@naturalcycles/nodejs-lib 15.15.0 → 15.17.0

package/dist/validation/ajv/getAjv.d.ts

@@ -7,6 +7,13 @@ import { Ajv } from 'ajv';
  * to benefit from cached Ajv instance.
  */
 export declare const getAjv: any;
+/**
+ * Returns cached instance of Ajv, which is non-mutating.
+ *
+ * To be used in places where we only need to know if an item is valid or not,
+ * and are not interested in transforming the data.
+ */
+export declare const getNonMutatingAjv: any;
 /**
  * Create Ajv with modified defaults.
  *

package/dist/validation/ajv/getAjv.js

@@ -11,6 +11,11 @@ const AJV_OPTIONS = {
     // https://ajv.js.org/options.html#coercetypes
     coerceTypes: false, // while `false` - it won't mutate your input
 };
+const AJV_NON_MUTATING_OPTIONS = {
+    ...AJV_OPTIONS,
+    removeAdditional: false,
+    useDefaults: false,
+};
 /**
  * Return cached instance of Ajv with default (recommended) options.
  *
@@ -18,6 +23,13 @@ const AJV_OPTIONS = {
  * to benefit from cached Ajv instance.
  */
 export const getAjv = _lazyValue(createAjv);
+/**
+ * Returns cached instance of Ajv, which is non-mutating.
+ *
+ * To be used in places where we only need to know if an item is valid or not,
+ * and are not interested in transforming the data.
+ */
+export const getNonMutatingAjv = _lazyValue(() => createAjv(AJV_NON_MUTATING_OPTIONS));
 /**
  * Create Ajv with modified defaults.
  *
@@ -32,6 +44,7 @@ export function createAjv(opt) {
     });
     // Add custom formats
     addCustomAjvFormats(ajv);
+    // todo: review and possibly cherry-pick/vendor the formats
     // Adds ajv "formats"
     // https://ajv.js.org/guide/formats.html
     // @ts-expect-error types are wrong
@@ -50,7 +63,9 @@ export function createAjv(opt) {
     return ajv;
 }
 const TS_2500 = 16725225600; // 2500-01-01
+const TS_2500_MILLIS = TS_2500 * 1000;
 const TS_2000 = 946684800; // 2000-01-01
+const TS_2000_MILLIS = TS_2000 * 1000;
 function addCustomAjvFormats(ajv) {
     return (ajv
         .addFormat('id', /^[a-z0-9_]{6,64}$/)
@@ -75,13 +90,13 @@ function addCustomAjvFormats(ajv) {
         .addFormat('unixTimestampMillis', {
         type: 'number',
         validate: (n) => {
-            return n >= 0 && n < TS_2500 * 1000;
+            return n >= 0 && n < TS_2500_MILLIS;
         },
     })
         .addFormat('unixTimestampMillis2000', {
         type: 'number',
         validate: (n) => {
-            return n >= TS_2000 * 1000 && n < TS_2500 * 1000;
+            return n >= TS_2000_MILLIS && n < TS_2500_MILLIS;
         },
     })
         .addFormat('utcOffset', {

package/dist/zip/zip.util.d.ts

@@ -3,23 +3,23 @@ import type { ZlibOptions } from 'node:zlib';
  * deflateBuffer uses `deflate`.
  * It's 9 bytes shorter than `gzip`.
  */
-export declare function deflateBuffer(buf: Buffer, options?: ZlibOptions): Promise<Buffer>;
-export declare function inflateBuffer(buf: Buffer, options?: ZlibOptions): Promise<Buffer>;
+export declare function deflateBuffer(buf: Buffer, options?: ZlibOptions): Promise<Buffer<ArrayBuffer>>;
+export declare function inflateBuffer(buf: Buffer, options?: ZlibOptions): Promise<Buffer<ArrayBuffer>>;
 /**
  * deflateString uses `deflate`.
  * It's 9 bytes shorter than `gzip`.
  */
