@api-client/core 0.3.0

package/build/src/runtime/variables/EvalFunctions.js

@@ -0,0 +1,123 @@
+import { find, store } from './Cache.js';
+export const hasBuffer = typeof Buffer === 'function';
+/**
+ * A map of functions that evaluates values with native functions.
+ */
+export class EvalFunctions {
+    /**
+     * Calls `encodeURIComponent()` function on the first item of arguments array
+     * @param args List of expression arguments
+     * @return Encoded value
+     * @throws {Error} When input has no value.
+     */
+    static EncodeURIComponent(cacheTarget, args) {
+        const value = args && args[0];
+        if (!value) {
+            throw new Error('encodeURIComponent() requires a value');
+        }
+        return encodeURIComponent(value);
+    }
+    /**
+     * Calls `decodeURIComponent()` function on the first item of arguments array
+     * @param args List of expression arguments
+     * @return Decoded value
+     * @throws {Error} When input has no value.
+     */
+    static DecodeURIComponent(cacheTarget, args) {
+        const value = args && args[0];
+        if (!value) {
+            throw new Error('decodeURIComponent() requires a value');
+        }
+        return decodeURIComponent(value);
+    }
+    /**
+     * Calls the `btoa()` function on the first item on the arguments array
+     * @param args List of expression arguments
+     * @return Decoded value
+     * @throws {Error} When input has no value.
+     */
+    static Btoa(cacheTarget, args = []) {
+        const [value] = args;
+        if (!value) {
+            throw new Error('btoa() requires a value');
+        }
+        if (hasBuffer) {
+            const b = Buffer.from(value);
+            return b.toString('base64');
+        }
+        return btoa(value);
+    }
+    /**
+     * Calls the `atob()` function on the first item on the arguments array
+     * @param args List of expression arguments
+     * @return Decoded value
+     * @throws {Error} When input has no value.
+     */
+    static Atob(cacheTarget, args = []) {
+        const [value] = args;
+        if (!value) {
+            throw new Error('atob() requires a value');
+        }
+        if (hasBuffer) {
+            const b = Buffer.from(value, 'base64');
+            return b.toString('utf8');
+        }
+        return atob(value);
+    }
+    /**
+     * Calls the `now()` function. Returns current timestamp.
+     * If argument is passed is will try to retrieve existing cached value
+     * or create new one.
+     *
+     * @param args Arguments passed to the function
+     * @return Current timestamp
+     */
+    static Now(cacheTarget, args) {
+        const key = '__evalFnNow';
+        const hasGroup = !!(args && args[0]);
+        let value;
+        if (hasGroup) {
+            value = find(cacheTarget, key, args[0]);
+        }
+        if (!value) {
+            value = Date.now();
+        }
+        if (hasGroup) {
+            store(cacheTarget, key, args[0], value);
+        }
+        return value;
+    }
+    /**
+     * Generates random integer value. If a group is passed in the `args` then
+     * it looks for the value in the cache and prefers it if available.
+     *
+     * @param args Arguments passed to the function
+     * @returns Current timestamp
+     */
+    static Random(cacheTarget, args) {
+        const key = '__evalFnRandom';
+        const hasGroup = !!(args && args[0]);
+        let value;
+        if (hasGroup) {
+            value = find(cacheTarget, key, args[0]);
+        }
+        if (!value) {
+            value = EvalFunctions.randomInt();
+        }
+        if (hasGroup) {
+            store(cacheTarget, key, args[0], value);
+        }
+        return value;
+    }
+    /**
+     * Returns a random `int` between 0 (inclusive) and
+     * `Number.MAX_SAFE_INTEGER` (exclusive) with roughly equal probability of
+     * returning any particular `int` in this range.
+     */
+    static randomInt() {
+        // "|0" forces the value to a 32 bit integer.
+        // Number.MAX_SAFE_INTEGER
+        return Math.abs(Math.floor(Math.random() * 9007199254740991) | 0);
+    }
+}
+//# sourceMappingURL=EvalFunctions.js.map

