@sigmaott/base-next 1.4.0 → 1.4.2

package/src/modules/api-party/runtime/server/$api.ts

@@ -1,29 +1,29 @@
-import { headersToObject, resolvePath } from '../utils'
-import type { ModuleOptions } from '../../module'
-import type { ApiFetchOptions } from '../composables/$api'
-import { useRuntimeConfig } from '#imports'
-
-export function _$api<T = any>(
-  endpointId: string,
-  path: string,
-  opts: ApiFetchOptions = {},
-): Promise<T> {
-  const { pathParams, query, headers, ...fetchOptions } = opts
-  const { apiParty } = useRuntimeConfig()
-  const endpoints = (apiParty as unknown as ModuleOptions).endpoints || {}
-  const endpoint = endpoints[endpointId]
-
-  return globalThis.$fetch<T>(resolvePath(path, pathParams), {
-    ...fetchOptions,
-    baseURL: endpoint.url,
-    query: {
-      ...endpoint.query,
-      ...query,
-    },
-    headers: {
-      ...(endpoint.token && { Authorization: `Bearer ${endpoint.token}` }),
-      ...endpoint.headers,
-      ...headersToObject(headers),
-    },
-  }) as Promise<T>
-}
+import { headersToObject, resolvePath } from '../utils'
+import type { ModuleOptions } from '../../module'
+import type { ApiFetchOptions } from '../composables/$api'
+import { useRuntimeConfig } from '#imports'
+
+export function _$api<T = any>(
+  endpointId: string,
+  path: string,
+  opts: ApiFetchOptions = {},
+): Promise<T> {
+  const { pathParams, query, headers, ...fetchOptions } = opts
+  const { apiParty } = useRuntimeConfig()
+  const endpoints = (apiParty as unknown as ModuleOptions).endpoints || {}
+  const endpoint = endpoints[endpointId]
+
+  return globalThis.$fetch<T>(resolvePath(path, pathParams), {
+    ...fetchOptions,
+    baseURL: endpoint.url,
+    query: {
+      ...endpoint.query,
+      ...query,
+    },
+    headers: {
+      ...(endpoint.token && { Authorization: `Bearer ${endpoint.token}` }),
+      ...endpoint.headers,
+      ...headersToObject(headers),
+    },
+  }) as Promise<T>
+}

package/src/modules/api-party/runtime/server/handler.ts

