@stryke/json 0.9.16 → 0.9.24

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stryke/json",
-  "version": "0.9.16",
+  "version": "0.9.24",
   "type": "module",
   "description": "A package containing JSON parsing/stringify utilities used by Storm Software.",
   "repository": {
@@ -9,254 +9,60 @@
     "directory": "packages/json"
   },
   "private": false,
-  "dependencies": {
-    "buffer": "6.0.3",
-    "lines-and-columns": "2.0.4",
-    "superjson": "2.2.2",
-    "@stryke/type-checks": "^0.4.4",
-    "@stryke/types": "^0.10.13"
-  },
-  "devDependencies": { "@types/node": "^24.10.1" },
-  "publishConfig": { "access": "public" },
-  "sideEffects": false,
-  "files": ["dist/**/*"],
-  "homepage": "https://stormsoftware.com",
-  "bugs": {
-    "url": "https://stormsoftware.com/support",
-    "email": "support@stormsoftware.com"
-  },
-  "license": "Apache-2.0",
-  "keywords": [
-    "stryke",
-    "typescript",
-    "utilities",
-    "storm-software",
-    "storm",
-    "storm-ops",
-    "cyclone-ui",
-    "sullivanpj",
-    "monorepo"
-  ],
-  "funding": {
-    "type": "github",
-    "url": "https://github.com/sponsors/storm-software"
-  },
-  "author": {
-    "name": "Storm Software",
-    "email": "contact@stormsoftware.com",
-    "url": "https://stormsoftware.com"
-  },
-  "maintainers": [
-    {
-      "name": "Storm Software",
-      "email": "contact@stormsoftware.com",
-      "url": "https://stormsoftware.com"
-    }
-  ],
-  "contributors": [
-    {
-      "name": "Storm Software",
-      "email": "contact@stormsoftware.com",
-      "url": "https://stormsoftware.com"
-    }
-  ],
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
   "exports": {
-    "./types": {
-      "import": { "types": "./dist/types.d.ts", "default": "./dist/types.mjs" },
-      "require": {
-        "types": "./dist/types.d.ts",
-        "default": "./dist/types.cjs"
-      },
-      "default": { "types": "./dist/types.d.ts", "default": "./dist/types.mjs" }
-    },
-    "./storm-json": {
-      "import": {
-        "types": "./dist/storm-json.d.ts",
-        "default": "./dist/storm-json.mjs"
-      },
-      "require": {
-        "types": "./dist/storm-json.d.ts",
-        "default": "./dist/storm-json.cjs"
-      },
-      "default": {
-        "types": "./dist/storm-json.d.ts",
-        "default": "./dist/storm-json.mjs"
-      }
-    },
-    "./index": {
-      "import": { "types": "./dist/index.d.ts", "default": "./dist/index.mjs" },
-      "require": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.cjs"
-      },
-      "default": { "types": "./dist/index.d.ts", "default": "./dist/index.mjs" }
-    },
-    "./utils/strip-comments": {
-      "import": {
-        "types": "./dist/utils/strip-comments.d.ts",
-        "default": "./dist/utils/strip-comments.mjs"
-      },
-      "require": {
-        "types": "./dist/utils/strip-comments.d.ts",
-        "default": "./dist/utils/strip-comments.cjs"
-      },
-      "default": {
-        "types": "./dist/utils/strip-comments.d.ts",
-        "default": "./dist/utils/strip-comments.mjs"
-      }
+    ".": { "require": "./dist/index.cjs", "import": "./dist/index.mjs" },
+    "./pointer": {
+      "require": "./dist/pointer/index.cjs",
+      "import": "./dist/pointer/index.mjs"
     },
-    "./utils/stringify": {
-      "import": {
-        "types": "./dist/utils/stringify.d.ts",
-        "default": "./dist/utils/stringify.mjs"
-      },
-      "require": {
-        "types": "./dist/utils/stringify.d.ts",
-        "default": "./dist/utils/stringify.cjs"
-      },
-      "default": {
-        "types": "./dist/utils/stringify.d.ts",
-        "default": "./dist/utils/stringify.mjs"
-      }
+    "./pointer/find-reference": {
+      "require": "./dist/pointer/find-reference.cjs",
+      "import": "./dist/pointer/find-reference.mjs"
     },
-    "./utils/parse": {
-      "import": {
-        "types": "./dist/utils/parse.d.ts",
-        "default": "./dist/utils/parse.mjs"
-      },
-      "require": {
-        "types": "./dist/utils/parse.d.ts",
-        "default": "./dist/utils/parse.cjs"
-      },
-      "default": {
-        "types": "./dist/utils/parse.d.ts",
-        "default": "./dist/utils/parse.mjs"
-      }
+    "./pointer/parse": {
+      "require": "./dist/pointer/parse.cjs",
+      "import": "./dist/pointer/parse.mjs"
     },
-    "./utils/parse-error": {
-      "import": {
-        "types": "./dist/utils/parse-error.d.ts",
-        "default": "./dist/utils/parse-error.mjs"
-      },
-      "require": {
-        "types": "./dist/utils/parse-error.d.ts",
-        "default": "./dist/utils/parse-error.cjs"
-      },
-      "default": {
-        "types": "./dist/utils/parse-error.d.ts",
-        "default": "./dist/utils/parse-error.mjs"
-      }
+    "./storm-json": {
+      "require": "./dist/storm-json.cjs",
+      "import": "./dist/storm-json.mjs"
     },
-    "./utils/index": {
-      "import": {
-        "types": "./dist/utils/index.d.ts",
-        "default": "./dist/utils/index.mjs"
-      },
-      "require": {
-        "types": "./dist/utils/index.d.ts",
-        "default": "./dist/utils/index.cjs"
-      },
-      "default": {
-        "types": "./dist/utils/index.d.ts",
-        "default": "./dist/utils/index.mjs"
-      }
+    "./types": { "require": "./dist/types.cjs", "import": "./dist/types.mjs" },
+    "./utils": {
+      "require": "./dist/utils/index.cjs",
+      "import": "./dist/utils/index.mjs"
     },
     "./utils/code-frames": {
-      "import": {
-        "types": "./dist/utils/code-frames.d.ts",
-        "default": "./dist/utils/code-frames.mjs"
-      },
-      "require": {
-        "types": "./dist/utils/code-frames.d.ts",
-        "default": "./dist/utils/code-frames.cjs"
-      },
-      "default": {
-        "types": "./dist/utils/code-frames.d.ts",
-        "default": "./dist/utils/code-frames.mjs"
-      }
-    },
-    "./pointer/parse": {
-      "import": {
-        "types": "./dist/pointer/parse.d.ts",
-        "default": "./dist/pointer/parse.mjs"
-      },
-      "require": {
-        "types": "./dist/pointer/parse.d.ts",
-        "default": "./dist/pointer/parse.cjs"
-      },
-      "default": {
-        "types": "./dist/pointer/parse.d.ts",
-        "default": "./dist/pointer/parse.mjs"
-      }
+      "require": "./dist/utils/code-frames.cjs",
+      "import": "./dist/utils/code-frames.mjs"
     },
-    "./pointer/index": {
-      "import": {
-        "types": "./dist/pointer/index.d.ts",
-        "default": "./dist/pointer/index.mjs"
-      },
-      "require": {
-        "types": "./dist/pointer/index.d.ts",
-        "default": "./dist/pointer/index.cjs"
-      },
-      "default": {
-        "types": "./dist/pointer/index.d.ts",
-        "default": "./dist/pointer/index.mjs"
-      }
-    },
-    "./pointer/find-reference": {
-      "import": {
-        "types": "./dist/pointer/find-reference.d.ts",
-        "default": "./dist/pointer/find-reference.mjs"
-      },
-      "require": {
-        "types": "./dist/pointer/find-reference.d.ts",
-        "default": "./dist/pointer/find-reference.cjs"
-      },
-      "default": {
-        "types": "./dist/pointer/find-reference.d.ts",
-        "default": "./dist/pointer/find-reference.mjs"
-      }
+    "./utils/parse": {
+      "require": "./dist/utils/parse.cjs",
+      "import": "./dist/utils/parse.mjs"
     },
-    ".": {
-      "import": { "types": "./dist/index.d.ts", "default": "./dist/index.mjs" },
-      "require": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.cjs"
-      },
-      "default": { "types": "./dist/index.d.ts", "default": "./dist/index.mjs" }
+    "./utils/parse-error": {
+      "require": "./dist/utils/parse-error.cjs",
+      "import": "./dist/utils/parse-error.mjs"
     },
-    "./utils": {
-      "import": {
-        "types": "./dist/utils/index.d.ts",
-        "default": "./dist/utils/index.mjs"
-      },
-      "require": {
-        "types": "./dist/utils/index.d.ts",
-        "default": "./dist/utils/index.cjs"
-      },
-      "default": {
-        "types": "./dist/utils/index.d.ts",
-        "default": "./dist/utils/index.mjs"
-      }
+    "./utils/stringify": {
+      "require": "./dist/utils/stringify.cjs",
+      "import": "./dist/utils/stringify.mjs"
     },
-    "./pointer": {
-      "import": {
-        "types": "./dist/pointer/index.d.ts",
-        "default": "./dist/pointer/index.mjs"
-      },
-      "require": {
-        "types": "./dist/pointer/index.d.ts",
-        "default": "./dist/pointer/index.cjs"
-      },
-      "default": {
-        "types": "./dist/pointer/index.d.ts",
-        "default": "./dist/pointer/index.mjs"
-      }
+    "./utils/strip-comments": {
+      "require": "./dist/utils/strip-comments.cjs",
+      "import": "./dist/utils/strip-comments.mjs"
     },
-    "./package.json": "./package.json"
+    "./*": "./*"
   },
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.ts",
-  "gitHead": "eb28313b3230b7ea654c87586ca07773e2e57f52"
+  "types": "./dist/index.d.cts",
+  "dependencies": {
+    "buffer": "6.0.3",
+    "lines-and-columns": "2.0.4",
+    "superjson": "2.2.2"
+  },
+  "devDependencies": { "@types/node": "^24.10.1", "tsdown": "^0.17.1" },
+  "publishConfig": { "access": "public" },
+  "gitHead": "e9fb3e13aebac54518fd668cecdd3dd89540d34e"
 }

package/dist/index.d.ts

@@ -1,11 +0,0 @@
-/**
- * The JSON library used by Storm Software for building TypeScript applications.
- *
- * @remarks
- * A package containing JSON parsing/stringify utilities used by Storm Software
- *
- * @packageDocumentation
- */
-export * from "./storm-json";
-export * from "./types";
-export * from "./utils";

package/dist/pointer/find-reference.d.ts

@@ -1,48 +0,0 @@
-export interface Reference {
-    /** Target value where pointer is pointing. */
-    readonly val: unknown;
-    /** Object which contains the target value. */
-    readonly obj?: unknown | object | unknown[];
-    /** Key which targets the target value in the object. */
-    readonly key?: string | number;
-}
-/**
- * Finds a target in document specified by JSON Pointer. Also returns the
- * object containing the target and key used to reference that object.
- *
- * Throws Error('NOT_FOUND') if pointer does not result into a value in the middle
- * of the path. If the last element of the path does not result into a value, the
- * lookup succeeds with `val` set to `undefined`. It can be used to discriminate
- * missing values, because `undefined` is not a valid JSON value.
- *
- * If last element in array is targeted using "-", e.g. "/arr/-", use
- * `isArrayEnd` to verify that:
- *
- * ```js
- * const ref = find({arr: [1, 2, 3], ['arr', '-']});
- * if (isArrayReference(ref)) {
- *   if (isArrayEnd(ref)) {
- *     // ...
- *   }
- * }
- * ```
- *
- * @param val - Document to search in.
- * @param path - JSON Pointer path.
- * @returns Reference to the target.
- */
-export declare const find: (val: unknown, path: Reference["key"][]) => Reference;
-export interface ArrayReference<T = unknown> {
-    /** `undefined` in case JSON Pointer points to last element, e.g. "/foo/-". */
-    readonly val: undefined | T;
-    readonly obj: T[];
-    readonly key: number;
-}
-export declare const isArrayReference: <T = unknown>(ref: Reference) => ref is ArrayReference<T>;
-export declare const isArrayEnd: (ref: ArrayReference) => boolean;
-export interface ObjectReference<T = unknown> {
-    readonly val: T;
-    readonly obj: Record<string, T>;
-    readonly key: string;
-}
-export declare const isObjectReference: <T = unknown>(ref: Reference) => ref is ObjectReference<T>;

package/dist/pointer/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./find-reference";
-export * from "./parse";

package/dist/pointer/parse.d.ts

@@ -1,38 +0,0 @@
-import type { JsonPointerPath } from "@stryke/types/json";
-/**
- * Escapes a JSON pointer path segment.
- *
- * @param segment - JSON pointer path segment.
- * @returns Escaped JSON pointer path segment.
- */
-export declare function escapePointerSegment(segment: string): string;
-/**
- * Unescapes a JSON pointer path segment.
- *
- * @param segment - JSON pointer path segment.
- * @returns Unescaped JSON pointer path segment.
- */
-export declare function unescapePointerSegment(segment: string): string;
-/**
- * Convert JSON pointer like "/foo/bar" to array like ["", "foo", "bar"], while
- * also un-escaping reserved characters.
- */
-export declare function parseJsonPointer(pointer: string): JsonPointerPath;
-/**
- * Escape and format a path array like ["", "foo", "bar"] to JSON pointer
- * like "/foo/bar".
- */
-export declare function formatJsonPointer(path: JsonPointerPath): string;
-/**
- * Returns true if JSON Pointer points to root value, false otherwise.
- */
-export declare const isRoot: (path: string | number | JsonPointerPath) => boolean;
-/**
- * Returns parent path, e.g. for ['foo', 'bar', 'baz'] returns ['foo', 'bar'].
- */
-export declare function parent(path: JsonPointerPath): JsonPointerPath;
-/**
- * Check if path component can be a valid array index.
- */
-export declare function isValidIndex(index: string | number): boolean;
-export declare const isInteger: (str: string) => boolean;

package/dist/storm-json.d.ts

@@ -1,64 +0,0 @@
-import type { Class, JsonParseOptions, JsonParserResult, JsonSerializeOptions, JsonValue } from "./types";
-import SuperJSON from "superjson";
-/**
- * A static JSON parser class used by Storm Software to serialize and deserialize JSON data
- *
- * @remarks
- * This class uses the [SuperJSON](https://github.com/blitz-js/superjson) library under the hood.
- */
-export declare class StormJSON extends SuperJSON {
-    #private;
-    static get instance(): StormJSON;
-    /**
-     * Deserialize the given value with superjson using the given metadata
-     */
-    static deserialize<TData = unknown>(payload: JsonParserResult): TData;
-    /**
-     * Serialize the given value with superjson
-     */
-    static serialize(object: JsonValue): JsonParserResult;
-    /**
-     * Parse the given string value with superjson using the given metadata
-     *
-     * @param value - The string value to parse
-     * @returns The parsed data
-     */
-    static parse<TData = unknown>(value: string): TData;
-    /**
-     * Serializes the given data to a JSON string.
-     * By default the JSON string is formatted with a 2 space indentation to be easy readable.
-     *
-     * @param value - Object which should be serialized to JSON
-     * @param _options - JSON serialize options
-     * @returns the formatted JSON representation of the object
-     */
-    static stringify<T>(value: T, _options?: JsonSerializeOptions): string;
-    /**
-     * Parses the given JSON string and returns the object the JSON content represents.
-     * By default javascript-style comments and trailing commas are allowed.
-     *
-     * @param strData - JSON content as string
-     * @param options - JSON parse options
-     * @returns Object the JSON content represents
-     */
-    static parseJson<TData = unknown>(strData: string, options?: JsonParseOptions): TData;
-    /**
-     * Register a custom schema with superjson
-     *
-     * @param name - The name of the schema
-     * @param serialize - The function to serialize the schema
-     * @param deserialize - The function to deserialize the schema
-     * @param isApplicable - The function to check if the schema is applicable
-     */
-    static register<TData = any, TJsonObject extends JsonValue = JsonValue>(name: string, serialize: (data: TData) => TJsonObject, deserialize: (json: TJsonObject) => TData, isApplicable: (data: any) => data is TData): void;
-    /**
-     * Register a class with superjson
-     *
-     * @param classConstructor - The class constructor to register
-     */
-    static registerClass(classConstructor: Class, options?: {
-        identifier?: string;
-        allowProps?: string[];
-    } | string): void;
-    private constructor();
-}

package/dist/types.d.ts

@@ -1,64 +0,0 @@
-import type { ParseOptions } from "jsonc-parser";
-export type PrimitiveJsonValue = string | number | boolean | undefined | null;
-export interface Class {
-    new (...args: any[]): any;
-}
-export type JsonValue = PrimitiveJsonValue | JsonArray | JsonObject;
-export type JsonArray = Array<JsonValue>;
-export interface JsonObject {
-    [key: string]: JsonValue;
-}
-export type ClassInstance = any;
-export type SerializableJsonValue = symbol | Set<JsonValue> | Map<JsonValue, JsonValue> | undefined | bigint | Date | ClassInstance | RegExp;
-export type Tree<T> = InnerNode<T> | Leaf<T>;
-export type Leaf<T> = [T];
-export type InnerNode<T> = [T, Record<string, Tree<T>>];
-export type PrimitiveTypeAnnotation = "number" | "undefined" | "bigint";
-export type LeafTypeAnnotation = PrimitiveTypeAnnotation | "regexp" | "Date" | "Error" | "URL";
-export type TypedArrayAnnotation = ["typed-array", string];
-export type ClassTypeAnnotation = ["class", string];
-export type SymbolTypeAnnotation = ["symbol", string];
-export type CustomTypeAnnotation = ["custom", string];
-export type SimpleTypeAnnotation = LeafTypeAnnotation | "map" | "set";
-export type CompositeTypeAnnotation = TypedArrayAnnotation | ClassTypeAnnotation | SymbolTypeAnnotation | CustomTypeAnnotation;
-export type TypeAnnotation = SimpleTypeAnnotation | CompositeTypeAnnotation;
-export interface JsonParseOptions extends ParseOptions {
-    /**
-     * Expect JSON with javascript-style
-     *
-     * @defaultValue false
-     */
-    expectComments?: boolean;
-    /**
-     * Disallow javascript-style
-     *
-     * @defaultValue false
-     */
-    disallowComments?: boolean;
-    /**
-     * Allow trailing commas in the JSON content
-     */
-    allowTrailingComma?: boolean;
-}
-export interface JsonSerializeOptions {
-    /**
-     * the whitespaces to add as indentation to make the output more readable.
-     *
-     * @defaultValue 2
-     */
-    spaces?: number;
-}
-export interface JsonParserResult {
-    json: JsonValue;
-    meta?: {
-        values?: Tree<TypeAnnotation> | Record<string, Tree<TypeAnnotation>> | undefined;
-        referentialEqualities?: Record<string, string[]> | [string[]] | [string[], Record<string, string[]>];
-    };
-}
-export interface JsonParserInterface {
-    parse: <TData = any>(strData: string) => TData;
-    stringify: <TData = any>(data: TData) => string;
-    serialize: (object: JsonValue) => JsonParserResult;
-    deserialize: <TData = any>(payload: JsonParserResult) => TData;
-    register: <TData = any, TJsonValue extends JsonValue = JsonValue>(name: string, serialize: (object: JsonValue) => TJsonValue, deserialize: (payload: TJsonValue) => TData, isApplicable: (data: any) => data is TData) => void;
-}

package/dist/utils/code-frames.d.ts

@@ -1,14 +0,0 @@
-interface Location {
-    column: number;
-    line: number;
-}
-interface NodeLocation {
-    end?: Location;
-    start?: Location;
-}
-export declare function codeFrameColumns(rawLines: string, loc: NodeLocation, opts?: {
-    linesAbove?: number;
-    linesBelow?: number;
-    highlight?: (rawLines: string) => string;
-}): string;
-export {};

package/dist/utils/index.d.ts

@@ -1,5 +0,0 @@
-export * from "./code-frames";
-export * from "./parse";
-export * from "./parse-error";
-export * from "./stringify";
-export * from "./strip-comments";

package/dist/utils/parse-error.d.ts

@@ -1,9 +0,0 @@
-import type { ParseError } from "jsonc-parser";
-/**
- * Nicely formats a JSON error with context
- *
- * @param input - JSON content as string
- * @param parseError - jsonc ParseError
- * @returns
- */
-export declare function formatParseError(input: string, parseError: ParseError): string;

package/dist/utils/parse.d.ts

@@ -1,5 +0,0 @@
-export interface Options {
-    strict?: boolean;
-}
-export declare function parse<T = unknown>(value: any, options?: Options): T;
-export declare function safeParse<T = unknown>(value: any, options?: Options): T;

package/dist/utils/stringify.d.ts

@@ -1,9 +0,0 @@
-export declare const invalidKeyChars: readonly ["@", "/", "#", "$", " ", ":", ";", ",", ".", "!", "?", "&", "=", "+", "-", "*", "%", "^", "~", "|", "\\", "\"", "'", "`", "{", "}", "[", "]", "(", ")", "<", ">"];
-/**
- * Stringify a value to a JSON-like string.
- *
- * @param value - The value to stringify
- * @param spacing - The spacing to use for the stringification
- * @returns The stringified value
- */
-export declare const stringify: (value: unknown, spacing?: string | number) => string;

package/dist/utils/strip-comments.d.ts

@@ -1,4 +0,0 @@
-export declare function stripComments(value: string, { whitespace, trailingCommas }?: {
-    whitespace?: boolean | undefined;
-    trailingCommas?: boolean | undefined;
-}): string;