@futdevpro/fsm-dynamo 1.20.92 → 1.20.93

package/build-esm/_modules/pipe/_collections/utils/pip-multi-pipe-pipe.util.js

@@ -0,0 +1,164 @@
+import { DyFM_allDynamoPipes, DyFM_allMultiPipesAvailable, DyFM_AngularMultiPipeAvailable, DyFM_Pipe } from '../../_enums/pip.enum';
+import { DyFM_pipeTransforms } from '../pip-transforms.const';
+export const DyFM_multiPipeAngularPipes = {
+    [DyFM_AngularMultiPipeAvailable.currency]: null,
+    [DyFM_AngularMultiPipeAvailable.date]: null,
+    [DyFM_AngularMultiPipeAvailable.decimal]: null,
+    [DyFM_AngularMultiPipeAvailable.number]: null,
+    [DyFM_AngularMultiPipeAvailable.percent]: null,
+};
+/**
+ * This pipe makes you able to use multiple pipes in one pipe
+ *
+ * The pipes that are available are:
+ * - country
+ * - custom
+ * - division
+ * - list
+ * - multiPipe
+ * - objKey
+ * - range
+ * - region
+ * - replace
+ * - slider
+ * - smartReplace
+ *
+ * The angular pipes that are available are:
+ * - currency
+ * - date
+ * - decimal
+ * - number
+ * - percent
+ *
+ * (The custom pipe is basically usable for anything,
+ * you you even can create your own, combining multiple pipes)
+ *
+ * @example
+ *
+ * ```html
+ * {{ 1000.123 | multiPipe: [
+ *   { currency: [ 'USD' ] },
+ *   { number: [ '1.0-1' ] },
+ * ] }}
+ * ```
+ * will return `1,000.1`
+ *
+ * ```html
+ * {{ { from: 1.321, to: 10.123 } | multiPipe: [
+ *   { range: [ 'from-to' ] },
+ *   { number: [ '1.0-1' ] },
+ * ] }}
+ * ```
+ * will return `1.3 - 10.1`
+ *
+ * ```html
+ * {{ 1000.123 | multiPipe: [
+ *   { range: [ 'from-to' ] },
+ *   { currency: [ 'EUR', 'symbol', '1.0-0' ] },
+ *   { replace: [ ',', ' ' ] },
+ * ] }}
+ * ```
+ * will return `€1 000`
+ */
+export function DyFM_multiPipe_pipeTransform(value, pipes) {
+    try {
+        /* console.log(
+          'applyPipes...',
+          '\nvalue:', value,
+          '\npipes:', DyFM_Object.clone(pipes)
+        ); */
+        stackPipes(pipes);
+        /* console.log('stacked pipes:', DyFM_Object.clone(pipes)); */
+        for (let i = 0; i < pipes.length; i++) {
+            const pipe = pipes[i];
+            /* pipes.forEach((pipe: DyFM_MultiPipe_Setting): void => { */
+            const keys = Object.keys(pipe);
+            if (keys.length !== 1) {
+                console.warn('DYNAMO WARNING: ' +
+                    '\nMultiPipe: pipeSettings has more than one key...', '\npipeSettings: ', pipe, '\n\n', new Error());
+                return value;
+            }
+            const pipeName = keys[0];
+            if (!DyFM_allMultiPipesAvailable.includes(pipeName)) {
+                console.warn('DYNAMO WARNING: ' +
+                    '\nMultiPipe: unknown pipe "' + pipeName + '"...', '\nsorry, but this pipe is not supported by the MultiPipe yet.', '\navailable pipes are: ' + DyFM_allMultiPipesAvailable.join(', '), '\nthe custom pipe is basically usable for anything, you might try to use that.', '\n\n', new Error());
+                return value;
+            }
+            const pipeArgs = pipe[pipeName];
+            /* console.log(
+              'transforming...',
+              '\npipe:', pipeName,
+              '\nargs:', pipeArgs,
+              '\nvalue:', value
+            ); */
+            if (DyFM_allDynamoPipes.includes(pipeName)) {
+                if (pipeArgs?.length) {
+                    value = DyFM_pipeTransforms[pipeName](value, ...pipeArgs);
+                }
+                else {
+                    value = DyFM_pipeTransforms[pipeName](value);
+                }
+            }
+            else {
+                if (!DyFM_multiPipeAngularPipes[pipeName]) {
+                    console.error('DYNAMO ERROR: ', '\nMultiPipe: Angular pipe "' + pipeName + '" is not defined...', '\nPlease set the pipe in the DyFM_multiPipeAngularPipes object.');
+                    return value;
+                }
+                value = DyFM_multiPipeAngularPipes[pipeName](value, ...pipeArgs);
+            }
+        }
+        return value;
+    }
+    catch (error) {
+        console.error('DYNAMO ERROR: ', '\nMultiPipe: something went wrong...', '\nvalue:', value, '\npipes:', pipes, '\n\n', error);
+        return value;
+    }
+}
+/**
+ * This method stacks the pipes in the pipe settings.
+ * Developing this funcfion you must know which pipe have multiPipe settings
+ * and which argument is that
+ *
+ * IMPORTANT: the args are starting from the second transform argument!
+ *
+ * @param pipes
+ */
+function stackPipes(pipes) {
+    for (let i = 0; i < pipes.length; i++) {
+        if (i + 1 < pipes.length) {
+            const pipe = pipes[i];
+            const pipeName = Object.keys(pipe)[0];
+            switch (pipeName) {
+                case DyFM_Pipe.range:
+                    const furtherPipesAfterRange = pipes.splice(i + 1);
+                    if (!pipe[pipeName]?.length) {
+                        pipe[pipeName] = [null, furtherPipesAfterRange];
+                    }
+                    else if (pipe[pipeName][1]?.length) {
+                        pipe[pipeName][1].push(...furtherPipesAfterRange);
+                    }
+                    else {
+                        pipe[pipeName][1] = furtherPipesAfterRange;
+                    }
+                    break;
+                case DyFM_Pipe.smartReplace:
+                    const furtherPipesAfterSR = pipes.splice(i + 1);
+                    if (!pipe[pipeName]?.length) {
+                        throw new Error('DYNAMO ERROR: ' +
+                            '\nMultiPipe: SmartReplacePipe has no arguments...' +
+                            '\nSmartReplacePipe needs at least one argument: replaceTo.' +
+                            '\nMaybe you forgot to put the replacerObject in an array?');
+                    }
+                    if (pipe[pipeName][1]?.length) {
+                        pipe[pipeName][1].push(...furtherPipesAfterSR);
+                    }
+                    else {
+                        pipe[pipeName][1] = furtherPipesAfterSR;
+                    }
+                    break;
+                default:
+                    break;
+            }
+        }
+    }
+}

