@interop/did-cli 0.10.0 → 0.12.0

package/dist/meta.js

@@ -115,6 +115,40 @@ export async function removeKeyDidAssociation({ publicKeyMultibase, did }) {
         meta: updated
     });
 }
+/**
+ * Resolve a metadata handle to a single storage id by scanning the `.meta.json`
+ * sidecars of a set of items. This is the shared core of every `resolve*Ref`
+ * helper: the direct id/fingerprint match stays in each caller, and this
+ * collapses the "scan handles, collect matches, complain on ambiguity" tail.
+ * Returns undefined when no handle matches; throws when more than one does
+ * (handles are not unique).
+ *
+ * @param options {object}
+ * @param options.ref {string}             The handle to match.
+ * @param options.noun {string}            Plural noun for the ambiguity message (e.g. `zcaps`).
+ * @param options.alternative {string}     The unambiguous identifier to suggest instead.
+ * @param options.storageIds {string[]}    The storage ids to scan.
+ * @param options.loadMeta {(storageId: string) => Promise<MetaType | undefined>}
+ *   Loads the metadata sidecar for a storage id.
+ * @returns {Promise<{storageId: string, meta: MetaType} | undefined>}
+ */
+export async function resolveByHandle({ ref, noun, alternative, storageIds, loadMeta }) {
+    const matches = [];
+    for (const storageId of storageIds) {
+        const meta = await loadMeta(storageId);
+        if (meta?.handle === ref) {
+            matches.push({ storageId, meta });
+        }
+    }
+    if (matches.length === 0) {
+        return undefined;
+    }
+    if (matches.length > 1) {
+        throw new Error(`Handle "${ref}" matches ${matches.length} ${noun}; ` +
+            `use the ${alternative} instead.`);
+    }
+    return matches[0];
+}
 /**
  * Resolve a user-supplied DID reference -- a full DID or a metadata handle --
  * to a stored DID. Anything starting with `did:` is returned as-is; otherwise
@@ -130,22 +164,14 @@ export async function resolveDidRef({ ref }) {
     if (ref.startsWith('did:')) {
         return ref;
     }
-    const dids = await listDids();
-    const matches = [];
-    for (const did of dids) {
-        const meta = await loadDidMeta({ did });
-        if (meta?.handle === ref) {
-            matches.push(did);
-        }
-    }
-    if (matches.length === 0) {
-        return undefined;
-    }
-    if (matches.length > 1) {
-        throw new Error(`Handle "${ref}" matches ${matches.length} DIDs; ` +
-            'use the full DID instead.');
-    }
-    return matches[0];
+    const match = await resolveByHandle({
+        ref,
+        noun: 'DIDs',
+        alternative: 'full DID',
+        storageIds: await listDids(),
+        loadMeta: did => loadDidMeta({ did })
+    });
+    return match?.storageId;
 }
 /**
  * Resolve a user-supplied zcap reference -- a capability id (the `urn:...`
@@ -156,12 +182,15 @@ export async function resolveDidRef({ ref }) {
  *
  * @param options {object}
  * @param options.ref {string}
- * @returns {Promise<{storageId: string, zcap: StoredZcap, meta?: KeyMetadata} | undefined>}
+ * @returns {Promise<{storageId: string, zcap: StoredZcap, meta?: ItemMetadata} | undefined>}
  */
 export async function resolveZcapRef({ ref }) {
     const storageIds = await listCollection('zcaps');
     for (const storageId of storageIds) {
-        const zcap = await loadFromCollection('zcaps', storageId);
+        const zcap = await loadFromCollection({
+            collection: 'zcaps',
+            storageId
+        });
         if (zcap.id === ref) {
             const meta = await loadMetaFromCollection({
                 collection: 'zcaps',
@@ -170,26 +199,21 @@ export async function resolveZcapRef({ ref }) {
             return { storageId, zcap, meta };
         }
     }
-    const matches = [];
-    for (const storageId of storageIds) {
-        const meta = await loadMetaFromCollection({
-            collection: 'zcaps',
-            storageId
-        });
-        if (meta?.handle === ref) {
-            matches.push({ storageId, meta });
-        }
-    }
-    if (matches.length === 0) {
+    const match = await resolveByHandle({
+        ref,
+        noun: 'zcaps',
+        alternative: 'capability id',
+        storageIds,
+        loadMeta: storageId => loadMetaFromCollection({ collection: 'zcaps', storageId })
+    });
+    if (!match) {
         return undefined;
     }
-    if (matches.length > 1) {
-        throw new Error(`Handle "${ref}" matches ${matches.length} zcaps; ` +
-            'use the capability id instead.');
-    }
-    const { storageId, meta } = matches[0];
-    const zcap = await loadFromCollection('zcaps', storageId);
-    return { storageId, zcap, meta };
+    const zcap = await loadFromCollection({
+        collection: 'zcaps',
+        storageId: match.storageId
+    });
+    return { storageId: match.storageId, zcap, meta: match.meta };
 }
 /**
  * Resolve a user-supplied credential reference -- a credential id, a storage
@@ -201,12 +225,15 @@ export async function resolveZcapRef({ ref }) {
  *
  * @param options {object}
  * @param options.ref {string}
- * @returns {Promise<{storageId: string, credential: StoredCredential, meta?: KeyMetadata} | undefined>}
+ * @returns {Promise<{storageId: string, credential: StoredCredential, meta?: ItemMetadata} | undefined>}
  */
 export async function resolveCredentialRef({ ref }) {
     const storageIds = await listCollection('credentials');
     for (const storageId of storageIds) {
-        const credential = await loadFromCollection('credentials', storageId);
+        const credential = await loadFromCollection({
+            collection: 'credentials',
+            storageId
+        });
         if (credential.id === ref) {
             const meta = await loadMetaFromCollection({
                 collection: 'credentials',
@@ -216,33 +243,31 @@ export async function resolveCredentialRef({ ref }) {
         }
     }
     if (storageIds.includes(ref)) {
-        const credential = await loadFromCollection('credentials', ref);
-        const meta = await loadMetaFromCollection({
+        const credential = await loadFromCollection({
             collection: 'credentials',
             storageId: ref
         });
-        return { storageId: ref, credential, meta };
-    }
-    const matches = [];
-    for (const storageId of storageIds) {
         const meta = await loadMetaFromCollection({
             collection: 'credentials',
-            storageId
+            storageId: ref
         });
-        if (meta?.handle === ref) {
-            matches.push({ storageId, meta });
-        }
+        return { storageId: ref, credential, meta };
     }
-    if (matches.length === 0) {
+    const match = await resolveByHandle({
+        ref,
+        noun: 'credentials',
+        alternative: 'credential id',
+        storageIds,
+        loadMeta: storageId => loadMetaFromCollection({ collection: 'credentials', storageId })
+    });
+    if (!match) {
         return undefined;
     }
-    if (matches.length > 1) {
-        throw new Error(`Handle "${ref}" matches ${matches.length} credentials; ` +
-            'use the credential id instead.');
-    }
-    const { storageId, meta } = matches[0];
-    const credential = await loadFromCollection('credentials', storageId);
-    return { storageId, credential, meta };
+    const credential = await loadFromCollection({
+        collection: 'credentials',
+        storageId: match.storageId
+    });
+    return { storageId: match.storageId, credential, meta: match.meta };
 }
 /**
  * Resolve a user-supplied key reference -- a publicKeyMultibase fingerprint
@@ -253,7 +278,7 @@ export async function resolveCredentialRef({ ref }) {
  *
  * @param options {object}
  * @param options.ref {string}
- * @returns {Promise<{storageId: string, key: object, meta?: KeyMetadata} | undefined>}
+ * @returns {Promise<{storageId: string, key: StoredKeyPair, meta?: KeyMetadata} | undefined>}
  */
 export async function resolveKeyRef({ ref }) {
     const byFingerprint = await findStoredKey({ fingerprint: ref });
@@ -264,23 +289,20 @@ export async function resolveKeyRef({ ref }) {
         });
         return { ...byFingerprint, meta };
     }
-    const storageIds = await listCollection('keys');
-    const matches = [];
-    for (const storageId of storageIds) {
-        const meta = await loadMetaFromCollection({ collection: 'keys', storageId });
-        if (meta?.handle === ref) {
-            matches.push({ storageId, meta });
-        }
-    }
-    if (matches.length === 0) {
+    const match = await resolveByHandle({
+        ref,
+        noun: 'keys',
+        alternative: 'publicKeyMultibase fingerprint',
+        storageIds: await listCollection('keys'),
+        loadMeta: storageId => loadMetaFromCollection({ collection: 'keys', storageId })
+    });
+    if (!match) {
         return undefined;
     }
-    if (matches.length > 1) {
-        throw new Error(`Handle "${ref}" matches ${matches.length} keys; ` +
-            'use the publicKeyMultibase fingerprint instead.');
-    }
-    const { storageId, meta } = matches[0];
-    const key = await loadFromCollection('keys', storageId);
-    return { storageId, key, meta };
+    const key = await loadFromCollection({
+        collection: 'keys',
+        storageId: match.storageId
+    });
+    return { storageId: match.storageId, key, meta: match.meta };
 }
 //# sourceMappingURL=meta.js.map

package/dist/meta.js.map

@@ -1 +1 @@
-{"version":3,"file":"meta.js","sourceRoot":"","sources":["../src/meta.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EACL,aAAa,EACb,cAAc,EACd,QAAQ,EACR,eAAe,EACf,WAAW,EACX,kBAAkB,EAClB,sBAAsB,EACtB,oBAAoB,EAErB,MAAM,cAAc,CAAA;AAErB;;;;;;;;GAQG;AACH,MAAM,UAAU,iBAAiB,CAAC,EAAE,SAAS,EAAyB;IAKpE,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAC3B,iEAAiE,CAClE,CAAA;IACD,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,EAAE,CAAA;IACX,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAA;AAC5D,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB;IACzC,MAAM,eAAe,GAAG,IAAI,GAAG,EAAoB,CAAA;IACnD,MAAM,IAAI,GAAG,MAAM,QAAQ,EAAE,CAAA;IAC7B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,MAAM,WAAW,GAAG,MAAM,eAAe,CAEtC,GAAG,CAAC,CAAA;QACP,KAAK,MAAM,MAAM,IAAI,WAAW,CAAC,kBAAkB,IAAI,EAAE,EAAE,CAAC;YAC1D,IAAI,CAAC,MAAM,CAAC,kBAAkB,EAAE,CAAC;gBAC/B,SAAQ;YACV,CAAC;YACD,MAAM,OAAO,GAAG,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,kBAAkB,CAAC,IAAI,EAAE,CAAA;YACpE,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC3B,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YACnB,CAAC;YACD,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAA;QACzD,CAAC;IACH,CAAC;IACD,KAAK,MAAM,OAAO,IAAI,eAAe,CAAC,MAAM,EAAE,EAAE,CAAC;QAC/C,OAAO,CAAC,IAAI,EAAE,CAAA;IAChB,CAAC;IACD,OAAO,eAAe,CAAA;AACxB,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAAC,EAC5C,kBAAkB,EAClB,GAAG,EAIJ;IACC,MAAM,KAAK,GAAG,MAAM,aAAa,CAAC,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC,CAAA;IACtE,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAM;IACR,CAAC;IACD,MAAM,IAAI,GACR,CAAC,MAAM,sBAAsB,CAAC;QAC5B,UAAU,EAAE,MAAM;QAClB,SAAS,EAAE,KAAK,CAAC,SAAS;KAC3B,CAAC,CAAC,IAAI,EAAE,CAAA;IACX,MAAM,IAAI,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;IAC7D,MAAM,oBAAoB,CAAC;QACzB,UAAU,EAAE,MAAM;QAClB,SAAS,EAAE,KAAK,CAAC,SAAS;QAC1B,IAAI,EAAE,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE;KACxB,CAAC,CAAA;AACJ,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAAC,EAC5C,kBAAkB,EAClB,GAAG,EAIJ;IACC,MAAM,KAAK,GAAG,MAAM,aAAa,CAAC,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC,CAAA;IACtE,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAM;IACR,CAAC;IACD,MAAM,IAAI,GAAG,MAAM,sBAAsB,CAAC;QACxC,UAAU,EAAE,MAAM;QAClB,SAAS,EAAE,KAAK,CAAC,SAAS;KAC3B,CAAC,CAAA;IACF,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QAC/B,OAAM;IACR,CAAC;IACD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,KAAK,GAAG,CAAC,CAAA;IACrD,MAAM,OAAO,GAAgB,EAAE,GAAG,IAAI,EAAE,CAAA;IACxC,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACpB,OAAO,CAAC,IAAI,GAAG,IAAI,CAAA;IACrB,CAAC;SAAM,CAAC;QACN,OAAO,OAAO,CAAC,IAAI,CAAA;IACrB,CAAC;IACD,MAAM,oBAAoB,CAAC;QACzB,UAAU,EAAE,MAAM;QAClB,SAAS,EAAE,KAAK,CAAC,SAAS;QAC1B,IAAI,EAAE,OAAO;KACd,CAAC,CAAA;AACJ,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,EAClC,GAAG,EAGJ;IACC,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QAC3B,OAAO,GAAG,CAAA;IACZ,CAAC;IACD,MAAM,IAAI,GAAG,MAAM,QAAQ,EAAE,CAAA;IAC7B,MAAM,OAAO,GAAa,EAAE,CAAA;IAC5B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,MAAM,IAAI,GAAG,MAAM,WAAW,CAAC,EAAE,GAAG,EAAE,CAAC,CAAA;QACvC,IAAI,IAAI,EAAE,MAAM,KAAK,GAAG,EAAE,CAAC;YACzB,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QACnB,CAAC;IACH,CAAC;IACD,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,SAAS,CAAA;IAClB,CAAC;IACD,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,MAAM,IAAI,KAAK,CACb,WAAW,GAAG,aAAa,OAAO,CAAC,MAAM,SAAS;YAChD,2BAA2B,CAC9B,CAAA;IACH,CAAC;IACD,OAAO,OAAO,CAAC,CAAC,CAAC,CAAA;AACnB,CAAC;AAeD;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,EAAE,GAAG,EAAmB;IAQ3D,MAAM,UAAU,GAAG,MAAM,cAAc,CAAC,OAAO,CAAC,CAAA;IAChD,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;QACnC,MAAM,IAAI,GAAG,MAAM,kBAAkB,CAAa,OAAO,EAAE,SAAS,CAAC,CAAA;QACrE,IAAI,IAAI,CAAC,EAAE,KAAK,GAAG,EAAE,CAAC;YACpB,MAAM,IAAI,GAAG,MAAM,sBAAsB,CAAC;gBACxC,UAAU,EAAE,OAAO;gBACnB,SAAS;aACV,CAAC,CAAA;YACF,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,CAAA;QAClC,CAAC;IACH,CAAC;IACD,MAAM,OAAO,GAA+C,EAAE,CAAA;IAC9D,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;QACnC,MAAM,IAAI,GAAG,MAAM,sBAAsB,CAAC;YACxC,UAAU,EAAE,OAAO;YACnB,SAAS;SACV,CAAC,CAAA;QACF,IAAI,IAAI,EAAE,MAAM,KAAK,GAAG,EAAE,CAAC;YACzB,OAAO,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;QACnC,CAAC;IACH,CAAC;IACD,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,SAAS,CAAA;IAClB,CAAC;IACD,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,MAAM,IAAI,KAAK,CACb,WAAW,GAAG,aAAa,OAAO,CAAC,MAAM,UAAU;YACjD,gCAAgC,CACnC,CAAA;IACH,CAAC;IACD,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;IACtC,MAAM,IAAI,GAAG,MAAM,kBAAkB,CAAa,OAAO,EAAE,SAAS,CAAC,CAAA;IACrE,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,CAAA;AAClC,CAAC;AAiBD;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAC,EAAE,GAAG,EAAmB;IAQjE,MAAM,UAAU,GAAG,MAAM,cAAc,CAAC,aAAa,CAAC,CAAA;IACtD,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;QACnC,MAAM,UAAU,GAAG,MAAM,kBAAkB,CACzC,aAAa,EACb,SAAS,CACV,CAAA;QACD,IAAI,UAAU,CAAC,EAAE,KAAK,GAAG,EAAE,CAAC;YAC1B,MAAM,IAAI,GAAG,MAAM,sBAAsB,CAAC;gBACxC,UAAU,EAAE,aAAa;gBACzB,SAAS;aACV,CAAC,CAAA;YACF,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,IAAI,EAAE,CAAA;QACxC,CAAC;IACH,CAAC;IACD,IAAI,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QAC7B,MAAM,UAAU,GAAG,MAAM,kBAAkB,CACzC,aAAa,EACb,GAAG,CACJ,CAAA;QACD,MAAM,IAAI,GAAG,MAAM,sBAAsB,CAAC;YACxC,UAAU,EAAE,aAAa;YACzB,SAAS,EAAE,GAAG;SACf,CAAC,CAAA;QACF,OAAO,EAAE,SAAS,EAAE,GAAG,EAAE,UAAU,EAAE,IAAI,EAAE,CAAA;IAC7C,CAAC;IACD,MAAM,OAAO,GAA+C,EAAE,CAAA;IAC9D,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;QACnC,MAAM,IAAI,GAAG,MAAM,sBAAsB,CAAC;YACxC,UAAU,EAAE,aAAa;YACzB,SAAS;SACV,CAAC,CAAA;QACF,IAAI,IAAI,EAAE,MAAM,KAAK,GAAG,EAAE,CAAC;YACzB,OAAO,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;QACnC,CAAC;IACH,CAAC;IACD,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,SAAS,CAAA;IAClB,CAAC;IACD,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,MAAM,IAAI,KAAK,CACb,WAAW,GAAG,aAAa,OAAO,CAAC,MAAM,gBAAgB;YACvD,gCAAgC,CACnC,CAAA;IACH,CAAC;IACD,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;IACtC,MAAM,UAAU,GAAG,MAAM,kBAAkB,CACzC,aAAa,EACb,SAAS,CACV,CAAA;IACD,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,IAAI,EAAE,CAAA;AACxC,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,EAAE,GAAG,EAAmB;IAY1D,MAAM,aAAa,GAAG,MAAM,aAAa,CAAC,EAAE,WAAW,EAAE,GAAG,EAAE,CAAC,CAAA;IAC/D,IAAI,aAAa,EAAE,CAAC;QAClB,MAAM,IAAI,GAAG,MAAM,sBAAsB,CAAC;YACxC,UAAU,EAAE,MAAM;YAClB,SAAS,EAAE,aAAa,CAAC,SAAS;SACnC,CAAC,CAAA;QACF,OAAO,EAAE,GAAG,aAAa,EAAE,IAAI,EAAE,CAAA;IACnC,CAAC;IACD,MAAM,UAAU,GAAG,MAAM,cAAc,CAAC,MAAM,CAAC,CAAA;IAC/C,MAAM,OAAO,GAA+C,EAAE,CAAA;IAC9D,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;QACnC,MAAM,IAAI,GAAG,MAAM,sBAAsB,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAA;QAC5E,IAAI,IAAI,EAAE,MAAM,KAAK,GAAG,EAAE,CAAC;YACzB,OAAO,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;QACnC,CAAC;IACH,CAAC;IACD,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,SAAS,CAAA;IAClB,CAAC;IACD,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,MAAM,IAAI,KAAK,CACb,WAAW,GAAG,aAAa,OAAO,CAAC,MAAM,SAAS;YAChD,iDAAiD,CACpD,CAAA;IACH,CAAC;IACD,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;IACtC,MAAM,GAAG,GAAG,MAAM,kBAAkB,CAIjC,MAAM,EAAE,SAAS,CAAC,CAAA;IACrB,OAAO,EAAE,SAAS,EAAE,GAAG,EAAE,IAAI,EAAE,CAAA;AACjC,CAAC"}
+{"version":3,"file":"meta.js","sourceRoot":"","sources":["../src/meta.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EACL,aAAa,EACb,cAAc,EACd,QAAQ,EACR,eAAe,EACf,WAAW,EACX,kBAAkB,EAClB,sBAAsB,EACtB,oBAAoB,EAIrB,MAAM,cAAc,CAAA;AAErB;;;;;;;;GAQG;AACH,MAAM,UAAU,iBAAiB,CAAC,EAAE,SAAS,EAAyB;IAKpE,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAC3B,iEAAiE,CAClE,CAAA;IACD,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,EAAE,CAAA;IACX,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAA;AAC5D,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB;IACzC,MAAM,eAAe,GAAG,IAAI,GAAG,EAAoB,CAAA;IACnD,MAAM,IAAI,GAAG,MAAM,QAAQ,EAAE,CAAA;IAC7B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,MAAM,WAAW,GAAG,MAAM,eAAe,CAEtC,GAAG,CAAC,CAAA;QACP,KAAK,MAAM,MAAM,IAAI,WAAW,CAAC,kBAAkB,IAAI,EAAE,EAAE,CAAC;YAC1D,IAAI,CAAC,MAAM,CAAC,kBAAkB,EAAE,CAAC;gBAC/B,SAAQ;YACV,CAAC;YACD,MAAM,OAAO,GAAG,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,kBAAkB,CAAC,IAAI,EAAE,CAAA;YACpE,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC3B,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YACnB,CAAC;YACD,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAA;QACzD,CAAC;IACH,CAAC;IACD,KAAK,MAAM,OAAO,IAAI,eAAe,CAAC,MAAM,EAAE,EAAE,CAAC;QAC/C,OAAO,CAAC,IAAI,EAAE,CAAA;IAChB,CAAC;IACD,OAAO,eAAe,CAAA;AACxB,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAAC,EAC5C,kBAAkB,EAClB,GAAG,EAIJ;IACC,MAAM,KAAK,GAAG,MAAM,aAAa,CAAC,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC,CAAA;IACtE,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAM;IACR,CAAC;IACD,MAAM,IAAI,GACR,CAAC,MAAM,sBAAsB,CAAc;QACzC,UAAU,EAAE,MAAM;QAClB,SAAS,EAAE,KAAK,CAAC,SAAS;KAC3B,CAAC,CAAC,IAAI,EAAE,CAAA;IACX,MAAM,IAAI,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;IAC7D,MAAM,oBAAoB,CAAC;QACzB,UAAU,EAAE,MAAM;QAClB,SAAS,EAAE,KAAK,CAAC,SAAS;QAC1B,IAAI,EAAE,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE;KACxB,CAAC,CAAA;AACJ,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAAC,EAC5C,kBAAkB,EAClB,GAAG,EAIJ;IACC,MAAM,KAAK,GAAG,MAAM,aAAa,CAAC,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC,CAAA;IACtE,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAM;IACR,CAAC;IACD,MAAM,IAAI,GAAG,MAAM,sBAAsB,CAAc;QACrD,UAAU,EAAE,MAAM;QAClB,SAAS,EAAE,KAAK,CAAC,SAAS;KAC3B,CAAC,CAAA;IACF,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QAC/B,OAAM;IACR,CAAC;IACD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,KAAK,GAAG,CAAC,CAAA;IACrD,MAAM,OAAO,GAAgB,EAAE,GAAG,IAAI,EAAE,CAAA;IACxC,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACpB,OAAO,CAAC,IAAI,GAAG,IAAI,CAAA;IACrB,CAAC;SAAM,CAAC;QACN,OAAO,OAAO,CAAC,IAAI,CAAA;IACrB,CAAC;IACD,MAAM,oBAAoB,CAAC;QACzB,UAAU,EAAE,MAAM;QAClB,SAAS,EAAE,KAAK,CAAC,SAAS;QAC1B,IAAI,EAAE,OAAO;KACd,CAAC,CAAA;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CAAuC,EAC1E,GAAG,EACH,IAAI,EACJ,WAAW,EACX,UAAU,EACV,QAAQ,EAOT;IACC,MAAM,OAAO,GAA4C,EAAE,CAAA;IAC3D,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;QACnC,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,SAAS,CAAC,CAAA;QACtC,IAAI,IAAI,EAAE,MAAM,KAAK,GAAG,EAAE,CAAC;YACzB,OAAO,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;QACnC,CAAC;IACH,CAAC;IACD,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,SAAS,CAAA;IAClB,CAAC;IACD,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,MAAM,IAAI,KAAK,CACb,WAAW,GAAG,aAAa,OAAO,CAAC,MAAM,IAAI,IAAI,IAAI;YACnD,WAAW,WAAW,WAAW,CACpC,CAAA;IACH,CAAC;IACD,OAAO,OAAO,CAAC,CAAC,CAAC,CAAA;AACnB,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,EAClC,GAAG,EAGJ;IACC,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QAC3B,OAAO,GAAG,CAAA;IACZ,CAAC;IACD,MAAM,KAAK,GAAG,MAAM,eAAe,CAAC;QAClC,GAAG;QACH,IAAI,EAAE,MAAM;QACZ,WAAW,EAAE,UAAU;QACvB,UAAU,EAAE,MAAM,QAAQ,EAAE;QAC5B,QAAQ,EAAE,GAAG,CAAC,EAAE,CAAC,WAAW,CAAC,EAAE,GAAG,EAAE,CAAC;KACtC,CAAC,CAAA;IACF,OAAO,KAAK,EAAE,SAAS,CAAA;AACzB,CAAC;AAeD;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,EAAE,GAAG,EAAmB;IAQ3D,MAAM,UAAU,GAAG,MAAM,cAAc,CAAC,OAAO,CAAC,CAAA;IAChD,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;QACnC,MAAM,IAAI,GAAG,MAAM,kBAAkB,CAAa;YAChD,UAAU,EAAE,OAAO;YACnB,SAAS;SACV,CAAC,CAAA;QACF,IAAI,IAAI,CAAC,EAAE,KAAK,GAAG,EAAE,CAAC;YACpB,MAAM,IAAI,GAAG,MAAM,sBAAsB,CAAC;gBACxC,UAAU,EAAE,OAAO;gBACnB,SAAS;aACV,CAAC,CAAA;YACF,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,CAAA;QAClC,CAAC;IACH,CAAC;IACD,MAAM,KAAK,GAAG,MAAM,eAAe,CAAC;QAClC,GAAG;QACH,IAAI,EAAE,OAAO;QACb,WAAW,EAAE,eAAe;QAC5B,UAAU;QACV,QAAQ,EAAE,SAAS,CAAC,EAAE,CACpB,sBAAsB,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;KAC7D,CAAC,CAAA;IACF,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,SAAS,CAAA;IAClB,CAAC;IACD,MAAM,IAAI,GAAG,MAAM,kBAAkB,CAAa;QAChD,UAAU,EAAE,OAAO;QACnB,SAAS,EAAE,KAAK,CAAC,SAAS;KAC3B,CAAC,CAAA;IACF,OAAO,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,CAAA;AAC/D,CAAC;AAiBD;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAC,EAAE,GAAG,EAAmB;IAQjE,MAAM,UAAU,GAAG,MAAM,cAAc,CAAC,aAAa,CAAC,CAAA;IACtD,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;QACnC,MAAM,UAAU,GAAG,MAAM,kBAAkB,CAAmB;YAC5D,UAAU,EAAE,aAAa;YACzB,SAAS;SACV,CAAC,CAAA;QACF,IAAI,UAAU,CAAC,EAAE,KAAK,GAAG,EAAE,CAAC;YAC1B,MAAM,IAAI,GAAG,MAAM,sBAAsB,CAAC;gBACxC,UAAU,EAAE,aAAa;gBACzB,SAAS;aACV,CAAC,CAAA;YACF,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,IAAI,EAAE,CAAA;QACxC,CAAC;IACH,CAAC;IACD,IAAI,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QAC7B,MAAM,UAAU,GAAG,MAAM,kBAAkB,CAAmB;YAC5D,UAAU,EAAE,aAAa;YACzB,SAAS,EAAE,GAAG;SACf,CAAC,CAAA;QACF,MAAM,IAAI,GAAG,MAAM,sBAAsB,CAAC;YACxC,UAAU,EAAE,aAAa;YACzB,SAAS,EAAE,GAAG;SACf,CAAC,CAAA;QACF,OAAO,EAAE,SAAS,EAAE,GAAG,EAAE,UAAU,EAAE,IAAI,EAAE,CAAA;IAC7C,CAAC;IACD,MAAM,KAAK,GAAG,MAAM,eAAe,CAAC;QAClC,GAAG;QACH,IAAI,EAAE,aAAa;QACnB,WAAW,EAAE,eAAe;QAC5B,UAAU;QACV,QAAQ,EAAE,SAAS,CAAC,EAAE,CACpB,sBAAsB,CAAC,EAAE,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,CAAC;KACnE,CAAC,CAAA;IACF,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,SAAS,CAAA;IAClB,CAAC;IACD,MAAM,UAAU,GAAG,MAAM,kBAAkB,CAAmB;QAC5D,UAAU,EAAE,aAAa;QACzB,SAAS,EAAE,KAAK,CAAC,SAAS;KAC3B,CAAC,CAAA;IACF,OAAO,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS,EAAE,UAAU,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,CAAA;AACrE,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,EAAE,GAAG,EAAmB;IAQ1D,MAAM,aAAa,GAAG,MAAM,aAAa,CAAC,EAAE,WAAW,EAAE,GAAG,EAAE,CAAC,CAAA;IAC/D,IAAI,aAAa,EAAE,CAAC;QAClB,MAAM,IAAI,GAAG,MAAM,sBAAsB,CAAc;YACrD,UAAU,EAAE,MAAM;YAClB,SAAS,EAAE,aAAa,CAAC,SAAS;SACnC,CAAC,CAAA;QACF,OAAO,EAAE,GAAG,aAAa,EAAE,IAAI,EAAE,CAAA;IACnC,CAAC;IACD,MAAM,KAAK,GAAG,MAAM,eAAe,CAAC;QAClC,GAAG;QACH,IAAI,EAAE,MAAM;QACZ,WAAW,EAAE,gCAAgC;QAC7C,UAAU,EAAE,MAAM,cAAc,CAAC,MAAM,CAAC;QACxC,QAAQ,EAAE,SAAS,CAAC,EAAE,CACpB,sBAAsB,CAAc,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;KACzE,CAAC,CAAA;IACF,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,SAAS,CAAA;IAClB,CAAC;IACD,MAAM,GAAG,GAAG,MAAM,kBAAkB,CAAgB;QAClD,UAAU,EAAE,MAAM;QAClB,SAAS,EAAE,KAAK,CAAC,SAAS;KAC3B,CAAC,CAAA;IACF,OAAO,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,CAAA;AAC9D,CAAC"}

package/dist/storage.d.ts

@@ -28,6 +28,19 @@ export interface ItemMetadata {
 export interface KeyMetadata extends ItemMetadata {
     dids?: string[];
 }
+/**
+ * The shape of an exported key pair saved in a `<did>.keys.json` file (a DID
+ * signing key) or a wallet `keys/` collection item. Only `id` is always
+ * present: `controller`/`type` are absent from some exports, and the
+ * `publicKeyMultibase`/`secretKeyMultibase` pair is absent for a symmetric key.
+ */
+export interface StoredKeyPair {
+    id: string;
+    controller?: string;
+    type?: string;
+    publicKeyMultibase?: string;
+    secretKeyMultibase?: string;
+}
 /**
  * List the storage IDs of all items saved in a wallet collection.
  *
@@ -43,24 +56,41 @@ export declare function listCollection(collection: string): Promise<string[]>;
 /**
  * Load and JSON-parse a single item from a wallet collection.
  *
- * @param collection {string}
- * @param storageId {string}
+ * @param options {object}
+ * @param options.collection {string}
+ * @param options.storageId {string}
  * @returns {Promise<T>}
  */
-export declare function loadFromCollection<T = unknown>(collection: string, storageId: string): Promise<T>;
-export declare function saveToCollection(collection: string, storageId: string, data: object): Promise<string>;
+export declare function loadFromCollection<T = unknown>({ collection, storageId }: {
+    collection: string;
+    storageId: string;
+}): Promise<T>;
+/**
+ * JSON-serialize and save a single item into a wallet collection.
+ *
+ * @param options {object}
+ * @param options.collection {string}
+ * @param options.storageId {string}
+ * @param options.data {object}
+ * @returns {Promise<string>} the item file path.
+ */
+export declare function saveToCollection({ collection, storageId, data }: {
+    collection: string;
+    storageId: string;
+    data: object;
+}): Promise<string>;
 /**
  * Load the `.meta.json` metadata sidecar of a wallet collection item.
  *
  * @param options {object}
  * @param options.collection {string}
  * @param options.storageId {string}
- * @returns {Promise<KeyMetadata | undefined>} undefined when no sidecar exists.
+ * @returns {Promise<T | undefined>} undefined when no sidecar exists.
  */
-export declare function loadMetaFromCollection({ collection, storageId }: {
+export declare function loadMetaFromCollection<T extends ItemMetadata = ItemMetadata>({ collection, storageId }: {
     collection: string;
     storageId: string;
-}): Promise<KeyMetadata | undefined>;
+}): Promise<T | undefined>;
 /**
  * Save the `.meta.json` metadata sidecar of a wallet collection item.
  *
@@ -98,18 +128,23 @@ export declare function removeFromCollection({ collection, storageId }: {
  *
  * @param options {object}
  * @param options.fingerprint {string}
- * @returns {Promise<{storageId: string, key: object} | undefined>}
+ * @returns {Promise<{storageId: string, key: StoredKeyPair} | undefined>}
  */
 export declare function findStoredKey({ fingerprint }: {
     fingerprint: string;
 }): Promise<{
     storageId: string;
-    key: {
-        id?: string;
-        publicKeyMultibase?: string;
-        secretKeyMultibase?: string;
-    };
+    key: StoredKeyPair;
 } | undefined>;
+/**
+ * Extract the method name from a DID -- the segment between the first two
+ * colons (`did:web:example.com` -> `web`). Used to pick the per-method storage
+ * subdirectory and to label DIDs in listings.
+ *
+ * @param did {string}
+ * @returns {string}
+ */
+export declare function methodOf(did: string): string;
 /**
  * List the DIDs saved in local storage, across all method subdirectories.
  *
@@ -176,6 +211,23 @@ export declare function saveDidMeta({ did, meta }: {
 export declare function removeDidFiles({ did }: {
     did: string;
 }): Promise<string[]>;
+/**
+ * Report the on-disk file paths a DID's stored artifacts use -- the DID
+ * document, its keys file, its metadata sidecar, and (for did:webvh) the
+ * history log and update-keys sidecar -- whether or not each one currently
+ * exists. Non-destructive; used to surface where things live (e.g. `did meta`).
+ *
+ * @param options {object}
+ * @param options.did {string}
+ * @returns {Promise<{ label: string, path: string, exists: boolean }[]>}
+ */
+export declare function didStorageFiles({ did }: {
+    did: string;
+}): Promise<{
+    label: string;
+    path: string;
+    exists: boolean;
+}[]>;
 /**
  * Save a did:webvh history log as a raw newline-delimited JSON (`.jsonl`) file
  * alongside the DID document, under the method subdirectory.

package/dist/storage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":"AAYA;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAEpD;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,2DAA2D;IAC3D,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,sDAAsD;IACtD,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,oCAAoC;IACpC,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAY,SAAQ,YAAY;IAC/C,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;CAChB;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAe1E;AAED;;;;;;GAMG;AACH,wBAAsB,kBAAkB,CAAC,CAAC,GAAG,OAAO,EAClD,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,CAAC,CAAC,CAGZ;AAED,wBAAsB,gBAAgB,CACpC,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,MAAM,CAAC,CAMjB;AAED;;;;;;;GAOG;AACH,wBAAsB,sBAAsB,CAAC,EAC3C,UAAU,EACV,SAAS,EACV,EAAE;IACD,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;CAClB,GAAG,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC,CAUnC;AAED;;;;;;;;GAQG;AACH,wBAAsB,oBAAoB,CAAC,EACzC,UAAU,EACV,SAAS,EACT,IAAI,EACL,EAAE;IACD,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,WAAW,CAAA;CAClB,GAAG,OAAO,CAAC,MAAM,CAAC,CAMlB;AAoBD;;;;;;;;GAQG;AACH,wBAAsB,oBAAoB,CAAC,EACzC,UAAU,EACV,SAAS,EACV,EAAE;IACD,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;CAClB,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAWpB;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,aAAa,CAAC,EAClC,WAAW,EACZ,EAAE;IACD,WAAW,EAAE,MAAM,CAAA;CACpB,GAAG,OAAO,CACP;IACE,SAAS,EAAE,MAAM,CAAA;IACjB,GAAG,EAAE;QACH,EAAE,CAAC,EAAE,MAAM,CAAA;QACX,kBAAkB,CAAC,EAAE,MAAM,CAAA;QAC3B,kBAAkB,CAAC,EAAE,MAAM,CAAA;KAC5B,CAAA;CACF,GACD,SAAS,CACZ,CAaA;AAMD;;;;;;;;;;GAUG;AACH,wBAAsB,QAAQ,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CA8BlD;AAED;;;;;;;;GAQG;AACH,wBAAsB,eAAe,CAAC,CAAC,GAAG,OAAO,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAI1E;AAED;;;;;;;;GAQG;AACH,wBAAsB,WAAW,CAAC,CAAC,GAAG,OAAO,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAItE;AAED;;;;;;GAMG;AACH,wBAAsB,WAAW,CAAC,EAChC,GAAG,EACJ,EAAE;IACD,GAAG,EAAE,MAAM,CAAA;CACZ,GAAG,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC,CAWpC;AAED;;;;;;;GAOG;AACH,wBAAsB,WAAW,CAAC,EAChC,GAAG,EACH,IAAI,EACL,EAAE;IACD,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,YAAY,CAAA;CACnB,GAAG,OAAO,CAAC,MAAM,CAAC,CAGlB;AAED;;;;;;;;GAQG;AACH,wBAAsB,cAAc,CAAC,EACnC,GAAG,EACJ,EAAE;IACD,GAAG,EAAE,MAAM,CAAA;CACZ,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAoBpB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,UAAU,CAAC,EAC/B,GAAG,EACH,GAAG,EACJ,EAAE;IACD,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,MAAM,EAAE,CAAA;CACd,GAAG,OAAO,CAAC,MAAM,CAAC,CAQlB;AAED;;;;;;;;GAQG;AACH,wBAAsB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAI7D;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,kBAAkB,EAAE,MAAM,CAAA;IAC1B,kBAAkB,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,cAAc,CAAA;IACtB,MAAM,CAAC,EAAE,cAAc,GAAG;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,CAAA;IACjD,OAAO,CAAC,EAAE,cAAc,EAAE,CAAA;CAC3B;AAED;;;;;;;;GAQG;AACH,wBAAsB,iBAAiB,CAAC,EACtC,GAAG,EACH,UAAU,EACX,EAAE;IACD,GAAG,EAAE,MAAM,CAAA;IACX,UAAU,EAAE,eAAe,CAAA;CAC5B,GAAG,OAAO,CAAC,MAAM,CAAC,CAGlB;AAED;;;;;;GAMG;AACH,wBAAsB,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAI7E;AAED;;;;;;;GAOG;AACH,wBAAsB,UAAU,CAAC,EAC/B,MAAM,EACN,GAAG,EACH,MAAM,EACN,IAAI,EACL,EAAE;IACD,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;CACb,GAAG,OAAO,CAAC,MAAM,CAAC,CAOlB"}
+{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":"AAmBA;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAEpD;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,2DAA2D;IAC3D,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,sDAAsD;IACtD,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,oCAAoC;IACpC,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAY,SAAQ,YAAY;IAC/C,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;CAChB;AAED;;;;;GAKG;AACH,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAA;IACV,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,kBAAkB,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAe1E;AAED;;;;;;;GAOG;AACH,wBAAsB,kBAAkB,CAAC,CAAC,GAAG,OAAO,EAAE,EACpD,UAAU,EACV,SAAS,EACV,EAAE;IACD,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;CAClB,GAAG,OAAO,CAAC,CAAC,CAAC,CAGb;AAED;;;;;;;;GAQG;AACH,wBAAsB,gBAAgB,CAAC,EACrC,UAAU,EACV,SAAS,EACT,IAAI,EACL,EAAE;IACD,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,MAAM,CAAA;CACb,GAAG,OAAO,CAAC,MAAM,CAAC,CAMlB;AAED;;;;;;;GAOG;AACH,wBAAsB,sBAAsB,CAC1C,CAAC,SAAS,YAAY,GAAG,YAAY,EACrC,EACA,UAAU,EACV,SAAS,EACV,EAAE;IACD,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;CAClB,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,CAUzB;AAED;;;;;;;;GAQG;AACH,wBAAsB,oBAAoB,CAAC,EACzC,UAAU,EACV,SAAS,EACT,IAAI,EACL,EAAE;IACD,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,WAAW,CAAA;CAClB,GAAG,OAAO,CAAC,MAAM,CAAC,CAMlB;AAoBD;;;;;;;;GAQG;AACH,wBAAsB,oBAAoB,CAAC,EACzC,UAAU,EACV,SAAS,EACV,EAAE;IACD,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;CAClB,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAWpB;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,aAAa,CAAC,EAClC,WAAW,EACZ,EAAE;IACD,WAAW,EAAE,MAAM,CAAA;CACpB,GAAG,OAAO,CAAC;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,aAAa,CAAA;CAAE,GAAG,SAAS,CAAC,CAYjE;AAMD;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE5C;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,QAAQ,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CA8BlD;AAED;;;;;;;;GAQG;AACH,wBAAsB,eAAe,CAAC,CAAC,GAAG,OAAO,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAI1E;AAED;;;;;;;;GAQG;AACH,wBAAsB,WAAW,CAAC,CAAC,GAAG,OAAO,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAItE;AAED;;;;;;GAMG;AACH,wBAAsB,WAAW,CAAC,EAChC,GAAG,EACJ,EAAE;IACD,GAAG,EAAE,MAAM,CAAA;CACZ,GAAG,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC,CAWpC;AAED;;;;;;;GAOG;AACH,wBAAsB,WAAW,CAAC,EAChC,GAAG,EACH,IAAI,EACL,EAAE;IACD,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,YAAY,CAAA;CACnB,GAAG,OAAO,CAAC,MAAM,CAAC,CAGlB;AAED;;;;;;;;GAQG;AACH,wBAAsB,cAAc,CAAC,EACnC,GAAG,EACJ,EAAE;IACD,GAAG,EAAE,MAAM,CAAA;CACZ,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAoBpB;AAED;;;;;;;;;GASG;AACH,wBAAsB,eAAe,CAAC,EACpC,GAAG,EACJ,EAAE;IACD,GAAG,EAAE,MAAM,CAAA;CACZ,GAAG,OAAO,CAAC;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,OAAO,CAAA;CAAE,EAAE,CAAC,CAsB9D;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,UAAU,CAAC,EAC/B,GAAG,EACH,GAAG,EACJ,EAAE;IACD,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,MAAM,EAAE,CAAA;CACd,GAAG,OAAO,CAAC,MAAM,CAAC,CAQlB;AAED;;;;;;;;GAQG;AACH,wBAAsB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAI7D;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,kBAAkB,EAAE,MAAM,CAAA;IAC1B,kBAAkB,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,cAAc,CAAA;IACtB,MAAM,CAAC,EAAE,cAAc,GAAG;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,CAAA;IACjD,OAAO,CAAC,EAAE,cAAc,EAAE,CAAA;CAC3B;AAED;;;;;;;;GAQG;AACH,wBAAsB,iBAAiB,CAAC,EACtC,GAAG,EACH,UAAU,EACX,EAAE;IACD,GAAG,EAAE,MAAM,CAAA;IACX,UAAU,EAAE,eAAe,CAAA;CAC5B,GAAG,OAAO,CAAC,MAAM,CAAC,CAGlB;AAED;;;;;;GAMG;AACH,wBAAsB,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAI7E;AAED;;;;;;;GAOG;AACH,wBAAsB,UAAU,CAAC,EAC/B,MAAM,EACN,GAAG,EACH,MAAM,EACN,IAAI,EACL,EAAE;IACD,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;CACb,GAAG,OAAO,CAAC,MAAM,CAAC,CAOlB"}

package/dist/storage.js

@@ -1,4 +1,4 @@
-import { mkdir, readFile, readdir, unlink, writeFile } from 'node:fs/promises';
+import { mkdir, readFile, readdir, stat, unlink, writeFile } from 'node:fs/promises';
 import { homedir } from 'node:os';
 import { join } from 'node:path';
 function getWalletDir() {
@@ -50,15 +50,25 @@ export async function listCollection(collection) {
 /**
  * Load and JSON-parse a single item from a wallet collection.
  *
- * @param collection {string}
- * @param storageId {string}
+ * @param options {object}
+ * @param options.collection {string}
+ * @param options.storageId {string}
  * @returns {Promise<T>}
  */
-export async function loadFromCollection(collection, storageId) {
+export async function loadFromCollection({ collection, storageId }) {
     const filePath = join(getWalletDir(), collection, `${storageId}.json`);
     return JSON.parse(await readFile(filePath, 'utf8'));
 }
-export async function saveToCollection(collection, storageId, data) {
+/**
+ * JSON-serialize and save a single item into a wallet collection.
+ *
+ * @param options {object}
+ * @param options.collection {string}
+ * @param options.storageId {string}
+ * @param options.data {object}
+ * @returns {Promise<string>} the item file path.
+ */
+export async function saveToCollection({ collection, storageId, data }) {
     const dir = join(getWalletDir(), collection);
     await mkdir(dir, { recursive: true });
     const filePath = join(dir, `${storageId}.json`);
@@ -71,7 +81,7 @@ export async function saveToCollection(collection, storageId, data) {
  * @param options {object}
  * @param options.collection {string}
  * @param options.storageId {string}
- * @returns {Promise<KeyMetadata | undefined>} undefined when no sidecar exists.
+ * @returns {Promise<T | undefined>} undefined when no sidecar exists.
  */
 export async function loadMetaFromCollection({ collection, storageId }) {
     const filePath = join(getWalletDir(), collection, `${storageId}.meta.json`);
@@ -150,12 +160,15 @@ export async function removeFromCollection({ collection, storageId }) {
  *
  * @param options {object}
  * @param options.fingerprint {string}
- * @returns {Promise<{storageId: string, key: object} | undefined>}
+ * @returns {Promise<{storageId: string, key: StoredKeyPair} | undefined>}
  */
 export async function findStoredKey({ fingerprint }) {
     const storageIds = await listCollection('keys');
     for (const storageId of storageIds) {
-        const key = await loadFromCollection('keys', storageId);
+        const key = await loadFromCollection({
+            collection: 'keys',
+            storageId
+        });
         if (key.publicKeyMultibase === fingerprint || key.id === fingerprint) {
             return { storageId, key };
         }
@@ -165,6 +178,17 @@ export async function findStoredKey({ fingerprint }) {
 function getDidsDir() {
     return process.env.DIDS_DIR ?? join(getWalletDir(), 'dids');
 }
+/**
+ * Extract the method name from a DID -- the segment between the first two
+ * colons (`did:web:example.com` -> `web`). Used to pick the per-method storage
+ * subdirectory and to label DIDs in listings.
+ *
+ * @param did {string}
+ * @returns {string}
+ */
+export function methodOf(did) {
+    return did.split(':')[1];
+}
 /**
  * List the DIDs saved in local storage, across all method subdirectories.
  *
@@ -216,7 +240,7 @@ export async function listDids() {
  * @returns {Promise<T>}
  */
 export async function loadDidDocument(did) {
-    const method = did.split(':')[1];
+    const method = methodOf(did);
     const filePath = join(getDidsDir(), method, `${did}.json`);
     return JSON.parse(await readFile(filePath, 'utf8'));
 }
@@ -230,7 +254,7 @@ export async function loadDidDocument(did) {
  * @returns {Promise<T>}
  */
 export async function loadDidKeys(did) {
-    const method = did.split(':')[1];
+    const method = methodOf(did);
     const filePath = join(getDidsDir(), method, `${did}.keys.json`);
     return JSON.parse(await readFile(filePath, 'utf8'));
 }
@@ -242,7 +266,7 @@ export async function loadDidKeys(did) {
  * @returns {Promise<ItemMetadata | undefined>} undefined when no sidecar exists.
  */
 export async function loadDidMeta({ did }) {
-    const method = did.split(':')[1];
+    const method = methodOf(did);
     const filePath = join(getDidsDir(), method, `${did}.meta.json`);
     try {
         return JSON.parse(await readFile(filePath, 'utf8'));
@@ -263,7 +287,7 @@ export async function loadDidMeta({ did }) {
  * @returns {Promise<string>} the sidecar file path.
  */
 export async function saveDidMeta({ did, meta }) {
-    const method = did.split(':')[1];
+    const method = methodOf(did);
     return saveToDids({ method, did, suffix: 'meta', data: meta });
 }
 /**
@@ -276,7 +300,7 @@ export async function saveDidMeta({ did, meta }) {
  * @returns {Promise<string[]>} the file paths that were deleted.
  */
 export async function removeDidFiles({ did }) {
-    const method = did.split(':')[1];
+    const method = methodOf(did);
     const dir = join(getDidsDir(), method);
     const removed = [];
     const docPath = join(dir, `${did}.json`);
@@ -296,6 +320,40 @@ export async function removeDidFiles({ did }) {
     }
     return removed;
 }
+/**
+ * Report the on-disk file paths a DID's stored artifacts use -- the DID
+ * document, its keys file, its metadata sidecar, and (for did:webvh) the
+ * history log and update-keys sidecar -- whether or not each one currently
+ * exists. Non-destructive; used to surface where things live (e.g. `did meta`).
+ *
+ * @param options {object}
+ * @param options.did {string}
+ * @returns {Promise<{ label: string, path: string, exists: boolean }[]>}
+ */
+export async function didStorageFiles({ did }) {
+    const method = methodOf(did);
+    const dir = join(getDidsDir(), method);
+    const candidates = [
+        { label: 'document', path: join(dir, `${did}.json`) },
+        { label: 'keys', path: join(dir, `${did}.keys.json`) },
+        { label: 'metadata', path: join(dir, `${did}.meta.json`) },
+        // did:webvh-only artifacts; omitted from the listing when absent.
+        { label: 'log', path: join(dir, `${did}.jsonl`) },
+        { label: 'update-keys', path: join(dir, `${did}.update-keys.json`) }
+    ];
+    const files = [];
+    for (const candidate of candidates) {
+        let exists = true;
+        try {
+            await stat(candidate.path);
+        }
+        catch {
+            exists = false;
+        }
+        files.push({ ...candidate, exists });
+    }
+    return files;
+}
 /**
  * Save a did:webvh history log as a raw newline-delimited JSON (`.jsonl`) file
  * alongside the DID document, under the method subdirectory.
@@ -310,7 +368,7 @@ export async function removeDidFiles({ did }) {
  * @returns {Promise<string>} the log file path.
  */
 export async function saveDidLog({ did, log }) {
-    const method = did.split(':')[1];
+    const method = methodOf(did);
     const dir = join(getDidsDir(), method);
     await mkdir(dir, { recursive: true });
     const filePath = join(dir, `${did}.jsonl`);
@@ -328,7 +386,7 @@ export async function saveDidLog({ did, log }) {
  * @returns {Promise<string>}
  */
 export async function loadDidLog(did) {
-    const method = did.split(':')[1];
+    const method = methodOf(did);
     const filePath = join(getDidsDir(), method, `${did}.jsonl`);
     return readFile(filePath, 'utf8');
 }
@@ -342,7 +400,7 @@ export async function loadDidLog(did) {
  * @returns {Promise<string>} the sidecar file path.
  */
 export async function saveDidUpdateKeys({ did, updateKeys }) {
-    const method = did.split(':')[1];
+    const method = methodOf(did);
     return saveToDids({ method, did, suffix: 'update-keys', data: updateKeys });
 }
 /**
@@ -353,7 +411,7 @@ export async function saveDidUpdateKeys({ did, updateKeys }) {
  * @returns {Promise<WebvhUpdateKeys>}
  */
 export async function loadDidUpdateKeys(did) {
-    const method = did.split(':')[1];
+    const method = methodOf(did);
     const filePath = join(getDidsDir(), method, `${did}.update-keys.json`);
     return JSON.parse(await readFile(filePath, 'utf8'));
 }