shred-api-client 2.9.1 → 2.9.3

package/dist/index.d.ts

@@ -3497,6 +3497,15 @@ type ActionGroup = "Projects" | "Editors" | "Goals" | "Notes" | "Tenants" | "Off
 type ActionMeta = {
     label: string;
     group: ActionGroup;
+    /**
+     * Whether this action is meaningful when scoped to a single tenant.
+     * A role that contains at least one scopeable action can be assigned with
+     * `scope: tenant:<id>`; roles made only of global capabilities (e.g. admin,
+     * role management) can only be assigned globally.
+     *
+     * Add `scopeable: true` to any action that should become tenant-scoped later.
+     */
+    scopeable?: boolean;
 };
 /** One catalog row as served to the admin UI (GET /actions). */
 type ActionCatalogEntry = ActionMeta & {
@@ -3512,6 +3521,8 @@ type ActionCatalogEntry = ActionMeta & {
 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[];
+/** Whether an action is meaningful when scoped to a single tenant. */
+declare function isScopeable(action: Action): boolean;
 
 declare const RoleSchema: z.ZodObject<{
     id: z.ZodString;
@@ -3642,6 +3653,24 @@ declare const RoleAssignmentSchema: z.ZodObject<{
 type RoleGrant = z.infer<typeof RoleGrantSchema>;
 type RoleAssignment = z.infer<typeof RoleAssignmentSchema>;
 
+declare const PrincipalSchema: z.ZodObject<{
+    uid: z.ZodString;
+    email: z.ZodString;
+    name: z.ZodString;
+    disabled: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    email: string;
+    name: string;
+    uid: string;
+    disabled: boolean;
+}, {
+    email: string;
+    name: string;
+    uid: string;
+    disabled: boolean;
+}>;
+type Principal = z.infer<typeof PrincipalSchema>;
+
 type CreateRoleInput = Omit<Role, "id">;
 type UpdateRoleInput = Partial<Omit<Role, "id">>;
 type AssignRoleInput = RoleGrant;
@@ -3654,6 +3683,7 @@ interface IAPI {
     getAssignments: (c: Context, uid: string) => Promise<RoleAssignment | null>;
     assign: (c: Context, uid: string, input: AssignRoleInput) => Promise<RoleAssignment>;
     unassign: (c: Context, uid: string, input: AssignRoleInput) => Promise<RoleAssignment>;
+    searchPrincipals: (c: Context, term: string) => Promise<Principal[]>;
 }
 declare const Endpoints: {
     GetActions: {
@@ -3688,6 +3718,10 @@ declare const Endpoints: {
         uri: string;
         method: string;
     };
+    SearchPrincipals: {
+        uri: string;
+        method: string;
+    };
 };
 
 type index$2_Action = Action;
@@ -3700,6 +3734,8 @@ type index$2_AssignRoleInput = AssignRoleInput;
 type index$2_CreateRoleInput = CreateRoleInput;
 declare const index$2_Endpoints: typeof Endpoints;
 type index$2_IAPI = IAPI;
+type index$2_Principal = Principal;
+declare const index$2_PrincipalSchema: typeof PrincipalSchema;
 type index$2_Role = Role;
 type index$2_RoleAssignment = RoleAssignment;
 declare const index$2_RoleAssignmentSchema: typeof RoleAssignmentSchema;
@@ -3709,9 +3745,10 @@ declare const index$2_RoleSchema: typeof RoleSchema;
 type index$2_Scope = Scope;
 declare const index$2_ScopeSchema: typeof ScopeSchema;
 type index$2_UpdateRoleInput = UpdateRoleInput;
+declare const index$2_isScopeable: typeof isScopeable;
 declare const index$2_listActionCatalog: typeof listActionCatalog;
 declare namespace index$2 {
-  export { type index$2_Action as Action, index$2_ActionCatalog as ActionCatalog, type index$2_ActionCatalogEntry as ActionCatalogEntry, type index$2_ActionGroup as ActionGroup, type index$2_ActionMeta as ActionMeta, index$2_Actions as Actions, type index$2_AssignRoleInput as AssignRoleInput, type index$2_CreateRoleInput as CreateRoleInput, index$2_Endpoints as Endpoints, type index$2_IAPI as IAPI, type index$2_Role as Role, type index$2_RoleAssignment as RoleAssignment, index$2_RoleAssignmentSchema as RoleAssignmentSchema, type index$2_RoleGrant as RoleGrant, index$2_RoleGrantSchema as RoleGrantSchema, index$2_RoleSchema as RoleSchema, type index$2_Scope as Scope, index$2_ScopeSchema as ScopeSchema, type index$2_UpdateRoleInput as UpdateRoleInput, index$2_listActionCatalog as listActionCatalog };
+  export { type index$2_Action as Action, index$2_ActionCatalog as ActionCatalog, type index$2_ActionCatalogEntry as ActionCatalogEntry, type index$2_ActionGroup as ActionGroup, type index$2_ActionMeta as ActionMeta, index$2_Actions as Actions, type index$2_AssignRoleInput as AssignRoleInput, type index$2_CreateRoleInput as CreateRoleInput, index$2_Endpoints as Endpoints, type index$2_IAPI as IAPI, type index$2_Principal as Principal, index$2_PrincipalSchema as PrincipalSchema, type index$2_Role as Role, type index$2_RoleAssignment as RoleAssignment, index$2_RoleAssignmentSchema as RoleAssignmentSchema, type index$2_RoleGrant as RoleGrant, index$2_RoleGrantSchema as RoleGrantSchema, index$2_RoleSchema as RoleSchema, type index$2_Scope as Scope, index$2_ScopeSchema as ScopeSchema, type index$2_UpdateRoleInput as UpdateRoleInput, index$2_isScopeable as isScopeable, index$2_listActionCatalog as listActionCatalog };
 }
 
 declare class ShredAPI {

package/dist/index.js

@@ -6015,10 +6015,12 @@ __export(rbac_exports, {
   ActionCatalog: () => ActionCatalog,
   Actions: () => Actions,
   Endpoints: () => Endpoints9,
+  PrincipalSchema: () => PrincipalSchema,
   RoleAssignmentSchema: () => RoleAssignmentSchema,
   RoleGrantSchema: () => RoleGrantSchema,
   RoleSchema: () => RoleSchema,
   ScopeSchema: () => ScopeSchema,
+  isScopeable: () => isScopeable,
   listActionCatalog: () => listActionCatalog
 });
 
@@ -6148,7 +6150,7 @@ var ActionCatalog = {
   [Actions.TENANT_VIEW_MEMBERS]: { label: "View a tenant's members", group: "Tenants" },
   [Actions.TENANT_UPDATE_MEMBERS]: { label: "Manage a tenant's members", group: "Tenants" },
   [Actions.TENANT_UPDATE_REPORT_VIEWERS]: { label: "Manage a tenant's report viewers", group: "Tenants" },
-  [Actions.TENANT_VIEW_REPORT]: { label: "View a tenant's report", group: "Tenants" },
+  [Actions.TENANT_VIEW_REPORT]: { label: "View a tenant's report", group: "Tenants", scopeable: true },
   [Actions.TENANT_VIEW_MINE]: { label: "View your own tenant", group: "Tenants" },
   // Offers
   [Actions.OFFER_LIST]: { label: "List all offers", group: "Offers" },
@@ -6193,6 +6195,10 @@ function listActionCatalog() {
     ...meta
   }));
 }
+function isScopeable(action) {
+  var _a, _b;
+  return (_b = (_a = ActionCatalog[action]) == null ? void 0 : _a.scopeable) != null ? _b : false;
+}
 
 // src/model/rbac/Role.schema.ts
 var RoleSchema = external_exports.object({
@@ -6215,6 +6221,14 @@ var RoleAssignmentSchema = external_exports.object({
   roles: external_exports.array(RoleGrantSchema)
 });
 
+// src/model/rbac/Principal.schema.ts
+var PrincipalSchema = external_exports.object({
+  uid: external_exports.string(),
+  email: external_exports.string(),
+  name: external_exports.string(),
+  disabled: external_exports.boolean()
+});
+
 // src/model/rbac/RBAC.api.ts
 var Endpoints9 = {
   GetActions: { uri: "/rbac/actions", method: "GET" },
@@ -6224,7 +6238,8 @@ var Endpoints9 = {
   DeleteRole: { uri: "/rbac/roles/:roleId", method: "DELETE" },
   GetAssignments: { uri: "/rbac/assignments/:uid", method: "GET" },
   Assign: { uri: "/rbac/assignments/:uid", method: "POST" },
-  Unassign: { uri: "/rbac/assignments/:uid", method: "DELETE" }
+  Unassign: { uri: "/rbac/assignments/:uid", method: "DELETE" },
+  SearchPrincipals: { uri: "/rbac/principals", method: "GET" }
 };
 
 // src/api/RBAC.api.ts
@@ -6277,6 +6292,11 @@ var RBACAPI = class {
     const uri = e.uri.replace(":uid", uid);
     return this.clientHTTP.makeRequest(this.env, uri, e.method, input, c, RoleAssignmentSchema);
   }
+  async searchPrincipals(c, term) {
+    const e = Endpoints9.SearchPrincipals;
+    const uri = `${e.uri}?q=${encodeURIComponent(term)}`;
+    return this.clientHTTP.makeRequest(this.env, uri, e.method, null, c, external_exports.array(PrincipalSchema));
+  }
 };
 var RBAC_api_default = RBACAPI;