package/build-esm/_modules/pipe/_collections/utils/pip-obj-key-pipe.util.js

@@ -0,0 +1,16 @@
+/**
+ * This pipe will return the keys of an object
+ * (it will return an empty array if the object is empty)
+ * (This can be used in multiPipe, all datas from objects)
+ *
+ * @example
+ *
+ * ```html
+ * {{ { a: 1, b: 2, c: 3 } | objKey }}
+ * ```
+ * will return `['a', 'b', 'c']`
+ *
+ */
+export function DyFM_objKey_pipeTransform(value) {
+    return value ? Object.keys(value) : [];
+}

package/build-esm/_modules/pipe/_collections/utils/pip-range-pipe.util.js

@@ -0,0 +1,64 @@
+import { DyFM_RangePipe_Setting } from '../../_enums/pip-range-pipe-setting.enum';
+import { DyFM_multiPipe_pipeTransform } from './pip-multi-pipe-pipe.util';
+/**
+ * This pipe will return the range of a value
+ *
+ * @example
+ *
+ * ```html
+ * {{ { from: 1, to: 10 } | range: 'from-to' }}
+ * ```
+ * will return `1 - 10`
+ *
+ *
+ */
+export function DyFM_range_pipeTransform(value, setting, multiPipes) {
+    if (!checkRangePipeRequirements(value, setting, multiPipes)) {
+        return value;
+    }
+    switch (setting) {
+        case DyFM_RangePipe_Setting.avg:
+        case DyFM_RangePipe_Setting.average:
+            return (value.to + value.from) / 2;
+        case DyFM_RangePipe_Setting.min:
+        case DyFM_RangePipe_Setting.from:
+            return value.from;
+        case DyFM_RangePipe_Setting.max:
+        case DyFM_RangePipe_Setting.to:
+            return value.to;
+        case DyFM_RangePipe_Setting.both:
+        case DyFM_RangePipe_Setting.fromTo:
+            if (0 < multiPipes?.length) {
+                if (value.from === value.to) {
+                    return DyFM_multiPipe_pipeTransform(value.from, multiPipes);
+                }
+                else {
+                    return DyFM_multiPipe_pipeTransform(value.from, multiPipes) +
+                        ' - ' +
+                        DyFM_multiPipe_pipeTransform(value.to, multiPipes);
+                }
+            }
+            else {
+                return `${value.from} - ${value.to}`;
+            }
+        default:
+            return value;
+    }
+}
+function checkRangePipeRequirements(value, setting, multiPipes) {
+    if (!value?.isRange) {
+        console.warn('DYNAMO WARNING: ' +
+            '\nRangePipe: value is not a DyFM_RangeValue...', '\nrange pipe is only usable for DyFM_RangeValue.', '\nvalue: ', value, '\n\n', new Error());
+        return false;
+    }
+    if (!setting) {
+        setting = DyFM_RangePipe_Setting.fromTo;
+    }
+    if (setting !== DyFM_RangePipe_Setting.both &&
+        setting !== DyFM_RangePipe_Setting.fromTo &&
+        0 < multiPipes?.length) {
+        console.warn('DYNAMO WARNING: ' +
+            '\nRangePipe: you can only use further pipes with setting "both"/"from-to"...', '\nThere is no need to use this special syntax for the other pipes.', '\nvalue: ', value, '\nsetting: ', setting, '\nfurtherPipes: ', multiPipes, '\n\n', new Error());
+    }
+    return true;
+}

