crisp-api 10.0.2 → 10.0.4

package/CHANGELOG.md

@@ -1,13 +1,17 @@
 Changelog
 =========
 
+## v10.0.3
+
+# Return missing type on website.listHelpdeskLocales
+
 ## v10.0.1
 
-* Routes supporting pagination can be used without page argument (page 1 by default)
+* Routes supporting pagination can be used without a page argument (page is set to `1` by default).
 
 ## v10.0.0
 
-* Typescript support (retrocompatible)
+* Added TypeScript support (retro-compatible).
 
 ## v9.13.0
 

package/dist/crisp.d.ts

@@ -1,25 +1,33 @@
 import { Socket } from "socket.io-client";
 import { Emitter } from "mitt";
-import Bucket from "./services/bucket";
-import Media from "./services/media";
-import Plugin from "./services/plugin";
+import { BucketServiceInterface } from "./services/bucket";
+import { MediaServiceInterface } from "./services/media";
+import { PluginServiceInterface } from "./services/plugin";
 import { WebsiteServiceInterface } from "./services/website";
-export * from "./resources";
+/**************************************************************************
+ * TYPES
+ ***************************************************************************/
 export type RTM_MODES = "websockets" | "webhooks";
+export type CrispTier = "user" | "plugin";
+/**************************************************************************
+ * INTERFACES
+ ***************************************************************************/
 interface CrispAuth {
     tier: CrispTier;
     identifier: string | null;
     key: string | null;
     token: string | null;
 }