@@ -1,92 +1,92 @@
-import { createError, defineEventHandler, getRequestHeader, getRouterParam, readBody, removeResponseHeader, send, setResponseHeaders, setResponseStatus } from 'h3'
-import { deserializeMaybeEncodedBody } from '../utils'
-import type { ModuleOptions } from '../../module'
-import type { EndpointFetchOptions } from '../types'
-import { useRuntimeConfig } from '#imports'
-
-export default defineEventHandler(async (event): Promise<any> => {
-  const endpointId = getRouterParam(event, 'endpointId')!
-  const { apiParty } = useRuntimeConfig()
-  const endpoints = (apiParty as unknown as ModuleOptions).endpoints || {}
-  const endpoint = endpoints[endpointId]
-
-  if (!endpoint) {
-    throw createError({
-      statusCode: 404,
-      statusMessage: `Unknown API endpoint "${endpointId}"`,
-    })
-  }
-
-  const _body = await readBody<EndpointFetchOptions>(event)
-
-  const {
-    path,
-    query,
-    headers,
-    body,
-    ...fetchOptions
-  } = _body
-
-  // Check if the path is an absolute URL
-  if (new URL(path, 'http://localhost').origin !== 'http://localhost') {
-    throw createError({
-      statusCode: 400,
-      statusMessage: 'Absolute URLs are not allowed',
-    })
-  }
-
-  // Allows to overwrite the backend url with a custom header
-  // (e.g. `jsonPlaceholder` endpoint becomes `Json-Placeholder-Endpoint-Url`)
-  const baseURL = new Headers(headers).get(`${endpointId}-endpoint-url`) || endpoint.url
-
-  // Check if the base URL is in the allow list
-  if (
-    baseURL !== endpoint.url
-    && !endpoint.allowedUrls?.includes(baseURL)
-  ) {
-    throw createError({
-      statusCode: 400,
-      statusMessage: `Base URL "${baseURL}" is not allowed`,
-    })
-  }
-
-  try {
-    const response = await globalThis.$fetch.raw<ArrayBuffer>(
-      path,
-      {
-        ...fetchOptions,
-        baseURL,
-        query: {
-          ...endpoint.query,
-          ...query,
-        },
-        headers: {
-          ...(endpoint.token && { Authorization: `Bearer ${endpoint.token}` }),
-          ...(endpoint.cookies && { cookie: getRequestHeader(event, 'cookie') }),
-          ...endpoint.headers,
-          ...headers,
-        },
-        ...(body && { body: await deserializeMaybeEncodedBody(body) }),
-        ignoreResponseError: true,
-        responseType: 'arrayBuffer',
-      },
-    )
-    setResponseStatus(event, response.status, response.statusText)
-    setResponseHeaders(event, Object.fromEntries(response.headers.entries()))
-
-    // ofetch has already decoded the response. Leaving this header can cause the
-    // client issues when decoding and may create a conflict if a compression
-    // middleware is used
-    removeResponseHeader(event, 'content-encoding')
-
-    await send(event, new Uint8Array(response._data ?? []))
-  }
-  catch (error) {
-    console.error(error)
-
-    throw createError({
-      statusCode: 503,
-      statusMessage: 'Service Unavailable',
-    })
-  }
-})
+import { createError, defineEventHandler, getRequestHeader, getRouterParam, readBody, removeResponseHeader, send, setResponseHeaders, setResponseStatus } from 'h3'
+import { deserializeMaybeEncodedBody } from '../utils'
+import type { ModuleOptions } from '../../module'
+import type { EndpointFetchOptions } from '../types'
+import { useRuntimeConfig } from '#imports'
+
+export default defineEventHandler(async (event): Promise<any> => {
+  const endpointId = getRouterParam(event, 'endpointId')!
+  const { apiParty } = useRuntimeConfig()
+  const endpoints = (apiParty as unknown as ModuleOptions).endpoints || {}
+  const endpoint = endpoints[endpointId]
+
+  if (!endpoint) {
+    throw createError({
+      statusCode: 404,
+      statusMessage: `Unknown API endpoint "${endpointId}"`,
+    })
+  }
+
+  const _body = await readBody<EndpointFetchOptions>(event)
+
+  const {
+    path,
+    query,
+    headers,
+    body,
+    ...fetchOptions
+  } = _body
+
+  // Check if the path is an absolute URL
+  if (new URL(path, 'http://localhost').origin !== 'http://localhost') {
+    throw createError({
+      statusCode: 400,
+      statusMessage: 'Absolute URLs are not allowed',
+    })
+  }
+
+  // Allows to overwrite the backend url with a custom header
+  // (e.g. `jsonPlaceholder` endpoint becomes `Json-Placeholder-Endpoint-Url`)
+  const baseURL = new Headers(headers).get(`${endpointId}-endpoint-url`) || endpoint.url
+
+  // Check if the base URL is in the allow list
+  if (
+    baseURL !== endpoint.url
+    && !endpoint.allowedUrls?.includes(baseURL)
+  ) {
+    throw createError({
+      statusCode: 400,
+      statusMessage: `Base URL "${baseURL}" is not allowed`,
+    })
+  }
+
+  try {
+    const response = await globalThis.$fetch.raw<ArrayBuffer>(
+      path,
+      {
+        ...fetchOptions,
+        baseURL,
+        query: {
+          ...endpoint.query,
+          ...query,
+        },
+        headers: {
+          ...(endpoint.token && { Authorization: `Bearer ${endpoint.token}` }),
+          ...(endpoint.cookies && { cookie: getRequestHeader(event, 'cookie') }),
+          ...endpoint.headers,
+          ...headers,
+        },
+        ...(body && { body: await deserializeMaybeEncodedBody(body) }),
+        ignoreResponseError: true,
+        responseType: 'arrayBuffer',
+      },
+    )
+    setResponseStatus(event, response.status, response.statusText)
+    setResponseHeaders(event, Object.fromEntries(response.headers.entries()))
+
+    // ofetch has already decoded the response. Leaving this header can cause the
+    // client issues when decoding and may create a conflict if a compression
+    // middleware is used
+    removeResponseHeader(event, 'content-encoding')
+
+    await send(event, new Uint8Array(response._data ?? []))
+  }
+  catch (error) {
+    console.error(error)
+
+    throw createError({
+      statusCode: 503,
+      statusMessage: 'Service Unavailable',
+    })
+  }
+})

