@instantdb/admin 0.22.75 → 0.22.76

package/src/index.ts

@@ -109,7 +109,7 @@ export type InstantConfig<
   adminToken?: string;
   apiURI?: string;
   schema?: Schema;
-  useDateObjects?: UseDates;
+  useDateObjects: UseDates;
   disableValidation?: boolean;
 };
 
@@ -167,7 +167,7 @@ function withImpersonation(
 
 function validateConfigAndImpersonation(
   config: FilledConfig,
-  impersonationOpts: ImpersonationOpts,
+  impersonationOpts: ImpersonationOpts | undefined,
 ) {
   if (
     impersonationOpts &&
@@ -254,7 +254,7 @@ async function jsonFetch(
 ): Promise<any> {
   const defaultFetchOpts = getDefaultFetchOpts();
   const headers = {
-    ...(init.headers || {}),
+    ...(init?.headers || {}),
     'Instant-Admin-Version': version,
     'Instant-Core-Version': coreVersion,
   };
@@ -297,11 +297,22 @@ function init<
   Schema extends InstantSchemaDef<any, any, any> = InstantUnknownSchema,
   UseDates extends boolean = false,
 >(
-  config: InstantConfig<Schema, UseDates>,
-): InstantAdminDatabase<Schema, InstantConfig<Schema, UseDates>> {
-  return new InstantAdminDatabase<Schema, InstantConfig<Schema, UseDates>>(
-    config,
-  );
+  // Allows config with missing `useDateObjects`, but keeps `UseDates`
+  // as a non-nullable in the InstantConfig type.
+  config: Omit<InstantConfig<Schema, UseDates>, 'useDateObjects'> & {
+    useDateObjects?: UseDates;
+  },
+): InstantAdminDatabase<Schema, UseDates, InstantConfig<Schema, UseDates>> {
+  const configStrict = {
+    ...config,
+    useDateObjects: (config.useDateObjects ?? false) as UseDates,
+  };
+
+  return new InstantAdminDatabase<
+    Schema,
+    UseDates,
+    InstantConfig<Schema, UseDates>
+  >(configStrict);
 }
 
 /**
@@ -680,12 +691,12 @@ class Storage {
       duplex = 'half'; // one-way stream
     }
     if (isNodeReadable(file) || isWebReadable(file)) {
-      headers['content-length'] = metadata.fileSize.toString();
       if (!metadata.fileSize) {
         throw new Error(
           'fileSize is required in metadata when uploading streams',
         );
       }
+      headers['content-length'] = metadata.fileSize.toString();
     }
 
     let options = {
@@ -752,12 +763,15 @@ class Storage {
         }),
       },
     );
+    const headers = {};
+    const contentType = metadata.contentType;
+    if (contentType) {
+      headers['Content-Type'] = contentType;
+    }
     const { ok } = await fetch(presignedUrl, {
       method: 'PUT',
       body: file as unknown as BodyInit,
-      headers: {
-        'Content-Type': metadata.contentType,
-      },
+      headers,
     });
 
     return ok;
@@ -823,9 +837,13 @@ type AdminQueryOpts = {
  */
 class InstantAdminDatabase<
   Schema extends InstantSchemaDef<any, any, any>,
-  Config extends InstantConfig<Schema, boolean> = InstantConfig<Schema, false>,
+  UseDates extends boolean = false,
+  Config extends InstantConfig<Schema, UseDates> = InstantConfig<
+    Schema,
+    UseDates
+  >,
 > {
-  config: InstantConfigFilled<Schema, Config['useDateObjects']>;
+  config: InstantConfigFilled<Schema, UseDates>;
   auth: Auth;
   storage: Storage;
   rooms: Rooms<Schema>;
@@ -849,8 +867,10 @@ class InstantAdminDatabase<
    * @example
    *  await db.asUser({email: "stopa@instantdb.com"}).query({ goals: {} })
    */
-  asUser = (opts: ImpersonationOpts): InstantAdminDatabase<Schema, Config> => {
-    const newClient = new InstantAdminDatabase<Schema, Config>({
+  asUser = (
+    opts: ImpersonationOpts,
+  ): InstantAdminDatabase<Schema, UseDates, Config> => {
+    const newClient = new InstantAdminDatabase<Schema, UseDates, Config>({
       ...(this.config as Config),
     });
     newClient.impersonationOpts = opts;
@@ -876,7 +896,7 @@ class InstantAdminDatabase<
   query = <Q extends ValidQuery<Q, Schema>>(
     query: Q,
     opts: AdminQueryOpts = {},
-  ): Promise<InstaQLResponse<Schema, Q, Config['useDateObjects']>> => {
+  ): Promise<InstaQLResponse<Schema, Q, UseDates>> => {
     if (query && opts && 'ruleParams' in opts) {
       query = { $$ruleParams: opts['ruleParams'], ...query };
     }
@@ -938,9 +958,9 @@ class InstantAdminDatabase<
    */
   subscribeQuery<Q extends ValidQuery<Q, Schema>>(
     query: Q,
-    cb?: SubscribeQueryCallback<Schema, Q, Config>,
+    cb?: SubscribeQueryCallback<Schema, Q, UseDates>,
     opts: AdminQueryOpts = {},
-  ): SubscribeQueryResponse<Schema, Q, Config> {
+  ): SubscribeQueryResponse<Schema, Q, UseDates> {
     if (query && opts && 'ruleParams' in opts) {
       query = { $$ruleParams: opts['ruleParams'], ...query };
     }
@@ -1030,7 +1050,7 @@ class InstantAdminDatabase<
     query: Q,
     opts?: { rules?: any; ruleParams?: { [key: string]: any } },
   ): Promise<{
-    result: InstaQLResponse<Schema, Q, Config['useDateObjects']>;
+    result: InstaQLResponse<Schema, Q, UseDates>;
     checkResults: DebugCheckResult[];
   }> => {
     if (query && opts && 'ruleParams' in opts) {

package/src/subscribe.ts

@@ -21,12 +21,12 @@ export type SubscribeQuerySessionInfo = {
 export type SubscribeQueryPayload<
   Schema extends InstantSchemaDef<any, any, any>,
   Q extends ValidQuery<Q, Schema>,
-  Config extends InstantConfig<Schema, boolean> = InstantConfig<Schema, false>,
+  UseDates extends boolean = false,
 > =
   | {
       type: 'ok';
-      data: InstaQLResponse<Schema, Q, Config['useDateObjects']>;
-      pageInfo: PageInfoResponse<Q>;
+      data: InstaQLResponse<Schema, Q, UseDates>;
+      pageInfo: PageInfoResponse<Q> | undefined;
       sessionInfo: SubscribeQuerySessionInfo | null;
     }
   | {
@@ -40,13 +40,13 @@ export type SubscribeQueryPayload<
 export type SubscribeQueryCallback<
   Schema extends InstantSchemaDef<any, any, any>,
   Q extends ValidQuery<Q, Schema>,
-  Config extends InstantConfig<Schema, boolean> = InstantConfig<Schema, false>,
-> = (payload: SubscribeQueryPayload<Schema, Q, Config>) => void;
+  UseDates extends boolean = false,
+> = (payload: SubscribeQueryPayload<Schema, Q, UseDates>) => void;
 
 export interface SubscribeQueryResponse<
   Schema extends InstantSchemaDef<any, any, any>,
   Q extends ValidQuery<Q, Schema>,
-  Config extends InstantConfig<Schema, boolean> = InstantConfig<Schema, false>,
+  UseDates extends boolean = false,
 > {
   /** Stop the subscription and close the connection. */
   close(): void;
@@ -56,7 +56,7 @@ export interface SubscribeQueryResponse<
 
   /** Async iterator of query payloads */
   [Symbol.asyncIterator](): AsyncIterableIterator<
-    SubscribeQueryPayload<Schema, Q, Config>
+    SubscribeQueryPayload<Schema, Q, UseDates>
   >;
 
   /** Ready state of the connection */
@@ -72,19 +72,19 @@ export interface SubscribeQueryResponse<
 function makeAsyncIterator<
   Schema extends InstantSchemaDef<any, any, any>,
   Q extends ValidQuery<Q, Schema>,
-  Config extends InstantConfig<Schema, boolean> = InstantConfig<Schema, false>,
+  UseDates extends boolean = false,
 >(
-  subscribe: (cb: SubscribeQueryCallback<Schema, Q, Config>) => void,
+  subscribe: (cb: SubscribeQueryCallback<Schema, Q, UseDates>) => void,
   subscribeOnClose: (cb: () => void) => void,
-  unsubscribe: (cb: SubscribeQueryCallback<Schema, Q, Config>) => void,
+  unsubscribe: (cb: SubscribeQueryCallback<Schema, Q, UseDates>) => void,
   readyState: () => SubscriptionReadyState,
-): AsyncGenerator<SubscribeQueryPayload<Schema, Q, Config>> {
-  let wakeup = null;
+): AsyncGenerator<SubscribeQueryPayload<Schema, Q, UseDates>> {
+  let wakeup: (() => void) | null = null;
   let closed = false;
 
-  const backlog: SubscribeQueryPayload<Schema, Q, Config>[] = [];
-  const handler: SubscribeQueryCallback<Schema, Q, Config> = (
-    data: SubscribeQueryPayload<Schema, Q, Config>,
+  const backlog: SubscribeQueryPayload<Schema, Q, UseDates>[] = [];
+  const handler: SubscribeQueryCallback<Schema, Q, UseDates> = (
+    data: SubscribeQueryPayload<Schema, Q, UseDates>,
   ): void => {
     backlog.push(data);
     if (backlog.length > 100) {
@@ -102,7 +102,10 @@ function makeAsyncIterator<
 
   subscribe(handler);
 
-  const done = () => {
+  const done = (): Promise<{
+    done: true;
+    value: undefined;
+  }> => {
     unsubscribe(handler);
     return Promise.resolve({ done: true, value: undefined });
   };
@@ -117,7 +120,9 @@ function makeAsyncIterator<
 
   subscribeOnClose(onClose);
 
-  const next = async () => {
+  const next = async (): Promise<
+    IteratorResult<SubscribeQueryPayload<Schema, Q, UseDates>, undefined>
+  > => {
     while (true) {
       if (readyState() === 'closed' || closed) {
         return done();
@@ -128,7 +133,7 @@ function makeAsyncIterator<
         return { value: nextValue, done: false };
       }
 
-      const p = new Promise((resolve) => {
+      const p = new Promise<void>((resolve) => {
         wakeup = resolve;
       });
 
@@ -160,11 +165,13 @@ function esReadyState(es: EventSource): SubscriptionReadyState {
     case es.OPEN: {
       return 'open';
     }
+    default:
+      return 'connecting';
   }
 }
 
-function multiReadFetchResponse(r) {
-  let p = null;
+function multiReadFetchResponse(r: Response) {
+  let p: null | Promise<string> = null;
   return {
     ...r,
     text() {
@@ -214,12 +221,12 @@ function formatPageInfo(
 export function subscribe<
   Schema extends InstantSchemaDef<any, any, any>,
   Q extends ValidQuery<Q, Schema>,
-  Config extends InstantConfig<Schema, boolean> = InstantConfig<Schema, false>,
+  UseDates extends boolean,
 >(
   query: Q,
-  cb,
+  cb: SubscribeQueryCallback<Schema, Q, UseDates> | undefined,
   opts: { headers: HeadersInit; inference: boolean; apiURI: string },
-): SubscribeQueryResponse<Schema, Q, Config> {
+): SubscribeQueryResponse<Schema, Q, UseDates> {
   let fetchErrorResponse;
   let closed = false;
 
@@ -254,8 +261,8 @@ export function subscribe<
     },
   );
 
-  const subscribers: SubscribeQueryCallback<Schema, Q, Config>[] = [];
-  const onCloseSubscribers = [];
+  const subscribers: SubscribeQueryCallback<Schema, Q, UseDates>[] = [];
+  const onCloseSubscribers: (() => void)[] = [];
 
   const subscribe = (cb) => {
     subscribers.push(cb);
@@ -275,7 +282,7 @@ export function subscribe<
 
   let sessionParams: SubscribeQuerySessionInfo | null = null;
 
-  function deliver(result: SubscribeQueryPayload<Schema, Q, Config>) {
+  function deliver(result: SubscribeQueryPayload<Schema, Q, UseDates>) {
     if (closed) {
       return;
     }

package/tsconfig.json

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

package/tsconfig.test.json

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