ts-fortress 8.3.0 → 8.4.0

package/dist/entry-point.mjs

@@ -47,6 +47,7 @@ export { email } from './predefined/brand/string/email.mjs';
 export { iso8601 } from './predefined/brand/string/iso-8601.mjs';
 export { jsonString } from './predefined/brand/string/json-string.mjs';
 export { nonEmptyString } from './predefined/brand/string/non-empty-string.mjs';
+export { uri } from './predefined/brand/string/uri.mjs';
 export { uuid, uuidV4, uuidV6, uuidV7 } from './predefined/brand/string/uuid.mjs';
 export { int8 } from './predefined/int8.mjs';
 export { JsonObject, JsonPrimitive, JsonValue } from './predefined/json.mjs';

package/dist/entry-point.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"entry-point.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"entry-point.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/index.mjs

@@ -46,6 +46,7 @@ export { email } from './predefined/brand/string/email.mjs';
 export { iso8601 } from './predefined/brand/string/iso-8601.mjs';
 export { jsonString } from './predefined/brand/string/json-string.mjs';
 export { nonEmptyString } from './predefined/brand/string/non-empty-string.mjs';
+export { uri } from './predefined/brand/string/uri.mjs';
 export { uuid, uuidV4, uuidV6, uuidV7 } from './predefined/brand/string/uuid.mjs';
 export { int8 } from './predefined/int8.mjs';
 export { JsonObject, JsonPrimitive, JsonValue } from './predefined/json.mjs';

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/predefined/brand/index.mjs

@@ -24,5 +24,6 @@ export { email } from './string/email.mjs';
 export { iso8601 } from './string/iso-8601.mjs';
 export { jsonString } from './string/json-string.mjs';
 export { nonEmptyString } from './string/non-empty-string.mjs';
+export { uri } from './string/uri.mjs';
 export { uuid, uuidV4, uuidV6, uuidV7 } from './string/uuid.mjs';
 //# sourceMappingURL=index.mjs.map

package/dist/predefined/brand/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/predefined/brand/string/index.d.mts

@@ -2,5 +2,6 @@ export * from './email.mjs';
 export * from './iso-8601.mjs';
 export * from './json-string.mjs';
 export * from './non-empty-string.mjs';
+export * from './uri.mjs';
 export * from './uuid.mjs';
 //# sourceMappingURL=index.d.mts.map

package/dist/predefined/brand/string/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../../src/predefined/brand/string/index.mts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,YAAY,CAAC"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../../src/predefined/brand/string/index.mts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC"}

package/dist/predefined/brand/string/index.mjs

@@ -2,5 +2,6 @@ export { email } from './email.mjs';
 export { iso8601 } from './iso-8601.mjs';
 export { jsonString } from './json-string.mjs';
 export { nonEmptyString } from './non-empty-string.mjs';
+export { uri } from './uri.mjs';
 export { uuid, uuidV4, uuidV6, uuidV7 } from './uuid.mjs';
 //# sourceMappingURL=index.mjs.map

