@cerios/salesforce-sobjectly 0.0.0-stage → 1.0.0

package/dist/codegen.d.mts

@@ -0,0 +1,312 @@
+import { E as AuthProvider, O as HttpTransport, a as FieldDescribe, c as RecordTypeInfo, t as ChildRelationship, u as ApiVersion } from "./describe-Dj3J8o-x.mjs";
+//#region src/codegen/config.d.ts
+/** Client credentials read from environment variables (defaults shown). */
+interface EnvClientCredentialsAuth {
+  type: "clientCredentials";
+  /** Defaults to `SF_LOGIN_URL` (your My Domain URL). */
+  loginUrlEnv?: string;
+  /** Defaults to `SF_CLIENT_ID`. */
+  clientIdEnv?: string;
+  /** Defaults to `SF_CLIENT_SECRET`. */
+  clientSecretEnv?: string;
+}
+/** An access token read from environment variables (defaults shown), e.g. from `sf org display`. */
+interface EnvAccessTokenAuth {
+  type: "accessToken";
+  /** Defaults to `SF_ACCESS_TOKEN`. */
+  accessTokenEnv?: string;
+  /** Defaults to `SF_INSTANCE_URL`. */
+  instanceUrlEnv?: string;
+}
+/** JWT bearer flow with values read from environment variables (defaults shown). */
+interface EnvJwtBearerAuth {
+  type: "jwtBearer";
+  /** Defaults to `SF_LOGIN_URL`. */
+  loginUrlEnv?: string;
+  /** Defaults to `SF_CLIENT_ID`. */
+  clientIdEnv?: string;
+  /** Defaults to `SF_USERNAME`. */
+  usernameEnv?: string;
+  /** The PEM key itself. Defaults to `SF_PRIVATE_KEY`. */
+  privateKeyEnv?: string;
+  /** A path to the PEM key file, used when the key variable is empty. Defaults to `SF_PRIVATE_KEY_PATH`. */
+  privateKeyPathEnv?: string;
+}
+/** An auth setting that reads credentials from environment variables. The only kind a JSON config can use. */
+/** An org you are logged into with the Salesforce CLI (`sf org login web --alias my-org`). */
+interface SfCliAuth {
+  type: "sfCli";
+  /** The org alias or username. Defaults to the CLI's default org. */
+  targetOrg?: string;
+}
+type EnvAuth = EnvClientCredentialsAuth | EnvAccessTokenAuth | EnvJwtBearerAuth | SfCliAuth;
+/** Env-based auth, or any auth provider (TypeScript configs only). */
+type CodegenAuth = EnvAuth | AuthProvider;
+type PicklistMode =
+/** Every picklist is `string`. */
+"string" |
+/** Restricted picklists become a union of their values; unrestricted ones `"A" | "B" | (string & {})`. */
+"union";
+/**
+ * The codegen config. `S` is the union of the listed sObject names; `defineConfig` infers it, so
+ * per-sObject options such as `excludeCreateFields` only accept listed names.
+ */
+interface CodegenConfig<S extends string = string> {
+  /** Output file, relative to the config file's directory, e.g. `"src/generated/sobjects.ts"`. */
+  output: string;
+  /**
+   * The API version to describe with, e.g. `"v66.0"`. Required. It is also written to the
+   * generated file as `API_VERSION`, so the client can use the same version.
+   */
+  apiVersion: ApiVersion;
+  /**
+   * sObjects to generate. Strongly recommended: without it every queryable sObject in the org
+   * is generated, which can be thousands of types.
+   */
+  sobjects?: readonly S[];
+  /** sObjects to skip (applied after `sobjects`). */
+  exclude?: readonly string[];
+  /** How to authenticate. Defaults to client credentials from `SF_LOGIN_URL`, `SF_CLIENT_ID` and `SF_CLIENT_SECRET`. */
+  auth?: CodegenAuth;
+  /** Fields to leave out of the create input per sObject (e.g. fields describe marks createable but REST rejects). */
+  excludeCreateFields?: Partial<Record<NoInfer<S>, readonly string[]>>;
+  /** Fields to leave out of the update input per sObject. */
+  excludeUpdateFields?: Partial<Record<NoInfer<S>, readonly string[]>>;
+  /** How picklists are typed. Defaults to `"union"`. */
+  picklists?: PicklistMode;
+  /** Emit the `PICKLIST_VALUES` and `RECORD_TYPES` runtime constants. Defaults to `true`. */
+  constants?: boolean;
+  /** Parallel describe calls. Defaults to 10. */
+  concurrency?: number;
+  /** Skip sObjects whose describe fails instead of failing the run. Defaults to `false`. */
+  continueOnDescribeError?: boolean;
+  /** Where the generated file imports helper types from. Defaults to `"@cerios/salesforce-sobjectly"`. */
+  importSource?: string;
+  /** Post-processes the generated source, e.g. with your formatter. TypeScript configs only. */
+  format?: (source: string, filePath: string) => string | Promise<string>;
+  /** A custom transport for the describe calls (e.g. behind a proxy). TypeScript configs only. */
+  transport?: HttpTransport;
+}
+/**
+ * The shape of `sobjectly.config.json`: everything that can be written as JSON (no functions,
+ * no auth providers). `$schema` points editors at the bundled JSON Schema.
+ */
+type JsonCodegenConfig = Omit<CodegenConfig, "auth" | "format" | "transport"> & {
+  $schema?: string;
+  auth?: EnvAuth;
+};
+/**
+ * Type-checks a `sobjectly.config.ts`. The listed `sobjects` become a literal union, so a typo in
+ * a per-sObject option is a compile error:
+ *
+ * ```ts
+ * export default defineConfig({
+ * 	apiVersion: "v66.0",
+ * 	output: "src/generated/sobjects.ts",
+ * 	sobjects: ["Account", "Contact"],
+ * 	excludeCreateFields: { Acount: ["Name"] }, // ❌ "Acount" is not in sobjects
+ * });
+ * ```
+ */
+export declare function defineConfig<const S extends string = string>(config: CodegenConfig<S>): CodegenConfig<S>;
+//#endregion
+//#region src/codegen/type-mapper.d.ts
+/** The subset of a field describe the generator needs. */
+type CodegenField = Pick<FieldDescribe, "name" | "label" | "type" | "nillable" | "createable" | "updateable" | "defaultedOnCreate" | "referenceTo" | "relationshipName"> & Partial<Pick<FieldDescribe, "picklistValues" | "restrictedPicklist" | "externalId" | "idLookup">>;
+/** Maps each Salesforce field type to a TypeScript type. Types not listed become `unknown`. */
+export declare const FIELD_TYPE_MAP: Readonly<Record<string, string>>;
+/** Returns the TypeScript type for a field, including `| null` for nillable fields. */
+export declare function mapFieldType(field: CodegenField, picklists?: PicklistMode): string;
+//#endregion
+//#region src/codegen/generator.d.ts
+/** The subset of an sObject describe the generator needs. */
+interface CodegenDescribe {
+  name: string;
+  label?: string;
+  fields: CodegenField[];
+  childRelationships: Pick<ChildRelationship, "childSObject" | "field" | "relationshipName">[];
+  recordTypeInfos?: Pick<RecordTypeInfo, "developerName">[];
+}
+interface GenerateSourceOptions {
+  excludeCreateFields?: Partial<Record<string, readonly string[]>>;
+  excludeUpdateFields?: Partial<Record<string, readonly string[]>>;
+  picklists?: PicklistMode;
+  importSource?: string;
+  /** When set, the output exports it as `API_VERSION`, so the client can use the same version. */
+  apiVersion?: ApiVersion;
+  /** Emit the `PICKLIST_VALUES` and `RECORD_TYPES` runtime constants. Defaults to `true`. */
+  constants?: boolean;
+}
+/**
+ * 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.
+ * The output is deterministic: sObjects are sorted by name and fields by name (`Id` first).
+ */
+export declare function generateSource(describes: readonly CodegenDescribe[], options?: GenerateSourceOptions): string;
+/** The content hashes a generated file records in its header. */
+interface GeneratedFileHashes {
+  /** SHA-256 of the unformatted generated content; formatting changes don't affect it. */
+  contentHash: string;
+  /** Short hash per sObject, to tell which sObjects changed. */
+  sobjects: Map<string, string>;
+}
+/** Reads the content hashes from a generated file's header (also after reformatting). */
+export declare function readGeneratedHashes(source: string): GeneratedFileHashes | undefined;
+//#endregion
+//#region src/codegen/load-config.d.ts
+/** Config file names, in lookup order. */
+export declare const CONFIG_FILE_NAMES: string[];
+/** Looks for a `sobjectly.config.{ts,mts,cts,json}` file in `cwd`; the first match in lookup order wins. */
+export declare function findConfigFile(cwd?: string): string | undefined;
+/** Every `sobjectly.config.*` file in `cwd`, in lookup order. */
+export declare function findConfigFiles(cwd?: string): string[];
+/**
+ * Loads and validates a TypeScript (`.ts`, `.mts`, `.cts`) or JSON config file. Returns the
+ * config and the directory it lives in. Throws a `CodegenConfigError` listing every problem.
+ */
+export declare function loadConfig(configPath: string): Promise<{
+  config: CodegenConfig;
+  directory: string;
+}>;
+//#endregion
+//#region src/codegen/validate-config.d.ts
+/** Thrown when a codegen config is invalid. Lists every problem found. */
+export declare class CodegenConfigError extends Error {
+  readonly source: string;
+  readonly problems: string[];
+  readonly name: string;
+  constructor(source: string, problems: string[]);
+}
+/** The env-variable options each env-based auth type accepts. */
+export declare const AUTH_OPTIONS: Record<EnvAuth["type"], readonly string[]>;
+/** The options a config may contain. */
+export declare const CONFIG_OPTIONS: readonly string[];
+/**
+ * Checks a loaded config and returns it typed. Throws a `CodegenConfigError` listing every
+ * problem. `json` disallows the options that only a TypeScript config can express.
+ */
+export declare function validateConfig(value: unknown, options: {
+  source: string;
+  json?: boolean;
+}): CodegenConfig;
+//#endregion
+//#region src/codegen/prompter.d.ts
+interface Choice<T extends string> {
+  value: T;
+  label: string;
+}
+/** Asks questions. The CLI uses `readlinePrompter`; tests pass a scripted implementation. */
+interface Prompter {
+  /** Asks for text. `validate` returns an error message to ask again, or `undefined` to accept. */
+  ask(question: string, options?: {
+    defaultValue?: string;
+    validate?: (answer: string) => string | undefined;
+  }): Promise<string>;
+  /** Asks to pick one of `choices`, by number or value. */
+  choose<T extends string>(question: string, choices: readonly Choice<T>[], defaultValue: T): Promise<T>;
+  /** Asks a yes/no question. */
+  confirm(question: string, defaultValue: boolean): Promise<boolean>;
+  close(): void;
+}
+/**
+ * A prompter on stdin/stdout (or the given streams). Lines are queued as they arrive, so piped
+ * input (`printf "v66.0\n..." | sobjectly init`) works too. If the input ends before a question
+ * is answered, the question rejects.
+ */
+export declare function readlinePrompter(input?: NodeJS.ReadableStream, output?: NodeJS.WritableStream): Prompter;
+//#endregion
+//#region src/codegen/init.d.ts
+type InitAuthType = "clientCredentials" | "accessToken" | "jwtBearer" | "sfCli";
+type InitConfigFormat = "ts" | "json";
+interface InitAnswers {
+  apiVersion: ApiVersion;
+  output: string;
+  sobjects: string[];
+  auth: InitAuthType;
+  /** The Salesforce CLI org alias, for `auth: "sfCli"`. Omitted means the CLI's default org. */
+  targetOrg?: string;
+  picklists: PicklistMode;
+  format: InitConfigFormat;
+}
+interface InitOptions {
+  cwd: string;
+  prompter: Prompter;
+  log: (message: string) => void;
+  /** Answers given up front (e.g. CLI flags); those questions are skipped. */
+  preset?: Partial<InitAnswers>;
+  /** Accept the suggested answer for every question not in `preset`. `apiVersion` must then be preset. */
+  yes?: boolean;
+  /** Overwrite an existing config without asking. */
+  force?: boolean;
+}
+interface InitResult {
+  /** `undefined` when the user chose not to overwrite an existing config. */
+  configPath: string | undefined;
+  answers?: InitAnswers;
+  envExampleUpdated?: boolean;
+  scriptAdded?: boolean;
+}
+/** The environment variables each auth type reads by default. */
+export declare const AUTH_ENV_VARS: Record<InitAuthType, string[]>;
+/**
+ * Creates a `sobjectly.config` file by asking for the API version, output path, sObjects, auth
+ * method, picklist mode and file format. Optionally adds the auth variables to `.env.example`
+ * and an npm script to `package.json`.
+ */
+export declare function runInit(options: InitOptions): Promise<InitResult>;
+/** Splits a comma/space separated list of sObject names, removing duplicates. */
+export declare function parseSObjects(answer: string): string[];
+/** Renders the config file in the chosen format. */
+export declare function renderConfig(answers: InitAnswers): string;
+//#endregion
+//#region src/codegen/index.d.ts
+export interface CodegenLogger {
+  info(message: string): void;
+  warn(message: string): void;
+}
+export interface GenerateOptions {
+  /** Directory that `output` is resolved against. Defaults to `process.cwd()`. */
+  cwd?: string;
+  logger?: CodegenLogger;
+  /** Environment to read credentials from. Defaults to `process.env`. */
+  env?: Record<string, string | undefined>;
+  /** Write the file. Defaults to `true`; with `false` the source is only returned. */
+  write?: boolean;
+}
+export interface GenerateResult {
+  outputPath: string;
+  /** The concrete API version the types were generated with. */
+  apiVersion: ApiVersion;
+  sobjects: string[];
+  skipped: {
+    name: string;
+    error: string;
+  }[];
+  /** The generated source (after the `format` hook). */
+  source: string;
+  /** SHA-256 of the unformatted content, as recorded in the file header. */
+  contentHash: string;
+}
+export interface CheckResult {
+  /** `true` when the file on disk has the same content (formatting differences are ignored). */
+  upToDate: boolean;
+  /** Why the file is out of date. */
+  reason?: "missing" | "changed";
+  outputPath: string;
+  /** sObjects that would be added, removed or changed (known when the file has hash headers). */
+  added: string[];
+  removed: string[];
+  changed: string[];
+}
+/** Describes the configured sObjects and writes the generated types to `config.output`. */
+export declare function generate(input: CodegenConfig, options?: GenerateOptions): Promise<GenerateResult>;
+/**
+ * Checks whether the generated file on disk is up to date with the org, without writing it.
+ * Only content counts: a file reformatted by Prettier, oxfmt or the `format` hook is up to date.
+ */
+export declare function checkGenerated(input: CodegenConfig, options?: GenerateOptions): Promise<CheckResult>;
+/** Turns the config's auth setting into an auth provider, reading env-based credentials. */
+export declare function resolveAuth(auth: CodegenAuth | undefined, env: Record<string, string | undefined>): AuthProvider;
+//#endregion
+export type { Choice, CodegenAuth, CodegenConfig, CodegenDescribe, CodegenField, EnvAccessTokenAuth, EnvAuth, EnvClientCredentialsAuth, EnvJwtBearerAuth, GenerateSourceOptions, GeneratedFileHashes, InitAnswers, InitAuthType, InitConfigFormat, InitOptions, InitResult, JsonCodegenConfig, PicklistMode, Prompter, SfCliAuth };
+//# sourceMappingURL=codegen.d.mts.map

