@6thbridge/utils 1.8.2 → 1.8.3

package/lib/utils/file.d.ts

@@ -1,5 +1,5 @@
 import { PFunctionResult } from '../types';
-import { OptionsWithColumns } from 'csv-parse/sync';
+import { Options } from 'csv-parse/sync';
 import { Sheet2JSONOpts } from 'xlsx';
 export declare enum FileType {
     csv = "csv",
@@ -17,7 +17,7 @@ export type ConvertFilePayload = {
     destination: FileSourceOrDestination;
     fileType: FileType;
     sourceFile?: string | Buffer;
-    destinationFileParams?: OptionsWithColumns<any> | Sheet2JSONOpts | Record<string, any>;
+    destinationFileParams?: Options | Sheet2JSONOpts | Record<string, any>;
 };
 export declare class FileUtil {
     static getFileFromURL(url: string): Promise<Buffer>;

package/lib/utils/file.js.map

@@ -1 +1 @@
-{"version":3,"file":"file.js","sourceRoot":"","sources":["../../src/utils/file.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,yCAAyD;AACzD,gDAA0C;AAE1C,IAAY,QAIX;AAJD,WAAY,QAAQ;IAClB,uBAAW,CAAA;IACX,yBAAa,CAAA;IACb,uBAAW,CAAA;AACb,CAAC,EAJW,QAAQ,wBAAR,QAAQ,QAInB;AAED,IAAY,uBAIX;AAJD,WAAY,uBAAuB;IACjC,sCAAW,CAAA;IACX,sCAAW,CAAA;IACX,wCAAa,CAAA;AACf,CAAC,EAJW,uBAAuB,uCAAvB,uBAAuB,QAIlC;AAWD,MAAa,QAAQ;IACnB,MAAM,CAAO,cAAc,CAAC,GAAW;;YACrC,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;YAChC,MAAM,WAAW,GAAG,MAAM,MAAM,CAAC,WAAW,EAAE,CAAC;YAC/C,OAAO,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAClC,CAAC;KAAA;IAED,MAAM,CAAO,WAAW,CAAC,OAA2B;;YAClD,IAAI,IAAkB,CAAC;YACvB,IAAI,OAAO,CAAC,MAAM,KAAK,uBAAuB,CAAC,GAAG,EAAE,CAAC;gBACnD,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC,UAAoB,CAAC,CAAC;gBACzD,IAAI,GAAG,MAAM,MAAM,CAAC,WAAW,EAAE,CAAC;YACpC,CAAC;YAED,IAAI,OAAO,CAAC,QAAQ,IAAI,QAAQ,CAAC,GAAG,IAAI,OAAO,CAAC,WAAW,KAAK,uBAAuB,CAAC,IAAI,EAAE,CAAC;gBAC7F,OAAO;oBACL,IAAI,EAAE,IAAA,YAAK,EAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,OAAO,CAAC,qBAAgD,CAAC;iBACpG,CAAC;YACJ,CAAC;YAED,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,OAAO,CAAC,WAAW,KAAK,uBAAuB,CAAC,IAAI,EAAE,CAAC;gBACrH,MAAM,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACjC,MAAM,SAAS,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;gBACzC,MAAM,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;gBAC7C,MAAM,IAAI,GAAG,cAAI,CAAC,KAAK,CAAC,aAAa,CAAC,SAAS,kBAC3C,MAAM,EAAE,CAAC,EACT,GAAG,EAAE,KAAK,EACV,MAAM,EAAE,EAAE,EACV,SAAS,EAAE,KAAK,IACb,OAAO,CAAC,qBAAuC,EAErD,CAAC;gBAEF,OAAO;oBACL,IAAI,EAAE,IAAI;iBACX,CAAC;YACJ,CAAC;YAED,OAAO;gBACL,IAAI,EAAE,IAAI;aACX,CAAC;QACJ,CAAC;KAAA;CACF;AA1CD,4BA0CC;AAID,MAAM;AACN,2BAA2B;AAC3B,2BAA2B;AAC3B,yCAAyC;AACzC,4BAA4B;AAC5B,0GAA0G;AAC1G,+CAA+C;AAC/C,6BAA6B;AAC7B,qBAAqB;AACrB,sBAAsB;AACtB,8BAA8B;AAC9B,OAAO;AACP,uBAAuB;AACvB,2BAA2B;AAG3B,2BAA2B;AAC3B,2BAA2B;AAC3B,yCAAyC;AACzC,6BAA6B;AAC7B,0GAA0G;AAC1G,+CAA+C;AAC/C,6BAA6B;AAC7B,qBAAqB;AACrB,oBAAoB;AACpB,8BAA8B;AAC9B,OAAO;AACP,uBAAuB;AACvB,2BAA2B"}
+{"version":3,"file":"file.js","sourceRoot":"","sources":["../../src/utils/file.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,yCAAgD;AAChD,gDAA0C;AAE1C,IAAY,QAIX;AAJD,WAAY,QAAQ;IAClB,uBAAW,CAAA;IACX,yBAAa,CAAA;IACb,uBAAW,CAAA;AACb,CAAC,EAJW,QAAQ,wBAAR,QAAQ,QAInB;AAED,IAAY,uBAIX;AAJD,WAAY,uBAAuB;IACjC,sCAAW,CAAA;IACX,sCAAW,CAAA;IACX,wCAAa,CAAA;AACf,CAAC,EAJW,uBAAuB,uCAAvB,uBAAuB,QAIlC;AAWD,MAAa,QAAQ;IACnB,MAAM,CAAO,cAAc,CAAC,GAAW;;YACrC,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;YAChC,MAAM,WAAW,GAAG,MAAM,MAAM,CAAC,WAAW,EAAE,CAAC;YAC/C,OAAO,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAClC,CAAC;KAAA;IAED,MAAM,CAAO,WAAW,CAAC,OAA2B;;YAClD,IAAI,IAAkB,CAAC;YACvB,IAAI,OAAO,CAAC,MAAM,KAAK,uBAAuB,CAAC,GAAG,EAAE,CAAC;gBACnD,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC,UAAoB,CAAC,CAAC;gBACzD,IAAI,GAAG,MAAM,MAAM,CAAC,WAAW,EAAE,CAAC;YACpC,CAAC;YAED,IAAI,OAAO,CAAC,QAAQ,IAAI,QAAQ,CAAC,GAAG,IAAI,OAAO,CAAC,WAAW,KAAK,uBAAuB,CAAC,IAAI,EAAE,CAAC;gBAC7F,OAAO;oBACL,IAAI,EAAE,IAAA,YAAK,EAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,OAAO,CAAC,qBAAgC,CAAC;iBACpF,CAAC;YACJ,CAAC;YAED,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,OAAO,CAAC,WAAW,KAAK,uBAAuB,CAAC,IAAI,EAAE,CAAC;gBACrH,MAAM,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACjC,MAAM,SAAS,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;gBACzC,MAAM,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;gBAC7C,MAAM,IAAI,GAAG,cAAI,CAAC,KAAK,CAAC,aAAa,CAAC,SAAS,kBAC3C,MAAM,EAAE,CAAC,EACT,GAAG,EAAE,KAAK,EACV,MAAM,EAAE,EAAE,EACV,SAAS,EAAE,KAAK,IACb,OAAO,CAAC,qBAAuC,EAErD,CAAC;gBAEF,OAAO;oBACL,IAAI,EAAE,IAAI;iBACX,CAAC;YACJ,CAAC;YAED,OAAO;gBACL,IAAI,EAAE,IAAI;aACX,CAAC;QACJ,CAAC;KAAA;CACF;AA1CD,4BA0CC;AAID,MAAM;AACN,2BAA2B;AAC3B,2BAA2B;AAC3B,yCAAyC;AACzC,4BAA4B;AAC5B,0GAA0G;AAC1G,+CAA+C;AAC/C,6BAA6B;AAC7B,qBAAqB;AACrB,sBAAsB;AACtB,8BAA8B;AAC9B,OAAO;AACP,uBAAuB;AACvB,2BAA2B;AAG3B,2BAA2B;AAC3B,2BAA2B;AAC3B,yCAAyC;AACzC,6BAA6B;AAC7B,0GAA0G;AAC1G,+CAA+C;AAC/C,6BAA6B;AAC7B,qBAAqB;AACrB,oBAAoB;AACpB,8BAA8B;AAC9B,OAAO;AACP,uBAAuB;AACvB,2BAA2B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@6thbridge/utils",
-  "version": "1.8.2",
+  "version": "1.8.3",
   "description": "simple interface for the our commonly used functions",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -41,6 +41,7 @@
     "mongoose-paginate-v2": "^1.9.5",
     "path-to-regexp": "^8.4.2",
     "randomstring": "^1.3.1",
+    "redlock": "^5.0.0-beta.2",
     "rollbar": "^3.1.0",
     "xlsx": "https://cdn.sheetjs.com/xlsx-0.20.3/xlsx-0.20.3.tgz",
     "zod": "^4.6.5",

package/readme.md

@@ -7,6 +7,7 @@ A comprehensive TypeScript utility library for Node.js applications, providing r
 - [Core Modules](#core-modules)
 - [API Reference](#api-reference)
 - [Examples](#examples)
+- [Pipelines](#pipelines)
 - [Testing](#testing)
 - [Contributing](#contributing)
 - [License](#license)
@@ -290,6 +291,93 @@ LOG_OUT=1
 # Service URLs
 USER_SERVICE_URL=http://user-service:3000
 ```
+## Pipelines
+
+`SerialPipeline` passes each executed step's result to the next step. `ParallelPipeline`
+runs independent steps concurrently with the same initial input and returns named results.
+Both accept the existing `ContextEntity` as the first argument on every invocation; the
+pipeline never stores context.
+
+Every step must provide `shouldRun(contextEntity, input): Promise<boolean>` and
+`run(contextEntity, input): Promise<Result>`. Implementers choose the result type.
+Register objects or class instances with `.pipe(name, step)`. Names must be unique.
+Registration returns a new pipeline, so retain the returned instance or chain calls.
+
+### Serial transformations and skipped steps
+
+```typescript
+import { ContextEntity, PipelineStep, SerialPipeline } from '@6thbridge/utils';
+
+class MeasureText implements PipelineStep<string, number> {
+  constructor(private minimumLength: number) {}
+
+  async shouldRun(contextEntity: ContextEntity, input: string): Promise<boolean> {
+    return input.length >= this.minimumLength;
+  }
+
+  async run(contextEntity: ContextEntity, input: string): Promise<number> {
+    return input.length;
+  }
+}
+
+const pipeline = new SerialPipeline<string>()
+  .pipe('measure', new MeasureText(3))
+  .pipe('describe', {
+    async shouldRun(contextEntity, input) {
+      return true;
+    },
+    async run(contextEntity, input) {
+      // input is string | number: skipped measurement forwards the original string.
+      return typeof input === 'number' ? `Length: ${input}` : `Unmeasured: ${input}`;
+    },
+  });
+
+const contextEntity = new ContextEntity();
+await pipeline.run(contextEntity, 'hello'); // "Length: 5"
+await pipeline.run(new ContextEntity(), 'hi'); // "Unmeasured: hi"
+```
+
+Serial execution awaits each predicate and result in registration order. A skipped step
+forwards its input unchanged, so downstream input and the final result include the types
+of values that may pass through skipped steps. Class instance methods retain their `this`.
+
+### Named parallel results
+
+```typescript
+import { ContextEntity, ParallelPipeline } from '@6thbridge/utils';
+
+const pipeline = new ParallelPipeline<string>()
+  .pipe('length', {
+    async shouldRun(contextEntity, input) {
+      return true;
+    },
+    async run(contextEntity, input) {
+      return input.length;
+    },
+  })
+  .pipe('uppercase', {
+    async shouldRun(contextEntity, input) {
+      return input.length > 0;
+    },
+    async run(contextEntity, input) {
+      return input.toUpperCase();
+    },
+  });
+
+const results = await pipeline.run(new ContextEntity(), 'hello');
+// { length: 5, uppercase: 'HELLO' }
+// Inferred properties: length?: number; uppercase?: string.
+```
+
+Parallel predicates and executions run independently. Skipped steps are omitted from the
+result object; executed steps returning `undefined` still have a result property. Result
+keys follow registration order regardless of completion order.
+
+Both pipelines reject errors from `shouldRun` or `run`. Serial execution stops before the
+next step; already started parallel work continues. Empty serial pipelines return their
+input, and empty parallel pipelines return `{}`. Pipelines can be reused concurrently
+with different contexts and inputs; callers manage any mutable state inside their steps.
+
 ## Testing
 The library includes comprehensive test suites using Jest:
 ``` bash
@@ -377,3 +465,22 @@ This project is licensed under the ISC License.
 ## Support
 For support and questions, please open an issue on the GitHub repository.
 **Note**: This library is actively maintained and used in production environments. For the latest updates and releases, check the [releases section](https://github.com/6thbridge/utils/releases).
+
+## Lock and database transaction actions
+
+Create these actions with dependencies owned by the consuming service. The package does not create Redis or MongoDB connections.
+
+```ts
+import { DatabaseSessionAction, LockAction } from '@6thbridge/utils';
+
+LockAction.configure(redisClient);
+DatabaseSessionAction.configure(transactionRepository.getModel());
+
+await DatabaseSessionAction.withTransaction(
+  context,
+  async (session) => transactionRepository.updateMany(filter, update, { session }),
+  { lockKey: ['wallet:123'], lockTTLInSeconds: 10 },
+);
+```
+
+`redisClient` must be an initialized `RedisClient`; `LockAction.configure` creates Redlock with the package retry settings. Every action method takes a `ContextEntity` first and uses its logger. Database sessions run only when `NODE_ENV` is `production`; callbacks receive `null` for the session in other environments. Returned locks need `release()`; sessions need the MongoDB transaction methods.