@dargmuesli/nuxt-vio 22.0.6 → 23.0.0-beta.2

package/app/composables/networking.ts

@@ -4,23 +4,22 @@ export const useGetServiceHref = () => {
   const isTesting = useIsTesting()
 
   return ({
-    isSsr = true,
+    allowInternal = true,
     name,
     path,
-    port,
   }: {
-    isSsr?: boolean
-    name: string
+    allowInternal?: boolean
+    name: ServiceName
     path?: string
-    port?: number
   }) =>
     getServiceHref({
+      allowInternal,
       host,
-      isSsr,
+      isServer: import.meta.server,
       isTesting,
       name,
       path,
-      port,
+      services: runtimeConfig.public.vio.services,
       stagingHost: runtimeConfig.public.vio.stagingHost,
     })
 }

package/app/composables/strapi.ts

@@ -5,5 +5,4 @@ export const useStrapiFetch = (
     ...(options ? options : {}),
     name: options?.name || 'strapi',
     path: options?.path || '/api',
-    port: options?.port || 1337,
   })

package/node/networking.ts

@@ -0,0 +1,89 @@
+import type { H3Event } from 'h3'
+
+import { SERVICES } from './services'
+import type { Service, ServiceName } from './services'
+import { SITE_URL_TYPED } from './static'
+
+export const getHost = (event: H3Event) => {
+  const host = event.node.req.headers.host
+
+  if (!host) throw new Error('Host header is not given!')
+
+  return host
+}
+
+export const getRootHost = (host: string) => {
+  const hostParts = host.split('.')
+  const hostPartsLast = hostParts[hostParts.length - 1]
+
+  if (hostParts.length === 1) return hostParts[0]
+
+  // only a single subdomain directly on bare localhost collapses to the root; e.g. app.localhost must keep its "app" label
+  if (
+    hostParts.length === 2 &&
+    hostPartsLast &&
+    /^localhost(:[0-9]+)?$/.test(hostPartsLast)
+  )
+    return hostPartsLast
+
+  return `${hostParts[hostParts.length - 2]}.${hostPartsLast}`
+}
+
+export const getServiceHref = ({
+  allowInternal = true,
+  host,
+  isServer,
+  isTesting,
+  name,
+  path,
+  protocol = SITE_URL_TYPED.protocol,
+  services = SERVICES,
+  stagingHost,
+}: {
+  allowInternal?: boolean
+  host?: string
+  isServer: boolean
+  isTesting?: boolean
+  name: ServiceName
+  path?: string
+  protocol?: string
+  services?: Record<string, Service>
+  stagingHost?: string
+}) => {
+  const service = services[name]
+
+  if (!service) throw new Error(`Service "${name}" is not registered!`)
+
+  const { hasSubdomain, port } = service
+  const nameSubdomainString = `${name.replaceAll('_', '-')}.`
+  const pathString = path ? `/${path.replace(/^\/+/, '')}` : ''
+
+  const assertHasSubdomain = () => {
+    if (!hasSubdomain)
+      throw new Error(`Service "${name}" has no public subdomain!`)
+  }
+
+  if (isTesting) {
+    assertHasSubdomain()
+
+    return `${protocol}//${nameSubdomainString}${SITE_URL_TYPED.host}${pathString}`
+  }
+
+  if (stagingHost) {
+    assertHasSubdomain()
+
+    return `${protocol}//${nameSubdomainString}${stagingHost}${pathString}`
+  }
+
+  if (isServer && allowInternal) {
+    return `http://${name}:${port}${pathString}`
+  }
+
+  if (host) {
+    assertHasSubdomain()
+
+    return `${protocol}//${nameSubdomainString}${getRootHost(host)}${pathString}`
+  }
+
+  throw new Error('Could not get service href!')
+}

package/node/services.ts

@@ -0,0 +1,11 @@
+export type Service = {
+  hasSubdomain: boolean
+  port: number
+}
+
+export const SERVICES = {
+  strapi: { hasSubdomain: true, port: 1337 },
+} as const satisfies Record<string, Service>
+
+// The open string branch accepts services registered by extending projects through VIO_NUXT_BASE_CONFIG's `services` option, while still keeping autocomplete for the built-in names.
+export type ServiceName = keyof typeof SERVICES | (string & {})

package/node/static/nuxt.ts

@@ -1,11 +1,15 @@
 import type { defineNuxtConfig } from 'nuxt/config'
 