package/src/modules/api-party/runtime/types.ts

@@ -1,97 +1,97 @@
-import type { NitroFetchOptions } from 'nitropack'
-import type { Ref } from 'vue'
-
-export type EndpointFetchOptions = NitroFetchOptions<string> & {
-  path: string
-}
-
-export type MaybeRef<T> = T | Ref<T>
-export type MaybeRefOrGetter<T> = MaybeRef<T> | (() => T)
-
-export type IgnoreCase<T extends string> = Lowercase<T> | Uppercase<T>
-export type RemovePrefix<T extends string, P extends string> = T extends `${P}${infer S}` ? S : never
-
-export type PathItemObject = { [M in HttpMethod]?: any } & { parameters?: any }
-
-// HTTP status codes and methods
-export type HttpMethod = 'get' | 'put' | 'post' | 'delete' | 'options' | 'head' | 'patch' | 'trace'
-export type OkStatus = 200 | 201 | 202 | 203 | 204 | 206 | 207 | '2XX' | 'default'
-export type ErrorStatus = 500 | '5XX' | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 420 | 421 | 422 | 423 | 424 | 425 | 426 | 429 | 431 | 444 | 450 | 451 | 497 | 498 | 499 | '4XX'
-
-// General purpose types
-export type RequestBody<T> = T extends { requestBody?: { content: infer Body } }
-  ?
-    | (Body extends { 'application/octet-stream': any }
-      ? {
-          body: string | Blob
-          headers: { 'content-type': 'application/octet-stream' }
-        }
-      : Record<string, any>)
-    | (Body extends { 'application/json': infer Schema }
-      ? { body: Schema; headers?: { 'content-type'?: 'application/json' } }
-      : Record<string, any>)
-    | (Body extends { '*/*': infer Schema }
-      ? { body: Schema; headers?: { 'content-type'?: 'application/json' } }
-      : Record<string, any>)
-    | (Body extends { 'application/x-www-form-urlencoded': any }
-      ? {
-          body: FormData
-          headers: { 'content-type': 'application/x-www-form-urlencoded' }
-        }
-      : Record<string, any>)
-  : unknown
-
-export type Method<M extends IgnoreCase<HttpMethod>> =
-  'get' extends Lowercase<M> ? { method?: M } : { method: M }
-
-export type Param<T, N extends string, K extends string = N> = T extends {
-  parameters: { [_ in N]?: any }
-}
-  ? { [_ in keyof Pick<T['parameters'], N> as K]: T['parameters'][N] }
-  : unknown
-
-export type PathParameters<T> = Param<T, 'path', 'pathParams'>
-export type QueryParameters<T> = Param<T, 'query'>
-export type HeaderParameters<T> = Param<T, 'header', 'headers'>
-
-export type OpenApiRequestOptions<
-  P extends PathItemObject,
-  M extends IgnoreCase<keyof P & HttpMethod> = IgnoreCase<keyof P & 'get'>,
-> = Omit<
-  NitroFetchOptions<any, Lowercase<M>>,
-  'params' | 'query' | 'headers' | 'method' | 'body' | 'cache'
-> & RequestBody<P[Lowercase<M>]> & PathParameters<P[Lowercase<M>]> & QueryParameters<P[Lowercase<M>]> & Method<M>
-
-type MediaTypes<T, Status extends keyof any> = {
-  [S in Status]: T extends {
-    responses: {
-      [_ in S]: {
-        content: {
-          'application/json': infer Model
-        }
-      };
-    }
-  }
-    ? Model
-    : never;
-}[Status]
-
-// Fetch types
-export type OpenApiResponse<T> = MediaTypes<T, OkStatus>
-export type OpenApiError<T> = MediaTypes<T, ErrorStatus>
-
-export type AllPaths<Paths> = RemovePrefix<keyof Paths & string, '/'>
-
-/** All endpoints that don't require a `method` property */
-export type GETPaths<Paths> = {
-  [P in keyof Paths]: Paths[P] extends { get: any } ? RemovePrefix<P & string, '/'> : never;
-}[keyof Paths]
-
-/** All endpoints that don't require additional options */
-export type GETPlainPaths<Paths> = {
-  [P in keyof Paths]: Paths[P] extends { get: infer O }
-    ? O extends { parameters: { query: any } | { header: any } | { path: any } }
-      ? never
-      : RemovePrefix<P & string, '/'>
-    : never;
-}[keyof Paths]
+import type { NitroFetchOptions } from 'nitropack'
+import type { Ref } from 'vue'
+
+export type EndpointFetchOptions = NitroFetchOptions<string> & {
+  path: string
+}
+
+export type MaybeRef<T> = T | Ref<T>
+export type MaybeRefOrGetter<T> = MaybeRef<T> | (() => T)
+
+export type IgnoreCase<T extends string> = Lowercase<T> | Uppercase<T>
+export type RemovePrefix<T extends string, P extends string> = T extends `${P}${infer S}` ? S : never
+
+export type PathItemObject = { [M in HttpMethod]?: any } & { parameters?: any }
+
+// HTTP status codes and methods
+export type HttpMethod = 'get' | 'put' | 'post' | 'delete' | 'options' | 'head' | 'patch' | 'trace'
+export type OkStatus = 200 | 201 | 202 | 203 | 204 | 206 | 207 | '2XX' | 'default'
+export type ErrorStatus = 500 | '5XX' | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 420 | 421 | 422 | 423 | 424 | 425 | 426 | 429 | 431 | 444 | 450 | 451 | 497 | 498 | 499 | '4XX'
+
+// General purpose types
+export type RequestBody<T> = T extends { requestBody?: { content: infer Body } }
+  ?
+    | (Body extends { 'application/octet-stream': any }
+      ? {
+          body: string | Blob
+          headers: { 'content-type': 'application/octet-stream' }
+        }
+      : Record<string, any>)
+    | (Body extends { 'application/json': infer Schema }
+      ? { body: Schema; headers?: { 'content-type'?: 'application/json' } }
+      : Record<string, any>)
+    | (Body extends { '*/*': infer Schema }
+      ? { body: Schema; headers?: { 'content-type'?: 'application/json' } }
+      : Record<string, any>)
+    | (Body extends { 'application/x-www-form-urlencoded': any }
+      ? {
+          body: FormData
+          headers: { 'content-type': 'application/x-www-form-urlencoded' }
+        }
+      : Record<string, any>)
+  : unknown
+
+export type Method<M extends IgnoreCase<HttpMethod>> =
+  'get' extends Lowercase<M> ? { method?: M } : { method: M }
+
+export type Param<T, N extends string, K extends string = N> = T extends {
+  parameters: { [_ in N]?: any }
+}
+  ? { [_ in keyof Pick<T['parameters'], N> as K]: T['parameters'][N] }
+  : unknown
+
+export type PathParameters<T> = Param<T, 'path', 'pathParams'>
+export type QueryParameters<T> = Param<T, 'query'>
+export type HeaderParameters<T> = Param<T, 'header', 'headers'>
+
+export type OpenApiRequestOptions<
+  P extends PathItemObject,
+  M extends IgnoreCase<keyof P & HttpMethod> = IgnoreCase<keyof P & 'get'>,
+> = Omit<
+  NitroFetchOptions<any, Lowercase<M>>,
+  'params' | 'query' | 'headers' | 'method' | 'body' | 'cache'
+> & RequestBody<P[Lowercase<M>]> & PathParameters<P[Lowercase<M>]> & QueryParameters<P[Lowercase<M>]> & Method<M>
+
+type MediaTypes<T, Status extends keyof any> = {
+  [S in Status]: T extends {
+    responses: {
+      [_ in S]: {
+        content: {
+          'application/json': infer Model
+        }
+      };
+    }
+  }
+    ? Model
+    : never;
+}[Status]
+
+// Fetch types
+export type OpenApiResponse<T> = MediaTypes<T, OkStatus>
+export type OpenApiError<T> = MediaTypes<T, ErrorStatus>
+
+export type AllPaths<Paths> = RemovePrefix<keyof Paths & string, '/'>
+
+/** All endpoints that don't require a `method` property */
+export type GETPaths<Paths> = {
+  [P in keyof Paths]: Paths[P] extends { get: any } ? RemovePrefix<P & string, '/'> : never;
+}[keyof Paths]
+
+/** All endpoints that don't require additional options */
+export type GETPlainPaths<Paths> = {
+  [P in keyof Paths]: Paths[P] extends { get: infer O }
+    ? O extends { parameters: { query: any } | { header: any } | { path: any } }
+      ? never
+      : RemovePrefix<P & string, '/'>
+    : never;
+}[keyof Paths]

