@extrahorizon/javascript-sdk 8.10.0-dev-159-0e9a0f1 → 8.10.0-dev-161-c1dd6ca

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

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

package/build/sha1.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Copied from https://github.com/pH200/hmacsha1-js/blob/master/index.js
+ */
+/**
+ * Computes a HMAC-SHA1 code.
+ *
+ * @param {string} k Secret key.
+ * @param {string} d Data to be hashed.
+ * @return {string} The hashed string.
+ */
+export declare function HmacSHA1(k: any, d: any, _p?: any, _z?: any): string;

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

@@ -419,22 +419,64 @@ export interface UserRoles {
     roles: ObjectId[];
 }
 export interface EmailTemplates {
-    /** Template id used by the User Service for the account activation email. */
+    /**
+     * Template id used by the User Service for the account activation email.
+     * @deprecated activationEmailTemplateId is deprecated in favor of activationEmailTemplateName
+    */
     activationEmailTemplateId: string;
-    /** Template id used by the User Service for the account reactivation email. */
+    /**
+     * Template name used by the User Service for the account activation email.
+    */
+    activationEmailTemplateName: string;
+    /**
+     * Template id used by the User Service for the account reactivation email.
+     * @deprecated reactivationEmailTemplateId is deprecated in favor of reactivationEmailTemplateName
+     */
     reactivationEmailTemplateId: string;
-    /** Template id used by the User Service for the password reset email. */
+    /** Template name used by the User Service for the account reactivation email. */
+    reactivationEmailTemplateName: string;
+    /**
+     * Template id used by the User Service for the password reset email.
+     * @deprecated passwordResetEmailTemplateId is deprecated in favor of passwordResetEmailTemplateName
+     */
     passwordResetEmailTemplateId: string;
-    /** Template id used by the User Service for the OIDC unlink email. */
+    /** Template name used by the User Service for the password reset email. */
+    passwordResetEmailTemplateName: string;
+    /**
+     * Template id used by the User Service for the OIDC unlink email.
+     * @deprecated oidcUnlinkEmailTemplateId is deprecated in favor of oidcUnlinkEmailTemplateName
+     */
     oidcUnlinkEmailTemplateId: string;
-    /** Template id used by the User Service for the OIDC unlink pin code email. */
+    /** Template name used by the User Service for the OIDC unlink email. */
+    oidcUnlinkEmailTemplateName: string;
+    /**
+     * Template id used by the User Service for the OIDC unlink pin code email.
+     * @deprecated oidcUnlinkPinEmailTemplateId is deprecated in favor of oidcUnlinkPinEmailTemplateName
+     */
     oidcUnlinkPinEmailTemplateId: string;
-    /** Template id used by the User Service for the account activation pin code email. */
+    /** Template name used by the User Service for the OIDC unlink pin code email. */
+    oidcUnlinkPinEmailTemplateName: string;
+    /**
+     * Template id used by the User Service for the account activation pin code email.
+     * @deprecated activationPinEmailTemplateId is deprecated in favor of activationPinEmailTemplateName
+     */
     activationPinEmailTemplateId: string;
-    /** Template id used by the User Service for the account reactivation pin code email. */
+    /** Template name used by the User Service for the account activation pin code email. */
+    activationPinEmailTemplateName: string;
+    /**
+     * Template id used by the User Service for the account reactivation pin code email.
+     * @deprecated reactivationPinEmailTemplateId is deprecated in favor of reactivationPinEmailTemplateName
+     */
     reactivationPinEmailTemplateId: string;
-    /** Template id used by the User Service for the password reset pin code email. */
+    /** Template name used by the User Service for the account reactivation pin code email. */
+    reactivationPinEmailTemplateName: string;
+    /**
+     * Template id used by the User Service for the password reset pin code email.
+     * @deprecated passwordResetPinEmailTemplateId is deprecated in favor of passwordResetPinEmailTemplateName
+     */
     passwordResetPinEmailTemplateId: string;
+    /** Template name used by the User Service for the password reset pin code email. */
+    passwordResetPinEmailTemplateName: string;
 }
 export interface PasswordResetRequestData {
     email: string;
@@ -897,14 +939,14 @@ export interface UsersService {
      * An email is send to the new email address with a token and instructions to reactivate the account.
      * The token should be used to complete the account activation via `exh.users.validateEmailActivation`.
      *
-     * By default the email send to the user is the email template configured by `reactivationEmailTemplateId`.
+     * By default the email send to the user is the email template configured by `reactivationEmailTemplateName`.
      * The template receives a 40 hexadecimal character hash in the `content.activation_hash` variable.
      * The hash should be used within 60 minutes, otherwise `exh.users.requestEmailActivation` should be used to request a new email.
      *
      * If enabled, a pin code can be used rather than a hash.
      * The pin code mode must be enabled by the `enablePinCodeActivationRequests` verification setting.
      * To use the pin code mode, the `activationMode` field can be set to `pin_code`.
-     * Then the email send to the user is the email template configured by `reactivationPinEmailTemplateId`.
+     * Then the email send to the user is the email template configured by `reactivationPinEmailTemplateName`.
      * The pin code template receives a 8 digit pin code in the `content.pin_code` variable.
      * The pin code should be used within 15 minutes, otherwise `exh.users.requestEmailActivation` should be used to request a new email.
      *
@@ -953,14 +995,14 @@ export interface UsersService {
      * An email is send to the supplied email address with a token and instructions to activate the account.
      * The token should be used to complete the account activation via `exh.users.validateEmailActivation`.
      *
-     * By default the email send to the user is the email template configured by `activationEmailTemplateId`.
+     * By default the email send to the user is the email template configured by `activationEmailTemplateName`.
      * The template receives a 40 hexadecimal character hash in the `content.activation_hash` variable.
      * The hash should be used within 60 minutes, otherwise `exh.users.requestEmailActivation` should be used to request a new email.
      *
      * If enabled, a pin code can be used rather than a hash.
      * The pin code mode must be enabled by the `enablePinCodeActivationRequests` verification setting.
      * To use the pin code mode, the `activationMode` field can be set to `pin_code`.
-     * Then the email send to the user is the email template configured by `activationPinEmailTemplateId`.
+     * Then the email send to the user is the email template configured by `activationPinEmailTemplateName`.
      * The pin code template receives a 8 digit pin code in the `content.pin_code` variable.
      * The pin code should be used within 15 minutes, otherwise `exh.users.requestEmailActivation` should be used to request a new email.
      *
@@ -1006,7 +1048,7 @@ export interface UsersService {
      * An email is send to the supplied email address with a token and instructions to activate the account.
      * The token should be used to complete the account activation via `exh.users.validateEmailActivation`.
      *
-     * The email send to the user is the email template configured by `activationEmailTemplateId`.
+     * The email send to the user is the email template configured by `activationEmailTemplateName`.
      * The template receives a 40 hexadecimal character hash in the `content.activation_hash` variable.
      * The hash should be used within 60 minutes, otherwise this method should be called again to request a new email.
      *
@@ -1016,7 +1058,7 @@ export interface UsersService {
      *
      * @throws {EmailUnknownError}
      * @throws {AlreadyActivatedError}
-     * @throws {IllegalStateError} Attempting to use `activationEmailTemplateId` while not configured. See `exh.users.setEmailTemplates`.
+     * @throws {IllegalStateError} Attempting to use `activationEmailTemplateName` while not configured. See `exh.users.setEmailTemplates`.
      * @throws {ActivationRequestLimitError} The maximum allowed consecutive activation requests is reached
      * @throws {ActivationRequestTimeoutError} Activation request too short after the previous one
      */
@@ -1027,14 +1069,14 @@ export interface UsersService {
      * An email is send to the supplied email address with a token and instructions to activate the account.
      * The token should be used to complete the account activation via `exh.users.validateEmailActivation`.
      *
-     * By default the email send to the user is the email template configured by `activationEmailTemplateId`.
+     * By default the email send to the user is the email template configured by `activationEmailTemplateName`.
      * The template receives a 40 hexadecimal character hash in the `content.activation_hash` variable.
      * The hash should be used within 60 minutes, otherwise this method should be called again to request a new email.
      *
      * If enabled, a pin code can be used rather than a hash.
      * The pin code mode must be enabled by the `enablePinCodeActivationRequests` verification setting.
      * To use the pin code mode, the `activationMode` field can be set to `pin_code`.
-     * Then the email send to the user is the email template configured by `activationPinEmailTemplateId`.
+     * Then the email send to the user is the email template configured by `activationPinEmailTemplateName`.
      * The pin code template receives a 8 digit pin code in the `content.pin_code` variable.
      * The pin code should be used within 15 minutes, otherwise this method should be called again to request a new email.
      *
@@ -1044,7 +1086,7 @@ export interface UsersService {
      *
      * @throws {EmailUnknownError}
      * @throws {AlreadyActivatedError}
-     * @throws {IllegalStateError} Attempting to use either `activationEmailTemplateId` or `activationPinEmailTemplateId` while not configured. See `exh.users.setEmailTemplates`.
+     * @throws {IllegalStateError} Attempting to use either `activationEmailTemplateName` or `activationPinEmailTemplateName` while not configured. See `exh.users.setEmailTemplates`.
      * @throws {ActivationRequestLimitError} The maximum allowed consecutive activation requests is reached
      * @throws {ActivationRequestTimeoutError} Activation request too short after the previous one
      */
@@ -1070,7 +1112,7 @@ export interface UsersService {
      * An email is send to the targeted user with a token and instructions to reset their password.
      * The token should be used to complete the password reset via `exh.users.validatePasswordReset`.
      *
-     * The email send to the user is the email template configured by `passwordResetEmailTemplateId`.
+     * The email send to the user is the email template configured by `passwordResetEmailTemplateName`.
      * The template receives a 40 hexadecimal character hash in the `content.reset_hash` variable.
      * The hash should be used within 60 minutes, otherwise this method should be called again to request a new email.
      *
@@ -1080,7 +1122,7 @@ export interface UsersService {
      *
      * @throws {EmailUnknownError}
      * @throws {NotActivatedError}
-     * @throws {IllegalStateError} Attempting to use either `passwordResetEmailTemplateId` or `passwordResetPinEmailTemplateId` while not configured. See `exh.users.setEmailTemplates`.
+     * @throws {IllegalStateError} Attempting to use either `passwordResetEmailTemplateName` or `passwordResetPinEmailTemplateName` while not configured. See `exh.users.setEmailTemplates`.
      * @throws {ForgotPasswordRequestLimitError} The maximum allowed consecutive forgot password requests is reached
      * @throws {ForgotPasswordRequestTimeoutError} Forgot password request too short after the previous one
      */
@@ -1091,14 +1133,14 @@ export interface UsersService {
      * An email is send to the targeted user with a token and instructions to reset their password.
      * The token should be used to complete the password reset via `exh.users.validatePasswordReset`.
      *
-     * By default the email send to the user is the email template configured by `passwordResetEmailTemplateId`.
+     * By default the email send to the user is the email template configured by `passwordResetEmailTemplateName`.
      * The template receives a 40 hexadecimal character hash in the `content.reset_hash` variable.
      * The hash should be used within 60 minutes, otherwise this method should be called again to request a new email.
      *
      * If enabled, a pin code can be used rather than a hash.
      * The pin code mode must be enabled by the `enablePinCodeForgotPasswordRequests` verification setting.
      * To use the pin code mode, the `mode` field can be set to `pin_code`.
-     * Then the email send to the user is the email template configured by `passwordResetPinEmailTemplateId`.
+     * Then the email send to the user is the email template configured by `passwordResetPinEmailTemplateName`.
      * The pin code template receives a 8 digit pin code in the `content.pin_code` variable.
      * The pin code should be used within 15 minutes, otherwise this method should be called again to request a new email.
      *
@@ -1108,7 +1150,7 @@ export interface UsersService {
      *
      * @throws {EmailUnknownError}
      * @throws {NotActivatedError}
-     * @throws {IllegalStateError} Attempting to use either `passwordResetEmailTemplateId` or `passwordResetPinEmailTemplateId` while not configured. See `exh.users.setEmailTemplates`.
+     * @throws {IllegalStateError} Attempting to use either `passwordResetEmailTemplateName` or `passwordResetPinEmailTemplateName` while not configured. See `exh.users.setEmailTemplates`.
      * @throws {DisabledForOidcUsersError}
      * @throws {PinCodesNotEnabledError} Pin codes are not enabled, please check the verification settings
      * @throws {ForgotPasswordRequestLimitError} The maximum allowed consecutive forgot password requests is reached
@@ -1213,7 +1255,7 @@ export interface UsersService {
      * @param options {@link OptionsBase} - Add options to the request
      * @returns A list of email templates {@link EmailTemplates}
      */
-    getEmailTemplates(options?: OptionsBase): Promise<EmailTemplates>;
+    getEmailTemplates(options?: OptionsBase): Promise<Partial<EmailTemplates>>;
     /**
      * ## Set the list of email templates
      *
@@ -1222,10 +1264,12 @@ export interface UsersService {
      *
      * **Notes:**
      * - This operation works as an update and will only update the templates that are provided
-     * @param templates {@link EmailTemplatesUpdate} - A partial list of email templates to update
+     * - id fields are deprecated and will be removed in a future release, it is recommended to use the name fields instead
+     * - name and id fields are mutually exclusive, e.g., setting `activation_email_template_name` will remove `activation_email_template_id` and vice versa
+     * @param templates {@link EmailTemplates} - A partial list of email templates to update
      * @returns A list of email templates {@link EmailTemplates}
      */
-    setEmailTemplates(templates: Partial<EmailTemplates>): Promise<EmailTemplates>;
+    setEmailTemplates(templates: Partial<EmailTemplates>): Promise<Partial<EmailTemplates>>;
     /**
      * Perform a health check
      * @returns {boolean} success

package/build/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "8.10.0-dev-159-0e9a0f1";
+export declare const version = "8.10.0-dev-161-c1dd6ca";

package/build/types.d.ts

@@ -0,0 +1,104 @@
+import { AxiosResponse } from 'axios';
+import { TokenDataOauth2, HttpRequestConfig } from './http/types';
+export * from './http/types';
+export * from './services/types';
+export * from './services/auth/types';
+export * from './services/data/types';
+export * from './services/files/types';
+export * from './services/tasks/types';
+export * from './services/users/types';
+export * from './services/mails/types';
+export * from './services/templates/types';
+export * from './services/templatesV2/types';
+export * from './services/configurations/types';
+export * from './services/dispatchers/types';
+export * from './services/payments/types';
+export * from './services/localizations/types';
+export * from './services/profiles/types';
+export * from './services/notifications/types';
+export * from './services/notificationsV2/types';
+export * from './services/events/types';
+export interface ParamsOauth1WithEmail {
+    email: string;
+    password: string;
+}
+export interface ParamsOauth1WithToken {
+    token: string;
+    tokenSecret: string;
+    skipTokenCheck?: boolean;
+}
+export interface ParamsOauth2AuthorizationCode {
+    code: string;
+}
+export interface ParamsOauth2Password {
+    username: string;
+    password: string;
+}
+export interface ParamsOauth2Refresh {
+    refreshToken: string;
+}
+export declare type Oauth1AuthParams = ParamsOauth1WithEmail | ParamsOauth1WithToken;
+export declare type Oauth2AuthParams = ParamsOauth2AuthorizationCode | ParamsOauth2Password | ParamsOauth2Refresh;
+export declare type AuthParams = Oauth1AuthParams | Oauth2AuthParams;
+interface ParamsBase {
+    host: string;
+    responseLogger?: (response: AxiosResponse | Error) => unknown;
+    requestLogger?: (request: HttpRequestConfig | Error) => unknown;
+    headers?: {
+        'X-Request-Service'?: string;
+        'X-Forwarded-Application'?: string;
+        'X-Forwarded-User'?: string;
+    };
+    /**
+     * @deprecated this property is only meant to be used for backwards compatibility when upgrading to v8.0.0.
+     *
+     * Key names that are not chosen by Extra Horizon where also affected by the data normalization before v8.0.0.
+     * They were converted from camel case to snake case before sending the request and the other way around before
+     * providing the response.
+     *
+     * Also fields ending with the name timestamp not chosen by extra horizon in custom properties where automatically
+     * converted to dates. Even though they could be just booleans, strings or numbers. Dates provided in such fields will
+     * now be converted to strings while all other types will stay as they are.
+     *
+     * 'records_affected', 'recordsAffected' as keys in custom properties were converted to affectedRecords. In v8.0.0
+     * they also stay as they are.
+     *
+     * To enable this behaviour again, set to true.
+     */
+    normalizeCustomData?: boolean;
+}
+export interface ParamsOauth1Consumer extends ParamsBase {
+    consumerKey: string;
+    consumerSecret: string;
+}
+export interface ParamsOauth1Token extends ParamsOauth1Consumer {
+    token: string;
+    tokenSecret: string;
+}
+export declare type ParamsOauth1 = ParamsOauth1Consumer | ParamsOauth1Token;
+export interface ParamsOauth2Client extends ParamsBase {
+    clientId: string;
+    clientSecret?: string;
+    freshTokensCallback?: (tokenData: TokenDataOauth2) => void;
+}
+export interface ParamsOauth2AccessToken extends ParamsOauth2Client {
+    refreshToken: string;
+    accessToken: string;
+    /**
+     * Can be supplied just as it is returned by the different authentication methods and the `freshTokensCallback`.
+     * Allows the SDK to continue using the supplied access token until just before it expires, then it is automatically refreshed.
+     */
+    expiresIn?: number;
+    /**
+     * Can be supplied just as it is returned by the different authentication methods and the `freshTokensCallback`.
+     * Allows the SDK to continue using the supplied access token until just before it expires, then it is automatically refreshed.
+     */
+    creationTimestamp?: Date | string;
+}
+export declare type ParamsOauth2 = ParamsOauth2Client | ParamsOauth2AccessToken;
+export declare type ParamsProxy = ParamsBase;
+interface HttpClientBase {
+    packageVersion: string;
+}
+export declare type ClientParams = ParamsOauth1 | ParamsOauth2 | ParamsProxy;
+export declare type HttpClientConfig = HttpClientBase & ClientParams;

package/build/utils.d.ts

@@ -0,0 +1,5 @@
+import { ClientParams, GlobalPermissionName } from './types';
+export declare function validateConfig<T extends ClientParams>(params: T): T;
+export declare function delay(ms: number): Promise<void>;
+/** @deprecated Any permission string is now accepted by the permission add/removing methods. The GlobalPermissionName enum can still be used as a source of known permissions. */
+export declare function parseGlobalPermissions(permissions: string[]): GlobalPermissionName[];

package/build/version.d.ts

@@ -0,0 +1 @@
+export declare const version = "8.10.0-dev-161-c1dd6ca";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@extrahorizon/javascript-sdk",
-  "version": "8.10.0-dev-159-0e9a0f1",
+  "version": "8.10.0-dev-161-c1dd6ca",
   "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",
@@ -32,7 +32,7 @@
     "build"
   ],
   "dependencies": {
-    "axios": "0.30.3",
+    "axios": "0.31.0",
     "buffer": "6.0.3",
     "fflate": "0.8.2",
     "form-data": "4.0.4",
@@ -44,7 +44,7 @@
     "@extrahorizon/eslint-config-node": "^1.6.0",
     "@rollup/plugin-json": "^4.1.0",
     "@rollup/plugin-node-resolve": "^13.1.3",
-    "@rollup/plugin-typescript": "^8.3.1",
+    "@rollup/plugin-typescript": "^8.5.0",
     "@types/jest": "^29.5.12",
     "@types/node": "^17.0.21",
     "@typescript-eslint/eslint-plugin": "^5.13.0",