@elaraai/e3-cloud-client 0.0.0-stage → 1.0.90

package/dist/src/invitations.js

@@ -0,0 +1,31 @@
+/**
+ * Copyright (c) 2025 Elara AI Pty Ltd
+ * Licensed under BSL 1.1. See LICENSE for details.
+ */
+/**
+ * Invitation API functions using BEAST2 format.
+ *
+ * Invitations are created implicitly by the add-user flow when the email has
+ * never logged in (the response's userId carries the `invited:` sentinel);
+ * these functions give admins visibility and revocation.
+ */
+import { NullType } from '@elaraai/east';
+import { InvitationListType } from '@elaraai/e3-cloud-types';
+import { get, del } from '@elaraai/e3-api-client';
+/**
+ * List all invitations (admin only), newest first.
+ */
+export async function listInvitations(url, options) {
+    return get(url, '/admin/invitations', InvitationListType, options);
+}
+/**
+ * Revoke a pending invitation (admin only). No-op on absent/claimed.
+ */
+export async function revokeInvitation(url, email, options) {
+    await del(url, `/admin/invitations/${encodeURIComponent(email.toLowerCase())}`, NullType, options);
+}
+/** Whether an add-user response denotes a recorded invitation (not yet a member). */
+export function isInvitedSentinel(userId) {
+    return userId.startsWith('invited:');
+}
+//# sourceMappingURL=invitations.js.map

package/dist/src/invitations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"invitations.js","sourceRoot":"","sources":["../../src/invitations.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;GAMG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,kBAAkB,EAAuB,MAAM,yBAAyB,CAAC;AAClF,OAAO,EAAE,GAAG,EAAE,GAAG,EAAuB,MAAM,wBAAwB,CAAC;AAEvE;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,GAAW,EAAE,OAAuB;IACxE,OAAO,GAAG,CAAC,GAAG,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,OAAO,CAAC,CAAC;AACrE,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,GAAW,EAAE,KAAa,EAAE,OAAuB;IACxF,MAAM,GAAG,CAAC,GAAG,EAAE,sBAAsB,kBAAkB,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,EAAE,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;AACrG,CAAC;AAED,qFAAqF;AACrF,MAAM,UAAU,iBAAiB,CAAC,MAAc;IAC9C,OAAO,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;AACvC,CAAC"}

package/dist/src/me.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Copyright (c) 2025 Elara AI Pty Ltd
+ * Licensed under BSL 1.1. See LICENSE for details.
+ */
+import { type AdminUserMembership } from '@elaraai/e3-cloud-types';
+import { type RequestOptions } from '@elaraai/e3-api-client';
+/**
+ * List the caller's own repo memberships (any authenticated user).
+ */
+export declare function myMemberships(url: string, options: RequestOptions): Promise<AdminUserMembership[]>;
+//# sourceMappingURL=me.d.ts.map

package/dist/src/me.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"me.d.ts","sourceRoot":"","sources":["../../src/me.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAQH,OAAO,EAA2B,KAAK,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAC5F,OAAO,EAAO,KAAK,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAElE;;GAEG;AACH,wBAAsB,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAExG"}

package/dist/src/me.js

@@ -0,0 +1,18 @@
+/**
+ * Copyright (c) 2025 Elara AI Pty Ltd
+ * Licensed under BSL 1.1. See LICENSE for details.
+ */
+/**
+ * Self-scoped API functions using BEAST2 format: what the caller can know
+ * about themselves beyond whoami.
+ */
+import { ArrayType } from '@elaraai/east';
+import { AdminUserMembershipType } from '@elaraai/e3-cloud-types';
+import { get } from '@elaraai/e3-api-client';
+/**
+ * List the caller's own repo memberships (any authenticated user).
+ */
+export async function myMemberships(url, options) {
+    return get(url, '/me/memberships', ArrayType(AdminUserMembershipType), options);
+}
+//# sourceMappingURL=me.js.map

package/dist/src/me.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"me.js","sourceRoot":"","sources":["../../src/me.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;GAGG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,uBAAuB,EAA4B,MAAM,yBAAyB,CAAC;AAC5F,OAAO,EAAE,GAAG,EAAuB,MAAM,wBAAwB,CAAC;AAElE;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,GAAW,EAAE,OAAuB;IACtE,OAAO,GAAG,CAAC,GAAG,EAAE,iBAAiB,EAAE,SAAS,CAAC,uBAAuB,CAAC,EAAE,OAAO,CAAC,CAAC;AAClF,CAAC"}

package/dist/src/records.d.ts

