assistant-robot 0.0.2-gamma → 0.0.2

package/dist/Assistant.d.ts

@@ -5,18 +5,35 @@ import { EUserDetectorStatus } from "./constants";
 import { EventListener } from "./utils";
 import type { LanguageModel } from "./LanguageModel";
 import type { IAssistantRobotConfig, IActionConfig } from "./type";
+/**
+ * the main class of the assistant robot.
+ * After the class is instantiated, a fill funtion assistant robot will be show on the page.
+ */
 export declare class Assistant<T extends LanguageModel> extends EventListener {
     assistantModel: AssistantModel;
     userDetector: UserDetector;
-    questionManager: OperationManager | undefined;
+    operationManager: OperationManager | undefined;
     languageModel: T;
     options: IAssistantRobotConfig<T>;
     constructor(el: Element, options: IAssistantRobotConfig<T>);
     handleLanguageModelLoad: () => void;
     handleUserDetectorStatusChange: (status: EUserDetectorStatus) => void;
     onMenuClick: (key: string) => void;
+    /**
+     * ask the assistant robot a question
+     * @param question question go ask
+     */
     ask: (question: string) => Promise<void>;
+    /**
+     * make the robot say something
+     * @param text what the robot should say
+     */
     assistantSay(text: string): void;
+    /**
+     * make the robot play a action
+     * @param name name of the action
+     * @param config config of the action
+     */
     assistantPlay(name: string, config?: IActionConfig): void;
     lookAtUser(): Promise<void>;
 }

package/dist/AssistantModel.d.ts

@@ -1,5 +1,10 @@
 import { PerspectiveCamera, Scene, WebGL1Renderer, Object3D, AnimationMixer, AnimationClip, AnimationAction, Clock } from "three";
 import type { TRobotModelConfig, IModelConfig, IActionConfig } from "./type";
