tauri-plugin-configurate-api 0.2.0 → 0.2.2

package/dist-js/index.d.ts

@@ -166,17 +166,14 @@ export declare class LazyConfigEntry<S extends SchemaObject> {
      */
     unlock(opts: KeyringOptions): Promise<UnlockedConfig<S>>;
 }
-/** Options passed to the `Configurate` constructor. */
-export interface ConfigurateOptions {
-    /**
-     * Full filename for the configuration file, including extension.
-     *
-     * Examples: `"app.json"`, `"data.yaml"`, `"settings.binc"`, `".env"`.
-     *
-     * Must be a single path component — path separators (`/`, `\`) are rejected
-     * by the Rust side. Use the `path` option to store files in a sub-directory.
-     */
-    name: string;
+/**
+ * Base options shared across all configs created by a `ConfigurateFactory`.
+ * `name` is omitted because each config provides its own filename.
+ *
+ * `dirName` replaces the app identifier component of the base path.
+ * `path` adds a sub-directory within the root (after `dirName` / identifier).
+ */
+export interface ConfigurateBaseOptions {
     /** Base directory in which the configuration file will be stored. */
     dir: BaseDirectory;
     /**
@@ -193,17 +190,6 @@ export interface ConfigurateOptions {
      *
      * Each segment is validated on the Rust side; `..` and Windows-forbidden
      * characters are rejected.
-     *
-     * @example
-     * ```ts
-     * // → %APPDATA%/my-app/app.json  (identifier replaced)
-     * new Configurate(schema, {
-     *   name: "app.json",
-     *   dir: BaseDirectory.AppConfig,
-     *   format: "json",
-     *   dirName: "my-app",
-     * });
-     * ```
      */
     dirName?: string;
     /**
@@ -221,17 +207,6 @@ export interface ConfigurateOptions {
      * | `"my-app"`  | _(omitted)_ | `%APPDATA%/my-app/<name>`                                 |
      * | _(omitted)_ | `"cfg/v2"`  | `%APPDATA%/com.example.app/cfg/v2/<name>`                 |
      * | `"my-app"`  | `"cfg/v2"`  | `%APPDATA%/my-app/cfg/v2/<name>`                          |
-     *
-     * @example
-     * ```ts
-     * // → %APPDATA%/com.example.app/profiles/settings.json
-     * new Configurate(schema, {
-     *   name: "settings.json",
-     *   dir: BaseDirectory.AppConfig,
-     *   format: "json",
-     *   path: "profiles",
-     * });
-     * ```
      */
     path?: string;
     /** On-disk storage format. */
@@ -249,6 +224,18 @@ export interface ConfigurateOptions {
      */
     encryptionKey?: string;
 }
+/** Options passed to the `Configurate` constructor. */
+export interface ConfigurateOptions extends ConfigurateBaseOptions {
+    /**
+     * Full filename for the configuration file, including extension.
+     *
+     * Examples: `"app.json"`, `"data.yaml"`, `"settings.binc"`, `".env"`.
+     *
+     * Must be a single path component — path separators (`/`, `\`) are rejected
+     * by the Rust side. Use the `path` option to store files in a sub-directory.
+     */
+    name: string;
+}
 /**
  * Main entry point for managing application configuration.
  *
@@ -333,13 +320,20 @@ export declare class Configurate<S extends SchemaObject> {
     _buildPayload(op: "create" | "load" | "save", data: InferUnlocked<S> | undefined, keyringOpts: KeyringOptions | null, withUnlock: boolean): Record<string, unknown>;
 }
 /**
- * Base options shared across all configs created by a `ConfigurateFactory`.
- * `name` is omitted because each config provides its own.
+ * Object form accepted by `ConfigurateFactory.build()` as the second argument.
  *
- * `dirName` replaces the app identifier component of the base path.
- * `path` adds a sub-directory within the root (after `dirName` / identifier).
+ * - `name` — filename (may include a relative path, e.g. `"config/state.bin"`)
+ * - `path` — sub-directory appended after the root / `dirName`; `null` disables the factory-level value
+ * - `dirName` — replaces the app identifier segment; `null` disables the factory-level value
  */
-export type ConfigurateBaseOptions = Omit<ConfigurateOptions, "name">;
+export interface BuildConfig {
+    /** Filename including extension. May contain `/`-separated path segments (e.g. `"config/state.bin"`). */
+    name: string;
+    /** Optional sub-directory within the root. Pass `null` to disable the factory-level value. */
+    path?: string | null;
+    /** Optional replacement for the app identifier directory. Pass `null` to disable the factory-level value. */
+    dirName?: string | null;
+}
 /**
  * A factory that creates `Configurate` instances with pre-set shared options
  * (`dir`, `format`, and optionally `dirName`, `path`, `encryptionKey`).
@@ -408,12 +402,9 @@ export declare class ConfigurateFactory {
      * factory.build(schema, { name: "cfg.json", dirName: "my-app", path: "a/b" })   // → %APPDATA%/my-app/a/b/cfg.json
      * ```
      */
+    build<S extends SchemaObject>(schema: S & (true extends HasDuplicateKeyringIds<S> ? never : unknown), nameOrConfig: string | BuildConfig, dirName?: string): Configurate<S>;
+    build<S extends SchemaObject>(schema: S & (true extends HasDuplicateKeyringIds<S> ? never : unknown), config: BuildConfig): Configurate<S>;
     build<S extends SchemaObject>(schema: S & (true extends HasDuplicateKeyringIds<S> ? never : unknown), name: string, dirName?: string): Configurate<S>;
-    build<S extends SchemaObject>(schema: S & (true extends HasDuplicateKeyringIds<S> ? never : unknown), config: {
-        name: string;
-        path?: string | null;
-        dirName?: string | null;
-    }): Configurate<S>;
 }
 /**
  * Defines a configuration schema. Provides a convenient declaration site and

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tauri-plugin-configurate-api",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "A Tauri v2 plugin for type-safe application configuration management.",
   "keywords": [
     "config",