@datapos/datapos-shared 0.3.330 → 0.3.331

package/dist/datapos-shared.es.js

@@ -480,7 +480,7 @@ const oe = /* @__PURE__ */ b({
   "describeConnection",
   "dropObject",
   "findObject",
-  "getReader",
+  "getReadableStream",
   "getRecord",
   "listNodes",
   "previewObject",

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

@@ -1,7 +1,27 @@
 /**
- * Connector schema.
- * Drafted by Copilot.
+ * Connector schema (drafted by Copilot).
  */
+/** Schemas -  */
+export declare const connectorModuleCategoryIdSchema: import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"application", undefined>, import('valibot').LiteralSchema<"curatedDataset", undefined>, import('valibot').LiteralSchema<"database", undefined>, import('valibot').LiteralSchema<"fileStore", undefined>], undefined>;
+/** Schemas - Connector operations. */
+export declare const connectorOperationSchema: import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"abortOperation", undefined>, import('valibot').LiteralSchema<"authenticateConnection", 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<"retrieveRecords", undefined>, import('valibot').LiteralSchema<"upsertRecords", undefined>], undefined>;
+export declare const connectorUsageIdSchema: import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"bidirectional", undefined>, import('valibot').LiteralSchema<"destination", undefined>, import('valibot').LiteralSchema<"source", undefined>, import('valibot').LiteralSchema<"unknown", undefined>], undefined>;
+/** Schemas - Connector implementation. */
+export declare const connectorImplementationSchema: import('valibot').ObjectSchema<{
+    readonly authMethodId: import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"apiKey", undefined>, import('valibot').LiteralSchema<"disabled", undefined>, import('valibot').LiteralSchema<"oAuth2", undefined>, import('valibot').LiteralSchema<"none", undefined>], undefined>;
+    readonly activeConnectionCount: import('valibot').OptionalSchema<import('valibot').NumberSchema<undefined>, undefined>;
+    readonly canDescribe: import('valibot').OptionalSchema<import('valibot').BooleanSchema<undefined>, undefined>;
+    readonly id: import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+    readonly label: import('valibot').OptionalSchema<import('valibot').ObjectSchema<{
+        readonly 'en-au': import('valibot').StringSchema<undefined>;
+        readonly 'en-gb': import('valibot').StringSchema<undefined>;
+        readonly 'en-us': import('valibot').StringSchema<undefined>;
+        readonly 'es-es': import('valibot').StringSchema<undefined>;
+    }, undefined>, undefined>;
+    readonly maxConnectionCount: import('valibot').OptionalSchema<import('valibot').NumberSchema<undefined>, undefined>;
+    readonly params: import('valibot').OptionalSchema<import('valibot').ArraySchema<import('valibot').RecordSchema<import('valibot').StringSchema<undefined>, import('valibot').StringSchema<undefined>, undefined>, undefined>, undefined>;
+}, undefined>;
+/** Schemas - Connector configuration. */
 export declare const connectorConfigSchema: import('valibot').ObjectSchema<{
     readonly typeId: import('valibot').LiteralSchema<"connector", undefined>;
     readonly category: import('valibot').NullableSchema<import('valibot').ObjectSchema<{
@@ -23,7 +43,7 @@ export declare const connectorConfigSchema: import('valibot').ObjectSchema<{
         readonly maxConnectionCount: import('valibot').OptionalSchema<import('valibot').NumberSchema<undefined>, undefined>;
         readonly params: import('valibot').OptionalSchema<import('valibot').ArraySchema<import('valibot').RecordSchema<import('valibot').StringSchema<undefined>, import('valibot').StringSchema<undefined>, undefined>, undefined>, undefined>;
     }, undefined>, undefined>;
-    readonly operations: import('valibot').ArraySchema<import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"abortOperation", undefined>, import('valibot').LiteralSchema<"authenticateConnection", undefined>, import('valibot').LiteralSchema<"createObject", undefined>, import('valibot').LiteralSchema<"describeConnection", undefined>, import('valibot').LiteralSchema<"dropObject", undefined>, import('valibot').LiteralSchema<"findObject", undefined>, import('valibot').LiteralSchema<"getReader", undefined>, import('valibot').LiteralSchema<"getRecord", undefined>, import('valibot').LiteralSchema<"listNodes", undefined>, import('valibot').LiteralSchema<"previewObject", undefined>, import('valibot').LiteralSchema<"removeRecords", undefined>, import('valibot').LiteralSchema<"retrieveRecords", undefined>, import('valibot').LiteralSchema<"upsertRecords", undefined>], undefined>, undefined>;
+    readonly operations: import('valibot').ArraySchema<import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"abortOperation", undefined>, import('valibot').LiteralSchema<"authenticateConnection", 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<"retrieveRecords", undefined>, import('valibot').LiteralSchema<"upsertRecords", undefined>], undefined>, undefined>;
     readonly usageId: import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"bidirectional", undefined>, import('valibot').LiteralSchema<"destination", undefined>, import('valibot').LiteralSchema<"source", undefined>, import('valibot').LiteralSchema<"unknown", undefined>], undefined>;
     readonly vendorAccountURL: import('valibot').NullableSchema<import('valibot').StringSchema<undefined>, undefined>;
     readonly vendorDocumentationURL: import('valibot').NullableSchema<import('valibot').StringSchema<undefined>, undefined>;

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

