@dpuse/dpuse-shared 0.3.593

package/dist/dpuse-shared-utilities.es.js

@@ -0,0 +1,79 @@
+//#region src/utilities/index.ts
+var e = "en-US", t = /* @__PURE__ */ new Map();
+function n(e) {
+	switch (e) {
+		case "Edm.Binary": return "unknown";
+		case "Edm.Boolean": return "boolean";
+		case "Edm.Byte": return "wholeNumber";
+		case "Edm.DateTime": return "moment";
+		case "Edm.DateTimeOffset": return "moment";
+		case "Edm.Decimal": return "decimalNumber";
+		case "Edm.Double": return "decimalNumber";
+		case "Edm.Guid": return "string";
+		case "Edm.Int16": return "wholeNumber";
+		case "Edm.Int32": return "wholeNumber";
+		case "Edm.Int64": return "wholeNumber";
+		case "Edm.SByte": return "wholeNumber";
+		case "Edm.Single": return "decimalNumber";
+		case "Edm.String": return "string";
+		case "Edm.Time": return "momentTime";
+		default: return "unknown";
+	}
+}
+function r(e) {
+	if (e) {
+		let t = e.lastIndexOf("/"), n = e.lastIndexOf(".", t === -1 ? e.length : t);
+		return n === -1 ? e : e.slice(0, Math.max(0, n));
+	}
+}
+function i(e) {
+	if (e) {
+		let t = e.lastIndexOf(".");
+		if (t !== -1) return e.slice(Math.max(0, t + 1));
+	}
+}
+function a(n, r = 2, i = r, a = e) {
+	if (n == null) return "";
+	let o = `${a}decimal${r}.${i}`, s = t.get(o);
+	return s || (s = new Intl.NumberFormat(a, {
+		localeMatcher: "best fit",
+		maximumFractionDigits: r,
+		minimumFractionDigits: i,
+		minimumIntegerDigits: 1,
+		style: "decimal",
+		useGrouping: !0
+	}), t.set(o, s)), s.format(n);
+}
+function o(e) {
+	return e == null ? "" : e < 1e3 ? l(e) : e < 1e6 ? `${a(e / 1e3, 2, 0)}K` : e < 1e9 ? `${a(e / 1e6, 2, 0)}M` : e < 0xe8d4a51000 ? `${a(e / 1e9, 2, 0)}B` : `${a(e / 0xe8d4a51000, 2, 0)}T`;
+}
+function s(e) {
+	return e == null ? "" : e === 1 ? "1 byte" : e < 1024 ? `${l(e)} bytes` : e < 1048576 ? `${a(e / 1024, 2, 0)} KB` : e < 1073741824 ? `${a(e / 1048576, 2, 0)} MB` : e < 1099511627776 ? `${a(e / 1073741824, 2, 0)} GB` : `${a(e / 1099511627776, 2, 0)} TB`;
+}
+function c(e) {
+	return e == null ? "" : e < 1e3 ? `${l(e)} ms` : e === 1e3 ? `${l(e)} sec` : e < 6e4 ? `${a(e / 1e3, 2, 0)} secs` : e === 6e4 ? "1 min" : e < 36e5 ? `${a(e / 6e4, 2, 0)} mins` : e === 36e5 ? "1 hr" : e < 864e5 ? `${a(e / 36e5, 2, 0)} hrs` : e === 864e5 ? "1 day" : `${a(e / 864e5, 2, 0)} days`;
+}
+function l(n, r = e) {
+	if (n == null) return "";
+	let i = `${r}decimal0.0`, a = t.get(i);
+	return a || (a = new Intl.NumberFormat(r, {
+		localeMatcher: "best fit",
+		maximumFractionDigits: 0,
+		minimumFractionDigits: 0,
+		minimumIntegerDigits: 1,
+		style: "decimal",
+		useGrouping: !0
+	}), t.set(i, a)), a.format(n);
+}
+function u(e) {
+	switch (e) {
+		case "csv": return "text/csv";
+		case "tab":
+		case "tsv": return "text/tab-separated-values";
+		case "xls": return "application/vnd.ms-excel";
+		case "xlsx": return "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet";
+		default: return "application/octet-stream";
+	}
+}
+//#endregion
+export { n as convertODataTypeIdToUsageTypeId, i as extractExtensionFromPath, r as extractNameFromPath, a as formatNumberAsDecimalNumber, c as formatNumberAsDuration, o as formatNumberAsSize, s as formatNumberAsStorageSize, l as formatNumberAsWholeNumber, u as lookupMimeTypeForExtension };

