@wix/sdk-types 1.13.25 → 1.13.27

package/build/browser/index.d.mts

@@ -321,6 +321,10 @@ type NumberOperators = '$eq' | '$ne' | '$gt' | '$lt' | '$gte' | '$lte' | '$exist
  * Operators available for boolean fields
  */
 type BooleanOperators = '$eq' | '$ne' | '$exists' | '$in' | '$nin';
+/**
+ * Operators available for enum fields
+ */
+type EnumOperators = '$eq' | '$ne' | '$in' | '$nin' | '$exists';
 /**
  * Operators available for date fields
  */
@@ -533,12 +537,18 @@ type SearchableFields<Spec extends SearchSpec> = Spec extends {
     searchable: readonly string[];
 } ? Spec['searchable'][number] : string;
 
+/**
+ * Helper type to detect if a type is an enum-like union of string literals
+ * This checks if the type is a union of specific string literals (not a generic string)
+ * It handles both simple enums and complex enum + literal unions like EnumWithTypeAlias
+ */
+type IsEnumLike<T> = T extends string | null | undefined ? string extends NonNullable<T> ? false : NonNullable<T> extends string ? true : false : false;
 /**
  * Determines operators applicable to a field based on its type
  * @template Entity The entity type
  * @template Path The field path to check
  */
-type ApplicableOperators<Entity, Path extends string> = Path extends keyof Entity ? Entity[Path] extends string | null | undefined ? StringOperators : Entity[Path] extends number | null | undefined ? NumberOperators : Entity[Path] extends boolean | null | undefined ? BooleanOperators : Entity[Path] extends Date | null | undefined ? DateOperators : Entity[Path] extends (infer E)[] | null | undefined ? E extends object ? ArrayOfObjectsOperators : ArrayOfPrimitivesOperators : Entity[Path] extends object | null | undefined ? ObjectOperators : never : Path extends `${infer K}.${infer R}` ? K extends keyof Entity ? Entity[K] extends (infer U)[] | null | undefined ? ApplicableOperators<NonNullable<U>, R> : Entity[K] extends object | null | undefined ? ApplicableOperators<NonNullable<Entity[K]>, R> : never : never : never;
+type ApplicableOperators<Entity, Path extends string> = Path extends keyof Entity ? Entity[Path] extends string | null | undefined ? IsEnumLike<Entity[Path]> extends true ? EnumOperators : StringOperators : Entity[Path] extends number | null | undefined ? NumberOperators : Entity[Path] extends boolean | null | undefined ? BooleanOperators : Entity[Path] extends Date | null | undefined ? DateOperators : Entity[Path] extends (infer E)[] | null | undefined ? E extends object ? ArrayOfObjectsOperators : ArrayOfPrimitivesOperators : Entity[Path] extends object | null | undefined ? ObjectOperators : never : Path extends `${infer K}.${infer R}` ? K extends keyof Entity ? Entity[K] extends (infer U)[] | null | undefined ? ApplicableOperators<NonNullable<U>, R> : Entity[K] extends object | null | undefined ? ApplicableOperators<NonNullable<Entity[K]>, R> : never : never : never;
 /**
  * Determines allowed operators for a field based on the search spec
  * @template Entity The entity type
@@ -630,6 +640,14 @@ interface ValueAggregation {
 interface RangeAggregation {
     buckets?: RangeBucket[];
 }
+/**
+ * Group by aggregation configuration
+ */
+interface GroupByAggregation {
+    name?: string | null;
+    fieldPath?: string | null;
+    value?: ValueAggregation;
+}
 /**
  * Scalar aggregation configuration
  */
@@ -673,6 +691,7 @@ type BaseAggregationWithoutType<Spec extends SearchSpec> = {
     range?: RangeAggregation;
     scalar?: ScalarAggregation;
     value?: ValueAggregation;
+    groupBy?: GroupByAggregation;
 };
 /**
  * Base aggregation interface

package/build/index.d.mts

@@ -321,6 +321,10 @@ type NumberOperators = '$eq' | '$ne' | '$gt' | '$lt' | '$gte' | '$lte' | '$exist
  * Operators available for boolean fields
  */
 type BooleanOperators = '$eq' | '$ne' | '$exists' | '$in' | '$nin';
