KysoqlAPI reference
Codegen API reference
Generated API reference for schema generation, Describe clients, rendering, field filters, and configuration in @kysoql/codegen.
Functions
| Function | Description |
|---|---|
| loadSchema | Loads and validates Salesforce object metadata, then applies configured field filters. |
| generateSchema | Loads Salesforce metadata and writes the rendered TypeScript schema to disk. |
| defineConfig | Provide completion without reading files or contacting Salesforce. |
| renderSchema | Renders Salesforce object metadata as a TypeScript Kysoql schema module. |
| createRestDescribeClient | Native metadata transport. No JSforce import or dependency is needed. |
Interfaces
| Interface | Description |
|---|---|
| GenerateSchemaOptions | Options for generating a TypeScript Kysoql schema from Salesforce Describe metadata. |
| KysoqlConfig | Schema-generation settings. Authentication is resolved explicitly. |
| SalesforceChildRelationshipDescription | Child-relationship metadata required to render relationship subqueries. |
| SalesforceDataCategoryGroupDescription | Flattened data-category group stored in generated schema metadata. |
| SalesforceDataCategoryGroupResponse | Data-category group returned by the Salesforce metadata APIs. |
| SalesforceDataCategoryGroupsResponse | Container returned when describing Salesforce data-category groups. |
| SalesforceDataCategorySummaryResponse | Recursive data-category entry returned by the Salesforce metadata APIs. |
| SalesforceDescribeClient | Describe client contract used by schema loading and generation. |
| SalesforceFieldDescription | Field metadata required to render a generated Kysoql schema. |
| SalesforceGlobalDescription | Subset of the Salesforce global describe response consumed by code generation. |
| SalesforceGlobalObjectDescription | Minimal global-describe metadata used to identify queryable Salesforce objects. |
| SalesforceObjectDescription | Salesforce object metadata consumed by the schema renderer. |
| SalesforcePicklistValue | Picklist value metadata consumed by schema generation. |
| SalesforceSupportedScopeDescription | Supported Salesforce USING SCOPE metadata for an object. |
Type Aliases
| Type Alias | Description |
|---|---|
| ObjectFieldFilter | Exact field API names; include and exclude are mutually exclusive. |
| ObjectFieldFilters | Rules do not add objects to the generation set. |
| SalesforceAuthProvider | Resolve a fresh Salesforce OAuth session for CLI schema generation. |