@paroicms/public-server-lib 0.25.0 → 0.27.0

package/dist/simple-i18n.d.ts

@@ -1,5 +1,5 @@
 import type { ScSchemaLocales, ScTranslations } from "@paroicms/public-anywhere-lib";
-import type { AppLogger } from "../types/backend-plugin-types.ts";
+import type { AppLogger } from "../types/backend-plugin-types.d.ts";
 export interface SimpleTranslator {
     translate: (options: SimpleTranslateOptions) => string;
 }
@@ -19,4 +19,4 @@ export declare function createSimpleTranslator(options: {
         [language: string]: ScTranslations;
     } | ScSchemaLocales;
     logger: Pick<AppLogger, "warn">;
-}): Promise<SimpleTranslator>;
+}): SimpleTranslator;

package/dist/simple-i18n.js

@@ -7,7 +7,7 @@ export async function loadSimpleTranslatorFromDirectory(options) {
         translate: (options) => translate(labels, options),
     };
 }
-export async function createSimpleTranslator(options) {
+export function createSimpleTranslator(options) {
     const labels = new Map(Object.entries(options.labels).map(([k, v]) => [k, flattenLocales(v)]));
     return {
         translate: (options) => translate(labels, options),

package/dist/simple-i18n.js.map

@@ -1 +1 @@
-{"version":3,"file":"simple-i18n.js","sourceRoot":"","sources":["../src/simple-i18n.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAC;AAEnD,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAcjC,MAAM,CAAC,KAAK,UAAU,iCAAiC,CAAC,OAIvD;IACC,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,CAAC;IACzC,OAAO;QACL,SAAS,EAAE,CAAC,OAA+B,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC;KAC3E,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAAC,OAO5C;IACC,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/F,OAAO;QACL,SAAS,EAAE,CAAC,OAA+B,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC;KAC3E,CAAC;AACJ,CAAC;AAED,SAAS,SAAS,CAChB,MAA4C,EAC5C,EAAE,IAAI,GAAG,EAAE,EAAE,GAAG,EAAE,YAAY,EAAE,QAAQ,EAA0B;IAElE,IAAI,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;IACxC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO,YAAY,IAAI,GAAG,CAAC;IAC7B,CAAC;IACD,MAAM,SAAS,GAAG,qBAAqB,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAC5D,SAAS,CAAC,OAAO,EAAE,CAAC;IACpB,KAAK,MAAM,EAAE,aAAa,EAAE,YAAY,EAAE,cAAc,EAAE,IAAI,SAAS,EAAE,CAAC;QACxE,MAAM,KAAK,GAAG,IAAI,CAAC,cAAc,GAAG,CAAC,CAAC,CAAC;QACvC,MAAM,MAAM,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC;QACjD,MAAM,KAAK,GAAG,KAAK,CAAC,SAAS,CAAC,aAAa,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;QACnE,KAAK,GAAG,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,EAAE,CAAC;IACtC,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAiBD,SAAS,qBAAqB,CAAC,GAAW,EAAE,GAAW;IACrD,MAAM,OAAO,GAAuB,EAAE,CAAC;IACvC,MAAM,KAAK,GAAG,WAAW,CAAC;IAC1B,IAAI,KAA6B,CAAC;IAClC,OAAO,IAAI,EAAE,CAAC;QACZ,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxB,IAAI,CAAC,KAAK;YAAE,MAAM;QAClB,MAAM,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC;QAC7B,MAAM,cAAc,GAAG,KAAK,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC;QACnF,IAAI,cAAc,IAAI,GAAG,EAAE,CAAC;YAC1B,OAAO,CAAC,IAAI,CAAC;gBACX,YAAY;gBACZ,cAAc;gBACd,aAAa,EAAE,KAAK,CAAC,KAAK;aAC3B,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,KAAK,UAAU,UAAU,CAAC,EACxB,OAAO,EACP,SAAS,EACT,MAAM,GAKP;IACC,MAAM,MAAM,GAAG,IAAI,GAAG,EAAmC,CAAC;IAC1D,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;QACjC,IAAI,OAAe,CAAC;QACpB,IAAI,CAAC;YACH,OAAO,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,QAAQ,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC;QACvE,CAAC;QAAC,MAAM,CAAC;YACP,SAAS,CAAC,uDAAuD;QACnE,CAAC;QACD,IAAI,CAAC;YACH,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAC5D,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,CAAC,IAAI,CAAC,wBAAwB,IAAI,CAAC,OAAO,EAAE,GAAG,QAAQ,OAAO,CAAC,GAAG,CAAC,CAAC;QAC5E,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,cAAc,CAAC,MAAc,EAAE,MAAM,GAAG,EAAE;IACjD,MAAM,MAAM,GAA4B,EAAE,CAAC;IAE3C,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAChD,IAAI,GAAG,KAAK,IAAI;YAAE,MAAM,IAAI,KAAK,CAAC,2BAA2B,GAAG,GAAG,CAAC,CAAC;QACrE,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;YAC5B,MAAM,CAAC,GAAG,MAAM,GAAG,GAAG,EAAE,CAAC,GAAG,GAAG,CAAC;QAClC,CAAC;aAAM,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;YACnC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,GAAG,EAAE,GAAG,MAAM,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC;QACjE,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,sBAAsB,GAAG,GAAG,CAAC,CAAC;QAChD,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}
+{"version":3,"file":"simple-i18n.js","sourceRoot":"","sources":["../src/simple-i18n.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAC;AAEnD,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAcjC,MAAM,CAAC,KAAK,UAAU,iCAAiC,CAAC,OAIvD;IACC,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,CAAC;IACzC,OAAO;QACL,SAAS,EAAE,CAAC,OAA+B,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC;KAC3E,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,OAOtC;IACC,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/F,OAAO;QACL,SAAS,EAAE,CAAC,OAA+B,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC;KAC3E,CAAC;AACJ,CAAC;AAED,SAAS,SAAS,CAChB,MAA4C,EAC5C,EAAE,IAAI,GAAG,EAAE,EAAE,GAAG,EAAE,YAAY,EAAE,QAAQ,EAA0B;IAElE,IAAI,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;IACxC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO,YAAY,IAAI,GAAG,CAAC;IAC7B,CAAC;IACD,MAAM,SAAS,GAAG,qBAAqB,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAC5D,SAAS,CAAC,OAAO,EAAE,CAAC;IACpB,KAAK,MAAM,EAAE,aAAa,EAAE,YAAY,EAAE,cAAc,EAAE,IAAI,SAAS,EAAE,CAAC;QACxE,MAAM,KAAK,GAAG,IAAI,CAAC,cAAc,GAAG,CAAC,CAAC,CAAC;QACvC,MAAM,MAAM,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC;QACjD,MAAM,KAAK,GAAG,KAAK,CAAC,SAAS,CAAC,aAAa,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;QACnE,KAAK,GAAG,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,EAAE,CAAC;IACtC,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAiBD,SAAS,qBAAqB,CAAC,GAAW,EAAE,GAAW;IACrD,MAAM,OAAO,GAAuB,EAAE,CAAC;IACvC,MAAM,KAAK,GAAG,WAAW,CAAC;IAC1B,IAAI,KAA6B,CAAC;IAClC,OAAO,IAAI,EAAE,CAAC;QACZ,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxB,IAAI,CAAC,KAAK;YAAE,MAAM;QAClB,MAAM,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC;QAC7B,MAAM,cAAc,GAAG,KAAK,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC;QACnF,IAAI,cAAc,IAAI,GAAG,EAAE,CAAC;YAC1B,OAAO,CAAC,IAAI,CAAC;gBACX,YAAY;gBACZ,cAAc;gBACd,aAAa,EAAE,KAAK,CAAC,KAAK;aAC3B,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,KAAK,UAAU,UAAU,CAAC,EACxB,OAAO,EACP,SAAS,EACT,MAAM,GAKP;IACC,MAAM,MAAM,GAAG,IAAI,GAAG,EAAmC,CAAC;IAC1D,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;QACjC,IAAI,OAAe,CAAC;QACpB,IAAI,CAAC;YACH,OAAO,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,QAAQ,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC;QACvE,CAAC;QAAC,MAAM,CAAC;YACP,SAAS,CAAC,uDAAuD;QACnE,CAAC;QACD,IAAI,CAAC;YACH,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAC5D,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,CAAC,IAAI,CAAC,wBAAwB,IAAI,CAAC,OAAO,EAAE,GAAG,QAAQ,OAAO,CAAC,GAAG,CAAC,CAAC;QAC5E,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,cAAc,CAAC,MAAc,EAAE,MAAM,GAAG,EAAE;IACjD,MAAM,MAAM,GAA4B,EAAE,CAAC;IAE3C,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAChD,IAAI,GAAG,KAAK,IAAI;YAAE,MAAM,IAAI,KAAK,CAAC,2BAA2B,GAAG,GAAG,CAAC,CAAC;QACrE,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;YAC5B,MAAM,CAAC,GAAG,MAAM,GAAG,GAAG,EAAE,CAAC,GAAG,GAAG,CAAC;QAClC,CAAC;aAAM,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;YACnC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,GAAG,EAAE,GAAG,MAAM,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC;QACjE,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,sBAAsB,GAAG,GAAG,CAAC,CAAC;QAChD,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paroicms/public-server-lib",
-  "version": "0.25.0",
+  "version": "0.27.0",
   "description": "Common utilitaries for paroicms plugins (backend side).",
   "author": "Paroi Team",
   "repository": {
@@ -21,15 +21,15 @@
   },
   "dependencies": {
     "@paroi/data-formatters-lib": "~0.4.0",
-    "@paroicms/internal-anywhere-lib": "1.24.0",
-    "@paroicms/public-anywhere-lib": "0.18.0",
+    "@paroicms/internal-anywhere-lib": "1.25.0",
+    "@paroicms/public-anywhere-lib": "0.19.0",
     "@types/express": "~4.17.21"
   },
   "devDependencies": {
-    "@types/node": "~22.10.7",
+    "@types/node": "~22.13.10",
     "rimraf": "~6.0.1",
-    "typescript": "~5.7.3",
-    "vitest": "~3.0.2"
+    "typescript": "~5.8.2",
+    "vitest": "~3.0.5"
   },
   "files": [
     "dist",

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

@@ -3,7 +3,9 @@ import type {
   FieldValue,
   ImageSize,
   ParsedNodelId,
+  ScFieldDataType,
   ScSiteSchema,
+  SiteIds,
   ThemeConf,
 } from "@paroicms/public-anywhere-lib";
 import type { Request, Response } from "express";
@@ -75,6 +77,16 @@ export interface BackendPluginService {
   executeHook<T = unknown>(hookName: string, params?: any): T[];
   pluginConf: PluginConf;
   pluginAssetsUrl: string;
+  registerNewSite: (options: NewSiteOptions) => Promise<Readonly<SiteConf>>;
+  /** This is the connector of the running instance of ParoiCMS. */
+  connector: RunningInstanceConnector;
+}
+
+export interface NewSiteOptions {
+  packName: string;
+  siteDir: string;
+  domain: string;
+  version?: string;
 }
 
 export interface BackendPluginRenderService extends BackendPluginService {
@@ -160,3 +172,159 @@ 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 type SitePackConf = FqdnSitePackConf | SubDomainSitePackConf;
+
+export interface SitePackConfBase {
+  packName: string;
+  sitesDir?: string;
+  dataDir: string;
+  cacheDir: string;
+  backupDir: string;
+  redirectWww?: boolean;
+  trusted: boolean;
+}
+
+export interface FqdnSitePackConf extends SitePackConfBase {
+  serveOn: "fqdn";
+}
+
+export interface SubDomainSitePackConf extends SitePackConfBase {
+  serveOn: "subDomain";
+  parentDomain: string;
+}
+
+export interface RunningInstanceConnector {
+  getSitePackConf(packName: string): SitePackConf;
+  loadSiteSchemaAndIds(fqdn: string): Promise<SiteSchemaAndIds>;
+  createAccount(
+    fqdn: string,
+    account: RiNewAccount,
+    options?: { asContactEmail?: boolean },
+  ): Promise<void>;
+  updateSiteFields(fqdn: string, fields: RiFieldSetContent): Promise<void>;
+  updateDocumentContent(
+    fqdn: string,
+    options: {
+      nodeId: string;
+      content: RiDocumentContent;
+    },
+  ): Promise<void>;
+  addMultipleDocumentContents(
+    fqdn: string,
+    options: {
+      parentNodeId: string;
+      contents: RiDocumentContent[];
+    },
+  ): Promise<void>;
+  addMultiplePartContents(
+    fqdn: string,
+    options: {
+      parentNodeId: string;
+      contents: RiPartContent[];
+    },
+  ): Promise<void>;
+}
+
+export interface SiteSchemaAndIds {
+  siteSchema: ScSiteSchema;
+  siteIds: SiteIds;
+}
+
+export type RiNewAccount = RiLocalNewAccount | RiExternalNewAccount;
+
+export interface RiLocalNewAccount {
+  kind: "local";
+  email: string;
+  name: string;
+  password: string;
+}
+
+export interface RiExternalNewAccount {
+  kind: "google";
+  email: string;
+  name: string;
+}
+
+/** "Nc" stands for Node Content. */
+export type RiNodeContent = RiDocumentContent | RiPartContent;
+
+export interface RiDocumentContent {
+  kind: "document";
+  typeName: string;
+  title?: { [language: string]: string };
+  featuredImage?: RiMediaValue;
+  fields: RiFieldSetContent;
+}
+
+export interface RiPartContent {
+  kind: "part";
+  typeName: string;
+  fields: RiFieldSetContent;
+}
+
+export interface RiFieldSetContent {
+  [fieldName: string]: RiFieldContent;
+}
+
+export type RiFieldContent =
+  | RiStringContent
+  | RiNumberContent
+  | RiBooleanContent
+  | RiQuillDeltaContent
+  | RiMediaContent
+  | RiGalleryContent;
+
+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 RiMediaContent = RiFieldContentTemplate<"media", RiMediaValue>;
+export type RiGalleryContent = RiFieldContentTemplate<"gallery", RiGalleryValue>;
+
+export type RiFieldContentTemplate<T extends ScFieldDataType, V> =
+  | RiLocalizedFieldContent<T, V>
+  | RiUnlocalizedFieldContent<T, V>;
+
+export interface RiLocalizedFieldContent<T extends ScFieldDataType, V> {
+  dataType: T;
+  localized: true;
+  value: {
+    [language: string]: V | null;
+  };
+}
+
+export interface RiUnlocalizedFieldContent<T extends ScFieldDataType, V> {
+  dataType: T;
+  localized: false;
+  value: V | null;
+}
+
+export interface RiMediaValue {
+  file: string;
+}
+
+export interface RiGalleryValue {
+  files: string[];
+}
+
+// TODO: replace with markdown content. The plugin should convert markdown to quill delta.
+export interface QuillDeltaValue {
+  ops: any[];
+}