@cerios/salesforce-sobjectly 1.0.0 → 1.1.0

package/dist/{codegen-CSx0WAtK.mjs → codegen-C6MEYiWo.mjs}

@@ -1,22 +1,50 @@
-import { Mt as init_api_version, Nt as isApiVersion, Pt as normalizeApiVersion, Rt as __esmMin, d as init_client, i as clientCredentials, n as sfCli, o as init_providers, r as accessToken, s as jwtBearer, t as init_sf_cli, u as SalesforceClient } from "./sf-cli-CtWtdkJ0.mjs";
+import { Mt as init_api_version, Nt as isApiVersion, Pt as normalizeApiVersion, Rt as __esmMin, d as init_client, i as clientCredentials, n as sfCli, o as init_providers, r as accessToken, s as jwtBearer, t as init_sf_cli, u as SalesforceClient } from "./sf-cli-_Ua-M_Zi.mjs";
 import { createHash } from "node:crypto";
 import { existsSync, readFileSync, rmSync, writeFileSync } from "node:fs";
 import { mkdir, readFile, rename, rm, writeFile } from "node:fs/promises";
 import { dirname, extname, isAbsolute, join, relative, resolve } from "node:path";
 import { createJiti } from "jiti";
 import { createInterface } from "node:readline";
+//#region src/codegen/emit.ts
+/** Fields sorted by name, `Id` first, so the output is deterministic. */
+function sortedFields(describe) {
+	return [...describe.fields].sort((a, b) => a.name === "Id" ? -1 : b.name === "Id" ? 1 : compare(a.name, b.name));
+}
+/** An object key: the bare name when it is an identifier, otherwise a quoted string. */
+function propertyKey(name) {
+	return IDENTIFIER$1.test(name) ? name : JSON.stringify(name);
+}
+function escapeComment(value) {
+	return String(value ?? "").replace(/\*\//g, "*\\/").replace(/\r?\n/g, " ");
+}
+function compare(a, b) {
+	return a < b ? -1 : a > b ? 1 : 0;
+}
+var IDENTIFIER$1;
+var init_emit = __esmMin((() => {
+	IDENTIFIER$1 = /^[A-Za-z_$][A-Za-z0-9_$]*$/;
+}));
+//#endregion
 //#region src/codegen/type-mapper.ts
-/** Returns the TypeScript type for a field, including `| null` for nillable fields. */
-function mapFieldType(field, picklists = "union") {
-	const base = picklistType(field, picklists) ?? FIELD_TYPE_MAP[field.type] ?? "unknown";
+/**
+* Returns the TypeScript type for a field, including `| null` for nillable fields. With picklist
+* mode `"const"` or `"enum"`, `typeName` is the field's named picklist type; it replaces the union.
+*/
+function mapFieldType(field, picklists = "union", typeName) {
+	const base = picklistType(field, picklists, typeName) ?? FIELD_TYPE_MAP[field.type] ?? "unknown";
 	return field.nillable && base !== "unknown" ? `${base} | null` : base;
 }
-function picklistType(field, picklists) {
-	if (picklists !== "union" || field.type !== "picklist" && field.type !== "combobox") return;
-	const values = [...new Set((field.picklistValues ?? []).filter((entry) => entry.active).map((entry) => entry.value))];
+function picklistType(field, picklists, typeName) {
+	if (picklists === "string" || field.type !== "picklist" && field.type !== "combobox") return;
+	const values = activePicklistValues(field);
 	if (values.length === 0) return;
-	const union = values.map((value) => JSON.stringify(value)).join(" | ");
-	return field.restrictedPicklist && field.type === "picklist" ? union : `${union} | (string & {})`;
+	const members = picklists !== "union" && typeName !== void 0 ? typeName : values.map((value) => JSON.stringify(value)).join(" | ");
+	return field.restrictedPicklist && field.type === "picklist" ? members : `${members} | (string & {})`;
+}
+/** The distinct active values of a picklist, multi-select picklist or combobox, in describe order. */
+function activePicklistValues(field) {
+	if (field.type !== "picklist" && field.type !== "multipicklist" && field.type !== "combobox") return [];
+	return [...new Set((field.picklistValues ?? []).filter((entry) => entry.active).map((entry) => entry.value))];
 }
 var ADDRESS_TYPE, GEOLOCATION_TYPE, FIELD_TYPE_MAP;
 var init_type_mapper = __esmMin((() => {
@@ -54,24 +82,151 @@ var init_type_mapper = __esmMin((() => {
 	};
 }));
 //#endregion
+//#region src/codegen/picklist-types.ts
+function isNamedPicklistMode(mode) {
+	return mode === "const" || mode === "enum";
+}
+/**
+* Names the type of every picklist with active values: sObject and field in PascalCase, e.g.
+* `Case.Status` -> `CaseStatus` and `Case.Status__c` -> `CaseStatusCustom`. A name that is in
+* `taken` (the sObjects and other names the file defines) or already used by another picklist gets
+* the suffix `Picklist`; when that is taken too, this throws.
+*/
+function picklistTypeNames(describes, taken) {
+	const used = new Map([...taken].map((name) => [name, void 0]));
+	const result = /* @__PURE__ */ new Map();
+	for (const describe of [...describes].sort((a, b) => compare(a.name, b.name))) {
+		const names = /* @__PURE__ */ new Map();
+		for (const field of sortedFields(describe).filter((item) => activePicklistValues(item).length > 0)) {
+			const base = `${pascalApiName(describe.name, "sobject")}${pascalApiName(field.name, "field")}`;
+			if (IDENTIFIER$1.test(base)) {
+				const picklist = `${describe.name}.${field.name}`;
+				const name = resolveName(base, picklist, used);
+				used.set(name, picklist);
+				names.set(field.name, name);
+			}
+		}
+		if (names.size > 0) result.set(describe.name, names);
+	}
+	return result;
+}
+function resolveName(base, picklist, used) {
+	const name = used.has(base) ? `${base}${CLASH_SUFFIX}` : base;
+	if (used.has(name)) {
+		const owner = used.get(name);
+		const other = owner === void 0 ? "a type the generated file defines" : `the picklist type for ${owner}`;
+		throw new Error(`The picklist type "${name}" for ${picklist} clashes with ${other}; exclude one of the sObjects or use picklists: "union".`);
+	}
+	return name;
+}
+/**
+* An API name in PascalCase without underscores. A field's `__c` becomes `Custom`
+* (`Lead_Source__c` -> `LeadSourceCustom`) and an sObject's is dropped (`My_Object__c` ->
+* `MyObject`). Other suffixes are kept: `Foo__pc` -> `FooPc`, `Config__mdt` -> `ConfigMdt`.
+*/
+function pascalApiName(name, kind) {
+	const match = /^(.+?)__([a-z]+)$/.exec(name);
+	const body = match ? match[1] : name;
+	const suffix = match ? match[2] : "";
+	const suffixPart = suffix === "c" ? kind === "field" ? "Custom" : "" : capitalize(suffix);
+	return `${body.split("_").filter((part) => part.length > 0).map(capitalize).join("")}${suffixPart}`;
+}
+function capitalize(value) {
+	return value.charAt(0).toUpperCase() + value.slice(1);
+}
+/**
+* The member names for a picklist's values, in the same order. A value that is an identifier is
+* its own name; other values are sanitized (`"Closed Won"` -> `Closed_Won`, `"3rd Party"` ->
+* `_3rd_Party`). When the sanitized name is empty or taken, the value itself is the (quoted) name.
+*/
+function picklistMemberKeys(values, mode) {
+	const used = /* @__PURE__ */ new Set();
+	const claim = (key) => {
+		used.add(key);
+		return key;
+	};
+	const usable = (key) => key.length > 0 && key !== "__proto__" && !used.has(key) && (mode === "const" || !isNumericName(key));
+	const own = values.map((value) => IDENTIFIER$1.test(value) && usable(value) ? claim(value) : void 0);
+	return values.map((value, index) => {
+		const ownKey = own[index];
+		if (ownKey !== void 0) return ownKey;
+		const sanitized = sanitizeKey(value);
+		if (usable(sanitized)) return claim(sanitized);
+		if (usable(value)) return claim(value);
+		let counter = 2;
+		while (!usable(`${sanitized || "_"}_${counter}`)) counter++;
+		return claim(`${sanitized || "_"}_${counter}`);
+	});
+}
+function sanitizeKey(value) {
+	const key = value.normalize("NFKD").replace(/\p{M}/gu, "").replace(/[^A-Za-z0-9_]+/g, "_").replace(/^_+|_+$/g, "");
+	return /^[0-9]/.test(key) ? `_${key}` : key;
+}
+/** Names TypeScript rejects as enum members because they are numeric, e.g. `"1"` or `"-1"`. */
+function isNumericName(key) {
+	const number = Number(key);
+	return Number.isFinite(number) && String(number) === key;
+}
+/** The named type declarations for one sObject's picklists, in field order; `""` when there are none. */
+function picklistDeclarations(describe, names, mode) {
+	if (!names) return "";
+	return sortedFields(describe).flatMap((field) => {
+		const name = names.get(field.name);
+		return name === void 0 ? [] : [declaration(describe.name, field, name, mode)];
+	}).join("\n\n");
+}
+function declaration(sobject, field, name, mode) {
+	const values = activePicklistValues(field);
+	const keys = picklistMemberKeys(values, mode);
+	const doc = `/** Active values of ${escapeComment(`${sobject}.${field.name}`)} (${escapeComment(field.type)}). */`;
+	if (mode === "enum") {
+		const members = values.map((value, index) => `\t${propertyKey(keys[index])} = ${JSON.stringify(value)},`);
+		return [
+			doc,
+			`export enum ${name} {`,
+			...members,
+			"}"
+		].join("\n");
+	}
+	const members = values.map((value, index) => `\t${propertyKey(keys[index])}: ${JSON.stringify(value)},`);
+	return [
+		doc,
+		`export const ${name} = {`,
+		...members,
+		"} as const;",
+		`export type ${name} = (typeof ${name})[keyof typeof ${name}];`
+	].join("\n");
+}
+var CLASH_SUFFIX;
+var init_picklist_types = __esmMin((() => {
+	init_emit();
+	init_type_mapper();
+	CLASH_SUFFIX = "Picklist";
+}));
+//#endregion
 //#region src/codegen/generator.ts
 /**
 * Generates the TypeScript source for a set of sObject describes: a read interface, create
-* and update input types per sObject, and the `SObjectRegistry` that ties them together.
+* and update input types per sObject, and the `SObjectRegistry` that ties them together. With
+* picklist mode `"const"` or `"enum"`, each picklist also gets a named type before its sObject.
 * The output is deterministic: sObjects are sorted by name and fields by name (`Id` first).
 */
 function generateSource(describes, options = {}) {
 	const sorted = [...describes].sort((a, b) => compare(a.name, b.name));
-	assertGeneratableNames(sorted);
+	const definedNames = assertGeneratableNames(sorted);
 	const names = new Set(sorted.map((describe) => describe.name));
+	const picklists = options.picklists ?? "union";
+	const picklistTypes = isNamedPicklistMode(picklists) ? picklistTypeNames(sorted, definedNames) : void 0;
 	const sections = [imports(sorted, options.importSource ?? "@cerios/salesforce-sobjectly")];
 	const objectHashes = [];
 	for (const describe of sorted) {
+		const typeNames = picklistTypes?.get(describe.name);
 		const objectSections = [
-			readInterface(describe, options.picklists ?? "union"),
+			isNamedPicklistMode(picklists) ? picklistDeclarations(describe, typeNames, picklists) : "",
+			readInterface(describe, picklists, typeNames),
 			inputType(describe, "CreateInput", "createable", lookup(options.excludeCreateFields, describe.name)),
 			inputType(describe, "UpdateInput", "updateable", lookup(options.excludeUpdateFields, describe.name))
-		];
+		].filter((section) => section.length > 0);
 		sections.push(...objectSections);
 		const fingerprint = [
 			...objectSections,
@@ -86,7 +241,10 @@ function generateSource(describes, options = {}) {
 	const body = sections.filter((section) => section.length > 0).join("\n\n");
 	return `${header(sha256(body), objectHashes)}\n\n${body}\n`;
 }
-/** Fails with a clear message for sObject names the generated TypeScript can't represent. */
+/**
+* Fails with a clear message for sObject names the generated TypeScript can't represent. Returns
+* every name the file defines apart from picklist types, so those can avoid them.
+*/
 function assertGeneratableNames(describes) {
 	const seen = /* @__PURE__ */ new Map();
 	const generated = new Set(describes.flatMap((describe) => [`${describe.name}CreateInput`, `${describe.name}UpdateInput`]));
@@ -97,6 +255,11 @@ function assertGeneratableNames(describes) {
 		if (previous !== void 0) throw new Error(`sObjects "${previous}" and "${name}" differ only in case; list each sObject once.`);
 		seen.set(name.toLowerCase(), name);
 	}
+	return /* @__PURE__ */ new Set([
+		...RESERVED_TYPE_NAMES,
+		...generated,
+		...describes.map((describe) => describe.name)
+	]);
 }
 /** Looks up a per-sObject option case-insensitively (sObject names are case-insensitive in Salesforce). */
 function lookup(map, name) {
@@ -141,12 +304,11 @@ function imports(describes, importSource) {
 	if (fields.some((field) => field.type === "location")) used.push(GEOLOCATION_TYPE);
 	return used.length > 0 ? `import type { ${used.join(", ")} } from ${JSON.stringify(importSource)};` : "";
 }
-function sortedFields(describe) {
-	return [...describe.fields].sort((a, b) => a.name === "Id" ? -1 : b.name === "Id" ? 1 : compare(a.name, b.name));
-}
-function readInterface(describe, picklists) {
+function readInterface(describe, picklists, typeNames) {
 	const lines = sortedFields(describe).map((field) => {
-		return `${`\t/** ${escapeComment(field.label)} (${escapeComment(field.type)}) */`}\n\t${propertyKey(field.name)}: ${mapFieldType(field, picklists)};`;
+		const comment = `\t/** ${escapeComment(field.label)} (${escapeComment(field.type)}) */`;
+		const type = mapFieldType(field, picklists, typeNames?.get(field.name));
+		return `${comment}\n\t${propertyKey(field.name)}: ${type};`;
 	});
 	return `${describe.label ? `/** ${escapeComment(describe.label)} */\n` : ""}export interface ${describe.name} {\n${lines.join("\n")}\n}`;
 }
@@ -233,10 +395,6 @@ function recordTypeConstants(describes) {
 	const entries = describes.map((describe) => [describe.name, recordTypeNames(describe)]).filter(([, names]) => names.length > 0).map(([name, names]) => `\t${name}: [${names.map((value) => JSON.stringify(value)).join(", ")}],`);
 	return ["/** Record type DeveloperNames per sObject. Resolve ids with `sf.sobject(name).recordTypeId(developerName)`. */", `export const RECORD_TYPES = {${entries.length > 0 ? `\n${entries.join("\n")}\n` : ""}} as const;`].join("\n");
 }
-function activePicklistValues(field) {
-	if (field.type !== "picklist" && field.type !== "multipicklist" && field.type !== "combobox") return [];
-	return [...new Set((field.picklistValues ?? []).filter((entry) => entry.active).map((entry) => entry.value))];
-}
 function unionOrNever(values) {
 	return values.length > 0 ? values.map((value) => JSON.stringify(value)).join(" | ") : "never";
 }
@@ -259,17 +417,10 @@ function relationshipMap(entries) {
 function keyUnion(names) {
 	return names.map((name) => JSON.stringify(name)).join(" | ");
 }
-function propertyKey(name) {
-	return IDENTIFIER$1.test(name) ? name : JSON.stringify(name);
-}
-function escapeComment(value) {
-	return String(value ?? "").replace(/\*\//g, "*\\/").replace(/\r?\n/g, " ");
-}
-function compare(a, b) {
-	return a < b ? -1 : a > b ? 1 : 0;
-}
-var FIELD_KINDS, IDENTIFIER$1, RESERVED_TYPE_NAMES, CONTENT_HASH_PREFIX, OBJECT_HASHES_PREFIX, OBJECT_HASH_LENGTH;
+var FIELD_KINDS, RESERVED_TYPE_NAMES, CONTENT_HASH_PREFIX, OBJECT_HASHES_PREFIX, OBJECT_HASH_LENGTH;
 var init_generator = __esmMin((() => {
+	init_emit();
+	init_picklist_types();
 	init_type_mapper();
 	FIELD_KINDS = /* @__PURE__ */ new Set([
 		"date",
@@ -277,7 +428,6 @@ var init_generator = __esmMin((() => {
 		"time",
 		"multipicklist"
 	]);
-	IDENTIFIER$1 = /^[A-Za-z_$][A-Za-z0-9_$]*$/;
 	RESERVED_TYPE_NAMES = /* @__PURE__ */ new Set([
 		"Record",
 		"Pick",
@@ -397,7 +547,12 @@ var init_validate_config = __esmMin((() => {
 		],
 		sfCli: ["targetOrg"]
 	};
-	PICKLIST_MODES = ["union", "string"];
+	PICKLIST_MODES = [
+		"union",
+		"string",
+		"const",
+		"enum"
+	];
 	IDENTIFIER = /^[A-Za-z][A-Za-z0-9_]*$/;
 	VALIDATORS = {
 		$schema: (value, { problem }) => {
@@ -417,7 +572,7 @@ var init_validate_config = __esmMin((() => {
 		excludeCreateFields: (value, context) => validateFieldMap("excludeCreateFields", value, context),
 		excludeUpdateFields: (value, context) => validateFieldMap("excludeUpdateFields", value, context),
 		picklists: (value, { problem }) => {
-			if (!PICKLIST_MODES.includes(value)) problem(`picklists: must be "union" or "string", got ${show(value)}.`);
+			if (!PICKLIST_MODES.includes(value)) problem(`picklists: must be one of ${PICKLIST_MODES.join(", ")}, got ${show(value)}.`);
 		},
 		constants: (value, { problem }) => {
 			if (typeof value !== "boolean") problem(`constants: must be true or false, got ${show(value)}.`);
@@ -759,13 +914,24 @@ var init_init = __esmMin((() => {
 			label: "JWT bearer (certificate-based, runs as a user)"
 		}
 	];
-	PICKLIST_CHOICES = [{
-		value: "union",
-		label: "Union of values, e.g. \"New\" | \"Closed\" (type-safe)"
-	}, {
-		value: "string",
-		label: "Plain string"
-	}];
+	PICKLIST_CHOICES = [
+		{
+			value: "union",
+			label: "Union of values, e.g. \"New\" | \"Closed\" (type-safe)"
+		},
+		{
+			value: "string",
+			label: "Plain string"
+		},
+		{
+			value: "const",
+			label: "Union plus a named constant per picklist, e.g. CaseStatus.Closed"
+		},
+		{
+			value: "enum",
+			label: "TypeScript enum per picklist (restricted picklists only accept enum members)"
+		}
+	];
 	FORMAT_CHOICES = [{
 		value: "ts",
 		label: "TypeScript (sobjectly.config.ts, type-checked with defineConfig)"
@@ -1105,6 +1271,6 @@ var init_codegen = __esmMin((() => {
 	};
 }));
 //#endregion
-export { validateConfig as C, FIELD_TYPE_MAP as D, readGeneratedHashes as E, init_type_mapper as O, init_validate_config as S, init_generator as T, defineConfig as _, init_prompter as a, CONFIG_OPTIONS as b, init_init as c, runInit as d, CONFIG_FILE_NAMES as f, loadConfig as g, init_load_config as h, resolveAuth as i, mapFieldType as k, parseSObjects as l, findConfigFiles as m, generate as n, readlinePrompter as o, findConfigFile as p, init_codegen as r, AUTH_ENV_VARS as s, checkGenerated as t, renderConfig as u, init_config as v, generateSource as w, CodegenConfigError as x, AUTH_OPTIONS as y };
+export { mapFieldType as A, init_validate_config as C, readGeneratedHashes as D, init_generator as E, FIELD_TYPE_MAP as O, PICKLIST_MODES as S, generateSource as T, defineConfig as _, init_prompter as a, CONFIG_OPTIONS as b, init_init as c, runInit as d, CONFIG_FILE_NAMES as f, loadConfig as g, init_load_config as h, resolveAuth as i, init_type_mapper as k, parseSObjects as l, findConfigFiles as m, generate as n, readlinePrompter as o, findConfigFile as p, init_codegen as r, AUTH_ENV_VARS as s, checkGenerated as t, renderConfig as u, init_config as v, validateConfig as w, CodegenConfigError as x, AUTH_OPTIONS as y };
 
-//# sourceMappingURL=codegen-CSx0WAtK.mjs.map
+//# sourceMappingURL=codegen-C6MEYiWo.mjs.map