package/src/modules/api-party/runtime/utils.ts

@@ -1,43 +1,43 @@
-import { unref } from 'vue'
-import { formDataToObject, isFormData, isSerializedFormData, objectToFormData } from './formData'
-import type { MaybeRefOrGetter } from './types'
-import type { ApiFetchOptions } from './composables/$api'
-
-export function toValue<T>(r: MaybeRefOrGetter<T>): T {
-  return typeof r === 'function'
-    ? (r as (...args: any[]) => any)()
-    : unref(r)
-}
-
-export function headersToObject(headers: HeadersInit = {}): Record<string, string> {
-  if (headers instanceof Headers || Array.isArray(headers))
-    return Object.fromEntries(headers)
-
-  return headers
-}
-
-export async function serializeMaybeEncodedBody(value: ApiFetchOptions['body']) {
-  if (isFormData(value))
-    return await formDataToObject(value)
-
-  return value
-}
-
-export async function deserializeMaybeEncodedBody(value: ApiFetchOptions['body']) {
-  if (isSerializedFormData(value))
-    return await objectToFormData(value)
-
-  return value
-}
-
-export function resolvePath(path: string, params?: Record<string, MaybeRefOrGetter<unknown>>) {
-  // To simplify typings, OpenAPI path parameters can be expanded here
-  if (params) {
-    return Object.entries(params).reduce(
-      (path, [name, value]) => path.replace(`{${name}}`, encodeURIComponent(String(toValue(value)))),
-      path,
-    )
-  }
-
-  return path
-}
+import { unref } from 'vue'
+import { formDataToObject, isFormData, isSerializedFormData, objectToFormData } from './formData'
+import type { MaybeRefOrGetter } from './types'
+import type { ApiFetchOptions } from './composables/$api'
+
+export function toValue<T>(r: MaybeRefOrGetter<T>): T {
+  return typeof r === 'function'
+    ? (r as (...args: any[]) => any)()
+    : unref(r)
+}
+
+export function headersToObject(headers: HeadersInit = {}): Record<string, string> {
+  if (headers instanceof Headers || Array.isArray(headers))
+    return Object.fromEntries(headers)
+
+  return headers
+}
+
+export async function serializeMaybeEncodedBody(value: ApiFetchOptions['body']) {
+  if (isFormData(value))
+    return await formDataToObject(value)
+
+  return value
+}
+
+export async function deserializeMaybeEncodedBody(value: ApiFetchOptions['body']) {
+  if (isSerializedFormData(value))
+    return await objectToFormData(value)
+
+  return value
+}
+
+export function resolvePath(path: string, params?: Record<string, MaybeRefOrGetter<unknown>>) {
+  // To simplify typings, OpenAPI path parameters can be expanded here
+  if (params) {
+    return Object.entries(params).reduce(
+      (path, [name, value]) => path.replace(`{${name}}`, encodeURIComponent(String(toValue(value)))),
+      path,
+    )
+  }
+
+  return path
+}

