was-teaching-server 0.9.1

package/dist/requests/CollectionRequest.d.ts

@@ -0,0 +1,234 @@
+/**
+ * Request handlers for Collection operations: get/update/delete a Collection,
+ * list its items, and add a Resource to it.
+ */
+import type { FastifyReply, FastifyRequest } from 'fastify';
+import type { StorageBackend } from '../types.js';
+export declare class CollectionRequest {
+    /**
+     * POST /space/:spaceId/:collectionId/
+     * Request handler for "Create Resource" request
+     * Before this, `parseAuthHeaders()` hook executed, resulting in:
+     * request.zcap: {
+     *   keyId, headers, signature, created, expires, invocation, digest
+     * }
+     *
+     * @param request {import('fastify').FastifyRequest}
+     * @param reply {import('fastify').FastifyReply}
+     * @returns {Promise<FastifyReply>}
+     */
+    static post(request: FastifyRequest<{
+        Params: {
+            spaceId: string;
+            collectionId: string;
+        };
+    }>, reply: FastifyReply): Promise<FastifyReply>;
+    /**
+     * PUT /space/:spaceId/:collectionId
+     * Request handler for "Update (or Create By Id) Collection" request
+     * Before this, `parseAuthHeaders()` hook executed, resulting in:
+     * request.zcap: {
+     *   keyId, headers, signature, created, expires, invocation, digest
+     * }
+     *
+     * @param request {import('fastify').FastifyRequest}
+     * @param reply {import('fastify').FastifyReply}
+     * @returns {Promise<FastifyReply>}
+     */
+    static put(request: FastifyRequest<{
+        Params: {
+            spaceId: string;
+            collectionId: string;
+        };
+        Body: {
+            id?: string;
+            name?: string;
+            backend?: unknown;
+            encryption?: unknown;
+        };
+    }>, reply: FastifyReply): Promise<FastifyReply>;
+    /**
+     * GET /space/:spaceId/:collectionId (no trailing slash): Get Collection details
+     *
+     * @param request {import('fastify').FastifyRequest}
+     * @param reply {import('fastify').FastifyReply}
+     * @returns {Promise<FastifyReply>}
+     */
+    static get(request: FastifyRequest<{
+        Params: {
+            spaceId: string;
+            collectionId: string;
+        };
+    }>, reply: FastifyReply): Promise<FastifyReply>;
+    /**
+     * GET /space/:spaceId/:collectionId/linkset
+     * Request handler for the Collection's linkset (RFC9264): advertises the
+     * Collection's access-control `policy` and selected `backend` resources for
+     * discovery. Readable by whoever may read the Collection (capability or
+     * fallback policy).
+     *
+     * @param request {import('fastify').FastifyRequest}
+     * @param reply {import('fastify').FastifyReply}
+     * @returns {Promise<FastifyReply>}
+     */
+    static linkset(request: FastifyRequest<{
+        Params: {
+            spaceId: string;
+            collectionId: string;
+        };
+    }>, reply: FastifyReply): Promise<FastifyReply>;
+    /**
+     * GET /space/:spaceId/:collectionId/backend
+     * Request handler for "Collection Backend Selected": returns the detailed
+     * backend description object for the Collection's selected backend (resolved
+     * from the Collection's stored `{ id }` against the Space's backends-available;
+     * default-filled for Collections created before the property existed).
+     *
+     * Authorization is capability-or-policy, the same as Get Collection: the
+     * selected backend is no more sensitive than the Collection description, so a
+     * public-readable Collection may also read its backend.
+     *
+     * @param request {import('fastify').FastifyRequest}
+     * @param reply {import('fastify').FastifyReply}
+     * @returns {Promise<FastifyReply>}
+     */
+    static getBackend(request: FastifyRequest<{
+        Params: {
+            spaceId: string;
+            collectionId: string;
+        };
+    }>, reply: FastifyReply): Promise<FastifyReply>;
+    /**
+     * GET /space/:spaceId/:collectionId/quota
+     * Request handler for the per-Collection "Quotas" report (spec "Quotas"):
+     * the storage report for a single Collection, scoped to its backend (a single
+     * backend-usage entry whose `usageBytes` reflects only this Collection). A
+     * backend that cannot account per-Collection yields `unsupported-operation`
+     * (501); the filesystem backend supports it.
+     *
+     * Authorization is capability-or-policy, the same as the Space Quota report:
+     * a caller not authorized to read it receives a 404 (maximum-privacy
+     * invariant), and a public-readable Collection may read its quota.
+     *
+     * @param request {import('fastify').FastifyRequest}
+     * @param reply {import('fastify').FastifyReply}
+     * @returns {Promise<FastifyReply>}
+     */
+    static getQuota(request: FastifyRequest<{
+        Params: {
+            spaceId: string;
+            collectionId: string;
+        };
+    }>, reply: FastifyReply): Promise<FastifyReply>;
+    /**
+     * POST /space/:spaceId/:collectionId/query
+     * The reserved Collection `query` endpoint (spec "Collection-level reserved
+     * endpoints"). This server serves two profiles, selected by the body's
+     * `profile`:
+     *
+     * - `changes` -- the replication change feed: the Collection's JSON
+     *   documents and tombstones changed strictly after `checkpoint`, in change
+     *   order, capped at `limit`.
+     * - `blinded-index` -- the EDV blinded-attribute query (the
+     *   `blinded-index-query` backend feature): `{index, equals | has, count,
+     *   limit, cursor}` evaluated against the HMAC-blinded `indexed` entries of
+     *   the Collection's stored documents, answering `{documents, hasMore,
+     *   cursor?}` (matching documents verbatim, opaque-cursor paginated) or
+     *   `{count}`.
+     *
+     * The query parameters ride the signed JSON POST body (covered by the
+     * `Digest`), so no `allowTargetQuery` is needed. A body naming any other
+     * profile, or a backend without the profile's method, yields
+     * `unsupported-operation` (501). Authorization is capability-or-policy, the
+     * same read semantics as List Collection: an under-authorized caller
+     * receives a 404.
+     *
+     * @param request {import('fastify').FastifyRequest}
+     * @param reply {import('fastify').FastifyReply}
+     * @returns {Promise<FastifyReply>}
+     */
+    static query(request: FastifyRequest<{
+        Params: {
+            spaceId: string;
+            collectionId: string;
+        };
+        Body: {
+            profile?: string;
+            checkpoint?: {
+                id?: unknown;
+                updatedAt?: unknown;
+            };
+            limit?: unknown;
+            index?: unknown;
+            equals?: unknown;
+            has?: unknown;
+            count?: unknown;
+            cursor?: unknown;
+        };
+    }>, reply: FastifyReply): Promise<FastifyReply>;
+    /**
+     * The `changes` profile of the Collection `query` endpoint (see `query`
+     * above): parses the checkpoint/limit, pulls the page from the backend's
+     * change feed, and projects it to the wire shape.
+     *
+     * @param options {object}
+     * @param options.reply {import('fastify').FastifyReply}
+     * @param options.dataBackend {StorageBackend}
+     * @param options.spaceId {string}
+     * @param options.collectionId {string}
+     * @param options.body {object}   the query POST body
+     * @param options.requestName {string}
+     * @returns {Promise<FastifyReply>}
+     */
+    static _queryChanges({ reply, dataBackend, spaceId, collectionId, body, requestName }: {
+        reply: FastifyReply;
+        dataBackend: StorageBackend;
+        spaceId: string;
+        collectionId: string;
+        body: {
+            checkpoint?: {
+                id?: unknown;
+                updatedAt?: unknown;
+            };
+            limit?: unknown;
+        };
+        requestName: string;
+    }): Promise<FastifyReply>;
+    /**
+     * DELETE /space/:spaceId/:collectionId
+     * Request handler for "Delete Collection" request
+     * Before this, `parseAuthHeaders()` hook executed, resulting in:
+     * request.zcap: {
+     *   keyId, headers, signature, created, expires, invocation, digest
+     * }
+     *
+     * @param request {import('fastify').FastifyRequest}
+     * @param reply {import('fastify').FastifyReply}
+     * @returns {Promise<FastifyReply>}
+     */
+    static delete(request: FastifyRequest<{
+        Params: {
+            spaceId: string;
+            collectionId: string;
+        };
+    }>, reply: FastifyReply): Promise<FastifyReply>;
+    /**
+     * GET /space/:spaceId/:collectionId/ (with trailing slash):
+     * List Collection items
+     *
+     * @param request {import('fastify').FastifyRequest}
+     * @param reply {import('fastify').FastifyReply}
+     * @returns {Promise<FastifyReply>}
+     */
+    static list(request: FastifyRequest<{
+        Params: {
+            spaceId: string;
+            collectionId: string;
+        };
+        Querystring: {
+            limit?: string;
+            cursor?: string;
+        };
+    }>, reply: FastifyReply): Promise<FastifyReply>;
+}
+//# sourceMappingURL=CollectionRequest.d.ts.map

