@opencrvs/toolkit 2.1.0-rc.5396c75 → 2.1.0-rc.562608b
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.
- package/README.md +3 -12
- package/build.sh +12 -4
- package/create-countryconfig/index.js +441 -59
- package/create-countryconfig/node_modules/.bin/degit +21 -0
- package/create-countryconfig/package.json +4 -1
- package/dist/application-config/index.js +362 -284
- package/dist/authentication/index.d.ts +66 -0
- package/dist/authentication/index.d.ts.map +1 -0
- package/dist/authentication/index.js +765 -0
- package/dist/cli.js +3347 -1229
- package/dist/commons/api/router.d.ts +785 -153
- package/dist/commons/application-config/index.d.ts +0 -2
- package/dist/commons/conditionals/conditionals.d.ts +6 -6
- package/dist/commons/conditionals/validate.d.ts +34 -8
- package/dist/commons/events/ActionConfig.d.ts +5 -14
- package/dist/commons/events/ActionDocument.d.ts +35 -15
- package/dist/commons/events/ActionInput.d.ts +4 -4
- package/dist/commons/events/ActionStatus.d.ts +14 -0
- package/dist/commons/events/AdvancedSearchConfig.d.ts +48 -12
- package/dist/commons/events/AuditLog.d.ts +148 -0
- package/dist/commons/events/Draft.d.ts +1 -21
- package/dist/commons/events/EventConfig.d.ts +3 -0
- package/dist/commons/events/EventDocument.d.ts +472 -4
- package/dist/commons/events/EventIndex.d.ts +3 -26
- package/dist/commons/events/EventMetadata.d.ts +1 -11
- package/dist/commons/events/EventStatus.d.ts +19 -0
- package/dist/commons/events/FieldConfig.d.ts +109 -63
- package/dist/commons/events/FieldTypeMapping.d.ts +17 -17
- package/dist/commons/events/FieldValue.d.ts +3 -2
- package/dist/commons/events/Flag.d.ts +42 -0
- package/dist/commons/events/FormConfig.d.ts +6 -0
- package/dist/commons/events/PageConfig.d.ts +4 -0
- package/dist/commons/events/PlainDate.d.ts +8 -0
- package/dist/commons/events/SummaryConfig.d.ts +249 -0
- package/dist/commons/events/WorkqueueConfig.d.ts +17 -14
- package/dist/commons/events/event.d.ts +12 -0
- package/dist/commons/events/index.d.ts +1 -0
- package/dist/commons/events/locationPayloads.d.ts +95 -0
- package/dist/commons/events/locations.d.ts +246 -13
- package/dist/commons/events/mocks.test.utils.d.ts +46 -2
- package/dist/commons/events/scopes.d.ts +21 -1
- package/dist/commons/events/test.utils.d.ts +82 -24
- package/dist/commons/events/utils.d.ts +34 -4
- package/dist/commons/notification/UserNotifications.d.ts +28 -13
- package/dist/commons/notification/dispatch.d.ts +10 -0
- package/dist/commons/notification/index.d.ts +1 -0
- package/dist/conditionals/index.js +349 -65
- package/dist/csv.d.ts +25 -0
- package/dist/csv.d.ts.map +1 -0
- package/dist/csv.js +120 -0
- package/dist/environment/index.d.ts +1 -0
- package/dist/environment/index.d.ts.map +1 -1
- package/dist/environment/index.js +12 -1
- package/dist/environment/logger.d.ts +15 -3
- package/dist/environment/logger.d.ts.map +1 -1
- package/dist/environment/manage-users.js +1 -1
- package/dist/environment/paths.d.ts +7 -0
- package/dist/environment/paths.d.ts.map +1 -0
- package/dist/environment/paths.js +72 -0
- package/dist/environment/questions.d.ts.map +1 -1
- package/dist/environment/questions.js +20 -14
- package/dist/environment/setup-environment.d.ts +1 -1
- package/dist/environment/setup-environment.d.ts.map +1 -1
- package/dist/environment/setup-environment.js +587 -562
- package/dist/environment/templates.d.ts +0 -1
- package/dist/environment/templates.d.ts.map +1 -1
- package/dist/environment/templates.js +5 -9
- package/dist/environment/update-workflows.d.ts.map +1 -1
- package/dist/environment/update-workflows.js +21 -5
- package/dist/environment/upgrade.d.ts +2 -0
- package/dist/environment/upgrade.d.ts.map +1 -0
- package/dist/environment/upgrade.js +82 -0
- package/dist/environment/users.js +11 -13
- package/dist/environment/utils.d.ts +0 -12
- package/dist/environment/utils.d.ts.map +1 -1
- package/dist/environment/utils.js +1 -28
- package/dist/events/index.js +5873 -5292
- package/dist/migrations/v2.0/checkout-upstream-files.d.ts +2 -2
- package/dist/migrations/v2.0/checkout-upstream-files.d.ts.map +1 -1
- package/dist/migrations/v2.0/checkout-upstream-files.js +2 -2
- package/dist/migrations/v2.0/convert-config-files-to-ts.d.ts.map +1 -1
- package/dist/migrations/v2.0/convert-config-files-to-ts.js +3 -10
- package/dist/migrations/v2.0/merge-infrastructure-directory.js +3 -3
- package/dist/migrations/v2.1/add-recovery-link-notifications.d.ts +3 -0
- package/dist/migrations/v2.1/add-recovery-link-notifications.d.ts.map +1 -0
- package/dist/migrations/v2.1/add-recovery-link-notifications.js +511 -0
- package/dist/migrations/v2.1/add-translations.d.ts +9 -0
- package/dist/migrations/v2.1/add-translations.d.ts.map +1 -0
- package/dist/migrations/v2.1/add-translations.js +149 -0
- package/dist/migrations/v2.1/enable-telemetry.d.ts +3 -0
- package/dist/migrations/v2.1/enable-telemetry.d.ts.map +1 -0
- package/dist/migrations/v2.1/enable-telemetry.js +455 -0
- package/dist/migrations/v2.1/index.d.ts.map +1 -1
- package/dist/migrations/v2.1/index.js +1556 -0
- package/dist/migrations/v2.1/remove-metabase-package-installs.d.ts +2 -0
- package/dist/migrations/v2.1/remove-metabase-package-installs.d.ts.map +1 -0
- package/dist/migrations/v2.1/remove-metabase-package-installs.js +161 -0
- package/dist/migrations/v2.1/remove-sentry.d.ts +3 -0
- package/dist/migrations/v2.1/remove-sentry.d.ts.map +1 -0
- package/dist/migrations/v2.1/remove-sentry.js +354 -0
- package/dist/migrations/v2.1/rename-trigger-paths.d.ts +3 -0
- package/dist/migrations/v2.1/rename-trigger-paths.d.ts.map +1 -0
- package/dist/migrations/v2.1/rename-trigger-paths.js +216 -0
- package/dist/notification/index.js +1899 -1489
- package/dist/scopes/index.d.ts +614 -36
- package/dist/scopes/index.js +351 -65
- package/dist/telemetry/index.d.ts +45 -0
- package/dist/telemetry/index.d.ts.map +1 -0
- package/dist/telemetry/index.js +43 -0
- package/dist/templates/charts-values/dependencies/values.yaml +8 -0
- package/dist/templates/charts-values/opencrvs-services/values.yaml +10 -3
- package/dist/templates/charts-values/opentelemetry/values.yaml +102 -0
- package/dist/templates/charts-values/traefik/values.yaml +23 -9
- package/dist/templates/inventory/inventory.template.yml +1 -3
- package/dist/translations/template.d.ts +11 -0
- package/dist/translations/template.d.ts.map +1 -0
- package/dist/translations/template.js +100 -0
- package/dist/verify/endpoints.d.ts +2 -0
- package/dist/verify/endpoints.d.ts.map +1 -0
- package/dist/verify/endpoints.js +510 -0
- package/opencrvs-toolkit-2.1.0-rc.562608b.tgz +0 -0
- package/package.json +13 -7
- package/tsconfig.build.json +11 -0
- package/tsconfig.build.tsbuildinfo +1 -0
- package/tsconfig.json +3 -0
- package/dist/templates/inventory/production.example.yml +0 -77
- package/dist/templates/inventory/qa.example.yml +0 -48
- package/opencrvs-toolkit-2.1.0-rc.5396c75.tgz +0 -0
- package/tsconfig.tsbuildinfo +0 -1
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
import * as z from 'zod/v4';
|
|
2
|
+
/**
|
|
3
|
+
* Input payload for creating a location: the identity fields (parent and
|
|
4
|
+
* locationType are set once, immutable thereafter) plus the first version.
|
|
5
|
+
* `id` and `versionId` may be supplied by the caller for idempotent retries.
|
|
6
|
+
* `effectiveFrom` defaults to the beginning-of-time sentinel on the server.
|
|
7
|
+
*/
|
|
8
|
+
export declare const CreateLocationPayload: z.ZodObject<{
|
|
9
|
+
id: z.ZodOptional<z.core.$ZodBranded<z.ZodUUID, "UUID", "out">>;
|
|
10
|
+
versionId: z.ZodOptional<z.core.$ZodBranded<z.ZodUUID, "UUID", "out">>;
|
|
11
|
+
name: z.ZodString;
|
|
12
|
+
externalId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
13
|
+
administrativeAreaId: z.ZodNullable<z.core.$ZodBranded<z.ZodUUID, "UUID", "out">>;
|
|
14
|
+
locationType: z.ZodNullable<z.ZodString>;
|
|
15
|
+
effectiveFrom: z.ZodOptional<z.ZodISODate>;
|
|
16
|
+
status: z.ZodDefault<z.ZodEnum<{
|
|
17
|
+
active: "active";
|
|
18
|
+
inactive: "inactive";
|
|
19
|
+
}>>;
|
|
20
|
+
}, z.core.$strip>;
|
|
21
|
+
export type CreateLocationPayload = z.infer<typeof CreateLocationPayload>;
|
|
22
|
+
/**
|
|
23
|
+
* Input payload for appending a new version to a location. A full snapshot of
|
|
24
|
+
* every versioned field is required — omitted does not mean unchanged. The
|
|
25
|
+
* schema is strict: identity fields (`administrativeAreaId`, `locationType`)
|
|
26
|
+
* are rejected rather than ignored, as they cannot change. `lastVersionId`
|
|
27
|
+
* is the optimistic-concurrency check: it must be the id of the last element
|
|
28
|
+
* the caller observed. `effectiveFrom` defaults to today on the server;
|
|
29
|
+
* supply it explicitly for idempotent retries.
|
|
30
|
+
*/
|
|
31
|
+
export declare const UpdateLocationPayload: z.ZodObject<{
|
|
32
|
+
id: z.core.$ZodBranded<z.ZodUUID, "UUID", "out">;
|
|
33
|
+
versionId: z.ZodOptional<z.core.$ZodBranded<z.ZodUUID, "UUID", "out">>;
|
|
34
|
+
name: z.ZodString;
|
|
35
|
+
externalId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
36
|
+
status: z.ZodEnum<{
|
|
37
|
+
active: "active";
|
|
38
|
+
inactive: "inactive";
|
|
39
|
+
}>;
|
|
40
|
+
effectiveFrom: z.ZodOptional<z.ZodISODate>;
|
|
41
|
+
lastVersionId: z.core.$ZodBranded<z.ZodUUID, "UUID", "out">;
|
|
42
|
+
}, z.core.$strict>;
|
|
43
|
+
export type UpdateLocationPayload = z.infer<typeof UpdateLocationPayload>;
|
|
44
|
+
/**
|
|
45
|
+
* Input payload for withdrawing a pending (future-dated) version element.
|
|
46
|
+
* Only elements whose `effectiveFrom` has not yet passed can be withdrawn.
|
|
47
|
+
*/
|
|
48
|
+
export declare const WithdrawLocationVersionPayload: z.ZodObject<{
|
|
49
|
+
id: z.core.$ZodBranded<z.ZodUUID, "UUID", "out">;
|
|
50
|
+
versionId: z.core.$ZodBranded<z.ZodUUID, "UUID", "out">;
|
|
51
|
+
}, z.core.$strip>;
|
|
52
|
+
export type WithdrawLocationVersionPayload = z.infer<typeof WithdrawLocationVersionPayload>;
|
|
53
|
+
/**
|
|
54
|
+
* Administrative-area twin of {@link CreateLocationPayload}: `parentId`
|
|
55
|
+
* instead of `administrativeAreaId`, no `locationType`.
|
|
56
|
+
*/
|
|
57
|
+
export declare const CreateAdministrativeAreaPayload: z.ZodObject<{
|
|
58
|
+
id: z.ZodOptional<z.core.$ZodBranded<z.ZodUUID, "UUID", "out">>;
|
|
59
|
+
versionId: z.ZodOptional<z.core.$ZodBranded<z.ZodUUID, "UUID", "out">>;
|
|
60
|
+
name: z.ZodString;
|
|
61
|
+
externalId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
62
|
+
parentId: z.ZodNullable<z.core.$ZodBranded<z.ZodUUID, "UUID", "out">>;
|
|
63
|
+
effectiveFrom: z.ZodOptional<z.ZodISODate>;
|
|
64
|
+
status: z.ZodDefault<z.ZodEnum<{
|
|
65
|
+
active: "active";
|
|
66
|
+
inactive: "inactive";
|
|
67
|
+
}>>;
|
|
68
|
+
}, z.core.$strip>;
|
|
69
|
+
export type CreateAdministrativeAreaPayload = z.infer<typeof CreateAdministrativeAreaPayload>;
|
|
70
|
+
/**
|
|
71
|
+
* Administrative-area twin of {@link UpdateLocationPayload} — strict for the
|
|
72
|
+
* same reason: the identity field (`parentId`) is rejected, not ignored.
|
|
73
|
+
*/
|
|
74
|
+
export declare const UpdateAdministrativeAreaPayload: z.ZodObject<{
|
|
75
|
+
id: z.core.$ZodBranded<z.ZodUUID, "UUID", "out">;
|
|
76
|
+
versionId: z.ZodOptional<z.core.$ZodBranded<z.ZodUUID, "UUID", "out">>;
|
|
77
|
+
name: z.ZodString;
|
|
78
|
+
externalId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
79
|
+
status: z.ZodEnum<{
|
|
80
|
+
active: "active";
|
|
81
|
+
inactive: "inactive";
|
|
82
|
+
}>;
|
|
83
|
+
effectiveFrom: z.ZodOptional<z.ZodISODate>;
|
|
84
|
+
lastVersionId: z.core.$ZodBranded<z.ZodUUID, "UUID", "out">;
|
|
85
|
+
}, z.core.$strict>;
|
|
86
|
+
export type UpdateAdministrativeAreaPayload = z.infer<typeof UpdateAdministrativeAreaPayload>;
|
|
87
|
+
/**
|
|
88
|
+
* Administrative-area twin of {@link WithdrawLocationVersionPayload}.
|
|
89
|
+
*/
|
|
90
|
+
export declare const WithdrawAdministrativeAreaVersionPayload: z.ZodObject<{
|
|
91
|
+
id: z.core.$ZodBranded<z.ZodUUID, "UUID", "out">;
|
|
92
|
+
versionId: z.core.$ZodBranded<z.ZodUUID, "UUID", "out">;
|
|
93
|
+
}, z.core.$strip>;
|
|
94
|
+
export type WithdrawAdministrativeAreaVersionPayload = z.infer<typeof WithdrawAdministrativeAreaVersionPayload>;
|
|
95
|
+
//# sourceMappingURL=locationPayloads.d.ts.map
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { UUID } from '../uuid';
|
|
2
2
|
import * as z from 'zod/v4';
|
|
3
|
+
import { PlainDate } from './PlainDate';
|
|
3
4
|
import { EventIndex } from './EventIndex';
|
|
4
5
|
import { ActionCreationMetadata, RegistrationCreationMetadata } from './EventMetadata';
|
|
5
6
|
import { RecordScopeV2, UserScopeV2 } from '../scopes';
|
|
@@ -11,12 +12,52 @@ export declare const LocationTypeV1: z.ZodEnum<{
|
|
|
11
12
|
HEALTH_FACILITY: "HEALTH_FACILITY";
|
|
12
13
|
}>;
|
|
13
14
|
export type LocationTypeV1 = z.infer<typeof LocationTypeV1>;
|
|
15
|
+
export declare const LocationStatus: z.ZodEnum<{
|
|
16
|
+
active: "active";
|
|
17
|
+
inactive: "inactive";
|
|
18
|
+
}>;
|
|
19
|
+
export type LocationStatus = z.infer<typeof LocationStatus>;
|
|
20
|
+
/** Thrown when a user's assigned office is inactive and must not be allowed to authenticate. */
|
|
21
|
+
export declare class InactiveOfficeError extends Error {
|
|
22
|
+
constructor(message?: string);
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* A single element of the `versions` history of a location or administrative
|
|
26
|
+
* area. Versions are sorted ascending by `effectiveFrom` ('0001-01-01' is used
|
|
27
|
+
* as the beginning-of-time sentinel). Updates only ever append, but a
|
|
28
|
+
* not-yet-effective version can be withdrawn and seeding replaces a history
|
|
29
|
+
* wholesale, so the array is not append-only.
|
|
30
|
+
*/
|
|
31
|
+
export declare const LocationVersion: z.ZodObject<{
|
|
32
|
+
versionId: z.core.$ZodBranded<z.ZodUUID, "UUID", "out">;
|
|
33
|
+
effectiveFrom: z.ZodISODate;
|
|
34
|
+
name: z.ZodString;
|
|
35
|
+
externalId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
36
|
+
status: z.ZodEnum<{
|
|
37
|
+
active: "active";
|
|
38
|
+
inactive: "inactive";
|
|
39
|
+
}>;
|
|
40
|
+
}, z.core.$strip>;
|
|
41
|
+
export type LocationVersion = z.infer<typeof LocationVersion>;
|
|
14
42
|
export declare const AdministrativeArea: z.ZodObject<{
|
|
15
43
|
id: z.core.$ZodBranded<z.ZodUUID, "UUID", "out">;
|
|
16
44
|
name: z.ZodString;
|
|
17
45
|
externalId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
18
46
|
parentId: z.ZodNullable<z.core.$ZodBranded<z.ZodUUID, "UUID", "out">>;
|
|
19
|
-
|
|
47
|
+
status: z.ZodEnum<{
|
|
48
|
+
active: "active";
|
|
49
|
+
inactive: "inactive";
|
|
50
|
+
}>;
|
|
51
|
+
versions: z.ZodArray<z.ZodObject<{
|
|
52
|
+
versionId: z.core.$ZodBranded<z.ZodUUID, "UUID", "out">;
|
|
53
|
+
effectiveFrom: z.ZodISODate;
|
|
54
|
+
name: z.ZodString;
|
|
55
|
+
externalId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
56
|
+
status: z.ZodEnum<{
|
|
57
|
+
active: "active";
|
|
58
|
+
inactive: "inactive";
|
|
59
|
+
}>;
|
|
60
|
+
}, z.core.$strip>>;
|
|
20
61
|
}, z.core.$strip>;
|
|
21
62
|
export type AdministrativeArea = z.infer<typeof AdministrativeArea>;
|
|
22
63
|
export declare const Location: z.ZodObject<{
|
|
@@ -24,10 +65,168 @@ export declare const Location: z.ZodObject<{
|
|
|
24
65
|
name: z.ZodString;
|
|
25
66
|
externalId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
26
67
|
administrativeAreaId: z.ZodNullable<z.core.$ZodBranded<z.ZodUUID, "UUID", "out">>;
|
|
27
|
-
validUntil: z.ZodNullable<z.ZodISODateTime>;
|
|
28
68
|
locationType: z.ZodNullable<z.ZodString>;
|
|
69
|
+
status: z.ZodEnum<{
|
|
70
|
+
active: "active";
|
|
71
|
+
inactive: "inactive";
|
|
72
|
+
}>;
|
|
73
|
+
versions: z.ZodArray<z.ZodObject<{
|
|
74
|
+
versionId: z.core.$ZodBranded<z.ZodUUID, "UUID", "out">;
|
|
75
|
+
effectiveFrom: z.ZodISODate;
|
|
76
|
+
name: z.ZodString;
|
|
77
|
+
externalId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
78
|
+
status: z.ZodEnum<{
|
|
79
|
+
active: "active";
|
|
80
|
+
inactive: "inactive";
|
|
81
|
+
}>;
|
|
82
|
+
}, z.core.$strip>>;
|
|
29
83
|
}, z.core.$strip>;
|
|
30
84
|
export type Location = z.infer<typeof Location>;
|
|
85
|
+
/**
|
|
86
|
+
* TEMPORARY — client-side view of {@link AdministrativeArea} with the
|
|
87
|
+
* server-flattened `name`, `status` and `externalId` removed, leaving exactly
|
|
88
|
+
* identity + versions. Every name/status read is thereby forced through the
|
|
89
|
+
* anchored resolution utilities ({@link resolveVersion}, {@link resolvePath})
|
|
90
|
+
* at compile time. Delete this type when the contract migration removes the
|
|
91
|
+
* flat fields from the server schema, at which point the wire type itself
|
|
92
|
+
* becomes identity + versions.
|
|
93
|
+
*/
|
|
94
|
+
export declare const ClientAdministrativeArea: z.ZodObject<{
|
|
95
|
+
id: z.core.$ZodBranded<z.ZodUUID, "UUID", "out">;
|
|
96
|
+
parentId: z.ZodNullable<z.core.$ZodBranded<z.ZodUUID, "UUID", "out">>;
|
|
97
|
+
versions: z.ZodArray<z.ZodObject<{
|
|
98
|
+
versionId: z.core.$ZodBranded<z.ZodUUID, "UUID", "out">;
|
|
99
|
+
effectiveFrom: z.ZodISODate;
|
|
100
|
+
name: z.ZodString;
|
|
101
|
+
externalId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
102
|
+
status: z.ZodEnum<{
|
|
103
|
+
active: "active";
|
|
104
|
+
inactive: "inactive";
|
|
105
|
+
}>;
|
|
106
|
+
}, z.core.$strip>>;
|
|
107
|
+
}, z.core.$strip>;
|
|
108
|
+
export type ClientAdministrativeArea = z.infer<typeof ClientAdministrativeArea>;
|
|
109
|
+
/**
|
|
110
|
+
* TEMPORARY — client-side view of {@link Location} with the server-flattened
|
|
111
|
+
* `name`, `status` and `externalId` removed, leaving exactly identity +
|
|
112
|
+
* versions. See {@link ClientAdministrativeArea} for the full rationale and
|
|
113
|
+
* deletion condition.
|
|
114
|
+
*/
|
|
115
|
+
export declare const ClientLocation: z.ZodObject<{
|
|
116
|
+
id: z.core.$ZodBranded<z.ZodUUID, "UUID", "out">;
|
|
117
|
+
administrativeAreaId: z.ZodNullable<z.core.$ZodBranded<z.ZodUUID, "UUID", "out">>;
|
|
118
|
+
locationType: z.ZodNullable<z.ZodString>;
|
|
119
|
+
versions: z.ZodArray<z.ZodObject<{
|
|
120
|
+
versionId: z.core.$ZodBranded<z.ZodUUID, "UUID", "out">;
|
|
121
|
+
effectiveFrom: z.ZodISODate;
|
|
122
|
+
name: z.ZodString;
|
|
123
|
+
externalId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
124
|
+
status: z.ZodEnum<{
|
|
125
|
+
active: "active";
|
|
126
|
+
inactive: "inactive";
|
|
127
|
+
}>;
|
|
128
|
+
}, z.core.$strip>>;
|
|
129
|
+
}, z.core.$strip>;
|
|
130
|
+
export type ClientLocation = z.infer<typeof ClientLocation>;
|
|
131
|
+
/**
|
|
132
|
+
* Strips the server-flattened fields from a location as it enters the
|
|
133
|
+
* client's cached maps. The wire format keeps the flat fields for
|
|
134
|
+
* compatibility; the cache must not, or devices would keep rendering names
|
|
135
|
+
* flattened before a future-dated version takes effect.
|
|
136
|
+
*/
|
|
137
|
+
export declare function toClientLocation(location: Location): ClientLocation;
|
|
138
|
+
/** See {@link toClientLocation}. */
|
|
139
|
+
export declare function toClientAdministrativeArea(area: AdministrativeArea): ClientAdministrativeArea;
|
|
140
|
+
export declare const SeededLocationVersions: z.ZodArray<z.ZodObject<{
|
|
141
|
+
versionId: z.core.$ZodBranded<z.ZodUUID, "UUID", "out">;
|
|
142
|
+
effectiveFrom: z.ZodISODate;
|
|
143
|
+
name: z.ZodString;
|
|
144
|
+
externalId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
145
|
+
status: z.ZodEnum<{
|
|
146
|
+
active: "active";
|
|
147
|
+
inactive: "inactive";
|
|
148
|
+
}>;
|
|
149
|
+
}, z.core.$strip>>;
|
|
150
|
+
export type SeededLocationVersions = z.infer<typeof SeededLocationVersions>;
|
|
151
|
+
/**
|
|
152
|
+
* Input payload for the locations `set` mutation. Carries the seedable
|
|
153
|
+
* identity and hierarchy fields, plus an optional pre-built history.
|
|
154
|
+
*
|
|
155
|
+
* Last-write-wins on history: a repeated seed of the same row replaces its
|
|
156
|
+
* stored `versions`, so a caller that means to keep one has to send it every
|
|
157
|
+
* time. Seeding is only reachable while system initialisation is incomplete,
|
|
158
|
+
* so this replaces what an earlier seed attempt wrote, never a live history.
|
|
159
|
+
*/
|
|
160
|
+
export declare const SetLocationPayload: z.ZodObject<{
|
|
161
|
+
id: z.core.$ZodBranded<z.ZodUUID, "UUID", "out">;
|
|
162
|
+
name: z.ZodString;
|
|
163
|
+
externalId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
164
|
+
administrativeAreaId: z.ZodNullable<z.core.$ZodBranded<z.ZodUUID, "UUID", "out">>;
|
|
165
|
+
locationType: z.ZodNullable<z.ZodString>;
|
|
166
|
+
versions: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
167
|
+
versionId: z.core.$ZodBranded<z.ZodUUID, "UUID", "out">;
|
|
168
|
+
effectiveFrom: z.ZodISODate;
|
|
169
|
+
name: z.ZodString;
|
|
170
|
+
externalId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
171
|
+
status: z.ZodEnum<{
|
|
172
|
+
active: "active";
|
|
173
|
+
inactive: "inactive";
|
|
174
|
+
}>;
|
|
175
|
+
}, z.core.$strip>>>;
|
|
176
|
+
}, z.core.$strip>;
|
|
177
|
+
export type SetLocationPayload = z.infer<typeof SetLocationPayload>;
|
|
178
|
+
/**
|
|
179
|
+
* Input payload for the administrative areas `set` mutation. Twin of
|
|
180
|
+
* {@link SetLocationPayload}, including the optional pre-built `versions`
|
|
181
|
+
* history and the same semantics for omitting it.
|
|
182
|
+
*/
|
|
183
|
+
export declare const SetAdministrativeAreaPayload: z.ZodObject<{
|
|
184
|
+
id: z.core.$ZodBranded<z.ZodUUID, "UUID", "out">;
|
|
185
|
+
name: z.ZodString;
|
|
186
|
+
externalId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
187
|
+
parentId: z.ZodNullable<z.core.$ZodBranded<z.ZodUUID, "UUID", "out">>;
|
|
188
|
+
versions: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
189
|
+
versionId: z.core.$ZodBranded<z.ZodUUID, "UUID", "out">;
|
|
190
|
+
effectiveFrom: z.ZodISODate;
|
|
191
|
+
name: z.ZodString;
|
|
192
|
+
externalId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
193
|
+
status: z.ZodEnum<{
|
|
194
|
+
active: "active";
|
|
195
|
+
inactive: "inactive";
|
|
196
|
+
}>;
|
|
197
|
+
}, z.core.$strip>>>;
|
|
198
|
+
}, z.core.$strip>;
|
|
199
|
+
export type SetAdministrativeAreaPayload = z.infer<typeof SetAdministrativeAreaPayload>;
|
|
200
|
+
/**
|
|
201
|
+
* Resolves the version in effect at the given anchor date.
|
|
202
|
+
*
|
|
203
|
+
* Returns the element with the greatest `effectiveFrom` that is less than or
|
|
204
|
+
* equal to `anchor`, falling back to the earliest element when the anchor
|
|
205
|
+
* precedes all versions. Assumes `versions` is sorted ascending by
|
|
206
|
+
* `effectiveFrom`. Both `effectiveFrom` and `anchor` are 'YYYY-MM-DD' strings,
|
|
207
|
+
* so plain string comparison is correct.
|
|
208
|
+
*/
|
|
209
|
+
export declare function resolveVersion<T extends {
|
|
210
|
+
effectiveFrom: string;
|
|
211
|
+
}>(versions: T[], anchor: string): T;
|
|
212
|
+
/**
|
|
213
|
+
* Whether the entity is selectable at `anchor`: it must already have a
|
|
214
|
+
* version effective by then, and the version that resolves at `anchor` must
|
|
215
|
+
* be active. `resolveVersion` alone is not enough for this — when `anchor`
|
|
216
|
+
* precedes every version it falls back to the earliest one, which would
|
|
217
|
+
* otherwise make a location created after `anchor` look selectable.
|
|
218
|
+
*/
|
|
219
|
+
export declare function isSelectableAtAnchor<T extends {
|
|
220
|
+
effectiveFrom: string;
|
|
221
|
+
status: string;
|
|
222
|
+
}>(versions: T[], anchor: string): boolean;
|
|
223
|
+
/**
|
|
224
|
+
* Whether the entity holds the given externalId with active status at the
|
|
225
|
+
* anchor date or at any point after it. Used for point-in-time uniqueness of
|
|
226
|
+
* external codes: a new holder starting at `anchor` collides when an existing
|
|
227
|
+
* holder is (or is scheduled to be) active with the code from then on.
|
|
228
|
+
*/
|
|
229
|
+
export declare function hasActiveExternalIdOnOrAfter(versions: LocationVersion[], externalId: string, anchor: string): boolean;
|
|
31
230
|
type WrapArrayPreserveNullish<V> = V extends readonly any[] ? V : NonNullable<V>[] | Extract<V, null | undefined>;
|
|
32
231
|
/**
|
|
33
232
|
* For type T, convert fields K to arrays. If field is string, convert to string[].
|
|
@@ -52,7 +251,7 @@ export type EventIndexWithAdministrativeHierarchy = Omit<ToArrayFields<EventInde
|
|
|
52
251
|
* Return false early to break out of checks as soon as possible - if any option is not satisfied, the scope does not allow access to the event, so no need to check further options.
|
|
53
252
|
*
|
|
54
253
|
*/
|
|
55
|
-
export declare function canAccessEventWithScope(event:
|
|
254
|
+
export declare function canAccessEventWithScope(event: EventIndexWithAdministrativeHierarchy, scope: RecordScopeV2, user: UserContext | SystemContext, customActionType?: string): boolean;
|
|
56
255
|
export type UserWithResolvedHierarchy = {
|
|
57
256
|
role: string;
|
|
58
257
|
administrativeHierarchy: UUID[];
|
|
@@ -73,14 +272,11 @@ export declare function canAccessOtherUserWithScopes({ scopes, userToAccess, use
|
|
|
73
272
|
*
|
|
74
273
|
* One of the scopes must allow access for the event to be accessible.
|
|
75
274
|
*/
|
|
76
|
-
export declare function userCanAccessEventWithScopes(event:
|
|
77
|
-
export declare function getAdministrativeAreaHierarchy
|
|
78
|
-
id:
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
parentId: (string & z.$brand<"UUID">) | null;
|
|
82
|
-
validUntil: string | null;
|
|
83
|
-
}[];
|
|
275
|
+
export declare function userCanAccessEventWithScopes(event: EventIndexWithAdministrativeHierarchy, scopes: RecordScopeV2[], user: UserContext | SystemContext, customActionType?: string): boolean;
|
|
276
|
+
export declare function getAdministrativeAreaHierarchy<A extends {
|
|
277
|
+
id: UUID;
|
|
278
|
+
parentId: UUID | null;
|
|
279
|
+
}>(administrativeAreaId: string | undefined | null, administrativeAreas: Map<UUID, A>): A[];
|
|
84
280
|
/**
|
|
85
281
|
* Resolves a location or administrative area UUID into a root-first hierarchy of UUIDs.
|
|
86
282
|
*
|
|
@@ -92,8 +288,45 @@ export declare function getAdministrativeAreaHierarchy(administrativeAreaId: str
|
|
|
92
288
|
* so the result is reversed to match the root-first convention used by the server.
|
|
93
289
|
*/
|
|
94
290
|
export declare function getLocationHierarchy(selectedId: UUID, context: {
|
|
95
|
-
administrativeAreas: Map<UUID,
|
|
96
|
-
|
|
291
|
+
administrativeAreas: Map<UUID, {
|
|
292
|
+
id: UUID;
|
|
293
|
+
parentId: UUID | null;
|
|
294
|
+
}>;
|
|
295
|
+
locations: Map<UUID, {
|
|
296
|
+
id: UUID;
|
|
297
|
+
administrativeAreaId: UUID | null;
|
|
298
|
+
}>;
|
|
97
299
|
}): UUID[];
|
|
300
|
+
/**
|
|
301
|
+
* A node of an anchored hierarchy path: the identity id plus the name and
|
|
302
|
+
* status in effect at the anchor date.
|
|
303
|
+
*/
|
|
304
|
+
export type ResolvedPathNode = {
|
|
305
|
+
id: UUID;
|
|
306
|
+
name: string;
|
|
307
|
+
status: LocationStatus;
|
|
308
|
+
};
|
|
309
|
+
/**
|
|
310
|
+
* Resolves a location or administrative area id into its root-first
|
|
311
|
+
* hierarchy path — leaf included — with every node's name and status
|
|
312
|
+
* resolved at the anchor date.
|
|
313
|
+
*
|
|
314
|
+
* The parent chain is identity-level and fixed for life, so the chain is
|
|
315
|
+
* constant and only each node's name/status varies with the anchor. Status is
|
|
316
|
+
* returned for callers that filter on it; an inactive node still resolves to
|
|
317
|
+
* its name. Returns an empty array for an unknown id.
|
|
318
|
+
*/
|
|
319
|
+
export declare function resolvePath(locationId: UUID, anchor: PlainDate, context: {
|
|
320
|
+
administrativeAreas: Map<UUID, {
|
|
321
|
+
id: UUID;
|
|
322
|
+
parentId: UUID | null;
|
|
323
|
+
versions: LocationVersion[];
|
|
324
|
+
}>;
|
|
325
|
+
locations: Map<UUID, {
|
|
326
|
+
id: UUID;
|
|
327
|
+
administrativeAreaId: UUID | null;
|
|
328
|
+
versions: LocationVersion[];
|
|
329
|
+
}>;
|
|
330
|
+
}): ResolvedPathNode[];
|
|
98
331
|
export {};
|
|
99
332
|
//# sourceMappingURL=locations.d.ts.map
|
|
@@ -6,14 +6,58 @@ export declare const V2_DEFAULT_MOCK_LOCATIONS_MAP: Map<string & import("zod").$
|
|
|
6
6
|
name: string;
|
|
7
7
|
externalId?: string | null | undefined;
|
|
8
8
|
administrativeAreaId: (string & import("zod").$brand<"UUID">) | null;
|
|
9
|
-
validUntil: string | null;
|
|
10
9
|
locationType: string | null;
|
|
10
|
+
status: "active" | "inactive";
|
|
11
|
+
versions: {
|
|
12
|
+
versionId: string & import("zod").$brand<"UUID">;
|
|
13
|
+
effectiveFrom: string;
|
|
14
|
+
name: string;
|
|
15
|
+
externalId?: string | null | undefined;
|
|
16
|
+
status: "active" | "inactive";
|
|
17
|
+
}[];
|
|
11
18
|
}>;
|
|
12
19
|
export declare const V2_DEFAULT_MOCK_ADMINISTRATIVE_AREAS_MAP: Map<string & import("zod").$brand<"UUID">, {
|
|
13
20
|
id: string & import("zod").$brand<"UUID">;
|
|
14
21
|
name: string;
|
|
15
22
|
externalId?: string | null | undefined;
|
|
16
23
|
parentId: (string & import("zod").$brand<"UUID">) | null;
|
|
17
|
-
|
|
24
|
+
status: "active" | "inactive";
|
|
25
|
+
versions: {
|
|
26
|
+
versionId: string & import("zod").$brand<"UUID">;
|
|
27
|
+
effectiveFrom: string;
|
|
28
|
+
name: string;
|
|
29
|
+
externalId?: string | null | undefined;
|
|
30
|
+
status: "active" | "inactive";
|
|
31
|
+
}[];
|
|
32
|
+
}>;
|
|
33
|
+
/**
|
|
34
|
+
* Stripped view of {@link V2_DEFAULT_MOCK_LOCATIONS_MAP} matching what the
|
|
35
|
+
* client's cached location map actually holds at runtime (identity +
|
|
36
|
+
* versions only). Use this — not the wire-format map above — wherever a test
|
|
37
|
+
* stands in for `useLocations().getLocations.useSuspenseQuery()`.
|
|
38
|
+
*/
|
|
39
|
+
export declare const V2_DEFAULT_MOCK_CLIENT_LOCATIONS_MAP: Map<string & import("zod").$brand<"UUID">, {
|
|
40
|
+
id: string & import("zod").$brand<"UUID">;
|
|
41
|
+
administrativeAreaId: (string & import("zod").$brand<"UUID">) | null;
|
|
42
|
+
locationType: string | null;
|
|
43
|
+
versions: {
|
|
44
|
+
versionId: string & import("zod").$brand<"UUID">;
|
|
45
|
+
effectiveFrom: string;
|
|
46
|
+
name: string;
|
|
47
|
+
externalId?: string | null | undefined;
|
|
48
|
+
status: "active" | "inactive";
|
|
49
|
+
}[];
|
|
50
|
+
}>;
|
|
51
|
+
/** See {@link V2_DEFAULT_MOCK_CLIENT_LOCATIONS_MAP}. */
|
|
52
|
+
export declare const V2_DEFAULT_MOCK_CLIENT_ADMINISTRATIVE_AREAS_MAP: Map<string & import("zod").$brand<"UUID">, {
|
|
53
|
+
id: string & import("zod").$brand<"UUID">;
|
|
54
|
+
parentId: (string & import("zod").$brand<"UUID">) | null;
|
|
55
|
+
versions: {
|
|
56
|
+
versionId: string & import("zod").$brand<"UUID">;
|
|
57
|
+
effectiveFrom: string;
|
|
58
|
+
name: string;
|
|
59
|
+
externalId?: string | null | undefined;
|
|
60
|
+
status: "active" | "inactive";
|
|
61
|
+
}[];
|
|
18
62
|
}>;
|
|
19
63
|
//# sourceMappingURL=mocks.test.utils.d.ts.map
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { DisplayableAction } from './ActionType';
|
|
2
|
-
import { EncodedScope, UserScopeV2 } from '../scopes';
|
|
2
|
+
import { EncodedScope, RecordScopeTypeV2, ScopeType, UserScopeV2 } from '../scopes';
|
|
3
3
|
import { EventIndexWithAdministrativeHierarchy } from './locations';
|
|
4
4
|
import { UserContext } from '../users/User';
|
|
5
5
|
import { EventIndex } from './EventIndex';
|
|
@@ -27,6 +27,26 @@ export declare const ACTION_SCOPE_MAP: {
|
|
|
27
27
|
DUPLICATE_DETECTED: never[];
|
|
28
28
|
CUSTOM: never[];
|
|
29
29
|
};
|
|
30
|
+
/**
|
|
31
|
+
* The scopes of every action that can write to a record. Each of them can
|
|
32
|
+
* trigger a sweep of the record's prefix, so each of them has to be able to
|
|
33
|
+
* delete. `record.read` is absent: reading a record is not grounds for erasing
|
|
34
|
+
* it.
|
|
35
|
+
*/
|
|
36
|
+
export declare const RECORD_WRITE_SCOPES: RecordScopeTypeV2[];
|
|
37
|
+
/**
|
|
38
|
+
* Scopes that authorize deleting objects held by the documents service.
|
|
39
|
+
*
|
|
40
|
+
* Documents records no link between an object and the record it belongs to, so
|
|
41
|
+
* it cannot check that the caller owns a prefix. It checks instead that the
|
|
42
|
+
* caller holds a scope that lets them change a record or edit a user, and the
|
|
43
|
+
* service that forwarded the request has already checked that this particular
|
|
44
|
+
* record or user is theirs to act on.
|
|
45
|
+
*
|
|
46
|
+
* Listed rather than derived, so that adding an action to `ACTION_SCOPE_MAP`
|
|
47
|
+
* cannot silently grant deletion. `scopes.test.ts` fails when the two drift.
|
|
48
|
+
*/
|
|
49
|
+
export declare const DOCUMENT_DELETE_SCOPES: ScopeType[];
|
|
30
50
|
export declare function hasAnyOfScopes(a: string[], b: string[]): boolean;
|
|
31
51
|
export declare const AssignmentStatus: {
|
|
32
52
|
readonly ASSIGNED_TO_SELF: 'ASSIGNED_TO_SELF';
|