+/**
+ * Operators available for enum fields
+ */
+type EnumOperators = '$eq' | '$ne' | '$in' | '$nin' | '$exists';
 /**
  * Operators available for date fields
  */
@@ -533,12 +537,18 @@ type SearchableFields<Spec extends SearchSpec> = Spec extends {
     searchable: readonly string[];
 } ? Spec['searchable'][number] : string;
 
+/**
+ * Helper type to detect if a type is an enum-like union of string literals
+ * This checks if the type is a union of specific string literals (not a generic string)
+ * It handles both simple enums and complex enum + literal unions like EnumWithTypeAlias
+ */
+type IsEnumLike<T> = T extends string | null | undefined ? string extends NonNullable<T> ? false : NonNullable<T> extends string ? true : false : false;
 /**
  * Determines operators applicable to a field based on its type
  * @template Entity The entity type
  * @template Path The field path to check
  */
-type ApplicableOperators<Entity, Path extends string> = Path extends keyof Entity ? Entity[Path] extends string | null | undefined ? StringOperators : Entity[Path] extends number | null | undefined ? NumberOperators : Entity[Path] extends boolean | null | undefined ? BooleanOperators : Entity[Path] extends Date | null | undefined ? DateOperators : Entity[Path] extends (infer E)[] | null | undefined ? E extends object ? ArrayOfObjectsOperators : ArrayOfPrimitivesOperators : Entity[Path] extends object | null | undefined ? ObjectOperators : never : Path extends `${infer K}.${infer R}` ? K extends keyof Entity ? Entity[K] extends (infer U)[] | null | undefined ? ApplicableOperators<NonNullable<U>, R> : Entity[K] extends object | null | undefined ? ApplicableOperators<NonNullable<Entity[K]>, R> : never : never : never;
+type ApplicableOperators<Entity, Path extends string> = Path extends keyof Entity ? Entity[Path] extends string | null | undefined ? IsEnumLike<Entity[Path]> extends true ? EnumOperators : StringOperators : Entity[Path] extends number | null | undefined ? NumberOperators : Entity[Path] extends boolean | null | undefined ? BooleanOperators : Entity[Path] extends Date | null | undefined ? DateOperators : Entity[Path] extends (infer E)[] | null | undefined ? E extends object ? ArrayOfObjectsOperators : ArrayOfPrimitivesOperators : Entity[Path] extends object | null | undefined ? ObjectOperators : never : Path extends `${infer K}.${infer R}` ? K extends keyof Entity ? Entity[K] extends (infer U)[] | null | undefined ? ApplicableOperators<NonNullable<U>, R> : Entity[K] extends object | null | undefined ? ApplicableOperators<NonNullable<Entity[K]>, R> : never : never : never;
 /**
  * Determines allowed operators for a field based on the search spec
  * @template Entity The entity type
@@ -630,6 +640,14 @@ interface ValueAggregation {
 interface RangeAggregation {
     buckets?: RangeBucket[];
 }
+/**
+ * Group by aggregation configuration
+ */
+interface GroupByAggregation {
+    name?: string | null;
+    fieldPath?: string | null;
+    value?: ValueAggregation;
+}
 /**
  * Scalar aggregation configuration
  */
@@ -673,6 +691,7 @@ type BaseAggregationWithoutType<Spec extends SearchSpec> = {
     range?: RangeAggregation;
     scalar?: ScalarAggregation;
     value?: ValueAggregation;
+    groupBy?: GroupByAggregation;
 };
 /**
  * Base aggregation interface

package/build/index.d.ts

@@ -321,6 +321,10 @@ type NumberOperators = '$eq' | '$ne' | '$gt' | '$lt' | '$gte' | '$lte' | '$exist
  * Operators available for boolean fields
  */
 type BooleanOperators = '$eq' | '$ne' | '$exists' | '$in' | '$nin';
