@sendbird/cli 0.0.0-stage → 0.3.0-alpha.1

package/dist/presentation.d.ts

@@ -0,0 +1,208 @@
+export type OperationEffect = "read" | "mutation" | "local" | "sdk-read" | "stream";
+type Context = {
+    command: string;
+    effect: OperationEffect;
+    value: unknown;
+    appId?: string;
+    orgId?: string;
+    actorId?: string;
+    params?: Record<string, unknown>;
+    dryRun?: boolean;
+};
+/** The --json stdout schema wraps the command's underlying result schema. */
+export declare function operationSchema(resultSchema: Record<string, unknown>, effect: OperationEffect): {
+    type: string;
+    required: string[];
+    properties: {
+        ok: {
+            const: boolean;
+        };
+        command: {
+            type: string;
+        };
+        effect: {
+            const: OperationEffect;
+        };
+        status: {
+            enum: string[];
+        };
+        target: {
+            type: string;
+            properties: {
+                app_id: {
+                    type: string;
+                };
+                org_id: {
+                    type: string;
+                };
+                channel_url: {
+                    type: string;
+                };
+                channel_type: {
+                    enum: string[];
+                };
+                user_id: {
+                    type: string;
+                };
+                actor_user_id: {
+                    type: string;
+                };
+                message_id: {
+                    type: string;
+                };
+            };
+            additionalProperties: boolean;
+        };
+        result: {
+            anyOf: Record<string, unknown>[];
+        };
+        response: {
+            enum: string[];
+        };
+    };
+    additionalProperties: boolean;
+};
+/** Each watch stdout line is either an event or the terminal operation result. */
+export declare function stdoutSchema(resultSchema: Record<string, unknown>, effect: OperationEffect): {
+    type: string;
+    required: string[];
+    properties: {
+        ok: {
+            const: boolean;
+        };
+        command: {
+            type: string;
+        };
+        effect: {
+            const: OperationEffect;
+        };
+        status: {
+            enum: string[];
+        };
+        target: {
+            type: string;
+            properties: {
+                app_id: {
+                    type: string;
+                };
+                org_id: {
+                    type: string;
+                };
+                channel_url: {
+                    type: string;
+                };
+                channel_type: {
+                    enum: string[];
+                };
+                user_id: {
+                    type: string;
+                };
+                actor_user_id: {
+                    type: string;
+                };
+                message_id: {
+                    type: string;
+                };
+            };
+            additionalProperties: boolean;
+        };
+        result: {
+            anyOf: Record<string, unknown>[];
+        };
+        response: {
+            enum: string[];
+        };
+    };
+    additionalProperties: boolean;
+} | {
+    anyOf: ({
+        type: string;
+        required: string[];
+        properties: {
+            ok: {
+                const: boolean;
+            };
+            command: {
+                type: string;
+            };
+            effect: {
+                const: OperationEffect;
+            };
+            status: {
+                enum: string[];
+            };
+            target: {
+                type: string;
+                properties: {
+                    app_id: {
+                        type: string;
+                    };
+                    org_id: {
+                        type: string;
+                    };
+                    channel_url: {
+                        type: string;
+                    };
+                    channel_type: {
+                        enum: string[];
+                    };
+                    user_id: {
+                        type: string;
+                    };
+                    actor_user_id: {
+                        type: string;
+                    };
+                    message_id: {
+                        type: string;
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            result: {
+                anyOf: Record<string, unknown>[];
+            };
+            response: {
+                enum: string[];
+            };
+        };
+        additionalProperties: boolean;
+    } | {
+        type: string;
+        required: string[];
+        properties: {
+            ok: {
+                const: boolean;
+            };
+            type: {
+                const: string;
+            };
+            command: {
+                type: string;
+            };
+            event: {
+                type: string;
+                additionalProperties: boolean;
+            };
+        };
+        additionalProperties: boolean;
+    })[];
+};
+export declare function operationResult(context: Context): {
+    ok: true;
+    command: string;
+    effect: OperationEffect;
+    status: string;
+    target: {
+        message_id?: number | undefined;
+        actor_user_id?: string | undefined;
+        user_id?: string | undefined;
+        channel_type?: unknown;
+        channel_url?: string | undefined;
+        org_id?: string | undefined;
+        app_id?: string | undefined;
+    };
+    result: {} | null;
+    response: string;
+};
+export type OperationResult = ReturnType<typeof operationResult>;
+export { humanEvent, humanFailure, humanOperation, humanValue, } from "./human-output.js";

package/dist/presentation.js

@@ -0,0 +1,156 @@
+/** The --json stdout schema wraps the command's underlying result schema. */
+export function operationSchema(resultSchema, effect) {
+    const normalStatus = effect === "mutation"
+        ? "accepted"
+        : effect === "stream"
+            ? "completed"
+            : effect === "local"
+                ? "succeeded"
+                : "verified";
+    return {
+        type: "object",
+        required: [
+            "ok",
+            "command",
+            "effect",
+            "status",
+            "target",
+            "result",
+            "response",
+        ],
+        properties: {
+            ok: { const: true },
+            command: { type: "string" },
+            effect: { const: effect },
+            status: { enum: [normalStatus, "preview"] },
+            target: {
+                type: "object",
+                properties: {
+                    app_id: { type: "string" },
+                    org_id: { type: "string" },
+                    channel_url: { type: "string" },
+                    channel_type: { enum: ["open", "group", "supergroup"] },
+                    user_id: { type: "string" },
+                    actor_user_id: { type: "string" },
+                    message_id: { type: "number" },
+                },
+                additionalProperties: false,
+            },
+            result: {
+                anyOf: [
+                    resultSchema,
+                    {
+                        type: "object",
+                        required: ["dry_run"],
+                        properties: { dry_run: { const: true } },
+                        additionalProperties: true,
+                    },
+                    { type: "null" },
+                ],
+            },
+            response: { enum: ["data", "empty"] },
+        },
+        additionalProperties: false,
+    };
+}
+/** Each watch stdout line is either an event or the terminal operation result. */
+export function stdoutSchema(resultSchema, effect) {
+    const terminal = operationSchema(resultSchema, effect);
+    if (effect !== "stream")
+        return terminal;
+    return {
+        anyOf: [
+            {
+                type: "object",
+                required: ["ok", "type", "command", "event"],
+                properties: {
+                    ok: { const: true },
+                    type: { const: "event" },
+                    command: { type: "string" },
+                    event: { type: "object", additionalProperties: true },
+                },
+                additionalProperties: false,
+            },
+            terminal,
+        ],
+    };
+}
+function target({ command, appId, orgId, actorId, params, value, dryRun, }) {
+    const result = value && typeof value === "object"
+        ? value
+        : {};
+    const channelScoped = /\b(channel|message|poll)\b/.test(command) ||
+        command.startsWith("chat sdk report ");
+    const userScoped = /\buser\b/.test(command);
+    const channelUrl = result.channel_url ?? (channelScoped ? params?.id : undefined);
+    const explicitUser = typeof params?.user_id === "string" ? params.user_id : undefined;
+    const moderationUser = command.startsWith("chat moderation channel ")
+        ? result.user && typeof result.user === "object"
+            ? result.user.user_id
+            : undefined
+        : undefined;
+    const userId = explicitUser ??
+        moderationUser ??
+        (dryRun && actorId ? undefined : result.user_id) ??
+        (userScoped ? params?.id : undefined) ??
+        (command.startsWith("chat sdk user ") ? actorId : undefined);
+    const application = result.application;
+    const createdOrg = Array.isArray(result.organizations)
+        ? result.organizations[0]
+        : undefined;
+    const resultAppId = result.app_id ?? application?.app_id;
+    const resultOrgId = result.org_id ?? result.organization_uid ?? result.uid ?? createdOrg?.uid;
+    const messageId = result.message_id ?? params?.message_id;
+    const targetAppId = command.startsWith("calls credits ")
+        ? undefined
+        : command === "app create"
+            ? (resultAppId ?? appId)
+            : (appId ?? resultAppId);
+    const targetOrgId = command === "org create" ? (resultOrgId ?? orgId) : (orgId ?? resultOrgId);
+    return {
+        ...(command.startsWith("org ") || command === "app list"
+            ? {}
+            : typeof targetAppId === "string"
+                ? { app_id: targetAppId }
+                : {}),
+        ...(command === "org list"
+            ? {}
+            : typeof targetOrgId === "string"
+                ? { org_id: targetOrgId }
+                : {}),
+        ...(typeof channelUrl === "string" ? { channel_url: channelUrl } : {}),
+        ...(channelScoped &&
+            ["open", "group", "supergroup"].includes(String(params?.type))
+            ? { channel_type: params?.type }
+            : {}),
+        ...(typeof userId === "string" ? { user_id: userId } : {}),
+        ...(typeof actorId === "string" ? { actor_user_id: actorId } : {}),
+        ...(typeof messageId === "number" ? { message_id: messageId } : {}),
+    };
+}
+export function operationResult(context) {
+    const empty = context.value === null ||
+        context.value === undefined ||
+        (typeof context.value === "object" &&
+            !Array.isArray(context.value) &&
+            Object.keys(context.value).length === 0);
+    return {
+        ok: true,
+        command: `sendbird ${context.command}`,
+        effect: context.effect,
+        status: context.dryRun
+            ? "preview"
+            : context.effect === "mutation"
+                ? "accepted"
+                : context.effect === "stream"
+                    ? "completed"
+                    : context.effect === "local"
+                        ? "succeeded"
+                        : "verified",
+        target: target(context),
+        result: context.value ?? null,
+        response: empty ? "empty" : "data",
+    };
+}
+export { humanEvent, humanFailure, humanOperation, humanValue, } from "./human-output.js";
+//# sourceMappingURL=presentation.js.map

package/dist/presentation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"presentation.js","sourceRoot":"","sources":["../src/presentation.ts"],"names":[],"mappings":"AAcA,6EAA6E;AAC7E,MAAM,UAAU,eAAe,CAC7B,YAAqC,EACrC,MAAuB;IAEvB,MAAM,YAAY,GAChB,MAAM,KAAK,UAAU;QACnB,CAAC,CAAC,UAAU;QACZ,CAAC,CAAC,MAAM,KAAK,QAAQ;YACnB,CAAC,CAAC,WAAW;YACb,CAAC,CAAC,MAAM,KAAK,OAAO;gBAClB,CAAC,CAAC,WAAW;gBACb,CAAC,CAAC,UAAU,CAAC;IACrB,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE;YACR,IAAI;YACJ,SAAS;YACT,QAAQ;YACR,QAAQ;YACR,QAAQ;YACR,QAAQ;YACR,UAAU;SACX;QACD,UAAU,EAAE;YACV,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE;YACnB,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;YAC3B,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE;YACzB,MAAM,EAAE,EAAE,IAAI,EAAE,CAAC,YAAY,EAAE,SAAS,CAAC,EAAE;YAC3C,MAAM,EAAE;gBACN,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;oBAC1B,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;oBAC1B,WAAW,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;oBAC/B,YAAY,EAAE,EAAE,IAAI,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,YAAY,CAAC,EAAE;oBACvD,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;oBAC3B,aAAa,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;oBACjC,UAAU,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;iBAC/B;gBACD,oBAAoB,EAAE,KAAK;aAC5B;YACD,MAAM,EAAE;gBACN,KAAK,EAAE;oBACL,YAAY;oBACZ;wBACE,IAAI,EAAE,QAAQ;wBACd,QAAQ,EAAE,CAAC,SAAS,CAAC;wBACrB,UAAU,EAAE,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;wBACxC,oBAAoB,EAAE,IAAI;qBAC3B;oBACD,EAAE,IAAI,EAAE,MAAM,EAAE;iBACjB;aACF;YACD,QAAQ,EAAE,EAAE,IAAI,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE;SACtC;QACD,oBAAoB,EAAE,KAAK;KAC5B,CAAC;AACJ,CAAC;AAED,kFAAkF;AAClF,MAAM,UAAU,YAAY,CAC1B,YAAqC,EACrC,MAAuB;IAEvB,MAAM,QAAQ,GAAG,eAAe,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;IACvD,IAAI,MAAM,KAAK,QAAQ;QAAE,OAAO,QAAQ,CAAC;IACzC,OAAO;QACL,KAAK,EAAE;YACL;gBACE,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC;gBAC5C,UAAU,EAAE;oBACV,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE;oBACnB,IAAI,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE;oBACxB,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;oBAC3B,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,oBAAoB,EAAE,IAAI,EAAE;iBACtD;gBACD,oBAAoB,EAAE,KAAK;aAC5B;YACD,QAAQ;SACT;KACF,CAAC;AACJ,CAAC;AAED,SAAS,MAAM,CAAC,EACd,OAAO,EACP,KAAK,EACL,KAAK,EACL,OAAO,EACP,MAAM,EACN,KAAK,EACL,MAAM,GACE;IACR,MAAM,MAAM,GACV,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;QAChC,CAAC,CAAE,KAAiC;QACpC,CAAC,CAAC,EAAE,CAAC;IACT,MAAM,aAAa,GACjB,4BAA4B,CAAC,IAAI,CAAC,OAAO,CAAC;QAC1C,OAAO,CAAC,UAAU,CAAC,kBAAkB,CAAC,CAAC;IACzC,MAAM,UAAU,GAAG,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC5C,MAAM,UAAU,GACd,MAAM,CAAC,WAAW,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IACjE,MAAM,YAAY,GAChB,OAAO,MAAM,EAAE,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;IACnE,MAAM,cAAc,GAAG,OAAO,CAAC,UAAU,CAAC,0BAA0B,CAAC;QACnE,CAAC,CAAC,MAAM,CAAC,IAAI,IAAI,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ;YAC9C,CAAC,CAAE,MAAM,CAAC,IAAgC,CAAC,OAAO;YAClD,CAAC,CAAC,SAAS;QACb,CAAC,CAAC,SAAS,CAAC;IACd,MAAM,MAAM,GACV,YAAY;QACZ,cAAc;QACd,CAAC,MAAM,IAAI,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC;QAChD,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACrC,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IAC/D,MAAM,WAAW,GAAG,MAAM,CAAC,WAAkD,CAAC;IAC9E,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC;QACpD,CAAC,CAAE,MAAM,CAAC,aAAa,CAAC,CAAC,CAAyC;QAClE,CAAC,CAAC,SAAS,CAAC;IACd,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,IAAI,WAAW,EAAE,MAAM,CAAC;IACzD,MAAM,WAAW,GACf,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,gBAAgB,IAAI,MAAM,CAAC,GAAG,IAAI,UAAU,EAAE,GAAG,CAAC;IAC5E,MAAM,SAAS,GAAG,MAAM,CAAC,UAAU,IAAI,MAAM,EAAE,UAAU,CAAC;IAC1D,MAAM,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC,gBAAgB,CAAC;QACtD,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,OAAO,KAAK,YAAY;YACxB,CAAC,CAAC,CAAC,WAAW,IAAI,KAAK,CAAC;YACxB,CAAC,CAAC,CAAC,KAAK,IAAI,WAAW,CAAC,CAAC;IAC7B,MAAM,WAAW,GACf,OAAO,KAAK,YAAY,CAAC,CAAC,CAAC,CAAC,WAAW,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,WAAW,CAAC,CAAC;IAC7E,OAAO;QACL,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,OAAO,KAAK,UAAU;YACtD,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,OAAO,WAAW,KAAK,QAAQ;gBAC/B,CAAC,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE;gBACzB,CAAC,CAAC,EAAE,CAAC;QACT,GAAG,CAAC,OAAO,KAAK,UAAU;YACxB,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,OAAO,WAAW,KAAK,QAAQ;gBAC/B,CAAC,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE;gBACzB,CAAC,CAAC,EAAE,CAAC;QACT,GAAG,CAAC,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACtE,GAAG,CAAC,aAAa;YACjB,CAAC,MAAM,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YAC5D,CAAC,CAAC,EAAE,YAAY,EAAE,MAAM,EAAE,IAAI,EAAE;YAChC,CAAC,CAAC,EAAE,CAAC;QACP,GAAG,CAAC,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC1D,GAAG,CAAC,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAClE,GAAG,CAAC,OAAO,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACpE,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,OAAgB;IAC9C,MAAM,KAAK,GACT,OAAO,CAAC,KAAK,KAAK,IAAI;QACtB,OAAO,CAAC,KAAK,KAAK,SAAS;QAC3B,CAAC,OAAO,OAAO,CAAC,KAAK,KAAK,QAAQ;YAChC,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC;YAC7B,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;IAC7C,OAAO;QACL,EAAE,EAAE,IAAa;QACjB,OAAO,EAAE,YAAY,OAAO,CAAC,OAAO,EAAE;QACtC,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,MAAM,EAAE,OAAO,CAAC,MAAM;YACpB,CAAC,CAAC,SAAS;YACX,CAAC,CAAC,OAAO,CAAC,MAAM,KAAK,UAAU;gBAC7B,CAAC,CAAC,UAAU;gBACZ,CAAC,CAAC,OAAO,CAAC,MAAM,KAAK,QAAQ;oBAC3B,CAAC,CAAC,WAAW;oBACb,CAAC,CAAC,OAAO,CAAC,MAAM,KAAK,OAAO;wBAC1B,CAAC,CAAC,WAAW;wBACb,CAAC,CAAC,UAAU;QACpB,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC;QACvB,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI,IAAI;QAC7B,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM;KACnC,CAAC;AACJ,CAAC;AAGD,OAAO,EACL,UAAU,EACV,YAAY,EACZ,cAAc,EACd,UAAU,GACX,MAAM,mBAAmB,CAAC"}

package/dist/pro-api-catalog.d.ts

@@ -0,0 +1,24 @@
+/** Dashboard-backed Pro operations. All traffic uses Gate OAuth and App-Id. */
+import { z } from "zod";
+export declare const proApiDefinitions: {
+    resultSchema?: z.ZodType;
+    response: z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
+    description: string;
+    name: string;
+    method: string;
+    path: string;
+    scope?: "app" | "org";
+    requiresOrg?: boolean;
+    params?: z.ZodObject;
+    query?: z.ZodObject;
+    body?: z.ZodObject;
+    multipart?: boolean;
+    danger?: boolean;
+    secret?: boolean;
+    privateFields?: string[];
+    source: [string, string];
+    example?: Record<string, unknown>;
+    exampleParams?: Record<string, unknown>;
+    exampleQuery?: Record<string, unknown>;
+    defaults?: Record<string, unknown>;
+}[];