package/src/pages/403.vue

@@ -1,11 +1,11 @@
-<script setup lang="ts">
-definePageMeta({
-  title: '403',
-  layout: 'empty',
-  notAsMenu: true,
-})
-</script>
-
-<template>
-  <SSException403 />
-</template>
+<script setup lang="ts">
+definePageMeta({
+  title: '403',
+  layout: 'empty',
+  notAsMenu: true,
+})
+</script>
+
+<template>
+  <SSException403 />
+</template>

package/src/pages/500.vue

@@ -1,11 +1,11 @@
-<script setup lang="ts">
-definePageMeta({
-  title: '500',
-  layout: 'empty',
-  notAsMenu: true,
-})
-</script>
-
-<template>
-  <SSException500 />
-</template>
+<script setup lang="ts">
+definePageMeta({
+  title: '500',
+  layout: 'empty',
+  notAsMenu: true,
+})
+</script>
+
+<template>
+  <SSException500 />
+</template>

package/src/pages/[...all].vue

@@ -1,11 +1,11 @@
-<script setup lang="ts">
-definePageMeta({
-  title: '404',
-  layout: 'empty',
-  notAsMenu: true,
-})
-</script>
-
-<template>
-  <SSException404 />
-</template>
+<script setup lang="ts">
+definePageMeta({
+  title: '404',
+  layout: 'empty',
+  notAsMenu: true,
+})
+</script>
+
+<template>
+  <SSException404 />
+</template>