@workos/oagen 0.0.1

package/dist/compat/index.d.ts

@@ -0,0 +1,195 @@
+import { c as Extractor, a as ApiSurface, A as ApiSpec, r as LanguageHints, O as OverlayLookup, V as Violation, D as DiffResult } from '../types-B5t9O9Wm.js';
+export { s as Addition, t as ApiClass, u as ApiEnum, v as ApiField, x as ApiInterface, y as ApiMethod, z as ApiParam, B as ApiProperty, C as ApiTypeAlias, G as MethodOverlay, I as ViolationCategory, J as ViolationSeverity } from '../types-B5t9O9Wm.js';
+
+declare function registerExtractor(extractor: Extractor): void;
+declare function getExtractor(language: string): Extractor;
+
+interface ManifestEntry {
+    operationId: string;
+    sdkResourceProperty: string;
+    sdkMethodName: string;
+    httpMethod: string;
+    path: string;
+    pathParams: string[];
+    bodyFields: string[];
+    queryFields: string[];
+}
+declare function buildOverlayLookup(surface: ApiSurface, manifest?: ManifestEntry[], spec?: ApiSpec, hints?: LanguageHints, options?: {
+    strictModelMatch?: boolean;
+}): OverlayLookup;
+/**
+ * Patch overlay with violations from a failed verification.
+ * Adds explicit name mappings for symbols that were generated with wrong names.
+ * Returns a new OverlayLookup (immutable).
+ */
+declare function patchOverlay(overlay: OverlayLookup, violations: Violation[], baseline: ApiSurface): OverlayLookup;
+
+/**
+ * Compute the set of symbol names that are derivable from the OpenAPI spec.
+ * Only these names should be compared during compat verification — everything
+ * else in the baseline is hand-written and out of scope for generation.
+ */
+declare function specDerivedNames(spec: ApiSpec, hints: LanguageHints): Set<string>;
+/**
+ * Compute a map of enum name → set of wire values that appear in the spec.
+ * Used by filterSurface to exclude hand-added enum members that aren't in the spec.
+ */
+declare function specDerivedEnumValues(spec: ApiSpec): Map<string, Set<string | number>>;
+/**
+ * Compute the set of field paths (e.g., "Organization.name") that are defined
+ * in the OpenAPI spec's model schemas. Used by filterSurface to exclude
+ * hand-added SDK fields that reference spec-derived types.
+ */
+declare function specDerivedFieldPaths(spec: ApiSpec, hints: LanguageHints): Set<string>;
+/**
+ * Compute the set of method paths (e.g., "SSO.authorize") that are defined
+ * as operations in the OpenAPI spec's services. Used by filterSurface to
+ * exclude hand-written SDK methods that don't correspond to spec operations.
+ */
+declare function specDerivedMethodPaths(spec: ApiSpec): Set<string>;
+/**
+ * Compute the set of HTTP operation keys (e.g., "GET /sso/authorize") that
+ * exist in the spec. Used for overlay-based method matching.
+ */
+declare function specDerivedHttpKeys(spec: ApiSpec): Set<string>;
+/**
+ * Filter an ApiSurface to only include symbols whose names appear in the
+ * allowed set. Symbols not in the set are dropped entirely — they won't
+ * count toward the total or produce violations.
+ *
+ * For interfaces: when fieldPaths is provided, only keeps fields that appear
+ * in the spec-derived field paths. This prevents false positives from hand-added
+ * SDK fields that reference spec-derived types but aren't defined in the spec.
+ *
+ * For classes: when methodPaths is provided, only keeps methods whose names
+ * appear in the spec-derived method paths. This prevents false positives from
+ * hand-written SDK methods (e.g., SSO.authorization_url, Webhooks.construct_event)
+ * that don't correspond to spec operations. Properties on service classes are
+ * also filtered: only UPPER_CASE constants that are spec-derivable are kept.
+ */
+declare function filterSurface(surface: ApiSurface, allowedNames: Set<string>, opts?: {
+    fieldPaths?: Set<string>;
+    methodPaths?: Set<string>;
+    enumValues?: Map<string, Set<string | number>>;
+}): ApiSurface;
+
+declare function diffSurfaces(baseline: ApiSurface, candidate: ApiSurface, hints: LanguageHints): DiffResult;
+
+declare const nodeExtractor: Extractor;
+
+/**
+ * PHP API surface extractor.
+ *
+ * Walks `.php` files under `lib/` (or `src/`), parses classes, interfaces,
+ * methods, properties, and constants, then builds an `ApiSurface`.
+ *
+ * Parser:  `php-parser.ts`  — tree-sitter-based PHP source analysis
+ * Surface: `php-surface.ts` — ApiSurface construction
+ */
+
+/** Default PHP extractor with generic language hints (no SDK-specific bases). */
+declare const phpExtractor: Extractor;
+
+/**
+ * Python API surface extractor.
+ *
+ * Walks `.py` files under `src/` (fallback to top-level package dirs),
+ * parses classes, type aliases, and module exports, then builds an
+ * `ApiSurface` with Protocol-based services, Pydantic model interfaces,
+ * Literal type enums, and exception classes.
+ *
+ * Parser:  `python-parser.ts`  — tree-sitter-based Python source analysis
+ * Surface: `python-surface.ts` — ApiSurface construction
+ */
+
+/** Default Python extractor with generic language hints (no SDK-specific bases). */
+declare const pythonExtractor: Extractor;
+
+/**
+ * Ruby API surface extractor.
+ *
+ * Walks `.rb` files under `lib/`, parses class/module declarations,
+ * and builds an `ApiSurface` with classes, service modules, and enum modules.
+ *
+ * Parser: `ruby-parser.ts` — tree-sitter-based class/module/enum extraction
+ */
+
+declare const rubyExtractor: Extractor;
+
+/**
+ * Go API surface extractor.
+ *
+ * Walks `.go` files (excluding `_test.go` and `internal/`), parses exported
+ * structs, functions, type declarations, and const blocks, then builds an
+ * `ApiSurface` with package-qualified names to avoid collisions when
+ * multiple packages define the same symbol (e.g., `Client`).
+ *
+ * Parser: `go-parser.ts`   — regex-based Go source analysis
+ * Surface: `go-surface.ts` — ApiSurface construction & name qualification
+ */
+
+declare const goExtractor: Extractor;
+
+/**
+ * Rust API surface extractor.
+ *
+ * Walks `.rs` files under `src/`, parses pub structs, enums, impl blocks,
+ * traits, and type aliases, then builds an ApiSurface.
+ *
+ * Parser:  `rust-parser.ts`  — tree-sitter-based Rust source analysis
+ * Surface: `rust-surface.ts` — ApiSurface construction
+ */
+
+declare const rustExtractor: Extractor;
+
+/**
+ * Kotlin API surface extractor.
+ *
+ * Walks `.kt` files (excluding test files and build directories), parses
+ * data classes, classes, enum classes, and type aliases, then builds an
+ * `ApiSurface`.
+ *
+ * Parser:  `kotlin-parser.ts`  — regex-based Kotlin source analysis
+ * Surface: `kotlin-surface.ts` — ApiSurface construction
+ */
+
+declare const kotlinExtractor: Extractor;
+
+/**
+ * DotNet (C#) API surface extractor.
+ *
+ * Walks `.cs` files (excluding test, bin, and obj directories), parses
+ * classes, enums, properties, and methods, then builds an `ApiSurface`.
+ *
+ * Parser:  `dotnet-parser.ts`  — regex-based C# source analysis
+ * Surface: `dotnet-surface.ts` — ApiSurface construction
+ */
+
+/** Default DotNet extractor with generic language hints. */
+declare const dotnetExtractor: Extractor;
+
+/**
+ * Elixir API surface extractor.
+ *
+ * Walks `.ex` files under `lib/` (the standard Elixir source directory),
+ * parses modules, structs, functions, and type specs, then builds an
+ * `ApiSurface`.
+ *
+ * Parser:  `elixir-parser.ts`  — regex-based Elixir source analysis
+ * Surface: `elixir-surface.ts` — ApiSurface construction
+ */
+
+declare const elixirExtractor: Extractor;
+
+/**
+ * Node/TypeScript language hints — reference implementation.
+ * Extracted from the hardcoded logic previously in differ.ts and overlay.ts.
+ */
+declare const nodeHints: LanguageHints;
+/**
+ * Merge partial language hint overrides over nodeHints defaults.
+ * Any hint not provided falls back to the Node/TypeScript implementation.
+ */
+declare function resolveHints(overrides: Partial<LanguageHints>): LanguageHints;
+
+export { ApiSurface, DiffResult, Extractor, LanguageHints, OverlayLookup, Violation, buildOverlayLookup, diffSurfaces, dotnetExtractor, elixirExtractor, filterSurface, getExtractor, goExtractor, kotlinExtractor, nodeExtractor, nodeHints, patchOverlay, phpExtractor, pythonExtractor, registerExtractor, resolveHints, rubyExtractor, rustExtractor, specDerivedEnumValues, specDerivedFieldPaths, specDerivedHttpKeys, specDerivedMethodPaths, specDerivedNames };