@sidebase/base-config 0.2.0 → 0.2.2

package/dist/config.d.ts

@@ -1,19 +1,16 @@
-import { C as CreateSidebaseEslintOptions } from './shared/base-config.CuUhyvQo.js';
+import { C as CreateSidebaseEslintOptions } from './shared/base-config.BoberVUk.js';
 
 /**
- * Version-baseline profile, named for the framework AND its major so two majors can
- * coexist during a migration: the manifest declares one profile per major with its own
- * `detect.majorIs`, and each repo detects the one matching its own Nuxt version.
+ * Version-baseline profile, named for the framework and its major so two majors can
+ * coexist during a migration.
  *
- * The name MUST match a `versionProfiles` key in the preset chain. The CLI resolves the
- * baseline with `versionProfiles?.[profile] ?? {}`, so a name nothing declares reconciles
- * NOTHING, silently. `scripts/validate-presets.mjs` fails the build on that mismatch.
+ * An unknown name reconciles nothing, silently. `scripts/validate-presets.mjs` fails
+ * the build on that mismatch.
  */
 type Profile = "nuxt-4";
 /**
- * Optional CI knobs (`config.ci.*`) the nuxt-app preset understands: the job
- * toggles. Keys mirror the manifest's `ci.*` `configKeys`; the consistency test
- * in `test/config.test.ts` proves they stay in lockstep.
+ * CI job knobs (`config.ci.*`). Keys mirror the manifest's `ci.*` `configKeys`, and
+ * `test/config.test.ts` proves the two stay in lockstep.
  */
 interface NuxtBaseCiConfig {
     /** Include the `pnpm test` job. */
@@ -21,22 +18,19 @@ interface NuxtBaseCiConfig {
     /** Include the e2e job + postgres service. */
     e2e?: boolean;
     /**
-     * System packages apt-installed in the `test` and `e2e` jobs before
-     * `pnpm install`, for a binary the suite needs that `ubuntu-latest` does not
-     * ship (the motivating case: `libxml2-utils` for `xmllint`). Empty by default,
-     * which renders the install step inert rather than absent. Package names only:
-     * each element is metacharacter-checked, then the joined string is re-validated
-     * by the manifest pattern, because the rendered `run:` line is deliberately
-     * unquoted so word splitting reaches apt-get.
+     * Packages apt-installed in the `test` and `e2e` jobs, for a binary the suite needs
+     * that `ubuntu-latest` lacks. Empty renders the install step inert, not absent.
+     *
+     * Package names only: the rendered `run:` line is unquoted so word splitting reaches
+     * apt-get, so every element is metacharacter-checked.
      */
     aptPackages?: string[];
 }
 /**
- * Optional runtime version pins (`config.versions.*`). `node` feeds every
- * render (`ci.yml`, the Dockerfile, the upgrade-PR workflow); `pnpm` feeds the
- * Dockerfile only. CI takes its pnpm from `package.json#packageManager`, the
- * single reconciled source, so it is never passed to `pnpm/action-setup`.
- * Defaults come from the version baseline (node 24.13.0, pnpm 10.28.1).
+ * Runtime version pins (`config.versions.*`). `node` feeds every render (`ci.yml`,
+ * the Dockerfile, the upgrade workflow); `pnpm` feeds the Dockerfile only, because CI
+ * takes pnpm from `package.json#packageManager`. Defaults come from the version
+ * baseline (node 24.13.0, pnpm 10.28.1).
  */
 interface NuxtBaseVersionsConfig {
     /** Node version for CI jobs, the Docker base image, and the upgrade workflow. */
@@ -52,16 +46,15 @@ interface NuxtBaseVersionsConfig {
  */
 interface NuxtBaseDockerConfig {
     /**
-     * Project-owned apt packages for the production stage, ON TOP of the baked-in
-     * baseline (`openssl`: the Prisma query engine generated in the build stage
-     * dynamically links libssl3, which slim images do not ship).
+     * Apt packages for the production stage, on top of the baked-in `openssl`, which is
+     * always installed because the Prisma query engine links libssl3 and slim images do
+     * not ship it.
      */
     aptPackages?: string[];
     /**
-     * Raw Dockerfile text injected in the build stage BEFORE `pnpm install`, e.g.
-     * a `COPY ./vendor ./vendor` a repo needs present at install time. Lands
-     * verbatim; see the trust note below. Global installs must use `npm i -g`
-     * (`PNPM_HOME` is not set, so `pnpm add -g` fails to find its bin dir).
+     * Raw Dockerfile text injected in the build stage before `pnpm install`, e.g. a
+     * `COPY ./vendor ./vendor` needed at install time. Lands verbatim. Global installs
+     * must use `npm i -g`: `PNPM_HOME` is unset, so `pnpm add -g` cannot find its bin dir.
      */
     preInstall?: string;
     /**
@@ -77,15 +70,14 @@ interface NuxtBaseDockerConfig {
     buildSteps?: string;
     /**
      * Raw Dockerfile text injected in the final stage BEFORE `CMD`, e.g. extra
-     * `ENV`, `COPY --from`, or `RUN`. Lands verbatim. Cannot drop the fixed
-     * `USER node` switch, which sits below it.
+     * `ENV`, `COPY --from`, or `RUN`. Lands verbatim. The container runs as root,
+     * so a repo that wants an unprivileged runtime appends its own `USER` here.
      */
     finalStage?: string;
     /**
      * The final-stage Prisma runtime block (copy the schema, install the CLI for
      * `migrate deploy`). Defaults to that block; set `""` for a repo with no
-     * Prisma. The `USER node` switch and the `.output` ownership are FIXED outside
-     * this knob, so an override cannot re-root the container. Lands verbatim.
+     * Prisma. The `.output` ownership is FIXED outside this knob. Lands verbatim.
      */
     prismaRuntime?: string;
     /**
@@ -101,25 +93,26 @@ interface NuxtBaseDockerConfig {
     startCommand?: string;
 }
 /**
- * Optional automation knobs (`config.automation.*`) the base preset understands:
- * the opt-in upgrade-PR workflow and its runtime version pins. Keys mirror the
- * manifest's `automation.*` `configKeys`; the consistency test in
- * `test/config.test.ts` proves they stay in lockstep.
+ * Automation knobs (`config.automation.*`) for the opt-in upgrade-PR workflow. Keys
+ * mirror the manifest's `automation.*` `configKeys`, checked by `test/config.test.ts`.
  */
 interface NuxtBaseAutomationConfig {
     /** Sync the weekly streamctl upgrade-PR workflow (default: off, no workflow lands). */
     upgradePr?: boolean;
+    /** Let upgrade PRs change GitHub Actions workflows (default: false). */
+    allowWorkflowUpdates?: boolean;
+    /** Repository secret used when workflow updates are allowed. */
+    prTokenSecret?: string;
 }
 /**
- * Optional supply-chain knobs (`config.security.*`) the base preset understands:
- * the pnpm install cooldown rendered into the managed `pnpm-workspace.yaml`.
+ * Supply-chain knobs (`config.security.*`): the pnpm install cooldown rendered into
+ * the managed `pnpm-workspace.yaml`.
  */
 interface NuxtBaseSecurityConfig {
     /**
-     * Minutes a version must have been published before pnpm resolves it
-     * (`minimumReleaseAge`). Default `"10080"` (7 days); `"0"` disables the cooldown.
-     * A STRING because the manifest's `configKeys` has no number type, same as the
-     * `versions.*` pins.
+     * Minutes a version must have been published before pnpm resolves it. Default
+     * `"10080"` (7 days), `"0"` disables it. A string because the manifest's
+     * `configKeys` has no number type, same as the `versions.*` pins.
      */
     minimumReleaseAge?: string;
 }
@@ -129,33 +122,29 @@ interface NuxtBaseSecurityConfig {
  */
 interface NuxtBasePnpmConfig {
     /**
-     * Packages allowed to run install lifecycle scripts, ON TOP of the baked-in
-     * baseline (`@prisma/client`, `esbuild`, `prisma`). Use this instead of
-     * `pnpm approve-builds`, which writes to the managed file and is reverted on
-     * the next sync.
+     * Packages allowed to run install lifecycle scripts, on top of the baseline
+     * (`@prisma/client`, `esbuild`, `prisma`). Use this instead of `pnpm approve-builds`,
+     * which writes to the managed file and is reverted on the next sync.
      */
     onlyBuiltDependencies?: string[];
 }
 /**
- * Optional editor knobs (`config.editor.*`) rendered into the managed
- * `.vscode/settings.json`. Only the i18n-ally source language varies across the
- * fleet; the locales path and key style are payload-enforced.
+ * Editor knobs (`config.editor.*`) rendered into the managed `.vscode/settings.json`.
+ * Only the i18n-ally source language varies across the fleet.
  */
 interface NuxtBaseEditorConfig {
     /**
-     * Source locale i18n-ally translates FROM (`i18n-ally.sourceLanguage`).
-     * Default `"de"`, the fleet majority; repos authoring in English set `"en"`.
-     * A BCP-47-ish tag (`de`, `pt-BR`, `zh-Hans-CN`); the manifest's `pattern`
-     * rejects anything that could break the rendered JSON string.
+     * Source locale i18n-ally translates from. Default `"de"`; repos authoring in
+     * English set `"en"`. A BCP-47-ish tag (`de`, `pt-BR`, `zh-Hans-CN`); the manifest
+     * pattern rejects anything that could break the rendered JSON string.
      */
     i18nSourceLanguage?: string;
 }
 /**
- * The typed `streamctl.config.ts` shape for the `@sidebase/base-config` payload:
- * the CLI-universal fields plus this payload's declared knobs (`ci`, `versions`,
- * `docker`, `automation`, `eslint`) with their real option types. The generic CLI only
- * shape-checks these against the manifest's `configKeys`, so the precise types live
- * here, next to the payload that owns them, and consumers keep a fully typed config.
+ * The typed `streamctl.config.ts` shape for this payload: the CLI-universal fields plus
+ * the declared knobs with their real option types. The CLI only shape-checks knobs
+ * against the manifest's `configKeys`, so the precise types live here, next to the
+ * payload that owns them, and consumers keep a fully typed config.
  */
 interface NuxtBaseConfig {
     /** The payload package this repo syncs from. */
@@ -190,9 +179,8 @@ interface NuxtBaseConfig {
     eslint?: CreateSidebaseEslintOptions;
 }
 /**
- * Identity helper for a typed `streamctl.config.ts`, the payload analog of the
- * CLI's `defineStreamctlConfig`, adding editor inference for this payload's knobs.
- * Returns the config unchanged; the CLI validates it at load.
+ * Identity helper giving editor inference for this payload's knobs, the analog of the
+ * CLI's `defineStreamctlConfig`. Returns the config unchanged; the CLI validates it.
  */
 declare function defineNuxtBaseConfig(config: NuxtBaseConfig): NuxtBaseConfig;
 /** Runtime list of every {@link NuxtBaseCiConfig} key. */
@@ -210,11 +198,9 @@ declare const NUXT_BASE_PNPM_KEYS: string[];
 /** Runtime list of every {@link NuxtBaseEditorConfig} key. */
 declare const NUXT_BASE_EDITOR_KEYS: string[];
 /**
- * Every payload KNOB dot-path {@link NuxtBaseConfig} declares (the `ci.*` and
- * `automation.*` leaves plus the top-level knobs); excludes the CLI-universal
- * fields. The consistency test asserts this set equals the RESOLVED preset chain's
- * declared `configKeys` (base + nuxt-app), catching drift between the type and the
- * manifest in either direction.
+ * Every knob dot-path {@link NuxtBaseConfig} declares, excluding the CLI-universal
+ * fields. The consistency test asserts this set equals the resolved preset chain's
+ * `configKeys`, catching drift between the type and the manifest in either direction.
  */
 declare const NUXT_BASE_CONFIG_KEYS: string[];
 

package/dist/config.mjs

@@ -24,7 +24,9 @@ const NUXT_BASE_DOCKER_KEYS = knobKeys({
   startCommand: 0
 });
 const NUXT_BASE_AUTOMATION_KEYS = knobKeys({
-  upgradePr: 0
+  upgradePr: 0,
+  allowWorkflowUpdates: 0,
+  prTokenSecret: 0
 });
 const NUXT_BASE_SECURITY_KEYS = knobKeys({
   minimumReleaseAge: 0

package/dist/eslint/index.d.mts

@@ -1,5 +1,5 @@
-import { C as CreateSidebaseEslintOptions } from '../shared/base-config.CuUhyvQo.mjs';
-export { E as ESLINT_OPTION_KEYS } from '../shared/base-config.CuUhyvQo.mjs';
+import { C as CreateSidebaseEslintOptions } from '../shared/base-config.BoberVUk.mjs';
+export { E as ESLINT_OPTION_KEYS } from '../shared/base-config.BoberVUk.mjs';
 import antfu, { TypedFlatConfigItem } from '@antfu/eslint-config';
 
 /** {@link CreateSidebaseEslintOptions} with all defaults applied + the computed type-aware gate. */
@@ -20,10 +20,7 @@ interface ResolvedEslintOptions {
     testFilePattern: string[];
     typeAware: boolean;
 }
-/**
- * Whether type-aware linting is on: gated behind `LINT_TYPEAWARE=true` so the
- * slower type-aware pass stays opt-in (CI/local override).
- */
+/** Type-aware linting is gated behind `LINT_TYPEAWARE=true` because it is slow. */
 declare function isTypeAware(): boolean;
 /** Apply the documented option defaults and resolve the type-aware gate. */
 declare function resolveEslintOptions(options?: CreateSidebaseEslintOptions): ResolvedEslintOptions;

package/dist/eslint/index.d.ts

@@ -1,5 +1,5 @@
-import { C as CreateSidebaseEslintOptions } from '../shared/base-config.CuUhyvQo.js';
-export { E as ESLINT_OPTION_KEYS } from '../shared/base-config.CuUhyvQo.js';
+import { C as CreateSidebaseEslintOptions } from '../shared/base-config.BoberVUk.js';
+export { E as ESLINT_OPTION_KEYS } from '../shared/base-config.BoberVUk.js';
 import antfu, { TypedFlatConfigItem } from '@antfu/eslint-config';
 
 /** {@link CreateSidebaseEslintOptions} with all defaults applied + the computed type-aware gate. */
@@ -20,10 +20,7 @@ interface ResolvedEslintOptions {
     testFilePattern: string[];
     typeAware: boolean;
 }
-/**
- * Whether type-aware linting is on: gated behind `LINT_TYPEAWARE=true` so the
- * slower type-aware pass stays opt-in (CI/local override).
- */
+/** Type-aware linting is gated behind `LINT_TYPEAWARE=true` because it is slow. */
 declare function isTypeAware(): boolean;
 /** Apply the documented option defaults and resolve the type-aware gate. */
 declare function resolveEslintOptions(options?: CreateSidebaseEslintOptions): ResolvedEslintOptions;

package/dist/eslint/index.mjs

@@ -107,30 +107,27 @@ function buildEslintLayers(options) {
         imports: "always-multiline"
       }],
       "space-infix-ops": ["error"],
-      // `node/prefer-global/process` is NOT set here: antfu 7.4.3 registers
-      // eslint-plugin-n (`node`) only inside its own files-scoped object, so setting
-      // the rule in this plugin-less layer makes ESLint 10 ABORT. It is instead
-      // neutralized to `"off"` via `.override("antfu/node/rules")` in
-      // `createSidebaseEslint`, inside antfu's node-scoped object where the plugin
-      // is registered (see the comment there). The `no-restricted-properties`
-      // process.env ban below carries the real guard.
+      // `node/prefer-global/process` is deliberately not set here: antfu registers
+      // eslint-plugin-n only inside its own files-scoped object, so setting the rule in
+      // this plugin-less layer makes ESLint 10 abort. It is neutralized via
+      // `.override("antfu/node/rules")` in `createSidebaseEslint` instead. The
+      // `no-restricted-properties` process.env ban below carries the real guard.
       "no-unused-expressions": ["error"],
       "no-param-reassign": ["error"],
       "no-fallthrough": ["error"],
       "require-await": ["error"],
       "ts/no-non-null-assertion": ["error"],
-      // antfu leaves `ts/no-explicit-any` off; this baseline enforces it, matching the
-      // shipped `AGENTS.md` ban on `any`. Breaking for consumers (Q5, Option A).
+      // antfu leaves `ts/no-explicit-any` off. This baseline enforces it, matching the
+      // shipped `AGENTS.md` ban on `any`. Breaking for consumers on adoption.
       "ts/no-explicit-any": "error",
       // Type-aware rules antfu enables that this baseline turns off.
       "ts/no-misused-promises": "off",
       "ts/no-unsafe-call": "off",
       "ts/strict-boolean-expressions": "off",
       "ts/promise-function-async": "off",
-      // Newer antfu rules outside the established house baseline. `prefer-static-regex`
-      // is a perf nudge the consuming apps never adopted; `custom-event-name-casing`
-      // is actively wrong for naive-ui's kebab `update:*` v-model events. Off by
-      // default; a repo can opt back in via `.append()`.
+      // Newer antfu rules outside the house baseline. `prefer-static-regex` is a perf
+      // nudge the apps never adopted, and `custom-event-name-casing` is wrong for
+      // naive-ui's kebab `update:*` v-model events. Opt back in via `.append()`.
       "e18e/prefer-static-regex": "off",
       "vue/custom-event-name-casing": "off"
     }
@@ -141,17 +138,14 @@ function buildEslintLayers(options) {
   });
   configs.push({
     name: "sidebase/console",
-    // Source files only: antfu's markdown processor lints fenced code
-    // blocks as virtual `*.md/*` files, so an un-scoped `no-console` fires inside
-    // README/doc examples. This carve-out leaves real `.ts`/`.vue`/... enforcement intact.
+    // Source files only. antfu's markdown processor lints fenced code blocks as virtual
+    // `*.md/*` files, so an un-scoped `no-console` fires inside doc examples.
     ignores: ["**/*.md/**"],
     rules: {
-      // Always pass an explicit options object: a severity-only override would
-      // retain antfu's `{ allow: ["warn", "error"] }`. `"error"` (hard-ban)
-      // emits `{}` (no-console's schema rejects an empty `allow` array), which
-      // replaces those options so every `console.*` is banned. An empty
-      // allow-list was normalized to `"error"` in resolveEslintOptions, so the
-      // array branch here is always a non-empty allow-list (no cast needed).
+      // Always pass an explicit options object, or a severity-only override retains
+      // antfu's `{ allow: ["warn", "error"] }`. A hard ban emits `{}`, since no-console
+      // rejects an empty `allow` array. `resolveEslintOptions` already normalized an
+      // empty allow-list to `"error"`, so the array branch is always non-empty.
       "no-console": options.console === "error" ? ["error", {}] : ["error", { allow: options.console }]
     }
   });
@@ -229,48 +223,23 @@ function createSidebaseEslint(options = {}) {
   return antfu(
     {
       type: "app",
-      // `local.*` files and directories are personal, git-ignored scratch space
-      // and are never linted.
-      ignores: ["**/local.*", "**/local.*/**"],
-      // Org house style: 2-space indent, single quotes, Vue on,
-      // JSON/YAML linting off (handled elsewhere).
+      // Personal scratch space. Root-anchored so `src/path/local.ts` stays linted.
+      ignores: ["local.*", "local.*/**", "prisma/local.*", "prisma/local.*/**"],
+      // House style. JSON and YAML linting are handled elsewhere.
       stylistic: { indent: 2, quotes: "single" },
       vue: true,
       jsonc: false,
       yaml: false,
-      // Type-aware is gated behind `LINT_TYPEAWARE`; when on, point at the repo
-      // tsconfig and exclude the configured paths from the type-aware program.
+      // Gated behind `LINT_TYPEAWARE`. When on, point at the repo tsconfig and
+      // exclude the configured paths from the type-aware program.
       typescript: resolved.typeAware ? { tsconfigPath: "tsconfig.json", ignoresTypeAware: resolved.ignoresTypeAware } : true
     },
     ...buildEslintLayers(resolved)
   ).override("antfu/node/rules", {
-    // antfu 7.4.3's node layer defaults `node/prefer-global/process` to
-    // `["error", "never"]` (demands `require("process")`), which flags EVERY legit
-    // global `process` use in an ESM Nuxt app (env modules, server plugins, loggers).
-    // Leaving the rule unset is not enough: antfu's `never` then wins in consumer
-    // resolution. Neutralize it HERE, inside antfu's own node-scoped config where the
-    // `node` plugin IS registered; setting it in a plugin-less object makes ESLint 10
-    // abort. `"off"`, not `["error", "always"]`, because `"always"` would wrongly flag
-    // the generated Prisma client's `import * as process from 'node:process'`.
-    //
-    // Note what this does NOT mean. prefer-global is not merely redundant here:
-    // `["error", "always"]` would also close a real hole, because
-    // `no-restricted-properties` keys on the `process.env` MEMBER EXPRESSION, and any
-    // import that renames the binding erases the shape it matches. Measured against
-    // this factory, the property ban alone catches `process.env.X`,
-    // `const { env } = process`, and a default import still named `process`, but NOT
-    // `import { env }`, `import { env as e }`, `import * as proc`, or
-    // `import proc from "node:process"`. Those are closed at the import site instead,
-    // by the `node:process` / `process` entries in `paths` (see `importRestrictions` in
-    // rules.ts): narrower than flipping prefer-global, and free of the Prisma-client
-    // false positive.
-    //
-    // With `importNames: ["env", "default"]` that is now the COMPLETE set, not a sample.
-    // Every way to reach `process.env` is covered by one rule or the other: the member
-    // expression and an un-renamed default import at the USAGE site, and the named,
-    // renamed-named, namespace and renamed-default imports at the IMPORT site. The
-    // un-renamed default being caught at the usage site rather than by the import ban is
-    // the asymmetry that hid the renamed-default hole for two rounds of review.
+    // antfu's `"never"` default flags every legitimate global `process` use. Neutralize
+    // it here, inside antfu's node-scoped config: a plugin-less object aborts ESLint 10.
+    // `"off"` and not `"always"`, which would flag the generated Prisma client. The
+    // `process.env` hole is covered at the import site by `importRestrictions`.
     rules: { "node/prefer-global/process": "off" }
   });
 }

package/dist/prisma/index.d.mts

@@ -6,27 +6,12 @@ interface SchemaEngineDatasource {
     shadowDatabaseUrl?: string;
 }
 /**
- * Seed the three Prisma connection env vars with localhost dev defaults when UNSET.
- * This is a deliberate SIDE EFFECT on `env` (defaults to `process.env`). Necessary because
- * once a `prisma.config.ts` exists Prisma stops auto-loading `.env`, so a schema that
- * reads `env("DATABASE_URL")` / `env("DIRECT_DATABASE_URL")` would fail at rest.
+ * Seed the Prisma connection env vars with localhost dev defaults when unset.
+ * Deliberately mutates `env`: once a `prisma.config.ts` exists Prisma stops auto-loading
+ * `.env`, so a schema reading `env("DATABASE_URL")` would fail at rest.
  *
- * Call it (after `import "dotenv/config"`) in the config file so the Prisma CLI runs
- * with ZERO env; a real `.env`/shell value always wins. `buildPrismaConfig` then reads
- * the seeded env and derives its direct-connection + shadow datasource.
- *
- * TWO paths, not one:
- * - **Bare, or an explicit `DIRECT_DATABASE_URL`.** Seeds all three. Defaults:
- *   direct = local postgres, pooled = direct + `pgbouncer=1`, shadow = direct with a
- *   `/prisma-shadow` database.
- * - **A real `DATABASE_URL` and no direct URL.** Seeds ONLY `DIRECT_DATABASE_URL`,
- *   derived from the pooled URL, and returns early. No shadow is seeded on purpose:
- *   deriving one would name a `/prisma-shadow` database on the production host, which
- *   Prisma CREATEs and DROPs.
- *
- * An empty-string value counts as unset throughout; `docker-compose` produces `""` for an
- * undefined variable, and treating it as present is how the localhost default used to
- * reach production.
+ * Call it after `import "dotenv/config"`. A real value always wins, and an empty string
+ * counts as unset.
  */
 declare function applyPrismaDevEnv(env?: Record<string, string | undefined>): void;
 /**
@@ -35,13 +20,12 @@ declare function applyPrismaDevEnv(env?: Record<string, string | undefined>): vo
  */
 declare function stripPgbouncerParams(url: string): string;
 /**
- * Resolve the schema engine's datasource (Pattern B):
- * - direct URL = `DIRECT_DATABASE_URL`, else `DATABASE_URL` with pgbouncer params stripped;
- * - shadow DB = `SHADOW_DATABASE_URL` when present.
+ * Resolve the schema engine's datasource:
+ * - direct URL = `DIRECT_DATABASE_URL`, else `DATABASE_URL` with pooler params stripped
+ * - shadow DB = `SHADOW_DATABASE_URL` when present
  *
- * Returns `undefined` when neither a direct nor a pooled URL is set, so the
- * config falls back to the schema's own `datasource` block (e.g. during
- * `prisma generate` without a database).
+ * Returns `undefined` when neither is set, so the config falls back to the schema's own
+ * `datasource` block, e.g. during `prisma generate` without a database.
  */
 declare function resolveSchemaEngineDatasource(env: Record<string, string | undefined>): SchemaEngineDatasource | undefined;
 
@@ -54,8 +38,8 @@ interface BuildPrismaConfigOptions {
     typedSql?: boolean;
 }
 /**
- * Build the shared `@sidebase` Prisma config (Prisma 6.19 "Pattern B").
- * Wrap the result in `defineConfig`:
+ * Build the shared `@sidebase` Prisma config. Gives the schema engine a pooler-free
+ * direct connection. Prisma 7's config shape is not covered.
  *
  * ```ts
  * // prisma.config.ts
@@ -63,10 +47,6 @@ interface BuildPrismaConfigOptions {
  * import { buildPrismaConfig } from "@sidebase/base-config/prisma";
  * export default defineConfig(buildPrismaConfig({ views: true, typedSql: true }));
  * ```
- *
- * Reads `DATABASE_URL` / `DIRECT_DATABASE_URL` / `SHADOW_DATABASE_URL` (the
- * schema engine gets a pgbouncer-free direct connection). Prisma 7's changed
- * config shape is out of scope for v1.
  */
 declare function buildPrismaConfig(options?: BuildPrismaConfigOptions, env?: Record<string, string | undefined>): PrismaConfig;
 

package/dist/prisma/index.d.ts

@@ -6,27 +6,12 @@ interface SchemaEngineDatasource {
     shadowDatabaseUrl?: string;
 }
 /**
- * Seed the three Prisma connection env vars with localhost dev defaults when UNSET.
- * This is a deliberate SIDE EFFECT on `env` (defaults to `process.env`). Necessary because
- * once a `prisma.config.ts` exists Prisma stops auto-loading `.env`, so a schema that
- * reads `env("DATABASE_URL")` / `env("DIRECT_DATABASE_URL")` would fail at rest.
+ * Seed the Prisma connection env vars with localhost dev defaults when unset.
+ * Deliberately mutates `env`: once a `prisma.config.ts` exists Prisma stops auto-loading
+ * `.env`, so a schema reading `env("DATABASE_URL")` would fail at rest.
  *
- * Call it (after `import "dotenv/config"`) in the config file so the Prisma CLI runs
- * with ZERO env; a real `.env`/shell value always wins. `buildPrismaConfig` then reads
- * the seeded env and derives its direct-connection + shadow datasource.
- *
- * TWO paths, not one:
- * - **Bare, or an explicit `DIRECT_DATABASE_URL`.** Seeds all three. Defaults:
- *   direct = local postgres, pooled = direct + `pgbouncer=1`, shadow = direct with a
- *   `/prisma-shadow` database.
- * - **A real `DATABASE_URL` and no direct URL.** Seeds ONLY `DIRECT_DATABASE_URL`,
- *   derived from the pooled URL, and returns early. No shadow is seeded on purpose:
- *   deriving one would name a `/prisma-shadow` database on the production host, which
- *   Prisma CREATEs and DROPs.
- *
- * An empty-string value counts as unset throughout; `docker-compose` produces `""` for an
- * undefined variable, and treating it as present is how the localhost default used to
- * reach production.
+ * Call it after `import "dotenv/config"`. A real value always wins, and an empty string
+ * counts as unset.
  */
 declare function applyPrismaDevEnv(env?: Record<string, string | undefined>): void;
 /**
@@ -35,13 +20,12 @@ declare function applyPrismaDevEnv(env?: Record<string, string | undefined>): vo
  */
 declare function stripPgbouncerParams(url: string): string;
 /**
- * Resolve the schema engine's datasource (Pattern B):
- * - direct URL = `DIRECT_DATABASE_URL`, else `DATABASE_URL` with pgbouncer params stripped;
- * - shadow DB = `SHADOW_DATABASE_URL` when present.
+ * Resolve the schema engine's datasource:
+ * - direct URL = `DIRECT_DATABASE_URL`, else `DATABASE_URL` with pooler params stripped
+ * - shadow DB = `SHADOW_DATABASE_URL` when present
  *
- * Returns `undefined` when neither a direct nor a pooled URL is set, so the
- * config falls back to the schema's own `datasource` block (e.g. during
- * `prisma generate` without a database).
+ * Returns `undefined` when neither is set, so the config falls back to the schema's own
+ * `datasource` block, e.g. during `prisma generate` without a database.
  */
 declare function resolveSchemaEngineDatasource(env: Record<string, string | undefined>): SchemaEngineDatasource | undefined;
 
@@ -54,8 +38,8 @@ interface BuildPrismaConfigOptions {
     typedSql?: boolean;
 }
 /**
- * Build the shared `@sidebase` Prisma config (Prisma 6.19 "Pattern B").
- * Wrap the result in `defineConfig`:
+ * Build the shared `@sidebase` Prisma config. Gives the schema engine a pooler-free
+ * direct connection. Prisma 7's config shape is not covered.
  *
  * ```ts
  * // prisma.config.ts
@@ -63,10 +47,6 @@ interface BuildPrismaConfigOptions {
  * import { buildPrismaConfig } from "@sidebase/base-config/prisma";
  * export default defineConfig(buildPrismaConfig({ views: true, typedSql: true }));
  * ```
- *
- * Reads `DATABASE_URL` / `DIRECT_DATABASE_URL` / `SHADOW_DATABASE_URL` (the
- * schema engine gets a pgbouncer-free direct connection). Prisma 7's changed
- * config shape is out of scope for v1.
  */
 declare function buildPrismaConfig(options?: BuildPrismaConfigOptions, env?: Record<string, string | undefined>): PrismaConfig;
 

package/dist/shared/{base-config.CuUhyvQo.d.mts → base-config.BoberVUk.d.mts}

@@ -1,7 +1,4 @@
-/**
- * Options for the published ESLint factory (`@sidebase/base-config/eslint`).
- * Covers the per-repo variance found across the consuming repos.
- */
+/** Options for the published ESLint factory (`@sidebase/base-config/eslint`). */
 interface CreateSidebaseEslintOptions {
     /** Zod `.extend()/.merge()/.passthrough()` bans and/or `import * as z` enforcement. Default `"none"` (opt-in). */
     zod?: "full" | "import-style" | "none";
@@ -36,10 +33,9 @@ interface CreateSidebaseEslintOptions {
     testFilePattern?: string[];
 }
 /**
- * Runtime list of every {@link CreateSidebaseEslintOptions} key, for config
- * validation/iteration. The `satisfies Record<keyof ..., 0>` map makes this
- * exhaustive: adding a future option to the interface fails to compile until
- * the key is listed here too, so the validator allow-list can never drift.
+ * Runtime list of every {@link CreateSidebaseEslintOptions} key. The `satisfies` map
+ * keeps it exhaustive: a new option fails to compile until it is listed here, so the
+ * validator allow-list cannot drift.
  */
 declare const ESLINT_OPTION_KEYS: string[];
 

package/dist/shared/{base-config.CuUhyvQo.d.ts → base-config.BoberVUk.d.ts}

@@ -1,7 +1,4 @@
-/**
- * Options for the published ESLint factory (`@sidebase/base-config/eslint`).
- * Covers the per-repo variance found across the consuming repos.
- */
+/** Options for the published ESLint factory (`@sidebase/base-config/eslint`). */
 interface CreateSidebaseEslintOptions {
     /** Zod `.extend()/.merge()/.passthrough()` bans and/or `import * as z` enforcement. Default `"none"` (opt-in). */
     zod?: "full" | "import-style" | "none";
@@ -36,10 +33,9 @@ interface CreateSidebaseEslintOptions {
     testFilePattern?: string[];
 }
 /**
- * Runtime list of every {@link CreateSidebaseEslintOptions} key, for config
- * validation/iteration. The `satisfies Record<keyof ..., 0>` map makes this
- * exhaustive: adding a future option to the interface fails to compile until
- * the key is listed here too, so the validator allow-list can never drift.
+ * Runtime list of every {@link CreateSidebaseEslintOptions} key. The `satisfies` map
+ * keeps it exhaustive: a new option fails to compile until it is listed here, so the
+ * validator allow-list cannot drift.
  */
 declare const ESLINT_OPTION_KEYS: string[];