package/dist/dpuse-shared.es.js

@@ -0,0 +1,25 @@
+import { d as e, f as t, i as n, l as r, r as i, s as a, t as o } from "./componentConfig.schema-Csigo0y4.js";
+import { t as s } from "./moduleConfig.schema-WvtAJjAG.js";
+//#region src/component/context/contextConfig.schema.ts
+var c = n(["list"]), l = t({
+	...o,
+	typeId: r("contextModelGroup"),
+	modelRefs: a(i),
+	order: e()
+}), u = t({
+	...s,
+	typeId: r("context"),
+	models: a(l),
+	operations: a(c)
+}), d = n([
+	"list",
+	"render",
+	"setColorMode"
+]), f = t({
+	...s,
+	typeId: r("presenter"),
+	presentations: a(i),
+	operations: a(d)
+});
+//#endregion
+export { u as contextConfigSchema, f as presenterConfigSchema };

package/dist/moduleConfig.schema-WvtAJjAG.js

@@ -0,0 +1,19 @@
+import { f as e, h as t, i as n, t as r } from "./componentConfig.schema-Csigo0y4.js";
+//#region src/component/moduleConfig.schema.ts
+var i = n([
+	"app",
+	"engine",
+	"connector",
+	"context",
+	"presenter",
+	"tool"
+]), a = {
+	...r,
+	version: t()
+};
+e({
+	...a,
+	typeId: i
+});
+//#endregion
+export { a as t };

package/dist/types/src/component/componentConfig.schema.d.ts