package/dist/codegen.mjs

@@ -0,0 +1,10 @@
+import { C as validateConfig, D as FIELD_TYPE_MAP, E as readGeneratedHashes, O as init_type_mapper, S as init_validate_config, T as init_generator, _ as defineConfig, a as init_prompter, b as CONFIG_OPTIONS, c as init_init, d as runInit, f as CONFIG_FILE_NAMES, g as loadConfig, h as init_load_config, i as resolveAuth, k as mapFieldType, l as parseSObjects, m as findConfigFiles, n as generate, o as readlinePrompter, p as findConfigFile, r as init_codegen, s as AUTH_ENV_VARS, t as checkGenerated, u as renderConfig, v as init_config, w as generateSource, x as CodegenConfigError, y as AUTH_OPTIONS } from "./codegen-CSx0WAtK.mjs";
+init_type_mapper();
+init_generator();
+init_validate_config();
+init_config();
+init_load_config();
+init_init();
+init_prompter();
+init_codegen();
+export { AUTH_ENV_VARS, AUTH_OPTIONS, CONFIG_FILE_NAMES, CONFIG_OPTIONS, CodegenConfigError, FIELD_TYPE_MAP, checkGenerated, defineConfig, findConfigFile, findConfigFiles, generate, generateSource, loadConfig, mapFieldType, parseSObjects, readGeneratedHashes, readlinePrompter, renderConfig, resolveAuth, runInit, validateConfig };

