@alfredmouelle/create-stack 0.1.2 → 0.2.0

package/lib/capabilities.mjs

@@ -0,0 +1,375 @@
+// Swappable capabilities (storage, cache, jobs, logger, analytics, error-tracking).
+// Generalizes mailer.mjs: vendor a capability's core + chosen adapter into the fork,
+// generate a composition root reading typed env, and return dep/env deltas.
+// Manifest (capability.json) is the source of truth for files/deps/env; this registry
+// adds only what a manifest can't carry — the env → constructor-arg mapping.
+
+import { readdirSync, statSync } from 'node:fs'
+import { STACK_ROOT } from './paths.mjs'
+import { copy, exists, join, read, readJSON, write } from './util.mjs'
+
+const PKG = (cap) => join(STACK_ROOT, 'packages', cap)
+
+/**
+ * Per-capability wiring. `dir` = vendored destination, `entry` = exported accessor
+ * stem, `portType` = the interface returned. Each adapter maps constructor args to
+ * env keys: [argName, ENV_KEY, required?]. A required arg is narrowed via required().
+ */
+const CAPS = {
+  storage: {
+    label: 'Storage',
+    dir: 'src/server/storage',
+    entry: 'storage',
+    portType: 'StoragePort',
+    defaultAdapter: 's3',
+    adapters: {
+      s3: {
+        fn: 's3Adapter',
+        args: [
+          ['bucket', 'S3_BUCKET', true],
+          ['region', 'S3_REGION', true],
+          ['accessKeyId', 'AWS_ACCESS_KEY_ID', false],
+          ['secretAccessKey', 'AWS_SECRET_ACCESS_KEY', false],
+        ],
+      },
+      r2: {
+        fn: 'r2Adapter',
+        args: [
+          ['bucket', 'R2_BUCKET', true],
+          ['accountId', 'R2_ACCOUNT_ID', true],
+          ['accessKeyId', 'R2_ACCESS_KEY_ID', false],
+          ['secretAccessKey', 'R2_SECRET_ACCESS_KEY', false],
+        ],
+      },
+      gcs: {
+        fn: 'gcsAdapter',
+        args: [
+          ['bucket', 'GCS_BUCKET', true],
+          ['projectId', 'GOOGLE_CLOUD_PROJECT', false],
+        ],
+      },
+      local: { fn: 'localAdapter', args: [['baseDir', 'STORAGE_LOCAL_DIR', true]] },
+    },
+  },
+
+  cache: {
+    label: 'Cache',
+    dir: 'src/server/cache',
+    entry: 'cache',
+    portType: 'CachePort',
+    defaultAdapter: 'redis',
+    adapters: {
+      redis: { fn: 'redisAdapter', args: [['url', 'REDIS_URL', false]] },
+      memory: { fn: 'memoryAdapter', args: [] },
+    },
+  },
+
+  logger: {
+    label: 'Logger',
+    dir: 'src/server/logger',
+    entry: 'logger',
+    portType: 'Logger',
+    defaultAdapter: 'pino',
+    adapters: {
+      pino: { fn: 'pinoAdapter', args: [] },
+      console: { fn: 'consoleAdapter', args: [] },
+    },
+  },
+
+  analytics: {
+    label: 'Analytics',
+    dir: 'src/server/analytics',
+    entry: 'analytics',
+    portType: 'AnalyticsPort',
+    defaultAdapter: 'posthog',
+    adapters: {
+      posthog: {
+        fn: 'posthogAdapter',
+        args: [
+          ['apiKey', 'POSTHOG_API_KEY', true],
+          ['host', 'POSTHOG_HOST', false],
+        ],
+      },
+      plausible: {
+        fn: 'plausibleAdapter',
+        args: [
+          ['domain', 'PLAUSIBLE_DOMAIN', true],
+          ['apiHost', 'PLAUSIBLE_API_HOST', false],
+        ],
+      },
+      noop: { fn: 'noopAdapter', args: [] },
+    },
+  },
+
+  'error-tracking': {
+    label: 'Error tracking',
+    dir: 'src/server/error-tracking',
+    entry: 'errorTracking',
+    portType: 'ErrorTrackingPort',
+    defaultAdapter: 'sentry',
+    adapters: {
+      sentry: {
+        fn: 'sentryAdapter',
+        args: [
+          ['dsn', 'SENTRY_DSN', true],
+          ['environment', 'SENTRY_ENVIRONMENT', false],
+        ],
+      },
+      console: { fn: 'consoleAdapter', args: [] },
+    },
+  },
+
+  jobs: {
+    label: 'Background jobs',
+    dir: 'src/server/jobs',
+    entry: 'jobs',
+    kind: 'jobs', // bespoke: concrete adapter (serving) + HTTP surface
+    defaultAdapter: 'inngest',
+    adapters: {
+      inngest: { fn: 'inngestAdapter' },
+      trigger: { fn: 'triggerDevAdapter' },
+      memory: { fn: 'memoryAdapter' },
+    },
+  },
+}
+
+export const CAPABILITIES = Object.keys(CAPS)
+
+/** Prompt options for the capability multiselect. */
+export const capabilityChoices = () =>
+  CAPABILITIES.map((name) => ({
+    value: name,
+    label: CAPS[name].label,
+    hint: Object.keys(CAPS[name].adapters).join(' / '),
+  }))
+
+/** Adapter options + default for one capability (drives the per-capability select). */
+export const adapterChoices = (cap) => ({
+  defaultAdapter: CAPS[cap].defaultAdapter,
+  options: Object.keys(CAPS[cap].adapters).map((value) => ({ value, label: value })),
+})
+
+/** Resolve a possibly-empty flag value to a valid adapter, or throw. */
+export function resolveAdapter(cap, value) {
+  const spec = CAPS[cap]
+  if (!spec) throw new Error(`Unknown capability: ${cap}`)
+  if (value === true || value == null || value === '') return spec.defaultAdapter
+  if (!spec.adapters[value]) {
+    throw new Error(
+      `Unknown ${cap} adapter: ${value} (have ${Object.keys(spec.adapters).join(', ')})`,
+    )
+  }
+  return value
+}
+
+const REQUIRED_HELPER = `
+function required(value: string | undefined, name: string): string {
+  if (!value) throw new Error(\`\${name} is required\`)
+  return value
+}
+`
+
+/** Object-literal body mapping constructor args to env (required ones narrowed). */
+const ctorArgs = (args) =>
+  args
+    .map(([name, key, req]) =>
+      req ? `      ${name}: required(env.${key}, '${key}'),` : `      ${name}: env.${key},`,
+    )
+    .join('\n')
+
+/** Lazy-singleton composition root: boots without env, constructs on first use. */
+function standardRoot({ entry, portType, adapterKey, fn, args }) {
+  const getter = `get${entry[0].toUpperCase()}${entry.slice(1)}`
+  const hasRequired = args.some((a) => a[2])
+  const ctor = args.length ? `${fn}({\n${ctorArgs(args)}\n    })` : `${fn}()`
+  const envImport = args.length ? "import { env } from '~/env'\n" : ''
+  return `${envImport}import { ${fn} } from './adapters/${adapterKey}/index'
+import type { ${portType} } from './core/port'
+${hasRequired ? REQUIRED_HELPER : ''}
+let instance: ${portType} | null = null
+export function ${getter}(): ${portType} {
+  if (!instance) {
+    instance = ${ctor}
+  }
+  return instance
+}
+`
+}
+
+/** Slug usable as an Inngest app id (no slashes, lowercase). */
+const slug = (name) =>
+  name
+    .split('/')
+    .pop()
+    .replace(/[^a-z0-9]+/gi, '-')
+    .replace(/^-+|-+$/g, '')
+    .toLowerCase() || 'app'
+
+/** Jobs needs the concrete adapter object (for serving), so it exports an eager const. */
+function jobsRoot(adapterKey, projectName) {
+  if (adapterKey === 'inngest') {
+    return `import { env } from '~/env'
+import { inngestAdapter } from './adapters/inngest/index'
+
+// Composition root — register jobs with jobs.defineJob(), trigger with jobs.trigger().
+export const jobs = inngestAdapter({
+  id: '${slug(projectName)}',
+  eventKey: env.INNGEST_EVENT_KEY,
+})
+`
+  }
+  if (adapterKey === 'trigger') {
+    return `import { env } from '~/env'
+import { triggerDevAdapter } from './adapters/trigger/index'
+
+// Composition root — register jobs with jobs.defineJob(), trigger with jobs.trigger().
+export const jobs = triggerDevAdapter({
+  secretKey: env.TRIGGER_SECRET_KEY,
+})
+`
+  }
+  return `import { memoryAdapter } from './adapters/memory/index'
+
+// In-process composition root (dev/tests) — runs handlers inline on trigger().
+export const jobs = memoryAdapter()
+`
+}
+
+const JOBS_SERVE = `import { serve } from 'inngest/edge'
+import { env } from '~/env'
+import { inngestServeHandler } from './adapters/inngest/index'
+import { jobs } from './index'
+
+// Web-standard FetchHandler serving the registered functions; mounted by the route shim.
+export const handler = inngestServeHandler(jobs, serve, {
+  signingKey: env.INNGEST_SIGNING_KEY,
+})
+`
+
+const NEXT_INNGEST_ROUTE = `import { handler } from '~/server/jobs/serve'
+
+export { handler as GET, handler as POST, handler as PUT }
+`
+
+const TANSTACK_INNGEST_ROUTE = `import { createFileRoute } from '@tanstack/react-router'
+import type {} from '@tanstack/react-start'
+import { handler } from '~/server/jobs/serve'
+
+export const Route = createFileRoute('/api/inngest')({
+  server: {
+    handlers: {
+      GET: ({ request }) => handler(request),
+      POST: ({ request }) => handler(request),
+      PUT: ({ request }) => handler(request),
+    },
+  },
+})
+`
+
+/** Copy a manifest path (rooted at the package) under destDir, stripping `src/`. */
+function copyPath(cap, relSrc, destDir) {
+  copy(join(PKG(cap), relSrc), join(destDir, relSrc.replace(/^src\//, '')))
+}
+
+/** True if any vendored .ts file under dir still imports a cross-package. */
+function references(dir, mod) {
+  for (const name of readdirSync(dir, { recursive: true })) {
+    const p = join(dir, name)
+    if (statSync(p).isFile() && /\.tsx?$/.test(p) && read(p).includes(mod)) return true
+  }
+  return false
+}
+
+/** Run fn(path, source) over every vendored .ts/.tsx file under dir. */
+function walkTs(dir, fn) {
+  for (const name of readdirSync(dir, { recursive: true })) {
+    const p = join(dir, name)
+    if (statSync(p).isFile() && /\.tsx?$/.test(p)) fn(p, read(p))
+  }
+}
+
+/** Rewrite every `from`-module import to `to` across vendored .ts files. */
+function rewriteImports(dir, from, to) {
+  walkTs(dir, (p, src) => {
+    if (src.includes(from)) write(p, src.split(from).join(to))
+  })
+}
+
+// Package source uses NodeNext `.js` extensions on relative imports (for tsdown);
+// the base app + app bundlers (Next/Vite) expect extensionless. Strip them on vendor.
+const JS_EXT = /(from\s+['"]\.\.?\/[^'"]*?)\.js(['"])/g
+
+/** Drop `.js` from relative import specifiers across vendored .ts files. */
+function stripJsExtensions(dir) {
+  walkTs(dir, (p, src) => {
+    const next = src.replace(JS_EXT, '$1$2')
+    if (next !== src) write(p, next)
+  })
+}
+
+/** Vendor @alfredmouelle/http into src/lib/http (once) and point imports at it. */
+function vendorHttp(projectDir, destDir) {
+  if (!references(destDir, '@alfredmouelle/http')) return
+  const httpDest = join(projectDir, 'src/lib/http')
+  if (!exists(httpDest)) {
+    copy(join(STACK_ROOT, 'packages/http/src'), httpDest)
+    stripJsExtensions(httpDest)
+  }
+  rewriteImports(destDir, '@alfredmouelle/http', '~/lib/http')
+}
+
+/** Dep ranges from the capability's manifest; skips vendored @alfredmouelle/* deps. */
+function resolveDeps(cap, names) {
+  const pkg = readJSON(join(PKG(cap), 'package.json'))
+  const out = {}
+  for (const d of names) {
+    if (d.startsWith('@alfredmouelle/')) continue
+    out[d] = pkg.dependencies?.[d] ?? 'latest'
+  }
+  return out
+}
+
+/**
+ * Vendor one capability into the fork.
+ * @returns {{ addDeps: Record<string,string>, envKeys: string[] }}
+ */
+export function vendorCapability({ projectDir, framework, projectName, cap, adapter }) {
+  const spec = CAPS[cap]
+  if (!spec) throw new Error(`Unknown capability: ${cap}`)
+  const aSpec = spec.adapters[adapter]
+  if (!aSpec) throw new Error(`Unknown ${cap} adapter: ${adapter}`)
+
+  const manifest = readJSON(join(PKG(cap), 'capability.json'))
+  const adManifest = manifest.adapters[adapter]
+  const destDir = join(projectDir, spec.dir)
+
+  // core (+ shared) and the chosen adapter; the barrel index.ts is replaced below.
+  const files = [...manifest.sharedFiles.filter((f) => f !== 'src/index.ts'), ...adManifest.files]
+  for (const f of files) copyPath(cap, f, destDir)
+  stripJsExtensions(destDir) // NodeNext `.js` specifiers → extensionless (app bundler)
+
+  // composition root
+  write(
+    join(destDir, 'index.ts'),
+    spec.kind === 'jobs'
+      ? jobsRoot(adapter, projectName)
+      : standardRoot({ ...spec, adapterKey: adapter, fn: aSpec.fn, args: aSpec.args }),
+  )
+
+  // jobs/inngest has an HTTP surface: serve handler + per-framework route shim.
+  if (spec.kind === 'jobs' && adapter === 'inngest') {
+    write(join(destDir, 'serve.ts'), JOBS_SERVE)
+    if (framework === 'next') {
+      write(join(projectDir, 'src/app/api/inngest/route.ts'), NEXT_INNGEST_ROUTE)
+    } else {
+      write(join(projectDir, 'src/routes/api/inngest.ts'), TANSTACK_INNGEST_ROUTE)
+    }
+  }
+
+  vendorHttp(projectDir, destDir)
+
+  return {
+    addDeps: resolveDeps(cap, [...adManifest.deps, ...(manifest.sharedDeps ?? [])]),
+    envKeys: adManifest.env,
+  }
+}

package/lib/env.mjs

@@ -16,6 +16,27 @@ const SCHEMAS = {
   AWS_REGION: 'v.optional(v.pipe(v.string(), v.minLength(1)))',
   AWS_ACCESS_KEY_ID: 'v.optional(v.pipe(v.string(), v.minLength(1)))',
   AWS_SECRET_ACCESS_KEY: 'v.optional(v.pipe(v.string(), v.minLength(1)))',
+  // capabilities — all optional; adapters validate required-ness at first use.
+  // emptyStringAsUndefined (env.ts) turns blank placeholders into undefined.
+  S3_BUCKET: 'v.optional(v.pipe(v.string(), v.minLength(1)))',
+  S3_REGION: 'v.optional(v.pipe(v.string(), v.minLength(1)))',
+  R2_BUCKET: 'v.optional(v.pipe(v.string(), v.minLength(1)))',
+  R2_ACCOUNT_ID: 'v.optional(v.pipe(v.string(), v.minLength(1)))',
+  R2_ACCESS_KEY_ID: 'v.optional(v.pipe(v.string(), v.minLength(1)))',
+  R2_SECRET_ACCESS_KEY: 'v.optional(v.pipe(v.string(), v.minLength(1)))',
+  GCS_BUCKET: 'v.optional(v.pipe(v.string(), v.minLength(1)))',
+  GOOGLE_CLOUD_PROJECT: 'v.optional(v.pipe(v.string(), v.minLength(1)))',
+  STORAGE_LOCAL_DIR: 'v.optional(v.pipe(v.string(), v.minLength(1)))',
+  REDIS_URL: 'v.optional(v.pipe(v.string(), v.url()))',
+  POSTHOG_API_KEY: 'v.optional(v.pipe(v.string(), v.minLength(1)))',
+  POSTHOG_HOST: 'v.optional(v.pipe(v.string(), v.url()))',
+  PLAUSIBLE_DOMAIN: 'v.optional(v.pipe(v.string(), v.minLength(1)))',
+  PLAUSIBLE_API_HOST: 'v.optional(v.pipe(v.string(), v.url()))',
+  SENTRY_DSN: 'v.optional(v.pipe(v.string(), v.minLength(1)))',
+  SENTRY_ENVIRONMENT: 'v.optional(v.pipe(v.string(), v.minLength(1)))',
+  INNGEST_EVENT_KEY: 'v.optional(v.pipe(v.string(), v.minLength(1)))',
+  INNGEST_SIGNING_KEY: 'v.optional(v.pipe(v.string(), v.minLength(1)))',
+  TRIGGER_SECRET_KEY: 'v.optional(v.pipe(v.string(), v.minLength(1)))',
 }
 
 /** Placeholder values for generated .env files. */

package/lib/scaffold.mjs

@@ -20,6 +20,7 @@ const PNPM_WORKSPACE = `allowBuilds:
   esbuild: true
   sharp: true
   lightningcss: true
+  protobufjs: true
 `
 
 // Generated explicitly: npm strips `.gitignore` from published tarballs, so the

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alfredmouelle/create-stack",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "type": "module",
   "description": "Interactive, deterministic installer for the personal reference stack — forks a base app (Next.js / TanStack Start) and strips it to your selection.",
   "author": {