@enbox/api 0.2.3 → 0.2.4

package/dist/types/record.d.ts

@@ -3,142 +3,11 @@
  * https://github.com/enboxorg/enbox/pull/507
  */
 import type { DwnDateSort, DwnMessage, DwnMessageDescriptor, DwnPaginationCursor, DwnResponseStatus, PermissionsApi, Web5Agent } from '@enbox/agent';
+import type { RecordDeleteParams, RecordModel, RecordOptions, RecordUpdateParams } from './record-types.js';
 import { DwnInterface } from '@enbox/agent';
-/**
- * Represents Immutable Record properties that cannot be changed after the record is created.
- *
- * @beta
- * */
-export type ImmutableRecordProperties = Pick<DwnMessageDescriptor[DwnInterface.RecordsWrite], 'dateCreated' | 'parentId' | 'protocol' | 'protocolPath' | 'recipient' | 'schema'>;
-/**
- * Represents Optional Record properties that depend on the Record's current state.
- *
- * @beta
-*/
-export type OptionalRecordProperties = Pick<DwnMessage[DwnInterface.RecordsWrite], 'authorization' | 'attestation' | 'encryption' | 'contextId'> & Pick<DwnMessageDescriptor[DwnInterface.RecordsWrite], 'dataFormat' | 'dataCid' | 'dataSize' | 'datePublished' | 'published' | 'tags'>;
-/**
- * Represents the structured data model of a record, encapsulating the essential fields that define
- * the record's metadata and payload within a Decentralized Web Node (DWN).
- *
- * @beta
- */
-export type RecordModel = ImmutableRecordProperties & OptionalRecordProperties & {
-    /** The logical author of the record. */
-    author: string;
-    /** The unique identifier of the record. */
-    recordId?: string;
-    /** The message timestamp (time of creation, most recent update, or deletion). */
-    timestamp?: string;
-    /** The protocol role under which this record is written. */
-    protocolRole?: RecordOptions['protocolRole'];
-};
-/**
- * Options for configuring a {@link Record} instance, extending the base `RecordsWriteMessage` with
- * additional properties.
- *
- * This type combines the standard fields required for writing DWN records with additional metadata
- * and configuration options used specifically in the {@link Record} class.
- *
- * @beta
- */
-export type RecordOptions = DwnMessage[DwnInterface.RecordsWrite | DwnInterface.RecordsDelete] & {
-    /** The DID that signed the record. */
-    author: string;
-    /** The attestation signature(s) for the record. */
-    attestation?: DwnMessage[DwnInterface.RecordsWrite]['attestation'];
-    /** The encryption information for the record. */
-    encryption?: DwnMessage[DwnInterface.RecordsWrite]['encryption'];
-    /** The contextId associated with the record. */
-    contextId?: string;
-    /** The unique identifier of the record */
-    recordId?: string;
-    /** The DID of the DWN tenant under which record operations are being performed. */
-    connectedDid: string;
-    /** The optional DID that will sign the records on behalf of the connectedDid  */
-    delegateDid?: string;
-    /** The data of the record, either as a Base64 URL encoded string or a Blob. */
-    encodedData?: string | Blob;
-    /**
-     * A stream of data, conforming to the Web `ReadableStream` interface, providing a mechanism
-     * to read the record's data sequentially. This is particularly useful for handling large
-     * datasets that should not be loaded entirely in memory, allowing for efficient, chunked
-     * processing of the record's data.
-     *
-     * The DWN SDK now returns Web `ReadableStream` natively, so no conversion is needed.
-     */
-    data?: ReadableStream;
-    /** The initial `RecordsWriteMessage` that represents the initial state/version of the record. */
-    initialWrite?: DwnMessage[DwnInterface.RecordsWrite];
-    /** The protocol role under which this record is written. */
-    protocolRole?: string;
-    /** The remote tenant DID if the record was queried or read from a remote DWN. */
-    remoteOrigin?: string;
-};
-/**
- * Parameters for updating a DWN record.
- *
- * This type specifies the set of properties that can be updated on an existing record. It is used
- * to convey the new state or changes to be applied to the record.
- *
- * @beta
- */
-export type RecordUpdateParams = {
-    /**
-     * The new data for the record, which can be of any type. This data will replace the existing
-     * data of the record. It's essential to ensure that this data is compatible with the record's
-     * schema or data format expectations.
-     */
-    data?: unknown;
-    /**
-     * The Content Identifier (CID) of the data. Updating this value changes the reference to the data
-     * associated with the record.
-     */
-    dataCid?: DwnMessageDescriptor[DwnInterface.RecordsWrite]['dataCid'];
-    /** Whether or not to store the updated message. */
-    store?: boolean;
-    /** The data format/MIME type of the supplied data */
-    dataFormat?: string;
-    /** The size of the data in bytes. */
-    dataSize?: DwnMessageDescriptor[DwnInterface.RecordsWrite]['dataSize'];
-    /** The timestamp of the update message. */
-    timestamp?: DwnMessageDescriptor[DwnInterface.RecordsWrite]['messageTimestamp'];
-    /** The timestamp indicating when the record was published. */
-    datePublished?: DwnMessageDescriptor[DwnInterface.RecordsWrite]['datePublished'];
-    /** The protocol role under which this record is written. */
-    protocolRole?: RecordOptions['protocolRole'];
-    /** The published status of the record. */
-    published?: DwnMessageDescriptor[DwnInterface.RecordsWrite]['published'];
-    /** The tags associated with the updated record */
-    tags?: DwnMessageDescriptor[DwnInterface.RecordsWrite]['tags'];
-    /**
-     * Controls whether the updated record should be auto-encrypted.
-     *
-     * If omitted, auto-detected from the original record: if the record was
-     * originally encrypted, the update is automatically re-encrypted with a
-     * fresh DEK. Set to `false` explicitly to skip encryption on the update.
-     */
-    encryption?: boolean;
-};
-/**
- * Parameters for deleting a DWN record.
- *
- * This type specifies the set of properties that are used when deleting an existing record. It is used
- * to convey the new state or changes to be applied to the record.
- *
- * @beta
- */
-export type RecordDeleteParams = {
-    /** Whether or not to store the message. */
-    store?: boolean;
-    /** Whether or not to sign the delete as an owner in order to import it. */
-    signAsOwner?: boolean;
-    /** Whether or not to prune any children this record may have. */
-    prune?: DwnMessageDescriptor[DwnInterface.RecordsDelete]['prune'];
-    /** The timestamp of the delete message. */
-    timestamp?: DwnMessageDescriptor[DwnInterface.RecordsDelete]['messageTimestamp'];
-    /** The protocol role under which this record will be deleted. */
-    protocolRole?: string;
-};
+import type { RecordData } from './record-data.js';
+export type { ImmutableRecordProperties, OptionalRecordProperties, RecordDeleteParams, RecordModel, RecordOptions, RecordUpdateParams, } from './record-types.js';
+export type { RecordData } from './record-data.js';
 /**
  * The result of a {@link Record.update} operation.
  *
@@ -282,15 +151,7 @@ export declare class Record implements RecordModel {
      *
      * @beta
      */
