@rtsdk/topia 0.0.21 → 0.0.23

package/LICENSE.md

@@ -0,0 +1,15 @@
+BSD 3-Clause License
+
+Copyright (c) 2023, metaversecloud.com | topia.io
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+- Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -8,6 +8,32 @@ The Topia Client Library leverages the Topia Public API and allows users to inte
 
 A Topia provided API Key can 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.
 
+### Want to build interactive assets? This is how you can get started:
+
+- Email developers@metaversecloud.com and Topia wil send you a Public/Private key pair.
+- When you want to make an asset “interactive” add your PUBLIC key to the integrations page of the asset editor. Now webhooks that fire from this asset and iframes that open from this asset include the following values:
+  - assetId
+  - interactivePublicKey
+  - interactiveNonce
+  - visitorId
+  - urlSlug
+- The above values are included in the query params of the iframe URL as well as payload of the webhook.
+- Once you have the above values you can pass them as credentials into the factory classes when creating class instances.
+
+```ts
+await DroppedAsset.get(assetId, urlSlug, {
+  credentials: {
+    assetId,
+    interactivePublicKey,
+    interactiveNonce,
+    visitorId,
+    urlSlug,
+  },
+});
+```
+
+<br />
+
 ### Need an API Key to test locally? This is how you can create one:
 
 - While logged in to [topia.io](https://topia.io/), click on your image (or gray circle) in the top left of the screen to open My Account

package/dist/example.js

@@ -20,13 +20,13 @@ const DroppedAsset = new DroppedAssetFactory(myTopiaInstance);
 const TopiaWorld = new TopiaWorldFactory(myTopiaInstance);
 export default { myTopiaInstance, DroppedAsset, TopiaWorld };
 const setTextOnAsset = (req, res) => __awaiter(void 0, void 0, void 0, function* () {
-    const asset = yield DroppedAsset.get(req.body.assetId, req.body.urlSlug, { creds: req.body });
+    const asset = yield DroppedAsset.get(req.body.assetId, req.body.urlSlug, { credentials: req.body });
     yield asset.setAssetText(req.body.text);
 });
 import { myTopiaInterface } from "./src";
 const setTextOnAsset = (req, res) => __awaiter(void 0, void 0, void 0, function* () {
     const asset = yield new DroppedAssetFactory(myTopiaInterface).get(req.body.assetId, req.body.urlSlug, {
-        creds: req.body,
+        credentials: req.body,
     });
     yield asset.setAssetText(req.body.text);
 });