js-bao-wss-client 2.0.3 → 2.0.5

package/dist/api/notificationsApi.js

@@ -0,0 +1,52 @@
+// ── API ──
+/**
+ * Sub-API for the notification inbox (`client.notifications.*`).
+ *
+ * Inbox reads/writes act on the signed-in user's own notifications. `send()`
+ * requires app admin permission. Live updates arrive as the `notification`
+ * client event (`client.on("notification", ...)`).
+ */
+export class NotificationsAPI {
+    constructor(client) {
+        this.client = client;
+    }
+    /** List the caller's notifications, newest first. */
+    async list(options) {
+        const params = new URLSearchParams();
+        if (options?.limit !== undefined)
+            params.set("limit", String(options.limit));
+        if (options?.cursor)
+            params.set("cursor", options.cursor);
+        const query = params.toString() ? `?${params.toString()}` : "";
+        return this.client.makeRequest("GET", `/notifications${query}`);
+    }
+    /** Count the caller's unread notifications. */
+    async unreadCount() {
+        return this.client.makeRequest("GET", "/notifications/unread-count");
+    }
+    /** Mark one of the caller's notifications as read. */
+    async markRead(notificationId) {
+        return this.client.makeRequest("PATCH", `/notifications/${encodeURIComponent(notificationId)}/read`, {});
+    }
+    /** Mark all of the caller's notifications as read. */
+    async markAllRead() {
+        return this.client.makeRequest("POST", "/notifications/read-all", {});
+    }
+    /** Send a notification to an app user (requires app admin permission). */
+    async send(params) {
+        return this.client.makeRequest("POST", "/notifications/send", params);
+    }
+    /** Register (upsert) the calling user's device push token. */
+    async registerDevice(params) {
+        return this.client.makeRequest("POST", "/me/push-tokens", params);
+    }
+    /** List the calling user's registered push devices. */
+    async listDevices() {
+        return this.client.makeRequest("GET", "/me/push-tokens");
+    }
+    /** Unregister one of the calling user's device push tokens (e.g. on logout). */
+    async unregisterDevice(token) {
+        return this.client.makeRequest("DELETE", `/me/push-tokens/${encodeURIComponent(token)}`);
+    }
+}
+//# sourceMappingURL=notificationsApi.js.map

package/dist/api/notificationsApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notificationsApi.js","sourceRoot":"","sources":["../../api/notificationsApi.ts"],"names":[],"mappings":"AAuGA,YAAY;AAEZ;;;;;;GAMG;AACH,MAAM,OAAO,gBAAgB;IAC3B,YAA6B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAG,CAAC;IAEpD,qDAAqD;IACrD,KAAK,CAAC,IAAI,CACR,OAAiC;QAEjC,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;QACrC,IAAI,OAAO,EAAE,KAAK,KAAK,SAAS;YAAE,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;QAC7E,IAAI,OAAO,EAAE,MAAM;YAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;QAC1D,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/D,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAC5B,KAAK,EACL,iBAAiB,KAAK,EAAE,CACU,CAAC;IACvC,CAAC;IAED,+CAA+C;IAC/C,KAAK,CAAC,WAAW;QACf,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAC5B,KAAK,EACL,6BAA6B,CACM,CAAC;IACxC,CAAC;IAED,sDAAsD;IACtD,KAAK,CAAC,QAAQ,CAAC,cAAsB;QACnC,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAC5B,OAAO,EACP,kBAAkB,kBAAkB,CAAC,cAAc,CAAC,OAAO,EAC3D,EAAE,CAC0B,CAAC;IACjC,CAAC;IAED,sDAAsD;IACtD,KAAK,CAAC,WAAW;QACf,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAC5B,MAAM,EACN,yBAAyB,EACzB,EAAE,CAC6B,CAAC;IACpC,CAAC;IAED,0EAA0E;IAC1E,KAAK,CAAC,IAAI,CAAC,MAA8B;QAOvC,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,qBAAqB,EAAE,MAAM,CAIlE,CAAC;IACL,CAAC;IAED,8DAA8D;IAC9D,KAAK,CAAC,cAAc,CAClB,MAAgC;QAEhC,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAC5B,MAAM,EACN,iBAAiB,EACjB,MAAM,CACoB,CAAC;IAC/B,CAAC;IAED,uDAAuD;IACvD,KAAK,CAAC,WAAW;QACf,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,KAAK,EAAE,iBAAiB,CAErD,CAAC;IACL,CAAC;IAED,gFAAgF;IAChF,KAAK,CAAC,gBAAgB,CAAC,KAAa;QAClC,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAC5B,QAAQ,EACR,mBAAmB,kBAAkB,CAAC,KAAK,CAAC,EAAE,CACd,CAAC;IACrC,CAAC;CACF"}

package/dist/api/resourceMetadataApi.d.ts

