Type for Zendesk Chat (Zopim) Web SDK (#36424)

* added typedef, wip tests

* add tests

* fix lints

* capital letter

* lint

* update strick null checks

* revert unwanted changes

* address comments

* fixing diff

* lint

* fixing test

types/z-schema/tsconfig.json

@@ -21,4 +21,4 @@
         "index.d.ts",
         "z-schema-tests.ts"
     ]
-}
+}

types/zchat-browser/index.d.ts

@@ -0,0 +1,250 @@
+// Type definitions for non-npm package zchat-browser 1.81
+// Project: https://api.zopim.com/web-sdk/#introduction
+// Definitions by: David Copley <https://github.com/davidcopley>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+// TypeScript Version: 2.1
+
+export as namespace zChat;
+
+export interface InitProps {
+    account_key: string;
+    authentication?: {
+        jwt_fn?: (callback: (jwt: string) => void) => void;
+    };
+}
+
+export function init(initProps: InitProps): void;
+
+export function getAccountStatus(): 'online' | 'offline' | 'away';
+
+export function getConnectionStatus(): 'connected' | 'connecting' | 'closed';
+
+export function getVisitorInfo(): VisitorInfo;
+
+export function setVisitorInfo(options: Partial<VisitorInfo>, callback?: (err: Error) => void): void;
+
+export function sendVisitorPath(options: { title: string; url: string }, callback?: (err: Error) => void): void;
+
+export function getQueuePosition(): number;
+
+export function getAllDepartments(): Department[];
+
+export function getDepartment(id: number): Department;
+
+export function getVisitorDefaultDepartment(id?: number): Department;
+
+export function setVisitorDefaultDepartment(id: number, callback?: (err: Error) => void): void;
+
+export function clearVisitorDefaultDepartment(callback?: (err: Error) => void): void;
+
+/**
+ * If this method is used when none of the agents are available to pick up a chat,
+ * messages sent by visitors may result in missed chats.
+ * @param msg
+ * @param callback
+ */
+export function sendChatMsg(msg: string, callback?: (err: Error) => void): void;
+
+/**
+ * The size of each file attachment sent cannot exceed 20MB as of v1.1.4.
+ * The previous limit was 5MB.
+ * @param file
+ * @param callback
+ */
+export function sendFile(file: File, callback?: (err: SendFileErrorMessage, data: {
+    mime_type: string,
+    name: string,
+    size: number,
+    url: string,
+}) => void): void;
+
+export function sendOfflineMsg(
+    options: {
+        name: string;
+        email: string;
+        phone?: string;
+        message: string;
+        department?: number;
+    },
+    callback: (err: Error) => void
+): void;
+
+export function addTags(tags: string[], callback?: (err: Error) => void): void;
+
+export function removeTags(tags: ReadonlyArray<string>, callback?: (err: Error) => void): void;
+
+export function sendTyping(is_typing: boolean): void;
+
+export function getChatInfo(): { rating?: string; comment?: string };
+
+export function sendChatRating(rating: 'good' | 'bad' | undefined, callback?: (err: Error) => void): void;
+
+export function sendChatComment(comment: string, callback?: (err: Error) => void): void;
+
+export function isChatting(): boolean;
+
+export function getChatLog(): ChatEvent.ChatEventData[];
+
+export function on(event_name: EventName, handler: (event_data?: EventData) => void): void;
+
+export function un(event_name: EventName, handler: (event_data?: EventData) => void): void;
+
+export namespace ChatEvent {
+    interface BaseChatEventData {
+        nick: string;
+        display_name: string;
+        time_stamp: number;
+    }
+
+    type ChatEventData =
+        | BaseChatEventData & {
+        type: 'chat.msg';
+        msg: string;
+        options: string[];
+        structured_msg: StructuredMessage;
+    }
+        | BaseChatEventData & {
+        type: 'chat.file';
+        attachment: Attachment;
+        deleted: boolean;
+    }
+        | BaseChatEventData & {
+        type: 'chat.memberjoin';
+    }
+        | BaseChatEventData & {
+        type: 'chat.memberleave';
+    }
+        | BaseChatEventData & {
+        type: 'chat.request.rating';
+    }
+        | BaseChatEventData & {
+        type: 'chat.rating';
+        rating?: string;
+        new_rating?: string;
+    }
+        | BaseChatEventData & {
+        type: 'chat.comment';
+        comment?: string;
+        new_comment?: string;
+    };
+
+    interface Action {
+        type: 'QUICK_REPLY_ACTION' | 'LINK_ACTION';
+        value: string;
+    }
+
+    interface Button {
+        text: string;
+        action: Action;
+    }
+
+    interface Panel {
+        heading: string;
+        paragraph?: string;
+        image_url: string;
+        action: Action;
+    }
+
+    interface PanelTemplate {
+        type: 'PANEL_TEMPLATE';
+        panel: Panel;
+        buttons: Button[];
+    }
+
+    interface ListItem {
+        heading: string;
+        paragraph: string;
+        image_url?: string;
+        action: Action;
+    }
+
+    type StructuredMessage =
+        | {
+        type: 'QUICK_REPLIES';
+        msg: string;
+        quick_replies: Button[];
+    }
+        | {
+        type: 'PANEL_TEMPLATE';
+        panel: Panel;
+        buttons: Button[];
+    }
+        | {
+        type: 'PANEL_TEMPLATE_CAROUSEL';
+        items: PanelTemplate[];
+    }
+        | {
+        type: 'LIST_TEMPLATE';
+        items: ListItem[];
+        buttons: Button[];
+    };
+}
+
+export type SendFileErrorMessage =
+    | 'NOT_SUPPORTED'
+    | 'NOT_ALLOWED'
+    | 'CONN_ERROR'
+    | 'INVALID_EXTENSION'
+    | 'EXCEED_SIZE_LIMIT'
+    | 'INTERNAL_ERROR'
+    | 'UNKNOWN_ERROR';
+
+export interface VisitorInfo {
+    display_name: string;
+    email: string;
+    phone: string;
+}
+
+export interface Department {
+    id: number;
+    name: string;
+    status: 'online' | 'offline';
+}
+
+export interface Attachment {
+    metadata?: AttachmentMetadata;
+    mime_type: string;
+    name: string;
+    size: number;
+    url: string;
+}
+
+export interface AttachmentMetadata {
+    width: number;
+    height: number;
+}
+
+export type EventName =
+    | 'account_status'
+    | 'connection_update'
+    | 'department_update'
+    | 'visitor_update'
+    | 'agent_update'
+    | 'chat'
+    | 'history'
+    | 'typing'
+    | 'error';
+
+export type EventData =
+    | ChatEvent.ChatEventData
+    | {
+    type: 'chat.queue_position';
+    nick: string;
+    queue_position: number;
+}
+    | {
+    type: 'typing';
+    nick: string;
+    typing: boolean;
+}
+    | {
+    type: 'last_read';
+    nick: string;
+    timestamp: number;
+}
+    | 'online'
+    | 'away'
+    | 'offline'
+    | 'connecting'
+    | 'connected'
+    | 'closed';

