@xylabs/object-model 5.0.79 → 5.0.81

package/README.md

@@ -33,6 +33,7 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 - [AsTypeFunction](#type-aliases/AsTypeFunction)
 - [AsOptionalTypeFunction](#type-aliases/AsOptionalTypeFunction)
 - [Compare](#type-aliases/Compare)
+- [EmptyObject](#type-aliases/EmptyObject)
 - [StringOrAlertFunction](#type-aliases/StringOrAlertFunction)
 - [TypeCheck](#type-aliases/TypeCheck)
 
@@ -126,7 +127,7 @@ required: true;
 ***
 
 ```ts
-type AnyObject = Record<TypedKey, unknown>;
+type AnyObject = EmptyObject & Partial<Record<TypedKey, unknown>>;
 ```
 
 Any object, which means that it does not enforce the set of fields that it has.  Extending from AnyObject
@@ -139,7 +140,7 @@ will result in a type that includes the universal set of field names
 ***
 
 ```ts
-type AsOptionalTypeFunction<T> = <TType>(value) => undefined | TType;
+type AsOptionalTypeFunction<T> = <TType>(value) => TType | undefined;
 ```
 
 ## Type Parameters
@@ -162,7 +163,7 @@ type AsOptionalTypeFunction<T> = <TType>(value) => undefined | TType;
 
 ## Returns
 
-`undefined` \| `TType`
+`TType` \| `undefined`
 
   ### <a id="AsTypeFunction"></a>AsTypeFunction
 
@@ -172,12 +173,12 @@ type AsOptionalTypeFunction<T> = <TType>(value) => undefined | TType;
 
 ```ts
 type AsTypeFunction<T> = {
-<TType>  (value): undefined | TType;
+<TType>  (value): TType | undefined;
 <TType>  (value, config): TType;
-<TType>  (value, config): undefined | TType;
-<TType>  (value, assert): undefined | TType;
+<TType>  (value, config): TType | undefined;
+<TType>  (value, assert): TType | undefined;
 <TType>  (value, assert, config): TType;
-<TType>  (value, assert, config): undefined | TType;
+<TType>  (value, assert, config): TType | undefined;
 };
 ```
 
@@ -190,7 +191,7 @@ type AsTypeFunction<T> = {
 ## Call Signature
 
 ```ts
-<TType>(value): undefined | TType;
+<TType>(value): TType | undefined;
 ```
 
 ### Type Parameters
@@ -207,7 +208,7 @@ type AsTypeFunction<T> = {
 
 ### Returns
 
-`undefined` \| `TType`
+`TType` \| `undefined`
 
 ## Call Signature
 
@@ -238,7 +239,7 @@ type AsTypeFunction<T> = {
 ## Call Signature
 
 ```ts
-<TType>(value, config): undefined | TType;
+<TType>(value, config): TType | undefined;
 ```
 
 ### Type Parameters
@@ -259,12 +260,12 @@ type AsTypeFunction<T> = {
 
 ### Returns
 
-`undefined` \| `TType`
+`TType` \| `undefined`
 
 ## Call Signature
 
 ```ts
-<TType>(value, assert): undefined | TType;
+<TType>(value, assert): TType | undefined;
 ```
 
 ### Type Parameters
@@ -285,7 +286,7 @@ type AsTypeFunction<T> = {
 
 ### Returns
 
-`undefined` \| `TType`
+`TType` \| `undefined`
 
 ## Call Signature
 
@@ -326,7 +327,7 @@ type AsTypeFunction<T> = {
 <TType>(
    value, 
    assert, 
-   config): undefined | TType;
+   config): TType | undefined;
 ```
 
 ### Type Parameters
@@ -351,7 +352,7 @@ type AsTypeFunction<T> = {
 
 ### Returns
 
-`undefined` \| `TType`
+`TType` \| `undefined`
 
   ### <a id="Compare"></a>Compare
 
@@ -383,6 +384,25 @@ type Compare<T> = (a, b) => number;
 
 `number`
 
+  ### <a id="EmptyObject"></a>EmptyObject
+
+[**@xylabs/object-model**](#../README)
+
+***
+
+```ts
+type EmptyObject<T> = Exclude<{ [K in keyof T]?: never }, unknown[] | (...args) => unknown | null>;
+```
+
+An empty object, which means that it does enforce the set of field names, defaulting to an empty set until
+extended from, which then adds only those additional fields
+
+## Type Parameters
+
+### T
+
+`T` *extends* `object` = `object`
+
   ### <a id="StringOrAlertFunction"></a>StringOrAlertFunction
 
 [**@xylabs/object-model**](#../README)
@@ -469,7 +489,7 @@ type TypeCheck<T> = {
 
 ### config
 
-`undefined` | `number` | [`TypeCheckConfig`](#../interfaces/TypeCheckConfig)
+`number` | [`TypeCheckConfig`](#../interfaces/TypeCheckConfig) | `undefined`
 
 ### Returns
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/object-model",
-  "version": "5.0.79",
+  "version": "5.0.81",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -22,30 +22,27 @@
   "exports": {
     ".": {
       "types": "./dist/neutral/index.d.ts",
-      "source": "./src/index.ts",
       "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
   "module": "./dist/neutral/index.mjs",
-  "source": "./src/index.ts",
   "types": "./dist/neutral/index.d.ts",
   "files": [
     "dist",
-    "src",
     "!**/*.bench.*",
     "!**/*.spec.*",
     "!**/*.test.*"
   ],
   "dependencies": {
-    "@xylabs/assert": "~5.0.79",
-    "@xylabs/logger": "~5.0.79",
-    "@xylabs/promise": "~5.0.79",
-    "@xylabs/typeof": "~5.0.79"
+    "@xylabs/assert": "~5.0.81",
+    "@xylabs/logger": "~5.0.81",
+    "@xylabs/promise": "~5.0.81",
+    "@xylabs/typeof": "~5.0.81"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "~7.3.2",
-    "@xylabs/tsconfig": "~7.3.2",
+    "@xylabs/ts-scripts-yarn3": "~7.4.11",
+    "@xylabs/tsconfig": "~7.4.11",
     "typescript": "~5.9.3",
     "vitest": "~4.0.18"
   },

package/src/AnyObject.ts

@@ -1,9 +0,0 @@
-import type { TypedKey } from '@xylabs/typeof'
-
-import type { EmptyObject } from './EmptyObject.ts'
-
-/**
- * Any object, which means that it does not enforce the set of fields that it has.  Extending from AnyObject
- * will result in a type that includes the universal set of field names
- */
-export type AnyObject = EmptyObject & Partial<Record<TypedKey, unknown>>

package/src/AsTypeFactory.ts

@@ -1,55 +0,0 @@
-import { assertDefinedEx } from '@xylabs/assert'
-import type { AnyNonPromise } from '@xylabs/promise'
-import { isPromise } from '@xylabs/promise'
-import { isTruthy } from '@xylabs/typeof'
-
-import type { AsTypeFunction } from './AsTypeFunction.ts'
-import type {
-  StringOrAlertFunction, TypeCheck, TypeCheckConfig,
-  TypeCheckRequiredConfig,
-} from './types.ts'
-
-export const AsTypeFactory = {
-  create: <T extends AnyNonPromise>(typeCheck: TypeCheck<T>): AsTypeFunction<T> => {
-    const func = (
-      value: AnyNonPromise,
-      assertOrConfig?: StringOrAlertFunction<T> | TypeCheckConfig,
-      config?: TypeCheckConfig,
-    ): T | undefined => {
-      // when used as a predicate, it seems that the index is passed as the second parameter (filter,map)
-      const isPredicate = typeof assertOrConfig === 'number'
-      const resolvedAssert = isPredicate
-        ? undefined
-        : (typeof assertOrConfig === 'object' ? undefined : assertOrConfig) as (StringOrAlertFunction<T> | undefined)
-      const resolvedConfig = isPredicate ? undefined : typeof assertOrConfig === 'object' ? assertOrConfig : config
-
-      // only return undefined if not required
-      const required = isTruthy((resolvedConfig as (TypeCheckRequiredConfig | undefined))?.required)
-      if (!required && (value === undefined || value === null)) {
-        return undefined
-      }
-
-      if (isPromise(value)) {
-        throw new TypeError('un-awaited promises may not be sent to "as" functions')
-      }
-
-      const result = typeCheck(value, resolvedConfig) ? (value as T) : undefined
-
-      if (resolvedAssert !== undefined) {
-        return typeof resolvedAssert === 'function' ? assertDefinedEx<T>(result, resolvedAssert) : assertDefinedEx<T>(result, () => resolvedAssert)
-      }
-      return result
-    }
-    return func
-  },
-  createOptional: <T extends AnyNonPromise>(typeCheck: TypeCheck<T>) => {
-    const func = (value: AnyNonPromise): T | undefined => {
-      if (value === undefined || value === null) return undefined
-      if (isPromise(value)) {
-        throw new TypeError('un-awaited promises may not be sent to "as" functions')
-      }
-      return typeCheck(value) ? (value as T) : undefined
-    }
-    return func
-  },
-}

package/src/AsTypeFunction.ts

@@ -1,19 +0,0 @@
-import type { AnyNonPromise } from '@xylabs/promise'
-
-import type {
-  StringOrAlertFunction,
-  TypeCheckConfig, TypeCheckOptionalConfig, TypeCheckRequiredConfig,
-} from './types.ts'
-
-export type AsTypeFunction<T extends AnyNonPromise = AnyNonPromise> = {
-  <TType extends T>(value: AnyNonPromise): TType | undefined
-  <TType extends T>(value: AnyNonPromise, config: TypeCheckRequiredConfig): TType
-  <TType extends T>(value: AnyNonPromise, config: TypeCheckConfig | TypeCheckOptionalConfig): TType | undefined
-  <TType extends T>(value: AnyNonPromise, assert: StringOrAlertFunction<TType>): TType | undefined
-  <TType extends T>(value: AnyNonPromise, assert: StringOrAlertFunction<TType>, config: TypeCheckRequiredConfig): TType
-  <TType extends T>(value: AnyNonPromise, assert: StringOrAlertFunction<TType>, config: TypeCheckConfig | TypeCheckOptionalConfig): TType | undefined
-}
-
-export type AsOptionalTypeFunction<T extends AnyNonPromise = AnyNonPromise> = {
-  <TType extends T>(value: AnyNonPromise): TType | undefined
-}

package/src/Compare.ts

@@ -1,2 +0,0 @@
-// Returns a negative number if a < b, zero if a == b, and a positive number if a > b
-export type Compare<T> = (a: T, b: T) => number

package/src/EmptyObject.ts

@@ -1,29 +0,0 @@
-/**
- * An empty object, which means that it does enforce the set of field names, defaulting to an empty set until
- * extended from, which then adds only those additional fields
- */
-
-export type EmptyObject<T extends object = object> = Exclude<{ [K in keyof T]?: never }, unknown[] | ((...args: unknown[]) => unknown) | null>
-
-/* export type EmptyObjectExperimental = Exclude<
-
-  Record<TypedKey, unknown>,
-  unknown[] | ((...args: unknown[]) => unknown) | null
-> */
-
-/*
-const foo: EmptyObjectExperimental = {}
-const bar: EmptyObjectExperimental = []
-const baz: EmptyObjectExperimental = () => null
-const qux: EmptyObjectExperimental = null
-
-type x = EmptyObjectExperimental & { test: boolean }
-
-const y: x = { test: true, arie: 1 }
-
-export type AnyObject = EmptyObjectExperimental & Partial<Record<TypedKey, unknown>>
-
-export abstract class ValidatorBase<T extends EmptyObjectExperimental = AnyObject> {
-  abstract validate(payload: T): Promise<Error[]>
-}
-*/

package/src/index.ts

@@ -1,5 +0,0 @@
-export * from './AnyObject.ts'
-export * from './AsTypeFunction.ts'
-export * from './Compare.ts'
-export * from './EmptyObject.ts'
-export * from './types.ts'

package/src/types.ts

@@ -1,24 +0,0 @@
-import type { AssertExMessageFunc } from '@xylabs/assert'
-import type { Logger } from '@xylabs/logger'
-import type { AnyNonPromise } from '@xylabs/promise'
-import type { TypedValue } from '@xylabs/typeof'
-
-export interface TypeCheckConfig {
-  log?: boolean | Logger
-}
-
-export interface TypeCheckRequiredConfig extends TypeCheckConfig {
-  required: true
-}
-
-export interface TypeCheckOptionalConfig extends TypeCheckConfig {
-  required: false
-}
-
-export type StringOrAlertFunction<T extends AnyNonPromise> = string | AssertExMessageFunc<T>
-
-export type TypeCheck<T extends TypedValue> = {
-  (obj: AnyNonPromise): obj is T
-  (obj: AnyNonPromise, config: TypeCheckConfig): obj is T
-  (obj: AnyNonPromise, config: TypeCheckConfig | number /* for use as predicate */ | undefined): obj is T
-}