@simplysf/simply-data 1.0.0

package/oclif.manifest.json

@@ -0,0 +1,207 @@
+{
+  "commands": {
+    "simply:data:file:upload": {
+      "aliases": [],
+      "args": {},
+      "description": "Uploads a file to a Salesforce org.",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> --file-path fileToUpload.txt --target-org myTargetOrg",
+        "<%= config.bin %> <%= command.id %> --file-path fileToUpload.txt --first-publish-location-id 0019000000DmehK --target-org myTargetOrg"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "api-version": {
+          "description": "Override the api version used for api requests made by this command",
+          "name": "api-version",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "file-path": {
+          "name": "file-path",
+          "required": true,
+          "summary": "Path to the file to upload.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "first-publish-location-id": {
+          "name": "first-publish-location-id",
+          "summary": "Specify a record Id that the file should be linked to.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "target-org": {
+          "char": "o",
+          "name": "target-org",
+          "noCacheDefault": true,
+          "required": true,
+          "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
+          "hasDynamicHelp": true,
+          "multiple": false,
+          "type": "option"
+        },
+        "title": {
+          "name": "title",
+          "summary": "Specify the title for the file being uploaded.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": true,
+      "hiddenAliases": [],
+      "id": "simply:data:file:upload",
+      "pluginAlias": "@simplysf/simply-data",
+      "pluginName": "@simplysf/simply-data",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Upload a file to a Salesforce org.",
+      "enableJsonFlag": true,
+      "SF_ENV": "SF_ENV",
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "simply",
+        "data",
+        "file",
+        "upload.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "simply:data:file:upload",
+        "data:simply:file:upload",
+        "data:file:simply:upload",
+        "data:file:upload:simply",
+        "simply:file:data:upload",
+        "file:simply:data:upload",
+        "file:data:simply:upload",
+        "file:data:upload:simply",
+        "simply:file:upload:data",
+        "file:simply:upload:data",
+        "file:upload:simply:data",
+        "file:upload:data:simply",
+        "simply:data:upload:file",
+        "data:simply:upload:file",
+        "data:upload:simply:file",
+        "data:upload:file:simply",
+        "simply:upload:data:file",
+        "upload:simply:data:file",
+        "upload:data:simply:file",
+        "upload:data:file:simply",
+        "simply:upload:file:data",
+        "upload:simply:file:data",
+        "upload:file:simply:data",
+        "upload:file:data:simply"
+      ]
+    },
+    "simply:data:files:upload": {
+      "aliases": [],
+      "args": {},
+      "description": "Uploads files specified by a csv to a Salesforce org. By default, the plugin uses the REST API for the upload as the Bulk API is limited in its payload size. This means that each file will use one REST API request.",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> --file-path filesToUpload.csv --target-org myTargetOrg",
+        "<%= config.bin %> <%= command.id %> --file-path filesToUpload.csv --max-parallel-jobs 5 --target-org myTargetOrg"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "api-version": {
+          "description": "Override the api version used for api requests made by this command",
+          "name": "api-version",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "file-path": {
+          "description": "The csv file must specify the columns PathOnClient and Title. Optionally, a FirstPublishLocationId can be specified to have it linked directly to a Salesforce record after upload.",
+          "name": "file-path",
+          "required": true,
+          "summary": "Path to the csv file that specifies the upload.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "max-parallel-jobs": {
+          "description": "By default the plugin will only process a single file upload at a time. You can increase this value to allow for quasi concurrent uploads. Please note that setting this value too high can cause performance issues.",
+          "name": "max-parallel-jobs",
+          "summary": "Maximum number of parallel jobs.",
+          "default": 1,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "target-org": {
+          "char": "o",
+          "name": "target-org",
+          "noCacheDefault": true,
+          "required": true,
+          "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
+          "hasDynamicHelp": true,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": true,
+      "hiddenAliases": [],
+      "id": "simply:data:files:upload",
+      "pluginAlias": "@simplysf/simply-data",
+      "pluginName": "@simplysf/simply-data",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Upload files to a Salesforce org.",
+      "enableJsonFlag": true,
+      "SF_ENV": "SF_ENV",
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "simply",
+        "data",
+        "files",
+        "upload.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "simply:data:files:upload",
+        "data:simply:files:upload",
+        "data:files:simply:upload",
+        "data:files:upload:simply",
+        "simply:files:data:upload",
+        "files:simply:data:upload",
+        "files:data:simply:upload",
+        "files:data:upload:simply",
+        "simply:files:upload:data",
+        "files:simply:upload:data",
+        "files:upload:simply:data",
+        "files:upload:data:simply",
+        "simply:data:upload:files",
+        "data:simply:upload:files",
+        "data:upload:simply:files",
+        "data:upload:files:simply",
+        "simply:upload:data:files",
+        "upload:simply:data:files",
+        "upload:data:simply:files",
+        "upload:data:files:simply",
+        "simply:upload:files:data",
+        "upload:simply:files:data",
+        "upload:files:simply:data",
+        "upload:files:data:simply"
+      ]
+    }
+  },
+  "version": "1.0.0"
+}

package/package.json

@@ -0,0 +1,219 @@
+{
+  "name": "@simplysf/simply-data",
+  "description": "Utilities for working with data",
+  "version": "1.0.0",
+  "author": "@ClayChipps",
+  "bugs": "https://github.com/SimplySF/simply-data/issues",
+  "dependencies": {
+    "@oclif/core": "^3.19.2",
+    "@salesforce/core": "^6.5.3",
+    "@salesforce/kit": "^3.0.15",
+    "@salesforce/sf-plugins-core": "^5.0.13",
+    "csv-parse": "^5.5.3",
+    "csv-writer": "^1.6.0",
+    "form-data": "^4.0.0",
+    "got": "13.0.0",
+    "p-queue": "^8.0.1"
+  },
+  "devDependencies": {
+    "@oclif/plugin-command-snapshot": "^5.0.8",
+    "@salesforce/cli-plugins-testkit": "^5.1.9",
+    "@salesforce/plugin-command-reference": "^3.0.68",
+    "@salesforce/ts-sinon": "1.4.19",
+    "@simplysf/dev-scripts": "^2.0.0",
+    "@types/shelljs": "^0.8.14",
+    "eslint-plugin-sf-plugin": "^1.17.3",
+    "oclif": "^4.4.17",
+    "shelljs": "^0.8.5",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.3.3"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "files": [
+    "/lib",
+    "/messages",
+    "/npm-shrinkwrap.json",
+    "/oclif.lock",
+    "/oclif.manifest.json"
+  ],
+  "homepage": "https://github.com/SimplySF/simply-data",
+  "keywords": [
+    "force",
+    "salesforce",
+    "sfdx",
+    "salesforcedx",
+    "sfdx-plugin",
+    "sf-plugin",
+    "sf"
+  ],
+  "license": "BSD-3-Clause",
+  "oclif": {
+    "bin": "sf",
+    "commands": "./lib/commands",
+    "devPlugins": [
+      "@oclif/plugin-command-snapshot",
+      "@oclif/plugin-help",
+      "@salesforce/plugin-command-reference"
+    ],
+    "flexibleTaxonomy": true,
+    "plugins": [],
+    "repositoryPrefix": "<%- repo %>/blob/<%- version %>/<%- commandPath %>",
+    "topics": {
+      "simply": {
+        "description": "Commands for simplifying Salesforce",
+        "subtopics": {
+          "data": {
+            "description": "Commands for working with data",
+            "subtopics": {
+              "files": {
+                "description": "Commands for working with files"
+              }
+            }
+          }
+        }
+      }
+    },
+    "topicSeparator": " "
+  },
+  "repository": "SimplySF/simply-data",
+  "scripts": {
+    "build": "wireit",
+    "clean": "sf-clean",
+    "clean-all": "sf-clean all",
+    "compile": "wireit",
+    "docs": "sf-docs",
+    "format": "wireit",
+    "link-check": "wireit",
+    "lint": "wireit",
+    "postpack": "sf-clean",
+    "prepack": "sf-prepack",
+    "prepare": "sf-install",
+    "test": "wireit",
+    "test:nuts": "nyc mocha \"**/*.nut.ts\" --slow 4500 --timeout 1200000 --parallel --jobs 5",
+    "test:only": "wireit",
+    "test:watch": "mocha --watch \"./test/**/*.test.ts\"",
+    "version": "oclif readme"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "wireit": {
+    "build": {
+      "dependencies": [
+        "compile",
+        "lint"
+      ]
+    },
+    "compile": {
+      "command": "tsc -p . --pretty --incremental",
+      "files": [
+        "src/**/*.ts",
+        "**/tsconfig.json",
+        "messages/**"
+      ],
+      "output": [
+        "lib/**",
+        "*.tsbuildinfo"
+      ],
+      "clean": "if-file-deleted"
+    },
+    "format": {
+      "command": "prettier --write \"+(src|test|schemas)/**/*.+(ts|js|json)|command-snapshot.json\"",
+      "files": [
+        "src/**/*.ts",
+        "test/**/*.ts",
+        "schemas/**/*.json",
+        "command-snapshot.json",
+        ".prettier*"
+      ],
+      "output": []
+    },
+    "lint": {
+      "command": "eslint src test --color --cache --cache-location .eslintcache",
+      "files": [
+        "src/**/*.ts",
+        "test/**/*.ts",
+        "messages/**",
+        "**/.eslint*",
+        "**/tsconfig.json"
+      ],
+      "output": []
+    },
+    "test": {
+      "dependencies": [
+        "test:compile",
+        "test:only",
+        "test:command-reference",
+        "test:deprecation-policy",
+        "lint",
+        "test:json-schema",
+        "link-check"
+      ]
+    },
+    "test:command-reference": {
+      "command": "node --loader ts-node/esm --no-warnings=ExperimentalWarning \"./bin/dev.js\" commandreference:generate --erroronwarnings",
+      "files": [
+        "src/**/*.ts",
+        "messages/**",
+        "package.json"
+      ],
+      "output": [
+        "tmp/root"
+      ]
+    },
+    "test:deprecation-policy": {
+      "command": "node --loader ts-node/esm --no-warnings=ExperimentalWarning \"./bin/dev.js\" snapshot:compare",
+      "files": [
+        "src/**/*.ts"
+      ],
+      "output": [],
+      "dependencies": [
+        "compile"
+      ]
+    },
+    "test:json-schema": {
+      "command": "node --loader ts-node/esm --no-warnings=ExperimentalWarning \"./bin/dev.js\" schema:compare",
+      "files": [
+        "src/**/*.ts",
+        "schemas"
+      ],
+      "output": []
+    },
+    "test:compile": {
+      "command": "tsc -p \"./test\" --pretty",
+      "files": [
+        "test/**/*.ts",
+        "**/tsconfig.json"
+      ],
+      "output": []
+    },
+    "test:only": {
+      "command": "nyc mocha \"test/**/*.test.ts\"",
+      "env": {
+        "FORCE_COLOR": "2"
+      },
+      "files": [
+        "test/**/*.ts",
+        "src/**/*.ts",
+        "**/tsconfig.json",
+        ".mocha*",
+        "!*.nut.ts",
+        ".nycrc"
+      ],
+      "output": []
+    },
+    "link-check": {
+      "command": "node -e \"process.exit(process.env.CI ? 0 : 1)\" || linkinator \"**/*.md\" --skip \"CHANGELOG.md|node_modules|test/|confluence.internal.salesforce.com|my.salesforce.com|%s\" --markdown --retry --directory-listing --verbosity error",
+      "files": [
+        "./*.md",
+        "./!(CHANGELOG).md",
+        "messages/**/*.md"
+      ],
+      "output": []
+    }
+  },
+  "exports": "./lib/index.js",
+  "type": "module"
+}