@o3r/configuration 10.3.0-prerelease.4 → 10.3.0-prerelease.41

package/schematics/ng-update/v10-3/index.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateV10_3 = void 0;
+const schematics_1 = require("@o3r/schematics");
+const configObserverRegExp = /\bConfigObserver\b/g;
+function updateV10_3Fn() {
+    return (tree) => {
+        const files = (0, schematics_1.findFilesInTree)(tree.getDir(''), (filePath) => /.*\.ts/.test(filePath));
+        files.forEach(({ content, path }) => {
+            const str = content.toString();
+            if (configObserverRegExp.test(str)) {
+                tree.overwrite(path, str.replaceAll(configObserverRegExp, 'O3rConfig'));
+            }
+        });
+    };
+}
+/**
+ * Update of Otter configuration V10.3
+ */
+exports.updateV10_3 = (0, schematics_1.createSchematicWithMetricsIfInstalled)(updateV10_3Fn);
+//# sourceMappingURL=index.js.map

package/schematics/use-config-signal/index.d.ts

@@ -0,0 +1,8 @@
+import { type Rule } from '@angular-devkit/schematics';
+import type { NgUseConfigSignalSchematicsSchema } from './schema';
+/**
+ * Migrate from configuration observable to signal
+ * @param options
+ */
+export declare const ngUseConfigSignal: (options: NgUseConfigSignalSchematicsSchema) => Rule;
+//# sourceMappingURL=index.d.ts.map

package/schematics/use-config-signal/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../schematics/use-config-signal/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,IAAI,EAEV,MAAM,4BAA4B,CAAC;AAYpC,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,UAAU,CAAC;AAgIlE;;;GAGG;AACH,eAAO,MAAM,iBAAiB,sDAA6D,CAAC"}

package/schematics/use-config-signal/index.js

@@ -0,0 +1,95 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ngUseConfigSignal = void 0;
+const schematics_1 = require("@angular-devkit/schematics");
+const schematics_2 = require("@o3r/schematics");
+const ts = require("typescript");
+const configObserverRegexp = /.*new ConfigurationObserver<(?<configName>\w+)>\(\s*(?<configId>\w+),\s*(?<defaultConfig>\w+)(,\s*\w+)?\s*\);/;
+function ngUseConfigSignalFn(options) {
+    return (0, schematics_1.chain)([
+        (0, schematics_2.addImportsRule)(options.path, [
+            {
+                from: '@angular/core',
+                importNames: [
+                    'inject',
+                    'input'
+                ]
+            },
+            {
+                from: '@angular/core/rxjs-interop',
+                importNames: [
+                    'toObservable'
+                ]
+            },
+            {
+                from: '@o3r/configuration',
+                importNames: [
+                    'configSignal',
+                    'O3rConfig',
+                    'ConfigurationBaseService',
+                    'DynamicConfigurableWithSignal'
+                ]
+            }
+        ]),
+        (tree) => {
+            const content = tree.readText(options.path);
+            // Retrieve all info
+            const match = content.match(configObserverRegexp);
+            const { configName, configId, defaultConfig } = match?.groups || {};
+            if (!configName || !configId || !defaultConfig) {
+                throw new schematics_2.O3rCliError(`Configuration name, id or default value not found in ${options.path}.\nCannot migrate to signal based configuration.`);
+            }
+            const componentSourceFile = ts.createSourceFile(options.path, content, ts.ScriptTarget.ES2020, true);
+            const result = ts.transform(componentSourceFile, [
+                (0, schematics_2.addInterfaceToClassTransformerFactory)(`DynamicConfigurableWithSignal<${configName}>`, schematics_2.isO3rClassComponent, new Set(['DynamicConfigurable'])),
+                (ctx) => (rootNode) => {
+                    const { factory } = ctx;
+                    const visit = (node) => {
+                        if (ts.isClassDeclaration(node) && (0, schematics_2.isO3rClassComponent)(node)) {
+                            const propertiesToAdd = (0, schematics_2.generateClassElementsFromString)(`
+  private readonly configurationService = inject(ConfigurationBaseService);
+
+  public config = input<Partial<${configName}>>();
+
+  @O3rConfig()
+  public readonly configSignal = configSignal(this.config, ${configId}, ${defaultConfig}, this.configurationService);
+
+  public readonly config$ = toObservable(this.configSignal);`);
+                            const newMembers = propertiesToAdd.concat(node.members.filter((member) => !member.name
+                                || (ts.isIdentifier(member.name)
+                                    && member.name.escapedText !== 'config$'
+                                    && member.name.escapedText !== 'config'
+                                    && member.name.escapedText !== 'dynamicConfig$')));
+                            (0, schematics_2.addCommentsOnClassProperties)(newMembers, {
+                                config: 'Input configuration to override the default configuration of the component',
+                                configSignal: 'Configuration signal based on the input and the stored configuration',
+                                config$: '@deprecated use configSignal instead'
+                            });
+                            return factory.updateClassDeclaration(node, ts.getModifiers(node), node.name, node.typeParameters, node.heritageClauses, newMembers);
+                        }
+                        return ts.visitEachChild(node, visit, ctx);
+                    };
+                    return ts.visitNode(rootNode, visit);
+                }
+            ]);
+            const printer = ts.createPrinter({
+                removeComments: false,
+                newLine: ts.NewLineKind.LineFeed
+            });
+            let newContent = printer.printFile(result.transformed[0]);
+            newContent = newContent
+                .replace(/this\.dynamicConfig\$\.next\(this.config\);/, '// TODO remove the ngOnChanges if empty')
+                .replace(configObserverRegexp, '')
+                .replace(/this\.config\$\s*=\s*this\.dynamicConfig\$\s*\.asObservable\(\);/, '');
+            tree.overwrite(options.path, newContent);
+            return tree;
+        },
+        options.skipLinter ? (0, schematics_1.noop)() : (0, schematics_2.applyEsLintFix)()
+    ]);
+}
+/**
+ * Migrate from configuration observable to signal
+ * @param options
+ */
+exports.ngUseConfigSignal = (0, schematics_2.createSchematicWithMetricsIfInstalled)(ngUseConfigSignalFn);
+//# sourceMappingURL=index.js.map

