Skip to main content

Legacy meta (stored for further discussion of ideas)

Important: this widget type is not in service. The article is archieved.

Object describing the widget.

{
    name: 'MyWidget',
    version: '0.0.1',
    widgetId: '*UUID*',
    publishedAt: '01.01.2021',
    vendorName: 'Vendor Company LLC',
    vendorId: '*UUID*',
    description: 'This is informer widget used for displaing info',
    externalAPI?: {
        externalAPIId1: { 
            uri: 'https://google.com',
            reason: 'used as search engine' 
        },
        externalAPIId2: { 
            uri: 'https://my-vendor-uri.com',
            reason: 'used to fetch main info on widget'
        }
    },
    locales: ['ru_RU', 'en_EN'],
    requiredStoreData?: ['userProfile', 'dashbordMeta', ....],
}

name​

  • Widget name.

version​

  • Widget version.
  • Recommend the use of semver.

widgetId​

  • The internal ID of all widgets of this type.
  • Constant value.
  • The ID is independent of the widget version.
  • The ID is assigned when the widget is first published.
  • The ID is uuid.

publishedAt​

  • Last published date of the widget.

vendorName​

  • Vendor name by string.

vendorId​

  • Vendor ID.
  • Vendor ID is constant.
  • Vendor ID is assigned by the platform during registration in the system.
  • The ID is uuid.

description​

  • Brief string description of the widget's purpose.
  • Possibly a link to README.md inside the widget repository.

locales​

  • List of locales supported by the widget.
  • This information will be displayed in the storeroom.
  • This information is for information purposes only.

externalAPI​

  • An object with access keys.
  • The key is the id by which this object can be retrieved.
  • This information is needed to describe the widget.
  • url - address where the widget should be.
  • reason - a brief reason why it is needed. This information will be available when the widget is added.