Merge remote-tracking branch 'origin/feat/migrate-index-js-to-typescript' into beta

Author: JonaszJestem

.eslintrc.js

@@ -8,13 +8,7 @@ module.exports = {
     'plugin:react/recommended',
     'plugin:@typescript-eslint/recommended',
   ],
-  ignorePatterns: [
-    '*/build/**/*',
-    '*.json',
-    '*.txt',
-    'yarn.lock',
-    '*.yaml',
-  ],
+  ignorePatterns: ['*/build/**/*', '*.json', '*.txt', 'yarn.lock', '*.yaml'],
   parser: '@typescript-eslint/parser',
   parserOptions: {
     ecmaFeatures: {
@@ -23,38 +17,35 @@ module.exports = {
     ecmaVersion: 11,
     sourceType: 'module',
   },
-  plugins: [
-    'react',
-    '@typescript-eslint',
-  ],
+  plugins: ['react', '@typescript-eslint'],
   rules: {
-    semi: ['error', 'never'],
+    semi: ['error', 'always'],
     'no-unused-vars': 'off',
     'import/extensions': 'off',
     'import/no-unresolved': 'off',
     'react/jsx-filename-extension': 'off',
-    indent: [
-      'error',
-      2,
-    ],
+    indent: ['error', 2],
     'linebreak-style': ['error', 'unix'],
     'object-curly-newline': 'off',
     '@typescript-eslint/no-explicit-any': 'off',
   },
-  overrides: [{
-    files: ['*.tsx'],
-    rules: {
-      'react/prop-types': 'off',
-      'react/jsx-props-no-spreading': 'off',
-      'import/no-extraneous-dependencies': 'off',
+  overrides: [
+    {
+      files: ['*.tsx'],
+      rules: {
+        'react/prop-types': 'off',
+        'react/jsx-props-no-spreading': 'off',
+        'import/no-extraneous-dependencies': 'off',
+      },
     },
-  }, {
-    files: ['./src/**/*.spec.ts', 'spec/*.ts'],
-    rules: {
-      'no-unused-expressions': 'off',
-      'prefer-arrow-callback': 'off',
-      'func-names': 'off',
-      'import/no-extraneous-dependencies': 'off',
+    {
+      files: ['./src/**/*.spec.ts', 'spec/*.ts'],
+      rules: {
+        'no-unused-expressions': 'off',
+        'prefer-arrow-callback': 'off',
+        'func-names': 'off',
+        'import/no-extraneous-dependencies': 'off',
+      },
     },
-  }],
-}
+  ],
+};

config/config.js

@@ -6,5 +6,6 @@ module.exports = {
     database: process.env.POSTGRES_DATABASE || 'database_test',
     host: process.env.POSTGRES_HOST || 'localhost',
     dialect: 'postgres',
+    logging: false,
   },
 }

example-app/package.json

@@ -6,7 +6,7 @@
   "scripts": {
     "build": "tsc",
     "start": "yarn build && node build/index.js",
-    "start:dev": "concurrently \"yarn build --watch\" \"nodemon --ext '.js' --watch ../build --watch ./build --ignore 'cypress/**/*.js' node build/src/index.js\"",
+    "dev": "SKIP_SYNC=true concurrently \"wait-on build/src/index.js && nodemon --ext '.js' --watch ../build --watch ./build --ignore 'cypress/**/*.js' node build/src/index.js\" \"yarn build --watch\"",
     "cypress:open": "cypress open",
     "cypress:run": "cypress run"
   },
@@ -16,7 +16,8 @@
     "cypress": "^4.11.0",
     "nodemon": "^2.0.4",
     "ts-node": "^8.10.2",
-    "typescript": "^3.9.7"
+    "typescript": "^3.9.7",
+    "wait-on": "^5.2.0"
   },
   "dependencies": {
     "@admin-bro/express": "^3.0.0",

example-app/src/connect.ts

@@ -27,7 +27,9 @@ const connect = async (): Promise<Sequelize> => {
     console.error('Unable to connect to the database:', error)
   }
 
-  await sequelize.sync({ force: true })
+  if (!process.env.SKIP_SYNC) {
+    await sequelize.sync({ force: true })
+  }
   return sequelize
 }
 

example-app/yarn.lock

@@ -1119,6 +1119,35 @@
   resolved "https://registry.yarnpkg.com/@emotion/utils/-/utils-0.8.2.tgz#576ff7fb1230185b619a75d258cbc98f0867a8dc"
   integrity sha512-rLu3wcBWH4P5q1CGoSSH/i9hrXs7SlbRLkoq9IGuoPYNGQvDJ3pt/wmOM+XgYjIDRMVIdkUWt0RsfzF50JfnCw==
 