-export declare function deflateString(s: string, options?: ZlibOptions): Promise<Buffer>;
+export declare function deflateString(s: string, options?: ZlibOptions): Promise<Buffer<ArrayBuffer>>;
 export declare function inflateToString(buf: Buffer, options?: ZlibOptions): Promise<string>;
 /**
  * gzipBuffer uses `gzip`
  * It's 9 bytes longer than `deflate`.
  */
-export declare function gzipBuffer(buf: Buffer, options?: ZlibOptions): Promise<Buffer>;
-export declare function gunzipBuffer(buf: Buffer, options?: ZlibOptions): Promise<Buffer>;
+export declare function gzipBuffer(buf: Buffer, options?: ZlibOptions): Promise<Buffer<ArrayBuffer>>;
+export declare function gunzipBuffer(buf: Buffer, options?: ZlibOptions): Promise<Buffer<ArrayBuffer>>;
 /**
  * gzipString uses `gzip`.
  * It's 9 bytes longer than `deflate`.
  */
-export declare function gzipString(s: string, options?: ZlibOptions): Promise<Buffer>;
+export declare function gzipString(s: string, options?: ZlibOptions): Promise<Buffer<ArrayBuffer>>;
 export declare function gunzipToString(buf: Buffer, options?: ZlibOptions): Promise<string>;

package/dist/zip/zip.util.js

@@ -9,10 +9,10 @@ const gunzip = promisify(zlib.gunzip.bind(zlib));
  * It's 9 bytes shorter than `gzip`.
  */
 export async function deflateBuffer(buf, options = {}) {
-    return await deflate(buf, options);
+    return (await deflate(buf, options));
 }
 export async function inflateBuffer(buf, options = {}) {
-    return await inflate(buf, options);
+    return (await inflate(buf, options));
 }
 /**
  * deflateString uses `deflate`.
@@ -29,10 +29,10 @@ export async function inflateToString(buf, options) {
  * It's 9 bytes longer than `deflate`.
  */
 export async function gzipBuffer(buf, options = {}) {
-    return await gzip(buf, options);
+    return (await gzip(buf, options));
 }
 export async function gunzipBuffer(buf, options = {}) {
-    return await gunzip(buf, options);
+    return (await gunzip(buf, options));
 }
 /**
  * gzipString uses `gzip`.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@naturalcycles/nodejs-lib",
   "type": "module",
-  "version": "15.15.0",
+  "version": "15.17.0",
   "dependencies": {
     "@naturalcycles/js-lib": "^15",
     "@types/js-yaml": "^4",

package/src/validation/ajv/getAjv.ts

@@ -14,6 +14,12 @@ const AJV_OPTIONS: Options = {
   coerceTypes: false, // while `false` - it won't mutate your input
 }
 
+const AJV_NON_MUTATING_OPTIONS: Options = {
+  ...AJV_OPTIONS,
+  removeAdditional: false,
+  useDefaults: false,
+}
+
 /**
  * Return cached instance of Ajv with default (recommended) options.
  *
@@ -22,6 +28,14 @@ const AJV_OPTIONS: Options = {
  */
 export const getAjv = _lazyValue(createAjv)
 
