@paroicms/public-server-lib 0.8.0 → 0.9.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paroicms/public-server-lib",
-  "version": "0.8.0",
+  "version": "0.9.1",
   "description": "Common utilitaries for paroicms plugins (backend side).",
   "author": "Paroi Team",
   "repository": {
@@ -27,11 +27,12 @@
     "vitest": "~1.6.0"
   },
   "files": [
-    "dist"
+    "dist",
+    "types"
   ],
   "dependencies": {
     "@paroi/data-formatters-lib": "~0.4.0",
-    "@paroicms/internal-anywhere-lib": "1.18.0",
-    "@paroicms/public-anywhere-lib": "0.3.0"
+    "@paroicms/internal-anywhere-lib": "1.18.1",
+    "@paroicms/public-anywhere-lib": "0.4.0"
   }
 }

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

@@ -0,0 +1,55 @@
+import type { ImageSize } from "@paroicms/public-anywhere-lib";
+import type { Request, Response } from "express";
+import type { AppLog, PluginSiteContext } from "./plugin-site-context-types";
+
+export interface ParoiCmsPlugin {
+  version: string;
+  siteInit?: (api: PluginInitApi) => void | Promise<void>;
+}
+
+export interface PluginInitApi {
+  siteLog: AppLog;
+  registerLiquidFilter(
+    filterName: string,
+    handler: (value: unknown) => string | Promise<string>,
+    options?: { raw?: boolean },
+  ): void;
+  registerFieldPreprocessor(dataType: string, handler: FieldPreprocessor): void;
+  setPublicAssetsDirectory(directory: string): void;
+  setBoAssetsDirectory(directory: string): void;
+  setPublicApiHandler(handler: PublicApiHandler): void;
+  addHeadTag(...htmlTags: string[]): void;
+  declareCommonSchemaLibrary(directory: string): void;
+}
+
+export type PublicApiHandler = (
+  pluginSiteContext: PluginSiteContext,
+  req: Request,
+  res: Response,
+  relativePath: string,
+) => Promise<void> | void;
+
+export type FieldPreprocessor = (
+  ctx: FieldPreprocessorContext,
+  value: unknown,
+  options: FieldPreprocessorOptions,
+) => unknown | Promise<unknown>;
+
+export interface FieldPreprocessorContext {
+  siteContext: PluginSiteContext;
+  useImage: UseImage;
+}
+
+export type UseImage = (options: { imageUid: string; size: ImageSize }) => Promise<UsedImage>;
+
+export interface UsedImage {
+  url: string;
+  width: number;
+  height: number;
+  mediaType: string;
+}
+
+export interface FieldPreprocessorOptions {
+  absoluteUrls?: boolean;
+  outputType?: "plainText";
+}

package/types/plugin-site-context-types.d.ts

@@ -0,0 +1,41 @@
+import type { ScSiteSchema, ThemeConf } from "@paroicms/public-anywhere-lib";
+
+export interface PluginSiteContext {
+  fqdn: string;
+  siteUrl: string;
+  siteSchema: ScSiteSchema;
+  themeConf: ThemeConf;
+  siteLog: AppLog;
+  validateRecaptchaResponse: (gRecaptchaResponse: string | undefined) => Promise<boolean>;
+  getSiteFieldValue: (options: {
+    fieldName: string;
+    language?: string;
+  }) => Promise<unknown | undefined>;
+  sendMail: (
+    { subject, html, replyTo, to }: MailData,
+    {
+      appLog,
+    }: {
+      appLog: AppLog;
+    },
+  ) => Promise<void>;
+}
+
+export interface MailData {
+  subject: string;
+  html: string;
+  replyTo?: ReplyTo;
+  to: string;
+}
+
+export interface ReplyTo {
+  email: string;
+  name: string;
+}
+
+export interface AppLog {
+  error(...messages: any[]): void;
+  warn(...messages: any[]): void;
+  info(...messages: any[]): void;
+  debug(...messages: any[]): void;
+}