@opencrvs/toolkit 1.9.5-rc.98beaa4 → 1.9.5-rc.a9ac36b

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 (15) hide show
  1. package/dist/commons/api/router.d.ts +27 -25
  2. package/dist/commons/events/AdvancedSearchConfig.d.ts +17 -17
  3. package/dist/commons/events/CountryConfigQueryInput.d.ts +350 -350
  4. package/dist/commons/events/EventConfig.d.ts +11 -11
  5. package/dist/commons/events/FieldConfig.d.ts +108 -30
  6. package/dist/commons/events/FieldType.d.ts +1 -1
  7. package/dist/commons/events/TemplateConfig.d.ts +15 -3
  8. package/dist/commons/events/WorkqueueConfig.d.ts +525 -525
  9. package/dist/commons/events/defineConfig.d.ts +1 -1
  10. package/dist/commons/events/event.d.ts +4 -4
  11. package/dist/commons/events/utils.d.ts +1 -1
  12. package/dist/conditionals/index.js +7 -2
  13. package/dist/events/index.js +15 -7
  14. package/dist/notification/index.js +14 -6
  15. package/package.json +1 -1
package/dist/commons/events/EventConfig.d.ts CHANGED
@@ -545,14 +545,14 @@ export declare const EventConfig: z.ZodEffects<z.ZodObject<{
545
545
  validator: import(".").JSONSchema;
546
546
  }>, "many">>>;
