@atproto/lex-cbor 0.0.6 → 0.0.7

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @atproto/lex-cbor
 
+## 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)! - Remove direct depdency on `multiformats`
+
+- [#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**: Removed CID utilities (they can be imported from `@atproto/lex-data` instead)
+
+- Updated dependencies [[`d78484f`](https://github.com/bluesky-social/atproto/commit/d78484f94d8ba1352ec66030115000d515c9dafe), [`d78484f`](https://github.com/bluesky-social/atproto/commit/d78484f94d8ba1352ec66030115000d515c9dafe), [`d78484f`](https://github.com/bluesky-social/atproto/commit/d78484f94d8ba1352ec66030115000d515c9dafe)]:
+  - @atproto/lex-data@0.0.7
+
 ## 0.0.6
 
 ### Patch Changes

package/dist/index.cjs

@@ -1,7 +1,5 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const digest = require("multiformats/hashes/digest");
-const sha2 = require("multiformats/hashes/sha2");
 const lexData = require("@atproto/lex-data");
 const typeofs = [
   "string",
@@ -1582,7 +1580,7 @@ function cidEncoder(cid) {
   return [new Token(Type.tag, CID_CBOR_TAG), new Token(Type.bytes, bytes)];
 }
 function objectEncoder(obj, _typ, _options) {
-  const cid = lexData.asCid(obj);
+  const cid = lexData.ifCid(obj);
   if (cid) return cidEncoder(cid);
   return null;
 }
@@ -1645,63 +1643,12 @@ function* decodeAll(data) {
   } while (data.byteLength > 0);
 }
 async function cidForLex(value) {
-  return cidForCbor(encode(value));
-}
-async function cidForCbor(bytes) {
-  const digest2 = await sha2.sha256.digest(bytes);
-  return lexData.createCid(lexData.DAG_CBOR_MULTICODEC, digest2);
-}
-async function verifyCidForBytes(cid, bytes) {
-  const digest2 = await sha2.sha256.digest(bytes);
-  const expected = lexData.createCid(cid.code, digest2);
-  if (!cid.equals(expected)) {
-    throw new Error(
-      `Not a valid CID for bytes. Expected: ${expected.toString()} Got: ${cid.toString()}`
-    );
-  }
-}
-async function cidForRawBytes(bytes) {
-  const digest2 = await sha2.sha256.digest(bytes);
-  return lexData.createCid(lexData.RAW_BIN_MULTICODEC, digest2);
-}
-function cidForRawHash(hash) {
-  const digest$1 = digest.create(sha2.sha256.code, hash);
-  return lexData.createCid(lexData.RAW_BIN_MULTICODEC, digest$1);
-}
-function parseCidFromBytes(cidBytes) {
-  const version = cidBytes[0];
-  if (version !== 1) {
-    throw new Error(`Unsupported CID version: ${version}`);
-  }
-  const code = cidBytes[1];
-  if (code !== lexData.RAW_BIN_MULTICODEC && code !== lexData.DAG_CBOR_MULTICODEC) {
-    throw new Error(`Unsupported CID codec: ${code}`);
-  }
-  const hashType = cidBytes[2];
-  if (hashType !== lexData.SHA2_256_MULTIHASH_CODE) {
-    throw new Error(`Unsupported CID hash function: ${hashType}`);
-  }
-  const hashLength = cidBytes[3];
-  if (hashLength !== 32) {
-    throw new Error(`Unexpected CID hash length: ${hashLength}`);
-  }
-  if (hashLength !== cidBytes.length - 4) {
-    throw new Error(`Unexpected CID bytes length: ${hashLength}`);
-  }
-  const hashBytes = cidBytes.slice(4);
-  const digest$1 = digest.create(hashType, hashBytes);
-  return lexData.createCid(code, digest$1);
+  return lexData.cidForCbor(encode(value));
 }
-Object.defineProperty(exports, "hasher", {
-  enumerable: true,
-  get: () => sha2.sha256
-});
-exports.cidForCbor = cidForCbor;
+exports.cborDecode = decode;
+exports.cborDecodeAll = decodeAll;
+exports.cborEncode = encode;
 exports.cidForLex = cidForLex;
-exports.cidForRawBytes = cidForRawBytes;
-exports.cidForRawHash = cidForRawHash;
 exports.decode = decode;
 exports.decodeAll = decodeAll;
 exports.encode = encode;
-exports.parseCidFromBytes = parseCidFromBytes;
-exports.verifyCidForBytes = verifyCidForBytes;

package/dist/index.d.ts

@@ -1,17 +1,7 @@
-import { sha256 as hasher } from 'multiformats/hashes/sha2';
-import { Cid, LexValue } from '@atproto/lex-data';
-export { hasher };
+import { CborCid, LexValue } from '@atproto/lex-data';
+export type { Cid } from '@atproto/lex-data';
+export type { CborCid, LexValue };
 export { decode, decodeAll, encode } from './encoding.js';
-export type { Cid, LexValue };
-export declare function cidForLex(value: LexValue): Promise<Cid>;
-export declare function cidForCbor(bytes: Uint8Array): Promise<Cid>;
-export declare function verifyCidForBytes(cid: Cid, bytes: Uint8Array): Promise<void>;
-export declare function cidForRawBytes(bytes: Uint8Array): Promise<Cid>;
-export declare function cidForRawHash(hash: Uint8Array): Cid;
-/**
- * @note Only supports DASL CIDs
- * @see {@link https://dasl.ing/cid.html}
- * @throws if the input do not represent a valid DASL {@link Cid}
- */
-export declare function parseCidFromBytes(cidBytes: Uint8Array): Cid;
+export { decode as cborDecode, decodeAll as cborDecodeAll, encode as cborEncode, } from './encoding.js';
+export declare function cidForLex(value: LexValue): Promise<CborCid>;
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EACL,GAAG,EAEH,QAAQ,EAIT,MAAM,mBAAmB,CAAA;AAG1B,OAAO,EAAE,MAAM,EAAE,CAAA;AACjB,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AACzD,YAAY,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAA;AAE7B,wBAAsB,SAAS,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,CAE7D;AAED,wBAAsB,UAAU,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,CAGhE;AAED,wBAAsB,iBAAiB,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,UAAU,iBAQlE;AAED,wBAAsB,cAAc,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,CAGpE;AAED,wBAAgB,aAAa,CAAC,IAAI,EAAE,UAAU,GAAG,GAAG,CAGnD;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,UAAU,GAAG,GAAG,CAuB3D"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAc,MAAM,mBAAmB,CAAA;AAGjE,YAAY,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAA;AAC5C,YAAY,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAA;AAEjC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAEzD,OAAO,EACL,MAAM,IAAI,UAAU,EACpB,SAAS,IAAI,aAAa,EAC1B,MAAM,IAAI,UAAU,GACrB,MAAM,eAAe,CAAA;AAEtB,wBAAsB,SAAS,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,CAEjE"}

package/dist/index.mjs

@@ -1,7 +1,4 @@
-import { create } from "multiformats/hashes/digest";
-import { sha256 } from "multiformats/hashes/sha2";
-import { sha256 as sha2562 } from "multiformats/hashes/sha2";
-import { decodeCid, asCid, createCid, DAG_CBOR_MULTICODEC, RAW_BIN_MULTICODEC, SHA2_256_MULTIHASH_CODE } from "@atproto/lex-data";
+import { decodeCid, ifCid, cidForCbor } from "@atproto/lex-data";
 const typeofs = [
   "string",
   "number",
@@ -1581,7 +1578,7 @@ function cidEncoder(cid) {
   return [new Token(Type.tag, CID_CBOR_TAG), new Token(Type.bytes, bytes)];
 }
 function objectEncoder(obj, _typ, _options) {
-  const cid = asCid(obj);
+  const cid = ifCid(obj);
   if (cid) return cidEncoder(cid);
   return null;
 }
@@ -1646,60 +1643,12 @@ function* decodeAll(data) {
 async function cidForLex(value) {
   return cidForCbor(encode(value));
 }
-async function cidForCbor(bytes) {
-  const digest = await sha256.digest(bytes);
-  return createCid(DAG_CBOR_MULTICODEC, digest);
-}
-async function verifyCidForBytes(cid, bytes) {
-  const digest = await sha256.digest(bytes);
-  const expected = createCid(cid.code, digest);
-  if (!cid.equals(expected)) {
-    throw new Error(
-      `Not a valid CID for bytes. Expected: ${expected.toString()} Got: ${cid.toString()}`
-    );
-  }
-}
-async function cidForRawBytes(bytes) {
-  const digest = await sha256.digest(bytes);
-  return createCid(RAW_BIN_MULTICODEC, digest);
-}
-function cidForRawHash(hash) {
-  const digest = create(sha256.code, hash);
-  return createCid(RAW_BIN_MULTICODEC, digest);
-}
-function parseCidFromBytes(cidBytes) {
-  const version = cidBytes[0];
-  if (version !== 1) {
-    throw new Error(`Unsupported CID version: ${version}`);
-  }
-  const code = cidBytes[1];
-  if (code !== RAW_BIN_MULTICODEC && code !== DAG_CBOR_MULTICODEC) {
-    throw new Error(`Unsupported CID codec: ${code}`);
-  }
-  const hashType = cidBytes[2];
-  if (hashType !== SHA2_256_MULTIHASH_CODE) {
-    throw new Error(`Unsupported CID hash function: ${hashType}`);
-  }
-  const hashLength = cidBytes[3];
-  if (hashLength !== 32) {
-    throw new Error(`Unexpected CID hash length: ${hashLength}`);
-  }
-  if (hashLength !== cidBytes.length - 4) {
-    throw new Error(`Unexpected CID bytes length: ${hashLength}`);
-  }
-  const hashBytes = cidBytes.slice(4);
-  const digest = create(hashType, hashBytes);
-  return createCid(code, digest);
-}
 export {
-  cidForCbor,
+  decode as cborDecode,
+  decodeAll as cborDecodeAll,
+  encode as cborEncode,
   cidForLex,
-  cidForRawBytes,
-  cidForRawHash,
   decode,
   decodeAll,
-  encode,
-  sha2562 as hasher,
-  parseCidFromBytes,
-  verifyCidForBytes
+  encode
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atproto/lex-cbor",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "license": "MIT",
   "description": "Lexicon encoding utilities for AT Lexicon data in CBOR format",
   "keywords": [
@@ -37,15 +37,14 @@
     }
   },
   "dependencies": {
-    "multiformats": "^9.9.0",
     "tslib": "^2.8.1",
-    "@atproto/lex-data": "0.0.6"
+    "@atproto/lex-data": "0.0.7"
   },
   "devDependencies": {
     "cborg": "^4.3.0",
     "vite": "^6.2.0",
     "vitest": "^4.0.16",
-    "@atproto/lex-json": "0.0.6"
+    "@atproto/lex-json": "0.0.7"
   },
   "scripts": {
     "dev": "vite build --watch",

package/src/encoding.ts

@@ -8,7 +8,7 @@ import {
   decodeFirst as cborgDecodeFirst,
   encode as cborgEncode,
 } from 'cborg'
-import { Cid, LexValue, asCid, decodeCid } from '@atproto/lex-data'
+import { Cid, LexValue, decodeCid, ifCid } from '@atproto/lex-data'
 
 // @NOTE This was inspired by @ipld/dag-cbor implementation, but adapted to
 // match the AT Data Model constraints. Floats, in particular, are not allowed.
@@ -31,7 +31,7 @@ function objectEncoder(
   _typ: string,
   _options: EncodeOptions,
 ): Token[] | null {
-  const cid = asCid(obj)
+  const cid = ifCid(obj)
   if (cid) return cidEncoder(cid)
 
   // @TODO strip undefined values somehow

package/src/index.ts

@@ -1,74 +1,17 @@
-import { create as createDigest } from 'multiformats/hashes/digest'
-import { sha256 as hasher } from 'multiformats/hashes/sha2'
-import {
-  Cid,
-  DAG_CBOR_MULTICODEC,
-  LexValue,
-  RAW_BIN_MULTICODEC,
-  SHA2_256_MULTIHASH_CODE,
-  createCid,
-} from '@atproto/lex-data'
+import { CborCid, LexValue, cidForCbor } from '@atproto/lex-data'
 import { encode } from './encoding.js'
 
-export { hasher }
-export { decode, decodeAll, encode } from './encoding.js'
-export type { Cid, LexValue }
-
-export async function cidForLex(value: LexValue): Promise<Cid> {
-  return cidForCbor(encode(value))
-}
-
-export async function cidForCbor(bytes: Uint8Array): Promise<Cid> {
-  const digest = await hasher.digest(bytes)
-  return createCid(DAG_CBOR_MULTICODEC, digest)
-}
+export type { Cid } from '@atproto/lex-data'
+export type { CborCid, LexValue }
 
-export async function verifyCidForBytes(cid: Cid, bytes: Uint8Array) {
-  const digest = await hasher.digest(bytes)
-  const expected = createCid(cid.code, digest)
-  if (!cid.equals(expected)) {
-    throw new Error(
-      `Not a valid CID for bytes. Expected: ${expected.toString()} Got: ${cid.toString()}`,
-    )
-  }
-}
-
-export async function cidForRawBytes(bytes: Uint8Array): Promise<Cid> {
-  const digest = await hasher.digest(bytes)
-  return createCid(RAW_BIN_MULTICODEC, digest)
-}
+export { decode, decodeAll, encode } from './encoding.js'
 
-export function cidForRawHash(hash: Uint8Array): Cid {
-  const digest = createDigest(hasher.code, hash)
-  return createCid(RAW_BIN_MULTICODEC, digest)
-}
+export {
+  decode as cborDecode,
+  decodeAll as cborDecodeAll,
+  encode as cborEncode,
+} from './encoding.js'
 
-/**
- * @note Only supports DASL CIDs
- * @see {@link https://dasl.ing/cid.html}
- * @throws if the input do not represent a valid DASL {@link Cid}
- */
-export function parseCidFromBytes(cidBytes: Uint8Array): Cid {
-  const version = cidBytes[0]
-  if (version !== 0x01) {
-    throw new Error(`Unsupported CID version: ${version}`)
-  }
-  const code = cidBytes[1]
-  if (code !== RAW_BIN_MULTICODEC && code !== DAG_CBOR_MULTICODEC) {
-    throw new Error(`Unsupported CID codec: ${code}`)
-  }
-  const hashType = cidBytes[2]
-  if (hashType !== SHA2_256_MULTIHASH_CODE) {
-    throw new Error(`Unsupported CID hash function: ${hashType}`)
-  }
-  const hashLength = cidBytes[3]
-  if (hashLength !== 32) {
-    throw new Error(`Unexpected CID hash length: ${hashLength}`)
-  }
-  if (hashLength !== cidBytes.length - 4) {
-    throw new Error(`Unexpected CID bytes length: ${hashLength}`)
-  }
-  const hashBytes = cidBytes.slice(4)
-  const digest = createDigest(hashType, hashBytes)
-  return createCid(code, digest)
+export async function cidForLex(value: LexValue): Promise<CborCid> {
+  return cidForCbor(encode(value))
 }