@extrahorizon/javascript-sdk 8.9.0-dev-136-24be1b9 → 8.9.0-dev-138-3022f93

package/CHANGELOG.md

@@ -8,7 +8,15 @@ 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.
+- Completed the `Task` type for changes made in TaskService 1.3.0 a while ago:
+  - Added the `retriedByTaskId`, `retryForTaskIds`, and `error` properties.
+  - Added the `retried` status.
+
+### Deprecated
+- `exh.tasks.schedules.delete` is deprecated in favor of `exh.tasks.schedules.remove`
+- `exh.auth.oidc.providers.delete` is deprecated in favor of `exh.auth.oidc.providers.remove`
 
 ### Fixed
 - Corrected the types for the `findFirst` (based) methods to indicate they may return `undefined` when no results are found.

package/build/index.cjs.js

@@ -999,12 +999,23 @@ 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";
     TaskStatus["IN_PROGRESS"] = "inProgress";
     TaskStatus["COMPLETE"] = "complete";
     TaskStatus["FAILED"] = "failed";
+    TaskStatus["RETRIED"] = "retried";
     TaskStatus["CANCELED"] = "canceled";
 })(exports.TaskStatus || (exports.TaskStatus = {}));
 
@@ -3464,10 +3475,13 @@ var providers = (oidcClient, httpWithAuth) => {
             const { data } = await oidcClient.post(httpWithAuth, `/oidc/providers/${providerId}/disable`, {});
             return data;
         },
-        async delete(providerId) {
+        async remove(providerId) {
             const { data } = await oidcClient.delete(httpWithAuth, `/oidc/providers/${providerId}`);
             return data;
         },
+        delete(providerId) {
+            return this.remove(providerId);
+        },
     };
 };
 
@@ -4011,8 +4025,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;
     },
 });
@@ -4047,10 +4101,13 @@ var schedules = (client, httpAuth) => {
             });
             return data;
         },
