bun-query-builder 0.2.25 → 0.2.26

package/dist/config.d.ts

@@ -1,4 +1,4 @@
-import type { QueryBuilderConfig, SupportedDialect } from './types';
+import type { QueryBuilderConfig, QueryBuilderOptions, SupportedDialect } from './types';
 /**
  * Whether a dialect belongs to the MySQL wire-protocol family (MySQL itself,
  * SingleStore, or Vitess). These share `?` placeholders, backtick identifier
@@ -62,12 +62,41 @@ export declare function getPlaceholders(count: number, startIndex?: number): str
  *
  * So the loaded object is applied with those keys filtered out — an explicit API
  * call is a stronger signal than a file that may not know the embedder exists.
+ * The filter is per top-level section; see `configState` for why per-leaf is
+ * the wrong granularity.
  *
  * Note the load MUST pass `defaultConfig`: bunfig derives the environment
  * variable names it recognises (`QUERY_BUILDER_*`) from the shape of the
  * defaults, so passing an empty object silently drops env-var support.
  */
 export declare function getConfig(): Promise<QueryBuilderConfig>;
-export declare function setConfig(userConfig: Partial<QueryBuilderConfig>): void;
+export declare function setConfig(userConfig: QueryBuilderOptions): void;
+/**
+ * Identity helper for a typed `query-builder.config.ts`.
+ *
+ * It exists so that writing a config file requires no decision about which
+ * type to annotate with — which is what stacksjs/bun-query-builder#1062 was
+ * actually about. The only config type this package exported was
+ * `QueryBuilderConfig`, the RESOLVED shape with every field required, and the
+ * docs told people to import it, so downstream apps annotated their config
+ * file with a type demanding `migrationDir`, `snapshotDir`, `features`,
+ * `aliasing` and nine other sections they had no opinion about. Every field
+ * added here afterwards was a downstream build break.
+ *
+ * `defineConfig` takes `QueryBuilderOptions`, so nothing is ever required, and
+ * returns its argument unchanged — there is no runtime behavior here, only the
+ * type and the editor completion that comes with it.
+ *
+ * ```ts
+ * // query-builder.config.ts
+ * import { defineConfig } from 'bun-query-builder'
+ *
+ * export default defineConfig({
+ *   dialect: 'postgres',
+ *   database: { database: 'my_app' },
+ * })
+ * ```
+ */
+export declare function defineConfig(userConfig: QueryBuilderOptions): QueryBuilderOptions;
 export declare const defaultConfig: QueryBuilderConfig;
 export declare const config: QueryBuilderConfig;