@wix/wix-data-items-common 1.0.296 → 1.0.297

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 (7) hide show
  1. package/dist/cjs/api/WixDataSearchBuilder.js +36 -0
  2. package/dist/cjs/api/WixDataSearchBuilder.js.map +1 -1
  3. package/dist/esm/api/WixDataSearchBuilder.js +34 -0
  4. package/dist/esm/api/WixDataSearchBuilder.js.map +1 -1
  5. package/dist/types/api/WixDataSearchBuilder.d.ts +34 -0
  6. package/dist/types/api/WixDataSearchBuilder.d.ts.map +1 -1
  7. package/package.json +2 -2
package/dist/cjs/api/WixDataSearchBuilder.js CHANGED
@@ -15,6 +15,42 @@ var _searchBuilderUtils = require("@wix/sdk-runtime/search-builder-utils");
15
15
  */
16
16
 
17
17
  const searchUtils = (0, _searchBuilderUtils.createSearchUtils)();
18
+
19
+ /**
20
+ * Creates a new WixData search builder.
21
+ * @internal
22
+ *
23
+ * @example
24
+ * ```ts
25
+ * import { SearchBuilder, SearchParams } from '@wix/wix-data-items-common'
26
+ *
27
+ * const request = SearchBuilder()
28
+ * .withSearch(SearchParams.expression('red car'))
29
+ * .withFilter({ status: 'active' })
30
+ * .withPaging({ limit: 10, offset: 0 })
31
+ * .build()
32
+ *
33
+ * const result = await wixData.search('myCollection', request)
34
+ * ```
35
+ */
18
36
  const SearchBuilder = exports.SearchBuilder = searchUtils.SearchBuilder;
37
+
38
+ /**
39
+ * Search parameter factory for creating search expressions.
40
+ * Uses the SDK's SearchParams with WixData types.
41
+ * @internal
42
+ *
43
+ * @example
44
+ * ```ts
45
+ * // Simple expression
46
+ * SearchParams.expression('search text')
47
+ *
48
+ * // Fuzzy search
49
+ * SearchParams.fuzzy(true)
50
+ *
51
+ * // AND mode (all terms must match)
52
+ * SearchParams.mode('AND')
53
+ * ```
54
+ */
19
55
  const SearchParams = exports.SearchParams = searchUtils.SearchParams;
20
56
  //# sourceMappingURL=WixDataSearchBuilder.js.map