package/dist/requests/CollectionRequest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CollectionRequest.d.ts","sourceRoot":"","sources":["../../src/requests/CollectionRequest.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAU3D,OAAO,KAAK,EAAyB,cAAc,EAAE,MAAM,aAAa,CAAA;AA8BxE,qBAAa,iBAAiB;IAC5B;;;;;;;;;;;OAWG;WACU,IAAI,CACf,OAAO,EAAE,cAAc,CAAC;QACtB,MAAM,EAAE;YAAE,OAAO,EAAE,MAAM,CAAC;YAAC,YAAY,EAAE,MAAM,CAAA;SAAE,CAAA;KAClD,CAAC,EACF,KAAK,EAAE,YAAY,GAClB,OAAO,CAAC,YAAY,CAAC;IA8FxB;;;;;;;;;;;OAWG;WACU,GAAG,CACd,OAAO,EAAE,cAAc,CAAC;QACtB,MAAM,EAAE;YAAE,OAAO,EAAE,MAAM,CAAC;YAAC,YAAY,EAAE,MAAM,CAAA;SAAE,CAAA;QACjD,IAAI,EAAE;YACJ,EAAE,CAAC,EAAE,MAAM,CAAA;YACX,IAAI,CAAC,EAAE,MAAM,CAAA;YACb,OAAO,CAAC,EAAE,OAAO,CAAA;YACjB,UAAU,CAAC,EAAE,OAAO,CAAA;SACrB,CAAA;KACF,CAAC,EACF,KAAK,EAAE,YAAY,GAClB,OAAO,CAAC,YAAY,CAAC;IAqJxB;;;;;;OAMG;WACU,GAAG,CACd,OAAO,EAAE,cAAc,CAAC;QACtB,MAAM,EAAE;YAAE,OAAO,EAAE,MAAM,CAAC;YAAC,YAAY,EAAE,MAAM,CAAA;SAAE,CAAA;KAClD,CAAC,EACF,KAAK,EAAE,YAAY,GAClB,OAAO,CAAC,YAAY,CAAC;IA2DxB;;;;;;;;;;OAUG;WACU,OAAO,CAClB,OAAO,EAAE,cAAc,CAAC;QACtB,MAAM,EAAE;YAAE,OAAO,EAAE,MAAM,CAAC;YAAC,YAAY,EAAE,MAAM,CAAA;SAAE,CAAA;KAClD,CAAC,EACF,KAAK,EAAE,YAAY,GAClB,OAAO,CAAC,YAAY,CAAC;IA2BxB;;;;;;;;;;;;;;OAcG;WACU,UAAU,CACrB,OAAO,EAAE,cAAc,CAAC;QACtB,MAAM,EAAE;YAAE,OAAO,EAAE,MAAM,CAAC;YAAC,YAAY,EAAE,MAAM,CAAA;SAAE,CAAA;KAClD,CAAC,EACF,KAAK,EAAE,YAAY,GAClB,OAAO,CAAC,YAAY,CAAC;IAoCxB;;;;;;;;;;;;;;;OAeG;WACU,QAAQ,CACnB,OAAO,EAAE,cAAc,CAAC;QACtB,MAAM,EAAE;YAAE,OAAO,EAAE,MAAM,CAAC;YAAC,YAAY,EAAE,MAAM,CAAA;SAAE,CAAA;KAClD,CAAC,EACF,KAAK,EAAE,YAAY,GAClB,OAAO,CAAC,YAAY,CAAC;IAgDxB;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;WACU,KAAK,CAChB,OAAO,EAAE,cAAc,CAAC;QACtB,MAAM,EAAE;YAAE,OAAO,EAAE,MAAM,CAAC;YAAC,YAAY,EAAE,MAAM,CAAA;SAAE,CAAA;QACjD,IAAI,EAAE;YACJ,OAAO,CAAC,EAAE,MAAM,CAAA;YAChB,UAAU,CAAC,EAAE;gBAAE,EAAE,CAAC,EAAE,OAAO,CAAC;gBAAC,SAAS,CAAC,EAAE,OAAO,CAAA;aAAE,CAAA;YAClD,KAAK,CAAC,EAAE,OAAO,CAAA;YACf,KAAK,CAAC,EAAE,OAAO,CAAA;YACf,MAAM,CAAC,EAAE,OAAO,CAAA;YAChB,GAAG,CAAC,EAAE,OAAO,CAAA;YACb,KAAK,CAAC,EAAE,OAAO,CAAA;YACf,MAAM,CAAC,EAAE,OAAO,CAAA;SACjB,CAAA;KACF,CAAC,EACF,KAAK,EAAE,YAAY,GAClB,OAAO,CAAC,YAAY,CAAC;IAmExB;;;;;;;;;;;;;OAaG;WACU,aAAa,CAAC,EACzB,KAAK,EACL,WAAW,EACX,OAAO,EACP,YAAY,EACZ,IAAI,EACJ,WAAW,EACZ,EAAE;QACD,KAAK,EAAE,YAAY,CAAA;QACnB,WAAW,EAAE,cAAc,CAAA;QAC3B,OAAO,EAAE,MAAM,CAAA;QACf,YAAY,EAAE,MAAM,CAAA;QACpB,IAAI,EAAE;YACJ,UAAU,CAAC,EAAE;gBAAE,EAAE,CAAC,EAAE,OAAO,CAAC;gBAAC,SAAS,CAAC,EAAE,OAAO,CAAA;aAAE,CAAA;YAClD,KAAK,CAAC,EAAE,OAAO,CAAA;SAChB,CAAA;QACD,WAAW,EAAE,MAAM,CAAA;KACpB,GAAG,OAAO,CAAC,YAAY,CAAC;IA6DzB;;;;;;;;;;;OAWG;WACU,MAAM,CACjB,OAAO,EAAE,cAAc,CAAC;QACtB,MAAM,EAAE;YAAE,OAAO,EAAE,MAAM,CAAC;YAAC,YAAY,EAAE,MAAM,CAAA;SAAE,CAAA;KAClD,CAAC,EACF,KAAK,EAAE,YAAY,GAClB,OAAO,CAAC,YAAY,CAAC;IA+BxB;;;;;;;OAOG;WACU,IAAI,CACf,OAAO,EAAE,cAAc,CAAC;QACtB,MAAM,EAAE;YAAE,OAAO,EAAE,MAAM,CAAC;YAAC,YAAY,EAAE,MAAM,CAAA;SAAE,CAAA;QACjD,WAAW,EAAE;YAAE,KAAK,CAAC,EAAE,MAAM,CAAC;YAAC,MAAM,CAAC,EAAE,MAAM,CAAA;SAAE,CAAA;KACjD,CAAC,EACF,KAAK,EAAE,YAAY,GAClB,OAAO,CAAC,YAAY,CAAC;CAoEzB"}