@ram_28/kf-ai-sdk 2.0.12 → 2.0.14

package/dist/workflow.types.d.ts

@@ -1,3 +1,2 @@
 export type { ActivityInstanceFieldsType, ActivityOperations, ActivityProgressType, WorkflowStartResponseType, } from './workflow/types';
-export type { UseActivityTableOptionsType, UseActivityTableReturnType, ActivityTableStatusType, ActivityRowType, } from './workflow/components/useActivityTable/types';
 //# sourceMappingURL=workflow.types.d.ts.map

package/dist/workflow.types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"workflow.types.d.ts","sourceRoot":"","sources":["../sdk/workflow.types.ts"],"names":[],"mappings":"AAKA,YAAY,EACV,0BAA0B,EAC1B,kBAAkB,EAClB,oBAAoB,EACpB,yBAAyB,GAC1B,MAAM,kBAAkB,CAAC;AAE1B,YAAY,EACV,2BAA2B,EAC3B,0BAA0B,EAC1B,uBAAuB,EACvB,eAAe,GAChB,MAAM,8CAA8C,CAAC"}
+{"version":3,"file":"workflow.types.d.ts","sourceRoot":"","sources":["../sdk/workflow.types.ts"],"names":[],"mappings":"AAKA,YAAY,EACV,0BAA0B,EAC1B,kBAAkB,EAClB,oBAAoB,EACpB,yBAAyB,GAC1B,MAAM,kBAAkB,CAAC"}

package/docs/api.md

@@ -1,303 +1,95 @@
 # API Types Reference
 
-Request and response types for all BDO methods, grouped by method.
+Request and response types for BDO methods. For usage patterns, see [bdo.md](bdo.md).
 
-For the BDO pattern, field classes, and `ItemType` accessor documentation, see [bdo.md](bdo.md).
-
----
-
-## Read Operations
-
-### get
-
-Fetches a single record by ID.
+## Imports
 
 ```typescript
-async get(id: string): Promise<ItemType<TEditable, TReadonly>>
+import { api } from "@ram_28/kf-ai-sdk/api";
+import type { ListOptionsType, CreateUpdateResponseType, DeleteResponseType, DraftResponseType, MetricOptionsType, MetricResponseType, PivotOptionsType, PivotResponseType } from "@ram_28/kf-ai-sdk/api/types";
 ```
 