-    get data(): {
-        blob: () => Promise<Blob>;
-        bytes: () => Promise<Uint8Array>;
-        json: <T = unknown>() => Promise<T>;
-        text: () => Promise<string>;
-        stream: () => Promise<ReadableStream>;
-        then: (onFulfilled?: (value: ReadableStream) => ReadableStream | PromiseLike<ReadableStream>, onRejected?: (reason: any) => PromiseLike<never>) => Promise<ReadableStream>;
-        catch: (onRejected?: (reason: any) => PromiseLike<never>) => Promise<ReadableStream>;
-    };
+    get data(): RecordData;
     /**
      * Stores the current record state as well as any initial write to the owner's DWN.
      *
@@ -382,6 +243,14 @@ export declare class Record implements RecordModel {
      * @beta
      */
     private readRecordData;
+    /**
+     * If the record is operating as a delegate, fetches the appropriate permission grant
+     * and applies it to the given DWN request options. This centralises the repeated
+     * pattern of looking up a delegated grant and attaching it to a request.
+     *
+     * @param requestOptions - The DWN request options to augment with the delegate grant.
+     */
+    private applyDelegateGrant;
     /**
      * Verifies if the properties to be mutated are mutable.
      *

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

@@ -1 +1 @@
-{"version":3,"file":"record.d.ts","sourceRoot":"","sources":["../../src/record.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EACV,WAAW,EACX,UAAU,EACV,oBAAoB,EAEpB,mBAAmB,EACnB,iBAAiB,EACjB,cAAc,EAGd,SAAS,EACV,MAAM,cAAc,CAAC;AAEtB,OAAO,EAEL,YAAY,EAKb,MAAM,cAAc,CAAC;AAKtB;;;;KAIK;AACL,MAAM,MAAM,yBAAyB,GACnC,IAAI,CAAC,oBAAoB,CAAC,YAAY,CAAC,YAAY,CAAC,EAAE,aAAa,GAAG,UAAU,GAAG,UAAU,GAAG,cAAc,GAAG,WAAW,GAAG,QAAQ,CAAC,CAAC;AAE3I;;;;EAIE;AACF,MAAM,MAAM,wBAAwB,GAClC,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC,EAAE,eAAe,GAAG,aAAa,GAAG,YAAY,GAAG,WAAW,CAAE,GAC1G,IAAI,CAAC,oBAAoB,CAAC,YAAY,CAAC,YAAY,CAAC,EAAE,YAAY,GAAG,SAAS,GAAG,UAAU,GAAG,eAAe,GAAG,WAAW,GAAG,MAAM,CAAC,CAAC;AAExI;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GAAG,yBAAyB,GAAG,wBAAwB,GAAG;IAE/E,wCAAwC;IACxC,MAAM,EAAE,MAAM,CAAC;IAEf,2CAA2C;IAC3C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,iFAAiF;IACjF,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,4DAA4D;IAC5D,YAAY,CAAC,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC;CAC9C,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,YAAY,CAAC,YAAY,GAAG,YAAY,CAAC,aAAa,CAAC,GAAG;IAC/F,sCAAsC;IACtC,MAAM,EAAE,MAAM,CAAC;IAEf,mDAAmD;IACnD,WAAW,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,aAAa,CAAC,CAAC;IAEnE,iDAAiD;IACjD,UAAU,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,YAAY,CAAC,CAAC;IAEjE,gDAAgD;IAChD,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,mFAAmF;IACnF,YAAY,EAAE,MAAM,CAAC;IAErB,iFAAiF;IACjF,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,+EAA+E;IAC/E,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;;;;;OAOG;IACH,IAAI,CAAC,EAAE,cAAc,CAAC;IAEtB,iGAAiG;IACjG,YAAY,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;IAErD,4DAA4D;IAC5D,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,iFAAiF;IACjF,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;;OAIG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf;;;OAGG;IACH,OAAO,CAAC,EAAE,oBAAoB,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,SAAS,CAAC,CAAC;IAErE,mDAAmD;IACnD,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB,qDAAqD;IACrD,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,qCAAqC;IACrC,QAAQ,CAAC,EAAE,oBAAoB,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,UAAU,CAAC,CAAC;IAEvE,2CAA2C;IAC3C,SAAS,CAAC,EAAE,oBAAoB,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,kBAAkB,CAAC,CAAC;IAEhF,8DAA8D;IAC9D,aAAa,CAAC,EAAE,oBAAoB,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,eAAe,CAAC,CAAC;IAEjF,4DAA4D;IAC5D,YAAY,CAAC,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC;IAE7C,0CAA0C;IAC1C,SAAS,CAAC,EAAE,oBAAoB,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,WAAW,CAAC,CAAC;IAGzE,kDAAkD;IAClD,IAAI,CAAC,EAAE,oBAAoB,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC;IAE/D;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,2CAA2C;IAC3C,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB,2EAA2E;IAC3E,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB,iEAAiE;IACjE,KAAK,CAAC,EAAE,oBAAoB,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC;IAElE,2CAA2C;IAC3C,SAAS,CAAC,EAAE,oBAAoB,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,kBAAkB,CAAC,CAAC;IAEjF,iEAAiE;IACjE,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,iBAAiB,GAAG;IACnD,4DAA4D;IAC5D,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,iBAAiB,GAAG;IACnD,gEAAgE;IAChE,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,qBAAa,MAAO,YAAW,WAAW;IACxC;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,UAAU,CAAa;IAItC,iEAAiE;IACjE,OAAO,CAAC,MAAM,CAAY;IAC1B,4EAA4E;IAC5E,OAAO,CAAC,aAAa,CAAS;IAC9B,8EAA8E;IAC9E,OAAO,CAAC,YAAY,CAAC,CAAS;IAC9B,4GAA4G;IAC5G,OAAO,CAAC,eAAe,CAAiB;IACxC,gDAAgD;IAChD,OAAO,CAAC,YAAY,CAAC,CAAO;IAC5B,yFAAyF;IACzF,OAAO,CAAC,eAAe,CAAC,CAAiB;IACzC,kEAAkE;IAClE,OAAO,CAAC,aAAa,CAAC,CAAS;IAI/B,+EAA+E;IAC/E,OAAO,CAAC,OAAO,CAAS;IACxB,gEAAgE;IAChE,OAAO,CAAC,QAAQ,CAAS;IACzB,iCAAiC;IACjC,OAAO,CAAC,YAAY,CAAC,CAAuD;IAC5E,kCAAkC;IAClC,OAAO,CAAC,cAAc,CAAC,CAAsF;IAC7G,6CAA6C;IAC7C,OAAO,CAAC,UAAU,CAAC,CAAS;IAC5B,4EAA4E;IAC5E,OAAO,CAAC,WAAW,CAAqG;IACxH,mEAAmE;IACnE,OAAO,CAAC,WAAW,CAAC,CAAsD;IAC1E,sDAAsD;IACtD,OAAO,CAAC,aAAa,CAAgC;IACrD,mFAAmF;IACnF,OAAO,CAAC,mBAAmB,CAAU;IACrC,yEAAyE;IACzE,OAAO,CAAC,mBAAmB,CAAU;IACrC,uCAAuC;IACvC,OAAO,CAAC,SAAS,CAAS;IAC1B,8CAA8C;IAC9C,OAAO,CAAC,aAAa,CAAC,CAAgC;IAEtD,+EAA+E;IAC/E,OAAO,CAAC,gBAAgB,CAAC,CAAiF;IAC1G,wEAAwE;IACxE,OAAO,CAAC,gBAAgB,CAAiB;IAEzC,mFAAmF;IACnF,OAAO,KAAK,uBAAuB,GAMlC;IAED,qHAAqH;IACrH,OAAO,KAAK,oBAAoB,GAE/B;IAGD,kBAAkB;IAClB,IAAI,EAAE,IAAI,MAAM,CAA2B;IAE3C,iGAAiG;IACjG,IAAI,SAAS,IAAI,MAAM,GAAG,SAAS,CAA0E;IAE7G,6BAA6B;IAC7B,IAAI,WAAW,IAAI,MAAM,CAAkD;IAE3E,yBAAyB;IACzB,IAAI,QAAQ,IAAI,MAAM,GAAG,SAAS,CAA+C;IAEjF,wBAAwB;IACxB,IAAI,QAAQ,IAAI,MAAM,GAAG,SAAS,CAA+C;IAEjF,6BAA6B;IAC7B,IAAI,YAAY,IAAI,MAAM,GAAG,SAAS,CAAmD;IAEzF,yBAAyB;IACzB,IAAI,SAAS,IAAI,MAAM,GAAG,SAAS,CAAgD;IAEnF,sBAAsB;IACtB,IAAI,MAAM,IAAI,MAAM,GAAG,SAAS,CAA6C;IAI7E,2BAA2B;IAC3B,IAAI,UAAU,IAAI,MAAM,GAAG,SAAS,CAAqD;IAEzF,mBAAmB;IACnB,IAAI,OAAO,IAAI,MAAM,GAAG,SAAS,CAAkD;IAEnF,yBAAyB;IACzB,IAAI,QAAQ,IAAI,MAAM,GAAG,SAAS,CAAmD;IAErF,8BAA8B;IAC9B,IAAI,aAAa,IAAI,MAAM,GAAG,SAAS,CAAwD;IAE/F,6CAA6C;IAC7C,IAAI,SAAS,IAAI,OAAO,GAAG,SAAS,CAAoD;IAExF,yBAAyB;IACzB,IAAI,IAAI,IAAI,oBAAoB,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,GAAG,SAAS,CAE9E;IAGD,oDAAoD;IACpD,IAAI,MAAM,IAAI,MAAM,CAAyB;IAE7C,sDAAsD;IACtD,IAAI,OAAO,IAAI,MAAM,CAA0B;IAE/C,sFAAsF;IACtF,IAAI,SAAS,IAAI,MAAM,CAA8C;IAErE,0BAA0B;IAC1B,IAAI,UAAU,IAAI,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,YAAY,CAAC,CAA6B;IAElG,sCAAsC;IACtC,IAAI,aAAa,IAAI,UAAU,CAAC,YAAY,CAAC,YAAY,GAAG,YAAY,CAAC,aAAa,CAAC,CAAC,eAAe,CAAC,CAAgC;IAExI,sCAAsC;IACtC,IAAI,WAAW,IAAI,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,aAAa,CAAC,GAAG,SAAS,CAA8B;IAEjH,wDAAwD;IACxD,IAAI,YAAY,IAAI,MAAM,GAAG,SAAS,CAA+B;IAErE,0CAA0C;IAC1C,IAAI,OAAO,IAAI,OAAO,CAA6D;IAEnF,4DAA4D;IAC5D,IAAI,YAAY,IAAI,aAAa,CAAC,cAAc,CAAC,CAA+B;IAEhF;;;OAGG;IACH,IAAI,UAAU,IAAI,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC,GAAG,UAAU,CAAC,YAAY,CAAC,aAAa,CAAC,CA4B/F;gBAEW,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,aAAa,EAAE,cAAc,CAAC,EAAE,cAAc;IAiDrF;;;;;;;OAOG;IACH,IAAI,IAAI,IAAI;QACR,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;QAC1B,KAAK,EAAE,MAAM,OAAO,CAAC,UAAU,CAAC,CAAC;QACjC,IAAI,EAAE,CAAC,CAAC,GAAG,OAAO,OAAO,OAAO,CAAC,CAAC,CAAC,CAAC;QACpC,IAAI,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;QAC5B,MAAM,EAAE,MAAM,OAAO,CAAC,cAAc,CAAC,CAAC;QACtC,IAAI,EAAE,CACJ,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,cAAc,GAAG,WAAW,CAAC,cAAc,CAAC,EACrF,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,KAAK,WAAW,CAAC,KAAK,CAAC,KAC7C,OAAO,CAAC,cAAc,CAAC,CAAC;QAC7B,KAAK,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,KAAK,WAAW,CAAC,KAAK,CAAC,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;KACpF,CAkIJ;IAED;;;;;;;OAOG;IACG,KAAK,CAAC,YAAY,GAAE,OAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAKtE;;;;;;;;OAQG;IACG,MAAM,CAAC,KAAK,GAAE,OAAc,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAI/D;;;;;;;;;;;;OAYG;IACG,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IA+CvD;;;OAGG;IACH,MAAM,IAAI,WAAW;IAyBrB;;;OAGG;IACH,QAAQ,IAAI,MAAM;IAqBlB;;;;;OAKG;IACG,gBAAgB,CAAC,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,GAAG,SAAS,CAAC;IAInF;;;;;;;OAOG;IACG,MAAM,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,UAAU,EAAE,YAAY,EAAE,KAAY,EAAE,GAAG,MAAM,EAAE,EAAE,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAsGrI;;;;OAIG;IACG,MAAM,CAAC,YAAY,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAsF5E;;OAEG;YACW,2BAA2B;IAiDzC;;;OAGG;YACW,aAAa;IAkE3B;;;;;;;;;;;;;;;OAeG;YACW,cAAc;IAyD5B;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,MAAM,CAAC,uBAAuB;IAQtC;;;;OAIG;IACH,OAAO,CAAC,yBAAyB;CAKlC"}
+{"version":3,"file":"record.d.ts","sourceRoot":"","sources":["../../src/record.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EACV,WAAW,EACX,UAAU,EACV,oBAAoB,EAEpB,mBAAmB,EACnB,iBAAiB,EACjB,cAAc,EAGd,SAAS,EACV,MAAM,cAAc,CAAC;AAEtB,OAAO,KAAK,EACV,kBAAkB,EAClB,WAAW,EACX,aAAa,EACb,kBAAkB,EACnB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAEL,YAAY,EAKb,MAAM,cAAc,CAAC;AAGtB,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAOnD,YAAY,EACV,yBAAyB,EACzB,wBAAwB,EACxB,kBAAkB,EAClB,WAAW,EACX,aAAa,EACb,kBAAkB,GACnB,MAAM,mBAAmB,CAAC;AAE3B,YAAY,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEnD;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,iBAAiB,GAAG;IACnD,4DAA4D;IAC5D,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,iBAAiB,GAAG;IACnD,gEAAgE;IAChE,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,qBAAa,MAAO,YAAW,WAAW;IACxC;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,UAAU,CAAa;IAItC,iEAAiE;IACjE,OAAO,CAAC,MAAM,CAAY;IAC1B,4EAA4E;IAC5E,OAAO,CAAC,aAAa,CAAS;IAC9B,8EAA8E;IAC9E,OAAO,CAAC,YAAY,CAAC,CAAS;IAC9B,4GAA4G;IAC5G,OAAO,CAAC,eAAe,CAAiB;IACxC,gDAAgD;IAChD,OAAO,CAAC,YAAY,CAAC,CAAO;IAC5B,yFAAyF;IACzF,OAAO,CAAC,eAAe,CAAC,CAAiB;IACzC,kEAAkE;IAClE,OAAO,CAAC,aAAa,CAAC,CAAS;IAI/B,+EAA+E;IAC/E,OAAO,CAAC,OAAO,CAAS;IACxB,gEAAgE;IAChE,OAAO,CAAC,QAAQ,CAAS;IACzB,iCAAiC;IACjC,OAAO,CAAC,YAAY,CAAC,CAAuD;IAC5E,kCAAkC;IAClC,OAAO,CAAC,cAAc,CAAC,CAAsF;IAC7G,6CAA6C;IAC7C,OAAO,CAAC,UAAU,CAAC,CAAS;IAC5B,4EAA4E;IAC5E,OAAO,CAAC,WAAW,CAAqG;IACxH,mEAAmE;IACnE,OAAO,CAAC,WAAW,CAAC,CAAsD;IAC1E,sDAAsD;IACtD,OAAO,CAAC,aAAa,CAAgC;IACrD,mFAAmF;IACnF,OAAO,CAAC,mBAAmB,CAAU;IACrC,yEAAyE;IACzE,OAAO,CAAC,mBAAmB,CAAU;IACrC,uCAAuC;IACvC,OAAO,CAAC,SAAS,CAAS;IAC1B,8CAA8C;IAC9C,OAAO,CAAC,aAAa,CAAC,CAAgC;IAEtD,+EAA+E;IAC/E,OAAO,CAAC,gBAAgB,CAAC,CAAiF;IAC1G,wEAAwE;IACxE,OAAO,CAAC,gBAAgB,CAAiB;IAEzC,mFAAmF;IACnF,OAAO,KAAK,uBAAuB,GAMlC;IAED,qHAAqH;IACrH,OAAO,KAAK,oBAAoB,GAE/B;IAGD,kBAAkB;IAClB,IAAI,EAAE,IAAI,MAAM,CAA2B;IAE3C,iGAAiG;IACjG,IAAI,SAAS,IAAI,MAAM,GAAG,SAAS,CAA0E;IAE7G,6BAA6B;IAC7B,IAAI,WAAW,IAAI,MAAM,CAAkD;IAE3E,yBAAyB;IACzB,IAAI,QAAQ,IAAI,MAAM,GAAG,SAAS,CAA+C;IAEjF,wBAAwB;IACxB,IAAI,QAAQ,IAAI,MAAM,GAAG,SAAS,CAA+C;IAEjF,6BAA6B;IAC7B,IAAI,YAAY,IAAI,MAAM,GAAG,SAAS,CAAmD;IAEzF,yBAAyB;IACzB,IAAI,SAAS,IAAI,MAAM,GAAG,SAAS,CAAgD;IAEnF,sBAAsB;IACtB,IAAI,MAAM,IAAI,MAAM,GAAG,SAAS,CAA6C;IAI7E,2BAA2B;IAC3B,IAAI,UAAU,IAAI,MAAM,GAAG,SAAS,CAAqD;IAEzF,mBAAmB;IACnB,IAAI,OAAO,IAAI,MAAM,GAAG,SAAS,CAAkD;IAEnF,yBAAyB;IACzB,IAAI,QAAQ,IAAI,MAAM,GAAG,SAAS,CAAmD;IAErF,8BAA8B;IAC9B,IAAI,aAAa,IAAI,MAAM,GAAG,SAAS,CAAwD;IAE/F,6CAA6C;IAC7C,IAAI,SAAS,IAAI,OAAO,GAAG,SAAS,CAAoD;IAExF,yBAAyB;IACzB,IAAI,IAAI,IAAI,oBAAoB,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,GAAG,SAAS,CAE9E;IAGD,oDAAoD;IACpD,IAAI,MAAM,IAAI,MAAM,CAAyB;IAE7C,sDAAsD;IACtD,IAAI,OAAO,IAAI,MAAM,CAA0B;IAE/C,sFAAsF;IACtF,IAAI,SAAS,IAAI,MAAM,CAA8C;IAErE,0BAA0B;IAC1B,IAAI,UAAU,IAAI,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,YAAY,CAAC,CAA6B;IAElG,sCAAsC;IACtC,IAAI,aAAa,IAAI,UAAU,CAAC,YAAY,CAAC,YAAY,GAAG,YAAY,CAAC,aAAa,CAAC,CAAC,eAAe,CAAC,CAAgC;IAExI,sCAAsC;IACtC,IAAI,WAAW,IAAI,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,aAAa,CAAC,GAAG,SAAS,CAA8B;IAEjH,wDAAwD;IACxD,IAAI,YAAY,IAAI,MAAM,GAAG,SAAS,CAA+B;IAErE,0CAA0C;IAC1C,IAAI,OAAO,IAAI,OAAO,CAA6D;IAEnF,4DAA4D;IAC5D,IAAI,YAAY,IAAI,aAAa,CAAC,cAAc,CAAC,CAA+B;IAEhF;;;OAGG;IACH,IAAI,UAAU,IAAI,UAAU,CAAC,YAAY,CAAC,YAAY,CAAC,GAAG,UAAU,CAAC,YAAY,CAAC,aAAa,CAAC,CA4B/F;gBAEW,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,aAAa,EAAE,cAAc,CAAC,EAAE,cAAc;IAiDrF;;;;;;;OAOG;IACH,IAAI,IAAI,IAAI,UAAU,CA+BrB;IAED;;;;;;;OAOG;IACG,KAAK,CAAC,YAAY,GAAE,OAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAKtE;;;;;;;;OAQG;IACG,MAAM,CAAC,KAAK,GAAE,OAAc,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAI/D;;;;;;;;;;;;OAYG;IACG,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IA+CvD;;;OAGG;IACH,MAAM,IAAI,WAAW;IAyBrB;;;OAGG;IACH,QAAQ,IAAI,MAAM;IAqBlB;;;;;OAKG;IACG,gBAAgB,CAAC,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,GAAG,SAAS,CAAC;IAInF;;;;;;;OAOG;IACG,MAAM,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,UAAU,EAAE,YAAY,EAAE,KAAY,EAAE,GAAG,MAAM,EAAE,EAAE,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IA2FrI;;;;OAIG;IACG,MAAM,CAAC,YAAY,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAsE5E;;OAEG;YACW,2BAA2B;IAiCzC;;;OAGG;YACW,aAAa;IAkD3B;;;;;;;;;;;;;;;OAeG;YACW,cAAc;IA2C5B;;;;;;OAMG;YACW,kBAAkB;IAwBhC;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,MAAM,CAAC,uBAAuB;IAQtC;;;;OAIG;IACH,OAAO,CAAC,yBAAyB;CAKlC"}

package/dist/types/repository-types.d.ts

@@ -0,0 +1,137 @@
+/**
+ * Type-level machinery for the protocol repository pattern.
+ *
+ * These types produce a statically-typed CRUD API shape from a
+ * `ProtocolDefinition` + `SchemaMap`, with singleton detection
+ * (via `$recordLimit: { max: 1 }`) and nested-path awareness.
+ *
+ * All types are purely compile-time — they produce no runtime code.
+ *
+ * @module
+ */
+import type { SchemaMap } from './protocol-types.js';
+import type { TypedLiveQuery } from './typed-live-query.js';
+import type { TypedRecord } from './typed-record.js';
+import type { DataForPath, TypedCreateRequest, TypedQueryRequest, TypedSubscribeRequest } from './typed-web5.js';
+import type { DwnPaginationCursor, DwnResponseStatus } from '@enbox/agent';
+import type { ProtocolDefinition, ProtocolRuleSet } from '@enbox/dwn-sdk-js';
+/**
+ * Navigates a `ProtocolRuleSet` tree to the node at a slash-delimited path.
+ */
+type RuleSetAtPath<R, Path extends string> = Path extends `${infer Head}/${infer Tail}` ? Head extends keyof R ? R[Head] extends ProtocolRuleSet ? RuleSetAtPath<R[Head], Tail> : never : never : Path extends keyof R ? R[Path] extends ProtocolRuleSet ? R[Path] : never : never;
+/**
+ * Extracts the `$recordLimit` from a rule set node, if present.
+ */
+type RecordLimitAtRuleSet<RS> = RS extends {
+    $recordLimit: infer L;
+} ? L : never;
+/**
+ * `true` when the rule set at `Path` has `$recordLimit: { max: 1 }`.
+ */
+export type IsSingleton<D extends ProtocolDefinition, Path extends string> = RecordLimitAtRuleSet<RuleSetAtPath<D['structure'], Path>> extends {
+    max: 1;
+} ? true : false;
+/** Resolves the TypeScript data type for a given path. */
+type DataAt<D extends ProtocolDefinition, M extends SchemaMap, Path extends string> = DataForPath<D, M, Path>;
+/**
+ * Write options for a collection `create()` call.
+ * Omits `data` (passed separately) and protocol-injected fields.
+ */
+export type CollectionCreateOptions<D extends ProtocolDefinition, M extends SchemaMap, Path extends string> = Omit<TypedCreateRequest<D, M, Path>, 'data' | 'parentContextId'> & {
+    data: DataAt<D, M, Path>;
+};
+/**
+ * Write options for a singleton `set()` call.
+ */
+export type SingletonSetOptions<D extends ProtocolDefinition, M extends SchemaMap, Path extends string> = Omit<TypedCreateRequest<D, M, Path>, 'data' | 'parentContextId'> & {
+    data: DataAt<D, M, Path>;
+};
+/** CRUD API for a root-level collection (unbounded or max > 1). */
+export type CollectionCRUD<D extends ProtocolDefinition, M extends SchemaMap, Path extends string> = {
+    create(options: CollectionCreateOptions<D, M, Path>): Promise<DwnResponseStatus & {
+        record: TypedRecord<DataAt<D, M, Path>>;
+    }>;
+    query(options?: TypedQueryRequest): Promise<DwnResponseStatus & {
+        records: TypedRecord<DataAt<D, M, Path>>[];
+        cursor?: DwnPaginationCursor;
+    }>;
+    get(recordId: string): Promise<TypedRecord<DataAt<D, M, Path>>>;
+    delete(recordId: string): Promise<DwnResponseStatus>;
+    subscribe(options?: TypedSubscribeRequest): Promise<TypedLiveQuery<DataAt<D, M, Path>> | undefined>;
+};
+/** CRUD API for a root-level singleton ($recordLimit max: 1). */
+export type SingletonCRUD<D extends ProtocolDefinition, M extends SchemaMap, Path extends string> = {
+    set(options: SingletonSetOptions<D, M, Path>): Promise<DwnResponseStatus & {
+        record: TypedRecord<DataAt<D, M, Path>>;
+    }>;
+    get(): Promise<TypedRecord<DataAt<D, M, Path>> | undefined>;
+    delete(recordId: string): Promise<DwnResponseStatus>;
+};
+/** CRUD API for a nested collection (parent context required). */
+export type NestedCollectionCRUD<D extends ProtocolDefinition, M extends SchemaMap, Path extends string> = {
+    create(parentContextId: string, options: CollectionCreateOptions<D, M, Path>): Promise<DwnResponseStatus & {
+        record: TypedRecord<DataAt<D, M, Path>>;
+    }>;
+    query(parentContextId: string, options?: TypedQueryRequest): Promise<DwnResponseStatus & {
+        records: TypedRecord<DataAt<D, M, Path>>[];
+        cursor?: DwnPaginationCursor;
+    }>;
+    get(recordId: string): Promise<TypedRecord<DataAt<D, M, Path>>>;
+    delete(recordId: string): Promise<DwnResponseStatus>;
+    subscribe(parentContextId: string, options?: TypedSubscribeRequest): Promise<TypedLiveQuery<DataAt<D, M, Path>> | undefined>;
+};
+/** CRUD API for a nested singleton ($recordLimit max: 1). */
+export type NestedSingletonCRUD<D extends ProtocolDefinition, M extends SchemaMap, Path extends string> = {
+    set(parentContextId: string, options: SingletonSetOptions<D, M, Path>): Promise<DwnResponseStatus & {
+        record: TypedRecord<DataAt<D, M, Path>>;
+    }>;
+    get(parentContextId: string): Promise<TypedRecord<DataAt<D, M, Path>> | undefined>;
+    delete(recordId: string): Promise<DwnResponseStatus>;
+};
+/**
+ * Extracts the child type names (non-`$`-prefixed keys that extend ProtocolRuleSet)
+ * from a rule set node.
+ */
+type ChildKeys<RS> = {
+    [K in Extract<keyof RS, string>]: K extends `$${string}` ? never : RS[K] extends ProtocolRuleSet ? K : never;
+}[Extract<keyof RS, string>];
+/**
+ * Builds nested repository nodes for all children of a given rule set.
+ */
+type ChildNodes<D extends ProtocolDefinition, M extends SchemaMap, RS, ParentPath extends string> = {
+    [K in ChildKeys<RS>]: RepositoryNode<D, M, RS[K], `${ParentPath}/${K}`, true>;
+};
+/**
+ * A single node in the repository tree. Provides CRUD methods appropriate
+ * to whether the path is root/nested and singleton/collection, plus child
+ * nodes for further nesting.
+ */
+export type RepositoryNode<D extends ProtocolDefinition, M extends SchemaMap, RS, Path extends string, IsNested extends boolean = false> = (IsNested extends true ? (IsSingleton<D, Path> extends true ? NestedSingletonCRUD<D, M, Path> : NestedCollectionCRUD<D, M, Path>) : (IsSingleton<D, Path> extends true ? SingletonCRUD<D, M, Path> : CollectionCRUD<D, M, Path>)) & ChildNodes<D, M, RS, Path>;
+/**
+ * The top-level repository type for a protocol definition.
+ *
+ * Maps each root-level type name in the protocol's `structure` to a
+ * `RepositoryNode` with the appropriate CRUD methods and nested children.
+ *
+ * @example
+ * ```ts
+ * const social: Repository<typeof SocialGraphDef, SocialGraphSchemaMap>;
+ *
+ * // Root collection
+ * await social.friend.create({ data: { did: '...' } });
+ * await social.friend.query();
+ *
+ * // Nested under group
+ * await social.group.member.create(groupCtxId, { data: { did: '...' } });
+ * ```
+ */
+export type Repository<D extends ProtocolDefinition, M extends SchemaMap> = {
+    [K in Extract<keyof D['structure'], string> as K extends `$${string}` ? never : K]: D['structure'][K] extends ProtocolRuleSet ? RepositoryNode<D, M, D['structure'][K], K> : never;
+} & {
+    /** Install (configure) the protocol. Idempotent — no-op if already installed. */
+    configure(options?: {
+        encryption?: boolean;
+    }): Promise<DwnResponseStatus>;
+};
+export {};
+//# sourceMappingURL=repository-types.d.ts.map

