@halix/action-sdk 1.0.24 → 1.0.25

package/lib/esm/messaging.js.map

@@ -1 +1 @@
-{"version":3,"file":"messaging.js","sourceRoot":"","sources":["../../src/messaging.ts"],"names":[],"mappings":"AAAA,yBAAyB;AACzB,mCAAmC;AACnC,EAAE;AACF,oEAAoE;AACpE,0EAA0E;AAC1E,EAAE;AACF,6DAA6D;AAC7D,oDAAoD;AAEpD;;;;GAIG;AAEH,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,IAAI,EAAc,aAAa,EAAE,MAAM,MAAM,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAEzE,mFAAmF;AACnF,oBAAoB;AACpB,mFAAmF;AAEnF;;GAEG;AACH,MAAM,CAAN,IAAY,aAOX;AAPD,WAAY,aAAa;IACrB,oBAAoB;IACpB,gCAAe,CAAA;IACf,uBAAuB;IACvB,8BAAa,CAAA;IACb,kCAAkC;IAClC,4CAA2B,CAAA;AAC/B,CAAC,EAPW,aAAa,KAAb,aAAa,QAOxB;AAgED,mFAAmF;AACnF,sBAAsB;AACtB,mFAAmF;AAEnF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,iBAAyB,EAAE,WAAmB,EAAE,OAAuB;IAErG,8DAA8D;IAC9D,MAAM,aAAa,GAAyB;QACxC,eAAe,EAAE,OAAO,CAAC,aAAa,IAAI,OAAO,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;YACzE;gBACI,IAAI,EAAE,EAAE;gBACR,aAAa,EAAE,OAAO,CAAC,aAAa;aACvC;SACJ,CAAC,CAAC,CAAC,EAAE;QACN,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,aAAa,CAAC,KAAK;QACzD,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,YAAY,EAAE,OAAO,CAAC,YAAY;QAClC,YAAY,EAAE,OAAO,CAAC,YAAY;QAClC,gBAAgB,EAAE,OAAO,CAAC,oBAAoB;KACjD,CAAC;IAEF,IAAI,CAAC,YAAY,EAAE,CAAC;QAChB,MAAM,YAAY,GAAG,sBAAsB,CAAC;QAC5C,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;IAClC,CAAC;IAED,IAAI,GAAG,GAAG,GAAG,cAAc,2BAA2B,UAAU,gBAAgB,iBAAiB,IAAI,WAAW,EAAE,CAAC;IAEnH,IAAI,SAAS,GAAG,MAAM,aAAa,CAAC,YAAY,EAAE,CAAC,CAAC;IAEpD,OAAO,CAAC,GAAG,CAAC,0BAA0B,GAAG,GAAG,GAAG,cAAc,GAAG,SAAS,CAAC,CAAC;IAE3E,MAAM,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,aAAa,EAAE;QACjC,OAAO,EAAE,EAAE,eAAe,EAAE,UAAU,SAAS,EAAE,EAAE;KACtD,CAAC,CAAC;IAEH,uEAAuE;IACvE,wFAAwF;AAC5F,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,UAAU,uBAAuB,CAAC,iBAAyB,EAAE,WAAmB,EAAE,OAAuB;IAC3G,OAAO,IAAI,CAAC,WAAW,CAAC,iBAAiB,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC,CAAC;AACtE,CAAC"}
+{"version":3,"file":"messaging.js","sourceRoot":"","sources":["../../src/messaging.ts"],"names":[],"mappings":"AAAA,yBAAyB;AACzB,mCAAmC;AACnC,EAAE;AACF,oEAAoE;AACpE,0EAA0E;AAC1E,EAAE;AACF,6DAA6D;AAC7D,oDAAoD;AAEpD;;;;GAIG;AAEH,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,IAAI,EAAc,aAAa,EAAE,MAAM,MAAM,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAEzE,mFAAmF;AACnF,oBAAoB;AACpB,mFAAmF;AAEnF;;GAEG;AACH,MAAM,CAAN,IAAY,aAOX;AAPD,WAAY,aAAa;IACrB,oBAAoB;IACpB,gCAAe,CAAA;IACf,uBAAuB;IACvB,8BAAa,CAAA;IACb,kCAAkC;IAClC,4CAA2B,CAAA;AAC/B,CAAC,EAPW,aAAa,KAAb,aAAa,QAOxB;AAgED,mFAAmF;AACnF,sBAAsB;AACtB,mFAAmF;AAEnF;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,iBAAyB,EAAE,WAAmB,EAAE,OAAuB;IAErG,8DAA8D;IAC9D,MAAM,aAAa,GAAyB;QACxC,eAAe,EAAE,OAAO,CAAC,aAAa,IAAI,OAAO,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;YACzE;gBACI,IAAI,EAAE,EAAE;gBACR,aAAa,EAAE,OAAO,CAAC,aAAa;aACvC;SACJ,CAAC,CAAC,CAAC,EAAE;QACN,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,aAAa,CAAC,KAAK;QACzD,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,YAAY,EAAE,OAAO,CAAC,YAAY;QAClC,YAAY,EAAE,OAAO,CAAC,YAAY;QAClC,gBAAgB,EAAE,OAAO,CAAC,oBAAoB;KACjD,CAAC;IAEF,IAAI,CAAC,YAAY,EAAE,CAAC;QAChB,MAAM,YAAY,GAAG,sBAAsB,CAAC;QAC5C,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;IAClC,CAAC;IAED,IAAI,GAAG,GAAG,GAAG,cAAc,2BAA2B,UAAU,gBAAgB,iBAAiB,IAAI,WAAW,EAAE,CAAC;IAEnH,IAAI,SAAS,GAAG,MAAM,aAAa,CAAC,YAAY,EAAE,CAAC,CAAC;IAEpD,OAAO,CAAC,GAAG,CAAC,0BAA0B,GAAG,GAAG,GAAG,cAAc,GAAG,SAAS,CAAC,CAAC;IAE3E,MAAM,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,aAAa,EAAE;QACjC,OAAO,EAAE,EAAE,eAAe,EAAE,UAAU,SAAS,EAAE,EAAE;KACtD,CAAC,CAAC;IAEH,uEAAuE;IACvE,wFAAwF;AAC5F,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,uBAAuB,CAAC,iBAAyB,EAAE,WAAmB,EAAE,OAAuB;IAC3G,OAAO,IAAI,CAAC,WAAW,CAAC,iBAAiB,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC,CAAC;AACtE,CAAC"}

