@halix/action-sdk 1.0.19 → 1.0.21

package/lib/esm/lists.js

@@ -0,0 +1,157 @@
+// 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/lists
+ * @description List data retrieval functions. Use this to efficiently retrieve objects
+ * from the database for display in list-like user interfaces. This is preferred over
+ * the `data-crud` module when showing one page of data at a time.
+ *
+ * Key features:
+ * - Efficient retrieval of one page of data at a time
+ * - Pagination
+ * - Sorting
+ * - Filtering
+ * - Search
+ */
+import axios from 'axios';
+import { from, lastValueFrom } from 'rxjs';
+import { sandboxKey, serviceAddress, getAuthToken } from './sdk-general';
+// ================================================================================
+// LIST DATA RETRIEVAL FUNCTIONS
+// ================================================================================
+/**
+ * getListData retrieves list data from the Halix platform. This function can operate in four
+ * different modes based on the provided options:
+ *
+ * 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
+ *
+ * @example
+ * // Basic authenticated list data retrieval
+ * const listData = await getListData({
+ *   dataElementId: 'customer',
+ *   parentDataElementId: 'company',
+ *   parentKey: orgProxyKey,
+ *   pageNumber: 1,
+ *   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 async function getListData(request, options) {
+    const isPublic = options?.isPublic ?? false;
+    const hasSearch = !!options?.search;
+    // Determine which endpoint to use based on public access and search requirements
+    let url;
+    if (hasSearch && isPublic) {
+        url = `${serviceAddress}/list/sandboxes/${sandboxKey}/public/listdataSearch`;
+    }
+    else if (hasSearch && !isPublic) {
+        url = `${serviceAddress}/list/sandboxes/${sandboxKey}/listdataSearch`;
+    }
+    else if (!hasSearch && isPublic) {
+        url = `${serviceAddress}/list/sandboxes/${sandboxKey}/public/listdata`;
+    }
+    else {
+        url = `${serviceAddress}/list/sandboxes/${sandboxKey}/listdata`;
+    }
+    // Build query parameters
+    let params = {};
+    // Add bypassTotal parameter if specified
+    if (options?.bypassTotal !== undefined) {
+        params.bypassTotal = options.bypassTotal;
+    }
+    // Add search parameters if search is enabled
+    if (hasSearch && options?.search) {
+        params.attributeId = options.search.attributeId;
+        params.value = options.search.value;
+        params.total = options.search.total.toString();
+    }
+    // Build headers with authentication token for non-public endpoints
+    let headers = {};
+    if (!isPublic) {
+        let authToken = await lastValueFrom(getAuthToken());
+        headers.Authorization = `Bearer ${authToken}`;
+        console.log("Sending POST request to " + url + " with token " + authToken);
+    }
+    else {
+        console.log("Sending POST request to " + url + " (public endpoint)");
+    }
+    // Make the API request
+    let response = await axios.post(url, request, {
+        headers,
+        params: Object.keys(params).length > 0 ? params : undefined,
+    });
+    return response.data;
+}
+/**
+ * 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
+ *
+ * @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);
+ * });
+ */
+export function getListDataAsObservable(request, options) {
+    return from(getListData(request, options));
+}
+//# sourceMappingURL=lists.js.map

package/lib/esm/lists.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lists.js","sourceRoot":"","sources":["../../src/lists.ts"],"names":[],"mappings":"AAAA,yBAAyB;AACzB,mCAAmC;AACnC,EAAE;AACF,oEAAoE;AACpE,0EAA0E;AAC1E,EAAE;AACF,6DAA6D;AAC7D,oDAAoD;AAEpD;;;;;;;;;;;;GAYG;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;AAyJzE,mFAAmF;AACnF,gCAAgC;AAChC,mFAAmF;AAEnF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,OAAwB,EAAE,OAAyB;IAEjF,MAAM,QAAQ,GAAG,OAAO,EAAE,QAAQ,IAAI,KAAK,CAAC;IAC5C,MAAM,SAAS,GAAG,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC;IAEpC,iFAAiF;IACjF,IAAI,GAAW,CAAC;IAChB,IAAI,SAAS,IAAI,QAAQ,EAAE,CAAC;QACxB,GAAG,GAAG,GAAG,cAAc,mBAAmB,UAAU,wBAAwB,CAAC;IACjF,CAAC;SAAM,IAAI,SAAS,IAAI,CAAC,QAAQ,EAAE,CAAC;QAChC,GAAG,GAAG,GAAG,cAAc,mBAAmB,UAAU,iBAAiB,CAAC;IAC1E,CAAC;SAAM,IAAI,CAAC,SAAS,IAAI,QAAQ,EAAE,CAAC;QAChC,GAAG,GAAG,GAAG,cAAc,mBAAmB,UAAU,kBAAkB,CAAC;IAC3E,CAAC;SAAM,CAAC;QACJ,GAAG,GAAG,GAAG,cAAc,mBAAmB,UAAU,WAAW,CAAC;IACpE,CAAC;IAED,yBAAyB;IACzB,IAAI,MAAM,GAAQ,EAAE,CAAC;IAErB,yCAAyC;IACzC,IAAI,OAAO,EAAE,WAAW,KAAK,SAAS,EAAE,CAAC;QACrC,MAAM,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;IAC7C,CAAC;IAED,6CAA6C;IAC7C,IAAI,SAAS,IAAI,OAAO,EAAE,MAAM,EAAE,CAAC;QAC/B,MAAM,CAAC,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC;QAChD,MAAM,CAAC,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC;QACpC,MAAM,CAAC,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnD,CAAC;IAED,mEAAmE;IACnE,IAAI,OAAO,GAAQ,EAAE,CAAC;IACtB,IAAI,CAAC,QAAQ,EAAE,CAAC;QACZ,IAAI,SAAS,GAAG,MAAM,aAAa,CAAC,YAAY,EAAE,CAAC,CAAC;QACpD,OAAO,CAAC,aAAa,GAAG,UAAU,SAAS,EAAE,CAAC;QAE9C,OAAO,CAAC,GAAG,CAAC,0BAA0B,GAAG,GAAG,GAAG,cAAc,GAAG,SAAS,CAAC,CAAC;IAC/E,CAAC;SAAM,CAAC;QACJ,OAAO,CAAC,GAAG,CAAC,0BAA0B,GAAG,GAAG,GAAG,oBAAoB,CAAC,CAAC;IACzE,CAAC;IAED,uBAAuB;IACvB,IAAI,QAAQ,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE;QAC1C,OAAO;QACP,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;KAC9D,CAAC,CAAC;IAEH,OAAO,QAAQ,CAAC,IAAI,CAAC;AACzB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,UAAU,uBAAuB,CAAC,OAAwB,EAAE,OAAyB;IACvF,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;AAC/C,CAAC"}

