@dpuse/dpuse-shared 0.3.593

package/dist/types/src/component/presenter/presenterConfig.schema.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Presenter schema (drafted by Copilot).
+ */
+export declare const presenterConfigSchema: import('valibot').ObjectSchema<{
+    readonly typeId: import('valibot').LiteralSchema<"presenter", undefined>;
+    readonly presentations: import('valibot').ArraySchema<import('valibot').ObjectSchema<{
+        readonly id: import('valibot').StringSchema<undefined>;
+        readonly label: import('valibot').ObjectSchema<{
+            readonly 'en-au': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+            readonly 'en-gb': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+            readonly 'en-us': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+            readonly 'es-es': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+        }, undefined>;
+        readonly description: import('valibot').ObjectSchema<{
+            readonly 'en-au': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+            readonly 'en-gb': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+            readonly 'en-us': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+            readonly 'es-es': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+        }, undefined>;
+        readonly icon: import('valibot').NullableSchema<import('valibot').StringSchema<undefined>, undefined>;
+        readonly iconDark: import('valibot').NullableSchema<import('valibot').StringSchema<undefined>, undefined>;
+        readonly order: import('valibot').NumberSchema<undefined>;
+        readonly path: import('valibot').StringSchema<undefined>;
+    }, undefined>, undefined>;
+    readonly operations: import('valibot').ArraySchema<import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"list", undefined>, import('valibot').LiteralSchema<"render", undefined>, import('valibot').LiteralSchema<"setColorMode", undefined>], undefined>, undefined>;
+    readonly version: import('valibot').StringSchema<undefined>;
+    readonly id: import('valibot').StringSchema<undefined>;
+    readonly label: import('valibot').ObjectSchema<{
+        readonly 'en-au': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+        readonly 'en-gb': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+        readonly 'en-us': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+        readonly 'es-es': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+    }, undefined>;
+    readonly description: import('valibot').ObjectSchema<{
+        readonly 'en-au': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+        readonly 'en-gb': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+        readonly 'en-us': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+        readonly 'es-es': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+    }, undefined>;
+    readonly firstCreatedAt: import('valibot').OptionalSchema<import('valibot').NumberSchema<undefined>, undefined>;
+    readonly icon: import('valibot').NullableSchema<import('valibot').StringSchema<undefined>, undefined>;
+    readonly iconDark: import('valibot').NullableSchema<import('valibot').StringSchema<undefined>, undefined>;
+    readonly lastUpdatedAt: import('valibot').NullableSchema<import('valibot').NumberSchema<undefined>, undefined>;
+    readonly status: import('valibot').NullableSchema<import('valibot').ObjectSchema<{
+        readonly id: import('valibot').StringSchema<undefined>;
+        readonly color: import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"amber", undefined>, import('valibot').LiteralSchema<"green", undefined>, import('valibot').LiteralSchema<"red", undefined>, import('valibot').LiteralSchema<"other", undefined>], undefined>;
+        readonly label: import('valibot').StringSchema<undefined>;
+    }, undefined>, undefined>;
+    readonly statusId: 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>;

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

@@ -0,0 +1,13 @@
+import { ModuleConfig } from '../module';
+/**
+ * Tool configuration.
+ */
+interface ToolConfig extends ModuleConfig {
+    typeId: 'tool';
+}
+/**
+ * Load tool.
+ */
+declare function loadTool<T>(toolConfigs: ToolConfig[], toolId: string): Promise<T>;
+export { loadTool };
+export type { ToolConfig };

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

@@ -0,0 +1,26 @@
+/**
+ * Encoding.
+ */
+/**
+ * Encoding configuration.
+ */
+interface EncodingConfig {
+    id: string;
+    confidenceLevel: number | undefined;
+}
+/**
+ * Encoding type configuration.
+ */
+interface EncodingTypeConfig {
+    id: string;
+    groupLabel: string;
+    label: string;
+    isDetectable: boolean;
+    isDecodable: boolean;
+}
+declare const encodingConfigMap: Record<string, EncodingTypeConfig>;
+/**
+ * Get encoding type configurations.
+ */
+declare function getEncodingTypeConfigs(localeId?: string): EncodingTypeConfig[];
+export { type EncodingConfig, encodingConfigMap, type EncodingTypeConfig, getEncodingTypeConfigs };

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