package/schematics/use-config-signal/schema.d.ts

@@ -0,0 +1,8 @@
+import type { SchematicOptionObject } from '@o3r/schematics';
+export interface NgUseConfigSignalSchematicsSchema extends SchematicOptionObject {
+    /** Path to the component */
+    path: string;
+    /** Skip the linter process */
+    skipLinter: boolean;
+}
+//# sourceMappingURL=schema.d.ts.map

package/schematics/use-config-signal/schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../schematics/use-config-signal/schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAE7D,MAAM,WAAW,iCAAkC,SAAQ,qBAAqB;IAC9E,4BAA4B;IAC5B,IAAI,EAAE,MAAM,CAAC;IAEb,8BAA8B;IAC9B,UAAU,EAAE,OAAO,CAAC;CACrB"}

package/schematics/use-config-signal/schema.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=schema.js.map

package/schematics/use-config-signal/schema.json

@@ -0,0 +1,21 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "NgUseConfigSignalSchematicsSchema",
+  "title": "Migrate from configuration observable to signal",
+  "description": "Migrate from configuration observable to signal",
+  "properties": {
+    "path": {
+      "type": "string",
+      "description": "Path to the component"
+    },
+    "skipLinter": {
+      "type": "boolean",
+      "description": "Skip the linter process",
+      "default": false
+    }
+  },
+  "additionalProperties": true,
+  "required": [
+    "path"
+  ]
+}

package/tools/configuration.decorators.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Decorator to identify the configuration observer
+ * @deprecated please use O3rConfig, will be removed in v12
+ */
+export declare function ConfigObserver(): (target: any, key: string) => void;
+/**
+ * Decorator to identify the component's configuration
+ */
+export declare function O3rConfig(): (target: any, key: string) => void;
+//# sourceMappingURL=configuration.decorators.d.ts.map

package/tools/configuration.decorators.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"configuration.decorators.d.ts","sourceRoot":"","sources":["../../src/tools/configuration.decorators.ts"],"names":[],"mappings":"AAwBA;;;GAGG;AAEH,wBAAgB,cAAc,uCAE7B;AAED;;GAEG;AAEH,wBAAgB,SAAS,uCAExB"}

package/tools/configuration.signal.d.ts

