@esri/hub-search

Module to search for ArcGIS items and format them for display in ArcGIS Hub.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@esri/hub-search
278311.16.14 days ago3 years agoMinified + gzip package size for @esri/hub-search in KB

Readme

!npm versionnpm-imgnpm-url !build statustravis-imgtravis-url !gzip bundle sizegzip-imagenpm-url !Coverage Statuscoverage-imgcoverage-url apache licensed
@esri/hub-search
DEPRECATED: This package is now deprecated and currently only includes functions that are still in use in legacy applications.
Use the hubSearch() function and related classes in @esri/hub-common instead.
Module to search for ArcGIS items and format them for display in ArcGIS Hub.

Example

npm install @esri/hub-search

Use in frontend

import { serialize } from '@esri/hub-search';

// Search query params that ArcGIS Hub expects
const params = {
  q: 'crime',
  sort: 'name',
  agg: { fields: 'tags,collection,owner,source,hasApi,downloadable' },
  start: 1,
  num: 10,
  groupIds: '1ef,2ef',
  orgId: '3ef',
  initiativeId: '4ef'
}
const token = 'xxxYYY' // AGO token
const portal = 'https://qaext.arcgis.com/sharing/rest'
const headers = { authorization: token, portal }
const serializedParams = serialize(params)
// Query hub v3's new search endpoint
fetch(`hub.arcgis.com/api/v3/search?${serializedParams}`, { headers })

Use in backend

const { agoSearch } = require('@esri/hub-search')
// req.query has deserialized query parameters
// req.headers.authorization has token
agoSearch(req.query, req.headers.authorization, req.headers.portal)

Issues

If something isn't working the way you expected, please take a look at previously logged issues first. Have you found a new bug? Want to request a new feature? We'd love to hear from you.
If you're looking for help you can also post issues on GIS Stackexchange.

Versioning

For transparency into the release cycle and in striving to maintain backward compatibility, @esri/hub.js is maintained under Semantic Versioning guidelines and will adhere to these rules whenever possible.
For more information on SemVer, please visit .

Contributing

Esri welcomes contributions from anyone and everyone. Please see our guidelines for contributing.

License

Copyright © 2019 Esri
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
A copy of the license is available in the repository's LICENSE file.