547
547
  }, {
548
- fieldId: z.ZodEnum<["event.trackingId", "event.status", "event.legalStatuses.REGISTERED.acceptedAt", "event.legalStatuses.REGISTERED.createdAtLocation", "event.updatedAt"]>;
548
+ fieldId: z.ZodEnum<["event.trackingId", "event.status", "event.legalStatuses.REGISTERED.acceptedAt", "event.legalStatuses.REGISTERED.createdAtLocation", "event.legalStatuses.REGISTERED.registrationNumber", "event.updatedAt"]>;
549
549
  fieldType: z.ZodLiteral<"event">;
550
550
  }>, "strip", z.ZodTypeAny, {
551
551
  config: {
552
552
  type: "exact" | "fuzzy" | "range" | "within";
553
553
  searchFields?: string[] | undefined;
554
554
  };
555
- fieldId: "event.status" | "event.trackingId" | "event.updatedAt" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation";
555
+ fieldId: "event.status" | "event.trackingId" | "event.updatedAt" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation" | "event.legalStatuses.REGISTERED.registrationNumber";
556
556
  fieldType: "event";
557
557
  type?: "NAME" | "PHONE" | "ID" | "ADDRESS" | "TEXT" | "NUMBER" | "TEXTAREA" | "EMAIL" | "DATE" | "AGE" | "DATE_RANGE" | "SELECT_DATE_RANGE" | "TIME" | "PARAGRAPH" | "PAGE_HEADER" | "RADIO_GROUP" | "FILE" | "FILE_WITH_OPTIONS" | "BULLET_LIST" | "CHECKBOX" | "SELECT" | "COUNTRY" | "LOCATION" | "DIVIDER" | "ADMINISTRATIVE_AREA" | "FACILITY" | "OFFICE" | "SIGNATURE" | "DATA" | "BUTTON" | "SEARCH" | "ALPHA_PRINT_BUTTON" | "HTTP" | "LINK_BUTTON" | "VERIFICATION_STATUS" | "QUERY_PARAM_READER" | "QR_READER" | "ID_READER" | "LOADER" | undefined;
558
558
  options?: {
@@ -580,7 +580,7 @@ export declare const EventConfig: z.ZodEffects<z.ZodObject<{
580
580
  type: "exact" | "fuzzy" | "range" | "within";
581
581
  searchFields?: string[] | undefined;
582
582
  };
583
- fieldId: "event.status" | "event.trackingId" | "event.updatedAt" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation";
583
+ fieldId: "event.status" | "event.trackingId" | "event.updatedAt" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation" | "event.legalStatuses.REGISTERED.registrationNumber";
584
584
  fieldType: "event";
585
585
  type?: "NAME" | "PHONE" | "ID" | "ADDRESS" | "TEXT" | "NUMBER" | "TEXTAREA" | "EMAIL" | "DATE" | "AGE" | "DATE_RANGE" | "SELECT_DATE_RANGE" | "TIME" | "PARAGRAPH" | "PAGE_HEADER" | "RADIO_GROUP" | "FILE" | "FILE_WITH_OPTIONS" | "BULLET_LIST" | "CHECKBOX" | "SELECT" | "COUNTRY" | "LOCATION" | "DIVIDER" | "ADMINISTRATIVE_AREA" | "FACILITY" | "OFFICE" | "SIGNATURE" | "DATA" | "BUTTON" | "SEARCH" | "ALPHA_PRINT_BUTTON" | "HTTP" | "LINK_BUTTON" | "VERIFICATION_STATUS" | "QUERY_PARAM_READER" | "QR_READER" | "ID_READER" | "LOADER" | undefined;
586
586
  options?: {
@@ -652,7 +652,7 @@ export declare const EventConfig: z.ZodEffects<z.ZodObject<{
652
652
  type: "exact" | "fuzzy" | "range" | "within";
653
653
  searchFields?: string[] | undefined;
654
654
  };
655
- fieldId: "event.status" | "event.trackingId" | "event.updatedAt" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation";
655
+ fieldId: "event.status" | "event.trackingId" | "event.updatedAt" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation" | "event.legalStatuses.REGISTERED.registrationNumber";
656
656
  fieldType: "event";
657
657
  type?: "NAME" | "PHONE" | "ID" | "ADDRESS" | "TEXT" | "NUMBER" | "TEXTAREA" | "EMAIL" | "DATE" | "AGE" | "DATE_RANGE" | "SELECT_DATE_RANGE" | "TIME" | "PARAGRAPH" | "PAGE_HEADER" | "RADIO_GROUP" | "FILE" | "FILE_WITH_OPTIONS" | "BULLET_LIST" | "CHECKBOX" | "SELECT" | "COUNTRY" | "LOCATION" | "DIVIDER" | "ADMINISTRATIVE_AREA" | "FACILITY" | "OFFICE" | "SIGNATURE" | "DATA" | "BUTTON" | "SEARCH" | "ALPHA_PRINT_BUTTON" | "HTTP" | "LINK_BUTTON" | "VERIFICATION_STATUS" | "QUERY_PARAM_READER" | "QR_READER" | "ID_READER" | "LOADER" | undefined;
658
658
  options?: {
@@ -724,7 +724,7 @@ export declare const EventConfig: z.ZodEffects<z.ZodObject<{
724
724
  type: "exact" | "fuzzy" | "range" | "within";
725
725
  searchFields?: string[] | undefined;
726
726
  };
727
- fieldId: "event.status" | "event.trackingId" | "event.updatedAt" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation";
727
+ fieldId: "event.status" | "event.trackingId" | "event.updatedAt" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation" | "event.legalStatuses.REGISTERED.registrationNumber";
728
728
  fieldType: "event";
729
729
  type?: "NAME" | "PHONE" | "ID" | "ADDRESS" | "TEXT" | "NUMBER" | "TEXTAREA" | "EMAIL" | "DATE" | "AGE" | "DATE_RANGE" | "SELECT_DATE_RANGE" | "TIME" | "PARAGRAPH" | "PAGE_HEADER" | "RADIO_GROUP" | "FILE" | "FILE_WITH_OPTIONS" | "BULLET_LIST" | "CHECKBOX" | "SELECT" | "COUNTRY" | "LOCATION" | "DIVIDER" | "ADMINISTRATIVE_AREA" | "FACILITY" | "OFFICE" | "SIGNATURE" | "DATA" | "BUTTON" | "SEARCH" | "ALPHA_PRINT_BUTTON" | "HTTP" | "LINK_BUTTON" | "VERIFICATION_STATUS" | "QUERY_PARAM_READER" | "QR_READER" | "ID_READER" | "LOADER" | undefined;
730
730
  options?: {
@@ -799,7 +799,7 @@ export declare const EventConfig: z.ZodEffects<z.ZodObject<{
799
799
  type: "exact" | "fuzzy" | "range" | "within";
800
800
  searchFields?: string[] | undefined;
801
801
  };
802
- fieldId: "event.status" | "event.trackingId" | "event.updatedAt" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation";
802
+ fieldId: "event.status" | "event.trackingId" | "event.updatedAt" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation" | "event.legalStatuses.REGISTERED.registrationNumber";
803
803
  fieldType: "event";
804
804
  type?: "NAME" | "PHONE" | "ID" | "ADDRESS" | "TEXT" | "NUMBER" | "TEXTAREA" | "EMAIL" | "DATE" | "AGE" | "DATE_RANGE" | "SELECT_DATE_RANGE" | "TIME" | "PARAGRAPH" | "PAGE_HEADER" | "RADIO_GROUP" | "FILE" | "FILE_WITH_OPTIONS" | "BULLET_LIST" | "CHECKBOX" | "SELECT" | "COUNTRY" | "LOCATION" | "DIVIDER" | "ADMINISTRATIVE_AREA" | "FACILITY" | "OFFICE" | "SIGNATURE" | "DATA" | "BUTTON" | "SEARCH" | "ALPHA_PRINT_BUTTON" | "HTTP" | "LINK_BUTTON" | "VERIFICATION_STATUS" | "QUERY_PARAM_READER" | "QR_READER" | "ID_READER" | "LOADER" | undefined;
805
805
  options?: {
@@ -878,7 +878,7 @@ export declare const EventConfig: z.ZodEffects<z.ZodObject<{
878
878
  type: "exact" | "fuzzy" | "range" | "within";
879
879
  searchFields?: string[] | undefined;
880
880
  };
881
- fieldId: "event.status" | "event.trackingId" | "event.updatedAt" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation";
881
+ fieldId: "event.status" | "event.trackingId" | "event.updatedAt" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation" | "event.legalStatuses.REGISTERED.registrationNumber";
882
882
  fieldType: "event";
883
883
  type?: "NAME" | "PHONE" | "ID" | "ADDRESS" | "TEXT" | "NUMBER" | "TEXTAREA" | "EMAIL" | "DATE" | "AGE" | "DATE_RANGE" | "SELECT_DATE_RANGE" | "TIME" | "PARAGRAPH" | "PAGE_HEADER" | "RADIO_GROUP" | "FILE" | "FILE_WITH_OPTIONS" | "BULLET_LIST" | "CHECKBOX" | "SELECT" | "COUNTRY" | "LOCATION" | "DIVIDER" | "ADMINISTRATIVE_AREA" | "FACILITY" | "OFFICE" | "SIGNATURE" | "DATA" | "BUTTON" | "SEARCH" | "ALPHA_PRINT_BUTTON" | "HTTP" | "LINK_BUTTON" | "VERIFICATION_STATUS" | "QUERY_PARAM_READER" | "QR_READER" | "ID_READER" | "LOADER" | undefined;
884
884
  options?: {
@@ -1114,7 +1114,7 @@ export declare const EventConfig: z.ZodEffects<z.ZodObject<{
1114
1114
  type: "exact" | "fuzzy" | "range" | "within";
1115
1115
  searchFields?: string[] | undefined;
1116
1116
  };
1117
- fieldId: "event.status" | "event.trackingId" | "event.updatedAt" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation";
1117
+ fieldId: "event.status" | "event.trackingId" | "event.updatedAt" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation" | "event.legalStatuses.REGISTERED.registrationNumber";
1118
1118
  fieldType: "event";
1119
1119
  type?: "NAME" | "PHONE" | "ID" | "ADDRESS" | "TEXT" | "NUMBER" | "TEXTAREA" | "EMAIL" | "DATE" | "AGE" | "DATE_RANGE" | "SELECT_DATE_RANGE" | "TIME" | "PARAGRAPH" | "PAGE_HEADER" | "RADIO_GROUP" | "FILE" | "FILE_WITH_OPTIONS" | "BULLET_LIST" | "CHECKBOX" | "SELECT" | "COUNTRY" | "LOCATION" | "DIVIDER" | "ADMINISTRATIVE_AREA" | "FACILITY" | "OFFICE" | "SIGNATURE" | "DATA" | "BUTTON" | "SEARCH" | "ALPHA_PRINT_BUTTON" | "HTTP" | "LINK_BUTTON" | "VERIFICATION_STATUS" | "QUERY_PARAM_READER" | "QR_READER" | "ID_READER" | "LOADER" | undefined;
1120
1120
  options?: {
@@ -1532,7 +1532,7 @@ export declare const EventConfig: z.ZodEffects<z.ZodObject<{
1532
1532
  type: "exact" | "fuzzy" | "range" | "within";
1533
1533
  searchFields?: string[] | undefined;
1534
1534
  };
1535
- fieldId: "event.status" | "event.trackingId" | "event.updatedAt" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation";
1535
+ fieldId: "event.status" | "event.trackingId" | "event.updatedAt" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation" | "event.legalStatuses.REGISTERED.registrationNumber";
1536
1536
  fieldType: "event";
1537
1537
  type?: "NAME" | "PHONE" | "ID" | "ADDRESS" | "TEXT" | "NUMBER" | "TEXTAREA" | "EMAIL" | "DATE" | "AGE" | "DATE_RANGE" | "SELECT_DATE_RANGE" | "TIME" | "PARAGRAPH" | "PAGE_HEADER" | "RADIO_GROUP" | "FILE" | "FILE_WITH_OPTIONS" | "BULLET_LIST" | "CHECKBOX" | "SELECT" | "COUNTRY" | "LOCATION" | "DIVIDER" | "ADMINISTRATIVE_AREA" | "FACILITY" | "OFFICE" | "SIGNATURE" | "DATA" | "BUTTON" | "SEARCH" | "ALPHA_PRINT_BUTTON" | "HTTP" | "LINK_BUTTON" | "VERIFICATION_STATUS" | "QUERY_PARAM_READER" | "QR_READER" | "ID_READER" | "LOADER" | undefined;
1538
1538
  options?: {
@@ -1768,7 +1768,7 @@ export declare const EventConfig: z.ZodEffects<z.ZodObject<{
1768
1768
  type: "exact" | "fuzzy" | "range" | "within";
1769
1769
  searchFields?: string[] | undefined;
1770
1770
  };
1771
- fieldId: "event.status" | "event.trackingId" | "event.updatedAt" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation";
1771
+ fieldId: "event.status" | "event.trackingId" | "event.updatedAt" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation" | "event.legalStatuses.REGISTERED.registrationNumber";
1772
1772
  fieldType: "event";
1773
1773
  type?: "NAME" | "PHONE" | "ID" | "ADDRESS" | "TEXT" | "NUMBER" | "TEXTAREA" | "EMAIL" | "DATE" | "AGE" | "DATE_RANGE" | "SELECT_DATE_RANGE" | "TIME" | "PARAGRAPH" | "PAGE_HEADER" | "RADIO_GROUP" | "FILE" | "FILE_WITH_OPTIONS" | "BULLET_LIST" | "CHECKBOX" | "SELECT" | "COUNTRY" | "LOCATION" | "DIVIDER" | "ADMINISTRATIVE_AREA" | "FACILITY" | "OFFICE" | "SIGNATURE" | "DATA" | "BUTTON" | "SEARCH" | "ALPHA_PRINT_BUTTON" | "HTTP" | "LINK_BUTTON" | "VERIFICATION_STATUS" | "QUERY_PARAM_READER" | "QR_READER" | "ID_READER" | "LOADER" | undefined;
1774
1774
  options?: {
@@ -2186,7 +2186,7 @@ export declare const EventConfig: z.ZodEffects<z.ZodObject<{
2186
2186
  type: "exact" | "fuzzy" | "range" | "within";
2187
2187
  searchFields?: string[] | undefined;
2188
2188
  };
2189
- fieldId: "event.status" | "event.trackingId" | "event.updatedAt" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation";
2189
+ fieldId: "event.status" | "event.trackingId" | "event.updatedAt" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation" | "event.legalStatuses.REGISTERED.registrationNumber";
2190
2190
  fieldType: "event";
2191
2191
  type?: "NAME" | "PHONE" | "ID" | "ADDRESS" | "TEXT" | "NUMBER" | "TEXTAREA" | "EMAIL" | "DATE" | "AGE" | "DATE_RANGE" | "SELECT_DATE_RANGE" | "TIME" | "PARAGRAPH" | "PAGE_HEADER" | "RADIO_GROUP" | "FILE" | "FILE_WITH_OPTIONS" | "BULLET_LIST" | "CHECKBOX" | "SELECT" | "COUNTRY" | "LOCATION" | "DIVIDER" | "ADMINISTRATIVE_AREA" | "FACILITY" | "OFFICE" | "SIGNATURE" | "DATA" | "BUTTON" | "SEARCH" | "ALPHA_PRINT_BUTTON" | "HTTP" | "LINK_BUTTON" | "VERIFICATION_STATUS" | "QUERY_PARAM_READER" | "QR_READER" | "ID_READER" | "LOADER" | undefined;
2192
2192
  options?: {
package/dist/commons/events/FieldConfig.d.ts CHANGED
@@ -537,7 +537,16 @@ export declare const TextField: z.ZodObject<z.objectUtil.extendShape<{
537
537
  analytics: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
538
538
  }, {
539
539
  type: z.ZodLiteral<"TEXT">;
540
- defaultValue: z.ZodOptional<z.ZodString>;
540
+ defaultValue: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodObject<{
541
+ $userField: z.ZodEnum<["id", "name", "role", "fullHonorificName", "device", "firstname", "middlename", "surname", "district", "province", "primaryOfficeId"]>;
542
+ $location: z.ZodOptional<z.ZodString>;
543
+ }, "strip", z.ZodTypeAny, {
544
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
545
+ $location?: string | undefined;
546
+ }, {
547
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
548
+ $location?: string | undefined;
549
+ }>]>>;
541
550
  configuration: z.ZodOptional<z.ZodDefault<z.ZodObject<{
542
551
  maxLength: z.ZodOptional<z.ZodNumber>;
543
552
  type: z.ZodOptional<z.ZodEnum<["text", "password"]>>;
@@ -611,7 +620,10 @@ export declare const TextField: z.ZodObject<z.objectUtil.extendShape<{
611
620
  hideLabel?: boolean | undefined;
612
621
  uncorrectable?: boolean | undefined;
613
622
  analytics?: boolean | undefined;
614
- defaultValue?: string | undefined;
623
+ defaultValue?: string | {
624
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
625
+ $location?: string | undefined;
626
+ } | undefined;
615
627
  configuration?: {
616
628
  type?: "text" | "password" | undefined;
617
629
  maxLength?: number | undefined;
@@ -679,7 +691,10 @@ export declare const TextField: z.ZodObject<z.objectUtil.extendShape<{
679
691
  hideLabel?: boolean | undefined;
680
692
  uncorrectable?: boolean | undefined;
681
693
  analytics?: boolean | undefined;
682
- defaultValue?: string | undefined;
694
+ defaultValue?: string | {
695
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
696
+ $location?: string | undefined;
697
+ } | undefined;
683
698
  configuration?: {
684
699
  type?: "text" | "password" | undefined;
685
700
  maxLength?: number | undefined;
@@ -4662,17 +4677,62 @@ declare const NameField: z.ZodObject<z.objectUtil.extendShape<{
4662
4677
  }, {
4663
4678
  type: z.ZodLiteral<"NAME">;
4664
4679
  defaultValue: z.ZodOptional<z.ZodObject<{
4665
- firstname: z.ZodOptional<z.ZodString>;
4666
- middlename: z.ZodOptional<z.ZodString>;
4667
- surname: z.ZodOptional<z.ZodString>;
4680
+ firstname: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
4681
+ $userField: z.ZodEnum<["id", "name", "role", "fullHonorificName", "device", "firstname", "middlename", "surname", "district", "province", "primaryOfficeId"]>;
4682
+ $location: z.ZodOptional<z.ZodString>;
4683
+ }, "strip", z.ZodTypeAny, {
4684
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
4685
+ $location?: string | undefined;
4686
+ }, {
4687
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
4688
+ $location?: string | undefined;
4689
+ }>, z.ZodString]>>;
4690
+ middlename: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
4691
+ $userField: z.ZodEnum<["id", "name", "role", "fullHonorificName", "device", "firstname", "middlename", "surname", "district", "province", "primaryOfficeId"]>;
4692
+ $location: z.ZodOptional<z.ZodString>;
4693
+ }, "strip", z.ZodTypeAny, {
4694
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
4695
+ $location?: string | undefined;
4696
+ }, {
4697
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
4698
+ $location?: string | undefined;
4699
+ }>, z.ZodString]>>;
4700
+ surname: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
4701
+ $userField: z.ZodEnum<["id", "name", "role", "fullHonorificName", "device", "firstname", "middlename", "surname", "district", "province", "primaryOfficeId"]>;
4702
+ $location: z.ZodOptional<z.ZodString>;
4703
+ }, "strip", z.ZodTypeAny, {
4704
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
4705
+ $location?: string | undefined;
4706
+ }, {
4707
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
4708
+ $location?: string | undefined;
4709
+ }>, z.ZodString]>>;
4668
4710
  }, "strip", z.ZodTypeAny, {
4669
- firstname?: string | undefined;
4670
- surname?: string | undefined;
4671
- middlename?: string | undefined;
4711
+ firstname?: string | {
4712
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
4713
+ $location?: string | undefined;
4714
+ } | undefined;
4715
+ surname?: string | {
4716
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
4717
+ $location?: string | undefined;
4718
+ } | undefined;
4719
+ middlename?: string | {
4720
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
4721
+ $location?: string | undefined;
4722
+ } | undefined;
4672
4723
  }, {
4673
- firstname?: string | undefined;
4674
- surname?: string | undefined;
4675
- middlename?: string | undefined;
4724
+ firstname?: string | {
4725
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
4726
+ $location?: string | undefined;
4727
+ } | undefined;
4728
+ surname?: string | {
4729
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
4730
+ $location?: string | undefined;
4731
+ } | undefined;
4732
+ middlename?: string | {
4733
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
4734
+ $location?: string | undefined;
4735
+ } | undefined;
4676
4736
  }>>;
4677
4737
  configuration: z.ZodOptional<z.ZodDefault<z.ZodObject<{
4678
4738
  name: z.ZodOptional<z.ZodDefault<z.ZodObject<{
@@ -4996,9 +5056,18 @@ declare const NameField: z.ZodObject<z.objectUtil.extendShape<{
4996
5056
  uncorrectable?: boolean | undefined;
4997
5057
  analytics?: boolean | undefined;
4998
5058
  defaultValue?: {
4999
- firstname?: string | undefined;
5000
- surname?: string | undefined;
5001
- middlename?: string | undefined;
5059
+ firstname?: string | {
5060
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
5061
+ $location?: string | undefined;
5062
+ } | undefined;
5063
+ surname?: string | {
5064
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
5065
+ $location?: string | undefined;
5066
+ } | undefined;
5067
+ middlename?: string | {
5068
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
5069
+ $location?: string | undefined;
5070
+ } | undefined;
5002
5071
  } | undefined;
5003
5072
  configuration?: {
5004
5073
  name?: {
@@ -5088,9 +5157,18 @@ declare const NameField: z.ZodObject<z.objectUtil.extendShape<{
5088
5157
  uncorrectable?: boolean | undefined;
5089
5158
  analytics?: boolean | undefined;
5090
5159
  defaultValue?: {
5091
- firstname?: string | undefined;
5092
- surname?: string | undefined;
5093
- middlename?: string | undefined;
5160
+ firstname?: string | {
5161
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
5162
+ $location?: string | undefined;
5163
+ } | undefined;
5164
+ surname?: string | {
5165
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
5166
+ $location?: string | undefined;
5167
+ } | undefined;
5168
+ middlename?: string | {
5169
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
5170
+ $location?: string | undefined;
5171
+ } | undefined;
5094
5172
  } | undefined;
5095
5173
  configuration?: {
5096
5174
  name?: {
@@ -7114,13 +7192,13 @@ export declare const DefaultAddressFieldValue: z.ZodObject<z.objectUtil.extendSh
7114
7192
  administrativeArea: z.ZodString;
7115
7193
  }>, {
7116
7194
  administrativeArea: z.ZodOptional<z.ZodUnion<[z.ZodBranded<z.ZodString, "UUID">, z.ZodObject<{
7117
- $userField: z.ZodEnum<["id", "name", "role", "signature", "avatar", "primaryOfficeId"]>;
7195
+ $userField: z.ZodEnum<["id", "name", "role", "fullHonorificName", "device", "firstname", "middlename", "surname", "district", "province", "primaryOfficeId"]>;
7118
7196
  $location: z.ZodOptional<z.ZodString>;
7119
7197
  }, "strip", z.ZodTypeAny, {
7120
- $userField: "signature" | "id" | "name" | "role" | "avatar" | "primaryOfficeId";
7198
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
7121
7199
  $location?: string | undefined;
7122
7200
  }, {
7123
- $userField: "signature" | "id" | "name" | "role" | "avatar" | "primaryOfficeId";
7201
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
7124
7202
  $location?: string | undefined;
7125
7203
  }>]>>;
7126
7204
  }>, "strip", z.ZodTypeAny, {
@@ -7128,7 +7206,7 @@ export declare const DefaultAddressFieldValue: z.ZodObject<z.objectUtil.extendSh
7128
7206
  addressType: "DOMESTIC";
7129
7207
  streetLevelDetails?: Record<string, string> | undefined;
7130
7208
  administrativeArea?: (string & z.BRAND<"UUID">) | {
7131
- $userField: "signature" | "id" | "name" | "role" | "avatar" | "primaryOfficeId";
7209
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
7132
7210
  $location?: string | undefined;
7133
7211
  } | undefined;
7134
7212
  }, {
@@ -7136,7 +7214,7 @@ export declare const DefaultAddressFieldValue: z.ZodObject<z.objectUtil.extendSh
7136
7214
  addressType: "DOMESTIC";
7137
7215
  streetLevelDetails?: Record<string, string> | undefined;
7138
7216
  administrativeArea?: string | {
7139
- $userField: "signature" | "id" | "name" | "role" | "avatar" | "primaryOfficeId";
7217
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
7140
7218
  $location?: string | undefined;
7141
7219
  } | undefined;
7142
7220
  }>;
@@ -7394,13 +7472,13 @@ declare const Address: z.ZodObject<z.objectUtil.extendShape<{
7394
7472
  administrativeArea: z.ZodString;
7395
7473
  }>, {
7396
7474
  administrativeArea: z.ZodOptional<z.ZodUnion<[z.ZodBranded<z.ZodString, "UUID">, z.ZodObject<{
7397
- $userField: z.ZodEnum<["id", "name", "role", "signature", "avatar", "primaryOfficeId"]>;
7475
+ $userField: z.ZodEnum<["id", "name", "role", "fullHonorificName", "device", "firstname", "middlename", "surname", "district", "province", "primaryOfficeId"]>;
7398
7476
  $location: z.ZodOptional<z.ZodString>;
7399
7477
  }, "strip", z.ZodTypeAny, {
7400
- $userField: "signature" | "id" | "name" | "role" | "avatar" | "primaryOfficeId";
7478
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
7401
7479
  $location?: string | undefined;
7402
7480
  }, {
7403
- $userField: "signature" | "id" | "name" | "role" | "avatar" | "primaryOfficeId";
7481
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
7404
7482
  $location?: string | undefined;
7405
7483
  }>]>>;
7406
7484
  }>, "strip", z.ZodTypeAny, {
@@ -7408,7 +7486,7 @@ declare const Address: z.ZodObject<z.objectUtil.extendShape<{
7408
7486
  addressType: "DOMESTIC";
7409
7487
  streetLevelDetails?: Record<string, string> | undefined;
7410
7488
  administrativeArea?: (string & z.BRAND<"UUID">) | {
7411
- $userField: "signature" | "id" | "name" | "role" | "avatar" | "primaryOfficeId";
7489
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
7412
7490
  $location?: string | undefined;
7413
7491
  } | undefined;
7414
7492
  }, {
@@ -7416,7 +7494,7 @@ declare const Address: z.ZodObject<z.objectUtil.extendShape<{
7416
7494
  addressType: "DOMESTIC";
7417
7495
  streetLevelDetails?: Record<string, string> | undefined;
7418
7496
  administrativeArea?: string | {
7419
- $userField: "signature" | "id" | "name" | "role" | "avatar" | "primaryOfficeId";
7497
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
7420
7498
  $location?: string | undefined;
7421
7499
  } | undefined;
7422
7500
  }>>;
@@ -7466,7 +7544,7 @@ declare const Address: z.ZodObject<z.objectUtil.extendShape<{
7466
7544
  addressType: "DOMESTIC";
7467
7545
  streetLevelDetails?: Record<string, string> | undefined;
7468
7546
  administrativeArea?: (string & z.BRAND<"UUID">) | {
7469
- $userField: "signature" | "id" | "name" | "role" | "avatar" | "primaryOfficeId";
7547
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
7470
7548
  $location?: string | undefined;
7471
7549
  } | undefined;
7472
7550
  } | undefined;
@@ -7563,7 +7641,7 @@ declare const Address: z.ZodObject<z.objectUtil.extendShape<{
7563
7641
  addressType: "DOMESTIC";
7564
7642
  streetLevelDetails?: Record<string, string> | undefined;
7565
7643
  administrativeArea?: string | {
7566
- $userField: "signature" | "id" | "name" | "role" | "avatar" | "primaryOfficeId";
7644
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
7567
7645
  $location?: string | undefined;
7568
7646
  } | undefined;
7569
7647
  } | undefined;
package/dist/commons/events/FieldType.d.ts CHANGED
@@ -49,6 +49,6 @@ export type FieldType = (typeof fieldTypes)[number];
49
49
  /**
50
50
  * Composite field types are field types that consist of multiple field values.
51
51
  */
52
- export declare const compositeFieldTypes: ("ADDRESS" | "DATE_RANGE" | "FILE" | "FILE_WITH_OPTIONS" | "DATA" | "ID_READER")[];
52
+ export declare const compositeFieldTypes: ("NAME" | "ADDRESS" | "DATE_RANGE" | "FILE" | "FILE_WITH_OPTIONS" | "DATA" | "ID_READER")[];
53
53
  export declare const FieldTypesToHideInReview: ("PARAGRAPH" | "PAGE_HEADER" | "BULLET_LIST" | "DIVIDER" | "DATA" | "HTTP" | "QUERY_PARAM_READER" | "ID_READER" | "LOADER")[];
54
54
  //# sourceMappingURL=FieldType.d.ts.map
package/dist/commons/events/TemplateConfig.d.ts CHANGED
@@ -2,14 +2,26 @@
2
2
  * TemplateConfig defines configuration rules for system-based variables (e.g. $user.province).
3
3
  * They are currently used for providing default values in FieldConfig.
4
4
  */
5
+ import { UUID } from '../uuid';
5
6
  import { FieldValue } from './FieldValue';
6
7
  /**
7
8
  * Available system variables for configuration.
8
9
  */
9
10
  export type SystemVariables = {
10
- $user: {
11
- province: string;
12
- district: string;
11
+ user: {
12
+ id: string;
13
+ province?: string;
14
+ district?: string;
15
+ name?: string;
16
+ role?: string;
17
+ firstname?: string;
18
+ middlename?: string;
19
+ surname?: string;
20
+ primaryOfficeId?: UUID;
21
+ fullHonorificName?: string;
22
+ device?: string;
23
+ avatar?: string;
24
+ signature?: string;
13
25
  };
14
26
  $window: {
15
27
  location: {