@halix/action-sdk 1.0.23 → 1.0.25

package/lib/cjs/types/data-crud.d.ts

@@ -8,154 +8,61 @@ export interface SaveOptions {
     bypassValidation?: boolean;
 }
 /**
- * getObject retrieves a single object from the database by its data element ID and key.
+ * Retrieves a single object by dataElementId and key. Optionally fetch related objects.
  *
- * @param dataElementId - The ID of the data element
- * @param key - The key of the object
- * @param fetchedRelationships - Optional array of relationships to fetch; if provided, the returned
- * object will include the specified related objects as nested objects
- * @returns Promise resolving to the object data
+ * @returns Promise<any> - the object data
  */
 export declare function getObject(dataElementId: string, key: string, fetchedRelationships?: string[]): Promise<any>;
 /**
- * getObjectAsObservable retrieves a single object from the database by its data element ID and key.
- *
- * @param dataElementId - The ID of the data element
- * @param key - The key of the object
- * @param fetchedRelationships - Optional array of relationships to fetch; if provided, the returned
- * object will include the specified related objects as nested objects
- *
- * @returns Observable resolving to the object data
+ * Observable version of getObject. See getObject for details.
  */
 export declare function getObjectAsObservable(dataElementId: string, key: string, fetchedRelationships?: string[]): Observable<any>;
 /**
- * getRelatedObjects retrieves an array of objects from the the database. The objects returned are
- * related to a parent through a defined relationship in the schema. In a typical setup, action's
- * auth token must have scope access to the parent object in order to access all of its related
- * objects.
- *
- * It is common to use getRelatedObjects to retrieve all objects belonging to the current user proxy
- * or organization proxy. For example, in a user context where the current user proxy element is
- * "customer," an action might want to retrieve all "purchase" objects related to the current
- * customer. Similarly, in an organization context where the current organization proxy is
- * "business," an action might want to retrieve all "employee" objects related to the current
- * business.
- *
- * @param parentElementId - The ID of the parent element
- * @param parentKey - The key of the parent object
- * @param elementId - The ID of the element
- * @param filter - Optional filter criteria for the query; if not provided, all related objects will
- * be returned
- * @param fetchedRelationships - Optional array of relationships to fetch; if provided, the returned
- * objects will include the specified related objects as nested objects
- *
- * @returns Promise resolving to an array of objects
- *
- * @see {@link FilterExpression} for filter syntax and examples
+ * Retrieves all objects related to a parent through a schema relationship. Commonly used to get objects belonging to current user/org proxy.
+ *
+ * @param parentElementId - Parent element ID
+ * @param parentKey - Parent object key
+ * @param elementId - Child element ID
+ * @param filter - Optional filter (see FilterExpression)
+ * @param fetchedRelationships - Optional relationships to include as nested objects
+ * @returns Promise<any[]>
  */
 export declare function getRelatedObjects(parentElementId: string, parentKey: string, elementId: string, filter?: FilterExpression, fetchedRelationships?: string[]): Promise<any[]>;
 /**
- * getRelatedObjectsAsObservable retrieves an array of objects from the the database. The objects
- * returned are related to a parent through a defined relationship in the schema. In a typical
- * setup, action's auth token must have scope access to the parent object in order to access all of
- * its related objects.
- *
- * It is common to use getRelatedObjects to retrieve all objects belonging to the current user proxy
- * or organization proxy. For example, in a user context where the current user proxy element is
- * "customer," an action might want to retrieve all "purchase" objects related to the current
- * customer. Similarly, in an organization context where the current organization proxy is
- * "business," an action might want to retrieve all "employee" objects related to the current
- * business.
- *
- * @param parentElementId - The ID of the parent element
- * @param parentKey - The key of the parent element
- * @param elementId - The ID of the element
- * @param filter - Optional filter criteria for the query; if not provided, all related objects will
- * be returned
- * @param fetchedRelationships - Optional array of relationships to fetch; if provided, the returned
- * objects will include the specified related objects as nested objects
- *
- * @returns Observable resolving to an array of objects
- *
- * @see {@link FilterExpression} for filter syntax and examples
+ * Observable version of getRelatedObjects. See getRelatedObjects for details.
  */
 export declare function getRelatedObjectsAsObservable(parentElementId: string, parentKey: string, elementId: string, filter?: FilterExpression, fetchedRelationships?: string[]): Observable<any[]>;
 /**
- * saveRelatedObject saves a related object to the database. The objectToSave is saved, and its
- * relationship to the parent object is established based on the relationship specified in the
- * schema. The objectToSave must have a relationship to the parent object and the user must have
- * scope access to the parent object.
+ * Saves a related object and establishes relationship to parent. Returns saved object with any server-assigned values (objKey, calculated fields).
  *
- * @param parentElementId - The ID of the parent element
- * @param parentKey - The key of the parent object
- * @param elementId - The element ID of the object to save
- * @param objectToSave - The object data to save (as a JSON string)
- * @param opts - Optional save options
- *
- * @returns Promise resolving to saved object, including any updates made to the object during the
- * save operation (such as assigning an objKey if the object is new), or the assignment of
- * calculated values
+ * @param objectToSave - JSON string of object data
+ * @param opts - Optional: bypassValidation
+ * @returns Promise<any> - saved object with updates
  */
 export declare function saveRelatedObject(parentElementId: string, parentKey: string, elementId: string, objectToSave: string, opts?: SaveOptions): Promise<any>;
 /**
- * saveRelatedObjectAsObservable saves a related object to the database. The objectToSave is saved,
- * and its relationship to the parent object is established based on the relationship specified in
- * the schema. The objectToSave must have a relationship to the parent object and the user must have
- * scope access to the parent object.
- *
- * @param parentElementId - The ID of the parent element
- * @param parentKey - The key of the parent object
- * @param elementId - The element ID of the object to save
- * @param objectToSave - The object data to save (as a JSON string)
- * @param opts - Optional save options
- *
- * @returns Observable resolving to saved object, including any updates made to the object during
- * the save operation (such as assigning an objKey if the object is new), or the assignment of
- * calculated values
+ * Observable version of saveRelatedObject. See saveRelatedObject for details.
  */
 export declare function saveRelatedObjectAsObservable(parentElementId: string, parentKey: string, elementId: string, objectToSave: string, opts?: SaveOptions): Observable<any>;
 /**
- * deleteRelatedObject deletes a single object related to a specific parent.
+ * Deletes a single object related to a parent.
  *
- * @param parentElementId - The ID of the parent element
- * @param parentKey - The key of the parent object
- * @param childElementId - The ID of the child element to delete
- * @param childKey - The key of the child object to delete
- *
- * @returns Promise resolving to true if deletion was successful
+ * @returns Promise<boolean> - true if successful
  */
 export declare function deleteRelatedObject(parentElementId: string, parentKey: string, childElementId: string, childKey: string): Promise<boolean>;
 /**
- * deleteRelatedObjectAsObservable deletes a single object related to a specific parent.
- *
- * @param parentElementId - The ID of the parent element
- * @param parentKey - The key of the parent object
- * @param childElementId - The ID of the child element to delete
- * @param childKey - The key of the child object to delete
- *
- * @returns Observable resolving to true if deletion was successful
+ * Observable version of deleteRelatedObject. See deleteRelatedObject for details.
  */
 export declare function deleteRelatedObjectAsObservable(parentElementId: string, parentKey: string, childElementId: string, childKey: string): Observable<boolean>;
 /**
- * deleteRelatedObjects deletes multiple objects related to a specific parent.
- *
- * @param parentElementId - The ID of the parent element
- * @param parentKey - The key of the parent object
- * @param childElementId - The ID of the child element to delete
- * @param childKeys - Array of keys of the child objects to delete
+ * Deletes multiple objects related to a parent.
  *
- * @returns Promise resolving to true if deletion was successful
+ * @param childKeys - Array of child object keys to delete
+ * @returns Promise<boolean> - true if successful
  */
 export declare function deleteRelatedObjects(parentElementId: string, parentKey: string, childElementId: string, childKeys: string[]): Promise<boolean>;
 /**
- * deleteRelatedObjectsAsObservable deletes multiple objects related to a specific parent.
- *
- * @param parentElementId - The ID of the parent element
- * @param parentKey - The key of the parent object
- * @param childElementId - The ID of the child element to delete
- * @param childKeys - Array of keys of the child objects to delete
- *
- * @returns Observable resolving to true if deletion was successful
+ * Observable version of deleteRelatedObjects. See deleteRelatedObjects for details.
  */
 export declare function deleteRelatedObjectsAsObservable(parentElementId: string, parentKey: string, childElementId: string, childKeys: string[]): Observable<boolean>;
 //# sourceMappingURL=data-crud.d.ts.map