+/**
+ * Operators available for enum fields
+ */
+type EnumOperators = '$eq' | '$ne' | '$in' | '$nin' | '$exists';
 /**
  * Operators available for date fields
  */
@@ -533,12 +537,18 @@ type SearchableFields<Spec extends SearchSpec> = Spec extends {
     searchable: readonly string[];
 } ? Spec['searchable'][number] : string;
 
+/**
+ * Helper type to detect if a type is an enum-like union of string literals
+ * This checks if the type is a union of specific string literals (not a generic string)
+ * It handles both simple enums and complex enum + literal unions like EnumWithTypeAlias
+ */
+type IsEnumLike<T> = T extends string | null | undefined ? string extends NonNullable<T> ? false : NonNullable<T> extends string ? true : false : false;
 /**
  * Determines operators applicable to a field based on its type
  * @template Entity The entity type
  * @template Path The field path to check
  */
-type ApplicableOperators<Entity, Path extends string> = Path extends keyof Entity ? Entity[Path] extends string | null | undefined ? StringOperators : Entity[Path] extends number | null | undefined ? NumberOperators : Entity[Path] extends boolean | null | undefined ? BooleanOperators : Entity[Path] extends Date | null | undefined ? DateOperators : Entity[Path] extends (infer E)[] | null | undefined ? E extends object ? ArrayOfObjectsOperators : ArrayOfPrimitivesOperators : Entity[Path] extends object | null | undefined ? ObjectOperators : never : Path extends `${infer K}.${infer R}` ? K extends keyof Entity ? Entity[K] extends (infer U)[] | null | undefined ? ApplicableOperators<NonNullable<U>, R> : Entity[K] extends object | null | undefined ? ApplicableOperators<NonNullable<Entity[K]>, R> : never : never : never;
+type ApplicableOperators<Entity, Path extends string> = Path extends keyof Entity ? Entity[Path] extends string | null | undefined ? IsEnumLike<Entity[Path]> extends true ? EnumOperators : StringOperators : Entity[Path] extends number | null | undefined ? NumberOperators : Entity[Path] extends boolean | null | undefined ? BooleanOperators : Entity[Path] extends Date | null | undefined ? DateOperators : Entity[Path] extends (infer E)[] | null | undefined ? E extends object ? ArrayOfObjectsOperators : ArrayOfPrimitivesOperators : Entity[Path] extends object | null | undefined ? ObjectOperators : never : Path extends `${infer K}.${infer R}` ? K extends keyof Entity ? Entity[K] extends (infer U)[] | null | undefined ? ApplicableOperators<NonNullable<U>, R> : Entity[K] extends object | null | undefined ? ApplicableOperators<NonNullable<Entity[K]>, R> : never : never : never;
 /**
  * Determines allowed operators for a field based on the search spec
  * @template Entity The entity type
@@ -630,6 +640,14 @@ interface ValueAggregation {
 interface RangeAggregation {
     buckets?: RangeBucket[];
 }
+/**
+ * Group by aggregation configuration
+ */
+interface GroupByAggregation {
+    name?: string | null;
+    fieldPath?: string | null;
+    value?: ValueAggregation;
+}
 /**
  * Scalar aggregation configuration
  */
@@ -673,6 +691,7 @@ type BaseAggregationWithoutType<Spec extends SearchSpec> = {
     range?: RangeAggregation;
     scalar?: ScalarAggregation;
     value?: ValueAggregation;
+    groupBy?: GroupByAggregation;
 };
 /**
  * Base aggregation interface

package/internal/build/browser/index.d.mts

@@ -390,6 +390,10 @@ type NumberOperators = '$eq' | '$ne' | '$gt' | '$lt' | '$gte' | '$lte' | '$exist
  * Operators available for boolean fields
  */
 type BooleanOperators = '$eq' | '$ne' | '$exists' | '$in' | '$nin';
+/**
+ * Operators available for enum fields
+ */
+type EnumOperators = '$eq' | '$ne' | '$in' | '$nin' | '$exists';
 /**
  * Operators available for date fields
  */