package/build/src/runtime/variables/EvalFunctions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EvalFunctions.js","sourceRoot":"","sources":["../../../../src/runtime/variables/EvalFunctions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAEzC,MAAM,CAAC,MAAM,SAAS,GAAY,OAAO,MAAM,KAAK,UAAU,CAAC;AAE/D;;GAEG;AACH,MAAM,OAAO,aAAa;IAGxB;;;;;OAKG;IACH,MAAM,CAAC,kBAAkB,CAAC,WAAmB,EAAE,IAAe;QAC5D,MAAM,KAAK,GAAG,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC;QAC9B,IAAI,CAAC,KAAK,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;SAC1D;QACD,OAAO,kBAAkB,CAAC,KAAK,CAAC,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,kBAAkB,CAAC,WAAmB,EAAE,IAAe;QAC5D,MAAM,KAAK,GAAG,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC;QAC9B,IAAI,CAAC,KAAK,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;SAC1D;QACD,OAAO,kBAAkB,CAAC,KAAK,CAAC,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,IAAI,CAAC,WAAmB,EAAE,OAAiB,EAAE;QAClD,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;QACrB,IAAI,CAAC,KAAK,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;SAC5C;QACD,IAAI,SAAS,EAAE;YACb,MAAM,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC7B,OAAO,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC;IACrB,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,IAAI,CAAC,WAAmB,EAAE,OAAiB,EAAE;QAClD,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;QACrB,IAAI,CAAC,KAAK,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;SAC5C;QACD,IAAI,SAAS,EAAE;YACb,MAAM,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;YACvC,OAAO,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;SAC3B;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC;IACrB,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,GAAG,CAAC,WAAmB,EAAE,IAAe;QAC7C,MAAM,GAAG,GAAG,aAAa,CAAC;QAC1B,MAAM,QAAQ,GAAG,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QACrC,IAAI,KAAK,CAAC;QACV,IAAI,QAAQ,EAAE;YACZ,KAAK,GAAG,IAAI,CAAC,WAAW,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;SACzC;QACD,IAAI,CAAC,KAAK,EAAE;YACV,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;SACpB;QACD,IAAI,QAAQ,EAAE;YACZ,KAAK,CAAC,WAAW,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;SACzC;QACD,OAAO,KAAe,CAAC;IACzB,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,MAAM,CAAC,WAAmB,EAAE,IAAe;QAChD,MAAM,GAAG,GAAG,gBAAgB,CAAC;QAC7B,MAAM,QAAQ,GAAG,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QACrC,IAAI,KAAK,CAAC;QACV,IAAI,QAAQ,EAAE;YACZ,KAAK,GAAG,IAAI,CAAC,WAAW,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;SACzC;QACD,IAAI,CAAC,KAAK,EAAE;YACV,KAAK,GAAG,aAAa,CAAC,SAAS,EAAE,CAAC;SACnC;QACD,IAAI,QAAQ,EAAE;YACZ,KAAK,CAAC,WAAW,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;SACzC;QACD,OAAO,KAAe,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,SAAS;QACd,6CAA6C;QAC7C,0BAA0B;QAC1B,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC;IACpE,CAAC;CACF"}

package/build/src/runtime/variables/ProjectVariables.d.ts

@@ -0,0 +1,5 @@
+/**
+ * A class that processes values in the request object.
+ */
+export declare class RequestVariables {
+}

package/build/src/runtime/variables/ProjectVariables.js

@@ -0,0 +1,6 @@
+/**
+ * A class that processes values in the request object.
+ */
+export class RequestVariables {
+}
+//# sourceMappingURL=ProjectVariables.js.map

package/build/src/runtime/variables/ProjectVariables.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProjectVariables.js","sourceRoot":"","sources":["../../../../src/runtime/variables/ProjectVariables.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,OAAO,gBAAgB;CAE5B"}

package/build/src/runtime/variables/VariablesProcessor.d.ts

