@o3r/components 13.2.0-prerelease.12 → 13.2.0-prerelease.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. package/builders/metadata-check/component/helpers/component-metadata-comparison.helper.d.ts +24 -0
  2. package/builders/metadata-check/component/helpers/component-metadata-comparison.helper.d.ts.map +1 -0
  3. package/builders/metadata-check/component/helpers/component-metadata-comparison.helper.js +32 -0
  4. package/builders/metadata-check/component/helpers/index.d.ts +2 -0
  5. package/builders/metadata-check/component/helpers/index.d.ts.map +1 -0
  6. package/builders/metadata-check/component/helpers/index.js +5 -0
  7. package/builders/metadata-check/component/index.d.ts +4 -0
  8. package/builders/metadata-check/component/index.d.ts.map +1 -0
  9. package/builders/metadata-check/component/index.js +9 -0
  10. package/builders/metadata-check/component/schema.d.ts +5 -0
  11. package/builders/metadata-check/component/schema.d.ts.map +1 -0
  12. package/builders/metadata-check/component/schema.json +46 -0
  13. package/builders/metadata-check/config/helpers/config-metadata-comparison.helper.d.ts.map +1 -0
  14. package/builders/metadata-check/config/helpers/index.d.ts.map +1 -0
  15. package/builders/metadata-check/config/index.d.ts.map +1 -0
  16. package/builders/metadata-check/config/schema.d.ts.map +1 -0
  17. package/builders/metadata-check/config/schema.js +3 -0
  18. package/builders.json +8 -3
  19. package/package.json +11 -11
  20. package/builders/metadata-check/helpers/config-metadata-comparison.helper.d.ts.map +0 -1
  21. package/builders/metadata-check/helpers/index.d.ts.map +0 -1
  22. package/builders/metadata-check/index.d.ts.map +0 -1
  23. package/builders/metadata-check/schema.d.ts.map +0 -1
  24. /package/builders/metadata-check/{schema.js → component/schema.js} +0 -0
  25. /package/builders/metadata-check/{helpers → config/helpers}/config-metadata-comparison.helper.d.ts +0 -0
  26. /package/builders/metadata-check/{helpers → config/helpers}/config-metadata-comparison.helper.js +0 -0
  27. /package/builders/metadata-check/{helpers → config/helpers}/index.d.ts +0 -0
  28. /package/builders/metadata-check/{helpers → config/helpers}/index.js +0 -0
  29. /package/builders/metadata-check/{index.d.ts → config/index.d.ts} +0 -0
  30. /package/builders/metadata-check/{index.js → config/index.js} +0 -0
  31. /package/builders/metadata-check/{schema.d.ts → config/schema.d.ts} +0 -0
  32. /package/builders/metadata-check/{schema.json → config/schema.json} +0 -0
