@salesforce/plugin-schema 2.2.0 → 2.2.2

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"2.2.0","commands":{"sobject:describe":{"id":"sobject:describe","summary":"Display the metadata for a standard or custom object or a Tooling API object.","description":"The metadata is displayed in JSON format. See this topic for a description of each property: https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_calls_describesobjects_describesobjectresult.htm.\n\nThis command displays metadata for Salesforce objects by default. Use the --use-tooling-api flag to view metadata for a Tooling API object.","strict":true,"pluginName":"@salesforce/plugin-schema","pluginAlias":"@salesforce/plugin-schema","pluginType":"core","aliases":["force:schema:sobject:describe"],"examples":["Display the metadata of the \"Account\" standard object in your default org:\n<%= config.bin %> <%= command.id %> --sobject Account","Display the metadata of the \"MyObject__c\" custom object in the org with alias \"my-scratch-org\":\n<%= config.bin %> <%= command.id %> --sobject MyObject__c --target-org my-scratch-org","Display the metadata of the ApexCodeCoverage Tooling API object in your default org:\n<%= config.bin %> <%= command.id %> --sobject ApexCodeCoverage --use-tooling-api"],"flags":{"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"target-org":{"name":"target-org","type":"option","char":"o","summary":"Username or alias of the target org.","multiple":false,"aliases":["targetusername","u"]},"api-version":{"name":"api-version","type":"option","description":"Override the api version used for api requests made by this command","multiple":false,"aliases":["apiversion"]},"loglevel":{"name":"loglevel","type":"option","hidden":true,"multiple":false,"deprecated":{"message":"The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored."}},"sobject":{"name":"sobject","type":"option","char":"s","summary":"API name of the object to describe.","required":true,"multiple":false,"aliases":["sobjecttype"]},"use-tooling-api":{"name":"use-tooling-api","type":"boolean","char":"t","summary":"Use Tooling API to display metadata for Tooling API objects.","allowNo":false,"aliases":["usetoolingapi"]}},"args":[],"hasDynamicHelp":true},"sobject:list":{"id":"sobject:list","summary":"List all Salesforce objects of a specified category.","description":"You can list the standard objects, custom objects, or all. The lists include only Salesforce objects, not Tooling API objects.","strict":true,"pluginName":"@salesforce/plugin-schema","pluginAlias":"@salesforce/plugin-schema","pluginType":"core","aliases":["force:schema:sobject:list"],"examples":["List all objects in your default org:\n<%= config.bin %> <%= command.id %> --sobject all","List only custom objects in the org with alias \"my-scratch-org\":\n<%= config.bin %> <%= command.id %> --sobject custom --target-org my-scratch-org"],"flags":{"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"target-org":{"name":"target-org","type":"option","char":"o","summary":"Username or alias of the target org.","multiple":false,"aliases":["targetusername","u"]},"api-version":{"name":"api-version","type":"option","description":"Override the api version used for api requests made by this command","multiple":false,"aliases":["apiversion"]},"loglevel":{"name":"loglevel","type":"option","hidden":true,"multiple":false,"deprecated":{"message":"The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored."}},"sobject":{"name":"sobject","type":"option","char":"s","summary":"Category of objects to list.","multiple":false,"default":"ALL","aliases":["sobjecttypecategory","c"]}},"args":[],"hasDynamicHelp":true}}}
+{"version":"2.2.2","commands":{"sobject:describe":{"id":"sobject:describe","summary":"Display the metadata for a standard or custom object or a Tooling API object.","description":"The metadata is displayed in JSON format. See this topic for a description of each property: https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_calls_describesobjects_describesobjectresult.htm.\n\nThis command displays metadata for Salesforce objects by default. Use the --use-tooling-api flag to view metadata for a Tooling API object.","strict":true,"pluginName":"@salesforce/plugin-schema","pluginAlias":"@salesforce/plugin-schema","pluginType":"core","aliases":["force:schema:sobject:describe"],"examples":["Display the metadata of the \"Account\" standard object in your default org:\n<%= config.bin %> <%= command.id %> --sobject Account","Display the metadata of the \"MyObject__c\" custom object in the org with alias \"my-scratch-org\":\n<%= config.bin %> <%= command.id %> --sobject MyObject__c --target-org my-scratch-org","Display the metadata of the ApexCodeCoverage Tooling API object in your default org:\n<%= config.bin %> <%= command.id %> --sobject ApexCodeCoverage --use-tooling-api"],"flags":{"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"target-org":{"name":"target-org","type":"option","char":"o","summary":"Username or alias of the target org.","multiple":false,"aliases":["targetusername","u"]},"api-version":{"name":"api-version","type":"option","description":"Override the api version used for api requests made by this command","multiple":false,"aliases":["apiversion"]},"loglevel":{"name":"loglevel","type":"option","hidden":true,"multiple":false,"deprecated":{"message":"The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored."}},"sobject":{"name":"sobject","type":"option","char":"s","summary":"API name of the object to describe.","required":true,"multiple":false,"aliases":["sobjecttype"]},"use-tooling-api":{"name":"use-tooling-api","type":"boolean","char":"t","summary":"Use Tooling API to display metadata for Tooling API objects.","allowNo":false,"aliases":["usetoolingapi"]}},"args":[],"hasDynamicHelp":true},"sobject:list":{"id":"sobject:list","summary":"List all Salesforce objects of a specified category.","description":"You can list the standard objects, custom objects, or all. The lists include only Salesforce objects, not Tooling API objects.","strict":true,"pluginName":"@salesforce/plugin-schema","pluginAlias":"@salesforce/plugin-schema","pluginType":"core","aliases":["force:schema:sobject:list"],"examples":["List all objects in your default org:\n<%= config.bin %> <%= command.id %> --sobject all","List only custom objects in the org with alias \"my-scratch-org\":\n<%= config.bin %> <%= command.id %> --sobject custom --target-org my-scratch-org"],"flags":{"json":{"name":"json","type":"boolean","description":"Format output as json.","helpGroup":"GLOBAL","allowNo":false},"target-org":{"name":"target-org","type":"option","char":"o","summary":"Username or alias of the target org.","multiple":false,"aliases":["targetusername","u"]},"api-version":{"name":"api-version","type":"option","description":"Override the api version used for api requests made by this command","multiple":false,"aliases":["apiversion"]},"loglevel":{"name":"loglevel","type":"option","hidden":true,"multiple":false,"deprecated":{"message":"The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored."}},"sobject":{"name":"sobject","type":"option","char":"s","summary":"Category of objects to list.","multiple":false,"default":"ALL","aliases":["sobjecttypecategory","c"]}},"args":[],"hasDynamicHelp":true}}}

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@salesforce/plugin-schema",
     "description": "Commands to interact with salesforce sobject schemas",
-    "version": "2.2.0",
+    "version": "2.2.2",
     "author": "Salesforce",
     "main": "lib/index.js",
     "bugs": "https://github.com/forcedotcom/cli/issues",
@@ -51,7 +51,8 @@
     "files": [
         "/lib",
         "/messages",
-        "/oclif.manifest.json"
+        "/oclif.manifest.json",
+        "/schemas"
     ],
     "homepage": "https://github.com/salesforcecli/plugin-schema",
     "keywords": [
@@ -95,13 +96,14 @@
         "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",
         "test": "sf-test",
         "test:command-reference": "./bin/dev commandreference:generate --erroronwarnings",
         "test:deprecation-policy": "./bin/dev snapshot:compare",
+        "test:json-schema": "./bin/dev schema:compare",
         "test:nuts": "nyc mocha \"**/*.nut.ts\" --slow 4500 --timeout 600000 --parallel",
         "version": "oclif readme"
     },
@@ -109,7 +111,7 @@
         "access": "public"
     },
     "sfdx": {
-        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-schema/2.2.0.crt",
-        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-schema/2.2.0.sig"
+        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-schema/2.2.2.crt",
+        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-schema/2.2.2.sig"
     }
 }

package/schemas/sobject-describe.json

@@ -0,0 +1,616 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "#/definitions/DescribeSObjectResult",
+  "definitions": {
+    "DescribeSObjectResult": {
+      "type": "object",
+      "properties": {
+        "actionOverrides": {
+          "anyOf": [
+            {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/ActionOverride"
+              }
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "activateable": {
+          "type": "boolean"
+        },
+        "childRelationships": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/ChildRelationship"
+          }
+        },
+        "compactLayoutable": {
+          "type": "boolean"
+        },
+        "createable": {
+          "type": "boolean"
+        },
+        "custom": {
+          "type": "boolean"
+        },
+        "customSetting": {
+          "type": "boolean"
+        },
+        "dataTranslationEnabled": {
+          "type": ["boolean", "null"]
+        },
+        "deepCloneable": {
+          "type": "boolean"
+        },
+        "defaultImplementation": {
+          "type": ["string", "null"]
+        },
+        "deletable": {
+          "type": "boolean"
+        },
+        "deprecatedAndHidden": {
+          "type": "boolean"
+        },
+        "feedEnabled": {
+          "type": "boolean"
+        },
+        "fields": {
+          "anyOf": [
+            {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/Field"
+              }
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "hasSubtypes": {
+          "type": "boolean"
+        },
+        "idEnabled": {
+          "type": "boolean"
+        },
+        "implementedBy": {
+          "type": ["string", "null"]
+        },
+        "implementsInterfaces": {
+          "type": ["string", "null"]
+        },
+        "isInterface": {
+          "type": "boolean"
+        },
+        "isSubtype": {
+          "type": "boolean"
+        },
+        "keyPrefix": {
+          "type": ["string", "null"]
+        },
+        "label": {
+          "type": "string"
+        },
+        "labelPlural": {
+          "type": "string"
+        },
+        "layoutable": {
+          "type": "boolean"
+        },
+        "mergeable": {
+          "type": "boolean"
+        },
+        "mruEnabled": {
+          "type": "boolean"
+        },
+        "name": {
+          "type": "string"
+        },
+        "namedLayoutInfos": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/NamedLayoutInfo"
+          }
+        },
+        "networkScopeFieldName": {
+          "type": ["string", "null"]
+        },
+        "queryable": {
+          "type": "boolean"
+        },
+        "recordTypeInfos": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/RecordTypeInfo"
+          }
+        },
+        "replicateable": {
+          "type": "boolean"
+        },
+        "retrieveable": {
+          "type": "boolean"
+        },
+        "searchLayoutable": {
+          "type": ["boolean", "null"]
+        },
+        "searchable": {
+          "type": "boolean"
+        },
+        "supportedScopes": {
+          "anyOf": [
+            {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/ScopeInfo"
+              }
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "triggerable": {
+          "type": ["boolean", "null"]
+        },
+        "undeletable": {
+          "type": "boolean"
+        },
+        "updateable": {
+          "type": "boolean"
+        },
+        "urlDetail": {
+          "type": ["string", "null"]
+        },
+        "urlEdit": {
+          "type": ["string", "null"]
+        },
+        "urlNew": {
+          "type": ["string", "null"]
+        }
+      },
+      "required": [
+        "activateable",
+        "childRelationships",
+        "compactLayoutable",
+        "createable",
+        "custom",
+        "customSetting",
+        "deepCloneable",
+        "deletable",
+        "deprecatedAndHidden",
+        "feedEnabled",
+        "hasSubtypes",
+        "idEnabled",
+        "isInterface",
+        "isSubtype",
+        "label",
+        "labelPlural",
+        "layoutable",
+        "mergeable",
+        "mruEnabled",
+        "name",
+        "namedLayoutInfos",
+        "queryable",
+        "recordTypeInfos",
+        "replicateable",
+        "retrieveable",
+        "searchable",
+        "undeletable",
+        "updateable"
+      ],
+      "additionalProperties": false
+    },
+    "ActionOverride": {
+      "type": "object",
+      "properties": {
+        "formFactor": {
+          "type": "string"
+        },
+        "isAvailableInTouch": {
+          "type": "boolean"
+        },
+        "name": {
+          "type": "string"
+        },
+        "pageId": {
+          "type": "string"
+        },
+        "url": {
+          "type": ["string", "null"]
+        }
+      },
+      "required": ["formFactor", "isAvailableInTouch", "name", "pageId"],
+      "additionalProperties": false
+    },
+    "ChildRelationship": {
+      "type": "object",
+      "properties": {
+        "cascadeDelete": {
+          "type": "boolean"
+        },
+        "childSObject": {
+          "type": "string"
+        },
+        "deprecatedAndHidden": {
+          "type": "boolean"
+        },
+        "field": {
+          "type": "string"
+        },
+        "junctionIdListNames": {
+          "anyOf": [
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "junctionReferenceTo": {
+          "anyOf": [
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "relationshipName": {
+          "type": ["string", "null"]
+        },
+        "restrictedDelete": {
+          "type": ["boolean", "null"]
+        }
+      },
+      "required": ["cascadeDelete", "childSObject", "deprecatedAndHidden", "field"],
+      "additionalProperties": false
+    },
+    "Field": {
+      "type": "object",
+      "properties": {
+        "aggregatable": {
+          "type": "boolean"
+        },
+        "aiPredictionField": {
+          "type": "boolean"
+        },
+        "autoNumber": {
+          "type": "boolean"
+        },
+        "byteLength": {
+          "type": "number"
+        },
+        "calculated": {
+          "type": "boolean"
+        },
+        "calculatedFormula": {
+          "type": ["string", "null"]
+        },
+        "cascadeDelete": {
+          "type": ["boolean", "null"]
+        },
+        "caseSensitive": {
+          "type": "boolean"
+        },
+        "compoundFieldName": {
+          "type": ["string", "null"]
+        },
+        "controllerName": {
+          "type": ["string", "null"]
+        },
+        "createable": {
+          "type": "boolean"
+        },
+        "custom": {
+          "type": "boolean"
+        },
+        "dataTranslationEnabled": {
+          "type": ["boolean", "null"]
+        },
+        "defaultValue": {
+          "anyOf": [
+            {},
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "defaultValueFormula": {
+          "type": ["string", "null"]
+        },
+        "defaultedOnCreate": {
+          "type": "boolean"
+        },
+        "dependentPicklist": {
+          "type": ["boolean", "null"]
+        },
+        "deprecatedAndHidden": {
+          "type": "boolean"
+        },
+        "digits": {
+          "type": "number"
+        },
+        "displayLocationInDecimal": {
+          "type": ["boolean", "null"]
+        },
+        "encrypted": {
+          "type": ["boolean", "null"]
+        },
+        "externalId": {
+          "type": ["boolean", "null"]
+        },
+        "extraTypeInfo": {
+          "type": ["string", "null"]
+        },
+        "filterable": {
+          "type": "boolean"
+        },
+        "filteredLookupInfo": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/FilteredLookupInfo"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "formulaTreatNullNumberAsZero": {
+          "type": ["boolean", "null"]
+        },
+        "groupable": {
+          "type": "boolean"
+        },
+        "highScaleNumber": {
+          "type": ["boolean", "null"]
+        },
+        "htmlFormatted": {
+          "type": ["boolean", "null"]
+        },
+        "idLookup": {
+          "type": "boolean"
+        },
+        "inlineHelpText": {
+          "type": ["string", "null"]
+        },
+        "label": {
+          "type": "string"
+        },
+        "length": {
+          "type": "number"
+        },
+        "mask": {
+          "type": ["string", "null"]
+        },
+        "maskType": {
+          "type": ["string", "null"]
+        },
+        "name": {
+          "type": "string"
+        },
+        "nameField": {
+          "type": "boolean"
+        },
+        "namePointing": {
+          "type": ["boolean", "null"]
+        },
+        "nillable": {
+          "type": "boolean"
+        },
+        "permissionable": {
+          "type": "boolean"
+        },
+        "picklistValues": {
+          "anyOf": [
+            {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/PicklistEntry"
+              }
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "polymorphicForeignKey": {
+          "type": "boolean"
+        },
+        "precision": {
+          "type": "number"
+        },
+        "queryByDistance": {
+          "type": "boolean"
+        },
+        "referenceTargetField": {
+          "type": ["string", "null"]
+        },
+        "referenceTo": {
+          "anyOf": [
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "relationshipName": {
+          "type": ["string", "null"]
+        },
+        "relationshipOrder": {
+          "type": ["number", "null"]
+        },
+        "restrictedDelete": {
+          "type": ["boolean", "null"]
+        },
+        "restrictedPicklist": {
+          "type": "boolean"
+        },
+        "scale": {
+          "type": "number"
+        },
+        "searchPrefilterable": {
+          "type": "boolean"
+        },
+        "soapType": {
+          "type": "string"
+        },
+        "sortable": {
+          "type": ["boolean", "null"]
+        },
+        "type": {
+          "type": "string"
+        },
+        "unique": {
+          "type": "boolean"
+        },
+        "updateable": {
+          "type": "boolean"
+        },
+        "writeRequiresMasterRead": {
+          "type": ["boolean", "null"]
+        }
+      },
+      "required": [
+        "aggregatable",
+        "aiPredictionField",
+        "autoNumber",
+        "byteLength",
+        "calculated",
+        "caseSensitive",
+        "createable",
+        "custom",
+        "defaultedOnCreate",
+        "deprecatedAndHidden",
+        "digits",
+        "filterable",
+        "groupable",
+        "idLookup",
+        "label",
+        "length",
+        "name",
+        "nameField",
+        "nillable",
+        "permissionable",
+        "polymorphicForeignKey",
+        "precision",
+        "queryByDistance",
+        "restrictedPicklist",
+        "scale",
+        "searchPrefilterable",
+        "soapType",
+        "type",
+        "unique",
+        "updateable"
+      ],
+      "additionalProperties": false
+    },
+    "FilteredLookupInfo": {
+      "type": "object",
+      "properties": {
+        "controllingFields": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "dependent": {
+          "type": "boolean"
+        },
+        "optionalFilter": {
+          "type": "boolean"
+        }
+      },
+      "required": ["controllingFields", "dependent", "optionalFilter"],
+      "additionalProperties": false
+    },
+    "PicklistEntry": {
+      "type": "object",
+      "properties": {
+        "active": {
+          "type": "boolean"
+        },
+        "defaultValue": {
+          "type": "boolean"
+        },
+        "label": {
+          "type": ["string", "null"]
+        },
+        "validFor": {
+          "type": ["string", "null"]
+        },
+        "value": {
+          "type": "string"
+        }
+      },
+      "required": ["active", "defaultValue", "value"],
+      "additionalProperties": false
+    },
+    "NamedLayoutInfo": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string"
+        }
+      },
+      "required": ["name"],
+      "additionalProperties": false
+    },
+    "RecordTypeInfo": {
+      "type": "object",
+      "properties": {
+        "active": {
+          "type": "boolean"
+        },
+        "available": {
+          "type": "boolean"
+        },
+        "defaultRecordTypeMapping": {
+          "type": "boolean"
+        },
+        "developerName": {
+          "type": "string"
+        },
+        "master": {
+          "type": "boolean"
+        },
+        "name": {
+          "type": "string"
+        },
+        "recordTypeId": {
+          "type": ["string", "null"]
+        }
+      },
+      "required": ["active", "available", "defaultRecordTypeMapping", "developerName", "master", "name"],
+      "additionalProperties": false
+    },
+    "ScopeInfo": {
+      "type": "object",
+      "properties": {
+        "label": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string"
+        }
+      },
+      "required": ["label", "name"],
+      "additionalProperties": false
+    }
+  }
+}

package/schemas/sobject-list.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "#/definitions/SObjectListResult",
+  "definitions": {
+    "SObjectListResult": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    }
+  }
+}