Skip to main content

Migrations

Widgets​

Widget Type​

WidgetType Enum describes the available types of widgets.

  • Platform - Widgets like navigation, GA, sidenav. Anything that cannot be placed on the dashboard.
  • Dashboard - Widgets for dashboards only. Informers, charts, e.t.c.
  • Universal - Widgets both for platform and dashboards.
enum WidgetType {
  Platform = 0,
  Dashboard = 1,
  Universal = 2,
}

Domain​

Domain describes placement of widget.

type Domain =
  | "info"
  | "navigation"
  | "dashboard"
  | "menu"
  | "users"
  | "lightbox"
  | "navigation"
  | "reporters"
  | "get-user-info"
  | "actionbar";

Migration widget​

type MigrationWidgetConfigT = {
  id: number;
  name: string;
  issuer: string;
  domain: Domain;
  url?: string;
  placement?: string;
  version: string;
  widgetType: number;
  widgetDetails?: WidgetDetailsT;
  defaultProps?: Record<string, unknown>;
  props?: Record<string, unknown>;
  layout?: WidgetLayoutT;
  port: number;
  vendorPrefix: string;
  tenentSlug: string;
  defaultBranch: string;
  exposes: Record<string, string>;
  extended?: Record<string, unknown>;
};
  • id - id of Gitlab repo.
  • name - widget name. IMPORTANT: please use VENODOR-PREFIX_WidgetName notation
  • issuer - issuer of the widget.
  • domain - see domain section
  • url - widget source url if used non default
  • placement - place where widget expected to be placed
  • version - widget version
  • widgetType - see WidgetType enum
  • tenantSlug - short name of vendor
  • widgetDetails - special widget's parameters
  • defaultProps - props setted to widget by default
  • props - react props
  • layout - React Grid Layout props
  • port - port on which the widget is published
  • vendorPrefix - short name of vendor
  • tenetSlug - short name of vendor
  • defaultBranch - default branch of repository
  • exposes - react components exposed in module federation
  • extended - reserved key

Example:

{
  "id": 100,
  "port": 5100,
  "name": "VENDOR_Widget",
  "issuer": "Invent",
  "domain": "domain",
  "url": "url",
  "version": "0.1.1",
  "widgetType": 1,
  "vendorPrefix": "vendor",
  "tenentSlug": "vendor",
  "defaultBranch": "master",
  "exposes": {
    "./Widget": "./src/widget/widget",
    "./WidgetSettings": "./src/widget/settings",
    "./WidgetPreview": "./src/widget/preview"
  },
  "widgetDetails": {
  },
  "defaultProps": {
    "apiUrl": "_internal_api_"
  },
  "layout": {
    "minW": 5,
    "maxW": 1000,
    "minH": 5,
    "maxH": 1000
  }
}

Vendors​

Types​

type JWKSLink = {
  link: string;
  issuer: string;
  tenentSlug: string;
  token: string;
};
  • link - url where open-id configuration for jwks could be found
  • issuer - issuer key
  • tenentSlug - same as for Widgets
  • token - tenent-id

The example of tenent data migration​

  {
    link: "https://id.vendor.some-host.cloud/.well-known/openid-configuration/jwks",
    issuer: "https://id.vendor.some-host.cloud",
    tenentSlug: "VENDOR",
    token: "2f6a9390-fe40-46ed-8731-0b72d321d01d",
  }