+"@hapi/address@^4.1.0":
+  version "4.1.0"
+  resolved "https://registry.yarnpkg.com/@hapi/address/-/address-4.1.0.tgz#d60c5c0d930e77456fdcde2598e77302e2955e1d"
+  integrity sha512-SkszZf13HVgGmChdHo/PxchnSaCJ6cetVqLzyciudzZRT0jcOouIF/Q93mgjw8cce+D+4F4C1Z/WrfFN+O3VHQ==
+  dependencies:
+    "@hapi/hoek" "^9.0.0"
+
+"@hapi/formula@^2.0.0":
+  version "2.0.0"
+  resolved "https://registry.yarnpkg.com/@hapi/formula/-/formula-2.0.0.tgz#edade0619ed58c8e4f164f233cda70211e787128"
+  integrity sha512-V87P8fv7PI0LH7LiVi8Lkf3x+KCO7pQozXRssAHNXXL9L1K+uyu4XypLXwxqVDKgyQai6qj3/KteNlrqDx4W5A==
+
+"@hapi/hoek@^9.0.0":
+  version "9.1.0"
+  resolved "https://registry.yarnpkg.com/@hapi/hoek/-/hoek-9.1.0.tgz#6c9eafc78c1529248f8f4d92b0799a712b6052c6"
+  integrity sha512-i9YbZPN3QgfighY/1X1Pu118VUz2Fmmhd6b2n0/O8YVgGGfw0FbUYoA97k7FkpGJ+pLCFEDLUmAPPV4D1kpeFw==
+
+"@hapi/pinpoint@^2.0.0":
+  version "2.0.0"
+  resolved "https://registry.yarnpkg.com/@hapi/pinpoint/-/pinpoint-2.0.0.tgz#805b40d4dbec04fc116a73089494e00f073de8df"
+  integrity sha512-vzXR5MY7n4XeIvLpfl3HtE3coZYO4raKXW766R6DZw/6aLqR26iuZ109K7a0NtF2Db0jxqh7xz2AxkUwpUFybw==
+
+"@hapi/topo@^5.0.0":
+  version "5.0.0"
+  resolved "https://registry.yarnpkg.com/@hapi/topo/-/topo-5.0.0.tgz#c19af8577fa393a06e9c77b60995af959be721e7"
+  integrity sha512-tFJlT47db0kMqVm3H4nQYgn6Pwg10GTZHb1pwmSiv1K4ks6drQOtfEF5ZnPjkvC+y4/bUPHK+bc87QvLcL+WMw==
+  dependencies:
+    "@hapi/hoek" "^9.0.0"
+
 "@samverschueren/stream-to-observable@^0.3.0":
   version "0.3.0"
   resolved "https://registry.yarnpkg.com/@samverschueren/stream-to-observable/-/stream-to-observable-0.3.0.tgz#ecdf48d532c58ea477acfcab80348424f8d0662f"
@@ -3129,6 +3158,17 @@ jest-worker@^26.0.0:
     merge-stream "^2.0.0"
     supports-color "^7.0.0"
 
+joi@^17.1.1:
+  version "17.2.1"
+  resolved "https://registry.yarnpkg.com/joi/-/joi-17.2.1.tgz#e5140fdf07e8fecf9bc977c2832d1bdb1e3f2a0a"
+  integrity sha512-YT3/4Ln+5YRpacdmfEfrrKh50/kkgX3LgBltjqnlMPIYiZ4hxXZuVJcxmsvxsdeHg9soZfE3qXxHC2tMpCCBOA==
+  dependencies:
+    "@hapi/address" "^4.1.0"
+    "@hapi/formula" "^2.0.0"
+    "@hapi/hoek" "^9.0.0"
+    "@hapi/pinpoint" "^2.0.0"
+    "@hapi/topo" "^5.0.0"
+
 "js-tokens@^3.0.0 || ^4.0.0", js-tokens@^4.0.0:
   version "4.0.0"
   resolved "https://registry.yarnpkg.com/js-tokens/-/js-tokens-4.0.0.tgz#19203fb59991df98e3a287050d4647cdeaf32499"
@@ -4441,6 +4481,13 @@ rxjs@^6.3.3, rxjs@^6.5.2:
   dependencies:
     tslib "^1.9.0"
 
