bonsai-search 3.0.8

package/README.md

@@ -0,0 +1,84 @@
+# Bonsai SDK
+
+The build and CDN publish system for the Bonsai Search SDK.
+
+## Development
+
+- Install dependencies:
+
+```bash
+npm install
+```
+
+- Run the unit tests:
+
+```bash
+npm run test
+```
+
+- Build the library:
+
+```bash
+npm run build
+```
+
+## I just want to test the SDK with a tenant
+
+```bash
+cd sdk
+npm install
+npm run build
+npx serve
+#edit index.html to suit your test (apikey mostly)
+open http://localhost:3000
+```
+
+## Unhandled case right now
+
+```javascript
+renderResults(data, results) {
+    if (!this.resultsContainer)
+        return;
+
+    //This was to remove all faw content for bathhouse and just let the recommendation stand alone as "THE answer"
+    for (let i = results.length - 1; i >= 0; i--) {
+        if (!results[i].productType === "faq") {
+            results.splice(i, 1);
+        }
+    }
+```
+
+## Aurora Integration
+
+inside a `<script>` tag:
+
+```javascript
+function waitForWindowObject(objectName, interval = 100) {
+  return new Promise((resolve) => {
+    const intervalId = setInterval(() => {
+      if (window[objectName]) {
+        clearInterval(intervalId);
+        resolve(window[objectName]);
+      }
+    }, interval);
+  });
+}
+waitForWindowObject("BonsaiSearch").then(() => {
+  const search = new BonsaiSearch({
+    container: document.getElementsByClassName("framer-ys3trd-container")[0],
+    apiKey: "FA3s_HgeI-oc1zogV8qRnT06s4NJJwaRgmDlo7eL0DiEo7ZTpZoqc9bwcLDb8Z4_", // Replace with your API key
+    baseUrl: "https://api.hibonsai.com/rest/search/v2/", // Replace with your API URL
+    placeholder: "Ask us any question here...",
+    suggestions: ["suggestion 1", "suggestion 2", "suggestion 3"],
+    onSearch: (query) => {
+      console.log("Searching for:", query);
+    },
+    onResults: (results) => {
+      console.log("Found results:", results);
+    },
+    onError: (error) => {
+      console.error("Search error:", error);
+    },
+  });
+});
+```