@datapos/datapos-shared 0.3.254 → 0.3.256

package/dist/types/src/{component/test.d.ts → _SCHEMA_TYPES.d.ts}

@@ -5,14 +5,12 @@ type ComponentStatus = {
 };
 type ComponentStatusId = 'alpha' | 'beta' | 'generalAvailability' | 'notApplicable' | 'preAlpha' | 'proposed' | 'releaseCandidate' | 'unavailable' | 'underReview';
 type ComponentTypeId = 'app' | 'connector' | 'connectorConnection' | 'context' | 'contextModelGroup' | 'contextModel' | 'contextModelDimensionGroup' | 'contextModelDimension' | 'contextModelDimensionHierarchy' | 'contextModelEntityGroup' | 'contextModelEntity' | 'contextModelEntityDataItem' | 'contextModelEntityEvent' | 'contextModelEntityPrimaryMeasure' | 'contextModelSecondaryMeasureGroup' | 'contextModelSecondaryMeasure' | 'dataView' | 'dimension' | 'engine' | 'eventQuery' | 'presenter' | 'presenterPresentation' | 'tool';
-type LocaleCode = 'en-au' | 'en-gb' | 'en-us' | 'es-es';
-type LocalisedString = Record<LocaleCode, string>;
 type StatusColorId = 'amber' | 'green' | 'red' | 'other';
 type Timestamp = number;
 interface ComponentConfig {
     id: string;
-    label: Partial<LocalisedString>;
-    description: Partial<LocalisedString>;
+    label: Record<string, string>;
+    description: Record<string, string>;
     firstCreatedAt?: Timestamp;
     icon?: string;
     iconDark?: string;
@@ -21,36 +19,24 @@ interface ComponentConfig {
     statusId: ComponentStatusId;
     typeId: ComponentTypeId;
 }
+type ComponentRef = {
+    id: string;
+    label: Record<string, string>;
+    description: Record<string, string>;
+    icon?: string;
+    iconDark?: string;
+    order: number;
+    path: string;
+};
 interface ModuleConfig extends ComponentConfig {
     typeId: ModuleTypeId;
     version: string;
 }
 type ModuleTypeId = 'app' | 'engine' | 'connector' | 'context' | 'presenter' | 'tool';
-type ConnectorCategory = {
-    id: string;
-    label: string;
-};
-export type ConnectorImplementation = {
-    activeConnectionCount?: number;
-    canDescribe?: boolean;
-    id?: string;
-    authMethodId: 'apiKey' | 'disabled' | 'oAuth2' | 'none';
-    label?: LocalisedString;
-    maxConnectionCount?: number;
-    params?: Record<string, string>[];
-};
-type ConnectorModuleCategoryId = 'application' | 'curatedDataset' | 'database' | 'fileStore';
-type ConnectorOperation = 'abortOperation' | 'authenticateConnection' | 'createObject' | 'describeConnection' | 'dropObject' | 'findObject' | 'getRecord' | 'listNodes' | 'previewObject' | 'removeRecords' | 'retrieveRecords' | 'upsertRecords';
-type ConnectorUsageId = 'bidirectional' | 'destination' | 'source' | 'unknown';
-export interface ConnectorConfig extends ModuleConfig {
-    category?: ConnectorCategory;
-    categoryId: ConnectorModuleCategoryId;
-    implementations: Record<string, ConnectorImplementation>;
-    operations: ConnectorOperation[];
-    typeId: 'connector';
-    usageId: ConnectorUsageId;
-    vendorAccountURL?: string;
-    vendorDocumentationURL?: string;
-    vendorHomeURL?: string;
+export interface PresenterConfig extends ModuleConfig {
+    presentations: ComponentRef[];
+    operations: PresenterOperation[];
+    typeId: 'presenter';
 }
+type PresenterOperation = 'list' | 'render' | 'setColorMode';
 export {};

package/dist/types/src/component/context/contextSchema.d.ts

@@ -0,0 +1,45 @@
+import { z } from 'zod';
+export declare const contextConfigSchema: z.ZodObject<{
+    id: z.ZodString;
+    label: z.ZodRecord<z.ZodString, z.ZodString>;
+    description: z.ZodRecord<z.ZodString, z.ZodString>;
+    firstCreatedAt: z.ZodOptional<z.ZodNumber>;
+    icon: z.ZodOptional<z.ZodString>;
+    iconDark: z.ZodOptional<z.ZodString>;
+    lastUpdatedAt: z.ZodOptional<z.ZodNumber>;
+    status: z.ZodOptional<z.ZodObject<{
+        id: z.ZodString;
+        color: z.ZodUnion<readonly [z.ZodLiteral<"amber">, z.ZodLiteral<"green">, z.ZodLiteral<"red">, z.ZodLiteral<"other">]>;
+        label: z.ZodString;
+    }, z.core.$strip>>;
+    statusId: z.ZodUnion<readonly [z.ZodLiteral<"alpha">, z.ZodLiteral<"beta">, z.ZodLiteral<"generalAvailability">, z.ZodLiteral<"notApplicable">, z.ZodLiteral<"preAlpha">, z.ZodLiteral<"proposed">, z.ZodLiteral<"releaseCandidate">, z.ZodLiteral<"unavailable">, z.ZodLiteral<"underReview">]>;
+    version: z.ZodString;
+    models: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        label: z.ZodRecord<z.ZodString, z.ZodString>;
+        description: z.ZodRecord<z.ZodString, z.ZodString>;
+        firstCreatedAt: z.ZodOptional<z.ZodNumber>;
+        icon: z.ZodOptional<z.ZodString>;
+        iconDark: z.ZodOptional<z.ZodString>;
+        lastUpdatedAt: z.ZodOptional<z.ZodNumber>;
+        status: z.ZodOptional<z.ZodObject<{
+            id: z.ZodString;
+            color: z.ZodUnion<readonly [z.ZodLiteral<"amber">, z.ZodLiteral<"green">, z.ZodLiteral<"red">, z.ZodLiteral<"other">]>;
+            label: z.ZodString;
+        }, z.core.$strip>>;
+        statusId: z.ZodUnion<readonly [z.ZodLiteral<"alpha">, z.ZodLiteral<"beta">, z.ZodLiteral<"generalAvailability">, z.ZodLiteral<"notApplicable">, z.ZodLiteral<"preAlpha">, z.ZodLiteral<"proposed">, z.ZodLiteral<"releaseCandidate">, z.ZodLiteral<"unavailable">, z.ZodLiteral<"underReview">]>;
+        typeId: z.ZodUnion<readonly [z.ZodLiteral<"app">, z.ZodLiteral<"connector">, z.ZodLiteral<"connectorConnection">, z.ZodLiteral<"context">, z.ZodLiteral<"contextModelGroup">, z.ZodLiteral<"contextModel">, z.ZodLiteral<"contextModelDimensionGroup">, z.ZodLiteral<"contextModelDimension">, z.ZodLiteral<"contextModelDimensionHierarchy">, z.ZodLiteral<"contextModelEntityGroup">, z.ZodLiteral<"contextModelEntity">, z.ZodLiteral<"contextModelEntityDataItem">, z.ZodLiteral<"contextModelEntityEvent">, z.ZodLiteral<"contextModelEntityPrimaryMeasure">, z.ZodLiteral<"contextModelSecondaryMeasureGroup">, z.ZodLiteral<"contextModelSecondaryMeasure">, z.ZodLiteral<"dataView">, z.ZodLiteral<"dimension">, z.ZodLiteral<"engine">, z.ZodLiteral<"eventQuery">, z.ZodLiteral<"presenter">, z.ZodLiteral<"presenterPresentation">, z.ZodLiteral<"tool">]>;
+        modelRefs: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            label: z.ZodRecord<z.ZodString, z.ZodString>;
+            description: z.ZodRecord<z.ZodString, z.ZodString>;
+            icon: z.ZodOptional<z.ZodString>;
+            iconDark: z.ZodOptional<z.ZodString>;
+            order: z.ZodNumber;
+            path: z.ZodString;
+        }, z.core.$strip>>;
+        order: z.ZodNumber;
+    }, z.core.$strip>>;
+    operations: z.ZodArray<z.ZodLiteral<"list">>;
+    typeId: z.ZodLiteral<"context">;
+}, z.core.$strip>;

