@salesforce/plugin-bre-to-cml 1.0.2

package/oclif.manifest.json

@@ -0,0 +1,209 @@
+{
+  "commands": {
+    "cml:convert:prod-cfg-rules": {
+      "aliases": [],
+      "args": {},
+      "description": "Before you execute this command make sure to migrate you PCM or perform migration of rules within the same org.\n\nExport BRE based Standard Configurator rules using sf data export bulk plugin and save results in a JSON file:\nsf data export bulk -o breMigOrg --query \"SELECT ApiName, ConfigurationRuleDefinition,Description, EffectiveFromDate, EffectiveToDate, Id, IsDeleted, Name, ProcessScope, RuleSubType, RuleType, Sequence, Status FROM ProductConfigurationRule WHERE RuleType = 'Configurator' AND ApiName = 'myTestBundle'\" --output-file ./data/ProductConfigurationRules.json --result-format json --wait 10 --all-rows\n\nThis command executes following logic:\n\n- Read SC Rules from the json file and build a list of `ConfiguratorRuleInput` to mimic the JSON structure of `ConfigurationRuleDefinition`\n- Group rules by non-intersecting `Product2` IDs (CMLs can’t share products)\n- For each group:\n  - Query PCM for related products (for bundle rules) or root definitions (for others)\n  - Build an in-memory representation of the CML\n  - Apply logic to build constraints\n- Serialize the in-memory CML to a blob for import as an Expression Set, save it in a cml-api.cml file. \n- Create `ExpressionSetConstraintObj` association records pointing to the `cml-api` name and write them to `cml-api_associations.csv` file.\n- If multiple CML and association files are produced 1-N number will be appended to the names of files.",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> --pcr-file data/ProductConfigurationRules.json --cml-api MY_TEST --workspace-dir data --target-org breMigOrg"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "flags-dir": {
+          "helpGroup": "GLOBAL",
+          "name": "flags-dir",
+          "summary": "Import flag values from a directory.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "target-org": {
+          "char": "o",
+          "name": "target-org",
+          "noCacheDefault": true,
+          "required": true,
+          "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
+          "hasDynamicHelp": true,
+          "multiple": false,
+          "type": "option"
+        },
+        "api-version": {
+          "description": "Override the api version used for api requests made by this command",
+          "name": "api-version",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "pcr-file": {
+          "char": "r",
+          "name": "pcr-file",
+          "required": true,
+          "summary": "Name of the JSON file that contain exported standard Product Configuration Rules.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "cml-api": {
+          "char": "c",
+          "name": "cml-api",
+          "required": true,
+          "summary": "Unique CML API Name to be created.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "workspace-dir": {
+          "char": "d",
+          "name": "workspace-dir",
+          "summary": "Directory where working files are located, exported rules JSON and where CMLs will be created.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "additional-products": {
+          "char": "x",
+          "name": "additional-products",
+          "summary": "Comma-separated list of additional product IDs for which CML types should be generated.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "products-file": {
+          "char": "v",
+          "name": "products-file",
+          "summary": "Name of the JSON file that contain exported Products from PCM (if not present products will be fetched automatically).",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": true,
+      "hiddenAliases": [],
+      "id": "cml:convert:prod-cfg-rules",
+      "pluginAlias": "@salesforce/plugin-bre-to-cml",
+      "pluginName": "@salesforce/plugin-bre-to-cml",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Converts BRE based Standard Configurator rules represented as JSON to CML and saves it as a pair of CML and association files.",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "cml",
+        "convert",
+        "prod-cfg-rules.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "cml:convert:prod-cfg-rules",
+        "convert:cml:prod-cfg-rules",
+        "convert:prod-cfg-rules:cml",
+        "cml:prod-cfg-rules:convert",
+        "prod-cfg-rules:cml:convert",
+        "prod-cfg-rules:convert:cml"
+      ]
+    },
+    "cml:import:as-expression-set": {
+      "aliases": [],
+      "args": {},
+      "description": "Review CM created by conversion command before doing import.  \nThis command executes following logic:\n- Import one CML at a time\n- Upsert the Expression Set using the `cml-api` name\n- Read and upsert `ExpressionSetConstraintObj` rows from the `cml-api_associations.csv` file (resolving FKs)\n- Upload the CML blob",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> --cml-api MY_TEST --context-definition PricingTransactionCD2 --workspace-dir data --target-org tgtOrg"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "flags-dir": {
+          "helpGroup": "GLOBAL",
+          "name": "flags-dir",
+          "summary": "Import flag values from a directory.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "target-org": {
+          "char": "o",
+          "name": "target-org",
+          "noCacheDefault": true,
+          "required": true,
+          "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
+          "hasDynamicHelp": true,
+          "multiple": false,
+          "type": "option"
+        },
+        "api-version": {
+          "description": "Override the api version used for api requests made by this command",
+          "name": "api-version",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "context-definition": {
+          "char": "x",
+          "name": "context-definition",
+          "required": true,
+          "summary": "Context Definition name to be assocciated with the CML.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "cml-api": {
+          "char": "c",
+          "name": "cml-api",
+          "required": true,
+          "summary": "Unique CML API Name to be created.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "workspace-dir": {
+          "char": "d",
+          "name": "workspace-dir",
+          "summary": "Directory where converted CML and assocciations csv files are located.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": true,
+      "hiddenAliases": [],
+      "id": "cml:import:as-expression-set",
+      "pluginAlias": "@salesforce/plugin-bre-to-cml",
+      "pluginName": "@salesforce/plugin-bre-to-cml",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Imports CML and associations to the target org",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "cml",
+        "import",
+        "as-expression-set.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "cml:import:as-expression-set",
+        "import:cml:as-expression-set",
+        "import:as-expression-set:cml",
+        "cml:as-expression-set:import",
+        "as-expression-set:cml:import",
+        "as-expression-set:import:cml"
+      ]
+    }
+  },
+  "version": "1.0.2"
+}

