@extrahorizon/exh-cli 1.13.0-dev-165-dcc70f3 → 1.13.0-dev-170-ebde5f5

package/build/commands/settings/sync.d.ts

@@ -0,0 +1,5 @@
+import { Argv } from 'yargs';
+export declare const command = "sync";
+export declare const desc = "Synchronize Service Settings";
+export declare const builder: (yargs: Argv) => Argv<import("yargs").Omit<{}, never> & import("yargs").InferredOptionTypes<{}>>;
+export declare const handler: () => Promise<void>;

package/build/commands/settings/sync.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handler = exports.builder = exports.desc = exports.command = void 0;
+const path = require("node:path");
+const util_1 = require("../../helpers/util");
+const serviceSettingService = require("../../services/settings");
+exports.command = 'sync';
+exports.desc = 'Synchronize Service Settings';
+const builder = (yargs) => (0, util_1.epilogue)(yargs).options({});
+exports.builder = builder;
+const handler = async () => {
+    const filePath = path.join(process.cwd(), 'service-settings.json');
+    await serviceSettingService.sync(filePath);
+};
+exports.handler = handler;

package/build/commands/settings.d.ts

@@ -0,0 +1,5 @@
+import { Argv } from 'yargs';
+export declare const command = "settings <command>";
+export declare const desc = "Manage Service Settings within Extra Horizon";
+export declare const builder: (yargs: Argv) => Argv<{}>;
+export declare const handler: () => void;

package/build/commands/settings.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handler = exports.builder = exports.desc = exports.command = void 0;
+const util_1 = require("../helpers/util");
+exports.command = 'settings <command>';
+exports.desc = 'Manage Service Settings within Extra Horizon';
+const builder = (yargs) => (0, util_1.epilogue)(yargs).commandDir('settings');
+exports.builder = builder;
+const handler = () => { };
+exports.handler = handler;

package/build/commands/sync.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="yargs" />
 export declare const command = "sync";
 export declare const desc = "Sync your ExH configuration to the cloud environment";