@@ -0,0 +1,127 @@
+/**
+ * Copyright (c) 2025 Elara AI Pty Ltd
+ * Licensed under BSL 1.1. See LICENSE for details.
+ */
+import { type RecordList, type RecordAuditPage, type RecordBackupInfo, type RecordBackupList, type RecordBackupDownload, type RecordRollbackRequest, type RecordRestoreRequest } from '@elaraai/e3-cloud-types';
+import { type DatasetPage, type RequestOptions, type MutationResult } from '@elaraai/e3-api-client';
+/** Channel tag for the audit index's `source` field. */
+export type RecordClientSource = 'web' | 'cli';
+/**
+ * List a workspace's records with head commit info and backup counts.
+ */
+export declare function listRecordInfos(url: string, repo: string, ws: string, options: RequestOptions): Promise<RecordList>;
+/**
+ * Fetch one page of a record's durable audit index, newest first. Unlike the
+ * chain-walk history endpoint, entries survive `$compact` + GC.
+ *
+ * @param opts.limit - Page size (server default 50, cap 200)
+ * @param opts.before - Opaque cursor from a prior page's `nextBefore`
+ */
+export declare function recordAudit(url: string, repo: string, ws: string, record: string, options: RequestOptions, opts?: {
+    limit?: number;
+    before?: string;
+}): Promise<RecordAuditPage>;
+/**
+ * A value's bytes, in order, from where the server says it is: one object
+ * (`objectGet`), or a collection's manifest, whose header and segments are
+ * fetched a few at a time ahead of the splice that joins them
+ * (`collectionGetStream`), each checked against its hash. The caller holds the
+ * segments in flight, never the value.
+ *
+ * @param url - Base URL of the e3 API server
+ * @param repo - Repository name
+ * @param value - Where the value is (a backup download's `value`)
+ * @param options - Request options including auth token
+ * @returns The value's bytes, a chunk at a time
+ */
+export declare function recordValueChunks(url: string, repo: string, value: RecordBackupDownload['value'], options: RequestOptions): Promise<AsyncIterable<Uint8Array>>;
+/**
+ * A record's value at a commit: whole, or — for a collection too large to
+ * answer in one response — how many rows it has, to read by pages
+ * ({@link recordStatePage}), and the manifest it can be downloaded by
+ * ({@link recordValueChunks}).
+ */
+export type RecordStateAt = {
+    kind: 'value';
+    stateHash: string;
+    data: Uint8Array;
+} | {
+    kind: 'pages';
+    stateHash: string;
+    rows: number;
+    bytes: number;
+    manifest: string;
+};
+/**
+ * Read a record's value at a commit. A value is self-describing beast2:
+ * decode it with `decodeBeast2`. A large value that is no collection is
+ * fetched through the objects route, whole.
+ */
+export declare function recordStateAt(url: string, repo: string, ws: string, record: string, commitHash: string, options: RequestOptions): Promise<RecordStateAt>;
+/**
+ * Read one page of a record's collection at a commit: its window, a beast2
+ * value of the type the collection is stored as, clamped by the server's byte
+ * budget, read as e3-api-client reads a dataset's page (`parsePage`). A
+ * commit's state never changes, so a page is immutable.
+ *
+ * @param window.offset - The first row (Array order, or Set/Dict key order)
+ * @param window.limit - The most rows (the server may answer fewer)
+ * @throws {ApiError} A page's refusal, as the server names it (a malformed
+ *   window `bad_request`, a state that holds no collection), or the history's
+ *   (a commit not in the record's history)
+ */
+export declare function recordStatePage(url: string, repo: string, ws: string, record: string, commitHash: string, window: {
+    offset: number;
+    limit: number;
+}, options: RequestOptions): Promise<DatasetPage>;
+/**
+ * Roll a record back to a historical commit via an audited `$rollback`
+ * commit (roll-forward: history is preserved and downstream dataflow
+ * re-runs). Refused, with the reason, past a migration or to a commit a
+ * compaction cut from the chain. Owner/admin only.
+ */
+export declare function rollbackRecord(url: string, repo: string, ws: string, record: string, req: RecordRollbackRequest, options: RequestOptions, source?: RecordClientSource): Promise<MutationResult>;
+/**
+ * List a record's backups, newest first.
+ */
+export declare function listRecordBackups(url: string, repo: string, ws: string, record: string, options: RequestOptions): Promise<RecordBackupList>;
+/**
+ * Back up a record's current head: a row naming its state, which the
+ * platform keeps while the backup exists. Owner/admin only.
+ */
+export declare function createRecordBackup(url: string, repo: string, ws: string, record: string, req: {
+    note?: string;
+}, options: RequestOptions, source?: RecordClientSource): Promise<RecordBackupInfo>;
+/**
+ * Restore a backup: an audited `$restore` commit pointing the record at the
+ * backup's state. Refused, with the reason, when the record's migrations or
+ * type are not the backup's. Owner/admin only.
+ */
+export declare function restoreRecordBackup(url: string, repo: string, ws: string, record: string, id: string, req: RecordRestoreRequest, options: RequestOptions, source?: RecordClientSource): Promise<MutationResult>;
+/**
+ * Where a backup's value is: the state it names, and the object holding the
+ * value (a collection's manifest, or one object). Owner/admin only.
+ */
+export declare function recordBackupDownload(url: string, repo: string, ws: string, record: string, id: string, options: RequestOptions): Promise<RecordBackupDownload>;
+/**
+ * A backup's value, a chunk at a time: a plain beast2 value of the record's
+ * type, downloaded by segments. For a caller that writes it to a file.
+ * Owner/admin only.
+ */
+export declare function recordBackupStream(url: string, repo: string, ws: string, record: string, id: string, options: RequestOptions): Promise<{
+    stateHash: string;
+    chunks: AsyncIterable<Uint8Array>;
+}>;
+/**
+ * A backup's value, whole: a plain beast2 value of the record's type,
+ * downloaded by segments. Owner/admin only.
+ */
+export declare function recordBackupValue(url: string, repo: string, ws: string, record: string, id: string, options: RequestOptions): Promise<{
+    stateHash: string;
+    data: Uint8Array;
+}>;
+/**
+ * Delete one backup, releasing its state. Owner/admin only.
+ */
+export declare function deleteRecordBackup(url: string, repo: string, ws: string, record: string, id: string, options: RequestOptions): Promise<void>;
+//# sourceMappingURL=records.d.ts.map