package/lib/cjs/types/data-crud.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"data-crud.d.ts","sourceRoot":"","sources":["../../../src/data-crud.ts"],"names":[],"mappings":"AAuBA,OAAO,EAAQ,UAAU,EAAiB,MAAM,MAAM,CAAC;AAEvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAMxD;;GAEG;AACH,MAAM,WAAW,WAAW;IACxB,mCAAmC;IACnC,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAMD;;;;;;;;GAQG;AACH,wBAAsB,SAAS,CAAC,aAAa,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,oBAAoB,CAAC,EAAE,MAAM,EAAE,gBAwBlG;AAED;;;;;;;;;GASG;AACH,wBAAgB,qBAAqB,CAAC,aAAa,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,oBAAoB,CAAC,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,CAAC,CAE1H;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAsB,iBAAiB,CAAC,eAAe,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,gBAAgB,EAAE,oBAAoB,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,CA2BjL;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,6BAA6B,CAAC,eAAe,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,gBAAgB,EAAE,oBAAoB,CAAC,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,CAE1L;AAMD;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,iBAAiB,CAAC,eAAe,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,CAmB7J;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,6BAA6B,CAAC,eAAe,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,WAAW,GAAG,UAAU,CAAC,GAAG,CAAC,CAEtK;AAMD;;;;;;;;;GASG;AACH,wBAAsB,mBAAmB,CAAC,eAAe,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAgBhJ;AAED;;;;;;;;;GASG;AACH,wBAAgB,+BAA+B,CAAC,eAAe,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,CAEzJ;AAED;;;;;;;;;GASG;AACH,wBAAsB,oBAAoB,CAAC,eAAe,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAiBpJ;AAED;;;;;;;;;GASG;AACH,wBAAgB,gCAAgC,CAAC,eAAe,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,OAAO,CAAC,CAE7J"}
+{"version":3,"file":"data-crud.d.ts","sourceRoot":"","sources":["../../../src/data-crud.ts"],"names":[],"mappings":"AAuBA,OAAO,EAAQ,UAAU,EAAiB,MAAM,MAAM,CAAC;AAEvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAMxD;;GAEG;AACH,MAAM,WAAW,WAAW;IACxB,mCAAmC;IACnC,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAMD;;;;GAIG;AACH,wBAAsB,SAAS,CAAC,aAAa,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,oBAAoB,CAAC,EAAE,MAAM,EAAE,gBA6BlG;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,aAAa,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,oBAAoB,CAAC,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,CAAC,CAE1H;AAED;;;;;;;;;GASG;AACH,wBAAsB,iBAAiB,CAAC,eAAe,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,gBAAgB,EAAE,oBAAoB,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,CAgCjL;AAED;;GAEG;AACH,wBAAgB,6BAA6B,CAAC,eAAe,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,gBAAgB,EAAE,oBAAoB,CAAC,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,CAE1L;AAMD;;;;;;GAMG;AACH,wBAAsB,iBAAiB,CAAC,eAAe,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,CAwB7J;AAED;;GAEG;AACH,wBAAgB,6BAA6B,CAAC,eAAe,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,WAAW,GAAG,UAAU,CAAC,GAAG,CAAC,CAEtK;AAMD;;;;GAIG;AACH,wBAAsB,mBAAmB,CAAC,eAAe,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAsBhJ;AAED;;GAEG;AACH,wBAAgB,+BAA+B,CAAC,eAAe,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,CAEzJ;AAED;;;;;GAKG;AACH,wBAAsB,oBAAoB,CAAC,eAAe,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAuBpJ;AAED;;GAEG;AACH,wBAAgB,gCAAgC,CAAC,eAAe,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,OAAO,CAAC,CAE7J"}

