ts-fortress 8.1.0 → 8.2.0

package/dist/enum/enum.d.mts

@@ -1,7 +1,13 @@
 import { type ArrayElement, type NonEmptyArray, type Primitive } from 'ts-type-forge';
 import { type Type } from '../type.mjs';
-export declare const enumType: <const Values extends NonEmptyArray<Primitive>>(values: Values, options?: Partial<Readonly<{
+export declare function enumType<const Values extends NonEmptyArray<Primitive>>(values: Values, options?: Partial<Readonly<{
     typeName: string;
     defaultValue: ArrayElement<Values>;
-}>>) => Type<ArrayElement<Values>>;
+    allowAnyString: false;
+}>>): Type<ArrayElement<Values>>;
+export declare function enumType<const Values extends NonEmptyArray<string>>(values: Values, options: Readonly<{
+    allowAnyString: true;
+    typeName?: string;
+    defaultValue?: ArrayElement<Values> | (string & {});
+}>): Type<ArrayElement<Values> | (string & {})>;
 //# sourceMappingURL=enum.d.mts.map

package/dist/enum/enum.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"enum.d.mts","sourceRoot":"","sources":["../../src/enum/enum.mts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,aAAa,EAClB,KAAK,SAAS,EACf,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,aAAa,CAAC;AAQxC,eAAO,MAAM,QAAQ,GAAI,KAAK,CAAC,MAAM,SAAS,aAAa,CAAC,SAAS,CAAC,EACpE,QAAQ,MAAM,EACd,UAAU,OAAO,CACf,QAAQ,CAAC;IACP,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;CACpC,CAAC,CACH,KACA,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CA6C3B,CAAC"}
+{"version":3,"file":"enum.d.mts","sourceRoot":"","sources":["../../src/enum/enum.mts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,aAAa,EAClB,KAAK,SAAS,EACf,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,aAAa,CAAC;AAQxC,wBAAgB,QAAQ,CAAC,KAAK,CAAC,MAAM,SAAS,aAAa,CAAC,SAAS,CAAC,EACpE,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,OAAO,CACf,QAAQ,CAAC;IACP,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;IACnC,cAAc,EAAE,KAAK,CAAC;CACvB,CAAC,CACH,GACA,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;AAM9B,wBAAgB,QAAQ,CAAC,KAAK,CAAC,MAAM,SAAS,aAAa,CAAC,MAAM,CAAC,EACjE,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,QAAQ,CAAC;IAChB,cAAc,EAAE,IAAI,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;CACrD,CAAC,GACD,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC,CAAC"}

package/dist/enum/enum.mjs

@@ -1,9 +1,17 @@
-import { ISet, memoizeFunction, Result } from 'ts-data-forge';
+import { isString, ISet, memoizeFunction, Result } from 'ts-data-forge';
 import { createAssertFn } from '../utils/create-assert-fn.mjs';
 import { createCastFn } from '../utils/create-cast-fn.mjs';
 import { createIsFn } from '../utils/create-is-fn.mjs';
+import '@sindresorhus/is';
+import '../other-types/unknown.mjs';
+import { string } from '../primitives/string.mjs';
 
-const enumType = (values, options) => {
+function enumType(values, options) {
+    if (options?.allowAnyString === true &&
+        values.every(isString) &&
+        isString(options.defaultValue)) {
+        return string(options.defaultValue);
+    }
     const valueSet = ISet.create(values);
     const typeName = options?.typeName ?? 'enum';
     const getDefaultValue = memoizeFunction(
@@ -29,7 +37,7 @@ const enumType = (values, options) => {
     const is = createIsFn(validate);
     const fill = (a) => (is(a) ? a : getDefaultValue());
     return {
-        typeName: options?.typeName ?? 'enum',
+        typeName,
         get defaultValue() {
             return getDefaultValue();
         },
@@ -39,7 +47,7 @@ const enumType = (values, options) => {
         assertIs: createAssertFn(validate),
         cast: createCastFn(validate),
     };
-};
+}
 
 export { enumType };
 //# sourceMappingURL=enum.mjs.map

package/dist/enum/enum.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"enum.mjs","sources":["../../src/enum/enum.mts"],"sourcesContent":[null],"names":[],"mappings":";;;;;MAca,QAAQ,GAAG,CACtB,MAAc,EACd,OAKC,KAC6B;IAG9B,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;AAEpC,IAAA,MAAM,QAAQ,GAAG,OAAO,EAAE,QAAQ,IAAI,MAAM;IAE5C,MAAM,eAAe,GAAG,eAAe;;IAErC,MAAS,OAAO,EAAE,YAAY,IAAK,MAAM,CAAC,CAAC,CAA0B,CACtE;AAED,IAAA,MAAM,QAAQ,GAAwB,CAAC,CAAC;;AAEtC,IAAA,QAAQ,CAAC,GAAG,CAAC,CAAc;AACzB;AACE,YAAA,MAAM,CAAC,EAAE,CAAC,CAAM;AAClB,UAAE,MAAM,CAAC,GAAG,CAAC;AACT,YAAA;AACE,gBAAA,IAAI,EAAE,EAAE;AACR,gBAAA,WAAW,EAAE,CAAC;AACd,gBAAA,YAAY,EAAE,QAAQ;gBACtB,QAAQ;AACR,gBAAA,OAAO,EAAE;AACP,oBAAA,IAAI,EAAE,MAAM;oBACZ,MAAM;AACP,iBAAA;AACwB,aAAA;AAC5B,SAAA,CAAC;AAER,IAAA,MAAM,EAAE,GAAG,UAAU,CAAI,QAAQ,CAAC;IAElC,MAAM,IAAI,GAAoB,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,eAAe,EAAE,CAAC;IAEpE,OAAO;AACL,QAAA,QAAQ,EAAE,OAAO,EAAE,QAAQ,IAAI,MAAM;AACrC,QAAA,IAAI,YAAY,GAAA;YACd,OAAO,eAAe,EAAE;QAC1B,CAAC;QACD,IAAI;QACJ,QAAQ;QACR,EAAE;AACF,QAAA,QAAQ,EAAE,cAAc,CAAC,QAAQ,CAAC;AAClC,QAAA,IAAI,EAAE,YAAY,CAAC,QAAQ,CAAC;KAC7B;AACH;;;;"}
+{"version":3,"file":"enum.mjs","sources":["../../src/enum/enum.mts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;;;AAuCM,SAAU,QAAQ,CACtB,MAAc,EACd,OAMC,EAAA;AAED,IAAA,IACE,OAAO,EAAE,cAAc,KAAK,IAAI;AAChC,QAAA,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC;AACtB,QAAA,QAAQ,CAAC,OAAO,CAAC,YAAY,CAAC,EAC9B;AACA,QAAA,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC;IACrC;IAIA,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;AAEpC,IAAA,MAAM,QAAQ,GAAG,OAAO,EAAE,QAAQ,IAAI,MAAM;IAE5C,MAAM,eAAe,GAAG,eAAe;;IAErC,MAAS,OAAO,EAAE,YAAY,IAAK,MAAM,CAAC,CAAC,CAA0B,CACtE;AAED,IAAA,MAAM,QAAQ,GAAwB,CAAC,CAAC;;AAEtC,IAAA,QAAQ,CAAC,GAAG,CAAC,CAAc;AACzB;AACE,YAAA,MAAM,CAAC,EAAE,CAAC,CAAM;AAClB,UAAE,MAAM,CAAC,GAAG,CAAC;AACT,YAAA;AACE,gBAAA,IAAI,EAAE,EAAE;AACR,gBAAA,WAAW,EAAE,CAAC;AACd,gBAAA,YAAY,EAAE,QAAQ;gBACtB,QAAQ;AACR,gBAAA,OAAO,EAAE;AACP,oBAAA,IAAI,EAAE,MAAM;oBACZ,MAAM;AACP,iBAAA;AACwB,aAAA;AAC5B,SAAA,CAAC;AAER,IAAA,MAAM,EAAE,GAAG,UAAU,CAAI,QAAQ,CAAC;IAElC,MAAM,IAAI,GAAoB,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,eAAe,EAAE,CAAC;IAEpE,OAAO;QACL,QAAQ;AACR,QAAA,IAAI,YAAY,GAAA;YACd,OAAO,eAAe,EAAE;QAC1B,CAAC;QACD,IAAI;QACJ,QAAQ;QACR,EAAE;AACF,QAAA,QAAQ,EAAE,cAAc,CAAC,QAAQ,CAAC;AAClC,QAAA,IAAI,EAAE,YAAY,CAAC,QAAQ,CAAC;KAC7B;AACH;;;;"}

package/dist/predefined/int8.mjs

@@ -1,4 +1,6 @@
 import 'ts-data-forge';
+import '@sindresorhus/is';
+import '../other-types/unknown.mjs';
 import { intRange } from '../enum/int-range.mjs';
 
 const int8 = (defaultValue = 0) => intRange({

package/dist/predefined/int8.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"int8.mjs","sources":["../../src/predefined/int8.mts"],"sourcesContent":[null],"names":[],"mappings":";;;AAIO,MAAM,IAAI,GAAG,CAAC,YAAA,GAAqB,CAAC,KACzC,QAAQ,CAAC;IACP,KAAK,EAAE,IAAI;AACX,IAAA,GAAG,EAAE,GAAG;IACR,YAAY;AACb,CAAA;;;;"}
+{"version":3,"file":"int8.mjs","sources":["../../src/predefined/int8.mts"],"sourcesContent":[null],"names":[],"mappings":";;;;;AAIO,MAAM,IAAI,GAAG,CAAC,YAAA,GAAqB,CAAC,KACzC,QAAQ,CAAC;IACP,KAAK,EAAE,IAAI;AACX,IAAA,GAAG,EAAE,GAAG;IACR,YAAY;AACb,CAAA;;;;"}

package/dist/predefined/uint8.mjs

@@ -1,4 +1,6 @@
 import 'ts-data-forge';
+import '@sindresorhus/is';
+import '../other-types/unknown.mjs';
 import { uintRange } from '../enum/uint-range.mjs';
 
 const uint8 = (defaultValue = 0) => uintRange({

package/dist/predefined/uint8.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"uint8.mjs","sources":["../../src/predefined/uint8.mts"],"sourcesContent":[null],"names":[],"mappings":";;;AAIO,MAAM,KAAK,GAAG,CAAC,YAAA,GAAsB,CAAC,KAC3C,SAAS,CAAC;AACR,IAAA,KAAK,EAAE,CAAC;AACR,IAAA,GAAG,EAAE,GAAG;IACR,YAAY;AACb,CAAA;;;;"}
+{"version":3,"file":"uint8.mjs","sources":["../../src/predefined/uint8.mts"],"sourcesContent":[null],"names":[],"mappings":";;;;;AAIO,MAAM,KAAK,GAAG,CAAC,YAAA,GAAsB,CAAC,KAC3C,SAAS,CAAC;AACR,IAAA,KAAK,EAAE,CAAC;AACR,IAAA,GAAG,EAAE,GAAG;IACR,YAAY;AACb,CAAA;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-fortress",
-  "version": "8.1.0",
+  "version": "8.2.0",
   "private": false,
   "keywords": [
     "typescript"

package/src/enum/enum.mts

@@ -1,9 +1,10 @@
-import { ISet, memoizeFunction, Result } from 'ts-data-forge';
+import { ISet, isString, memoizeFunction, Result } from 'ts-data-forge';
 import {
   type ArrayElement,
   type NonEmptyArray,
   type Primitive,
 } from 'ts-type-forge';
+import { string } from '../primitives/index.mjs';
 import { type Type } from '../type.mjs';
 import {
   createAssertFn,
@@ -12,16 +13,49 @@ import {
   type ValidationError,
 } from '../utils/index.mjs';
 
-export const enumType = <const Values extends NonEmptyArray<Primitive>>(
+export function enumType<const Values extends NonEmptyArray<Primitive>>(
   values: Values,
   options?: Partial<
     Readonly<{
       typeName: string;
       defaultValue: ArrayElement<Values>;
+      allowAnyString: false;
     }>
   >,
-): Type<ArrayElement<Values>> => {
-  type T = ArrayElement<Values>;
+): Type<ArrayElement<Values>>;
+
+// When `allowAnyString` is on, the result type keeps autocomplete for the
+// listed members via the `T | (string & {})` idiom while still accepting any
+// other string, and at runtime the value is validated as a plain string
+// (i.e. it behaves like `string()`).
+export function enumType<const Values extends NonEmptyArray<string>>(
+  values: Values,
+  options: Readonly<{
+    allowAnyString: true;
+    typeName?: string;
+    defaultValue?: ArrayElement<Values> | (string & {});
+  }>,
+): Type<ArrayElement<Values> | (string & {})>;
+
+export function enumType<const Values extends NonEmptyArray<Primitive>>(
+  values: Values,
+  options?: Partial<
+    Readonly<{
+      typeName: string;
+      defaultValue: ArrayElement<Values> | (string & {});
+      allowAnyString: boolean;
+    }>
+  >,
+): Type<ArrayElement<Values> | (string & {})> {
+  if (
+    options?.allowAnyString === true &&
+    values.every(isString) &&
+    isString(options.defaultValue)
+  ) {
+    return string(options.defaultValue);
+  }
+
+  type T = ArrayElement<Values> | (string & {});
 
   const valueSet = ISet.create(values);
 
@@ -55,7 +89,7 @@ export const enumType = <const Values extends NonEmptyArray<Primitive>>(
   const fill: Type<T>['fill'] = (a) => (is(a) ? a : getDefaultValue());
 
   return {
-    typeName: options?.typeName ?? 'enum',
+    typeName,
     get defaultValue() {
       return getDefaultValue();
     },
@@ -65,4 +99,4 @@ export const enumType = <const Values extends NonEmptyArray<Primitive>>(
     assertIs: createAssertFn(validate),
     cast: createCastFn(validate),
   };
-};
+}

package/src/enum/enum.test.mts

@@ -108,3 +108,73 @@ describe(enumType, () => {
     });
   });
 });
+
+describe('enumType with allowAnyString', () => {
+  const color = enumType(['red', 'green', 'blue'], {
+    allowAnyString: true,
+    defaultValue: '',
+  });
+
+  type Color = TypeOf<typeof color>;
+
+  // Autocomplete is preserved for the listed members via the open-union idiom,
+  // while any other string is still part of the type.
+  expectType<Color, 'red' | 'green' | 'blue' | (string & {})>('=');
+
+  expectType<typeof color.defaultValue, Color>('=');
+
+  describe('is', () => {
+    test('accepts a listed member', () => {
+      assert.isTrue(color.is('red'));
+    });
+
+    test('accepts any other string at runtime (behaves like string())', () => {
+      assert.isTrue(color.is('purple'));
+    });
+
+    test('rejects non-string values', () => {
+      assert.isFalse(color.is(42));
+    });
+  });
+
+  describe('validate', () => {
+    test('returns an unlisted string as-is', () => {
+      const result = color.validate('purple');
+
+      assert.isTrue(Result.isOk(result));
+
+      expect(Result.unwrapThrow(result)).toBe('purple');
+    });
+
+    test('rejects non-string values with a string-type error', () => {
+      const result = color.validate(42);
+
+      assert.isTrue(Result.isErr(result));
+
+      assert.deepStrictEqual(
+        validationErrorsToMessages(Result.unwrapErrThrow(result)),
+        [
+          'Error: expected <string> type but <number> type value `42` was passed.',
+        ],
+      );
+    });
+  });
+
+  describe('default value and fill', () => {
+    test('uses the configured default value', () => {
+      expect(color.defaultValue).toBe('');
+    });
+
+    test('keeps any string', () => {
+      const x: unknown = 'anything';
+
+      expect(color.fill(x)).toBe('anything');
+    });
+
+    test('non-string falls back to the default value', () => {
+      const x: unknown = 123;
+
+      expect(color.fill(x)).toBe('');
+    });
+  });
+});