@datapos/datapos-shared 0.3.333 → 0.3.334

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

@@ -1,5 +1,5 @@
 import { ComponentConfig } from '..';
-import { ConnectorConfig } from '.';
+import { ConnectorConfig } from './types';
 export interface ConnectionAuthorizationConfig {
     accessToken: string;
     accountId: string;

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

@@ -1,177 +1,11 @@
-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 { 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'> & {
-    label: string;
-    description: string;
-};
-/** Interfaces/Types - Connector. */
-export interface Connector extends Component {
-    abortController?: AbortController;
-    readonly config: ConnectorConfig;
-    readonly connectionConfig: ConnectionConfig;
-    readonly tools: ConnectorTools;
-    abortOperation?(connector: Connector): void;
-    authenticateConnection?(accountId: string, windowCenterX: number, windowCenterY: number): Window;
-    createObject?(connector: Connector, settings: CreateSettings): Promise<void>;
-    describeConnection?(connector: Connector, settings: DescribeSettings): Promise<DescribeResult>;
-    dropObject?(connector: Connector, settings: DropSettings): Promise<void>;
-    findObject?(connector: Connector, findSettings: FindSettings): Promise<FindResult>;
-    getReadableStream?(connector: Connector, getSettings: GetReadableStreamSettings): Promise<GetReadableStreamResult>;
-    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>;
-    retrieveChunks?(connector: Connector, settings: RetrieveChunksSettings, chunk: (records: (string[] | Record<string, unknown>)[]) => void, complete: (result: RetrieveChunksSummary) => void): Promise<void>;
-    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;
-}
+/**
+ * Connector composables, constants, errors, types/interfaces and utilities.
+ */
+export type * from './types';
 /** Constants  */
 export declare const CONNECTOR_DESTINATION_OPERATIONS: string[];
 export declare const CONNECTOR_SOURCE_OPERATIONS: string[];
 export interface InitialiseSettings {
-    connectorStorageURLPrefix: string;
-}
-export interface ConnectorOperationSettings {
-    accountId?: string;
-    appCheckToken?: string;
-    sessionAccessToken?: string;
-}
-export interface AuditContentSettings extends ConnectorOperationSettings {
-    chunkSize?: number;
-    encodingId: string;
-    path: string;
-    valueDelimiterId: ValueDelimiterId;
-}
-export interface AuditContentResult {
-    contentAuditConfig: DataViewContentAuditConfig;
-}
-export interface CreateSettings extends ConnectorOperationSettings {
-    accountId?: string;
-    path: string;
-    structure: string;
-}
-type DescribeSettings = ConnectorOperationSettings;
-interface DescribeResult {
-    description: ConnectionDescription;
-}
-export interface DropSettings extends ConnectorOperationSettings {
-    path: string;
-}
-export interface FindSettings extends ConnectorOperationSettings {
-    containerName?: string;
-    objectName: string;
-}
-export interface FindResult {
-    folderPath?: string;
-}
-export interface GetReadableStreamSettings extends ConnectorOperationSettings {
-    id: string;
-    path: string;
-}
-export interface GetReadableStreamResult {
-    readable?: ReadableStream<unknown>;
-}
-export interface GetRecordSettings extends ConnectorOperationSettings {
-    id: string;
-    path: string;
-}
-export interface GetRecordResult {
-    record?: string[] | Record<string, unknown>;
-}
-export interface ListSettings extends ConnectorOperationSettings {
-    folderPath: string;
-    limit?: number;
-    offset?: number;
-    totalCount?: number;
-}
-export interface ListResult {
-    cursor: string | number | undefined;
-    connectionNodeConfigs: ConnectionNodeConfig[];
-    isMore: boolean;
-    totalCount: number;
-}
-export interface PreviewSettings extends ConnectorOperationSettings {
-    chunkSize?: number;
-    extension?: string;
-    path: string;
-}
-export interface PreviewResult {
-    data: Record<string, unknown>[] | Uint8Array;
-    typeId: 'jsonArray' | 'uint8Array';
-}
-export interface RemoveSettings extends ConnectorOperationSettings {
-    keys: string[];
-    path: string;
-}
-export interface RetrieveChunksSettings extends ConnectorOperationSettings {
-    chunkSize?: number;
-    encodingId: string;
-    path: string;
-    valueDelimiterId: ValueDelimiterId;
-}
-export interface RetrieveRecordsSettings extends ConnectorOperationSettings {
-    chunkSize?: number;
-    encodingId: string;
-    path: string;
-    valueDelimiterId: ValueDelimiterId;
-}
-export interface RetrieveRecordsResult {
-    records: (string[] | Record<string, unknown>)[];
-}
-export interface RetrieveChunksSummary {
-    byteCount: number;
-    commentLineCount: number;
-    emptyLineCount: number;
-    invalidFieldLengthCount: number;
-    lineCount: number;
-    recordCount: number;
-}
-export interface RetrieveRecordsSummary {
-    byteCount: number;
-    commentLineCount: number;
-    emptyLineCount: number;
-    invalidFieldLengthCount: number;
-    lineCount: number;
-    recordCount: number;
-}
-export interface UpsertSettings extends ConnectorOperationSettings {
-    records: Record<string, unknown>[];
-    path: string;
-}
-export interface ConnectorCallbackData {
-    typeId: string;
     properties: Record<string, unknown>;
 }
 /** Exposures */

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

@@ -0,0 +1,174 @@
+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 { ConnectionConfig, ConnectionDescription, ConnectionNodeConfig } from './connection';
+import { connectorCategoryIdSchema, connectorConfigSchema, connectorImplementationSchema, connectorOperationNameSchema, connectorUsageIdSchema } from './connectorConfig.schema';
+import { DataViewContentAuditConfig, ValueDelimiterId } from '../dataView';
+import { buildFetchError, OperationalError } from '../../errors';
+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'> & {
+    label: string;
+    description: string;
+};
+/** Interfaces/Types - Connector. */
+export interface Connector extends Component {
+    abortController?: AbortController;
+    readonly config: ConnectorConfig;
+    readonly connectionConfig: ConnectionConfig;
+    readonly tools: ConnectorTools;
+    abortOperation?(connector: Connector): void;
+    authenticateConnection?(accountId: string, windowCenterX: number, windowCenterY: number): Window;
+    createObject?(connector: Connector, settings: CreateSettings): Promise<void>;
+    describeConnection?(connector: Connector, settings: DescribeSettings): Promise<DescribeResult>;
+    dropObject?(connector: Connector, settings: DropSettings): Promise<void>;
+    findObject?(connector: Connector, findSettings: FindSettings): Promise<FindResult>;
+    getReadableStream?(connector: Connector, getSettings: GetReadableStreamSettings): Promise<GetReadableStreamResult>;
+    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>;
+    retrieveChunks?(connector: Connector, settings: RetrieveChunksSettings, chunk: (records: (string[] | Record<string, unknown>)[]) => void, complete: (result: RetrieveChunksSummary) => void): Promise<void>;
+    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;
+}
+export interface InitialiseSettings {
+    connectorStorageURLPrefix: string;
+}
+export interface ConnectorOperationSettings {
+    accountId?: string;
+    appCheckToken?: string;
+    sessionAccessToken?: string;
+}
+export interface AuditContentSettings extends ConnectorOperationSettings {
+    chunkSize?: number;
+    encodingId: string;
+    path: string;
+    valueDelimiterId: ValueDelimiterId;
+}
+export interface AuditContentResult {
+    contentAuditConfig: DataViewContentAuditConfig;
+}
+export interface CreateSettings extends ConnectorOperationSettings {
+    accountId?: string;
+    path: string;
+    structure: string;
+}
+export type DescribeSettings = ConnectorOperationSettings;
+export interface DescribeResult {
+    description: ConnectionDescription;
+}
+export interface DropSettings extends ConnectorOperationSettings {
+    path: string;
+}
+export interface FindSettings extends ConnectorOperationSettings {
+    containerName?: string;
+    objectName: string;
+}
+export interface FindResult {
+    folderPath?: string;
+}
+export interface GetReadableStreamSettings extends ConnectorOperationSettings {
+    id: string;
+    path: string;
+}
+export interface GetReadableStreamResult {
+    readable?: ReadableStream<unknown>;
+}
+export interface GetRecordSettings extends ConnectorOperationSettings {
+    id: string;
+    path: string;
+}
+export interface GetRecordResult {
+    record?: string[] | Record<string, unknown>;
+}
+export interface ListSettings extends ConnectorOperationSettings {
+    folderPath: string;
+    limit?: number;
+    offset?: number;
+    totalCount?: number;
+}
+export interface ListResult {
+    cursor: string | number | undefined;
+    connectionNodeConfigs: ConnectionNodeConfig[];
+    isMore: boolean;
+    totalCount: number;
+}
+export interface PreviewSettings extends ConnectorOperationSettings {
+    chunkSize?: number;
+    extension?: string;
+    path: string;
+}
+export interface PreviewResult {
+    data: Record<string, unknown>[] | Uint8Array;
+    typeId: 'jsonArray' | 'uint8Array';
+}
+export interface RemoveSettings extends ConnectorOperationSettings {
+    keys: string[];
+    path: string;
+}
+export interface RetrieveChunksSettings extends ConnectorOperationSettings {
+    chunkSize?: number;
+    encodingId: string;
+    path: string;
+    valueDelimiterId: ValueDelimiterId;
+}
+export interface RetrieveRecordsSettings extends ConnectorOperationSettings {
+    chunkSize?: number;
+    encodingId: string;
+    path: string;
+    valueDelimiterId: ValueDelimiterId;
+}
+export interface RetrieveRecordsResult {
+    records: (string[] | Record<string, unknown>)[];
+}
+export interface RetrieveChunksSummary {
+    byteCount: number;
+    commentLineCount: number;
+    emptyLineCount: number;
+    invalidFieldLengthCount: number;
+    lineCount: number;
+    recordCount: number;
+}
+export interface RetrieveRecordsSummary {
+    byteCount: number;
+    commentLineCount: number;
+    emptyLineCount: number;
+    invalidFieldLengthCount: number;
+    lineCount: number;
+    recordCount: number;
+}
+export type RetrieveResult = RetrieveRecordsResult;
+export interface UpsertSettings extends ConnectorOperationSettings {
+    records: Record<string, unknown>[];
+    path: string;
+}
+export interface ConnectorCallbackData {
+    typeId: string;
+    properties: Record<string, unknown>;
+}

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

