@paroicms/public-server-lib 0.31.3 → 0.33.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paroicms/public-server-lib",
-  "version": "0.31.3",
+  "version": "0.33.0",
   "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.27.1",
-    "@paroicms/public-anywhere-lib": "0.21.1",
+    "@paroicms/internal-anywhere-lib": "1.28.0",
+    "@paroicms/public-anywhere-lib": "0.22.0",
     "@types/express": "~4.17.21"
   },
   "devDependencies": {

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

@@ -8,6 +8,7 @@ import type {
   ScSiteSchema,
   SiteIds,
   ThemeConf,
+  UpdateLabelingFieldValue,
 } from "@paroicms/public-anywhere-lib";
 import type Stream from "node:stream";
 
@@ -23,9 +24,14 @@ export interface PaHttpRequest {
   /** Contains the path and the query string. */
   relativeUrl: string;
   path: string;
-  query: { [parameterName: string]: string | undefined };
+  query: PaUrlQuery;
   body: object | undefined;
   file: MulterFile | undefined;
+  cookies?: { [key: string]: string };
+}
+
+export interface PaUrlQuery {
+  [key: string]: undefined | string | PaUrlQuery | (string | PaUrlQuery)[];
 }
 
 export interface MulterFile {
@@ -52,6 +58,12 @@ export interface PaHttpResponse {
   status(code: number): this;
   append(field: string, value?: string[] | string): this;
   send(body?: Buffer | object | string | Stream): this;
+  cookie(
+    name: string,
+    value: string,
+    options?: { maxAge?: number; httpOnly?: boolean; secure?: boolean; path?: string },
+  ): this;
+  clearCookie(name: string, options?: { path?: string }): this;
 }
 
 export interface ParoiCmsPlugin {
@@ -266,13 +278,13 @@ export interface RunningInstanceConnector {
     fqdn: string,
     account: RiNewAccount,
     options?: { asContactEmail?: boolean },
-  ): Promise<void>;
+  ): Promise<string>;
   updateSiteFields(fqdn: string, fields: RiFieldSetContent): Promise<void>;
-  updateDocumentContent(
+  updateNodeContent(
     fqdn: string,
     options: {
       nodeId: string;
-      content: RiDocumentContent;
+      content: RiNodeContent;
     },
   ): Promise<void>;
   addMultipleDocumentContents(
@@ -281,14 +293,14 @@ export interface RunningInstanceConnector {
       parentNodeId: string;
       contents: RiDocumentContent[];
     },
-  ): Promise<void>;
+  ): Promise<ParsedNodelId[]>;
   addMultiplePartContents(
     fqdn: string,
     options: {
       parentNodeId: string;
       contents: RiPartContent[];
     },
-  ): Promise<void>;
+  ): Promise<ParsedNodelId[]>;
   registerNewSite: (options: NewSiteOptions) => Promise<RegisteredSite>;
   removeSite: (fqdn: string) => Promise<void>;
 }
@@ -313,7 +325,6 @@ export interface RiExternalNewAccount {
   name: string;
 }
 
-/** "Nc" stands for Node Content. */
 export type RiNodeContent = RiDocumentContent | RiPartContent;
 
 export interface RiDocumentContent {
@@ -340,7 +351,8 @@ export type RiFieldContent =
   | RiBooleanContent
   | RiQuillDeltaContent
   | RiMediaContent
-  | RiGalleryContent;
+  | RiGalleryContent
+  | RiLabelingContent;
 
 export type RiStringContent = RiFieldContentTemplate<"string", string>;
 export type RiNumberContent = RiFieldContentTemplate<"number", number>;
@@ -348,6 +360,7 @@ export type RiBooleanContent = RiFieldContentTemplate<"boolean", boolean>;
 export type RiQuillDeltaContent = RiFieldContentTemplate<"json", JsonFieldValue>;
 export type RiMediaContent = RiFieldContentTemplate<"media", RiMediaValue>;
 export type RiGalleryContent = RiFieldContentTemplate<"gallery", RiGalleryValue>;
+export type RiLabelingContent = RiUnlocalizedFieldContent<"labeling", UpdateLabelingFieldValue>;
 
 export type RiFieldContentTemplate<T extends ScFieldDataType, V> =
   | RiLocalizedFieldContent<T, V>