@rainbow-o23/n1 1.0.56 → 1.0.58-alpha.2

package/README.md

@@ -127,6 +127,7 @@ Pipeline steps provide rich function support, and all the following functions or
 | $date.dayjs                                                              | Get [Day.js](https://day.js.org/).                                                                                                                                                                                   |
 | $math                                                                    | Get [Math.js](https://mathjs.org).                                                                                                                                                                                   |
 | $decimal(value: string \| number \| Decimal.value)                       | Create a decimal value by [Decimal.js](https://mikemcl.github.io/decimal.js/).                                                                                                                                       |
+| $zstd(buffer: Buffer): Promise<string>                                   | Decompress given buffer to string, using [zstd](https://developer.mozilla.org/en-US/docs/Glossary/Zstandard_compression).                                                                                            |
 | $nano(size?: number)                                                     | Create a nano string.                                                                                                                                                                                                |
 | $ascii(size?: number)                                                    | Create a nano string, only contains ascii characters (0-9, a-z, A-Z, _).                                                                                                                                             |
 | $error(options: PipelineStepErrorOptions)                                | Throw an exposed uncatchable error.                                                                                                                                                                                  |

package/index.cjs

@@ -5,6 +5,7 @@ var nanoid = require('nanoid');
 var dayjs = require('dayjs');
 var Decimal = require('decimal.js');
 var mathjs$1 = require('mathjs');
+var zstddec = require('zstddec');
 
 const ERR_PIPELINE_NOT_FOUND = 'O01-00001';
 const ERR_TRIM_NON_STRING = 'O01-00002';
@@ -623,6 +624,13 @@ const registerToStepHelpers = (helpers) => {
     RegisteredHelpers.helpers = helpers ?? {};
 };
 const mathjs = mathjs$1.create(mathjs$1.all, { number: 'BigNumber', precision: 32 });
+const removeTrailingZeros = (arr) => {
+    let i = arr.length;
+    while (i > 0 && arr[i - 1] === 0) {
+        i--;
+    }
+    return arr.slice(0, i);
+};
 const createStepHelpers = (config, logger) => {
     const helpers = {
         ...RegisteredHelpers.helpers,
@@ -630,6 +638,12 @@ const createStepHelpers = (config, logger) => {
         $date: new PipelineStepDateHelper(config),
         $math: mathjs,
         $decimal: (value) => new Decimal(value),
+        $zstd: async (buffer) => {
+            const decoder = new zstddec.ZSTDDecoder();
+            await decoder.init();
+            const decompressedArray = decoder.decode(buffer);
+            return new TextDecoder().decode(removeTrailingZeros(decompressedArray));
+        },
         $nano: exports.StepHelpersUtils.$nano, $ascii: exports.StepHelpersUtils.$ascii,
         $error: exports.StepHelpersUtils.createExposedUncatchableError,
         $errorCodes: ErrorCodes,

package/index.js

@@ -3,6 +3,7 @@ import { customAlphabet, nanoid } from 'nanoid';
 import dayjs from 'dayjs';
 import Decimal from 'decimal.js';
 import { create, all } from 'mathjs';
+import { ZSTDDecoder } from 'zstddec';
 
 const ERR_PIPELINE_NOT_FOUND = 'O01-00001';
 const ERR_TRIM_NON_STRING = 'O01-00002';
@@ -621,6 +622,13 @@ const registerToStepHelpers = (helpers) => {
     RegisteredHelpers.helpers = helpers ?? {};
 };
 const mathjs = create(all, { number: 'BigNumber', precision: 32 });
+const removeTrailingZeros = (arr) => {
+    let i = arr.length;
+    while (i > 0 && arr[i - 1] === 0) {
+        i--;
+    }
+    return arr.slice(0, i);
+};
 const createStepHelpers = (config, logger) => {
     const helpers = {
         ...RegisteredHelpers.helpers,
@@ -628,6 +636,12 @@ const createStepHelpers = (config, logger) => {
         $date: new PipelineStepDateHelper(config),
         $math: mathjs,
         $decimal: (value) => new Decimal(value),
+        $zstd: async (buffer) => {
+            const decoder = new ZSTDDecoder();
+            await decoder.init();
+            const decompressedArray = decoder.decode(buffer);
+            return new TextDecoder().decode(removeTrailingZeros(decompressedArray));
+        },
         $nano: StepHelpersUtils.$nano, $ascii: StepHelpersUtils.$ascii,
         $error: StepHelpersUtils.createExposedUncatchableError,
         $errorCodes: ErrorCodes,

package/lib/pipeline/step-helpers.d.ts

@@ -12,12 +12,14 @@ export declare class PipelineStepDateHelper {
 }
 export type PipelineStepMathHelper = MathJsInstance;
 export type PipelineStepDecimalHelper = (value: Decimal.Value) => Decimal;
+export type PipelineStepZStdHelper = (buffer: Buffer) => Promise<string>;
 export interface PipelineStepHelpers extends IStepHelpersUtils {
     $config?: Config;
     $logger?: Logger;
     $date: PipelineStepDateHelper;
     $math: PipelineStepMathHelper;
     $decimal: PipelineStepDecimalHelper;
+    $zstd: PipelineStepZStdHelper;
     $error: (options: PipelineStepErrorOptions) => never;
     $errorCodes: Readonly<Record<string, string>>;
     [key: string]: any;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@rainbow-o23/n1",
-	"version": "1.0.56",
+	"version": "1.0.58-alpha.2",
 	"description": "o23 interfaces",
 	"main": "index.cjs",
 	"module": "index.js",
@@ -25,7 +25,8 @@
 		"dayjs": "^1.11.13",
 		"decimal.js": "^10.4.3",
 		"mathjs": "^13.2.1",
-		"nanoid": "3.3.8"
+		"nanoid": "3.3.8",
+		"zstddec": "^0.1.0"
 	},
 	"devDependencies": {
 		"@babel/core": "^7.23.9",

package/rollup.config.base.js

@@ -25,7 +25,7 @@ export const buildConfig = (lint) => {
 			return ["dayjs/plugin/"].some(scope => id.startsWith(scope))
 				|| [
 					'@rainbow-n19/n1',
-					'nanoid', 'dayjs', 'mathjs', 'decimal.js'
+					'nanoid', 'dayjs', 'mathjs', 'decimal.js', "zstddec"
 				].includes(id);
 		}
 	};

package/src/lib/pipeline/step-helpers.ts

@@ -1,6 +1,7 @@
 import dayjs from 'dayjs';
 import Decimal from 'decimal.js';
 import {all, create, MathJsInstance} from 'mathjs';
+import {ZSTDDecoder} from 'zstddec';
 import {Config, DateTime, ErrorCodes, Logger} from '../utils';
 import {IStepHelpersUtils, PipelineStepErrorOptions, StepHelpersUtils} from './step-helpers-utils';
 
@@ -26,6 +27,7 @@ export class PipelineStepDateHelper {
 
 export type PipelineStepMathHelper = MathJsInstance;
 export type PipelineStepDecimalHelper = (value: Decimal.Value) => Decimal;
+export type PipelineStepZStdHelper = (buffer: Buffer) => Promise<string>;
 
 export interface PipelineStepHelpers extends IStepHelpersUtils {
 	$config?: Config;
@@ -34,6 +36,8 @@ export interface PipelineStepHelpers extends IStepHelpersUtils {
 	$math: PipelineStepMathHelper;
 	$decimal: PipelineStepDecimalHelper;
 
+	$zstd: PipelineStepZStdHelper;
+
 	/** create an exposed uncatchable error*/
 	$error: (options: PipelineStepErrorOptions) => never;
 	$errorCodes: Readonly<Record<string, string>>;
@@ -49,6 +53,14 @@ export const registerToStepHelpers = (helpers: Record<string, any>) => {
 };
 
 const mathjs = create(all, {number: 'BigNumber', precision: 32});
+const removeTrailingZeros = (arr: Uint8Array): Uint8Array => {
+	let i = arr.length;
+	while (i > 0 && arr[i - 1] === 0) {
+		i--;
+	}
+	return arr.slice(0, i);
+};
+
 export const createStepHelpers = (config: Config, logger: Logger): Readonly<PipelineStepHelpers> => {
 	const helpers: PipelineStepHelpers = {
 		...RegisteredHelpers.helpers,
@@ -57,6 +69,12 @@ export const createStepHelpers = (config: Config, logger: Logger): Readonly<Pipe
 		$date: new PipelineStepDateHelper(config),
 		$math: mathjs,
 		$decimal: (value: Decimal.Value) => new Decimal(value),
+		$zstd: async (buffer: Buffer) => {
+			const decoder = new ZSTDDecoder();
+			await decoder.init();
+			const decompressedArray = decoder.decode(buffer);
+			return new TextDecoder().decode(removeTrailingZeros(decompressedArray));
+		},
 		// nano
 		$nano: StepHelpersUtils.$nano, $ascii: StepHelpersUtils.$ascii,
 		// errors