@opencrvs/toolkit 2.0.0 → 2.1.0-rc.0066f38

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (106) hide show
  1. package/README.md +15 -0
  2. package/build.sh +5 -4
  3. package/create-countryconfig/package.json +1 -1
  4. package/dist/application-config/index.js +29 -6
  5. package/dist/cli.js +3186 -4921
  6. package/dist/commons/api/router.d.ts +623 -20
  7. package/dist/commons/conditionals/conditionals.d.ts +6 -6
  8. package/dist/commons/events/ActionConfig.d.ts +237 -2
  9. package/dist/commons/events/ActionDocument.d.ts +44 -0
  10. package/dist/commons/events/ActionInput.d.ts +26 -0
  11. package/dist/commons/events/ActionType.d.ts +6 -1
  12. package/dist/commons/events/AdvancedSearchConfig.d.ts +18 -0
  13. package/dist/commons/events/AuditLog.d.ts +2 -0
  14. package/dist/commons/events/CountryConfigQueryInput.d.ts +42 -0
  15. package/dist/commons/events/Draft.d.ts +2 -0
  16. package/dist/commons/events/EventConfig.d.ts +2 -0
  17. package/dist/commons/events/EventDocument.d.ts +22 -0
  18. package/dist/commons/events/EventIndex.d.ts +25 -0
  19. package/dist/commons/events/EventMetadata.d.ts +26 -0
  20. package/dist/commons/events/FieldConfig.d.ts +15 -0
  21. package/dist/commons/events/WorkqueueConfig.d.ts +44 -2
  22. package/dist/commons/events/locations.d.ts +1 -0
  23. package/dist/commons/events/scopes.d.ts +1 -0
  24. package/dist/commons/events/state/index.d.ts +8 -0
  25. package/dist/commons/events/state/utils.d.ts +9 -0
  26. package/dist/commons/events/test.utils.d.ts +9 -1
  27. package/dist/commons/events/utils.d.ts +23 -1
  28. package/dist/conditionals/index.js +12 -5
  29. package/dist/environment/custom-types.d.ts +33 -0
  30. package/dist/environment/custom-types.d.ts.map +1 -0
  31. package/dist/environment/custom-types.js +12 -0
  32. package/dist/environment/derived-variables.d.ts +134 -0
  33. package/dist/environment/derived-variables.d.ts.map +1 -0
  34. package/dist/environment/derived-variables.js +169 -0
  35. package/dist/environment/editor-questions.d.ts +4 -0
  36. package/dist/environment/editor-questions.d.ts.map +1 -0
  37. package/dist/environment/editor-questions.js +67 -0
  38. package/dist/environment/git.d.ts +5 -0
  39. package/dist/environment/git.d.ts.map +1 -0
  40. package/dist/environment/git.js +38 -0
  41. package/dist/environment/github.d.ts +26 -0
  42. package/dist/environment/github.d.ts.map +1 -0
  43. package/dist/environment/github.js +247 -0
  44. package/dist/environment/index.d.ts +5 -0
  45. package/dist/environment/index.d.ts.map +1 -0
  46. package/dist/environment/index.js +71 -0
  47. package/dist/environment/logger.d.ts +15 -0
  48. package/dist/environment/logger.d.ts.map +1 -0
  49. package/dist/environment/logger.js +25 -0
  50. package/dist/environment/manage-users.d.ts +11 -0
  51. package/dist/environment/manage-users.d.ts.map +1 -0
  52. package/dist/environment/manage-users.js +497 -0
  53. package/dist/environment/questions-helper.d.ts +15 -0
  54. package/dist/environment/questions-helper.d.ts.map +1 -0
  55. package/dist/environment/questions-helper.js +70 -0
  56. package/dist/environment/questions.d.ts +199 -0
  57. package/dist/environment/questions.d.ts.map +1 -0
  58. package/dist/environment/questions.js +412 -0
  59. package/dist/environment/setup-environment.d.ts +2 -0
  60. package/dist/environment/setup-environment.d.ts.map +1 -0
  61. package/dist/environment/setup-environment.js +794 -0
  62. package/dist/environment/ssh-keygen.d.ts +5 -0
  63. package/dist/environment/ssh-keygen.d.ts.map +1 -0
  64. package/dist/environment/ssh-keygen.js +21 -0
  65. package/dist/environment/swarm-to-k8s.d.ts +2 -0
  66. package/dist/environment/swarm-to-k8s.d.ts.map +1 -0
  67. package/dist/environment/swarm-to-k8s.js +173 -0
  68. package/dist/environment/templates.d.ts +27 -0
  69. package/dist/environment/templates.d.ts.map +1 -0
  70. package/dist/environment/templates.js +163 -0
  71. package/dist/environment/update-workflows.d.ts +2 -0
  72. package/dist/environment/update-workflows.d.ts.map +1 -0
  73. package/dist/environment/update-workflows.js +169 -0
  74. package/dist/environment/users.d.ts +2 -0
  75. package/dist/environment/users.d.ts.map +1 -0
  76. package/dist/environment/users.js +112 -0
  77. package/dist/environment/utils.d.ts +18 -0
  78. package/dist/environment/utils.d.ts.map +1 -0
  79. package/dist/environment/utils.js +100 -0
  80. package/dist/events/index.js +272 -39
  81. package/dist/migrations/v2.0/checkout-upstream-files.d.ts +1 -1
  82. package/dist/migrations/v2.0/checkout-upstream-files.d.ts.map +1 -1
  83. package/dist/migrations/v2.0/checkout-upstream-files.js +1 -1
  84. package/dist/migrations/v2.0/index.js +88 -5139
  85. package/dist/migrations/v2.1/add-explicit-correction-flags.d.ts +3 -0
  86. package/dist/migrations/v2.1/add-explicit-correction-flags.d.ts.map +1 -0
  87. package/dist/migrations/v2.1/add-explicit-correction-flags.js +234 -0
  88. package/dist/migrations/v2.1/index.d.ts +6 -0
  89. package/dist/migrations/v2.1/index.d.ts.map +1 -0
  90. package/dist/migrations/v2.1/index.js +218 -0
  91. package/dist/notification/index.js +197 -28
  92. package/dist/scopes/index.d.ts +96 -2
  93. package/dist/scopes/index.js +12 -5
  94. package/dist/templates/charts-values/dependencies/values.override.yaml +4 -0
  95. package/dist/templates/charts-values/dependencies/values.yaml +83 -0
  96. package/dist/templates/charts-values/opencrvs-services/values.override.yaml +4 -0
  97. package/dist/templates/charts-values/opencrvs-services/values.yaml +81 -0
  98. package/dist/templates/charts-values/traefik/values.override.yaml +4 -0
  99. package/dist/templates/charts-values/traefik/values.yaml +115 -0
  100. package/dist/templates/inventory/inventory.template.yml +100 -0
  101. package/dist/templates/inventory/production.example.yml +77 -0
  102. package/dist/templates/inventory/qa.example.yml +48 -0
  103. package/opencrvs-toolkit-2.1.0-rc.0066f38.tgz +0 -0
  104. package/package.json +15 -1
  105. package/tsconfig.tsbuildinfo +1 -1
  106. package/opencrvs-toolkit-2.0.0.tgz +0 -0