@@ -0,0 +1,16 @@
+import type { InputSignal, Signal } from '@angular/core';
+import type { Configuration } from '@o3r/core';
+import type { ConfigurationBaseService } from '../services';
+/** Configuration signal */
+export type ConfigurationSignal<T> = Signal<T> & {
+    configId: string;
+};
+/**
+ * Get a configuration signal
+ * @param configInput
+ * @param configId
+ * @param defaultConfig
+ * @param configurationService
+ */
+export declare const configSignal: <T extends Configuration>(configInput: InputSignal<Partial<T> | undefined>, configId: string, defaultConfig: T, configurationService?: ConfigurationBaseService | null) => ConfigurationSignal<T>;
+//# sourceMappingURL=configuration.signal.d.ts.map

package/tools/configuration.signal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"configuration.signal.d.ts","sourceRoot":"","sources":["../../src/tools/configuration.signal.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAEzD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAG/C,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAC;AAE5D,2BAA2B;AAC3B,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG;IAAE,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC;AAEtE;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,yCACV,YAAY,QAAQ,CAAC,CAAC,GAAG,SAAS,CAAC,YACtC,MAAM,iBACD,CAAC,yBACO,wBAAwB,GAAG,IAAI,KACrD,oBAAoB,CAAC,CAcvB,CAAC"}

package/tools/index.d.ts

@@ -1,3 +1,4 @@
-export * from './configuration.decorator';
+export * from './configuration.decorators';
 export * from './configuration.observer';
+export * from './configuration.signal';
 //# sourceMappingURL=index.d.ts.map

package/tools/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/tools/index.ts"],"names":[],"mappings":"AAAA,cAAc,2BAA2B,CAAC;AAC1C,cAAc,0BAA0B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/tools/index.ts"],"names":[],"mappings":"AAAA,cAAc,4BAA4B,CAAC;AAC3C,cAAc,0BAA0B,CAAC;AACzC,cAAc,wBAAwB,CAAC"}

package/esm2022/tools/configuration.decorator.mjs

