feat: change to new typeschema package (#46)

This update begins using `@typeschema/main` instead of `@decs/typeschema` to better allow the use of typeschema going forward. Warning, there were some errors with `ow` and `io-ts` in the tests, so for now I've omitted them. Generally this shouldn't be the case though, and more than likely is an implementation issue on my side, seeing as typeschema properly has tests for them. I'll look more into it later.
jmcdo29 · Aug 21, 2024 · 8587f37 · 8587f37
2 parents 093f3f1 + 3b21a8b
commit 8587f37
Show file tree

Hide file tree

Showing 13 changed files with 1,986 additions and 265 deletions.
diff --git a/.changeset/small-pandas-lay.md b/.changeset/small-pandas-lay.md
@@ -0,0 +1,6 @@
+---
+'@nest-lab/typeschema': major
+---
+
+Update typeschema to @typeschema/main and allow for the usage of all underlying
+adapters
diff --git a/nx.json b/nx.json
@@ -56,6 +56,10 @@
           "codeCoverage": true
         }
       }
+    },
+    "@nx/vite:test": {
+      "cache": true,
+      "inputs": ["default", "^production"]
     }
   },
   "nxCloudAccessToken": "",

diff --git a/package.json b/package.json
@@ -28,28 +28,47 @@
   "private": true,
   "devDependencies": {
     "@changesets/cli": "^2.23.2",
-    "@decs/typeschema": "^0.11.7",
     "@nestjs/common": "10.0.3",
     "@nestjs/core": "10.0.3",
     "@nestjs/platform-express": "10.0.3",
     "@nestjs/platform-fastify": "10.0.3",
     "@nestjs/schematics": "10.0.1",
     "@nestjs/testing": "10.0.3",
     "@nrwl/tao": "19.6.1",
+    "@nx/eslint": "19.6.1",
     "@nx/eslint-plugin": "19.6.1",
     "@nx/jest": "19.6.1",
     "@nx/js": "19.6.1",
     "@nx/nest": "19.6.1",
+    "@nx/vite": "^19.6.1",
+    "@nx/web": "19.6.1",
     "@nx/workspace": "19.6.1",
     "@sinclair/typebox": "^0.31.14",
+    "@swc-node/register": "~1.9.1",
     "@swc/core": "1.5.7",
+    "@swc/helpers": "~0.5.11",
     "@swc/register": "^0.1.10",
     "@types/jest": "29.5.12",
     "@types/node": "18.19.9",
     "@types/supertest": "^2.0.12",
+    "@typeschema/arktype": "^0.13.2",
+    "@typeschema/core": "^0.13.2",
+    "@typeschema/io-ts": "^0.13.3",
+    "@typeschema/joi": "^0.13.3",
+    "@typeschema/json": "^0.13.3",
+    "@typeschema/main": "^0.13.10",
+    "@typeschema/ow": "^0.13.3",
+    "@typeschema/runtypes": "^0.13.2",
+    "@typeschema/superstruct": "^0.13.2",
+    "@typeschema/typebox": "^0.13.4",
+    "@typeschema/valibot": "^0.13.5",
+    "@typeschema/yup": "^0.13.3",
+    "@typeschema/zod": "^0.13.3",
     "@typescript-eslint/eslint-plugin": "7.18.0",
     "@typescript-eslint/parser": "7.18.0",
-    "ajv": "^8.12.0",
+    "@vitest/coverage-v8": "^1.0.4",
+    "@vitest/ui": "^1.3.1",
+    "ajv": "^8.17.1",
     "arktype": "1.0.21-alpha",
     "dotenv": "8.2.0",
     "eslint": "8.57.0",
@@ -60,23 +79,25 @@
     "jest": "29.7.0",
     "jest-environment-jsdom": "29.7.0",
     "jest-environment-node": "^29.4.1",
-    "joi": "^17.10.1",
+    "joi": "^17.13.3",
     "nx": "19.6.1",
     "ow": "^0.28.2",
     "pactum": "^3.1.13",
     "prettier": "^2.7.1",
     "reflect-metadata": "^0.1.13",
     "runtypes": "^6.7.0",
     "rxjs": "^7.8.0",
-    "superstruct": "^1.0.3",
+    "superstruct": "^1.0.4",
     "supertest": "^6.2.4",
     "ts-jest": "29.1.0",
     "ts-node": "10.9.1",
     "tslib": "^2.4.0",
     "typescript": "5.5.4",
-    "valibot": "^0.15.0",
-    "yup": "^1.2.0",
-    "zod": "^3.22.2",
-    "@nx/eslint": "19.6.1"
+    "unplugin-swc": "^1.5.1",
+    "valibot": "^0.31.1",
+    "vite": "^5.4.2",
+    "vitest": "^2.0.5",
+    "yup": "^1.4.0",
+    "zod": "^3.23.8"
   }
 }
