@instantdb/core 0.22.75 → 0.22.76

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instantdb/core",
-  "version": "0.22.75",
+  "version": "0.22.76",
   "description": "Instant's core local abstraction",
   "homepage": "https://github.com/instantdb/instant/tree/main/client/packages/core",
   "repository": {
@@ -53,12 +53,13 @@
   "dependencies": {
     "mutative": "^1.0.10",
     "uuid": "^11.1.0",
-    "@instantdb/version": "0.22.75"
+    "@instantdb/version": "0.22.76"
   },
   "scripts": {
     "test": "vitest",
     "bench": "vitest bench",
-    "test:ci": "vitest run",
+    "test:types": "tsc -p tsconfig.test.json --noEmit",
+    "test:ci": "vitest run && pnpm run test:types",
     "bench:ci": "vitest bench --run",
     "check": "tsc --noEmit",
     "check-exports": "attw --pack .",

package/src/Connection.ts

@@ -36,7 +36,7 @@ type SendMessageData = {
 
 type MsgEvent<T extends Conn> = {
   target: Connection<T>;
-  message: MessageData;
+  message: MessageData | MessageData[];
 };
 
 type CloseEvent<T extends Conn> = {
@@ -152,24 +152,13 @@ export class SSEConnection implements Connection<EventSourceType> {
     }, 10000);
 
     this.conn.onmessage = (e) => {
-      const msg = JSON.parse(e.data);
-      if (msg.op === 'sse-init') {
-        this.initParams = {
-          machineId: msg['machine-id'],
-          sessionId: msg['session-id'],
-          sseToken: msg['sse-token'],
-        };
-        if (this.onopen) {
-          this.onopen({ target: this });
+      const message = JSON.parse(e.data);
+      if (Array.isArray(message)) {
+        for (const msg of message) {
+          this.handleMessage(msg);
         }
-        clearTimeout(this.sseInitTimeout);
-        return;
-      }
-      if (this.onmessage) {
-        this.onmessage({
-          target: this,
-          message: msg,
-        });
+      } else {
+        this.handleMessage(message);
       }
     };
 
@@ -178,6 +167,27 @@ export class SSEConnection implements Connection<EventSourceType> {
     };
   }
 
+  private handleMessage(msg: MessageData) {
+    if (msg.op === 'sse-init') {
+      this.initParams = {
+        machineId: msg['machine-id'],
+        sessionId: msg['session-id'],
+        sseToken: msg['sse-token'],
+      };
+      if (this.onopen) {
+        this.onopen({ target: this });
+      }
+      clearTimeout(this.sseInitTimeout);
+      return;
+    }
+    if (this.onmessage) {
+      this.onmessage({
+        target: this,
+        message: msg,
+      });
+    }
+  }
+
   // Runs the onerror and closes the connection
   private handleError() {
     try {

package/src/Reactor.js

@@ -1500,7 +1500,13 @@ export default class Reactor {
     }
     // Try to reconnect via websocket the next time we connect
     this._transportType = 'ws';
-    this._handleReceive(targetTransport.id, e.message);
+    if (Array.isArray(e.message)) {
+      for (const msg of e.message) {
+        this._handleReceive(targetTransport.id, msg);
+      }
+    } else {
+      this._handleReceive(targetTransport.id, e.message);
+    }
   };
 
   _transportOnError = (e) => {

package/src/SyncTable.ts

@@ -309,7 +309,7 @@ export enum CallbackEventType {
 type QueryEntities<
   Schema extends IContainEntitiesAndLinks<EntitiesDef, any>,
   Q extends ValidQuery<Q, Schema>,
-  UseDates extends boolean | undefined,
+  UseDates extends boolean,
 > = InstaQLResponse<Schema, Q, UseDates>[keyof InstaQLResponse<
   Schema,
   Q,
@@ -319,7 +319,7 @@ type QueryEntities<
 type QueryEntity<
   Schema extends IContainEntitiesAndLinks<EntitiesDef, any>,
   Q extends ValidQuery<Q, Schema>,
-  UseDates extends boolean | undefined,
+  UseDates extends boolean,
 > = QueryEntities<Schema, Q, UseDates> extends (infer E)[] ? E : never;
 
 type ChangedFields<Entity> = {
@@ -332,7 +332,7 @@ type ChangedFields<Entity> = {
 export interface BaseCallbackEvent<
   Schema extends IContainEntitiesAndLinks<EntitiesDef, any>,
   Q extends ValidQuery<Q, Schema>,
-  UseDates extends boolean | undefined,
+  UseDates extends boolean,
 > {
   type: CallbackEventType;
   data: InstaQLResponse<Schema, Q, UseDates>;
@@ -341,7 +341,7 @@ export interface BaseCallbackEvent<
 export interface InitialSyncBatch<
   Schema extends IContainEntitiesAndLinks<EntitiesDef, any>,
   Q extends ValidQuery<Q, Schema>,
-  UseDates extends boolean | undefined,
+  UseDates extends boolean,
 > extends BaseCallbackEvent<Schema, Q, UseDates> {
   type: CallbackEventType.InitialSyncBatch;
   batch: QueryEntities<Schema, Q, UseDates>;
@@ -350,7 +350,7 @@ export interface InitialSyncBatch<
 export interface InitialSyncComplete<
   Schema extends IContainEntitiesAndLinks<EntitiesDef, any>,
   Q extends ValidQuery<Q, Schema>,
-  UseDates extends boolean | undefined,
+  UseDates extends boolean,
 > extends BaseCallbackEvent<Schema, Q, UseDates> {
   type: CallbackEventType.InitialSyncComplete;
 }
@@ -358,7 +358,7 @@ export interface InitialSyncComplete<
 export interface SyncTransaction<
   Schema extends IContainEntitiesAndLinks<EntitiesDef, any>,
   Q extends ValidQuery<Q, Schema>,
-  UseDates extends boolean | undefined,
+  UseDates extends boolean,
 > extends BaseCallbackEvent<Schema, Q, UseDates> {
   type: CallbackEventType.SyncTransaction;
   added: QueryEntities<Schema, Q, UseDates>;
@@ -373,7 +373,7 @@ export interface SyncTransaction<
 export interface LoadFromStorage<
   Schema extends IContainEntitiesAndLinks<EntitiesDef, any>,
   Q extends ValidQuery<Q, Schema>,
-  UseDates extends boolean | undefined,
+  UseDates extends boolean,
 > extends BaseCallbackEvent<Schema, Q, UseDates> {
   type: CallbackEventType.LoadFromStorage;
 }
@@ -381,7 +381,7 @@ export interface LoadFromStorage<
 export interface SetupError<
   Schema extends IContainEntitiesAndLinks<EntitiesDef, any>,
   Q extends ValidQuery<Q, Schema>,
-  UseDates extends boolean | undefined,
+  UseDates extends boolean,
 > extends BaseCallbackEvent<Schema, Q, UseDates> {
   type: CallbackEventType.Error;
   error: { message: string; hint?: any; type: string; status: number };
@@ -390,7 +390,7 @@ export interface SetupError<
 export type CallbackEvent<
   Schema extends IContainEntitiesAndLinks<EntitiesDef, any>,
   Q extends ValidQuery<Q, Schema>,
-  UseDates extends boolean | undefined,
+  UseDates extends boolean,
 > =
   | InitialSyncBatch<Schema, Q, UseDates>
   | InitialSyncComplete<Schema, Q, UseDates>
@@ -401,7 +401,7 @@ export type CallbackEvent<
 export type SyncTableCallback<
   Schema extends IContainEntitiesAndLinks<EntitiesDef, any>,
   Q extends ValidQuery<Q, Schema>,
-  UseDates extends boolean | undefined,
+  UseDates extends boolean,
 > = (event: CallbackEvent<Schema, Q, UseDates>) => void;
 
 export class SyncTable {

package/{__tests__/src → src/__types__}/fieldsTypeTest.ts

@@ -1,4 +1,4 @@
-import { i, init } from '../../src/index.ts';
+import { i, init } from '../index.ts';
 import type { Equal, Expect, NotAny } from './typeUtils.ts';
 
 // These tests just check types. See `type _cases = ` for the test cases.

package/src/__types__/typeUtils.ts

@@ -0,0 +1,39 @@
+// Type testing utils from
+// https://github.com/type-challenges/type-challenges/blob/main/utils/index.d.ts
+
+export type Expect<T extends true> = T;
+export type ExpectTrue<T extends true> = T;
+export type ExpectFalse<T extends false> = T;
+export type IsTrue<T extends true> = T;
+export type IsFalse<T extends false> = T;
+
+export type Equal<X, Y> =
+  (<T>() => T extends X ? 1 : 2) extends <T>() => T extends Y ? 1 : 2
+    ? true
+    : false;
+export type NotEqual<X, Y> = true extends Equal<X, Y> ? false : true;
+
+// https://stackoverflow.com/questions/49927523/disallow-call-with-any/49928360#49928360
+export type IsAny<T> = 0 extends 1 & T ? true : false;
+export type NotAny<T> = true extends IsAny<T> ? false : true;
+
+export type Debug<T> = { [K in keyof T]: T[K] };
+export type MergeInsertions<T> = T extends object
+  ? { [K in keyof T]: MergeInsertions<T[K]> }
+  : T;
+
+export type Alike<X, Y> = Equal<MergeInsertions<X>, MergeInsertions<Y>>;
+
+export type ExpectExtends<VALUE, EXPECTED> = EXPECTED extends VALUE
+  ? true
+  : false;
+export type ExpectValidArgs<
+  FUNC extends (...args: any[]) => any,
+  ARGS extends any[],
+> = ARGS extends Parameters<FUNC> ? true : false;
+
+export type UnionToIntersection<U> = (
+  U extends any ? (k: U) => void : never
+) extends (k: infer I) => void
+  ? I
+  : never;

package/{__tests__/src → src/__types__}/useDatesTypeTest.ts

@@ -1,6 +1,5 @@
-import { i, init } from '../../src/index.ts';
+import { i, init } from '../index.ts';
 import type { Equal, Expect, NotAny } from './typeUtils.ts';
-
 // These tests just check types. See `type _cases = ` for the test cases.
 
 const schema = i.schema({

package/src/clientTypes.ts

@@ -14,7 +14,7 @@ export type AuthResult =
 export type AuthState =
   | { isLoading: true; error: undefined; user: undefined }
   | { isLoading: false; error: { message: string }; user: undefined }
-  | { isLoading: false; error: undefined; user: User | null };
+  | { isLoading: false; error: undefined; user: User | null | undefined };
 
 export type ConnectionStatus =
   | 'connecting'

package/src/index.ts

@@ -142,13 +142,13 @@ export type Config = {
   devtool?: boolean | DevtoolConfig;
   verbose?: boolean;
   queryCacheLimit?: number;
-  useDateObjects?: boolean;
+  useDateObjects: boolean;
   disableValidation?: boolean;
 };
 
 export type InstantConfig<
   S extends InstantSchemaDef<any, any, any>,
-  UseDates extends boolean | undefined = false,
+  UseDates extends boolean = false,
 > = {
   appId: string;
   schema?: S;
@@ -157,7 +157,7 @@ export type InstantConfig<
   devtool?: boolean | DevtoolConfig;
   verbose?: boolean;
   queryCacheLimit?: number;
-  useDateObjects?: UseDates;
+  useDateObjects: UseDates;
   disableValidation?: boolean;
 };
 
@@ -212,11 +212,7 @@ type SubscriptionState<Q, Schema, WithCardinalityInference extends boolean> =
       pageInfo: PageInfoResponse<Q>;
     };
 
-type InstaQLSubscriptionState<
-  Schema,
-  Q,
-  UseDates extends boolean | undefined,
-> =
+type InstaQLSubscriptionState<Schema, Q, UseDates extends boolean> =
   | { error: { message: string }; data: undefined; pageInfo: undefined }
   | {
       error: undefined;
@@ -232,13 +228,16 @@ type LifecycleSubscriptionState<
   isLoading: boolean;
 };
 
-type InstaQLLifecycleState<
-  Schema,
-  Q,
-  UseDates extends boolean | undefined = false,
-> = InstaQLSubscriptionState<Schema, Q, UseDates> & {
-  isLoading: boolean;
-};
+type InstaQLLifecycleState<Schema, Q, UseDates extends boolean = false> =
+  | (InstaQLSubscriptionState<Schema, Q, UseDates> & {
+      isLoading: boolean;
+    })
+  | {
+      isLoading: true;
+      data: undefined;
+      pageInfo: undefined;
+      error: undefined;
+    };
 
 type UnsubscribeFn = () => void;
 
@@ -261,7 +260,7 @@ function initGlobalInstantCoreStore(): Record<string, any> {
   return globalThis.__instantDbStore;
 }
 
-function reactorKey(config: InstantConfig<any, boolean | undefined>): string {
+function reactorKey(config: InstantConfig<any, boolean>): string {
   // @ts-expect-error
   const adminToken = config.__adminToken;
   return (
@@ -523,7 +522,7 @@ function coerceQuery(o: any) {
 
 class InstantCoreDatabase<
   Schema extends InstantSchemaDef<any, any, any>,
-  UseDates extends boolean | undefined = false,
+  UseDates extends boolean = false,
 > implements IInstantDatabase<Schema>
 {
   public _reactor: Reactor<RoomsOf<Schema>>;
@@ -597,7 +596,7 @@ class InstantCoreDatabase<
    */
   subscribeQuery<
     Q extends ValidQuery<Q, Schema>,
-    UseDatesLocal extends boolean | undefined = UseDates,
+    UseDatesLocal extends boolean = UseDates,
   >(
     query: Q,
     cb: (resp: InstaQLSubscriptionState<Schema, Q, UseDatesLocal>) => void,
@@ -800,21 +799,29 @@ function schemaChanged(
  */
 function init<
   Schema extends InstantSchemaDef<any, any, any> = InstantUnknownSchema,
-  UseDates extends boolean | undefined = false,
+  UseDates extends boolean = false,
 >(
-  config: InstantConfig<Schema, UseDates>,
+  // Allows config with missing `useDateObjects`, but keeps `UseDates`
+  // as a non-nullable in the InstantConfig type.
+  config: Omit<InstantConfig<Schema, UseDates>, 'useDateObjects'> & {
+    useDateObjects?: UseDates;
+  },
   Storage?: any,
   NetworkListener?: any,
   versions?: { [key: string]: string },
   EventSourceImpl?: any,
 ): InstantCoreDatabase<Schema, UseDates> {
+  const configStrict = {
+    ...config,
+    useDateObjects: (config.useDateObjects ?? false) as UseDates,
+  };
   const existingClient = globalInstantCoreStore[
-    reactorKey(config)
-  ] as InstantCoreDatabase<any, Config['useDateObjects']>;
+    reactorKey(configStrict)
+  ] as InstantCoreDatabase<any, UseDates>;
 
   if (existingClient) {
-    if (schemaChanged(existingClient, config.schema)) {
-      existingClient._reactor.updateSchema(config.schema);
+    if (schemaChanged(existingClient, configStrict.schema)) {
+      existingClient._reactor.updateSchema(configStrict.schema);
     }
     return existingClient;
   }
@@ -822,8 +829,8 @@ function init<
   const reactor = new Reactor<RoomsOf<Schema>>(
     {
       ...defaultConfig,
-      ...config,
-      cardinalityInference: config.schema ? true : false,
+      ...configStrict,
+      cardinalityInference: configStrict.schema ? true : false,
     },
     Storage || IndexedDBStorage,
     NetworkListener || WindowNetworkListener,
@@ -831,12 +838,10 @@ function init<
     EventSourceImpl,
   );
 
-  const client = new InstantCoreDatabase<any, Config['useDateObjects']>(
-    reactor,
-  );
-  globalInstantCoreStore[reactorKey(config)] = client;
+  const client = new InstantCoreDatabase<any, UseDates>(reactor);
+  globalInstantCoreStore[reactorKey(configStrict)] = client;
 
-  handleDevtool(config.appId, config.devtool);
+  handleDevtool(configStrict.appId, configStrict.devtool);
 
   return client;
 }

package/src/queryTypes.ts

@@ -198,7 +198,7 @@ type QueryResponse<
     ? InstaQLQueryResult<E, Q, WithCardinalityInference, UseDates>
     : ResponseOf<{ [K in keyof Q]: Remove$<Q[K]> }, Schema>;
 
-type InstaQLResponse<Schema, Q, UseDates extends boolean | undefined = false> =
+type InstaQLResponse<Schema, Q, UseDates extends boolean = false> =
   Schema extends IContainEntitiesAndLinks<any, any>
     ? Q extends InstaQLParams<Schema> | undefined
       ? InstaQLResult<Schema, Q, UseDates>
@@ -261,7 +261,7 @@ type InstaQLEntitySubqueryResult<
   Schema extends IContainEntitiesAndLinks<EntitiesDef, any>,
   EntityName extends keyof Schema['entities'],
   Query extends InstaQLEntitySubquery<Schema, EntityName> | undefined = {},
-  UseDates extends boolean | undefined = false,
+  UseDates extends boolean = false,
 > = {
   [QueryPropName in keyof Query]: Schema['entities'][EntityName]['links'][QueryPropName] extends LinkAttrDef<
     infer Cardinality,
@@ -354,7 +354,7 @@ type InstaQLEntity<
   EntityName extends keyof Schema['entities'],
   Subquery extends InstaQLEntitySubquery<Schema, EntityName> | undefined = {},
   Fields extends InstaQLFields<Schema, EntityName> | undefined = undefined,
-  UseDates extends boolean | undefined = false,
+  UseDates extends boolean = false,
 > = Expand<
   { id: string } & ComputeAttrs<
     ResolveEntityAttrs<Schema['entities'][EntityName], UseDates>,
@@ -400,7 +400,7 @@ type InstaQLQueryResult<
 type InstaQLResult<
   Schema extends IContainEntitiesAndLinks<EntitiesDef, any>,
   Query extends InstaQLParams<Schema> | undefined,
-  UseDates extends boolean | undefined = false,
+  UseDates extends boolean = false,
 > = Expand<{
   [QueryPropName in keyof Query]: QueryPropName extends keyof Schema['entities']
     ? InstaQLEntity<

package/src/schemaTypes.ts

@@ -302,10 +302,7 @@ type OptionalKeys<Attrs extends AttrsDefs> = {
  *   - Required keys => `key: ValueType`
  *   - Optional keys => `key?: ValueType`
  */
-type MappedAttrs<
-  Attrs extends AttrsDefs,
-  UseDates extends boolean | undefined,
-> = {
+type MappedAttrs<Attrs extends AttrsDefs, UseDates extends boolean> = {
   [K in RequiredKeys<Attrs>]: Attrs[K] extends DataAttrDef<infer V, any, any>
     ? V extends Date
       ? UseDates extends true
@@ -325,7 +322,7 @@ type MappedAttrs<
 
 export type ResolveEntityAttrs<
   EDef extends EntityDef<any, any, any>,
-  UseDates extends boolean | undefined = false,
+  UseDates extends boolean = false,
   ResolvedAttrs = MappedAttrs<EDef['attrs'], UseDates>,
 > =
   EDef extends EntityDef<any, any, infer AsType>

package/tsconfig.json

@@ -1,7 +1,7 @@
 {
   "extends": "../../tsconfig.base.json",
   "include": ["src"],
-  "exclude": ["node_modules", "dist"],
+  "exclude": ["node_modules", "dist", "src/__types__"],
   "compilerOptions": {
     "outDir": "dist/tsc",
     "rewriteRelativeImportExtensions": true,

package/tsconfig.test.json

@@ -0,0 +1,5 @@
+{
+  "extends": "./tsconfig.json",
+  "include": ["src", "src/__types__"],
+  "exclude": ["node_modules", "dist"]
+}