@workos/oagen-emitters 0.2.0 → 0.3.0

package/src/php/client.ts

@@ -0,0 +1,171 @@
+import type { ApiSpec, Service, EmitterContext, GeneratedFile } from '@workos/oagen';
+import { toPascalCase, toCamelCase } from '@workos/oagen';
+import { className, servicePropertyName } from './naming.js';
+import { getMountTarget } from '../shared/resolved-ops.js';
+import { NON_SPEC_SERVICES } from '../shared/non-spec-services.js';
+
+/**
+ * PHP-specific class-name overrides for non-spec services.
+ * If a service id isn't listed here, PascalCase(id) is used.
+ */
+const PHP_NON_SPEC_CLASS_NAMES: Record<string, string> = {
+  webhook_verification: 'WebhookVerification',
+  session_manager: 'SessionManager',
+  pkce: 'PKCEHelper',
+};
+
+/** Derive PHP class name + property name from a non-spec service id. */
+function phpNonSpecAccessor(id: string): { className: string; propName: string } {
+  return {
+    className: PHP_NON_SPEC_CLASS_NAMES[id] ?? toPascalCase(id),
+    propName:
+      id === 'webhook_verification'
+        ? 'webhookVerification'
+        : id === 'session_manager'
+          ? 'sessionManager'
+          : toCamelCase(id),
+  };
+}
+
+/**
+ * Generate the main PHP client class (service wiring only).
+ *
+ * Static infrastructure (HttpClient, PaginatedResponse, RequestOptions) is
+ * now hand-maintained in the target SDK with @oagen-ignore-file.
+ */
+export function generateClient(spec: ApiSpec, ctx: EmitterContext): GeneratedFile[] {
+  const ns = ctx.namespacePascal;
+  const dedupedServices = deduplicateByMount(spec.services, ctx);
+
+  return [
+    {
+      path: `lib/${ns}.php`,
+      content: generateMainClient(spec, dedupedServices, ctx),
+      overwriteExisting: true,
+    },
+  ];
+}
+
+/**
+ * Build a map from IR service name to the client accessor property name.
+ */
+export function buildServiceAccessPaths(services: Service[], ctx: EmitterContext): Map<string, string> {
+  const map = new Map<string, string>();
+  for (const service of services) {
+    const target = getMountTarget(service, ctx);
+    map.set(service.name, servicePropertyName(target));
+    map.set(target, servicePropertyName(target));
+  }
+  return map;
+}
+
+function deduplicateByMount(services: Service[], ctx: EmitterContext): { name: string; propName: string }[] {
+  const seen = new Map<string, { name: string; propName: string }>();
+  for (const service of services) {
+    const target = getMountTarget(service, ctx);
+    if (!seen.has(target)) {
+      seen.set(target, {
+        name: className(target),
+        propName: servicePropertyName(target),
+      });
+    }
+  }
+  return [...seen.values()];
+}
+
+function generateMainClient(
+  spec: ApiSpec,
+  services: { name: string; propName: string }[],
+  ctx: EmitterContext,
+): string {
+  const ns = ctx.namespacePascal;
+  const lines: string[] = [];
+
+  // No <?php here — the file header from fileHeader() provides it
+  lines.push(`namespace ${ns};`);
+  lines.push('');
+
+  // Use imports (sorted case-insensitively for PSR-12)
+  const nonSpecAccessors = NON_SPEC_SERVICES.map((s) => phpNonSpecAccessor(s.id));
+  const allImports: string[] = [];
+  for (const svc of services) {
+    allImports.push(`use ${ns}\\Service\\${svc.name};`);
+  }
+  allImports.sort((a, b) => a.toLowerCase().localeCompare(b.toLowerCase()));
+  for (const imp of allImports) {
+    lines.push(imp);
+  }
+  lines.push('');
+
+  lines.push(`class ${ns}`);
+  lines.push('{');
+  lines.push('    private static ?string $apiKey = null;');
+  lines.push('    private static ?string $clientId = null;');
+  lines.push('    private ?HttpClient $httpClient = null;');
+  lines.push('');
+  lines.push('    public static function getApiKey(): ?string');
+  lines.push('    {');
+  lines.push('        return self::$apiKey;');
+  lines.push('    }');
+  lines.push('');
+  lines.push('    public static function setApiKey(?string $key): void');
+  lines.push('    {');
+  lines.push('        self::$apiKey = $key;');
+  lines.push('    }');
+  lines.push('');
+  lines.push('    public static function getClientId(): ?string');
+  lines.push('    {');
+  lines.push('        return self::$clientId;');
+  lines.push('    }');
+  lines.push('');
+  lines.push('    public static function setClientId(?string $id): void');
+  lines.push('    {');
+  lines.push('        self::$clientId = $id;');
+  lines.push('    }');
+
+  // Nullable resource properties
+  for (const svc of services) {
+    lines.push(`    private ?Service\\${svc.name} $${svc.propName} = null;`);
+  }
+  // Non-spec service properties (hand-maintained modules)
+  for (const a of nonSpecAccessors) {
+    lines.push(`    private ?${a.className} $${a.propName} = null;`);
+  }
+
+  lines.push('');
+  lines.push('    public function __construct(');
+  lines.push('        ?string $apiKey = null,');
+  lines.push('        ?string $clientId = null,');
+  lines.push(`        string $baseUrl = '${spec.baseUrl}',`);
+  lines.push('        int $timeout = 60,');
+  lines.push('        int $maxRetries = 3,');
+  lines.push('        ?\\GuzzleHttp\\HandlerStack $handler = null,');
+  lines.push('    ) {');
+  lines.push("        $apiKey ??= getenv('WORKOS_API_KEY') ?: self::$apiKey ?? '';");
+  lines.push("        $clientId ??= getenv('WORKOS_CLIENT_ID') ?: self::$clientId;");
+  lines.push(
+    '        $this->httpClient = new HttpClient($apiKey, $clientId, $baseUrl, $timeout, $maxRetries, $handler);',
+  );
+  lines.push('    }');
+
+  // Resource accessors
+  for (const svc of services) {
+    lines.push('');
+    lines.push(`    public function ${svc.propName}(): ${svc.name}`);
+    lines.push('    {');
+    lines.push(`        return $this->${svc.propName} ??= new Service\\${svc.name}($this->httpClient);`);
+    lines.push('    }');
+  }
+
+  // Non-spec service accessors (hand-maintained modules)
+  for (const a of nonSpecAccessors) {
+    lines.push('');
+    lines.push(`    public function ${a.propName}(): ${a.className}`);
+    lines.push('    {');
+    lines.push(`        return $this->${a.propName} ??= new ${a.className}($this->httpClient);`);
+    lines.push('    }');
+  }
+
+  lines.push('}');
+  return lines.join('\n');
+}

