@octonodes/sdk 0.2.13 → 0.2.26

package/dist/plugins/sdk/types.d.ts

@@ -0,0 +1,115 @@
+import type { InvocationContext, IconValue, PluginManifest, PluginManifestInput, PluginNode, OkResult, ErrorResult, ManifestResult, ManifestError } from "../schema/plugin-sdk";
+export type JsonSchema = Record<string, unknown>;
+export interface ValidationError {
+    path: string;
+    message: string;
+}
+/**
+ * What a node IS. `function` (default) is a data-flow node with inputs/outputs.
+ * `class`/`service`/`const` are setup-time entities with no runtime I/O ports —
+ * they're depended on by function nodes rather than feeding data into them.
+ */
+export type NodeKind = "function" | "class" | "service" | "const";
+/**
+ * The signature a node author writes: a plain (optionally async) function from
+ * a JSON `inputs` payload to a JSON `outputs` payload. The second argument is
+ * the invocation context (config, env, attempt, …). Nodes never touch stdin,
+ * stdout, or the envelope — the runner harness owns the wire.
+ */
+export type NodeHandler<I = unknown, O = unknown> = (inputs: I, context: InvocationContext) => O | Promise<O>;
+export interface NodeDefinition<I = unknown, O = unknown> {
+    /** Stable node id — the discovery key used by `octonode scan`. */
+    id: string;
+    workflowId?: string;
+    label?: string;
+    description?: string;
+    symbol?: string;
+    defaults?: Record<string, unknown>;
+    run(inputs: I, context: InvocationContext): O | Promise<O>;
+    /** JSON Schema for the inputs payload. Validated by the runner before `run`. */
+    inputs?: JsonSchema;
+    /** JSON Schema for the outputs payload. Validated by the runner after `run`. */
+    outputs?: JsonSchema;
+    /** What this node is. Omitted → `function`. */
+    kind?: NodeKind;
+    /** Setup params (constructor/config shape) for non-`function` kinds. */
+    setup?: JsonSchema;
+    /** Advisory default icon (a one-time seed; `.octonode` owns it thereafter). */
+    icon?: IconValue;
+    /** Advisory default config (a one-time seed; `.octonode` owns it thereafter). */
+    config?: Record<string, unknown>;
+}
+export interface DefineNodeArgs<I, O> {
+    id?: string;
+    workflowId?: string;
+    label?: string;
+    description?: string;
+    symbol?: string;
+    defaults?: Record<string, unknown>;
+    run: NodeHandler<I, O>;
+    inputs?: JsonSchema;
+    outputs?: JsonSchema;
+    kind?: NodeKind;
+    setup?: JsonSchema;
+    icon?: IconValue;
+    config?: Record<string, unknown>;
+}
+/** Args for the setup-time helpers. These entities have setup params, not I/O ports. */
+export interface DefineSetupArgs<I = unknown, O = unknown> {
+    id: string;
+    /** JSON Schema for the setup/constructor params — rendered as a form in the editor. */
+    setup?: JsonSchema;
+    /**
+     * How the entity materializes at runtime (instantiate a client, read config…).
+     * Optional: setup-time entities aren't part of the data DAG, so a missing run
+     * defaults to a no-op that echoes the resolved setup config.
+     */
+    run?: NodeHandler<I, O>;
+    icon?: IconValue;
+    config?: Record<string, unknown>;
+}
+export interface ServiceMethodSpec {
+    /** Object input keys mapped to positional class-method arguments. */
+    params?: string[];
+    inputs?: JsonSchema;
+    outputs?: JsonSchema;
+}
+export interface DefineExplicitServiceArgs<T extends object> {
+    id: string;
+    /** Explicit class identity for container-resolved or indirect factories; never constructed by discovery. */
+    class?: abstract new (...args: never[]) => T;
+    create: (context: InvocationContext) => T | Promise<T>;
+    /** Close owned resources when an invocation or service worker ends. */
+    dispose?: (instance: T) => void | Promise<void>;
+    expose: readonly (keyof T & string)[] | Record<string, ServiceMethodSpec>;
+    lifecycle?: "invocation" | "workflow-run" | "worker";
+    icon?: IconValue;
+    setup?: JsonSchema;
+    config?: Record<string, unknown>;
+}
+export interface ServiceDefinition<T extends object = object> extends NodeDefinition {
+    kind: "service";
+    service: {
+        create: (context: InvocationContext) => T | Promise<T>;
+        dispose?: (instance: T) => void | Promise<void>;
+        lifecycle: "invocation" | "workflow-run" | "worker";
+        methods: Record<string, ServiceMethodSpec>;
+    };
+}
+export type SetupNodeDefinition<I, O> = NodeDefinition<I, O | Record<string, unknown>>;
+export type Envelope = OkResult | ErrorResult | ManifestResult | ManifestError;
+export interface NodeErrorOptions {
+    retryable?: boolean;
+}
+export interface PluginDefinition {
+    manifest: PluginManifest;
+    nodes: Record<string, NodeDefinition>;
+    /** Project-relative assets copied into the built plugin. Never credential files. */
+    assets?: readonly string[];
+}
+export type PluginHandlers = Record<string, NodeDefinition["run"]>;
+export type PluginOptions = Omit<PluginManifestInput, "nodes"> & {
+    nodes: readonly (NodeDefinition & Pick<PluginNode, "connections" | "env" | "trigger">)[];
+    assets?: readonly string[];
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/plugins/sdk/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/plugins/sdk/types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,iBAAiB,EACjB,SAAS,EACT,cAAc,EACd,mBAAmB,EACnB,UAAU,EACV,QAAQ,EACR,WAAW,EACX,cAAc,EACd,aAAa,EACd,MAAM,sBAAsB,CAAC;AAE9B,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEjD,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;GAIG;AACH,MAAM,MAAM,QAAQ,GAAG,UAAU,GAAG,OAAO,GAAG,SAAS,GAAG,OAAO,CAAC;AAElE;;;;;GAKG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,iBAAiB,KAAK,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AAE9G,MAAM,WAAW,cAAc,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,OAAO;IACtD,kEAAkE;IAClE,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,iBAAiB,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3D,gFAAgF;IAChF,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,gFAAgF;IAChF,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,+CAA+C;IAC/C,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,wEAAwE;IACxE,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB,+EAA+E;IAC/E,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,iFAAiF;IACjF,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC;AAED,MAAM,WAAW,cAAc,CAAC,CAAC,EAAE,CAAC;IAClC,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,GAAG,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACvB,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC;AAED,wFAAwF;AACxF,MAAM,WAAW,eAAe,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,OAAO;IACvD,EAAE,EAAE,MAAM,CAAC;IACX,uFAAuF;IACvF,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB;;;;OAIG;IACH,GAAG,CAAC,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACxB,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC;AAED,MAAM,WAAW,iBAAiB;IAChC,qEAAqE;IACrE,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,OAAO,CAAC,EAAE,UAAU,CAAC;CACtB;AAED,MAAM,WAAW,yBAAyB,CAAC,CAAC,SAAS,MAAM;IACzD,EAAE,EAAE,MAAM,CAAC;IACX,4GAA4G;IAC5G,KAAK,CAAC,EAAE,QAAQ,MAAM,GAAG,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IAC7C,MAAM,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IACvD,uEAAuE;IACvE,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAChD,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IAC1E,SAAS,CAAC,EAAE,YAAY,GAAG,cAAc,GAAG,QAAQ,CAAC;IACrD,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC;AAED,MAAM,WAAW,iBAAiB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,cAAc;IAClF,IAAI,EAAE,SAAS,CAAC;IAChB,OAAO,EAAE;QACP,MAAM,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;QACvD,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAChD,SAAS,EAAE,YAAY,GAAG,cAAc,GAAG,QAAQ,CAAC;QACpD,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;KAC5C,CAAC;CACH;AAED,MAAM,MAAM,mBAAmB,CAAC,CAAC,EAAE,CAAC,IAAI,cAAc,CAAC,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;AAEvF,MAAM,MAAM,QAAQ,GAAG,QAAQ,GAAG,WAAW,GAAG,cAAc,GAAG,aAAa,CAAC;AAE/E,MAAM,WAAW,gBAAgB;IAC/B,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,cAAc,CAAC;IACzB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IACtC,oFAAoF;IACpF,MAAM,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CAC5B;AAED,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;AAEnE,MAAM,MAAM,aAAa,GAAG,IAAI,CAAC,mBAAmB,EAAE,OAAO,CAAC,GAAG;IAC/D,KAAK,EAAE,SAAS,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,EAAE,aAAa,GAAG,KAAK,GAAG,SAAS,CAAC,CAAC,EAAE,CAAC;IACzF,MAAM,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CAC5B,CAAC"}

package/dist/plugins/sdk/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/plugins/sdk/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/plugins/sdk/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@octonodes/sdk",
-  "version": "0.2.13",
+  "version": "0.2.26",
   "description": "Octonode API client and code-first plugin SDK.",
   "license": "MIT",
   "repository": {