@@ -0,0 +1,163 @@
+import type { JsBaoClient } from "../JsBaoClient";
+/**
+ * Result of a single-category metadata read (`resourceMetadata.get`). When no
+ * row has been written yet the read still succeeds with `exists: false` and an
+ * empty `data` object.
+ */
+export interface ResourceMetadataReadResult {
+    resourceType: string;
+    resourceId: string;
+    category: string;
+    /** The stored metadata object (`{}` when nothing has been written yet). */
+    data: Record<string, unknown>;
+    /** Schema version the stored data was validated against (`null` when `exists` is false). */
+    schemaVersion: number | null;
+    /** Whether a stored row exists for this resource and category. */
+    exists: boolean;
+}
+/** Result of a metadata write (`resourceMetadata.set` — a full replace). */
+export interface ResourceMetadataWriteResult {
+    resourceType: string;
+    resourceId: string;
+    category: string;
+    /** The stored metadata object as validated and persisted. */
+    data: Record<string, unknown>;
+    /** Schema version the write was validated against. */
+    schemaVersion: number;
+    /** Stored size of the serialized data, in bytes. */
+    size: number;
+}
+/**
+ * One item of a batch read request. `categories` is required and must be
+ * non-empty — there is no expand-to-all; an item that omits it comes back as a
+ * per-item error with `status: 400`.
+ */
+export interface ResourceMetadataBatchRequestItem {
+    resourceType: string;
+    resourceId: string;
+    /** Explicit categories to read for this resource. */
+    categories: string[];
+}
+/** Parameters for `resourceMetadata.getBatch`. */
+export interface ResourceMetadataBatchParams {
+    /**
+     * Up to 50 resource entries, and up to 200 expanded resource/category pairs
+     * per call. Exceeding either limit fails the whole call with `400
+     * BATCH_TOO_LARGE`.
+     */
+    requests: ResourceMetadataBatchRequestItem[];
+}
+/**
+ * Per-category result inside a batch read — a discriminated union on `ok`. A
+ * success carries the same fields as the single read (`data`, `schemaVersion`,
+ * `exists`); a failure carries `status`/`code`/`message` and never `data`.
+ */
+export type ResourceMetadataBatchCategoryResult = {
+    ok: true;
+    data: Record<string, unknown>;
+    schemaVersion: number | null;
+    exists: boolean;
+} | {
+    ok: false;
+    status: number;
+    code: string;
+    message: string;
+};
+/**
+ * Per-resource result inside a batch read. `ok: true` carries a per-category
+ * map; `ok: false` is an item-level fault (malformed segment, or missing
+ * `categories`) that applies to the whole item.
+ */
+export type ResourceMetadataBatchResourceResult = {
+    resourceType: string;
+    resourceId: string;
+    ok: true;
+    categories: Record<string, ResourceMetadataBatchCategoryResult>;
+} | {
+    resourceType: string;
+    resourceId: string;
+    ok: false;
+    status: number;
+    code: string;
+    message: string;
+};
+/**
+ * Result of `resourceMetadata.getBatch`. The call itself succeeds (HTTP 200)
+ * even when individual items fail — check each entry's `ok` discriminant.
+ */
+export interface ResourceMetadataBatchResult {
+    /** One entry per request item, in request order. */
+    results: ResourceMetadataBatchResourceResult[];
+}
+/** One stored category in a resource metadata listing (`resourceMetadata.list`). */
+export interface ResourceMetadataListEntry {
+    category: string;
+    /** The stored metadata object for this category. */
+    data: Record<string, unknown>;
+    /** Schema version the stored data was validated against (`null` if unknown). */
+    schemaVersion: number | null;
+}
+/**
+ * Result of `resourceMetadata.list`. Only categories the caller may read are
+ * returned: each is gated by its `readRule` with the app-level owner/admin
+ * bypass, so an admin sees every category while a plain member sees only the
+ * ones their rule permits. A resource with no metadata returns an empty list.
+ */
+export interface ResourceMetadataListResult {
+    resourceType: string;
+    resourceId: string;
+    categories: ResourceMetadataListEntry[];
+}
+/** Result of `resourceMetadata.delete` (idempotent — an absent item is not an error). */
+export interface ResourceMetadataDeleteResult {
+    resourceType: string;
+    resourceId: string;
+    category: string;
+    /** `false` when no stored item existed (still a success, not a 404). */
+    deleted: boolean;
+}
+/**
+ * Sub-API for reading and writing typed resource metadata (values only —
+ * category definitions are managed by app admins, not through this client).
+ * Reads are gated per category by its `readRule` and writes by its
+ * `writeRule`, with an app-level owner/admin bypass; a resource-level
+ * permission never bypasses. A denial surfaces as an HTTP 403
+ * error on the single calls and as a per-item `ok: false` entry in the batch.
+ */
+export declare class ResourceMetadataAPI {
+    private client;
+    constructor(client: JsBaoClient);
+    /**
+     * Read one resource's metadata for one category. Succeeds with
+     * `exists: false` and empty `data` when nothing has been written yet;
+     * fails with 404 when the category is not defined for the resource type,
+     * or 403 when the category's `readRule` denies the caller.
+     */
+    get(resourceType: string, resourceId: string, category: string): Promise<ResourceMetadataReadResult>;
+    /**
+     * Write (full replace) one resource's metadata for one category. The data
+     * is validated against the category's schema; the category's `writeRule`
+     * gates the write (403 on denial).
+     */
+    set(resourceType: string, resourceId: string, category: string, data: Record<string, unknown>): Promise<ResourceMetadataWriteResult>;
+    /**
+     * Read metadata for many resources in one call (bounded: 50 resources /
+     * 200 resource-category pairs). Partial success: per-item 403/404 errors
+     * are returned as structured entries and do not fail the call.
+     */
+    getBatch(params: ResourceMetadataBatchParams): Promise<ResourceMetadataBatchResult>;
+    /**
+     * List every stored metadata category on one resource. Only categories the
+     * caller may read are returned (each gated by its `readRule`, with the
+     * app-level owner/admin bypass); a resource with no metadata comes back with
+     * an empty `categories` array.
+     */
+    list(resourceType: string, resourceId: string): Promise<ResourceMetadataListResult>;
+    /**
+     * Delete one resource's metadata for one category. The category's `writeRule`
+     * gates the delete (403 on denial). Idempotent: deleting an item that does
+     * not exist succeeds with `deleted: false` rather than failing with 404.
+     */
+    delete(resourceType: string, resourceId: string, category: string): Promise<ResourceMetadataDeleteResult>;
+}
+//# sourceMappingURL=resourceMetadataApi.d.ts.map

