@dpuse/dpuse-shared 1.0.147 → 1.0.149

package/dist/types/src/component/module/tool/index.d.ts

@@ -1,5 +1,7 @@
-import { ModuleConfig } from '..';
-export interface ToolConfig extends ModuleConfig {
-    typeId: 'tool';
-}
+import { InferOutput } from 'valibot';
+import { parserConfigSchema, toolConfigSchema } from './toolConfig.schema';
+export { toolConfigSchema } from './toolConfig.schema';
+export type ToolConfig = InferOutput<typeof toolConfigSchema>;
+export type ParserConfig = InferOutput<typeof parserConfigSchema>;
+export type { ParserInterface, ParseStreamOptions, ParseTextOptions, ParseTextResult } from './parser';
 export declare function loadTool<T>(toolConfigs: ToolConfig[], toolId: string): Promise<T>;

package/dist/types/src/component/module/tool/parser.d.ts

@@ -0,0 +1,24 @@
+import { DataFormatId, ParsingRecord, PreviewIssue, RecordDelimiterId, ValueDelimiterId } from '../../dataView';
+import { RecordRetrievalTypeId, RetrieveRecordsSummary } from '../connector';
+export interface ParserInterface {
+    parseStream: (stream: ReadableStream<Uint8Array>, options: ParseStreamOptions, chunk: (typeId: RecordRetrievalTypeId, records: ParsingRecord[]) => void) => Promise<RetrieveRecordsSummary>;
+    parseText: (text: string, options: ParseTextOptions) => Promise<ParseTextResult>;
+}
+export interface ParseTextOptions {
+    dataFormatId: DataFormatId;
+    isComplete: boolean;
+    valueDelimiterIds: ValueDelimiterId[];
+}
+export interface ParseTextResult {
+    issues: PreviewIssue[];
+    parsedRecords: ParsingRecord[];
+    recordDelimiterId: RecordDelimiterId;
+    valueDelimiterId: ValueDelimiterId | undefined;
+}
+export interface ParseStreamOptions {
+    abortSignal: AbortSignal;
+    chunkSize: number | undefined;
+    dataFormatId: DataFormatId;
+    encodingId: string;
+    valueDelimiterId: ValueDelimiterId;
+}

