@opencrvs/toolkit 1.9.5-rc.e4b3277 → 1.9.5-rc.fe5b5f8

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;
@@ -4708,17 +4723,62 @@ declare const NameField: z.ZodObject<z.objectUtil.extendShape<{
4708
4723
  }, {
4709
4724
  type: z.ZodLiteral<"NAME">;
4710
4725
  defaultValue: z.ZodOptional<z.ZodObject<{
4711
- firstname: z.ZodOptional<z.ZodString>;
4712
- middlename: z.ZodOptional<z.ZodString>;
4713
- surname: z.ZodOptional<z.ZodString>;
4726
+ firstname: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
4727
+ $userField: z.ZodEnum<["id", "name", "role", "fullHonorificName", "device", "firstname", "middlename", "surname", "district", "province", "primaryOfficeId"]>;
4728
+ $location: z.ZodOptional<z.ZodString>;
4729
+ }, "strip", z.ZodTypeAny, {
4730
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
4731
+ $location?: string | undefined;
4732
+ }, {
4733
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
4734
+ $location?: string | undefined;
4735
+ }>, z.ZodString]>>;
4736
+ middlename: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
4737
+ $userField: z.ZodEnum<["id", "name", "role", "fullHonorificName", "device", "firstname", "middlename", "surname", "district", "province", "primaryOfficeId"]>;
4738
+ $location: z.ZodOptional<z.ZodString>;
4739
+ }, "strip", z.ZodTypeAny, {
4740
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
4741
+ $location?: string | undefined;
4742
+ }, {
4743
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
4744
+ $location?: string | undefined;
4745
+ }>, z.ZodString]>>;
4746
+ surname: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
4747
+ $userField: z.ZodEnum<["id", "name", "role", "fullHonorificName", "device", "firstname", "middlename", "surname", "district", "province", "primaryOfficeId"]>;
4748
+ $location: z.ZodOptional<z.ZodString>;
4749
+ }, "strip", z.ZodTypeAny, {
4750
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
4751
+ $location?: string | undefined;
4752
+ }, {
4753
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
4754
+ $location?: string | undefined;
4755
+ }>, z.ZodString]>>;
4714
4756
  }, "strip", z.ZodTypeAny, {
4715
- firstname?: string | undefined;
4716
- surname?: string | undefined;
4717
- middlename?: string | undefined;
4757
+ firstname?: string | {
4758
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
4759
+ $location?: string | undefined;
4760
+ } | undefined;
4761
+ surname?: string | {
4762
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
4763
+ $location?: string | undefined;
4764
+ } | undefined;
4765
+ middlename?: string | {
4766
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
4767
+ $location?: string | undefined;
4768
+ } | undefined;
4718
4769
  }, {
4719
- firstname?: string | undefined;
4720
- surname?: string | undefined;
4721
- middlename?: string | undefined;
4770
+ firstname?: string | {
4771
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
4772
+ $location?: string | undefined;
4773
+ } | undefined;
4774
+ surname?: string | {
4775
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
4776
+ $location?: string | undefined;
4777
+ } | undefined;
4778
+ middlename?: string | {
4779
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
4780
+ $location?: string | undefined;
4781
+ } | undefined;
4722
4782
  }>>;
