asana 0.18.6 → 0.18.14

package/.github/workflows/build.yml

@@ -0,0 +1,27 @@
+name: Build
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  test:
+    name: Run npm build and npm test
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [8.x, 9.x, 12.x]
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Install dependencies
+        run: npm i
+      - run: npm run build --if-present
+      - run: npm test

package/.github/workflows/publish-to-github-releases.yml

@@ -0,0 +1,26 @@
+name: Publish to GitHub Releases
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+jobs:
+  build-n-publish-to-github:
+    name: Build and publish to GitHub Releases
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '8.x'
+      - name: Bundle the code, full version to asana.js and minified to asana-min.js
+        run: |
+          npm i gulp
+          gulp bundle
+      - name: Publish to GitHub Releases
+        uses: softprops/action-gh-release@v1
+        with:
+          files: |
+            dist/asana.js
+            dist/asana-min.js

package/.github/workflows/publish-to-npmjs.yml

@@ -0,0 +1,21 @@
+name: Publish 📦 to npmjs
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+jobs:
+  build-n-publish-to-npmjs:
+    name: Build and publish 📦 to npmjs
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '8.x'
+          registry-url: 'https://registry.npmjs.com'
+      - run: npm i
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/README.md

@@ -1,4 +1,4 @@
-# Asana [![GitHub release][release-image]]() [![Build Status][travis-image]][travis-url] [![NPM Version][npm-image]][npm-url]
+# Asana [![GitHub release][release-image]]() [![Build Status][github-actions-image]][github-actions-url] [![NPM Version][npm-image]][npm-url]
 
 A JavaScript client (for both Node and browser) for the Asana API v1.0.
 
