@commercelayer/cli-plugin-metrics 1.0.1 → 1.0.2

package/README.md

@@ -130,10 +130,11 @@ Perform a Frequently Bought Together query on the Metrics API analysis endpoint.
 
 ```sh-session
 USAGE
-  $ commercelayer metrics:fbt [-i <value>...]
+  $ commercelayer metrics:fbt [-F <value>] [-i <value>...]
 
 FLAGS
-  -i, --in=<value>...  a list of SKU or bundle IDs associated as line items to one or more orders
+  -F, --filter=<value>  the filter to apply to the query in JSON format (enclosed in single quotes)
+  -i, --in=<value>...   a list of SKU or bundle IDs associated as line items to one or more orders
 
 DESCRIPTION
   perform a Frequently Bought Together query on the Metrics API analysis endpoint

package/lib/base.d.ts

@@ -15,7 +15,16 @@ export declare abstract class BaseCommand extends Command {
     protected multivalFlag(flag?: string[]): string[];
     protected printResponse(response: Response): Promise<void>;
 }
-export declare abstract class BaseResourceCommand extends BaseCommand {
+export declare abstract class BaseFilterCommand extends BaseCommand {
+    static baseFlags: {
+        filter: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+        organization: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+        domain: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+        accessToken: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+    };
+    protected filterFlag(flag?: string): MetricsFilter | undefined;
+}
+export declare abstract class BaseResourceCommand extends BaseFilterCommand {
     static baseFlags: {
         filter: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
         organization: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
@@ -25,7 +34,6 @@ export declare abstract class BaseResourceCommand extends BaseCommand {
     static args: {
         resource: import("@oclif/core/lib/interfaces").Arg<string, Record<string, unknown>>;
     };
-    protected filterFlag(flag?: string): MetricsFilter | undefined;
 }
 export declare abstract class BaseBreakdownCommand extends BaseResourceCommand {
     static baseFlags: {

package/lib/base.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Flags = exports.Args = exports.BaseBreakdownCommand = exports.BaseResourceCommand = exports.BaseCommand = void 0;
+exports.Flags = exports.Args = exports.BaseBreakdownCommand = exports.BaseResourceCommand = exports.BaseFilterCommand = exports.BaseCommand = void 0;
 const tslib_1 = require("tslib");
 const sdk_1 = tslib_1.__importStar(require("@commercelayer/sdk"));
 const core_1 = require("@oclif/core");
@@ -99,7 +99,7 @@ class BaseCommand extends core_1.Command {
     }
 }
 exports.BaseCommand = BaseCommand;
-class BaseResourceCommand extends BaseCommand {
+class BaseFilterCommand extends BaseCommand {
     static baseFlags = {
         ...BaseCommand.baseFlags,
         filter: core_1.Flags.string({
@@ -107,9 +107,6 @@ class BaseResourceCommand extends BaseCommand {
             description: 'the filter to apply to the query in JSON format (enclosed in single quotes)'
         })
     };
-    static args = {
-        resource: core_1.Args.string({ resource: 'the resource name', options: common_1.resources, required: true })
-    };
     filterFlag(flag) {
         let filter;
         if (flag) {
@@ -123,6 +120,15 @@ class BaseResourceCommand extends BaseCommand {
         return filter;
     }
 }
+exports.BaseFilterCommand = BaseFilterCommand;
+class BaseResourceCommand extends BaseFilterCommand {
+    static baseFlags = {
+        ...BaseFilterCommand.baseFlags
+    };
+    static args = {
+        resource: core_1.Args.string({ resource: 'the resource name', options: common_1.resources, required: true })
+    };
+}
 exports.BaseResourceCommand = BaseResourceCommand;
 class BaseBreakdownCommand extends BaseResourceCommand {
     static baseFlags = {

package/lib/commands/metrics/fbt.d.ts

@@ -1,5 +1,5 @@
-import { BaseCommand } from '../../base';
-export default class MetricsFbt extends BaseCommand {
+import { BaseFilterCommand } from '../../base';
+export default class MetricsFbt extends BaseFilterCommand {
     static operation: string;
     static aliases: string[];
     static description: string;

package/lib/commands/metrics/fbt.js

@@ -6,7 +6,7 @@ const base_1 = require("../../base");
 const request_1 = require("../../request");
 const cli_core_1 = require("@commercelayer/cli-core");
 const cliux = tslib_1.__importStar(require("@commercelayer/cli-ux"));
-class MetricsFbt extends base_1.BaseCommand {
+class MetricsFbt extends base_1.BaseFilterCommand {
     static operation = 'fbt';
     static aliases = [MetricsFbt.operation];
     static description = 'perform a Frequently Bought Together query on the Metrics API analysis endpoint';
@@ -18,15 +18,20 @@ class MetricsFbt extends base_1.BaseCommand {
             char: 'i',
             description: 'a list of SKU or bundle IDs associated as line items to one or more orders',
             required: false,
-            multiple: true
+            multiple: true,
+            relationships: [
+                { type: 'some', flags: ['in', 'filter'] }
+            ],
         })
     };
     async run() {
         const { flags } = await this.parse(MetricsFbt);
         this.checkAcessTokenData(flags.accessToken, flags);
         const ids = this.multivalFlag(flags.in);
+        const filterObject = this.filterFlag(flags.filter);
         const query = (ids.length > 0) ? {
             filter: {
+                ...filterObject,
                 line_items: {
                     item_ids: {
                         in: ids

package/oclif.manifest.json

@@ -365,10 +365,27 @@
           "multiple": false,
           "type": "option"
         },
+        "filter": {
+          "char": "F",
+          "description": "the filter to apply to the query in JSON format (enclosed in single quotes)",
+          "name": "filter",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "in": {
           "char": "i",
           "description": "a list of SKU or bundle IDs associated as line items to one or more orders",
           "name": "in",
+          "relationships": [
+            {
+              "type": "some",
+              "flags": [
+                "in",
+                "filter"
+              ]
+            }
+          ],
           "required": false,
           "hasDynamicHelp": false,
           "multiple": true,
@@ -670,5 +687,5 @@
       ]
     }
   },
-  "version": "1.0.1"
+  "version": "1.0.2"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@commercelayer/cli-plugin-metrics",
   "description": "Commerce Layer CLI metrics plugin",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "author": "Pierluigi Viti <pierluigi@commercelayer.io>",
   "bugs": "https://github.com/commercelayer/commercelayer-cli-plugin-metrics/issues",
   "engines": {
@@ -63,20 +63,20 @@
     "@semantic-release/git": "^10.0.1",
     "@types/chai": "^4.3.20",
     "@types/mocha": "^10.0.10",
-    "@types/node": "^22.15.18",
+    "@types/node": "^22.15.24",
     "chai": "^4.5.0",
     "eslint": "^8.57.1",
     "mocha": "^10.8.2",
     "nyc": "^15.1.0",
     "oclif": "^4.17.46",
-    "semantic-release": "^24.2.3",
+    "semantic-release": "^24.2.5",
     "tsx": "^4.19.4",
     "typescript": "5.5.2"
   },
   "dependencies": {
     "@commercelayer/cli-core": "^5.9.0",
     "@commercelayer/cli-ux": "^1.0.7",
-    "@commercelayer/sdk": "^6.41.0",
+    "@commercelayer/sdk": "^6.42.0",
     "@oclif/core": "^3.27.0",
     "tslib": "^2.8.1"
   },