search package (#152)

search package

docs/build-typedoc.js

@@ -135,7 +135,11 @@ const md = new MarkdownIt();
       );
     })
     .then(declarations => {
-      const blacklist = [];
+      const blacklist = ['encodeAgoQuery', 'downloadableAgg', 'downloadableFilter', 'collectionAgg', 
+      'collectionFilter', 'createAggs', 'format', 'hasApiAgg', 'buildFilter', 'createFilters', 
+      'encodeFilters', 'groupIds', 'handleFilter', 'hasApiFilter', 'computeItemsFacets',
+      'formatItem', 'calcHighlights', 'getSortField', 'isFilterable', 'generateFilter',
+      'agoFormatItemCollection'];
       /**
        * Next we remove any declarations we want to blacklist from the API ref
        */

packages/common/src/categories.ts

@@ -113,6 +113,56 @@ const other: string[] = [
 
 const site: string[] = ["Hub Site Application"];
 
+// eligible types are listed here: http://doc.arcgis.com/en/arcgis-online/reference/supported-items.htm
+const downloadableTypes: string[] = [
+  "360 VR Experience",
+  "Application",
+  "CityEngine Web Scene",
+  "Code Sample",
+  "CSV Collection",
+  "CSV",
+  "CAD Drawing",
+  "Desktop Application",
+  "Desktop Application Template",
+  "Desktop Style",
+  "File Geodatabase",
+  "GeoJson",
+  "Geoprocessing Package",
+  "Geoprocessing Sample",
+  "Image",
+  "iWork Keynote",
+  "iWork Numbers",
+  "KML Collection",
+  "KML",
+  "Layer",
+  "Layer File",
+  "Layer Package",
+  "Layout",
+  "Locator Package",
+  "Map Package",
+  "Map Service Definition",
+  "Map Template",
+  "Microsoft Excel",
+  "Microsoft Powerpoint",
+  "Microsoft Visio",
+  "Microsoft Word",
+  "Operations Dashboard Add In",
+  "PDF",
+  "Pro Map",
+  "Project Package",
+  "Project Template",
+  "Raster function template",
+  "Rule Package",
+  "Service Definition",
+  "Shapefile",
+  "Vector Tile Package",
+  "Workflow Manager Package"
+];
+
+const downloadableTypeKeywords: string[] = ["Data"];
+
+const apiTypes: string[] = ["Feature Service", "Map Service", "Image Service"];
+
 export const categories: { [key: string]: string[] } = {
   app,
   dataset,
@@ -121,5 +171,8 @@ export const categories: { [key: string]: string[] } = {
   initiative,
   map,
   other,
-  site
+  site,
+  downloadableTypes,
+  downloadableTypeKeywords,
+  apiTypes
 };

packages/common/src/index.ts

@@ -5,3 +5,4 @@ export * from "./util";
 export * from "./types";
 export * from "./api";
 export * from "./content";
+export * from "./categories";

packages/search/README.md

@@ -0,0 +1,87 @@
+[![npm version][npm-img]][npm-url]
+[![build status][travis-img]][travis-url]
+[![gzip bundle size][gzip-image]][npm-url]
+[![Coverage Status][coverage-img]][coverage-url]
+[![apache licensed](https://img.shields.io/badge/license-Apache-green.svg?style=flat-square)](https://raw.githubusercontent.com/Esri/hub.js/master/LICENSE)
+
+[npm-img]: https://img.shields.io/npm/v/@esri/hub-auth.svg?style=flat-square
+[npm-url]: https://www.npmjs.com/package/@esri/hub-search
+[travis-img]: https://img.shields.io/travis/Esri/hub.js/master.svg?style=flat-square
+[travis-url]: https://travis-ci.org/Esri/hub.js
+[gzip-image]: https://img.badgesize.io/https://unpkg.com/@esri/hub-auth/dist/umd/search.umd.min.js?compression=gzip
+[coverage-img]: https://codecov.io/gh/Esri/hub.js/branch/master/graph/badge.svg
+[coverage-url]: https://codecov.io/gh/Esri/hub.js
+
+# @esri/hub-search
+
+> Module to search for ArcGIS items and format them for display in ArcGIS Hub.
+
+### Example
+
+```bash
+npm install @esri/hub-search
+```
+
+#### Use in frontend
+
+```js
+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
+}
+const token = 'xxxYYY' // AGO token
+const portal = 'https://qaext.arcgis.com/sharing/rest'
+const headers = { authorization: token, portal }
+const serializedParams = arcgisHub.serialize(params)
+// Query hub v3's new search endpoint
+fetch(`hub.arcgis.com/api/v3/search?${serializedParams}`, { headers })
+```
+
+#### Use in backend
+
+```js
+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](https://github.com/Esri/hub.js/issues) first.  Have you found a new bug?  Want to request a new feature?  We'd [**love**](https://github.com/Esri/hub.js/issues/new) to hear from you.
+
+If you're looking for help you can also post issues on [GIS Stackexchange](http://gis.stackexchange.com/questions/ask?tags=esri-oss).
+
+### 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 <http://semver.org/>.
+
+### Contributing
+
+Esri welcomes contributions from anyone and everyone. Please see our [guidelines for contributing](CONTRIBUTING.md).
+
+### License
+
+Copyright &copy; 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](../../LICENSE) file.