@enbox/api 0.3.1 → 0.4.0

package/dist/esm/web5.js

@@ -1,410 +0,0 @@
-/**
- * NOTE: Added reference types here to avoid a `pnpm` bug during build.
- * https://github.com/enboxorg/enbox/pull/507
- */
-/// <reference types="@enbox/dwn-sdk-js" />
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __rest = (this && this.__rest) || function (s, e) {
-    var t = {};
-    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
-        t[p] = s[p];
-    if (s != null && typeof Object.getOwnPropertySymbols === "function")
-        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
-                t[p[i]] = s[p[i]];
-        }
-    return t;
-};
-import { AnonymousDwnApi, WalletConnect, Web5UserAgent } from '@enbox/agent';
-import { DidDht, DidJwk, DidKey, DidResolverCacheMemory, DidWeb, UniversalResolver } from '@enbox/dids';
-import { DwnRegistrar, Web5RpcClient } from '@enbox/dwn-clients';
-import { DidApi } from './did-api.js';
-import { DwnApi } from './dwn-api.js';
-import { DwnReaderApi } from './dwn-reader-api.js';
-import { PermissionGrant } from './permission-grant.js';
-import { TypedWeb5 } from './typed-web5.js';
-import { VcApi } from './vc-api.js';
-/**
- * The main Web5 API interface. It manages the creation of a DID if needed, the connection to the
- * local DWN and all the web5 main foundational APIs such as VC, syncing, etc.
- */
-export class Web5 {
-    constructor({ agent, connectedDid, delegateDid }) {
-        this.agent = agent;
-        this.did = new DidApi({ agent, connectedDid });
-        this._dwn = new DwnApi({ agent, connectedDid, delegateDid });
-        this.vc = new VcApi({ agent, connectedDid });
-    }
-    /**
-     * Returns a {@link TypedWeb5} instance scoped to the given protocol.
-     *
-     * This is the **primary developer interface** for interacting with
-     * protocol-backed records. It auto-injects the protocol URI, protocolPath,
-     * and schema into every operation, and provides compile-time path
-     * autocompletion plus typed data payloads via the schema map.
-     *
-     * @param protocol - A typed protocol created via `defineProtocol()`.
-     * @returns A `TypedWeb5` instance bound to the given protocol.
-     *
-     * @example
-     * ```ts
-     * const social = web5.using(SocialProtocol);
-     *
-     * await social.configure();
-     *
-     * const { record } = await social.records.write('friend', {
-     *   data: { did: 'did:example:alice', alias: 'Alice' },
-     * });
-     *
-     * const { records } = await social.records.query('friend');
-     * ```
-     */
-    using(protocol) {
-        return new TypedWeb5(this._dwn, protocol);
-    }
-    /**
-     * Creates a lightweight, read-only Web5 instance for querying public DWN data.
-     *
-     * No identity, vault, password, or signing keys are required. The returned
-     * API supports querying and reading published records and protocols from any
-     * remote DWN, using **unsigned** (anonymous) DWN messages.
-     *
-     * @param options - Optional configuration overrides.
-     * @returns A {@link Web5AnonymousApi} with a read-only `dwn` property.
-     *
-     * @example
-     * ```ts
-     * const { dwn } = Web5.anonymous();
-     *
-     * const { records } = await dwn.records.query({
-     *   from: 'did:dht:alice...',
-     *   filter: { protocol: 'https://social.example/posts', protocolPath: 'post' },
-     * });
-     *
-     * for (const record of records) {
-     *   console.log(record.id, await record.data.text());
-     * }
-     * ```
-     *
-     * @beta
-     */
-    static anonymous(options) {
-        var _a;
-        const didResolver = new UniversalResolver({
-            didResolvers: (_a = options === null || options === void 0 ? void 0 : options.didResolvers) !== null && _a !== void 0 ? _a : [DidDht, DidJwk, DidKey, DidWeb],
-            cache: new DidResolverCacheMemory(),
-        });
-        const rpcClient = new Web5RpcClient();
-        const anonymousDwn = new AnonymousDwnApi({ didResolver, rpcClient });
-        return {
-            dwn: new DwnReaderApi(anonymousDwn),
-        };
-    }
-    /**
-     * Connects to a {@link Web5Agent}. Defaults to creating a local {@link Web5UserAgent} if one
-     * isn't provided.
-     *
-     * If `walletConnectOptions` are provided, a WalletConnect flow will be initiated to import a delegated DID from an external wallet.
-     * If there is a failure at any point during connecting and processing grants, all created DIDs and Identities as well as the provided grants
-     * will be cleaned up and an error thrown. This allows for subsequent Connect attempts to be made without any errors.
-     *
-     * @param options - Optional overrides that can be provided when calling {@link Web5.connect}.
-     * @returns A promise that resolves to a {@link Web5} instance and the connected DID.
-     */
-    static connect() {
-        return __awaiter(this, arguments, void 0, function* ({ agent, agentVault, connectedDid, password, recoveryPhrase, sync, techPreview, didCreateOptions, registration, walletConnectOptions, } = {}) {
-            var _a, _b, _c, _d;
-            let delegateDid;
-            if (agent === undefined) {
-                let registerSync = false;
-                // A custom Web5Agent implementation was not specified, so use default managed user agent.
-                const userAgent = yield Web5UserAgent.create({ agentVault });
-                agent = userAgent;
-                // Warn the developer and application user of the security risks of using a static password.
-                if (password === undefined) {
-                    password = 'insecure-static-phrase';
-                    console.warn('%cSECURITY WARNING:%c ' +
-                        'You have not set a password, which defaults to a static, guessable value. ' +
-                        'This significantly compromises the security of your data. ' +
-                        'Please configure a secure, unique password.', 'font-weight: bold; color: red;', 'font-weight: normal; color: inherit;');
-                }
-                // Use the specified DWN endpoints or the latest TBD hosted DWN
-                const serviceEndpointNodes = (_b = (_a = techPreview === null || techPreview === void 0 ? void 0 : techPreview.dwnEndpoints) !== null && _a !== void 0 ? _a : didCreateOptions === null || didCreateOptions === void 0 ? void 0 : didCreateOptions.dwnEndpoints) !== null && _b !== void 0 ? _b : ['https://enbox-dwn.fly.dev'];
-                // Initialize, if necessary, and start the agent.
-                if (yield userAgent.firstLaunch()) {
-                    recoveryPhrase = yield userAgent.initialize({ password, recoveryPhrase, dwnEndpoints: serviceEndpointNodes });
-                }
-                yield userAgent.start({ password });
-                // Attempt to retrieve the connected Identity if it exists.
-                const connectedIdentity = yield userAgent.identity.connectedIdentity();
-                let identity;
-                let connectedProtocols = [];
-                if (connectedIdentity) {
-                    // if a connected identity is found, use it
-                    // TODO: In the future, implement a way to re-connect an already connected identity and apply additional grants/protocols
-                    identity = connectedIdentity;
-                }
-                else if (walletConnectOptions) {
-                    if (sync === 'off') {
-                        // Currently we require sync to be enabled when using WalletConnect
-                        // This is to ensure a connected app is not in a disjointed state from any other clients/app using the connectedDid
-                        throw new Error('Sync must not be disabled when using WalletConnect');
-                    }
-                    // Since we are connecting a new identity, we will want to register sync for the connectedDid
-                    registerSync = true;
-                    // No connected identity found and connectOptions are provided, attempt to import a delegated DID from an external wallet
-                    try {
-                        const { permissionRequests } = walletConnectOptions, connectOptions = __rest(walletConnectOptions, ["permissionRequests"]);
-                        const walletPermissionRequests = permissionRequests.map(({ protocolDefinition, permissions }) => WalletConnect.createPermissionRequestForProtocol({
-                            definition: protocolDefinition,
-                            permissions: permissions !== null && permissions !== void 0 ? permissions : [
-                                'read', 'write', 'delete', 'query', 'subscribe',
-                            ],
-                        }));
-                        const { delegatePortableDid, connectedDid, delegateGrants } = yield WalletConnect.initClient(Object.assign(Object.assign({}, connectOptions), { permissionRequests: walletPermissionRequests }));
-                        // Import the delegated DID as an Identity in the User Agent.
-                        // Setting the connectedDID in the metadata applies a relationship between the signer identity and the one it is impersonating.
-                        identity = yield userAgent.identity.import({ portableIdentity: {
-                                portableDid: delegatePortableDid,
-                                metadata: {
-                                    connectedDid,
-                                    name: 'Default',
-                                    uri: delegatePortableDid.uri,
-                                    tenant: agent.agentDid.uri,
-                                }
-                            } });
-                        // Attempts to process the connected grants to be used by the delegateDID
-                        // If the process fails, we want to clean up the identity
-                        // the connected grants will return a de-duped array of protocol URIs that are used to register sync for those protocols
-                        connectedProtocols = yield this.processConnectedGrants({ agent, delegateDid: delegatePortableDid.uri, grants: delegateGrants });
-                    }
-                    catch (error) {
-                        // clean up the DID and Identity if import fails and throw
-                        // TODO: Implement the ability to purge all of our messages as a tenant
-                        yield this.cleanUpIdentity({ identity, userAgent });
-                        throw new Error(`Failed to connect to wallet: ${error.message}`);
-                    }
-                }
-                else {
-                    // No connected (WalletConnect) identity and no walletConnectOptions provided.
-                    // Look for an existing local identity, or create one on first use.
-                    const identities = yield userAgent.identity.list();
-                    if (identities.length === 0) {
-                        registerSync = true;
-                        // First use — generate a new Identity for the end-user.
-                        identity = yield userAgent.identity.create({
-                            didMethod: 'dht',
-                            metadata: { name: 'Default' },
-                            didOptions: {
-                                services: [
-                                    {
-                                        id: 'dwn',
-                                        type: 'DecentralizedWebNode',
-                                        serviceEndpoint: serviceEndpointNodes,
-                                        enc: '#enc',
-                                        sig: '#sig',
-                                    }
-                                ],
-                                verificationMethods: [
-                                    {
-                                        algorithm: 'Ed25519',
-                                        id: 'sig',
-                                        purposes: ['assertionMethod', 'authentication']
-                                    },
-                                    {
-                                        algorithm: 'X25519',
-                                        id: 'enc',
-                                        purposes: ['keyAgreement']
-                                    }
-                                ]
-                            }
-                        });
-                    }
-                    else {
-                        // Reconnecting — use the first local identity. When the agent manages
-                        // multiple identities (e.g. created via agent.identity.create()), the
-                        // first one returned by the store is used as the default for connect().
-                        identity = identities[0];
-                    }
-                }
-                // If the stored identity has a connected DID, use it as the connected DID, otherwise use the identity's DID.
-                connectedDid = (_c = identity.metadata.connectedDid) !== null && _c !== void 0 ? _c : identity.did.uri;
-                // If the stored identity has a connected DID, use the identity DID as the delegated DID, otherwise it is undefined.
-                delegateDid = identity.metadata.connectedDid ? identity.did.uri : undefined;
-                if (registration !== undefined) {
-                    const updatedTokens = Object.assign({}, ((_d = registration.registrationTokens) !== null && _d !== void 0 ? _d : {}));
-                    try {
-                        for (const dwnEndpoint of serviceEndpointNodes) {
-                            const serverInfo = yield userAgent.rpc.getServerInfo(dwnEndpoint);
-                            if (serverInfo.registrationRequirements.length === 0) {
-                                continue;
-                            }
-                            // Deduplicate DIDs to register.
-                            const didsToRegister = [agent.agentDid.uri, connectedDid]
-                                .filter((did, i, arr) => arr.indexOf(did) === i);
-                            const hasProviderAuth = serverInfo.registrationRequirements.includes('provider-auth-v0')
-                                && serverInfo.providerAuth !== undefined;
-                            if (hasProviderAuth && registration.onProviderAuthRequired) {
-                                // --- Provider Auth Path ---
-                                let tokenData = updatedTokens[dwnEndpoint];
-                                // Refresh expired tokens.
-                                if ((tokenData === null || tokenData === void 0 ? void 0 : tokenData.expiresAt) !== undefined && tokenData.expiresAt < Date.now()) {
-                                    if (tokenData.refreshUrl && tokenData.refreshToken) {
-                                        const refreshed = yield DwnRegistrar.refreshRegistrationToken(tokenData.refreshUrl, tokenData.refreshToken);
-                                        tokenData = {
-                                            registrationToken: refreshed.registrationToken,
-                                            refreshToken: refreshed.refreshToken,
-                                            expiresAt: refreshed.expiresIn !== undefined
-                                                ? Date.now() + (refreshed.expiresIn * 1000) : undefined,
-                                            tokenUrl: tokenData.tokenUrl,
-                                            refreshUrl: tokenData.refreshUrl,
-                                        };
-                                        updatedTokens[dwnEndpoint] = tokenData;
-                                    }
-                                    else {
-                                        tokenData = undefined;
-                                    }
-                                }
-                                // Run the auth flow if no valid token exists.
-                                if (tokenData === undefined) {
-                                    const state = crypto.randomUUID();
-                                    const providerAuth = serverInfo.providerAuth;
-                                    const separator = providerAuth.authorizeUrl.includes('?') ? '&' : '?';
-                                    const authorizeUrl = `${providerAuth.authorizeUrl}${separator}`
-                                        + `redirect_uri=${encodeURIComponent(dwnEndpoint)}`
-                                        + `&state=${encodeURIComponent(state)}`;
-                                    const authResult = yield registration.onProviderAuthRequired({
-                                        authorizeUrl,
-                                        dwnEndpoint,
-                                        state,
-                                    });
-                                    if (authResult.state !== state) {
-                                        throw new Error('Provider auth state mismatch — possible CSRF attack.');
-                                    }
-                                    const tokenResponse = yield DwnRegistrar.exchangeAuthCode(providerAuth.tokenUrl, authResult.code, dwnEndpoint);
-                                    tokenData = {
-                                        registrationToken: tokenResponse.registrationToken,
-                                        refreshToken: tokenResponse.refreshToken,
-                                        expiresAt: tokenResponse.expiresIn !== undefined
-                                            ? Date.now() + (tokenResponse.expiresIn * 1000) : undefined,
-                                        tokenUrl: providerAuth.tokenUrl,
-                                        refreshUrl: providerAuth.refreshUrl,
-                                    };
-                                    updatedTokens[dwnEndpoint] = tokenData;
-                                }
-                                // Register each DID using the provider auth token.
-                                for (const did of didsToRegister) {
-                                    yield DwnRegistrar.registerTenantWithToken(dwnEndpoint, did, tokenData.registrationToken);
-                                }
-                            }
-                            else {
-                                // --- Default Path (PoW / general registration) ---
-                                for (const did of didsToRegister) {
-                                    yield DwnRegistrar.registerTenant(dwnEndpoint, did);
-                                }
-                            }
-                        }
-                        // Notify app of updated tokens for persistence.
-                        if (registration.onRegistrationTokens) {
-                            registration.onRegistrationTokens(updatedTokens);
-                        }
-                        registration.onSuccess();
-                    }
-                    catch (error) {
-                        registration.onFailure(error);
-                    }
-                }
-                // Enable sync, unless explicitly disabled.
-                if (sync !== 'off') {
-                    // First, register the user identity for sync.
-                    // The connected protocols are used to register sync for only a subset of protocols from the connectedDid's DWN
-                    if (registerSync) {
-                        yield userAgent.sync.registerIdentity({
-                            did: connectedDid,
-                            options: {
-                                delegateDid,
-                                protocols: connectedProtocols
-                            }
-                        });
-                        if (walletConnectOptions !== undefined) {
-                            // If we are using WalletConnect, we should do a one-shot sync to pull down any messages that are associated with the connectedDid
-                            yield userAgent.sync.sync('pull');
-                        }
-                    }
-                    // Enable sync using the specified interval or default.
-                    // When sync is unset (undefined), default to live mode.
-                    // When sync is an interval string (e.g. '2m', '30s'), use poll mode with that interval.
-                    const syncMode = sync === undefined ? 'live' : 'poll';
-                    const syncInterval = sync !== null && sync !== void 0 ? sync : (syncMode === 'live' ? '5m' : '2m');
-                    userAgent.sync.startSync({ mode: syncMode, interval: syncInterval })
-                        .catch((error) => {
-                        console.error(`Sync failed: ${error}`);
-                    });
-                }
-            }
-            const web5 = new Web5({ agent, connectedDid, delegateDid });
-            return { web5, did: connectedDid, delegateDid, recoveryPhrase };
-        });
-    }
-    /**
-     * Cleans up the DID, Keys and Identity. Primarily used by a failed WalletConnect import.
-     * Does not throw on error, but logs to console.
-     */
-    static cleanUpIdentity(_a) {
-        return __awaiter(this, arguments, void 0, function* ({ identity, userAgent }) {
-            try {
-                // Delete the DID and the Associated Keys
-                yield userAgent.did.delete({
-                    didUri: identity.did.uri,
-                    tenant: identity.metadata.tenant,
-                    deleteKey: true,
-                });
-            }
-            catch (error) {
-                console.error(`Failed to delete DID ${identity.did.uri}: ${error.message}`);
-            }
-            try {
-                // Delete the Identity
-                yield userAgent.identity.delete({ didUri: identity.did.uri });
-            }
-            catch (error) {
-                console.error(`Failed to delete Identity ${identity.metadata.name}: ${error.message}`);
-            }
-        });
-    }
-    /**
-     * A static method to process connected grants for a delegate DID.
-     *
-     * This will store the grants as the DWN owner to be used later when impersonating the connected DID.
-     */
-    static processConnectedGrants(_a) {
-        return __awaiter(this, arguments, void 0, function* ({ grants, agent, delegateDid }) {
-            const connectedProtocols = new Set();
-            for (const grantMessage of grants) {
-                // use the delegateDid as the connectedDid of the grant as they do not yet support impersonation/delegation
-                const grant = PermissionGrant.parse({ connectedDid: delegateDid, agent, message: grantMessage });
-                // store the grant as the owner of the DWN, this will allow the delegateDid to use the grant when impersonating the connectedDid
-                const { status } = yield grant.store(true);
-                if (status.code !== 202) {
-                    throw new Error(`AgentDwnApi: Failed to process connected grant: ${status.detail}`);
-                }
-                const protocol = grant.scope.protocol;
-                if (protocol) {
-                    connectedProtocols.add(protocol);
-                }
-            }
-            // currently we return a de-duped set of protocols represented by these grants, this is used to register protocols for sync
-            // we expect that any connected protocols will include MessagesSync and MessagesRead grants that will allow it to sync
-            return [...connectedProtocols];
-        });
-    }
-}
-//# sourceMappingURL=web5.js.map