package/build-esm/_modules/pipe/_collections/utils/pip-region-pipe.util.js

@@ -0,0 +1,22 @@
+import { DyFM_countryISOs } from '../../../location/_collections/loc-country-isos.const';
+/**
+ * This pipe will return the region of a country
+ *
+ * @example
+ *
+ * ```html
+ * {{ 'US' | region }}
+ * ```
+ * will return `North America`
+ *
+ * ```html
+ * {{ 'DE' | region }}
+ * ```
+ * will return `Europe`
+ *
+ *
+ */
+export function DyFM_region_pipeTransform(countryISO) {
+    const result = DyFM_countryISOs.find((iso) => iso.iso2 === countryISO)?.region;
+    return result ?? countryISO;
+}

package/build-esm/_modules/pipe/_collections/utils/pip-replace-pipe.util.js

@@ -0,0 +1,15 @@
+/**
+ * This pipe will replace all the occurrences of a string with another string
+ * (usually used for data injections for localized messages)
+ *
+ * @example
+ *
+ * ```html
+ * {{ 'Hello World' | replace: 'World', 'Universe' }}
+ * ```
+ * will return `Hello Universe`
+ *
+ */
+export function DyFM_replace_pipeTransform(value, from, to) {
+    return value?.replaceAll(from, to) ?? value;
+}

package/build-esm/_modules/pipe/_collections/utils/pip-slider-pipe.util.js

