@transai/connector-runner-dummy-node 0.1.2 → 0.2.1

package/CHANGELOG.md

@@ -1,3 +1,32 @@
+## 0.3.0 (2025-11-26)
+
+### 🚀 Features
+
+- fix connector packages publish ([9b6c43a5](https://github.com/xip-online-applications/xod-core/commit/9b6c43a5))
+- fix connector packages publish ([24714951](https://github.com/xip-online-applications/xod-core/commit/24714951))
+
+### 🧱 Updated Dependencies
+
+- Updated @transai/connector-runtime-sdk to 0.2.0
+
+### ❤️ Thank You
+
+- Youri Lefers @yourilefers
+
+## 0.2.0 (2025-11-19)
+
+### 🚀 Features
+
+- fix connector packages publish ([517d2fd2](https://github.com/xip-online-applications/xod-core/commit/517d2fd2))
+
+### 🧱 Updated Dependencies
+
+- Updated @transai/connector-runtime-sdk to 0.1.0
+
+### ❤️ Thank You
+
+- Youri Lefers @yourilefers
+
 # Changelog
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).

package/index.cjs

@@ -1,2 +1,2 @@
-"use strict";var d=Object.create;var c=Object.defineProperty;var g=Object.getOwnPropertyDescriptor;var C=Object.getOwnPropertyNames;var b=Object.getPrototypeOf,u=Object.prototype.hasOwnProperty;var I=(n,o)=>{for(var e in o)c(n,e,{get:o[e],enumerable:!0})},p=(n,o,e,r)=>{if(o&&typeof o=="object"||typeof o=="function")for(let t of C(o))!u.call(n,t)&&t!==e&&c(n,t,{get:()=>o[t],enumerable:!(r=g(o,t))||r.enumerable});return n};var h=(n,o,e)=>(e=n!=null?d(b(n)):{},p(o||!n||!n.__esModule?c(e,"default",{value:n,enumerable:!0}):e,n)),y=n=>p(c({},"__esModule",{value:!0}),n);var v={};I(v,{ConnectorRunnerDummyNode:()=>f});module.exports=y(v);var s=h(require("node:process")),a=class{constructor(o,e){this.#o="connector-runtime";this.init=()=>Promise.resolve();this.start=()=>Promise.resolve();this.stop=()=>Promise.resolve();this.#e=e,s.on?s.on("message",r=>{r.cmd===this.#o&&e.logger.verbose(`${s.pid} Received message from parent process:`,r)}):e.logger.warn("IPC channel is not available. process.on is undefined."),s.send||e.logger.warn("IPC channel is not available. process.send is undefined."),o.actions?.forEach(r=>{if(r.config.templates===void 0)return;let t={};Object.entries(r.config.templates).forEach(([i,l])=>{try{t[i]=e.templating.compile(l)}catch(m){e.logger.error(`Error compiling template ${i} for action ${r.identifier}`,m)}}),r.config.parsedTemplates=t})}#o;#e;set callbackFunction(o){this.connectorSDK.receiver.registerCallback(this.#r(o))}get connectorSDK(){return this.#e}#r(o){return async e=>{let r=this.#e.receiver.getActionConfig(e);return r?o(e,r):this.#e.receiver.responses.badRequest("Action not found")(e)}}};var f=class extends a{constructor(){super(...arguments);this.CONNECTOR_INSTANCE="XOD_CONNECTOR_DUMMY_NODE_CONFIG";this.init=async()=>{let{config:e}=this.connectorSDK,r=e.failProbability||0;r>0&&this.connectorSDK.logger.debug("Fail probability set to",r);let t=()=>Math.random()<r;this.callbackFunction=async(i,l)=>(this.connectorSDK.logger.info("Received message: ",i.testRun?"(test run)":"",i.eventId,i.payload),t()?(this.connectorSDK.logger.error("Dummy process failed"),this.connectorSDK.receiver.responses.internalServerError("Dummy process failed")(i)):this.connectorSDK.receiver.responses.ok()(i))}}};0&&(module.exports={ConnectorRunnerDummyNode});
+"use strict";var d=Object.create;var c=Object.defineProperty;var g=Object.getOwnPropertyDescriptor;var C=Object.getOwnPropertyNames;var b=Object.getPrototypeOf,u=Object.prototype.hasOwnProperty;var I=(n,o)=>{for(var e in o)c(n,e,{get:o[e],enumerable:!0})},l=(n,o,e,r)=>{if(o&&typeof o=="object"||typeof o=="function")for(let t of C(o))!u.call(n,t)&&t!==e&&c(n,t,{get:()=>o[t],enumerable:!(r=g(o,t))||r.enumerable});return n};var h=(n,o,e)=>(e=n!=null?d(b(n)):{},l(o||!n||!n.__esModule?c(e,"default",{value:n,enumerable:!0}):e,n)),y=n=>l(c({},"__esModule",{value:!0}),n);var v={};I(v,{ConnectorRunnerDummyNode:()=>f});module.exports=y(v);var s=h(require("node:process")),a=class{constructor(o,e){this.#o="connector-runtime";this.init=()=>Promise.resolve();this.start=()=>Promise.resolve();this.stop=()=>Promise.resolve();this.#e=e,s.on?s.on("message",r=>{r.cmd===this.#o&&e.logger.verbose(`${s.pid} Received message from parent process:`,r)}):e.logger.warn("IPC channel is not available. process.on is undefined."),s.send||e.logger.warn("IPC channel is not available. process.send is undefined."),o.actions?.forEach(r=>{if(r.config.templates===void 0)return;let t={};Object.entries(r.config.templates).forEach(([i,p])=>{try{t[i]=e.templating.compile(p)}catch(m){e.logger.error(`Error compiling template ${i} for action ${r.identifier}`,m)}}),r.config.parsedTemplates=t})}#o;#e;set callbackFunction(o){this.connectorSDK.receiver.registerCallback(this.#r(o))}get connectorSDK(){return this.#e}#r(o){return async e=>{let r=this.#e.receiver.getActionConfig(e);return r?o(e,r):this.#e.receiver.responses.badRequest("Action not found")(e)}}};var f=class extends a{constructor(){super(...arguments);this.CONNECTOR_INSTANCE="XOD_CONNECTOR_DUMMY_NODE_CONFIG";this.init=async()=>{let{config:e}=this.connectorSDK,r=e.failProbability||0;r>0&&this.connectorSDK.logger.debug("Fail probability set to",r);let t=()=>Math.random()<r;this.callbackFunction=async(i,p)=>(this.connectorSDK.logger.info("Received message: ",i.testRun?"(test run)":"",i.eventId,i.payload),t()?(this.connectorSDK.logger.error("Dummy process failed"),this.connectorSDK.receiver.responses.internalServerError("Dummy process failed")(i)):this.connectorSDK.receiver.responses.ok()(i))}}};0&&(module.exports={ConnectorRunnerDummyNode});
 //# sourceMappingURL=index.cjs.map

package/index.cjs.map

@@ -3,5 +3,5 @@
   "sources": ["../../../libs/connector-runner-dummy-node/src/index.ts", "../../../libs/connector-runtime-sdk/src/lib/connector-runtime.ts", "../../../libs/connector-runner-dummy-node/src/lib/connector-runner-dummy-node.ts"],
   "sourcesContent": ["export * from './lib/connector-runner-dummy-node';\n", "import * as process from 'node:process';\n\nimport {\n  KafkaCallbackResponse,\n  BaseConnectorConfig,\n  ActionInterface,\n  ConnectorInterface,\n  XodJobType,\n} from '@xip-online-data/types';\n\nimport { ConnectorRuntimeInterface } from './connector-runtime.interface';\nimport { CompileDelegate, ConnectorSDKInterface } from './sdk';\n\nexport interface IpcMessage {\n  cmd: string;\n  message: string;\n}\n\nexport abstract class ConnectorRuntimeSDK<\n  T extends BaseConnectorConfig = BaseConnectorConfig,\n> implements ConnectorRuntimeInterface\n{\n  readonly #IPC_CHANNEL = 'connector-runtime';\n\n  readonly #connectorSDK: ConnectorSDKInterface<T>;\n\n  constructor(\n    connector: ConnectorInterface,\n    connectorSDK: ConnectorSDKInterface,\n  ) {\n    this.#connectorSDK = connectorSDK as ConnectorSDKInterface<T>;\n\n    if (process.on) {\n      process.on('message', (message: IpcMessage) => {\n        if (message.cmd === this.#IPC_CHANNEL) {\n          connectorSDK.logger.verbose(\n            `${process.pid} Received message from parent process:`,\n            message,\n          );\n        }\n      });\n    } else {\n      connectorSDK.logger.warn(\n        'IPC channel is not available. process.on is undefined.',\n      );\n    }\n\n    if (!process.send) {\n      // Check if process.send is available\n      connectorSDK.logger.warn(\n        'IPC channel is not available. process.send is undefined.',\n      );\n    }\n\n    // eslint-disable-next-line no-restricted-syntax\n    connector.actions?.forEach((action: ActionInterface) => {\n      if (action.config['templates'] === undefined) {\n        return;\n      }\n\n      const containers: {\n        [key: string]: CompileDelegate;\n      } = {};\n\n      Object.entries(action.config['templates']).forEach(([key, value]) => {\n        try {\n          // eslint-disable-next-line security/detect-object-injection\n          containers[key] = connectorSDK.templating.compile(value);\n        } catch (error: unknown) {\n          connectorSDK.logger.error(\n            `Error compiling template ${key} for action ${action.identifier}`,\n            error,\n          );\n        }\n      });\n\n      // eslint-disable-next-line no-param-reassign\n      action.config['parsedTemplates'] = containers;\n    });\n  }\n\n  public init: () => Promise<void> = () => Promise.resolve();\n\n  public start: () => Promise<void> = () => Promise.resolve();\n\n  public stop: () => Promise<void> = () => Promise.resolve();\n\n  set callbackFunction(\n    callback: (\n      message: XodJobType,\n      action: ActionInterface,\n    ) => Promise<KafkaCallbackResponse>,\n  ) {\n    this.connectorSDK.receiver.registerCallback(\n      this.#enrichWithActionConfig(callback),\n    );\n  }\n\n  protected get connectorSDK(): ConnectorSDKInterface<T> {\n    return this.#connectorSDK;\n  }\n\n  #enrichWithActionConfig(\n    callbackFunction: (\n      message: XodJobType,\n      action: ActionInterface,\n    ) => Promise<KafkaCallbackResponse>,\n  ): (message: XodJobType) => Promise<KafkaCallbackResponse> {\n    return async (message: XodJobType) => {\n      const action = this.#connectorSDK.receiver.getActionConfig(message);\n      if (!action) {\n        return this.#connectorSDK.receiver.responses.badRequest(\n          'Action not found',\n        )(message);\n      }\n      return callbackFunction(message, action);\n    };\n  }\n}\n", "import { ConnectorRuntimeSDK } from '@transai/connector-runtime-sdk';\nimport {\n  ActionInterface,\n  BaseConnectorConfig,\n  KafkaCallbackResponse,\n  XodJobType,\n} from '@xip-online-data/types';\n\nexport class ConnectorRunnerDummyNode extends ConnectorRuntimeSDK<\n  {\n    failProbability?: number;\n  } & BaseConnectorConfig\n> {\n  readonly CONNECTOR_INSTANCE: string = 'XOD_CONNECTOR_DUMMY_NODE_CONFIG';\n\n  override init = async (): Promise<void> => {\n    const { config } = this.connectorSDK;\n\n    const failProbability = config.failProbability || 0.0;\n    if (failProbability > 0) {\n      this.connectorSDK.logger.debug(\n        'Fail probability set to',\n        failProbability,\n      );\n    }\n\n    const dummyProcessFailed = (): boolean => {\n      return Math.random() < failProbability;\n    };\n\n    this.callbackFunction = async (\n      message: XodJobType,\n      action: ActionInterface,\n    ): Promise<KafkaCallbackResponse> => {\n      this.connectorSDK.logger.info(\n        'Received message: ',\n        message.testRun ? '(test run)' : '',\n        message.eventId,\n        message.payload,\n      );\n\n      if (dummyProcessFailed()) {\n        this.connectorSDK.logger.error('Dummy process failed');\n        return this.connectorSDK.receiver.responses.internalServerError(\n          'Dummy process failed',\n        )(message);\n      }\n\n      return this.connectorSDK.receiver.responses.ok()(message);\n    };\n  };\n}\n"],
   "mappings": "0jBAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,8BAAAE,IAAA,eAAAC,EAAAH,GCAA,IAAAI,EAAyB,2BAkBHC,EAAf,KAGP,CAKE,YACEC,EACAC,EACA,CAPF,KAASC,GAAe,oBA2DxB,KAAO,KAA4B,IAAM,QAAQ,QAAQ,EAEzD,KAAO,MAA6B,IAAM,QAAQ,QAAQ,EAE1D,KAAO,KAA4B,IAAM,QAAQ,QAAQ,EAvDvD,KAAKC,GAAgBF,EAET,KACF,KAAG,UAAYG,GAAwB,CACzCA,EAAQ,MAAQ,KAAKF,IACvBD,EAAa,OAAO,QAClB,GAAW,KAAG,yCACdG,CACF,CAEJ,CAAC,EAEDH,EAAa,OAAO,KAClB,wDACF,EAGW,QAEXA,EAAa,OAAO,KAClB,0DACF,EAIFD,EAAU,SAAS,QAASK,GAA4B,CACtD,GAAIA,EAAO,OAAO,YAAiB,OACjC,OAGF,IAAMC,EAEF,CAAC,EAEL,OAAO,QAAQD,EAAO,OAAO,SAAY,EAAE,QAAQ,CAAC,CAACE,EAAKC,CAAK,IAAM,CACnE,GAAI,CAEFF,EAAWC,CAAG,EAAIN,EAAa,WAAW,QAAQO,CAAK,CACzD,OAASC,EAAgB,CACvBR,EAAa,OAAO,MAClB,4BAA4BM,CAAG,eAAeF,EAAO,UAAU,GAC/DI,CACF,CACF,CACF,CAAC,EAGDJ,EAAO,OAAO,gBAAqBC,CACrC,CAAC,CACH,CAzDSJ,GAEAC,GA+DT,IAAI,iBACFO,EAIA,CACA,KAAK,aAAa,SAAS,iBACzB,KAAKC,GAAwBD,CAAQ,CACvC,CACF,CAEA,IAAc,cAAyC,CACrD,OAAO,KAAKP,EACd,CAEAQ,GACEC,EAIyD,CACzD,MAAO,OAAOR,GAAwB,CACpC,IAAMC,EAAS,KAAKF,GAAc,SAAS,gBAAgBC,CAAO,EAClE,OAAKC,EAKEO,EAAiBR,EAASC,CAAM,EAJ9B,KAAKF,GAAc,SAAS,UAAU,WAC3C,kBACF,EAAEC,CAAO,CAGb,CACF,CACF,EC9GO,IAAMS,EAAN,cAAuCC,CAI5C,CAJK,kCAKL,KAAS,mBAA6B,kCAEtC,KAAS,KAAO,SAA2B,CACzC,GAAM,CAAE,OAAAC,CAAO,EAAI,KAAK,aAElBC,EAAkBD,EAAO,iBAAmB,EAC9CC,EAAkB,GACpB,KAAK,aAAa,OAAO,MACvB,0BACAA,CACF,EAGF,IAAMC,EAAqB,IAClB,KAAK,OAAO,EAAID,EAGzB,KAAK,iBAAmB,MACtBE,EACAC,KAEA,KAAK,aAAa,OAAO,KACvB,qBACAD,EAAQ,QAAU,aAAe,GACjCA,EAAQ,QACRA,EAAQ,OACV,EAEID,EAAmB,GACrB,KAAK,aAAa,OAAO,MAAM,sBAAsB,EAC9C,KAAK,aAAa,SAAS,UAAU,oBAC1C,sBACF,EAAEC,CAAO,GAGJ,KAAK,aAAa,SAAS,UAAU,GAAG,EAAEA,CAAO,EAE5D,EACF",
-  "names": ["src_exports", "__export", "ConnectorRunnerDummyNode", "__toCommonJS", "process", "ConnectorRuntimeSDK", "connector", "connectorSDK", "#IPC_CHANNEL", "#connectorSDK", "message", "action", "containers", "key", "value", "error", "callback", "#enrichWithActionConfig", "callbackFunction", "ConnectorRunnerDummyNode", "ConnectorRuntimeSDK", "config", "failProbability", "dummyProcessFailed", "message", "action"]
+  "names": ["index_exports", "__export", "ConnectorRunnerDummyNode", "__toCommonJS", "process", "ConnectorRuntimeSDK", "connector", "connectorSDK", "#IPC_CHANNEL", "#connectorSDK", "message", "action", "containers", "key", "value", "error", "callback", "#enrichWithActionConfig", "callbackFunction", "ConnectorRunnerDummyNode", "ConnectorRuntimeSDK", "config", "failProbability", "dummyProcessFailed", "message", "action"]
 }

package/index.js

@@ -1,2 +1,2 @@
-import*as n from"node:process";var s=class{constructor(t,o){this.#o="connector-runtime";this.init=()=>Promise.resolve();this.start=()=>Promise.resolve();this.stop=()=>Promise.resolve();this.#e=o,n.on?n.on("message",e=>{e.cmd===this.#o&&o.logger.verbose(`${n.pid} Received message from parent process:`,e)}):o.logger.warn("IPC channel is not available. process.on is undefined."),n.send||o.logger.warn("IPC channel is not available. process.send is undefined."),t.actions?.forEach(e=>{if(e.config.templates===void 0)return;let i={};Object.entries(e.config.templates).forEach(([r,c])=>{try{i[r]=o.templating.compile(c)}catch(l){o.logger.error(`Error compiling template ${r} for action ${e.identifier}`,l)}}),e.config.parsedTemplates=i})}#o;#e;set callbackFunction(t){this.connectorSDK.receiver.registerCallback(this.#r(t))}get connectorSDK(){return this.#e}#r(t){return async o=>{let e=this.#e.receiver.getActionConfig(o);return e?t(o,e):this.#e.receiver.responses.badRequest("Action not found")(o)}}};var a=class extends s{constructor(){super(...arguments);this.CONNECTOR_INSTANCE="XOD_CONNECTOR_DUMMY_NODE_CONFIG";this.init=async()=>{let{config:o}=this.connectorSDK,e=o.failProbability||0;e>0&&this.connectorSDK.logger.debug("Fail probability set to",e);let i=()=>Math.random()<e;this.callbackFunction=async(r,c)=>(this.connectorSDK.logger.info("Received message: ",r.testRun?"(test run)":"",r.eventId,r.payload),i()?(this.connectorSDK.logger.error("Dummy process failed"),this.connectorSDK.receiver.responses.internalServerError("Dummy process failed")(r)):this.connectorSDK.receiver.responses.ok()(r))}}};export{a as ConnectorRunnerDummyNode};
+import*as n from"node:process";var s=class{constructor(t,o){this.#o="connector-runtime";this.init=()=>Promise.resolve();this.start=()=>Promise.resolve();this.stop=()=>Promise.resolve();this.#e=o,n.on?n.on("message",e=>{e.cmd===this.#o&&o.logger.verbose(`${n.pid} Received message from parent process:`,e)}):o.logger.warn("IPC channel is not available. process.on is undefined."),n.send||o.logger.warn("IPC channel is not available. process.send is undefined."),t.actions?.forEach(e=>{if(e.config.templates===void 0)return;let i={};Object.entries(e.config.templates).forEach(([r,c])=>{try{i[r]=o.templating.compile(c)}catch(p){o.logger.error(`Error compiling template ${r} for action ${e.identifier}`,p)}}),e.config.parsedTemplates=i})}#o;#e;set callbackFunction(t){this.connectorSDK.receiver.registerCallback(this.#r(t))}get connectorSDK(){return this.#e}#r(t){return async o=>{let e=this.#e.receiver.getActionConfig(o);return e?t(o,e):this.#e.receiver.responses.badRequest("Action not found")(o)}}};var a=class extends s{constructor(){super(...arguments);this.CONNECTOR_INSTANCE="XOD_CONNECTOR_DUMMY_NODE_CONFIG";this.init=async()=>{let{config:o}=this.connectorSDK,e=o.failProbability||0;e>0&&this.connectorSDK.logger.debug("Fail probability set to",e);let i=()=>Math.random()<e;this.callbackFunction=async(r,c)=>(this.connectorSDK.logger.info("Received message: ",r.testRun?"(test run)":"",r.eventId,r.payload),i()?(this.connectorSDK.logger.error("Dummy process failed"),this.connectorSDK.receiver.responses.internalServerError("Dummy process failed")(r)):this.connectorSDK.receiver.responses.ok()(r))}}};export{a as ConnectorRunnerDummyNode};
 //# sourceMappingURL=index.js.map

package/libs/connector-runtime-sdk/src/lib/sdk/files.sdk.interface.d.ts

@@ -0,0 +1,18 @@
+export interface FileInfo {
+    type: 'DIRECTORY' | 'FILE';
+    name: string;
+    size: number;
+    modifyTime: Date;
+}
+export interface FileHandleInterface {
+    get(): Buffer;
+    close(): boolean;
+}
+export interface FilesSDKInterface {
+    list(path: string): Promise<Array<FileInfo>>;
+    read(filePath: string): Promise<FileHandleInterface>;
+    write(filePath: string, data: FileHandleInterface | Buffer | string): Promise<boolean>;
+    delete(path: string): Promise<boolean>;
+    exists(path: string): Promise<boolean>;
+    pathAsDsn(path: string): string;
+}

package/libs/connector-runtime-sdk/src/lib/sdk/http-client.interface.d.ts

@@ -0,0 +1,46 @@
+export interface HttpConfig {
+    baseUrl?: string;
+    contentType?: string;
+    timeout?: number;
+}
+export type HttpRequestOptions<D = string | object> = {
+    headers?: Record<string, string>;
+    params?: Record<string, string | number | boolean>;
+    data?: D;
+    withCredentials?: boolean;
+};
+export type HttpRequestOptionsFormatter<D = string | object> = (requestOptions: HttpRequestOptions<D>, method: HttpMethod, url: string) => Promise<HttpRequestOptions<D>> | HttpRequestOptions<D>;
+export type HttpErrorResponseCallbackRequest<D = string | object> = {
+    client: HttpClientSDKInterface;
+    method: HttpMethod;
+    url: string;
+    options?: HttpRequestOptions<D>;
+};
+export type HttpErrorResponseCallback<R = unknown, D = string | object> = (error: HttpError, request: HttpErrorResponseCallbackRequest<D>) => HttpClientPromise<R>;
+export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+export type HttpResponseHeader = string | Array<string> | number | boolean | null;
+export type HttpResponse<D = unknown> = {
+    status: number;
+    data: D;
+    headers?: Record<string, HttpResponseHeader>;
+};
+export type HttpError = {
+    status: number;
+    error?: string;
+};
+interface PromiseWithReason<T = unknown, R = unknown> extends Promise<T> {
+    then<TResult1 = T, TResult2 = never>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | undefined | null, onrejected?: ((reason: R) => TResult2 | PromiseLike<TResult2>) | undefined | null): Promise<TResult1 | TResult2>;
+    catch<TResult = never>(onrejected?: ((reason: R) => TResult | PromiseLike<TResult>) | undefined | null): Promise<T | TResult>;
+}
+export type HttpClientPromise<T> = PromiseWithReason<HttpResponse<T>, HttpError>;
+export interface HttpClientSDKInterface {
+    get<R = unknown>(destination: string, options?: HttpRequestOptions): HttpClientPromise<R>;
+    post<R = unknown, D = string | object>(destination: string, data: D, options?: HttpRequestOptions<D>): HttpClientPromise<R>;
+    put<R = unknown, D = string | object>(destination: string, data: D, options?: HttpRequestOptions<D>): HttpClientPromise<R>;
+    patch<R = unknown, D = string | object>(destination: string, data: D, options?: HttpRequestOptions<D>): HttpClientPromise<R>;
+    delete<R = unknown>(destination: string, options?: HttpRequestOptions): HttpClientPromise<R>;
+    request<R = unknown, D = string | object>(method: HttpMethod, url: string, options?: HttpRequestOptions<D>): HttpClientPromise<R>;
+    setRequestOptionsFormatter<D = string | object>(formatter: HttpRequestOptionsFormatter<D>): HttpClientSDKInterface;
+    setErrorResponseHandler<R = unknown, D = string | object>(callback?: HttpErrorResponseCallback<R, D>): HttpClientSDKInterface;
+}
+export {};

package/libs/connector-runtime-sdk/src/lib/sdk/index.d.ts

@@ -1,7 +1,10 @@
 export * from './sdk.interface';
+export * from './http-client.interface';
 export * from './logger.sdk.interface';
 export * from './offset-store.sdk.interface';
 export * from './processing.sdk.interface';
 export * from './receiver.sdk.interface';
 export * from './sender.sdk.interface';
+export * from './telemetry.sdk.interface';
 export * from './templating.sdk.interface';
+export * from './files.sdk.interface';

package/libs/connector-runtime-sdk/src/lib/sdk/offset-store.sdk.interface.d.ts

@@ -4,6 +4,7 @@ export interface StoredOffset {
     isoDate?: string;
     date?: string;
     rawTimestamp?: number | string;
+    [key: string]: string | number | undefined;
 }
 export interface OffsetStoreSDKInterface {
     getOffset(identifier: string): Promise<StoredOffset>;

package/libs/connector-runtime-sdk/src/lib/sdk/processing.sdk.interface.d.ts

@@ -1,5 +1,6 @@
 export interface IntervalHandler {
     name?: string;
+    onInit?: () => Promise<void> | void;
     onRun: () => Promise<void> | void;
     onStop?: () => Promise<void> | void;
 }

package/libs/connector-runtime-sdk/src/lib/sdk/sdk.interface.d.ts

@@ -1,9 +1,12 @@
 import { BaseConnectorConfig } from '@xip-online-data/types';
+import { FilesSDKInterface } from './files.sdk.interface';
+import { HttpClientSDKInterface, HttpConfig } from './http-client.interface';
 import { LoggerSDKInterface } from './logger.sdk.interface';
 import { OffsetStoreSDKInterface } from './offset-store.sdk.interface';
 import { ProcessingSDKInterface } from './processing.sdk.interface';
 import { ReceiverSDKInterface } from './receiver.sdk.interface';
 import { SenderSDKInterface } from './sender.sdk.interface';
+import { TelemetrySDKInterface } from './telemetry.sdk.interface';
 import { TemplatingSDKInterface } from './templating.sdk.interface';
 export interface ConnectorSDKInterface<T = BaseConnectorConfig> {
     get config(): T;
@@ -11,6 +14,18 @@ export interface ConnectorSDKInterface<T = BaseConnectorConfig> {
     get sender(): SenderSDKInterface;
     get receiver(): ReceiverSDKInterface;
     get templating(): TemplatingSDKInterface;
+    /**
+     * Service to schedule and manage processing tasks that need monitoring and retries.
+     */
     get processing(): ProcessingSDKInterface;
     get offsetStore(): OffsetStoreSDKInterface;
+    /**
+     * Ability to send telemetry data such as gauges and increments on how the connector is performing.
+     */
+    get telemetry(): TelemetrySDKInterface;
+    /**
+     * Get file service instance to access files using a specified DSN. If no DSN is provided, defaults to local file system tmp dir.
+     */
+    files(dsn?: string): FilesSDKInterface;
+    httpClient(httpConfig?: HttpConfig): HttpClientSDKInterface;
 }

package/libs/connector-runtime-sdk/src/lib/sdk/sender.sdk.interface.d.ts

@@ -17,6 +17,6 @@ export type Result = boolean | {
 };
 export interface SenderSDKInterface {
     metrics(metrics: Array<Metric>, metadata?: Metadata, context?: Context): Promise<Result>;
-    metricsLegacy(metrics: Array<never>, metadata?: Metadata, context?: Context): Promise<Result>;
-    documents(metrics: Array<object>, metadata?: Metadata, context?: Context): Promise<Result>;
+    metricsLegacy<T = never>(metrics: Array<T>, metadata?: Metadata, context?: Context): Promise<Result>;
+    documents<T = object>(documents: Array<T>, metadata?: Metadata, context?: Context): Promise<Result>;
 }

package/libs/connector-runtime-sdk/src/lib/sdk/telemetry.sdk.interface.d.ts

@@ -0,0 +1,15 @@
+export interface TelemetrySDKInterface {
+    /**
+     * Increment a telemetry counter by 1.
+     */
+    increment(key: string): void;
+    /**
+     * Increment a telemetry counter by a specified value. 0 doesn't send any telemetry.
+     * A negative value will decrement the counter.
+     */
+    increment(key: string, value: number): void;
+    /**
+     * Send a gauge telemetry metric.
+     */
+    gauge(key: string, value: number): void;
+}

package/libs/types/src/lib/http-status-codes.enum.d.ts

@@ -59,5 +59,6 @@ export declare enum HttpStatusCode {
     InsufficientStorage = 507,
     LoopDetected = 508,
     NotExtended = 510,
-    NetworkAuthenticationRequired = 511
+    NetworkAuthenticationRequired = 511,
+    Aborted = 512
 }

package/libs/types/src/lib/management-api/connector/connector.interface.d.ts

@@ -4,10 +4,10 @@ import { ConnectorOrigin } from '../type-enums';
 import { ActionInterface } from '../workflow';
 export declare const ConnectorSchema: z.ZodObject<{
     identifier: z.ZodString;
-    connectorType: z.ZodNativeEnum<typeof ConfiguredConnectorTypes>;
+    connectorType: z.ZodEnum<typeof ConfiguredConnectorTypes>;
     name: z.ZodString;
     location: z.ZodString;
-    config: z.ZodRecord<z.ZodString, z.ZodAny>;
+    config: z.ZodObject<{}, z.core.$loose>;
     enabled: z.ZodBoolean;
     actions: z.ZodOptional<z.ZodArray<z.ZodObject<{
         identifier: z.ZodString;
@@ -17,112 +17,24 @@ export declare const ConnectorSchema: z.ZodObject<{
         config: z.ZodRecord<z.ZodString, z.ZodAny>;
         inputParameters: z.ZodArray<z.ZodObject<{
             name: z.ZodString;
-            type: z.ZodEnum<["string", "number", "boolean", "array"]>;
+            description: z.ZodOptional<z.ZodString>;
+            type: z.ZodEnum<{
+                string: "string";
+                number: "number";
+                boolean: "boolean";
+                array: "array";
+            }>;
             required: z.ZodOptional<z.ZodBoolean>;
-            items: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
-        }, "strip", z.ZodTypeAny, {
-            type: "string" | "number" | "boolean" | "array";
-            name: string;
-            required?: boolean | undefined;
-            items?: any[] | undefined;
-        }, {
-            type: "string" | "number" | "boolean" | "array";
-            name: string;
-            required?: boolean | undefined;
-            items?: any[] | undefined;
-        }>, "many">;
+            items: z.ZodOptional<z.ZodArray<z.ZodAny>>;
+        }, z.core.$strip>>;
         outputParameters: z.ZodAny;
-        mode: z.ZodOptional<z.ZodNativeEnum<typeof ConnectorOrigin>>;
+        mode: z.ZodOptional<z.ZodEnum<typeof ConnectorOrigin>>;
         createdAt: z.ZodOptional<z.ZodDate>;
         updatedAt: z.ZodOptional<z.ZodDate>;
-    }, "strip", z.ZodTypeAny, {
-        identifier: string;
-        version: string;
-        name: string;
-        config: Record<string, any>;
-        inputParameters: {
-            type: "string" | "number" | "boolean" | "array";
-            name: string;
-            required?: boolean | undefined;
-            items?: any[] | undefined;
-        }[];
-        mode?: ConnectorOrigin | undefined;
-        createdAt?: Date | undefined;
-        description?: string | undefined;
-        outputParameters?: any;
-        updatedAt?: Date | undefined;
-    }, {
-        identifier: string;
-        version: string;
-        name: string;
-        config: Record<string, any>;
-        inputParameters: {
-            type: "string" | "number" | "boolean" | "array";
-            name: string;
-            required?: boolean | undefined;
-            items?: any[] | undefined;
-        }[];
-        mode?: ConnectorOrigin | undefined;
-        createdAt?: Date | undefined;
-        description?: string | undefined;
-        outputParameters?: any;
-        updatedAt?: Date | undefined;
-    }>, "many">>;
+    }, z.core.$strip>>>;
     createdAt: z.ZodOptional<z.ZodDate>;
     updatedAt: z.ZodOptional<z.ZodDate>;
-}, "strip", z.ZodTypeAny, {
-    identifier: string;
-    name: string;
-    config: Record<string, any>;
-    connectorType: ConfiguredConnectorTypes;
-    location: string;
-    enabled: boolean;
-    createdAt?: Date | undefined;
-    updatedAt?: Date | undefined;
-    actions?: {
-        identifier: string;
-        version: string;
-        name: string;
-        config: Record<string, any>;
-        inputParameters: {
-            type: "string" | "number" | "boolean" | "array";
-            name: string;
-            required?: boolean | undefined;
-            items?: any[] | undefined;
-        }[];
-        mode?: ConnectorOrigin | undefined;
-        createdAt?: Date | undefined;
-        description?: string | undefined;
-        outputParameters?: any;
-        updatedAt?: Date | undefined;
-    }[] | undefined;
-}, {
-    identifier: string;
-    name: string;
-    config: Record<string, any>;
-    connectorType: ConfiguredConnectorTypes;
-    location: string;
-    enabled: boolean;
-    createdAt?: Date | undefined;
-    updatedAt?: Date | undefined;
-    actions?: {
-        identifier: string;
-        version: string;
-        name: string;
-        config: Record<string, any>;
-        inputParameters: {
-            type: "string" | "number" | "boolean" | "array";
-            name: string;
-            required?: boolean | undefined;
-            items?: any[] | undefined;
-        }[];
-        mode?: ConnectorOrigin | undefined;
-        createdAt?: Date | undefined;
-        description?: string | undefined;
-        outputParameters?: any;
-        updatedAt?: Date | undefined;
-    }[] | undefined;
-}>;
+}, z.core.$strip>;
 export interface ConnectorInterface<T = Partial<BaseConnectorConfig>> {
     identifier: string;
     connectorType: ConfiguredConnectorTypes;

package/libs/types/src/lib/management-api/connector/connectors.interface.d.ts

@@ -2,10 +2,10 @@ import { z } from 'zod';
 import { ConnectorInterface } from '../index';
 export declare const ConnectorsSchema: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodObject<{
     identifier: z.ZodString;
-    connectorType: z.ZodNativeEnum<typeof import("../../types").ConfiguredConnectorTypes>;
+    connectorType: z.ZodEnum<typeof import("../../types").ConfiguredConnectorTypes>;
     name: z.ZodString;
     location: z.ZodString;
-    config: z.ZodRecord<z.ZodString, z.ZodAny>;
+    config: z.ZodObject<{}, z.core.$loose>;
     enabled: z.ZodBoolean;
     actions: z.ZodOptional<z.ZodArray<z.ZodObject<{
         identifier: z.ZodString;
@@ -15,112 +15,24 @@ export declare const ConnectorsSchema: z.ZodRecord<z.ZodString, z.ZodUnion<[z.Zo
         config: z.ZodRecord<z.ZodString, z.ZodAny>;
         inputParameters: z.ZodArray<z.ZodObject<{
             name: z.ZodString;
-            type: z.ZodEnum<["string", "number", "boolean", "array"]>;
+            description: z.ZodOptional<z.ZodString>;
+            type: z.ZodEnum<{
+                string: "string";
+                number: "number";
+                boolean: "boolean";
+                array: "array";
+            }>;
             required: z.ZodOptional<z.ZodBoolean>;
-            items: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
-        }, "strip", z.ZodTypeAny, {
-            type: "string" | "number" | "boolean" | "array";
-            name: string;
-            required?: boolean | undefined;
-            items?: any[] | undefined;
-        }, {
-            type: "string" | "number" | "boolean" | "array";
-            name: string;
-            required?: boolean | undefined;
-            items?: any[] | undefined;
-        }>, "many">;
+            items: z.ZodOptional<z.ZodArray<z.ZodAny>>;
+        }, z.core.$strip>>;
         outputParameters: z.ZodAny;
-        mode: z.ZodOptional<z.ZodNativeEnum<typeof import("../type-enums").ConnectorOrigin>>;
+        mode: z.ZodOptional<z.ZodEnum<typeof import("../type-enums").ConnectorOrigin>>;
         createdAt: z.ZodOptional<z.ZodDate>;
         updatedAt: z.ZodOptional<z.ZodDate>;
-    }, "strip", z.ZodTypeAny, {
-        identifier: string;
-        version: string;
-        name: string;
-        config: Record<string, any>;
-        inputParameters: {
-            type: "string" | "number" | "boolean" | "array";
-            name: string;
-            required?: boolean | undefined;
-            items?: any[] | undefined;
-        }[];
-        mode?: import("../type-enums").ConnectorOrigin | undefined;
-        createdAt?: Date | undefined;
-        description?: string | undefined;
-        outputParameters?: any;
-        updatedAt?: Date | undefined;
-    }, {
-        identifier: string;
-        version: string;
-        name: string;
-        config: Record<string, any>;
-        inputParameters: {
-            type: "string" | "number" | "boolean" | "array";
-            name: string;
-            required?: boolean | undefined;
-            items?: any[] | undefined;
-        }[];
-        mode?: import("../type-enums").ConnectorOrigin | undefined;
-        createdAt?: Date | undefined;
-        description?: string | undefined;
-        outputParameters?: any;
-        updatedAt?: Date | undefined;
-    }>, "many">>;
+    }, z.core.$strip>>>;
     createdAt: z.ZodOptional<z.ZodDate>;
     updatedAt: z.ZodOptional<z.ZodDate>;
-}, "strip", z.ZodTypeAny, {
-    identifier: string;
-    name: string;
-    config: Record<string, any>;
-    connectorType: import("../../types").ConfiguredConnectorTypes;
-    location: string;
-    enabled: boolean;
-    createdAt?: Date | undefined;
-    updatedAt?: Date | undefined;
-    actions?: {
-        identifier: string;
-        version: string;
-        name: string;
-        config: Record<string, any>;
-        inputParameters: {
-            type: "string" | "number" | "boolean" | "array";
-            name: string;
-            required?: boolean | undefined;
-            items?: any[] | undefined;
-        }[];
-        mode?: import("../type-enums").ConnectorOrigin | undefined;
-        createdAt?: Date | undefined;
-        description?: string | undefined;
-        outputParameters?: any;
-        updatedAt?: Date | undefined;
-    }[] | undefined;
-}, {
-    identifier: string;
-    name: string;
-    config: Record<string, any>;
-    connectorType: import("../../types").ConfiguredConnectorTypes;
-    location: string;
-    enabled: boolean;
-    createdAt?: Date | undefined;
-    updatedAt?: Date | undefined;
-    actions?: {
-        identifier: string;
-        version: string;
-        name: string;
-        config: Record<string, any>;
-        inputParameters: {
-            type: "string" | "number" | "boolean" | "array";
-            name: string;
-            required?: boolean | undefined;
-            items?: any[] | undefined;
-        }[];
-        mode?: import("../type-enums").ConnectorOrigin | undefined;
-        createdAt?: Date | undefined;
-        description?: string | undefined;
-        outputParameters?: any;
-        updatedAt?: Date | undefined;
-    }[] | undefined;
-}>, z.ZodBoolean]>>;
+}, z.core.$strip>, z.ZodBoolean]>>;
 export interface ConnectorsInterface {
     [key: string]: ConnectorInterface | boolean;
 }

package/libs/types/src/lib/management-api/dataset/collection.interface.d.ts

@@ -2,14 +2,8 @@ import { z } from 'zod';
 import { FiltersInterface } from './filters.interface';
 export declare const CollectionSchema: z.ZodObject<{
     collection: z.ZodString;
-    filters: z.ZodOptional<z.ZodType<FiltersInterface, z.ZodTypeDef, FiltersInterface>>;
-}, "strip", z.ZodTypeAny, {
-    collection: string;
-    filters?: FiltersInterface | undefined;
-}, {
-    collection: string;
-    filters?: FiltersInterface | undefined;
-}>;
+    filters: z.ZodOptional<z.ZodType<FiltersInterface, unknown, z.core.$ZodTypeInternals<FiltersInterface, unknown>>>;
+}, z.core.$strip>;
 export interface CollectionInterface {
     collection: string;
     filters?: FiltersInterface;