@extrahorizon/javascript-sdk 8.9.0-dev-121-e732d56 → 8.9.0-feat-134-c0f5b9d

package/build/types/services/tasks/functions/types.d.ts

@@ -1,6 +1,82 @@
-import { OptionsBase } from '../../types';
+import { OptionsBase, type AffectedRecords, type PagedResult } from '../../types';
 import { Task } from '../types';
 export interface FunctionsService {
+    /**
+     * View a list of functions.
+     *
+     * Although this endpoint is a paged-like endpoint, it will return all functions in a single page.
+     * RQL is not supported for this endpoint, and any RQL provided will be ignored.
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_TASK_FUNCTIONS` | `global` | **Required** for this endpoint
+     */
+    find(options?: OptionsBase): Promise<PagedResult<FunctionBase>>;
+    /**
+     * View a list of functions.
+     *
+     * Although this endpoint is a paged-like endpoint, it will return all functions in a single page.
+     * RQL is not supported for this endpoint, and any RQL provided will be ignored.
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_TASK_FUNCTIONS` | `global` | **Required** for this endpoint
+     */
+    create(body: FunctionCreation, options?: OptionsBase): Promise<FunctionDetails>;
+    /**
+     * View details of a function by its name.
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_TASK_FUNCTION_DETAILS` | `global` | **Required** for this endpoint
+     *
+     * @throws {ResourceUnknownError} When no function with the specified name is found
+     */
+    getByName(name: string, options?: OptionsBase): Promise<FunctionDetails>;
+    /**
+     * Update a function by its name.
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `UPDATE_TASK_FUNCTION` | `global` | **Required** for this endpoint
+     *
+     * @throws {ResourceUnknownError} When no function with the specified name is found
+     */
+    update(name: string, body: Partial<FunctionCreation>, options?: OptionsBase): Promise<AffectedRecords>;
+    /**
+     * Delete a function by its name.
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `DELETE_TASK_FUNCTION` | `global` | **Required** for this endpoint
+     *
+     * @throws {ResourceUnknownError} When no function with the specified name is found
+     */
+    delete(name: string, options?: OptionsBase): Promise<AffectedRecords>;
+    /**
+     * Enable a function by its name.
+     *
+     * Does nothing if the function is already enabled.
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `UPDATE_TASK_FUNCTION` | `global` | **Required** for this endpoint
+     *
+     * @throws {ResourceUnknownError} When no function with the specified name is found
+     */
+    enable(name: string, options?: OptionsBase): Promise<AffectedRecords>;
+    /**
+     * Disable a function by its name.
+     *
+     * Does nothing if the function is already disabled.
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `UPDATE_TASK_FUNCTION` | `global` | **Required** for this endpoint
+     *
+     * @throws {ResourceUnknownError} When no function with the specified name is found
+     */
+    disable(name: string, options?: OptionsBase): Promise<AffectedRecords>;
     /**
      * ## Execute a Function directly
      *
@@ -21,6 +97,74 @@ export interface FunctionsService {
      */
     execute<T = any, U = any>(functionName: string, data?: U, options?: OptionsBase): Promise<DirectExecutionResponse<T, U>>;
 }
