@idb-orm/react 0.0.1

package/LICENSE

@@ -0,0 +1,7 @@
+ISC License
+
+Copyright 2025 jtb
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+# @idb-orm/react
+
+> ## THIS PACKAGE IS BRAND-NEW AND UNSTABLE. DO NOT USE

package/dist/index.cjs.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("react");exports.clientProviderFactory=function(t){const r=e.createContext(null);return{Context:r,useDbClient:()=>{const t=e.useContext(r);if(!t)throw new Error("Client Context not found. Please ensure this component is wrapped in a <DbClientProvider /> component.");return t},DbClientProvider:({fallback:n,children:o,version:i})=>{const[c,l]=e.useState(null);return e.useEffect(()=>{t.createClientAsync(i).then(e=>{l(e)}).catch(e=>{throw new Error(`@idb-orm Client Creation Failed: ${e}`)})},[i]),c?React.createElement(r.Provider,{value:c},o):n}}};

package/dist/index.d.ts

@@ -0,0 +1,24 @@
+import { PropsWithChildren, ReactNode, Context } from 'react';
+import { core } from '@idb-orm/core';
+export interface ClientProviderProps<Name extends string, ModelNames extends string, Models extends core.CollectionObject<ModelNames>> {
+    /**
+     * `CompiledDb` object
+     */
+    db: core.CompiledDb<Name, ModelNames, Models>;
+    /**
+     * React node to render while the client is being built
+     * @default undefined
+     */
+    fallback?: ReactNode;
+    /**
+     * Version of the IDB Database
+     * @default 1
+     */
+    version?: number;
+}
+export interface ClientProviderFactoryReturn<Name extends string, ModelNames extends string, Models extends core.CollectionObject<ModelNames>> {
+    Context: Context<core.DbClient<Name, ModelNames, Models> | null>;
+    useDbClient: () => core.DbClient<Name, ModelNames, Models>;
+    DbClientProvider: (props: PropsWithChildren<ClientProviderProps<Name, ModelNames, Models>>) => ReactNode;
+}
+export declare function clientProviderFactory<Name extends string, ModelNames extends string, Models extends core.CollectionObject<ModelNames>>(db: core.CompiledDb<Name, ModelNames, Models>): ClientProviderFactoryReturn<Name, ModelNames, Models>;

package/dist/index.es.js

@@ -0,0 +1 @@
+import{createContext as e,useState as n,useEffect as t,useContext as r}from"react";function o(o){const i=e(null);return{Context:i,useDbClient:()=>{const e=r(i);if(!e)throw new Error("Client Context not found. Please ensure this component is wrapped in a <DbClientProvider /> component.");return e},DbClientProvider:({fallback:e,children:r,version:l})=>{const[c,a]=n(null);return t(()=>{o.createClientAsync(l).then(e=>{a(e)}).catch(e=>{throw new Error(`@idb-orm Client Creation Failed: ${e}`)})},[l]),c?/* @__PURE__ */React.createElement(i.Provider,{value:c},r):e}}}export{o as clientProviderFactory};

package/package.json

@@ -0,0 +1,46 @@
+{
+    "name": "@idb-orm/react",
+    "version": "0.0.1",
+    "description": "An adapter for the React framework for @idb-orm",
+    "main": "dist/index.js",
+    "scripts": {
+        "build": "vite build",
+        "build-test": "vite --config vite.config-test.ts build"
+    },
+    "keywords": [
+        "typescript",
+        "react",
+        "adapter",
+        "idb-orm"
+    ],
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "import": "./dist/index.es.js",
+            "require": "./dist/index.cjs.js"
+        }
+    },
+    "author": "jtb",
+    "license": "ISC",
+    "peerDependencies": {
+        "@idb-orm/core": "^1.0.7",
+        "react": "^19.2.0"
+    },
+    "devDependencies": {
+        "@eslint/js": "^9.38.0",
+        "@rollup/plugin-alias": "^6.0.0",
+        "@rollup/plugin-node-resolve": "^16.0.3",
+        "@rollup/plugin-terser": "^0.4.4",
+        "@rollup/plugin-typescript": "^12.1.4",
+        "@types/node": "^24.9.1",
+        "@types/react": "^19.2.7",
+        "eslint": "^9.38.0",
+        "rollup": "^4.52.4",
+        "serve": "^14.2.5",
+        "tslib": "^2.8.1",
+        "typescript": "^5.9.3",
+        "typescript-eslint": "^8.46.2",
+        "vite": "^7.2.4",
+        "vite-plugin-dts": "^4.5.4"
+    }
+}