Merge pull request #33 from iotum/jerry_hu/search-widget

search widget

Author: jerry2013

.eslintrc.json

@@ -7,6 +7,8 @@ declare module '@iotum/callbridge-js/dashboard' {
   export enum Service {
       /** None */
       None = "",
+      /** Search */
+      Search = "Search",
       /** Team (Chat) */
       Team = "Team",
       /** Drive (Content Library) */
@@ -82,6 +84,9 @@ declare module '@iotum/callbridge-js/dashboard' {
        */
       invitedHosts?: number[];
   };
+  /**
+   * Chat room.
+   */
   export type ChatRoom = {
       /** Room path, used for navigation. @see `Dashboard.load` */
       path: string;
@@ -94,6 +99,24 @@ declare module '@iotum/callbridge-js/dashboard' {
           picture_url: string;
       }>;
   };
+  /**
+   * Search options.
+   */
+  export type SearchOptions = {
+      /** The search content type. Default `SearchContentType.Event` */
+      contentType?: SearchContentType;
+      /** The page number of the search result. Optional, default 1 */
+      page?: number;
+      /** The sorting order of the search result. Optional, default 'date' */
+      order?: 'date' | 'relevance';
+  };
+  /**
+   * Search content type.
+   */
+  export enum SearchContentType {
+      /** E.g. meeting and call event. */
+      event = "event"
+  }
   /**
    * Callbridge Dashboard.
    */
@@ -136,6 +159,29 @@ declare module '@iotum/callbridge-js/dashboard' {
           id?: number;
           options: ScheduleOptions;
       };
+      'dashboard.SEARCH_START': {
+          /** The search query. */
+          query: string;
+          /** The page of the result. */
+          page: number;
+          /** The order of the result. */
+          order: 'date' | 'relevance';
+      };
+      'dashboard.SEARCH_RESULT': {
+          /** The search query. */
+          query: string;
+          /** The search error. */
+          error?: string;
+          /** The search result. */
+          result?: Array<{
+              /** The type of the item. */
+              contentType: SearchContentType;
+              /** The id of the item */
+              id: number;
+              /** The result text with <mark> */
+              highlight: Record<string, Array<string>>;
+          }>;
+      };
       /** Meeting widget is ready */
       'room.READY': void;
       /** Meeting widget is unloading */
@@ -156,6 +202,15 @@ declare module '@iotum/callbridge-js/dashboard' {
        * Optional, service options.
        */
       serviceOptions?: ServiceOptions);
+      /**
+       * Search for thing.
+       * @param query The search query.
+       * @param options Optional, search options.
+       * @throws {Error}
+       *   - "Not implemented" when the service is not "Search".
+       *   - "Nothing to search" when the query is empty.
+       */
+      search(query: string, options?: SearchOptions): void;
       /**
        * Loads the service.
        * @param service the service to load.
@@ -179,7 +234,7 @@ declare module '@iotum/callbridge-js/dashboard' {
 }
 declare module '@iotum/callbridge-js/index' {
   export { type WidgetOptions } from '@iotum/callbridge-js/widget';
-  export { default as Dashboard, Service, LayoutOption, MeetingAction, ScheduleAction, type ServiceOptions, type ChatRoom, } from '@iotum/callbridge-js/dashboard';
+  export { default as Dashboard, Service, LayoutOption, MeetingAction, ScheduleAction, SearchContentType, type ServiceOptions, type ChatRoom, type SearchOptions, } from '@iotum/callbridge-js/dashboard';
   export { type AudioSettings } from '@iotum/callbridge-js/room';
   export { default as Meeting, type MeetingOptions } from '@iotum/callbridge-js/meeting';
   export { default as Livestream, type LivestreamOptions } from '@iotum/callbridge-js/livestream';

dist/index.d.ts

@@ -122,6 +122,7 @@ var Widget = class {
           this.emit("widget.ERROR", ev instanceof Error ? ev.message : ev);
         };
       } catch (ex) {
+        console.warn(ex);
         this.emit("widget.ERROR", "Unable to open");
       }
     };
@@ -307,6 +308,7 @@ var Widget = class {
 // src/dashboard.ts
 var Service = /* @__PURE__ */ ((Service2) => {
   Service2["None"] = "";
+  Service2["Search"] = "Search";
   Service2["Team"] = "Team";
   Service2["Drive"] = "Drive";
   Service2["Contacts"] = "Contacts";
@@ -331,6 +333,10 @@ var ScheduleAction = /* @__PURE__ */ ((ScheduleAction2) => {
   ScheduleAction2["intercept"] = "intercept";
   return ScheduleAction2;
 })(ScheduleAction || {});
+var SearchContentType = /* @__PURE__ */ ((SearchContentType2) => {
+  SearchContentType2["event"] = "event";
+  return SearchContentType2;
+})(SearchContentType || {});
 var Dashboard = class extends Widget {
   constructor(options, service = "" /* None */, serviceOptions = {}) {
     super(options);
@@ -339,13 +345,44 @@ var Dashboard = class extends Widget {
       case "Drive" /* Drive */:
       case "Contacts" /* Contacts */:
       case "Meet" /* Meet */:
+      case "Search" /* Search */:
         this.once("dashboard.READY", () => this.load(service, serviceOptions));
         break;
     }
+    switch (service) {
+      case "Search" /* Search */:
+        this.search = (query, {
+          contentType = "event" /* event */,
+          ...opts
+        } = {}) => {
+          if (!query) {
+            throw new Error("Nothing to search");
+          }
+          this._send("dashboard", "search", {
+            query,
+            contentType,
+            ...opts
+          });
+        };
+        break;
+    }
     this._load({
       redirect_url: `/conf/loading`
     });
   }
+  /**
+   * Search for thing.
+   * @param query The search query.
+   * @param options Optional, search options.
+   * @throws {Error}
+   *   - "Not implemented" when the service is not "Search".
+   *   - "Nothing to search" when the query is empty.
+   */
+  search(query, options) {
+    query;
+    options;
+    throw new Error("Not implemented");
+  }
   /**
    * Loads the service.
    * @param service the service to load.
@@ -533,5 +570,6 @@ export {
   Meeting,
   MeetingAction,
   ScheduleAction,
+  SearchContentType,
   Service
 };

dist/index.esm.js

@@ -18,17 +18,18 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
-var src_exports = {};
-__export(src_exports, {
+var index_exports = {};
+__export(index_exports, {
   Dashboard: () => Dashboard,
   LayoutOption: () => LayoutOption,
   Livestream: () => Livestream,
   Meeting: () => Meeting,
   MeetingAction: () => MeetingAction,
   ScheduleAction: () => ScheduleAction,
+  SearchContentType: () => SearchContentType,
   Service: () => Service
 });
-module.exports = __toCommonJS(src_exports);
+module.exports = __toCommonJS(index_exports);
 
 // src/widget.ts
 var import_events = require("events");
@@ -154,6 +155,7 @@ var Widget = class {
           this.emit("widget.ERROR", ev instanceof Error ? ev.message : ev);
         };
       } catch (ex) {
+        console.warn(ex);
         this.emit("widget.ERROR", "Unable to open");
       }
     };
@@ -339,6 +341,7 @@ var Widget = class {
 // src/dashboard.ts
 var Service = /* @__PURE__ */ ((Service2) => {
   Service2["None"] = "";
+  Service2["Search"] = "Search";
   Service2["Team"] = "Team";
   Service2["Drive"] = "Drive";
   Service2["Contacts"] = "Contacts";
@@ -363,6 +366,10 @@ var ScheduleAction = /* @__PURE__ */ ((ScheduleAction2) => {
   ScheduleAction2["intercept"] = "intercept";
   return ScheduleAction2;
 })(ScheduleAction || {});
+var SearchContentType = /* @__PURE__ */ ((SearchContentType2) => {
+  SearchContentType2["event"] = "event";
+  return SearchContentType2;
+})(SearchContentType || {});
 var Dashboard = class extends Widget {
   constructor(options, service = "" /* None */, serviceOptions = {}) {
     super(options);
@@ -371,13 +378,44 @@ var Dashboard = class extends Widget {
       case "Drive" /* Drive */:
       case "Contacts" /* Contacts */:
       case "Meet" /* Meet */:
+      case "Search" /* Search */:
         this.once("dashboard.READY", () => this.load(service, serviceOptions));
         break;
     }
+    switch (service) {
+      case "Search" /* Search */:
+        this.search = (query, {
+          contentType = "event" /* event */,
+          ...opts
+        } = {}) => {
+          if (!query) {
+            throw new Error("Nothing to search");
+          }
+          this._send("dashboard", "search", {
+            query,
+            contentType,
+            ...opts
+          });
+        };
+        break;
+    }
     this._load({
       redirect_url: `/conf/loading`
     });
   }
+  /**
+   * Search for thing.
+   * @param query The search query.
+   * @param options Optional, search options.
+   * @throws {Error}
+   *   - "Not implemented" when the service is not "Search".
+   *   - "Nothing to search" when the query is empty.
+   */
+  search(query, options) {
+    query;
+    options;
+    throw new Error("Not implemented");
+  }
   /**
    * Loads the service.
    * @param service the service to load.
@@ -566,5 +604,6 @@ var Livestream = class extends Widget {
   Meeting,
   MeetingAction,
   ScheduleAction,
+  SearchContentType,
   Service
 });

dist/index.js

@@ -0,0 +1,50 @@
+import typescriptEslint from '@typescript-eslint/eslint-plugin';
+import jest from 'eslint-plugin-jest';
+import prettier from 'eslint-plugin-prettier';
+import globals from 'globals';
+import tsParser from '@typescript-eslint/parser';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import js from '@eslint/js';
+import { FlatCompat } from '@eslint/eslintrc';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const compat = new FlatCompat({
+  baseDirectory: __dirname,
+  recommendedConfig: js.configs.recommended,
+  allConfig: js.configs.all,
+});
+
+/** @type {import('eslint').Linter.Config[]} */
+export default [
+  {
+    ignores: ['dist/*'],
+  },
+  ...compat.extends('eslint:recommended', 'plugin:jest/recommended'),
+  {
+    plugins: {
+      '@typescript-eslint': typescriptEslint,
+      jest,
+      prettier,
+    },
+
+    languageOptions: {
+      globals: {
+        ...globals.browser,
+        require: 'readonly',
+      },
+
+      parser: tsParser,
+    },
+
+    rules: {
+      'no-unused-vars': 'off',
+      '@typescript-eslint/no-unused-vars': 'warn',
+      'prettier/prettier': 'error',
+    },
+  },
+  {
+    files: ['src/**/*.ts'],
+  },
+];