-export declare const builder: (yargs: any) => import("yargs").Argv<import("yargs").Omit<{}, "path" | "schemas" | "dispatchers" | "tasks" | "templates" | "localizations" | "cleanDispatchers" | "ignoreSchemaVerificationErrors"> & import("yargs").InferredOptionTypes<{
+export declare const builder: (yargs: any) => import("yargs").Argv<import("yargs").Omit<{}, "path" | "settings" | "schemas" | "dispatchers" | "tasks" | "templates" | "localizations" | "cleanDispatchers" | "ignoreSchemaVerificationErrors"> & import("yargs").InferredOptionTypes<{
     path: {
         demandOption: false;
         describe: string;
@@ -42,6 +42,12 @@ export declare const builder: (yargs: any) => import("yargs").Argv<import("yargs
         type: "boolean";
         default: boolean;
     };
+    settings: {
+        demandOption: false;
+        describe: string;
+        type: "boolean";
+        default: boolean;
+    };
     ignoreSchemaVerificationErrors: {
         demandOption: false;
         describe: string;
@@ -57,5 +63,6 @@ export declare const handler: (options: {
     dispatchers?: boolean;
     cleanDispatchers?: boolean;
     localizations?: boolean;
+    settings?: boolean;
     ignoreSchemaVerificationErrors?: boolean;
 }) => Promise<void>;

package/build/commands/sync.js

@@ -12,7 +12,7 @@ const builder = (yargs) => (0, util_1.epilogue)(yargs)
     .options({
     path: {
         demandOption: false,
-        describe: `Path to folder which needs to be synchronized. The target folder should contain a ${repoConfig_1.REPO_CONFIG_FILE} file. 
+        describe: `Path to folder which needs to be synchronized. The target folder should contain a ${repoConfig_1.REPO_CONFIG_FILE} file.
 If not, the local directory is assumed with a default configuration which assumes tasks are in a 'tasks' folder, schemas in  a 'schemas' folder, etc...`,
         type: 'string',
     },
@@ -51,6 +51,12 @@ If not, the local directory is assumed with a default configuration which assume
         type: 'boolean',
         default: false,
     },
+    settings: {
+        demandOption: false,
+        describe: 'Sync service settings only',
+        type: 'boolean',
+        default: false,
+    },
     ignoreSchemaVerificationErrors: {
         demandOption: false,
         describe: 'Allow schema synchronization to proceed with validation errors.',

package/build/config-json-schemas/SettingsConfig.json

@@ -0,0 +1,123 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+        "$schema": {
+            "type": "string"
+        },
+        "users": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "passwordPolicy": {
+                    "type": "object",
+                    "additionalProperties": false,
+                    "properties": {
+                        "minimumLength": {
+                            "description": "The minimum number of characters required in a password.",
+                            "type": "integer",
+                            "minimum": 3
+                        },
+                        "maximumLength": {
+                            "description": "The maximum number of characters allowed in a password.",
+                            "type": "integer",
+                            "minimum": 3
+                        },
+                        "numberRequired": {
+                            "description": "A password must contain at least one numeric character (0-9).",
+                            "type": "boolean"
+                        },
+                        "symbolRequired": {
+                            "description": "A password must contain at least one symbol (~`!@#$%^&*()_-+={[}]|\\:;\"'<,>.?/).",
+                            "type": "boolean"
+                        },
+                        "upperCaseRequired": {
+                            "description": "A password must contain at least one uppercase letter (A-Z).",
+                            "type": "boolean"
+                        },
+                        "lowerCaseRequired": {
+                            "description": "A password must contain at least one lowercase letter (a-z).",
+                            "type": "boolean"
+                        }
+                    }
+                },
+                "emailTemplates": {
+                    "type": "object",
+                    "additionalProperties": false,
+                    "properties": {
+                        "activationEmailTemplateName": {
+                            "description": "The name of the email template used for account activation emails.",
+                            "type": "string",
+                            "minLength": 1
+                        },
+                        "reactivationEmailTemplateName": {
+                            "description": "The name of the email template used for account reactivation emails.",
+                            "type": "string",
+                            "minLength": 1
+                        },
+                        "passwordResetEmailTemplateName": {
+                            "description": "The name of the email template used for password reset emails.",
+                            "type": "string",
+                            "minLength": 1
+                        },
+                        "oidcUnlinkEmailTemplateName": {
+                            "description": "The name of the email template used for OIDC unlinking emails.",
+                            "type": "string",
+                            "minLength": 1
+                        },
+                        "oidcUnlinkPinEmailTemplateName": {
+                            "description": "The name of the email template used for OIDC unlinking PIN emails.",
+                            "type": "string",
+                            "minLength": 1
+                        },
+                        "activationPinEmailTemplateName": {
+                            "description": "The name of the email template used for account activation PIN emails.",
+                            "type": "string",
+                            "minLength": 1
+                        },
+                        "reactivationPinEmailTemplateName": {
+                            "description": "The name of the email template used for account reactivation PIN emails.",
+                            "type": "string",
+                            "minLength": 1
+                        },
+                        "passwordResetPinEmailTemplateName": {
+                            "description": "The name of the email template used for password reset PIN emails.",
+                            "type": "string",
+                            "minLength": 1
+                        }
+                    }
+                },
+                "verification": {
+                    "type": "object",
+                    "additionalProperties": false,
+                    "properties": {
+                        "enablePinCodeActivationRequests": {
+                            "description": "A PIN code can be used for account activation instead of an activation link.",
+                            "type": "boolean"
+                        },
+                        "enablePinCodeForgotPasswordRequests": {
+                            "description": "A PIN code can be used for password reset requests instead of a password reset link.",
+                            "type": "boolean"
+                        }
+                    }
+                }
+            }
+        },
+        "files": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "disableForceDownloadForMimeTypes": {
+                    "description": "All files will have a Content-Disposition header with the Attachment value when fetched, unless their MIME type matches a type in this array exactly. The Attachment value ensures files are downloaded rather than displayed directly in the browser, enhancing protection against potential XSS vulnerabilities. The value */* can be used to allow any file to be displayed by browsers, use at your own discretion.",
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "minLength": 3,
+                        "maxLength": 255
+                    }
+                }
+            }
+        }
+    }
+}

package/build/repositories/files.d.ts

@@ -0,0 +1,2 @@
+import { FileServiceSettingsUpdate } from '@extrahorizon/javascript-sdk';
+export declare function updateFileServiceSettings(settings: Partial<FileServiceSettingsUpdate>): Promise<import("@extrahorizon/javascript-sdk").AffectedRecords>;

package/build/repositories/files.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateFileServiceSettings = void 0;
+const exh_1 = require("../exh");
+async function updateFileServiceSettings(settings) {
+    return await (0, exh_1.getSdk)().files.settings.update(settings);
+}
+exports.updateFileServiceSettings = updateFileServiceSettings;

package/build/repositories/user.d.ts

