@datapos/datapos-shared 0.3.241 → 0.3.243

package/README.md

@@ -43,8 +43,8 @@ The Data Positioning solution consists of the following modules. All modules, ex
 | Engine    |   ✔    | Implements the data positioning engine.                         |
 | Connector |   ✔    | Implements a connector which handles one or more connections.   |
 | Context   |   ✔    | Implements a context which defines one or more models.          |
-| Informer  |   ✔    | Implements an informer which renders one or more documents.     |
 | Presenter |   ✔    | Implements a presenter which renders one or more presentations. |
+| Tool      |   ✔    | Implements...                                                   |
 
 ### Components
 
@@ -82,13 +82,6 @@ Each module implements a set of components. All module component types extend th
 | ---------------------------------- | ------------- |
 | [Engine Types](./src/dimension.ts) | Engine types. |
 
-#### Informer Module Components
-
-| Item                                | Notes                                                         |
-| ----------------------------------- | ------------------------------------------------------------- |
-| [Informer Types](./src/informer.ts) | Informer types. The Informer type extends the Component type. |
-| [Recipe Types](./src/recipe.ts)     | Recipe types. The Recipe type extends the Component type.     |
-
 #### Presenter Module Components
 
 | Item                                        | Notes                                                                 |

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

@@ -1,14 +1,18 @@
 import { parse as csvParse } from 'csv-parse/browser/esm';
 import { parse as dateFnsParse } from 'date-fns';
 import { nanoid } from 'nanoid';
-import { Module } from '../../module';
 import { buildFetchError, OperationalError } from '../../errors';
-import { Component, ComponentConfig } from '..';
+import { Component, ModuleConfig } from '..';
 import { ConnectionConfig, ConnectionDescription, ConnectionNodeConfig } from './connection';
 import { convertMillisecondsToTimestamp, LocalisedString } from '../../index';
 import { DataViewContentAuditConfig, ValueDelimiterId } from '../dataView';
 import { extractExtensionFromPath, extractNameFromPath, lookupMimeTypeForExtension } from '../../utilities';
