Implement code points validator

library/src/actions/codePoints/codePoints.test-d.ts

@@ -0,0 +1,50 @@
+import { describe, expectTypeOf, test } from 'vitest';
+import type { InferInput, InferIssue, InferOutput } from '../../types/index.ts';
+import {
+  codePoints,
+  type CodePointsAction,
+  type CodePointsIssue,
+} from './codePoints.ts';
+
+describe('codePoints', () => {
+  describe('should return action object', () => {
+    test('with undefined message', () => {
+      type Action = CodePointsAction<string, 10, undefined>;
+      expectTypeOf(codePoints<string, 10>(10)).toEqualTypeOf<Action>();
+      expectTypeOf(
+        codePoints<string, 10, undefined>(10, undefined)
+      ).toEqualTypeOf<Action>();
+    });
+
+    test('with string message', () => {
+      expectTypeOf(
+        codePoints<string, 10, 'message'>(10, 'message')
+      ).toEqualTypeOf<CodePointsAction<string, 10, 'message'>>();
+    });
+
+    test('with function message', () => {
+      expectTypeOf(
+        codePoints<string, 10, () => string>(10, () => 'message')
+      ).toEqualTypeOf<CodePointsAction<string, 10, () => string>>();
+    });
+  });
+
+  describe('should infer correct types', () => {
+    type Input = 'example string';
+    type Action = CodePointsAction<Input, 5, undefined>;
+
+    test('of input', () => {
+      expectTypeOf<InferInput<Action>>().toEqualTypeOf<Input>();
+    });
+
+    test('of output', () => {
+      expectTypeOf<InferOutput<Action>>().toEqualTypeOf<Input>();
+    });
+
+    test('of issue', () => {
+      expectTypeOf<InferIssue<Action>>().toEqualTypeOf<
+        CodePointsIssue<Input, 5>
+      >();
+    });
+  });
+});

library/src/actions/codePoints/codePoints.test.ts

@@ -0,0 +1,121 @@
+import { describe, expect, test } from 'vitest';
+import type { StringIssue } from '../../schemas/index.ts';
+import { _getCodePointCount } from '../../utils/index.ts';
+import { expectActionIssue, expectNoActionIssue } from '../../vitest/index.ts';
+import {
+  codePoints,
+  type CodePointsAction,
+  type CodePointsIssue,
+} from './codePoints.ts';
+
+describe('codePoints', () => {
+  describe('should return action object', () => {
+    const baseAction: Omit<CodePointsAction<string, 5, never>, 'message'> = {
+      kind: 'validation',
+      type: 'code_points',
+      reference: codePoints,
+      expects: '5',
+      requirement: 5,
+      async: false,
+      '~run': expect.any(Function),
+    };
+
+    test('with undefined message', () => {
+      const action: CodePointsAction<string, 5, undefined> = {
+        ...baseAction,
+        message: undefined,
+      };
+      expect(codePoints(5)).toStrictEqual(action);
+      expect(codePoints(5, undefined)).toStrictEqual(action);
+    });
+
+    test('with string message', () => {
+      expect(codePoints(5, 'message')).toStrictEqual({
+        ...baseAction,
+        message: 'message',
+      } satisfies CodePointsAction<string, 5, string>);
+    });
+
+    test('with function message', () => {
+      const message = () => 'message';
+      expect(codePoints(5, message)).toStrictEqual({
+        ...baseAction,
+        message,
+      } satisfies CodePointsAction<string, 5, typeof message>);
+    });
+  });
+
+  describe('should return dataset without issues', () => {
+    const action = codePoints(5);
+
+    test('for untyped inputs', () => {
+      const issues: [StringIssue] = [
+        {
+          kind: 'schema',
+          type: 'string',
+          input: null,
+          expected: 'string',
+          received: 'null',
+          message: 'message',
+        },
+      ];
+      expect(
+        action['~run']({ typed: false, value: null, issues }, {})
+      ).toStrictEqual({
+        typed: false,
+        value: null,
+        issues,
+      });
+    });
+
+    test('for valid strings', () => {
+      expectNoActionIssue(action, ['12345', '12 45', '1234 ', 'hello']);
+    });
+
+    test('for valid emoji', () => {
+      expectNoActionIssue(action, ['👨🏽‍👩🏽', '😶‍🌫️😀', '😡👍😁😂😀', '0️⃣㊙️']);
+    });
+
+    test('for valid non-latin', () => {
+      expectNoActionIssue(action, ['あ𛀙よろし', '𠮷野家で𩸽', '葛󠄀城市！']);
+    });
+  });
+
+  describe('should return dataset with issues', () => {
+    const action = codePoints(5, 'message');
+    const baseIssue: Omit<CodePointsIssue<string, 5>, 'input' | 'received'> = {
+      kind: 'validation',
+      type: 'code_points',
+      expected: '5',
+      message: 'message',
+      requirement: 5,
+    };
+
+    test('for invalid strings', () => {
+      expectActionIssue(
+        action,
+        baseIssue,
+        ['', ' ', '1', '1234', '123 ', '123456', '12 456', '123456789'],
+        (value) => `${_getCodePointCount(value)}`
+      );
+    });
+
+    test('for invalid emoji', () => {
+      expectActionIssue(
+        action,
+        baseIssue,
+        ['😀👋🏼🧩👩🏻‍🏫🫥', '㊙️㊙️0️⃣1️⃣2️⃣'],
+        (value) => `${_getCodePointCount(value)}`
+      );
+    });
+
+    test('for invalid non-latin', () => {
+      expectActionIssue(
+        action,
+        baseIssue,
+        ['竈門禰󠄀豆子', '葛󠄀城市'],
+        (value) => `${_getCodePointCount(value)}`
+      );
+    });
+  });
+});

