@wix/auto_sdk_benefit-programs_pool-definition-items 1.0.24 → 1.0.26

package/build/internal/cjs/meta.d.ts

@@ -121,6 +121,30 @@ interface PoolDefinitionItem {
      * @readonly
      */
     removed?: boolean | null;
+    /**
+     * Monotonic counter incremented on every change, including system/materialization updates that do not bump revision.
+     * @internal
+     * @readonly
+     */
+    poolDefinitionChangesCounter?: string | null;
+    /**
+     * Last revision number of the corresponding pool definition that this entity was created from
+     * @internal
+     * @readonly
+     */
+    poolDefinitionRevision?: string | null;
+    /**
+     * Monotonic counter incremented on every change, including system/materialization updates that do not bump revision.
+     * @internal
+     * @readonly
+     */
+    itemChangesCounter?: string | null;
+    /**
+     * Last revision number of the corresponding item that this entity was created from
+     * @internal
+     * @readonly
+     */
+    itemRevision?: string | null;
 }
 interface PoolDefinitionInfo {
     /**
@@ -244,6 +268,20 @@ interface Sorting {
     fieldName?: string;
     /** Sort order. */
     order?: SortOrderWithLiterals;
+    /**
+     * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
+     * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
+     *
+     * If multiple filters are provided, they are combined with AND operator.
+     *
+     * Example:
+     * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
+     * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
+     * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
+     * @internal
+     * @maxSize 10
+     */
+    selectItemsBy?: Record<string, any>[] | null;
 }
 declare enum SortOrder {
     ASC = "ASC",
@@ -500,8 +538,18 @@ interface DomainEventBodyOneOf {
 }
 interface EntityCreatedEvent {
     entityAsJson?: string;
+    /**
+     * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity
+     * @internal
+     */
+    triggeredByUndelete?: boolean | null;
     /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
     restoreInfo?: RestoreInfo;
+    /**
+     * Optional domain-specific metadata defined by the API owner, encoded as JSON.
+     * @internal
+     */
+    additionalMetadataAsJson?: string | null;
 }
 interface RestoreInfo {
     deletedDate?: Date | null;
@@ -513,10 +561,42 @@ interface EntityUpdatedEvent {
      * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
      */
     currentEntityAsJson?: string;
+    /**
+     * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard
+     * wont populate it / have any reference to it in the API.
+     * 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,
+     * the developer should send only the new (current) entity.
+     * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big
+     * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.
+     * @internal
+     * @deprecated
+     */
+    previousEntityAsJson?: string | null;
+    /**
+     * Map of fully qualified field paths to their previous values for fields that changed.
+     * 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)
+     * @internal
+     */
+    modifiedFields?: Record<string, any>;
+    /**
+     * Optional domain-specific metadata defined by the API owner, encoded as JSON.
+     * @internal
+     */
+    additionalMetadataAsJson?: string | null;
 }
 interface EntityDeletedEvent {
+    /**
+     * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled
+     * @internal
+     */
+    movedToTrash?: boolean | null;
     /** Entity that was deleted. */
     deletedEntityAsJson?: string | null;
+    /**
+     * Optional domain-specific metadata defined by the API owner, encoded as JSON.
+     * @internal
+     */
+    additionalMetadataAsJson?: string | null;
 }
 interface ActionEvent {
     bodyAsJson?: string;

package/build/internal/es/index.typings.d.mts

@@ -121,6 +121,30 @@ interface PoolDefinitionItem {
      * @readonly
      */
     removed?: boolean | null;
+    /**
+     * Monotonic counter incremented on every change, including system/materialization updates that do not bump revision.
+     * @internal
+     * @readonly
+     */
+    poolDefinitionChangesCounter?: string | null;
+    /**
+     * Last revision number of the corresponding pool definition that this entity was created from
+     * @internal
+     * @readonly
+     */
+    poolDefinitionRevision?: string | null;
+    /**
+     * Monotonic counter incremented on every change, including system/materialization updates that do not bump revision.
+     * @internal
+     * @readonly
+     */
+    itemChangesCounter?: string | null;
+    /**
+     * Last revision number of the corresponding item that this entity was created from
+     * @internal
+     * @readonly
+     */
+    itemRevision?: string | null;
 }
 interface PoolDefinitionInfo {
     /**
@@ -244,6 +268,20 @@ interface Sorting {
     fieldName?: string;
     /** Sort order. */
     order?: SortOrderWithLiterals;
+    /**
+     * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
+     * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
+     *
+     * If multiple filters are provided, they are combined with AND operator.
+     *
+     * Example:
+     * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
+     * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
+     * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
+     * @internal
+     * @maxSize 10
+     */
+    selectItemsBy?: Record<string, any>[] | null;
 }
 declare enum SortOrder {
     ASC = "ASC",
@@ -687,10 +725,6 @@ interface PoolDefinitionItemsQueryBuilder {
      * @param string - String to compare against. Case-insensitive.
      */
     startsWith: (propertyName: '_id' | 'externalId' | 'category' | 'providerAppId' | 'namespace' | 'poolDefinitionId' | 'itemSetId' | 'programDefinitions.id' | 'programDefinitions.externalId' | 'benefitKey' | 'itemSearchKey', value: string) => PoolDefinitionItemsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `values`.
-     * @param values - List of values to compare against.
-     */
-    hasSome: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'providerAppId' | 'namespace' | 'poolDefinitionId' | 'itemSetId' | 'programDefinitions.id' | 'programDefinitions.externalId' | 'benefitKey' | 'itemSearchKey', value: any[]) => PoolDefinitionItemsQueryBuilder;
     in: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'providerAppId' | 'namespace' | 'poolDefinitionId' | 'itemSetId' | 'programDefinitions.id' | 'programDefinitions.externalId' | 'benefitKey' | 'itemSearchKey', value: any) => PoolDefinitionItemsQueryBuilder;
     exists: (propertyName: '_id' | '_createdDate' | 'externalId' | 'category' | 'providerAppId' | 'namespace' | 'poolDefinitionId' | 'itemSetId' | 'programDefinitions.id' | 'programDefinitions.externalId' | 'benefitKey' | 'itemSearchKey', value: boolean) => PoolDefinitionItemsQueryBuilder;
     /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
@@ -779,14 +813,24 @@ type PoolDefinitionItemQuery = {
       Sort order.
       */
         order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
+        /**
+      When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
+      a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
+    
+      If multiple filters are provided, they are combined with AND operator.
+    
+      Example:
+      Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
+      and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
+      { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
+      @internal: undefined,
+      @maxSize: 10
+      */
+        selectItemsBy?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['selectItemsBy'] | null;
     }[];
 };
 declare const utils: {
-    query: {
-        QueryBuilder: () => _wix_sdk_types.QueryBuilder<PoolDefinitionItem, PoolDefinitionItemQuerySpec, PoolDefinitionItemQuery>;
-        Filter: _wix_sdk_types.FilterFactory<PoolDefinitionItem, PoolDefinitionItemQuerySpec>;
-        Sort: _wix_sdk_types.SortFactory<PoolDefinitionItemQuerySpec>;
-    };
+    query: _wix_sdk_types.QueryHelpers<PoolDefinitionItem, PoolDefinitionItemQuerySpec, PoolDefinitionItemQuery>;
 };
 /**
  * Removes items from a benefit. The service removes items asynchronously. They may briefly still appear in

package/build/internal/es/meta.d.mts

@@ -121,6 +121,30 @@ interface PoolDefinitionItem {
      * @readonly
      */
     removed?: boolean | null;
+    /**
+     * Monotonic counter incremented on every change, including system/materialization updates that do not bump revision.
+     * @internal
+     * @readonly
+     */
+    poolDefinitionChangesCounter?: string | null;
+    /**
+     * Last revision number of the corresponding pool definition that this entity was created from
+     * @internal
+     * @readonly
+     */
+    poolDefinitionRevision?: string | null;
+    /**
+     * Monotonic counter incremented on every change, including system/materialization updates that do not bump revision.
+     * @internal
+     * @readonly
+     */
+    itemChangesCounter?: string | null;
+    /**
+     * Last revision number of the corresponding item that this entity was created from
+     * @internal
+     * @readonly
+     */
+    itemRevision?: string | null;
 }
 interface PoolDefinitionInfo {
     /**
@@ -244,6 +268,20 @@ interface Sorting {
     fieldName?: string;
     /** Sort order. */
     order?: SortOrderWithLiterals;
+    /**
+     * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
+     * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
+     *
+     * If multiple filters are provided, they are combined with AND operator.
+     *
+     * Example:
+     * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
+     * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
+     * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
+     * @internal
+     * @maxSize 10
+     */
+    selectItemsBy?: Record<string, any>[] | null;
 }
 declare enum SortOrder {
     ASC = "ASC",
@@ -500,8 +538,18 @@ interface DomainEventBodyOneOf {
 }
 interface EntityCreatedEvent {
     entityAsJson?: string;
+    /**
+     * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity
+     * @internal
+     */
+    triggeredByUndelete?: boolean | null;
     /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
     restoreInfo?: RestoreInfo;
+    /**
+     * Optional domain-specific metadata defined by the API owner, encoded as JSON.
+     * @internal
+     */
+    additionalMetadataAsJson?: string | null;
 }
 interface RestoreInfo {
     deletedDate?: Date | null;
@@ -513,10 +561,42 @@ interface EntityUpdatedEvent {
      * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
      */
     currentEntityAsJson?: string;
+    /**
+     * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard
+     * wont populate it / have any reference to it in the API.
+     * 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,
+     * the developer should send only the new (current) entity.
+     * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big
+     * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.
+     * @internal
+     * @deprecated
+     */
+    previousEntityAsJson?: string | null;
+    /**
+     * Map of fully qualified field paths to their previous values for fields that changed.
+     * 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)
+     * @internal
+     */
+    modifiedFields?: Record<string, any>;
+    /**
+     * Optional domain-specific metadata defined by the API owner, encoded as JSON.
+     * @internal
+     */
+    additionalMetadataAsJson?: string | null;
 }
 interface EntityDeletedEvent {
+    /**
+     * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled
+     * @internal
+     */
+    movedToTrash?: boolean | null;
     /** Entity that was deleted. */
     deletedEntityAsJson?: string | null;
+    /**
+     * Optional domain-specific metadata defined by the API owner, encoded as JSON.
+     * @internal
+     */
+    additionalMetadataAsJson?: string | null;
 }
 interface ActionEvent {
     bodyAsJson?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/auto_sdk_benefit-programs_pool-definition-items",
-  "version": "1.0.24",
+  "version": "1.0.26",
   "license": "MIT",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
@@ -21,23 +21,16 @@
       "import": "./build/es/meta.mjs",
       "require": "./build/cjs/meta.js",
       "types": "./build/es/meta.d.mts"
-    },
-    "./schemas": {
-      "import": "./build/es/schemas.mjs",
-      "require": "./build/cjs/schemas.js",
-      "types": "./build/es/schemas.d.mts"
     }
   },
   "files": [
     "build",
     "meta",
-    "service-plugins",
-    "schemas"
+    "service-plugins"
   ],
   "dependencies": {
-    "@wix/sdk-runtime": "^1.0.12",
-    "@wix/sdk-types": "^1.17.7",
-    "zod": "^4.3.6"
+    "@wix/sdk-runtime": "^1.0.24",
+    "@wix/sdk-types": "^1.17.11"
   },
   "devDependencies": {
     "tsup": "^8.4.0",
@@ -57,5 +50,5 @@
       "fqdn": "wix.benefit_programs.v1.pool_definition_item"
     }
   },
-  "falconPackageHash": "50e5389b8cc3b43b8e5a596ff44923b52cab2253db96b7fccb3173e3"
+  "falconPackageHash": "06912b09d817f54bfce3904c8d18b98b7205b7258561c7bb21abd407"
 }

