@dxos/util 0.7.4 → 0.7.5-feature-compute.4d9d99a

package/src/disposition.ts

@@ -0,0 +1,30 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+/**
+ * Determines priority order.
+ *
+ * - `static` - Remain in natural order.
+ * - `hoist` - Placed before `static`.
+ * - `fallback` - Placed after `static`.
+ */
+export type Disposition = 'static' | 'hoist' | 'fallback';
+
+/**
+ * Sorting function for sorting by disposition.
+ */
+export const byDisposition = <T extends { disposition?: Disposition }>(a: T, b: T) => {
+  const aDisposition = a.disposition ?? 'static';
+  const bDisposition = b.disposition ?? 'static';
+
+  if (aDisposition === bDisposition) {
+    return 0;
+  } else if (aDisposition === 'hoist' || bDisposition === 'fallback') {
+    return -1;
+  } else if (bDisposition === 'hoist' || aDisposition === 'fallback') {
+    return 1;
+  }
+
+  return 0;
+};

package/src/index.ts

@@ -14,6 +14,7 @@ export * from './complex';
 export * from './defer';
 export * from './defer-function';
 export * from './deep';
+export * from './disposition';
 export * from './entry';
 export * from './for-each-async';
 export * from './human-hash';
@@ -31,7 +32,7 @@ export * from './range';
 export * from './reducers';
 export * from './safe-await';
 export * from './safe-instanceof';
-export * from './safe-parse-json';
+export * from './safe-parse';
 export * from './sliding-window-summary';
 export * from './sort';
 export * from './sum';
@@ -47,3 +48,4 @@ export * from './chunk-array';
 export * from './array-to-hex';
 export * from './remove-undefined-keys';
 export * from './order-keys';
+export * from './no-infer';

package/src/instance-id.ts

@@ -42,5 +42,5 @@ export const getDebugName = (instance: any): string => {
   }
 
   const prototype = Object.getPrototypeOf(instance);
-  return `${prototype.constructor.name}#${getPrototypeSpecificInstanceId(instance)}`;
+  return `${prototype.constructor?.name ?? 'Object'}#${getPrototypeSpecificInstanceId(instance)}`;
 };

package/src/no-infer.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+export type NoInfer<A> = [A][A extends any ? 0 : never];

package/src/safe-parse.ts

@@ -0,0 +1,32 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+export const safeParseInt = (value: string | undefined, defaultValue?: number) => {
+  try {
+    const n = parseInt(value ?? '');
+    return isNaN(n) ? defaultValue : n;
+  } catch (err) {
+    return defaultValue;
+  }
+};
+
+export const safeParseFloat = (str: string, defaultValue?: number): number | undefined => {
+  try {
+    return parseFloat(str);
+  } catch {
+    return defaultValue ?? 0;
+  }
+};
+
+export const safeParseJson: {
+  <T extends object>(data: string | undefined | null, defaultValue: T): T;
+  <T extends object>(data: string | undefined | null): T | undefined;
+} = <T extends object>(data: string | undefined | null, defaultValue?: T) => {
+  if (data) {
+    try {
+      return JSON.parse(data);
+    } catch (err) {}
+  }
+  return defaultValue;
+};

package/src/types.ts

@@ -10,7 +10,34 @@ export type MaybeProvider<T, V = void> = T | ((arg: V) => T);
 
 export type MaybePromise<T> = T | Promise<T>;
 