@@ -314,18 +314,34 @@ See our [openapi spec][https://github.com/Asana/developer-docs/blob/master/defs/
 
 **Repo Owners Only.** Take the following steps to issue a new release of the library.
 
+#### Automatic Deployment
+
   1. Merge in the desired changes into the `master` branch and commit them.
   2. Clone the repo; work on `master`.
-  3. Bump the package version to indicate the [semantic version](http://semver.org) change, using one of: `gulp bump-patch`, `gulp bump-feature`, or `gulp bump-release`
+  3. Bump the package version to indicate the [semantic version](http://semver.org) change, using one of: `gulp bump-patch`, `gulp bump-minor`, or `gulp bump-major`
+  (NOTE: If this is your first time running `gulp` please install `gulp` globally using `npm i -g gulp`)
   4. Push changes to origin, including tags:
-     `git push origin master --tags` 
+     `git push --tags origin master:master`
+
+#### Manual Deployment
+
+  1. Merge in the desired changes into the `master` branch and commit them.
+  2. Clone the repo, work on master.
+  3. Edit package version in `package.json`, `bower.json` and `VERSION` to indicate the [semantic version](http://semver.org/) change.
+  4. Commit the change
+  5. Tag the commit with `v` plus the same version number you set in the file.
+     `git tag v1.2.3`
+  6. Push changes to origin, including tags:
+     `git push --tags origin master:master`
+
+GitHub Actions will automatically build and deploy the tagged release.
 
-Travis CI will automatically build and deploy the tagged release.
+:reminder_ribbon: Make sure to edit the [new release](https://github.com/Asana/node-asana/releases) description on GitHub after it has been deployed. Please use bullet points to indicate notable changes since the last version.
 
 [release-image]: https://img.shields.io/github/release/asana/node-asana.svg
 
-[travis-url]: http://travis-ci.org/Asana/node-asana
-[travis-image]: http://img.shields.io/travis/Asana/node-asana.svg?style=flat-square&branch=master
+[github-actions-url]: https://github.com/Asana/node-asana/actions
+[github-actions-image]: https://github.com/Asana/node-asana/workflows/Build/badge.svg
 
 [npm-url]: https://www.npmjs.org/package/asana
 [npm-image]: http://img.shields.io/npm/v/asana.svg?style=flat-square

package/VERSION

@@ -1 +1 @@
-0.18.6
+0.18.14

package/bower.json

@@ -1,7 +1,7 @@
 {
   "name": "asana",
   "main": "dist/asana.js",
-  "version": "0.15.1",
+  "version": "0.18.14",
   "homepage": "https://github.com/Asana/node-asana",
   "authors": [
     "Greg Slovacek <greg@asana.com>",

package/gulpfile.js

@@ -1,4 +1,5 @@
 var browserify = require('browserify');
+var fs = require('fs');
 var bump = require('gulp-bump');
 var filter = require('gulp-filter');
 var git = require('gulp-git');
@@ -51,8 +52,10 @@ function browserTask(minify) {
 function ensureGitClean(done) {
   git.status(function(err, out) {
     if (err) { throw err; }
-    if (!/working directory clean/.exec(out)) {
-      throw new Error('Git working directory not clean, will not bump version');
+    if (!/nothing to commit/.exec(out)) {
+      throw new Error(
+        'Git working directory not clean, will not bump version'
+        );
     }
   });
 
@@ -66,33 +69,87 @@ gulp.task('ensure-git-clean', ensureGitClean);
  *
  * You can use the commands
  *
- *     gulp bump-patch     # makes v0.1.0 → v0.1.1
- *     gulp bump-feature   # makes v0.1.1 → v0.2.0
- *     gulp bump-release   # makes v0.2.1 → v1.0.0
+ *     gulp bump-patch   # makes v0.1.0 → v0.1.1
+ *     gulp bump-minor   # makes v0.1.1 → v0.2.0
+ *     gulp bump-major   # makes v0.2.1 → v1.0.0
  *
  * To bump the version numbers accordingly after you did a patch,
  * introduced a feature or made a backwards-incompatible release.
  */
 function bumpVersion(importance) {
-  return gulp.src(['./package.json', './bower.json'])
-      .pipe(bump({type: importance}))
-      .pipe(gulp.dest('./'))
-      .pipe(git.commit('bump package version'))
+  // Update VERSION file
+  function updateVersionFile(cb) {
+    fs.readFile('VERSION', 'utf-8', function (err, data) {
+      if (err) {
+        console.log(err);
+      }
+
+      var versionArray = data.split('.');
+      var major = versionArray[0];
+      var minor = versionArray[1];
+      var patch = versionArray[2];
+
+      if (importance === 'major') {
+        major = (parseInt(major) + 1).toString();
+      }
+      if (importance === 'minor') {
+        minor = (parseInt(minor) + 1).toString();
+      }
+      if (importance === 'patch') {
+        patch = (parseInt(patch) + 1).toString();
+      }
+
+      var updatedVersion = [major, minor, patch].join('.');
+
+      fs.writeFile('VERSION', updatedVersion, function (err) {
+        if (err) {
+          console.log(err);
+        }
+      });
+    });
+    cb();
+  }
+
+  // Bump version in package.json and bower.json
+  function updateVersion() {
+    return gulp
+      .src(['./package.json', './bower.json'])
+      .pipe(bump({ type: importance }))
+      .pipe(gulp.dest('./'));
+  }
+
+  // Add, commit version files and tag commit with new version
+  function addCommitTagPush(cb) {
+    gulp
+      .src(['./package.json', './bower.json', './VERSION'])
+      .pipe(git.add())
+      .pipe(git.commit('Bump package version'))
       .pipe(filter('package.json'))
       .pipe(tagVersion());
+    cb();
+  }
+
+  // Update the version files in parallel and then commit the changes
+  return gulp.series(
+    gulp.parallel(updateVersionFile, updateVersion),
+    addCommitTagPush
+  )();
 }
-function bumpPatch() {
-  return bumpVersion('patch');
+function bumpPatch(cb) {
+  bumpVersion('patch');
+  cb();
 }
 gulp.task('bump-patch', gulp.series('ensure-git-clean', bumpPatch));
-function bumpFeature() {
-  return bumpVersion('minor');
+function bumpMinor(cb) {
+  bumpVersion('minor');
+  cb();
 }
-gulp.task('bump-feature', gulp.series('ensure-git-clean', bumpFeature));
-function bumpVersion() {
-  return bumpVersion('major');
+gulp.task('bump-minor', gulp.series('ensure-git-clean', bumpMinor));
+function bumpMajor(cb) {
+  bumpVersion('major');
+  cb();
 }
-gulp.task('bump-release', gulp.series('ensure-git-clean', bumpVersion));
+gulp.task('bump-major', gulp.series('ensure-git-clean', bumpMajor));
 
 /**
  * Lints all of the JavaScript files and fails if the tasks do not pass
@@ -117,7 +174,7 @@ function spec(callback) {
       .on('finish', function() {
         gulp.src(test)
             .pipe(mocha({
-              reporter: process.env.TRAVIS ? 'spec' : 'nyan'
+              reporter: 'nyan'
             }))
             .pipe(istanbul.writeReports({
               reporters: ['text', 'text-summary']

package/lib/auth/app.js

@@ -97,7 +97,7 @@ App.prototype.accessTokenFromCode = function(code, options) {
   var params = {
     method: 'POST',
     url: this.asanaTokenUrl(options),
-    formData: {
+    form: {
       'grant_type': 'authorization_code',
       'client_id': this.clientId,
       'client_secret': this.clientSecret,
@@ -121,7 +121,7 @@ App.prototype.accessTokenFromRefreshToken = function(refreshToken, options) {
   var params = {
     method: 'POST',
     url: this.asanaTokenUrl(options),
-    formData: {
+    form: {
       'grant_type': 'refresh_token',
       'client_id': this.clientId,
       'client_secret': this.clientSecret,

package/lib/resources/gen/audit_log_api.js

@@ -0,0 +1,45 @@
+/**
+ * This file is auto-generated by our openapi spec.
+ * We try to keep the generated code pretty clean but there will be lint
+ * errors that are just not worth fixing (like unused requires).
+ * TODO: maybe we can just disable those specifically and keep this code
+ * pretty lint-free too!
+ */
+/* jshint ignore:start */
+var Resource = require('../resource');
+var util = require('util');
+var _ = require('lodash');
+
+function AuditLogAPI(dispatcher) {
+    Resource.call(this, dispatcher);
+}
+util.inherits(AuditLogAPI, Resource);
+
+
+/**
+ * Get audit log events
+ * @param {String} workspaceGid: (required) Globally unique identifier for the workspace or organization.
+ * @param {Object} params: Parameters for the request
+     - startAt {Date}:  Filter to events created after this time (inclusive).
+     - endAt {Date}:  Filter to events created before this time (exclusive).
+     - eventType {String}:  Filter to events of this type. Refer to the [Supported AuditLogEvents](/docs/supported-auditlogevents) for a full list of values.
+     - actorType {String}:  Filter to events with an actor of this type. This only needs to be included if querying for actor types without an ID. If `actor_gid` is included, this should be excluded.
+     - actorGid {String}:  Filter to events triggered by the actor with this ID.
+     - resourceGid {String}:  Filter to events with this resource ID.
+     - offset {String}:  Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
+     - limit {Number}:  Results per page. The number of objects to return per page. The value must be between 1 and 100.
+ * @param {Object} [dispatchOptions]: Options, if any, to pass the dispatcher for the request
+ * @return {Promise} The requested resource
+ */
+AuditLogAPI.prototype.getAuditLogEvents = function(
+    workspaceGid,
+    params,
+    dispatchOptions
+) {
+    var path = "/workspaces/{workspace_gid}/audit_log_events".replace("{workspace_gid}", workspaceGid);
+
+    return this.dispatchGetCollection(path, params, dispatchOptions)
+};
+
+module.exports = AuditLogAPI;
+/* jshint ignore:end */

package/lib/resources/gen/goals.js

@@ -0,0 +1,299 @@
+/**
+ * This file is auto-generated by our openapi spec.
+ * We try to keep the generated code pretty clean but there will be lint
+ * errors that are just not worth fixing (like unused requires).
+ * TODO: maybe we can just disable those specifically and keep this code
+ * pretty lint-free too!
+ */
+/* jshint ignore:start */
+var Resource = require('../resource');
+var util = require('util');
+var _ = require('lodash');
+
+function Goals(dispatcher) {
+    Resource.call(this, dispatcher);
+}
+util.inherits(Goals, Resource);
+
+
+/**
+ * Add a collaborator to a goal
+ * @param {Object} data: Data for the request
+ * @param {Object} [dispatchOptions]: Options, if any, to pass the dispatcher for the request
+ * @return {Promise} The requested resource
+ */
+Goals.prototype.addFollowers = function(
+    data,
+    dispatchOptions
+) {
+    var path = "/goals/{goal_gid}/addFollowers";
+
+    return this.dispatchPost(path, data, dispatchOptions)
+};
+
+
+/**
+ * Add a subgoal to a parent goal
+ * @param {Object} data: Data for the request
+ * @param {Object} [dispatchOptions]: Options, if any, to pass the dispatcher for the request
+ * @return {Promise} The requested resource
+ */
+Goals.prototype.addSubgoal = function(
+    data,
+    dispatchOptions
+) {
+    var path = "/goals/{goal_gid}/addSubgoal";
+
+    return this.dispatchPost(path, data, dispatchOptions)
+};
+
+
+/**
+ * Add a project/portfolio as supporting work for a goal.
+ * @param {Object} data: Data for the request
+ * @param {Object} [dispatchOptions]: Options, if any, to pass the dispatcher for the request
+ * @return {Promise} The requested resource
+ */
+Goals.prototype.addSupportingWorkForGoal = function(
+    data,
+    dispatchOptions
+) {
+    var path = "/goals/{goal_gid}/addSupportingWork";
+
+    return this.dispatchPost(path, data, dispatchOptions)
+};
+
+
+/**
+ * Create a goal
+ * @param {Object} data: Data for the request
+ * @param {Object} [dispatchOptions]: Options, if any, to pass the dispatcher for the request
+ * @return {Promise} The requested resource
+ */
+Goals.prototype.createGoal = function(
+    data,
+    dispatchOptions
+) {
+    var path = "/goals";
+
+    return this.dispatchPost(path, data, dispatchOptions)
+};
+
+
+/**
+ * Create a goal metric
+ * @param {Object} data: Data for the request
+ * @param {Object} [dispatchOptions]: Options, if any, to pass the dispatcher for the request
+ * @return {Promise} The requested resource
+ */
+Goals.prototype.createGoalMetric = function(
+    data,
+    dispatchOptions
+) {
+    var path = "/goals/{goal_gid}/setMetric";
+
+    return this.dispatchPost(path, data, dispatchOptions)
+};
+
+
+/**
+ * Delete a goal
+ * @param {String} goalGid: (required) Globally unique identifier for the goal.
+ * @param {Object} data: Data for the request
+ * @param {Object} [dispatchOptions]: Options, if any, to pass the dispatcher for the request
+ * @return {Promise} The requested resource
+ */
+Goals.prototype.deleteGoal = function(
+    goalGid,
+    data,
+    dispatchOptions
+) {
+    var path = "/goals/{goal_gid}".replace("{goal_gid}", goalGid);
+
+    return this.dispatchDelete(path, data, dispatchOptions)
+};
+
+
+/**
+ * Get a goal
+ * @param {String} goalGid: (required) Globally unique identifier for the goal.
+ * @param {Object} params: Parameters for the request
+     - optFields {[String]}:  Defines fields to return. Some requests return *compact* representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The id of included objects will always be returned, regardless of the field options.
+     - optPretty {Boolean}:  Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
+ * @param {Object} [dispatchOptions]: Options, if any, to pass the dispatcher for the request
+ * @return {Promise} The requested resource
+ */
+Goals.prototype.getGoal = function(
+    goalGid,
+    params,
+    dispatchOptions
+) {
+    var path = "/goals/{goal_gid}".replace("{goal_gid}", goalGid);
+
+    return this.dispatchGet(path, params, dispatchOptions)
+};
+
+
+/**
+ * Get goals
+ * @param {Object} params: Parameters for the request
+     - portfolio {String}:  Globally unique identifier for supporting portfolio.
+     - project {String}:  Globally unique identifier for supporting project.
+     - isWorkspaceLevel {Boolean}:  Filter to goals with is_workspace_level set to query value. Must be used with the workspace parameter.
+     - team {String}:  Globally unique identifier for the team.
+     - workspace {String}:  Globally unique identifier for the workspace.
+     - timePeriods {[String]}:  Globally unique identifiers for the time periods.
+     - offset {String}:  Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
+     - limit {Number}:  Results per page. The number of objects to return per page. The value must be between 1 and 100.
+     - optFields {[String]}:  Defines fields to return. Some requests return *compact* representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The id of included objects will always be returned, regardless of the field options.
+     - optPretty {Boolean}:  Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
+ * @param {Object} [dispatchOptions]: Options, if any, to pass the dispatcher for the request
+ * @return {Promise} The requested resource
+ */
+Goals.prototype.getGoals = function(
+    params,
+    dispatchOptions
+) {
+    var path = "/goals";
+
+    return this.dispatchGetCollection(path, params, dispatchOptions)
+};
+
+
+/**
+ * Get parent goals from a goal
+ * @param {Object} params: Parameters for the request
+     - optFields {[String]}:  Defines fields to return. Some requests return *compact* representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The id of included objects will always be returned, regardless of the field options.
+     - optPretty {Boolean}:  Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
+ * @param {Object} [dispatchOptions]: Options, if any, to pass the dispatcher for the request
+ * @return {Promise} The requested resource
+ */
+Goals.prototype.getParentGoalsForGoal = function(
+    params,
+    dispatchOptions
+) {
+    var path = "/goals/{goal_gid}/parentGoals";
+
+    return this.dispatchGetCollection(path, params, dispatchOptions)
+};
+
+
+/**
+ * Get subgoals from a goal
+ * @param {Object} params: Parameters for the request
+     - optFields {[String]}:  Defines fields to return. Some requests return *compact* representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The id of included objects will always be returned, regardless of the field options.
+     - optPretty {Boolean}:  Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
+ * @param {Object} [dispatchOptions]: Options, if any, to pass the dispatcher for the request
+ * @return {Promise} The requested resource
+ */
+Goals.prototype.getSubgoalsForGoal = function(
+    params,
+    dispatchOptions
+) {
+    var path = "/goals/{goal_gid}/subgoals";
+
+    return this.dispatchGetCollection(path, params, dispatchOptions)
+};
+
+
+/**
+ * Remove a collaborator from a goal
+ * @param {Object} data: Data for the request
+ * @param {Object} [dispatchOptions]: Options, if any, to pass the dispatcher for the request
+ * @return {Promise} The requested resource
+ */
+Goals.prototype.removeFollowers = function(
+    data,
+    dispatchOptions
+) {
+    var path = "/goals/{goal_gid}/removeFollowers";
+
+    return this.dispatchPost(path, data, dispatchOptions)
+};
+
+
+/**
+ * Remove a subgoal from a goal
+ * @param {Object} data: Data for the request
+ * @param {Object} [dispatchOptions]: Options, if any, to pass the dispatcher for the request
+ * @return {Promise} The requested resource
+ */
+Goals.prototype.removeSubgoal = function(
+    data,
+    dispatchOptions
+) {
+    var path = "/goals/{goal_gid}/removeSubgoal";
+
+    return this.dispatchPost(path, data, dispatchOptions)
+};
+
+
+/**
+ * Remove a project/portfolio as supporting work for a goal.
+ * @param {Object} data: Data for the request
+ * @param {Object} [dispatchOptions]: Options, if any, to pass the dispatcher for the request
+ * @return {Promise} The requested resource
+ */
+Goals.prototype.removeSupportingWorkForGoal = function(
+    data,
+    dispatchOptions
+) {
+    var path = "/goals/{goal_gid}/removeSupportingWork";
+
+    return this.dispatchPost(path, data, dispatchOptions)
+};
+
+
+/**
+ * Get supporting work from a goal
+ * @param {Object} params: Parameters for the request
+     - optFields {[String]}:  Defines fields to return. Some requests return *compact* representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The id of included objects will always be returned, regardless of the field options.
+     - optPretty {Boolean}:  Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
+ * @param {Object} [dispatchOptions]: Options, if any, to pass the dispatcher for the request
+ * @return {Promise} The requested resource
+ */
+Goals.prototype.supportingWork = function(
+    params,
+    dispatchOptions
+) {
+    var path = "/goals/{goal_gid}/supportingWork";
+
+    return this.dispatchGetCollection(path, params, dispatchOptions)
+};
+
+
+/**
+ * Update a goal
+ * @param {String} goalGid: (required) Globally unique identifier for the goal.
+ * @param {Object} data: Data for the request
+ * @param {Object} [dispatchOptions]: Options, if any, to pass the dispatcher for the request
+ * @return {Promise} The requested resource
+ */
+Goals.prototype.updateGoal = function(
+    goalGid,
+    data,
+    dispatchOptions
+) {
+    var path = "/goals/{goal_gid}".replace("{goal_gid}", goalGid);
+
+    return this.dispatchPut(path, data, dispatchOptions)
+};
+
+
+/**
+ * Update a goal metric
+ * @param {Object} data: Data for the request
+ * @param {Object} [dispatchOptions]: Options, if any, to pass the dispatcher for the request
+ * @return {Promise} The requested resource
+ */
+Goals.prototype.updateGoalMetric = function(
+    data,
+    dispatchOptions
+) {
+    var path = "/goals/{goal_gid}/setMetricCurrentValue";
+
+    return this.dispatchPost(path, data, dispatchOptions)
+};
+
+module.exports = Goals;
+/* jshint ignore:end */