-export interface Connector extends Module, Component {
+type ConnectorModuleCategoryId = 'application' | 'curatedDataset' | 'database' | 'fileStore';
+export type ConnectorModuleOperation = 'abortOperation' | 'authenticateConnection' | 'createObject' | 'describeConnection' | 'dropObject' | 'findObject' | 'getRecord' | 'listNodes' | 'previewObject' | 'removeRecords' | 'retrieveRecords' | 'upsertRecords';
+export type ConnectorModuleUsageId = 'bidirectional' | 'destination' | 'source';
+export declare const CONNECTOR_DESTINATION_OPERATIONS: string[];
+export declare const CONNECTOR_SOURCE_OPERATIONS: string[];
+export interface Connector extends Component {
     abortController?: AbortController | undefined;
     readonly config: ConnectorConfig;
     readonly connectionConfig: ConnectionConfig;
@@ -26,15 +30,16 @@ export interface Connector extends Module, Component {
     retrieveRecords?(connector: Connector, settings: RetrieveSettings, chunk: (records: (string[] | Record<string, unknown>)[]) => void, complete: (result: RetrieveSummary) => void): Promise<void>;
     upsertRecords?(connector: Connector, settings: UpsertSettings): Promise<void>;
 }
-export interface ConnectorConfig extends ComponentConfig {
+export interface ConnectorConfig extends ModuleConfig {
     category?: ConnectorCategory;
-    categoryId: string;
+    categoryId: ConnectorModuleCategoryId;
     implementations: Record<string, ConnectorImplementation>;
-    usageId: 'bidirectional' | 'destination' | 'source';
+    operations: ConnectorModuleOperation[];
+    typeId: 'connector';
+    usageId: ConnectorModuleUsageId;
     vendorAccountURL?: string;
     vendorDocumentationURL?: string;
     vendorHomeURL?: string;
-    version: string;
 }
 export type ConnectorLocalisedConfig = Omit<ConnectorConfig, 'label' | 'description'> & {
     label: string;

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

@@ -1,6 +1,6 @@
-import { Module } from '../../module';
-import { Component, ComponentConfig, ComponentRef } from '..';
-export interface Context extends Module, Component {
+import { LocalisedString } from '../../index';
+import { Component, ComponentConfig, ComponentRef, ModuleConfig } from '..';
+export interface Context extends Component {
     readonly config: ContextConfig;
     list(settings?: ContextListSettings): Promise<ContextListResult>;
 }
@@ -13,10 +13,11 @@ export type ContextCallbackData = {
     typeId: string;
     properties: Record<string, unknown>;
 };
-export interface ContextConfig extends ComponentConfig {
+export interface ContextConfig extends ModuleConfig {
     models: ContextModelGroupConfig[];
-    version: string;
+    typeId: 'context';
 }
+export type ContextModuleOperation = 'list';
 export type ContextLocalisedConfig = Omit<ContextConfig, 'label' | 'description'> & {
     label: string;
     description: string;
@@ -41,8 +42,8 @@ export type ContextModelLocalisedConfig = Omit<ContextModelConfig, 'label' | 'de
 };
 export interface ContextModelDimensionGroupConfig {
     id: string;
-    label: Record<string, string>;
-    description?: Record<string, unknown>;
+    label: Partial<LocalisedString>;
+    description: Partial<LocalisedString>;
     dimensionRefs: ComponentRef[];
 }
 export type ContextModelDimensionGroupLocalisedConfig = Omit<ContextModelDimensionGroupConfig, 'label' | 'description'> & {
@@ -51,7 +52,7 @@ export type ContextModelDimensionGroupLocalisedConfig = Omit<ContextModelDimensi
 };
 export interface ContextModelDimensionConfig {
     id: string;
-    label: Record<string, string>;
+    label: Partial<LocalisedString>;
     hierarchies: ContextModelDimensionHierarchyConfig[];
 }
 export type ContextModelDimensionLocalisedConfig = Omit<ContextModelDimensionConfig, 'label' | 'description'> & {
@@ -60,7 +61,7 @@ export type ContextModelDimensionLocalisedConfig = Omit<ContextModelDimensionCon
 };
 export interface ContextModelDimensionHierarchyConfig {
     id: string;
-    label: Record<string, string>;
+    label: Partial<LocalisedString>;
 }
 export type ContextModelDimensionHierarchyLocalisedConfig = Omit<ContextModelDimensionHierarchyConfig, 'label' | 'description'> & {
     label: string;
@@ -68,7 +69,7 @@ export type ContextModelDimensionHierarchyLocalisedConfig = Omit<ContextModelDim
 };
 export interface ContextModelEntityGroupConfig {
     id: string;
-    label: Record<string, string>;
+    label: Partial<LocalisedString>;
     description?: Record<string, unknown>;
     entityRefs: ComponentRef[];
 }
@@ -78,8 +79,8 @@ export type ContextModelEntityGroupLocalisedConfig = Omit<ContextModelEntityGrou
 };
 export interface ContextModelEntityConfig {
     id: string;
-    label: Record<string, string>;
-    labelPlural: Record<string, string>;
+    label: Partial<LocalisedString>;
+    labelPlural: Partial<LocalisedString>;
     dataItems: ContextModelEntityDataItemConfig[];
     events: ContextModelEntityEventConfig[];
     primaryMeasures: ContextModelEntityPrimaryMeasureConfig[];
@@ -90,7 +91,7 @@ export type ContextModelEntityLocalisedConfig = Omit<ContextModelEntityConfig, '
 };
 export interface ContextModelEntityDataItemConfig {
     id: string;
-    label: Record<string, string>;
+    label: Partial<LocalisedString>;
 }
 export type ContextModelEntityDataItemLocalisedConfig = Omit<ContextModelEntityDataItemConfig, 'label' | 'description'> & {
     label: string;
@@ -107,7 +108,7 @@ export type ContextModelEntityEventLocalisedConfig = Omit<ContextModelEntityEven
 };
 export interface ContextModelEntityPrimaryMeasureConfig {
     id: string;
-    label: Record<string, string>;
+    label: Partial<LocalisedString>;
 }
 export type ContextModelEntityPrimaryMeasureLocalisedConfig = Omit<ContextModelEntityPrimaryMeasureConfig, 'label' | 'description'> & {
     label: string;
@@ -115,7 +116,7 @@ export type ContextModelEntityPrimaryMeasureLocalisedConfig = Omit<ContextModelE
 };
 export interface ContextModelSecondaryMeasureGroupConfig {
     id: string;
-    label: Record<string, string>;
+    label: Partial<LocalisedString>;
     description?: Record<string, unknown>;
     secondaryMeasureRefs: ComponentRef[];
 }
@@ -125,7 +126,7 @@ export type ContextModelSecondaryMeasureGroupLocalisedConfig = Omit<ContextModel
 };
 export interface ContextModelSecondaryMeasureConfig {
     id: string;
-    label: Record<string, string>;
+    label: Partial<LocalisedString>;
 }
 export type ContextModelSecondaryMeasureLocalisedConfig = Omit<ContextModelSecondaryMeasureConfig, 'label' | 'description'> & {
     label: string;

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

@@ -19,6 +19,8 @@ export type ComponentRef = {
     id: string;
     label: Partial<LocalisedString>;
     description: Partial<LocalisedString>;
+    icon?: string;
+    iconDark?: string;
     order: number;
     path: string;
 };
@@ -29,4 +31,9 @@ export type ComponentStatus = {
 };
 export type ComponentStatusId = 'alpha' | 'beta' | 'generalAvailability' | 'notApplicable' | 'preAlpha' | 'proposed' | 'releaseCandidate' | 'unavailable' | 'underReview';
 export declare const getComponentStatus: (id: string, localeId?: LocaleCode) => ComponentStatus;
-export type ComponentTypeId = 'connector' | 'connectorConnection' | 'context' | 'contextModelGroup' | 'contextModel' | 'contextModelDimensionGroup' | 'contextModelDimension' | 'contextModelDimensionHierarchy' | 'contextModelEntityGroup' | 'contextModelEntity' | 'contextModelEntityDataItem' | 'contextModelEntityEvent' | 'contextModelEntityPrimaryMeasure' | 'contextModelSecondaryMeasureGroup' | 'contextModelSecondaryMeasure' | 'dataView' | 'dimension' | 'eventQuery' | 'presenter' | 'presenterPresentation' | 'informer' | 'informerDocument';
+export 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';
+export interface ModuleConfig extends ComponentConfig {
+    typeId: ModuleTypeId;
+    version: string;
+}
+export type ModuleTypeId = 'app' | 'engine' | 'connector' | 'context' | 'presenter' | 'tool';

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

@@ -1,14 +1,14 @@
-import { Module } from '../../module';
-import { Component, ComponentConfig, ComponentRef } from '..';
-export interface Presenter extends Module, Component {
+import { Component, ComponentRef, ModuleConfig } from '..';
+export interface Presenter extends Component {
     readonly config: PresenterConfig;
     list(): ComponentRef[];
     render(presentationPath: string, renderTo: HTMLElement, data?: unknown): Promise<void>;
 }
-export interface PresenterConfig extends ComponentConfig {
+export interface PresenterConfig extends ModuleConfig {
     presentations: ComponentRef[];
-    version: string;
+    typeId: 'presenter';
 }
+export type PresenterModuleOperation = 'list' | 'render';
 export type PresenterLocalisedConfig = Omit<PresenterConfig, 'label' | 'description'> & {
     label: string;
     description: string;

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

@@ -0,0 +1,4 @@
+import { ModuleConfig } from '..';
+export interface ToolModuleConfig extends ModuleConfig {
+    typeId: 'tool';
+}

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

@@ -1,14 +1,17 @@
 import { ConnectionConfig } from '../component/connector/connection';
-import { Module } from '../module';
 import { AuditContentResult, ConnectorCallbackData, ConnectorOperationSettings, InitialiseSettings, ListResult, RetrieveResult } from '../component/connector';
+import { Component, ModuleConfig } from '../component';
 import { ContextCallbackData, ContextConfig, ContextOperationSettings } from '../component/context';
 import { DataViewPreviewConfig, EncodingConfig } from '../component/dataView';
+export interface EngineModuleConfig extends ModuleConfig {
+    typeId: 'engine';
+}
 type InitialiseEngine = (settings: InitialiseSettings) => 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>;
 export type ConnectorInterfaceResult = AuditContentResult | DataViewPreviewConfig | ListResult | RetrieveResult;
-export interface Engine extends Module {
+export interface Engine extends Component {
     getEncodingConfigs: (localeId: string) => EncodingConfig[];
     invokeWorker(errorEventCallback: (errorEvent: ErrorEvent) => void): EngineWorker;
 }

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

@@ -4,16 +4,9 @@
 export type LocaleCode = 'en-au' | 'en-gb' | 'en-us' | 'es-es';
 export type LocalisedString = Record<LocaleCode, string>;
 export type StatusColorId = 'amber' | 'green' | 'red' | 'other';
-export type { ModuleConfig } from './module';
-export type { AppModuleConfig } from './module';
-export type { ConnectorModuleConfig, ConnectorModuleOperation, ConnectorModuleUsageId } from './module';
-export type { ContextModuleConfig, ContextModuleOperation } from './module';
-export type { EngineModuleConfig } from './module';
-export type { InformerModuleConfig, InformerModuleOperation } from './module';
-export type { PresenterModuleConfig, PresenterModuleOperation } from './module';
-export type { ToolModuleConfig } from './module';
-export { CONNECTOR_DESTINATION_OPERATIONS, CONNECTOR_SOURCE_OPERATIONS } from './module';
-export type { ComponentConfig, ComponentRef, ComponentStatus, ComponentStatusId, ComponentTypeId } from './component';
+export type { ComponentConfig, ComponentRef, ComponentStatus, ComponentStatusId, ComponentTypeId, ModuleConfig, ModuleTypeId } from './component';
+export type { ConnectorModuleOperation, ConnectorModuleUsageId } from './component/connector';
+export { CONNECTOR_DESTINATION_OPERATIONS, CONNECTOR_SOURCE_OPERATIONS } from './component/connector';
 export type { AuditContentResult, AuditContentSettings } from './component/connector';
 export type { Connector, ConnectorCallbackData, ConnectorConfig, ConnectorImplementation, ConnectorOperationSettings, ConnectorLocalisedConfig, ConnectorTools } from './component/connector';
 export type { CreateSettings } from './component/connector';
@@ -42,7 +35,6 @@ export type { DimensionConfig, DimensionLocalisedConfig } from './component/dime
 export type { ConnectorInterfaceResult, ContextInterfaceResult, Engine, EngineWorker } from './engine';
 export type { SerialisedError } from './errors';
 export type { EventQueryConfig, EventQueryLocalisedConfig } from './component/eventQuery';
-export type { Informer, InformerConfig, InformerLocalisedConfig, InformerTools } from './component/informer';
 export type { Presenter, PresenterConfig, PresenterLocalisedConfig } from './component/presenter';
 export type { PresentationConfig, PresentationView } from './component/presenter/presentation';
 export type { PresentationCategoryId, PresentationCartesianTypeId, PresentationPolarTypeId, PresentationRangeTypeId, PresentationVisualConfig, PresentationVisualContentConfig, PresentationVisualViewConfig, PresentationVisualCartesianChartViewConfig, PresentationVisualChordDiagramViewConfig, PresentationVisualPeriodFlowBoundariesChartViewConfig, PresentationVisualPolarChartViewConfig, PresentationVisualRangeChartViewConfig, PresentationVisualSankeyDiagramViewConfig, PresentationVisualStreamGraphViewConfig, PresentationVisualValueTableViewConfig } from './component/presenter/presentation';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@datapos/datapos-shared",
-    "version": "0.3.241",
+    "version": "0.3.243",
     "description": "A TypeScript library containing common declarations and utilities used across other Data Positioning repositories.",
     "license": "MIT",
     "private": false,

package/dist/types/src/component/informer/document.d.ts

@@ -1,3 +0,0 @@
-/**
- * Document composables, constants, errors, types/interfaces and utilities.
- */

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

@@ -1,16 +0,0 @@
-import { Module } from '../../module';
-import { Component, ComponentConfig, ComponentRef } from '..';
-export interface Informer extends Module, Component {
-    readonly config: InformerConfig;
-    readonly tools: InformerTools;
-    list(): ComponentRef[];
-    render(informerPath: string, renderTo: HTMLElement, data?: unknown): Promise<void>;
-}
-export interface InformerConfig extends ComponentConfig {
-    version: string;
-}
-export type InformerLocalisedConfig = Omit<InformerConfig, 'label' | 'description'> & {
-    label: string;
-    description: string;
-};
-export type InformerTools = {};

package/dist/types/src/component/informer/recipe.d.ts

@@ -1,19 +0,0 @@
-import { ComponentConfig } from '..';
-export interface Recipe {
-    readonly config: RecipeConfig;
-    list(path: string): RecipeItemConfig[];
-    render(id: string, renderTo: string | HTMLElement): Promise<void>;
-}
-export interface RecipeConfig extends ComponentConfig {
-    version: string;
-}
-export type RecipeLocalisedConfig = Omit<RecipeConfig, 'label' | 'description'> & {
-    label: string;
-    description: string;
-};
-export interface RecipeItemConfig {
-    items?: RecipeItemConfig[];
-    label: Record<string, string>;
-    name: string;
-    typeId: 'folder' | 'object';
-}

package/dist/types/src/component/informer/tutorial.d.ts

@@ -1,4 +0,0 @@
-import { ComponentConfig } from '..';
-export interface TutorialConfig extends ComponentConfig {
-    placeholder?: string;
-}

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

@@ -1,56 +0,0 @@
-import { ContextModelGroupConfig } from '../component/context';
-import { LocalisedString } from '../index';
-export interface Module {
-}
-export interface ModuleConfig {
-    id: string;
-    label: Partial<LocalisedString>;
-    description: Partial<LocalisedString>;
-    statusId: unknown;
-    typeId: ModuleTypeId;
-    version: string;
-}
-type ModuleTypeId = 'app' | 'engine' | 'connector' | 'context' | 'informer' | 'presenter' | 'tool';
-export interface AppModuleConfig extends ModuleConfig {
-    typeId: 'app';
-}
-export interface EngineModuleConfig extends ModuleConfig {
-    typeId: 'engine';
-}
-export interface ConnectorModuleConfig extends ModuleConfig {
-    categoryId: ConnectorModuleCategoryId;
-    implementations: Record<string, unknown>;
-    icon: string;
-    iconDark: string;
-    operations: ConnectorModuleOperation[];
-    typeId: 'connector';
-    usageId: ConnectorModuleUsageId | null;
-    vendorAccountURL?: string;
-    vendorDocumentationURL?: string;
-    vendorHomeURL?: string;
-}
-type ConnectorModuleCategoryId = 'application' | 'curatedDataset' | 'database' | 'fileStore';
-export type ConnectorModuleOperation = 'abortOperation' | 'authenticateConnection' | 'createObject' | 'describeConnection' | 'dropObject' | 'findObject' | 'getRecord' | 'listNodes' | 'previewObject' | 'removeRecords' | 'retrieveRecords' | 'upsertRecords';
-export type ConnectorModuleUsageId = 'bidirectional' | 'destination' | 'source';
-export declare const CONNECTOR_DESTINATION_OPERATIONS: string[];
-export declare const CONNECTOR_SOURCE_OPERATIONS: string[];
-export interface ContextModuleConfig extends ModuleConfig {
-    operations: ContextModuleOperation[];
-    models: ContextModelGroupConfig[];
-    typeId: 'context';
-}
-export type ContextModuleOperation = 'list';
-export interface InformerModuleConfig extends ModuleConfig {
-    operations: InformerModuleOperation[];
-    typeId: 'informer';
-}
-export type InformerModuleOperation = 'list' | 'render';
-export interface PresenterModuleConfig extends ModuleConfig {
-    operations: PresenterModuleOperation[];
-    typeId: 'presenter';
-}
-export type PresenterModuleOperation = 'list' | 'render';
-export interface ToolModuleConfig extends ModuleConfig {
-    typeId: 'tool';
-}
-export {};