@paroicms/public-server-lib 0.26.0 → 0.27.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paroicms/public-server-lib",
-  "version": "0.26.0",
+  "version": "0.27.0",
   "description": "Common utilitaries for paroicms plugins (backend side).",
   "author": "Paroi Team",
   "repository": {

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

@@ -213,26 +213,31 @@ export interface SubDomainSitePackConf extends SitePackConfBase {
 export interface RunningInstanceConnector {
   getSitePackConf(packName: string): SitePackConf;
   loadSiteSchemaAndIds(fqdn: string): Promise<SiteSchemaAndIds>;
-  updateSiteFields(fqdn: string, fields: NcFieldSetContent): Promise<void>;
+  createAccount(
+    fqdn: string,
+    account: RiNewAccount,
+    options?: { asContactEmail?: boolean },
+  ): Promise<void>;
+  updateSiteFields(fqdn: string, fields: RiFieldSetContent): Promise<void>;
   updateDocumentContent(
     fqdn: string,
     options: {
       nodeId: string;
-      content: NcDocumentContent;
+      content: RiDocumentContent;
     },
   ): Promise<void>;
   addMultipleDocumentContents(
     fqdn: string,
     options: {
       parentNodeId: string;
-      contents: NcDocumentContent[];
+      contents: RiDocumentContent[];
     },
   ): Promise<void>;
   addMultiplePartContents(
     fqdn: string,
     options: {
       parentNodeId: string;
-      contents: NcPartContent[];
+      contents: RiPartContent[];
     },
   ): Promise<void>;
 }
@@ -242,47 +247,62 @@ export interface SiteSchemaAndIds {
   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 NcNodeContent = NcDocumentContent | NcPartContent;
+export type RiNodeContent = RiDocumentContent | RiPartContent;
 
-export interface NcDocumentContent {
+export interface RiDocumentContent {
   kind: "document";
   typeName: string;
   title?: { [language: string]: string };
-  featuredImage?: NcMediaValue;
-  fields: NcFieldSetContent;
+  featuredImage?: RiMediaValue;
+  fields: RiFieldSetContent;
 }
 
-export interface NcPartContent {
+export interface RiPartContent {
   kind: "part";
   typeName: string;
-  fields: NcFieldSetContent;
+  fields: RiFieldSetContent;
 }
 
-export interface NcFieldSetContent {
-  [fieldName: string]: NcFieldContent;
+export interface RiFieldSetContent {
+  [fieldName: string]: RiFieldContent;
 }
 
-export type NcFieldContent =
-  | NcStringContent
-  | NcNumberContent
-  | NcBooleanContent
-  | NcQuillDeltaContent
-  | NcMediaContent
-  | NcGalleryContent;
-
-export type NcStringContent = NcFieldContentTemplate<"string", string>;
-export type NcNumberContent = NcFieldContentTemplate<"number", number>;
-export type NcBooleanContent = NcFieldContentTemplate<"boolean", boolean>;
-export type NcQuillDeltaContent = NcFieldContentTemplate<"quillDelta", QuillDeltaValue>;
-export type NcMediaContent = NcFieldContentTemplate<"media", NcMediaValue>;
-export type NcGalleryContent = NcFieldContentTemplate<"gallery", NcGalleryValue>;
-
-export type NcFieldContentTemplate<T extends ScFieldDataType, V> =
-  | NcLocalizedFieldContent<T, V>
-  | NcUnlocalizedFieldContent<T, V>;
-
-export interface NcLocalizedFieldContent<T extends ScFieldDataType, V> {
+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: {
@@ -290,17 +310,17 @@ export interface NcLocalizedFieldContent<T extends ScFieldDataType, V> {
   };
 }
 
-export interface NcUnlocalizedFieldContent<T extends ScFieldDataType, V> {
+export interface RiUnlocalizedFieldContent<T extends ScFieldDataType, V> {
   dataType: T;
   localized: false;
   value: V | null;
 }
 
-export interface NcMediaValue {
+export interface RiMediaValue {
   file: string;
 }
 
-export interface NcGalleryValue {
+export interface RiGalleryValue {
   files: string[];
 }