@pingroom/sdk 0.7.1 → 0.9.0

package/dist/types/rooms.d.ts

@@ -0,0 +1,163 @@
+/**
+ * The detail every press of a quick action must carry. `location` needs
+ * `data.location`, `link` needs `data.url`, `file`/`photo`/`pdf` need
+ * `attachment_ids` (photo: jpg/png only, pdf: pdf only). A press without it is
+ * refused with `422 quick_action_input_required` and nothing is sent.
+ */
+export type QuickActionInputType = 'none' | 'location' | 'link' | 'file' | 'photo' | 'pdf';
+export interface QuickActionInput {
+    action_number: number;
+    label: string;
+    /**
+     * Emoji or icon id. Sending `label` and `icon` both empty reserves the slot
+     * as disabled: it stays in the layout and a press answers `404
+     * action_not_configured`.
+     */
+    icon: string;
+    sound?: string | null;
+    haptic_style?: string | null;
+    /** Every fire of this reusable action opens the acknowledgement lifecycle. */
+    requires_ack?: boolean;
+    /** Omit to keep the stored value; new slots default to `none`. */
+    input_type?: QuickActionInputType;
+}
+/**
+ * Body of `actions.updateLayout()`. `page_order` lists the new page positions:
+ * each entry is the ORIGINAL page number (1–4) to keep at that index, or
+ * `null` for a fresh blank page; original pages absent from the list are
+ * deleted. `actions` is the full renumbered 4–16 set. `base_action_ids` is
+ * every stored action id in `action_number` order as last read — a stale
+ * snapshot is refused with `409 quick_action_layout_changed`.
+ */
+export interface UpdateQuickActionLayoutInput {
+    base_action_ids: string[];
+    page_order: Array<number | null>;
+    actions: QuickActionInput[];
+}
+export interface CreateRoomInput {
+    name: string;
+    icon: string;
+    color: string;
+}
+export interface CreatePublicRoomInput extends CreateRoomInput {
+    handle: string;
+    description?: string;
+    everyone_can_trigger?: boolean;
+    is_password_protected?: boolean;
+    password?: string;
+    actions?: QuickActionInput[];
+    category?: string;
+    show_owner?: boolean;
+    /**
+     * Public-room location for nearby discovery. Send all three or none —
+     * `createPublic()` rejects a partial trio locally, the server with a 422.
+     */
+    location_name?: string;
+    location_latitude?: number;
+    location_longitude?: number;
+}
+export interface JoinRoomInput {
+    invite_code: string;
+    password?: string;
+}
+export interface UpdateQuickActionInput {
+    /**
+     * The Ping's title. Must be sent, but may be `''` — a Ping can be named by
+     * its emoji alone, and the app renders an untitled one as just the emoji.
+     */
+    label: string;
+    icon: string;
+    sound?: string | null;
+    haptic_style?: string | null;
+    /** Every fire of this reusable action opens the acknowledgement lifecycle. */
+    requires_ack?: boolean;
+    /** Omit to keep the stored value. */
+    input_type?: QuickActionInputType;
+}
+export interface QuickAction {
+    id?: string;
+    action_number: number;
+    label: string;
+    icon: string;
+    sound?: string | null;
+    haptic_style?: string | null;
+    /** Every fire of this reusable action opens the acknowledgement lifecycle. */
+    requires_ack?: boolean;
+    /** Missing on pre-2026-09-16 rows; treat absent as `none`. */
+    input_type?: QuickActionInputType;
+    [key: string]: unknown;
+}
+export interface Room {
+    id: string;
+    name: string;
+    icon: string | null;
+    color: string | null;
+    invite_code: string;
+    is_public?: boolean;
+    handle?: string | null;
+    quick_actions?: QuickAction[];
+    /** 4, or 16 while the room owner is Pro. */
+    quick_action_limit?: 4 | 16;
+    /** Every stored slot, including pages hidden by a lapsed Pro. */
+    quick_action_count?: number;
+    location_name?: string | null;
+    location_latitude?: number | null;
+    location_longitude?: number | null;
+    [key: string]: unknown;
+}
+/** Catalog ids accepted by room and webhook creation. */
+export interface RoomIconCatalog {
+    version: number;
+    base_url: string;
+    categories: Array<{
+        id: string;
+        label: string;
+        icons: string[];
+    }>;
+    icons: Record<string, {
+        file: string;
+        tags: string[];
+    }>;
+}
+export interface CreateWebhookInput {
+    name: string;
+    title?: string | null;
+    message?: string | null;
+    emoji?: string | null;
+    icon?: string | null;
+    color?: string | null;
+    sound?: string | null;
+    haptic?: string | null;
+    /** Optional Quick Ping preset. Omit or use null for an independent webhook. */
+    action_number?: number | null;
+    enabled?: boolean;
+    cooldown_seconds?: number;
+}
+export interface UpdateWebhookInput extends Partial<CreateWebhookInput> {
+    /** Rotate the trigger URL; the previous URL stops working. */
+    regenerate_secret?: boolean;
+}
+/** Incoming webhook configuration. The trigger URL contains its credential. */
+export interface Webhook {
+    id: string;
+    room_id: string;
+    name: string;
+    title: string | null;
+    message: string | null;
+    emoji: string | null;
+    icon: string | null;
+    color: string | null;
+    sound: string | null;
+    haptic: string | null;
+    /** Null when the webhook uses its own content without a Quick Ping preset. */
+    action_number: number | null;
+    enabled: boolean;
+    cooldown_seconds: number;
+    trigger_count: number;
+    last_triggered_at?: string | null;
+    webhook_url: string;
+    created_at: string;
+    updated_at: string;
+    [key: string]: unknown;
+}
+//# sourceMappingURL=rooms.d.ts.map

