@datapos/datapos-shared 0.3.412 → 0.3.413

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

@@ -25,18 +25,18 @@ interface ConnectorInterface extends Component {
     readonly toolConfigs: ToolConfig[];
     abortOperation?(connector: ConnectorInterface): void;
     authenticateConnection?(accountId: string, windowCenterX: number, windowCenterY: number): Window;
-    createObject?(connector: ConnectorInterface, options: CreateOptions): Promise<void>;
-    describeConnection?(connector: ConnectorInterface, options: DescribeOptions): Promise<DescribeResult>;
-    dropObject?(connector: ConnectorInterface, options: DropOptions): Promise<void>;
+    createObject?(connector: ConnectorInterface, options: CreateObjectOptions): Promise<void>;
+    describeConnection?(connector: ConnectorInterface, options: DescribeConnectionOptions): Promise<DescribeConnectionResult>;
+    dropObject?(connector: ConnectorInterface, options: DropObjectOptions): Promise<void>;
     findObject?(connector: ConnectorInterface, options: FindObjectFolderPathOptions): Promise<string | null>;
     getReadableStream?(connector: ConnectorInterface, options: GetReadableStreamOptions): Promise<ReadableStream<Uint8Array>>;
     getRecord?(connector: ConnectorInterface, options: GetRecordOptions): Promise<GetRecordResult>;
     listNodes?(connector: ConnectorInterface, options: ListNodesOptions): Promise<ListNodesResult>;
     previewObject?(connector: ConnectorInterface, options: PreviewObjectOptions): Promise<PreviewObjectResult>;
-    removeRecords?(connector: ConnectorInterface, options: RemoveOptions): Promise<void>;
-    retrieveChunks?(connector: ConnectorInterface, options: RetrieveChunksOptions, chunk: (records: (string[] | Record<string, unknown>)[]) => void, complete: (result: RetrieveChunksSummary) => void): Promise<void>;
-    retrieveRecords?(connector: ConnectorInterface, options: RetrieveRecordsOptions, chunk: (records: (string[] | Record<string, unknown>)[]) => void, complete: (result: RetrieveChunksSummary) => void): Promise<void>;
-    upsertRecords?(connector: ConnectorInterface, options: UpsertOptions): Promise<void>;
+    removeRecords?(connector: ConnectorInterface, options: RemoveRecordsOptions): Promise<void>;
+    retrieveChunks?(connector: ConnectorInterface, options: RetrieveChunksOptions, chunk: (records: (string[] | Record<string, unknown>)[]) => void, complete: () => void): Promise<void>;
+    retrieveRecords?(connector: ConnectorInterface, options: RetrieveRecordsOptions, chunk: (records: (string[] | Record<string, unknown>)[]) => void, complete: (result: RetrieveRecordsSummary) => void): Promise<void>;
+    upsertRecords?(connector: ConnectorInterface, options: UpsertRecordsOptions): Promise<void>;
 }
 /** Connector operation options. */
 interface ConnectorOperationOptions {
@@ -44,6 +44,20 @@ interface ConnectorOperationOptions {
     appCheckToken?: string;
     sessionAccessToken?: string;
 }
+/** Create object options. */
+interface CreateObjectOptions extends ConnectorOperationOptions {
+    path: string;
+    structure: string;
+}
+/** Describe connection options and result. */
+type DescribeConnectionOptions = ConnectorOperationOptions;
+interface DescribeConnectionResult {
+    description: ConnectionDescription;
+}
+/** Drop object options. */
+interface DropObjectOptions extends ConnectorOperationOptions {
+    path: string;
+}
 /** Find object folder path options. */
 interface FindObjectFolderPathOptions extends ConnectorOperationOptions {
     containerName: string | undefined;
@@ -54,6 +68,14 @@ interface GetReadableStreamOptions extends ConnectorOperationOptions {
     id: string;
     path: string;
 }
+/** Get record options and result. */
+interface GetRecordOptions extends ConnectorOperationOptions {
+    id: string;
+    path: string;
+}
+interface GetRecordResult {
+    record?: string[] | Record<string, unknown>;
+}
 /** List nodes options and result. */
 interface ListNodesOptions extends ConnectorOperationOptions {
     folderPath: string;
@@ -77,59 +99,35 @@ interface PreviewObjectResult {
     data: Record<string, unknown>[] | Uint8Array;
     typeId: 'jsonArray' | 'uint8Array';
 }
-/** Retrieve records options and summary. */
-interface RetrieveRecordsOptions extends ConnectorOperationOptions {
+/** Remove records options. */
+interface RemoveRecordsOptions extends ConnectorOperationOptions {
+    keys: string[];
+    path: string;
+}
+/** Retrieve chunks options. */
+interface RetrieveChunksOptions extends ConnectorOperationOptions {
     chunkSize?: number;
     encodingId: string;
     path: string;
     valueDelimiterId: ValueDelimiterId;
 }
-interface RetrieveRecordsSummary {
-    byteCount: number;
-    commentLineCount: number;
-    emptyLineCount: number;
-    invalidFieldLengthCount: number;
-    lineCount: number;
-    recordCount: number;
-}
-interface CreateOptions extends ConnectorOperationOptions {
-    accountId?: string;
-    path: string;
-    structure: string;
-}
-type DescribeOptions = ConnectorOperationOptions;
-interface DescribeResult {
-    description: ConnectionDescription;
-}
-interface DropOptions extends ConnectorOperationOptions {
-    path: string;
-}
-interface GetRecordOptions extends ConnectorOperationOptions {
-    id: string;
-    path: string;
-}
-interface GetRecordResult {
-    record?: string[] | Record<string, unknown>;
-}
-interface RemoveOptions extends ConnectorOperationOptions {
-    keys: string[];
-    path: string;
-}
-interface RetrieveChunksOptions extends ConnectorOperationOptions {
+/** Retrieve records options and summary. */
+interface RetrieveRecordsOptions extends ConnectorOperationOptions {
     chunkSize?: number;
     encodingId: string;
     path: string;
     valueDelimiterId: ValueDelimiterId;
 }
-interface RetrieveChunksSummary {
+interface RetrieveRecordsSummary {
     byteCount: number;
     commentLineCount: number;
     emptyLineCount: number;
-    invalidFieldLengthCount: number;
     lineCount: number;
+    nonUniformRecordCount: number;
     recordCount: number;
 }
-interface UpsertOptions extends ConnectorOperationOptions {
+/** Upsert records options. */
+interface UpsertRecordsOptions extends ConnectorOperationOptions {
     records: Record<string, unknown>[];
     path: string;
 }
@@ -137,7 +135,7 @@ interface UpsertOptions extends ConnectorOperationOptions {
 type ConnectorCategory = InferOutput<typeof connectorCategorySchema>;
 declare const getConnectorCategory: (id: string, localeId?: import('../../index').LocaleCode) => ConnectorCategory;
 /** Exports. */
+export { connectorConfigSchema } from './connectorConfig.schema';
 export { getConnectorCategory };
 export type { ConnectionColumnConfig, ConnectionConfig, ConnectionNodeConfig, Encoding, UsageTypeId } from './connection';
-export type { ConnectorConfig, ConnectorInterface, ConnectorLocalisedConfig, ConnectorOperationName, ConnectorOperationOptions, ConnectorUsageId, CreateOptions, DropOptions, FindObjectFolderPathOptions, GetReadableStreamOptions, GetRecordResult, GetRecordOptions, ListNodesResult, ListNodesOptions, PreviewObjectResult, PreviewObjectOptions, RemoveOptions, RetrieveChunksOptions, RetrieveChunksSummary, RetrieveRecordsOptions, RetrieveRecordsSummary, UpsertOptions };
-export { connectorConfigSchema } from './connectorConfig.schema';
+export type { ConnectorConfig, ConnectorInterface, ConnectorLocalisedConfig, ConnectorOperationName, ConnectorOperationOptions, ConnectorUsageId, CreateObjectOptions, DropObjectOptions, FindObjectFolderPathOptions, GetReadableStreamOptions, GetRecordResult, GetRecordOptions, ListNodesResult, ListNodesOptions, PreviewObjectResult, PreviewObjectOptions, RemoveRecordsOptions, RetrieveChunksOptions, RetrieveRecordsOptions, RetrieveRecordsSummary, UpsertRecordsOptions };

package/package.json

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