@dereekb/dbx-cli 14.1.0 → 14.3.0

package/src/lib/index.d.ts

@@ -1,6 +1,7 @@
 export * from './action';
 export * from './api';
 export * from './auth';
+export * from './cache';
 export * from './config';
 export * from './context';
 export * from './doctor';

package/src/lib/runner/run.d.ts

@@ -1,5 +1,6 @@
 import { type Argv, type CommandModule } from 'yargs';
 import { type ActionCommandSpec } from '../action/action.command.factory';
+import { type CreateCacheCommandInput } from '../cache/cache.command.factory';
 import { type CliEnvDefault } from '../config/env';
 import { type CliContext } from '../context/cli.context';
 import { type DoctorCheck } from '../doctor/doctor.command.factory';
@@ -127,6 +128,15 @@ export interface CreateCliInput extends CliLifecycleHooks {
      * Disable the built-in `firestore-get` command even when {@link firestore} is provided.
      */
     readonly disableFirestoreGet?: boolean;
+    /**
+     * Enables the recorded query/export dataset cache: the auth-free `cache` command group, and the
+     * `--cache` / `--refresh` global flags that `firestore-query` and app actions honour.
+     *
+     * Pass `true` for the defaults (`<configDir>/cache`, the CLI's `version` as the recorded build
+     * stamp), or an object to override the cache instance (tests point it at a temp dir), the build
+     * stamp, or the command name.
+     */
+    readonly dataCache?: boolean | Omit<CreateCacheCommandInput, 'cliName'>;
     /**
      * Test-only override that bypasses the auth middleware entirely and attaches the supplied
      * {@link CliContext} on every command invocation.
@@ -199,6 +209,7 @@ export interface CreateCliInput extends CliLifecycleHooks {
  *   if {@link CreateCliInput.modelManifest} is provided.
  * @param input.firestore - The app-supplied direct-Firestore binding; enables `firestore-get` / `firestore-query`.
  * @param input.firestoreQueryManifest - The generated Firestore query catalog; enables `firestore-queries`.
+ * @param input.dataCache - Enables the recorded dataset cache: the `cache` command group plus the `--cache` / `--refresh` global flags.
  * @param input.manifestGeneratorVersion - The `@dereekb/dbx-cli` version that emitted the app's generated
  *   manifests, for the built-in `cli-build-not-stale` doctor check.
  * @param input.setup - App hook run once before the command's handler; a throw aborts the command.

package/src/lib/util/browser.d.ts

@@ -0,0 +1,23 @@
+import { type WebsiteUrl } from '@dereekb/util';
+export interface OpenUrlInBrowserInput {
+    /**
+     * The URL to hand to the platform's default handler.
+     */
+    readonly url: WebsiteUrl;
+}
+/**
+ * Opens a URL in the user's default browser.
+ *
+ * Shells out to the platform's URL handler (`open` on macOS, `start` on Windows, `xdg-open`
+ * elsewhere) rather than taking a dependency for what is a single spawn. The child is detached with
+ * its stdio ignored, so the browser neither holds the CLI's event loop open nor interleaves output
+ * into the CLI's own stdout/stderr.
+ *
+ * Never throws or rejects: a headless machine with no handler registered is an ordinary outcome, and
+ * the caller falls back to the printed URL.
+ *
+ * @param input - The open inputs.
+ * @param input.url - The URL to open.
+ * @returns `true` when the handler process was spawned, `false` when it could not be.
+ */
+export declare function openUrlInBrowser(input: OpenUrlInBrowserInput): Promise<boolean>;

package/src/lib/util/index.d.ts

@@ -1,4 +1,5 @@
 export * from './args';
+export * from './browser';
 export * from './context.slot';
 export * from './handler';
 export * from './interactive';

package/src/lib/util/interactive.d.ts

@@ -1,6 +1,14 @@
 export interface PromptInput {
     readonly question: string;
     readonly mask?: boolean;
+    /**
+     * Optional signal that cancels the prompt, rejecting it with {@link PROMPT_CANCELLED_ERROR_CODE}
+     * and releasing stdin.
+     *
+     * Lets a prompt race another source of the same answer — `auth login` offers the paste prompt
+     * while its loopback listener waits, and aborts the prompt the moment the redirect lands.
+     */
+    readonly signal?: AbortSignal;
 }
 /**
  * Error code thrown by {@link promptLine} when the user cancels a masked prompt with Ctrl-C.
@@ -16,11 +24,12 @@ export declare const PROMPT_CANCELLED_ERROR_CODE = "PROMPT_CANCELLED";
  * pasted redirect URL.
  *
  * Rejects with a {@link CliError} (`code: 'PROMPT_CANCELLED'`) when the user presses Ctrl-C
- * during a masked prompt, instead of forcibly terminating the process.
+ * during a masked prompt, or when `signal` aborts, instead of forcibly terminating the process.
  *
  * @param input - The prompt inputs.
  * @param input.question - The prompt text written to stdout (or stderr when masking).
  * @param input.mask - When `true`, characters are echoed as `*` and Ctrl-C cancels the prompt.
+ * @param input.signal - Optional signal that cancels the prompt and releases stdin.
  * @returns The line entered by the user (without the trailing newline).
  */
 export declare function promptLine(input: PromptInput): Promise<string>;

package/test/package.json

@@ -1,16 +1,17 @@
 {
   "name": "@dereekb/dbx-cli/test",
-  "version": "14.1.0",
+  "version": "14.3.0",
+  "sideEffects": false,
   "type": "module",
   "peerDependencies": {
-    "@dereekb/date": "14.1.0",
-    "@dereekb/dbx-cli": "14.1.0",
-    "@dereekb/firebase": "14.1.0",
-    "@dereekb/firebase-server/test": "14.1.0",
-    "@dereekb/model": "14.1.0",
-    "@dereekb/nestjs": "14.1.0",
-    "@dereekb/rxjs": "14.1.0",
-    "@dereekb/util": "14.1.0",
+    "@dereekb/date": "14.3.0",
+    "@dereekb/dbx-cli": "14.3.0",
+    "@dereekb/firebase": "14.3.0",
+    "@dereekb/firebase-server/test": "14.3.0",
+    "@dereekb/model": "14.3.0",
+    "@dereekb/nestjs": "14.3.0",
+    "@dereekb/rxjs": "14.3.0",
+    "@dereekb/util": "14.3.0",
     "@nestjs/common": "^12.0.1",
     "arktype": "^2.2.0",
     "vitest": "4.1.11",

package/validate/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@dereekb/dbx-cli/validate",
-  "version": "14.1.0",
+  "version": "14.3.0",
   "type": "module",
   "sideEffects": false,
   "peerDependencies": {
-    "@dereekb/dbx-cli": "14.1.0",
-    "@dereekb/util": "14.1.0",
+    "@dereekb/dbx-cli": "14.3.0",
+    "@dereekb/util": "14.3.0",
     "ts-morph": "^28.0.0"
   }
 }