@electric-sql/pglite-react 0.2.10 → 0.2.12

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.cjs CHANGED
@@ -1,2 +1,2 @@
1
- "use strict";var l=Object.defineProperty;var x=Object.getOwnPropertyDescriptor;var w=Object.getOwnPropertyNames;var y=Object.prototype.hasOwnProperty;var R=(t,e)=>{for(var n in e)l(t,n,{get:e[n],enumerable:!0})},g=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of w(e))!y.call(t,i)&&i!==n&&l(t,i,{get:()=>e[i],enumerable:!(r=x(e,i))||r.enumerable});return t};var h=t=>g(l({},"__esModule",{value:!0}),t);var W={};R(W,{PGliteProvider:()=>k,makePGliteProvider:()=>c,useLiveIncrementalQuery:()=>L,useLiveQuery:()=>p,usePGlite:()=>d});module.exports=h(W);var o=require("react"),v=require("react/jsx-runtime");function c(){let t=(0,o.createContext)(void 0);return{usePGlite:e=>{let n=(0,o.useContext)(t);if(e)return e;if(!n)throw new Error("No PGlite instance found, use PGliteProvider to provide one");return n},PGliteProvider:({children:e,db:n})=>(0,v.jsx)(t.Provider,{value:n,children:e})}}var{PGliteProvider:k,usePGlite:d}=c();var s=require("react");var G=require("@electric-sql/pglite/template");function P(t,e,n){let r=d(),[i,m]=(0,s.useState)();return(0,s.useEffect)(()=>{let f=!1,T=u=>{f||m(u)},a=n!==void 0?r.live.incrementalQuery(t,e,n,T):r.live.query(t,e,T);return()=>{f=!0,a.then(({unsubscribe:u})=>u())}},[r,n,t,...e??[]]),i&&{rows:i.rows,fields:i.fields}}function p(t,e){return P(t,e)}p.sql=function(t,...e){let{query:n,params:r}=(0,G.query)(t,...e);return P(n,r)};function L(t,e,n){return P(t,e,n)}0&&(module.exports={PGliteProvider,makePGliteProvider,useLiveIncrementalQuery,useLiveQuery,usePGlite});
1
+ "use strict";var f=Object.defineProperty;var g=Object.getOwnPropertyDescriptor;var h=Object.getOwnPropertyNames;var x=Object.prototype.hasOwnProperty;var k=(t,e)=>{for(var n in e)f(t,n,{get:e[n],enumerable:!0})},y=(t,e,n,i)=>{if(e&&typeof e=="object"||typeof e=="function")for(let r of h(e))!x.call(t,r)&&r!==n&&f(t,r,{get:()=>e[r],enumerable:!(i=g(e,r))||i.enumerable});return t};var L=t=>y(f({},"__esModule",{value:!0}),t);var S={};k(S,{PGliteProvider:()=>W,makePGliteProvider:()=>G,useLiveIncrementalQuery:()=>Q,useLiveQuery:()=>a,usePGlite:()=>P});module.exports=L(S);var s=require("react"),m=require("react/jsx-runtime");function G(){let t=(0,s.createContext)(void 0);return{usePGlite:e=>{let n=(0,s.useContext)(t);if(e)return e;if(!n)throw new Error("No PGlite instance found, use PGliteProvider to provide one");return n},PGliteProvider:({children:e,db:n})=>(0,m.jsx)(t.Provider,{value:n,children:e})}}var{PGliteProvider:W,usePGlite:P}=G();var u=require("react");var p=require("@electric-sql/pglite/template");function b(t,e){if(!t&&!e)return!0;if(t?.length!==e?.length)return!1;for(let n=0;n<t.length;n++)if(!Object.is(t[n],e[n]))return!1;return!0}function c(t,e,n){let i=P(),[r,w]=(0,u.useState)(),l=(0,u.useRef)(e),o=l.current;return b(l.current,e)||(l.current=e,o=e),(0,u.useEffect)(()=>{let T=!1,v=d=>{T||w(d)},R=n!==void 0?i.live.incrementalQuery(t,o,n,v):i.live.query(t,o,v);return()=>{T=!0,R.then(({unsubscribe:d})=>d())}},[i,n,t,o]),r&&{rows:r.rows,fields:r.fields}}function a(t,e){return c(t,e)}a.sql=function(t,...e){let{query:n,params:i}=(0,p.query)(t,...e);return c(n,i)};function Q(t,e,n){return c(t,e,n)}0&&(module.exports={PGliteProvider,makePGliteProvider,useLiveIncrementalQuery,useLiveQuery,usePGlite});
2
2
  //# sourceMappingURL=index.cjs.map
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/index.ts","../src/provider.tsx","../src/hooks.ts"],"sourcesContent":["export * from './provider'\nexport * from './hooks'\n","import React, { createContext, useContext } from 'react'\nimport { PGliteWithLive } from '@electric-sql/pglite/live'\n\ninterface Props<T extends PGliteWithLive> {\n children?: React.ReactNode\n db?: T\n}\n\ntype PGliteProvider<T extends PGliteWithLive> = (props: Props<T>) => JSX.Element\ntype UsePGlite<T extends PGliteWithLive> = (db?: T) => T\n\ninterface PGliteProviderSet<T extends PGliteWithLive> {\n PGliteProvider: PGliteProvider<T>\n usePGlite: UsePGlite<T>\n}\n\n/**\n * Create a typed set of {@link PGliteProvider} and {@link usePGlite}.\n */\nfunction makePGliteProvider<T extends PGliteWithLive>(): PGliteProviderSet<T> {\n const ctx = createContext<T | undefined>(undefined)\n return {\n usePGlite: (db?: T) => {\n const dbProvided = useContext(ctx)\n\n // allow providing a db explicitly\n if (db) return db\n\n if (!dbProvided)\n throw new Error(\n 'No PGlite instance found, use PGliteProvider to provide one',\n )\n\n return dbProvided\n },\n PGliteProvider: ({ children, db }: Props<T>) => {\n return <ctx.Provider value={db}>{children}</ctx.Provider>\n },\n }\n}\n\nconst { PGliteProvider, usePGlite } = makePGliteProvider<PGliteWithLive>()\n\nexport { makePGliteProvider, PGliteProvider, usePGlite }\n","import { useEffect, useState } from 'react'\nimport { Results } from '@electric-sql/pglite'\nimport { usePGlite } from './provider'\nimport { query as buildQuery } from '@electric-sql/pglite/template'\n\nfunction useLiveQueryImpl<T = { [key: string]: unknown }>(\n query: string,\n params: unknown[] | undefined | null,\n key?: string,\n): Omit<Results<T>, 'affectedRows'> | undefined {\n const db = usePGlite()\n const [results, setResults] = useState<Results<T>>()\n useEffect(() => {\n let cancelled = false\n const cb = (results: Results<T>) => {\n if (cancelled) return\n setResults(results)\n }\n const ret =\n key !== undefined\n ? db.live.incrementalQuery<T>(query, params, key, cb)\n : db.live.query<T>(query, params, cb)\n\n return () => {\n cancelled = true\n ret.then(({ unsubscribe }) => unsubscribe())\n }\n\n // Using spread operator for params to avoid serializing it to JSON\n // or performing more complicated array equality checks\n // eslint-disable-next-line react-compiler/react-compiler\n // eslint-disable-next-line react-hooks/exhaustive-deps\n }, [db, key, query, ...(params ?? [])])\n return (\n results && {\n rows: results.rows,\n fields: results.fields,\n }\n )\n}\n\nexport function useLiveQuery<T = { [key: string]: unknown }>(\n query: string,\n params: unknown[] | undefined | null,\n): Results<T> | undefined {\n return useLiveQueryImpl<T>(query, params)\n}\n\nuseLiveQuery.sql = function <T = { [key: string]: unknown }>(\n strings: TemplateStringsArray,\n ...values: any[]\n): Results<T> | undefined {\n const { query, params } = buildQuery(strings, ...values)\n // eslint-disable-next-line react-compiler/react-compiler\n // eslint-disable-next-line react-hooks/rules-of-hooks\n return useLiveQueryImpl<T>(query, params)\n}\n\nexport function useLiveIncrementalQuery<T = { [key: string]: unknown }>(\n query: string,\n params: unknown[] | undefined | null,\n key: string,\n): Results<T> | undefined {\n return useLiveQueryImpl<T>(query, params, key)\n}\n"],"mappings":"yaAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,oBAAAE,EAAA,uBAAAC,EAAA,4BAAAC,EAAA,iBAAAC,EAAA,cAAAC,IAAA,eAAAC,EAAAP,GCAA,IAAAQ,EAAiD,iBAoCpCC,EAAA,6BAjBb,SAASC,GAAqE,CAC5E,IAAMC,KAAM,iBAA6B,MAAS,EAClD,MAAO,CACL,UAAYC,GAAW,CACrB,IAAMC,KAAa,cAAWF,CAAG,EAGjC,GAAIC,EAAI,OAAOA,EAEf,GAAI,CAACC,EACH,MAAM,IAAI,MACR,6DACF,EAEF,OAAOA,CACT,EACA,eAAgB,CAAC,CAAE,SAAAC,EAAU,GAAAF,CAAG,OACvB,OAACD,EAAI,SAAJ,CAAa,MAAOC,EAAK,SAAAE,EAAS,CAE9C,CACF,CAEA,GAAM,CAAE,eAAAC,EAAgB,UAAAC,CAAU,EAAIN,EAAmC,ECzCzE,IAAAO,EAAoC,iBAGpC,IAAAC,EAAoC,yCAEpC,SAASC,EACPC,EACAC,EACAC,EAC8C,CAC9C,IAAMC,EAAKC,EAAU,EACf,CAACC,EAASC,CAAU,KAAI,YAAqB,EACnD,sBAAU,IAAM,CACd,IAAIC,EAAY,GACVC,EAAMH,GAAwB,CAC9BE,GACJD,EAAWD,CAAO,CACpB,EACMI,EACJP,IAAQ,OACJC,EAAG,KAAK,iBAAoBH,EAAOC,EAAQC,EAAKM,CAAE,EAClDL,EAAG,KAAK,MAASH,EAAOC,EAAQO,CAAE,EAExC,MAAO,IAAM,CACXD,EAAY,GACZE,EAAI,KAAK,CAAC,CAAE,YAAAC,CAAY,IAAMA,EAAY,CAAC,CAC7C,CAMF,EAAG,CAACP,EAAID,EAAKF,EAAO,GAAIC,GAAU,CAAC,CAAE,CAAC,EAEpCI,GAAW,CACT,KAAMA,EAAQ,KACd,OAAQA,EAAQ,MAClB,CAEJ,CAEO,SAASM,EACdX,EACAC,EACwB,CACxB,OAAOF,EAAoBC,EAAOC,CAAM,CAC1C,CAEAU,EAAa,IAAM,SACjBC,KACGC,EACqB,CACxB,GAAM,CAAE,MAAAb,EAAO,OAAAC,CAAO,KAAI,EAAAa,OAAWF,EAAS,GAAGC,CAAM,EAGvD,OAAOd,EAAoBC,EAAOC,CAAM,CAC1C,EAEO,SAASc,EACdf,EACAC,EACAC,EACwB,CACxB,OAAOH,EAAoBC,EAAOC,EAAQC,CAAG,CAC/C","names":["src_exports","__export","PGliteProvider","makePGliteProvider","useLiveIncrementalQuery","useLiveQuery","usePGlite","__toCommonJS","import_react","import_jsx_runtime","makePGliteProvider","ctx","db","dbProvided","children","PGliteProvider","usePGlite","import_react","import_template","useLiveQueryImpl","query","params","key","db","usePGlite","results","setResults","cancelled","cb","ret","unsubscribe","useLiveQuery","strings","values","buildQuery","useLiveIncrementalQuery"]}
1
+ {"version":3,"sources":["../src/index.ts","../src/provider.tsx","../src/hooks.ts"],"sourcesContent":["export * from './provider'\nexport * from './hooks'\n","import React, { createContext, useContext } from 'react'\nimport { PGliteWithLive } from '@electric-sql/pglite/live'\n\ninterface Props<T extends PGliteWithLive> {\n children?: React.ReactNode\n db?: T\n}\n\ntype PGliteProvider<T extends PGliteWithLive> = (props: Props<T>) => JSX.Element\ntype UsePGlite<T extends PGliteWithLive> = (db?: T) => T\n\ninterface PGliteProviderSet<T extends PGliteWithLive> {\n PGliteProvider: PGliteProvider<T>\n usePGlite: UsePGlite<T>\n}\n\n/**\n * Create a typed set of {@link PGliteProvider} and {@link usePGlite}.\n */\nfunction makePGliteProvider<T extends PGliteWithLive>(): PGliteProviderSet<T> {\n const ctx = createContext<T | undefined>(undefined)\n return {\n usePGlite: (db?: T) => {\n const dbProvided = useContext(ctx)\n\n // allow providing a db explicitly\n if (db) return db\n\n if (!dbProvided)\n throw new Error(\n 'No PGlite instance found, use PGliteProvider to provide one',\n )\n\n return dbProvided\n },\n PGliteProvider: ({ children, db }: Props<T>) => {\n return <ctx.Provider value={db}>{children}</ctx.Provider>\n },\n }\n}\n\nconst { PGliteProvider, usePGlite } = makePGliteProvider<PGliteWithLive>()\n\nexport { makePGliteProvider, PGliteProvider, usePGlite }\n","import { useEffect, useState, useRef } from 'react'\nimport { Results } from '@electric-sql/pglite'\nimport { usePGlite } from './provider'\nimport { query as buildQuery } from '@electric-sql/pglite/template'\n\nfunction paramsEqual(\n a1: unknown[] | undefined | null,\n a2: unknown[] | undefined | null,\n) {\n if (!a1 && !a2) return true\n if (a1?.length !== a2?.length) return false\n for (let i = 0; i < a1!.length; i++) {\n if (!Object.is(a1![i], a2![i])) {\n return false\n }\n }\n return true\n}\n\nfunction useLiveQueryImpl<T = { [key: string]: unknown }>(\n query: string,\n params: unknown[] | undefined | null,\n key?: string,\n): Omit<Results<T>, 'affectedRows'> | undefined {\n const db = usePGlite()\n const [results, setResults] = useState<Results<T>>()\n const paramsRef = useRef(params)\n\n let currentParams = paramsRef.current\n if (!paramsEqual(paramsRef.current, params)) {\n paramsRef.current = params\n currentParams = params\n }\n\n useEffect(() => {\n let cancelled = false\n const cb = (results: Results<T>) => {\n if (cancelled) return\n setResults(results)\n }\n const ret =\n key !== undefined\n ? db.live.incrementalQuery<T>(query, currentParams, key, cb)\n : db.live.query<T>(query, currentParams, cb)\n\n return () => {\n cancelled = true\n ret.then(({ unsubscribe }) => unsubscribe())\n }\n }, [db, key, query, currentParams])\n return (\n results && {\n rows: results.rows,\n fields: results.fields,\n }\n )\n}\n\nexport function useLiveQuery<T = { [key: string]: unknown }>(\n query: string,\n params?: unknown[] | null,\n): Results<T> | undefined {\n return useLiveQueryImpl<T>(query, params)\n}\n\nuseLiveQuery.sql = function <T = { [key: string]: unknown }>(\n strings: TemplateStringsArray,\n ...values: any[]\n): Results<T> | undefined {\n const { query, params } = buildQuery(strings, ...values)\n // eslint-disable-next-line react-compiler/react-compiler\n // eslint-disable-next-line react-hooks/rules-of-hooks\n return useLiveQueryImpl<T>(query, params)\n}\n\nexport function useLiveIncrementalQuery<T = { [key: string]: unknown }>(\n query: string,\n params: unknown[] | undefined | null,\n key: string,\n): Results<T> | undefined {\n return useLiveQueryImpl<T>(query, params, key)\n}\n"],"mappings":"yaAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,oBAAAE,EAAA,uBAAAC,EAAA,4BAAAC,EAAA,iBAAAC,EAAA,cAAAC,IAAA,eAAAC,EAAAP,GCAA,IAAAQ,EAAiD,iBAoCpCC,EAAA,6BAjBb,SAASC,GAAqE,CAC5E,IAAMC,KAAM,iBAA6B,MAAS,EAClD,MAAO,CACL,UAAYC,GAAW,CACrB,IAAMC,KAAa,cAAWF,CAAG,EAGjC,GAAIC,EAAI,OAAOA,EAEf,GAAI,CAACC,EACH,MAAM,IAAI,MACR,6DACF,EAEF,OAAOA,CACT,EACA,eAAgB,CAAC,CAAE,SAAAC,EAAU,GAAAF,CAAG,OACvB,OAACD,EAAI,SAAJ,CAAa,MAAOC,EAAK,SAAAE,EAAS,CAE9C,CACF,CAEA,GAAM,CAAE,eAAAC,EAAgB,UAAAC,CAAU,EAAIN,EAAmC,ECzCzE,IAAAO,EAA4C,iBAG5C,IAAAC,EAAoC,yCAEpC,SAASC,EACPC,EACAC,EACA,CACA,GAAI,CAACD,GAAM,CAACC,EAAI,MAAO,GACvB,GAAID,GAAI,SAAWC,GAAI,OAAQ,MAAO,GACtC,QAASC,EAAI,EAAGA,EAAIF,EAAI,OAAQE,IAC9B,GAAI,CAAC,OAAO,GAAGF,EAAIE,CAAC,EAAGD,EAAIC,CAAC,CAAC,EAC3B,MAAO,GAGX,MAAO,EACT,CAEA,SAASC,EACPC,EACAC,EACAC,EAC8C,CAC9C,IAAMC,EAAKC,EAAU,EACf,CAACC,EAASC,CAAU,KAAI,YAAqB,EAC7CC,KAAY,UAAON,CAAM,EAE3BO,EAAgBD,EAAU,QAC9B,OAAKZ,EAAYY,EAAU,QAASN,CAAM,IACxCM,EAAU,QAAUN,EACpBO,EAAgBP,MAGlB,aAAU,IAAM,CACd,IAAIQ,EAAY,GACVC,EAAML,GAAwB,CAC9BI,GACJH,EAAWD,CAAO,CACpB,EACMM,EACJT,IAAQ,OACJC,EAAG,KAAK,iBAAoBH,EAAOQ,EAAeN,EAAKQ,CAAE,EACzDP,EAAG,KAAK,MAASH,EAAOQ,EAAeE,CAAE,EAE/C,MAAO,IAAM,CACXD,EAAY,GACZE,EAAI,KAAK,CAAC,CAAE,YAAAC,CAAY,IAAMA,EAAY,CAAC,CAC7C,CACF,EAAG,CAACT,EAAID,EAAKF,EAAOQ,CAAa,CAAC,EAEhCH,GAAW,CACT,KAAMA,EAAQ,KACd,OAAQA,EAAQ,MAClB,CAEJ,CAEO,SAASQ,EACdb,EACAC,EACwB,CACxB,OAAOF,EAAoBC,EAAOC,CAAM,CAC1C,CAEAY,EAAa,IAAM,SACjBC,KACGC,EACqB,CACxB,GAAM,CAAE,MAAAf,EAAO,OAAAC,CAAO,KAAI,EAAAe,OAAWF,EAAS,GAAGC,CAAM,EAGvD,OAAOhB,EAAoBC,EAAOC,CAAM,CAC1C,EAEO,SAASgB,EACdjB,EACAC,EACAC,EACwB,CACxB,OAAOH,EAAoBC,EAAOC,EAAQC,CAAG,CAC/C","names":["src_exports","__export","PGliteProvider","makePGliteProvider","useLiveIncrementalQuery","useLiveQuery","usePGlite","__toCommonJS","import_react","import_jsx_runtime","makePGliteProvider","ctx","db","dbProvided","children","PGliteProvider","usePGlite","import_react","import_template","paramsEqual","a1","a2","i","useLiveQueryImpl","query","params","key","db","usePGlite","results","setResults","paramsRef","currentParams","cancelled","cb","ret","unsubscribe","useLiveQuery","strings","values","buildQuery","useLiveIncrementalQuery"]}
package/dist/index.d.cts CHANGED
@@ -21,7 +21,7 @@ declare const usePGlite: UsePGlite<PGliteWithLive>;
21
21
 
22
22
  declare function useLiveQuery<T = {
23
23
  [key: string]: unknown;
24
- }>(query: string, params: unknown[] | undefined | null): Results<T> | undefined;
24
+ }>(query: string, params?: unknown[] | null): Results<T> | undefined;
25
25
  declare namespace useLiveQuery {
26
26
  var sql: <T = {
27
27
  [key: string]: unknown;
package/dist/index.d.ts CHANGED
@@ -21,7 +21,7 @@ declare const usePGlite: UsePGlite<PGliteWithLive>;
21
21
 
22
22
  declare function useLiveQuery<T = {
23
23
  [key: string]: unknown;
24
- }>(query: string, params: unknown[] | undefined | null): Results<T> | undefined;
24
+ }>(query: string, params?: unknown[] | null): Results<T> | undefined;
25
25
  declare namespace useLiveQuery {
26
26
  var sql: <T = {
27
27
  [key: string]: unknown;
package/dist/index.js CHANGED
@@ -1,2 +1,2 @@
1
- import{createContext as T,useContext as c}from"react";import{jsx as G}from"react/jsx-runtime";function v(){let t=T(void 0);return{usePGlite:e=>{let n=c(t);if(e)return e;if(!n)throw new Error("No PGlite instance found, use PGliteProvider to provide one");return n},PGliteProvider:({children:e,db:n})=>G(t.Provider,{value:n,children:e})}}var{PGliteProvider:R,usePGlite:d}=v();import{useEffect as p,useState as m}from"react";import{query as a}from"@electric-sql/pglite/template";function s(t,e,n){let i=d(),[r,P]=m();return p(()=>{let u=!1,l=o=>{u||P(o)},f=n!==void 0?i.live.incrementalQuery(t,e,n,l):i.live.query(t,e,l);return()=>{u=!0,f.then(({unsubscribe:o})=>o())}},[i,n,t,...e??[]]),r&&{rows:r.rows,fields:r.fields}}function x(t,e){return s(t,e)}x.sql=function(t,...e){let{query:n,params:i}=a(t,...e);return s(n,i)};function b(t,e,n){return s(t,e,n)}export{R as PGliteProvider,v as makePGliteProvider,b as useLiveIncrementalQuery,x as useLiveQuery,d as usePGlite};
1
+ import{createContext as v,useContext as G}from"react";import{jsx as p}from"react/jsx-runtime";function m(){let t=v(void 0);return{usePGlite:e=>{let n=G(t);if(e)return e;if(!n)throw new Error("No PGlite instance found, use PGliteProvider to provide one");return n},PGliteProvider:({children:e,db:n})=>p(t.Provider,{value:n,children:e})}}var{PGliteProvider:L,usePGlite:P}=m();import{useEffect as a,useState as w,useRef as R}from"react";import{query as g}from"@electric-sql/pglite/template";function h(t,e){if(!t&&!e)return!0;if(t?.length!==e?.length)return!1;for(let n=0;n<t.length;n++)if(!Object.is(t[n],e[n]))return!1;return!0}function l(t,e,n){let r=P(),[u,c]=w(),o=R(e),i=o.current;return h(o.current,e)||(o.current=e,i=e),a(()=>{let d=!1,f=s=>{d||c(s)},T=n!==void 0?r.live.incrementalQuery(t,i,n,f):r.live.query(t,i,f);return()=>{d=!0,T.then(({unsubscribe:s})=>s())}},[r,n,t,i]),u&&{rows:u.rows,fields:u.fields}}function x(t,e){return l(t,e)}x.sql=function(t,...e){let{query:n,params:r}=g(t,...e);return l(n,r)};function q(t,e,n){return l(t,e,n)}export{L as PGliteProvider,m as makePGliteProvider,q as useLiveIncrementalQuery,x as useLiveQuery,P as usePGlite};
2
2
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/provider.tsx","../src/hooks.ts"],"sourcesContent":["import React, { createContext, useContext } from 'react'\nimport { PGliteWithLive } from '@electric-sql/pglite/live'\n\ninterface Props<T extends PGliteWithLive> {\n children?: React.ReactNode\n db?: T\n}\n\ntype PGliteProvider<T extends PGliteWithLive> = (props: Props<T>) => JSX.Element\ntype UsePGlite<T extends PGliteWithLive> = (db?: T) => T\n\ninterface PGliteProviderSet<T extends PGliteWithLive> {\n PGliteProvider: PGliteProvider<T>\n usePGlite: UsePGlite<T>\n}\n\n/**\n * Create a typed set of {@link PGliteProvider} and {@link usePGlite}.\n */\nfunction makePGliteProvider<T extends PGliteWithLive>(): PGliteProviderSet<T> {\n const ctx = createContext<T | undefined>(undefined)\n return {\n usePGlite: (db?: T) => {\n const dbProvided = useContext(ctx)\n\n // allow providing a db explicitly\n if (db) return db\n\n if (!dbProvided)\n throw new Error(\n 'No PGlite instance found, use PGliteProvider to provide one',\n )\n\n return dbProvided\n },\n PGliteProvider: ({ children, db }: Props<T>) => {\n return <ctx.Provider value={db}>{children}</ctx.Provider>\n },\n }\n}\n\nconst { PGliteProvider, usePGlite } = makePGliteProvider<PGliteWithLive>()\n\nexport { makePGliteProvider, PGliteProvider, usePGlite }\n","import { useEffect, useState } from 'react'\nimport { Results } from '@electric-sql/pglite'\nimport { usePGlite } from './provider'\nimport { query as buildQuery } from '@electric-sql/pglite/template'\n\nfunction useLiveQueryImpl<T = { [key: string]: unknown }>(\n query: string,\n params: unknown[] | undefined | null,\n key?: string,\n): Omit<Results<T>, 'affectedRows'> | undefined {\n const db = usePGlite()\n const [results, setResults] = useState<Results<T>>()\n useEffect(() => {\n let cancelled = false\n const cb = (results: Results<T>) => {\n if (cancelled) return\n setResults(results)\n }\n const ret =\n key !== undefined\n ? db.live.incrementalQuery<T>(query, params, key, cb)\n : db.live.query<T>(query, params, cb)\n\n return () => {\n cancelled = true\n ret.then(({ unsubscribe }) => unsubscribe())\n }\n\n // Using spread operator for params to avoid serializing it to JSON\n // or performing more complicated array equality checks\n // eslint-disable-next-line react-compiler/react-compiler\n // eslint-disable-next-line react-hooks/exhaustive-deps\n }, [db, key, query, ...(params ?? [])])\n return (\n results && {\n rows: results.rows,\n fields: results.fields,\n }\n )\n}\n\nexport function useLiveQuery<T = { [key: string]: unknown }>(\n query: string,\n params: unknown[] | undefined | null,\n): Results<T> | undefined {\n return useLiveQueryImpl<T>(query, params)\n}\n\nuseLiveQuery.sql = function <T = { [key: string]: unknown }>(\n strings: TemplateStringsArray,\n ...values: any[]\n): Results<T> | undefined {\n const { query, params } = buildQuery(strings, ...values)\n // eslint-disable-next-line react-compiler/react-compiler\n // eslint-disable-next-line react-hooks/rules-of-hooks\n return useLiveQueryImpl<T>(query, params)\n}\n\nexport function useLiveIncrementalQuery<T = { [key: string]: unknown }>(\n query: string,\n params: unknown[] | undefined | null,\n key: string,\n): Results<T> | undefined {\n return useLiveQueryImpl<T>(query, params, key)\n}\n"],"mappings":"AAAA,OAAgB,iBAAAA,EAAe,cAAAC,MAAkB,QAoCpC,cAAAC,MAAA,oBAjBb,SAASC,GAAqE,CAC5E,IAAMC,EAAMJ,EAA6B,MAAS,EAClD,MAAO,CACL,UAAYK,GAAW,CACrB,IAAMC,EAAaL,EAAWG,CAAG,EAGjC,GAAIC,EAAI,OAAOA,EAEf,GAAI,CAACC,EACH,MAAM,IAAI,MACR,6DACF,EAEF,OAAOA,CACT,EACA,eAAgB,CAAC,CAAE,SAAAC,EAAU,GAAAF,CAAG,IACvBH,EAACE,EAAI,SAAJ,CAAa,MAAOC,EAAK,SAAAE,EAAS,CAE9C,CACF,CAEA,GAAM,CAAE,eAAAC,EAAgB,UAAAC,CAAU,EAAIN,EAAmC,ECzCzE,OAAS,aAAAO,EAAW,YAAAC,MAAgB,QAGpC,OAAS,SAASC,MAAkB,gCAEpC,SAASC,EACPC,EACAC,EACAC,EAC8C,CAC9C,IAAMC,EAAKC,EAAU,EACf,CAACC,EAASC,CAAU,EAAIC,EAAqB,EACnD,OAAAC,EAAU,IAAM,CACd,IAAIC,EAAY,GACVC,EAAML,GAAwB,CAC9BI,GACJH,EAAWD,CAAO,CACpB,EACMM,EACJT,IAAQ,OACJC,EAAG,KAAK,iBAAoBH,EAAOC,EAAQC,EAAKQ,CAAE,EAClDP,EAAG,KAAK,MAASH,EAAOC,EAAQS,CAAE,EAExC,MAAO,IAAM,CACXD,EAAY,GACZE,EAAI,KAAK,CAAC,CAAE,YAAAC,CAAY,IAAMA,EAAY,CAAC,CAC7C,CAMF,EAAG,CAACT,EAAID,EAAKF,EAAO,GAAIC,GAAU,CAAC,CAAE,CAAC,EAEpCI,GAAW,CACT,KAAMA,EAAQ,KACd,OAAQA,EAAQ,MAClB,CAEJ,CAEO,SAASQ,EACdb,EACAC,EACwB,CACxB,OAAOF,EAAoBC,EAAOC,CAAM,CAC1C,CAEAY,EAAa,IAAM,SACjBC,KACGC,EACqB,CACxB,GAAM,CAAE,MAAAf,EAAO,OAAAC,CAAO,EAAIH,EAAWgB,EAAS,GAAGC,CAAM,EAGvD,OAAOhB,EAAoBC,EAAOC,CAAM,CAC1C,EAEO,SAASe,EACdhB,EACAC,EACAC,EACwB,CACxB,OAAOH,EAAoBC,EAAOC,EAAQC,CAAG,CAC/C","names":["createContext","useContext","jsx","makePGliteProvider","ctx","db","dbProvided","children","PGliteProvider","usePGlite","useEffect","useState","buildQuery","useLiveQueryImpl","query","params","key","db","usePGlite","results","setResults","useState","useEffect","cancelled","cb","ret","unsubscribe","useLiveQuery","strings","values","useLiveIncrementalQuery"]}
1
+ {"version":3,"sources":["../src/provider.tsx","../src/hooks.ts"],"sourcesContent":["import React, { createContext, useContext } from 'react'\nimport { PGliteWithLive } from '@electric-sql/pglite/live'\n\ninterface Props<T extends PGliteWithLive> {\n children?: React.ReactNode\n db?: T\n}\n\ntype PGliteProvider<T extends PGliteWithLive> = (props: Props<T>) => JSX.Element\ntype UsePGlite<T extends PGliteWithLive> = (db?: T) => T\n\ninterface PGliteProviderSet<T extends PGliteWithLive> {\n PGliteProvider: PGliteProvider<T>\n usePGlite: UsePGlite<T>\n}\n\n/**\n * Create a typed set of {@link PGliteProvider} and {@link usePGlite}.\n */\nfunction makePGliteProvider<T extends PGliteWithLive>(): PGliteProviderSet<T> {\n const ctx = createContext<T | undefined>(undefined)\n return {\n usePGlite: (db?: T) => {\n const dbProvided = useContext(ctx)\n\n // allow providing a db explicitly\n if (db) return db\n\n if (!dbProvided)\n throw new Error(\n 'No PGlite instance found, use PGliteProvider to provide one',\n )\n\n return dbProvided\n },\n PGliteProvider: ({ children, db }: Props<T>) => {\n return <ctx.Provider value={db}>{children}</ctx.Provider>\n },\n }\n}\n\nconst { PGliteProvider, usePGlite } = makePGliteProvider<PGliteWithLive>()\n\nexport { makePGliteProvider, PGliteProvider, usePGlite }\n","import { useEffect, useState, useRef } from 'react'\nimport { Results } from '@electric-sql/pglite'\nimport { usePGlite } from './provider'\nimport { query as buildQuery } from '@electric-sql/pglite/template'\n\nfunction paramsEqual(\n a1: unknown[] | undefined | null,\n a2: unknown[] | undefined | null,\n) {\n if (!a1 && !a2) return true\n if (a1?.length !== a2?.length) return false\n for (let i = 0; i < a1!.length; i++) {\n if (!Object.is(a1![i], a2![i])) {\n return false\n }\n }\n return true\n}\n\nfunction useLiveQueryImpl<T = { [key: string]: unknown }>(\n query: string,\n params: unknown[] | undefined | null,\n key?: string,\n): Omit<Results<T>, 'affectedRows'> | undefined {\n const db = usePGlite()\n const [results, setResults] = useState<Results<T>>()\n const paramsRef = useRef(params)\n\n let currentParams = paramsRef.current\n if (!paramsEqual(paramsRef.current, params)) {\n paramsRef.current = params\n currentParams = params\n }\n\n useEffect(() => {\n let cancelled = false\n const cb = (results: Results<T>) => {\n if (cancelled) return\n setResults(results)\n }\n const ret =\n key !== undefined\n ? db.live.incrementalQuery<T>(query, currentParams, key, cb)\n : db.live.query<T>(query, currentParams, cb)\n\n return () => {\n cancelled = true\n ret.then(({ unsubscribe }) => unsubscribe())\n }\n }, [db, key, query, currentParams])\n return (\n results && {\n rows: results.rows,\n fields: results.fields,\n }\n )\n}\n\nexport function useLiveQuery<T = { [key: string]: unknown }>(\n query: string,\n params?: unknown[] | null,\n): Results<T> | undefined {\n return useLiveQueryImpl<T>(query, params)\n}\n\nuseLiveQuery.sql = function <T = { [key: string]: unknown }>(\n strings: TemplateStringsArray,\n ...values: any[]\n): Results<T> | undefined {\n const { query, params } = buildQuery(strings, ...values)\n // eslint-disable-next-line react-compiler/react-compiler\n // eslint-disable-next-line react-hooks/rules-of-hooks\n return useLiveQueryImpl<T>(query, params)\n}\n\nexport function useLiveIncrementalQuery<T = { [key: string]: unknown }>(\n query: string,\n params: unknown[] | undefined | null,\n key: string,\n): Results<T> | undefined {\n return useLiveQueryImpl<T>(query, params, key)\n}\n"],"mappings":"AAAA,OAAgB,iBAAAA,EAAe,cAAAC,MAAkB,QAoCpC,cAAAC,MAAA,oBAjBb,SAASC,GAAqE,CAC5E,IAAMC,EAAMJ,EAA6B,MAAS,EAClD,MAAO,CACL,UAAYK,GAAW,CACrB,IAAMC,EAAaL,EAAWG,CAAG,EAGjC,GAAIC,EAAI,OAAOA,EAEf,GAAI,CAACC,EACH,MAAM,IAAI,MACR,6DACF,EAEF,OAAOA,CACT,EACA,eAAgB,CAAC,CAAE,SAAAC,EAAU,GAAAF,CAAG,IACvBH,EAACE,EAAI,SAAJ,CAAa,MAAOC,EAAK,SAAAE,EAAS,CAE9C,CACF,CAEA,GAAM,CAAE,eAAAC,EAAgB,UAAAC,CAAU,EAAIN,EAAmC,ECzCzE,OAAS,aAAAO,EAAW,YAAAC,EAAU,UAAAC,MAAc,QAG5C,OAAS,SAASC,MAAkB,gCAEpC,SAASC,EACPC,EACAC,EACA,CACA,GAAI,CAACD,GAAM,CAACC,EAAI,MAAO,GACvB,GAAID,GAAI,SAAWC,GAAI,OAAQ,MAAO,GACtC,QAASC,EAAI,EAAGA,EAAIF,EAAI,OAAQE,IAC9B,GAAI,CAAC,OAAO,GAAGF,EAAIE,CAAC,EAAGD,EAAIC,CAAC,CAAC,EAC3B,MAAO,GAGX,MAAO,EACT,CAEA,SAASC,EACPC,EACAC,EACAC,EAC8C,CAC9C,IAAMC,EAAKC,EAAU,EACf,CAACC,EAASC,CAAU,EAAIC,EAAqB,EAC7CC,EAAYC,EAAOR,CAAM,EAE3BS,EAAgBF,EAAU,QAC9B,OAAKb,EAAYa,EAAU,QAASP,CAAM,IACxCO,EAAU,QAAUP,EACpBS,EAAgBT,GAGlBU,EAAU,IAAM,CACd,IAAIC,EAAY,GACVC,EAAMR,GAAwB,CAC9BO,GACJN,EAAWD,CAAO,CACpB,EACMS,EACJZ,IAAQ,OACJC,EAAG,KAAK,iBAAoBH,EAAOU,EAAeR,EAAKW,CAAE,EACzDV,EAAG,KAAK,MAASH,EAAOU,EAAeG,CAAE,EAE/C,MAAO,IAAM,CACXD,EAAY,GACZE,EAAI,KAAK,CAAC,CAAE,YAAAC,CAAY,IAAMA,EAAY,CAAC,CAC7C,CACF,EAAG,CAACZ,EAAID,EAAKF,EAAOU,CAAa,CAAC,EAEhCL,GAAW,CACT,KAAMA,EAAQ,KACd,OAAQA,EAAQ,MAClB,CAEJ,CAEO,SAASW,EACdhB,EACAC,EACwB,CACxB,OAAOF,EAAoBC,EAAOC,CAAM,CAC1C,CAEAe,EAAa,IAAM,SACjBC,KACGC,EACqB,CACxB,GAAM,CAAE,MAAAlB,EAAO,OAAAC,CAAO,EAAIP,EAAWuB,EAAS,GAAGC,CAAM,EAGvD,OAAOnB,EAAoBC,EAAOC,CAAM,CAC1C,EAEO,SAASkB,EACdnB,EACAC,EACAC,EACwB,CACxB,OAAOH,EAAoBC,EAAOC,EAAQC,CAAG,CAC/C","names":["createContext","useContext","jsx","makePGliteProvider","ctx","db","dbProvided","children","PGliteProvider","usePGlite","useEffect","useState","useRef","buildQuery","paramsEqual","a1","a2","i","useLiveQueryImpl","query","params","key","db","usePGlite","results","setResults","useState","paramsRef","useRef","currentParams","useEffect","cancelled","cb","ret","unsubscribe","useLiveQuery","strings","values","useLiveIncrementalQuery"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@electric-sql/pglite-react",
3
- "version": "0.2.10",
3
+ "version": "0.2.12",
4
4
  "description": "Hooks for using PGlite",
5
5
  "type": "module",
6
6
  "private": false,
@@ -48,11 +48,11 @@
48
48
  "react": "^18.2.0",
49
49
  "react-dom": "^18.2.0",
50
50
  "vitest": "^2.0.5",
51
- "@electric-sql/pglite": "0.2.10"
51
+ "@electric-sql/pglite": "0.2.12"
52
52
  },
53
53
  "peerDependencies": {
54
54
  "react": "^18.0.0",
55
- "@electric-sql/pglite": "^0.2.10"
55
+ "@electric-sql/pglite": "^0.2.12"
56
56
  },
57
57
  "scripts": {
58
58
  "build": "tsup",