@workos/oagen-emitters 0.2.1 → 0.3.0

package/src/shared/resolved-ops.ts

@@ -0,0 +1,109 @@
+import type { Operation, EmitterContext, Service, ResolvedOperation } from '@workos/oagen';
+import { toPascalCase } from '@workos/oagen';
+
+/**
+ * Build a lookup map from "METHOD /path" to ResolvedOperation.
+ * Used by emitters to find the resolved method name for any IR operation.
+ */
+export function buildResolvedLookup(ctx: EmitterContext): Map<string, ResolvedOperation> {
+  const map = new Map<string, ResolvedOperation>();
+  for (const r of ctx.resolvedOperations ?? []) {
+    const key = `${r.operation.httpMethod.toUpperCase()} ${r.operation.path}`;
+    map.set(key, r);
+  }
+  return map;
+}
+
+/**
+ * Look up the resolved method name for an operation.
+ * Returns the snake_case resolved name, or undefined if not found.
+ */
+export function lookupMethodName(op: Operation, lookup: Map<string, ResolvedOperation>): string | undefined {
+  const key = `${op.httpMethod.toUpperCase()} ${op.path}`;
+  return lookup.get(key)?.methodName;
+}
+
+/**
+ * Look up the full ResolvedOperation for an IR operation.
+ */
+export function lookupResolved(op: Operation, lookup: Map<string, ResolvedOperation>): ResolvedOperation | undefined {
+  const key = `${op.httpMethod.toUpperCase()} ${op.path}`;
+  return lookup.get(key);
+}
+
+/**
+ * A mount group: a set of resolved operations that all mount on the same target.
+ * Serves the same role as a Service in the old architecture, but operations may
+ * come from multiple IR services.
+ */
+export interface MountGroup {
+  /** PascalCase mount target name (e.g., "SSO", "UserManagement"). */
+  name: string;
+  /** All resolved operations in this group. */
+  resolvedOps: ResolvedOperation[];
+  /** The raw IR operations (convenience — same as resolvedOps[*].operation). */
+  operations: Operation[];
+}
+
+/**
+ * Group resolved operations by their mountOn target.
+ * Returns a map from PascalCase mount target to MountGroup.
+ */
+export function groupByMount(ctx: EmitterContext): Map<string, MountGroup> {
+  const groups = new Map<string, MountGroup>();
+  for (const r of ctx.resolvedOperations ?? []) {
+    let group = groups.get(r.mountOn);
+    if (!group) {
+      group = { name: r.mountOn, resolvedOps: [], operations: [] };
+      groups.set(r.mountOn, group);
+    }
+    group.resolvedOps.push(r);
+    group.operations.push(r.operation);
+  }
+  return groups;
+}
+
+/**
+ * Get the mount target for an IR service.
+ * Checks the first resolved operation that belongs to this service.
+ * Falls back to PascalCase of the service name if no resolved ops exist.
+ */
+export function getMountTarget(service: Service, ctx: EmitterContext): string {
+  for (const r of ctx.resolvedOperations ?? []) {
+    if (r.service.name === service.name) return r.mountOn;
+  }
+  return toPascalCase(service.name);
+}
+
+// ---------------------------------------------------------------------------
+// Defaults / inferFromClient helpers
+//
+// For non-split operations with operationHints that specify `defaults` or
+// `inferFromClient`, oagen attaches these properties at runtime but they
+// are not part of the ResolvedOperation TypeScript interface (they live on
+// ResolvedWrapper for split operations). These helpers provide type-safe
+// access so individual emitters don't need `as any` casts.
+// ---------------------------------------------------------------------------
+
+/** Extract constant defaults from a resolved operation (if any). */
+export function getOpDefaults(resolvedOp?: ResolvedOperation): Record<string, string | number | boolean> {
+  return ((resolvedOp as any)?.defaults as Record<string, string | number | boolean> | undefined) ?? {};
+}
+
+/** Extract inferFromClient fields from a resolved operation (if any). */
+export function getOpInferFromClient(resolvedOp?: ResolvedOperation): string[] {
+  return ((resolvedOp as any)?.inferFromClient as string[] | undefined) ?? [];
+}
+
+/** Build the set of param names hidden from the public API (injected as defaults or inferred from client config). */
+export function buildHiddenParams(resolvedOp?: ResolvedOperation): Set<string> {
+  const hidden = new Set<string>();
+  for (const key of Object.keys(getOpDefaults(resolvedOp))) hidden.add(key);
+  for (const key of getOpInferFromClient(resolvedOp)) hidden.add(key);
+  return hidden;
+}
+
+/** Check whether a resolved operation has any hidden params. */
+export function hasHiddenParams(resolvedOp?: ResolvedOperation): boolean {
+  return Object.keys(getOpDefaults(resolvedOp)).length > 0 || getOpInferFromClient(resolvedOp).length > 0;
+}