+/**
+ * assistant robot's 3d model manager.
+ * include the inition of the scene and the 3d model.
+ * include the methods to make the 3d model play an action or speek something
+ */
 export declare class AssistantModel {
     clock: Clock;
     container: Element;
@@ -14,14 +19,41 @@ export declare class AssistantModel {
     options: TRobotModelConfig;
     idleAction: AnimationAction | undefined;
     constructor(container: Element, options: TRobotModelConfig);
+    /**
+     * init the 3d scene an 3d model for the robot
+     * @param options configs
+     */
     init(options?: TRobotModelConfig): void;
+    /**
+     * to load the 3d model
+     * @param modelUrl  the url to load 3d model, default to use MR Potato
+     * @param param1 the config for the 3d model
+     */
     loadModel(modelUrl: string, { position, rotation }?: Partial<IModelConfig>): void;
     startIdleAction(): void;
-    haltIdleAction(durationInSeconds: number): void;
+    /**
+     * halt idle action
+     * @param duration how long time to halt
+     */
+    haltIdleAction(duration: number): void;
     hello(): void;
+    /**
+     * make the robot play a action
+     * @param name name of the action
+     * @param config config of the action
+     */
     play(name: string, { loop, weight, timeScale, repetitions, }?: IActionConfig): void;
     hideTip(): void;
+    /**
+     * make the robot say something
+     * @param text what the robot should say
+     */
     say(text: string): void;
     animate(): void;
+    /**
+     * make the robot rotate
+     * @param x the rotate angle on x axis
+     * @param y the rotate angle on y axis
+     */
     rotate(x?: number, y?: number): void;
 }

package/dist/LanguageModel.d.ts

@@ -4,6 +4,10 @@ import "@tensorflow/tfjs-backend-cpu";
 import "@tensorflow/tfjs-backend-webgl";
 import { ELanguageModelStatus } from "./constants";
 import type { TCallback, ILanguageModelOptions } from "./type";
+/**
+ * the abstract class to use a language model.
+ * The language model manager should to extend this class to used in the assistant.
+ */
 export declare abstract class LanguageModel {
     status: ELanguageModelStatus;
     onLoadList: TCallback[];
@@ -13,11 +17,21 @@ export declare abstract class LanguageModel {
     abstract findAnswers(question: string): Promise<string>;
     constructor();
 }
+/**
+ * The default language model implementation to used in assistant robot.
+ * It used mobile bert(https://openreview.net/forum?id=SJxjVaNKwB).
+ * It is faster and smaller, but it's not very good.
+ */
 export declare class MobileBertModel extends LanguageModel {
     passage: string;
     modelUrl: string;
     model: QuestionAndAnswer | undefined;
     constructor({ passage, modelUrl }: ILanguageModelOptions);
     init(): Promise<void>;
+    /**
+     * ask model question
+     * @param question question to ask
+     * @returns answer of the question
+     */
     findAnswers(question: string): Promise<string>;
 }

package/dist/LanguageModel.js

@@ -1 +1 @@
-"use strict";var l=Object.defineProperty;var d=(s,t,e)=>t in s?l(s,t,{enumerable:!0,configurable:!0,writable:!0,value:e}):s[t]=e;var a=(s,t,e)=>(d(s,typeof t!="symbol"?t+"":t,e),e);Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const u=require("@tensorflow-models/qna");require("@tensorflow/tfjs-core");require("@tensorflow/tfjs-backend-cpu");require("@tensorflow/tfjs-backend-webgl");const r=require("./utils-DoHpdGms.js");function c(s){const t=Object.create(null,{[Symbol.toStringTag]:{value:"Module"}});if(s){for(const e in s)if(e!=="default"){const o=Object.getOwnPropertyDescriptor(s,e);Object.defineProperty(t,e,o.get?o:{enumerable:!0,get:()=>s[e]})}}return t.default=s,Object.freeze(t)}const g=c(u);class i{constructor(){a(this,"status",r.ELanguageModelStatus.loading);a(this,"onLoadList",[])}loaded(){this.status=r.ELanguageModelStatus.ready,this.onLoadList.forEach(t=>t())}onLoad(t){this.onLoadList.push(t)}removeLoadCb(t){this.onLoadList=this.onLoadList.filter(e=>e!=t)}}class h extends i{constructor({passage:e,modelUrl:o}){super();a(this,"passage");a(this,"modelUrl");a(this,"model");this.passage=e,this.modelUrl=o,this.init()}async init(){this.status=r.ELanguageModelStatus.loading;try{const e=this.modelUrl?{modelUrl:this.modelUrl}:void 0;this.model=await g.load(e),this.loaded()}catch(e){console.warn(e),this.status=r.ELanguageModelStatus.error}}async findAnswers(e){if(this.model){const o=await this.model.findAnswers(e,this.passage),n=r.findHighestScoreItem(o);return n?n.text:""}return""}}exports.LanguageModel=i;exports.MobileBertModel=h;
+"use strict";var l=Object.defineProperty;var d=(s,t,e)=>t in s?l(s,t,{enumerable:!0,configurable:!0,writable:!0,value:e}):s[t]=e;var a=(s,t,e)=>(d(s,typeof t!="symbol"?t+"":t,e),e);Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const u=require("@tensorflow-models/qna");require("@tensorflow/tfjs-core");require("@tensorflow/tfjs-backend-cpu");require("@tensorflow/tfjs-backend-webgl");const r=require("./utils-_ulwJfGD.js");function c(s){const t=Object.create(null,{[Symbol.toStringTag]:{value:"Module"}});if(s){for(const e in s)if(e!=="default"){const o=Object.getOwnPropertyDescriptor(s,e);Object.defineProperty(t,e,o.get?o:{enumerable:!0,get:()=>s[e]})}}return t.default=s,Object.freeze(t)}const g=c(u);class i{constructor(){a(this,"status",r.ELanguageModelStatus.loading);a(this,"onLoadList",[])}loaded(){this.status=r.ELanguageModelStatus.ready,this.onLoadList.forEach(t=>t())}onLoad(t){this.onLoadList.push(t)}removeLoadCb(t){this.onLoadList=this.onLoadList.filter(e=>e!=t)}}class h extends i{constructor({passage:e,modelUrl:o}){super();a(this,"passage");a(this,"modelUrl");a(this,"model");this.passage=e,this.modelUrl=o,this.init()}async init(){this.status=r.ELanguageModelStatus.loading;try{const e=this.modelUrl?{modelUrl:this.modelUrl}:void 0;this.model=await g.load(e),this.loaded()}catch(e){console.warn(e),this.status=r.ELanguageModelStatus.error}}async findAnswers(e){if(this.model){const o=await this.model.findAnswers(e,this.passage),n=r.findHighestScoreItem(o);return n?n.text:""}return""}}exports.LanguageModel=i;exports.MobileBertModel=h;

package/dist/LanguageModel.mjs

@@ -5,7 +5,7 @@ import * as l from "@tensorflow-models/qna";
 import "@tensorflow/tfjs-core";
 import "@tensorflow/tfjs-backend-cpu";
 import "@tensorflow/tfjs-backend-webgl";
-import { o as i, q as h } from "./utils-W4yhvT2-.mjs";
+import { o as i, q as h } from "./utils-FAxjgnse.mjs";
 class m {
   constructor() {
     a(this, "status", i.loading);
@@ -24,11 +24,15 @@ class m {
 class f extends m {
   constructor({ passage: s, modelUrl: e }) {
     super();
+    // The content to extract answers from.
     a(this, "passage");
+    // specifies custom url of the model. This is useful for area/countries that don't have access to the model hosted on GCP.
     a(this, "modelUrl");
+    // the real language model
     a(this, "model");
     this.passage = s, this.modelUrl = e, this.init();
   }
+  // to load real language model
   async init() {
     this.status = i.loading;
     try {
@@ -38,6 +42,11 @@ class f extends m {
       console.warn(s), this.status = i.error;
     }
   }
+  /**
+   * ask model question
+   * @param question question to ask
+   * @returns answer of the question
+   */
   async findAnswers(s) {
     if (this.model) {
       const e = await this.model.findAnswers(s, this.passage), r = h(e);

package/dist/OperationManager.d.ts

@@ -1,4 +1,9 @@
-import { IOperationBoxBoxConfig } from "./type";
+import { IOperationBoxConfig } from "./type";
+/**
+ * the manager to manage the operation of assistant robot.
+ * include the operation box's render.
+ * include the operation's implementation.
+ */
 export declare class OperationManager {
     btnDom: HTMLButtonElement | undefined;
     inputDom: HTMLInputElement | undefined;
@@ -6,7 +11,7 @@ export declare class OperationManager {
     menuDom: HTMLElement | undefined;
     onAsk: (question: string) => void;
     onMenuClick: (key: string) => void;
-    constructor(container: Element, onAsk: (question: string) => void, onMenuClick: (key: string) => void, options?: IOperationBoxBoxConfig);
-    initChatBox(container: Element, options?: IOperationBoxBoxConfig): void;
+    constructor(container: Element, onAsk: (question: string) => void, onMenuClick: (key: string) => void, options?: IOperationBoxConfig);
+    initOperationBox(container: Element, options?: IOperationBoxConfig): void;
     addEventListener(): void;
 }

package/dist/UserDetector.d.ts

@@ -3,6 +3,9 @@ import type { FaceDetector } from "@tensorflow-models/face-detection";
 import { EUserDetectorStatus } from "./constants";
 import { EventListener } from "./utils";
 import { IUserDetectorConfig } from "./type";
+/**
+ * user detect module.open the camera to detect the user's face.
+ */
 export declare class UserDetector extends EventListener {
     video: HTMLVideoElement;
     detector: FaceDetector | undefined;
@@ -11,6 +14,7 @@ export declare class UserDetector extends EventListener {
     options: IUserDetectorConfig;
     status: EUserDetectorStatus;
     constructor(options?: IUserDetectorConfig);
+    init(): void;
     initVideo(): Promise<void>;
     createDetector(): Promise<void>;
     getFaces(): Promise<faceDetection.Face[]>;

package/dist/constants.d.ts

@@ -13,9 +13,9 @@ export declare const VIDEO_SIZE: {
     };
 };
 export declare const ASSISTANT_MODEL_CONTAINER_CLASS = "assistant-robot-model-container";
-export declare const ASSISTANT_TIP_CONTAINER = "assistant_tip_container";
+export declare const ASSISTANT_TIP_CONTAINER = "assistant-robot-tip-container";
 export declare const CONTAINER_HEAD = "<div class=\"assistant-robot-container ";
-export declare const CONTAINER_BODY = "\">\n  <style>\n    .assistant-robot-container{\n      width: 100%;\n      height: 100%;\n      display: flex;\n      flex-direction: column;\n    }\n    .assistant-robot-model-container{\n      flex: 1;\n      position:relative;\n      width:100%;\n    }\n    .assistant_tip_container{\n      position: absolute;\n      top: 2px;\n      left: 50%;\n      min-width: 100px;\n      border: 1px solid #aaaaaa;\n      border-radius: 6px;\n      background: #fff;\n      transform: translate(-50%);\n      padding: 12px 20px;\n      text-align: center;\n      animation: fadeInOut 0.4s ease-in-out;\n    }\n    @keyframes fadeInOut {\n      0% { opacity: 0; }\n      100% { opacity: 1; }\n    }\n    .assistant_tip_container::after{\n      content: '';\n      display: block;\n      position: absolute;\n      bottom: -6px;\n      left: 50%;\n      width: 8px;\n      height: 8px;\n      transform: rotate(45deg);\n      border-bottom: 1px solid #aaaaaa;\n      border-right: 1px solid #aaaaaa;\n      background: #fff;\n    }\n  </style>\n  <div class=\"assistant-robot-model-container\">\n    <div class=\"assistant_tip_container\">HI!</div>\n\n  </div>\n<div>\n";
+export declare const CONTAINER_BODY = "\">\n  <style>\n    .assistant-robot-container{\n      width: 100%;\n      height: 100%;\n      display: flex;\n      flex-direction: column;\n    }\n    .assistant-robot-model-container{\n      flex: 1;\n      position:relative;\n      width:100%;\n    }\n    .assistant-robot-tip-container{\n      position: absolute;\n      top: 2px;\n      left: 50%;\n      min-width: 100px;\n      border: 1px solid #aaaaaa;\n      border-radius: 6px;\n      background: #fff;\n      transform: translate(-50%);\n      padding: 12px 20px;\n      text-align: center;\n      animation: fadeInOut 0.4s ease-in-out;\n    }\n    @keyframes fadeInOut {\n      0% { opacity: 0; }\n      100% { opacity: 1; }\n    }\n    .assistant-robot-tip-container::after{\n      content: '';\n      display: block;\n      position: absolute;\n      bottom: -6px;\n      left: 50%;\n      width: 8px;\n      height: 8px;\n      transform: rotate(45deg);\n      border-bottom: 1px solid #aaaaaa;\n      border-right: 1px solid #aaaaaa;\n      background: #fff;\n    }\n  </style>\n  <div class=\"assistant-robot-model-container\">\n    <div class=\"assistant-robot-tip-container\">HI!</div>\n\n  </div>\n<div>\n";
 export declare const tips: {
     openCamera: string;
     alreadyOpenCamera: string;
@@ -26,11 +26,11 @@ export declare enum EMenuKey {
 }
 export declare const ROBOT_OPERATION_INPUT_CLASS = "assistant-robot-input";
 export declare const ROBOT_OPERATION_BTN_CLASS = "assistant-robot-btn";
-export declare const OPERATION_CONTAINER_CLASS = "operation_container";
-export declare const MENU_BTN_CLASS = "menu_btn";
-export declare const MENU_LIST_CLASS = "menu_list";
-export declare const ROBOT_OPERATION_BOX_HEAD = "<div class=\"assistant-robot-chartbox";
-export declare const ROBOT_OPERATION_BOX_BODY = "\">\n<style>\n  .assistant-robot-chartbox{\n    box-sizing: content-box;\n    width: 100%;\n    height: 32px;\n    display: flex;\n    flex: 0 0 auto;\n    flex-wrap: wrap;\n    align-items: center;\n    border-radius: 54px;\n    box-shadow: 0 1px 2px -2px rgba(0, 0, 0, 0.16),\n    0 3px 6px 0 rgba(0, 0, 0, 0.12),\n    0 5px 12px 4px rgba(0, 0, 0, 0.09);\n    background-color: #fff;\n    padding: 10px 12px;\n  }\n  .assistant-robot-input{\n    flex: 1;\n    min-width: 200px;\n    background: rgba(0,0,0,0);\n    border: 1px solid #dedede;\n    height: 28px;\n    margin-right: 6px;\n    outline:none;\n    color: #666666;\n  }\n  .assistant-robot-btn{\n    flex: 0 0 auto;\n    height: 24px;\n  }\n\n  .operation_container{\n    position: relative;\n    height: 24px;\n  }\n  .menu_btn{\n    color: #dedede;\n    width:24px;\n    height: 24px;\n    cursor: pointer;\n  }\n\n  .menu_list {\n    display: none;\n    position: absolute;\n    top: 30px;\n    left: 0px;\n    background-color: #fff;\n    border: 1px solid #ccc;\n    box-shadow: 0 2px 5px rgba(0, 0, 0, 0.1);\n    padding: 10px;\n    border-radius: 5px;\n    animation: fadeInOut 0.4s ease-in-out;\n    list-style: none;\n  }\n\n  .menu_list li{\n    line-height: 32px;\n    text-wrap: nowrap;\n    border-bottom: 1px solid #dedede;\n    cursor: pointer;\n  }\n\n  .menu_list li:last-child{\n    border-bottom: none;\n  }\n\n  @keyframes fadeInOut {\n    0% { opacity: 0; }\n    100% { opacity: 1; }\n  }\n</style>\n<span class=\"operation_container\">\n  <svg\n    t=\"1702017878997\"\n    class=\"menu_btn\"\n    viewBox=\"0 0 1024 1024\"\n    version=\"1.1\"\n    p-id=\"1322\"\n    width=\"32\"\n    height=\"32\"\n    >\n    <path\n      d=\"M512 512m-116.949333 0a116.949333 116.949333 0 1 0 233.898666 0 116.949333 116.949333 0 1 0-233.898666 0Z\"\n      fill=\"currentColor\"\n      p-id=\"1323\"\n    ></path>\n    <path\n      d=\"M512 159.616m-116.949333 0a116.949333 116.949333 0 1 0 233.898666 0 116.949333 116.949333 0 1 0-233.898666 0Z\"\n      fill=\"currentColor\"\n      p-id=\"1324\"\n    ></path>\n    <path\n      d=\"M512 864.384m-116.949333 0a116.949333 116.949333 0 1 0 233.898666 0 116.949333 116.949333 0 1 0-233.898666 0Z\"\n      fill=\"currentColor\"\n      p-id=\"1325\"\n    ></path>\n  </svg>\n  <ul class=\"menu_list\">\n    <li data-id=\"openCamera\">Open the Camera</li>\n";
+export declare const OPERATION_CONTAINER_CLASS = "assistant-robot-operation-container";
+export declare const MENU_BTN_CLASS = "assistant-robot-menu-btn";
+export declare const MENU_LIST_CLASS = "assistant-robot-menu-list";
+export declare const ROBOT_OPERATION_BOX_HEAD = "<div class=\"assistant-robot-operationbox";
+export declare const ROBOT_OPERATION_BOX_BODY = "\">\n<style>\n  .assistant-robot-operationbox{\n    box-sizing: border-box;\n    width: 100%;\n    height: 52px;\n    display: flex;\n    flex: 0 0 auto;\n    flex-wrap: wrap;\n    align-items: center;\n    border-radius: 54px;\n    box-shadow: 0 1px 2px -2px rgba(0, 0, 0, 0.16),\n    0 3px 6px 0 rgba(0, 0, 0, 0.12),\n    0 5px 12px 4px rgba(0, 0, 0, 0.09);\n    background-color: #fff;\n    padding: 10px 12px;\n  }\n  .assistant-robot-input{\n    flex: 1;\n    min-width: 200px;\n    background: rgba(0,0,0,0);\n    border: 1px solid #dedede;\n    height: 28px;\n    margin-right: 6px;\n    outline:none;\n    color: #666666;\n  }\n  .assistant-robot-btn{\n    flex: 0 0 auto;\n    height: 24px;\n  }\n\n  .assistant-robot-operation-container{\n    position: relative;\n    height: 24px;\n  }\n  .assistant-robot-menu-btn{\n    color: #aaaaaa;\n    width:24px;\n    height: 24px;\n    cursor: pointer;\n  }\n\n  .assistant-robot-menu-list {\n    display: none;\n    position: absolute;\n    top: 30px;\n    left: 0px;\n    background-color: #fff;\n    border: 1px solid #ccc;\n    box-shadow: 0 2px 5px rgba(0, 0, 0, 0.1);\n    padding: 10px;\n    border-radius: 5px;\n    animation: fadeInOut 0.4s ease-in-out;\n    list-style: none;\n  }\n\n  .assistant-robot-menu-list li{\n    line-height: 32px;\n    text-wrap: nowrap;\n    border-bottom: 1px solid #dedede;\n    cursor: pointer;\n  }\n\n  .assistant-robot-menu-list li:last-child{\n    border-bottom: none;\n  }\n\n  @keyframes fadeInOut {\n    0% { opacity: 0; }\n    100% { opacity: 1; }\n  }\n</style>\n<span class=\"assistant-robot-operation-container\">\n  <svg\n    t=\"1702017878997\"\n    class=\"assistant-robot-menu-btn\"\n    viewBox=\"0 0 1024 1024\"\n    version=\"1.1\"\n    p-id=\"1322\"\n    width=\"32\"\n    height=\"32\"\n    >\n    <path\n      d=\"M512 512m-116.949333 0a116.949333 116.949333 0 1 0 233.898666 0 116.949333 116.949333 0 1 0-233.898666 0Z\"\n      fill=\"currentColor\"\n      p-id=\"1323\"\n    ></path>\n    <path\n      d=\"M512 159.616m-116.949333 0a116.949333 116.949333 0 1 0 233.898666 0 116.949333 116.949333 0 1 0-233.898666 0Z\"\n      fill=\"currentColor\"\n      p-id=\"1324\"\n    ></path>\n    <path\n      d=\"M512 864.384m-116.949333 0a116.949333 116.949333 0 1 0 233.898666 0 116.949333 116.949333 0 1 0-233.898666 0Z\"\n      fill=\"currentColor\"\n      p-id=\"1325\"\n    ></path>\n  </svg>\n  <ul class=\"assistant-robot-menu-list\">\n    <li data-id=\"openCamera\">eye contact</li>\n";
 export declare const ROBOT_OPERATION_BOX_TAIL = "</ul>\n</span>\n<input class=\"assistant-robot-input\" type=\"text\" />\n<button class=\"assistant-robot-btn\">ask</button>\n</div>";
 export declare enum ELanguageModelStatus {
     loading = 1,