@plurid/plurid-react-server 0.0.0-0 → 0.0.0-11

package/distribution/data/constants/general/index.d.ts

@@ -0,0 +1,34 @@
+export declare const DEFAULT_SERVER_PORT: number;
+export declare const DEFAULT_SERVER_OPTIONS_SERVER_NAME = "Plurid Server";
+export declare const DEFAULT_SERVER_OPTIONS_HOSTNAME = "origin";
+export declare const DEFAULT_SERVER_OPTIONS_QUIET = false;
+export declare const DEFAULT_SERVER_OPTIONS_COMPRESSION = true;
+export declare const DEFAULT_SERVER_OPTIONS_OPEN = false;
+export declare const DEFAULT_SERVER_OPTIONS_BUILD_DIRECTORY = "build";
+export declare const DEFAULT_SERVER_OPTIONS_ASSETS_DIRECTORY = "assets";
+export declare const DEFAULT_SERVER_OPTIONS_STILLS_DIRECTORY = "stills";
+export declare const DEFAULT_SERVER_OPTIONS_GATEWAY = "/gateway";
+export declare const DEFAULT_SERVER_OPTIONS: {
+    SERVER_NAME: string;
+    HOSTNAME: string;
+    QUIET: boolean;
+    COMPRESSION: boolean;
+    OPEN: boolean;
+    BUILD_DIRECTORY: string;
+    ASSETS_DIRECTORY: string;
+    STILLS_DIRECTORY: string;
+    GATEWAY: string;
+};
+export declare const DEFAULT_RENDERER_LANGUAGE = "en";
+export declare const DEFAULT_RENDERER_ROOT = "root";
+export declare const DEFAULT_RENDERER_PLURID_STATE = "{}";
+export declare const DEFAULT_RENDERER_VENDOR_SCRIPT_SOURCE = "/vendor.js";
+export declare const DEFAULT_RENDERER_MAIN_SCRIPT_SOURCE = "/index.js";
+export declare const DEFAULT__PRELOADED_PLURID_METASTATE__ = "__PRELOADED_PLURID_METASTATE__";
+export declare const CATCH_ALL_ROUTE = "*";
+export declare const NOT_FOUND_ROUTE: string;
+export declare const PTTP_ROUTE: string;
+export declare const environment: {
+    production: boolean;
+    development: boolean;
+};

package/distribution/data/constants/index.d.ts

@@ -1,30 +1,2 @@
+export * from './general';
 export * from './stiller';
-export declare const DEFAULT_SERVER_PORT: number;
-export declare const DEFAULT_SERVER_OPTIONS_SERVER_NAME = "Plurid Server";
-export declare const DEFAULT_SERVER_OPTIONS_QUIET = false;
-export declare const DEFAULT_SERVER_OPTIONS_COMPRESSION = true;
-export declare const DEFAULT_SERVER_OPTIONS_OPEN = false;
-export declare const DEFAULT_SERVER_OPTIONS_BUILD_DIRECTORY = "build";
-export declare const DEFAULT_SERVER_OPTIONS_STILLS_DIRECTORY = "stills";
-export declare const DEFAULT_SERVER_OPTIONS_GATEWAY = "/gateway";
-export declare const DEFAULT_SERVER_OPTIONS: {
-    SERVER_NAME: string;
-    QUIET: boolean;
-    COMPRESSION: boolean;
-    OPEN: boolean;
-    BUILD_DIRECTORY: string;
-    STILLS_DIRECTORY: string;
-    GATEWAY: string;
-};
-export declare const DEFAULT_RENDERER_REDUX_STATE = "{}";
-export declare const DEFAULT_RENDERER_PLURID_STATE = "{}";
-export declare const DEFAULT_RENDERER_VENDOR_SCRIPT_SOURCE = "/vendor.js";
-export declare const DEFAULT_RENDERER_MAIN_SCRIPT_SOURCE = "/index.js";
-export declare const DEFAULT__PRELOADED_REDUX_STATE__ = "__PRELOADED_REDUX_STATE__";
-export declare const DEFAULT__PRELOADED_PLURID_METASTATE__ = "__PRELOADED_PLURID_METASTATE__";
-export declare const DEFAULT_WINDOW_SIZER_SCRIPT = "\n/** PLURID WINDOW SIZER */\nconst pluridRoots = document.querySelectorAll('[data-plurid-entity=\"PluridRoots\"]');\npluridRoots.forEach(pluridRoot => {\n    pluridRoot.style.width = window.innerWidth + 'px';\n    pluridRoot.style.height = window.innerHeight + 'px';\n});\n";
-export declare const NOT_FOUND_ROUTE = "/not-found";
-export declare const environment: {
-    production: boolean;
-    development: boolean;
-};

