@openstax/highlights-client - npm Package Compare versions

Comparing version 0.1.0 to 0.2.0

dist/apis/HighlightsApi.js

@@ -16,5 +16,8 @@ "use strict";
 var __extends = (this && this.__extends) || (function () {
-    var extendStatics = Object.setPrototypeOf ||
-        ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-        function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
     return function (d, b) {
@@ -21,0 +24,0 @@ extendStatics(d, b);

dist/apis/InfoApi.js

@@ -16,5 +16,8 @@ "use strict";
 var __extends = (this && this.__extends) || (function () {
-    var extendStatics = Object.setPrototypeOf ||
-        ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-        function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
     return function (d, b) {
@@ -21,0 +24,0 @@ extendStatics(d, b);

dist/models/InfoData.d.ts

@@ -19,2 +19,32 @@ /**
     /**
+     * The total number of notes/annotations
+     * @type {number}
+     * @memberof InfoData
+     */
+    totalNotes?: number;
+    /**
+     * The number of users with notes
+     * @type {number}
+     * @memberof InfoData
+     */
+    numUsersWithNotes?: number;
+    /**
+     * The average length (chars) of a note
+     * @type {number}
+     * @memberof InfoData
+     */
+    avgNoteLength?: number;
+    /**
+     * The median length (chars) of a note
+     * @type {number}
+     * @memberof InfoData
+     */
+    medianNoteLength?: number;
+    /**
+     * The max length (chars) of a note for any user
+     * @type {number}
+     * @memberof InfoData
+     */
+    maxNoteLength?: number;
+    /**
      * The total number of highlights
@@ -26,2 +56,8 @@ * @type {number}
     /**
+     * The number of users with highlights
+     * @type {number}
+     * @memberof InfoData
+     */
+    numUsersWithHighlights?: number;
+    /**
      * The average number of highlights per user
@@ -33,2 +69,8 @@ * @type {number}
     /**
+     * The median number of highlights per user
+     * @type {number}
+     * @memberof InfoData
+     */
+    medianHighlightsPerUser?: number;
+    /**
      * The max number of highlights used by any one user
@@ -40,13 +82,25 @@ * @type {number}
     /**
-     * The total number of notes/annotations
+     * The number of users that have greater than 200 highlights on any page
      * @type {number}
      * @memberof InfoData
      */
-    totalNotes?: number;
+    numUsersGt200HighlightsPerPage?: number;
     /**
-     * The average length (chars) of a note
+     * The number of users that have greater than 10 highlights
      * @type {number}
      * @memberof InfoData
      */
-    avgNoteLength?: number;
+    numUsersGt10Highlights?: number;
+    /**
+     * The number of users that have greater than 50 highlights
+     * @type {number}
+     * @memberof InfoData
+     */
+    numUsersGt50Highlights?: number;
+    /**
+     * The total number of users
+     * @type {number}
+     * @memberof InfoData
+     */
+    totalUsers?: number;
 }
@@ -53,0 +107,0 @@ export declare function InfoDataFromJSON(json: any): InfoData;

dist/models/InfoData.js

@@ -26,7 +26,16 @@ "use strict";
     return {
+        'totalNotes': !runtime_1.exists(json, 'total_notes') ? undefined : json['total_notes'],
+        'numUsersWithNotes': !runtime_1.exists(json, 'num_users_with_notes') ? undefined : json['num_users_with_notes'],
+        'avgNoteLength': !runtime_1.exists(json, 'avg_note_length') ? undefined : json['avg_note_length'],
+        'medianNoteLength': !runtime_1.exists(json, 'median_note_length') ? undefined : json['median_note_length'],
+        'maxNoteLength': !runtime_1.exists(json, 'max_note_length') ? undefined : json['max_note_length'],
         'totalHighlights': !runtime_1.exists(json, 'total_highlights') ? undefined : json['total_highlights'],
+        'numUsersWithHighlights': !runtime_1.exists(json, 'num_users_with_highlights') ? undefined : json['num_users_with_highlights'],
         'avgHighlightsPerUser': !runtime_1.exists(json, 'avg_highlights_per_user') ? undefined : json['avg_highlights_per_user'],
+        'medianHighlightsPerUser': !runtime_1.exists(json, 'median_highlights_per_user') ? undefined : json['median_highlights_per_user'],
         'maxNumHighlightsAnyUser': !runtime_1.exists(json, 'max_num_highlights_any_user') ? undefined : json['max_num_highlights_any_user'],
-        'totalNotes': !runtime_1.exists(json, 'total_notes') ? undefined : json['total_notes'],
-        'avgNoteLength': !runtime_1.exists(json, 'avg_note_length') ? undefined : json['avg_note_length'],
+        'numUsersGt200HighlightsPerPage': !runtime_1.exists(json, 'num_users_gt_200_highlights_per_page') ? undefined : json['num_users_gt_200_highlights_per_page'],
+        'numUsersGt10Highlights': !runtime_1.exists(json, 'num_users_gt_10_highlights') ? undefined : json['num_users_gt_10_highlights'],
+        'numUsersGt50Highlights': !runtime_1.exists(json, 'num_users_gt_50_highlights') ? undefined : json['num_users_gt_50_highlights'],
+        'totalUsers': !runtime_1.exists(json, 'total_users') ? undefined : json['total_users'],
     };
@@ -43,9 +52,18 @@ }
     return {
+        'total_notes': value.totalNotes,
+        'num_users_with_notes': value.numUsersWithNotes,
+        'avg_note_length': value.avgNoteLength,
+        'median_note_length': value.medianNoteLength,
+        'max_note_length': value.maxNoteLength,
         'total_highlights': value.totalHighlights,
+        'num_users_with_highlights': value.numUsersWithHighlights,
         'avg_highlights_per_user': value.avgHighlightsPerUser,
+        'median_highlights_per_user': value.medianHighlightsPerUser,
         'max_num_highlights_any_user': value.maxNumHighlightsAnyUser,
-        'total_notes': value.totalNotes,
-        'avg_note_length': value.avgNoteLength,
+        'num_users_gt_200_highlights_per_page': value.numUsersGt200HighlightsPerPage,
+        'num_users_gt_10_highlights': value.numUsersGt10Highlights,
+        'num_users_gt_50_highlights': value.numUsersGt50Highlights,
+        'total_users': value.totalUsers,
     };
 }
 exports.InfoDataToJSON = InfoDataToJSON;

dist/models/InfoResults.d.ts

@@ -50,2 +50,8 @@ /**
     /**
+     * Git sha
+     * @type {string}
+     * @memberof InfoResults
+     */
+    readonly gitSha?: string;
+    /**
      *
@@ -52,0 +58,0 @@ * @type {InfoData}

dist/models/InfoResults.js

@@ -32,2 +32,3 @@ "use strict";
         'amiId': !runtime_1.exists(json, 'ami_id') ? undefined : json['ami_id'],
+        'gitSha': !runtime_1.exists(json, 'git_sha') ? undefined : json['git_sha'],
         'data': !runtime_1.exists(json, 'data') ? undefined : _1.InfoDataFromJSON(json['data']),
@@ -34,0 +35,0 @@ };

dist/runtime.d.ts

@@ -129,3 +129,3 @@ /**
     constructor(raw: Response);
-    value(): Promise<any>;
+    value(): Promise<void>;
 }
@@ -132,0 +132,0 @@ export declare class BlobApiResponse {

dist/runtime.js

@@ -16,5 +16,8 @@ "use strict";
 var __extends = (this && this.__extends) || (function () {
-    var extendStatics = Object.setPrototypeOf ||
-        ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-        function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
     return function (d, b) {
@@ -26,9 +29,12 @@ extendStatics(d, b);
 })();
-var __assign = (this && this.__assign) || Object.assign || function(t) {
-    for (var s, i = 1, n = arguments.length; i < n; i++) {
-        s = arguments[i];
-        for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-            t[p] = s[p];
-    }
-    return t;
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
 };
@@ -35,0 +41,0 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {

package.json

 {
   "name": "@openstax/highlights-client",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "OpenAPI client for @openstax/highlights-client",
@@ -5,0 +5,0 @@ "author": "OpenAPI-Generator",

src/models/InfoData.ts

@@ -23,2 +23,32 @@ /* tslint:disable */
     /**
+     * The total number of notes/annotations
+     * @type {number}
+     * @memberof InfoData
+     */
+    totalNotes?: number;
+    /**
+     * The number of users with notes
+     * @type {number}
+     * @memberof InfoData
+     */
+    numUsersWithNotes?: number;
+    /**
+     * The average length (chars) of a note
+     * @type {number}
+     * @memberof InfoData
+     */
+    avgNoteLength?: number;
+    /**
+     * The median length (chars) of a note
+     * @type {number}
+     * @memberof InfoData
+     */
+    medianNoteLength?: number;
+    /**
+     * The max length (chars) of a note for any user
+     * @type {number}
+     * @memberof InfoData
+     */
+    maxNoteLength?: number;
+    /**
      * The total number of highlights
@@ -30,2 +60,8 @@ * @type {number}
     /**
+     * The number of users with highlights
+     * @type {number}
+     * @memberof InfoData
+     */
+    numUsersWithHighlights?: number;
+    /**
      * The average number of highlights per user
@@ -37,2 +73,8 @@ * @type {number}
     /**
+     * The median number of highlights per user
+     * @type {number}
+     * @memberof InfoData
+     */
+    medianHighlightsPerUser?: number;
+    /**
      * The max number of highlights used by any one user
@@ -44,13 +86,25 @@ * @type {number}
     /**
-     * The total number of notes/annotations
+     * The number of users that have greater than 200 highlights on any page
      * @type {number}
      * @memberof InfoData
      */
-    totalNotes?: number;
+    numUsersGt200HighlightsPerPage?: number;
     /**
-     * The average length (chars) of a note
+     * The number of users that have greater than 10 highlights
      * @type {number}
      * @memberof InfoData
      */
-    avgNoteLength?: number;
+    numUsersGt10Highlights?: number;
+    /**
+     * The number of users that have greater than 50 highlights
+     * @type {number}
+     * @memberof InfoData
+     */
+    numUsersGt50Highlights?: number;
+    /**
+     * The total number of users
+     * @type {number}
+     * @memberof InfoData
+     */
+    totalUsers?: number;
 }
@@ -68,7 +122,16 @@
         
+        'totalNotes': !exists(json, 'total_notes') ? undefined : json['total_notes'],
+        'numUsersWithNotes': !exists(json, 'num_users_with_notes') ? undefined : json['num_users_with_notes'],
+        'avgNoteLength': !exists(json, 'avg_note_length') ? undefined : json['avg_note_length'],
+        'medianNoteLength': !exists(json, 'median_note_length') ? undefined : json['median_note_length'],
+        'maxNoteLength': !exists(json, 'max_note_length') ? undefined : json['max_note_length'],
         'totalHighlights': !exists(json, 'total_highlights') ? undefined : json['total_highlights'],
+        'numUsersWithHighlights': !exists(json, 'num_users_with_highlights') ? undefined : json['num_users_with_highlights'],
         'avgHighlightsPerUser': !exists(json, 'avg_highlights_per_user') ? undefined : json['avg_highlights_per_user'],
+        'medianHighlightsPerUser': !exists(json, 'median_highlights_per_user') ? undefined : json['median_highlights_per_user'],
         'maxNumHighlightsAnyUser': !exists(json, 'max_num_highlights_any_user') ? undefined : json['max_num_highlights_any_user'],
-        'totalNotes': !exists(json, 'total_notes') ? undefined : json['total_notes'],
-        'avgNoteLength': !exists(json, 'avg_note_length') ? undefined : json['avg_note_length'],
+        'numUsersGt200HighlightsPerPage': !exists(json, 'num_users_gt_200_highlights_per_page') ? undefined : json['num_users_gt_200_highlights_per_page'],
+        'numUsersGt10Highlights': !exists(json, 'num_users_gt_10_highlights') ? undefined : json['num_users_gt_10_highlights'],
+        'numUsersGt50Highlights': !exists(json, 'num_users_gt_50_highlights') ? undefined : json['num_users_gt_50_highlights'],
+        'totalUsers': !exists(json, 'total_users') ? undefined : json['total_users'],
     };
@@ -86,7 +149,16 @@ }
         