package/dist/cjs/api/WixDataSearchBuilder.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"names":["_searchBuilderUtils","require","searchUtils","createSearchUtils","SearchBuilder","exports","SearchParams"],"sources":["../../../src/api/WixDataSearchBuilder.ts"],"sourcesContent":["import { createSearchUtils } from '@wix/sdk-runtime/search-builder-utils'\nimport type {\n SearchSpec,\n SearchBuilder as SDKSearchBuilder,\n SearchRequest,\n} from '@wix/sdk-types'\nimport type { WixDataItem } from './types'\n\n/**\n * WixData SearchSpec - allows searching/sorting on any string field\n * since WixData collections are dynamic and don't have a fixed schema.\n */\ninterface WixDataSearchSpec extends SearchSpec {\n wql: [\n {\n fields: string[]\n sort: 'BOTH'\n }\n ]\n paging: 'offset' | 'cursor'\n}\n\ntype WixDataSearchRequest = SearchRequest<WixDataItem, WixDataSearchSpec>\n\n/**\n * WixData SearchBuilder type.\n * Omits withAggregation and withTimeZone which are not supported by WixData search.\n * @internal\n */\nexport type WixDataSearchBuilder = Omit<\n SDKSearchBuilder<WixDataItem, WixDataSearchSpec, WixDataSearchRequest>,\n 'withAggregation' | 'withTimeZone'\n>\n\nconst searchUtils = createSearchUtils<WixDataItem, WixDataSearchSpec>()\n\nexport const SearchBuilder: () => WixDataSearchBuilder =\n searchUtils.SearchBuilder\nexport const SearchParams = searchUtils.SearchParams\n"],"mappings":";;;;AAAA,IAAAA,mBAAA,GAAAC,OAAA;AAQA;AACA;AACA;AACA;;AAaA;AACA;AACA;AACA;AACA;;AAMA,MAAMC,WAAW,GAAG,IAAAC,qCAAiB,EAAiC,CAAC;AAEhE,MAAMC,aAAyC,GAAAC,OAAA,CAAAD,aAAA,GACpDF,WAAW,CAACE,aAAa;AACpB,MAAME,YAAY,GAAAD,OAAA,CAAAC,YAAA,GAAGJ,WAAW,CAACI,YAAY","ignoreList":[]}
1
+ {"version":3,"names":["_searchBuilderUtils","require","searchUtils","createSearchUtils","SearchBuilder","exports","SearchParams"],"sources":["../../../src/api/WixDataSearchBuilder.ts"],"sourcesContent":["import { createSearchUtils } from '@wix/sdk-runtime/search-builder-utils'\nimport type {\n SearchSpec,\n SearchBuilder as SDKSearchBuilder,\n SearchRequest,\n} from '@wix/sdk-types'\nimport type { WixDataItem } from './types'\n\n/**\n * WixData SearchSpec - allows searching/sorting on any string field\n * since WixData collections are dynamic and don't have a fixed schema.\n */\ninterface WixDataSearchSpec extends SearchSpec {\n wql: [\n {\n fields: string[]\n sort: 'BOTH'\n }\n ]\n paging: 'offset' | 'cursor'\n}\n\ntype WixDataSearchRequest = SearchRequest<WixDataItem, WixDataSearchSpec>\n\n/**\n * WixData SearchBuilder type.\n * Omits withAggregation and withTimeZone which are not supported by WixData search.\n * @internal\n */\nexport type WixDataSearchBuilder = Omit<\n SDKSearchBuilder<WixDataItem, WixDataSearchSpec, WixDataSearchRequest>,\n 'withAggregation' | 'withTimeZone'\n>\n\nconst searchUtils = createSearchUtils<WixDataItem, WixDataSearchSpec>()\n\n/**\n * Creates a new WixData search builder.\n * @internal\n *\n * @example\n * ```ts\n * import { SearchBuilder, SearchParams } from '@wix/wix-data-items-common'\n *\n * const request = SearchBuilder()\n * .withSearch(SearchParams.expression('red car'))\n * .withFilter({ status: 'active' })\n * .withPaging({ limit: 10, offset: 0 })\n * .build()\n *\n * const result = await wixData.search('myCollection', request)\n * ```\n */\nexport const SearchBuilder: () => WixDataSearchBuilder =\n searchUtils.SearchBuilder\n\n/**\n * Search parameter factory for creating search expressions.\n * Uses the SDK's SearchParams with WixData types.\n * @internal\n *\n * @example\n * ```ts\n * // Simple expression\n * SearchParams.expression('search text')\n *\n * // Fuzzy search\n * SearchParams.fuzzy(true)\n *\n * // AND mode (all terms must match)\n * SearchParams.mode('AND')\n * ```\n */\nexport const SearchParams = searchUtils.SearchParams\n"],"mappings":";;;;AAAA,IAAAA,mBAAA,GAAAC,OAAA;AAQA;AACA;AACA;AACA;;AAaA;AACA;AACA;AACA;AACA;;AAMA,MAAMC,WAAW,GAAG,IAAAC,qCAAiB,EAAiC,CAAC;;AAEvE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMC,aAAyC,GAAAC,OAAA,CAAAD,aAAA,GACpDF,WAAW,CAACE,aAAa;;AAE3B;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAME,YAAY,GAAAD,OAAA,CAAAC,YAAA,GAAGJ,WAAW,CAACI,YAAY","ignoreList":[]}
package/dist/esm/api/WixDataSearchBuilder.js CHANGED
@@ -1,5 +1,39 @@
1
1
  import { createSearchUtils } from '@wix/sdk-runtime/search-builder-utils';