package/lib/cjs/types/filter-expressions.d.ts

@@ -5,23 +5,15 @@
  */
 /**
  * FilterExpression represents a filter expression string in the Halix dataexpr format.
+ * Used to filter data based on logical comparisons and boolean conditions.
  *
- * Filter expressions are used to filter data based on logical comparisons and boolean conditions.
- * They support a wide range of operators, boolean logic, arrays, and special variables.
- *
- * ## Expression Structure
- *
- * An expression consists of:
- * - One or more comparisons
- * - Optionally combined using boolean operators (`AND`, `OR`)
- * - Grouped using parentheses `(...)` for logical grouping and precedence
- *
- * ### Basic Forms
+ * ## Basic Forms
  * ```
  * <left> <operator> <right>
  * (<expression1>) AND (<expression2>)
  * (<expression1>) OR (<expression2>)
  * ```
+ * Combine comparisons with AND/OR. Each operand must be in parentheses.
  *
  * ## Supported Operators
  *
@@ -43,111 +35,47 @@
  * | `!<empty> $void` | Value is not empty | `notes !<empty> $void` |
  *
  * ## Value Types
- *
- * Values in expressions can be:
- * - **String literals**: Must be wrapped in single quotes - `'value'`
- * - **Attribute references**: Must not be quoted - `status`, `score`
- * - **Arrays**: Literal arrays - `['A', 'B', 'C']`
- * - **Variables**: Special variables - `$today`, `$daysAgo:5`
- * - **Page/group variables**: Must be quoted - `'@{page.fieldName}'`, `'@{group.fieldName}'`
- *
- * ## Boolean Logic
- *
- * Combine comparisons using:
- * - `AND` – all subexpressions must be true
- * - `OR` – at least one subexpression must be true
- *
- * **Important**: Each operand of `AND`/`OR` must be enclosed in parentheses.
- *
- * ### Examples
- * ```
- * (status = 'active') AND (priority = 'high')
- * (status = 'active') AND ((priority = 'high') OR (escalated = 'true'))
- * ```
- *
- * ## Expression Variables
- *
- * Use special `$variables` for dynamic time-based filtering:
- *
- * | Variable | Meaning |
- * |----------|---------|
- * | `$today` | Current date (e.g. `2023-06-25`) |
- * | `$todayTimestamp` | Timestamp for midnight today |
- * | `$todayUnixTimestamp` | Unix timestamp (ms) for today |
- * | `$startOfMonth` | First day of the current month |
- * | `$endOfMonth` | Last day of the current month |
- * | `$yearsAgo:N` | Timestamp N years ago |
- * | `$monthsAgo:N` | Timestamp N months ago |
- * | `$weeksAgo:N` | Timestamp N weeks ago |
- * | `$daysAgo:N` | Timestamp N days ago |
- * | `$hoursAgo:N` | Timestamp N hours ago |
- * | `$minutesAgo:N` | Timestamp N minutes ago |
- * | `$secondsAgo:N` | Timestamp N seconds ago |
- * | `$yearsAhead:N` | Timestamp N years in the future |
- * | `$monthsAhead:N` | Timestamp N months in the future |
- * | `$weeksAhead:N` | Timestamp N weeks in the future |
- * | `$daysAhead:N` | Timestamp N days in the future |
- * | `$hoursAhead:N` | Timestamp N hours in the future |
- * | `$minutesAhead:N` | Timestamp N minutes in the future |
- * | `$secondsAhead:N` | Timestamp N seconds in the future |
- *
- * ## Common Examples
- *
- * ### Simple Comparison
+ * - **String literals**: `'value'` (single quotes required)
+ * - **Attribute references**: `status`, `score` (no quotes)
+ * - **Arrays**: `['A', 'B', 'C']`
+ * - **Variables**: `$today`, `$daysAgo:5`
+ * - **Page/group variables**: `'@{page.fieldName}'` (quoted)
+ *
+ * ## Time Variables
+ * - `$today`, `$todayTimestamp`, `$todayUnixTimestamp`
+ * - `$startOfMonth`, `$endOfMonth`
+ * - `$yearsAgo:N`, `$monthsAgo:N`, `$weeksAgo:N`, `$daysAgo:N`, `$hoursAgo:N`, `$minutesAgo:N`, `$secondsAgo:N`
+ * - `$yearsAhead:N`, `$monthsAhead:N`, `$weeksAhead:N`, `$daysAhead:N`, `$hoursAhead:N`, `$minutesAhead:N`, `$secondsAhead:N`
+ *
+ * ## Examples
  * ```typescript
- * const filter = "status = 'active'";
- * ```
+ * // Simple comparison
+ * "status = 'active'"
  *
- * ### Case-Insensitive Match
- * ```typescript
- * const filter = "role ~ 'ADMIN'";
- * ```
+ * // Case-insensitive
+ * "role ~ 'ADMIN'"
  *
- * ### Contains Check
- * ```typescript
- * const filter = "notes <> 'important'";
- * ```
+ * // Contains
+ * "notes <> 'important'"
  *
- * ### Array Contains
- * ```typescript
- * const filter = "['pending', 'active', 'review'] <> status";
- * ```
- *
- * ### Empty/Not Empty
- * ```typescript
- * const filter = "notes !<empty> $void";  // Has notes
- * ```
- *
- * ### Compound Expression
- * ```typescript
- * const filter = "(status = 'active') AND (priority = 'high')";
- * ```
+ * // Array contains
+ * "['pending', 'active'] <> status"
  *
- * ### Nested Logic
- * ```typescript
- * const filter = "(status = 'active') AND ((score > '90') OR (grade = 'A'))";
- * ```
+ * // Not empty
+ * "notes !<empty> $void"
  *
- * ### Time-Based Filtering
- * ```typescript
- * const filter = "createdAt > $daysAgo:30";  // Created in last 30 days
- * ```
+ * // Compound with AND/OR
+ * "(status = 'active') AND (priority = 'high')"
+ * "(status = 'active') AND ((score > '90') OR (grade = 'A'))"
  *
- * ### Boolean Values
- * ```typescript
- * const filter = "enabled = boolean:true";
- * ```
+ * // Time-based
+ * "createdAt > $daysAgo:30"
  *
- * ### Using Page Variables
- * ```typescript
- * const filter = "category = '@{page.selectedCategory.value}'";
- * ```
+ * // Boolean
+ * "enabled = boolean:true"
  *
- * ### Complex Multi-Condition Filter
- * ```typescript
- * const filter = "(status = 'active') AND " +
- *                "((priority = 'high') OR (dueDate < $today)) AND " +
- *                "(assignedTo !<empty> $void)";
+ * // Page variables
+ * "category = '@{page.selectedCategory.value}'"
  * ```
  */
 export type FilterExpression = string;

