comic-vine-sdk 1.0.4 → 1.1.1

package/README.md

@@ -5,11 +5,11 @@ The Comic Vine SDK provides convenient access to the [Comic Vine API][comic-vine
 ## Table of Contents
 
 - [Installation](#installation)
-- [Browser Support](#browser-support)
 - [Roadmap](#roadmap)
 - [Comic Vine Resources](#comic-vine-resources)
 - [Usage/Examples](#usageexamples)
   - [Initialization](#initialization)
+  - [Options](#options)
   - [Fetch a single resource](#fetch-a-single-resource)
   - [Fetch a resource list](#fetch-a-resource-list)
   - [Limit the fields in the response payload](#limit-the-fields-in-the-response-payload)
@@ -27,18 +27,12 @@ npm install comic-vine-sdk
 yarn add comic-vine-sdk
 ```
 
-## Browser support
-
-This package does not currently work in a web browser, the Comic Vine API does not allow [cross-origin](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) requests. The recommended approach would be to use it server side, however, in a future update an option to set the baseUrl will be added. This option could be used to proxy the request assuming you have some safe way for the web client to fetch your api key, you don't want to send the api key to the browser in your JS bundle.
-
 ## TypeScript Typings
 
 There's a good change you may find an issue with the typings in the API response objects. They were generated using sample data from the API, if you find a problem [open an issue](https://github.com/AllyMurray/comic-vine/issues/new) detailing the problem along with the request details so I can add that request to the sample dataset. While you wait for it to be fixed add `// @ts-expect-error` above the line causing the problem. This will allow you to compile in the meantime but will flag when the problem has been fixed.
 
 ## Roadmap
 
-- Add option to set baseUrl when initializing the library
-
 - Automatic Pagination
 
 - Expandable responses
@@ -109,6 +103,42 @@ const comicVine = new ComicVine('your-api-key-here');
 })();
 ```
 
+### Options
+
+The second parameter of the constructor accepts options to configure the library
+
+```js
+new ComicVine('your-api-key-here', options);
+```
+
+### `baseUrl`
+
+**Type: <code>string | undefined</code>**
+
+**Default: https://comicvine.gamespot.com/api/**
+
+If using the package in node then leave this as the default value. The Comic Vine API does not allow [cross-origin](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) requests. This option could be used to proxy the request assuming you have some safe way for the web client to fetch your api key, you don't want to send the api key to the browser in your JS bundle.
+
+```js
+import ComicVine from 'comic-vine-sdk';
+
+// This is just an example, to try it out you would
+// have to visit (https://cors-anywhere.herokuapp.com)
+// to request temporary access.
+const comicVine = new ComicVine('your-api-key-here', {
+  baseUrl: 'https://cors-anywhere.herokuapp.com/https://www.comicvine.com/api/',
+});
+
+(async () => {
+  try {
+    const publisher = await comicVine.publisher.retrieve(1859);
+    console.log(publisher.name);
+  } catch (error) {
+    console.error(error);
+  }
+})();
+```
+
 ### Fetch a single resource
 
 All resources have a retrieve method, the following example retrieves a publisher

package/dist/cjs/comic-vine.d.ts

@@ -1,3 +1,4 @@
+import { userOptions } from './options';
 export declare class ComicVine {
     private _character;
     private _concept;
@@ -18,7 +19,7 @@ export declare class ComicVine {
     private _videoCategory;
     private _videoType;
     private _volume;
-    constructor(key: string);
+    constructor(key: string, options?: userOptions);
     get character(): import("./resources/character").Character;
     get concept(): import("./resources/concept").Concept;
     get episode(): import("./resources/episode").Episode;

package/dist/cjs/comic-vine.js

@@ -1,12 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ComicVine = void 0;
+const options_1 = require("./options");
 const http_client_1 = require("./http-client");
 const resources_1 = require("./resources");
 class ComicVine {
-    constructor(key) {
+    constructor(key, options) {
+        const _options = (0, options_1.loadOptions)(options);
         const httpClient = http_client_1.HttpClientFactory.createClient();
-        const urlBuilder = http_client_1.HttpClientFactory.createUrlBuilder(key);
+        const urlBuilder = http_client_1.HttpClientFactory.createUrlBuilder(key, _options.baseUrl);
         const resourceFactory = new resources_1.ResourceFactory(httpClient, urlBuilder);
         this._character = resourceFactory.create('Character');
         this._concept = resourceFactory.create('Concept');

package/dist/cjs/comic-vine.js.map

@@ -1 +1 @@
-{"version":3,"file":"comic-vine.js","sourceRoot":"","sources":["../../src/comic-vine.ts"],"names":[],"mappings":";;;AAAA,+CAAkD;AAClD,2CAA8C;AAE9C,MAAa,SAAS;IAqBpB,YAAY,GAAW;QACrB,MAAM,UAAU,GAAG,+BAAiB,CAAC,YAAY,EAAE,CAAC;QACpD,MAAM,UAAU,GAAG,+BAAiB,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;QAC3D,MAAM,eAAe,GAAG,IAAI,2BAAe,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;QAEpE,IAAI,CAAC,UAAU,GAAG,eAAe,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACtD,IAAI,CAAC,QAAQ,GAAG,eAAe,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClD,IAAI,CAAC,QAAQ,GAAG,eAAe,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClD,IAAI,CAAC,MAAM,GAAG,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC9C,IAAI,CAAC,SAAS,GAAG,eAAe,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QACpD,IAAI,CAAC,MAAM,GAAG,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC9C,IAAI,CAAC,OAAO,GAAG,eAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAChD,IAAI,CAAC,OAAO,GAAG,eAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAChD,IAAI,CAAC,MAAM,GAAG,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC9C,IAAI,CAAC,MAAM,GAAG,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC9C,IAAI,CAAC,UAAU,GAAG,eAAe,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACtD,IAAI,CAAC,OAAO,GAAG,eAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAChD,IAAI,CAAC,SAAS,GAAG,eAAe,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QACpD,IAAI,CAAC,KAAK,GAAG,eAAe,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,GAAG,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC9C,IAAI,CAAC,MAAM,GAAG,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC9C,IAAI,CAAC,cAAc,GAAG,eAAe,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;QAC9D,IAAI,CAAC,UAAU,GAAG,eAAe,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACtD,IAAI,CAAC,OAAO,GAAG,eAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAClD,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;CACF;AA1HD,8BA0HC"}
+{"version":3,"file":"comic-vine.js","sourceRoot":"","sources":["../../src/comic-vine.ts"],"names":[],"mappings":";;;AAAA,uCAAqD;AACrD,+CAAkD;AAClD,2CAA8C;AAE9C,MAAa,SAAS;IAqBpB,YAAY,GAAW,EAAE,OAAqB;QAC5C,MAAM,QAAQ,GAAG,IAAA,qBAAW,EAAC,OAAO,CAAC,CAAC;QACtC,MAAM,UAAU,GAAG,+BAAiB,CAAC,YAAY,EAAE,CAAC;QACpD,MAAM,UAAU,GAAG,+BAAiB,CAAC,gBAAgB,CACnD,GAAG,EACH,QAAQ,CAAC,OAAO,CACjB,CAAC;QACF,MAAM,eAAe,GAAG,IAAI,2BAAe,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;QAEpE,IAAI,CAAC,UAAU,GAAG,eAAe,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACtD,IAAI,CAAC,QAAQ,GAAG,eAAe,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClD,IAAI,CAAC,QAAQ,GAAG,eAAe,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClD,IAAI,CAAC,MAAM,GAAG,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC9C,IAAI,CAAC,SAAS,GAAG,eAAe,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QACpD,IAAI,CAAC,MAAM,GAAG,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC9C,IAAI,CAAC,OAAO,GAAG,eAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAChD,IAAI,CAAC,OAAO,GAAG,eAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAChD,IAAI,CAAC,MAAM,GAAG,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC9C,IAAI,CAAC,MAAM,GAAG,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC9C,IAAI,CAAC,UAAU,GAAG,eAAe,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACtD,IAAI,CAAC,OAAO,GAAG,eAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAChD,IAAI,CAAC,SAAS,GAAG,eAAe,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QACpD,IAAI,CAAC,KAAK,GAAG,eAAe,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,GAAG,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC9C,IAAI,CAAC,MAAM,GAAG,eAAe,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC9C,IAAI,CAAC,cAAc,GAAG,eAAe,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;QAC9D,IAAI,CAAC,UAAU,GAAG,eAAe,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACtD,IAAI,CAAC,OAAO,GAAG,eAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAClD,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;CACF;AA9HD,8BA8HC"}

package/dist/cjs/errors/{comic-vine-error.d.ts → base-error.d.ts}

@@ -2,7 +2,7 @@ interface ErrorDetails {
     message: string;
     help: string;
 }
-export declare abstract class ComicVineError extends Error {
+export declare abstract class BaseError extends Error {
     help: string;
     constructor(details: ErrorDetails);
 }

package/dist/cjs/errors/{comic-vine-error.js → base-error.js}

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ComicVineError = void 0;
-class ComicVineError extends Error {
+exports.BaseError = void 0;
+class BaseError extends Error {
     constructor(details) {
         super(details.message);
         this.name = this.constructor.name;
@@ -11,5 +11,5 @@ class ComicVineError extends Error {
         this.help = details.help;
     }
 }
-exports.ComicVineError = ComicVineError;
-//# sourceMappingURL=comic-vine-error.js.map
+exports.BaseError = BaseError;
+//# sourceMappingURL=base-error.js.map

package/dist/cjs/errors/base-error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-error.js","sourceRoot":"","sources":["../../../src/errors/base-error.ts"],"names":[],"mappings":";;;AAKA,MAAsB,SAAU,SAAQ,KAAK;IAG3C,YAAY,OAAqB;QAE/B,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACvB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;QAGlC,IAAI,KAAK,CAAC,iBAAiB,EAAE;YAC3B,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;SACjD;QAGD,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAC3B,CAAC;CACF;AAhBD,8BAgBC"}

package/dist/cjs/errors/custom-error.d.ts

@@ -0,0 +1,2 @@
+import { GenericError } from './generic-error';
+export declare const customError: (error: unknown) => GenericError;

package/dist/cjs/errors/custom-error.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.customError = void 0;
+const generic_error_1 = require("./generic-error");
+const customError = (error) => {
+    if (error instanceof Error) {
+        return new generic_error_1.GenericError(error.message);
+    }
+    return new generic_error_1.GenericError();
+};
+exports.customError = customError;
+//# sourceMappingURL=custom-error.js.map

package/dist/cjs/errors/custom-error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-error.js","sourceRoot":"","sources":["../../../src/errors/custom-error.ts"],"names":[],"mappings":";;;AAAA,mDAA+C;AAExC,MAAM,WAAW,GAAG,CAAC,KAAc,EAAE,EAAE;IAC5C,IAAI,KAAK,YAAY,KAAK,EAAE;QAC1B,OAAO,IAAI,4BAAY,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;KACxC;IACD,OAAO,IAAI,4BAAY,EAAE,CAAC;AAC5B,CAAC,CAAC;AALW,QAAA,WAAW,eAKtB"}

package/dist/cjs/errors/filter-error.d.ts

@@ -1,4 +1,4 @@
-import { ComicVineError } from './comic-vine-error';
-export declare class ComicVineFilterError extends ComicVineError {
+import { BaseError } from './base-error';
+export declare class ComicVineFilterError extends BaseError {
     constructor();
 }

package/dist/cjs/errors/filter-error.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ComicVineFilterError = void 0;
-const comic_vine_error_1 = require("./comic-vine-error");
-class ComicVineFilterError extends comic_vine_error_1.ComicVineError {
+const base_error_1 = require("./base-error");
+class ComicVineFilterError extends base_error_1.BaseError {
     constructor() {
         super({
             message: 'There was a problem trying to filter the API results',

package/dist/cjs/errors/filter-error.js.map

@@ -1 +1 @@
-{"version":3,"file":"filter-error.js","sourceRoot":"","sources":["../../../src/errors/filter-error.ts"],"names":[],"mappings":";;;AAAA,yDAAoD;AAEpD,MAAa,oBAAqB,SAAQ,iCAAc;IACtD;QACE,KAAK,CAAC;YACJ,OAAO,EAAE,sDAAsD;YAC/D,IAAI,EAAE,qGAAqG;SAC5G,CAAC,CAAC;IACL,CAAC;CACF;AAPD,oDAOC"}
+{"version":3,"file":"filter-error.js","sourceRoot":"","sources":["../../../src/errors/filter-error.ts"],"names":[],"mappings":";;;AAAA,6CAAyC;AAEzC,MAAa,oBAAqB,SAAQ,sBAAS;IACjD;QACE,KAAK,CAAC;YACJ,OAAO,EAAE,sDAAsD;YAC/D,IAAI,EAAE,qGAAqG;SAC5G,CAAC,CAAC;IACL,CAAC;CACF;AAPD,oDAOC"}

package/dist/cjs/errors/generic-error.d.ts

@@ -1,4 +1,4 @@
-import { ComicVineError } from './comic-vine-error';
-export declare class ComicVineGenericError extends ComicVineError {
+import { BaseError } from './base-error';
+export declare class GenericError extends BaseError {
     constructor(message?: string);
 }

package/dist/cjs/errors/generic-error.js

@@ -1,14 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ComicVineGenericError = void 0;
-const comic_vine_error_1 = require("./comic-vine-error");
-class ComicVineGenericError extends comic_vine_error_1.ComicVineError {
+exports.GenericError = void 0;
+const base_error_1 = require("./base-error");
+class GenericError extends base_error_1.BaseError {
     constructor(message) {
         super({
-            message: `Request to comic vine failed: ${message !== null && message !== void 0 ? message : 'Unknown Error'}`,
+            message: `An unexpected error occurred: ${message || 'Unknown Error'}`,
             help: 'Please open a Github issue with steps to reproduce: https://github.com/AllyMurray/comic-vine/issues',
         });
     }
 }
-exports.ComicVineGenericError = ComicVineGenericError;
+exports.GenericError = GenericError;
 //# sourceMappingURL=generic-error.js.map

package/dist/cjs/errors/generic-error.js.map

@@ -1 +1 @@
-{"version":3,"file":"generic-error.js","sourceRoot":"","sources":["../../../src/errors/generic-error.ts"],"names":[],"mappings":";;;AAAA,yDAAoD;AAEpD,MAAa,qBAAsB,SAAQ,iCAAc;IACvD,YAAY,OAAgB;QAC1B,KAAK,CAAC;YACJ,OAAO,EAAE,iCAAiC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,eAAe,EAAE;YACtE,IAAI,EAAE,qGAAqG;SAC5G,CAAC,CAAC;IACL,CAAC;CACF;AAPD,sDAOC"}
+{"version":3,"file":"generic-error.js","sourceRoot":"","sources":["../../../src/errors/generic-error.ts"],"names":[],"mappings":";;;AAAA,6CAAyC;AAEzC,MAAa,YAAa,SAAQ,sBAAS;IACzC,YAAY,OAAgB;QAC1B,KAAK,CAAC;YACJ,OAAO,EAAE,iCAAiC,OAAO,IAAI,eAAe,EAAE;YACtE,IAAI,EAAE,qGAAqG;SAC5G,CAAC,CAAC;IACL,CAAC;CACF;AAPD,oCAOC"}

package/dist/cjs/errors/generic-request-error.d.ts

@@ -0,0 +1,7 @@
+import { BaseError } from './base-error';
+export declare class ComicVineGenericError extends BaseError {
+    constructor(message?: string);
+}
+export declare class ComicVineGenericRequestError extends ComicVineGenericError {
+    constructor(message?: string);
+}

package/dist/cjs/errors/generic-request-error.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ComicVineGenericRequestError = exports.ComicVineGenericError = void 0;
+const base_error_1 = require("./base-error");
+class ComicVineGenericError extends base_error_1.BaseError {
+    constructor(message) {
+        super({
+            message: `Request to comic vine failed: ${message !== null && message !== void 0 ? message : 'Unknown Error'}`,
+            help: 'Please open a Github issue with steps to reproduce: https://github.com/AllyMurray/comic-vine/issues',
+        });
+    }
+}
+exports.ComicVineGenericError = ComicVineGenericError;
+class ComicVineGenericRequestError extends ComicVineGenericError {
+    constructor(message) {
+        super(message);
+    }
+}
+exports.ComicVineGenericRequestError = ComicVineGenericRequestError;
+//# sourceMappingURL=generic-request-error.js.map

package/dist/cjs/errors/generic-request-error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generic-request-error.js","sourceRoot":"","sources":["../../../src/errors/generic-request-error.ts"],"names":[],"mappings":";;;AAAA,6CAAyC;AAKzC,MAAa,qBAAsB,SAAQ,sBAAS;IAClD,YAAY,OAAgB;QAC1B,KAAK,CAAC;YACJ,OAAO,EAAE,iCAAiC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,eAAe,EAAE;YACtE,IAAI,EAAE,qGAAqG;SAC5G,CAAC,CAAC;IACL,CAAC;CACF;AAPD,sDAOC;AAED,MAAa,4BAA6B,SAAQ,qBAAqB;IACrE,YAAY,OAAgB;QAC1B,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;CACF;AAJD,oEAIC"}

package/dist/cjs/errors/index.d.ts

@@ -1,7 +1,10 @@
+export * from './custom-error';
 export * from './filter-error';
 export * from './generic-error';
+export * from './generic-request-error';
 export * from './jsonp-callback-missing-error';
 export * from './object-not-found-error';
+export * from './options-validation-error';
 export * from './subscriber-only-error';
 export * from './unauthorized-error';
 export * from './url-format-error';

package/dist/cjs/errors/index.js

@@ -14,10 +14,13 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./custom-error"), exports);
 __exportStar(require("./filter-error"), exports);
 __exportStar(require("./generic-error"), exports);
+__exportStar(require("./generic-request-error"), exports);
 __exportStar(require("./jsonp-callback-missing-error"), exports);
 __exportStar(require("./object-not-found-error"), exports);
+__exportStar(require("./options-validation-error"), exports);
 __exportStar(require("./subscriber-only-error"), exports);
 __exportStar(require("./unauthorized-error"), exports);
 __exportStar(require("./url-format-error"), exports);

package/dist/cjs/errors/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/errors/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iDAA+B;AAC/B,kDAAgC;AAChC,iEAA+C;AAC/C,2DAAyC;AACzC,0DAAwC;AACxC,uDAAqC;AACrC,qDAAmC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/errors/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iDAA+B;AAC/B,iDAA+B;AAC/B,kDAAgC;AAChC,0DAAwC;AACxC,iEAA+C;AAC/C,2DAAyC;AACzC,6DAA2C;AAC3C,0DAAwC;AACxC,uDAAqC;AACrC,qDAAmC"}

package/dist/cjs/errors/jsonp-callback-missing-error.d.ts

@@ -1,4 +1,4 @@
-import { ComicVineError } from './comic-vine-error';
-export declare class ComicJsonpCallbackMissingError extends ComicVineError {
+import { BaseError } from './base-error';
+export declare class ComicJsonpCallbackMissingError extends BaseError {
     constructor();
 }

package/dist/cjs/errors/jsonp-callback-missing-error.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ComicJsonpCallbackMissingError = void 0;
-const comic_vine_error_1 = require("./comic-vine-error");
-class ComicJsonpCallbackMissingError extends comic_vine_error_1.ComicVineError {
+const base_error_1 = require("./base-error");
+class ComicJsonpCallbackMissingError extends base_error_1.BaseError {
     constructor() {
         super({
             message: 'JSONP format requires a callback',

package/dist/cjs/errors/jsonp-callback-missing-error.js.map

@@ -1 +1 @@
-{"version":3,"file":"jsonp-callback-missing-error.js","sourceRoot":"","sources":["../../../src/errors/jsonp-callback-missing-error.ts"],"names":[],"mappings":";;;AAAA,yDAAoD;AAEpD,MAAa,8BAA+B,SAAQ,iCAAc;IAChE;QACE,KAAK,CAAC;YACJ,OAAO,EAAE,kCAAkC;YAC3C,IAAI,EAAE,sIAAsI;SAC7I,CAAC,CAAC;IACL,CAAC;CACF;AAPD,wEAOC"}
+{"version":3,"file":"jsonp-callback-missing-error.js","sourceRoot":"","sources":["../../../src/errors/jsonp-callback-missing-error.ts"],"names":[],"mappings":";;;AAAA,6CAAyC;AAEzC,MAAa,8BAA+B,SAAQ,sBAAS;IAC3D;QACE,KAAK,CAAC;YACJ,OAAO,EAAE,kCAAkC;YAC3C,IAAI,EAAE,sIAAsI;SAC7I,CAAC,CAAC;IACL,CAAC;CACF;AAPD,wEAOC"}

package/dist/cjs/errors/object-not-found-error.d.ts

@@ -1,4 +1,4 @@
-import { ComicVineError } from './comic-vine-error';
-export declare class ComicVineObjectNotFoundError extends ComicVineError {
+import { BaseError } from './base-error';
+export declare class ComicVineObjectNotFoundError extends BaseError {
     constructor();
 }

package/dist/cjs/errors/object-not-found-error.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ComicVineObjectNotFoundError = void 0;
-const comic_vine_error_1 = require("./comic-vine-error");
-class ComicVineObjectNotFoundError extends comic_vine_error_1.ComicVineError {
+const base_error_1 = require("./base-error");
+class ComicVineObjectNotFoundError extends base_error_1.BaseError {
     constructor() {
         super({
             message: 'The requested resource could not be found in the Comic Vine API',

package/dist/cjs/errors/object-not-found-error.js.map

@@ -1 +1 @@
-{"version":3,"file":"object-not-found-error.js","sourceRoot":"","sources":["../../../src/errors/object-not-found-error.ts"],"names":[],"mappings":";;;AAAA,yDAAoD;AAEpD,MAAa,4BAA6B,SAAQ,iCAAc;IAC9D;QACE,KAAK,CAAC;YACJ,OAAO,EACL,iEAAiE;YACnE,IAAI,EAAE,0CAA0C;SACjD,CAAC,CAAC;IACL,CAAC;CACF;AARD,oEAQC"}
+{"version":3,"file":"object-not-found-error.js","sourceRoot":"","sources":["../../../src/errors/object-not-found-error.ts"],"names":[],"mappings":";;;AAAA,6CAAyC;AAEzC,MAAa,4BAA6B,SAAQ,sBAAS;IACzD;QACE,KAAK,CAAC;YACJ,OAAO,EACL,iEAAiE;YACnE,IAAI,EAAE,0CAA0C;SACjD,CAAC,CAAC;IACL,CAAC;CACF;AARD,oEAQC"}

package/dist/cjs/errors/options-validation-error.d.ts

@@ -0,0 +1,4 @@
+import { BaseError } from './base-error';
+export declare class OptionsValidationError extends BaseError {
+    constructor(path: Array<string | number>, message: string);
+}

package/dist/cjs/errors/options-validation-error.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OptionsValidationError = void 0;
+const base_error_1 = require("./base-error");
+class OptionsValidationError extends base_error_1.BaseError {
+    constructor(path, message) {
+        super({
+            message: `Property: ${path.join('.')}, Problem: ${message}`,
+            help: 'If the error message does not provide enough information or you believe there is a bug, please open a Github issue with steps to reproduce: https://github.com/AllyMurray/comic-vine/issues',
+        });
+    }
+}
+exports.OptionsValidationError = OptionsValidationError;
+//# sourceMappingURL=options-validation-error.js.map

package/dist/cjs/errors/options-validation-error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"options-validation-error.js","sourceRoot":"","sources":["../../../src/errors/options-validation-error.ts"],"names":[],"mappings":";;;AAAA,6CAAyC;AAEzC,MAAa,sBAAuB,SAAQ,sBAAS;IACnD,YAAY,IAA4B,EAAE,OAAe;QACvD,KAAK,CAAC;YACJ,OAAO,EAAE,aAAa,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,cAAc,OAAO,EAAE;YAC3D,IAAI,EAAE,6LAA6L;SACpM,CAAC,CAAC;IACL,CAAC;CACF;AAPD,wDAOC"}

package/dist/cjs/errors/subscriber-only-error.d.ts

@@ -1,4 +1,4 @@
-import { ComicVineError } from './comic-vine-error';
-export declare class ComicVineSubscriberOnlyError extends ComicVineError {
+import { BaseError } from './base-error';
+export declare class ComicVineSubscriberOnlyError extends BaseError {
     constructor();
 }

package/dist/cjs/errors/subscriber-only-error.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ComicVineSubscriberOnlyError = void 0;
-const comic_vine_error_1 = require("./comic-vine-error");
-class ComicVineSubscriberOnlyError extends comic_vine_error_1.ComicVineError {
+const base_error_1 = require("./base-error");
+class ComicVineSubscriberOnlyError extends base_error_1.BaseError {
     constructor() {
         super({
             message: 'The requested video is for subscribers only',

package/dist/cjs/errors/subscriber-only-error.js.map

@@ -1 +1 @@
-{"version":3,"file":"subscriber-only-error.js","sourceRoot":"","sources":["../../../src/errors/subscriber-only-error.ts"],"names":[],"mappings":";;;AAAA,yDAAoD;AAEpD,MAAa,4BAA6B,SAAQ,iCAAc;IAC9D;QACE,KAAK,CAAC;YACJ,OAAO,EAAE,6CAA6C;YACtD,IAAI,EAAE,kIAAkI;SACzI,CAAC,CAAC;IACL,CAAC;CACF;AAPD,oEAOC"}
+{"version":3,"file":"subscriber-only-error.js","sourceRoot":"","sources":["../../../src/errors/subscriber-only-error.ts"],"names":[],"mappings":";;;AAAA,6CAAyC;AAEzC,MAAa,4BAA6B,SAAQ,sBAAS;IACzD;QACE,KAAK,CAAC;YACJ,OAAO,EAAE,6CAA6C;YACtD,IAAI,EAAE,kIAAkI;SACzI,CAAC,CAAC;IACL,CAAC;CACF;AAPD,oEAOC"}

package/dist/cjs/errors/unauthorized-error.d.ts

@@ -1,4 +1,4 @@
-import { ComicVineError } from './comic-vine-error';
-export declare class ComicVineUnauthorizedError extends ComicVineError {
+import { BaseError } from './base-error';
+export declare class ComicVineUnauthorizedError extends BaseError {
     constructor();
 }

package/dist/cjs/errors/unauthorized-error.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ComicVineUnauthorizedError = void 0;
-const comic_vine_error_1 = require("./comic-vine-error");
-class ComicVineUnauthorizedError extends comic_vine_error_1.ComicVineError {
+const base_error_1 = require("./base-error");
+class ComicVineUnauthorizedError extends base_error_1.BaseError {
     constructor() {
         super({
             message: 'Unauthorized response received when calling the Comic Vine API',

package/dist/cjs/errors/unauthorized-error.js.map

@@ -1 +1 @@
-{"version":3,"file":"unauthorized-error.js","sourceRoot":"","sources":["../../../src/errors/unauthorized-error.ts"],"names":[],"mappings":";;;AAAA,yDAAoD;AAEpD,MAAa,0BAA2B,SAAQ,iCAAc;IAC5D;QACE,KAAK,CAAC;YACJ,OAAO,EAAE,gEAAgE;YACzE,IAAI,EAAE,4FAA4F;SACnG,CAAC,CAAC;IACL,CAAC;CACF;AAPD,gEAOC"}
+{"version":3,"file":"unauthorized-error.js","sourceRoot":"","sources":["../../../src/errors/unauthorized-error.ts"],"names":[],"mappings":";;;AAAA,6CAAyC;AAEzC,MAAa,0BAA2B,SAAQ,sBAAS;IACvD;QACE,KAAK,CAAC;YACJ,OAAO,EAAE,gEAAgE;YACzE,IAAI,EAAE,4FAA4F;SACnG,CAAC,CAAC;IACL,CAAC;CACF;AAPD,gEAOC"}

package/dist/cjs/errors/url-format-error.d.ts

@@ -1,4 +1,4 @@
-import { ComicVineError } from './comic-vine-error';
-export declare class ComicVineUrlFormatError extends ComicVineError {
+import { BaseError } from './base-error';
+export declare class ComicVineUrlFormatError extends BaseError {
     constructor();
 }

package/dist/cjs/errors/url-format-error.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ComicVineUrlFormatError = void 0;
-const comic_vine_error_1 = require("./comic-vine-error");
-class ComicVineUrlFormatError extends comic_vine_error_1.ComicVineError {
+const base_error_1 = require("./base-error");
+class ComicVineUrlFormatError extends base_error_1.BaseError {
     constructor() {
         super({
             message: 'The url for the request was not in the correct format',

package/dist/cjs/errors/url-format-error.js.map

@@ -1 +1 @@
-{"version":3,"file":"url-format-error.js","sourceRoot":"","sources":["../../../src/errors/url-format-error.ts"],"names":[],"mappings":";;;AAAA,yDAAoD;AAEpD,MAAa,uBAAwB,SAAQ,iCAAc;IACzD;QACE,KAAK,CAAC;YACJ,OAAO,EAAE,uDAAuD;YAChE,IAAI,EAAE,qGAAqG;SAC5G,CAAC,CAAC;IACL,CAAC;CACF;AAPD,0DAOC"}
+{"version":3,"file":"url-format-error.js","sourceRoot":"","sources":["../../../src/errors/url-format-error.ts"],"names":[],"mappings":";;;AAAA,6CAAyC;AAEzC,MAAa,uBAAwB,SAAQ,sBAAS;IACpD;QACE,KAAK,CAAC;YACJ,OAAO,EAAE,uDAAuD;YAChE,IAAI,EAAE,qGAAqG;SAC5G,CAAC,CAAC;IACL,CAAC;CACF;AAPD,0DAOC"}

package/dist/cjs/http-client/http-client-factory.d.ts

@@ -2,5 +2,5 @@ import { HttpClient } from './http-client';
 import { UrlBuilder } from './url-builder';
 export declare class HttpClientFactory {
     static createClient(): HttpClient;
-    static createUrlBuilder(apiKey: string): UrlBuilder;
+    static createUrlBuilder(apiKey: string, baseUrl: string): UrlBuilder;
 }

package/dist/cjs/http-client/http-client-factory.js

@@ -7,8 +7,8 @@ class HttpClientFactory {
     static createClient() {
         return new http_client_1.HttpClient();
     }
-    static createUrlBuilder(apiKey) {
-        return new url_builder_1.UrlBuilder(apiKey);
+    static createUrlBuilder(apiKey, baseUrl) {
+        return new url_builder_1.UrlBuilder(apiKey, baseUrl);
     }
 }
 exports.HttpClientFactory = HttpClientFactory;

package/dist/cjs/http-client/http-client-factory.js.map

@@ -1 +1 @@
-{"version":3,"file":"http-client-factory.js","sourceRoot":"","sources":["../../../src/http-client/http-client-factory.ts"],"names":[],"mappings":";;;AAAA,+CAA2C;AAC3C,+CAA2C;AAE3C,MAAa,iBAAiB;IACrB,MAAM,CAAC,YAAY;QACxB,OAAO,IAAI,wBAAU,EAAE,CAAC;IAC1B,CAAC;IAEM,MAAM,CAAC,gBAAgB,CAAC,MAAc;QAC3C,OAAO,IAAI,wBAAU,CAAC,MAAM,CAAC,CAAC;IAChC,CAAC;CACF;AARD,8CAQC"}
+{"version":3,"file":"http-client-factory.js","sourceRoot":"","sources":["../../../src/http-client/http-client-factory.ts"],"names":[],"mappings":";;;AAAA,+CAA2C;AAC3C,+CAA2C;AAE3C,MAAa,iBAAiB;IACrB,MAAM,CAAC,YAAY;QACxB,OAAO,IAAI,wBAAU,EAAE,CAAC;IAC1B,CAAC;IAEM,MAAM,CAAC,gBAAgB,CAAC,MAAc,EAAE,OAAe;QAC5D,OAAO,IAAI,wBAAU,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACzC,CAAC;CACF;AARD,8CAQC"}

package/dist/cjs/http-client/http-client.js

@@ -17,7 +17,7 @@ const axios_1 = __importDefault(require("axios"));
 const utils_1 = require("../utils");
 const status_code_1 = require("./status-code");
 const errors_1 = require("../errors");
-const comic_vine_error_1 = require("../errors/comic-vine-error");
+const base_error_1 = require("../errors/base-error");
 class HttpClient {
     constructor() {
         this._http = axios_1.default.create({
@@ -44,7 +44,7 @@ class HttpClient {
     }
     generateClientError(err) {
         var _a, _b, _c;
-        if (err instanceof comic_vine_error_1.ComicVineError) {
+        if (err instanceof base_error_1.BaseError) {
             return err;
         }
         const error = err;
@@ -52,7 +52,7 @@ class HttpClient {
             return new errors_1.ComicVineUnauthorizedError();
         }
         const errorMessage = (_c = (_b = error.response) === null || _b === void 0 ? void 0 : _b.data) === null || _c === void 0 ? void 0 : _c.message;
-        return new errors_1.ComicVineGenericError(`${error.message}${errorMessage ? `, ${errorMessage}` : ''}`);
+        return new errors_1.ComicVineGenericRequestError(`${error.message}${errorMessage ? `, ${errorMessage}` : ''}`);
     }
     get(url) {
         return __awaiter(this, void 0, void 0, function* () {

package/dist/cjs/http-client/http-client.js.map

@@ -1 +1 @@
-{"version":3,"file":"http-client.js","sourceRoot":"","sources":["../../../src/http-client/http-client.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,kDAAyD;AAEzD,oCAAuD;AACvD,+CAA2C;AAC3C,sCAQmB;AACnB,iEAA4D;AAE5D,MAAa,UAAU;IAGrB;QACE,IAAI,CAAC,KAAK,GAAG,eAAK,CAAC,MAAM,CAAC;YACxB,iBAAiB,EAAE,CAAC,IAAS,EAAE,EAAE;gBAC/B,OAAO,IAAI,CAAC,CAAC,CAAC,IAAA,mCAA2B,EAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1E,CAAC;SACF,CAAC,CAAC;IACL,CAAC;IAEO,cAAc,CAAS,QAAyC;QACtE,QAAQ,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE;YAChC,KAAK,wBAAU,CAAC,WAAW;gBACzB,MAAM,IAAI,6BAAoB,EAAE,CAAC;YACnC,KAAK,wBAAU,CAAC,oBAAoB;gBAClC,MAAM,IAAI,uCAA8B,EAAE,CAAC;YAC7C,KAAK,wBAAU,CAAC,cAAc;gBAC5B,MAAM,IAAI,qCAA4B,EAAE,CAAC;YAC3C,KAAK,wBAAU,CAAC,mBAAmB;gBACjC,MAAM,IAAI,qCAA4B,EAAE,CAAC;YAC3C,KAAK,wBAAU,CAAC,cAAc;gBAC5B,MAAM,IAAI,gCAAuB,EAAE,CAAC;YACtC;gBACE,OAAO,QAAQ,CAAC,IAAI,CAAC;SACxB;IACH,CAAC;IAEO,mBAAmB,CAAC,GAAQ;;QAClC,IAAI,GAAG,YAAY,iCAAc,EAAE;YACjC,OAAO,GAAG,CAAC;SACZ;QAED,MAAM,KAAK,GAAG,GAAsB,CAAC;QACrC,IAAI,CAAA,MAAA,KAAK,CAAC,QAAQ,0CAAE,MAAM,MAAK,GAAG,EAAE;YAClC,OAAO,IAAI,mCAA0B,EAAE,CAAC;SACzC;QAED,MAAM,YAAY,GAAG,MAAA,MAAA,KAAK,CAAC,QAAQ,0CAAE,IAAI,0CAAE,OAAO,CAAC;QACnD,OAAO,IAAI,8BAAqB,CAC9B,GAAG,KAAK,CAAC,OAAO,GAAG,YAAY,CAAC,CAAC,CAAC,KAAK,YAAY,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAC7D,CAAC;IACJ,CAAC;IAEK,GAAG,CAAS,GAAW;;YAC3B,IAAI;gBACF,OAAO,IAAI,CAAC,cAAc,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAmB,GAAG,CAAC,CAAC,CAAC;aACzE;YAAC,OAAO,KAAK,EAAE;gBACd,MAAM,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;aACvC;QACH,CAAC;KAAA;CACF;AAnDD,gCAmDC"}
+{"version":3,"file":"http-client.js","sourceRoot":"","sources":["../../../src/http-client/http-client.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,kDAAyD;AAEzD,oCAAuD;AACvD,+CAA2C;AAC3C,sCAQmB;AACnB,qDAAiD;AAEjD,MAAa,UAAU;IAGrB;QACE,IAAI,CAAC,KAAK,GAAG,eAAK,CAAC,MAAM,CAAC;YACxB,iBAAiB,EAAE,CAAC,IAAS,EAAE,EAAE;gBAC/B,OAAO,IAAI,CAAC,CAAC,CAAC,IAAA,mCAA2B,EAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1E,CAAC;SACF,CAAC,CAAC;IACL,CAAC;IAEO,cAAc,CAAS,QAAyC;QACtE,QAAQ,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE;YAChC,KAAK,wBAAU,CAAC,WAAW;gBACzB,MAAM,IAAI,6BAAoB,EAAE,CAAC;YACnC,KAAK,wBAAU,CAAC,oBAAoB;gBAClC,MAAM,IAAI,uCAA8B,EAAE,CAAC;YAC7C,KAAK,wBAAU,CAAC,cAAc;gBAC5B,MAAM,IAAI,qCAA4B,EAAE,CAAC;YAC3C,KAAK,wBAAU,CAAC,mBAAmB;gBACjC,MAAM,IAAI,qCAA4B,EAAE,CAAC;YAC3C,KAAK,wBAAU,CAAC,cAAc;gBAC5B,MAAM,IAAI,gCAAuB,EAAE,CAAC;YACtC;gBACE,OAAO,QAAQ,CAAC,IAAI,CAAC;SACxB;IACH,CAAC;IAEO,mBAAmB,CAAC,GAAQ;;QAClC,IAAI,GAAG,YAAY,sBAAS,EAAE;YAC5B,OAAO,GAAG,CAAC;SACZ;QAED,MAAM,KAAK,GAAG,GAAsB,CAAC;QACrC,IAAI,CAAA,MAAA,KAAK,CAAC,QAAQ,0CAAE,MAAM,MAAK,GAAG,EAAE;YAClC,OAAO,IAAI,mCAA0B,EAAE,CAAC;SACzC;QAED,MAAM,YAAY,GAAG,MAAA,MAAA,KAAK,CAAC,QAAQ,0CAAE,IAAI,0CAAE,OAAO,CAAC;QACnD,OAAO,IAAI,qCAA4B,CACrC,GAAG,KAAK,CAAC,OAAO,GAAG,YAAY,CAAC,CAAC,CAAC,KAAK,YAAY,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAC7D,CAAC;IACJ,CAAC;IAEK,GAAG,CAAS,GAAW;;YAC3B,IAAI;gBACF,OAAO,IAAI,CAAC,cAAc,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAmB,GAAG,CAAC,CAAC,CAAC;aACzE;YAAC,OAAO,KAAK,EAAE;gBACd,MAAM,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;aACvC;QACH,CAAC;KAAA;CACF;AAnDD,gCAmDC"}

package/dist/cjs/http-client/url-builder.d.ts

@@ -3,7 +3,7 @@ import { RetrieveOptions, ListOptions } from '../types';
 export declare class UrlBuilder {
     private apiKey;
     private baseUrl;
-    constructor(apiKey: string);
+    constructor(apiKey: string, baseUrl: string);
     private getParam;
     private getFormatParm;
     private getApiKeyParm;

package/dist/cjs/http-client/url-builder.js

@@ -7,9 +7,9 @@ const isDefined = (value) => {
     return value != null;
 };
 class UrlBuilder {
-    constructor(apiKey) {
+    constructor(apiKey, baseUrl) {
         this.apiKey = apiKey;
-        this.baseUrl = 'https://comicvine.gamespot.com/api/';
+        this.baseUrl = baseUrl;
     }
     getParam(key, value) {
         if (value) {

package/dist/cjs/http-client/url-builder.js.map

@@ -1 +1 @@
-{"version":3,"file":"url-builder.js","sourceRoot":"","sources":["../../../src/http-client/url-builder.ts"],"names":[],"mappings":";;;AAAA,4CAAyD;AAEzD,oCAAoE;AAEpE,MAAM,SAAS,GAAG,CAAI,KAAQ,EAA2B,EAAE;IACzD,OAAO,KAAK,IAAI,IAAI,CAAC;AACvB,CAAC,CAAC;AAOF,MAAa,UAAU;IAGrB,YAAoB,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;QAF1B,YAAO,GAAG,qCAAqC,CAAC;IAEnB,CAAC;IAE9B,QAAQ,CAAC,GAAW,EAAE,KAAkC;QAC9D,IAAI,KAAK,EAAE;YACT,OAAO,EAAE,IAAI,EAAE,IAAA,mBAAW,EAAC,GAAG,CAAC,EAAE,KAAK,EAAE,CAAC;SAC1C;IACH,CAAC;IAEO,aAAa;QACnB,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;IAC3C,CAAC;IAEO,aAAa;QACnB,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;IACjD,CAAC;IAEO,YAAY,CAAC,IAAW;QAC9B,IAAI,IAAI,EAAE;YACR,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC;SACnE;IACH,CAAC;IAEO,aAAa,CAAC,KAAc;QAClC,IAAI,KAAK,EAAE;YACT,OAAO,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;SACtC;IACH,CAAC;IAEO,cAAc,CAAC,MAAe;QACpC,IAAI,MAAM,EAAE;YACV,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;SACxC;IACH,CAAC;IAEO,kBAAkB,CAAM,SAA4B;QAC1D,IAAI,SAAS,EAAE;YACb,OAAO;gBACL,IAAI,EAAE,YAAY;gBAClB,KAAK,EAAE,SAAS;qBACb,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAA,mBAAW,EAAC,KAA0B,CAAC,CAAC;qBACvD,IAAI,CAAC,GAAG,CAAC;aACb,CAAC;SACH;IACH,CAAC;IAEO,eAAe,CAAa,MAA8B;QAChE,IAAI,MAAM,EAAE;YACV,MAAM,eAAe,GAAG,IAAA,mCAA2B,EAAM,MAAM,CAAC,CAAC;YACjE,MAAM,YAAY,GAAG,MAAM,CAAC,OAAO,CAAM,eAAe,CAAC,CAAC,GAAG,CAC3D,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,KAAK,EAAE,CACpC,CAAC;YAEF,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;SAC1D;IACH,CAAC;IAEO,QAAQ,CACd,QAAgB,EAChB,WAA0C;QAE1C,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAC5C,MAAM,eAAe,GAAG,IAAI,eAAe,CACzC,WAAW;aACR,MAAM,CAAC,SAAS,CAAC;aACjB,GAAG,CAAmB,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAC1E,CAAC;QAEF,GAAG,CAAC,MAAM,GAAG,eAAe,CAAC,QAAQ,EAAE,CAAC;QAExC,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAC;IACxB,CAAC;IAQD,QAAQ,CACN,YAA0B,EAC1B,EAAU,EACV,OAA8B;QAE9B,MAAM,QAAQ,GAAG,IAAA,uBAAW,EAAC,YAAY,CAAC,CAAC;QAC3C,MAAM,QAAQ,GAAG,GAAG,QAAQ,CAAC,UAAU,IAAI,YAAY,IAAI,EAAE,EAAE,CAAC;QAChE,MAAM,WAAW,GAAG;YAClB,IAAI,CAAC,aAAa,EAAE;YACpB,IAAI,CAAC,aAAa,EAAE;YACpB,IAAI,CAAC,kBAAkB,CAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,CAAC;SAC5C,CAAC;QACF,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IAC9C,CAAC;IAOD,IAAI,CACF,YAA0B,EAC1B,OAA2C;QAE3C,MAAM,QAAQ,GAAG,IAAA,uBAAW,EAAC,YAAY,CAAC,CAAC,QAAQ,CAAC;QACpD,MAAM,WAAW,GAAG;YAClB,IAAI,CAAC,aAAa,EAAE;YACpB,IAAI,CAAC,aAAa,EAAE;YACpB,IAAI,CAAC,aAAa,CAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,CAAC;YAClC,IAAI,CAAC,cAAc,CAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,CAAC;YACpC,IAAI,CAAC,YAAY,CAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,CAAC;YAChC,IAAI,CAAC,kBAAkB,CAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,CAAC;YAC3C,IAAI,CAAC,eAAe,CAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,CAAC;SACtC,CAAC;QACF,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IAC9C,CAAC;CACF;AArHD,gCAqHC"}
+{"version":3,"file":"url-builder.js","sourceRoot":"","sources":["../../../src/http-client/url-builder.ts"],"names":[],"mappings":";;;AAAA,4CAAyD;AAEzD,oCAAoE;AAEpE,MAAM,SAAS,GAAG,CAAI,KAAQ,EAA2B,EAAE;IACzD,OAAO,KAAK,IAAI,IAAI,CAAC;AACvB,CAAC,CAAC;AAOF,MAAa,UAAU;IACrB,YAAoB,MAAc,EAAU,OAAe;QAAvC,WAAM,GAAN,MAAM,CAAQ;QAAU,YAAO,GAAP,OAAO,CAAQ;IAAG,CAAC;IAEvD,QAAQ,CAAC,GAAW,EAAE,KAAkC;QAC9D,IAAI,KAAK,EAAE;YACT,OAAO,EAAE,IAAI,EAAE,IAAA,mBAAW,EAAC,GAAG,CAAC,EAAE,KAAK,EAAE,CAAC;SAC1C;IACH,CAAC;IAEO,aAAa;QACnB,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;IAC3C,CAAC;IAEO,aAAa;QACnB,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;IACjD,CAAC;IAEO,YAAY,CAAC,IAAW;QAC9B,IAAI,IAAI,EAAE;YACR,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC;SACnE;IACH,CAAC;IAEO,aAAa,CAAC,KAAc;QAClC,IAAI,KAAK,EAAE;YACT,OAAO,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;SACtC;IACH,CAAC;IAEO,cAAc,CAAC,MAAe;QACpC,IAAI,MAAM,EAAE;YACV,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;SACxC;IACH,CAAC;IAEO,kBAAkB,CAAM,SAA4B;QAC1D,IAAI,SAAS,EAAE;YACb,OAAO;gBACL,IAAI,EAAE,YAAY;gBAClB,KAAK,EAAE,SAAS;qBACb,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAA,mBAAW,EAAC,KAA0B,CAAC,CAAC;qBACvD,IAAI,CAAC,GAAG,CAAC;aACb,CAAC;SACH;IACH,CAAC;IAEO,eAAe,CAAa,MAA8B;QAChE,IAAI,MAAM,EAAE;YACV,MAAM,eAAe,GAAG,IAAA,mCAA2B,EAAM,MAAM,CAAC,CAAC;YACjE,MAAM,YAAY,GAAG,MAAM,CAAC,OAAO,CAAM,eAAe,CAAC,CAAC,GAAG,CAC3D,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,KAAK,EAAE,CACpC,CAAC;YAEF,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;SAC1D;IACH,CAAC;IAEO,QAAQ,CACd,QAAgB,EAChB,WAA0C;QAE1C,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAC5C,MAAM,eAAe,GAAG,IAAI,eAAe,CACzC,WAAW;aACR,MAAM,CAAC,SAAS,CAAC;aACjB,GAAG,CAAmB,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAC1E,CAAC;QAEF,GAAG,CAAC,MAAM,GAAG,eAAe,CAAC,QAAQ,EAAE,CAAC;QAExC,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAC;IACxB,CAAC;IAQD,QAAQ,CACN,YAA0B,EAC1B,EAAU,EACV,OAA8B;QAE9B,MAAM,QAAQ,GAAG,IAAA,uBAAW,EAAC,YAAY,CAAC,CAAC;QAC3C,MAAM,QAAQ,GAAG,GAAG,QAAQ,CAAC,UAAU,IAAI,YAAY,IAAI,EAAE,EAAE,CAAC;QAChE,MAAM,WAAW,GAAG;YAClB,IAAI,CAAC,aAAa,EAAE;YACpB,IAAI,CAAC,aAAa,EAAE;YACpB,IAAI,CAAC,kBAAkB,CAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,CAAC;SAC5C,CAAC;QACF,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IAC9C,CAAC;IAOD,IAAI,CACF,YAA0B,EAC1B,OAA2C;QAE3C,MAAM,QAAQ,GAAG,IAAA,uBAAW,EAAC,YAAY,CAAC,CAAC,QAAQ,CAAC;QACpD,MAAM,WAAW,GAAG;YAClB,IAAI,CAAC,aAAa,EAAE;YACpB,IAAI,CAAC,aAAa,EAAE;YACpB,IAAI,CAAC,aAAa,CAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,CAAC;YAClC,IAAI,CAAC,cAAc,CAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,CAAC;YACpC,IAAI,CAAC,YAAY,CAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,CAAC;YAChC,IAAI,CAAC,kBAAkB,CAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,CAAC;YAC3C,IAAI,CAAC,eAAe,CAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,CAAC;SACtC,CAAC;QACF,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IAC9C,CAAC;CACF;AAnHD,gCAmHC"}

package/dist/cjs/options/index.d.ts

@@ -0,0 +1,16 @@
+import { z } from 'zod';
+declare const options: z.ZodObject<{
+    baseUrl: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    baseUrl: string;
+}, {
+    baseUrl?: string | undefined;
+}>;
+export declare type userOptions = z.input<typeof options>;
+export declare type Options = z.output<typeof options>;
+export declare const loadOptions: (userOptions?: {
+    baseUrl?: string | undefined;
+} | undefined) => {
+    baseUrl: string;
+};
+export {};

package/dist/cjs/options/index.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadOptions = void 0;
+const zod_1 = require("zod");
+const errors_1 = require("../errors");
+const options = zod_1.z.object({
+    baseUrl: zod_1.z
+        .string()
+        .url()
+        .optional()
+        .default('https://comicvine.gamespot.com/api/'),
+});
+const loadOptions = (userOptions) => {
+    try {
+        return options.parse(userOptions !== null && userOptions !== void 0 ? userOptions : {});
+    }
+    catch (error) {
+        if (error instanceof zod_1.ZodError) {
+            const validationError = error.issues[0];
+            throw new errors_1.OptionsValidationError(validationError.path, validationError.message);
+        }
+        throw (0, errors_1.customError)(error);
+    }
+};
+exports.loadOptions = loadOptions;
+//# sourceMappingURL=index.js.map