package/dist/types/repository-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"repository-types.d.ts","sourceRoot":"","sources":["../../src/repository-types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,KAAK,EACV,WAAW,EACX,kBAAkB,EAClB,iBAAiB,EACjB,qBAAqB,EACtB,MAAM,iBAAiB,CAAC;AACzB,OAAO,KAAK,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAC3E,OAAO,KAAK,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAM7E;;GAEG;AACH,KAAK,aAAa,CAAC,CAAC,EAAE,IAAI,SAAS,MAAM,IACvC,IAAI,SAAS,GAAG,MAAM,IAAI,IAAI,MAAM,IAAI,EAAE,GACtC,IAAI,SAAS,MAAM,CAAC,GAClB,CAAC,CAAC,IAAI,CAAC,SAAS,eAAe,GAC7B,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,GAC5B,KAAK,GACP,KAAK,GACP,IAAI,SAAS,MAAM,CAAC,GAClB,CAAC,CAAC,IAAI,CAAC,SAAS,eAAe,GAC7B,CAAC,CAAC,IAAI,CAAC,GACP,KAAK,GACP,KAAK,CAAC;AAMd;;GAEG;AACH,KAAK,oBAAoB,CAAC,EAAE,IAC1B,EAAE,SAAS;IAAE,YAAY,EAAE,MAAM,CAAC,CAAA;CAAE,GAAG,CAAC,GAAG,KAAK,CAAC;AAEnD;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,kBAAkB,EAAE,IAAI,SAAS,MAAM,IACvE,oBAAoB,CAAC,aAAa,CAAC,CAAC,CAAC,WAAW,CAAC,EAAE,IAAI,CAAC,CAAC,SAAS;IAAE,GAAG,EAAE,CAAC,CAAA;CAAE,GACxE,IAAI,GACJ,KAAK,CAAC;AAMZ,0DAA0D;AAC1D,KAAK,MAAM,CACT,CAAC,SAAS,kBAAkB,EAC5B,CAAC,SAAS,SAAS,EACnB,IAAI,SAAS,MAAM,IACjB,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;AAM5B;;;GAGG;AACH,MAAM,MAAM,uBAAuB,CACjC,CAAC,SAAS,kBAAkB,EAC5B,CAAC,SAAS,SAAS,EACnB,IAAI,SAAS,MAAM,IACjB,IAAI,CAAC,kBAAkB,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,iBAAiB,CAAC,GAAG;IACrE,IAAI,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;CAC1B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,CAC7B,CAAC,SAAS,kBAAkB,EAC5B,CAAC,SAAS,SAAS,EACnB,IAAI,SAAS,MAAM,IACjB,IAAI,CAAC,kBAAkB,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,iBAAiB,CAAC,GAAG;IACrE,IAAI,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;CAC1B,CAAC;AAMF,mEAAmE;AACnE,MAAM,MAAM,cAAc,CACxB,CAAC,SAAS,kBAAkB,EAC5B,CAAC,SAAS,SAAS,EACnB,IAAI,SAAS,MAAM,IACjB;IACF,MAAM,CAAC,OAAO,EAAE,uBAAuB,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,GAAG,OAAO,CAAC,iBAAiB,GAAG;QAAE,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;KAAE,CAAC,CAAC;IAC/H,KAAK,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,GAAG;QAAE,OAAO,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC;QAAC,MAAM,CAAC,EAAE,mBAAmB,CAAA;KAAE,CAAC,CAAC;IAC9I,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IAChE,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;IACrD,SAAS,CAAC,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC;CACrG,CAAC;AAEF,iEAAiE;AACjE,MAAM,MAAM,aAAa,CACvB,CAAC,SAAS,kBAAkB,EAC5B,CAAC,SAAS,SAAS,EACnB,IAAI,SAAS,MAAM,IACjB;IACF,GAAG,CAAC,OAAO,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,GAAG,OAAO,CAAC,iBAAiB,GAAG;QAAE,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;KAAE,CAAC,CAAC;IACxH,GAAG,IAAI,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC;IAC5D,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;CACtD,CAAC;AAEF,kEAAkE;AAClE,MAAM,MAAM,oBAAoB,CAC9B,CAAC,SAAS,kBAAkB,EAC5B,CAAC,SAAS,SAAS,EACnB,IAAI,SAAS,MAAM,IACjB;IACF,MAAM,CACJ,eAAe,EAAE,MAAM,EACvB,OAAO,EAAE,uBAAuB,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,GAC3C,OAAO,CAAC,iBAAiB,GAAG;QAAE,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;KAAE,CAAC,CAAC;IAC5E,KAAK,CACH,eAAe,EAAE,MAAM,EACvB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,iBAAiB,GAAG;QAAE,OAAO,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC;QAAC,MAAM,CAAC,EAAE,mBAAmB,CAAA;KAAE,CAAC,CAAC;IAC7G,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IAChE,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;IACrD,SAAS,CACP,eAAe,EAAE,MAAM,EACvB,OAAO,CAAC,EAAE,qBAAqB,GAC9B,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC;CAC5D,CAAC;AAEF,6DAA6D;AAC7D,MAAM,MAAM,mBAAmB,CAC7B,CAAC,SAAS,kBAAkB,EAC5B,CAAC,SAAS,SAAS,EACnB,IAAI,SAAS,MAAM,IACjB;IACF,GAAG,CACD,eAAe,EAAE,MAAM,EACvB,OAAO,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,GACvC,OAAO,CAAC,iBAAiB,GAAG;QAAE,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;KAAE,CAAC,CAAC;IAC5E,GAAG,CAAC,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC;IACnF,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;CACtD,CAAC;AAMF;;;GAGG;AACH,KAAK,SAAS,CAAC,EAAE,IAAI;KAClB,CAAC,IAAI,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC,SAAS,IAAI,MAAM,EAAE,GACpD,KAAK,GACL,EAAE,CAAC,CAAC,CAAC,SAAS,eAAe,GAC3B,CAAC,GACD,KAAK;CACZ,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC;AAE7B;;GAEG;AACH,KAAK,UAAU,CACb,CAAC,SAAS,kBAAkB,EAC5B,CAAC,SAAS,SAAS,EACnB,EAAE,EACF,UAAU,SAAS,MAAM,IACvB;KACD,CAAC,IAAI,SAAS,CAAC,EAAE,CAAC,GAAG,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,UAAU,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC;CAC9E,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,cAAc,CACxB,CAAC,SAAS,kBAAkB,EAC5B,CAAC,SAAS,SAAS,EACnB,EAAE,EACF,IAAI,SAAS,MAAM,EACnB,QAAQ,SAAS,OAAO,GAAG,KAAK,IAGhC,CAAC,QAAQ,SAAS,IAAI,GAClB,CAAC,WAAW,CAAC,CAAC,EAAE,IAAI,CAAC,SAAS,IAAI,GAChC,mBAAmB,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,GAC/B,oBAAoB,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,GACnC,CAAC,WAAW,CAAC,CAAC,EAAE,IAAI,CAAC,SAAS,IAAI,GAChC,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,GACzB,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,GAEhC,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;AAM/B;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,UAAU,CACpB,CAAC,SAAS,kBAAkB,EAC5B,CAAC,SAAS,SAAS,IACjB;KACD,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,SAAS,IAAI,MAAM,EAAE,GAAG,KAAK,GAAG,CAAC,GAC/E,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,eAAe,GACrC,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,GAC1C,KAAK;CACZ,GAAG;IACF,iFAAiF;IACjF,SAAS,CAAC,OAAO,CAAC,EAAE;QAAE,UAAU,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;CAC3E,CAAC"}

