@oh-my-ghaad/core 0.0.1 → 0.0.2

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,124 @@
+# @oh-my-ghaad/core
+
+The core package provides the fundamental functionality for treating Git repositories as JSON databases. It handles the abstraction layer between your application and the Git platform adapters.
+
+## Overview
+
+The core package provides:
+
+- Collection management with Zod validation
+- Repository configuration and initialization
+- CRUD operations for JSON data
+- Subscription system for real-time updates
+- Adapter management for different Git platforms
+
+## Installation
+
+```bash
+npm install @oh-my-ghaad/core
+# or
+yarn add @oh-my-ghaad/core
+# or
+pnpm add @oh-my-ghaad/core
+```
+
+## Basic Usage
+
+```typescript
+import { Engine } from '@oh-my-ghaad/core';
+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: [/* your adapter */],
+  collections: [widgetsCollection],
+  appConfig: {
+    persisted: true
+  }
+});
+```
+
+## Key Concepts
+
+### Collections
+
+Collections are the primary way to organize and validate your data. Each collection:
+- Has a unique ID
+- Uses Zod for schema validation
+- Can be referenced by ID, singular name, or plural name
+- Stores data in a dedicated directory in the repository
+
+### Engine
+
+The Engine is the main interface for interacting with your Git-based database. It:
+- Manages adapters for different Git platforms
+- Handles collection operations
+- Provides real-time updates through subscriptions
+- Manages repository configuration
+
+### Adapters
+
+Adapters are responsible for platform-specific operations. The core package defines the interface that all adapters must implement. See the [main README](../../README.md) for available adapters.
+
+## API Reference
+
+### Engine
+
+```typescript
+class Engine {
+  constructor(config: {
+    adapters: (Adapter & IAdapter)[];
+    collections: Collection[];
+    appConfig: AppConfig;
+  });
+
+  // Collection Operations
+  addToCollection<T>(collectionId: string, data: T): Promise<T[]>;
+  updateInCollection<T>(collectionId: string, itemId: string, data: T): Promise<T[]>;
+  removeFromCollection<T>(collectionId: string, itemId: string): Promise<T[]>;
+  fetchCollectionItems<T>(collectionId: string): Promise<T[]>;
+  fetchCollectionItem<T>(collectionId: string, itemId: string): Promise<T | null>;
+
+  // Repository Management
+  initialize(): Promise<void>;
+  sync(): Promise<void>;
+  setRepoOwner(owner: string): void;
+  setRepoName(name: string): void;
+  setToken(token: string): void;
+
+  // Subscription
+  subscribe(callback: (collections: Collection[]) => void): void;
+  unsubscribe(callback: (collections: Collection[]) => void): void;
+}
+```
+
+## Related Packages
+
+- [@oh-my-ghaad/adapter-github](../adapter-github/README.md) - GitHub adapter implementation
+- [@oh-my-ghaad/react](../react/README.md) - React integration
+
+For more examples and detailed usage, see the [main README](../../README.md).

package/dist/index.d.cts

@@ -31,7 +31,7 @@ interface AdapterProps {
 }
 type Subscription = (collections: Collection[]) => void | Promise<void>;
 interface RepositoryResponse {
-    id: string;
+    id: string | number;
     org: string;
     name: string;
     url: string;

package/dist/index.d.ts

@@ -31,7 +31,7 @@ interface AdapterProps {
 }
 type Subscription = (collections: Collection[]) => void | Promise<void>;
 interface RepositoryResponse {
-    id: string;
+    id: string | number;
     org: string;
     name: string;
     url: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oh-my-ghaad/core",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "",
   "main": "dist/index.js",
   "type": "module",
@@ -18,6 +18,7 @@
   "scripts": {
     "dev": "tsup src/index.ts --watch --dts --format esm,cjs",
     "build": "tsup src/index.ts --dts --format esm,cjs",
+    "prepublish": "pnpm run build",
     "test": "echo \"Error: no test specified\" && exit 1"
   }
 }

package/src/types.ts

@@ -17,7 +17,7 @@ export interface AdapterProps {
 export type Subscription = (collections: Collection[]) => void | Promise<void>;
 
 export interface RepositoryResponse {
-  id: string;
+  id: string | number;
   org: string;
   name: string;
   url: string;