package/dist/src/records.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"records.d.ts","sourceRoot":"","sources":["../../src/records.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAsBH,OAAO,EASL,KAAK,UAAU,EACf,KAAK,eAAe,EACpB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,EAE1B,MAAM,yBAAyB,CAAC;AAEjC,OAAO,EAUL,KAAK,WAAW,EAChB,KAAK,cAAc,EACnB,KAAK,cAAc,EACpB,MAAM,wBAAwB,CAAC;AAUhC,wDAAwD;AACxD,MAAM,MAAM,kBAAkB,GAAG,KAAK,GAAG,KAAK,CAAC;AAK/C;;GAEG;AACH,wBAAsB,eAAe,CACnC,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,cAAc,GACtB,OAAO,CAAC,UAAU,CAAC,CAErB;AAED;;;;;;GAMG;AACH,wBAAsB,WAAW,CAC/B,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,cAAc,EACvB,IAAI,GAAE;IAAE,KAAK,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAO,GAC7C,OAAO,CAAC,eAAe,CAAC,CAM1B;AAkBD;;;;;;;;;;;;GAYG;AACH,wBAAsB,iBAAiB,CACrC,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,oBAAoB,CAAC,OAAO,CAAC,EACpC,OAAO,EAAE,cAAc,GACtB,OAAO,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,CAGpC;AAkCD;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GACrB;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,UAAU,CAAA;CAAE,GACtD;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC;AAExF;;;;GAIG;AACH,wBAAsB,aAAa,CACjC,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,cAAc,GACtB,OAAO,CAAC,aAAa,CAAC,CAexB;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,eAAe,CACnC,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,EACzC,OAAO,EAAE,cAAc,GACtB,OAAO,CAAC,WAAW,CAAC,CAQtB;AAED;;;;;GAKG;AACH,wBAAsB,cAAc,CAClC,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,qBAAqB,EAC1B,OAAO,EAAE,cAAc,EACvB,MAAM,CAAC,EAAE,kBAAkB,GAC1B,OAAO,CAAC,cAAc,CAAC,CAEzB;AAED;;GAEG;AACH,wBAAsB,iBAAiB,CACrC,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,cAAc,GACtB,OAAO,CAAC,gBAAgB,CAAC,CAE3B;AAED;;;GAGG;AACH,wBAAsB,kBAAkB,CACtC,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,MAAM,EACd,GAAG,EAAE;IAAE,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,EACtB,OAAO,EAAE,cAAc,EACvB,MAAM,CAAC,EAAE,kBAAkB,GAC1B,OAAO,CAAC,gBAAgB,CAAC,CAK3B;AAED;;;;GAIG;AACH,wBAAsB,mBAAmB,CACvC,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,MAAM,EACd,EAAE,EAAE,MAAM,EACV,GAAG,EAAE,oBAAoB,EACzB,OAAO,EAAE,cAAc,EACvB,MAAM,CAAC,EAAE,kBAAkB,GAC1B,OAAO,CAAC,cAAc,CAAC,CAEzB;AAED;;;GAGG;AACH,wBAAsB,oBAAoB,CACxC,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,MAAM,EACd,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,cAAc,GACtB,OAAO,CAAC,oBAAoB,CAAC,CAE/B;AAED;;;;GAIG;AACH,wBAAsB,kBAAkB,CACtC,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,MAAM,EACd,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,cAAc,GACtB,OAAO,CAAC;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,aAAa,CAAC,UAAU,CAAC,CAAA;CAAE,CAAC,CAGnE;AAED;;;GAGG;AACH,wBAAsB,iBAAiB,CACrC,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,MAAM,EACd,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,cAAc,GACtB,OAAO,CAAC;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,UAAU,CAAA;CAAE,CAAC,CAGlD;AAED;;GAEG;AACH,wBAAsB,kBAAkB,CACtC,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,MAAM,EACd,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,cAAc,GACtB,OAAO,CAAC,IAAI,CAAC,CAEf"}

package/dist/src/records.js

