@cerios/salesforce-sobjectly 0.0.0-stage → 1.0.0

package/package.json

@@ -1,6 +1,113 @@
 {
-  "name": "@cerios/salesforce-sobjectly",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+	"name": "@cerios/salesforce-sobjectly",
+	"version": "1.0.0",
+	"description": "Type-safe Salesforce REST API client for TypeScript. Generated SObject types, a typed SOQL builder, CRUD, composite, sObject collections, SOSL, invocable actions/Flow, Tooling API and Bulk API 2.0.",
+	"keywords": [
+		"api",
+		"bulk-api",
+		"cerios",
+		"codegen",
+		"composite",
+		"crm",
+		"rest",
+		"salesforce",
+		"sobject",
+		"soql",
+		"sosl",
+		"tooling-api",
+		"type-safe",
+		"typescript"
+	],
+	"homepage": "https://github.com/CeriosTesting/salesforce-sobjectly#readme",
+	"bugs": {
+		"url": "https://github.com/CeriosTesting/salesforce-sobjectly/issues"
+	},
+	"license": "MIT",
+	"author": "Ronald Veth - Cerios",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/CeriosTesting/salesforce-sobjectly.git"
+	},
+	"bin": {
+		"sobjectly": "dist/cli.cjs"
+	},
+	"files": [
+		"dist",
+		"sobjectly.config.schema.json"
+	],
+	"type": "commonjs",
+	"sideEffects": false,
+	"main": "./dist/index.cjs",
+	"module": "./dist/index.mjs",
+	"types": "./dist/index.d.cts",
+	"exports": {
+		".": {
+			"import": {
+				"types": "./dist/index.d.mts",
+				"default": "./dist/index.mjs"
+			},
+			"require": {
+				"types": "./dist/index.d.cts",
+				"default": "./dist/index.cjs"
+			}
+		},
+		"./codegen": {
+			"import": {
+				"types": "./dist/codegen.d.mts",
+				"default": "./dist/codegen.mjs"
+			},
+			"require": {
+				"types": "./dist/codegen.d.cts",
+				"default": "./dist/codegen.cjs"
+			}
+		},
+		"./sobjectly.config.schema.json": "./sobjectly.config.schema.json",
+		"./package.json": "./package.json"
+	},
+	"publishConfig": {
+		"access": "public",
+		"provenance": true
+	},
+	"scripts": {
+		"build": "tsdown",
+		"changeset": "changeset",
+		"check-exports": "attw --pack . --profile node16",
+		"compile": "tsc --noEmit",
+		"deps:update": "npx npm-check-updates -u --dep prod,dev,optional,peer,packageManager --install never && npm install",
+		"format": "oxfmt",
+		"format:check": "oxfmt --check",
+		"lint": "oxlint --type-aware",
+		"lint:fix": "oxlint --type-aware --fix",
+		"pack": "npm pack",
+		"prepare": "husky",
+		"release": "changeset publish",
+		"test": "vitest --run",
+		"test:coverage": "vitest --run --coverage",
+		"test:integration": "vitest --run --config vitest.integration.config.mts",
+		"test:smoke": "node scripts/smoke.mjs",
+		"test:watch": "vitest --watch",
+		"version-packages": "changeset version",
+		"version-packages:prepare-release": "npm run version-packages && npm run format"
+	},
+	"dependencies": {
+		"jiti": "^2.7.0"
+	},
+	"devDependencies": {
+		"@arethetypeswrong/cli": "^0.18.5",
+		"@changesets/cli": "^3.0.3",
+		"@types/node": "^26.6.3",
+		"@vitest/coverage-v8": "5.0.3",
+		"husky": "^9.1.7",
+		"lint-staged": "^17.6.0",
+		"npm-check-updates": "^23.1.0",
+		"oxfmt": "^0.71.0",
+		"oxlint": "^1.86.0",
+		"oxlint-tsgolint": "^7.0.2003",
+		"tsdown": "^0.23.0",
+		"typescript": "^7.0.2",
+		"vitest": "^5.0.3"
+	},
+	"engines": {
+		"node": ">=20.19.0"
+	}
+}

package/sobjectly.config.schema.json

