@open-xchange/vite-plugin-ox-manifests 0.2.1 → 0.2.2

package/index.js

@@ -6,6 +6,7 @@ import servePlugin from './src/plugins/serve.js'
 import serverManifestPlugin from './src/plugins/server-manifests.js'
 import gettextPlugin from './src/plugins/gettext.js'
 import { deepMergeObject } from './src/util.js'
+import additionalManifestsPlugin from './src/plugins/additional-manifests.js'
 
 /**
  * Creates a vite-plugin to include manifests in dev and production mode
@@ -13,6 +14,7 @@ import { deepMergeObject } from './src/util.js'
  * @param {object} [options]
  * @param {boolean} [options.watch=false] - If set to true, this plugin will watch manifest changes and reload the ui
  * @param {string} [options.appsuiteUrl] - When used in dev-mode, the dev-server can merge the local manifests with the manifest-files from the appsuiteUrl server.
+ * @param {Array} [options.additionalManifestUrls] - You can add additional urls which can point to manifest files during development. This parameter will be ignored in production
  * @param {string} [options.entryPoints] - Convenience method to specify additional entry points for the production build. Can be specified as a glob-pattern.
  * @param {boolean} [options.manifestsAsEntryPoints=true] - Specifies, that every path in a manifest is used as an entry-point for the production build.
  * @param {boolean} [options.transformAbsolutePaths=true] - If this is set to true, every path in the html-files is transformed to a relative path. Additionally, every preloaded file will also be loaded relative to the index.html
@@ -22,6 +24,7 @@ import { deepMergeObject } from './src/util.js'
 export default function ({
   watch = false,
   appsuiteUrl,
+  additionalManifestUrls,
   entryPoints,
   manifestsAsEntryPoints = true,
   transformAbsolutePaths = true,
@@ -31,6 +34,7 @@ export default function ({
   const options = {
     watch,
     appsuiteUrl,
+    additionalManifestUrls,
     entryPoints,
     manifestsAsEntryPoints,
     transformAbsolutePaths,
@@ -44,6 +48,7 @@ export default function ({
     relativePathsPlugin(options),
     servePlugin(options),
     serverManifestPlugin(options),
+    additionalManifestsPlugin(options),
     gettextPlugin(options),
     // manifest plugin last
     manifestsPlugin(options)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-xchange/vite-plugin-ox-manifests",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "A vite plugin to concat and serve ox manifests",
   "main": "index.js",
   "type": "module",

package/src/plugins/additional-manifests.js

@@ -0,0 +1,18 @@
+import axios from 'axios'
+
+export default function ({ additionalManifestUrls = [] } = {}) {
+  return {
+    async getManifests () {
+      const manifestSets = await Promise.all(additionalManifestUrls.map(async url => {
+        try {
+          const res = await axios.get(url)
+          return res.data
+        } catch (e) {
+          console.error(`Could not fetch manifest ${url}`, e)
+          return []
+        }
+      }))
+      return manifestSets.flat(1)
+    }
+  }
+}

package/test/upstream-manifests/main.test.js

@@ -0,0 +1,64 @@
+import { describe, it, expect, afterEach } from '@jest/globals'
+import { createServer } from 'vite'
+import path from 'path'
+import vitePluginOxManifests from '../../index'
+import { getPort } from '../util'
+import axios from 'axios'
+import express from 'express'
+
+const __dirname = path.dirname(new URL(import.meta.url).pathname)
+const PORT = getPort()
+const MANIFEST_PORT = getPort()
+const OTHER_PORT = getPort()
+
+describe('Additional upstream manifests', function () {
+  let server, manifestServer, otherServer
+
+  afterEach(async function () {
+    if (server) {
+      await server.close()
+      server = null
+    }
+    if (manifestServer) {
+      await manifestServer.close()
+      manifestServer = null
+    }
+    if (otherServer) {
+      await otherServer.close()
+      otherServer = null
+    }
+  })
+
+  it('works in dev mode', async function () {
+    server = await createServer({
+      root: __dirname,
+      logLevel: 'silent',
+      plugins: [vitePluginOxManifests({
+        appsuiteUrl: `http://localhost:${MANIFEST_PORT}`,
+        additionalManifestUrls: [`http://localhost:${OTHER_PORT}/path/to/file.json`]
+      })]
+    })
+    await server.listen(PORT)
+
+    // create a manifest server
+    const app = express()
+    manifestServer = app.listen(MANIFEST_PORT)
+    app.get('/api/manifest.json', (req, res) => {
+      res.json([{ namespace: 'server' }])
+    })
+
+    // create other server with random endpoint
+    const app2 = express()
+    otherServer = app2.listen(OTHER_PORT)
+    app2.get('/path/to/file.json', (req, res) => {
+      res.json([{ namespace: 'other' }])
+    })
+
+    const res = await axios({ baseURL: `http://localhost:${PORT}/api/manifest.json` })
+    const manifests = res.data
+    expect(Object.keys(manifests)).toHaveLength(3)
+    expect(manifests.map(m => m.namespace)).toContain('test')
+    expect(manifests.map(m => m.namespace)).toContain('server')
+    expect(manifests.map(m => m.namespace)).toContain('other')
+  })
+})

package/test/upstream-manifests/manifest.json

@@ -0,0 +1,3 @@
+{
+  "namespace": "test"
+}

package/test/upstream-manifests/register.js

@@ -0,0 +1 @@
+console.log('Hello world')