@bwi-mentorspaces/application-utils-npm 0.0.6 → 0.0.7

package/chat/stream/stream.base.d.ts

@@ -1,56 +1,56 @@
-import { Channel, StreamChat } from "stream-chat";
-import { StreamAuth } from "./stream.auth";
-/**
- * BaseClient class
- */
-export declare abstract class StreamBase {
-    private _server;
-    private _auth;
-    /**
-     * getter for stream chat instance
-     *
-     * @returns {StreamChat} stream chat instance
-     */
-    get server(): StreamChat;
-    /**
-     * setter for stream chat instance
-     *
-     * @param {StreamChat} value stream chat instance
-     */
-    set server(value: StreamChat);
-    /**
-     * getter for stream auth
-     *
-     * @returns {StreamAuth} stream auth instance
-     */
-    get auth(): StreamAuth;
-    /**
-     * setter for stream auth instance
-     *
-     * @param {StreamAuth} value stream auth instance
-     */
-    set auth(value: StreamAuth);
-    /**
-     * Get token for extended classes
-     *
-     * @param {string} userId user id
-     * @param {boolean} refresh refresh token
-     * @returns {string} returns the token value
-     */
-    getToken(userId: string, refresh?: boolean): string;
-    /**
-     * Get channel instance by id
-     *
-     * @param {string} channelId channel id
-     * @returns {Channel} channel instance
-     */
-    getChannelById(channelId: string): Promise<Channel[]>;
-    /**
-     * Handles the exceptions generated by the StreamAPI *(check for token expiration)
-     *
-     * @param {number} httpError http error from Stream
-     * @param {number} httpCode http error code
-     * @returns {boolean} Will be return a string with a friendly message or a new token(depending of the case)
-     */
-    static hasTokenExpired(httpError: number, httpCode: number): boolean;
-}
+import { Channel, StreamChat } from "stream-chat";
+import { StreamAuth } from "./stream.auth";
+/**
+ * BaseClient class
+ */
+export declare abstract class StreamBase {
+    private _server;
+    private _auth;
+    /**
+     * getter for stream chat instance
+     *
+     * @returns {StreamChat} stream chat instance
+     */
+    get server(): StreamChat;
+    /**
+     * setter for stream chat instance
+     *
+     * @param {StreamChat} value stream chat instance
+     */
+    set server(value: StreamChat);
+    /**
+     * getter for stream auth
+     *
+     * @returns {StreamAuth} stream auth instance
+     */
+    get auth(): StreamAuth;
+    /**
+     * setter for stream auth instance
+     *
+     * @param {StreamAuth} value stream auth instance
+     */
+    set auth(value: StreamAuth);
+    /**
+     * Get token for extended classes
+     *
+     * @param {string} userId user id
+     * @param {boolean} refresh refresh token
+     * @returns {string} returns the token value
+     */
+    getToken(userId: string, refresh?: boolean): string;
+    /**
+     * Get channel instance by id
+     *
+     * @param {string} channelId channel id
+     * @returns {Channel} channel instance
+     */
+    getChannelById(channelId: string): Promise<Channel[]>;
+    /**
+     * Handles the exceptions generated by the StreamAPI *(check for token expiration)
+     *
+     * @param {number} httpError http error from Stream
+     * @param {number} httpCode http error code
+     * @returns {boolean} Will be return a string with a friendly message or a new token(depending of the case)
+     */
+    static hasTokenExpired(httpError: number, httpCode: number): boolean;
+}

package/chat/stream/stream.base.js

