@anchrd/colab-sdk 0.0.0-stage → 0.1.0

package/dist/connectors/connectors.d.ts

@@ -0,0 +1,148 @@
+import { z } from "zod";
+export declare const ConnectorId: z.ZodString;
+export type ConnectorId = z.infer<typeof ConnectorId>;
+export declare const CallId: z.ZodTemplateLiteral<`call_${string}`>;
+export declare const ConnectorListInput: z.ZodObject<{
+    cursor: z.ZodOptional<z.ZodString>;
+    limit: z.ZodOptional<z.ZodCoercedNumber<unknown>>;
+}, z.core.$strict>;
+export type ConnectorListInput = z.infer<typeof ConnectorListInput>;
+export declare const ConnectorGetInput: z.ZodObject<{
+    connectorId: z.ZodString;
+}, z.core.$strict>;
+export type ConnectorGetInput = z.infer<typeof ConnectorGetInput>;
+export declare const ConnectorField: z.ZodObject<{
+    name: z.ZodString;
+    label: z.ZodString;
+    help: z.ZodOptional<z.ZodString>;
+    placeholder: z.ZodOptional<z.ZodString>;
+    optional: z.ZodBoolean;
+    kind: z.ZodEnum<{
+        secret: "secret";
+        setting: "setting";
+    }>;
+}, z.core.$strict>;
+export type ConnectorField = z.infer<typeof ConnectorField>;
+export declare const ConnectorTool: z.ZodObject<{
+    function: z.ZodString;
+    description: z.ZodString;
+    writes: z.ZodBoolean;
+}, z.core.$strict>;
+export type ConnectorTool = z.infer<typeof ConnectorTool>;
+export declare const Connector: z.ZodObject<{
+    connectorId: z.ZodString;
+    name: z.ZodString;
+    category: z.ZodString;
+    description: z.ZodString;
+    icon: z.ZodString;
+    catalog: z.ZodBoolean;
+    tools: z.ZodArray<z.ZodObject<{
+        function: z.ZodString;
+        description: z.ZodString;
+        writes: z.ZodBoolean;
+    }, z.core.$strict>>;
+    fields: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        label: z.ZodString;
+        help: z.ZodOptional<z.ZodString>;
+        placeholder: z.ZodOptional<z.ZodString>;
+        optional: z.ZodBoolean;
+        kind: z.ZodEnum<{
+            secret: "secret";
+            setting: "setting";
+        }>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type Connector = z.infer<typeof Connector>;
+export declare const ConnectorList: z.ZodObject<{
+    items: z.ZodArray<z.ZodObject<{
+        connectorId: z.ZodString;
+        name: z.ZodString;
+        category: z.ZodString;
+        description: z.ZodString;
+        icon: z.ZodString;
+        catalog: z.ZodBoolean;
+        tools: z.ZodArray<z.ZodObject<{
+            function: z.ZodString;
+            description: z.ZodString;
+            writes: z.ZodBoolean;
+        }, z.core.$strict>>;
+        fields: z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            label: z.ZodString;
+            help: z.ZodOptional<z.ZodString>;
+            placeholder: z.ZodOptional<z.ZodString>;
+            optional: z.ZodBoolean;
+            kind: z.ZodEnum<{
+                secret: "secret";
+                setting: "setting";
+            }>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+    nextCursor: z.ZodNullable<z.ZodString>;
+}, z.core.$strict>;
+export type ConnectorList = z.infer<typeof ConnectorList>;
+export declare const CallSource: z.ZodEnum<{
+    schedule: "schedule";
+    mcp: "mcp";
+    api: "api";
+}>;
+export type CallSource = z.infer<typeof CallSource>;
+export declare const CallListInput: z.ZodObject<{
+    connectorId: z.ZodString;
+    failed: z.ZodOptional<z.ZodPreprocess<z.ZodBoolean, unknown>>;
+    cursor: z.ZodOptional<z.ZodTemplateLiteral<`call_${string}`>>;
+    limit: z.ZodOptional<z.ZodCoercedNumber<unknown>>;
+}, z.core.$strict>;
+export type CallListInput = z.infer<typeof CallListInput>;
+export declare const Call: z.ZodObject<{
+    callId: z.ZodTemplateLiteral<`call_${string}`>;
+    connectorId: z.ZodString;
+    function: z.ZodString;
+    source: z.ZodEnum<{
+        schedule: "schedule";
+        mcp: "mcp";
+        api: "api";
+    }>;
+    status: z.ZodNullable<z.ZodNumber>;
+    failed: z.ZodBoolean;
+    durationMs: z.ZodNumber;
+    createdAt: z.ZodISODateTime;
+    actor: z.ZodNullable<z.ZodObject<{
+        userId: z.ZodString;
+        name: z.ZodNullable<z.ZodString>;
+        kind: z.ZodNullable<z.ZodEnum<{
+            machine: "machine";
+            human: "human";
+        }>>;
+        image: z.ZodNullable<z.ZodString>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type Call = z.infer<typeof Call>;
+export declare const CallList: z.ZodObject<{
+    items: z.ZodArray<z.ZodObject<{
+        callId: z.ZodTemplateLiteral<`call_${string}`>;
+        connectorId: z.ZodString;
+        function: z.ZodString;
+        source: z.ZodEnum<{
+            schedule: "schedule";
+            mcp: "mcp";
+            api: "api";
+        }>;
+        status: z.ZodNullable<z.ZodNumber>;
+        failed: z.ZodBoolean;
+        durationMs: z.ZodNumber;
+        createdAt: z.ZodISODateTime;
+        actor: z.ZodNullable<z.ZodObject<{
+            userId: z.ZodString;
+            name: z.ZodNullable<z.ZodString>;
+            kind: z.ZodNullable<z.ZodEnum<{
+                machine: "machine";
+                human: "human";
+            }>>;
+            image: z.ZodNullable<z.ZodString>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+    nextCursor: z.ZodNullable<z.ZodTemplateLiteral<`call_${string}`>>;
+}, z.core.$strict>;
+export type CallList = z.infer<typeof CallList>;

package/dist/connectors/connectors.js

@@ -0,0 +1,83 @@
+import { z } from "zod";
+import { idSchema } from "../ids/ids.js";
+import { Flag, Limit } from "../list-input.js";
+// The connectors' catalog and call log (#5): the inputs of `connectors_connector_list`,
+// `connectors_connector_get` and `connectors_call_list` and the answers the UI (#7) reads.
+// The id from a connector's code (`shopify`), never a ULID: one single word (E64).
+export const ConnectorId = z.string().regex(/^[a-z][a-z0-9]*$/, "A connector id is one word");
+export const CallId = idSchema("call");
+export const ConnectorListInput = z.strictObject({
+    cursor: ConnectorId.optional(),
+    limit: Limit.optional(),
+});
+export const ConnectorGetInput = z.strictObject({ connectorId: ConnectorId });
+// One field of the form a connection is entered in (#7), from the connector's `settings` and
+// `secrets` and their `.meta()`. A `secret` field is a password field and is never read back.
+//
+// ⚠️ Not `key` and not `secret: true`: `/mcp` strikes every value under a key that looks like a
+// secret (`redactSecrets` in `shared`), and both names match. `name` and `kind` survive it.
+export const ConnectorField = z.strictObject({
+    // The key in `settings` or `secrets`, `SHOPIFY_SHOP`.
+    name: z.string(),
+    label: z.string(),
+    help: z.string().optional(),
+    placeholder: z.string().optional(),
+    optional: z.boolean(),
+    kind: z.enum(["setting", "secret"]),
+});
+export const ConnectorTool = z.strictObject({
+    // The key in the connector's `tools`, `order-list`; the right is `connectors / <id> / <function>`.
+    function: z.string(),
+    description: z.string(),
+    writes: z.boolean(),
+});
+export const Connector = z.strictObject({
+    connectorId: ConnectorId,
+    name: z.string(),
+    category: z.string(),
+    description: z.string(),
+    // The SVG as text, for the catalog tile.
+    icon: z.string(),
+    // From the catalog `anchrd/connectors`, rather than the installation's own.
+    catalog: z.boolean(),
+    tools: z.array(ConnectorTool),
+    fields: z.array(ConnectorField),
+});
+export const ConnectorList = z.strictObject({
+    items: z.array(Connector),
+    nextCursor: ConnectorId.nullable(),
+});
+// How a call came in: an AI or machine over `/mcp`, the UI (the test button, #7), or the daily test.
+export const CallSource = z.enum(["mcp", "api", "schedule"]);
+export const CallListInput = z.strictObject({
+    connectorId: ConnectorId,
+    // Only the failed calls, or only the others.
+    failed: Flag.optional(),
+    cursor: CallId.optional(),
+    limit: Limit.optional(),
+});
+// One line of a connector's log: who, which function, the answer and how long it took, never the
+// arguments or the result (E69).
+export const Call = z.strictObject({
+    callId: CallId,
+    connectorId: ConnectorId,
+    // `order-list`, or `test` for the connection test.
+    function: z.string(),
+    source: CallSource,
+    // The provider's HTTP status, 200 on success, null without an answer.
+    status: z.number().int().nullable(),
+    failed: z.boolean(),
+    durationMs: z.number().int(),
+    createdAt: z.iso.datetime(),
+    // Null for the daily test, which nobody started. Name, kind and picture come from `access`, null
+    // when it no longer knows the id; the picture is null for a machine and a person without one (#140).
+    actor: z
+        .strictObject({
+        userId: z.string(),
+        name: z.string().nullable(),
+        kind: z.enum(["human", "machine"]).nullable(),
+        image: z.string().nullable(),
+    })
+        .nullable(),
+});
+export const CallList = z.strictObject({ items: z.array(Call), nextCursor: CallId.nullable() });

package/dist/dashboards/dashboards.d.ts

@@ -0,0 +1,221 @@
+import { z } from "zod";
+export declare const DashboardId: z.ZodTemplateLiteral<`node_${string}`>;
+export type DashboardId = z.infer<typeof DashboardId>;
+export declare const rhythms: readonly ["manual", "daily", "weekly", "monthly", "dates"];
+export declare const weekdays: readonly ["monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday"];
+export declare const whileOpenModes: readonly ["wait", "continue"];
+export declare const WhileOpen: z.ZodEnum<{
+    wait: "wait";
+    continue: "continue";
+}>;
+export type WhileOpen = z.infer<typeof WhileOpen>;
+export declare const Schedule: z.ZodObject<{
+    rhythm: z.ZodEnum<{
+        manual: "manual";
+        daily: "daily";
+        weekly: "weekly";
+        monthly: "monthly";
+        dates: "dates";
+    }>;
+    days: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+        monday: "monday";
+        tuesday: "tuesday";
+        wednesday: "wednesday";
+        thursday: "thursday";
+        friday: "friday";
+        saturday: "saturday";
+        sunday: "sunday";
+    }>>>;
+    dayOfMonth: z.ZodOptional<z.ZodArray<z.ZodInt>>;
+    times: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    dates: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    zone: z.ZodOptional<z.ZodString>;
+    whileOpen: z.ZodOptional<z.ZodEnum<{
+        wait: "wait";
+        continue: "continue";
+    }>>;
+}, z.core.$strict>;
+export type Schedule = z.infer<typeof Schedule>;
+export declare const boxTypes: readonly ["metric", "line", "bar", "area", "summary", "note"];
+export type BoxType = (typeof boxTypes)[number];
+export declare const chartTypes: readonly ["line", "bar", "area"];
+export declare const DashboardKey: z.ZodString;
+export type DashboardKey = z.infer<typeof DashboardKey>;
+declare const DashboardBox: z.ZodObject<{
+    metric: z.ZodOptional<z.ZodString>;
+    line: z.ZodOptional<z.ZodString>;
+    bar: z.ZodOptional<z.ZodString>;
+    area: z.ZodOptional<z.ZodString>;
+    summary: z.ZodOptional<z.ZodString>;
+    note: z.ZodOptional<z.ZodString>;
+    title: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+    instructions: z.ZodOptional<z.ZodString>;
+    width: z.ZodOptional<z.ZodInt>;
+    shows: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    uses: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    assignee: z.ZodOptional<z.ZodTemplateLiteral<`user_${string}`>>;
+}, z.core.$strict>;
+export type DashboardBox = z.infer<typeof DashboardBox>;
+export declare const DashboardConfig: z.ZodObject<{
+    instruction: z.ZodOptional<z.ZodString>;
+    schedule: z.ZodDefault<z.ZodObject<{
+        rhythm: z.ZodEnum<{
+            manual: "manual";
+            daily: "daily";
+            weekly: "weekly";
+            monthly: "monthly";
+            dates: "dates";
+        }>;
+        days: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+            monday: "monday";
+            tuesday: "tuesday";
+            wednesday: "wednesday";
+            thursday: "thursday";
+            friday: "friday";
+            saturday: "saturday";
+            sunday: "sunday";
+        }>>>;
+        dayOfMonth: z.ZodOptional<z.ZodArray<z.ZodInt>>;
+        times: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        dates: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        zone: z.ZodOptional<z.ZodString>;
+        whileOpen: z.ZodOptional<z.ZodEnum<{
+            wait: "wait";
+            continue: "continue";
+        }>>;
+    }, z.core.$strict>>;
+    metrics: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodObject<{
+        title: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        instructions: z.ZodString;
+        source: z.ZodOptional<z.ZodString>;
+        assignee: z.ZodOptional<z.ZodTemplateLiteral<`user_${string}`>>;
+    }, z.core.$strict>>>;
+    sections: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        title: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        boxes: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            metric: z.ZodOptional<z.ZodString>;
+            line: z.ZodOptional<z.ZodString>;
+            bar: z.ZodOptional<z.ZodString>;
+            area: z.ZodOptional<z.ZodString>;
+            summary: z.ZodOptional<z.ZodString>;
+            note: z.ZodOptional<z.ZodString>;
+            title: z.ZodOptional<z.ZodString>;
+            description: z.ZodOptional<z.ZodString>;
+            instructions: z.ZodOptional<z.ZodString>;
+            width: z.ZodOptional<z.ZodInt>;
+            shows: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            uses: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            assignee: z.ZodOptional<z.ZodTemplateLiteral<`user_${string}`>>;
+        }, z.core.$strict>>>;
+    }, z.core.$strict>>>;
+}, z.core.$strict>;
+export type DashboardConfig = z.infer<typeof DashboardConfig>;
+export declare const DashboardRun: z.ZodObject<{
+    metrics: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodObject<{
+        value: z.ZodUnion<readonly [z.ZodNumber, z.ZodString, z.ZodNull]>;
+        source: z.ZodNullable<z.ZodString>;
+        parameter: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        report: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        recommendation: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    }, z.core.$strict>>>;
+    summaries: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodObject<{
+        text: z.ZodNullable<z.ZodString>;
+        report: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        recommendation: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    }, z.core.$strict>>>;
+}, z.core.$strict>;
+export type DashboardRun = z.infer<typeof DashboardRun>;
+export declare const DashboardCreateInput: z.ZodObject<{
+    parentId: z.ZodNullable<z.ZodTemplateLiteral<`node_${string}`>>;
+    name: z.ZodString;
+    config: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    yaml: z.ZodOptional<z.ZodString>;
+    idempotencyKey: z.ZodString;
+}, z.core.$strict>;
+export type DashboardCreateInput = z.infer<typeof DashboardCreateInput>;
+export declare const DashboardGetInput: z.ZodObject<{
+    dashboardId: z.ZodTemplateLiteral<`node_${string}`>;
+}, z.core.$strict>;
+export type DashboardGetInput = z.infer<typeof DashboardGetInput>;
+export declare const DashboardUpdateInput: z.ZodObject<{
+    dashboardId: z.ZodTemplateLiteral<`node_${string}`>;
+    rev: z.ZodNumber;
+    config: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    yaml: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export type DashboardUpdateInput = z.infer<typeof DashboardUpdateInput>;
+export declare const DashboardDetail: z.ZodObject<{
+    dashboardId: z.ZodTemplateLiteral<`node_${string}`>;
+    name: z.ZodString;
+    config: z.ZodObject<{
+        instruction: z.ZodOptional<z.ZodString>;
+        schedule: z.ZodDefault<z.ZodObject<{
+            rhythm: z.ZodEnum<{
+                manual: "manual";
+                daily: "daily";
+                weekly: "weekly";
+                monthly: "monthly";
+                dates: "dates";
+            }>;
+            days: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+                monday: "monday";
+                tuesday: "tuesday";
+                wednesday: "wednesday";
+                thursday: "thursday";
+                friday: "friday";
+                saturday: "saturday";
+                sunday: "sunday";
+            }>>>;
+            dayOfMonth: z.ZodOptional<z.ZodArray<z.ZodInt>>;
+            times: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            dates: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            zone: z.ZodOptional<z.ZodString>;
+            whileOpen: z.ZodOptional<z.ZodEnum<{
+                wait: "wait";
+                continue: "continue";
+            }>>;
+        }, z.core.$strict>>;
+        metrics: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodObject<{
+            title: z.ZodString;
+            description: z.ZodOptional<z.ZodString>;
+            instructions: z.ZodString;
+            source: z.ZodOptional<z.ZodString>;
+            assignee: z.ZodOptional<z.ZodTemplateLiteral<`user_${string}`>>;
+        }, z.core.$strict>>>;
+        sections: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            title: z.ZodString;
+            description: z.ZodOptional<z.ZodString>;
+            boxes: z.ZodDefault<z.ZodArray<z.ZodObject<{
+                metric: z.ZodOptional<z.ZodString>;
+                line: z.ZodOptional<z.ZodString>;
+                bar: z.ZodOptional<z.ZodString>;
+                area: z.ZodOptional<z.ZodString>;
+                summary: z.ZodOptional<z.ZodString>;
+                note: z.ZodOptional<z.ZodString>;
+                title: z.ZodOptional<z.ZodString>;
+                description: z.ZodOptional<z.ZodString>;
+                instructions: z.ZodOptional<z.ZodString>;
+                width: z.ZodOptional<z.ZodInt>;
+                shows: z.ZodOptional<z.ZodArray<z.ZodString>>;
+                uses: z.ZodOptional<z.ZodArray<z.ZodString>>;
+                assignee: z.ZodOptional<z.ZodTemplateLiteral<`user_${string}`>>;
+            }, z.core.$strict>>>;
+        }, z.core.$strict>>>;
+    }, z.core.$strict>;
+    yaml: z.ZodString;
+    nextRunAt: z.ZodNullable<z.ZodISODateTime>;
+    dueAt: z.ZodNullable<z.ZodISODateTime>;
+    processCheck: z.ZodObject<{
+        operator: z.ZodBoolean;
+    }, z.core.$strict>;
+    rights: z.ZodObject<{
+        write: z.ZodBoolean;
+    }, z.core.$strict>;
+    rev: z.ZodNumber;
+    updatedAt: z.ZodISODateTime;
+}, z.core.$strict>;
+export type DashboardDetail = z.infer<typeof DashboardDetail>;
+export {};