@@ -0,0 +1,58 @@
+import { ConnectionConfig } from '../component/connector/connection';
+import { EncodingTypeConfig } from '../encoding';
+import { ModuleConfig } from '../component/module';
+import { ObjectColumnConfig } from '../component/connector';
+import { ToolConfig } from '../component/tool';
+import { ContextConfig, ContextOperationOptions } from '../component/context';
+import { InferenceRecord, InferenceSummary, ParsingRecord } from '../component/dataView';
+/**
+ * Engine runtime interface.
+ */
+interface EngineRuntimeInterface {
+    getEncodingTypeConfigs: (localeId: string) => EncodingTypeConfig[];
+    invokeWorker(errorEventCallback: (errorEvent: ErrorEvent) => void): EngineWorkerInterface;
+}
+/**
+ * Engine operation options.
+ */
+interface EngineOperationOptions {
+    accountId?: string;
+    appCheckToken?: string;
+    sessionAccessToken?: string;
+}
+/**
+ * Engine worker interface.
+ */
+interface EngineWorkerInterface {
+    initialise: (options: EngineWorkerInitialiseOptions) => Promise<void>;
+    processRequest: (id: string, config: ConnectionConfig | ContextConfig, options: EngineOperationOptions | ContextOperationOptions, callback?: (callbackData: EngineCallbackData) => void) => Promise<unknown>;
+}
+/**
+ * Engine worker initialise options.
+ */
+interface EngineWorkerInitialiseOptions {
+    connectorStorageURLPrefix: string;
+    toolConfigs: ToolConfig[];
+}
+/**
+ * Engine configuration.
+ */
+interface EngineConfig extends ModuleConfig {
+    typeId: 'engine';
+}
+/**
+ * Engine callback data.
+ */
+interface EngineCallbackData {
+    typeId: string;
+    properties: Record<string, unknown>;
+}
+/**
+ * Engine utilities.
+ */
+interface EngineUtilities {
+    hasReadableStreamTransferSupport(): boolean;
+    inferValues: (parsedRecord: ParsingRecord, columnConfigs: ObjectColumnConfig[], leadingRecord: boolean) => InferenceRecord;
+    inferDataTypes: (parsedRecords: ParsingRecord[]) => InferenceSummary;
+}
+export type { EngineCallbackData, EngineConfig, EngineOperationOptions, EngineRuntimeInterface, EngineUtilities, EngineWorkerInitialiseOptions, EngineWorkerInterface };

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

@@ -0,0 +1,37 @@
+export interface SerialisedError {
+    data: Record<string, unknown> | undefined;
+    locator: string;
+    message: string;
+    name: string;
+    stack: string | undefined;
+}
+export declare class DPUseError extends Error {
+    readonly data: Record<string, unknown> | undefined;
+    readonly locator: string;
+    constructor(message: string, locator: string, data?: Record<string, unknown>, options?: ErrorOptions);
+}
+export declare class AppError extends DPUseError {
+    constructor(message: string, locator: string, data?: Record<string, unknown>, options?: ErrorOptions);
+}
+export declare class APIError extends DPUseError {
+    constructor(message: string, locator: string, data?: Record<string, unknown>, options?: ErrorOptions);
+}
+export declare class EngineError extends DPUseError {
+    constructor(message: string, locator: string, data?: Record<string, unknown>, options?: ErrorOptions);
+}
+export declare class ConnectorError extends DPUseError {
+    constructor(message: string, locator: string, data?: Record<string, unknown>, options?: ErrorOptions);
+}
+export declare class FetchError extends DPUseError {
+    constructor(message: string, locator: string, data?: Record<string, unknown>, options?: ErrorOptions);
+}
+export declare function buildFetchError(response: {
+    status: number;
+    statusText: string;
+    text: () => Promise<string>;
+}, message: string, locator: string): Promise<FetchError>;
+export declare function concatenateSerialisedErrorMessages(serialisedErrors: SerialisedError[]): string;
+export declare function ignoreErrors(action: () => void): void;
+export declare function normalizeToError(value: unknown): Error;
+export declare function serialiseError(error?: unknown): SerialisedError[];
+export declare function unserialiseError(serialisedErrors: SerialisedError[]): Error | undefined;

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

