@workos/oagen 0.1.0 → 0.2.0

package/dist/index.d.ts

@@ -1,277 +0,0 @@
-import { M as Model, A as ApiSpec, a as ApiSurface, O as OverlayLookup, E as Enum, S as Service, b as Operation, c as Extractor } from './types-B5t9O9Wm.js';
-export { d as ArrayType, e as AuthScheme, f as EnumRef, g as EnumValue, h as ErrorResponse, F as Field, H as HttpMethod, L as LiteralType, i as MapType, j as ModelRef, N as NullableType, P as PaginationMeta, k as Parameter, l as PrimitiveType, m as ServerEntry, n as SuccessResponse, T as TypeParam, o as TypeRef, U as UnionType, p as assertNever, q as mapTypeRef, w as walkTypeRef } from './types-B5t9O9Wm.js';
-
-/**
- * Structured error hierarchy for oagen.
- *
- * Every error carries a human-readable `hint` that suggests a recovery action.
- * The hint is appended to the `message` so it appears in stack traces and logs.
- */
-/** Base class for all oagen errors. */
-declare class OagenError extends Error {
-    readonly hint: string;
-    constructor(message: string, hint: string);
-}
-/** Thrown when a command should terminate with a specific exit code. */
-declare class CommandError extends OagenError {
-    readonly exitCode: number;
-    constructor(message: string, hint: string, exitCode: number);
-}
-/** Thrown when an OpenAPI spec cannot be parsed or has an unsupported version. */
-declare class SpecParseError extends OagenError {
-    constructor(message: string, hint: string);
-}
-/** Thrown when configuration files (manifests, API surfaces, overlays) are missing or malformed. */
-declare class ConfigError extends OagenError {
-    constructor(message: string, hint: string);
-}
-/** Thrown when a config file exists but cannot be loaded or evaluated. */
-declare class ConfigLoadError extends ConfigError {
-    constructor(message: string, hint: string);
-}
-/** Thrown when a config targets a different IR version than the installed package. */
-declare class ConfigVersionMismatchError extends ConfigError {
-    constructor(message: string, hint: string);
-}
-/** Thrown when an API surface extractor encounters a problem. */
-declare class ExtractorError extends OagenError {
-    constructor(message: string, hint: string);
-}
-/** Thrown when a requested language or extractor is not found in a registry. */
-declare class RegistryError extends OagenError {
-    constructor(message: string, hint: string);
-}
-/** Thrown for internal invariant violations that indicate a bug. */
-declare class InternalError extends OagenError {
-    constructor(message: string, hint: string);
-}
-
-interface GeneratedFile {
-    path: string;
-    content: string;
-    skipIfExists?: boolean;
-    headerPlacement?: 'prepend' | 'skip';
-    /** When false, exclude this file from --target integration. Defaults to true. */
-    integrateTarget?: boolean;
-}
-interface EmitterContext {
-    namespace: string;
-    namespacePascal: string;
-    spec: ApiSpec;
-    outputDir?: string;
-    apiSurface?: ApiSurface;
-    overlayLookup?: OverlayLookup;
-}
-interface Emitter {
-    language: string;
-    generateModels(models: Model[], ctx: EmitterContext): GeneratedFile[];
-    generateEnums(enums: Enum[], ctx: EmitterContext): GeneratedFile[];
-    generateResources(services: Service[], ctx: EmitterContext): GeneratedFile[];
-    generateClient(spec: ApiSpec, ctx: EmitterContext): GeneratedFile[];
-    generateErrors(ctx: EmitterContext): GeneratedFile[];
-    generateConfig(ctx: EmitterContext): GeneratedFile[];
-    generateTypeSignatures?(spec: ApiSpec, ctx: EmitterContext): GeneratedFile[];
-    generateTests(spec: ApiSpec, ctx: EmitterContext): GeneratedFile[];
-    /** Optional: generate a smoke-manifest.json mapping operationIds to SDK methods */
-    generateManifest?(spec: ApiSpec, ctx: EmitterContext): GeneratedFile[];
-    fileHeader(): string;
-}
-
-interface DiffReport {
-    oldVersion: string;
-    newVersion: string;
-    changes: Change[];
-    summary: {
-        added: number;
-        removed: number;
-        modified: number;
-        breaking: number;
-        additive: number;
-    };
-}
-type Change = ModelAdded | ModelRemoved | ModelModified | EnumAdded | EnumRemoved | EnumModified | ServiceAdded | ServiceRemoved | OperationAdded | OperationRemoved | OperationModified;
-interface ModelAdded {
-    kind: 'model-added';
-    name: string;
-    classification: 'additive';
-}
-interface ModelRemoved {
-    kind: 'model-removed';
-    name: string;
-    classification: 'breaking';
-}
-interface ModelModified {
-    kind: 'model-modified';
-    name: string;
-    fieldChanges: FieldChange[];
-    classification: 'additive' | 'breaking';
-}
-interface FieldChange {
-    kind: 'field-added' | 'field-removed' | 'field-type-changed' | 'field-required-changed' | 'field-access-changed';
-    fieldName: string;
-    classification: 'additive' | 'breaking';
-    details?: string;
-}
-interface EnumAdded {
-    kind: 'enum-added';
-    name: string;
-    classification: 'additive';
-}
-interface EnumRemoved {
-    kind: 'enum-removed';
-    name: string;
-    classification: 'breaking';
-}
-interface EnumModified {
-    kind: 'enum-modified';
-    name: string;
-    valueChanges: EnumValueChange[];
-    classification: 'additive' | 'breaking';
-}
-interface EnumValueChange {
-    kind: 'value-added' | 'value-removed' | 'value-changed';
-    valueName: string;
-    classification: 'additive' | 'breaking';
-    details?: string;
-}
-interface ServiceAdded {
-    kind: 'service-added';
-    name: string;
-    classification: 'additive';
-}
-interface ServiceRemoved {
-    kind: 'service-removed';
-    name: string;
-    classification: 'breaking';
-}
-interface OperationAdded {
-    kind: 'operation-added';
-    serviceName: string;
-    operationName: string;
-    classification: 'additive';
-}
-interface OperationRemoved {
-    kind: 'operation-removed';
-    serviceName: string;
-    operationName: string;
-    classification: 'breaking';
-}
-interface OperationModified {
-    kind: 'operation-modified';
-    serviceName: string;
-    operationName: string;
-    paramChanges: ParamChange[];
-    responseChanged: boolean;
-    requestBodyChanged: boolean;
-    httpMethodChanged: boolean;
-    pathChanged: boolean;
-    paginatedChanged: boolean;
-    injectIdempotencyKeyChanged: boolean;
-    errorsChanged: boolean;
-    classification: 'additive' | 'breaking';
-}
-interface ParamChange {
-    kind: 'param-added' | 'param-removed' | 'param-type-changed' | 'param-required-changed';
-    paramName: string;
-    classification: 'additive' | 'breaking';
-}
-
-interface ParseOptions {
-    operationIdTransform?: (id: string) => string;
-}
-declare function parseSpec(specPath: string, options?: ParseOptions): Promise<ApiSpec>;
-
-declare function generate(spec: ApiSpec, emitter: Emitter, options: {
-    namespace: string;
-    dryRun?: boolean;
-    outputDir: string;
-    target?: string;
-    apiSurface?: ApiSurface;
-    overlayLookup?: OverlayLookup;
-}): Promise<GeneratedFile[]>;
-
-declare function buildEmitterContext(spec: ApiSpec, options: {
-    namespace: string;
-    outputDir: string;
-    apiSurface?: ApiSurface;
-    overlayLookup?: OverlayLookup;
-}): EmitterContext;
-/** Collect all generated files from an emitter (no headers, no path prefixes). */
-declare function generateAllFiles(spec: ApiSpec, emitter: Emitter, ctx: EmitterContext): GeneratedFile[];
-/** Apply file header to generated files, respecting headerPlacement and JSON files. */
-declare function applyFileHeaders(files: GeneratedFile[], header: string): GeneratedFile[];
-declare function generateFiles(spec: ApiSpec, emitter: Emitter, options: {
-    namespace: string;
-    outputDir: string;
-    apiSurface?: ApiSurface;
-    overlayLookup?: OverlayLookup;
-}): {
-    files: GeneratedFile[];
-    ctx: EmitterContext;
-    header: string;
-};
-
-interface WriteResult {
-    written: string[];
-    merged: string[];
-    skipped: string[];
-    identical: string[];
-    ignored: string[];
-}
-
-declare function mapFilesForTargetIntegration(files: GeneratedFile[], language: string): GeneratedFile[];
-declare function integrateGeneratedFiles(opts: {
-    files: GeneratedFile[];
-    language: string;
-    targetDir: string;
-    header: string;
-}): Promise<WriteResult>;
-
-declare function registerEmitter(emitter: Emitter): void;
-declare function getEmitter(language: string): Emitter;
-
-declare function diffSpecs(oldSpec: ApiSpec, newSpec: ApiSpec): DiffReport;
-
-declare const ACRONYM_SET: Set<string>;
-declare function toPascalCase(s: string, acronyms?: Set<string>): string;
-declare function toCamelCase(s: string, acronyms?: Set<string>): string;
-declare function toSnakeCase(s: string): string;
-declare function toKebabCase(s: string): string;
-declare function toUpperSnakeCase(s: string): string;
-declare function stripBackendPrefixes(name: string): string;
-declare function cleanSchemaName(name: string): string;
-
-interface OperationPlan {
-    operation: Operation;
-    isDelete: boolean;
-    hasBody: boolean;
-    isIdempotentPost: boolean;
-    pathParamsInOptions: boolean;
-    isPaginated: boolean;
-    responseModelName: string | null;
-    isModelResponse: boolean;
-    hasQueryParams: boolean;
-    isAsync: boolean;
-}
-declare function planOperation(op: Operation): OperationPlan;
-
-interface OagenConfig {
-    emitters?: Emitter[];
-    extractors?: Extractor[];
-    /** Path to the emitter project (where skills scaffold new emitters, tests, smoke runners). */
-    emitterProject?: string;
-    /** Map from language key to custom smoke runner script path. */
-    smokeRunners?: Record<string, string>;
-    /**
-     * Custom transform for operation IDs. When provided, replaces the default
-     * camelCase pass-through. Receives the raw operationId string; return the
-     * desired operation name (no additional conversion is applied).
-     *
-     */
-    operationIdTransform?: (id: string) => string;
-    /** Base URL for documentation links. When set, relative paths in descriptions
-     *  (e.g. `/reference/authkit/user`) are expanded to full URLs. */
-    docUrl?: string;
-}
-
-export { ACRONYM_SET, ApiSpec, type Change, CommandError, ConfigError, ConfigLoadError, ConfigVersionMismatchError, type DiffReport, type Emitter, type EmitterContext, Enum, type EnumAdded, type EnumModified, type EnumRemoved, type EnumValueChange, ExtractorError, type FieldChange, type GeneratedFile, InternalError, Model, type ModelAdded, type ModelModified, type ModelRemoved, type OagenConfig, OagenError, Operation, type OperationAdded, type OperationModified, type OperationPlan, type OperationRemoved, type ParamChange, RegistryError, Service, type ServiceAdded, type ServiceRemoved, SpecParseError, applyFileHeaders, buildEmitterContext, cleanSchemaName, diffSpecs, generate, generateAllFiles, generateFiles, getEmitter, integrateGeneratedFiles, mapFilesForTargetIntegration, parseSpec, planOperation, registerEmitter, stripBackendPrefixes, toCamelCase, toKebabCase, toPascalCase, toSnakeCase, toUpperSnakeCase };