@oh-my-ghaad/react 0.0.1 → 0.0.6

package/CHANGELOG.md

@@ -0,0 +1,29 @@
+## [0.0.6](https://github.com/cmgriffing/oh-my-ghaad/compare/v0.0.5...v0.0.6) (2025-10-04)
+
+
+
+## [0.0.5](https://github.com/cmgriffing/oh-my-ghaad/compare/v0.0.4...v0.0.5) (2025-10-04)
+
+
+
+## [0.0.4](https://github.com/cmgriffing/oh-my-ghaad/compare/v0.0.3...v0.0.4) (2025-10-04)
+
+
+
+## [0.0.3](https://github.com/cmgriffing/oh-my-ghaad/compare/v0.0.2...v0.0.3) (2025-10-04)
+
+
+
+## [0.0.2](https://github.com/cmgriffing/oh-my-ghaad/compare/v0.0.1...v0.0.2) (2025-10-04)
+
+
+
+## [0.0.1](https://github.com/cmgriffing/oh-my-ghaad/compare/46e2539da2b72e0d1f95ce739d19f5137a726adb...v0.0.1) (2025-10-04)
+
+
+### Features
+
+* bring demo-app up to functional and add mvp methods for engine ([46e2539](https://github.com/cmgriffing/oh-my-ghaad/commit/46e2539da2b72e0d1f95ce739d19f5137a726adb))
+
+
+

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2025 Chris Griffing
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,148 @@
+# @oh-my-ghaad/react
+
+React integration for Oh My GHAAD, providing a hook to easily use Git repositories as JSON databases in your React applications.
+
+## Overview
+
+The React package provides a `useGHaaD` hook that integrates the core Engine with React's state management system, allowing you to:
+- Access the Engine instance in your React components
+- Subscribe to Engine updates
+- Track repository status changes
+
+## Installation
+
+```bash
+npm install @oh-my-ghaad/react @oh-my-ghaad/core
+# or
+yarn add @oh-my-ghaad/react @oh-my-ghaad/core
+# or
+pnpm add @oh-my-ghaad/react @oh-my-ghaad/core
+```
+
+## Basic Usage
+
+```typescript
+import { Engine } from '@oh-my-ghaad/core';
+import { GithubAdapter } from '@oh-my-ghaad/adapter-github';
+import { useGHaaD } from '@oh-my-ghaad/react';
+import { useEffect, useState } from 'react';
+import { z } from 'zod';
+
+// Define your collection schema
+const widgetSchema = z.object({
+  id: z.string(),
+  name: z.string(),
+  type: z.enum(['gauge', 'chart', 'counter']),
+  config: z.object({
+    color: z.string(),
+    size: z.enum(['small', 'medium', 'large']),
+    enabled: z.boolean()
+  })
+});
+
+// Create a collection
+const widgetsCollection = {
+  id: 'widgets',
+  names: {
+    singular: 'widget',
+    plural: 'widgets',
+    path: 'widgets'
+  },
+  validator: widgetSchema,
+  idFunction: () => crypto.randomUUID()
+};
+
+// Create the engine instance
+const engine = new Engine({
+  adapters: [new GithubAdapter()],
+  collections: [widgetsCollection],
+  appConfig: {
+    persisted: true
+  }
+});
+
+// Use the hook in your component
+function WidgetsList() {
+  const { engine, repoStatus, lastUpdated } = useGHaaD(engine);
+  const [widgets, setWidgets] = useState<z.infer<typeof widgetSchema>[]>([]);
+  const [loading, setLoading] = useState(true);
+
+  // Fetch widgets when the component mounts or when lastUpdated changes
+  useEffect(() => {
+    async function fetchWidgets() {
+      try {
+        setLoading(true);
+        const items = await engine.fetchCollectionItems('widgets');
+        setWidgets(items);
+      } catch (error) {
+        console.error('Failed to fetch widgets:', error);
+      } finally {
+        setLoading(false);
+      }
+    }
+
+    fetchWidgets();
+  }, [lastUpdated]); // Re-fetch when the engine updates
+
+  if (loading) {
+    return <div>Loading widgets...</div>;
+  }
+
+  return (
+    <div>
+      <div>Repository Status: {repoStatus}</div>
+      {widgets.map(widget => (
+        <div key={widget.id}>
+          <h3>{widget.name}</h3>
+          <p>Type: {widget.type}</p>
+          <p>Size: {widget.config.size}</p>
+          <button
+            onClick={async () => {
+              try {
+                await engine.updateInCollection('widgets', widget.id, {
+                  ...widget,
+                  config: {
+                    ...widget.config,
+                    enabled: !widget.config.enabled
+                  }
+                });
+              } catch (error) {
+                console.error('Failed to update widget:', error);
+              }
+            }}
+          >
+            Toggle Enabled
+          </button>
+        </div>
+      ))}
+    </div>
+  );
+}
+```
+
+## API Reference
+
+### useGHaaD Hook
+
+```typescript
+function useGHaaD(
+  engine: Engine,
+  subscription?: Subscription
+): {
+  engine: Engine;
+  repoStatus: RepoStatus;
+  lastUpdated: number;
+}
+```
+
+The hook returns:
+- `engine`: The Engine instance
+- `repoStatus`: Current status of the repository
+- `lastUpdated`: Timestamp of the last update
+
+## Related Packages
+
+- [@oh-my-ghaad/core](../core/README.md) - Core functionality
+- [@oh-my-ghaad/adapter-github](../adapter-github/README.md) - GitHub adapter implementation
+
+For more examples and detailed usage, see the [main README](../../README.md) and the [demo app](../../apps/demo-app/README.md).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oh-my-ghaad/react",
-  "version": "0.0.1",
+  "version": "0.0.6",
   "description": "",
   "main": "dist/index.js",
   "type": "module",
@@ -15,7 +15,7 @@
   },
   "peerDependencies": {
     "react": ">= 18.0.0",
-    "@oh-my-ghaad/core": "0.0.1"
+    "@oh-my-ghaad/core": "0.0.6"
   },
   "scripts": {
     "dev": "tsup src/index.ts --watch --dts --format esm,cjs",