@paroicms/public-server-lib 0.28.0 → 0.29.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paroicms/public-server-lib",
-  "version": "0.28.0",
+  "version": "0.29.0",
   "description": "Common utilitaries for paroicms plugins (backend side).",
   "author": "Paroi Team",
   "repository": {

package/types/backend-plugin-types.d.ts

@@ -8,7 +8,50 @@ import type {
   SiteIds,
   ThemeConf,
 } from "@paroicms/public-anywhere-lib";
-import type { Request, Response } from "express";
+import type Stream from "node:stream";
+
+export interface PaHttpContext {
+  req: PaHttpRequest;
+  res: PaHttpResponse;
+}
+
+export interface PaHttpRequest {
+  hostname: string;
+  headers: { [headerName: string]: string | undefined };
+  method: string;
+  /** Contains the path and the query string. */
+  relativeUrl: string;
+  path: string;
+  query: { [parameterName: string]: string | undefined };
+  body: object | undefined;
+  file: MulterFile | undefined;
+}
+
+export interface MulterFile {
+  /** Name of the form field associated with this file. */
+  fieldname: string;
+  /** Name of the file on the uploader's computer. */
+  originalname: string;
+  /** Value of the `Content-Type` header for this file. */
+  mimetype: string;
+  /** Size of the file in bytes. */
+  size: number;
+  /** `DiskStorage` only: Directory to which this file has been uploaded. */
+  destination: string;
+  /** `DiskStorage` only: Name of this file within `destination`. */
+  filename: string;
+  /** `DiskStorage` only: Full path to the uploaded file. */
+  path: string;
+  /** `MemoryStorage` only: A Buffer containing the entire file. */
+  buffer: Buffer;
+}
+
+export interface PaHttpResponse {
+  readonly headersSent: boolean;
+  status(code: number): this;
+  append(field: string, value?: string[] | string): this;
+  send(body?: Buffer | object | string | Stream): this;
+}
 
 export interface ParoiCmsPlugin {
   version: string;
@@ -55,8 +98,7 @@ export type PluginLiquidFilterHandler = (
 
 export type PublicApiHandler = (
   service: BackendPluginRenderService,
-  req: Request,
-  res: Response,
+  httpContext: PaHttpContext,
   relativePath: string,
 ) => Promise<void> | void;
 
@@ -94,22 +136,24 @@ export interface BackendPluginRenderService extends BackendPluginService {
     fieldName: string;
     language?: string;
   }) => Promise<FieldValue | undefined>;
-  renderChildPartials(options: {
-    req: Request;
-    res: Response;
-    params: PartialsParamsInput;
-    parentDocumentId: ParsedNodelId;
-    labeledByTermId?: string;
-  }): Promise<void>;
-  renderSearchPartials(options: {
-    req: Request;
-    res: Response;
-    language: string;
-    words: string[];
-    limit: number;
-    start: number;
-    templateName: string;
-  }): Promise<void>;
+  renderChildPartials(
+    ctx: PaHttpContext,
+    options: {
+      params: PartialsParamsInput;
+      parentDocumentId: ParsedNodelId;
+      labeledByTermId?: string;
+    },
+  ): Promise<void>;
+  renderSearchPartials(
+    ctx: PaHttpContext,
+    options: {
+      language: string;
+      words: string[];
+      limit: number;
+      start: number;
+      templateName: string;
+    },
+  ): Promise<void>;
   useImage: (options: { imageUid: string; size: ImageSize }) => Promise<UsedImage>;
   getDocument: (documentId: string) => Promise<PublicDocument | undefined>;
 }