@dereekb/dbx-cli 13.11.9 → 13.11.10

package/firebase-api-manifest/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/dbx-cli-firebase-api-manifest",
-  "version": "13.11.9",
+  "version": "13.11.10",
   "private": true,
   "type": "module",
   "devDependencies": {

package/index.cjs.js

@@ -8940,7 +8940,7 @@ function buildModelCommand(model, entries, context) {
                     }
                 }
             }
-            yargs.command(buildPerModelGetCommand(model));
+            yargs.command(buildPerModelGetCommand(model, context.modelManifest));
             hideGlobalOptions(yargs, context.hideOnFocus);
             return yargs.demandCommand(1, 'Please specify an action.');
         },
@@ -8950,24 +8950,85 @@ function buildModelCommand(model, entries, context) {
     };
 }
 /**
- * Synthetic per-model `get <key>` sub-command appended to every model's command tree.
+ * Resolves a per-model `get` positional into the full Firestore key the backend expects.
  *
- * The parent `model <name>` already fixes the `modelType`, so this command just passes the bare
- * `key` positional through to `context.getModel(modelType, key)`. Supports both the full
- * `<prefix>/<id>` form and a bare doc id (when the user knows the modelType from the parent).
- */ function buildPerModelGetCommand(model) {
+ * The backend's `ModelApiController.getOne` only accepts full `prefix/id` keys, so a bare doc id
+ * has to be expanded before the HTTP call. The expansion is only safe for top-level (root) models
+ * whose `collectionPrefix` is enough to address the document — subcollection models also need the
+ * parent prefix/id and cannot be reconstructed from a bare id alone.
+ *
+ * Rules:
+ * 1. Keys containing `/` are treated as full keys and passed through verbatim.
+ * 2. Bare ids on a top-level model resolve to `<collectionPrefix>/<id>` via the manifest.
+ * 3. Bare ids on a subcollection model throw — the parent path is required.
+ * 4. When the manifest is not wired, bare ids pass through unchanged (preserves the old behavior
+ *    so the CLI still works without `modelManifest` even though the backend will reject the call).
+ *
+ * @param model - The persisted model type (e.g. `profile`).
+ * @param key - The trimmed `<key>` positional from yargs — full `prefix/id` or bare doc id.
+ * @param manifest - The generated model manifest used to look up the model's `collectionPrefix`
+ *   and `parentIdentityConst`. When omitted, the key passes through unchanged.
+ * @returns The resolved Firestore model key ready for `context.getModel(model, key)`.
+ * @__NO_SIDE_EFFECTS__
+ */ function resolvePerModelGetKey(model, key, manifest) {
+    var result = key;
+    if (!key.includes('/')) {
+        var entry = manifest === null || manifest === void 0 ? void 0 : manifest.find(function(e) {
+            return e.modelType === model;
+        });
+        if (entry) {
+            if (entry.parentIdentityConst) {
+                throw new CliError({
+                    message: "get: model '".concat(model, "' is a subcollection — bare doc id '").concat(key, "' is ambiguous without the parent path. Provide a full key (e.g. '<parentPrefix>/<parentId>/").concat(entry.collectionPrefix, "/").concat(key, "')."),
+                    code: 'INVALID_ARGUMENT'
+                });
+            }
+            result = "".concat(entry.collectionPrefix, "/").concat(key);
+        }
+    }
+    return result;
+}
+/**
+ * Synthetic per-model `get` sub-command appended to every model's command tree.
+ *
+ * The parent `model <name>` already fixes the `modelType`. The command shape varies by whether
+ * the model is root-level (no parent) or a subcollection — only root models can address documents
+ * by bare doc id, so subcollection models keep the `<key>` positional (full `prefix/id` required):
+ *
+ * - **Root model with a wired manifest entry** — `get <id-or-key>` accepts either a bare doc id
+ *   (expanded to `<collectionPrefix>/<id>` via {@link resolvePerModelGetKey}) or a full
+ *   `<prefix>/<id>` key.
+ * - **Subcollection model with a wired manifest entry** — `get <key>` requires the full
+ *   `<parentPrefix>/<parentId>/<childPrefix>/<childId>` path. Bare doc ids are rejected with a
+ *   clear error because the parent path cannot be reconstructed from the id alone.
+ * - **No wired model manifest** — falls back to `get <key>`; the key is forwarded verbatim and
+ *   the backend will reject anything that is not a full `prefix/id` key.
+ *
+ * @param model - The persisted model type owning this `get` subcommand.
+ * @param manifest - The generated model manifest used by {@link resolvePerModelGetKey} to expand
+ *   bare doc ids into full keys for top-level models and to pick the command shape.
+ * @returns The yargs `CommandModule` registered under the model's command tree.
+ */ function buildPerModelGetCommand(model, manifest) {
+    var entry = manifest === null || manifest === void 0 ? void 0 : manifest.find(function(e) {
+        return e.modelType === model;
+    });
+    var isRootModel = entry != null && !entry.parentIdentityConst;
+    var positionalName = isRootModel ? 'idOrKey' : 'key';
+    var placeholder = isRootModel ? '<id-or-key>' : '<key>';
+    var positionalDescribe = isRootModel ? "Firestore key for the ".concat(model, " document — bare doc id (resolved to `").concat(entry.collectionPrefix, "/<id>`) or full `prefix/id`.") : "Firestore key for the ".concat(model, " document (full `prefix/id` — bare doc id is not supported").concat(entry ? ' for this subcollection model' : '', ").");
+    var commandDescribe = isRootModel ? "Read a single ".concat(model, " document by id or key.") : "Read a single ".concat(model, " document by key.");
     return {
-        command: 'get <key>',
-        describe: "Read a single ".concat(model, " document by key."),
+        command: "get ".concat(placeholder),
+        describe: commandDescribe,
         builder: function builder(yargs) {
-            return yargs.positional('key', {
+            return yargs.positional(positionalName, {
                 type: 'string',
-                describe: "Firestore key for the ".concat(model, " document (full `prefix/id` or bare id).")
+                describe: positionalDescribe
             });
         },
         handler: function handler(argv) {
             return _async_to_generator$1(function() {
-                var ctx, key, result, e;
+                var ctx, raw, key, resolvedKey, result, e;
                 return _ts_generator$1(this, function(_state) {
                     switch(_state.label){
                         case 0:
@@ -8978,16 +9039,18 @@ function buildModelCommand(model, entries, context) {
                                 3
                             ]);
                             ctx = requireCliContext();
-                            key = typeof argv.key === 'string' ? argv.key.trim() : '';
+                            raw = argv[positionalName];
+                            key = typeof raw === 'string' ? raw.trim() : '';
                             if (key.length === 0) {
                                 throw new CliError({
-                                    message: "get: missing required <key> positional for model '".concat(model, "'."),
+                                    message: "get: missing required ".concat(placeholder, " positional for model '").concat(model, "'."),
                                     code: 'INVALID_ARGUMENT'
                                 });
                             }
+                            resolvedKey = resolvePerModelGetKey(model, key, manifest);
                             return [
                                 4,
-                                ctx.getModel(model, key)
+                                ctx.getModel(model, resolvedKey)
                             ];
                         case 1:
                             result = _state.sent();
@@ -10045,6 +10108,7 @@ exports.requireCliContext = requireCliContext;
 exports.resolveActiveEnvName = resolveActiveEnvName;
 exports.resolveCliModel = resolveCliModel;
 exports.resolveOutputConfig = resolveOutputConfig;
+exports.resolvePerModelGetKey = resolvePerModelGetKey;
 exports.revokeToken = revokeToken;
 exports.runCli = runCli;
 exports.runPaginatedList = runPaginatedList;

package/index.esm.js

@@ -8938,7 +8938,7 @@ function buildModelCommand(model, entries, context) {
                     }
                 }
             }
-            yargs.command(buildPerModelGetCommand(model));
+            yargs.command(buildPerModelGetCommand(model, context.modelManifest));
             hideGlobalOptions(yargs, context.hideOnFocus);
             return yargs.demandCommand(1, 'Please specify an action.');
         },
@@ -8948,24 +8948,85 @@ function buildModelCommand(model, entries, context) {
     };
 }
 /**
- * Synthetic per-model `get <key>` sub-command appended to every model's command tree.
+ * Resolves a per-model `get` positional into the full Firestore key the backend expects.
  *
- * The parent `model <name>` already fixes the `modelType`, so this command just passes the bare
- * `key` positional through to `context.getModel(modelType, key)`. Supports both the full
- * `<prefix>/<id>` form and a bare doc id (when the user knows the modelType from the parent).
- */ function buildPerModelGetCommand(model) {
+ * The backend's `ModelApiController.getOne` only accepts full `prefix/id` keys, so a bare doc id
+ * has to be expanded before the HTTP call. The expansion is only safe for top-level (root) models
+ * whose `collectionPrefix` is enough to address the document — subcollection models also need the
+ * parent prefix/id and cannot be reconstructed from a bare id alone.
+ *
+ * Rules:
+ * 1. Keys containing `/` are treated as full keys and passed through verbatim.
+ * 2. Bare ids on a top-level model resolve to `<collectionPrefix>/<id>` via the manifest.
+ * 3. Bare ids on a subcollection model throw — the parent path is required.
+ * 4. When the manifest is not wired, bare ids pass through unchanged (preserves the old behavior
+ *    so the CLI still works without `modelManifest` even though the backend will reject the call).
+ *
+ * @param model - The persisted model type (e.g. `profile`).
+ * @param key - The trimmed `<key>` positional from yargs — full `prefix/id` or bare doc id.
+ * @param manifest - The generated model manifest used to look up the model's `collectionPrefix`
+ *   and `parentIdentityConst`. When omitted, the key passes through unchanged.
+ * @returns The resolved Firestore model key ready for `context.getModel(model, key)`.
+ * @__NO_SIDE_EFFECTS__
+ */ function resolvePerModelGetKey(model, key, manifest) {
+    var result = key;
+    if (!key.includes('/')) {
+        var entry = manifest === null || manifest === void 0 ? void 0 : manifest.find(function(e) {
+            return e.modelType === model;
+        });
+        if (entry) {
+            if (entry.parentIdentityConst) {
+                throw new CliError({
+                    message: "get: model '".concat(model, "' is a subcollection — bare doc id '").concat(key, "' is ambiguous without the parent path. Provide a full key (e.g. '<parentPrefix>/<parentId>/").concat(entry.collectionPrefix, "/").concat(key, "')."),
+                    code: 'INVALID_ARGUMENT'
+                });
+            }
+            result = "".concat(entry.collectionPrefix, "/").concat(key);
+        }
+    }
+    return result;
+}
+/**
+ * Synthetic per-model `get` sub-command appended to every model's command tree.
+ *
+ * The parent `model <name>` already fixes the `modelType`. The command shape varies by whether
+ * the model is root-level (no parent) or a subcollection — only root models can address documents
+ * by bare doc id, so subcollection models keep the `<key>` positional (full `prefix/id` required):
+ *
+ * - **Root model with a wired manifest entry** — `get <id-or-key>` accepts either a bare doc id
+ *   (expanded to `<collectionPrefix>/<id>` via {@link resolvePerModelGetKey}) or a full
+ *   `<prefix>/<id>` key.
+ * - **Subcollection model with a wired manifest entry** — `get <key>` requires the full
+ *   `<parentPrefix>/<parentId>/<childPrefix>/<childId>` path. Bare doc ids are rejected with a
+ *   clear error because the parent path cannot be reconstructed from the id alone.
+ * - **No wired model manifest** — falls back to `get <key>`; the key is forwarded verbatim and
+ *   the backend will reject anything that is not a full `prefix/id` key.
+ *
+ * @param model - The persisted model type owning this `get` subcommand.
+ * @param manifest - The generated model manifest used by {@link resolvePerModelGetKey} to expand
+ *   bare doc ids into full keys for top-level models and to pick the command shape.
+ * @returns The yargs `CommandModule` registered under the model's command tree.
+ */ function buildPerModelGetCommand(model, manifest) {
+    var entry = manifest === null || manifest === void 0 ? void 0 : manifest.find(function(e) {
+        return e.modelType === model;
+    });
+    var isRootModel = entry != null && !entry.parentIdentityConst;
+    var positionalName = isRootModel ? 'idOrKey' : 'key';
+    var placeholder = isRootModel ? '<id-or-key>' : '<key>';
+    var positionalDescribe = isRootModel ? "Firestore key for the ".concat(model, " document — bare doc id (resolved to `").concat(entry.collectionPrefix, "/<id>`) or full `prefix/id`.") : "Firestore key for the ".concat(model, " document (full `prefix/id` — bare doc id is not supported").concat(entry ? ' for this subcollection model' : '', ").");
+    var commandDescribe = isRootModel ? "Read a single ".concat(model, " document by id or key.") : "Read a single ".concat(model, " document by key.");
     return {
-        command: 'get <key>',
-        describe: "Read a single ".concat(model, " document by key."),
+        command: "get ".concat(placeholder),
+        describe: commandDescribe,
         builder: function builder(yargs) {
-            return yargs.positional('key', {
+            return yargs.positional(positionalName, {
                 type: 'string',
-                describe: "Firestore key for the ".concat(model, " document (full `prefix/id` or bare id).")
+                describe: positionalDescribe
             });
         },
         handler: function handler(argv) {
             return _async_to_generator$1(function() {
-                var ctx, key, result, e;
+                var ctx, raw, key, resolvedKey, result, e;
                 return _ts_generator$1(this, function(_state) {
                     switch(_state.label){
                         case 0:
@@ -8976,16 +9037,18 @@ function buildModelCommand(model, entries, context) {
                                 3
                             ]);
                             ctx = requireCliContext();
-                            key = typeof argv.key === 'string' ? argv.key.trim() : '';
+                            raw = argv[positionalName];
+                            key = typeof raw === 'string' ? raw.trim() : '';
                             if (key.length === 0) {
                                 throw new CliError({
-                                    message: "get: missing required <key> positional for model '".concat(model, "'."),
+                                    message: "get: missing required ".concat(placeholder, " positional for model '").concat(model, "'."),
                                     code: 'INVALID_ARGUMENT'
                                 });
                             }
+                            resolvedKey = resolvePerModelGetKey(model, key, manifest);
                             return [
                                 4,
-                                ctx.getModel(model, key)
+                                ctx.getModel(model, resolvedKey)
                             ];
                         case 1:
                             result = _state.sent();
@@ -9953,4 +10016,4 @@ function printPaginatedOutput(input) {
     })();
 }
 
-export { CALL_MODEL_API_PATH, CliError, DEFAULT_CLI_OIDC_SCOPES, DEFAULT_CLI_REDIRECT_URI, DEFAULT_CLI_SECRET_PATTERNS, DEFAULT_MANIFEST_HELP_DATA_FORMAT, DEFAULT_MANIFEST_HELP_MODE, DEFAULT_MANIFEST_MODEL_COMMAND_NAME, DEFAULT_MODEL_DECODE_COMMAND_NAME, DEFAULT_MODEL_INFO_COMMAND_NAME, DUMP_MERGE_MODES, DUMP_OUTPUT_MODES, MAX_MODEL_ACCESS_MULTI_READ_KEYS, MODEL_WRITE_OIDC_SCOPES, MULTIPLE_PAGES_OUTPUT_MODES, PROMPT_CANCELLED_ERROR_CODE, STANDARD_GLOBAL_OPTION_NAMES, applyEnvVarOverrides, buildAuthorizationUrl, buildCliPaths, buildDumpFilePath, buildErrorOutput, buildManifestCommands, buildModelDecodeCommand, buildModelInfoCommand, buildOidcDiscoveryCandidates, callModelOverHttp, callPassthroughCommand, configureCliErrorMapper, configureCliSecretPatterns, configureOutputOptions, createAuthCommand, createAuthMiddleware, createCallModelCommand, createCli, createCliContext, createCliTokenCacheStore, createContextSlot, createDoctorCommand, createEnvCommand, createOutputCommand, createOutputMiddleware, decodeFirestoreModelKey, defaultDoctorChecks, detectDataHelpFormat, detectHelpMode, discoverOidcMetadata, dumpTimestamp, exchangeAuthorizationCode, expandModelKeys, fetchUserInfo, filterReadOnlyModelScopes, findCliEnvDefault, findCliModelManifestEntry, generateOAuthState, generatePkceMaterial, getCliContext, getCommand, getManyCommand, getModelOverHttp, getMultipleModelsOverHttp, getOutputOptions, isCliEnvConfigComplete, isTokenExpired, loadCliConfig, maskSecret, mergeCliConfig, mergeCliEnvWithDefault, mergeOutputConfig, openStreamingDump, outputError, outputResult, parseGetArgs, parseGetManyArgs, parsePastedRedirect, pickFields, promptLine, refreshAccessToken, renderDecodedKey, renderModelManifestEntry, renderModelManifestFields, renderModelManifestList, requireCliContext, resolveActiveEnvName, resolveCliModel, resolveOutputConfig, revokeToken, runCli, runPaginatedList, sanitizeString, saveCliConfig, setCliContext, withCallModelArgs, withEnv, withMultiplePages, withOutput, wrapCommandHandler };
+export { CALL_MODEL_API_PATH, CliError, DEFAULT_CLI_OIDC_SCOPES, DEFAULT_CLI_REDIRECT_URI, DEFAULT_CLI_SECRET_PATTERNS, DEFAULT_MANIFEST_HELP_DATA_FORMAT, DEFAULT_MANIFEST_HELP_MODE, DEFAULT_MANIFEST_MODEL_COMMAND_NAME, DEFAULT_MODEL_DECODE_COMMAND_NAME, DEFAULT_MODEL_INFO_COMMAND_NAME, DUMP_MERGE_MODES, DUMP_OUTPUT_MODES, MAX_MODEL_ACCESS_MULTI_READ_KEYS, MODEL_WRITE_OIDC_SCOPES, MULTIPLE_PAGES_OUTPUT_MODES, PROMPT_CANCELLED_ERROR_CODE, STANDARD_GLOBAL_OPTION_NAMES, applyEnvVarOverrides, buildAuthorizationUrl, buildCliPaths, buildDumpFilePath, buildErrorOutput, buildManifestCommands, buildModelDecodeCommand, buildModelInfoCommand, buildOidcDiscoveryCandidates, callModelOverHttp, callPassthroughCommand, configureCliErrorMapper, configureCliSecretPatterns, configureOutputOptions, createAuthCommand, createAuthMiddleware, createCallModelCommand, createCli, createCliContext, createCliTokenCacheStore, createContextSlot, createDoctorCommand, createEnvCommand, createOutputCommand, createOutputMiddleware, decodeFirestoreModelKey, defaultDoctorChecks, detectDataHelpFormat, detectHelpMode, discoverOidcMetadata, dumpTimestamp, exchangeAuthorizationCode, expandModelKeys, fetchUserInfo, filterReadOnlyModelScopes, findCliEnvDefault, findCliModelManifestEntry, generateOAuthState, generatePkceMaterial, getCliContext, getCommand, getManyCommand, getModelOverHttp, getMultipleModelsOverHttp, getOutputOptions, isCliEnvConfigComplete, isTokenExpired, loadCliConfig, maskSecret, mergeCliConfig, mergeCliEnvWithDefault, mergeOutputConfig, openStreamingDump, outputError, outputResult, parseGetArgs, parseGetManyArgs, parsePastedRedirect, pickFields, promptLine, refreshAccessToken, renderDecodedKey, renderModelManifestEntry, renderModelManifestFields, renderModelManifestList, requireCliContext, resolveActiveEnvName, resolveCliModel, resolveOutputConfig, resolvePerModelGetKey, revokeToken, runCli, runPaginatedList, sanitizeString, saveCliConfig, setCliContext, withCallModelArgs, withEnv, withMultiplePages, withOutput, wrapCommandHandler };

package/manifest-extract/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/dbx-cli/manifest-extract",
-  "version": "13.11.9",
+  "version": "13.11.10",
   "sideEffects": false,
   "peerDependencies": {
     "ts-morph": "^21.0.0"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/dbx-cli",
-  "version": "13.11.9",
+  "version": "13.11.10",
   "sideEffects": false,
   "bin": {
     "dbx-cli-generate-firebase-api-manifest": "firebase-api-manifest/main.js"
@@ -24,10 +24,10 @@
     }
   },
   "peerDependencies": {
-    "@dereekb/date": "13.11.9",
-    "@dereekb/firebase": "13.11.9",
-    "@dereekb/nestjs": "13.11.9",
-    "@dereekb/util": "13.11.9",
+    "@dereekb/date": "13.11.10",
+    "@dereekb/firebase": "13.11.10",
+    "@dereekb/nestjs": "13.11.10",
+    "@dereekb/util": "13.11.10",
     "arktype": "^2.2.0",
     "yargs": "^18.0.0"
   },

package/src/lib/manifest/build-manifest-commands.d.ts

@@ -142,3 +142,26 @@ export declare function detectDataHelpFormat(argv?: readonly string[]): Manifest
  * @returns The detected mode, or {@link DEFAULT_MANIFEST_HELP_MODE}.
  */
 export declare function detectHelpMode(argv?: readonly string[]): ManifestHelpMode;
+/**
+ * Resolves a per-model `get` positional into the full Firestore key the backend expects.
+ *
+ * The backend's `ModelApiController.getOne` only accepts full `prefix/id` keys, so a bare doc id
+ * has to be expanded before the HTTP call. The expansion is only safe for top-level (root) models
+ * whose `collectionPrefix` is enough to address the document — subcollection models also need the
+ * parent prefix/id and cannot be reconstructed from a bare id alone.
+ *
+ * Rules:
+ * 1. Keys containing `/` are treated as full keys and passed through verbatim.
+ * 2. Bare ids on a top-level model resolve to `<collectionPrefix>/<id>` via the manifest.
+ * 3. Bare ids on a subcollection model throw — the parent path is required.
+ * 4. When the manifest is not wired, bare ids pass through unchanged (preserves the old behavior
+ *    so the CLI still works without `modelManifest` even though the backend will reject the call).
+ *
+ * @param model - The persisted model type (e.g. `profile`).
+ * @param key - The trimmed `<key>` positional from yargs — full `prefix/id` or bare doc id.
+ * @param manifest - The generated model manifest used to look up the model's `collectionPrefix`
+ *   and `parentIdentityConst`. When omitted, the key passes through unchanged.
+ * @returns The resolved Firestore model key ready for `context.getModel(model, key)`.
+ * @__NO_SIDE_EFFECTS__
+ */
+export declare function resolvePerModelGetKey(model: string, key: string, manifest: CliModelManifest | undefined): string;