initial commit

docs/plugins/ActionPlugin.js

@@ -0,0 +1,6 @@
+/**
+ * Installs the Action API, which can be found in the "jibo-action-system" module
+ * @class ActionPlugin
+ * @implements Plugin
+ * @private
+ */

docs/plugins/AnimDBPlugin.js

@@ -0,0 +1,6 @@
+/**
+ * Installs the AnimDB API, which can be found in the "jibo-anim-db" module
+ * @class AnimDBPlugin
+ * @implements Plugin
+ * @private
+ */

docs/plugins/AutobotPlugin.js

@@ -0,0 +1,6 @@
+/**
+ * Installs the Autobot API
+ * @class AutobotPlugin
+ * @implements Plugin
+ * @private
+ */

docs/plugins/DevShellPlugin.js

@@ -0,0 +1,13 @@
+/**
+ * Jibo plugin designed to communicate with the DevShell service, if it's running
+ * in int-developer or developer mode
+ * @class DevShell
+ * @extends EventEmitter
+ * @implements Plugin
+ * @private
+ */
+
+    /**
+     * Called from skills manager
+     * @param command
+     */

docs/plugins/EmbodiedPlugin.js

@@ -0,0 +1,6 @@
+/**
+ * Installs the Embodied API, which can be found in the "jibo-embodied-dialog" module
+ * @class EmbodiedPlugin
+ * @implements Plugin
+ * @private
+ */

docs/plugins/EmotionPlugin.js

@@ -0,0 +1,6 @@
+/**
+ * Installs the Emotion API, which can be found in the "jibo-emotion-system" module
+ * @class Emotion
+ * @implements Plugin
+ * @private
+ */

docs/plugins/ExpressionPlugin.js

@@ -0,0 +1,6 @@
+/**
+ * Installs the DOF Arbiter API, which can be found in the "jibo-dof-arbiter" module
+ * @class DOFArbiterPlugin
+ * @implements Plugin
+ * @private
+ */

docs/plugins/FontsPlugin.js

@@ -0,0 +1,3 @@
+/**
+ * Preload the fonts needed for GUI
+ */

docs/plugins/InteractionMemoryPlugin.js

@@ -0,0 +1,6 @@
+/**
+ * Installs the interaction memory API, which can be found in the "jibo-interaction-memory" module
+ * @class InteractionMemoryPlugin
+ * @implements Plugin
+ * @private
+ */

docs/plugins/Lifecycle.js

@@ -0,0 +1,18 @@
+/**
+ * Jibo plugin designed to communicate with Skills Service Manager
+ * mainly to dispatch events when shutting down, initializing or showing
+ * the current jibo skill. Available on `jibo.lifecycle`
+ * @class LifeCycle
+ * @extends EventEmitter
+ * @implements Plugin
+ * @private
+ */
+
+    /**
+     * Call when skill is done and wants to exit
+     */
+
+    /**
+     * Called from skills manager
+     * @param command
+     */

docs/plugins/LocationPlugin.js

@@ -0,0 +1,6 @@
+/**
+ * Initializes Jibo's location data
+ * @class LocationPlugin
+ * @implements Plugin
+ * @private
+ */

docs/plugins/MediaPlugin.js

@@ -0,0 +1,6 @@
+/**
+ * Installs the Media API
+ * @class MediaPlugin
+ * @implements Plugin
+ * @private
+ */

docs/plugins/RegistryPlugin.js

@@ -0,0 +1,3 @@
+/**
+ * Fetch the registry host from the IPC host
+ */

docs/plugins/RenderingPlugin.js

@@ -0,0 +1,3 @@
+/**
+ * Registers tasks with the loader related to rendering
+ */

docs/plugins/ServiceRecordsPlugin.js

@@ -0,0 +1,3 @@
+/**
+ * Fetch the list of services from the registry
+ */

docs/plugins/ServicesPlugin.js

@@ -0,0 +1,11 @@
+/**
+ * Init all the clients on the `jibo` object for the running services
+ * as listed in the services registry.
+ */
+
+        /**
+         * The map of service calls to init. The key must match the
+         * name of the service as found in the registry. If the
+         * service isn't currently running (and thus not listed in the
+         * registry), then the client will not be inited.
+         */

docs/plugins/VersionsPlugin.js