package/package.json

@@ -0,0 +1,227 @@
+{
+    "name": "@salesforce/plugin-bre-to-cml",
+    "description": "Plugin for migrating BRE based configurator rules to CML.",
+    "version": "1.0.2",
+    "salesforceRelease": "256.11",
+    "dependencies": {
+        "@oclif/core": "^4",
+        "@salesforce/core": "^8.2.7",
+        "@salesforce/sf-plugins-core": "^12",
+        "csv-parse": "^5.6.0",
+        "got": "12"
+    },
+    "devDependencies": {
+        "@oclif/plugin-command-snapshot": "^5.3.5",
+        "@salesforce/plugin-command-reference": "^3.1.61",
+        "@oclif/test": "^4.1.0",
+        "@salesforce/cli-plugins-testkit": "^5.3.20",
+        "@salesforce/dev-scripts": "^11.0.2",
+        "@types/node": "^22.17.0",
+        "eslint-config-salesforce-license": "^1.0.1",
+        "eslint-plugin-sf-plugin": "^1.18.8",
+        "oclif": "^4.14.0",
+        "ts-node": "^10.9.2",
+        "typescript": "^5.9.2"
+    },
+    "engines": {
+        "node": ">=18.0.0"
+    },
+    "files": [
+        "lib",
+        "messages",
+        "oclif.manifest.json",
+        "oclif.lock"
+    ],
+    "keywords": [
+        "force",
+        "salesforce",
+        "salesforcedx",
+        "sf",
+        "sf-plugin",
+        "sfdx",
+        "sfdx-plugin"
+    ],
+    "license": "Apache-2.0",
+    "oclif": {
+        "commands": "./lib/commands",
+        "bin": "sf",
+        "topicSeparator": " ",
+        "devPlugins": [
+            "@oclif/plugin-help",
+            "@oclif/plugin-command-snapshot",
+            "@salesforce/plugin-command-reference"
+        ],
+        "topics": {
+            "cml": {
+                "description": "description for cml",
+                "subtopics": {
+                    "convert": {
+                        "description": "description for cml.convert"
+                    },
+                    "import": {
+                        "description": "description for cml.import"
+                    }
+                }
+            }
+        },
+        "flexibleTaxonomy": true
+    },
+    "scripts": {
+        "build": "wireit",
+        "clean": "sf-clean",
+        "clean-all": "sf-clean all",
+        "compile": "wireit",
+        "dev.js": "./bin/dev.js cml convert prod-cfg-rules -o prism-dev -r ./data/ProductConfigurationRules3.json -v ./data/Products.json -c TestModel3 -d ./data/output",
+        "docs": "sf-docs",
+        "fix-license": "eslint src test --fix --rule \"header/header: [2]\"",
+        "format": "wireit",
+        "link-check": "wireit",
+        "lint": "wireit",
+        "postinstall": "test -d .git && yarn husky install || echo 'Skipping husky install'",
+        "postpack": "sf-clean --ignore-signing-artifacts",
+        "prepack": "sf-prepack",
+        "prepare": "sf-install",
+        "test": "wireit",
+        "test:nuts": "nyc mocha \"**/*.nut.ts\" --slow 4500 --timeout 600000 --parallel",
+        "test:only": "wireit",
+        "version": "oclif readme"
+    },
+    "publishConfig": {
+        "access": "public"
+    },
+    "wireit": {
+        "build": {
+            "dependencies": [
+                "compile",
+                "lint",
+                "gen-manifest"
+            ]
+        },
+        "compile": {
+            "command": "tsc -p . --pretty --incremental",
+            "files": [
+                "src/**/*.ts",
+                "**/tsconfig.json",
+                "messages/**"
+            ],
+            "output": [
+                "lib/**",
+                "*.tsbuildinfo"
+            ],
+            "clean": "if-file-deleted"
+        },
+        "format": {
+            "command": "prettier --write \"+(src|test|schemas)/**/*.+(ts|js|json)|command-snapshot.json\"",
+            "files": [
+                "src/**/*.ts",
+                "test/**/*.ts",
+                "schemas/**/*.json",
+                "command-snapshot.json",
+                ".prettier*"
+            ],
+            "output": []
+        },
+        "lint": {
+            "command": "eslint src test --color --cache --cache-location .eslintcache",
+            "files": [
+                "src/**/*.ts",
+                "test/**/*.ts",
+                "messages/**",
+                "**/.eslint*",
+                "**/tsconfig.json"
+            ],
+            "output": []
+        },
+        "gen-manifest": {
+            "command": "yarn oclif manifest .",
+            "dependencies": [
+                "compile"
+            ],
+            "files": [
+                "lib/commands/**/*.js"
+            ],
+            "output": [
+                "oclif.manifest.json"
+            ]
+        },
+        "test:compile": {
+            "command": "tsc -p \"./test\" --pretty",
+            "files": [
+                "test/**/*.ts",
+                "**/tsconfig.json"
+            ],
+            "output": []
+        },
+        "test": {
+            "dependencies": [
+                "test:compile",
+                "test:only",
+                "test:command-reference",
+                "test:deprecation-policy",
+                "lint",
+                "test:json-schema",
+                "link-check"
+            ]
+        },
+        "test:only": {
+            "command": "nyc mocha \"test/**/*.test.ts\"",
+            "env": {
+                "FORCE_COLOR": "2"
+            },
+            "files": [
+                "test/**/*.ts",
+                "src/**/*.ts",
+                "**/tsconfig.json",
+                ".mocha*",
+                "!*.nut.ts",
+                ".nycrc"
+            ],
+            "output": []
+        },
+        "test:command-reference": {
+            "command": "node --loader ts-node/esm --no-warnings=ExperimentalWarning \"./bin/dev.js\" commandreference:generate --erroronwarnings",
+            "files": [
+                "src/**/*.ts",
+                "messages/**",
+                "package.json"
+            ],
+            "output": [
+                "tmp/root"
+            ]
+        },
+        "test:deprecation-policy": {
+            "command": "node --loader ts-node/esm --no-warnings=ExperimentalWarning \"./bin/dev.js\" snapshot:compare",
+            "files": [
+                "src/**/*.ts"
+            ],
+            "output": [],
+            "dependencies": [
+                "compile"
+            ]
+        },
+        "test:json-schema": {
+            "command": "node --loader ts-node/esm --no-warnings=ExperimentalWarning \"./bin/dev.js\" schema:compare",
+            "files": [
+                "src/**/*.ts",
+                "schemas"
+            ],
+            "output": []
+        },
+        "link-check": {
+            "command": "node -e \"process.exit(process.env.CI ? 0 : 1)\" || linkinator \"**/*.md\" --skip \"CHANGELOG.md|node_modules|test/|confluence.internal.salesforce.com|my.salesforce.com|localhost|%s\" --markdown --retry --directory-listing --verbosity error",
+            "files": [
+                "./*.md",
+                "./!(CHANGELOG).md",
+                "messages/**/*.md"
+            ],
+            "output": []
+        }
+    },
+    "exports": "./lib/index.js",
+    "type": "module",
+    "author": "George Kibilov",
+    "sfdx": {
+        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-bre-to-cml/1.0.2.crt",
+        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-bre-to-cml/1.0.2.sig"
+    }
+}