package/src/php/enums.ts

@@ -0,0 +1,67 @@
+import type { Enum, EmitterContext, GeneratedFile } from '@workos/oagen';
+import { toPascalCase } from '@workos/oagen';
+import { className, resolveEnumName } from './naming.js';
+import { phpDocComment } from './utils.js';
+
+/**
+ * Generate PHP enum files from IR enums.
+ */
+export function generateEnums(enums: Enum[], ctx: EmitterContext): GeneratedFile[] {
+  if (enums.length === 0) return [];
+
+  const files: GeneratedFile[] = [];
+  const emittedCanonical = new Set<string>();
+
+  for (const e of enums) {
+    const canonical = resolveEnumName(e.name);
+    if (emittedCanonical.has(canonical)) continue; // skip aliases
+    emittedCanonical.add(canonical);
+
+    const name = className(canonical);
+    const _isAllStrings = e.values.every((v) => typeof v.value === 'string');
+    const isAllInts = e.values.every((v) => typeof v.value === 'number' && Number.isInteger(v.value));
+    const backingType = isAllInts ? 'int' : 'string';
+
+    const lines: string[] = [];
+    // No <?php here — the file header from fileHeader() provides it
+    lines.push(`namespace ${ctx.namespacePascal}\\Resource;`);
+    lines.push('');
+    lines.push(`enum ${name}: ${backingType}`);
+    lines.push('{');
+
+    // Deduplicate case names
+    const usedNames = new Map<string, number>();
+    for (const val of e.values) {
+      let caseName = toPascalCase(val.name.toLowerCase());
+      const baseName = caseName;
+      const count = usedNames.get(baseName) ?? 0;
+      if (count > 0) {
+        caseName = `${baseName}${count + 1}`;
+      }
+      usedNames.set(baseName, count + 1);
+
+      if (val.description || val.deprecated) {
+        const parts: string[] = [];
+        if (val.description) parts.push(val.description);
+        if (val.deprecated) parts.push('@deprecated');
+        lines.push(...phpDocComment(parts.join('\n'), 4));
+      }
+
+      if (typeof val.value === 'string') {
+        lines.push(`    case ${caseName} = '${val.value}';`);
+      } else {
+        lines.push(`    case ${caseName} = ${val.value};`);
+      }
+    }
+
+    lines.push('}');
+
+    files.push({
+      path: `lib/Resource/${name}.php`,
+      content: lines.join('\n'),
+      overwriteExisting: true,
+    });
+  }
+
+  return files;
+}