package/src/shared/wrapper-utils.ts

@@ -0,0 +1,59 @@
+import type { EmitterContext, Field, ResolvedWrapper } from '@workos/oagen';
+import { toSnakeCase } from '@workos/oagen';
+import { enrichModelsFromSpec } from './model-utils.js';
+
+/**
+ * A resolved wrapper parameter with its variant model field and optional status.
+ * Pre-computed once per wrapper so emitters don't repeat the lookup.
+ */
+export interface ResolvedWrapperParam {
+  /** Wire name of the param (e.g., "email", "grant_type"). */
+  paramName: string;
+  /** The field from the variant model, or null if not found in the spec. */
+  field: Field | null;
+  /** Whether this param should be optional in the generated SDK. */
+  isOptional: boolean;
+}
+
+/**
+ * Resolve the variant model's fields for a wrapper's exposed params.
+ *
+ * Encapsulates the three-step lookup every emitter needs:
+ * 1. Find the variant model via wrapper.targetVariant in ctx.spec.models
+ * 2. Match each exposed param to its field in the variant
+ * 3. Classify as required or optional using wrapper.optionalParams + field.required
+ *
+ * Field matching uses exact name first, then falls back to snake_case normalization
+ * to handle cases where wire names and model field names differ in casing.
+ */
+export function resolveWrapperParams(wrapper: ResolvedWrapper, ctx: EmitterContext): ResolvedWrapperParam[] {
+  let variantModel = ctx.spec.models.find((m) => m.name === wrapper.targetVariant);
+
+  // If the variant model has no fields, try enriching from the raw spec.
+  // Some oneOf variants have 0 IR fields until enrichModelsFromSpec backfills them.
+  if (!variantModel || variantModel.fields.length === 0) {
+    const enriched = enrichModelsFromSpec(ctx.spec.models);
+    variantModel = enriched.find((m) => m.name === wrapper.targetVariant) ?? variantModel;
+  }
+
+  const variantFields = variantModel?.fields ?? [];
+  const optionalSet = new Set(wrapper.optionalParams);
+
+  return wrapper.exposedParams.map((paramName) => {
+    const field =
+      variantFields.find((f) => f.name === paramName || toSnakeCase(f.name) === toSnakeCase(paramName)) ?? null;
+    const isOptional = optionalSet.has(paramName) || !field?.required;
+    return { paramName, field, isOptional };
+  });
+}
+
+/**
+ * Format a snake_case wrapper name into a human-readable description.
+ * "authenticate_with_password" → "Authenticate with password"
+ */
+export function formatWrapperDescription(name: string): string {
+  return name
+    .split('_')
+    .map((w, i) => (i === 0 ? w.charAt(0).toUpperCase() + w.slice(1) : w))
+    .join(' ');
+}

package/test/go/client.test.ts

