@supabase/lite 0.8.0 → 0.8.1-next.2

package/dist/cli/lib.d.ts

@@ -1,6 +1,6 @@
 import * as _supabase_supabase_js from '@supabase/supabase-js';
 import { SupportedStorage, SupabaseClient } from '@supabase/supabase-js';
-import { S as Schema } from '../index-xv_pDjEt.js';
+import { S as Schema } from '../index-DKO3OQpz.js';
 import { Connection, DefaultAppConfig, App } from '@supabase/lite';
 import 'jsonv-ts';
 
@@ -72,7 +72,24 @@ declare class ProjectLocalApi extends ProjectApi {
     protected readConfig(file_path?: string): Promise<Schema>;
     createConnection(): Promise<Connection>;
     getConfig(file_path?: string): Promise<DefaultAppConfig>;
-    createApp(config_path?: string): Promise<App>;
+    /**
+     * Build the `App` for a local project: read the config, resolve the
+     * connection, apply caller overrides, and initialize it.
+     *
+     * @param opts.admin An explicit local-admin-mode decision (see
+     * `ServerOptions.admin`) — `--no-admin`, or the Vite preview server's forced
+     * opt-out. Wins over `config.toml`: otherwise a config saying `admin = true`
+     * would silently re-enable what the operator just turned off.
+     * @param opts.adminDefault The launcher's default, applied only when neither
+     * the caller nor the config expressed a preference — so a project can set
+     * `admin = false` in config and have `lite start` honor it.
+     *
+     * Resolution order is therefore `admin` > `config.toml` > `adminDefault`.
+     */
+    createApp(config_path?: string, opts?: {
+        admin?: boolean;
+        adminDefault?: boolean;
+    }): Promise<App>;
 }
 
 declare class ProjectRemoteApi extends ProjectApi {
@@ -119,20 +136,29 @@ declare class Api extends BaseApi<ApiConfig> {
 
 declare function createApi(options?: Partial<ApiConfig>): Promise<Api>;
 
+type GeneratedProjectKeys = {
+    publishable?: string;
+    secret?: string;
+};
+/** @param created True only on the run that wrote the config, so `lite dev` can announce the scaffold it caused. */
 declare function ensureInitialStructure(opts?: Partial<{
     configFormat: "toml" | "json";
     driver: NonNullable<Schema["db"]>["driver"];
     recreate: boolean;
     template: boolean;
-}>): Promise<void>;
+}>): Promise<{
+    generatedKeys?: GeneratedProjectKeys;
+    created: boolean;
+}>;
 
 declare function ensureSchema(app: App, opts?: {
     force?: boolean;
 }): Promise<void>;
+/** Returns a stop function so callers can tear the watcher down on shutdown. */
 declare function watchSchema(app: App, opts?: {
     force?: boolean;
     translate?: boolean;
-}): void;
+}): () => Promise<void>;
 
 interface MigrationFile {
     version: string;
@@ -148,12 +174,39 @@ interface ApplyResult {
     applied: MigrationFile[];
     skipped: MigrationFile[];
 }
+interface ApplyOptions {
+    /**
+     * Persist the migration-derived deparse snapshot even when the project has
+     * declarative `supabase/schemas/*.sql`. Set ONLY by `lite db reset`, which is
+     * destructive: it drops whatever a declarative apply built, so migration
+     * metadata then describes the fresh database exactly. Non-destructive callers
+     * must not opt in — their snapshot would validate on the next `lite start`
+     * while missing every declarative policy (LITE-310).
+     */
+    persistWithDeclarative?: boolean;
+}
 /**
  * Apply pending migrations to the connected database, one implicit transaction
  * per file. The history INSERT is appended to the file's batch so a failure in
  * any statement rolls back the record too — same semantics as Supabase CLI
  * (`~/supabase/cli/pkg/migration/file.go:72-103` `ExecBatch`).
  */
-declare function applyPendingMigrations(app: App): Promise<ApplyResult>;
+declare function applyPendingMigrations(app: App, options?: ApplyOptions): Promise<ApplyResult>;
+
+/**
+ * Resolve the project's configured `auth.publishable_key`, fully substituted
+ * (an `env(VAR)` ref resolves to the real value, or "" if unset) — without
+ * opening a database connection. Used where only the key is needed (e.g. the
+ * Vite plugin's `config()` hook, which runs before the app/connection exists).
+ * Returns `undefined` when no project/config is found, the config can't be
+ * read (missing/malformed — never crash `vite dev` over this), or no key is
+ * configured.
+ *
+ * `env` defaults to `process.env` but can be overridden with an isolated
+ * object — tests share one process (`bun test` interleaves files async), so
+ * mutating the real `process.env` here (via `loadDotenvForConfig`'s
+ * first-write-wins) would otherwise race with any other test's `.env` load.
+ */
+declare function resolveConfiguredPublishableKey(configPath?: string, env?: NodeJS.ProcessEnv): Promise<string | undefined>;
 
-export { applyPendingMigrations, createApi, ensureInitialStructure, ensureSchema, listMigrationFiles, migrationsDir, watchSchema };
+export { applyPendingMigrations, createApi, ensureInitialStructure, ensureSchema, listMigrationFiles, migrationsDir, resolveConfiguredPublishableKey, watchSchema };