@workos/oagen 0.1.1 → 0.3.0

package/dist/types-B5t9O9Wm.d.ts

@@ -1,367 +0,0 @@
-/** Authentication scheme extracted from OpenAPI securitySchemes */
-type AuthScheme = {
-    kind: 'bearer';
-} | {
-    kind: 'apiKey';
-    in: 'header' | 'query' | 'cookie';
-    name: string;
-} | {
-    kind: 'oauth2';
-    flows: Record<string, unknown>;
-};
-/** Root IR node representing the full API surface */
-/** A server entry from the OpenAPI servers array */
-interface ServerEntry {
-    url: string;
-    description?: string;
-}
-/** Root IR node representing the full API surface */
-interface ApiSpec {
-    name: string;
-    version: string;
-    description?: string;
-    baseUrl: string;
-    servers?: ServerEntry[];
-    services: Service[];
-    models: Model[];
-    enums: Enum[];
-    auth?: AuthScheme[];
-}
-/** A service groups related operations (maps to an SDK resource class) */
-interface Service {
-    name: string;
-    description?: string;
-    operations: Operation[];
-}
-/** A single API operation (maps to an SDK method) */
-interface Operation {
-    name: string;
-    description?: string;
-    httpMethod: HttpMethod;
-    path: string;
-    pathParams: Parameter[];
-    queryParams: Parameter[];
-    headerParams: Parameter[];
-    cookieParams?: Parameter[];
-    requestBody?: TypeRef;
-    requestBodyEncoding?: 'json' | 'form-data' | 'form-urlencoded' | 'binary' | 'text';
-    response: TypeRef;
-    successResponses?: SuccessResponse[];
-    errors: ErrorResponse[];
-    pagination?: PaginationMeta;
-    injectIdempotencyKey: boolean;
-    deprecated?: boolean;
-    async?: boolean;
-}
-/** Structured pagination metadata for auto-paging iterator generation */
-interface PaginationMeta {
-    strategy: 'cursor' | 'offset' | 'link-header';
-    param: string;
-    limitParam?: string;
-    dataPath?: string;
-    itemType: TypeRef;
-}
-type HttpMethod = 'get' | 'post' | 'put' | 'patch' | 'delete' | 'head' | 'options' | 'trace';
-interface Parameter {
-    name: string;
-    type: TypeRef;
-    required: boolean;
-    description?: string;
-    deprecated?: boolean;
-    default?: unknown;
-    example?: unknown;
-}
-/** Type reference — the core type system of the IR */
-type TypeRef = PrimitiveType | ArrayType | ModelRef | EnumRef | UnionType | NullableType | LiteralType | MapType;
-interface PrimitiveType {
-    kind: 'primitive';
-    type: 'string' | 'integer' | 'number' | 'boolean' | 'unknown';
-    format?: string;
-}
-interface ArrayType {
-    kind: 'array';
-    items: TypeRef;
-}
-interface ModelRef {
-    kind: 'model';
-    name: string;
-}
-interface EnumRef {
-    kind: 'enum';
-    name: string;
-    values?: (string | number)[];
-}
-interface LiteralType {
-    kind: 'literal';
-    value: string | number | boolean | null;
-}
-interface UnionType {
-    kind: 'union';
-    variants: TypeRef[];
-    discriminator?: {
-        property: string;
-        mapping: Record<string, string>;
-    };
-    /** Which OAS composition keyword produced this union. Emitters can use this to
-     *  distinguish inheritance (allOf) from exclusive union (oneOf) from open union (anyOf). */
-    compositionKind?: 'allOf' | 'oneOf' | 'anyOf';
-}
-interface NullableType {
-    kind: 'nullable';
-    inner: TypeRef;
-}
-interface MapType {
-    kind: 'map';
-    valueType: TypeRef;
-    keyType?: TypeRef;
-}
-/**
- * A generic type parameter on a model.
- * Example: `DirectoryUser<TCustomAttributes = Record<string, unknown>>`
- * → `{ name: 'TCustomAttributes', default: { kind: 'map', valueType: { kind: 'primitive', type: 'unknown' } } }`
- */
-interface TypeParam {
-    name: string;
-    /** Default type when the param is not specified. */
-    default?: TypeRef;
-}
-/** Model definition (maps to an SDK model/data class) */
-interface Model {
-    name: string;
-    description?: string;
-    fields: Field[];
-    /** Generic type parameters. Empty/undefined for non-generic models. */
-    typeParams?: TypeParam[];
-}
-interface Field {
-    name: string;
-    type: TypeRef;
-    required: boolean;
-    description?: string;
-    readOnly?: boolean;
-    writeOnly?: boolean;
-    deprecated?: boolean;
-    default?: unknown;
-}
-/** Enum definition */
-interface Enum {
-    name: string;
-    values: EnumValue[];
-}
-interface EnumValue {
-    name: string;
-    value: string | number;
-    description?: string;
-    deprecated?: boolean;
-}
-/**
- * Exhaustive check helper for TypeRef switches.
- * If a new kind is added to TypeRef, any switch that doesn't handle it
- * will fail to compile because `never` won't accept the unhandled variant.
- *
- * Usage:
- *   switch (ref.kind) {
- *     case 'primitive': ...
- *     case 'array': ...
- *     // If you forget 'literal', TypeScript errors here:
- *     default: assertNever(ref);
- *   }
- */
-declare function assertNever(x: never): never;
-/**
- * Generic depth-first walker for TypeRef trees.
- * Handles recursion into array/nullable/union/map children and provides
- * an exhaustive `assertNever` check so callers don't need to repeat the
- * switch boilerplate.  Supply callbacks only for the leaf kinds you care about.
- */
-declare function walkTypeRef(ref: TypeRef, visitor: {
-    model?: (ref: ModelRef) => void;
-    enum?: (ref: EnumRef) => void;
-    primitive?: (ref: PrimitiveType) => void;
-    literal?: (ref: LiteralType) => void;
-}): void;
-/**
- * Generic depth-first mapper for TypeRef trees.
- * Like walkTypeRef but returns a transformed value instead of void.
- * Handles recursion into array/nullable/union/map children, passing
- * already-mapped child values to the parent callback.
- */
-declare function mapTypeRef<T>(ref: TypeRef, mapper: {
-    primitive: (ref: PrimitiveType) => T;
-    array: (ref: ArrayType, mappedItems: T) => T;
-    model: (ref: ModelRef) => T;
-    enum: (ref: EnumRef) => T;
-    union: (ref: UnionType, mappedVariants: T[]) => T;
-    nullable: (ref: NullableType, mappedInner: T) => T;
-    literal: (ref: LiteralType) => T;
-    map: (ref: MapType, mappedValue: T, mappedKey?: T) => T;
-}): T;
-interface ErrorResponse {
-    statusCode: number;
-    type?: TypeRef;
-}
-/** A successful response entry from a 2xx status code */
-interface SuccessResponse {
-    statusCode: number;
-    type: TypeRef;
-}
-
-interface ApiSurface {
-    language: string;
-    extractedFrom: string;
-    extractedAt: string;
-    classes: Record<string, ApiClass>;
-    interfaces: Record<string, ApiInterface>;
-    typeAliases: Record<string, ApiTypeAlias>;
-    enums: Record<string, ApiEnum>;
-    exports: Record<string, string[]>;
-}
-interface ApiClass {
-    name: string;
-    sourceFile?: string;
-    methods: Record<string, ApiMethod[]>;
-    properties: Record<string, ApiProperty>;
-    constructorParams: ApiParam[];
-}
-interface ApiMethod {
-    name: string;
-    params: ApiParam[];
-    returnType: string;
-    async: boolean;
-}
-interface ApiParam {
-    name: string;
-    type: string;
-    optional: boolean;
-}
-interface ApiProperty {
-    name: string;
-    type: string;
-    readonly: boolean;
-}
-interface ApiInterface {
-    name: string;
-    sourceFile?: string;
-    fields: Record<string, ApiField>;
-    extends: string[];
-}
-interface ApiField {
-    name: string;
-    type: string;
-    optional: boolean;
-}
-interface ApiTypeAlias {
-    name: string;
-    sourceFile?: string;
-    value: string;
-}
-interface ApiEnum {
-    name: string;
-    sourceFile?: string;
-    members: Record<string, string | number>;
-}
-interface LanguageHints {
-    /** Strip nullable wrapper, return inner type. null if not nullable.
-     *  Node: "string | null" → "string"
-     *  Go: "*Organization" → "Organization"
-     *  Python: "Optional[str]" → "str" */
-    stripNullable(type: string): string | null;
-    /** True if a and b differ only by nullability. */
-    isNullableOnlyDifference(a: string, b: string): boolean;
-    /** True if a and b are union types with same members in different order. */
-    isUnionReorder(a: string, b: string): boolean;
-    /** True if type is a generic type parameter the extractor can't resolve. */
-    isGenericTypeParam(type: string): boolean;
-    /** True if type is an extraction artifact (extractor couldn't resolve).
-     *  Node: "any"; Python: "Any"; Go: "interface{}" */
-    isExtractionArtifact(type: string): boolean;
-    /** Whether a missing type alias should be tolerated when the candidate
-     *  has the same name as an interface or class (TS allows this). */
-    tolerateCategoryMismatch: boolean;
-    /** Extract innermost meaningful type name from a return type string.
-     *  Node: "Promise<AutoPaginatable<Organization>>" → "Organization" */
-    extractReturnTypeName(returnType: string): string | null;
-    /** Extract meaningful type name from a param type string. null for primitives. */
-    extractParamTypeName(paramType: string): string | null;
-    /** True if sdkResourceProperty maps to className.
-     *  Node: camelCase ("organizations" → "Organizations")
-     *  Ruby: snake_case ("organizations" → "Organizations") */
-    propertyMatchesClass(propertyName: string, className: string): boolean;
-    /** Additional names derived from a model name by this language's emitter.
-     *  Node: ["FooResponse", "SerializedFoo"]
-     *  Go: ["FooResponse"] */
-    derivedModelNames(modelName: string): string[];
-    /** True if two type strings are semantically equivalent even when
-     *  structurally different — e.g., a named enum vs an inline union
-     *  of its string literal values. The candidate surface is provided
-     *  so the hint can look up enum definitions.
-     *  Returns true to suppress the mismatch, false to report it. */
-    isTypeEquivalent?(baselineType: string, candidateType: string, candidateSurface: ApiSurface): boolean;
-    /** True if two method signatures should be considered equivalent despite
-     *  structural differences. Called as a fallback when strict positional
-     *  matching fails — e.g., when the baseline unpacks body fields into
-     *  individual params while the candidate uses a dict/array payload.
-     *  Returns true to suppress the mismatch. */
-    isSignatureEquivalent?(baseline: ApiMethod, candidate: ApiMethod, candidateSurface: ApiSurface): boolean;
-    /** Base class names that indicate a data model (→ ApiInterface).
-     *  Python: ["BaseModel"]; PHP: ["BaseResource"].
-     *  Extractors should provide these for their SDK. */
-    modelBaseClasses?: string[];
-    /** Base class names that indicate an exception class.
-     *  Python: ["Exception", "BaseException"]; PHP: ["Exception"]. */
-    exceptionBaseClasses?: string[];
-    /** Type names for list/paginated resource wrappers (for return type unwrapping).
-     *  The first type argument is extracted as the inner item type.
-     *  e.g., ["ListResource"] causes `ListResource[Org, ...]` → `Org`. */
-    listResourcePatterns?: string[];
-}
-interface Extractor {
-    language: string;
-    extract(sdkPath: string): Promise<ApiSurface>;
-    hints: LanguageHints;
-}
-interface MethodOverlay {
-    className: string;
-    methodName: string;
-    params: ApiParam[];
-    returnType: string;
-}
-interface OverlayLookup {
-    /** HTTP method + path → existing method info */
-    methodByOperation: Map<string, MethodOverlay>;
-    /** Reverse map: "ClassName.methodName" → HTTP key for patchOverlay */
-    httpKeyByMethod: Map<string, string>;
-    /** IR interface name → existing interface name */
-    interfaceByName: Map<string, string>;
-    /** IR type alias name → existing type alias name */
-    typeAliasByName: Map<string, string>;
-    /** Barrel file path → symbols that must be exported */
-    requiredExports: Map<string, Set<string>>;
-    /** IR model name → SDK interface name (auto-inferred from field structure) */
-    modelNameByIR: Map<string, string>;
-    /** IR symbol name → relative file path in the live SDK */
-    fileBySymbol: Map<string, string>;
-}
-type ViolationCategory = 'public-api' | 'signature' | 'export-structure' | 'behavioral' | 'staleness';
-type ViolationSeverity = 'breaking' | 'warning';
-interface Violation {
-    category: ViolationCategory;
-    severity: ViolationSeverity;
-    symbolPath: string;
-    baseline: string;
-    candidate: string;
-    message: string;
-}
-interface Addition {
-    symbolPath: string;
-    symbolType: 'class' | 'method' | 'interface' | 'type-alias' | 'enum' | 'property';
-}
-interface DiffResult {
-    preservationScore: number;
-    totalBaselineSymbols: number;
-    preservedSymbols: number;
-    violations: Violation[];
-    additions: Addition[];
-}
-
-export { type ApiSpec as A, type ApiProperty as B, type ApiTypeAlias as C, type DiffResult as D, type Enum as E, type Field as F, type MethodOverlay as G, type HttpMethod as H, type ViolationCategory as I, type ViolationSeverity as J, type LiteralType as L, type Model as M, type NullableType as N, type OverlayLookup as O, type PaginationMeta as P, type Service as S, type TypeParam as T, type UnionType as U, type Violation as V, type ApiSurface as a, type Operation as b, type Extractor as c, type ArrayType as d, type AuthScheme as e, type EnumRef as f, type EnumValue as g, type ErrorResponse as h, type MapType as i, type ModelRef as j, type Parameter as k, type PrimitiveType as l, type ServerEntry as m, type SuccessResponse as n, type TypeRef as o, assertNever as p, mapTypeRef as q, type LanguageHints as r, type Addition as s, type ApiClass as t, type ApiEnum as u, type ApiField as v, walkTypeRef as w, type ApiInterface as x, type ApiMethod as y, type ApiParam as z };