@@ -0,0 +1,92 @@
+import { describe, it, expect } from 'vitest';
+import type { EmitterContext, ApiSpec, Service } from '@workos/oagen';
+import { defaultSdkBehavior } from '@workos/oagen';
+import { generateClient } from '../../src/go/client.js';
+
+function makeSpec(services: Service[]): ApiSpec {
+  return {
+    name: 'Test',
+    version: '1.0.0',
+    baseUrl: 'https://api.workos.com',
+    services,
+    models: [],
+    enums: [],
+    sdk: defaultSdkBehavior(),
+  };
+}
+
+function makeCtx(spec: ApiSpec): EmitterContext {
+  return {
+    namespace: 'workos',
+    namespacePascal: 'WorkOS',
+    spec,
+  };
+}
+
+describe('go/client', () => {
+  it('generates only workos.go', () => {
+    const spec = makeSpec([]);
+    const files = generateClient(spec, makeCtx(spec));
+    expect(files.length).toBe(1);
+    expect(files[0].path).toBe('workos.go');
+  });
+
+  it('generates Client struct with service fields', () => {
+    const spec = makeSpec([
+      {
+        name: 'Organizations',
+        operations: [
+          {
+            name: 'listOrganizations',
+            httpMethod: 'get',
+            path: '/organizations',
+            pathParams: [],
+            queryParams: [],
+            headerParams: [],
+            response: { kind: 'model', name: 'Organization' },
+            errors: [],
+            injectIdempotencyKey: false,
+          },
+        ],
+      },
+    ]);
+    const files = generateClient(spec, makeCtx(spec));
+    const workosFile = files.find((f) => f.path === 'workos.go')!;
+    const content = workosFile.content;
+
+    expect(content).toContain('package workos');
+    expect(content).toContain('organizations *organizationService');
+    expect(content).toContain('func NewClient(apiKey string, opts ...ClientOption) *Client {');
+    expect(content).toContain('func (c *Client) Organizations() *organizationService {');
+  });
+
+  it('does not emit static options or HTTP infrastructure', () => {
+    const spec = makeSpec([]);
+    const files = generateClient(spec, makeCtx(spec));
+    const workosFile = files.find((f) => f.path === 'workos.go')!;
+    const content = workosFile.content;
+
+    // These definitions are now in hand-maintained options.go
+    expect(content).not.toContain('type ClientOption func(*Client)');
+    expect(content).not.toContain('func WithBaseURL');
+    expect(content).not.toContain('type RequestOption');
+    expect(content).not.toContain('type requestConfig struct');
+    // Constants are defined in options.go, but referenced in NewClient
+    expect(content).not.toContain('defaultBaseURL    =');
+  });
+
+  it('uses acronym-aware service accessors and fields', () => {
+    const spec = makeSpec([
+      { name: 'ApiKeys', operations: [] },
+      { name: 'SSO', operations: [] },
+    ]);
+    const files = generateClient(spec, makeCtx(spec));
+    const workosFile = files.find((f) => f.path === 'workos.go')!;
+    const content = workosFile.content;
+
+    expect(content).toContain('apiKeys *apiKeyService');
+    expect(content).toContain('sso *ssoService');
+    expect(content).toContain('func (c *Client) APIKeys() *apiKeyService {');
+    expect(content).toContain('func (c *Client) SSO() *ssoService {');
+  });
+});

package/test/go/enums.test.ts

