assistant-robot 0.0.2-epsilon → 0.0.2

package/dist/type.d.ts

@@ -11,9 +11,14 @@ export interface ILanguageModelConfig<T extends LanguageModel> extends ILanguage
 export interface IOperation {
     key: string;
     text: string;
-    disable: boolean;
+    /**
+     * To mark that is this item disabled,
+     * we just add a `data-disabled` attribute to the menu item,
+     * user should implement the funtion
+     */
+    disabled: boolean;
 }
-export interface IOperationBoxBoxConfig {
+export interface IOperationBoxConfig {
     hide?: boolean;
     perationBoxClassName?: string;
     operationList?: IOperation[];
@@ -25,6 +30,10 @@ export interface IModelConfig {
     idleActionName: string;
     helloContent: string;
 }
+/**
+ * Configs for the scene of the assistant robot's 3d model.
+ * To see all default value's, look at MODEL_SCENE_CONFIG
+ */
 export interface IModelSceneConfig {
     backgroundColor: number;
     backgroundAlpha: number;
@@ -35,27 +44,42 @@ export interface IModelSceneConfig {
         position: [number, number, number];
         lookAt: [number, number, number];
     };
+    /**
+     * config of the ambient light in the scene.
+     * the light globally illuminates all objects in the scene equally.
+     */
     ambientLight: {
         color: number;
         intensity: number;
     };
+    /**
+     * config of the directional light in the scene.
+     *  A light that gets emitted in a specific direction
+     */
     directionalLight: {
         color: number;
         intensity: number;
         position: [number, number, number];
     };
 }
+/**
+ * config for the 3d render part.
+ */
 export type TRobotModelConfig = Partial<IModelSceneConfig> & {
     modelConfig?: Partial<IModelConfig>;
     modelUrl?: string;
 };
 export interface IUserDetectorConfig {
+    /**
+     * The path to where the files of the face detect model are located.
+     * If your user can not get the public one, the files can be download from there:https://github.com/ymrdf/assistant-robot/tree/main/example/public/face_detection
+     */
     solutionPath?: string;
 }
 export interface IAssistantRobotConfig<T extends LanguageModel> {
     className: string;
     languageModel: ILanguageModelConfig<T>;
-    operationBox: IOperationBoxBoxConfig;
+    operationBox: IOperationBoxConfig;
     robotModel: TRobotModelConfig;
     userDetector: IUserDetectorConfig;
 }

package/dist/{utils-u6rFqFWg.mjs → utils-FAxjgnse.mjs}

@@ -1,5 +1,5 @@
-var p = Object.defineProperty;
-var h = (t, e, o) => e in t ? p(t, e, { enumerable: !0, configurable: !0, writable: !0, value: o }) : t[e] = o;
+var c = Object.defineProperty;
+var h = (t, e, o) => e in t ? c(t, e, { enumerable: !0, configurable: !0, writable: !0, value: o }) : t[e] = o;
 var n = (t, e, o) => (h(t, typeof e != "symbol" ? e + "" : e, o), o);
 const A = 60, y = {
   position: [0, 0, 0],
@@ -83,12 +83,12 @@ const A = 60, y = {
   alreadyOpenCamera: "the camera have be opened"
 };
 var b = /* @__PURE__ */ ((t) => (t.openCamera = "openCamera", t.hello = "hello", t))(b || {});
-const x = "assistant-robot-input", u = "assistant-robot-btn", d = "assistant-robot-operation_container", c = "assistant-robot-menu_btn", r = "assistant-robot-menu_list", S = '<div class="assistant-robot-chartbox', E = `">
+const x = "assistant-robot-input", u = "assistant-robot-btn", d = "assistant-robot-operation-container", p = "assistant-robot-menu-btn", r = "assistant-robot-menu-list", S = '<div class="assistant-robot-operationbox', E = `">
 <style>
-  .assistant-robot-chartbox{
-    box-sizing: content-box;
+  .assistant-robot-operationbox{
+    box-sizing: border-box;
     width: 100%;
-    height: 32px;
+    height: 52px;
     display: flex;
     flex: 0 0 auto;
     flex-wrap: wrap;
@@ -119,8 +119,8 @@ const x = "assistant-robot-input", u = "assistant-robot-btn", d = "assistant-rob
     position: relative;
     height: 24px;
   }
-  .${c}{
-    color: #dedede;
+  .${p}{
+    color: #aaaaaa;
     width:24px;
     height: 24px;
     cursor: pointer;
@@ -159,7 +159,7 @@ const x = "assistant-robot-input", u = "assistant-robot-btn", d = "assistant-rob
 <span class="${d}">
   <svg
     t="1702017878997"
-    class="${c}"
+    class="${p}"
     viewBox="0 0 1024 1024"
     version="1.1"
     p-id="1322"
@@ -183,7 +183,7 @@ const x = "assistant-robot-input", u = "assistant-robot-btn", d = "assistant-rob
     ></path>
   </svg>
   <ul class="${r}">
-    <li data-id="openCamera">Open the Camera</li>
+    <li data-id="openCamera">eye contact</li>
 `, k = `</ul>
 </span>
 <input class="${x}" type="text" />
@@ -194,14 +194,14 @@ const $ = 50, L = 2e3;
 var g = /* @__PURE__ */ ((t) => (t.init = "init", t.ready = "ready", t.openCameraRejected = "openCameraRejected", t.userMediaUnavailable = "userMediaUnavailable", t.faceDetectorCreateError = "faceDetectorCreateError", t.error = "error", t))(g || {});
 const m = "userDetectorStatusChange";
 var O = /* @__PURE__ */ ((t) => (t.languageModelLoaded = "languageModelLoaded", t[t.userDetectorStatusChange = m] = "userDetectorStatusChange", t.menuClick = "menuClick", t.ask = "ask", t.say = "say", t))(O || {});
-function _() {
+function C() {
   return /iPhone|iPad|iPod/i.test(navigator.userAgent);
 }
-function C() {
+function T() {
   return /Android/i.test(navigator.userAgent);
 }
 function P() {
-  return C() || _();
+  return T() || C();
 }
 function B(t) {
   return new DOMParser().parseFromString(t, "text/html").body.firstElementChild;
@@ -259,7 +259,7 @@ export {
   k as e,
   u as f,
   x as g,
-  c as h,
+  p as h,
   P as i,
   r as j,
   R as k,

package/dist/{utils-ybKQi2Om.js → utils-_ulwJfGD.js}

@@ -1,4 +1,4 @@
-"use strict";var A=Object.defineProperty;var E=(t,e,o)=>e in t?A(t,e,{enumerable:!0,configurable:!0,writable:!0,value:o}):t[e]=o;var d=(t,e,o)=>(E(t,typeof e!="symbol"?e+"":e,o),o);const x={position:[0,0,0],rotation:[0,Math.PI,0],helloActionName:"hello",idleActionName:"idle",helloContent:"Hi, you can talk to me!"},f={backgroundColor:0,backgroundAlpha:0,camera:{fov:50,near:.1,far:10,position:[0,0,2],lookAt:[0,0,0]},ambientLight:{color:16777215,intensity:.5},directionalLight:{color:16777215,intensity:2,position:[10,10,0]}},C={big:{width:640,height:480},small:{width:360,height:270}},s="assistant-robot-model-container",n="assistant-robot-tip-container",I='<div class="assistant-robot-container ',N=`">
+"use strict";var A=Object.defineProperty;var E=(t,e,o)=>e in t?A(t,e,{enumerable:!0,configurable:!0,writable:!0,value:o}):t[e]=o;var d=(t,e,o)=>(E(t,typeof e!="symbol"?e+"":e,o),o);const x={position:[0,0,0],rotation:[0,Math.PI,0],helloActionName:"hello",idleActionName:"idle",helloContent:"Hi, you can talk to me!"},f={backgroundColor:0,backgroundAlpha:0,camera:{fov:50,near:.1,far:10,position:[0,0,2],lookAt:[0,0,0]},ambientLight:{color:16777215,intensity:.5},directionalLight:{color:16777215,intensity:2,position:[10,10,0]}},I={big:{width:640,height:480},small:{width:360,height:270}},s="assistant-robot-model-container",n="assistant-robot-tip-container",C='<div class="assistant-robot-container ',N=`">
   <style>
     .assistant-robot-container{
       width: 100%;
@@ -47,12 +47,12 @@
 
   </div>
 <div>
-`,g={openCamera:"To interactive with the assistant, we'd like to access your device's camera.Take it easy, your pictures and information won't be sent anywhere or be stored.",alreadyOpenCamera:"the camera have be opened"};var p=(t=>(t.openCamera="openCamera",t.hello="hello",t))(p||{});const h="assistant-robot-input",_="assistant-robot-btn",c="assistant-robot-operation_container",l="assistant-robot-menu_btn",a="assistant-robot-menu_list",m='<div class="assistant-robot-chartbox',S=`">
+`,g={openCamera:"To interactive with the assistant, we'd like to access your device's camera.Take it easy, your pictures and information won't be sent anywhere or be stored.",alreadyOpenCamera:"the camera have be opened"};var p=(t=>(t.openCamera="openCamera",t.hello="hello",t))(p||{});const O="assistant-robot-input",h="assistant-robot-btn",c="assistant-robot-operation-container",l="assistant-robot-menu-btn",a="assistant-robot-menu-list",S='<div class="assistant-robot-operationbox',m=`">
 <style>
-  .assistant-robot-chartbox{
-    box-sizing: content-box;
+  .assistant-robot-operationbox{
+    box-sizing: border-box;
     width: 100%;
-    height: 32px;
+    height: 52px;
     display: flex;
     flex: 0 0 auto;
     flex-wrap: wrap;
@@ -84,7 +84,7 @@
     height: 24px;
   }
   .${l}{
-    color: #dedede;
+    color: #aaaaaa;
     width:24px;
     height: 24px;
     cursor: pointer;
@@ -147,9 +147,9 @@
     ></path>
   </svg>
   <ul class="${a}">
-    <li data-id="openCamera">Open the Camera</li>
+    <li data-id="openCamera">eye contact</li>
 `,R=`</ul>
 </span>
-<input class="${h}" type="text" />
-<button class="${_}">ask</button>
-</div>`;var O=(t=>(t[t.loading=1]="loading",t[t.ready=2]="ready",t[t.error=3]="error",t))(O||{});const y=50,L=2e3;var T=(t=>(t.init="init",t.ready="ready",t.openCameraRejected="openCameraRejected",t.userMediaUnavailable="userMediaUnavailable",t.faceDetectorCreateError="faceDetectorCreateError",t.error="error",t))(T||{});const u="userDetectorStatusChange";var b=(t=>(t.languageModelLoaded="languageModelLoaded",t[t.userDetectorStatusChange=u]="userDetectorStatusChange",t.menuClick="menuClick",t.ask="ask",t.say="say",t))(b||{});function v(){return/iPhone|iPad|iPod/i.test(navigator.userAgent)}function B(){return/Android/i.test(navigator.userAgent)}function D(){return B()||v()}function w(t){return new DOMParser().parseFromString(t,"text/html").body.firstElementChild}function M(t){if(!Array.isArray(t)||t.length===0)return null;let e=-1/0,o=null;for(let i=0;i<t.length;i++){const r=t[i];r&&typeof r.score=="number"&&r.score>e&&(e=r.score,o=r)}return o}class P{constructor(){d(this,"listeners",{})}addEventListener(e,o){this.listeners[e]?this.get(e).push(o):this.listeners[e]=[o]}removeEventListener(e,o){this.listeners[e]&&(this.listeners[e]=this.get(e).filter(i=>i!==o))}emit(e,...o){this.get(e).map(i=>{i(...o)})}get(e){return this.listeners[e]||[]}}function k(t,e){for(;t.firstChild;)t.removeChild(t.firstChild);t.appendChild(e)}exports.ASSISTANT_MODEL_CONTAINER_CLASS=s;exports.ASSISTANT_TIP_CONTAINER=n;exports.CONTAINER_BODY=N;exports.CONTAINER_HEAD=I;exports.EAssistantEvent=b;exports.ELanguageModelStatus=O;exports.EMenuKey=p;exports.EUserDetectorStatus=T;exports.EventListener=P;exports.MENU_BTN_CLASS=l;exports.MENU_LIST_CLASS=a;exports.MODEL_CONFIG=x;exports.MODEL_SCENE_CONFIG=f;exports.ONE_LETTER_READ_TIME=y;exports.READ_WAIT_TIME=L;exports.ROBOT_OPERATION_BOX_BODY=S;exports.ROBOT_OPERATION_BOX_HEAD=m;exports.ROBOT_OPERATION_BOX_TAIL=R;exports.ROBOT_OPERATION_BTN_CLASS=_;exports.ROBOT_OPERATION_INPUT_CLASS=h;exports.TARGET_FPS=60;exports.USER_DETECTOR_STATUS_CHANGE_EVENT=u;exports.VIDEO_SIZE=C;exports.findHighestScoreItem=M;exports.isMobile=D;exports.parseHTML=w;exports.replaceChildren=k;exports.tips=g;
+<input class="${O}" type="text" />
+<button class="${h}">ask</button>
+</div>`;var _=(t=>(t[t.loading=1]="loading",t[t.ready=2]="ready",t[t.error=3]="error",t))(_||{});const y=50,L=2e3;var T=(t=>(t.init="init",t.ready="ready",t.openCameraRejected="openCameraRejected",t.userMediaUnavailable="userMediaUnavailable",t.faceDetectorCreateError="faceDetectorCreateError",t.error="error",t))(T||{});const b="userDetectorStatusChange";var u=(t=>(t.languageModelLoaded="languageModelLoaded",t[t.userDetectorStatusChange=b]="userDetectorStatusChange",t.menuClick="menuClick",t.ask="ask",t.say="say",t))(u||{});function v(){return/iPhone|iPad|iPod/i.test(navigator.userAgent)}function B(){return/Android/i.test(navigator.userAgent)}function D(){return B()||v()}function w(t){return new DOMParser().parseFromString(t,"text/html").body.firstElementChild}function M(t){if(!Array.isArray(t)||t.length===0)return null;let e=-1/0,o=null;for(let i=0;i<t.length;i++){const r=t[i];r&&typeof r.score=="number"&&r.score>e&&(e=r.score,o=r)}return o}class P{constructor(){d(this,"listeners",{})}addEventListener(e,o){this.listeners[e]?this.get(e).push(o):this.listeners[e]=[o]}removeEventListener(e,o){this.listeners[e]&&(this.listeners[e]=this.get(e).filter(i=>i!==o))}emit(e,...o){this.get(e).map(i=>{i(...o)})}get(e){return this.listeners[e]||[]}}function k(t,e){for(;t.firstChild;)t.removeChild(t.firstChild);t.appendChild(e)}exports.ASSISTANT_MODEL_CONTAINER_CLASS=s;exports.ASSISTANT_TIP_CONTAINER=n;exports.CONTAINER_BODY=N;exports.CONTAINER_HEAD=C;exports.EAssistantEvent=u;exports.ELanguageModelStatus=_;exports.EMenuKey=p;exports.EUserDetectorStatus=T;exports.EventListener=P;exports.MENU_BTN_CLASS=l;exports.MENU_LIST_CLASS=a;exports.MODEL_CONFIG=x;exports.MODEL_SCENE_CONFIG=f;exports.ONE_LETTER_READ_TIME=y;exports.READ_WAIT_TIME=L;exports.ROBOT_OPERATION_BOX_BODY=m;exports.ROBOT_OPERATION_BOX_HEAD=S;exports.ROBOT_OPERATION_BOX_TAIL=R;exports.ROBOT_OPERATION_BTN_CLASS=h;exports.ROBOT_OPERATION_INPUT_CLASS=O;exports.TARGET_FPS=60;exports.USER_DETECTOR_STATUS_CHANGE_EVENT=b;exports.VIDEO_SIZE=I;exports.findHighestScoreItem=M;exports.isMobile=D;exports.parseHTML=w;exports.replaceChildren=k;exports.tips=g;

package/dist/utils.d.ts

@@ -1,10 +1,18 @@
-import { TEventListenFunc } from "./type";
 import type { Answer } from "@tensorflow-models/qna/dist/question_and_answer";
+import { TEventListenFunc } from "./type";
 export declare function isiOS(): boolean;
 export declare function isAndroid(): boolean;
 export declare function isMobile(): boolean;
+/**
+ * turn a html string to dom
+ * @param htmlString  a html string
+ * @returns a dom tree
+ */
 export declare function parseHTML(htmlString: string): Element | null;
 export declare function findHighestScoreItem(data: Answer[]): Answer | null;
+/**
+ * utils class which implement Observer Pattern
+ */
 export declare class EventListener {
     private listeners;
     addEventListener(name: string, func: TEventListenFunc): void;
@@ -12,4 +20,9 @@ export declare class EventListener {
     emit(event: string, ...args: any[]): void;
     get(name: string): TEventListenFunc[];
 }
+/**
+ * to replace all children of parentNode to a new node
+ * @param parentNode the pareent node
+ * @param newNode the child node will insert to the parent node
+ */
 export declare function replaceChildren(parentNode: Node, newNode: Node): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "assistant-robot",
-  "version": "0.0.2-epsilon",
+  "version": "0.0.2",
   "description": "An assistant widget, have a 3D robot which can interact with user, have a simple LLM which can chat with user.",
   "main": "dist/index.js",
   "module": "dist/index.mjs",