@basictech/react 0.2.0-beta.5 → 0.2.0-beta.7

package/changelog.md

@@ -1,5 +1,20 @@
 # 1.3.4
 
+## 0.2.0-beta.7
+
+### Minor Changes
+
+- update useQuery hook
+
+  - no need to pass param as a function, can now enter query directly
+  - defaults to empty array when loading
+
+## 0.2.0-beta.6
+
+### Minor Changes
+
+- add debug option
+
 ## 0.2.0-beta.5
 
 ### Minor Changes

package/dist/index.d.mts

@@ -1,6 +1,5 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import React from 'react';
-export { useLiveQuery as useQuery } from 'dexie-react-hooks';
 
 declare enum DBStatus {
     LOADING = "LOADING",
@@ -19,10 +18,11 @@ type User = {
     };
     fullName?: string;
 };
-declare function BasicProvider({ children, project_id, schema }: {
+declare function BasicProvider({ children, project_id, schema, debug }: {
     children: React.ReactNode;
     project_id: string;
     schema: any;
+    debug?: boolean;
 }): react_jsx_runtime.JSX.Element;
 declare function useBasic(): {
     unicorn: string;
@@ -37,4 +37,6 @@ declare function useBasic(): {
     dbStatus: DBStatus;
 };
 
-export { BasicProvider, useBasic };
+declare function useQuery(queryable: any): any;
+
+export { BasicProvider, useBasic, useQuery };

package/dist/index.d.ts

@@ -1,6 +1,5 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import React from 'react';
-export { useLiveQuery as useQuery } from 'dexie-react-hooks';
 
 declare enum DBStatus {
     LOADING = "LOADING",
@@ -19,10 +18,11 @@ type User = {
     };
     fullName?: string;
 };
-declare function BasicProvider({ children, project_id, schema }: {
+declare function BasicProvider({ children, project_id, schema, debug }: {
     children: React.ReactNode;
     project_id: string;
     schema: any;
+    debug?: boolean;
 }): react_jsx_runtime.JSX.Element;
 declare function useBasic(): {
     unicorn: string;
@@ -37,4 +37,6 @@ declare function useBasic(): {
     dbStatus: DBStatus;
 };
 
-export { BasicProvider, useBasic };
+declare function useQuery(queryable: any): any;
+
+export { BasicProvider, useBasic, useQuery };

package/dist/index.js

@@ -32,7 +32,7 @@ var src_exports = {};
 __export(src_exports, {
   BasicProvider: () => BasicProvider,
   useBasic: () => useBasic,
-  useQuery: () => import_dexie_react_hooks.useLiveQuery
+  useQuery: () => useQuery
 });
 module.exports = __toCommonJS(src_exports);
 
@@ -48,8 +48,81 @@ var import_dexie_observable = require("dexie-observable");
 
 // src/sync/syncProtocol.js
 var import_dexie = require("dexie");
+
+// src/config.ts
+var import_ajv = __toESM(require("ajv"));
+var SERVER_URL = "https://api.basic.tech";
+var log = (...args) => {
+  try {
+    if (localStorage.getItem("basic_debug") === "true") {
+      console.log("[basic]", ...args);
+    }
+  } catch (e) {
+  }
+};
+var basicJsonSchema = {
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "project_id": {
+      "type": "string"
+    },
+    "namespace": {
+      "type": "string"
+    },
+    "version": {
+      "type": "integer",
+      "minimum": 0
+    },
+    "tables": {
+      "type": "object",
+      "patternProperties": {
+        "^[a-zA-Z0-9_]+$": {
+          "type": "object",
+          "properties": {
+            "name": {
+              "type": "string"
+            },
+            "type": {
+              "type": "string",
+              "enum": ["collection"]
+            },
+            "fields": {
+              "type": "object",
+              "patternProperties": {
+                "^[a-zA-Z0-9_]+$": {
+                  "type": "object",
+                  "properties": {
+                    "type": {
+                      "type": "string"
+                    },
+                    "primary": {
+                      "type": "boolean"
+                    },
+                    "indexed": {
+                      "type": "boolean"
+                    }
+                  },
+                  "required": ["type"]
+                }
+              },
+              "additionalProperties": true
+            }
+          },
+          "required": ["fields"]
+        }
+      },
+      "additionalProperties": true
+    }
+  },
+  "required": ["project_id", "version", "tables"]
+};
+var ajv = new import_ajv.default();
+var validator = ajv.compile(basicJsonSchema);
+
+// src/sync/syncProtocol.js
 var syncProtocol = function() {
-  console.log("Initializing syncProtocol");
+  log("Initializing syncProtocol");
   var RECONNECT_DELAY = 5e3;
   import_dexie.Dexie.Syncable.registerSyncProtocol("websocket", {
     sync: function(context, url, options, baseRevision, syncedRevision, changes, partial, applyRemoteChanges, onChangesAccepted, onSuccess, onError) {
@@ -57,7 +130,7 @@ var syncProtocol = function() {
       var acceptCallbacks = {};
       var ws = new WebSocket(url);
       function sendChanges(changes2, baseRevision2, partial2, onChangesAccepted2) {
-        console.log("sendChanges", changes2.length, baseRevision2);
+        log("sendChanges", changes2.length, baseRevision2);
         ++requestId;
         acceptCallbacks[requestId.toString()] = onChangesAccepted2;
         ws.send(
@@ -71,7 +144,7 @@ var syncProtocol = function() {
         );
       }
       ws.onopen = function(event) {
-        console.log("Opening socket - sending clientIdentity", context.clientIdentity);
+        log("Opening socket - sending clientIdentity", context.clientIdentity);
         ws.send(
           JSON.stringify({
             type: "clientIdentity",
@@ -82,7 +155,7 @@ var syncProtocol = function() {
       };
       ws.onerror = function(event) {
         ws.close();
-        console.log("ws.onerror", event);
+        log("ws.onerror", event);
         onError(event?.message, RECONNECT_DELAY);
       };
       ws.onclose = function(event) {
@@ -92,7 +165,7 @@ var syncProtocol = function() {
       ws.onmessage = function(event) {
         try {
           var requestFromServer = JSON.parse(event.data);
-          console.log("requestFromServer", requestFromServer, { acceptCallback, isFirstRound });
+          log("requestFromServer", requestFromServer, { acceptCallback, isFirstRound });
           if (requestFromServer.type == "clientIdentity") {
             context.clientIdentity = requestFromServer.clientIdentity;
             context.save();
@@ -138,7 +211,7 @@ var syncProtocol = function() {
             ws.close();
             onError(requestFromServer.message, Infinity);
           } else {
-            console.log("unknown message", requestFromServer);
+            log("unknown message", requestFromServer);
             ws.close();
             onError("unknown message", Infinity);
           }
@@ -151,69 +224,6 @@ var syncProtocol = function() {
   });
 };
 
-// src/config.ts
-var import_ajv = __toESM(require("ajv"));
-var SERVER_URL = "https://api.basic.tech";
-var basicJsonSchema = {
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "type": "object",
-  "properties": {
-    "project_id": {
-      "type": "string"
-    },
-    "namespace": {
-      "type": "string"
-    },
-    "version": {
-      "type": "integer",
-      "minimum": 0
-    },
-    "tables": {
-      "type": "object",
-      "patternProperties": {
-        "^[a-zA-Z0-9_]+$": {
-          "type": "object",
-          "properties": {
-            "name": {
-              "type": "string"
-            },
-            "type": {
-              "type": "string",
-              "enum": ["collection"]
-            },
-            "fields": {
-              "type": "object",
-              "patternProperties": {
-                "^[a-zA-Z0-9_]+$": {
-                  "type": "object",
-                  "properties": {
-                    "type": {
-                      "type": "string"
-                    },
-                    "primary": {
-                      "type": "boolean"
-                    },
-                    "indexed": {
-                      "type": "boolean"
-                    }
-                  },
-                  "required": ["type"]
-                }
-              },
-              "additionalProperties": true
-            }
-          },
-          "required": ["fields"]
-        }
-      },
-      "additionalProperties": true
-    }
-  },
-  "required": ["project_id", "version", "tables"]
-};
-var ajv = new import_ajv.default();
-var validator = ajv.compile(basicJsonSchema);
-
 // src/sync/index.ts
 syncProtocol();
 var BasicSync = class extends import_dexie2.Dexie {
@@ -228,31 +238,31 @@ var BasicSync = class extends import_dexie2.Dexie {
   async connect({ access_token }) {
     const WS_URL = `${SERVER_URL}/ws`;
     await this.updateSyncNodes();
-    console.log("Starting connection...");
+    log("Starting connection...");
     return this.syncable.connect("websocket", WS_URL, { authToken: access_token });
   }
   async updateSyncNodes() {
     try {
       const syncNodes = await this.table("_syncNodes").toArray();
       const localSyncNodes = syncNodes.filter((node) => node.type === "local");
-      console.log("Local sync nodes:", localSyncNodes);
+      log("Local sync nodes:", localSyncNodes);
       if (localSyncNodes.length > 1) {
         const largestNodeId = Math.max(...localSyncNodes.map((node) => node.id));
         const largestNode = localSyncNodes.find((node) => node.id === largestNodeId);
         if (largestNode && largestNode.isMaster === 1) {
-          console.log("Largest node is already the master. No changes needed.");
+          log("Largest node is already the master. No changes needed.");
           return;
         }
-        console.log("Largest node id:", largestNodeId);
-        console.error("HEISENBUG: More than one local sync node found.");
+        log("Largest node id:", largestNodeId);
+        log("HEISENBUG: More than one local sync node found.");
         for (const node of localSyncNodes) {
-          console.log(`Local sync node keys:`, node.id, node.isMaster);
+          log(`Local sync node keys:`, node.id, node.isMaster);
           await this.table("_syncNodes").update(node.id, { isMaster: node.id === largestNodeId ? 1 : 0 });
-          console.log(`HEISENBUG: Setting ${node.id} to ${node.id === largestNodeId ? "master" : "0"}`);
+          log(`HEISENBUG: Setting ${node.id} to ${node.id === largestNodeId ? "master" : "0"}`);
         }
         await new Promise((resolve) => setTimeout(resolve, 2e3));
       }
-      console.log("Sync nodes updated");
+      log("Sync nodes updated");
     } catch (error) {
       console.error("Error updating _syncNodes table:", error);
     }
@@ -281,7 +291,7 @@ var BasicSync = class extends import_dexie2.Dexie {
       ref: this.table(name),
       // --- WRITE ---- // 
       add: (data) => {
-        console.log("Adding data to", name, data);
+        log("Adding data to", name, data);
         return this.table(name).add({
           id: (0, import_uuid.v7)(),
           ...data
@@ -300,10 +310,10 @@ var BasicSync = class extends import_dexie2.Dexie {
         return this.table(name).delete(id);
       },
       // --- READ ---- // 
-      get: (id) => {
+      get: async (id) => {
         return this.table(name).get(id);
       },
-      getAll: () => {
+      getAll: async () => {
         return this.table(name).toArray();
       },
       // --- QUERY ---- // 
@@ -395,7 +405,7 @@ function getSyncStatus(statusCode) {
       return "UNKNOWN";
   }
 }
-function BasicProvider({ children, project_id, schema }) {
+function BasicProvider({ children, project_id, schema, debug = false }) {
   const [isLoaded, setIsLoaded] = (0, import_react.useState)(false);
   const [isSignedIn, setIsSignedIn] = (0, import_react.useState)(false);
   const [token, setToken] = (0, import_react.useState)(null);
@@ -407,11 +417,11 @@ function BasicProvider({ children, project_id, schema }) {
   (0, import_react.useEffect)(() => {
     function initDb() {
       if (!validator(schema)) {
-        console.error("Basic Schema is invalid!", validator.errors);
+        log("Basic Schema is invalid!", validator.errors);
         console.group("Schema Errors");
         let errorMessage = "";
         validator.errors.forEach((error2, index) => {
-          console.log(`${index + 1}:`, error2.message, ` - at ${error2.instancePath}`);
+          log(`${index + 1}:`, error2.message, ` - at ${error2.instancePath}`);
           errorMessage += `${index + 1}: ${error2.message} - at ${error2.instancePath}
 `;
         });
@@ -429,7 +439,7 @@ function BasicProvider({ children, project_id, schema }) {
           setDbStatus(getSyncStatus(status));
         });
         syncRef.current.syncable.getStatus().then((status) => {
-          console.log("sync status", getSyncStatus(status));
+          log("sync status", getSyncStatus(status));
         });
       }
     }
@@ -437,9 +447,9 @@ function BasicProvider({ children, project_id, schema }) {
   }, []);
   const connectToDb = async () => {
     const tok = await getToken();
-    console.log("connecting to db...", tok.substring(0, 10));
+    log("connecting to db...", tok.substring(0, 10));
     syncRef.current.connect({ access_token: tok }).catch((e) => {
-      console.log("error connecting to db", e);
+      log("error connecting to db", e);
     });
   };
   (0, import_react.useEffect)(() => {
@@ -448,7 +458,7 @@ function BasicProvider({ children, project_id, schema }) {
     }
   }, [token]);
   const getSignInLink = () => {
-    console.log("getting sign in link...");
+    log("getting sign in link...");
     const randomState = Math.random().toString(36).substring(7);
     let baseUrl2 = "https://api.basic.tech/auth/authorize";
     baseUrl2 += `?client_id=${project_id}`;
@@ -459,12 +469,12 @@ function BasicProvider({ children, project_id, schema }) {
     return baseUrl2;
   };
   const signin = () => {
-    console.log("signing in: ", getSignInLink());
+    log("signing in: ", getSignInLink());
     const signInLink = getSignInLink();
     window.location.href = signInLink;
   };
   const signout = () => {
-    console.log("signing out!");
+    log("signing out!");
     setUser({});
     setIsSignedIn(false);
     setToken(null);
@@ -472,15 +482,15 @@ function BasicProvider({ children, project_id, schema }) {
     document.cookie = `basic_token=; Secure; SameSite=Strict`;
   };
   const getToken = async () => {
-    console.log("getting token...");
+    log("getting token...");
     if (!token) {
-      console.log("no token found");
+      log("no token found");
       throw new Error("no token found");
     }
     const decoded = (0, import_jwt_decode.jwtDecode)(token?.access_token);
     const isExpired = decoded.exp && decoded.exp < Date.now() / 1e3;
     if (isExpired) {
-      console.log("token is expired - refreshing ...");
+      log("token is expired - refreshing ...");
       const newToken = await fetchToken(token?.refresh);
       return newToken?.access_token || "";
     }
@@ -507,9 +517,9 @@ function BasicProvider({ children, project_id, schema }) {
         "Content-Type": "application/json"
       },
       body: JSON.stringify({ code })
-    }).then((response) => response.json()).catch((error2) => console.error("Error:", error2));
+    }).then((response) => response.json()).catch((error2) => log("Error:", error2));
     if (token2.error) {
-      console.log("error fetching token", token2.error);
+      log("error fetching token", token2.error);
       return;
     } else {
       setToken(token2);
@@ -517,6 +527,7 @@ function BasicProvider({ children, project_id, schema }) {
     return token2;
   };
   (0, import_react.useEffect)(() => {
+    localStorage.setItem("basic_debug", debug ? "true" : "false");
     try {
       let cookie_token = getCookie("basic_token");
       if (cookie_token !== "") {
@@ -531,7 +542,7 @@ function BasicProvider({ children, project_id, schema }) {
         setIsLoaded(true);
       }
     } catch (e) {
-      console.log("error getting cookie", e);
+      log("error getting cookie", e);
     }
   }, []);
   (0, import_react.useEffect)(() => {
@@ -541,9 +552,9 @@ function BasicProvider({ children, project_id, schema }) {
         headers: {
           "Authorization": `Bearer ${acc_token}`
         }
-      }).then((response) => response.json()).catch((error2) => console.error("Error:", error2));
+      }).then((response) => response.json()).catch((error2) => log("Error:", error2));
       if (user2.error) {
-        console.log("error fetching user", user2.error);
+        log("error fetching user", user2.error);
         return;
       } else {
         document.cookie = `basic_token=${JSON.stringify(token)}; Secure; SameSite=Strict`;
@@ -554,13 +565,13 @@ function BasicProvider({ children, project_id, schema }) {
     }
     async function checkToken() {
       if (!token) {
-        console.log("error: no user token found");
+        log("error: no user token found");
         return;
       }
       const decoded = (0, import_jwt_decode.jwtDecode)(token?.access_token);
       const isExpired = decoded.exp && decoded.exp < Date.now() / 1e3;
       if (isExpired) {
-        console.log("token is expired - refreshing ...");
+        log("token is expired - refreshing ...");
         const newToken = await fetchToken(token?.refresh);
         fetchUser(newToken.access_token);
       } else {
@@ -646,6 +657,14 @@ function useBasic() {
 
 // src/index.ts
 var import_dexie_react_hooks = require("dexie-react-hooks");
+function useQuery(queryable) {
+  return (0, import_dexie_react_hooks.useLiveQuery)(() => {
+    if (typeof queryable === "function") {
+      return queryable();
+    }
+    return queryable;
+  }, [queryable], []);
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   BasicProvider,