summaryrefslogtreecommitdiffstats
path: root/packages/gitbook-core/src/models
diff options
context:
space:
mode:
Diffstat (limited to 'packages/gitbook-core/src/models')
-rw-r--r--packages/gitbook-core/src/models/StateApi.js26
-rw-r--r--packages/gitbook-core/src/models/StateSummary.js31
-rw-r--r--packages/gitbook-core/src/models/User.js15
3 files changed, 72 insertions, 0 deletions
diff --git a/packages/gitbook-core/src/models/StateApi.js b/packages/gitbook-core/src/models/StateApi.js
new file mode 100644
index 0000000..430833b
--- /dev/null
+++ b/packages/gitbook-core/src/models/StateApi.js
@@ -0,0 +1,26 @@
+const { Record } = require('immutable');
+
+const DEFAULTS = {
+ currentUser: null
+};
+
+/**
+ * State for the API, it stores informations about the logged in user, etc.
+ * @type {Record}
+ */
+class StateApi extends Record(DEFAULTS) {
+ static create(state) {
+ return state instanceof StateApi ?
+ state : new StateApi(state);
+ }
+
+ /**
+ * Check if reader is an user is loggedin.
+ * @return {Boolean}
+ */
+ get isLoggedIn() {
+ return Boolean(this.currentUser);
+ }
+}
+
+module.exports = StateApi;
diff --git a/packages/gitbook-core/src/models/StateSummary.js b/packages/gitbook-core/src/models/StateSummary.js
new file mode 100644
index 0000000..f268f34
--- /dev/null
+++ b/packages/gitbook-core/src/models/StateSummary.js
@@ -0,0 +1,31 @@
+const { Record, List } = require('immutable');
+
+const File = require('../models/File');
+const SummaryPart = require('../models/SummaryPart');
+
+const DEFAULTS = {
+ file: new File(),
+ parts: List()
+};
+
+/**
+ * State for the summary.
+ * @type {Record}
+ */
+class StateSummary extends Record(DEFAULTS) {
+ constructor(state = {}) {
+ super({
+ ...state,
+ file: new File(state.file),
+ parts: (new List(state.parts))
+ .map(article => new SummaryPart(article))
+ });
+ }
+
+ static create(state) {
+ return state instanceof StateSummary ?
+ state : new StateSummary(state);
+ }
+}
+
+module.exports = StateSummary;
diff --git a/packages/gitbook-core/src/models/User.js b/packages/gitbook-core/src/models/User.js
new file mode 100644
index 0000000..6653dc4
--- /dev/null
+++ b/packages/gitbook-core/src/models/User.js
@@ -0,0 +1,15 @@
+const { Record } = require('immutable');
+
+const DEFAULTS = {
+ username: ''
+};
+
+/**
+ * An instance of a GitBook.com user (from API)
+ * @type {String}
+ */
+class User extends Record(DEFAULTS) {
+
+}
+
+module.exports = User;