@workos/oagen 0.1.0 → 0.2.0

package/dist/smoke.d.mts

@@ -0,0 +1,331 @@
+//#region src/ir/types.d.ts
+/** 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;
+  example?: unknown;
+}
+/** Enum definition */
+interface Enum {
+  name: string;
+  values: EnumValue[];
+}
+interface EnumValue {
+  name: string;
+  value: string | number;
+  description?: string;
+  deprecated?: boolean;
+}
+interface ErrorResponse {
+  statusCode: number;
+  type?: TypeRef;
+}
+/** A successful response entry from a 2xx status code */
+interface SuccessResponse {
+  statusCode: number;
+  type: TypeRef;
+}
+//#endregion
+//#region src/parser/parse.d.ts
+interface ParseOptions {
+  operationIdTransform?: (id: string) => string;
+}
+declare function parseSpec(specPath: string, options?: ParseOptions): Promise<ApiSpec>;
+//#endregion
+//#region src/utils/naming.d.ts
+declare function toCamelCase(s: string, acronyms?: Set<string>): string;
+declare function toSnakeCase(s: string): string;
+//#endregion
+//#region scripts/smoke/shared.d.ts
+interface ExchangeProvenance {
+  resolutionTier: 'exact' | 'crud-prefix' | 'fuzzy' | 'manifest';
+  resolutionConfidence: number;
+  sdkMethodName: string;
+  captureIndex: number;
+  totalCaptures: number;
+}
+interface CapturedExchange {
+  operationId: string;
+  service: string;
+  operationName: string;
+  request: {
+    method: string;
+    path: string;
+    queryParams: Record<string, string>;
+    body: unknown | null;
+  };
+  response: {
+    status: number;
+    body: unknown | null;
+  };
+  outcome: 'success' | 'api-error' | 'skipped';
+  error?: string;
+  /** True when the response status code is not declared in the OpenAPI spec for this operation */
+  unexpectedStatus?: boolean;
+  /** Status codes declared in the OpenAPI spec (success + error codes) */
+  expectedStatusCodes?: number[];
+  durationMs: number;
+  /** How the SDK method was resolved and which capture was selected */
+  provenance?: ExchangeProvenance;
+}
+interface SmokeResults {
+  source: 'raw' | 'spec-baseline' | `sdk-${string}`;
+  timestamp: string;
+  specVersion: string;
+  exchanges: CapturedExchange[];
+}
+interface PlannedOperation {
+  service: string;
+  operation: Operation;
+}
+interface PlannedGroup {
+  service: string;
+  operations: PlannedOperation[];
+}
+/** Operations that require complex preconditions and can't be auto-tested */
+declare let SKIP_OPERATIONS: Set<string>;
+/** Services to skip entirely */
+declare let SKIP_SERVICES: Set<string>;
+/**
+ * Map IR service names to SDK property names on the client object.
+ * Empty = use toCamelCase(serviceName) as fallback.
+ */
+declare let SERVICE_PROPERTY_MAP: Record<string, string>;
+interface SmokeConfig {
+  skipOperations: string[];
+  skipServices: string[];
+  servicePriority: Record<string, number>;
+  servicePropertyMap: Record<string, string>;
+}
+/** Load smoke test configuration from a JSON file */
+declare function loadSmokeConfig(configPath?: string): void;
+/** Return the current smoke config values (for diff.ts to consume) */
+declare function getSmokeConfig(): {
+  skipOperations: Set<string>;
+  skipServices: Set<string>;
+  servicePriority: Record<string, number>;
+  servicePropertyMap: Record<string, string>;
+};
+declare function planOperations(spec: ApiSpec): PlannedGroup[];
+/**
+ * A single wave of operations that can be planned and executed together.
+ * Wave 0 contains parameterless operations. Subsequent waves contain
+ * operations whose path params became resolvable after earlier waves ran.
+ */
+interface OperationWave {
+  /** Operations in this wave, with pre-resolved path params */
+  calls: Array<{
+    op: Operation;
+    irService: string;
+    pathParams: Record<string, string>;
+  }>;
+}
+/**
+ * Plan operations in waves so that batched runners can execute each wave,
+ * extract IDs from responses, then plan the next wave.
+ *
+ * Returns an iterator that yields one wave at a time. The caller must
+ * execute each wave and populate the IdRegistry before calling next().
+ *
+ * @param groups - service groups from planOperations()
+ * @param ids - the IdRegistry (mutated by the caller between waves)
+ * @param resolveMethod - optional filter; return null to skip an operation
+ */
+declare function planWaves(groups: PlannedGroup[], ids: IdRegistry, resolveMethod?: (op: Operation, irService: string) => boolean): Generator<OperationWave, PlannedOperation[], void>;
+declare function generateFixtureValue(typeRef: TypeRef, fieldName: string, spec: ApiSpec): unknown;
+/** Generate a snake_case request body payload from an operation's requestBody type */
+declare function generatePayload(op: Operation, spec: ApiSpec): Record<string, unknown> | null;
+/** Generate a camelCase payload for SDK method calls */
+declare function generateCamelPayload(op: Operation, spec: ApiSpec): Record<string, unknown> | null;
+/** Generate query params for an operation (required params only, plus limit=1 for lists) */
+declare function generateQueryParams(op: Operation, spec: ApiSpec): Record<string, string>;
+/** Generate camelCase query params for SDK method calls */
+declare function generateCamelQueryParams(op: Operation, spec: ApiSpec): Record<string, unknown>;
+declare class IdRegistry {
+  private ids;
+  set(service: string, field: string, value: string): void;
+  get(service: string, field: string): string | undefined;
+  /** Resolve path parameters for an operation using stored IDs */
+  resolvePathParams(op: Operation, service: string): Record<string, string> | null;
+  /** Try to find a param value across all services */
+  private findAcrossServices;
+  /**
+   * Resolve a path param like "organizationId" by mapping it to the
+   * service that stores that entity's ID (e.g. Organizations.id).
+   * Also handles snake_case suffixed with _id by stripping the suffix
+   * and looking up the pluralized service name.
+   */
+  private resolveFromParamName;
+  /**
+   * Find a value by looking for any service name that ends with the given suffix.
+   * e.g. suffix "Users" matches "UserManagementUsers.id"
+   */
+  private findByServiceSuffix;
+  /**
+   * Last-resort fallback: use the spec's example or default value for a parameter.
+   * Many path params (e.g. actionName, slug, type) have example values in the spec.
+   */
+  private resolveFromExample;
+  /**
+   * Extract IDs from a response body and store them.
+   * @param isTopLevel - true for operations without path params (their `id` belongs to this service).
+   *                     false for sub-resource operations (their `id` is a child entity, don't overwrite).
+   */
+  extractAndStore(service: string, responseBody: unknown, isTopLevel?: boolean): void;
+  /** Extract fields ending in _id or Id and store them for cross-service resolution */
+  private extractNestedIds;
+}
+/** Get the set of status codes declared in the spec for an operation (success + errors) */
+declare function getExpectedStatusCodes(op: Operation): number[];
+/** Check if a status code is unexpected (not declared in the spec) */
+declare function isUnexpectedStatus(status: number, op: Operation): boolean;
+declare function resolvePath(op: Operation, pathParams: Record<string, string>): string;
+declare function delay(ms: number): Promise<void>;
+declare function parseCliArgs(): {
+  spec: string;
+  sdkPath?: string;
+  smokeConfig?: string;
+};
+//#endregion
+export { CapturedExchange, ExchangeProvenance, IdRegistry, OperationWave, PlannedGroup, PlannedOperation, SERVICE_PROPERTY_MAP, SKIP_OPERATIONS, SKIP_SERVICES, SmokeConfig, SmokeResults, delay, generateCamelPayload, generateCamelQueryParams, generateFixtureValue, generatePayload, generateQueryParams, getExpectedStatusCodes, getSmokeConfig, isUnexpectedStatus, loadSmokeConfig, parseCliArgs, parseSpec, planOperations, planWaves, resolvePath, toCamelCase, toSnakeCase };
+//# sourceMappingURL=smoke.d.mts.map

