Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add travis config file and bump to 1.0.0 #72

Merged
merged 1 commit into from
Dec 2, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
language: node_js
sudo: false
notifications:
email: false
node_js:
- "6"
- "8"
cache:
directories: # Cache dependencies
- node_modules
before_script:
- npm run bootstrap
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
[![npm version][npm-img]][npm-url]
[![build status][travis-img]][travis-url]
[![apache licensed](https://img.shields.io/badge/license-Apache-green.svg?style=flat-square)](https://raw.githubusercontent.com/Esri/arcgis-rest-js/master/LICENSE)

[npm-img]: https://img.shields.io/npm/v/@esri/arcgis-rest-request.svg?style=flat-square
[npm-url]: https://www.npmjs.com/package/@esri/arcgis-rest-request
[travis-img]: https://img.shields.io/travis/Esri/arcgis-rest-js/master.svg?style=flat-square
[travis-url]: https://travis-ci.org/Esri/arcgis-rest-js

# @esri/arcgis-rest-js

> compact, modular JavaScript wrappers for the ArcGIS REST API that run in Node.js and modern browsers.
Expand Down Expand Up @@ -31,7 +40,7 @@ request(url)

### API Reference

The documentation is published at https://esri.github.io/arcgis-rest-js/ (source code [here](/docs/src)).
The documentation is published at http://arcgis-rest-js.surge.sh/ (source code [here](/docs/src)).

### Instructions

Expand All @@ -52,9 +61,11 @@ Some useful commands include:

### Packages

* [`@esri/arcgis-rest-request`](./packages/arcgis-rest-request/) - Handles common functionality across all aspects of `@esri/arcgis-rest-js`.
* [`@esri/arcgis-rest-auth`](./packages/arcgis-rest-auth) - Provides methods for authenticating named users and applications for `@esri/arcgis-rest-auth`.
* [`@esri/arcgis-rest-request`](./packages/arcgis-rest-request/) - Underpins other packages and supports making low-level requests.
* [`@esri/arcgis-rest-auth`](./packages/arcgis-rest-auth) - Provides methods for authenticating named users and applications.
* [`@esri/arcgis-rest-geocoder`](./packages/arcgis-rest-geocoder) - Geocoding wrapper for `@esri/arcgis-rest-js`
* [`@esri/arcgis-rest-items`](./packages/arcgis-rest-items) - Methods for working with ArcGIS Online/Enterprise content.
* [`@esri/arcgis-rest-groups`](./packages/arcgis-rest-groups) - Methods for working with ArcGIS Online/Enterprise groups.

### Frequently Asked Questions

Expand Down
4 changes: 2 additions & 2 deletions demos/express/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
"author": "",
"license": "Apache-2.0",
"dependencies": {
"@esri/arcgis-rest-auth": "0.0.0",
"@esri/arcgis-rest-request": "0.0.0",
"@esri/arcgis-rest-auth": "1.0.0",
"@esri/arcgis-rest-request": "1.0.0",
"express": "^4.15.4",
"isomorphic-fetch": "^2.2.1",
"isomorphic-form-data": "^1.0.0"
Expand Down
8 changes: 4 additions & 4 deletions demos/geocoder/package.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
{
"name": "@esri/arcgis-rest-geocoder-vanilla",
"version": "0.0.0",
"version": "1.0.0",
"private": true,
"description": "Vanilla JavaScript demo of @esri/arcgis-rest-geocoder",
"author": "",
"license": "Apache-2.0",
"dependencies": {
"@esri/arcgis-rest-request": "0.0.0",
"@esri/arcgis-rest-auth": "0.0.0",
"@esri/arcgis-rest-geocoder": "0.0.0"
"@esri/arcgis-rest-request": "1.0.0",
"@esri/arcgis-rest-auth": "1.0.0",
"@esri/arcgis-rest-geocoder": "1.0.0"
},
"devDependencies": {
"http-server": "*"
Expand Down
4 changes: 2 additions & 2 deletions demos/vanilla/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
"author": "",
"license": "Apache-2.0",
"dependencies": {
"@esri/arcgis-rest-auth": "0.0.0",
"@esri/arcgis-rest-request": "0.0.0"
"@esri/arcgis-rest-auth": "1.0.0",
"@esri/arcgis-rest-request": "1.0.0"
},
"devDependencies": {
"http-server": "*"
Expand Down
2 changes: 1 addition & 1 deletion docs/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ Using TypeScript allows us to add type information to request params and respons

TypeScript compiles to JavaScript so you can use @esri/arcgis-rest-js in any JavaScript project. However if you use TypeScript you will get the benefits of type checking for free.

We also _really_ like TypeScript because it supports exporting to both [ES 2015 modules](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import) (use `import`/`export`) and [UMD](http://davidbcalhoun.com/2014/what-is-amd-commonjs-and-umd/) modules/. This allows us to support a wide variety of module loaders and bundlers, including Browserify, Webpack, RequireJS, and Dojo 1 and 2.
We also _really_ like TypeScript because it supports exporting to both [ES 2015 modules](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import) (use `import`/`export`) and [UMD](http://davidbcalhoun.com/2014/what-is-amd-commonjs-and-umd/) modules. This allows us to support a wide variety of module loaders and bundlers, including Browserify, Webpack, RequireJS, and Dojo 1 and 2.
6 changes: 3 additions & 3 deletions docs/src/_layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8">
<meta content="IE=edge" http-equiv="X-UA-Compatible">
<meta name="viewport" content="width=device-width, user-scalable=no">
<title>{{title if title}}{{" | " + titleSegments | join(" |") if titleSegments}}{{" | " if title}}Esri REST JS</title>
<title>{{title if title}}{{" | " + titleSegments | join(" |") if titleSegments}}{{" | " if title}}ArcGIS REST JS</title>
{% if description %}
<meta name="description" content="This is an example of a meta description. This will often show up in search results.">
{% endif %}
Expand All @@ -17,7 +17,7 @@
<div class="drawer drawer-left js-drawer" data-drawer="top-nav" tabindex="0">
<nav class="drawer-nav" role="navigation">
<aside class="side-nav">
<h2 class="side-nav-title">Esri REST JS</h2>
<h2 class="side-nav-title">ArcGIS REST JS</h2>
{% link "/guides/", "Guides", class="side-nav-link" %}
{% link "/api/", "API Reference", class="side-nav-link"%}
</aside>
Expand All @@ -32,7 +32,7 @@ <h2 class="side-nav-title">Esri REST JS</h2>
<!-- desktop sized navigation -->
<div class="tablet-hide">
<!-- logo / home -->
<a href="/" class="top-nav-title">Esri REST JS</a>
<a href="/" class="top-nav-title">ArcGIS REST JS</a>
<!-- primary navigation sections -->
<nav class="top-nav-list" role="navigation" aria-labelledby="topnav">
{% link "/guides/", "Guides", class="top-nav-link" %}
Expand Down
6 changes: 3 additions & 3 deletions docs/src/guides/amd-requirejs-dojo.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: Using Esri REST JS in AMD with Require.js or Dojo
title: Using ArcGIS REST JS in AMD with Require.js or Dojo
navTitle: AMD (Require.js or Dojo)
description: Learn how to integrate the Esri REST JS library into project using AMD with Require.js or Dojo.
description: Learn how to integrate the ArcGIS REST JS library into project using AMD with Require.js or Dojo.
order: 50
group: 1-get-started
---

# Get Started with Esri REST JS and AMD
# Get Started with ArcGIS REST JS and AMD
4 changes: 2 additions & 2 deletions docs/src/guides/browser-authentication.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Browser-based authentication with Esri REST JS
title: Browser-based authentication with ArcGIS REST JS
navTitle: Browser-based OAuth 2.0
description: Learn how to authenticate users with Esri REST JS and OAuth 2.0 in a browser.
description: Learn how to authenticate users with ArcGIS REST JS and OAuth 2.0 in a browser.
order: 1
group: 2-authentication
---
Expand Down
6 changes: 3 additions & 3 deletions docs/src/guides/browserify.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: Using Esri REST JS with Browserify
title: Using ArcGIS REST JS with Browserify
navTitle: Browserify
description: Learn how to integrate the Esri REST JS library into a Browserify based workflow.
description: Learn how to integrate the ArcGIS REST JS library into a Browserify based workflow.
order: 80
group: 1-get-started
---

# Get Started with Esri REST JS and Browserify
# Get Started with ArcGIS REST JS and Browserify
2 changes: 1 addition & 1 deletion docs/src/guides/client-server-authentication.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Server-client authentication with Esri REST JS
title: Server-client authentication with ArcGIS REST JS
navTitle: Shared client server authentication
description: Learn how to authenticate users and share authentication details between the client and server.
order: 30
Expand Down
6 changes: 3 additions & 3 deletions docs/src/guides/from-a-cdn.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: Using Esri REST JS from a CDN
title: Using ArcGIS REST JS from a CDN
navTitle: From a CDN
description: Learn how to use Esri REST JS from a CDN.
description: Learn how to use ArcGIS REST JS from a CDN.
order: 20
group: 1-get-started
---

# Get Started with Esri REST JS from a CDN
# Get Started with ArcGIS REST JS from a CDN
2 changes: 1 addition & 1 deletion docs/src/guides/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Get Started
description: Get started with the Esri REST JS library.
description: Get started with the ArcGIS REST JS library.
---

# Get Started
6 changes: 3 additions & 3 deletions docs/src/guides/node-app.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: Using Esri REST JS in Node.js
title: Using ArcGIS REST JS in Node.js
navTitle: Node.js
description: Learn how to integrate the Esri REST JS library into a Node.js app.
description: Learn how to integrate the ArcGIS REST JS library into a Node.js app.
order: 60
group: 1-get-started
---

# Get Started with Esri REST JS and Node.js
# Get Started with ArcGIS REST JS and Node.js
2 changes: 1 addition & 1 deletion docs/src/guides/packge-overview.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Package Overview
description: Overview of packages provided by Esri REST JS.
description: Overview of packages provided by ArcGIS REST JS.
order: 10
group: 0-introduction
---
Expand Down
4 changes: 2 additions & 2 deletions docs/src/guides/rollup-babel.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Using Esri REST JS with Babel and Rollup
title: Using ArcGIS REST JS with Babel and Rollup
navTitle: Babel + Rollup
description: Learn how to integrate the Esri REST JS library into a Babel and Rollup based workflow.
description: Learn how to integrate the ArcGIS REST JS library into a Babel and Rollup based workflow.
order: 70
group: 1-get-started
---
Expand Down
4 changes: 2 additions & 2 deletions docs/src/guides/server-authentication.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Server-based authentication with Esri REST JS
title: Server-based authentication with ArcGIS REST JS
navTitle: Server-based OAuth 2.0
description: Learn how to authenticate users with Esri REST JS and OAuth 2.0 in a Node.js server.
description: Learn how to authenticate users with ArcGIS REST JS and OAuth 2.0 in a Node.js server.
order: 10
group: 2-authentication
---
Expand Down
4 changes: 2 additions & 2 deletions docs/src/guides/webpack-and-babel.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Using Esri REST JS with Babel and Webpack
title: Using ArcGIS REST JS with Babel and Webpack
navTitle: Babel + WebPack
description: Learn how to integrate the Esri REST JS library into a Babel and Webpack based workflow.
description: Learn how to integrate the ArcGIS REST JS library into a Babel and Webpack based workflow.
order: 30
group: 1-get-started
---
Expand Down
4 changes: 2 additions & 2 deletions docs/src/guides/webpack-and-typescript.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Using Esri REST JS with TypeScript and Webpack
title: Using ArcGIS REST JS with TypeScript and Webpack
navTitle: TypeScript + WebPack
description: Learn how to integrate the Esri REST JS library into a TypeScript and Webpack based workflow.
description: Learn how to integrate the ArcGIS REST JS library into a TypeScript and Webpack based workflow.
order: 40
group: 1-get-started
---
Expand Down
4 changes: 2 additions & 2 deletions docs/src/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
<header class="sub-nav" role="banner">
<div class="grid-container">
<div class="column-24 text-center leader-4 trailer-5">
<h1 class="font-size-7 text-white">Esri REST JS</h1>
<p class="text-white font-size-2">A modular, high quality toolkit for working with the ArcGIS REST API.</p>
<h1 class="font-size-7 text-white">ArcGIS REST JS</h1>
<p class="text-white font-size-2">A modular, high quality toolkit for working with the ArcGIS REST API</a>.</p>
{% link "/guides/", "Get Started", class="btn btn-large btn-clear-white" %}
{% link "/api/", "API Reference", class="btn btn-large btn-clear-white" %}
</div>
Expand Down
61 changes: 61 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 5 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@esri/arcgis-rest-js",
"version": "0.0.0",
"description": "This repository is for discussing and creating a fully featured JavaScript client API for browsers and Node.js.",
"version": "1.0.0",
"description": "Compact, modular JavaScript wrappers for the ArcGIS REST API that run in Node.js and modern browsers.",
"devDependencies": {
"@types/es6-promise": "0.0.32",
"@types/fetch-mock": "^5.8.3",
Expand All @@ -19,6 +19,7 @@
"cz-lerna-changelog": "github:patrickarlt/cz-lerna-changelog#3fe7650a2e2e624b1f46e5031c96119759698288",
"date-fns": "^1.28.5",
"fetch-mock": "^5.12.1",
"gh-pages": "^1.1.0",
"gh-release": "^3.1.1",
"husky": "^0.14.3",
"inspect-process": "^0.5.0",
Expand Down Expand Up @@ -76,6 +77,8 @@
"test:chrome": "karma start --single-run --browsers=Chrome",
"test:node": "jasmine --config=jasmine.json",
"test:node:debug": "inspect jasmine --config=jasmine.json",
"docs:build": "acetate build --config docs/acetate.config.js",
"docs:deploy": "node support/deploy-doc-site.js",
"docs:typedoc": "node docs/build-typedoc.js",
"docs:dev:typedoc": "onchange -v 'packages/*/src/**/*.ts' -- npm run docs:typedoc",
"predocs:serve": "npm run docs:typedoc",
Expand Down
6 changes: 3 additions & 3 deletions packages/arcgis-rest-auth/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@esri/arcgis-rest-auth",
"version": "0.0.0",
"version": "1.0.0",
"description": "Authentication helpers for @esri/arcgis-rest-*.",
"main": "dist/node/index.js",
"browser": "dist/browser/arcgis-rest-auth.umd.js",
Expand All @@ -12,10 +12,10 @@
"tslib": "^1.7.1"
},
"peerDependencies": {
"@esri/arcgis-rest-request": "0.0.0"
"@esri/arcgis-rest-request": "^1.0.0"
},
"devDependencies": {
"@esri/arcgis-rest-request": "0.0.0"
"@esri/arcgis-rest-request": "^1.0.0"
},
"scripts": {
"prepublish": "npm run build",
Expand Down
2 changes: 1 addition & 1 deletion packages/arcgis-rest-common-types/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@esri/arcgis-rest-common-types",
"version": "0.0.0",
"version": "1.0.0",
"description": "Common TypeScript types for @esri/arcgis-rest-* packages.",
"types": "dist/types/index.d.ts",
"author": "",
Expand Down
Loading