+import type { Service } from '../services'
+import { SERVICES } from '../services'
 import { IS_IN_FRONTEND_DEVELOPMENT } from './'
 
 export const VIO_NUXT_BASE_CONFIG = ({
+  services,
   siteName,
   stagingHost,
 }: {
+  services?: Record<string, Service>
   siteName: string
   stagingHost?: string
 }) =>
@@ -18,6 +22,7 @@ export const VIO_NUXT_BASE_CONFIG = ({
     runtimeConfig: {
       public: {
         vio: {
+          services: { ...SERVICES, ...services },
           stagingHost: IS_IN_FRONTEND_DEVELOPMENT ? stagingHost : undefined,
         },
       },

package/package.json

@@ -101,7 +101,7 @@
     "url": "git+https://github.com/dargmuesli/vio.git"
   },
   "type": "module",
-  "version": "22.0.6",
+  "version": "23.0.0-beta.2",
   "scripts": {
     "build": "pnpm run build:node",
     "build:node": "NUXT_PUBLIC_I18N_BASE_URL=https://app.localhost:3001 nuxt build playground",

package/server/utils/networking.ts

@@ -6,23 +6,22 @@ export const useGetServiceHref = ({ event }: { event?: H3Event } = {}) => {
   const isTesting = useIsTesting()
 
   return ({
-    isSsr = true,
+    allowInternal = true,
     name,
     path,
-    port,
   }: {
-    isSsr?: boolean
-    name: string
+    allowInternal?: boolean
+    name: ServiceName
     path?: string
-    port?: number
   }) =>
     getServiceHref({
+      allowInternal,
       host,
-      isSsr,
+      isServer: import.meta.server,
       isTesting,
       name,
       path,
-      port,
+      services: runtimeConfig.public.vio.services,
       stagingHost: runtimeConfig.public.vio.stagingHost,
     })
 }

package/shared/utils/networking.ts

@@ -1,11 +1,11 @@
 import type { CombinedError } from '@urql/core'
-import type { H3Event } from 'h3'
 import { computed, reactive } from 'vue'
 import type { Ref } from 'vue'
 
-import { SITE_URL_TYPED } from '../../node/static'
 import type { ApiData, BackendError } from '../types/api'
 
+export { getHost, getRootHost, getServiceHref } from '../../node/networking'
+
 export const getApiDataDefault = (): ApiData =>
   computed(() =>
     reactive({
@@ -64,70 +64,3 @@ export const getCombinedErrorMessages = (
 
   return errorMessages
 }
-
-export const getRootHost = (host: string) => {
-  const hostParts = host.split('.')
-  const hostPartsLast = hostParts[hostParts.length - 1]
-
-  if (hostParts.length === 1) return hostParts[0]
-
-  // only a single subdomain directly on bare localhost collapses to the root; e.g. app.localhost must keep its "app" label
-  if (
-    hostParts.length === 2 &&
-    hostPartsLast &&
-    /^localhost(:[0-9]+)?$/.test(hostPartsLast)
-  )
-    return hostPartsLast
-
-  return `${hostParts[hostParts.length - 2]}.${hostPartsLast}`
-}
-
-export const getHost = (event: H3Event) => {
-  const host = event.node.req.headers.host
-
-  if (!host) throw new Error('Host header is not given!')
-
-  return host
-}
-
-export const getServiceHref = ({
-  host,
-  isSsr = true,
-  isTesting,
-  name,
-  path,
-  port,
-  stagingHost,
-}: {
-  host?: string
-  isSsr?: boolean
-  isTesting?: boolean
-  name: string
-  path?: string
-  port?: number
-  stagingHost?: string
-}) => {
-  const nameSubdomain =
-    name !== VIO_SITE_NAME ? name?.replaceAll('_', '-') : undefined
-  const nameSubdomainString = nameSubdomain ? `${nameSubdomain}.` : ''
-  const portString = port ? `:${port}` : ''
-  const pathString = path ? `/${path.replace(/^\/+/, '')}` : ''
-
-  if (isTesting) {
-    return `${SITE_URL_TYPED.protocol}//${nameSubdomainString}${SITE_URL_TYPED.host}${pathString}`
-  }
-
-  if (stagingHost) {
-    return `https://${nameSubdomainString}${stagingHost}${pathString}`
-  }
-
-  if (import.meta.server && isSsr) {
-    return `http://${name}${portString}${pathString}`
-  }
-
-  if (host) {
-    return `https://${nameSubdomainString}${getRootHost(host)}${pathString}`
-  }
-
-  throw new Error('Could not get service href!')
-}

package/shared/utils/services.ts

@@ -0,0 +1,2 @@
+export { SERVICES } from '../../node/services'
+export type { Service, ServiceName } from '../../node/services'