package/dist/predefined/brand/string/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;"}
+{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;"}

package/dist/predefined/brand/string/uri.d.mts

@@ -0,0 +1,10 @@
+import { type Brand } from 'ts-type-forge';
+import { type Type } from '../../../type.mjs';
+export type Uri = Brand<string, 'Uri' | 'NonEmptyString'>;
+/**
+ * @link https://url.spec.whatwg.org/
+ */
+export declare const uri: (options?: Partial<Readonly<{
+    defaultValue: string;
+}>>) => Type<Uri>;
+//# sourceMappingURL=uri.d.mts.map

package/dist/predefined/brand/string/uri.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uri.d.mts","sourceRoot":"","sources":["../../../../src/predefined/brand/string/uri.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,eAAe,CAAC;AAG3C,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAG9C,MAAM,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAAE,KAAK,GAAG,gBAAgB,CAAC,CAAC;AAE1D;;GAEG;AACH,eAAO,MAAM,GAAG,GACd,UAAU,OAAO,CACf,QAAQ,CAAC;IACP,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC,CACH,KACA,IAAI,CAAC,GAAG,CAOP,CAAC"}

package/dist/predefined/brand/string/uri.mjs

@@ -0,0 +1,21 @@
+import { brand } from '../../../brand/brand.mjs';
+import 'ts-data-forge';
+import '@sindresorhus/is';
+import '../../../other-types/unknown.mjs';
+import { string } from '../../../primitives/string.mjs';
+
+/**
+ * @link https://url.spec.whatwg.org/
+ */
+const uri = (options) => brand({
+    baseType: string(options?.defaultValue ?? defaultUri),
+    is: isUri,
+    defaultValue: options?.defaultValue ?? defaultUri,
+    brandKeys: ['Uri', 'NonEmptyString'],
+    typeName: 'Uri',
+});
+const defaultUri = 'https://example.com';
+const isUri = (s) => URL.canParse(s);
+
+export { uri };
+//# sourceMappingURL=uri.mjs.map

package/dist/predefined/brand/string/uri.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"uri.mjs","sources":["../../../../src/predefined/brand/string/uri.mts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;AAQA;;AAEG;AACI,MAAM,GAAG,GAAG,CACjB,OAIC,KAED,KAAK,CAAC;IACJ,QAAQ,EAAE,MAAM,CAAC,OAAO,EAAE,YAAY,IAAI,UAAU,CAAC;AACrD,IAAA,EAAE,EAAE,KAAK;AACT,IAAA,YAAY,EAAE,OAAO,EAAE,YAAY,IAAI,UAAU;AACjD,IAAA,SAAS,EAAE,CAAC,KAAK,EAAE,gBAAgB,CAAC;AACpC,IAAA,QAAQ,EAAE,KAAK;AAChB,CAAA;AAEH,MAAM,UAAU,GAAG,qBAAqB;AAExC,MAAM,KAAK,GAAG,CAAC,CAAS,KAAe,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;;;;"}

package/dist/predefined/index.mjs

@@ -24,6 +24,7 @@ export { email } from './brand/string/email.mjs';
 export { iso8601 } from './brand/string/iso-8601.mjs';
 export { jsonString } from './brand/string/json-string.mjs';
 export { nonEmptyString } from './brand/string/non-empty-string.mjs';
+export { uri } from './brand/string/uri.mjs';
 export { uuid, uuidV4, uuidV6, uuidV7 } from './brand/string/uuid.mjs';
 export { int8 } from './int8.mjs';
 export { JsonObject, JsonPrimitive, JsonValue } from './json.mjs';

package/dist/predefined/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/package.json

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

package/src/predefined/brand/string/index.mts

@@ -2,4 +2,5 @@ export * from './email.mjs';
 export * from './iso-8601.mjs';
 export * from './json-string.mjs';
 export * from './non-empty-string.mjs';
+export * from './uri.mjs';
 export * from './uuid.mjs';

package/src/predefined/brand/string/non-empty-string.test.mts

@@ -69,9 +69,15 @@ describe('nonEmptyString with extra constraints', () => {
     assert.isFalse(t.is('')); // empty string is still rejected
   });
 
+  test('throws when the default value violates a nonEmpty constraint', () => {
+    expect(() => nonEmptyString('')).toThrow(
+      /^defaultValue "" for string does not satisfy the constraint nonempty = true$/u,
+    );
+  });
+
   test('throws when the default value violates a forwarded constraint', () => {
     expect(() => nonEmptyString('ab', { minLength: 3 })).toThrow(
-      'minLength = 3',
+      /^defaultValue "ab" for string does not satisfy the constraint minLength = 3$/u,
     );
   });
 

package/src/predefined/brand/string/uri.mts

@@ -0,0 +1,35 @@
+import { type Brand } from 'ts-type-forge';
+import { brand } from '../../../brand/index.mjs';
+import { string } from '../../../primitives/index.mjs';
+import { type Type } from '../../../type.mjs';
+
+// A valid URI always has a non-empty scheme, so it also satisfies `NonEmptyString`.
+export type Uri = Brand<string, 'Uri' | 'NonEmptyString'>;
+
+/**
+ * @link https://url.spec.whatwg.org/
+ */
+export const uri = (
+  options?: Partial<
+    Readonly<{
+      defaultValue: string;
+    }>
+  >,
+): Type<Uri> =>
+  brand({
+    baseType: string(options?.defaultValue ?? defaultUri),
+    is: isUri,
+    defaultValue: options?.defaultValue ?? defaultUri,
+    brandKeys: ['Uri', 'NonEmptyString'],
+    typeName: 'Uri',
+  });
+
+const defaultUri = 'https://example.com';
+
+const isUri = (s: string): s is Uri => URL.canParse(s);
+
+if (import.meta.vitest !== undefined) {
+  test('defaultUri', () => {
+    assert.isTrue(isUri(defaultUri));
+  });
+}

package/src/predefined/brand/string/uri.test.mts

@@ -0,0 +1,79 @@
+import { expectType, Result } from 'ts-data-forge';
+import { type NonEmptyString } from 'ts-type-forge';
+import { type TypeOf } from '../../../type.mjs';
+import { validationErrorsToMessages } from '../../../utils/index.mjs';
+import { uri } from './uri.mjs';
+
+const validSamples = [
+  'https://example.com',
+  'https://example.com/path?query=1#fragment',
+  'http://user:pass@example.com:8080/path',
+  'ftp://ftp.is.co.za/rfc/rfc1808.txt',
+  'mailto:foo@bar.com',
+  'urn:isbn:0451450523',
+  'file:///etc/hosts',
+  'tel:+1-816-555-1212',
+] as const satisfies readonly string[];
+
+const invalidSamples = [
+  '',
+  'not a uri',
+  '://missing-scheme',
+  'relative/path',
+  '/absolute/path',
+  '1http://example.com',
+] as const satisfies readonly string[];
+
+describe(uri, () => {
+  const baseType = uri();
+
+  type UriType = TypeOf<typeof baseType>;
+
+  expectType<UriType, string>('<=');
+
+  expectType<UriType, NonEmptyString>('<=');
+
+  expectType<typeof baseType.defaultValue, UriType>('=');
+
+  test('provides https://example.com as default', () => {
+    expect(baseType.defaultValue).toBe('https://example.com');
+  });
+
+  test.each(validSamples)('accepts %s', (u) => {
+    assert.isTrue(baseType.is(u));
+  });
+
+  test.each(invalidSamples)('rejects %s', (u) => {
+    assert.isFalse(baseType.is(u));
+  });
+
+  test('validate surfaces details for invalid strings', () => {
+    const result = baseType.validate('not a uri');
+
+    assert.isTrue(Result.isErr(result));
+
+    if (!Result.isErr(result)) {
+      throw new Error('Expected validation failure');
+    }
+
+    assert.deepStrictEqual(result.value, [
+      {
+        path: [],
+        actualValue: 'not a uri',
+        expectedType: 'Uri',
+        typeName: 'Uri',
+        details: undefined,
+      },
+    ]);
+
+    assert.deepStrictEqual(validationErrorsToMessages(result.value), [
+      'Error: expected <Uri> type but <string> type value "not a uri" was passed.',
+    ]);
+  });
+
+  test('accepts a custom default value', () => {
+    const customType = uri({ defaultValue: 'mailto:foo@bar.com' });
+
+    expect(customType.defaultValue).toBe('mailto:foo@bar.com');
+  });
+});