@@ -602,12 +606,18 @@ type SearchableFields<Spec extends SearchSpec> = Spec extends {
     searchable: readonly string[];
 } ? Spec['searchable'][number] : string;
 
+/**
+ * Helper type to detect if a type is an enum-like union of string literals
+ * This checks if the type is a union of specific string literals (not a generic string)
+ * It handles both simple enums and complex enum + literal unions like EnumWithTypeAlias
+ */
+type IsEnumLike<T> = T extends string | null | undefined ? string extends NonNullable<T> ? false : NonNullable<T> extends string ? true : false : false;
 /**
  * Determines operators applicable to a field based on its type
  * @template Entity The entity type
  * @template Path The field path to check
  */
-type ApplicableOperators<Entity, Path extends string> = Path extends keyof Entity ? Entity[Path] extends string | null | undefined ? StringOperators : Entity[Path] extends number | null | undefined ? NumberOperators : Entity[Path] extends boolean | null | undefined ? BooleanOperators : Entity[Path] extends Date | null | undefined ? DateOperators : Entity[Path] extends (infer E)[] | null | undefined ? E extends object ? ArrayOfObjectsOperators : ArrayOfPrimitivesOperators : Entity[Path] extends object | null | undefined ? ObjectOperators : never : Path extends `${infer K}.${infer R}` ? K extends keyof Entity ? Entity[K] extends (infer U)[] | null | undefined ? ApplicableOperators<NonNullable<U>, R> : Entity[K] extends object | null | undefined ? ApplicableOperators<NonNullable<Entity[K]>, R> : never : never : never;
+type ApplicableOperators<Entity, Path extends string> = Path extends keyof Entity ? Entity[Path] extends string | null | undefined ? IsEnumLike<Entity[Path]> extends true ? EnumOperators : StringOperators : Entity[Path] extends number | null | undefined ? NumberOperators : Entity[Path] extends boolean | null | undefined ? BooleanOperators : Entity[Path] extends Date | null | undefined ? DateOperators : Entity[Path] extends (infer E)[] | null | undefined ? E extends object ? ArrayOfObjectsOperators : ArrayOfPrimitivesOperators : Entity[Path] extends object | null | undefined ? ObjectOperators : never : Path extends `${infer K}.${infer R}` ? K extends keyof Entity ? Entity[K] extends (infer U)[] | null | undefined ? ApplicableOperators<NonNullable<U>, R> : Entity[K] extends object | null | undefined ? ApplicableOperators<NonNullable<Entity[K]>, R> : never : never : never;
 /**
  * Determines allowed operators for a field based on the search spec
  * @template Entity The entity type
@@ -699,6 +709,14 @@ interface ValueAggregation {
 interface RangeAggregation {
     buckets?: RangeBucket[];
 }
+/**
+ * Group by aggregation configuration
+ */
+interface GroupByAggregation {
+    name?: string | null;
+    fieldPath?: string | null;
+    value?: ValueAggregation;
+}
 /**
  * Scalar aggregation configuration
  */
@@ -742,6 +760,7 @@ type BaseAggregationWithoutType<Spec extends SearchSpec> = {
     range?: RangeAggregation;
     scalar?: ScalarAggregation;
     value?: ValueAggregation;
+    groupBy?: GroupByAggregation;
 };
 /**
  * Base aggregation interface

package/internal/build/index.d.mts

@@ -390,6 +390,10 @@ type NumberOperators = '$eq' | '$ne' | '$gt' | '$lt' | '$gte' | '$lte' | '$exist
  * Operators available for boolean fields
  */
 type BooleanOperators = '$eq' | '$ne' | '$exists' | '$in' | '$nin';
+/**
+ * Operators available for enum fields
+ */
+type EnumOperators = '$eq' | '$ne' | '$in' | '$nin' | '$exists';
 /**
  * Operators available for date fields
  */
@@ -602,12 +606,18 @@ type SearchableFields<Spec extends SearchSpec> = Spec extends {
     searchable: readonly string[];
 } ? Spec['searchable'][number] : string;
 