@@ -0,0 +1,226 @@
+/**
+ * Copyright (c) 2025 Elara AI Pty Ltd
+ * Licensed under BSL 1.1. See LICENSE for details.
+ */
+/**
+ * Record history, rollback and backup API functions using
+ * BEAST2 format. These extend the base record surface from
+ * `@elaraai/e3-api-client` (describe/mutate/history/compact) with the cloud's
+ * operator features: the durable audit index (survives `$compact` + GC),
+ * the record's value at a commit (whole, or by pages), `$rollback`/`$restore`
+ * commits, and backups: rows naming states, whose values download by
+ * segments.
+ *
+ * The mutating functions accept a `source` channel tag sent as the
+ * `X-E3-Client` header — recorded on the audit entry (`web` from the UI,
+ * `cli` from e3-cloud CLI; omitted ⇒ shown as plain api access).
+ *
+ * A value named by its hash is read as e3-api-client reads one
+ * (east-workspace#1057): an object with `objectGet`, a collection by its
+ * manifest with `collectionGetStream`, a page with `parsePage`, and a refusal
+ * answered in JSON with `parseErrorBody`.
+ */
+import { NullType, decodeBeast2For, some, none } from '@elaraai/east';
+import { RecordListType, RecordAuditPageType, RecordRollbackRequestType, RecordBackupInfoType, RecordBackupListType, RecordBackupCreateRequestType, RecordRestoreRequestType, RecordBackupDownloadType, } from '@elaraai/e3-cloud-types';
+import { BEAST2_CONTENT_TYPE, ResponseType, MutationResultType } from '@elaraai/e3-types';
+import { get, post, del, fetchWithAuth, objectGet, collectionGetStream, parsePage, parseErrorBody, ApiError, } from '@elaraai/e3-api-client';
+const enc = encodeURIComponent;
+const recordsBase = (repo, ws) => `/repos/${enc(repo)}/workspaces/${enc(ws)}/records`;
+const recordBase = (repo, ws, record) => `${recordsBase(repo, ws)}/${enc(record)}`;
+const sourceHeaders = (source) => source !== undefined ? { 'X-E3-Client': source } : undefined;
+/**
+ * List a workspace's records with head commit info and backup counts.
+ */
+export async function listRecordInfos(url, repo, ws, options) {
+    return get(url, recordsBase(repo, ws), RecordListType, options);
+}
+/**
+ * Fetch one page of a record's durable audit index, newest first. Unlike the
+ * chain-walk history endpoint, entries survive `$compact` + GC.
+ *
+ * @param opts.limit - Page size (server default 50, cap 200)
+ * @param opts.before - Opaque cursor from a prior page's `nextBefore`
+ */
+export async function recordAudit(url, repo, ws, record, options, opts = {}) {
+    const params = new URLSearchParams();
+    if (opts.limit !== undefined)
+        params.set('limit', String(opts.limit));
+    if (opts.before !== undefined)
+        params.set('before', opts.before);
+    const query = params.toString();
+    return get(url, `${recordBase(repo, ws, record)}/audit${query ? `?${query}` : ''}`, RecordAuditPageType, options);
+}
+const decodeNullResponse = decodeBeast2For(ResponseType(NullType));
+/** The error a response carries that is not the answer asked for: a JSON
+ *  refusal, read as the rest of the client reads one, or the server's beast2
+ *  error envelope. */
+async function responseError(response) {
+    if (!response.ok)
+        return parseErrorBody(await response.text(), `http_${response.status}`);
+    try {
+        const decoded = decodeNullResponse(new Uint8Array(await response.arrayBuffer()));
+        if (decoded.type === 'error')
+            return new ApiError(decoded.value.type, decoded.value.value);
+    }
+    catch {
+        // Not an envelope either
+    }
+    return new ApiError('unexpected_response', { status: response.status });
+}
+/**
+ * A value's bytes, in order, from where the server says it is: one object
+ * (`objectGet`), or a collection's manifest, whose header and segments are
+ * fetched a few at a time ahead of the splice that joins them
+ * (`collectionGetStream`), each checked against its hash. The caller holds the
+ * segments in flight, never the value.
+ *
+ * @param url - Base URL of the e3 API server
+ * @param repo - Repository name
+ * @param value - Where the value is (a backup download's `value`)
+ * @param options - Request options including auth token
+ * @returns The value's bytes, a chunk at a time
+ */
+export async function recordValueChunks(url, repo, value, options) {
+    if (value.type === 'object')
+        return inHand([await objectGet(url, repo, value.value, options)]);
+    return collectionGetStream(url, repo, value.value, options);
+}
+/** Chunks already in hand, as an async iterable. */
+function inHand(chunks) {
+    return {
+        [Symbol.asyncIterator]() {
+            let next = 0;
+            return {
+                next: () => Promise.resolve(next < chunks.length
+                    ? { done: false, value: chunks[next++] }
+                    : { done: true, value: undefined }),
+            };
+        },
+    };
+}
+/** An iterable's chunks, as one array. */
+async function collect(chunks) {
+    const parts = [];
+    let size = 0;
+    for await (const chunk of chunks) {
+        parts.push(chunk);
+        size += chunk.length;
+    }
+    if (parts.length === 1)
+        return parts[0];
+    const out = new Uint8Array(size);
+    let at = 0;
+    for (const part of parts) {
+        out.set(part, at);
+        at += part.length;
+    }
+    return out;
+}
+/**
+ * Read a record's value at a commit. A value is self-describing beast2:
+ * decode it with `decodeBeast2`. A large value that is no collection is
+ * fetched through the objects route, whole.
+ */
+export async function recordStateAt(url, repo, ws, record, commitHash, options) {
+    const response = await fetchWithAuth(`${url}/api${recordBase(repo, ws, record)}/commits/${enc(commitHash)}/state`, {
+        method: 'GET',
+        headers: { Accept: BEAST2_CONTENT_TYPE },
+    }, options);
+    if (response.ok && (response.headers.get('Content-Type') ?? '').includes('application/json')) {
+        const body = await response.json();
+        if (body.object !== undefined) {
+            return { kind: 'value', stateHash: body.stateHash, data: await objectGet(url, repo, body.object, options) };
+        }
+        return { kind: 'pages', stateHash: body.stateHash, rows: body.rows ?? 0, bytes: body.bytes, manifest: body.manifest ?? '' };
+    }
+    const stateHash = response.headers.get('X-Content-SHA256');
+    if (response.ok && stateHash !== null)
+        return { kind: 'value', stateHash, data: new Uint8Array(await response.arrayBuffer()) };
+    throw await responseError(response);
+}
+/**
+ * Read one page of a record's collection at a commit: its window, a beast2
+ * value of the type the collection is stored as, clamped by the server's byte
+ * budget, read as e3-api-client reads a dataset's page (`parsePage`). A
+ * commit's state never changes, so a page is immutable.
+ *
+ * @param window.offset - The first row (Array order, or Set/Dict key order)
+ * @param window.limit - The most rows (the server may answer fewer)
+ * @throws {ApiError} A page's refusal, as the server names it (a malformed
+ *   window `bad_request`, a state that holds no collection), or the history's
+ *   (a commit not in the record's history)
+ */
+export async function recordStatePage(url, repo, ws, record, commitHash, window, options) {
+    const params = new URLSearchParams({ page: 'true', offset: String(window.offset), limit: String(window.limit) });
+    const response = await fetchWithAuth(`${url}/api${recordBase(repo, ws, record)}/commits/${enc(commitHash)}/state?${params.toString()}`, {
+        method: 'GET',
+        headers: { Accept: BEAST2_CONTENT_TYPE },
+    }, options);
+    if (!response.ok || response.headers.get('X-Page-Count') === null)
+        throw await responseError(response);
+    return parsePage(response);
+}
+/**
+ * Roll a record back to a historical commit via an audited `$rollback`
+ * commit (roll-forward: history is preserved and downstream dataflow
+ * re-runs). Refused, with the reason, past a migration or to a commit a
+ * compaction cut from the chain. Owner/admin only.
+ */
+export async function rollbackRecord(url, repo, ws, record, req, options, source) {
+    return post(url, `${recordBase(repo, ws, record)}/rollback`, req, RecordRollbackRequestType, MutationResultType, options, sourceHeaders(source));
+}
+/**
+ * List a record's backups, newest first.
+ */
+export async function listRecordBackups(url, repo, ws, record, options) {
+    return get(url, `${recordBase(repo, ws, record)}/backups`, RecordBackupListType, options);
+}
+/**
+ * Back up a record's current head: a row naming its state, which the
+ * platform keeps while the backup exists. Owner/admin only.
+ */
+export async function createRecordBackup(url, repo, ws, record, req, options, source) {
+    const body = {
+        note: req.note !== undefined ? some(req.note) : none,
+    };
+    return post(url, `${recordBase(repo, ws, record)}/backups`, body, RecordBackupCreateRequestType, RecordBackupInfoType, options, sourceHeaders(source));
+}
+/**
+ * Restore a backup: an audited `$restore` commit pointing the record at the
+ * backup's state. Refused, with the reason, when the record's migrations or
+ * type are not the backup's. Owner/admin only.
+ */
+export async function restoreRecordBackup(url, repo, ws, record, id, req, options, source) {
+    return post(url, `${recordBase(repo, ws, record)}/backups/${enc(id)}/restore`, req, RecordRestoreRequestType, MutationResultType, options, sourceHeaders(source));
+}
+/**
+ * Where a backup's value is: the state it names, and the object holding the
+ * value (a collection's manifest, or one object). Owner/admin only.
+ */
+export async function recordBackupDownload(url, repo, ws, record, id, options) {
+    return get(url, `${recordBase(repo, ws, record)}/backups/${enc(id)}/download`, RecordBackupDownloadType, options);
+}
+/**
+ * A backup's value, a chunk at a time: a plain beast2 value of the record's
+ * type, downloaded by segments. For a caller that writes it to a file.
+ * Owner/admin only.
+ */
+export async function recordBackupStream(url, repo, ws, record, id, options) {
+    const where = await recordBackupDownload(url, repo, ws, record, id, options);
+    return { stateHash: where.stateHash, chunks: await recordValueChunks(url, repo, where.value, options) };
+}
+/**
+ * A backup's value, whole: a plain beast2 value of the record's type,
+ * downloaded by segments. Owner/admin only.
+ */
+export async function recordBackupValue(url, repo, ws, record, id, options) {
+    const { stateHash, chunks } = await recordBackupStream(url, repo, ws, record, id, options);
+    return { stateHash, data: await collect(chunks) };
+}
+/**
+ * Delete one backup, releasing its state. Owner/admin only.
+ */
+export async function deleteRecordBackup(url, repo, ws, record, id, options) {
+    await del(url, `${recordBase(repo, ws, record)}/backups/${enc(id)}`, NullType, options);
+}
+//# sourceMappingURL=records.js.map

