@geolonia/geonicdb-cli 0.6.2 → 0.6.4

package/README.md

@@ -564,7 +564,11 @@ When both a Bearer token and an API key are configured, both headers are sent (t
 
 ### Valid Scopes
 
-`read:entities`, `write:entities`, `read:subscriptions`, `write:subscriptions`, `read:registrations`, `write:registrations`
+`read:entities`, `write:entities`, `read:subscriptions`, `write:subscriptions`, `read:registrations`, `write:registrations`, `read:rules`, `write:rules`, `read:custom-data-models`, `write:custom-data-models`, `admin:users`, `admin:tenants`, `admin:policies`, `admin:oauth-clients`, `admin:api-keys`, `admin:metrics`
+
+`write:X` implies `read:X`. `admin:X` implies both `read:X` and `write:X`.
+
+Special scopes: `permanent` (no token expiry), `jwt` (JWT format token).
 
 ### Entity Type Restrictions
 

package/dist/index.js

@@ -303,9 +303,13 @@ function entityToFeature(entity) {
 // src/commands/help.ts
 import chalk2 from "chalk";
 var examplesMap = /* @__PURE__ */ new WeakMap();
+var notesMap = /* @__PURE__ */ new WeakMap();
 function addExamples(cmd, examples) {
   examplesMap.set(cmd, examples);
 }
+function addNotes(cmd, notes) {
+  notesMap.set(cmd, notes);
+}
 function header(title) {
   return chalk2.yellow.bold(title);
 }
@@ -451,6 +455,15 @@ function formatCommandDetails(program2, cmd, path) {
       lines.push("");
     }
   }
+  const notes = notesMap.get(cmd);
+  if (notes && notes.length > 0) {
+    lines.push("");
+    lines.push(header("NOTES"));
+    lines.push("");
+    for (const note of notes) {
+      lines.push(`  ${note}`);
+    }
+  }
   lines.push("");
   lines.push(formatGlobalParameters(program2));
   return lines.join("\n");
@@ -924,6 +937,21 @@ var GdbClientError = class extends Error {
 };
 
 // src/helpers.ts
+var SCOPES_HELP_NOTES = [
+  "Valid scopes:",
+  "  read:entities, write:entities, read:subscriptions, write:subscriptions,",
+  "  read:registrations, write:registrations, read:rules, write:rules,",
+  "  read:custom-data-models, write:custom-data-models,",
+  "  admin:users, admin:tenants, admin:policies, admin:oauth-clients,",
+  "  admin:api-keys, admin:metrics",
+  "",
+  "write:X implies read:X. admin:X implies both read:X and write:X."
+];
+var API_KEY_SCOPES_HELP_NOTES = [
+  "Valid scopes:",
+  "  read:entities, write:entities, read:subscriptions, write:subscriptions,",
+  "  read:registrations, write:registrations"
+];
 function resolveOptions(cmd) {
   const opts = cmd.optsWithGlobals();
   const config = loadConfig(opts.profile);
@@ -1348,6 +1376,7 @@ function addMeOAuthClientsSubcommand(me) {
       printSuccess("OAuth client created.");
     })
   );
+  addNotes(create, SCOPES_HELP_NOTES);
   addExamples(create, [
     {
       description: "Create an OAuth client with flags",
@@ -1465,6 +1494,7 @@ function addMeApiKeysSubcommand(me) {
       console.error("API key created.");
     })
   );
+  addNotes(create, API_KEY_SCOPES_HELP_NOTES);
   addExamples(create, [
     {
       description: "Create an API key with flags",
@@ -3731,10 +3761,11 @@ function registerApiKeysCommand(parent) {
       console.error("API key created.");
     })
   );
+  addNotes(create, API_KEY_SCOPES_HELP_NOTES);
   addExamples(create, [
     {
       description: "Create an API key with flags",
-      command: "geonic admin api-keys create --name my-key --scopes entities:read,entities:write --origins '*'"
+      command: "geonic admin api-keys create --name my-key --scopes read:entities,write:entities --origins '*'"
     },
     {
       description: "Create an API key with DPoP required",
@@ -3771,6 +3802,7 @@ function registerApiKeysCommand(parent) {
       }
     )
   );
+  addNotes(update, API_KEY_SCOPES_HELP_NOTES);
   addExamples(update, [
     {
       description: "Update an API key name",