-export type MakeOptional<Type, Key extends keyof Type> = Omit<Type, Key> & Partial<Pick<Type, Key>>;
+export type GuardedType<T> = T extends (value: any) => value is infer R ? R : never;
+
+export type DeepReadonly<T> = {
+  readonly [P in keyof T]: T[P] extends Record<string, any>
+    ? DeepReadonly<T[P]>
+    : T[P] extends Array<infer U>
+      ? ReadonlyArray<DeepReadonly<U>>
+      : T[P];
+};
+
+export type DeepWriteable<T> = { -readonly [K in keyof T]: T[K] extends object ? DeepWriteable<T[K]> : T[K] };
+
+/**
+ * Simplifies type (copied from effect).
+ */
+export type Simplify<A> = { [K in keyof A]: A[K] } extends infer B ? B : never;
+
+/**
+ * Replace types of specified keys.
+ */
+export type Specialize<T, U> = Simplify<Omit<T, keyof U> & U>;
+
+/**
+ * Make specified keys optional.
+ */
+// TODO(burdon): Wrapping with Simplify fails.
+// export type MakeOptional<T, K extends keyof T> = Simplify<Omit<T, K> & Partial<Pick<T, K>>>;
+export type MakeOptional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
 
 /**
  * All types that evaluate to false when cast to a boolean.
@@ -27,7 +54,7 @@ export const isNotFalsy = <T>(value: T): value is Exclude<T, Falsy> => !!value;
 export const nonNullable = <T>(value: T): value is NonNullable<T> => value !== null && value !== undefined;
 export const isNotNullOrUndefined = <T>(value: T): value is Exclude<T, null | undefined> => value != null;
 // export const isNotNullish = <T>(value: T | null | undefined): value is T => value !== undefined && value !== null;
-export const boolGuard = <T>(value: T | null | undefined): value is T => Boolean(value);
+// export const boolGuard = <T>(value: T | null | undefined): value is T => Boolean(value);
 
 // TODO(burdon): Replace use of setTimeout everywhere?
 //  Would remove the need to cancel (and associated errors), but would change the operation of the code
@@ -55,14 +82,14 @@ export const getAsyncProviderValue = <T, V = void>(
 /**
  * Remove keys with undefined values.
  */
-export const stripUndefinedValues = <T extends { [index: string]: any }>(obj: T): T => {
+export const stripUndefined = <T extends { [index: string]: any }>(obj: T): T => {
   if (typeof obj === 'object') {
     Object.keys(obj).forEach((key) => {
       const value = obj[key];
       if (value === undefined) {
         delete obj[key];
       } else if (value !== null && typeof value === 'object') {
-        stripUndefinedValues(value); // TODO(burdon): Test recursion.
+        stripUndefined(value); // TODO(burdon): Test recursion.
       }
     });
   }
@@ -88,12 +115,3 @@ export const arrayMove = <T>(array: T[], from: number, to: number): Array<T> =>
   array.splice(to < 0 ? array.length + to : to, 0, array.splice(from, 1)[0]);
   return array;
 };
-
-export const safeParseInt = (value: string | undefined, defaultValue?: number) => {
-  try {
-    const n = parseInt(value ?? '');
-    return isNaN(n) ? defaultValue : n;
-  } catch (err) {
-    return defaultValue;
-  }
-};

package/dist/types/src/safe-parse-json.d.ts

@@ -1,5 +0,0 @@
-export declare const safeParseJson: {
-    <T extends object>(data: string | undefined | null, defaultValue: T): T;
-    <T extends object>(data: string | undefined | null): T | undefined;
-};
-//# sourceMappingURL=safe-parse-json.d.ts.map

package/dist/types/src/safe-parse-json.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"safe-parse-json.d.ts","sourceRoot":"","sources":["../../../src/safe-parse-json.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,aAAa,EAAE;IAC1B,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,EAAE,YAAY,EAAE,CAAC,GAAG,CAAC,CAAC;IACxE,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,GAAG,CAAC,GAAG,SAAS,CAAC;CAQpE,CAAC"}

package/src/safe-parse-json.ts

@@ -1,15 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-export const safeParseJson: {
-  <T extends object>(data: string | undefined | null, defaultValue: T): T;
-  <T extends object>(data: string | undefined | null): T | undefined;
-} = <T extends object>(data: string | undefined | null, defaultValue?: T) => {
-  if (data) {
-    try {
-      return JSON.parse(data);
-    } catch (err) {}
-  }
-  return defaultValue;
-};