4723
4783
  configuration: z.ZodOptional<z.ZodDefault<z.ZodObject<{
4724
4784
  name: z.ZodOptional<z.ZodDefault<z.ZodObject<{
@@ -5042,9 +5102,18 @@ declare const NameField: z.ZodObject<z.objectUtil.extendShape<{
5042
5102
  uncorrectable?: boolean | undefined;
5043
5103
  analytics?: boolean | undefined;
5044
5104
  defaultValue?: {
5045
- firstname?: string | undefined;
5046
- surname?: string | undefined;
5047
- middlename?: string | undefined;
5105
+ firstname?: string | {
5106
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
5107
+ $location?: string | undefined;
5108
+ } | undefined;
5109
+ surname?: string | {
5110
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
5111
+ $location?: string | undefined;
5112
+ } | undefined;
5113
+ middlename?: string | {
5114
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
5115
+ $location?: string | undefined;
5116
+ } | undefined;
5048
5117
  } | undefined;
5049
5118
  configuration?: {
5050
5119
  name?: {
@@ -5134,9 +5203,18 @@ declare const NameField: z.ZodObject<z.objectUtil.extendShape<{
5134
5203
  uncorrectable?: boolean | undefined;
5135
5204
  analytics?: boolean | undefined;
5136
5205
  defaultValue?: {
5137
- firstname?: string | undefined;
5138
- surname?: string | undefined;
5139
- middlename?: string | undefined;
5206
+ firstname?: string | {
5207
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
5208
+ $location?: string | undefined;
5209
+ } | undefined;
5210
+ surname?: string | {
5211
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
5212
+ $location?: string | undefined;
5213
+ } | undefined;
5214
+ middlename?: string | {
5215
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
5216
+ $location?: string | undefined;
5217
+ } | undefined;
5140
5218
  } | undefined;
5141
5219
  configuration?: {
5142
5220
  name?: {
@@ -7206,13 +7284,13 @@ export declare const DefaultAddressFieldValue: z.ZodObject<z.objectUtil.extendSh
7206
7284
  administrativeArea: z.ZodString;
7207
7285
  }>, {
7208
7286
  administrativeArea: z.ZodOptional<z.ZodUnion<[z.ZodBranded<z.ZodString, "UUID">, z.ZodObject<{
7209
- $userField: z.ZodEnum<["id", "name", "role", "signature", "avatar", "primaryOfficeId"]>;
7287
+ $userField: z.ZodEnum<["id", "name", "role", "fullHonorificName", "device", "firstname", "middlename", "surname", "district", "province", "primaryOfficeId"]>;
7210
7288
  $location: z.ZodOptional<z.ZodString>;
7211
7289
  }, "strip", z.ZodTypeAny, {
7212
- $userField: "signature" | "id" | "name" | "role" | "avatar" | "primaryOfficeId";
7290
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
7213
7291
  $location?: string | undefined;
7214
7292
  }, {
7215
- $userField: "signature" | "id" | "name" | "role" | "avatar" | "primaryOfficeId";
7293
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
7216
7294
  $location?: string | undefined;
7217
7295
  }>]>>;
7218
7296
  }>, "strip", z.ZodTypeAny, {
@@ -7220,7 +7298,7 @@ export declare const DefaultAddressFieldValue: z.ZodObject<z.objectUtil.extendSh
7220
7298
  addressType: "DOMESTIC";
7221
7299
  streetLevelDetails?: Record<string, string> | undefined;
7222
7300
  administrativeArea?: (string & z.BRAND<"UUID">) | {
7223
- $userField: "signature" | "id" | "name" | "role" | "avatar" | "primaryOfficeId";
7301
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
7224
7302
  $location?: string | undefined;
7225
7303
  } | undefined;
7226
7304
  }, {
@@ -7228,7 +7306,7 @@ export declare const DefaultAddressFieldValue: z.ZodObject<z.objectUtil.extendSh
7228
7306
  addressType: "DOMESTIC";
7229
7307
  streetLevelDetails?: Record<string, string> | undefined;
7230
7308
  administrativeArea?: string | {
7231
- $userField: "signature" | "id" | "name" | "role" | "avatar" | "primaryOfficeId";
7309
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
7232
7310
  $location?: string | undefined;
7233
7311
  } | undefined;
7234
7312
  }>;
@@ -7486,13 +7564,13 @@ declare const Address: z.ZodObject<z.objectUtil.extendShape<{
7486
7564
  administrativeArea: z.ZodString;
7487
7565
  }>, {
7488
7566
  administrativeArea: z.ZodOptional<z.ZodUnion<[z.ZodBranded<z.ZodString, "UUID">, z.ZodObject<{
7489
- $userField: z.ZodEnum<["id", "name", "role", "signature", "avatar", "primaryOfficeId"]>;
7567
+ $userField: z.ZodEnum<["id", "name", "role", "fullHonorificName", "device", "firstname", "middlename", "surname", "district", "province", "primaryOfficeId"]>;
7490
7568
  $location: z.ZodOptional<z.ZodString>;
7491
7569
  }, "strip", z.ZodTypeAny, {
7492
- $userField: "signature" | "id" | "name" | "role" | "avatar" | "primaryOfficeId";
7570
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
7493
7571
  $location?: string | undefined;
7494
7572
  }, {
7495
- $userField: "signature" | "id" | "name" | "role" | "avatar" | "primaryOfficeId";
7573
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
7496
7574
  $location?: string | undefined;
7497
7575
  }>]>>;
7498
7576
  }>, "strip", z.ZodTypeAny, {
@@ -7500,7 +7578,7 @@ declare const Address: z.ZodObject<z.objectUtil.extendShape<{
7500
7578
  addressType: "DOMESTIC";
7501
7579
  streetLevelDetails?: Record<string, string> | undefined;
7502
7580
  administrativeArea?: (string & z.BRAND<"UUID">) | {
7503
- $userField: "signature" | "id" | "name" | "role" | "avatar" | "primaryOfficeId";
7581
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
7504
7582
  $location?: string | undefined;
7505
7583
  } | undefined;
7506
7584
  }, {
@@ -7508,7 +7586,7 @@ declare const Address: z.ZodObject<z.objectUtil.extendShape<{
7508
7586
  addressType: "DOMESTIC";
7509
7587
  streetLevelDetails?: Record<string, string> | undefined;
7510
7588
  administrativeArea?: string | {
7511
- $userField: "signature" | "id" | "name" | "role" | "avatar" | "primaryOfficeId";
7589
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
7512
7590
  $location?: string | undefined;
7513
7591
  } | undefined;
7514
7592
  }>>;
@@ -7558,7 +7636,7 @@ declare const Address: z.ZodObject<z.objectUtil.extendShape<{
7558
7636
  addressType: "DOMESTIC";
7559
7637
  streetLevelDetails?: Record<string, string> | undefined;
7560
7638
  administrativeArea?: (string & z.BRAND<"UUID">) | {
7561
- $userField: "signature" | "id" | "name" | "role" | "avatar" | "primaryOfficeId";
7639
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
7562
7640
  $location?: string | undefined;
7563
7641
  } | undefined;
7564
7642
  } | undefined;
@@ -7655,7 +7733,7 @@ declare const Address: z.ZodObject<z.objectUtil.extendShape<{
7655
7733
  addressType: "DOMESTIC";
7656
7734
  streetLevelDetails?: Record<string, string> | undefined;
7657
7735
  administrativeArea?: string | {
7658
- $userField: "signature" | "id" | "name" | "role" | "avatar" | "primaryOfficeId";
7736
+ $userField: "id" | "name" | "device" | "district" | "firstname" | "surname" | "middlename" | "role" | "fullHonorificName" | "province" | "primaryOfficeId";
7659
7737
  $location?: string | undefined;
7660
7738
  } | undefined;
7661
7739
  } | 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: {