@wix/auto_sdk_benefit-programs_programs 1.0.54 → 1.0.56

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 (42) hide show
  1. package/build/cjs/index.js +2 -4
  2. package/build/cjs/index.js.map +1 -1
  3. package/build/cjs/index.typings.d.ts +1 -9
  4. package/build/cjs/index.typings.js +1 -3
  5. package/build/cjs/index.typings.js.map +1 -1
  6. package/build/cjs/meta.js.map +1 -1
  7. package/build/es/index.mjs +2 -4
  8. package/build/es/index.mjs.map +1 -1
  9. package/build/es/index.typings.d.mts +1 -9
  10. package/build/es/index.typings.mjs +1 -3
  11. package/build/es/index.typings.mjs.map +1 -1
  12. package/build/es/meta.mjs.map +1 -1
  13. package/build/internal/cjs/index.typings.d.ts +52 -9
  14. package/build/internal/cjs/meta.d.ts +73 -0
  15. package/build/internal/es/index.typings.d.mts +52 -9
  16. package/build/internal/es/meta.d.mts +73 -0
  17. package/package.json +5 -12
  18. package/build/cjs/schemas.d.ts +0 -467
  19. package/build/cjs/schemas.js +0 -915
  20. package/build/cjs/schemas.js.map +0 -1
  21. package/build/es/schemas.d.mts +0 -467
  22. package/build/es/schemas.mjs +0 -861
  23. package/build/es/schemas.mjs.map +0 -1
  24. package/build/internal/cjs/index.js +0 -858
  25. package/build/internal/cjs/index.js.map +0 -1
  26. package/build/internal/cjs/index.typings.js +0 -759
  27. package/build/internal/cjs/index.typings.js.map +0 -1
  28. package/build/internal/cjs/meta.js +0 -613
  29. package/build/internal/cjs/meta.js.map +0 -1
  30. package/build/internal/cjs/schemas.d.ts +0 -467
  31. package/build/internal/cjs/schemas.js +0 -915
  32. package/build/internal/cjs/schemas.js.map +0 -1
  33. package/build/internal/es/index.mjs +0 -819
  34. package/build/internal/es/index.mjs.map +0 -1
  35. package/build/internal/es/index.typings.mjs +0 -719
  36. package/build/internal/es/index.typings.mjs.map +0 -1
  37. package/build/internal/es/meta.mjs +0 -572
  38. package/build/internal/es/meta.mjs.map +0 -1
  39. package/build/internal/es/schemas.d.mts +0 -467
  40. package/build/internal/es/schemas.mjs +0 -861
  41. package/build/internal/es/schemas.mjs.map +0 -1
  42. package/schemas/package.json +0 -3
@@ -78,6 +78,12 @@ interface Program {
78
78
  * @readonly
79
79
  */
80
80
  programDefinition?: ProgramDefinitionInfo;
81
+ /**
82
+ * Intended status of a program after the completion of an action.
83
+ * @internal
84
+ * @readonly
85
+ */
86
+ targetStatus?: ProgramStatusWithLiterals;
81
87
  }
82
88
  declare enum ProgramStatus {
83
89
  /** Program is active. */
@@ -113,6 +119,12 @@ interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
113
119
  * @format GUID
114
120
  */
115
121
  wixUserId?: string;
122
+ /**
123
+ * Identity type.
124
+ * @internal
125
+ * @readonly
126
+ */
127
+ identityType?: IdentityTypeWithLiterals;
116
128
  }
117
129
  /** @oneof */
