@sanoma-ai/workflows 0.9.1 → 0.10.1

package/dist/description.d.ts

@@ -0,0 +1,532 @@
+import { z } from "zod";
+import type { Outline } from "./outline.ts";
+import type { ResourceFields } from "./resource.ts";
+/** Where a declaration is: its file, relative to the root with `/`, and the export that holds it (`default` for a default export). */
+export declare const AtSchema: z.ZodObject<{
+    file: z.ZodString;
+    export: z.ZodString;
+}, z.core.$strict>;
+export type At = z.infer<typeof AtSchema>;
+/** Something wrong in a file, at a line and column from 1 (UTF-16 code units). */
+export declare const LintProblemSchema: z.ZodObject<{
+    line: z.ZodNumber;
+    column: z.ZodNumber;
+    message: z.ZodString;
+}, z.core.$strict>;
+export type LintProblem = z.infer<typeof LintProblemSchema>;
+/**
+ * Something wrong in a company's files (a data file, an app's `app.ts`, a site's `site.ts`), or in
+ * finding them: at a place in the file when an error's stack gives one, else at an export.
+ */
+export declare const ResourceProblemSchema: z.ZodObject<{
+    file: z.ZodOptional<z.ZodString>;
+    export: z.ZodOptional<z.ZodString>;
+    line: z.ZodOptional<z.ZodNumber>;
+    column: z.ZodOptional<z.ZodNumber>;
+    message: z.ZodString;
+}, z.core.$strict>;
+export type ResourceProblem = z.infer<typeof ResourceProblemSchema>;
+/** A resource a data file declares, as loading the file made it. */
+export declare const DeclaredResourceSchema: z.ZodObject<{
+    id: z.ZodString;
+    file: z.ZodString;
+    vendor: z.ZodString;
+    type: z.ZodString;
+    name: z.ZodString;
+    identity: z.ZodOptional<z.ZodString>;
+    binding: z.ZodOptional<z.ZodString>;
+    at: z.ZodObject<{
+        file: z.ZodString;
+        export: z.ZodString;
+    }, z.core.$strict>;
+    desired: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    connection: z.ZodOptional<z.ZodObject<{
+        $connection: z.ZodString;
+        vendor: z.ZodString;
+        revision: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>;
+    refs: z.ZodRecord<z.ZodString, z.ZodString>;
+}, z.core.$strict>;
+export type DeclaredResource = z.infer<typeof DeclaredResourceSchema>;
+/**
+ * A collection `resources/data.ts` declares: where it is, for its declaration on Hosting. Its fields are
+ * the collection's own (`describeConfig`'s `collections`), from the same file, which the runtime
+ * imports.
+ */
+export declare const DeclaredCollectionSchema: z.ZodObject<{
+    id: z.ZodString;
+    file: z.ZodString;
+    name: z.ZodString;
+    at: z.ZodObject<{
+        file: z.ZodString;
+        export: z.ZodString;
+    }, z.core.$strict>;
+}, z.core.$strict>;
+export type DeclaredCollection = z.infer<typeof DeclaredCollectionSchema>;
+/** An app: a folder of `apps/`, and what its `app.ts` declares. */
+export declare const AppEntrySchema: z.ZodObject<{
+    name: z.ZodString;
+    dir: z.ZodString;
+    source: z.ZodOptional<z.ZodString>;
+    at: z.ZodOptional<z.ZodObject<{
+        file: z.ZodString;
+        export: z.ZodString;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type AppEntry = z.infer<typeof AppEntrySchema>;
+/** A call a site's code makes: `<RunForm workflow="…" />`, or a use of `api`. */
+export declare const SiteCallSchema: z.ZodObject<{
+    kind: z.ZodEnum<{
+        collection: "collection";
+        op: "op";
+        workflow: "workflow";
+    }>;
+    target: z.ZodString;
+    method: z.ZodOptional<z.ZodString>;
+    via: z.ZodEnum<{
+        RunForm: "RunForm";
+        api: "api";
+    }>;
+    file: z.ZodString;
+    line: z.ZodNumber;
+    column: z.ZodNumber;
+    page: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export type SiteCall = z.infer<typeof SiteCallSchema>;
+/** A page of a site: a route file's path, and for a page per content entry the kind it reads. */
+export declare const SitePageSchema: z.ZodObject<{
+    path: z.ZodString;
+    content: z.ZodOptional<z.ZodString>;
+    sitemap: z.ZodOptional<z.ZodLiteral<false>>;
+}, z.core.$strict>;
+export type SitePage = z.infer<typeof SitePageSchema>;
+/** A site, `sites/<name>/` or an app's `apps/<app>/sites/<name>/`, and what it calls. */
+export declare const SiteEntrySchema: z.ZodObject<{
+    name: z.ZodString;
+    app: z.ZodOptional<z.ZodString>;
+    at: z.ZodOptional<z.ZodObject<{
+        file: z.ZodString;
+        export: z.ZodString;
+    }, z.core.$strict>>;
+    title: z.ZodOptional<z.ZodString>;
+    icon: z.ZodOptional<z.ZodString>;
+    public: z.ZodOptional<z.ZodLiteral<true>>;
+    login: z.ZodOptional<z.ZodString>;
+    locales: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    domain: z.ZodOptional<z.ZodString>;
+    pages: z.ZodArray<z.ZodObject<{
+        path: z.ZodString;
+        content: z.ZodOptional<z.ZodString>;
+        sitemap: z.ZodOptional<z.ZodLiteral<false>>;
+    }, z.core.$strict>>;
+    calls: z.ZodArray<z.ZodObject<{
+        kind: z.ZodEnum<{
+            collection: "collection";
+            op: "op";
+            workflow: "workflow";
+        }>;
+        target: z.ZodString;
+        method: z.ZodOptional<z.ZodString>;
+        via: z.ZodEnum<{
+            RunForm: "RunForm";
+            api: "api";
+        }>;
+        file: z.ZodString;
+        line: z.ZodNumber;
+        column: z.ZodNumber;
+        page: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>;
+    problems: z.ZodArray<z.ZodObject<{
+        export: z.ZodOptional<z.ZodString>;
+        line: z.ZodOptional<z.ZodNumber>;
+        column: z.ZodOptional<z.ZodNumber>;
+        message: z.ZodString;
+        file: z.ZodString;
+    }, z.core.$strict>>;
+    warnings: z.ZodArray<z.ZodObject<{
+        line: z.ZodNumber;
+        column: z.ZodNumber;
+        message: z.ZodString;
+        file: z.ZodString;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type SiteEntry = z.infer<typeof SiteEntrySchema>;
+/** What a workflow is, read from its definition: enough to draw a start form and show what it may call. */
+export declare const WorkflowEntrySchema: z.ZodObject<{
+    name: z.ZodString;
+    app: z.ZodOptional<z.ZodString>;
+    title: z.ZodOptional<z.ZodString>;
+    trigger: z.ZodUnion<readonly [z.ZodLiteral<"manual">, z.ZodObject<{
+        schedule: z.ZodString;
+        timezone: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>]>;
+    builtin: z.ZodOptional<z.ZodLiteral<true>>;
+    input: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    ops: z.ZodArray<z.ZodString>;
+    builtins: z.ZodArray<z.ZodEnum<{
+        all: "all";
+        approval: "approval";
+        sleep: "sleep";
+    }>>;
+    file: z.ZodString;
+    outline: z.ZodCustom<Outline, Outline>;
+    problems: z.ZodArray<z.ZodObject<{
+        line: z.ZodNumber;
+        column: z.ZodNumber;
+        message: z.ZodString;
+    }, z.core.$strict>>;
+    source: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export type WorkflowEntry = z.infer<typeof WorkflowEntrySchema>;
+/** What an operation is, read from its connector: enough to badge it and show its contract. */
+export declare const OpEntrySchema: z.ZodObject<{
+    id: z.ZodString;
+    vendor: z.ZodString;
+    resource: z.ZodString;
+    name: z.ZodString;
+    effect: z.ZodEnum<{
+        access: "access";
+        money: "money";
+        publish: "publish";
+        read: "read";
+        send: "send";
+        write: "write";
+    }>;
+    idempotent: z.ZodBoolean;
+    description: z.ZodOptional<z.ZodString>;
+    phrases: z.ZodOptional<z.ZodObject<{
+        given: z.ZodOptional<z.ZodString>;
+        expect: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>;
+    direct: z.ZodBoolean;
+    input: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    output: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+}, z.core.$strict>;
+export type OpEntry = z.infer<typeof OpEntrySchema>;
+/** Who a vendor is, from its connector's `VendorInfo`: enough to name it, show its logo and link to its connector. */
+export declare const VendorEntrySchema: z.ZodObject<{
+    title: z.ZodString;
+    logo: z.ZodOptional<z.ZodObject<{
+        src: z.ZodString;
+        dark: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>;
+    package: z.ZodOptional<z.ZodString>;
+    homepage: z.ZodOptional<z.ZodString>;
+    fake: z.ZodBoolean;
+    credentials: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        optional: z.ZodOptional<z.ZodLiteral<true>>;
+    }, z.core.$strict>>>;
+}, z.core.$strict>;
+export type VendorEntry = z.infer<typeof VendorEntrySchema>;
+/**
+ * The contracts a resource type meets, from its spec: `host`, `database` and `wakeup` (`Host`,
+ * `Database`, `Wakeup`), and `source` for a type a host's `source` names (the repository it clones).
+ */
+export declare const CAPABILITIES: readonly ["host", "database", "wakeup", "source"];
+/** A resource type a connector declares with `defineResource`. */
+export declare const ResourceTypeEntrySchema: z.ZodObject<{
+    id: z.ZodString;
+    vendor: z.ZodString;
+    type: z.ZodString;
+    title: z.ZodString;
+    identity: z.ZodOptional<z.ZodString>;
+    fields: z.ZodCustom<ResourceFields, ResourceFields>;
+    schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    ops: z.ZodArray<z.ZodString>;
+    capabilities: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+        database: "database";
+        host: "host";
+        source: "source";
+        wakeup: "wakeup";
+    }>>>;
+}, z.core.$strict>;
+export type ResourceTypeEntry = z.infer<typeof ResourceTypeEntrySchema>;
+/** A collection the config declares (`collection()`). */
+export declare const CollectionEntrySchema: z.ZodObject<{
+    name: z.ZodString;
+    app: z.ZodOptional<z.ZodString>;
+    title: z.ZodOptional<z.ZodString>;
+    key: z.ZodString;
+    fields: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodEnum<{
+        boolean: "boolean";
+        date: "date";
+        number: "number";
+        person: "person";
+        text: "text";
+    }>, z.ZodObject<{
+        type: z.ZodEnum<{
+            boolean: "boolean";
+            date: "date";
+            number: "number";
+            person: "person";
+            text: "text";
+        }>;
+        optional: z.ZodOptional<z.ZodLiteral<true>>;
+    }, z.core.$strict>, z.ZodObject<{
+        enum: z.ZodReadonly<z.ZodTuple<[z.ZodString], z.ZodString>>;
+        optional: z.ZodOptional<z.ZodLiteral<true>>;
+    }, z.core.$strict>]>>;
+    record: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    ops: z.ZodArray<z.ZodString>;
+    declared: z.ZodOptional<z.ZodObject<{
+        id: z.ZodString;
+        file: z.ZodString;
+        name: z.ZodString;
+        at: z.ZodObject<{
+            file: z.ZodString;
+            export: z.ZodString;
+        }, z.core.$strict>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type CollectionEntry = z.infer<typeof CollectionEntrySchema>;
+/**
+ * A plain-JSON description of what a config can do: its workflows, the operations they call,
+ * and whether a policy gates them. The app server builds it from the config and sends it to the
+ * browser, so the UI shows exactly what the worker enforces. Never written by hand.
+ */
+export declare const ConfigDescriptionSchema: z.ZodObject<{
+    secrets: z.ZodOptional<z.ZodObject<{
+        store: z.ZodString;
+        namespace: z.ZodString;
+        bindings: z.ZodRecord<z.ZodString, z.ZodObject<{
+            path: z.ZodString;
+            management: z.ZodEnum<{
+                external: "external";
+                sanoma: "sanoma";
+            }>;
+            store: z.ZodString;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+    connections: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        vendor: z.ZodString;
+        method: z.ZodString;
+        scopes: z.ZodReadonly<z.ZodArray<z.ZodString>>;
+        account: z.ZodOptional<z.ZodString>;
+        default: z.ZodBoolean;
+    }, z.core.$strict>>>;
+    appName: z.ZodString;
+    version: z.ZodString;
+    workflows: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        app: z.ZodOptional<z.ZodString>;
+        title: z.ZodOptional<z.ZodString>;
+        trigger: z.ZodUnion<readonly [z.ZodLiteral<"manual">, z.ZodObject<{
+            schedule: z.ZodString;
+            timezone: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>]>;
+        builtin: z.ZodOptional<z.ZodLiteral<true>>;
+        input: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        ops: z.ZodArray<z.ZodString>;
+        builtins: z.ZodArray<z.ZodEnum<{
+            all: "all";
+            approval: "approval";
+            sleep: "sleep";
+        }>>;
+        file: z.ZodString;
+        outline: z.ZodCustom<Outline, Outline>;
+        problems: z.ZodArray<z.ZodObject<{
+            line: z.ZodNumber;
+            column: z.ZodNumber;
+            message: z.ZodString;
+        }, z.core.$strict>>;
+        source: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>;
+    ops: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        vendor: z.ZodString;
+        resource: z.ZodString;
+        name: z.ZodString;
+        effect: z.ZodEnum<{
+            access: "access";
+            money: "money";
+            publish: "publish";
+            read: "read";
+            send: "send";
+            write: "write";
+        }>;
+        idempotent: z.ZodBoolean;
+        description: z.ZodOptional<z.ZodString>;
+        phrases: z.ZodOptional<z.ZodObject<{
+            given: z.ZodOptional<z.ZodString>;
+            expect: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>;
+        direct: z.ZodBoolean;
+        input: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        output: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    }, z.core.$strict>>;
+    vendors: z.ZodRecord<z.ZodString, z.ZodObject<{
+        title: z.ZodString;
+        logo: z.ZodOptional<z.ZodObject<{
+            src: z.ZodString;
+            dark: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>;
+        package: z.ZodOptional<z.ZodString>;
+        homepage: z.ZodOptional<z.ZodString>;
+        fake: z.ZodBoolean;
+        credentials: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            description: z.ZodOptional<z.ZodString>;
+            optional: z.ZodOptional<z.ZodLiteral<true>>;
+        }, z.core.$strict>>>;
+    }, z.core.$strict>>;
+    resourceTypes: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        vendor: z.ZodString;
+        type: z.ZodString;
+        title: z.ZodString;
+        identity: z.ZodOptional<z.ZodString>;
+        fields: z.ZodCustom<ResourceFields, ResourceFields>;
+        schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        ops: z.ZodArray<z.ZodString>;
+        capabilities: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+            database: "database";
+            host: "host";
+            source: "source";
+            wakeup: "wakeup";
+        }>>>;
+    }, z.core.$strict>>;
+    collections: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        app: z.ZodOptional<z.ZodString>;
+        title: z.ZodOptional<z.ZodString>;
+        key: z.ZodString;
+        fields: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodEnum<{
+            boolean: "boolean";
+            date: "date";
+            number: "number";
+            person: "person";
+            text: "text";
+        }>, z.ZodObject<{
+            type: z.ZodEnum<{
+                boolean: "boolean";
+                date: "date";
+                number: "number";
+                person: "person";
+                text: "text";
+            }>;
+            optional: z.ZodOptional<z.ZodLiteral<true>>;
+        }, z.core.$strict>, z.ZodObject<{
+            enum: z.ZodReadonly<z.ZodTuple<[z.ZodString], z.ZodString>>;
+            optional: z.ZodOptional<z.ZodLiteral<true>>;
+        }, z.core.$strict>]>>;
+        record: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        ops: z.ZodArray<z.ZodString>;
+        declared: z.ZodOptional<z.ZodObject<{
+            id: z.ZodString;
+            file: z.ZodString;
+            name: z.ZodString;
+            at: z.ZodObject<{
+                file: z.ZodString;
+                export: z.ZodString;
+            }, z.core.$strict>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+    resources: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        file: z.ZodString;
+        vendor: z.ZodString;
+        type: z.ZodString;
+        name: z.ZodString;
+        identity: z.ZodOptional<z.ZodString>;
+        binding: z.ZodOptional<z.ZodString>;
+        at: z.ZodObject<{
+            file: z.ZodString;
+            export: z.ZodString;
+        }, z.core.$strict>;
+        desired: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        connection: z.ZodOptional<z.ZodObject<{
+            $connection: z.ZodString;
+            vendor: z.ZodString;
+            revision: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>;
+        refs: z.ZodRecord<z.ZodString, z.ZodString>;
+    }, z.core.$strict>>;
+    orphans: z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        type: z.ZodString;
+        id: z.ZodString;
+        connection: z.ZodOptional<z.ZodObject<{
+            $connection: z.ZodString;
+            vendor: z.ZodString;
+            revision: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+    problems: z.ZodArray<z.ZodObject<{
+        file: z.ZodOptional<z.ZodString>;
+        export: z.ZodOptional<z.ZodString>;
+        line: z.ZodOptional<z.ZodNumber>;
+        column: z.ZodOptional<z.ZodNumber>;
+        message: z.ZodString;
+    }, z.core.$strict>>;
+    apps: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        dir: z.ZodString;
+        source: z.ZodOptional<z.ZodString>;
+        at: z.ZodOptional<z.ZodObject<{
+            file: z.ZodString;
+            export: z.ZodString;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+    policy: z.ZodObject<{
+        defined: z.ZodBoolean;
+        version: z.ZodOptional<z.ZodString>;
+        problems: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        files: z.ZodArray<z.ZodObject<{
+            file: z.ZodString;
+            text: z.ZodString;
+        }, z.core.$strict>>;
+    }, z.core.$strict>;
+    sites: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        app: z.ZodOptional<z.ZodString>;
+        at: z.ZodOptional<z.ZodObject<{
+            file: z.ZodString;
+            export: z.ZodString;
+        }, z.core.$strict>>;
+        title: z.ZodOptional<z.ZodString>;
+        icon: z.ZodOptional<z.ZodString>;
+        public: z.ZodOptional<z.ZodLiteral<true>>;
+        login: z.ZodOptional<z.ZodString>;
+        locales: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        domain: z.ZodOptional<z.ZodString>;
+        pages: z.ZodArray<z.ZodObject<{
+            path: z.ZodString;
+            content: z.ZodOptional<z.ZodString>;
+            sitemap: z.ZodOptional<z.ZodLiteral<false>>;
+        }, z.core.$strict>>;
+        calls: z.ZodArray<z.ZodObject<{
+            kind: z.ZodEnum<{
+                collection: "collection";
+                op: "op";
+                workflow: "workflow";
+            }>;
+            target: z.ZodString;
+            method: z.ZodOptional<z.ZodString>;
+            via: z.ZodEnum<{
+                RunForm: "RunForm";
+                api: "api";
+            }>;
+            file: z.ZodString;
+            line: z.ZodNumber;
+            column: z.ZodNumber;
+            page: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>;
+        problems: z.ZodArray<z.ZodObject<{
+            export: z.ZodOptional<z.ZodString>;
+            line: z.ZodOptional<z.ZodNumber>;
+            column: z.ZodOptional<z.ZodNumber>;
+            message: z.ZodString;
+            file: z.ZodString;
+        }, z.core.$strict>>;
+        warnings: z.ZodArray<z.ZodObject<{
+            line: z.ZodNumber;
+            column: z.ZodNumber;
+            message: z.ZodString;
+            file: z.ZodString;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type ConfigDescription = z.infer<typeof ConfigDescriptionSchema>;