@omnibase/core-js 0.7.1 → 0.7.3

package/dist/permissions/index.cjs

@@ -20,12 +20,263 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/permissions/index.ts
 var permissions_exports = {};
 __export(permissions_exports, {
-  PermissionsClient: () => PermissionsClient
+  PermissionsClient: () => PermissionsClient,
+  RolesHandler: () => RolesHandler
 });
 module.exports = __toCommonJS(permissions_exports);
 
 // src/permissions/handler.ts
 var import_client = require("@ory/client");
+
+// src/permissions/roles.ts
+var RolesHandler = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Get available namespace definitions for UI
+   *
+   * Returns all namespaces and their available relations/permissions.
+   * Useful for building role configuration UIs.
+   *
+   * @returns List of namespace definitions
+   *
+   * @example
+   * ```typescript
+   * const definitions = await omnibase.permissions.roles.getDefinitions();
+   *
+   * // Output: [{ namespace: 'Tenant', relations: ['invite_user', 'delete_tenant', ...] }]
+   * definitions.forEach(def => {
+   *   console.log(`${def.namespace} supports: ${def.relations.join(', ')}`);
+   * });
+   * ```
+   */
+  async getDefinitions() {
+    const response = await this.client.fetch(
+      "/api/v1/permissions/definitions",
+      {
+        method: "GET"
+      }
+    );
+    const data = await response.json();
+    if (!response.ok || data.error) {
+      throw new Error(data.error || "Failed to fetch definitions");
+    }
+    return data.data.definitions;
+  }
+  /**
+   * List all roles for the current tenant
+   *
+   * Returns both system roles (defined in roles.config.json) and
+   * custom roles created via the API. System roles have `tenant_id = null`.
+   *
+   * @returns List of roles
+   *
+   * @example
+   * ```typescript
+   * const roles = await omnibase.permissions.roles.list();
+   *
+   * const systemRoles = roles.filter(r => r.tenant_id === null);
+   * const customRoles = roles.filter(r => r.tenant_id !== null);
+   *
+   * console.log(`System roles: ${systemRoles.map(r => r.role_name).join(', ')}`);
+   * console.log(`Custom roles: ${customRoles.map(r => r.role_name).join(', ')}`);
+   * ```
+   */
+  async list() {
+    const response = await this.client.fetch("/api/v1/permissions/roles", {
+      method: "GET"
+    });
+    const data = await response.json();
+    if (!response.ok || data.error) {
+      throw new Error(data.error || "Failed to list roles");
+    }
+    return data.data.roles;
+  }
+  /**
+   * Create a new custom role
+   *
+   * Creates a tenant-specific role with the specified permissions.
+   * Permissions use the format `namespace#relation` or `namespace:id#relation`.
+   *
+   * @param request - Role creation request
+   * @returns Created role
+   *
+   * @example
+   * ```typescript
+   * const role = await omnibase.permissions.roles.create({
+   *   role_name: 'billing_manager',
+   *   permissions: [
+   *     'tenant#manage_billing',
+   *     'tenant#view_invoices',
+   *     'tenant#update_payment_methods'
+   *   ]
+   * });
+   *
+   * console.log(`Created role: ${role.id}`);
+   * ```
+   *
+   * @example
+   * Resource-specific permissions:
+   * ```typescript
+   * const devRole = await omnibase.permissions.roles.create({
+   *   role_name: 'project_developer',
+   *   permissions: [
+   *     'project:proj_abc123#deploy',
+   *     'project:proj_abc123#view_logs',
+   *     'tenant#invite_user'
+   *   ]
+   * });
+   * ```
+   */
+  async create(request) {
+    const response = await this.client.fetch("/api/v1/permissions/roles", {
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify(request)
+    });
+    const data = await response.json();
+    if (!response.ok || data.error) {
+      throw new Error(data.error || "Failed to create role");
+    }
+    return data.data;
+  }
+  /**
+   * Update an existing role's permissions
+   *
+   * Updates the permissions for a role and automatically updates all
+   * Keto relationships for users assigned to this role. Old permissions
+   * are removed and new ones are created.
+   *
+   * @param roleId - ID of role to update
+   * @param request - Update request with new permissions
+   * @returns Updated role
+   *
+   * @example
+   * ```typescript
+   * const updatedRole = await omnibase.permissions.roles.update('role_123', {
+   *   permissions: [
+   *     'tenant#manage_billing',
+   *     'tenant#view_invoices',
+   *     'tenant#manage_users' // Added new permission
+   *   ]
+   * });
+   *
+   * console.log(`Updated role with ${updatedRole.permissions.length} permissions`);
+   * ```
+   */
+  async update(roleId, request) {
+    const response = await this.client.fetch(
+      `/api/v1/permissions/roles/${roleId}`,
+      {
+        method: "PUT",
+        headers: { "Content-Type": "application/json" },
+        body: JSON.stringify(request)
+      }
+    );
+    const data = await response.json();
+    if (!response.ok || data.error) {
+      throw new Error(data.error || "Failed to update role");
+    }
+    return data.data;
+  }
+  /**
+   * Delete a role
+   *
+   * Deletes the role and automatically removes all Keto relationships
+   * for users assigned to this role. Cannot delete system roles.
+   *
+   * @param roleId - ID of role to delete
+   *
+   * @example
+   * ```typescript
+   * await omnibase.permissions.roles.delete('role_123');
+   * console.log('Role deleted successfully');
+   * ```
+   */
+  async delete(roleId) {
+    const response = await this.client.fetch(
+      `/api/v1/permissions/roles/${roleId}`,
+      {
+        method: "DELETE"
+      }
+    );
+    const data = await response.json();
+    if (!response.ok || data.error) {
+      throw new Error(data.error || "Failed to delete role");
+    }
+  }
+  /**
+   * Assign a role to a user
+   *
+   * Assigns a role to a user and automatically creates all necessary
+   * Keto relationship tuples based on the role's permissions. The user
+   * immediately gains all permissions defined in the role.
+   *
+   * Supports assignment by either role ID or role name for flexibility.
+   *
+   * @param userId - ID of user to assign role to
+   * @param request - Assignment request with either role_id or role_name
+   *
+   * @example
+   * Assign by role ID:
+   * ```typescript
+   * await omnibase.permissions.roles.assign('user_123', {
+   *   role_id: 'role_456'
+   * });
+   * ```
+   *
+   * @example
+   * Assign by role name (system or custom role):
+   * ```typescript
+   * // Assign system role
+   * await omnibase.permissions.roles.assign('user_123', {
+   *   role_name: 'owner'
+   * });
+   *
+   * // Assign custom role
+   * await omnibase.permissions.roles.assign('user_456', {
+   *   role_name: 'billing_manager'
+   * });
+   * ```
+   *
+   * @example
+   * Verify permissions after assignment:
+   * ```typescript
+   * await omnibase.permissions.roles.assign('user_123', {
+   *   role_name: 'admin'
+   * });
+   *
+   * // User now has all permissions from the admin role
+   * const canManage = await omnibase.permissions.permissions.checkPermission(
+   *   undefined,
+   *   {
+   *     namespace: 'Tenant',
+   *     object: 'tenant_789',
+   *     relation: 'manage_billing',
+   *     subjectId: 'user_123'
+   *   }
+   * );
+   * // canManage.data.allowed === true
+   * ```
+   */
+  async assign(userId, request) {
+    const response = await this.client.fetch(
+      `/api/v1/permissions/users/${userId}/roles`,
+      {
+        method: "POST",
+        headers: { "Content-Type": "application/json" },
+        body: JSON.stringify(request)
+      }
+    );
+    const data = await response.json();
+    if (!response.ok || data.error) {
+      throw new Error(data.error || "Failed to assign role");
+    }
+  }
+};
+
+// src/permissions/handler.ts
 var PermissionsClient = class {
   /**
    * Ory Keto RelationshipApi for managing subject-object relationships
@@ -90,6 +341,31 @@ var PermissionsClient = class {
    * @group Permissions
    */
   permissions;
+  /**
+   * Handler for managing roles and role-based permissions
+   *
+   * Provides methods for creating custom roles, assigning permissions,
+   * and managing role assignments. Works alongside the Keto-based
+   * permissions system to provide dynamic RBAC capabilities.
+   *
+   * @example
+   * ```typescript
+   * // Create a custom role
+   * const role = await omnibase.permissions.roles.create({
+   *   role_name: 'billing_manager',
+   *   permissions: ['tenant#manage_billing', 'tenant#view_invoices']
+   * });
+   *
+   * // Assign role to user
+   * await omnibase.permissions.roles.assign('user_123', {
+   *   role_id: role.id
+   * });
+   * ```
+   *
+   * @since 0.7.0
+   * @group Roles
+   */
+  roles;
   /**
    * Creates a new PermissionsClient instance
    *
@@ -98,24 +374,19 @@ var PermissionsClient = class {
    * for optimal performance and security separation.
    *
    * @param apiBaseUrl - The base URL for your Omnibase API instance
+   * @param client - The main OmnibaseClient instance (for roles handler)
    *
    * @throws {Error} When the base URL is invalid or cannot be reached
    *
    * @example
    * ```typescript
-   * const client = new PermissionsClient('https://api.example.com');
-   * ```
-   *
-   * @example
-   * Local development:
-   * ```typescript
-   * const client = new PermissionsClient('http://localhost:8080');
+   * const client = new PermissionsClient('https://api.example.com', omnibaseClient);
    * ```
    *
    * @since 1.0.0
    * @group Client
    */
-  constructor(apiBaseUrl) {
+  constructor(apiBaseUrl, client) {
     this.relationships = new import_client.RelationshipApi(
       void 0,
       `${apiBaseUrl}/api/v1/permissions/write`
@@ -124,9 +395,11 @@ var PermissionsClient = class {
       void 0,
       `${apiBaseUrl}/api/v1/permissions/read`
     );
+    this.roles = new RolesHandler(client);
   }
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  PermissionsClient
+  PermissionsClient,
+  RolesHandler
 });

package/dist/permissions/index.d.cts

@@ -1,195 +1,2 @@
-import { RelationshipApi, PermissionApi } from '@ory/client';
-
-/**
- * Client for managing permissions and relationships using Ory Keto
- *
- * This client provides access to Ory Keto's permission system, allowing you to
- * create, manage, and check relationships between subjects and objects. It handles
- * both read operations (permission checks) and write operations (relationship management).
- *
- * The client automatically configures separate endpoints for read and write operations
- * to optimize performance and security by following Ory Keto's recommended architecture.
- *
- * @example
- * Basic permission checking:
- * ```typescript
- * import { PermissionsClient } from '@omnibase/core-js/permissions';
- *
- * const permissionsClient = new PermissionsClient('https://api.example.com');
- *
- * // Check if a user can view a tenant
- * const canView = await permissionsClient.permissions.checkPermission(
- *   undefined,
- *   {
- *     namespace: 'Tenant',
- *     object: 'tenant_123',
- *     relation: 'view',
- *     subjectId: 'user_456'
- *   }
- * );
- *
- * if (canView.data.allowed) {
- *   console.log('User can view the tenant');
- * }
- * ```
- *
- * @example
- * Creating tenant relationships:
- * ```typescript
- * // Create a relationship making a user an owner of a tenant
- * await permissionsClient.relationships.createRelationship(
- *   undefined,
- *   {
- *     namespace: 'Tenant',
- *     object: 'tenant_123',
- *     relation: 'owners',
- *     subjectId: 'user_456'
- *   }
- * );
- *
- * // Now the user has owner permissions on the tenant
- * console.log('User is now an owner of the tenant');
- * ```
- *
- * @example
- * Complex tenant permission management:
- * ```typescript
- * const tenantId = 'tenant_123';
- * const userId = 'user_456';
- *
- * // Grant admin permissions to a user
- * await permissionsClient.relationships.createRelationship(
- *   undefined,
- *   {
- *     namespace: 'Tenant',
- *     object: tenantId,
- *     relation: 'admins',
- *     subjectId: userId
- *   }
- * );
- *
- * // Check if user can manage members (admins and owners can)
- * const canManageMembers = await permissionsClient.permissions.checkPermission(
- *   undefined,
- *   {
- *     namespace: 'Tenant',
- *     object: tenantId,
- *     relation: 'manage_members',
- *     subjectId: userId
- *   }
- * );
- *
- * if (canManageMembers.data.allowed) {
- *   // User can invite/remove members
- *   console.log('User can manage tenant members');
- * }
- *
- * // Later, remove admin permissions
- * await permissionsClient.relationships.deleteRelationships(
- *   undefined,
- *   {
- *     namespace: 'Tenant',
- *     object: tenantId,
- *     relation: 'admins',
- *     subjectId: userId
- *   }
- * );
- * ```
- *
- * @since 1.0.0
- * @public
- * @group Client
- */
-declare class PermissionsClient {
-    /**
-     * Ory Keto RelationshipApi for managing subject-object relationships
-     *
-     * Provides methods for creating, updating, and deleting relationships between
-     * subjects (users, groups) and objects (tenants, resources). This API handles
-     * write operations and is used to establish permission structures.
-     *
-     * Key methods:
-     * - `createRelationship()` - Creates a new relationship tuple
-     * - `deleteRelationships()` - Removes existing relationship tuples
-     * - `getRelationships()` - Queries existing relationships
-     * - `patchRelationships()` - Updates multiple relationships atomically
-     *
-     * @example
-     * ```typescript
-     * // Create a relationship
-     * await client.relationships.createRelationship(
-     *   undefined,
-     *   {
-     *     namespace: 'Tenant',
-     *     object: 'tenant_123',
-     *     relation: 'members',
-     *     subjectId: 'user_456'
-     *   }
-     * );
-     * ```
-     *
-     * @since 1.0.0
-     * @group Relationships
-     */
-    relationships: RelationshipApi;
-    /**
-     * Ory Keto PermissionApi for checking permissions
-     *
-     * Provides methods for querying whether a subject has a specific permission
-     * on an object. This API handles read operations and is optimized for fast
-     * permission checks in your application logic.
-     *
-     * Key methods:
-     * - `checkPermission()` - Checks if a subject has permission on an object
-     * - `checkPermissionOrError()` - Same as above but throws error if denied
-     * - `expandPermissions()` - Expands relationships to show all granted permissions
-     *
-     * @example
-     * ```typescript
-     * // Check permission
-     * const result = await client.permissions.checkPermission(
-     *   undefined,
-     *   {
-     *     namespace: 'Tenant',
-     *     object: 'tenant_123',
-     *     relation: 'view',
-     *     subjectId: 'user_456'
-     *   }
-     * );
-     *
-     * console.log('Has permission:', result.data.allowed);
-     * ```
-     *
-     * @since 1.0.0
-     * @group Permissions
-     */
-    permissions: PermissionApi;
-    /**
-     * Creates a new PermissionsClient instance
-     *
-     * Initializes the client with separate endpoints for read and write operations.
-     * The client automatically appends the appropriate Keto API paths to the base URL
-     * for optimal performance and security separation.
-     *
-     * @param apiBaseUrl - The base URL for your Omnibase API instance
-     *
-     * @throws {Error} When the base URL is invalid or cannot be reached
-     *
-     * @example
-     * ```typescript
-     * const client = new PermissionsClient('https://api.example.com');
-     * ```
-     *
-     * @example
-     * Local development:
-     * ```typescript
-     * const client = new PermissionsClient('http://localhost:8080');
-     * ```
-     *
-     * @since 1.0.0
-     * @group Client
-     */
-    constructor(apiBaseUrl: string);
-}
-
-export { PermissionsClient };
+export { A as AssignRoleRequest, C as CreateRoleRequest, N as NamespaceDefinition, P as PermissionsClient, a as Role, R as RolesHandler, U as UpdateRoleRequest } from '../payments/index.cjs';
+import '@ory/client';