@extrahorizon/javascript-sdk 8.9.0-feat-134-c0f5b9d → 8.9.0

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

@@ -1,41 +1,78 @@
 /// <reference types="node" />
 import { FindAllIterator } from '../../services/helpers';
-import { TypeConfiguration } from '../data/types';
 import { ObjectId, LanguageCode, TimeZone, PagedResult, AffectedRecords, OptionsWithRql, OptionsBase } from '../types';
-export interface TemplateOut {
-    id?: ObjectId;
-    name?: string;
-    description?: string;
-    schema?: TemplateObjectConfiguration;
-    fields?: Record<string, string>;
-    creationTimestamp?: Date;
-    updateTimestamp?: Date;
+export declare type TemplateOut = Template;
+export declare type TemplateIn = TemplateCreation;
+export interface Template {
+    id: ObjectId;
+    name: string;
+    description: string;
+    schema: TemplateObjectConfiguration;
+    fields: Record<string, string>;
+    creationTimestamp: Date;
+    updateTimestamp: Date;
 }
-export interface TemplateIn {
+export interface TemplateCreation {
     name: string;
     description: string;
     schema: TemplateObjectConfiguration;
     fields: Record<string, string>;
 }
+export declare type TemplateTypeConfiguration = TemplateObjectConfiguration | TemplateArrayConfiguration | TemplateStringConfiguration | TemplateNumberConfiguration | TemplateBooleanConfiguration | TemplateObjectIdConfiguration | TemplateDateConfiguration;
 export interface TemplateObjectConfiguration {
-    type?: 'object';
-    options?: Array<ObjectOption>;
-    fields?: Record<string, TypeConfiguration>;
+    type: 'object';
+    fields?: Record<string, TemplateTypeConfiguration>;
+    options?: TemplateObjectOption[];
+}
+export interface TemplateArrayConfiguration {
+    type: 'array';
+    type_configuration: TemplateTypeConfiguration;
+    options?: TemplateArrayOption[];
+}
+export interface TemplateStringConfiguration {
+    type: 'string';
+    options?: TemplateStringOption[];
+}
+export interface TemplateNumberConfiguration {
+    type: 'number';
+    options?: TemplateNumberOption[];
 }
-export declare type ObjectOption = ObjectMinBytesOption | ObjectMaxBytesOption;
-export interface ObjectMinBytesOption {
-    type?: ObjectMinBytesOptionType;
-    value: number;
+export interface TemplateBooleanConfiguration {
+    type: 'boolean';
 }
-export declare enum ObjectMinBytesOptionType {
-    MIN_BYTES = "min_bytes"
+export interface TemplateObjectIdConfiguration {
+    type: 'object_id';
 }
-export interface ObjectMaxBytesOption {
-    type?: ObjectMaxBytesOptionType;
-    value: number;
+export interface TemplateDateConfiguration {
+    type: 'date';
+    options?: TemplateDateOption[];
 }
-export declare enum ObjectMaxBytesOptionType {
-    MAX_BYTES = "max_bytes"
+export declare type TemplateObjectOption = TemplateObjectMinBytesOption | TemplateObjectMaxBytesOption;
+export declare type TemplateObjectMinBytesOption = TemplateTypeOption<'min_bytes', number>;
+export declare type TemplateObjectMaxBytesOption = TemplateTypeOption<'max_bytes', number>;
+export declare type TemplateNumberOption = TemplateNumberInOption | TemplateNumberMaxOption | TemplateNumberMaxSizeOption | TemplateNumberMinOption | TemplateNumberMinSizeOption | TemplateNumberSizeOption;
+export declare type TemplateNumberInOption = TemplateTypeOption<'in', number[]>;
+export declare type TemplateNumberMaxOption = TemplateTypeOption<'max', number>;
+export declare type TemplateNumberMaxSizeOption = TemplateTypeOption<'max_size', number>;
+export declare type TemplateNumberMinOption = TemplateTypeOption<'min', number>;
+export declare type TemplateNumberMinSizeOption = TemplateTypeOption<'min_size', number>;
+export declare type TemplateNumberSizeOption = TemplateTypeOption<'size', number>;
+export declare type TemplateArrayOption = TemplateArrayMaxSizeOption | TemplateArrayMinSizeOption | TemplateArraySizeOption;
+export declare type TemplateArrayMaxSizeOption = TemplateTypeOption<'max_size', number>;
+export declare type TemplateArrayMinSizeOption = TemplateTypeOption<'min_size', number>;
+export declare type TemplateArraySizeOption = TemplateTypeOption<'size', number>;
+export declare type TemplateStringOption = TemplateStringInOption | TemplateStringMaxSizeOption | TemplateStringMinSizeOption | TemplateStringRegexOption | TemplateStringSizeOption;
+export declare type TemplateStringInOption = TemplateTypeOption<'in', string[]>;
+export declare type TemplateStringRegexOption = TemplateTypeOption<'regex', string>;
+export declare type TemplateStringMaxSizeOption = TemplateTypeOption<'max_size', number>;
+export declare type TemplateStringMinSizeOption = TemplateTypeOption<'min_size', number>;
+export declare type TemplateStringSizeOption = TemplateTypeOption<'size', number>;
+export declare type TemplateDateOption = TemplateDateMaxOption | TemplateDateMinOption;
+export declare type TemplateDateMaxOption = TemplateTypeOption<'max', number>;
+export declare type TemplateDateMinOption = TemplateTypeOption<'min', number>;
+interface TemplateTypeOption<T, V> {
+    type: T;
+    value: V;
 }
 export interface CreateFile {
     /**
@@ -63,7 +100,7 @@ export interface TemplatesService {
      * @param rql Add filters to the requested list.
      * @returns PagedResult<TemplateOut>
      */
-    find(options?: OptionsWithRql): Promise<PagedResult<TemplateOut>>;
+    find(options?: OptionsWithRql): Promise<PagedResult<Template>>;
     /**
      * Request a list of all templates
      *
@@ -75,7 +112,7 @@ export interface TemplatesService {
      * @param rql Add filters to the requested list.
      * @returns TemplateOut[]
      */
-    findAll(options?: OptionsWithRql): Promise<TemplateOut[]>;
+    findAll(options?: OptionsWithRql): Promise<Template[]>;
     /**
      * Request a list of all templates
      *
@@ -85,24 +122,24 @@ export interface TemplatesService {
      * @param rql Add filters to the requested list.
      * @returns TemplateOut[]
      */
-    findAllIterator(options?: OptionsWithRql): FindAllIterator<TemplateOut>;
+    findAllIterator(options?: OptionsWithRql): FindAllIterator<Template>;
     /**
      * Find By Id
      * @param id the Id to search for
      * @returns the first element found
      */
-    findById(id: ObjectId, options?: OptionsWithRql): Promise<TemplateOut | undefined>;
+    findById(id: ObjectId, options?: OptionsWithRql): Promise<Template | undefined>;
     /**
      * Find By Name
      * @param name the name to search for
      * @returns the first element found
      */
-    findByName(name: string, options?: OptionsWithRql): Promise<TemplateOut | undefined>;
+    findByName(name: string, options?: OptionsWithRql): Promise<Template | undefined>;
     /**
      * Find First
      * @returns the first element found
      */
-    findFirst(options?: OptionsWithRql): Promise<TemplateOut | undefined>;
+    findFirst(options?: OptionsWithRql): Promise<Template | undefined>;
     /**
      * Create a new template
      *
@@ -112,7 +149,7 @@ export interface TemplatesService {
      * @param requestBody TemplateIn
      * @returns TemplateOut
      */
-    create(requestBody: TemplateIn, options?: OptionsBase): Promise<TemplateOut>;
+    create(requestBody: TemplateCreation, options?: OptionsBase): Promise<Template>;
     /**
      * Update an existing template
      *
@@ -124,7 +161,7 @@ export interface TemplatesService {
      * @returns TemplateOut
      * @throws {ResourceUnknownError}
      */
-    update(templateId: string, requestBody: TemplateIn, options?: OptionsBase): Promise<TemplateOut>;
+    update(templateId: string, requestBody: TemplateCreation, options?: OptionsBase): Promise<Template>;
     /**
      * Delete a template
      *
@@ -197,3 +234,4 @@ export interface TemplatesService {
      */
     resolveAsJsonUsingCode(templateId: string, localizationCode: string, requestBody: CreateFile, options?: OptionsBase): Promise<Record<string, string>>;
 }
+export {};

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

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

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

@@ -7,9 +7,15 @@ export interface TemplateV2 extends TemplateV2Creation {
 export interface TemplateV2Creation {
     name: string;
     description?: string;
-    properties?: Record<string, TemplateV2TypeConfiguration>;
+    inputs?: Record<string, TemplateV2TypeConfiguration>;
     outputs: Record<string, string>;
 }
+export interface TemplateV2Update {
+    name?: string;
+    description?: string | null;
+    inputs?: Record<string, TemplateV2TypeConfiguration> | null;
+    outputs?: Record<string, string>;
+}
 export declare type TemplateV2TypeConfiguration = TemplateV2ObjectConfiguration | TemplateV2ArrayConfiguration | TemplateV2StringConfiguration | TemplateV2NumberConfiguration | TemplateV2BooleanConfiguration;
 export interface TemplateV2ObjectConfiguration {
     type: 'object';
@@ -37,7 +43,7 @@ export interface TemplateV2ResolveIn<T extends Record<string, any>> {
      * 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;
+    inputs?: T;
 }
 export interface TemplatesV2ErrorInfo {
     /**
@@ -95,7 +101,7 @@ export interface TemplatesV2Service {
      * Permission | Scope | Effect
      * - | - | -
      * `CREATE_TEMPLATES` | `global` | **Required** for this endpoint
-     * @param requestBody TemplateIn
+     * @param requestBody TemplateV2Creation
      * @returns TemplateV2
      * @throws {ResourceAlreadyExistsError}
      * @throws {TemplateSyntaxError}
@@ -108,13 +114,13 @@ export interface TemplatesV2Service {
      * - | - | -
      * `UPDATE_TEMPLATES` | `global` | **Required** for this endpoint
      * @param templateIdOrName Id or Name of the targeted template
-     * @param requestBody TemplateIn
+     * @param requestBody TemplateV2Update
      * @returns TemplateV2
      * @throws {ResourceAlreadyExistsError}
      * @throws {TemplateSyntaxError}
      * @throws {ResourceUnknownError}
      */
-    update(templateIdOrName: string, requestBody: Partial<TemplateV2Creation>, options?: OptionsBase): Promise<AffectedRecords>;
+    update(templateIdOrName: string, requestBody: TemplateV2Update, options?: OptionsBase): Promise<AffectedRecords>;
     /**
      * Delete a template
      *
@@ -142,4 +148,9 @@ export interface TemplatesV2Service {
      * @throws {ResourceUnknownError}
      */
     resolve<InputData = Record<string, any>, Outputs = Record<string, string>>(templateIdOrName: string, requestBody: TemplateV2ResolveIn<InputData>, options?: OptionsBase): Promise<Outputs>;
+    /**
+     * Perform a health check
+     * @returns {boolean} success
+     */
+    health(): Promise<boolean>;
 }

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

@@ -1,13 +1,11 @@
-import type { HttpInstance } from '../../types';
+import type { HttpInstance, UsersService } from '../../types';
 import { ActivationRequestsService } from './activationRequests/types';
 import { ForgotPasswordRequestsService } from './forgotPasswordRequests/types';
 import globalRoles from './globalRoles';
 import groupRoles from './groupRoles';
-import health from './health';
 import { SettingsService } from './settings/types';
 import { UsersGlobalRolesService, UsersGroupRolesService } from './types';
-import users from './users';
-export declare const usersService: (httpWithAuth: HttpInstance, http: HttpInstance) => ReturnType<typeof users> & ReturnType<typeof health> & {
+export declare const usersService: (httpWithAuth: HttpInstance, http: HttpInstance) => UsersService & {
     globalRoles: UsersGlobalRolesService;
     groupRoles: UsersGroupRolesService;
     activationRequests: ActivationRequestsService;

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

@@ -1216,4 +1216,9 @@ export interface UsersService {
      * @returns A list of email templates {@link EmailTemplates}
      */
     setEmailTemplates(templates: Partial<EmailTemplates>): Promise<EmailTemplates>;
+    /**
+     * Perform a health check
+     * @returns {boolean} success
+     */
+    health(): Promise<boolean>;
 }

package/build/types/types.d.ts

@@ -9,6 +9,7 @@ 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';

package/build/types/version.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@extrahorizon/javascript-sdk",
-  "version": "8.9.0-feat-134-c0f5b9d",
+  "version": "8.9.0",
   "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,12 +32,12 @@
     "build"
   ],
   "dependencies": {
-    "axios": "0.30.2",
+    "axios": "0.30.3",
     "buffer": "6.0.3",
     "fflate": "0.8.2",
     "form-data": "4.0.4",
     "platform-specific": "1.1.0",
-    "qs": "6.14.1",
+    "qs": "6.14.2",
     "typescript-json-decoder": "1.0.11"
   },
   "devDependencies": {

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

@@ -1,9 +0,0 @@
-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/localizations/health.d.ts

@@ -1,9 +0,0 @@
-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/notifications/health.d.ts

@@ -1,9 +0,0 @@
-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/notificationsV2/health.d.ts

@@ -1,9 +0,0 @@
-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/profiles/health.d.ts

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

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

@@ -1,9 +0,0 @@
-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/users/health.d.ts

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