@esri/hub-common 12.36.0 → 12.37.0

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 (20) hide show
  1. package/dist/esm/search/_internal/hubSearchItems.js +0 -3
  2. package/dist/esm/search/_internal/hubSearchItems.js.map +1 -1
  3. package/dist/esm/search/_internal/hubSearchItemsHelpers/getOgcItemQueryParams.js +19 -1
  4. package/dist/esm/search/_internal/hubSearchItemsHelpers/getOgcItemQueryParams.js.map +1 -1
  5. package/dist/esm/search/_internal/hubSearchItemsHelpers/getQueryString.js +1 -1
  6. package/dist/esm/search/_internal/hubSearchItemsHelpers/getQueryString.js.map +1 -1
  7. package/dist/esm/search/_internal/hubSearchItemsHelpers/getSortByQueryParam.js +20 -0
  8. package/dist/esm/search/_internal/hubSearchItemsHelpers/getSortByQueryParam.js.map +1 -0
  9. package/dist/node/search/_internal/hubSearchItems.js +0 -3
  10. package/dist/node/search/_internal/hubSearchItems.js.map +1 -1
  11. package/dist/node/search/_internal/hubSearchItemsHelpers/getOgcItemQueryParams.js +19 -1
  12. package/dist/node/search/_internal/hubSearchItemsHelpers/getOgcItemQueryParams.js.map +1 -1
  13. package/dist/node/search/_internal/hubSearchItemsHelpers/getQueryString.js +1 -1
  14. package/dist/node/search/_internal/hubSearchItemsHelpers/getQueryString.js.map +1 -1
  15. package/dist/node/search/_internal/hubSearchItemsHelpers/getSortByQueryParam.js +24 -0
  16. package/dist/node/search/_internal/hubSearchItemsHelpers/getSortByQueryParam.js.map +1 -0
  17. package/dist/types/search/_internal/hubSearchItemsHelpers/getOgcItemQueryParams.d.ts +18 -7
  18. package/dist/types/search/_internal/hubSearchItemsHelpers/getSortByQueryParam.d.ts +10 -0
  19. package/dist/types/search/types/IHubSearchOptions.d.ts +0 -4
  20. package/package.json +1 -1
@@ -9,9 +9,6 @@ import { searchOgcItems } from "./hubSearchItemsHelpers/searchOgcItems";
9
9
  */
10
10
  export async function hubSearchItems(query, options) {
11
11
  var _a;
12
- if (!options.useBeta) {
13
- throw new Error("Not implemented");
14
- }
15
12
  return ((_a = options.aggFields) === null || _a === void 0 ? void 0 : _a.length) ? searchOgcAggregations(query, options)
16
13
  : searchOgcItems(query, options);
17
14
  }
