shred-api-client 2.8.0 → 2.8.1

package/dist/index.d.ts

@@ -3517,7 +3517,8 @@ declare namespace index$1 {
  * An Action is an atomic capability the code checks (via `<Allowed>` in the hub,
  * `requireAction` in the API). Roles are bags of Actions; the code never checks roles.
  *
- * Adding a capability = add a key here, then bump this package (see rbac docs).
+ * Adding a capability = add a key here, add its metadata to `ActionCatalog`
+ * (the compiler enforces the entry exists), then bump this package (see rbac docs).
  * String values are dot-notation `domain.action` and are permanent once shipped.
  */
 declare const Actions: {
@@ -3581,7 +3582,6 @@ declare const Actions: {
     readonly PROMPT_GET: "prompt.get";
     readonly EMAIL_SEND: "email.send";
     readonly USER_SEARCH: "user.search";
-    readonly USER_CREATE_PRIVILEGED: "user.create_privileged";
     readonly USER_UPDATE: "user.update";
     readonly USER_DELETE: "user.delete";
     readonly USER_CHANGE_EMAIL: "user.change_email";
@@ -3603,26 +3603,35 @@ type Scope = {
     id: string;
 };
 type ActionGroup = "Projects" | "Editors" | "Goals" | "Notes" | "Tenants" | "Offers" | "Subscriptions" | "Scripts" | "Prompts" | "Email" | "Users" | "Administration";
-/** Metadata for one Action — powers the admin "create/edit role" UI (GET /actions). */
-type ActionCatalogEntry = {
-    key: Action;
+type ActionMeta = {
     label: string;
     group: ActionGroup;
 };
+/** One catalog row as served to the admin UI (GET /actions). */
+type ActionCatalogEntry = ActionMeta & {
+    key: Action;
+};
 /**
- * Human-readable catalog for the admin UI. References `Actions.*` values so the
- * string literal lives in exactly one place — this only adds label + group metadata.
+ * Human-readable metadata for every Action, powering the admin "create/edit role" UI.
+ *
+ * Typed as `Record<Action, ActionMeta>`, so the compiler GUARANTEES: every Action has
+ * exactly one entry (a missing one is a build error), and no entry can reference an
+ * Action that doesn't exist. Keys reference `Actions.*` so each string lives in one place.
  */
-declare const ActionCatalog: ActionCatalogEntry[];
+declare const ActionCatalog: Record<Action, ActionMeta>;
+/** The catalog as a flat list of `{ key, label, group }` — e.g. for `GET /actions`. */
+declare function listActionCatalog(): ActionCatalogEntry[];
 
 type index_Action = Action;
 declare const index_ActionCatalog: typeof ActionCatalog;
 type index_ActionCatalogEntry = ActionCatalogEntry;
 type index_ActionGroup = ActionGroup;
+type index_ActionMeta = ActionMeta;
 declare const index_Actions: typeof Actions;
 type index_Scope = Scope;
+declare const index_listActionCatalog: typeof listActionCatalog;
 declare namespace index {
-  export { type index_Action as Action, index_ActionCatalog as ActionCatalog, type index_ActionCatalogEntry as ActionCatalogEntry, type index_ActionGroup as ActionGroup, index_Actions as Actions, type index_Scope as Scope };
+  export { type index_Action as Action, index_ActionCatalog as ActionCatalog, type index_ActionCatalogEntry as ActionCatalogEntry, type index_ActionGroup as ActionGroup, type index_ActionMeta as ActionMeta, index_Actions as Actions, type index_Scope as Scope, index_listActionCatalog as listActionCatalog };
 }
 
 export { index$1 as Asset, index$d as Core, index$6 as Editor, index$9 as Email, index$2 as Exceptions, index$7 as Goal, index$4 as Note, index$5 as Notification, index$8 as Project, index$f as Prompt, index as RBAC, ShredAPI, index$3 as SpecialOffer, index$e as Subscription, index$b as Tenant, index$a as Track, index$c as User, ShredAPI as default };

package/dist/index.js

@@ -6476,7 +6476,8 @@ __export(special_offer_exports, {
 var rbac_exports = {};
 __export(rbac_exports, {
   ActionCatalog: () => ActionCatalog,
-  Actions: () => Actions
+  Actions: () => Actions,
+  listActionCatalog: () => listActionCatalog
 });
 
 // src/model/rbac/Actions.ts
@@ -6553,7 +6554,6 @@ var Actions = {
   EMAIL_SEND: "email.send",
   // — Users —
   USER_SEARCH: "user.search",
-  USER_CREATE_PRIVILEGED: "user.create_privileged",
   USER_UPDATE: "user.update",
   USER_DELETE: "user.delete",
   USER_CHANGE_EMAIL: "user.change_email",
@@ -6563,88 +6563,93 @@ var Actions = {
   ROLE_MANAGE: "role.manage",
   USER_ASSIGN_ROLE: "user.assign_role"
 };
-var ActionCatalog = [
+var ActionCatalog = {
   // Projects
-  { key: Actions.PROJECT_APPROVE, label: "Approve project", group: "Projects" },
-  { key: Actions.PROJECT_DENY, label: "Deny project", group: "Projects" },
-  { key: Actions.PROJECT_ASSIGN, label: "Assign project", group: "Projects" },
-  { key: Actions.PROJECT_ROLLBACK, label: "Rollback project", group: "Projects" },
-  { key: Actions.PROJECT_SCHEDULE, label: "Schedule project", group: "Projects" },
-  { key: Actions.PROJECT_UNSCHEDULE, label: "Unschedule project", group: "Projects" },
-  { key: Actions.PROJECT_GET_NEXT_IN_QUEUE, label: "Get next project in queue", group: "Projects" },
-  { key: Actions.PROJECT_VIEW_ALL, label: "View all projects", group: "Projects" },
-  { key: Actions.PROJECT_VIEW_HISTORY, label: "View project history", group: "Projects" },
-  { key: Actions.PROJECT_START, label: "Start project (pull from pool)", group: "Projects" },
-  { key: Actions.PROJECT_SEND_TO_APPROVAL, label: "Send project to approval", group: "Projects" },
-  { key: Actions.PROJECT_VIEW_POOL, label: "View pool size", group: "Projects" },
-  { key: Actions.PROJECT_STREAM, label: "Stream projects (realtime)", group: "Projects" },
-  { key: Actions.PROJECT_CREATE, label: "Create project", group: "Projects" },
-  { key: Actions.PROJECT_CANCEL, label: "Cancel project", group: "Projects" },
-  { key: Actions.PROJECT_REORDER, label: "Reorder projects", group: "Projects" },
-  { key: Actions.PROJECT_REQUEST_REVIEW, label: "Request project review", group: "Projects" },
-  { key: Actions.PROJECT_RECORD_INTERACTION, label: "Record project interaction", group: "Projects" },
-  { key: Actions.PROJECT_CHECK_FREE_QUOTA, label: "Check free project quota", group: "Projects" },
-  { key: Actions.PROJECT_LIST_OWN, label: "List own projects", group: "Projects" },
-  { key: Actions.PROJECT_VIEW_OWN, label: "View own project", group: "Projects" },
+  [Actions.PROJECT_APPROVE]: { label: "Approve project", group: "Projects" },
+  [Actions.PROJECT_DENY]: { label: "Deny project", group: "Projects" },
+  [Actions.PROJECT_ASSIGN]: { label: "Assign project", group: "Projects" },
+  [Actions.PROJECT_ROLLBACK]: { label: "Rollback project", group: "Projects" },
+  [Actions.PROJECT_SCHEDULE]: { label: "Schedule project", group: "Projects" },
+  [Actions.PROJECT_UNSCHEDULE]: { label: "Unschedule project", group: "Projects" },
+  [Actions.PROJECT_GET_NEXT_IN_QUEUE]: { label: "Get next project in queue", group: "Projects" },
+  [Actions.PROJECT_VIEW_ALL]: { label: "View all projects", group: "Projects" },
+  [Actions.PROJECT_VIEW_HISTORY]: { label: "View project history", group: "Projects" },
+  [Actions.PROJECT_START]: { label: "Start project (pull from pool)", group: "Projects" },
+  [Actions.PROJECT_SEND_TO_APPROVAL]: { label: "Send project to approval", group: "Projects" },
+  [Actions.PROJECT_VIEW_POOL]: { label: "View pool size", group: "Projects" },
+  [Actions.PROJECT_STREAM]: { label: "Stream projects (realtime)", group: "Projects" },
+  [Actions.PROJECT_CREATE]: { label: "Create project", group: "Projects" },
+  [Actions.PROJECT_CANCEL]: { label: "Cancel project", group: "Projects" },
+  [Actions.PROJECT_REORDER]: { label: "Reorder projects", group: "Projects" },
+  [Actions.PROJECT_REQUEST_REVIEW]: { label: "Request project review", group: "Projects" },
+  [Actions.PROJECT_RECORD_INTERACTION]: { label: "Record project interaction", group: "Projects" },
+  [Actions.PROJECT_CHECK_FREE_QUOTA]: { label: "Check free project quota", group: "Projects" },
+  [Actions.PROJECT_LIST_OWN]: { label: "List own projects", group: "Projects" },
+  [Actions.PROJECT_VIEW_OWN]: { label: "View own project", group: "Projects" },
   // Editors
-  { key: Actions.EDITOR_LIST, label: "List editors", group: "Editors" },
-  { key: Actions.EDITOR_GET, label: "View editor", group: "Editors" },
+  [Actions.EDITOR_LIST]: { label: "List editors", group: "Editors" },
+  [Actions.EDITOR_GET]: { label: "View editor", group: "Editors" },
   // Goals
-  { key: Actions.GOAL_VIEW_OWN, label: "View own goals", group: "Goals" },
-  { key: Actions.GOAL_VIEW_EDITOR, label: "View editor goals", group: "Goals" },
+  [Actions.GOAL_VIEW_OWN]: { label: "View own goals", group: "Goals" },
+  [Actions.GOAL_VIEW_EDITOR]: { label: "View editor goals", group: "Goals" },
   // Notes
-  { key: Actions.NOTE_VIEW, label: "View notes", group: "Notes" },
-  { key: Actions.NOTE_CREATE, label: "Create note", group: "Notes" },
-  { key: Actions.NOTE_UPDATE, label: "Update note", group: "Notes" },
-  { key: Actions.NOTE_DELETE, label: "Delete note", group: "Notes" },
+  [Actions.NOTE_VIEW]: { label: "View notes", group: "Notes" },
+  [Actions.NOTE_CREATE]: { label: "Create note", group: "Notes" },
+  [Actions.NOTE_UPDATE]: { label: "Update note", group: "Notes" },
+  [Actions.NOTE_DELETE]: { label: "Delete note", group: "Notes" },
   // Tenants
-  { key: Actions.TENANT_CREATE, label: "Create tenant", group: "Tenants" },
-  { key: Actions.TENANT_LIST, label: "List tenants", group: "Tenants" },
-  { key: Actions.TENANT_VIEW, label: "View tenant", group: "Tenants" },
-  { key: Actions.TENANT_UPDATE, label: "Update tenant", group: "Tenants" },
-  { key: Actions.TENANT_VIEW_MEMBERS, label: "View tenant members", group: "Tenants" },
-  { key: Actions.TENANT_UPDATE_MEMBERS, label: "Update tenant members", group: "Tenants" },
-  { key: Actions.TENANT_UPDATE_REPORT_VIEWERS, label: "Update tenant report viewers", group: "Tenants" },
-  { key: Actions.TENANT_VIEW_REPORT, label: "View tenant report", group: "Tenants" },
-  { key: Actions.TENANT_VIEW_MINE, label: "View my tenant", group: "Tenants" },
+  [Actions.TENANT_CREATE]: { label: "Create tenant", group: "Tenants" },
+  [Actions.TENANT_LIST]: { label: "List tenants", group: "Tenants" },
+  [Actions.TENANT_VIEW]: { label: "View tenant", group: "Tenants" },
+  [Actions.TENANT_UPDATE]: { label: "Update tenant", group: "Tenants" },
+  [Actions.TENANT_VIEW_MEMBERS]: { label: "View tenant members", group: "Tenants" },
+  [Actions.TENANT_UPDATE_MEMBERS]: { label: "Update tenant members", group: "Tenants" },
+  [Actions.TENANT_UPDATE_REPORT_VIEWERS]: { label: "Update tenant report viewers", group: "Tenants" },
+  [Actions.TENANT_VIEW_REPORT]: { label: "View tenant report", group: "Tenants" },
+  [Actions.TENANT_VIEW_MINE]: { label: "View my tenant", group: "Tenants" },
   // Offers
-  { key: Actions.OFFER_LIST, label: "List offers", group: "Offers" },
-  { key: Actions.OFFER_CREATE, label: "Create offer", group: "Offers" },
-  { key: Actions.OFFER_UPDATE, label: "Update offer", group: "Offers" },
-  { key: Actions.OFFER_ENABLE, label: "Enable offer", group: "Offers" },
-  { key: Actions.OFFER_DISABLE, label: "Disable offer", group: "Offers" },
-  { key: Actions.OFFER_GET_MINE, label: "View my offer", group: "Offers" },
-  { key: Actions.OFFER_CLAIM, label: "Claim offer", group: "Offers" },
+  [Actions.OFFER_LIST]: { label: "List offers", group: "Offers" },
+  [Actions.OFFER_CREATE]: { label: "Create offer", group: "Offers" },
+  [Actions.OFFER_UPDATE]: { label: "Update offer", group: "Offers" },
+  [Actions.OFFER_ENABLE]: { label: "Enable offer", group: "Offers" },
+  [Actions.OFFER_DISABLE]: { label: "Disable offer", group: "Offers" },
+  [Actions.OFFER_GET_MINE]: { label: "View my offer", group: "Offers" },
+  [Actions.OFFER_CLAIM]: { label: "Claim offer", group: "Offers" },
   // Subscriptions
-  { key: Actions.SUBSCRIPTION_VIEW_USER, label: "View user subscription", group: "Subscriptions" },
-  { key: Actions.SUBSCRIPTION_VIEW_SUMMARY, label: "View subscription summary", group: "Subscriptions" },
-  { key: Actions.SUBSCRIPTION_LIST_PROMO_CODES, label: "List promo codes", group: "Subscriptions" },
-  { key: Actions.SUBSCRIPTION_CHECKOUT, label: "Checkout subscription", group: "Subscriptions" },
-  { key: Actions.SUBSCRIPTION_PORTAL, label: "Open subscription portal", group: "Subscriptions" },
-  { key: Actions.SUBSCRIPTION_VIEW_ACTIVE, label: "View active subscription", group: "Subscriptions" },
-  { key: Actions.SUBSCRIPTION_LIST_PRODUCTS, label: "List subscription products", group: "Subscriptions" },
+  [Actions.SUBSCRIPTION_VIEW_USER]: { label: "View user subscription", group: "Subscriptions" },
+  [Actions.SUBSCRIPTION_VIEW_SUMMARY]: { label: "View subscription summary", group: "Subscriptions" },
+  [Actions.SUBSCRIPTION_LIST_PROMO_CODES]: { label: "List promo codes", group: "Subscriptions" },
+  [Actions.SUBSCRIPTION_CHECKOUT]: { label: "Checkout subscription", group: "Subscriptions" },
+  [Actions.SUBSCRIPTION_PORTAL]: { label: "Open subscription portal", group: "Subscriptions" },
+  [Actions.SUBSCRIPTION_VIEW_ACTIVE]: { label: "View active subscription", group: "Subscriptions" },
+  [Actions.SUBSCRIPTION_LIST_PRODUCTS]: { label: "List subscription products", group: "Subscriptions" },
   // Scripts
-  { key: Actions.SCRIPT_LIST, label: "List scripts", group: "Scripts" },
-  { key: Actions.SCRIPT_CREATE, label: "Create script", group: "Scripts" },
-  { key: Actions.SCRIPT_UPDATE, label: "Update script", group: "Scripts" },
-  { key: Actions.SCRIPT_DELETE, label: "Delete script", group: "Scripts" },
-  { key: Actions.SCRIPT_GENERATE, label: "Generate script", group: "Scripts" },
+  [Actions.SCRIPT_LIST]: { label: "List scripts", group: "Scripts" },
+  [Actions.SCRIPT_CREATE]: { label: "Create script", group: "Scripts" },
+  [Actions.SCRIPT_UPDATE]: { label: "Update script", group: "Scripts" },
+  [Actions.SCRIPT_DELETE]: { label: "Delete script", group: "Scripts" },
+  [Actions.SCRIPT_GENERATE]: { label: "Generate script", group: "Scripts" },
   // Prompts
-  { key: Actions.PROMPT_GET, label: "Get prompt", group: "Prompts" },
+  [Actions.PROMPT_GET]: { label: "Get prompt", group: "Prompts" },
   // Email
-  { key: Actions.EMAIL_SEND, label: "Send email", group: "Email" },
+  [Actions.EMAIL_SEND]: { label: "Send email", group: "Email" },
   // Users
-  { key: Actions.USER_SEARCH, label: "Search users", group: "Users" },
-  { key: Actions.USER_CREATE_PRIVILEGED, label: "Create privileged user", group: "Users" },
-  { key: Actions.USER_UPDATE, label: "Update own profile", group: "Users" },
-  { key: Actions.USER_DELETE, label: "Delete own account", group: "Users" },
-  { key: Actions.USER_CHANGE_EMAIL, label: "Change own email", group: "Users" },
-  { key: Actions.USER_GET_TOKEN, label: "Get API token", group: "Users" },
-  { key: Actions.USER_CREATE_TOKEN, label: "Create API token", group: "Users" },
+  [Actions.USER_SEARCH]: { label: "Search users", group: "Users" },
+  [Actions.USER_UPDATE]: { label: "Update own profile", group: "Users" },
+  [Actions.USER_DELETE]: { label: "Delete own account", group: "Users" },
+  [Actions.USER_CHANGE_EMAIL]: { label: "Change own email", group: "Users" },
+  [Actions.USER_GET_TOKEN]: { label: "Get API token", group: "Users" },
+  [Actions.USER_CREATE_TOKEN]: { label: "Create API token", group: "Users" },
   // Administration
-  { key: Actions.ROLE_MANAGE, label: "Manage roles", group: "Administration" },
-  { key: Actions.USER_ASSIGN_ROLE, label: "Assign roles to users", group: "Administration" }
-];
+  [Actions.ROLE_MANAGE]: { label: "Manage roles", group: "Administration" },
+  [Actions.USER_ASSIGN_ROLE]: { label: "Assign roles to users", group: "Administration" }
+};
+function listActionCatalog() {
+  return Object.entries(ActionCatalog).map(([key, meta]) => ({
+    key,
+    ...meta
+  }));
+}
 
 // src/index.ts
 var index_default = ShredAPI;