@@ -2,18 +2,19 @@ import { parse as csvParse } from 'csv-parse/browser/esm';
 import { parse as dateFnsParse } from 'date-fns';
 import { InferOutput } from 'valibot';
 import { nanoid } from 'nanoid';
-import { connectorConfigSchema } from './connectorConfig.schema';
-import { LocalisedString } from '../../index';
+import { Component } from '..';
 import { buildFetchError, OperationalError } from '../../errors';
-import { Component, ModuleConfig } from '..';
 import { ConnectionConfig, ConnectionDescription, ConnectionNodeConfig } from './connection';
+import { connectorConfigSchema, connectorImplementationSchema, connectorModuleCategoryIdSchema, connectorOperationSchema, connectorUsageIdSchema } from './connectorConfig.schema';
 import { DataViewContentAuditConfig, ValueDelimiterId } from '../dataView';
 import { extractExtensionFromPath, extractNameFromPath, lookupMimeTypeForExtension } from '../../utilities';
-type ConnectorModuleCategoryId = 'application' | 'curatedDataset' | 'database' | 'fileStore';
-export type ConnectorOperation = 'abortOperation' | 'authenticateConnection' | 'createObject' | 'describeConnection' | 'dropObject' | 'findObject' | 'getRecord' | 'listNodes' | 'previewObject' | 'removeRecords' | 'retrieveRecords' | 'upsertRecords';
-export type ConnectorUsageId = 'bidirectional' | 'destination' | 'source' | 'unknown';
+export type ConnectorModuleCategoryId = InferOutput<typeof connectorModuleCategoryIdSchema>;
+export type ConnectorOperation = InferOutput<typeof connectorOperationSchema>;
+export type ConnectorUsageId = InferOutput<typeof connectorUsageIdSchema>;
+/** Constants  */
 export declare const CONNECTOR_DESTINATION_OPERATIONS: string[];
 export declare const CONNECTOR_SOURCE_OPERATIONS: string[];
+/** Interfaces/Types - Connector. */
 export interface Connector extends Component {
     abortController?: AbortController;
     readonly config: ConnectorConfig;
@@ -25,7 +26,7 @@ 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>;
-    getReader?(connector: Connector, getSettings: GetReaderSettings): Promise<GetReaderResult>;
+    getReadableStream?(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>;
@@ -34,30 +35,11 @@ export interface Connector extends Component {
     upsertRecords?(connector: Connector, settings: UpsertSettings): Promise<void>;
 }
 export type ConnectorConfig = InferOutput<typeof connectorConfigSchema>;
-export interface ConnectorConfig1 extends ModuleConfig {
-    category: ConnectorCategory | null;
-    categoryId: ConnectorModuleCategoryId;
-    implementations: Record<string, ConnectorImplementation>;
-    operations: ConnectorOperation[];
-    typeId: 'connector';
-    usageId: ConnectorUsageId;
-    vendorAccountURL: string | null;
-    vendorDocumentationURL: string | null;
-    vendorHomeURL: string | null;
-}
 export type ConnectorLocalisedConfig = Omit<ConnectorConfig, 'label' | 'description'> & {
     label: string;
     description: string;
 };
-export interface ConnectorImplementation {
-    activeConnectionCount?: number;
-    canDescribe?: boolean;
-    id?: string;
-    authMethodId: 'apiKey' | 'disabled' | 'oAuth2' | 'none';
-    label?: LocalisedString;
-    maxConnectionCount?: number;
-    params?: Record<string, string>[];
-}
+export type ConnectorImplementation = InferOutput<typeof connectorImplementationSchema>;
 export interface ConnectorTools {
     csvParse: typeof csvParse;
     dataPos: {
@@ -172,9 +154,5 @@ export interface ConnectorCallbackData {
     typeId: string;
     properties: Record<string, unknown>;
 }
-interface ConnectorCategory {
-    id: string;
-    label: string;
-}
 /** Exposures */
 export { connectorConfigSchema } from './connectorConfig.schema';

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

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

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

@@ -1,6 +1,5 @@
 /**
- * Presenter schema.
- * Drafted by Copilot.
+ * Presenter schema (drafted by Copilot).
  */
 export declare const presenterConfigSchema: import('valibot').ObjectSchema<{
     readonly typeId: import('valibot').LiteralSchema<"presenter", undefined>;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@datapos/datapos-shared",
-    "version": "0.3.330",
+    "version": "0.3.331",
     "description": "A library containing common constants, types and utilities used across all Data Positioning projects.",
     "license": "MIT",
     "author": "Jonathan Terrell <terrell.jm@gmail.com>",
@@ -33,8 +33,8 @@
         "nanoid": "^5.1.6"
     },
     "devDependencies": {
-        "@datapos/datapos-development": "^0.3.395",
-        "@datapos/eslint-config-datapos": "^1.0.27",
+        "@datapos/datapos-development": "^0.3.424",
+        "@datapos/eslint-config-datapos": "^1.0.28",
         "@types/node": "^25.0.3",
         "@typescript-eslint/eslint-plugin": "^8.50.0",
         "@typescript-eslint/parser": "^8.50.0",