bulkyard 1.0.0

package/oclif.manifest.json

@@ -0,0 +1,252 @@
+{
+  "commands": {
+    "bulkyard:extract": {
+      "aliases": [],
+      "args": {},
+      "description": "Reads a YAML config file to determine which objects to query, then uses Bulk API 2.0 to extract records and write them to a local SQLite database. Each object is stored in its own table.\n\nAlternatively, use --sobject and --query to extract a single object without a config file.",
+      "examples": [
+        "Extract data using a config file:\n<%= config.bin %> <%= command.id %> --target-org myOrg --config-file bulkyard.config.yml",
+        "Extract a single object inline:\n<%= config.bin %> <%= command.id %> --target-org myOrg --sobject Account --query \"SELECT Id, Name FROM Account\"",
+        "Extract inline with a custom database and table name:\n<%= config.bin %> <%= command.id %> --target-org myOrg -s Account -q \"SELECT Id, Name FROM Account\" -d my.db -t Account_Backup"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "flags-dir": {
+          "helpGroup": "GLOBAL",
+          "name": "flags-dir",
+          "summary": "Import flag values from a directory.",
+          "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"
+        },
+        "api-version": {
+          "description": "Override the api version used for api requests made by this command",
+          "name": "api-version",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "config-file": {
+          "char": "c",
+          "name": "config-file",
+          "summary": "Path to the YAML config file.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "sobject": {
+          "char": "s",
+          "name": "sobject",
+          "summary": "Salesforce object API name (e.g. Account, Contact).",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "query": {
+          "char": "q",
+          "dependsOn": [
+            "sobject"
+          ],
+          "name": "query",
+          "summary": "SOQL query to execute for extraction.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "database": {
+          "char": "d",
+          "exclusive": [
+            "config-file"
+          ],
+          "name": "database",
+          "summary": "Path to the SQLite database file.",
+          "default": "bulkyard.db",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "table": {
+          "char": "t",
+          "dependsOn": [
+            "sobject"
+          ],
+          "name": "table",
+          "summary": "SQLite table name override (defaults to the object name).",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": true,
+      "hiddenAliases": [],
+      "id": "bulkyard:extract",
+      "pluginAlias": "bulkyard",
+      "pluginName": "bulkyard",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Extract data from a Salesforce org into a local SQLite database using Bulk API 2.0.",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "bulkyard",
+        "extract.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "bulkyard:extract",
+        "extract:bulkyard"
+      ]
+    },
+    "bulkyard:load": {
+      "aliases": [],
+      "args": {},
+      "description": "Reads a YAML config file to determine which tables to load, then uses Bulk API 2.0 to insert, update, or upsert records from a local SQLite database into the target Salesforce org.\n\nAlternatively, use --sobject and --operation to load a single object without a config file.",
+      "examples": [
+        "Load data using a config file:\n<%= config.bin %> <%= command.id %> --target-org myOrg --config-file bulkyard.config.yml",
+        "Load a single object inline:\n<%= config.bin %> <%= command.id %> --target-org myOrg --sobject Account --operation upsert --external-id-field Id",
+        "Load inline with a custom database and table name:\n<%= config.bin %> <%= command.id %> --target-org myOrg -s Account -p insert -d my.db -t Account_Staging"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "flags-dir": {
+          "helpGroup": "GLOBAL",
+          "name": "flags-dir",
+          "summary": "Import flag values from a directory.",
+          "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"
+        },
+        "api-version": {
+          "description": "Override the api version used for api requests made by this command",
+          "name": "api-version",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "config-file": {
+          "char": "c",
+          "name": "config-file",
+          "summary": "Path to the YAML config file.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "sobject": {
+          "char": "s",
+          "name": "sobject",
+          "summary": "Salesforce object API name (e.g. Account, Contact).",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "operation": {
+          "char": "p",
+          "dependsOn": [
+            "sobject"
+          ],
+          "name": "operation",
+          "summary": "Bulk API operation: insert, update, upsert, or delete.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "insert",
+            "update",
+            "upsert",
+            "delete"
+          ],
+          "type": "option"
+        },
+        "external-id-field": {
+          "char": "e",
+          "dependsOn": [
+            "sobject"
+          ],
+          "name": "external-id-field",
+          "summary": "External ID field for upsert operations.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "database": {
+          "char": "d",
+          "exclusive": [
+            "config-file"
+          ],
+          "name": "database",
+          "summary": "Path to the SQLite database file.",
+          "default": "bulkyard.db",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "table": {
+          "char": "t",
+          "dependsOn": [
+            "sobject"
+          ],
+          "name": "table",
+          "summary": "SQLite table name override (defaults to the object name).",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": true,
+      "hiddenAliases": [],
+      "id": "bulkyard:load",
+      "pluginAlias": "bulkyard",
+      "pluginName": "bulkyard",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Load data from a local SQLite database into a Salesforce org using Bulk API 2.0.",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "bulkyard",
+        "load.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "bulkyard:load",
+        "load:bulkyard"
+      ]
+    }
+  },
+  "version": "1.0.0"
+}

package/package.json

@@ -0,0 +1,191 @@
+{
+  "name": "bulkyard",
+  "description": "A Salesforce CLI plugin for bulk data extraction and loading via local SQLite3 databases.",
+  "version": "1.0.0",
+  "dependencies": {
+    "@oclif/core": "^4",
+    "@salesforce/core": "^8",
+    "@salesforce/sf-plugins-core": "^12",
+    "better-sqlite3": "^9",
+    "js-yaml": "^4.1.1"
+  },
+  "devDependencies": {
+    "@oclif/plugin-command-snapshot": "^5.1.9",
+    "@salesforce/cli-plugins-testkit": "^5.3.10",
+    "@salesforce/dev-scripts": "^10",
+    "@types/better-sqlite3": "^7.6.13",
+    "@types/js-yaml": "^4.0.9",
+    "eslint-plugin-sf-plugin": "^1.18.6",
+    "oclif": "^4.14.0",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.4.5"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "files": [
+    "/lib",
+    "/messages",
+    "/oclif.manifest.json",
+    "/oclif.lock"
+  ],
+  "keywords": [
+    "force",
+    "salesforce",
+    "salesforcedx",
+    "sf",
+    "sf-plugin",
+    "sfdx",
+    "sfdx-plugin"
+  ],
+  "license": "BSD-3-Clause",
+  "oclif": {
+    "commands": "./lib/commands",
+    "bin": "sf",
+    "topicSeparator": " ",
+    "devPlugins": [
+      "@oclif/plugin-help"
+    ],
+    "topics": {
+      "bulkyard": {
+        "description": "Extract and load Salesforce data via local SQLite databases."
+      }
+    },
+    "flexibleTaxonomy": true
+  },
+  "scripts": {
+    "build": "wireit",
+    "clean": "sf-clean",
+    "clean-all": "sf-clean all",
+    "compile": "wireit",
+    "docs": "sf-docs",
+    "format": "wireit",
+    "link-check": "wireit",
+    "lint": "wireit",
+    "postinstall": "yarn husky install",
+    "postpack": "sf-clean --ignore-signing-artifacts",
+    "prepack": "sf-prepack",
+    "test": "wireit",
+    "test:nuts": "nyc mocha \"**/*.nut.ts\" --slow 4500 --timeout 600000 --parallel",
+    "test:only": "wireit",
+    "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:compile": {
+      "command": "tsc -p \"./test\" --pretty",
+      "files": [
+        "test/**/*.ts",
+        "**/tsconfig.json"
+      ],
+      "output": []
+    },
+    "test": {
+      "dependencies": [
+        "test:compile",
+        "test:only",
+        "lint"
+      ]
+    },
+    "test:only": {
+      "command": "nyc mocha \"test/**/*.test.ts\"",
+      "env": {
+        "FORCE_COLOR": "2"
+      },
+      "files": [
+        "test/**/*.ts",
+        "src/**/*.ts",
+        "**/tsconfig.json",
+        ".mocha*",
+        "!*.nut.ts",
+        ".nycrc"
+      ],
+      "output": []
+    },
+    "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": []
+    },
+    "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",
+  "author": "Jesse Wheeler",
+  "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
+}