package/src/php/errors.ts

@@ -0,0 +1,9 @@
+import type { GeneratedFile } from '@workos/oagen';
+
+/**
+ * PHP exception classes are now hand-maintained in the target SDK
+ * (lib/Exception/*.php with @oagen-ignore-file).
+ */
+export function generateErrors(): GeneratedFile[] {
+  return [];
+}

package/src/php/fixtures.ts

@@ -0,0 +1,181 @@
+import type { Model, TypeRef, Enum } from '@workos/oagen';
+import { isListMetadataModel, isListWrapperModel } from './models.js';
+import { snakeName } from './naming.js';
+
+/**
+ * Prefix mapping for generating realistic ID fixture values.
+ */
+export const ID_PREFIXES: Record<string, string> = {
+  Connection: 'conn_',
+  Organization: 'org_',
+  OrganizationMembership: 'om_',
+  User: 'user_',
+  Directory: 'directory_',
+  DirectoryGroup: 'dir_grp_',
+  DirectoryUser: 'dir_usr_',
+  Invitation: 'inv_',
+  Session: 'session_',
+  AuthenticationFactor: 'auth_factor_',
+  EmailVerification: 'email_verification_',
+  MagicAuth: 'magic_auth_',
+  PasswordReset: 'password_reset_',
+};
+
+/**
+ * Generate JSON fixture files for test data.
+ */
+export function generateFixtures(spec: {
+  models: Model[];
+  enums: Enum[];
+  services: any[];
+}): { path: string; content: string }[] {
+  if (spec.models.length === 0) return [];
+
+  const modelMap = new Map(spec.models.map((m) => [m.name, m]));
+  const enumMap = new Map(spec.enums.map((e) => [e.name, e]));
+  const files: { path: string; content: string }[] = [];
+
+  for (const model of spec.models) {
+    if (isListMetadataModel(model)) continue;
+    if (isListWrapperModel(model)) continue;
+
+    const fixture = generateModelFixture(model, modelMap, enumMap);
+
+    files.push({
+      path: `tests/Fixtures/${snakeName(model.name)}.json`,
+      content: JSON.stringify(fixture, null, 2),
+    });
+  }
+
+  // Generate list fixtures for paginated responses
+  for (const service of spec.services) {
+    for (const op of service.operations) {
+      if (op.pagination) {
+        let itemModel = op.pagination.itemType.kind === 'model' ? modelMap.get(op.pagination.itemType.name) : null;
+        if (itemModel) {
+          const unwrapped = unwrapListModel(itemModel, modelMap);
+          if (unwrapped) itemModel = unwrapped;
+          if (itemModel.fields.length === 0) continue;
+          const fixture = generateModelFixture(itemModel, modelMap, enumMap);
+          const listFixture = {
+            data: [fixture],
+            list_metadata: {
+              before: null,
+              after: null,
+            },
+          };
+          files.push({
+            path: `tests/Fixtures/list_${snakeName(itemModel.name)}.json`,
+            content: JSON.stringify(listFixture, null, 2),
+          });
+        }
+      }
+    }
+  }
+
+  return files;
+}
+
+export function unwrapListModel(model: Model, modelMap: Map<string, Model>): Model | null {
+  const dataField = model.fields.find((f) => f.name === 'data');
+  const hasListMetadata = model.fields.some((f) => f.name === 'list_metadata' || f.name === 'listMetadata');
+  if (dataField && hasListMetadata && dataField.type.kind === 'array') {
+    const itemType = dataField.type.items;
+    if (itemType.kind === 'model') {
+      return modelMap.get(itemType.name) ?? null;
+    }
+  }
+  return null;
+}
+
+export function generateModelFixture(
+  model: Model,
+  modelMap: Map<string, Model>,
+  enumMap: Map<string, Enum>,
+): Record<string, any> {
+  const fixture: Record<string, any> = {};
+
+  for (const field of model.fields) {
+    const wireName = field.name;
+    if (field.example !== undefined) {
+      fixture[wireName] = field.example;
+    } else {
+      fixture[wireName] = generateFieldValue(field.type, field.name, model.name, modelMap, enumMap);
+    }
+  }
+
+  return fixture;
+}
+
+function generateFieldValue(
+  ref: TypeRef,
+  fieldName: string,
+  modelName: string,
+  modelMap: Map<string, Model>,
+  enumMap: Map<string, Enum>,
+): any {
+  switch (ref.kind) {
+    case 'primitive':
+      return generatePrimitiveValue(ref.type, ref.format, fieldName, modelName);
+    case 'literal':
+      return ref.value;
+    case 'enum': {
+      const e = enumMap.get(ref.name);
+      return e?.values[0]?.value ?? 'unknown';
+    }
+    case 'model': {
+      const nested = modelMap.get(ref.name);
+      if (nested) return generateModelFixture(nested, modelMap, enumMap);
+      return {};
+    }
+    case 'array': {
+      if (ref.items.kind === 'enum') {
+        const e = enumMap.get(ref.items.name);
+        if (e && e.values.length > 0) {
+          return e.values.map((v) => v.value);
+        }
+      }
+      const item = generateFieldValue(ref.items, fieldName, modelName, modelMap, enumMap);
+      return [item];
+    }
+    case 'nullable':
+      return generateFieldValue(ref.inner, fieldName, modelName, modelMap, enumMap);
+    case 'union':
+      if (ref.variants.length > 0) {
+        return generateFieldValue(ref.variants[0], fieldName, modelName, modelMap, enumMap);
+      }
+      return null;
+    case 'map':
+      return {
+        key: generateFieldValue(ref.valueType, 'value', modelName, modelMap, enumMap),
+      };
+  }
+}
+
+function generatePrimitiveValue(type: string, format: string | undefined, name: string, modelName: string): any {
+  switch (type) {
+    case 'string':
+      if (format === 'date-time') return '2023-01-01T00:00:00.000Z';
+      if (format === 'date') return '2023-01-01';
+      if (format === 'uuid') return '00000000-0000-0000-0000-000000000000';
+      if (name === 'id') {
+        const prefix = ID_PREFIXES[modelName] ?? '';
+        return `${prefix}01234`;
+      }
+      if (name.includes('id')) return `${name}_01234`;
+      if (name.includes('email')) return 'test@example.com';
+      if (name.includes('url') || name.includes('uri')) return 'https://example.com';
+      if (name.includes('name')) return 'Test';
+      return `test_${name}`;
+    case 'integer':
+      return 1;
+    case 'number':
+      return 1.0;
+    case 'boolean':
+      return true;
+    case 'unknown':
+      return {};
+    default:
+      return null;
+  }
+}