package/dist/esm/web5.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"web5.js","sourceRoot":"","sources":["../../src/web5.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,2CAA2C;;;;;;;;;;;;;;;;;;;;;AAkB3C,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC7E,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,sBAAsB,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AACxG,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEjE,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AACtC,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AA6QpC;;;GAGG;AACH,MAAM,OAAO,IAAI;IAgBf,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,WAAW,EAAc;QAC1D,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,GAAG,GAAG,IAAI,MAAM,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC,CAAC;QAC/C,IAAI,CAAC,IAAI,GAAG,IAAI,MAAM,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC,CAAC;QAC7D,IAAI,CAAC,EAAE,GAAG,IAAI,KAAK,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACI,KAAK,CACV,QAA6B;QAE7B,OAAO,IAAI,SAAS,CAAO,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,MAAM,CAAC,SAAS,CAAC,OAA8B;;QAC7C,MAAM,WAAW,GAAG,IAAI,iBAAiB,CAAC;YACxC,YAAY,EAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,YAAY,mCAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;YACxE,KAAK,EAAU,IAAI,sBAAsB,EAAE;SAC5C,CAAC,CAAC;QAEH,MAAM,SAAS,GAAG,IAAI,aAAa,EAAE,CAAC;QACtC,MAAM,YAAY,GAAG,IAAI,eAAe,CAAC,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC,CAAC;QAErE,OAAO;YACL,GAAG,EAAE,IAAI,YAAY,CAAC,YAAY,CAAC;SACpC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAO,OAAO;6DAAC,EACnB,KAAK,EACL,UAAU,EACV,YAAY,EACZ,QAAQ,EACR,cAAc,EACd,IAAI,EACJ,WAAW,EACX,gBAAgB,EAChB,YAAY,EACZ,oBAAoB,MACE,EAAE;;YACxB,IAAI,WAA+B,CAAC;YACpC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACxB,IAAI,YAAY,GAAG,KAAK,CAAC;gBACzB,0FAA0F;gBAC1F,MAAM,SAAS,GAAG,MAAM,aAAa,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;gBAC7D,KAAK,GAAG,SAAS,CAAC;gBAElB,4FAA4F;gBAC5F,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;oBAC3B,QAAQ,GAAG,wBAAwB,CAAC;oBACpC,OAAO,CAAC,IAAI,CACV,wBAAwB;wBACxB,4EAA4E;wBAC5E,4DAA4D;wBAC5D,6CAA6C,EAC7C,gCAAgC,EAChC,sCAAsC,CACvC,CAAC;gBACJ,CAAC;gBAED,+DAA+D;gBAC/D,MAAM,oBAAoB,GAAG,MAAA,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,YAAY,mCAAI,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,YAAY,mCAAI,CAAC,2BAA2B,CAAC,CAAC;gBAE1H,iDAAiD;gBACjD,IAAI,MAAM,SAAS,CAAC,WAAW,EAAE,EAAE,CAAC;oBAClC,cAAc,GAAG,MAAM,SAAS,CAAC,UAAU,CAAC,EAAE,QAAQ,EAAE,cAAc,EAAE,YAAY,EAAE,oBAAoB,EAAE,CAAC,CAAC;gBAChH,CAAC;gBACD,MAAM,SAAS,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;gBACpC,2DAA2D;gBAC3D,MAAM,iBAAiB,GAAmB,MAAM,SAAS,CAAC,QAAQ,CAAC,iBAAiB,EAAE,CAAC;gBACvF,IAAI,QAAwB,CAAC;gBAC7B,IAAI,kBAAkB,GAAa,EAAE,CAAC;gBACtC,IAAI,iBAAiB,EAAE,CAAC;oBACtB,2CAA2C;oBAC3C,yHAAyH;oBACzH,QAAQ,GAAG,iBAAiB,CAAC;gBAC/B,CAAC;qBAAM,IAAI,oBAAoB,EAAE,CAAC;oBAChC,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;wBACnB,mEAAmE;wBACnE,mHAAmH;wBACnH,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;oBACxE,CAAC;oBAED,6FAA6F;oBAC7F,YAAY,GAAG,IAAI,CAAC;oBAEpB,yHAAyH;oBACzH,IAAI,CAAC;wBACH,MAAM,EAAE,kBAAkB,KAAwB,oBAAoB,EAAvC,cAAc,UAAK,oBAAoB,EAAhE,sBAAyC,CAAuB,CAAC;wBACvE,MAAM,wBAAwB,GAAG,kBAAkB,CAAC,GAAG,CACrD,CAAC,EAAE,kBAAkB,EAAE,WAAW,EAAE,EAAE,EAAE,CACtC,aAAa,CAAC,kCAAkC,CAAC;4BAC/C,UAAU,EAAI,kBAAkB;4BAChC,WAAW,EAAG,WAAW,aAAX,WAAW,cAAX,WAAW,GAAI;gCAC3B,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,WAAW;6BAChD;yBACF,CAAC,CACL,CAAC;wBAEF,MAAM,EAAE,mBAAmB,EAAE,YAAY,EAAE,cAAc,EAAE,GAAG,MAAM,aAAa,CAAC,UAAU,iCACvF,cAAc,KACjB,kBAAkB,EAAE,wBAAwB,IAC5C,CAAC;wBAEH,6DAA6D;wBAC7D,+HAA+H;wBAC/H,QAAQ,GAAG,MAAM,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,gBAAgB,EAAE;gCAC7D,WAAW,EAAG,mBAAmB;gCACjC,QAAQ,EAAM;oCACZ,YAAY;oCACZ,IAAI,EAAK,SAAS;oCAClB,GAAG,EAAM,mBAAmB,CAAC,GAAG;oCAChC,MAAM,EAAG,KAAK,CAAC,QAAQ,CAAC,GAAG;iCAC5B;6BACF,EAAE,CAAC,CAAC;wBAEL,yEAAyE;wBACzE,yDAAyD;wBACzD,wHAAwH;wBACxH,kBAAkB,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,mBAAmB,CAAC,GAAG,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC,CAAC;oBAClI,CAAC;oBAAC,OAAO,KAAS,EAAE,CAAC;wBACnB,0DAA0D;wBAC1D,uEAAuE;wBACvE,MAAM,IAAI,CAAC,eAAe,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC;wBACpD,MAAM,IAAI,KAAK,CAAC,gCAAgC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;oBACnE,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,8EAA8E;oBAC9E,mEAAmE;oBACnE,MAAM,UAAU,GAAG,MAAM,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;oBAEnD,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;wBAC5B,YAAY,GAAG,IAAI,CAAC;wBAEpB,wDAAwD;wBACxD,QAAQ,GAAG,MAAM,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC;4BACzC,SAAS,EAAI,KAAK;4BAClB,QAAQ,EAAK,EAAE,IAAI,EAAE,SAAS,EAAE;4BAChC,UAAU,EAAG;gCACX,QAAQ,EAAE;oCACR;wCACE,EAAE,EAAgB,KAAK;wCACvB,IAAI,EAAc,sBAAsB;wCACxC,eAAe,EAAG,oBAAoB;wCACtC,GAAG,EAAe,MAAM;wCACxB,GAAG,EAAe,MAAM;qCACzB;iCACF;gCACD,mBAAmB,EAAE;oCACnB;wCACE,SAAS,EAAG,SAAS;wCACrB,EAAE,EAAU,KAAK;wCACjB,QAAQ,EAAI,CAAC,iBAAiB,EAAE,gBAAgB,CAAC;qCAClD;oCACD;wCACE,SAAS,EAAG,QAAQ;wCACpB,EAAE,EAAU,KAAK;wCACjB,QAAQ,EAAI,CAAC,cAAc,CAAC;qCAC7B;iCACF;6BACF;yBACF,CAAC,CAAC;oBAEL,CAAC;yBAAM,CAAC;wBACN,sEAAsE;wBACtE,sEAAsE;wBACtE,wEAAwE;wBACxE,QAAQ,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;oBAC3B,CAAC;gBACH,CAAC;gBAED,6GAA6G;gBAC7G,YAAY,GAAG,MAAA,QAAQ,CAAC,QAAQ,CAAC,YAAY,mCAAI,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC;gBAClE,oHAAoH;gBACpH,WAAW,GAAG,QAAQ,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;gBAC5E,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;oBAC/B,MAAM,aAAa,qBACd,CAAC,MAAA,YAAY,CAAC,kBAAkB,mCAAI,EAAE,CAAC,CAC3C,CAAC;oBAEF,IAAI,CAAC;wBACH,KAAK,MAAM,WAAW,IAAI,oBAAoB,EAAE,CAAC;4BAC/C,MAAM,UAAU,GAAG,MAAM,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;4BAElE,IAAI,UAAU,CAAC,wBAAwB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gCACrD,SAAS;4BACX,CAAC;4BAED,gCAAgC;4BAChC,MAAM,cAAc,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,YAAY,CAAC;iCACtD,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,GAAG,EAAiB,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;4BAElE,MAAM,eAAe,GAAG,UAAU,CAAC,wBAAwB,CAAC,QAAQ,CAAC,kBAAkB,CAAC;mCACnF,UAAU,CAAC,YAAY,KAAK,SAAS,CAAC;4BAE3C,IAAI,eAAe,IAAI,YAAY,CAAC,sBAAsB,EAAE,CAAC;gCAC3D,6BAA6B;gCAC7B,IAAI,SAAS,GAAG,aAAa,CAAC,WAAW,CAAC,CAAC;gCAE3C,0BAA0B;gCAC1B,IAAI,CAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,SAAS,MAAK,SAAS,IAAI,SAAS,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;oCAC3E,IAAI,SAAS,CAAC,UAAU,IAAI,SAAS,CAAC,YAAY,EAAE,CAAC;wCACnD,MAAM,SAAS,GAAG,MAAM,YAAY,CAAC,wBAAwB,CAC3D,SAAS,CAAC,UAAU,EAAE,SAAS,CAAC,YAAY,CAC7C,CAAC;wCACF,SAAS,GAAG;4CACV,iBAAiB,EAAG,SAAS,CAAC,iBAAiB;4CAC/C,YAAY,EAAQ,SAAS,CAAC,YAAY;4CAC1C,SAAS,EAAW,SAAS,CAAC,SAAS,KAAK,SAAS;gDACnD,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,SAAS,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;4CACzD,QAAQ,EAAK,SAAS,CAAC,QAAQ;4CAC/B,UAAU,EAAG,SAAS,CAAC,UAAU;yCAClC,CAAC;wCACF,aAAa,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC;oCACzC,CAAC;yCAAM,CAAC;wCACN,SAAS,GAAG,SAAS,CAAC;oCACxB,CAAC;gCACH,CAAC;gCAED,8CAA8C;gCAC9C,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;oCAC5B,MAAM,KAAK,GAAG,MAAM,CAAC,UAAU,EAAE,CAAC;oCAClC,MAAM,YAAY,GAAG,UAAU,CAAC,YAAa,CAAC;oCAC9C,MAAM,SAAS,GAAG,YAAY,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;oCACtE,MAAM,YAAY,GAAG,GAAG,YAAY,CAAC,YAAY,GAAG,SAAS,EAAE;0CAC3D,gBAAgB,kBAAkB,CAAC,WAAW,CAAC,EAAE;0CACjD,UAAU,kBAAkB,CAAC,KAAK,CAAC,EAAE,CAAC;oCAE1C,MAAM,UAAU,GAAG,MAAM,YAAY,CAAC,sBAAsB,CAAC;wCAC3D,YAAY;wCACZ,WAAW;wCACX,KAAK;qCACN,CAAC,CAAC;oCAEH,IAAI,UAAU,CAAC,KAAK,KAAK,KAAK,EAAE,CAAC;wCAC/B,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;oCAC1E,CAAC;oCAED,MAAM,aAAa,GAAG,MAAM,YAAY,CAAC,gBAAgB,CACvD,YAAY,CAAC,QAAQ,EAAE,UAAU,CAAC,IAAI,EAAE,WAAW,CACpD,CAAC;oCAEF,SAAS,GAAG;wCACV,iBAAiB,EAAG,aAAa,CAAC,iBAAiB;wCACnD,YAAY,EAAQ,aAAa,CAAC,YAAY;wCAC9C,SAAS,EAAW,aAAa,CAAC,SAAS,KAAK,SAAS;4CACvD,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,aAAa,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;wCAC7D,QAAQ,EAAK,YAAY,CAAC,QAAQ;wCAClC,UAAU,EAAG,YAAY,CAAC,UAAU;qCACrC,CAAC;oCACF,aAAa,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC;gCACzC,CAAC;gCAED,mDAAmD;gCACnD,KAAK,MAAM,GAAG,IAAI,cAAc,EAAE,CAAC;oCACjC,MAAM,YAAY,CAAC,uBAAuB,CACxC,WAAW,EAAE,GAAG,EAAE,SAAS,CAAC,iBAAiB,CAC9C,CAAC;gCACJ,CAAC;4BAEH,CAAC;iCAAM,CAAC;gCACN,oDAAoD;gCACpD,KAAK,MAAM,GAAG,IAAI,cAAc,EAAE,CAAC;oCACjC,MAAM,YAAY,CAAC,cAAc,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;gCACtD,CAAC;4BACH,CAAC;wBACH,CAAC;wBAED,gDAAgD;wBAChD,IAAI,YAAY,CAAC,oBAAoB,EAAE,CAAC;4BACtC,YAAY,CAAC,oBAAoB,CAAC,aAAa,CAAC,CAAC;wBACnD,CAAC;wBAED,YAAY,CAAC,SAAS,EAAE,CAAC;oBAC3B,CAAC;oBAAC,OAAO,KAAK,EAAE,CAAC;wBACf,YAAY,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;oBAChC,CAAC;gBACH,CAAC;gBAED,2CAA2C;gBAC3C,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;oBACnB,8CAA8C;oBAC9C,+GAA+G;oBAE/G,IAAI,YAAY,EAAE,CAAC;wBACjB,MAAM,SAAS,CAAC,IAAI,CAAC,gBAAgB,CAAC;4BACpC,GAAG,EAAO,YAAY;4BACtB,OAAO,EAAG;gCACR,WAAW;gCACX,SAAS,EAAE,kBAAkB;6BAC9B;yBACF,CAAC,CAAC;wBAEH,IAAI,oBAAoB,KAAK,SAAS,EAAE,CAAC;4BACvC,kIAAkI;4BAClI,MAAM,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;wBACpC,CAAC;oBACH,CAAC;oBAED,uDAAuD;oBACvD,wDAAwD;oBACxD,wFAAwF;oBACxF,MAAM,QAAQ,GAAG,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC;oBACtD,MAAM,YAAY,GAAG,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,CAAC,QAAQ,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;oBACjE,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC;yBACjE,KAAK,CAAC,CAAC,KAAU,EAAE,EAAE;wBACpB,OAAO,CAAC,KAAK,CAAC,gBAAgB,KAAK,EAAE,CAAC,CAAC;oBACzC,CAAC,CAAC,CAAC;gBACP,CAAC;YACH,CAAC;YAED,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC,CAAC;YAE5D,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,YAAY,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC;QAClE,CAAC;KAAA;IAED;;;OAGG;IACK,MAAM,CAAO,eAAe;6DAAC,EAAE,QAAQ,EAAE,SAAS,EAGzD;YACC,IAAI,CAAC;gBACH,yCAAyC;gBACzC,MAAM,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC;oBACzB,MAAM,EAAM,QAAQ,CAAC,GAAG,CAAC,GAAG;oBAC5B,MAAM,EAAM,QAAQ,CAAC,QAAQ,CAAC,MAAM;oBACpC,SAAS,EAAG,IAAI;iBACjB,CAAC,CAAC;YACL,CAAC;YAAC,OAAO,KAAU,EAAE,CAAC;gBACpB,OAAO,CAAC,KAAK,CAAC,wBAAwB,QAAQ,CAAC,GAAG,CAAC,GAAG,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;YAC9E,CAAC;YAED,IAAI,CAAC;gBACH,sBAAsB;gBACtB,MAAM,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC;YAChE,CAAC;YAAC,OAAO,KAAU,EAAE,CAAC;gBACpB,OAAO,CAAC,KAAK,CAAC,6BAA6B,QAAQ,CAAC,QAAQ,CAAC,IAAI,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;YACzF,CAAC;QACH,CAAC;KAAA;IAED;;;;OAIG;IACH,MAAM,CAAO,sBAAsB;6DAAC,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,EAI/D;YACC,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAAU,CAAC;YAC7C,KAAK,MAAM,YAAY,IAAI,MAAM,EAAE,CAAC;gBAClC,2GAA2G;gBAC3G,MAAM,KAAK,GAAG,eAAe,CAAC,KAAK,CAAC,EAAE,YAAY,EAAE,WAAW,EAAE,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC;gBACjG,gIAAgI;gBAChI,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBAC3C,IAAI,MAAM,CAAC,IAAI,KAAK,GAAG,EAAE,CAAC;oBACxB,MAAM,IAAI,KAAK,CAAC,mDAAmD,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;gBACtF,CAAC;gBAED,MAAM,QAAQ,GAAI,KAAK,CAAC,KAAgE,CAAC,QAAQ,CAAC;gBAClG,IAAI,QAAQ,EAAE,CAAC;oBACb,kBAAkB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBACnC,CAAC;YACH,CAAC;YAED,2HAA2H;YAC3H,sHAAsH;YACtH,OAAO,CAAC,GAAG,kBAAkB,CAAC,CAAC;QACjC,CAAC;KAAA;CACF"}

