@stryke/json 0.2.1 → 0.3.0

package/dist/storm-json.cjs

@@ -10,57 +10,54 @@ var _buffer = require("buffer/");
 var _jsoncParser = require("jsonc-parser");
 var _superjson = _interopRequireDefault(require("superjson"));
 var _parseError = require("./utils/parse-error.cjs");
-var _stringifyMin = require("./utils/stringify-min.cjs");
+var _stringifyJson = require("./utils/stringify-json.cjs");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 class StormJSON extends _superjson.default {
-  static #r;
+  static #e;
   static get instance() {
-    return StormJSON.#r || (StormJSON.#r = new StormJSON()), StormJSON.#r;
+    return StormJSON.#e || (StormJSON.#e = new StormJSON()), StormJSON.#e;
   }
-  static deserialize(r) {
-    return StormJSON.instance.deserialize(r);
+  static deserialize(e) {
+    return StormJSON.instance.deserialize(e);
   }
-  static serialize(r) {
-    return StormJSON.instance.serialize(r);
+  static serialize(e) {
+    return StormJSON.instance.serialize(e);
   }
-  static parse(r) {
-    return StormJSON.instance.parse(r);
+  static parse(e) {
+    return StormJSON.instance.parse(e);
   }
-  static stringifyMin(r) {
-    const e = StormJSON.instance.customTransformerRegistry.findApplicable(r);
-    let s = r;
-    return e && (s = e.serialize(s)), (0, _stringifyMin.stringifyMin)(s);
+  static stringifyJson(e, r) {
+    const s = StormJSON.instance.customTransformerRegistry.findApplicable(e);
+    let t = e;
+    return s && (t = s.serialize(t)), (0, _stringifyJson.stringifyJson)(t?.json ? t?.json : t, r?.spaces);
   }
-  static stringify(r) {
-    return StormJSON.instance.stringify(r);
+  static stringify(e) {
+    return StormJSON.instance.stringify(e);
   }
-  static stringifyJson(r) {
-    return StormJSON.instance.stringify(r);
-  }
-  static parseJson(r, e) {
+  static parseJson(e, r) {
     try {
-      if (e?.expectComments === !1) return StormJSON.instance.parse(r);
+      if (r?.expectComments === !1) return StormJSON.instance.parse(e);
     } catch {}
     const s = [],
-      i = {
+      t = {
         allowTrailingComma: !0,
-        ...e
+        ...r
       },
-      n = (0, _jsoncParser.parse)(r, s, i);
-    if (s.length > 0 && s[0]) throw new Error((0, _parseError.formatParseError)(r, s[0]));
+      n = (0, _jsoncParser.parse)(e, s, t);
+    if (s.length > 0 && s[0]) throw new Error((0, _parseError.formatParseError)(e, s[0]));
     return n;
   }
-  static register(r, e, s, i) {
+  static register(e, r, s, t) {
     StormJSON.instance.registerCustom({
-      isApplicable: i,
-      serialize: e,
+      isApplicable: t,
+      serialize: r,
       deserialize: s
-    }, r);
+    }, e);
   }
-  static registerClass(r, e) {
-    StormJSON.instance.registerClass(r, {
-      identifier: (0, _isString.isString)(e) ? e : e?.identifier || r.name,
-      allowProps: e && (0, _isObject.isObject)(e) && e?.allowProps && Array.isArray(e.allowProps) ? e.allowProps : ["__typename"]
+  static registerClass(e, r) {
+    StormJSON.instance.registerClass(e, {
+      identifier: (0, _isString.isString)(r) ? r : r?.identifier || e.name,
+      allowProps: r && (0, _isObject.isObject)(r) && r?.allowProps && Array.isArray(r.allowProps) ? r.allowProps : ["__typename"]
     });
   }
   constructor() {
@@ -71,7 +68,7 @@ class StormJSON extends _superjson.default {
 }
 exports.StormJSON = StormJSON;
 StormJSON.instance.registerCustom({
-  isApplicable: t => _buffer.Buffer.isBuffer(t),
-  serialize: t => t.toString("base64"),
-  deserialize: t => _buffer.Buffer.from(t, "base64")
+  isApplicable: i => _buffer.Buffer.isBuffer(i),
+  serialize: i => i.toString("base64"),
+  deserialize: i => _buffer.Buffer.from(i, "base64")
 }, "Bytes");

package/dist/storm-json.d.ts

@@ -1,4 +1,4 @@
-import type { Class, JsonParseOptions, JsonParserResult, JsonValue } from "./types";
+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
@@ -27,10 +27,14 @@ export declare class StormJSON extends SuperJSON {
      */
     static parse<TData = unknown>(value: string): TData;
     /**
-     * Stringify the given value with superjson
+     * 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 json - Object which should be serialized to JSON
+     * @param options - JSON serialize options
+     * @returns the formatted JSON representation of the object
      */
-    static stringifyMin(obj: any): string;
+    static stringifyJson<TJson>(json: TJson, options?: JsonSerializeOptions): string;
     /**
      * Stringify the given value with superjson
      *
@@ -38,14 +42,6 @@ export declare class StormJSON extends SuperJSON {
      * @returns The stringified object
      */
     static stringify(obj: any): string;
-    /**
-     * 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 json - Object which should be serialized to JSON
-     * @returns the formatted JSON representation of the object
-     */
-    static stringifyJson(json: any): string;
     /**
      * Parses the given JSON string and returns the object the JSON content represents.
      * By default javascript-style comments and trailing commas are allowed.

package/dist/storm-json.mjs

@@ -1 +1 @@
-import{isObject as o}from"@stryke/types/type-checks/is-object";import{isString as c}from"@stryke/types/type-checks/is-string";import{Buffer as a}from"buffer/";import{parse as l}from"jsonc-parser";import u from"superjson";import{formatParseError as p}from"./utils/parse-error";import{stringifyMin as f}from"./utils/stringify-min";export class StormJSON extends u{static#r;static get instance(){return StormJSON.#r||(StormJSON.#r=new StormJSON),StormJSON.#r}static deserialize(r){return StormJSON.instance.deserialize(r)}static serialize(r){return StormJSON.instance.serialize(r)}static parse(r){return StormJSON.instance.parse(r)}static stringifyMin(r){const e=StormJSON.instance.customTransformerRegistry.findApplicable(r);let s=r;return e&&(s=e.serialize(s)),f(s)}static stringify(r){return StormJSON.instance.stringify(r)}static stringifyJson(r){return StormJSON.instance.stringify(r)}static parseJson(r,e){try{if(e?.expectComments===!1)return StormJSON.instance.parse(r)}catch{}const s=[],i={allowTrailingComma:!0,...e},n=l(r,s,i);if(s.length>0&&s[0])throw new Error(p(r,s[0]));return n}static register(r,e,s,i){StormJSON.instance.registerCustom({isApplicable:i,serialize:e,deserialize:s},r)}static registerClass(r,e){StormJSON.instance.registerClass(r,{identifier:c(e)?e:e?.identifier||r.name,allowProps:e&&o(e)&&e?.allowProps&&Array.isArray(e.allowProps)?e.allowProps:["__typename"]})}constructor(){super({dedupe:!0})}}StormJSON.instance.registerCustom({isApplicable:t=>a.isBuffer(t),serialize:t=>t.toString("base64"),deserialize:t=>a.from(t,"base64")},"Bytes");
+import{isObject as o}from"@stryke/types/type-checks/is-object";import{isString as l}from"@stryke/types/type-checks/is-string";import{Buffer as a}from"buffer/";import{parse as c}from"jsonc-parser";import u from"superjson";import{formatParseError as p}from"./utils/parse-error";import{stringifyJson as f}from"./utils/stringify-json";export class StormJSON extends u{static#e;static get instance(){return StormJSON.#e||(StormJSON.#e=new StormJSON),StormJSON.#e}static deserialize(e){return StormJSON.instance.deserialize(e)}static serialize(e){return StormJSON.instance.serialize(e)}static parse(e){return StormJSON.instance.parse(e)}static stringifyJson(e,r){const s=StormJSON.instance.customTransformerRegistry.findApplicable(e);let t=e;return s&&(t=s.serialize(t)),f(t?.json?t?.json:t,r?.spaces)}static stringify(e){return StormJSON.instance.stringify(e)}static parseJson(e,r){try{if(r?.expectComments===!1)return StormJSON.instance.parse(e)}catch{}const s=[],t={allowTrailingComma:!0,...r},n=c(e,s,t);if(s.length>0&&s[0])throw new Error(p(e,s[0]));return n}static register(e,r,s,t){StormJSON.instance.registerCustom({isApplicable:t,serialize:r,deserialize:s},e)}static registerClass(e,r){StormJSON.instance.registerClass(e,{identifier:l(r)?r:r?.identifier||e.name,allowProps:r&&o(r)&&r?.allowProps&&Array.isArray(r.allowProps)?r.allowProps:["__typename"]})}constructor(){super({dedupe:!0})}}StormJSON.instance.registerCustom({isApplicable:i=>a.isBuffer(i),serialize:i=>i.toString("base64"),deserialize:i=>a.from(i,"base64")},"Bytes");

package/dist/types.d.ts

@@ -1,8 +1,8 @@
 import type { ParseOptions } from "jsonc-parser";
 export type PrimitiveJsonValue = string | number | boolean | undefined | null;
-export type Class = {
+export interface Class {
     new (...args: any[]): any;
-};
+}
 export type JsonValue = PrimitiveJsonValue | JsonArray | JsonObject;
 export type JsonArray = Array<JsonValue>;
 export interface JsonObject {

package/dist/utils/index.cjs

@@ -25,14 +25,14 @@ Object.keys(_parseError).forEach(function (key) {
     }
   });
 });
-var _stringifyMin = require("./stringify-min.cjs");
-Object.keys(_stringifyMin).forEach(function (key) {
+var _stringifyJson = require("./stringify-json.cjs");
+Object.keys(_stringifyJson).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _stringifyMin[key]) return;
+  if (key in exports && exports[key] === _stringifyJson[key]) return;
   Object.defineProperty(exports, key, {
     enumerable: true,
     get: function () {
-      return _stringifyMin[key];
+      return _stringifyJson[key];
     }
   });
 });

package/dist/utils/index.d.ts

@@ -1,4 +1,4 @@
 export * from "./code-frames";
 export * from "./parse-error";
-export * from "./stringify-min";
+export * from "./stringify-json";
 export * from "./strip-comments";

package/dist/utils/index.mjs

@@ -1 +1 @@
-export*from"./code-frames";export*from"./parse-error";export*from"./stringify-min";export*from"./strip-comments";
+export*from"./code-frames";export*from"./parse-error";export*from"./stringify-json";export*from"./strip-comments";

package/dist/utils/{stringify-min.cjs → stringify-json.cjs}

@@ -3,21 +3,21 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.stringifyMin = void 0;
+exports.stringifyJson = void 0;
 var _isNumber = require("@stryke/types/type-checks/is-number");
-const stringifyMin = (r, n = " ") => {
-  const t = (0, _isNumber.isNumber)(n) ? " ".repeat(n) : n;
+const stringifyJson = (r, t = 2) => {
+  const n = (0, _isNumber.isNumber)(t) ? " ".repeat(t) : t;
   switch (r) {
     case null:
-      return "!n";
+      return "null";
     case void 0:
-      return "!u";
+      return "undefined";
     case !0:
-      return "!t";
+      return "true";
     case !1:
-      return "!f";
+      return "false";
   }
-  if (Array.isArray(r)) return `[${t}${r.map(e => stringifyMin(e, t)).join(`,${t}`)}${t}]`;
+  if (Array.isArray(r)) return `[${n}${r.map(e => stringifyJson(e, n)).join(`,${n}`)}${n}]`;
   if (r instanceof Uint8Array) return r.toString();
   switch (typeof r) {
     case "number":
@@ -27,10 +27,10 @@ const stringifyMin = (r, n = " ") => {
     case "object":
       {
         const e = Object.keys(r);
-        return `{${t}${e.map(s => `${s}${t}=${t}${stringifyMin(r[s], t)}`).join(`,${t}`)}${t}}`;
+        return `{${n}${e.map(s => `${s}${n}=${n}${stringifyJson(r[s], n)}`).join(`,${n}`)}${n}}`;
       }
     default:
-      return "?";
+      return "null";
   }
 };
-exports.stringifyMin = stringifyMin;
+exports.stringifyJson = stringifyJson;

package/dist/utils/{stringify-min.d.ts → stringify-json.d.ts}

@@ -5,4 +5,4 @@
  * @param spacing - The spacing to use for the stringification
  * @returns The stringified value
  */
-export declare const stringifyMin: (value: unknown, spacing?: string | number) => string;
+export declare const stringifyJson: (value: unknown, spacing?: string | number) => string;

package/dist/utils/stringify-json.mjs

@@ -0,0 +1 @@
+import{isNumber as i}from"@stryke/types/type-checks/is-number";export const stringifyJson=(r,t=2)=>{const n=i(t)?" ".repeat(t):t;switch(r){case null:return"null";case void 0:return"undefined";case!0:return"true";case!1:return"false"}if(Array.isArray(r))return`[${n}${r.map(e=>stringifyJson(e,n)).join(`,${n}`)}${n}]`;if(r instanceof Uint8Array)return r.toString();switch(typeof r){case"number":return`${r}`;case"string":return JSON.stringify(r);case"object":{const e=Object.keys(r);return`{${n}${e.map(s=>`${s}${n}=${n}${stringifyJson(r[s],n)}`).join(`,${n}`)}${n}}`}default:return"null"}};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stryke/json",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "type": "module",
   "description": "A package containing JSON parsing/stringify utilities used by Storm Software.",
   "repository": {
@@ -106,18 +106,18 @@
         "default": "./dist/utils/strip-comments.mjs"
       }
     },
-    "./utils/stringify-min": {
+    "./utils/stringify-json": {
       "import": {
-        "types": "./dist/utils/stringify-min.d.ts",
-        "default": "./dist/utils/stringify-min.mjs"
+        "types": "./dist/utils/stringify-json.d.ts",
+        "default": "./dist/utils/stringify-json.mjs"
       },
       "require": {
-        "types": "./dist/utils/stringify-min.d.ts",
-        "default": "./dist/utils/stringify-min.cjs"
+        "types": "./dist/utils/stringify-json.d.ts",
+        "default": "./dist/utils/stringify-json.cjs"
       },
       "default": {
-        "types": "./dist/utils/stringify-min.d.ts",
-        "default": "./dist/utils/stringify-min.mjs"
+        "types": "./dist/utils/stringify-json.d.ts",
+        "default": "./dist/utils/stringify-json.mjs"
       }
     },
     "./utils/parse-error": {

package/dist/utils/stringify-min.mjs

@@ -1 +0,0 @@
-import{isNumber as i}from"@stryke/types/type-checks/is-number";export const stringifyMin=(r,n=" ")=>{const t=i(n)?" ".repeat(n):n;switch(r){case null:return"!n";case void 0:return"!u";case!0:return"!t";case!1:return"!f"}if(Array.isArray(r))return`[${t}${r.map(e=>stringifyMin(e,t)).join(`,${t}`)}${t}]`;if(r instanceof Uint8Array)return r.toString();switch(typeof r){case"number":return`${r}`;case"string":return JSON.stringify(r);case"object":{const e=Object.keys(r);return`{${t}${e.map(s=>`${s}${t}=${t}${stringifyMin(r[s],t)}`).join(`,${t}`)}${t}}`}default:return"?"}};