@naturalcycles/nodejs-lib 12.93.0 → 12.93.1

package/dist/fs/fs.util.d.ts

@@ -12,16 +12,40 @@ export declare function _readFile(filePath: string): Promise<string>;
  * Convenience wrapper that defaults to utf-8 string output.
  */
 export declare function _readFileSync(filePath: string): string;
-export declare function _readJsonFile<T = unknown>(filePath: string): Promise<T>;
-export declare function _readJsonFileSync<T = unknown>(filePath: string): T;
+export declare function _readJson<T = unknown>(filePath: string): Promise<T>;
+/**
+ * @deprecated use _readJson
+ */
+export declare const _readJsonFile: typeof _readJson;
+export declare function _readJsonSync<T = unknown>(filePath: string): T;
+/**
+ * @deprecated use _readJsonSync
+ */
+export declare const _readJsonFileSync: typeof _readJsonSync;
 export declare function _writeFile(filePath: string, data: string | Buffer): Promise<void>;
 export declare function _writeFileSync(filePath: string, data: string | Buffer): void;
 export declare function _outputFile(filePath: string, data: string | Buffer): Promise<void>;
 export declare function _outputFileSync(filePath: string, data: string | Buffer): void;
-export declare function _writeJsonFile(filePath: string, data: any, opt?: JsonOptions): Promise<void>;
-export declare function _writeJsonFileSync(filePath: string, data: any, opt?: JsonOptions): void;
-export declare function _outputJsonFile(filePath: string, data: any, opt?: JsonOptions): Promise<void>;
-export declare function _outputJsonFileSync(filePath: string, data: any, opt?: JsonOptions): void;
+export declare function _writeJson(filePath: string, data: any, opt?: JsonOptions): Promise<void>;
+/**
+ * @deprecated use _writeJson
+ */
+export declare const _writeJsonFile: typeof _writeJson;
+export declare function _writeJsonSync(filePath: string, data: any, opt?: JsonOptions): void;
+/**
+ * @deprecated use _writeJsonSync
+ */
+export declare const _writeJsonFileSync: typeof _writeJsonSync;
+export declare function _outputJson(filePath: string, data: any, opt?: JsonOptions): Promise<void>;
+/**
+ * @deprecated use _outputJson
+ */
+export declare const _outputJsonFile: typeof _outputJson;
+export declare function _outputJsonSync(filePath: string, data: any, opt?: JsonOptions): void;
+/**
+ * @deprecated use _outputJsonSync
+ */
+export declare const _outputJsonFileSync: typeof _outputJsonSync;
 export declare function _pathExists(filePath: string): Promise<boolean>;
 export declare function _pathExistsSync(filePath: string): boolean;
 export declare function _ensureDir(dirPath: string): Promise<void>;

package/dist/fs/fs.util.js

