workos 0.11.2 → 0.12.0-beta.1

package/dist/gen-routes.ts

@@ -0,0 +1,96 @@
+#!/usr/bin/env tsx
+/**
+ * Codegen script: reads a WorkOS OpenAPI spec and generates emulator TypeScript
+ * files (entities, store, helpers, route stubs).
+ *
+ * Usage:
+ *   pnpm gen:routes path/to/openapi.yaml [--out-dir src/emulate/workos/generated]
+ *   pnpm gen:routes path/to/openapi.json --dry-run
+ *
+ * The generated code matches the hand-written patterns in src/emulate/workos/.
+ * Running twice on the same spec produces identical output (idempotent).
+ */
+
+import { readFileSync, writeFileSync, mkdirSync, existsSync } from 'node:fs';
+import { resolve, extname, join } from 'node:path';
+import YAML from 'yaml';
+
+import {
+  type OpenAPISpec,
+  parseSpec,
+  generateEntities,
+  generateStore,
+  generateHelpers,
+  generateRoutes,
+} from './gen-routes-lib.js';
+
+function main(): void {
+  const args = process.argv.slice(2);
+  const flags = args.filter((a) => a.startsWith('--'));
+  const positional = args.filter((a) => !a.startsWith('--'));
+
+  const specPath = positional[0];
+  if (!specPath) {
+    console.error('Usage: gen-routes <openapi-spec> [--out-dir <dir>] [--dry-run]');
+    process.exit(1);
+  }
+
+  const dryRun = flags.includes('--dry-run');
+  const outDirIdx = args.indexOf('--out-dir');
+  const outDir = outDirIdx !== -1 ? args[outDirIdx + 1] : 'src/emulate/workos/generated';
+
+  const resolvedSpec = resolve(specPath);
+  if (!existsSync(resolvedSpec)) {
+    console.error(`Spec file not found: ${resolvedSpec}`);
+    process.exit(1);
+  }
+
+  const raw = readFileSync(resolvedSpec, 'utf-8');
+  const ext = extname(resolvedSpec).toLowerCase();
+  let spec: OpenAPISpec;
+
+  if (ext === '.yaml' || ext === '.yml') {
+    spec = YAML.parse(raw) as OpenAPISpec;
+  } else {
+    spec = JSON.parse(raw) as OpenAPISpec;
+  }
+
+  const parsed = parseSpec(spec);
+  const output = generateAll(parsed);
+
+  if (dryRun) {
+    for (const [filename, content] of Object.entries(output)) {
+      console.log(`--- ${filename} ---`);
+      console.log(content);
+      console.log('');
+    }
+    return;
+  }
+
+  const resolvedOutDir = resolve(outDir);
+  mkdirSync(resolvedOutDir, { recursive: true });
+
+  for (const [filename, content] of Object.entries(output)) {
+    const filePath = join(resolvedOutDir, filename);
+    writeFileSync(filePath, content, 'utf-8');
+    console.log(`  wrote ${filePath}`);
+  }
+
+  console.log(`\nGenerated ${Object.keys(output).length} files in ${resolvedOutDir}`);
+}
+
+function generateAll(parsed: ReturnType<typeof parseSpec>): Record<string, string> {
+  const output: Record<string, string> = {};
+
+  output['entities.ts'] = generateEntities(parsed.entities);
+  output['store.ts'] = generateStore(parsed.entities);
+  output['helpers.ts'] = generateHelpers(parsed.entities);
+
+  for (const route of parsed.routes) {
+    output[`routes/${route.filename}`] = generateRoutes(route);
+  }
+
+  return output;
+}
+
+main();

package/dist/lib/dev-command.d.ts

@@ -0,0 +1,26 @@
+export interface DevCommandResult {
+    command: string;
+    args: string[];
+    framework: string | null;
+}
+interface PackageJson {
+    scripts?: Record<string, string>;
+    dependencies?: Record<string, string>;
+    devDependencies?: Record<string, string>;
+}
+declare function readPackageJson(projectDir: string): PackageJson | null;
+/**
+ * Resolve the dev command for a project directory.
+ *
+ * Priority:
+ * 1. `scripts.dev` from package.json (developer's config is authoritative)
+ * 2. Framework-specific default based on dependency detection
+ * 3. Non-JS framework detection (Django, Rails, Go)
+ * 4. Error — no dev command could be resolved
+ */
+export declare function resolveDevCommand(projectDir: string): Promise<DevCommandResult>;
+/**
+ * Detect the package manager used in the project.
+ */
+declare function detectPackageManager(projectDir: string): string;
+export { readPackageJson as _readPackageJson, detectPackageManager as _detectPackageManager };