package/dist/types/typed-web5.d.ts

@@ -1,221 +0,0 @@
-/**
- * A protocol-scoped API returned by {@link Web5.using}.
- *
- * `TypedWeb5` is the **primary developer interface** for interacting with
- * protocol-backed records. It auto-injects the protocol URI, protocolPath,
- * and schema into every operation, and provides compile-time path
- * autocompletion plus typed data payloads via the schema map.
- *
- * All record-returning methods wrap the underlying `Record` instances in
- * {@link TypedRecord} so that type information flows through reads, queries,
- * updates, and subscriptions without manual casts.
- *
- * @example
- * ```ts
- * const social = web5.using(SocialProtocol);
- *
- * // Install the protocol
- * await social.configure();
- *
- * // Create — path and data type are checked at compile time
- * const { record } = await social.records.create('thread', {
- *   data: { title: 'Hello World', body: '...' },
- * });
- * // record is TypedRecord<ThreadData>
- *
- * const data = await record.data.json(); // ThreadData — no cast needed
- *
- * // Query — protocol and protocolPath are auto-injected
- * const { records } = await social.records.query('thread');
- * // records is TypedRecord<ThreadData>[]
- *
- * // Subscribe — real-time changes via TypedLiveQuery
- * const { liveQuery } = await social.records.subscribe('thread/reply');
- * liveQuery.on('create', (record) => {
- *   // record is TypedRecord<ReplyData>
- * });
- * ```
- */
-import type { DwnApi } from './dwn-api.js';
-import type { Protocol } from './protocol.js';
-import type { DateSort, ProtocolDefinition, ProtocolType, RecordsFilter } from '@enbox/dwn-sdk-js';
-import type { DwnPaginationCursor, DwnResponseStatus } from '@enbox/agent';
-import type { ProtocolPaths, SchemaMap, TypedProtocol, TypeNameAtPath } from './protocol-types.js';
-import { TypedLiveQuery } from './typed-live-query.js';
-import { TypedRecord } from './typed-record.js';
-/**
- * Resolves the TypeScript data type for a given protocol path.
- *
- * If the schema map contains a mapping for the type name at the given path,
- * that type is returned. Otherwise falls back to `unknown`.
- */
-export type DataForPath<_D extends ProtocolDefinition, M extends SchemaMap, Path extends string> = TypeNameAtPath<Path> extends keyof M ? M[TypeNameAtPath<Path>] : unknown;
-/**
- * Resolves the `ProtocolType` entry for a given protocol path.
- */
-type ProtocolTypeForPath<D extends ProtocolDefinition, Path extends string> = TypeNameAtPath<Path> extends keyof D['types'] ? D['types'][TypeNameAtPath<Path>] extends ProtocolType ? D['types'][TypeNameAtPath<Path>] : undefined : undefined;
-/**
- * Resolves a `dataFormat` string literal union for a path, or `string` if none.
- */
-type DataFormatForPath<D extends ProtocolDefinition, Path extends string> = ProtocolTypeForPath<D, Path> extends {
-    dataFormats: infer F;
-} ? F extends readonly string[] ? F[number] : string : string;
-/** Options for {@link TypedWeb5} `records.create()`. */
-export type TypedCreateRequest<D extends ProtocolDefinition, M extends SchemaMap, Path extends string> = {
-    /** The data payload. Type-checked against the schema map. */
-    data: DataForPath<D, M, Path>;
-    parentContextId?: string;
-    published?: boolean;
-    datePublished?: string;
-    recipient?: string;
-    protocolRole?: string;
-    dataFormat?: DataFormatForPath<D, Path>;
-    tags?: globalThis.Record<string, string | number | boolean | string[] | number[]>;
-    /** Whether to persist immediately (defaults to `true`). */
-    store?: boolean;
-    /** Whether to auto-encrypt (follows protocol definition if omitted). */
-    encryption?: boolean;
-};
-/** Response from {@link TypedWeb5} `records.create()`. */
-export type TypedCreateResponse<T = unknown> = DwnResponseStatus & {
-    record: TypedRecord<T>;
-};
-/** Filter options for {@link TypedWeb5} `records.query()`. */
-export type TypedQueryFilter = Omit<RecordsFilter, 'protocol' | 'protocolPath' | 'schema'> & {
-    tags?: globalThis.Record<string, string | number | boolean | (string | number)[]>;
-};
-/** Options for {@link TypedWeb5} `records.query()`. */
-export type TypedQueryRequest = {
-    /** Optional remote DWN DID to query from. */
-    from?: string;
-    /** Query filter (protocol, protocolPath, schema are injected). */
-    filter?: TypedQueryFilter;
-    dateSort?: DateSort;
-    pagination?: {
-        limit?: number;
-        cursor?: DwnPaginationCursor;
-    };
-    protocolRole?: string;
-    /** When true, automatically decrypts encrypted records. */
-    encryption?: boolean;
-};
-/** Response from {@link TypedWeb5} `records.query()`. */
-export type TypedQueryResponse<T = unknown> = DwnResponseStatus & {
-    records: TypedRecord<T>[];
-    cursor?: DwnPaginationCursor;
-};
-/** Options for {@link TypedWeb5} `records.read()`. */
-export type TypedReadRequest = {
-    /** Optional remote DWN DID to read from. */
-    from?: string;
-    /** Filter to identify the record (protocol and protocolPath are injected). */
-    filter: Omit<RecordsFilter, 'protocol' | 'protocolPath' | 'schema'>;
-    /** When true, automatically decrypts the record. */
-    encryption?: boolean;
-};
-/** Response from {@link TypedWeb5} `records.read()`. */
-export type TypedReadResponse<T = unknown> = DwnResponseStatus & {
-    record: TypedRecord<T>;
-};
-/** Options for {@link TypedWeb5} `records.delete()`. */
-export type TypedDeleteRequest = {
-    /** Optional remote DWN DID to delete from. */
-    from?: string;
-    /** The `recordId` of the record to delete. */
-    recordId: string;
-};
-/** Options for {@link TypedWeb5} `records.subscribe()`. */
-export type TypedSubscribeRequest = {
-    /** Optional remote DWN DID to subscribe to. */
-    from?: string;
-    /** Subscription filter (protocol, protocolPath, schema are injected). */
-    filter?: TypedQueryFilter;
-    protocolRole?: string;
-};
-/** Response from {@link TypedWeb5} `records.subscribe()`. */
-export type TypedSubscribeResponse<T = unknown> = DwnResponseStatus & {
-    /** The typed live query instance, or `undefined` if the request failed. */
-    liveQuery?: TypedLiveQuery<T>;
-};
-/**
- * A protocol-scoped API that auto-injects `protocol`, `protocolPath`, and
- * `schema` into every DWN operation.
- *
- * All record-returning methods wrap results in {@link TypedRecord} so that
- * the data type `T` (resolved from the schema map) flows end-to-end — from
- * write through read, query, update, and subscribe — without manual casts.
- *
- * Obtain an instance via `web5.using(typedProtocol)`.
- *
- * @example
- * ```ts
- * const social = web5.using(SocialProtocol);
- *
- * await social.configure();
- *
- * const { record } = await social.records.create('friend', {
- *   data: { did: 'did:example:alice', alias: 'Alice' },
- * });
- * const data = await record.data.json(); // FriendData — no cast
- *
- * const { records } = await social.records.query('friend', {
- *   filter: { tags: { did: 'did:example:alice' } },
- * });
- * for (const r of records) {
- *   const d = await r.data.json(); // FriendData
- * }
- * ```
- */
-export declare class TypedWeb5<D extends ProtocolDefinition = ProtocolDefinition, M extends SchemaMap = SchemaMap> {
-    private _dwn;
-    private _definition;
-    private _configured;
-    private _validPaths;
-    private _records?;
-    constructor(dwn: DwnApi, protocol: TypedProtocol<D, M>);
-    /** The protocol URI. */
-    get protocol(): string;
-    /** The raw protocol definition. */
-    get definition(): D;
-    /**
-     * Configures (installs) this protocol on the local DWN.
-     *
-     * If the protocol is already installed with an identical definition,
-     * this is a no-op and returns the existing protocol. If the definition
-     * has changed (e.g. new types, modified structure), the protocol is
-     * re-configured with the updated definition.
-     *
-     * @param options - Optional overrides like `encryption`.
-     */
-    configure(options?: {
-        encryption?: boolean;
-    }): Promise<DwnResponseStatus & {
-        protocol?: Protocol;
-    }>;
-    /** Whether the protocol has been configured (installed) on the local DWN. */
-    get isConfigured(): boolean;
-    /**
-     * Validates that the protocol has been configured and that the path is
-     * recognized. Throws a descriptive error if either check fails.
-     */
-    private _assertReady;
-    /**
-     * Protocol-scoped record operations.
-     *
-     * Every method auto-injects the protocol URI, protocolPath, and schema
-     * from the protocol definition. Path parameters provide compile-time
-     * autocompletion via `ProtocolPaths<D>`.
-     *
-     * All methods return {@link TypedRecord} or {@link TypedLiveQuery} instances
-     * that carry the resolved data type from the schema map.
-     */
-    get records(): {
-        create: <Path extends ProtocolPaths<D> & string>(path: Path, request: TypedCreateRequest<D, M, Path>) => Promise<TypedCreateResponse<DataForPath<D, M, Path>>>;
-        query: <Path extends ProtocolPaths<D> & string>(path: Path, request?: TypedQueryRequest) => Promise<TypedQueryResponse<DataForPath<D, M, Path>>>;
-        read: <Path extends ProtocolPaths<D> & string>(path: Path, request: TypedReadRequest) => Promise<TypedReadResponse<DataForPath<D, M, Path>>>;
-        delete: <Path extends ProtocolPaths<D> & string>(path: Path, request: TypedDeleteRequest) => Promise<DwnResponseStatus>;
-        subscribe: <Path extends ProtocolPaths<D> & string>(path: Path, request?: TypedSubscribeRequest) => Promise<TypedSubscribeResponse<DataForPath<D, M, Path>>>;
-    };
-}
-export {};
-//# sourceMappingURL=typed-web5.d.ts.map