@declarion/react 0.1.26 → 0.1.28

package/dist-lib/api/data.d.ts

@@ -6,11 +6,14 @@ export declare function createEntity(entity: string, data: Record<string, unknow
 export declare function updateEntity(entity: string, pkValues: PkValues | string, data: Record<string, unknown>): Promise<DataResponse>;
 export declare function deleteEntity(entity: string, pkValues: PkValues | string): Promise<void>;
 export declare function restoreEntity(entity: string, pkValues: PkValues | string): Promise<void>;
-export interface ActionExecuteRequest {
-    entity?: string;
-    ids?: string[];
-    args?: Record<string, unknown>;
-}
+/**
+ * Action request body is flat: top-level keys are handler params. The only
+ * reserved control key is `_ids` (array of object IDs for single/batch
+ * scope). The server resolves entity from the action's registration; the
+ * URL code is fully qualified ("entity.action" for entity-scoped,
+ * "action" for global).
+ */
+export type ActionExecuteRequest = Record<string, unknown>;
 export interface ActionExecuteResponse {
     status: string;
     result?: unknown;
@@ -19,6 +22,17 @@ export interface ActionExecuteResponse {
     /** IDs that succeeded (batch_mode: each responses). */
     success?: string[];
 }
+/**
+ * Build a flat action body from handler params + optional object IDs.
+ * Promotes `ids` to the reserved `_ids` key. Throws if a caller passes a
+ * param literally named `_ids` (collision with the reserved control key).
+ */
+export declare function buildActionBody(params: Record<string, unknown> | undefined, ids?: string[] | undefined): ActionExecuteRequest;
+/**
+ * Invoke an action. The URL `code` must be fully qualified for
+ * entity-scoped actions (e.g. `lead.archive`). For global actions it's the
+ * action code on its own (e.g. `auth.login`).
+ */
 export declare function executeAction(code: string, body: ActionExecuteRequest): Promise<ActionExecuteResponse>;
 export interface AssociationResponse {
     target_entity: string;