package/dist/lib/dev-command.js

@@ -0,0 +1,122 @@
+import { readFileSync, existsSync } from 'node:fs';
+import { resolve, join } from 'node:path';
+/**
+ * Framework-to-dev-command mapping. Checked in order after package.json detection.
+ * Each entry maps a dependency name to a framework display name and default dev command.
+ */
+const FRAMEWORK_DEV_COMMANDS = [
+    { dep: 'next', framework: 'Next.js', command: 'next', args: ['dev'] },
+    { dep: '@remix-run/dev', framework: 'Remix', command: 'remix', args: ['dev'] },
+    { dep: 'react-router', framework: 'React Router', command: 'react-router', args: ['dev'] },
+    { dep: '@tanstack/react-start', framework: 'TanStack Start', command: 'vinxi', args: ['dev'] },
+    { dep: '@sveltejs/kit', framework: 'SvelteKit', command: 'vite', args: ['dev'] },
+    { dep: 'vite', framework: 'Vite', command: 'vite', args: ['dev'] },
+    { dep: 'nuxt', framework: 'Nuxt', command: 'nuxt', args: ['dev'] },
+    { dep: 'express', framework: 'Express', command: 'node', args: ['index.js'] },
+];
+/**
+ * Non-JS framework detection: checks for well-known files in the project directory.
+ */
+const NON_JS_FRAMEWORKS = [
+    { file: 'manage.py', framework: 'Django', command: 'python', args: ['manage.py', 'runserver'] },
+    { file: 'Gemfile', framework: 'Rails', command: 'rails', args: ['server'] },
+    { file: 'go.mod', framework: 'Go', command: 'go', args: ['run', '.'] },
+];
+function readPackageJson(projectDir) {
+    const pkgPath = resolve(projectDir, 'package.json');
+    if (!existsSync(pkgPath))
+        return null;
+    try {
+        return JSON.parse(readFileSync(pkgPath, 'utf-8'));
+    }
+    catch {
+        return null;
+    }
+}
+function hasDependency(pkg, dep) {
+    return !!(pkg.dependencies?.[dep] || pkg.devDependencies?.[dep]);
+}
+/**
+ * Resolve the npx-style command for a given binary.
+ * Returns the binary path under node_modules/.bin if it exists,
+ * otherwise returns the bare command name (assumes it's globally available).
+ */
+function resolveNodeBin(projectDir, command) {
+    const binPath = join(projectDir, 'node_modules', '.bin', command);
+    if (existsSync(binPath))
+        return binPath;
+    return command;
+}
+/**
+ * Resolve the dev command for a project directory.
+ *
+ * Priority:
+ * 1. `scripts.dev` from package.json (developer's config is authoritative)
+ * 2. Framework-specific default based on dependency detection
+ * 3. Non-JS framework detection (Django, Rails, Go)
+ * 4. Error — no dev command could be resolved
+ */
+export async function resolveDevCommand(projectDir) {
+    const pkg = readPackageJson(projectDir);
+    if (pkg) {
+        // Detect framework from dependencies first (for display purposes)
+        let detectedFramework = null;
+        for (const entry of FRAMEWORK_DEV_COMMANDS) {
+            if (hasDependency(pkg, entry.dep)) {
+                detectedFramework = entry.framework;
+                break;
+            }
+        }
+        // Priority 1: scripts.dev from package.json
+        if (pkg.scripts?.dev) {
+            // Use the package manager's run command to execute scripts.dev
+            const packageManager = detectPackageManager(projectDir);
+            return {
+                command: packageManager,
+                args: ['run', 'dev'],
+                framework: detectedFramework,
+            };
+        }
+        // Priority 2: Framework-specific default
+        for (const entry of FRAMEWORK_DEV_COMMANDS) {
+            if (hasDependency(pkg, entry.dep)) {
+                return {
+                    command: resolveNodeBin(projectDir, entry.command),
+                    args: entry.args,
+                    framework: entry.framework,
+                };
+            }
+        }
+    }
+    // Priority 3: Non-JS frameworks
+    for (const entry of NON_JS_FRAMEWORKS) {
+        if (existsSync(resolve(projectDir, entry.file))) {
+            return {
+                command: entry.command,
+                args: entry.args,
+                framework: entry.framework,
+            };
+        }
+    }
+    // No framework or scripts.dev found
+    return {
+        command: 'npm',
+        args: ['run', 'dev'],
+        framework: null,
+    };
+}
+/**
+ * Detect the package manager used in the project.
+ */
+function detectPackageManager(projectDir) {
+    if (existsSync(resolve(projectDir, 'pnpm-lock.yaml')))
+        return 'pnpm';
+    if (existsSync(resolve(projectDir, 'yarn.lock')))
+        return 'yarn';
+    if (existsSync(resolve(projectDir, 'bun.lockb')) || existsSync(resolve(projectDir, 'bun.lock')))
+        return 'bun';
+    return 'npm';
+}
+// Export for testing
+export { readPackageJson as _readPackageJson, detectPackageManager as _detectPackageManager };
+//# sourceMappingURL=dev-command.js.map

