Update Pulse to 3.1.0 (#128)

Develop — updates

Author: maxichrome

.gitignore

@@ -25,6 +25,8 @@ private/
 *.sw*
 
 # Generated files from build
+build/
+declarations/
 dist/
 docs/dist/
 

.npmignore

@@ -1,2 +1,3 @@
 examples
-test
+test
+build/

_config.yml

@@ -0,0 +1,7 @@
+please do NOT change any config files without consulting Jamie first! Thanks :P
+
+handy command to remove accidental build files in lib
+
+```
+rm -f lib/**/*.(js|js.map)
+```

config/readme.md

@@ -0,0 +1,8 @@
+{
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../dist",
+    "declaration": true,
+    "declarationDir": "../dist"
+  }
+}

config/tsconfig.dev.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "declaration": true,
+    "declarationDir": "../declarations"
+  }
+}

config/tsconfig.prod.json

@@ -0,0 +1,14 @@
+const base = require('../webpack.config');
+
+module.exports = {
+  ...base('dev'),
+  name: 'dev',
+  mode: 'development',
+  devtool: 'inline-source-map',
+  watch: true,
+  entry: {
+    index: './lib/index.ts',
+    next: './lib/next'
+  },
+  plugins: []
+};

config/webpack.config.dev.js

@@ -0,0 +1,37 @@
+const base = require('../webpack.config');
+const dts = require('dts-bundle-webpack');
+const TerserPlugin = require('terser-webpack-plugin');
+
+module.exports = {
+  ...base('prod'),
+  name: 'build',
+  mode: 'production',
+  devtool: 'hidden-source-map',
+  entry: {
+    index: './lib/index.ts',
+    next: './lib/next'
+  },
+  optimization: {
+    minimize: true,
+    minimizer: [
+      new TerserPlugin({
+        terserOptions: {
+          keep_classnames: true,
+          keep_fnames: true
+        }
+      })
+    ]
+  },
+  plugins: [
+    new dts({
+      name: 'pulse-framework',
+      main: 'declarations/index.d.ts',
+      out: '../dist/index.d.ts'
+    }),
+    new dts({
+      name: 'pulse-framework/next',
+      main: 'declarations/next/index.d.ts',
+      out: '../../dist/next.d.ts'
+    })
+  ]
+};

config/webpack.config.prod.js

@@ -121,7 +121,7 @@ module.exports = {
         {
           title: 'Getting Started',
           collapsable: false,
-          children: ['getting-started/setup-with-react', 'getting-started/concepts']
+          children: ['getting-started/setup-with-react', 'getting-started/setup-with-vue', 'getting-started/concepts']
         },
         {
           title: 'Documentation',
@@ -136,6 +136,7 @@ module.exports = {
             'docs/core',
             'docs/api',
             'docs/persisting-data',
+            'docs/events',
             'docs/ssr'
           ]
         },

docs/.vuepress/config.js

@@ -1,24 +1,24 @@
 ---
 title: API
 ---
-
 ## Introduction
-
+::: warning Sorry!
+This page is not up to standards, improvements need to be made inline with the rest of the documentation.
+:::
 # API
 
 This is Pulse's integrated fetch API. It's a wrapper around Fetch, which is native to the browser environment.
-
+```ts
+const MyAPI = App.API()
+```
 ## Setup
-
-To create an api instance, you must pass a config object. This will define several things such as the options, baseurl, path, timeout and some functions to run before and after each http request.
-
+The API class accepts a config object.
 ```ts
 const MyAPI = App.API({
   options: {
     headers: {
       'content-type': 'application/json, text/plain' // this is not necessary
     }
-    // ...
   },
   baseURL: 'https://api.mysite.co', // default: 'https://localhost'
   path: '/api', // default: '/'
@@ -71,9 +71,9 @@ interface PulseResponse<DataType = any> {
 }
 ```
 
-**Available functions and Properties**
+## Methods
 
-## `API.with()`
+# `.with()`
 
 This function allows you to override the API config and request options. It returns a modified instance of the original API with the options in the config parameter overriding the original config options.
 
@@ -85,7 +85,7 @@ This function allows you to override the API config and request options. It retu
 
 - [response (Response)](#response)
 
-## `API.get()`
+# `.get()`
 
 Send a HTTP get request to a url
 
@@ -98,7 +98,7 @@ Send a HTTP get request to a url
 
 - [response (Response)](#response)
 
-## `API.post()`
+# `.post()`
 
 Send a HTTP post request to a URL
 
@@ -112,7 +112,7 @@ Send a HTTP post request to a URL
 
 - [response (Response)](#response)
 
-## `API.put()`
+# `.put()`
 
 Send a HTTP put request to a URL
 
@@ -126,7 +126,7 @@ Send a HTTP put request to a URL
 
 - [response (Response)](#response)
 
-## `API.patch()`
+# `.patch()`
 
 Send a HTTP patch request to a URL
 
@@ -140,7 +140,7 @@ Send a HTTP patch request to a URL
 
 - [Response (response)](#response)
 
-## `API.delete()`
+# `.delete()`
 
 Send a HTTP delete request to a URL