@atproto/lex-data 0.0.6 → 0.0.7

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @atproto/lex-data
 
+## 0.0.7
+
+### Patch Changes
+
+- [#4512](https://github.com/bluesky-social/atproto/pull/4512) [`d78484f`](https://github.com/bluesky-social/atproto/commit/d78484f94d8ba1352ec66030115000d515c9dafe) Thanks [@matthieusieben](https://github.com/matthieusieben)! - **breaking**: replace `strict` options with `flavor` checking when parsing/decoding/validating `Cid` values
+
+- [#4512](https://github.com/bluesky-social/atproto/pull/4512) [`d78484f`](https://github.com/bluesky-social/atproto/commit/d78484f94d8ba1352ec66030115000d515c9dafe) Thanks [@matthieusieben](https://github.com/matthieusieben)! - Expose CID creation and validation utilities
+
+- [#4512](https://github.com/bluesky-social/atproto/pull/4512) [`d78484f`](https://github.com/bluesky-social/atproto/commit/d78484f94d8ba1352ec66030115000d515c9dafe) Thanks [@matthieusieben](https://github.com/matthieusieben)! - **breaking**: `asCid` now throws if the input cannot be cast into a `Cid`
+
 ## 0.0.6
 
 ### Patch Changes

package/dist/blob.d.ts

@@ -1,15 +1,15 @@
-import { Cid } from './cid.js';
+import { Cid, RawCid } from './cid.js';
 import { LexValue } from './lex.js';
 /**
  * @note {@link BlobRef} is just a {@link LexMap} with a specific shape.
  */
-export type BlobRef = {
+export type BlobRef<Ref extends Cid = Cid> = {
     $type: 'blob';
     mimeType: string;
-    ref: Cid;
+    ref: Ref;
     size: number;
 };
-export type BlobRefValidationOptions = {
+export type BlobRefCheckOptions = {
     /**
      * If `false`, skips strict CID validation of {@link BlobRef.ref}, allowing
      * any valid CID. Otherwise, validates that the CID is v1, uses the raw
@@ -19,7 +19,14 @@ export type BlobRefValidationOptions = {
      */
     strict?: boolean;
 };
-export declare function isBlobRef(input: unknown, options?: BlobRefValidationOptions): input is BlobRef;
+export type InferCheckedBlobRef<TOptions extends BlobRefCheckOptions> = TOptions extends {
+    strict: false;
+} ? BlobRef : {
+    strict: boolean;
+} extends TOptions ? BlobRef : BlobRef<RawCid>;
+export declare function isBlobRef(input: unknown): input is BlobRef<RawCid>;
+export declare function isBlobRef<TOptions extends BlobRefCheckOptions>(input: unknown, options: TOptions): input is InferCheckedBlobRef<TOptions>;
+export declare function isBlobRef(input: unknown, options?: BlobRefCheckOptions): input is BlobRef;
 /**
  * @note {@link LegacyBlobRef} is just a {@link LexMap} with a specific shape.
  */
@@ -28,21 +35,22 @@ export type LegacyBlobRef = {
     mimeType: string;
 };
 export declare function isLegacyBlobRef(input: unknown): input is LegacyBlobRef;
-export type EnumBlobRefsOptions = BlobRefValidationOptions & {
+export type EnumBlobRefsOptions = BlobRefCheckOptions & {
     /**
      * @defaults to `false`
      */
     allowLegacy?: boolean;
 };
+export type InferEnumBlobRefs<TOptions extends EnumBlobRefsOptions> = TOptions extends {
+    allowLegacy: true;
+} ? InferCheckedBlobRef<TOptions> | LegacyBlobRef : {
+    allowLegacy: boolean;
+} extends TOptions ? InferCheckedBlobRef<TOptions> | LegacyBlobRef : InferCheckedBlobRef<TOptions>;
 /**
  * Enumerates all {@link BlobRef}s (and, optionally, {@link LegacyBlobRef}s)
  * found within a {@link LexValue}.
  */
-export declare function enumBlobRefs(input: LexValue, options: EnumBlobRefsOptions & {
-    allowLegacy: true;
-}): Generator<BlobRef | LegacyBlobRef, void, unknown>;
-export declare function enumBlobRefs(input: LexValue, options?: EnumBlobRefsOptions & {
-    allowLegacy?: false;
-}): Generator<BlobRef, void, unknown>;
+export declare function enumBlobRefs(input: LexValue): Generator<BlobRef<RawCid>, void, unknown>;
+export declare function enumBlobRefs<TOptions extends EnumBlobRefsOptions>(input: LexValue, options: TOptions): Generator<InferEnumBlobRefs<TOptions>, void, unknown>;
 export declare function enumBlobRefs(input: LexValue, options?: EnumBlobRefsOptions): Generator<BlobRef | LegacyBlobRef, void, unknown>;
 //# sourceMappingURL=blob.d.ts.map

package/dist/blob.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"blob.d.ts","sourceRoot":"","sources":["../src/blob.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,GAAG,EAKJ,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AAGnC;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;IAChB,GAAG,EAAE,GAAG,CAAA;IACR,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,wBAAgB,SAAS,CACvB,KAAK,EAAE,OAAO,EACd,OAAO,CAAC,EAAE,wBAAwB,GACjC,KAAK,IAAI,OAAO,CAoDlB;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,wBAAgB,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,aAAa,CA2BtE;AAED,MAAM,MAAM,mBAAmB,GAAG,wBAAwB,GAAG;IAC3D;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;CACtB,CAAA;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAC1B,KAAK,EAAE,QAAQ,EACf,OAAO,EAAE,mBAAmB,GAAG;IAAE,WAAW,EAAE,IAAI,CAAA;CAAE,GACnD,SAAS,CAAC,OAAO,GAAG,aAAa,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;AACpD,wBAAgB,YAAY,CAC1B,KAAK,EAAE,QAAQ,EACf,OAAO,CAAC,EAAE,mBAAmB,GAAG;IAAE,WAAW,CAAC,EAAE,KAAK,CAAA;CAAE,GACtD,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;AACpC,wBAAgB,YAAY,CAC1B,KAAK,EAAE,QAAQ,EACf,OAAO,CAAC,EAAE,mBAAmB,GAC5B,SAAS,CAAC,OAAO,GAAG,aAAa,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA"}
+{"version":3,"file":"blob.d.ts","sourceRoot":"","sources":["../src/blob.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,EAA4B,MAAM,UAAU,CAAA;AAChE,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AAGnC;;GAEG;AACH,MAAM,MAAM,OAAO,CAAC,GAAG,SAAS,GAAG,GAAG,GAAG,IAAI;IAC3C,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;IAChB,GAAG,EAAE,GAAG,CAAA;IACR,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,mBAAmB,CAAC,QAAQ,SAAS,mBAAmB,IAClE,QAAQ,SAAS;IAAE,MAAM,EAAE,KAAK,CAAA;CAAE,GAC9B,OAAO,GACP;IAAE,MAAM,EAAE,OAAO,CAAA;CAAE,SAAS,QAAQ,GAClC,OAAO,GACP,OAAO,CAAC,MAAM,CAAC,CAAA;AAEvB,wBAAgB,SAAS,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,OAAO,CAAC,MAAM,CAAC,CAAA;AACnE,wBAAgB,SAAS,CAAC,QAAQ,SAAS,mBAAmB,EAC5D,KAAK,EAAE,OAAO,EACd,OAAO,EAAE,QAAQ,GAChB,KAAK,IAAI,mBAAmB,CAAC,QAAQ,CAAC,CAAA;AACzC,wBAAgB,SAAS,CACvB,KAAK,EAAE,OAAO,EACd,OAAO,CAAC,EAAE,mBAAmB,GAC5B,KAAK,IAAI,OAAO,CAAA;AAkDnB;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,wBAAgB,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,aAAa,CAyBtE;AAED,MAAM,MAAM,mBAAmB,GAAG,mBAAmB,GAAG;IACtD;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,iBAAiB,CAAC,QAAQ,SAAS,mBAAmB,IAChE,QAAQ,SAAS;IAAE,WAAW,EAAE,IAAI,CAAA;CAAE,GAClC,mBAAmB,CAAC,QAAQ,CAAC,GAAG,aAAa,GAC7C;IAAE,WAAW,EAAE,OAAO,CAAA;CAAE,SAAS,QAAQ,GACvC,mBAAmB,CAAC,QAAQ,CAAC,GAAG,aAAa,GAC7C,mBAAmB,CAAC,QAAQ,CAAC,CAAA;AAErC;;;GAGG;AACH,wBAAgB,YAAY,CAC1B,KAAK,EAAE,QAAQ,GACd,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;AAC5C,wBAAgB,YAAY,CAAC,QAAQ,SAAS,mBAAmB,EAC/D,KAAK,EAAE,QAAQ,EACf,OAAO,EAAE,QAAQ,GAChB,SAAS,CAAC,iBAAiB,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;AACxD,wBAAgB,YAAY,CAC1B,KAAK,EAAE,QAAQ,EACf,OAAO,CAAC,EAAE,mBAAmB,GAC5B,SAAS,CAAC,OAAO,GAAG,aAAa,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA"}

package/dist/blob.js

@@ -31,21 +31,12 @@ function isBlobRef(input, options) {
             return false;
         }
     }
-    const cid = (0, cid_js_1.asCid)(ref);
+    const cid = (0, cid_js_1.ifCid)(ref, 
+    // Strict unless explicitly disabled
+    options?.strict === false ? undefined : { flavor: 'raw' });
     if (!cid) {
         return false;
     }
-    if (options?.strict !== false) {
-        if (cid.version !== 1) {
-            return false;
-        }
-        if (cid.code !== cid_js_1.RAW_BIN_MULTICODEC) {
-            return false;
-        }
-        if (cid.multihash.code !== cid_js_1.SHA2_256_MULTIHASH_CODE) {
-            return false;
-        }
-    }
     return true;
 }
 function isLegacyBlobRef(input) {
@@ -64,15 +55,13 @@ function isLegacyBlobRef(input) {
             return false;
         }
     }
-    try {
-        (0, cid_js_1.parseCid)(cid);
-    }
-    catch {
+    if (!(0, cid_js_1.validateCidString)(cid)) {
         return false;
     }
     return true;
 }
 function* enumBlobRefs(input, options) {
+    // LegacyBlobRef not included by default
     const includeLegacy = options?.allowLegacy === true;
     // Using a stack to avoid recursion depth issues.
     const stack = [input];

package/dist/blob.js.map

@@ -1 +1 @@
-{"version":3,"file":"blob.js","sourceRoot":"","sources":["../src/blob.ts"],"names":[],"mappings":";;AA+BA,8BAuDC;AAUD,0CA2BC;AAyBD,oCAwCC;AA5LD,qCAMiB;AAEjB,2CAAyD;AAuBzD,SAAgB,SAAS,CACvB,KAAc,EACd,OAAkC;IAElC,IAAI,CAAC,IAAA,yBAAa,EAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,KAAK,EAAE,KAAK,KAAK,MAAM,EAAE,CAAC;QAC5B,OAAO,KAAK,CAAA;IACd,CAAC;IAED,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,KAAK,CAAA;IACrC,mCAAmC;IACnC,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QAC5D,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;QACxE,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;QAC5C,OAAO,KAAK,CAAA;IACd,CAAC;IAED,KAAK,MAAM,GAAG,IAAI,KAAK,EAAE,CAAC;QACxB,IACE,GAAG,KAAK,OAAO;YACf,GAAG,KAAK,UAAU;YAClB,GAAG,KAAK,KAAK;YACb,GAAG,KAAK,MAAM,EACd,CAAC;YACD,OAAO,KAAK,CAAA;QACd,CAAC;IACH,CAAC;IAED,MAAM,GAAG,GAAG,IAAA,cAAK,EAAC,GAAG,CAAC,CAAA;IACtB,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,OAAO,EAAE,MAAM,KAAK,KAAK,EAAE,CAAC;QAC9B,IAAI,GAAG,CAAC,OAAO,KAAK,CAAC,EAAE,CAAC;YACtB,OAAO,KAAK,CAAA;QACd,CAAC;QACD,IAAI,GAAG,CAAC,IAAI,KAAK,2BAAkB,EAAE,CAAC;YACpC,OAAO,KAAK,CAAA;QACd,CAAC;QACD,IAAI,GAAG,CAAC,SAAS,CAAC,IAAI,KAAK,gCAAuB,EAAE,CAAC;YACnD,OAAO,KAAK,CAAA;QACd,CAAC;IACH,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC;AAUD,SAAgB,eAAe,CAAC,KAAc;IAC5C,IAAI,CAAC,IAAA,yBAAa,EAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,KAAK,CAAA;IACd,CAAC;IAED,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,GAAG,KAAK,CAAA;IAC/B,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC5B,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1D,OAAO,KAAK,CAAA;IACd,CAAC;IAED,KAAK,MAAM,GAAG,IAAI,KAAK,EAAE,CAAC;QACxB,IAAI,GAAG,KAAK,KAAK,IAAI,GAAG,KAAK,UAAU,EAAE,CAAC;YACxC,OAAO,KAAK,CAAA;QACd,CAAC;IACH,CAAC;IAED,IAAI,CAAC;QACH,IAAA,iBAAQ,EAAC,GAAG,CAAC,CAAA;IACf,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAA;IACd,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC;AAyBD,QAAe,CAAC,CAAC,YAAY,CAC3B,KAAe,EACf,OAA6B;IAE7B,MAAM,aAAa,GAAG,OAAO,EAAE,WAAW,KAAK,IAAI,CAAA;IAEnD,iDAAiD;IACjD,MAAM,KAAK,GAAe,CAAC,KAAK,CAAC,CAAA;IAEjC,8EAA8E;IAC9E,0EAA0E;IAC1E,kCAAkC;IAClC,MAAM,OAAO,GAAG,IAAI,GAAG,EAAU,CAAA;IAEjC,GAAG,CAAC;QACF,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,EAAG,CAAA;QAE1B,IAAI,KAAK,IAAI,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC/C,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzB,IAAI,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC;oBAAE,SAAQ;gBAChC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;gBAClB,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAA;YACtB,CAAC;iBAAM,IAAI,IAAA,wBAAY,EAAC,KAAK,CAAC,EAAE,CAAC;gBAC/B,IAAI,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC;oBAAE,SAAQ;gBAChC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;gBAClB,IAAI,SAAS,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC;oBAC9B,MAAM,KAAK,CAAA;gBACb,CAAC;qBAAM,IAAI,aAAa,IAAI,eAAe,CAAC,KAAK,CAAC,EAAE,CAAC;oBACnD,MAAM,KAAK,CAAA;gBACb,CAAC;qBAAM,CAAC;oBACN,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;wBACrC,IAAI,CAAC,IAAI,IAAI;4BAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;oBAC9B,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC,QAAQ,KAAK,CAAC,MAAM,GAAG,CAAC,EAAC;IAE1B,+BAA+B;IAC/B,OAAO,CAAC,KAAK,EAAE,CAAA;AACjB,CAAC","sourcesContent":["import {\n  Cid,\n  RAW_BIN_MULTICODEC,\n  SHA2_256_MULTIHASH_CODE,\n  asCid,\n  parseCid,\n} from './cid.js'\nimport { LexValue } from './lex.js'\nimport { isPlainObject, isPlainProto } from './object.js'\n\n/**\n * @note {@link BlobRef} is just a {@link LexMap} with a specific shape.\n */\nexport type BlobRef = {\n  $type: 'blob'\n  mimeType: string\n  ref: Cid\n  size: number\n}\n\nexport type BlobRefValidationOptions = {\n  /**\n   * If `false`, skips strict CID validation of {@link BlobRef.ref}, allowing\n   * any valid CID. Otherwise, validates that the CID is v1, uses the raw\n   * multicodec, and has a sha256 multihash.\n   *\n   * @defaults to `true`\n   */\n  strict?: boolean\n}\n\nexport function isBlobRef(\n  input: unknown,\n  options?: BlobRefValidationOptions,\n): input is BlobRef {\n  if (!isPlainObject(input)) {\n    return false\n  }\n\n  if (input?.$type !== 'blob') {\n    return false\n  }\n\n  const { mimeType, size, ref } = input\n  // @NOTE Very basic mime validation\n  if (typeof mimeType !== 'string' || !mimeType.includes('/')) {\n    return false\n  }\n\n  if (typeof size !== 'number' || size < 0 || !Number.isSafeInteger(size)) {\n    return false\n  }\n\n  if (typeof ref !== 'object' || ref === null) {\n    return false\n  }\n\n  for (const key in input) {\n    if (\n      key !== '$type' &&\n      key !== 'mimeType' &&\n      key !== 'ref' &&\n      key !== 'size'\n    ) {\n      return false\n    }\n  }\n\n  const cid = asCid(ref)\n  if (!cid) {\n    return false\n  }\n\n  if (options?.strict !== false) {\n    if (cid.version !== 1) {\n      return false\n    }\n    if (cid.code !== RAW_BIN_MULTICODEC) {\n      return false\n    }\n    if (cid.multihash.code !== SHA2_256_MULTIHASH_CODE) {\n      return false\n    }\n  }\n\n  return true\n}\n\n/**\n * @note {@link LegacyBlobRef} is just a {@link LexMap} with a specific shape.\n */\nexport type LegacyBlobRef = {\n  cid: string\n  mimeType: string\n}\n\nexport function isLegacyBlobRef(input: unknown): input is LegacyBlobRef {\n  if (!isPlainObject(input)) {\n    return false\n  }\n\n  const { cid, mimeType } = input\n  if (typeof cid !== 'string') {\n    return false\n  }\n\n  if (typeof mimeType !== 'string' || mimeType.length === 0) {\n    return false\n  }\n\n  for (const key in input) {\n    if (key !== 'cid' && key !== 'mimeType') {\n      return false\n    }\n  }\n\n  try {\n    parseCid(cid)\n  } catch {\n    return false\n  }\n\n  return true\n}\n\nexport type EnumBlobRefsOptions = BlobRefValidationOptions & {\n  /**\n   * @defaults to `false`\n   */\n  allowLegacy?: boolean\n}\n\n/**\n * Enumerates all {@link BlobRef}s (and, optionally, {@link LegacyBlobRef}s)\n * found within a {@link LexValue}.\n */\nexport function enumBlobRefs(\n  input: LexValue,\n  options: EnumBlobRefsOptions & { allowLegacy: true },\n): Generator<BlobRef | LegacyBlobRef, void, unknown>\nexport function enumBlobRefs(\n  input: LexValue,\n  options?: EnumBlobRefsOptions & { allowLegacy?: false },\n): Generator<BlobRef, void, unknown>\nexport function enumBlobRefs(\n  input: LexValue,\n  options?: EnumBlobRefsOptions,\n): Generator<BlobRef | LegacyBlobRef, void, unknown>\nexport function* enumBlobRefs(\n  input: LexValue,\n  options?: EnumBlobRefsOptions,\n): Generator<BlobRef | LegacyBlobRef, void, unknown> {\n  const includeLegacy = options?.allowLegacy === true\n\n  // Using a stack to avoid recursion depth issues.\n  const stack: LexValue[] = [input]\n\n  // Since we are using a stack, we could end-up in an infinite loop with cyclic\n  // structures. Cyclic structures are not valid LexValues and should, thus,\n  // never occur, but let's be safe.\n  const visited = new Set<object>()\n\n  do {\n    const value = stack.pop()!\n\n    if (value != null && typeof value === 'object') {\n      if (Array.isArray(value)) {\n        if (visited.has(value)) continue\n        visited.add(value)\n        stack.push(...value)\n      } else if (isPlainProto(value)) {\n        if (visited.has(value)) continue\n        visited.add(value)\n        if (isBlobRef(value, options)) {\n          yield value\n        } else if (includeLegacy && isLegacyBlobRef(value)) {\n          yield value\n        } else {\n          for (const v of Object.values(value)) {\n            if (v != null) stack.push(v)\n          }\n        }\n      }\n    }\n  } while (stack.length > 0)\n\n  // Optimization: ease GC's work\n  visited.clear()\n}\n"]}
+{"version":3,"file":"blob.js","sourceRoot":"","sources":["../src/blob.ts"],"names":[],"mappings":";;AAyCA,8BA+CC;AAUD,0CAyBC;AA+BD,oCAyCC;AAnMD,qCAAgE;AAEhE,2CAAyD;AAuCzD,SAAgB,SAAS,CACvB,KAAc,EACd,OAA6B;IAE7B,IAAI,CAAC,IAAA,yBAAa,EAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,KAAK,EAAE,KAAK,KAAK,MAAM,EAAE,CAAC;QAC5B,OAAO,KAAK,CAAA;IACd,CAAC;IAED,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,KAAK,CAAA;IACrC,mCAAmC;IACnC,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QAC5D,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;QACxE,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;QAC5C,OAAO,KAAK,CAAA;IACd,CAAC;IAED,KAAK,MAAM,GAAG,IAAI,KAAK,EAAE,CAAC;QACxB,IACE,GAAG,KAAK,OAAO;YACf,GAAG,KAAK,UAAU;YAClB,GAAG,KAAK,KAAK;YACb,GAAG,KAAK,MAAM,EACd,CAAC;YACD,OAAO,KAAK,CAAA;QACd,CAAC;IACH,CAAC;IAED,MAAM,GAAG,GAAG,IAAA,cAAK,EACf,GAAG;IACH,oCAAoC;IACpC,OAAO,EAAE,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAC1D,CAAA;IACD,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,OAAO,KAAK,CAAA;IACd,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC;AAUD,SAAgB,eAAe,CAAC,KAAc;IAC5C,IAAI,CAAC,IAAA,yBAAa,EAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,KAAK,CAAA;IACd,CAAC;IAED,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,GAAG,KAAK,CAAA;IAC/B,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC5B,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1D,OAAO,KAAK,CAAA;IACd,CAAC;IAED,KAAK,MAAM,GAAG,IAAI,KAAK,EAAE,CAAC;QACxB,IAAI,GAAG,KAAK,KAAK,IAAI,GAAG,KAAK,UAAU,EAAE,CAAC;YACxC,OAAO,KAAK,CAAA;QACd,CAAC;IACH,CAAC;IAED,IAAI,CAAC,IAAA,0BAAiB,EAAC,GAAG,CAAC,EAAE,CAAC;QAC5B,OAAO,KAAK,CAAA;IACd,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC;AA+BD,QAAe,CAAC,CAAC,YAAY,CAC3B,KAAe,EACf,OAA6B;IAE7B,wCAAwC;IACxC,MAAM,aAAa,GAAG,OAAO,EAAE,WAAW,KAAK,IAAI,CAAA;IAEnD,iDAAiD;IACjD,MAAM,KAAK,GAAe,CAAC,KAAK,CAAC,CAAA;IAEjC,8EAA8E;IAC9E,0EAA0E;IAC1E,kCAAkC;IAClC,MAAM,OAAO,GAAG,IAAI,GAAG,EAAU,CAAA;IAEjC,GAAG,CAAC;QACF,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,EAAG,CAAA;QAE1B,IAAI,KAAK,IAAI,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC/C,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzB,IAAI,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC;oBAAE,SAAQ;gBAChC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;gBAClB,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAA;YACtB,CAAC;iBAAM,IAAI,IAAA,wBAAY,EAAC,KAAK,CAAC,EAAE,CAAC;gBAC/B,IAAI,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC;oBAAE,SAAQ;gBAChC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;gBAClB,IAAI,SAAS,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC;oBAC9B,MAAM,KAAK,CAAA;gBACb,CAAC;qBAAM,IAAI,aAAa,IAAI,eAAe,CAAC,KAAK,CAAC,EAAE,CAAC;oBACnD,MAAM,KAAK,CAAA;gBACb,CAAC;qBAAM,CAAC;oBACN,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;wBACrC,IAAI,CAAC,IAAI,IAAI;4BAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;oBAC9B,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC,QAAQ,KAAK,CAAC,MAAM,GAAG,CAAC,EAAC;IAE1B,+BAA+B;IAC/B,OAAO,CAAC,KAAK,EAAE,CAAA;AACjB,CAAC","sourcesContent":["import { Cid, RawCid, ifCid, validateCidString } from './cid.js'\nimport { LexValue } from './lex.js'\nimport { isPlainObject, isPlainProto } from './object.js'\n\n/**\n * @note {@link BlobRef} is just a {@link LexMap} with a specific shape.\n */\nexport type BlobRef<Ref extends Cid = Cid> = {\n  $type: 'blob'\n  mimeType: string\n  ref: Ref\n  size: number\n}\n\nexport type BlobRefCheckOptions = {\n  /**\n   * If `false`, skips strict CID validation of {@link BlobRef.ref}, allowing\n   * any valid CID. Otherwise, validates that the CID is v1, uses the raw\n   * multicodec, and has a sha256 multihash.\n   *\n   * @defaults to `true`\n   */\n  strict?: boolean\n}\n\nexport type InferCheckedBlobRef<TOptions extends BlobRefCheckOptions> =\n  TOptions extends { strict: false }\n    ? BlobRef\n    : { strict: boolean } extends TOptions\n      ? BlobRef\n      : BlobRef<RawCid>\n\nexport function isBlobRef(input: unknown): input is BlobRef<RawCid>\nexport function isBlobRef<TOptions extends BlobRefCheckOptions>(\n  input: unknown,\n  options: TOptions,\n): input is InferCheckedBlobRef<TOptions>\nexport function isBlobRef(\n  input: unknown,\n  options?: BlobRefCheckOptions,\n): input is BlobRef\nexport function isBlobRef(\n  input: unknown,\n  options?: BlobRefCheckOptions,\n): input is BlobRef {\n  if (!isPlainObject(input)) {\n    return false\n  }\n\n  if (input?.$type !== 'blob') {\n    return false\n  }\n\n  const { mimeType, size, ref } = input\n  // @NOTE Very basic mime validation\n  if (typeof mimeType !== 'string' || !mimeType.includes('/')) {\n    return false\n  }\n\n  if (typeof size !== 'number' || size < 0 || !Number.isSafeInteger(size)) {\n    return false\n  }\n\n  if (typeof ref !== 'object' || ref === null) {\n    return false\n  }\n\n  for (const key in input) {\n    if (\n      key !== '$type' &&\n      key !== 'mimeType' &&\n      key !== 'ref' &&\n      key !== 'size'\n    ) {\n      return false\n    }\n  }\n\n  const cid = ifCid(\n    ref,\n    // Strict unless explicitly disabled\n    options?.strict === false ? undefined : { flavor: 'raw' },\n  )\n  if (!cid) {\n    return false\n  }\n\n  return true\n}\n\n/**\n * @note {@link LegacyBlobRef} is just a {@link LexMap} with a specific shape.\n */\nexport type LegacyBlobRef = {\n  cid: string\n  mimeType: string\n}\n\nexport function isLegacyBlobRef(input: unknown): input is LegacyBlobRef {\n  if (!isPlainObject(input)) {\n    return false\n  }\n\n  const { cid, mimeType } = input\n  if (typeof cid !== 'string') {\n    return false\n  }\n\n  if (typeof mimeType !== 'string' || mimeType.length === 0) {\n    return false\n  }\n\n  for (const key in input) {\n    if (key !== 'cid' && key !== 'mimeType') {\n      return false\n    }\n  }\n\n  if (!validateCidString(cid)) {\n    return false\n  }\n\n  return true\n}\n\nexport type EnumBlobRefsOptions = BlobRefCheckOptions & {\n  /**\n   * @defaults to `false`\n   */\n  allowLegacy?: boolean\n}\n\nexport type InferEnumBlobRefs<TOptions extends EnumBlobRefsOptions> =\n  TOptions extends { allowLegacy: true }\n    ? InferCheckedBlobRef<TOptions> | LegacyBlobRef\n    : { allowLegacy: boolean } extends TOptions\n      ? InferCheckedBlobRef<TOptions> | LegacyBlobRef\n      : InferCheckedBlobRef<TOptions>\n\n/**\n * Enumerates all {@link BlobRef}s (and, optionally, {@link LegacyBlobRef}s)\n * found within a {@link LexValue}.\n */\nexport function enumBlobRefs(\n  input: LexValue,\n): Generator<BlobRef<RawCid>, void, unknown>\nexport function enumBlobRefs<TOptions extends EnumBlobRefsOptions>(\n  input: LexValue,\n  options: TOptions,\n): Generator<InferEnumBlobRefs<TOptions>, void, unknown>\nexport function enumBlobRefs(\n  input: LexValue,\n  options?: EnumBlobRefsOptions,\n): Generator<BlobRef | LegacyBlobRef, void, unknown>\nexport function* enumBlobRefs(\n  input: LexValue,\n  options?: EnumBlobRefsOptions,\n): Generator<BlobRef | LegacyBlobRef, void, unknown> {\n  // LegacyBlobRef not included by default\n  const includeLegacy = options?.allowLegacy === true\n\n  // Using a stack to avoid recursion depth issues.\n  const stack: LexValue[] = [input]\n\n  // Since we are using a stack, we could end-up in an infinite loop with cyclic\n  // structures. Cyclic structures are not valid LexValues and should, thus,\n  // never occur, but let's be safe.\n  const visited = new Set<object>()\n\n  do {\n    const value = stack.pop()!\n\n    if (value != null && typeof value === 'object') {\n      if (Array.isArray(value)) {\n        if (visited.has(value)) continue\n        visited.add(value)\n        stack.push(...value)\n      } else if (isPlainProto(value)) {\n        if (visited.has(value)) continue\n        visited.add(value)\n        if (isBlobRef(value, options)) {\n          yield value\n        } else if (includeLegacy && isLegacyBlobRef(value)) {\n          yield value\n        } else {\n          for (const v of Object.values(value)) {\n            if (v != null) stack.push(v)\n          }\n        }\n      }\n    }\n  } while (stack.length > 0)\n\n  // Optimization: ease GC's work\n  visited.clear()\n}\n"]}

package/dist/cid.d.ts

@@ -1,7 +1,10 @@
 import { CID } from 'multiformats/cid';
 export declare const DAG_CBOR_MULTICODEC = 113;
-export declare const RAW_BIN_MULTICODEC = 85;
-export declare const SHA2_256_MULTIHASH_CODE = 18;
+export type DAG_CBOR_MULTICODEC = typeof DAG_CBOR_MULTICODEC;
+export declare const RAW_MULTICODEC = 85;
+export type RAW_MULTICODEC = typeof RAW_MULTICODEC;
+export declare const SHA256_MULTIHASH: 18;
+export type SHA256_MULTIHASH = typeof SHA256_MULTIHASH;
 export type MultihashDigest<Code extends number = number> = {
     code: Code;
     digest: Uint8Array;
@@ -11,8 +14,8 @@ export type MultihashDigest<Code extends number = number> = {
 declare module 'multiformats/cid' {
     /**
      * @deprecated use the {@link Cid} interface from `@atproto/lex-data`, and
-     * related helpers ({@link asCid}, {@link parseCid}, {@link decodeCid},
-     * {@link createCid}, {@link isCid}), instead.
+     * related helpers ({@link isCid}, {@link ifCid}, {@link asCid},
+     * {@link parseCid}, {@link decodeCid}), instead.
      *
      * This is marked as deprecated because we want to discourage direct usage of
      * `multiformats/cid` in dependent packages, and instead have them rely on the
@@ -44,14 +47,80 @@ export interface Cid {
     equals(other: unknown): boolean;
     toString(): string;
 }
-export declare function asCid(value: unknown): Cid | null;
-export declare function parseCid(input: string): Cid;
-export declare function decodeCid(bytes: Uint8Array): Cid;
-export declare function createCid(code: number, digest: MultihashDigest): Cid;
-export declare function isCid(value: unknown, options?: {
-    strict?: boolean;
-}): value is Cid;
-export declare function validateCidString(input: string): boolean;
-export declare function parseCidString(input: string): Cid | undefined;
-export declare function ensureValidCidString(input: string): void;
+/**
+ * Represents the cid of raw binary data (like media blobs).
+ * @see {@link https://atproto.com/specs/data-model#link-and-cid-formats ATproto Data Model - Link and CID Formats}
+ */
+export interface RawCid extends Cid {
+    version: 1;
+    code: RAW_MULTICODEC;
+}
+export declare function isRawCid(cid: Cid): cid is RawCid;
+/**
+ * Represents a DASL compliant CID.
+ * @see {@link https://dasl.ing/cid.html DASL-CIDs}
+ */
+export interface DaslCid extends Cid {
+    version: 1;
+    code: RAW_MULTICODEC | DAG_CBOR_MULTICODEC;
+    multihash: MultihashDigest<SHA256_MULTIHASH>;
+}
+export declare function isDaslCid(cid: Cid): cid is DaslCid;
+/**
+ * Represents the cid of ATProto DAG-CBOR data (like repository MST nodes).
+ * @see {@link https://atproto.com/specs/data-model#link-and-cid-formats ATproto Data Model - Link and CID Formats}
+ */
+export interface CborCid extends DaslCid {
+    code: DAG_CBOR_MULTICODEC;
+}
+export declare function isCborCid(cid: Cid): cid is CborCid;
+export type CidCheckOptions = {
+    flavor?: 'raw' | 'cbor' | 'dasl';
+};
+export type InferCheckedCid<TOptions> = TOptions extends {
+    flavor: 'raw';
+} ? RawCid : TOptions extends {
+    flavor: 'cbor';
+} ? CborCid : Cid;
+/**
+ * Coerces the input value to a Cid, or returns null if not possible.
+ */
+export declare function ifCid<TOptions extends CidCheckOptions>(value: unknown, options: TOptions): InferCheckedCid<TOptions> | null;
+export declare function ifCid(value: unknown, options?: CidCheckOptions): Cid | null;
+export declare function isCid<TOptions extends CidCheckOptions>(value: unknown, options: TOptions): value is InferCheckedCid<TOptions>;
+export declare function isCid(value: unknown, options?: CidCheckOptions): value is Cid;
+/**
+ * Coerces the input value to a Cid, or throws if not possible.
+ */
+export declare function asCid<TOptions extends CidCheckOptions>(value: unknown, options: TOptions): InferCheckedCid<TOptions>;
+export declare function asCid(value: unknown, options?: CidCheckOptions): Cid;
+/**
+ * Parses a CID string into a Cid object.
+ *
+ * @throws if the input is not a valid CID string.
+ */
+export declare function parseCid<TOptions extends CidCheckOptions>(input: string, options: TOptions): InferCheckedCid<TOptions>;
+export declare function parseCid(input: string, options?: CidCheckOptions): Cid;
+/**
+ * Decodes a CID from its binary representation.
+ *
+ * @see {@link https://dasl.ing/cid.html DASL-CIDs}
+ * @throws if the input do not represent a valid DASL {@link Cid}
+ */
+export declare function decodeCid<TOptions extends CidCheckOptions>(cidBytes: Uint8Array, options: TOptions): InferCheckedCid<TOptions>;
+export declare function decodeCid(cidBytes: Uint8Array, options?: CidCheckOptions): Cid;
+export declare function validateCidString(input: string, options?: CidCheckOptions): boolean;
+export declare function parseCidString<TOptions extends CidCheckOptions>(input: string, options: TOptions): InferCheckedCid<TOptions> | undefined;
+export declare function parseCidString(input: string, options?: CidCheckOptions): Cid | undefined;
+export declare function ensureValidCidString(input: string, options?: CidCheckOptions): void;
+/**
+ * Verifies whether the multihash of a given {@link cid} matches the hash of the provided {@link bytes}.
+ * @params cid The CID to match against the bytes.
+ * @params bytes The bytes to verify.
+ * @returns true if the CID matches the bytes, false otherwise.
+ */
+export declare function isCidForBytes(cid: Cid, bytes: Uint8Array): Promise<boolean>;
+export declare function cidForCbor(bytes: Uint8Array): Promise<CborCid>;
+export declare function cidForRawBytes(bytes: Uint8Array): Promise<RawCid>;
+export declare function cidForRawHash(hash: Uint8Array): RawCid;
 //# sourceMappingURL=cid.d.ts.map

package/dist/cid.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cid.d.ts","sourceRoot":"","sources":["../src/cid.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAEtC,eAAO,MAAM,mBAAmB,MAAO,CAAA;AACvC,eAAO,MAAM,kBAAkB,KAAO,CAAA;AAEtC,eAAO,MAAM,uBAAuB,KAAO,CAAA;AAE3C,MAAM,MAAM,eAAe,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,IAAI;IAC1D,IAAI,EAAE,IAAI,CAAA;IACV,MAAM,EAAE,UAAU,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,UAAU,CAAA;CAClB,CAAA;AAED,OAAO,QAAQ,kBAAkB,CAAC;IAChC;;;;;;;;;;;;;;;;;;OAkBG;IACH,UAAU,GAAG;KAAG;CACjB;AAqBD,OAAO,EAAE,GAAG,EAAE,CAAA;AAEd;;;GAGG;AACH,MAAM,WAAW,GAAG;IAClB,OAAO,EAAE,CAAC,GAAG,CAAC,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,eAAe,CAAA;IAC1B,KAAK,EAAE,UAAU,CAAA;IACjB,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAA;IAC/B,QAAQ,IAAI,MAAM,CAAA;CACnB;AAED,wBAAgB,KAAK,CAAC,KAAK,EAAE,OAAO,GAAG,GAAG,GAAG,IAAI,CAEhD;AAED,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAE3C;AAED,wBAAgB,SAAS,CAAC,KAAK,EAAE,UAAU,GAAG,GAAG,CAEhD;AAED,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,eAAe,GAAG,GAAG,CAEpE;AAED,wBAAgB,KAAK,CACnB,KAAK,EAAE,OAAO,EACd,OAAO,CAAC,EAAE;IAAE,MAAM,CAAC,EAAE,OAAO,CAAA;CAAE,GAC7B,KAAK,IAAI,GAAG,CAmBd;AAED,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAExD;AAED,wBAAgB,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,GAAG,SAAS,CAM7D;AAED,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAIxD"}
+{"version":3,"file":"cid.d.ts","sourceRoot":"","sources":["../src/cid.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAOtC,eAAO,MAAM,mBAAmB,MAAO,CAAA;AACvC,MAAM,MAAM,mBAAmB,GAAG,OAAO,mBAAmB,CAAA;AAE5D,eAAO,MAAM,cAAc,KAAO,CAAA;AAClC,MAAM,MAAM,cAAc,GAAG,OAAO,cAAc,CAAA;AAElD,eAAO,MAAM,gBAAgB,IAAc,CAAA;AAC3C,MAAM,MAAM,gBAAgB,GAAG,OAAO,gBAAgB,CAAA;AAEtD,MAAM,MAAM,eAAe,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,IAAI;IAC1D,IAAI,EAAE,IAAI,CAAA;IACV,MAAM,EAAE,UAAU,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,UAAU,CAAA;CAClB,CAAA;AAED,OAAO,QAAQ,kBAAkB,CAAC;IAChC;;;;;;;;;;;;;;;;;;OAkBG;IACH,UAAU,GAAG;KAAG;CACjB;AAqBD,OAAO,EAAE,GAAG,EAAE,CAAA;AAEd;;;GAGG;AACH,MAAM,WAAW,GAAG;IAClB,OAAO,EAAE,CAAC,GAAG,CAAC,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,eAAe,CAAA;IAC1B,KAAK,EAAE,UAAU,CAAA;IACjB,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAA;IAC/B,QAAQ,IAAI,MAAM,CAAA;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,MAAO,SAAQ,GAAG;IACjC,OAAO,EAAE,CAAC,CAAA;IACV,IAAI,EAAE,cAAc,CAAA;CACrB;AAED,wBAAgB,QAAQ,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,MAAM,CAEhD;AAED;;;GAGG;AACH,MAAM,WAAW,OAAQ,SAAQ,GAAG;IAClC,OAAO,EAAE,CAAC,CAAA;IACV,IAAI,EAAE,cAAc,GAAG,mBAAmB,CAAA;IAC1C,SAAS,EAAE,eAAe,CAAC,gBAAgB,CAAC,CAAA;CAC7C;AAED,wBAAgB,SAAS,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,OAAO,CAOlD;AAED;;;GAGG;AACH,MAAM,WAAW,OAAQ,SAAQ,OAAO;IACtC,IAAI,EAAE,mBAAmB,CAAA;CAC1B;AAED,wBAAgB,SAAS,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,OAAO,CAElD;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,CAAA;CACjC,CAAA;AACD,MAAM,MAAM,eAAe,CAAC,QAAQ,IAAI,QAAQ,SAAS;IAAE,MAAM,EAAE,KAAK,CAAA;CAAE,GACtE,MAAM,GACN,QAAQ,SAAS;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,GACjC,OAAO,GACP,GAAG,CAAA;AAET;;GAEG;AACH,wBAAgB,KAAK,CAAC,QAAQ,SAAS,eAAe,EACpD,KAAK,EAAE,OAAO,EACd,OAAO,EAAE,QAAQ,GAChB,eAAe,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAA;AACnC,wBAAgB,KAAK,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,GAAG,GAAG,IAAI,CAAA;AAmB5E,wBAAgB,KAAK,CAAC,QAAQ,SAAS,eAAe,EACpD,KAAK,EAAE,OAAO,EACd,OAAO,EAAE,QAAQ,GAChB,KAAK,IAAI,eAAe,CAAC,QAAQ,CAAC,CAAA;AACrC,wBAAgB,KAAK,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,KAAK,IAAI,GAAG,CAAA;AAK9E;;GAEG;AACH,wBAAgB,KAAK,CAAC,QAAQ,SAAS,eAAe,EACpD,KAAK,EAAE,OAAO,EACd,OAAO,EAAE,QAAQ,GAChB,eAAe,CAAC,QAAQ,CAAC,CAAA;AAC5B,wBAAgB,KAAK,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,GAAG,CAAA;AAOrE;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,QAAQ,SAAS,eAAe,EACvD,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,QAAQ,GAChB,eAAe,CAAC,QAAQ,CAAC,CAAA;AAC5B,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,GAAG,CAAA;AAMvE;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,QAAQ,SAAS,eAAe,EACxD,QAAQ,EAAE,UAAU,EACpB,OAAO,EAAE,QAAQ,GAChB,eAAe,CAAC,QAAQ,CAAC,CAAA;AAC5B,wBAAgB,SAAS,CAAC,QAAQ,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,GAAG,CAAA;AAS/E,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAET;AAED,wBAAgB,cAAc,CAAC,QAAQ,SAAS,eAAe,EAC7D,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,QAAQ,GAChB,eAAe,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAA;AACxC,wBAAgB,cAAc,CAC5B,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,eAAe,GACxB,GAAG,GAAG,SAAS,CAAA;AAYlB,wBAAgB,oBAAoB,CAClC,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,eAAe,GACxB,IAAI,CAIN;AAED;;;;;GAKG;AACH,wBAAsB,aAAa,CACjC,GAAG,EAAE,GAAG,EACR,KAAK,EAAE,UAAU,GAChB,OAAO,CAAC,OAAO,CAAC,CAalB;AAED,wBAAsB,UAAU,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,CAGpE;AAED,wBAAsB,cAAc,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,CAGvE;AAED,wBAAgB,aAAa,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,CAOtD"}

package/dist/cid.js

@@ -1,63 +1,122 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CID = exports.SHA2_256_MULTIHASH_CODE = exports.RAW_BIN_MULTICODEC = exports.DAG_CBOR_MULTICODEC = void 0;
+exports.CID = exports.SHA256_MULTIHASH = exports.RAW_MULTICODEC = exports.DAG_CBOR_MULTICODEC = void 0;
+exports.isRawCid = isRawCid;
+exports.isDaslCid = isDaslCid;
+exports.isCborCid = isCborCid;
+exports.ifCid = ifCid;
+exports.isCid = isCid;
 exports.asCid = asCid;
 exports.parseCid = parseCid;
 exports.decodeCid = decodeCid;
-exports.createCid = createCid;
-exports.isCid = isCid;
 exports.validateCidString = validateCidString;
 exports.parseCidString = parseCidString;
 exports.ensureValidCidString = ensureValidCidString;
+exports.isCidForBytes = isCidForBytes;
+exports.cidForCbor = cidForCbor;
+exports.cidForRawBytes = cidForRawBytes;
+exports.cidForRawHash = cidForRawHash;
 const cid_1 = require("multiformats/cid");
 Object.defineProperty(exports, "CID", { enumerable: true, get: function () { return cid_1.CID; } });
-exports.DAG_CBOR_MULTICODEC = 0x71;
-exports.RAW_BIN_MULTICODEC = 0x55;
-exports.SHA2_256_MULTIHASH_CODE = 0x12;
-function asCid(value) {
-    return cid_1.CID.asCID(value);
+const digest_1 = require("multiformats/hashes/digest");
+const sha2_1 = require("multiformats/hashes/sha2");
+exports.DAG_CBOR_MULTICODEC = 0x71; // DRISL conformant DAG-CBOR
+exports.RAW_MULTICODEC = 0x55; // raw binary codec used in DASL CIDs
+exports.SHA256_MULTIHASH = sha2_1.sha256.code;
+function isRawCid(cid) {
+    return cid.version === 1 && cid.code === exports.RAW_MULTICODEC;
 }
-function parseCid(input) {
-    return cid_1.CID.parse(input);
+function isDaslCid(cid) {
+    return (cid.version === 1 &&
+        (cid.code === exports.RAW_MULTICODEC || cid.code === exports.DAG_CBOR_MULTICODEC) &&
+        cid.multihash.code === exports.SHA256_MULTIHASH &&
+        cid.multihash.size === 32 // Should always be 32 bytes (256 bits) for SHA-256
+    );
 }
-function decodeCid(bytes) {
-    return cid_1.CID.decode(bytes);
+function isCborCid(cid) {
+    return cid.code === exports.DAG_CBOR_MULTICODEC && isDaslCid(cid);
 }
-function createCid(code, digest) {
-    return cid_1.CID.createV1(code, digest);
-}
-function isCid(value, options) {
-    const cid = asCid(value);
+function ifCid(value, options) {
+    const cid = cid_1.CID.asCID(value);
     if (!cid) {
-        return false;
+        return null;
     }
-    if (options?.strict) {
-        if (cid.version !== 1) {
-            return false;
-        }
-        if (cid.code !== exports.RAW_BIN_MULTICODEC && cid.code !== exports.DAG_CBOR_MULTICODEC) {
-            return false;
-        }
-        if (cid.multihash.code !== exports.SHA2_256_MULTIHASH_CODE) {
-            return false;
-        }
+    switch (options?.flavor) {
+        case 'cbor':
+            return isCborCid(cid) ? cid : null;
+        case 'raw':
+            return isRawCid(cid) ? cid : null;
+        case 'dasl':
+            return isDaslCid(cid) ? cid : null;
+        default:
+            return cid;
     }
-    return true;
 }
-function validateCidString(input) {
-    return parseCidString(input)?.toString() === input;
+function isCid(value, options) {
+    return ifCid(value, options) !== null;
+}
+function asCid(value, options) {
+    const cid = ifCid(value, options);
+    if (cid)
+        return cid;
+    throw new Error('Not a valid CID');
+}
+function parseCid(input, options) {
+    const cid = cid_1.CID.parse(input);
+    return asCid(cid, options);
+}
+function decodeCid(cidBytes, options) {
+    const cid = cid_1.CID.decode(cidBytes);
+    return asCid(cid, options);
 }
-function parseCidString(input) {
+function validateCidString(input, options) {
+    return parseCidString(input, options)?.toString() === input;
+}
+function parseCidString(input, options) {
     try {
-        return parseCid(input);
+        return parseCid(input, options);
     }
     catch {
         return undefined;
     }
 }
-function ensureValidCidString(input) {
-    if (!validateCidString(input)) {
+function ensureValidCidString(input, options) {
+    if (!validateCidString(input, options)) {
         throw new Error(`Invalid CID string`);
     }
 }
+/**
+ * Verifies whether the multihash of a given {@link cid} matches the hash of the provided {@link bytes}.
+ * @params cid The CID to match against the bytes.
+ * @params bytes The bytes to verify.
+ * @returns true if the CID matches the bytes, false otherwise.
+ */
+async function isCidForBytes(cid, bytes) {
+    if (cid.multihash.code === sha2_1.sha256.code) {
+        const digest = await sha2_1.sha256.digest(bytes);
+        return (0, digest_1.equals)(cid.multihash, digest);
+    }
+    if (cid.multihash.code === sha2_1.sha512.code) {
+        const digest = await sha2_1.sha512.digest(bytes);
+        return (0, digest_1.equals)(cid.multihash, digest);
+    }
+    // Don't know how to verify other multihash codes
+    throw new Error('Unsupported CID multihash');
+}
+async function cidForCbor(bytes) {
+    const digest = await sha2_1.sha256.digest(bytes);
+    return cid_1.CID.createV1(exports.DAG_CBOR_MULTICODEC, digest);
+}
+async function cidForRawBytes(bytes) {
+    const digest = await sha2_1.sha256.digest(bytes);
+    return cid_1.CID.createV1(exports.RAW_MULTICODEC, digest);
+}
+function cidForRawHash(hash) {
+    // Fool-proofing
+    if (hash.length !== 32) {
+        throw new Error(`Invalid SHA-256 hash length: ${hash.length}`);
+    }
+    const digest = (0, digest_1.create)(sha2_1.sha256.code, hash);
+    return cid_1.CID.createV1(exports.RAW_MULTICODEC, digest);
+}
 //# sourceMappingURL=cid.js.map

package/dist/cid.js.map

@@ -1 +1 @@
-{"version":3,"file":"cid.js","sourceRoot":"","sources":["../src/cid.ts"],"names":[],"mappings":";;;AAuEA,sBAEC;AAED,4BAEC;AAED,8BAEC;AAED,8BAEC;AAED,sBAsBC;AAED,8CAEC;AAED,wCAMC;AAED,oDAIC;AA/HD,0CAAsC;AAwD7B,oFAxDA,SAAG,OAwDA;AAtDC,QAAA,mBAAmB,GAAG,IAAI,CAAA;AAC1B,QAAA,kBAAkB,GAAG,IAAI,CAAA;AAEzB,QAAA,uBAAuB,GAAG,IAAI,CAAA;AAkE3C,SAAgB,KAAK,CAAC,KAAc;IAClC,OAAO,SAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;AACzB,CAAC;AAED,SAAgB,QAAQ,CAAC,KAAa;IACpC,OAAO,SAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;AACzB,CAAC;AAED,SAAgB,SAAS,CAAC,KAAiB;IACzC,OAAO,SAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;AAC1B,CAAC;AAED,SAAgB,SAAS,CAAC,IAAY,EAAE,MAAuB;IAC7D,OAAO,SAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;AACnC,CAAC;AAED,SAAgB,KAAK,CACnB,KAAc,EACd,OAA8B;IAE9B,MAAM,GAAG,GAAG,KAAK,CAAC,KAAK,CAAC,CAAA;IACxB,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,OAAO,EAAE,MAAM,EAAE,CAAC;QACpB,IAAI,GAAG,CAAC,OAAO,KAAK,CAAC,EAAE,CAAC;YACtB,OAAO,KAAK,CAAA;QACd,CAAC;QACD,IAAI,GAAG,CAAC,IAAI,KAAK,0BAAkB,IAAI,GAAG,CAAC,IAAI,KAAK,2BAAmB,EAAE,CAAC;YACxE,OAAO,KAAK,CAAA;QACd,CAAC;QACD,IAAI,GAAG,CAAC,SAAS,CAAC,IAAI,KAAK,+BAAuB,EAAE,CAAC;YACnD,OAAO,KAAK,CAAA;QACd,CAAC;IACH,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC;AAED,SAAgB,iBAAiB,CAAC,KAAa;IAC7C,OAAO,cAAc,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,KAAK,KAAK,CAAA;AACpD,CAAC;AAED,SAAgB,cAAc,CAAC,KAAa;IAC1C,IAAI,CAAC;QACH,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAA;IACxB,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAA;IAClB,CAAC;AACH,CAAC;AAED,SAAgB,oBAAoB,CAAC,KAAa;IAChD,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,EAAE,CAAC;QAC9B,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAA;IACvC,CAAC;AACH,CAAC","sourcesContent":["import { CID } from 'multiformats/cid'\n\nexport const DAG_CBOR_MULTICODEC = 0x71\nexport const RAW_BIN_MULTICODEC = 0x55\n\nexport const SHA2_256_MULTIHASH_CODE = 0x12\n\nexport type MultihashDigest<Code extends number = number> = {\n  code: Code\n  digest: Uint8Array\n  size: number\n  bytes: Uint8Array\n}\n\ndeclare module 'multiformats/cid' {\n  /**\n   * @deprecated use the {@link Cid} interface from `@atproto/lex-data`, and\n   * related helpers ({@link asCid}, {@link parseCid}, {@link decodeCid},\n   * {@link createCid}, {@link isCid}), instead.\n   *\n   * This is marked as deprecated because we want to discourage direct usage of\n   * `multiformats/cid` in dependent packages, and instead have them rely on the\n   * {@link Cid} interface from `@atproto/lex-data`. The {@link CID} class from\n   * `multiformats` version <10 has compatibility issues with certain TypeScript\n   * configuration, which can lead to type errors in dependent packages.\n   *\n   * We are stuck with version 9 because `@atproto` packages did not drop\n   * CommonJS support yet, and multiformats version 10 only supports ES modules.\n   *\n   * In order to avoid compatibility issues, while preparing for future breaking\n   * changes (CID in multiformats v10+ has a slightly different interface), as\n   * we update or swap out `multiformats`, we provide our own stable {@link Cid}\n   * interface.\n   */\n  interface CID {}\n}\n\n// multiformats' CID class is not very portable because:\n//\n// - In dependent packages that use \"moduleResolution\" set to \"node16\",\n//   \"nodenext\" or \"bundler\", TypeScript fails to properly resolve the\n//   multiformats package when importing CID from @atproto/lex-data. This causes\n//   type errors in those packages. This is caused by the fact that the\n//   multiformats version <10 (which is the last version that supports CommonJS)\n//   uses \"exports\" field in package.json, which do not contain \"types\"\n//   entrypoints.\n//   https://www.npmjs.com/package/multiformats/v/9.9.0?activeTab=code\n// - By defining our own interface and helper functions, we can have more\n//   control over the public API exposed by this package.\n// - It allow us to have a stable interface in case we need to swap out, or\n//   eventually update multiformats (should we choose to drop CommonJS support)\n//   in the future.\n\n// @NOTE Even though it is not portable, we still re-export CID here so that\n// dependent packages where it can be used, have access to it (instead of\n// importing directly from \"multiformats\" or\"multiformats/cid\").\nexport { CID }\n\n/**\n * Interface for working with decoded CID string, compatible with\n * {@link CID} implementation.\n */\nexport interface Cid {\n  version: 0 | 1\n  code: number\n  multihash: MultihashDigest\n  bytes: Uint8Array\n  equals(other: unknown): boolean\n  toString(): string\n}\n\nexport function asCid(value: unknown): Cid | null {\n  return CID.asCID(value)\n}\n\nexport function parseCid(input: string): Cid {\n  return CID.parse(input)\n}\n\nexport function decodeCid(bytes: Uint8Array): Cid {\n  return CID.decode(bytes)\n}\n\nexport function createCid(code: number, digest: MultihashDigest): Cid {\n  return CID.createV1(code, digest)\n}\n\nexport function isCid(\n  value: unknown,\n  options?: { strict?: boolean },\n): value is Cid {\n  const cid = asCid(value)\n  if (!cid) {\n    return false\n  }\n\n  if (options?.strict) {\n    if (cid.version !== 1) {\n      return false\n    }\n    if (cid.code !== RAW_BIN_MULTICODEC && cid.code !== DAG_CBOR_MULTICODEC) {\n      return false\n    }\n    if (cid.multihash.code !== SHA2_256_MULTIHASH_CODE) {\n      return false\n    }\n  }\n\n  return true\n}\n\nexport function validateCidString(input: string): boolean {\n  return parseCidString(input)?.toString() === input\n}\n\nexport function parseCidString(input: string): Cid | undefined {\n  try {\n    return parseCid(input)\n  } catch {\n    return undefined\n  }\n}\n\nexport function ensureValidCidString(input: string): void {\n  if (!validateCidString(input)) {\n    throw new Error(`Invalid CID string`)\n  }\n}\n"]}
+{"version":3,"file":"cid.js","sourceRoot":"","sources":["../src/cid.ts"],"names":[],"mappings":";;;AAyFA,4BAEC;AAYD,8BAOC;AAUD,8BAEC;AAmBD,sBAgBC;AAOD,sBAEC;AAUD,sBAIC;AAYD,4BAGC;AAaD,8BAMC;AAED,8CAKC;AAUD,wCASC;AAED,oDAOC;AAQD,sCAgBC;AAED,gCAGC;AAED,wCAGC;AAED,sCAOC;AApSD,0CAAsC;AAiE7B,oFAjEA,SAAG,OAiEA;AAhEZ,uDAGmC;AACnC,mDAAyD;AAE5C,QAAA,mBAAmB,GAAG,IAAI,CAAA,CAAC,4BAA4B;AAGvD,QAAA,cAAc,GAAG,IAAI,CAAA,CAAC,qCAAqC;AAG3D,QAAA,gBAAgB,GAAG,aAAM,CAAC,IAAI,CAAA;AA4E3C,SAAgB,QAAQ,CAAC,GAAQ;IAC/B,OAAO,GAAG,CAAC,OAAO,KAAK,CAAC,IAAI,GAAG,CAAC,IAAI,KAAK,sBAAc,CAAA;AACzD,CAAC;AAYD,SAAgB,SAAS,CAAC,GAAQ;IAChC,OAAO,CACL,GAAG,CAAC,OAAO,KAAK,CAAC;QACjB,CAAC,GAAG,CAAC,IAAI,KAAK,sBAAc,IAAI,GAAG,CAAC,IAAI,KAAK,2BAAmB,CAAC;QACjE,GAAG,CAAC,SAAS,CAAC,IAAI,KAAK,wBAAgB;QACvC,GAAG,CAAC,SAAS,CAAC,IAAI,KAAK,EAAE,CAAC,mDAAmD;KAC9E,CAAA;AACH,CAAC;AAUD,SAAgB,SAAS,CAAC,GAAQ;IAChC,OAAO,GAAG,CAAC,IAAI,KAAK,2BAAmB,IAAI,SAAS,CAAC,GAAG,CAAC,CAAA;AAC3D,CAAC;AAmBD,SAAgB,KAAK,CAAC,KAAc,EAAE,OAAyB;IAC7D,MAAM,GAAG,GAAG,SAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;IAC5B,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,OAAO,IAAI,CAAA;IACb,CAAC;IAED,QAAQ,OAAO,EAAE,MAAM,EAAE,CAAC;QACxB,KAAK,MAAM;YACT,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAA;QACpC,KAAK,KAAK;YACR,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAA;QACnC,KAAK,MAAM;YACT,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAA;QACpC;YACE,OAAO,GAAG,CAAA;IACd,CAAC;AACH,CAAC;AAOD,SAAgB,KAAK,CAAC,KAAc,EAAE,OAAyB;IAC7D,OAAO,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,CAAA;AACvC,CAAC;AAUD,SAAgB,KAAK,CAAC,KAAc,EAAE,OAAyB;IAC7D,MAAM,GAAG,GAAG,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;IACjC,IAAI,GAAG;QAAE,OAAO,GAAG,CAAA;IACnB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAA;AACpC,CAAC;AAYD,SAAgB,QAAQ,CAAC,KAAa,EAAE,OAAyB;IAC/D,MAAM,GAAG,GAAG,SAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;IAC5B,OAAO,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;AAC5B,CAAC;AAaD,SAAgB,SAAS,CACvB,QAAoB,EACpB,OAAyB;IAEzB,MAAM,GAAG,GAAG,SAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;IAChC,OAAO,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;AAC5B,CAAC;AAED,SAAgB,iBAAiB,CAC/B,KAAa,EACb,OAAyB;IAEzB,OAAO,cAAc,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,QAAQ,EAAE,KAAK,KAAK,CAAA;AAC7D,CAAC;AAUD,SAAgB,cAAc,CAC5B,KAAa,EACb,OAAyB;IAEzB,IAAI,CAAC;QACH,OAAO,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;IACjC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAA;IAClB,CAAC;AACH,CAAC;AAED,SAAgB,oBAAoB,CAClC,KAAa,EACb,OAAyB;IAEzB,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC;QACvC,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAA;IACvC,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,aAAa,CACjC,GAAQ,EACR,KAAiB;IAEjB,IAAI,GAAG,CAAC,SAAS,CAAC,IAAI,KAAK,aAAM,CAAC,IAAI,EAAE,CAAC;QACvC,MAAM,MAAM,GAAG,MAAM,aAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;QACzC,OAAO,IAAA,eAAY,EAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,CAAA;IAC5C,CAAC;IAED,IAAI,GAAG,CAAC,SAAS,CAAC,IAAI,KAAK,aAAM,CAAC,IAAI,EAAE,CAAC;QACvC,MAAM,MAAM,GAAG,MAAM,aAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;QACzC,OAAO,IAAA,eAAY,EAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,CAAA;IAC5C,CAAC;IAED,iDAAiD;IACjD,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;AAC9C,CAAC;AAEM,KAAK,UAAU,UAAU,CAAC,KAAiB;IAChD,MAAM,MAAM,GAAG,MAAM,aAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;IACzC,OAAO,SAAG,CAAC,QAAQ,CAAC,2BAAmB,EAAE,MAAM,CAAY,CAAA;AAC7D,CAAC;AAEM,KAAK,UAAU,cAAc,CAAC,KAAiB;IACpD,MAAM,MAAM,GAAG,MAAM,aAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;IACzC,OAAO,SAAG,CAAC,QAAQ,CAAC,sBAAc,EAAE,MAAM,CAAW,CAAA;AACvD,CAAC;AAED,SAAgB,aAAa,CAAC,IAAgB;IAC5C,gBAAgB;IAChB,IAAI,IAAI,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;QACvB,MAAM,IAAI,KAAK,CAAC,gCAAgC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAA;IAChE,CAAC;IACD,MAAM,MAAM,GAAG,IAAA,eAAY,EAAC,aAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;IAC9C,OAAO,SAAG,CAAC,QAAQ,CAAC,sBAAc,EAAE,MAAM,CAAW,CAAA;AACvD,CAAC","sourcesContent":["import { CID } from 'multiformats/cid'\nimport {\n  create as createDigest,\n  equals as digestEquals,\n} from 'multiformats/hashes/digest'\nimport { sha256, sha512 } from 'multiformats/hashes/sha2'\n\nexport const DAG_CBOR_MULTICODEC = 0x71 // DRISL conformant DAG-CBOR\nexport type DAG_CBOR_MULTICODEC = typeof DAG_CBOR_MULTICODEC\n\nexport const RAW_MULTICODEC = 0x55 // raw binary codec used in DASL CIDs\nexport type RAW_MULTICODEC = typeof RAW_MULTICODEC\n\nexport const SHA256_MULTIHASH = sha256.code\nexport type SHA256_MULTIHASH = typeof SHA256_MULTIHASH\n\nexport type MultihashDigest<Code extends number = number> = {\n  code: Code\n  digest: Uint8Array\n  size: number\n  bytes: Uint8Array\n}\n\ndeclare module 'multiformats/cid' {\n  /**\n   * @deprecated use the {@link Cid} interface from `@atproto/lex-data`, and\n   * related helpers ({@link isCid}, {@link ifCid}, {@link asCid},\n   * {@link parseCid}, {@link decodeCid}), instead.\n   *\n   * This is marked as deprecated because we want to discourage direct usage of\n   * `multiformats/cid` in dependent packages, and instead have them rely on the\n   * {@link Cid} interface from `@atproto/lex-data`. The {@link CID} class from\n   * `multiformats` version <10 has compatibility issues with certain TypeScript\n   * configuration, which can lead to type errors in dependent packages.\n   *\n   * We are stuck with version 9 because `@atproto` packages did not drop\n   * CommonJS support yet, and multiformats version 10 only supports ES modules.\n   *\n   * In order to avoid compatibility issues, while preparing for future breaking\n   * changes (CID in multiformats v10+ has a slightly different interface), as\n   * we update or swap out `multiformats`, we provide our own stable {@link Cid}\n   * interface.\n   */\n  interface CID {}\n}\n\n// multiformats' CID class is not very portable because:\n//\n// - In dependent packages that use \"moduleResolution\" set to \"node16\",\n//   \"nodenext\" or \"bundler\", TypeScript fails to properly resolve the\n//   multiformats package when importing CID from @atproto/lex-data. This causes\n//   type errors in those packages. This is caused by the fact that the\n//   multiformats version <10 (which is the last version that supports CommonJS)\n//   uses \"exports\" field in package.json, which do not contain \"types\"\n//   entrypoints.\n//   https://www.npmjs.com/package/multiformats/v/9.9.0?activeTab=code\n// - By defining our own interface and helper functions, we can have more\n//   control over the public API exposed by this package.\n// - It allow us to have a stable interface in case we need to swap out, or\n//   eventually update multiformats (should we choose to drop CommonJS support)\n//   in the future.\n\n// @NOTE Even though it is not portable, we still re-export CID here so that\n// dependent packages where it can be used, have access to it (instead of\n// importing directly from \"multiformats\" or\"multiformats/cid\").\nexport { CID }\n\n/**\n * Interface for working with decoded CID string, compatible with\n * {@link CID} implementation.\n */\nexport interface Cid {\n  version: 0 | 1\n  code: number\n  multihash: MultihashDigest\n  bytes: Uint8Array\n  equals(other: unknown): boolean\n  toString(): string\n}\n\n/**\n * Represents the cid of raw binary data (like media blobs).\n * @see {@link https://atproto.com/specs/data-model#link-and-cid-formats ATproto Data Model - Link and CID Formats}\n */\nexport interface RawCid extends Cid {\n  version: 1\n  code: RAW_MULTICODEC\n}\n\nexport function isRawCid(cid: Cid): cid is RawCid {\n  return cid.version === 1 && cid.code === RAW_MULTICODEC\n}\n\n/**\n * Represents a DASL compliant CID.\n * @see {@link https://dasl.ing/cid.html DASL-CIDs}\n */\nexport interface DaslCid extends Cid {\n  version: 1\n  code: RAW_MULTICODEC | DAG_CBOR_MULTICODEC\n  multihash: MultihashDigest<SHA256_MULTIHASH>\n}\n\nexport function isDaslCid(cid: Cid): cid is DaslCid {\n  return (\n    cid.version === 1 &&\n    (cid.code === RAW_MULTICODEC || cid.code === DAG_CBOR_MULTICODEC) &&\n    cid.multihash.code === SHA256_MULTIHASH &&\n    cid.multihash.size === 32 // Should always be 32 bytes (256 bits) for SHA-256\n  )\n}\n\n/**\n * Represents the cid of ATProto DAG-CBOR data (like repository MST nodes).\n * @see {@link https://atproto.com/specs/data-model#link-and-cid-formats ATproto Data Model - Link and CID Formats}\n */\nexport interface CborCid extends DaslCid {\n  code: DAG_CBOR_MULTICODEC\n}\n\nexport function isCborCid(cid: Cid): cid is CborCid {\n  return cid.code === DAG_CBOR_MULTICODEC && isDaslCid(cid)\n}\n\nexport type CidCheckOptions = {\n  flavor?: 'raw' | 'cbor' | 'dasl'\n}\nexport type InferCheckedCid<TOptions> = TOptions extends { flavor: 'raw' }\n  ? RawCid\n  : TOptions extends { flavor: 'cbor' }\n    ? CborCid\n    : Cid\n\n/**\n * Coerces the input value to a Cid, or returns null if not possible.\n */\nexport function ifCid<TOptions extends CidCheckOptions>(\n  value: unknown,\n  options: TOptions,\n): InferCheckedCid<TOptions> | null\nexport function ifCid(value: unknown, options?: CidCheckOptions): Cid | null\nexport function ifCid(value: unknown, options?: CidCheckOptions): Cid | null {\n  const cid = CID.asCID(value)\n  if (!cid) {\n    return null\n  }\n\n  switch (options?.flavor) {\n    case 'cbor':\n      return isCborCid(cid) ? cid : null\n    case 'raw':\n      return isRawCid(cid) ? cid : null\n    case 'dasl':\n      return isDaslCid(cid) ? cid : null\n    default:\n      return cid\n  }\n}\n\nexport function isCid<TOptions extends CidCheckOptions>(\n  value: unknown,\n  options: TOptions,\n): value is InferCheckedCid<TOptions>\nexport function isCid(value: unknown, options?: CidCheckOptions): value is Cid\nexport function isCid(value: unknown, options?: CidCheckOptions): value is Cid {\n  return ifCid(value, options) !== null\n}\n\n/**\n * Coerces the input value to a Cid, or throws if not possible.\n */\nexport function asCid<TOptions extends CidCheckOptions>(\n  value: unknown,\n  options: TOptions,\n): InferCheckedCid<TOptions>\nexport function asCid(value: unknown, options?: CidCheckOptions): Cid\nexport function asCid(value: unknown, options?: CidCheckOptions): Cid {\n  const cid = ifCid(value, options)\n  if (cid) return cid\n  throw new Error('Not a valid CID')\n}\n\n/**\n * Parses a CID string into a Cid object.\n *\n * @throws if the input is not a valid CID string.\n */\nexport function parseCid<TOptions extends CidCheckOptions>(\n  input: string,\n  options: TOptions,\n): InferCheckedCid<TOptions>\nexport function parseCid(input: string, options?: CidCheckOptions): Cid\nexport function parseCid(input: string, options?: CidCheckOptions): Cid {\n  const cid = CID.parse(input)\n  return asCid(cid, options)\n}\n\n/**\n * Decodes a CID from its binary representation.\n *\n * @see {@link https://dasl.ing/cid.html DASL-CIDs}\n * @throws if the input do not represent a valid DASL {@link Cid}\n */\nexport function decodeCid<TOptions extends CidCheckOptions>(\n  cidBytes: Uint8Array,\n  options: TOptions,\n): InferCheckedCid<TOptions>\nexport function decodeCid(cidBytes: Uint8Array, options?: CidCheckOptions): Cid\nexport function decodeCid(\n  cidBytes: Uint8Array,\n  options?: CidCheckOptions,\n): Cid {\n  const cid = CID.decode(cidBytes)\n  return asCid(cid, options)\n}\n\nexport function validateCidString(\n  input: string,\n  options?: CidCheckOptions,\n): boolean {\n  return parseCidString(input, options)?.toString() === input\n}\n\nexport function parseCidString<TOptions extends CidCheckOptions>(\n  input: string,\n  options: TOptions,\n): InferCheckedCid<TOptions> | undefined\nexport function parseCidString(\n  input: string,\n  options?: CidCheckOptions,\n): Cid | undefined\nexport function parseCidString(\n  input: string,\n  options?: CidCheckOptions,\n): Cid | undefined {\n  try {\n    return parseCid(input, options)\n  } catch {\n    return undefined\n  }\n}\n\nexport function ensureValidCidString(\n  input: string,\n  options?: CidCheckOptions,\n): void {\n  if (!validateCidString(input, options)) {\n    throw new Error(`Invalid CID string`)\n  }\n}\n\n/**\n * Verifies whether the multihash of a given {@link cid} matches the hash of the provided {@link bytes}.\n * @params cid The CID to match against the bytes.\n * @params bytes The bytes to verify.\n * @returns true if the CID matches the bytes, false otherwise.\n */\nexport async function isCidForBytes(\n  cid: Cid,\n  bytes: Uint8Array,\n): Promise<boolean> {\n  if (cid.multihash.code === sha256.code) {\n    const digest = await sha256.digest(bytes)\n    return digestEquals(cid.multihash, digest)\n  }\n\n  if (cid.multihash.code === sha512.code) {\n    const digest = await sha512.digest(bytes)\n    return digestEquals(cid.multihash, digest)\n  }\n\n  // Don't know how to verify other multihash codes\n  throw new Error('Unsupported CID multihash')\n}\n\nexport async function cidForCbor(bytes: Uint8Array): Promise<CborCid> {\n  const digest = await sha256.digest(bytes)\n  return CID.createV1(DAG_CBOR_MULTICODEC, digest) as CborCid\n}\n\nexport async function cidForRawBytes(bytes: Uint8Array): Promise<RawCid> {\n  const digest = await sha256.digest(bytes)\n  return CID.createV1(RAW_MULTICODEC, digest) as RawCid\n}\n\nexport function cidForRawHash(hash: Uint8Array): RawCid {\n  // Fool-proofing\n  if (hash.length !== 32) {\n    throw new Error(`Invalid SHA-256 hash length: ${hash.length}`)\n  }\n  const digest = createDigest(sha256.code, hash)\n  return CID.createV1(RAW_MULTICODEC, digest) as RawCid\n}\n"]}

package/dist/lex-equals.js

@@ -42,7 +42,7 @@ function lexEquals(a, b) {
     if ((0, cid_js_1.isCid)(a)) {
         // @NOTE CID.equals returns its argument when it is falsy (e.g. null or
         // undefined) so we need to explicitly check that the output is "true".
-        return (0, cid_js_1.asCid)(a).equals((0, cid_js_1.asCid)(b)) === true;
+        return (0, cid_js_1.ifCid)(b)?.equals(a) === true;
     }
     else if ((0, cid_js_1.isCid)(b)) {
         return false;

package/dist/lex-equals.js.map

@@ -1 +1 @@
-{"version":3,"file":"lex-equals.js","sourceRoot":"","sources":["../src/lex-equals.ts"],"names":[],"mappings":";;AAKA,8BA+EC;AApFD,qCAAuC;AAEvC,2CAA2C;AAC3C,mDAA2C;AAE3C,SAAgB,SAAS,CAAC,CAAW,EAAE,CAAW;IAChD,IAAI,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;QACpB,OAAO,IAAI,CAAA;IACb,CAAC;IAED,IACE,CAAC,IAAI,IAAI;QACT,CAAC,IAAI,IAAI;QACT,OAAO,CAAC,KAAK,QAAQ;QACrB,OAAO,CAAC,KAAK,QAAQ,EACrB,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;QACrB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;YACtB,OAAO,KAAK,CAAA;QACd,CAAC;QACD,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC;YAC1B,OAAO,KAAK,CAAA;QACd,CAAC;QACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAClC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC3B,OAAO,KAAK,CAAA;YACd,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;SAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5B,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;QAC1B,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC;YAAE,OAAO,KAAK,CAAA;QACxC,OAAO,IAAA,yBAAS,EAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IACxB,CAAC;SAAM,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;QACjC,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,IAAA,cAAK,EAAC,CAAC,CAAC,EAAE,CAAC;QACb,uEAAuE;QACvE,uEAAuE;QACvE,OAAO,IAAA,cAAK,EAAC,CAAC,CAAE,CAAC,MAAM,CAAC,IAAA,cAAK,EAAC,CAAC,CAAC,CAAC,KAAK,IAAI,CAAA;IAC5C,CAAC;SAAM,IAAI,IAAA,cAAK,EAAC,CAAC,CAAC,EAAE,CAAC;QACpB,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,CAAC,IAAA,yBAAa,EAAC,CAAC,CAAC,IAAI,CAAC,IAAA,yBAAa,EAAC,CAAC,CAAC,EAAE,CAAC;QAC3C,kCAAkC;QAClC,MAAM,IAAI,SAAS,CACjB,wDAAwD,CACzD,CAAA;IACH,CAAC;IAED,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IAC5B,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IAE5B,IAAI,KAAK,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM,EAAE,CAAC;QAClC,OAAO,KAAK,CAAA;IACd,CAAC;IAED,KAAK,MAAM,GAAG,IAAI,KAAK,EAAE,CAAC;QACxB,MAAM,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,CAAA;QACnB,MAAM,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,CAAA;QAEnB,wEAAwE;QACxE,4DAA4D;QAC5D,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,IAAI,IAAI,KAAK,SAAS,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC;gBAAE,SAAQ;YACvD,OAAO,KAAK,CAAA;QACd,CAAC;aAAM,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YAC9B,OAAO,KAAK,CAAA;QACd,CAAC;QAED,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC;YAC3B,OAAO,KAAK,CAAA;QACd,CAAC;IACH,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC","sourcesContent":["import { asCid, isCid } from './cid.js'\nimport { LexValue } from './lex.js'\nimport { isPlainObject } from './object.js'\nimport { ui8Equals } from './uint8array.js'\n\nexport function lexEquals(a: LexValue, b: LexValue): boolean {\n  if (Object.is(a, b)) {\n    return true\n  }\n\n  if (\n    a == null ||\n    b == null ||\n    typeof a !== 'object' ||\n    typeof b !== 'object'\n  ) {\n    return false\n  }\n\n  if (Array.isArray(a)) {\n    if (!Array.isArray(b)) {\n      return false\n    }\n    if (a.length !== b.length) {\n      return false\n    }\n    for (let i = 0; i < a.length; i++) {\n      if (!lexEquals(a[i], b[i])) {\n        return false\n      }\n    }\n    return true\n  } else if (Array.isArray(b)) {\n    return false\n  }\n\n  if (ArrayBuffer.isView(a)) {\n    if (!ArrayBuffer.isView(b)) return false\n    return ui8Equals(a, b)\n  } else if (ArrayBuffer.isView(b)) {\n    return false\n  }\n\n  if (isCid(a)) {\n    // @NOTE CID.equals returns its argument when it is falsy (e.g. null or\n    // undefined) so we need to explicitly check that the output is \"true\".\n    return asCid(a)!.equals(asCid(b)) === true\n  } else if (isCid(b)) {\n    return false\n  }\n\n  if (!isPlainObject(a) || !isPlainObject(b)) {\n    // Foolproof (should never happen)\n    throw new TypeError(\n      'Invalid LexValue (expected CID, Uint8Array, or LexMap)',\n    )\n  }\n\n  const aKeys = Object.keys(a)\n  const bKeys = Object.keys(b)\n\n  if (aKeys.length !== bKeys.length) {\n    return false\n  }\n\n  for (const key of aKeys) {\n    const aVal = a[key]\n    const bVal = b[key]\n\n    // Needed because of the optional index signature in the Lex object type\n    // though, in practice, aVal should never be undefined here.\n    if (aVal === undefined) {\n      if (bVal === undefined && bKeys.includes(key)) continue\n      return false\n    } else if (bVal === undefined) {\n      return false\n    }\n\n    if (!lexEquals(aVal, bVal)) {\n      return false\n    }\n  }\n\n  return true\n}\n"]}
+{"version":3,"file":"lex-equals.js","sourceRoot":"","sources":["../src/lex-equals.ts"],"names":[],"mappings":";;AAKA,8BA+EC;AApFD,qCAAuC;AAEvC,2CAA2C;AAC3C,mDAA2C;AAE3C,SAAgB,SAAS,CAAC,CAAW,EAAE,CAAW;IAChD,IAAI,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;QACpB,OAAO,IAAI,CAAA;IACb,CAAC;IAED,IACE,CAAC,IAAI,IAAI;QACT,CAAC,IAAI,IAAI;QACT,OAAO,CAAC,KAAK,QAAQ;QACrB,OAAO,CAAC,KAAK,QAAQ,EACrB,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;QACrB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;YACtB,OAAO,KAAK,CAAA;QACd,CAAC;QACD,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC;YAC1B,OAAO,KAAK,CAAA;QACd,CAAC;QACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAClC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC3B,OAAO,KAAK,CAAA;YACd,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;SAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5B,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;QAC1B,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC;YAAE,OAAO,KAAK,CAAA;QACxC,OAAO,IAAA,yBAAS,EAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IACxB,CAAC;SAAM,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;QACjC,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,IAAA,cAAK,EAAC,CAAC,CAAC,EAAE,CAAC;QACb,uEAAuE;QACvE,uEAAuE;QACvE,OAAO,IAAA,cAAK,EAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,IAAI,CAAA;IACrC,CAAC;SAAM,IAAI,IAAA,cAAK,EAAC,CAAC,CAAC,EAAE,CAAC;QACpB,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,CAAC,IAAA,yBAAa,EAAC,CAAC,CAAC,IAAI,CAAC,IAAA,yBAAa,EAAC,CAAC,CAAC,EAAE,CAAC;QAC3C,kCAAkC;QAClC,MAAM,IAAI,SAAS,CACjB,wDAAwD,CACzD,CAAA;IACH,CAAC;IAED,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IAC5B,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IAE5B,IAAI,KAAK,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM,EAAE,CAAC;QAClC,OAAO,KAAK,CAAA;IACd,CAAC;IAED,KAAK,MAAM,GAAG,IAAI,KAAK,EAAE,CAAC;QACxB,MAAM,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,CAAA;QACnB,MAAM,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,CAAA;QAEnB,wEAAwE;QACxE,4DAA4D;QAC5D,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,IAAI,IAAI,KAAK,SAAS,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC;gBAAE,SAAQ;YACvD,OAAO,KAAK,CAAA;QACd,CAAC;aAAM,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YAC9B,OAAO,KAAK,CAAA;QACd,CAAC;QAED,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC;YAC3B,OAAO,KAAK,CAAA;QACd,CAAC;IACH,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC","sourcesContent":["import { ifCid, isCid } from './cid.js'\nimport { LexValue } from './lex.js'\nimport { isPlainObject } from './object.js'\nimport { ui8Equals } from './uint8array.js'\n\nexport function lexEquals(a: LexValue, b: LexValue): boolean {\n  if (Object.is(a, b)) {\n    return true\n  }\n\n  if (\n    a == null ||\n    b == null ||\n    typeof a !== 'object' ||\n    typeof b !== 'object'\n  ) {\n    return false\n  }\n\n  if (Array.isArray(a)) {\n    if (!Array.isArray(b)) {\n      return false\n    }\n    if (a.length !== b.length) {\n      return false\n    }\n    for (let i = 0; i < a.length; i++) {\n      if (!lexEquals(a[i], b[i])) {\n        return false\n      }\n    }\n    return true\n  } else if (Array.isArray(b)) {\n    return false\n  }\n\n  if (ArrayBuffer.isView(a)) {\n    if (!ArrayBuffer.isView(b)) return false\n    return ui8Equals(a, b)\n  } else if (ArrayBuffer.isView(b)) {\n    return false\n  }\n\n  if (isCid(a)) {\n    // @NOTE CID.equals returns its argument when it is falsy (e.g. null or\n    // undefined) so we need to explicitly check that the output is \"true\".\n    return ifCid(b)?.equals(a) === true\n  } else if (isCid(b)) {\n    return false\n  }\n\n  if (!isPlainObject(a) || !isPlainObject(b)) {\n    // Foolproof (should never happen)\n    throw new TypeError(\n      'Invalid LexValue (expected CID, Uint8Array, or LexMap)',\n    )\n  }\n\n  const aKeys = Object.keys(a)\n  const bKeys = Object.keys(b)\n\n  if (aKeys.length !== bKeys.length) {\n    return false\n  }\n\n  for (const key of aKeys) {\n    const aVal = a[key]\n    const bVal = b[key]\n\n    // Needed because of the optional index signature in the Lex object type\n    // though, in practice, aVal should never be undefined here.\n    if (aVal === undefined) {\n      if (bVal === undefined && bKeys.includes(key)) continue\n      return false\n    } else if (bVal === undefined) {\n      return false\n    }\n\n    if (!lexEquals(aVal, bVal)) {\n      return false\n    }\n  }\n\n  return true\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atproto/lex-data",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "license": "MIT",
   "description": "Core utilities for AT Lexicons",
   "keywords": [

package/src/blob.test.ts

@@ -6,16 +6,19 @@ import {
   isBlobRef,
   isLegacyBlobRef,
 } from './blob.js'
-import { parseCid } from './cid.js'
+import { RawCid, parseCid } from './cid.js'
 import { LexArray, LexMap, LexValue } from './lex.js'
 
 // await cidForRawBytes(Buffer.from('Hello, World!'))
 const validBlobCid = parseCid(
   'bafkreig77vqcdozl2wyk6z3cscaj5q5fggi53aoh64fewkdiri3cdauyn4',
+  { flavor: 'raw' },
 )
+
 // await cidForLex(Buffer.from('Hello, World!'))
 const invalidBlobCid = parseCid(
   'bafyreic52vzks7wdklat4evp3vimohl55i2unzqpshz2ytka5omzr7exdy',
+  { flavor: 'cbor' },
 )
 
 describe(isBlobRef, () => {
@@ -285,14 +288,14 @@ describe(isLegacyBlobRef, () => {
 })
 
 describe(enumBlobRefs, () => {
-  const valid1: BlobRef = {
+  const valid1: BlobRef<RawCid> = {
     $type: 'blob',
     ref: validBlobCid,
     mimeType: 'image/png',
     size: 2048,
   }
 
-  const valid2: BlobRef = {
+  const valid2: BlobRef<RawCid> = {
     $type: 'blob',
     ref: validBlobCid,
     mimeType: 'image/jpeg',

package/src/blob.ts

@@ -1,24 +1,18 @@
-import {
-  Cid,
-  RAW_BIN_MULTICODEC,
-  SHA2_256_MULTIHASH_CODE,
-  asCid,
-  parseCid,
-} from './cid.js'
+import { Cid, RawCid, ifCid, validateCidString } from './cid.js'
 import { LexValue } from './lex.js'
 import { isPlainObject, isPlainProto } from './object.js'
 
 /**
  * @note {@link BlobRef} is just a {@link LexMap} with a specific shape.
  */
-export type BlobRef = {
+export type BlobRef<Ref extends Cid = Cid> = {
   $type: 'blob'
   mimeType: string
-  ref: Cid
+  ref: Ref
   size: number
 }
 
-export type BlobRefValidationOptions = {
+export type BlobRefCheckOptions = {
   /**
    * If `false`, skips strict CID validation of {@link BlobRef.ref}, allowing
    * any valid CID. Otherwise, validates that the CID is v1, uses the raw
@@ -29,9 +23,25 @@ export type BlobRefValidationOptions = {
   strict?: boolean
 }
 
+export type InferCheckedBlobRef<TOptions extends BlobRefCheckOptions> =
+  TOptions extends { strict: false }
+    ? BlobRef
+    : { strict: boolean } extends TOptions
+      ? BlobRef
+      : BlobRef<RawCid>
+
+export function isBlobRef(input: unknown): input is BlobRef<RawCid>
+export function isBlobRef<TOptions extends BlobRefCheckOptions>(
+  input: unknown,
+  options: TOptions,
+): input is InferCheckedBlobRef<TOptions>
+export function isBlobRef(
+  input: unknown,
+  options?: BlobRefCheckOptions,
+): input is BlobRef
 export function isBlobRef(
   input: unknown,
-  options?: BlobRefValidationOptions,
+  options?: BlobRefCheckOptions,
 ): input is BlobRef {
   if (!isPlainObject(input)) {
     return false
@@ -66,23 +76,15 @@ export function isBlobRef(
     }
   }
 
-  const cid = asCid(ref)
+  const cid = ifCid(
+    ref,
+    // Strict unless explicitly disabled
+    options?.strict === false ? undefined : { flavor: 'raw' },
+  )
   if (!cid) {
     return false
   }
 
-  if (options?.strict !== false) {
-    if (cid.version !== 1) {
-      return false
-    }
-    if (cid.code !== RAW_BIN_MULTICODEC) {
-      return false
-    }
-    if (cid.multihash.code !== SHA2_256_MULTIHASH_CODE) {
-      return false
-    }
-  }
-
   return true
 }
 
@@ -114,34 +116,38 @@ export function isLegacyBlobRef(input: unknown): input is LegacyBlobRef {
     }
   }
 
-  try {
-    parseCid(cid)
-  } catch {
+  if (!validateCidString(cid)) {
     return false
   }
 
   return true
 }
 
-export type EnumBlobRefsOptions = BlobRefValidationOptions & {
+export type EnumBlobRefsOptions = BlobRefCheckOptions & {
   /**
    * @defaults to `false`
    */
   allowLegacy?: boolean
 }
 
+export type InferEnumBlobRefs<TOptions extends EnumBlobRefsOptions> =
+  TOptions extends { allowLegacy: true }
+    ? InferCheckedBlobRef<TOptions> | LegacyBlobRef
+    : { allowLegacy: boolean } extends TOptions
+      ? InferCheckedBlobRef<TOptions> | LegacyBlobRef
+      : InferCheckedBlobRef<TOptions>
+
 /**
  * Enumerates all {@link BlobRef}s (and, optionally, {@link LegacyBlobRef}s)
  * found within a {@link LexValue}.
  */
 export function enumBlobRefs(
   input: LexValue,
-  options: EnumBlobRefsOptions & { allowLegacy: true },
-): Generator<BlobRef | LegacyBlobRef, void, unknown>
-export function enumBlobRefs(
+): Generator<BlobRef<RawCid>, void, unknown>
+export function enumBlobRefs<TOptions extends EnumBlobRefsOptions>(
   input: LexValue,
-  options?: EnumBlobRefsOptions & { allowLegacy?: false },
-): Generator<BlobRef, void, unknown>
+  options: TOptions,
+): Generator<InferEnumBlobRefs<TOptions>, void, unknown>
 export function enumBlobRefs(
   input: LexValue,
   options?: EnumBlobRefsOptions,
@@ -150,6 +156,7 @@ export function* enumBlobRefs(
   input: LexValue,
   options?: EnumBlobRefsOptions,
 ): Generator<BlobRef | LegacyBlobRef, void, unknown> {
+  // LegacyBlobRef not included by default
   const includeLegacy = options?.allowLegacy === true
 
   // Using a stack to avoid recursion depth issues.

package/src/cid.test.ts

@@ -2,8 +2,8 @@ import { CID } from 'multiformats/cid'
 import { sha256, sha512 } from 'multiformats/hashes/sha2'
 import { describe, expect, it } from 'vitest'
 import {
-  RAW_BIN_MULTICODEC,
-  createCid,
+  DAG_CBOR_MULTICODEC,
+  RAW_MULTICODEC,
   decodeCid,
   ensureValidCidString,
   isCid,
@@ -23,7 +23,7 @@ describe(isCid, () => {
     it('returns true for CID v0 and v1', async () => {
       const digest = await sha256.digest(Buffer.from('hello world'))
       const cidV0 = CID.createV0(digest)
-      const cidV1 = CID.createV1(RAW_BIN_MULTICODEC, digest)
+      const cidV1 = CID.createV1(RAW_MULTICODEC, digest)
       expect(isCid(cidV0)).toBe(true)
       expect(isCid(cidV1)).toBe(true)
     })
@@ -35,41 +35,58 @@ describe(isCid, () => {
     })
   })
 
-  describe('strict mode', () => {
-    it('returns true for valid CIDs in strict mode', async () => {
-      const digest = await sha256.digest(Buffer.from('hello world'))
-      const cid = CID.createV1(RAW_BIN_MULTICODEC, digest)
-      expect(isCid(cid, { strict: true })).toBe(true)
-    })
+  describe('flavors', () => {
+    describe('raw', () => {
+      it('validated "raw" cids', async () => {
+        const digest = await sha256.digest(Buffer.from('hello world'))
+        const cid = CID.createV1(RAW_MULTICODEC, digest)
+        expect(isCid(cid, { flavor: 'raw' })).toBe(true)
+      })
 
-    it('rejects CID v0 when strict option is set', async () => {
-      const digest = await sha256.digest(Buffer.from('hello world'))
-      const cid = CID.createV0(digest)
-      expect(isCid(cid, { strict: true })).toBe(false)
-    })
+      it('allows other hash algorithms', async () => {
+        const digest = await sha512.digest(Buffer.from('hello world'))
+        const cid = CID.createV1(RAW_MULTICODEC, digest)
+        expect(isCid(cid, { flavor: 'raw' })).toBe(true)
+      })
 
-    it('rejects CIDs with invalid hash algorithm', async () => {
-      const digest = await sha512.digest(Buffer.from('hello world'))
-      const cid = CID.createV1(RAW_BIN_MULTICODEC, digest)
-      expect(isCid(cid, { strict: true })).toBe(false)
-    })
+      it('rejects CID v0 when strict option is set', async () => {
+        const digest = await sha256.digest(Buffer.from('hello world'))
+        const cid = CID.createV0(digest)
+        expect(isCid(cid, { flavor: 'raw' })).toBe(false)
+      })
 
-    it('rejects CIDs with invalid code', async () => {
-      const digest = await sha256.digest(Buffer.from('hello world'))
-      const cid = CID.createV1(3333, digest)
-      expect(isCid(cid, { strict: true })).toBe(false)
+      it('rejects CIDs with invalid code', async () => {
+        const digest = await sha256.digest(Buffer.from('hello world'))
+        const cid = CID.createV1(3333, digest)
+        expect(isCid(cid, { flavor: 'raw' })).toBe(false)
+      })
     })
-  })
-})
 
-describe(createCid, () => {
-  it('creates a valid CID v1', async () => {
-    const digest = await sha256.digest(Buffer.from('hello world'))
-    const cid = createCid(RAW_BIN_MULTICODEC, digest)
-    expect(cid.version).toBe(1)
-    expect(cid.code).toBe(RAW_BIN_MULTICODEC)
-    expect(cid.multihash.code).toBe(sha256.code)
-    expect(cid.multihash.digest).toEqual(digest.digest)
+    describe('cbor', () => {
+      it('validated "cbor" cids', async () => {
+        const digest = await sha256.digest(Buffer.from('hello world'))
+        const cid = CID.createV1(DAG_CBOR_MULTICODEC, digest)
+        expect(isCid(cid, { flavor: 'cbor' })).toBe(true)
+      })
+
+      it('rejects CIDs with invalid hash algorithm', async () => {
+        const digest = await sha512.digest(Buffer.from('hello world'))
+        const cid = CID.createV1(RAW_MULTICODEC, digest)
+        expect(isCid(cid, { flavor: 'cbor' })).toBe(false)
+      })
+
+      it('rejects CID v0 when strict option is set', async () => {
+        const digest = await sha256.digest(Buffer.from('hello world'))
+        const cid = CID.createV0(digest)
+        expect(isCid(cid, { flavor: 'cbor' })).toBe(false)
+      })
+
+      it('rejects CIDs with invalid code', async () => {
+        const digest = await sha256.digest(Buffer.from('hello world'))
+        const cid = CID.createV1(3333, digest)
+        expect(isCid(cid, { flavor: 'cbor' })).toBe(false)
+      })
+    })
   })
 })
 

package/src/cid.ts

@@ -1,9 +1,18 @@
 import { CID } from 'multiformats/cid'
+import {
+  create as createDigest,
+  equals as digestEquals,
+} from 'multiformats/hashes/digest'
+import { sha256, sha512 } from 'multiformats/hashes/sha2'
 
-export const DAG_CBOR_MULTICODEC = 0x71
-export const RAW_BIN_MULTICODEC = 0x55
+export const DAG_CBOR_MULTICODEC = 0x71 // DRISL conformant DAG-CBOR
+export type DAG_CBOR_MULTICODEC = typeof DAG_CBOR_MULTICODEC
 
-export const SHA2_256_MULTIHASH_CODE = 0x12
+export const RAW_MULTICODEC = 0x55 // raw binary codec used in DASL CIDs
+export type RAW_MULTICODEC = typeof RAW_MULTICODEC
+
+export const SHA256_MULTIHASH = sha256.code
+export type SHA256_MULTIHASH = typeof SHA256_MULTIHASH
 
 export type MultihashDigest<Code extends number = number> = {
   code: Code
@@ -15,8 +24,8 @@ export type MultihashDigest<Code extends number = number> = {
 declare module 'multiformats/cid' {
   /**
    * @deprecated use the {@link Cid} interface from `@atproto/lex-data`, and
-   * related helpers ({@link asCid}, {@link parseCid}, {@link decodeCid},
-   * {@link createCid}, {@link isCid}), instead.
+   * related helpers ({@link isCid}, {@link ifCid}, {@link asCid},
+   * {@link parseCid}, {@link decodeCid}), instead.
    *
    * This is marked as deprecated because we want to discourage direct usage of
    * `multiformats/cid` in dependent packages, and instead have them rely on the
@@ -69,60 +78,216 @@ export interface Cid {
   toString(): string
 }
 
-export function asCid(value: unknown): Cid | null {
-  return CID.asCID(value)
+/**
+ * Represents the cid of raw binary data (like media blobs).
+ * @see {@link https://atproto.com/specs/data-model#link-and-cid-formats ATproto Data Model - Link and CID Formats}
+ */
+export interface RawCid extends Cid {
+  version: 1
+  code: RAW_MULTICODEC
+}
+
+export function isRawCid(cid: Cid): cid is RawCid {
+  return cid.version === 1 && cid.code === RAW_MULTICODEC
+}
+
+/**
+ * Represents a DASL compliant CID.
+ * @see {@link https://dasl.ing/cid.html DASL-CIDs}
+ */
+export interface DaslCid extends Cid {
+  version: 1
+  code: RAW_MULTICODEC | DAG_CBOR_MULTICODEC
+  multihash: MultihashDigest<SHA256_MULTIHASH>
 }
 
-export function parseCid(input: string): Cid {
-  return CID.parse(input)
+export function isDaslCid(cid: Cid): cid is DaslCid {
+  return (
+    cid.version === 1 &&
+    (cid.code === RAW_MULTICODEC || cid.code === DAG_CBOR_MULTICODEC) &&
+    cid.multihash.code === SHA256_MULTIHASH &&
+    cid.multihash.size === 32 // Should always be 32 bytes (256 bits) for SHA-256
+  )
 }
 
-export function decodeCid(bytes: Uint8Array): Cid {
-  return CID.decode(bytes)
+/**
+ * Represents the cid of ATProto DAG-CBOR data (like repository MST nodes).
+ * @see {@link https://atproto.com/specs/data-model#link-and-cid-formats ATproto Data Model - Link and CID Formats}
+ */
+export interface CborCid extends DaslCid {
+  code: DAG_CBOR_MULTICODEC
 }
 
-export function createCid(code: number, digest: MultihashDigest): Cid {
-  return CID.createV1(code, digest)
+export function isCborCid(cid: Cid): cid is CborCid {
+  return cid.code === DAG_CBOR_MULTICODEC && isDaslCid(cid)
 }
 
-export function isCid(
+export type CidCheckOptions = {
+  flavor?: 'raw' | 'cbor' | 'dasl'
+}
+export type InferCheckedCid<TOptions> = TOptions extends { flavor: 'raw' }
+  ? RawCid
+  : TOptions extends { flavor: 'cbor' }
+    ? CborCid
+    : Cid
+
+/**
+ * Coerces the input value to a Cid, or returns null if not possible.
+ */
+export function ifCid<TOptions extends CidCheckOptions>(
   value: unknown,
-  options?: { strict?: boolean },
-): value is Cid {
-  const cid = asCid(value)
+  options: TOptions,
+): InferCheckedCid<TOptions> | null
+export function ifCid(value: unknown, options?: CidCheckOptions): Cid | null
+export function ifCid(value: unknown, options?: CidCheckOptions): Cid | null {
+  const cid = CID.asCID(value)
   if (!cid) {
-    return false
+    return null
   }
 
-  if (options?.strict) {
-    if (cid.version !== 1) {
-      return false
-    }
-    if (cid.code !== RAW_BIN_MULTICODEC && cid.code !== DAG_CBOR_MULTICODEC) {
-      return false
-    }
-    if (cid.multihash.code !== SHA2_256_MULTIHASH_CODE) {
-      return false
-    }
+  switch (options?.flavor) {
+    case 'cbor':
+      return isCborCid(cid) ? cid : null
+    case 'raw':
+      return isRawCid(cid) ? cid : null
+    case 'dasl':
+      return isDaslCid(cid) ? cid : null
+    default:
+      return cid
   }
+}
 
-  return true
+export function isCid<TOptions extends CidCheckOptions>(
+  value: unknown,
+  options: TOptions,
+): value is InferCheckedCid<TOptions>
+export function isCid(value: unknown, options?: CidCheckOptions): value is Cid
+export function isCid(value: unknown, options?: CidCheckOptions): value is Cid {
+  return ifCid(value, options) !== null
 }
 
-export function validateCidString(input: string): boolean {
-  return parseCidString(input)?.toString() === input
+/**
+ * Coerces the input value to a Cid, or throws if not possible.
+ */
+export function asCid<TOptions extends CidCheckOptions>(
+  value: unknown,
+  options: TOptions,
+): InferCheckedCid<TOptions>
+export function asCid(value: unknown, options?: CidCheckOptions): Cid
+export function asCid(value: unknown, options?: CidCheckOptions): Cid {
+  const cid = ifCid(value, options)
+  if (cid) return cid
+  throw new Error('Not a valid CID')
 }
 
-export function parseCidString(input: string): Cid | undefined {
+/**
+ * Parses a CID string into a Cid object.
+ *
+ * @throws if the input is not a valid CID string.
+ */
+export function parseCid<TOptions extends CidCheckOptions>(
+  input: string,
+  options: TOptions,
+): InferCheckedCid<TOptions>
+export function parseCid(input: string, options?: CidCheckOptions): Cid
+export function parseCid(input: string, options?: CidCheckOptions): Cid {
+  const cid = CID.parse(input)
+  return asCid(cid, options)
+}
+
+/**
+ * Decodes a CID from its binary representation.
+ *
+ * @see {@link https://dasl.ing/cid.html DASL-CIDs}
+ * @throws if the input do not represent a valid DASL {@link Cid}
+ */
+export function decodeCid<TOptions extends CidCheckOptions>(
+  cidBytes: Uint8Array,
+  options: TOptions,
+): InferCheckedCid<TOptions>
+export function decodeCid(cidBytes: Uint8Array, options?: CidCheckOptions): Cid
+export function decodeCid(
+  cidBytes: Uint8Array,
+  options?: CidCheckOptions,
+): Cid {
+  const cid = CID.decode(cidBytes)
+  return asCid(cid, options)
+}
+
+export function validateCidString(
+  input: string,
+  options?: CidCheckOptions,
+): boolean {
+  return parseCidString(input, options)?.toString() === input
+}
+
+export function parseCidString<TOptions extends CidCheckOptions>(
+  input: string,
+  options: TOptions,
+): InferCheckedCid<TOptions> | undefined
+export function parseCidString(
+  input: string,
+  options?: CidCheckOptions,
+): Cid | undefined
+export function parseCidString(
+  input: string,
+  options?: CidCheckOptions,
+): Cid | undefined {
   try {
-    return parseCid(input)
+    return parseCid(input, options)
   } catch {
     return undefined
   }
 }
 
-export function ensureValidCidString(input: string): void {
-  if (!validateCidString(input)) {
+export function ensureValidCidString(
+  input: string,
+  options?: CidCheckOptions,
+): void {
+  if (!validateCidString(input, options)) {
     throw new Error(`Invalid CID string`)
   }
 }
+
+/**
+ * Verifies whether the multihash of a given {@link cid} matches the hash of the provided {@link bytes}.
+ * @params cid The CID to match against the bytes.
+ * @params bytes The bytes to verify.
+ * @returns true if the CID matches the bytes, false otherwise.
+ */
+export async function isCidForBytes(
+  cid: Cid,
+  bytes: Uint8Array,
+): Promise<boolean> {
+  if (cid.multihash.code === sha256.code) {
+    const digest = await sha256.digest(bytes)
+    return digestEquals(cid.multihash, digest)
+  }
+
+  if (cid.multihash.code === sha512.code) {
+    const digest = await sha512.digest(bytes)
+    return digestEquals(cid.multihash, digest)
+  }
+
+  // Don't know how to verify other multihash codes
+  throw new Error('Unsupported CID multihash')
+}
+
+export async function cidForCbor(bytes: Uint8Array): Promise<CborCid> {
+  const digest = await sha256.digest(bytes)
+  return CID.createV1(DAG_CBOR_MULTICODEC, digest) as CborCid
+}
+
+export async function cidForRawBytes(bytes: Uint8Array): Promise<RawCid> {
+  const digest = await sha256.digest(bytes)
+  return CID.createV1(RAW_MULTICODEC, digest) as RawCid
+}
+
+export function cidForRawHash(hash: Uint8Array): RawCid {
+  // Fool-proofing
+  if (hash.length !== 32) {
+    throw new Error(`Invalid SHA-256 hash length: ${hash.length}`)
+  }
+  const digest = createDigest(sha256.code, hash)
+  return CID.createV1(RAW_MULTICODEC, digest) as RawCid
+}

package/src/lex-equals.ts

@@ -1,4 +1,4 @@
-import { asCid, isCid } from './cid.js'
+import { ifCid, isCid } from './cid.js'
 import { LexValue } from './lex.js'
 import { isPlainObject } from './object.js'
 import { ui8Equals } from './uint8array.js'
@@ -44,7 +44,7 @@ export function lexEquals(a: LexValue, b: LexValue): boolean {
   if (isCid(a)) {
     // @NOTE CID.equals returns its argument when it is falsy (e.g. null or
     // undefined) so we need to explicitly check that the output is "true".
-    return asCid(a)!.equals(asCid(b)) === true
+    return ifCid(b)?.equals(a) === true
   } else if (isCid(b)) {
     return false
   }