still moving codebase to new API (WIP)

2025-07-24 15:49:44 +02:00 · 2017-07-26 20:03:23 +01:00 · 2017-07-26 20:03:23 +01:00 · d90b3249c3
commit d90b3249c3
parent 72b14def6d
44 changed files with 5276 additions and 336 deletions
--- a/model/page/page.go
+++ b/model/page/page.go
@ -0,0 +1,116 @@
+// Copyright 2016 Documize Inc. <legal@documize.com>. All rights reserved.
+//
+// This software (Documize Community Edition) is licensed under
+// GNU AGPL v3 http://www.gnu.org/licenses/agpl-3.0.en.html
+//
+// You can operate outside the AGPL restrictions by purchasing
+// Documize Enterprise Edition and obtaining a commercial license
+// by contacting <sales@documize.com>.
+//
+// https://documize.com
+
+package page
+
+import (
+	"strings"
+	"time"
+
+	"github.com/documize/community/model"
+)
+
+// Page represents a section within a document.
+type Page struct {
+	model.BaseEntity
+	OrgID       string  `json:"orgId"`
+	DocumentID  string  `json:"documentId"`
+	UserID      string  `json:"userId"`
+	ContentType string  `json:"contentType"`
+	PageType    string  `json:"pageType"`
+	BlockID     string  `json:"blockId"`
+	Level       uint64  `json:"level"`
+	Sequence    float64 `json:"sequence"`
+	Title       string  `json:"title"`
+	Body        string  `json:"body"`
+	Revisions   uint64  `json:"revisions"`
+}
+
+// SetDefaults ensures no blank values.
+func (p *Page) SetDefaults() {
+	if len(p.ContentType) == 0 {
+		p.ContentType = "wysiwyg"
+	}
+
+	p.Title = strings.TrimSpace(p.Title)
+}
+
+// IsSectionType tells us that page is "words"
+func (p *Page) IsSectionType() bool {
+	return p.PageType == "section"
+}
+
+// IsTabType tells us that page is "SaaS data embed"
+func (p *Page) IsTabType() bool {
+	return p.PageType == "tab"
+}
+
+// Meta holds raw page data that is used to
+// render the actual page data.
+type Meta struct {
+	ID             uint64    `json:"id"`
+	Created        time.Time `json:"created"`
+	Revised        time.Time `json:"revised"`
+	OrgID          string    `json:"orgId"`
+	UserID         string    `json:"userId"`
+	DocumentID     string    `json:"documentId"`
+	PageID         string    `json:"pageId"`
+	RawBody        string    `json:"rawBody"`        // a blob of data
+	Config         string    `json:"config"`         // JSON based custom config for this type
+	ExternalSource bool      `json:"externalSource"` // true indicates data sourced externally
+}
+
+// SetDefaults ensures no blank values.
+func (p *Meta) SetDefaults() {
+	if len(p.Config) == 0 {
+		p.Config = "{}"
+	}
+}
+
+// Revision holds the previous version of a Page.
+type Revision struct {
+	model.BaseEntity
+	OrgID       string `json:"orgId"`
+	DocumentID  string `json:"documentId"`
+	PageID      string `json:"pageId"`
+	OwnerID     string `json:"ownerId"`
+	UserID      string `json:"userId"`
+	ContentType string `json:"contentType"`
+	PageType    string `json:"pageType"`
+	Title       string `json:"title"`
+	Body        string `json:"body"`
+	RawBody     string `json:"rawBody"`
+	Config      string `json:"config"`
+	Email       string `json:"email"`
+	Firstname   string `json:"firstname"`
+	Lastname    string `json:"lastname"`
+	Initials    string `json:"initials"`
+	Revisions   int    `json:"revisions"`
+}
+
+// Block represents a section that has been published as a reusable content block.
+type Block struct {
+	model.BaseEntity
+	OrgID          string `json:"orgId"`
+	LabelID        string `json:"folderId"`
+	UserID         string `json:"userId"`
+	ContentType    string `json:"contentType"`
+	PageType       string `json:"pageType"`
+	Title          string `json:"title"`
+	Body           string `json:"body"`
+	Excerpt        string `json:"excerpt"`
+	RawBody        string `json:"rawBody"`        // a blob of data
+	Config         string `json:"config"`         // JSON based custom config for this type
+	ExternalSource bool   `json:"externalSource"` // true indicates data sourced externally
+	Used           uint64 `json:"used"`
+	Firstname      string `json:"firstname"`
+	Lastname       string `json:"lastname"`
+}