@rtsdk/topia 0.0.10 → 0.0.11

package/README.md

@@ -0,0 +1,19 @@
+# Javascript RTSDK - Topia Client Library
+
+The Topia Client Library leverages the Topia Public API and allows users to interact with the topia systems and modify their world programmatically.
+
+## Get Started
+
+Run `yarn add @rtsdk/topia` or `npm install @rtsdk/topia`
+
+## Authorization
+
+A Topia provided API Key should be included with every object initialization as a parameter named `apiKey`. This API Key is used to in authorization headers in all calls to the Public API.
+
+## Testing
+
+We use Jest for testing and take advantage of dependency injection to pass mock data into our services.
+
+To run the test suite, please run:
+
+`yarn test`

package/dist/controllers/User.js

@@ -12,6 +12,13 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var _User_worldsMap;
 import { World } from "controllers/World";
 import { getErrorMessage, publicAPI } from "utils";
+/**
+ * Create an instance of User class with a given apiKey
+ *
+ * ```ts
+ * await new User({ apiKey: API_KEY, email: "example@email.io" })
+ * ```
+ */
 export class User {
     constructor({ apiKey, email }) {
         _User_worldsMap.set(this, void 0);
@@ -22,6 +29,10 @@ export class User {
     get worlds() {
         return __classPrivateFieldGet(this, _User_worldsMap, "f");
     }
+    /**
+     * @summary
+     * Returns all scenes owned by User when an email address is provided
+     */
     fetchScenesByEmail() {
         return new Promise((resolve, reject) => {
             if (!this.email)
@@ -36,6 +47,23 @@ export class User {
             });
         });
     }
+    /**
+     * @summary
+     * Retrieves all worlds owned by user with matching API Key,
+     * creates a new World object for each,
+     * and creates new map of Worlds accessible via user.worlds
+     *
+     * @usage
+     * ```ts
+     * await user.fetchWorldsByKey();
+     * const userWorlds = user.worlds;
+     * ```
+     *
+     * @result
+     * ```ts
+     * { urlSlug: new World({ apiKey, worldArgs, urlSlug }) }
+     * ```
+     */
     fetchWorldsByKey() {
         return new Promise((resolve, reject) => {
             publicAPI(this.apiKey)