add type tests to onyx!

Author: blazejkustra

.eslintignore

@@ -1,4 +1,5 @@
 *.d.ts
 dist
 node_modules
-*.config.js
+*.config.js
+tests/types/**/*.ts

.github/workflows/test.yml

@@ -30,3 +30,5 @@ jobs:
             - run: npm run test
               env:
                   CI: true
+
+            - run: npm run test:types

package.json

@@ -32,6 +32,7 @@
     "lint": "eslint .",
     "typecheck": "tsc --noEmit",
     "test": "jest",
+    "test:types": "npm run build && tsc --noEmit --project tsconfig.test.json",
     "perf-test": "npx reassure",
     "build": "tsc -p tsconfig.build.json",
     "build:watch": "nodemon --watch lib --ext js,json,ts,tsx --exec \"npm run build && npm pack\"",

tests/types/test.ts

@@ -0,0 +1,52 @@
+import type {OnyxUpdate} from '../../dist/types';
+
+const ONYX_KEYS = {
+    TEST_KEY: 'test',
+    COLLECTION: {
+        TEST_KEY: 'test_',
+    },
+};
+
+type OnyxValues = {
+    [ONYX_KEYS.TEST_KEY]: string;
+};
+
+type OnyxCollectionValues = {
+    [ONYX_KEYS.COLLECTION.TEST_KEY]: {str: string};
+};
+
+declare module '../../dist/types' {
+    interface CustomTypeOptions {
+        keys: keyof OnyxValues;
+        collectionKeys: keyof OnyxCollectionValues;
+        values: OnyxValues;
+    }
+}
+
+const onyxUpdate: OnyxUpdate = {
+    onyxMethod: 'set',
+    key: ONYX_KEYS.TEST_KEY,
+    value: 'string',
+};
+
+const onyxUpdateError: OnyxUpdate = {
+    onyxMethod: 'set',
+    key: 'string',
+    // @ts-expect-error TEST_KEY is a string, not a number
+    value: 2,
+};
+
+const onyxUpdateCollection: OnyxUpdate = {
+    onyxMethod: 'mergecollection',
+    key: ONYX_KEYS.COLLECTION.TEST_KEY,
+    value: {
+        [ONYX_KEYS.COLLECTION.TEST_KEY]: {str: 'test'},
+    },
+};
+
+const onyxUpdateCollectionError: OnyxUpdate = {
+    onyxMethod: 'mergecollection',
+    key: ONYX_KEYS.COLLECTION.TEST_KEY,
+    // @ts-expect-error TEST_KEY is an object, not a number
+    value: 2,
+};

tsconfig.json

@@ -17,5 +17,5 @@
         "declaration": true,
         "outDir": "./dist"
     },
-    "exclude": ["**/node_modules/**/*", "**/dist/**/*"]
+    "exclude": ["**/node_modules/**/*", "**/dist/**/*", "tests/types/**/*.ts"]
 }

tsconfig.test.json

@@ -0,0 +1,6 @@
+{
+    "$schema": "https://json.schemastore.org/tsconfig",
+    "extends": "./tsconfig.json",
+    "include": ["tests/types/**/*.ts"],
+    "exclude": ["**/node_modules/**/*", "lib/**/*"]
+  }