package/build/cjs/schemas.d.ts

@@ -1,138 +0,0 @@
-import * as z from 'zod';
-
-declare const QueryPoolDefinitionItemsRequest: z.ZodObject<{
-    query: z.ZodIntersection<z.ZodObject<{
-        filter: z.ZodNullable<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
-        sort: z.ZodOptional<z.ZodArray<z.ZodObject<{
-            fieldName: z.ZodOptional<z.ZodString>;
-            order: z.ZodOptional<z.ZodEnum<{
-                ASC: "ASC";
-                DESC: "DESC";
-            }>>;
-        }, z.core.$strip>>>;
-    }, z.core.$strip>, z.ZodXor<readonly [z.ZodObject<{
-        cursorPaging: z.ZodOptional<z.ZodNever>;
-    }, z.core.$strip>, z.ZodObject<{
-        cursorPaging: z.ZodObject<{
-            limit: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
-            cursor: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-        }, z.core.$strip>;
-    }, z.core.$strip>]>>;
-    options: z.ZodOptional<z.ZodObject<{
-        fields: z.ZodOptional<z.ZodArray<z.ZodEnum<{
-            POOL_DEFINITION: "POOL_DEFINITION";
-            PROGRAM_DEFINITION: "PROGRAM_DEFINITION";
-            BENEFIT: "BENEFIT";
-            ITEM: "ITEM";
-        }>>>;
-    }, z.core.$strip>>;
-}, z.core.$strip>;
-declare const QueryPoolDefinitionItemsResponse: z.ZodObject<{
-    poolDefinitionItems: z.ZodOptional<z.ZodArray<z.ZodObject<{
-        _id: z.ZodOptional<z.ZodString>;
-        revision: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-        _createdDate: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
-        _updatedDate: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
-        externalId: z.ZodOptional<z.ZodString>;
-        category: z.ZodOptional<z.ZodString>;
-        providerAppId: z.ZodOptional<z.ZodString>;
-        namespace: z.ZodOptional<z.ZodString>;
-        poolDefinitionId: z.ZodOptional<z.ZodString>;
-        itemSetId: z.ZodOptional<z.ZodString>;
-        poolDefinition: z.ZodOptional<z.ZodObject<{
-            displayName: z.ZodOptional<z.ZodString>;
-            description: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-            creditConfiguration: z.ZodOptional<z.ZodObject<{
-                amount: z.ZodOptional<z.ZodString>;
-                unitDisplayName: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-                unitType: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-            }, z.core.$strip>>;
-        }, z.core.$strip>>;
-        programDefinitions: z.ZodOptional<z.ZodArray<z.ZodObject<{
-            _id: z.ZodOptional<z.ZodString>;
-            externalId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-            displayName: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-            description: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-        }, z.core.$strip>>>;
-        itemId: z.ZodOptional<z.ZodString>;
-        benefitInfo: z.ZodOptional<z.ZodObject<{
-            price: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-            displayName: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-            description: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-        }, z.core.$strip>>;
-        itemInfo: z.ZodOptional<z.ZodObject<{
-            displayName: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-        }, z.core.$strip>>;
-        benefitKey: z.ZodOptional<z.ZodString>;
-        itemSearchKey: z.ZodOptional<z.ZodString>;
-        removed: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
-    }, z.core.$strip>>>;
-    metadata: z.ZodOptional<z.ZodObject<{
-        count: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
-        cursors: z.ZodOptional<z.ZodObject<{
-            next: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-            prev: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-        }, z.core.$strip>>;
-        hasNext: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
-    }, z.core.$strip>>;
-}, z.core.$strip>;
-declare const RemoveItemsFromBenefitRequest: z.ZodObject<{
-    itemReferences: z.ZodArray<z.ZodObject<{
-        externalId: z.ZodString;
-        category: z.ZodOptional<z.ZodString>;
-    }, z.core.$strip>>;
-    options: z.ZodObject<{
-        poolDefinitionId: z.ZodString;
-        benefitKey: z.ZodString;
-    }, z.core.$strip>;
-}, z.core.$strip>;
-declare const RemoveItemsFromBenefitResponse: z.ZodObject<{
-    results: z.ZodOptional<z.ZodArray<z.ZodObject<{
-        itemMetadata: z.ZodOptional<z.ZodObject<{
-            _id: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-            originalIndex: z.ZodOptional<z.ZodNumber>;
-            success: z.ZodOptional<z.ZodBoolean>;
-            error: z.ZodOptional<z.ZodObject<{
-                code: z.ZodOptional<z.ZodString>;
-                description: z.ZodOptional<z.ZodString>;
-                data: z.ZodNullable<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
-            }, z.core.$strip>>;
-        }, z.core.$strip>>;
-    }, z.core.$strip>>>;
-    bulkActionMetadata: z.ZodOptional<z.ZodObject<{
-        totalSuccesses: z.ZodOptional<z.ZodNumber>;
-        totalFailures: z.ZodOptional<z.ZodNumber>;
-        undetailedFailures: z.ZodOptional<z.ZodNumber>;
-    }, z.core.$strip>>;
-}, z.core.$strip>;
-declare const AddItemsToBenefitRequest: z.ZodObject<{
-    itemReferences: z.ZodArray<z.ZodObject<{
-        externalId: z.ZodString;
-        category: z.ZodOptional<z.ZodString>;
-    }, z.core.$strip>>;
-    options: z.ZodObject<{
-        poolDefinitionId: z.ZodString;
-        benefitKey: z.ZodString;
-    }, z.core.$strip>;
-}, z.core.$strip>;
-declare const AddItemsToBenefitResponse: z.ZodObject<{
-    results: z.ZodOptional<z.ZodArray<z.ZodObject<{
-        itemMetadata: z.ZodOptional<z.ZodObject<{
-            _id: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-            originalIndex: z.ZodOptional<z.ZodNumber>;
-            success: z.ZodOptional<z.ZodBoolean>;
-            error: z.ZodOptional<z.ZodObject<{
-                code: z.ZodOptional<z.ZodString>;
-                description: z.ZodOptional<z.ZodString>;
-                data: z.ZodNullable<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
-            }, z.core.$strip>>;
-        }, z.core.$strip>>;
-    }, z.core.$strip>>>;
-    bulkActionMetadata: z.ZodOptional<z.ZodObject<{
-        totalSuccesses: z.ZodOptional<z.ZodNumber>;
-        totalFailures: z.ZodOptional<z.ZodNumber>;
-        undetailedFailures: z.ZodOptional<z.ZodNumber>;
-    }, z.core.$strip>>;
-}, z.core.$strip>;
-
-export { AddItemsToBenefitRequest, AddItemsToBenefitResponse, QueryPoolDefinitionItemsRequest, QueryPoolDefinitionItemsResponse, RemoveItemsFromBenefitRequest, RemoveItemsFromBenefitResponse };