@xylabs/express 5.0.80 → 5.0.81

package/src/middleware/standardResponses/jsonApi/error.ts

@@ -1,52 +0,0 @@
-import type { ApiLinks } from './links.ts'
-
-/**
- * An object containing references to the source of the error
- */
-export interface Source {
-  /**
-   * A string indicating which URI query parameter caused the error.
-   */
-  parameter?: string
-  /**
-   * A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. "/data" for a primary data object,
-   * or "/data/attributes/title" for a specific attribute].
-   */
-  pointer?: string
-}
-
-export interface ApiError {
-  /**
-   *  An application-specific error code, expressed as a string value.
-   */
-  code?: string
-  /**
-   *  A human-readable explanation specific to this occurrence of the problem. Like title, this field's value can be localized.
-   */
-  detail?: string
-  /**
-   *  A unique identifier for this particular occurrence of the problem.
-   */
-  id?: string
-  /**
-   *  A links object containing the following members:
-   *    about: a link that leads to further details about this particular occurrence of the problem
-   */
-  links?: ApiLinks
-  /**
-   *  A meta object containing non-standard meta-information about the error.
-   */
-  meta?: Record<string, unknown>
-  /**
-   *  An object containing references to the source of the error, optionally including any of the following members:
-   */
-  source?: Source
-  /**
-   *  The HTTP status code applicable to this problem, expressed as a string value.
-   */
-  status?: string
-  /**
-   *  A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
-   */
-  title?: string
-}

package/src/middleware/standardResponses/jsonApi/index.ts

@@ -1,5 +0,0 @@
-export * from './error.ts'
-export * from './links.ts'
-export * from './relationship.ts'
-export * from './resourceIdentifier.ts'
-export * from './response.ts'

package/src/middleware/standardResponses/jsonApi/links.ts

@@ -1,6 +0,0 @@
-export interface HrefWithMeta {
-  href: string
-  meta: Record<string, unknown>
-}
-export type ApiLink = string | HrefWithMeta
-export type ApiLinks = Record<string, ApiLink>

package/src/middleware/standardResponses/jsonApi/relationship.ts

@@ -1,43 +0,0 @@
-import type { ApiResourceIdentifierObject } from './resourceIdentifier.ts'
-
-export interface IRelationshipSelfLink {
-  /**
-   * A link for the relationship itself (a "relationship link"). This link allows the client to directly manipulate the relationship.
-   * For example, removing an author through an article’s relationship URL would disconnect the person from the article without
-   * deleting the people resource itself. When fetched successfully, this link returns the linkage for the related resources as its primary data.
-   */
-  self: string
-}
-
-export interface IRelationshipRelatedLink {
-  /**
-   * A related resource link
-   */
-  related: string
-}
-
-export interface IRelationshipLinks {
-  links: IRelationshipRelatedLink | IRelationshipSelfLink
-}
-
-/**
- * Resource linkage in a compound document allows a client to link together all of the included resource objects without having to GET any URLs via links.
- * Resource linkage MUST be represented as one of the following:
- *    • null for empty to-one relationships.
- *    • an empty array ([]) for empty to-many relationships.
- *    • a single resource identifier object for non-empty to-one relationships.
- *    • an array of resource identifier objects for non-empty to-many relationships.
- */
-export type ResourceLinkage = null | [] | ApiResourceIdentifierObject | ApiResourceIdentifierObject[]
-export interface IRelationshipData {
-  data: ResourceLinkage
-}
-
-export type RelationshipMeta = Record<string, unknown>
-
-/**
- * The value of the relationships key MUST be an object (a "relationships object"). Members of the relationships object ("relationships")
- * represent references from the resource object in which it’s defined to other resource objects.
- * Relationships may be to-one or to-many.
- */
-export type Relationship = IRelationshipLinks | IRelationshipData | RelationshipMeta

package/src/middleware/standardResponses/jsonApi/resourceIdentifier.ts

@@ -1,15 +0,0 @@
-/**
- * Within a given API, each resource object's type and id pair MUST identify a single, unique resource.
- * (The set of URIs controlled by a server, or multiple servers acting as one, constitute an API.)
- */
-export interface ApiResourceIdentifierObject {
-  /**
-   * The id member is not required when the resource object originates at the client and represents a new resource to be created on the server.
-   */
-  id: string
-  /**
-   * The type member is used to describe resource objects that share common attributes and relationships.
-   * The values of type members MUST adhere to the same constraints as member names.
-   */
-  type: string
-}

package/src/middleware/standardResponses/jsonApi/response.ts