+/**
+ * Returns cached instance of Ajv, which is non-mutating.
+ *
+ * To be used in places where we only need to know if an item is valid or not,
+ * and are not interested in transforming the data.
+ */
+export const getNonMutatingAjv = _lazyValue(() => createAjv(AJV_NON_MUTATING_OPTIONS))
+
 /**
  * Create Ajv with modified defaults.
  *
@@ -38,6 +52,7 @@ export function createAjv(opt?: Options): Ajv {
   // Add custom formats
   addCustomAjvFormats(ajv)
 
+  // todo: review and possibly cherry-pick/vendor the formats
   // Adds ajv "formats"
   // https://ajv.js.org/guide/formats.html
   // @ts-expect-error types are wrong
@@ -60,7 +75,9 @@ export function createAjv(opt?: Options): Ajv {
 }
 
 const TS_2500 = 16725225600 // 2500-01-01
+const TS_2500_MILLIS = TS_2500 * 1000
 const TS_2000 = 946684800 // 2000-01-01
+const TS_2000_MILLIS = TS_2000 * 1000
 
 function addCustomAjvFormats(ajv: Ajv): Ajv {
   return (
@@ -87,13 +104,13 @@ function addCustomAjvFormats(ajv: Ajv): Ajv {
       .addFormat('unixTimestampMillis', {
         type: 'number',
         validate: (n: number) => {
-          return n >= 0 && n < TS_2500 * 1000
+          return n >= 0 && n < TS_2500_MILLIS
         },
       })
       .addFormat('unixTimestampMillis2000', {
         type: 'number',
         validate: (n: number) => {
-          return n >= TS_2000 * 1000 && n < TS_2500 * 1000
+          return n >= TS_2000_MILLIS && n < TS_2500_MILLIS
         },
       })
       .addFormat('utcOffset', {

package/src/zip/zip.util.ts

@@ -11,19 +11,28 @@ const gunzip = promisify(zlib.gunzip.bind(zlib))
  * deflateBuffer uses `deflate`.
  * It's 9 bytes shorter than `gzip`.
  */
-export async function deflateBuffer(buf: Buffer, options: ZlibOptions = {}): Promise<Buffer> {
-  return await deflate(buf, options)
+export async function deflateBuffer(
+  buf: Buffer,
+  options: ZlibOptions = {},
+): Promise<Buffer<ArrayBuffer>> {
+  return (await deflate(buf, options)) as Buffer<ArrayBuffer>
 }
 
-export async function inflateBuffer(buf: Buffer, options: ZlibOptions = {}): Promise<Buffer> {
-  return await inflate(buf, options)
+export async function inflateBuffer(
+  buf: Buffer,
+  options: ZlibOptions = {},
+): Promise<Buffer<ArrayBuffer>> {
+  return (await inflate(buf, options)) as Buffer<ArrayBuffer>
 }
 
 /**
  * deflateString uses `deflate`.
  * It's 9 bytes shorter than `gzip`.
  */
-export async function deflateString(s: string, options?: ZlibOptions): Promise<Buffer> {
+export async function deflateString(
+  s: string,
+  options?: ZlibOptions,
+): Promise<Buffer<ArrayBuffer>> {
   return await deflateBuffer(Buffer.from(s), options)
 }
 
@@ -35,19 +44,25 @@ export async function inflateToString(buf: Buffer, options?: ZlibOptions): Promi
  * gzipBuffer uses `gzip`
  * It's 9 bytes longer than `deflate`.
  */
-export async function gzipBuffer(buf: Buffer, options: ZlibOptions = {}): Promise<Buffer> {
-  return await gzip(buf, options)
+export async function gzipBuffer(
+  buf: Buffer,
+  options: ZlibOptions = {},
+): Promise<Buffer<ArrayBuffer>> {
+  return (await gzip(buf, options)) as Buffer<ArrayBuffer>
 }
 
-export async function gunzipBuffer(buf: Buffer, options: ZlibOptions = {}): Promise<Buffer> {
-  return await gunzip(buf, options)
+export async function gunzipBuffer(
+  buf: Buffer,
+  options: ZlibOptions = {},
+): Promise<Buffer<ArrayBuffer>> {
+  return (await gunzip(buf, options)) as Buffer<ArrayBuffer>
 }
 
 /**
  * gzipString uses `gzip`.
  * It's 9 bytes longer than `deflate`.
  */
-export async function gzipString(s: string, options?: ZlibOptions): Promise<Buffer> {
+export async function gzipString(s: string, options?: ZlibOptions): Promise<Buffer<ArrayBuffer>> {
   return await gzipBuffer(Buffer.from(s), options)
 }