@@ -1,94 +1,94 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StreamBase = void 0;
-const enum_1 = require("./enum");
-/**
- * BaseClient class
- */
-class StreamBase {
-    // getter / setter
-    /**
-     * getter for stream chat instance
-     *
-     * @returns {StreamChat} stream chat instance
-     */
-    get server() {
-        return this._server;
-    }
-    /**
-     * setter for stream chat instance
-     *
-     * @param {StreamChat} value stream chat instance
-     */
-    set server(value) {
-        this._server = value;
-    }
-    /**
-     * getter for stream auth
-     *
-     * @returns {StreamAuth} stream auth instance
-     */
-    get auth() {
-        return this._auth;
-    }
-    /**
-     * setter for stream auth instance
-     *
-     * @param {StreamAuth} value stream auth instance
-     */
-    set auth(value) {
-        this._auth = value;
-    }
-    // methods
-    /**
-     * Get token for extended classes
-     *
-     * @param {string} userId user id
-     * @param {boolean} refresh refresh token
-     * @returns {string} returns the token value
-     */
-    getToken(userId, refresh) {
-        return this.auth.token(userId, refresh);
-    }
-    /**
-     * Get channel instance by id
-     *
-     * @param {string} channelId channel id
-     * @returns {Channel} channel instance
-     */
-    getChannelById(channelId) {
-        return __awaiter(this, void 0, void 0, function* () {
-            //Create the filter
-            const filter = { type: enum_1.ChannelType.Team, id: { $eq: channelId } };
-            //return the result
-            return yield this._server.queryChannels(filter);
-        });
-    }
-    /**
-     * Handles the exceptions generated by the StreamAPI *(check for token expiration)
-     *
-     * @param {number} httpError http error from Stream
-     * @param {number} httpCode http error code
-     * @returns {boolean} Will be return a string with a friendly message or a new token(depending of the case)
-     */
-    static hasTokenExpired(httpError, httpCode) {
-        //Check if the error belows an specific Authentication error code
-        if (httpError === 401 /* Unauthorized */ || httpError === 403 /* Forbidden */) {
-            //This is a token expired validation from API
-            if (httpCode == enum_1.ResponseCode.TokenExpired) {
-                return true;
-            }
-        }
-    }
-}
-exports.StreamBase = StreamBase;
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StreamBase = void 0;
+const enum_1 = require("./enum");
+/**
+ * BaseClient class
+ */
+class StreamBase {
+    // getter / setter
+    /**
+     * getter for stream chat instance
+     *
+     * @returns {StreamChat} stream chat instance
+     */
+    get server() {
+        return this._server;
+    }
+    /**
+     * setter for stream chat instance
+     *
+     * @param {StreamChat} value stream chat instance
+     */
+    set server(value) {
+        this._server = value;
+    }
+    /**
+     * getter for stream auth
+     *
+     * @returns {StreamAuth} stream auth instance
+     */
+    get auth() {
+        return this._auth;
+    }
+    /**
+     * setter for stream auth instance
+     *
+     * @param {StreamAuth} value stream auth instance
+     */
+    set auth(value) {
+        this._auth = value;
+    }
+    // methods
+    /**
+     * Get token for extended classes
+     *
+     * @param {string} userId user id
+     * @param {boolean} refresh refresh token
+     * @returns {string} returns the token value
+     */
+    getToken(userId, refresh) {
+        return this.auth.token(userId, refresh);
+    }
+    /**
+     * Get channel instance by id
+     *
+     * @param {string} channelId channel id
+     * @returns {Channel} channel instance
+     */
+    getChannelById(channelId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            //Create the filter
+            const filter = { type: enum_1.ChannelType.Team, id: { $eq: channelId } };
+            //return the result
+            return yield this._server.queryChannels(filter);
+        });
+    }
+    /**
+     * Handles the exceptions generated by the StreamAPI *(check for token expiration)
+     *
+     * @param {number} httpError http error from Stream
+     * @param {number} httpCode http error code
+     * @returns {boolean} Will be return a string with a friendly message or a new token(depending of the case)
+     */
+    static hasTokenExpired(httpError, httpCode) {
+        //Check if the error belows an specific Authentication error code
+        if (httpError === 401 /* Unauthorized */ || httpError === 403 /* Forbidden */) {
+            //This is a token expired validation from API
+            if (httpCode == enum_1.ResponseCode.TokenExpired) {
+                return true;
+            }
+        }
+    }
+}
+exports.StreamBase = StreamBase;
 //# sourceMappingURL=stream.base.js.map

package/chat/stream/stream.channel.d.ts

