3 |
20 |
21 |
22 |
--------------------------------------------------------------------------------
/frontend/src/views/auth/signup.vue:
--------------------------------------------------------------------------------
1 |
2 |
4 | 
5 |
18 |
19 |
5 |
18 |
3 |
19 |
20 |
21 |
--------------------------------------------------------------------------------
/frontend/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
4 | 
5 |
17 |
18 |
5 |
17 |
3 |
12 |
13 | {{props.option[model_metadata.options.title_field]}}
14 |
15 |
16 |
17 |
18 |
19 |
66 |
--------------------------------------------------------------------------------
/src/lib/cache.js:
--------------------------------------------------------------------------------
1 |
2 | export class Cache {
3 | constructor () {}
4 |
5 | async read(id, callback) {
6 | // fires callback if the object is not in the cache, putting the returned value into the cache in its place.
7 | let cache = caches.default
8 | const req = new Request(`https://ceru.dev/cache/${id}`)
9 |
10 | let res = await cache.match(req)
11 |
12 | if (!res) {
13 | log(`[CACHE] [${id}] MISS`)
14 |
15 | let value
16 |
17 | try {
18 | value = await callback()
19 | } catch (e) {
20 | return null
21 | }
22 |
23 | res = value
24 |
25 | if (res === null) {
26 | // Dont cache a null value
27 | return null
28 | }
29 |
30 | await this.write(
31 | id,
32 | value
33 | )
34 | } else {
35 | increase_cost('cache_read')
36 | log(`[CACHE] [${id}] HIT`)
37 | res = await res.json()
38 | }
39 |
40 | return res
41 | }
42 |
43 | async write(id, data, opt) {
44 | const options = Object.assign(
45 | {},
46 | opt
47 | )
48 |
49 | console.log(`[CACHEdasdasdasdasdasdasdsadasdasdasdasdasda] Writing ${id}`)
50 |
51 | let cache = caches.default
52 | const req = new Request(`https://ceru.dev/cache/${id}`)
53 | const res = new Response(
54 | JSON.stringify(data),
55 | {
56 | headers: {'Cache-Control': 'max-age=860000'}
57 | }
58 | )
59 |
60 | await cache.put(req, res)
61 | }
62 |
63 | async delete(id) {
64 | let cache = caches.default
65 | const req = new Request(`https://ceru.dev/cache/${id}`)
66 |
67 | console.log(`[CACHEasdasdasdasdasdasdasdsadas] Deleting ${id}`)
68 |
69 | //ctx.waitUntil(async () => {
70 | await new Promise(r => setTimeout(r, 750))
71 | await cache.delete(req)
72 | console.log(`[CACHE] Deleted ${id}`)
73 | }
74 | }
--------------------------------------------------------------------------------
/src/index.js:
--------------------------------------------------------------------------------
1 | import { router } from './router.js'
2 | import { captureError } from '@cfworker/sentry'
3 | import { all_timers } from './lib/timing.js'
4 |
5 | export { WriterDO } from './lib/writer.mjs'
6 |
7 | import './api_v1/auth/accounts.js'
8 | import './api_v1/models/models.js'
9 | import './api_v1/models/content.js'
10 | import './api_v1/models/presets.js'
11 | // import './api_v1/models/graphql.js'
12 | import './init.js'
13 |
14 | export default {
15 | async fetch(request, env, ctx) {
16 | // store the global request variables for use in other parts of the API
17 | globalThis.cloudflare = request.cf
18 | globalThis.request = request
19 | globalThis.env = env
20 | globalThis.ctx = ctx
21 |
22 | globalThis.cost = {
23 | read: 0, // Times we asked KV for data
24 | write: 0, // Times we wrote to KV
25 | cache_read: 0 // Times we found a cached result
26 | }
27 |
28 | const log = []
29 |
30 | globalThis.increase_cost = (t) => {
31 | globalThis.cost[t] += 1
32 | }
33 |
34 | globalThis.log = (l) => {
35 | console.log(l)
36 | log.push(l)
37 | }
38 |
39 | router.corsConfig.allowOrigin = '*'
40 | router.corsConfig.allowHeaders = 'Origin, X-Requested-With, Content-Type, Accept, Authorization, Content-Length, x-cost, x-log, Server-Timing'
41 |
42 | let resp
43 |
44 | try {
45 | resp = await router.handle(request)
46 | } catch (e) {
47 |
48 | const { event_id, posted } = captureError(
49 | 'https://9292f7a98bf841efb933169ad404dfae@o225929.ingest.sentry.io/6531416',
50 | 'production',
51 | '0',
52 | e,
53 | request,
54 | ''
55 | )
56 |
57 | throw e
58 | }
59 |
60 | const response = new Response(resp.body, resp)
61 |
62 | response.headers.set('X-Cost', JSON.stringify(cost))
63 | response.headers.set('X-Log', JSON.stringify(log))
64 | response.headers.set('Access-Control-Expose-Headers', router.corsConfig.allowHeaders)
65 |
66 | return response
67 | }
68 | }
69 |
70 |
--------------------------------------------------------------------------------
/frontend/src/components/loading_overlay.vue:
--------------------------------------------------------------------------------
1 |
2 |
3 |
19 |
20 |
21 |
53 |
--------------------------------------------------------------------------------
/frontend/src/App.vue:
--------------------------------------------------------------------------------
1 |
2 |
4 | 
5 |
6 |
10 |
11 |
12 | {{ loadingMessage || 'Loading your Object!' }}
13 |
14 |
18 |
5 |
6 |
10 |
11 |
12 | {{ loadingMessage || 'Loading your Object!' }}
13 |
14 | 15 | Shouldnt take long... 16 |
17 |
3 |
4 |
40 |
41 |
43 |
44 |
47 |
48 |
--------------------------------------------------------------------------------
/frontend/src/views/dashboard/models/list.vue:
--------------------------------------------------------------------------------
1 |
2 |
5 |
6 |
9 |
10 |
17 |
18 |
23 |
24 |
25 |
39 |
11 | Horseman
12 |
13 | The headless CMS
14 |
15 |
16 |
26 |
27 | Sign up
28 |
29 |
30 | Login
31 |
32 |
33 |
34 |
35 | Dashboard
36 |
37 |
38 |
3 |
22 |
38 |
39 |
40 |
41 |
--------------------------------------------------------------------------------
/frontend/src/api.js:
--------------------------------------------------------------------------------
1 | import axios from 'axios'
2 | import { reactive } from 'vue'
3 | import { createNanoEvents } from 'nanoevents'
4 | import { notify } from "@kyvg/vue3-notification"
5 | import * as marked from 'marked'
6 |
7 | export default class API {
8 | constructor () {
9 | this.user_token = localStorage.token || ''
10 |
11 | this.state = reactive({
12 | reads: 0,
13 | writes: 0,
14 | cache_hits: 0
15 | })
16 |
17 | this.api_url = `https://${ import.meta.env.PROD ? 'horseman.ceru.dev' : 'api-dev.constellations.tech' }/v1`
18 |
19 | this.events = createNanoEvents()
20 | this.marked = marked
21 |
22 | this.axios = this.create_axios()
23 |
24 | if (this.user_token) {
25 | this.authorize(this.user_token)
26 | }
27 | }
28 |
29 | create_axios() {
30 | return axios.create({
31 | baseURL: this.api_url,
32 | timeout: 10000,
33 | headers: {'Authorization': `User ${this.user_token}`}
34 | })
35 | }
36 |
37 | process_request(data) {
38 | const stats = JSON.parse(data.headers['x-cost'])
39 |
40 | this.state.reads = this.state.reads + stats.read
41 | this.state.writes = this.state.writes + stats.write
42 | this.state.cache_hits = this.state.cache_hits + stats.cache_read
43 | }
44 |
45 | async get(route) {
46 | const data = await this.axios.get(route)
47 | this.process_request(data)
48 |
49 | return data
50 | }
51 |
52 | async post(route, body) {
53 | const data = await this.axios.post(
54 | route,
55 | body
56 | )
57 | this.process_request(data)
58 |
59 | return data
60 | }
61 |
62 | async delete(route, body) {
63 | const data = await this.axios.delete(route)
64 | this.process_request(data)
65 |
66 | return data
67 | }
68 |
69 | authorize(token) {
70 | this.user_token = token
71 | localStorage.token = token
72 | this.axios = this.create_axios()
73 | this.get(`/auth/@me`).then(resp => {
74 | this.state.user = resp.data.user
75 | })
76 | }
77 |
78 | error_notification(error_response) {
79 | if ('response' in error_response) {
80 | notify({
81 | title: `We're sorry, there was an error`,
82 | text: `${error_response.response.status} - ${error_response.response.data.error}`,
83 | type: 'error'
84 | })
85 | } else {
86 | throw error_response
87 | }
88 |
89 |
90 |
91 | }
92 | }
--------------------------------------------------------------------------------
/src/lib/writer.mjs:
--------------------------------------------------------------------------------
1 | // The writer is a durable object tasked with ensuring that all writes are sequencial
2 | // You might ask why?
3 | // Well what happens if two writes come in at the same time?
4 | // Our indexes drop one of the objects as both Workers get the index, append the object, and write it again
5 | // This durable objects job is to sit and just write the indexes and objects to the DB.
6 |
7 | import Router from '@tsndr/cloudflare-worker-router'
8 |
9 | export class WriterDO {
10 | constructor(state, env) {
11 | this.env = env
12 | this.state = state
13 |
14 | this.tasks = []
15 | }
16 |
17 | async fetch(req) {
18 | const router = new Router()
19 |
20 | router.cors()
21 |
22 | router.post(`/v1/write`, async (req, res) => {
23 | const prefix = req.body.prefix
24 | const objectID = req.body.objectID
25 | const value = req.body.value
26 |
27 | const resp = await this.state.blockConcurrencyWhile(async () => {
28 | // prefix should be userID:tablename:field
29 | let idx = await this.env.INDEXKV.get(prefix + ':index', { type: 'json' })
30 |
31 | if (!idx) {
32 | // we need to make an index for this object
33 | idx = []
34 | }
35 |
36 | const is_existing = idx.filter(comp => comp[1] == objectID)
37 |
38 | if (is_existing.length > 0) {
39 | idx = idx.map(comp => {
40 | if (comp[1] == objectID) {
41 | comp[0] = value
42 | }
43 | return comp
44 | })
45 | } else {
46 | idx.push([ value, objectID ])
47 | }
48 |
49 | await this.env.INDEXKV.put(prefix + ':index', JSON.stringify( idx ))
50 |
51 | return idx
52 | })
53 |
54 | res.body = {
55 | success: true,
56 | index: resp
57 | }
58 | })
59 |
60 | router.post(`/v1/delete`, async (req, res) => {
61 | const prefix = req.body.prefix
62 | const objectID = req.body.objectID
63 |
64 | const index = await this.state.blockConcurrencyWhile(async () => {
65 | // prefix should be userID:tablename:field
66 | let idx = await this.env.INDEXKV.get(prefix + ':index', { type: 'json' })
67 |
68 | if (!idx) {
69 | return {
70 | success: false,
71 | error: 'This object doesnt exist in this index'
72 | }
73 | }
74 |
75 | idx = idx.filter(x => x[1] != objectID)
76 |
77 | if (idx.length == 0) {
78 | await this.env.INDEXKV.delete(prefix + ':index')
79 | } else {
80 | await this.env.INDEXKV.put(prefix + ':index', JSON.stringify( idx ))
81 | }
82 | })
83 |
84 | res.body = {
85 | success: true,
86 | index
87 | }
88 | })
89 |
90 | return await router.handle(req)
91 | }
92 | }
--------------------------------------------------------------------------------
/src/init.js:
--------------------------------------------------------------------------------
1 | // Startup script for when the API was just initiated
2 | //
3 |
4 | import { router } from './router.js'
5 | import { Table } from './lib/table.js'
6 |
7 |
8 | // Basic setup using the built in schema
9 | router.get(router.version + '/__meta/init', async (req, res) => {
10 | // create the accounts "table"
11 |
12 | const accounts = new Table(
13 | 'internal',
14 | 'accounts'
15 | )
16 |
17 | await accounts.set_spec([
18 | {'name': 'email', 'type': 'string', 'index': true },
19 | {'name': 'token', 'type': 'string', 'index': true },
20 | {'name': 'password_hash', 'type': 'string' },
21 | {'name': 'customerID', 'type': 'string' },
22 | {'name': 'options', 'type': 'object' },
23 | ])
24 |
25 | const keys = new Table(
26 | 'internal',
27 | 'keys'
28 | )
29 |
30 | await keys.set_spec([
31 | {'name': 'userID', 'type': 'string', 'index': true },
32 | {'name': 'label', 'type': 'string', 'index': true },
33 | {'name': 'type', 'type': 'string'}, // public or preview
34 | {'name': 'permissions', 'type': 'array' }
35 | ])
36 |
37 | res.body = {
38 | success: true
39 | }
40 | })
41 |
42 | router.get(router.version + '/init', async (req, res) => {
43 | res.body = `
44 |
45 |
46 |
4 |
8 | New
9 |
10 |
11 | 5 | Models 6 |
7 |12 | Models are like buckets of objects that can be read later on. To store data with Horseman, you first need a model to store them in. Please be aware that indexes cannot be added once a model is created. 13 |
14 | 15 |
16 |
20 |
21 | 17 | Loading models, this could take some time if you have a lot. 18 |
19 |
23 |
37 |
24 |
25 |
36 |
26 |
35 |
27 |
31 |
28 | {{model.id}}
29 |
30 |
32 | Created {{new Date(model.created_at).toLocaleDateString()}}
33 |
34 |
47 |
71 |
72 |
73 |
74 |
75 | `
76 | res.headers['Content-Type'] = 'text/html'
77 | })
--------------------------------------------------------------------------------
/npm-debug.log:
--------------------------------------------------------------------------------
1 | 0 info it worked if it ends with ok
2 | 1 verbose cli [ '/usr/bin/node', '/usr/bin/npm', 'run', 'dev' ]
3 | 2 info using npm@3.5.2
4 | 3 info using node@v8.10.0
5 | 4 verbose run-script [ 'predev', 'dev', 'postdev' ]
6 | 5 info lifecycle miniflare-esbuild-ava@1.0.0~predev: miniflare-esbuild-ava@1.0.0
7 | 6 silly lifecycle miniflare-esbuild-ava@1.0.0~predev: no script for predev, continuing
8 | 7 info lifecycle miniflare-esbuild-ava@1.0.0~dev: miniflare-esbuild-ava@1.0.0
9 | 8 verbose lifecycle miniflare-esbuild-ava@1.0.0~dev: unsafe-perm in lifecycle true
10 | 9 verbose lifecycle miniflare-esbuild-ava@1.0.0~dev: PATH: /usr/share/npm/bin/node-gyp-bin:/root/x-rp/horseman/node_modules/.bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/snap/bin:/usr/lib/jvm/java-8-openjdk-amd64//bin
11 | 10 verbose lifecycle miniflare-esbuild-ava@1.0.0~dev: CWD: /root/x-rp/horseman
12 | 11 silly lifecycle miniflare-esbuild-ava@1.0.0~dev: Args: [ '-c',
13 | 11 silly lifecycle 'npx miniflare@latest --watch --debug --env .secrets.env' ]
14 | 12 info lifecycle miniflare-esbuild-ava@1.0.0~dev: Failed to exec dev script
15 | 13 verbose stack Error: miniflare-esbuild-ava@1.0.0 dev: `npx miniflare@latest --watch --debug --env .secrets.env`
16 | 13 verbose stack spawn ENOENT
17 | 13 verbose stack at ChildProcess.
3 |
46 |
47 |
48 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | 
2 |
3 | # 🐴 Horseman, the headless CMS
4 |
5 | Horseman is a headless CMS thats powered by Cloudflare KV and the Cache API. Using DurableObjects to ensure data indexes are valid and up to date.
6 |
7 | Horseman was created when I wanted to make a news feed for [Wordful](https://wordful.ceru.dev), my multiplayer Wordle game. Looking at other offerings, I wished for something simple, yet quick. After some quick discussions, I realised I could make my own headless CMS by utilising Cloudflare's global KV. This makes Horseman no less than 50ms from anyone around the world.
8 |
9 | You can find a public Horseman instance on my website, here: https://horseman.ceru.dev/
10 |
11 | API documentation can be found here: https://horseman.stoplight.io/docs/horseman/abe38a2fb9c9d-list-models
12 |
13 | ## ⚡ Features
14 | - World-wide, high speed, infinitely scalable, all thanks to Cloudflare Workers.
15 | - Modern, sleek UI for creating and managing your Objects.
16 | - Caching API built in, smartly clears cache to ensure your data is always up to date world-wide. Also reduces read costs significantly so you dont have to worry about a sudden burst of requests killing your bill.
17 | - Wildcard searching built-in. Alongside other features such as cursors, Horseman can perform wildcard searching on any indexed field.
18 | - For example: `?Field=eq.Hello*` would find any Object with `Hello` in `Field`. Wildcards can go anywhere in the string.
19 | - Relationships to bind two Objects together. Add an Author to that Post without having to type them out every time.
20 |
21 | ## 🔥 Todo
22 |
23 | - Pub/Sub channels for getting up to date information on your Objects.
24 | - An "organisation" system to allow people to be assigned to groups modifying the same group of Objects.
25 | - A plugin system to support third-party modifications to the API. For self-hosted users only, however would allow for people to add custom content-based embeds/RSS feeds.
26 | - Ask for more feedback
27 | - Better documentation 📚
28 |
29 | *Have an idea? Make a discussion post about it and tell us all about your awesome idea!!*
30 |
31 | ## 🔧 Setting up
32 | What you'll need:
33 | - A machine with Wrangler 2
34 | - A paid Workers subscription ($5 a month, used for the password hashing Worker & DurableObjects)
35 | - A setup, working password hashing Worker: (https://github.com/AggressivelyMeows/password-hashing)
36 | - Please read the README to get the passowrd hashing Worker setup correctly.
37 |
38 | #### Step 1 - Config
39 | Open wrangler.toml and edit the lines described by the comments. Make sure to follow them precicely otherwise Horseman will not work.
40 |
41 | #### Step 2 - Publish the Worker
42 | Run `npx wrangler publish` to publish Horseman to your Cloudflare account. Once done, you will neekd to visit `/v1/__meta/init` to start the database. This step is *required* for Horseman to know whats going on.
43 |
44 | ## ✨ Acknowledgements
45 | Horseman was created by Cerulean, all code (except ./src/tsndr_router.js, from https://www.npmjs.com/package/@tsndr/cloudflare-worker-router, read comments for why) is copyright of Connor Vince. Please read the Licence terms before publishing your own Horseman instance.
--------------------------------------------------------------------------------
/src/router.js:
--------------------------------------------------------------------------------
1 | import Router from './tsndr_router.js'
2 | import { Table } from './lib/table.js'
3 |
4 | const router = new Router()
5 |
6 | router.cors()
7 |
8 | router.version = '/v1'
9 |
10 | router.requires_auth = async (req, res, next) => {
11 | const token = req.headers.get('Authorization') || req.query.key
12 |
13 | if (!token) {
14 | res.body = {
15 | success: false,
16 | error: 'No authorization token present',
17 | code: 'AUTH_HEADER_MISSING'
18 | }
19 | res.status = 403
20 | return
21 | }
22 |
23 | const accounts = new Table(
24 | 'internal',
25 | 'accounts'
26 | )
27 |
28 | let user
29 | if (token.includes('User')) {
30 | user = await accounts.get(
31 | 'token',
32 | token.split(' ')[1]
33 | )
34 |
35 | user.authorization_type = 'email'
36 | user.read_level = 'preview'
37 | user.permissions = [
38 | 'read:all',
39 | 'write:all'
40 | ]
41 | } else {
42 | const key = await (new Table(
43 | 'internal',
44 | 'keys'
45 | )).get(
46 | 'id',
47 | token
48 | )
49 |
50 | if (!key) {
51 | res.body = {
52 | success: false,
53 | error: 'Invalid authorization token',
54 | code: 'AUTH_TOKEN_INVALID'
55 | }
56 | res.status = 403
57 | return
58 | }
59 |
60 | user = await accounts.get(
61 | 'id',
62 | key.userID
63 | )
64 |
65 | user.authorization_type = 'key'
66 | user.read_level = key.type
67 | user.key = key
68 | user.permissions = key.permissions
69 | }
70 |
71 | req.user = user
72 |
73 | if (user.authorization_type == 'key' && !'modelID' in req.params) {
74 | res.body = {
75 | success: false,
76 | error: 'Invalid use of an API key, must be used with a model',
77 | code: 'AUTH_KEY_INVALID'
78 | }
79 | res.status = 403
80 | return
81 | }
82 |
83 | if ('modelID' in req.params) {
84 | // this is a request targeting one of the models on the API
85 | // check if the user has the right to access this model
86 | const model = req.params.modelID
87 |
88 | if (req.method == 'GET' && !user.permissions.includes('read:all')) {
89 | if (!user.permissions.includes(`read:${model}`)) {
90 | res.body = {
91 | success: false,
92 | error: 'This key does not have access to read this model. Please validate your permissions with the owner of this key.',
93 | code: 'AUTH_MODEL_DENIED'
94 | }
95 | res.status = 403
96 | return
97 | }
98 | }
99 |
100 | if (['POST', 'DELETE'].includes(req.method) && !user.permissions.includes('write:all')) {
101 | if (!user.permissions.includes(`write:${model}`)) {
102 |
103 | res.body = {
104 | success: false,
105 | error: 'This key does not have access to write to this model. Please validate your permissions with the owner of this key.',
106 | code: 'AUTH_MODEL_DENIED'
107 | }
108 | res.status = 403
109 | return
110 | }
111 | }
112 | }
113 |
114 | await next()
115 | }
116 |
117 | router.get('/v1/clr-cache/:id', async (req, res) => {
118 | const accounts = new Table(
119 | 'internal',
120 | 'accounts'
121 | )
122 |
123 | res.body = {
124 | success: await accounts.cache.delete(req.params.id)
125 | }
126 | })
127 |
128 | router.get('/v1/cache/:id', async (req, res) => {
129 | const accounts = new Table(
130 | 'internal',
131 | 'accounts'
132 | )
133 |
134 | res.body = {
135 | cache: await accounts.cache.read(req.params.id)
136 | }
137 | })
138 |
139 | router.get('/v1/kv/read/:id', async (req, res) => {
140 | res.body = {
141 | obj: await env.CONTENTKV.get(req.params.id, { type: 'json' }),
142 | idx: await env.INDEXKV.get(req.params.id, { type: 'json' })
143 | }
144 | })
145 |
146 |
147 | router.get('/v1/kv/write', async (req, res) => {
148 | const ts = new Date().toISOString()
149 | await env.CONTENTKV.put('testing:kv:latency', JSON.stringify({ date: ts, colo_ray: req.headers.get('cf-ray') }))
150 |
151 | res.body = {
152 | ts
153 | }
154 | })
155 |
156 | export {
157 | router
158 | }
--------------------------------------------------------------------------------
/frontend/src/views/dashboard/keys/edit.vue:
--------------------------------------------------------------------------------
1 |
2 |
4 |
5 | 💽 Your data
6 |
7 |
8 |
40 |
9 |
10 | Getting started
11 |
12 |
13 | Models
14 |
15 |
16 | API keys
17 |
18 |
19 |
20 |
21 | 🔏 Your objects
22 |
23 |
24 |
25 |
26 | {{model.id}}
27 |
28 |
29 |
30 |
31 |
34 | You have no models 😢
35 |
39 | 36 | Once you have created one, they will show up here for you to add objects to 37 |
38 |
41 |
45 |
42 |
44 |
3 |
4 |
10 |
20 |
21 |
64 |
65 |
66 |
--------------------------------------------------------------------------------
/src/api_v1/models/models.js:
--------------------------------------------------------------------------------
1 | import { router } from '../../router.js'
2 | import { Table } from '../../lib/table.js'
3 |
4 | import slugify from 'slugify'
5 |
6 | router.get(router.version + '/models', router.requires_auth, async (req, res) => {
7 | const tbl = new Table(
8 | req.user.id,
9 | 'models'
10 | )
11 |
12 | const models = await tbl.list(
13 | '__all_objects_index',
14 | 0,
15 | {
16 | limit: 20,
17 | order: 'newest_first'
18 | }
19 | )
20 |
21 | res.body = {
22 | success: true,
23 | results: models
24 | }
25 | })
26 |
27 | router.get(router.version + '/models/:modelID', router.requires_auth, async (req, res) => {
28 | const tbl = new Table(
29 | req.user.id,
30 | 'models'
31 | )
32 |
33 | let model = await tbl.get(
34 | 'id',
35 | req.params.modelID
36 | )
37 |
38 | if (!model) {
39 | res.body = { success: false, error: 'Model not found' }
40 | res.status = 404
41 | return
42 | }
43 |
44 | if (model.userID != req.user.id) {
45 | res.body = { success: false, error: 'You do not own this model' }
46 | res.status = 403
47 | return
48 | }
49 |
50 | model.spec = model.spec.filter(field => field.name != '__all_objects_index')
51 |
52 | model.options = model.options || {}
53 |
54 | res.body = {
55 | success: true,
56 | model
57 | }
58 | })
59 |
60 | router.post(router.version + '/models', router.requires_auth, async (req, res) => {
61 | // create a new model
62 | const tbl = new Table(
63 | req.user.id,
64 | 'models'
65 | )
66 |
67 | // map the spec to a URL safe form while also doing spec validation
68 | const spec = req.body.spec.map(field => {
69 | //field.name = slugify(field.name, '_').toLowerCase()
70 | return field
71 | })
72 |
73 | // might be asking why do we force all objects to have an index like below?
74 | // this is because the DB has no native list all objects without there being a unified index for all models and objects
75 | // this field is hidden from the user, cannot be set, cannot be deleted, cannot be read
76 | spec.push({
77 | name: '__all_objects_index',
78 | type: 'string',
79 | index: true
80 | })
81 |
82 | req.body.title = req.body.title ||req.body.id
83 |
84 | const model = await tbl.put({
85 | id: slugify(req.body.title, '-').toLowerCase(),
86 | userID: req.user.id,
87 | spec,
88 | options: req.body.options,
89 | created_at: new Date().toISOString()
90 | })
91 |
92 | // get table reference
93 | const model_table = new Table(
94 | req.user.id,
95 | slugify(req.body.title, '-').toLowerCase()
96 | )
97 |
98 | await model_table.set_spec(spec)
99 |
100 | res.body = {
101 | success: true,
102 | model
103 | }
104 | })
105 |
106 | // UPDATE a model
107 | router.post(router.version + '/models/:modelID', router.requires_auth, async (req, res) => {
108 | // create a new model
109 | const tbl = new Table(
110 | req.user.id,
111 | 'models'
112 | )
113 |
114 | const existing = await tbl.get(
115 | 'id',
116 | req.params.modelID
117 | )
118 |
119 | // map the spec to a URL safe form while also doing spec validation
120 | const spec = req.body.spec.map(field => {
121 | //field.name = slugify(field.name, '_').toLowerCase()
122 | return field
123 | })
124 |
125 | // might be asking why do we force all objects to have an index like below?
126 | // this is because the DB has no native list all objects without there being a unified index for all models and objects
127 | // this field is hidden from the user, cannot be set, cannot be deleted, cannot be read
128 | spec.push({
129 | name: '__all_objects_index',
130 | type: 'string',
131 | index: true
132 | })
133 |
134 | await tbl.update(
135 | req.params.modelID,
136 | {
137 | options: req.body.options,
138 | spec,
139 | }
140 | )
141 |
142 | // get table reference
143 | const model_table = new Table(
144 | req.user.id,
145 | existing.id
146 | )
147 |
148 | await model_table.set_spec(spec)
149 |
150 | res.body = {
151 | success: true
152 | }
153 | })
154 |
155 | // DELETE A MODEL
156 | router.delete(router.version + '/models/:modelID', router.requires_auth, async (req, res) => {
157 | // create a new model
158 | const tbl = new Table(
159 | req.user.id,
160 | req.params.modelID
161 | )
162 |
163 | const idx_keys = (
164 | await env.INDEXKV.list({
165 | prefix: tbl.get_kv_prefix()
166 | })
167 | ).keys.map(k => k.name)
168 |
169 | const object_keys = (
170 | await env.CONTENTKV.list({
171 | prefix: tbl.get_kv_prefix()
172 | })
173 | ).keys.map(k => k.name)
174 |
175 | await Promise.all([
176 | Promise.all(idx_keys.map(k => env.INDEXKV.delete(k))),
177 | Promise.all(object_keys.map(k => env.CONTENTKV.delete(k))),
178 | ])
179 |
180 | await new Table(req.user.id, 'models').delete(
181 | req.params.modelID
182 | )
183 |
184 | res.body = {
185 | success: true
186 | }
187 | })
--------------------------------------------------------------------------------
/frontend/src/views/dashboard/keys/list.vue:
--------------------------------------------------------------------------------
1 |
2 | 11 | Delete API key 12 |
13 |14 | Deleting this key will mean it cannot be used to access the API anymore. This action is irreversible. Are you sure you want to delete this key? 15 |
16 | 17 | Delete key 18 | 19 |
22 |
34 |
35 | 23 | {{ $route.params.keyID == 'new' ? 'Creating' : 'Editing' }} {{key.label || 'API key'}} 24 |
25 | 26 | 27 | Delete 28 | 29 | 30 | 31 | {{ $route.params.keyID == 'new' ? 'Create' : 'Save' }} 32 | 33 |
36 |
37 |
43 |
44 |
45 |
46 |
49 |
52 |
53 |
54 |
55 |
62 |
63 |
3 |
4 |
10 |
14 | Clearing cache will reset the server-side cache for all 250+ locations. This will significantly slow down the speed of your key for the first hit. You will also incur a read hit for each location as your key is requested.
15 |
18 |
19 | Clear {{model.id}}'s cache
20 |
21 |
22 |
23 |
34 |
35 |
64 |
88 |
89 |
90 |
91 |
--------------------------------------------------------------------------------
/frontend/src/tailwind.css:
--------------------------------------------------------------------------------
1 | @tailwind base;
2 | @tailwind components;
3 | @tailwind utilities;
4 |
5 | .mdi {
6 | /*
7 | Yay, love me some Material Design Icon fuckery.
8 | For whatever reason, the icons are not centered in their respective I tags.
9 | */
10 | display: flex;
11 | align-items: center;
12 | justify-content: center;
13 | @apply opacity-75 text-xs;
14 | }
15 |
16 | .mdi-24px.mdi-set, .mdi-24px.mdi::before {
17 | font-size: 1.4em;
18 | }
19 |
20 | .o-inputit__item {
21 | @apply flex flex-row items-center justify-center;
22 | }
23 |
24 | .button {
25 | @apply border-none;
26 | }
27 |
28 | .heading {
29 | @apply text-3xl font-bold text-primary-500
30 | }
31 |
32 | .o-field__message {
33 | @apply text-xs text-gray-400 mt-2
34 | }
35 |
36 | .subheading {
37 | @apply font-medium text-gray-300 text-sm
38 | }
39 |
40 | .o-field__label {
41 | @apply mb-2 font-bold;
42 | }
43 |
44 | .o-input {
45 | @apply border-none rounded-md bg-gray-800 text-sm px-2 py-2 border-gray-700 focus:outline-none focus:border-primary-900 focus:ring-primary-600 focus:ring-1;
46 | }
47 |
48 | .o-input--dark {
49 | @apply bg-gray-900 !important
50 | }
51 |
52 | .o-ctrl-sel {
53 | @apply w-full
54 | }
55 |
56 | .o-sel {
57 | @apply w-full border-none rounded-md bg-gray-800 text-sm px-2 py-2 border-gray-700 focus:outline-none focus:border-primary-900 focus:ring-primary-600 focus:ring-1;
58 | }
59 |
60 | .o-inputit {
61 | @apply rounded-md overflow-hidden border-none
62 | }
63 |
64 | .o-inputit__container {
65 | @apply border-none !important
66 | }
67 |
68 | .o-inputit__item {
69 | @apply bg-primary-600 rounded-md ml-0 mr-2 text-sm font-mono !important;
70 | padding: 8px 4px!important
71 | }
72 |
73 | .o-inputit__input {
74 | @apply text-gray-200
75 | }
76 |
77 | .o-chk__check {
78 | @apply bg-gray-850 text-primary-600 rounded-md border-gray-700 focus:outline-none focus:border-primary-900 focus:ring-primary-600 focus:ring-1 !important
79 | }
80 |
81 | .o-chk__check--checked {
82 | @apply bg-primary-600 !important
83 | }
84 |
85 | .o-chk__label {
86 | @apply ml-2 text-sm
87 | }
88 |
89 | .o-modal__content {
90 | /* Oruga does this as well, until i can figure out how to fix the priority issues with CSS, this will have to be it. */
91 | @apply rounded-md overflow-hidden bg-gray-800 text-gray-200 max-w-lg p-4 !important
92 | }
93 |
94 | .o-acp__menu {
95 | @apply rounded-md overflow-hidden bg-gray-800 text-gray-200 !important
96 | }
97 |
98 | .o-acp__item {
99 | @apply p-2 hover:bg-gray-850 hover:text-primary-500
100 | }
101 |
102 | .notif {
103 | @apply p-2 px-3 rounded-md mb-3 mr-3 cursor-pointer
104 | }
105 |
106 | .notif.success {
107 | @apply text-gray-200 bg-green-600
108 | }
109 |
110 | .notif.warning {
111 | @apply text-gray-200 bg-yellow-600
112 | }
113 |
114 | .notif.error {
115 | @apply text-gray-200 bg-red-600
116 | }
117 |
118 | .notif.info {
119 | @apply text-gray-200 bg-blue-600
120 | }
121 |
122 | .notification-content {
123 | @apply text-sm
124 | }
125 |
126 |
127 |
128 | .ql-syntax {
129 | @apply bg-gray-900 p-2 !important;
130 | }
131 |
132 | .ql-html-textArea {
133 | @apply bg-transparent !important;
134 | }
135 |
136 | .ql-html-textArea > .ql-editor {
137 | @apply p-0 pt-2 !important
138 | }
139 |
140 | .ql-html-popupContainer {
141 | @apply bg-gray-800 text-gray-200 !important
142 | }
143 |
144 | .ql-html-buttonCancel {
145 | @apply bg-red-600 text-white font-medium p-2 rounded-md text-xs !important;
146 | }
147 |
148 | .ql-html-buttonOk {
149 | @apply bg-green-600 text-white font-medium p-2 rounded-md text-xs !important;
150 | }
151 |
152 | .ql-snow .ql-picker.ql-font .ql-picker-item[data-value="serif"]::before, .ql-font-serif {
153 | font-family: 'Merriweather', serif!important;
154 | }
155 |
156 | .ql-snow .ql-picker.ql-font .ql-picker-item[data-value="monospace"]::before, .ql-font-monospace {
157 | font-family: 'Source Code Pro', monospace!important;
158 | }
159 |
160 | .ql-container {
161 | height:unset!important;
162 | @apply bg-gray-800
163 | }
164 |
165 | .ql-toolbar.ql-snow {
166 | /* We need to do important because CSS makes the editor CSS higher prio than our edits */
167 | @apply border-none rounded-t-md mx-0 px-0 !important
168 | }
169 |
170 | .ql-container.ql-snow {
171 | @apply border-none rounded-md !important
172 | }
173 |
174 | .ql-container {
175 | font-family: "Inter var", ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, "Noto Sans", sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji"!important;
176 | }
177 |
178 | .ql-formats {
179 | @apply mr-2 !important
180 | }
181 |
182 | .ql-formats > * {
183 | @apply text-gray-200 mr-1 !important
184 | }
185 |
186 | .ql-picker-label {
187 | @apply rounded-md bg-gray-800 border-none !important
188 | }
189 |
190 | .ql-active {
191 | @apply rounded-md bg-gray-900 text-gray-200 !important
192 | }
193 |
194 | .ql-snow.ql-toolbar button {
195 | @apply bg-gray-800 rounded-md flex items-center justify-center !important
196 | }
197 |
198 | .ql-snow.ql-toolbar button.ql-active, .ql-snow .ql-toolbar button.ql-active, .ql-snow.ql-toolbar .ql-picker-label.ql-active, .ql-snow .ql-toolbar .ql-picker-label.ql-active, .ql-snow.ql-toolbar .ql-picker-item.ql-selected, .ql-snow .ql-toolbar .ql-picker-item.ql-selected {
199 | @apply text-primary-500 !important
200 | }
201 |
202 | .ql-snow.ql-toolbar button:hover, .ql-snow .ql-toolbar button:hover, .ql-snow.ql-toolbar button:focus, .ql-snow .ql-toolbar button:focus, .ql-snow.ql-toolbar .ql-picker-label:hover, .ql-snow .ql-toolbar .ql-picker-label:hover, .ql-snow.ql-toolbar .ql-picker-item:hover, .ql-snow .ql-toolbar {
203 | @apply bg-gray-900 rounded-md !important
204 | }
205 |
206 | .ql-snow.ql-toolbar button.ql-active, .ql-snow .ql-toolbar button.ql-active, .ql-snow.ql-toolbar .ql-picker-label.ql-active, .ql-snow .ql-toolbar .ql-picker-label.ql-active, .ql-snow.ql-toolbar .ql-picker-item.ql-selected, .ql-snow .ql-toolbar .ql-picker-item.ql-selected {
207 | @apply bg-primary-500/10 !important
208 | }
209 |
210 | .ql-editor {
211 | @apply prose prose-invert prose-headings:font-bold prose-headings:mb-2 max-w-full w-full
212 | }
213 |
214 | .ql-snow .ql-picker-options {
215 | @apply bg-gray-800 !important
216 | }
217 |
218 | .ql-editor.ql-blank::before {
219 | @apply text-gray-600 font-medium !important
220 | }
221 |
222 | .ql-picker-options {
223 | @apply rounded-md overflow-hidden border-none !important
224 | }
225 |
226 | .ql-picker-item:hover {
227 | @apply bg-gray-900 !important
228 | }
229 |
230 | .ql-picker-options .ql-selected:not([data-value]) {
231 | @apply bg-gray-900 text-primary-500 !important
232 | }
233 |
234 | .ql-picker-item:not([data-value]) {
235 | @apply bg-gray-800 !important
236 | }
237 |
238 | .ql-snow .ql-stroke {
239 | @apply stroke-gray-200 !important
240 | }
--------------------------------------------------------------------------------
/src/api_v1/models/presets.js:
--------------------------------------------------------------------------------
1 | import { router } from '../../router.js'
2 | import { Table } from '../../lib/table.js'
3 |
4 | // {
5 | // "id": "horseman-news",
6 | // "spec": [
7 | // {
8 | // "name": "Title",
9 | // "type": "string",
10 | // "args": {},
11 | // "index": true
12 | // },
13 | // {
14 | // "name": "Content",
15 | // "type": "html",
16 | // "args": {}
17 | // },
18 | // {
19 | // "name": "Tags",
20 | // "type": "tag",
21 | // "args": {},
22 | // "index": true
23 | // },
24 | // {
25 | // "name": "__all_objects_index",
26 | // "type": "string",
27 | // "index": true
28 | // }
29 | // ],
30 | // "options": {
31 | // "title_field": "Title"
32 | // },
33 | // }
34 |
35 | const generate_model = (name, spec, options) => {
36 | return {
37 | id: name,
38 | spec: spec,
39 | options: options
40 | }
41 | }
42 |
43 | router.get(router.version + '/presets', async (req, res) => {
44 | const presets = [
45 | {
46 | name: 'Blog',
47 | desc: 'A preset that gets you setup for writing blogs',
48 | models: [
49 | generate_model(
50 | 'posts',
51 | [
52 | {
53 | name: 'Title',
54 | type: 'string',
55 | args: {},
56 | index: true,
57 | help: 'The title of the blog post.'
58 | },
59 | {
60 | name: 'Author',
61 | type: 'relationship',
62 | args: {
63 | model: 'authors'
64 | },
65 | index: true,
66 | help: 'This is your author profile. If you havent made one yet, swap over to the "Authors" tab and create one. Make sure to publish it and then come back.'
67 | },
68 | {
69 | name: 'Content',
70 | type: 'html',
71 | args: {}
72 | },
73 | {
74 | name: 'Tags',
75 | type: 'tag',
76 | args: {},
77 | index: true
78 | }
79 | ],
80 | {
81 | title_field: 'Title',
82 | preset: true
83 | }
84 | ),
85 | generate_model(
86 | 'authors',
87 | [
88 | {
89 | name: 'Name',
90 | type: 'string',
91 | args: {},
92 | index: true
93 | },
94 | {
95 | name: 'Biography',
96 | type: 'html',
97 | args: {}
98 | },
99 | {
100 | name: 'Image',
101 | type: 'string',
102 | args: {},
103 | help: 'A URL of your avatar goes here.'
104 | }
105 | ],
106 | {
107 | title_field: 'Name',
108 | preset: true
109 | }
110 | )
111 | ]
112 | },
113 | {
114 | name: 'Portfolio',
115 | desc: 'A preset that gets you setup for writing portfolios',
116 | models: [
117 | generate_model(
118 | 'projects',
119 | [
120 | {
121 | name: 'Title',
122 | type: 'string',
123 | args: {},
124 | index: true,
125 | help: 'The title of the project.'
126 | },
127 | {
128 | name: 'Tags',
129 | type: 'tag',
130 | args: {},
131 | index: true,
132 | help: 'Any tags you want to associate to this project, for example "Vue.JS", "Tailwind", "Python", "PHP".'
133 | },
134 | {
135 | name: 'Image',
136 | type: 'string',
137 | args: {},
138 | index: false,
139 | help: 'The image that will be used to represent this project on your home page or portfolio page.'
140 | },
141 | {
142 | name: 'Content',
143 | type: 'html',
144 | args: {},
145 | help: 'Give us a description of your project, what you did, how you did it, what are you proud of, etc.'
146 | }
147 | ],
148 | {
149 | title_field: 'Title',
150 | preset: true
151 | }
152 | ),
153 | generate_model(
154 | 'authors',
155 | [
156 | {
157 | name: 'Name',
158 | type: 'string',
159 | args: {},
160 | index: true
161 | },
162 | {
163 | name: 'Biography',
164 | type: 'html',
165 | args: {}
166 | },
167 | {
168 | name: 'Image',
169 | type: 'string',
170 | args: {}
171 | }
172 | ],
173 | {
174 | title_field: 'Name',
175 | preset: true
176 | }
177 | )
178 | ]
179 | }
180 | ]
181 |
182 | res.body = {
183 | success: true,
184 | presets
185 | }
186 | })
--------------------------------------------------------------------------------
/frontend/src/views/dashboard/objects/list.vue:
--------------------------------------------------------------------------------
1 |
2 | 11 | Clear cache 12 |
13 |
14 | Clearing cache will reset the server-side cache for all 250+ locations. This will significantly slow down the speed of your key for the first hit. You will also incur a read hit for each location as your key is requested.
15 |
16 | Horseman manages its own cache efficiently, however if you notice your key is not being served, you can clear the cache manually.
17 |
18 |
19 | Clear {{model.id}}'s cache
20 |
21 | 36 | Manage how you access your data by limiting what keys can do. 37 |
38 | 39 | 46 | 47 | 48 |
49 |
62 |
63 |
50 |
53 | You have no keys 😢
54 |
61 | 55 | Once you have created one, they will show up here for you to add keys to 56 |
57 |58 | Your search query may not have any results, the search box will only find results in the keys title. 59 |
60 |
65 |
87 |
66 |
67 |
86 |
68 |
77 |
69 |
73 |
70 | {{ key.label || key.id }}
71 |
72 |
74 | Created {{new Date(key?.metadata?.created_at).toLocaleDateString()}}
75 |
76 |
78 |
79 | Public
80 |
81 |
82 | Preview
83 |
84 |
85 |
3 |
4 |
10 |
14 | Clearing cache will reset the server-side cache for all 250+ locations. This will significantly slow down the speed of your content for the first hit. You will also incur a read hit for each location as your content is requested.
15 |
18 |
19 | Clear {{model.id}}'s cache
20 |
21 |
22 |
23 |
34 |
35 |
76 |
100 |
101 |
102 |
103 |
--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
1 | -----------------------------------------------------------------------------
2 |
3 | Business Source License 1.1
4 |
5 | License text copyright (c) 2017 MariaDB Corporation Ab, All Rights Reserved.
6 | "Business Source License" is a trademark of MariaDB Corporation Ab.
7 |
8 | -----------------------------------------------------------------------------
9 |
10 | Parameters
11 |
12 | Licensor: Connor Vince
13 |
14 | Licensed Work: Horseman, the headless CMS
15 | The Licensed Work is (c) 2022 Connor Vince.
16 |
17 | Additional Use Grant: You may make use of the Licensed Work, provided you
18 | do not use it in any of the following ways:
19 |
20 |
21 | * Sell hosted Horseman services as a "SaaS" Product
22 |
23 | (1) Operate or sell access to Horseman APIs, data,
24 | or authorization of the Licensed Work as a
25 | for-profit service, regardless of whether the use of
26 | these components is sold alone or is bundled with other
27 | services. Note that this does not apply to the use of
28 | Horseman behind the scenes to operate a service not
29 | related to Horseman's API.
30 |
31 | * Create Non-Open-Source Commercial Derviative Works
32 |
33 | (2) Link or directly include the Licensed Work in a
34 | commercial or for-profit application or other product
35 | not distributed under an Open Source Initiative (OSI)
36 | compliant license. See: https://opensource.org/licenses
37 |
38 | (3) Remove the name, logo, copyright, or other branding
39 | material from the Licensed Work to create a "rebranded"
40 | or "white labeled" version to distribute as part of
41 | any commercial or for-profit product or service.
42 |
43 | * Certain Government Uses
44 |
45 | (4) Use or deploy the Licensed Work in a government
46 | setting in support of any active government function
47 | or operation with the exception of the following:
48 | physical or mental health care, family and social
49 | services, social welfare, senior care, child care, and
50 | the care of persons with disabilities.
51 |
52 | Change Date: 2024-01-01
53 |
54 | Change License: Apache License version 2.0 as published by the Apache
55 | Software Foundation
56 | https://www.apache.org/licenses/
57 |
58 | Alternative Licensing
59 |
60 | If you would like to use the Licensed Work in any way that conflicts with
61 | the stipulations of the Additional Use Grant, contact Connor Vince. to
62 | obtain an alternative commercial license.
63 |
64 | Visit us on the web at: https://horseman.ceru.dev
65 |
66 | Notice
67 |
68 | The Business Source License (this document, or the "License") is not an Open
69 | Source license. However, the Licensed Work will eventually be made available
70 | under an Open Source License, as stated in this License.
71 |
72 | For more information on the use of the Business Source License generally,
73 | please visit the Adopting and Developing Business Source License FAQ at
74 | https://mariadb.com/bsl-faq-adopting.
75 |
76 | -----------------------------------------------------------------------------
77 |
78 | Business Source License 1.1
79 |
80 | Terms
81 |
82 | The Licensor hereby grants you the right to copy, modify, create derivative
83 | works, redistribute, and make non-production use of the Licensed Work. The
84 | Licensor may make an Additional Use Grant, above, permitting limited
85 | production use.
86 |
87 | Effective on the Change Date, or the fourth anniversary of the first publicly
88 | available distribution of a specific version of the Licensed Work under this
89 | License, whichever comes first, the Licensor hereby grants you rights under
90 | the terms of the Change License, and the rights granted in the paragraph
91 | above terminate.
92 |
93 | If your use of the Licensed Work does not comply with the requirements
94 | currently in effect as described in this License, you must purchase a
95 | commercial license from the Licensor, its affiliated entities, or authorized
96 | resellers, or you must refrain from using the Licensed Work.
97 |
98 | All copies of the original and modified Licensed Work, and derivative works
99 | of the Licensed Work, are subject to this License. This License applies
100 | separately for each version of the Licensed Work and the Change Date may vary
101 | for each version of the Licensed Work released by Licensor.
102 |
103 | You must conspicuously display this License on each original or modified copy
104 | of the Licensed Work. If you receive the Licensed Work in original or
105 | modified form from a third party, the terms and conditions set forth in this
106 | License apply to your use of that work.
107 |
108 | Any use of the Licensed Work in violation of this License will automatically
109 | terminate your rights under this License for the current and all other
110 | versions of the Licensed Work.
111 |
112 | This License does not grant you any right in any trademark or logo of
113 | Licensor or its affiliates (provided that you may use a trademark or logo of
114 | Licensor as expressly required by this License).
115 |
116 | TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
117 | AN "AS IS" BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
118 | EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
119 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
120 | TITLE.
121 |
122 | -----------------------------------------------------------------------------
123 |
124 | MariaDB hereby grants you permission to use this License’s text to license
125 | your works, and to refer to it using the trademark "Business Source License",
126 | as long as you comply with the Covenants of Licensor below.
127 |
128 | Covenants of Licensor
129 |
130 | In consideration of the right to use this License’s text and the "Business
131 | Source License" name and trademark, Licensor covenants to MariaDB, and to all
132 | other recipients of the licensed work to be provided by Licensor:
133 |
134 | 1. To specify as the Change License the GPL Version 2.0 or any later version,
135 | or a license that is compatible with GPL Version 2.0 or a later version,
136 | where "compatible" means that software provided under the Change License can
137 | be included in a program with software provided under GPL Version 2.0 or a
138 | later version. Licensor may specify additional Change Licenses without
139 | limitation.
140 |
141 | 2. To either: (a) specify an additional grant of rights to use that does not
142 | impose any additional restriction on the right granted in this License, as
143 | the Additional Use Grant; or (b) insert the text "None".
144 |
145 | 3. To specify a Change Date.
146 |
147 | 4. Not to modify this License in any other way.
--------------------------------------------------------------------------------
/src/api_v1/models/content.js:
--------------------------------------------------------------------------------
1 | import { router } from '../../router.js'
2 | import { Table } from '../../lib/table.js'
3 |
4 | import slugify from 'slugify'
5 | import mask from 'json-mask'
6 |
7 | // LIST OBJECT
8 | router.get(router.version + '/models/:modelID/objects', router.requires_auth, async (req, res) => {
9 | const tbl = new Table(
10 | req.user.id,
11 | req.params.modelID
12 | )
13 |
14 | let index = req.query.index || '__all_objects_index'
15 | let query = req.query.q || 0
16 | let mode = 'eq'
17 |
18 | const spec = await tbl.get_spec()
19 |
20 | const target = Object.keys(req.query).find(q => spec.map(x => x.name.toLowerCase()).includes(q.toLowerCase()))
21 |
22 | if (target) {
23 | query = req.query[target]
24 |
25 | // parse query
26 | if (query.split('.').length == 2) {
27 | mode = query.split('.')[0]
28 | query = query.split('.')[1]
29 | } else {
30 | res.body = {
31 | success: false,
32 | error: 'Query filters require a prefix, for example: "eq.value", "gt.1", "neq.bad value"'
33 | }
34 | res.status = 400
35 | return
36 | }
37 |
38 | index = target
39 | }
40 |
41 | let models = await tbl.list(
42 | index,
43 | query,
44 | {
45 | mode,
46 | limit: 20,
47 | order: 'newest_first',
48 | read_level: req.user.read_level,
49 | }
50 | )
51 |
52 | models = models.map(x => {
53 | let new_obj = Object.assign({}, x)
54 |
55 | Object.keys(x).map(field_key => {
56 | const field = spec.find(field => field.name.toLowerCase() == field_key.toLowerCase())
57 |
58 | if (field) {
59 | if (field.type == 'html') {
60 | new_obj[field_key] = new_obj[field_key].replaceAll('11 | Clear cache 12 |
13 |
14 | Clearing cache will reset the server-side cache for all 250+ locations. This will significantly slow down the speed of your content for the first hit. You will also incur a read hit for each location as your content is requested.
15 |
16 | Horseman manages its own cache efficiently, however if you notice your content is not being served, you can clear the cache manually.
17 |
18 |
19 | Clear {{model.id}}'s cache
20 |
21 | 36 | Create and manage your {{model.id}} objects without needing to create your own interface. Just click and enter the Horseman Editor. 37 |
38 | 39 |
40 | Access your data via the API by visiting this URL:
41 |
42 | {{ $api.api_url }}/models/{{model.id}}/objects?key={{(keys[0] || {}).id}} 43 |
44 |
45 |
52 |
53 | 42 | {{ $api.api_url }}/models/{{model.id}}/objects?key={{(keys[0] || {}).id}} 43 |
54 |
58 |
59 |
60 | 55 | Loading content, this could take some time if you have a lot. 56 |
57 |
61 |
74 |
75 |
62 |
65 | You have no objects for this model 😢
66 |
73 | 67 | Once you have created one, they will show up here for you to add objects to 68 |
69 |70 | Your search query may not have any results, the search box will only find results in the objects title. 71 |
72 |
77 |
99 |
78 |
79 |
98 |
80 |
89 |
81 |
85 |
82 | {{ content[ model.options.title_field || 'id' ] }}
83 |
84 |
86 | Created {{new Date(content.metadata.created_at).toLocaleDateString()}}
87 |
88 |
90 |
91 | Unpublished
92 |
93 |
94 | Published
95 |
96 |
97 | ') 61 | } else { 62 | new_obj[field_key] = new_obj[field_key] 63 | } 64 | } else { 65 | new_obj[field_key] = new_obj[field_key] 66 | } 67 | }) 68 | 69 | return new_obj 70 | }) 71 | 72 | if ('expand' in req.query) { 73 | const expand = req.query.expand.split(',') 74 | 75 | for (let target of expand) { 76 | // expand each objects internal fields if the field type is "relationship" 77 | const is_valid = spec.filter(x => x.type=='relationship') 78 | .map(x => x.name) 79 | .includes(target) 80 | 81 | if (!is_valid) { 82 | res.body = { 83 | success: false, 84 | error: 'Invalid expand target: ' + target, 85 | extra: `Must be one of ${spec.filter(x=>x.type=='relationship').map(x => x.name).join(', ')}`, 86 | code: 'INVALID_EXPAND_TARGET' 87 | } 88 | res.status = 400 89 | return 90 | } 91 | 92 | const expand_table = new Table( 93 | req.user.id, 94 | spec.find(x => x.name == target).args.model 95 | ) 96 | 97 | models = await Promise.all(models.map(async found_item => { 98 | const object = await expand_table.get( 99 | 'id', 100 | found_item[target] 101 | ) 102 | 103 | if (!object.id) { 104 | found_item[target] = null 105 | return found_item 106 | } 107 | 108 | if (req.user.read_level == 'preview' || object?.metadata?.published) { 109 | delete object.__all_objects_index 110 | found_item[target] = object 111 | return found_item 112 | } 113 | 114 | found_item[target] = { 115 | error: 'Object is not published, cannot be expanded. This API key does not have the required read level.', 116 | } 117 | 118 | return found_item 119 | })) 120 | } 121 | } 122 | 123 | 124 | res.body = { 125 | success: true, 126 | results: models.map(x => { 127 | delete x.__all_objects_index 128 | return req.query.fields ? mask(x, req.query.fields) : x 129 | }), 130 | model: await (new Table(req.user.id, 'models')).get( 131 | 'id', 132 | req.params.modelID 133 | ) 134 | } 135 | }) 136 | 137 | // GET OBJECT 138 | router.get(router.version + '/models/:modelID/objects/:objectID', router.requires_auth, async (req, res) => { 139 | const tbl = new Table( 140 | req.user.id, 141 | req.params.modelID 142 | ) 143 | 144 | const object = await tbl.get( 145 | 'id', 146 | req.params.objectID 147 | ) 148 | 149 | delete object.__all_objects_index 150 | 151 | res.body = { 152 | success: true, 153 | object 154 | } 155 | }) 156 | 157 | // CREATE A NEW OBJECT 158 | router.post(router.version + '/models/:modelID/objects', router.requires_auth, async (req, res) => { 159 | const tbl = new Table( 160 | req.user.id, 161 | req.params.modelID 162 | ) 163 | 164 | req.body.__all_objects_index = 0 165 | 166 | req.body.metadata = { 167 | userID: req.user.id, 168 | published: false, 169 | created_at: new Date().toISOString() 170 | } 171 | 172 | const model = await tbl.put(req.body) 173 | 174 | res.body = { 175 | success: true, 176 | model 177 | } 178 | }) 179 | 180 | // UPDATE AN OBJECT 181 | router.post(router.version + '/models/:modelID/objects/:objectID', router.requires_auth, async (req, res) => { 182 | // create a new model 183 | const tbl = new Table( 184 | req.user.id, 185 | req.params.modelID 186 | ) 187 | 188 | const spec = await tbl.get_spec() 189 | 190 | const update = {} 191 | 192 | spec.map(x => { 193 | // prevents the user from updating keys and values we need for record keeping like metadata and id. 194 | if (req.body[x.name]) { 195 | update[x.name] = req.body[x.name] 196 | } 197 | }) 198 | 199 | await tbl.update( 200 | req.params.objectID, 201 | update 202 | ) 203 | 204 | res.body = { 205 | success: true 206 | } 207 | }) 208 | 209 | // UPDATE AN OBJECTS STATE 210 | router.post(router.version + '/models/:modelID/objects/:objectID/state', router.requires_auth, async (req, res) => { 211 | const tbl = new Table( 212 | req.user.id, 213 | req.params.modelID 214 | ) 215 | 216 | const object = await tbl.get( 217 | 'id', 218 | req.params.objectID 219 | ) 220 | 221 | if (req.body.published) { 222 | object.metadata.published = true 223 | object.metadata.published_at = new Date().toISOString() 224 | } else { 225 | object.metadata.published = false 226 | object.metadata.published_at = null 227 | } 228 | 229 | await tbl.update( 230 | req.params.objectID, 231 | { 232 | metadata: object.metadata 233 | } 234 | ) 235 | 236 | res.body = { 237 | success: true, 238 | published: object.metadata.published 239 | } 240 | }) 241 | 242 | // DELETE AN OBJECT 243 | router.delete(router.version + '/models/:modelID/objects/:objectID', router.requires_auth, async (req, res) => { 244 | // create a new model 245 | const tbl = new Table( 246 | req.user.id, 247 | req.params.modelID 248 | ) 249 | 250 | await tbl.delete( 251 | req.params.objectID 252 | ) 253 | 254 | res.body = { 255 | success: true 256 | } 257 | }) 258 | 259 | // CLEAR MODEL CACHE 260 | router.delete(router.version + '/models/:modelID/cache', router.requires_auth, async (req, res) => { 261 | const tbl = new Table( 262 | req.user.id, 263 | req.params.modelID 264 | ) 265 | 266 | await tbl.get_spec() 267 | 268 | // list all of this models indexes 269 | const indexes = tbl.spec.map(x => x.index ? x.name : null ).filter(x=>x) 270 | 271 | await Promise.all(indexes.map(async x => { 272 | return tbl.cache.delete(`${tbl.get_kv_prefix()}:${x}:index`) 273 | })) 274 | 275 | const keys = await tbl.list( 276 | '__all_objects_index', 277 | 0, 278 | { 279 | mode: 'eq', 280 | limit: 1000, 281 | resolve: false 282 | } 283 | ) 284 | 285 | await Promise.all(keys.map(async x => { 286 | console.log(`${tbl.get_kv_prefix()}:${x}`) 287 | return tbl.cache.delete(`${tbl.get_kv_prefix()}:${x}`) 288 | })) 289 | 290 | res.body = { 291 | success: true, 292 | } 293 | }) -------------------------------------------------------------------------------- /src/api_v1/auth/accounts.js: -------------------------------------------------------------------------------- 1 | import { router } from '../../router.js' 2 | import { Table } from '../../lib/table.js' 3 | 4 | router.get(router.version + '/auth/@me', router.requires_auth, async (req, res) => { 5 | 6 | 7 | req.user.options = req.user.options || {} // polyfill, babeyy 8 | 9 | res.body = { 10 | success: true, 11 | user: req.user 12 | } 13 | }) 14 | 15 | router.post(router.version + '/auth/password-fix', router.requires_auth, async (req, res) => { 16 | const hash_resp = await env.PASSWORD_HASHING.fetch('https://hash.com/v1/hash', { 17 | method: 'POST', 18 | headers: { 'Authorization': env.PASSWORD_HASHER_KEY, 'content-type': 'application/json' }, 19 | body: JSON.stringify({ 20 | password: req.body.password 21 | }) 22 | }).then(r => r.json()) 23 | 24 | if (!hash_resp.success) { 25 | res.body = { 26 | success: false, 27 | error: `We're sorry, there was an issue with the password hashing service. Please try again later.` 28 | } 29 | res.status = 500 30 | return 31 | } 32 | 33 | const hashed_password = hash_resp.hash 34 | 35 | const acc = new Table( 36 | 'internal', 37 | 'accounts' 38 | ) 39 | 40 | await acc.update( 41 | req.user.id, 42 | { 43 | password_hash: hashed_password 44 | } 45 | ) 46 | 47 | res.body = { 48 | success: true 49 | } 50 | }) 51 | 52 | router.post(router.version + '/auth/signup', async (req, res) => { 53 | if (!env.ALLOW_SIGNUPS) { 54 | res.body = { 55 | success: false, 56 | error: 'Signups are not allowed right now, please try again later.', 57 | code: 'SIGNUPS_NOT_ALLOWED' 58 | } 59 | res.status = 403 60 | return 61 | } 62 | 63 | const acc = new Table( 64 | 'internal', 65 | 'accounts' 66 | ) 67 | 68 | const data = req.body 69 | 70 | if (!data.password) { 71 | res.body = { 72 | success: false, 73 | error: 'No password provided' 74 | } 75 | res.status = 400 76 | return 77 | } 78 | 79 | if (await acc.get('email', data.email)) { 80 | res.body = { 81 | success: false, 82 | error: 'Email already in use' 83 | } 84 | res.status = 400 85 | return 86 | } 87 | 88 | const hash_resp = await env.PASSWORD_HASHING.fetch('https://hash.com/v1/hash', { 89 | method: 'POST', 90 | headers: { 'Authorization': env.PASSWORD_HASHER_KEY, 'content-type': 'application/json' }, 91 | body: JSON.stringify({ 92 | password: req.body.password 93 | }) 94 | }).then(r => r.json()) 95 | 96 | if (!hash_resp.success) { 97 | res.body = { 98 | success: false, 99 | error: `We're sorry, there was an issue with the password hashing service. Please try again later.` 100 | } 101 | res.status = 500 102 | return 103 | } 104 | 105 | const hashed_password = hash_resp.hash 106 | 107 | 108 | 109 | const account = await acc.put({ 110 | 'email': data.email, 111 | 'token': acc.generate_id(20), 112 | 'password_hash': hashed_password 113 | }) 114 | 115 | const keys = new Table( 116 | 'internal', 117 | 'keys' 118 | ) 119 | 120 | // we can use the ID of the key instead of a token since the tok and ID gen are the same generator. 121 | await keys.put({ 122 | userID: account.id, 123 | type: 'public', // public keys are used for accessing Objects that are published 124 | // a key with the type of `preview` is used for accessing Objects that are marked as "draft" 125 | permissions: [ 'read:all' ], 126 | }) 127 | 128 | res.body = { 129 | success: true, 130 | account 131 | } 132 | }) 133 | 134 | router.post(router.version + '/auth/login', async (req, res) => { 135 | const data = req.body 136 | 137 | const acc = new Table( 138 | 'internal', 139 | 'accounts' 140 | ) 141 | 142 | const existing = await acc.get( 143 | 'email', 144 | data.email 145 | ) 146 | 147 | if (!existing) { 148 | res.body = { 149 | success: false, 150 | error: 'No account found with that email address.', 151 | code: 'NO_ACCOUNT' 152 | } 153 | res.status = 403 154 | return 155 | } 156 | 157 | const resp = await env.PASSWORD_HASHING.fetch('https://hash.com/v1/compare', { 158 | method: 'POST', 159 | headers: { 'Authorization': env.PASSWORD_HASHER_KEY, 'content-type': 'application/json' }, 160 | body: JSON.stringify({ 161 | password: req.body.password, 162 | hash: existing.password_hash 163 | }) 164 | }).then(resp => resp.json()) 165 | 166 | console.log(resp) 167 | 168 | if (!resp.is_same) { 169 | res.body = { 170 | success: false, 171 | error: 'Email/password incorrect', 172 | code: 'INCORRECT_AUTH' 173 | } 174 | res.status = 403 175 | return 176 | } 177 | 178 | res.body = { 179 | success: true, 180 | user: existing 181 | } 182 | }) 183 | 184 | router.get(router.version + '/auth/keys', router.requires_auth, async (req, res) => { 185 | const keys = await new Table('internal', 'keys').list( 186 | 'userID', 187 | req.user.id, 188 | { 189 | limit: 100, 190 | order: 'newest_first' 191 | } 192 | ) 193 | 194 | res.body = { 195 | success: true, 196 | results: keys 197 | } 198 | }) 199 | 200 | router.get(router.version + '/auth/keys/:keyID', router.requires_auth, async (req, res) => { 201 | const tbl = new Table('internal', 'keys') 202 | 203 | const key = await tbl.get( 204 | 'id', 205 | req.params.keyID 206 | ) 207 | 208 | if (!key) { 209 | res.body = { 210 | success: false, 211 | error: 'Key not found', 212 | code: 'KEY_NOT_FOUND' 213 | } 214 | res.status = 404 215 | return 216 | } 217 | 218 | if (key.userID !== req.user.id) { 219 | res.body = { 220 | success: false, 221 | error: 'You do not have permission to access this key', 222 | code: 'NO_PERMISSION' 223 | } 224 | res.status = 403 225 | return 226 | } 227 | 228 | res.body = { 229 | success: true, 230 | key 231 | } 232 | }) 233 | 234 | // POST 235 | router.post(router.version + '/auth/keys', router.requires_auth, async (req, res) => { 236 | const keys = new Table( 237 | 'internal', 238 | 'keys' 239 | ) 240 | 241 | const key = await keys.put({ 242 | userID: req.user.id, 243 | type: req.body.type, // public keys are used for accessing Objects that are published 244 | label: req.body.label.substring(0, 255), 245 | // a key with the type of `preview` is used for accessing Objects that are marked as "draft" 246 | permissions: req.body.permissions, 247 | }) 248 | 249 | res.body = { 250 | success: true, 251 | key 252 | } 253 | }) 254 | 255 | // Update a key 256 | router.post(router.version + '/auth/keys/:keyID', router.requires_auth, async (req, res) => { 257 | const tbl = new Table( 258 | 'internal', 259 | 'keys' 260 | ) 261 | 262 | const key = await tbl.get( 263 | 'id', 264 | req.params.keyID 265 | ) 266 | 267 | if (!key) { 268 | res.body = { 269 | success: false, 270 | error: 'Key not found', 271 | code: 'KEY_NOT_FOUND' 272 | } 273 | res.status = 404 274 | return 275 | } 276 | 277 | if (key.userID !== req.user.id) { 278 | res.body = { 279 | success: false, 280 | error: 'You do not have permission to access this key', 281 | code: 'NO_PERMISSION' 282 | } 283 | res.status = 403 284 | return 285 | } 286 | 287 | const update = { 288 | type: req.body.type, 289 | label: req.body.label.substring(0, 255), 290 | permissions: req.body.permissions, 291 | } 292 | 293 | await tbl.update( 294 | req.params.keyID, 295 | update 296 | ) 297 | 298 | res.body = { 299 | success: true 300 | } 301 | }) 302 | 303 | 304 | router.delete(router.version + '/auth/keys/:keyID', router.requires_auth, async (req, res) => { 305 | const tbl = new Table('internal', 'keys') 306 | 307 | const key = await tbl.get( 308 | 'id', 309 | req.params.keyID 310 | ) 311 | 312 | if (!key) { 313 | res.body = { 314 | success: false, 315 | error: 'Key not found', 316 | code: 'KEY_NOT_FOUND' 317 | } 318 | res.status = 404 319 | return 320 | } 321 | 322 | if (key.userID !== req.user.id) { 323 | res.body = { 324 | success: false, 325 | error: 'You do not have permission to access this key', 326 | code: 'NO_PERMISSION' 327 | } 328 | res.status = 403 329 | return 330 | } 331 | 332 | await tbl.delete( 333 | key.id 334 | ) 335 | 336 | res.body = { 337 | success: true, 338 | key 339 | } 340 | }) -------------------------------------------------------------------------------- /frontend/src/views/dashboard/objects/edit.vue: -------------------------------------------------------------------------------- 1 | 2 |
3 |
4 |
71 |
72 |
73 |
--------------------------------------------------------------------------------
/frontend/src/views/dashboard/models/edit.vue:
--------------------------------------------------------------------------------
1 |
2 |
10 |
30 |
31 | 11 | {{ $route.params.objectID == 'new' ? 'Creating' : 'Editing' }} {{model.id}} 12 |
13 | 14 | 15 | Delete 16 | 17 | 18 | 19 | Unpublish 20 | 21 | 22 | 23 | Publish 24 | 25 | 26 | 27 | {{ $route.params.objectID == 'new' ? 'Create' : 'Save' }} 28 | 29 |
32 |
70 |
33 |
34 |
41 |
42 |
43 |
44 |
45 |
46 |
47 |
48 |
68 |
69 |
51 |
60 |
61 |
3 |
17 |
19 |
20 |
119 |
120 |
121 |
--------------------------------------------------------------------------------
/frontend/src/views/dashboard/presets.vue:
--------------------------------------------------------------------------------
1 |
2 |
4 |
15 |
16 | 5 | {{ model.id == 'new' ? 'Creating' : 'Editing' }} {{model.id == 'new' ? 'new model' : model.id}} 6 |
7 | 8 | 9 | Delete 10 | 11 | 12 | Save 13 | 14 |
21 |
118 |
22 | Model specification
23 |
24 | New field
25 |
26 |
27 |
28 | 29 | This is used to describe what your data will look like and how you want to store it. As a note, you cannot add new indexable fields once the model is created. 30 |
31 | 32 |
33 |
117 |
34 |
51 |
52 |
53 |
54 |
55 |
56 |
57 |
58 |
59 |
60 |
61 |
62 |
63 |
64 |
65 |
66 |
67 |
68 |
69 |
79 |
80 |
81 |
82 |
116 |
70 |
77 |
78 | 71 | {{element.name}} 72 |
73 | 74 | {{element.type}} 75 | 76 |
83 |
88 |
89 |
84 | Dropdown options
85 |
86 |
90 |
101 |
102 |
103 |
104 |
91 | Relationship options
92 |
93 |
105 | This field is the model's title
106 |
107 |
108 |
109 | Indexable
110 |
111 |
112 |
113 | This field is being indexed.
114 |
115 |
3 |
4 |
10 |
42 |
43 |
44 |
52 |
54 |
55 |
87 |
88 |
113 |
114 |
115 |
263 |
264 |
265 |
--------------------------------------------------------------------------------
/src/lib/table.js:
--------------------------------------------------------------------------------
1 | // This is where the magic happens.
2 | // This file is responsible for manaing the data in our "table".
3 | // Since KV has no idea what a table is, we simulate one by creating
4 | // indexes and datastores as if we were a real table.
5 |
6 | import { nanoid } from 'nanoid'
7 | import wcmatch from 'wildcard-match'
8 | import { Cache } from './cache.js'
9 | import { ServerTiming } from './timing.js'
10 |
11 | export class Table {
12 | constructor (userID, table) {
13 | this.userID = userID
14 | this.table = table
15 | this.cache = new Cache()
16 | this.spec = {}
17 | }
18 |
19 | get_kv_prefix() {
20 | return `${this.userID}:${this.table}`
21 | }
22 |
23 | generate_id(length) {
24 | return nanoid(length || 12)
25 | }
26 |
27 | // All models require a "spec" to be defined.
28 | // this ensures the data is always in the same format.
29 | // Right now, we dont validate spec, but we should in the future.
30 | // Specs are also responsible for index mangement.
31 | async get_spec() {
32 | // hard-coded models schema. this basically never changes but is needed for inital model creation.
33 | if (this.table == 'models') {
34 | this.spec = [
35 | {
36 | name: '__all_objects_index',
37 | type: 'string',
38 | index: true
39 | },
40 | {
41 | name: 'spec',
42 | type: 'array'
43 | },
44 | {
45 | name: 'options',
46 | type: 'object'
47 | },
48 | ]
49 |
50 | return this.spec
51 | }
52 |
53 | let spec = await this.cache.read(`${this.get_kv_prefix()}:spec`, async () => {
54 | increase_cost('read')
55 | return await env.INDEXKV.get(`${this.get_kv_prefix()}:spec`, { type: 'json' })
56 | })
57 |
58 |
59 | this.spec = spec
60 | return spec
61 | }
62 |
63 | async set_spec(spec) {
64 | await env.INDEXKV.put(`${this.get_kv_prefix()}:spec`, JSON.stringify(spec))
65 | }
66 |
67 | async index_field(prefix, value, objectID) {
68 | const durable = env.IndexWriter.get(env.IndexWriter.idFromName(`${prefix}`))
69 |
70 | const new_index = await durable.fetch(
71 | `http://internal/v1/write`,
72 | {
73 | method: 'POST',
74 | headers: { 'Content-Type': 'application/json' },
75 | body: JSON.stringify({ prefix, value, objectID, ts: new Date().toISOString() })
76 | }
77 | ).then(resp => resp.json())
78 |
79 | // If the DO is in a different location, such as if the colo cannot make DOs,
80 | // then the KV propagation will be extremely slow.
81 | // we "abuse" the Cache API to act as a pseudo KV solution to allow for instant KV propagation to the colo
82 | await this.cache.write(
83 | `${prefix}:index`,
84 | new_index.index
85 | )
86 | }
87 |
88 | async delete_index(prefix, objectID) {
89 | const durable = env.IndexWriter.get(env.IndexWriter.idFromName(`${prefix}`))
90 |
91 | const new_index = await durable.fetch(
92 | `http://internal/v1/delete`,
93 | {
94 | method: 'POST',
95 | headers: { 'Content-Type': 'application/json' },
96 | body: JSON.stringify({ prefix, objectID })
97 | }
98 | ).then(resp => resp.json())
99 |
100 | await this.cache.write(
101 | `${prefix}:index`,
102 | new_index.index
103 | )
104 | }
105 |
106 | async get(index, search) {
107 | const timer = new ServerTiming(
108 | 'object-get',
109 | `${index}:${search}`
110 | )
111 |
112 | if (index == 'id') {
113 | // no need for an index
114 | const obj = await this.cache.read(`${this.get_kv_prefix()}:${search}`, async () => {
115 | increase_cost('read')
116 | return await env.CONTENTKV.get(`${this.get_kv_prefix()}:${search}`, { type: 'json', })
117 | })
118 |
119 | timer.finish()
120 | return obj
121 | }
122 |
123 | const key = `${this.get_kv_prefix()}:${index}:index`
124 |
125 | const idx = await this.cache.read(key, async () => {
126 | increase_cost('read')
127 | return await env.INDEXKV.get(key, { type: 'json' })
128 | })
129 |
130 | if ((!idx || !idx.length)) {
131 | return null
132 | }
133 |
134 | const first = idx.find(x => x[0] == search)
135 |
136 | if (!first) {
137 | return null
138 | }
139 |
140 | const object = await this.cache.read(`${this.get_kv_prefix()}:${first[1]}`, async () => {
141 | increase_cost('read')
142 | return await env.CONTENTKV.get(`${this.get_kv_prefix()}:${first[1]}`, { type: 'json' })
143 | })
144 |
145 | timer.finish()
146 |
147 | return object
148 | }
149 |
150 | async put(object, opt) {
151 | const options = Object.assign({
152 | update_indexes: true // disable if this is an update operation where the indexed fields dont get changed
153 | }, opt)
154 |
155 | await this.get_spec()
156 |
157 | if (!object.id) {
158 | object.id = nanoid(12)
159 | }
160 |
161 | if (!object.metadata) {
162 | object.metadata = {
163 | published: true,
164 | published_at: new Date().toISOString(),
165 | created_at: new Date().toISOString(),
166 | }
167 | }
168 |
169 | const objectID = `${this.get_kv_prefix()}:${object.id}`
170 |
171 | increase_cost('write')
172 | object.__all_objects_index = 0
173 |
174 | await env.CONTENTKV.put(objectID, JSON.stringify(object))
175 |
176 | const cache_clears = []
177 |
178 | await Promise.all(this.spec.map(async field => {
179 | if (field.index) {
180 | increase_cost('write')
181 | await this.cache.delete(`${this.get_kv_prefix()}:${field.name}:index`)
182 |
183 | const data = await this.index_field(
184 | // prefix should be userID:tablename:field
185 | `${this.get_kv_prefix()}:${field.name}`,
186 | object[field.name],
187 | object.id
188 | )
189 |
190 | return data
191 | } else {
192 | return Promise.resolve(null)
193 | }
194 | }))
195 |
196 | // clear cache of existing IDX
197 | await Promise.all(cache_clears)
198 |
199 | return object
200 | }
201 |
202 | async update(existingID, modifications) {
203 | await this.get_spec()
204 |
205 | const existing = await this.get(
206 | 'id',
207 | existingID
208 | )
209 |
210 | const object = Object.assign(
211 | existing,
212 | modifications
213 | )
214 |
215 | const objectID = `${this.get_kv_prefix()}:${object.id}`
216 |
217 | increase_cost('write')
218 | await env.CONTENTKV.put(objectID, JSON.stringify(object))
219 | await this.cache.delete(objectID)
220 |
221 | const cache_clears = []
222 |
223 | await Promise.all(this.spec.map(async field => {
224 | if (field.index) {
225 | if (existing[field.name] != object[field.name]) {
226 | increase_cost('write')
227 | const data = await this.index_field(
228 | // prefix should be userID:tablename:field
229 | `${this.get_kv_prefix()}:${field.name}`,
230 | object[field.name],
231 | object.id
232 | )
233 |
234 | await this.cache.delete(`${this.get_kv_prefix()}:${field.name}:index`)
235 |
236 | return data
237 | }
238 | }
239 |
240 | return
241 | }))
242 |
243 | await Promise.all(cache_clears)
244 |
245 | // clear cache of existing IDX
246 | await this.cache.delete(`${this.get_kv_prefix()}:${existingID}`)
247 |
248 | return object
249 | }
250 |
251 |
252 | async delete(objectID) {
253 | await this.get_spec()
254 |
255 | const key = `${this.get_kv_prefix()}:${objectID}`
256 |
257 | increase_cost('write')
258 | await env.CONTENTKV.delete(key)
259 |
260 | await Promise.all(this.spec.map(async field => {
261 | if (field.index) {
262 | increase_cost('write')
263 |
264 |
265 | const data = await this.delete_index(
266 | // prefix should be userID:tablename:field
267 | `${this.get_kv_prefix()}:${field.name}`,
268 | objectID
269 | )
270 |
271 | await this.cache.delete(`${this.get_kv_prefix()}:${field.name}:index`)
272 |
273 | return data
274 | } else {
275 | return Promise.resolve(null)
276 | }
277 | }))
278 |
279 | await this.cache.delete(`${this.get_kv_prefix()}:${objectID}`)
280 |
281 | return true
282 | }
283 |
284 | async list(index, search, opt) {
285 | const options = Object.assign(
286 | { mode: 'eq', limit: 30, order: 'oldest_first', read_level: 'preview', resolve: true },
287 | opt || {}
288 | )
289 |
290 | const key = `${this.get_kv_prefix()}:${index}:index`
291 |
292 | // get the index from the cache or from the KV store if it's not in the cache yet
293 | const idx = await this.cache.read(key, async () => {
294 | increase_cost('read')
295 | return await env.INDEXKV.get(key, { type: 'json' })
296 | })
297 |
298 | if ((!idx || !idx.length)) {
299 | return []
300 | }
301 |
302 | let is_match
303 | let is_valid_object
304 |
305 | if (options.mode == 'eq' && typeof search == 'string') {
306 | is_match = wcmatch(search.toLowerCase())
307 |
308 | is_valid_object = (obj) => {
309 | if (typeof obj[0] == 'string') {
310 | return is_match(obj[0].toLowerCase())
311 | }
312 |
313 | if (Array.isArray(obj[0])) {
314 | return obj[0].map(x => is_match(x.toLowerCase())).includes(true)
315 | }
316 |
317 | return obj[0] == search
318 | }
319 |
320 | } else if (options.mode == 'inc') {
321 | // replaces all \, with a block of characters, splits on ,, then removes the block and converts to a wildcard supported search
322 | // to ensure an object is valid, we need to check if all tags in the search string are in the object
323 | is_match = search.replace('\\,','11 | Use preset {{selected_preset.name}}? 12 |
13 |14 | Be aware, if you have any models that use the names below, they will be wiped and replaced with the preset. 15 | This preset will create the following on your account: 16 |
17 | 18 |
19 |
30 |
31 |
20 |
21 | Model: {{model.id}}
22 |
23 |
29 | -
24 |
- 25 | {{field.index ? '🔍' : ''}} {{field.name}}: {{field.type}} 26 | 27 |
32 |
34 |
35 |
36 | Activate preset
37 |
38 |
39 | Activate, but remove all existing models
40 |
41 | {{line.message}}
33 |45 | Import from JSON 46 |
47 |48 | This will load the JSON you paste below and auto create the models for you. Please validate the JSON is what you are expecting below before clicking the import button. 49 |
50 | 51 |56 | Whoa there! This JSON is not valid. Please check the JSON is valid before importing. 57 |
58 | 59 |60 | The above JSON will import: 61 |
62 | 63 |
64 |
75 |
76 |
65 |
66 | Model: {{model.id}}
67 |
68 |
74 | -
69 |
- 70 | {{field.index ? '🔍' : ''}} {{field.name}}: {{field.type}} 71 | 72 |
77 |
79 |
80 |
81 | Import JSON
82 |
83 |
84 | Import JSON, but remove all existing data
85 |
86 | {{line.message}}
78 |
89 |
96 |
97 | 90 | Presets 91 |
92 | 93 | Import from JSON 94 | 95 |98 | Get started quickly by clicking one of the presets below! You can also import your own preset by clicking the "Import from JSON" button above. Activating one of the presets will create models on your account. 99 |
100 | 101 |
102 |
112 |
103 |
110 |
111 |
3 |
184 |
185 |
186 |
251 |
252 |
--------------------------------------------------------------------------------
4 |
11 |
12 |
13 | Your data,
15 |
16 | The database thats only 150ms from your users, worldwide.
18 |
19 |
20 |
13 | Your data,
unbound
14 |
15 |
16 | The database thats only 150ms from your users, worldwide.
Built for the next generation of apps.
17 |
18 |
21 | 
26 |
27 |
28 |
26 |
29 |
36 |
37 | 30 | Scale your ability to innovate. 31 |
32 |33 | With Horseman, you can build apps that scale to millions of users, with a database that can handle it. Taking advantage of a global network of data centers, you can build apps and services that are fast, reliable, and secure. All from a single dashboard and API. 34 |
35 |
38 |
63 |
64 |
39 |
46 | 40 | 99.999% uptime 41 |
42 |43 | With no single point of failure, you can be sure that your data will be available to your users. 44 |
45 |
47 |
54 | 48 | Low latency 49 |
50 |51 | Using our API, your data is only 150ms average from your users, no matter where they are in the world. 52 |
53 |
55 |
62 | 56 | 100% REST 57 |
58 |59 | Our API has been designed to be simple and intuitive, so you can focus on building your app. 60 |
61 |
65 |
66 | One of the best databases I've ever used. Having a dashboard with this depth feels like cheating.
70 |
71 |
72 |
66 | One of the best databases I've ever used. Having a dashboard with this depth feels like cheating.
I can't recommend it enough.
67 |
68 | ~ Tori, Software Engineer
69 |
70 |
73 |
80 |
81 | 74 | Built for developers, by developers. 75 |
76 |77 | With our REST API, you can create modern apps without needing to worry about the underlying infrastructure. No more managing clusters, scaling up, or dealing with downtime. With Horseman, you can focus on building your app, and let us handle the rest. 78 |
79 |
82 |
123 |
124 |
83 |
90 | 84 | CREATE 85 |
86 |87 | POST /v1/models/table/objects?key=abc123 88 |
89 |
91 |
98 | 92 | LIST 93 |
94 |95 | GET /v1/models/table/objects?key=abc123 96 |
97 |
99 |
106 | 100 | GET 101 |
102 |103 | GET /v1/models/table/objects/objectID?key=abc123 104 |
105 |
107 |
114 | 108 | EDIT 109 |
110 |111 | POST /v1/models/table/objects/objectID?key=abc123 112 |
113 |
115 |
122 | 116 | DELETE 117 |
118 |119 | DELETE /v1/models/table/objects/objectID?key=abc123 120 |
121 |
125 |
171 |
172 |
126 |
170 |
127 |
140 |
141 | 128 | 🚀 SQL Support 129 |
130 | 131 |132 | SQL is just one way for you to access your data via Horseman. We have built in REST APIs, as well as a powerful SQL API. All over HTTP, allowing you to access your data in a way that is familiar to you. 133 |
134 | 135 |136 | Hit Enter to see what results you'll get! You can query the "posts", "authors", and "news" tables. 137 | We only support Horseman style wildcard searches inside the string, not LIKE queries. You can use the wildcard character '*' to search for anything. We also only support SELECT queries as of right now. 138 |
139 |
142 |
149 |
150 |
155 |
156 |
168 |
169 | 151 | Query execution time: {{query_latency.toFixed(0)}}ms 152 |
153 | 154 || {{heading}} | 158 |
|---|
| 163 | {{JSON.stringify(obj[heading]).substring(0, 60)}} 164 | | 165 |
173 |
174 | Get access to Horseman for free today by signing up now.
175 |
181 |
182 |
183 |