@@ -0,0 +1,147 @@
+{
+	"$schema": "http://json-schema.org/draft-07/schema#",
+	"$id": "https://unpkg.com/@cerios/salesforce-sobjectly/sobjectly.config.schema.json",
+	"title": "sobjectly config",
+	"description": "Configuration for `sobjectly generate` (@cerios/salesforce-sobjectly).",
+	"type": "object",
+	"additionalProperties": false,
+	"required": ["apiVersion", "output"],
+	"properties": {
+		"$schema": {
+			"type": "string",
+			"description": "The JSON Schema for this file."
+		},
+		"apiVersion": {
+			"type": "string",
+			"pattern": "^v\\d+\\.\\d+$",
+			"description": "The Salesforce REST API version to describe with, e.g. \"v66.0\". Exported as API_VERSION in the generated file.",
+			"examples": ["v66.0"]
+		},
+		"output": {
+			"type": "string",
+			"pattern": "\\.(ts|mts|cts)$",
+			"description": "The generated TypeScript file, relative to this config file.",
+			"examples": ["src/generated/sobjects.ts"]
+		},
+		"sobjects": {
+			"type": "array",
+			"description": "The sObjects to generate types for. Without it, every queryable sObject is generated.",
+			"items": { "$ref": "#/definitions/sobjectName" },
+			"examples": [["Account", "Contact"]]
+		},
+		"exclude": {
+			"type": "array",
+			"description": "sObjects to skip.",
+			"items": { "$ref": "#/definitions/sobjectName" }
+		},
+		"auth": {
+			"description": "How the generator logs in. Credentials are read from environment variables. Defaults to client credentials from SF_LOGIN_URL, SF_CLIENT_ID and SF_CLIENT_SECRET.",
+			"oneOf": [
+				{
+					"type": "object",
+					"additionalProperties": false,
+					"required": ["type"],
+					"properties": {
+						"type": { "const": "clientCredentials" },
+						"loginUrlEnv": {
+							"$ref": "#/definitions/envName",
+							"description": "Defaults to SF_LOGIN_URL (your My Domain URL)."
+						},
+						"clientIdEnv": { "$ref": "#/definitions/envName", "description": "Defaults to SF_CLIENT_ID." },
+						"clientSecretEnv": { "$ref": "#/definitions/envName", "description": "Defaults to SF_CLIENT_SECRET." }
+					}
+				},
+				{
+					"type": "object",
+					"additionalProperties": false,
+					"required": ["type"],
+					"properties": {
+						"type": { "const": "accessToken" },
+						"accessTokenEnv": { "$ref": "#/definitions/envName", "description": "Defaults to SF_ACCESS_TOKEN." },
+						"instanceUrlEnv": { "$ref": "#/definitions/envName", "description": "Defaults to SF_INSTANCE_URL." }
+					}
+				},
+				{
+					"type": "object",
+					"additionalProperties": false,
+					"required": ["type"],
+					"properties": {
+						"type": { "const": "jwtBearer" },
+						"loginUrlEnv": { "$ref": "#/definitions/envName", "description": "Defaults to SF_LOGIN_URL." },
+						"clientIdEnv": { "$ref": "#/definitions/envName", "description": "Defaults to SF_CLIENT_ID." },
+						"usernameEnv": { "$ref": "#/definitions/envName", "description": "Defaults to SF_USERNAME." },
+						"privateKeyEnv": {
+							"$ref": "#/definitions/envName",
+							"description": "The PEM key itself. Defaults to SF_PRIVATE_KEY."
+						},
+						"privateKeyPathEnv": {
+							"$ref": "#/definitions/envName",
+							"description": "A path to the PEM key file. Defaults to SF_PRIVATE_KEY_PATH."
+						}
+					}
+				},
+				{
+					"type": "object",
+					"additionalProperties": false,
+					"required": ["type"],
+					"properties": {
+						"type": { "const": "sfCli" },
+						"targetOrg": {
+							"type": "string",
+							"minLength": 1,
+							"description": "The Salesforce CLI org alias or username. Defaults to the CLI's default org."
+						}
+					}
+				}
+			]
+		},
+		"excludeCreateFields": {
+			"$ref": "#/definitions/fieldMap",
+			"description": "Per sObject, fields to leave out of the create input."
+		},
+		"excludeUpdateFields": {
+			"$ref": "#/definitions/fieldMap",
+			"description": "Per sObject, fields to leave out of the update input."
+		},
+		"picklists": {
+			"enum": ["union", "string"],
+			"description": "\"union\" (default): picklists become unions of their values. \"string\": plain strings."
+		},
+		"constants": {
+			"type": "boolean",
+			"description": "Emit the PICKLIST_VALUES and RECORD_TYPES runtime constants. Defaults to true."
+		},
+		"concurrency": {
+			"type": "integer",
+			"minimum": 1,
+			"description": "Parallel describe calls. Defaults to 10."
+		},
+		"continueOnDescribeError": {
+			"type": "boolean",
+			"description": "Skip sObjects whose describe fails instead of failing the run. Defaults to false."
+		},
+		"importSource": {
+			"type": "string",
+			"minLength": 1,
+			"description": "Where the generated file imports helper types from. Defaults to \"@cerios/salesforce-sobjectly\"."
+		}
+	},
+	"definitions": {
+		"sobjectName": {
+			"type": "string",
+			"pattern": "^[A-Za-z][A-Za-z0-9_]*$"
+		},
+		"envName": {
+			"type": "string",
+			"minLength": 1
+		},
+		"fieldMap": {
+			"type": "object",
+			"propertyNames": { "$ref": "#/definitions/sobjectName" },
+			"additionalProperties": {
+				"type": "array",
+				"items": { "type": "string", "minLength": 1 }
+			}
+		}
+	}
+}