-export type CrispTier = "user" | "plugin";
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
 /**
- * Crisp API Library
+ *
  */
 export declare class Crisp {
-    bucket: Bucket;
-    media: Media;
-    plugin: Plugin;
+    bucket: BucketServiceInterface;
+    media: MediaServiceInterface;
+    plugin: PluginServiceInterface;
     website: WebsiteServiceInterface;
     /**
      * @deprecated Use import { RTM_MODES } instead
@@ -29,22 +37,22 @@ export declare class Crisp {
         WebHooks: RTM_MODES;
     };
     auth: CrispAuth;
-    _rest: {
+    protected _rest: {
         host: string;
         basePath: string;
     };
-    _rtm: {
+    protected _rtm: {
         host: string;
         mode: RTM_MODES;
     };
-    _useragent: string;
-    _emitter: Emitter<Record<import("mitt").EventType, unknown>>;
-    _socket: Socket | null;
-    _loopback: Emitter<Record<string, unknown>> | null;
-    _lastEventRebind: any;
-    _brokerScheduler: typeof setTimeout | null;
-    _brokerBindHooks: ((modeInstance: any, emitter: any) => void)[];
-    _boundEvents: {};
+    protected _useragent: string;
+    protected _emitter: Emitter<Record<import("mitt").EventType, unknown>>;
+    protected _socket: Socket | null;
+    protected _loopback: Emitter<Record<string, unknown>> | null;
+    protected _lastEventRebind: any;
+    protected _brokerScheduler: typeof setTimeout | null;
+    protected _brokerBindHooks: ((modeInstance: any, emitter: any) => void)[];
+    protected _boundEvents: {};
     /**
      * Constructor
      */
@@ -126,42 +134,46 @@ export declare class Crisp {
     /**
      * Binds services to the main object
      */
-    _prepareServices(): void;
+    protected _prepareServices(): void;
     /**
      * Binds resources to the service object
      */
-    private prepareResources;
+    private __prepareResources;
     /**
      * Binds broker to the main object
      */
-    private prepareBroker;
+    private __prepareBroker;
     /**
      * Connects loopback (used for Web Hooks)
      */
-    private connectLoopback;
+    private __connectLoopback;
     /**
      * Connects socket, using preferred RTM API host (used for WebSockets)
      */
-    private connectSocket;
+    private __connectSocket;
     /**
      * Authenticates client (used for WebSockets)
      */
-    private emitAuthenticateSocket;
+    private __emitAuthenticateSocket;
     /**
      * Unstacks pending broker bind hooks
      */
-    private unstackBrokerBindHooks;
+    private __unstackBrokerBindHooks;
     /**
      * Performs a request to REST API
      */
-    private request;
+    private __request;
     /**
      * Reads reason for error response
      */
-    private readErrorResponseReason;
+    private __readErrorResponseReason;
     /**
      * Verifies an event string and checks that signatures match
      */
-    private verifySignature;
+    private __verifySignature;
 }
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
+export * from "./resources";
 export default Crisp;

package/dist/crisp.js

@@ -28,24 +28,24 @@ exports.Crisp = void 0;
  * IMPORTS
  ***************************************************************************/
 // NPM
-const got_1 = __importDefault(require("got"));
-const socket_io_client_1 = require("socket.io-client");
 const url_1 = require("url");
 const crypto_1 = __importDefault(require("crypto"));
+const got_1 = __importDefault(require("got"));
+const socket_io_client_1 = require("socket.io-client");
 const mitt_1 = __importDefault(require("mitt"));
 // PROJECT: SERVICES
 const bucket_1 = __importDefault(require("./services/bucket"));
 const media_1 = __importDefault(require("./services/media"));
 const plugin_1 = __importDefault(require("./services/plugin"));
 const website_1 = __importDefault(require("./services/website"));
-// PROJECT: MAIN
-// Export all types from resources
-__exportStar(require("./resources"), exports);
+/**************************************************************************
+ * CONSTANTS
+ ***************************************************************************/
 const AVAILABLE_RTM_MODES = [
     "websockets",
     "webhooks"
 ];
-const VERSION = "10.0.2";
+const VERSION = "10.0.4";
 // Base configuration
 const DEFAULT_REQUEST_TIMEOUT = 10000;
 const DEFAULT_SOCKET_TIMEOUT = 10000;
@@ -163,8 +163,11 @@ const services = {
     Plugin: plugin_1.default,
     Website: website_1.default
 };
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
 /**
- * Crisp API Library
+ *
  */
 class Crisp {
     /**
@@ -263,7 +266,7 @@ class Crisp {
      */
     head(resource, query) {
         return new Promise((resolve, reject) => {
-            this.request(resource, "head", (query || {}), null, resolve, reject);
+            this.__request(resource, "head", (query || {}), null, resolve, reject);
         });
     }
     /**
@@ -271,7 +274,7 @@ class Crisp {
      */
     get(resource, query) {
         return new Promise((resolve, reject) => {
-            this.request(resource, "get", (query || {}), null, resolve, reject);
+            this.__request(resource, "get", (query || {}), null, resolve, reject);
         });
     }
     /**
@@ -279,7 +282,7 @@ class Crisp {
      */
     post(resource, query, body) {
         return new Promise((resolve, reject) => {
-            this.request(resource, "post", (query || {}), (body || {}), resolve, reject);
+            this.__request(resource, "post", (query || {}), (body || {}), resolve, reject);
         });
     }
     /**
@@ -287,7 +290,7 @@ class Crisp {
      */
     patch(resource, query, body) {
         return new Promise((resolve, reject) => {
-            this.request(resource, "patch", (query || {}), (body || {}), resolve, reject);
+            this.__request(resource, "patch", (query || {}), (body || {}), resolve, reject);
         });
     }
     /**
@@ -295,7 +298,7 @@ class Crisp {
      */
     put(resource, query, body) {
         return new Promise((resolve, reject) => {
-            this.request(resource, "put", (query || {}), (body || {}), resolve, reject);
+            this.__request(resource, "put", (query || {}), (body || {}), resolve, reject);
         });
     }
     /**
@@ -303,7 +306,7 @@ class Crisp {
      */
     delete(resource, query, body) {
         return new Promise((resolve, reject) => {
-            this.request(resource, "delete", (query || {}), (body || null), resolve, reject);
+            this.__request(resource, "delete", (query || {}), (body || null), resolve, reject);
         });
     }
     /* eslint-enable @typescript-eslint/no-explicit-any */
@@ -340,7 +343,7 @@ class Crisp {
             // Mark event as bound
             this._boundEvents[event] = true;
             // Broker not connected? Connect now.
-            return this.prepareBroker((instance, emitter) => {
+            return this.__prepareBroker((instance, emitter) => {
                 // Listen for event? (once instance is bound)
                 switch (rtmMode) {
                     case "websockets": {
@@ -393,7 +396,7 @@ class Crisp {
      */
     verifyHook(secret, body, timestamp, signature) {
         if (this._loopback) {
-            return this.verifySignature(secret, body, timestamp, signature);
+            return this.__verifySignature(secret, body, timestamp, signature);
         }
         // Default: not verified (loopback not /yet?/ bound)
         return false;
@@ -403,7 +406,7 @@ class Crisp {
      *   Widgets)
      */
     verifyWidget(secret, body, timestamp, signature) {
-        return this.verifySignature(secret, body, timestamp, signature);
+        return this.__verifySignature(secret, body, timestamp, signature);
     }
     /**
      * Rebinds socket events (used for WebSockets)
@@ -456,19 +459,20 @@ class Crisp {
                     "defined");
             }
             // Prepare all resources (for service)
-            this.prepareResources(serviceMap, serviceInstance.__resources);
+            this.__prepareResources(serviceMap, serviceInstance.__resources);
         }
     }
     /**
      * Binds resources to the service object
      */
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    prepareResources(serviceMap, resources) {
+    __prepareResources(serviceMap, resources) {
         for (let i = 0; i < resources.length; i++) {
             const resourceConstructor = resources[i];
             const resourceInstance = new resourceConstructor(this);
             // Bind each method of the resource instance to the service map
-            for (const methodName of Object.getOwnPropertyNames(Object.getPrototypeOf(resourceInstance))) {
+            const methodNames = Object.getOwnPropertyNames(Object.getPrototypeOf(resourceInstance));
+            for (const methodName of methodNames) {
                 if (methodName !== "constructor") {
                     serviceMap[methodName] = resourceInstance[methodName].bind(resourceInstance);
                 }
@@ -478,8 +482,9 @@ class Crisp {
     /**
      * Binds broker to the main object
      */
+    __prepareBroker(
     // eslint-disable-next-line @typescript-eslint/no-explicit-any, no-unused-vars
-    prepareBroker(fnBindHook) {
+    fnBindHook) {
         return new Promise((resolve, reject) => {
             const rtmMode = this._rtm.mode;
             const rtmHostOverride = this._rtm.host;
@@ -500,14 +505,14 @@ class Crisp {
                         case "websockets": {
                             // Connect to socket now
                             // Notice: will unstack broker bind hooks once ready
-                            this.connectSocket(rtmHostOverride)
+                            this.__connectSocket(rtmHostOverride)
                                 .then(resolve)
                                 .catch(reject);
                             break;
                         }
                         case "webhooks": {
                             // Connect to loopback now
-                            this.connectLoopback()
+                            this.__connectLoopback()
                                 .then(resolve)
                                 .catch(reject);
                             break;
@@ -529,20 +534,20 @@ class Crisp {
     /**
      * Connects loopback (used for Web Hooks)
      */
-    connectLoopback() {
+    __connectLoopback() {
         return Promise.resolve()
             .then(() => {
             // Assign emitter to loopback
             this._loopback = this._emitter;
             // Unstack broker bind hooks immediately
-            this.unstackBrokerBindHooks(this._loopback);
+            this.__unstackBrokerBindHooks(this._loopback);
             return Promise.resolve();
         });
     }
     /**
      * Connects socket, using preferred RTM API host (used for WebSockets)
      */
-    connectSocket(rtmHostOverride) {
+    __connectSocket(rtmHostOverride) {
         return Promise.resolve()
             .then(() => {
             // Any override RTM API host?
@@ -592,24 +597,24 @@ class Crisp {
                 reconnectionDelayMax: DEFAULT_SOCKET_RECONNECT_DELAY_MAX,
                 randomizationFactor: DEFAULT_SOCKET_RECONNECT_FACTOR
             });
-            this.emitAuthenticateSocket();
+            this.__emitAuthenticateSocket();
             // Setup base socket event listeners
             (_b = this._socket) === null || _b === void 0 ? void 0 : _b.io.on("reconnect", () => {
-                this.emitAuthenticateSocket();
+                this.__emitAuthenticateSocket();
             });
             (_c = this._socket) === null || _c === void 0 ? void 0 : _c.on("unauthorized", () => {
                 throw new Error("[Crisp] connectSocket: cannot listen for events as " +
                     "authentication is invalid");
             });
             // Setup user socket event listeners
-            this.unstackBrokerBindHooks(this._socket);
+            this.__unstackBrokerBindHooks(this._socket);
             return Promise.resolve();
         });
     }
     /**
      * Authenticates client (used for WebSockets)
      */
-    emitAuthenticateSocket() {
+    __emitAuthenticateSocket() {
         const auth = this.auth;
         const boundEvents = Object.keys(this._boundEvents);
         if (!this._socket) {
@@ -635,7 +640,7 @@ class Crisp {
      * Unstacks pending broker bind hooks
      */
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    unstackBrokerBindHooks(modeInstance) {
+    __unstackBrokerBindHooks(modeInstance) {
         var _a;
         // Setup user socket event listeners
         while (this._brokerBindHooks.length > 0) {
@@ -645,7 +650,7 @@ class Crisp {
     /**
      * Performs a request to REST API
      */
-    request(resource, method, query, body, 
+    __request(resource, method, query, body, 
     // eslint-disable-next-line no-unused-vars
     resolve, 
     // eslint-disable-next-line no-unused-vars
@@ -695,7 +700,7 @@ class Crisp {
             }
             // Response error?
             if (response.statusCode >= 400) {
-                let reasonMessage = this.readErrorResponseReason(method, response.statusCode, response);
+                let reasonMessage = this.__readErrorResponseReason(method, response.statusCode, response);
                 const dataMessage = (((_b = (_a = response === null || response === void 0 ? void 0 : response.body) === null || _a === void 0 ? void 0 : _a.data) === null || _b === void 0 ? void 0 : _b.message) || "");
                 return reject({
                     reason: "error",
@@ -714,7 +719,7 @@ class Crisp {
     /**
      * Reads reason for error response
      */
-    readErrorResponseReason(method, statusCode, response) {
+    __readErrorResponseReason(method, statusCode, response) {
         var _a;
         // HEAD method? As HEAD requests do not expect any response body, then we \
         //   cannot map a reason from the response.
@@ -736,7 +741,7 @@ class Crisp {
     /**
      * Verifies an event string and checks that signatures match
      */
-    verifySignature(secret, body, timestamp, signature) {
+    __verifySignature(secret, body, timestamp, signature) {
         // Ensure all provided data is valid
         if (!secret || !signature || !body || typeof body !== "object" ||
             !timestamp || isNaN(timestamp) === true) {
@@ -761,4 +766,8 @@ Crisp.RTM_MODES = {
     WebHooks: "webhooks"
 };
 ;
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
+__exportStar(require("./resources"), exports);
 exports.default = Crisp;

package/dist/resources/BaseResource.d.ts

@@ -2,6 +2,9 @@
  * IMPORTS
  ***************************************************************************/
 import Crisp from "../crisp";
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
 /**
  * Crisp Base Resource
  */
@@ -12,4 +15,7 @@ declare class BaseResource {
      */
     constructor(crisp: Crisp);
 }
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
 export default BaseResource;

package/dist/resources/BaseResource.js

@@ -6,6 +6,9 @@
  * Author: Baptiste Jamin <baptiste@crisp.chat>
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
 /**
  * Crisp Base Resource
  */
@@ -17,4 +20,7 @@ class BaseResource {
         this.crisp = crisp;
     }
 }
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
 exports.default = BaseResource;

package/dist/resources/BucketURL.d.ts

@@ -2,6 +2,9 @@
  * IMPORTS
  ***************************************************************************/
 import BaseResource from "./BaseResource";
+/**************************************************************************
+ * TYPES
+ ***************************************************************************/
 export type BucketURLRequestFile = {
     name?: string;
     type?: string;
@@ -16,6 +19,9 @@ export type BucketURLRequest = {
     file?: BucketURLRequestFile;
     resource?: BucketURLRequestResource;
 };
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
 /**
  * Crisp BucketURL Resource
  */
@@ -25,4 +31,7 @@ declare class BucketURL extends BaseResource {
      */
     generateBucketURL(data: BucketURLRequest): Promise<any>;
 }
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
 export default BucketURL;

package/dist/resources/BucketURL.js

@@ -14,6 +14,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
  ***************************************************************************/
 // PROJECT: RESOURCES
 const BaseResource_1 = __importDefault(require("./BaseResource"));
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
 /**
  * Crisp BucketURL Resource
  */
@@ -26,4 +29,7 @@ class BucketURL extends BaseResource_1.default {
     }
     ;
 }
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
 exports.default = BucketURL;

package/dist/resources/MediaAnimation.d.ts

@@ -2,6 +2,9 @@
  * IMPORTS
  ***************************************************************************/
 import BaseResource from "./BaseResource";
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
 /**
  * Crisp MediaAnimation Resource
  */
@@ -11,4 +14,7 @@ declare class MediaAnimation extends BaseResource {
      */
     listAnimationMedias(pageNumber: number, listID: string, searchQuery: object): Promise<any>;
 }
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
 export default MediaAnimation;

package/dist/resources/MediaAnimation.js

@@ -14,6 +14,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
  ***************************************************************************/
 // PROJECT: RESOURCES
 const BaseResource_1 = __importDefault(require("./BaseResource"));
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
 /**
  * Crisp MediaAnimation Resource
  */
@@ -22,11 +25,16 @@ class MediaAnimation extends BaseResource_1.default {
      * List Animation Medias
      */
     listAnimationMedias(pageNumber, listID, searchQuery) {
-        return this.crisp.get(this.crisp.prepareRestUrl(["media", "animation", "list", String(pageNumber)]), {
+        return this.crisp.get(this.crisp.prepareRestUrl([
+            "media", "animation", "list", String(pageNumber)
+        ]), {
             list_id: listID,
             search_query: searchQuery
         });
     }
     ;
 }
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
 exports.default = MediaAnimation;

package/dist/resources/PluginConnect.d.ts

@@ -2,6 +2,9 @@
  * IMPORTS
  ***************************************************************************/
 import BaseResource from "./BaseResource";
+/**************************************************************************
+ * TYPES
+ ***************************************************************************/
 export type PluginConnectAccount = {
     plugin_id?: string;
 };
@@ -22,6 +25,9 @@ export type PluginConnectEndpoints = {
 export type PluginConnectEndpointsSocket = {
     app?: string;
 };
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
 /**
  * Crisp PluginConnect Resource
  */
@@ -47,4 +53,7 @@ declare class PluginConnect extends BaseResource {
      */
     getConnectEndpoints(): Promise<PluginConnectEndpoints>;
 }
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
 export default PluginConnect;

package/dist/resources/PluginConnect.js

@@ -14,6 +14,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
  ***************************************************************************/
 // PROJECT: RESOURCES
 const BaseResource_1 = __importDefault(require("./BaseResource"));
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
 /**
  * Crisp PluginConnect Resource
  */
@@ -70,4 +73,7 @@ class PluginConnect extends BaseResource_1.default {
     }
     ;
 }
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
 exports.default = PluginConnect;

package/dist/resources/PluginSubscription.d.ts

@@ -2,6 +2,9 @@
  * IMPORTS
  ***************************************************************************/
 import BaseResource from "./BaseResource";
+/**************************************************************************
+ * TYPES
+ ***************************************************************************/
 type PluginSubscription = {
     id?: string;
     urn?: string;
@@ -47,6 +50,9 @@ type PluginSubscriptionEventDispatch = {
     name?: string;
     data?: object;
 };
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
 /**
  * Crisp PluginSubscription Resource
  */
@@ -100,4 +106,7 @@ declare class PluginSubscriptionService extends BaseResource {
      */
     dispatchPluginEvent(websiteID: string, pluginID: string, payload: PluginSubscriptionEventDispatch): Promise<any>;
 }
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
 export default PluginSubscriptionService;

package/dist/resources/PluginSubscription.js

@@ -14,6 +14,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
  ***************************************************************************/
 // PROJECT: RESOURCES
 const BaseResource_1 = __importDefault(require("./BaseResource"));
+/**************************************************************************
+ * CLASSES
+ ***************************************************************************/
 /**
  * Crisp PluginSubscription Resource
  */
@@ -52,7 +55,9 @@ class PluginSubscriptionService extends BaseResource_1.default {
      * Unsubscribe Plugin From Website
      */
     unsubscribePluginFromWebsite(websiteID, pluginID) {
-        return this.crisp.delete(this.crisp.prepareRestUrl(["plugins", "subscription", websiteID, pluginID]));
+        return this.crisp.delete(this.crisp.prepareRestUrl([
+            "plugins", "subscription", websiteID, pluginID
+        ]));
     }
     ;
     /**
@@ -119,4 +124,7 @@ class PluginSubscriptionService extends BaseResource_1.default {
     }
     ;
 }
+/**************************************************************************
+ * EXPORTS
+ ***************************************************************************/
 exports.default = PluginSubscriptionService;