package/lib/esm/preferences.js

@@ -0,0 +1,57 @@
+// Halix SDK License v1.0
+// Copyright (c) 2025 halix.io LLC.
+//
+// This source code is licensed for use **only** within applications
+// running on the Halix platform, in accordance with Halix SDK guidelines.
+//
+// Unauthorized use outside the Halix platform is prohibited.
+// Full license terms available in the LICENSE file.
+/**
+ * @module @halix/action-sdk/preferences
+ * @description Preference management functions for the Halix Platform action SDK. This module
+ * provides functions for retrieving preference values.
+ */
+import axios from 'axios';
+import { from, lastValueFrom } from 'rxjs';
+import { serviceAddress, getAuthToken, userContext } from './sdk-general';
+// ================================================================================
+// PREFERENCE RETRIEVAL FUNCTIONS
+// ================================================================================
+/**
+ * Retrieves a preference value for the current user.
+ *
+ * @param prefID - The preference ID to retrieve
+ * @returns Promise<any> - the preference value
+ * @throws Error if SDK not initialized or user context not available
+ *
+ * @example
+ * const preferenceValue = await getPreference('myPreferenceId');
+ */
+export async function getPreference(prefID) {
+    if (!getAuthToken) {
+        const errorMessage = 'SDK not initialized.';
+        console.error(errorMessage);
+        throw new Error(errorMessage);
+    }
+    if (!userContext?.user?.objKey) {
+        const errorMessage = 'User context not available. Cannot retrieve preference value.';
+        console.error(errorMessage);
+        throw new Error(errorMessage);
+    }
+    const ownerElementID = 'user';
+    const ownerKey = userContext.user.objKey;
+    let url = `${serviceAddress}/sysapi/preference/${prefID}/${ownerElementID}/${ownerKey}`;
+    let authToken = await lastValueFrom(getAuthToken());
+    console.log("Sending GET request to " + url + " with token " + authToken);
+    let response = await axios.get(url, {
+        headers: { "Authorization": `Bearer ${authToken}` },
+    });
+    return response.data;
+}
+/**
+ * Observable version of getPreference. See getPreference for details.
+ */
+export function getPreferenceAsObservable(prefID) {
+    return from(getPreference(prefID));
+}
+//# sourceMappingURL=preferences.js.map

