catalyst-core 0.0.1-beta.2

package/server/utils/validator.js

@@ -0,0 +1,98 @@
+"use strict";
+
+const pc = require("picocolors");
+const handleError = e => {
+  console.log(pc.red("Failed to start server: "), e);
+};
+const validatePreInitServer = fn => {
+  try {
+    if (!fn) throw new Error("preServerInit named function should be defined in server/index.js");
+    if (typeof fn !== 'function') throw new Error("preServerInit should be function present in server/index.js");
+    return true;
+  } catch (e) {
+    handleError(e);
+  }
+};
+const validateMiddleware = fn => {
+  try {
+    if (!fn) throw new Error("addMiddlewares named function not found in server/server.js");
+    if (typeof fn !== 'function') throw new Error("addMiddlewares should be function present in server/server.js");
+    return true;
+  } catch (e) {
+    handleError(e);
+  }
+};
+const validateReducerFunction = fn => {
+  try {
+    if (!fn) throw new Error("reducer not found in src/js/containers/App/reducer");
+    if (typeof fn !== 'function') throw new Error("reducer should present in src/js/containers/App/reducer");
+    return true;
+  } catch (e) {
+    handleError(e);
+  }
+};
+const validateConfigFile = obj => {
+  try {
+    if (!obj) throw new Error("config not found in config folder");
+    if (typeof obj !== 'object') throw new Error("config object should be exported from config folder inside your project root directory");
+    return true;
+  } catch (e) {
+    handleError(e);
+  }
+};
+const validatePackageJson = obj => {
+  try {
+    if (!obj) throw new Error("package.json not found in the project");
+    if (typeof obj !== 'object') throw new Error("package.json should be defined in project root directory");
+    return true;
+  } catch (e) {
+    handleError(e);
+  }
+};
+const validateModuleAlias = obj => {
+  try {
+    if (!obj) throw new Error("moduleAliases not found in package.json file present in root directory.");
+    if (typeof obj !== 'object') throw new Error("moduleAliases named object should be exported from package.json");
+    return true;
+  } catch (e) {
+    handleError(e);
+  }
+};
+const validateConfigureStore = fn => {
+  try {
+    if (!fn) throw new Error("configureStore not found in file src/js/store/index.js");
+    if (typeof fn !== 'function') throw new Error("configureStore should be function exported from src/js/store/index.js");
+    return true;
+  } catch (e) {
+    handleError(e);
+  }
+};
+const validateGetRoutes = fn => {
+  try {
+    if (!fn) throw new Error("getRoutes not found in file src/js/routers/index.js");
+    if (typeof fn !== 'function') throw new Error("getRoutes should be function exported from src/js/routers/index.js");
+    return true;
+  } catch (e) {
+    handleError(e);
+  }
+};
+const validateCustomDocument = fn => {
+  try {
+    if (!fn) throw new Error("document not found in file server/document.js");
+    if (typeof fn !== 'function') throw new Error("document should be a react component exported from server/document.js");
+    return true;
+  } catch (e) {
+    handleError(e);
+  }
+};
+module.exports = {
+  validateConfigFile,
+  validateConfigureStore,
+  validateCustomDocument,
+  validateGetRoutes,
+  validatePackageJson,
+  validateReducerFunction,
+  validateModuleAlias,
+  validatePreInitServer,
+  validateMiddleware
+};

package/store/index.dev.js

