@atproto/lex-cbor 0.0.3 → 0.0.4

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @atproto/lex-cbor
 
+## 0.0.4
+
+### Patch Changes
+
+- [#4457](https://github.com/bluesky-social/atproto/pull/4457) [`e6b6107`](https://github.com/bluesky-social/atproto/commit/e6b6107e028fee964972274b71f5da1329a7bece) Thanks [@matthieusieben](https://github.com/matthieusieben)! - Throw an error when attempting to encode a float
+
+- Updated dependencies [[`e6b6107`](https://github.com/bluesky-social/atproto/commit/e6b6107e028fee964972274b71f5da1329a7bece), [`e6b6107`](https://github.com/bluesky-social/atproto/commit/e6b6107e028fee964972274b71f5da1329a7bece), [`e6b6107`](https://github.com/bluesky-social/atproto/commit/e6b6107e028fee964972274b71f5da1329a7bece), [`e6b6107`](https://github.com/bluesky-social/atproto/commit/e6b6107e028fee964972274b71f5da1329a7bece), [`e6b6107`](https://github.com/bluesky-social/atproto/commit/e6b6107e028fee964972274b71f5da1329a7bece)]:
+  - @atproto/lex-data@0.0.4
+
 ## 0.0.3
 
 ### Patch Changes

package/dist/encoding.d.ts

@@ -1,6 +1,5 @@
-import type { ByteView } from 'multiformats/block';
 import { LexValue } from '@atproto/lex-data';
-export declare function encode<T extends LexValue>(data: T): ByteView<T>;
-export declare function decode<T extends LexValue>(bytes: ByteView<T>): T;
-export declare function decodeAll<T = LexValue>(data: ByteView<T>): Generator<T, void, unknown>;
+export declare function encode<T extends LexValue = LexValue>(data: T): Uint8Array;
+export declare function decode<T extends LexValue = LexValue>(bytes: Uint8Array): T;
+export declare function decodeAll<T extends LexValue = LexValue>(data: Uint8Array): Generator<T, void, unknown>;
 //# sourceMappingURL=encoding.d.ts.map

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,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"}
+{"version":3,"file":"encoding.d.ts","sourceRoot":"","sources":["../src/encoding.ts"],"names":[],"mappings":"AAUA,OAAO,EAAO,QAAQ,EAAoB,MAAM,mBAAmB,CAAA;AAsFnE,wBAAgB,MAAM,CAAC,CAAC,SAAS,QAAQ,GAAG,QAAQ,EAAE,IAAI,EAAE,CAAC,GAAG,UAAU,CAEzE;AAED,wBAAgB,MAAM,CAAC,CAAC,SAAS,QAAQ,GAAG,QAAQ,EAAE,KAAK,EAAE,UAAU,GAAG,CAAC,CAE1E;AAED,wBAAiB,SAAS,CAAC,CAAC,SAAS,QAAQ,GAAG,QAAQ,EACtD,IAAI,EAAE,UAAU,GACf,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAM7B"}

package/dist/index.cjs

@@ -1576,18 +1576,21 @@ function decode$1(data, options) {
   return decoded;
 }
 const CID_CBOR_TAG = 42;
-function cidEncoder(obj) {
-  const cid = lexData.asCid(obj);
-  if (!cid) return null;
+function cidEncoder(cid) {
   const bytes = new Uint8Array(cid.bytes.byteLength + 1);
   bytes.set(cid.bytes, 1);
   return [new Token(Type.tag, CID_CBOR_TAG), new Token(Type.bytes, bytes)];
 }
+function objectEncoder(obj, _typ, _options) {
+  const cid = lexData.asCid(obj);
+  if (cid) return cidEncoder(cid);
+  return null;
+}
 function undefinedEncoder() {
   throw new Error("`undefined` is not allowed by the AT Data Model");
 }
 function numberEncoder(num) {
-  if (Number.isInteger(num)) return null;
+  if (Number.isInteger(num) && Number.isSafeInteger(num)) return null;
   throw new Error("Non-integer numbers are not allowed by the AT Data Model");
 }
 function mapEncoder(map) {
@@ -1601,9 +1604,10 @@ function mapEncoder(map) {
   return null;
 }
 const encodeOptions = {
+  float64: true,
   typeEncoders: {
     Map: mapEncoder,
-    Object: cidEncoder,
+    Object: objectEncoder,
     undefined: undefinedEncoder,
     number: numberEncoder
   }

package/dist/index.mjs

@@ -1575,18 +1575,21 @@ function decode$1(data, options) {
   return decoded;
 }
 const CID_CBOR_TAG = 42;
-function cidEncoder(obj) {
-  const cid = asCid(obj);
-  if (!cid) return null;
+function cidEncoder(cid) {
   const bytes = new Uint8Array(cid.bytes.byteLength + 1);
   bytes.set(cid.bytes, 1);
   return [new Token(Type.tag, CID_CBOR_TAG), new Token(Type.bytes, bytes)];
 }
+function objectEncoder(obj, _typ, _options) {
+  const cid = asCid(obj);
+  if (cid) return cidEncoder(cid);
+  return null;
+}
 function undefinedEncoder() {
   throw new Error("`undefined` is not allowed by the AT Data Model");
 }
 function numberEncoder(num) {
-  if (Number.isInteger(num)) return null;
+  if (Number.isInteger(num) && Number.isSafeInteger(num)) return null;
   throw new Error("Non-integer numbers are not allowed by the AT Data Model");
 }
 function mapEncoder(map) {
@@ -1600,9 +1603,10 @@ function mapEncoder(map) {
   return null;
 }
 const encodeOptions = {
+  float64: true,
   typeEncoders: {
     Map: mapEncoder,
-    Object: cidEncoder,
+    Object: objectEncoder,
     undefined: undefinedEncoder,
     number: numberEncoder
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atproto/lex-cbor",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "license": "MIT",
   "description": "Lexicon encoding utilities for AT Lexicon data in CBOR format",
   "keywords": [
@@ -39,13 +39,13 @@
   "dependencies": {
     "multiformats": "^9.9.0",
     "tslib": "^2.8.1",
-    "@atproto/lex-data": "0.0.3"
+    "@atproto/lex-data": "0.0.4"
   },
   "devDependencies": {
     "cborg": "^4.3.0",
     "jest": "^28.1.2",
     "vite": "^6.2.0",
-    "@atproto/lex-json": "0.0.3"
+    "@atproto/lex-json": "0.0.4"
   },
   "scripts": {
     "dev": "vite build --watch",

package/src/encoding.ts

@@ -8,7 +8,6 @@ import {
   decodeFirst as cborgDecodeFirst,
   encode as cborgEncode,
 } from 'cborg'
-import type { ByteView } from 'multiformats/block'
 import { Cid, LexValue, asCid, decodeCid } from '@atproto/lex-data'
 
 // @NOTE This was inspired by @ipld/dag-cbor implementation, but adapted to
@@ -21,21 +20,33 @@ import { Cid, LexValue, asCid, decodeCid } from '@atproto/lex-data'
 
 const CID_CBOR_TAG = 42
 
-function cidEncoder(obj: object): Token[] | null {
-  const cid = asCid(obj)
-  if (!cid) return null
-
+function cidEncoder(cid: Cid): Token[] {
   const bytes = new Uint8Array(cid.bytes.byteLength + 1)
   bytes.set(cid.bytes, 1) // prefix is 0x00, for historical reasons
   return [new Token(Type.tag, CID_CBOR_TAG), new Token(Type.bytes, bytes)]
 }
 
+function objectEncoder(
+  obj: object,
+  _typ: string,
+  _options: EncodeOptions,
+): Token[] | null {
+  const cid = asCid(obj)
+  if (cid) return cidEncoder(cid)
+
+  // @TODO strip undefined values somehow
+  // https://github.com/rvagg/cborg/issues/154
+
+  // Fallback to default object encoder
+  return null
+}
+
 function undefinedEncoder(): null {
   throw new Error('`undefined` is not allowed by the AT Data Model')
 }
 
 function numberEncoder(num: number): null {
-  if (Number.isInteger(num)) return null
+  if (Number.isInteger(num) && Number.isSafeInteger(num)) return null
 
   throw new Error('Non-integer numbers are not allowed by the AT Data Model')
 }
@@ -53,9 +64,10 @@ function mapEncoder(map: Map<unknown, unknown>): null {
 }
 
 const encodeOptions: EncodeOptions = {
+  float64: true,
   typeEncoders: {
     Map: mapEncoder,
-    Object: cidEncoder,
+    Object: objectEncoder,
     undefined: undefinedEncoder,
     number: numberEncoder,
   },
@@ -82,16 +94,16 @@ const decodeOptions: DecodeOptions = {
   tags: tagDecoders,
 }
 
-export function encode<T extends LexValue>(data: T): ByteView<T> {
+export function encode<T extends LexValue = LexValue>(data: T): Uint8Array {
   return cborgEncode(data, encodeOptions)
 }
 
-export function decode<T extends LexValue>(bytes: ByteView<T>): T {
+export function decode<T extends LexValue = LexValue>(bytes: Uint8Array): T {
   return cborgDecode(bytes, decodeOptions)
 }
 
-export function* decodeAll<T = LexValue>(
-  data: ByteView<T>,
+export function* decodeAll<T extends LexValue = LexValue>(
+  data: Uint8Array,
 ): Generator<T, void, unknown> {
   do {
     const [result, remainingBytes] = cborgDecodeFirst(data, decodeOptions)

package/tsconfig.tests.json

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