Alpha version

Author: matrunchyk

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "vue-model",
-  "version": "0.0.2",
+  "version": "0.1.0",
   "description": "A library based on Model-Repository patterns for Vue components. Usable for GraphQL and RESTful APIs.",
   "keywords": [
     "collections",
@@ -33,7 +33,7 @@
     "bundlesize": "npm run build && bundlesize",
     "dev": "tsc -w",
     "test": "NODE_ENV=test nyc --reporter lcovonly --reporter=text --reporter=text-summary mocha && codecov",
-    "test:watch": "mocha -w ./test/*.spec.js"
+    "test:watch": "mocha -w"
   },
   "dependencies": {
     "clone": "^2.1.2",
@@ -51,6 +51,8 @@
     "@types/mocha": "^5.2.7",
     "@types/node": "^12.7.8",
     "@types/uuid": "^3.4.5",
+    "@types/fetch-mock": "^7.3.1",
+    "@types/vue": "^2.0.0",
     "bundlesize": "^0.18.0",
     "chai": "^4.2.0",
     "danger": "^9.2.1",
@@ -59,11 +61,16 @@
     "ts-node": "^8.4.1",
     "typescript": "^3.6.3",
     "vue": "^2.6.10",
-    "vue-apollo": "^3.0.0-rc.7"
+    "vue-apollo": "^3.0.0-rc.7",
+    "apollo-client": "^2.4.1",
+    "apollo-link-http-common": "^0.2.15",
+    "chai-fetch-mock": "^2.0.0",
+    "fetch-mock": "^7.4.0"
   },
   "peerDependencies": {
     "vue": "^2.6.10",
-    "vue-apollo": "^3.0.0-rc.7"
+    "vue-apollo": "^3.0.0-rc.7",
+    "apollo-client": "^2.4.1"
   },
   "publishConfig": {
     "registry": "https://npm.pkg.github.com/@matrunchyk"

package.json

@@ -1,35 +1,68 @@
-import Vue, {PluginObject} from 'vue';
+import _Vue from 'vue';
 import BaseModel from './models/BaseModel';
 import BaseRepository from './repositories/BaseRepository';
 import Container from './Container';
-import {Config} from '@/typings';
+import * as Utils from './utils';
 
 const container = Container.getInstance();
 
 container.set('BaseModel', BaseModel);
 container.set('BaseRepository', BaseRepository);
 
-export default class VueModel implements PluginObject<Config> {
-  [key: string]: any;
+export class VueModelOptions {
+  /**
+   * Use REST plugin.
+   *
+   * @type {boolean}
+   */
+  rest = true;
 
-  install(pVue: typeof Vue, defaultConfig: Config = {}) {
-    const config = {
-      rest: true,
-      graphql: false,
-      ...defaultConfig,
-    };
+  /**
+   * Use GraphQL plugin
+   *
+   * @type {boolean}
+   */
+  graphql = false;
 
-    container.set('Vue', pVue);
-    container.set('Config', config);
+  /**
+   * GraphQL Schema to parse for update variables guesser.
+   *
+   * @type {null}
+   */
+  schema: string = null;
 
-    pVue.prototype.$container = container;
-  }
-};
+  /**
+   * Debug mode
+   *
+   * @type {boolean}
+   */
+  debug = false;
+}
 
+function VueModel<VueModelOptions>(Vue: typeof _Vue, options?: VueModelOptions): void {
+  const config = {
+    rest: true,
+    graphql: false,
+    schema: null,
+    debug: false,
+    ...options,
+  };
+
+  container.set('Vue', Vue);
+  container.set('Config', config);
+
+  Vue.prototype.$container = container;
+}
+
+export default VueModel;
 export {default as Container} from './Container';
 export {default as BaseRepository} from './repositories/BaseRepository';
 export {default as BaseModel} from './models/BaseModel';
 export {default as Collection} from './models/Collection';
 export {default as BaseException} from './models/Exceptions/BaseException';
 export {default as InvalidArgumentException} from './models/Exceptions/InvalidArgumentException';
 export {default as UnexpectedException} from './models/Exceptions/UnexpectedException';
+export {default as UnauthorizedException} from './models/Exceptions/UnauthorizedException';
+export {default as ValidationException} from './models/Exceptions/ValidationException';
+export {Utils, VueModel};
+

src/index.ts

@@ -1,18 +1,9 @@
 import camelCase from 'lodash.camelcase';
 import clone from 'clone';
 import uuid from 'uuid';
-import {performSafeRequestREST, performSafeRequestGraphql, config, getSchemaTypeFields} from '@/utils';
+import getUrl, {performSafeRequestREST, performSafeRequestGraphql, config, getSchemaTypeFields} from '@/utils';
 import Collection from './Collection';
-
-type KeyValueString = { [key: string]: string };
-
-type UrlResolver = (params?: KeyValueString, collection?: boolean) => string;
-
-type ResolvingRESTOptions = {
-  method: string;
-  url: string | UrlResolver;
-  params: unknown;
-}
+import {ResolvingRESTOptions} from '@/typings';
 
 export default abstract class BaseModel {
   public id: string;
@@ -31,7 +22,8 @@ export default abstract class BaseModel {
 
   protected performSafeRequestREST = performSafeRequestREST;
 
-  protected constructor(props) {
+  //noinspection TypeScriptAbstractClassConstructorCanBeMadeProtected
+  public constructor(props = {}) {
     //@ts-ignore
     if (typeof this.defaults === 'function') {
       console.warn('Deprecated: Use property variables or constructor instead. `defaults` will be removed in the next versions.');
@@ -101,32 +93,6 @@ export default abstract class BaseModel {
     return null;
   }
 
-  protected async getUrl(_opts: ResolvingRESTOptions) {
-    const {url, params} = _opts;
-    let resolvedUrl = url;
-
-    if (typeof url === 'function') {
-      resolvedUrl = await url();
-    } else {
-      resolvedUrl = (resolvedUrl as string).replace(
-        /:([^\s\/]+)/gi,
-        (_, m) => {
-          const param = params[m];
-          const hasParam = param !== undefined;
-
-          if (hasParam) {
-            delete params[m];
-            return param;
-          }
-
-          return m;
-        },
-      );
-    }
-
-    return resolvedUrl;
-  }
-
   public toCollection(skipEmpty = false) {
     return (new Collection(this)).filter(i => !!i || !skipEmpty);
   }
@@ -196,11 +162,11 @@ export default abstract class BaseModel {
   public async mutate(mutationOrUrl, params, method = this.defaultMethod) {
     if (config().graphql) {
       return this.beforeMutate()
-        .then(this.performSafeRequestGraphql.bind(this, mutationOrUrl, params))
+        .then(this.performSafeRequestGraphql.bind(this, mutationOrUrl, params, null))
         .finally(this.afterMutate.bind(this));
     }
 
-    const resolvedUrl = await this.getUrl({method, url: mutationOrUrl, params});
+    const resolvedUrl = await getUrl({method, url: mutationOrUrl, params});
     const resolvedMethod = await this.getMethod({method, url: resolvedUrl, params});
 
     return this.beforeMutate()

src/models/BaseModel.ts

@@ -1,51 +1,11 @@
-import {GraphQLError} from 'graphql';
+import {GraphQLError, DocumentNode} from 'graphql';
 import InvalidArgumentException from '../models/Exceptions/InvalidArgumentException';
 import Collection from '../models/Collection';
-import {config, performSafeRequestREST, performSafeRequestGraphql} from '@/utils';
+import getUrl, {config, performSafeRequestREST, performSafeRequestGraphql} from '@/utils';
 import UnexpectedException from '@/models/Exceptions/UnexpectedException';
 import ValidationException from '@/models/Exceptions/ValidationException';
 import UnauthorizedException from '@/models/Exceptions/UnauthorizedException';
-
-type KeyValueString = { [key: string]: string };
-
-type UrlResolver = (params?: KeyValueString, collection?: boolean) => string;
-
-type ResolvingRESTOptions = {
-  method: string;
-  url: string | UrlResolver;
-  params: unknown;
-}
-
-type PropertyFunction<T> = () => T;
-
-type HttpMethod = 'get' | 'post' | 'put' | 'delete' | 'patch';
-
-type GraphQLErrorType = {
-  extensions: {
-    errorCode: number,
-    message: string,
-  },
-}
-
-type GraphQLErrorBag = {
-  graphQLErrors: GraphQLErrorType[];
-}
-
-export type EventType = {
-  type: string;
-  target: unknown;
-  payload?: unknown;
-};
-
-type EventSubscriber = {
-  fired?: boolean;
-  immediate: boolean;
-  callback: (event: EventType) => void;
-};
-
-type EventListeners = {
-  [key: string]: EventSubscriber[];
-}
+import {EventListeners, EventType, GraphQLErrorBag, KeyValueString, PropertyFunction, ResolvingRESTOptions, UrlResolver, HttpMethod} from '@/typings';
 
 export default abstract class BaseRepository<M = unknown> {
   /**
@@ -94,7 +54,8 @@ export default abstract class BaseRepository<M = unknown> {
    */
   public queryParams: KeyValueString = {};
 
-  public subscriptions() {
+  public subscriptions(): unknown[] {
+    return [];
   }
 
   /**
@@ -160,32 +121,6 @@ export default abstract class BaseRepository<M = unknown> {
     return null;
   }
 
-  protected async getUrl(_opts: ResolvingRESTOptions) {
-    const {url, params} = _opts;
-    let resolvedUrl = url;
-
-    if (typeof url === 'function') {
-      resolvedUrl = await url();
-    } else {
-      resolvedUrl = (resolvedUrl as string).replace(
-        /:([^\s\/]+)/gi,
-        (_, m) => {
-          const param = params[m];
-          const hasParam = param !== undefined;
-
-          if (hasParam) {
-            delete params[m];
-            return param;
-          }
-
-          return m;
-        },
-      );
-    }
-
-    return resolvedUrl;
-  }
-
   public fromArray(array: unknown[], skipEmpty = true) {
     //@ts-ignore
     return new Collection(array.filter(i => i || !skipEmpty).map(i => new this.model(i)));
@@ -235,12 +170,12 @@ export default abstract class BaseRepository<M = unknown> {
    * @param {string} method
    * @returns {Promise<Collection|BaseModel>}
    */
-  public async query(queryOrUrl: string | UrlResolver, params: KeyValueString = {}, collection = false, method: HttpMethod = this.defaultMethod) {
+  public async query(queryOrUrl: string | UrlResolver | DocumentNode, params: KeyValueString = {}, collection = false, method: HttpMethod = this.defaultMethod) {
     if (config().graphql) {
-      let doc = queryOrUrl;
+      let doc = queryOrUrl as unknown as DocumentNode;
 
       if (typeof queryOrUrl === 'function') {
-        doc = await queryOrUrl();
+        doc = await queryOrUrl() as unknown as DocumentNode;
       }
 
       return this.beforeQuery()
@@ -252,7 +187,7 @@ export default abstract class BaseRepository<M = unknown> {
 
     this.method = method;
 
-    const resolvedUrl = await this.getUrl({method, url: queryOrUrl, params});
+    const resolvedUrl = await getUrl({method, url: queryOrUrl as string, params});
     const resolvedMethod = await this.getMethod({method, url: resolvedUrl, params});
 
     return this.beforeQuery()

src/repositories/BaseRepository.ts

@@ -3,3 +3,44 @@ export type Config = {
   rest?: boolean;
 }
 
+export type KeyValueString = { [key: string]: string };
+
+export type UrlResolver = (params?: KeyValueString, collection?: boolean) => string;
+
+export type ResolvingRESTOptions = {
+  method: string;
+  url: string | UrlResolver;
+  params: unknown;
+}
+
+export type PropertyFunction<T> = () => T;
+
+export type HttpMethod = 'get' | 'post' | 'put' | 'delete' | 'patch';
+
+export type GraphQLErrorType = {
+  extensions: {
+    errorCode: number,
+    message: string,
+  },
+}
+
+export type GraphQLErrorBag = {
+  graphQLErrors: GraphQLErrorType[];
+}
+
+export type EventType = {
+  type: string;
+  target: unknown;
+  payload?: unknown;
+};
+
+export type EventSubscriber = {
+  fired?: boolean;
+  immediate: boolean;
+  callback: (event: EventType) => void;
+};
+
+export type EventListeners = {
+  [key: string]: EventSubscriber[];
+}
+