@salesforce/plugin-packaging 1.12.3 → 1.12.4

package/package.json

@@ -1,48 +1,49 @@
 {
     "name": "@salesforce/plugin-packaging",
     "description": "SFDX plugin that support Salesforce Packaging Platform",
-    "version": "1.12.3",
+    "version": "1.12.4",
     "main": "lib/index.js",
     "author": "Salesforce",
     "bugs": "https://github.com/forcedotcom/cli/issues",
     "dependencies": {
-        "@oclif/core": "^1.22.0",
-        "@salesforce/command": "^5.2.33",
-        "@salesforce/core": "^3.32.11",
-        "@salesforce/kit": "^1.8.2",
+        "@oclif/core": "^1.25.0",
+        "@salesforce/core": "^3.33.0",
+        "@salesforce/kit": "^1.8.3",
         "@salesforce/packaging": "^1.1.11",
+        "@salesforce/sf-plugins-core": "^1.22.1",
         "chalk": "^4.1.2",
         "tslib": "^2"
     },
     "devDependencies": {
-        "@oclif/plugin-command-snapshot": "^3.2.11",
-        "@oclif/plugin-version": "^1.1.2",
-        "@salesforce/cli-plugins-testkit": "^3.2.17",
+        "@oclif/plugin-command-snapshot": "^3.2.18",
+        "@oclif/plugin-version": "^1.2.0",
+        "@salesforce/cli-plugins-testkit": "^3.2.18",
         "@salesforce/dev-config": "^3.1.0",
-        "@salesforce/dev-scripts": "^3.1.0",
-        "@salesforce/plugin-auth": "^2.3.7",
-        "@salesforce/plugin-command-reference": "^1.5.6",
-        "@salesforce/plugin-config": "^1.4.22",
+        "@salesforce/dev-scripts": "^3.1.1",
+        "@salesforce/plugin-auth": "^2.3.12",
+        "@salesforce/plugin-command-reference": "^2.2.9",
+        "@salesforce/plugin-config": "^1.4.23",
         "@salesforce/prettier-config": "^0.0.2",
-        "@salesforce/ts-sinon": "1.4.2",
+        "@salesforce/ts-sinon": "1.4.4",
         "@salesforce/ts-types": "^1.5.20",
-        "@swc/core": "^1.3.24",
-        "@typescript-eslint/eslint-plugin": "^5.33.0",
-        "@typescript-eslint/parser": "^5.33.0",
+        "@swc/core": "^1.3.27",
+        "@typescript-eslint/eslint-plugin": "^5.48.2",
+        "@typescript-eslint/parser": "^5.48.2",
         "chai": "^4.3.7",
-        "eslint": "^8.31.0",
+        "eslint": "^8.32.0",
         "eslint-config-prettier": "^8.6.0",
         "eslint-config-salesforce": "^1.1.0",
-        "eslint-config-salesforce-license": "^0.1.6",
+        "eslint-config-salesforce-license": "^0.2.0",
         "eslint-config-salesforce-typescript": "^1.1.1",
         "eslint-plugin-header": "^3.1.1",
-        "eslint-plugin-import": "^2.26.0",
-        "eslint-plugin-jsdoc": "^39.6.4",
+        "eslint-plugin-import": "^2.27.5",
+        "eslint-plugin-jsdoc": "^39.6.7",
+        "eslint-plugin-sf-plugin": "^1.6.3",
         "husky": "^7.0.4",
         "mocha": "^9.1.3",
         "nyc": "^15.1.0",
-        "oclif": "^3.4.3",
-        "prettier": "^2.8.1",
+        "oclif": "^3.6.0",
+        "prettier": "^2.8.3",
         "pretty-quick": "^3.1.3",
         "shx": "0.3.4",
         "sinon": "^11.1.2",
@@ -56,7 +57,8 @@
     "files": [
         "/lib",
         "/messages",
-        "/oclif.manifest.json"
+        "/oclif.manifest.json",
+        "/schemas"
     ],
     "homepage": "https://github.com/salesforcecli/plugin-packaging",
     "keywords": [
@@ -85,64 +87,46 @@
         ],
         "plugins": [],
         "topics": {
-            "force": {
-                "description": "tools for the Salesforce developer",
-                "longDescription": "Commands to develop on the Salesforce Platform.",
+            "package1": {
+                "description": "Commands to develop first-generation managed and unmanaged packages.",
                 "trailblazerCommunityLink": {
-                    "url": "https://success.salesforce.com/_ui/core/chatter/groups/GroupProfilePage?g=0F93A000000HTp1",
-                    "name": "Salesforce DX"
+                    "url": "https://success.salesforce.com/_ui/core/chatter/groups/GroupProfilePage?g=0F93A000000Lg5U",
+                    "name": "Unlocked Packages and Managed 2GPs"
                 },
                 "subtopics": {
-                    "package1": {
-                        "description": "develop first-generation managed and unmanaged packages",
-                        "longDescription": "Use the package1 commands to create and view first-generation package versions in your Dev Hub org.",
+                    "version": {
+                        "description": "Commands to manage first-generation package versions.",
                         "subtopics": {
-                            "version": {
-                                "description": "first-generation manage package versions",
-                                "longDescription": "Use the package version commands to first-generation manage package versions.",
-                                "subtopics": {
-                                    "create": {
-                                        "description": "create package versions",
-                                        "longDescription": "Use the package version list command to list package versions."
-                                    },
-                                    "display": {
-                                        "description": "display package versions",
-                                        "longDescription": "Use the package version list command to list package versions."
-                                    },
-                                    "list": {
-                                        "description": "list package versions"
-                                    }
-                                }
+                            "create": {
+                                "description": "Command to get package creation requests."
                             }
                         }
-                    },
-                    "package": {
-                        "description": "develop and install packages",
-                        "longDescription": "Use the package commands to develop and install packages.",
-                        "trailblazerCommunityLink": {
-                            "url": "https://success.salesforce.com/_ui/core/chatter/groups/GroupProfilePage?g=0F93A000000Lg5U",
-                            "name": "Unlocked Packages and Managed 2GPs"
-                        },
+                    }
+                }
+            },
+            "package": {
+                "description": "Commands to develop and install unlocked packages and managed 2GP packages.",
+                "trailblazerCommunityLink": {
+                    "url": "https://success.salesforce.com/_ui/core/chatter/groups/GroupProfilePage?g=0F93A000000Lg5U",
+                    "name": "Unlocked Packages and Managed 2GPs"
+                },
+                "subtopics": {
+                    "version": {
+                        "description": "Commands to manage package versions.",
                         "subtopics": {
-                            "version": {
-                                "description": "manage package versions",
-                                "longDescription": "Use the package version commands to manage package versions.",
-                                "subtopics": {
-                                    "create": {
-                                        "description": "create package versions",
-                                        "longDescription": "Use the package version list command to list package versions."
-                                    }
-                                }
-                            },
-                            "uninstall": {
-                                "description": "uninstall packages",
-                                "longDescription": "Use the package uninstall commands to uninstall packages."
-                            },
-                            "install": {
-                                "description": "install packages",
-                                "longDescription": "Use the package install commands to install packages."
+                            "create": {
+                                "description": "Commands to list and report package creation requests."
                             }
                         }
+                    },
+                    "install": {
+                        "description": "Command to report on installed packages."
+                    },
+                    "uninstall": {
+                        "description": "Command to report on uninstalled packages."
+                    },
+                    "installed": {
+                        "description": "Command to list installed packages."
                     }
                 }
             }
@@ -158,7 +142,7 @@
         "format": "sf-format",
         "lint": "sf-lint",
         "postpack": "shx rm -f oclif.manifest.json",
-        "posttest": "yarn lint && yarn test:deprecation-policy && yarn test:command-reference",
+        "posttest": "yarn lint && yarn test:deprecation-policy && yarn test:json-schema && yarn test:command-reference",
         "prepack": "sf-prepack",
         "prepare": "sf-install",
         "pretest": "sf-compile-test",
@@ -167,13 +151,14 @@
         "test:deprecation-policy": "./bin/dev snapshot:compare",
         "test:nuts": "nyc mocha \"**/*.nut.ts\" --slow 4500 --timeout 1800000 --parallel",
         "test:nuts:package1": "nyc mocha \"**/package1/*.nut.ts\" --slow 4500 --timeout 600000 --parallel",
+        "test:json-schema": "./bin/dev schema:compare",
         "version": "oclif readme"
     },
     "publishConfig": {
         "access": "public"
     },
     "sfdx": {
-        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-packaging/1.12.3.crt",
-        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-packaging/1.12.3.sig"
+        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-packaging/1.12.4.crt",
+        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-packaging/1.12.4.sig"
     }
 }

package/schemas/package-convert.json

@@ -0,0 +1,73 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "#/definitions/PackageVersionCreateRequestResult",
+  "definitions": {
+    "PackageVersionCreateRequestResult": {
+      "type": "object",
+      "properties": {
+        "Id": {
+          "type": "string"
+        },
+        "Status": {
+          "$ref": "#/definitions/PackagingSObjects.Package2VersionStatus"
+        },
+        "Package2Id": {
+          "type": "string"
+        },
+        "Package2VersionId": {
+          "type": "string"
+        },
+        "SubscriberPackageVersionId": {
+          "type": ["string", "null"]
+        },
+        "Tag": {
+          "type": "string"
+        },
+        "Branch": {
+          "type": "string"
+        },
+        "Error": {
+          "type": "array",
+          "items": {}
+        },
+        "CreatedDate": {
+          "type": "string"
+        },
+        "HasMetadataRemoved": {
+          "type": ["boolean", "null"]
+        },
+        "CreatedBy": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "Id",
+        "Status",
+        "Package2Id",
+        "Package2VersionId",
+        "SubscriberPackageVersionId",
+        "Tag",
+        "Branch",
+        "Error",
+        "CreatedDate",
+        "HasMetadataRemoved",
+        "CreatedBy"
+      ],
+      "additionalProperties": false
+    },
+    "PackagingSObjects.Package2VersionStatus": {
+      "type": "string",
+      "enum": [
+        "Queued",
+        "InProgress",
+        "Success",
+        "Error",
+        "Initializing",
+        "VerifyingFeaturesAndSettings",
+        "VerifyingDependencies",
+        "VerifyingMetadata",
+        "FinalizingPackageVersion"
+      ]
+    }
+  }
+}

package/schemas/package-create.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "#/definitions/PackageCreate",
+  "definitions": {
+    "PackageCreate": {
+      "type": "object",
+      "properties": {
+        "Id": {
+          "type": "string"
+        }
+      },
+      "required": ["Id"],
+      "additionalProperties": false
+    }
+  }
+}

package/schemas/package-delete.json

@@ -0,0 +1,72 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "#/definitions/PackageSaveResult",
+  "definitions": {
+    "PackageSaveResult": {
+      "$ref": "#/definitions/SaveResult"
+    },
+    "SaveResult": {
+      "anyOf": [
+        {
+          "type": "object",
+          "properties": {
+            "success": {
+              "type": "boolean",
+              "const": true
+            },
+            "id": {
+              "type": "string"
+            },
+            "errors": {
+              "type": "array",
+              "items": {
+                "not": {}
+              }
+            }
+          },
+          "required": ["success", "id", "errors"],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "success": {
+              "type": "boolean",
+              "const": false
+            },
+            "id": {
+              "not": {}
+            },
+            "errors": {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/SaveError"
+              }
+            }
+          },
+          "required": ["success", "errors"],
+          "additionalProperties": false
+        }
+      ]
+    },
+    "SaveError": {
+      "type": "object",
+      "properties": {
+        "errorCode": {
+          "type": "string"
+        },
+        "message": {
+          "type": "string"
+        },
+        "fields": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "required": ["errorCode", "message"],
+      "additionalProperties": false
+    }
+  }
+}

package/schemas/package-install-report.json

@@ -0,0 +1,169 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "#/definitions/PackageInstallRequest",
+  "definitions": {
+    "PackageInstallRequest": {
+      "$ref": "#/definitions/PackagingSObjects.PackageInstallRequest"
+    },
+    "PackagingSObjects.PackageInstallRequest": {
+      "type": "object",
+      "properties": {
+        "attributes": {
+          "$ref": "#/definitions/PackagingSObjects.Attributes"
+        },
+        "Id": {
+          "type": "string"
+        },
+        "IsDeleted": {
+          "type": "boolean"
+        },
+        "CreatedDate": {
+          "type": "string"
+        },
+        "CreatedById": {
+          "type": "string"
+        },
+        "LastModifiedDate": {
+          "type": "string"
+        },
+        "LastModifiedById": {
+          "type": "string"
+        },
+        "SystemModstamp": {
+          "type": "string"
+        },
+        "SubscriberPackageVersionKey": {
+          "type": "string"
+        },
+        "NameConflictResolution": {
+          "type": "string",
+          "enum": ["Block", "RenameMetadata"]
+        },
+        "SecurityType": {
+          "type": "string",
+          "enum": ["Custom", "Full", "None"]
+        },
+        "PackageInstallSource": {
+          "type": "string"
+        },
+        "ProfileMappings": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/PackagingSObjects.SubscriberPackageProfileMappings"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "Password": {
+          "type": ["string", "null"]
+        },
+        "EnableRss": {
+          "type": "boolean"
+        },
+        "UpgradeType": {
+          "type": ["string", "null"],
+          "enum": ["delete-only", "deprecate-only", "mixed-mode", null]
+        },
+        "ApexCompileType": {
+          "type": ["string", "null"],
+          "enum": ["all", "package", null]
+        },
+        "Status": {
+          "type": "string",
+          "enum": ["ERROR", "IN_PROGRESS", "SUCCESS", "UNKNOWN"]
+        },
+        "Errors": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/PackagingSObjects.SubscriberPackageInstallErrors"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        }
+      },
+      "required": [
+        "attributes",
+        "Id",
+        "IsDeleted",
+        "CreatedDate",
+        "CreatedById",
+        "LastModifiedDate",
+        "LastModifiedById",
+        "SystemModstamp",
+        "SubscriberPackageVersionKey",
+        "NameConflictResolution",
+        "SecurityType",
+        "PackageInstallSource",
+        "EnableRss",
+        "Status"
+      ],
+      "additionalProperties": false
+    },
+    "PackagingSObjects.Attributes": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "type": "string"
+        },
+        "url": {
+          "type": "string"
+        }
+      },
+      "required": ["type", "url"],
+      "additionalProperties": false
+    },
+    "PackagingSObjects.SubscriberPackageProfileMappings": {
+      "type": "object",
+      "properties": {
+        "profileMappings": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/PackagingSObjects.SubscriberPackageProfileMapping"
+          }
+        }
+      },
+      "required": ["profileMappings"],
+      "additionalProperties": false
+    },
+    "PackagingSObjects.SubscriberPackageProfileMapping": {
+      "type": "object",
+      "properties": {
+        "source": {
+          "type": "string"
+        },
+        "target": {
+          "type": "string"
+        }
+      },
+      "required": ["source", "target"],
+      "additionalProperties": false
+    },
+    "PackagingSObjects.SubscriberPackageInstallErrors": {
+      "type": "object",
+      "properties": {
+        "errors": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/PackagingSObjects.SubscriberPackageInstallError"
+          }
+        }
+      },
+      "required": ["errors"],
+      "additionalProperties": false
+    },
+    "PackagingSObjects.SubscriberPackageInstallError": {
+      "type": "object",
+      "properties": {
+        "message": {
+          "type": "string"
+        }
+      },
+      "required": ["message"],
+      "additionalProperties": false
+    }
+  }
+}