@opencrvs/toolkit 2.0.0-rc.b387062 → 2.0.0-rc.b4498f2

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.
@@ -39,6 +39,10 @@ exports.main = main;
39
39
  * - `actions: [{...}, {...}, ...]` -> keeps first as `action`, warns about dropped extras
40
40
  * - If `action` already exists, removes deprecated `actions` and keeps `action`
41
41
  * - Removes unsupported `action.type` values (`DEFAULT`, `VALIDATE`, etc.)
42
+ * - Ensures every workqueue ends up with a valid `action`. When none is
43
+ * present (or the existing one is unsupported), falls back to
44
+ * `action: { type: ActionType.READ }` and ensures `ActionType` is imported
45
+ * from `@opencrvs/toolkit/events` in the file.
42
46
  * - Saves modified files in-place
43
47
  */
44
48
  const ts_morph_1 = require("ts-morph");
@@ -49,6 +53,10 @@ const ACTION_PROPERTY_NAME = 'action';
49
53
  const CONDITIONALS_PROPERTY_NAME = 'conditionals';
50
54
  const TYPE_PROPERTY_NAME = 'type';
51
55
  const SLUG_PROPERTY_NAME = 'slug';
56
+ const READ_ACTION_TYPE = 'READ';
57
+ const ACTION_TYPE_IMPORT_NAME = 'ActionType';
58
+ const TOOLKIT_EVENTS_MODULE = '@opencrvs/toolkit/events';
59
+ const READ_ACTION_FALLBACK_INITIALIZER = `{ type: ${ACTION_TYPE_IMPORT_NAME}.${READ_ACTION_TYPE} }`;
52
60
  const SUPPORTED_WORKQUEUE_ACTION_TYPES = new Set([
53
61
  'READ',
54
62
  'DELETE',
@@ -96,80 +104,146 @@ function isUnsupportedActionType(action) {
96
104
  }
97
105
  return !SUPPORTED_WORKQUEUE_ACTION_TYPES.has(typeName);
98
106
  }
99
- function migrateWorkqueueActions(workqueue, relPath) {
100
- const actionsProperty = workqueue.getProperty(ACTIONS_PROPERTY_NAME);
101
- if (!actionsProperty || !ts_morph_1.Node.isPropertyAssignment(actionsProperty)) {
102
- return 0;
103
- }
104
- const actionsInitializer = actionsProperty.getInitializer();
105
- if (!actionsInitializer || !ts_morph_1.Node.isArrayLiteralExpression(actionsInitializer)) {
106
- return 0;
107
+ /**
108
+ * Ensures the workqueue has a valid singular `action` property. When the
109
+ * existing `action` is missing or has an unsupported type, replaces it with
110
+ * `action: { type: ActionType.READ }`.
111
+ *
112
+ * Returns whether anything was changed and whether the READ fallback was
113
+ * applied (so the caller can ensure `ActionType` is imported in the file).
114
+ */
115
+ function ensureValidAction(workqueue, relPath) {
116
+ const workqueueLabel = getWorkqueueLabel(workqueue);
117
+ const actionProperty = workqueue.getProperty(ACTION_PROPERTY_NAME);
118
+ if (actionProperty && ts_morph_1.Node.isPropertyAssignment(actionProperty)) {
119
+ const initializer = actionProperty.getInitializer();
120
+ if (initializer && ts_morph_1.Node.isObjectLiteralExpression(initializer)) {
121
+ if (!isUnsupportedActionType(initializer)) {
122
+ return { changed: false, usedReadFallback: false };
123
+ }
124
+ actionProperty.set({
125
+ name: ACTION_PROPERTY_NAME,
126
+ initializer: READ_ACTION_FALLBACK_INITIALIZER
127
+ });
128
+ // eslint-disable-next-line no-console
129
+ console.log(` [${relPath}] Replaced unsupported 'action' type with '${ACTION_TYPE_IMPORT_NAME}.${READ_ACTION_TYPE}' on workqueue '${workqueueLabel}'`);
130
+ return { changed: true, usedReadFallback: true };
131
+ }
107
132
  }
133
+ workqueue.addPropertyAssignment({
134
+ name: ACTION_PROPERTY_NAME,
135
+ initializer: READ_ACTION_FALLBACK_INITIALIZER
136
+ });
137
+ // eslint-disable-next-line no-console
138
+ console.log(` [${relPath}] Added default 'action: ${READ_ACTION_FALLBACK_INITIALIZER}' to workqueue '${workqueueLabel}'`);
139
+ return { changed: true, usedReadFallback: true };
140
+ }
141
+ function migrateWorkqueueActions(workqueue, relPath) {
108
142
  const workqueueLabel = getWorkqueueLabel(workqueue);
109
- const existingActionProperty = workqueue.getProperty(ACTION_PROPERTY_NAME);
110
- if (existingActionProperty) {
111
- if (ts_morph_1.Node.isPropertyAssignment(existingActionProperty)) {
112
- const existingActionInitializer = existingActionProperty.getInitializer();
113
- if (existingActionInitializer && ts_morph_1.Node.isObjectLiteralExpression(existingActionInitializer)) {
114
- const conditionalsProperty = existingActionInitializer.getProperty(CONDITIONALS_PROPERTY_NAME);
115
- if (conditionalsProperty) {
116
- conditionalsProperty.remove();
117
- // eslint-disable-next-line no-console
118
- console.log(` [${relPath}] Removed deprecated 'conditionals' from 'action' on workqueue '${workqueueLabel}'`);
143
+ const actionsProperty = workqueue.getProperty(ACTIONS_PROPERTY_NAME);
144
+ let actionsArrayMigrated = false;
145
+ if (actionsProperty && ts_morph_1.Node.isPropertyAssignment(actionsProperty)) {
146
+ const actionsInitializer = actionsProperty.getInitializer();
147
+ if (actionsInitializer &&
148
+ ts_morph_1.Node.isArrayLiteralExpression(actionsInitializer)) {
149
+ const existingActionProperty = workqueue.getProperty(ACTION_PROPERTY_NAME);
150
+ if (existingActionProperty) {
151
+ if (ts_morph_1.Node.isPropertyAssignment(existingActionProperty)) {
152
+ const existingActionInitializer = existingActionProperty.getInitializer();
153
+ if (existingActionInitializer &&
154
+ ts_morph_1.Node.isObjectLiteralExpression(existingActionInitializer)) {
155
+ const conditionalsProperty = existingActionInitializer.getProperty(CONDITIONALS_PROPERTY_NAME);
156
+ if (conditionalsProperty) {
157
+ conditionalsProperty.remove();
158
+ // eslint-disable-next-line no-console
159
+ console.log(` [${relPath}] Removed deprecated 'conditionals' from 'action' on workqueue '${workqueueLabel}'`);
160
+ }
161
+ }
119
162
  }
120
- if (isUnsupportedActionType(existingActionInitializer)) {
121
- existingActionProperty.remove();
163
+ actionsProperty.remove();
164
+ // eslint-disable-next-line no-console
165
+ console.log(` [${relPath}] Removed deprecated 'actions' from workqueue '${workqueueLabel}' (existing 'action' kept)`);
166
+ actionsArrayMigrated = true;
167
+ }
168
+ else {
169
+ const actionCandidates = actionsInitializer
170
+ .getElements()
171
+ .filter((element) => ts_morph_1.Node.isObjectLiteralExpression(element));
172
+ if (actionCandidates.length === 0) {
173
+ actionsProperty.remove();
122
174
  // eslint-disable-next-line no-console
123
- console.log(` [${relPath}] Removed unsupported 'action' type on workqueue '${workqueueLabel}'`);
175
+ console.log(` [${relPath}] Removed empty 'actions' from workqueue '${workqueueLabel}'`);
176
+ actionsArrayMigrated = true;
177
+ }
178
+ else {
179
+ if (actionCandidates.length > 1) {
180
+ const droppedCount = actionCandidates.length - 1;
181
+ // eslint-disable-next-line no-console
182
+ console.warn(` [${relPath}] Workqueue '${workqueueLabel}' has ${actionCandidates.length} actions; keeping first as 'action' and dropping ${droppedCount} extra action(s)`);
183
+ }
184
+ const conditionalsProperty = actionCandidates[0].getProperty(CONDITIONALS_PROPERTY_NAME);
185
+ if (conditionalsProperty) {
186
+ conditionalsProperty.remove();
187
+ // eslint-disable-next-line no-console
188
+ console.log(` [${relPath}] Removed deprecated 'conditionals' from migrated 'action' on workqueue '${workqueueLabel}'`);
189
+ }
190
+ if (isUnsupportedActionType(actionCandidates[0])) {
191
+ actionsProperty.remove();
192
+ // eslint-disable-next-line no-console
193
+ console.log(` [${relPath}] Removed deprecated 'actions' from workqueue '${workqueueLabel}' because action type is unsupported`);
194
+ actionsArrayMigrated = true;
195
+ }
196
+ else {
197
+ const firstActionText = actionCandidates[0].getText();
198
+ workqueue.addPropertyAssignment({
199
+ name: ACTION_PROPERTY_NAME,
200
+ initializer: firstActionText
201
+ });
202
+ actionsProperty.remove();
203
+ // eslint-disable-next-line no-console
204
+ console.log(` [${relPath}] Replaced 'actions' with 'action' on workqueue '${workqueueLabel}'`);
205
+ actionsArrayMigrated = true;
206
+ }
124
207
  }
125
208
  }
126
209
  }
127
- actionsProperty.remove();
128
- // eslint-disable-next-line no-console
129
- console.log(` [${relPath}] Removed deprecated 'actions' from workqueue '${workqueueLabel}' (existing 'action' kept)`);
130
- return 1;
131
- }
132
- const actionCandidates = actionsInitializer
133
- .getElements()
134
- .filter((element) => ts_morph_1.Node.isObjectLiteralExpression(element));
135
- if (actionCandidates.length === 0) {
136
- actionsProperty.remove();
137
- // eslint-disable-next-line no-console
138
- console.log(` [${relPath}] Removed empty 'actions' from workqueue '${workqueueLabel}'`);
139
- return 1;
140
- }
141
- if (actionCandidates.length > 1) {
142
- const droppedCount = actionCandidates.length - 1;
143
- // eslint-disable-next-line no-console
144
- console.warn(` [${relPath}] Workqueue '${workqueueLabel}' has ${actionCandidates.length} actions; keeping first as 'action' and dropping ${droppedCount} extra action(s)`);
145
- }
146
- const conditionalsProperty = actionCandidates[0].getProperty(CONDITIONALS_PROPERTY_NAME);
147
- if (conditionalsProperty) {
148
- conditionalsProperty.remove();
149
- // eslint-disable-next-line no-console
150
- console.log(` [${relPath}] Removed deprecated 'conditionals' from migrated 'action' on workqueue '${workqueueLabel}'`);
151
210
  }
152
- if (isUnsupportedActionType(actionCandidates[0])) {
153
- actionsProperty.remove();
154
- // eslint-disable-next-line no-console
155
- console.log(` [${relPath}] Removed deprecated 'actions' from workqueue '${workqueueLabel}' because action type is unsupported`);
156
- return 1;
211
+ // Always ensure the workqueue ends up with a valid `action`. This both
212
+ // covers workqueues that never had an `actions` array, and patches up
213
+ // workqueues whose existing/migrated action type is unsupported.
214
+ const fallback = ensureValidAction(workqueue, relPath);
215
+ return {
216
+ changed: actionsArrayMigrated || fallback.changed,
217
+ usedReadFallback: fallback.usedReadFallback
218
+ };
219
+ }
220
+ /**
221
+ * Ensures `import { ActionType } from '@opencrvs/toolkit/events'` exists in
222
+ * the source file, merging into any existing import declaration from the
223
+ * same module specifier.
224
+ */
225
+ function ensureActionTypeImport(sourceFile) {
226
+ const existingImport = sourceFile.getImportDeclaration((decl) => decl.getModuleSpecifierValue() === TOOLKIT_EVENTS_MODULE);
227
+ if (existingImport) {
228
+ const alreadyImported = existingImport
229
+ .getNamedImports()
230
+ .some((ni) => ni.getName() === ACTION_TYPE_IMPORT_NAME);
231
+ if (!alreadyImported) {
232
+ existingImport.addNamedImport(ACTION_TYPE_IMPORT_NAME);
233
+ }
234
+ return;
157
235
  }
158
- const firstActionText = actionCandidates[0].getText();
159
- workqueue.addPropertyAssignment({
160
- name: ACTION_PROPERTY_NAME,
161
- initializer: firstActionText
236
+ sourceFile.addImportDeclaration({
237
+ moduleSpecifier: TOOLKIT_EVENTS_MODULE,
238
+ namedImports: [ACTION_TYPE_IMPORT_NAME]
162
239
  });
163
- actionsProperty.remove();
164
- // eslint-disable-next-line no-console
165
- console.log(` [${relPath}] Replaced 'actions' with 'action' on workqueue '${workqueueLabel}'`);
166
- return 1;
167
240
  }
168
241
  function processFile(filePath, project) {
169
242
  const sourceFile = project.getSourceFile(filePath);
170
243
  if (!sourceFile)
171
244
  return 0;
172
245
  let migratedWorkqueues = 0;
246
+ let needsActionTypeImport = false;
173
247
  const relPath = path_1.default.relative(process.cwd(), filePath);
174
248
  const callExpressions = sourceFile.getDescendantsOfKind(ts_morph_1.SyntaxKind.CallExpression);
175
249
  for (const call of callExpressions) {
@@ -187,9 +261,16 @@ function processFile(filePath, project) {
187
261
  for (const element of workqueuesArg.getElements()) {
188
262
  if (!ts_morph_1.Node.isObjectLiteralExpression(element))
189
263
  continue;
190
- migratedWorkqueues += migrateWorkqueueActions(element, relPath);
264
+ const result = migrateWorkqueueActions(element, relPath);
265
+ if (result.changed)
266
+ migratedWorkqueues++;
267
+ if (result.usedReadFallback)
268
+ needsActionTypeImport = true;
191
269
  }
192
270
  }
271
+ if (needsActionTypeImport) {
272
+ ensureActionTypeImport(sourceFile);
273
+ }
193
274
  return migratedWorkqueues;
194
275
  }
195
276
  function main() {
@@ -4180,6 +4180,8 @@ var BaseActionInput = z38.object({
4180
4180
  originalActionId: UUID.optional(),
4181
4181
  // should not be part of base action.
4182
4182
  keepAssignment: z38.boolean().optional(),
4183
+ keepAssignmentIfAccepted: z38.boolean().optional(),
4184
+ keepAssignmentIfRejected: z38.boolean().optional(),
4183
4185
  // For normal users, the createdAtLocation is resolved on the backend from the user's primaryOfficeId.
4184
4186
  // @TODO: createdAtLocation should be limited to actions that system users can perform. For normal users, it should not be part of the base action.
4185
4187
  createdAtLocation: UUID.nullish().describe(
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@opencrvs/toolkit",
3
- "version": "2.0.0-rc.b387062",
3
+ "version": "2.0.0-rc.b4498f2",
4
4
  "description": "OpenCRVS toolkit for building country configurations",
5
5
  "license": "MPL-2.0",
6
6
  "bin": {