@xentom/integration-framework 0.0.0 → 0.0.1

package/dist/controls/base.d.ts

@@ -9,6 +9,8 @@ export interface BaseControl<S = never> {
     description?: string;
     /**
      * The default value used when no user input is provided.
+     *
+     * @remarks `unknown`
      */
     defaultValue?: S;
 }

package/dist/controls/expression.d.ts

@@ -1,6 +1,9 @@
 import { type ControlType } from '.';
 import { type BaseControl } from './base';
 export interface ExpressionControl<S = never> extends BaseControl<S> {
+    /**
+     * @internal
+     */
     type: ControlType.Expression;
     /**
      * Placeholder text displayed when the input is empty.

package/dist/controls/select.d.ts

@@ -2,10 +2,15 @@ import { type ControlType } from '.';
 import { type IntegrationOptions } from '../integration';
 import { type BaseControl } from './base';
 export interface SelectControl<S = never, Options = SelectControlOptions<S> | SelectControlOptionsCallback<S>> extends BaseControl<S> {
+    /**
+     * @internal
+     */
     type: ControlType.Select;
     /**
      * Defines the options available for selection.
      * Can be a static array of options or a callback function that returns options dynamically.
+     *
+     * @remarks `SelectControlOption[] | (opts: IntegrationOptions) => SelectControlOption[]`
      */
     options: Options;
     /**
@@ -18,6 +23,8 @@ export type SelectControlOptionsCallback<S = never> = (opts: IntegrationOptions)
 export interface SelectControlOption<S = never> {
     /**
      * The value associated with the option, which will be used as the pin's value.
+     *
+     * @remarks `unknown`
      */
     value: S;
     /**

package/dist/controls/switch.d.ts

@@ -1,6 +1,9 @@
 import { type ControlType } from '.';
 import { type BaseControl } from './base';
 export interface SwitchControl<S = never> extends BaseControl<S> {
+    /**
+     * @internal
+     */
     type: ControlType.Switch;
 }
 export type SwitchControlBuilder = (definition?: Omit<SwitchControl<boolean>, 'type'>) => SwitchControl<boolean>;

package/dist/controls/text.d.ts

@@ -1,6 +1,9 @@
 import { type ControlType } from '.';
 import { type BaseControl } from './base';
 export interface TextControl<S = string> extends BaseControl<S> {
+    /**
+     * @internal
+     */
     type: ControlType.Text;
     /**
      * Specifies the syntax highlighting language used in the text control, if applicable.

package/dist/env.d.ts

@@ -4,6 +4,8 @@ export interface Env<O = unknown> {
     /**
      * Defines the UI control used to configure the environment variable.
      * Can be a text input, a switch (boolean), or a select dropdown.
+     *
+     * @remarks `TextControl | SwitchControl | SelectControl`
      */
     control: TextControl<string> | SwitchControl<boolean> | SelectControl<string, SelectControlOptions<string>>;
     /**
@@ -17,6 +19,8 @@ export interface Env<O = unknown> {
      * ```ts
      * v.pipe(v.string(), v.startsWith('sk-'))
      * ```
+     *
+     * @remarks `StandardSchemaV1`
      */
     schema?: StandardSchemaV1<string | undefined, O>;
 }

package/dist/integration.d.ts

@@ -16,6 +16,8 @@ export interface Integration<NR extends NodeRecord = NodeRecord, E extends EnvRe
      *   }),
      * },
      * ```
+     *
+     * @remarks `Record<string, Node>`
      */
     nodes: NR;
     /**
@@ -36,6 +38,8 @@ export interface Integration<NR extends NodeRecord = NodeRecord, E extends EnvRe
      *   }),
      * },
      * ```
+     *
+     * @remarks `Record<string, Env>`
      */
     env?: E;
     /**

package/dist/nodes/base.d.ts

@@ -8,6 +8,8 @@ export interface BaseNode<I extends BaseNodeInputs = BaseNodeInputs, O extends B
     /**
      * Category used to organize the node in a hierarchical structure.
      * Helps with grouping and filtering nodes in the UI.
+     *
+     * @remarks `{ path: string[] }`
      */
     category?: NodeCategory;
     /**
@@ -25,11 +27,15 @@ export interface BaseNode<I extends BaseNodeInputs = BaseNodeInputs, O extends B
     /**
      * Defines the input pins for the node.
      * These specify the data required for the node to run.
+     *
+     * @remarks `Record<string, DataPin>`
      */
     inputs?: I;
     /**
      * Defines the output pins for the node.
      * These represent the result or side effects of running the node.
+     *
+     * @remarks `Record<string, DataPin | ExecPin>`
      */
     outputs?: O;
 }

package/dist/nodes/callable.d.ts

