@spooky-sync/client-solid 0.0.1-canary.16 → 0.0.1-canary.17
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.cts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.cts","names":[],"sources":["../../../src/lib/models.ts","../../../src/types/index.ts","../../../src/lib/use-query.ts","../../../src/lib/use-file-upload.ts","../../../src/lib/use-download-file.ts","../../../src/lib/SpookyProvider.ts","../../../src/lib/context.ts","../../../src/index.ts"],"sourcesContent":[],"mappings":";;;;;;;KAMY,WAAW;KACX,kBAAkB;MAAU;;;;;;;;AAD5B,UCGK,gBAAA,CDHO;EACZ;EAAY,KAAA,CAAA,EAAA,OAAA;;ACSP,UAAA,CAAA,CAAA;AAPA,KAWL,aAAA,GAXqB,QAAA,GAAA,WAAA;AAOhB;AAIjB;AAKA;AAAgC,KAApB,oBAAoB,CAAA,UAAW,iBAAX,CAAA,GAAA,QACxB,YADmC,CACxB,CADwB,CAAA,GACnB,YADmB,CACR,UADQ,CACC,CADD,EACI,CADJ,CAAA,CAAA;;;;;AACnB,KAOZ,2BAPY,CAAA,UAO0B,iBAP1B,EAAA,eAO0D,aAP1D,CAAA,GAAA,gBAQR,YARkB,CAQP,CARO,CAAA,GAAA,UAStB,OAFA,CAEQ,CAFR,CAAA,eAA2B,CAAA,CAAA,MAAA,CAAA,EAAA;EAAA,IAAA,EAEiB,SAFjB;AAAW,CAAA,CAAA,IAEsB,GAFtB,CAAA,OAAA,CAAA,GAAA;EAAgC,KAAA,EAGrE,GAHqE,CAAA,IAAA,CAAA,SAAA,MAG7C,MAH6C,GAGpC,MAHoC,CAG7B,GAH6B,CAAA,IAAA,CAAA,CAAA,GAAA,GAAA;EACvD,KAAA,EAGd,GAHc,CAAA,IAAA,CAAA;EAAX,WAAA,EAIG,GAJH,CAAA,aAAA,CAAA;AACI,CAAA;KASf,QATmE,CAAA,CAAA,CAAA,GAAA,QAC3D,MAQoB,CARpB,GAQwB,CARxB,CAQ0B,CAR1B,CAAA;AAAiC,KAUlC,cAVkC,CAAA,UAUT,iBAVS,CAAA,GAUU,QAVV,CAUmB,YAVnB,CAUgC,CAVhC,CAAA,CAAA;;;KCxBzC,mBACO,qCACQ,aAAW;WACR,eAAe;yBACd,8CAGpB,WAAW,GAAG,WAAW,GAAG,eAAe,OAAO,mCAE9C,WAAW,GAAG,WAAW,GAAG,eAAe,OAAO;KAIrD,YAAA;EFnBO,OAAA,CAAK,EAAA,GAAA,GAAA,OAAO;AACxB,CAAA;AAAwB,iBEqBR,QFrBQ,CAAA,UEsBZ,iBFtBY,EAAA,kBEuBJ,YFvBI,CEuBO,CFvBP,CAAA,EAAA,UAAA;SAAM,EEwBP,MFxBO,CAAA,MAAA,EEwBQ,YFxBR,CAAA;yBEyBN,MFzBgB,CAAA,MAAA,EAAA,GAAA,CAAA,EAAA,cAAA,OAAA,EAAA,QE2B9B,aF3B8B,CE2BlB,CF3BkB,EE2Bf,SF3Be,EE2BJ,aF3BI,EE2BW,KF3BX,CAAA,GAAA,IAAA,CAAA,CAAA,UAAA,EE6B1B,QF7B0B,CE6BjB,CF7BiB,EE6Bd,SF7Bc,EE6BH,CF7BG,EE6BA,aF7BA,EE6Be,KF7Bf,CAAA,EAAA,OAAA,CAAA,EE8B5B,YF9B4B,CAAA,EAAA;EAAQ,IAAA,EAAA,GAAA,GE+B/B,KF/B+B,GAAA,SAAA;eE+BC;;;AD7BhC,iBCgCD,QDhCiB,CAAA,UCiCrB,iBDjCqB,EAAA,kBCkCb,YDlCa,CCkCF,CDlCE,CAAA,EAAA,UAAA;EAOhB,OAAA,EC4BM,MD5BN,CAAA,MAAA,EC4BqB,YD5BrB,CAAA;AAIjB,CAAA,EAAA,sBCyBwB,MDzBC,CAAA,MAAA,EAAA,GAAA,CAAA,EAAA,cAAA,OAAA,EAAA,QC2Bf,aD3Be,CC2BH,CD3BG,EC2BA,SD3BA,EC2BW,aD3BX,EC2B0B,KD3B1B,CAAA,GAAA,IAAA,CAAA,CAAA,EAAA,EC6BnB,QD7BmB,CC6BV,CD7BU,CAAA,EAAA,UAAA,EC8BX,QD9BW,CC8BF,CD9BE,EC8BC,SD9BD,EC8BY,CD9BZ,EC8Be,aD9Bf,EC8B8B,KD9B9B,CAAA,EAAA,OAAA,CAAA,EC+Bb,YD/Ba,CAAA,EAAA;EAKb,IAAA,EAAA,GAAA,GC2BK,KD3BL,GAAA,SAAoB;EAAA,KAAA,EAAA,GAAA,GC2BiB,KD3BjB,GAAA,SAAA;WAAW,EAAA,GAAA,GAAA,OAAA;;;;UEnB1B,gBAAA;;eAEF;;+BAEgB,OAAO,SAAS;EHJnC,QAAK,EAAA,CAAA,IAAA,EAAA,MAAO,EAAA,GGKM,OHLN,CAAA,MAAA,GAAA,IAAA,CAAA;EACZ,MAAA,EAAA,CAAA,IAAA,EAAY,MAAA,EAAA,GGKI,OHLJ,CAAA,IAAA,CAAA;EAAA,MAAA,EAAA,CAAA,IAAA,EAAA,MAAA,EAAA,GGMI,OHNJ,CAAA,OAAA,CAAA;;AAAgB,iBGSxB,aHTwB,CAAA,UGSA,iBHTA,CAAA,CAAA,UAAA,EGU1B,WHV0B,CGUd,CHVc,CAAA,CAAA,EGWrC,gBHXqC;AAAQ,iBGYhC,aHZgC,CAAA,UGYR,iBHZQ,CAAA,CAAA,EAAA,EGa1C,QHb0C,CGajC,CHbiC,CAAA,EAAA,UAAA,EGclC,WHdkC,CGctB,CHdsB,CAAA,CAAA,EGe7C,gBHf6C;;;;UIF/B,sBAAA;;;UAIA,qBAAA;EJHL,GAAA,EIIL,QJJU,CAAA,
|
|
1
|
+
{"version":3,"file":"index.d.cts","names":[],"sources":["../../../src/lib/models.ts","../../../src/types/index.ts","../../../src/lib/use-query.ts","../../../src/lib/use-file-upload.ts","../../../src/lib/use-download-file.ts","../../../src/lib/SpookyProvider.ts","../../../src/lib/context.ts","../../../src/index.ts"],"sourcesContent":[],"mappings":";;;;;;;KAMY,WAAW;KACX,kBAAkB;MAAU;;;;;;;;AAD5B,UCGK,gBAAA,CDHO;EACZ;EAAY,KAAA,CAAA,EAAA,OAAA;;ACSP,UAAA,CAAA,CAAA;AAPA,KAWL,aAAA,GAXqB,QAAA,GAAA,WAAA;AAOhB;AAIjB;AAKA;AAAgC,KAApB,oBAAoB,CAAA,UAAW,iBAAX,CAAA,GAAA,QACxB,YADmC,CACxB,CADwB,CAAA,GACnB,YADmB,CACR,UADQ,CACC,CADD,EACI,CADJ,CAAA,CAAA;;;;;AACnB,KAOZ,2BAPY,CAAA,UAO0B,iBAP1B,EAAA,eAO0D,aAP1D,CAAA,GAAA,gBAQR,YARkB,CAQP,CARO,CAAA,GAAA,UAStB,OAFA,CAEQ,CAFR,CAAA,eAA2B,CAAA,CAAA,MAAA,CAAA,EAAA;EAAA,IAAA,EAEiB,SAFjB;AAAW,CAAA,CAAA,IAEsB,GAFtB,CAAA,OAAA,CAAA,GAAA;EAAgC,KAAA,EAGrE,GAHqE,CAAA,IAAA,CAAA,SAAA,MAG7C,MAH6C,GAGpC,MAHoC,CAG7B,GAH6B,CAAA,IAAA,CAAA,CAAA,GAAA,GAAA;EACvD,KAAA,EAGd,GAHc,CAAA,IAAA,CAAA;EAAX,WAAA,EAIG,GAJH,CAAA,aAAA,CAAA;AACI,CAAA;KASf,QATmE,CAAA,CAAA,CAAA,GAAA,QAC3D,MAQoB,CARpB,GAQwB,CARxB,CAQ0B,CAR1B,CAAA;AAAiC,KAUlC,cAVkC,CAAA,UAUT,iBAVS,CAAA,GAUU,QAVV,CAUmB,YAVnB,CAUgC,CAVhC,CAAA,CAAA;;;KCxBzC,mBACO,qCACQ,aAAW;WACR,eAAe;yBACd,8CAGpB,WAAW,GAAG,WAAW,GAAG,eAAe,OAAO,mCAE9C,WAAW,GAAG,WAAW,GAAG,eAAe,OAAO;KAIrD,YAAA;EFnBO,OAAA,CAAK,EAAA,GAAA,GAAA,OAAO;AACxB,CAAA;AAAwB,iBEqBR,QFrBQ,CAAA,UEsBZ,iBFtBY,EAAA,kBEuBJ,YFvBI,CEuBO,CFvBP,CAAA,EAAA,UAAA;SAAM,EEwBP,MFxBO,CAAA,MAAA,EEwBQ,YFxBR,CAAA;yBEyBN,MFzBgB,CAAA,MAAA,EAAA,GAAA,CAAA,EAAA,cAAA,OAAA,EAAA,QE2B9B,aF3B8B,CE2BlB,CF3BkB,EE2Bf,SF3Be,EE2BJ,aF3BI,EE2BW,KF3BX,CAAA,GAAA,IAAA,CAAA,CAAA,UAAA,EE6B1B,QF7B0B,CE6BjB,CF7BiB,EE6Bd,SF7Bc,EE6BH,CF7BG,EE6BA,aF7BA,EE6Be,KF7Bf,CAAA,EAAA,OAAA,CAAA,EE8B5B,YF9B4B,CAAA,EAAA;EAAQ,IAAA,EAAA,GAAA,GE+B/B,KF/B+B,GAAA,SAAA;eE+BC;;;AD7BhC,iBCgCD,QDhCiB,CAAA,UCiCrB,iBDjCqB,EAAA,kBCkCb,YDlCa,CCkCF,CDlCE,CAAA,EAAA,UAAA;EAOhB,OAAA,EC4BM,MD5BN,CAAA,MAAA,EC4BqB,YD5BrB,CAAA;AAIjB,CAAA,EAAA,sBCyBwB,MDzBC,CAAA,MAAA,EAAA,GAAA,CAAA,EAAA,cAAA,OAAA,EAAA,QC2Bf,aD3Be,CC2BH,CD3BG,EC2BA,SD3BA,EC2BW,aD3BX,EC2B0B,KD3B1B,CAAA,GAAA,IAAA,CAAA,CAAA,EAAA,EC6BnB,QD7BmB,CC6BV,CD7BU,CAAA,EAAA,UAAA,EC8BX,QD9BW,CC8BF,CD9BE,EC8BC,SD9BD,EC8BY,CD9BZ,EC8Be,aD9Bf,EC8B8B,KD9B9B,CAAA,EAAA,OAAA,CAAA,EC+Bb,YD/Ba,CAAA,EAAA;EAKb,IAAA,EAAA,GAAA,GC2BK,KD3BL,GAAA,SAAoB;EAAA,KAAA,EAAA,GAAA,GC2BiB,KD3BjB,GAAA,SAAA;WAAW,EAAA,GAAA,GAAA,OAAA;;;;UEnB1B,gBAAA;;eAEF;;+BAEgB,OAAO,SAAS;EHJnC,QAAK,EAAA,CAAA,IAAA,EAAA,MAAO,EAAA,GGKM,OHLN,CAAA,MAAA,GAAA,IAAA,CAAA;EACZ,MAAA,EAAA,CAAA,IAAA,EAAY,MAAA,EAAA,GGKI,OHLJ,CAAA,IAAA,CAAA;EAAA,MAAA,EAAA,CAAA,IAAA,EAAA,MAAA,EAAA,GGMI,OHNJ,CAAA,OAAA,CAAA;;AAAgB,iBGSxB,aHTwB,CAAA,UGSA,iBHTA,CAAA,CAAA,UAAA,EGU1B,WHV0B,CGUd,CHVc,CAAA,CAAA,EGWrC,gBHXqC;AAAQ,iBGYhC,aHZgC,CAAA,UGYR,iBHZQ,CAAA,CAAA,EAAA,EGa1C,QHb0C,CGajC,CHbiC,CAAA,EAAA,UAAA,EGclC,WHdkC,CGctB,CHdsB,CAAA,CAAA,EGe7C,gBHf6C;;;;UIF/B,sBAAA;;;UAIA,qBAAA;EJHL,GAAA,EIIL,QJJU,CAAA,MAAO,GAAA,IAAA,CAAA;EACZ,SAAA,EIIC,QJJW,CAAA,OAAA,CAAA;EAAA,KAAA,EIKf,QJLe,CIKN,KJLM,GAAA,IAAA,CAAA;SAAM,EAAA,GAAA,GAAA,IAAA;;AAAkB,iBI+BhC,eJ/BgC,CAAA,UI+BN,iBJ/BM,CAAA,CAAA,UAAA,EIgClC,WJhCkC,CIgCtB,CJhCsB,CAAA,EAAA,IAAA,EIiCxC,QJjCwC,CAAA,MAAA,GAAA,IAAA,GAAA,SAAA,CAAA,EAAA,OAAA,CAAA,EIkCpC,sBJlCoC,CAAA,EImC7C,qBJnC6C;iBIoChC,0BAA0B,uBACpC,SAAS,gBACD,YAAY,UAClB,+CACI,yBACT;;;;UC1Cc,8BAA8B;UACrC,eAAe;aACZ,GAAA,CAAI;ELFL,OAAA,CAAK,EAAA,CAAA,KAAA,EKGG,KLHI,EAAA,GAAA,IAAA;EACZ,OAAA,CAAA,EAAA,CAAA,EAAA,EKGK,QLHO,CKGE,CLHF,CAAA,EAAA,GAAA,IAAA;EAAA,QAAA,EKIZ,GAAA,CAAI,OLJQ;;AAAgB,iBKOxB,cLPwB,CAAA,UKOC,eLPD,CAAA,CAAA,KAAA,EKQ/B,mBLR+B,CKQX,CLRW,CAAA,CAAA,EKSrC,GAAA,CAAI,OLTiC;;;;iBMDxB,gBAAgB,oBAAoB,SAAS;;;;;KCkDjD,iCACK,qCACG,aAAW,uBACf,6BAA6B,QAAQ,cACjD,gBAAgB,QAAQ,WAAW;KAE3B,wCACK,qCACG,aAAW,+BACP,6BAA6B,QAAQ,aACzD,6BAA6B,QAAQ,sBAEjC;EN3DS,EAAA,EM4DT,iBN5DyB,CM4DP,MN5DO,EM4DC,SN5DD,EM4DY,CN5DZ,CAAA,CAAA,IAAA,CAAA;EAOhB,aAAA,EMsDE,gBNtDF;EAIL,WAAA,EMmDK,iBNnDQ,CMmDU,MNnDV,EMmDkB,SNnDlB,EMmD6B,CNnD7B,CAAA,CAAA,aAAA,CAAA;AAKb,CAAA,EAAoB;AAAW,KMkD/B,UNlD+B,CAAA,eMmD1B,iBNnD0B,EAAA,kBMoDvB,YNpDuB,CMoDZ,MNpDY,CAAA,EAAA,sBMqDnB,wBNrDmB,CMqDM,MNrDN,EMqDc,SNrDd,CAAA,CAAA,GMsDvC,aNtDuC,CMsD3B,MNtD2B,EMsDnB,SNtDmB,EMsDR,aNtDQ,EAAA,IAAA,CAAA;AACxB,KMuDP,WNvDO,CAAA,cAAA,MAAA,EAAA,sBMuDiD,gBNvDjD,GAAA,CAAA,CAAA,CAAA,GAAA,QMwDX,KNxDA,GMwDQ,INxDR,CMwDa,oBNxDb,EAAA,eAAA,CAAA,GAAA;EAAoC,aAAA,EMyDzB,aNzDyB;;AAApB,KM6DZ,eN7DY,CAAA,cAAA,MAAA,EAAA,sBM6DgD,gBN7DhD,GAAA,CAAA,CAAA,CAAA,GAAA,QM8DhB,KN9D0B,GAAA;EAOtB,EAAA,EMwDJ,KNxDI;EAA2B,aAAA,EMyDpB,aNzDoB;EAAW,WAAA,EAAA,MAAA;;;;;;AAEsB,cMgE3D,QNhE2D,CAAA,UMgExC,iBNhEwC,CAAA,CAAA;UAC3D,MAAA;UAAwB,MAAA;UAAS,YAAA;aAAO,CAAA,MAAA,EMoE/B,cNpE+B,CMoEhB,CNpEgB,CAAA;WACxC,CAAA,CAAA,EMuES,YNvET,CMuEsB,CNvEtB,CAAA;;;AAIX;EAGW,IAAA,CAAA,CAAA,EMwEG,ONxEH,CAAA,IAAA,CAAA;;;;EAA2B,MAAA,CAAA,EAAA,EAAA,MAAA,EAAA,OAAA,EMkFJ,MNlFI,CAAA,MAAA,EAAA,OAAA,CAAA,CAAA,EMkFsB,ONlFtB,CAAA,IAAA,CAAA;EAE5B;;;QAAkE,CAAA,cMwFjD,YNxFiD,CMwFtC,CNxFsC,CAAA,CAAA,CAAA,SAAA,EMyF/D,KNzF+D,EAAA,QAAA,EAAA,MAAA,EAAA,OAAA,EM2FjE,ON3FiE,CM2FzD,YN3FyD,CM2F9C,UN3F8C,CM2FrC,CN3FqC,EM2FlC,KN3FkC,CAAA,CAAA,CAAA,EAAA,OAAA,CAAA,EM4FhE,aN5FgE,CAAA,EM6FzE,ON7FyE,CAAA,IAAA,CAAA;;;;uBM0GjD,aAAW,eACzB,0BACQ,WAAW,WAAS,GAAG,mBACzC;;;ALlJwD;EAGhD,KAAA,CAAA,cKyJgB,YLzJhB,CKyJ2B,CLzJ3B,CAAA,CAAA,CAAA,KAAA,EK0JF,KL1JE,CAAA,EK2JR,YL3JQ,CK2JK,CL3JL,EK2JQ,KL3JR,EK2Je,wBL3Jf,EAAA,CAAA,CAAA,EAAA,KAAA,CAAA;;;;KAGyB,CAAA,UKiKxB,YLjKwB,CKiKX,CLjKW,CAAA,EAAA,UKkKxB,aLlKwB,CKkKV,CLlKU,EKkKP,CLlKO,CAAA,CAAA,CAAA,OAAA,EKoKzB,CLpKyB,EAAA,IAAA,EKqK5B,CLrK4B,EAAA,OAAA,EKsKzB,YLtKyB,CKsKZ,CLtKY,EKsKT,CLtKS,EKsKN,CLtKM,CAAA,EAAA,OAAA,CAAA,EKuKxB,ULvKwB,CAAA,EKwKjC,OLxKiC,CAAA,IAAA,CAAA;;;;cAIpB,CAAA,KAAA,EAAA,MAAA,CAAA,EK4K0B,OL5K1B,CK4KkC,QL5KlC,CAAA,MAAA,CAAA,CAAA;;;;;gBAAd,CAAA,CAAA,EKyL6B,OLzL7B,CAAA,IAAA,CAAA;;;;SAEgC,CAAA,CAAA,EK8LV,OL9LU,CAAA,IAAA,CAAA;;;;EAAlB,SAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,EAAA,EKsMmB,OLtMnB,EAAA,GKsM+B,CLtM/B,GKsMmC,OLtMnC,CKsM2C,CLtM3C,CAAA,CAAA,EKsMgD,OLtMhD,CKsMwD,CLtMxD,CAAA;EAIb;AAGL;;MACY,MAAA,CAAA,CAAA,EKqMI,YLrMJ,CKqMiB,CLrMjB,CAAA,CAAA,cAAA,CAAA;;;;MAEW,KAAA,CAAA,CAAA,EK2MR,YL3MQ,CK2MK,CL3ML,CAAA,CAAA,aAAA,CAAA;;;;MAGa,IAAA,CAAA,CAAA,EKgNtB,WLhNsB,CKgNV,CLhNU,CAAA;MAAe,oBAAA,CAAA,CAAA,EAAA,MAAA;6BAAzC,CAAA,EAAA,EAAA,CAAA,KAAA,EAAA,MAAA,EAAA,GAAA,IAAA,CAAA,EAAA,GAAA,GAAA,IAAA;QAEa,CAAA,UK6NJ,WL7NI,CK6NQ,CL7NR,CAAA,CAAA,CAAA,IAAA,EK6NkB,CL7NlB,CAAA,EK6NsB,YL7NtB;iBAAG,CAAA,IAAA,EAAA,MAAA,CAAA,EKkOO,sBLlOP,GAAA,SAAA"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@spooky-sync/client-solid",
|
|
3
|
-
"version": "0.0.1-canary.
|
|
3
|
+
"version": "0.0.1-canary.17",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "SurrealDB client with local and remote database support for browser applications",
|
|
6
6
|
"main": "./dist/index.cjs",
|
|
@@ -27,7 +27,8 @@
|
|
|
27
27
|
"database",
|
|
28
28
|
"browser",
|
|
29
29
|
"offline",
|
|
30
|
-
"sync"
|
|
30
|
+
"sync",
|
|
31
|
+
"tanstack-intent"
|
|
31
32
|
],
|
|
32
33
|
"author": "",
|
|
33
34
|
"license": "MIT",
|
|
@@ -0,0 +1,217 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: spooky-solid
|
|
3
|
+
description: >-
|
|
4
|
+
SolidJS integration for the Spooky reactive local-first SurrealDB framework.
|
|
5
|
+
Use when setting up SpookyProvider, using useQuery for reactive data, building
|
|
6
|
+
queries with QueryBuilder in SolidJS components, handling mutations, auth,
|
|
7
|
+
file uploads/downloads, or working with Spooky types like Model and RecordId.
|
|
8
|
+
metadata:
|
|
9
|
+
author: spooky-sync
|
|
10
|
+
version: "0.0.1"
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
# Spooky SolidJS Client
|
|
14
|
+
|
|
15
|
+
`@spooky-sync/client-solid` provides SolidJS bindings for the Spooky framework. It wraps `@spooky-sync/core` with a context provider, reactive `useQuery` hook, and file operation hooks.
|
|
16
|
+
|
|
17
|
+
## Setup
|
|
18
|
+
|
|
19
|
+
```tsx
|
|
20
|
+
import { SpookyProvider } from '@spooky-sync/client-solid';
|
|
21
|
+
import { schema } from './generated/schema';
|
|
22
|
+
import schemaSurql from './generated/schema.surql?raw';
|
|
23
|
+
|
|
24
|
+
function App() {
|
|
25
|
+
return (
|
|
26
|
+
<SpookyProvider
|
|
27
|
+
config={{
|
|
28
|
+
database: {
|
|
29
|
+
endpoint: 'ws://localhost:8000',
|
|
30
|
+
namespace: 'my_ns',
|
|
31
|
+
database: 'my_db',
|
|
32
|
+
store: 'indexeddb',
|
|
33
|
+
},
|
|
34
|
+
schema,
|
|
35
|
+
schemaSurql,
|
|
36
|
+
logLevel: 'info',
|
|
37
|
+
}}
|
|
38
|
+
fallback={<div>Loading database...</div>}
|
|
39
|
+
onReady={(db) => console.log('DB ready')}
|
|
40
|
+
onError={(err) => console.error('DB failed', err)}
|
|
41
|
+
>
|
|
42
|
+
<MyApp />
|
|
43
|
+
</SpookyProvider>
|
|
44
|
+
);
|
|
45
|
+
}
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
### SpookyProvider Props
|
|
49
|
+
|
|
50
|
+
| Prop | Type | Description |
|
|
51
|
+
|------|------|-------------|
|
|
52
|
+
| `config` | `SyncedDbConfig<S>` | Same as `SpookyConfig` from core |
|
|
53
|
+
| `fallback` | `JSX.Element` | Shown while the database is initializing |
|
|
54
|
+
| `onReady` | `(db: SyncedDb<S>) => void` | Called when initialization succeeds |
|
|
55
|
+
| `onError` | `(error: Error) => void` | Called if initialization fails |
|
|
56
|
+
| `children` | `JSX.Element` | App content, rendered after init |
|
|
57
|
+
|
|
58
|
+
## useQuery
|
|
59
|
+
|
|
60
|
+
The primary hook for reactive data fetching. Queries automatically re-subscribe when inputs change.
|
|
61
|
+
|
|
62
|
+
### Context-based usage (recommended)
|
|
63
|
+
|
|
64
|
+
```tsx
|
|
65
|
+
import { useQuery } from '@spooky-sync/client-solid';
|
|
66
|
+
import { QueryBuilder } from '@spooky-sync/query-builder';
|
|
67
|
+
import { schema } from './generated/schema';
|
|
68
|
+
|
|
69
|
+
function PostList() {
|
|
70
|
+
const db = useDb();
|
|
71
|
+
|
|
72
|
+
// Static query
|
|
73
|
+
const posts = useQuery(
|
|
74
|
+
db.query('post').orderBy('createdAt', 'desc').limit(20).build()
|
|
75
|
+
);
|
|
76
|
+
|
|
77
|
+
return (
|
|
78
|
+
<Show when={!posts.isLoading()} fallback={<div>Loading...</div>}>
|
|
79
|
+
<For each={posts.data()}>
|
|
80
|
+
{(post) => <div>{post.title}</div>}
|
|
81
|
+
</For>
|
|
82
|
+
</Show>
|
|
83
|
+
);
|
|
84
|
+
}
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
### Reactive queries (function form)
|
|
88
|
+
|
|
89
|
+
Wrap the query in a function to make it reactive to signal changes:
|
|
90
|
+
|
|
91
|
+
```tsx
|
|
92
|
+
function UserPosts(props: { userId: string }) {
|
|
93
|
+
const db = useDb();
|
|
94
|
+
|
|
95
|
+
// Query re-runs when props.userId changes
|
|
96
|
+
const posts = useQuery(
|
|
97
|
+
() => db.query('post')
|
|
98
|
+
.where({ author: props.userId })
|
|
99
|
+
.related('author')
|
|
100
|
+
.build()
|
|
101
|
+
);
|
|
102
|
+
|
|
103
|
+
return <For each={posts.data()}>{(post) => <div>{post.title}</div>}</For>;
|
|
104
|
+
}
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
### Conditional queries
|
|
108
|
+
|
|
109
|
+
Use the `enabled` option to conditionally run queries:
|
|
110
|
+
|
|
111
|
+
```tsx
|
|
112
|
+
const [userId, setUserId] = createSignal<string | null>(null);
|
|
113
|
+
|
|
114
|
+
const user = useQuery(
|
|
115
|
+
() => userId()
|
|
116
|
+
? db.query('user').where({ id: userId()! }).one().build()
|
|
117
|
+
: undefined,
|
|
118
|
+
{ enabled: () => userId() !== null }
|
|
119
|
+
);
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
### Return value
|
|
123
|
+
|
|
124
|
+
| Property | Type | Description |
|
|
125
|
+
|----------|------|-------------|
|
|
126
|
+
| `data` | `() => T \| undefined` | Reactive accessor for query results |
|
|
127
|
+
| `error` | `() => Error \| undefined` | Reactive accessor for errors |
|
|
128
|
+
| `isLoading` | `() => boolean` | `true` until first data arrives |
|
|
129
|
+
|
|
130
|
+
### Explicit db overload
|
|
131
|
+
|
|
132
|
+
You can also pass the `SyncedDb` instance directly (legacy):
|
|
133
|
+
|
|
134
|
+
```tsx
|
|
135
|
+
const posts = useQuery(db, db.query('post').build());
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
## useDb
|
|
139
|
+
|
|
140
|
+
Access the `SyncedDb` instance from context:
|
|
141
|
+
|
|
142
|
+
```tsx
|
|
143
|
+
import { useDb } from '@spooky-sync/client-solid';
|
|
144
|
+
|
|
145
|
+
function MyComponent() {
|
|
146
|
+
const db = useDb();
|
|
147
|
+
// db.query(), db.create(), db.update(), db.delete(), db.auth, etc.
|
|
148
|
+
}
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
## Mutations
|
|
152
|
+
|
|
153
|
+
Use the `SyncedDb` instance (from `useDb()`) for mutations:
|
|
154
|
+
|
|
155
|
+
```tsx
|
|
156
|
+
const db = useDb();
|
|
157
|
+
|
|
158
|
+
// Create
|
|
159
|
+
await db.create('post:abc', { title: 'Hello', body: 'World', author: 'user:alice' });
|
|
160
|
+
|
|
161
|
+
// Update
|
|
162
|
+
await db.update('post', 'post:abc', { title: 'Updated' });
|
|
163
|
+
|
|
164
|
+
// Update with debounce
|
|
165
|
+
await db.update('post', 'post:abc', { body: newText }, {
|
|
166
|
+
debounced: { key: 'recordId_x_fields', delay: 300 },
|
|
167
|
+
});
|
|
168
|
+
|
|
169
|
+
// Delete
|
|
170
|
+
await db.delete('post', 'post:abc');
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
## Authentication
|
|
174
|
+
|
|
175
|
+
```tsx
|
|
176
|
+
const db = useDb();
|
|
177
|
+
|
|
178
|
+
await db.auth.signUp('user_access', { email, password, name });
|
|
179
|
+
await db.auth.signIn('user_access', { email, password });
|
|
180
|
+
await db.auth.signOut();
|
|
181
|
+
|
|
182
|
+
// Subscribe to auth state
|
|
183
|
+
const unsub = db.auth.subscribe((userId) => { ... });
|
|
184
|
+
```
|
|
185
|
+
|
|
186
|
+
## File Upload & Download
|
|
187
|
+
|
|
188
|
+
See [references/file-hooks.md](references/file-hooks.md) for details.
|
|
189
|
+
|
|
190
|
+
```tsx
|
|
191
|
+
import { useFileUpload, useDownloadFile } from '@spooky-sync/client-solid';
|
|
192
|
+
|
|
193
|
+
// Upload
|
|
194
|
+
const { upload, isUploading, error } = useFileUpload('avatars');
|
|
195
|
+
await upload('alice/photo.png', file);
|
|
196
|
+
|
|
197
|
+
// Download (reactive)
|
|
198
|
+
const { url, isLoading } = useDownloadFile('avatars', () => user()?.avatarPath);
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
## Backend Runs
|
|
202
|
+
|
|
203
|
+
```tsx
|
|
204
|
+
const db = useDb();
|
|
205
|
+
await db.run('email', '/send', { to: 'alice@example.com', subject: 'Hi', body: 'Hello' });
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
## Key Re-exports
|
|
209
|
+
|
|
210
|
+
The package re-exports commonly needed types:
|
|
211
|
+
|
|
212
|
+
```typescript
|
|
213
|
+
import { RecordId, Uuid } from '@spooky-sync/client-solid';
|
|
214
|
+
import type {
|
|
215
|
+
Model, GenericModel, QueryResult, TableModel, TableNames, GetTable,
|
|
216
|
+
} from '@spooky-sync/client-solid';
|
|
217
|
+
```
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
# File Hooks Reference
|
|
2
|
+
|
|
3
|
+
## useFileUpload
|
|
4
|
+
|
|
5
|
+
Upload, download, and manage files in a SurrealDB bucket.
|
|
6
|
+
|
|
7
|
+
### Signatures
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
// Context-based (inside SpookyProvider)
|
|
11
|
+
useFileUpload<S>(bucketName: BucketNames<S>): FileUploadResult;
|
|
12
|
+
|
|
13
|
+
// Explicit db
|
|
14
|
+
useFileUpload<S>(db: SyncedDb<S>, bucketName: BucketNames<S>): FileUploadResult;
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
### Return Value
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
interface FileUploadResult {
|
|
21
|
+
isUploading: () => boolean;
|
|
22
|
+
error: () => Error | null;
|
|
23
|
+
clearError: () => void;
|
|
24
|
+
upload: (path: string, file: File | Blob) => Promise<void>;
|
|
25
|
+
download: (path: string) => Promise<string | null>; // Returns object URL
|
|
26
|
+
remove: (path: string) => Promise<void>;
|
|
27
|
+
exists: (path: string) => Promise<boolean>;
|
|
28
|
+
}
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
### Validation
|
|
32
|
+
|
|
33
|
+
If the bucket has `maxSize` or `allowedExtensions` configured in the schema, the hook validates files before upload and sets `error()` on failure.
|
|
34
|
+
|
|
35
|
+
### Example
|
|
36
|
+
|
|
37
|
+
```tsx
|
|
38
|
+
function AvatarUpload() {
|
|
39
|
+
const { upload, isUploading, error, clearError } = useFileUpload('avatars');
|
|
40
|
+
|
|
41
|
+
const handleFile = async (e: Event) => {
|
|
42
|
+
const file = (e.target as HTMLInputElement).files?.[0];
|
|
43
|
+
if (file) {
|
|
44
|
+
await upload(`user/${userId()}/avatar.png`, file);
|
|
45
|
+
}
|
|
46
|
+
};
|
|
47
|
+
|
|
48
|
+
return (
|
|
49
|
+
<div>
|
|
50
|
+
<input type="file" onChange={handleFile} disabled={isUploading()} />
|
|
51
|
+
<Show when={error()}>
|
|
52
|
+
<p class="error">{error()!.message}</p>
|
|
53
|
+
<button onClick={clearError}>Dismiss</button>
|
|
54
|
+
</Show>
|
|
55
|
+
</div>
|
|
56
|
+
);
|
|
57
|
+
}
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
## useDownloadFile
|
|
61
|
+
|
|
62
|
+
Reactively download a file from a bucket. Re-fetches when the path changes.
|
|
63
|
+
|
|
64
|
+
### Signatures
|
|
65
|
+
|
|
66
|
+
```typescript
|
|
67
|
+
// Context-based
|
|
68
|
+
useDownloadFile<S>(
|
|
69
|
+
bucketName: BucketNames<S>,
|
|
70
|
+
path: Accessor<string | null | undefined>,
|
|
71
|
+
options?: { cache?: boolean },
|
|
72
|
+
): UseDownloadFileResult;
|
|
73
|
+
|
|
74
|
+
// Explicit db
|
|
75
|
+
useDownloadFile<S>(
|
|
76
|
+
db: SyncedDb<S>,
|
|
77
|
+
bucketName: BucketNames<S>,
|
|
78
|
+
path: Accessor<string | null | undefined>,
|
|
79
|
+
options?: { cache?: boolean },
|
|
80
|
+
): UseDownloadFileResult;
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
### Return Value
|
|
84
|
+
|
|
85
|
+
```typescript
|
|
86
|
+
interface UseDownloadFileResult {
|
|
87
|
+
url: Accessor<string | null>; // Object URL for the file
|
|
88
|
+
isLoading: Accessor<boolean>;
|
|
89
|
+
error: Accessor<Error | null>;
|
|
90
|
+
refetch: () => void; // Force re-download (evicts cache)
|
|
91
|
+
}
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### Caching
|
|
95
|
+
|
|
96
|
+
By default, downloads are cached by `bucket:path` key with reference counting. Object URLs are revoked when no component references them. Set `cache: false` to disable.
|
|
97
|
+
|
|
98
|
+
### Example
|
|
99
|
+
|
|
100
|
+
```tsx
|
|
101
|
+
function Avatar(props: { path: string | null }) {
|
|
102
|
+
const { url, isLoading } = useDownloadFile('avatars', () => props.path);
|
|
103
|
+
|
|
104
|
+
return (
|
|
105
|
+
<Show when={!isLoading()} fallback={<Spinner />}>
|
|
106
|
+
<Show when={url()}>
|
|
107
|
+
<img src={url()!} alt="Avatar" />
|
|
108
|
+
</Show>
|
|
109
|
+
</Show>
|
|
110
|
+
);
|
|
111
|
+
}
|
|
112
|
+
```
|