+        'total_notes': value.totalNotes,
+        'num_users_with_notes': value.numUsersWithNotes,
+        'avg_note_length': value.avgNoteLength,
+        'median_note_length': value.medianNoteLength,
+        'max_note_length': value.maxNoteLength,
         'total_highlights': value.totalHighlights,
+        'num_users_with_highlights': value.numUsersWithHighlights,
         'avg_highlights_per_user': value.avgHighlightsPerUser,
+        'median_highlights_per_user': value.medianHighlightsPerUser,
         'max_num_highlights_any_user': value.maxNumHighlightsAnyUser,
-        'total_notes': value.totalNotes,
-        'avg_note_length': value.avgNoteLength,
+        'num_users_gt_200_highlights_per_page': value.numUsersGt200HighlightsPerPage,
+        'num_users_gt_10_highlights': value.numUsersGt10Highlights,
+        'num_users_gt_50_highlights': value.numUsersGt50Highlights,
+        'total_users': value.totalUsers,
     };
@@ -93,0 +165,0 @@ }

src/models/InfoResults.ts

@@ -60,2 +60,8 @@ /* tslint:disable */
     /**
+     * Git sha
+     * @type {string}
+     * @memberof InfoResults
+     */
+    readonly gitSha?: string;
+    /**
      * 
@@ -83,2 +89,3 @@ * @type {InfoData}
         'amiId': !exists(json, 'ami_id') ? undefined : json['ami_id'],
+        'gitSha': !exists(json, 'git_sha') ? undefined : json['git_sha'],
         'data': !exists(json, 'data') ? undefined : InfoDataFromJSON(json['data']),
@@ -85,0 +92,0 @@ };

src/runtime.ts

@@ -289,3 +289,3 @@ /* tslint:disable */
 
-    async value() {
+    async value(): Promise<T> {
         return this.transformer(await this.raw.json());
@@ -298,3 +298,3 @@ }
 
-    async value() {
+    async value(): Promise<void> {
         return undefined;
@@ -307,3 +307,3 @@ }
 
-    async value() {
+    async value(): Promise<Blob> {
         return await this.raw.blob();
@@ -316,5 +316,5 @@ };
 
-    async value() {
+    async value(): Promise<string> {
         return await this.raw.text();
     };
 }

No alert changes

Improved metrics

Total package byte prevSize

186070

increased by3.83%

Lines of code

4849

increased by3.63%

No dependency changes