@salesforce/b2c-tooling-sdk 1.24.2 → 2.1.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@salesforce/b2c-tooling-sdk",
   "description": "Core tooling library for Salesforce B2C Commerce CLI",
-  "version": "1.24.2",
+  "version": "2.1.0",
   "author": "Charles Lavery",
   "license": "Apache-2.0",
   "repository": "SalesforceCommerceCloud/b2c-developer-tooling",
@@ -23,6 +23,10 @@
     "registry": "https://registry.npmjs.org/"
   },
   "exports": {
+    "./scapi": {
+      "types": "./dist/esm/scapi/index.d.ts",
+      "default": "./dist/esm/scapi/index.js"
+    },
     "./package.json": "./package.json",
     ".": {
       "types": "./dist/esm/index.d.ts",
@@ -84,6 +88,10 @@
       "types": "./dist/esm/operations/sites/index.d.ts",
       "default": "./dist/esm/operations/sites/index.js"
     },
+    "./operations/catalogs": {
+      "types": "./dist/esm/operations/catalogs/index.d.ts",
+      "default": "./dist/esm/operations/catalogs/index.js"
+    },
     "./operations/orgs": {
       "types": "./dist/esm/operations/orgs/index.d.ts",
       "default": "./dist/esm/operations/orgs/index.js"
@@ -112,6 +120,10 @@
       "types": "./dist/esm/clients/index.d.ts",
       "default": "./dist/esm/clients/index.js"
     },
+    "./compat": {
+      "types": "./dist/esm/compat/index.d.ts",
+      "default": "./dist/esm/compat/index.js"
+    },
     "./logging": {
       "types": "./dist/esm/logging/index.d.ts",
       "default": "./dist/esm/logging/index.js"
@@ -167,6 +179,10 @@
     "./ux": {
       "types": "./dist/esm/ux/index.d.ts",
       "default": "./dist/esm/ux/index.js"
+    },
+    "./guidance": {
+      "types": "./dist/esm/guidance/index.d.ts",
+      "default": "./dist/esm/guidance/index.js"
     }
   },
   "main": "./dist/esm/index.js",
@@ -177,6 +193,9 @@
     "data",
     "!data/script-api/*.md"
   ],
