@naturalcycles/nodejs-lib 13.13.0 → 13.15.0

package/dist/index.d.ts

@@ -34,7 +34,7 @@ export * from './stream/readable/readableFromArray';
 export * from './stream/readable/readableToArray';
 export * from './stream/stream.model';
 export * from './stream/progressLogger';
-export * from './stream/transform/transformBuffer';
+export * from './stream/transform/transformChunk';
 export * from './stream/transform/transformFilter';
 export * from './stream/transform/transformLimit';
 export * from './stream/transform/transformLogProgress';

package/dist/index.js

@@ -38,7 +38,7 @@ tslib_1.__exportStar(require("./stream/readable/readableFromArray"), exports);
 tslib_1.__exportStar(require("./stream/readable/readableToArray"), exports);
 tslib_1.__exportStar(require("./stream/stream.model"), exports);
 tslib_1.__exportStar(require("./stream/progressLogger"), exports);
-tslib_1.__exportStar(require("./stream/transform/transformBuffer"), exports);
+tslib_1.__exportStar(require("./stream/transform/transformChunk"), exports);
 tslib_1.__exportStar(require("./stream/transform/transformFilter"), exports);
 tslib_1.__exportStar(require("./stream/transform/transformLimit"), exports);
 tslib_1.__exportStar(require("./stream/transform/transformLogProgress"), exports);

package/dist/stream/progressLogger.d.ts

@@ -78,12 +78,12 @@ export interface ProgressLoggerCfg<T = any> {
     extra?: (chunk: T | undefined, index: number) => AnyObject;
     /**
      * If specified - will multiply the counter by this number.
-     * Useful e.g when using `transformBuffer({ batchSize: 500 })`, so
-     * it'll accurately represent the number of processed entries (not batches).
+     * Useful e.g when using `transformChunk({ chunkSize: 500 })`, so
+     * it'll accurately represent the number of processed entries (not chunks).
      *
      * Defaults to 1.
      */
-    batchSize?: number;
+    chunkSize?: number;
     /**
      * Experimental logging of item (shunk) sizes, when json-stringified.
      *
@@ -121,7 +121,7 @@ export declare class ProgressLogger<T> implements Disposable {
     cfg: ProgressLoggerCfg<T> & {
         logEvery: number;
         logSizesBuffer: number;
-        batchSize: number;
+        chunkSize: number;
         metric: string;
         logger: CommonLogger;
     };

package/dist/stream/progressLogger.js

@@ -18,7 +18,7 @@ class ProgressLogger {
             logRPS: true,
             logEvery: 1000,
             logSizesBuffer: 100_000,
-            batchSize: 1,
+            chunkSize: 1,
             logger: console,
             logProgress: cfg.logProgress !== false && cfg.logEvery !== 0,
             ...cfg,
@@ -59,11 +59,11 @@ class ProgressLogger {
     logStats(chunk, final = false, tenx = false) {
         if (!this.cfg.logProgress)
             return;
-        const { metric, extra, batchSize, heapUsed: logHeapUsed, heapTotal: logHeapTotal, rss: logRss, peakRSS: logPeakRss, rssMinusHeap, external, arrayBuffers, logRPS, logger, } = this.cfg;
+        const { metric, extra, chunkSize, heapUsed: logHeapUsed, heapTotal: logHeapTotal, rss: logRss, peakRSS: logPeakRss, rssMinusHeap, external, arrayBuffers, logRPS, logger, } = this.cfg;
         const mem = process.memoryUsage();
         const now = Date.now();
-        const batchedProgress = this.progress * batchSize;
-        const lastRPS = (this.processedLastSecond * batchSize) / ((now - this.lastSecondStarted) / 1000) || 0;
+        const batchedProgress = this.progress * chunkSize;
+        const lastRPS = (this.processedLastSecond * chunkSize) / ((now - this.lastSecondStarted) / 1000) || 0;
         const rpsTotal = Math.round(batchedProgress / ((now - this.started) / 1000)) || 0;
         this.lastSecondStarted = now;
         this.processedLastSecond = 0;

package/dist/stream/transform/transformChunk.d.ts

@@ -0,0 +1,14 @@
+import { TransformOptions, TransformTyped } from '../stream.model';
+export interface TransformChunkOptions extends TransformOptions {
+    /**
+     * How many items to include in each chunk.
+     * Last chunk will contain the remaining items, possibly less than chunkSize.
+     */
+    chunkSize: number;
+}
+/**
+ * Similar to RxJS bufferCount(),
+ * allows to "chunk" the input stream into chunks of `opt.chunkSize` size.
+ * Last chunk will contain the remaining items, possibly less than chunkSize.
+ */
+export declare function transformChunk<IN = any>(opt: TransformChunkOptions): TransformTyped<IN, IN[]>;

