@datapos/datapos-shared 0.3.342 → 0.3.348

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

@@ -1,63 +1,83 @@
-/** Interfaces/Types - Serialised error data. */
-export interface SerialisedError {
-    body?: string;
-    componentName?: string;
-    info?: string;
-    locator: string;
-    message: string;
-    name: string;
-    stack?: string;
-}
-/** Classes - Base Data Positioning error. */
+/**
+ * Error classes and utilities.
+ */
+/** Serializable representation of an error and its cause chain.
+ * Used for logging, reporting, and transport across process or network boundaries.
+ */
+interface SerialisedError {
+    /** HTTP response body (Fetch errors only). */ body?: string;
+    /** Vue component name (Vue errors only). */ componentName?: string;
+    /** Vue error info string. */ info?: string;
+    /** Logical source of the error. */ locator: string;
+    /** Human-readable error message. */ message: string;
+    /** Error class or type name. */ name: string;
+    /** Stack trace, if available. */ stack?: string;
+}
+/** Base class for all Data Positioning errors.
+ * All errors include a `locator` identifying the logical source of the error (module, feature, or operation).
+ */
 declare class DataPosError extends Error {
-    locator: string;
+    readonly locator: string; /** Logical source of the error. */
     constructor(message: string, locator: string, options?: ErrorOptions);
 }