+  "bundledDependencies": [
+    "@salesforce/b2c-api-schemas"
+  ],
   "devDependencies": {
     "@eslint/compat": "^1",
     "@oclif/core": "4.8.0",
@@ -226,6 +245,7 @@
     "fuse.js": "7.1.0",
     "glob": "13.0.0",
     "i18next": "25.7.4",
+    "jiti": "2.6.1",
     "js-yaml": "4.2.0",
     "jsonschema": "1.5.0",
     "jszip": "3.10.1",
@@ -238,10 +258,11 @@
     "protobufjs": "7.6.4",
     "tar-fs": "3.1.2",
     "undici": "7.28.0",
-    "xml2js": "0.6.2"
+    "xml2js": "0.6.2",
+    "@salesforce/b2c-api-schemas": "0.2.0"
   },
   "scripts": {
-    "generate:types": "openapi-typescript specs/data-api.json -o src/clients/ocapi.generated.ts && openapi-typescript specs/slas-admin-v1.yaml -o src/clients/slas-admin.generated.ts && openapi-typescript specs/ods-api-v1.json -o src/clients/ods.generated.ts && openapi-typescript specs/mrt-api-v1.json -o src/clients/mrt.generated.ts && openapi-typescript specs/mrt-b2c.json -o src/clients/mrt-b2c.generated.ts && openapi-typescript specs/custom-apis-v1.yaml -o src/clients/custom-apis.generated.ts && openapi-typescript specs/scapi-schemas-v1.yaml -o src/clients/scapi-schemas.generated.ts && openapi-typescript specs/cdn-zones-v1.yaml -o src/clients/cdn-zones.generated.ts && openapi-typescript specs/am-users-api-v1.yaml -o src/clients/am-users-api.generated.ts && openapi-typescript specs/am-roles-api-v1.yaml -o src/clients/am-roles-api.generated.ts && openapi-typescript specs/am-apiclients-api-v1.yaml -o src/clients/am-apiclients-api.generated.ts && openapi-typescript specs/granular-replications-v1.yaml -o src/clients/granular-replications.generated.ts && openapi-typescript specs/preferences-v1.yaml -o src/clients/preferences.generated.ts && openapi-typescript specs/metrics-v1.json -o src/clients/metrics.generated.ts",
+    "generate:types": "openapi-typescript specs/data-api.json -o src/clients/ocapi.generated.ts && openapi-typescript specs/slas-admin-v1.yaml -o src/clients/slas-admin.generated.ts && openapi-typescript specs/slas-shopper-v1.yaml -o src/clients/slas-shopper.generated.ts && openapi-typescript specs/ods-api-v1.json -o src/clients/ods.generated.ts && openapi-typescript specs/mrt-api-v1.json -o src/clients/mrt.generated.ts && openapi-typescript specs/mrt-b2c.json -o src/clients/mrt-b2c.generated.ts && openapi-typescript specs/custom-apis-v1.yaml -o src/clients/custom-apis.generated.ts && openapi-typescript specs/scapi-schemas-v1.yaml -o src/clients/scapi-schemas.generated.ts && openapi-typescript specs/cdn-zones-v1.yaml -o src/clients/cdn-zones.generated.ts && openapi-typescript specs/am-users-api-v1.yaml -o src/clients/am-users-api.generated.ts && openapi-typescript specs/am-roles-api-v1.yaml -o src/clients/am-roles-api.generated.ts && openapi-typescript specs/am-apiclients-api-v1.yaml -o src/clients/am-apiclients-api.generated.ts && openapi-typescript specs/granular-replications-v1.yaml -o src/clients/granular-replications.generated.ts && openapi-typescript specs/operations-jobs-v1.yaml -o src/clients/scapi-jobs.generated.ts && openapi-typescript specs/dx-scripts-v1.yaml -o src/clients/scapi-scripts.generated.ts && openapi-typescript specs/merchant-users-v1.yaml -o src/clients/scapi-merchant-users.generated.ts && openapi-typescript specs/merchant-roles-v1.yaml -o src/clients/scapi-merchant-roles.generated.ts && openapi-typescript specs/site-sites-v1.yaml -o src/clients/scapi-sites.generated.ts && openapi-typescript specs/product-catalogs-v1.yaml -o src/clients/scapi-catalogs.generated.ts && openapi-typescript specs/preferences-v1.yaml -o src/clients/preferences.generated.ts && openapi-typescript specs/metrics-v1.json -o src/clients/metrics.generated.ts && openapi-typescript specs/storefront-deployments-v1.yaml -o src/clients/storefront-deployments.generated.ts && openapi-typescript specs/storefront-environments-v1.yaml -o src/clients/storefront-environments.generated.ts",
     "build": "pnpm run generate:types && pnpm run build:esm",
     "build:esm": "tsc -p tsconfig.esm.json",
     "clean": "shx rm -rf dist",

package/specs/dx-scripts-v1.yaml

@@ -0,0 +1,409 @@
+openapi: 3.0.3
+info:
+    title: Scripts
+    version: 1.0.0
+    x-api-type: Admin
+    x-api-family: DX
+servers:
+  -     url: "https://{shortCode}.api.commercecloud.salesforce.com/dx/scripts/v1"
+        variables:
+                shortCode:
+                          default: shortCode
+paths:
+    /organizations/{organizationId}/code-versions:
+          get:
+                  operationId: getCodeVersions
+                  parameters:
+                    -           name: organizationId
+                                in: path
+                                required: true
+                                style: simple
+                                explode: false
+                                schema:
+                                              $ref: "#/components/schemas/OrganizationId"
+                    -           name: expand
+                                in: query
+                                required: false
+                                style: form
+                                explode: false
+                                schema:
+                                              type: array
+                                              items:
+                                                              type: string
+                                                              enum: [size]
+                  responses:
+                            200:
+                                        description: List of code versions successfully retrieved.
+                                        content:
+                                                      application/json:
+                                                                      schema:
+                                                                                        $ref: "#/components/schemas/CodeVersionResult"
+                            401:
+                                        description: Your access token is invalid or expired and can’t be used to identify a user.
+                                        content:
+                                                      application/problem+json:
+                                                                      schema:
+                                                                                        $ref: "#/components/schemas/ErrorResponse"
+                            403:
+                                        description: Forbidden. Your access token is valid, but you don’t have the required permissions to access the resource.
+                                        content:
+                                                      application/problem+json:
+                                                                      schema:
+                                                                                        $ref: "#/components/schemas/ErrorResponse"
+                  security:
+                    -           AmOAuth2: [sfcc.scripts, sfcc.scripts.rw]
+    /organizations/{organizationId}/code-versions/{codeVersionId}:
+          get:
+                  operationId: getCodeVersion
+                  parameters:
+                    -           name: organizationId
+                                in: path
+                                required: true
+                                style: simple
+                                explode: false
+                                schema:
+                                              $ref: "#/components/schemas/OrganizationId"
+                    -           name: codeVersionId
+                                in: path
+                                required: true
+                                style: simple
+                                explode: false
+                                schema:
+                                              type: string
+                                              maxLength: 256
+                                              minLength: 1
+                    -           name: expand
+                                in: query
+                                required: false
+                                style: form
+                                explode: false
+                                schema:
+                                              type: array
+                                              items:
+                                                              type: string
+                                                              enum: [size]
+                  responses:
+                            200:
+                                        description: Code version successfully retrieved.
+                                        content:
+                                                      application/json:
+                                                                      schema:
+                                                                                        $ref: "#/components/schemas/CodeVersion"
+                            401:
+                                        description: Your access token is invalid or expired and can’t be used to identify a user.
+                                        content:
+                                                      application/problem+json:
+                                                                      schema:
+                                                                                        $ref: "#/components/schemas/ErrorResponse"
+                            403:
+                                        description: Forbidden. Your access token is valid, but you don’t have the required permissions to access the resource.
+                                        content:
+                                                      application/problem+json:
+                                                                      schema:
+                                                                                        $ref: "#/components/schemas/ErrorResponse"
+                            404:
+                                        description: Code version not found.
+                                        content:
+                                                      application/problem+json:
+                                                                      schema:
+                                                                                        $ref: "#/components/schemas/ErrorResponse"
+                  security:
+                    -           AmOAuth2: [sfcc.scripts, sfcc.scripts.rw]
+          put:
+                  operationId: createCodeVersion
+                  parameters:
+                    -           name: organizationId
+                                in: path
+                                required: true
+                                style: simple
+                                explode: false
+                                schema:
+                                              $ref: "#/components/schemas/OrganizationId"
+                    -           name: codeVersionId
+                                in: path
+                                required: true
+                                style: simple
+                                explode: false
+                                schema:
+                                              type: string
+                                              maxLength: 256
+                                              minLength: 1
+                  responses:
+                            200:
+                                        description: Code version successfully replaced.
+                                        content:
+                                                      application/json:
+                                                                      schema:
+                                                                                        $ref: "#/components/schemas/CodeVersion"
+                            201:
+                                        description: Code version successfully created.
+                                        content:
+                                                      application/json:
+                                                                      schema:
+                                                                                        $ref: "#/components/schemas/CodeVersion"
+                            401:
+                                        description: Your access token is invalid or expired and can’t be used to identify a user.
+                                        content:
+                                                      application/problem+json:
+                                                                      schema:
+                                                                                        $ref: "#/components/schemas/ErrorResponse"
+                            403:
+                                        description: Forbidden. Your access token is valid, but you don’t have the required permissions to access the resource.
+                                        content:
+                                                      application/problem+json:
+                                                                      schema:
+                                                                                        $ref: "#/components/schemas/ErrorResponse"
+                            409:
+                                        description: A code version with the given ID already exists.
+                                        content:
+                                                      application/problem+json:
+                                                                      schema:
+                                                                                        $ref: "#/components/schemas/ErrorResponse"
+                  security:
+                    -           AmOAuth2: [sfcc.scripts.rw]
+          delete:
+                  operationId: deleteCodeVersion
+                  parameters:
+                    -           name: organizationId
+                                in: path
+                                required: true
+                                style: simple
+                                explode: false
+                                schema:
+                                              $ref: "#/components/schemas/OrganizationId"
+                    -           name: codeVersionId
+                                in: path
+                                required: true
+                                style: simple
+                                explode: false
+                                schema:
+                                              type: string
+                                              maxLength: 256
+                                              minLength: 1
+                  responses:
+                            204:
+                                        description: Code version successfully deleted.
+                            400:
+                                        description: The active code version cannot be deleted.
+                                        content:
+                                                      application/problem+json:
+                                                                      schema:
+                                                                                        $ref: "#/components/schemas/ErrorResponse"
+                            401:
+                                        description: Your access token is invalid or expired and can’t be used to identify a user.
+                                        content:
+                                                      application/problem+json:
+                                                                      schema:
+                                                                                        $ref: "#/components/schemas/ErrorResponse"
+                            403:
+                                        description: Forbidden. Your access token is valid, but you don’t have the required permissions to access the resource.
+                                        content:
+                                                      application/problem+json:
+                                                                      schema:
+                                                                                        $ref: "#/components/schemas/ErrorResponse"
+                            404:
+                                        description: Code version not found.
+                                        content:
+                                                      application/problem+json:
+                                                                      schema:
+                                                                                        $ref: "#/components/schemas/ErrorResponse"
+                  security:
+                    -           AmOAuth2: [sfcc.scripts.rw]
+          patch:
+                  operationId: updateCodeVersion
+                  parameters:
+                    -           name: organizationId
+                                in: path
+                                required: true
+                                style: simple
+                                explode: false
+                                schema:
+                                              $ref: "#/components/schemas/OrganizationId"
+                    -           name: codeVersionId
+                                in: path
+                                required: true
+                                style: simple
+                                explode: false
+                                schema:
+                                              type: string
+                                              maxLength: 256
+                                              minLength: 1
+                  requestBody:
+                            content:
+                                        application/json:
+                                                      schema:
+                                                                      $ref: "#/components/schemas/CodeVersion"
+                            required: true
+                  responses:
+                            200:
+                                        description: Code version successfully updated.
+                                        content:
+                                                      application/json:
+                                                                      schema:
+                                                                                        $ref: "#/components/schemas/CodeVersion"
+                            400:
+                                        description: The active code version cannot be modified.
+                                        content:
+                                                      application/problem+json:
+                                                                      schema:
+                                                                                        $ref: "#/components/schemas/ErrorResponse"
+                            401:
+                                        description: Your access token is invalid or expired and can’t be used to identify a user.
+                                        content:
+                                                      application/problem+json:
+                                                                      schema:
+                                                                                        $ref: "#/components/schemas/ErrorResponse"
+                            403:
+                                        description: Forbidden. Your access token is valid, but you don’t have the required permissions to access the resource.
+                                        content:
+                                                      application/problem+json:
+                                                                      schema:
+                                                                                        $ref: "#/components/schemas/ErrorResponse"
+                            404:
+                                        description: Code version not found.
+                                        content:
+                                                      application/problem+json:
+                                                                      schema:
+                                                                                        $ref: "#/components/schemas/ErrorResponse"
+                            409:
+                                        description: A code version with the given ID already exists (when renaming).
+                                        content:
+                                                      application/problem+json:
+                                                                      schema:
+                                                                                        $ref: "#/components/schemas/ErrorResponse"
+                  security:
+                    -           AmOAuth2: [sfcc.scripts.rw]
+components:
+    schemas:
+          OrganizationId:
+                  type: string
+                  maxLength: 32
+                  minLength: 1
+          Total:
+                  type: integer
+                  format: int32
+                  default: 0
+                  minimum: 0
+          ResultBase:
+                  type: object
+                  properties:
+                            limit:
+                                        type: integer
+                                        format: int32
+                            total:
+                                        $ref: "#/components/schemas/Total"
+                  required: [limit, total]
+          CodeVersion:
+                  type: object
+                  properties:
+                            id:
+                                        type: string
+                                        maxLength: 256
+                                        minLength: 1
+                            active:
+                                        type: boolean
+                            cartridges:
+                                        type: array
+                                        items:
+                                                      type: string
+                                                      maxLength: 256
+                            compatibilityMode:
+                                        type: string
+                                        maxLength: 100
+                            activationTime:
+                                        type: string
+                                        format: date-time
+                            lastModificationTime:
+                                        type: string
+                                        format: date-time
+                            rollback:
+                                        type: boolean
+                            totalSize:
+                                        type: integer
+                                        format: int64
+                            webDavUrl:
+                                        type: string
+                                        maxLength: 4000
+          CodeVersionResult:
+                  allOf:
+                    -           $ref: "#/components/schemas/ResultBase"
+                  properties:
+                            data:
+                                        type: array
+                                        items:
+                                                      $ref: "#/components/schemas/CodeVersion"
+                                                      type: string
+          ErrorResponse:
+                  type: object
+                  additionalProperties: true
+                  properties:
+                            title:
+                                        type: string
+                                        maxLength: 256
+                            type:
+                                        type: string
+                                        maxLength: 2048
+                            detail:
+                                        type: string
+                            instance:
+                                        type: string
+                                        maxLength: 2048
+                  required: [detail, title, type]
+    responses:
+          401unauthorized:
+                  description: Your access token is invalid or expired and can’t be used to identify a user.
+                  content:
+                            application/problem+json:
+                                        schema:
+                                                      $ref: "#/components/schemas/ErrorResponse"
+          403forbidden:
+                  description: Forbidden. Your access token is valid, but you don’t have the required permissions to access the resource.
+                  content:
+                            application/problem+json:
+                                        schema:
+                                                      $ref: "#/components/schemas/ErrorResponse"
+    parameters:
+          organizationId:
+                  name: organizationId
+                  in: path
+                  required: true
+                  style: simple
+                  explode: false
+                  schema:
+                            $ref: "#/components/schemas/OrganizationId"
+          expand:
+                  name: expand
+                  in: query
+                  required: false
+                  style: form
+                  explode: false
+                  schema:
+                            type: array
+                            items:
+                                        type: string
+                                        enum: [size]
+          codeVersionId:
+                  name: codeVersionId
+                  in: path
+                  required: true
+                  style: simple
+                  explode: false
+                  schema:
+                            type: string
+                            maxLength: 256
+                            minLength: 1
+    securitySchemes:
+          AmOAuth2:
+                  type: oauth2
+                  flows:
+                            clientCredentials:
+                                        tokenUrl: "https://account.demandware.com/dwsso/oauth2/access_token"
+                                        scopes:
+                                                      sfcc.scripts: Scripts API READONLY scope
+                                                      sfcc.scripts.rw: Scripts API scope
+                            authorizationCode:
+                                        authorizationUrl: "https://account.demandware.com/dwsso/oauth2/authorize"
+                                        tokenUrl: "https://account.demandware.com/dwsso/oauth2/access_token"
+                                        scopes:
+                                                      sfcc.scripts: Scripts API READONLY scope
+                                                      sfcc.scripts.rw: Scripts API scope