package/dist/src/records.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"records.js","sourceRoot":"","sources":["../../src/records.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AACtE,OAAO,EACL,cAAc,EACd,mBAAmB,EACnB,yBAAyB,EACzB,oBAAoB,EACpB,oBAAoB,EACpB,6BAA6B,EAC7B,wBAAwB,EACxB,wBAAwB,GASzB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,mBAAmB,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAC1F,OAAO,EACL,GAAG,EACH,IAAI,EACJ,GAAG,EACH,aAAa,EACb,SAAS,EACT,mBAAmB,EACnB,SAAS,EACT,cAAc,EACd,QAAQ,GAIT,MAAM,wBAAwB,CAAC;AAEhC,MAAM,GAAG,GAAG,kBAAkB,CAAC;AAE/B,MAAM,WAAW,GAAG,CAAC,IAAY,EAAE,EAAU,EAAE,EAAE,CAC/C,UAAU,GAAG,CAAC,IAAI,CAAC,eAAe,GAAG,CAAC,EAAE,CAAC,UAAU,CAAC;AAEtD,MAAM,UAAU,GAAG,CAAC,IAAY,EAAE,EAAU,EAAE,MAAc,EAAE,EAAE,CAC9D,GAAG,WAAW,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;AAK5C,MAAM,aAAa,GAAG,CAAC,MAA2B,EAAsC,EAAE,CACxF,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;AAE/D;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,GAAW,EACX,IAAY,EACZ,EAAU,EACV,OAAuB;IAEvB,OAAO,GAAG,CAAC,GAAG,EAAE,WAAW,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,cAAc,EAAE,OAAO,CAAC,CAAC;AAClE,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,GAAW,EACX,IAAY,EACZ,EAAU,EACV,MAAc,EACd,OAAuB,EACvB,OAA4C,EAAE;IAE9C,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;IACrC,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS;QAAE,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IACtE,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS;QAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACjE,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;IAChC,OAAO,GAAG,CAAC,GAAG,EAAE,GAAG,UAAU,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,SAAS,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,mBAAmB,EAAE,OAAO,CAAC,CAAC;AACpH,CAAC;AAED,MAAM,kBAAkB,GAAG,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC;AAEnE;;sBAEsB;AACtB,KAAK,UAAU,aAAa,CAAC,QAAkB;IAC7C,IAAI,CAAC,QAAQ,CAAC,EAAE;QAAE,OAAO,cAAc,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,EAAE,QAAQ,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IAC1F,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,kBAAkB,CAAC,IAAI,UAAU,CAAC,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAC,CAA8D,CAAC;QAC9I,IAAI,OAAO,CAAC,IAAI,KAAK,OAAO;YAAE,OAAO,IAAI,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC7F,CAAC;IAAC,MAAM,CAAC;QACP,yBAAyB;IAC3B,CAAC;IACD,OAAO,IAAI,QAAQ,CAAC,qBAAqB,EAAE,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;AAC1E,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,GAAW,EACX,IAAY,EACZ,KAAoC,EACpC,OAAuB;IAEvB,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ;QAAE,OAAO,MAAM,CAAC,CAAC,MAAM,SAAS,CAAC,GAAG,EAAE,IAAI,EAAE,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IAC/F,OAAO,mBAAmB,CAAC,GAAG,EAAE,IAAI,EAAE,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;AAC9D,CAAC;AAED,oDAAoD;AACpD,SAAS,MAAM,CAAC,MAA6B;IAC3C,OAAO;QACL,CAAC,MAAM,CAAC,aAAa,CAAC;YACpB,IAAI,IAAI,GAAG,CAAC,CAAC;YACb,OAAO;gBACL,IAAI,EAAE,GAAwC,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,GAAG,MAAM,CAAC,MAAM;oBACnF,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,IAAI,EAAE,CAAE,EAAE;oBACzC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;aACtC,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC;AAED,0CAA0C;AAC1C,KAAK,UAAU,OAAO,CAAC,MAAiC;IACtD,MAAM,KAAK,GAAiB,EAAE,CAAC;IAC/B,IAAI,IAAI,GAAG,CAAC,CAAC;IACb,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QACjC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAClB,IAAI,IAAI,KAAK,CAAC,MAAM,CAAC;IACvB,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC,CAAC,CAAE,CAAC;IACzC,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC;IACjC,IAAI,EAAE,GAAG,CAAC,CAAC;IACX,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAClB,EAAE,IAAI,IAAI,CAAC,MAAM,CAAC;IACpB,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAYD;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,GAAW,EACX,IAAY,EACZ,EAAU,EACV,MAAc,EACd,UAAkB,EAClB,OAAuB;IAEvB,MAAM,QAAQ,GAAG,MAAM,aAAa,CAAC,GAAG,GAAG,OAAO,UAAU,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,YAAY,GAAG,CAAC,UAAU,CAAC,QAAQ,EAAE;QACjH,MAAM,EAAE,KAAK;QACb,OAAO,EAAE,EAAE,MAAM,EAAE,mBAAmB,EAAE;KACzC,EAAE,OAAO,CAAC,CAAC;IACZ,IAAI,QAAQ,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,CAAC;QAC7F,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAA6F,CAAC;QAC9H,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC9B,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;QAC9G,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,IAAI,EAAE,EAAE,CAAC;IAC9H,CAAC;IACD,MAAM,SAAS,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;IAC3D,IAAI,QAAQ,CAAC,EAAE,IAAI,SAAS,KAAK,IAAI;QAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,UAAU,CAAC,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;IAC/H,MAAM,MAAM,aAAa,CAAC,QAAQ,CAAC,CAAC;AACtC,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,GAAW,EACX,IAAY,EACZ,EAAU,EACV,MAAc,EACd,UAAkB,EAClB,MAAyC,EACzC,OAAuB;IAEvB,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACjH,MAAM,QAAQ,GAAG,MAAM,aAAa,CAAC,GAAG,GAAG,OAAO,UAAU,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,YAAY,GAAG,CAAC,UAAU,CAAC,UAAU,MAAM,CAAC,QAAQ,EAAE,EAAE,EAAE;QACtI,MAAM,EAAE,KAAK;QACb,OAAO,EAAE,EAAE,MAAM,EAAE,mBAAmB,EAAE;KACzC,EAAE,OAAO,CAAC,CAAC;IACZ,IAAI,CAAC,QAAQ,CAAC,EAAE,IAAI,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,KAAK,IAAI;QAAE,MAAM,MAAM,aAAa,CAAC,QAAQ,CAAC,CAAC;IACvG,OAAO,SAAS,CAAC,QAAQ,CAAC,CAAC;AAC7B,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,GAAW,EACX,IAAY,EACZ,EAAU,EACV,MAAc,EACd,GAA0B,EAC1B,OAAuB,EACvB,MAA2B;IAE3B,OAAO,IAAI,CAAC,GAAG,EAAE,GAAG,UAAU,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,WAAW,EAAE,GAAG,EAAE,yBAAyB,EAAE,kBAAkB,EAAE,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;AACnJ,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,GAAW,EACX,IAAY,EACZ,EAAU,EACV,MAAc,EACd,OAAuB;IAEvB,OAAO,GAAG,CAAC,GAAG,EAAE,GAAG,UAAU,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,UAAU,EAAE,oBAAoB,EAAE,OAAO,CAAC,CAAC;AAC5F,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,GAAW,EACX,IAAY,EACZ,EAAU,EACV,MAAc,EACd,GAAsB,EACtB,OAAuB,EACvB,MAA2B;IAE3B,MAAM,IAAI,GAA8B;QACtC,IAAI,EAAE,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI;KACrD,CAAC;IACF,OAAO,IAAI,CAAC,GAAG,EAAE,GAAG,UAAU,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,UAAU,EAAE,IAAI,EAAE,6BAA6B,EAAE,oBAAoB,EAAE,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;AACzJ,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,GAAW,EACX,IAAY,EACZ,EAAU,EACV,MAAc,EACd,EAAU,EACV,GAAyB,EACzB,OAAuB,EACvB,MAA2B;IAE3B,OAAO,IAAI,CAAC,GAAG,EAAE,GAAG,UAAU,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,YAAY,GAAG,CAAC,EAAE,CAAC,UAAU,EAAE,GAAG,EAAE,wBAAwB,EAAE,kBAAkB,EAAE,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;AACpK,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,GAAW,EACX,IAAY,EACZ,EAAU,EACV,MAAc,EACd,EAAU,EACV,OAAuB;IAEvB,OAAO,GAAG,CAAC,GAAG,EAAE,GAAG,UAAU,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,YAAY,GAAG,CAAC,EAAE,CAAC,WAAW,EAAE,wBAAwB,EAAE,OAAO,CAAC,CAAC;AACpH,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,GAAW,EACX,IAAY,EACZ,EAAU,EACV,MAAc,EACd,EAAU,EACV,OAAuB;IAEvB,MAAM,KAAK,GAAG,MAAM,oBAAoB,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7E,OAAO,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC,GAAG,EAAE,IAAI,EAAE,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC;AAC1G,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,GAAW,EACX,IAAY,EACZ,EAAU,EACV,MAAc,EACd,EAAU,EACV,OAAuB;IAEvB,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,MAAM,kBAAkB,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3F,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;AACpD,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,GAAW,EACX,IAAY,EACZ,EAAU,EACV,MAAc,EACd,EAAU,EACV,OAAuB;IAEvB,MAAM,GAAG,CAAC,GAAG,EAAE,GAAG,UAAU,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,YAAY,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;AAC1F,CAAC"}

