v1 Setup

.github/workflows/tests.yaml

@@ -0,0 +1,27 @@
+name: Tests 
+
+on:
+  push:
+    branches: [ main, v1 ]
+  pull_request:
+    branches: [ main, v1 ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: v1
+
+    strategy:
+      matrix:
+        node-version: [18.x]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm ci
+      - run: npm test

.gitignore

@@ -36,6 +36,7 @@ bower_components
 
 # Compiled binary addons (https://nodejs.org/api/addons.html)
 build/Release
+v1/build/
 
 # Dependency directories
 node_modules/
@@ -104,4 +105,5 @@ dist
 .tern-port
 
 # Distributed Press data files
-.data/
+.data/
+v1/store

v1/api/admin.ts

@@ -0,0 +1,35 @@
+import { Static } from '@sinclair/typebox'
+import { FastifyInstance } from 'fastify'
+import { StoreI } from '../config/index.js'
+import { NewAdmin } from './schemas.js'
+
+export const adminRoutes = (store: StoreI) => async (server: FastifyInstance): Promise<void> => {
+  server.post<{
+    Body: Static<typeof NewAdmin>
+    Reply: string
+  }>('/admin', {
+    schema: {
+      body: NewAdmin,
+      description: 'Add a new admin.',
+      tags: ['admin']
+    }
+  }, async (request, reply) => {
+    const id = await store.admin.create(request.body)
+    return reply.send(id)
+  })
+
+  server.delete<{
+    Params: {
+      id: string
+    }
+  }>('/admin/:id', {
+    schema: {
+      description: 'Delete an admin',
+      tags: ['admin']
+    }
+  }, async (request, reply) => {
+    const { id } = request.params
+    await store.admin.delete(id)
+    return reply.status(200)
+  })
+}

v1/api/index.test.ts

@@ -0,0 +1,11 @@
+import test from 'ava'
+import apiBuilder from './index.js'
+
+test('health check /healthz', async t => {
+  const server = await apiBuilder({})
+  const response = await server.inject({
+    method: 'GET',
+    url: '/healthz'
+  })
+  t.is(response.statusCode, 200, 'returns a status code of 200')
+})

v1/api/index.ts

@@ -0,0 +1,76 @@
+import { TypeBoxTypeProvider } from '@fastify/type-provider-typebox'
+import fastify, { FastifyBaseLogger, FastifyInstance, RawReplyDefaultExpression, RawRequestDefaultExpression, RawServerDefault } from 'fastify'
+import multipart from '@fastify/multipart'
+import swagger from '@fastify/swagger'
+import swagger_ui from '@fastify/swagger-ui'
+import metrics from 'fastify-metrics'
+import { siteRoutes } from './sites.js'
+import { adminRoutes } from './admin.js'
+import { publisherRoutes } from './publisher.js'
+import Store, { StoreI } from '../config/index.js'
+
+export type FastifyTypebox = FastifyInstance<
+RawServerDefault,
+RawRequestDefaultExpression<RawServerDefault>,
+RawReplyDefaultExpression<RawServerDefault>,
+FastifyBaseLogger,
+TypeBoxTypeProvider
+>
+
+interface APIConfig {
+  useLogging: boolean
+  useSwagger: boolean
+  usePrometheus: boolean
+}
+
+async function apiBuilder (cfg: Partial<APIConfig>, store: StoreI = new Store()): Promise<FastifyTypebox> {
+  const server = fastify({ logger: cfg.useLogging }).withTypeProvider<TypeBoxTypeProvider>()
+  await server.register(multipart)
+
+  server.get('/healthz', () => {
+    return 'ok\n'
+  })
+
+  await server.register(v1Routes(cfg, store), { prefix: '/v1' })
+  await server.ready()
+  return server
+}
+
+const v1Routes = (cfg: Partial<APIConfig>, store: StoreI) => async (server: FastifyTypebox): Promise<void> => {
+  if (cfg.usePrometheus ?? false) {
+    server.register(metrics, { endpoint: '/metrics' });
+  }
+
+  if (cfg.useSwagger ?? false) {
+    await server.register(swagger, {
+      swagger: {
+        info: {
+          title: 'Distributed Press API',
+          description: 'Documentation on how to use the Distributed Press API to publish your website content and the Distributed Press API for your project',
+          version: '1.0.0'
+        },
+        tags: [
+          { name: 'site', description: 'Managing site deployments' },
+          { name: 'publisher', description: 'Publisher account management. Publishers can manage site deployments' },
+          { name: 'admin', description: 'Admin management. Admins can create, modify, and delete publishers' }
+        ]
+      }
+    })
+
+    await server.register(swagger_ui, {
+      routePrefix: '/docs'
+    })
+  }
+
+  // Register Routes
+  await server.register(siteRoutes(store))
+  await server.register(publisherRoutes(store))
+  await server.register(adminRoutes(store))
+
+  if (cfg.useSwagger ?? false) {
+    server.swagger()
+    server.log.info('Registered Swagger endpoints')
+  }
+}
+
+export default apiBuilder

v1/api/publisher.ts

@@ -0,0 +1,57 @@
+import { Type, Static } from '@sinclair/typebox'
+import { FastifyInstance } from 'fastify'
+import { StoreI } from '../config/index.js'
+import { NewPublisher, Publisher } from './schemas.js'
+
+export const publisherRoutes = (store: StoreI) => async (server: FastifyInstance): Promise<void> => {
+  server.post<{
+    Body: Static<typeof NewPublisher>
+    Reply: Static<typeof Publisher>
+  }>('/publisher', {
+    schema: {
+      body: Publisher,
+      response: {
+        200: Publisher
+      },
+      description: 'Add a new publisher.',
+      tags: ['publisher']
+    }
+  }, async (request, _reply) => {
+    return store.publisher.create(request.body)
+  })
+
+  server.get<{
+    Params: {
+      id: string
+    }
+    Reply: Static<typeof Publisher>
+  }>('/publisher/:id', {
+    schema: {
+      params: {
+        id: Type.String()
+      },
+      response: {
+        200: Publisher
+      },
+      description: 'Gets information about a specific publisher',
+      tags: ['publisher']
+    }
+  }, async (request, _reply) => {
+    const { id } = request.params
+    return store.publisher.get(id)
+  })
+
+  server.delete<{
+    Params: {
+      id: string
+    }
+  }>('/publisher/:id', {
+    schema: {
+      description: 'Delete a publisher',
+      tags: ['publisher']
+    }
+  }, async (request, _reply) => {
+    const { id } = request.params
+    return store.publisher.delete(id)
+  })
+}

v1/api/schemas.ts

@@ -0,0 +1,51 @@
+import { Type } from '@sinclair/typebox'
+
+export const DNS = Type.Object({
+  server: Type.String(),
+  domains: Type.Array(Type.String())
+})
+
+export const Links = Type.Partial(Type.Object({
+  http: Type.String(),
+  hyper: Type.String(),
+  hyperGateway: Type.String(),
+  hyperRaw: Type.String(),
+  ipns: Type.String(),
+  ipnsRaw: Type.String(),
+  ipnsGateway: Type.String(),
+  ipfs: Type.String(),
+  ipfsGateway: Type.String()
+}))
+
+export const Publication = Type.Object({
+  enabled: Type.Boolean(),
+  pinningURL: Type.Optional(Type.String())
+})
+
+export const Site = Type.Object({
+  id: Type.String(),
+  domain: Type.String(),
+  dns: DNS,
+  links: Links,
+  publication: Type.Object({
+    http: Type.Partial(Publication),
+    hyper: Type.Partial(Publication),
+    ipfs: Type.Partial(Publication)
+  })
+})
+export const NewSite = Type.Omit(Site, ['publication', 'id'])
+export const UpdateSite = Type.Partial(Type.Omit(Site, ['id']))
+
+export const Publisher = Type.Object({
+  id: Type.String(),
+  name: Type.String()
+  // TODO: what other fields do we need here?
+})
+export const NewPublisher = Type.Omit(Publisher, ['id'])
+
+export const Admin = Type.Object({
+  id: Type.String(),
+  name: Type.String()
+  // TODO: what other fields do we need here?
+})
+export const NewAdmin = Type.Omit(Admin, ['id'])