package/dist/types/src/component/presenter/presenterSchema.d.ts

@@ -0,0 +1,28 @@
+import { z } from 'zod';
+export declare const presenterConfigSchema: z.ZodObject<{
+    id: z.ZodString;
+    label: z.ZodRecord<z.ZodString, z.ZodString>;
+    description: z.ZodRecord<z.ZodString, z.ZodString>;
+    firstCreatedAt: z.ZodOptional<z.ZodNumber>;
+    icon: z.ZodOptional<z.ZodString>;
+    iconDark: z.ZodOptional<z.ZodString>;
+    lastUpdatedAt: z.ZodOptional<z.ZodNumber>;
+    status: z.ZodOptional<z.ZodObject<{
+        id: z.ZodString;
+        color: z.ZodUnion<readonly [z.ZodLiteral<"amber">, z.ZodLiteral<"green">, z.ZodLiteral<"red">, z.ZodLiteral<"other">]>;
+        label: z.ZodString;
+    }, z.core.$strip>>;
+    statusId: z.ZodUnion<readonly [z.ZodLiteral<"alpha">, z.ZodLiteral<"beta">, z.ZodLiteral<"generalAvailability">, z.ZodLiteral<"notApplicable">, z.ZodLiteral<"preAlpha">, z.ZodLiteral<"proposed">, z.ZodLiteral<"releaseCandidate">, z.ZodLiteral<"unavailable">, z.ZodLiteral<"underReview">]>;
+    version: z.ZodString;
+    presentations: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        label: z.ZodRecord<z.ZodString, z.ZodString>;
+        description: z.ZodRecord<z.ZodString, z.ZodString>;
+        icon: z.ZodOptional<z.ZodString>;
+        iconDark: z.ZodOptional<z.ZodString>;
+        order: z.ZodNumber;
+        path: z.ZodString;
+    }, z.core.$strip>>;
+    operations: z.ZodArray<z.ZodUnion<readonly [z.ZodLiteral<"list">, z.ZodLiteral<"render">, z.ZodLiteral<"setColorMode">]>>;
+    typeId: z.ZodLiteral<"presenter">;
+}, z.core.$strip>;