@@ -1,26 +0,0 @@
-import { otterComponentInfoPropertyName } from '@o3r/core';
-/**
- * Decorator to identify the configuration observer
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-export function ConfigObserver() {
-    return (target, key) => {
-        const privateField = `_${key}`;
-        if (delete target[key]) {
-            Object.defineProperty(target, key, {
-                get: function () {
-                    return this[privateField];
-                },
-                set: function (value) {
-                    this[privateField] = value;
-                    if (this[otterComponentInfoPropertyName]) {
-                        this[otterComponentInfoPropertyName].configId = this[privateField].configId;
-                    }
-                },
-                enumerable: true,
-                configurable: true
-            });
-        }
-    };
-}
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlndXJhdGlvbi5kZWNvcmF0b3IuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvdG9vbHMvY29uZmlndXJhdGlvbi5kZWNvcmF0b3IudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFpQiw4QkFBOEIsRUFBRSxNQUFNLFdBQVcsQ0FBQztBQUcxRTs7R0FFRztBQUNILGdFQUFnRTtBQUNoRSxNQUFNLFVBQVUsY0FBYztJQUM1QixPQUFPLENBQUMsTUFBVyxFQUFFLEdBQVcsRUFBRSxFQUFFO1FBQ2xDLE1BQU0sWUFBWSxHQUFHLElBQUksR0FBRyxFQUFFLENBQUM7UUFFL0IsSUFBSSxPQUFPLE1BQU0sQ0FBQyxHQUFHLENBQUMsRUFBRSxDQUFDO1lBQ3ZCLE1BQU0sQ0FBQyxjQUFjLENBQUMsTUFBTSxFQUFFLEdBQUcsRUFBRTtnQkFDakMsR0FBRyxFQUFFO29CQUNILE9BQU8sSUFBSSxDQUFDLFlBQVksQ0FBQyxDQUFDO2dCQUM1QixDQUFDO2dCQUNELEdBQUcsRUFBRSxVQUFxQixLQUE4QjtvQkFDdEQsSUFBSSxDQUFDLFlBQVksQ0FBQyxHQUFHLEtBQUssQ0FBQztvQkFDM0IsSUFBSSxJQUFJLENBQUMsOEJBQThCLENBQUMsRUFBRSxDQUFDO3dCQUN6QyxJQUFJLENBQUMsOEJBQThCLENBQUMsQ0FBQyxRQUFRLEdBQUksSUFBSSxDQUFDLFlBQVksQ0FBMEMsQ0FBQyxRQUFRLENBQUM7b0JBQ3hILENBQUM7Z0JBQ0gsQ0FBQztnQkFDRCxVQUFVLEVBQUUsSUFBSTtnQkFDaEIsWUFBWSxFQUFFLElBQUk7YUFDbkIsQ0FBQyxDQUFDO1FBQ0wsQ0FBQztJQUNILENBQUMsQ0FBQztBQUNKLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBDb25maWd1cmF0aW9uLCBvdHRlckNvbXBvbmVudEluZm9Qcm9wZXJ0eU5hbWUgfSBmcm9tICdAbzNyL2NvcmUnO1xuaW1wb3J0IHsgQ29uZmlndXJhdGlvbk9ic2VydmVyIH0gZnJvbSAnLi9jb25maWd1cmF0aW9uLm9ic2VydmVyJztcblxuLyoqXG4gKiBEZWNvcmF0b3IgdG8gaWRlbnRpZnkgdGhlIGNvbmZpZ3VyYXRpb24gb2JzZXJ2ZXJcbiAqL1xuLy8gZXNsaW50LWRpc2FibGUtbmV4dC1saW5lIEB0eXBlc2NyaXB0LWVzbGludC9uYW1pbmctY29udmVudGlvblxuZXhwb3J0IGZ1bmN0aW9uIENvbmZpZ09ic2VydmVyKCkge1xuICByZXR1cm4gKHRhcmdldDogYW55LCBrZXk6IHN0cmluZykgPT4ge1xuICAgIGNvbnN0IHByaXZhdGVGaWVsZCA9IGBfJHtrZXl9YDtcblxuICAgIGlmIChkZWxldGUgdGFyZ2V0W2tleV0pIHtcbiAgICAgIE9iamVjdC5kZWZpbmVQcm9wZXJ0eSh0YXJnZXQsIGtleSwge1xuICAgICAgICBnZXQ6IGZ1bmN0aW9uICh0aGlzOiBhbnkpIHtcbiAgICAgICAgICByZXR1cm4gdGhpc1twcml2YXRlRmllbGRdO1xuICAgICAgICB9LFxuICAgICAgICBzZXQ6IGZ1bmN0aW9uICh0aGlzOiBhbnksIHZhbHVlOiBSZWNvcmQ8c3RyaW5nLCB1bmtub3duPikge1xuICAgICAgICAgIHRoaXNbcHJpdmF0ZUZpZWxkXSA9IHZhbHVlO1xuICAgICAgICAgIGlmICh0aGlzW290dGVyQ29tcG9uZW50SW5mb1Byb3BlcnR5TmFtZV0pIHtcbiAgICAgICAgICAgIHRoaXNbb3R0ZXJDb21wb25lbnRJbmZvUHJvcGVydHlOYW1lXS5jb25maWdJZCA9ICh0aGlzW3ByaXZhdGVGaWVsZF0gYXMgQ29uZmlndXJhdGlvbk9ic2VydmVyPENvbmZpZ3VyYXRpb24+KS5jb25maWdJZDtcbiAgICAgICAgICB9XG4gICAgICAgIH0sXG4gICAgICAgIGVudW1lcmFibGU6IHRydWUsXG4gICAgICAgIGNvbmZpZ3VyYWJsZTogdHJ1ZVxuICAgICAgfSk7XG4gICAgfVxuICB9O1xufVxuIl19

package/tools/configuration.decorator.d.ts

@@ -1,5 +0,0 @@
-/**
- * Decorator to identify the configuration observer
- */
-export declare function ConfigObserver(): (target: any, key: string) => void;
-//# sourceMappingURL=configuration.decorator.d.ts.map

package/tools/configuration.decorator.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"configuration.decorator.d.ts","sourceRoot":"","sources":["../../src/tools/configuration.decorator.ts"],"names":[],"mappings":"AAGA;;GAEG;AAEH,wBAAgB,cAAc,aACZ,GAAG,OAAO,MAAM,UAmBjC"}