@cbortech/cbor 0.25.6 → 0.25.8

package/dist/types.d.ts

@@ -114,8 +114,10 @@ export interface FromCBOROptions {
      * Allow bytes after the decoded item.
      *
      * When `false`, decoding still requires the item to consume the remaining
-     * input, preserving the historical single-item behaviour. Set this to `true`
-     * when using `CborItem.end` to continue decoding a CBOR Sequence.
+     * input, preserving the historical single-item behaviour. With `strict: false`
+     * a trailing byte becomes a recoverable warning rather than an error, but
+     * truly malformed trailing data (e.g. truncated items) still throws. Set this
+     * to `true` when using `CborItem.end` to continue decoding a CBOR Sequence.
      *
      * @example
      * // Read two items from a CBOR Sequence, validating that the second is last.
@@ -141,7 +143,9 @@ export interface FromCBOROptions {
      *   with a best-effort interpretation of the data.
      *
      * Truly malformed data (e.g. truncated input, reserved AI values) always
-     * throws regardless of this setting.
+     * throws regardless of this setting. Trailing bytes after a successfully
+     * decoded item are a recoverable violation and are therefore controlled by
+     * this flag.
      *
      * @default true
      */
@@ -176,6 +180,27 @@ export interface FromHexDumpOptions {
      * returning a non-`undefined` value replaces the default `CborTag` node.
      */
     extensions?: CborExtension[];
+    /**
+     * Controls how CBOR validity violations are handled during hex-dump decoding.
+     * Mirrors `FromCBOROptions.strict`. With `strict: false`, trailing bytes after
+     * the first decoded item (i.e. a CBOR Sequence) emit a warning instead of
+     * throwing, allowing the first item to be returned.
+     *
+     * @default true
+     */
+    strict?: boolean;
+    /**
+     * Callback invoked when a CBOR validity violation is detected.
+     * Mirrors `FromCBOROptions.onWarning`.
+     */
+    onWarning?: (warning: DecodeWarning) => void;
+    /**
+     * When `true`, suppresses the default `console.warn` output for violations.
+     * Mirrors `FromCBOROptions.silent`.
+     *
+     * @default false
+     */
+    silent?: boolean;
 }
 export interface FromCDNOptions {
     /**
@@ -189,8 +214,11 @@ export interface FromCDNOptions {
      * Allow tokens after the parsed item.
      *
      * When `false`, parsing still requires the item to consume the remaining
-     * input, preserving the historical single-item behaviour. Set this to `true`
-     * when using `CborItem.end` to continue parsing a CDN sequence.
+     * input, preserving the historical single-item behaviour. With `strict: false`
+     * a trailing token becomes a recoverable warning rather than an error, but
+     * hard lexer errors in the trailing content (e.g. unterminated strings) still
+     * throw. Set this to `true` when using `CborItem.end` to continue parsing a
+     * CDN sequence.
      * Top-level comma separators are not skipped by `fromCDN()` itself; handle
      * them in sequence-level code before passing the next `offset`. For example,
      * after parsing `1, 2`, the first item's `end` points just before the comma;
@@ -258,8 +286,10 @@ export interface FromCDNOptions {
      * - `false`: recoverable violations call `onWarning` and parsing continues
      *   with a best-effort interpretation of the input.
      *
-     * Hard syntax errors (e.g. unterminated strings, unexpected tokens) always
-     * throw regardless of this setting.
+     * Hard syntax errors (e.g. unterminated strings, unexpected tokens that
+     * prevent parsing a value) always throw regardless of this setting.
+     * A trailing token after a successfully-parsed value is a recoverable
+     * violation and is therefore controlled by this flag.
      *
      * @default true
      */
@@ -473,6 +503,10 @@ export interface CborComments {
     trailing?: CborComment[];
     dangling?: CborComment[];
 }
+/** `fromCBORSeq()` の options（`offset`/`allowTrailing` はジェネレータが管理するため除外）。 */
+export type FromCBORSeqOptions = Omit<FromCBOROptions, 'offset' | 'allowTrailing'>;
+/** `fromCDNSeq()` の options（`offset`/`allowTrailing` はジェネレータが管理するため除外）。 */
+export type FromCDNSeqOptions = Omit<FromCDNOptions, 'offset' | 'allowTrailing'>;
 /**
  * Combined options for the `CBOR` constructor.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cbortech/cbor",
-  "version": "0.25.6",
+  "version": "0.25.8",
   "description": "Convert between CBOR, CDN (CBOR-EDN), and JavaScript values",
   "keywords": [
     "cbor",
@@ -108,10 +108,10 @@
     "@vitest/coverage-v8": "^4.1.9",
     "@vitest/ui": "^4.1.9",
     "cross-env": "^10.1.0",
-    "playwright": "^1.61.0",
+    "playwright": "^1.61.1",
     "prettier": "^3.8.4",
     "typescript": "^5.9.3",
-    "vite": "^8.0.16",
+    "vite": "^8.1.0",
     "vite-plugin-dts": "^4.5.4",
     "vitest": "^4.1.9"
   }