package/lib/cjs/types/filter-expressions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"filter-expressions.d.ts","sourceRoot":"","sources":["../../../src/filter-expressions.ts"],"names":[],"mappings":"AASA;;;;GAIG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkJG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC"}
+{"version":3,"file":"filter-expressions.d.ts","sourceRoot":"","sources":["../../../src/filter-expressions.ts"],"names":[],"mappings":"AASA;;;;GAIG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0EG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC"}

package/lib/cjs/types/index.d.ts

@@ -7,6 +7,7 @@ export { getAuthToken, sandboxKey, serviceAddress, actionSubject, userContext, p
 export { type SaveOptions, getObject, getObjectAsObservable, getRelatedObjects, getRelatedObjectsAsObservable, saveRelatedObject, saveRelatedObjectAsObservable, deleteRelatedObject, deleteRelatedObjectAsObservable, deleteRelatedObjects, deleteRelatedObjectsAsObservable } from './data-crud';
 export { type ContentResource, getOrCreateResource, getOrCreateResourceAsObservable, saveResource, saveResourceAsObservable, sendFileContents, sendFileContentsAsObservable, createOrUpdateResource, createOrUpdateResourceAsObservable } from './content';
 export { MessageMethod, type MessageRequest, sendMessage, sendMessageAsObservable } from './messaging';
+export { getPreference, getPreferenceAsObservable } from './preferences';
 export { type FilterExpression } from './filter-expressions';
 export { type SortField, type DataSortField, type BaseListDataRequest, type PagedListDataRequest, type ListDataResponse, type ListDataOptions, type ListDataSearchOptions, type MassEditValueType, type MassEditRequest, type MassDeleteRequest, type MassChangeResponse, getListData, getListDataAsObservable, massEdit, massEditAsObservable, massDelete, massDeleteAsObservable } from './lists';
 export { sortObjectArray, compareValues, getValueFromObject, debounceFn } from './utilities';

package/lib/cjs/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AASA;;;;GAIG;AAMH,OAAO,EAEH,YAAY,EACZ,UAAU,EACV,cAAc,EACd,aAAa,EACb,WAAW,EACX,MAAM,EACN,OAAO,EAGP,UAAU,EAGV,KAAK,WAAW,EAChB,KAAK,iBAAiB,EAGtB,KAAK,kBAAkB,EACvB,KAAK,cAAc,EACnB,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,0BAA0B,EAC/B,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,6BAA6B,EAClC,KAAK,yBAAyB,EAC9B,KAAK,aAAa,EAGlB,sBAAsB,EACtB,oBAAoB,EACvB,MAAM,eAAe,CAAC;AAMvB,OAAO,EAEH,KAAK,WAAW,EAGhB,SAAS,EACT,qBAAqB,EACrB,iBAAiB,EACjB,6BAA6B,EAG7B,iBAAiB,EACjB,6BAA6B,EAG7B,mBAAmB,EACnB,+BAA+B,EAC/B,oBAAoB,EACpB,gCAAgC,EACnC,MAAM,aAAa,CAAC;AAMrB,OAAO,EAEH,KAAK,eAAe,EAGpB,mBAAmB,EACnB,+BAA+B,EAC/B,YAAY,EACZ,wBAAwB,EACxB,gBAAgB,EAChB,4BAA4B,EAC5B,sBAAsB,EACtB,kCAAkC,EACrC,MAAM,WAAW,CAAC;AAMnB,OAAO,EAEH,aAAa,EAGb,KAAK,cAAc,EAGnB,WAAW,EACX,uBAAuB,EAC1B,MAAM,aAAa,CAAC;AAMrB,OAAO,EACH,KAAK,gBAAgB,EACxB,MAAM,sBAAsB,CAAC;AAM9B,OAAO,EAEH,KAAK,SAAS,EACd,KAAK,aAAa,EAClB,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,EACzB,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,qBAAqB,EAC1B,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EAGvB,WAAW,EACX,uBAAuB,EACvB,QAAQ,EACR,oBAAoB,EACpB,UAAU,EACV,sBAAsB,EACzB,MAAM,SAAS,CAAC;AAMjB,OAAO,EACH,eAAe,EACf,aAAa,EACb,kBAAkB,EAClB,UAAU,EACb,MAAM,aAAa,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AASA;;;;GAIG;AAMH,OAAO,EAEH,YAAY,EACZ,UAAU,EACV,cAAc,EACd,aAAa,EACb,WAAW,EACX,MAAM,EACN,OAAO,EAGP,UAAU,EAGV,KAAK,WAAW,EAChB,KAAK,iBAAiB,EAGtB,KAAK,kBAAkB,EACvB,KAAK,cAAc,EACnB,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,0BAA0B,EAC/B,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,6BAA6B,EAClC,KAAK,yBAAyB,EAC9B,KAAK,aAAa,EAGlB,sBAAsB,EACtB,oBAAoB,EACvB,MAAM,eAAe,CAAC;AAMvB,OAAO,EAEH,KAAK,WAAW,EAGhB,SAAS,EACT,qBAAqB,EACrB,iBAAiB,EACjB,6BAA6B,EAG7B,iBAAiB,EACjB,6BAA6B,EAG7B,mBAAmB,EACnB,+BAA+B,EAC/B,oBAAoB,EACpB,gCAAgC,EACnC,MAAM,aAAa,CAAC;AAMrB,OAAO,EAEH,KAAK,eAAe,EAGpB,mBAAmB,EACnB,+BAA+B,EAC/B,YAAY,EACZ,wBAAwB,EACxB,gBAAgB,EAChB,4BAA4B,EAC5B,sBAAsB,EACtB,kCAAkC,EACrC,MAAM,WAAW,CAAC;AAMnB,OAAO,EAEH,aAAa,EAGb,KAAK,cAAc,EAGnB,WAAW,EACX,uBAAuB,EAC1B,MAAM,aAAa,CAAC;AAMrB,OAAO,EAEH,aAAa,EACb,yBAAyB,EAC5B,MAAM,eAAe,CAAC;AAMvB,OAAO,EACH,KAAK,gBAAgB,EACxB,MAAM,sBAAsB,CAAC;AAM9B,OAAO,EAEH,KAAK,SAAS,EACd,KAAK,aAAa,EAClB,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,EACzB,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,qBAAqB,EAC1B,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EAGvB,WAAW,EACX,uBAAuB,EACvB,QAAQ,EACR,oBAAoB,EACpB,UAAU,EACV,sBAAsB,EACzB,MAAM,SAAS,CAAC;AAMjB,OAAO,EACH,eAAe,EACf,aAAa,EACb,kBAAkB,EAClB,UAAU,EACb,MAAM,aAAa,CAAC"}

package/lib/cjs/types/lists.d.ts

@@ -60,7 +60,7 @@ export interface BaseListDataRequest {
     childKeysField?: string;
     /**
      * Filter expression to limit results. Evaluated within the parent key scope.
-     * @see {@link FilterExpression} for filter syntax and examples
+     * @see the filter-expressions module for filter syntax and examples
      */
     filter?: FilterExpression;
     /**
@@ -201,24 +201,13 @@ export interface MassChangeResponse {
     failed: number;
 }
 /**
- * getListData retrieves list data from the Halix platform. This function can operate in four
- * different modes based on the provided options:
+ * Retrieves paginated list data. Supports authenticated/public access, filtering, sorting, and binary search.
  *
- * 1. Authenticated list data retrieval (default)
- * 2. Public list data retrieval (when isPublic is true)
- * 3. Authenticated list data with search (when search options are provided)
- * 4. Public list data with search (when both isPublic and search options are provided)
- *
- * The search functionality uses binary search to efficiently locate items in a sorted list by
- * a specific attribute value.
- *
- * @param request - The list data request containing list configuration and parameters
- * @param options - Optional configuration for the request
- *
- * @returns Promise resolving to the list data response
+ * @param request - List configuration including dataElementId, parentDataElementId, parentKey, pagination, sort, filter
+ * @param options - Optional: isPublic, bypassTotal, search
+ * @returns Promise<ListDataResponse> with data array, total count, pageNumber
  *
  * @example
- * // Basic authenticated list data retrieval
  * const listData = await getListData({
  *   dataElementId: 'customer',
  *   parentDataElementId: 'company',
@@ -227,199 +216,55 @@ export interface MassChangeResponse {
  *   pageSize: 50,
  *   displayFields: ['firstName', 'lastName', 'email']
  * });
- * console.log('Total customers:', listData.total);
- * console.log('Page:', listData.pageNumber);
- * console.log('Data:', listData.data);
- *
- * @example
- * // Public list data retrieval without authentication
- * const publicData = await getListData({
- *   dataElementId: 'product',
- *   parentDataElementId: 'catalog',
- *   parentKey: orgProxyKey,
- *   pageNumber: 1,
- *   pageSize: 20
- * }, { isPublic: true });
- *
- * @example
- * // List data retrieval with binary search
- * const searchData = await getListData({
- *   dataElementId: 'purchases',
- *   parentDataElementId: 'customer',
- *   parentKey: userProxyKey,
- *   sort: [{ attributeId: 'invoiceNumber', descending: false }]
- * }, {
- *   search: {
- *     attributeId: 'invoiceNumber',
- *     value: 'INV-123456',
- *     total: 1000
- *   }
- * });
- * console.log('Selected row index:', searchData.selectedRow);
  */
 export declare function getListData(request: PagedListDataRequest, options?: ListDataOptions): Promise<ListDataResponse>;
 /**
- * getListDataAsObservable retrieves list data from the Halix platform as an Observable. This
- * function operates in the same four modes as getListData.
- *
- * @param request - The list data request containing list configuration and parameters
- * @param options - Optional configuration for the request
- *
- * @returns Observable resolving to the list data response
+ * Observable version of getListData. See getListData for details.
  *
  * @example
- * // Basic authenticated list data retrieval as Observable
- * getListDataAsObservable({
- *   dataElementId: 'customer',
- *   parentDataElementId: 'company',
- *   parentKey: userContext.orgProxyKey,
- *   pageNumber: 1,
- *   pageSize: 50
- * }).subscribe(response => {
- *   console.log('Total customers:', response.total);
- *   console.log('Page:', response.pageNumber);
- *   console.log('Data:', response.data);
- * });
+ * getListDataAsObservable({ dataElementId: 'customer', parentDataElementId: 'company', parentKey: orgProxyKey })
+ *   .subscribe(response => console.log(response.data));
  */
 export declare function getListDataAsObservable(request: PagedListDataRequest, options?: ListDataOptions): Observable<ListDataResponse>;
 /**
- * massEdit performs a bulk update operation on multiple records. This function allows you to
- * update a specific property on multiple objects in a single request.
- *
- * **Security Scoping**: The dataRequest serves as a security boundary. Only records that would
- * be returned by the dataRequest can be updated. The keys array must reference records within
- * this scope. This allows efficient security validation without checking each record individually.
- *
- * The value can be set in two ways based on valueType:
- * - 'literal': Set the property to a literal value
- * - 'property': Copy the value from another property on the same object
- *
- * @param request - The mass edit request specifying what to update and how
+ * Bulk update multiple records. The dataRequest defines security scope; only records within that scope can be updated.
+ * Use valueType 'literal' to set a value, or 'property' to copy from another field.
  *
- * @returns Promise resolving to statistics about the operation
+ * @param request - keys[], dataRequest (scope), dataElementId, property, valueType, value
+ * @returns Promise<MassChangeResponse> with tried/succeeded/failed counts
  *
  * @example
- * // Update the status of multiple orders to 'shipped'
  * const result = await massEdit({
- *   keys: ['order-123', 'order-456', 'order-789'],
- *   dataRequest: {
- *     dataElementId: 'order',
- *     parentDataElementId: 'company',
- *     parentKey: orgProxyKey
- *   },
+ *   keys: ['order-123', 'order-456'],
+ *   dataRequest: { dataElementId: 'order', parentDataElementId: 'company', parentKey: orgProxyKey },
  *   dataElementId: 'order',
  *   property: 'status',
  *   valueType: 'literal',
  *   value: 'shipped'
  * });
- * console.log(`Updated ${result.succeeded} of ${result.tried} orders`);
- *
- * @example
- * // Copy shipping address to billing address for multiple customers
- * const result = await massEdit({
- *   keys: selectedCustomerKeys,
- *   dataRequest: {
- *     dataElementId: 'customer',
- *     parentDataElementId: 'company',
- *     parentKey: orgProxyKey
- *   },
- *   dataElementId: 'customer',
- *   property: 'billingAddress',
- *   valueType: 'property',
- *   value: 'shippingAddress'
- * });
  */
 export declare function massEdit(request: MassEditRequest): Promise<MassChangeResponse>;
 /**
- * massEditAsObservable performs a bulk update operation on multiple records, returning an Observable.
- * See massEdit for detailed documentation.
- *
- * @param request - The mass edit request specifying what to update and how
- *
- * @returns Observable resolving to statistics about the operation
- *
- * @example
- * massEditAsObservable({
- *   keys: ['order-123', 'order-456'],
- *   dataRequest: {
- *     dataElementId: 'order',
- *     parentDataElementId: 'company',
- *     parentKey: orgProxyKey
- *   },
- *   dataElementId: 'order',
- *   property: 'status',
- *   valueType: 'literal',
- *   value: 'shipped'
- * }).subscribe(result => {
- *   console.log(`Updated ${result.succeeded} of ${result.tried} orders`);
- * });
+ * Observable version of massEdit. See massEdit for details.
  */
 export declare function massEditAsObservable(request: MassEditRequest): Observable<MassChangeResponse>;
 /**
- * massDelete performs a bulk delete operation on multiple records. This function allows you to
- * soft-delete multiple objects in a single request.
- *
- * **Security Scoping**: The dataRequest serves as a security boundary. Only records that would
- * be returned by the dataRequest can be deleted. The keys array must reference records within
- * this scope. This allows efficient security validation without checking each record individually.
- *
- * If emptyList is set to true, all records returned by the dataRequest will be deleted,
- * ignoring the keys array.
- *
- * @param request - The mass delete request specifying what to delete
+ * Bulk soft-delete multiple records. The dataRequest defines security scope; only records within that scope can be deleted.
+ * Set emptyList: true to delete all records matching dataRequest (ignores keys array).
  *
- * @returns Promise resolving to statistics about the operation
+ * @param request - keys[], dataRequest (scope), dataElementId, emptyList?
+ * @returns Promise<MassChangeResponse> with tried/succeeded/failed counts
  *
  * @example
- * // Delete specific orders
  * const result = await massDelete({
- *   keys: ['order-123', 'order-456', 'order-789'],
- *   dataRequest: {
- *     dataElementId: 'order',
- *     parentDataElementId: 'company',
- *     parentKey: orgProxyKey,
- *     filter: { field: 'status', operator: '==', value: 'cancelled' }
- *   },
+ *   keys: ['order-123', 'order-456'],
+ *   dataRequest: { dataElementId: 'order', parentDataElementId: 'company', parentKey: orgProxyKey },
  *   dataElementId: 'order'
  * });
- * console.log(`Deleted ${result.succeeded} of ${result.tried} orders`);
- *
- * @example
- * // Delete all records matching the filter
- * const result = await massDelete({
- *   keys: [],
- *   dataRequest: {
- *     dataElementId: 'tempRecord',
- *     parentDataElementId: 'company',
- *     parentKey: orgProxyKey,
- *     filter: { field: 'createdDate', operator: '<', value: '2023-01-01' }
- *   },
- *   dataElementId: 'tempRecord',
- *   emptyList: true
- * });
- * console.log(`Deleted ${result.succeeded} old records`);
  */
 export declare function massDelete(request: MassDeleteRequest): Promise<MassChangeResponse>;
 /**
- * massDeleteAsObservable performs a bulk delete operation on multiple records, returning an Observable.
- * See massDelete for detailed documentation.
- *
- * @param request - The mass delete request specifying what to delete
- *
- * @returns Observable resolving to statistics about the operation
- *
- * @example
- * massDeleteAsObservable({
- *   keys: ['order-123', 'order-456'],
- *   dataRequest: {
- *     dataElementId: 'order',
- *     parentDataElementId: 'company',
- *     parentKey: orgProxyKey
- *   },
- *   dataElementId: 'order'
- * }).subscribe(result => {
- *   console.log(`Deleted ${result.succeeded} of ${result.tried} orders`);
- * });
+ * Observable version of massDelete. See massDelete for details.
  */
 export declare function massDeleteAsObservable(request: MassDeleteRequest): Observable<MassChangeResponse>;
 //# sourceMappingURL=lists.d.ts.map