package/dist/src/roles.d.ts

@@ -0,0 +1,72 @@
+/**
+ * Copyright (c) 2025 Elara AI Pty Ltd
+ * Licensed under BSL 1.1. See LICENSE for details.
+ */
+import { type BusinessRole, type MyAccess, type RolePreview } from '@elaraai/e3-cloud-types';
+import { type RequestOptions } from '@elaraai/e3-api-client';
+/**
+ * A repository's business roles, by name (owner or admin).
+ *
+ * @param url - Base URL of the e3 API server
+ * @param repo - Repository name
+ * @param options - Request options including auth token
+ * @returns The roles
+ */
+export declare function listRoles(url: string, repo: string, options: RequestOptions): Promise<BusinessRole[]>;
+/**
+ * A business role (owner or admin).
+ *
+ * @param url - Base URL of the e3 API server
+ * @param repo - Repository name
+ * @param name - The role's name
+ * @param options - Request options including auth token
+ * @returns The role
+ * @throws When the repository has no role of the name (404 `not_found`)
+ */
+export declare function getRole(url: string, repo: string, name: string, options: RequestOptions): Promise<BusinessRole>;
+/**
+ * Writes a business role whole, made or replaced (owner or admin). Refused
+ * (400) for a name no role may have, a grant of the same app twice, of no
+ * page or a page twice, or of an app or page the repository does not have.
+ *
+ * @param url - Base URL of the e3 API server
+ * @param repo - Repository name
+ * @param role - The role
+ * @param options - Request options including auth token
+ * @returns The role, as stored
+ */
+export declare function putRole(url: string, repo: string, role: BusinessRole, options: RequestOptions): Promise<BusinessRole>;
+/**
+ * Removes a business role, idempotently (owner or admin). Refused (409
+ * `role_in_use`) while anyone of the repository holds it.
+ *
+ * @param url - Base URL of the e3 API server
+ * @param repo - Repository name
+ * @param name - The role's name
+ * @param options - Request options including auth token
+ */
+export declare function deleteRole(url: string, repo: string, name: string, options: RequestOptions): Promise<void>;
+/**
+ * What a user holding one role of a repository, and nothing else, gets
+ * (owner or admin; "Preview as role"): the apps their sidebar lists and what
+ * each grants them, as `myAppList` and `myAccess` would answer such a user.
+ *
+ * @param url - Base URL of the e3 API server
+ * @param repo - Repository name
+ * @param name - The role's name (the built-in All apps included)
+ * @param options - Request options including auth token
+ * @returns The apps, and what each grants
+ * @throws {ApiError} `not_found` for a role the repository has not
+ */
+export declare function previewRole(url: string, repo: string, name: string, options: RequestOptions): Promise<RolePreview>;
+/**
+ * What the caller's roles grant them: each app of the repositories they are
+ * no owner of, with its pages (every page, or those named). An owner's apps
+ * are every page of every one, which the answer leaves out.
+ *
+ * @param url - Base URL of the e3 API server
+ * @param options - Request options including auth token
+ * @returns Each app granted, with its pages
+ */
+export declare function myAccess(url: string, options: RequestOptions): Promise<MyAccess>;
+//# sourceMappingURL=roles.d.ts.map