package/src/php/index.ts

@@ -0,0 +1,96 @@
+import type {
+  Emitter,
+  EmitterContext,
+  FormatCommand,
+  GeneratedFile,
+  ApiSpec,
+  Model,
+  Enum,
+  Service,
+} from '@workos/oagen';
+import * as fs from 'node:fs';
+import * as path from 'node:path';
+
+import { generateModels } from './models.js';
+import { generateEnums } from './enums.js';
+import { generateResources } from './resources.js';
+import { generateClient } from './client.js';
+import { generateTests } from './tests.js';
+import { generateManifest } from './manifest.js';
+import { initializeEnumDedup } from './naming.js';
+
+/** Initialize enum deduplication from spec data. */
+function ensureNamingInitialized(ctx: EmitterContext): void {
+  initializeEnumDedup(ctx.spec.enums);
+}
+
+/** Ensure every generated file's content ends with a trailing newline. */
+function ensureTrailingNewlines(files: GeneratedFile[]): GeneratedFile[] {
+  for (const f of files) {
+    if (f.content && !f.content.endsWith('\n')) {
+      f.content += '\n';
+    }
+  }
+  return files;
+}
+
+export const phpEmitter: Emitter = {
+  language: 'php',
+
+  generateModels(models: Model[], ctx: EmitterContext): GeneratedFile[] {
+    ensureNamingInitialized(ctx);
+    return ensureTrailingNewlines(generateModels(models, ctx));
+  },
+
+  generateEnums(enums: Enum[], ctx: EmitterContext): GeneratedFile[] {
+    ensureNamingInitialized(ctx);
+    return ensureTrailingNewlines(generateEnums(enums, ctx));
+  },
+
+  generateResources(services: Service[], ctx: EmitterContext): GeneratedFile[] {
+    ensureNamingInitialized(ctx);
+    return ensureTrailingNewlines(generateResources(services, ctx));
+  },
+
+  generateClient(spec: ApiSpec, ctx: EmitterContext): GeneratedFile[] {
+    ensureNamingInitialized(ctx);
+    return ensureTrailingNewlines(generateClient(spec, ctx));
+  },
+
+  generateErrors(): GeneratedFile[] {
+    return [];
+  },
+
+  generateTypeSignatures(_spec: ApiSpec, _ctx: EmitterContext): GeneratedFile[] {
+    // PHP uses inline type hints — no separate type signature files needed
+    return [];
+  },
+
+  generateTests(spec: ApiSpec, ctx: EmitterContext): GeneratedFile[] {
+    ensureNamingInitialized(ctx);
+    return ensureTrailingNewlines(generateTests(spec, ctx));
+  },
+
+  generateManifest(spec: ApiSpec, ctx: EmitterContext): GeneratedFile[] {
+    ensureNamingInitialized(ctx);
+    return ensureTrailingNewlines(generateManifest(spec, ctx));
+  },
+
+  fileHeader(): string {
+    return '<?php\n\ndeclare(strict_types=1);\n\n// This file is auto-generated by oagen. Do not edit.';
+  },
+
+  formatCommand(targetDir: string): FormatCommand | null {
+    const hasPhpCsFixer =
+      fs.existsSync(path.join(targetDir, '.php-cs-fixer.dist.php')) ||
+      fs.existsSync(path.join(targetDir, '.php-cs-fixer.php'));
+    if (hasPhpCsFixer) {
+      return {
+        cmd: 'bash',
+        args: ['-c', 'php vendor/bin/php-cs-fixer fix --using-cache=no --quiet . || true'],
+        batchSize: 999999,
+      };
+    }
+    return null;
+  },
+};

