@paroicms/public-server-lib 0.40.0 → 0.42.0

package/dist/vite-config.helper.d.ts

@@ -1 +1,2 @@
-export declare function getSolidJsVersion(pluginPath: string): string;
+export declare function esmDirName(url: string): string;
+export declare function getSolidJsVersion(dirName: string): string;

package/dist/vite-config.helper.js

@@ -1,7 +1,11 @@
 import { readFileSync } from "node:fs";
-import { resolve } from "node:path";
-export function getSolidJsVersion(pluginPath) {
-    const packageJsonPath = resolve(pluginPath, "package.json");
+import { dirname, resolve } from "node:path";
+import { fileURLToPath } from "node:url";
+export function esmDirName(url) {
+    return dirname(fileURLToPath(url));
+}
+export function getSolidJsVersion(dirName) {
+    const packageJsonPath = resolve(dirName, "package.json");
     const packageJson = JSON.parse(readFileSync(packageJsonPath, "utf-8"));
     const version = packageJson.devDependencies["solid-js"];
     if (!version)

package/dist/vite-config.helper.js.map

@@ -1 +1 @@
-{"version":3,"file":"vite-config.helper.js","sourceRoot":"","sources":["../src/vite-config.helper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,MAAM,UAAU,iBAAiB,CAAC,UAAkB;IAClD,MAAM,eAAe,GAAG,OAAO,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;IAC5D,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC,CAAC;IACvE,MAAM,OAAO,GAAG,WAAW,CAAC,eAAe,CAAC,UAAU,CAAuB,CAAC;IAC9E,IAAI,CAAC,OAAO;QAAE,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;IAC/D,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,0BAA0B,CAAC,EAAE,CAAC;QAC/C,MAAM,IAAI,KAAK,CAAC,8BAA8B,OAAO,uCAAuC,CAAC,CAAC;IAChG,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC"}
+{"version":3,"file":"vite-config.helper.js","sourceRoot":"","sources":["../src/vite-config.helper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,MAAM,UAAU,UAAU,CAAC,GAAW;IACpC,OAAO,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC;AACrC,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,OAAe;IAC/C,MAAM,eAAe,GAAG,OAAO,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;IACzD,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC,CAAC;IACvE,MAAM,OAAO,GAAG,WAAW,CAAC,eAAe,CAAC,UAAU,CAAuB,CAAC;IAC9E,IAAI,CAAC,OAAO;QAAE,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;IAC/D,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,0BAA0B,CAAC,EAAE,CAAC;QAC/C,MAAM,IAAI,KAAK,CAAC,8BAA8B,OAAO,uCAAuC,CAAC,CAAC;IAChG,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paroicms/public-server-lib",
-  "version": "0.40.0",
+  "version": "0.42.0",
   "description": "Common utilitaries for paroicms plugins (backend side).",
   "author": "Paroi Team",
   "repository": {
@@ -14,14 +14,14 @@
   "types": "dist/index.d.ts",
   "scripts": {
     "build": "tsc",
-    "test": "vitest",
-    "test:once": "vitest run",
+    "test:watch": "vitest",
+    "test": "vitest run",
     "clear": "rimraf dist/*",
     "dev": "tsc --watch --preserveWatchOutput"
   },
   "dependencies": {
-    "@paroicms/internal-anywhere-lib": "1.31.10",
-    "@paroicms/public-anywhere-lib": "0.31.0",
+    "@paroicms/internal-anywhere-lib": "1.32.0",
+    "@paroicms/public-anywhere-lib": "0.33.0",
     "arktype": "~2.1.20"
   },
   "devDependencies": {

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

@@ -8,9 +8,11 @@ import type {
   ReadFieldValue,
   ResizeRule,
   ScFieldDataType,
+  ScFieldType,
   ScSiteSchema,
   SiteIds,
   ThemeConf,
+  UpdateFieldValue,
   UpdateLabelingFieldValue,
   WithAttachedData,
 } from "@paroicms/public-anywhere-lib";
@@ -101,8 +103,23 @@ export interface BackendPluginInitService {
     tagKind: "injectHtml",
     handler: PluginLiquidTagReturnsHtmlHandler,
   ): void;
-  registerFieldPreprocessor(handler: FieldPreprocessor): void;
-  registerHook(hookName: string, handler: BackendHookHandler, options?: { unique?: boolean }): void;
+  registerHook(
+    hookName: "initialized",
+    handler: BackendHookHandler<undefined, undefined, void>,
+  ): void;
+  registerHook(
+    hookName: "normalizeTypography",
+    handler: BackendHookHandler<string, { language: string }, string>,
+  ): void;
+  registerHook(
+    hookName: "beforeSaveValue",
+    handler: BackendHookHandler<
+      UpdateFieldValue,
+      { fieldType: ScFieldType; language: string | undefined },
+      UpdateFieldValue
+    >,
+  ): void;
+  registerRenderingHook(hookName: "fieldPreprocessor", handler: RenderingHookHandler): void;
   setPublicApiHandler(handler: PublicApiHandler): void;
   /** @deprecated Use `registerHeadTags` instead. */
   addHeadTag(...htmlTags: string[]): void;
@@ -117,10 +134,24 @@ export type HeadTagsHandler = (options: {
   html: string;
 }) => string[] | string | undefined;
 
-export type BackendHookHandler = (
-  service: BackendPluginService,
-  params: any,
-) => Promise<unknown> | unknown;
+export type BackendHookHandler<V = unknown, O = unknown, R = unknown> = (hookPayload: {
+  service: BackendPluginService;
+  value: V;
+  options: O;
+}) => Promise<R> | R;
+
+export type RenderingHookHandler = (hookPayload: {
+  service: PluginRenderingService;
+  options: RenderingHookOptions;
+  value: ReadFieldValue;
+}) => ReadFieldValue | undefined | Promise<ReadFieldValue | undefined>;
+
+export interface RenderingHookOptions {
+  fieldType: ScFieldType;
+  language: string;
+  absoluteUrls?: boolean;
+  outputType?: "plainText";
+}
 
 export type PluginLiquidFilterHandler = (
   service: PluginRenderingService,
@@ -129,10 +160,10 @@ export type PluginLiquidFilterHandler = (
     /**
      * The Liquid context
      */
-    ctx: any;
-    args: any[];
+    ctx: unknown;
+    args: unknown[];
   },
-) => string | Promise<string>;
+) => string | undefined | Promise<string | undefined>;
 
 export type PluginLiquidTagReturnsVarHandler = (
   service: PluginRenderingService,
@@ -145,12 +176,6 @@ export type PluginLiquidTagReturnsHtmlHandler = (
   parameters: { [key: string]: unknown },
 ) => string | Promise<string>;
 
-export type FieldPreprocessor = (
-  service: PluginRenderingService,
-  value: ReadFieldValue,
-  options: FieldPreprocessorOptions,
-) => ReadFieldValue | undefined | Promise<ReadFieldValue | undefined>;
-
 export type PublicApiHandler = (
   service: BackendPluginService,
   httpContext: PaHttpContext,
@@ -165,7 +190,13 @@ export interface BackendPluginService {
   logger: AppLogger;
   validateRecaptchaResponse: (gRecaptchaResponse: string | undefined) => Promise<boolean>;
   sendMail: ({ subject, html, replyTo, to }: MailData) => Promise<void>;
-  executeHook(hookName: string, params?: any): Promise<unknown[]>;
+  executeHook(
+    hookName: string,
+    hookPayload?: {
+      options?: unknown;
+      value?: unknown;
+    },
+  ): Promise<unknown> | unknown;
   registeredSite: RegisteredSite;
   configuration: PluginConfiguration;
   pluginAssetsUrl: string;
@@ -262,11 +293,6 @@ export interface PublicDocument {
   publishDate: string;
 }
 
-export interface FieldPreprocessorOptions {
-  absoluteUrls?: boolean;
-  outputType?: "plainText";
-}
-
 export interface PluginConfigurations {
   [pluginName: string]: PluginConfiguration;
 }