Nullify data in types

Author: kossnocorp

Diff for: .gitignore

@@ -7,4 +7,4 @@ firestore-debug.log
 firebase-debug.log
 .firebaserc
 /tmp
-/.ts
+.ts

Diff for: .vscode/settings.json

@@ -1,24 +1,7 @@
 {
   "typescript.tsdk": "node_modules/typescript/lib",
   "workbench.colorCustomizations": {
-    "activityBar.activeBackground": "#1a8cad",
-    "activityBar.activeBorder": "#f3ace3",
-    "activityBar.background": "#1a8cad",
-    "activityBar.foreground": "#e7e7e7",
-    "activityBar.inactiveForeground": "#e7e7e799",
-    "activityBarBadge.background": "#f3ace3",
-    "activityBarBadge.foreground": "#15202b",
-    "sash.hoverBorder": "#1a8cad",
-    "statusBar.background": "#136881",
-    "statusBar.foreground": "#e7e7e7",
-    "statusBarItem.hoverBackground": "#1a8cad",
-    "statusBarItem.remoteBackground": "#136881",
-    "statusBarItem.remoteForeground": "#e7e7e7",
-    "titleBar.activeBackground": "#136881",
-    "titleBar.activeForeground": "#e7e7e7",
-    "titleBar.inactiveBackground": "#13688199",
-    "titleBar.inactiveForeground": "#e7e7e799",
-    "commandCenter.border": "#e7e7e799"
+    "activityBar.activeBorder": "#f3ace3"
   },
   "peacock.remoteColor": "#136881",
   "editor.formatOnSave": true,

Diff for: src/index.ts

@@ -1,4 +1,5 @@
 import type { TypesaurusCore as Core } from "./types/core";
+import type { TypesaurusUtils as Utils } from "./types/utils";
 
 export * from "./transaction";
 export * from "./groups";
@@ -7,6 +8,13 @@ export * from "./helpers";
 
 export declare const schema: Core.Function;
 
+/**
+ * Deeply adds null to all undefined values. It's useful for wrapping
+ * your types when you expect data from Firestore where undefined values turn
+ * into nulls.
+ */
+export type Nullify<Type> = Core.Nullify<Type>;
+
 export namespace Typesaurus {
   /**
    * Infers schema types. Useful to define function arguments that accept

Diff for: src/types/core.ts

@@ -515,6 +515,11 @@ export namespace TypesaurusCore {
   export type Data<
     Model extends ModelObjectType,
     DateMissing extends ServerDateMissing,
+  > = DataNullified<Nullify<Model>, DateMissing>;
+
+  export type DataNullified<
+    Model extends ModelObjectType,
+    DateMissing extends ServerDateMissing,
   > = {
     [Key in keyof Model]: DataField<Model[Key], DateMissing>;
   };
@@ -608,7 +613,12 @@ export namespace TypesaurusCore {
    * Type of the data passed to write functions. It extends the model allowing
    * to set special values, sucha as server date, increment, etc.
    */
-  export type WriteData<Model, Props extends DocProps> = {
+  export type WriteData<Model, Props extends DocProps> = WriteDataNullified<
+    Nullify<Model>,
+    Props
+  >;
+
+  export type WriteDataNullified<Model, Props extends DocProps> = {
     [Key in keyof Model]: WriteField<Model, Key, Props>;
   };
 
@@ -1549,4 +1559,27 @@ export namespace TypesaurusCore {
     /** The client app name. It takes priority over the root's app name. */
     app?: string;
   }
+
+  /**
+   * Deeply adds null to all undefined values.
+   */
+  export type Nullify<Type> =
+    // First we extract null and undefined
+    Type extends null | undefined
+      ? Type | null
+      : // Now we extract as-is types
+        Type extends string | number | boolean | Date | ServerDate | Ref<any>
+        ? Type
+        : // Now extract array types
+          Type extends Array<infer Item>
+          ? Array<Nullify<Item>>
+          : // Now extract object types
+            Type extends object
+            ? {
+                [Key in keyof Type]: // If field is optionally undefined, exclude undefined before nullifing the rest
+                Utils.ActuallyUndefined<Type, Key> extends true
+                  ? Nullify<Type[Key]>
+                  : Nullify<Exclude<Type[Key], undefined>>;
+              }
+            : never;
 }

Diff for: src/types/update.ts

@@ -1,5 +1,6 @@
 import type { TypesaurusUtils as Utils } from "./utils.js";
 import type { TypesaurusCore as Core } from "./core.js";
+import { Nullify } from "../index.js";
 
 export namespace TypesaurusUpdate {
   export interface CollectionFunction<Def extends Core.DocDef> {
@@ -79,6 +80,11 @@ export namespace TypesaurusUpdate {
   export type Data<
     Model extends Core.ModelObjectType,
     Props extends Core.DocProps,
+  > = DataNullified<Core.Nullify<Model>, Props>;
+
+  export type DataNullified<
+    Model extends Core.ModelObjectType,
+    Props extends Core.DocProps,
   > = {
     [Key in keyof Model]?: Core.WriteField<Model, Key, Props>;
   };
@@ -97,13 +103,15 @@ export namespace TypesaurusUpdate {
   export interface Helpers<
     Model extends Core.ModelObjectType,
     Props extends Core.DocProps,
-  > extends CommonHelpers<Model, Props, UpdateField<Model>> {}
+  > extends CommonHelpers<Nullify<Model>, Props, UpdateField<Model>> {}
 
   export interface Builder<Def extends Core.DocDef, Props extends Core.DocProps>
     extends CommonHelpers<
-      Def["Flags"]["Reduced"] extends true
-        ? Core.IntersectVariableModelType<Def["Model"]>
-        : Core.SharedVariableModelType<Def["WideModel"]>,
+      Core.Nullify<
+        Def["Flags"]["Reduced"] extends true
+          ? Core.IntersectVariableModelType<Def["Model"]>
+          : Core.SharedVariableModelType<Def["WideModel"]>
+      >,
       Props,
       void
     > {

Diff for: src/types/utils.ts

@@ -70,7 +70,10 @@ export namespace TypesaurusUtils {
    * and values.
    */
   export type AllRequired<Model> = {
-    [Key in keyof Required<Model>]-?: Exclude<Required<Model>[Key], undefined>;
+    [Key in keyof Required<Model>]-?: Exclude<
+      Required<Model>[Key],
+      undefined | null
+    >;
   };
 
   /**
@@ -85,6 +88,15 @@ export namespace TypesaurusUtils {
       : true
     : false;
 
+  /**
+   * Resolves true if the passed field is undefined union and not optionally
+   * undefined.
+   */
+  export type ActuallyUndefined<
+    Model,
+    Key extends keyof Model,
+  > = undefined extends Required<Model>[Key] ? true : false;
+
   /**
    * Resolves true if all sibling fields in the passed model are optional.
    */
@@ -2238,7 +2250,11 @@ export namespace TypesaurusUtils {
   export type WholeOrEmpty<Type> = Type | { [Key in keyof Type]?: undefined };
 
   /**
-   * Resolves true if the strictNullChecks is set to true in the tsconfig.
+   * Checks if exactOptionalPropertyTypes is enabled or not
    */
-  export type StrictNullChecksEnabled = true; // null extends undefined ? false : true
+  export type ExactOptionalPropertyTypesEnabled = {
+    test: undefined;
+  } extends { test?: boolean }
+    ? false
+    : true;
 }

Diff for: src/tysts/batch.ts

@@ -189,13 +189,13 @@ async function tysts() {
   }));
 
   $.accounts.update(db.accounts.id("sasha"), ($) =>
-    $.field("nested1Optional").set($.remove())
+    $.field("nested1Optional").set($.remove()),
   );
 
   // Single field update
 
   $.accounts.update(db.accounts.id("sasha"), ($) =>
-    $.field("name").set("Alexander")
+    $.field("name").set("Alexander"),
   );
 
   // Multiple fields update
@@ -208,68 +208,68 @@ async function tysts() {
   // Nested fields
 
   $.accounts.update(db.accounts.id("sasha"), ($) =>
-    $.field("contacts", "phone").set("+65xxxxxxxx")
+    $.field("contacts", "phone").set("+65xxxxxxxx"),
   );
 
   $.accounts.update(db.accounts.id("sasha"), ($) =>
     $.field("contacts", "phone")
       // @ts-expect-error - wrong type
-      .set(6500000000)
+      .set(6500000000),
   );
 
   $.accounts.update(db.accounts.id("sasha"), ($) =>
     // @ts-expect-error - can't update because emergencyContacts can be undefined
-    $.field("emergencyContacts", "phone").set("+65xxxxxxxx")
+    $.field("emergencyContacts", "phone").set("+65xxxxxxxx"),
   );
 
   $.accounts.update(db.accounts.id("sasha"), ($) =>
     // @ts-expect-error - emergencyContacts must have name and phone
     $.field("emergencyContacts").set({
       name: "Sasha",
-    })
+    }),
   );
 
   $.accounts.update(db.accounts.id("sasha"), ($) =>
     $.field("emergencyContacts").set({
       name: "Sasha",
       phone: "+65xxxxxxxx",
-    })
+    }),
   );
 
   // Deeply nested field corner cases
 
   $.accounts.update(db.accounts.id("sasha"), ($) =>
     $.field("nested1Required", "nested12Required").set({
       hello: "Hello!",
-    })
+    }),
   );
 
   $.accounts.update(db.accounts.id("sasha"), ($) =>
     $.field("nested1Required", "nested12Required").set({
       hello: "Hello!",
       world: "World!",
-    })
+    }),
   );
 
   $.accounts.update(db.accounts.id("sasha"), ($) =>
     // @ts-expect-error - can't update without hello
     $.field("nested1Required", "nested12Required").set({
       world: "World!",
-    })
+    }),
   );
 
   $.accounts.update(db.accounts.id("sasha"), ($) =>
     // @ts-expect-error - should not update because requried12 on nested1Optional is required
     $.field("nested1Optional", "nested12Optional").set({
       hello: "Hello!",
-    })
+    }),
   );
 
   $.accounts.update(db.accounts.id("sasha"), ($) =>
     // @ts-expect-error - nested1Optional has required12, so can't update
     $.field("nested1Optional", "nested12Optional").set({
       world: "World!",
-    })
+    }),
   );
 
   // Updating variable collection
@@ -289,22 +289,22 @@ async function tysts() {
 
   $.content.update(contentId, ($) =>
     // @ts-expect-error - can't update non-shared variable model fields
-    $.field("type").set("text")
+    $.field("type").set("text"),
   );
 
   // Nested fields with records
 
   const postId = Math.random().toString();
 
   $.accounts.update(db.accounts.id("sasha"), ($) =>
-    $.field("counters").set({ [postId]: { likes: 5 } })
+    $.field("counters").set({ [postId]: { likes: 5 } }),
   );
 
   $.accounts.update(db.accounts.id("sasha"), ($) =>
-    $.field("counters", postId).set({ likes: 5 })
+    $.field("counters", postId).set({ likes: 5 }),
   );
 
   $.accounts.update(db.accounts.id("sasha"), ($) =>
-    $.field("counters", postId, "likes").set($.increment(1))
+    $.field("counters", postId, "likes").set($.increment(1)),
   );
 }