@electric-sql/react 0.0.1 → 0.0.3

package/LICENSE

@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from './react-hooks';

package/dist/index.js

@@ -0,0 +1 @@
+export * from './react-hooks';

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export * from './react-hooks'\n"],"mappings":"AAAA,cAAc;","names":[]}

package/dist/react-hooks.d.ts

@@ -0,0 +1,35 @@
+import React from 'react';
+import { Shape, ShapeStream, ShapeStreamOptions, JsonSerializable } from '@electric-sql/next';
+interface ShapeContextType {
+    getShape: (shapeStream: ShapeStream) => Shape;
+    getShapeStream: (options: ShapeStreamOptions) => ShapeStream;
+}
+export declare function preloadShape(options: ShapeStreamOptions): Promise<Shape>;
+export declare function sortedOptionsHash(options: ShapeStreamOptions): string;
+export declare function getShapeStream(options: ShapeStreamOptions): ShapeStream;
+export declare function getShape(shapeStream: ShapeStream): Shape;
+interface ShapeProviderProps {
+    children: React.ReactNode;
+}
+export declare function ShapesProvider({ children }: ShapeProviderProps): JSX.Element;
+export declare function useShapeContext(): ShapeContextType;
+interface UseShapeResult {
+    /**
+     * The array of rows that make up the Shape.
+     * @type {JsonSerializable}
+     */
+    data: JsonSerializable[];
+    /**
+     * The Shape instance used by this useShape
+     * @type(Shape)
+     */
+    shape: Shape;
+    error: Shape[`error`];
+    isError: boolean;
+    /**
+     * Has the ShapeStream caught up with the replication log from Postgres.
+     */
+    isUpToDate: boolean;
+}
+export declare function useShape(options: ShapeStreamOptions): UseShapeResult;
+export {};

package/dist/react-hooks.js