@@ -0,0 +1,132 @@
+import { describe, it, expect } from 'vitest';
+import type { EmitterContext, ApiSpec, Enum } from '@workos/oagen';
+import { defaultSdkBehavior } from '@workos/oagen';
+import { generateEnums } from '../../src/go/enums.js';
+
+const emptySpec: ApiSpec = {
+  name: 'Test',
+  version: '1.0.0',
+  baseUrl: '',
+  services: [],
+  models: [],
+  enums: [],
+  sdk: defaultSdkBehavior(),
+};
+
+const ctx: EmitterContext = {
+  namespace: 'workos',
+  namespacePascal: 'WorkOS',
+  spec: emptySpec,
+};
+
+describe('go/enums', () => {
+  it('returns empty for no enums', () => {
+    expect(generateEnums([], ctx)).toEqual([]);
+  });
+
+  it('generates typed string constants', () => {
+    const enums: Enum[] = [
+      {
+        name: 'ConnectionStatus',
+        values: [
+          { name: 'ACTIVE', value: 'active' },
+          { name: 'INACTIVE', value: 'inactive' },
+        ],
+      },
+    ];
+    const files = generateEnums(enums, ctx);
+    expect(files).toHaveLength(1);
+    expect(files[0].path).toBe('enums.go');
+    const content = files[0].content;
+    expect(content).toContain('package workos');
+    expect(content).toContain('type ConnectionStatus string');
+    expect(content).toContain('ConnectionStatusActive ConnectionStatus = "active"');
+    expect(content).toContain('ConnectionStatusInactive ConnectionStatus = "inactive"');
+  });
+
+  it('deduplicates identical enums as type aliases', () => {
+    const enums: Enum[] = [
+      {
+        name: 'Alpha',
+        values: [{ name: 'A', value: 'a' }],
+      },
+      {
+        name: 'Beta',
+        values: [{ name: 'A', value: 'a' }],
+      },
+    ];
+    const files = generateEnums(enums, ctx);
+    const content = files[0].content;
+    expect(content).toContain('type Alpha string');
+    expect(content).toContain('type Beta = Alpha');
+  });
+
+  it('handles empty enums as type aliases to string', () => {
+    const enums: Enum[] = [{ name: 'UnknownType', values: [] }];
+    const files = generateEnums(enums, ctx);
+    const content = files[0].content;
+    expect(content).toContain('type UnknownType = string');
+  });
+
+  it('snapshot: ConnectionStatus enum', () => {
+    const enums: Enum[] = [
+      {
+        name: 'ConnectionStatus',
+        values: [
+          { name: 'ACTIVE', value: 'active' },
+          { name: 'INACTIVE', value: 'inactive' },
+          { name: 'PENDING', value: 'pending' },
+        ],
+      },
+    ];
+    const files = generateEnums(enums, ctx);
+    expect(files[0].content).toMatchInlineSnapshot(`
+      "package workos
+
+      // ConnectionStatus represents connection status values.
+      type ConnectionStatus string
+
+      const (
+      	ConnectionStatusActive ConnectionStatus = "active"
+      	ConnectionStatusInactive ConnectionStatus = "inactive"
+      	ConnectionStatusPending ConnectionStatus = "pending"
+      )
+      "
+    `);
+  });
+
+  it('emits Deprecated comments for deprecated enum values', () => {
+    const enums: Enum[] = [
+      {
+        name: 'WidgetStatus',
+        values: [
+          { name: 'ACTIVE', value: 'active', description: 'Currently active', deprecated: true },
+          { name: 'LEGACY', value: 'legacy', deprecated: true },
+          { name: 'CURRENT', value: 'current' },
+        ],
+      },
+    ];
+    const files = generateEnums(enums, ctx);
+    const content = files[0].content;
+    // deprecated value WITH description gets separator + Deprecated
+    expect(content).toContain(
+      '\t// WidgetStatusActive is Currently active.\n\t//\n\t// Deprecated: this value is deprecated.',
+    );
+    // deprecated value WITHOUT description gets Deprecated only
+    expect(content).toContain('\t// Deprecated: this value is deprecated.\n\tWidgetStatusLegacy');
+    // non-deprecated value does NOT get Deprecated
+    expect(content).not.toMatch(/Deprecated.*\n\tWidgetStatusCurrent/);
+  });
+
+  it('uses Go acronym conventions for enum type names', () => {
+    const enums: Enum[] = [
+      {
+        name: 'SsoConnectionType',
+        values: [{ name: 'SAML', value: 'saml' }],
+      },
+    ];
+    const files = generateEnums(enums, ctx);
+    const content = files[0].content;
+    expect(content).toContain('type SSOConnectionType string');
+  });
+});

package/test/go/errors.test.ts

@@ -0,0 +1,9 @@
+import { describe, it, expect } from 'vitest';
+import { goEmitter } from '../../src/go/index.js';
+
+describe('go/errors', () => {
+  it('returns empty array (errors are hand-maintained in the target SDK)', () => {
+    const files = goEmitter.generateErrors({} as any);
+    expect(files).toHaveLength(0);
+  });
+});

package/test/go/models.test.ts

