Release version 3.0 via #103 from pulse-framework/3.0

3.0 is here baby!

Author: maxichrome

.babelrc

@@ -1,4 +1,8 @@
 {
-  "presets": ["@babel/preset-env"],
-  "plugins": [["@babel/plugin-transform-runtime"]]
+  "presets": [
+    "@babel/preset-env"
+  ],
+  "plugins": [
+    ["@babel/plugin-transform-runtime"]
+  ]
 }

.gitignore

@@ -1,5 +1,5 @@
 .DS_Store
-node_modules
+node_modules/
 out
 dist
 
@@ -24,3 +24,7 @@ sync.js
 
 # Generated docs assets
 docs/dist/
+
+# Generated files from build
+lib/*.js
+lib/*.js.map

.npmignore

@@ -0,0 +1,2 @@
+examples
+test

.prettierrc

@@ -1,10 +1,13 @@
 {
-  "useTabs": false, 
-  "printWidth": 80, 
-  "tabWidth": 2,   
+  "useTabs": false,
+  "printWidth": 150,
+  "tabWidth": 2,
   "singleQuote": true,
   "trailingComma": "none",
   "jsxBracketSameLine": false,
   "noSemi": false,
-  "rcVerbose": true
-}
+  "rcVerbose": true,
+  "ignoreChainWithDepth": 10,
+  "arrowParens": "avoid",
+  "semi": true
+}

.reposyncignore

@@ -0,0 +1 @@
+examples/react-typescript/node_modules

README.md

@@ -1,56 +1,32 @@
-# Pulse Framework
-
-Pulse is a global state and logic framework for reactive Javascript applications. Supporting frameworks like VueJS, React and React Native. Lightweight, modular and powerful, but most importantly friendly to beginners.
-
-Pulse replaces global state management solutions such as Redux, VueX and MobX, including HTTP libraries such as Axios, Fetch or Request.js. It makes your application more modular, ensuring you follow the best practices while writing significantly less code. Your Pulse code can be used in many different applications, such as a webapp in Vue and a mobile app in React native; if it uses Javascript, it can use Pulse.
-
-## Features
-
-- :gear: Modular structure ([Modules](https://pulsejs.org/v2/docs/modules.html))
-- :zap: Reactive data ([Reactivity](https://pulsejs.org/v2/docs/concepts.html#reactivity)) `pulse.something = somethingElse`
-- :robot: Computed data with automatic dependency tracking ([Computed](https://pulsejs.org/v2/docs/computed.html))
-- :first_quarter_moon: Lifecycle hooks [`watch()`]() / `onReady()` / `nextPulse()`
-- :gem: SSOT architecture (single source of truth)
-- :nerd_face: DB/ORM-like structure with [Collections](https://pulsejs.org/v2/docs/collections.html#collection-basics)
-- :sparkles: Automatic data normalization using [Collect](https://pulsejs.org/v2/docs/collections.html#what-is-data-normalization) `collection.collect()`
-- :lock: Model based [data validation](https://pulsejs.org/v2/docs/collections.html#models) with Collections
-- :timer_clock: Mutation history tracking with [smart undo]() `collection.undo()`
-- :crystal_ball: Dynamic relations between collections using [Populate]() `populate()`
-- :wrench: Wrappers for utils and services
-- :construction: Task queuing for race condition prevention
-- :telephone_receiver: Promise based HTTP requests and websocket connections (web sockets coming soon)
-- :hourglass_flowing_sand: Timed interval task handler using [Jobs]()
-- :bus: Event bus `pulse.on() / pulse.emit()`
-- :floppy_disk: Persisted data API for localStorage and async storage
-- :closed_book: Error logging & snapshot bug reporting (WIP)
-- :leaves: Lightweight (only 100KB) with 0 dependencies
-- :fire: Supports Vue, React and React Native
-- :yellow_heart: Well documented (I'm getting there...)
+# Pulse Framework `3.0`
 
-## Why Pulse?
-
-After exploring the many options for Javascript state libraries, including the popular VueX and Redux, I felt like I needed a simpler solution. I wanted to get more out of a library than just state management― something that could provide solid structure for the **entire** application. It needed to be structured and simple, but also scalable. This framework provides everything needed to get a reactive javascript front-end application working fast, taking care to follow best practices and to employ simple terminology that makes sense even to beginners.
+_Pulse is a global state and logic framework for reactive Typescript & Javascript applications. Supporting frameworks like VueJS, React and React Native._
 
-I built Pulse reflective of the architecture in which we use at Notify.me, and as a replacement for VueX at Notify also, making sure it is also compatible with React and vanilla environments. The team at Notify love it and I think you will too.
+Lightweight, modular and powerful. An alternative to `Redux`/`VueX`/`MobX` and request libraries such as `Axios`/`Request.js`. Use Pulse to creare a **_core_** state & logic library for your application; plug and play directly into any UI Framework.
 
-## Get involved
+Created by [@jamiepine]() | Sponsored and maintained by the [Notify Team]()
 
-If you wish contribute, that is very much welcome! But please reach out first so we don't work on the same thing at the same time, twitter dm @jamiepine or Discord jam#0001
-[Join Community Discord](https://discord.gg/RjG8ShB)
+### Official website: [pulsejs.org](https://pulsejs.org/v3/introduction/what-is-pulse.html)
 
-FULL DOCUMENTATION HERE: [pulsejs.org](https://pulsejs.org)
-
-<p align="center">
-  <a href="https://patreon.com/jamiepine"><img src="https://img.shields.io/badge/donate-patreon-F96854.svg" alt="Donate on patreon"></a>
-  <a href="https://twitter.com/jamiepine"><img src="https://img.shields.io/twitter/follow/jamiepine.svg?label=Follow" alt="Follow on twitter"></a>
-  <a href="https://twitter.com/pulseframework"><img src="https://img.shields.io/twitter/follow/pulseframework.svg?label=Pulse+Twitter" alt="Follow Pulse on twitter"></a> 
+<p align="left">
   <a href="https://discord.gg/RjG8ShB"><img src="https://discordapp.com/api/guilds/658189217746255881/embed.png" alt="Join Discord"></a>
-  <a href="https://npmjs.com/pulse-framework"><img src="https://img.shields.io/npm/v/pulse-framework.svg" alt="NPM Package Version"></a>
-  <a href="https://npmjs.com/pulse-framework"><img src="https://img.shields.io/npm/dm/pulse-framework.svg" alt="NPM Monthly Downloads"></a>
-  <a href="https://npmjs.com/pulse-framework"><img src="https://img.shields.io/npm/dw/pulse-framework.svg" alt="NPM Weekly Downloads"></a>
-  <a href="https://npmjs.com/pulse-framework"><img src="https://img.shields.io/npm/dt/pulse-framework.svg" alt="NPM Total Downloads"></a>
-  <a href="https://npmjs.com/pulse-framework"><img src="https://img.shields.io/bundlephobia/min/pulse-framework.svg" alt="NPM Bundle MIN Size"></a>
-  <a href="https://github.com/jamiepine/pulse"><img src="https://img.shields.io/github/license/jamiepine/pulse.svg" alt="GitHub License"></a>
-  <a href="https://github.com/jamiepine/pulse"><img src="https://img.shields.io/github/languages/code-size/jamiepine/pulse.svg" alt="GitHub Code Size"></a>
-  <a href="https://github.com/jamiepine/pulse"><img src="https://img.shields.io/github/repo-size/jamiepine/pulse.svg" alt="GitHub Repo Size"></a>
+  <a href="https://patreon.com/jamiepine"><img src="https://img.shields.io/badge/donate-patreon-F96854.svg" alt="Donate on patreon"></a>
+  <a href="https://twitter.com/jamiepine"><img src="https://img.shields.io/twitter/follow/jamiepine.svg?label=Jamie's Twitter" alt="Follow on twitter"></a>
+  <a href="https://twitter.com/pulseframework"><img src="https://img.shields.io/twitter/follow/pulseframework.svg?label=Pulse+Twitter" alt="Follow Pulse on twitter"></a>
 </p>
+
+```ts
+const App = new Pulse();
+
+const Hello = App.State<string>('the sound of music');
+```
+
+## Why Pulse?
+
+Pulse provides a clean-cut toolset to build a Javascript application quickly and efficiently. It encourges developers to construct a core library that can be dropped into any UI framework. Your `core` is the brain of your application, it will handle everything from state management, API requests to all logic and calculations. Pulse will supply pre-computed data to your UI components, in the framework of your choice with complete reactivity.
+
+### Typescript
+
+Pulse is written in Typescript and is designed to support it heavily. Everything is type safe out of the box and encourages you to write clean typed code.
+
+Read the [documentation](https://pulsejs.org/v3/introduction/what-is-pulse.html) to learn more!

__mocks__/localStorage.js

@@ -1,7 +1,6 @@
 module.exports = {
-  title: 'PulseJS',
-  description:
-    'A global state and logic framework for reactive Javascript applications.',
+  title: 'Pulse Framework',
+  description: 'A global state and logic framework for reactive Javascript applications.',
   dest: 'dist',
   serviceWorker: true,
   base: '/',
@@ -10,8 +9,8 @@ module.exports = {
     logo: '/logo.svg',
     nav: [
       { text: 'Home', link: '/' },
-      { text: 'Documentation', link: '/v2/' },
-      { text: 'Changelog', link: '/v2/introduction/changelog' }
+      { text: 'Documentation', link: '/v3/introduction/what-is-pulse' },
+      { text: 'Changelog', link: '/v3/introduction/changelog' }
     ],
     lastUpdated: 'Last Updated',
     // Assumes GitHub. Can also be a full GitLab url.
@@ -83,10 +82,7 @@ module.exports = {
         {
           title: 'Quick Start',
           collapsable: false,
-          children: [
-            'getting-started/setup-with-react',
-            'getting-started/setup-with-vue'
-          ]
+          children: ['getting-started/setup-with-react', 'getting-started/setup-with-vue']
         },
         {
           title: 'Documentation',
@@ -115,7 +111,72 @@ module.exports = {
           collapsable: false,
           children: ['under-the-hood/runtime']
         }
+      ],
+      '/v3/': [
+        {
+          title: 'Introduction',
+          collapsable: false,
+          children: ['introduction/what-is-pulse', 'introduction/changelog']
+        },
+        {
+          title: 'Getting Started',
+          collapsable: false,
+          children: ['getting-started/setup-with-react', 'getting-started/concepts']
+        },
+        {
+          title: 'Documentation',
+          collapsable: false,
+          children: [
+            'docs/pulse-instance',
+            'docs/state',
+            'docs/computed',
+            'docs/collections',
+            'docs/actions',
+            'docs/controllers',
+            'docs/core',
+            'docs/api'
+          ]
+        },
+        {
+          title: 'Resources',
+          collapsable: false,
+          children: ['resources/snippets', 'getting-started/style-guide', 'resources/ideas']
+        }
       ]
     }
-  }
+  },
+  plugins: [
+    ['@vuepress/back-to-top', true],
+    [
+      '@vuepress/pwa',
+      {
+        serviceWorker: true,
+        updatePopup: true
+      }
+    ],
+    ['@vuepress/medium-zoom', true],
+    [
+      '@vuepress/google-analytics',
+      {
+        ga: 'UA-128189152-1'
+      }
+    ],
+    [
+      'container',
+      {
+        type: 'vue',
+        before: '<pre class="vue-container"><code>',
+        after: '</code></pre>'
+      }
+    ],
+    [
+      'container',
+      {
+        type: 'upgrade',
+        before: (info) => `<UpgradePath title="${info}">`,
+        after: '</UpgradePath>'
+      }
+    ],
+    ['flowchart']
+  ]
 };