+/**
+ * Helper type to detect if a type is an enum-like union of string literals
+ * This checks if the type is a union of specific string literals (not a generic string)
+ * It handles both simple enums and complex enum + literal unions like EnumWithTypeAlias
+ */
+type IsEnumLike<T> = T extends string | null | undefined ? string extends NonNullable<T> ? false : NonNullable<T> extends string ? true : false : false;
 /**
  * Determines operators applicable to a field based on its type
  * @template Entity The entity type
  * @template Path The field path to check
  */
-type ApplicableOperators<Entity, Path extends string> = Path extends keyof Entity ? Entity[Path] extends string | null | undefined ? StringOperators : Entity[Path] extends number | null | undefined ? NumberOperators : Entity[Path] extends boolean | null | undefined ? BooleanOperators : Entity[Path] extends Date | null | undefined ? DateOperators : Entity[Path] extends (infer E)[] | null | undefined ? E extends object ? ArrayOfObjectsOperators : ArrayOfPrimitivesOperators : Entity[Path] extends object | null | undefined ? ObjectOperators : never : Path extends `${infer K}.${infer R}` ? K extends keyof Entity ? Entity[K] extends (infer U)[] | null | undefined ? ApplicableOperators<NonNullable<U>, R> : Entity[K] extends object | null | undefined ? ApplicableOperators<NonNullable<Entity[K]>, R> : never : never : never;
+type ApplicableOperators<Entity, Path extends string> = Path extends keyof Entity ? Entity[Path] extends string | null | undefined ? IsEnumLike<Entity[Path]> extends true ? EnumOperators : StringOperators : Entity[Path] extends number | null | undefined ? NumberOperators : Entity[Path] extends boolean | null | undefined ? BooleanOperators : Entity[Path] extends Date | null | undefined ? DateOperators : Entity[Path] extends (infer E)[] | null | undefined ? E extends object ? ArrayOfObjectsOperators : ArrayOfPrimitivesOperators : Entity[Path] extends object | null | undefined ? ObjectOperators : never : Path extends `${infer K}.${infer R}` ? K extends keyof Entity ? Entity[K] extends (infer U)[] | null | undefined ? ApplicableOperators<NonNullable<U>, R> : Entity[K] extends object | null | undefined ? ApplicableOperators<NonNullable<Entity[K]>, R> : never : never : never;
 /**
  * Determines allowed operators for a field based on the search spec
  * @template Entity The entity type
@@ -699,6 +709,14 @@ interface ValueAggregation {
 interface RangeAggregation {
     buckets?: RangeBucket[];
 }
+/**
+ * Group by aggregation configuration
+ */
+interface GroupByAggregation {
+    name?: string | null;
+    fieldPath?: string | null;
+    value?: ValueAggregation;
+}
 /**
  * Scalar aggregation configuration
  */
@@ -742,6 +760,7 @@ type BaseAggregationWithoutType<Spec extends SearchSpec> = {
     range?: RangeAggregation;
     scalar?: ScalarAggregation;
     value?: ValueAggregation;
+    groupBy?: GroupByAggregation;
 };
 /**
  * Base aggregation interface

package/internal/build/index.d.ts

@@ -390,6 +390,10 @@ type NumberOperators = '$eq' | '$ne' | '$gt' | '$lt' | '$gte' | '$lte' | '$exist
  * Operators available for boolean fields
  */
 type BooleanOperators = '$eq' | '$ne' | '$exists' | '$in' | '$nin';
+/**
+ * Operators available for enum fields
+ */
+type EnumOperators = '$eq' | '$ne' | '$in' | '$nin' | '$exists';
 /**
  * Operators available for date fields
  */
@@ -602,12 +606,18 @@ type SearchableFields<Spec extends SearchSpec> = Spec extends {
     searchable: readonly string[];
 } ? Spec['searchable'][number] : string;
 
