Renaming to Vuex-ORM-GraphQL

Author: phortx

README.md

@@ -1,25 +1,18 @@
-# vuex-orm-apollo
+# vuex-orm-graphql
 
-[![Travis CI](https://travis-ci.org/vuex-orm/vuex-orm-apollo.svg?branch=master)](https://travis-ci.org/vuex-orm/vuex-orm-apollo)
+[![Travis CI](https://travis-ci.org/vuex-orm/vuex-orm-graphql.svg?branch=master)](https://travis-ci.org/vuex-orm/vuex-orm-graphql)
 [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
-[![License](https://img.shields.io/npm/l/@vuex-orm/vuex-orm-apollo.svg)](https://github.com/vuex-orm/vuex-orm-apollo/blob/master/LICENSE.md)
+[![License](https://img.shields.io/npm/l/@vuex-orm/vuex-orm-graphql.svg)](https://github.com/vuex-orm/vuex-orm-graphql/blob/master/LICENSE.md)
 
-This [Vuex-ORM](https://github.com/vuex-orm/vuex-orm) plugin uses the
-[apollo-client](https://www.apollographql.com/client/) to let you sync your Vuex state with
-a [GraphQL API](http://graphql.org/)
-
-
-## Documentation
-
-https://vuex-orm.github.io/vuex-orm-apollo/
+**Documentation:** https://vuex-orm.github.io/vuex-orm-graphql/
 
 
 ## Contribution
 
 To test this plugin in your existing project, you can use `yarn link` functionality. Run `yarn link` in your local
-vuex-orm-apollo directory and run `yarn link @vuex-orm/plugin-apollo` in your project dir.
+vuex-orm-graphql directory and run `yarn link @vuex-orm/plugin-graphql` in your project dir.
 
-Remember to run `yarn build` in your vuex-orm-apollo directory and then again `yarn link` in your project after you have
+Remember to run `yarn build` in your vuex-orm-graphql directory and then again `yarn link` in your project after you have
 made changes to the plugin code. You probably have also to restart your webpack server.
 
 
@@ -71,4 +64,4 @@ Deploys the documentation.
 
 ## License
 
-Vuex ORM Apollo is open-sourced software licensed under the [MIT license](https://github.com/phortx/vuex-orm-apollo/blob/master/LICENSE.md).
+Vuex ORM GraphQL is open-sourced software licensed under the [MIT license](https://github.com/phortx/vuex-orm-graphql/blob/master/LICENSE.md).

dist/vuex-orm-apollo.esm.js

@@ -3518,12 +3518,11 @@ var Logger = /** @class */ (function () {
          * Fancy Vuex-ORM-Apollo prefix for all log messages.
          * @type {string[]}
          */
-        this.PREFIX = process.env.NODE_ENV === 'test' ? ['[Vuex-ORM-Apollo]'] :
-            [
-                '%c Vuex-ORM: Apollo Plugin %c',
-                'background: #35495e; padding: 1px 0; border-radius: 3px; color: #eee;',
-                'background: transparent;'
-            ];
+        this.PREFIX = [
+            '%c Vuex-ORM: GraphQL Plugin %c',
+            'background: #35495e; padding: 1px 0; border-radius: 3px; color: #eee;',
+            'background: transparent;'
+        ];
         this.enabled = enabled;
         this.log('Logging is enabled.');
     }
@@ -3538,21 +3537,11 @@ var Logger = /** @class */ (function () {
             messages[_i] = arguments[_i];
         }
         if (this.enabled) {
-            if (process.env.NODE_ENV === 'test') {
-                if (console.group) {
-                    console.group.apply(console, this.PREFIX.concat(messages));
-                }
-                else {
-                    console.log.apply(console, this.PREFIX.concat(messages));
-                }
+            if (console.groupCollapsed) {
+                console.groupCollapsed.apply(console, this.PREFIX.concat(messages));
             }
             else {
-                if (console.groupCollapsed) {
-                    console.groupCollapsed.apply(console, this.PREFIX.concat(messages));
-                }
-                else {
-                    console.log.apply(console, this.PREFIX.concat(messages));
-                }
+                console.log.apply(console, this.PREFIX.concat(messages));
             }
         }
     };
@@ -9785,7 +9774,7 @@ var Context = /** @class */ (function () {
         this.debugMode = Boolean(options.debug);
         this.logger = new Logger(this.debugMode);
         if (!options.database) {
-            throw new Error('database param is required to initialize vuex-orm-apollo!');
+            throw new Error('database param is required to initialize vuex-orm-graphql!');
         }
     }
     /**
@@ -10123,8 +10112,8 @@ var Store = /** @class */ (function () {
      */
     Store.insertData = function (data, dispatch) {
         return __awaiter$1(this, void 0, void 0, function () {
-            var _this = this;
             var insertedData;
+            var _this = this;
             return __generator$1(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -11070,21 +11059,21 @@ var __generator$11 = (undefined && undefined.__generator) || function (thisArg,
 /**
  * Main class of the plugin. Setups the internal context, Vuex actions and model methods
  */
-var VuexORMApollo = /** @class */ (function () {
+var VuexORMGraphQL = /** @class */ (function () {
     /**
      * @constructor
      * @param {Components} components The Vuex-ORM Components collection
      * @param {Options} options The options passed to VuexORM.install
      */
-    function VuexORMApollo(components, options) {
+    function VuexORMGraphQL(components, options) {
         Context.setup(components, options);
-        VuexORMApollo.setupActions();
-        VuexORMApollo.setupModelMethods();
+        VuexORMGraphQL.setupActions();
+        VuexORMGraphQL.setupModelMethods();
     }
     /**
      * This method will setup following Vuex actions: fetch, persist, push, destroy, mutate
      */
-    VuexORMApollo.setupActions = function () {
+    VuexORMGraphQL.setupActions = function () {
         var context = Context.getInstance();
         context.components.rootActions.simpleQuery = SimpleQuery.call.bind(SimpleQuery);
         context.components.rootActions.simpleMutation = SimpleMutation.call.bind(SimpleMutation);
@@ -11099,7 +11088,7 @@ var VuexORMApollo = /** @class */ (function () {
      * This method will setup following model methods: Model.fetch, Model.mutate, Model.customQuery, record.$mutate,
      * record.$persist, record.$push, record.$destroy and record.$deleteAndDestroy, record.$customQuery
      */
-    VuexORMApollo.setupModelMethods = function () {
+    VuexORMGraphQL.setupModelMethods = function () {
         var context = Context.getInstance();
         // Register static model convenience methods
         context.components.Model.fetch = function (filter, bypassCache) {
@@ -11187,29 +11176,29 @@ var VuexORMApollo = /** @class */ (function () {
             });
         };
     };
-    return VuexORMApollo;
+    return VuexORMGraphQL;
 }());
 
 /**
  * Plugin class. This just provides a static install method for Vuex-ORM and stores the instance of the model
  * within this.instance.
  */
-var VuexORMApolloPlugin = /** @class */ (function () {
-    function VuexORMApolloPlugin() {
+var VuexORMGraphQLPlugin = /** @class */ (function () {
+    function VuexORMGraphQLPlugin() {
     }
     /**
-     * This is called, when VuexORM.install(VuexOrmApollo, options) is called.
+     * This is called, when VuexORM.install(VuexOrmGraphQL, options) is called.
      *
      * @param {Components} components The Vuex-ORM Components collection
      * @param {Options} options The options passed to VuexORM.install
-     * @returns {VuexORMApollo}
+     * @returns {VuexORMGraphQL}
      */
-    VuexORMApolloPlugin.install = function (components, options) {
-        var plugin = new VuexORMApolloPlugin();
-        plugin.instance = new VuexORMApollo(components, options);
+    VuexORMGraphQLPlugin.install = function (components, options) {
+        var plugin = new VuexORMGraphQLPlugin();
+        plugin.instance = new VuexORMGraphQL(components, options);
         return plugin.instance;
     };
-    return VuexORMApolloPlugin;
+    return VuexORMGraphQLPlugin;
 }());
 
-export default VuexORMApolloPlugin;
+export default VuexORMGraphQLPlugin;

docs/guide/README.md

@@ -24,7 +24,7 @@ You should have basic knowledge of [Vue](https://vuejs.org/), [Vuex](https://vue
 
 ## Actions
 
-While using Vuex-ORM with the Apollo plugin you have to distinct between two types of Vuex actions:
+While using Vuex-ORM with the GraphQL plugin you have to distinct between two types of Vuex actions:
 
 - Vuex-ORM actions: Retrieve data from or save data to Vuex (`Vue Component <--> Vuex Store`)
 - Persistence actions: Load data from or persist data to the GraphQL API (`Vuex Store <--> GraphQL Server`)
@@ -90,11 +90,11 @@ After [installing](/guide/setup) this plugin you can load data in your component
 ```
 
 ::: tip
-Vuex-ORM-Apollo works with the [Apollo Dev Tools](https://chrome.google.com/webstore/detail/apollo-client-developer-t/jdkknkkbebbapilgoeccciglkfbmbnfm)!
+Vuex-ORM-GraphQL works with the [Apollo Dev Tools](https://chrome.google.com/webstore/detail/apollo-client-developer-t/jdkknkkbebbapilgoeccciglkfbmbnfm)!
 :::
 
 
 ## License
 
-Vuex ORM Apollo is open-sourced software licensed under the
-[MIT license](https://github.com/phortx/vuex-orm-apollo/blob/master/LICENSE.md).
+Vuex-ORM-GraphQL is open-sourced software licensed under the
+[MIT license](https://github.com/phortx/vuex-orm-graphql/blob/master/LICENSE.md).

docs/guide/custom-queries/README.md

@@ -3,12 +3,12 @@
 [[toc]]
 
 With custom mutations and custom queries we distinguish between model related and model unrelated (simple) custom
-quries/mutations. The difference is that model related queries/mutations always are tied to a model, so Vuex-ORM-Apollo
+quries/mutations. The difference is that model related queries/mutations always are tied to a model, so Vuex-ORM-GraphQL
 expected that the query/mutation type is the same as the model. A model related custom mutation `upvotePost` is expected
 to be of type `Post`. To make this even clearer, all model related queries and mutations are called on a specific Model
 or a record of this model.
 
-A simple query or simple mutation is not tied to a model. And so Vuex-ORM-Apollo doesn't expect the result to be of a
+A simple query or simple mutation is not tied to a model. And so Vuex-ORM-GraphQL doesn't expect the result to be of a
 specific type. Also the return value is not automatically inserted in the Vuex store.
 
 
@@ -41,7 +41,7 @@ of the record into the arguments list. The plugin automatically determines if th
 record is requests by looking in the arguments hash if there is a `id` field and respectively setups the query.
 
 A model related custom query is always tied to the model, so the plugin expects the return value of the custom query
-is of the model type. In this example that means, that Vuex-ORM-Apollo expects that the `example` query is of type `Post`. 
+is of the model type. In this example that means, that Vuex-ORM-GraphQL expects that the `example` query is of type `Post`. 
 
 This generates the following query:
 
@@ -139,7 +139,7 @@ of the record into the arguments list. The plugin automatically determines if th
 record is requests by looking in the arguments hash if there is a `id` field and respectively setups the query.
 
 A model related custom mutation is always tied to the model, so the plugin expects the return value of the custom query
-is of the model type. In this example that means, that Vuex-ORM-Apollo expects that the `upvotePost` mutation is of type
+is of the model type. In this example that means, that Vuex-ORM-GraphQL expects that the `upvotePost` mutation is of type
 `Post`.
 
 This generates the following query:
@@ -220,7 +220,7 @@ Following fields are allowed:
 
 ## Multiple or single record
 
-Vuex-ORM-Apollo tries to determine automatically if a  single record or a connection (multiple records) is returned by
+Vuex-ORM-GraphQL tries to determine automatically if a  single record or a connection (multiple records) is returned by
 a query/mutation via checking if a `id` field is set in the filter/args/variables. But sometimes you have a
 query/mutation without ID but it still returns a single record or vice versa. For this case you can manually set the
 `multiple` field to tell the plugin how the result is shaped:

docs/guide/fetch/README.md

@@ -187,7 +187,7 @@ recommend the usage of async/await.
 
 ## Caching
 
-Apollo-Client caches same queries. To bypass caching set the second param of the `fetch` action to `true`
+The plugin caches same queries. To bypass caching set the second param of the `fetch` action to `true`
 when using the convenience method or add `bypassCache: true` to the arguments of the `dispatch()` call
 
 ```javascript

docs/guide/relationships/README.md

@@ -2,7 +2,7 @@
 
 [[toc]]
 
-This chapter describes how the Apollo-Plugin interacts with relationships. All relationships work out of the box.
+This chapter describes how the GraphQL-Plugin interacts with relationships. All relationships work out of the box.
 We take the examples from the [Vuex-ORM documentation for definition relationships](https://vuex-orm.github.io/vuex-orm/relationships/defining-relationships.html)
 and show what GraphQL queries will be generated.
 

docs/guide/setup/README.md

@@ -5,24 +5,24 @@
 
 ## Installation
 
-Installation of the Apollo plugin is easy. First add the package to your dependencies:
+Installation of the GraphQL plugin is easy. First add the package to your dependencies:
 
 ```bash
-$ yarn add @vuex-orm/plugin-apollo
+$ yarn add @vuex-orm/plugin-graphql
 ```
 
 or
 
 ```bash
-$ npm install --save @vuex-orm/plugin-apollo
+$ npm install --save @vuex-orm/plugin-graphql
 ```
 
 
 After that we setup the plugin. Add this after [registering your models to the database](https://vuex-orm.github.io/vuex-orm/prologue/getting-started.html#register-models-and-modules-to-the-vuex-store):
 
 ```javascript
-import VuexORMApollo from '@vuex-orm/plugin-apollo';
-VuexORM.use(VuexORMApollo, { database });
+import VuexORMGraphQL from '@vuex-orm/plugin-graphql';
+VuexORM.use(VuexORMGraphQL, { database });
 ```
 
 ## Possible options

docs/guide/virtual-fields/README.md

@@ -26,7 +26,7 @@ export default class Product extends Model {
 }
 ```
 
-With this model definition, the apollo plugin will produce the following GraphQL Query when `fetch` is called:
+With this model definition, the GraphQL plugin will produce the following GraphQL Query when `fetch` is called:
 
 ```graphql
 query Posts() {

package.json

@@ -1,10 +1,10 @@
 {
-  "name": "@vuex-orm/plugin-apollo",
-  "version": "1.0.0-rc.3",
-  "description": "Vuex-ORM Plugin to sync the data against a GraphQL API via Apollo.",
-  "main": "dist/vuex-orm-apollo.common.js",
-  "module": "dist/vuex-orm-apollo.esm.js",
-  "unpkg": "dist/vuex-orm-apollo.js",
+  "name": "@vuex-orm/plugin-graphql",
+  "version": "1.0.0-rc.4",
+  "description": "Vuex-ORM Plugin to sync the data against a GraphQL API.",
+  "main": "dist/vuex-orm-graphql.common.js",
+  "module": "dist/vuex-orm-graphql.esm.js",
+  "unpkg": "dist/vuex-orm-graphql.js",
   "typings": "lib/index.d.ts",
   "files": [
     "dist",
@@ -17,7 +17,7 @@
     "build:docs": "vuepress build docs",
     "clean": "rm -rf dist && rm -rf lib && rm -rf dist && rm -rf coverage && rm -rf .nyc_output && rm -rf .tmp",
     "lint": "tslint 'src/**/*.ts' -c tslint.json -p . --fix",
-    "test": "NODE_ENV=test mocha-webpack --webpack-config test/webpack.config.js --require test/bootstrap.js 'test/**/*.spec.js'",
+    "test": "mocha-webpack --webpack-config test/webpack.config.js --require test/bootstrap.js 'test/**/*.spec.js'",
     "test:watch": "mocha-webpack --webpack-config test/webpack.config.js --watch --require test/bootstrap.js 'test/**/*.spec.js'",
     "test:coverage": "mocha-webpack --webpack-config test/webpack.config.js --require test/bootstrap.js 'src/**/*.js' 'test/**/*.spec.js'",
     "coverage": "NODE_ENV=coverage nyc --reporter=lcov --reporter=text npm run test:coverage",
@@ -27,7 +27,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/vuex-orm/vuex-orm-apollo.git"
+    "url": "git+https://github.com/vuex-orm/vuex-orm-graphql.git"
   },
   "keywords": [
     "vue",
@@ -41,7 +41,7 @@
   "author": "Benjamin Klein",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/vuex-orm/vuex-orm-apollo/issues"
+    "url": "https://github.com/vuex-orm/vuex-orm-graphql/issues"
   },
   "dependencies": {
     "@types/graphql": "^0.12.3",

src/common/context.ts

@@ -51,7 +51,7 @@ export default class Context {
   public readonly debugMode: boolean = false;
 
   /**
-   * Our nice Vuex-ORM-Apollo logger
+   * Our nice Vuex-ORM-GraphQL logger
    * @type {Logger}
    */
   public readonly logger: Logger;
@@ -77,7 +77,7 @@ export default class Context {
     this.logger = new Logger(this.debugMode);
 
     if (!options.database) {
-      throw new Error('database param is required to initialize vuex-orm-apollo!');
+      throw new Error('database param is required to initialize vuex-orm-graphql!');
     }
   }