library/src/actions/codePoints/codePoints.ts

@@ -0,0 +1,133 @@
+import type {
+  BaseIssue,
+  BaseValidation,
+  ErrorMessage,
+} from '../../types/index.ts';
+import { _addIssue, _getCodePointCount } from '../../utils/index.ts';
+
+/**
+ * Code points issue interface.
+ */
+export interface CodePointsIssue<
+  TInput extends string,
+  TRequirement extends number,
+> extends BaseIssue<TInput> {
+  /**
+   * The issue kind.
+   */
+  readonly kind: 'validation';
+  /**
+   * The issue type.
+   */
+  readonly type: 'code_points';
+  /**
+   * The expected property.
+   */
+  readonly expected: `${TRequirement}`;
+  /**
+   * The received property.
+   */
+  readonly received: `${number}`;
+  /**
+   * The required code points.
+   */
+  readonly requirement: TRequirement;
+}
+
+/**
+ * Code points action interface.
+ */
+export interface CodePointsAction<
+  TInput extends string,
+  TRequirement extends number,
+  TMessage extends
+    | ErrorMessage<CodePointsIssue<TInput, TRequirement>>
+    | undefined,
+> extends BaseValidation<
+    TInput,
+    TInput,
+    CodePointsIssue<TInput, TRequirement>
+  > {
+  /**
+   * The action type.
+   */
+  readonly type: 'code_points';
+  /**
+   * The action reference.
+   */
+  readonly reference: typeof codePoints;
+  /**
+   * The expected property.
+   */
+  readonly expects: `${TRequirement}`;
+  /**
+   * The required code points.
+   */
+  readonly requirement: TRequirement;
+  /**
+   * The error message.
+   */
+  readonly message: TMessage;
+}
+
+/**
+ * Creates a code points validation action.
+ *
+ * @param requirement The required code points.
+ *
+ * @returns A code points action.
+ */
+export function codePoints<
+  TInput extends string,
+  const TRequirement extends number,
+>(requirement: TRequirement): CodePointsAction<TInput, TRequirement, undefined>;
+
+/**
+ * Creates a code points validation action.
+ *
+ * @param requirement The required code points.
+ * @param message The error message.
+ *
+ * @returns A code points action.
+ */
+export function codePoints<
+  TInput extends string,
+  const TRequirement extends number,
+  const TMessage extends
+    | ErrorMessage<CodePointsIssue<TInput, TRequirement>>
+    | undefined,
+>(
+  requirement: TRequirement,
+  message: TMessage
+): CodePointsAction<TInput, TRequirement, TMessage>;
+
+// @__NO_SIDE_EFFECTS__
+export function codePoints(
+  requirement: number,
+  message?: ErrorMessage<CodePointsIssue<string, number>>
+): CodePointsAction<
+  string,
+  number,
+  ErrorMessage<CodePointsIssue<string, number>> | undefined
+> {
+  return {
+    kind: 'validation',
+    type: 'code_points',
+    reference: codePoints,
+    async: false,
+    expects: `${requirement}`,
+    requirement,
+    message,
+    '~run'(dataset, config) {
+      if (dataset.typed) {
+        const count = _getCodePointCount(dataset.value);
+        if (count !== this.requirement) {
+          _addIssue(this, 'code_points', dataset, config, {
+            received: `${count}`,
+          });
+        }
+      }
+      return dataset;
+    },
+  };
+}