@@ -11,12 +11,17 @@ export type CallableNodeOutputs = PinRecord<DataPin | ExecPin>;
  * CallableNode is a type of node that can be called by other nodes.
  */
 export interface CallableNode<I extends CallableNodeInputs = CallableNodeInputs, O extends CallableNodeOutputs = CallableNodeOutputs> extends BaseNode<I, O> {
+    /**
+     * @internal
+     */
     type: NodeType.Callable;
     /**
      * Runs the node with the provided inputs, state, and context.
      * This method is invoked when the node is called by another node.
      *
      * @param opts - Options containing the execution context, state, inputs, variables, webhook, and next callback.
+     *
+     * @remarks `run(opts: CallableNodeRunOptions): Promise<void> | void`
      */
     run(opts: CallableNodeRunOptions<I, O>): void | Promise<void>;
 }
@@ -46,6 +51,8 @@ export interface CallableNodeRunOptions<I extends CallableNodeInputs, O extends
     /**
      * The resolved input values for the node, typically based on user configuration
      * or outputs from preceding nodes in the workflow.
+     *
+     * @remarks `Record<string, unknown>`
      */
     inputs: InferPinRecordOutput<I>;
     /**
@@ -58,6 +65,8 @@ export interface CallableNodeRunOptions<I extends CallableNodeInputs, O extends
     /**
      * Webhook utility exposing the integration's public URL.
      * Can be shared with external systems to send data back into the workflow.
+     *
+     * @remarks `{ url: string }`
      */
     webhook: Pick<Webhook, 'url'>;
     /**
@@ -80,6 +89,8 @@ export interface CallableNodeRunOptions<I extends CallableNodeInputs, O extends
      *   value: Math.random(),
      * });
      * ```
+     *
+     * @remarks `NodeNextCallback`
      */
     next: NodeNextCallback<O>;
 }

package/dist/nodes/pure.d.ts

@@ -11,10 +11,7 @@ export type PureNodeOutputs = PinRecord<DataPin>;
  */
 export interface PureNode<I extends PureNodeInputs = PureNodeInputs, O extends PureNodeOutputs = PureNodeOutputs> extends BaseNode<I, O> {
     /**
-     * Identifies the node as a pure node.
-     * Pure nodes do not mutate any external or internal state and produce outputs solely based on their inputs.
-     * They cannot be triggered directly or independently, they must be connected to an input pin.
-     * The `run` function is executed automatically when the node is required as part of a data flow.
+     * @internal
      */
     type: NodeType.Pure;
     /**
@@ -28,6 +25,8 @@ export interface PureNode<I extends PureNodeInputs = PureNodeInputs, O extends P
      *   opts.outputs.result = opts.inputs.a + opts.inputs.b;
      * }
      * ```
+     *
+     * @remarks `run(opts: PureNodeRunOptions): Promise<void> | void`
      */
     run?(opts: PureNodeRunOptions<I, O>): Promise<void> | void;
 }
@@ -54,11 +53,15 @@ export interface PureNodeRunOptions<I extends PureNodeInputs = PureNodeInputs, O
     /**
      * The resolved input values for the node, typically based on user configuration
      * or outputs from preceding steps in the workflow.
+     *
+     * @remarks `Record<string, unknown>`
      */
     inputs: InferPinRecordOutput<I>;
     /**
      * The object used to assign output values from the node.
      * Each output pin should be populated within the `run` function to pass values forward in the workflow.
+     *
+     * @remarks `Record<string, unknown>`
      */
     outputs: InferPinRecordInput<O>;
     /**
@@ -71,6 +74,8 @@ export interface PureNodeRunOptions<I extends PureNodeInputs = PureNodeInputs, O
     /**
      * Webhook utility exposing the integration's public URL.
      * Can be shared with external systems to send data back into the workflow.
+     *
+     * @remarks `{ url: string }`
      */
     webhook: Pick<Webhook, 'url'>;
 }

package/dist/nodes/trigger.d.ts

@@ -10,6 +10,9 @@ import { type NodeType } from './index';
 export type TriggerNodeInputs = PinRecord<DataPin>;
 export type TriggerNodeOutputs = PinRecord<DataPin | ExecPin>;
 export interface TriggerNode<I extends TriggerNodeInputs = TriggerNodeInputs, O extends TriggerNodeOutputs = TriggerNodeOutputs> extends BaseNode<I, O> {
+    /**
+     * @internal
+     */
     type: NodeType.Trigger;
     /**
      * Registers a callback to subscribe to internal or external events.
@@ -62,6 +65,8 @@ export interface TriggerNode<I extends TriggerNodeInputs = TriggerNodeInputs, O
      *   };
      * }
      * ```
+     *
+     * @remarks `subscribe(opts: TriggerSubscribeOptions): () => void`
      */
     subscribe(opts: TriggerSubscribeOptions<I, O>): TriggerSubscribeCleanup;
 }