package/dist/types/repository.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Protocol-aware repository factory.
+ *
+ * `repository()` takes a `TypedWeb5` instance and returns a Proxy-backed
+ * object whose shape mirrors the protocol's `structure` tree with
+ * ergonomic CRUD methods on each node.
+ *
+ * - **Collections** (default): `create`, `query`, `get`, `delete`, `subscribe`
+ * - **Singletons** (`$recordLimit: { max: 1 }`): `set`, `get`, `delete`
+ * - **Nested types**: first argument is `parentContextId`
+ * - **`configure()`**: idempotent protocol installation
+ *
+ * @example
+ * ```ts
+ * const social = repository(web5.using(SocialGraphProtocol));
+ * await social.configure();
+ *
+ * // Root collection
+ * const { record } = await social.friend.create({
+ *   data: { did: 'did:example:alice' },
+ * });
+ *
+ * // Nested under group
+ * const members = await social.group.member.query(groupContextId);
+ * ```
+ *
+ * @module
+ */
+import type { Repository } from './repository-types.js';
+import type { SchemaMap } from './protocol-types.js';
+import type { TypedWeb5 } from './typed-web5.js';
+import type { ProtocolDefinition } from '@enbox/dwn-sdk-js';
+/**
+ * Creates a protocol-aware repository from a `TypedWeb5` instance.
+ *
+ * The returned object provides domain-specific CRUD methods that mirror
+ * the protocol's structure tree:
+ *
+ * - Root types: `repo.friend.create()`, `repo.friend.query()`
+ * - Nested types: `repo.group.member.create(groupCtxId, { data })`
+ * - Singletons: `repo.profile.set()`, `repo.profile.get()`
+ * - Protocol install: `repo.configure()`
+ *
+ * @param typed - A `TypedWeb5` instance from `web5.using(protocol)`.
+ * @returns A typed repository object.
+ *
+ * @example
+ * ```ts
+ * const social = repository(web5.using(SocialGraphProtocol));
+ * await social.configure();
+ *
+ * const rec = await social.friend.create({
+ *   data: { did: 'did:example:alice' },
+ * });
+ * const friends = await social.friend.query();
+ * ```
+ */
+export declare function repository<D extends ProtocolDefinition, M extends SchemaMap>(typed: TypedWeb5<D, M>): Repository<D, M>;
+//# sourceMappingURL=repository.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"repository.d.ts","sourceRoot":"","sources":["../../src/repository.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AAGH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,KAAK,EAAE,kBAAkB,EAAmB,MAAM,mBAAmB,CAAC;AAoS7E;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,UAAU,CACxB,CAAC,SAAS,kBAAkB,EAC5B,CAAC,SAAS,SAAS,EACnB,KAAK,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAqC1C"}