@@ -1,49 +0,0 @@
-/**
- * Loosely following the JSON API 1.0 formats and conventions
- * https://jsonapi.org/format/
- */
-
-import type { ApiError } from './error.ts'
-import type { ApiLinks } from './links.ts'
-import type { Relationship } from './relationship.ts'
-import type { ApiResourceIdentifierObject } from './resourceIdentifier.ts'
-
-export interface ApiResourceObject extends ApiResourceIdentifierObject {
-  /**
-   * An attributes object representing some of the resource's data.
-   */
-  attributes?: Record<string, unknown>
-  /**
-   * A links object containing links related to the resource.
-   */
-  links?: ApiLinks
-  /**
-   * A meta object containing non-standard meta-information about a resource that can not be represented as an attribute or relationship.
-   */
-  meta?: Record<string, unknown>
-  /**
-   * A relationships object describing relationships between the resource and other JSON:API resources.
-   */
-  relationships?: Record<string, Relationship>
-}
-
-export interface JsonApi {
-  meta?: Record<string, unknown>
-  version?: '1.0' | '1.1'
-}
-
-export interface ApiResponseBase {
-  jsonapi?: JsonApi
-  links?: ApiLinks
-  meta?: Record<string, unknown>
-}
-
-export interface ApiDataResponse<T extends ApiResourceIdentifierObject> extends ApiResponseBase {
-  data: T
-  included?: ApiResourceObject[]
-}
-export interface ApiErrorResponse extends ApiResponseBase {
-  errors: ApiError[]
-}
-
-export type ApiResponse<T extends ApiResourceIdentifierObject> = ApiDataResponse<T> | ApiErrorResponse

package/src/middleware/standardResponses/standardErrors.ts

@@ -1,27 +0,0 @@
-import { isError } from '@xylabs/typeof'
-import type {
-  NextFunction, Request, Response,
-} from 'express'
-
-import { getDefaultLogger } from '../../Logger/index.ts'
-import type { ExpressError } from '../../Model/index.ts'
-import type { ApiError } from './jsonApi/index.ts'
-
-export const standardErrors = (err: ExpressError | undefined, req: Request, res: Response, next: NextFunction) => {
-  if (!isError(err)) {
-    next(err)
-    return
-  }
-  getDefaultLogger().error(err.message)
-  err.statusCode = err.statusCode ?? 500
-
-  const error: ApiError = {
-    detail: err.message,
-    status: `${err.statusCode}`,
-    title: err.name,
-  }
-
-  res.status(err.statusCode).json(error)
-
-  next(err)
-}

package/src/middleware/standardResponses/standardResponses.ts

@@ -1,61 +0,0 @@
-import type {
-  Request, RequestHandler, Response,
-} from 'express'
-import mung from 'express-mung'
-
-import { getResponseMetadata } from './getResponseMetadata.js'
-
-interface TransformResponseLocals {
-  rawResponse?: boolean
-}
-
-/**
- * Flags the response to forgo the standard response envelope
- * and return the raw response body to the client
- * @param res The response to disable the standard response format on
- */
-export const setRawResponseFormat = (res: Response): void => {
-  res.locals.rawResponse = true
-}
-
-/**
- * Clears any flags on the response, allowing the response to
- * use the default standard response envelope
- * @param res The response to set to the standard response format
- */
-export const clearRawResponseFormat = (res: Response): void => {
-  res.locals.rawResponse = false
-}
-
-/**
- * Checks if there are any flags on the response that would cause it
- * to forgo the standard response envelope and return the raw response
- * body to the client
- * @param res
- * @returns True if there are any flags on the response, false otherwise
- */
-export const isRawResponseFormatSet = (res: Response): boolean => {
-  return res.locals.rawResponse ? true : false
-}
-
-/**
- * Transforms each response to conform to the standard response format (compatible with JSON API)
- * @param body The original request body
- * @param _req The request
- * @param res The response
- * @returns The transformed response body
- */
-const transformResponse = (body: unknown, _req: Request, res: Response<unknown, TransformResponseLocals>) => {
-  return isRawResponseFormatSet(res)
-    ? body
-    : (res.statusCode >= 200 && res.statusCode < 300)
-        ? { data: body, meta: getResponseMetadata(res) }
-        : { error: body, meta: getResponseMetadata(res) }
-}
-
-/**
- * Connect middleware to enable the transform of all responses to match
- * the standard response format (compatible with JSON API)
- */
-
-export const standardResponses: RequestHandler = mung.json(transformResponse, { mungError: true })