@datapos/datapos-shared 0.3.477 → 0.3.479

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

@@ -28,7 +28,7 @@ interface ConnectionAuthorisationConfig {
  */
 interface ConnectionNodeConfig {
     childCount?: number;
-    columnsConfigs?: ConnectionColumnConfig[];
+    columnsConfigs?: ObjectColumnConfig[];
     extension: string | undefined;
     folderPath: string;
     handle?: DPAFileSystemFileHandle;
@@ -40,7 +40,7 @@ interface ConnectionNodeConfig {
     mimeType?: string;
     name: string;
     size?: number;
-    typeId: ConnectionNodeTypeId;
+    typeId: NodeTypeId;
 }
 interface DPAFileSystemFileHandle {
     readonly kind: 'file';
@@ -49,7 +49,7 @@ interface DPAFileSystemFileHandle {
 /**
  * Connection node type identifier.
  */
-type ConnectionNodeTypeId = 'folder' | 'object';
+type NodeTypeId = 'folder' | 'object';
 /**
  * Connection description configuration.
  */
@@ -57,13 +57,13 @@ interface ConnectionDescriptionConfig {
     objects: {
         id: string;
         label: Record<string, string>;
-        columns: ConnectionColumnConfig[];
+        columns: ObjectColumnConfig[];
     }[];
 }
 /**
- * Connection column configuration.
+ * Object column configuration.
  */
-interface ConnectionColumnConfig {
+interface ObjectColumnConfig {
     invalidValueCount?: number;
     invalidValues?: string[];
     isIgnored?: boolean;
@@ -77,11 +77,11 @@ interface ConnectionColumnConfig {
     minSize?: number;
     minValue?: string;
     patterns?: Record<string, string>;
-    storageTypeId?: StorageDataTypeId;
-    DataTypeId?: DataTypeId;
+    storageTypeId?: StorageTypeId;
+    dataTypeId?: DataTypeId;
     validValueCount?: number;
     validValues?: Record<string, string>;
     voidValueCount?: number;
 }
-type StorageDataTypeId = 'binary' | 'boolean' | 'byte' | 'date' | 'dateTime' | 'dateTimeOffset' | 'decimal' | 'double' | 'int8' | 'int16' | 'int32' | 'int64' | 'object' | 'single' | 'string' | 'time' | 'unknown';
-export type { ConnectionColumnConfig, ConnectionConfig, ConnectionDescriptionConfig, ConnectionNodeConfig };
+type StorageTypeId = 'binary' | 'boolean' | 'byte' | 'date' | 'dateTime' | 'dateTimeOffset' | 'decimal' | 'double' | 'int8' | 'int16' | 'int32' | 'int64' | 'object' | 'single' | 'string' | 'time' | 'unknown';
+export type { ConnectionConfig, ConnectionDescriptionConfig, ConnectionNodeConfig, ObjectColumnConfig };

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

@@ -4,7 +4,7 @@ import { EngineUtilities } from '../../engine';
 import { ToolConfig } from '../tool';
 import { ConnectionDescriptionConfig, ConnectionNodeConfig } from './connection';
 import { connectorCategoryConfigSchema, connectorConfigSchema, connectorOperationNameSchema, connectorUsageIdSchema } from './connectorConfig.schema';
-import { DataViewPreviewConfig, ParsingRecord, ValueDelimiterId } from '../dataView';
+import { ParsingRecord, PreviewConfig, ValueDelimiterId } from '../dataView';
 /**
  * Connector interface and constructor.
  */
@@ -51,7 +51,7 @@ interface ConnectorInterface extends Component {
     /**
      * Preview an object for a specified connection.
      */
-    previewObject?(options: PreviewObjectOptions): Promise<DataViewPreviewConfig>;
+    previewObject?(options: PreviewObjectOptions): Promise<PreviewConfig>;
     /**
      * Remove one or more records from an object for a specified connection.
      */
@@ -236,5 +236,5 @@ type ConnectorCategoryLocalisedConfig = Omit<ConnectorCategoryConfig, 'label'> &
 declare const constructConnectorCategoryConfig: (id: string, localeId?: import('../../locale').LocaleCode) => ConnectorCategoryLocalisedConfig;
 export { connectorConfigSchema } from './connectorConfig.schema';
 export { constructConnectorCategoryConfig };
-export type { ConnectionColumnConfig, ConnectionConfig, ConnectionNodeConfig } from './connection';
+export type { ConnectionConfig, ConnectionNodeConfig, ObjectColumnConfig } from './connection';
 export type { ConnectorConfig, ConnectorConstructor, ConnectorInterface, ConnectorLocalisedConfig, ConnectorOperationName, ConnectorOperationOptions, ConnectorUsageId, CreateObjectOptions, DropObjectOptions, FindObjectFolderPathOptions, GetReadableStreamOptions, GetRecordResult, GetRecordOptions, ListNodesResult, ListNodesOptions, PreviewObjectOptions, RemoveRecordsOptions, RetrieveChunksOptions, RetrieveRecordsOptions, RetrieveRecordsSummary, UpsertRecordsOptions };

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

@@ -1,6 +1,6 @@
 import { FileTypeResult } from 'file-type';
 import { Component, ComponentConfig } from '..';
-import { ConnectionColumnConfig, ConnectionNodeConfig } from '../connector/connection';
+import { ConnectionNodeConfig, ObjectColumnConfig } from '../connector/connection';
 /**
  * Data view interface.
  */
@@ -9,11 +9,11 @@ type DataViewInterface = Component;
  * Data view configuration.
  */
 interface DataViewConfig extends ComponentConfig {
-    connectionId?: string;
-    connectionNodeConfig?: ConnectionNodeConfig;
-    previewConfig?: DataViewPreviewConfig;
-    contentAuditConfig?: DataViewContentAuditConfig;
-    relationshipsAuditConfig?: DataViewRelationshipsAuditConfig;
+    connectionId: string | undefined;
+    connectionNodeConfig: ConnectionNodeConfig | undefined;
+    previewConfig: PreviewConfig | undefined;
+    contentAuditConfig: ContentAuditConfig | undefined;
+    relationshipsAuditConfig: RelationshipsAuditConfig | undefined;
 }
 /**
  * Data view localised configuration.
@@ -25,29 +25,37 @@ type DataViewLocalisedConfig = Omit<DataViewConfig, 'label' | 'description'> & {
 /**
  * Data view preview configuration.
  */
-interface DataViewPreviewConfig {
+interface PreviewConfig {
     asAt: number;
-    columnConfigs: ConnectionColumnConfig[];
+    commentMarkCharSeq: string | undefined;
+    columnConfigs: ObjectColumnConfig[];
     dataFormatId: DataFormatId | undefined;
     duration: number;
     encodingConfidenceLevel: number | undefined;
     encodingId: string | undefined;
-    errorMessage?: string;
+    errorMessage: string | undefined;
     fileType: FileTypeResult | undefined;
-    hasHeaders: boolean | undefined;
-    recordDelimiterId?: RecordDelimiterId;
+    hasHeaders: boolean;
+    linesToSkipAtStart: number;
+    quoteEscapeChar: string;
+    quoteMarkCharSeq: string;
+    recordDelimiterCharSeq: RecordDelimiterId;
     parsingRecords: ParsingRecord[];
     inferenceRecords: InferenceRecord[];
     size: number;
+    skipEmptyLines: boolean;
+    skipLinesWithEmptyValues: boolean;
+    skipLinesWithErrors: boolean;
     text: string;
-    valueDelimiterId?: ValueDelimiterId;
+    valueDelimiterCharSeq: ValueDelimiterId;
+    valueTrimMethodId: string;
 }
 /**
  * Data view content audit configuration.
  */
-interface DataViewContentAuditConfig {
+interface ContentAuditConfig {
     asAt: number;
-    columns: ConnectionColumnConfig[];
+    columns: ObjectColumnConfig[];
     commentLineCount: number;
     emptyLineCount: number;
     invalidFieldLengthCount: number;
@@ -58,7 +66,7 @@ interface DataViewContentAuditConfig {
 /**
  * Data view relationships audit configuration.
  */
-interface DataViewRelationshipsAuditConfig {
+interface RelationshipsAuditConfig {
     placeholder?: string;
 }
 type ObjectRecord = (NamedValueRecord | StringValueRecord | ValueRecord)[];
@@ -142,7 +150,7 @@ type ValueDelimiterId = '' | ':' | ',' | '!' | '0x1E' | ';' | ' ' | '\t' | '_' |
  */
 declare const ORDERED_VALUE_DELIMITER_IDS: ValueDelimiterId[];
 export { ORDERED_VALUE_DELIMITER_IDS };
-export type { DataViewInterface, DataViewConfig, DataViewContentAuditConfig, DataViewLocalisedConfig, DataViewPreviewConfig, DataFormatId, // Data format.
+export type { DataViewInterface, DataViewConfig, DataViewLocalisedConfig, PreviewConfig, ContentAuditConfig, RelationshipsAuditConfig, DataFormatId, // Data format.
 DataTypeId, // Data type.
 NumericSubtypeId, // Numeric subtype and characteristics.
 NumericSignId, NumericUnitsId, StringSubtypeId, // String subtype.

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

@@ -2,9 +2,9 @@ import { ConnectionConfig } from '../component/connector/connection';
 import { EncodingTypeConfig } from '../encoding';
 import { ModuleConfig } from '../component/module';
 import { ToolConfig } from '../component/tool';
-import { ConnectionColumnConfig, ConnectorOperationOptions } from '../component/connector';
+import { ConnectorOperationOptions, ObjectColumnConfig } from '../component/connector';
+import { ContentAuditConfig, InferenceRecord, ParsingRecord, ValueDelimiterId } from '../component/dataView';
 import { ContextConfig, ContextOperationOptions } from '../component/context';
-import { DataViewContentAuditConfig, InferenceResult, ParsingResult, ValueDelimiterId } from '../component/dataView';
 /**
  * Engine runtime interface.
  */
@@ -43,7 +43,7 @@ interface EngineCallbackData {
  * Engine utilities.
  */
 interface EngineUtilities {
-    parseRecord: (columnConfigs: ConnectionColumnConfig[], record: ParsingResult[], isPreview: boolean) => InferenceResult[];
+    inferValues: (columnConfigs: ObjectColumnConfig[], parsingRecord: ParsingRecord) => InferenceRecord;
 }
 /**
  * Audit object content options and result.
@@ -55,7 +55,7 @@ interface AuditObjectContentOptions extends ConnectorOperationOptions {
     valueDelimiterId: ValueDelimiterId;
 }
 interface AuditObjectContentResult {
-    contentAuditConfig: DataViewContentAuditConfig;
+    contentAuditConfig: ContentAuditConfig;
 }
 interface TestSettings {
     action?: string;

package/package.json

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