package/dist/types/src/engine/index.d.ts

@@ -7,6 +7,7 @@ export interface EngineConfig extends ModuleConfig {
     typeId: 'engine';
 }
 type InitialiseEngine = (settings: InitialiseSettings) => Promise<void>;
+type Test = () => Promise<void>;
 type ProcessConnectorRequest = (id: string, connectionConfig: ConnectionConfig, settings: ConnectorOperationSettings, callback?: ((callbackData: ContextCallbackData) => void) | undefined) => Promise<ContextInterfaceResult>;
 export type ContextInterfaceResult = AuditContentResult | DataViewPreviewConfig | ListResult | RetrieveResult;
 type ProcessContextRequest = (id: string, contextConfig: ContextConfig, settings: ContextOperationSettings, callback?: ((callbackData: ConnectorCallbackData) => void) | undefined) => Promise<ConnectorInterfaceResult>;
@@ -17,6 +18,7 @@ export interface Engine extends Component {
 }
 export interface EngineWorker {
     initialise: InitialiseEngine;
+    test: Test;
     processConnectorRequest: ProcessConnectorRequest;
     processContextRequest: ProcessContextRequest;
 }

package/dist/types/src/index.d.ts

@@ -20,6 +20,8 @@ export type { RemoveSettings } from './component/connector';
 export type { RetrieveResult, RetrieveSettings, RetrieveSummary } from './component/connector';
 export type { UpsertSettings } from './component/connector';
 export { connectorConfigSchema } from './component/connector/connectorSchema';
+export { contextConfigSchema } from './component/context/contextSchema';
+export { presenterConfigSchema } from './component/presenter/presenterSchema';
 export type { ConnectionAuthorizationConfig, ConnectionColumnConfig, ConnectionConfig, ConnectionNodeConfig } from './component/connector/connection';
 export type { DPAFileSystemFileHandle, Encoding, StorageTypeId, UsageTypeId } from './component/connector/connection';
 export type { Context, ContextConfig, ContextLocalisedConfig, ContextListSettings, ContextListResult, ContextOperation } from './component/context';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@datapos/datapos-shared",
-    "version": "0.3.254",
+    "version": "0.3.256",
     "description": "A TypeScript library containing common declarations and utilities used across other Data Positioning repositories.",
     "license": "MIT",
     "private": false,
@@ -44,6 +44,7 @@
         "npm-check-updates": "^19.1.2",
         "prettier": "^3.6.2",
         "retire": "^5.3.0",
+        "ts-to-zod": "^5.1.0",
         "typescript": "^5.9.3",
         "vite": "^7.2.4",
         "vite-plugin-dts": "^4.5.4"
@@ -64,7 +65,8 @@
         "_document:licenceReport": "license-report --only=prod,peer > LICENSES.json",
         "_document:licenceCheck": "license-report-check --source ./LICENSES.json --allowed 'MIT' --allowed 'n/a' --allowed 'Apache-2.0' --output=table",
         "_sync:withGitHub": "node -e \"import('@datapos/datapos-development').then(m => m.syncWithGitHub())\"",
-        "_update:developDep": "npm install --save-dev @datapos/datapos-development@latest"
+        "_update:developDep": "npm install --save-dev @datapos/datapos-development@latest",
+        "___ts-to-zod": "npx ts-to-zod src/schemaTypes.ts src/schemaZOD.ts"
     },
     "engines": {
         "node": ">=22.0.0",