@@ -0,0 +1,34 @@
+/**
+ * Shared composables, constants, errors, interfaces, schemas, types and utilities.
+ */
+/** Interfaces/Types - Context. */
+export { contextConfigSchema } from './component/context';
+export type { Context, ContextConfig, ContextLocalisedConfig, ContextListOptions, ContextListResult, ContextOperation } from './component/context';
+/** Interfaces/Types - Context model. */
+export type { ContextModelGroupConfig, ContextModelGroupLocalisedConfig, ContextModelConfig, ContextModelLocalisedConfig } from './component/context';
+/** Interfaces/Types - Context model dimension. */
+export type { ContextModelDimensionGroupConfig, ContextModelDimensionGroupLocalisedConfig, ContextModelDimensionConfig, ContextModelDimensionLocalisedConfig, ContextModelDimensionHierarchyConfig, ContextModelDimensionHierarchyLocalisedConfig } from './component/context';
+/** Interfaces/Types - Context model entity. */
+export type { ContextModelEntityGroupConfig, ContextModelEntityGroupLocalisedConfig, ContextModelEntityConfig, ContextModelEntityLocalisedConfig, ContextModelEntityDataItemConfig, // Data items.
+ContextModelEntityDataItemLocalisedConfig, ContextModelEntityEventConfig, // Events.
+ContextModelEntityEventLocalisedConfig, ContextModelEntityPrimaryMeasureConfig, // Primary measures.
+ContextModelEntityPrimaryMeasureLocalisedConfig } from './component/context';
+/** Interfaces/Types - Context model secondary measure. */
+export type { ContextModelSecondaryMeasureGroupConfig, ContextModelSecondaryMeasureGroupLocalisedConfig, ContextModelSecondaryMeasureConfig, ContextModelSecondaryMeasureLocalisedConfig } from './component/context';
+/** Interfaces/Types - Context Operator Settings */
+export interface ContextOperationOptions {
+    accountId?: string;
+    appCheckToken?: string;
+    sessionAccessToken?: string;
+}
+/** Interfaces/Types - Dimension. */
+export type { DimensionConfig, DimensionLocalisedConfig } from './component/dimension';
+/** Interfaces/Types - Event query. */
+export type { EventQueryConfig, EventQueryLocalisedConfig } from './component/eventQuery';
+/** Interfaces/Types */
+export { presenterConfigSchema } from './component/presenter';
+export type { Presenter, PresenterConfig, PresenterLocalisedConfig, PresenterOperation } from './component/presenter';
+/** Interfaces/Types - Presenter presentation. */
+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';
+/** Utilities */

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

@@ -0,0 +1,26 @@
+/**
+ * Locale constants and type declarations.
+ */
+declare const DEFAULT_LOCALE_CODE: LocaleCode;
+/**
+ * Locale codes.
+ */
+type LocaleCode = 'en' | 'en-au' | 'en-gb' | 'en-us' | 'es-es';
+/**
+ * Localised string.
+ */
+type LocalisedString = Record<LocaleCode, string>;
+/**
+ *
+ */
+type LocaleLabelMap = ReadonlyMap<string, string>;
+/**
+ *
+ */
+declare const createLabelMap: (labels: Record<string, string>) => LocaleLabelMap;
+/**
+ *
+ */
+declare const resolveLabel: (labels: LocaleLabelMap, localeId: string, fallbackLocaleId?: "en-gb") => string | undefined;
+export { createLabelMap, DEFAULT_LOCALE_CODE, resolveLabel };
+export type { LocaleCode, LocaleLabelMap, LocalisedString };

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

@@ -0,0 +1,12 @@
+/**
+ * Utilities.
+ */
+export declare function convertODataTypeIdToUsageTypeId(oDataTypeId: string): string;
+export declare function extractNameFromPath(itemPath: string): string | undefined;
+export declare function extractExtensionFromPath(itemPath: string): string | undefined;
+export declare function formatNumberAsDecimalNumber(number?: number, decimalPlaces?: number, minimumFractionDigits?: number, locale?: string): string;
+export declare function formatNumberAsSize(number?: number): string;
+export declare function formatNumberAsStorageSize(number?: number): string;
+export declare function formatNumberAsDuration(number?: number): string;
+export declare function formatNumberAsWholeNumber(number?: number, locale?: string): string;
+export declare function lookupMimeTypeForExtension(extension?: string): string;

package/dist/types/vite.config.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Vite configuration.
+ */
+declare const _default: import('vite').UserConfig;
+export default _default;

package/package.json