types/zchat-browser/tsconfig.json

@@ -0,0 +1,25 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": [
+            "es6",
+            "dom"
+        ],
+        "target": "es6",
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictNullChecks": true,
+        "strictFunctionTypes": true,
+        "baseUrl": "../",
+        "typeRoots": [
+            "../"
+        ],
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "zchat-browser-tests.ts"
+    ]
+}

types/zchat-browser/tslint.json

@@ -0,0 +1 @@
+{ "extends": "dtslint/dt.json" }

types/zchat-browser/zchat-browser-tests.ts

@@ -0,0 +1,40 @@
+import * as zChat from 'zchat-browser';
+
+const fakeCallback = (err: Error) => 0;
+const fakeFile = new File(['foo'], 'foo.txt', {
+    type: 'text/plain',
+});
+
+zChat.addTags(['tag1', 'tag2']);
+zChat.clearVisitorDefaultDepartment(fakeCallback);
+zChat.getAccountStatus();
+zChat.getAllDepartments();
+zChat.getChatInfo();
+zChat.getChatLog();
+zChat.getConnectionStatus();
+zChat.getDepartment(1);
+zChat.getQueuePosition();
+zChat.getVisitorDefaultDepartment();
+zChat.getVisitorInfo();
+zChat.init({ account_key: 'fake_account_key' });
+zChat.isChatting();
+zChat.removeTags(['tag1', 'tag2']);
+zChat.sendChatComment('fake_comment', fakeCallback);
+zChat.sendChatMsg('fake_message', fakeCallback);
+zChat.sendChatRating('good', fakeCallback);
+zChat.sendFile(
+    fakeFile,
+    (err: zChat.SendFileErrorMessage, data: { mime_type: string; name: string; size: number; url: string }) => 0
+);
+zChat.sendOfflineMsg({ name: 'fake_name', email: 'fake_email', message: 'fake_message' }, fakeCallback);
+zChat.sendTyping(true);
+zChat.sendVisitorPath({ title: 'fake_title', url: 'fake_url' }, fakeCallback);
+zChat.setVisitorDefaultDepartment(1, fakeCallback);
+zChat.setVisitorInfo({
+    display_name: 'fake_name',
+    email: 'fake_email',
+    phone: 'fake_phone',
+});
+const fakeHandler = (event_data?: zChat.EventData) => 0;
+zChat.on('account_status', fakeHandler);
+zChat.un('account_status', fakeHandler);