Prepare for 1.0.0-beta.1

Author: jmdobry

.babelrc

@@ -1,27 +1,37 @@
-# Contributing
+# Contributing to js-data-mongodb
 
-[Read the Contributing Guide](http://js-data.io/docs/contributing).
+[Read the general Contributing Guide](http://js-data.io/docs/contributing).
 
-## Support
+## Project structure
 
-[Find out how to Get Support](http://js-data.io/docs/support).
+* `dist/` - Contains final build files for distribution
+* `doc/` - Output folder for JSDocs
+* `src/` - Project source code
+* `test/` - Project tests
 
-## Community
+## Clone, build & test
 
-[Explore the Community](http://js-data.io/docs/community).
+1. `clone [email protected]:js-data/js-data-mongodb.git`
+1. `cd js-data-mongodb`
+1. `npm install`
+1. `npm run build` - Lint and build distribution files
+1. `npm run mocha` - Run tests (RethinkDB must be running)
 
-### Have write access?
-
-To cut a release:
+## To cut a release
 
 1. Checkout master
 1. Bump version in `package.json` appropriately
-1. Run `npm run release`
 1. Update `CHANGELOG.md` appropriately
-1. Commit and push changes, including the `dist/` folder
+1. Run `npm run release`
+1. Commit and push changes
+1. Checkout `release`, merge `master` into `release`
+1. Run `npm run release` again
+1. Commit and push changes
 1. Make a GitHub release
+  - tag from `release` branch
   - set tag name to version
   - set release name to version
   - set release body to changelog entry for the version
-  - attach the files in the `dist/` folder
 1. `npm publish .`
+
+See also [Community & Support](http://js-data.io/docs/community).

.github/CONTRIBUTING.md

@@ -1,7 +1,5 @@
-(delete this line) GitHub Issues are NOT for support questions.
-(delete this line) GitHub Issues ARE for bug reports, feature requests, and other issues.
-(delete this line) Find out how to Get Support here: http://js-data.io/docs/support.
+(delete this line) Find out how to get help here: http://js-data.io/docs/community.
 
-<your detailed, discussable, actionable, and helpful text goes here>
+<your detailed, actionable, and helpful text goes here>
 
 Thanks!

.github/ISSUE_TEMPLATE.md

@@ -1,8 +1,6 @@
 Fixes #<issue_number_goes_here> (it's a good idea to open an issue first for discussion)
 
 - [ ] - `npm test` succeeds
-- [ ] - Pull request has been squashed into 1 commit
-- [ ] - I did NOT commit changes to `dist/`
 - [ ] - Code coverage does not decrease (if any source code was changed)
 - [ ] - Appropriate JSDoc comments were updated in source code (if applicable)
 - [ ] - Approprate changes to js-data.io docs have been suggested ("Suggest Edits" button)

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,3 +1,33 @@
+##### 1.0.0-beta.1 - 30 April 2016
+
+###### Breaking changes
+- How you must now import in ES2015:
+
+    ```js
+    import MongoDBAdapter from 'js-data-mongodb'
+    const adapter = new MongoDBAdapter()
+    ```
+    or
+    ```js
+    import {MongoDBAdapter, version} from 'js-data-mongodb'
+    console.log(version)
+    const adapter = new MongoDBAdapter()
+    ```
+
+- How you must now import in ES5:
+
+    ```js
+    var JSDataMongoDB = require('js-data-mongodb')
+    var MongoDBAdapter = JSDataMongoDB.MongoDBAdapter
+    var adapter = new MongoDBAdapter()
+    ```
+
+- Moved some `dist` files to the `release` branch to reduce noise
+
+###### Other
+- Upgraded to `js-data-adapter` v0.6.1
+- Now using js-data JSDoc template
+
 ##### 1.0.0-alpha.6 - 17 March 2016
 
 ###### Backwards compatible API changes

.npmignore

@@ -7,74 +7,20 @@
 [![Circle CI][circle_b]][circle_l]
 [![npm downloads][dn_b]][dn_l]
 [![Coverage Status][cov_b]][cov_l]
-[![Codacy][cod_b]][cod_l]
 
 MongoDB adapter for [js-data](http://www.js-data.io/).
 
-## Table of contents
+To get started, visit __[http://js-data.io](http://www.js-data.io/docs/js-data-mongodb)__.
 
-* [Quick start](#quick-start)
-* [Guides and Tutorials](#guides-and-tutorials)
-* [API Reference Docs](#api-reference-docs)
-* [Community](#community)
-* [Support](#support)
-* [Contributing](#contributing)
-* [License](#license)
+## Links
 
-## Quick Start
-`npm install --save js-data js-data-mongodb mongodb bson`.
-
-```js
-// Use Container instead of DataStore on the server
-import {Container} from 'js-data'
-import MongoDBAdapter from 'js-data-mongodb'
-
-// Create a store to hold your Mappers
-const store = new Container({
-  mapperDefaults: {
-    // MongoDB uses "_id" as the primary key
-    idAttribute: '_id'
-  }
-})
-
-// Create an instance of MongoDBAdapter with default settings
-const adapter = new MongoDBAdapter()
-
-// Mappers in "store" will use the MongoDB adapter by default
-store.registerAdapter('mongodb', adapter, { default: true })
-
-// Create a Mapper that maps to a "user" collection
-store.defineMapper('user')
-```
-
-```js
-async function findAllAdminUsers () {
-  // Find all users where "user.role" == "admin"
-  return await store.findAll('user', {
-    role: 'admin'
-  })
-}
-```
-
-## Guides and Tutorials
-
-[Get started at http://js-data.io](http://js-data.io)
-
-## API Reference Docs
-
-[Visit http://api.js-data.io](http://api.js-data.io).
-
-## Community
-
-[Explore the Community](http://js-data.io/docs/community).
-
-## Support
-
-[Find out how to Get Support](http://js-data.io/docs/support).
-
-## Contributing
-
-[Read the Contributing Guide](http://js-data.io/docs/contributing).
+* [Quick start](http://www.js-data.io/docs/home#quick-start) - Get started in 5 minutes
+* [Guides and Tutorials](http://www.js-data.io/docs/home) - Learn how to use JSData
+* [`MongoDBAdapter` Guide](http://www.js-data.io/docs/js-data-mongodb) - Learn how to use `MongoDBAdapter`
+* [API Reference Docs](http://api.js-data.io) - Explore components, methods, options, etc.
+* [Community & Support](http://js-data.io/docs/community) - Find solutions and chat with the community
+* [General Contributing Guide](http://js-data.io/docs/contributing) - Give back and move the project forward
+  * [Contributing to js-data-mongodb](https://github.com/js-data/js-data-mongodb/blob/master/.github/CONTRIBUTING.md)
 
 ## License
 
@@ -90,11 +36,9 @@ Copyright (c) 2014-2016 js-data-mongodb project authors
 [sl_l]: http://slack.js-data.io
 [npm_b]: https://img.shields.io/npm/v/js-data-mongodb.svg?style=flat
 [npm_l]: https://www.npmjs.org/package/js-data-mongodb
-[circle_b]: https://img.shields.io/circleci/project/js-data/js-data-mongodb/master.svg?style=flat
-[circle_l]: https://circleci.com/gh/js-data/js-data-mongodb/tree/master
+[circle_b]: https://img.shields.io/circleci/project/js-data/js-data-mongodb.svg?style=flat
+[circle_l]: https://circleci.com/gh/js-data/js-data-mongodb
 [dn_b]: https://img.shields.io/npm/dm/js-data-mongodb.svg?style=flat
 [dn_l]: https://www.npmjs.org/package/js-data-mongodb
-[cov_b]: https://img.shields.io/coveralls/js-data/js-data-mongodb/master.svg?style=flat
-[cov_l]: https://coveralls.io/github/js-data/js-data-mongodb?branch=master
-[cod_b]: https://img.shields.io/codacy/1f45ede49dfb4bdea68f46ca55631968.svg
-[cod_l]: https://www.codacy.com/app/jasondobry/js-data-mongodb/dashboard
+[cov_b]: https://img.shields.io/codecov/c/github/js-data/js-data-mongodb.svg?style=flat
+[cov_l]: https://codecov.io/github/js-data/js-data-mongodb

CHANGELOG.md

@@ -12,16 +12,15 @@
     "package": "./package.json"
   },
   "templates": {
-    "theme": "lumen",
+    "theme": "jsdata",
     "systemName": "js-data-mongodb",
     "copyright": "js-data-mongodb Copyright © 2014-2016 js-data-mongodb project authors",
     "outputSourceFiles": true,
-    "syntaxTheme": "dark",
     "linenums": true,
-    "footer": "<div style=\"text-align:center\">Back to <a href=\"http://js-data.io\">js-data.io</a></div>",
+    "footer": "<div style=\"text-align:center\"><a href=\"/\">api.js-data.io</a>&nbsp;&#8226;&nbsp;<a href=\"http://js-data.io\">js-data.io</a></div>",
     "analytics": {
       "ua": "UA-55528236-2",
       "domain": "api.js-data.io"
     }
   }
-}
+}

README.md

@@ -0,0 +1,25 @@
+import {Adapter} from 'js-data-adapter'
+
+interface IDict {
+  [key: string]: any;
+}
+interface IBaseAdapter extends IDict {
+  debug?: boolean,
+  raw?: boolean
+}
+interface IBaseMongoDBAdapter extends IBaseAdapter {
+  translateId?: boolean
+  uri?: string
+}
+export class MongoDBAdapter extends Adapter {
+  static extend(instanceProps?: IDict, classProps?: IDict): typeof MongoDBAdapter
+  constructor(opts?: IBaseMongoDBAdapter)
+}
+export interface version {
+  full: string
+  minor: string
+  major: string
+  patch: string
+  alpha: string | boolean
+  beta: string | boolean
+}