-**Request:** `id: string`
-
-**Response:** [`ItemType<TEditable, TReadonly>`](bdo.md#itemtype--runtime-accessor-pattern) — Proxy-wrapped record with field accessors.
-
 ---
 
-### list
+## Common Mistakes (READ FIRST)
 
-Fetches paginated records with optional filtering, sorting, and pagination.
+### 1. Calling `api` directly instead of as factory
 
 ```typescript
-async list(options?: ListOptionsType): Promise<ItemType<TEditable, TReadonly>[]>
-```
-
-**Request:**
-
-```typescript
-interface ListOptionsType {
-  // Specific fields to return (omit for all fields)
-  Field?: string[];
-
-  // Filter criteria
-  Filter?: FilterType;
-
-  // Sort configuration: [{ "fieldName": "ASC" | "DESC" }]
-  Sort?: SortType;
-
-  // Page number (1-indexed, default: 1)
-  Page?: number;
+// ❌ WRONG — api is a function, not a client
+api.get(id);  api.delete(id);
 
-  // Records per page (default: 10)
-  PageSize?: number;
-}
+// ✅ CORRECT — call api(boId) first
+api(bdo.meta._id).get(id);
+api(bdo.meta._id).delete(id);
 ```
 
-**Response:** [`ItemType<TEditable, TReadonly>[]`](bdo.md#itemtype--runtime-accessor-pattern) — Array of Proxy-wrapped records.
-
-> **Search:** Use a `Filter` with the `Contains` operator on the desired field. See [useFilter docs](useFilter.md).
-
----
-
-### count
+### 2. Using `api()` when BDO methods are available
 
-Returns the count of records matching filter criteria.
+Prefer BDO methods when they're `public` on the role's class. Use `api()` only for `protected` methods.
 
 ```typescript
-async count(options?: ListOptionsType): Promise<number>
-```
-
-**Request:** `ListOptionsType` (same as [list](#list))
+// ✅ PREFERRED — BDO method
+const items = await bdo.list();
 
-**Response:** `number` — count returned directly (internally unwraps `{ Count: number }`).
-
----
-
-## Write Operations
-
-### create
-
-Creates a new record.
-
-```typescript
-async create(data: Partial<TEditable>): Promise<ItemType<TEditable, TReadonly>>
+// ✅ USE api() ONLY when BDO method is protected
+await api(bdo.meta._id).delete(id);
 ```
 
-**Request:** `Partial<TEditable>` — field values for the new record.
-
-**Response:** [`ItemType<TEditable, TReadonly>`](bdo.md#itemtype--runtime-accessor-pattern) — the created record with `_id` from the API and input data as field accessors.
-
----
+### 3. Wrong metric response key format
 
-### update
-
-Updates an existing record.
+Key pattern is `{lowercase_type}_{Field}` with single underscore.
 
 ```typescript
-async update(id: string, data: Partial<TEditable>): Promise<CreateUpdateResponseType>
-```
-
-**Request:** `id: string`, `data: Partial<TEditable>`
+// ❌ WRONG
+const count = result.Data[0].count;
 
-**Response:**
-
-```typescript
-interface CreateUpdateResponseType {
-  _id: string;
-}
+// ✅ CORRECT
+const count = result.Data?.[0]?.["count__id"] ?? 0;     // Count of _id
+const total = result.Data?.[0]?.["sum_unit_price"] ?? 0; // Sum of unit_price
 ```
 
 ---
 
-### delete
-
-Deletes a record by ID.
+## Response Types
 
 ```typescript
-async delete(id: string): Promise<DeleteResponseType>
-```
-
-**Request:** `id: string`
-
-**Response:**
-
-```typescript
-interface DeleteResponseType {
-  status: "success";
-}
-```
-
----
-
-## Draft Operations
+interface CreateUpdateResponseType { _id: string; }
+interface DeleteResponseType { status: "success"; }
+interface DraftResponseType { [fieldName: string]: any; }
 
-### draft
-
-Previews computed field values for a new record without saving.
-
-```typescript
-async draft(data: Partial<TEditable>): Promise<DraftResponseType>
-```
-
-**Request:** `Partial<TEditable>` — field values to compute against.
-
-**Response:**
-
-```typescript
-interface DraftResponseType {
-  // Keys are field names, values are server-computed results
-  [fieldName: string]: any;
+interface ListOptionsType {
+  Field?: string[];
+  Filter?: FilterType;
+  Sort?: Record<string, "ASC" | "DESC">[];
+  Page?: number;       // 1-indexed
+  PageSize?: number;   // Default: 10
 }
-```
-
----
-
-### draftPatch
-
-Previews computed field values for an existing record being edited.
 
-```typescript
-async draftPatch(id: string, data: Partial<TEditable>): Promise<DraftResponseType>
-```
-
-**Request:** `id: string`, `data: Partial<TEditable>`
-
-**Response:** `DraftResponseType` (same as [draft](#draft))
-
----
-
-### draftInteraction
-
-Creates/updates a draft without requiring an instance ID. Returns computed fields along with a temporary `_id`.
-
-```typescript
-async draftInteraction(data: Partial<TEditable>): Promise<DraftResponseType & { _id: string }>
-```
-
-**Request:** `Partial<TEditable>`
-
-**Response:** `DraftResponseType & { _id: string }` — computed fields plus a temporary draft ID.
-
----
-
-## Analytics Operations
-
-### metric
-
-Performs aggregation queries on records.
-
-```typescript
-async metric(options: Omit<MetricOptionsType, "Type">): Promise<MetricResponseType>
-```
-
-> `Type` is added internally — pass only `GroupBy`, `Metric`, and optional `Filter`.
-
-**Request:**
-
-```typescript
 interface MetricOptionsType {
-  Type: "Metric";    // added internally
-  GroupBy: string[]; // fields to group by (empty array for totals)
-  Metric: MetricFieldType[];
+  GroupBy: string[];
+  Metric: { Field: string; Type: AggregationType; }[];
   Filter?: FilterType;
 }
 
-interface MetricFieldType {
-  Field: string;
-  Type: AggregationType;
-}
-```
-
-**Response:**
-
-```typescript
-interface MetricResponseType {
-  // Keys follow pattern: {type}_{Field}
-  // e.g., "count__id", "sum_Stock", "avg_Price"
-  Data: Record<string, any>[];
-}
-```
+interface MetricResponseType { Data: Record<string, any>[]; }
 
-**Response key pattern:** `{lowercase_type}_{Field}` — e.g., `{ Field: "Stock", Type: "Sum" }` produces key `"sum_Stock"`.
-
----
-
-### pivot
-
-Creates pivot table aggregations with row and column dimensions.
-
-```typescript
-async pivot(options: Omit<PivotOptionsType, "Type">): Promise<PivotResponseType>
-```
-
-> `Type` is added internally — pass only `Row`, `Column`, `Metric`, and optional `Filter`.
-
-**Request:**
-
-```typescript
 interface PivotOptionsType {
-  Type: "Pivot";     // added internally
-  Row: string[];     // row dimension fields
-  Column: string[];  // column dimension fields
-  Metric: MetricFieldType[];
+  Row: string[];
+  Column: string[];
+  Metric: { Field: string; Type: AggregationType; }[];
   Filter?: FilterType;
 }
-```
-
-**Response:**
 
-```typescript
 interface PivotResponseType {
-  Data: {
-    RowHeader: PivotHeaderItemType[];
-    ColumnHeader: PivotHeaderItemType[];
-    Value: (number | string | null)[][]; // [row][column]
-  };
-}
-
-interface PivotHeaderItemType {
-  Key: string;
-  Children?: PivotHeaderItemType[];
+  Data: { RowHeader: { Key: string }[]; ColumnHeader: { Key: string }[]; Value: (number | string | null)[][]; };
 }
-```
-
----
 
-## Shared Types
+type AggregationType = "Sum" | "Avg" | "Count" | "Max" | "Min" | "DistinctCount" | "BlankCount" | "NotBlankCount" | "Concat" | "DistinctConcat";
 
-### FilterType
+// Filter type (for bdo.list() Filter parameter)
+interface FilterType { Operator: "And" | "Or" | "Not"; Condition: Array<ConditionType | ConditionGroupType>; }
+interface ConditionType { Operator: string; LHSField: string; RHSValue: any; RHSType?: "Constant" | "BDOField" | "AppVariable"; }
 
-```typescript
-type FilterType = ConditionGroupType;
-
-interface ConditionGroupType {
-  Operator: "And" | "Or" | "Not";
-  Condition: Array<ConditionType | ConditionGroupType>;
-}
-
-interface ConditionType {
-  Operator: ConditionOperatorType;
-  LHSField: string;
-  RHSValue: any;
-  RHSType?: "Constant" | "BDOField" | "AppVariable";
-}
-```
-
-**Condition Operators:** `EQ`, `NE`, `GT`, `GTE`, `LT`, `LTE`, `Between`, `NotBetween`, `IN`, `NIN`, `Empty`, `NotEmpty`, `Contains`, `NotContains`, `MinLength`, `MaxLength`
-
-For full filter documentation, see the [useFilter docs](useFilter.md).
-
-### SortType
-
-```typescript
 type SortType = Record<string, "ASC" | "DESC">[];
 ```
-
-Format: `[{ "fieldName": "ASC" }, { "anotherField": "DESC" }]`
-
-### AggregationType
-
-```typescript
-type AggregationType =
-  | "Sum" | "Avg" | "Count" | "Max" | "Min"
-  | "DistinctCount" | "BlankCount" | "NotBlankCount"
-  | "Concat" | "DistinctConcat";
-```