@paroicms/public-server-lib 0.30.0 → 0.31.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paroicms/public-server-lib",
-  "version": "0.30.0",
+  "version": "0.31.1",
   "description": "Common utilitaries for paroicms plugins (backend side).",
   "author": "Paroi Team",
   "repository": {
@@ -21,8 +21,8 @@
   },
   "dependencies": {
     "@paroi/data-formatters-lib": "~0.4.0",
-    "@paroicms/internal-anywhere-lib": "1.26.0",
-    "@paroicms/public-anywhere-lib": "0.20.0",
+    "@paroicms/internal-anywhere-lib": "1.27.0",
+    "@paroicms/public-anywhere-lib": "0.21.0",
     "@types/express": "~4.17.21"
   },
   "devDependencies": {

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

@@ -1,8 +1,9 @@
 import type { Obj } from "@paroi/data-formatters-lib";
 import type {
-  FieldValue,
   ImageSize,
+  JsonFieldValue,
   ParsedNodelId,
+  ReadFieldValue,
   ScFieldDataType,
   ScSiteSchema,
   SiteIds,
@@ -74,10 +75,11 @@ export interface BackendPluginInitService {
     handler: PluginLiquidFilterHandler,
     options?: { raw?: boolean },
   ): void;
-  registerFieldPreprocessor(dataType: string, handler: FieldPreprocessor): void;
+  registerFieldPreprocessor(handler: FieldPreprocessor): void;
   registerHook(hookName: string, handler: BackendHookHandler, options?: { unique?: boolean }): void;
   setPublicApiHandler(handler: PublicApiHandler): void;
   addHeadTag(...htmlTags: string[]): void;
+  registeredSite: RegisteredSite;
   configuration: PluginConfiguration;
   pluginAssetsUrl: string;
 }
@@ -104,9 +106,9 @@ export type PublicApiHandler = (
 
 export type FieldPreprocessor = (
   service: BackendPluginRenderService,
-  value: FieldValue,
+  value: ReadFieldValue,
   options: FieldPreprocessorOptions,
-) => FieldValue | undefined | Promise<FieldValue | undefined>;
+) => ReadFieldValue | undefined | Promise<ReadFieldValue | undefined>;
 
 export interface BackendPluginService {
   fqdn: string;
@@ -117,9 +119,9 @@ export interface BackendPluginService {
   validateRecaptchaResponse: (gRecaptchaResponse: string | undefined) => Promise<boolean>;
   sendMail: ({ subject, html, replyTo, to }: MailData) => Promise<void>;
   executeHook<T = unknown>(hookName: string, params?: any): T[];
+  registeredSite: RegisteredSite;
   configuration: PluginConfiguration;
   pluginAssetsUrl: string;
-  registerNewSite: (options: NewSiteOptions) => Promise<Readonly<SiteConf>>;
   /** This is the connector of the running instance of ParoiCMS. */
   connector: RunningInstanceConnector;
 }
@@ -135,13 +137,13 @@ export interface BackendPluginRenderService extends BackendPluginService {
   getSiteFieldValue: (options: {
     fieldName: string;
     language?: string;
-  }) => Promise<FieldValue | undefined>;
+  }) => Promise<ReadFieldValue | undefined>;
   renderChildPartials(
     ctx: PaHttpContext,
     options: {
       params: PartialsParamsInput;
       parentDocumentId: ParsedNodelId;
-      labeledByTermId?: string;
+      labeledBy?: LabeledBy;
     },
   ): Promise<void>;
   renderSearchPartials(
@@ -158,6 +160,11 @@ export interface BackendPluginRenderService extends BackendPluginService {
   getDocument: (documentId: string) => Promise<PublicDocument | undefined>;
 }
 
+export interface LabeledBy {
+  termNodeId: string;
+  fieldName: string;
+}
+
 export interface PublicDocument {
   id: string;
   getUrl: (options?: { absoluteUrl?: boolean }) => Promise<string>;
@@ -217,26 +224,23 @@ export interface PartialsParamsInput {
   offset: string;
   limit: string;
 }
-export interface SiteConf {
-  fqdn: string;
-  siteName: string;
-  version?: string;
-  siteDir: string;
-  dataDir: string;
-  cacheDir: string;
-  backupDir: string;
-  siteUrl: string;
-  /**
-   * This status can be mutated.
-   */
-  loadedOnce: boolean;
-  redirectWww?: boolean;
-  trusted: boolean;
+
+export interface RegisteredSite {
+  readonly fqdn: string;
+  readonly siteName: string;
+  readonly version?: string;
+  readonly siteDir: string;
+  readonly dataDir: string;
+  readonly cacheDir: string;
+  readonly backupDir: string;
+  readonly siteUrl: string;
+  readonly redirectWww?: boolean;
+  readonly trusted: boolean;
 }
 
-export type SitePackConf = FqdnSitePackConf | SubDomainSitePackConf;
+export type SitePackConfiguration = FqdnSitePackConfiguration | SubDomainSitePackConfiguration;
 
-export interface SitePackConfBase {
+export interface SitePackConfigurationBase {
   packName: string;
   sitesDir?: string;
   dataDir: string;
@@ -246,17 +250,17 @@ export interface SitePackConfBase {
   trusted: boolean;
 }
 
-export interface FqdnSitePackConf extends SitePackConfBase {
+export interface FqdnSitePackConfiguration extends SitePackConfigurationBase {
   serveOn: "fqdn";
 }
 
-export interface SubDomainSitePackConf extends SitePackConfBase {
+export interface SubDomainSitePackConfiguration extends SitePackConfigurationBase {
   serveOn: "subDomain";
   parentDomain: string;
 }
 
 export interface RunningInstanceConnector {
-  getSitePackConf(packName: string): SitePackConf;
+  getSitePackConf(packName: string): SitePackConfiguration;
   loadSiteSchemaAndIds(fqdn: string): Promise<SiteSchemaAndIds>;
   createAccount(
     fqdn: string,
@@ -285,6 +289,8 @@ export interface RunningInstanceConnector {
       contents: RiPartContent[];
     },
   ): Promise<void>;
+  registerNewSite: (options: NewSiteOptions) => Promise<RegisteredSite>;
+  removeSite: (fqdn: string) => Promise<void>;
 }
 
 export interface SiteSchemaAndIds {
@@ -339,7 +345,7 @@ export type RiFieldContent =
 export type RiStringContent = RiFieldContentTemplate<"string", string>;
 export type RiNumberContent = RiFieldContentTemplate<"number", number>;
 export type RiBooleanContent = RiFieldContentTemplate<"boolean", boolean>;
-export type RiQuillDeltaContent = RiFieldContentTemplate<"quillDelta", QuillDeltaValue>;
+export type RiQuillDeltaContent = RiFieldContentTemplate<"json", JsonFieldValue>;
 export type RiMediaContent = RiFieldContentTemplate<"media", RiMediaValue>;
 export type RiGalleryContent = RiFieldContentTemplate<"gallery", RiGalleryValue>;
 
@@ -368,8 +374,3 @@ export interface RiMediaValue {
 export interface RiGalleryValue {
   files: string[];
 }
-
-// TODO: replace with markdown content. The plugin should convert markdown to quill delta.
-export interface QuillDeltaValue {
-  ops: any[];
-}