@paroicms/public-server-lib 0.31.0 → 0.31.1

package/package.json

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

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

@@ -79,6 +79,7 @@ export interface BackendPluginInitService {
   registerHook(hookName: string, handler: BackendHookHandler, options?: { unique?: boolean }): void;
   setPublicApiHandler(handler: PublicApiHandler): void;
   addHeadTag(...htmlTags: string[]): void;
+  registeredSite: RegisteredSite;
   configuration: PluginConfiguration;
   pluginAssetsUrl: string;
 }
@@ -118,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;
 }
@@ -223,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;
@@ -252,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,
@@ -291,6 +289,8 @@ export interface RunningInstanceConnector {
       contents: RiPartContent[];
     },
   ): Promise<void>;
+  registerNewSite: (options: NewSiteOptions) => Promise<RegisteredSite>;
+  removeSite: (fqdn: string) => Promise<void>;
 }
 
 export interface SiteSchemaAndIds {