feat(leaderboard): #getArchives

Author: leeyeh

src/leaderboard.js

@@ -45,6 +45,16 @@ AV.LeaderboardUpdateStrategy = {
  * @property {Statistic[]} [includedStatistics] Other statistics of the user, specified by the `includeStatistic` option of `AV.Leaderboard.getResults()`
  */
 
+/**
+ * @typedef {Object} LeaderboardArchive
+ * @property {string} statisticName
+ * @property {number} version version of the leaderboard
+ * @property {string} status
+ * @property {string} url URL for the downloadable archive
+ * @property {Date} activatedAt time when this version became active
+ * @property {Date} deactivatedAt time when this version was deactivated by a version incrementing
+ */
+
 /**
  * @class
  */
@@ -358,5 +368,33 @@ _.extend(
         authOptions,
       }).then(() => undefined);
     },
+    /**
+     * (masterKey required) Get archived versions.
+     * @param {Object} [options]
+     * @param {number} [options.skip] The number of results to skip. This is useful for pagination.
+     * @param {number} [options.limit] The limit of the number of results.
+     * @param {AuthOptions} [authOptions]
+     * @return {Promise<LeaderboardArchive[]>}
+     */
+    getArchives({ skip, limit } = {}, authOptions) {
+      return request({
+        method: 'GET',
+        path: `/leaderboard/leaderboards/${this.statisticName}/archives`,
+        query: {
+          skip,
+          limit,
+        },
+        authOptions,
+      }).then(({ results }) =>
+        results.map(({ version, status, url, activatedAt, deactivatedAt }) => ({
+          statisticName: this.statisticName,
+          version,
+          status,
+          url,
+          activatedAt: parseDate(activatedAt.iso),
+          deactivatedAt: parseDate(deactivatedAt.iso),
+        }))
+      );
+    },
   }
 );

storage.d.ts

@@ -844,6 +844,15 @@ declare interface UpdateStatisticsOptions extends AuthOptions {
   overwrite?: boolean;
 }
 
+declare interface LeaderboardArchive {
+  statisticName: string;
+  version: number;
+  status: string;
+  url: string;
+  activatedAt: Date;
+  deactivatedAt: Date;
+}
+
 export class Leaderboard {
   statisticName: string;
   order?: LeaderboardOrder;
@@ -907,6 +916,13 @@ export class Leaderboard {
   ): Promise<Leaderboard>;
   reset(authOptions?: AuthOptions): Promise<Leaderboard>;
   destroy(authOptions?: AuthOptions): Promise<void>;
+  getArchives(
+    options?: {
+      skip?: number;
+      limit?: number;
+    },
+    authOptions?: AuthOptions
+  ): Promise<LeaderboardArchive>;
 }
 
 export enum LeaderboardOrder {

test/leaderboard.js

@@ -80,6 +80,11 @@ describe('Leaderboard', () => {
         );
       });
   });
+  it('getArchives', function() {
+    return this.leaderboard.getArchives(undefined, {
+      useMasterKey: true,
+    });
+  });
 
   describe('Statistics', function() {
     let users;