feat(leaderboard): add AV.Leaderboard.deleteStatistics

Author: leeyeh

src/leaderboard.js

@@ -180,6 +180,7 @@ AV.Leaderboard.getStatistics = (user, { statisticNames } = {}, authOptions) =>
       authOptions,
     }).then(({ results }) => results.map(parseStatisticData));
   });
+
 /**
  * Update Statistics for the specified user.
  * @param {AV.User} user The specified AV.User pointer.
@@ -207,6 +208,26 @@ AV.Leaderboard.updateStatistics = (user, statistics, options = {}) =>
     }).then(({ results }) => results.map(parseStatisticData));
   });
 
+/**
+ * Delete Statistics for the specified user.
+ * @param {AV.User} user The specified AV.User pointer.
+ * @param {Object} statistics A name-value pair representing the statistics to delete.
+ * @param {AuthOptions} [options]
+ * @return {Promise<void>}
+ */
+AV.Leaderboard.deleteStatistics = (user, statisticNames, authOptions) =>
+  Promise.resolve().then(() => {
+    if (!(user && user.id)) throw new Error('user must be an AV.User');
+    return request({
+      method: 'DELETE',
+      path: `/leaderboard/users/${user.id}/statistics`,
+      query: {
+        statistics: ensureArray(statisticNames).join(','),
+      },
+      authOptions,
+    }).then(() => undefined);
+  });
+
 _.extend(
   Leaderboard.prototype,
   /** @lends AV.Leaderboard.prototype */ {

storage.d.ts

@@ -888,6 +888,11 @@ export class Leaderboard {
     statistics: { [name: string]: number },
     options?: UpdateStatisticsOptions
   ): Promise<Statistic[]>;
+  static deleteStatistics(
+    user: User,
+    statisticNames: string[],
+    authOptions?: AuthOptions
+  ): Promise<void>;
 
   fetch(authOptions?: AuthOptions): Promise<Leaderboard>;
   getResults(

test/leaderboard.js

@@ -196,6 +196,14 @@ describe('Leaderboard', () => {
           rankings.map(ranking => ranking.rank).should.eql([0, 1, 2]);
         });
     });
+    it('delete statistics', function() {
+      const leaderboard = this.leaderboard;
+      return AV.Leaderboard.deleteStatistics(currentUser, statisticName, {
+        user: currentUser,
+      })
+        .then(() => leaderboard.getResults())
+        .then(rankings => rankings.should.be.length(3));
+    });
   });
 
   after(function() {