@qelos/global-types 3.7.4 → 3.8.0

package/LICENSE

@@ -16,16 +16,16 @@ For full license details, see [Apache License 2.0](https://www.apache.org/licens
 
 ## Restriction on Managed Services - Custom Clause
 
-While the software is open and free to use for internal or personal purposes, **you are not permitted to offer this software or any derivative of it as a paid managed service** or **Software as a Service (SaaS)** without explicit permission from Qelos LTD.
+While the software is open and free to use for internal or personal purposes, **you are not permitted to offer this software or any derivative of it as a paid managed service** or **Software as a Service (SaaS)** without explicit permission from Velocitech LTD.
 
 ### Key Restriction:
 - You **may not** sell, offer, or commercialize this software as a managed service, SaaS, or any similar hosted service.
 
 ### How to Obtain Permission:
-If you wish to offer a managed or commercial version of this software, you must obtain a **commercial license** from Qelos LTD. Please contact us at [support@qelos.io](mailto:support@qelos.io) for details.
+If you wish to offer a managed or commercial version of this software, you must obtain a **commercial license** from Velocitech LTD. Please contact us at [support@qelos.io](mailto:support@qelos.io) for details.
 
 ## Additional Notes
 
-This license ensures the software remains free for personal use and community development, while protecting Qelos LTD’s right to control the commercialization of managed services based on the software.
+This license ensures the software remains free for personal use and community development, while protecting Velocitech LTD’s right to control the commercialization of managed services based on the software.
 
 For any questions regarding the license, feel free to reach out at [support@qelos.io].

package/app-configuration-metadata.ts

@@ -0,0 +1,19 @@
+
+export interface IAppConfigurationMetadata {
+  name: string;
+  logoUrl: string;
+  description: string;
+  keywords: string;
+  slogan: string;
+  language: string;
+  direction: string;
+  themeStylesUrl: string;
+  scriptUrl: string;
+  homeScreen: string;
+  colorsPalette: Record<string, string>;
+  borderRadius: number;
+  baseFontSize: number;
+  websiteUrls: string[];
+
+  [key: string]: any;
+}

package/auth-configuration-metadata.ts

@@ -0,0 +1,25 @@
+
+export interface IUserAdditionalField {
+  key: string
+  name: string,
+  label: string,
+  inputType: 'text' | 'email' | 'phone' | 'select' | 'checkbox' | 'radio',
+  valueType: 'string' | 'number' | 'boolean',
+  required: boolean,
+  defaultValue?: any;
+  options?: Array<{ label: string, value: string }>,
+}
+
+export interface IAuthConfigurationMetadata {
+  treatUsernameAs: 'email' | 'username' | 'phone',
+  formPosition: 'left' | 'right' | 'center' | 'top' | 'bottom',
+  loginTitle?: string,
+  showLoginPage: boolean,
+  showRegisterPage: boolean,
+  backgroundImage?: string,
+  socialLoginsSources?: {
+    linkedin?: string,
+  }
+  allowSocialAutoRegistration?: boolean,
+  additionalUserFields: Array<IUserAdditionalField>
+}

package/blueprint.ts

@@ -10,7 +10,8 @@ export enum BlueprintPropertyType {
   DATE = 'date',
   DATETIME = 'datetime',
   TIME = 'time',
-  OBJECT = 'object'
+  OBJECT = 'object',
+  FILE = 'file'
 }
 
 export enum PermissionScope {
@@ -29,6 +30,7 @@ export enum CRUDOperation {
 export interface IPermissionsDescriptor {
   scope: PermissionScope,
   operation: CRUDOperation,
+  guest: boolean,
   roleBased: string[],
   workspaceRoleBased: string[],
   workspaceLabelsBased: string[],
@@ -48,6 +50,8 @@ export interface IBlueprintPropertyDescriptor {
 
 export interface IBlueprintLimitation {
   scope: PermissionScope;
+  workspaceLabels: string[];
+  roles: string[];
   properties?: string[];
   value: number;
 }
@@ -71,5 +75,4 @@ export interface IBlueprint {
   };
   created: Date;
   updated: Date;
-  workspaceLabelsBased?: string[];
 }

package/index.ts

@@ -6,4 +6,9 @@ export * from './micro-frontend'
 export * from './screen-requirement'
 export * from './navbar-group'
 export * from './plugin-crud'
-export * from './query-filters'
+export * from './query-filters'
+export * from './workspace-configuration-metadata'
+export * from './auth-configuration-metadata'
+export * from './app-configuration-metadata'
+export * from './integration-sources'
+export * from './integration'

package/integration-sources.ts

@@ -0,0 +1,116 @@
+export enum IntegrationSourceKind {
+  Qelos = 'qelos',
+  OpenAI = 'openai',
+  Email = 'email',
+  N8n = 'n8n',
+  Supabase = 'supabase',
+  LinkedIn = 'linkedin',
+  Http = 'http',
+}
+
+export interface IIntegrationSource {
+  _id?: string;
+  tenant: string;
+  plugin?: string;
+  user: string;
+  authentication: any;
+  metadata: any;
+  name: string;
+  labels: string[];
+  kind: IntegrationSourceKind;
+  created: Date;
+}
+
+export enum HttpTargetOperation {
+  makeRequest = 'makeRequest',
+}
+
+export enum QelosTriggerOperation {
+  webhook = 'webhook',
+}
+
+export enum QelosTargetOperation {
+  webhook = 'webhook',
+  createBlueprintEntity = 'createBlueprintEntity',
+  createUser = 'createUser',
+  updateUser = 'updateUser',
+  setUserRoles = 'setUserRoles',
+  setWorkspaceLabels = 'setWorkspaceLabels',
+}
+
+export enum OpenAITargetOperation {
+  chatCompletion = 'chatCompletion',
+}
+
+export interface ILinkedInSource extends IIntegrationSource {
+  _id?: string;
+  kind: IntegrationSourceKind.LinkedIn;
+  authentication: {
+    clientSecret?: string;
+  };
+  metadata: {
+    clientId: string;
+    scope: string;
+  };
+}
+
+export interface IQelosSource extends IIntegrationSource {
+  _id?: string;
+  kind: IntegrationSourceKind.Qelos;
+  authentication: {
+    password: string;
+  };
+  metadata: {
+    url: string;
+    username: string;
+  };
+}
+
+export interface ISupabaseSource extends IIntegrationSource {
+  _id?: string;
+  kind: IntegrationSourceKind.Supabase;
+  metadata: {
+    url: string;
+  };
+}
+
+export interface IOpenAISource extends IIntegrationSource {
+  _id?: string;
+  kind: IntegrationSourceKind.OpenAI;
+}
+
+export interface IN8nSource extends IIntegrationSource {
+  _id?: string;
+  kind: IntegrationSourceKind.N8n;
+  metadata: {
+    url: string;
+  };
+}
+
+export interface IEmailSource extends IIntegrationSource {
+  _id?: string;
+  kind: IntegrationSourceKind.Email;
+  authentication: {
+    password: string;
+  };
+  metadata: {
+    username: string;
+    email: string;
+    pop3: string;
+    smtp: string;
+    senderName: string;
+  };
+}
+
+export interface IHttpSource extends IIntegrationSource {
+  _id?: string;
+  kind: IntegrationSourceKind.Http;
+  authentication: {
+    securedHeaders: Record<string, string>;
+  };
+  metadata: {
+    baseUrl: string;
+    headers: Record<string, string>;
+    query: Record<string, string>;
+  };
+}

package/integration.ts

@@ -0,0 +1,24 @@
+export interface IDataManipulationStep {
+  map: Record<string, string> // JQ expressions to be assigned to the key
+  // populate data from given object using qelos source. If blueprint is provided, it will be used to fetch the blueprint entity
+  populate: Record<string, { source: 'user' | 'workspace' | 'blueprintEntity'; blueprint?: string; }>,
+  clean?: boolean
+}
+
+export interface IIntegration {
+  _id: string;
+  tenant: string;
+  plugin?: string;
+  user: string;
+  kind: string[];
+  trigger: IIntegrationEntity;
+  target: IIntegrationEntity;
+  dataManipulation: IDataManipulationStep[]
+  created: Date;
+}
+
+export interface IIntegrationEntity {
+  source: string;
+  operation: string;
+  details: any;
+}

package/micro-frontend.ts

@@ -5,11 +5,13 @@ export interface IMicroFrontend {
   name: string;
   description: string;
   manifestUrl: string;
+  guest?: boolean;
   url: string;
   active: boolean;
   opened: boolean;
   roles: string[],
   workspaceRoles: string[],
+  workspaceLabels?: string[],
   crud?: string;
   use?: string;
   structure?: string;

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@qelos/global-types",
-  "version": "3.7.4",
+  "version": "3.8.0",
   "description": "",
   "main": "index.ts",
   "types": "index.ts",
   "scripts": {},
   "author": "",
-  "gitHead": "19f9c9c5e119299f5bbe3f9cf9acb44578eb10cb",
+  "gitHead": "cb6281585059df8baa9b2ce388fb00577b2cf99b",
   "license": "MIT",
   "publishConfig": {
     "access": "public"

package/screen-requirement.ts

@@ -14,6 +14,9 @@ export interface IScreenRequirement {
     name: string,
     identifier?: string,
     query?: any,
+    dependsOn?: string;
+    dependsField?: string;
   },
   fromData?: any;
+  lazy?: boolean;
 }

package/workspace-configuration-metadata.ts

@@ -0,0 +1,18 @@
+export interface WorkspaceLabelDefinition {
+  title: string,
+  description: string,
+  value: string[],
+  allowedRolesForCreation?: string[],
+}
+
+export interface WorkspaceConfigurationMetadata {
+  isActive: boolean,
+  creationPrivilegedRoles: string[],
+  viewMembersPrivilegedWsRoles: string[],
+  labels: WorkspaceLabelDefinition[],
+  allowNonLabeledWorkspaces: boolean,
+  allowNonWorkspaceUsers: boolean,
+  allowLogo?: boolean,
+  createWorkspacePageTitle?: string,
+  labelsSelectorTitle?: string,
+}