@@ -1,4 +1,4 @@
-import { RegisterUserData } from '@extrahorizon/javascript-sdk';
+import { EmailTemplates, PasswordPolicy, RegisterUserData, VerificationSettings } from '@extrahorizon/javascript-sdk';
 export declare function findUserByEmail(email: string): Promise<import("@extrahorizon/javascript-sdk").UserData>;
 export declare function isEmailAvailable(email: string): Promise<boolean>;
 export declare function createUser(data: RegisterUserData): Promise<import("@extrahorizon/javascript-sdk").UserData>;
@@ -7,3 +7,6 @@ export declare function createGlobalRole(name: string, description: string): Pro
 export declare function addPermissionsToGlobalRole(name: string, permissions: string[]): Promise<import("@extrahorizon/javascript-sdk").AffectedRecords>;
 export declare function removePermissionsFromGlobalRole(name: string, permissions: string[]): Promise<import("@extrahorizon/javascript-sdk").AffectedRecords>;
 export declare function addGlobalRoleToUser(userId: string, roleId: string): Promise<import("@extrahorizon/javascript-sdk").AffectedRecords>;
+export declare function updateVerificationSettings(settings: Partial<VerificationSettings>): Promise<VerificationSettings>;
+export declare function updateEmailTemplates(emailTemplates: Partial<EmailTemplates>): Promise<EmailTemplates>;
+export declare function updatePasswordPolicy(passwordPolicy: Partial<PasswordPolicy>): Promise<PasswordPolicy>;