2
2
  const searchUtils = createSearchUtils();
3
+ /**
4
+ * Creates a new WixData search builder.
5
+ * @internal
6
+ *
7
+ * @example
8
+ * ```ts
9
+ * import { SearchBuilder, SearchParams } from '@wix/wix-data-items-common'
10
+ *
11
+ * const request = SearchBuilder()
12
+ * .withSearch(SearchParams.expression('red car'))
13
+ * .withFilter({ status: 'active' })
14
+ * .withPaging({ limit: 10, offset: 0 })
15
+ * .build()
16
+ *
17
+ * const result = await wixData.search('myCollection', request)
18
+ * ```
19
+ */
3
20
  export const SearchBuilder = searchUtils.SearchBuilder;
21
+ /**
22
+ * Search parameter factory for creating search expressions.
23
+ * Uses the SDK's SearchParams with WixData types.
24
+ * @internal
25
+ *
26
+ * @example
27
+ * ```ts
28
+ * // Simple expression
29
+ * SearchParams.expression('search text')
30
+ *
31
+ * // Fuzzy search
32
+ * SearchParams.fuzzy(true)
33
+ *
34
+ * // AND mode (all terms must match)
35
+ * SearchParams.mode('AND')
36
+ * ```
37
+ */
4
38
  export const SearchParams = searchUtils.SearchParams;
5
39
  //# sourceMappingURL=WixDataSearchBuilder.js.map