package/dist/types/typed-live-query.d.ts

@@ -0,0 +1,86 @@
+/**
+ * A type-safe wrapper around {@link LiveQuery} that carries the data type `T`
+ * through initial snapshot records and real-time change events.
+ *
+ * `TypedLiveQuery<T>` wraps a `LiveQuery` so that:
+ * - `.records` returns `TypedRecord<T>[]` instead of `Record[]`.
+ * - `.on('create', handler)` provides `TypedRecord<T>` in the callback.
+ * - `.on('change', handler)` provides `TypedRecordChange<T>` in the callback.
+ *
+ * @example
+ * ```ts
+ * const { liveQuery } = await typed.records.subscribe('friend');
+ * // liveQuery is TypedLiveQuery<FriendData>
+ *
+ * for (const record of liveQuery.records) {
+ *   const data = await record.data.json(); // FriendData
+ * }
+ *
+ * liveQuery.on('create', async (record) => {
+ *   const data = await record.data.json(); // FriendData
+ * });
+ * ```
+ */
+import type { PaginationCursor } from '@enbox/dwn-sdk-js';
+import type { LiveQuery, RecordChange } from './live-query.js';
+import { TypedRecord } from './typed-record.js';
+/**
+ * Describes a change to a record in a {@link TypedLiveQuery}.
+ *
+ * Same shape as {@link RecordChange} but with the record wrapped
+ * in a {@link TypedRecord}.
+ */
+export type TypedRecordChange<T> = {
+    /** Whether the record was created, updated, or deleted. */
+    type: RecordChange['type'];
+    /** The typed record affected by the change. */
+    record: TypedRecord<T>;
+};
+/**
+ * A type-safe wrapper around {@link LiveQuery} that preserves the data type `T`
+ * through the initial snapshot and all subsequent change events.
+ *
+ * Obtain instances through `TypedWeb5.records.subscribe()` — never construct
+ * directly.
+ */
+export declare class TypedLiveQuery<T> {
+    /** The underlying untyped LiveQuery instance. */
+    private _liveQuery;
+    /** Cached typed record array, built lazily from the underlying records. */
+    private _typedRecords?;
+    constructor(liveQuery: LiveQuery);
+    /** Access the underlying untyped {@link LiveQuery} for advanced use cases. */
+    get rawLiveQuery(): LiveQuery;
+    /** The initial snapshot of matching records, typed as `TypedRecord<T>[]`. */
+    get records(): TypedRecord<T>[];
+    /**
+     * Pagination cursor for fetching the next page of initial results.
+     *
+     * `undefined` when there are no more results.
+     */
+    get cursor(): PaginationCursor | undefined;
+    /**
+     * Register a typed event handler. Returns an unsubscribe function.
+     *
+     * @param event - The event type to listen for.
+     * @param handler - The handler function with typed record(s).
+     * @returns A function that removes the handler when called.
+     *
+     * @example
+     * ```ts
+     * const off = liveQuery.on('create', (record) => {
+     *   // record is TypedRecord<T>
+     * });
+     * off(); // stop listening
+     * ```
+     */
+    on(event: 'change', handler: (change: TypedRecordChange<T>) => void): () => void;
+    on(event: 'create', handler: (record: TypedRecord<T>) => void): () => void;
+    on(event: 'update', handler: (record: TypedRecord<T>) => void): () => void;
+    on(event: 'delete', handler: (record: TypedRecord<T>) => void): () => void;
+    /**
+     * Close the underlying subscription and stop dispatching events.
+     */
+    close(): Promise<void>;
+}
+//# sourceMappingURL=typed-live-query.d.ts.map

