feat(index.d.ts): add typescript type declarations (#16)

Author: rubinovitz

.github/workflows/ci.yml

@@ -12,15 +12,15 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v2
-      
+
       - uses: actions/setup-node@v1
         with:
           node-version: '12'
-      
+
       - name: Get yarn cache directory path
         id: yarn-cache-dir-path
         run: echo "::set-output name=dir::$(yarn config get cacheFolder)"
-      
+
       - name: Cache yarn packages
         uses: actions/cache@v2
         id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
@@ -36,7 +36,7 @@ jobs:
           path: ~/.m2
           key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
           restore-keys: ${{ runner.os }}-m2
-      
+
       - name: Cache shadow-cljs
         uses: actions/cache@v2
         with:
@@ -47,7 +47,9 @@ jobs:
       - run: yarn install --frozen-lockfile
 
       - run: yarn shadow-cljs release npm
+      - run: yarn bundle-ts
       - run: yarn shadow-cljs compile test
-      
+
       - run: node out/node-tests.js
       - run: yarn jest js/tests
+      - run: yarn tsd

bundle-ts.sh

@@ -0,0 +1,2 @@
+mkdir dist/types
+cp -r types/ dist/types/.

jest.config.js

@@ -0,0 +1,8 @@
+module.exports = {
+  verbose: true,
+  moduleFileExtensions: ["js", "jsx", "ts", "tsx"],
+  transform: {
+    '^.+\\.(ts|tsx)?$': 'ts-jest',
+    "^.+\\.(js|jsx)$": "babel-jest",
+  }
+};

package.json

@@ -8,10 +8,10 @@
   "private": false,
   "scripts": {
     "dev": "shadow-cljs watch dev",
-    "build": "rm -rf dist && shadow-cljs release npm",
-    "build:dev": "rm -rf dist && shadow-cljs compile npm",
-    "test:js": "yarn build && jest js/tests",
-    "test:js:dev": "yarn build:dev && jest js/tests",
+    "build": "rm -rf dist && shadow-cljs release npm && yarn bundle-ts",
+    "build:dev": "rm -rf dist && shadow-cljs compile npm && yarn bundle-ts",
+    "test:js": "yarn build && jest js/tests && yarn tsd",
+    "test:js:dev": "yarn build:dev && jest js/tests && yarn tsd",
     "test:cljs": "shadow-cljs compile test && node out/node-tests.js",
     "test:cljs:watch": "shadow-cljs watch test-autorun",
     "test": "yarn test:cljs && yarn test:js",
@@ -20,7 +20,8 @@
     "semantic-release": "semantic-release",
     "_postinstall": "husky install",
     "prepublish": "pinst --disable",
-    "postpublish": "pinst --enable"
+    "postpublish": "pinst --enable",
+    "bundle-ts": "./bundle-ts.sh"
   },
   "config": {
     "commitizen": {
@@ -32,7 +33,6 @@
   },
   "devDependencies": {
     "@babel/cli": "7.11.6",
-    "@babel/core": "7.11.6",
     "@babel/plugin-transform-modules-commonjs": "7.12.1",
     "@babel/plugin-transform-react-jsx": "7.10.4",
     "@commitlint/cli": "^11.0.0",
@@ -43,6 +43,7 @@
     "@semantic-release/github": "7.1.1",
     "@semantic-release/npm": "7.0.6",
     "@semantic-release/release-notes-generator": "9.0.1",
+    "@types/react": "^16.9.56",
     "babel-runtime": "6.26.0",
     "commitizen": "^4.2.2",
     "create-react-class": "15.6.3",
@@ -57,10 +58,15 @@
     "react": "16.14.0",
     "react-component-benchmark": "0.0.4",
     "react-dom": "16.14.0",
+    "react-test-renderer": "^16.14.0",
     "semantic-release": "17.2.2",
     "semantic-release-cli": "5.4.0",
-    "shadow-cljs": "2.11.4"
+    "shadow-cljs": "2.11.4",
+    "ts-jest": "^26.4.4",
+    "tsd": "^0.13.1",
+    "typescript": "^4.0.5"
   },
+  "types": "./dist/types",
   "keywords": [
     "react",
     "relational",
@@ -69,6 +75,9 @@
     "state",
     "graph"
   ],
+  "tsd": {
+    "directory": "types/tests"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/homebaseio/homebase-react.git"

types/index.d.ts

@@ -0,0 +1,11 @@
+export type Transaction = Array<object>;
+export type Schema = object;
+export type config = {schema?: Schema, initialData?: Transaction };
+export type Entity = {
+  get: (...params:string[]) => any;
+}
+
+export function HomebaseProvider(props: {config?:config, children:any}): any;
+export function useTransact(): [(transaction:Transaction) => any];
+export function useEntity(lookup: object | number): [Entity];
+export function useQuery(query: object, ...args: any): [Array<Entity>];

types/tests/index.test-d.ts

@@ -0,0 +1,15 @@
+import {expectType, expectError} from 'tsd';
+import { HomebaseProvider, useTransact, useEntity, useQuery, Entity, Transaction} from '../index';
+
+expectType<any>(HomebaseProvider({children: []}));
+expectError(HomebaseProvider("a"));
+expectError(HomebaseProvider(1));
+
+expectType<[(transaction: Transaction) => any]>(useTransact());
+expectError(useTransact("blurb"));
+
+expectType<[Entity]>(useEntity(1));
+expectError(useEntity());
+
+expectType<[Entity[]]>(useQuery({}));
+expectError(useQuery("d"));