@o3r/components 11.1.0-prerelease.20 → 11.1.0-prerelease.22

package/builders/metadata-check/helpers/config-metadata-comparison.helper.d.ts

@@ -0,0 +1,22 @@
+import type { ComponentConfigOutput } from '@o3r/components';
+import type { MetadataComparator } from '@o3r/extractors';
+/**
+ * Interface describing a config migration element
+ */
+export interface MigrationConfigData {
+    /** Library name */
+    libraryName: string;
+    /**
+     * Configuration name
+     */
+    configName?: string;
+    /**
+     * Configuration property name
+     */
+    propertyName?: string;
+}
+/**
+ * Comparator used to compare one version of config metadata with another
+ */
+export declare const configMetadataComparator: MetadataComparator<ComponentConfigOutput, MigrationConfigData, ComponentConfigOutput[]>;
+//# sourceMappingURL=config-metadata-comparison.helper.d.ts.map

package/builders/metadata-check/helpers/config-metadata-comparison.helper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config-metadata-comparison.helper.d.ts","sourceRoot":"","sources":["../../../../builders/metadata-check/helpers/config-metadata-comparison.helper.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAC7D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAE1D;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,mBAAmB;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AA4BD;;GAEG;AACH,eAAO,MAAM,wBAAwB,EAAE,kBAAkB,CAAC,qBAAqB,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,CAI5H,CAAC"}

package/builders/metadata-check/helpers/config-metadata-comparison.helper.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configMetadataComparator = void 0;
+/**
+ * Returns an array of config metadata from a metadata file.
+ * To be easily parseable, the properties will be split in separate items of the array.
+ * @param content Content of a migration metadata files
+ * @example Array conversion
+ * ```javascript
+ * [{ library: '@o3r/demo', properties: [{name : 'property1', type: 'string'}, {name : 'property2', type: 'number'}] }]
+ * ```
+ * will become :
+ * ```javascript
+ * [{ library: '@o3r/demo', properties: [{name : 'property1', type: 'string'}] }, { library: '@o3r/demo', properties: [{name : 'property2', type: 'number'}] }]
+ * ```
+ */
+const getConfigurationArray = (content) => content.flatMap((config) => config.properties.length > 1
+    ? config.properties.map((prop) => ({ ...config, properties: [prop] }))
+    : [config]);
+const getConfigurationPropertyName = (config) => `${config.library}#${config.name}` + (config.properties.length ? ` ${config.properties[0].name}` : '');
+const isMigrationConfigurationDataMatch = (config, migrationData) => migrationData.libraryName === config.library
+    && (!migrationData.configName || migrationData.configName === config.name)
+    && (!migrationData.propertyName || config.properties[0]?.name === migrationData.propertyName);
+/**
+ * Comparator used to compare one version of config metadata with another
+ */
+exports.configMetadataComparator = {
+    getArray: getConfigurationArray,
+    getIdentifier: getConfigurationPropertyName,
+    isMigrationDataMatch: isMigrationConfigurationDataMatch
+};
+//# sourceMappingURL=config-metadata-comparison.helper.js.map

package/builders/metadata-check/helpers/index.d.ts

@@ -0,0 +1,2 @@
+export * from './config-metadata-comparison.helper';
+//# sourceMappingURL=index.d.ts.map

package/builders/metadata-check/helpers/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../builders/metadata-check/helpers/index.ts"],"names":[],"mappings":"AAAA,cAAc,qCAAqC,CAAC"}

package/builders/metadata-check/helpers/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./config-metadata-comparison.helper"), exports);
+//# sourceMappingURL=index.js.map

package/builders/metadata-check/index.d.ts

@@ -0,0 +1,4 @@
+import type { ConfigMigrationMetadataCheckBuilderSchema } from './schema';
+declare const _default: import("@angular-devkit/architect/src/internal").Builder<ConfigMigrationMetadataCheckBuilderSchema & import("@angular-devkit/core").JsonObject>;
+export default _default;
+//# sourceMappingURL=index.d.ts.map

package/builders/metadata-check/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../builders/metadata-check/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,yCAAyC,EAAE,MAAM,UAAU,CAAC;;AAE1E,wBAEI"}

package/builders/metadata-check/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const architect_1 = require("@angular-devkit/architect");
+const extractors_1 = require("@o3r/extractors");
+const config_metadata_comparison_helper_1 = require("./helpers/config-metadata-comparison.helper");
+exports.default = (0, architect_1.createBuilder)((0, extractors_1.createBuilderWithMetricsIfInstalled)((options, context) => {
+    return (0, extractors_1.checkMetadataBuilder)(options, context, config_metadata_comparison_helper_1.configMetadataComparator);
+}));
+//# sourceMappingURL=index.js.map

package/builders/metadata-check/schema.d.ts

@@ -0,0 +1,5 @@
+import type { MigrationMetadataCheckBuilderOptions } from '@o3r/extractors';
+/** Migration metadata check builder schema */
+export interface ConfigMigrationMetadataCheckBuilderSchema extends MigrationMetadataCheckBuilderOptions {
+}
+//# sourceMappingURL=schema.d.ts.map

package/builders/metadata-check/schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../builders/metadata-check/schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oCAAoC,EAAE,MAAM,iBAAiB,CAAC;AAE5E,8CAA8C;AAC9C,MAAM,WAAW,yCAA0C,SAAQ,oCAAoC;CACtG"}

package/builders/metadata-check/schema.js

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

package/builders/metadata-check/schema.json

