@dereekb/dbx-cli 13.11.13 → 13.11.15

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -64,6 +64,8 @@ export declare function buildModelDecodeCommand(manifest: CliModelManifest, opti
64
64
  * @param rawKey - The Firestore key string.
65
65
  * @param manifest - The generated model manifest.
66
66
  * @returns The decoded key with leaf, ancestors, and any unresolved prefixes.
67
+ * @throws {CliError} When `rawKey` is empty or does not parse into an even number of `prefix/id` segments.
68
+ *
67
69
  * @__NO_SIDE_EFFECTS__
68
70
  */
69
71
  export declare function decodeFirestoreModelKey(rawKey: string, manifest: CliModelManifest): DecodedKey;
@@ -72,8 +74,9 @@ export declare function decodeFirestoreModelKey(rawKey: string, manifest: CliMod
72
74
  * MCP `dbx_model_decode` key-mode output for consistency between agent and
73
75
  * shell consumers.
74
76
  *
75
- * @param decoded - the decoded key returned by {@link decodeFirestoreModelKey}.
76
- * @returns the formatted block with a trailing newline.
77
+ * @param decoded - The decoded key returned by {@link decodeFirestoreModelKey}.
78
+ * @returns The formatted block with a trailing newline.
79
+ *
77
80
  * @__NO_SIDE_EFFECTS__
78
81
  */
79
82
  export declare function renderDecodedKey(decoded: DecodedKey): string;
@@ -6,17 +6,19 @@ import type { CliModelManifest, CliModelManifestEntry } from './types';
6
6
  * Re-exports {@link findCliModelManifestEntry} under a more descriptive name
7
7
  * for the model-info command.
8
8
  *
9
- * @param manifest - the generated model manifest.
10
- * @param query - identifier to look up.
11
- * @returns the matching entry or `undefined`.
9
+ * @param manifest - The generated model manifest.
10
+ * @param query - Identifier to look up.
11
+ * @returns The matching entry or `undefined`.
12
+ *
12
13
  * @__NO_SIDE_EFFECTS__
13
14
  */
14
15
  export declare function resolveCliModel(manifest: CliModelManifest, query: string): CliModelManifestEntry | undefined;
15
16
  /**
16
17
  * Produces a column-aligned summary table of every model in the manifest.
17
18
  *
18
- * @param manifest - the generated model manifest.
19
- * @returns the formatted table as a single string with a trailing newline.
19
+ * @param manifest - The generated model manifest.
20
+ * @returns The formatted table as a single string with a trailing newline.
21
+ *
20
22
  * @__NO_SIDE_EFFECTS__
21
23
  */
22
24
  export declare function renderModelManifestList(manifest: CliModelManifest): string;
@@ -24,8 +26,9 @@ export declare function renderModelManifestList(manifest: CliModelManifest): str
24
26
  * Produces a human-readable summary of one model entry: header, description,
25
27
  * and an indented field tree (recursing into `nestedFields`).
26
28
  *
27
- * @param entry - the manifest entry to render.
28
- * @returns the formatted summary as a single string with a trailing newline.
29
+ * @param entry - The manifest entry to render.
30
+ * @returns The formatted summary as a single string with a trailing newline.
31
+ *
29
32
  * @__NO_SIDE_EFFECTS__
30
33
  */
31
34
  export declare function renderModelManifestEntry(entry: CliModelManifestEntry): string;
@@ -33,8 +36,9 @@ export declare function renderModelManifestEntry(entry: CliModelManifestEntry):
33
36
  * Produces the field-table portion of {@link renderModelManifestEntry} on its
34
37
  * own, used by the `--fields` flag of the `model-info` command.
35
38
  *
36
- * @param entry - the manifest entry whose fields should be rendered.
37
- * @returns the formatted field tree as a single string with a trailing newline.
39
+ * @param entry - The manifest entry whose fields should be rendered.
40
+ * @returns The formatted field tree as a single string with a trailing newline.
41
+ *
38
42
  * @__NO_SIDE_EFFECTS__
39
43
  */
40
44
  export declare function renderModelManifestFields(entry: CliModelManifestEntry): string;
@@ -39,11 +39,12 @@ export declare function createAuthMiddleware(input: CreateAuthMiddlewareInput):
39
39
  * Test-only middleware that skips OIDC discovery, disk token loading, and token refresh, attaching
40
40
  * a pre-built {@link CliContext} directly via {@link setCliContext}.
41
41
  *
42
- * @internal Intended for use by `@dereekb/dbx-cli/test`. Not for production wiring.
43
- *
44
42
  * @param input - The pre-built context to attach on every invocation.
45
43
  * @param input.cliContext - The {@link CliContext} that will be attached via {@link setCliContext}.
46
44
  * @returns A yargs middleware function that always sets the provided context.
45
+ *
46
+ * @internal Intended for use by `@dereekb/dbx-cli/test`. Not for production wiring.
47
+ *
47
48
  * @__NO_SIDE_EFFECTS__
48
49
  */
49
50
  export declare function createPassthroughAuthMiddleware(input: {
package/test/package.json CHANGED
@@ -1,15 +1,15 @@
1
1
  {
2
2
  "name": "@dereekb/dbx-cli/test",
3
- "version": "13.11.13",
3
+ "version": "13.11.15",
4
4
  "peerDependencies": {
5
- "@dereekb/date": "13.11.13",
6
- "@dereekb/dbx-cli": "13.11.13",
7
- "@dereekb/firebase": "13.11.13",
8
- "@dereekb/firebase-server/test": "13.11.13",
9
- "@dereekb/model": "13.11.13",
10
- "@dereekb/nestjs": "13.11.13",
11
- "@dereekb/rxjs": "13.11.13",
12
- "@dereekb/util": "13.11.13",
5
+ "@dereekb/date": "13.11.15",
6
+ "@dereekb/dbx-cli": "13.11.15",
7
+ "@dereekb/firebase": "13.11.15",
8
+ "@dereekb/firebase-server/test": "13.11.15",
9
+ "@dereekb/model": "13.11.15",
10
+ "@dereekb/nestjs": "13.11.15",
11
+ "@dereekb/rxjs": "13.11.15",
12
+ "@dereekb/util": "13.11.15",
13
13
  "@nestjs/common": "^11.1.19",
14
14
  "arktype": "^2.2.0",
15
15
  "yargs": "^18.0.0"