@iblai/data-layer 1.10.0 → 1.11.0

package/dist/src/features/core/types.d.ts

@@ -71,3 +71,60 @@ export interface RbacActionDefinition {
     assignable_resources: string[];
 }
 export type RbacActionsDefinitionResponse = Record<string, RbacActionDefinition>;
+/** A child collection reachable from an entity node in the RBAC resource tree. */
+export interface RbacResourceDiscoveryCollection {
+    /** Collection identifier, e.g. "mentors", "documents". */
+    type: string;
+    /** Human-readable description shown as help text in pickers. */
+    help: string;
+    /** Discovery path to request next when drilling into this collection. */
+    path: string;
+    /**
+     * When true this collection is terminal: it can only be granted as a whole
+     * (no object-level grants), so there is nothing to search beneath it.
+     */
+    collection_only: boolean;
+}
+/** Discovery payload for an entity node: lists the child collections. */
+export interface RbacResourceDiscoveryEntityNode {
+    node_type: 'entity';
+    name: string | null;
+    /** The RBAC policy resource path built so far, e.g. "/mentors/6/". */
+    resource_path: string;
+    collections: RbacResourceDiscoveryCollection[];
+}
+/** Discovery payload for a collection node: how/where to search for entities. */
+export interface RbacResourceDiscoveryCollectionNode {
+    node_type: 'collection';
+    /** The RBAC policy resource path built so far, e.g. "/mentors/". */
+    resource_path: string;
+    /** Relative URL to list/search entities. Null for collection_only nodes. */
+    list_url: string | null;
+    /** Query params supported by list_url for filtering. */
+    search_qps: string[];
+    /** The primary search param a simple search box should map to. */
+    default_search_qp: string | null;
+    /**
+     * Which fields of each list result hold the primary key (appended to the
+     * resource path on selection) and the display name.
+     */
+    result_fields: {
+        pk: string;
+        name: string;
+    } | null;
+}
+export type RbacResourceDiscoveryResponse = RbacResourceDiscoveryEntityNode | RbacResourceDiscoveryCollectionNode;
+/** A normalized entity row returned when listing a discovery collection. */
+export interface RbacResourceListItem {
+    /** Value of the result_fields.pk field — appended to the resource path. */
+    pk: string | number;
+    /** Value of the result_fields.name field — shown to the user. */
+    name: string;
+    /** The untouched result object, for callers needing extra fields. */
+    raw: Record<string, unknown>;
+}
+export interface RbacResourceListResponse {
+    items: RbacResourceListItem[];
+    /** The raw list endpoint payload before normalization. */
+    raw: unknown;
+}