@datapos/datapos-shared 0.3.359 → 0.3.363

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

@@ -1,13 +1,14 @@
 /**
- * Connector schema (drafted by Copilot).
+ * Connector configuration schema.
+ *
+ * Defines the configuration metadata for a connector. Used for validation
+ * of connector manifests and capability discovery at runtime.
+ */
+/** Authentication method identifiers supported by a connector implementation. */
+export declare const connectorAuthMethodIdSchema: 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>;
+/** A connector implementation variant. A single connector may expose multiple
+ * implementations differing by auth method, limits, or vendor-specific behavior.
  */
-/** Schema Literal Unions - Connector category identifier. */
-export declare const connectorCategoryIdSchema: 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>;
-/** Schema Literal Unions - Connector operation name. */
-export declare const connectorOperationNameSchema: 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<"retrieveChunks", undefined>, import('valibot').LiteralSchema<"retrieveRecords", undefined>, import('valibot').LiteralSchema<"upsertRecords", undefined>], undefined>;
-/** Schema Literal Unions - Connector usage identifier. */
-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>;
-/** Schema Objects - 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>;
@@ -22,7 +23,13 @@ export declare const connectorImplementationSchema: import('valibot').ObjectSche
     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>;
-/** Schema Objects - Connector configuration. */
+/** Category identifiers used for grouping and filtering connectors. */
+export declare const connectorCategoryIdSchema: 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>;
+/** Operation names a connector may support. */
+export declare const connectorOperationNameSchema: 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<"retrieveChunks", undefined>, import('valibot').LiteralSchema<"retrieveRecords", undefined>, import('valibot').LiteralSchema<"upsertRecords", undefined>], undefined>;
+/** Connector data pipeline usage identifiers. */
+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>;
+/** Top-level connector configuration object. */
 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

@@ -1,33 +1,26 @@
-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 { Component } from '..';
-import { buildFetchError, OperationalError } from '../../errors';
+import { connectorConfigSchema } from './connectorConfig.schema';
 import { ConnectionConfig, ConnectionDescription, ConnectionNodeConfig } from './connection';
-import { connectorCategoryIdSchema, connectorConfigSchema, connectorImplementationSchema, connectorOperationNameSchema, connectorUsageIdSchema } from './connectorConfig.schema';
 import { DataViewContentAuditConfig, ValueDelimiterId } from '../dataView';