@@ -1,5 +1,5 @@
 import { ConnectionConfig } from '../component/connector/connection';
-import { AuditContentResult, ConnectorCallbackData, ConnectorOperationSettings, InitialiseSettings, ListResult, RetrieveResult } from '../component/connector';
+import { AuditContentResult, ConnectorCallbackData, ConnectorOperationSettings, InitialiseSettings, ListResult, RetrieveResult } from '../component/connector/types';
 import { Component, ModuleConfig } from '../component';
 import { ContextCallbackData, ContextConfig, ContextOperationSettings } from '../component/context';
 import { DataViewPreviewConfig, EncodingConfig } from '../component/dataView';

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

@@ -10,11 +10,11 @@ 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, 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/types';
 /** Interfaces/Types - Connection */
 export type { ConnectionAuthorizationConfig, ConnectionColumnConfig, ConnectionConfig, ConnectionNodeConfig, DPAFileSystemFileHandle, Encoding, StorageTypeId, UsageTypeId } from './component/connector/connection';
 /** Schemas - Connector  */
-export { connectorConfigSchema } from './component/connector';
+export { connectorConfigSchema } from './component/connector/connectorConfig.schema';
 /** Interfaces/Types - Context. */
 export { contextConfigSchema } from './component/context';
 export type { Context, ContextConfig, ContextLocalisedConfig, ContextListSettings, ContextListResult, ContextOperation, ContextCallbackData } from './component/context';

package/package.json

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