@dpuse/dpuse-shared 0.3.703 → 0.3.706

package/README.md

@@ -63,36 +63,12 @@ Implements the common Data Positioning repository management command set. For mo
 
 ## Architecture
 
-### Domain Model
+### Component Hierarchy
 
-`Component` is the foundational base type for all DPUse domain objects. All component types extend `ComponentConfig` and are logically grouped in the following hierarchy. `Module` is a component type whose implementations are dynamically loaded by the host modules (App and API):
+`Component` is the foundational base type for all DPUse components. All component types extend `ComponentConfig` and are logically grouped in the following hierarchy. `Module` is a component type whose implementations are dynamically loaded by the host modules (App and API):
 
 ![Schematic](./schematic.svg)
 
-```
-Component
-├── Module
-│   ├── Connector
-│   │   └── Connection
-│   ├── Context
-│   │   └── Model
-│   │       ├── Dimension
-│   │       │   └── DimensionHierarchy
-│   │       ├── Entity
-│   │       │   ├── DataItem
-│   │       │   ├── Event
-│   │       │   └── PrimaryMeasure
-│   │       └── SecondaryMeasure
-│   ├── Engine
-│   ├── Presenter
-│   │   └── Presentation
-│   ├── Recipe
-│   └── Tool
-├── DataView
-├── Dimension
-└── EventQuery
-```
-
 ### Cross-cutting Concerns
 
 The following are shared across all modules and are not part of the domain model:
@@ -106,7 +82,158 @@ The following are shared across all modules and are not part of the domain model
 
 ## API Reference
 
