@indietabletop/appkit 6.1.2 → 6.1.4

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/lib/client.ts

@@ -5,7 +5,7 @@ import {
   redeemedPledge,
   sessionInfo,
   type FeatureUnlock,
-  type SpaceGits,
+  type UserGameData,
 } from "@indietabletop/types";
 import {
   array,
@@ -20,12 +20,6 @@ import {
 import { Failure, Success } from "./async-op.ts";
 import type { CurrentUser, FailurePayload, SessionInfo } from "./types.ts";
 
-export type UserGameData = {
-  spacegits?: {
-    gangs?: (SpaceGits.GangData | SpaceGits.GangTombstone)[];
-  };
-};
-
 export type GameCode = keyof UserGameData;
 
 export type ClientEventType = keyof ClientEventMap;

package/lib/store/index.tsx

@@ -1,8 +1,9 @@
+import type { UserGameData } from "@indietabletop/types";
 import { createActorContext } from "@xstate/react";
 import { createContext, useContext, useMemo, type ReactNode } from "react";
 import { fromCallback, fromPromise } from "xstate";
 import { Failure, Success } from "../async-op.ts";
-import type { GameCode, IndieTabletopClient, UserGameData } from "../client.ts";
+import type { GameCode, IndieTabletopClient } from "../client.ts";
 import type { ModernIDB } from "../ModernIDB/ModernIDB.ts";
 import type { ModernIDBIndexes, ModernIDBSchema } from "../ModernIDB/types.ts";
 import type { CurrentUser } from "../types.ts";

package/lib/store/utils.ts

@@ -1,16 +1,24 @@
+import type { UserGameData } from "@indietabletop/types";
 import { Failure } from "../async-op.js";
-import type { UserGameData } from "../client.ts";
 import type { FailurePayload } from "../types.ts";
 import type { SyncedItem } from "./types.ts";
 
 /**
  * Flattens the UserGameData structure to a flat SyncedItem[].
  */
-
 export function toSyncedItems(data: UserGameData) {
   return Object.values(data).flatMap((groups) => {
     return Object.values(groups).flatMap((items) => {
       return items.map((item): SyncedItem => {
+        if ("type" in item) {
+          return {
+            id: item.type,
+            name: item.type,
+            deleted: false,
+            updatedTs: item.updatedTs,
+          };
+        }
+
         return {
           id: item.id,
           name: item.name,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@indietabletop/appkit",
-  "version": "6.1.2",
+  "version": "6.1.4",
   "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"
   },
@@ -32,19 +34,19 @@
     "@storybook/addon-docs": "^10.1.11",
     "@storybook/addon-links": "^10.1.11",
     "@storybook/react-vite": "^10.1.11",
-    "@types/react": "^19.2.7",
+    "@types/react": "^19.2.8",
     "msw": "^2.12.7",
     "msw-storybook-addon": "^2.0.6",
     "np": "^10.2.0",
     "storybook": "^10.1.11",
     "typescript": "^5.9.3",
     "vite": "^7.3.1",
-    "vitest": "^4.0.16"
+    "vitest": "^4.0.17"
   },
   "dependencies": {
-    "@ariakit/react": "^0.4.20",
+    "@ariakit/react": "^0.4.21",
     "@indietabletop/tooling": "^5.2.0",
-    "@indietabletop/types": "^1.2.0",
+    "@indietabletop/types": "^1.3.0",
     "@vanilla-extract/css": "^1.18.0",
     "@vanilla-extract/dynamic": "^2.1.5",
     "@vanilla-extract/recipes": "^0.5.7",
@@ -61,5 +63,8 @@
       "public"
     ]
   },
+  "np": {
+    "testScript": "test:release"
+  },
   "packageManager": "npm@11.7.0+sha512.c22099a6fff8d5b2286c2a09df5352b4858a7c0c716320f58989d60ad8b29ecf2ce6fdfe97ccb41c23ffb1272e1fa079f868487dd6b81d02a2a9e199c095a117"
 }