Merge pull request #1171 from jasperteo/nanoid

fix: update nanoid to be more accurate

Author: fabian-hiller

library/CHANGELOG.md

@@ -10,6 +10,7 @@ All notable changes to the library will be documented in this file.
 - Add `entries` and `notEntries` validation action to validate number of object entries (pull request #1156)
 - Add support for bigints to `multipleOf` validation action (pull request #1164)
 - Change implementation of `variant` and `variantAsync` schema to improve performance by aborting validation of discriminators early (pull request #1110)
+- Change name of `NanoIDAction` and `NanoIDIssue` interface to `NanoIdAction` and `NanoIdIssue` (pull request #1171)
 
 ## v1.0.0 (March 18, 2025)
 

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

@@ -1,11 +1,11 @@
 import { describe, expectTypeOf, test } from 'vitest';
 import type { InferInput, InferIssue, InferOutput } from '../../types/index.ts';
-import { nanoid, type NanoIDAction, type NanoIDIssue } from './nanoid.ts';
+import { nanoid, type NanoIdAction, type NanoIdIssue } from './nanoid.ts';
 
 describe('nanoid', () => {
   describe('should return action object', () => {
     test('with undefined message', () => {
-      type Action = NanoIDAction<string, undefined>;
+      type Action = NanoIdAction<string, undefined>;
       expectTypeOf(nanoid<string>()).toEqualTypeOf<Action>();
       expectTypeOf(
         nanoid<string, undefined>(undefined)
@@ -14,19 +14,19 @@ describe('nanoid', () => {
 
     test('with string message', () => {
       expectTypeOf(nanoid<string, 'message'>('message')).toEqualTypeOf<
-        NanoIDAction<string, 'message'>
+        NanoIdAction<string, 'message'>
       >();
     });
 
     test('with function message', () => {
       expectTypeOf(nanoid<string, () => string>(() => 'message')).toEqualTypeOf<
-        NanoIDAction<string, () => string>
+        NanoIdAction<string, () => string>
       >();
     });
   });
 
   describe('should infer correct types', () => {
-    type Action = NanoIDAction<string, undefined>;
+    type Action = NanoIdAction<string, undefined>;
 
     test('of input', () => {
       expectTypeOf<InferInput<Action>>().toEqualTypeOf<string>();
@@ -37,7 +37,7 @@ describe('nanoid', () => {
     });
 
     test('of issue', () => {
-      expectTypeOf<InferIssue<Action>>().toEqualTypeOf<NanoIDIssue<string>>();
+      expectTypeOf<InferIssue<Action>>().toEqualTypeOf<NanoIdIssue<string>>();
     });
   });
 });

library/src/actions/nanoid/nanoid.test.ts

@@ -2,11 +2,11 @@ import { describe, expect, test } from 'vitest';
 import { NANO_ID_REGEX } from '../../regex.ts';
 import type { StringIssue } from '../../schemas/index.ts';
 import { expectActionIssue, expectNoActionIssue } from '../../vitest/index.ts';
-import { nanoid, type NanoIDAction, type NanoIDIssue } from './nanoid.ts';
+import { nanoid, type NanoIdAction, type NanoIdIssue } from './nanoid.ts';
 
 describe('nanoid', () => {
   describe('should return action object', () => {
-    const baseAction: Omit<NanoIDAction<string, never>, 'message'> = {
+    const baseAction: Omit<NanoIdAction<string, never>, 'message'> = {
       kind: 'validation',
       type: 'nanoid',
       reference: nanoid,
@@ -17,7 +17,7 @@ describe('nanoid', () => {
     };
 
     test('with undefined message', () => {
-      const action: NanoIDAction<string, undefined> = {
+      const action: NanoIdAction<string, undefined> = {
         ...baseAction,
         message: undefined,
       };
@@ -29,15 +29,15 @@ describe('nanoid', () => {
       expect(nanoid('message')).toStrictEqual({
         ...baseAction,
         message: 'message',
-      } satisfies NanoIDAction<string, string>);
+      } satisfies NanoIdAction<string, string>);
     });
 
     test('with function message', () => {
       const message = () => 'message';
       expect(nanoid(message)).toStrictEqual({
         ...baseAction,
         message,
-      } satisfies NanoIDAction<string, typeof message>);
+      } satisfies NanoIdAction<string, typeof message>);
     });
   });
 
@@ -91,7 +91,7 @@ describe('nanoid', () => {
 
   describe('should return dataset with issues', () => {
     const action = nanoid('message');
-    const baseIssue: Omit<NanoIDIssue<string>, 'input' | 'received'> = {
+    const baseIssue: Omit<NanoIdIssue<string>, 'input' | 'received'> = {
       kind: 'validation',
       type: 'nanoid',
       expected: null,

library/src/actions/nanoid/nanoid.ts

@@ -9,7 +9,7 @@ import { _addIssue } from '../../utils/index.ts';
 /**
  * Nano ID issue interface.
  */
-export interface NanoIDIssue<TInput extends string> extends BaseIssue<TInput> {
+export interface NanoIdIssue<TInput extends string> extends BaseIssue<TInput> {
   /**
    * The issue kind.
    */
@@ -32,13 +32,20 @@ export interface NanoIDIssue<TInput extends string> extends BaseIssue<TInput> {
   readonly requirement: RegExp;
 }
 
+/**
+ * Nano ID issue type.
+ *
+ * @deprecated Use `NanoIdIssue` instead.
+ */
+export type NanoIDIssue<TInput extends string> = NanoIdIssue<TInput>;
+
 /**
  * Nano ID action interface.
  */
-export interface NanoIDAction<
+export interface NanoIdAction<
   TInput extends string,
-  TMessage extends ErrorMessage<NanoIDIssue<TInput>> | undefined,
-> extends BaseValidation<TInput, TInput, NanoIDIssue<TInput>> {
+  TMessage extends ErrorMessage<NanoIdIssue<TInput>> | undefined,
+> extends BaseValidation<TInput, TInput, NanoIdIssue<TInput>> {
   /**
    * The action type.
    */
@@ -61,12 +68,22 @@ export interface NanoIDAction<
   readonly message: TMessage;
 }
 
+/**
+ * Nano ID action type.
+ *
+ * @deprecated Use `NanoIdAction` instead.
+ */
+export type NanoIDAction<
+  TInput extends string,
+  TMessage extends ErrorMessage<NanoIdIssue<TInput>> | undefined,
+> = NanoIdAction<TInput, TMessage>;
+
 /**
  * Creates a [Nano ID](https://github.com/ai/nanoid) validation action.
  *
  * @returns A Nano ID action.
  */
-export function nanoid<TInput extends string>(): NanoIDAction<
+export function nanoid<TInput extends string>(): NanoIdAction<
   TInput,
   undefined
 >;
@@ -80,13 +97,13 @@ export function nanoid<TInput extends string>(): NanoIDAction<
  */
 export function nanoid<
   TInput extends string,
-  const TMessage extends ErrorMessage<NanoIDIssue<TInput>> | undefined,
->(message: TMessage): NanoIDAction<TInput, TMessage>;
+  const TMessage extends ErrorMessage<NanoIdIssue<TInput>> | undefined,
+>(message: TMessage): NanoIdAction<TInput, TMessage>;
 
 // @__NO_SIDE_EFFECTS__
 export function nanoid(
-  message?: ErrorMessage<NanoIDIssue<string>>
-): NanoIDAction<string, ErrorMessage<NanoIDIssue<string>> | undefined> {
+  message?: ErrorMessage<NanoIdIssue<string>>
+): NanoIdAction<string, ErrorMessage<NanoIdIssue<string>> | undefined> {
   return {
     kind: 'validation',
     type: 'nanoid',

packages/to-json-schema/src/convertAction.ts

@@ -85,7 +85,7 @@ type Action =
       number,
       v.ErrorMessage<v.MultipleOfIssue<number, number>> | undefined
     >
-  | v.NanoIDAction<string, v.ErrorMessage<v.NanoIDIssue<string>> | undefined>
+  | v.NanoIdAction<string, v.ErrorMessage<v.NanoIdIssue<string>> | undefined>
   | v.NonEmptyAction<
       v.LengthInput,
       v.ErrorMessage<v.NonEmptyIssue<v.LengthInput>> | undefined

website/src/routes/api/(actions)/nanoid/index.mdx

@@ -47,7 +47,7 @@ The following examples show how `nanoid` can be used.
 Schema to validate a Nano ID.
 
 ```ts
-const NanoIDSchema = v.pipe(
+const NanoIdSchema = v.pipe(
   v.string(),
   v.nanoid('The Nano ID is badly formatted.'),
   v.length(21, 'The Nano ID must be 21 characters long.')

website/src/routes/api/(actions)/nanoid/properties.ts

@@ -17,8 +17,8 @@ export const properties: Record<string, PropertyProps> = {
           generics: [
             {
               type: 'custom',
-              name: 'NanoIDIssue',
-              href: '../NanoIDIssue/',
+              name: 'NanoIdIssue',
+              href: '../NanoIdIssue/',
               generics: [
                 {
                   type: 'custom',
@@ -41,8 +41,8 @@ export const properties: Record<string, PropertyProps> = {
   Action: {
     type: {
       type: 'custom',
-      name: 'NanoIDAction',
-      href: '../NanoIDAction/',
+      name: 'NanoIdAction',
+      href: '../NanoIdAction/',
       generics: [
         {
           type: 'custom',