iodm 0.0.4 → 1.0.0-rc.1

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/dist/configure.d.ts

@@ -1,11 +1,59 @@
 import { IModel } from './model/types';
-interface ConfigureIndexedDBProps {
+export interface ConfigureIndexedDBProps {
     db: string;
     version: number;
     models: Array<IModel<any, any, any>>;
     onUpgradeNeededPre?: (event: IDBOpenDBRequest) => any;
     onUpgradeNeededPost?: (event: IDBOpenDBRequest) => any;
 }
+/**
+ * Configures the IndexedDB database to be used by the models.
+ * This function should be called before using any models to ensure that the database is properly set up.
+ *
+ * @example
+ * ```ts
+ * import { createRoot } from 'react-dom/client';
+ * import { configureIDB } from 'iodm';
+ * import UserModel from './models/UserModel';
+ * import App from './App';
+ *
+ * const config = {
+ *   db: 'MyDB',
+ *   version: 1,
+ *   models: [UserModel],
+ * };
+ *
+ * configureIDB(config).then((db) => {
+ *   createRoot(document.getElementById('app')!).render(<App />);
+ * }).catch((error) => {
+ *   createRoot(document.getElementById('app')!).render(<div>Error configuring database</div>);
+ * });
+ * ```
+ *
+ * @example
+ * ```ts
+ * // Using the returned promise directly in a React component with Suspense
+ * import { use } from 'react';
+ * import { configureIDB } from 'iodm';
+ * import UserModel from './models/UserModel';
+ *
+ * const config = {
+ *   db: 'MyDB',
+ *   version: 1,
+ *   models: [UserModel],
+ * };
+ *
+ * const dbPromise = configureIDB(config);
+ *
+ * function App() {
+ *    use(dbPromise);
+ *
+ *   // rest of the app
+ * }
+ * ```
+ *
+ * @param config - The configuration object for setting up the IndexedDB database. It includes the name and version of the database, the models to be used, and optional callbacks for handling the upgrade process.
+ * @returns A promise that resolves to the configured IDBDatabase instance once the database is successfully opened and configured.
+ */
 export declare const configureIDB: (config: ConfigureIndexedDBProps) => Promise<IDBDatabase>;
-export {};
 //# sourceMappingURL=configure.d.ts.map

package/dist/configure.d.ts.map

@@ -1 +1 @@
-{"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,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;IACrC,kBAAkB,CAAC,EAAE,CAAC,KAAK,EAAE,gBAAgB,KAAK,GAAG,CAAC;IACtD,mBAAmB,CAAC,EAAE,CAAC,KAAK,EAAE,gBAAgB,KAAK,GAAG,CAAC;CACxD;AAED,eAAO,MAAM,YAAY,GACvB,QAAQ,uBAAuB,KAC9B,OAAO,CAAC,WAAW,CA2BrB,CAAC"}
+{"version":3,"file":"configure.d.ts","sourceRoot":"","sources":["../src/configure.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAE5C,MAAM,WAAW,uBAAuB;IACtC,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;IACrC,kBAAkB,CAAC,EAAE,CAAC,KAAK,EAAE,gBAAgB,KAAK,GAAG,CAAC;IACtD,mBAAmB,CAAC,EAAE,CAAC,KAAK,EAAE,gBAAgB,KAAK,GAAG,CAAC;CACxD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,eAAO,MAAM,YAAY,GACvB,QAAQ,uBAAuB,KAC9B,OAAO,CAAC,WAAW,CA2BrB,CAAC"}

package/dist/index.d.ts

@@ -1,4 +1,10 @@
-export { AbstractModel, model } from './model/index';
-export { Schema } from './schema/index';
+export type { QueryFindOptions, QueryExecutorGetCommonOptions, QueryFindByIdAndUpdateOptions, QueryOpenCursorOptions, QueryDeleteOneOptions, QueryFindByIdOptions, QueryFindByIdAndDeleteOptions, QueryInsertOneOptions, QueryReplaceOneOptions, QueryUpdateManyOptions, QueryUpdateOneOptions, QueryDeleteManyOptions, QueryCountDocumentsOptions, QueryExecutorUpdateManyUpdater, QueryRootFilter } from 'iodm-query';
+export type { SchemaDefinition, BroadcastEnabledEventsOptions, FindMiddlewareContext, InjectFunctionContext, PluginFn, SchemaDefinitionValue, SchemaMethodOptions, SchemaOptions, SchemaSaveMethodOptions, SchemaDefinitionDateValue, SchemaDefinitionNumberValue, SchemaDefinitionStringValue, } from './schema/types.ts';
+export type { IModel, ModelInstance, ModelOptions, ModelSaveOptions, } from './model/types';
+export type { ConfigureIndexedDBProps } from './configure';
+export { default, Iodm } from './iodm';
 export { configureIDB } from './configure';
+export { AbstractModel, AbstractModelClass } from './model/index';
+export { default as CustomMiddlewareExecutor } from './schema/custom-middleware-executor';
+export { Schema } from './schema/index';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"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"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACR,gBAAgB,EAChB,6BAA6B,EAC7B,6BAA6B,EAC7B,sBAAsB,EACtB,qBAAqB,EACrB,oBAAoB,EACpB,6BAA6B,EAC7B,qBAAqB,EACrB,sBAAsB,EACtB,sBAAsB,EACtB,qBAAqB,EACrB,sBAAsB,EACtB,0BAA0B,EAC1B,8BAA8B,EAC9B,eAAe,EAClB,MAAM,YAAY,CAAC;AACpB,YAAY,EACR,gBAAgB,EAChB,6BAA6B,EAC7B,qBAAqB,EACrB,qBAAqB,EACrB,QAAQ,EACR,qBAAqB,EACrB,mBAAmB,EACnB,aAAa,EACb,uBAAuB,EACvB,yBAAyB,EACzB,2BAA2B,EAC3B,2BAA2B,GAC9B,MAAM,mBAAmB,CAAC;AAC3B,YAAY,EACR,MAAM,EACN,aAAa,EACb,YAAY,EACZ,gBAAgB,GACnB,MAAM,eAAe,CAAC;AACvB,YAAY,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAC;AAE3D,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAClE,OAAO,EAAE,OAAO,IAAI,wBAAwB,EAAE,MAAM,qCAAqC,CAAC;AAC1F,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC"}