@@ -0,0 +1,112 @@
1
+ "use strict";
2
+ /*
3
+ * This Source Code Form is subject to the terms of the Mozilla Public
4
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
5
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
6
+ *
7
+ * OpenCRVS is also distributed under the terms of the Civil Registration
8
+ * & Healthcare Disclaimer located at http://opencrvs.org/license.
9
+ *
10
+ * Copyright (C) The OpenCRVS Authors located at https://github.com/opencrvs/opencrvs-core/blob/master/AUTHORS.
11
+ */
12
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
13
+ if (k2 === undefined) k2 = k;
14
+ var desc = Object.getOwnPropertyDescriptor(m, k);
15
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
16
+ desc = { enumerable: true, get: function() { return m[k]; } };
17
+ }
18
+ Object.defineProperty(o, k2, desc);
19
+ }) : (function(o, m, k, k2) {
20
+ if (k2 === undefined) k2 = k;
21
+ o[k2] = m[k];
22
+ }));
23
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
24
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
25
+ }) : function(o, v) {
26
+ o["default"] = v;
27
+ });
28
+ var __importStar = (this && this.__importStar) || function (mod) {
29
+ if (mod && mod.__esModule) return mod;
30
+ var result = {};
31
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
32
+ __setModuleDefault(result, mod);
33
+ return result;
34
+ };
35
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
36
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
37
+ return new (P || (P = Promise))(function (resolve, reject) {
38
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
39
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
40
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
41
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
42
+ });
43
+ };
44
+ var __importDefault = (this && this.__importDefault) || function (mod) {
45
+ return (mod && mod.__esModule) ? mod : { "default": mod };
46
+ };
47
+ Object.defineProperty(exports, "__esModule", { value: true });
48
+ exports.manageEnvironmentUsers = manageEnvironmentUsers;
49
+ const fs = __importStar(require("fs"));
50
+ /* eslint-disable no-console */
51
+ const path = __importStar(require("path"));
52
+ const kleur_1 = __importDefault(require("kleur"));
53
+ const manage_users_1 = require("./manage-users");
54
+ const logger_1 = require("./logger");
55
+ function select(options) {
56
+ return __awaiter(this, void 0, void 0, function* () {
57
+ const inquirer = yield import('@inquirer/prompts');
58
+ return inquirer.select(options);
59
+ });
60
+ }
61
+ /**
62
+ * Allow user to select inventory file (environment from a list)
63
+ *
64
+ * @param {string} dirPath - Path to the inventory file
65
+ *
66
+ * * @returns {string} Inventory file
67
+ */
68
+ function selectInventoryFile() {
69
+ return __awaiter(this, arguments, void 0, function* (dirPath = './infrastructure/server-setup/inventory/') {
70
+ // Check if directory exists
71
+ if (!fs.existsSync(dirPath)) {
72
+ (0, logger_1.warn)(`⚠️ No environment configuration directory found at ${dirPath}`);
73
+ (0, logger_1.warn)('Hint: If this is a new infrastructure repository, run `opencrvs environment init` first.');
74
+ return null;
75
+ }
76
+ // Read and filter files
77
+ const files = fs
78
+ .readdirSync(dirPath)
79
+ .filter((file) => {
80
+ const filePath = path.join(dirPath, file);
81
+ const isFile = fs.statSync(filePath).isFile();
82
+ const ext = path.extname(file).slice(1).toLowerCase();
83
+ return isFile && (ext === 'yml' || ext === 'yaml');
84
+ })
85
+ .sort();
86
+ if (files.length === 0) {
87
+ (0, logger_1.warn)(`⚠️ No environment configuration files found at ${dirPath}`);
88
+ (0, logger_1.warn)('Hint: If this is a new infrastructure repository, run `opencrvs environment init` first.');
89
+ return null;
90
+ }
91
+ // Create choices - remove extension from display
92
+ const choices = files.map((file) => ({
93
+ name: path.basename(file, path.extname(file)),
94
+ value: path.join(dirPath, file)
95
+ }));
96
+ const selectedFile = yield select({
97
+ message: 'Select environment (inventory file) to load users:',
98
+ choices: choices
99
+ });
100
+ return selectedFile;
101
+ });
102
+ }
103
+ function manageEnvironmentUsers() {
104
+ return __awaiter(this, void 0, void 0, function* () {
105
+ console.log('\n', kleur_1.default.bold().underline('Manage users'), '\n');
106
+ const inventory_file = yield selectInventoryFile();
107
+ if (!inventory_file) {
108
+ return;
109
+ }
110
+ yield (0, manage_users_1.manageUsers)(inventory_file);
111
+ });
112
+ }
@@ -0,0 +1,18 @@
1
+ import { Secret, Variable } from './github';
2
+ import { Answers } from './custom-types';
3
+ export declare function generateLongPassword(): string;
4
+ export declare function findExistingValue<T extends string>(name: string, type: T, scope: 'ENVIRONMENT' | 'REPOSITORY', existingValues: Array<Secret | Variable>): (T extends "SECRET" ? Secret : T extends "VARIABLE" ? Variable : never) | undefined;
5
+ /**
6
+ * Merges and stores secrets in `.env.{environment}` file.
7
+ * Updates existing variables, preserves unchanged ones, adds new ones.
8
+ *
9
+ * @param environment - Environment name (e.g., 'production')
10
+ * @param answers - Variables to update: `[{ name: 'KEY', value: 'val' }]`
11
+ *
12
+ * @example
13
+ * storeSecrets('prod', [{ name: 'API_KEY', value: 'abc123' }]);
14
+ */
15
+ export declare function storeSecrets(environment: string, answers: Answers): void;
16
+ export declare function readYamlFile(filePath: any): any;
17
+ export declare function writeYamlFile(filePath: string, data: any): void;
18
+ //# sourceMappingURL=utils.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/environment/utils.ts"],"names":[],"mappings":"AAeA,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AAC3C,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAExC,wBAAgB,oBAAoB,WAMnC;AAED,wBAAgB,iBAAiB,CAAC,CAAC,SAAS,MAAM,EAChD,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,CAAC,EACP,KAAK,EAAE,aAAa,GAAG,YAAY,EACnC,cAAc,EAAE,KAAK,CAAC,MAAM,GAAG,QAAQ,CAAC,GAMpC,CAAC,CAAC,SAAS,QAAQ,GAAG,MAAM,GAAG,CAAC,SAAS,UAAU,GAAG,QAAQ,GAAG,KAAK,CAAC,GACvE,SAAS,CACd;AAED;;;;;;;;;GASG;AACH,wBAAgB,YAAY,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,QAoBjE;AAED,wBAAgB,YAAY,CAAC,QAAQ,EAAE,GAAG,GAAG,GAAG,CAG/C;AAED,wBAAgB,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,QAcxD"}
@@ -0,0 +1,100 @@
1
+ "use strict";
2
+ /*
3
+ * This Source Code Form is subject to the terms of the Mozilla Public
4
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
5
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
6
+ *
7
+ * OpenCRVS is also distributed under the terms of the Civil Registration
8
+ * & Healthcare Disclaimer located at http://opencrvs.org/license.
9
+ *
10
+ * Copyright (C) The OpenCRVS Authors located at https://github.com/opencrvs/opencrvs-core/blob/master/AUTHORS.
11
+ */
12
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
13
+ if (k2 === undefined) k2 = k;
14
+ var desc = Object.getOwnPropertyDescriptor(m, k);
15
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
16
+ desc = { enumerable: true, get: function() { return m[k]; } };
17
+ }
18
+ Object.defineProperty(o, k2, desc);
19
+ }) : (function(o, m, k, k2) {
20
+ if (k2 === undefined) k2 = k;
21
+ o[k2] = m[k];
22
+ }));
23
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
24
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
25
+ }) : function(o, v) {
26
+ o["default"] = v;
27
+ });
28
+ var __importStar = (this && this.__importStar) || function (mod) {
29
+ if (mod && mod.__esModule) return mod;
30
+ var result = {};
31
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
32
+ __setModuleDefault(result, mod);
33
+ return result;
34
+ };
35
+ var __importDefault = (this && this.__importDefault) || function (mod) {
36
+ return (mod && mod.__esModule) ? mod : { "default": mod };
37
+ };
38
+ Object.defineProperty(exports, "__esModule", { value: true });
39
+ exports.generateLongPassword = generateLongPassword;
40
+ exports.findExistingValue = findExistingValue;
41
+ exports.storeSecrets = storeSecrets;
42
+ exports.readYamlFile = readYamlFile;
43
+ exports.writeYamlFile = writeYamlFile;
44
+ const fs_1 = __importStar(require("fs"));
45
+ const yaml = __importStar(require("js-yaml"));
46
+ const dotenv_1 = __importDefault(require("dotenv"));
47
+ function generateLongPassword() {
48
+ const chars = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ';
49
+ let result = '';
50
+ for (let i = 16; i > 0; --i)
51
+ result += chars[Math.floor(Math.random() * chars.length)];
52
+ return result;
53
+ }
54
+ function findExistingValue(name, type, scope, existingValues) {
55
+ return existingValues.find((value) => value.name === name && value.type === type && value.scope === scope);
56
+ }
57
+ /**
58
+ * Merges and stores secrets in `.env.{environment}` file.
59
+ * Updates existing variables, preserves unchanged ones, adds new ones.
60
+ *
61
+ * @param environment - Environment name (e.g., 'production')
62
+ * @param answers - Variables to update: `[{ name: 'KEY', value: 'val' }]`
63
+ *
64
+ * @example
65
+ * storeSecrets('prod', [{ name: 'API_KEY', value: 'abc123' }]);
66
+ */
67
+ function storeSecrets(environment, answers) {
68
+ let envConfig = {};
69
+ try {
70
+ envConfig = dotenv_1.default.parse((0, fs_1.readFileSync)(`${process.cwd()}/.env.${environment}`));
71
+ }
72
+ catch (error) {
73
+ envConfig = {};
74
+ }
75
+ const linesFromAnswers = answers.map((update) => `${update.name}="${update.value}"`);
76
+ const linesFromEnvConfig = Object.entries(envConfig)
77
+ .filter(([name]) => !answers.find((update) => update.name === name))
78
+ .map(([name, value]) => `${name}="${value}"`);
79
+ const allLines = [...linesFromEnvConfig, ...linesFromAnswers].sort();
80
+ (0, fs_1.writeFileSync)(`.env.${environment}`, allLines.join('\n'));
81
+ }
82
+ function readYamlFile(filePath) {
83
+ const fileContent = fs_1.default.readFileSync(filePath, 'utf8');
84
+ return yaml.load(fileContent);
85
+ }
86
+ function writeYamlFile(filePath, data) {
87
+ try {
88
+ const yamlContent = yaml.dump(data, {
89
+ indent: 2,
90
+ lineWidth: -1,
91
+ flowLevel: -1, // Prevent flow style for arrays/objects
92
+ noRefs: true,
93
+ sortKeys: false
94
+ });
95
+ fs_1.default.writeFileSync(filePath, yamlContent, 'utf8');
96
+ }
97
+ catch (error) {
98
+ throw new Error(`Failed to write inventory file: ${error}`);
99
+ }
100
+ }