library/src/actions/codePoints/index.ts

@@ -0,0 +1 @@
+export * from './codePoints.ts';

library/src/actions/index.ts

@@ -6,6 +6,7 @@ export * from './brand/index.ts';
 export * from './bytes/index.ts';
 export * from './check/index.ts';
 export * from './checkItems/index.ts';
+export * from './codePoints/index.ts';
 export * from './creditCard/index.ts';
 export * from './cuid2/index.ts';
 export * from './decimal/index.ts';
@@ -53,6 +54,7 @@ export * from './mac48/index.ts';
 export * from './mac64/index.ts';
 export * from './mapItems/index.ts';
 export * from './maxBytes/index.ts';
+export * from './maxCodePoints/index.ts';
 export * from './maxEntries/index.ts';
 export * from './maxGraphemes/index.ts';
 export * from './maxLength/index.ts';
@@ -62,6 +64,7 @@ export * from './maxWords/index.ts';
 export * from './metadata/index.ts';
 export * from './mimeType/index.ts';
 export * from './minBytes/index.ts';
+export * from './minCodePoints/index.ts';
 export * from './minEntries/index.ts';
 export * from './minGraphemes/index.ts';
 export * from './minLength/index.ts';
@@ -73,6 +76,7 @@ export * from './nanoid/index.ts';
 export * from './nonEmpty/index.ts';
 export * from './normalize/index.ts';
 export * from './notBytes/index.ts';
+export * from './notCodePoints/index.ts';
 export * from './notEntries/index.ts';
 export * from './notGraphemes/index.ts';
 export * from './notLength/index.ts';

library/src/actions/maxCodePoints/index.ts

@@ -0,0 +1 @@
+export * from './maxCodePoints.ts';

library/src/actions/maxCodePoints/maxCodePoints.test-d.ts

@@ -0,0 +1,50 @@
+import { describe, expectTypeOf, test } from 'vitest';
+import type { InferInput, InferIssue, InferOutput } from '../../types/index.ts';
+import {
+  maxCodePoints,
+  type MaxCodePointsAction,
+  type MaxCodePointsIssue,
+} from './maxCodePoints.ts';
+
+describe('maxCodePoints', () => {
+  describe('should return action object', () => {
+    test('with undefined message', () => {
+      type Action = MaxCodePointsAction<string, 10, undefined>;
+      expectTypeOf(maxCodePoints<string, 10>(10)).toEqualTypeOf<Action>();
+      expectTypeOf(
+        maxCodePoints<string, 10, undefined>(10, undefined)
+      ).toEqualTypeOf<Action>();
+    });
+
+    test('with string message', () => {
+      expectTypeOf(
+        maxCodePoints<string, 10, 'message'>(10, 'message')
+      ).toEqualTypeOf<MaxCodePointsAction<string, 10, 'message'>>();
+    });
+
+    test('with function message', () => {
+      expectTypeOf(
+        maxCodePoints<string, 10, () => string>(10, () => 'message')
+      ).toEqualTypeOf<MaxCodePointsAction<string, 10, () => string>>();
+    });
+  });
+
+  describe('should infer correct types', () => {
+    type Input = 'example string';
+    type Action = MaxCodePointsAction<Input, 10, undefined>;
+
+    test('of input', () => {
+      expectTypeOf<InferInput<Action>>().toEqualTypeOf<Input>();
+    });
+
+    test('of output', () => {
+      expectTypeOf<InferOutput<Action>>().toEqualTypeOf<Input>();
+    });
+
+    test('of issue', () => {
+      expectTypeOf<InferIssue<Action>>().toEqualTypeOf<
+        MaxCodePointsIssue<Input, 10>
+      >();
+    });
+  });
+});