@@ -0,0 +1,73 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = configureStore;
+var _redux = require("redux");
+var _reduxThunk = _interopRequireDefault(require("redux-thunk"));
+var _reduxLogger = require("redux-logger");
+var _index = _interopRequireDefault(require("../reducer/index.js"));
+var _api = require("@lib/api.js");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+/**
+ * Function that initializes the store with the initialstate and adds middlewares that can be used during action dispatch
+ * @param    {object} initialState    Default state
+ * @param    {object} cookies    additional headers if needed
+ * @param    {object} requestObj    additional information
+ * @return   {object}         the store itself
+ */
+function configureStore(initialState, cookies, requestObj, customHeaders) {
+  // The variable defined below acts as a flag when the store is initialized on the client side
+  // Reason being that for the first time we need to actually need to forcefully set the reducer for which we have the initial data
+  let initializeClient = true;
+  const reducerManager = (0, _index.default)();
+  const api = (0, _api.directAxiosInstance)(cookies, requestObj, customHeaders);
+  const labsApi = (0, _api.labsAxiosInstance)(cookies, requestObj, customHeaders);
+
+  // FRAMEWORK COMMENT. This should be exposed to user.
+
+  // disable redux-logger in server - https://github.com/LogRocket/redux-logger/issues/6
+  const reduxLogger = (0, _reduxLogger.createLogger)({
+    predicate: () => typeof window !== "undefined"
+  });
+  const addReducer = reducer => {
+    // Only executed once when for the first run in client - side
+    if (initializeClient) {
+      initializeClient = false;
+      return store.replaceReducer(reducerManager.add(reducer));
+    }
+
+    // This blocks check if the reducer is already added or not in store
+    // If not then it only add the missing reducers
+    // And if the required reducers are already present then we simply return without performing any change
+    let reducerToAdd = {};
+    const currentState = store.getState();
+    for (let key in reducer) {
+      if (!currentState[key]) {
+        reducerToAdd[key] = reducer[key];
+      }
+    }
+    if (Object.keys(reducerToAdd).length > 0) {
+      return store.replaceReducer(reducerManager.add(reducerToAdd));
+    }
+    return;
+  };
+  let middleware = [_reduxThunk.default.withExtraArgument({
+    addReducer,
+    api,
+    labsApi
+  }), reduxLogger];
+
+  // Add universal enhancers here
+  let enhancers = [];
+  const composeEnhancers = typeof window !== "undefined" && window.__REDUX_DEVTOOLS_EXTENSION_COMPOSE__ || _redux.compose;
+  const enhancer = composeEnhancers(...[(0, _redux.applyMiddleware)(...middleware), ...enhancers]);
+
+  // create store with enhancers, middleware, reducers, and initialState
+  // When the store is initialized on the client side, we are passing a function that just returns the initial State from the server
+  // This is way we are able to maintain the initial state from the server on the client side and then add the relevant reducers
+  // Which then consumes the initial state
+  const store = (0, _redux.createStore)(Object.keys(initialState).length === 0 ? reducerManager.getReducerMap() : () => initialState, initialState, enhancer);
+  return store;
+}

package/store/index.js

