@withloops.ai/contracts 0.0.0-stage → 0.2.0

package/dist/manifest.d.ts

@@ -0,0 +1,550 @@
+import { z } from 'zod';
+/**
+ * App manifest v1 (`loops.manifest.json`). Everything is a Loops App: one manifest, two optional halves —
+ * `sync` (declarative CRM connector, run by the one Loops sync engine) and `ui` (LoopKit). Skill §2 #1–#3, §3.
+ * Only ever ADD optional fields to v1; a breaking change is manifest v2 and v1 keeps working.
+ */
+/** Loops record kinds a connector maps into. */
+export declare const RecordKind: z.ZodEnum<{
+    CONTACT: "CONTACT";
+    COMPANY: "COMPANY";
+    LEAD: "LEAD";
+    DEAL: "DEAL";
+}>;
+export type RecordKind = z.infer<typeof RecordKind>;
+export declare const SyncAuth: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    type: z.ZodLiteral<"oauth2">;
+    authorizeUrl: z.ZodURL;
+    tokenUrl: z.ZodURL;
+    scopes: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    refresh: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"apiKey">;
+    header: z.ZodDefault<z.ZodString>;
+    prefix: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>], "type">;
+export type SyncAuth = z.infer<typeof SyncAuth>;
+/** Who owns a field. The customer's CRM owns its fields (locked in Loops); Loops owns its own. Owner wins, never last-write-wins. */
+export declare const FieldOwner: z.ZodEnum<{
+    theirs: "theirs";
+    ours: "ours";
+}>;
+export declare const SyncField: z.ZodObject<{
+    theirs: z.ZodString;
+    ours: z.ZodString;
+    owner: z.ZodEnum<{
+        theirs: "theirs";
+        ours: "ours";
+    }>;
+}, z.core.$strip>;
+export declare const SyncObject: z.ZodObject<{
+    theirs: z.ZodString;
+    ours: z.ZodEnum<{
+        CONTACT: "CONTACT";
+        COMPANY: "COMPANY";
+        LEAD: "LEAD";
+        DEAL: "DEAL";
+    }>;
+    list: z.ZodObject<{
+        path: z.ZodString;
+        itemsPath: z.ZodDefault<z.ZodString>;
+        cursorParam: z.ZodOptional<z.ZodString>;
+        nextCursorPath: z.ZodOptional<z.ZodString>;
+        updatedSinceParam: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    fields: z.ZodArray<z.ZodObject<{
+        theirs: z.ZodString;
+        ours: z.ZodString;
+        owner: z.ZodEnum<{
+            theirs: "theirs";
+            ours: "ours";
+        }>;
+    }, z.core.$strip>>;
+    match: z.ZodDefault<z.ZodArray<z.ZodString>>;
+}, z.core.$strip>;
+export declare const SyncLink: z.ZodObject<{
+    from: z.ZodEnum<{
+        CONTACT: "CONTACT";
+        COMPANY: "COMPANY";
+        LEAD: "LEAD";
+        DEAL: "DEAL";
+    }>;
+    to: z.ZodEnum<{
+        CONTACT: "CONTACT";
+        COMPANY: "COMPANY";
+        LEAD: "LEAD";
+        DEAL: "DEAL";
+    }>;
+    theirs: z.ZodString;
+    role: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export declare const ChangeFeed: z.ZodObject<{
+    webhook: z.ZodOptional<z.ZodObject<{
+        signature: z.ZodObject<{
+            scheme: z.ZodEnum<{
+                "hmac-sha256": "hmac-sha256";
+                "hmac-sha1": "hmac-sha1";
+            }>;
+            header: z.ZodString;
+        }, z.core.$strip>;
+    }, z.core.$strip>>;
+    polling: z.ZodOptional<z.ZodObject<{
+        everyMinutes: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/** What Loops writes back to the CRM timeline (Loops owns these). */
+export declare const WriteBackKind: z.ZodEnum<{
+    call: "call";
+    transcript: "transcript";
+    meeting: "meeting";
+    note: "note";
+    action: "action";
+    campaignReply: "campaignReply";
+}>;
+export declare const WriteBack: z.ZodRecord<z.ZodEnum<{
+    call: "call";
+    transcript: "transcript";
+    meeting: "meeting";
+    note: "note";
+    action: "action";
+    campaignReply: "campaignReply";
+}> & z.core.$partial, z.ZodObject<{
+    method: z.ZodEnum<{
+        POST: "POST";
+        PUT: "PUT";
+        PATCH: "PATCH";
+    }>;
+    path: z.ZodString;
+}, z.core.$strip>>;
+export declare const SyncLimits: z.ZodObject<{
+    requestsPerSecond: z.ZodNumber;
+    burst: z.ZodOptional<z.ZodNumber>;
+    retryAfterHeader: z.ZodDefault<z.ZodString>;
+}, z.core.$strip>;
+export declare const SyncManifest: z.ZodObject<{
+    baseUrl: z.ZodURL;
+    auth: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        type: z.ZodLiteral<"oauth2">;
+        authorizeUrl: z.ZodURL;
+        tokenUrl: z.ZodURL;
+        scopes: z.ZodDefault<z.ZodArray<z.ZodString>>;
+        refresh: z.ZodDefault<z.ZodBoolean>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"apiKey">;
+        header: z.ZodDefault<z.ZodString>;
+        prefix: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>], "type">;
+    objects: z.ZodArray<z.ZodObject<{
+        theirs: z.ZodString;
+        ours: z.ZodEnum<{
+            CONTACT: "CONTACT";
+            COMPANY: "COMPANY";
+            LEAD: "LEAD";
+            DEAL: "DEAL";
+        }>;
+        list: z.ZodObject<{
+            path: z.ZodString;
+            itemsPath: z.ZodDefault<z.ZodString>;
+            cursorParam: z.ZodOptional<z.ZodString>;
+            nextCursorPath: z.ZodOptional<z.ZodString>;
+            updatedSinceParam: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>;
+        fields: z.ZodArray<z.ZodObject<{
+            theirs: z.ZodString;
+            ours: z.ZodString;
+            owner: z.ZodEnum<{
+                theirs: "theirs";
+                ours: "ours";
+            }>;
+        }, z.core.$strip>>;
+        match: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    }, z.core.$strip>>;
+    links: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        from: z.ZodEnum<{
+            CONTACT: "CONTACT";
+            COMPANY: "COMPANY";
+            LEAD: "LEAD";
+            DEAL: "DEAL";
+        }>;
+        to: z.ZodEnum<{
+            CONTACT: "CONTACT";
+            COMPANY: "COMPANY";
+            LEAD: "LEAD";
+            DEAL: "DEAL";
+        }>;
+        theirs: z.ZodString;
+        role: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    changeFeed: z.ZodObject<{
+        webhook: z.ZodOptional<z.ZodObject<{
+            signature: z.ZodObject<{
+                scheme: z.ZodEnum<{
+                    "hmac-sha256": "hmac-sha256";
+                    "hmac-sha1": "hmac-sha1";
+                }>;
+                header: z.ZodString;
+            }, z.core.$strip>;
+        }, z.core.$strip>>;
+        polling: z.ZodOptional<z.ZodObject<{
+            everyMinutes: z.ZodNumber;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+    writeBack: z.ZodDefault<z.ZodRecord<z.ZodEnum<{
+        call: "call";
+        transcript: "transcript";
+        meeting: "meeting";
+        note: "note";
+        action: "action";
+        campaignReply: "campaignReply";
+    }> & z.core.$partial, z.ZodObject<{
+        method: z.ZodEnum<{
+            POST: "POST";
+            PUT: "PUT";
+            PATCH: "PATCH";
+        }>;
+        path: z.ZodString;
+    }, z.core.$strip>>>;
+    limits: z.ZodObject<{
+        requestsPerSecond: z.ZodNumber;
+        burst: z.ZodOptional<z.ZodNumber>;
+        retryAfterHeader: z.ZodDefault<z.ZodString>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type SyncManifest = z.infer<typeof SyncManifest>;
+export declare const SLOTS: readonly ["recordPanel", "recordTab", "recordAction", "bulkAction", "composerButton", "messageAction", "loopCard", "linkCard", "crmPanelItem", "settingsPage", "dashboardTile", "simiTool"];
+export declare const Slot: z.ZodEnum<{
+    recordPanel: "recordPanel";
+    recordTab: "recordTab";
+    recordAction: "recordAction";
+    bulkAction: "bulkAction";
+    composerButton: "composerButton";
+    messageAction: "messageAction";
+    loopCard: "loopCard";
+    linkCard: "linkCard";
+    crmPanelItem: "crmPanelItem";
+    settingsPage: "settingsPage";
+    dashboardTile: "dashboardTile";
+    simiTool: "simiTool";
+}>;
+export type Slot = z.infer<typeof Slot>;
+/** Things an app may do in Loops (`LoopKit.do`), and the scope each needs. */
+export declare const DOES: {
+    readonly 'record.note': "notes:write";
+    readonly 'loop.post': "loops:write";
+    readonly 'action.add': "actions:write";
+};
+export declare const Does: z.ZodEnum<{
+    "record.note": "record.note";
+    "loop.post": "loop.post";
+    "action.add": "action.add";
+}>;
+/** A field the app reads: `contact.email`, `deal.value`, `loop.title`. */
+export declare const FieldPath: z.ZodString;
+/** Where a sent value comes from: a granted field, the link, or the app's settings. */
+export declare const ValueSource: z.ZodString;
+/** A declared response field type: string, number, boolean, date, or enum:a|b|c. */
+export declare const ReturnType: z.ZodString;
+export declare const Endpoint: z.ZodObject<{
+    method: z.ZodEnum<{
+        POST: "POST";
+        PUT: "PUT";
+        PATCH: "PATCH";
+        GET: "GET";
+        DELETE: "DELETE";
+    }>;
+    url: z.ZodURL;
+    sends: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
+    returns: z.ZodRecord<z.ZodString, z.ZodString>;
+}, z.core.$strip>;
+export type Endpoint = z.infer<typeof Endpoint>;
+export declare const Setting: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    type: z.ZodLiteral<"secret">;
+    label: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"text">;
+    label: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"choice">;
+    label: z.ZodString;
+    options: z.ZodArray<z.ZodString>;
+}, z.core.$strip>], "type">;
+export declare const UiManifest: z.ZodObject<{
+    apiVersion: z.ZodLiteral<1>;
+    slots: z.ZodArray<z.ZodEnum<{
+        recordPanel: "recordPanel";
+        recordTab: "recordTab";
+        recordAction: "recordAction";
+        bulkAction: "bulkAction";
+        composerButton: "composerButton";
+        messageAction: "messageAction";
+        loopCard: "loopCard";
+        linkCard: "linkCard";
+        crmPanelItem: "crmPanelItem";
+        settingsPage: "settingsPage";
+        dashboardTile: "dashboardTile";
+        simiTool: "simiTool";
+    }>>;
+    uses: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    does: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+        "record.note": "record.note";
+        "loop.post": "loop.post";
+        "action.add": "action.add";
+    }>>>;
+    hears: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+        "contact.created": "contact.created";
+        "contact.updated": "contact.updated";
+        "contact.deleted": "contact.deleted";
+        "company.created": "company.created";
+        "company.updated": "company.updated";
+        "company.deleted": "company.deleted";
+        "lead.created": "lead.created";
+        "lead.updated": "lead.updated";
+        "lead.deleted": "lead.deleted";
+        "deal.created": "deal.created";
+        "deal.updated": "deal.updated";
+        "deal.deleted": "deal.deleted";
+        "loop.message": "loop.message";
+        "loop.call.ended": "loop.call.ended";
+        "meeting.ended": "meeting.ended";
+        "app.installed": "app.installed";
+        "app.uninstalled": "app.uninstalled";
+    }>>>;
+    links: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    settings: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodDiscriminatedUnion<[z.ZodObject<{
+        type: z.ZodLiteral<"secret">;
+        label: z.ZodString;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"text">;
+        label: z.ZodString;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"choice">;
+        label: z.ZodString;
+        options: z.ZodArray<z.ZodString>;
+    }, z.core.$strip>], "type">>>;
+    endpoints: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodObject<{
+        method: z.ZodEnum<{
+            POST: "POST";
+            PUT: "PUT";
+            PATCH: "PATCH";
+            GET: "GET";
+            DELETE: "DELETE";
+        }>;
+        url: z.ZodURL;
+        sends: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
+        returns: z.ZodRecord<z.ZodString, z.ZodString>;
+    }, z.core.$strip>>>;
+    entry: z.ZodDefault<z.ZodString>;
+}, z.core.$strip>;
+export type UiManifest = z.infer<typeof UiManifest>;
+export declare const Developer: z.ZodObject<{
+    name: z.ZodString;
+    email: z.ZodEmail;
+    website: z.ZodOptional<z.ZodURL>;
+}, z.core.$strip>;
+export declare const Visibility: z.ZodEnum<{
+    private: "private";
+    public: "public";
+}>;
+export type Visibility = z.infer<typeof Visibility>;
+export declare const ManifestV1: z.ZodObject<{
+    manifestVersion: z.ZodLiteral<1>;
+    id: z.ZodString;
+    name: z.ZodString;
+    version: z.ZodString;
+    summary: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    developer: z.ZodObject<{
+        name: z.ZodString;
+        email: z.ZodEmail;
+        website: z.ZodOptional<z.ZodURL>;
+    }, z.core.$strip>;
+    visibility: z.ZodDefault<z.ZodEnum<{
+        private: "private";
+        public: "public";
+    }>>;
+    scopes: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+        "contacts:read": "contacts:read";
+        "contacts:write": "contacts:write";
+        "companies:read": "companies:read";
+        "companies:write": "companies:write";
+        "leads:read": "leads:read";
+        "leads:write": "leads:write";
+        "deals:read": "deals:read";
+        "deals:write": "deals:write";
+        "notes:write": "notes:write";
+        "actions:write": "actions:write";
+        "loops:read": "loops:read";
+        "loops:write": "loops:write";
+        "calls:read": "calls:read";
+        "meetings:read": "meetings:read";
+        "webhooks:manage": "webhooks:manage";
+    }>>>;
+    sync: z.ZodOptional<z.ZodObject<{
+        baseUrl: z.ZodURL;
+        auth: z.ZodDiscriminatedUnion<[z.ZodObject<{
+            type: z.ZodLiteral<"oauth2">;
+            authorizeUrl: z.ZodURL;
+            tokenUrl: z.ZodURL;
+            scopes: z.ZodDefault<z.ZodArray<z.ZodString>>;
+            refresh: z.ZodDefault<z.ZodBoolean>;
+        }, z.core.$strip>, z.ZodObject<{
+            type: z.ZodLiteral<"apiKey">;
+            header: z.ZodDefault<z.ZodString>;
+            prefix: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>], "type">;
+        objects: z.ZodArray<z.ZodObject<{
+            theirs: z.ZodString;
+            ours: z.ZodEnum<{
+                CONTACT: "CONTACT";
+                COMPANY: "COMPANY";
+                LEAD: "LEAD";
+                DEAL: "DEAL";
+            }>;
+            list: z.ZodObject<{
+                path: z.ZodString;
+                itemsPath: z.ZodDefault<z.ZodString>;
+                cursorParam: z.ZodOptional<z.ZodString>;
+                nextCursorPath: z.ZodOptional<z.ZodString>;
+                updatedSinceParam: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>;
+            fields: z.ZodArray<z.ZodObject<{
+                theirs: z.ZodString;
+                ours: z.ZodString;
+                owner: z.ZodEnum<{
+                    theirs: "theirs";
+                    ours: "ours";
+                }>;
+            }, z.core.$strip>>;
+            match: z.ZodDefault<z.ZodArray<z.ZodString>>;
+        }, z.core.$strip>>;
+        links: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            from: z.ZodEnum<{
+                CONTACT: "CONTACT";
+                COMPANY: "COMPANY";
+                LEAD: "LEAD";
+                DEAL: "DEAL";
+            }>;
+            to: z.ZodEnum<{
+                CONTACT: "CONTACT";
+                COMPANY: "COMPANY";
+                LEAD: "LEAD";
+                DEAL: "DEAL";
+            }>;
+            theirs: z.ZodString;
+            role: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
+        changeFeed: z.ZodObject<{
+            webhook: z.ZodOptional<z.ZodObject<{
+                signature: z.ZodObject<{
+                    scheme: z.ZodEnum<{
+                        "hmac-sha256": "hmac-sha256";
+                        "hmac-sha1": "hmac-sha1";
+                    }>;
+                    header: z.ZodString;
+                }, z.core.$strip>;
+            }, z.core.$strip>>;
+            polling: z.ZodOptional<z.ZodObject<{
+                everyMinutes: z.ZodNumber;
+            }, z.core.$strip>>;
+        }, z.core.$strip>;
+        writeBack: z.ZodDefault<z.ZodRecord<z.ZodEnum<{
+            call: "call";
+            transcript: "transcript";
+            meeting: "meeting";
+            note: "note";
+            action: "action";
+            campaignReply: "campaignReply";
+        }> & z.core.$partial, z.ZodObject<{
+            method: z.ZodEnum<{
+                POST: "POST";
+                PUT: "PUT";
+                PATCH: "PATCH";
+            }>;
+            path: z.ZodString;
+        }, z.core.$strip>>>;
+        limits: z.ZodObject<{
+            requestsPerSecond: z.ZodNumber;
+            burst: z.ZodOptional<z.ZodNumber>;
+            retryAfterHeader: z.ZodDefault<z.ZodString>;
+        }, z.core.$strip>;
+    }, z.core.$strip>>;
+    ui: z.ZodOptional<z.ZodObject<{
+        apiVersion: z.ZodLiteral<1>;
+        slots: z.ZodArray<z.ZodEnum<{
+            recordPanel: "recordPanel";
+            recordTab: "recordTab";
+            recordAction: "recordAction";
+            bulkAction: "bulkAction";
+            composerButton: "composerButton";
+            messageAction: "messageAction";
+            loopCard: "loopCard";
+            linkCard: "linkCard";
+            crmPanelItem: "crmPanelItem";
+            settingsPage: "settingsPage";
+            dashboardTile: "dashboardTile";
+            simiTool: "simiTool";
+        }>>;
+        uses: z.ZodDefault<z.ZodArray<z.ZodString>>;
+        does: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+            "record.note": "record.note";
+            "loop.post": "loop.post";
+            "action.add": "action.add";
+        }>>>;
+        hears: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+            "contact.created": "contact.created";
+            "contact.updated": "contact.updated";
+            "contact.deleted": "contact.deleted";
+            "company.created": "company.created";
+            "company.updated": "company.updated";
+            "company.deleted": "company.deleted";
+            "lead.created": "lead.created";
+            "lead.updated": "lead.updated";
+            "lead.deleted": "lead.deleted";
+            "deal.created": "deal.created";
+            "deal.updated": "deal.updated";
+            "deal.deleted": "deal.deleted";
+            "loop.message": "loop.message";
+            "loop.call.ended": "loop.call.ended";
+            "meeting.ended": "meeting.ended";
+            "app.installed": "app.installed";
+            "app.uninstalled": "app.uninstalled";
+        }>>>;
+        links: z.ZodDefault<z.ZodArray<z.ZodString>>;
+        settings: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodDiscriminatedUnion<[z.ZodObject<{
+            type: z.ZodLiteral<"secret">;
+            label: z.ZodString;
+        }, z.core.$strip>, z.ZodObject<{
+            type: z.ZodLiteral<"text">;
+            label: z.ZodString;
+        }, z.core.$strip>, z.ZodObject<{
+            type: z.ZodLiteral<"choice">;
+            label: z.ZodString;
+            options: z.ZodArray<z.ZodString>;
+        }, z.core.$strip>], "type">>>;
+        endpoints: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodObject<{
+            method: z.ZodEnum<{
+                POST: "POST";
+                PUT: "PUT";
+                PATCH: "PATCH";
+                GET: "GET";
+                DELETE: "DELETE";
+            }>;
+            url: z.ZodURL;
+            sends: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
+            returns: z.ZodRecord<z.ZodString, z.ZodString>;
+        }, z.core.$strip>>>;
+        entry: z.ZodDefault<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type ManifestV1 = z.infer<typeof ManifestV1>;
+export type ManifestV1Input = z.input<typeof ManifestV1>;
+/** The manifest file name in an app folder. */
+export declare const MANIFEST_FILE = "loops.manifest.json";
+/** Parse a manifest; errors come back as plain lines ("ui.uses.0: Reading contact.email needs the contacts:read scope"). */
+export declare function parseManifest(input: unknown): {
+    ok: true;
+    manifest: ManifestV1;
+} | {
+    ok: false;
+    errors: string[];
+};