@@ -1 +1 @@
1
- {"version":3,"file":"hubSearchItems.js","sourceRoot":"","sources":["../../../../src/search/_internal/hubSearchItems.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,qBAAqB,EAAE,MAAM,+CAA+C,CAAC;AACtF,OAAO,EAAE,cAAc,EAAE,MAAM,wCAAwC,CAAC;AAExE;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,KAAa,EACb,OAA0B;;IAE1B,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE;QACpB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;KACpC;IACD,OAAO,OAAA,OAAO,CAAC,SAAS,0CAAE,MAAM,EAC9B,CAAC,CAAC,qBAAqB,CAAC,KAAK,EAAE,OAAO,CAAC;QACvC,CAAC,CAAC,cAAc,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;AACrC,CAAC"}
1
+ {"version":3,"file":"hubSearchItems.js","sourceRoot":"","sources":["../../../../src/search/_internal/hubSearchItems.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,qBAAqB,EAAE,MAAM,+CAA+C,CAAC;AACtF,OAAO,EAAE,cAAc,EAAE,MAAM,wCAAwC,CAAC;AAExE;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,KAAa,EACb,OAA0B;;IAE1B,OAAO,OAAA,OAAO,CAAC,SAAS,0CAAE,MAAM,EAC9B,CAAC,CAAC,qBAAqB,CAAC,KAAK,EAAE,OAAO,CAAC;QACvC,CAAC,CAAC,cAAc,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;AACrC,CAAC"}
@@ -1,6 +1,16 @@
1
1
  import { getProp } from "../../../objects/get-prop";
2
2
  import { getFilterQueryParam } from "./getFilterQueryParam";
3
3
  import { getQQueryParam } from "./getQQueryParam";
4
+ import { getSortByQueryParam } from "./getSortByQueryParam";
5
+ /**
6
+ * @private
7
+ * Derives a hash of query params that should be included with a request
8
+ * to the /items endpoint of an OGC API collection
9
+ *
10
+ * @param query an IQuery to derive query params from
11
+ * @param options an IHubSearchOptions object to derive query params from
12
+ * @returns a hash of query params to be included in the request
13
+ */
4
14
  export function getOgcItemQueryParams(query, options) {
5
15
  const filter = getFilterQueryParam(query);
6
16
  const token = getProp(options, "requestOptions.authentication.token");
@@ -8,6 +18,14 @@ export function getOgcItemQueryParams(query, options) {
8
18
  // API requires the param name be all lowercase
9
19
  const startindex = options.start;
10
20
  const q = getQQueryParam(query);
11
- return { filter, token, limit, startindex, q };
21
+ const sortBy = getSortByQueryParam(options);
22
+ return {
23
+ filter,
24
+ token,
25
+ limit,
26
+ startindex,
27
+ q,
28
+ sortBy,
29
+ };
12
30
  }
13
31
  //# sourceMappingURL=getOgcItemQueryParams.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"getOgcItemQueryParams.js","sourceRoot":"","sources":["../../../../../src/search/_internal/hubSearchItemsHelpers/getOgcItemQueryParams.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AAGpD,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD,MAAM,UAAU,qBAAqB,CACnC,KAAa,EACb,OAA0B;IAE1B,MAAM,MAAM,GAAG,mBAAmB,CAAC,KAAK,CAAC,CAAC;IAC1C,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,EAAE,qCAAqC,CAAC,CAAC;IACtE,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC;IAC1B,+CAA+C;IAC/C,MAAM,UAAU,GAAG,OAAO,CAAC,KAAK,CAAC;IACjC,MAAM,CAAC,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC;IAEhC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC;AACjD,CAAC"}
1
+ {"version":3,"file":"getOgcItemQueryParams.js","sourceRoot":"","sources":["../../../../../src/search/_internal/hubSearchItemsHelpers/getOgcItemQueryParams.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AAGpD,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAW5D;;;;;;;;GAQG;AACH,MAAM,UAAU,qBAAqB,CACnC,KAAa,EACb,OAA0B;IAE1B,MAAM,MAAM,GAAG,mBAAmB,CAAC,KAAK,CAAC,CAAC;IAC1C,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,EAAE,qCAAqC,CAAC,CAAC;IACtE,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC;IAC1B,+CAA+C;IAC/C,MAAM,UAAU,GAAG,OAAO,CAAC,KAAK,CAAC;IACjC,MAAM,CAAC,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC;IAChC,MAAM,MAAM,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAE5C,OAAO;QACL,MAAM;QACN,KAAK;QACL,KAAK;QACL,UAAU;QACV,CAAC;QACD,MAAM;KACP,CAAC;AACJ,CAAC"}
@@ -1,7 +1,7 @@
1
1
  export function getQueryString(queryParams) {
2
2
  const result = Object.entries(queryParams)
3
3
  .filter(([_key, value]) => !!value)
4
- .map(([key, value]) => `${key}=${value}`)
4
+ .map(([key, value]) => `${key}=${encodeURIComponent(value)}`)
5
5
  .join("&");
6
6
  return result && `?${result}`;
7
7
  }
@@ -1 +1 @@
1
- {"version":3,"file":"getQueryString.js","sourceRoot":"","sources":["../../../../../src/search/_internal/hubSearchItemsHelpers/getQueryString.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,cAAc,CAAC,WAAgC;IAC7D,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC;SACvC,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;SAClC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,KAAK,EAAE,CAAC;SACxC,IAAI,CAAC,GAAG,CAAC,CAAC;IAEb,OAAO,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;AAChC,CAAC"}
1
+ {"version":3,"file":"getQueryString.js","sourceRoot":"","sources":["../../../../../src/search/_internal/hubSearchItemsHelpers/getQueryString.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,cAAc,CAAC,WAAgC;IAC7D,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC;SACvC,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;SAClC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,kBAAkB,CAAC,KAAK,CAAC,EAAE,CAAC;SAC5D,IAAI,CAAC,GAAG,CAAC,CAAC;IAEb,OAAO,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;AAChC,CAAC"}
@@ -0,0 +1,20 @@
1
+ /**
2
+ * @private
3
+ * Serializes the sort options provided from the request options
4
+ * object into a string that the OGC API can understand
5
+ *
6
+ * @param options IHubSearchOptions that contain sorting information
7
+ * @returns a serialized sort string
8
+ */
9
+ export function getSortByQueryParam(options) {
10
+ const { sortField, sortOrder } = options;
11
+ let result;
12
+ if (sortField) {
13
+ result =
14
+ sortOrder === "desc"
15
+ ? `-properties.${sortField}`
16
+ : `properties.${sortField}`;
17
+ }
18
+ return result;
19
+ }
20
+ //# sourceMappingURL=getSortByQueryParam.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"getSortByQueryParam.js","sourceRoot":"","sources":["../../../../../src/search/_internal/hubSearchItemsHelpers/getSortByQueryParam.ts"],"names":[],"mappings":"AAEA;;;;;;;GAOG;AACH,MAAM,UAAU,mBAAmB,CAAC,OAA0B;IAC5D,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;IACzC,IAAI,MAAM,CAAC;IACX,IAAI,SAAS,EAAE;QACb,MAAM;YACJ,SAAS,KAAK,MAAM;gBAClB,CAAC,CAAC,eAAe,SAAS,EAAE;gBAC5B,CAAC,CAAC,cAAc,SAAS,EAAE,CAAC;KACjC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}
@@ -12,9 +12,6 @@ const searchOgcItems_1 = require("./hubSearchItemsHelpers/searchOgcItems");
12
12
  */
13
13
  async function hubSearchItems(query, options) {
14
14
  var _a;
15
- if (!options.useBeta) {
16
- throw new Error("Not implemented");
17
- }
18
15
  return ((_a = options.aggFields) === null || _a === void 0 ? void 0 : _a.length) ? searchOgcAggregations_1.searchOgcAggregations(query, options)
19
16
  : searchOgcItems_1.searchOgcItems(query, options);
20
17
  }
@@ -1 +1 @@
1
- {"version":3,"file":"hubSearchItems.js","sourceRoot":"","sources":["../../../../src/search/_internal/hubSearchItems.ts"],"names":[],"mappings":";;;AAMA,yFAAsF;AACtF,2EAAwE;AAExE;;;;;;GAMG;AACI,KAAK,UAAU,cAAc,CAClC,KAAa,EACb,OAA0B;;IAE1B,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE;QACpB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;KACpC;IACD,OAAO,OAAA,OAAO,CAAC,SAAS,0CAAE,MAAM,EAC9B,CAAC,CAAC,6CAAqB,CAAC,KAAK,EAAE,OAAO,CAAC;QACvC,CAAC,CAAC,+BAAc,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;AACrC,CAAC;AAVD,wCAUC"}
1
+ {"version":3,"file":"hubSearchItems.js","sourceRoot":"","sources":["../../../../src/search/_internal/hubSearchItems.ts"],"names":[],"mappings":";;;AAMA,yFAAsF;AACtF,2EAAwE;AAExE;;;;;;GAMG;AACI,KAAK,UAAU,cAAc,CAClC,KAAa,EACb,OAA0B;;IAE1B,OAAO,OAAA,OAAO,CAAC,SAAS,0CAAE,MAAM,EAC9B,CAAC,CAAC,6CAAqB,CAAC,KAAK,EAAE,OAAO,CAAC;QACvC,CAAC,CAAC,+BAAc,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;AACrC,CAAC;AAPD,wCAOC"}
@@ -4,6 +4,16 @@ exports.getOgcItemQueryParams = void 0;
4
4
  const get_prop_1 = require("../../../objects/get-prop");
5
5
  const getFilterQueryParam_1 = require("./getFilterQueryParam");
6
6
  const getQQueryParam_1 = require("./getQQueryParam");
7
+ const getSortByQueryParam_1 = require("./getSortByQueryParam");
8
+ /**
9
+ * @private
10
+ * Derives a hash of query params that should be included with a request
11
+ * to the /items endpoint of an OGC API collection
12
+ *
13
+ * @param query an IQuery to derive query params from
14
+ * @param options an IHubSearchOptions object to derive query params from
15
+ * @returns a hash of query params to be included in the request
16
+ */
7
17
  function getOgcItemQueryParams(query, options) {
8
18
  const filter = getFilterQueryParam_1.getFilterQueryParam(query);
9
19
  const token = get_prop_1.getProp(options, "requestOptions.authentication.token");
@@ -11,7 +21,15 @@ function getOgcItemQueryParams(query, options) {
11
21
  // API requires the param name be all lowercase
12
22
  const startindex = options.start;
13
23
  const q = getQQueryParam_1.getQQueryParam(query);
14
- return { filter, token, limit, startindex, q };
24
+ const sortBy = getSortByQueryParam_1.getSortByQueryParam(options);
25
+ return {
26
+ filter,
27
+ token,
28
+ limit,
29
+ startindex,
30
+ q,
31
+ sortBy,
32
+ };
15
33
  }
16
34
  exports.getOgcItemQueryParams = getOgcItemQueryParams;
17
35
  //# sourceMappingURL=getOgcItemQueryParams.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"getOgcItemQueryParams.js","sourceRoot":"","sources":["../../../../../src/search/_internal/hubSearchItemsHelpers/getOgcItemQueryParams.ts"],"names":[],"mappings":";;;AAAA,wDAAoD;AAGpD,+DAA4D;AAC5D,qDAAkD;AAElD,SAAgB,qBAAqB,CACnC,KAAa,EACb,OAA0B;IAE1B,MAAM,MAAM,GAAG,yCAAmB,CAAC,KAAK,CAAC,CAAC;IAC1C,MAAM,KAAK,GAAG,kBAAO,CAAC,OAAO,EAAE,qCAAqC,CAAC,CAAC;IACtE,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC;IAC1B,+CAA+C;IAC/C,MAAM,UAAU,GAAG,OAAO,CAAC,KAAK,CAAC;IACjC,MAAM,CAAC,GAAG,+BAAc,CAAC,KAAK,CAAC,CAAC;IAEhC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC;AACjD,CAAC;AAZD,sDAYC"}
1
+ {"version":3,"file":"getOgcItemQueryParams.js","sourceRoot":"","sources":["../../../../../src/search/_internal/hubSearchItemsHelpers/getOgcItemQueryParams.ts"],"names":[],"mappings":";;;AAAA,wDAAoD;AAGpD,+DAA4D;AAC5D,qDAAkD;AAClD,+DAA4D;AAW5D;;;;;;;;GAQG;AACH,SAAgB,qBAAqB,CACnC,KAAa,EACb,OAA0B;IAE1B,MAAM,MAAM,GAAG,yCAAmB,CAAC,KAAK,CAAC,CAAC;IAC1C,MAAM,KAAK,GAAG,kBAAO,CAAC,OAAO,EAAE,qCAAqC,CAAC,CAAC;IACtE,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC;IAC1B,+CAA+C;IAC/C,MAAM,UAAU,GAAG,OAAO,CAAC,KAAK,CAAC;IACjC,MAAM,CAAC,GAAG,+BAAc,CAAC,KAAK,CAAC,CAAC;IAChC,MAAM,MAAM,GAAG,yCAAmB,CAAC,OAAO,CAAC,CAAC;IAE5C,OAAO;QACL,MAAM;QACN,KAAK;QACL,KAAK;QACL,UAAU;QACV,CAAC;QACD,MAAM;KACP,CAAC;AACJ,CAAC;AApBD,sDAoBC"}
@@ -4,7 +4,7 @@ exports.getQueryString = void 0;
4
4
  function getQueryString(queryParams) {
5
5
  const result = Object.entries(queryParams)
6
6
  .filter(([_key, value]) => !!value)
7
- .map(([key, value]) => `${key}=${value}`)
7
+ .map(([key, value]) => `${key}=${encodeURIComponent(value)}`)
8
8
  .join("&");
9
9
  return result && `?${result}`;
10
10
  }
@@ -1 +1 @@
1
- {"version":3,"file":"getQueryString.js","sourceRoot":"","sources":["../../../../../src/search/_internal/hubSearchItemsHelpers/getQueryString.ts"],"names":[],"mappings":";;;AAAA,SAAgB,cAAc,CAAC,WAAgC;IAC7D,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC;SACvC,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;SAClC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,KAAK,EAAE,CAAC;SACxC,IAAI,CAAC,GAAG,CAAC,CAAC;IAEb,OAAO,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;AAChC,CAAC;AAPD,wCAOC"}
1
+ {"version":3,"file":"getQueryString.js","sourceRoot":"","sources":["../../../../../src/search/_internal/hubSearchItemsHelpers/getQueryString.ts"],"names":[],"mappings":";;;AAAA,SAAgB,cAAc,CAAC,WAAgC;IAC7D,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC;SACvC,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;SAClC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,kBAAkB,CAAC,KAAK,CAAC,EAAE,CAAC;SAC5D,IAAI,CAAC,GAAG,CAAC,CAAC;IAEb,OAAO,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;AAChC,CAAC;AAPD,wCAOC"}
@@ -0,0 +1,24 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.getSortByQueryParam = void 0;
4
+ /**
5
+ * @private
6
+ * Serializes the sort options provided from the request options
7
+ * object into a string that the OGC API can understand
8
+ *
9
+ * @param options IHubSearchOptions that contain sorting information
10
+ * @returns a serialized sort string
11
+ */
12
+ function getSortByQueryParam(options) {
13
+ const { sortField, sortOrder } = options;
14
+ let result;
15
+ if (sortField) {
16
+ result =
17
+ sortOrder === "desc"
18
+ ? `-properties.${sortField}`
19
+ : `properties.${sortField}`;
20
+ }
21
+ return result;
22
+ }
23
+ exports.getSortByQueryParam = getSortByQueryParam;
24
+ //# sourceMappingURL=getSortByQueryParam.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"getSortByQueryParam.js","sourceRoot":"","sources":["../../../../../src/search/_internal/hubSearchItemsHelpers/getSortByQueryParam.ts"],"names":[],"mappings":";;;AAEA;;;;;;;GAOG;AACH,SAAgB,mBAAmB,CAAC,OAA0B;IAC5D,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;IACzC,IAAI,MAAM,CAAC;IACX,IAAI,SAAS,EAAE;QACb,MAAM;YACJ,SAAS,KAAK,MAAM;gBAClB,CAAC,CAAC,eAAe,SAAS,EAAE;gBAC5B,CAAC,CAAC,cAAc,SAAS,EAAE,CAAC;KACjC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAVD,kDAUC"}
@@ -1,9 +1,20 @@
1
1
  import { IQuery } from "../../types/IHubCatalog";
2
2
  import { IHubSearchOptions } from "../../types/IHubSearchOptions";
3
- export declare function getOgcItemQueryParams(query: IQuery, options: IHubSearchOptions): {
4
- filter: string;
5
- token: any;
6
- limit: number;
7
- startindex: number;
8
- q: any;
9
- };
3
+ export interface IOgcItemQueryParams {
4
+ filter?: string;
5
+ token?: string;
6
+ limit?: number;
7
+ startindex?: number;
8
+ q?: string;
9
+ sortBy?: string;
10
+ }
11
+ /**
12
+ * @private
13
+ * Derives a hash of query params that should be included with a request
14
+ * to the /items endpoint of an OGC API collection
15
+ *
16
+ * @param query an IQuery to derive query params from
17
+ * @param options an IHubSearchOptions object to derive query params from
18
+ * @returns a hash of query params to be included in the request
19
+ */
20
+ export declare function getOgcItemQueryParams(query: IQuery, options: IHubSearchOptions): IOgcItemQueryParams;
@@ -0,0 +1,10 @@
1
+ import { IHubSearchOptions } from "../../types/IHubSearchOptions";
2
+ /**
3
+ * @private
4
+ * Serializes the sort options provided from the request options
5
+ * object into a string that the OGC API can understand
6
+ *
7
+ * @param options IHubSearchOptions that contain sorting information
8
+ * @returns a serialized sort string
9
+ */
10
+ export declare function getSortByQueryParam(options: IHubSearchOptions): string;
@@ -69,8 +69,4 @@ export interface IHubSearchOptions {
69
69
  * The result number of the first entry in the result set response. The start parameter, along with the num parameter, can be used to paginate the search results.
70
70
  */
71
71
  start?: number;
72
- /**
73
- * Enables experimental functionality.
74
- */
75
- useBeta?: boolean;
76
72
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@esri/hub-common",
3
- "version": "12.36.0",
3
+ "version": "12.37.0",
4
4
  "description": "Common TypeScript types and utility functions for @esri/hub.js.",
5
5
  "main": "dist/node/index.js",
6
6
  "module": "dist/esm/index.js",