package/dist/api/resourceMetadataApi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resourceMetadataApi.d.ts","sourceRoot":"","sources":["../../api/resourceMetadataApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAElD;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACzC,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,2EAA2E;IAC3E,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9B,4FAA4F;IAC5F,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,kEAAkE;IAClE,MAAM,EAAE,OAAO,CAAC;CACjB;AAED,4EAA4E;AAC5E,MAAM,WAAW,2BAA2B;IAC1C,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,6DAA6D;IAC7D,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9B,sDAAsD;IACtD,aAAa,EAAE,MAAM,CAAC;IACtB,oDAAoD;IACpD,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;GAIG;AACH,MAAM,WAAW,gCAAgC;IAC/C,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,qDAAqD;IACrD,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB;AAED,kDAAkD;AAClD,MAAM,WAAW,2BAA2B;IAC1C;;;;OAIG;IACH,QAAQ,EAAE,gCAAgC,EAAE,CAAC;CAC9C;AAED;;;;GAIG;AACH,MAAM,MAAM,mCAAmC,GAC3C;IACE,EAAE,EAAE,IAAI,CAAC;IACT,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,MAAM,EAAE,OAAO,CAAC;CACjB,GACD;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC;AAEjE;;;;GAIG;AACH,MAAM,MAAM,mCAAmC,GAC3C;IACE,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,EAAE,EAAE,IAAI,CAAC;IACT,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,mCAAmC,CAAC,CAAC;CACjE,GACD;IACE,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,EAAE,EAAE,KAAK,CAAC;IACV,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEN;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC1C,oDAAoD;IACpD,OAAO,EAAE,mCAAmC,EAAE,CAAC;CAChD;AAED,oFAAoF;AACpF,MAAM,WAAW,yBAAyB;IACxC,QAAQ,EAAE,MAAM,CAAC;IACjB,oDAAoD;IACpD,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9B,gFAAgF;IAChF,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED;;;;;GAKG;AACH,MAAM,WAAW,0BAA0B;IACzC,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,yBAAyB,EAAE,CAAC;CACzC;AAED,yFAAyF;AACzF,MAAM,WAAW,4BAA4B;IAC3C,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,wEAAwE;IACxE,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;;;;;;GAOG;AACH,qBAAa,mBAAmB;IAClB,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,WAAW;IAEvC;;;;;OAKG;IACG,GAAG,CACP,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,0BAA0B,CAAC;IAStC;;;;OAIG;IACG,GAAG,CACP,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC5B,OAAO,CAAC,2BAA2B,CAAC;IAUvC;;;;OAIG;IACG,QAAQ,CACZ,MAAM,EAAE,2BAA2B,GAClC,OAAO,CAAC,2BAA2B,CAAC;IAQvC;;;;;OAKG;IACG,IAAI,CACR,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,0BAA0B,CAAC;IAStC;;;;OAIG;IACG,MAAM,CACV,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,4BAA4B,CAAC;CAQzC"}

package/dist/api/resourceMetadataApi.js

