@commercelayer/cli-plugin-provisioning 2.0.1 → 2.0.3

package/README.md

@@ -190,7 +190,7 @@ FLAGS
   -j, --json                convert output in standard JSON format
   -n, --pageSize=<value>    number of elements per page
   -p, --page=<value>        page number
-  -s, --sort=<value>...     defines results ordering
+  -s, --sort=<value>...     define results ordering
   -u, --unformatted         print unformatted JSON output
   -w, --where=<value>...    comma separated list of query filters
 
@@ -245,7 +245,7 @@ FLAGS
   -j, --json                convert output in standard JSON format
   -n, --pageSize=<value>    number of elements per page
   -p, --page=<value>        page number
-  -s, --sort=<value>...     defines results ordering
+  -s, --sort=<value>...     define results ordering
   -u, --unformatted         print unformatted JSON output
   -w, --where=<value>...    comma separated list of query filters
 
@@ -298,7 +298,7 @@ FLAGS
   -j, --json                convert output in standard JSON format
   -n, --pageSize=<value>    number of elements per page
   -p, --page=<value>        page number
-  -s, --sort=<value>...     defines results ordering
+  -s, --sort=<value>...     define results ordering
   -u, --unformatted         print unformatted JSON output
   -w, --where=<value>...    comma separated list of query filters
 

package/lib/commands/provisioning/create.js