package/lib/esm/preferences.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"preferences.js","sourceRoot":"","sources":["../../src/preferences.ts"],"names":[],"mappings":"AAAA,yBAAyB;AACzB,mCAAmC;AACnC,EAAE;AACF,oEAAoE;AACpE,0EAA0E;AAC1E,EAAE;AACF,6DAA6D;AAC7D,oDAAoD;AAEpD;;;;GAIG;AAEH,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,IAAI,EAAc,aAAa,EAAE,MAAM,MAAM,CAAC;AACvD,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE1E,mFAAmF;AACnF,iCAAiC;AACjC,mFAAmF;AAEnF;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,MAAc;IAC9C,IAAI,CAAC,YAAY,EAAE,CAAC;QAChB,MAAM,YAAY,GAAG,sBAAsB,CAAC;QAC5C,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;IAClC,CAAC;IAED,IAAI,CAAC,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;QAC7B,MAAM,YAAY,GAAG,+DAA+D,CAAC;QACrF,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;IAClC,CAAC;IAED,MAAM,cAAc,GAAG,MAAM,CAAC;IAC9B,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC;IAEzC,IAAI,GAAG,GAAG,GAAG,cAAc,sBAAsB,MAAM,IAAI,cAAc,IAAI,QAAQ,EAAE,CAAC;IAExF,IAAI,SAAS,GAAG,MAAM,aAAa,CAAC,YAAY,EAAE,CAAC,CAAC;IAEpD,OAAO,CAAC,GAAG,CAAC,yBAAyB,GAAG,GAAG,GAAG,cAAc,GAAG,SAAS,CAAC,CAAC;IAE1E,IAAI,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE;QAChC,OAAO,EAAE,EAAE,eAAe,EAAE,UAAU,SAAS,EAAE,EAAE;KACtD,CAAC,CAAC;IAEH,OAAO,QAAQ,CAAC,IAAI,CAAC;AACzB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,yBAAyB,CAAC,MAAc;IACpD,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;AACvC,CAAC"}

package/lib/esm/sdk-general.js