package/dist/src/roles.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"roles.d.ts","sourceRoot":"","sources":["../../src/roles.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAYH,OAAO,EAIL,KAAK,YAAY,EACjB,KAAK,QAAQ,EAEb,KAAK,WAAW,EACjB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAiB,KAAK,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAM5E;;;;;;;GAOG;AACH,wBAAsB,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,CAE3G;AAED;;;;;;;;;GASG;AACH,wBAAsB,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC,CAErH;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC,CAE3H;AAED;;;;;;;;GAQG;AACH,wBAAsB,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAEhH;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC,CAExH;AAED;;;;;;;;GAQG;AACH,wBAAsB,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC,CAEtF"}

package/dist/src/roles.js

@@ -0,0 +1,95 @@
+/**
+ * Copyright (c) 2025 Elara AI Pty Ltd
+ * Licensed under BSL 1.1. See LICENSE for details.
+ */
+/**
+ * A repository's business roles: the jobs its users do
+ * (Rostering, Finance), each granting apps, every page of each or some. Its
+ * owners and the deployment's admins list, read, write and remove them; a
+ * person holds some, by name (`addUser` with a `user` role). And what a
+ * person's own roles grant them, which the console's and the kiosk's menus
+ * show.
+ */
+import { NullType } from '@elaraai/east';
+import { BusinessRoleListType, BusinessRoleType, MyAccessType, RolePreviewType, } from '@elaraai/e3-cloud-types';
+import { del, get, put } from '@elaraai/e3-api-client';
+const enc = encodeURIComponent;
+const rolesBase = (repo) => `/repos/${enc(repo)}/roles`;
+/**
+ * A repository's business roles, by name (owner or admin).
+ *
+ * @param url - Base URL of the e3 API server
+ * @param repo - Repository name
+ * @param options - Request options including auth token
+ * @returns The roles
+ */
+export async function listRoles(url, repo, options) {
+    return get(url, rolesBase(repo), BusinessRoleListType, options);
+}
+/**
+ * A business role (owner or admin).
+ *
+ * @param url - Base URL of the e3 API server
+ * @param repo - Repository name
+ * @param name - The role's name
+ * @param options - Request options including auth token
+ * @returns The role
+ * @throws When the repository has no role of the name (404 `not_found`)
+ */
+export async function getRole(url, repo, name, options) {
+    return get(url, `${rolesBase(repo)}/${enc(name)}`, BusinessRoleType, options);
+}
+/**
+ * Writes a business role whole, made or replaced (owner or admin). Refused
+ * (400) for a name no role may have, a grant of the same app twice, of no
+ * page or a page twice, or of an app or page the repository does not have.
+ *
+ * @param url - Base URL of the e3 API server
+ * @param repo - Repository name
+ * @param role - The role
+ * @param options - Request options including auth token
+ * @returns The role, as stored
+ */
+export async function putRole(url, repo, role, options) {
+    return put(url, `${rolesBase(repo)}/${enc(role.name)}`, role, BusinessRoleType, BusinessRoleType, options);
+}
+/**
+ * Removes a business role, idempotently (owner or admin). Refused (409
+ * `role_in_use`) while anyone of the repository holds it.
+ *
+ * @param url - Base URL of the e3 API server
+ * @param repo - Repository name
+ * @param name - The role's name
+ * @param options - Request options including auth token
+ */
+export async function deleteRole(url, repo, name, options) {
+    await del(url, `${rolesBase(repo)}/${enc(name)}`, NullType, options);
+}
+/**
+ * What a user holding one role of a repository, and nothing else, gets
+ * (owner or admin; "Preview as role"): the apps their sidebar lists and what
+ * each grants them, as `myAppList` and `myAccess` would answer such a user.
+ *
+ * @param url - Base URL of the e3 API server
+ * @param repo - Repository name
+ * @param name - The role's name (the built-in All apps included)
+ * @param options - Request options including auth token
+ * @returns The apps, and what each grants
+ * @throws {ApiError} `not_found` for a role the repository has not
+ */
+export async function previewRole(url, repo, name, options) {
+    return get(url, `${rolesBase(repo)}/${enc(name)}/preview`, RolePreviewType, options);
+}
+/**
+ * What the caller's roles grant them: each app of the repositories they are
+ * no owner of, with its pages (every page, or those named). An owner's apps
+ * are every page of every one, which the answer leaves out.
+ *
+ * @param url - Base URL of the e3 API server
+ * @param options - Request options including auth token
+ * @returns Each app granted, with its pages
+ */
+export async function myAccess(url, options) {
+    return get(url, '/me/access', MyAccessType, options);
+}
+//# sourceMappingURL=roles.js.map