@@ -0,0 +1,130 @@
+var __getOwnPropSymbols = Object.getOwnPropertySymbols;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __propIsEnum = Object.prototype.propertyIsEnumerable;
+var __objRest = (source, exclude) => {
+  var target = {};
+  for (var prop in source)
+    if (__hasOwnProp.call(source, prop) && exclude.indexOf(prop) < 0)
+      target[prop] = source[prop];
+  if (source != null && __getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(source)) {
+      if (exclude.indexOf(prop) < 0 && __propIsEnum.call(source, prop))
+        target[prop] = source[prop];
+    }
+  return target;
+};
+var __async = (__this, __arguments, generator) => {
+  return new Promise((resolve, reject) => {
+    var fulfilled = (value) => {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var rejected = (value) => {
+      try {
+        step(generator.throw(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
+    step((generator = generator.apply(__this, __arguments)).next());
+  });
+};
+import React, { createContext, useEffect, useContext, useState } from "react";
+import {
+  Shape,
+  ShapeStream
+} from "@electric-sql/next";
+const ShapesContext = createContext(null);
+const streamCache = /* @__PURE__ */ new Map();
+const shapeCache = /* @__PURE__ */ new Map();
+function preloadShape(options) {
+  return __async(this, null, function* () {
+    const shapeStream = getShapeStream(options);
+    const shape = getShape(shapeStream);
+    yield shape.value;
+    return shape;
+  });
+}
+function sortedOptionsHash(options) {
+  const shapeDef = JSON.stringify(
+    options.shape,
+    Object.keys(options.shape).sort()
+  );
+  const _a = options, { shape } = _a, optionsWithoutShapeDef = __objRest(_a, ["shape"]);
+  const allOptions = JSON.stringify(
+    optionsWithoutShapeDef,
+    Object.keys(options).sort()
+  );
+  const shapeHash = shapeDef + allOptions;
+  return shapeHash;
+}
+function getShapeStream(options) {
+  const shapeHash = sortedOptionsHash(options);
+  if (streamCache.has(shapeHash)) {
+    return streamCache.get(shapeHash);
+  } else {
+    const newShapeStream = new ShapeStream(options);
+    streamCache.set(shapeHash, newShapeStream);
+    return newShapeStream;
+  }
+}
+function getShape(shapeStream) {
+  if (shapeCache.has(shapeStream)) {
+    return shapeCache.get(shapeStream);
+  } else {
+    const newShape = new Shape(shapeStream);
+    shapeCache.set(shapeStream, newShape);
+    return newShape;
+  }
+}
+function ShapesProvider({ children }) {
+  return /* @__PURE__ */ React.createElement(ShapesContext.Provider, { value: { getShape, getShapeStream } }, children);
+}
+function useShapeContext() {
+  const context = useContext(ShapesContext);
+  if (!context) {
+    throw new Error(`useShapeContext must be used within a ShapeProvider`);
+  }
+  return context;
+}
+function useShape(options) {
+  const { getShape: getShape2, getShapeStream: getShapeStream2 } = useShapeContext();
+  const shapeStream = getShapeStream2(options);
+  const shape = getShape2(shapeStream);
+  const [shapeData, setShapeData] = useState({
+    data: [...shape.valueSync.values()],
+    isUpToDate: shape.isUpToDate,
+    isError: shape.error !== false,
+    shape,
+    error: shape.error
+  });
+  useEffect(() => {
+    const unsubscribe = shape.subscribe((map) => {
+      setShapeData({
+        data: [...map.values()],
+        isUpToDate: shape.isUpToDate,
+        isError: shape.error !== false,
+        shape,
+        error: shape.error
+      });
+    });
+    return () => {
+      unsubscribe();
+    };
+  }, []);
+  return shapeData;
+}
+export {
+  ShapesProvider,
+  getShape,
+  getShapeStream,
+  preloadShape,
+  sortedOptionsHash,
+  useShape,
+  useShapeContext
+};
+//# sourceMappingURL=react-hooks.js.map

package/dist/react-hooks.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/react-hooks.tsx"],"sourcesContent":["import React, { createContext, useEffect, useContext, useState } from 'react'\nimport {\n  Shape,\n  ShapeStream,\n  ShapeStreamOptions,\n  JsonSerializable,\n} from '@electric-sql/next'\n\ninterface ShapeContextType {\n  getShape: (shapeStream: ShapeStream) => Shape\n  getShapeStream: (options: ShapeStreamOptions) => ShapeStream\n}\n\n// Create a Context\nconst ShapesContext = createContext<ShapeContextType | null>(null)\n\nconst streamCache = new Map<string, ShapeStream>()\nconst shapeCache = new Map<ShapeStream, Shape>()\n\nexport async function preloadShape(\n  options: ShapeStreamOptions\n): Promise<Shape> {\n  const shapeStream = getShapeStream(options)\n  const shape = getShape(shapeStream)\n  await shape.value\n  return shape\n}\n\nexport function sortedOptionsHash(options: ShapeStreamOptions): string {\n  const shapeDef = JSON.stringify(\n    options.shape,\n    Object.keys(options.shape).sort()\n  )\n  // eslint-disable-next-line\n  const { shape, ...optionsWithoutShapeDef } = options\n  const allOptions = JSON.stringify(\n    optionsWithoutShapeDef,\n    Object.keys(options).sort()\n  )\n  const shapeHash = shapeDef + allOptions\n\n  return shapeHash\n}\n\nexport function getShapeStream(options: ShapeStreamOptions): ShapeStream {\n  const shapeHash = sortedOptionsHash(options)\n\n  // If the stream is already cached, return\n  if (streamCache.has(shapeHash)) {\n    // Return the ShapeStream\n    return streamCache.get(shapeHash)!\n  } else {\n    const newShapeStream = new ShapeStream(options)\n\n    streamCache.set(shapeHash, newShapeStream)\n\n    // Return the created shape\n    return newShapeStream\n  }\n}\n\nexport function getShape(shapeStream: ShapeStream): Shape {\n  // If the stream is already cached, return\n  if (shapeCache.has(shapeStream)) {\n    // Return the ShapeStream\n    return shapeCache.get(shapeStream)!\n  } else {\n    const newShape = new Shape(shapeStream)\n\n    shapeCache.set(shapeStream, newShape)\n\n    // Return the created shape\n    return newShape\n  }\n}\n\ninterface ShapeProviderProps {\n  children: React.ReactNode\n}\n\n// Shapes Provider Component\nexport function ShapesProvider({ children }: ShapeProviderProps): JSX.Element {\n  // Provide the context value\n  return (\n    <ShapesContext.Provider value={{ getShape, getShapeStream }}>\n      {children}\n    </ShapesContext.Provider>\n  )\n}\n\nexport function useShapeContext() {\n  const context = useContext(ShapesContext)\n  if (!context) {\n    throw new Error(`useShapeContext must be used within a ShapeProvider`)\n  }\n  return context\n}\n\ninterface UseShapeResult {\n  /**\n   * The array of rows that make up the Shape.\n   * @type {JsonSerializable}\n   */\n  data: JsonSerializable[]\n  /**\n   * The Shape instance used by this useShape\n   * @type(Shape)\n   */\n  shape: Shape\n  error: Shape[`error`]\n  isError: boolean\n  /**\n   * Has the ShapeStream caught up with the replication log from Postgres.\n   */\n  isUpToDate: boolean\n}\n\nexport function useShape(options: ShapeStreamOptions): UseShapeResult {\n  const { getShape, getShapeStream } = useShapeContext()\n  const shapeStream = getShapeStream(options)\n  const shape = getShape(shapeStream)\n  const [shapeData, setShapeData] = useState<UseShapeResult>({\n    data: [...shape.valueSync.values()],\n    isUpToDate: shape.isUpToDate,\n    isError: shape.error !== false,\n    shape,\n    error: shape.error,\n  })\n\n  useEffect(() => {\n    // Subscribe to updates.\n    const unsubscribe = shape.subscribe((map) => {\n      setShapeData({\n        data: [...map.values()],\n        isUpToDate: shape.isUpToDate,\n        isError: shape.error !== false,\n        shape,\n        error: shape.error,\n      })\n    })\n\n    return () => {\n      unsubscribe()\n    }\n  }, [])\n\n  return shapeData\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,SAAS,eAAe,WAAW,YAAY,gBAAgB;AACtE;AAAA,EACE;AAAA,EACA;AAAA,OAGK;AAQP,MAAM,gBAAgB,cAAuC,IAAI;AAEjE,MAAM,cAAc,oBAAI,IAAyB;AACjD,MAAM,aAAa,oBAAI,IAAwB;AAE/C,SAAsB,aACpB,SACgB;AAAA;AAChB,UAAM,cAAc,eAAe,OAAO;AAC1C,UAAM,QAAQ,SAAS,WAAW;AAClC,UAAM,MAAM;AACZ,WAAO;AAAA,EACT;AAAA;AAEO,SAAS,kBAAkB,SAAqC;AACrE,QAAM,WAAW,KAAK;AAAA,IACpB,QAAQ;AAAA,IACR,OAAO,KAAK,QAAQ,KAAK,EAAE,KAAK;AAAA,EAClC;AAEA,QAA6C,cAArC,QAlCV,IAkC+C,IAA3B,mCAA2B,IAA3B,CAAV;AACR,QAAM,aAAa,KAAK;AAAA,IACtB;AAAA,IACA,OAAO,KAAK,OAAO,EAAE,KAAK;AAAA,EAC5B;AACA,QAAM,YAAY,WAAW;AAE7B,SAAO;AACT;AAEO,SAAS,eAAe,SAA0C;AACvE,QAAM,YAAY,kBAAkB,OAAO;AAG3C,MAAI,YAAY,IAAI,SAAS,GAAG;AAE9B,WAAO,YAAY,IAAI,SAAS;AAAA,EAClC,OAAO;AACL,UAAM,iBAAiB,IAAI,YAAY,OAAO;AAE9C,gBAAY,IAAI,WAAW,cAAc;AAGzC,WAAO;AAAA,EACT;AACF;AAEO,SAAS,SAAS,aAAiC;AAExD,MAAI,WAAW,IAAI,WAAW,GAAG;AAE/B,WAAO,WAAW,IAAI,WAAW;AAAA,EACnC,OAAO;AACL,UAAM,WAAW,IAAI,MAAM,WAAW;AAEtC,eAAW,IAAI,aAAa,QAAQ;AAGpC,WAAO;AAAA,EACT;AACF;AAOO,SAAS,eAAe,EAAE,SAAS,GAAoC;AAE5E,SACE,oCAAC,cAAc,UAAd,EAAuB,OAAO,EAAE,UAAU,eAAe,KACvD,QACH;AAEJ;AAEO,SAAS,kBAAkB;AAChC,QAAM,UAAU,WAAW,aAAa;AACxC,MAAI,CAAC,SAAS;AACZ,UAAM,IAAI,MAAM,qDAAqD;AAAA,EACvE;AACA,SAAO;AACT;AAqBO,SAAS,SAAS,SAA6C;AACpE,QAAM,EAAE,UAAAA,WAAU,gBAAAC,gBAAe,IAAI,gBAAgB;AACrD,QAAM,cAAcA,gBAAe,OAAO;AAC1C,QAAM,QAAQD,UAAS,WAAW;AAClC,QAAM,CAAC,WAAW,YAAY,IAAI,SAAyB;AAAA,IACzD,MAAM,CAAC,GAAG,MAAM,UAAU,OAAO,CAAC;AAAA,IAClC,YAAY,MAAM;AAAA,IAClB,SAAS,MAAM,UAAU;AAAA,IACzB;AAAA,IACA,OAAO,MAAM;AAAA,EACf,CAAC;AAED,YAAU,MAAM;AAEd,UAAM,cAAc,MAAM,UAAU,CAAC,QAAQ;AAC3C,mBAAa;AAAA,QACX,MAAM,CAAC,GAAG,IAAI,OAAO,CAAC;AAAA,QACtB,YAAY,MAAM;AAAA,QAClB,SAAS,MAAM,UAAU;AAAA,QACzB;AAAA,QACA,OAAO,MAAM;AAAA,MACf,CAAC;AAAA,IACH,CAAC;AAED,WAAO,MAAM;AACX,kBAAY;AAAA,IACd;AAAA,EACF,GAAG,CAAC,CAAC;AAEL,SAAO;AACT;","names":["getShape","getShapeStream"]}

package/dist/react-hooks.jsx

@@ -0,0 +1,111 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+import React, { createContext, useEffect, useContext, useState } from 'react';
+import { Shape, ShapeStream, } from '@electric-sql/next';
+// Create a Context
+const ShapesContext = createContext(null);
+const streamCache = new Map();
+const shapeCache = new Map();
+export function preloadShape(options) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const shapeStream = getShapeStream(options);
+        const shape = getShape(shapeStream);
+        yield shape.value;
+        return shape;
+    });
+}
+export function sortedOptionsHash(options) {
+    const shapeDef = JSON.stringify(options.shape, Object.keys(options.shape).sort());
+    // eslint-disable-next-line
+    const { shape } = options, optionsWithoutShapeDef = __rest(options, ["shape"]);
+    const allOptions = JSON.stringify(optionsWithoutShapeDef, Object.keys(options).sort());
+    const shapeHash = shapeDef + allOptions;
+    return shapeHash;
+}
+export function getShapeStream(options) {
+    const shapeHash = sortedOptionsHash(options);
+    // If the stream is already cached, return
+    if (streamCache.has(shapeHash)) {
+        // Return the ShapeStream
+        return streamCache.get(shapeHash);
+    }
+    else {
+        const newShapeStream = new ShapeStream(options);
+        streamCache.set(shapeHash, newShapeStream);
+        // Return the created shape
+        return newShapeStream;
+    }
+}
+export function getShape(shapeStream) {
+    // If the stream is already cached, return
+    if (shapeCache.has(shapeStream)) {
+        // Return the ShapeStream
+        return shapeCache.get(shapeStream);
+    }
+    else {
+        const newShape = new Shape(shapeStream);
+        shapeCache.set(shapeStream, newShape);
+        // Return the created shape
+        return newShape;
+    }
+}
+// Shapes Provider Component
+export function ShapesProvider({ children }) {
+    // Provide the context value
+    return (<ShapesContext.Provider value={{ getShape, getShapeStream }}>
+      {children}
+    </ShapesContext.Provider>);
+}
+export function useShapeContext() {
+    const context = useContext(ShapesContext);
+    if (!context) {
+        throw new Error(`useShapeContext must be used within a ShapeProvider`);
+    }
+    return context;
+}
+export function useShape(options) {
+    const { getShape, getShapeStream } = useShapeContext();
+    const shapeStream = getShapeStream(options);
+    const shape = getShape(shapeStream);
+    const [shapeData, setShapeData] = useState({
+        data: [...shape.valueSync.values()],
+        isUpToDate: shape.isUpToDate,
+        isError: shape.error !== false,
+        shape,
+        error: shape.error,
+    });
+    useEffect(() => {
+        // Subscribe to updates.
+        const unsubscribe = shape.subscribe((map) => {
+            setShapeData({
+                data: [...map.values()],
+                isUpToDate: shape.isUpToDate,
+                isError: shape.error !== false,
+                shape,
+                error: shape.error,
+            });
+        });
+        return () => {
+            unsubscribe();
+        };
+    }, []);
+    return shapeData;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@electric-sql/react",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "React hooks for ElectricSQL",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -11,14 +11,14 @@
     "type": "git",
     "url": "git+https://github.com/electric-sql/electric-next.git"
   },
-  "author": "",
-  "license": "ISC",
+  "author": "ElectricSQL team and contributors.",
+  "license": "Apache-2",
   "bugs": {
     "url": "https://github.com/electric-sql/electric-next/issues"
   },
-  "homepage": "https://github.com/electric-sql/electric-next#readme",
+  "homepage": "https://next.electric-sql.com",
   "dependencies": {
-    "@electric-sql/next": "0.0.1"
+    "@electric-sql/next": "0.0.3"
   },
   "devDependencies": {
     "@testing-library/react": "^16.0.0",