@@ -0,0 +1,68 @@
+/**
+ * Versions for ssm, platform, jibo.
+ * @namespace jibo.versions
+ */
+
+    /**
+     * The current version of the jibo API.
+     * @name jibo.versions#jibo
+     * @type {String}
+     */
+
+    /**
+     * The current version of skills-service-manager.
+     * @name jibo.versions#ssm
+     * @type {String}
+     */
+
+    /**
+     * The content of the current jibo's package.json.
+     * @name jibo.versions#platform
+     * @type {String}
+     */
+
+    /**
+     * The full-stack release number of this Jibo's software
+     * @name jibo.versions#release
+     * @type {String}
+     */
+
+    /**
+     * The current version of platform.
+     * @name jibo.versions#_packageInfo
+     * @type {Object}
+     * @private
+     */
+
+    /**
+     * Initializes the versions API.
+     * @private
+     * @param {Function} done Callback when completed.
+     */
+
+    /**
+     * Check to see if the current version is supported on this platform.
+     * @method jibo.versions#supported
+     * @param {String} currentPlatformVersion The current platform version.
+     * @return {Boolean} `true` if this `jibo` supports the current platform version.
+     */
+
+    /**
+     * The Semver on the platform needed to run this `jibo`.
+     * @name jibo.versions#requiresPlatform
+     * @type {String}
+     */
+
+    /**
+     * The content of the current jibo's `package.json`.
+     * @name jibo.versions#packageInfo
+     * @type {Object}
+     */
+
+    /**
+     * Internally get the SSM version.
+     * @method jibo.versions#_getSSMVersion
+     * @private
+     * @param {Object} service Current service object for skils.
+     * @param {Function} done Callback when complete.
+     */

docs/plugins/VolumePlugin.js

@@ -0,0 +1,6 @@
+/**
+ * @class VolumePlugin
+ * @extends EventEmitter
+ * @implements Plugin
+ * @private
+ */

docs/plugins/context/ContextPlugin.js

@@ -0,0 +1,7 @@
+/**
+ * Installs the Context Service API, which can be found in services/context
+ * @class ContextPlugin
+ * @implements Plugin
+ * @memberof jibo
+ * @private
+ */

docs/plugins/context/ContextProvider.js

@@ -0,0 +1,28 @@
+/**
+ * @description
+ * Context Service for providing on-robot context for cloud and related components.
+ *
+ * @namespace jibo.context
+ */
+
+    /**
+     * Updates the Skill portion of the Context with CloudSkill data from The Hub
+     * @param {jibo.context.SkillData} skill - SkillData provided from the CloudSkill
+     */
+
+    /**
+     * Resets the Skill portion of the Context back to default empty state.
+     */
+
+    /**
+     * Compile on-robot and active cloud skill (if any) context
+     * @param {jibo.jetstream.types.HubSpeakerRecogResults} [speakers] - List of speakers we've confidently ID'd.
+     * @param {boolean} [omitLoop=false] - `true` if you would like users/Jibo omitted from the LoopContext
+     * @returns {Promise<jibo.context.Context>}
+     */
+
+    /**
+     * Retrieves all relevant Loop member information.
+     * @returns {Promise<jibo.context.LoopContext>}
+     * @private
+     */

docs/plugins/context/api.js

