@ms-cloudpack/json-utilities 0.1.4 → 0.1.5

package/lib/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.39.4"
+      "packageVersion": "7.47.0"
     }
   ]
 }

package/lib/writeJson.d.ts

@@ -8,6 +8,9 @@ export interface WriteJsonOptions extends Pick<ReadJsonOptions, 'mode'> {
 }
 /**
  * Writes json to a path. Ensures the path exists.
+ *
+ * If the JSON is very large (causing a RangeError "Invalid string length"), it will fall back to
+ * stringifying and writing the object using a stream, provided that `update` is false/unset.
  */
 export declare function writeJson(filePath: string, data: unknown, options?: WriteJsonOptions): Promise<void>;
 /**

package/lib/writeJson.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"writeJson.d.ts","sourceRoot":"","sources":["../src/writeJson.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAErD,MAAM,WAAW,gBAAiB,SAAQ,IAAI,CAAC,eAAe,EAAE,MAAM,CAAC;IACrE;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,wBAAsB,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,GAAE,gBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC,CAM9G;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,GAAE,gBAAqB,GAAG,IAAI,CAMnG"}
+{"version":3,"file":"writeJson.d.ts","sourceRoot":"","sources":["../src/writeJson.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAErD,MAAM,WAAW,gBAAiB,SAAQ,IAAI,CAAC,eAAe,EAAE,MAAM,CAAC;IACrE;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;;;;GAKG;AACH,wBAAsB,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,GAAE,gBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC,CAmB9G;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,GAAE,gBAAqB,GAAG,IAAI,CAMnG"}

package/lib/writeJson.js

@@ -1,16 +1,33 @@
 import fs from 'fs';
-import fsPromises from 'fs/promises';
-import path from 'path';
 import fsExtra from 'fs-extra';
+import fsPromises from 'fs/promises';
 import jju from 'jju';
+import { JsonStreamStringify } from 'json-stream-stringify';
+import path from 'path';
+import { pipeline } from 'stream/promises';
 /**
  * Writes json to a path. Ensures the path exists.
+ *
+ * If the JSON is very large (causing a RangeError "Invalid string length"), it will fall back to
+ * stringifying and writing the object using a stream, provided that `update` is false/unset.
  */
 export async function writeJson(filePath, data, options = {}) {
     const folderPath = path.dirname(filePath);
     await fsExtra.ensureDir(folderPath);
-    const contents = stringify(filePath, data, options);
-    await fsPromises.writeFile(filePath, contents, 'utf8');
+    let contents;
+    try {
+        contents = stringify(filePath, data, options);
+        await fsPromises.writeFile(filePath, contents, 'utf8');
+    }
+    catch (err) {
+        if (!contents && err instanceof RangeError && !options.update) {
+            // It's a giant object, so try a stream
+            await pipeline(new JsonStreamStringify(data, undefined, 2, true), fs.createWriteStream(filePath, { encoding: 'utf8' }));
+        }
+        else {
+            throw err;
+        }
+    }
 }
 /**
  * Synchronously writes json to a path. Ensures the path exists.
@@ -24,7 +41,6 @@ export function writeJsonSync(filePath, data, options = {}) {
 function stringify(filePath, data, options) {
     const { update, mode } = options;
     if (update && fs.existsSync(filePath)) {
-        // eslint-disable-next-line @ms-cloudpack/internal/no-sync-filesystem
         const originalContent = fs.readFileSync(filePath, 'utf8');
         return jju.update(originalContent, data, {
             mode: mode === 'permissive' ? 'json5' : 'json',

package/lib/writeJson.js.map

@@ -1 +1 @@
-{"version":3,"file":"writeJson.js","sourceRoot":"","sources":["../src/writeJson.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,UAAU,MAAM,aAAa,CAAC;AACrC,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,OAAO,MAAM,UAAU,CAAC;AAC/B,OAAO,GAAG,MAAM,KAAK,CAAC;AAWtB;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,QAAgB,EAAE,IAAa,EAAE,UAA4B,EAAE;IAC7F,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC1C,MAAM,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IAEpC,MAAM,QAAQ,GAAG,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IACpD,MAAM,UAAU,CAAC,SAAS,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;AACzD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,aAAa,CAAC,QAAgB,EAAE,IAAa,EAAE,UAA4B,EAAE;IAC3F,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC1C,OAAO,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;IAElC,MAAM,QAAQ,GAAG,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IACpD,EAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;AAC/C,CAAC;AAED,SAAS,SAAS,CAAC,QAAgB,EAAE,IAAa,EAAE,OAAyB;IAC3E,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IAEjC,IAAI,MAAM,IAAI,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QACtC,qEAAqE;QACrE,MAAM,eAAe,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAC1D,OAAO,GAAG,CAAC,MAAM,CAAC,eAAe,EAAE,IAAI,EAAE;YACvC,IAAI,EAAE,IAAI,KAAK,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM;YAC9C,MAAM,EAAE,CAAC;YACT,KAAK,EAAE,GAAG;YACV,UAAU,EAAE,IAAI;YAChB,iBAAiB,EAAE,IAAI;SACxB,CAAC,CAAC;IACL,CAAC;IAED,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC;AAC9C,CAAC","sourcesContent":["import fs from 'fs';\nimport fsPromises from 'fs/promises';\nimport path from 'path';\nimport fsExtra from 'fs-extra';\nimport jju from 'jju';\nimport type { ReadJsonOptions } from './readJson.js';\n\nexport interface WriteJsonOptions extends Pick<ReadJsonOptions, 'mode'> {\n  /**\n   * If true, read the file (if it exists) and preserve as much of the original formatting as possible.\n   * (For files with comments, `mode: 'permissive'` must also be set.)\n   */\n  update?: boolean;\n}\n\n/**\n * Writes json to a path. Ensures the path exists.\n */\nexport async function writeJson(filePath: string, data: unknown, options: WriteJsonOptions = {}): Promise<void> {\n  const folderPath = path.dirname(filePath);\n  await fsExtra.ensureDir(folderPath);\n\n  const contents = stringify(filePath, data, options);\n  await fsPromises.writeFile(filePath, contents, 'utf8');\n}\n\n/**\n * Synchronously writes json to a path. Ensures the path exists.\n */\nexport function writeJsonSync(filePath: string, data: unknown, options: WriteJsonOptions = {}): void {\n  const folderPath = path.dirname(filePath);\n  fsExtra.ensureDirSync(folderPath);\n\n  const contents = stringify(filePath, data, options);\n  fs.writeFileSync(filePath, contents, 'utf8');\n}\n\nfunction stringify(filePath: string, data: unknown, options: WriteJsonOptions): string {\n  const { update, mode } = options;\n\n  if (update && fs.existsSync(filePath)) {\n    // eslint-disable-next-line @ms-cloudpack/internal/no-sync-filesystem\n    const originalContent = fs.readFileSync(filePath, 'utf8');\n    return jju.update(originalContent, data, {\n      mode: mode === 'permissive' ? 'json5' : 'json',\n      indent: 2,\n      quote: '\"',\n      quote_keys: true,\n      no_trailing_comma: true,\n    });\n  }\n\n  return JSON.stringify(data, null, 2) + '\\n';\n}\n"]}
+{"version":3,"file":"writeJson.js","sourceRoot":"","sources":["../src/writeJson.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,OAAO,MAAM,UAAU,CAAC;AAC/B,OAAO,UAAU,MAAM,aAAa,CAAC;AACrC,OAAO,GAAG,MAAM,KAAK,CAAC;AACtB,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAW3C;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,QAAgB,EAAE,IAAa,EAAE,UAA4B,EAAE;IAC7F,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC1C,MAAM,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IAEpC,IAAI,QAA4B,CAAC;IACjC,IAAI,CAAC;QACH,QAAQ,GAAG,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAC9C,MAAM,UAAU,CAAC,SAAS,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;IACzD,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,QAAQ,IAAI,GAAG,YAAY,UAAU,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;YAC9D,uCAAuC;YACvC,MAAM,QAAQ,CACZ,IAAI,mBAAmB,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC,EAAE,IAAI,CAAC,EACjD,EAAE,CAAC,iBAAiB,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CACrD,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,aAAa,CAAC,QAAgB,EAAE,IAAa,EAAE,UAA4B,EAAE;IAC3F,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC1C,OAAO,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;IAElC,MAAM,QAAQ,GAAG,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IACpD,EAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;AAC/C,CAAC;AAED,SAAS,SAAS,CAAC,QAAgB,EAAE,IAAa,EAAE,OAAyB;IAC3E,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IAEjC,IAAI,MAAM,IAAI,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QACtC,MAAM,eAAe,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAC1D,OAAO,GAAG,CAAC,MAAM,CAAC,eAAe,EAAE,IAAI,EAAE;YACvC,IAAI,EAAE,IAAI,KAAK,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM;YAC9C,MAAM,EAAE,CAAC;YACT,KAAK,EAAE,GAAG;YACV,UAAU,EAAE,IAAI;YAChB,iBAAiB,EAAE,IAAI;SACxB,CAAC,CAAC;IACL,CAAC;IAED,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC;AAC9C,CAAC","sourcesContent":["import fs from 'fs';\nimport fsExtra from 'fs-extra';\nimport fsPromises from 'fs/promises';\nimport jju from 'jju';\nimport { JsonStreamStringify } from 'json-stream-stringify';\nimport path from 'path';\nimport { pipeline } from 'stream/promises';\nimport type { ReadJsonOptions } from './readJson.js';\n\nexport interface WriteJsonOptions extends Pick<ReadJsonOptions, 'mode'> {\n  /**\n   * If true, read the file (if it exists) and preserve as much of the original formatting as possible.\n   * (For files with comments, `mode: 'permissive'` must also be set.)\n   */\n  update?: boolean;\n}\n\n/**\n * Writes json to a path. Ensures the path exists.\n *\n * If the JSON is very large (causing a RangeError \"Invalid string length\"), it will fall back to\n * stringifying and writing the object using a stream, provided that `update` is false/unset.\n */\nexport async function writeJson(filePath: string, data: unknown, options: WriteJsonOptions = {}): Promise<void> {\n  const folderPath = path.dirname(filePath);\n  await fsExtra.ensureDir(folderPath);\n\n  let contents: string | undefined;\n  try {\n    contents = stringify(filePath, data, options);\n    await fsPromises.writeFile(filePath, contents, 'utf8');\n  } catch (err) {\n    if (!contents && err instanceof RangeError && !options.update) {\n      // It's a giant object, so try a stream\n      await pipeline(\n        new JsonStreamStringify(data, undefined, 2, true),\n        fs.createWriteStream(filePath, { encoding: 'utf8' }),\n      );\n    } else {\n      throw err;\n    }\n  }\n}\n\n/**\n * Synchronously writes json to a path. Ensures the path exists.\n */\nexport function writeJsonSync(filePath: string, data: unknown, options: WriteJsonOptions = {}): void {\n  const folderPath = path.dirname(filePath);\n  fsExtra.ensureDirSync(folderPath);\n\n  const contents = stringify(filePath, data, options);\n  fs.writeFileSync(filePath, contents, 'utf8');\n}\n\nfunction stringify(filePath: string, data: unknown, options: WriteJsonOptions): string {\n  const { update, mode } = options;\n\n  if (update && fs.existsSync(filePath)) {\n    const originalContent = fs.readFileSync(filePath, 'utf8');\n    return jju.update(originalContent, data, {\n      mode: mode === 'permissive' ? 'json5' : 'json',\n      indent: 2,\n      quote: '\"',\n      quote_keys: true,\n      no_trailing_comma: true,\n    });\n  }\n\n  return JSON.stringify(data, null, 2) + '\\n';\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ms-cloudpack/json-utilities",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "description": "Helpers for reading/writing json files.",
   "license": "MIT",
   "type": "module",
@@ -15,11 +15,12 @@
   },
   "dependencies": {
     "fs-extra": "^11.2.0",
-    "jju": "^1.4.0"
+    "jju": "^1.4.0",
+    "json-stream-stringify": "^3.1.4"
   },
   "devDependencies": {
-    "@ms-cloudpack/eslint-plugin-internal": "*",
-    "@ms-cloudpack/scripts": "*",
+    "@ms-cloudpack/eslint-plugin-internal": "^0.0.1",
+    "@ms-cloudpack/scripts": "^0.0.1",
     "@types/jju": "^1.4.4"
   },
   "scripts": {