@instantdb/core 0.22.69 → 0.22.70

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instantdb/core",
-  "version": "0.22.69",
+  "version": "0.22.70",
   "description": "Instant's core local abstraction",
   "homepage": "https://github.com/instantdb/instant/tree/main/client/packages/core",
   "repository": {
@@ -53,7 +53,7 @@
   "dependencies": {
     "mutative": "^1.0.10",
     "uuid": "^11.1.0",
-    "@instantdb/version": "0.22.69"
+    "@instantdb/version": "0.22.70"
   },
   "scripts": {
     "test": "vitest",

package/src/Connection.ts

@@ -128,7 +128,7 @@ export class SSEConnection implements Connection<EventSourceType> {
   private sendQueue: any[] = [];
   private sendPromise: Promise<void> | null;
   private closeFired: boolean = false;
-  private sseInitTimeout: NodeJS.Timeout | null = null;
+  private sseInitTimeout: ReturnType<typeof setTimeout> | undefined = undefined;
   private ES: EventSourceConstructor;
   conn: EventSourceType;
   url: string;
@@ -203,9 +203,9 @@ export class SSEConnection implements Connection<EventSourceType> {
         method: 'POST',
         headers: { 'Content-Type': 'application/json' },
         body: JSON.stringify({
-          machine_id: this.initParams.machineId,
-          session_id: this.initParams.sessionId,
-          sse_token: this.initParams.sseToken,
+          machine_id: this.initParams?.machineId,
+          session_id: this.initParams?.sessionId,
+          sse_token: this.initParams?.sseToken,
           messages,
         }),
       });

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,
+  UseDates extends boolean | undefined,
 > = 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,
+  UseDates extends boolean | undefined,
 > = 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,
+  UseDates extends boolean | undefined,
 > {
   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,
+  UseDates extends boolean | undefined,
 > 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,
+  UseDates extends boolean | undefined,
 > 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,
+  UseDates extends boolean | undefined,
 > 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,
+  UseDates extends boolean | undefined,
 > 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,
+  UseDates extends boolean | undefined,
 > 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,
+  UseDates extends boolean | undefined,
 > =
   | 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,
+  UseDates extends boolean | undefined,
 > = (event: CallbackEvent<Schema, Q, UseDates>) => void;
 
 export class SyncTable {

package/src/devtool.ts

@@ -91,7 +91,7 @@ function createIframe(src: string) {
 }
 
 function createToggler(
-  config: DevtoolConfig,
+  config: StrictDevtoolConfig,
   onClick: (this: HTMLButtonElement, ev: MouseEvent) => any,
 ) {
   const logoSVG = `
@@ -150,7 +150,7 @@ function cssPositionForIframeContainer(position: DevtoolPosition) {
   }
 }
 
-function createIframeContainer(config: DevtoolConfig) {
+function createIframeContainer(config: StrictDevtoolConfig) {
   const element = document.createElement('div');
   Object.assign(element.style, {
     position: 'fixed',

package/src/helperTypes.ts

@@ -43,7 +43,9 @@ export type InstantQuery<DB extends IInstantDatabase<any>> =
  */
 export type InstantQueryResult<DB extends IInstantDatabase<any>, Q> =
   DB extends IInstantDatabase<infer Schema>
-    ? InstaQLResult<Schema, Remove$<Q>>
+    ? Q extends InstaQLParams<Schema> | undefined
+      ? InstaQLResult<Schema, Remove$<Q>>
+      : never
     : never;
 /**
  * @deprecated

package/src/index.ts

@@ -148,7 +148,7 @@ export type Config = {
 
 export type InstantConfig<
   S extends InstantSchemaDef<any, any, any>,
-  UseDates extends boolean = false,
+  UseDates extends boolean | undefined = false,
 > = {
   appId: string;
   schema?: S;
@@ -184,7 +184,7 @@ export type SubscribeTopic<PresenceShape, TopicsByKey> = <
 
 export type GetPresence<PresenceShape> = <Keys extends keyof PresenceShape>(
   opts: PresenceOpts<PresenceShape, Keys>,
-) => PresenceResponse<PresenceShape, Keys>;
+) => PresenceResponse<PresenceShape, Keys> | null;
 
 export type SubscribePresence<PresenceShape> = <
   Keys extends keyof PresenceShape,
@@ -212,7 +212,11 @@ type SubscriptionState<Q, Schema, WithCardinalityInference extends boolean> =
       pageInfo: PageInfoResponse<Q>;
     };
 
-type InstaQLSubscriptionState<Schema, Q, UseDates extends boolean> =
+type InstaQLSubscriptionState<
+  Schema,
+  Q,
+  UseDates extends boolean | undefined,
+> =
   | { error: { message: string }; data: undefined; pageInfo: undefined }
   | {
       error: undefined;
@@ -231,7 +235,7 @@ type LifecycleSubscriptionState<
 type InstaQLLifecycleState<
   Schema,
   Q,
-  UseDates extends boolean = false,
+  UseDates extends boolean | undefined = false,
 > = InstaQLSubscriptionState<Schema, Q, UseDates> & {
   isLoading: boolean;
 };
@@ -257,7 +261,7 @@ function initGlobalInstantCoreStore(): Record<string, any> {
   return globalThis.__instantDbStore;
 }
 
-function reactorKey(config: InstantConfig<any, boolean>): string {
+function reactorKey(config: InstantConfig<any, boolean | undefined>): string {
   // @ts-expect-error
   const adminToken = config.__adminToken;
   return (
@@ -519,7 +523,7 @@ function coerceQuery(o: any) {
 
 class InstantCoreDatabase<
   Schema extends InstantSchemaDef<any, any, any>,
-  UseDates extends boolean = false,
+  UseDates extends boolean | undefined = false,
 > implements IInstantDatabase<Schema>
 {
   public _reactor: Reactor<RoomsOf<Schema>>;
@@ -593,7 +597,7 @@ class InstantCoreDatabase<
    */
   subscribeQuery<
     Q extends ValidQuery<Q, Schema>,
-    UseDatesLocal extends boolean = UseDates,
+    UseDatesLocal extends boolean | undefined = UseDates,
   >(
     query: Q,
     cb: (resp: InstaQLSubscriptionState<Schema, Q, UseDatesLocal>) => void,
@@ -756,8 +760,9 @@ function schemaHash(schema?: InstantSchemaDef<any, any, any>): string {
     return '0';
   }
 
-  if (schemaHashStore.get(schema)) {
-    return schemaHashStore.get(schema);
+  const fromStore = schemaHashStore.get(schema);
+  if (fromStore) {
+    return fromStore;
   }
   const hash = weakHash(schema);
   schemaHashStore.set(schema, hash);
@@ -795,7 +800,7 @@ function schemaChanged(
  */
 function init<
   Schema extends InstantSchemaDef<any, any, any> = InstantUnknownSchema,
-  UseDates extends boolean = false,
+  UseDates extends boolean | undefined = false,
 >(
   config: InstantConfig<Schema, UseDates>,
   Storage?: any,
@@ -836,7 +841,10 @@ function init<
   return client;
 }
 
-function handleDevtool(appId: string, devtool: boolean | DevtoolConfig) {
+function handleDevtool(
+  appId: string,
+  devtool: boolean | DevtoolConfig | null | undefined,
+) {
   if (
     typeof window === 'undefined' ||
     typeof window.location === 'undefined' ||

package/src/queryTypes.ts

@@ -198,9 +198,11 @@ type QueryResponse<
     ? InstaQLQueryResult<E, Q, WithCardinalityInference, UseDates>
     : ResponseOf<{ [K in keyof Q]: Remove$<Q[K]> }, Schema>;
 
-type InstaQLResponse<Schema, Q, UseDates extends boolean = false> =
+type InstaQLResponse<Schema, Q, UseDates extends boolean | undefined = false> =
   Schema extends IContainEntitiesAndLinks<any, any>
-    ? InstaQLResult<Schema, Q, UseDates>
+    ? Q extends InstaQLParams<Schema> | undefined
+      ? InstaQLResult<Schema, Q, UseDates>
+      : never
     : never;
 
 type PageInfoResponse<T> = {
@@ -238,14 +240,28 @@ type Exactly<Parent, Child> = Parent & {
   [K in keyof Child]: K extends keyof Parent ? Child[K] : never;
 };
 
+// SafeLookup<T, ['A', 'B', number]> is like doing
+// T['A']['B'][number], but it will merge with undefined if any
+// of the intermediates are undefined
+type SafeLookup<T, K extends readonly PropertyKey[]> = K extends [
+  infer First,
+  ...infer Rest extends readonly PropertyKey[],
+]
+  ? First extends keyof NonNullable<T>
+    ?
+        | SafeLookup<NonNullable<T>[First], Rest>
+        | (T extends null | undefined ? undefined : never)
+    : undefined
+  : T;
+
 // ==========
 // InstaQL helpers
 
 type InstaQLEntitySubqueryResult<
   Schema extends IContainEntitiesAndLinks<EntitiesDef, any>,
   EntityName extends keyof Schema['entities'],
-  Query extends InstaQLEntitySubquery<Schema, EntityName> = {},
-  UseDates extends boolean = false,
+  Query extends InstaQLEntitySubquery<Schema, EntityName> | undefined = {},
+  UseDates extends boolean | undefined = false,
 > = {
   [QueryPropName in keyof Query]: Schema['entities'][EntityName]['links'][QueryPropName] extends LinkAttrDef<
     infer Cardinality,
@@ -257,16 +273,16 @@ type InstaQLEntitySubqueryResult<
             | InstaQLEntity<
                 Schema,
                 LinkedEntityName,
-                Remove$NonRecursive<Query[QueryPropName]>,
-                Query[QueryPropName]['$']['fields'],
+                Remove$NonRecursive<SafeLookup<Query, [QueryPropName]>>,
+                SafeLookup<Query, [QueryPropName, '$', 'fields']>,
                 UseDates
               >
             | undefined
         : InstaQLEntity<
             Schema,
             LinkedEntityName,
-            Remove$NonRecursive<Query[QueryPropName]>,
-            Query[QueryPropName]['$']['fields'],
+            Remove$NonRecursive<SafeLookup<Query, [QueryPropName]>>,
+            SafeLookup<Query, [QueryPropName, '$', 'fields']>,
             UseDates
           >[]
       : never
@@ -326,19 +342,24 @@ type InstaQLFields<
   K extends keyof S['entities'],
 > = (Extract<keyof ResolveEntityAttrs<S['entities'][K]>, string> | 'id')[];
 
+type ComputeAttrs<
+  AllAttrs,
+  Fields extends readonly string[] | undefined,
+> = Fields extends readonly string[]
+  ? DistributePick<AllAttrs, Exclude<Fields[number], 'id'>>
+  : AllAttrs;
+
 type InstaQLEntity<
   Schema extends IContainEntitiesAndLinks<EntitiesDef, any>,
   EntityName extends keyof Schema['entities'],
-  Subquery extends InstaQLEntitySubquery<Schema, EntityName> = {},
+  Subquery extends InstaQLEntitySubquery<Schema, EntityName> | undefined = {},
   Fields extends InstaQLFields<Schema, EntityName> | undefined = undefined,
-  UseDates extends boolean = false,
+  UseDates extends boolean | undefined = false,
 > = Expand<
-  { id: string } & (Extract<Fields[number], string> extends undefined
-    ? ResolveEntityAttrs<Schema['entities'][EntityName], UseDates>
-    : DistributePick<
-        ResolveEntityAttrs<Schema['entities'][EntityName], UseDates>,
-        Exclude<Fields[number], 'id'>
-      >) &
+  { id: string } & ComputeAttrs<
+    ResolveEntityAttrs<Schema['entities'][EntityName], UseDates>,
+    Fields
+  > &
     InstaQLEntitySubqueryResult<Schema, EntityName, Subquery, UseDates>
 >;
 
@@ -378,15 +399,15 @@ type InstaQLQueryResult<
 
 type InstaQLResult<
   Schema extends IContainEntitiesAndLinks<EntitiesDef, any>,
-  Query extends InstaQLParams<Schema>,
-  UseDates extends boolean = false,
+  Query extends InstaQLParams<Schema> | undefined,
+  UseDates extends boolean | undefined = false,
 > = Expand<{
   [QueryPropName in keyof Query]: QueryPropName extends keyof Schema['entities']
     ? InstaQLEntity<
         Schema,
         QueryPropName,
-        Remove$NonRecursive<Query[QueryPropName]>,
-        Query[QueryPropName]['$']['fields'],
+        Remove$NonRecursive<SafeLookup<Query, [QueryPropName]>>,
+        SafeLookup<Query, [QueryPropName, '$', 'fields']>,
         UseDates
       >[]
     : never;
@@ -601,15 +622,22 @@ type ValidWhereObject<
           Schema['entities'][EntityName]['attrs'][K]
         >;
       } & {
-        and?: Input extends { and: Array<infer Item> }
+        and?: Input extends {
+          and: Array<infer Item extends { [key: string]: any } | undefined>;
+        }
           ? ValidWhereObject<NoDistribute<Item>, Schema, EntityName>[]
           : never;
-        or?: Input extends { or: Array<infer Item> }
+        or?: Input extends {
+          or: Array<infer Item extends { [key: string]: any } | undefined>;
+        }
           ? ValidWhereObject<NoDistribute<Item>, Schema, EntityName>[]
           : never;
       } & {
         // Special case for id
-        id?: ValidWhereValue<Input['id'], DataAttrDef<string, false, false>>;
+        id?: ValidWhereValue<
+          SafeLookup<Input, ['id']>,
+          DataAttrDef<string, false, false>
+        >;
       }
     : never;
 
@@ -640,7 +668,7 @@ type ExtractAttrFromDotPath<
         : never;
 
 type ValidQuery<
-  Q extends object,
+  Q extends Record<string, any>,
   S extends IContainEntitiesAndLinks<any, any>,
 > = S extends InstantUnknownSchemaDef
   ? InstaQLParams<S>

package/src/queryValidation.ts

@@ -364,7 +364,7 @@ const validateWhereClause = (
 const validateDollarObject = (
   dollarObj: Record<string, unknown>,
   entityName: string,
-  schema?: IContainEntitiesAndLinks<any, any>,
+  schema?: IContainEntitiesAndLinks<any, any> | null | undefined,
   path?: string,
   depth: number = 0,
 ): void => {
@@ -414,7 +414,7 @@ const validateDollarObject = (
 const validateEntityInQuery = (
   queryPart: Record<string, unknown>,
   entityName: string,
-  schema: IContainEntitiesAndLinks<any, any>,
+  schema: IContainEntitiesAndLinks<any, any> | null | undefined,
   path: string,
   depth: number = 0,
 ): void => {

package/src/schemaTypes.ts

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

package/tsconfig.json

@@ -6,6 +6,7 @@
     "outDir": "dist/tsc",
     "rewriteRelativeImportExtensions": true,
     "rootDir": "src",
-    "checkJs": false
+    "checkJs": false,
+    "strictNullChecks": true
   }
 }