@@ -0,0 +1,41 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "type": "object",
+  "$id": "ConfigMigrationMetadataCheckBuilderSchema",
+  "title": "Check config migration metadata builder",
+  "description": "Check config migration metadata builder",
+  "properties": {
+    "migrationDataPath": {
+      "type": ["string", "array"],
+      "items": {
+        "type": "string"
+      },
+      "description": "Glob of the migration files to use."
+    },
+    "granularity": {
+      "type": "string",
+      "description": "Granularity of the migration check.",
+      "default": "minor",
+      "enum": [
+        "major",
+        "minor"
+      ]
+    },
+    "allowBreakingChanges": {
+      "type": "boolean",
+      "description": "Are breaking changes allowed.",
+      "default": false
+    },
+    "packageManager": {
+      "type": "string",
+      "description": "Override of the package manager, otherwise it will be computed from the project setup."
+    },
+    "metadataPath": {
+      "type": "string",
+      "description": "Path of the config metadata file.",
+      "default": "./component.config.metadata.json"
+    }
+  },
+  "additionalProperties": false,
+  "required": ["migrationDataPath"]
+}

package/builders.json

@@ -5,6 +5,11 @@
       "implementation": "./builders/component-extractor/",
       "schema": "./builders/component-extractor/schema.json",
       "description": "Extract the component metadata (configuration and class) from an Otter project"
+    },
+    "check-config-migration-metadata": {
+      "implementation": "./builders/metadata-check/",
+      "schema": "./builders/metadata-check/schema.json",
+      "description": "Check for component metadata breaking changes"
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@o3r/components",
-  "version": "11.1.0-prerelease.20",
+  "version": "11.1.0-prerelease.22",
   "publishConfig": {
     "access": "public"
   },
@@ -44,21 +44,27 @@
     "@ngrx/effects": "~18.0.0",
     "@ngrx/entity": "~18.0.0",
     "@ngrx/store": "~18.0.0",
-    "@o3r/analytics": "^11.1.0-prerelease.20",
-    "@o3r/configuration": "^11.1.0-prerelease.20",
-    "@o3r/core": "^11.1.0-prerelease.20",
-    "@o3r/dynamic-content": "^11.1.0-prerelease.20",
-    "@o3r/extractors": "^11.1.0-prerelease.20",
-    "@o3r/localization": "^11.1.0-prerelease.20",
-    "@o3r/logger": "^11.1.0-prerelease.20",
-    "@o3r/rules-engine": "^11.1.0-prerelease.20",
-    "@o3r/schematics": "^11.1.0-prerelease.20",
-    "@o3r/testing": "^11.1.0-prerelease.20",
+    "@o3r/analytics": "^11.1.0-prerelease.22",
+    "@o3r/configuration": "^11.1.0-prerelease.22",
+    "@o3r/core": "^11.1.0-prerelease.22",
+    "@o3r/dynamic-content": "^11.1.0-prerelease.22",
+    "@o3r/extractors": "^11.1.0-prerelease.22",
+    "@o3r/localization": "^11.1.0-prerelease.22",
+    "@o3r/logger": "^11.1.0-prerelease.22",
+    "@o3r/rules-engine": "^11.1.0-prerelease.22",
+    "@o3r/schematics": "^11.1.0-prerelease.22",
+    "@o3r/testing": "^11.1.0-prerelease.22",
     "@schematics/angular": "~18.0.0",
+    "@yarnpkg/cli": "^4.0.0",
+    "@yarnpkg/core": "^4.1.1",
+    "@yarnpkg/fslib": "^3.1.0",
+    "@yarnpkg/plugin-npm": "^3.0.1",
+    "@yarnpkg/plugin-pack": "^4.0.0",
     "chokidar": "^3.5.2",
     "globby": "^11.1.0",
     "jsonpath-plus": "^9.0.0",
     "rxjs": "^7.8.1",
+    "semver": "^7.5.2",
     "typescript": "~5.4.2"
   },
   "peerDependenciesMeta": {
@@ -92,6 +98,21 @@
     "@schematics/angular": {
       "optional": true
     },
+    "@yarnpkg/cli": {
+      "optional": true
+    },
+    "@yarnpkg/core": {
+      "optional": true
+    },
+    "@yarnpkg/fslib": {
+      "optional": true
+    },
+    "@yarnpkg/plugin-npm": {
+      "optional": true
+    },
+    "@yarnpkg/plugin-pack": {
+      "optional": true
+    },
     "chokidar": {
       "optional": true
     },
@@ -101,6 +122,9 @@
     "jsonpath-plus": {
       "optional": true
     },
+    "semver": {
+      "optional": true
+    },
     "typescript": {
       "optional": true
     }

package/schematics/cms-adapter/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../schematics/cms-adapter/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,IAAI,EAA0B,MAAM,4BAA4B,CAAC;AAgFvF;;;;GAIG;AACH,eAAO,MAAM,gBAAgB;kBA5EwB,MAAM,GAAG,SAAS;UA4EkB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../schematics/cms-adapter/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,IAAI,EAA0B,MAAM,4BAA4B,CAAC;AAuFvF;;;;GAIG;AACH,eAAO,MAAM,gBAAgB;kBAnFwB,MAAM,GAAG,SAAS;UAmFkB,CAAC"}

package/schematics/cms-adapter/index.js

@@ -37,6 +37,12 @@ function updateCmsAdapterFn(options) {
                 libraries: []
             }
         };
+        workspaceProject.architect['check-config-migration-metadata'] ||= {
+            builder: '@o3r/components:check-config-migration-metadata',
+            options: {
+                migrationDataPath: 'MIGRATION-*.json'
+            }
+        };
         workspace.projects[options.projectName] = workspaceProject;
         tree.overwrite('/angular.json', JSON.stringify(workspace, null, 2));
         return tree;