package/dist/verify/index.d.ts

@@ -1,76 +0,0 @@
-import { D as DiffResult, V as Violation, a as ApiSurface, A as ApiSpec } from '../types-B5t9O9Wm.js';
-
-interface VerifyDiagnostics {
-    compatCheck?: {
-        totalBaselineSymbols: number;
-        preservedSymbols: number;
-        preservationScore: number;
-        violationsByCategory: Record<string, number>;
-        violationsBySeverity: Record<string, number>;
-        additions: number;
-        scopedToSpec: boolean;
-        scopedSymbolCount?: number;
-    };
-    stalenessCheck?: {
-        staleSymbolCount: number;
-        staleSymbols: string[];
-    };
-    smokeCheck?: {
-        passed: boolean;
-        findingsCount?: number;
-        compileErrors?: boolean;
-    };
-    retryLoop?: {
-        attempts: number;
-        converged: boolean;
-        finalScore: number;
-        patchedPerIteration: number[];
-    };
-}
-interface CompatCheckResult {
-    passed: boolean;
-    diff: DiffResult;
-    scopedToSpec: boolean;
-    scopedSymbolCount?: number;
-}
-interface OverlayRetryResult {
-    status: 'passed' | 'max-retries' | 'no-patchable' | 'stalled';
-    attempts: number;
-    patchedPerIteration: number[];
-    compatResult: CompatCheckResult;
-}
-interface SmokeCheckResult {
-    passed: boolean;
-    findingsCount?: number;
-    compileErrors?: boolean;
-    baselinePath: string;
-    generatedBaseline: boolean;
-}
-interface StalenessCheckResult {
-    violations: Violation[];
-}
-
-declare function runCompatCheck(baseline: ApiSurface, outputDir: string, lang: string, spec?: ApiSpec): Promise<CompatCheckResult>;
-
-declare function runOverlayRetryLoop(opts: {
-    baseline: ApiSurface;
-    parsedSpec: ApiSpec;
-    outputDir: string;
-    lang: string;
-    maxRetries: number;
-    namespace?: string;
-    onRetry?: (attemptNumber: number, maxRetries: number, patchableCount: number) => void;
-}): Promise<OverlayRetryResult>;
-
-declare function runStalenessCheck(baseline: ApiSurface, oldSpec: ApiSpec, newSpec: ApiSpec, lang: string): StalenessCheckResult;
-
-declare function runSmokeCheck(opts: {
-    spec?: string;
-    lang: string;
-    output: string;
-    rawResults?: string;
-    smokeConfig?: string;
-    smokeRunner?: string;
-}): SmokeCheckResult;
-
-export { type VerifyDiagnostics, runCompatCheck, runOverlayRetryLoop, runSmokeCheck, runStalenessCheck };