118
130
  interface CommonIdentificationDataIdOneOf {
@@ -431,6 +443,11 @@ interface UpsertMigratedProgramResponse {
431
443
  interface UpdateProgramRequest {
432
444
  /** Program to update. */
433
445
  program: Program;
446
+ /**
447
+ * Explicit list of fields to update.
448
+ * @internal
449
+ */
450
+ fieldMask?: string[];
434
451
  }
435
452
  interface UpdateProgramResponse {
436
453
  /** Updated program. */
@@ -483,6 +500,20 @@ interface Sorting {
483
500
  * Default: `ASC`
484
501
  */
485
502
  order?: SortOrderWithLiterals;
503
+ /**
504
+ * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
505
+ * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
506
+ *
507
+ * If multiple filters are provided, they are combined with AND operator.
508
+ *
509
+ * Example:
510
+ * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
511
+ * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
512
+ * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
513
+ * @internal
514
+ * @maxSize 10
515
+ */
516
+ selectItemsBy?: Record<string, any>[] | null;
486
517
  }
487
518
  declare enum SortOrder {
488
519
  /** Ascending sort order. */
@@ -985,6 +1016,12 @@ interface UpdateProgram {
985
1016
  * @readonly
986
1017
  */
987
1018
  programDefinition?: ProgramDefinitionInfo;
1019
+ /**
1020
+ * Intended status of a program after the completion of an action.
1021
+ * @internal
1022
+ * @readonly
1023
+ */
1024
+ targetStatus?: ProgramStatusWithLiterals;
988
1025
  }
989
1026
  /**
990
1027
  * Retrieves a program.
@@ -1057,10 +1094,6 @@ interface ProgramsQueryBuilder {
1057
1094
  * @param string - String to compare against. Case-insensitive.
1058
1095
  */
1059
1096
  startsWith: (propertyName: '_id' | 'programDefinitionId' | 'namespace' | 'externalId' | 'programDefinition.id', value: string) => ProgramsQueryBuilder;
1060
- /** @param propertyName - Property whose value is compared with `values`.
1061
- * @param values - List of values to compare against.
1062
- */
1063
- hasSome: (propertyName: '_id' | '_createdDate' | 'programDefinitionId' | 'status' | 'namespace' | 'externalId' | 'programDefinition.id', value: any[]) => ProgramsQueryBuilder;
1064
1097
  in: (propertyName: '_id' | '_createdDate' | 'programDefinitionId' | 'status' | 'namespace' | 'externalId' | 'programDefinition.id', value: any) => ProgramsQueryBuilder;
1065
1098
  exists: (propertyName: '_id' | '_createdDate' | 'programDefinitionId' | 'status' | 'namespace' | 'externalId' | 'programDefinition.id', value: boolean) => ProgramsQueryBuilder;
1066
1099
  /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
@@ -1138,14 +1171,24 @@ type ProgramQuery = {
1138
1171
  Default: `ASC`
1139
1172
  */
1140
1173
  order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
1174
+ /**
1175
+ When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
1176
+ a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
1177
+
1178
+ If multiple filters are provided, they are combined with AND operator.
1179
+
1180
+ Example:
1181
+ Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
1182
+ and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
1183
+ { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
1184
+ @internal: undefined,
1185
+ @maxSize: 10
1186
+ */
1187
+ selectItemsBy?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['selectItemsBy'] | null;
1141
1188
  }[];
1142
1189
  };
1143
1190
  declare const utils: {
1144
- query: {
1145
- QueryBuilder: () => _wix_sdk_types.QueryBuilder<Program, ProgramQuerySpec, ProgramQuery>;
1146
- Filter: _wix_sdk_types.FilterFactory<Program, ProgramQuerySpec>;
1147
- Sort: _wix_sdk_types.SortFactory<ProgramQuerySpec>;
1148
- };
1191
+ query: _wix_sdk_types.QueryHelpers<Program, ProgramQuerySpec, ProgramQuery>;
1149
1192
  };
1150
1193
  /**
1151
1194
  * Retrieves a program with the specified external ID and namespace.
@@ -78,6 +78,12 @@ interface Program {
78
78
  * @readonly
79
79
  */
80
80
  programDefinition?: ProgramDefinitionInfo;
81
+ /**
82
+ * Intended status of a program after the completion of an action.
83
+ * @internal
84
+ * @readonly
85
+ */
86
+ targetStatus?: ProgramStatusWithLiterals;
81
87
  }
82
88
  declare enum ProgramStatus {
83
89
  /** Program is active. */
@@ -113,6 +119,12 @@ interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
113
119
  * @format GUID
114
120
  */
115
121
  wixUserId?: string;
122
+ /**
123
+ * Identity type.
124
+ * @internal
125
+ * @readonly
126
+ */
127
+ identityType?: IdentityTypeWithLiterals;
116
128
  }
117
129
  /** @oneof */
118
130
  interface CommonIdentificationDataIdOneOf {
@@ -431,6 +443,11 @@ interface UpsertMigratedProgramResponse {
431
443
  interface UpdateProgramRequest {
432
444
  /** Program to update. */
433
445
  program: Program;
446
+ /**
447
+ * Explicit list of fields to update.
448
+ * @internal
449
+ */
450
+ fieldMask?: string[];
434
451
  }
435
452
  interface UpdateProgramResponse {
436
453
  /** Updated program. */
@@ -483,6 +500,20 @@ interface Sorting {
483
500
  * Default: `ASC`
484
501
  */
485
502
  order?: SortOrderWithLiterals;
503
+ /**
504
+ * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
505
+ * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
506
+ *
507
+ * If multiple filters are provided, they are combined with AND operator.
508
+ *
509
+ * Example:
510
+ * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
511
+ * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
512
+ * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
513
+ * @internal
514
+ * @maxSize 10
515
+ */
516
+ selectItemsBy?: Record<string, any>[] | null;
486
517
  }
487
518
  declare enum SortOrder {
488
519
  /** Ascending sort order. */
@@ -611,8 +642,18 @@ interface DomainEventBodyOneOf {
611
642
  }
612
643
  interface EntityCreatedEvent {
613
644
  entityAsJson?: string;
645
+ /**
646
+ * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity
647
+ * @internal
648
+ */
649
+ triggeredByUndelete?: boolean | null;
614
650
  /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
615
651
  restoreInfo?: RestoreInfo;
652
+ /**
653
+ * Optional domain-specific metadata defined by the API owner, encoded as JSON.
654
+ * @internal
655
+ */
656
+ additionalMetadataAsJson?: string | null;
616
657
  }
617
658
  interface RestoreInfo {
618
659
  deletedDate?: Date | null;
@@ -624,10 +665,42 @@ interface EntityUpdatedEvent {
624
665
  * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
625
666
  */
626
667
  currentEntityAsJson?: string;
668
+ /**
669
+ * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard
670
+ * wont populate it / have any reference to it in the API.
671
+ * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,
672
+ * the developer should send only the new (current) entity.
673
+ * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big
674
+ * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.
675
+ * @internal
676
+ * @deprecated
677
+ */
678
+ previousEntityAsJson?: string | null;
679
+ /**
680
+ * Map of fully qualified field paths to their previous values for fields that changed.
681
+ * For more details please see [AIP](https://dev.wix.com/docs/rnd-general/articles/p13n-guidelines-aips/guidance-aips/design-patterns/7016-events#modified-fields-format)
682
+ * @internal
683
+ */
684
+ modifiedFields?: Record<string, any>;
685
+ /**
686
+ * Optional domain-specific metadata defined by the API owner, encoded as JSON.
687
+ * @internal
688
+ */
689
+ additionalMetadataAsJson?: string | null;
627
690
  }
628
691
  interface EntityDeletedEvent {
692
+ /**
693
+ * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled
694
+ * @internal
695
+ */
696
+ movedToTrash?: boolean | null;
629
697
  /** Entity that was deleted. */
630
698
  deletedEntityAsJson?: string | null;
699
+ /**
700
+ * Optional domain-specific metadata defined by the API owner, encoded as JSON.
701
+ * @internal
702
+ */
703
+ additionalMetadataAsJson?: string | null;
631
704
  }
632
705
  interface ActionEvent {
633
706
  bodyAsJson?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/auto_sdk_benefit-programs_programs",
3
- "version": "1.0.54",
3
+ "version": "1.0.56",
4
4
  "license": "MIT",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/",
@@ -21,23 +21,16 @@
21
21
  "import": "./build/es/meta.mjs",
22
22
  "require": "./build/cjs/meta.js",
23
23
  "types": "./build/es/meta.d.mts"
24
- },
25
- "./schemas": {
26
- "import": "./build/es/schemas.mjs",
27
- "require": "./build/cjs/schemas.js",
28
- "types": "./build/es/schemas.d.mts"
29
24
  }
30
25
  },
31
26
  "files": [
32
27
  "build",
33
28
  "meta",
34
- "service-plugins",
35
- "schemas"
29
+ "service-plugins"
36
30
  ],
37
31
  "dependencies": {
38
- "@wix/sdk-runtime": "^1.0.12",
39
- "@wix/sdk-types": "^1.17.7",
40
- "zod": "^4.3.6"
32
+ "@wix/sdk-runtime": "^1.0.24",
33
+ "@wix/sdk-types": "^1.17.11"
41
34
  },
42
35
  "devDependencies": {
43
36
  "tsup": "^8.4.0",
@@ -57,5 +50,5 @@
57
50
  "fqdn": "wix.benefit_programs.v1.program"
58
51
  }
59
52
  },
60
- "falconPackageHash": "a7d5e7658f220340a39a1ef12c60d4e82ffcabf049a13d18a31d3086"
53
+ "falconPackageHash": "2d40019f3e0ef0d3830c998ea20c1a426bc19f682e73f722949e0bed"
61
54
  }