@vornrun/connector-sdk 0.7.0-beta.8 → 0.7.0

package/dist/pack-C3ZJx9d4.d.ts

@@ -1,340 +0,0 @@
-/**
- * Author-facing types for Vorn connectors.
- *
- * A connector written with this SDK runs as an ordinary MCP stdio server, so
- * it is shared as a normal npm package and installed by pointing a Vorn
- * connection at `npx -y <package>`. Nothing about the host app has to change
- * to accept a new connector.
- */
-/** A raw item as the author's code returns it. Only id and title are required. */
-interface ConnectorItem {
-    /** Stable upstream identity. Vorn dedupes on this, so it must not change. */
-    externalId: string | number;
-    title: string;
-    url?: string;
-    description?: string;
-    /** Raw upstream status (`open`, `Active`, `In Progress`, …). */
-    status?: string;
-    labels?: string[];
-    assignee?: string;
-    /**
-     * When the item last changed. Vorn advances its poll cursor from this field,
-     * so it must be monotonic per item and comparable as an ISO 8601 string.
-     * Defaults to poll time when omitted.
-     */
-    updatedAt?: string | Date;
-    /** Extra fields to expose to workflow templates as `{{trigger.item.<key>}}`. */
-    data?: Record<string, unknown>;
-}
-/** A connector item after normalization. This is the exact JSON Vorn sees. */
-interface NormalizedItem extends Record<string, unknown> {
-    externalId: string;
-    title: string;
-    url: string;
-    description: string;
-    status: string;
-    labels: string[];
-    updatedAt: string;
-    assignee?: string;
-}
-/** Declares a value the connector needs at runtime, read from the environment. */
-interface ConnectorConfigField {
-    key: string;
-    label: string;
-    /** Environment variable the value is read from. Defaults to CONSTANT_CASE(key). */
-    env?: string;
-    required?: boolean;
-    /** Secrets are stored encrypted by Vorn and never printed by the CLI. */
-    secret?: boolean;
-    description?: string;
-    default?: string;
-}
-type ConnectorConfig = Record<string, string | undefined>;
-interface PollContext {
-    config: ConnectorConfig;
-    /**
-     * Lower bound the host asked for, when it was able to supply one. Treat it
-     * as a hint: returning older items is safe because Vorn dedupes, but
-     * returning fewer than everything after `since` loses events.
-     */
-    since?: string;
-    /** Opaque cursor previously returned by this trigger, when supplied. */
-    cursor?: string;
-    /** Upper bound on items to return in one page. */
-    limit?: number;
-    /** Injectable clock so tests are deterministic. */
-    now(): string;
-}
-interface PollOutcome {
-    items: ConnectorItem[];
-    nextCursor?: string;
-    hasMore?: boolean;
-}
-/**
- * How the SDK decides which fetched items are new.
- *
- * - `timestamp` — for sources that expose a reliable "last changed" field and
- *   can filter on it. Handles the boundary case where several items share the
- *   newest timestamp, which is the classic source of both duplicates and
- *   silently dropped items.
- * - `lastItem` — for feeds that return newest-first with no dependable
- *   timestamp. The cursor is the newest id already delivered.
- */
-type DedupeStrategy = 'timestamp' | 'lastItem';
-/**
- * What a declarative trigger's `fetch` receives. Deliberately smaller than
- * {@link PollContext}: cursor encoding, ordering, windowing and de-duplication
- * are the SDK's job, so the author only has to answer "what is there now?".
- */
-interface FetchContext {
-    config: ConnectorConfig;
-    /**
-     * With `dedupe: 'timestamp'`, everything changed at or after this instant is
-     * worth returning. Absent on the very first poll. Returning a little too
-     * much is safe — the SDK drops what was already delivered.
-     */
-    since?: string;
-    /**
-     * With `dedupe: 'lastItem'`, the newest id already delivered. Absent on the
-     * very first poll. Return the feed newest-first and the SDK will stop there.
-     */
-    lastItemId?: string;
-    /** Upper bound on items worth returning in one call. */
-    limit?: number;
-    /** Injectable clock so tests are deterministic. */
-    now(): string;
-}
-/**
- * What an upstream state should become when an item is imported as a task.
- *
- * A suggestion, not a rule: it seeds the connection form, and the person
- * setting it up can change it. Without any, everything a connector imports
- * lands as `todo` regardless of whether it was closed a year ago.
- */
-interface StatusSuggestion {
-    /** The value the connector reports in `ConnectorItem.status`. */
-    upstream: string;
-    suggestedLocal: 'todo' | 'in_progress' | 'in_review' | 'done' | 'cancelled';
-}
-/**
- * The workflow to create when a connection is made.
- *
- * A connector that fires on a schedule is useless until something polls it, and
- * expecting every person to build that workflow by hand is how a connection
- * ends up configured and silent. Seeded workflows are ordinary, visible and
- * editable — the schedule is a starting point, not a fixed rule.
- */
-interface DefaultWorkflow {
-    name: string;
-    defaultCronFromMinutes: number;
-}
-interface TriggerBase {
-    /** Event key, e.g. `workItemCreated`. Becomes the `poll_<type>` MCP tool. */
-    type: string;
-    label: string;
-    description?: string;
-    /** Seeds the connection's status mapping; the person setting it up owns it. */
-    statusMapping?: StatusSuggestion[];
-    /** Seeds a polling workflow when a connection is created. */
-    defaultWorkflow?: DefaultWorkflow;
-    /**
-     * Representative items. `vorn-connector check` replays these through the
-     * real dedupe pipeline, so a connector can be verified before anyone has
-     * credentials for it.
-     */
-    sample?: ConnectorItem[];
-}
-/**
- * A trigger is either declarative or hand-written, never both — expressed as a
- * union so the invalid combinations are a type error at authoring time rather
- * than a throw when the connector is first loaded.
- */
-type TriggerDefinition = TriggerBase & ({
-    /**
-     * Declarative polling: return what the source has and let the SDK
-     * handle cursors and de-duplication.
-     */
-    dedupe: DedupeStrategy;
-    fetch(context: FetchContext): Promise<ConnectorItem[]> | ConnectorItem[];
-    poll?: never;
-} | {
-    /**
-     * Full control over cursors and paging. Use only when the source's
-     * paging cannot be expressed as "give me everything since X".
-     */
-    poll(context: PollContext): Promise<PollOutcome> | PollOutcome;
-    dedupe?: never;
-    fetch?: never;
-});
-interface ActionInputField {
-    key: string;
-    label: string;
-    type?: 'string' | 'number' | 'boolean';
-    required?: boolean;
-    description?: string;
-}
-/**
- * A field the action is known to return. Declaring these is optional — extra
- * keys always pass through — but declared fields show up in Vorn's variable
- * autocomplete as `{{steps.<action>.<key>}}`.
- */
-interface ActionOutputField {
-    key: string;
-    type?: 'string' | 'number' | 'boolean';
-    description?: string;
-}
-interface ActionContext {
-    config: ConnectorConfig;
-    now(): string;
-}
-interface ActionDefinition {
-    /** Action key, e.g. `closeWorkItem`. Becomes an MCP tool of the same name. */
-    type: string;
-    label: string;
-    description?: string;
-    /**
-     * Whether repeating the call with the same arguments is safe. Surfaced in
-     * the MCP tool description, because an agent retrying a failed step has no
-     * other way to know whether it is about to create a second issue.
-     */
-    idempotent?: boolean;
-    inputs?: ActionInputField[];
-    outputs?: ActionOutputField[];
-    run(args: Record<string, unknown>, context: ActionContext): Promise<Record<string, unknown> | void> | Record<string, unknown> | void;
-}
-/**
- * A connector's own glyph, so an installed connector is recognizable in a list
- * rather than sharing one generic icon with every other one.
- *
- * Path data only — deliberately not markup. Vorn draws these itself as
- * `<path d="...">` inside an `<svg>` it owns, so a connector cannot inject
- * elements, scripts or external references into the app rendering it.
- */
-interface ConnectorIcon {
-    /** Defaults to `0 0 24 24`. */
-    viewBox?: string;
-    /** SVG path `d` data, drawn with `fill="currentColor"` so it inherits color. */
-    paths: string[];
-}
-/**
- * What a connector reports about its own readiness.
- *
- * `message` is shown to the user verbatim, so it should say what to do rather
- * than what went wrong — "run `gh auth login`" beats "not authenticated".
- */
-interface PreflightResult {
-    ok: boolean;
-    message?: string;
-}
-interface ConnectorDefinition {
-    /** Stable connector id, e.g. `azure-devops`. */
-    id: string;
-    name: string;
-    version?: string;
-    description?: string;
-    icon?: ConnectorIcon;
-    config?: ConnectorConfigField[];
-    triggers?: TriggerDefinition[];
-    actions?: ActionDefinition[];
-    /**
-     * Whether this connector could work right now, asked before anyone waits on
-     * a poll.
-     *
-     * A connector whose credentials come from config fields does not need this:
-     * a missing field is already a visible, nameable error. One that borrows an
-     * external tool's login — `gh auth login`, `az login` — has no field to be
-     * missing, so without this the first sign that the tool is absent or signed
-     * out is a poll failing some minutes after the connection was saved.
-     *
-     * Answer `ok: false` with a message saying what to do about it. Throwing is
-     * equivalent — the server catches it and reports the same shape with the
-     * error's message — so there is one result for a caller to read and no
-     * behaviour riding on which you choose. Prefer returning when the state is
-     * one you recognise, because then you get to write the sentence.
-     *
-     * Absent means there is nothing to check, which is not the same answer as a
-     * check that passed.
-     */
-    preflight?(): Promise<PreflightResult> | PreflightResult;
-}
-/** A validated definition. Every accessor below is guaranteed non-null. */
-interface Connector extends ConnectorDefinition {
-    readonly version: string;
-    readonly config: ConnectorConfigField[];
-    readonly triggers: TriggerDefinition[];
-    readonly actions: ActionDefinition[];
-}
-
-interface CheckFinding {
-    /** `error` means the connector will misbehave in Vorn; `warn` is advisory. */
-    level: 'error' | 'warn';
-    code: string;
-    /** Which part of the connector the finding is about. */
-    target: string;
-    message: string;
-}
-interface CheckOptions {
-    /**
-     * Poll every trigger against the real source. Off by default, so a check
-     * runs on declared `sample` items and the definition alone.
-     */
-    live?: boolean;
-    /** Credentials, required by `live`. */
-    config?: ConnectorConfig;
-    now?: () => string;
-}
-/**
- * Check a connector against the contract Vorn relies on.
- *
- * The point is a feedback loop: a connector — hand-written or generated — can
- * be verified before it is ever installed, catching the failures that are
- * otherwise invisible until duplicate tasks show up in someone's inbox days
- * later.
- */
-declare function checkConnector(connector: Connector, options?: CheckOptions): Promise<CheckFinding[]>;
-/** Render findings for a terminal. Returns an empty string when all clear. */
-declare function formatFindings(findings: CheckFinding[]): string;
-
-/** Largest pack Vorn will install, matched by the server's own verification. */
-declare const MAX_PACK_BYTES: number;
-interface PackOptions {
-    /** Module specifier the connector was loaded from, bundled as the pack entry. */
-    entry: string;
-    /** Directory the `.vorn.tgz` is written to; defaults to the working directory. */
-    outDir?: string;
-    /** Directory module specifiers resolve from; defaults to the working directory. */
-    resolveDir?: string;
-    /** SDK specifier the generated stdio entry imports; overridden in tests. */
-    sdkModule?: string;
-    /** Size ceiling for the written archive; defaults to `MAX_PACK_BYTES`. */
-    maxBytes?: number;
-    /** Replaced in tests so packing does not shell out to a bundler. */
-    bundle?(request: BundleRequest): Promise<BundleOutput>;
-}
-interface BundleRequest {
-    contents: string;
-    resolveDir: string;
-}
-interface BundleOutput {
-    code: string;
-    /** Specifiers the bundler left for the runtime to resolve. */
-    external: string[];
-}
-interface PackResult {
-    findings: CheckFinding[];
-    /** Absolute path of the written pack; absent when a gate failed. */
-    file?: string;
-    bytes?: number;
-}
-/** Reject a source package whose install would run code on the user's machine. */
-declare function lifecycleScriptFindings(pkg: unknown): CheckFinding[];
-/** Specifiers left outside a bundle, which would need a registry at launch. */
-declare function bundleDependencyFindings(external: string[]): CheckFinding[];
-/** Nearest package.json at or above a directory, or undefined when there is none. */
-declare function readNearestPackageJson(fromDir: string): Record<string, unknown> | undefined;
-/** File name Vorn recognizes as a connector pack. */
-declare function packFileName(connector: Connector): string;
-/** The entry is generated, not the author's bin, so every pack launches alike. */
-declare function packConnector(connector: Connector, options: PackOptions): Promise<PackResult>;
-
-export { type ActionContext as A, type BundleRequest as B, type ConnectorDefinition as C, type DefaultWorkflow as D, type FetchContext as F, MAX_PACK_BYTES as M, type NormalizedItem as N, type PollContext as P, type StatusSuggestion as S, type TriggerDefinition as T, type BundleOutput as a, type Connector as b, type ConnectorConfig as c, type PollOutcome as d, type ConnectorItem as e, type ConnectorIcon as f, type ActionDefinition as g, type ActionInputField as h, type CheckFinding as i, type CheckOptions as j, type ConnectorConfigField as k, type DedupeStrategy as l, type PackOptions as m, type PackResult as n, type PreflightResult as o, bundleDependencyFindings as p, checkConnector as q, formatFindings as r, lifecycleScriptFindings as s, packConnector as t, packFileName as u, readNearestPackageJson as v };