package/dist/types/src/component/module/tool/toolConfig.schema.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Defines the configuration metadata for a tool. Used for validation of tool manifests.
+ */
+export declare const parserDataFormatIdSchema: import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"arrow", undefined>, import('valibot').LiteralSchema<"avro", undefined>, import('valibot').LiteralSchema<"dtv", undefined>, import('valibot').LiteralSchema<"json", undefined>, import('valibot').LiteralSchema<"jsonl", undefined>, import('valibot').LiteralSchema<"markdown", undefined>, import('valibot').LiteralSchema<"ods", undefined>, import('valibot').LiteralSchema<"parquet", undefined>, import('valibot').LiteralSchema<"sav", undefined>, import('valibot').LiteralSchema<"sqlite", undefined>, import('valibot').LiteralSchema<"xlsx", undefined>, import('valibot').LiteralSchema<"xml", undefined>], undefined>;
+export declare const parserConfigSchema: import('valibot').StrictObjectSchema<{
+    readonly dataFormatIds: import('valibot').SchemaWithPipe<readonly [import('valibot').ArraySchema<import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"arrow", undefined>, import('valibot').LiteralSchema<"avro", undefined>, import('valibot').LiteralSchema<"dtv", undefined>, import('valibot').LiteralSchema<"json", undefined>, import('valibot').LiteralSchema<"jsonl", undefined>, import('valibot').LiteralSchema<"markdown", undefined>, import('valibot').LiteralSchema<"ods", undefined>, import('valibot').LiteralSchema<"parquet", undefined>, import('valibot').LiteralSchema<"sav", undefined>, import('valibot').LiteralSchema<"sqlite", undefined>, import('valibot').LiteralSchema<"xlsx", undefined>, import('valibot').LiteralSchema<"xml", undefined>], undefined>, undefined>, import('valibot').MinLengthAction<("arrow" | "avro" | "dtv" | "json" | "jsonl" | "markdown" | "ods" | "parquet" | "sav" | "sqlite" | "xlsx" | "xml")[], 1, undefined>]>;
+}, undefined>;
+export declare const toolConfigSchema: import('valibot').StrictObjectSchema<{
+    readonly typeId: import('valibot').LiteralSchema<"tool", undefined>;
+    readonly actionNames: import('valibot').OptionalSchema<import('valibot').ArraySchema<import('valibot').StringSchema<undefined>, undefined>, undefined>;
+    readonly parser: import('valibot').OptionalSchema<import('valibot').StrictObjectSchema<{
+        readonly dataFormatIds: import('valibot').SchemaWithPipe<readonly [import('valibot').ArraySchema<import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"arrow", undefined>, import('valibot').LiteralSchema<"avro", undefined>, import('valibot').LiteralSchema<"dtv", undefined>, import('valibot').LiteralSchema<"json", undefined>, import('valibot').LiteralSchema<"jsonl", undefined>, import('valibot').LiteralSchema<"markdown", undefined>, import('valibot').LiteralSchema<"ods", undefined>, import('valibot').LiteralSchema<"parquet", undefined>, import('valibot').LiteralSchema<"sav", undefined>, import('valibot').LiteralSchema<"sqlite", undefined>, import('valibot').LiteralSchema<"xlsx", undefined>, import('valibot').LiteralSchema<"xml", undefined>], undefined>, undefined>, import('valibot').MinLengthAction<("arrow" | "avro" | "dtv" | "json" | "jsonl" | "markdown" | "ods" | "parquet" | "sav" | "sqlite" | "xlsx" | "xml")[], 1, undefined>]>;
+    }, undefined>, undefined>;
+    readonly vendorAccountURL: import('valibot').NullableSchema<import('valibot').StringSchema<undefined>, undefined>;
+    readonly vendorDocumentationURL: import('valibot').NullableSchema<import('valibot').StringSchema<undefined>, undefined>;
+    readonly vendorHomeURL: import('valibot').NullableSchema<import('valibot').StringSchema<undefined>, undefined>;
+    readonly version: import('valibot').StringSchema<undefined>;
+    readonly firstCreatedAt: import('valibot').NullableSchema<import('valibot').NumberSchema<undefined>, undefined>;
+    readonly lastUpdatedAt: import('valibot').NullableSchema<import('valibot').NumberSchema<undefined>, undefined>;
+    readonly status: import('valibot').NullableSchema<import('valibot').StrictObjectSchema<{
+        readonly color: import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"danger", undefined>, import('valibot').LiteralSchema<"success", undefined>, import('valibot').LiteralSchema<"warning", undefined>], undefined>;
+        readonly label: import('valibot').StringSchema<undefined>;
+    }, undefined>, undefined>;
+    readonly statusId: import('valibot').NullableSchema<import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"alpha", undefined>, import('valibot').LiteralSchema<"beta", undefined>, import('valibot').LiteralSchema<"releaseCandidate", undefined>, import('valibot').LiteralSchema<"generalAvailability", undefined>], undefined>, undefined>;
+    readonly id: import('valibot').StringSchema<undefined>;
+    readonly label: import('valibot').StrictObjectSchema<{
+        readonly en: import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+        readonly es: import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+    }, undefined>;
+    readonly description: import('valibot').StrictObjectSchema<{
+        readonly en: import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+        readonly es: import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+    }, undefined>;
+    readonly icon: import('valibot').NullableSchema<import('valibot').StringSchema<undefined>, undefined>;
+    readonly iconDark: import('valibot').NullableSchema<import('valibot').StringSchema<undefined>, undefined>;
+}, undefined>;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@dpuse/dpuse-shared",
-    "version": "1.0.147",
+    "version": "1.0.149",
     "private": false,
     "description": "Common constants, types and utilities used across DPUse projects.",
     "license": "MIT",