@@ -88,6 +93,8 @@ export interface TriggerSubscribeOptions<I extends TriggerNodeInputs, O extends
     /**
      * The resolved input values for the trigger, typically based on user configuration
      * or outputs from preceding steps in the workflow.
+     *
+     * @remarks `Record<string, unknown>`
      */
     inputs: InferPinRecordOutput<I>;
     /**
@@ -117,6 +124,8 @@ export interface TriggerSubscribeOptions<I extends TriggerNodeInputs, O extends
      *   value: Math.random(),
      * });
      * ```
+     *
+     * @remarks `NodeNextCallback`
      */
     next: NodeNextCallback<O, [ctx?: TriggerRunContext]>;
 }

package/dist/pins/data.d.ts

@@ -5,6 +5,9 @@ import { type IntegrationOptions } from '../integration';
 import { type ConditionalOptional } from '../utils';
 import { type BasePin } from './base';
 export interface DataPin<Input = any, Output = Input, Optional extends boolean = boolean> extends BasePin {
+    /**
+     * @internal
+     */
     type: PinType.Data;
     /**
      * Validation schema compatible with the Standard Schema specification.
@@ -18,6 +21,8 @@ export interface DataPin<Input = any, Output = Input, Optional extends boolean =
      * ```ts
      * v.pipe(v.string(), v.trim())
      * ```
+     *
+     * @remarks `StandardSchemaV1 | (opts: IntegrationOptions) => StandardSchemaV1`
      */
     schema?: StandardSchemaV1<Input, Output> | ((opts: IntegrationOptions) => StandardSchemaV1<Input, Output>);
     /**
@@ -30,6 +35,8 @@ export interface DataPin<Input = any, Output = Input, Optional extends boolean =
      *   label: 'Message',
      * })
      * ```
+     *
+     * @remarks `Control | false`
      */
     control?: false | Control<ConditionalOptional<Optional, Input & {}>>;
     /**
@@ -56,6 +63,8 @@ export interface DataPin<Input = any, Output = Input, Optional extends boolean =
      *   },
      * ]
      * ```
+     *
+     * @remarks `DataPinExample[]`
      */
     examples?: DataPinExample<ConditionalOptional<Optional, Input & {}>>[];
     /**
@@ -67,6 +76,8 @@ export interface DataPin<Input = any, Output = Input, Optional extends boolean =
      * ```ts
      * optional: true,
      * ```
+     *
+     * @remarks `boolean`
      */
     optional?: Optional;
 }
@@ -78,6 +89,8 @@ export interface DataPinExample<I> {
     /**
      * The value of the example, which can be any valid input type for the pin.
      * This value is used to illustrate how the pin can be utilized in practice.
+     *
+     * @remarks `unknown`
      */
     value: I;
 }
@@ -90,6 +103,9 @@ export type DataPinBuilder<ParentInput = any, ParentOutput = ParentInput, Parent
      * i.pins.data().with({
      *   description: 'A message to send',
      * })
+     * ```
+     *
+     * @remarks `DataPinBuilder`
      */
     with: DataPinBuilder<Input, Output, Optional>;
 }>;

package/dist/pins/exec.d.ts

@@ -2,6 +2,9 @@ import { type PinRecord, type PinType } from '.';
 import { type BasePin } from './base';
 import { type DataPin } from './data';
 export interface ExecPin<PR extends PinRecord<DataPin> = PinRecord<DataPin>> extends BasePin {
+    /**
+     * @internal
+     */
     type: PinType.Exec;
     /**
      * Optional outputs for the exec pin, defined as a set of named data pins.
@@ -44,6 +47,8 @@ export interface ExecPin<PR extends PinRecord<DataPin> = PinRecord<DataPin>> ext
      *   },
      * });
      * ```
+     *
+     * @remarks `Record<string, DataPin>`
      */
     outputs?: PR;
 }
@@ -56,6 +61,9 @@ export type ExecPinBuilder<ParentPR extends PinRecord<DataPin> = PinRecord<DataP
      * i.pins.exec().with({
      *   description: 'A message to send',
      * })
+     * ```
+     *
+     * @remarks `ExecPinBuilder`
      */
     with: ExecPinBuilder<PR>;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xentom/integration-framework",
-  "version": "0.0.0",
+  "version": "0.0.1",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -25,10 +25,11 @@
     "@standard-schema/spec": "^1.0.0"
   },
   "devDependencies": {
-    "@xentom/style-guide": "0.0.0",
-    "eslint": "^9.31.0",
+    "@types/bun": "^1.2.19",
+    "@xentom/style-guide": "^0.0.0",
+    "eslint": "^9.32.0",
     "prettier": "^3.6.2",
-    "typescript": "^5.8.3"
+    "typescript": "^5.9.2"
   },
   "prettier": "@xentom/style-guide/prettier"
 }