@@ -0,0 +1,24 @@
1
+ import type { MetadataComparator } from '@o3r/extractors';
2
+ import type { ComponentClassOutput } from '@o3r/components';
3
+ /**
4
+ * Interface describing a component migration element
5
+ */
6
+ export interface MigrationComponentData {
7
+ /**
8
+ * Library name
9
+ */
10
+ libraryName: string;
11
+ /**
12
+ * Component name
13
+ */
14
+ componentName?: string;
15
+ /**
16
+ * Placeholder id
17
+ */
18
+ placeholderId?: string;
19
+ }
20
+ /**
21
+ * Comparator used to compare one version of component metadata with another
22
+ */
23
+ export declare const componentMetadataComparator: Readonly<MetadataComparator<ComponentClassOutput, MigrationComponentData, ComponentClassOutput[]>>;
24
+ //# sourceMappingURL=component-metadata-comparison.helper.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"component-metadata-comparison.helper.d.ts","sourceRoot":"","sources":["../../../../../builders/metadata-check/component/helpers/component-metadata-comparison.helper.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,kBAAkB,EACnB,MAAM,iBAAiB,CAAC;AACzB,OAAO,KAAK,EACV,oBAAoB,EACrB,MAAM,iBAAiB,CAAC;AAEzB;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AA4BD;;GAEG;AACH,eAAO,MAAM,2BAA2B,EAAE,QAAQ,CAAC,kBAAkB,CAAC,oBAAoB,EAAE,sBAAsB,EAAE,oBAAoB,EAAE,CAAC,CAKjI,CAAC"}
@@ -0,0 +1,32 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.componentMetadataComparator = void 0;
4
+ /**
5
+ * Returns an array of component metadata from a metadata file.
6
+ * To be easily parseable, the properties will be split in separate items of the array.
7
+ * @param content Content of a migration metadata files
8
+ * @example Array conversion
9
+ * ```javascript
10
+ * [{ library: '@o3r/demo', placeholders: [{id : 'id1', description: 'string'}, {id : 'id2', description: 'number'}] }]
11
+ * ```
12
+ * will become :
13
+ * ```javascript
14
+ * [{ library: '@o3r/demo', placeholders: [{id : 'id1', description: 'string'}] }, { library: '@o3r/demo', placeholders: [{id : 'id2', description: 'number'}] }]
15
+ * ```
16
+ */
17
+ const getComponentArray = (content) => content.flatMap((component) => component.placeholders?.map((prop) => ({ ...component, placeholders: [prop] })) || []);
18
+ const getIdentifier = (component) => `${component.library}#${component.name}` + (component.placeholders?.length ? ` ${component.placeholders[0].id}` : '');
19
+ const isRelevantContentType = (contentType) => contentType === 'COMPONENT';
20
+ const isMigrationComponentDataMatch = (component, migrationData) => migrationData.libraryName === component.library
21
+ && (!migrationData.componentName || migrationData.componentName === component.name)
22
+ && (!migrationData.placeholderId || component.placeholders?.[0].id === migrationData.placeholderId);
23
+ /**
24
+ * Comparator used to compare one version of component metadata with another
25
+ */
26
+ exports.componentMetadataComparator = {
27
+ getArray: getComponentArray,
28
+ getIdentifier,
29
+ isRelevantContentType,
30
+ isMigrationDataMatch: isMigrationComponentDataMatch
31
+ };
32
+ //# sourceMappingURL=component-metadata-comparison.helper.js.map
@@ -0,0 +1,2 @@
1
+ export * from './component-metadata-comparison.helper';
2
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../builders/metadata-check/component/helpers/index.ts"],"names":[],"mappings":"AAAA,cAAc,wCAAwC,CAAC"}
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const tslib_1 = require("tslib");
4
+ tslib_1.__exportStar(require("./component-metadata-comparison.helper"), exports);
5
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1,4 @@
1
+ import type { ComponentMigrationMetadataCheckBuilderSchema } from './schema';
2
+ declare const _default: import("@angular-devkit/architect").Builder<ComponentMigrationMetadataCheckBuilderSchema & import("@angular-devkit/core").JsonObject>;
3
+ export default _default;
4
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../builders/metadata-check/component/index.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EACV,4CAA4C,EAC7C,MAAM,UAAU,CAAC;;AAElB,wBAEI"}
@@ -0,0 +1,9 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const architect_1 = require("@angular-devkit/architect");
4
+ const extractors_1 = require("@o3r/extractors");
5
+ const component_metadata_comparison_helper_1 = require("./helpers/component-metadata-comparison.helper");
6
+ exports.default = (0, architect_1.createBuilder)((0, extractors_1.createBuilderWithMetricsIfInstalled)((options, context) => {
7
+ return (0, extractors_1.checkMetadataBuilder)({ ...options, packageJsonEntry: 'componentFilePath' }, context, component_metadata_comparison_helper_1.componentMetadataComparator);
8
+ }));
9
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1,5 @@
1
+ import type { MigrationMetadataCheckBuilderOptions } from '@o3r/extractors';
2
+ /** Migration metadata check builder schema */
3
+ export interface ComponentMigrationMetadataCheckBuilderSchema extends MigrationMetadataCheckBuilderOptions {
4
+ }
5
+ //# sourceMappingURL=schema.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../../builders/metadata-check/component/schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,oCAAoC,EACrC,MAAM,iBAAiB,CAAC;AAEzB,8CAA8C;AAC9C,MAAM,WAAW,4CAA6C,SAAQ,oCAAoC;CACzG"}
@@ -0,0 +1,46 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema",
3
+ "type": "object",
4
+ "$id": "ComponentMigrationMetadataCheckBuilderSchema",
5
+ "title": "Check component migration metadata builder",
6
+ "description": "Check component migration metadata builder",
7
+ "properties": {
8
+ "migrationDataPath": {
9
+ "type": ["string", "array"],
10
+ "items": {
11
+ "type": "string"
12
+ },
13
+ "description": "Glob of the migration files to use."
14
+ },
15
+ "granularity": {
16
+ "type": "string",
17
+ "description": "Granularity of the migration check.",
18
+ "default": "minor",
19
+ "enum": [
20
+ "major",
21
+ "minor"
22
+ ]
23
+ },
24
+ "allowBreakingChanges": {
25
+ "type": "boolean",
26
+ "description": "Are breaking changes allowed.",
27
+ "default": false
28
+ },
29
+ "shouldCheckUnusedMigrationData": {
30
+ "type": "boolean",
31
+ "description": "Whether to throw an error in case of a migration item that is not used during metadata checks",
32
+ "default": false
33
+ },
34
+ "packageManager": {
35
+ "type": "string",
36
+ "description": "Override of the package manager, otherwise it will be computed from the project setup."
37
+ },
38
+ "metadataPath": {
39
+ "type": "string",
40
+ "description": "Path of the component metadata file.",
41
+ "default": "./component.class.metadata.json"
42
+ }
43
+ },
44
+ "additionalProperties": false,
45
+ "required": ["migrationDataPath"]
46
+ }
@@ -0,0 +1 @@
1
+ {"version":3,"file":"config-metadata-comparison.helper.d.ts","sourceRoot":"","sources":["../../../../../builders/metadata-check/config/helpers/config-metadata-comparison.helper.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,kBAAkB,EACnB,MAAM,iBAAiB,CAAC;AACzB,OAAO,KAAK,EACV,qBAAqB,EACtB,MAAM,iBAAiB,CAAC;AAEzB;;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,QAAQ,CAAC,kBAAkB,CAAC,qBAAqB,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,CAAC,CAK7H,CAAC"}
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../builders/metadata-check/config/helpers/index.ts"],"names":[],"mappings":"AAAA,cAAc,qCAAqC,CAAC"}
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../builders/metadata-check/config/index.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EACV,yCAAyC,EAC1C,MAAM,UAAU,CAAC;;AAElB,wBAEI"}
@@ -0,0 +1 @@
1
+ {"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../../builders/metadata-check/config/schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,oCAAoC,EACrC,MAAM,iBAAiB,CAAC;AAEzB,8CAA8C;AAC9C,MAAM,WAAW,yCAA0C,SAAQ,oCAAoC;CACtG"}
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=schema.js.map
package/builders.json CHANGED
@@ -6,10 +6,15 @@
6
6
  "schema": "./builders/component-extractor/schema.json",
7
7
  "description": "Extract the component metadata (configuration and class) from an Otter project"
8
8
  },