@@ -103,7 +103,7 @@ class ProvisioningCreate extends base_1.default {
         // Include flags
         const include = this.includeFlag(flags.include, relationships);
         // Fields flags
-        const fields = this.fieldsFlag(flags.fields, resource.api);
+        const fields = this.fieldsFlag(flags.fields, resource.type);
         const rawReader = flags.raw ? cl.addRawResponseReader({ headers: showHeaders }) : undefined;
         const reqReader = flags.doc ? (0, lang_1.addRequestReader)(cl) : undefined;
         const params = {};
@@ -123,7 +123,7 @@ class ProvisioningCreate extends base_1.default {
             const out = (flags.raw && rawReader) ? rawReader.rawResponse : res;
             this.printHeaders(rawReader?.headers, flags);
             this.printOutput(out, flags);
-            this.log(`\n${cli_core_1.clColor.style.success('Successfully')} created new resource of type ${cli_core_1.clColor.style.resource(resource.api)} with id ${cli_core_1.clColor.style.id(res.id)}\n`);
+            this.log(`\n${cli_core_1.clColor.style.success('Successfully')} created new resource of type ${cli_core_1.clColor.style.resource(resource.type)} with id ${cli_core_1.clColor.style.id(res.id)}\n`);
             // Save command arguments
             // if (saveCmd) this.saveParams(saveCmd, { type: resource.api }, OPERATION, params)
             return out;

package/lib/commands/provisioning/delete.js

@@ -38,7 +38,7 @@ class ProvisioningDelete extends base_1.default {
             await resSdk.delete(id);
             if (showHeaders)
                 this.printHeaders(rawReader?.headers, flags);
-            this.log(`\n${cli_core_1.clColor.style.success('Successfully')} deleted resource of type ${cli_core_1.clColor.style.resource(resource.api)} with id ${cli_core_1.clColor.style.id(id)}\n`);
+            this.log(`\n${cli_core_1.clColor.style.success('Successfully')} deleted resource of type ${cli_core_1.clColor.style.resource(resource.type)} with id ${cli_core_1.clColor.style.id(id)}\n`);
         }
         catch (error) {
             if ((0, lang_1.isRequestInterrupted)(error) && reqReader) {

package/lib/commands/provisioning/list.js

@@ -31,7 +31,7 @@ class ProvisioningList extends base_1.default {
         }),
         sort: base_1.Flags.string({
             char: 's',
-            description: 'defines results ordering',
+            description: 'define results ordering',
             multiple: true,
         }),
         /*
@@ -74,7 +74,7 @@ class ProvisioningList extends base_1.default {
         // Include flags
         const include = this.includeFlag(flags.include, undefined, flags['force-include']);
         // Fields flags
-        const fields = this.fieldsFlag(flags.fields, resource.api);
+        const fields = this.fieldsFlag(flags.fields, resource.type);
         // Where flags
         const wheres = this.whereFlag(flags.where);
         // Sort flags

package/lib/commands/provisioning/relationship.js

@@ -41,7 +41,7 @@ class ResourcesRelationship extends base_1.default {
         // Include flags
         const include = this.includeFlag(flags.include);
         // Fields flags
-        const fields = this.fieldsFlag(flags.fields, resource.api);
+        const fields = this.fieldsFlag(flags.fields, resource.type);
         // Where flags
         const wheres = this.whereFlag(flags.where);
         // Sort flags

package/lib/commands/provisioning/retrieve.js

@@ -52,7 +52,7 @@ class ProvisioningRetrieve extends base_1.default {
         // Include flags
         const include = this.includeFlag(flags.include);
         // Fields flags
-        const fields = this.fieldsFlag(flags.fields, resource.api);
+        const fields = this.fieldsFlag(flags.fields, resource.type);
         const cl = this.initCommerceLayer(flags);
         const rawReader = flags.raw ? cl.addRawResponseReader({ headers: showHeaders }) : undefined;
         const reqReader = flags.doc ? (0, lang_1.addRequestReader)(cl) : undefined;

package/lib/commands/provisioning/update.js

@@ -112,7 +112,7 @@ class ProvisioningUpdate extends base_1.default {
         // Include flags
         const include = this.includeFlag(flags.include, relationships);
         // Fields flags
-        const fields = this.fieldsFlag(flags.fields, resource.api);
+        const fields = this.fieldsFlag(flags.fields, resource.type);
         const rawReader = flags.raw ? cl.addRawResponseReader({ headers: showHeaders }) : undefined;
         const reqReader = flags.doc ? (0, lang_1.addRequestReader)(cl) : undefined;
         const params = {};
@@ -141,7 +141,7 @@ class ProvisioningUpdate extends base_1.default {
             const out = (flags.raw && rawReader) ? rawReader.rawResponse : res;
             this.printHeaders(rawReader?.headers, flags);
             this.printOutput(out, flags);
-            this.log(`\n${cli_core_1.clColor.style.success('Successfully')} updated resource of type ${cli_core_1.clColor.style.resource(resource.api)} with id ${cli_core_1.clColor.style.id(res.id)}\n`);
+            this.log(`\n${cli_core_1.clColor.style.success('Successfully')} updated resource of type ${cli_core_1.clColor.style.resource(resource.type)} with id ${cli_core_1.clColor.style.id(res.id)}\n`);
             // Save command arguments
             // if (saveCmd) this.saveParams(saveCmd, { type: resource.api }, OPERATION, params)
             return out;

package/lib/util/resources/available.d.ts

@@ -1,34 +1,42 @@
 declare const RESOURCES: readonly [{
     readonly name: "api_credential";
+    readonly type: "api_credentials";
     readonly api: "api_credentials";
     readonly model: "ApiCredential";
 }, {
     readonly name: "application_membership";
+    readonly type: "application_memberships";
     readonly api: "application_memberships";
     readonly model: "ApplicationMembership";
 }, {
     readonly name: "membership";
+    readonly type: "memberships";
     readonly api: "memberships";
     readonly model: "Membership";
 }, {
     readonly name: "organization";
+    readonly type: "organizations";
     readonly api: "organizations";
     readonly model: "Organization";
 }, {
     readonly name: "permission";
+    readonly type: "permissions";
     readonly api: "permissions";
     readonly model: "Permission";
 }, {
     readonly name: "role";
+    readonly type: "roles";
     readonly api: "roles";
     readonly model: "Role";
 }, {
     readonly name: "user";
+    readonly type: "users";
     readonly api: "user";
     readonly model: "User";
     readonly singleton: true;
 }, {
     readonly name: "version";
+    readonly type: "versions";
     readonly api: "versions";
     readonly model: "Version";
 }];

package/lib/util/resources/available.js

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const RESOURCES = [
-    { name: 'api_credential', api: 'api_credentials', model: 'ApiCredential' },
-    { name: 'application_membership', api: 'application_memberships', model: 'ApplicationMembership' },
-    { name: 'membership', api: 'memberships', model: 'Membership' },
-    { name: 'organization', api: 'organizations', model: 'Organization' },
-    { name: 'permission', api: 'permissions', model: 'Permission' },
-    { name: 'role', api: 'roles', model: 'Role' },
-    { name: 'user', api: 'user', model: 'User', singleton: true },
-    { name: 'version', api: 'versions', model: 'Version' },
+    { name: 'api_credential', type: 'api_credentials', api: 'api_credentials', model: 'ApiCredential' },
+    { name: 'application_membership', type: 'application_memberships', api: 'application_memberships', model: 'ApplicationMembership' },
+    { name: 'membership', type: 'memberships', api: 'memberships', model: 'Membership' },
+    { name: 'organization', type: 'organizations', api: 'organizations', model: 'Organization' },
+    { name: 'permission', type: 'permissions', api: 'permissions', model: 'Permission' },
+    { name: 'role', type: 'roles', api: 'roles', model: 'Role' },
+    { name: 'user', type: 'users', api: 'user', model: 'User', singleton: true },
+    { name: 'version', type: 'versions', api: 'versions', model: 'Version' },
 ];
 exports.default = RESOURCES;

package/lib/util/resources/build.js

@@ -4,17 +4,16 @@ const provisioning_sdk_1 = require("@commercelayer/provisioning-sdk");
 const path_1 = require("path");
 const fs_1 = require("fs");
 const cli_core_1 = require("@commercelayer/cli-core");
-const isSingleton = (res) => {
-    return (cli_core_1.clText.singularize(res) === res);
-};
 const parseResourcesSdk = async () => {
     const resList = provisioning_sdk_1.CommerceLayerProvisioningStatic.resources().map(r => {
-        const singular = cli_core_1.clText.singularize(r);
+        const res = r;
+        const singular = cli_core_1.clText.singularize(res);
         const item = {
             name: singular,
-            api: r,
+            type: res,
+            api: provisioning_sdk_1.CommerceLayerProvisioningStatic.isSingleton(res) ? cli_core_1.clText.singularize(res) : res,
             model: cli_core_1.clText.camelize(singular),
-            singleton: isSingleton(r),
+            singleton: provisioning_sdk_1.CommerceLayerProvisioningStatic.isSingleton(res),
         };
         return item;
     });
@@ -30,7 +29,7 @@ const exportResources = async ({ source = 'sdk', variable = false, name = 'resou
         lines.push((variable ? `const ${name} = ` : '') + (array ? '[' : ''));
     const resLines = resources.map(res => {
         let item = `${tab ? '\t' : ''}{ `;
-        item += `name: '${res.name}', api: '${res.api}', model: '${res.model}'`;
+        item += `name: '${res.name}', type: '${res.type}', api: '${res.api}', model: '${res.model}'`;
         if (res.singleton)
             item += ', singleton: true';
         item += ' },';

package/lib/util/resources/index.d.ts

@@ -1,12 +1,13 @@
 import type { ResourceTypeLock } from '@commercelayer/provisioning-sdk';
-interface Resource {
+interface ApiResource {
     name: string;
-    api: ResourceTypeLock;
+    type: ResourceTypeLock;
+    api: string;
     model: string;
     singleton?: boolean;
 }
 declare const findResource: (res: string, { singular }?: {
     singular?: boolean | undefined;
-}) => (Resource | undefined);
+}) => (ApiResource | undefined);
 declare const resourceList: (field: "name" | "api" | "model") => string[];
-export { findResource, resourceList, type Resource };
+export { findResource, resourceList, type ApiResource as Resource };

package/lib/util/resources/index.js

@@ -9,7 +9,7 @@ const findResource = (res, { singular = false } = {}) => {
         return undefined;
     const lowRes = res.toLowerCase();
     return resources.find(r => {
-        return (lowRes === r.api) || (singular && (lowRes === r.name));
+        return (lowRes === r.type) || (singular && (lowRes === r.name));
     });
 };
 exports.findResource = findResource;

package/oclif.manifest.json

@@ -711,7 +711,7 @@
         },
         "sort": {
           "char": "s",
-          "description": "defines results ordering",
+          "description": "define results ordering",
           "name": "sort",
           "hasDynamicHelp": false,
           "multiple": true,
@@ -956,7 +956,7 @@
         },
         "sort": {
           "char": "s",
-          "description": "defines results ordering",
+          "description": "define results ordering",
           "name": "sort",
           "hasDynamicHelp": false,
           "multiple": true,
@@ -1185,7 +1185,7 @@
         },
         "sort": {
           "char": "s",
-          "description": "defines results ordering",
+          "description": "define results ordering",
           "name": "sort",
           "hasDynamicHelp": false,
           "multiple": true,
@@ -1455,7 +1455,7 @@
         },
         "sort": {
           "char": "s",
-          "description": "defines results ordering",
+          "description": "define results ordering",
           "name": "sort",
           "hasDynamicHelp": false,
           "multiple": true,
@@ -1994,5 +1994,5 @@
       ]
     }
   },
-  "version": "2.0.1"
+  "version": "2.0.3"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@commercelayer/cli-plugin-provisioning",
   "description": "Commerce Layer CLI Provisioning plugin",
-  "version": "2.0.1",
+  "version": "2.0.3",
   "author": "Pierluigi Viti <pierluigi@commercelayer.io>",
   "homepage": "https://github.com/commercelayer/commercelayer-cli-plugin-provisioning",
   "repository": "commercelayer/commercelayer-cli-plugin-provisioning",
@@ -55,32 +55,32 @@
   },
   "types": "lib/index.d.ts",
   "devDependencies": {
-    "@commercelayer/cli-dev": "^3.0.5",
+    "@commercelayer/cli-dev": "^3.0.6",
     "@commercelayer/eslint-config-ts": "^1.4.5",
-    "@oclif/plugin-help": "^6.2.3",
+    "@oclif/plugin-help": "^6.2.18",
     "@oclif/test": "^3.2.15",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
-    "@types/chai": "^4.3.16",
+    "@types/chai": "^4.3.20",
     "@types/inquirer": "^8.2.10",
-    "@types/mocha": "^10.0.7",
-    "@types/node": "^20.14.8",
-    "chai": "^4.4.1",
-    "eslint": "^8.57.0",
-    "mocha": "^10.5.1",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^20.17.9",
+    "chai": "^4.5.0",
+    "eslint": "^8.57.1",
+    "mocha": "^10.8.2",
     "nyc": "^15.1.0",
-    "oclif": "^4.13.10",
+    "oclif": "^4.16.0",
     "semantic-release": "^23.1.1",
-    "tsx": "^4.15.7",
-    "typescript": "^5.5.2"
+    "tsx": "^4.19.2",
+    "typescript": "^5.7.2"
   },
   "dependencies": {
-    "@commercelayer/cli-core": "^5.1.0",
-    "@commercelayer/provisioning-sdk": "^2.1.0",
+    "@commercelayer/cli-core": "^5.4.2",
+    "@commercelayer/provisioning-sdk": "^2.2.0",
     "@oclif/core": "^3.27.0",
     "inquirer": "^8.2.6",
-    "json-2-csv": "^5.5.1",
-    "tslib": "^2.6.3"
+    "json-2-csv": "^5.5.7",
+    "tslib": "^2.8.1"
   },
   "publishConfig": {
     "access": "public"