package/dist/lib/dev-command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dev-command.js","sourceRoot":"","sources":["../../src/lib/dev-command.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACnD,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAc1C;;;GAGG;AACH,MAAM,sBAAsB,GAKvB;IACH,EAAE,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,KAAK,CAAC,EAAE;IACrE,EAAE,GAAG,EAAE,gBAAgB,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,KAAK,CAAC,EAAE;IAC9E,EAAE,GAAG,EAAE,cAAc,EAAE,SAAS,EAAE,cAAc,EAAE,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,KAAK,CAAC,EAAE;IAC1F,EAAE,GAAG,EAAE,uBAAuB,EAAE,SAAS,EAAE,gBAAgB,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,KAAK,CAAC,EAAE;IAC9F,EAAE,GAAG,EAAE,eAAe,EAAE,SAAS,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,KAAK,CAAC,EAAE;IAChF,EAAE,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,KAAK,CAAC,EAAE;IAClE,EAAE,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,KAAK,CAAC,EAAE;IAClE,EAAE,GAAG,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,UAAU,CAAC,EAAE;CAC9E,CAAC;AAEF;;GAEG;AACH,MAAM,iBAAiB,GAKlB;IACH,EAAE,IAAI,EAAE,WAAW,EAAE,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,WAAW,EAAE,WAAW,CAAC,EAAE;IAC/F,EAAE,IAAI,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,QAAQ,CAAC,EAAE;IAC3E,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE;CACvE,CAAC;AAEF,SAAS,eAAe,CAAC,UAAkB;IACzC,MAAM,OAAO,GAAG,OAAO,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;IACpD,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC;QAAE,OAAO,IAAI,CAAC;IACtC,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,CAAgB,CAAC;IACnE,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED,SAAS,aAAa,CAAC,GAAgB,EAAE,GAAW;IAClD,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,YAAY,EAAE,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,eAAe,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;AACnE,CAAC;AAED;;;;GAIG;AACH,SAAS,cAAc,CAAC,UAAkB,EAAE,OAAe;IACzD,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,cAAc,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IAClE,IAAI,UAAU,CAAC,OAAO,CAAC;QAAE,OAAO,OAAO,CAAC;IACxC,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,UAAkB;IACxD,MAAM,GAAG,GAAG,eAAe,CAAC,UAAU,CAAC,CAAC;IAExC,IAAI,GAAG,EAAE,CAAC;QACR,kEAAkE;QAClE,IAAI,iBAAiB,GAAkB,IAAI,CAAC;QAC5C,KAAK,MAAM,KAAK,IAAI,sBAAsB,EAAE,CAAC;YAC3C,IAAI,aAAa,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;gBAClC,iBAAiB,GAAG,KAAK,CAAC,SAAS,CAAC;gBACpC,MAAM;YACR,CAAC;QACH,CAAC;QAED,4CAA4C;QAC5C,IAAI,GAAG,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC;YACrB,+DAA+D;YAC/D,MAAM,cAAc,GAAG,oBAAoB,CAAC,UAAU,CAAC,CAAC;YACxD,OAAO;gBACL,OAAO,EAAE,cAAc;gBACvB,IAAI,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC;gBACpB,SAAS,EAAE,iBAAiB;aAC7B,CAAC;QACJ,CAAC;QAED,yCAAyC;QACzC,KAAK,MAAM,KAAK,IAAI,sBAAsB,EAAE,CAAC;YAC3C,IAAI,aAAa,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;gBAClC,OAAO;oBACL,OAAO,EAAE,cAAc,CAAC,UAAU,EAAE,KAAK,CAAC,OAAO,CAAC;oBAClD,IAAI,EAAE,KAAK,CAAC,IAAI;oBAChB,SAAS,EAAE,KAAK,CAAC,SAAS;iBAC3B,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED,gCAAgC;IAChC,KAAK,MAAM,KAAK,IAAI,iBAAiB,EAAE,CAAC;QACtC,IAAI,UAAU,CAAC,OAAO,CAAC,UAAU,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;YAChD,OAAO;gBACL,OAAO,EAAE,KAAK,CAAC,OAAO;gBACtB,IAAI,EAAE,KAAK,CAAC,IAAI;gBAChB,SAAS,EAAE,KAAK,CAAC,SAAS;aAC3B,CAAC;QACJ,CAAC;IACH,CAAC;IAED,oCAAoC;IACpC,OAAO;QACL,OAAO,EAAE,KAAK;QACd,IAAI,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC;QACpB,SAAS,EAAE,IAAI;KAChB,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,SAAS,oBAAoB,CAAC,UAAkB;IAC9C,IAAI,UAAU,CAAC,OAAO,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC;QAAE,OAAO,MAAM,CAAC;IACrE,IAAI,UAAU,CAAC,OAAO,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;QAAE,OAAO,MAAM,CAAC;IAChE,IAAI,UAAU,CAAC,OAAO,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,IAAI,UAAU,CAAC,OAAO,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;QAAE,OAAO,KAAK,CAAC;IAC9G,OAAO,KAAK,CAAC;AACf,CAAC;AAED,qBAAqB;AACrB,OAAO,EAAE,eAAe,IAAI,gBAAgB,EAAE,oBAAoB,IAAI,qBAAqB,EAAE,CAAC","sourcesContent":["import { readFileSync, existsSync } from 'node:fs';\nimport { resolve, join } from 'node:path';\n\nexport interface DevCommandResult {\n  command: string;\n  args: string[];\n  framework: string | null;\n}\n\ninterface PackageJson {\n  scripts?: Record<string, string>;\n  dependencies?: Record<string, string>;\n  devDependencies?: Record<string, string>;\n}\n\n/**\n * Framework-to-dev-command mapping. Checked in order after package.json detection.\n * Each entry maps a dependency name to a framework display name and default dev command.\n */\nconst FRAMEWORK_DEV_COMMANDS: Array<{\n  dep: string;\n  framework: string;\n  command: string;\n  args: string[];\n}> = [\n  { dep: 'next', framework: 'Next.js', command: 'next', args: ['dev'] },\n  { dep: '@remix-run/dev', framework: 'Remix', command: 'remix', args: ['dev'] },\n  { dep: 'react-router', framework: 'React Router', command: 'react-router', args: ['dev'] },\n  { dep: '@tanstack/react-start', framework: 'TanStack Start', command: 'vinxi', args: ['dev'] },\n  { dep: '@sveltejs/kit', framework: 'SvelteKit', command: 'vite', args: ['dev'] },\n  { dep: 'vite', framework: 'Vite', command: 'vite', args: ['dev'] },\n  { dep: 'nuxt', framework: 'Nuxt', command: 'nuxt', args: ['dev'] },\n  { dep: 'express', framework: 'Express', command: 'node', args: ['index.js'] },\n];\n\n/**\n * Non-JS framework detection: checks for well-known files in the project directory.\n */\nconst NON_JS_FRAMEWORKS: Array<{\n  file: string;\n  framework: string;\n  command: string;\n  args: string[];\n}> = [\n  { file: 'manage.py', framework: 'Django', command: 'python', args: ['manage.py', 'runserver'] },\n  { file: 'Gemfile', framework: 'Rails', command: 'rails', args: ['server'] },\n  { file: 'go.mod', framework: 'Go', command: 'go', args: ['run', '.'] },\n];\n\nfunction readPackageJson(projectDir: string): PackageJson | null {\n  const pkgPath = resolve(projectDir, 'package.json');\n  if (!existsSync(pkgPath)) return null;\n  try {\n    return JSON.parse(readFileSync(pkgPath, 'utf-8')) as PackageJson;\n  } catch {\n    return null;\n  }\n}\n\nfunction hasDependency(pkg: PackageJson, dep: string): boolean {\n  return !!(pkg.dependencies?.[dep] || pkg.devDependencies?.[dep]);\n}\n\n/**\n * Resolve the npx-style command for a given binary.\n * Returns the binary path under node_modules/.bin if it exists,\n * otherwise returns the bare command name (assumes it's globally available).\n */\nfunction resolveNodeBin(projectDir: string, command: string): string {\n  const binPath = join(projectDir, 'node_modules', '.bin', command);\n  if (existsSync(binPath)) return binPath;\n  return command;\n}\n\n/**\n * Resolve the dev command for a project directory.\n *\n * Priority:\n * 1. `scripts.dev` from package.json (developer's config is authoritative)\n * 2. Framework-specific default based on dependency detection\n * 3. Non-JS framework detection (Django, Rails, Go)\n * 4. Error — no dev command could be resolved\n */\nexport async function resolveDevCommand(projectDir: string): Promise<DevCommandResult> {\n  const pkg = readPackageJson(projectDir);\n\n  if (pkg) {\n    // Detect framework from dependencies first (for display purposes)\n    let detectedFramework: string | null = null;\n    for (const entry of FRAMEWORK_DEV_COMMANDS) {\n      if (hasDependency(pkg, entry.dep)) {\n        detectedFramework = entry.framework;\n        break;\n      }\n    }\n\n    // Priority 1: scripts.dev from package.json\n    if (pkg.scripts?.dev) {\n      // Use the package manager's run command to execute scripts.dev\n      const packageManager = detectPackageManager(projectDir);\n      return {\n        command: packageManager,\n        args: ['run', 'dev'],\n        framework: detectedFramework,\n      };\n    }\n\n    // Priority 2: Framework-specific default\n    for (const entry of FRAMEWORK_DEV_COMMANDS) {\n      if (hasDependency(pkg, entry.dep)) {\n        return {\n          command: resolveNodeBin(projectDir, entry.command),\n          args: entry.args,\n          framework: entry.framework,\n        };\n      }\n    }\n  }\n\n  // Priority 3: Non-JS frameworks\n  for (const entry of NON_JS_FRAMEWORKS) {\n    if (existsSync(resolve(projectDir, entry.file))) {\n      return {\n        command: entry.command,\n        args: entry.args,\n        framework: entry.framework,\n      };\n    }\n  }\n\n  // No framework or scripts.dev found\n  return {\n    command: 'npm',\n    args: ['run', 'dev'],\n    framework: null,\n  };\n}\n\n/**\n * Detect the package manager used in the project.\n */\nfunction detectPackageManager(projectDir: string): string {\n  if (existsSync(resolve(projectDir, 'pnpm-lock.yaml'))) return 'pnpm';\n  if (existsSync(resolve(projectDir, 'yarn.lock'))) return 'yarn';\n  if (existsSync(resolve(projectDir, 'bun.lockb')) || existsSync(resolve(projectDir, 'bun.lock'))) return 'bun';\n  return 'npm';\n}\n\n// Export for testing\nexport { readPackageJson as _readPackageJson, detectPackageManager as _detectPackageManager };\n"]}

package/dist/utils/help-json.js

@@ -1006,6 +1006,29 @@ const commands = [
             },
         ],
     },
+    // --- Emulator ---
+    {
+        name: 'emulate',
+        description: 'Start a local WorkOS API emulator',
+        options: [
+            { name: 'port', type: 'number', description: 'Port to listen on', required: false, default: 4100, hidden: false },
+            {
+                name: 'seed',
+                type: 'string',
+                description: 'Path to seed config file (YAML or JSON)',
+                required: false,
+                hidden: false,
+            },
+        ],
+    },
+    {
+        name: 'dev',
+        description: 'Start emulator + your app in one command',
+        options: [
+            { name: 'port', type: 'number', description: 'Emulator port', required: false, default: 4100, hidden: false },
+            { name: 'seed', type: 'string', description: 'Path to seed config file', required: false, hidden: false },
+        ],
+    },
     // --- Workflow Commands ---
     {
         name: 'seed',