@plurid/plurid-react-server 0.0.0-15 → 0.0.0-17

package/distribution/data/interfaces/external/index.d.ts

@@ -1,152 +0,0 @@
-import express from 'express';
-import { Helmet } from 'react-helmet-async';
-import { PluridRoute, PluridRoutePlane, PluridPreserve, IsoMatcherRouteResult, PluridRouterProperties } 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.
-     */
-    quiet: boolean;
-    /**
-     * Debug levels.
-     *
-     * Production default: `error`.
-     * Development default: `info` and above.
-     */
-    debug: DebugLevels;
-    /**
-     * Use `gzip` compression for the response. Default `true`.
-     */
-    compression: boolean;
-    /**
-     * Open in browser at start.
-     */
-    open: boolean;
-    /**
-     * 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`.
-     */
-    gatewayEndpoint: string;
-    /**
-     * Provide a `max-age` in milliseconds for http caching of the static serves.
-     * This can also be a string accepted by the `ms` module.
-     *
-     * Default: 0.
-     */
-    staticCache: number | string;
-    /**
-     * Routes to be ignored when serving the application (`GET`).
-     */
-    ignore: string[];
-    /**
-     * Name of the directory where the stills are gathered.
-     */
-    stillsDirectory: string;
-    stiller: PluridStillerOptions;
-}
-export declare type PluridServerPartialOptions = Partial<PluridServerOptions>;
-export interface PluridServerService<P = any, PP = any> {
-    name: string;
-    Provider: P;
-    properties?: PP;
-}
-export interface PluridServerConfiguration {
-    routes: PluridRoute<PluridReactComponent>[];
-    planes?: PluridRoutePlane<PluridReactComponent>[];
-    preserves: PluridPreserveReact[];
-    helmet: Helmet;
-    styles?: string[];
-    middleware?: PluridServerMiddleware[];
-    exterior?: PluridReactComponent;
-    shell?: PluridReactComponent;
-    routerProperties?: Partial<PluridRouterProperties<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[];
-    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[];
-    bodyScripts?: string[];
-    /**
-     * The JavaScript vendor filepath to inject in the HTML template.
-     * Default `'/vendor.js'`.
-     *
-     * A CDN link can be used for better caching.
-     */
-    vendorScriptSource?: string;
-    /**
-     * The JavaScript filename to inject in the HTML template.
-     */
-    mainScriptSource?: string;
-    bodyAttributes?: Record<string, string>;
-    /**
-     * 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 plurid metastate.
-     *
-     * Default: `__PRELOADED_PLURID_METASTATE__`
-     */
-    defaultPreloadedPluridMetastate?: string;
-    minify?: boolean;
-}
-export interface PluridStillerOptions {
-    /**
-     * Recommended: `'networkidle0'` | `'networkidle2'` | `'load'`.
-     *
-     * Default: `'networkidle0'`.
-     */
-    waitUntil: 'load' | 'domcontentloaded' | 'networkidle0' | 'networkidle2';
-    /**
-     * Maximum navigation time in milliseconds, pass 0 to disable timeout.
-     *
-     * Default: 30000.
-     */
-    timeout: number;
-    /**
-     * Routes to be ignored by the stilling process.
-     */
-    ignore: string[];
-}
-export declare type PluridPreserveReact = PluridPreserve<IsoMatcherRouteResult<PluridReactComponent<any>> | undefined, express.Request, express.Response>;
-export interface PluridLiveServerOptions {
-    server: string;
-}

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

@@ -1,2 +0,0 @@
-export * from './external';
-export * from './internal';

package/distribution/data/interfaces/internal/index.d.ts

@@ -1,84 +0,0 @@
-import { Helmet } from 'react-helmet-async';
-import { ServerStyleSheet } from 'styled-components';
-import { Indexed, PluridRoute, PluridRoutePlane, PluridPreserveResponse, PluridRouterProperties } from '@plurid/plurid-data';
-import { PluridReactComponent } from '@plurid/plurid-react';
-import { PluridServerService, PluridStillerOptions } from '../external';
-export interface PluridRendererConfiguration {
-    htmlLanguage: string | undefined;
-    htmlAttributes: string;
-    head: string;
-    defaultStyle: string | undefined;
-    styles: string;
-    headScripts: string[];
-    bodyScripts: string[];
-    vendorScriptSource: string | undefined;
-    mainScriptSource: string | undefined;
-    bodyAttributes: string | undefined;
-    root: string | undefined;
-    content: string;
-    defaultPreloadedPluridMetastate: string | undefined;
-    pluridMetastate: string;
-    globals: Record<string, string> | undefined;
-    minify: boolean | undefined;
-}
-export interface StillerOptions {
-    host: string;
-    routes: string[];
-    configuration: StillerConfiguration;
-}
-export declare type StillerConfiguration = Pick<PluridStillerOptions, 'timeout' | 'waitUntil'>;
-export interface StilledSpace {
-    id: string;
-    html: string;
-    route: string;
-    pages: Indexed<StilledPage>;
-}
-export interface StilledPage {
-    route: string;
-    html: string;
-    stilltime: number;
-}
-export interface StilledMetadataEntry {
-    route: string;
-    name: string;
-}
-export interface StillsGeneratorOptions {
-    server: string;
-    build: string;
-}
-export interface PluridContentGeneratorData {
-    services: PluridServerService[];
-    stylesheet: ServerStyleSheet;
-    helmet: Helmet;
-    exterior: PluridReactComponent | undefined;
-    shell: PluridReactComponent | undefined;
-    routerProperties: Partial<PluridRouterProperties<PluridReactComponent>>;
-    routes: PluridRoute<PluridReactComponent>[];
-    planes: PluridRoutePlane<PluridReactComponent>[];
-    pluridMetastate: any;
-    gateway: boolean;
-    gatewayEndpoint: string;
-    gatewayQuery: string;
-    preserveResult: PluridPreserveResponse | undefined;
-    matchedPlane: any;
-    pathname: string;
-    hostname: string;
-}
-export interface RendererTemplateData {
-    htmlLanguage: string;
-    htmlAttributes: string;
-    head: string;
-    defaultStyle: string;
-    styles: string;
-    headScripts: string[];
-    bodyScripts: string[];
-    vendorScriptSource: string;
-    mainScriptSource: string;
-    bodyAttributes: string;
-    root: string;
-    content: string;
-    defaultPreloadedPluridMetastate: string;
-    pluridMetastate: string;
-    globals: Record<string, string>;
-    minify: boolean;
-}

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

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