+export interface FunctionBase {
+    /** The name of the Function */
+    name: string;
+    /** A description of the Function */
+    description: string;
+    /** The timestamp when the Function was last updated */
+    updateTimestamp: Date;
+}
+export interface FunctionCreation {
+    /** The name of the Function, this serves as the unique identifier amongst all Functions */
+    name: string;
+    /** A description of the Function */
+    description?: string;
+    /** Base64 Encoded binary value of the compressed (.zip) function code */
+    code: string;
+    /** Entry point for execution of the function, e.g. `index.handler` */
+    entryPoint: string;
+    /**
+     * The runtime environment for the Function, e.g. `nodejs24.x`
+     * The supported runtimes can be found in the [task service documentation](https://docs.extrahorizon.com/extrahorizon/services/automation/task-service/functions#runtime)
+     */
+    runtime: string;
+    /**
+     * Maximum execution time (seconds) of the function.
+     * Should be between 3 and 300 seconds, defaults to 30 seconds if not provided.
+     */
+    timeLimit?: number;
+    /**
+     * Memory limit (MB) for the function.
+     * Should be between 128 and 10240, defaults to 128 if not provided.
+     */
+    memoryLimit?: number;
+    /** Environment variables to be made available to the function during execution */
+    environmentVariables?: {
+        [key: string]: {
+            value: string;
+        };
+    };
+    /** Options related to the execution of the function, such as permission an priority */
+    executionOptions?: {
+        /** Defines access for executing the function directly or for invoking it as an API function. */
+        permissionMode?: FunctionPermissionMode;
+        /** The default priority assigned to all tasks created for this function, unless a priority is specified for a task explicitly */
+        defaultPriority?: number;
+    };
+    /** The policy that determines system behavior after the execution of a Function fails. */
+    retryPolicy?: {
+        /**
+         * The retry policy is disabled by default, If this field is set to true, the retry policy becomes active.
+         * If active the policy will retry a maximum of 3 times, with an increasing timeout of 2, 5 and 10 seconds respectively.
+         */
+        enabled: boolean;
+        /** A list of error names that should trigger a retry. If not specified, the default is to retry on all errors. */
+        errorsToRetry: string[];
+    };
+}
+export declare type FunctionDetails = Omit<FunctionCreation, 'code'> & FunctionBase & {
+    /** Indicates whether the function is enabled or disabled for execution/invocation. Enabled by default. */
+    enabled: boolean;
+};
+export declare enum FunctionPermissionMode {
+    /** To execute this function directly the user needs the EXECUTE_TASK_FUNCTION permission */
+    PERMISSION_REQUIRED = "permissionRequired",
+    /** Every logged in user can execute this function directly */
+    ALL_USERS = "allUsers",
+    /** The function can be executed even by unauthenticated requests */
+    PUBLIC = "public"
+}
 export interface DirectExecutionResponse<T, U> extends Task<U> {
     /** The result of the Function execution, this may be user defined */
     result: T;

package/build/types/services/tasks/logs/types.d.ts

@@ -20,7 +20,7 @@ export interface LogsService {
      * @param taskId {@link string} The id of the targeted task
      * @param options {@link OptionsWithRql} - Additional options for the request
      * @returns The first element of the queried task logs {@link LogLine}     */
-    findFirst(taskId: ObjectId, options?: OptionsWithRql): Promise<LogLine>;
+    findFirst(taskId: ObjectId, options?: OptionsWithRql): Promise<LogLine | undefined>;
 }
 export interface LogLine {
     message: string;

package/build/types/services/tasks/schedules/types.d.ts

@@ -61,7 +61,7 @@ export interface SchedulesService {
      * @param options {@link OptionsWithRql} - Add filters to the requested list
      * @returns The first element of the queried Schedules {@link Schedule}
      */
-    findFirst<T>(options?: OptionsWithRql): Promise<Schedule<T>>;
+    findFirst<T>(options?: OptionsWithRql): Promise<Schedule<T> | undefined>;
 }
 export interface ScheduleCreation<T = Record<string, any>> {
     /** The period in seconds, for which the function defined will execute recurrently */

package/build/types/services/tasks/types.d.ts

@@ -51,7 +51,7 @@ export interface TasksService {
      * @param rql an optional rql string
      * @returns the first element found
      */
-    findById(id: ObjectId, options?: OptionsWithRql): Promise<Task>;
+    findById(id: ObjectId, options?: OptionsWithRql): Promise<Task | undefined>;
     /**
      * Request a list of all tasks
      *
@@ -79,7 +79,7 @@ export interface TasksService {
      * @param rql an optional rql string
      * @returns the first element found
      */
-    findFirst(options?: OptionsWithRql): Promise<Task>;
+    findFirst(options?: OptionsWithRql): Promise<Task | undefined>;
     /**
      * Create a task
      *

package/build/types/services/templatesV2/health.d.ts

@@ -0,0 +1,9 @@
+import type { HttpInstance } from '../../types';
+declare const _default: (client: any, http: HttpInstance) => {
+    /**
+     * Perform a health check
+     * @returns {boolean} success
+     */
+    health(): Promise<boolean>;
+};
+export default _default;

package/build/types/services/templatesV2/index.d.ts

@@ -0,0 +1,4 @@
+import { AuthHttpClient } from '../../types';
+import health from './health';
+import { TemplatesV2Service } from './types';
+export declare const templatesV2Service: (httpWithAuth: AuthHttpClient) => ReturnType<typeof health> & TemplatesV2Service;

package/build/types/services/templatesV2/templatesV2.d.ts

@@ -0,0 +1,5 @@
+import { AuthHttpClient } from '../../types';
+import { HttpClient } from '../http-client';
+import { TemplatesV2Service } from './types';
+declare const _default: (client: HttpClient, httpWithAuth: AuthHttpClient) => TemplatesV2Service;
+export default _default;

package/build/types/services/templatesV2/types.d.ts

@@ -0,0 +1,145 @@
+import { ObjectId, LanguageCode, TimeZone, PagedResult, AffectedRecords, OptionsWithRql, OptionsBase } from '../types';
+export interface TemplateV2 extends TemplateV2Creation {
+    id: ObjectId;
+    creationTimestamp: Date;
+    updateTimestamp: Date;
+}
+export interface TemplateV2Creation {
+    name: string;
+    description?: string;
+    properties?: Record<string, TemplateV2TypeConfiguration>;
+    outputs: Record<string, string>;
+}
+export declare type TemplateV2TypeConfiguration = TemplateV2ObjectConfiguration | TemplateV2ArrayConfiguration | TemplateV2StringConfiguration | TemplateV2NumberConfiguration | TemplateV2BooleanConfiguration;
+export interface TemplateV2ObjectConfiguration {
+    type: 'object';
+    properties: Record<string, TemplateV2TypeConfiguration>;
+}
+export interface TemplateV2ArrayConfiguration {
+    type: 'array';
+    items: TemplateV2TypeConfiguration;
+}
+export interface TemplateV2StringConfiguration {
+    type: 'string';
+}
+export interface TemplateV2NumberConfiguration {
+    type: 'number';
+}
+export interface TemplateV2BooleanConfiguration {
+    type: 'boolean';
+}
+export interface TemplateV2ResolveIn<T extends Record<string, any>> {
+    /**
+     * If not present (or empty) we will first check the configured language in the users-service. If that is not present it will default to 'EN'
+     */
+    language?: LanguageCode;
+    /**
+     * If not present (or empty) we will first check the configured time_zone in the users-service. If that is not present it will default to 'UTC'
+     */
+    timeZone?: TimeZone;
+    data?: T;
+}
+export interface TemplatesV2ErrorInfo {
+    /**
+     * The template outputs key in the request body that resulted in an error
+     */
+    output: string;
+    /**
+     * Error message describing the syntax error
+     */
+    message: string;
+}
+export interface TemplatesV2Service {
+    /**
+     * Get all templates the service has to offer
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_TEMPLATES` | `global` | **Required** for this endpoint
+     * @param rql Add filters to the requested list.
+     * @returns PagedResult<TemplateV2>
+     */
+    find(options?: OptionsWithRql): Promise<PagedResult<TemplateV2>>;
+    /**
+     * Request a list of all templates
+     *
+     * Do not pass in a rql with limit operator!
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `VIEW_TEMPLATES` | `global` | **Required** for this endpoint
+     * @param rql Add filters to the requested list.
+     * @returns TemplateV2[]
+     */
+    findAll(options?: OptionsWithRql): Promise<TemplateV2[]>;
+    /**
+     * Find By Id
+     * @param id the Id to search for
+     * @returns the first element found
+     */
+    findById(id: ObjectId, options?: OptionsWithRql): Promise<TemplateV2 | undefined>;
+    /**
+     * Find By Name
+     * @param name the name to search for
+     * @returns the first element found
+     */
+    findByName(name: string, options?: OptionsWithRql): Promise<TemplateV2 | undefined>;
+    /**
+     * Find First
+     * @returns the first element found
+     */
+    findFirst(options?: OptionsWithRql): Promise<TemplateV2 | undefined>;
+    /**
+     * Create a new template
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `CREATE_TEMPLATES` | `global` | **Required** for this endpoint
+     * @param requestBody TemplateIn
+     * @returns TemplateV2
+     * @throws {ResourceAlreadyExistsError}
+     * @throws {TemplateSyntaxError}
+     */
+    create(requestBody: TemplateV2Creation, options?: OptionsBase): Promise<TemplateV2>;
+    /**
+     * Update an existing template
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `UPDATE_TEMPLATES` | `global` | **Required** for this endpoint
+     * @param templateIdOrName Id or Name of the targeted template
+     * @param requestBody TemplateIn
+     * @returns TemplateV2
+     * @throws {ResourceAlreadyExistsError}
+     * @throws {TemplateSyntaxError}
+     * @throws {ResourceUnknownError}
+     */
+    update(templateIdOrName: string, requestBody: Partial<TemplateV2Creation>, options?: OptionsBase): Promise<AffectedRecords>;
+    /**
+     * Delete a template
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * `DELETE_TEMPLATES` | `global` | **Required** for this endpoint
+     * @param templateIdOrName Id or Name of the targeted template
+     * @returns AffectedRecords
+     * @throws {ResourceUnknownError}
+     */
+    remove(templateIdOrName: string, options?: OptionsBase): Promise<AffectedRecords>;
+    /**
+     * Resolves a template and presents the result as a json response
+     * Permission is **required** for this endpoint
+     * Permission | Scope | Effect
+     * - | - | -
+     * `RESOLVE_TEMPLATES` | `global` | Resolve any template
+     * `RESOLVE_TEMPLATES:{TEMPLATE_NAME}` | `global` | Resolve the specified template
+     *
+     * @param templateIdOrName Id or Name of the targeted template
+     * @param requestBody CreateFile
+     * @returns TemplateV2ResolveOut
+     * @throws {TemplateResolvingError}
+     * @throws {TemplateFillingError}
+     * @throws {ResourceUnknownError}
+     */
+    resolve<InputData = Record<string, any>, Outputs = Record<string, string>>(templateIdOrName: string, requestBody: TemplateV2ResolveIn<InputData>, options?: OptionsBase): Promise<Outputs>;
+}

package/build/types/services/types.d.ts

@@ -31,7 +31,10 @@ export declare enum Results {
     Success = 200
 }
 /**
- * Supported timezones from [Java.time.zoneId](https://docs.oracle.com/javase/8/docs/api/java/time/ZoneId.html#of-java.lang.String-)
+ * IANA time zone identifier (e.g. "Europe/Brussels").
+ * We aim to stay aligned with the official IANA time zone database.
+ * In practice, supported values closely match those returned by Intl.supportedValuesOf('timeZone') in JavaScript.
+ * For an overview of IANA time zones, see: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
  */
 export declare type TimeZone = string;
 export declare type MailAddress = string;

package/build/types/services/users/activationRequests/types.d.ts

@@ -15,7 +15,7 @@ export interface ActivationRequestsService {
      * - | - | -
      * `VIEW_ACTIVATION_REQUESTS` | global | **Required** for this endpoint
      */
-    findFirst(options?: OptionsWithRql): Promise<ActivationRequest>;
+    findFirst(options?: OptionsWithRql): Promise<ActivationRequest | undefined>;
     /**
      * Find an activation request by its id
      *
@@ -23,7 +23,7 @@ export interface ActivationRequestsService {
      * - | - | -
      * `VIEW_ACTIVATION_REQUESTS` | global | **Required** for this endpoint
      */
-    findById(id: string, options?: OptionsWithRql): Promise<ActivationRequest>;
+    findById(id: string, options?: OptionsWithRql): Promise<ActivationRequest | undefined>;
     /**
      * Find an activation request for a user id
      *
@@ -31,7 +31,7 @@ export interface ActivationRequestsService {
      * - | - | -
      * `VIEW_ACTIVATION_REQUESTS` | global | **Required** for this endpoint
      */
-    findByUserId(userId: string, options?: OptionsWithRql): Promise<ActivationRequest>;
+    findByUserId(userId: string, options?: OptionsWithRql): Promise<ActivationRequest | undefined>;
     /**
      * Remove an activation request
      *

package/build/types/services/users/forgotPasswordRequests/types.d.ts

@@ -15,7 +15,7 @@ export interface ForgotPasswordRequestsService {
      * - | - | -
      * `VIEW_FORGOT_PASSWORD_REQUESTS` | global | **Required** for this endpoint
      */
-    findFirst(options?: OptionsWithRql): Promise<ForgotPasswordRequest>;
+    findFirst(options?: OptionsWithRql): Promise<ForgotPasswordRequest | undefined>;
     /**
      * Find a forgot password request by its id
      *
@@ -23,7 +23,7 @@ export interface ForgotPasswordRequestsService {
      * - | - | -
      * `VIEW_FORGOT_PASSWORD_REQUESTS` | global | **Required** for this endpoint
      */
-    findById(id: string, options?: OptionsWithRql): Promise<ForgotPasswordRequest>;
+    findById(id: string, options?: OptionsWithRql): Promise<ForgotPasswordRequest | undefined>;
     /**
      * Find a forgot password request for a user id
      *
@@ -31,7 +31,7 @@ export interface ForgotPasswordRequestsService {
      * - | - | -
      * `VIEW_FORGOT_PASSWORD_REQUESTS` | global | **Required** for this endpoint
      */
-    findByUserId(userId: string, options?: OptionsWithRql): Promise<ForgotPasswordRequest>;
+    findByUserId(userId: string, options?: OptionsWithRql): Promise<ForgotPasswordRequest | undefined>;
     /**
      * Remove a forgot password request
      *

package/build/types/services/users/types.d.ts

@@ -207,6 +207,7 @@ export declare enum GlobalPermissionName {
     REMOVE_ROLE_PERMISSION = "REMOVE_ROLE_PERMISSION",
     REMOVE_STAFF = "REMOVE_STAFF",
     RESET_FAILED_LOGIN_ATTEMPTS = "RESET_FAILED_LOGIN_ATTEMPTS",
+    RESOLVE_TEMPLATES = "RESOLVE_TEMPLATES",
     SEND_MAILS = "SEND_MAILS",
     SYNC_PROFILE_GROUPS = "SYNC_PROFILE_GROUPS",
     TRANSFER_PERIOD = "TRANSFER_PERIOD",
@@ -459,7 +460,7 @@ export interface UsersGlobalRolesService {
      * - | - | -
      * `VIEW_ROLE` | `global` | **Required** for this endpoint
      */
-    findFirst(options?: OptionsWithRql): Promise<Role>;
+    findFirst(options?: OptionsWithRql): Promise<Role | undefined>;
     /**
      * Returns the first role with a specific id
      *
@@ -467,7 +468,7 @@ export interface UsersGlobalRolesService {
      * - | - | -
      * `VIEW_ROLE` | `global` | **Required** for this endpoint
      */
-    findById(id: ObjectId, options?: OptionsWithRql): Promise<Role>;
+    findById(id: ObjectId, options?: OptionsWithRql): Promise<Role | undefined>;
     /**
      * Returns the first role with a specific name
      *
@@ -475,7 +476,7 @@ export interface UsersGlobalRolesService {
      * - | - | -
      * `VIEW_ROLE` | `global` | **Required** for this endpoint
      */
-    findByName(name: string, options?: OptionsWithRql): Promise<Role>;
+    findByName(name: string, options?: OptionsWithRql): Promise<Role | undefined>;
     /**
      * @deprecated Use `find` instead
      *
@@ -591,7 +592,7 @@ export interface UsersGroupRolesService {
      * none | `staff enlistment` | View the roles for the group
      * `VIEW_GROUP` | `global` | View any group its roles
      */
-    findFirst(groupId: ObjectId, options?: OptionsWithRql): Promise<GroupRole>;
+    findFirst(groupId: ObjectId, options?: OptionsWithRql): Promise<GroupRole | undefined>;
     /**
      * Finds a group role by its id
      *
@@ -600,7 +601,7 @@ export interface UsersGroupRolesService {
      * none | `staff enlistment` | View the roles for the group
      * `VIEW_GROUP` | `global` | View any group its roles
      */
-    findById(groupId: ObjectId, roleId: ObjectId, options?: OptionsWithRql): Promise<GroupRole>;
+    findById(groupId: ObjectId, roleId: ObjectId, options?: OptionsWithRql): Promise<GroupRole | undefined>;
     /**
      * Returns the first group role found by a specific name
      *
@@ -609,7 +610,7 @@ export interface UsersGroupRolesService {
      * none | `staff enlistment` | View the roles for the group
      * `VIEW_GROUP` | `global` | View any group its roles
      */
-    findByName(groupId: ObjectId, roleName: string, options?: OptionsWithRql): Promise<GroupRole>;
+    findByName(groupId: ObjectId, roleName: string, options?: OptionsWithRql): Promise<GroupRole | undefined>;
     /**
      * @deprecated Use `find` instead
      *
@@ -815,9 +816,26 @@ export interface UsersService {
      * @returns User[]
      */
     findAllIterator(options?: OptionsWithRql): FindAllIterator<User>;
-    findFirst(options?: {
-        rql?: RQLString;
-    }): Promise<User>;
+    /**
+     * Find the first user matching the rql query
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | `patient enlistment` | See a limited set of fields of the staff members (of the groups where you are enlisted as a patient)
+     * none | `staff enlistment` | See a limited set of fields of all patients and staff members (of the groups where you are enlisted as staff member)
+     * `VIEW_USER` | `global` | See all fields of all users
+     */
+    findFirst(options?: OptionsWithRql): Promise<User | undefined>;
+    /**
+     * Find a user by their email address
+     *
+     * Permission | Scope | Effect
+     * - | - | -
+     * none | `patient enlistment` | See a limited set of fields of the staff members (of the groups where you are enlisted as a patient)
+     * none | `staff enlistment` | See a limited set of fields of all patients and staff members (of the groups where you are enlisted as staff member)
+     * `VIEW_USER` | `global` | See all fields of all users
+     */
+    findByEmail(email: string, options?: OptionsWithRql): Promise<User | undefined>;
     /**
      * @deprecated
      * Delete a list of users

package/build/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "8.9.0-dev-121-e732d56";
+export declare const version = "8.9.0-feat-134-c0f5b9d";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@extrahorizon/javascript-sdk",
-  "version": "8.9.0-dev-121-e732d56",
+  "version": "8.9.0-feat-134-c0f5b9d",
   "description": "This package serves as a JavaScript wrapper around all Extra Horizon cloud services.",
   "main": "build/index.cjs.js",
   "types": "build/types/index.d.ts",
@@ -26,7 +26,7 @@
     "prepare": "yarn build && yarn lint",
     "test": "jest",
     "test:e2e": "jest tests/e2e",
-    "lint": "eslint src --ext .ts"
+    "lint": "eslint src/** tests/** --ext .ts"
   },
   "files": [
     "build"