-import { extractExtensionFromPath, extractNameFromPath, lookupMimeTypeForExtension } from '../../utilities';
-/** Interfaces/Types - Connector category identifier. */
-export type ConnectorCategoryId = InferOutput<typeof connectorCategoryIdSchema>;
-/** Interfaces/Types - Connector operation name. */
-export type ConnectorOperationName = InferOutput<typeof connectorOperationNameSchema>;
-/** Interfaces/Types - Connector usage identifier. */
-export type ConnectorUsageId = InferOutput<typeof connectorUsageIdSchema>;
-/** Interfaces/Types - Connector implementation. */
-export type ConnectorImplementation = InferOutput<typeof connectorImplementationSchema>;
-/** Interfaces/Types - Connector configuration. */
-export type ConnectorConfig = InferOutput<typeof connectorConfigSchema>;
-export type ConnectorLocalisedConfig = Omit<ConnectorConfig, 'label' | 'description'> & {
+import { ToolConfig } from '../../index';
+/** Authentication method identifiers supported by a connector implementation. */
+/** Connector implementation. */
+/** Category identifiers used for grouping and filtering connectors. */
+/** Operation names a connector may support. */
+/** Connector data pipeline usage identifiers. */
+/** Connector configuration. */
+type ConnectorConfig = InferOutput<typeof connectorConfigSchema>;
+type ConnectorLocalisedConfig = Omit<ConnectorConfig, 'label' | 'description'> & {
     label: string;
     description: string;
 };
-/** Interfaces/Types - Connector. */
-export interface Connector extends Component {
+/** Connector runtime interface. */
+interface Connector extends Component {
     abortController?: AbortController;
     readonly config: ConnectorConfig;
     readonly connectionConfig: ConnectionConfig;
-    readonly tools: ConnectorTools;
+    readonly toolConfigs: ToolConfig[];
     abortOperation?(connector: Connector): void;
     authenticateConnection?(accountId: string, windowCenterX: number, windowCenterY: number): Window;
     createObject?(connector: Connector, settings: CreateSettings): Promise<void>;
@@ -43,23 +36,6 @@ export interface Connector extends Component {
     retrieveRecords?(connector: Connector, settings: RetrieveRecordsSettings, chunk: (records: (string[] | Record<string, unknown>)[]) => void, complete: (result: RetrieveRecordsSummary) => void): Promise<void>;
     upsertRecords?(connector: Connector, settings: UpsertSettings): Promise<void>;
 }
-export interface ConnectorTools {
-    csvParse: typeof csvParse;
-    dataPos: {
-        buildFetchError: typeof buildFetchError;
-        extractExtensionFromPath: typeof extractExtensionFromPath;
-        extractNameFromPath: typeof extractNameFromPath;
-        lookupMimeTypeForExtension: typeof lookupMimeTypeForExtension;
-        OperationalError: typeof OperationalError;
-    };
-    dateFns: {
-        parse: typeof dateFnsParse;
-    };
-    nanoid: typeof nanoid;
-}
-/** Constants  */
-export declare const CONNECTOR_DESTINATION_OPERATIONS: string[];
-export declare const CONNECTOR_SOURCE_OPERATIONS: string[];
 export interface InitialiseSettings {
     connectorStorageURLPrefix: string;
 }
@@ -174,5 +150,7 @@ export interface ConnectorCallbackData {
     typeId: string;
     properties: Record<string, unknown>;
 }
-/** Exposures */
+/** Exports. */
+export type { ConnectionConfig, ConnectionNodeConfig } from './connection';
+export type { Connector, ConnectorConfig, ConnectorLocalisedConfig };
 export { connectorConfigSchema } from './connectorConfig.schema';

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

@@ -77,7 +77,7 @@ declare function normalizeToError(value: unknown): Error;
  * - Messages are normalized to end with punctuation.
  */
 declare function serialiseError(error?: unknown): SerialisedError[];
-/** Exports */
+/** 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

@@ -8,10 +8,8 @@ export type LocalisedString = Record<LocaleCode, string>;
 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 { AuditContentResult, AuditContentSettings, Connector, ConnectorCallbackData, ConnectorConfig, ConnectorImplementation, ConnectorLocalisedConfig, ConnectorOperationName, ConnectorOperationSettings, ConnectorTools, ConnectorUsageId, CreateSettings, DropSettings, FindResult, FindSettings, GetReadableStreamResult, GetReadableStreamSettings, GetRecordResult, GetRecordSettings, InitialiseSettings, ListResult, ListSettings, PreviewResult, PreviewSettings, RemoveSettings, RetrieveChunksSettings, RetrieveChunksSummary, RetrieveRecordsResult, RetrieveRecordsSettings, RetrieveRecordsSummary, UpsertSettings } from './component/connector';
+export type { AuditContentResult, AuditContentSettings, Connector, ConnectorCallbackData, ConnectorConfig, ConnectorLocalisedConfig, ConnectorOperationSettings, CreateSettings, DropSettings, FindResult, FindSettings, GetReadableStreamResult, GetReadableStreamSettings, GetRecordResult, GetRecordSettings, InitialiseSettings, ListResult, ListSettings, PreviewResult, PreviewSettings, RemoveSettings, RetrieveChunksSettings, RetrieveChunksSummary, RetrieveRecordsResult, RetrieveRecordsSettings, RetrieveRecordsSummary, UpsertSettings } from './component/connector';
 /** Interfaces/Types - Connection */
 export type { ConnectionAuthorizationConfig, ConnectionColumnConfig, ConnectionConfig, ConnectionNodeConfig, DPAFileSystemFileHandle, Encoding, StorageTypeId, UsageTypeId } from './component/connector/connection';
 /** Schemas - Connector  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@datapos/datapos-shared",
-    "version": "0.3.359",
+    "version": "0.3.363",
     "description": "A library containing common constants, types and utilities used across all Data Positioning projects.",
     "license": "MIT",
     "author": "Jonathan Terrell <terrell.jm@gmail.com>",