@@ -24,59 +24,37 @@ import { of } from 'rxjs';
 // GLOBAL VARIABLES AND INITIALIZATION
 // ================================================================================
 /**
- * authToken contains the authentication token that the action handler can use to make API requests
- * to Halix web services. This value is set upon calling the initialize function with incoming event
- * data.
+ * Authentication token for API requests. Set by initialize().
  */
 export let getAuthToken;
 /**
- * sandboxKey contains the sandbox key identifier; identifies the sandbox that the action handler is
- * running in. The sandbox identifies the current solution. This value is set upon calling the
- * initialize function with incoming event data.
+ * Sandbox key identifier for the current solution. Set by initialize().
  */
 export let sandboxKey;
 /**
- * serviceAddress contains the URL of the Halix service that the action handler can use to make API
- * requests to. This value is set upon calling the initialize function with incoming event data.
+ * Halix service URL for API requests. Set by initialize().
  */
 export let serviceAddress;
 /**
- * actionSubject contains the identifier of the subject of the action. The subject is the object
- * that the action is being performed on. The action subject's contents will differ depending on the
- * context in which the action is being executed. This value is set upon calling the initialize
- * function with incoming event data.
- * - for formTemplateActions, the action subject is the data being edited on the form
- * - for pageTemplateActions, the action subject is record containing the context variables and
- *   their corresponding values on the page
- * - for objectSaveActions, the action subject is the object being saved
- * - for calculatedFieldActions, the action subject is the object containing the calculated field
- * - for singleValueActions, the action subject may differ depending on the caller
+ * Subject of the action (context-dependent: form data, page variables, object being saved, etc.). Set by initialize().
  */
 export let actionSubject;
 /**
- * userContext contains the user context information for the user that is executing the action.
- * This value is set upon calling the initialize function with incoming event data.
+ * User context (user, userProxy, orgProxy, keys). Set by initialize().
  */
 export let userContext;
 /**
- * params contains the parameters passed to the action. If an input dialog is used, params will
- * contain the values entered in the dialog. This value is set upon calling the initialize
- * function with incoming event data.
+ * Parameters passed to the action (e.g., from input dialog). Set by initialize().
  */
 export let params;
 /**
- * useBody is a flag indicating how responses should be formatted. If true, the response will be
- * returned as an object with the HTTP response code and ActionResponse in the body field. If false,
- * the ActionResponse will be returned directly. Typically, this does not need to be set by the
- * action handler and should remain false.
+ * Response format flag (internal). Typically leave as false.
  */
 export let useBody;
 /**
- * initialize initializes the SDK with event data. This should be called at the beginning of the
- * action handler to set up the SDK with incoming information, including context information, input
- * parameters, and authentication information needed to make API requests to the Halix service.
+ * Initializes SDK with event data. Call at the beginning of action handler to set up authentication, context, and parameters.
  *
- * @param event - The event object containing authentication and context information
+ * @param event - Event object with body containing IncomingEventBody
  */
 export function initialize(event) {
     let body = event;
@@ -98,14 +76,9 @@ export function initialize(event) {
 // RESPONSE HELPER FUNCTIONS
 // ================================================================================
 /**
- * prepareSuccessResponse prepares a success response in the appropriate format. The action handler
- * should return an ActionResponse response when the action is successful. If useBody is true, the
- * response will be returned as an object with the HTTP response code and the ActionResponse in the
- * body field. If useBody is false, the ActionResponse will be returned directly.
+ * Formats a success response. Returns ActionResponse directly, or wrapped with statusCode if useBody is true.
  *
- * @param successResponse - The value to return
- *
- * @returns Formatted success response; an ActionResponse unless useBody is true
+ * @returns ActionResponse or {statusCode: 200, body: string}
  */
 export function prepareSuccessResponse(successResponse) {
     if (useBody) {
@@ -117,14 +90,9 @@ export function prepareSuccessResponse(successResponse) {
     return successResponse;
 }
 /**
- * prepareErrorResponse prepares an error response in the appropriate format. The action handler
- * should return an ErrorResponse response when the action is not successful. If useBody is true,
- * the response will be returned as an object with the HTTP response code and the ErrorResponse in
- * the body field. If useBody is false, the ErrorResponse will be returned directly.
- *
- * @param errorMessage - The error message
+ * Formats an error response. Returns ErrorResponse directly, or wrapped with statusCode if useBody is true.
  *
- * @returns Formatted error response; an ErrorResponse unless useBody is true
+ * @returns ErrorResponse or {statusCode: 400, body: string}
  */
 export function prepareErrorResponse(errorMessage) {
     if (useBody) {

package/lib/esm/sdk-general.js.map

@@ -1 +1 @@
-{"version":3,"file":"sdk-general.js","sourceRoot":"","sources":["../../src/sdk-general.ts"],"names":[],"mappings":"AAAA,yBAAyB;AACzB,mCAAmC;AACnC,EAAE;AACF,oEAAoE;AACpE,0EAA0E;AAC1E,EAAE;AACF,6DAA6D;AAC7D,oDAAoD;AAEpD;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAc,EAAE,EAAE,MAAM,MAAM,CAAC;AAEtC,mFAAmF;AACnF,sCAAsC;AACtC,mFAAmF;AAEnF;;;;GAIG;AACH,MAAM,CAAC,IAAI,YAAsC,CAAC;AAElD;;;;GAIG;AACH,MAAM,CAAC,IAAI,UAAkB,CAAC;AAE9B;;;GAGG;AACH,MAAM,CAAC,IAAI,cAAsB,CAAC;AAElC;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,IAAI,aAAkB,CAAC;AAE9B;;;GAGG;AACH,MAAM,CAAC,IAAI,WAAwB,CAAC;AAEpC;;;;GAIG;AACH,MAAM,CAAC,IAAI,MAAc,CAAC;AAE1B;;;;;GAKG;AACH,MAAM,CAAC,IAAI,OAAgB,CAAC;AAE5B;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CAAC,KAAmC;IAE1D,IAAI,IAAI,GAAQ,KAAK,CAAC;IACtB,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;QACb,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QAClB,OAAO,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,IAAI,IAAI,EAAE,CAAC;QACP,CAAC,EAAE,UAAU,EAAE,cAAc,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;QAE5E,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACjB,YAAY,GAAG,GAAG,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC5C,CAAC;aAAM,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACjC,YAAY,GAAG,IAAI,CAAC,kBAAkB,CAAC;QAC3C,CAAC;IACL,CAAC;AACL,CAAC;AAuLD,mFAAmF;AACnF,4BAA4B;AAC5B,mFAAmF;AAEnF;;;;;;;;;GASG;AACH,MAAM,UAAU,sBAAsB,CAAC,eAA+B;IAClE,IAAI,OAAO,EAAE,CAAC;QACV,OAAO;YACH,UAAU,EAAE,GAAG;YACf,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC;SACxC,CAAC;IACN,CAAC;IAED,OAAO,eAAe,CAAC;AAC3B,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,oBAAoB,CAAC,YAAoB;IACrD,IAAI,OAAO,EAAE,CAAC;QACV,OAAO;YACH,UAAU,EAAE,GAAG;YACf,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,YAAY,EAAE,CAAC;SACzC,CAAC;IACN,CAAC;IAED,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,OAAO,EAAE,CAAC;AACnD,CAAC"}
+{"version":3,"file":"sdk-general.js","sourceRoot":"","sources":["../../src/sdk-general.ts"],"names":[],"mappings":"AAAA,yBAAyB;AACzB,mCAAmC;AACnC,EAAE;AACF,oEAAoE;AACpE,0EAA0E;AAC1E,EAAE;AACF,6DAA6D;AAC7D,oDAAoD;AAEpD;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAc,EAAE,EAAE,MAAM,MAAM,CAAC;AAEtC,mFAAmF;AACnF,sCAAsC;AACtC,mFAAmF;AAEnF;;GAEG;AACH,MAAM,CAAC,IAAI,YAAsC,CAAC;AAElD;;GAEG;AACH,MAAM,CAAC,IAAI,UAAkB,CAAC;AAE9B;;GAEG;AACH,MAAM,CAAC,IAAI,cAAsB,CAAC;AAElC;;GAEG;AACH,MAAM,CAAC,IAAI,aAAkB,CAAC;AAE9B;;GAEG;AACH,MAAM,CAAC,IAAI,WAAwB,CAAC;AAEpC;;GAEG;AACH,MAAM,CAAC,IAAI,MAAc,CAAC;AAE1B;;GAEG;AACH,MAAM,CAAC,IAAI,OAAgB,CAAC;AAE5B;;;;GAIG;AACH,MAAM,UAAU,UAAU,CAAC,KAAmC;IAE1D,IAAI,IAAI,GAAQ,KAAK,CAAC;IACtB,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;QACb,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QAClB,OAAO,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,IAAI,IAAI,EAAE,CAAC;QACP,CAAC,EAAE,UAAU,EAAE,cAAc,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;QAE5E,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACjB,YAAY,GAAG,GAAG,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC5C,CAAC;aAAM,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACjC,YAAY,GAAG,IAAI,CAAC,kBAAkB,CAAC;QAC3C,CAAC;IACL,CAAC;AACL,CAAC;AAgKD,mFAAmF;AACnF,4BAA4B;AAC5B,mFAAmF;AAEnF;;;;GAIG;AACH,MAAM,UAAU,sBAAsB,CAAC,eAA+B;IAClE,IAAI,OAAO,EAAE,CAAC;QACV,OAAO;YACH,UAAU,EAAE,GAAG;YACf,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC;SACxC,CAAC;IACN,CAAC;IAED,OAAO,eAAe,CAAC;AAC3B,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,oBAAoB,CAAC,YAAoB;IACrD,IAAI,OAAO,EAAE,CAAC;QACV,OAAO;YACH,UAAU,EAAE,GAAG;YACf,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,YAAY,EAAE,CAAC;SACzC,CAAC;IACN,CAAC;IAED,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,OAAO,EAAE,CAAC;AACnD,CAAC"}

package/lib/esm/types/content.d.ts

@@ -19,100 +19,42 @@ export interface ContentResource {
     deserialize?: (data: any) => ContentResource;
 }
 /**
- * getOrCreateResource retrieves an existing content resource by its key, or creates a new one
- * if the key is not provided. If a resource key is provided, it attempts to fetch the existing
- * resource from the server. If no key is provided, it creates a new resource with the specified
- * properties.
+ * Retrieves an existing content resource by key, or creates a new one if key is null.
  *
- * @param resourceKey - Optional key of the existing resource to retrieve
- * @param fileToUpload - Optional file or blob to upload
- * @param publicFlag - Whether the resource should be public
- * @param resourceType - The type of resource
- * @param tags - Array of tags for the resource
- *
- * @returns Promise resolving to a ContentResource
+ * @returns Promise<ContentResource>
  */
 export declare function getOrCreateResource(resourceKey: string | null, fileToUpload: File | Blob | null, publicFlag: boolean, resourceType: string, tags: string[]): Promise<ContentResource>;
 /**
- * getOrCreateResourceAsObservable retrieves an existing content resource by its key, or creates a new one
- * if the key is not provided. If a resource key is provided, it attempts to fetch the existing
- * resource from the server. If no key is provided, it creates a new resource with the specified
- * properties.
- *
- * @param resourceKey - Optional key of the existing resource to retrieve
- * @param fileToUpload - Optional file or blob to upload
- * @param publicFlag - Whether the resource should be public
- * @param resourceType - The type of resource
- * @param tags - Array of tags for the resource
- *
- * @returns Observable resolving to a ContentResource
+ * Observable version of getOrCreateResource. See getOrCreateResource for details.
  */
 export declare function getOrCreateResourceAsObservable(resourceKey: string | null, fileToUpload: File | Blob | null, publicFlag: boolean, resourceType: string, tags: string[]): Observable<ContentResource>;
 /**
- * saveResource saves a content resource to the server. The resource is saved with appropriate
- * ownership parameters based on the current context (solution builder vs regular organization view).
+ * Saves a content resource with appropriate ownership based on context (solution builder vs org view).
  *
- * @param resource - The ContentResource to save
- *
- * @returns Promise resolving to the saved ContentResource
+ * @returns Promise<ContentResource>
  */
 export declare function saveResource(resource: ContentResource): Promise<ContentResource>;
 /**
- * saveResourceAsObservable saves a content resource to the server. The resource is saved with appropriate
- * ownership parameters based on the current context (solution builder vs regular organization view).
- *
- * @param resource - The ContentResource to save
- *
- * @returns Observable resolving to the saved ContentResource
+ * Observable version of saveResource. See saveResource for details.
  */
 export declare function saveResourceAsObservable(resource: ContentResource): Observable<ContentResource>;
 /**
- * sendFileContents uploads file contents to the server for a specific resource. The file is uploaded
- * via FormData with the appropriate scope and public flag settings.
+ * Uploads file contents to a resource via FormData.
  *
- * @param resourceKey - The key of the resource to upload file contents for
- * @param fileToUpload - The file or blob to upload
- * @param publicFlag - Whether the file should be public
- *
- * @returns Promise resolving to true if upload was successful
+ * @returns Promise<boolean> - true if successful
  */
 export declare function sendFileContents(resourceKey: string, fileToUpload: File | Blob, publicFlag: boolean): Promise<boolean>;
 /**
- * sendFileContentsAsObservable uploads file contents to the server for a specific resource. The file is uploaded
- * via FormData with the appropriate scope and public flag settings.
- *
- * @param resourceKey - The key of the resource to upload file contents for
- * @param fileToUpload - The file or blob to upload
- * @param publicFlag - Whether the file should be public
- *
- * @returns Observable resolving to true if upload was successful
+ * Observable version of sendFileContents. See sendFileContents for details.
  */
 export declare function sendFileContentsAsObservable(resourceKey: string, fileToUpload: File | Blob, publicFlag: boolean): Observable<boolean>;
 /**
- * createOrUpdateResource creates a new content resource or updates an existing one, then uploads
- * the file contents to that resource. If a resourceKey is provided, it updates the existing resource;
- * otherwise, it creates a new resource and uploads the file to the newly created resource.
+ * Creates or updates a content resource and uploads file contents. If resourceKey is provided, updates existing; otherwise creates new.
  *
- * @param resourceKey - Optional key of the existing resource to update; if not provided, a new resource is created
- * @param fileToUpload - The file or blob to upload
- * @param publicFlag - Whether the resource should be public
- * @param resourceType - The type of resource
- * @param tags - Array of tags for the resource
- *
- * @returns Promise resolving to the ContentResource with uploaded file
+ * @returns Promise<ContentResource> with uploaded file metadata
  */
 export declare function createOrUpdateResource(resourceKey: string | null, fileToUpload: File | Blob, publicFlag: boolean, resourceType: string, tags: string[]): Promise<ContentResource>;
 /**
- * createOrUpdateResourceAsObservable creates a new content resource or updates an existing one, then uploads
- * the file contents to that resource. If a resourceKey is provided, it updates the existing resource;
- * otherwise, it creates a new resource and uploads the file to the newly created resource.
- *
- * @param resourceKey - Optional key of the existing resource to update; if not provided, a new resource is created
- * @param fileToUpload - The file or blob to upload
- * @param publicFlag - Whether the resource should be public
- * @param resourceType - The type of resource
- * @param tags - Array of tags for the resource
- *
- * @returns Observable resolving to the ContentResource with uploaded file
+ * Observable version of createOrUpdateResource. See createOrUpdateResource for details.
  */
 export declare function createOrUpdateResourceAsObservable(resourceKey: string | null, fileToUpload: File | Blob, publicFlag: boolean, resourceType: string, tags: string[]): Observable<ContentResource>;

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

@@ -8,153 +8,60 @@ 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>;