actor endpoints setting

README.md

@@ -244,6 +244,7 @@ collectionParam | String. Express route parameter used for collection id (defaul
 pageParam | String. Query parameter used for collection page identifier (defaults to `page`)
 itemsPerPage | Number. Count of items in each collection page (default `20`)
 context | String, Array. JSON-LD context for your app. Defaults to AcivityStreams + Security vocabs
+endpoints | Object. Optional system-wide api endpoint URLs included in [actor objects](https://www.w3.org/TR/activitypub/#actor-objects): `proxyUrl`, `oauthAuthorizationEndpoint`, `oauthTokenEndpoint`, `provideClientKey`, `signClientKey`, `sharedInbox`, `uploadMedia`
 store | Replace the default storage model & database backend with your own (see `store/interface.js` for API)
 threadDepth | Controls how far up apex will follow links in incoming activities in order to display the conversation thread & check for inbox forwarding needs  (default 10)
 systemUser | Actor object representing system and used for signing GETs (see below)

pub/actor.js

@@ -42,6 +42,12 @@ async function createActor (username, displayName, summary, icon, type = 'Person
   if (icon) {
     actor.icon = icon
   }
+  if (this.settings.endpoints) {
+    actor.endpoints = {
+      id: `${id}#endpoints`,
+      ...this.settings.endpoints
+    }
+  }
   actor = await this.fromJSONLD(actor)
   actor._meta = { privateKey: pair.privateKey }
   return actor

spec/helpers/test-utils.js

@@ -29,7 +29,11 @@ global.initApex = async function initApex () {
     actorParam: 'actor',
     objectParam: 'id',
     activityParam: 'id',
-    routes
+    routes,
+    endpoints: {
+      uploadMedia: 'https://localhost/upload',
+      oauthAuthorizationEndpoint: 'https://localhost/auth/authorize'
+    }
   })
 
   app.use(express.json({ type: apex.consts.jsonldTypes }), apex)

spec/unit/actor.spec.js

@@ -0,0 +1,35 @@
+/* global describe, beforeAll, beforeEach, it, expect */
+
+describe('actor utils', function () {
+  let testUser
+  let app
+  let apex
+  let client
+  beforeAll(async function () {
+    const init = await global.initApex()
+    testUser = init.testUser
+    app = init.app
+    apex = init.apex
+    client = init.client
+    app.route('/outbox/:actor')
+      .get(apex.net.outbox.get)
+      .post(apex.net.outbox.post)
+  })
+  beforeEach(function () {
+    return global.resetDb(apex, client, testUser)
+  })
+  describe('createActor', function () {
+    it('includes endpoints', async function () {
+      expect(testUser.endpoints).toEqual([{
+        id: 'https://localhost/u/test#endpoints',
+        uploadMedia: ['https://localhost/upload'],
+        oauthAuthorizationEndpoint: ['https://localhost/auth/authorize']
+      }])
+      expect((await apex.toJSONLD(testUser)).endpoints).toEqual({
+        id: 'https://localhost/u/test#endpoints',
+        uploadMedia: 'https://localhost/upload',
+        oauthAuthorizationEndpoint: 'https://localhost/auth/authorize'
+      })
+    })
+  })
+})