@@ -0,0 +1,129 @@
+import { LiteralSchema, UnionSchema } from 'valibot';
+/**
+ *
+ */
+type LiteralUnionSchema<T extends readonly string[]> = UnionSchema<{
+    [K in keyof T]: LiteralSchema<T[K], undefined>;
+}, undefined>;
+/**
+ *
+ */
+declare const literalUnion: <const T extends readonly string[]>(values: T) => LiteralUnionSchema<T>;
+/**
+ *
+ */
+declare const localisedStringSchema: import('valibot').ObjectSchema<{
+    readonly 'en-au': import('valibot').StringSchema<undefined>;
+    readonly 'en-gb': import('valibot').StringSchema<undefined>;
+    readonly 'en-us': import('valibot').StringSchema<undefined>;
+    readonly 'es-es': import('valibot').StringSchema<undefined>;
+}, undefined>;
+/**
+ *
+ */
+declare const partialLocalisedStringSchema: import('valibot').ObjectSchema<{
+    readonly 'en-au': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+    readonly 'en-gb': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+    readonly 'en-us': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+    readonly 'es-es': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+}, undefined>;
+/**
+ *
+ */
+declare const componentStatusColorIdSchema: LiteralUnionSchema<readonly ["amber", "green", "red", "other"]>;
+/**
+ *
+ */
+declare const componentStatusIdSchema: LiteralUnionSchema<readonly ["alpha", "beta", "generalAvailability", "notApplicable", "preAlpha", "proposed", "releaseCandidate", "unavailable", "underReview"]>;
+/**
+ *
+ */
+declare const componentTypeIdSchema: LiteralUnionSchema<readonly ["app", "connector", "connectorConnection", "context", "contextModelGroup", "contextModel", "contextModelDimensionGroup", "contextModelDimension", "contextModelDimensionHierarchy", "contextModelEntityGroup", "contextModelEntity", "contextModelEntityDataItem", "contextModelEntityEvent", "contextModelEntityPrimaryMeasure", "contextModelSecondaryMeasureGroup", "contextModelSecondaryMeasure", "dataView", "dimension", "engine", "eventQuery", "presenter", "presenterPresentation", "tool"]>;
+/**
+ *
+ */
+declare const componentStatusSchema: import('valibot').ObjectSchema<{
+    readonly id: import('valibot').StringSchema<undefined>;
+    readonly color: LiteralUnionSchema<readonly ["amber", "green", "red", "other"]>;
+    readonly label: import('valibot').StringSchema<undefined>;
+}, undefined>;
+/**
+ *
+ */
+declare const componentConfigCoreFields: {
+    readonly id: import('valibot').StringSchema<undefined>;
+    readonly label: import('valibot').ObjectSchema<{
+        readonly 'en-au': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+        readonly 'en-gb': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+        readonly 'en-us': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+        readonly 'es-es': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+    }, undefined>;
+    readonly description: import('valibot').ObjectSchema<{
+        readonly 'en-au': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+        readonly 'en-gb': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+        readonly 'en-us': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+        readonly 'es-es': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+    }, undefined>;
+    readonly firstCreatedAt: import('valibot').OptionalSchema<import('valibot').NumberSchema<undefined>, undefined>;
+    readonly icon: import('valibot').NullableSchema<import('valibot').StringSchema<undefined>, undefined>;
+    readonly iconDark: import('valibot').NullableSchema<import('valibot').StringSchema<undefined>, undefined>;
+    readonly lastUpdatedAt: import('valibot').NullableSchema<import('valibot').NumberSchema<undefined>, undefined>;
+    readonly status: import('valibot').NullableSchema<import('valibot').ObjectSchema<{
+        readonly id: import('valibot').StringSchema<undefined>;
+        readonly color: LiteralUnionSchema<readonly ["amber", "green", "red", "other"]>;
+        readonly label: import('valibot').StringSchema<undefined>;
+    }, undefined>, undefined>;
+    readonly statusId: LiteralUnionSchema<readonly ["alpha", "beta", "generalAvailability", "notApplicable", "preAlpha", "proposed", "releaseCandidate", "unavailable", "underReview"]>;
+};
+/**
+ *
+ */
+declare const componentConfigSchema: import('valibot').ObjectSchema<{
+    readonly typeId: LiteralUnionSchema<readonly ["app", "connector", "connectorConnection", "context", "contextModelGroup", "contextModel", "contextModelDimensionGroup", "contextModelDimension", "contextModelDimensionHierarchy", "contextModelEntityGroup", "contextModelEntity", "contextModelEntityDataItem", "contextModelEntityEvent", "contextModelEntityPrimaryMeasure", "contextModelSecondaryMeasureGroup", "contextModelSecondaryMeasure", "dataView", "dimension", "engine", "eventQuery", "presenter", "presenterPresentation", "tool"]>;
+    readonly id: import('valibot').StringSchema<undefined>;
+    readonly label: import('valibot').ObjectSchema<{
+        readonly 'en-au': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+        readonly 'en-gb': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+        readonly 'en-us': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+        readonly 'es-es': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+    }, undefined>;
+    readonly description: import('valibot').ObjectSchema<{
+        readonly 'en-au': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+        readonly 'en-gb': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+        readonly 'en-us': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+        readonly 'es-es': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+    }, undefined>;
+    readonly firstCreatedAt: import('valibot').OptionalSchema<import('valibot').NumberSchema<undefined>, undefined>;
+    readonly icon: import('valibot').NullableSchema<import('valibot').StringSchema<undefined>, undefined>;
+    readonly iconDark: import('valibot').NullableSchema<import('valibot').StringSchema<undefined>, undefined>;
+    readonly lastUpdatedAt: import('valibot').NullableSchema<import('valibot').NumberSchema<undefined>, undefined>;
+    readonly status: import('valibot').NullableSchema<import('valibot').ObjectSchema<{
+        readonly id: import('valibot').StringSchema<undefined>;
+        readonly color: LiteralUnionSchema<readonly ["amber", "green", "red", "other"]>;
+        readonly label: import('valibot').StringSchema<undefined>;
+    }, undefined>, undefined>;
+    readonly statusId: LiteralUnionSchema<readonly ["alpha", "beta", "generalAvailability", "notApplicable", "preAlpha", "proposed", "releaseCandidate", "unavailable", "underReview"]>;
+}, undefined>;
+/**
+ *
+ */
+declare const componentReferenceSchema: import('valibot').ObjectSchema<{
+    readonly id: import('valibot').StringSchema<undefined>;
+    readonly label: import('valibot').ObjectSchema<{
+        readonly 'en-au': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+        readonly 'en-gb': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+        readonly 'en-us': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+        readonly 'es-es': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+    }, undefined>;
+    readonly description: import('valibot').ObjectSchema<{
+        readonly 'en-au': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+        readonly 'en-gb': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+        readonly 'en-us': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+        readonly 'es-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>;
+    readonly order: import('valibot').NumberSchema<undefined>;
+    readonly path: import('valibot').StringSchema<undefined>;
+}, undefined>;
+export { componentConfigCoreFields, componentConfigSchema, componentReferenceSchema, componentStatusColorIdSchema, componentStatusIdSchema, componentStatusSchema, componentTypeIdSchema, literalUnion, localisedStringSchema, partialLocalisedStringSchema };

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

@@ -0,0 +1,92 @@
+import { ComponentConfig } from '..';
+import { ConnectorConfig } from '.';
+import { LocalisedString } from '../../locale';
+import { DataSubtypeId, DataTypeId } from '../dataView';
+/**
+ * Connection configuration.
+ */
+interface ConnectionConfig extends ComponentConfig {
+    authorisation: Record<string, ConnectionAuthorisationConfig>;
+    connectorConfig: ConnectorConfig;
+    lastVerifiedAt: number;
+    notation: string | undefined;
+}
+/**
+ * Connection authorisation configuration.
+ */
+interface ConnectionAuthorisationConfig {
+    accessToken: string;
+    accountId: string;
+    expiresAt: number;
+    expiresIn: number;
+    refreshToken: string;
+    scope: string;
+    tokenType: string;
+    uid: string;
+}
+/**
+ * Connection description configuration.
+ */
+interface ConnectionDescriptionConfig {
+    objects: {
+        id: string;
+        label: Record<string, string>;
+        columns: ObjectColumnConfig[];
+    }[];
+}
+/**
+ * Connection node configuration.
+ */
+interface ConnectionNodeConfig {
+    childCount: number | undefined;
+    childNodes: ConnectionNodeConfig[];
+    extension: string | undefined;
+    folderPath: string;
+    handle: DPAFileSystemFileHandle | undefined;
+    id: string;
+    label: string;
+    lastModifiedAt: number | undefined;
+    mimeType: string | undefined;
+    name: string;
+    size: number | undefined;
+    typeId: NodeTypeId;
+}
+/**
+ *
+ */
+interface DPAFileSystemFileHandle {
+    readonly kind: 'file';
+    getFile(): Promise<File>;
+}
+/**
+ * Connection node type identifier.
+ */
+type NodeTypeId = 'folder' | 'object';
+/**
+ * Object column configuration.
+ */
+interface ObjectColumnConfig {
+    dataTypeId: DataTypeId;
+    dataSubtypeId: DataSubtypeId | undefined;
+    inferenceCounts: Record<string, number>;
+    invalidValueCount: number | undefined;
+    invalidValues: Record<string, string>;
+    isIgnored: boolean | undefined;
+    isRequired: boolean | undefined;
+    isUnique: boolean | undefined;
+    label: Partial<LocalisedString>;
+    leadingInferenceCounts: Record<string, number>;
+    maxDecimals: number | undefined;
+    maxSize: number | undefined;
+    maxValue: string | undefined;
+    minDecimals: number | undefined;
+    minSize: number | undefined;
+    minValue: string | undefined;
+    formats: Record<string, string>;
+    storageTypeId: StorageTypeId | undefined;
+    validValueCount: number | undefined;
+    validValues: Record<string, string>;
+    voidValueCount: number | undefined;
+}
+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/connectorConfig.schema.d.ts

@@ -0,0 +1,80 @@
+/**
+ * Connector configuration schema.
+ *
+ * Defines the configuration metadata for a connector. Used for validation
+ * of connector manifests and capability discovery at runtime.
+ */
+/** Operation names a connector may support. */
+declare const connectorOperationNameSchema: import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"abortOperation", undefined>, import('valibot').LiteralSchema<"auditObjectContent", 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. */
+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>;
+/**
+ *
+ */
+declare const connectorCategoryConfigSchema: import('valibot').ObjectSchema<{
+    readonly id: import('valibot').StringSchema<undefined>;
+    readonly label: import('valibot').ObjectSchema<{
+        readonly 'en-au': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+        readonly 'en-gb': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+        readonly 'en-us': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+        readonly 'es-es': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+    }, undefined>;
+}, undefined>;
+/** Top-level connector configuration object. */
+declare const connectorConfigSchema: import('valibot').ObjectSchema<{
+    readonly typeId: import('valibot').LiteralSchema<"connector", undefined>;
+    readonly category: import('valibot').NullableSchema<import('valibot').ObjectSchema<{
+        readonly id: import('valibot').StringSchema<undefined>;
+        readonly label: import('valibot').ObjectSchema<{
+            readonly 'en-au': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+            readonly 'en-gb': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+            readonly 'en-us': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+            readonly 'es-es': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+        }, undefined>;
+    }, undefined>, undefined>;
+    readonly categoryId: 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>;
+    readonly implementations: import('valibot').RecordSchema<import('valibot').StringSchema<undefined>, 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>;
+        readonly canDescribe: import('valibot').OptionalSchema<import('valibot').BooleanSchema<undefined>, undefined>;
+        readonly id: import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+        readonly label: import('valibot').OptionalSchema<import('valibot').ObjectSchema<{
+            readonly 'en-au': import('valibot').StringSchema<undefined>;
+            readonly 'en-gb': import('valibot').StringSchema<undefined>;
+            readonly 'en-us': import('valibot').StringSchema<undefined>;
+            readonly 'es-es': import('valibot').StringSchema<undefined>;
+        }, undefined>, undefined>;
+        readonly maxConnectionCount: import('valibot').NullableSchema<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>, undefined>;
+    readonly operations: import('valibot').ArraySchema<import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"abortOperation", undefined>, import('valibot').LiteralSchema<"auditObjectContent", 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>, undefined>;
+    readonly usageId: 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>;
+    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 id: import('valibot').StringSchema<undefined>;
+    readonly label: import('valibot').ObjectSchema<{
+        readonly 'en-au': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+        readonly 'en-gb': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+        readonly 'en-us': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+        readonly 'es-es': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+    }, undefined>;
+    readonly description: import('valibot').ObjectSchema<{
+        readonly 'en-au': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+        readonly 'en-gb': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+        readonly 'en-us': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+        readonly 'es-es': import('valibot').OptionalSchema<import('valibot').StringSchema<undefined>, undefined>;
+    }, undefined>;
+    readonly firstCreatedAt: import('valibot').OptionalSchema<import('valibot').NumberSchema<undefined>, undefined>;
+    readonly icon: import('valibot').NullableSchema<import('valibot').StringSchema<undefined>, undefined>;
+    readonly iconDark: import('valibot').NullableSchema<import('valibot').StringSchema<undefined>, undefined>;
+    readonly lastUpdatedAt: import('valibot').NullableSchema<import('valibot').NumberSchema<undefined>, undefined>;
+    readonly status: import('valibot').NullableSchema<import('valibot').ObjectSchema<{
+        readonly id: import('valibot').StringSchema<undefined>;
+        readonly color: import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"amber", undefined>, import('valibot').LiteralSchema<"green", undefined>, import('valibot').LiteralSchema<"red", undefined>, import('valibot').LiteralSchema<"other", undefined>], undefined>;
+        readonly label: import('valibot').StringSchema<undefined>;
+    }, undefined>, undefined>;
+    readonly statusId: import('valibot').UnionSchema<readonly [import('valibot').LiteralSchema<"alpha", undefined>, import('valibot').LiteralSchema<"beta", undefined>, import('valibot').LiteralSchema<"generalAvailability", undefined>, import('valibot').LiteralSchema<"notApplicable", undefined>, import('valibot').LiteralSchema<"preAlpha", undefined>, import('valibot').LiteralSchema<"proposed", undefined>, import('valibot').LiteralSchema<"releaseCandidate", undefined>, import('valibot').LiteralSchema<"unavailable", undefined>, import('valibot').LiteralSchema<"underReview", undefined>], undefined>;
+}, undefined>;
+export { connectorCategoryConfigSchema, connectorConfigSchema, connectorOperationNameSchema, connectorUsageIdSchema };

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