@@ -0,0 +1,165 @@
+import { Jexl } from '@pawel-up/jexl';
+import { Property } from '../../models/Property.js';
+export interface EvaluateOptions {
+    /**
+     * The execution context to use instead of creating the context
+     */
+    context?: Record<string, string>;
+    /**
+     * The list of properties to evaluate. If not set then it scans for all keys in the object.
+     * This is used when evaluating objects.
+     */
+    names?: string[];
+}
+export declare function valueHasVariable(value: string): boolean;
+export declare const functionRegex: RegExp;
+export declare const varValueRe: RegExp;
+export declare const varExprRe: RegExp;
+export declare const varStrictExprRe: RegExp;
+export declare class VariablesProcessor {
+    jexl: Jexl;
+    /**
+     * A helper function to map properties to the context object.
+     *
+     * The arguments are the lists of `Property`. It starts reading the variables from the right to left,
+     * meaning, variables on the left override variables already defined on the left.
+     *
+     * ```javascript
+     * const result = VariablesProcessor.createContextFromProperties([Property.String('test1', 'value1')], [Property.String('test1', 'value2')]);
+     * ```
+     * The result has only one variable `test1` with value `value1` because this value if left most in the arguments list.
+     *
+     * When a property with the same name is repeated in the same group then the last value wins.
+     *
+     * Note, variables without a name, not enabled, or which `value` is undefined are ignored.
+     */
+    static createContextFromProperties(...input: Property[][]): Record<string, string>;
+    /**
+     * Processes the context itself. This way the context can also contain variables.
+     *
+     * @return Promise resolved to the context to be passed to Jexl.
+     */
+    buildContext(unprocessedContext: Record<string, string>): Promise<Record<string, string>>;
+    /**
+     * Processes variables in the context recursively.
+     *
+     * @param result A result to where to put the values.
+     * @param variables The map of current variables
+     * @param runCount Current run count in the recursive function. It stops executing after second run.
+     */
+    _processContextVariables(result: Record<string, string>, variables: Record<string, string>, runCount?: number): Promise<Record<string, string>>;
+    /**
+     * Clears cached groups.
+     */
+    clearCache(): void;
+    /**
+     * Evaluates a value against the passed variables.
+     *
+     * Use this method when the context is not evaluated against itself. You can manually
+     * build context with `buildContext()` and call `evaluateWithContext()` for additional
+     * performance improvement.
+     *
+     * @param value A value to evaluate
+     * @param unprocessedContext The context (or variables) to use when evaluating the value.
+     * @return Promise that resolves to the evaluated value.
+     */
+    evaluateVariable(value: string, unprocessedContext: Record<string, string>): Promise<string>;
+    /**
+     * Evaluates the object against the passed variables.
+     *
+     * Note, it only performs a shallow evaluation. Deep objects are not evaluated.
+     *
+     * Use this method when the context is not evaluated against itself. You can manually
+     * build context with `buildContext()` and call `evaluateVariablesWithContext()` for additional
+     * performance improvement.
+     *
+     * @param obj The object to evaluate.
+     * @param unprocessedContext The context (or variables) to use when evaluating the value.
+     * @return Copy of the passed object with the evaluated values.
+     */
+    evaluateVariables<T>(obj: T, unprocessedContext: Record<string, string>, names?: string[]): Promise<T>;
+    /**
+     * Evaluates the object against the passed variables.
+     *
+     * Note, it only performs a shallow evaluation. Deep objects are not evaluated.
+     *
+     * This method is to be used when the passed context is already evaluated against itself.
+     *
+     * @param obj The object to evaluate.
+     * @param context The evaluated context. use `buildContext()` to prepare the values.
+     * @param names The list of names of variables to evaluate. Note, this function changes this array.
+     * @returns Copy of the passed object with the evaluated values.
+     */
+    evaluateVariablesWithContext<T>(obj: T, context: Record<string, string>, names?: string[]): Promise<T>;
+    /**
+     * Evaluates a value with context passed to Jexl.
+     *
+     * @param context Jexl's context
+     * @param value Value to evaluate
+     */
+    evaluateWithContext(context: Record<string, string>, value: string): Promise<string>;
+    _parse(value: string, context: Record<string, string>): Promise<string>;
+    /**
+     * Upgrades old syntax of magic variables to new one.
+     * It replaces `${now}` and `${random}` to function calls: `now()` and
+     * `random()`. It also keeps grouping.
+     *
+     * @param value Currently evaluated value
+     * @return Parsed value without old syntax.
+     */
+    _upgradeLegacy(value: string): string;
+    /**
+     * Evaluates functions.
+     *
+     * @param value A value to evaluate
+     * @returns Evaluated value with removed functions.
+     * @throws Error if a function is not supported.
+     */
+    _evalFunctions(value: string, context: Record<string, string>): string;
+    /**
+     * Calls one of the predefined functions and returns its value.
+     *
+     * @param fnName A function name to call.
+     * @param args Arguments find in the expression.
+     * @return Result of calling a function. Always a string.
+     */
+    _callFn(context: Record<string, string>, fnName: string, args?: string[]): string | number;
+    /**
+     * Calls JavaScript native function.
+     * Currently only `Math`, 'JSON', and `String` namespaces are supported.
+     *
+     * @param namespace The namespace of the function to call
+     * @param fn Name of the function to call
+     * @param args A list of arguments to call
+     * @returns Processed value.
+     */
+    _callNamespaceFunction(context: Record<string, string>, namespace: string, fn: string, args?: string[]): string | number;
+    /**
+     * Prepares variables to be evaluated where a value is a multiline value.
+     * @param lines Lines in the expression
+     * @returns Processed lines
+     */
+    _prepareMultilineValue(lines: string[]): string[];
+    _applyArgumentsContext(arg: any, context: Record<string, string>): any;
+    /**
+     * Replaces strings with quoted string and variables notation into
+     * variables that Jexl understands.
+     *
+     * @param value Value to evaluate
+     * @return Proper syntax for Jexl
+     */
+    _prepareValue(value: string): string;
+    /**
+     * Wraps a passed value with `'{'` and `'}'` to be properly processed by Jexl.
+     * @param value The value to wrap.
+     * @param isJson Whether the passed string originally was a JSON string.
+     * @return Valid for Jexl JSON string.
+     */
+    _wrapJsonValue(value: string, isJson: boolean): string;
+    /**
+     * Checks whether passed value is a valid variable name.
+     * @param name Variable name
+     * @return true if the passed name can be used as variable value.
+     */
+    isValidName(name: string): boolean;
+}