@cerios/salesforce-sobjectly 0.0.0-stage → 1.1.0

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

@@ -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.mts.map

package/dist/index.cjs

@@ -0,0 +1,65 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_sf_cli = require("./sf-cli-R6LHwqoo.cjs");
+exports.ActionsApi = require_sf_cli.ActionsApi;
+exports.ApexExecutionError = require_sf_cli.ApexExecutionError;
+exports.ApprovalsApi = require_sf_cli.ApprovalsApi;
+exports.BulkApi = require_sf_cli.BulkApi;
+exports.BulkIngestJob = require_sf_cli.BulkIngestJob;
+exports.BulkQueryJob = require_sf_cli.BulkQueryJob;
+exports.CollectionsApi = require_sf_cli.CollectionsApi;
+exports.CompositeApi = require_sf_cli.CompositeApi;
+exports.CompositeRequestBuilder = require_sf_cli.CompositeRequestBuilder;
+exports.CompositeResponse = require_sf_cli.CompositeResponse;
+exports.CsvRowParser = require_sf_cli.CsvRowParser;
+exports.DEBUG_LEVEL_NAME = require_sf_cli.DEBUG_LEVEL_NAME;
+exports.DEFAULT_DEBUG_LEVELS = require_sf_cli.DEFAULT_DEBUG_LEVELS;
+exports.DebugLogCaptureError = require_sf_cli.DebugLogCaptureError;
+exports.DebugLogsApi = require_sf_cli.DebugLogsApi;
+exports.EventsApi = require_sf_cli.EventsApi;
+exports.FilesApi = require_sf_cli.FilesApi;
+exports.MAX_JSON_UPLOAD_BYTES = require_sf_cli.MAX_JSON_UPLOAD_BYTES;
+exports.MAX_UPLOAD_BYTES = require_sf_cli.MAX_UPLOAD_BYTES;
+exports.MetadataCache = require_sf_cli.MetadataCache;
+exports.QueryApi = require_sf_cli.QueryApi;
+exports.QuickActionsApi = require_sf_cli.QuickActionsApi;
+exports.ReportsApi = require_sf_cli.ReportsApi;
+exports.SObjectResource = require_sf_cli.SObjectResource;
+exports.SalesforceAuthError = require_sf_cli.SalesforceAuthError;
+exports.SalesforceBulkJobError = require_sf_cli.SalesforceBulkJobError;
+exports.SalesforceClient = require_sf_cli.SalesforceClient;
+exports.SalesforceConnection = require_sf_cli.SalesforceConnection;
+exports.SalesforceError = require_sf_cli.SalesforceError;
+exports.SalesforcePartialFailureError = require_sf_cli.SalesforcePartialFailureError;
+exports.SalesforceSaveError = require_sf_cli.SalesforceSaveError;
+exports.SearchApi = require_sf_cli.SearchApi;
+exports.SoqlQueryBuilder = require_sf_cli.SoqlQueryBuilder;
+exports.ToolingApi = require_sf_cli.ToolingApi;
+exports.TypeOfBuilder = require_sf_cli.TypeOfBuilder;
+exports.UiApi = require_sf_cli.UiApi;
+exports.accessToken = require_sf_cli.accessToken;
+exports.buildMultipart = require_sf_cli.buildMultipart;
+exports.clientCredentials = require_sf_cli.clientCredentials;
+exports.createJwtAssertion = require_sf_cli.createJwtAssertion;
+exports.fetchTransport = require_sf_cli.fetchTransport;
+exports.hasErrorCode = require_sf_cli.hasErrorCode;
+exports.isApiVersion = require_sf_cli.isApiVersion;
+exports.isSObjectType = require_sf_cli.isSObjectType;
+exports.isSalesforceError = require_sf_cli.isSalesforceError;
+exports.jwtBearer = require_sf_cli.jwtBearer;
+exports.normalizeApiVersion = require_sf_cli.normalizeApiVersion;
+exports.parseCsv = require_sf_cli.parseCsv;
+exports.parseCsvRows = require_sf_cli.parseCsvRows;
+exports.parseCsvStream = require_sf_cli.parseCsvStream;
+exports.refreshToken = require_sf_cli.refreshToken;
+exports.reportRows = require_sf_cli.reportRows;
+exports.sfCli = require_sf_cli.sfCli;
+exports.soqlDate = require_sf_cli.soqlDate;
+exports.soqlDateLiteral = require_sf_cli.soqlDateLiteral;
+exports.soqlEscape = require_sf_cli.soqlEscape;
+exports.soqlEscapeDateOnly = require_sf_cli.soqlEscapeDateOnly;
+exports.soqlFor = require_sf_cli.soqlFor;
+exports.soqlLiteral = require_sf_cli.soqlLiteral;
+exports.soslEscape = require_sf_cli.soslEscape;
+exports.toCsv = require_sf_cli.toCsv;
+exports.toPublishResult = require_sf_cli.toPublishResult;
+exports.tokenProvider = require_sf_cli.tokenProvider;