diff --git a/doc/index.md b/doc/index.md
new file mode 100644
index 0000000000000000000000000000000000000000..65c927b352e2d6517be04c98065013326846cfd2
--- /dev/null
+++ b/doc/index.md
@@ -0,0 +1,581 @@
+
+# Component Docs
+- Systems
+ - [app-mode](#systems/app-mode)
+ - [exit-on-blur](#systems/exit-on-blur)
+ - [personal-space-bubble](#systems/personal-space-bubble)
+- Components
+ - [app-mode](#components/app-mode)
+ - [app-mode-toggle-playing](#components/app-mode/app-mode-toggle-playing)
+ - [app-mode-toggle-attribute](#components/app-mode/app-mode-toggle-attribute)
+ - [app-mode-input-mappings](#components/app-mode/app-mode-input-mappings)
+ - [avatar](#components/avatar)
+ - [networked-audio-analyser](#components/avatar/networked-audio-analyser)
+ - [scale-audio-feedback](#components/avatar/scale-audio-feedback)
+ - [avatar-replay](#components/avatar/avatar-replay)
+ - [bone-mute-state-indicator](#components/avatar/bone-mute-state-indicator)
+ - [bone-visibility](#components/avatar/bone-visibility)
+ - [character-controller](#components/avatar/character-controller)
+ - [hand-pose](#components/avatar/hand-pose)
+ - [hand-pose-controller](#components/avatar/hand-pose-controller)
+ - [ik-root](#components/avatar/ik-root)
+ - [ik-controller](#components/avatar/ik-controller)
+ - [networked-avatar](#components/avatar/networked-avatar)
+ - [player-info](#components/avatar/player-info)
+ - [spawn-controller](#components/avatar/spawn-controller)
+ - [avatar/personal-space-bubble](#components/avatar/personal-space-bubble)
+ - [space-invader-mesh](#components/avatar/personal-space-bubble/space-invader-mesh)
+ - [personal-space-invader](#components/avatar/personal-space-bubble/personal-space-invader)
+ - [personal-space-bubble](#components/avatar/personal-space-bubble/personal-space-bubble)
+ - [environment](#components/environment)
+ - [hide-when-quality](#components/environment/hide-when-quality)
+ - [layers](#components/environment/layers)
+ - [nav-mesh-helper](#components/environment/nav-mesh-helper)
+ - [scene-shadow](#components/environment/scene-shadow)
+ - [spawn-point](#components/environment/spawn-point)
+ - [gltf](#components/gltf)
+ - [gltf-bundle](#components/gltf/gltf-bundle)
+ - [gltf-model-plus](#components/gltf/gltf-model-plus)
+ - [misc](#components/misc)
+ - [animation-mixer](#components/misc/animation-mixer)
+ - [matcolor-audio-feedback](#components/misc/matcolor-audio-feedback)
+ - [css-class](#components/misc/css-class)
+ - [duck](#components/misc/duck)
+ - [event-repeater](#components/misc/event-repeater)
+ - [loop-animation](#components/misc/loop-animation)
+ - [offset-relative-to](#components/misc/offset-relative-to)
+ - [network](#components/network)
+ - [block-button](#components/network/block-button)
+ - [freeze-controller](#components/network/freeze-controller)
+ - [mute-mic](#components/network/mute-mic)
+ - [networked-counter](#components/network/networked-counter)
+ - [networked-video-player](#components/network/networked-video-player)
+ - [super-networked-interactable](#components/network/super-networked-interactable)
+ - [super-spawner](#components/network/super-spawner)
+ - [ui](#components/ui)
+ - [hud-controller](#components/ui/hud-controller)
+ - [icon-button](#components/ui/icon-button)
+ - [in-world-hud](#components/ui/in-world-hud)
+ - [text-button](#components/ui/text-button)
+ - [visible-while-frozen](#components/ui/visible-while-frozen)
+ - [ui-class-while-frozen](#components/ui/ui-class-while-frozen)
+ - [user-input](#components/user-input)
+ - [cardboard-controls](#components/user-input/cardboard-controls)
+ - [controls-shape-offset](#components/user-input/controls-shape-offset)
+ - [cursor-controller](#components/user-input/cursor-controller)
+ - [hand-controls2](#components/user-input/hand-controls2)
+ - [haptic-feedback](#components/user-input/haptic-feedback)
+ - [virtual-gamepad-controls](#components/user-input/virtual-gamepad-controls)
+ - [wasd-to-analog2d](#components/user-input/wasd-to-analog2d)
+ - [vr-mode](#components/vr-mode)
+ - [vr-mode-toggle-visibility](#components/vr-mode/vr-mode-toggle-visibility)
+ - [vr-mode-toggle-playing](#components/vr-mode/vr-mode-toggle-playing)
+
+## Systems
+
+<a name="systems/app-mode"></a>
+#### app-mode
+
+Simple system for keeping track of a modal app state
+
+`src/systems/app-mode.js`
+
+
+<a name="systems/exit-on-blur"></a>
+#### exit-on-blur
+
+Emits an "exit" event when a user has stopped using the app for a certain period of time
+
+`src/systems/exit-on-blur.js`
+
+
+<a name="systems/personal-space-bubble"></a>
+#### personal-space-bubble
+
+Iterates through bubbles and invaders on every tick and sets invader state accordingly. testing multiline things
+
+`src/systems/personal-space-bubble.js`
+
+
+## Components
+
+<a name="components/misc"></a>
+### misc
+
+<a name="components/misc/animation-mixer"></a>
+#### animation-mixer
+
+Instantiates and updates a THREE.AnimationMixer on an entity.
+
+`src/components/animation-mixer.js`
+
+
+<a name="components/misc/matcolor-audio-feedback"></a>
+#### matcolor-audio-feedback
+
+Sets an entity's color base on audioFrequencyChange events.
+
+`src/components/audio-feedback.js`
+
+
+<a name="components/misc/css-class"></a>
+#### css-class
+
+Sets the CSS class on an entity.
+
+`src/components/css-class.js`
+
+
+<a name="components/misc/duck"></a>
+#### duck
+
+Floats a duck based on its scale.
+
+`src/components/duck.js`
+
+
+<a name="components/misc/event-repeater"></a>
+#### event-repeater
+
+Listens to events from an event source and re-emits them on this entity
+
+`src/components/event-repeater.js`
+
+
+<a name="components/misc/loop-animation"></a>
+#### loop-animation
+
+Loops the given clip using this entity's animation mixer
+
+`src/components/loop-animation.js`
+
+
+<a name="components/misc/offset-relative-to"></a>
+#### offset-relative-to
+
+Positions an entity relative to a given target when the given event is fired.
+
+`src/components/offset-relative-to.js`
+
+
+
+<a name="components/avatar"></a>
+### avatar
+
+<a name="components/avatar/networked-audio-analyser"></a>
+#### networked-audio-analyser
+
+Emits audioFrequencyChange events based on a networked audio source
+
+`src/components/audio-feedback.js`
+
+
+<a name="components/avatar/scale-audio-feedback"></a>
+#### scale-audio-feedback
+
+Sets an entity's scale base on audioFrequencyChange events.
+
+`src/components/audio-feedback.js`
+
+
+<a name="components/avatar/avatar-replay"></a>
+#### avatar-replay
+
+Replays a recorded motion capture with the given avatar body parts
+
+`src/components/avatar-replay.js`
+
+
+<a name="components/avatar/bone-mute-state-indicator"></a>
+#### bone-mute-state-indicator
+
+Toggles the position of 2 bones into "on" and "off" positions to indicate mute state.
+
+`src/components/bone-mute-state-indicator.js`
+
+
+<a name="components/avatar/bone-visibility"></a>
+#### bone-visibility
+
+Scales an object to near-zero if the object is invisible. Useful for bones representing avatar body parts.
+
+`src/components/bone-visibility.js`
+
+
+<a name="components/avatar/character-controller"></a>
+#### character-controller
+
+Avatar movement controller that listens to move, rotate and teleportation events and moves the avatar accordingly. The controller accounts for playspace offset and orientation and depends on the nav mesh system for translation.
+
+`src/components/character-controller.js`
+
+
+<a name="components/avatar/hand-pose"></a>
+#### hand-pose
+
+Animates between poses based on networked pose state using an animation mixer.
+
+`src/components/hand-poses.js`
+
+
+<a name="components/avatar/hand-pose-controller"></a>
+#### hand-pose-controller
+
+Sets the networked hand pose state based on hand-pose events.
+
+`src/components/hand-poses.js`
+
+
+<a name="components/avatar/ik-root"></a>
+#### ik-root
+
+Provides access to the end effectors for IK.
+
+`src/components/ik-controller.js`
+
+
+<a name="components/avatar/ik-controller"></a>
+#### ik-controller
+
+Performs IK on a hip-rooted skeleton to align the hip, head and hands with camera and controller inputs.
+
+`src/components/ik-controller.js`
+
+
+<a name="components/avatar/networked-avatar"></a>
+#### networked-avatar
+
+Stores networked avatar state.
+
+`src/components/networked-avatar.js`
+
+
+<a name="components/avatar/player-info"></a>
+#### player-info
+
+Sets player info state, including avatar choice and display name.
+
+`src/components/player-info.js`
+
+
+<a name="components/avatar/spawn-controller"></a>
+#### spawn-controller
+
+Used on a player-rig to move the player to a random spawn point on entry.
+
+`src/components/spawn-controller.js`
+
+
+
+<a name="components/network"></a>
+### network
+
+<a name="components/network/block-button"></a>
+#### block-button
+
+Registers a click handler and invokes the block method on the NAF adapter for the owner associated with its entity.
+
+`src/components/block-button.js`
+
+
+<a name="components/network/freeze-controller"></a>
+#### freeze-controller
+
+Toggles freezing of network traffic on the given event.
+
+`src/components/freeze-controller.js`
+
+
+<a name="components/network/mute-mic"></a>
+#### mute-mic
+
+Toggles the microphone on the current network connection based on the given events.
+
+`src/components/mute-mic.js`
+
+
+<a name="components/network/networked-counter"></a>
+#### networked-counter
+
+Limits networked interactables to a maximum number at any given time
+
+`src/components/networked-counter.js`
+
+
+<a name="components/network/networked-video-player"></a>
+#### networked-video-player
+
+Instantiates and plays a network video stream, setting the video as the source material for this entity.
+
+`src/components/networked-video-player.js`
+
+
+<a name="components/network/super-networked-interactable"></a>
+#### super-networked-interactable
+
+Manages ownership and haptics on an interatable
+
+`src/components/super-networked-interactable.js`
+
+
+<a name="components/network/super-spawner"></a>
+#### super-spawner
+
+Spawns networked objects when grabbed.
+
+`src/components/super-spawner.js`
+
+
+
+<a name="components/user-input"></a>
+### user-input
+
+<a name="components/user-input/cardboard-controls"></a>
+#### cardboard-controls
+
+Polls the Gamepad API for Cardboard Button input and emits cardboardbutton events.
+
+`src/components/cardboard-controls.js`
+
+
+<a name="components/user-input/controls-shape-offset"></a>
+#### controls-shape-offset
+
+Sets the offset of the aframe-physics shape on this entity based on the current VR controller type
+
+`src/components/controls-shape-offset.js`
+
+
+<a name="components/user-input/cursor-controller"></a>
+#### cursor-controller
+
+Controls virtual cursor behavior in various modalities to affect teleportation, interatables and UI.
+
+`src/components/cursor-controller.js`
+
+
+<a name="components/user-input/hand-controls2"></a>
+#### hand-controls2
+
+Converts events from various 6DoF and 3DoF controllers into hand-pose events.
+
+`src/components/hand-controls2.js`
+
+
+<a name="components/user-input/haptic-feedback"></a>
+#### haptic-feedback
+
+Listens for haptic events and actuates hardware controllers accordingly
+
+`src/components/haptic-feedback.js`
+
+
+<a name="components/user-input/virtual-gamepad-controls"></a>
+#### virtual-gamepad-controls
+
+Instantiates 2D virtual gamepads and emits associated events.
+
+`src/components/virtual-gamepad-controls.js`
+
+
+<a name="components/user-input/wasd-to-analog2d"></a>
+#### wasd-to-analog2d
+
+Converts WASD keyboard inputs to simulated analog inputs.
+
+`src/components/wasd-to-analog2d.js`
+
+
+
+<a name="components/gltf"></a>
+### gltf
+
+<a name="components/gltf/gltf-bundle"></a>
+#### gltf-bundle
+
+Instantiates GLTF models as specified in a bundle JSON.
+
+`src/components/gltf-bundle.js`
+
+
+<a name="components/gltf/gltf-model-plus"></a>
+#### gltf-model-plus
+
+Loads a GLTF model, optionally recursively "inflates" the child nodes of a model into a-entities and sets whitelisted components on them if defined in the node's extras.
+
+`src/components/gltf-model-plus.js`
+
+
+
+<a name="components/environment"></a>
+### environment
+
+<a name="components/environment/hide-when-quality"></a>
+#### hide-when-quality
+
+Hides entities based on the scene's quality mode
+
+`src/components/hide-when-quality.js`
+
+
+<a name="components/environment/layers"></a>
+#### layers
+
+Sets layer flags on the underlying Object3D
+
+`src/components/layers.js`
+
+
+<a name="components/environment/nav-mesh-helper"></a>
+#### nav-mesh-helper
+
+Initializes teleport-controls when the environment bundle has loaded.
+
+`src/components/nav-mesh-helper.js`
+
+
+<a name="components/environment/scene-shadow"></a>
+#### scene-shadow
+
+For use in environment gltf bundles to set scene shadow properties.
+
+`src/components/scene-shadow.js`
+
+
+<a name="components/environment/spawn-point"></a>
+#### spawn-point
+
+Marks an entity as a potential spawn point.
+
+`src/components/spawn-controller.js`
+
+
+
+<a name="components/ui"></a>
+### ui
+
+<a name="components/ui/hud-controller"></a>
+#### hud-controller
+
+Positions the HUD and toggles app mode based on where the user is looking
+
+`src/components/hud-controller.js`
+
+
+<a name="components/ui/icon-button"></a>
+#### icon-button
+
+A button with an image, tooltip, hover states and haptics.
+
+`src/components/icon-button.js`
+
+
+<a name="components/ui/in-world-hud"></a>
+#### in-world-hud
+
+HUD panel for muting, freezing, and space bubble controls.
+
+`src/components/in-world-hud.js`
+
+
+<a name="components/ui/text-button"></a>
+#### text-button
+
+A button with text and haptics
+
+`src/components/text-button.js`
+
+
+<a name="components/ui/visible-while-frozen"></a>
+#### visible-while-frozen
+
+Toggles the visibility of this entity when the scene is frozen.
+
+`src/components/visible-while-frozen.js`
+
+
+<a name="components/ui/ui-class-while-frozen"></a>
+#### ui-class-while-frozen
+
+Toggles the interactivity of a UI entity while the scene is frozen.
+
+`src/components/visible-while-frozen.js`
+
+
+
+<a name="components/app-mode"></a>
+### app-mode
+
+<a name="components/app-mode/app-mode-toggle-playing"></a>
+#### app-mode-toggle-playing
+
+Toggle the isPlaying state of a component based on app mode
+
+`src/systems/app-mode.js`
+
+
+<a name="components/app-mode/app-mode-toggle-attribute"></a>
+#### app-mode-toggle-attribute
+
+Toggle a boolean property of a component based on app mode
+
+`src/systems/app-mode.js`
+
+
+<a name="components/app-mode/app-mode-input-mappings"></a>
+#### app-mode-input-mappings
+
+Toggle aframe input mappings action set based on app mode
+
+`src/systems/app-mode.js`
+
+
+
+<a name="components/vr-mode"></a>
+### vr-mode
+
+<a name="components/vr-mode/vr-mode-toggle-visibility"></a>
+#### vr-mode-toggle-visibility
+
+Toggle visibility of an entity based on if the user is in vr mode or not
+
+`src/systems/app-mode.js`
+
+
+<a name="components/vr-mode/vr-mode-toggle-playing"></a>
+#### vr-mode-toggle-playing
+
+Toggle the isPlaying state of a component based on app mode
+
+`src/systems/app-mode.js`
+
+
+
+<a name="components/avatar/personal-space-bubble"></a>
+### avatar/personal-space-bubble
+
+<a name="components/avatar/personal-space-bubble/space-invader-mesh"></a>
+#### space-invader-mesh
+
+Specifies a mesh associated with an invader.
+
+`src/systems/personal-space-bubble.js`
+
+
+<a name="components/avatar/personal-space-bubble/personal-space-invader"></a>
+#### personal-space-invader
+
+Represents an entity that can invade a personal space bubble
+
+`src/systems/personal-space-bubble.js`
+
+
+<a name="components/avatar/personal-space-bubble/personal-space-bubble"></a>
+#### personal-space-bubble
+
+Represents a personal space bubble on an entity.
+
+`src/systems/personal-space-bubble.js`
+
+
+
\ No newline at end of file
diff --git a/package.json b/package.json
index 096b55a0569a4ce24467970318e290ffdd2116d8..c20bebfb9fab1116be01b4c09b23a2ab50fa7d5e 100644
--- a/package.json
+++ b/package.json
@@ -11,6 +11,7 @@
"postinstall": "node ./scripts/postinstall.js",
"start": "cross-env NODE_ENV=development webpack-dev-server",
"build": "rimraf ./public && cross-env NODE_ENV=production webpack --mode=production",
+ "doc": "node ./scripts/doc/build.js",
"prettier": "prettier --write '*.js' 'src/**/*.js'",
"lint:js": "eslint '*.js' 'scripts/**/*.js' 'src/**/*.js'",
"lint:html": "node ./scripts/lint-html.js 'src/**/*.html'",
diff --git a/scripts/doc/build.js b/scripts/doc/build.js
new file mode 100644
index 0000000000000000000000000000000000000000..2e910117fcdc94239dab4177b94307a746daec42
--- /dev/null
+++ b/scripts/doc/build.js
@@ -0,0 +1,60 @@
+const fs = require("fs");
+const { promisify } = require("util");
+const readFile = promisify(fs.readFile);
+const writeFile = promisify(fs.writeFile);
+const shell = require("shelljs");
+const flatten = require("lodash/flatten");
+const indexTemplate = require("./index.js");
+
+async function extractDocs(file) {
+ const contents = (await readFile(file)).toString();
+ // Find all the doc strings in the file.
+ const matches = contents.match(/\/\*\*.+?\*\//gs);
+ if (matches) {
+ return matches.map(match => {
+ return { doc: match, file };
+ });
+ } else {
+ return null;
+ }
+}
+
+function parseDocs(doc) {
+ const _doc = doc;
+ // Capture the description and tags in the doc string
+ const matches = _doc.doc.match(/\/\*\*([^@]+)(.+)\*\//s);
+ // Trim whitespace and asterisks from a line
+ const trimLine = line => line.trim().replace(/^\*\s*|\s*\*$/g, "");
+
+ _doc.doc = {
+ desc: matches[1]
+ .split("\n")
+ .map(trimLine)
+ .filter(x => x)
+ .join(" "),
+ tags: matches[2]
+ .split(/[\r\n]/)
+ .map(trimLine)
+ .filter(x => x.startsWith("@"))
+ .reduce((a, x) => {
+ const tag = x.split(" ");
+ a[tag[0].substring(1)] = tag.slice(1).join();
+ return a;
+ }, {})
+ };
+ return _doc;
+}
+
+function aframeDocs(doc) {
+ const keys = Object.keys(doc.doc.tags);
+ return keys.includes("component") || keys.includes("system");
+}
+
+(async function() {
+ const files = shell.ls("src/components/*.js", "src/systems/*.js");
+ const parsedDocs = flatten(await Promise.all(files.map(extractDocs)))
+ .filter(x => x)
+ .map(parseDocs)
+ .filter(aframeDocs);
+ writeFile("doc/index.md", indexTemplate(parsedDocs));
+})();
diff --git a/scripts/doc/index.js b/scripts/doc/index.js
new file mode 100644
index 0000000000000000000000000000000000000000..bb6f0d1592cda812f50d3da16aa41ef1bfad2578
--- /dev/null
+++ b/scripts/doc/index.js
@@ -0,0 +1,69 @@
+module.exports = function(docs) {
+ const systems = docs.filter(doc => Object.keys(doc.doc.tags).includes("system"));
+ const components = docs.filter(doc => Object.keys(doc.doc.tags).includes("component")).reduce((acc, doc) => {
+ const namespace = doc.doc.tags.namespace || "misc";
+ if (!acc[namespace]) {
+ acc[namespace] = [];
+ }
+ acc[namespace].push(doc);
+ return acc;
+ }, {});
+ return `
+# Component Docs
+- Systems
+${systems
+ .map(system => {
+ return ` - [${system.doc.tags.system}](#systems/${system.doc.tags.system})`;
+ })
+ .join("\n")}
+- Components
+${Object.entries(components)
+ .sort((a, b) => a[0] > b[0])
+ .map(([namespace, components]) => {
+ return ` - [${namespace}](#components/${namespace})
+${components
+ .map(
+ component =>
+ ` - [${component.doc.tags.component}](#components/${namespace}/${component.doc.tags.component})`
+ )
+ .join("\n")}`;
+ })
+ .join("\n")}
+
+## Systems
+${systems
+ .map(system => {
+ return `
+<a name="systems/${system.doc.tags.system}"></a>
+#### ${system.doc.tags.system}
+
+${system.doc.desc}
+
+\`${system.file}\`
+ `;
+ })
+ .join("\n")}
+
+## Components
+${Object.entries(components)
+ .map(([namespace, components]) => {
+ return `
+<a name="components/${namespace}"></a>
+### ${namespace}
+ ${components
+ .map(
+ component => `
+<a name="components/${namespace}/${component.doc.tags.component}"></a>
+#### ${component.doc.tags.component}
+
+${component.doc.desc}
+
+\`${component.file}\`
+ `
+ )
+ .join("\n")}
+ `;
+ })
+ .join("\n")}
+ `;
+};
diff --git a/src/components/animation-mixer.js b/src/components/animation-mixer.js
index 791854f1eab2b6f30f20f094b9fb9a35c3ecb9f2..480a4de234751aa4dd2088d9f497f043f3c46b85 100644
--- a/src/components/animation-mixer.js
+++ b/src/components/animation-mixer.js
@@ -1,3 +1,7 @@
+/**
+ * Instantiates and updates a THREE.AnimationMixer on an entity.
+ * @component animation-mixer
+ */
AFRAME.registerComponent("animation-mixer", {
init() {
this.mixer = null;
diff --git a/src/components/audio-feedback.js b/src/components/audio-feedback.js
index a72ec196ece7d4f66f5cc0e85b7f9a1edaeff916..7edf3ec3f654eb9ee7b45c35c58d2afee2c56373 100644
--- a/src/components/audio-feedback.js
+++ b/src/components/audio-feedback.js
@@ -1,3 +1,8 @@
+/**
+ * Emits audioFrequencyChange events based on a networked audio source
+ * @namespace avatar
+ * @component networked-audio-analyser
+ */
AFRAME.registerComponent("networked-audio-analyser", {
schema: {},
async init() {
@@ -27,6 +32,10 @@ AFRAME.registerComponent("networked-audio-analyser", {
}
});
+/**
+ * Sets an entity's color base on audioFrequencyChange events.
+ * @component matcolor-audio-feedback
+ */
AFRAME.registerComponent("matcolor-audio-feedback", {
schema: {
analyserSrc: { type: "selector" }
@@ -49,6 +58,11 @@ AFRAME.registerComponent("matcolor-audio-feedback", {
}
});
+/**
+ * Sets an entity's scale base on audioFrequencyChange events.
+ * @namespace avatar
+ * @component scale-audio-feedback
+ */
AFRAME.registerComponent("scale-audio-feedback", {
schema: {
analyserSrc: { type: "selector" },
diff --git a/src/components/avatar-replay.js b/src/components/avatar-replay.js
index bbcb397cf4127778c2b4ffb3c45a78894c0e2bbd..260744549a7f3eb60c210bb90f7ec063c454e888 100644
--- a/src/components/avatar-replay.js
+++ b/src/components/avatar-replay.js
@@ -11,6 +11,11 @@ const controlsBlacklist = [
"gearvr-controls"
];
+/**
+ * Replays a recorded motion capture with the given avatar body parts
+ * @namespace avatar
+ * @component avatar-replay
+ */
AFRAME.registerComponent("avatar-replay", {
schema: {
camera: { type: "selector" },
diff --git a/src/components/block-button.js b/src/components/block-button.js
index 9dc23988c351d8483de8ea2e6546579d9e25d5b0..603de3bc6dc649e90165cf65b323b66431836839 100644
--- a/src/components/block-button.js
+++ b/src/components/block-button.js
@@ -1,3 +1,8 @@
+/**
+ * Registers a click handler and invokes the block method on the NAF adapter for the owner associated with its entity.
+ * @namespace network
+ * @component block-button
+ */
AFRAME.registerComponent("block-button", {
init() {
this.onClick = () => {
diff --git a/src/components/bone-mute-state-indicator.js b/src/components/bone-mute-state-indicator.js
index 92a2590e2cda9c2d0c048b0849d1e7bdcab35849..cf7305576e1df88fb5a713e577e93d6cbd0170ca 100644
--- a/src/components/bone-mute-state-indicator.js
+++ b/src/components/bone-mute-state-indicator.js
@@ -1,5 +1,7 @@
/**
* Toggles the position of 2 bones into "on" and "off" positions to indicate mute state.
+ * @namespace avatar
+ * @component bone-mute-state-indicator
*/
AFRAME.registerComponent("bone-mute-state-indicator", {
schema: {
diff --git a/src/components/bone-visibility.js b/src/components/bone-visibility.js
index 6f6f1a53e6f3eb464561ea91741d6d09e33a093f..84016d5984a53ccac41ab8089e2ec26dd541d2b4 100644
--- a/src/components/bone-visibility.js
+++ b/src/components/bone-visibility.js
@@ -1,3 +1,8 @@
+/**
+ * Scales an object to near-zero if the object is invisible. Useful for bones representing avatar body parts.
+ * @namespace avatar
+ * @component bone-visibility
+ */
AFRAME.registerComponent("bone-visibility", {
tick() {
const { visible } = this.el.object3D;
diff --git a/src/components/cardboard-controls.js b/src/components/cardboard-controls.js
index 766fda015a2b9d3ccf1e392ba9c3613b420cb904..792fa1bd0b22f8162e316f7782e4f361f0aebabe 100644
--- a/src/components/cardboard-controls.js
+++ b/src/components/cardboard-controls.js
@@ -1,5 +1,10 @@
const CARDBOARD_BUTTON_GAMEPAD_ID = "Cardboard Button";
+/**
+ * Polls the Gamepad API for Cardboard Button input and emits cardboardbutton events.
+ * @namespace user-input
+ * @component cardboard-controls
+ */
module.exports = AFRAME.registerComponent("cardboard-controls", {
init: function() {
this.buttons = {};
diff --git a/src/components/character-controller.js b/src/components/character-controller.js
index 2b86ff0a353b406d073238c8aca664197ff7084d..a079671e29c24733a11681c867a5ad0b7af10041 100644
--- a/src/components/character-controller.js
+++ b/src/components/character-controller.js
@@ -2,7 +2,12 @@ const CLAMP_VELOCITY = 0.01;
const MAX_DELTA = 0.2;
const EPS = 10e-6;
-// Does not have any type of collisions yet.
+/**
+ * Avatar movement controller that listens to move, rotate and teleportation events and moves the avatar accordingly.
+ * The controller accounts for playspace offset and orientation and depends on the nav mesh system for translation.
+ * @namespace avatar
+ * @component character-controller
+ */
AFRAME.registerComponent("character-controller", {
schema: {
groundAcc: { default: 5.5 },
@@ -136,7 +141,8 @@ AFRAME.registerComponent("character-controller", {
// Reapply playspace (player rig) translation
root.applyMatrix(trans);
- // TODO: the above matrix trnsfomraitons introduce some floating point erros in scale, this reverts them to avoid spamming network with fake scale updates
+ // TODO: the above matrix trnsfomraitons introduce some floating point errors in scale, this reverts them to
+ // avoid spamming network with fake scale updates
root.scale.copy(startScale);
this.pendingSnapRotationMatrix.identity(); // Revert to identity
diff --git a/src/components/controls-shape-offset.js b/src/components/controls-shape-offset.js
index 7f47c498bc287a0dbd5c8f8126b724d320c95ca7..d234b971ac69d3379c740d414e84831d0ba9cf90 100644
--- a/src/components/controls-shape-offset.js
+++ b/src/components/controls-shape-offset.js
@@ -1,5 +1,10 @@
import { CONTROLLER_OFFSETS } from "./hand-controls2.js";
+/**
+ * Sets the offset of the aframe-physics shape on this entity based on the current VR controller type
+ * @namespace user-input
+ * @component controls-shape-offset
+ */
AFRAME.registerComponent("controls-shape-offset", {
schema: {
additionalOffset: { type: "vec3", default: { x: 0, y: -0.03, z: -0.04 } }
diff --git a/src/components/css-class.js b/src/components/css-class.js
index 1528ed4d450aea61f63b7426524229ed63609044..77882e9bce9e2e00c6d02f02677b9388b8110d14 100644
--- a/src/components/css-class.js
+++ b/src/components/css-class.js
@@ -1,3 +1,7 @@
+/**
+ * Sets the CSS class on an entity.
+ * @component css-class
+ */
AFRAME.registerComponent("css-class", {
schema: {
type: "string"
diff --git a/src/components/cursor-controller.js b/src/components/cursor-controller.js
index 7ae7aa529904d8ab6166161fece927e6fc61a830..3f81d7ea0869a4481e003a8aeba3cf418621ac3c 100644
--- a/src/components/cursor-controller.js
+++ b/src/components/cursor-controller.js
@@ -4,6 +4,11 @@ const TARGET_TYPE_UI = 4;
const TARGET_TYPE_INTERACTABLE_OR_UI = TARGET_TYPE_INTERACTABLE | TARGET_TYPE_UI;
const virtualJoystickCutoff = 0.8;
+/**
+ * Controls virtual cursor behavior in various modalities to affect teleportation, interatables and UI.
+ * @namespace user-input
+ * @component cursor-controller
+ */
AFRAME.registerComponent("cursor-controller", {
dependencies: ["raycaster", "line"],
schema: {
diff --git a/src/components/duck.js b/src/components/duck.js
index 59172942074173c393c7d86e9fd9e121737ae128..2b18f32c56cf62cef7baf23d378375d84a66be74 100644
--- a/src/components/duck.js
+++ b/src/components/duck.js
@@ -1,4 +1,8 @@
/* global CANNON */
+/**
+ * Floats a duck based on its scale.
+ * @component duck
+ */
AFRAME.registerComponent("duck", {
schema: {
initialForce: { default: 0 },
diff --git a/src/components/event-repeater.js b/src/components/event-repeater.js
index e5e5ffd192b2b170a4efeac2e0c30e9ee43dd92a..10061132520ee0a7102255052f0108729ecf6090 100644
--- a/src/components/event-repeater.js
+++ b/src/components/event-repeater.js
@@ -1,3 +1,7 @@
+/**
+ * Listens to events from an event source and re-emits them on this entity
+ * @component event-repeater
+ */
AFRAME.registerComponent("event-repeater", {
schema: {
eventSource: { type: "selector" },
diff --git a/src/components/freeze-controller.js b/src/components/freeze-controller.js
index 3cb64d76d91a8823c6d14ca8922cf388c7f83948..b7305ea720660644837192a89d85d27c3072397e 100644
--- a/src/components/freeze-controller.js
+++ b/src/components/freeze-controller.js
@@ -1,3 +1,8 @@
+/**
+ * Toggles freezing of network traffic on the given event.
+ * @namespace network
+ * @component freeze-controller
+ */
AFRAME.registerComponent("freeze-controller", {
schema: {
toggleEvent: { type: "string" }
diff --git a/src/components/gltf-bundle.js b/src/components/gltf-bundle.js
index ba6f7b3dc6d78aa08646352e49b6e3f91031056a..72163ec542922ea21c5c7612b54b193f5c256a97 100644
--- a/src/components/gltf-bundle.js
+++ b/src/components/gltf-bundle.js
@@ -1,3 +1,8 @@
+/**
+ * Instantiates GLTF models as specified in a bundle JSON.
+ * @namespace gltf
+ * @component gltf-bundle
+ */
AFRAME.registerComponent("gltf-bundle", {
schema: {
src: { default: "" }
diff --git a/src/components/gltf-model-plus.js b/src/components/gltf-model-plus.js
index cc803235164240994ddd47d7a3be2809d609bbe3..55d62b10e997a943d39c6e593cb35256c67b0e6c 100644
--- a/src/components/gltf-model-plus.js
+++ b/src/components/gltf-model-plus.js
@@ -194,6 +194,12 @@ function cachedLoadGLTF(src, preferredTechnique, onProgress) {
});
}
+/**
+ * Loads a GLTF model, optionally recursively "inflates" the child nodes of a model into a-entities and sets
+ * whitelisted components on them if defined in the node's extras.
+ * @namespace gltf
+ * @component gltf-model-plus
+ */
AFRAME.registerComponent("gltf-model-plus", {
schema: {
src: { type: "string" },
diff --git a/src/components/hand-controls2.js b/src/components/hand-controls2.js
index d99d5fc063d9a2c487c60490616b959b79c297ea..961790fead81073fcf066ad907079c2497461cd8 100644
--- a/src/components/hand-controls2.js
+++ b/src/components/hand-controls2.js
@@ -28,6 +28,11 @@ export const CONTROLLER_OFFSETS = {
"gearvr-controls": new THREE.Matrix4()
};
+/**
+ * Converts events from various 6DoF and 3DoF controllers into hand-pose events.
+ * @namespace user-input
+ * @component hand-controls2
+ */
AFRAME.registerComponent("hand-controls2", {
schema: { default: "left" },
diff --git a/src/components/hand-poses.js b/src/components/hand-poses.js
index 7a0f9a4d26ddb022fbf5e5e51ee26fb01eef1772..98c1282cb714ae3b5a2d915ff5a5e237b127ca87 100644
--- a/src/components/hand-poses.js
+++ b/src/components/hand-poses.js
@@ -11,6 +11,11 @@ const POSES = {
const NETWORK_POSES = ["allOpen", "thumbDown", "indexDown", "mrpDown", "thumbsUp", "point", "allGrip", "pinch"];
+/**
+ * Animates between poses based on networked pose state using an animation mixer.
+ * @namespace avatar
+ * @component hand-pose
+ */
AFRAME.registerComponent("hand-pose", {
multiple: true,
@@ -66,6 +71,11 @@ AFRAME.registerComponent("hand-pose", {
}
});
+/**
+ * Sets the networked hand pose state based on hand-pose events.
+ * @namespace avatar
+ * @component hand-pose-controller
+ */
AFRAME.registerComponent("hand-pose-controller", {
multiple: true,
schema: {
diff --git a/src/components/haptic-feedback.js b/src/components/haptic-feedback.js
index 9a0a2337de1ef895bdbd3bb699259f3063187cf2..72ce54ad0228317976183a7dfefcd85427023ec7 100644
--- a/src/components/haptic-feedback.js
+++ b/src/components/haptic-feedback.js
@@ -4,6 +4,11 @@ const strengthForIntensity = {
high: 1
};
+/**
+ * Listens for haptic events and actuates hardware controllers accordingly
+ * @namespace user-input
+ * @component haptic-feedback
+ */
AFRAME.registerComponent("haptic-feedback", {
schema: {
hapticEventName: { default: "haptic_pulse" }
diff --git a/src/components/hide-when-quality.js b/src/components/hide-when-quality.js
index 93e238d61b74eff66d3becdabca314d13641a97c..8f13e0a32486e510be47e33df3e03132f094b541 100644
--- a/src/components/hide-when-quality.js
+++ b/src/components/hide-when-quality.js
@@ -1,3 +1,8 @@
+/**
+ * Hides entities based on the scene's quality mode
+ * @namespace environment
+ * @component hide-when-quality
+ */
AFRAME.registerComponent("hide-when-quality", {
schema: { type: "string", default: "low" },
diff --git a/src/components/hud-controller.js b/src/components/hud-controller.js
index 2fac822d84d187d141217fa00327a63555a04332..1f94a319b6abb0a370a05014d7c1d8ba3795fd76 100644
--- a/src/components/hud-controller.js
+++ b/src/components/hud-controller.js
@@ -8,6 +8,8 @@ function deltaAngle(a, b) {
/**
* Positions the HUD and toggles app mode based on where the user is looking
+ * @namespace ui
+ * @component hud-controller
*/
AFRAME.registerComponent("hud-controller", {
schema: {
diff --git a/src/components/icon-button.js b/src/components/icon-button.js
index 88f5e7303822ff103d7e67479ab99b3d7bddba4f..0f0e21a1dfc0205d4c4f4d4fc957a0af08e645dd 100644
--- a/src/components/icon-button.js
+++ b/src/components/icon-button.js
@@ -1,3 +1,8 @@
+/**
+ * A button with an image, tooltip, hover states and haptics.
+ * @namespace ui
+ * @component icon-button
+ */
AFRAME.registerComponent("icon-button", {
schema: {
image: { type: "string" },
diff --git a/src/components/ik-controller.js b/src/components/ik-controller.js
index 23f2dbf799f59558fd261eaa615f1bd2d37a66d2..3b2f3026a56ce64afb9460c6c6de0f37ccc6d969 100644
--- a/src/components/ik-controller.js
+++ b/src/components/ik-controller.js
@@ -1,4 +1,9 @@
const { Vector3, Quaternion, Matrix4, Euler } = THREE;
+/**
+ * Provides access to the end effectors for IK.
+ * @namespace avatar
+ * @component ik-root
+ */
AFRAME.registerComponent("ik-root", {
schema: {
camera: { type: "string", default: ".camera" },
@@ -27,6 +32,11 @@ function findIKRoot(entity) {
return entity && entity.components["ik-root"];
}
+/**
+ * Performs IK on a hip-rooted skeleton to align the hip, head and hands with camera and controller inputs.
+ * @namespace avatar
+ * @component ik-controller
+ */
AFRAME.registerComponent("ik-controller", {
schema: {
leftEye: { type: "string", default: ".LeftEye" },
@@ -150,7 +160,8 @@ AFRAME.registerComponent("ik-controller", {
// Compute the head position such that the hmd position would be in line with the middleEye
headTransform.multiplyMatrices(cameraForward, invMiddleEyeToHead);
- // Then position the hips such that the head is aligned with headTransform (which positions middleEye in line with the hmd)
+ // Then position the hips such that the head is aligned with headTransform
+ // (which positions middleEye in line with the hmd)
hips.object3D.position.setFromMatrixPosition(headTransform).add(invHipsToHeadVector);
// Animate the hip rotation to follow the Y rotation of the camera with some damping.
@@ -165,7 +176,8 @@ AFRAME.registerComponent("ik-controller", {
this.data.rotationSpeed * dt / 1000
);
- // Take the head orientation computed from the hmd, remove the Y rotation already applied to it by the hips, and apply it to the head
+ // Take the head orientation computed from the hmd, remove the Y rotation already applied to it by the hips,
+ // and apply it to the head
invHipsQuaternion.copy(hips.object3D.quaternion).inverse();
head.object3D.quaternion.setFromRotationMatrix(headTransform).premultiply(invHipsQuaternion);
diff --git a/src/components/in-world-hud.js b/src/components/in-world-hud.js
index 2077b7ef28236d7257c0aa9b8e536ddd9891a499..a4fe8c9655ecffe3161a86b09fa3b6f6cdbdb19b 100644
--- a/src/components/in-world-hud.js
+++ b/src/components/in-world-hud.js
@@ -1,3 +1,8 @@
+/**
+ * HUD panel for muting, freezing, and space bubble controls.
+ * @namespace ui
+ * @component in-world-hud
+ */
AFRAME.registerComponent("in-world-hud", {
schema: {
haptic: { type: "selector" },
diff --git a/src/components/layers.js b/src/components/layers.js
index 2838cf754efd2c525cfa5508246f230449f5c895..28a9e7c1d3da2477aa3bba09d1aef76f47998c1f 100644
--- a/src/components/layers.js
+++ b/src/components/layers.js
@@ -3,6 +3,11 @@ export const Layers = {
reflection: 3
};
+/**
+ * Sets layer flags on the underlying Object3D
+ * @namespace environment
+ * @component layers
+ */
AFRAME.registerComponent("layers", {
schema: {
reflection: { type: "boolean", default: false }
diff --git a/src/components/loop-animation.js b/src/components/loop-animation.js
index 09a9e9dafabf8c05c7f13a02a9ecb820018ef573..76d3a0ec2135d174abf6c014363d3ea8561bd97e 100644
--- a/src/components/loop-animation.js
+++ b/src/components/loop-animation.js
@@ -1,3 +1,7 @@
+/**
+ * Loops the given clip using this entity's animation mixer
+ * @component loop-animation
+ */
AFRAME.registerComponent("loop-animation", {
dependencies: ["animation-mixer"],
schema: {
diff --git a/src/components/mute-mic.js b/src/components/mute-mic.js
index 00729ba1904002a88729e21ed82f69dbb872dda9..9498d90a421701fe033696d8f2660ef908204587 100644
--- a/src/components/mute-mic.js
+++ b/src/components/mute-mic.js
@@ -17,6 +17,11 @@ const unbindAllEvents = function(elements, events, f) {
}
};
+/**
+ * Toggles the microphone on the current network connection based on the given events.
+ * @namespace network
+ * @component mute-mic
+ */
AFRAME.registerComponent("mute-mic", {
schema: {
eventSrc: { type: "selectorAll" },
diff --git a/src/components/nav-mesh-helper.js b/src/components/nav-mesh-helper.js
index 5c1be4ce96946dddb6ba98590dc7da27d403ab10..876f62a8558add90f2093d1430535c792cc732a5 100644
--- a/src/components/nav-mesh-helper.js
+++ b/src/components/nav-mesh-helper.js
@@ -1,3 +1,8 @@
+/**
+ * Initializes teleport-controls when the environment bundle has loaded.
+ * @namespace environment
+ * @component nav-mesh-helper
+ */
AFRAME.registerComponent("nav-mesh-helper", {
schema: {
teleportControls: { type: "selectorAll", default: "[teleport-controls]" }
diff --git a/src/components/networked-avatar.js b/src/components/networked-avatar.js
index 8820509cd57cae4c359cdbd8235edf6a62548555..04a5fac8e5d097b7daf7d75b5b27923b6c65534a 100644
--- a/src/components/networked-avatar.js
+++ b/src/components/networked-avatar.js
@@ -1,3 +1,8 @@
+/**
+ * Stores networked avatar state.
+ * @namespace avatar
+ * @component networked-avatar
+ */
AFRAME.registerComponent("networked-avatar", {
schema: {
left_hand_pose: { default: 0 },
diff --git a/src/components/networked-counter.js b/src/components/networked-counter.js
index 39f76ddb7fb31482e86ddf4630f5d45d14c0d4e0..be9725cf6a50efb822370ab5d4b7196a6bcce3c4 100644
--- a/src/components/networked-counter.js
+++ b/src/components/networked-counter.js
@@ -1,3 +1,8 @@
+/**
+ * Limits networked interactables to a maximum number at any given time
+ * @namespace network
+ * @component networked-counter
+ */
AFRAME.registerComponent("networked-counter", {
schema: {
max: { default: 3 },
diff --git a/src/components/networked-video-player.js b/src/components/networked-video-player.js
index 189a43e393f359a5c2d217b5978132476f6407c6..eb4a93e0acc77173a714ca72aee1a29f744a2ffb 100644
--- a/src/components/networked-video-player.js
+++ b/src/components/networked-video-player.js
@@ -8,6 +8,11 @@ const nafConnected = function() {
});
};
+/**
+ * Instantiates and plays a network video stream, setting the video as the source material for this entity.
+ * @namespace network
+ * @component networked-video-player
+ */
AFRAME.registerComponent("networked-video-player", {
schema: {},
async init() {
diff --git a/src/components/offset-relative-to.js b/src/components/offset-relative-to.js
index 39361022488971c5b41a160520594020d81f36ac..3cd45b942ed4573ee9b588a467de456af801f62f 100644
--- a/src/components/offset-relative-to.js
+++ b/src/components/offset-relative-to.js
@@ -1,3 +1,7 @@
+/**
+ * Positions an entity relative to a given target when the given event is fired.
+ * @component offset-relative-to
+ */
AFRAME.registerComponent("offset-relative-to", {
schema: {
target: {
diff --git a/src/components/player-info.js b/src/components/player-info.js
index b9455352a104bd71aceb07ed4718a2999a4d08b6..a7e0812f8810c56544f14f2ed0c93602050f2a13 100644
--- a/src/components/player-info.js
+++ b/src/components/player-info.js
@@ -1,3 +1,8 @@
+/**
+ * Sets player info state, including avatar choice and display name.
+ * @namespace avatar
+ * @component player-info
+ */
AFRAME.registerComponent("player-info", {
schema: {
displayName: { type: "string" },
diff --git a/src/components/scene-shadow.js b/src/components/scene-shadow.js
index 14b2e23cc6bbfc4b0a3e930cba4bfab65e74977d..c510604c9ea40785a24853bc341a481f992983ad 100644
--- a/src/components/scene-shadow.js
+++ b/src/components/scene-shadow.js
@@ -1,4 +1,8 @@
-// For use in environment gltf bundles to set scene shadow properties.
+/**
+ * For use in environment gltf bundles to set scene shadow properties.
+ * @namespace environment
+ * @component scene-shadow
+ */
AFRAME.registerComponent("scene-shadow", {
schema: {
type: {
diff --git a/src/components/spawn-controller.js b/src/components/spawn-controller.js
index 1daf01b756e4308f1f9d50ceffd362aeb4b8e399..6476d733a38a4ea183ea46ca641a897d2290b510 100644
--- a/src/components/spawn-controller.js
+++ b/src/components/spawn-controller.js
@@ -1,3 +1,8 @@
+/**
+ * Used on a player-rig to move the player to a random spawn point on entry.
+ * @namespace avatar
+ * @component spawn-controller
+ */
AFRAME.registerComponent("spawn-controller", {
schema: {
target: { type: "selector" },
@@ -23,4 +28,9 @@ AFRAME.registerComponent("spawn-controller", {
}
});
+/**
+ * Marks an entity as a potential spawn point.
+ * @namespace environment
+ * @component spawn-point
+ */
AFRAME.registerComponent("spawn-point", {});
diff --git a/src/components/super-networked-interactable.js b/src/components/super-networked-interactable.js
index 0d9fc26dea6304e7ea66f165f76a62bd7044b2d3..903302562341289cb972515c3ea9030eec5979fd 100644
--- a/src/components/super-networked-interactable.js
+++ b/src/components/super-networked-interactable.js
@@ -1,3 +1,8 @@
+/**
+ * Manages ownership and haptics on an interatable
+ * @namespace network
+ * @component super-networked-interactable
+ */
AFRAME.registerComponent("super-networked-interactable", {
schema: {
mass: { default: 1 },
diff --git a/src/components/super-spawner.js b/src/components/super-spawner.js
index 7bd554f5a5ae07026896c45f0a837f5fb7467be3..083f81db766a810876b563a77b8de18544daf912 100644
--- a/src/components/super-spawner.js
+++ b/src/components/super-spawner.js
@@ -1,3 +1,8 @@
+/**
+ * Spawns networked objects when grabbed.
+ * @namespace network
+ * @component super-spawner
+ */
AFRAME.registerComponent("super-spawner", {
schema: {
template: { default: "" },
diff --git a/src/components/text-button.js b/src/components/text-button.js
index 2668694c01d8efc973e7c8bdfd65596554e1ea7b..67af3653dcc4c9e81b59aec376feab6a00eb7fe4 100644
--- a/src/components/text-button.js
+++ b/src/components/text-button.js
@@ -1,3 +1,8 @@
+/**
+ * A button with text and haptics
+ * @namespace ui
+ * @component text-button
+ */
AFRAME.registerComponent("text-button", {
schema: {
haptic: { type: "selector" },
diff --git a/src/components/virtual-gamepad-controls.js b/src/components/virtual-gamepad-controls.js
index 5b45d07cbb197ae144f0450b31b7e29078c368f1..5da2c3c8ebd0c27530d5eb45b546b6dc0558bc2e 100644
--- a/src/components/virtual-gamepad-controls.js
+++ b/src/components/virtual-gamepad-controls.js
@@ -1,6 +1,11 @@
import nipplejs from "nipplejs";
import styles from "./virtual-gamepad-controls.css";
+/**
+ * Instantiates 2D virtual gamepads and emits associated events.
+ * @namespace user-input
+ * @component virtual-gamepad-controls
+ */
AFRAME.registerComponent("virtual-gamepad-controls", {
schema: {},
diff --git a/src/components/visible-while-frozen.js b/src/components/visible-while-frozen.js
index 59448cb6b989034699d879daae0a1ac1690c39af..4acff3d420136fee0393dc84ae32e14c6779553b 100644
--- a/src/components/visible-while-frozen.js
+++ b/src/components/visible-while-frozen.js
@@ -1,3 +1,8 @@
+/**
+ * Toggles the visibility of this entity when the scene is frozen.
+ * @namespace ui
+ * @component visible-while-frozen
+ */
AFRAME.registerComponent("visible-while-frozen", {
init() {
this.onStateChange = evt => {
@@ -18,6 +23,11 @@ AFRAME.registerComponent("visible-while-frozen", {
}
});
+/**
+ * Toggles the interactivity of a UI entity while the scene is frozen.
+ * @namespace ui
+ * @component ui-class-while-frozen
+ */
AFRAME.registerComponent("ui-class-while-frozen", {
init() {
this.onStateChange = evt => {
diff --git a/src/components/wasd-to-analog2d.js b/src/components/wasd-to-analog2d.js
index a86641623b348f67c743e1845f51dd1c6e9ccb7f..a99babe7d65221a7f527e1cdd563cdaad708bbe9 100644
--- a/src/components/wasd-to-analog2d.js
+++ b/src/components/wasd-to-analog2d.js
@@ -1,3 +1,8 @@
+/**
+ * Converts WASD keyboard inputs to simulated analog inputs.
+ * @namespace user-input
+ * @component wasd-to-analog2d
+ */
AFRAME.registerComponent("wasd-to-analog2d", {
schema: {
analog2dOutputAction: { default: "wasd_analog2d" }
diff --git a/src/systems/app-mode.js b/src/systems/app-mode.js
index 49e8d361bd90de4612fe4548fc0ecb4cc027d53d..6954d3ad5e364e05954ffa1acc6371d5364854f2 100644
--- a/src/systems/app-mode.js
+++ b/src/systems/app-mode.js
@@ -4,6 +4,7 @@ export const AppModes = Object.freeze({ DEFAULT: "default", HUD: "hud" });
/**
* Simple system for keeping track of a modal app state
+ * @system app-mode
*/
AFRAME.registerSystem("app-mode", {
init() {
@@ -20,6 +21,8 @@ AFRAME.registerSystem("app-mode", {
/**
* Toggle the isPlaying state of a component based on app mode
+ * @namespace app-mode
+ * @component app-mode-toggle-playing
*/
AFRAME.registerComponent("app-mode-toggle-playing", {
multiple: true,
@@ -44,6 +47,8 @@ AFRAME.registerComponent("app-mode-toggle-playing", {
/**
* Toggle a boolean property of a component based on app mode
+ * @namespace app-mode
+ * @component app-mode-toggle-attribute
*/
AFRAME.registerComponent("app-mode-toggle-attribute", {
multiple: true,
@@ -69,6 +74,8 @@ AFRAME.registerComponent("app-mode-toggle-attribute", {
/**
* Toggle aframe input mappings action set based on app mode
+ * @namespace app-mode
+ * @component app-mode-input-mappings
*/
AFRAME.registerComponent("app-mode-input-mappings", {
schema: {
@@ -91,6 +98,8 @@ AFRAME.registerComponent("app-mode-input-mappings", {
/**
* Toggle visibility of an entity based on if the user is in vr mode or not
+ * @namespace vr-mode
+ * @component vr-mode-toggle-visibility
*/
AFRAME.registerComponent("vr-mode-toggle-visibility", {
schema: {
@@ -120,6 +129,8 @@ AFRAME.registerComponent("vr-mode-toggle-visibility", {
/**
* Toggle the isPlaying state of a component based on app mode
+ * @namespace vr-mode
+ * @component vr-mode-toggle-playing
*/
AFRAME.registerComponent("vr-mode-toggle-playing", {
multiple: true,
diff --git a/src/systems/exit-on-blur.js b/src/systems/exit-on-blur.js
index c6820a4016cbd3440bab91997e19741b006b6b29..5fe0b6fd6f7f87ae431e6844935cd4bcb44595e2 100644
--- a/src/systems/exit-on-blur.js
+++ b/src/systems/exit-on-blur.js
@@ -1,3 +1,7 @@
+/**
+ * Emits an "exit" event when a user has stopped using the app for a certain period of time
+ * @system exit-on-blur
+ */
AFRAME.registerSystem("exit-on-blur", {
init() {
this.onBlur = this.onBlur.bind(this);
diff --git a/src/systems/personal-space-bubble.js b/src/systems/personal-space-bubble.js
index d89a59cae4ff907f777f98d6327ef704cc1e38e3..0ba3cee5d48a1b5095031db89f9fa2cf6e490429 100644
--- a/src/systems/personal-space-bubble.js
+++ b/src/systems/personal-space-bubble.js
@@ -1,6 +1,12 @@
const invaderPos = new AFRAME.THREE.Vector3();
const bubblePos = new AFRAME.THREE.Vector3();
+/**
+ * Iterates through bubbles and invaders on every tick and sets invader state accordingly.
+ * testing multiline things
+ * @namespace avatar/personal-space-bubble
+ * @system personal-space-bubble
+ */
AFRAME.registerSystem("personal-space-bubble", {
schema: {
debug: { default: false },
@@ -110,6 +116,11 @@ function createSphereGizmo(radius) {
}
// TODO: we need to come up with a more generic way of doing this as this is very specific to our avatars.
+/**
+ * Specifies a mesh associated with an invader.
+ * @namespace avatar/personal-space-bubble
+ * @component space-invader-mesh
+ */
AFRAME.registerComponent("space-invader-mesh", {
schema: {
meshSelector: { type: "string" }
@@ -128,6 +139,11 @@ function findInvaderMesh(entity) {
const DEBUG_OBJ = "psb-debug";
+/**
+ * Represents an entity that can invade a personal space bubble
+ * @namespace avatar/personal-space-bubble
+ * @component personal-space-invader
+ */
AFRAME.registerComponent("personal-space-invader", {
schema: {
radius: { type: "number", default: 0.1 },
@@ -177,6 +193,11 @@ AFRAME.registerComponent("personal-space-invader", {
}
});
+/**
+ * Represents a personal space bubble on an entity.
+ * @namespace avatar/personal-space-bubble
+ * @component personal-space-bubble
+ */
AFRAME.registerComponent("personal-space-bubble", {
schema: {
radius: { type: "number", default: 0.8 },
diff --git a/yarn.lock b/yarn.lock
index f4ec5109406b9005f252a2f450f1f2f1f0971061..86387c5f8ee357b53924ffac3acc92c4bc2664bc 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -152,10 +152,14 @@ acorn@^4.0.3:
version "4.0.13"
resolved "https://registry.yarnpkg.com/acorn/-/acorn-4.0.13.tgz#105495ae5361d697bd195c825192e1ad7f253787"
-acorn@^5.0.0, acorn@^5.2.1, acorn@^5.4.0, acorn@^5.4.1:
+acorn@^5.0.0, acorn@^5.2.1, acorn@^5.4.1:
version "5.4.1"
resolved "https://registry.yarnpkg.com/acorn/-/acorn-5.4.1.tgz#fdc58d9d17f4a4e98d102ded826a9b9759125102"
+acorn@^5.5.0:
+ version "5.5.3"
+ resolved "https://registry.yarnpkg.com/acorn/-/acorn-5.5.3.tgz#f473dd47e0277a08e28e9bec5aeeb04751f0b8c9"
+
aframe-billboard-component@^1.0.0:
version "1.0.0"
resolved "https://registry.yarnpkg.com/aframe-billboard-component/-/aframe-billboard-component-1.0.0.tgz#10ce2482729eef7386c5844d65917581a62d3adc"
@@ -208,7 +212,11 @@ after@0.8.2:
version "0.8.2"
resolved "https://registry.yarnpkg.com/after/-/after-0.8.2.tgz#fedb394f9f0e02aa9768e702bda23b505fae7e1f"
-ajv-keywords@^3.0.0, ajv-keywords@^3.1.0:
+ajv-keywords@^2.1.0:
+ version "2.1.1"
+ resolved "https://registry.yarnpkg.com/ajv-keywords/-/ajv-keywords-2.1.1.tgz#617997fc5f60576894c435f940d819e135b80762"
+
+ajv-keywords@^3.1.0:
version "3.1.0"
resolved "https://registry.yarnpkg.com/ajv-keywords/-/ajv-keywords-3.1.0.tgz#ac2b27939c543e95d2c06e7f7f5c27be4aa543be"
@@ -219,7 +227,7 @@ ajv@^4.9.1:
co "^4.6.0"
json-stable-stringify "^1.0.1"
-ajv@^5.3.0:
+ajv@^5.2.3, ajv@^5.3.0:
version "5.5.2"
resolved "https://registry.yarnpkg.com/ajv/-/ajv-5.5.2.tgz#73b5eeca3fab653e3d3f9422b341ad42205dc965"
dependencies:
@@ -228,7 +236,7 @@ ajv@^5.3.0:
fast-json-stable-stringify "^2.0.0"
json-schema-traverse "^0.3.0"
-ajv@^6.0.1, ajv@^6.1.0:
+ajv@^6.1.0:
version "6.1.1"
resolved "https://registry.yarnpkg.com/ajv/-/ajv-6.1.1.tgz#978d597fbc2b7d0e5a5c3ddeb149a682f2abfa0e"
dependencies:
@@ -249,8 +257,8 @@ ansi-escapes@^1.0.0, ansi-escapes@^1.1.0:
resolved "https://registry.yarnpkg.com/ansi-escapes/-/ansi-escapes-1.4.0.tgz#d3a8a83b319aa67793662b13e761c7911422306e"
ansi-escapes@^3.0.0:
- version "3.0.0"
- resolved "https://registry.yarnpkg.com/ansi-escapes/-/ansi-escapes-3.0.0.tgz#ec3e8b4e9f8064fc02c3ac9b65f1c275bda8ef92"
+ version "3.1.0"
+ resolved "https://registry.yarnpkg.com/ansi-escapes/-/ansi-escapes-3.1.0.tgz#f73207bb81207d75fd6c83f125af26eea378ca30"
ansi-html@0.0.7:
version "0.0.7"
@@ -280,9 +288,9 @@ ansi-styles@^2.2.1:
version "2.2.1"
resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-2.2.1.tgz#b432dd3358b634cf75e1e4664368240533c1ddbe"
-ansi-styles@^3.2.0:
- version "3.2.0"
- resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-3.2.0.tgz#c159b8d5be0f9e5a6f346dab94f16ce022161b88"
+ansi-styles@^3.2.0, ansi-styles@^3.2.1:
+ version "3.2.1"
+ resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-3.2.1.tgz#41fbb20243e50b12be0f04b8dedbf07520ce841d"
dependencies:
color-convert "^1.9.0"
@@ -1608,6 +1616,10 @@ budo@^10.0.3:
ws "^1.1.1"
xtend "^4.0.0"
+buffer-from@^1.0.0:
+ version "1.0.0"
+ resolved "https://registry.yarnpkg.com/buffer-from/-/buffer-from-1.0.0.tgz#4cb8832d23612589b0406e9e2956c17f06fdf531"
+
buffer-indexof@^1.0.0:
version "1.1.1"
resolved "https://registry.yarnpkg.com/buffer-indexof/-/buffer-indexof-1.1.1.tgz#52fabcc6a606d1a00302802648ef68f639da268c"
@@ -1768,7 +1780,15 @@ chalk@^1.0.0, chalk@^1.1.1, chalk@^1.1.3:
strip-ansi "^3.0.0"
supports-color "^2.0.0"
-chalk@^2.0.0, chalk@^2.0.1, chalk@^2.1.0, chalk@^2.3.1:
+chalk@^2.0.0, chalk@^2.1.0:
+ version "2.4.1"
+ resolved "https://registry.yarnpkg.com/chalk/-/chalk-2.4.1.tgz#18c49ab16a037b6eb0152cc83e3471338215b66e"
+ dependencies:
+ ansi-styles "^3.2.1"
+ escape-string-regexp "^1.0.5"
+ supports-color "^5.3.0"
+
+chalk@^2.0.1, chalk@^2.3.1:
version "2.3.1"
resolved "https://registry.yarnpkg.com/chalk/-/chalk-2.3.1.tgz#523fe2678aec7b04e8041909292fe8b17059b796"
dependencies:
@@ -2101,7 +2121,7 @@ concat-map@0.0.1:
version "0.0.1"
resolved "https://registry.yarnpkg.com/concat-map/-/concat-map-0.0.1.tgz#d8a96bd77fd68df7793a73036a3ba0d5405d477b"
-concat-stream@^1.4.7, concat-stream@^1.5.0, concat-stream@^1.6.0, concat-stream@~1.6.0:
+concat-stream@^1.4.7, concat-stream@^1.5.0, concat-stream@~1.6.0:
version "1.6.0"
resolved "https://registry.yarnpkg.com/concat-stream/-/concat-stream-1.6.0.tgz#0aac662fd52be78964d5532f694784e70110acf7"
dependencies:
@@ -2109,6 +2129,15 @@ concat-stream@^1.4.7, concat-stream@^1.5.0, concat-stream@^1.6.0, concat-stream@
readable-stream "^2.2.2"
typedarray "^0.0.6"
+concat-stream@^1.6.0:
+ version "1.6.2"
+ resolved "https://registry.yarnpkg.com/concat-stream/-/concat-stream-1.6.2.tgz#904bdf194cd3122fc675c77fc4ac3d4ff0fd1a34"
+ dependencies:
+ buffer-from "^1.0.0"
+ inherits "^2.0.3"
+ readable-stream "^2.2.2"
+ typedarray "^0.0.6"
+
concat-stream@~1.5.0, concat-stream@~1.5.1:
version "1.5.2"
resolved "https://registry.yarnpkg.com/concat-stream/-/concat-stream-1.5.2.tgz#708978624d856af41a5a741defdd261da752c266"
@@ -2937,8 +2966,8 @@ eslint-visitor-keys@^1.0.0:
resolved "https://registry.yarnpkg.com/eslint-visitor-keys/-/eslint-visitor-keys-1.0.0.tgz#3f3180fb2e291017716acb4c9d6d5b5c34a6a81d"
eslint@^4.10.0:
- version "4.18.1"
- resolved "https://registry.yarnpkg.com/eslint/-/eslint-4.18.1.tgz#b9138440cb1e98b2f44a0d578c6ecf8eae6150b0"
+ version "4.19.1"
+ resolved "https://registry.yarnpkg.com/eslint/-/eslint-4.19.1.tgz#32d1d653e1d90408854bfb296f076ec7e186a300"
dependencies:
ajv "^5.3.0"
babel-code-frame "^6.22.0"
@@ -2949,7 +2978,7 @@ eslint@^4.10.0:
doctrine "^2.1.0"
eslint-scope "^3.7.1"
eslint-visitor-keys "^1.0.0"
- espree "^3.5.2"
+ espree "^3.5.4"
esquery "^1.0.0"
esutils "^2.0.2"
file-entry-cache "^2.0.0"
@@ -2971,18 +3000,19 @@ eslint@^4.10.0:
path-is-inside "^1.0.2"
pluralize "^7.0.0"
progress "^2.0.0"
+ regexpp "^1.0.1"
require-uncached "^1.0.3"
semver "^5.3.0"
strip-ansi "^4.0.0"
strip-json-comments "~2.0.1"
- table "^4.0.1"
+ table "4.0.2"
text-table "~0.2.0"
-espree@^3.5.2:
- version "3.5.3"
- resolved "https://registry.yarnpkg.com/espree/-/espree-3.5.3.tgz#931e0af64e7fbbed26b050a29daad1fc64799fa6"
+espree@^3.5.4:
+ version "3.5.4"
+ resolved "https://registry.yarnpkg.com/espree/-/espree-3.5.4.tgz#b0f447187c8a8bed944b815a660bddf5deb5d1a7"
dependencies:
- acorn "^5.4.0"
+ acorn "^5.5.0"
acorn-jsx "^3.0.0"
esprima@^2.6.0:
@@ -2998,8 +3028,8 @@ esprima@~3.1.0:
resolved "https://registry.yarnpkg.com/esprima/-/esprima-3.1.3.tgz#fdca51cee6133895e3c88d535ce49dbff62a4633"
esquery@^1.0.0:
- version "1.0.0"
- resolved "https://registry.yarnpkg.com/esquery/-/esquery-1.0.0.tgz#cfba8b57d7fba93f17298a8a006a04cda13d80fa"
+ version "1.0.1"
+ resolved "https://registry.yarnpkg.com/esquery/-/esquery-1.0.1.tgz#406c51658b1f5991a5f9b62b1dc25b00e3e5c708"
dependencies:
estraverse "^4.0.0"
@@ -3196,8 +3226,8 @@ external-editor@^1.1.0:
tmp "^0.0.29"
external-editor@^2.0.4:
- version "2.1.0"
- resolved "https://registry.yarnpkg.com/external-editor/-/external-editor-2.1.0.tgz#3d026a21b7f95b5726387d4200ac160d372c3b48"
+ version "2.2.0"
+ resolved "https://registry.yarnpkg.com/external-editor/-/external-editor-2.2.0.tgz#045511cfd8d133f3846673d1047c154e214ad3d5"
dependencies:
chardet "^0.4.0"
iconv-lite "^0.4.17"
@@ -3695,7 +3725,11 @@ global@^4.3.2:
min-document "^2.19.0"
process "~0.5.1"
-globals@^11.0.1, globals@^11.1.0:
+globals@^11.0.1:
+ version "11.5.0"
+ resolved "https://registry.yarnpkg.com/globals/-/globals-11.5.0.tgz#6bc840de6771173b191f13d3a9c94d441ee92642"
+
+globals@^11.1.0:
version "11.3.0"
resolved "https://registry.yarnpkg.com/globals/-/globals-11.3.0.tgz#e04fdb7b9796d8adac9c8f64c14837b2313378b0"
@@ -4115,10 +4149,16 @@ humps@^2.0.1:
version "2.0.1"
resolved "https://registry.yarnpkg.com/humps/-/humps-2.0.1.tgz#dd02ea6081bd0568dc5d073184463957ba9ef9aa"
-iconv-lite@0.4.19, iconv-lite@^0.4.17, iconv-lite@~0.4.13:
+iconv-lite@0.4.19, iconv-lite@~0.4.13:
version "0.4.19"
resolved "https://registry.yarnpkg.com/iconv-lite/-/iconv-lite-0.4.19.tgz#f7468f60135f5e5dad3399c0a81be9a1603a082b"
+iconv-lite@^0.4.17:
+ version "0.4.23"
+ resolved "https://registry.yarnpkg.com/iconv-lite/-/iconv-lite-0.4.23.tgz#297871f63be507adcfbfca715d0cd0eed84e9a63"
+ dependencies:
+ safer-buffer ">= 2.1.2 < 3"
+
icss-replace-symbols@^1.1.0:
version "1.1.0"
resolved "https://registry.yarnpkg.com/icss-replace-symbols/-/icss-replace-symbols-1.1.0.tgz#06ea6f83679a7749e386cfe1fe812ae5db223ded"
@@ -4137,7 +4177,11 @@ iferr@^0.1.5:
version "0.1.5"
resolved "https://registry.yarnpkg.com/iferr/-/iferr-0.1.5.tgz#c60eed69e6d8fdb6b3104a1fcbca1c192dc5b501"
-ignore@^3.3.3, ignore@^3.3.5:
+ignore@^3.3.3:
+ version "3.3.8"
+ resolved "https://registry.yarnpkg.com/ignore/-/ignore-3.3.8.tgz#3f8e9c35d38708a3a7e0e9abb6c73e7ee7707b2b"
+
+ignore@^3.3.5:
version "3.3.7"
resolved "https://registry.yarnpkg.com/ignore/-/ignore-3.3.7.tgz#612289bfb3c220e186a58118618d5be8c1bab021"
@@ -4487,8 +4531,8 @@ is-path-cwd@^1.0.0:
resolved "https://registry.yarnpkg.com/is-path-cwd/-/is-path-cwd-1.0.0.tgz#d225ec23132e89edd38fda767472e62e65f1106d"
is-path-in-cwd@^1.0.0:
- version "1.0.0"
- resolved "https://registry.yarnpkg.com/is-path-in-cwd/-/is-path-in-cwd-1.0.0.tgz#6477582b8214d602346094567003be8a9eac04dc"
+ version "1.0.1"
+ resolved "https://registry.yarnpkg.com/is-path-in-cwd/-/is-path-in-cwd-1.0.1.tgz#5ac48b345ef675339bd6c7a48a912110b241cf52"
dependencies:
is-path-inside "^1.0.0"
@@ -4635,8 +4679,8 @@ js-tokens@^3.0.0, js-tokens@^3.0.2:
resolved "https://registry.yarnpkg.com/js-tokens/-/js-tokens-3.0.2.tgz#9866df395102130e38f7f996bceb65443209c25b"
js-yaml@^3.9.1:
- version "3.10.0"
- resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-3.10.0.tgz#2e78441646bd4682e963f22b6e92823c309c62dc"
+ version "3.11.0"
+ resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-3.11.0.tgz#597c1a8bd57152f26d622ce4117851a51f5ebaef"
dependencies:
argparse "^1.0.7"
esprima "^4.0.0"
@@ -4967,10 +5011,14 @@ lodash@3.7.x:
version "3.7.0"
resolved "https://registry.yarnpkg.com/lodash/-/lodash-3.7.0.tgz#3678bd8ab995057c07ade836ed2ef087da811d45"
-lodash@^4.0.0, lodash@^4.11.1, lodash@^4.13.1, lodash@^4.14.0, lodash@^4.17.2, lodash@^4.17.3, lodash@^4.17.4, lodash@^4.17.5, lodash@^4.2.0, lodash@^4.3.0, lodash@~4.17.4:
+lodash@^4.0.0, lodash@^4.11.1, lodash@^4.13.1, lodash@^4.14.0, lodash@^4.17.2, lodash@^4.17.3, lodash@^4.17.5, lodash@^4.2.0, lodash@~4.17.4:
version "4.17.5"
resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.5.tgz#99a92d65c0272debe8c96b6057bc8fbfa3bed511"
+lodash@^4.17.4, lodash@^4.3.0:
+ version "4.17.10"
+ resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.10.tgz#1b7793cf7259ea38fb3661d4d38b3260af8ae4e7"
+
log-symbols@2.1.0, log-symbols@^2.1.0:
version "2.1.0"
resolved "https://registry.yarnpkg.com/log-symbols/-/log-symbols-2.1.0.tgz#f35fa60e278832b538dc4dddcbb478a45d3e3be6"
@@ -5023,7 +5071,14 @@ lru-cache@2:
version "2.7.3"
resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-2.7.3.tgz#6d4524e8b955f95d4f5b58851ce21dd72fb4e952"
-lru-cache@^4.0.1, lru-cache@^4.1.1:
+lru-cache@^4.0.1:
+ version "4.1.3"
+ resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-4.1.3.tgz#a1175cf3496dfc8436c156c334b4955992bce69c"
+ dependencies:
+ pseudomap "^1.0.2"
+ yallist "^2.1.2"
+
+lru-cache@^4.1.1:
version "4.1.1"
resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-4.1.1.tgz#622e32e82488b49279114a4f9ecf45e7cd6bba55"
dependencies:
@@ -6670,7 +6725,7 @@ read-pkg@^2.0.0:
normalize-package-data "^2.3.2"
path-type "^2.0.0"
-"readable-stream@1 || 2", readable-stream@^2.0.0, readable-stream@^2.0.1, readable-stream@^2.0.2, readable-stream@^2.0.4, readable-stream@^2.0.6, readable-stream@^2.1.4, readable-stream@^2.1.5, readable-stream@^2.2.2, readable-stream@^2.2.9, readable-stream@^2.3.3:
+"readable-stream@1 || 2", readable-stream@^2.0.0, readable-stream@^2.0.1, readable-stream@^2.0.2, readable-stream@^2.0.4, readable-stream@^2.0.6, readable-stream@^2.1.4, readable-stream@^2.1.5, readable-stream@^2.2.9, readable-stream@^2.3.3:
version "2.3.4"
resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-2.3.4.tgz#c946c3f47fa7d8eabc0b6150f4a12f69a4574071"
dependencies:
@@ -6700,6 +6755,18 @@ readable-stream@1.1:
isarray "0.0.1"
string_decoder "~0.10.x"
+readable-stream@^2.2.2:
+ version "2.3.6"
+ resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-2.3.6.tgz#b11c27d88b8ff1fbe070643cf94b0c79ae1b0aaf"
+ dependencies:
+ core-util-is "~1.0.0"
+ inherits "~2.0.3"
+ isarray "~1.0.0"
+ process-nextick-args "~2.0.0"
+ safe-buffer "~5.1.1"
+ string_decoder "~1.1.1"
+ util-deprecate "~1.0.1"
+
readable-stream@~2.0.0:
version "2.0.6"
resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-2.0.6.tgz#8f90341e68a53ccc928788dacfcd11b36eb9b78e"
@@ -6804,6 +6871,10 @@ regex-not@^1.0.0:
extend-shallow "^3.0.2"
safe-regex "^1.1.0"
+regexpp@^1.0.1:
+ version "1.1.0"
+ resolved "https://registry.yarnpkg.com/regexpp/-/regexpp-1.1.0.tgz#0e3516dd0b7904f413d2d4193dce4618c3a689ab"
+
regexpu-core@^1.0.0:
version "1.0.0"
resolved "https://registry.yarnpkg.com/regexpu-core/-/regexpu-core-1.0.0.tgz#86a763f58ee4d7c2f6b102e4764050de7ed90c6b"
@@ -7070,16 +7141,24 @@ rxjs@^5.0.0-beta.11:
dependencies:
symbol-observable "1.0.1"
-safe-buffer@5.1.1, safe-buffer@^5.0.1, safe-buffer@^5.1.0, safe-buffer@^5.1.1, safe-buffer@~5.1.0, safe-buffer@~5.1.1:
+safe-buffer@5.1.1, safe-buffer@^5.0.1, safe-buffer@^5.1.0, safe-buffer@^5.1.1:
version "5.1.1"
resolved "https://registry.yarnpkg.com/safe-buffer/-/safe-buffer-5.1.1.tgz#893312af69b2123def71f57889001671eeb2c853"
+safe-buffer@~5.1.0, safe-buffer@~5.1.1:
+ version "5.1.2"
+ resolved "https://registry.yarnpkg.com/safe-buffer/-/safe-buffer-5.1.2.tgz#991ec69d296e0313747d59bdfd2b745c35f8828d"
+
safe-regex@^1.1.0:
version "1.1.0"
resolved "https://registry.yarnpkg.com/safe-regex/-/safe-regex-1.1.0.tgz#40a3669f3b077d1e943d44629e157dd48023bf2e"
dependencies:
ret "~0.1.10"
+"safer-buffer@>= 2.1.2 < 3":
+ version "2.1.2"
+ resolved "https://registry.yarnpkg.com/safer-buffer/-/safer-buffer-2.1.2.tgz#44fa161b0187b9549dd84bb91802f9bd8385cd6a"
+
sass-graph@^2.2.4:
version "2.2.4"
resolved "https://registry.yarnpkg.com/sass-graph/-/sass-graph-2.2.4.tgz#13fbd63cd1caf0908b9fd93476ad43a51d1e0b49"
@@ -7681,6 +7760,12 @@ string_decoder@~0.10.x:
version "0.10.31"
resolved "https://registry.yarnpkg.com/string_decoder/-/string_decoder-0.10.31.tgz#62e203bc41766c6c28c9fc84301dab1c5310fa94"
+string_decoder@~1.1.1:
+ version "1.1.1"
+ resolved "https://registry.yarnpkg.com/string_decoder/-/string_decoder-1.1.1.tgz#9cf1611ba62685d7030ae9e4ba34149c3af03fc8"
+ dependencies:
+ safe-buffer "~5.1.0"
+
stringstream@~0.0.4:
version "0.0.5"
resolved "https://registry.yarnpkg.com/stringstream/-/stringstream-0.0.5.tgz#4e484cd4de5a0bbbee18e46307710a8a81621878"
@@ -7783,12 +7868,18 @@ supports-color@^4.4.0:
dependencies:
has-flag "^2.0.0"
-supports-color@^5.1.0, supports-color@^5.2.0:
+supports-color@^5.1.0:
version "5.2.0"
resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-5.2.0.tgz#b0d5333b1184dd3666cbe5aa0b45c5ac7ac17a4a"
dependencies:
has-flag "^3.0.0"
+supports-color@^5.2.0, supports-color@^5.3.0:
+ version "5.4.0"
+ resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-5.4.0.tgz#1c6b337402c2137605efe19f10fec390f6faab54"
+ dependencies:
+ has-flag "^3.0.0"
+
svgo@^0.7.0:
version "0.7.2"
resolved "https://registry.yarnpkg.com/svgo/-/svgo-0.7.2.tgz#9f5772413952135c6fefbf40afe6a4faa88b4bb5"
@@ -7811,12 +7902,12 @@ syntax-error@^1.1.1:
dependencies:
acorn-node "^1.2.0"
-table@^4.0.1:
- version "4.0.3"
- resolved "https://registry.yarnpkg.com/table/-/table-4.0.3.tgz#00b5e2b602f1794b9acaf9ca908a76386a7813bc"
+table@4.0.2:
+ version "4.0.2"
+ resolved "https://registry.yarnpkg.com/table/-/table-4.0.2.tgz#a33447375391e766ad34d3486e6e2aedc84d2e36"
dependencies:
- ajv "^6.0.1"
- ajv-keywords "^3.0.0"
+ ajv "^5.2.3"
+ ajv-keywords "^2.1.0"
chalk "^2.1.0"
lodash "^4.17.4"
slice-ansi "1.0.0"