iodm 0.0.3 → 1.0.0-rc.0

package/README.md

@@ -1,4 +1,144 @@
-# iodm package
+# iodm
 
+`iodm` is an Object Data Modeling library for IndexedDB. It provides a schema-driven API for defining models, validating document shapes, and using IndexedDB as a persistent storage backend in browser applications.
 
-- [Documentation](./docs/pages/index.md)
+## Features
+
+- Schema-based model definition with primitives, arrays, references, dates, sets, maps, and virtuals
+- IndexedDB initialization utility with upgrade hooks
+- Model methods for insert, update, delete, find, and query operations
+- Plugin support for schema extensions and behaviors
+- Type-safe model definitions with TypeScript support
+
+## Install
+
+```bash
+npm install iodm
+```
+
+## Quick Start with React
+
+```tsx
+import React, { useEffect } from 'react';
+import iodm, { Schema, configureIDB } from 'iodm';
+
+interface User {
+  name?: string;
+  email: string;
+  age?: number;
+  isActive?: boolean;
+  createdAt?: Date;
+}
+
+const userSchema = new Schema<User>({
+  name: String,
+  email: { type: String, required: true },
+  age: { type: Number, min: 0 },
+  isActive: { type: Boolean, default: true },
+  createdAt: Date,
+});
+
+const UserModel = iodm.model('User', userSchema);
+
+const configurePromise = configureIDB({
+  db: 'MyAppDB',
+  version: 1,
+  models: [UserModel],
+});
+
+configurePromise.then(() => {
+  createRoot(document.getElementById('root')!).render(<App />);
+}).catch(() => {
+    createRoot(document.getElementById('root')!).render(<div>Error initializing database</div>);
+});
+```
+
+## Quick Start with TypeScript
+
+```ts
+import iodm, { Schema, configureIDB } from 'iodm';
+
+interface User {
+  name?: string;
+  email: string;
+  age?: number;
+  isActive?: boolean;
+  createdAt?: Date;
+}
+
+const userSchema = new Schema<User>({
+  name: String,
+  email: { type: String, required: true },
+  age: { type: Number, min: 0 },
+  isActive: { type: Boolean, default: true },
+  createdAt: Date,
+});
+
+const UserModel = iodm.model('User', userSchema);
+
+async function main() {
+  await configureIDB({
+    db: 'MyAppDB',
+    version: 1,
+    models: [UserModel],
+  });
+
+  const newUser = await UserModel.insertOne({
+    name: 'Alice',
+    email: 'alice@example.com',
+    age: 28,
+  });
+
+  console.log('Created user:', newUser);
+
+  const users = await UserModel.find({ isActive: true });
+  console.log('Active users:', users);
+
+  await UserModel.updateOne({ _id: newUser._id }, { age: 29 });
+  await UserModel.deleteOne({ _id: newUser._id });
+}
+
+main().catch(console.error);
+```
+
+## Model Definition
+
+Use `new Schema()` to define the structure of your documents. Primitive fields can be specified directly, or with a configuration object for validation and default values.
+
+```ts
+const productSchema = new Schema({
+  title: { type: String, required: true },
+  price: { type: Number, min: 0 },
+  tags: [String],
+  publishedAt: Date,
+});
+```
+
+## Database Configuration
+
+`configureIDB()` opens the browser IndexedDB database and initializes each model. Call it before using your models in the app.
+
+```ts
+import { configureIDB } from 'iodm';
+
+await configureIDB({
+  db: 'MyAppDB',
+  version: 1,
+  models: [UserModel],
+});
+```
+
+Optional hooks `onUpgradeNeededPre` and `onUpgradeNeededPost` can be supplied to run logic during database upgrades.
+
+## API
+
+### Exports
+
+- `default` / `Iodm` — default ODM instance for creating models and registering plugins
+- `Schema` — schema constructor for defining model structures
+- `configureIDB` — IndexedDB setup helper
+- `AbstractModel`, `AbstractModelClass` — base classes for advanced model use
+
+## Documentation
+
+Github [Documentation link](https://github.com/SanthoshKumar9028/idb-odm/blob/main/packages/iodm/docs/pages/iodm.md) for detailed API docs and advanced examples.

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "iodm",
-  "version": "0.0.3",
+  "version": "1.0.0-rc.0",
   "description": "Object Data Modeling library for IndexedDB",
   "main": "dist/index.es.js",
   "types": "dist/index.d.ts",
@@ -10,7 +10,8 @@
   ],
   "keywords": [
     "odm",
-    "indexeddb"
+    "indexeddb",
+    "browser"
   ],
   "author": "Santhoshkumar",
   "license": "MIT",
@@ -25,15 +26,17 @@
     "api:documenter": "api-documenter markdown --input-folder temp --output-folder docs/pages",
     "build:docs": "npm run api:extractor && npm run api:documenter",
     "lint": "eslint .",
-    "test": "vitest"
+    "test": "vitest --coverage.enabled --coverage.reporter=text",
+    "test:coverage": "vitest run --coverage"
   },
   "dependencies": {
-    "iodm-query": "0.0.6"
+    "iodm-query": "1.0.0-rc.0"
   },
   "devDependencies": {
     "@eslint/js": "^9.30.1",
     "@microsoft/api-documenter": "^7.26.29",
     "@microsoft/api-extractor": "^7.52.8",
+    "@vitest/coverage-v8": "^3.2.4",
     "eslint": "^9.30.1",
     "globals": "^16.3.0",
     "typescript": "~5.8.3",

package/dist/configure.d.ts

@@ -1,10 +0,0 @@
-import { IModel } from './model/types';
-interface ConfigureIndexedDBProps {
-    db: string;
-    version: number;
-    models: Array<IModel>;
-    onupgradeneeded?: (event: IDBOpenDBRequest) => any;
-}
-export declare const configureIDB: (config: ConfigureIndexedDBProps) => Promise<IDBDatabase>;
-export {};
-//# sourceMappingURL=configure.d.ts.map

package/dist/configure.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"configure.d.ts","sourceRoot":"","sources":["../src/configure.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAE5C,UAAU,uBAAuB;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACtB,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,gBAAgB,KAAK,GAAG,CAAC;CACpD;AAED,eAAO,MAAM,YAAY,GACvB,QAAQ,uBAAuB,KAC9B,OAAO,CAAC,WAAW,CAwBrB,CAAC"}

package/dist/index.d.ts

@@ -1,4 +0,0 @@
-export { AbstractModel, model } from './model/index';
-export { Schema } from './schema/index';
-export { configureIDB } from './configure';
-//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AACrD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AACxC,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC"}