add client typecheck, add test for Entity type

packages/client/package.json

@@ -43,7 +43,9 @@
  "build:watch": "tsc -w",
  "lint:build": "npx publint",
  "lint": "tsc --noEmit",
- "test": "vitest run",
+ "test": "yarn test:unit && yarn typecheck",
+ "test:unit": "vitest run",
+ "typecheck": "vitest --typecheck.only --no-watch",
  "publish-pkg": "node ../../scripts/npm-check-version-and-publish.js",
  "build-worker": "esbuild ./src/worker-client-operator.ts --bundle --minify --platform=browser --outfile=./dist/worker-client-operator.js --format=esm --sourcemap"
  },

packages/client/test/typecheck/friendly-types.test-d.ts

@@ -0,0 +1,25 @@
+import { expectTypeOf, test } from 'vitest';
+import { Schema as S } from '@triplit/db';
+import { Entity } from '../../src/utils/query';
+
+test('Entity', () => {
+ const schema = {
+ a: {
+ schema: S.Schema({
+ id: S.Id(),
+ attr: S.String(),
+ rel: S.RelationById('b', '$bId'),
+ }),
+ },
+ b: {
+ schema: S.Schema({
+ id: S.Id(),
+ attr: S.String(),
+ }),
+ },
+ };
+ expectTypeOf<Entity<typeof schema, 'a'>>().toEqualTypeOf<{
+ id: string;
+ attr: string;
+ }>();
+});

packages/client/tsconfig.test.json

@@ -0,0 +1,18 @@
+// TODO: combine with tsconfigs
+{
+ "compilerOptions": {
+ "lib": ["ESNext"],
+ "target": "ESNext", // You can adjust the target as needed.
+ "module": "ESNext", // This will be overridden in npm scripts
+ "moduleResolution": "node",
+ "strict": true,
+ "resolveJsonModule": true,
+ "isolatedModules": true,
+ // "noUnusedLocals": true,
+ // "noUnusedParameters": true,
+ "noImplicitReturns": true,
+ "skipLibCheck": true,
+ "useDefineForClassFields": true
+ },
+ "include": ["./test/**/*.test-d.ts"]
+}

packages/client/vitest.config.ts

@@ -0,0 +1,10 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+ test: {
+ typecheck: {
+ ignoreSourceErrors: false,
+ tsconfig: './tsconfig.test.json',
+ },
+ },
+});