package/dist/types/typed-live-query.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typed-live-query.d.ts","sourceRoot":"","sources":["../../src/typed-live-query.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAC1D,OAAO,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/D,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAMhD;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,CAAC,CAAC,IAAI;IACjC,2DAA2D;IAC3D,IAAI,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;IAE3B,+CAA+C;IAC/C,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;CACxB,CAAC;AAMF;;;;;;GAMG;AACH,qBAAa,cAAc,CAAC,CAAC;IAC3B,iDAAiD;IACjD,OAAO,CAAC,UAAU,CAAY;IAE9B,2EAA2E;IAC3E,OAAO,CAAC,aAAa,CAAC,CAAmB;gBAE7B,SAAS,EAAE,SAAS;IAQhC,8EAA8E;IAC9E,IAAW,YAAY,IAAI,SAAS,CAEnC;IAMD,6EAA6E;IAC7E,IAAW,OAAO,IAAI,WAAW,CAAC,CAAC,CAAC,EAAE,CAOrC;IAED;;;;OAIG;IACH,IAAW,MAAM,IAAI,gBAAgB,GAAG,SAAS,CAEhD;IAMD;;;;;;;;;;;;;;OAcG;IACI,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,MAAM,IAAI;IAChF,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,MAAM,IAAI;IAC1E,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,MAAM,IAAI;IAC1E,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,MAAM,IAAI;IA0BjF;;OAEG;IACU,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAGpC"}