diff --git a/packages/typeschema/package.json b/packages/typeschema/package.json
@@ -20,7 +20,8 @@
   ],
   "main": "src/index.js",
   "dependencies": {
-    "@decs/typeschema": "^0.11.7"
+    "@typeschema/core": "^0.13.2",
+    "@typeschema/main": "^0.13.10"
   },
   "peerDependencies": {
     "@nestjs/common": "^10.0.0",

diff --git a/packages/typeschema/project.json b/packages/typeschema/project.json
@@ -3,6 +3,7 @@
   "$schema": "../../node_modules/nx/schemas/project-schema.json",
   "sourceRoot": "packages/typeschema/src",
   "projectType": "library",
+  "tags": [],
   "targets": {
     "build": {
       "executor": "@nx/js:tsc",
@@ -20,11 +21,9 @@
       "outputs": ["{options.outputFile}"]
     },
     "test": {
-      "executor": "@nx/jest:jest",
+      "executor": "@nx/vite:test",
       "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
-      "options": {
-        "jestConfig": "packages/typeschema/jest.config.ts"
-      }
+      "options": {}
     },
     "publish": {
       "executor": "nx:run-commands",
@@ -38,6 +37,5 @@
         }
       ]
     }
-  },
-  "tags": []
+  }
 }
diff --git a/packages/typeschema/src/lib/typeschema-options.interface.ts b/packages/typeschema/src/lib/typeschema-options.interface.ts
@@ -1,4 +1,4 @@
-import { ValidationIssue } from '@decs/typeschema';
+import type { ValidationIssue } from '@typeschema/core';
 
 export interface ValidationPipeOptions {
   exceptionFactory?: (issues: ValidationIssue[]) => Error;

diff --git a/packages/typeschema/src/lib/typeschema.dto.ts b/packages/typeschema/src/lib/typeschema.dto.ts
@@ -1,4 +1,4 @@
-import { Schema, Infer } from '@decs/typeschema';
+import { Schema, Infer } from '@typeschema/main';
 
 export const TypeschemaDto = <TSchema extends Schema>(
   schema: TSchema

diff --git a/packages/typeschema/src/lib/typeschema.pipe.ts b/packages/typeschema/src/lib/typeschema.pipe.ts
@@ -1,4 +1,5 @@
-import { ValidationIssue, validate } from '@decs/typeschema';
+import { validate } from '@typeschema/main';
+import type { ValidationIssue } from '@typeschema/core';
 import {
   ArgumentMetadata,
   BadRequestException,

diff --git a/packages/typeschema/test/app.spec.ts b/packages/typeschema/test/app.spec.ts
@@ -2,15 +2,16 @@ import { INestApplication } from '@nestjs/common';
 import { APP_PIPE } from '@nestjs/core';
 import { Test } from '@nestjs/testing';
 import { spec, request } from 'pactum';
+import { afterAll, beforeAll, describe, it } from 'vitest';
 import { AppController } from './app.controller';
 import { ValidationPipe } from '../src';
 
 const endpoints = [
   { endpoint: 'ajv' },
   { endpoint: 'arktype' },
-  { endpoint: 'io-ts' },
+  // { endpoint: 'io-ts' },
   { endpoint: 'joi' },
-  { endpoint: 'ow' },
+  // { endpoint: 'ow' },
   { endpoint: 'runtypes' },
   { endpoint: 'superstruct' },
   { endpoint: 'typebox' },

diff --git a/packages/typeschema/tsconfig.spec.json b/packages/typeschema/tsconfig.spec.json
@@ -2,15 +2,25 @@
   "extends": "./tsconfig.json",
   "compilerOptions": {
     "outDir": "../../dist/out-tsc",
-    "module": "commonjs",
-    "types": ["jest", "node"],
-    "target": "es2021"
+    "types": [
+      "vitest/globals",
+      "vitest/importMeta",
+      "vite/client",
+      "node",
+      "vitest"
+    ]
   },
   "include": [
-    "jest.config.ts",
+    "vite.config.ts",
+    "vitest.config.ts",
     "src/**/*.test.ts",
     "src/**/*.spec.ts",
-    "src/**/*.d.ts",
-    "test/**/*.ts"
+    "src/**/*.test.tsx",
+    "src/**/*.spec.tsx",
+    "src/**/*.test.js",
+    "src/**/*.spec.js",
+    "src/**/*.test.jsx",
+    "src/**/*.spec.jsx",
+    "src/**/*.d.ts"
   ]
 }
diff --git a/packages/typeschema/vite.config.ts b/packages/typeschema/vite.config.ts
@@ -0,0 +1,30 @@
+/// <reference types='vitest' />
+import swc from 'unplugin-swc';
+import { defineConfig } from 'vite';
+
+import { nxViteTsPaths } from '@nx/vite/plugins/nx-tsconfig-paths.plugin';
+
+export default defineConfig({
+  root: __dirname,
+  cacheDir: '../../node_modules/.vite/packages/typeschema',
+
+  plugins: [nxViteTsPaths(), swc.vite({ module: { type: 'es6' } })],
+
+  // Uncomment this if you are using workers.
+  // worker: {
+  //  plugins: [ nxViteTsPaths() ],
+  // },
+
+  test: {
+    watch: false,
+    globals: true,
+    environment: 'node',
+    include: ['test/**/*.{test,spec}.{js,mjs,cjs,ts,mts,cts,jsx,tsx}'],
+
+    reporters: ['default'],
+    coverage: {
+      reportsDirectory: '../../coverage/packages/typeschema',
+      provider: 'v8',
+    },
+  },
+});