type-plus 4.6.3 → 4.8.1

package/README.md

@@ -427,6 +427,7 @@ So you may encounter some weird behavior if your logic is complex.
 
 ### Utility Functions
 
+- `amend(subject)...`: amend subject as union or intersect of `T`.
 - `facade(subject, ...props)`: create a facade of `subject`.
 - `getField(subject, key, defaultValue)`: get a field from a subject. Works against nullable and optional subject.
 - `hasKey()`: function of `HasKey`.
@@ -440,6 +441,7 @@ So you may encounter some weird behavior if your logic is complex.
 - `requiredDeep(...)`: merge options deeply and removing `Partial<T>`. From [`unpartial`](https://github.com/unional/unpartial)
 - `split(target, ...splitters)`: split one object into multiple objects.
 - `stub<T>(value)`: stub a particular type `T`.
+- `stub.build<T>(init?)`: build a stub for particular type `T`.
 - `typeOverrideIncompatible<T>()`: override only the incompatible portion between two types.
 
 ```ts

package/cjs/object/split.d.ts

@@ -4,7 +4,7 @@ declare type Splitter<T extends AnyRecord> = Partial<{
     [k in keyof T]: T[k] | undefined;
 }>;
 export declare type Split<T extends AnyRecord, S extends AnyRecord> = {
-    [k in keyof S]: S[k] extends undefined ? T[k] : NonNullable<T[k]> | S[k];
+    [k in keyof S]-?: S[k] extends undefined ? T[k] : NonNullable<T[k]> | S[k];
 };
 export declare function split<T extends AnyRecord, S1 extends Splitter<T>>(target: T, split1: S1): [
     Split<T, S1>,

package/cjs/testing/stub.d.ts

@@ -4,3 +4,6 @@ export declare namespace stub {
     type Param<T> = T extends AnyFunction ? T : RecursivePartial<T>;
 }
 export declare function stub<T>(stub?: stub.Param<T>): T;
+export declare namespace stub {
+    var build: <T>(init?: Param<T> | undefined) => (value?: Param<T> | undefined) => T;
+}

package/cjs/testing/stub.js

@@ -1,8 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.stub = void 0;
+var unpartial_1 = require("unpartial");
 function stub(stub) {
     return stub;
 }
 exports.stub = stub;
+stub.build = function build(init) {
+    return function (value) {
+        return init
+            ? stub((0, unpartial_1.requiredDeep)(init, value))
+            : stub(value);
+    };
+};
 //# sourceMappingURL=stub.js.map

package/cjs/testing/stub.js.map

@@ -1 +1 @@
-{"version":3,"file":"stub.js","sourceRoot":"","sources":["../../ts/testing/stub.ts"],"names":[],"mappings":";;;AAOA,SAAgB,IAAI,CAAI,IAAoB;IAC1C,OAAO,IAAS,CAAA;AAClB,CAAC;AAFD,oBAEC"}
+{"version":3,"file":"stub.js","sourceRoot":"","sources":["../../ts/testing/stub.ts"],"names":[],"mappings":";;;AAAA,uCAAwC;AAQxC,SAAgB,IAAI,CAAI,IAAoB;IAC1C,OAAO,IAAS,CAAA;AAClB,CAAC;AAFD,oBAEC;AAKD,IAAI,CAAC,KAAK,GAAG,SAAS,KAAK,CAAI,IAAoB;IACjD,OAAO,UAAU,KAAqB;QACpC,OAAO,IAAI;YACT,CAAC,CAAC,IAAI,CAAI,IAAA,wBAAY,EAAC,IAAW,EAAE,KAAY,CAAQ,CAAC;YACzD,CAAC,CAAC,IAAI,CAAI,KAAK,CAAC,CAAA;IACpB,CAAC,CAAA;AACH,CAAC,CAAA"}

package/cjs/utils/as.d.ts

@@ -1,2 +1,6 @@
 export declare function as<T>(subject: unknown): T;
 export declare function asAny(subject: unknown): any;
+export declare function amend<S>(subject: S): {
+    union<T>(): T & S;
+    intersect<T_1>(): S | T_1;
+};

package/cjs/utils/as.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.asAny = exports.as = void 0;
+exports.amend = exports.asAny = exports.as = void 0;
 function as(subject) {
     return subject;
 }
@@ -9,4 +9,11 @@ function asAny(subject) {
     return subject;
 }
 exports.asAny = asAny;
+function amend(subject) {
+    return {
+        union: function () { return subject; },
+        intersect: function () { return subject; }
+    };
+}
+exports.amend = amend;
 //# sourceMappingURL=as.js.map

package/cjs/utils/as.js.map

@@ -1 +1 @@
-{"version":3,"file":"as.js","sourceRoot":"","sources":["../../ts/utils/as.ts"],"names":[],"mappings":";;;AAAA,SAAgB,EAAE,CAAI,OAAgB;IACpC,OAAO,OAAY,CAAA;AACrB,CAAC;AAFD,gBAEC;AAED,SAAgB,KAAK,CAAC,OAAgB;IACpC,OAAO,OAAO,CAAA;AAChB,CAAC;AAFD,sBAEC"}
+{"version":3,"file":"as.js","sourceRoot":"","sources":["../../ts/utils/as.ts"],"names":[],"mappings":";;;AAAA,SAAgB,EAAE,CAAI,OAAgB;IACpC,OAAO,OAAY,CAAA;AACrB,CAAC;AAFD,gBAEC;AAED,SAAgB,KAAK,CAAC,OAAgB;IACpC,OAAO,OAAO,CAAA;AAChB,CAAC;AAFD,sBAEC;AAKD,SAAgB,KAAK,CAAI,OAAU;IACjC,OAAO;QACL,KAAK,EAAL,cAAoB,OAAO,OAAgB,CAAA,CAAC,CAAC;QAC7C,SAAS,EAAT,cAAwB,OAAO,OAAgB,CAAA,CAAC,CAAC;KAClD,CAAA;AACH,CAAC;AALD,sBAKC"}

package/esm/testing/stub.js

@@ -1,4 +1,12 @@
+import { requiredDeep } from 'unpartial';
 export function stub(stub) {
     return stub;
 }
+stub.build = function build(init) {
+    return function (value) {
+        return init
+            ? stub(requiredDeep(init, value))
+            : stub(value);
+    };
+};
 //# sourceMappingURL=stub.js.map

package/esm/testing/stub.js.map

@@ -1 +1 @@
-{"version":3,"file":"stub.js","sourceRoot":"","sources":["../../ts/testing/stub.ts"],"names":[],"mappings":"AAOA,MAAM,UAAU,IAAI,CAAI,IAAoB;IAC1C,OAAO,IAAS,CAAA;AAClB,CAAC"}
+{"version":3,"file":"stub.js","sourceRoot":"","sources":["../../ts/testing/stub.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAQxC,MAAM,UAAU,IAAI,CAAI,IAAoB;IAC1C,OAAO,IAAS,CAAA;AAClB,CAAC;AAKD,IAAI,CAAC,KAAK,GAAG,SAAS,KAAK,CAAI,IAAoB;IACjD,OAAO,UAAU,KAAqB;QACpC,OAAO,IAAI;YACT,CAAC,CAAC,IAAI,CAAI,YAAY,CAAC,IAAW,EAAE,KAAY,CAAQ,CAAC;YACzD,CAAC,CAAC,IAAI,CAAI,KAAK,CAAC,CAAA;IACpB,CAAC,CAAA;AACH,CAAC,CAAA"}

package/esm/utils/as.js

@@ -4,4 +4,10 @@ export function as(subject) {
 export function asAny(subject) {
     return subject;
 }
+export function amend(subject) {
+    return {
+        union() { return subject; },
+        intersect() { return subject; }
+    };
+}
 //# sourceMappingURL=as.js.map

package/esm/utils/as.js.map

@@ -1 +1 @@
-{"version":3,"file":"as.js","sourceRoot":"","sources":["../../ts/utils/as.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,EAAE,CAAI,OAAgB;IACpC,OAAO,OAAY,CAAA;AACrB,CAAC;AAED,MAAM,UAAU,KAAK,CAAC,OAAgB;IACpC,OAAO,OAAO,CAAA;AAChB,CAAC"}
+{"version":3,"file":"as.js","sourceRoot":"","sources":["../../ts/utils/as.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,EAAE,CAAI,OAAgB;IACpC,OAAO,OAAY,CAAA;AACrB,CAAC;AAED,MAAM,UAAU,KAAK,CAAC,OAAgB;IACpC,OAAO,OAAO,CAAA;AAChB,CAAC;AAKD,MAAM,UAAU,KAAK,CAAI,OAAU;IACjC,OAAO;QACL,KAAK,KAAe,OAAO,OAAgB,CAAA,CAAC,CAAC;QAC7C,SAAS,KAAe,OAAO,OAAgB,CAAA,CAAC,CAAC;KAClD,CAAA;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "type-plus",
-  "version": "4.6.3",
+  "version": "4.8.1",
   "description": "Provides additional types for TypeScript.",
   "homepage": "https://github.com/unional/type-plus",
   "bugs": {

package/ts/object/split.spec.ts

@@ -35,6 +35,24 @@ test('can default with null', () => {
   isType.equal<true, number | null, typeof a>()
 })
 
+test('remove optional/undefined when default is provided', () => {
+  interface S {
+    variant?: 'abc' | 'def'
+  }
+  const s: S = {}
+  const [a] = split(s, { variant: 'def' })
+  isType.equal<true, 'abc' | 'def', typeof a.variant>()
+})
+
+test('keep undefined when default is undefined', () => {
+  interface S {
+    variant?: 'abc' | 'def'
+  }
+  const s: S = {}
+  const [a] = split(s, { variant: undefined })
+  isType.equal<true, 'abc' | 'def' | undefined, typeof a.variant>()
+})
+
 
 test('can default with false', () => {
   const s: { a?: number | boolean } = {}

package/ts/object/split.ts

@@ -4,7 +4,7 @@ import { reduceByKey } from './reduceKey'
 
 type Splitter<T extends AnyRecord> = Partial<{ [k in keyof T]: T[k] | undefined }>
 export type Split<T extends AnyRecord, S extends AnyRecord> = {
-  [k in keyof S]: S[k] extends undefined ? T[k] : NonNullable<T[k]> | S[k]
+  [k in keyof S]-?: S[k] extends undefined ? T[k] : NonNullable<T[k]> | S[k]
 }
 
 /**

package/ts/testing/stub.spec.ts

@@ -1,38 +1,58 @@
 import { isType, stub } from '..'
 
-test('stub is a partial of the actual object', () => {
-  const real = { a: 1, b: { c: 2 }, d: 3 }
+describe('stub()', () => {
+  test('stub is a partial of the actual object', () => {
+    const real = { a: 1, b: { c: 2 }, d: 3 }
 
-  const a = stub<typeof real>({ a: 2 })
-  expect(a.a).toBe(2)
-  isType.equal<true, typeof a, typeof real>()
-})
+    const a = stub<typeof real>({ a: 2 })
+    expect(a.a).toBe(2)
+    isType.equal<true, typeof a, typeof real>()
+  })
+
+  test('stub function retains param types', () => {
+    function real(a: string, b: number): boolean { return a === String(b) }
 
-test('stub function retains param types', () => {
-  function real(a: string, b: number): boolean { return a === String(b) }
+    const a = stub<typeof real>((_a, _b) => {
+      isType.equal<true, string, typeof _a>()
+      isType.equal<true, number, typeof _b>()
+      return false
+    })
 
-  const a = stub<typeof real>((_a, _b) => {
-    isType.equal<true, string, typeof _a>()
-    isType.equal<true, number, typeof _b>()
-    return false
+    expect(a('1', 1)).toBe(false)
+    isType.equal<true, typeof a, typeof real>()
   })
 
-  expect(a('1', 1)).toBe(false)
-  isType.equal<true, typeof a, typeof real>()
-})
+  test('stub function params can be omitted', () => {
+    function real(a: string, b: number): boolean { return a === String(b) }
 
-test('stub function params can be omitted', () => {
-  function real(a: string, b: number): boolean { return a === String(b) }
+    const a = stub<typeof real>(() => false)
 
-  const a = stub<typeof real>(() => false)
+    expect(a('1', 1)).toBe(false)
+    isType.equal<true, typeof a, typeof real>()
+  })
 
-  expect(a('1', 1)).toBe(false)
-  isType.equal<true, typeof a, typeof real>()
+  test('stub input can be omitted', () => {
+    const real = { a: 1, b: { c: 2 }, d: 3 }
+
+    const a = stub<typeof real>()
+    isType.equal<true, typeof a, typeof real>()
+  })
 })
 
-test('stub input can be omitted', () => {
-  const real = { a: 1, b: { c: 2 }, d: 3 }
+describe('stub.build()', () => {
+  test('build a stub function', () => {
+    const real = { a: 1, b: { c: 2 }, d: 3 }
 
-  const a = stub<typeof real>()
-  isType.equal<true, typeof a, typeof real>()
+    const s = stub.build<typeof real>()
+    const a = s({ a: 2 })
+    expect(a.a).toBe(2)
+    isType.equal<true, typeof a, typeof real>()
+  })
+  test('can define init value', () => {
+    type S = { a: number, b: string }
+    const s = stub.build<S>({ b: 'b' })
+    const a = s({ a: 1 })
+    expect(a).toEqual({ a: 1, b: 'b' })
+    isType.equal<true, S, typeof a>()
+  })
 })

package/ts/testing/stub.ts

@@ -1,3 +1,4 @@
+import { requiredDeep } from 'unpartial'
 import { AnyFunction } from '../function'
 import { RecursivePartial } from '../object'
 
@@ -8,3 +9,14 @@ export namespace stub {
 export function stub<T>(stub?: stub.Param<T>) {
   return stub as T
 }
+
+/**
+ * builds a stub function
+ */
+stub.build = function build<T>(init?: stub.Param<T>) {
+  return function (value?: stub.Param<T>) {
+    return init
+      ? stub<T>(requiredDeep(init as any, value as any) as any)
+      : stub<T>(value)
+  }
+}

package/ts/utils/as.spec.ts

@@ -1,4 +1,4 @@
-import { as, asAny, isType } from '..'
+import { amend, as, asAny, isType } from '..'
 
 describe('as<T>()', () => {
   test('defaults subject type to unknown', () => {
@@ -31,3 +31,15 @@ describe('asAny()', () => {
   })
 })
 
+describe('amend<T>()', () => {
+  test('assert subject as (subject & T)', () => {
+    const s = { a: 1 }
+    const a = amend(s).union<{ b: string }>()
+    isType.equal<true, { a: number } & { b: string }, typeof a>()
+  })
+  test('assert subject as (subject | T)', () => {
+    const s = { a: 1 }
+    const a = amend(s).intersect<{ b: string }>()
+    isType.equal<true, { a: number } | { b: string }, typeof a>()
+  })
+})

package/ts/utils/as.ts

@@ -5,3 +5,13 @@ export function as<T>(subject: unknown): T {
 export function asAny(subject: unknown): any {
   return subject
 }
+
+/**
+ * amend `subject` with type `T`
+ */
+export function amend<S>(subject: S) {
+  return {
+    union<T>(): T & S { return subject as T & S },
+    intersect<T>(): T | S { return subject as T | S }
+  }
+}