@@ -1,118 +1,132 @@
-import { ChannelAPIResponse, StreamChat, Channel, ChannelSort, UpdateChannelAPIResponse, ChannelFilters, ChannelOptions } from "stream-chat";
-import { IChannelData } from "./models/";
-import { StreamBase } from "./stream.base";
-import { StreamAuth } from "./stream.auth";
-/**
- * Channel Api declarations
- */
-interface IStreamChannel {
-    /**
-     * Create channel with optional data object
-     */
-    create(data: IChannelData): Promise<ChannelAPIResponse>;
-    /**
-     * Check if exist a channel with specific members
-     */
-    getByMembers(data: IChannelData): Promise<Channel[]>;
-    /**
-     * Get channel by filter
-     */
-    getChannel(filter: ChannelFilters): Promise<Channel[]>;
-    /**
-     * Delete a specific channel from stream, this will be delete the data too.
-     */
-    deleteChannel(channelId: string, isHard: boolean): Promise<boolean>;
-    /**
-     * Accept invited channel
-     */
-    acceptInvite(channelId: string, userId: string): Promise<UpdateChannelAPIResponse>;
-    /**
-     * Reject invited channel
-     */
-    rejectInvite(channelId: string, userId: string): Promise<UpdateChannelAPIResponse>;
-    /**
-     * Sync channel
-     */
-    syncChannel(data: IChannelData): Promise<boolean>;
-}
-/**
- *  A class that provides methods to manage StreamAPI Channel
- */
-export declare class StreamChannel extends StreamBase implements IStreamChannel {
-    /**
-     * Stream channel constructor
-     *
-     * @param {StreamAuth} auth Auth class
-     * @param {StreamChat} server Stream API server
-     */
-    constructor(auth: StreamAuth, server: StreamChat);
-    /**
-     * Create channel
-     *
-     * @param {IChannelData} data channel data object
-     * @returns {ChannelAPIResponse} channel object response
-     */
-    create(data: IChannelData): Promise<ChannelAPIResponse>;
-    /**
-     * Add new members into a specific channel.
-     *
-     * @param {IChannelData} data channel data object
-     * @returns {Promise<boolean>} promise of the result to add members
-     */
-    addMembers(data: IChannelData): Promise<boolean>;
-    /**
-     * Check if exist a channel with specific members
-     *
-     * @param {IChannelData} data channel data object
-     * @returns {Promise<Channel[]>} channel response
-     */
-    getByMembers(data: IChannelData): Promise<Channel[]>;
-    /**
-     * Get channel by filter
-     *
-     * @param {ChannelFilters} filter filter parameters
-     * @param {ChannelSort} sort sort parameters
-     * @param {ChannelOptions} options options parameter
-     * @returns {Promise<Channel[]>} channel response
-     */
-    getChannel(filter: ChannelFilters, sort?: ChannelSort, options?: ChannelOptions): Promise<Channel[]>;
-    /**
-     * Allow to partial update some fields on stream channel
-     *
-     * @param {IChannelData} data channel data object
-     * @returns {Promise<UpdateChannelAPIResponse>} channel object response
-     */
-    updateChannel(data: IChannelData): Promise<UpdateChannelAPIResponse>;
-    /**
-     * This will be delete a specific channel from Stream
-     *
-     * @param {string} channelId channel id of the channel
-     * @param {boolean} isHard is Hard delete
-     * @returns {Promise<boolean>} promise of the result to delete channel
-     */
-    deleteChannel(channelId: string, isHard?: boolean): Promise<boolean>;
-    /**
-     * Accept invited channel
-     *
-     * @param {string} channelId channel id of the channel
-     * @param {string} userId user id from stream
-     * @returns {boolean} true / false
-     */
-    acceptInvite(channelId: string, userId: string): Promise<UpdateChannelAPIResponse>;
-    /**
-     * Reject invited channel
-     *
-     * @param {string} channelId channel id of the channel
-     * @param {string} userId user id from stream
-     * @returns {boolean} true / false
-     */
-    rejectInvite(channelId: string, userId: string): Promise<UpdateChannelAPIResponse>;
-    /**
-     * Sync a channel
-     *
-     * @param {IChannelData} data channel data
-     * @returns {Promise<boolean>} promise of the type boolean
-     */
-    syncChannel(data: IChannelData): Promise<boolean>;
-}
-export {};
+import { ChannelAPIResponse, StreamChat, Channel, ChannelSort, UpdateChannelAPIResponse, ChannelFilters, ChannelOptions, UserResponse, EventAPIResponse, DefaultGenerics } from "stream-chat";
+import { IChannelData, IEventTypes, IEventTypesData } from "./models";
+import { StreamBase } from "./stream.base";
+import { StreamAuth } from "./stream.auth";
+/**
+ * Channel Api declarations
+ */
+interface IStreamChannel {
+    /**
+     * Create channel with optional data object
+     */
+    create(data: IChannelData): Promise<ChannelAPIResponse>;
+    /**
+     * Check if exist a channel with specific members
+     */
+    getByMembers(data: IChannelData): Promise<Channel[]>;
+    /**
+     * Get channel by filter
+     */
+    getChannel(filter: ChannelFilters): Promise<Channel[]>;
+    /**
+     * Delete a specific channel from stream, this will be delete the data too.
+     */
+    deleteChannel(channelId: string, isHard: boolean): Promise<boolean>;
+    /**
+     * Accept invited channel
+     */
+    acceptInvite(channelId: string, userId: string): Promise<UpdateChannelAPIResponse>;
+    /**
+     * Reject invited channel
+     */
+    rejectInvite(channelId: string, userId: string): Promise<UpdateChannelAPIResponse>;
+    /**
+     * Sync channel
+     */
+    syncChannel(data: IChannelData): Promise<boolean>;
+    /**
+     * Send event to channel
+     */
+    sendChannelEvent<T extends IEventTypes>(channelId: string, eventType: T, user: UserResponse, customData?: IEventTypesData[T]): Promise<EventAPIResponse<DefaultGenerics>>;
+}
+/**
+ *  A class that provides methods to manage StreamAPI Channel
+ */
+export declare class StreamChannel extends StreamBase implements IStreamChannel {
+    /**
+     * Stream channel constructor
+     *
+     * @param {StreamAuth} auth Auth class
+     * @param {StreamChat} server Stream API server
+     */
+    constructor(auth: StreamAuth, server: StreamChat);
+    /**
+     * Create channel
+     *
+     * @param {IChannelData} data channel data object
+     * @returns {ChannelAPIResponse} channel object response
+     */
+    create(data: IChannelData): Promise<ChannelAPIResponse>;
+    /**
+     * Send event to channel
+     *
+     * @param {string} channelId the channel id
+     * @param {IEventTypes} eventType the event type
+     * @param {string} user user responsible for sent the event
+     * @param {IEventTypesData} customData the data to send with the event
+     * @returns {Promise<EventAPIResponse<DefaultGenerics>>} channel object response
+     */
+    sendChannelEvent<T extends IEventTypes>(channelId: string, eventType: T, user: UserResponse, customData?: IEventTypesData[T]): Promise<EventAPIResponse<DefaultGenerics>>;
+    /**
+     * Add new members into a specific channel.
+     *
+     * @param {IChannelData} data channel data object
+     * @returns {Promise<boolean>} promise of the result to add members
+     */
+    addMembers(data: IChannelData): Promise<boolean>;
+    /**
+     * Check if exist a channel with specific members
+     *
+     * @param {IChannelData} data channel data object
+     * @returns {Promise<Channel[]>} channel response
+     */
+    getByMembers(data: IChannelData): Promise<Channel[]>;
+    /**
+     * Get channel by filter
+     *
+     * @param {ChannelFilters} filter filter parameters
+     * @param {ChannelSort} sort sort parameters
+     * @param {ChannelOptions} options options parameter
+     * @returns {Promise<Channel[]>} channel response
+     */
+    getChannel(filter: ChannelFilters, sort?: ChannelSort, options?: ChannelOptions): Promise<Channel[]>;
+    /**
+     * Allow to partial update some fields on stream channel
+     *
+     * @param {IChannelData} data channel data object
+     * @returns {Promise<UpdateChannelAPIResponse>} channel object response
+     */
+    updateChannel(data: IChannelData): Promise<UpdateChannelAPIResponse>;
+    /**
+     * This will be delete a specific channel from Stream
+     *
+     * @param {string} channelId channel id of the channel
+     * @param {boolean} isHard is Hard delete
+     * @returns {Promise<boolean>} promise of the result to delete channel
+     */
+    deleteChannel(channelId: string, isHard?: boolean): Promise<boolean>;
+    /**
+     * Accept invited channel
+     *
+     * @param {string} channelId channel id of the channel
+     * @param {string} userId user id from stream
+     * @returns {boolean} true / false
+     */
+    acceptInvite(channelId: string, userId: string): Promise<UpdateChannelAPIResponse>;
+    /**
+     * Reject invited channel
+     *
+     * @param {string} channelId channel id of the channel
+     * @param {string} userId user id from stream
+     * @returns {boolean} true / false
+     */
+    rejectInvite(channelId: string, userId: string): Promise<UpdateChannelAPIResponse>;
+    /**
+     * Sync a channel
+     *
+     * @param {IChannelData} data channel data
+     * @returns {Promise<boolean>} promise of the type boolean
+     */
+    syncChannel(data: IChannelData): Promise<boolean>;
+}
+export {};