+rxjs@^6.5.5:
+  version "6.6.3"
+  resolved "https://registry.yarnpkg.com/rxjs/-/rxjs-6.6.3.tgz#8ca84635c4daa900c0d3967a6ee7ac60271ee552"
+  integrity sha512-trsQc+xYYXZ3urjOiJOuCOa5N3jAZ3eiSpQB5hIT8zGlL2QfnHLJ2r7GMkBGuIausdJN1OneaI6gQlsqNHHmZQ==
+  dependencies:
+    tslib "^1.9.0"
+
 safe-buffer@5.1.2, safe-buffer@~5.1.0, safe-buffer@~5.1.1:
   version "5.1.2"
   resolved "https://registry.yarnpkg.com/safe-buffer/-/safe-buffer-5.1.2.tgz#991ec69d296e0313747d59bdfd2b745c35f8828d"
@@ -5176,6 +5223,17 @@ void-elements@^2.0.1:
   resolved "https://registry.yarnpkg.com/void-elements/-/void-elements-2.0.1.tgz#c066afb582bb1cb4128d60ea92392e94d5e9dbec"
   integrity sha1-wGavtYK7HLQSjWDqkjkulNXp2+w=
 
+wait-on@^5.2.0:
+  version "5.2.0"
+  resolved "https://registry.yarnpkg.com/wait-on/-/wait-on-5.2.0.tgz#6711e74422523279714a36d52cf49fb47c9d9597"
+  integrity sha512-U1D9PBgGw2XFc6iZqn45VBubw02VsLwnZWteQ1au4hUVHasTZuFSKRzlTB2dqgLhji16YVI8fgpEpwUdCr8B6g==
+  dependencies:
+    axios "^0.19.2"
+    joi "^17.1.1"
+    lodash "^4.17.19"
+    minimist "^1.2.5"
+    rxjs "^6.5.5"
+
 warning@^4.0.2, warning@^4.0.3:
   version "4.0.3"
   resolved "https://registry.yarnpkg.com/warning/-/warning-4.0.3.tgz#16e9e077eb8a86d6af7d64aa1e05fd85b4678ca3"

index.d.ts

@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/no-var-requires */
 /**
  * @module @admin-bro/sequelize
  * @subcategory Adapters
@@ -79,7 +78,8 @@
  * @type {typeof BaseDatabase}
  * @static
  */
-const Database = require('./build/database').default
+import type { BaseDatabase, BaseResource } from 'admin-bro';
+import Database from './src/database';
 
 /**
  * Implementation of {@link BaseResource} for Sequelize Adapter
@@ -88,6 +88,10 @@ const Database = require('./build/database').default
  * @type {typeof BaseResource}
  * @static
  */
-const Resource = require('./build/resource').default
+import Resource from './src/resource';
 
-module.exports = { Database, Resource }
+module.exports = { Database, Resource };
+
+const SequelizeAdapter = { Database, Resource };
+
+export default SequelizeAdapter;

index.js renamed to index.ts

@@ -0,0 +1,13 @@
+module.exports = (sequelize, DataTypes) => {
+  const Comment = sequelize.define('Comment', {
+    id: {
+      primaryKey: true,
+      type: DataTypes.UUID,
+      defaultValue: sequelize.UUIDV4,
+    },
+    title: DataTypes.STRING,
+    description: DataTypes.STRING,
+    publishedAt: DataTypes.DATE,
+  }, {})
+  return Comment
+}

models/comment.js

@@ -1,12 +1,14 @@
 {
   "name": "@admin-bro/sequelize",
-  "version": "1.1.0-beta.1",
+  "version": "1.2.1",
   "description": "Sequelize adapter for AdminBro",
   "main": "build/index.js",
   "types": "index.d.ts",
   "scripts": {
     "build": "tsc",
+    "dev": "tsc --watch",
     "test": "mocha -r ts-node/register src/*.spec.ts",
+    "check:all": "yarn build && yarn test && yarn lint",
     "cover": "NODE_ENV=test ./node_modules/nyc/bin/nyc.js --reporter=html -x=spec -x=coverage  --all=true npm test",
     "sequelize": "sequelize",
     "lint": "eslint ./src/**/*.ts",
@@ -37,7 +39,7 @@
     "@types/sinon-chai": "^3.2.4",
     "@typescript-eslint/eslint-plugin": "^3.7.0",
     "@typescript-eslint/parser": "^3.7.0",
-    "admin-bro": "^3.2.3",
+    "admin-bro": "^3.4.0",
     "chai": "^4.2.0",
     "eslint": "^7.5.0",
     "eslint-config-airbnb": "^18.2.0",

package.json

@@ -35,7 +35,7 @@ describe('Database', () => {
   describe('#resources', () => {
     it('fetches all resources when entire db is given', () => {
       const database = new Database(db)
-      expect(database.resources()).to.have.lengthOf(2)
+      expect(database.resources()).to.have.lengthOf(Object.keys(db.sequelize.models).length)
       expect(database.resources()[0]).to.be.an.instanceof(Resource)
     })