@cerios/salesforce-sobjectly 0.0.0-stage → 1.0.0

package/LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright © 2026 Cerios
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,3 +1,232 @@
-# Temporary Holding Version
+# @cerios/salesforce-sobjectly
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+A type-safe Salesforce REST API client for TypeScript. It generates types for your org's sObjects and gives you a typed SOQL builder, CRUD, composite requests, sObject collections, SOSL, invocable actions and Flows, the Tooling API and Bulk API 2.0. Requests go through native `fetch` by default, and any other HTTP client can be plugged in.
+
+[![npm version](https://img.shields.io/npm/v/@cerios/salesforce-sobjectly.svg)](https://www.npmjs.com/package/@cerios/salesforce-sobjectly)
+[![npm downloads](https://img.shields.io/npm/dm/@cerios/salesforce-sobjectly.svg)](https://www.npmjs.com/package/@cerios/salesforce-sobjectly)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.4+-blue.svg)](https://www.typescriptlang.org/)
+
+## ✨ Key Features
+
+- **Generated sObject types**: `sobjectly generate` reads describe metadata and writes a read type, a create input and an update input for every sObject. Required fields, restricted picklists and relationships all come from your org.
+- **Typed SOQL builder**: field names are checked and autocompleted. The query result only contains the fields you selected, so `record.Phone` is a compile error unless you selected `Phone`.
+- **Relationship queries**: `selectRelated("Account", "Name")` and `selectChild("Contacts", c => c.select("Email"))` produce typed nested results.
+- **The whole REST API**: sObject CRUD, upsert by external id, query and queryAll with pagination, SOSL, Composite, Composite Graph, sObject Tree, sObject Collections, invocable actions and Flows, the Tooling API, Apex REST and Bulk API 2.0. Anything else is reachable through `request<T>()`.
+- **Platform APIs**: platform events, approvals, quick actions, UI API, files, reports, query plans and Apex debug-log capture.
+- **CI-friendly codegen**: `sobjectly generate --check` fails when the generated file is out of date and ignores formatting-only differences.
+- **Bring your own HTTP client**: `fetch` is the default; any other client (axios, undici, Playwright's `APIRequestContext`, a logging wrapper) fits a one-method interface.
+- **Built-in auth**: Salesforce CLI login (`sfCli`), static access token, client credentials, JWT bearer, refresh token or your own provider. Tokens are cached, and the client re-authenticates once on a 401.
+- **Safe by default**: values are escaped in SOQL, absolute URLs are limited to your instance's origin, tokens are never logged, and retries are opt-in. Mutations are only retried when you ask for it, e.g. on `UNABLE_TO_LOCK_ROW`, where Salesforce rolled the request back.
+- **Small footprint**: dual ESM/CJS builds. The only runtime dependency is `jiti`, which the codegen CLI uses to load TypeScript configs; the client never loads it.
+
+## 📦 Installation
+
+```bash
+npm install @cerios/salesforce-sobjectly
+```
+
+It needs Node.js 20.19 or later, and TypeScript 5.4 or later for the types.
+
+## 🎯 Quick Start
+
+### 1. Create a config
+
+```bash
+npx sobjectly init
+```
+
+`init` asks a few questions and writes `sobjectly.config.ts` or `sobjectly.config.json`:
+
+- the API version, e.g. `v66.0`;
+- where to write the generated types;
+- which sObjects to generate;
+- how to log in;
+- how to type picklists;
+- the config format: TypeScript (type-checked with `defineConfig`) or JSON (with a bundled JSON Schema for editor autocomplete).
+
+It can also add the credential variables to `.env.example` and an npm script to `package.json`. Both formats are validated when loaded, and all problems are reported at once. A TypeScript config looks like this:
+
+```ts
+import { defineConfig } from "@cerios/salesforce-sobjectly/codegen";
+
+export default defineConfig({
+	apiVersion: "v66.0",
+	output: "src/generated/sobjects.ts",
+	sobjects: ["Account", "Contact", "Case", "User"],
+	// Reads SF_LOGIN_URL, SF_CLIENT_ID and SF_CLIENT_SECRET from the environment.
+	auth: { type: "clientCredentials" },
+	picklists: "union",
+});
+```
+
+### 2. Generate types for your org
+
+```bash
+npx sobjectly generate --env-file .env
+```
+
+### 3. Use the typed client
+
+```ts
+import { SalesforceClient, clientCredentials } from "@cerios/salesforce-sobjectly";
+import { API_VERSION, type SObjectRegistry } from "./generated/sobjects";
+
+const sf = new SalesforceClient<SObjectRegistry>({
+	apiVersion: API_VERSION, // the same version the types were generated with
+	auth: clientCredentials({
+		loginUrl: process.env.SF_LOGIN_URL!, // your My Domain URL
+		clientId: process.env.SF_CLIENT_ID!,
+		clientSecret: process.env.SF_CLIENT_SECRET!,
+	}),
+});
+
+// CRUD
+const accountId = await sf.sobject("Account").create({ Name: "Acme" });
+await sf.sobject("Account").update(accountId, { Phone: "+31 20 123 4567" });
+const account = await sf.sobject("Account").get(accountId, ["Id", "Name", "Phone"]);
+
+// Typed SOQL
+const page = await sf.query(
+	sf
+		.soql("Contact")
+		.select("Id", "Email")
+		.selectRelated("Account", "Name")
+		.where("Email", "LIKE", "%@acme.com")
+		.orderBy("LastName")
+		.limit(50),
+);
+page.records[0].Account?.Name; // string
+page.records[0].Phone; // ❌ compile error: Phone was not selected
+
+// Every record, across all pages
+for await (const contact of sf.iterate(sf.soql("Contact").select("Id", "Email"))) {
+	console.log(contact.Email);
+}
+```
+
+## 📖 Documentation
+
+| Guide                                                        | What's in it                                                                                            |
+| ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------- |
+| [Authentication](docs/authentication.md)                     | Salesforce CLI, access tokens, client credentials, JWT bearer, refresh tokens, custom providers         |
+| [Code generation](docs/codegen.md)                           | Config reference, type mapping, required fields, picklists, CI usage                                    |
+| [SOQL builder](docs/soql.md)                                 | Selecting, relationships, filters, aggregates, pagination, escaping                                     |
+| [Composite & collections](docs/composite-and-collections.md) | Composite with references, batch, tree, graph, sObject collections                                      |
+| [Approvals, files, reports & more](docs/platform.md)         | Record types, picklists, platform events, approvals, quick actions, UI API, files, reports, query plans |
+| [Bulk API 2.0](docs/bulk.md)                                 | Ingest jobs, query jobs, CSV handling                                                                   |
+| [Transports](docs/transports.md)                             | Custom HTTP clients (axios and Playwright examples), streaming, hooks, retries, timeouts                |
+| [Endpoint coverage](docs/endpoints.md)                       | Which Salesforce REST resources have typed helpers                                                      |
+
+## 🧭 API Overview
+
+```ts
+sf.sobject("Account"): basicInfo, describe, create, get, update, delete, upsert, getByExternalId,
+                       getDeleted, getUpdated, getBlob, query, collect, iterate
+sf.soql("Account") → SoqlQueryBuilder
+sf.query / sf.queryMore / sf.iterate / sf.collect     (queryAll via { includeDeleted: true })
+sf.search:      sosl, parameterized, suggestions
+sf.composite:   execute, batch, tree, graph
+sf.collections: create, update, upsert, delete, retrieve        (≤ 200 per call, or { chunk: true })
+sf.actions:     invokeFlow, invokeApex, invokeStandard, invokeCustom, list*/describe*
+sf.tooling:     query, sobject, executeAnonymous, runTestsSynchronous, runTestsAsynchronous, request
+sf.bulk:        ingest, createIngestJob, query, createQueryJob
+sf.events:      publish (platform events)
+sf.approvals:   list, submit, approve, reject, pending
+sf.files:       upload, download, newVersion, link
+sf.reports:     list, describe, run, runAsync, instance, waitForInstance, toRows
+sf.uiApi:       objectInfo, picklistValues, record, layout
+sf.quickActions / sf.sobject(name).quickActions: list, describe, defaultValues, invoke
+sf.sobject(name).recordTypeId(), .picklistValues();  sf.explain(query);  sf.clearCache()
+sf.tooling.debugLogs: capture, list, body   (executeAnonymous(apex, { captureLog: true }))
+sf.apexRest(), sf.request(), sf.limits(), sf.versions(), sf.describeGlobal(), sf.recordCount()
+```
+
+### Flows and invocable actions
+
+```ts
+const [result] = await sf.actions.invokeFlow<{ accountId: string }, { caseId: string }>("Start_Onboarding", [
+	{ accountId },
+]);
+result.outputValues?.caseId;
+```
+
+### Composite with references
+
+```ts
+const result = await sf.composite.execute(
+	(c) => {
+		const account = c.create("Account", { Name: "Acme" });
+		const contact = c.create("Contact", { LastName: "Doe", AccountId: account.ref("id") });
+		return { account, contact };
+	},
+	{ allOrNone: true },
+);
+const contactId = result.get(result.refs.contact).id;
+```
+
+### Any other endpoint
+
+```ts
+import type { OrgLimits } from "@cerios/salesforce-sobjectly";
+
+const limits = await sf.request<OrgLimits>({ path: "/limits" });
+const tooling = await sf.request({ path: "/tooling/query", query: { q: "SELECT Id FROM ApexClass" } });
+const custom = await sf.apexRest<{ ok: boolean }>({ method: "POST", path: "/orders", body: { id: 1 } });
+```
+
+`path` is relative to `/services/data/{apiVersion}`. Paths that start with `/services/` are used as-is, and absolute URLs must be on your instance's origin.
+
+## 🔢 API version
+
+There is no default API version: you always choose one.
+
+- **Codegen:** `apiVersion` is required in `sobjectly.config.ts`, and `sobjectly generate` fails without it.
+- **Client:** `apiVersion` is required in `new SalesforceClient({ ... })`, both as a TypeScript type and at runtime.
+
+A fixed version means a Salesforce release, or an update of this package, never silently changes the API contract you call. Salesforce freezes behaviour per API version.
+
+The generated file exports the version it was generated with as `API_VERSION`. Pass that to the client, so your types and your requests always use the same version. To upgrade, change `apiVersion` in the config and run `sobjectly generate` again.
+
+## 🧯 Errors
+
+| Error                           | When                                                                                                                                                                                   |
+| ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `SalesforceError`               | Any non-2xx response. Carries `status`, `errorCode`, `errors[]`, `body`, `limitInfo` and a path without the query string.                                                              |
+| `SalesforceSaveError`           | A 2xx response in which an item reported `success: false` (create, collections, actions).                                                                                              |
+| `SalesforcePartialFailureError` | A call split into several requests (chunked collections, batched events) failed after earlier chunks succeeded. `completedResults` holds their results; `cause` is the original error. |
+| `SalesforceAuthError`           | The token request failed. Carries the OAuth `error` and `errorDescription`, never secrets.                                                                                             |
+| `SalesforceBulkJobError`        | A Bulk job ended as `Failed` or `Aborted`, or timed out.                                                                                                                               |
+| `ApexExecutionError`            | Anonymous Apex failed to compile or threw.                                                                                                                                             |
+| `DebugLogCaptureError`          | The work passed to `sf.tooling.debugLogs.capture()` threw. `logs` holds the logs collected anyway; `cause` is the original error.                                                      |
+
+Error codes are typed, with autocomplete for the common ones (`SalesforceErrorCode`). Check them with the guards:
+
+```ts
+import { hasErrorCode, isSalesforceError } from "@cerios/salesforce-sobjectly";
+
+try {
+	await sf.sobject("Account").update(id, { Name: "Acme" });
+} catch (error) {
+	if (hasErrorCode(error, "UNABLE_TO_LOCK_ROW")) {
+		// retry later
+	} else if (isSalesforceError(error, "INSUFFICIENT_ACCESS_OR_READONLY")) {
+		// ...
+	}
+}
+```
+
+## 🤝 Contributing
+
+Contributions are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md). Report security issues as described in [SECURITY.md](SECURITY.md).
+
+## 📄 License
+
+MIT © Ronald Veth - Cerios
+
+## 🔗 Links
+
+- [GitHub repository](https://github.com/CeriosTesting/salesforce-sobjectly)
+- [npm package](https://www.npmjs.com/package/@cerios/salesforce-sobjectly)
+- [Issue tracker](https://github.com/CeriosTesting/salesforce-sobjectly/issues)
+- [Changelog](CHANGELOG.md)

package/dist/cli.cjs

@@ -0,0 +1,188 @@
+#!/usr/bin/env node
+const require_sf_cli = require("./sf-cli-DEVZQTR7.cjs");
+const require_codegen = require("./codegen-BgDgU2RR.cjs");
+let node_fs = require("node:fs");
+let node_path = require("node:path");
+let node_util = require("node:util");
+//#region src/cli.ts
+const HELP = `Usage: sobjectly <command> [options]
+
+Commands:
+  init        Create a sobjectly.config file by answering a few questions
+  generate    Generate TypeScript types for Salesforce sObjects (default)
+
+Options for generate:
+  -c, --config <path>       Config file (default: sobjectly.config.ts or sobjectly.config.json)
+  -e, --env-file <path>     Load environment variables from a .env file first
+      --check               Don't write; exit with 1 when the generated file is out of date
+                            (formatting-only differences don't count)
+      --stdout              Print the generated source instead of writing it
+
+Options for init (skip the matching questions; useful in scripts):
+      --api-version <v>     Salesforce API version, e.g. v66.0
+      --output <path>       Generated types file, e.g. src/generated/sobjects.ts
+      --sobjects <list>     Comma-separated sObject API names
+      --auth <type>         clientCredentials | sfCli | accessToken | jwtBearer
+      --target-org <alias>  Salesforce CLI org alias (with --auth sfCli)
+      --picklists <mode>    union | string
+      --format <format>     ts | json
+  -y, --yes                 Use the suggested answer for every other question (needs --api-version)
+  -f, --force               Replace an existing config without asking
+
+  -h, --help                Show this help
+`;
+const options = {
+	config: {
+		type: "string",
+		short: "c"
+	},
+	"env-file": {
+		type: "string",
+		short: "e"
+	},
+	"api-version": { type: "string" },
+	output: { type: "string" },
+	sobjects: { type: "string" },
+	auth: { type: "string" },
+	picklists: { type: "string" },
+	format: { type: "string" },
+	check: { type: "boolean" },
+	stdout: { type: "boolean" },
+	"target-org": { type: "string" },
+	yes: {
+		type: "boolean",
+		short: "y"
+	},
+	force: {
+		type: "boolean",
+		short: "f"
+	},
+	help: {
+		type: "boolean",
+		short: "h"
+	}
+};
+async function main(argv) {
+	const { values, positionals } = (0, node_util.parseArgs)({
+		args: argv,
+		allowPositionals: true,
+		options
+	});
+	const command = positionals[0] ?? "generate";
+	if (values.help) {
+		console.log(HELP);
+		return 0;
+	}
+	if (command === "init") return init(values);
+	if (command === "generate") return runGenerate(values);
+	console.error(`Unknown command "${command}".\n\n${HELP}`);
+	return 1;
+}
+async function init(values) {
+	const preset = initPreset(values);
+	const prompter = require_codegen.readlinePrompter();
+	try {
+		await require_codegen.runInit({
+			cwd: process.cwd(),
+			prompter,
+			log: (message) => console.log(message),
+			preset,
+			yes: values.yes,
+			force: values.force
+		});
+		return 0;
+	} finally {
+		prompter.close();
+	}
+}
+function initPreset(values) {
+	const preset = {};
+	if (values["api-version"] !== void 0) {
+		const apiVersion = require_sf_cli.normalizeApiVersion(values["api-version"]);
+		if (!apiVersion) throw new Error(`Invalid --api-version "${values["api-version"]}". Expected a value like v66.0.`);
+		preset.apiVersion = apiVersion;
+	}
+	if (values.output !== void 0) preset.output = values.output;
+	if (values.sobjects !== void 0) preset.sobjects = require_codegen.parseSObjects(values.sobjects);
+	const auth = oneOf("--auth", values.auth, [
+		"clientCredentials",
+		"sfCli",
+		"accessToken",
+		"jwtBearer"
+	]);
+	if (values["target-org"] !== void 0) preset.targetOrg = values["target-org"];
+	const picklists = oneOf("--picklists", values.picklists, ["union", "string"]);
+	const format = oneOf("--format", values.format, ["ts", "json"]);
+	return {
+		...preset,
+		...auth && { auth },
+		...picklists && { picklists },
+		...format && { format }
+	};
+}
+function oneOf(flag, value, allowed) {
+	if (value === void 0) return;
+	const match = allowed.find((item) => item === value);
+	if (!match) throw new Error(`Invalid ${flag} "${value}". Expected one of: ${allowed.join(", ")}.`);
+	return match;
+}
+async function runGenerate(values) {
+	if (values["env-file"]) {
+		const envFile = (0, node_path.resolve)(values["env-file"]);
+		if (!(0, node_fs.existsSync)(envFile)) {
+			console.error(`Env file not found: ${envFile}`);
+			return 1;
+		}
+		process.loadEnvFile(envFile);
+	}
+	const found = require_codegen.findConfigFiles();
+	if (!values.config && found.length > 1) console.warn(`warning: found ${found.join(" and ")}; using ${found[0]}. Remove the other one.`);
+	const configPath = values.config ? (0, node_path.resolve)(values.config) : found[0];
+	if (!configPath) {
+		console.error("No sobjectly config file found. Run \"npx sobjectly init\" to create one, or pass --config.");
+		return 1;
+	}
+	const { config, directory } = await require_codegen.loadConfig(configPath);
+	const logger = {
+		info: values.stdout ? (message) => console.error(message) : (message) => console.log(message),
+		warn: (message) => console.warn(`warning: ${message}`)
+	};
+	if (values.check) return reportCheck(await require_codegen.checkGenerated(config, {
+		cwd: directory,
+		logger
+	}));
+	const result = await require_codegen.generate(config, {
+		cwd: directory,
+		logger,
+		write: !values.stdout
+	});
+	if (values.stdout) process.stdout.write(result.source);
+	if (result.skipped.length > 0) console.warn(`Skipped ${result.skipped.length} sObject(s): ${result.skipped.map((item) => item.name).join(", ")}`);
+	return 0;
+}
+function reportCheck(result) {
+	if (result.upToDate) {
+		console.log(`${result.outputPath} is up to date.`);
+		return 0;
+	}
+	if (result.reason === "missing") {
+		console.error(`${result.outputPath} does not exist. Run "sobjectly generate".`);
+		return 1;
+	}
+	const details = [
+		result.added.length > 0 ? `added: ${result.added.join(", ")}` : "",
+		result.removed.length > 0 ? `removed: ${result.removed.join(", ")}` : "",
+		result.changed.length > 0 ? `changed: ${result.changed.join(", ")}` : ""
+	].filter((detail) => detail.length > 0);
+	console.error(`${result.outputPath} is out of date${details.length > 0 ? ` (${details.join("; ")})` : ""}. Run "sobjectly generate".`);
+	return 1;
+}
+main(process.argv.slice(2)).then((code) => {
+	process.exitCode = code;
+}).catch((error) => {
+	console.error(error instanceof Error ? error.message : error);
+	process.exitCode = 1;
+});
+//#endregion
+
+//# sourceMappingURL=cli.cjs.map

package/dist/cli.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.cjs","names":["parseArgs","readlinePrompter","runInit","normalizeApiVersion","parseSObjects","resolve","existsSync","findConfigFiles","loadConfig","checkGenerated","generate"],"sources":["../src/cli.ts"],"sourcesContent":["#!/usr/bin/env node\n/* oxlint-disable no-console */\nimport { existsSync } from \"node:fs\";\nimport { resolve } from \"node:path\";\nimport { parseArgs } from \"node:util\";\n\nimport { normalizeApiVersion } from \"./api-version\";\nimport { checkGenerated, findConfigFiles, generate, loadConfig } from \"./codegen/index\";\nimport { type InitAnswers, parseSObjects, runInit } from \"./codegen/init\";\nimport { readlinePrompter } from \"./codegen/prompter\";\n\nconst HELP = `Usage: sobjectly <command> [options]\n\nCommands:\n  init        Create a sobjectly.config file by answering a few questions\n  generate    Generate TypeScript types for Salesforce sObjects (default)\n\nOptions for generate:\n  -c, --config <path>       Config file (default: sobjectly.config.ts or sobjectly.config.json)\n  -e, --env-file <path>     Load environment variables from a .env file first\n      --check               Don't write; exit with 1 when the generated file is out of date\n                            (formatting-only differences don't count)\n      --stdout              Print the generated source instead of writing it\n\nOptions for init (skip the matching questions; useful in scripts):\n      --api-version <v>     Salesforce API version, e.g. v66.0\n      --output <path>       Generated types file, e.g. src/generated/sobjects.ts\n      --sobjects <list>     Comma-separated sObject API names\n      --auth <type>         clientCredentials | sfCli | accessToken | jwtBearer\n      --target-org <alias>  Salesforce CLI org alias (with --auth sfCli)\n      --picklists <mode>    union | string\n      --format <format>     ts | json\n  -y, --yes                 Use the suggested answer for every other question (needs --api-version)\n  -f, --force               Replace an existing config without asking\n\n  -h, --help                Show this help\n`;\n\nconst options = {\n\tconfig: { type: \"string\", short: \"c\" },\n\t\"env-file\": { type: \"string\", short: \"e\" },\n\t\"api-version\": { type: \"string\" },\n\toutput: { type: \"string\" },\n\tsobjects: { type: \"string\" },\n\tauth: { type: \"string\" },\n\tpicklists: { type: \"string\" },\n\tformat: { type: \"string\" },\n\tcheck: { type: \"boolean\" },\n\tstdout: { type: \"boolean\" },\n\t\"target-org\": { type: \"string\" },\n\tyes: { type: \"boolean\", short: \"y\" },\n\tforce: { type: \"boolean\", short: \"f\" },\n\thelp: { type: \"boolean\", short: \"h\" },\n} as const;\n\ninterface Values {\n\tconfig?: string;\n\t\"env-file\"?: string;\n\t\"api-version\"?: string;\n\toutput?: string;\n\tsobjects?: string;\n\tauth?: string;\n\tpicklists?: string;\n\tformat?: string;\n\tcheck?: boolean;\n\tstdout?: boolean;\n\t\"target-org\"?: string;\n\tyes?: boolean;\n\tforce?: boolean;\n\thelp?: boolean;\n}\n\nasync function main(argv: string[]): Promise<number> {\n\tconst { values, positionals } = parseArgs({ args: argv, allowPositionals: true, options });\n\tconst command = positionals[0] ?? \"generate\";\n\tif (values.help) {\n\t\tconsole.log(HELP);\n\t\treturn 0;\n\t}\n\tif (command === \"init\") {\n\t\treturn init(values);\n\t}\n\tif (command === \"generate\") {\n\t\treturn runGenerate(values);\n\t}\n\tconsole.error(`Unknown command \"${command}\".\\n\\n${HELP}`);\n\treturn 1;\n}\n\nasync function init(values: Values): Promise<number> {\n\tconst preset = initPreset(values);\n\tconst prompter = readlinePrompter();\n\ttry {\n\t\tawait runInit({\n\t\t\tcwd: process.cwd(),\n\t\t\tprompter,\n\t\t\tlog: (message) => console.log(message),\n\t\t\tpreset,\n\t\t\tyes: values.yes,\n\t\t\tforce: values.force,\n\t\t});\n\t\treturn 0;\n\t} finally {\n\t\tprompter.close();\n\t}\n}\n\nfunction initPreset(values: Values): Partial<InitAnswers> {\n\tconst preset: Partial<InitAnswers> = {};\n\tif (values[\"api-version\"] !== undefined) {\n\t\tconst apiVersion = normalizeApiVersion(values[\"api-version\"]);\n\t\tif (!apiVersion) {\n\t\t\tthrow new Error(`Invalid --api-version \"${values[\"api-version\"]}\". Expected a value like v66.0.`);\n\t\t}\n\t\tpreset.apiVersion = apiVersion;\n\t}\n\tif (values.output !== undefined) {\n\t\tpreset.output = values.output;\n\t}\n\tif (values.sobjects !== undefined) {\n\t\tpreset.sobjects = parseSObjects(values.sobjects);\n\t}\n\tconst auth = oneOf(\"--auth\", values.auth, [\"clientCredentials\", \"sfCli\", \"accessToken\", \"jwtBearer\"] as const);\n\tif (values[\"target-org\"] !== undefined) {\n\t\tpreset.targetOrg = values[\"target-org\"];\n\t}\n\tconst picklists = oneOf(\"--picklists\", values.picklists, [\"union\", \"string\"] as const);\n\tconst format = oneOf(\"--format\", values.format, [\"ts\", \"json\"] as const);\n\treturn { ...preset, ...(auth && { auth }), ...(picklists && { picklists }), ...(format && { format }) };\n}\n\nfunction oneOf<T extends string>(flag: string, value: string | undefined, allowed: readonly T[]): T | undefined {\n\tif (value === undefined) {\n\t\treturn undefined;\n\t}\n\tconst match = allowed.find((item) => item === value);\n\tif (!match) {\n\t\tthrow new Error(`Invalid ${flag} \"${value}\". Expected one of: ${allowed.join(\", \")}.`);\n\t}\n\treturn match;\n}\n\nasync function runGenerate(values: Values): Promise<number> {\n\tif (values[\"env-file\"]) {\n\t\tconst envFile = resolve(values[\"env-file\"]);\n\t\tif (!existsSync(envFile)) {\n\t\t\tconsole.error(`Env file not found: ${envFile}`);\n\t\t\treturn 1;\n\t\t}\n\t\tprocess.loadEnvFile(envFile);\n\t}\n\tconst found = findConfigFiles();\n\tif (!values.config && found.length > 1) {\n\t\tconsole.warn(`warning: found ${found.join(\" and \")}; using ${found[0]}. Remove the other one.`);\n\t}\n\tconst configPath = values.config ? resolve(values.config) : found[0];\n\tif (!configPath) {\n\t\tconsole.error('No sobjectly config file found. Run \"npx sobjectly init\" to create one, or pass --config.');\n\t\treturn 1;\n\t}\n\tconst { config, directory } = await loadConfig(configPath);\n\t// With --stdout the source goes to stdout, so progress goes to stderr.\n\tconst log = values.stdout\n\t\t? (message: string): void => console.error(message)\n\t\t: (message: string): void => console.log(message);\n\tconst logger = { info: log, warn: (message: string): void => console.warn(`warning: ${message}`) };\n\tif (values.check) {\n\t\treturn reportCheck(await checkGenerated(config, { cwd: directory, logger }));\n\t}\n\tconst result = await generate(config, { cwd: directory, logger, write: !values.stdout });\n\tif (values.stdout) {\n\t\tprocess.stdout.write(result.source);\n\t}\n\tif (result.skipped.length > 0) {\n\t\tconsole.warn(`Skipped ${result.skipped.length} sObject(s): ${result.skipped.map((item) => item.name).join(\", \")}`);\n\t}\n\treturn 0;\n}\n\nfunction reportCheck(result: Awaited<ReturnType<typeof checkGenerated>>): number {\n\tif (result.upToDate) {\n\t\tconsole.log(`${result.outputPath} is up to date.`);\n\t\treturn 0;\n\t}\n\tif (result.reason === \"missing\") {\n\t\tconsole.error(`${result.outputPath} does not exist. Run \"sobjectly generate\".`);\n\t\treturn 1;\n\t}\n\tconst details = [\n\t\tresult.added.length > 0 ? `added: ${result.added.join(\", \")}` : \"\",\n\t\tresult.removed.length > 0 ? `removed: ${result.removed.join(\", \")}` : \"\",\n\t\tresult.changed.length > 0 ? `changed: ${result.changed.join(\", \")}` : \"\",\n\t].filter((detail) => detail.length > 0);\n\tconsole.error(\n\t\t`${result.outputPath} is out of date${details.length > 0 ? ` (${details.join(\"; \")})` : \"\"}. Run \"sobjectly generate\".`,\n\t);\n\treturn 1;\n}\n\nmain(process.argv.slice(2))\n\t.then((code) => {\n\t\tprocess.exitCode = code;\n\t})\n\t.catch((error: unknown) => {\n\t\tconsole.error(error instanceof Error ? error.message : error);\n\t\tprocess.exitCode = 1;\n\t});\n"],"mappings":";;;;;;;AAWA,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;AA2Bb,MAAM,UAAU;CACf,QAAQ;EAAE,MAAM;EAAU,OAAO;CAAI;CACrC,YAAY;EAAE,MAAM;EAAU,OAAO;CAAI;CACzC,eAAe,EAAE,MAAM,SAAS;CAChC,QAAQ,EAAE,MAAM,SAAS;CACzB,UAAU,EAAE,MAAM,SAAS;CAC3B,MAAM,EAAE,MAAM,SAAS;CACvB,WAAW,EAAE,MAAM,SAAS;CAC5B,QAAQ,EAAE,MAAM,SAAS;CACzB,OAAO,EAAE,MAAM,UAAU;CACzB,QAAQ,EAAE,MAAM,UAAU;CAC1B,cAAc,EAAE,MAAM,SAAS;CAC/B,KAAK;EAAE,MAAM;EAAW,OAAO;CAAI;CACnC,OAAO;EAAE,MAAM;EAAW,OAAO;CAAI;CACrC,MAAM;EAAE,MAAM;EAAW,OAAO;CAAI;AACrC;AAmBA,eAAe,KAAK,MAAiC;CACpD,MAAM,EAAE,QAAQ,iBAAA,GAAgBA,UAAAA,UAAAA,CAAU;EAAE,MAAM;EAAM,kBAAkB;EAAM;CAAQ,CAAC;CACzF,MAAM,UAAU,YAAY,MAAM;CAClC,IAAI,OAAO,MAAM;EAChB,QAAQ,IAAI,IAAI;EAChB,OAAO;CACR;CACA,IAAI,YAAY,QACf,OAAO,KAAK,MAAM;CAEnB,IAAI,YAAY,YACf,OAAO,YAAY,MAAM;CAE1B,QAAQ,MAAM,oBAAoB,QAAQ,QAAQ,MAAM;CACxD,OAAO;AACR;AAEA,eAAe,KAAK,QAAiC;CACpD,MAAM,SAAS,WAAW,MAAM;CAChC,MAAM,WAAWC,gBAAAA,iBAAiB;CAClC,IAAI;EACH,MAAMC,gBAAAA,QAAQ;GACb,KAAK,QAAQ,IAAI;GACjB;GACA,MAAM,YAAY,QAAQ,IAAI,OAAO;GACrC;GACA,KAAK,OAAO;GACZ,OAAO,OAAO;EACf,CAAC;EACD,OAAO;CACR,UAAU;EACT,SAAS,MAAM;CAChB;AACD;AAEA,SAAS,WAAW,QAAsC;CACzD,MAAM,SAA+B,CAAC;CACtC,IAAI,OAAO,mBAAmB,KAAA,GAAW;EACxC,MAAM,aAAaC,eAAAA,oBAAoB,OAAO,cAAc;EAC5D,IAAI,CAAC,YACJ,MAAM,IAAI,MAAM,0BAA0B,OAAO,eAAe,gCAAgC;EAEjG,OAAO,aAAa;CACrB;CACA,IAAI,OAAO,WAAW,KAAA,GACrB,OAAO,SAAS,OAAO;CAExB,IAAI,OAAO,aAAa,KAAA,GACvB,OAAO,WAAWC,gBAAAA,cAAc,OAAO,QAAQ;CAEhD,MAAM,OAAO,MAAM,UAAU,OAAO,MAAM;EAAC;EAAqB;EAAS;EAAe;CAAW,CAAU;CAC7G,IAAI,OAAO,kBAAkB,KAAA,GAC5B,OAAO,YAAY,OAAO;CAE3B,MAAM,YAAY,MAAM,eAAe,OAAO,WAAW,CAAC,SAAS,QAAQ,CAAU;CACrF,MAAM,SAAS,MAAM,YAAY,OAAO,QAAQ,CAAC,MAAM,MAAM,CAAU;CACvE,OAAO;EAAE,GAAG;EAAQ,GAAI,QAAQ,EAAE,KAAK;EAAI,GAAI,aAAa,EAAE,UAAU;EAAI,GAAI,UAAU,EAAE,OAAO;CAAG;AACvG;AAEA,SAAS,MAAwB,MAAc,OAA2B,SAAsC;CAC/G,IAAI,UAAU,KAAA,GACb;CAED,MAAM,QAAQ,QAAQ,MAAM,SAAS,SAAS,KAAK;CACnD,IAAI,CAAC,OACJ,MAAM,IAAI,MAAM,WAAW,KAAK,IAAI,MAAM,sBAAsB,QAAQ,KAAK,IAAI,EAAE,EAAE;CAEtF,OAAO;AACR;AAEA,eAAe,YAAY,QAAiC;CAC3D,IAAI,OAAO,aAAa;EACvB,MAAM,WAAA,GAAUC,UAAAA,QAAAA,CAAQ,OAAO,WAAW;EAC1C,IAAI,EAAA,GAACC,QAAAA,WAAAA,CAAW,OAAO,GAAG;GACzB,QAAQ,MAAM,uBAAuB,SAAS;GAC9C,OAAO;EACR;EACA,QAAQ,YAAY,OAAO;CAC5B;CACA,MAAM,QAAQC,gBAAAA,gBAAgB;CAC9B,IAAI,CAAC,OAAO,UAAU,MAAM,SAAS,GACpC,QAAQ,KAAK,kBAAkB,MAAM,KAAK,OAAO,EAAE,UAAU,MAAM,GAAG,wBAAwB;CAE/F,MAAM,aAAa,OAAO,UAAA,GAASF,UAAAA,QAAAA,CAAQ,OAAO,MAAM,IAAI,MAAM;CAClE,IAAI,CAAC,YAAY;EAChB,QAAQ,MAAM,6FAA2F;EACzG,OAAO;CACR;CACA,MAAM,EAAE,QAAQ,cAAc,MAAMG,gBAAAA,WAAW,UAAU;CAKzD,MAAM,SAAS;EAAE,MAHL,OAAO,UACf,YAA0B,QAAQ,MAAM,OAAO,KAC/C,YAA0B,QAAQ,IAAI,OAAO;EACrB,OAAO,YAA0B,QAAQ,KAAK,YAAY,SAAS;CAAE;CACjG,IAAI,OAAO,OACV,OAAO,YAAY,MAAMC,gBAAAA,eAAe,QAAQ;EAAE,KAAK;EAAW;CAAO,CAAC,CAAC;CAE5E,MAAM,SAAS,MAAMC,gBAAAA,SAAS,QAAQ;EAAE,KAAK;EAAW;EAAQ,OAAO,CAAC,OAAO;CAAO,CAAC;CACvF,IAAI,OAAO,QACV,QAAQ,OAAO,MAAM,OAAO,MAAM;CAEnC,IAAI,OAAO,QAAQ,SAAS,GAC3B,QAAQ,KAAK,WAAW,OAAO,QAAQ,OAAO,eAAe,OAAO,QAAQ,KAAK,SAAS,KAAK,IAAI,CAAC,CAAC,KAAK,IAAI,GAAG;CAElH,OAAO;AACR;AAEA,SAAS,YAAY,QAA4D;CAChF,IAAI,OAAO,UAAU;EACpB,QAAQ,IAAI,GAAG,OAAO,WAAW,gBAAgB;EACjD,OAAO;CACR;CACA,IAAI,OAAO,WAAW,WAAW;EAChC,QAAQ,MAAM,GAAG,OAAO,WAAW,2CAA2C;EAC9E,OAAO;CACR;CACA,MAAM,UAAU;EACf,OAAO,MAAM,SAAS,IAAI,UAAU,OAAO,MAAM,KAAK,IAAI,MAAM;EAChE,OAAO,QAAQ,SAAS,IAAI,YAAY,OAAO,QAAQ,KAAK,IAAI,MAAM;EACtE,OAAO,QAAQ,SAAS,IAAI,YAAY,OAAO,QAAQ,KAAK,IAAI,MAAM;CACvE,CAAC,CAAC,QAAQ,WAAW,OAAO,SAAS,CAAC;CACtC,QAAQ,MACP,GAAG,OAAO,WAAW,iBAAiB,QAAQ,SAAS,IAAI,KAAK,QAAQ,KAAK,IAAI,EAAE,KAAK,GAAG,4BAC5F;CACA,OAAO;AACR;AAEA,KAAK,QAAQ,KAAK,MAAM,CAAC,CAAC,CAAC,CACzB,MAAM,SAAS;CACf,QAAQ,WAAW;AACpB,CAAC,CAAC,CACD,OAAO,UAAmB;CAC1B,QAAQ,MAAM,iBAAiB,QAAQ,MAAM,UAAU,KAAK;CAC5D,QAAQ,WAAW;AACpB,CAAC"}

package/dist/cli.d.cts

@@ -0,0 +1 @@
+export {}

package/dist/cli.d.mts

@@ -0,0 +1 @@
+export {}

package/dist/cli.mjs

@@ -0,0 +1,196 @@
+#!/usr/bin/env node
+import { Lt as __commonJSMin, Mt as init_api_version, Pt as normalizeApiVersion } from "./sf-cli-CtWtdkJ0.mjs";
+import { a as init_prompter, c as init_init, d as runInit, g as loadConfig, l as parseSObjects, m as findConfigFiles, n as generate, o as readlinePrompter, r as init_codegen, t as checkGenerated } from "./codegen-CSx0WAtK.mjs";
+import { existsSync } from "node:fs";
+import { resolve } from "node:path";
+import { parseArgs } from "node:util";
+//#region src/cli.ts
+var require_cli = /* @__PURE__ */ __commonJSMin((() => {
+	init_api_version();
+	init_codegen();
+	init_init();
+	init_prompter();
+	const HELP = `Usage: sobjectly <command> [options]
+
+Commands:
+  init        Create a sobjectly.config file by answering a few questions
+  generate    Generate TypeScript types for Salesforce sObjects (default)
+
+Options for generate:
+  -c, --config <path>       Config file (default: sobjectly.config.ts or sobjectly.config.json)
+  -e, --env-file <path>     Load environment variables from a .env file first
+      --check               Don't write; exit with 1 when the generated file is out of date
+                            (formatting-only differences don't count)
+      --stdout              Print the generated source instead of writing it
+
+Options for init (skip the matching questions; useful in scripts):
+      --api-version <v>     Salesforce API version, e.g. v66.0
+      --output <path>       Generated types file, e.g. src/generated/sobjects.ts
+      --sobjects <list>     Comma-separated sObject API names
+      --auth <type>         clientCredentials | sfCli | accessToken | jwtBearer
+      --target-org <alias>  Salesforce CLI org alias (with --auth sfCli)
+      --picklists <mode>    union | string
+      --format <format>     ts | json
+  -y, --yes                 Use the suggested answer for every other question (needs --api-version)
+  -f, --force               Replace an existing config without asking
+
+  -h, --help                Show this help
+`;
+	const options = {
+		config: {
+			type: "string",
+			short: "c"
+		},
+		"env-file": {
+			type: "string",
+			short: "e"
+		},
+		"api-version": { type: "string" },
+		output: { type: "string" },
+		sobjects: { type: "string" },
+		auth: { type: "string" },
+		picklists: { type: "string" },
+		format: { type: "string" },
+		check: { type: "boolean" },
+		stdout: { type: "boolean" },
+		"target-org": { type: "string" },
+		yes: {
+			type: "boolean",
+			short: "y"
+		},
+		force: {
+			type: "boolean",
+			short: "f"
+		},
+		help: {
+			type: "boolean",
+			short: "h"
+		}
+	};
+	async function main(argv) {
+		const { values, positionals } = parseArgs({
+			args: argv,
+			allowPositionals: true,
+			options
+		});
+		const command = positionals[0] ?? "generate";
+		if (values.help) {
+			console.log(HELP);
+			return 0;
+		}
+		if (command === "init") return init(values);
+		if (command === "generate") return runGenerate(values);
+		console.error(`Unknown command "${command}".\n\n${HELP}`);
+		return 1;
+	}
+	async function init(values) {
+		const preset = initPreset(values);
+		const prompter = readlinePrompter();
+		try {
+			await runInit({
+				cwd: process.cwd(),
+				prompter,
+				log: (message) => console.log(message),
+				preset,
+				yes: values.yes,
+				force: values.force
+			});
+			return 0;
+		} finally {
+			prompter.close();
+		}
+	}
+	function initPreset(values) {
+		const preset = {};
+		if (values["api-version"] !== void 0) {
+			const apiVersion = normalizeApiVersion(values["api-version"]);
+			if (!apiVersion) throw new Error(`Invalid --api-version "${values["api-version"]}". Expected a value like v66.0.`);
+			preset.apiVersion = apiVersion;
+		}
+		if (values.output !== void 0) preset.output = values.output;
+		if (values.sobjects !== void 0) preset.sobjects = parseSObjects(values.sobjects);
+		const auth = oneOf("--auth", values.auth, [
+			"clientCredentials",
+			"sfCli",
+			"accessToken",
+			"jwtBearer"
+		]);
+		if (values["target-org"] !== void 0) preset.targetOrg = values["target-org"];
+		const picklists = oneOf("--picklists", values.picklists, ["union", "string"]);
+		const format = oneOf("--format", values.format, ["ts", "json"]);
+		return {
+			...preset,
+			...auth && { auth },
+			...picklists && { picklists },
+			...format && { format }
+		};
+	}
+	function oneOf(flag, value, allowed) {
+		if (value === void 0) return;
+		const match = allowed.find((item) => item === value);
+		if (!match) throw new Error(`Invalid ${flag} "${value}". Expected one of: ${allowed.join(", ")}.`);
+		return match;
+	}
+	async function runGenerate(values) {
+		if (values["env-file"]) {
+			const envFile = resolve(values["env-file"]);
+			if (!existsSync(envFile)) {
+				console.error(`Env file not found: ${envFile}`);
+				return 1;
+			}
+			process.loadEnvFile(envFile);
+		}
+		const found = findConfigFiles();
+		if (!values.config && found.length > 1) console.warn(`warning: found ${found.join(" and ")}; using ${found[0]}. Remove the other one.`);
+		const configPath = values.config ? resolve(values.config) : found[0];
+		if (!configPath) {
+			console.error("No sobjectly config file found. Run \"npx sobjectly init\" to create one, or pass --config.");
+			return 1;
+		}
+		const { config, directory } = await loadConfig(configPath);
+		const logger = {
+			info: values.stdout ? (message) => console.error(message) : (message) => console.log(message),
+			warn: (message) => console.warn(`warning: ${message}`)
+		};
+		if (values.check) return reportCheck(await checkGenerated(config, {
+			cwd: directory,
+			logger
+		}));
+		const result = await generate(config, {
+			cwd: directory,
+			logger,
+			write: !values.stdout
+		});
+		if (values.stdout) process.stdout.write(result.source);
+		if (result.skipped.length > 0) console.warn(`Skipped ${result.skipped.length} sObject(s): ${result.skipped.map((item) => item.name).join(", ")}`);
+		return 0;
+	}
+	function reportCheck(result) {
+		if (result.upToDate) {
+			console.log(`${result.outputPath} is up to date.`);
+			return 0;
+		}
+		if (result.reason === "missing") {
+			console.error(`${result.outputPath} does not exist. Run "sobjectly generate".`);
+			return 1;
+		}
+		const details = [
+			result.added.length > 0 ? `added: ${result.added.join(", ")}` : "",
+			result.removed.length > 0 ? `removed: ${result.removed.join(", ")}` : "",
+			result.changed.length > 0 ? `changed: ${result.changed.join(", ")}` : ""
+		].filter((detail) => detail.length > 0);
+		console.error(`${result.outputPath} is out of date${details.length > 0 ? ` (${details.join("; ")})` : ""}. Run "sobjectly generate".`);
+		return 1;
+	}
+	main(process.argv.slice(2)).then((code) => {
+		process.exitCode = code;
+	}).catch((error) => {
+		console.error(error instanceof Error ? error.message : error);
+		process.exitCode = 1;
+	});
+}));
+//#endregion
+export default require_cli();
+export {};
+
+//# sourceMappingURL=cli.mjs.map