package/src/php/manifest.ts

@@ -0,0 +1,36 @@
+import type { ApiSpec, EmitterContext, GeneratedFile } from '@workos/oagen';
+import { resolveMethodName } from './naming.js';
+import { buildServiceAccessPaths } from './client.js';
+import { getMountTarget } from '../shared/resolved-ops.js';
+
+/**
+ * Generate smoke test manifest mapping HTTP operations to SDK methods.
+ */
+export function generateManifest(spec: ApiSpec, ctx: EmitterContext): GeneratedFile[] {
+  const manifest: Record<string, { sdkMethod: string; service: string }> = {};
+  const accessPaths = buildServiceAccessPaths(spec.services, ctx);
+
+  for (const service of spec.services) {
+    let propName = accessPaths.get(service.name);
+    if (!propName) {
+      const mountTarget = getMountTarget(service, ctx);
+      propName = accessPaths.get(mountTarget);
+    }
+    if (!propName) {
+      throw new Error(`Missing public client access path for service ${service.name}`);
+    }
+    for (const op of service.operations) {
+      const httpKey = `${op.httpMethod.toUpperCase()} ${op.path}`;
+      const method = resolveMethodName(op, service, ctx);
+      manifest[httpKey] = { sdkMethod: method, service: propName };
+    }
+  }
+
+  return [
+    {
+      path: 'smoke-manifest.json',
+      content: JSON.stringify(manifest, null, 2),
+      integrateTarget: false,
+    },
+  ];
+}