feat: add validation package with DTOs

Author: tomast1337

packages/validation/README.md

@@ -0,0 +1,15 @@
+# database
+
+To install dependencies:
+
+```bash
+bun install
+```
+
+To run:
+
+```bash
+bun run index.ts
+```
+
+This project was created using `bun init` in bun v1.2.12. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.

packages/validation/jest.config.js

@@ -0,0 +1,33 @@
+module.exports = {
+  moduleFileExtensions: ['js', 'json', 'ts'],
+  rootDir: '.',
+  testRegex: '.*\\.spec\\.ts$',
+  transform: {
+    '^.+\\.(t|j)s$': [
+      'ts-jest',
+      {
+        tsconfig: '<rootDir>/tsconfig.json',
+        ignoreCodes: ['TS151001'],
+      },
+    ],
+  },
+  collectCoverageFrom: ['**/*.(t|j)s'],
+  coverageDirectory: './coverage',
+  testEnvironment: 'node',
+  moduleNameMapper: {
+    '^@shared/(.*)$': '<rootDir>/../shared/$1',
+    '^@server/(.*)$': '<rootDir>/src/$1',
+  },
+  testPathIgnorePatterns: [
+    '<rootDir>/node_modules/',
+    '<rootDir>/dist/',
+    '<rootDir>/coverage/',
+  ],
+  coveragePathIgnorePatterns: [
+    '<rootDir>/node_modules/',
+    '<rootDir>/coverage/',
+    '<rootDir>/dist/',
+    '.eslintrc.js',
+    'jest.config.js',
+  ],
+};

packages/validation/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@nbw/validation",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "private": true,
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "scripts": {
+    "build": "bun run clean && bun run build:js && bun run build:types",
+    "build:js": "tsc --project tsconfig.build.json",
+    "build:types": "tsc --project tsconfig.types.json",
+    "clean": "rm -rf dist",
+    "dev": "tsc --project tsconfig.build.json --watch",
+    "lint": "eslint \"src/**/*.ts\" --fix",
+    "test": "bun test **/*.spec.ts"
+  },
+  "devDependencies": {
+    "@types/bun": "^1.3.4",
+    "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "mongoose": "^9.0.1",
+    "zod": "^4.1.13",
+    "zod-validation-error": "^5.0.0",
+    "@nbw/config": "workspace:*"
+  },
+  "peerDependencies": {
+    "typescript": "^5"
+  }
+}

packages/validation/src/common/Page.dto.ts

@@ -0,0 +1,21 @@
+import { z } from 'zod';
+
+export function createPageDtoSchema<T extends z.ZodTypeAny>(itemSchema: T) {
+  return z.object({
+    total: z.number().int().min(0),
+    page: z.number().int().min(1),
+    limit: z.number().int().min(1),
+    sort: z.string().optional(),
+    order: z.boolean(),
+    content: z.array(itemSchema),
+  });
+}
+
+export type PageDto<T> = {
+  total: number;
+  page: number;
+  limit: number;
+  sort?: string;
+  order: boolean;
+  content: T[];
+};

packages/validation/src/common/PageQuery.dto.ts

@@ -0,0 +1,16 @@
+import { z } from 'zod';
+
+import { TIMESPANS } from '@nbw/config';
+
+export const pageQueryDTOSchema = z.object({
+  page: z.number().int().min(1).optional().default(1),
+  limit: z.number().int().min(1).max(100).optional(),
+  sort: z.string().optional().default('createdAt'),
+  order: z
+    .union([z.boolean(), z.string().transform((val) => val === 'true')])
+    .optional()
+    .default(false),
+  timespan: z.enum(TIMESPANS as unknown as [string, ...string[]]).optional(),
+});
+
+export type PageQueryDTO = z.infer<typeof pageQueryDTOSchema>;

packages/validation/src/common/types.ts

@@ -0,0 +1,3 @@
+import type { PageQueryDTO } from './PageQuery.dto';
+
+export type PageQueryDTOType = PageQueryDTO;

packages/validation/src/index.ts

@@ -0,0 +1,24 @@
+export * from './common/Page.dto';
+export * from './common/PageQuery.dto';
+export * from './common/types';
+
+export * from './song/CustomInstrumentData.dto';
+export * from './song/FeaturedSongsDto.dto';
+export * from './song/SongListQuery.dto';
+export * from './song/SongPage.dto';
+export * from './song/SongPreview.dto';
+export * from './song/SongStats';
+export * from './song/SongView.dto';
+export * from './song/ThumbnailData.dto';
+export * from './song/UploadSongDto.dto';
+export * from './song/UploadSongResponseDto.dto';
+export * from './song/types';
+
+export * from './user/CreateUser.dto';
+export * from './user/GetUser.dto';
+export * from './user/Login.dto copy';
+export * from './user/LoginWithEmail.dto';
+export * from './user/NewEmailUser.dto';
+export * from './user/SingleUsePass.dto';
+export * from './user/UpdateUsername.dto';
+export * from './user/user.dto';

packages/validation/src/song/CustomInstrumentData.dto.ts

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+
+export const customInstrumentDataSchema = z.object({
+  sound: z.array(z.string()).min(1),
+});
+
+export type CustomInstrumentData = z.infer<typeof customInstrumentDataSchema>;

packages/validation/src/song/FeaturedSongsDto.dto.ts

@@ -0,0 +1,25 @@
+import { z } from 'zod';
+
+import { songPreviewDtoSchema } from './SongPreview.dto';
+
+export const featuredSongsDtoSchema = z.object({
+  hour: z.array(songPreviewDtoSchema),
+  day: z.array(songPreviewDtoSchema),
+  week: z.array(songPreviewDtoSchema),
+  month: z.array(songPreviewDtoSchema),
+  year: z.array(songPreviewDtoSchema),
+  all: z.array(songPreviewDtoSchema),
+});
+
+export type FeaturedSongsDto = z.infer<typeof featuredSongsDtoSchema>;
+
+export const createFeaturedSongsDto = (): FeaturedSongsDto => {
+  return {
+    hour: [],
+    day: [],
+    week: [],
+    month: [],
+    year: [],
+    all: [],
+  };
+};

packages/validation/src/song/SongListQuery.dto.ts

@@ -0,0 +1,27 @@
+import { z } from 'zod';
+
+export enum SongSortType {
+  RECENT = 'recent',
+  RANDOM = 'random',
+  PLAY_COUNT = 'playCount',
+  TITLE = 'title',
+  DURATION = 'duration',
+  NOTE_COUNT = 'noteCount',
+}
+
+export enum SongOrderType {
+  ASC = 'asc',
+  DESC = 'desc',
+}
+
+export const songListQueryDTOSchema = z.object({
+  q: z.string().optional(),
+  sort: z.nativeEnum(SongSortType).optional().default(SongSortType.RECENT),
+  order: z.nativeEnum(SongOrderType).optional().default(SongOrderType.DESC),
+  category: z.string().optional(),
+  uploader: z.string().optional(),
+  page: z.number().int().min(1).optional().default(1),
+  limit: z.number().int().min(1).max(100).optional().default(10),
+});
+
+export type SongListQueryDTO = z.infer<typeof songListQueryDTOSchema>;