package/dist/smoke.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"smoke.d.mts","names":[],"sources":["../src/ir/types.ts","../src/parser/parse.ts","../src/utils/naming.ts","../scripts/smoke/shared.ts"],"mappings":";;KACY,UAAA;EACN,IAAA;AAAA;EACA,IAAA;EAAgB,EAAA;EAAmC,IAAA;AAAA;EACnD,IAAA;EAAgB,KAAA,EAAO,MAAA;AAAA;;;UAIZ,WAAA;EACf,GAAA;EACA,WAAA;AAAA;;UAIe,OAAA;EACf,IAAA;EACA,OAAA;EACA,WAAA;EACA,OAAA;EACA,OAAA,GAAU,WAAA;EACV,QAAA,EAAU,OAAA;EACV,MAAA,EAAQ,KAAA;EACR,KAAA,EAAO,IAAA;EACP,IAAA,GAAO,UAAA;AAAA;;UAIQ,OAAA;EACf,IAAA;EACA,WAAA;EACA,UAAA,EAAY,SAAA;AAAA;;UAIG,SAAA;EACf,IAAA;EACA,WAAA;EACA,UAAA,EAAY,UAAA;EACZ,IAAA;EACA,UAAA,EAAY,SAAA;EACZ,WAAA,EAAa,SAAA;EACb,YAAA,EAAc,SAAA;EACd,YAAA,GAAe,SAAA;EACf,WAAA,GAAc,OAAA;EACd,mBAAA;EACA,QAAA,EAAU,OAAA;EACV,gBAAA,GAAmB,eAAA;EACnB,MAAA,EAAQ,aAAA;EACR,UAAA,GAAa,cAAA;EACb,oBAAA;EACA,UAAA;EACA,KAAA;AAAA;;UAIe,cAAA;EACf,QAAA;EACA,KAAA;EACA,UAAA;EACA,QAAA;EACA,QAAA,EAAU,OAAA;AAAA;AAAA,KAGA,UAAA;AAAA,UAEK,SAAA;EACf,IAAA;EACA,IAAA,EAAM,OAAA;EACN,QAAA;EACA,WAAA;EACA,UAAA;EACA,OAAA;EACA,OAAA;AAAA;;KAIU,OAAA,GAAU,aAAA,GAAgB,SAAA,GAAY,QAAA,GAAW,OAAA,GAAU,SAAA,GAAY,YAAA,GAAe,WAAA,GAAc,OAAA;AAAA,UAE/F,aAAA;EACf,IAAA;EACA,IAAA;EACA,MAAA;AAAA;AAAA,UAGe,SAAA;EACf,IAAA;EACA,KAAA,EAAO,OAAA;AAAA;AAAA,UAGQ,QAAA;EACf,IAAA;EACA,IAAA;AAAA;AAAA,UAGe,OAAA;EACf,IAAA;EACA,IAAA;EACA,MAAA;AAAA;AAAA,UAGe,WAAA;EACf,IAAA;EACA,KAAA;AAAA;AAAA,UAGe,SAAA;EACf,IAAA;EACA,QAAA,EAAU,OAAA;EACV,aAAA;IAAkB,QAAA;IAAkB,OAAA,EAAS,MAAA;EAAA;EAhD5B;;EAmDjB,eAAA;AAAA;AAAA,UAGe,YAAA;EACf,IAAA;EACA,KAAA,EAAO,OAAA;AAAA;AAAA,UAGQ,OAAA;EACf,IAAA;EACA,SAAA,EAAW,OAAA;EACX,OAAA,GAAU,OAAA;AAAA;;AAzDZ;;;;UAiEiB,SAAA;EACf,IAAA;EAhEM;EAkEN,OAAA,GAAU,OAAA;AAAA;;UAIK,KAAA;EACf,IAAA;EACA,WAAA;EACA,MAAA,EAAQ,KAAA;EAhEE;EAkEV,UAAA,GAAa,SAAA;AAAA;AAAA,UAGE,KAAA;EACf,IAAA;EACA,IAAA,EAAM,OAAA;EACN,QAAA;EACA,WAAA;EACA,QAAA;EACA,SAAA;EACA,UAAA;EACA,OAAA;EACA,OAAA;AAAA;;UAIe,IAAA;EACf,IAAA;EACA,MAAA,EAAQ,SAAA;AAAA;AAAA,UAGO,SAAA;EACf,IAAA;EACA,KAAA;EACA,WAAA;EACA,UAAA;AAAA;AAAA,UA+Oe,aAAA;EACf,UAAA;EACA,IAAA,GAAO,OAAA;AAAA;;UAIQ,eAAA;EACf,UAAA;EACA,IAAA,EAAM,OAAA;AAAA;;;UCjZS,YAAA;EACf,oBAAA,IAAwB,EAAA;AAAA;AAAA,iBAGJ,SAAA,CAAU,QAAA,UAAkB,OAAA,GAAU,YAAA,GAAe,OAAA,CAAQ,OAAA;;;iBCkBnE,WAAA,CAAY,CAAA,UAAW,QAAA,GAAW,GAAA;AAAA,iBAelC,WAAA,CAAY,CAAA;;;UC7BX,kBAAA;EACf,cAAA;EACA,oBAAA;EACA,aAAA;EACA,YAAA;EACA,aAAA;AAAA;AAAA,UAGe,gBAAA;EACf,WAAA;EACA,OAAA;EACA,aAAA;EACA,OAAA;IACE,MAAA;IACA,IAAA;IACA,WAAA,EAAa,MAAA;IACb,IAAA;EAAA;EAEF,QAAA;IACE,MAAA;IACA,IAAA;EAAA;EAEF,OAAA;EACA,KAAA;EH3BA;EG6BA,gBAAA;EH3BA;EG6BA,mBAAA;EACA,UAAA;EH7BU;EG+BV,UAAA,GAAa,kBAAA;AAAA;AAAA,UAGE,YAAA;EACf,MAAA;EACA,SAAA;EACA,WAAA;EACA,SAAA,EAAW,gBAAA;AAAA;AAAA,UAOI,gBAAA;EACf,OAAA;EACA,SAAA,EAAW,SAAA;AAAA;AAAA,UAGI,YAAA;EACf,OAAA;EACA,UAAA,EAAY,gBAAA;AAAA;;YAQH,eAAA,EAAe,GAAA;AH9C1B;AAAA,YGiDW,aAAA,EAAa,GAAA;;;;;YAYb,oBAAA,EAAsB,MAAA;AAAA,UAEhB,WAAA;EACf,cAAA;EACA,YAAA;EACA,eAAA,EAAiB,MAAA;EACjB,kBAAA,EAAoB,MAAA;AAAA;;iBAIN,eAAA,CAAgB,UAAA;;iBAYhB,cAAA,CAAA;;;;;;iBA4BA,cAAA,CAAe,IAAA,EAAM,OAAA,GAAU,YAAA;;;;;;UAiD9B,aAAA;EHvJD;EGyJd,KAAA,EAAO,KAAA;IACL,EAAA,EAAI,SAAA;IACJ,SAAA;IACA,UAAA,EAAY,MAAA;EAAA;AAAA;;;;;;;;;AHhJhB;;;iBG+JiB,SAAA,CACf,MAAA,EAAQ,YAAA,IACR,GAAA,EAAK,UAAA,EACL,aAAA,IAAiB,EAAA,EAAI,SAAA,EAAW,SAAA,uBAC/B,SAAA,CAAU,aAAA,EAAe,gBAAA;AAAA,iBA0EZ,oBAAA,CAAqB,OAAA,EAAS,OAAA,EAAS,SAAA,UAAmB,IAAA,EAAM,OAAA;;iBAiDhE,eAAA,CAAgB,EAAA,EAAI,SAAA,EAAW,IAAA,EAAM,OAAA,GAAU,MAAA;;iBAsC/C,oBAAA,CAAqB,EAAA,EAAI,SAAA,EAAW,IAAA,EAAM,OAAA,GAAU,MAAA;;iBA0BpD,mBAAA,CAAoB,EAAA,EAAI,SAAA,EAAW,IAAA,EAAM,OAAA,GAAU,MAAA;;iBAsBnD,wBAAA,CAAyB,EAAA,EAAI,SAAA,EAAW,IAAA,EAAM,OAAA,GAAU,MAAA;AAAA,cAoB3D,UAAA;EAAA,QACH,GAAA;EAER,GAAA,CAAI,OAAA,UAAiB,KAAA,UAAe,KAAA;EAIpC,GAAA,CAAI,OAAA,UAAiB,KAAA;EHrYN;EG0Yf,iBAAA,CAAkB,EAAA,EAAI,SAAA,EAAW,OAAA,WAAkB,MAAA;;UAiB3C,kBAAA;EH1ZR;;;;;;EAAA,QG8aQ,oBAAA;EHxaR;;;AAIF;EAJE,QG+cQ,mBAAA;;;;;UAgBA,kBAAA;EH3d6D;;;;;EGwerE,eAAA,CAAgB,OAAA,UAAiB,YAAA,WAAuB,UAAA;EHxepC;EAAA,QG8gBZ,gBAAA;AAAA;;iBAiBM,sBAAA,CAAuB,EAAA,EAAI,SAAA;;iBAsB3B,kBAAA,CAAmB,MAAA,UAAgB,EAAA,EAAI,SAAA;AAAA,iBAUvC,WAAA,CAAY,EAAA,EAAI,SAAA,EAAW,UAAA,EAAY,MAAA;AAAA,iBAYvC,KAAA,CAAM,EAAA,WAAa,OAAA;AAAA,iBAInB,YAAA,CAAA;EAAkB,IAAA;EAAc,OAAA;EAAkB,WAAA;AAAA"}