Merge pull request #91 from knorm/v2

V2

README.md

@@ -7,56 +7,7 @@
 
 Timestamps plugin for [@knorm/knorm](https://www.npmjs.com/package/@knorm/knorm).
 
-This plugin adds the [knex timestamp](http://knexjs.org/#Schema-timestamps)
-fields to your models and also updates your query methods so that `createdAt`
-and `updatedAt` are set to the current time (i.e. `new Date()`) for `insert`
-calls and the `updatedAt` field is set to the current time for any `update`
-calls. It will also ensure that any `update` calls do not overwrite the
-`createdAt` field.
+## [Documentation](https://knorm.netlify.com/plugins/timestamps.html)
 
-## Installation
-
-```bash
-npm install --save @knorm/knorm @knorm/timestamps
-```
-
-> @knorm/timestamps has a peer dependency on [@knorm/knorm](https://www.npmjs.com/package/@knorm/knorm)
-
-## Usage
-
-```js
-const knorm = require('@knorm/knorm');
-const knormTimestamps = require('@knorm/timestamps');
-
-const orm = knorm({
-  // knorm options
-}).use(
-  knormTimestamps({
-    // knormTimestamps options
-  })
-);
-```
-
-## Options
-
-### name
-
-The name of the plugin, defaults to `'timestamps'`.
-
-### createdAt
-
-> type: object, default: `{ name: 'createdAt', column: 'created_at' }`
-
-The `createdAt` field can be configured with these options:
-
-* `name` _string, default: createdAt_: the field name
-* `column` _string, default: created_at_: the column name
-
-### updatedAt
-
-> type: object, default: `{ name: 'updatedAt', column: 'updated_at' }`
-
-The `updatedAt` field can be configured with these options:
-
-* `name` _string, default: updatedAt_: the field name
-* `column` _string, default: updated_at_: the column name
+View the docs on @knorm/knorm's documentation site
+[here](https://knorm.netlify.com/plugins/timestamps.html).

lib/KnormTimestamps.js

@@ -20,12 +20,16 @@ class KnormTimestamps {
   }
 
   updateModel(knorm) {
-    knorm.Model = class TimestampsModel extends knorm.Model {};
-    knorm.Model.fields = this.fields;
+    class TimestampsModel extends knorm.Model {}
+
+    TimestampsModel.fields = this.fields;
+
+    knorm.updateModel(TimestampsModel);
   }
 
   updateQuery(knorm) {
     const { updatedAtFieldName } = this;
+
     class TimestampsQuery extends knorm.Query {
       async update(data, options) {
         if (data) {
@@ -36,7 +40,8 @@ class KnormTimestamps {
         return super.update(data, options);
       }
     }
-    knorm.Model.Query = knorm.Query = TimestampsQuery;
+
+    knorm.updateQuery(TimestampsQuery);
   }
 
   init(knorm) {

package.json

@@ -9,19 +9,16 @@
     "test": "docker-compose run --rm knorm-timestamps",
     "test:mocha": "mocha --exit --recursive",
     "coverage": "nyc npm run test:mocha",
-    "coveralls": "nyc report --reporter=text-lcov | coveralls",
-    "postgres": "docker-compose exec postgres echo 'postgres running ...' || docker-compose up -d postgres",
-    "postgres:stop": "docker-compose stop postgres",
-    "postgres:remove": "docker-compose rm -sf postgres"
+    "coveralls": "nyc report --reporter=text-lcov | coveralls"
   },
   "author": "Joel Mukuthu <joelmukuthu@gmail.com>",
   "license": "MIT",
   "peerDependencies": {
-    "@knorm/knorm": "^1.9.0"
+    "@knorm/knorm": "^2.0.0"
   },
   "devDependencies": {
-    "@knorm/knorm": "1.11.2",
-    "@knorm/postgres": "1.3.4",
+    "@knorm/knorm": "2.0.0",
+    "@knorm/postgres": "2.0.0",
     "@semantic-release/changelog": "3.0.2",
     "@semantic-release/git": "7.0.8",
     "@semantic-release/github": "5.2.10",