@@ -15,7 +15,7 @@ Credit to: fs-extra (https://github.com/jprichardson/node-fs-extra)
 
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports._movePathSync = exports._movePath = exports._copyPathSync = exports._copyPath = exports._emptyDirSync = exports._emptyDir = exports._removePathSync = exports._removePath = exports._ensureFileSync = exports._ensureFile = exports._ensureDirSync = exports._ensureDir = exports._pathExistsSync = exports._pathExists = exports._outputJsonFileSync = exports._outputJsonFile = exports._writeJsonFileSync = exports._writeJsonFile = exports._outputFileSync = exports._outputFile = exports._writeFileSync = exports._writeFile = exports._readJsonFileSync = exports._readJsonFile = exports._readFileSync = exports._readFile = void 0;
+exports._movePathSync = exports._movePath = exports._copyPathSync = exports._copyPath = exports._emptyDirSync = exports._emptyDir = exports._removePathSync = exports._removePath = exports._ensureFileSync = exports._ensureFile = exports._ensureDirSync = exports._ensureDir = exports._pathExistsSync = exports._pathExists = exports._outputJsonFileSync = exports._outputJsonSync = exports._outputJsonFile = exports._outputJson = exports._writeJsonFileSync = exports._writeJsonSync = exports._writeJsonFile = exports._writeJson = exports._outputFileSync = exports._outputFile = exports._writeFileSync = exports._writeFile = exports._readJsonFileSync = exports._readJsonSync = exports._readJsonFile = exports._readJson = exports._readFileSync = exports._readFile = void 0;
 const fs = require("node:fs");
 const fsp = require("node:fs/promises");
 const path = require("node:path");
@@ -34,16 +34,24 @@ function _readFileSync(filePath) {
     return fs.readFileSync(filePath, 'utf8');
 }
 exports._readFileSync = _readFileSync;
-async function _readJsonFile(filePath) {
+async function _readJson(filePath) {
     const str = await fsp.readFile(filePath, 'utf8');
     return (0, js_lib_1._jsonParse)(str);
 }
-exports._readJsonFile = _readJsonFile;
-function _readJsonFileSync(filePath) {
+exports._readJson = _readJson;
+/**
+ * @deprecated use _readJson
+ */
+exports._readJsonFile = _readJson;
+function _readJsonSync(filePath) {
     const str = fs.readFileSync(filePath, 'utf8');
     return (0, js_lib_1._jsonParse)(str);
 }
-exports._readJsonFileSync = _readJsonFileSync;
+exports._readJsonSync = _readJsonSync;
+/**
+ * @deprecated use _readJsonSync
+ */
+exports._readJsonFileSync = _readJsonSync;
 async function _writeFile(filePath, data) {
     await fsp.writeFile(filePath, data);
 }
@@ -68,26 +76,42 @@ function _outputFileSync(filePath, data) {
     fs.writeFileSync(filePath, data);
 }
 exports._outputFileSync = _outputFileSync;
-async function _writeJsonFile(filePath, data, opt) {
+async function _writeJson(filePath, data, opt) {
     const str = JSON.stringify(data, null, opt?.spaces);
     await fsp.writeFile(filePath, str);
 }
-exports._writeJsonFile = _writeJsonFile;
-function _writeJsonFileSync(filePath, data, opt) {
+exports._writeJson = _writeJson;
+/**
+ * @deprecated use _writeJson
+ */
+exports._writeJsonFile = _writeJson;
+function _writeJsonSync(filePath, data, opt) {
     const str = JSON.stringify(data, null, opt?.spaces);
     fs.writeFileSync(filePath, str);
 }
-exports._writeJsonFileSync = _writeJsonFileSync;
-async function _outputJsonFile(filePath, data, opt) {
+exports._writeJsonSync = _writeJsonSync;
+/**
+ * @deprecated use _writeJsonSync
+ */
+exports._writeJsonFileSync = _writeJsonSync;
+async function _outputJson(filePath, data, opt) {
     const str = JSON.stringify(data, null, opt?.spaces);
     await _outputFile(filePath, str);
 }
-exports._outputJsonFile = _outputJsonFile;
-function _outputJsonFileSync(filePath, data, opt) {
+exports._outputJson = _outputJson;
+/**
+ * @deprecated use _outputJson
+ */
+exports._outputJsonFile = _outputJson;
+function _outputJsonSync(filePath, data, opt) {
     const str = JSON.stringify(data, null, opt?.spaces);
     _outputFileSync(filePath, str);
 }
-exports._outputJsonFileSync = _outputJsonFileSync;
+exports._outputJsonSync = _outputJsonSync;
+/**
+ * @deprecated use _outputJsonSync
+ */
+exports._outputJsonFileSync = _outputJsonSync;
 async function _pathExists(filePath) {
     try {
         await fsp.access(filePath);

package/dist/fs/json2env.js

@@ -28,7 +28,7 @@ function json2env(opt) {
         return;
     }
     // read file
-    const json = (0, fs_util_1._readJsonFileSync)(jsonPath);
+    const json = (0, fs_util_1._readJsonSync)(jsonPath);
     const exportStr = objectToShellExport(json, prefix);
     const githubStr = objectToGithubActionsEnv(json, prefix);
     if (debug) {

package/dist/secret/secrets-decrypt.util.js

@@ -24,8 +24,8 @@ function secretsDecrypt(dir, file, encKey, del = false, jsonMode = false) {
             (0, js_lib_1._assert)(filename.endsWith('.json'), `${path.basename(filename)} MUST end with '.json'`);
             (0, js_lib_1._assert)(!filename.endsWith('.plain.json'), `${path.basename(filename)} MUST NOT end with '.plain.json'`);
             plainFilename = filename.replace('.json', '.plain.json');
-            const json = (0, crypto_util_1.decryptObject)((0, index_1._readJsonFileSync)(filename), encKey);
-            (0, index_1._writeJsonFileSync)(plainFilename, json, { spaces: 2 });
+            const json = (0, crypto_util_1.decryptObject)((0, index_1._readJsonSync)(filename), encKey);
+            (0, index_1._writeJsonSync)(plainFilename, json, { spaces: 2 });
         }
         else {
             const enc = fs.readFileSync(filename);

package/dist/secret/secrets-encrypt.util.js

@@ -24,8 +24,8 @@ function secretsEncrypt(pattern, file, encKey, del = false, jsonMode = false) {
         if (jsonMode) {
             (0, js_lib_1._assert)(filename.endsWith('.plain.json'), `${path.basename(filename)} MUST end with '.plain.json'`);
             encFilename = filename.replace('.plain', '');
-            const json = (0, crypto_util_1.encryptObject)((0, index_1._readJsonFileSync)(filename), encKey);
-            (0, index_1._writeJsonFileSync)(encFilename, json, { spaces: 2 });
+            const json = (0, crypto_util_1.encryptObject)((0, index_1._readJsonSync)(filename), encKey);
+            (0, index_1._writeJsonSync)(encFilename, json, { spaces: 2 });
         }
         else {
             const plain = fs.readFileSync(filename);

package/dist/validation/ajv/ajv.util.js

@@ -12,7 +12,7 @@ const ajvSchema_1 = require("./ajvSchema");
  * @experimental
  */
 function readJsonSchemas(patterns, opt) {
-    return __1.fastGlob.sync(patterns, opt).map(fileName => (0, __1._readJsonFileSync)(fileName));
+    return __1.fastGlob.sync(patterns, opt).map(fileName => (0, __1._readJsonSync)(fileName));
 }
 exports.readJsonSchemas = readJsonSchemas;
 /**

package/dist/validation/ajv/ajvSchema.js

@@ -59,7 +59,7 @@ class AjvSchema {
      */
     static readJsonSync(filePath, cfg = {}) {
         (0, index_1.requireFileToExist)(filePath);
-        const schema = (0, index_1._readJsonFileSync)(filePath);
+        const schema = (0, index_1._readJsonSync)(filePath);
         return new AjvSchema(schema, cfg);
     }
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/nodejs-lib",
-  "version": "12.93.0",
+  "version": "12.93.1",
   "scripts": {
     "prepare": "husky install",
     "docs-serve": "vuepress dev docs",

package/src/fs/fs.util.ts

@@ -37,16 +37,26 @@ export function _readFileSync(filePath: string): string {
   return fs.readFileSync(filePath, 'utf8')
 }
 
-export async function _readJsonFile<T = unknown>(filePath: string): Promise<T> {
+export async function _readJson<T = unknown>(filePath: string): Promise<T> {
   const str = await fsp.readFile(filePath, 'utf8')
   return _jsonParse(str)
 }
 
-export function _readJsonFileSync<T = unknown>(filePath: string): T {
+/**
+ * @deprecated use _readJson
+ */
+export const _readJsonFile = _readJson
+
+export function _readJsonSync<T = unknown>(filePath: string): T {
   const str = fs.readFileSync(filePath, 'utf8')
   return _jsonParse(str)
 }
 
+/**
+ * @deprecated use _readJsonSync
+ */
+export const _readJsonFileSync = _readJsonSync
+
 export async function _writeFile(filePath: string, data: string | Buffer): Promise<void> {
   await fsp.writeFile(filePath, data)
 }
@@ -73,34 +83,46 @@ export function _outputFileSync(filePath: string, data: string | Buffer): void {
   fs.writeFileSync(filePath, data)
 }
 
-export async function _writeJsonFile(
-  filePath: string,
-  data: any,
-  opt?: JsonOptions,
-): Promise<void> {
+export async function _writeJson(filePath: string, data: any, opt?: JsonOptions): Promise<void> {
   const str = JSON.stringify(data, null, opt?.spaces)
   await fsp.writeFile(filePath, str)
 }
 
-export function _writeJsonFileSync(filePath: string, data: any, opt?: JsonOptions): void {
+/**
+ * @deprecated use _writeJson
+ */
+export const _writeJsonFile = _writeJson
+
+export function _writeJsonSync(filePath: string, data: any, opt?: JsonOptions): void {
   const str = JSON.stringify(data, null, opt?.spaces)
   fs.writeFileSync(filePath, str)
 }
 
-export async function _outputJsonFile(
-  filePath: string,
-  data: any,
-  opt?: JsonOptions,
-): Promise<void> {
+/**
+ * @deprecated use _writeJsonSync
+ */
+export const _writeJsonFileSync = _writeJsonSync
+
+export async function _outputJson(filePath: string, data: any, opt?: JsonOptions): Promise<void> {
   const str = JSON.stringify(data, null, opt?.spaces)
   await _outputFile(filePath, str)
 }
 
-export function _outputJsonFileSync(filePath: string, data: any, opt?: JsonOptions): void {
+/**
+ * @deprecated use _outputJson
+ */
+export const _outputJsonFile = _outputJson
+
+export function _outputJsonSync(filePath: string, data: any, opt?: JsonOptions): void {
   const str = JSON.stringify(data, null, opt?.spaces)
   _outputFileSync(filePath, str)
 }
 
+/**
+ * @deprecated use _outputJsonSync
+ */
+export const _outputJsonFileSync = _outputJsonSync
+
 export async function _pathExists(filePath: string): Promise<boolean> {
   try {
     await fsp.access(filePath)

package/src/fs/json2env.ts

@@ -1,6 +1,6 @@
 import * as fs from 'node:fs'
 import { dimGrey } from '../colors'
-import { _pathExistsSync, _readJsonFileSync, _writeFileSync } from './fs.util'
+import { _pathExistsSync, _readJsonSync, _writeFileSync } from './fs.util'
 
 export interface Json2EnvOptions {
   jsonPath: string
@@ -60,7 +60,7 @@ export function json2env(opt: Json2EnvOptions): void {
   }
 
   // read file
-  const json = _readJsonFileSync(jsonPath)
+  const json = _readJsonSync(jsonPath)
 
   const exportStr = objectToShellExport(json, prefix)
   const githubStr = objectToGithubActionsEnv(json, prefix)

package/src/secret/secrets-decrypt.util.ts

@@ -2,7 +2,7 @@ import * as path from 'node:path'
 import * as fs from 'node:fs'
 import { _assert } from '@naturalcycles/js-lib'
 import { dimGrey, yellow } from '../colors'
-import { _readJsonFileSync, _writeJsonFileSync, fastGlob } from '../index'
+import { _readJsonSync, _writeJsonSync, fastGlob } from '../index'
 import { decryptObject, decryptRandomIVBuffer } from '../security/crypto.util'
 
 export interface DecryptCLIOptions {
@@ -44,9 +44,9 @@ export function secretsDecrypt(
       )
       plainFilename = filename.replace('.json', '.plain.json')
 
-      const json = decryptObject(_readJsonFileSync(filename), encKey)
+      const json = decryptObject(_readJsonSync(filename), encKey)
 
-      _writeJsonFileSync(plainFilename, json, { spaces: 2 })
+      _writeJsonSync(plainFilename, json, { spaces: 2 })
     } else {
       const enc = fs.readFileSync(filename)
       const plain = decryptRandomIVBuffer(enc, encKey)

package/src/secret/secrets-encrypt.util.ts

@@ -2,7 +2,7 @@ import * as fs from 'node:fs'
 import * as path from 'node:path'
 import { _assert } from '@naturalcycles/js-lib'
 import { dimGrey, yellow } from '../colors'
-import { _readJsonFileSync, _writeJsonFileSync, fastGlob } from '../index'
+import { _readJsonSync, _writeJsonSync, fastGlob } from '../index'
 import { encryptObject, encryptRandomIVBuffer } from '../security/crypto.util'
 
 export interface EncryptCLIOptions {
@@ -41,9 +41,9 @@ export function secretsEncrypt(
       )
       encFilename = filename.replace('.plain', '')
 
-      const json = encryptObject(_readJsonFileSync(filename), encKey)
+      const json = encryptObject(_readJsonSync(filename), encKey)
 
-      _writeJsonFileSync(encFilename, json, { spaces: 2 })
+      _writeJsonSync(encFilename, json, { spaces: 2 })
     } else {
       const plain = fs.readFileSync(filename)
       const enc = encryptRandomIVBuffer(plain, encKey)

package/src/validation/ajv/ajv.util.ts

@@ -1,5 +1,5 @@
 import { JsonSchema } from '@naturalcycles/js-lib'
-import { _readJsonFileSync, fastGlob } from '../..'
+import { _readJsonSync, fastGlob } from '../..'
 import type { FastGlobOptions } from '../..'
 import { AjvSchema, AjvSchemaCfg } from './ajvSchema'
 
@@ -12,7 +12,7 @@ import { AjvSchema, AjvSchemaCfg } from './ajvSchema'
  * @experimental
  */
 export function readJsonSchemas(patterns: string | string[], opt?: FastGlobOptions): JsonSchema[] {
-  return fastGlob.sync(patterns, opt).map(fileName => _readJsonFileSync(fileName))
+  return fastGlob.sync(patterns, opt).map(fileName => _readJsonSync(fileName))
 }
 
 /**

package/src/validation/ajv/ajvSchema.ts

@@ -8,7 +8,7 @@ import {
   CommonLogger,
 } from '@naturalcycles/js-lib'
 import Ajv, { ValidateFunction } from 'ajv'
-import { _readJsonFileSync, inspectAny, requireFileToExist } from '../../index'
+import { _readJsonSync, inspectAny, requireFileToExist } from '../../index'
 import { AjvValidationError } from './ajvValidationError'
 import { getAjv } from './getAjv'
 
@@ -131,7 +131,7 @@ export class AjvSchema<T = unknown> {
     cfg: Partial<AjvSchemaCfg> = {},
   ): AjvSchema<T> {
     requireFileToExist(filePath)
-    const schema = _readJsonFileSync<JsonSchema<T>>(filePath)
+    const schema = _readJsonSync<JsonSchema<T>>(filePath)
     return new AjvSchema<T>(schema, cfg)
   }