package/dist/esm/api/WixDataSearchBuilder.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"WixDataSearchBuilder.js","sourceRoot":"","sources":["../../../src/api/WixDataSearchBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,uCAAuC,CAAA;AAkCzE,MAAM,WAAW,GAAG,iBAAiB,EAAkC,CAAA;AAEvE,MAAM,CAAC,MAAM,aAAa,GACxB,WAAW,CAAC,aAAa,CAAA;AAC3B,MAAM,CAAC,MAAM,YAAY,GAAG,WAAW,CAAC,YAAY,CAAA"}
1
+ {"version":3,"file":"WixDataSearchBuilder.js","sourceRoot":"","sources":["../../../src/api/WixDataSearchBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,uCAAuC,CAAA;AAkCzE,MAAM,WAAW,GAAG,iBAAiB,EAAkC,CAAA;AAEvE;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,MAAM,aAAa,GACxB,WAAW,CAAC,aAAa,CAAA;AAE3B;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,WAAW,CAAC,YAAY,CAAA"}
package/dist/types/api/WixDataSearchBuilder.d.ts CHANGED
@@ -20,7 +20,41 @@ type WixDataSearchRequest = SearchRequest<WixDataItem, WixDataSearchSpec>;
20
20
  * @internal
21
21
  */
22
22
  export type WixDataSearchBuilder = Omit<SDKSearchBuilder<WixDataItem, WixDataSearchSpec, WixDataSearchRequest>, 'withAggregation' | 'withTimeZone'>;
23
+ /**
24
+ * Creates a new WixData search builder.
25
+ * @internal
26
+ *
27
+ * @example
28
+ * ```ts
29
+ * import { SearchBuilder, SearchParams } from '@wix/wix-data-items-common'
30
+ *
31
+ * const request = SearchBuilder()
32
+ * .withSearch(SearchParams.expression('red car'))
33
+ * .withFilter({ status: 'active' })
34
+ * .withPaging({ limit: 10, offset: 0 })
35
+ * .build()
36
+ *
37
+ * const result = await wixData.search('myCollection', request)
38
+ * ```
39
+ */
23
40
  export declare const SearchBuilder: () => WixDataSearchBuilder;
41
+ /**
42
+ * Search parameter factory for creating search expressions.
43
+ * Uses the SDK's SearchParams with WixData types.
44
+ * @internal
45
+ *
46
+ * @example
47
+ * ```ts
48
+ * // Simple expression
49
+ * SearchParams.expression('search text')
50
+ *
51
+ * // Fuzzy search
52
+ * SearchParams.fuzzy(true)
53
+ *
54
+ * // AND mode (all terms must match)
55
+ * SearchParams.mode('AND')
56
+ * ```
57
+ */
24
58
  export declare const SearchParams: import("@wix/sdk-types").SearchParamsFactory<WixDataSearchSpec>;
25
59
  export {};
26
60
  //# sourceMappingURL=WixDataSearchBuilder.d.ts.map
package/dist/types/api/WixDataSearchBuilder.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"WixDataSearchBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataSearchBuilder.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,UAAU,EACV,aAAa,IAAI,gBAAgB,EACjC,aAAa,EACd,MAAM,gBAAgB,CAAA;AACvB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAE1C;;;GAGG;AACH,UAAU,iBAAkB,SAAQ,UAAU;IAC5C,GAAG,EAAE;QACH;YACE,MAAM,EAAE,MAAM,EAAE,CAAA;YAChB,IAAI,EAAE,MAAM,CAAA;SACb;KACF,CAAA;IACD,MAAM,EAAE,QAAQ,GAAG,QAAQ,CAAA;CAC5B;AAED,KAAK,oBAAoB,GAAG,aAAa,CAAC,WAAW,EAAE,iBAAiB,CAAC,CAAA;AAEzE;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG,IAAI,CACrC,gBAAgB,CAAC,WAAW,EAAE,iBAAiB,EAAE,oBAAoB,CAAC,EACtE,iBAAiB,GAAG,cAAc,CACnC,CAAA;AAID,eAAO,MAAM,aAAa,EAAE,MAAM,oBACP,CAAA;AAC3B,eAAO,MAAM,YAAY,iEAA2B,CAAA"}
1
+ {"version":3,"file":"WixDataSearchBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataSearchBuilder.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,UAAU,EACV,aAAa,IAAI,gBAAgB,EACjC,aAAa,EACd,MAAM,gBAAgB,CAAA;AACvB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAE1C;;;GAGG;AACH,UAAU,iBAAkB,SAAQ,UAAU;IAC5C,GAAG,EAAE;QACH;YACE,MAAM,EAAE,MAAM,EAAE,CAAA;YAChB,IAAI,EAAE,MAAM,CAAA;SACb;KACF,CAAA;IACD,MAAM,EAAE,QAAQ,GAAG,QAAQ,CAAA;CAC5B;AAED,KAAK,oBAAoB,GAAG,aAAa,CAAC,WAAW,EAAE,iBAAiB,CAAC,CAAA;AAEzE;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG,IAAI,CACrC,gBAAgB,CAAC,WAAW,EAAE,iBAAiB,EAAE,oBAAoB,CAAC,EACtE,iBAAiB,GAAG,cAAc,CACnC,CAAA;AAID;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa,EAAE,MAAM,oBACP,CAAA;AAE3B;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,YAAY,iEAA2B,CAAA"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/wix-data-items-common",
3
- "version": "1.0.296",
3
+ "version": "1.0.297",
4
4
  "license": "UNLICENSED",
5
5
  "author": {
6
6
  "name": "Rimvydas Gimbutas",
@@ -82,5 +82,5 @@
82
82
  "wallaby": {
83
83
  "autoDetect": true
84
84
  },
85
- "falconPackageHash": "03ac5dc0e9bf7a74f559a3779742ce5f9a84376987839993638a0c9a"
85
+ "falconPackageHash": "809c7a1f987de5a1cbc03467824b9b17f19ca7e81148b4fa7657123c"
86
86
  }