-        async delete(scheduleId, options) {
+        async remove(scheduleId, options) {
             const { data } = await client.delete(httpAuth, `/schedules/${scheduleId}`, options);
             return data;
         },
+        delete(scheduleId, options) {
+            return this.remove(scheduleId, options);
+        },
         async find(options) {
             const result = await query(options);
             return addPagersFn(query, options, result);
@@ -4258,17 +4315,6 @@ var groupRoles = (client, httpWithAuth) => ({
     },
 });
 
-var health$7 = (userClient, http) => ({
-    /**
-     * Perform a health check
-     * @returns {boolean} success
-     */
-    async health() {
-        const result = await userClient.get(http, '/health');
-        return result.status === exports.Results.Success;
-    },
-});
-
 const settingsService = (client, httpWithAuth) => ({
     async getVerificationSettings(options) {
         const response = await client.get(httpWithAuth, '/settings/verification', options);
@@ -4451,6 +4497,10 @@ var users$1 = (userClient, httpWithAuth, http) => {
             const { data } = await userClient.put(httpWithAuth, '/email_templates', templates);
             return data;
         },
+        async health() {
+            const result = await userClient.get(http, '/health');
+            return result.status === 200;
+        },
     };
 };
 
@@ -4459,7 +4509,6 @@ const usersService = (httpWithAuth, http) => {
         basePath: USER_BASE,
         transformRequestData: decamelizeRequestData,
     });
-    const healthMethods = health$7(userClient, httpWithAuth);
     const usersMethods = users$1(userClient, httpWithAuth, http);
     const groupRolesMethods = groupRoles(userClient, httpWithAuth);
     const globalRolesMethods = globalRoles(userClient, httpWithAuth);
@@ -4467,7 +4516,6 @@ const usersService = (httpWithAuth, http) => {
     const forgotPasswordRequestsMethods = forgotPasswordRequestsService(userClient, httpWithAuth);
     const settingsMethods = settingsService(userClient, httpWithAuth);
     return {
-        ...healthMethods,
         ...usersMethods,
         groupRoles: groupRolesMethods,
         globalRoles: globalRolesMethods,
@@ -4849,7 +4897,7 @@ var appStoreSubscriptions = (client, httpAuth) => ({
     },
 });
 
-var health$6 = (client, httpAuth) => ({
+var health = (client, httpAuth) => ({
     /**
      * Check if the service is available
      * @returns true if service is up and running
@@ -5053,7 +5101,7 @@ const paymentsService = (httpWithAuth) => {
         basePath: PAYMENTS_BASE,
     });
     return {
-        ...health$6(client, httpWithAuth),
+        ...health(client, httpWithAuth),
         products: products(client, httpWithAuth),
         orders: orders(client, httpWithAuth),
         subscriptions: subscriptions$1(client, httpWithAuth),
@@ -5075,17 +5123,6 @@ var countries = (client, httpAuth) => ({
     },
 });
 
-var health$5 = (client, http) => ({
-    /**
-     * Perform a health check
-     * @returns {boolean} success
-     */
-    async health() {
-        const result = await client.get(http, '/health');
-        return result.status === exports.Results.Success;
-    },
-});
-
 var languages = (client, httpAuth) => ({
     async getLanguages(options) {
         return (await client.get(httpAuth, '/languages', options)).data.data;
@@ -5119,6 +5156,10 @@ var localizations = (client, httpAuth) => ({
             customResponseKeys: ['*'],
         })).data;
     },
+    async health() {
+        const result = await client.get(httpAuth, '/health');
+        return result.status === 200;
+    },
 });
 
 const localizationsService = (httpWithAuth) => {
@@ -5127,7 +5168,6 @@ const localizationsService = (httpWithAuth) => {
         basePath: LOCALIZATIONS_BASE,
     });
     return {
-        ...health$5(client, httpWithAuth),
         ...localizations(client, httpWithAuth),
         ...countries(client, httpWithAuth),
         ...languages(client, httpWithAuth),
@@ -5152,17 +5192,6 @@ var groups = (client, httpAuth) => ({
     },
 });
 
-var health$4 = (client, httpAuth) => ({
-    /**
-     * Perform a health check for profiles service
-     * @returns {boolean} success
-     */
-    async health() {
-        const result = await client.get(httpAuth, '/health');
-        return result.status === exports.Results.Success;
-    },
-});
-
 var logs = (client, httpAuth) => {
     function partialApplyFind(profileId, groupId) {
         return async (options) => (await client.get(httpAuth, `/${profileId}/groups/${groupId}/logs/${(options === null || options === void 0 ? void 0 : options.rql) || ''}`, options)).data;
@@ -5233,6 +5262,10 @@ var profiles = (client, httpAuth) => ({
     async getImpediments(options) {
         return (await client.get(httpAuth, '/impediments', options)).data;
     },
+    async health() {
+        const result = await client.get(httpAuth, '/health');
+        return result.status === 200;
+    },
 });
 
 const profilesService = (httpWithAuth) => {
@@ -5241,24 +5274,12 @@ const profilesService = (httpWithAuth) => {
         basePath: PROFILES_BASE,
     });
     return {
-        ...health$4(client, httpWithAuth),
         ...profiles(client, httpWithAuth),
         groups: groups(client, httpWithAuth),
         logs: logs(client, httpWithAuth),
     };
 };
 
-var health$3 = (client, http) => ({
-    /**
-     * Perform a health check
-     * @returns {boolean} success
-     */
-    async health() {
-        const result = await client.get(http, '/health');
-        return result.status === exports.Results.Success;
-    },
-});
-
 var notifications = (client, httpAuth) => {
     async function find(options) {
         return (await client.get(httpAuth, `/notifications${(options === null || options === void 0 ? void 0 : options.rql) || ''}`, options)).data;
@@ -5304,6 +5325,10 @@ var notifications = (client, httpAuth) => {
         async getTypes(options) {
             return (await client.get(httpAuth, '/types', options)).data;
         },
+        async health() {
+            const result = await client.get(httpAuth, '/health');
+            return result.status === 200;
+        },
     };
 };
 
@@ -5333,23 +5358,11 @@ const notificationsService = (httpWithAuth) => {
         transformRequestData: decamelizeRequestData,
     });
     return {
-        ...health$3(client, httpWithAuth),
         ...notifications(client, httpWithAuth),
         settings: settings(client, httpWithAuth),
     };
 };
 
-var health$2 = (client, http) => ({
-    /**
-     * Perform a health check
-     * @returns {boolean} success
-     */
-    async health() {
-        const result = await client.get(http, '/health');
-        return result.status === exports.Results.Success;
-    },
-});
-
 var notificationsV2 = (client, httpWithAuth) => {
     async function find(options) {
         const result = await client.get(httpWithAuth, `/${(options === null || options === void 0 ? void 0 : options.rql) || ''}`, {
@@ -5386,6 +5399,10 @@ var notificationsV2 = (client, httpWithAuth) => {
             const rqlWithNotificationId = rqlBuilder().eq('id', notificationId).build();
             return await this.findFirst({ ...options, rql: rqlWithNotificationId });
         },
+        async health() {
+            const result = await client.get(httpWithAuth, '/health');
+            return result.status === 200;
+        },
     };
 };
 
@@ -5434,7 +5451,6 @@ const notificationsV2Service = (httpWithAuth) => {
         basePath: NOTIFICATIONS_V2_BASE,
     });
     return {
-        ...health$2(client, httpWithAuth),
         ...notificationsV2(client, httpWithAuth),
         userSettings: notificationV2UserSettings(client, httpWithAuth),
     };
@@ -5460,16 +5476,9 @@ var events = (client, httpAuth) => ({
         }
         return (await client.post(httpAuth, '/', requestBody, requestOptions)).data;
     },
-});
-
-var health$1 = (client, http) => ({
-    /**
-     * Perform a health check
-     * @returns {boolean} success
-     */
     async health() {
-        const result = await client.get(http, '/health');
-        return result.status === exports.Results.Success;
+        const result = await client.get(httpAuth, '/health');
+        return result.status === 200;
     },
 });
 
@@ -5498,7 +5507,6 @@ const eventsService = (httpWithAuth) => {
         transformRequestData: decamelizeRequestData,
     });
     return {
-        ...health$1(client, httpWithAuth),
         ...events(client, httpWithAuth),
         subscriptions: subscriptions(client, httpWithAuth),
     };
@@ -5530,17 +5538,6 @@ const logsService = (httpWithAuth) => {
     };
 };
 
-var health = (client, http) => ({
-    /**
-     * Perform a health check
-     * @returns {boolean} success
-     */
-    async health() {
-        const result = await client.get(http, '/health');
-        return result.status === exports.Results.Success;
-    },
-});
-
 var templatesV2 = (client, httpWithAuth) => {
     async function find(options) {
         const result = await client.get(httpWithAuth, `/${(options === null || options === void 0 ? void 0 : options.rql) || ''}`, {
@@ -5597,6 +5594,10 @@ var templatesV2 = (client, httpWithAuth) => {
             const result = await find(options);
             return result.data[0];
         },
+        async health() {
+            const result = await client.get(httpWithAuth, '/health');
+            return result.status === 200;
+        },
     };
 };
 
@@ -5605,12 +5606,11 @@ const templatesV2Service = (httpWithAuth) => {
         basePath: TEMPLATES_V2_BASE,
     });
     return {
-        ...health(client, httpWithAuth),
         ...templatesV2(client, httpWithAuth),
     };
 };
 
-const version = '8.9.0-dev-136-24be1b9';
+const version = '8.9.0-dev-138-3022f93';
 
 /**
  * Create ExtraHorizon client.