use isRecord/isObject instead of manual checks wherever possible

Author: seefeldb

packages/builder/src/opaque-ref.ts

@@ -16,6 +16,7 @@ import { getTopFrame, recipe } from "./recipe.ts";
 import { createNodeFactory } from "./module.ts";
 import { SchemaWithoutCell } from "./schema-to-ts.ts";
 import { ContextualFlowControl } from "../../runner/src/index.ts";
+import { isRecord } from "@commontools/utils/types";
 
 let mapFactory: NodeFactory<any, any>;
 
@@ -110,8 +111,11 @@ export function opaqueRef<T>(
       unsafe_getExternal: () => {
         if (!unsafe_binding) return proxy;
         const value = unsafe_materialize(unsafe_binding, path);
-        if (typeof value === "object" && value !== null && value[toOpaqueRef]) {
-          return value[toOpaqueRef]();
+        if (
+          isRecord(value) && value[toOpaqueRef] &&
+          typeof value[toOpaqueRef] === "function"
+        ) {
+          return (value[toOpaqueRef] as () => OpaqueRef<any>)();
         } else return proxy;
       },
       map: <S>(

packages/builder/src/recipe.ts

@@ -31,6 +31,7 @@ import {
   traverseValue,
 } from "./utils.ts";
 import { SchemaWithoutCell } from "./schema-to-ts.ts";
+import { isRecord } from "@commontools/utils/types";
 
 /** Declare a recipe
  *
@@ -187,13 +188,11 @@ function factoryFromRecipe<T, R>(
   // Fill in reasonable names for all cells, where possible:
 
   // First from results
-  if (typeof outputs === "object" && outputs !== null) {
-    Object.entries(outputs).forEach(([key, value]) => {
-      if (
-        isOpaqueRef(value) && !value.export().path.length &&
-        !value.export().name
-      ) {
-        value.setName(key);
+  if (isRecord(outputs)) {
+    Object.entries(outputs).forEach(([key, value]: [string, unknown]) => {
+      if (isOpaqueRef(value)) {
+        const ref = value; // Typescript needs this to avoid type errors
+        if (!ref.export().path.length && !ref.export().name) ref.setName(key);
       }
     });
   }
@@ -202,7 +201,7 @@ function factoryFromRecipe<T, R>(
   cells.forEach((cell) => {
     if (cell.export().path.length) return;
     cell.export().nodes.forEach((node: NodeRef) => {
-      if (typeof node.inputs === "object" && node.inputs !== null) {
+      if (isRecord(node.inputs)) {
         Object.entries(node.inputs).forEach(([key, input]) => {
           if (
             isOpaqueRef(input) && input.cell === cell && !cell.export().name

packages/builder/src/types.ts

@@ -68,8 +68,9 @@ export type OpaqueRefMethods<T> = {
 
 export const isOpaqueRefMarker = Symbol("isOpaqueRef");
 
-export function isOpaqueRef(value: unknown): value is OpaqueRef<any> {
-  return !!value && typeof (value as any)[isOpaqueRefMarker] === "boolean";
+export function isOpaqueRef<T = any>(value: unknown): value is OpaqueRef<T> {
+  return !!value &&
+    typeof (value as OpaqueRef<T>)[isOpaqueRefMarker] === "boolean";
 }
 
 export type NodeRef = {
@@ -176,7 +177,8 @@ export type StreamAlias = {
 };
 
 export function isStreamAlias(value: unknown): value is StreamAlias {
-  return !!value && typeof (value as any).$stream === "boolean" && (value as any).$stream;
+  return !!value && typeof (value as StreamAlias).$stream === "boolean" &&
+    (value as StreamAlias).$stream;
 }
 
 export type Module = {
@@ -257,7 +259,8 @@ export function isShadowRef(value: unknown): value is ShadowRef {
     !!value &&
     typeof value === "object" &&
     "shadowOf" in value &&
-    (isOpaqueRef((value as any).shadowOf) || isShadowRef((value as any).shadowOf))
+    (isOpaqueRef((value as ShadowRef).shadowOf) ||
+      isShadowRef((value as ShadowRef).shadowOf))
   );
 }
 

packages/builder/src/utils.ts

@@ -27,6 +27,7 @@ import {
   isCellLink,
   isDoc,
 } from "@commontools/runner";
+import { isObject, isRecord } from "@commontools/utils/types";
 
 /**
  * Traverse a value, _not_ entering cells
@@ -52,8 +53,7 @@ export function traverseValue(
     (!isOpaqueRef(value) &&
       !canBeOpaqueRef(value) &&
       !isShadowRef(value) &&
-      typeof value === "object" &&
-      value !== null) ||
+      isRecord(value)) ||
     isRecipe(value)
   ) {
     return staticWrap(
@@ -105,7 +105,7 @@ export function getValueAtPath(obj: any, path: PropertyKey[]): any {
 export function hasValueAtPath(obj: any, path: PropertyKey[]): boolean {
   let current = obj;
   for (const key of path) {
-    if (!current || typeof current !== "object" || !(key in current)) {
+    if (!isRecord(current) || !(key in current)) {
       return false;
     }
     current = current[key];
@@ -115,7 +115,7 @@ export function hasValueAtPath(obj: any, path: PropertyKey[]): boolean {
 
 export const deepEqual = (a: any, b: any): boolean => {
   if (a === b) return true;
-  if (a && b && typeof a === "object" && typeof b === "object") {
+  if (isRecord(a) && isRecord(b)) {
     if (a.constructor !== b.constructor) return false;
     const keysA = Object.keys(a);
     const keysB = Object.keys(b);
@@ -211,7 +211,7 @@ export function toJSONWithAliases(
     );
   }
 
-  if (typeof value === "object" || isRecipe(value)) {
+  if (isRecord(value) || isRecipe(value)) {
     const result: any = {};
     let hasValue = false;
     for (const key in value as any) {
@@ -278,11 +278,11 @@ export function createJsonSchema(
             schema.items = {};
           } else {
             const first = value[0];
-            if (first && typeof first === "object" && !Array.isArray(first)) {
+            if (isObject(first)) {
               const properties: { [key: string]: any } = {};
               for (let i = 0; i < value.length; i++) {
                 const item = value?.[i];
-                if (typeof item === "object" && item !== null) {
+                if (isRecord(item)) {
                   Object.keys(item).forEach((key) => {
                     if (!(key in properties)) {
                       properties[key] = analyzeType(
@@ -426,7 +426,7 @@ function attachCfcToOutputs<T, R>(
     const cfcSchema: JSONSchema = { ...outputSchema, ifc };
     (outputs as OpaqueRef<T>).setSchema(cfcSchema);
     return;
-  } else if (typeof outputs === "object" && outputs !== null) {
+  } else if (isRecord(outputs)) {
     // Descend into objects and arrays
     for (const [key, value] of Object.entries(outputs)) {
       attachCfcToOutputs(value, cfc, lubClassification);

packages/runner/src/cell.ts

@@ -18,6 +18,7 @@ import {
 } from "./utils.ts";
 import type { ReactivityLog } from "./scheduler.ts";
 import { type EntityId } from "./doc-map.ts";
+import { isObject, isRecord } from "@commontools/utils/types";
 import { type Cancel, isCancel, useCancelGroup } from "./cancel.ts";
 import { validateAndTransform } from "./schema.ts";
 import { type Schema } from "@commontools/builder";
@@ -303,7 +304,7 @@ function createRegularCell<T>(
       ),
     send: (newValue: Cellify<T>) => self.set(newValue),
     update: (values: Cellify<Partial<T>>) => {
-      if (typeof values !== "object" || values === null) {
+      if (!isRecord(values)) {
         throw new Error("Can't update with non-object value");
       }
       for (const [key, value] of Object.entries(values)) {
@@ -331,9 +332,8 @@ function createRegularCell<T>(
       const valuesToWrite = values.map((value: any) => {
         if (
           !isCell(value) && !isCellLink(value) && !isDoc(value) &&
-          !Array.isArray(value) && typeof value === "object" &&
-          value !== null &&
-          value[ID] === undefined && getTopFrame()
+          isObject(value) &&
+          (value as { [ID]?: unknown })[ID] === undefined && getTopFrame()
         ) {
           return {
             [ID]: getTopFrame()!.generatedIdCounter++,
@@ -498,8 +498,7 @@ function subscribeToReferencedDocs<T>(
  * @returns {boolean}
  */
 export function isCell(value: any): value is Cell<any> {
-  return typeof value === "object" && value !== null &&
-    value[isCellMarker] === true;
+  return isRecord(value) && value[isCellMarker] === true;
 }
 
 const isCellMarker = Symbol("isCell");
@@ -510,8 +509,7 @@ const isCellMarker = Symbol("isCell");
  * @returns True if the value is a Stream
  */
 export function isStream(value: any): value is Stream<any> {
-  return typeof value === "object" && value !== null &&
-    value[isStreamMarker] === true;
+  return isRecord(value) && value[isStreamMarker] === true;
 }
 
 const isStreamMarker = Symbol("isStream");
@@ -524,7 +522,6 @@ const isStreamMarker = Symbol("isStream");
  */
 export function isCellLink(value: any): value is CellLink {
   return (
-    typeof value === "object" && value !== null && isDoc(value.cell) &&
-    Array.isArray(value.path)
+    isRecord(value) && isDoc(value.cell) && Array.isArray(value.path)
   );
 }

packages/runner/src/doc-map.ts

@@ -7,6 +7,7 @@ import {
 import { type CellLink, isCell, isCellLink } from "./cell.ts";
 import { refer } from "merkle-reference";
 import type { IDocumentMap, IRuntime } from "./runtime.ts";
+import { isRecord } from "@commontools/utils/types";
 
 export type EntityId = {
   "/": string | Uint8Array;
@@ -34,11 +35,11 @@ export function createRef(
     seen.add(obj);
 
     // Don't traverse into ids.
-    if (typeof obj === "object" && obj !== null && "/" in obj) return obj;
+    if (isRecord(obj) && "/" in obj) return obj;
 
     // If there is a .toJSON method, replace obj with it, then descend.
     if (
-      (typeof obj === "object" || typeof obj === "function") && obj !== null &&
+      isRecord(obj) &&
       typeof obj.toJSON === "function"
     ) {
       obj = obj.toJSON() ?? obj;
@@ -54,7 +55,7 @@ export function createRef(
     // If referencing other docs, return their ids (or random as fallback).
     if (isDoc(obj) || isCell(obj)) return obj.entityId ?? crypto.randomUUID();
     else if (Array.isArray(obj)) return obj.map(traverse);
-    else if (typeof obj === "object" && obj !== null) {
+    else if (isRecord(obj)) {
       return Object.fromEntries(
         Object.entries(obj).map(([key, value]) => [key, traverse(value)]),
       );
@@ -76,7 +77,7 @@ export function getEntityId(value: any): { "/": string } | undefined {
   if (typeof value === "string") {
     return value.startsWith("{") ? JSON.parse(value) : { "/": value };
   }
-  if (typeof value === "object" && value !== null && "/" in value) {
+  if (isRecord(value) && "/" in value) {
     return JSON.parse(JSON.stringify(value));
   }
 
@@ -225,7 +226,7 @@ export class DocumentMap implements IDocumentMap {
 
   private generateEntityId(value: any, cause?: any): EntityId {
     return createRef(
-      typeof value === "object" && value !== null
+      isRecord(value)
         ? (value as object)
         : value !== undefined
         ? { value }

packages/runner/src/doc.ts

@@ -18,6 +18,7 @@ import {
 import { type EntityId } from "./doc-map.ts";
 import type { IRuntime } from "./runtime.ts";
 import { type ReactivityLog } from "./scheduler.ts";
+import { isRecord } from "@commontools/utils/types";
 import { type Cancel } from "./cancel.ts";
 import { arrayEqual } from "./utils.ts";
 import { ContextualFlowControl } from "./index.ts";
@@ -422,8 +423,7 @@ export function makeOpaqueRef(
  * @returns {boolean}
  */
 export function isDoc(value: any): value is DocImpl<any> {
-  return typeof value === "object" && value !== null &&
-    value[isDocMarker] === true;
+  return isRecord(value) && value[isDocMarker] === true;
 }
 
 const isDocMarker = Symbol("isDoc");

packages/runner/src/query-result-proxy.ts

@@ -3,6 +3,7 @@ import { type DocImpl, makeOpaqueRef } from "./doc.ts";
 import { type CellLink } from "./cell.ts";
 import { type ReactivityLog } from "./scheduler.ts";
 import { diffAndUpdate, resolveLinkToValue, setNestedValue } from "./utils.ts";
+import { isRecord } from "@commontools/utils/types";
 
 // Array.prototype's entries, and whether they modify the array
 enum ArrayMethodType {
@@ -60,7 +61,7 @@ export function createQueryResultProxy<T>(
   log?.reads.push({ cell: valueCell, path: valuePath });
   const target = valueCell.getAtPath(valuePath) as any;
 
-  if (typeof target !== "object" || target === null) return target;
+  if (!isRecord(target)) return target;
 
   return new Proxy(target as object, {
     get: (target, prop, receiver) => {
@@ -199,7 +200,10 @@ export function createQueryResultProxy<T>(
           ) {
             log?.writes.push({ cell: valueCell, path: [...valuePath, i] });
             if (valueCell.runtime) {
-              valueCell.runtime.scheduler.queueEvent({ cell: valueCell, path: [...valuePath, i] }, undefined);
+              valueCell.runtime.scheduler.queueEvent({
+                cell: valueCell,
+                path: [...valuePath, i],
+              }, undefined);
             }
           }
         }
@@ -247,7 +251,7 @@ const createProxyForArrayValue = (
 };
 
 function isProxyForArrayValue(value: any): value is ProxyForArrayValue {
-  return typeof value === "object" && value !== null && originalIndex in value;
+  return isRecord(value) && originalIndex in value;
 }
 
 /**
@@ -280,8 +284,7 @@ export function getCellLinkOrThrow(value: any): CellLink {
  * @returns {boolean}
  */
 export function isQueryResult(value: any): value is QueryResult<any> {
-  return typeof value === "object" && value !== null &&
-    value[getCellLink] !== undefined;
+  return isRecord(value) && value[getCellLink] !== undefined;
 }
 
 const getCellLink = Symbol("isQueryResultProxy");

packages/runner/src/runner.ts

@@ -38,6 +38,7 @@ import { type CellLink, isCell, isCellLink } from "./cell.ts";
 import { isQueryResultForDereferencing } from "./query-result-proxy.ts";
 import { getCellLinkOrThrow } from "./query-result-proxy.ts";
 import type { IRunner, IRuntime } from "./runtime.ts";
+import { isRecord } from "@commontools/utils/types";
 
 const moduleWrappers = {
   handler: (fn: (event: any, ...props: any[]) => any) => (props: any) =>
@@ -289,7 +290,7 @@ export class Runner implements IRunner {
       if (link && link.cell) {
         const maybePromise = this.runtime.storage.syncCell(link.cell);
         if (maybePromise instanceof Promise) promises.add(maybePromise);
-      } else if (typeof value === "object" && value !== null) {
+      } else if (isRecord(value)) {
         for (const key in value) syncAllMentionedCells(value[key]);
       }
     };