-This package provides constants, errors, types/interfaces and utilities used by Data Positioning modules.
+### `@dpuse/dpuse-shared/component`
+
+| Category | Exports |
+| -------- | ------- |
+| Schema | `componentConfigSchema` |
+| Types | `Component`, `ComponentConfig`, `ComponentReference`, `ComponentStatus`, `ComponentStatusColorId` |
+| Functions | `getComponentStatus(id, localeId?)` |
+
+### `@dpuse/dpuse-shared/component/connection`
+
+| Category | Exports |
+| -------- | ------- |
+| Types | `ConnectionConfig`, `ConnectionAuthorisationConfig`, `ConnectionDescriptionConfig`, `ConnectionNodeConfig`, `DPAFileSystemFileHandle`, `NodeTypeId`, `ObjectColumnConfig`, `StorageTypeId` |
+
+### `@dpuse/dpuse-shared/component/dataView`
+
+| Category | Exports |
+| -------- | ------- |
+| Constants | `ORDERED_VALUE_DELIMITER_IDS` |
+| Types | `DataViewConfig`, `DataViewInterface`, `PreviewConfig`, `ContentAuditConfig`, `RelationshipsAuditConfig`, `DataFormatId`, `RecordDelimiterId`, `ValueDelimiterId`, `ParsingRecord`, `ParsingResult`, `DataTypeId`, `DataSubtypeId`, `NumericSubtypeId`, `NumericSignId`, `NumericUnitsId`, `StringSubtypeId`, `TemporalSubtypeId`, `InferenceSummary`, `InferenceRecord`, `InferenceResult`, `BooleanInferenceResult`, `NumericInferenceResult`, `BigIntInferenceResult`, `NumberInferenceResult`, `StringInferenceResult`, `TemporalInferenceResult`, `UnknownInferenceResult` |
+
+### `@dpuse/dpuse-shared/component/dimension`
+
+| Category | Exports |
+| -------- | ------- |
+| Types | `DimensionConfig` |
+
+### `@dpuse/dpuse-shared/component/eventQuery`
+
+| Category | Exports |
+| -------- | ------- |
+| Types | `EventQueryConfig` |
+
+### `@dpuse/dpuse-shared/component/module`
+
+| Category | Exports |
+| -------- | ------- |
+| Types | `ModuleConfig`, `ModuleTypeId` |
+
+### `@dpuse/dpuse-shared/component/module/connector`
+
+| Category | Exports |
+| -------- | ------- |
+| Schema | `connectorConfigSchema` |
+| Constants | `CONNECTOR_ACTION_NAME_MAP` |
+| Types | `ConnectorInterface`, `ConnectorActionName`, `ConnectorConstructor`, `ConnectorUtilities`, `ConnectorConfig`, `AuditObjectContentOptions`, `AuditObjectContentOptions1`, `AuditObjectContentResult`, `AuditObjectContentResult1`, `CreateObjectOptions`, `DescribeConnectionOptions`, `DropObjectOptions`, `FindObjectOptions`, `FindObjectResult`, `GetReadableStreamOptions`, `GetRecordOptions`, `GetRecordResult`, `ListNodesOptions`, `ListNodesResult`, `PreviewObjectOptions`, `RecordRetrievalTypeId`, `RemoveRecordsOptions`, `RetrieveChunksOptions`, `RetrieveRecordsOptions`, `RetrieveRecordsSummary`, `UpsertRecordsOptions` |
+| Functions | `constructConnectorCategoryConfig(id, localeId?)`, `getConnectorActionsTable(supported)` |
+
+### `@dpuse/dpuse-shared/component/module/context`
+
+| Category | Exports |
+| -------- | ------- |
+| Schema | `contextConfigSchema` |
+| Types | `ContextInterface`, `ContextConfig`, `ContextActionName`, `ContextModelGroupConfig`, `ListContextOptions`, `ListContextResult` |
+
+### `@dpuse/dpuse-shared/component/module/context/model`
+
+| Category | Exports |
+| -------- | ------- |
+| Types | `ContextModelConfig`, `ContextModelDimensionGroupConfig`, `ContextModelEntityGroupConfig`, `ContextModelSecondaryMeasureGroupConfig` |
+
+### `@dpuse/dpuse-shared/component/module/context/model/dimension`
+
+| Category | Exports |
+| -------- | ------- |
+| Types | `ContextModelDimensionConfig`, `ContextModelDimensionHierarchyConfig` |
+
+### `@dpuse/dpuse-shared/component/module/context/model/entity`
+
+| Category | Exports |
+| -------- | ------- |
+| Types | `ContextModelEntityConfig` |
+
+### `@dpuse/dpuse-shared/component/module/context/model/entity/dataItem`
+
+| Category | Exports |
+| -------- | ------- |
+| Types | `ContextModelEntityDataItemConfig` |
+
+### `@dpuse/dpuse-shared/component/module/context/model/entity/event`
+
+| Category | Exports |
+| -------- | ------- |
+| Types | `ContextModelEntityEventConfig` |
+
+### `@dpuse/dpuse-shared/component/module/context/model/entity/primaryMeasure`
+
+| Category | Exports |
+| -------- | ------- |
+| Types | `ContextModelEntityPrimaryMeasureConfig` |
+
+### `@dpuse/dpuse-shared/component/module/context/model/secondaryMeasure`
+
+| Category | Exports |
+| -------- | ------- |
+| Types | `ContextModelSecondaryMeasureConfig` |
+
+### `@dpuse/dpuse-shared/component/module/engine`
+
+| Category | Exports |
+| -------- | ------- |
+| Types | `EngineConfig`, `EngineRuntime`, `EngineWorker`, `EngineInitialiseOptions`, `EngineAuthActionOptions`, `EngineConnectorActionOptions`, `EngineContextActionOptions`, `EngineCallbackData` |
+
+### `@dpuse/dpuse-shared/component/module/presenter`
+
+| Category | Exports |
+| -------- | ------- |
+| Schema | `presenterConfigSchema` |
+| Types | `PresenterInterface`, `PresenterActionName`, `PresenterConfig` |
+
+### `@dpuse/dpuse-shared/component/module/presenter/presentation`
+
+| Category | Exports |
+| -------- | ------- |
+| Types | `PresentationConfig`, `PresentationVisualConfig`, `PresentationVisualContentConfig`, `PresentationVisualViewConfig`, `PresentationCategoryId`, `PresentationView`, `PresentationVisualCartesianChartViewConfig`, `PresentationCartesianTypeId`, `PresentationVisualChordDiagramViewConfig`, `PresentationVisualPeriodFlowBoundariesChartViewConfig`, `PresentationVisualPolarChartViewConfig`, `PresentationPolarTypeId`, `PresentationVisualRangeChartViewConfig`, `PresentationRangeTypeId`, `PresentationVisualSankeyDiagramViewConfig`, `PresentationVisualStreamGraphViewConfig`, `PresentationVisualValueTableViewConfig` |
+
+### `@dpuse/dpuse-shared/component/module/tool`
+
+| Category | Exports |
+| -------- | ------- |
+| Types | `ToolConfig` |
+| Functions | `loadTool<T>(toolConfigs, toolId)` |
+
+### `@dpuse/dpuse-shared/encoding`
+
+| Category | Exports |
+| -------- | ------- |
+| Constants | `encodingConfigMap` |
+| Types | `EncodingConfig`, `EncodingTypeConfig` |
+| Functions | `getEncodingTypeConfigs(localeId?)` |
+
+### `@dpuse/dpuse-shared/errors`
+
+| Category | Exports |
+| -------- | ------- |
+| Types | `SerialisedError` |
+| Classes | `DPUseError`, `AppError`, `APIError`, `EngineError`, `ConnectorError`, `FetchError` |
+| Functions | `serialiseError(error?)`, `unserialiseError(serialisedErrors)`, `buildFetchError(response, message, locator)`, `normalizeToError(value)`, `concatenateSerialisedErrorMessages(serialisedErrors)`, `ignoreErrors(action)` |
+
+### `@dpuse/dpuse-shared/locale`
+
+| Category | Exports |
+| -------- | ------- |
+| Constants | `DEFAULT_LOCALE_ID`, `SUPPORTED_LANGUAGES` |
+| Types | `FlagId`, `LocaleId`, `LocaleLabel`, `LocaleDescription`, `LocaleLabelMap`, `LocalisedConfig<T>` |
+| Functions | `createLabelMap(labels)`, `localiseConfig(config, localeId)`, `localiseConfigs(configs, localeId, isResultSorted?)`, `resolveLabel(labels, localeId, fallbackLocaleId?)` |
+
+### `@dpuse/dpuse-shared/utilities`
+
+| Category | Exports |
+| -------- | ------- |
+| Functions | `convertODataTypeIdToUsageTypeId(oDataTypeId)`, `extractNameFromPath(itemPath)`, `extractExtensionFromPath(itemPath)`, `formatNumberAsDecimalNumber(number?, decimalPlaces?, minimumFractionDigits?, locale?)`, `formatNumberAsSize(number?, decimalPlaces?)`, `formatNumberAsStorageSize(number?, decimalPlaces?)`, `formatNumberAsDuration(number?, stopAt?)`, `formatNumberAsWholeNumber(number?, locale?)`, `lookupMimeTypeForExtension(extension?)` |
 
 ## Dependency Licenses
 

