19 |
20 |
Source: APIError.js
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 | // Copyright (c) 2021-2022 BuiltByBit (Mick Capital Pty. Ltd.)
30 | // MIT License (https://github.com/BuiltByBit/js-api-wrapper/blob/main/LICENSE)
31 |
32 | /** A type which represents a parsed error from the API, or an internal wrapper error. */
33 | class APIError extends Error {
34 | #code;
35 | #message;
36 |
37 | constructor(json) {
38 | super(`${json.code} - ${json.message}`);
39 |
40 | this.#code = json.code;
41 | this.#message = json.message;
42 | }
43 |
44 | /** Returns the machine-readable code of the error.
45 | *
46 | * @type {string} The machine-readable error code.
47 | */
48 | get code() {
49 | return this.#code;
50 | }
51 |
52 | /** Returns the human-readable message of the error.
53 | *
54 | * @type {string} The human-readable error message.
55 | */
56 | get message() {
57 | return this.#message;
58 | }
59 |
60 | /** Constructs a new Error which originated within the wrapper.
61 | *
62 | * @param {string} message The internal error message.
63 | * @returns {APIError} The newly-constructed error.
64 | */
65 | static internal(message) {
66 | return new APIError({code: "InternalWrapperError", message});
67 | }
68 | }
69 |
70 | exports.APIError = APIError;
71 |
72 |
73 |
74 |
75 |
76 |
77 |
19 |
20 |
Source: Error.js
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 | // Copyright (c) 2021-2022 BuiltByBit (Mick Capital Pty. Ltd.)
30 | // MIT License (https://github.com/BuiltByBit/js-api-wrapper/blob/main/LICENSE)
31 |
32 | /** A type which represents a parsed error from the API, or an internal wrapper error. */
33 | class Error {
34 | #code;
35 | #message;
36 |
37 | constructor(json) {
38 | this.#code = json.code;
39 | this.#message = json.message;
40 | }
41 |
42 | /** Returns a string representation of this error including both the machine and human-readable parts.
43 | *
44 | * @returns {string} A string representation of this error.
45 | */
46 | toString() {
47 | return `${this.#code}: ${this.#message}`;
48 | }
49 |
50 | /** Returns the machine-readable code of the error.
51 | *
52 | * @returns {string} The machine-readable error code.
53 | */
54 | code() {
55 | return this.#code;
56 | }
57 |
58 | /** Returns the human-readable message of the error.
59 | *
60 | * @returns {string} The human-readable error message.
61 | */
62 | message() {
63 | return this.#message;
64 | }
65 |
66 | /** Constructs a new Error which originated within the wrapper.
67 | *
68 | * @param {string} message The internal error message.
69 | * @returns {Error} The newly-constructed error.
70 | */
71 | static internal(message) {
72 | return new Error({code: "InternalWrapperError", message});
73 | }
74 | }
75 |
76 | exports.Error = Error;
77 |
78 |
79 |
80 |
81 |
82 |
83 |
19 |
20 |
Source: SortOptions.js
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 | // Copyright (c) 2021-2022 BuiltByBit (Mick Capital Pty. Ltd.)
30 | // MIT License (https://github.com/BuiltByBit/js-api-wrapper/blob/main/LICENSE)
31 |
32 | /** A type representing the sorting options available for listing-style endpoints. */
33 | class SortOptions {
34 | sort;
35 | order;
36 | page;
37 |
38 | /** Convets this SortOptions instance into a query string.
39 | *
40 | * @returns {string} The query-string representation.
41 | */
42 | toQueryString() {
43 | let asArray = [];
44 |
45 | if (this.sort) {
46 | asArray.push(`sort=${this.sort}`);
47 | }
48 | if (this.order) {
49 | asArray.push(`order=${this.order}`);
50 | }
51 | if (this.page) {
52 | asArray.push(`page=${this.page}`);
53 | }
54 |
55 | return "?" + asArray.join("&");
56 | }
57 |
58 | /** Returns whether or not any sort options have been set.
59 | *
60 | * @returns {boolean} Whether or not any sort options have been set.
61 | */
62 | isSet() {
63 | return this.sort || this.order || this.page;
64 | }
65 | }
66 |
67 | exports.SortOptions = SortOptions;
68 |
69 |
70 |
71 |
72 |
73 |
74 |
19 |
20 |
Source: Token.js
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 | // Copyright (c) 2021-2022 BuiltByBit (Mick Capital Pty. Ltd.)
30 | // MIT License (https://github.com/BuiltByBit/js-api-wrapper/blob/main/LICENSE)
31 |
32 | const { TokenType } = require("./TokenType");
33 |
34 | /** A type representing an API authentication token. */
35 | class Token {
36 | #type;
37 | #value;
38 |
39 | /** Constructs a new token from its constituents.
40 | *
41 | * @param {TokenType} type The type of this token.
42 | * @param {string} value The value of this token.
43 | */
44 | constructor(type, value) {
45 | this.#type = type;
46 | this.#value = value;
47 | }
48 |
49 | /** Constructs an object containing the header representation of this token.
50 | *
51 | * @returns An object with a single attribute, 'Authorization'.
52 | */
53 | asHeader() {
54 | return {Authorization: `${this.#type.headerName()} ${this.#value}`};
55 | }
56 | }
57 |
58 | exports.Token = Token;
59 |
60 |
61 |
62 |
63 |
64 |
65 |
19 |
20 |
Class: TokenType
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
37 |
38 |
39 |
40 |
41 |
42 |
43 |
44 |
Constructor
45 |
46 |
47 |
48 |
new TokenType()
49 |
50 |
51 |
52 |
53 |
54 |
55 |
56 |
57 |
58 |
59 |
60 |
61 |
62 |
63 |
64 |
65 |
66 |
67 |
68 |
69 |
70 |
71 |
72 |
73 |
74 |
75 |
76 |
77 |
78 |
79 |
80 |
81 |
82 |
83 |
84 |
85 |
86 |
87 |
88 |
89 |
90 |
91 |
92 |
93 |
94 | - Source:
95 |
98 |
99 |
100 |
101 |
102 |
103 |
104 |
105 |
106 |
107 |
108 |
109 |
110 |
111 |
112 |
113 |
114 |
115 |
116 |
117 |
118 |
119 |
120 |
121 |
122 |
123 |
124 |
125 |
126 |
127 |
151 |
152 |
153 |
154 |
155 |
19 |
20 |
Source: TokenType.js
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 | // Copyright (c) 2021-2022 BuiltByBit (Mick Capital Pty. Ltd.)
30 | // MIT License (https://github.com/BuiltByBit/js-api-wrapper/blob/main/LICENSE)
31 |
32 | /** A type representing the different token types. */
33 | class TokenType {
34 | static PRIVATE = new TokenType("Private");
35 | static SHARED = new TokenType("Shared");
36 |
37 | #headerName;
38 |
39 | constructor(headerName) {
40 | this.#headerName = headerName;
41 | }
42 |
43 | headerName() {
44 | return this.#headerName;
45 | }
46 | }
47 |
48 | exports.TokenType = TokenType;
49 |
50 |
51 |
52 |
53 |
54 |
55 |
19 |
20 |
Source: helpers/AlertsHelper.js
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 | // Copyright (c) 2021-2022 BuiltByBit (Mick Capital Pty. Ltd.)
30 | // MIT License (https://github.com/BuiltByBit/js-api-wrapper/blob/main/LICENSE)
31 |
32 | const { SortOptions } = require("../SortOptions");
33 |
34 | /**
35 | * @typedef {object} Alert
36 | * @property {number} caused_member_id
37 | * @property {string} content_type
38 | * @property {number} content_id
39 | * @property {string} alert_type
40 | * @property {number} alert_date
41 | */
42 |
43 | /** A helper type for alert-related API endpoints. */
44 | class AlertsHelper {
45 | #wrapper;
46 |
47 | constructor(wrapper) {
48 | this.#wrapper = wrapper;
49 | }
50 |
51 | /** List a single page of unread alerts.
52 | *
53 | * @param {SortOptions | undefined} sort An optional set of sort options.
54 | * @return {Array<Alert>} An array of raw data objects.
55 | */
56 | async list(sort) {
57 | return await this.#wrapper.http().get("/alerts", sort);
58 | }
59 |
60 | /** List all pages of unread alerts.
61 | *
62 | * @param {SortOptions | undefined} sort An optional set of sort options.
63 | * @return {Array<Alert>} An array of raw data objects.
64 | */
65 | async listAll(sort) {
66 | return await this.#wrapper.http().listUntil("/alerts", () => true, sort);
67 | }
68 |
69 | /** List multiple pages of unread alerts until a condition is no longer met.
70 | *
71 | * @param {function(Alert):boolean} shouldContinue A function which determines if further pages are requested.
72 | * @param {SortOptions | undefined} sort An optional set of sort options.
73 | *
74 | * @return {Array<Alert>} An array of raw data objects.
75 | */
76 | async listUntil(shouldContinue, sort) {
77 | return await this.#wrapper.http().listUntil("/alerts", shouldContinue, sort);
78 | }
79 |
80 | /** Mark unread alerts as read. */
81 | async markAsRead() {
82 | return await this.#wrapper.http().patch("/alerts", { read: true });
83 | }
84 | }
85 |
86 | exports.AlertsHelper = AlertsHelper;
87 |
88 |
89 |
90 |
91 |
92 |
93 |
19 |
20 |
Source: helpers/resources/PurchasesHelper.js
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 | // Copyright (c) 2021-2022 BuiltByBit (Mick Capital Pty. Ltd.)
30 | // MIT License (https://github.com/BuiltByBit/js-api-wrapper/blob/main/LICENSE)
31 |
32 | const { SortOptions } = require("../../SortOptions");
33 |
34 | /**
35 | * @typedef {object} Purchase
36 | * @property {number} purchase_id
37 | * @property {number} purchaser_id
38 | * @property {number} license_id
39 | * @property {boolean} renewal
40 | * @property {string} status
41 | * @property {number} price
42 | * @property {string} currency
43 | * @property {number} purchase_date
44 | * @property {number} validation_date
45 | */
46 |
47 | /** A helper type for resource purchase-related API endpoints. */
48 | class PurchasesHelper {
49 | #wrapper;
50 |
51 | constructor(wrapper) {
52 | this.#wrapper = wrapper;
53 | }
54 |
55 | /** List a page of purchases for a given resource.
56 | *
57 | * @param {number} resourceId The identifier of the resource.
58 | * @param {SortOptions | undefined} sort An optional set of sort options.
59 | *
60 | * @return {Array<Purchase>} An array of raw data objects.
61 | */
62 | async list(resourceId, sort) {
63 | return await this.#wrapper.http().get(`/resources/${resourceId}/purchases`, sort);
64 | }
65 |
66 | /** List all pages of purchases for a given resource.
67 | *
68 | * @param {number} resourceId The identifier of the resource.
69 | * @param {SortOptions | undefined} sort An optional set of sort options.
70 | *
71 | * @return {Array<Purchase>} An array of raw data objects.
72 | */
73 | async listAll(resourceId, sort) {
74 | return await this.#wrapper.http().listUntil(`/resources/${resourceId}/purchases`, () => true, sort);
75 | }
76 |
77 | /** List multiple pages of purchases for a given resource until a condition is no longer met.
78 | *
79 | * @param {number} resourceId The identifier of the resource.
80 | * @param {function(Purchase):boolean} shouldContinue A function which determines if further pages are requested.
81 | * @param {SortOptions | undefined} sort An optional set of sort options.
82 | *
83 | * @return {Array<Purchase>} An array of raw data objects.
84 | */
85 | async listUntil(resourceId, shouldContinue, sort) {
86 | return await this.#wrapper.http().listUntil(`/resources/${resourceId}/purchases`, shouldContinue, sort);
87 | }
88 |
89 | /** Fetch a purchase for a given resource.
90 | *
91 | * @param {number} resourceId The identifier of the resource.
92 | * @param {number} purchaseId The identifier of the purchase.
93 | *
94 | * @return {Purchase} A raw data object.
95 | */
96 | async fetch(resourceId, purchaseId) {
97 | return await this.#wrapper.http().get(`/resources/${resourceId}/purchases/${purchaseId}`);
98 | }
99 | }
100 |
101 | exports.PurchasesHelper = PurchasesHelper;
102 |
103 |
104 |
105 |
106 |
107 |
108 |
19 |
20 |
Source: APIError.js
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 | // Copyright (c) 2021-2022 BuiltByBit (Mick Capital Pty. Ltd.)
30 | // MIT License (https://github.com/BuiltByBit/js-api-wrapper/blob/main/LICENSE)
31 |
32 | /** A type which represents a parsed error from the API, or an internal wrapper error. */
33 | class APIError extends Error {
34 | #code;
35 | #message;
36 |
37 | constructor(json) {
38 | super(`${json.code} - ${json.message}`);
39 |
40 | this.#code = json.code;
41 | this.#message = json.message;
42 | }
43 |
44 | /** Returns the machine-readable code of the error.
45 | *
46 | * @type {string} The machine-readable error code.
47 | */
48 | get code() {
49 | return this.#code;
50 | }
51 |
52 | /** Returns the human-readable message of the error.
53 | *
54 | * @type {string} The human-readable error message.
55 | */
56 | get message() {
57 | return this.#message;
58 | }
59 |
60 | /** Constructs a new Error which originated within the wrapper.
61 | *
62 | * @param {string} message The internal error message.
63 | * @returns {APIError} The newly-constructed error.
64 | */
65 | static internal(message) {
66 | return new APIError({code: "InternalWrapperError", message});
67 | }
68 | }
69 |
70 | exports.APIError = APIError;
71 |
72 |
73 |
74 |
75 |
76 |
77 |
19 |
20 |
Source: Error.js
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 | // Copyright (c) 2021-2022 BuiltByBit (Mick Capital Pty. Ltd.)
30 | // MIT License (https://github.com/BuiltByBit/js-api-wrapper/blob/main/LICENSE)
31 |
32 | /** A type which represents a parsed error from the API, or an internal wrapper error. */
33 | class Error {
34 | #code;
35 | #message;
36 |
37 | constructor(json) {
38 | this.#code = json.code;
39 | this.#message = json.message;
40 | }
41 |
42 | /** Returns a string representation of this error including both the machine and human-readable parts.
43 | *
44 | * @returns {string} A string representation of this error.
45 | */
46 | toString() {
47 | return `${this.#code}: ${this.#message}`;
48 | }
49 |
50 | /** Returns the machine-readable code of the error.
51 | *
52 | * @returns {string} The machine-readable error code.
53 | */
54 | code() {
55 | return this.#code;
56 | }
57 |
58 | /** Returns the human-readable message of the error.
59 | *
60 | * @returns {string} The human-readable error message.
61 | */
62 | message() {
63 | return this.#message;
64 | }
65 |
66 | /** Constructs a new Error which originated within the wrapper.
67 | *
68 | * @param {string} message The internal error message.
69 | * @returns {Error} The newly-constructed error.
70 | */
71 | static internal(message) {
72 | return new Error({code: "InternalWrapperError", message});
73 | }
74 | }
75 |
76 | exports.Error = Error;
77 |
78 |
79 |
80 |
81 |
82 |
83 |
19 |
20 |
Source: SortOptions.js
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 | // Copyright (c) 2021-2022 BuiltByBit (Mick Capital Pty. Ltd.)
30 | // MIT License (https://github.com/BuiltByBit/js-api-wrapper/blob/main/LICENSE)
31 |
32 | /** A type representing the sorting options available for listing-style endpoints. */
33 | class SortOptions {
34 | sort;
35 | order;
36 | page;
37 |
38 | /** Convets this SortOptions instance into a query string.
39 | *
40 | * @returns {string} The query-string representation.
41 | */
42 | toQueryString() {
43 | let asArray = [];
44 |
45 | if (this.sort) {
46 | asArray.push(`sort=${this.sort}`);
47 | }
48 | if (this.order) {
49 | asArray.push(`order=${this.order}`);
50 | }
51 | if (this.page) {
52 | asArray.push(`page=${this.page}`);
53 | }
54 |
55 | return "?" + asArray.join("&");
56 | }
57 |
58 | /** Returns whether or not any sort options have been set.
59 | *
60 | * @returns {boolean} Whether or not any sort options have been set.
61 | */
62 | isSet() {
63 | return this.sort || this.order || this.page;
64 | }
65 | }
66 |
67 | exports.SortOptions = SortOptions;
68 |
69 |
70 |
71 |
72 |
73 |
74 |
19 |
20 |
Source: Token.js
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 | // Copyright (c) 2021-2022 BuiltByBit (Mick Capital Pty. Ltd.)
30 | // MIT License (https://github.com/BuiltByBit/js-api-wrapper/blob/main/LICENSE)
31 |
32 | const { TokenType } = require("./TokenType");
33 |
34 | /** A type representing an API authentication token. */
35 | class Token {
36 | #type;
37 | #value;
38 |
39 | /** Constructs a new token from its constituents.
40 | *
41 | * @param {TokenType} type The type of this token.
42 | * @param {string} value The value of this token.
43 | */
44 | constructor(type, value) {
45 | this.#type = type;
46 | this.#value = value;
47 | }
48 |
49 | /** Constructs an object containing the header representation of this token.
50 | *
51 | * @returns An object with a single attribute, 'Authorization'.
52 | */
53 | asHeader() {
54 | return {Authorization: `${this.#type.headerName()} ${this.#value}`};
55 | }
56 | }
57 |
58 | exports.Token = Token;
59 |
60 |
61 |
62 |
63 |
64 |
65 |
19 |
20 |
Class: TokenType
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
37 |
38 |
39 |
40 |
41 |
42 |
43 |
44 |
Constructor
45 |
46 |
47 |
48 |
new TokenType()
49 |
50 |
51 |
52 |
53 |
54 |
55 |
56 |
57 |
58 |
59 |
60 |
61 |
62 |
63 |
64 |
65 |
66 |
67 |
68 |
69 |
70 |
71 |
72 |
73 |
74 |
75 |
76 |
77 |
78 |
79 |
80 |
81 |
82 |
83 |
84 |
85 |
86 |
87 |
88 |
89 |
90 |
91 |
92 |
93 |
94 | - Source:
95 |
98 |
99 |
100 |
101 |
102 |
103 |
104 |
105 |
106 |
107 |
108 |
109 |
110 |
111 |
112 |
113 |
114 |
115 |
116 |
117 |
118 |
119 |
120 |
121 |
122 |
123 |
124 |
125 |
126 |
127 |
151 |
152 |
153 |
154 |
155 |
19 |
20 |
Source: TokenType.js
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 | // Copyright (c) 2021-2022 BuiltByBit (Mick Capital Pty. Ltd.)
30 | // MIT License (https://github.com/BuiltByBit/js-api-wrapper/blob/main/LICENSE)
31 |
32 | /** A type representing the different token types. */
33 | class TokenType {
34 | static PRIVATE = new TokenType("Private");
35 | static SHARED = new TokenType("Shared");
36 |
37 | #headerName;
38 |
39 | constructor(headerName) {
40 | this.#headerName = headerName;
41 | }
42 |
43 | headerName() {
44 | return this.#headerName;
45 | }
46 | }
47 |
48 | exports.TokenType = TokenType;
49 |
50 |
51 |
52 |
53 |
54 |
55 |
19 |
20 |
Source: helpers/AlertsHelper.js
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 | // Copyright (c) 2021-2022 BuiltByBit (Mick Capital Pty. Ltd.)
30 | // MIT License (https://github.com/BuiltByBit/js-api-wrapper/blob/main/LICENSE)
31 |
32 | const { SortOptions } = require("../SortOptions");
33 |
34 | /**
35 | * @typedef {object} Alert
36 | * @property {number} caused_member_id
37 | * @property {string} content_type
38 | * @property {number} content_id
39 | * @property {string} alert_type
40 | * @property {number} alert_date
41 | */
42 |
43 | /** A helper type for alert-related API endpoints. */
44 | class AlertsHelper {
45 | #wrapper;
46 |
47 | constructor(wrapper) {
48 | this.#wrapper = wrapper;
49 | }
50 |
51 | /** List a single page of unread alerts.
52 | *
53 | * @param {SortOptions | undefined} sort An optional set of sort options.
54 | * @return {Array<Alert>} An array of raw data objects.
55 | */
56 | async list(sort) {
57 | return await this.#wrapper.http().get("/alerts", sort);
58 | }
59 |
60 | /** List all pages of unread alerts.
61 | *
62 | * @param {SortOptions | undefined} sort An optional set of sort options.
63 | * @return {Array<Alert>} An array of raw data objects.
64 | */
65 | async listAll(sort) {
66 | return await this.#wrapper.http().listUntil("/alerts", () => true, sort);
67 | }
68 |
69 | /** List multiple pages of unread alerts until a condition is no longer met.
70 | *
71 | * @param {function(Alert):boolean} shouldContinue A function which determines if further pages are requested.
72 | * @param {SortOptions | undefined} sort An optional set of sort options.
73 | *
74 | * @return {Array<Alert>} An array of raw data objects.
75 | */
76 | async listUntil(shouldContinue, sort) {
77 | return await this.#wrapper.http().listUntil("/alerts", shouldContinue, sort);
78 | }
79 |
80 | /** Mark unread alerts as read. */
81 | async markAsRead() {
82 | return await this.#wrapper.http().patch("/alerts", { read: true });
83 | }
84 | }
85 |
86 | exports.AlertsHelper = AlertsHelper;
87 |
88 |
89 |
90 |
91 |
92 |
93 |