@dpuse/dpuse-shared 0.3.627 → 0.3.630

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

@@ -1,6 +1,6 @@
 import { ComponentConfig } from '..';
 import { ConnectorConfig } from '../module/connector';
-import { LocaleLabel } from '../../locale';
+import { Localised, LocaleLabel } from '../../locale';
 import { DataSubtypeId, DataTypeId } from '../dataView';
 export interface ConnectionConfig extends ComponentConfig {
     authorisation: Record<string, ConnectionAuthorisationConfig>;
@@ -8,10 +8,7 @@ export interface ConnectionConfig extends ComponentConfig {
     lastVerifiedAt: number;
     notation: string | undefined;
 }
-export type ConnectionLocalisedConfig = Omit<ConnectionConfig, 'label' | 'description'> & {
-    label: string;
-    description: string;
-};
+export type ConnectionLocalisedConfig = Localised<ConnectionConfig>;
 export interface ConnectionAuthorisationConfig {
     accessToken: string;
     accountId: string;

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

@@ -1,6 +1,7 @@
 import { FileTypeResult } from 'file-type';
 import { Component, ComponentConfig } from '..';
 import { ConnectionNodeConfig, ObjectColumnConfig } from '../connection';
+import { Localised } from '../../locale';
 type DataViewInterface = Component;
 interface DataViewConfig extends ComponentConfig {
     connectionId: string | undefined;
@@ -9,10 +10,7 @@ interface DataViewConfig extends ComponentConfig {
     contentAuditConfig: ContentAuditConfig | undefined;
     relationshipsAuditConfig: RelationshipsAuditConfig | undefined;
 }
-type DataViewLocalisedConfig = Omit<DataViewConfig, 'label' | 'description'> & {
-    label: string;
-    description: string;
-};
+type DataViewLocalisedConfig = Localised<DataViewConfig>;
 interface PreviewConfig {
     asAt: number;
     commentMarkId?: string | undefined;

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

@@ -1,8 +1,6 @@
 import { ComponentConfig } from '..';
+import { Localised } from '../../locale';
 export interface DimensionConfig extends ComponentConfig {
     placeholder?: string;
 }
-export type DimensionLocalisedConfig = Omit<DimensionConfig, 'label' | 'description'> & {
-    label: string;
-    description: string;
-};
+export type DimensionLocalisedConfig = Localised<DimensionConfig>;

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

@@ -1,8 +1,6 @@
 import { ComponentConfig } from '..';
+import { Localised } from '../../locale';
 export interface EventQueryConfig extends ComponentConfig {
     placeholder?: string;
 }
-export type EventQueryLocalisedConfig = Omit<EventQueryConfig, 'label' | 'description'> & {
-    label: string;
-    description: string;
-};
+export type EventQueryLocalisedConfig = Localised<EventQueryConfig>;

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

@@ -1,15 +1,12 @@
 import { InferOutput } from 'valibot';
 import { componentConfigSchema, componentReferenceSchema, componentStatusColorIdSchema, componentStatusConfigSchema } from './componentConfig.schema';
-import { LocaleId } from '../locale';
+import { LocaleId, Localised } from '../locale';
 export { componentConfigSchema } from './componentConfig.schema';
 export interface Component {
     readonly config: ComponentConfig;
 }
 export type ComponentConfig = InferOutput<typeof componentConfigSchema>;
-export type ComponentLocalisedConfig = Omit<ComponentConfig, 'label' | 'description'> & {
-    label: string;
-    description: string;
-};
+export type ComponentLocalisedConfig = Localised<ComponentConfig>;
 export type ComponentReference = InferOutput<typeof componentReferenceSchema>;
 export type ComponentStatus = InferOutput<typeof componentStatusConfigSchema>;
 export type ComponentStatusColorId = InferOutput<typeof componentStatusColorIdSchema>;

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

@@ -4,6 +4,7 @@ import { ToolConfig } from '../tool';
 import { ConnectionDescriptionConfig, ConnectionNodeConfig } from '../../connection';
 import { connectorCategoryConfigSchema, connectorConfigSchema, connectorOperationNameSchema, connectorUsageIdSchema } from './connectorConfig.schema';
 import { ContentAuditConfig, ParsingRecord, PreviewConfig, ValueDelimiterId } from '../../dataView';
+import { Localised } from '../../../locale';
 import { EngineConnectorActionOptions, EngineUtilities } from '../../../engine';
 export { connectorConfigSchema } from './connectorConfig.schema';
 export interface ConnectorInterface extends Component {
@@ -27,10 +28,7 @@ export interface ConnectorInterface extends Component {
 }
 export type ConnectorConstructor = new (engineUtilities: EngineUtilities, toolConfigs: ToolConfig[]) => ConnectorInterface;
 export type ConnectorConfig = InferOutput<typeof connectorConfigSchema>;
-export type ConnectorLocalisedConfig = Omit<ConnectorConfig, 'label' | 'description'> & {
-    label: string;
-    description: string;
-};
+export type ConnectorLocalisedConfig = Localised<ConnectorConfig>;
 type ConnectorCategoryConfig = InferOutput<typeof connectorCategoryConfigSchema>;
 type ConnectorCategoryLocalisedConfig = Omit<ConnectorCategoryConfig, 'label'> & {
     label: string;

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

@@ -1,7 +1,7 @@
 import { InferOutput } from 'valibot';
 import { contextConfigSchema } from './contextConfig.schema';
 import { EngineContextActionOptions } from '../../../engine';
-import { LocaleLabel } from '../../../locale';
+import { Localised } from '../../../locale';
 import { ModuleConfig } from '..';
 import { Component, ComponentConfig, ComponentReference } from '../..';
 export { contextConfigSchema } from './contextConfig.schema';
@@ -15,121 +15,13 @@ export interface ContextConfig1 extends ModuleConfig {
     operations: ContextOperation[];
     typeId: 'context';
 }
-export type ContextLocalisedConfig = Omit<ContextConfig, 'label' | 'description'> & {
-    label: string;
-    description: string;
-};
+export type ContextLocalisedConfig = Localised<ContextConfig>;
 export type ContextOperation = 'list';
 export interface ContextModelGroupConfig extends ComponentConfig {
     modelRefs: ComponentReference[];
     order: number;
 }
-export type ContextModelGroupLocalisedConfig = Omit<ContextModelGroupConfig, 'label' | 'description'> & {
-    label: string;
-    description: string;
-};
-export interface ContextModelConfig extends ComponentConfig {
-    diagramURL?: string;
-    dimension: ContextModelDimensionGroupConfig[];
-    entities: ContextModelEntityGroupConfig[];
-    secondaryMeasures: ContextModelSecondaryMeasureGroupConfig[];
-}
-export type ContextModelLocalisedConfig = Omit<ContextModelConfig, 'label' | 'description'> & {
-    label: string;
-    description: string;
-};
-export interface ContextModelDimensionGroupConfig {
-    id: string;
-    label: LocaleLabel;
-    description: LocaleLabel;
-    dimensionRefs: ComponentReference[];
-}
-export type ContextModelDimensionGroupLocalisedConfig = Omit<ContextModelDimensionGroupConfig, 'label' | 'description'> & {
-    label: string;
-    description: string;
-};
-export interface ContextModelDimensionConfig {
-    id: string;
-    label: LocaleLabel;
-    hierarchies: ContextModelDimensionHierarchyConfig[];
-}
-export type ContextModelDimensionLocalisedConfig = Omit<ContextModelDimensionConfig, 'label' | 'description'> & {
-    label: string;
-    description: string;
-};
-export interface ContextModelDimensionHierarchyConfig {
-    id: string;
-    label: LocaleLabel;
-}
-export type ContextModelDimensionHierarchyLocalisedConfig = Omit<ContextModelDimensionHierarchyConfig, 'label' | 'description'> & {
-    label: string;
-    description: string;
-};
-export interface ContextModelEntityGroupConfig {
-    id: string;
-    label: LocaleLabel;
-    description?: Record<string, unknown>;
-    entityRefs: ComponentReference[];
-}
-export type ContextModelEntityGroupLocalisedConfig = Omit<ContextModelEntityGroupConfig, 'label' | 'description'> & {
-    label: string;
-    description: string;
-};
-export interface ContextModelEntityConfig {
-    id: string;
-    label: LocaleLabel;
-    labelPlural: LocaleLabel;
-    dataItems: ContextModelEntityDataItemConfig[];
-    events: ContextModelEntityEventConfig[];
-    primaryMeasures: ContextModelEntityPrimaryMeasureConfig[];
-}
-export type ContextModelEntityLocalisedConfig = Omit<ContextModelEntityConfig, 'label' | 'description'> & {
-    label: string;
-    description: string;
-};
-export interface ContextModelEntityDataItemConfig {
-    id: string;
-    label: LocaleLabel;
-}
-export type ContextModelEntityDataItemLocalisedConfig = Omit<ContextModelEntityDataItemConfig, 'label' | 'description'> & {
-    label: string;
-    description: string;
-};
-export interface ContextModelEntityEventConfig {
-    id: string;
-    labelAction: Record<string, string>;
-    labelState: Record<string, string>;
-}
-export type ContextModelEntityEventLocalisedConfig = Omit<ContextModelEntityEventConfig, 'label' | 'description'> & {
-    label: string;
-    description: string;
-};
-export interface ContextModelEntityPrimaryMeasureConfig {
-    id: string;
-    label: LocaleLabel;
-}
-export type ContextModelEntityPrimaryMeasureLocalisedConfig = Omit<ContextModelEntityPrimaryMeasureConfig, 'label' | 'description'> & {
-    label: string;
-    description: string;
-};
-export interface ContextModelSecondaryMeasureGroupConfig {
-    id: string;
-    label: LocaleLabel;
-    description?: Record<string, unknown>;
-    secondaryMeasureRefs: ComponentReference[];
-}
-export type ContextModelSecondaryMeasureGroupLocalisedConfig = Omit<ContextModelSecondaryMeasureGroupConfig, 'label' | 'description'> & {
-    label: string;
-    description: string;
-};
-export interface ContextModelSecondaryMeasureConfig {
-    id: string;
-    label: LocaleLabel;
-}
-export type ContextModelSecondaryMeasureLocalisedConfig = Omit<ContextModelSecondaryMeasureConfig, 'label' | 'description'> & {
-    label: string;
-    description: string;
-};
+export type ContextModelGroupLocalisedConfig = Localised<ContextModelGroupConfig>;
 export interface ListContextOptions extends EngineContextActionOptions {
     placeholder: unknown;
 }

package/dist/types/src/component/module/context/model/dimension/index.d.ts

@@ -0,0 +1,12 @@
+import { LocaleLabel, Localised } from '../../../../../locale';
+export interface ContextModelDimensionConfig {
+    id: string;
+    label: LocaleLabel;
+    hierarchies: ContextModelDimensionHierarchyConfig[];
+}
+export type ContextModelDimensionLocalisedConfig = Localised<ContextModelDimensionConfig>;
+export interface ContextModelDimensionHierarchyConfig {
+    id: string;
+    label: LocaleLabel;
+}
+export type ContextModelDimensionHierarchyLocalisedConfig = Localised<ContextModelDimensionHierarchyConfig>;

package/dist/types/src/component/module/context/model/entity/dataItem/index.d.ts

@@ -0,0 +1,6 @@
+import { LocaleLabel, Localised } from '../../../../../../locale';
+export interface ContextModelEntityDataItemConfig {
+    id: string;
+    label: LocaleLabel;
+}
+export type ContextModelEntityDataItemLocalisedConfig = Localised<ContextModelEntityDataItemConfig>;

package/dist/types/src/component/module/context/model/entity/event/index.d.ts

@@ -0,0 +1,7 @@
+import { Localised } from '../../../../../../locale';
+export interface ContextModelEntityEventConfig {
+    id: string;
+    labelAction: Record<string, string>;
+    labelState: Record<string, string>;
+}
+export type ContextModelEntityEventLocalisedConfig = Localised<ContextModelEntityEventConfig>;

package/dist/types/src/component/module/context/model/entity/index.d.ts

@@ -0,0 +1,13 @@
+import { ContextModelEntityDataItemConfig } from './dataItem';
+import { ContextModelEntityEventConfig } from './event';
+import { ContextModelEntityPrimaryMeasureConfig } from './primaryMeasure';
+import { LocaleLabel, Localised } from '../../../../../locale';
+export interface ContextModelEntityConfig {
+    id: string;
+    label: LocaleLabel;
+    labelPlural: LocaleLabel;
+    dataItems: ContextModelEntityDataItemConfig[];
+    events: ContextModelEntityEventConfig[];
+    primaryMeasures: ContextModelEntityPrimaryMeasureConfig[];
+}
+export type ContextModelEntityLocalisedConfig = Localised<ContextModelEntityConfig>;

package/dist/types/src/component/module/context/model/entity/primaryMeasure/index.d.ts

@@ -0,0 +1,6 @@
+import { LocaleLabel, Localised } from '../../../../../../locale';
+export interface ContextModelEntityPrimaryMeasureConfig {
+    id: string;
+    label: LocaleLabel;
+}
+export type ContextModelEntityPrimaryMeasureLocalisedConfig = Localised<ContextModelEntityPrimaryMeasureConfig>;

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

@@ -0,0 +1,30 @@
+import { ComponentConfig, ComponentReference } from '../../..';
+import { LocaleLabel, Localised } from '../../../../locale';
+export interface ContextModelConfig extends ComponentConfig {
+    diagramURL?: string;
+    dimensions: ContextModelDimensionGroupConfig[];
+    entities: ContextModelEntityGroupConfig[];
+    secondaryMeasures: ContextModelSecondaryMeasureGroupConfig[];
+}
+export type ContextModelLocalisedConfig = Localised<ContextModelConfig>;
+export interface ContextModelDimensionGroupConfig {
+    id: string;
+    label: LocaleLabel;
+    description: LocaleLabel;
+    dimensionRefs: ComponentReference[];
+}
+export type ContextModelDimensionGroupLocalisedConfig = Localised<ContextModelDimensionGroupConfig>;
+export interface ContextModelEntityGroupConfig {
+    id: string;
+    label: LocaleLabel;
+    description?: Record<string, unknown>;
+    entityRefs: ComponentReference[];
+}
+export type ContextModelEntityGroupLocalisedConfig = Localised<ContextModelEntityGroupConfig>;
+export interface ContextModelSecondaryMeasureGroupConfig {
+    id: string;
+    label: LocaleLabel;
+    description?: Record<string, unknown>;
+    secondaryMeasureRefs: ComponentReference[];
+}
+export type ContextModelSecondaryMeasureGroupLocalisedConfig = Localised<ContextModelSecondaryMeasureGroupConfig>;

package/dist/types/src/component/module/context/model/secondaryMeasure/index.d.ts

@@ -0,0 +1,6 @@
+import { LocaleLabel, Localised } from '../../../../../locale';
+export interface ContextModelSecondaryMeasureConfig {
+    id: string;
+    label: LocaleLabel;
+}
+export type ContextModelSecondaryMeasureLocalisedConfig = Localised<ContextModelSecondaryMeasureConfig>;

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

@@ -1,5 +1,6 @@
 import { ModuleConfig } from '..';
 import { Component, ComponentReference } from '../..';
+import { Localised } from '../../../locale';
 export { presenterConfigSchema } from './presenterConfig.schema';
 export interface PresenterInterface extends Component {
     readonly config: PresenterConfig;
@@ -12,8 +13,5 @@ export interface PresenterConfig extends ModuleConfig {
     operations: PresenterOperation[];
     typeId: 'presenter';
 }
-export type PresenterLocalisedConfig = Omit<PresenterConfig, 'label' | 'description'> & {
-    label: string;
-    description: string;
-};
+export type PresenterLocalisedConfig = Localised<PresenterConfig>;
 export type PresenterOperation = 'list' | 'render' | 'setColorMode';

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

@@ -2,6 +2,10 @@ export type FlagId = 'es' | 'gb';
 export type LocaleId = 'en' | 'es';
 export type LocaleLabel = Partial<Record<LocaleId, string>>;
 export type LocaleLabelMap = ReadonlyMap<string, string>;
+export type Localised<T> = Omit<T, 'label' | 'description'> & {
+    label: string;
+    description: string;
+};
 export declare const DEFAULT_LOCALE_ID: LocaleId;
 export declare const SUPPORTED_LANGUAGES: {
     id: LocaleId;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@dpuse/dpuse-shared",
-    "version": "0.3.627",
+    "version": "0.3.630",
     "description": "Common constants, types and utilities used across all DPUse projects.",
     "license": "MIT",
     "author": "Jonathan Terrell <terrell.jm@gmail.com>",
@@ -49,6 +49,34 @@
             "import": "./dist/dpuse-shared-componentModuleContext.es.js",
             "types": "./dist/types/src/component/module/context/index.d.ts"
         },
+        "./component/module/context/model": {
+            "import": "./dist/dpuse-shared-componentModuleContextModel.es.js",
+            "types": "./dist/types/src/component/module/context/model/index.d.ts"
+        },
+        "./component/module/context/model/dimension": {
+            "import": "./dist/dpuse-shared-componentModuleContextModelDimension.es.js",
+            "types": "./dist/types/src/component/module/context/model/dimension/index.d.ts"
+        },
+        "./component/module/context/model/entity": {
+            "import": "./dist/dpuse-shared-componentModuleContextModelEntity.es.js",
+            "types": "./dist/types/src/component/module/context/model/entity/index.d.ts"
+        },
+        "./component/module/context/model/entity/dataItem": {
+            "import": "./dist/dpuse-shared-componentModuleContextModelEntityDataItem.es.js",
+            "types": "./dist/types/src/component/module/context/model/entity/dataItem/index.d.ts"
+        },
+        "./component/module/context/model/entity/event": {
+            "import": "./dist/dpuse-shared-componentModuleContextModelEntityEvent.es.js",
+            "types": "./dist/types/src/component/module/context/model/entity/event/index.d.ts"
+        },
+        "./component/module/context/model/entity/primaryMeasure": {
+            "import": "./dist/dpuse-shared-componentModuleContextModelEntityPrimaryMeasure.es.js",
+            "types": "./dist/types/src/component/module/context/model/entity/primaryMeasure/index.d.ts"
+        },
+        "./component/module/context/model/secondaryMeasure": {
+            "import": "./dist/dpuse-shared-componentModuleContextModelSecondaryMeasure.es.js",
+            "types": "./dist/types/src/component/module/context/model/secondaryMeasure/index.d.ts"
+        },
         "./component/module/presenter": {
             "import": "./dist/dpuse-shared-componentModulePresenter.es.js",
             "types": "./dist/types/src/component/module/presenter/index.d.ts"