@indietabletop/appkit 6.1.2 → 6.1.3

package/lib/ModernIDB/types.ts

@@ -17,42 +17,81 @@ export type ModernIDBIndexes<Schema extends ModernIDBSchema> = {
   [K in keyof Schema]?: string;
 };
 
-export type VersionChangeHandler<
+export type VersionChangeHandlerProps<
   Schema extends ModernIDBSchema,
-  IndexNames extends {
-    [K in keyof Schema]?: string;
-  },
-> = (props: {
+  IndexNames extends ModernIDBIndexes<Schema>,
+> = {
   event: IDBVersionChangeEvent;
   manager: VersionChangeManager<Schema, IndexNames>;
   db: ModernIDB<Schema, IndexNames>;
-}) => void;
+};
 
-export type BlockingHandler<
+export type VersionChangeHandler<
+  Schema extends ModernIDBSchema,
+  IndexNames extends ModernIDBIndexes<Schema>,
+> = (props: VersionChangeHandlerProps<Schema, IndexNames>) => void;
+
+export type BlockingHandlerProps<
   Schema extends ModernIDBSchema,
-  IndexNames extends {
-    [K in keyof Schema]?: string;
-  },
-> = (props: {
+  IndexNames extends ModernIDBIndexes<Schema>,
+> = {
   event: IDBVersionChangeEvent;
   db: ModernIDB<Schema, IndexNames>;
-}) => void;
+};
+
+export type BlockingHandler<
+  Schema extends ModernIDBSchema,
+  IndexNames extends ModernIDBIndexes<Schema>,
+> = (props: BlockingHandlerProps<Schema, IndexNames>) => void;
 
 export type OpenRequestHandlers<
   Schema extends ModernIDBSchema,
-  IndexNames extends {
-    [K in keyof Schema]?: string;
-  },
+  IndexNames extends ModernIDBIndexes<Schema>,
 > = {
   /**
-   * If error is thrown inside the `onInit` handler, the version change
-   * transaction will be aborted.
+   * Called when the database is initialized from scratch.
+   *
+   * Should be used to set up all required stores and indexes.
+   *
+   * If error is thrown in this handler, the version change transaction will
+   * be aborted.
+   *
+   * @example
+   *
+   * ```ts
+   * onInit({ manager }) {
+   *   const store = manager.createObjectStore("items", { keyPath: "id" });
+   *   store.createIndex("createdTs", "createdTs");
+   *
+   *   console.info("DB initialized.");
+   * },
+   * ```
    */
   onInit?: VersionChangeHandler<Schema, IndexNames>;
 
   /**
-   * If error is thrown inside the `onUpgrade` handler, the version change
-   * transaction will be aborted.
+   * Called when there is an existing IDB database present, but is is of a lower
+   * version than the latest.
+   *
+   * If error is thrown inside this handler, the version change transaction
+   * will be aborted.
+   *
+   * @example
+   * ```ts
+   * onUpgrade({ manager, event }) {
+   *  switch (event.oldVersion) {
+   *    case 1: {
+   *      // We need a `settings` store in v2, but it did't exist in v1
+   *      const store = manager.createObjectStore("settings", { keyPath: "id" });
+   *      store.createIndex("createdTs", "createdTs");
+   *    }
+   *
+   *    default: {
+   *      console.info(`Migration from DB v${event.oldVersion} complete.`);
+   *    }
+   *   }
+   * }
+   * ```
    */
   onUpgrade?: VersionChangeHandler<Schema, IndexNames>;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@indietabletop/appkit",
-  "version": "6.1.2",
+  "version": "6.1.3",
   "description": "A collection of modules used in apps built by Indie Tabletop Club",
   "private": false,
   "type": "module",
@@ -8,7 +8,9 @@
     "release": "np",
     "build": "tsc",
     "dev": "tsc --watch",
-    "test": "vitest",
+    "test": "vitest run",
+    "test:dev": "vitest watch",
+    "test:release": "npm run test && npm run typecheck",
     "storybook": "storybook dev",
     "typecheck": "tsc --noEmit"
   },
@@ -61,5 +63,8 @@
       "public"
     ]
   },
+  "np": {
+    "testScript": "test:release"
+  },
   "packageManager": "npm@11.7.0+sha512.c22099a6fff8d5b2286c2a09df5352b4858a7c0c716320f58989d60ad8b29ecf2ce6fdfe97ccb41c23ffb1272e1fa079f868487dd6b81d02a2a9e199c095a117"
 }