@@ -0,0 +1,120 @@
+{
+    "name": "@dpuse/dpuse-shared",
+    "version": "0.3.593",
+    "description": "Common constants, types and utilities used across all DPUse projects.",
+    "license": "MIT",
+    "author": "Jonathan Terrell <terrell.jm@gmail.com>",
+    "private": false,
+    "type": "module",
+    "homepage": "https://www.dpuse.app",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/data-positioning/dpuse-shared.git"
+    },
+    "bugs": {
+        "url": "https://github.com/data-positioning/dpuse-shared/issues"
+    },
+    "module": "./dist/dpuse-shared.es.js",
+    "types": "./dist/types/src/index.d.ts",
+    "exports": {
+        ".": {
+            "import": "./dist/dpuse-shared.es.js",
+            "types": "./dist/types/src/index.d.ts"
+        },
+        "./component": {
+            "import": "./dist/dpuse-shared-component.es.js",
+            "types": "./dist/types/src/component/index.d.ts"
+        },
+        "./component/connector": {
+            "import": "./dist/dpuse-shared-connector.es.js",
+            "types": "./dist/types/src/component/connector/index.d.ts"
+        },
+        "./component/dataView": {
+            "import": "./dist/dpuse-shared-dataview.es.js",
+            "types": "./dist/types/src/component/dataView/index.d.ts"
+        },
+        "./component/tool": {
+            "import": "./dist/dpuse-shared-tools.es.js",
+            "types": "./dist/types/src/component/tool/index.d.ts"
+        },
+        "./encoding": {
+            "import": "./dist/dpuse-shared-encoding.es.js",
+            "types": "./dist/types/src/encoding/index.d.ts"
+        },
+        "./engine": {
+            "import": "./dist/dpuse-shared-engine.es.js",
+            "types": "./dist/types/src/engine/index.d.ts"
+        },
+        "./errors": {
+            "import": "./dist/dpuse-shared-errors.es.js",
+            "types": "./dist/types/src/errors/index.d.ts"
+        },
+        "./locale": {
+            "import": "./dist/dpuse-shared-locale.es.js",
+            "types": "./dist/types/src/localt/index.d.ts"
+        },
+        "./utilities": {
+            "import": "./dist/dpuse-shared-utilities.es.js",
+            "types": "./dist/types/src/utilities/index.d.ts"
+        }
+    },
+    "sideEffects": false,
+    "files": [
+        "dist"
+    ],
+    "prettier": "@dpuse/dpuse-development/prettierrc",
+    "devDependencies": {
+        "@dpuse/dpuse-development": "^0.3.472",
+        "@dpuse/eslint-config-dpuse": "^1.0.49",
+        "@types/node": "^25.5.0",
+        "@typescript-eslint/eslint-plugin": "^8.57.1",
+        "@typescript-eslint/parser": "^8.57.1",
+        "eslint": "^9.39.4",
+        "eslint-import-resolver-typescript": "^4.4.4",
+        "eslint-plugin-import": "^2.32.0",
+        "eslint-plugin-security": "^4.0.0",
+        "eslint-plugin-sonarjs": "^4.0.2",
+        "eslint-plugin-unicorn": "^63.0.0",
+        "file-type": "^21.3.3",
+        "jiti": "^2.6.1",
+        "license-downloader": "^1.3.3",
+        "license-report": "^6.8.2",
+        "license-report-check": "^0.1.2",
+        "license-report-recursive": "^6.8.3",
+        "md-to-pdf": "^5.2.5",
+        "npm-check-updates": "^19.6.5",
+        "owasp-dependency-check": "^1.0.1",
+        "prettier": "^3.8.1",
+        "rollup-plugin-visualizer": "^7.0.1",
+        "sonda": "^0.11.1",
+        "type-fest": "^5.5.0",
+        "typedoc": "^0.28.17",
+        "typedoc-github-theme": "^0.4.0",
+        "typedoc-material-theme": "^1.4.1",
+        "typescript": "^5.9.3",
+        "valibot": "^1.3.1",
+        "vite": "^8.0.1",
+        "vite-plugin-dts": "^4.5.4",
+        "vitest": "^4.1.0"
+    },
+    "scripts": {
+        "audit": "op run --env-file=.env -- node -e \"import('@dpuse/dpuse-development').then(m => m.auditDependencies())\"",
+        "build": "node -e \"import('@dpuse/dpuse-development').then(m => m.buildProject())\"",
+        "check": "node -e \"import('@dpuse/dpuse-development').then(m => m.checkDependencies())\"",
+        "document": "op run --env-file=.env -- node -e \"import('@dpuse/dpuse-development').then(m => m.documentDependencies(['MIT']))\"",
+        "format": "node -e \"import('@dpuse/dpuse-development').then(m => m.formatCode())\"",
+        "lint": "node -e \"import('@dpuse/dpuse-development').then(m => m.lintCode())\"",
+        "release": "op run --env-file=.env -- node -e \"import('@dpuse/dpuse-development').then(m => m.releaseProject())\"",
+        "sync": "node -e \"import('@dpuse/dpuse-development').then(m => m.syncProjectWithGitHub())\"",
+        "test": "node -e \"import('@dpuse/dpuse-development').then(m => m.testProject())\"",
+        "update": "node -e \"import('@dpuse/dpuse-development').then(m => m.updateDPUseDependencies(['development', 'eslint']))\"",
+        "_readmeToPDF": "md-to-pdf README.md",
+        "_td": "npx typedoc --options docs/typedoc.json",
+        "_td:github": "npx typedoc --options docs/typedoc.json --plugin typedoc-github-theme",
+        "_td:material": "npx typedoc --options docs/typedoc.json  --plugin typedoc-material-theme --themeColor '#cb9820'"
+    },
+    "engines": {
+        "node": ">=22.0.0",
+        "npm": ">=11.0.0"
+    }
+}