@@ -0,0 +1,56 @@
+/**
+ * Sub-API for reading and writing typed resource metadata (values only —
+ * category definitions are managed by app admins, not through this client).
+ * Reads are gated per category by its `readRule` and writes by its
+ * `writeRule`, with an app-level owner/admin bypass; a resource-level
+ * permission never bypasses. A denial surfaces as an HTTP 403
+ * error on the single calls and as a per-item `ok: false` entry in the batch.
+ */
+export class ResourceMetadataAPI {
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Read one resource's metadata for one category. Succeeds with
+     * `exists: false` and empty `data` when nothing has been written yet;
+     * fails with 404 when the category is not defined for the resource type,
+     * or 403 when the category's `readRule` denies the caller.
+     */
+    async get(resourceType, resourceId, category) {
+        return this.client.makeRequest("GET", `/resources/${encodeURIComponent(resourceType)}/${encodeURIComponent(resourceId)}/metadata/${encodeURIComponent(category)}`);
+    }
+    /**
+     * Write (full replace) one resource's metadata for one category. The data
+     * is validated against the category's schema; the category's `writeRule`
+     * gates the write (403 on denial).
+     */
+    async set(resourceType, resourceId, category, data) {
+        return this.client.makeRequest("PUT", `/resources/${encodeURIComponent(resourceType)}/${encodeURIComponent(resourceId)}/metadata/${encodeURIComponent(category)}`, { data });
+    }
+    /**
+     * Read metadata for many resources in one call (bounded: 50 resources /
+     * 200 resource-category pairs). Partial success: per-item 403/404 errors
+     * are returned as structured entries and do not fail the call.
+     */
+    async getBatch(params) {
+        return this.client.makeRequest("POST", "/resources/metadata/batch", params);
+    }
+    /**
+     * List every stored metadata category on one resource. Only categories the
+     * caller may read are returned (each gated by its `readRule`, with the
+     * app-level owner/admin bypass); a resource with no metadata comes back with
+     * an empty `categories` array.
+     */
+    async list(resourceType, resourceId) {
+        return this.client.makeRequest("GET", `/resources/${encodeURIComponent(resourceType)}/${encodeURIComponent(resourceId)}/metadata`);
+    }
+    /**
+     * Delete one resource's metadata for one category. The category's `writeRule`
+     * gates the delete (403 on denial). Idempotent: deleting an item that does
+     * not exist succeeds with `deleted: false` rather than failing with 404.
+     */
+    async delete(resourceType, resourceId, category) {
+        return this.client.makeRequest("DELETE", `/resources/${encodeURIComponent(resourceType)}/${encodeURIComponent(resourceId)}/metadata/${encodeURIComponent(category)}`);
+    }
+}
+//# sourceMappingURL=resourceMetadataApi.js.map

package/dist/api/resourceMetadataApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resourceMetadataApi.js","sourceRoot":"","sources":["../../api/resourceMetadataApi.ts"],"names":[],"mappings":"AAgIA;;;;;;;GAOG;AACH,MAAM,OAAO,mBAAmB;IAC9B,YAAoB,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAAG,CAAC;IAE3C;;;;;OAKG;IACH,KAAK,CAAC,GAAG,CACP,YAAoB,EACpB,UAAkB,EAClB,QAAgB;QAEhB,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAC5B,KAAK,EACL,cAAc,kBAAkB,CAAC,YAAY,CAAC,IAAI,kBAAkB,CAClE,UAAU,CACX,aAAa,kBAAkB,CAAC,QAAQ,CAAC,EAAE,CAC7C,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,GAAG,CACP,YAAoB,EACpB,UAAkB,EAClB,QAAgB,EAChB,IAA6B;QAE7B,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAC5B,KAAK,EACL,cAAc,kBAAkB,CAAC,YAAY,CAAC,IAAI,kBAAkB,CAClE,UAAU,CACX,aAAa,kBAAkB,CAAC,QAAQ,CAAC,EAAE,EAC5C,EAAE,IAAI,EAAE,CACT,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,QAAQ,CACZ,MAAmC;QAEnC,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAC5B,MAAM,EACN,2BAA2B,EAC3B,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CACR,YAAoB,EACpB,UAAkB;QAElB,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAC5B,KAAK,EACL,cAAc,kBAAkB,CAAC,YAAY,CAAC,IAAI,kBAAkB,CAClE,UAAU,CACX,WAAW,CACb,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CACV,YAAoB,EACpB,UAAkB,EAClB,QAAgB;QAEhB,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAC5B,QAAQ,EACR,cAAc,kBAAkB,CAAC,YAAY,CAAC,IAAI,kBAAkB,CAClE,UAAU,CACX,aAAa,kBAAkB,CAAC,QAAQ,CAAC,EAAE,CAC7C,CAAC;IACJ,CAAC;CACF"}