package/build/repositories/user.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.addGlobalRoleToUser = exports.removePermissionsFromGlobalRole = exports.addPermissionsToGlobalRole = exports.createGlobalRole = exports.findGlobalRoleByName = exports.createUser = exports.isEmailAvailable = exports.findUserByEmail = void 0;
+exports.updatePasswordPolicy = exports.updateEmailTemplates = exports.updateVerificationSettings = exports.addGlobalRoleToUser = exports.removePermissionsFromGlobalRole = exports.addPermissionsToGlobalRole = exports.createGlobalRole = exports.findGlobalRoleByName = exports.createUser = exports.isEmailAvailable = exports.findUserByEmail = void 0;
 const javascript_sdk_1 = require("@extrahorizon/javascript-sdk");
 const exh_1 = require("../exh");
 async function findUserByEmail(email) {
@@ -37,3 +37,15 @@ async function addGlobalRoleToUser(userId, roleId) {
     return await (0, exh_1.getSdk)().users.globalRoles.addToUsers((0, javascript_sdk_1.rqlBuilder)().eq('id', userId).build(), { roles: [roleId] });
 }
 exports.addGlobalRoleToUser = addGlobalRoleToUser;
+async function updateVerificationSettings(settings) {
+    return await (0, exh_1.getSdk)().users.settings.updateVerificationSettings(settings);
+}
+exports.updateVerificationSettings = updateVerificationSettings;
+async function updateEmailTemplates(emailTemplates) {
+    return await (0, exh_1.getSdk)().users.setEmailTemplates(emailTemplates);
+}
+exports.updateEmailTemplates = updateEmailTemplates;
+async function updatePasswordPolicy(passwordPolicy) {
+    return await (0, exh_1.getSdk)().users.updatePasswordPolicy(passwordPolicy);
+}
+exports.updatePasswordPolicy = updatePasswordPolicy;

package/build/services/settings/index.d.ts

@@ -0,0 +1 @@
+export { sync } from './sync';

package/build/services/settings/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sync = void 0;
+var sync_1 = require("./sync");
+Object.defineProperty(exports, "sync", { enumerable: true, get: function () { return sync_1.sync; } });

package/build/services/settings/sync.d.ts

@@ -0,0 +1 @@
+export declare function sync(path: string): Promise<void>;

package/build/services/settings/sync.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sync = void 0;
+const chalk_1 = require("chalk");
+const files_1 = require("../../repositories/files");
+const templateV2Repository = require("../../repositories/templatesV2");
+const user_1 = require("../../repositories/user");
+const readServiceSettingsFile_1 = require("./util/readServiceSettingsFile");
+async function sync(path) {
+    console.log((0, chalk_1.yellow)('Syncing service settings'));
+    const serviceSettings = await (0, readServiceSettingsFile_1.readAndValidateServiceSettingsConfig)(path);
+    await syncUserSettings(serviceSettings?.users);
+    await syncFileServiceSettings(serviceSettings?.files);
+    console.log((0, chalk_1.green)('✓ Synced service settings'));
+}
+exports.sync = sync;
+async function syncUserSettings(userServiceSettings) {
+    if (!userServiceSettings) {
+        return;
+    }
+    console.group((0, chalk_1.blue)('Syncing user service settings:'));
+    await syncPasswordPolicy(userServiceSettings.passwordPolicy);
+    await syncEmailTemplates(userServiceSettings.emailTemplates);
+    await syncVerificationSettings(userServiceSettings.verification);
+    console.groupEnd();
+    console.log((0, chalk_1.green)('✓ Synced user service settings'));
+}
+async function syncFileServiceSettings(fileServiceSettings) {
+    if (!fileServiceSettings || Object.keys(fileServiceSettings).length === 0) {
+        return;
+    }
+    console.group((0, chalk_1.blue)('Syncing file service Settings:'));
+    await (0, files_1.updateFileServiceSettings)(fileServiceSettings);
+    console.groupEnd();
+    console.log((0, chalk_1.green)('✓ Synced file service settings'));
+}
+async function syncPasswordPolicy(passwordPolicy) {
+    if (!passwordPolicy || Object.keys(passwordPolicy).length === 0) {
+        return;
+    }
+    console.log((0, chalk_1.blue)('Syncing password policy'));
+    await (0, user_1.updatePasswordPolicy)(passwordPolicy);
+    console.log((0, chalk_1.green)('✓ Synced password policy'));
+}
+async function syncEmailTemplates(emailTemplateNames) {
+    if (!emailTemplateNames || Object.keys(emailTemplateNames).length === 0) {
+        return;
+    }
+    const emailTemplates = await convertEmailTemplateNamesToIds(emailTemplateNames);
+    if (Object.keys(emailTemplates).length === 0) {
+        return;
+    }
+    console.log((0, chalk_1.blue)('Syncing email templates'));
+    await (0, user_1.updateEmailTemplates)(emailTemplates);
+    console.log((0, chalk_1.green)('✓ Synced email templates'));
+}
+async function syncVerificationSettings(verificationSettings) {
+    if (!verificationSettings || Object.keys(verificationSettings).length === 0) {
+        return;
+    }
+    console.log((0, chalk_1.blue)('Syncing verification settings'));
+    await (0, user_1.updateVerificationSettings)(verificationSettings);
+    console.log((0, chalk_1.green)('✓ Synced verification settings'));
+}
+async function convertEmailTemplateNamesToIds(emailTemplateNames) {
+    const emailTemplates = {};
+    const templateNameIdMap = {
+        activationEmailTemplateName: 'activationEmailTemplateId',
+        reactivationEmailTemplateName: 'reactivationEmailTemplateId',
+        passwordResetEmailTemplateName: 'passwordResetEmailTemplateId',
+        oidcUnlinkEmailTemplateName: 'oidcUnlinkEmailTemplateId',
+        oidcUnlinkPinEmailTemplateName: 'oidcUnlinkPinEmailTemplateId',
+        activationPinEmailTemplateName: 'activationPinEmailTemplateId',
+        reactivationPinEmailTemplateName: 'reactivationPinEmailTemplateId',
+        passwordResetPinEmailTemplateName: 'passwordResetPinEmailTemplateId',
+    };
+    for (const [nameProperty, idProperty] of Object.entries(templateNameIdMap)) {
+        if (emailTemplateNames[nameProperty]) {
+            const template = await templateV2Repository.findByName(emailTemplateNames[nameProperty]);
+            if (!template) {
+                console.log((0, chalk_1.yellow)(`⚠️  Template with name "${emailTemplateNames[nameProperty]}" not found. Skipping ${idProperty}.`));
+                continue;
+            }
+            emailTemplates[idProperty] = template.id;
+        }
+    }
+    return emailTemplates;
+}

package/build/services/settings/util/readServiceSettingsFile.d.ts

@@ -0,0 +1,19 @@
+import { FileServiceSettingsUpdate, PasswordPolicy, VerificationSettings } from '@extrahorizon/javascript-sdk';
+export interface ServiceSettingsFile {
+    users?: {
+        passwordPolicy?: Partial<PasswordPolicy>;
+        verification?: Partial<Pick<VerificationSettings, 'enablePinCodeActivationRequests' | 'enablePinCodeForgotPasswordRequests'>>;
+        emailTemplates?: Partial<{
+            activationEmailTemplateName: string;
+            reactivationEmailTemplateName: string;
+            passwordResetEmailTemplateName: string;
+            oidcUnlinkEmailTemplateName: string;
+            oidcUnlinkPinEmailTemplateName: string;
+            activationPinEmailTemplateName: string;
+            reactivationPinEmailTemplateName: string;
+            passwordResetPinEmailTemplateName: string;
+        }>;
+    };
+    files?: FileServiceSettingsUpdate;
+}
+export declare function readAndValidateServiceSettingsConfig(path: string): Promise<ServiceSettingsFile>;

package/build/services/settings/util/readServiceSettingsFile.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readAndValidateServiceSettingsConfig = void 0;
+const promises_1 = require("fs/promises");
+const serviceSettingsSchema = require("../../../config-json-schemas/SettingsConfig.json");
+const util_1 = require("../../../helpers/util");
+async function readAndValidateServiceSettingsConfig(path) {
+    let config;
+    try {
+        const buffer = await (0, promises_1.readFile)(path);
+        config = JSON.parse(buffer.toString());
+    }
+    catch (error) {
+        throw new Error(`Failed to read Service Settings from ${path}: ${error.message}`);
+    }
+    (0, util_1.ajvValidate)(serviceSettingsSchema, config);
+    return config;
+}
+exports.readAndValidateServiceSettingsConfig = readAndValidateServiceSettingsConfig;

package/build/services/sync.d.ts

@@ -1,4 +1,4 @@
-export declare function sync({ path, schemas, tasks, templates, dispatchers, cleanDispatchers, localizations, ignoreSchemaVerificationErrors, }: {
+export declare function sync({ path, schemas, tasks, templates, dispatchers, cleanDispatchers, localizations, settings, ignoreSchemaVerificationErrors, }: {
     path?: string;
     schemas?: boolean;
     tasks?: boolean;
@@ -6,5 +6,6 @@ export declare function sync({ path, schemas, tasks, templates, dispatchers, cle
     dispatchers?: boolean;
     cleanDispatchers?: boolean;
     localizations?: boolean;
+    settings?: boolean;
     ignoreSchemaVerificationErrors?: boolean;
 }): Promise<void>;

package/build/services/sync.js

@@ -8,12 +8,13 @@ const repoConfig_1 = require("../helpers/repoConfig");
 const dispatcherService = require("../services/dispatchers");
 const localizationService = require("../services/localizations");
 const schemaService = require("../services/schemas");
+const settingsService = require("../services/settings");
 const taskService = require("../services/tasks");
 const templateService = require("../services/templates");
-async function sync({ path, schemas, tasks, templates, dispatchers, cleanDispatchers, localizations, ignoreSchemaVerificationErrors, }) {
+async function sync({ path, schemas, tasks, templates, dispatchers, cleanDispatchers, localizations, settings, ignoreSchemaVerificationErrors, }) {
     const targetPath = path || '.';
     const cfg = await (0, repoConfig_1.getRepoConfig)(targetPath);
-    const syncAll = !(schemas || tasks || templates || dispatchers || localizations);
+    const syncAll = !(schemas || tasks || templates || dispatchers || localizations || settings);
     if ((syncAll || schemas) && cfg.schemas) {
         console.log(chalk.green('\n ⚙️  Syncing schemas ...'));
         for (const schema of cfg.schemas) {
@@ -49,5 +50,16 @@ async function sync({ path, schemas, tasks, templates, dispatchers, cleanDispatc
             console.log(chalk.yellow('Warning: dispatchers.json not found'));
         }
     }
+    if (syncAll || settings) {
+        const serviceSettingsPath = ospath.join(targetPath, 'service-settings.json');
+        const isValidPath = (0, fs_1.existsSync)(serviceSettingsPath);
+        if (isValidPath) {
+            console.log(chalk.green('\n ⚙️  Syncing service settings...'));
+            await settingsService.sync(serviceSettingsPath);
+        }
+        else if (settings) {
+            console.log(chalk.yellow('Warning: service-settings.json not found'));
+        }
+    }
 }
 exports.sync = sync;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@extrahorizon/exh-cli",
-  "version": "1.13.0-dev-165-dcc70f3",
+  "version": "1.13.0-dev-170-ebde5f5",
   "main": "build/index.js",
   "exports": "./build/index.js",
   "license": "MIT",
@@ -41,7 +41,7 @@
     "typescript": "4.5.5"
   },
   "dependencies": {
-    "@extrahorizon/javascript-sdk": "8.9.0",
+    "@extrahorizon/javascript-sdk": "8.9.1-dev-152-3f69109",
     "ajv": "8.18.0",
     "archiver": "^7.0.1",
     "chalk": "^4.0.0",