package/dist/dpuse-shared-componentModuleConnector.es.js

@@ -3,11 +3,26 @@ import { a as n, c as r, d as i, f as a, i as o, l as s, m as c, o as l, p as u,
 import { t as p } from "./moduleConfig.schema-Cvc9QRvr.js";
 //#region src/component/module/connector/connectorConfig.schema.ts
 var m = n([
+	"abortOperation",
+	"auditObjectContent",
+	"createObject",
+	"describeConnection",
+	"dropObject",
+	"findObject",
+	"getReadableStream",
+	"getRecord",
+	"listNodes",
+	"previewObject",
+	"removeRecords",
+	"retrieveChunks",
+	"retrieveRecords",
+	"upsertRecords"
+]), h = n([
 	"application",
 	"curatedDataset",
 	"database",
 	"fileStore"
-]), h = i({ label: o }), g = i({
+]), g = i({ label: o }), _ = i({
 	authMethodId: n([
 		"apiKey",
 		"disabled",
@@ -20,28 +35,13 @@ var m = n([
 	label: a(o),
 	maxConnectionCount: s(f()),
 	params: a(l(u(c(), c())))
-}), _ = n([
-	"abortOperation",
-	"auditObjectContent",
-	"createObject",
-	"describeConnection",
-	"dropObject",
-	"findObject",
-	"getReadableStream",
-	"getRecord",
-	"listNodes",
-	"previewObject",
-	"removeRecords",
-	"retrieveChunks",
-	"retrieveRecords",
-	"upsertRecords"
-]), v = i({
+}), v = i({
 	typeId: r("connector"),
 	...p,
-	actionNames: l(_),
-	category: s(h),
-	categoryId: m,
-	implementations: u(c(), g),
+	actionNames: l(m),
+	category: s(g),
+	categoryId: h,
+	implementations: u(c(), _),
 	vendorAccountURL: s(c()),
 	vendorDocumentationURL: s(c()),
 	vendorHomeURL: s(c())

package/dist/dpuse-shared-componentModuleContext.es.js

@@ -2,15 +2,15 @@ import { a as e, c as t, d as n, o as r, r as i, t as a, u as o } from "./compon
 import { t as s } from "./moduleConfig.schema-Cvc9QRvr.js";
 //#region src/component/module/context/contextConfig.schema.ts
 var c = n({
-	...a,
 	typeId: t("contextModelGroup"),
+	...a,
 	modelRefs: r(i),
 	order: o()
 }), l = e(["listContextFocuses"]), u = n({
-	...s,
 	typeId: t("context"),
-	models: r(c),
-	operations: r(l)
+	...s,
+	actionNames: r(l),
+	models: r(c)
 });
 //#endregion
 export { u as contextConfigSchema };

package/dist/types/src/component/module/connector/connectorConfig.schema.d.ts

@@ -2,13 +2,13 @@
  * Defines the configuration metadata for a connector. Used for validation
  * of connector manifests and capability discovery at runtime.
  */
+export declare const connectorActionNameSchema: import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"abortOperation", undefined>, import('valibot').LiteralSchema<"auditObjectContent", undefined>, import('valibot').LiteralSchema<"createObject", undefined>, import('valibot').LiteralSchema<"describeConnection", undefined>, import('valibot').LiteralSchema<"dropObject", undefined>, import('valibot').LiteralSchema<"findObject", undefined>, import('valibot').LiteralSchema<"getReadableStream", undefined>, import('valibot').LiteralSchema<"getRecord", undefined>, import('valibot').LiteralSchema<"listNodes", undefined>, import('valibot').LiteralSchema<"previewObject", undefined>, import('valibot').LiteralSchema<"removeRecords", undefined>, import('valibot').LiteralSchema<"retrieveChunks", undefined>, import('valibot').LiteralSchema<"retrieveRecords", undefined>, import('valibot').LiteralSchema<"upsertRecords", undefined>], undefined>;
 export declare const connectorCategoryConfigSchema: import('valibot').ObjectSchema<{
     readonly label: import('valibot').ObjectSchema<{
         readonly en: import('valibot').StringSchema<undefined>;
         readonly es: import('valibot').StringSchema<undefined>;
     }, undefined>;
 }, undefined>;
-export declare const connectorActionNameSchema: import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"abortOperation", undefined>, import('valibot').LiteralSchema<"auditObjectContent", undefined>, import('valibot').LiteralSchema<"createObject", undefined>, import('valibot').LiteralSchema<"describeConnection", undefined>, import('valibot').LiteralSchema<"dropObject", undefined>, import('valibot').LiteralSchema<"findObject", undefined>, import('valibot').LiteralSchema<"getReadableStream", undefined>, import('valibot').LiteralSchema<"getRecord", undefined>, import('valibot').LiteralSchema<"listNodes", undefined>, import('valibot').LiteralSchema<"previewObject", undefined>, import('valibot').LiteralSchema<"removeRecords", undefined>, import('valibot').LiteralSchema<"retrieveChunks", undefined>, import('valibot').LiteralSchema<"retrieveRecords", undefined>, import('valibot').LiteralSchema<"upsertRecords", undefined>], undefined>;
 export declare const connectorConfigSchema: import('valibot').ObjectSchema<{
     readonly actionNames: import('valibot').ArraySchema<import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"abortOperation", undefined>, import('valibot').LiteralSchema<"auditObjectContent", undefined>, import('valibot').LiteralSchema<"createObject", undefined>, import('valibot').LiteralSchema<"describeConnection", undefined>, import('valibot').LiteralSchema<"dropObject", undefined>, import('valibot').LiteralSchema<"findObject", undefined>, import('valibot').LiteralSchema<"getReadableStream", undefined>, import('valibot').LiteralSchema<"getRecord", undefined>, import('valibot').LiteralSchema<"listNodes", undefined>, import('valibot').LiteralSchema<"previewObject", undefined>, import('valibot').LiteralSchema<"removeRecords", undefined>, import('valibot').LiteralSchema<"retrieveChunks", undefined>, import('valibot').LiteralSchema<"retrieveRecords", undefined>, import('valibot').LiteralSchema<"upsertRecords", undefined>], undefined>, undefined>;
     readonly category: import('valibot').NullableSchema<import('valibot').ObjectSchema<{

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

@@ -3,7 +3,7 @@ import { Component } from '../..';
 import { EngineConnectorActionOptions } from '../engine';
 import { ToolConfig } from '../tool';
 import { ConnectionDescriptionConfig, ConnectionNodeConfig, ObjectColumnConfig } from '../../connection';
-import { connectorCategoryConfigSchema, connectorConfigSchema, connectorActionNameSchema } from './connectorConfig.schema';
+import { connectorActionNameSchema, connectorCategoryConfigSchema, connectorConfigSchema } from './connectorConfig.schema';
 import { ContentAuditConfig, InferenceRecord, InferenceSummary, ParsingRecord, PreviewConfig, ValueDelimiterId } from '../../dataView';
 import { LocalisedConfig } from '../../../locale';
 export { connectorConfigSchema } from './connectorConfig.schema';

package/dist/types/src/component/module/context/contextConfig.schema.d.ts

@@ -1,8 +1,7 @@
-export declare const contextOperationNameSchema: import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"listContextFocuses", undefined>], undefined>;
+export declare const contextActionNameSchema: import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"listContextFocuses", undefined>], undefined>;
 export declare const contextConfigSchema: import('valibot').ObjectSchema<{
-    readonly typeId: import('valibot').LiteralSchema<"context", undefined>;
+    readonly actionNames: import('valibot').ArraySchema<import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"listContextFocuses", undefined>], undefined>, undefined>;
     readonly models: import('valibot').ArraySchema<import('valibot').ObjectSchema<{
-        readonly typeId: import('valibot').LiteralSchema<"contextModelGroup", undefined>;
         readonly modelRefs: import('valibot').ArraySchema<import('valibot').ObjectSchema<{
             readonly id: import('valibot').StringSchema<undefined>;
             readonly label: import('valibot').ObjectSchema<{
@@ -39,8 +38,8 @@ export declare const contextConfigSchema: import('valibot').ObjectSchema<{
             readonly label: import('valibot').StringSchema<undefined>;
         }, undefined>, undefined>;
         readonly statusId: import('valibot').NullableSchema<import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"alpha", undefined>, import('valibot').LiteralSchema<"beta", undefined>, import('valibot').LiteralSchema<"generalAvailability", undefined>, import('valibot').LiteralSchema<"notApplicable", undefined>, import('valibot').LiteralSchema<"preAlpha", undefined>, import('valibot').LiteralSchema<"proposed", undefined>, import('valibot').LiteralSchema<"releaseCandidate", undefined>, import('valibot').LiteralSchema<"unavailable", undefined>, import('valibot').LiteralSchema<"underReview", undefined>], undefined>, undefined>;
+        readonly typeId: import('valibot').LiteralSchema<"contextModelGroup", undefined>;
     }, undefined>, undefined>;
-    readonly operations: import('valibot').ArraySchema<import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"listContextFocuses", undefined>], undefined>, undefined>;
     readonly version: import('valibot').StringSchema<undefined>;
     readonly id: import('valibot').StringSchema<undefined>;
     readonly label: import('valibot').ObjectSchema<{
@@ -61,4 +60,5 @@ export declare const contextConfigSchema: import('valibot').ObjectSchema<{
         readonly label: import('valibot').StringSchema<undefined>;
     }, undefined>, undefined>;
     readonly statusId: import('valibot').NullableSchema<import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"alpha", undefined>, import('valibot').LiteralSchema<"beta", undefined>, import('valibot').LiteralSchema<"generalAvailability", undefined>, import('valibot').LiteralSchema<"notApplicable", undefined>, import('valibot').LiteralSchema<"preAlpha", undefined>, import('valibot').LiteralSchema<"proposed", undefined>, import('valibot').LiteralSchema<"releaseCandidate", undefined>, import('valibot').LiteralSchema<"unavailable", undefined>, import('valibot').LiteralSchema<"underReview", undefined>], undefined>, undefined>;
+    readonly typeId: import('valibot').LiteralSchema<"context", undefined>;
 }, undefined>;

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

@@ -1,14 +1,14 @@
 import { InferOutput } from 'valibot';
 import { EngineContextActionOptions } from '../engine';
 import { Component, ComponentConfig, ComponentReference } from '../..';
-import { contextConfigSchema, contextOperationNameSchema } from './contextConfig.schema';
+import { contextActionNameSchema, contextConfigSchema } from './contextConfig.schema';
 export { contextConfigSchema } from './contextConfig.schema';
 export interface ContextInterface extends Component {
     readonly config: ContextConfig;
     listContextFocuses?(context: ContextInterface, options?: ListContextOptions): Promise<ListContextResult>;
 }
 export type ContextConfig = InferOutput<typeof contextConfigSchema>;
-export type ContextOperationName = InferOutput<typeof contextOperationNameSchema>;
+export type ContextActionName = InferOutput<typeof contextActionNameSchema>;
 export interface ContextModelGroupConfig extends ComponentConfig {
     modelRefs: ComponentReference[];
     order: number;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@dpuse/dpuse-shared",
-    "version": "0.3.703",
+    "version": "0.3.706",
     "private": false,
     "description": "Common constants, types and utilities used across all DPUse projects.",
     "license": "MIT",