package/dist/types/rooms.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rooms.d.ts","sourceRoot":"","sources":["../../src/types/rooms.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC;AAE3F,MAAM,WAAW,gBAAgB;IAC/B,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,8EAA8E;IAC9E,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,kEAAkE;IAClE,UAAU,CAAC,EAAE,oBAAoB,CAAC;CACnC;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,4BAA4B;IAC3C,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,UAAU,EAAE,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IACjC,OAAO,EAAE,gBAAgB,EAAE,CAAC;CAC7B;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,qBAAsB,SAAQ,eAAe;IAC5D,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,aAAa;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,8EAA8E;IAC9E,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,qCAAqC;IACrC,UAAU,CAAC,EAAE,oBAAoB,CAAC;CACnC;AAED,MAAM,WAAW,WAAW;IAC1B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,8EAA8E;IAC9E,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,8DAA8D;IAC9D,UAAU,CAAC,EAAE,oBAAoB,CAAC;IAClC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,IAAI;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,aAAa,CAAC,EAAE,WAAW,EAAE,CAAC;IAC9B,4CAA4C;IAC5C,kBAAkB,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC;IAC5B,iEAAiE;IACjE,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,yDAAyD;AACzD,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,KAAK,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC,CAAC;IAClE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC,CAAC;CACzD;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,+EAA+E;IAC/E,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,kBAAmB,SAAQ,OAAO,CAAC,kBAAkB,CAAC;IACrE,8DAA8D;IAC9D,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED,+EAA+E;AAC/E,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,8EAA8E;IAC9E,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,OAAO,EAAE,OAAO,CAAC;IACjB,gBAAgB,EAAE,MAAM,CAAC;IACzB,aAAa,EAAE,MAAM,CAAC;IACtB,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB"}

package/dist/types/rooms.js

@@ -0,0 +1,3 @@
+// --- rooms & quick actions ------------------------------------------------
+export {};
+//# sourceMappingURL=rooms.js.map

package/dist/types/rooms.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rooms.js","sourceRoot":"","sources":["../../src/types/rooms.ts"],"names":[],"mappings":"AAAA,6EAA6E"}