@qelos/global-types 3.5.1

package/ScreenRequirement.ts

@@ -0,0 +1,11 @@
+export interface IScreenRequirement {
+  key: string,
+  fromHTTP?: {
+    uri: string,
+    method: string,
+  },
+  fromCrud?: {
+    name: string,
+    identifier?: string,
+  }
+}

package/blueprint.ts

@@ -0,0 +1,57 @@
+export enum EntityIdentifierMechanism {
+  OBJECT_ID = 'objectid',
+  GUID = 'guid'
+}
+
+export enum BlueprintPropertyType {
+  STRING = 'string',
+  NUMBER = 'number',
+  BOOLEAN = 'boolean',
+  DATE = 'date',
+  DATETIME = 'datetime',
+  TIME = 'time'
+}
+
+export enum PermissionScope {
+  USER = 'user',
+  WORKSPACE = 'workspace',
+  TENANT = 'tenant'
+}
+
+export enum CRUDOperation {
+  CREATE = 'create',
+  READ = 'read',
+  UPDATE = 'update',
+  DELETE = 'delete'
+}
+
+export interface IPermissionsDescriptor {
+  scope: PermissionScope,
+  operation: CRUDOperation,
+  roleBased: string[],
+  workspaceRoleBased: string[],
+}
+
+export interface IBlueprint {
+  tenant: string;
+  identifier: string,
+  name: string,
+  description?: string,
+  entityIdentifierMechanism: EntityIdentifierMechanism,
+  permissions: Array<Partial<IPermissionsDescriptor>>,
+  permissionScope: PermissionScope,
+  properties: Record<string, {
+    title: string,
+    type: BlueprintPropertyType,
+    description: string,
+    required: boolean,
+    enum?: string[],
+    multi?: boolean,
+    min?: number,
+    max?: number,
+  }>,
+  updateMapping: Record<string, string>,
+  relations: { key: string, target: string }[],
+  created: Date;
+  updated: Date;
+}

package/event-subscriber.ts

@@ -0,0 +1,6 @@
+export interface IEventSubscriber {
+  source?: string,
+  kind?: string,
+  eventName?: string,
+  hookUrl: string;
+}

package/index.ts

@@ -0,0 +1,7 @@
+export * from './blueprint'
+export * from './injectable'
+export * from './event-subscriber'
+export * from './plugin'
+export * from './micro-frontend'
+export * from './navbar-group'
+export * from './plugin-crud'

package/injectable.ts

@@ -0,0 +1,6 @@
+export interface IInjectable {
+  name?: string,
+  description?: string,
+  html: string,
+  active: boolean
+}

package/micro-frontend.ts

@@ -0,0 +1,39 @@
+import { IScreenRequirement } from './ScreenRequirement';
+
+export interface IMicroFrontend {
+  name: string;
+  description: string;
+  url: string;
+  active: boolean;
+  opened: boolean;
+  roles: string[],
+  workspaceRoles: string[],
+  crud?: string;
+  use?: string;
+  structure?: string;
+  searchQuery?: boolean,
+  searchPlaceholder?: string,
+  requirements?: IScreenRequirement[]
+  navigateAfterSubmit?: {
+    name: string,
+    params: Record<string, string>,
+    query: Record<string, string>,
+  },
+  clearAfterSubmit?: boolean,
+  route?: {
+    name: string;
+    path: string;
+    roles: string[],
+    navBarPosition: 'top' | 'bottom' | 'user-dropdown' | false;
+    group?: string;
+  };
+  component?: {
+    page: string;
+    position: 'top' | 'left' | 'right' | 'bottom';
+  };
+  modal?: {
+    name: string;
+    params: string[] | Record<string, string>; // schema / hints for props
+    size: 'sm' | 'md' | 'lg' | 'full'
+  }
+}

package/navbar-group.ts

@@ -0,0 +1,7 @@
+export interface INavbarGroup {
+  key: string,
+  name: string,
+  iconName?: string,
+  iconSvg?: string,
+  priority?: number
+}

package/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "@qelos/global-types",
+  "version": "3.5.1",
+  "description": "",
+  "main": "index.ts",
+  "types": "index.ts",
+  "scripts": {},
+  "author": "",
+  "gitHead": "0c89581c94896414d53b99a63788829fe3caab4c",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/plugin-crud.ts

@@ -0,0 +1,11 @@
+export interface IPluginCrud {
+  name: string,
+  display: {
+    name: string;
+    plural: string;
+    capitalized: string;
+    capitalizedPlural: string;
+  },
+  identifierKey: string;
+  schema: any;
+}

package/plugin.ts

@@ -0,0 +1,32 @@
+import { IMicroFrontend } from './micro-frontend';
+import { IEventSubscriber } from './event-subscriber';
+import { IPluginCrud } from './plugin-crud';
+import { IInjectable } from './injectable';
+import { INavbarGroup } from './navbar-group';
+
+export interface IPlugin {
+  tenant: string;
+  name: string;
+  description?: string;
+  apiPath: string;
+  registerUrl: string;
+  user: string;
+  token: string;
+  proxyUrl: string;
+  authAcquire: {
+    refreshTokenUrl: string;
+    refreshTokenKey: string;
+    accessTokenKey: string;
+  };
+  auth: {
+    refreshTokenIdentifier?: string;
+  };
+  manifestUrl: string,
+  callbackUrl?: string,
+  subscribedEvents: IEventSubscriber[]
+  microFrontends: IMicroFrontend[]
+  cruds: IPluginCrud[]
+
+  injectables: IInjectable[],
+  navBarGroups?: INavbarGroup[],
+}