@@ -0,0 +1,138 @@
+/**
+ * Enum of Jibo's colors.
+ * @typedef jibo.context.JiboColor
+ * @prop BLACK {string} 'BLACK'
+ * @prop WHITE {string} 'WHITE'
+ */
+
+/**
+ * Data provided about a given Loop member.
+ * @memberof jibo.context
+ * @interface LooperInfo
+ * @property {string} firstName - Loop member's first name.
+ * @property {string} lastName - Loop member's last name.
+ * @property {string} phoneticName - Loop member's phonetic name.
+ * @property {string} gender - Loop member's gender.
+ * @property {number} birthdate - Unix epoch timestamp.
+ * @property {string} id - Loop member's id in loop.
+ * @property {string} accountId - Loop member's account id (across loops).
+ */
+
+/**
+ * Data provided about Jibo himself.
+ * @memberof jibo.context
+ * @interface JiboInfo
+ * @property {jibo.context.JiboColor} color - Jibo's color.
+ * @property {number} birthdate - Unix epoch timestamp.
+ * @property {string} id - Loop member's id in loop.
+ */
+
+/**
+ * Data provided about the Loop and members of it.
+ * @memberof jibo.context
+ * @interface LoopContext
+ * @property {jibo.context.LooperInfo[]} users - Information about every Loop member (except Jibo).
+ * @property {jibo.context.JiboInfo} jibo - Information about Jibo himself.
+ * @property {string} owner - Loop owner's id in loop.
+ * @property {string} loopId - ID of loop.
+ */
+
+/**
+ * Data provided about Jibo's current emotional state.
+ * @memberof jibo.context
+ * @interface EmotionContext
+ * @property {string} name - Current nearest emotion.
+ * @property {number} valence - Current valence.
+ * @property {number} confidence - Current confidence.
+ */
+
+/**
+ * Data provided about Jibo's current character state.
+ * @memberof jibo.context
+ * @interface CharacterContext
+ * @property {jibo.context.EmotionContext} emotion - Current emotion context.
+ * @property {jibo.context.MotivationContext} motivation - Current motivation context.
+ */
+
+/**
+ * Data provided about Jibo's current motivational state.
+ * @memberof jibo.context
+ * @interface MotivationContext
+ * @property {number} social - Current social drive state.
+ * @property {number} playful - Current playful drive state.
+ */
+
+/**
+ * Data provided about Jibo's current perceptual information.
+ * @memberof jibo.context
+ * @interface PerceptionContext
+ * @property {string} speaker - ID of the currently active speaker.
+ * @property {jibo.lps.identity#Person[]} peoplePresent - Data about currently detected present people.
+ */
+
+/**
+ * Data provided about Jibo's current location.
+ * @memberof jibo.context
+ * @interface LocationContext
+ * @property {string} city - Jibo's current city (or nearest).
+ * @property {string} state - Jibo's current state.
+ * @property {string} stateAbbr - ISO 3166 1 alpha 2 spec compliant state (or political equivalent) abbreviation of Jibo's current location.
+ * @property {string} country - Jibo's current country.
+ * @property {string} countryCode - ISO 3166 1 alpha 2 spec compliant country code of Jibo's current country.
+ * @property {number} lat - Jibo's current latitude.
+ * @property {number} lng - Jibo's current longitude.
+ * @property {string} iso - ISO 8601 compliant string representing Jibo's current time/timezone.
+ */
+
+/**
+ * Data derived from last turn of dialog with jibo.
+ * @memberof jibo.context
+ * @interface DialogContext
+ * @property {string} [referent] - ID of a loop member that was referred to in utterance.
+ */
+
+/**
+ * On-robot context data
+ * @memberof jibo.context
+ * @interface RuntimeContext
+ * @property {jibo.context.EmotionContext} character - Information about Jibo's character state.
+ * @property {jibo.context.LocationContext} location - Information about Jibo's current location.
+ * @property {jibo.context.LoopContext} loop - Information about Jibo's loop.
+ * @property {jibo.context.PerceptionContext} perception - Information about Jibo's perception state.
+ * @property {jibo.context.DialogContext} dialog - Information about the current turn of Dialog.
+ */
+
+/**
+ * Cloud skill session data
+ * @memberof jibo.context
+ * @interface SkillData
+ * @property {string} id - Cloud Skill ID.
+ * @property {Object} [session] - Session data for the currently active Cloud Skill.
+ */
+
+/**
+ * Combination of on-robot and active cloud skill session data
+ * @memberof jibo.context
+ * @interface Context
+ * @property {jibo.context.RuntimeContext} runtime - On-robot context data.
+ * @property {jibo.context.SkillData} skill - Cloud skill session data.
+ */
+
+/**
+ * Retreive the merge of the on-robot context and any active cloud skill session context
+ * @method jibo.context#getContext
+ * @param {jibo.jetstream.types.HubSpeakerRecogResults} [speakers] - List of speakers we've confidently ID'd.
+ * @param {boolean} [omitLoop=false] - `true` if you would like users/Jibo omitted from the LoopContext.
+ * @returns {Promise<jibo.context.Context>}
+ */
+
+/**
+ * Updates the Skill portion of the Context with active Cloud Skill session data from The Hub
+ * @method jibo.context#updateSkillContext
+ * @param {jibo.context.SkillData} data - Skill session data provided from the CloudSkill
+ */
+
+/**
+ * Resets the Skill portion of the Context back to default empty state
+ * @method jibo.context#resetSkillContext
+ */