@@ -0,0 +1,219 @@
+import { InferOutput } from 'valibot';
+import { Component } from '..';
+import { ToolConfig } from '../tool';
+import { ConnectionDescriptionConfig, ConnectionNodeConfig } from './connection';
+import { connectorCategoryConfigSchema, connectorConfigSchema, connectorOperationNameSchema, connectorUsageIdSchema } from './connectorConfig.schema';
+import { ContentAuditConfig, ParsingRecord, PreviewConfig, ValueDelimiterId } from '../dataView';
+import { EngineOperationOptions, EngineUtilities } from '../../engine';
+export interface ConnectorInterface extends Component {
+    abortController: AbortController | undefined;
+    readonly config: ConnectorConfig;
+    readonly toolConfigs: ToolConfig[];
+    abortOperation?(): void;
+    auditObjectContent?(options: AuditObjectContentOptions, chunk: (rowCount: number) => void): Promise<AuditObjectContentResult>;
+    authenticateConnection?(accountId: string, windowCenterX: number, windowCenterY: number): Window;
+    createObject?(options: CreateObjectOptions): Promise<void>;
+    describeConnection?(options: DescribeConnectionOptions): Promise<DescribeConnectionResult>;
+    dropObject?(options: DropObjectOptions): Promise<void>;
+    findObject?(options: FindObjectOptions): Promise<FindObjectResult>;
+    getReadableStream?(options: GetReadableStreamOptions): Promise<ReadableStream<Uint8Array>>;
+    getRecord?(options: GetRecordOptions): Promise<GetRecordResult>;
+    listNodes?(options: ListNodesOptions): Promise<ListNodesResult>;
+    previewObject?(options: PreviewObjectOptions): Promise<PreviewConfig>;
+    removeRecords?(options: RemoveRecordsOptions): Promise<void>;
+    retrieveChunks?(options: RetrieveChunksOptions, chunk: (data: Uint8Array) => void, complete: () => void): Promise<void>;
+    retrieveRecords?(options: RetrieveRecordsOptions, chunk: (typeId: RetrievalTypeId, records: Record<string, unknown>[] | ParsingRecord[]) => void, complete: (result: RetrieveRecordsSummary) => void): Promise<void>;
+    upsertRecords?(options: UpsertRecordsOptions): Promise<void>;
+}
+export type ConnectorConstructor = new (engineUtilities: EngineUtilities, toolConfigs: ToolConfig[]) => ConnectorInterface;
+export type RetrievalTypeId = 'jsonRecordArray' | 'parsingRecordArray';
+export type ConnectorOperationName = InferOutput<typeof connectorOperationNameSchema>;
+/**
+ * Connector data pipeline usage identifiers.
+ */
+type ConnectorUsageId = InferOutput<typeof connectorUsageIdSchema>;
+/**
+ * Connector configuration.
+ */
+type ConnectorConfig = InferOutput<typeof connectorConfigSchema>;
+type ConnectorLocalisedConfig = Omit<ConnectorConfig, 'label' | 'description'> & {
+    label: string;
+    description: string;
+};
+/**
+ * Audit object content options and result.
+ */
+interface AuditObjectContentOptions1 extends EngineOperationOptions {
+    chunkSize: number | undefined;
+    encodingId: string;
+    path: string;
+    valueDelimiterId: ValueDelimiterId;
+}
+/**
+ *
+ */
+interface AuditObjectContentResult1 {
+    contentAuditConfig: ContentAuditConfig;
+}
+/**
+ * Audit object content options.
+ */
+interface AuditObjectContentOptions extends EngineOperationOptions {
+    chunkSize: number | undefined;
+    encodingId: string;
+    parsingToolName: string | undefined;
+    path: string;
+    supportsTransferableStreams: boolean;
+    valueDelimiterId: ValueDelimiterId;
+}
+/**
+ * Audit object content result.
+ */
+interface AuditObjectContentResult {
+    processedRowCount: number;
+    durationMs: number;
+}
+/**
+ * Create object options.
+ */
+interface CreateObjectOptions extends EngineOperationOptions {
+    path: string;
+    structure: string;
+}
+/**
+ * Describe connection options and result.
+ */
+type DescribeConnectionOptions = EngineOperationOptions;
+interface DescribeConnectionResult {
+    descriptionConfig: ConnectionDescriptionConfig;
+}
+/**
+ * Drop object options.
+ */
+interface DropObjectOptions extends EngineOperationOptions {
+    path: string;
+}
+/**
+ * Find object options and result.
+ */
+interface FindObjectOptions extends EngineOperationOptions {
+    storeId: string | undefined;
+    nodeId: string;
+}
+interface FindObjectResult {
+    path: string | undefined;
+}
+/**
+ * Get readable stream options.
+ */
+interface GetReadableStreamOptions extends EngineOperationOptions {
+    id: string;
+    path: string;
+}
+/**
+ * Get record options and result.
+ */
+interface GetRecordOptions extends EngineOperationOptions {
+    id: string;
+    path: string;
+}
+interface GetRecordResult {
+    record?: string[] | Record<string, unknown>;
+}
+/**
+ * List nodes options and result.
+ */
+interface ListNodesOptions extends EngineOperationOptions {
+    folderPath: string;
+    limit?: number;
+    offset?: number;
+    totalCount?: number;
+}
+interface ListNodesResult {
+    cursor: string | number | undefined;
+    connectionNodeConfigs: ConnectionNodeConfig[];
+    isMore: boolean;
+    totalCount: number;
+}
+/**
+ * Preview object options.
+ */
+interface PreviewObjectOptions extends EngineOperationOptions {
+    chunkSize: number | undefined;
+    extension: string | undefined;
+    path: string;
+}
+/**
+ * Remove records options.
+ */
+interface RemoveRecordsOptions extends EngineOperationOptions {
+    keys: string[];
+    path: string;
+}
+/**
+ * Retrieve chunks options.
+ */
+interface RetrieveChunksOptions extends EngineOperationOptions {
+    chunkSize: number | undefined;
+    encodingId: string;
+    path: string;
+    valueDelimiterId: ValueDelimiterId;
+}
+/**
+ * Retrieve records options and summary.
+ */
+interface RetrieveRecordsOptions extends EngineOperationOptions {
+    chunkSize: number | undefined;
+    encodingId: string;
+    path: string;
+    valueDelimiterId: ValueDelimiterId;
+}
+interface RetrieveRecordsSummary {
+    /**
+     * Number of processed bytes.
+     */
+    byteCount: number;
+    /**
+     * Count the number of lines being fully commented.
+     */
+    commentLineCount: number;
+    /**
+     * Count the number of processed empty lines; work only with the skip_empty_lines option or an error will be thrown
+     * if an empty line is found.
+     */
+    emptyLineCount: number;
+    /**
+     * Number of lines encountered in the source dataset, start at 1 for the first line.
+     */
+    lineCount: number;
+    /**
+     * Number of non uniform records when relax_column_count is true.
+     */
+    nonUniformRecordCount: number;
+    /**
+     * Count the number of processed records.
+     */
+    recordCount: number;
+}
+/**
+ * Upsert records options.
+ */
+interface UpsertRecordsOptions extends EngineOperationOptions {
+    records: Record<string, unknown>[];
+    path: string;
+}
+/**
+ * Connector category configuration.
+ */
+type ConnectorCategoryConfig = InferOutput<typeof connectorCategoryConfigSchema>;
+type ConnectorCategoryLocalisedConfig = Omit<ConnectorCategoryConfig, 'label'> & {
+    label: string;
+};
+/**
+ * Construct connector category configuration.
+ */
+declare const constructConnectorCategoryConfig: (id: string, localeId?: import('../../locale').LocaleCode) => ConnectorCategoryLocalisedConfig;
+export { connectorConfigSchema } from './connectorConfig.schema';
+export { constructConnectorCategoryConfig };
+export type { ConnectionConfig, ConnectionNodeConfig, ObjectColumnConfig } from './connection';
+export type { AuditObjectContentOptions1, AuditObjectContentResult1, AuditObjectContentOptions, AuditObjectContentResult, ConnectorConfig, ConnectorLocalisedConfig, ConnectorUsageId, CreateObjectOptions, DropObjectOptions, FindObjectOptions, FindObjectResult, GetReadableStreamOptions, GetRecordOptions, GetRecordResult, ListNodesOptions, ListNodesResult, PreviewObjectOptions, RemoveRecordsOptions, RetrieveChunksOptions, RetrieveRecordsOptions, RetrieveRecordsSummary, UpsertRecordsOptions };