@@ -0,0 +1,25 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _indexProd = _interopRequireDefault(require("./index.prod.js"));
+var _indexDev = _interopRequireDefault(require("./index.dev.js"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+/**
+ * Function that initializes the store with the initialstate and adds middlewares that can be used during action dispatch
+ * It returns different store based on NODE_ENV for eg: production store and development store.
+ * @param {object} initialState    Default state
+ * @param {object} cookies    additional headers if needed
+ * @param {object} requestObj    additional information
+ * @param {object} customHeaders   custom headers which needs to be used in axios instance
+ * @return {object} redux configured store
+ */
+const configureStore = (initialState, cookies, requestObj, customHeaders) => {
+  if (process.env.NODE_ENV === "production") {
+    return (0, _indexProd.default)(initialState, cookies, requestObj, customHeaders);
+  }
+  return (0, _indexDev.default)(initialState, cookies, requestObj, customHeaders);
+};
+var _default = exports.default = configureStore;

package/store/index.prod.js

@@ -0,0 +1,66 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = configureStore;
+var _redux = require("redux");
+var _reduxThunk = _interopRequireDefault(require("redux-thunk"));
+var _index = _interopRequireDefault(require("../reducer/index.js"));
+var _api = require("@lib/api.js");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+/**
+ * Function that initializes the store with the initialstate and adds middlewares that can be used during action dispatch
+ * @param    {object} initialState    Default state
+ * @param    {object} cookies    additional headers if needed
+ * @param    {object} requestObj    additional information
+ * @return   {object}         the store itself
+ */
+function configureStore(initialState, cookies, requestObj, customHeaders) {
+  // The variable defined below acts as a flag when the store is initialized on the client side
+  // Reason being that for the first time we need to actually need to forcefully set the reducer for which we have the initial data
+  let initializeClient = true;
+  const reducerManager = (0, _index.default)();
+  // FRAMEWORK COMMENT. This should be exposed to user.
+  const api = (0, _api.directAxiosInstance)(cookies, requestObj, customHeaders);
+  const labsApi = (0, _api.labsAxiosInstance)(cookies, requestObj, customHeaders);
+  const addReducer = reducer => {
+    // Only executed once when for the first run in client - side
+    if (initializeClient) {
+      initializeClient = false;
+      return store.replaceReducer(reducerManager.add(reducer));
+    }
+
+    // This blocks check if the reducer is already added or not in store
+    // If not then it only add the missing reducers
+    // And if the required reducers are already present then we simply return without performing any change
+    let reducerToAdd = {};
+    const currentState = store.getState();
+    for (let key in reducer) {
+      if (!currentState[key]) {
+        reducerToAdd[key] = reducer[key];
+      }
+    }
+    if (Object.keys(reducerToAdd).length > 0) {
+      return store.replaceReducer(reducerManager.add(reducerToAdd));
+    }
+    return;
+  };
+  // FRAMEWORK COMMENT THIS WILL NOT BE PART OF FRAMEWORK. NEED TO GENERALISE IT
+  let middleware = [_reduxThunk.default.withExtraArgument({
+    api,
+    labsApi,
+    addReducer
+  })];
+
+  // Add universal enhancers here
+  let enhancers = [];
+  const enhancer = (0, _redux.compose)(...[(0, _redux.applyMiddleware)(...middleware), ...enhancers]);
+
+  // create store with enhancers, middleware, reducers, and initialState
+  // When the store is initialized on the client side, we are passing a function that just returns the initial State from the server
+  // This is way we are able to maintain the initial state from the server on the client side and then add the relevant reducers
+  // Which then consumes the initial state
+  const store = (0, _redux.createStore)(Object.keys(initialState).length === 0 ? reducerManager.getReducerMap() : () => initialState, initialState, enhancer);
+  return store;
+}

package/tsconfig.json

@@ -0,0 +1,110 @@
+{
+    "compilerOptions": {
+        /* Visit https://aka.ms/tsconfig to read more about this file */
+
+        /* Projects */
+        // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+        // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+        // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+        // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+        // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+        // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+        /* Language and Environment */
+        "target": "es2016" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
+        // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+        "jsx": "react" /* Specify what JSX code is generated. */,
+        // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
+        // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+        // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+        // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+        // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+        // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+        // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+        // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+        // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+        /* Modules */
+        "module": "commonjs" /* Specify what module code is generated. */,
+        // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+        // "moduleResolution": "node10",                     /* Specify how TypeScript looks up a file from a given module specifier. */
+        // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+        // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+        // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+        // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+        // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+        // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+        // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+        // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
+        // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */
+        // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */
+        // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
+        // "resolveJsonModule": true,                        /* Enable importing .json files. */
+        // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
+        // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+        /* JavaScript Support */
+        "allowJs": true /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */,
+        "checkJs": false /* Enable error reporting in type-checked JavaScript files. */,
+        // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+        /* Emit */
+        "declaration": true /* Generate .d.ts files from TypeScript and JavaScript files in your project. */,
+        // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+        "emitDeclarationOnly": true /* Only output d.ts files and not JavaScript files. */,
+        // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+        // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+        // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+        "outDir": "./types" /* Specify an output folder for all emitted files. */,
+        // "removeComments": true,                           /* Disable emitting comments. */
+        // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+        // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+        // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
+        // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+        // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+        // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+        // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+        // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+        // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+        // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+        // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+        // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+        // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+        // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+        // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+        /* Interop Constraints */
+        // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+        // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
+        // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+        "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
+        // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+        "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
+
+        /* Type Checking */
+        "strict": true /* Enable all strict type-checking options. */,
+        // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+        // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+        // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+        // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+        // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+        // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+        // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+        // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+        // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+        // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+        // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+        // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+        // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+        // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+        // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+        // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+        // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+        // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+        /* Completeness */
+        // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+        "skipLibCheck": true /* Skip type checking all .d.ts files. */
+    },
+    "include": ["src"]
+}

package/types/caching.d.ts

@@ -0,0 +1 @@
+export {};

package/types/config/config.d.ts

@@ -0,0 +1,19 @@
+declare namespace _default {
+    let S3_BUCKET: string;
+    let S3_FOLDER: string;
+    let CDN_ASSET_PATH: string;
+    let APPLICATION_PORT: string;
+    let APPLICATION_BASE_URL: string;
+    let SERVER_PATH: string;
+    let OUTPUT_PATH: string;
+    let PUBLIC_OUTPUT_PATH: string;
+    let PUBLIC_ASSET_PATH: string;
+    let LOCAL_ASSET_PATH: string;
+    let EXTERNAL_BASE_URL: string;
+    let DEV_SERVER_PORT: number;
+    let DEV_SERVER_HOSTNAME: string;
+    let DEV_SERVER_HOST_URL: string;
+    let ENV_NAME: string;
+    let BUILD_ENV: string;
+}
+export default _default;

package/types/index.d.ts

@@ -0,0 +1 @@
+export * from "./server/renderer/document/index";

package/types/logger/index.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @description Logger library with rotational strategy. Creates a logs folder in root.
+ *              With debug, error and info log directories with their respective log files.
+ *
+ * @format Logstash with timestamp
+ * @param config { @enableDebugLogs: Bool // default: true }
+ * @returns loggerInstance
+ *
+ */
+export function configureLogger(config?: any): {
+    debug: () => void;
+    error: (msg: any) => void;
+    info: (msg: any) => void;
+};

package/types/reducer/index.d.ts

@@ -0,0 +1,22 @@
+export default createReducerManager;
+/**
+ * @description A 'Reducer Manager' object, which keeps track of all the registered reducers and exposes a reduce() function. For detailed info :- https://redux.js.org/usage/code-splitting#using-a-reducer-manager
+ */
+declare function createReducerManager(): {
+    getReducerMap: () => import("redux").Reducer<import("redux").CombinedState<{
+        shellReducer: unknown;
+        loadableConfigReducer: never;
+    }>, import("redux").Action<any>>;
+    reduce: (state: any, action: any) => import("redux").CombinedState<{
+        shellReducer: unknown;
+        loadableConfigReducer: never;
+    }>;
+    add: (reducer: any) => import("redux").Reducer<import("redux").CombinedState<{
+        shellReducer: unknown;
+        loadableConfigReducer: never;
+    }>, import("redux").Action<any>> | undefined;
+    remove: (key: any) => import("redux").Reducer<import("redux").CombinedState<{
+        shellReducer: unknown;
+        loadableConfigReducer: never;
+    }>, import("redux").Action<any>> | undefined;
+};

package/types/reducer/loadableConfigReducer.d.ts

@@ -0,0 +1,9 @@
+export default loadableConfigReducer;
+/** loads loadable config reducer
+ * @param {object} defaultState - default state in reducer
+ * @return {object} reducer default state
+*/
+declare function loadableConfigReducer(state?: {
+    SERVER_SIDE_RENDER: boolean;
+    CLIENT_ONLY_RENDER: boolean;
+}): object;

package/types/router/ClientRouter.d.ts

@@ -0,0 +1,5 @@
+export default clientRouter;
+/**
+ * @returns returns browsers routers (client routes)
+*/
+declare function clientRouter(): import("@remix-run/router").Router;

package/types/router/ServerRouter.d.ts

@@ -0,0 +1,7 @@
+export default ServerRouter;
+/**
+ * @description return
+ * @param {object} reduxData - redux data
+ * @returns returns server routes
+*/
+declare function ServerRouter(reduxData: object): import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>> | null;

package/types/router/index.d.ts

@@ -0,0 +1,8 @@
+export function preparedRoutes(): any;
+export default getRoutes;
+/**
+ * @description prepares routes from routes defined inside template.
+ *              Adds path and element key inside each route.
+ * @returns returns routes list after modifiing template routes
+*/
+declare const getRoutes: any;

package/types/router.d.ts

@@ -0,0 +1 @@
+export * from "@tata1mg/router";

package/types/scripts/build.d.ts

@@ -0,0 +1 @@
+export {};

package/types/scripts/loadEnvironmentVariables.d.ts

@@ -0,0 +1,5 @@
+export default loadEnvironmentVariables;
+/**
+ * @description stores all config.json key value into process.env before server starts.
+*/
+declare function loadEnvironmentVariables(): void;

package/types/scripts/loadScriptsBeforeServerStarts.d.ts

@@ -0,0 +1 @@
+export {};

package/types/scripts/prepare.d.ts

@@ -0,0 +1 @@
+export {};

package/types/scripts/registerAliases.d.ts

@@ -0,0 +1 @@
+export {};

package/types/scripts/serve.d.ts

@@ -0,0 +1 @@
+export {};

package/types/scripts/start.d.ts

@@ -0,0 +1 @@
+export {};

package/types/scripts/validator.d.ts

@@ -0,0 +1,9 @@
+export function validatePreInitServer(fn: any): true | undefined;
+export function validateMiddleware(fn: any): true | undefined;
+export function validateReducerFunction(fn: any): true | undefined;
+export function validateConfigFile(obj: any): true | undefined;
+export function validatePackageJson(obj: any): true | undefined;
+export function validateModuleAlias(obj: any): true | undefined;
+export function validateConfigureStore(fn: any): true | undefined;
+export function validateGetRoutes(fn: any): true | undefined;
+export function validateCustomDocument(fn: any): true | undefined;

package/types/scripts/verifyConfig.d.ts

@@ -0,0 +1 @@
+export {};

package/types/server/mainIndex.d.ts

@@ -0,0 +1 @@
+export {};

package/types/server/mainServer.d.ts

@@ -0,0 +1,2 @@
+export default app;
+declare const app: import("express-serve-static-core").Express;

package/types/server/renderer/document/Body.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Body component which will be used in page component
+ * @param {object} initialState - redux store state
+ * @param {object} statusCode - api config present in cache list
+ * @param {object} firstFoldCss - user defined components for meta tags input
+ * @param {object} firstFoldJS - user defined components for meta tags input
+ * @param {object} jsx - user defined components for meta tags input
+ * @param {object} fetcherData - router fetched data
+ */
+export function Body(props: any): React.JSX.Element;
+import React from "react";

package/types/server/renderer/document/Head.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Head component which will be used in page rendering
+ * @param {string} pageCss - includes all styles for page css
+ * @param {object} pageJS - async scripts for loading chunks
+ * @param {function} metaTagFunction - user defined function which returns meta tags in array
+ * @param {boolean} isBot - checks if request is made by bot
+ * @param {string} publicAssetPath - public asset path for assets
+ * @param {object} fetcherData - router fetched data
+ */
+export function Head(props: any): React.JSX.Element;
+import React from "react";

package/types/server/renderer/document/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./Head";
+export * from "./Body";

package/types/server/renderer/extract.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Stores css chunks styles into cache in string format
+ * @param {string} key - router path
+ * @param {object} data - css elements array extracted through loadable chunk extracter
+ */
+export function cacheCSS(key: string, data: object): void;
+/**
+ * Stores javascript into cache
+ * @param {string} key - router path
+ * @param {object} data - js elements array extracted through loadable chunk extracter
+ */
+export function cacheJS(key: string, data: object): void;
+/**
+ * stores css and js in cache
+ * @param {object} res - response object
+ * @param {string} route - route path
+ */
+export default function _default(res: object, route: string): void;

package/types/server/renderer/handler.d.ts

@@ -0,0 +1,6 @@
+/**
+ * middleware for document handling
+ * @param {object} req - router path
+ * @param {object} res - css elements array extracted through loadable chunk extracter
+ */
+export default function _default(req: object, res: object): Promise<void>;

package/types/server/renderer/index.d.ts

@@ -0,0 +1,2 @@
+export default router;
+declare const router: import("express-serve-static-core").Router;

package/types/server/renderer/render.d.ts

@@ -0,0 +1,38 @@
+declare namespace _default {
+    export { renderStart };
+    export { renderEnd };
+}
+export default _default;
+/**
+ * returns data which will be used in head component for page rendering
+ * @param {string} pageCss - includes all styles for page css
+ * @param {string} pageJS - async scripts for loading chunks
+ * @param {function} metaTagFunction - user defined function which returns meta tags in array
+ * @param {boolean} isBot - checks if request is made by bot
+ * @param {object} fetcherData - router fetched data
+ */
+declare function renderStart(pageCss: string, pageJS: string, metaTagFunction: Function, isBot: boolean, fetcherData: object): {
+    pageCss: string;
+    pageJS: string;
+    metaTagFunction: Function;
+    isBot: boolean;
+    publicAssetPath: string;
+    fetcherData: object;
+};
+/**
+ * returns data which will be used in body component for page rendering
+ * @param {object} webExtractor - loadable object which holds chunking function
+ * @param {string} initialState - reducer initial state
+ * @param {function} res - response object
+ * @param {boolean} jsx - jsx which needs to be render on server side
+ * @param {string|number|null} errorCode - error code
+ * @param {object} fetcherData - router fetched data
+ */
+declare function renderEnd(webExtractor: object, initialState: string | undefined, res: Function, jsx: boolean, errorCode: string | number | null, fetcherData: object): {
+    initialState: string;
+    firstFoldCss: string;
+    firstFoldJS: string;
+    jsx: boolean;
+    errorCode: string | number | null;
+    fetcherData: object;
+};

package/types/server/renderer/userAgentUtil.d.ts

@@ -0,0 +1 @@
+export function getUserAgentDetails(ua: string): object;