package/dist/describe-Dj3J8o-x.d.cts

@@ -0,0 +1,284 @@
+//#region src/http/transport.d.ts
+type HttpMethod = "GET" | "POST" | "PATCH" | "PUT" | "DELETE" | "HEAD";
+/** A fully prepared HTTP request handed to a transport. */
+interface TransportRequest {
+  method: HttpMethod;
+  url: URL;
+  headers: Headers;
+  body?: string | Uint8Array;
+  /** Aborts the request (covers both caller cancellation and the client timeout). */
+  signal?: AbortSignal;
+  /** The client timeout in milliseconds, for transports that take it as an option instead of a signal. */
+  timeoutMs?: number;
+}
+/** A buffered HTTP response returned by a transport. Non-2xx statuses must be returned, not thrown. */
+interface TransportResponse {
+  status: number;
+  headers: Headers;
+  body: Uint8Array;
+}
+/** A response whose body arrives as a stream of chunks. */
+interface StreamingTransportResponse {
+  status: number;
+  headers: Headers;
+  body: AsyncIterable<Uint8Array>;
+}
+/**
+ * The only thing the client needs from an HTTP library. Implement it to plug in any client
+ * (undici, axios, got, a logging wrapper, ...). See `fetchTransport`.
+ */
+interface HttpTransport {
+  send(request: TransportRequest): Promise<TransportResponse>;
+  /**
+   * Optional: sends a request and streams the response body. Used for large downloads such as
+   * Bulk API results; transports without it fall back to `send`.
+   */
+  stream?(request: TransportRequest): Promise<StreamingTransportResponse>;
+}
+//#endregion
+//#region src/auth/types.d.ts
+/** An access token together with the instance it is valid for. */
+interface AccessToken {
+  accessToken: string;
+  /** The org's instance URL, e.g. `https://mydomain.my.salesforce.com`. API calls go here. */
+  instanceUrl: string;
+  /** Optional expiry in epoch milliseconds. When set, the token is refreshed shortly before it expires. */
+  expiresAt?: number;
+}
+interface AuthContext {
+  /** The client's transport, so token requests use the same HTTP stack as API calls. */
+  transport: HttpTransport;
+  signal?: AbortSignal;
+}
+/**
+ * Supplies access tokens to the client. Implementations should cache tokens; the client calls
+ * `getToken` before every request.
+ */
+interface AuthProvider {
+  getToken(context: AuthContext): Promise<AccessToken>;
+  /**
+   * Called when Salesforce answered 401 for `token`. Providers that can obtain a new token
+   * should drop it from their cache; the client then retries the request once.
+   */
+  invalidate?(token: AccessToken): void;
+}
+//#endregion
+//#region src/types/error-codes.d.ts
+/**
+ * Common Salesforce error codes: record-level `StatusCode` values (in save results) and
+ * call-level `ExceptionCode` values (in REST error bodies). Salesforce has hundreds more, so the
+ * type stays open (`string & {}`) while giving autocomplete for these.
+ */
+type KnownSalesforceErrorCode = "ALL_OR_NONE_OPERATION_ROLLED_BACK" | "ALREADY_IN_PROCESS" | "CANNOT_EXECUTE_FLOW_TRIGGER" | "CANNOT_INSERT_UPDATE_ACTIVATE_ENTITY" | "CANNOT_UPDATE_CONVERTED_LEAD" | "CIRCULAR_DEPENDENCY" | "DELETE_FAILED" | "DEPENDENCY_EXISTS" | "DUPLICATE_EXTERNAL_ID" | "DUPLICATE_VALUE" | "DUPLICATES_DETECTED" | "ENTITY_IS_ARCHIVED" | "ENTITY_IS_DELETED" | "ENTITY_IS_LOCKED" | "FIELD_CUSTOM_VALIDATION_EXCEPTION" | "FIELD_FILTER_VALIDATION_EXCEPTION" | "FIELD_INTEGRITY_EXCEPTION" | "FILE_SIZE_LIMIT_EXCEEDED" | "FLOW_EXCEPTION" | "INACTIVE_OWNER_OR_USER" | "INSUFFICIENT_ACCESS" | "INSUFFICIENT_ACCESS_ON_CROSS_REFERENCE_ENTITY" | "INSUFFICIENT_ACCESS_OR_READONLY" | "INVALID_CROSS_REFERENCE_KEY" | "INVALID_EMAIL_ADDRESS" | "INVALID_FIELD_FOR_INSERT_UPDATE" | "INVALID_ID_FIELD" | "INVALID_OPERATION" | "INVALID_OR_NULL_FOR_RESTRICTED_PICKLIST" | "INVALID_RECORD_TYPE" | "INVALID_STATUS" | "INVALID_TYPE_ON_FIELD_IN_RECORD" | "LIMIT_EXCEEDED" | "MALFORMED_ID" | "MANAGER_NOT_DEFINED" | "MAXIMUM_SIZE_OF_DOCUMENT" | "MISSING_ARGUMENT" | "NO_APPLICABLE_PROCESS" | "NUMBER_OUTSIDE_VALID_RANGE" | "OPERATION_ENQUEUED" | "PLATFORM_EVENT_PUBLISH_FAILED" | "PLATFORM_EVENT_PUBLISHING_UNAVAILABLE" | "PROCESSING_HALTED" | "REQUIRED_FIELD_MISSING" | "STORAGE_LIMIT_EXCEEDED" | "STRING_TOO_LONG" | "TOO_MANY_APEX_REQUESTS" | "UNABLE_TO_LOCK_ROW" | "UNKNOWN_EXCEPTION" | "API_CURRENTLY_DISABLED" | "API_DISABLED_FOR_ORG" | "APEX_REST_SERVICES_DISABLED" | "ENTITY_NOT_QUERYABLE" | "EXCEEDED_ID_LIMIT" | "EXCEEDED_MAX_SEMIJOIN_SUBSELECTS" | "FUNCTIONALITY_NOT_ENABLED" | "INTERNAL_ERROR" | "INVALID_BATCH_SIZE" | "INVALID_FIELD" | "INVALID_ID" | "INVALID_LOGIN" | "INVALID_QUERY_FILTER_OPERATOR" | "INVALID_QUERY_LOCATOR" | "INVALID_SESSION_ID" | "INVALID_TYPE" | "INVALID_VERSION" | "JSON_PARSER_ERROR" | "MALFORMED_QUERY" | "MIXED_DML_OPERATION" | "MULTIPLE_RECORDS_FOUND" | "NOT_FOUND" | "NOT_MODIFIED" | "OPERATION_TOO_LARGE" | "QUERY_TIMEOUT" | "QUERY_TOO_COMPLICATED" | "REQUEST_LIMIT_EXCEEDED" | "REQUEST_RUNNING_TOO_LONG" | "SERVER_UNAVAILABLE" | "UNSUPPORTED_API_VERSION";
+/** A Salesforce error code: autocomplete for the common ones, any string accepted. */
+type SalesforceErrorCode = KnownSalesforceErrorCode | (string & {});
+//#endregion
+//#region src/types/common.d.ts
+/** A Salesforce REST API version such as `"v66.0"`. */
+type ApiVersion = `v${number}.${number}`;
+/** The `attributes` object Salesforce adds to every record it returns. */
+interface RecordAttributes {
+  type: string;
+  /** Absent in some contexts, such as aggregate query rows. */
+  url?: string;
+}
+/** Adds the Salesforce `attributes` object to a record type. */
+type WithAttributes<T> = T & {
+  attributes: RecordAttributes;
+};
+/** An untyped record, used when no generated registry is supplied. */
+type GenericRecord = Record<string, unknown>;
+/** An item of the error array Salesforce returns for a non-2xx REST response. */
+interface RestError {
+  message: string;
+  errorCode: SalesforceErrorCode;
+  fields?: string[];
+  [key: string]: unknown;
+}
+/** An error inside a save/delete/upsert result. Note: `statusCode`, not `errorCode`. */
+interface SaveError {
+  statusCode: SalesforceErrorCode;
+  message: string;
+  fields: string[];
+  extendedErrorDetails?: unknown;
+}
+interface SaveResult {
+  /** Absent when the operation failed. */
+  id?: string;
+  success: boolean;
+  errors: SaveError[];
+}
+interface UpsertResult extends SaveResult {
+  /** `true` when the record was inserted, `false` when an existing record was updated. */
+  created?: boolean;
+}
+type DeleteResult = SaveResult;
+/** The raw shape of a `/query`, `/queryAll` or `/tooling/query` response page. */
+interface QueryResponse<T> {
+  totalSize: number;
+  done: boolean;
+  nextRecordsUrl?: string;
+  records: T[];
+}
+/** A Salesforce compound address field value. */
+interface SalesforceAddress {
+  city: string | null;
+  country: string | null;
+  countryCode: string | null;
+  geocodeAccuracy: string | null;
+  latitude: number | null;
+  longitude: number | null;
+  postalCode: string | null;
+  state: string | null;
+  stateCode: string | null;
+  street: string | null;
+}
+/** A Salesforce compound geolocation (`location`) field value. */
+interface SalesforceGeolocation {
+  latitude: number | null;
+  longitude: number | null;
+}
+//#endregion
+//#region src/types/describe.d.ts
+/** Every field `type` a describe call can report. */
+type FieldType = "id" | "boolean" | "string" | "textarea" | "picklist" | "multipicklist" | "combobox" | "reference" | "currency" | "double" | "percent" | "int" | "long" | "date" | "datetime" | "time" | "url" | "email" | "phone" | "encryptedstring" | "base64" | "address" | "location" | "anyType" | "complexvalue" | "datacategorygroupreference";
+interface PicklistEntry {
+  active: boolean;
+  defaultValue: boolean;
+  label: string | null;
+  validFor: string | null;
+  value: string;
+}
+interface FieldDescribe {
+  name: string;
+  label: string;
+  /** Usually a {@link FieldType}; typed as `string` because Salesforce adds types over time. */
+  type: FieldType | (string & {});
+  soapType: string;
+  length: number;
+  byteLength: number;
+  precision: number;
+  scale: number;
+  digits: number;
+  nillable: boolean;
+  createable: boolean;
+  updateable: boolean;
+  defaultedOnCreate: boolean;
+  defaultValue: unknown;
+  defaultValueFormula: string | null;
+  calculated: boolean;
+  calculatedFormula: string | null;
+  autoNumber: boolean;
+  unique: boolean;
+  externalId: boolean;
+  idLookup: boolean;
+  nameField: boolean;
+  caseSensitive: boolean;
+  filterable: boolean;
+  sortable: boolean;
+  groupable: boolean;
+  aggregatable: boolean;
+  custom: boolean;
+  deprecatedAndHidden: boolean;
+  encrypted: boolean;
+  htmlFormatted: boolean;
+  inlineHelpText: string | null;
+  picklistValues: PicklistEntry[];
+  restrictedPicklist: boolean;
+  dependentPicklist: boolean;
+  controllerName: string | null;
+  /** Non-empty only for lookup and master-detail fields. More than one entry means a polymorphic lookup. */
+  referenceTo: string[];
+  /** The relationship name used for SOQL traversal, e.g. `"Account"` for `AccountId`. */
+  relationshipName: string | null;
+  relationshipOrder: number | null;
+  polymorphicForeignKey: boolean;
+  cascadeDelete: boolean;
+  restrictedDelete: boolean;
+  writeRequiresMasterRead: boolean;
+  compoundFieldName: string | null;
+  extraTypeInfo: string | null;
+  [key: string]: unknown;
+}
+interface ChildRelationship {
+  cascadeDelete: boolean;
+  /** API name of the child sObject, e.g. `"Case"` for Account's `Cases` relationship. */
+  childSObject: string;
+  deprecatedAndHidden: boolean;
+  /** The field on the child that points to this sObject. */
+  field: string;
+  junctionIdListNames: string[];
+  junctionReferenceTo: string[];
+  /** The name used in a nested SOQL subquery, e.g. `"Cases"`; `null` when not queryable. */
+  relationshipName: string | null;
+  restrictedDelete: boolean;
+}
+interface RecordTypeInfo {
+  active: boolean;
+  available: boolean;
+  defaultRecordTypeMapping: boolean;
+  developerName: string;
+  master: boolean;
+  name: string;
+  recordTypeId: string;
+  urls: Record<string, string>;
+}
+/** An entry of the `/sobjects` (describe global) response. */
+interface DescribeGlobalSObject {
+  activateable: boolean;
+  createable: boolean;
+  custom: boolean;
+  customSetting: boolean;
+  deletable: boolean;
+  deprecatedAndHidden: boolean;
+  feedEnabled: boolean;
+  hasSubtypes: boolean;
+  isInterface: boolean;
+  isSubtype: boolean;
+  keyPrefix: string | null;
+  label: string;
+  labelPlural: string;
+  layoutable: boolean;
+  mergeable: boolean;
+  mruEnabled: boolean;
+  name: string;
+  queryable: boolean;
+  replicateable: boolean;
+  retrieveable: boolean;
+  searchable: boolean;
+  triggerable: boolean;
+  undeletable: boolean;
+  updateable: boolean;
+  urls: Record<string, string>;
+  [key: string]: unknown;
+}
+interface DescribeGlobalResult {
+  encoding: string;
+  maxBatchSize: number;
+  sobjects: DescribeGlobalSObject[];
+}
+/** The `/sobjects/{name}/describe` response. */
+interface DescribeSObjectResult extends DescribeGlobalSObject {
+  childRelationships: ChildRelationship[];
+  fields: FieldDescribe[];
+  recordTypeInfos: RecordTypeInfo[];
+  compactLayoutable: boolean;
+  listviewable: boolean | null;
+  lookupLayoutable: boolean | null;
+  searchLayoutable: boolean;
+  networkScopeFieldName: string | null;
+  supportedScopes: {
+    label: string;
+    name: string;
+  }[];
+  actionOverrides: unknown[];
+  namedLayoutInfos: unknown[];
+}
+/** The `/sobjects/{name}` (basic information) response. */
+interface SObjectBasicInfo {
+  objectDescribe: DescribeGlobalSObject;
+  recentItems: Record<string, unknown>[];
+}
+//#endregion
+export { TransportRequest as A, SalesforceErrorCode as C, HttpMethod as D, AuthProvider as E, HttpTransport as O, KnownSalesforceErrorCode as S, AuthContext as T, SalesforceGeolocation as _, FieldDescribe as a, UpsertResult as b, RecordTypeInfo as c, DeleteResult as d, GenericRecord as f, SalesforceAddress as g, RestError as h, DescribeSObjectResult as i, TransportResponse as j, StreamingTransportResponse as k, SObjectBasicInfo as l, RecordAttributes as m, DescribeGlobalResult as n, FieldType as o, QueryResponse as p, DescribeGlobalSObject as r, PicklistEntry as s, ChildRelationship as t, ApiVersion as u, SaveError as v, AccessToken as w, WithAttributes as x, SaveResult as y };
+//# sourceMappingURL=describe-Dj3J8o-x.d.cts.map