@@ -0,0 +1,26 @@
+import { DyFM_RangeValue } from '../../../../_models/control-models/range-value.control-model';
+/**
+ * This pipe will return the value as a string
+ * The main purpose of this pipe is to be able to rewrite this pipe,
+ * so the Dynamo Slider Field will use it as you want
+ *
+ * @example
+ *
+ * ```html
+ * {{ 100 | slider }}
+ * ```
+ * will return `100`
+ *
+ *
+ */
+export function DyFM_slider_pipeTransform(value) {
+    if (value instanceof DyFM_RangeValue /* (value as DyFM_RangeValue).isRange */) {
+        return value.toString();
+    }
+    else if (typeof value === 'number') {
+        return `${value}`;
+    }
+    else {
+        return value;
+    }
+}

package/build-esm/_modules/pipe/_collections/utils/pip-smart-replace-pipe.util.js

@@ -0,0 +1,40 @@
+import { DyFM_Log } from '../../../../_collections/utils/log.util';
+import { DyFM_multiPipe_pipeTransform } from './pip-multi-pipe-pipe.util';
+/**
+ * This pipe will replace multiple values using the given keys
+ *
+ * @example
+ *
+ * ```html
+ * {{ 'Hello {name}, {customer} is waiting for you' | smartReplace: { name: 'John', customer: 'Bob' } }}
+ * ```
+ * will return `Hello John, Bob is waiting for you`
+ *
+ */
+export function DyFM_smartReplace_pipeTransform(value, replacer, multiPipes) {
+    if (!replacer) {
+        DyFM_Log.warn('DYNAMO WARNING: ' +
+            '\nSmartReplacePipe: replaceTo is not defined...', '\n\n', new Error());
+        return value;
+    }
+    for (const key in replacer) {
+        if (replacer[key]?.value) {
+            if (!replacer[key]?.pipes) {
+                DyFM_Log.warn('DYNAMO WARNING: ' +
+                    '\nSmartReplacePipe: replaceTo[' + key + '].multiPipe is not defined...', '\n\n', new Error());
+                return;
+            }
+            if (!Array.isArray(replacer[key].pipes)) {
+                DyFM_Log.warn('DYNAMO WARNING: ' +
+                    '\nSmartReplacePipe: replaceTo[' + key + '].multiPipe is not an array...', '\n\n', new Error());
+                return;
+            }
+            replacer[key] = DyFM_multiPipe_pipeTransform(replacer[key].value, replacer[key].pipes);
+        }
+        if (multiPipes?.length) {
+            replacer[key] = DyFM_multiPipe_pipeTransform(replacer[key], multiPipes);
+        }
+        value = value.replaceAll(`{${key}}`, replacer[key]);
+    }
+    return value;
+}

package/build-esm/_modules/pipe/_enums/pip-range-pipe-setting.enum.js

@@ -0,0 +1,14 @@
+/**
+ * Keys available for configuring the range pipe.
+ */
+export var DyFM_RangePipe_Setting;
+(function (DyFM_RangePipe_Setting) {
+    DyFM_RangePipe_Setting["avg"] = "avg";
+    DyFM_RangePipe_Setting["average"] = "average";
+    DyFM_RangePipe_Setting["min"] = "min";
+    DyFM_RangePipe_Setting["from"] = "from";
+    DyFM_RangePipe_Setting["max"] = "max";
+    DyFM_RangePipe_Setting["to"] = "to";
+    DyFM_RangePipe_Setting["both"] = "both";
+    DyFM_RangePipe_Setting["fromTo"] = "from-to";
+})(DyFM_RangePipe_Setting || (DyFM_RangePipe_Setting = {}));

package/build-esm/_modules/pipe/_enums/pip.enum.js

