@paroicms/public-server-lib 0.42.0 → 0.43.0

package/dist/index.d.ts

@@ -1,8 +1,6 @@
 export type * from "../types/backend-plugin-types.d.ts";
 export * from "./api-error-handler.js";
-export * from "./esm-module.helper.js";
 export * from "./html-helpers.js";
 export * from "./obfuscate.helper.js";
 export * from "./server-image-cache-engine.helper.js";
 export * from "./simple-i18n.js";
-export * from "./vite-config.helper.js";

package/dist/index.js

@@ -1,8 +1,6 @@
 export * from "./api-error-handler.js";
-export * from "./esm-module.helper.js";
 export * from "./html-helpers.js";
 export * from "./obfuscate.helper.js";
 export * from "./server-image-cache-engine.helper.js";
 export * from "./simple-i18n.js";
-export * from "./vite-config.helper.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uCAAuC,CAAC;AACtD,cAAc,kBAAkB,CAAC;AACjC,cAAc,yBAAyB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,cAAc,wBAAwB,CAAC;AACvC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uCAAuC,CAAC;AACtD,cAAc,kBAAkB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paroicms/public-server-lib",
-  "version": "0.42.0",
+  "version": "0.43.0",
   "description": "Common utilitaries for paroicms plugins (backend side).",
   "author": "Paroi Team",
   "repository": {
@@ -20,8 +20,8 @@
     "dev": "tsc --watch --preserveWatchOutput"
   },
   "dependencies": {
-    "@paroicms/internal-anywhere-lib": "1.32.0",
-    "@paroicms/public-anywhere-lib": "0.33.0",
+    "@paroicms/internal-anywhere-lib": "1.33.0",
+    "@paroicms/public-anywhere-lib": "0.34.0",
     "arktype": "~2.1.20"
   },
   "devDependencies": {

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

@@ -74,15 +74,10 @@ export interface PaHttpResponse {
 
 export interface ParoiCmsPlugin {
   version: string;
-  /**
-   * The slug of the plugin. It must be unique among all plugins. When it is not provided, then it
-   * is generated from the plugin name.
-   */
-  slug?: string;
   siteInit?: (service: BackendPluginInitService) => void | Promise<void>;
 }
 
-export interface BackendPluginInitService {
+export interface BackendPluginInitService extends PluginStaticConfiguration {
   logger: AppLogger;
   setPublicAssetsDirectory(directory: string): void;
   setAdminUiAssetsDirectory(directory: string): void;
@@ -119,13 +114,13 @@ export interface BackendPluginInitService {
       UpdateFieldValue
     >,
   ): void;
+  registerHook(hookName: "sendMail", handler: BackendHookHandler<MailData, undefined, void>): void;
   registerRenderingHook(hookName: "fieldPreprocessor", handler: RenderingHookHandler): void;
   setPublicApiHandler(handler: PublicApiHandler): void;
   /** @deprecated Use `registerHeadTags` instead. */
   addHeadTag(...htmlTags: string[]): void;
   registerHeadTags(handler: HeadTagsHandler): void;
   registeredSite: RegisteredSite;
-  configuration: PluginConfiguration;
   pluginAssetsUrl: string;
 }
 
@@ -182,13 +177,12 @@ export type PublicApiHandler = (
   relativePath: string,
 ) => Promise<void> | void;
 
-export interface BackendPluginService {
+export interface BackendPluginService extends PluginStaticConfiguration {
   fqdn: string;
   siteUrl: string;
   siteSchema: ScSiteSchema;
   themeConf: ThemeConf;
   logger: AppLogger;
-  validateRecaptchaResponse: (gRecaptchaResponse: string | undefined) => Promise<boolean>;
   sendMail: ({ subject, html, replyTo, to }: MailData) => Promise<void>;
   executeHook(
     hookName: string,
@@ -198,7 +192,6 @@ export interface BackendPluginService {
     },
   ): Promise<unknown> | unknown;
   registeredSite: RegisteredSite;
-  configuration: PluginConfiguration;
   pluginAssetsUrl: string;
   /** This is the connector of the running instance of ParoiCMS. */
   connector: RunningInstanceConnector;
@@ -293,14 +286,20 @@ export interface PublicDocument {
   publishDate: string;
 }
 
-export interface PluginConfigurations {
-  [pluginName: string]: PluginConfiguration;
+export interface PluginStaticConfigurations {
+  [pluginName: string]: PluginStaticConfiguration | undefined;
 }
 
-export interface PluginConfiguration {
-  [key: string]: unknown;
-  adminUi?: Obj;
-  googleRecaptchaSiteKey?: string;
+/**
+ * This is the configuration of a plugin that is statically defined in the app configuration, or in
+ * the site schema.
+ */
+export interface PluginStaticConfiguration {
+  platform: boolean;
+  configuration: {
+    [key: string]: unknown;
+    adminUi?: Obj;
+  };
 }
 
 export interface MailData {

package/dist/esm-module.helper.d.ts

@@ -1,3 +0,0 @@
-export declare function resolveModuleDirectory(moduleUrl: string, { parent }?: {
-    parent?: boolean | undefined;
-}): string;

package/dist/esm-module.helper.js

@@ -1,7 +0,0 @@
-import { dirname, resolve } from "node:path";
-import { fileURLToPath } from "node:url";
-export function resolveModuleDirectory(moduleUrl, { parent = false } = {}) {
-    const dir = resolve(dirname(fileURLToPath(moduleUrl)));
-    return parent ? dirname(dir) : dir;
-}
-//# sourceMappingURL=esm-module.helper.js.map

package/dist/esm-module.helper.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"esm-module.helper.js","sourceRoot":"","sources":["../src/esm-module.helper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,MAAM,UAAU,sBAAsB,CAAC,SAAiB,EAAE,EAAE,MAAM,GAAG,KAAK,EAAE,GAAG,EAAE;IAC/E,MAAM,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IACvD,OAAO,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;AACrC,CAAC"}

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

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

package/dist/vite-config.helper.js

@@ -1,18 +0,0 @@
-import { readFileSync } from "node:fs";
-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)
-        throw new Error("missing 'solid-js' dependency");
-    if (!version.match(/^[0-9]+\.[0-9]+\.[0-9]+$/)) {
-        throw new Error(`invalid solid-js version: "${version}" (please use an exact x.x.x version)`);
-    }
-    return version;
-}
-//# sourceMappingURL=vite-config.helper.js.map

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

@@ -1 +0,0 @@
-{"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"}