package/dist/src/roles.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"roles.js","sourceRoot":"","sources":["../../src/roles.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;GAOG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EACL,oBAAoB,EACpB,gBAAgB,EAChB,YAAY,EAGZ,eAAe,GAEhB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAuB,MAAM,wBAAwB,CAAC;AAE5E,MAAM,GAAG,GAAG,kBAAkB,CAAC;AAE/B,MAAM,SAAS,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,UAAU,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC;AAEhE;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,GAAW,EAAE,IAAY,EAAE,OAAuB;IAChF,OAAO,GAAG,CAAC,GAAG,EAAE,SAAS,CAAC,IAAI,CAAC,EAAE,oBAAoB,EAAE,OAAO,CAAC,CAAC;AAClE,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,OAAO,CAAC,GAAW,EAAE,IAAY,EAAE,IAAY,EAAE,OAAuB;IAC5F,OAAO,GAAG,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,gBAAgB,EAAE,OAAO,CAAC,CAAC;AAChF,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,OAAO,CAAC,GAAW,EAAE,IAAY,EAAE,IAAkB,EAAE,OAAuB;IAClG,OAAO,GAAG,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,OAAO,CAAC,CAAC;AAC7G,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,GAAW,EAAE,IAAY,EAAE,IAAY,EAAE,OAAuB;IAC/F,MAAM,GAAG,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;AACvE,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,GAAW,EAAE,IAAY,EAAE,IAAY,EAAE,OAAuB;IAChG,OAAO,GAAG,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,eAAe,EAAE,OAAO,CAAC,CAAC;AACvF,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,GAAW,EAAE,OAAuB;IACjE,OAAO,GAAG,CAAC,GAAG,EAAE,YAAY,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;AACvD,CAAC"}