package/lib/esm/sdk-general.js

@@ -0,0 +1,138 @@
+// 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/sdk-general
+ * @description Core SDK module providing global variables, initialization, and common types used
+ * across the entire SDK. This module includes:
+ * - Global variables for authentication, service configuration, and user context
+ * - initialize() function for setting up the SDK with incoming event data
+ * - Action response type definitions (ListActionResponse, FormTemplateActionResponse, etc.)
+ * - Response formatting helpers (prepareSuccessResponse, prepareErrorResponse)
+ * - Common interfaces (UserContext, IncomingEventBody, NotificationConfig)
+ *
+ * This module should be initialized by calling initialize() before using any other SDK functions.
+ * The global variables are then available for use and are automatically used by other SDK functions.
+ */
+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.
+ */
+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.
+ */
+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.
+ */
+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
+ */
+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.
+ */
+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.
+ */
+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.
+ */
+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.
+ *
+ * @param event - The event object containing authentication and context information
+ */
+export function initialize(event) {
+    let body = event;
+    if (event.body) {
+        body = event.body;
+        useBody = true;
+    }
+    if (body) {
+        ({ sandboxKey, serviceAddress, actionSubject, userContext, params } = body);
+        if (body.authToken) {
+            getAuthToken = () => of(body.authToken);
+        }
+        else if (body.authTokenRetriever) {
+            getAuthToken = body.authTokenRetriever;
+        }
+    }
+}
+// ================================================================================
+// 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.
+ *
+ * @param successResponse - The value to return
+ *
+ * @returns Formatted success response; an ActionResponse unless useBody is true
+ */
+export function prepareSuccessResponse(successResponse) {
+    if (useBody) {
+        return {
+            statusCode: 200,
+            body: JSON.stringify(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
+ *
+ * @returns Formatted error response; an ErrorResponse unless useBody is true
+ */
+export function prepareErrorResponse(errorMessage) {
+    if (useBody) {
+        return {
+            statusCode: 400,
+            body: JSON.stringify({ errorMessage })
+        };
+    }
+    return { errorMessage, responseType: "error" };
+}
+//# sourceMappingURL=sdk-general.js.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,118 @@
+import { Observable } from 'rxjs';
+/**
+ * ContentResource is an interface defining the properties of a content resource.
+ */
+export interface ContentResource {
+    objKey?: string;
+    isPublic: boolean;
+    resourceType: string;
+    tags: string[];
+    organizationKey: string;
+    sandboxKey: string;
+    userKey: string;
+    fileName?: string;
+    fileSize?: number;
+    mimeType?: string;
+    contentType?: string;
+    name?: string | null;
+    extension?: string | null;
+    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.
+ *
+ * @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
+ */
+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
+ */
+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).
+ *
+ * @param resource - The ContentResource to save
+ *
+ * @returns Promise resolving to the saved 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
+ */
+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.
+ *
+ * @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
+ */
+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
+ */
+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.
+ *
+ * @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
+ */
+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
+ */
+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

@@ -0,0 +1,155 @@
+import { Observable } from 'rxjs';
+/**
+ * SaveOptions is an interface for specifying save operation options.
+ */
+export interface SaveOptions {
+    /** Whether to bypass validation */
+    bypassValidation?: boolean;
+}
+/**
+ * getObject 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 Promise resolving to 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
+ */
+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
+ */
+export declare function getRelatedObjects(parentElementId: string, parentKey: string, elementId: string, filter?: string, 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
+ */
+export declare function getRelatedObjectsAsObservable(parentElementId: string, parentKey: string, elementId: string, filter?: string, 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.
+ *
+ * @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
+ */
+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
+ */
+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.
+ *
+ * @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
+ */
+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
+ */
+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
+ *
+ * @returns Promise resolving to true if deletion was 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
+ */
+export declare function deleteRelatedObjectsAsObservable(parentElementId: string, parentKey: string, childElementId: string, childKeys: string[]): Observable<boolean>;