@datapos/datapos-shared 0.3.319 → 0.3.325

package/README.md

@@ -1,8 +1,6 @@
 # Data Positioning Shared Library
 
-<span><!-- OWASP_BADGES_START -->
-[![OWASP](https://img.shields.io/badge/OWASP-passed-4CAF50)](https://data-positioning.github.io/datapos-shared/dependency-check-reports/dependency-check-report.html)
-<!-- OWASP_BADGES_END --></span>
+<span><!-- OWASP_BADGES_START -->[![OWASP](https://img.shields.io/badge/OWASP-passed-4CAF50)](https://data-positioning.github.io/datapos-shared/dependency-check-reports/dependency-check-report.html)<!-- OWASP_BADGES_END --></span>
 [![npm version](https://img.shields.io/npm/v/@datapos/datapos-shared.svg)](https://www.npmjs.com/package/@datapos/datapos-shared)
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](./LICENSE)
 
@@ -46,7 +44,7 @@ Each module implements a set of components. All module component types extend th
 | ComponentStatus                 |                                                              |
 | ComponentStatusId               |                                                              |
 | ComponentTypeId                 |                                                              |
-| StatusColorId                   |                                                              |
+| ComponentStatusColorId          |                                                              |
 
 #### Connector Module Components
 
@@ -121,11 +119,12 @@ The following table lists top-level production and peer dependencies. All these
 The following table lists top-level production and peer dependencies. All these dependencies (including transitive ones) have been recursively verified to use Apache-2.0, BSD-2-Clause, CC0-1.0, or MIT—commercially friendly licenses with minimal restrictions. Developers cloning this repository should independently verify dev and optional dependencies; users of the published library are covered by these checks. We do not include unlicensed dependencies. Used to support development activity and not released as part of the production release. Check if you clone. We use the `npm` packages [license-report](https://www.npmjs.com/package/license-report), [license-report-check](https://www.npmjs.com/package/license-report-check) and [license-report-recursive](https://www.npmjs.com/package/license-report-recursive) to identify dependency licenses.
 
 <!-- DEPENDENCY_LICENSES_START -->
-|Name|Type|Installed|Latest|Latest Released|Deps|Document|
-|:-|:-|:-:|:-:|:-|-:|:-|
-|csv-parse|MIT|6.1.0|6.1.0|5 months ago: 2025-07-16|0|⚠️ No license file|
-|date-fns|MIT|4.1.0|4.1.0|4 months ago: 2025-08-03|0|[LICENSE.md](https://raw.githubusercontent.com/date-fns/date-fns/main/LICENSE.md)|
-|nanoid|MIT|5.1.6|5.1.6|2 months ago: 2025-09-22|0|[LICENSE](https://raw.githubusercontent.com/ai/nanoid/main/LICENSE)|
+
+| Name      | Type | Installed | Latest | Latest Released          | Deps | Document                                                                          |
+| :-------- | :--- | :-------: | :----: | :----------------------- | ---: | :-------------------------------------------------------------------------------- |
+| csv-parse | MIT  |   6.1.0   | 6.1.0  | 5 months ago: 2025-07-16 |    0 | ⚠️ No license file                                                                |
+| date-fns  | MIT  |   4.1.0   | 4.1.0  | 4 months ago: 2025-08-03 |    0 | [LICENSE.md](https://raw.githubusercontent.com/date-fns/date-fns/main/LICENSE.md) |
+| nanoid    | MIT  |   5.1.6   | 5.1.6  | 2 months ago: 2025-09-22 |    0 | [LICENSE](https://raw.githubusercontent.com/ai/nanoid/main/LICENSE)               |
 
 <!-- DEPENDENCY_LICENSES_END -->
 

package/dist/types/src/component/componentConfig.schema.d.ts

@@ -15,7 +15,7 @@ export declare const partialLocalisedStringSchema: import('valibot').ObjectSchem
     readonly 'en-us': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
     readonly 'es-es': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
 }, undefined>;
-export declare const statusColorIdSchema: LiteralUnionSchema<readonly ["amber", "green", "red", "other"]>;
+export declare const componentStatusColorIdSchema: LiteralUnionSchema<readonly ["amber", "green", "red", "other"]>;
 export declare const componentStatusIdSchema: LiteralUnionSchema<readonly ["alpha", "beta", "generalAvailability", "notApplicable", "preAlpha", "proposed", "releaseCandidate", "unavailable", "underReview"]>;
 export declare const componentTypeIdSchema: LiteralUnionSchema<readonly ["app", "connector", "connectorConnection", "context", "contextModelGroup", "contextModel", "contextModelDimensionGroup", "contextModelDimension", "contextModelDimensionHierarchy", "contextModelEntityGroup", "contextModelEntity", "contextModelEntityDataItem", "contextModelEntityEvent", "contextModelEntityPrimaryMeasure", "contextModelSecondaryMeasureGroup", "contextModelSecondaryMeasure", "dataView", "dimension", "engine", "eventQuery", "presenter", "presenterPresentation", "tool"]>;
 export declare const moduleTypeIdSchema: LiteralUnionSchema<readonly ["app", "engine", "connector", "context", "presenter", "tool"]>;

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

@@ -1,3 +1,7 @@
+/**
+ * Connector schema.
+ * Drafted by Copilot.
+ */
 export declare const connectorConfigSchema: import('valibot').ObjectSchema<{
     readonly typeId: import('valibot').LiteralSchema<"connector", undefined>;
     readonly category: import('valibot').NullableSchema<import('valibot').ObjectSchema<{

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

@@ -25,7 +25,8 @@ export interface Connector extends Component {
     describeConnection?(connector: Connector, settings: DescribeSettings): Promise<DescribeResult>;
     dropObject?(connector: Connector, settings: DropSettings): Promise<void>;
     findObject?(connector: Connector, findSettings: FindSettings): Promise<FindResult>;
-    getRecord?(connector: Connector, getSettings: GetSettings): Promise<GetResult>;
+    getReader?(connector: Connector, getSettings: GetReaderSettings): Promise<GetReaderResult>;
+    getRecord?(connector: Connector, getSettings: GetRecordSettings): Promise<GetRecordResult>;
     listNodes?(connector: Connector, settings: ListSettings): Promise<ListResult>;
     previewObject?(connector: Connector, settings: PreviewSettings): Promise<PreviewResult>;
     removeRecords?(connector: Connector, settings: RemoveSettings): Promise<void>;
@@ -107,11 +108,18 @@ export interface FindSettings extends ConnectorOperationSettings {
 export interface FindResult {
     folderPath?: string;
 }
-export interface GetSettings extends ConnectorOperationSettings {
+export interface GetReaderSettings extends ConnectorOperationSettings {
     id: string;
     path: string;
 }
-export interface GetResult {
+export interface GetReaderResult {
+    record?: string[] | Record<string, unknown>;
+}
+export interface GetRecordSettings extends ConnectorOperationSettings {
+    id: string;
+    path: string;
+}
+export interface GetRecordResult {
     record?: string[] | Record<string, unknown>;
 }
 export interface ListSettings extends ConnectorOperationSettings {
@@ -168,4 +176,5 @@ interface ConnectorCategory {
     id: string;
     label: string;
 }
+/** Exposures */
 export { connectorConfigSchema } from './connectorConfig.schema';

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

@@ -1,3 +1,7 @@
+/**
+ * Context schema.
+ * Drafted by Copilot.
+ */
 export declare const contextConfigSchema: import('valibot').ObjectSchema<{
     readonly typeId: import('valibot').LiteralSchema<"context", undefined>;
     readonly models: import('valibot').ArraySchema<import('valibot').ObjectSchema<{

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

@@ -1,22 +1,14 @@
 import { InferOutput } from 'valibot';
-import { componentConfigSchema } from './componentConfig.schema';
-import { LocaleCode, LocalisedString, StatusColorId } from '../index';
+import { componentConfigSchema, componentStatusColorIdSchema, componentStatusIdSchema, componentStatusSchema, componentTypeIdSchema } from './componentConfig.schema';
+import { LocaleCode, LocalisedString } from '../index';
 export interface Component {
     readonly config: ComponentConfig;
 }
 export type ComponentConfig = InferOutput<typeof componentConfigSchema>;
-export interface ComponentConfig1 {
-    id: string;
-    label: Partial<LocalisedString>;
-    description: Partial<LocalisedString>;
-    firstCreatedAt?: number;
-    icon: string | null;
-    iconDark: string | null;
-    lastUpdatedAt: number | null;
-    status: ComponentStatus | null;
-    statusId: ComponentStatusId;
-    typeId: ComponentTypeId;
-}
+export type ComponentStatus = InferOutput<typeof componentStatusSchema>;
+export type ComponentStatusColorId = InferOutput<typeof componentStatusColorIdSchema>;
+export type ComponentStatusId = InferOutput<typeof componentStatusIdSchema>;
+export type ComponentTypeId = InferOutput<typeof componentTypeIdSchema>;
 export interface ComponentReference {
     id: string;
     label: Partial<LocalisedString>;
@@ -26,17 +18,11 @@ export interface ComponentReference {
     order: number;
     path: string;
 }
-export interface ComponentStatus {
-    id: string;
-    color: StatusColorId;
-    label: string;
-}
-export type ComponentStatusId = 'alpha' | 'beta' | 'generalAvailability' | 'notApplicable' | 'preAlpha' | 'proposed' | 'releaseCandidate' | 'unavailable' | 'underReview';
 export declare const getComponentStatus: (id: string, localeId?: LocaleCode) => ComponentStatus;
-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';
+/** Exposures */
 export { componentConfigSchema } from './componentConfig.schema';

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

@@ -1,3 +1,7 @@
+/**
+ * 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<{

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

@@ -5,29 +5,15 @@
 export type LocaleCode = 'en-au' | 'en-gb' | 'en-us' | 'es-es';
 export type LocalisedString = Record<LocaleCode, string>;
 /** Interfaces/Types - Component */
-export type { ComponentConfig, ComponentReference, ComponentStatus, ComponentStatusId, ComponentTypeId, ModuleConfig, ModuleTypeId } from './component';
-export type StatusColorId = 'amber' | 'green' | 'red' | 'other';
+export type { ComponentConfig, ComponentReference, ComponentStatus, ComponentStatusId, ComponentTypeId, ModuleConfig, ModuleTypeId, ComponentStatusColorId } from './component';
 /** Schemas - Component */
 export { componentConfigSchema } from './component';
 /** Constants - Connector */
 export { CONNECTOR_DESTINATION_OPERATIONS, CONNECTOR_SOURCE_OPERATIONS } from './component/connector';
 /** Interfaces/Types Component - Connector */
-export type { ConnectorOperation, ConnectorUsageId } 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';
-export type { DropSettings } from './component/connector';
-export type { FindResult, FindSettings } from './component/connector';
-export type { GetResult, GetSettings } from './component/connector';
-export type { InitialiseSettings } from './component/connector';
-export type { ListResult, ListSettings } from './component/connector';
-export type { PreviewResult, PreviewSettings } from './component/connector';
-export type { RemoveSettings } from './component/connector';
-export type { RetrieveResult, RetrieveSettings, RetrieveSummary } from './component/connector';
-export type { UpsertSettings } from './component/connector';
+export type { AuditContentResult, AuditContentSettings, Connector, ConnectorCallbackData, ConnectorConfig, ConnectorImplementation, ConnectorLocalisedConfig, ConnectorOperation, ConnectorOperationSettings, ConnectorTools, ConnectorUsageId, CreateSettings, DropSettings, FindResult, FindSettings, GetReaderResult, GetReaderSettings, GetRecordResult, GetRecordSettings, InitialiseSettings, ListResult, ListSettings, PreviewResult, PreviewSettings, RemoveSettings, RetrieveResult, RetrieveSettings, RetrieveSummary, UpsertSettings } from './component/connector';
 /** Interfaces/Types - Connection */
-export type { ConnectionAuthorizationConfig, ConnectionColumnConfig, ConnectionConfig, ConnectionNodeConfig } from './component/connector/connection';
-export type { DPAFileSystemFileHandle, Encoding, StorageTypeId, UsageTypeId } from './component/connector/connection';
+export type { ConnectionAuthorizationConfig, ConnectionColumnConfig, ConnectionConfig, ConnectionNodeConfig, DPAFileSystemFileHandle, Encoding, StorageTypeId, UsageTypeId } from './component/connector/connection';
 /** Schemas - Connector  */
 export { connectorConfigSchema } from './component/connector';
 /** Interfaces/Types - Context. */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@datapos/datapos-shared",
-    "version": "0.3.319",
+    "version": "0.3.325",
     "description": "A library containing common constants, types and utilities used across all Data Positioning projects.",
     "license": "MIT",
     "author": "Jonathan Terrell <terrell.jm@gmail.com>",
@@ -49,6 +49,7 @@
         "license-report": "^6.8.1",
         "license-report-check": "^0.1.2",
         "license-report-recursive": "^6.8.2",
+        "md-to-pdf": "^5.2.5",
         "nanoid": "^5.1.6",
         "npm-check-updates": "^19.2.0",
         "owasp-dependency-check": "^1.0.0",
@@ -71,7 +72,8 @@
         "release": "op run --env-file=.env -- node -e \"import('@datapos/datapos-development').then(m => m.releaseProject())\"",
         "sync": "node -e \"import('@datapos/datapos-development').then(m => m.syncProjectWithGitHub())\"",
         "test": "node -e \"import('@datapos/datapos-development').then(m => m.testProject())\"",
-        "update": "node -e \"import('@datapos/datapos-development').then(m => m.updateDataPosDependencies(['development']))\""
+        "update": "node -e \"import('@datapos/datapos-development').then(m => m.updateDataPosDependencies(['development']))\"",
+        "_readmeToPDF": "md-to-pdf README.md"
     },
     "engines": {
         "node": ">=22.0.0",