@atproto/lex-cbor 0.0.1 → 0.0.2

package/CHANGELOG.md

@@ -0,0 +1,21 @@
+# @atproto/lex-cbor
+
+## 0.0.2
+
+### Patch Changes
+
+- [#4390](https://github.com/bluesky-social/atproto/pull/4390) [`1d445af`](https://github.com/bluesky-social/atproto/commit/1d445af2a7fc27eca5a45869b29266e6a2a7f3ba) Thanks [@matthieusieben](https://github.com/matthieusieben)! - Replace use of `CID` with `Cid`
+
+- [#4397](https://github.com/bluesky-social/atproto/pull/4397) [`688f9d6`](https://github.com/bluesky-social/atproto/commit/688f9d67597ba96d6e9c4a4aec4d394d42f4cbf4) Thanks [@matthieusieben](https://github.com/matthieusieben)! - Add `CHANGELOG.md` to npm package
+
+- Updated dependencies [[`1d445af`](https://github.com/bluesky-social/atproto/commit/1d445af2a7fc27eca5a45869b29266e6a2a7f3ba), [`1d445af`](https://github.com/bluesky-social/atproto/commit/1d445af2a7fc27eca5a45869b29266e6a2a7f3ba), [`688f9d6`](https://github.com/bluesky-social/atproto/commit/688f9d67597ba96d6e9c4a4aec4d394d42f4cbf4)]:
+  - @atproto/lex-data@0.0.2
+
+## 0.0.1
+
+### Patch Changes
+
+- [#4371](https://github.com/bluesky-social/atproto/pull/4371) [`46550d6`](https://github.com/bluesky-social/atproto/commit/46550d6c1ffb298f57d54eb1904067b2df5a40af) Thanks [@matthieusieben](https://github.com/matthieusieben)! - Release
+
+- Updated dependencies [[`46550d6`](https://github.com/bluesky-social/atproto/commit/46550d6c1ffb298f57d54eb1904067b2df5a40af)]:
+  - @atproto/lex-data@0.0.1

package/dist/encoding.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"encoding.d.ts","sourceRoot":"","sources":["../src/encoding.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAA;AAClD,OAAO,EAAO,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AAyEjD,wBAAgB,MAAM,CAAC,CAAC,SAAS,QAAQ,EAAE,IAAI,EAAE,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAE/D;AAED,wBAAgB,MAAM,CAAC,CAAC,SAAS,QAAQ,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAEhE;AAED,wBAAiB,SAAS,CAAC,CAAC,GAAG,QAAQ,EACrC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,GAChB,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAM7B"}
+{"version":3,"file":"encoding.d.ts","sourceRoot":"","sources":["../src/encoding.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAA;AAClD,OAAO,EAAO,QAAQ,EAAoB,MAAM,mBAAmB,CAAA;AAyEnE,wBAAgB,MAAM,CAAC,CAAC,SAAS,QAAQ,EAAE,IAAI,EAAE,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAE/D;AAED,wBAAgB,MAAM,CAAC,CAAC,SAAS,QAAQ,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAEhE;AAED,wBAAiB,SAAS,CAAC,CAAC,GAAG,QAAQ,EACrC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,GAChB,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAM7B"}

package/dist/index.cjs.js

@@ -1577,7 +1577,7 @@ function decode$1(data, options) {
 }
 const CID_CBOR_TAG = 42;
 function cidEncoder(obj) {
-  const cid = lexData.CID.asCID(obj);
+  const cid = lexData.asCid(obj);
   if (!cid) return null;
   const bytes = new Uint8Array(cid.bytes.byteLength + 1);
   bytes.set(cid.bytes, 1);
@@ -1612,7 +1612,7 @@ function cidDecoder(bytes) {
   if (bytes[0] !== 0) {
     throw new Error("Invalid CID for CBOR tag 42; expected leading 0x00");
   }
-  return lexData.CID.decode(bytes.subarray(1));
+  return lexData.decodeCid(bytes.subarray(1));
 }
 const tagDecoders = [];
 tagDecoders[CID_CBOR_TAG] = cidDecoder;
@@ -1645,11 +1645,11 @@ async function cidForLex(value) {
 }
 async function cidForCbor(bytes) {
   const digest2 = await sha2.sha256.digest(bytes);
-  return lexData.CID.createV1(lexData.DAG_CBOR_MULTICODEC, digest2);
+  return lexData.createCid(lexData.DAG_CBOR_MULTICODEC, digest2);
 }
 async function verifyCidForBytes(cid, bytes) {
   const digest2 = await sha2.sha256.digest(bytes);
-  const expected = lexData.CID.createV1(cid.code, digest2);
+  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()}`
@@ -1658,11 +1658,11 @@ async function verifyCidForBytes(cid, bytes) {
 }
 async function cidForRawBytes(bytes) {
   const digest2 = await sha2.sha256.digest(bytes);
-  return lexData.CID.createV1(lexData.RAW_BIN_MULTICODEC, digest2);
+  return lexData.createCid(lexData.RAW_BIN_MULTICODEC, digest2);
 }
 function cidForRawHash(hash) {
   const digest$1 = digest.create(sha2.sha256.code, hash);
-  return lexData.CID.createV1(lexData.RAW_BIN_MULTICODEC, digest$1);
+  return lexData.createCid(lexData.RAW_BIN_MULTICODEC, digest$1);
 }
 function parseCidFromBytes(cidBytes) {
   const version = cidBytes[0];
@@ -1686,16 +1686,12 @@ function parseCidFromBytes(cidBytes) {
   }
   const hashBytes = cidBytes.slice(4);
   const digest$1 = digest.create(hashType, hashBytes);
-  return lexData.CID.create(version, code, digest$1);
+  return lexData.createCid(code, digest$1);
 }
 Object.defineProperty(exports, "hasher", {
   enumerable: true,
   get: () => sha2.sha256
 });
-Object.defineProperty(exports, "CID", {
-  enumerable: true,
-  get: () => lexData.CID
-});
 exports.cidForCbor = cidForCbor;
 exports.cidForLex = cidForLex;
 exports.cidForRawBytes = cidForRawBytes;

package/dist/index.d.ts

@@ -1,17 +1,17 @@
 import { sha256 as hasher } from 'multiformats/hashes/sha2';
-import { CID, LexValue } from '@atproto/lex-data';
-export { CID, hasher };
+import { Cid, LexValue } from '@atproto/lex-data';
+export { hasher };
 export { decode, decodeAll, encode } from './encoding.js';
-export type { 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;
+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}
+ * @throws if the input do not represent a valid DASL {@link Cid}
  */
-export declare function parseCidFromBytes(cidBytes: Uint8Array): CID;
+export declare function parseCidFromBytes(cidBytes: Uint8Array): Cid;
 //# 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,EAGT,MAAM,mBAAmB,CAAA;AAG1B,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,CAAA;AACtB,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AACzD,YAAY,EAAE,QAAQ,EAAE,CAAA;AAExB,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":"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"}

package/dist/index.es.js

@@ -1,8 +1,7 @@
 import { create } from "multiformats/hashes/digest";
 import { sha256 } from "multiformats/hashes/sha2";
 import { sha256 as sha2562 } from "multiformats/hashes/sha2";
-import { CID, DAG_CBOR_MULTICODEC, RAW_BIN_MULTICODEC, SHA2_256_MULTIHASH_CODE } from "@atproto/lex-data";
-import { CID as CID2 } from "@atproto/lex-data";
+import { decodeCid, asCid, createCid, DAG_CBOR_MULTICODEC, RAW_BIN_MULTICODEC, SHA2_256_MULTIHASH_CODE } from "@atproto/lex-data";
 const typeofs = [
   "string",
   "number",
@@ -1577,7 +1576,7 @@ function decode$1(data, options) {
 }
 const CID_CBOR_TAG = 42;
 function cidEncoder(obj) {
-  const cid = CID.asCID(obj);
+  const cid = asCid(obj);
   if (!cid) return null;
   const bytes = new Uint8Array(cid.bytes.byteLength + 1);
   bytes.set(cid.bytes, 1);
@@ -1612,7 +1611,7 @@ function cidDecoder(bytes) {
   if (bytes[0] !== 0) {
     throw new Error("Invalid CID for CBOR tag 42; expected leading 0x00");
   }
-  return CID.decode(bytes.subarray(1));
+  return decodeCid(bytes.subarray(1));
 }
 const tagDecoders = [];
 tagDecoders[CID_CBOR_TAG] = cidDecoder;
@@ -1645,11 +1644,11 @@ async function cidForLex(value) {
 }
 async function cidForCbor(bytes) {
   const digest = await sha256.digest(bytes);
-  return CID.createV1(DAG_CBOR_MULTICODEC, digest);
+  return createCid(DAG_CBOR_MULTICODEC, digest);
 }
 async function verifyCidForBytes(cid, bytes) {
   const digest = await sha256.digest(bytes);
-  const expected = CID.createV1(cid.code, digest);
+  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()}`
@@ -1658,11 +1657,11 @@ async function verifyCidForBytes(cid, bytes) {
 }
 async function cidForRawBytes(bytes) {
   const digest = await sha256.digest(bytes);
-  return CID.createV1(RAW_BIN_MULTICODEC, digest);
+  return createCid(RAW_BIN_MULTICODEC, digest);
 }
 function cidForRawHash(hash) {
   const digest = create(sha256.code, hash);
-  return CID.createV1(RAW_BIN_MULTICODEC, digest);
+  return createCid(RAW_BIN_MULTICODEC, digest);
 }
 function parseCidFromBytes(cidBytes) {
   const version = cidBytes[0];
@@ -1686,10 +1685,9 @@ function parseCidFromBytes(cidBytes) {
   }
   const hashBytes = cidBytes.slice(4);
   const digest = create(hashType, hashBytes);
-  return CID.create(version, code, digest);
+  return createCid(code, digest);
 }
 export {
-  CID2 as CID,
   cidForCbor,
   cidForLex,
   cidForRawBytes,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atproto/lex-cbor",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "license": "MIT",
   "description": "Lexicon encoding utilities for AT Lexicon data in CBOR format",
   "keywords": [
@@ -19,7 +19,11 @@
   },
   "files": [
     "./src",
-    "./dist"
+    "./tsconfig.build.json",
+    "./tsconfig.tests.json",
+    "./tsconfig.json",
+    "./dist",
+    "./CHANGELOG.md"
   ],
   "sideEffects": false,
   "main": "./dist/index.cjs.js",
@@ -35,13 +39,13 @@
   "dependencies": {
     "multiformats": "^9.9.0",
     "tslib": "^2.8.1",
-    "@atproto/lex-data": "0.0.1"
+    "@atproto/lex-data": "0.0.2"
   },
   "devDependencies": {
     "cborg": "^4.3.0",
     "jest": "^28.1.2",
     "vite": "^6.2.0",
-    "@atproto/lex-json": "0.0.1"
+    "@atproto/lex-json": "0.0.2"
   },
   "scripts": {
     "dev": "vite build --watch",

package/src/encoding.ts

@@ -9,7 +9,7 @@ import {
   encode as cborgEncode,
 } from 'cborg'
 import type { ByteView } from 'multiformats/block'
-import { CID, LexValue } from '@atproto/lex-data'
+import { Cid, LexValue, asCid, decodeCid } 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.
@@ -22,7 +22,7 @@ import { CID, LexValue } from '@atproto/lex-data'
 const CID_CBOR_TAG = 42
 
 function cidEncoder(obj: object): Token[] | null {
-  const cid = CID.asCID(obj)
+  const cid = asCid(obj)
   if (!cid) return null
 
   const bytes = new Uint8Array(cid.bytes.byteLength + 1)
@@ -61,11 +61,11 @@ const encodeOptions: EncodeOptions = {
   },
 }
 
-function cidDecoder(bytes: Uint8Array): CID {
+function cidDecoder(bytes: Uint8Array): Cid {
   if (bytes[0] !== 0) {
     throw new Error('Invalid CID for CBOR tag 42; expected leading 0x00')
   }
-  return CID.decode(bytes.subarray(1)) // ignore leading 0x00
+  return decodeCid(bytes.subarray(1)) // ignore leading 0x00
 }
 
 const tagDecoders: TagDecoder[] = []

package/src/index.ts

@@ -1,30 +1,31 @@
 import { create as createDigest } from 'multiformats/hashes/digest'
 import { sha256 as hasher } from 'multiformats/hashes/sha2'
 import {
-  CID,
+  Cid,
   DAG_CBOR_MULTICODEC,
   LexValue,
   RAW_BIN_MULTICODEC,
   SHA2_256_MULTIHASH_CODE,
+  createCid,
 } from '@atproto/lex-data'
 import { encode } from './encoding.js'
 
-export { CID, hasher }
+export { hasher }
 export { decode, decodeAll, encode } from './encoding.js'
-export type { LexValue }
+export type { Cid, LexValue }
 
-export async function cidForLex(value: LexValue): Promise<CID> {
+export async function cidForLex(value: LexValue): Promise<Cid> {
   return cidForCbor(encode(value))
 }
 
-export async function cidForCbor(bytes: Uint8Array): Promise<CID> {
+export async function cidForCbor(bytes: Uint8Array): Promise<Cid> {
   const digest = await hasher.digest(bytes)
-  return CID.createV1(DAG_CBOR_MULTICODEC, digest)
+  return createCid(DAG_CBOR_MULTICODEC, digest)
 }
 
-export async function verifyCidForBytes(cid: CID, bytes: Uint8Array) {
+export async function verifyCidForBytes(cid: Cid, bytes: Uint8Array) {
   const digest = await hasher.digest(bytes)
-  const expected = CID.createV1(cid.code, digest)
+  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()}`,
@@ -32,22 +33,22 @@ export async function verifyCidForBytes(cid: CID, bytes: Uint8Array) {
   }
 }
 
-export async function cidForRawBytes(bytes: Uint8Array): Promise<CID> {
+export async function cidForRawBytes(bytes: Uint8Array): Promise<Cid> {
   const digest = await hasher.digest(bytes)
-  return CID.createV1(RAW_BIN_MULTICODEC, digest)
+  return createCid(RAW_BIN_MULTICODEC, digest)
 }
 
-export function cidForRawHash(hash: Uint8Array): CID {
+export function cidForRawHash(hash: Uint8Array): Cid {
   const digest = createDigest(hasher.code, hash)
-  return CID.createV1(RAW_BIN_MULTICODEC, digest)
+  return createCid(RAW_BIN_MULTICODEC, digest)
 }
 
 /**
  * @note Only supports DASL CIDs
  * @see {@link https://dasl.ing/cid.html}
- * @throws if the input do not represent a valid DASL {@link CID}
+ * @throws if the input do not represent a valid DASL {@link Cid}
  */
-export function parseCidFromBytes(cidBytes: Uint8Array): CID {
+export function parseCidFromBytes(cidBytes: Uint8Array): Cid {
   const version = cidBytes[0]
   if (version !== 0x01) {
     throw new Error(`Unsupported CID version: ${version}`)
@@ -69,5 +70,5 @@ export function parseCidFromBytes(cidBytes: Uint8Array): CID {
   }
   const hashBytes = cidBytes.slice(4)
   const digest = createDigest(hashType, hashBytes)
-  return CID.create(version, code, digest)
+  return createCid(code, digest)
 }

package/tsconfig.build.json

@@ -0,0 +1,12 @@
+{
+  "extends": ["../../../tsconfig/isomorphic.json"],
+  "include": ["./src"],
+  "exclude": ["**/*.test.ts"],
+  "compilerOptions": {
+    "noImplicitAny": true,
+    "importHelpers": true,
+    "emitDeclarationOnly": true,
+    "rootDir": "./src",
+    "outDir": "./dist"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "include": [],
+  "references": [
+    { "path": "./tsconfig.build.json" },
+    { "path": "./tsconfig.tests.json" }
+  ]
+}

package/tsconfig.tests.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../../tsconfig/tests.json",
+  "include": ["./tests", "./src/**.test.ts"],
+  "compilerOptions": {
+    "noImplicitAny": true,
+    "rootDir": "./",
+    "baseUrl": "./"
+  }
+}