package/distribution/data/constants/{stiller.d.ts → stiller/index.d.ts}

@@ -1,2 +1,2 @@
-import { PluridStillerOptions } from '../interfaces';
+import { PluridStillerOptions } from "../../interfaces";
 export declare const defaultStillerOptions: PluridStillerOptions;

package/distribution/data/interfaces/{external.d.ts → external/index.d.ts}

@@ -1,11 +1,21 @@
 import express from 'express';
 import { Helmet } from 'react-helmet-async';
-import { PluridRoute, PluridPreserve, PluridComponent } from '@plurid/plurid-data';
+import { PluridRoute, PluridRoutePlane, PluridPreserve, IsoMatcherRouteResult } from '@plurid/plurid-data';
+import { PluridReactComponent } from '@plurid/plurid-react';
 export declare type PluridServerMiddleware = (request: express.Request, response: express.Response, next: express.NextFunction) => void;
+export declare type ServerRequest = express.Request & {
+    requestID: string;
+    requestTime: number;
+};
 export declare type DebugLevels = 'none' | 'error' | 'warn' | 'info';
 export interface PluridServerOptions {
     /** To be used for logging. Default `Plurid Server` */
     serverName: string;
+    /**
+     * The hostname of the server exposed to the internet, e.g. `example.com`,
+     * to be used in plurid plane links.
+     */
+    hostname: string;
     /**
      * To log or not to log to the console.
      */
@@ -29,6 +39,10 @@ export interface PluridServerOptions {
      * Name of the directory where the files (server and client) are bundled.
      */
     buildDirectory: string;
+    /**
+     * Name of the directory where the assets files are bundled.
+     */
+    assetsDirectory: string;
     /**
      * Default: `/gateway`.
      */
@@ -51,37 +65,44 @@ export interface PluridServerOptions {
     stiller: PluridStillerOptions;
 }
 export declare type PluridServerPartialOptions = Partial<PluridServerOptions>;
-export declare type PluridServerService = 'Apollo' | 'Redux' | 'Stripe';
-export interface PluridServerServicesData {
-    reduxStore?: any;
-    reduxStoreValue?: any;
-    reduxContext?: any;
-    apolloClient?: any;
-    stripeScript?: string;
+export interface PluridServerService<P = any> {
+    name: string;
+    package: string;
+    provider: string;
+    properties?: P;
 }
 export interface PluridServerConfiguration {
-    routes: PluridRoute[];
-    preserves: PluridPreserve[];
+    routes: PluridRoute<PluridReactComponent>[];
+    planes?: PluridRoutePlane<PluridReactComponent>[];
+    preserves: PluridPreserveReact[];
     helmet: Helmet;
     styles?: string[];
     middleware?: PluridServerMiddleware[];
-    exterior?: PluridComponent;
-    shell?: PluridComponent;
+    exterior?: PluridReactComponent;
+    shell?: PluridReactComponent;
+    /**
+     * Replace the internal plurid plane with a custom implementation.
+     */
+    customPlane?: PluridReactComponent;
     /**
      * Services to be handled by the server.
      *
      * Supported: `GraphQL`, `Redux`, `Stripe`.
      */
     services?: PluridServerService[];
-    servicesData?: PluridServerServicesData;
     options?: PluridServerPartialOptions;
     template?: PluridServerTemplateConfiguration;
+    usePTTP?: boolean;
+    pttpHandler?: PTTPHandler;
+    elementqlEndpoint?: string;
 }
+export declare type PTTPHandler = (path: string) => Promise<boolean>;
 export interface PluridServerTemplateConfiguration {
     htmlLanguage?: string;
     htmlAttributes?: Record<string, string>;
     defaultStyle?: string;
-    headScripts?: string;
+    headScripts?: string[];
+    bodyScripts?: string[];
     /**
      * The JavaScript vendor filepath to inject in the HTML template.
      * Default `'/vendor.js'`.
@@ -98,13 +119,6 @@ export interface PluridServerTemplateConfiguration {
      * The ID of the root element in the HTML template.
      */
     root?: string;
-    /**
-     * Global variable name to be attached to window on the server-side
-     * to preload redux state.
-     *
-     * Default: `__PRELOADED_REDUX_STATE__`
-     */
-    defaultPreloadedReduxState?: string;
     /**
      * Global variable name to be attached to window on the server-side
      * to preload plurid metastate.
@@ -112,13 +126,6 @@ export interface PluridServerTemplateConfiguration {
      * Default: `__PRELOADED_PLURID_METASTATE__`
      */
     defaultPreloadedPluridMetastate?: string;
-    /**
-     * JavaScript code to handle plurid space window resizing on the client.
-     *
-     * Default https://manual.plurid.com/plurid/server/window-sizer-script
-     */
-    windowSizerScript?: string;
-    bodyScripts?: string;
 }
 export interface PluridStillerOptions {
     /**
@@ -138,3 +145,7 @@ export interface PluridStillerOptions {
      */
     ignore: string[];
 }
+export declare type PluridPreserveReact = PluridPreserve<IsoMatcherRouteResult<PluridReactComponent<any>> | undefined, express.Request, express.Response>;
+export interface PluridLiveServerOptions {
+    server: string;
+}

package/distribution/data/interfaces/{internal.d.ts → internal/index.d.ts}

@@ -1,26 +1,24 @@
 import { Helmet } from 'react-helmet-async';
 import { ServerStyleSheet } from 'styled-components';
-import { Indexed, PluridRoute, PluridComponent } from '@plurid/plurid-data';
-import { router } from '@plurid/plurid-engine';
-import { PluridServerService, PluridServerServicesData, PluridStillerOptions } from './external';
+import { Indexed, PluridRoute, PluridRoutePlane, PluridPreserveResponse } from '@plurid/plurid-data';
+import { PluridReactComponent } from '@plurid/plurid-react';
+import { PluridServerService, PluridStillerOptions } from '../external';
 export interface PluridRendererConfiguration {
     htmlLanguage: string | undefined;
-    htmlAttributes: Record<string, string> | undefined;
+    htmlAttributes: string;
     head: string;
     defaultStyle: string | undefined;
     styles: string;
-    headScripts: string | undefined;
+    headScripts: string[];
+    bodyScripts: string[];
     vendorScriptSource: string | undefined;
     mainScriptSource: string | undefined;
     bodyAttributes: string | undefined;
     root: string | undefined;
     content: string;
-    windowSizerScript: string | undefined;
-    defaultPreloadedReduxState: string | undefined;
-    reduxState: string;
     defaultPreloadedPluridMetastate: string | undefined;
     pluridMetastate: string;
-    bodyScripts: string | undefined;
+    globals: Record<string, string> | undefined;
 }
 export interface StillerOptions {
     host: string;
@@ -49,18 +47,20 @@ export interface StillsGeneratorOptions {
 }
 export interface PluridContentGeneratorData {
     services: PluridServerService[];
-    servicesData: PluridServerServicesData | undefined;
     stylesheet: ServerStyleSheet;
     helmet: Helmet;
-    exterior: PluridComponent | undefined;
-    shell: PluridComponent | undefined;
-    matchedRoute: router.MatcherResponse;
-    routes: PluridRoute[];
+    exterior: PluridReactComponent | undefined;
+    shell: PluridReactComponent | undefined;
+    routes: PluridRoute<PluridReactComponent>[];
+    planes: PluridRoutePlane<PluridReactComponent>[];
     pluridMetastate: any;
     gateway: boolean;
     gatewayEndpoint: string;
     gatewayQuery: string;
-    preserveResult: any;
+    preserveResult: PluridPreserveResponse | undefined;
+    matchedPlane: any;
+    pathname: string;
+    hostname: string;
 }
 export interface RendererTemplateData {
     htmlLanguage: string;
@@ -68,16 +68,14 @@ export interface RendererTemplateData {
     head: string;
     defaultStyle: string;
     styles: string;
-    headScripts: string;
+    headScripts: string[];
+    bodyScripts: string[];
     vendorScriptSource: string;
     mainScriptSource: string;
     bodyAttributes: string;
     root: string;
     content: string;
-    windowSizerScript: string;
-    defaultPreloadedReduxState: string;
-    reduxState: string;
     defaultPreloadedPluridMetastate: string;
     pluridMetastate: string;
-    bodyScripts: string;
+    globals: Record<string, string>;
 }

package/distribution/data/templates/index.d.ts

@@ -1 +1,2 @@
 export declare const NOT_FOUND_TEMPLATE: string;
+export declare const SERVER_ERROR_TEMPLATE: string;

package/distribution/index.d.ts

@@ -1,5 +1,6 @@
 import PluridServer from './objects/Server';
+import PluridLiveServer from './objects/LiveServer';
 import PluridStillsGenerator from './objects/StillsGenerator';
-export * from './data/interfaces';
-export { PluridStillsGenerator, };
+export * from './data/interfaces/external';
+export { PluridLiveServer, PluridStillsGenerator, };
 export default PluridServer;