@@ -0,0 +1,265 @@
+import { describe, it, expect } from 'vitest';
+import type { EmitterContext, ApiSpec, Model } from '@workos/oagen';
+import { defaultSdkBehavior } from '@workos/oagen';
+import { generateModels } from '../../src/go/models.js';
+
+const emptySpec: ApiSpec = {
+  name: 'Test',
+  version: '1.0.0',
+  baseUrl: '',
+  services: [],
+  models: [],
+  enums: [],
+  sdk: defaultSdkBehavior(),
+};
+
+const ctx: EmitterContext = {
+  namespace: 'workos',
+  namespacePascal: 'WorkOS',
+  spec: emptySpec,
+};
+
+describe('go/models', () => {
+  it('returns empty for no models', () => {
+    expect(generateModels([], ctx)).toEqual([]);
+  });
+
+  it('generates a struct with required and optional fields', () => {
+    const models: Model[] = [
+      {
+        name: 'Organization',
+        fields: [
+          { name: 'id', type: { kind: 'primitive', type: 'string' }, required: true },
+          { name: 'name', type: { kind: 'primitive', type: 'string' }, required: true },
+          {
+            name: 'metadata',
+            type: { kind: 'map', valueType: { kind: 'primitive', type: 'string' } },
+            required: false,
+          },
+        ],
+      },
+    ];
+    const files = generateModels(models, ctx);
+    expect(files).toHaveLength(1);
+    expect(files[0].path).toBe('models.go');
+    const content = files[0].content;
+    expect(content).toContain('package workos');
+    expect(content).toContain('type Organization struct {');
+    expect(content).toContain('ID string `json:"id"`');
+    expect(content).toContain('Name string `json:"name"`');
+    expect(content).toContain('Metadata map[string]string `json:"metadata,omitempty"`');
+  });
+
+  it('handles model refs as pointer types', () => {
+    const models: Model[] = [
+      {
+        name: 'User',
+        fields: [
+          { name: 'id', type: { kind: 'primitive', type: 'string' }, required: true },
+          { name: 'profile', type: { kind: 'model', name: 'Profile' }, required: true },
+        ],
+      },
+      {
+        name: 'Profile',
+        fields: [{ name: 'bio', type: { kind: 'primitive', type: 'string' }, required: true }],
+      },
+    ];
+    const files = generateModels(models, ctx);
+    const content = files[0].content;
+    expect(content).toContain('Profile *Profile `json:"profile"`');
+  });
+
+  it('handles nullable fields as pointers', () => {
+    const models: Model[] = [
+      {
+        name: 'Item',
+        fields: [
+          {
+            name: 'description',
+            type: { kind: 'nullable', inner: { kind: 'primitive', type: 'string' } },
+            required: false,
+          },
+        ],
+      },
+    ];
+    const files = generateModels(models, ctx);
+    const content = files[0].content;
+    expect(content).toContain('Description *string');
+  });
+
+  it('skips list wrapper models', () => {
+    const models: Model[] = [
+      {
+        name: 'OrganizationList',
+        fields: [
+          {
+            name: 'data',
+            type: {
+              kind: 'array',
+              items: { kind: 'model', name: 'Organization' },
+            },
+            required: true,
+          },
+          {
+            name: 'list_metadata',
+            type: { kind: 'model', name: 'ListMetadata' },
+            required: true,
+          },
+        ],
+      },
+    ];
+    const files = generateModels(models, ctx);
+    const content = files[0].content;
+    expect(content).not.toContain('OrganizationList');
+  });
+
+  it('deduplicates structurally identical models', () => {
+    const models: Model[] = [
+      {
+        name: 'Alpha',
+        fields: [{ name: 'id', type: { kind: 'primitive', type: 'string' }, required: true }],
+      },
+      {
+        name: 'Beta',
+        fields: [{ name: 'id', type: { kind: 'primitive', type: 'string' }, required: true }],
+      },
+    ];
+    const files = generateModels(models, ctx);
+    const content = files[0].content;
+    expect(content).toContain('type Alpha struct {');
+    expect(content).toContain('type Beta = Alpha');
+  });
+
+  it('uses Go acronym conventions for field names', () => {
+    const models: Model[] = [
+      {
+        name: 'Connection',
+        fields: [
+          { name: 'connection_id', type: { kind: 'primitive', type: 'string' }, required: true },
+          { name: 'sso_url', type: { kind: 'primitive', type: 'string' }, required: false },
+        ],
+      },
+    ];
+    const files = generateModels(models, ctx);
+    const content = files[0].content;
+    expect(content).toContain('ConnectionID string');
+    expect(content).toContain('SSOURL *string');
+  });
+
+  it('generates array fields', () => {
+    const models: Model[] = [
+      {
+        name: 'Org',
+        fields: [
+          {
+            name: 'domains',
+            type: { kind: 'array', items: { kind: 'primitive', type: 'string' } },
+            required: true,
+          },
+        ],
+      },
+    ];
+    const files = generateModels(models, ctx);
+    const content = files[0].content;
+    expect(content).toContain('Domains []string `json:"domains"`');
+  });
+
+  it('generates enum field references', () => {
+    const models: Model[] = [
+      {
+        name: 'Connection',
+        fields: [{ name: 'status', type: { kind: 'enum', name: 'ConnectionStatus' }, required: true }],
+      },
+    ];
+    const files = generateModels(models, ctx);
+    const content = files[0].content;
+    expect(content).toContain('Status ConnectionStatus `json:"status"`');
+  });
+
+  it('preserves DTO model names when emitting distinct types', () => {
+    const models: Model[] = [
+      {
+        name: 'RedirectUriDto',
+        fields: [{ name: 'uri', type: { kind: 'primitive', type: 'string' }, required: true }],
+      },
+    ];
+    const files = generateModels(models, ctx);
+    const content = files[0].content;
+    expect(content).toContain('type RedirectURIDto struct {');
+    expect(content).toContain('URI string `json:"uri"`');
+  });
+
+  it('emits Deprecated comments for deprecated fields', () => {
+    const models: Model[] = [
+      {
+        name: 'Widget',
+        fields: [
+          {
+            name: 'old_name',
+            type: { kind: 'primitive', type: 'string' },
+            required: false,
+            description: 'The original name.',
+            deprecated: true,
+          },
+          {
+            name: 'legacy_id',
+            type: { kind: 'primitive', type: 'string' },
+            required: false,
+            deprecated: true,
+          },
+          {
+            name: 'current_name',
+            type: { kind: 'primitive', type: 'string' },
+            required: true,
+          },
+        ],
+      },
+    ];
+    const files = generateModels(models, ctx);
+    const content = files[0].content;
+    // deprecated field WITH description gets separator + Deprecated
+    expect(content).toContain('\t// OldName is the original name.\n\t//\n\t// Deprecated: this field is deprecated.');
+    // deprecated field WITHOUT description gets Deprecated only (no separator)
+    expect(content).toContain('\t// Deprecated: this field is deprecated.\n\tLegacyID');
+    // non-deprecated field does NOT get Deprecated
+    expect(content).not.toMatch(/Deprecated.*\n\tCurrentName/);
+  });
+
+  it('snapshot: Organization struct', () => {
+    const models: Model[] = [
+      {
+        name: 'Organization',
+        description: 'Represents an organization.',
+        fields: [
+          { name: 'id', type: { kind: 'primitive', type: 'string' }, required: true },
+          { name: 'name', type: { kind: 'primitive', type: 'string' }, required: true },
+          { name: 'created_at', type: { kind: 'primitive', type: 'string', format: 'date-time' }, required: true },
+        ],
+      },
+    ];
+    const files = generateModels(models, ctx);
+    expect(files[0].content).toMatchInlineSnapshot(`
+      "package workos
+
+      // Organization represents an organization.
+      type Organization struct {
+      	ID string \`json:"id"\`
+      	Name string \`json:"name"\`
+      	CreatedAt string \`json:"created_at"\`
+      }
+
+      // PaginationParams contains common pagination parameters for list operations.
+      type PaginationParams struct {
+      	// Before is a cursor for reverse pagination.
+      	Before *string \`url:"before,omitempty" json:"-"\`
+      	// After is a cursor for forward pagination.
+      	After *string \`url:"after,omitempty" json:"-"\`
+      	// Limit is the maximum number of items to return per page.
+      	Limit *int \`url:"limit,omitempty" json:"-"\`
+      	// Order is the sort order for results (asc or desc).
+      	Order *string \`url:"order,omitempty" json:"-"\`
+      }
+      "
+    `);
+  });
+});