@o3r/rules-engine 10.2.0-prerelease.50 → 10.2.0-prerelease.52

package/README.md

@@ -9,8 +9,8 @@ This package is an [Otter Framework Module](https://github.com/AmadeusITGroup/ot
 
 ## Description
 
-[![Stable Version](https://img.shields.io/npm/v/@o3r/rules-engine)](https://www.npmjs.com/package/@o3r/rules-engine)
-[![Bundle Size](https://img.shields.io/bundlephobia/min/@o3r/rules-engine?color=green)](https://www.npmjs.com/package/@o3r/rules-engine)
+[![Stable Version](https://img.shields.io/npm/v/@o3r/rules-engine?style=for-the-badge)](https://www.npmjs.com/package/@o3r/rules-engine)
+[![Bundle Size](https://img.shields.io/bundlephobia/min/@o3r/rules-engine?color=green&style=for-the-badge)](https://www.npmjs.com/package/@o3r/rules-engine)
 
 This module provides a rule engine that can be executed on your Otter application to customize your application (translations,
 placeholders and configs) based on a json file generated by your CMS.

package/builders/rules-engine-extractor/helpers/rules-engine.extractor.d.ts

@@ -5,8 +5,8 @@ import { Action, MetadataFact, MetadataOperator } from './rules-engine.extractor
  * Extracts rules engine facts and operator from code
  */
 export declare class RulesEngineExtractor {
-    private basePath;
-    private logger;
+    private readonly basePath;
+    private readonly logger;
     /** Interface of a Fact definition */
     static readonly FACT_DEFINITIONS_INTERFACE = "FactDefinitions";
     /** Interface of an operator definition */
@@ -16,7 +16,7 @@ export declare class RulesEngineExtractor {
     /** Reserved fact names that will be filtered out of metadata */
     static readonly RESERVED_FACT_NAMES: Readonly<string[]>;
     /** TSConfig to parse the code  */
-    private tsconfig;
+    private readonly tsconfig;
     /** Instance of the comment parser */
     private readonly commentParser;
     constructor(tsconfigPath: string, basePath: string, logger: LoggerApi);
@@ -25,7 +25,6 @@ export declare class RulesEngineExtractor {
      *
      * @param type Name of the type to extract
      * @param sourceFile path to the code source file
-     * @param outputPath path to the schema file to generate
      */
     private extractTypeRef;
     /**

package/builders/rules-engine-extractor/helpers/rules-engine.extractor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"rules-engine.extractor.d.ts","sourceRoot":"","sources":["../../../../builders/rules-engine-extractor/helpers/rules-engine.extractor.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AAQjE,OAAO,KAAK,EAAE,MAAM,YAAY,CAAC;AAEjC,OAAO,EAAE,MAAM,EAAmE,YAAY,EAAE,gBAAgB,EAAkC,MAAM,qCAAqC,CAAC;AAE9L;;GAEG;AACH,qBAAa,oBAAoB;IAiBG,OAAO,CAAC,QAAQ;IAAU,OAAO,CAAC,MAAM;IAf1E,qCAAqC;IACrC,gBAAuB,0BAA0B,qBAAqB;IACtE,0CAA0C;IAC1C,gBAAuB,+BAA+B,WAAiC;IACvF,wCAAwC;IACxC,gBAAuB,0BAA0B,uBAAuB;IACxE,gEAAgE;IAChE,gBAAuB,mBAAmB,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAmB;IAEjF,kCAAkC;IAClC,OAAO,CAAC,QAAQ,CAAM;IAEtB,qCAAqC;IACrC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAyB;gBAE3C,YAAY,EAAE,MAAM,EAAU,QAAQ,EAAE,MAAM,EAAU,MAAM,EAAE,SAAS;IAKrF;;;;;;OAMG;YACW,cAAc;IA2B5B;;;;;;OAMG;IACH,OAAO,CAAC,eAAe;IAMvB;;;;;;OAMG;IACH,OAAO,CAAC,sBAAsB;IAiB9B;;;;;;;;OAQG;IACH,OAAO,CAAC,cAAc;IAStB;;;;;;;;;OASG;IACH,OAAO,CAAC,sBAAsB;IA0B9B;;;;;;OAMG;IACU,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,oBAAoB,EAAE,MAAM,EAAE,wBAAwB,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAkEtI;;;;OAIG;IACI,YAAY,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ;IAMrC;;;;OAIG;IACI,gBAAgB,CAAC,UAAU,EAAE,MAAM,GAAG,gBAAgB,EAAE;IAqE/D;;;;OAIG;IACI,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE;CAkDpD"}
+{"version":3,"file":"rules-engine.extractor.d.ts","sourceRoot":"","sources":["../../../../builders/rules-engine-extractor/helpers/rules-engine.extractor.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AASjE,OAAO,KAAK,EAAE,MAAM,YAAY,CAAC;AAEjC,OAAO,EACL,MAAM,EAMN,YAAY,EACZ,gBAAgB,EAIjB,MAAM,qCAAqC,CAAC;AAE7C;;GAEG;AACH,qBAAa,oBAAoB;IAiBG,OAAO,CAAC,QAAQ,CAAC,QAAQ;IAAU,OAAO,CAAC,QAAQ,CAAC,MAAM;IAf5F,qCAAqC;IACrC,gBAAuB,0BAA0B,qBAAqB;IACtE,0CAA0C;IAC1C,gBAAuB,+BAA+B,WAAiC;IACvF,wCAAwC;IACxC,gBAAuB,0BAA0B,uBAAuB;IACxE,gEAAgE;IAChE,gBAAuB,mBAAmB,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAmB;IAEjF,kCAAkC;IAClC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAM;IAE/B,qCAAqC;IACrC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAyB;gBAE3C,YAAY,EAAE,MAAM,EAAmB,QAAQ,EAAE,MAAM,EAAmB,MAAM,EAAE,SAAS;IAKvG;;;;;OAKG;YACW,cAAc;IA2B5B;;;;;;OAMG;IACH,OAAO,CAAC,eAAe;IAMvB;;;;;;OAMG;IACH,OAAO,CAAC,sBAAsB;IAiB9B;;;;;;;;OAQG;IACH,OAAO,CAAC,cAAc;IAStB;;;;;;;;;OASG;IACH,OAAO,CAAC,sBAAsB;IA0B9B;;;;;;OAMG;IACU,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,oBAAoB,EAAE,MAAM,EAAE,wBAAwB,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAmGtI;;;;OAIG;IACI,YAAY,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ;IAMrC;;;;OAIG;IACI,gBAAgB,CAAC,UAAU,EAAE,MAAM,GAAG,gBAAgB,EAAE;IAqE/D;;;;OAIG;IACI,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE;CAkDpD"}

package/builders/rules-engine-extractor/helpers/rules-engine.extractor.interfaces.d.ts

@@ -1,16 +1,42 @@
 /** Supported types for a fact */
-export type FactSupportedTypes = 'string' | 'number' | 'date' | 'object' | 'boolean';
-/** Fact as description in the metadata file */
-export interface MetadataFact {
+export type FactSupportedTypes = 'string' | 'number' | 'date' | 'object' | 'boolean' | 'array';
+/** Base metadata fact */
+interface BaseMetadataFact {
     /** Name of the Fact */
     name: string;
     /** Fact description */
     description?: string;
     /** Type of the fact */
     type: FactSupportedTypes;
+}
+/** Metadata fact of type enum */
+export interface EnumMetadataFact extends BaseMetadataFact {
+    /** @inheritdoc */
+    type: 'string';
+    /** Set of values of enum of type string */
+    enum: string[];
+}
+/** Metadata fact of type object */
+export interface ObjectMetadataFact extends BaseMetadataFact {
+    /** @inheritdoc */
+    type: 'object';
     /** Path to schema file describing the complex file */
     schemaFile?: string;
 }
+/** Metadata fact of type array */
+export interface ArrayMetadataFact extends BaseMetadataFact {
+    /** @inheritdoc */
+    type: 'array';
+    /** Items in array */
+    items: MetadataFact;
+}
+/** Metadata fact of type string, number, date, or boolean */
+export interface OtherMetadataFact extends BaseMetadataFact {
+    /** @inheritdoc */
+    type: 'string' | 'number' | 'date' | 'boolean';
+}
+/** Fact as description in the metadata file */
+export type MetadataFact = OtherMetadataFact | ObjectMetadataFact | EnumMetadataFact | ArrayMetadataFact;
 /** Supported types for a operand */
 export type MetadataOperatorSupportedTypes = 'string' | 'number' | 'date' | 'object' | 'boolean';
 /** All supported default type of an operator when not explicit by the operator (`unknown` as parameter)  */
@@ -54,4 +80,5 @@ export interface Action {
     /** Map of parameter with types */
     parameters?: Record<string, string>;
 }
+export {};
 //# sourceMappingURL=rules-engine.extractor.interfaces.d.ts.map

package/builders/rules-engine-extractor/helpers/rules-engine.extractor.interfaces.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"rules-engine.extractor.interfaces.d.ts","sourceRoot":"","sources":["../../../../builders/rules-engine-extractor/helpers/rules-engine.extractor.interfaces.ts"],"names":[],"mappings":"AAAA,iCAAiC;AACjC,MAAM,MAAM,kBAAkB,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAC;AAErF,+CAA+C;AAC/C,MAAM,WAAW,YAAY;IAC3B,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,uBAAuB;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,uBAAuB;IACvB,IAAI,EAAE,kBAAkB,CAAC;IACzB,sDAAsD;IACtD,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,oCAAoC;AACpC,MAAM,MAAM,8BAA8B,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAC;AAEjG,4GAA4G;AAC5G,eAAO,MAAM,wBAAwB,EAAE,8BAA8B,EAA4C,CAAC;AAElH,0CAA0C;AAC1C,eAAO,MAAM,iBAAiB,EAAE,8BAA8B,EAAsD,CAAC;AAErH,+CAA+C;AAC/C,MAAM,WAAW,eAAe;IAC9B,iDAAiD;IACjD,KAAK,EAAE,CAAC,8BAA8B,GAAG,SAAS,CAAC,EAAE,CAAC;IACtD;;;;;;QAMI;IACJ,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,wCAAwC;AACxC,MAAM,WAAW,gBAAgB;IAC/B,gCAAgC;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,uBAAuB;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,8BAA8B;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,qCAAqC;IACrC,WAAW,EAAE,eAAe,CAAC;IAC7B,sCAAsC;IACtC,YAAY,CAAC,EAAE,eAAe,CAAC;IAC/B,6DAA6D;IAC7D,wBAAwB,CAAC,EAAE,MAAM,EAAE,CAAC;CACrC;AAED,sCAAsC;AACtC,MAAM,WAAW,MAAM;IACrB,yBAAyB;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,gCAAgC;IAChC,WAAW,EAAE,MAAM,CAAC;IACpB,kCAAkC;IAClC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACrC"}
+{"version":3,"file":"rules-engine.extractor.interfaces.d.ts","sourceRoot":"","sources":["../../../../builders/rules-engine-extractor/helpers/rules-engine.extractor.interfaces.ts"],"names":[],"mappings":"AAAA,iCAAiC;AACjC,MAAM,MAAM,kBAAkB,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,SAAS,GAAG,OAAO,CAAC;AAE/F,yBAAyB;AACzB,UAAU,gBAAgB;IACxB,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,uBAAuB;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,uBAAuB;IACvB,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED,iCAAiC;AACjC,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACxD,kBAAkB;IAClB,IAAI,EAAE,QAAQ,CAAC;IACf,2CAA2C;IAC3C,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB;AAED,mCAAmC;AACnC,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC1D,kBAAkB;IAClB,IAAI,EAAE,QAAQ,CAAC;IACf,sDAAsD;IACtD,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,kCAAkC;AAClC,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD,kBAAkB;IAClB,IAAI,EAAE,OAAO,CAAC;IACd,qBAAqB;IAErB,KAAK,EAAE,YAAY,CAAC;CACrB;AAED,6DAA6D;AAC7D,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD,kBAAkB;IAClB,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,CAAC;CAChD;AAED,+CAA+C;AAC/C,MAAM,MAAM,YAAY,GAAG,iBAAiB,GAAG,kBAAkB,GAAG,gBAAgB,GAAG,iBAAiB,CAAC;AACzG,oCAAoC;AACpC,MAAM,MAAM,8BAA8B,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAC;AAEjG,4GAA4G;AAC5G,eAAO,MAAM,wBAAwB,EAAE,8BAA8B,EAA4C,CAAC;AAElH,0CAA0C;AAC1C,eAAO,MAAM,iBAAiB,EAAE,8BAA8B,EAAsD,CAAC;AAErH,+CAA+C;AAC/C,MAAM,WAAW,eAAe;IAC9B,iDAAiD;IACjD,KAAK,EAAE,CAAC,8BAA8B,GAAG,SAAS,CAAC,EAAE,CAAC;IACtD;;;;;;QAMI;IACJ,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,wCAAwC;AACxC,MAAM,WAAW,gBAAgB;IAC/B,gCAAgC;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,uBAAuB;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,8BAA8B;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,qCAAqC;IACrC,WAAW,EAAE,eAAe,CAAC;IAC7B,sCAAsC;IACtC,YAAY,CAAC,EAAE,eAAe,CAAC;IAC/B,6DAA6D;IAC7D,wBAAwB,CAAC,EAAE,MAAM,EAAE,CAAC;CACrC;AAED,sCAAsC;AACtC,MAAM,WAAW,MAAM;IACrB,yBAAyB;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,gCAAgC;IAChC,WAAW,EAAE,MAAM,CAAC;IACpB,kCAAkC;IAClC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACrC"}

package/builders/rules-engine-extractor/helpers/rules-engine.extractor.js

@@ -38,9 +38,8 @@ class RulesEngineExtractor {
      *
      * @param type Name of the type to extract
      * @param sourceFile path to the code source file
-     * @param outputPath path to the schema file to generate
      */
-    async extractTypeRef(type, sourceFile, outputPath) {
+    async extractTypeRef(type, sourceFile) {
         const internalLibFiles = this.tsconfig.extraOptions?.otterSubModuleRefs?.length > 0 ?
             await (0, rxjs_1.lastValueFrom)((0, rxjs_1.zip)(...(this.tsconfig.extraOptions?.otterSubModuleRefs).map((value) => (0, globby_1.default)(value))).pipe((0, operators_1.map)((globFiles) => globFiles.reduce((acc, files) => [
                 ...acc,
@@ -60,7 +59,7 @@ class RulesEngineExtractor {
         if (schema?.definitions?.['utils.DateTime']) {
             schema.definitions['utils.DateTime'] = { type: 'string', format: 'date-time' };
         }
-        return node_fs_1.promises.writeFile(outputPath, JSON.stringify(schema, null, 2));
+        return schema;
     }
     /**
      * Extract the type node used to generate the type metadata.
@@ -191,21 +190,59 @@ class RulesEngineExtractor {
                     }
                     const typeName = mainType.getText(source);
                     const type = ts.isTypeReferenceNode(mainType) && typeName !== 'Date' ? 'object' : typeName.replace('Date', 'date');
-                    const fact = {
-                        name,
-                        description,
-                        type
-                    };
+                    let fact;
                     if (type === 'object') {
-                        const schemaFile = `${core_1.strings.dasherize(typeName)}.schema.json`;
+                        fact = {
+                            type: 'object',
+                            name,
+                            description
+                        };
                         try {
-                            await this.extractTypeRef(typeName, sourceFile, path.resolve(schemaFolderFullPath, schemaFile));
-                            fact.schemaFile = path.join(schemaFolderRelativePath, schemaFile).replace(/[\\]/g, '/');
+                            const schema = await this.extractTypeRef(typeName, sourceFile);
+                            if (schema === null) {
+                                this.logger.warn(`Schema of ${typeName} is null.`);
+                            }
+                            else if (schema.type === 'object') {
+                                const schemaFile = `${core_1.strings.dasherize(typeName)}.schema.json`;
+                                await node_fs_1.promises.writeFile(path.resolve(schemaFolderFullPath, schemaFile), JSON.stringify(schema, null, 2));
+                                fact = {
+                                    ...fact,
+                                    schemaFile: path.join(schemaFolderRelativePath, schemaFile).replace(/[\\]/g, '/')
+                                };
+                            }
+                            else if (schema.type === 'array') {
+                                fact = {
+                                    ...fact,
+                                    type: 'array',
+                                    items: schema.items
+                                };
+                            }
+                            else if (schema.enum) {
+                                fact = {
+                                    ...fact,
+                                    type: 'string',
+                                    // eslint-disable-next-line @typescript-eslint/no-base-to-string
+                                    enum: schema.enum?.filter((value) => !!value).map((v) => v.toString())
+                                };
+                            }
+                            else {
+                                fact = {
+                                    ...fact,
+                                    type: schema.type
+                                };
+                            }
                         }
                         catch {
                             this.logger.warn(`Error when parsing ${type} in ${sourceFile}`);
                         }
                     }
+                    else {
+                        fact = {
+                            type: type,
+                            name,
+                            description
+                        };
+                    }
                     return fact;
                 }));
             }

package/builders/rules-engine-extractor/index.js

@@ -60,7 +60,7 @@ exports.default = (0, architect_1.createBuilder)((0, extractors_1.createBuilderW
     await Promise.all(Object.entries(rulesEngineFactsMetadataFileWithContent)
         .reduce((acc, [metadataFilePath, factsFile]) => acc.concat([
         ...(factsFile.facts || [])
-            .filter(({ schemaFile }) => !!schemaFile)
+            .filter((fact) => fact.type === 'object' && !!fact.schemaFile)
             .map(({ schemaFile }) => ({ fullPath: (0, node_path_1.resolve)((0, node_path_1.dirname)(metadataFilePath), schemaFile), relativePath: schemaFile }))
     ]), [])
         .map(({ fullPath, relativePath }) => node_fs_1.promises.copyFile(fullPath, (0, node_path_1.resolve)(basePath, relativePath))));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@o3r/rules-engine",
-  "version": "10.2.0-prerelease.50",
+  "version": "10.2.0-prerelease.52",
   "publishConfig": {
     "access": "public"
   },
@@ -49,10 +49,10 @@
     "@ngrx/entity": "~17.1.0",
     "@ngrx/store": "~17.1.0",
     "@ngx-translate/core": "~15.0.0",
-    "@o3r/core": "^10.2.0-prerelease.50",
-    "@o3r/extractors": "^10.2.0-prerelease.50",
-    "@o3r/logger": "^10.2.0-prerelease.50",
-    "@o3r/schematics": "^10.2.0-prerelease.50",
+    "@o3r/core": "^10.2.0-prerelease.52",
+    "@o3r/extractors": "^10.2.0-prerelease.52",
+    "@o3r/logger": "^10.2.0-prerelease.52",
+    "@o3r/schematics": "^10.2.0-prerelease.52",
     "@schematics/angular": "~17.3.0",
     "globby": "^11.1.0",
     "jasmine": "^5.0.0",