@@ -0,0 +1,48 @@
+/**
+ * Pipe types supported by Dynamo.
+ */
+export var DyFM_Pipe;
+(function (DyFM_Pipe) {
+    DyFM_Pipe["country"] = "country";
+    DyFM_Pipe["custom"] = "custom";
+    DyFM_Pipe["division"] = "division";
+    DyFM_Pipe["list"] = "list";
+    DyFM_Pipe["multiPipe"] = "multiPipe";
+    DyFM_Pipe["objKey"] = "objKey";
+    DyFM_Pipe["json"] = "json";
+    DyFM_Pipe["range"] = "range";
+    DyFM_Pipe["region"] = "region";
+    DyFM_Pipe["replace"] = "replace";
+    DyFM_Pipe["slider"] = "slider";
+    DyFM_Pipe["smartReplace"] = "smartReplace";
+})(DyFM_Pipe || (DyFM_Pipe = {}));
+/**
+ * Built-in pipes provided by Angular.
+ */
+export var DyFM_AngularMultiPipeAvailable;
+(function (DyFM_AngularMultiPipeAvailable) {
+    DyFM_AngularMultiPipeAvailable["number"] = "number";
+    DyFM_AngularMultiPipeAvailable["decimal"] = "decimal";
+    DyFM_AngularMultiPipeAvailable["currency"] = "currency";
+    DyFM_AngularMultiPipeAvailable["date"] = "date";
+    DyFM_AngularMultiPipeAvailable["percent"] = "percent";
+})(DyFM_AngularMultiPipeAvailable || (DyFM_AngularMultiPipeAvailable = {}));
+/**
+ * Array containing every supported pipe.
+ */
+export const DyFM_allMultiPipesAvailable = [
+    ...Object.values(DyFM_AngularMultiPipeAvailable),
+    DyFM_Pipe.country,
+    DyFM_Pipe.custom,
+    DyFM_Pipe.division,
+    DyFM_Pipe.list,
+    DyFM_Pipe.objKey,
+    DyFM_Pipe.range,
+    DyFM_Pipe.region,
+    DyFM_Pipe.replace,
+    DyFM_Pipe.smartReplace,
+];
+/** List of Dynamo specific pipes. */
+export const DyFM_allDynamoPipes = Object.values(DyFM_Pipe);
+/** Default Angular pipes. */
+export const DyFM_allMultiPipeAngularPipes = Object.values(DyFM_AngularMultiPipeAvailable);

package/build-esm/_modules/pipe/_models/pip-multi-pipe-settings.type.js

@@ -0,0 +1 @@
+export {};

package/build-esm/_modules/pipe/_models/pip-transforms.interface.js

@@ -0,0 +1 @@
+import { DyFM_Pipe } from '../_enums/pip.enum';

package/build-esm/_modules/pipe/index.js

@@ -0,0 +1,22 @@
+// COLLECTIONS
+export * from './_collections/pip-transforms.const';
+// collections/UTILS
+export * from './_collections/utils/pip-country-pipe.util';
+export * from './_collections/utils/pip-custom-pipe.util';
+export * from './_collections/utils/pip-division-pipe.util';
+export * from './_collections/utils/pip-json-pipe.util';
+export * from './_collections/utils/pip-list-pipe.util';
+export * from './_collections/utils/pip-multi-pipe-pipe.util';
+export * from './_collections/utils/pip-obj-key-pipe.util';
+export * from './_collections/utils/pip-obj-key-pipe.util';
+export * from './_collections/utils/pip-range-pipe.util';
+export * from './_collections/utils/pip-region-pipe.util';
+export * from './_collections/utils/pip-replace-pipe.util';
+export * from './_collections/utils/pip-slider-pipe.util';
+export * from './_collections/utils/pip-smart-replace-pipe.util';
+// ENUMS
+export * from './_enums/pip.enum';
+export * from './_enums/pip-range-pipe-setting.enum';
+// MODELS
+export * from './_models/pip-multi-pipe-settings.type';
+export * from './_models/pip-transforms.interface';