@bizone-ai/json-transform-utils 1.10.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-Present  Suriel Bendahan and contributors.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,81 @@
+# @bizone-ai/json-transform-utils
+
+![](https://img.shields.io/npm/v/@bizone-ai/json-transform-utils.svg)
+
+Core types and utilities for handling JSON transformers
+
+# Installation
+
+`npm install @bizone-ai/json-transform-utils`
+
+# API
+
+```typescript
+{
+  ContextVariablesSchemas: Record<string, TypeSchema>,
+  getFunctionInlineSignature:  (name: string, func: FunctionDescriptor, requiredOnly?: boolean) => string,
+  getFunctionObjectSignature:  (name: string, func: FunctionDescriptor) => string,
+  functionsParser:  {
+    get(name: string) => FunctionDescriptor,
+    getNames() => Set<string>,
+    resolveDocsUrl(funcName: string, functionDescriptor ? : FunctionDescriptor) => string,
+    matchInline(
+      data: any,
+      callback?: (
+        funcName: EmbeddedTransformerFunction,
+        func: FunctionDescriptor,
+        value: any,
+        args: Record<string, any>,
+      ) => any): FunctionDescriptor | null,
+    matchObject(data: any, extractOutputTypeRecursively ? : boolean):ObjectFunctionMatchResult | undefined,
+    matchAllObjectFunctionsInLine(line: string) => IterableIterator,
+    matchAllInlineFunctionsInLine(line: string) => IterableIterator,
+  },
+  parseArgs: (func: FunctionDescriptor, args?: string) => {},
+  type Argument,
+  type ArgumentCondition,
+  type ConditionalSubFunction,
+  type FunctionDefinition,
+  type FunctionDescriptor,
+  EmbeddedTransformerFunction, // enum
+  EmbeddedTransformerFunctions: EmbeddedTransformerFunction[],
+  type JsonTransformExample,
+  jsonpathJoin: (...args: (string | null | undefined)[]): string,
+  JsonPathFunctionRegex: RegExp,
+  parseTransformer: (
+    definition: any,
+    targetPath: string,
+    previousPaths: string[],
+    paths: string[] = [],
+    typesMap? : Record<string, TypeSchema>,
+    additionalContext? : Record<string, TypeSchema>,
+  ) => void,
+  ParseContext: {
+    resolve(name: string) => TypeSchema,
+  },
+  type ParseMethod,
+  type HandleFunctionMethod,
+  definitions: Record<EmbeddedTransformerFunction, FunctionDefinition>,
+  examples: Record<EmbeddedTransformerFunction, JsonTransformExample>,
+  functions: Record<EmbeddedTransformerFunction, FunctionDescriptor>, 
+  transformUtils: { //TransformUtils
+    setAdditionalContext: (additionalContext: Set<string>) => void,
+    getAdditionalContext: () => Set<string>,
+    setSpecialKeys: (specialKeys: Set<string>) => void,
+    getSpecialKeys: () => Set<string>,
+    setContextVariablesSchemas: (contextVariablesSchemas: Record<string, TypeSchema>) => void,
+    getContextVariablesSchemas: () => Record<string, TypeSchema>,
+    setScopedContextVariablesSchema: (scopedContextVariablesSchema: Record<string, TypeSchema | null>) => void,
+    getScopedContextVariablesSchema: () => Record<string, TypeSchema | null>,
+    matchesAnyOfContextVariables: (variableName: string) => boolean,
+    matchesAnyOfAdditionalContext: (variableName: string) => boolean,
+    matchesAnyOfSpecialKeys: (variableName: string) => boolean,
+    variableDetectionRegExpFactory: (flags = "g") => RegExp,
+  }
+}
+;
+
+```
+
+# License
+[MIT](./LICENSE)

package/dist/ParseContext.d.ts

@@ -0,0 +1,23 @@
+import { TypeSchema } from "@bizone-ai/json-schema-utils";
+import { FunctionDescriptor } from "./functions/types";
+export declare class ParseContext {
+    private readonly paths?;
+    private readonly additionalContext?;
+    private knownVariables;
+    constructor(paths?: Record<string, TypeSchema>, additionalContext?: Record<string, TypeSchema>, previousPaths?: string[]);
+    hasPaths(): boolean;
+    hasPath(path: string): boolean;
+    /**
+     * If you are about to change the result, use this and not 'resolve()'
+     * @param path
+     */
+    getPath(path: string): TypeSchema | undefined;
+    setPath(path: string, type: TypeSchema): void;
+    removePaths(paths: string[], variableToRemove?: string): void;
+    resolve(key: string): TypeSchema;
+    isReferencingKnownVariable(path: any): boolean;
+}
+export type ParseMethod = (definition: any, targetPath: string, localPath: string, previousPaths: string[], paths: string[], context: ParseContext) => void;
+export type HandleFunctionMethod = (detectedAs: "inline" | "object", funcName: string, func: FunctionDescriptor, value: any, args: Record<string, any>, targetPath: string, localPath: string, previousPaths: string[], paths: string[], context: ParseContext, parse?: ParseMethod) => boolean;
+export default ParseContext;
+//# sourceMappingURL=ParseContext.d.ts.map

package/dist/ParseContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ParseContext.d.ts","sourceRoot":"","sources":["../src/ParseContext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAE1D,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAEvD,qBAAa,YAAY;IACvB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAA6B;IACpD,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAA6B;IAChE,OAAO,CAAC,cAAc,CAAc;gBAGlC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,EAClC,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,EAC9C,aAAa,CAAC,EAAE,MAAM,EAAE;IAyB1B,QAAQ;IAIR,OAAO,CAAC,IAAI,EAAE,MAAM;IAIpB;;;OAGG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM;IAIpB,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU;IAOtC,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,gBAAgB,CAAC,EAAE,MAAM;IAStD,OAAO,CAAC,GAAG,EAAE,MAAM;IAInB,0BAA0B,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO;CAK/C;AAED,MAAM,MAAM,WAAW,GAAG,CACxB,UAAU,EAAE,GAAG,EACf,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,EACjB,aAAa,EAAE,MAAM,EAAE,EACvB,KAAK,EAAE,MAAM,EAAE,EACf,OAAO,EAAE,YAAY,KAClB,IAAI,CAAC;AAEV,MAAM,MAAM,oBAAoB,GAAG,CACjC,UAAU,EAAE,QAAQ,GAAG,QAAQ,EAC/B,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,kBAAkB,EACxB,KAAK,EAAE,GAAG,EACV,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACzB,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,EACjB,aAAa,EAAE,MAAM,EAAE,EACvB,KAAK,EAAE,MAAM,EAAE,EACf,OAAO,EAAE,YAAY,EACrB,KAAK,CAAC,EAAE,WAAW,KAChB,OAAO,CAAC;AAEb,eAAe,YAAY,CAAC"}

package/dist/ParseContext.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ParseContext = void 0;
+const ContextVariablesSchemas_1 = require("./functions/ContextVariablesSchemas");
+class ParseContext {
+    constructor(paths, additionalContext, previousPaths) {
+        this.paths = paths;
+        this.additionalContext = additionalContext;
+        this.knownVariables = new Set();
+        if (paths) {
+            for (const path in paths) {
+                const v = path.split(/[.[]/, 1)[0];
+                this.knownVariables.add(v);
+            }
+        }
+        if (additionalContext) {
+            for (const path in additionalContext) {
+                const v = path.split(/[.[]/, 1)[0];
+                this.knownVariables.add(v);
+            }
+        }
+        if (previousPaths) {
+            for (const path of previousPaths) {
+                const v = path.split(/[.[]/, 1)[0];
+                this.knownVariables.add(v);
+            }
+        }
+    }
+    hasPaths() {
+        return Boolean(this.paths);
+    }
+    hasPath(path) {
+        return typeof this.paths?.[path] !== "undefined";
+    }
+    /**
+     * If you are about to change the result, use this and not 'resolve()'
+     * @param path
+     */
+    getPath(path) {
+        return this.paths?.[path];
+    }
+    setPath(path, type) {
+        if (!this.paths)
+            return;
+        this.paths[path] = type;
+        const v = path.split(/[.[]/, 1)[0];
+        this.knownVariables.add(v);
+    }
+    removePaths(paths, variableToRemove) {
+        for (const path of paths) {
+            delete this.paths?.[path];
+        }
+        if (variableToRemove) {
+            this.knownVariables.delete(variableToRemove);
+        }
+    }
+    resolve(key) {
+        return ContextVariablesSchemas_1.ContextVariablesSchemas[key] ?? this.additionalContext?.[key] ?? this.paths?.[key];
+    }
+    isReferencingKnownVariable(path) {
+        if (typeof path !== "string" || path.startsWith("$$"))
+            return false;
+        const v = path.split(/[.[]/, 1)[0];
+        return this.knownVariables.has(v) && (path === v || path.startsWith(v + ".") || path.startsWith(v + "["));
+    }
+}
+exports.ParseContext = ParseContext;
+exports.default = ParseContext;
+//# sourceMappingURL=ParseContext.js.map

package/dist/ParseContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ParseContext.js","sourceRoot":"","sources":["../src/ParseContext.ts"],"names":[],"mappings":";;;AACA,iFAA8E;AAG9E,MAAa,YAAY;IAKvB,YACE,KAAkC,EAClC,iBAA8C,EAC9C,aAAwB;QAExB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QAC3C,IAAI,CAAC,cAAc,GAAG,IAAI,GAAG,EAAE,CAAC;QAChC,IAAI,KAAK,EAAE,CAAC;YACV,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;gBACzB,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBACnC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YAC7B,CAAC;QACH,CAAC;QACD,IAAI,iBAAiB,EAAE,CAAC;YACtB,KAAK,MAAM,IAAI,IAAI,iBAAiB,EAAE,CAAC;gBACrC,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBACnC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YAC7B,CAAC;QACH,CAAC;QACD,IAAI,aAAa,EAAE,CAAC;YAClB,KAAK,MAAM,IAAI,IAAI,aAAa,EAAE,CAAC;gBACjC,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBACnC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YAC7B,CAAC;QACH,CAAC;IACH,CAAC;IAED,QAAQ;QACN,OAAO,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC7B,CAAC;IAED,OAAO,CAAC,IAAY;QAClB,OAAO,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,KAAK,WAAW,CAAC;IACnD,CAAC;IAED;;;OAGG;IACH,OAAO,CAAC,IAAY;QAClB,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED,OAAO,CAAC,IAAY,EAAE,IAAgB;QACpC,IAAI,CAAC,IAAI,CAAC,KAAK;YAAE,OAAO;QACxB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;QACxB,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACnC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAC7B,CAAC;IAED,WAAW,CAAC,KAAe,EAAE,gBAAyB;QACpD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,CAAC;QAC5B,CAAC;QACD,IAAI,gBAAgB,EAAE,CAAC;YACrB,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;IAED,OAAO,CAAC,GAAW;QACjB,OAAO,iDAAuB,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,iBAAiB,EAAE,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC;IAC5F,CAAC;IAED,0BAA0B,CAAC,IAAS;QAClC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YAAE,OAAO,KAAK,CAAC;QACpE,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACnC,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,CAAC,GAAG,GAAG,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;IAC5G,CAAC;CACF;AA1ED,oCA0EC;AAyBD,kBAAe,YAAY,CAAC"}

package/dist/__tests__/functions/functionsParser.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=functionsParser.test.d.ts.map

package/dist/__tests__/functions/functionsParser.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"functionsParser.test.d.ts","sourceRoot":"","sources":["../../../src/__tests__/functions/functionsParser.test.ts"],"names":[],"mappings":""}