+/**
+ * Helper type to detect if a type is an enum-like union of string literals
+ * This checks if the type is a union of specific string literals (not a generic string)
+ * It handles both simple enums and complex enum + literal unions like EnumWithTypeAlias
+ */
+type IsEnumLike<T> = T extends string | null | undefined ? string extends NonNullable<T> ? false : NonNullable<T> extends string ? true : false : false;
 /**
  * Determines operators applicable to a field based on its type
  * @template Entity The entity type
  * @template Path The field path to check
  */
-type ApplicableOperators<Entity, Path extends string> = Path extends keyof Entity ? Entity[Path] extends string | null | undefined ? StringOperators : Entity[Path] extends number | null | undefined ? NumberOperators : Entity[Path] extends boolean | null | undefined ? BooleanOperators : Entity[Path] extends Date | null | undefined ? DateOperators : Entity[Path] extends (infer E)[] | null | undefined ? E extends object ? ArrayOfObjectsOperators : ArrayOfPrimitivesOperators : Entity[Path] extends object | null | undefined ? ObjectOperators : never : Path extends `${infer K}.${infer R}` ? K extends keyof Entity ? Entity[K] extends (infer U)[] | null | undefined ? ApplicableOperators<NonNullable<U>, R> : Entity[K] extends object | null | undefined ? ApplicableOperators<NonNullable<Entity[K]>, R> : never : never : never;
+type ApplicableOperators<Entity, Path extends string> = Path extends keyof Entity ? Entity[Path] extends string | null | undefined ? IsEnumLike<Entity[Path]> extends true ? EnumOperators : StringOperators : Entity[Path] extends number | null | undefined ? NumberOperators : Entity[Path] extends boolean | null | undefined ? BooleanOperators : Entity[Path] extends Date | null | undefined ? DateOperators : Entity[Path] extends (infer E)[] | null | undefined ? E extends object ? ArrayOfObjectsOperators : ArrayOfPrimitivesOperators : Entity[Path] extends object | null | undefined ? ObjectOperators : never : Path extends `${infer K}.${infer R}` ? K extends keyof Entity ? Entity[K] extends (infer U)[] | null | undefined ? ApplicableOperators<NonNullable<U>, R> : Entity[K] extends object | null | undefined ? ApplicableOperators<NonNullable<Entity[K]>, R> : never : never : never;
 /**
  * Determines allowed operators for a field based on the search spec
  * @template Entity The entity type
@@ -699,6 +709,14 @@ interface ValueAggregation {
 interface RangeAggregation {
     buckets?: RangeBucket[];
 }
+/**
+ * Group by aggregation configuration
+ */
+interface GroupByAggregation {
+    name?: string | null;
+    fieldPath?: string | null;
+    value?: ValueAggregation;
+}
 /**
  * Scalar aggregation configuration
  */
@@ -742,6 +760,7 @@ type BaseAggregationWithoutType<Spec extends SearchSpec> = {
     range?: RangeAggregation;
     scalar?: ScalarAggregation;
     value?: ValueAggregation;
+    groupBy?: GroupByAggregation;
 };
 /**
  * Base aggregation interface

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/sdk-types",
-  "version": "1.13.25",
+  "version": "1.13.27",
   "license": "MIT",
   "author": {
     "name": "Ronny Ringel",
@@ -30,12 +30,12 @@
     "*.{js,ts}": "yarn lint"
   },
   "dependencies": {
-    "@wix/error-handler-types": "^1.6.0",
+    "@wix/error-handler-types": "^1.7.0",
     "@wix/monitoring-types": "^0.12.0",
     "type-fest": "^4.41.0"
   },
   "devDependencies": {
-    "@types/node": "^20.17.47",
+    "@types/node": "^20.17.50",
     "eslint": "^8.57.1",
     "eslint-config-sdk": "0.0.0",
     "tsup": "^7.3.0",
@@ -62,5 +62,5 @@
   "wallaby": {
     "autoDetect": true
   },
-  "falconPackageHash": "daf115af3a2d78a3098d8de49edd1587ee8fb49858364957e149e667"
+  "falconPackageHash": "e7c3abb583a6a4d25b4f984896ab8cb74e0c24603bf5693f3f7af15a"
 }