package/dist/stream/transform/{transformBuffer.js → transformChunk.js}

@@ -1,21 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.transformBuffer = void 0;
+exports.transformChunk = void 0;
 const node_stream_1 = require("node:stream");
 /**
- * Similar to RxJS bufferCount()
- *
- * @default batchSize is 10
+ * Similar to RxJS bufferCount(),
+ * allows to "chunk" the input stream into chunks of `opt.chunkSize` size.
+ * Last chunk will contain the remaining items, possibly less than chunkSize.
  */
-function transformBuffer(opt) {
-    const { batchSize } = opt;
+function transformChunk(opt) {
+    const { chunkSize } = opt;
     let buf = [];
     return new node_stream_1.Transform({
         objectMode: true,
         ...opt,
         transform(chunk, _, cb) {
             buf.push(chunk);
-            if (buf.length >= batchSize) {
+            if (buf.length >= chunkSize) {
                 cb(null, buf);
                 buf = [];
             }
@@ -32,4 +32,4 @@ function transformBuffer(opt) {
         },
     });
 }
-exports.transformBuffer = transformBuffer;
+exports.transformChunk = transformChunk;

package/dist/validation/joi/joi.shared.schemas.d.ts

@@ -14,6 +14,7 @@ export declare const percentageSchema: NumberSchema<number>;
 export declare const dateStringSchema: StringSchema<string>;
 export declare const binarySchema: import("joi").BinarySchema<Buffer>;
 export declare const dateObjectSchema: ObjectSchema<any>;
+export declare const dateIntervalStringSchema: StringSchema<string>;
 /**
  * Allows all values of a String Enum.
  */

package/dist/validation/joi/joi.shared.schemas.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.baseDBEntitySchema = exports.ipAddressSchema = exports.utcOffsetSchema = exports.userAgentSchema = exports.semVerSchema = exports.SEM_VER_REGEX = exports.emailSchema = exports.verSchema = exports.unixTimestampMillis2000Schema = exports.unixTimestampMillisSchema = exports.unixTimestamp2000Schema = exports.unixTimestampSchema = exports.slugSchema = exports.SLUG_REGEX = exports.idBase64UrlSchema = exports.idBase64Schema = exports.idBase62Schema = exports.idSchema = exports.jwtSchema = exports.JWT_REGEX = exports.base64UrlSchema = exports.base64Schema = exports.base62Schema = exports.BASE64URL_REGEX = exports.BASE64_REGEX = exports.BASE62_REGEX = exports.anyObjectSchema = exports.anySchema = exports.oneOfSchema = exports.objectSchema = exports.arraySchema = exports.urlSchema = exports.numberEnumKeySchema = exports.numberEnumValueSchema = exports.stringEnumKeySchema = exports.stringEnumValueSchema = exports.dateObjectSchema = exports.binarySchema = exports.dateStringSchema = exports.percentageSchema = exports.integerSchema = exports.numberSchemaTyped = exports.numberSchema = exports.stringSchemaTyped = exports.stringSchema = exports.booleanDefaultToFalseSchema = exports.booleanSchema = void 0;
+exports.baseDBEntitySchema = exports.ipAddressSchema = exports.utcOffsetSchema = exports.userAgentSchema = exports.semVerSchema = exports.SEM_VER_REGEX = exports.emailSchema = exports.verSchema = exports.unixTimestampMillis2000Schema = exports.unixTimestampMillisSchema = exports.unixTimestamp2000Schema = exports.unixTimestampSchema = exports.slugSchema = exports.SLUG_REGEX = exports.idBase64UrlSchema = exports.idBase64Schema = exports.idBase62Schema = exports.idSchema = exports.jwtSchema = exports.JWT_REGEX = exports.base64UrlSchema = exports.base64Schema = exports.base62Schema = exports.BASE64URL_REGEX = exports.BASE64_REGEX = exports.BASE62_REGEX = exports.anyObjectSchema = exports.anySchema = exports.oneOfSchema = exports.objectSchema = exports.arraySchema = exports.urlSchema = exports.numberEnumKeySchema = exports.numberEnumValueSchema = exports.stringEnumKeySchema = exports.stringEnumValueSchema = exports.dateIntervalStringSchema = exports.dateObjectSchema = exports.binarySchema = exports.dateStringSchema = exports.percentageSchema = exports.integerSchema = exports.numberSchemaTyped = exports.numberSchema = exports.stringSchemaTyped = exports.stringSchema = exports.booleanDefaultToFalseSchema = exports.booleanSchema = void 0;
 const js_lib_1 = require("@naturalcycles/js-lib");
 const joi_extensions_1 = require("./joi.extensions");
 exports.booleanSchema = joi_extensions_1.Joi.boolean();
@@ -16,6 +16,10 @@ exports.percentageSchema = joi_extensions_1.Joi.number().integer().min(0).max(10
 exports.dateStringSchema = exports.stringSchema.dateString();
 exports.binarySchema = joi_extensions_1.Joi.binary();
 exports.dateObjectSchema = joi_extensions_1.Joi.object().instance(Date);
+const DATE_INTERVAL_REGEX = /^\d{4}-\d{2}-\d{2}\/\d{4}-\d{2}-\d{2}$/;
+exports.dateIntervalStringSchema = exports.stringSchema.regex(DATE_INTERVAL_REGEX).messages({
+    'string.pattern.base': `must be a DateInterval string`,
+});
 /**
  * Allows all values of a String Enum.
  */

package/dist/validation/joi/string.extensions.js

@@ -41,10 +41,10 @@ function stringExtensions(joi) {
                     let { min, max } = args;
                     // Today allows +-14 hours gap to account for different timezones
                     if (max === 'today') {
-                        max = (0, js_lib_1.localTimeNow)().add(14, 'hour').toISODate();
+                        max = (0, js_lib_1.localTimeNow)().plus(14, 'hour').toISODate();
                     }
                     if (min === 'today') {
-                        min = (0, js_lib_1.localTimeNow)().subtract(14, 'hour').toISODate();
+                        min = (0, js_lib_1.localTimeNow)().minus(14, 'hour').toISODate();
                     }
                     // console.log('min/max', min, max)
                     const m = /^(\d{4})-(\d{2})-(\d{2})$/.exec(v);

package/package.json

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

package/src/index.ts

@@ -44,7 +44,7 @@ export * from './stream/readable/readableFromArray'
 export * from './stream/readable/readableToArray'
 export * from './stream/stream.model'
 export * from './stream/progressLogger'
-export * from './stream/transform/transformBuffer'
+export * from './stream/transform/transformChunk'
 export * from './stream/transform/transformFilter'
 export * from './stream/transform/transformLimit'
 export * from './stream/transform/transformLogProgress'

package/src/stream/progressLogger.ts

@@ -103,12 +103,12 @@ export interface ProgressLoggerCfg<T = any> {
 
   /**
    * If specified - will multiply the counter by this number.
-   * Useful e.g when using `transformBuffer({ batchSize: 500 })`, so
-   * it'll accurately represent the number of processed entries (not batches).
+   * Useful e.g when using `transformChunk({ chunkSize: 500 })`, so
+   * it'll accurately represent the number of processed entries (not chunks).
    *
    * Defaults to 1.
    */
-  batchSize?: number
+  chunkSize?: number
 
   /**
    * Experimental logging of item (shunk) sizes, when json-stringified.
@@ -160,7 +160,7 @@ export class ProgressLogger<T> implements Disposable {
       logRPS: true,
       logEvery: 1000,
       logSizesBuffer: 100_000,
-      batchSize: 1,
+      chunkSize: 1,
       logger: console,
       logProgress: cfg.logProgress !== false && cfg.logEvery !== 0,
       ...cfg,
@@ -174,7 +174,7 @@ export class ProgressLogger<T> implements Disposable {
   cfg!: ProgressLoggerCfg<T> & {
     logEvery: number
     logSizesBuffer: number
-    batchSize: number
+    chunkSize: number
     metric: string
     logger: CommonLogger
   }
@@ -230,7 +230,7 @@ export class ProgressLogger<T> implements Disposable {
     const {
       metric,
       extra,
-      batchSize,
+      chunkSize,
       heapUsed: logHeapUsed,
       heapTotal: logHeapTotal,
       rss: logRss,
@@ -245,9 +245,9 @@ export class ProgressLogger<T> implements Disposable {
     const mem = process.memoryUsage()
 
     const now = Date.now()
-    const batchedProgress = this.progress * batchSize
+    const batchedProgress = this.progress * chunkSize
     const lastRPS =
-      (this.processedLastSecond * batchSize) / ((now - this.lastSecondStarted) / 1000) || 0
+      (this.processedLastSecond * chunkSize) / ((now - this.lastSecondStarted) / 1000) || 0
     const rpsTotal = Math.round(batchedProgress / ((now - this.started) / 1000)) || 0
     this.lastSecondStarted = now
     this.processedLastSecond = 0

package/src/stream/transform/transformChunk.ts

@@ -0,0 +1,44 @@
+import { Transform } from 'node:stream'
+import { TransformOptions, TransformTyped } from '../stream.model'
+
+export interface TransformChunkOptions extends TransformOptions {
+  /**
+   * How many items to include in each chunk.
+   * Last chunk will contain the remaining items, possibly less than chunkSize.
+   */
+  chunkSize: number
+}
+
+/**
+ * Similar to RxJS bufferCount(),
+ * allows to "chunk" the input stream into chunks of `opt.chunkSize` size.
+ * Last chunk will contain the remaining items, possibly less than chunkSize.
+ */
+export function transformChunk<IN = any>(opt: TransformChunkOptions): TransformTyped<IN, IN[]> {
+  const { chunkSize } = opt
+
+  let buf: IN[] = []
+
+  return new Transform({
+    objectMode: true,
+    ...opt,
+    transform(chunk, _, cb) {
+      buf.push(chunk)
+
+      if (buf.length >= chunkSize) {
+        cb(null, buf)
+        buf = []
+      } else {
+        cb()
+      }
+    },
+    final(this: Transform, cb) {
+      if (buf.length) {
+        this.push(buf)
+        buf = []
+      }
+
+      cb()
+    },
+  })
+}

package/src/validation/joi/joi.shared.schemas.ts

@@ -24,6 +24,11 @@ export const dateStringSchema = stringSchema.dateString()
 export const binarySchema = Joi.binary()
 export const dateObjectSchema = Joi.object().instance(Date)
 
+const DATE_INTERVAL_REGEX = /^\d{4}-\d{2}-\d{2}\/\d{4}-\d{2}-\d{2}$/
+export const dateIntervalStringSchema = stringSchema.regex(DATE_INTERVAL_REGEX).messages({
+  'string.pattern.base': `must be a DateInterval string`,
+})
+
 /**
  * Allows all values of a String Enum.
  */

package/src/validation/joi/string.extensions.ts

@@ -51,10 +51,10 @@ export function stringExtensions(joi: typeof Joi): Extension {
 
           // Today allows +-14 hours gap to account for different timezones
           if (max === 'today') {
-            max = localTimeNow().add(14, 'hour').toISODate()
+            max = localTimeNow().plus(14, 'hour').toISODate()
           }
           if (min === 'today') {
-            min = localTimeNow().subtract(14, 'hour').toISODate()
+            min = localTimeNow().minus(14, 'hour').toISODate()
           }
           // console.log('min/max', min, max)
 

package/dist/stream/transform/transformBuffer.d.ts

@@ -1,10 +0,0 @@
-import { TransformOptions, TransformTyped } from '../stream.model';
-export interface TransformBufferOptions extends TransformOptions {
-    batchSize: number;
-}
-/**
- * Similar to RxJS bufferCount()
- *
- * @default batchSize is 10
- */
-export declare function transformBuffer<IN = any>(opt: TransformBufferOptions): TransformTyped<IN, IN[]>;

package/src/stream/transform/transformBuffer.ts

@@ -1,40 +0,0 @@
-import { Transform } from 'node:stream'
-import { TransformOptions, TransformTyped } from '../stream.model'
-
-export interface TransformBufferOptions extends TransformOptions {
-  batchSize: number
-}
-
-/**
- * Similar to RxJS bufferCount()
- *
- * @default batchSize is 10
- */
-export function transformBuffer<IN = any>(opt: TransformBufferOptions): TransformTyped<IN, IN[]> {
-  const { batchSize } = opt
-
-  let buf: IN[] = []
-
-  return new Transform({
-    objectMode: true,
-    ...opt,
-    transform(chunk, _, cb) {
-      buf.push(chunk)
-
-      if (buf.length >= batchSize) {
-        cb(null, buf)
-        buf = []
-      } else {
-        cb()
-      }
-    },
-    final(this: Transform, cb) {
-      if (buf.length) {
-        this.push(buf)
-        buf = []
-      }
-
-      cb()
-    },
-  })
-}