-/** Classes - Base application error. */
-export declare class ApplicationError extends DataPosError {
-    constructor(message: string, locator: string, options?: ErrorOptions);
+/** Represents application-level failures.
+ * Used for errors originating from application logic, not external systems.
+ */
+declare class ApplicationError extends DataPosError {
 }
-/** Classes - Application Error - API error. */
-export declare class APIError extends ApplicationError {
-    constructor(message: string, locator: string, options?: ErrorOptions);
+/** Represents API-related failures.
+ * Typically thrown when backend requests fail or return invalid responses.
+ */
+declare class APIError extends ApplicationError {
 }
-/** Classes - Application Error - Engine Error */
-export declare class EngineError extends ApplicationError {
-    constructor(message: string, locator: string, options?: ErrorOptions);
+/** Represents engine or core processing failures. */
+declare class EngineError extends ApplicationError {
 }
-/** Classes - Application Error - Fetch error. */
-export declare class FetchError extends ApplicationError {
-    body: string;
-    constructor(message: string, locator: string, body: string, options?: ErrorOptions);
+/** Represents failures during HTTP requests.
+ * Includes a sanitized snapshot of the response body for diagnostic purposes.
+ */
+declare class FetchError extends ApplicationError {
+    readonly body?: string; /** Sanitized HTTP response body. */
+    constructor(message: string, locator: string, body?: string | null, options?: ErrorOptions);
 }
-/** Classes - Application Error - Vue error. */
-export declare class VueError extends ApplicationError {
-    componentName?: string;
-    info: string;
-    constructor(message: string, locator: string, info: string, componentName?: string, options?: ErrorOptions);
+/** Represents operational failures not caused by application logic. */
+declare class OperationalError extends DataPosError {
 }
-/** Classes - Application Error - Window runtime error. */
-export declare class WindowRuntimeError extends ApplicationError {
-    constructor(message: string, locator: string, options?: ErrorOptions);
+/** Represents Vue errors that have been explicitly handled.
+ * Used when capturing Vue error handler output with additional component context.
+ */
+declare class VueHandledError extends ApplicationError {
+    readonly componentName?: string; /** Vue component name, if available. */
+    readonly info: string; /** Vue error info string. */
+    constructor(message: string, locator: string, info: string, componentName?: string, options?: ErrorOptions);
 }
-/** Classes - Application Error - Window promise rejection error. */
-export declare class WindowPromiseRejectionError extends ApplicationError {
-    constructor(message: string, locator: string, options?: ErrorOptions);
+/** Represents handled window runtime errors. */
+declare class WindowHandledRuntimeError extends ApplicationError {
 }
-/** Classes - Operational error. */
-export declare class OperationalError extends DataPosError {
-    constructor(message: string, locator: string, options?: ErrorOptions);
+/** Represents handled window promise rejection errors. */
+declare class WindowHandledPromiseRejectionError extends ApplicationError {
 }
-/** Utilities - Build fetch error. */
-export declare function buildFetchError(response: {
+/** Builds a {@link FetchError} from an HTTP response.
+ * The response body is eagerly read so it can be included in error logs even after the response stream is closed.
+ */
+declare function buildFetchError(response: {
     status: number;
     statusText: string;
     text: () => Promise<string>;
 }, message: string, locator: string): Promise<FetchError>;
-/** Utilities - Concatenate serialised error messages. */
-export declare function concatenateSerialisedErrorMessages(serialisedErrors: SerialisedError[]): string;
-/** Utilities - Normalise to error. */
-export declare function normalizeToError(value: unknown): Error;
-/** Utilities - Serialise error. */
-export declare function serialiseError(error?: unknown): SerialisedError[];
-export {};
+/** Concatenates serialized error messages into a single string. */
+declare function concatenateSerialisedErrorMessages(serialisedErrors: SerialisedError[]): string;
+/** Normalizes an unknown thrown value into an {@link Error}.
+ * This function should be used at error boundaries to guarantee consistent error handling.
+ */
+declare function normalizeToError(value: unknown): Error;
+/** Serializes an error and its cause chain into a flat structure.
+ * - Errors are ordered from outermost to root cause.
+ * - Cycles in the cause chain are safely ignored.
+ * - Messages are normalized to end with punctuation.
+ */
+declare function serialiseError(error?: unknown): SerialisedError[];
+/** Exports */
+export type { SerialisedError };
+export { ApplicationError, APIError, EngineError, FetchError, OperationalError, VueHandledError, WindowHandledRuntimeError, WindowHandledPromiseRejectionError };
+export { buildFetchError, concatenateSerialisedErrorMessages, normalizeToError, serialiseError };

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

@@ -46,9 +46,7 @@ export type { ConnectorInterfaceResult, ContextInterfaceResult, Engine, EngineCo
 /** Interfaces/Types */
 export type { SerialisedError } from './errors';
 /** Errors */
-export { APIError, ApplicationError, EngineError, FetchError, OperationalError, VueError, WindowRuntimeError, WindowPromiseRejectionError } from './errors';
 /** Utilities */
-export { buildFetchError, concatenateSerialisedErrorMessages, normalizeToError, serialiseError } from './errors';
 /** Interfaces/Types - Event query. */
 export type { EventQueryConfig, EventQueryLocalisedConfig } from './component/eventQuery';
 /** Interfaces/Types */

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

@@ -1,5 +1,5 @@
 /**
- * Application utilities.
+ * Utilities.
  */
 export declare function convertODataTypeIdToUsageTypeId(oDataTypeId: string): string;
 export declare function extractNameFromPath(itemPath: string): string | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@datapos/datapos-shared",
-    "version": "0.3.342",
+    "version": "0.3.348",
     "description": "A library containing common constants, types and utilities used across all Data Positioning projects.",
     "license": "MIT",
     "author": "Jonathan Terrell <terrell.jm@gmail.com>",
@@ -14,15 +14,19 @@
     "bugs": {
         "url": "https://github.com/data-positioning/datapos-shared/issues"
     },
-    "module": "./dist/datapos-shared.index.es.js",
+    "module": "./dist/datapos-shared.es.js",
     "types": "./dist/types/src/index.d.ts",
     "exports": {
         ".": {
-            "import": "./dist/datapos-shared.index.es.js",
+            "import": "./dist/datapos-shared.es.js",
             "types": "./dist/types/src/index.d.ts"
         },
+        "./errors": {
+            "import": "./dist/datapos-shared-errors.es.js",
+            "types": "./dist/types/src/errors/index.d.ts"
+        },
         "./utilities": {
-            "import": "./dist/datapos-shared.utilities.es.js",
+            "import": "./dist/datapos-shared-utilities.es.js",
             "types": "./dist/types/src/utilities/index.d.ts"
         }
     },
@@ -61,6 +65,8 @@
         "rollup-plugin-visualizer": "^6.0.5",
         "sonda": "^0.10.1",
         "type-fest": "^5.3.1",
+        "typedoc": "^0.28.15",
+        "typedoc-material-theme": "^1.4.1",
         "typescript": "^5.9.3",
         "valibot": "^1.2.0",
         "vite": "^7.3.0",

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

@@ -1,33 +0,0 @@
-import { PreviewColumn } from './OLD_PreviewColumn';
-export interface ParsedValue {
-    isValid: boolean;
-    value: bigint | boolean | number | string | null;
-}
-export declare class ContentAuditColumn extends PreviewColumn {
-    doCountIndividualValidValues: boolean;
-    doCountPatterns: boolean;
-    invalidValueCount: number;
-    invalidValues: {
-        recordNumber: number;
-        value: string;
-    }[];
-    isRequired: boolean;
-    isUnique: boolean;
-    maxDecimals: number;
-    maxSize: number;
-    maxValue: boolean | number | string | undefined;
-    minDecimals: number;
-    minSize: number;
-    minValue: boolean | number | string | undefined;
-    patterns: Record<string, number>;
-    validValueCount: number;
-    validValues: Record<string, number>;
-    voidValueCount: number;
-    constructor(dataUsageTypeId: string, label: string);
-    addInvalidValue(originalValue: string, recordNumber: number): string;
-    addValidValue(originalValue: string, parsedValue: ParsedValue, wholeDigitCount?: number, decimalDigitCount?: number): ParsedValue;
-    addVoidValue(): null;
-    finalise(): void;
-    private determineNumericPattern;
-    private determineTextPattern;
-}

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

@@ -1,5 +0,0 @@
-export declare class PreviewColumn {
-    dataUsageTypeId: string;
-    label: string;
-    constructor(dataUsageTypeId: string, label: string);
-}