9
- "check-config-migration-metadata": {
10
- "implementation": "./builders/metadata-check/",
11
- "schema": "./builders/metadata-check/schema.json",
9
+ "check-component-migration-metadata": {
10
+ "implementation": "./builders/metadata-check/component/",
11
+ "schema": "./builders/metadata-check/component/schema.json",
12
12
  "description": "Check for component metadata breaking changes"
13
+ },
14
+ "check-config-migration-metadata": {
15
+ "implementation": "./builders/metadata-check/config/",
16
+ "schema": "./builders/metadata-check/config/schema.json",
17
+ "description": "Check for config metadata breaking changes"
13
18
  }
14
19
  }
15
20
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@o3r/components",
3
- "version": "13.2.0-prerelease.12",
3
+ "version": "13.2.0-prerelease.14",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },
@@ -44,15 +44,15 @@
44
44
  "@ngrx/effects": "^20.0.0",
45
45
  "@ngrx/entity": "^20.0.0",
46
46
  "@ngrx/store": "^20.0.0",
47
- "@o3r/analytics": "^13.2.0-prerelease.12",
48
- "@o3r/configuration": "^13.2.0-prerelease.12",
49
- "@o3r/core": "^13.2.0-prerelease.12",
50
- "@o3r/dynamic-content": "^13.2.0-prerelease.12",
51
- "@o3r/extractors": "^13.2.0-prerelease.12",
52
- "@o3r/localization": "^13.2.0-prerelease.12",
53
- "@o3r/logger": "^13.2.0-prerelease.12",
54
- "@o3r/rules-engine": "^13.2.0-prerelease.12",
55
- "@o3r/schematics": "^13.2.0-prerelease.12",
47
+ "@o3r/analytics": "^13.2.0-prerelease.14",
48
+ "@o3r/configuration": "^13.2.0-prerelease.14",
49
+ "@o3r/core": "^13.2.0-prerelease.14",
50
+ "@o3r/dynamic-content": "^13.2.0-prerelease.14",
51
+ "@o3r/extractors": "^13.2.0-prerelease.14",
52
+ "@o3r/localization": "^13.2.0-prerelease.14",
53
+ "@o3r/logger": "^13.2.0-prerelease.14",
54
+ "@o3r/rules-engine": "^13.2.0-prerelease.14",
55
+ "@o3r/schematics": "^13.2.0-prerelease.14",
56
56
  "@schematics/angular": "^20.0.0",
57
57
  "@yarnpkg/cli": "^4.0.0",
58
58
  "@yarnpkg/core": "^4.1.1",
@@ -134,7 +134,7 @@
134
134
  }
135
135
  },
136
136
  "dependencies": {
137
- "@o3r/schematics": "^13.2.0-prerelease.12",
137
+ "@o3r/schematics": "^13.2.0-prerelease.14",
138
138
  "tslib": "^2.6.2"
139
139
  },
140
140
  "engines": {
@@ -1 +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,EACV,kBAAkB,EACnB,MAAM,iBAAiB,CAAC;AACzB,OAAO,KAAK,EACV,qBAAqB,EACtB,MAAM,iBAAiB,CAAC;AAEzB;;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,QAAQ,CAAC,kBAAkB,CAAC,qBAAqB,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,CAAC,CAK7H,CAAC"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../builders/metadata-check/helpers/index.ts"],"names":[],"mappings":"AAAA,cAAc,qCAAqC,CAAC"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../builders/metadata-check/index.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EACV,yCAAyC,EAC1C,MAAM,UAAU,CAAC;;AAElB,wBAEI"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../builders/metadata-check/schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,oCAAoC,EACrC,MAAM,iBAAiB,CAAC;AAEzB,8CAA8C;AAC9C,MAAM,WAAW,yCAA0C,SAAQ,oCAAoC;CACtG"}