@salesforce/b2c-cli 1.14.1 → 1.16.0

package/dist/utils/cip/report-flags.js

@@ -4,6 +4,11 @@
  * For full license text, see the license.txt file in the repo root or http://www.apache.org/licenses/LICENSE-2.0
  */
 import { Flags } from '@oclif/core';
+import { getCipReportByName } from '@salesforce/b2c-tooling-sdk';
+/** Converts a camelCase report parameter name to its kebab-case CLI flag name. */
+export function paramNameToFlag(name) {
+    return name.replaceAll(/[A-Z]/gu, (match) => `-${match.toLowerCase()}`);
+}
 export function createSiteIdFlag(options = {}) {
     return Flags.string({
         description: 'Site ID parameter for CIP report filters',
@@ -20,4 +25,69 @@ export function createLimitFlag(options = {}) {
         required: false,
     });
 }
+/**
+ * Maps a single report parameter definition to an oclif flag.
+ *
+ * `from`/`to` are intentionally skipped because they are already provided by
+ * {@link CipCommand.baseFlags}; callers should exclude them. Number params become
+ * range-checked integer flags, enum params become string flags with `options`, and
+ * `multiple` params accept repeated values.
+ */
+function paramToFlag(parameter) {
+    // Report params are intentionally NOT marked oclif-required even when the catalog
+    // marks them required: the SDK's validateReportParams enforces required-ness when
+    // building SQL, and `--describe` / metadata flows must run without supplying them.
+    // Making them oclif-required would break `cip report <name> --describe`.
+    const common = {
+        description: parameter.description,
+        helpGroup: 'QUERY',
+        required: false,
+    };
+    if (parameter.type === 'number') {
+        return Flags.integer({
+            ...common,
+            ...(parameter.min === undefined ? {} : { min: parameter.min }),
+            ...(parameter.max === undefined ? {} : { max: parameter.max }),
+        });
+    }
+    // string / boolean / date all surface as string flags; the SDK validates and
+    // escapes the value when building SQL. Enum params constrain to their options.
+    const options = parameter.options && parameter.options.length > 0 ? parameter.options : undefined;
+    if (parameter.multiple) {
+        return Flags.string({ ...common, multiple: true, ...(options ? { options } : {}) });
+    }
+    return Flags.string({ ...common, ...(options ? { options } : {}) });
+}
+/**
+ * Builds the oclif flag map for a report's own parameters from its catalog
+ * definition, excluding `from`/`to` which are handled by the base command. `siteId`
+ * is mapped to the shared `--site-id` flag. Returns flags keyed by kebab-cased name.
+ */
+export function buildReportFlags(report) {
+    const flags = {};
+    for (const parameter of report.parameters) {
+        if (parameter.name === 'from' || parameter.name === 'to') {
+            continue;
+        }
+        if (parameter.name === 'siteId') {
+            // Not oclif-required; the SDK validates required-ness at SQL-build time so
+            // `--describe` works without a site id (matches the historical behavior).
+            flags['site-id'] = createSiteIdFlag({ required: false });
+            continue;
+        }
+        flags[paramNameToFlag(parameter.name)] = paramToFlag(parameter);
+    }
+    return flags;
+}
+/**
+ * Resolves a report definition by name or throws — used by per-command files at
+ * module load to fail loudly if a report name does not exist in the catalog.
+ */
+export function requireReport(reportName) {
+    const report = getCipReportByName(reportName);
+    if (!report) {
+        throw new Error(`Unknown CIP report referenced by command: ${reportName}`);
+    }
+    return report;
+}
 //# sourceMappingURL=report-flags.js.map

package/dist/utils/cip/report-flags.js.map

@@ -1 +1 @@
-{"version":3,"file":"report-flags.js","sourceRoot":"","sources":["../../../src/utils/cip/report-flags.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAC,KAAK,EAAC,MAAM,aAAa,CAAC;AAWlC,MAAM,UAAU,gBAAgB,CAAC,UAA6B,EAAE;IAC9D,OAAO,KAAK,CAAC,MAAM,CAAC;QAClB,WAAW,EAAE,0CAA0C;QACvD,SAAS,EAAE,OAAO;QAClB,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,KAAK;KACpC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,UAA4B,EAAE;IAC5D,OAAO,KAAK,CAAC,OAAO,CAAC;QACnB,WAAW,EAAE,wBAAwB;QACrC,SAAS,EAAE,OAAO;QAClB,GAAG,EAAE,OAAO,CAAC,GAAG,IAAI,GAAG;QACvB,GAAG,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;QACrB,QAAQ,EAAE,KAAK;KAChB,CAAC,CAAC;AACL,CAAC"}
+{"version":3,"file":"report-flags.js","sourceRoot":"","sources":["../../../src/utils/cip/report-flags.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAC,KAAK,EAAkB,MAAM,aAAa,CAAC;AACnD,OAAO,EAAC,kBAAkB,EAA0D,MAAM,6BAA6B,CAAC;AAWxH,kFAAkF;AAClF,MAAM,UAAU,eAAe,CAAC,IAAY;IAC1C,OAAO,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;AAC1E,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,UAA6B,EAAE;IAC9D,OAAO,KAAK,CAAC,MAAM,CAAC;QAClB,WAAW,EAAE,0CAA0C;QACvD,SAAS,EAAE,OAAO;QAClB,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,KAAK;KACpC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,UAA4B,EAAE;IAC5D,OAAO,KAAK,CAAC,OAAO,CAAC;QACnB,WAAW,EAAE,wBAAwB;QACrC,SAAS,EAAE,OAAO;QAClB,GAAG,EAAE,OAAO,CAAC,GAAG,IAAI,GAAG;QACvB,GAAG,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;QACrB,QAAQ,EAAE,KAAK;KAChB,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,WAAW,CAAC,SAAmC;IACtD,kFAAkF;IAClF,kFAAkF;IAClF,mFAAmF;IACnF,yEAAyE;IACzE,MAAM,MAAM,GAAG;QACb,WAAW,EAAE,SAAS,CAAC,WAAW;QAClC,SAAS,EAAE,OAAgB;QAC3B,QAAQ,EAAE,KAAK;KAChB,CAAC;IAEF,IAAI,SAAS,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAChC,OAAO,KAAK,CAAC,OAAO,CAAC;YACnB,GAAG,MAAM;YACT,GAAG,CAAC,SAAS,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAC,GAAG,EAAE,SAAS,CAAC,GAAG,EAAC,CAAC;YAC5D,GAAG,CAAC,SAAS,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAC,GAAG,EAAE,SAAS,CAAC,GAAG,EAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED,6EAA6E;IAC7E,+EAA+E;IAC/E,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,IAAI,SAAS,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;IAElG,IAAI,SAAS,CAAC,QAAQ,EAAE,CAAC;QACvB,OAAO,KAAK,CAAC,MAAM,CAAC,EAAC,GAAG,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAC,OAAO,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAC,CAAC,CAAC;IAClF,CAAC;IAED,OAAO,KAAK,CAAC,MAAM,CAAC,EAAC,GAAG,MAAM,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAC,OAAO,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAC,CAAC,CAAC;AAClE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAA2B;IAC1D,MAAM,KAAK,GAAyB,EAAE,CAAC;IAEvC,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;QAC1C,IAAI,SAAS,CAAC,IAAI,KAAK,MAAM,IAAI,SAAS,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;YACzD,SAAS;QACX,CAAC;QAED,IAAI,SAAS,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAChC,2EAA2E;YAC3E,0EAA0E;YAC1E,KAAK,CAAC,SAAS,CAAC,GAAG,gBAAgB,CAAC,EAAC,QAAQ,EAAE,KAAK,EAAC,CAAC,CAAC;YACvD,SAAS;QACX,CAAC;QAED,KAAK,CAAC,eAAe,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,WAAW,CAAC,SAAS,CAAC,CAAC;IAClE,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,aAAa,CAAC,UAAkB;IAC9C,MAAM,MAAM,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;IAC9C,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,6CAA6C,UAAU,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}