@extrahorizon/javascript-sdk 8.9.0-dev-135-f1c216a → 8.9.0-dev-137-14a5300

package/CHANGELOG.md

@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [8.9.0]
 
 ### Added
+- Added the `exh.tasks.functions` methods `find`, `getByName`, `update`, `enable`, `disable` and `remove`
 - Added a `exh.users.findByEmail` method to find a user by their email address.
 
 ### Fixed

package/build/index.cjs.js

@@ -999,6 +999,16 @@ exports.ApiRequestErrorType = void 0;
     ApiRequestErrorType["RESPONSE"] = "response";
 })(exports.ApiRequestErrorType || (exports.ApiRequestErrorType = {}));
 
+exports.FunctionPermissionMode = void 0;
+(function (FunctionPermissionMode) {
+    /** To execute this function directly the user needs the EXECUTE_TASK_FUNCTION permission */
+    FunctionPermissionMode["PERMISSION_REQUIRED"] = "permissionRequired";
+    /** Every logged in user can execute this function directly */
+    FunctionPermissionMode["ALL_USERS"] = "allUsers";
+    /** The function can be executed even by unauthenticated requests */
+    FunctionPermissionMode["PUBLIC"] = "public";
+})(exports.FunctionPermissionMode || (exports.FunctionPermissionMode = {}));
+
 exports.TaskStatus = void 0;
 (function (TaskStatus) {
     TaskStatus["NEW"] = "new";
@@ -4011,8 +4021,48 @@ var apiRequests = (client, httpAuth) => {
 };
 
 var functions = (client, httpAuth) => ({
+    async find(options) {
+        const response = await client.get(httpAuth, '/functions/', options);
+        return response.data;
+    },
+    async create(body, options) {
+        const response = await client.post(httpAuth, '/functions/', body, {
+            ...options,
+            customKeys: ['environmentVariables'],
+        });
+        return response.data;
+    },
+    async getByName(name, options) {
+        const response = await client.get(httpAuth, `/functions/${name}`, {
+            ...options,
+            customResponseKeys: ['environmentVariables'],
+        });
+        return response.data;
+    },
+    async update(name, body, options) {
+        const response = await client.put(httpAuth, `/functions/${name}`, body, {
+            ...options,
+            customRequestKeys: ['environmentVariables'],
+        });
+        return response.data;
+    },
+    async remove(name, options) {
+        const response = await client.delete(httpAuth, `/functions/${name}`, options);
+        return response.data;
+    },
+    async enable(name, options) {
+        const response = await client.post(httpAuth, `/functions/${name}/enable`, {}, options);
+        return response.data;
+    },
+    async disable(name, options) {
+        const response = await client.post(httpAuth, `/functions/${name}/disable`, {}, options);
+        return response.data;
+    },
     async execute(functionName, data, options) {
-        const response = await client.post(httpAuth, `/functions/${functionName}/execute`, { data }, { ...options, customKeys: ['data', 'result'] });
+        const response = await client.post(httpAuth, `/functions/${functionName}/execute`, { data }, {
+            ...options,
+            customKeys: ['data', 'result'],
+        });
         return response.data;
     },
 });
@@ -5610,7 +5660,7 @@ const templatesV2Service = (httpWithAuth) => {
     };
 };
 
-const version = '8.9.0-dev-135-f1c216a';
+const version = '8.9.0-dev-137-14a5300';
 
 /**
  * Create ExtraHorizon client.

package/build/index.mjs

@@ -969,6 +969,16 @@ var ApiRequestErrorType;
     ApiRequestErrorType["RESPONSE"] = "response";
 })(ApiRequestErrorType || (ApiRequestErrorType = {}));
 
+var FunctionPermissionMode;
+(function (FunctionPermissionMode) {
+    /** To execute this function directly the user needs the EXECUTE_TASK_FUNCTION permission */
+    FunctionPermissionMode["PERMISSION_REQUIRED"] = "permissionRequired";
+    /** Every logged in user can execute this function directly */
+    FunctionPermissionMode["ALL_USERS"] = "allUsers";
+    /** The function can be executed even by unauthenticated requests */
+    FunctionPermissionMode["PUBLIC"] = "public";
+})(FunctionPermissionMode || (FunctionPermissionMode = {}));
+
 var TaskStatus;
 (function (TaskStatus) {
     TaskStatus["NEW"] = "new";
@@ -3981,8 +3991,48 @@ var apiRequests = (client, httpAuth) => {
 };
 
 var functions = (client, httpAuth) => ({
+    async find(options) {
+        const response = await client.get(httpAuth, '/functions/', options);
+        return response.data;
+    },
+    async create(body, options) {
+        const response = await client.post(httpAuth, '/functions/', body, {
+            ...options,
+            customKeys: ['environmentVariables'],
+        });
+        return response.data;
+    },
+    async getByName(name, options) {
+        const response = await client.get(httpAuth, `/functions/${name}`, {
+            ...options,
+            customResponseKeys: ['environmentVariables'],
+        });
+        return response.data;
+    },
+    async update(name, body, options) {
+        const response = await client.put(httpAuth, `/functions/${name}`, body, {
+            ...options,
+            customRequestKeys: ['environmentVariables'],
+        });
+        return response.data;
+    },
+    async remove(name, options) {
+        const response = await client.delete(httpAuth, `/functions/${name}`, options);
+        return response.data;
+    },
+    async enable(name, options) {
+        const response = await client.post(httpAuth, `/functions/${name}/enable`, {}, options);
+        return response.data;
+    },
+    async disable(name, options) {
+        const response = await client.post(httpAuth, `/functions/${name}/disable`, {}, options);
+        return response.data;
+    },
     async execute(functionName, data, options) {
-        const response = await client.post(httpAuth, `/functions/${functionName}/execute`, { data }, { ...options, customKeys: ['data', 'result'] });
+        const response = await client.post(httpAuth, `/functions/${functionName}/execute`, { data }, {
+            ...options,
+            customKeys: ['data', 'result'],
+        });
         return response.data;
     },
 });
@@ -5580,7 +5630,7 @@ const templatesV2Service = (httpWithAuth) => {
     };
 };
 
-const version = '8.9.0-dev-135-f1c216a';
+const version = '8.9.0-dev-137-14a5300';
 
 /**
  * Create ExtraHorizon client.
@@ -5760,4 +5810,4 @@ const parseStoredCredentials = (fileContent) => exhCredentialsDecoder(fileConten
     .filter(line => line.length === 2)
     .reduce((memo, [key, value]) => ({ ...memo, [key]: value }), {}));
 
-export { AccessTokenExpiredError, AccessTokenUnknownError, ActionType, ActivationRequestLimitError, ActivationRequestTimeoutError, ActivationUnknownError, AlreadyActivatedError, ApiError, ApiFunctionRequestMethod, ApiRequestErrorType, AppStoreTransactionAlreadyLinked, ApplicationNotAuthenticatedError, ApplicationType, ApplicationUnknownError, AuthenticationError, AuthorizationCodeExpiredError, AuthorizationUnknownError, BadGatewayServerError, BadRequestError, BodyFormatError, CallbackNotValidError, Comorbidities, DefaultLocalizationMissingError, DisabledForOidcUsersError, DuplicateRequestError, EmailUnknownError, EmailUsedError, EmptyBodyError, ErrorClassMap, FieldFormatError, FieldType, FileTooLargeError, FirebaseConnectionError, FirebaseInvalidPlatformDataError, ForbiddenError, ForgotPasswordRequestLimitError, ForgotPasswordRequestTimeoutError, Gender, GlobalPermissionName, IDFormatError, IllegalArgumentError, IllegalStateError, Impediments, IncorrectPinCodeError, InvalidClientError, InvalidCurrencyForProductPrice, InvalidGrantError, InvalidMfaCodeError, InvalidMfaTokenError, InvalidNonceError, InvalidPKCEError, InvalidPresenceTokenError, InvalidReceiptDataError, InvalidRequestError, InvalidTokenError, JSONSchemaType, LocalizationKeyMissingError, LockedDocumentError, LoginAttemptStatus, LoginFreezeError, LoginTimeoutError, MedicationFrequency, MedicationUnit, MfaReattemptDelayError, MfaRequiredError, MissingPKCEVerifierError, MissingRequiredFieldsError, NewMFARequiredError, NewPasswordHashUnknownError, NewPasswordPinCodeUnknownError, NoConfiguredAppStoreProduct, NoConfiguredPlayStoreProduct, NoMatchingPlayStoreLinkedSubscription, NoPermissionError, NotActivatedError, NotEnoughMfaMethodsError, NotFoundError, OAuth2ClientIdError, OAuth2ClientSecretError, OAuth2ErrorClassMap, OAuth2LoginError, OAuth2MissingClientCredentialsError, OauthKeyError, OauthSignatureError, OauthTokenError, OidcIdTokenError, OidcInvalidAuthorizationCodeError, OidcProviderResponseError, OrderSchemaStatus, PasswordError, PaymentIntentCreationSchemaPaymentMethodType, PaymentIntentCreationSchemaSetupPaymentMethodReuse, PinCodesNotEnabledError, PlayStoreTransactionAlreadyLinked, ProfileActivity, ProfileAlreadyExistsError, QueuedMailStatus, RefreshTokenExpiredError, RefreshTokenUnknownError, RemoveFieldError, RequestAbortedError, ResourceAlreadyExistsError, ResourceUnknownError, Results, ServerError, ServiceUnavailableError, StatusInUseError, StripePaymentMethodError, StripeRequestError, SubscriptionEntitlementSource, SubscriptionEntitlementStatus, SubscriptionEntitlementStatusCategory, SubscriptionEventSource, SubscriptionEventType, SupportedLanguageCodes, TaskStatus, TemplateFillingError, TemplateResolvingError, TemplateSyntaxError, TokenNotDeleteableError, TokenPermission, TooManyFailedAttemptsError, UnauthorizedClientError, UnauthorizedError, UnauthorizedTokenError, UnknownReceiptTransactionError, UnsupportedGrantError, UnsupportedGrantTypeError, UnsupportedResponseTypeError, UserNotAuthenticatedError, createClient, createOAuth1Client, createOAuth2Client, createProxyClient, findAllGeneric, findAllIterator, getMockSdkOAuth2 as getMockSdk, getMockSdkOAuth1, getMockSdkOAuth2, getMockSdkProxy, parseGlobalPermissions, parseStoredCredentials, recursiveMap, rqlBuilder, rqlParser };
+export { AccessTokenExpiredError, AccessTokenUnknownError, ActionType, ActivationRequestLimitError, ActivationRequestTimeoutError, ActivationUnknownError, AlreadyActivatedError, ApiError, ApiFunctionRequestMethod, ApiRequestErrorType, AppStoreTransactionAlreadyLinked, ApplicationNotAuthenticatedError, ApplicationType, ApplicationUnknownError, AuthenticationError, AuthorizationCodeExpiredError, AuthorizationUnknownError, BadGatewayServerError, BadRequestError, BodyFormatError, CallbackNotValidError, Comorbidities, DefaultLocalizationMissingError, DisabledForOidcUsersError, DuplicateRequestError, EmailUnknownError, EmailUsedError, EmptyBodyError, ErrorClassMap, FieldFormatError, FieldType, FileTooLargeError, FirebaseConnectionError, FirebaseInvalidPlatformDataError, ForbiddenError, ForgotPasswordRequestLimitError, ForgotPasswordRequestTimeoutError, FunctionPermissionMode, Gender, GlobalPermissionName, IDFormatError, IllegalArgumentError, IllegalStateError, Impediments, IncorrectPinCodeError, InvalidClientError, InvalidCurrencyForProductPrice, InvalidGrantError, InvalidMfaCodeError, InvalidMfaTokenError, InvalidNonceError, InvalidPKCEError, InvalidPresenceTokenError, InvalidReceiptDataError, InvalidRequestError, InvalidTokenError, JSONSchemaType, LocalizationKeyMissingError, LockedDocumentError, LoginAttemptStatus, LoginFreezeError, LoginTimeoutError, MedicationFrequency, MedicationUnit, MfaReattemptDelayError, MfaRequiredError, MissingPKCEVerifierError, MissingRequiredFieldsError, NewMFARequiredError, NewPasswordHashUnknownError, NewPasswordPinCodeUnknownError, NoConfiguredAppStoreProduct, NoConfiguredPlayStoreProduct, NoMatchingPlayStoreLinkedSubscription, NoPermissionError, NotActivatedError, NotEnoughMfaMethodsError, NotFoundError, OAuth2ClientIdError, OAuth2ClientSecretError, OAuth2ErrorClassMap, OAuth2LoginError, OAuth2MissingClientCredentialsError, OauthKeyError, OauthSignatureError, OauthTokenError, OidcIdTokenError, OidcInvalidAuthorizationCodeError, OidcProviderResponseError, OrderSchemaStatus, PasswordError, PaymentIntentCreationSchemaPaymentMethodType, PaymentIntentCreationSchemaSetupPaymentMethodReuse, PinCodesNotEnabledError, PlayStoreTransactionAlreadyLinked, ProfileActivity, ProfileAlreadyExistsError, QueuedMailStatus, RefreshTokenExpiredError, RefreshTokenUnknownError, RemoveFieldError, RequestAbortedError, ResourceAlreadyExistsError, ResourceUnknownError, Results, ServerError, ServiceUnavailableError, StatusInUseError, StripePaymentMethodError, StripeRequestError, SubscriptionEntitlementSource, SubscriptionEntitlementStatus, SubscriptionEntitlementStatusCategory, SubscriptionEventSource, SubscriptionEventType, SupportedLanguageCodes, TaskStatus, TemplateFillingError, TemplateResolvingError, TemplateSyntaxError, TokenNotDeleteableError, TokenPermission, TooManyFailedAttemptsError, UnauthorizedClientError, UnauthorizedError, UnauthorizedTokenError, UnknownReceiptTransactionError, UnsupportedGrantError, UnsupportedGrantTypeError, UnsupportedResponseTypeError, UserNotAuthenticatedError, createClient, createOAuth1Client, createOAuth2Client, createProxyClient, findAllGeneric, findAllIterator, getMockSdkOAuth2 as getMockSdk, getMockSdkOAuth1, getMockSdkOAuth2, getMockSdkProxy, parseGlobalPermissions, parseStoredCredentials, recursiveMap, rqlBuilder, rqlParser };

package/build/types/mockType.d.ts

@@ -182,6 +182,13 @@ export declare type MockClientOAuth1<MockFn> = {
             findFirst: MockFn;
         };
         functions: {
+            find: MockFn;
+            create: MockFn;
+            getByName: MockFn;
+            update: MockFn;
+            remove: MockFn;
+            enable: MockFn;
+            disable: MockFn;
             execute: MockFn;
         };
         api: {
@@ -748,6 +755,13 @@ export declare type MockClientOAuth2<MockFn> = {
             findFirst: MockFn;
         };
         functions: {
+            find: MockFn;
+            create: MockFn;
+            getByName: MockFn;
+            update: MockFn;
+            remove: MockFn;
+            enable: MockFn;
+            disable: MockFn;
             execute: MockFn;
         };
         api: {
@@ -1314,6 +1328,13 @@ export declare type MockClientProxy<MockFn> = {
             findFirst: MockFn;
         };
         functions: {
+            find: MockFn;
+            create: MockFn;
+            getByName: MockFn;
+            update: MockFn;
+            remove: MockFn;
+            enable: MockFn;
+            disable: MockFn;
             execute: MockFn;
         };
         api: {

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
+     */
+    remove(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/version.d.ts

@@ -1 +1 @@
-export declare const version = "8.9.0-dev-135-f1c216a";
+export declare const version = "8.9.0-dev-137-14a5300";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@extrahorizon/javascript-sdk",
-  "version": "8.9.0-dev-135-f1c216a",
+  "version": "8.9.0-dev-137-14a5300",
   "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",