@shuvi/platform-shared 1.0.0-rc.14 → 1.0.0-rc.17

package/esm/shared/application.d.ts

@@ -1,15 +1,17 @@
 import { IRouter, IPageRouteRecord } from './routerTypes';
-import { RedoxStore, IApplication, IAppContext, IApplicationOptions, IRerenderConfig, IError } from './applicationTypes';
-export declare class Application {
+import { RedoxStore, Application, IAppContext, ApplicationOptions, IRerenderConfig, IError } from './applicationTypes';
+export declare class ApplicationImpl<Config extends {} = {}> {
     private _router;
     private _appComponent;
     private _pluginManager;
     private _context;
+    private _config;
     private _store;
     private _error;
     private _loader;
-    constructor(options: IApplicationOptions);
+    constructor(options: ApplicationOptions<Config>);
     get router(): IRouter<IPageRouteRecord>;
+    get config(): Config;
     get context(): IAppContext;
     get pluginManager(): import("@shuvi/hook").HookManager<import("./runtimPlugin").RuntimePluginHooks, void>;
     get appComponent(): any;
@@ -25,5 +27,5 @@ export declare class Application {
     private _initPlugin;
     private _initAppContext;
     private _initAppComponent;
-    getPublicAPI(): IApplication;
+    getPublicAPI(): Application<Config>;
 }

package/esm/shared/application.js

@@ -12,8 +12,9 @@ import { initPlugins } from './runtimPlugin';
 import { redox } from '@shuvi/redox';
 import { errorModel } from './models/error';
 import { loaderModel } from './models/loader';
-export class Application {
+export class ApplicationImpl {
     constructor(options) {
+        this._config = options.config;
         this._router = options.router;
         this._context = {};
         this._store = redox({ initialState: options.initialState });
@@ -26,6 +27,9 @@ export class Application {
     get router() {
         return this._router;
     }
+    get config() {
+        return this._config;
+    }
     get context() {
         return this._context;
     }
@@ -92,10 +96,21 @@ export class Application {
     getPublicAPI() {
         const self = this;
         return {
-            context: self._context,
-            router: self._router,
-            appComponent: self._appComponent,
-            store: self._store,
+            get config() {
+                return self._config;
+            },
+            get context() {
+                return self._context;
+            },
+            get router() {
+                return self._router;
+            },
+            get appComponent() {
+                return self._appComponent;
+            },
+            get store() {
+                return self._store;
+            },
             get error() {
                 return self.error;
             },

package/esm/shared/applicationTypes.d.ts

@@ -23,7 +23,8 @@ export interface IErrorState {
 export declare type IAppState = {
     error?: IErrorState;
 };
-export interface IApplication {
+export interface Application<Config extends {} = {}> {
+    readonly config: Config;
     readonly context: IAppContext;
     readonly router: IRouter<IPageRouteRecord>;
     readonly appComponent: any;
@@ -34,7 +35,8 @@ export interface IApplication {
     getLoadersData(): Record<string, any>;
     setLoadersData(datas: Record<string, any>): void;
 }
-export interface IApplicationOptions {
+export interface ApplicationOptions<C extends {}> {
+    config: C;
     router: IRouter;
     AppComponent: any;
     initialState?: IAppState;

package/esm/shared/index.d.ts

@@ -6,6 +6,6 @@ export * from './loader';
 export { errorModel } from './models/error';
 export { loaderModel } from './models/loader';
 export * from './applicationTypes';
-export type { Application } from './application';
+export type { ApplicationImpl } from './application';
 export type { IRuntimeConfig } from './runtimeConfigTypes';
 export { IAppModule, IPluginInstance, BuiltInRuntimePluginHooks, CustomRuntimePluginHooks, RuntimePluginHooks, createRuntimePlugin, createRuntimePluginBefore, createRuntimePluginAfter, RuntimePluginInstance } from './runtimPlugin';

package/esm/shared/shuvi-singleton-runtimeConfig.d.ts

@@ -2,11 +2,12 @@ import { IRuntimeConfig } from './runtimeConfigTypes';
 /**
  * getRuntimeConfig function
  *
- * @returns runtimeConfig
+ * @returns serverRuntimeConfig
  */
 export declare function getRuntimeConfig(): {
     [x: string]: string;
 };
-export declare function getPublicRuntimeConfig(): IRuntimeConfig | null;
-export declare function setRuntimeConfig(config: IRuntimeConfig): void;
-export declare function setPublicRuntimeConfig(config: IRuntimeConfig): void;
+export declare function getPublicRuntimeConfig(): IRuntimeConfig | undefined | null;
+export declare function setPublicRuntimeConfig(config: IRuntimeConfig | null): void;
+export declare function getServerRuntimeConfig(): IRuntimeConfig | undefined | null;
+export declare function setServerRuntimeConfig(config: IRuntimeConfig | null): void;

package/esm/shared/shuvi-singleton-runtimeConfig.js

@@ -1,19 +1,49 @@
-let runtimeConfig;
+const isServer = typeof window === 'undefined';
+/**
+ * use global this to store runtime config, so we can safely bundle this module
+ * and get rid of the multiple-module-instance problem.
+ * */
+const KEY_SERVER_RUNTIME_CONFIG = Symbol.for('shuvi_server_runtime_config');
+const KEY_PUBLIC_RUNTIME_CONFIG = Symbol.for('shuvi_client_runtime_config');
 let publicRuntimeConfig;
+let serverRuntimeConfig;
 /**
  * getRuntimeConfig function
  *
- * @returns runtimeConfig
+ * @returns serverRuntimeConfig
  */
 export function getRuntimeConfig() {
-    return Object.assign(Object.assign({}, (runtimeConfig || {})), (publicRuntimeConfig || {}));
+    return Object.assign(Object.assign({}, (getServerRuntimeConfig() || {})), (getPublicRuntimeConfig() || {}));
 }
 export function getPublicRuntimeConfig() {
-    return publicRuntimeConfig;
-}
-export function setRuntimeConfig(config) {
-    runtimeConfig = config;
+    if (isServer) {
+        return globalThis[KEY_PUBLIC_RUNTIME_CONFIG];
+    }
+    else {
+        return publicRuntimeConfig;
+    }
 }
 export function setPublicRuntimeConfig(config) {
-    publicRuntimeConfig = config;
+    if (isServer) {
+        globalThis[KEY_PUBLIC_RUNTIME_CONFIG] = config;
+    }
+    else {
+        publicRuntimeConfig = config;
+    }
+}
+export function getServerRuntimeConfig() {
+    if (isServer) {
+        return globalThis[KEY_SERVER_RUNTIME_CONFIG];
+    }
+    else {
+        return serverRuntimeConfig;
+    }
+}
+export function setServerRuntimeConfig(config) {
+    if (isServer) {
+        globalThis[KEY_SERVER_RUNTIME_CONFIG] = config;
+    }
+    else {
+        serverRuntimeConfig = config;
+    }
 }

package/esm/shuvi-app/application.d.ts

@@ -1,4 +1,4 @@
-import { Application } from '../shared/application';
-import { IApplicationOptions } from './shared';
-export { Application };
-export default function application(options: IApplicationOptions): Application;
+import { ApplicationImpl } from '../shared/application';
+import { ApplicationOptions } from './shared';
+export { ApplicationImpl };
+export default function application<C extends {}>(options: ApplicationOptions<C>): ApplicationImpl<C>;

package/esm/shuvi-app/application.js

@@ -1,8 +1,8 @@
 import * as customApp from '@shuvi/app/user/app';
 import { pluginRecord } from '@shuvi/app/core/plugins';
-import { Application } from '../shared/application';
+import { ApplicationImpl } from '../shared/application';
 import { createRuntimePlugin } from './shared';
-export { Application };
+export { ApplicationImpl };
 function getPlugins(runtime, pluginRecords) {
     const plugins = [];
     const keys = Object.keys(pluginRecords);
@@ -29,6 +29,6 @@ function getPlugins(runtime, pluginRecords) {
     return plugins;
 }
 export default function application(options) {
-    const application = new Application(Object.assign(Object.assign({}, options), { plugins: getPlugins(customApp, pluginRecord) }));
+    const application = new ApplicationImpl(Object.assign(Object.assign({}, options), { plugins: getPlugins(customApp, pluginRecord) }));
     return application;
 }

package/lib/node/platform/plugins/main/index.js

@@ -9,9 +9,6 @@ const core = (0, service_1.createPlugin)({
     },
     addRuntimeService: () => [
         {
-            // must be export separately, we need the module path to always be the
-            // same as what we've defined in
-            // "packages/toolpack/src/webpack/config/parts/external.ts"
             source: (0, paths_1.resolvePkgFile)('lib/shared/shuvi-singleton-runtimeConfig'),
             exported: '{ getRuntimeConfig }'
         },

package/lib/node/platform/runtimeFiles.js

@@ -36,12 +36,8 @@ const getPresetRuntimeFilesCreator = (platformModule) => (pluginContext) => __aw
             break;
         }
     }
-    if (serverKeys) {
-        (0, shuvi_singleton_runtimeConfig_1.setRuntimeConfig)(serverRuntimeConfig);
-    }
-    if (publicKeys) {
-        (0, shuvi_singleton_runtimeConfig_1.setPublicRuntimeConfig)(publicRuntimeConfig);
-    }
+    (0, shuvi_singleton_runtimeConfig_1.setServerRuntimeConfig)(serverKeys ? serverRuntimeConfig : null);
+    (0, shuvi_singleton_runtimeConfig_1.setPublicRuntimeConfig)(publicKeys ? publicRuntimeConfig : null);
     const context = (0, projectContext_1.createProjectContext)();
     context.userModule = {
         error: getCandidates('error', 'nullish'),

package/lib/node/project/file-presets/files/app/core/setRuntimeConfig.js.js

@@ -3,5 +3,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const __1 = require("../../..");
 const paths_1 = require("../../../../../paths");
 exports.default = () => (0, __1.defineFile)({
-    content: () => `export { setRuntimeConfig as default } from '${(0, paths_1.resolvePkgFile)('lib/shared/shuvi-singleton-runtimeConfig')}'`
+    content: () => `export { setPublicRuntimeConfig as default } from '${(0, paths_1.resolvePkgFile)('lib/shared/shuvi-singleton-runtimeConfig')}'`
 });

package/lib/shared/application.d.ts

@@ -1,15 +1,17 @@
 import { IRouter, IPageRouteRecord } from './routerTypes';
-import { RedoxStore, IApplication, IAppContext, IApplicationOptions, IRerenderConfig, IError } from './applicationTypes';
-export declare class Application {
+import { RedoxStore, Application, IAppContext, ApplicationOptions, IRerenderConfig, IError } from './applicationTypes';
+export declare class ApplicationImpl<Config extends {} = {}> {
     private _router;
     private _appComponent;
     private _pluginManager;
     private _context;
+    private _config;
     private _store;
     private _error;
     private _loader;
-    constructor(options: IApplicationOptions);
+    constructor(options: ApplicationOptions<Config>);
     get router(): IRouter<IPageRouteRecord>;
+    get config(): Config;
     get context(): IAppContext;
     get pluginManager(): import("@shuvi/hook").HookManager<import("./runtimPlugin").RuntimePluginHooks, void>;
     get appComponent(): any;
@@ -25,5 +27,5 @@ export declare class Application {
     private _initPlugin;
     private _initAppContext;
     private _initAppComponent;
-    getPublicAPI(): IApplication;
+    getPublicAPI(): Application<Config>;
 }

package/lib/shared/application.js

@@ -9,14 +9,15 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Application = void 0;
+exports.ApplicationImpl = void 0;
 const runtimPlugin_1 = require("./runtimPlugin");
 const runtimPlugin_2 = require("./runtimPlugin");
 const redox_1 = require("@shuvi/redox");
 const error_1 = require("./models/error");
 const loader_1 = require("./models/loader");
-class Application {
+class ApplicationImpl {
     constructor(options) {
+        this._config = options.config;
         this._router = options.router;
         this._context = {};
         this._store = (0, redox_1.redox)({ initialState: options.initialState });
@@ -29,6 +30,9 @@ class Application {
     get router() {
         return this._router;
     }
+    get config() {
+        return this._config;
+    }
     get context() {
         return this._context;
     }
@@ -95,10 +99,21 @@ class Application {
     getPublicAPI() {
         const self = this;
         return {
-            context: self._context,
-            router: self._router,
-            appComponent: self._appComponent,
-            store: self._store,
+            get config() {
+                return self._config;
+            },
+            get context() {
+                return self._context;
+            },
+            get router() {
+                return self._router;
+            },
+            get appComponent() {
+                return self._appComponent;
+            },
+            get store() {
+                return self._store;
+            },
             get error() {
                 return self.error;
             },
@@ -117,4 +132,4 @@ class Application {
         };
     }
 }
-exports.Application = Application;
+exports.ApplicationImpl = ApplicationImpl;

package/lib/shared/applicationTypes.d.ts

@@ -23,7 +23,8 @@ export interface IErrorState {
 export declare type IAppState = {
     error?: IErrorState;
 };
-export interface IApplication {
+export interface Application<Config extends {} = {}> {
+    readonly config: Config;
     readonly context: IAppContext;
     readonly router: IRouter<IPageRouteRecord>;
     readonly appComponent: any;
@@ -34,7 +35,8 @@ export interface IApplication {
     getLoadersData(): Record<string, any>;
     setLoadersData(datas: Record<string, any>): void;
 }
-export interface IApplicationOptions {
+export interface ApplicationOptions<C extends {}> {
+    config: C;
     router: IRouter;
     AppComponent: any;
     initialState?: IAppState;

package/lib/shared/index.d.ts

@@ -6,6 +6,6 @@ export * from './loader';
 export { errorModel } from './models/error';
 export { loaderModel } from './models/loader';
 export * from './applicationTypes';
-export type { Application } from './application';
+export type { ApplicationImpl } from './application';
 export type { IRuntimeConfig } from './runtimeConfigTypes';
 export { IAppModule, IPluginInstance, BuiltInRuntimePluginHooks, CustomRuntimePluginHooks, RuntimePluginHooks, createRuntimePlugin, createRuntimePluginBefore, createRuntimePluginAfter, RuntimePluginInstance } from './runtimPlugin';

package/lib/shared/shuvi-singleton-runtimeConfig.d.ts

@@ -2,11 +2,12 @@ import { IRuntimeConfig } from './runtimeConfigTypes';
 /**
  * getRuntimeConfig function
  *
- * @returns runtimeConfig
+ * @returns serverRuntimeConfig
  */
 export declare function getRuntimeConfig(): {
     [x: string]: string;
 };
-export declare function getPublicRuntimeConfig(): IRuntimeConfig | null;
-export declare function setRuntimeConfig(config: IRuntimeConfig): void;
-export declare function setPublicRuntimeConfig(config: IRuntimeConfig): void;
+export declare function getPublicRuntimeConfig(): IRuntimeConfig | undefined | null;
+export declare function setPublicRuntimeConfig(config: IRuntimeConfig | null): void;
+export declare function getServerRuntimeConfig(): IRuntimeConfig | undefined | null;
+export declare function setServerRuntimeConfig(config: IRuntimeConfig | null): void;

package/lib/shared/shuvi-singleton-runtimeConfig.js

@@ -1,26 +1,57 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setPublicRuntimeConfig = exports.setRuntimeConfig = exports.getPublicRuntimeConfig = exports.getRuntimeConfig = void 0;
-let runtimeConfig;
+exports.setServerRuntimeConfig = exports.getServerRuntimeConfig = exports.setPublicRuntimeConfig = exports.getPublicRuntimeConfig = exports.getRuntimeConfig = void 0;
+const isServer = typeof window === 'undefined';
+/**
+ * use global this to store runtime config, so we can safely bundle this module
+ * and get rid of the multiple-module-instance problem.
+ * */
+const KEY_SERVER_RUNTIME_CONFIG = Symbol.for('shuvi_server_runtime_config');
+const KEY_PUBLIC_RUNTIME_CONFIG = Symbol.for('shuvi_client_runtime_config');
 let publicRuntimeConfig;
+let serverRuntimeConfig;
 /**
  * getRuntimeConfig function
  *
- * @returns runtimeConfig
+ * @returns serverRuntimeConfig
  */
 function getRuntimeConfig() {
-    return Object.assign(Object.assign({}, (runtimeConfig || {})), (publicRuntimeConfig || {}));
+    return Object.assign(Object.assign({}, (getServerRuntimeConfig() || {})), (getPublicRuntimeConfig() || {}));
 }
 exports.getRuntimeConfig = getRuntimeConfig;
 function getPublicRuntimeConfig() {
-    return publicRuntimeConfig;
+    if (isServer) {
+        return globalThis[KEY_PUBLIC_RUNTIME_CONFIG];
+    }
+    else {
+        return publicRuntimeConfig;
+    }
 }
 exports.getPublicRuntimeConfig = getPublicRuntimeConfig;
-function setRuntimeConfig(config) {
-    runtimeConfig = config;
-}
-exports.setRuntimeConfig = setRuntimeConfig;
 function setPublicRuntimeConfig(config) {
-    publicRuntimeConfig = config;
+    if (isServer) {
+        globalThis[KEY_PUBLIC_RUNTIME_CONFIG] = config;
+    }
+    else {
+        publicRuntimeConfig = config;
+    }
 }
 exports.setPublicRuntimeConfig = setPublicRuntimeConfig;
+function getServerRuntimeConfig() {
+    if (isServer) {
+        return globalThis[KEY_SERVER_RUNTIME_CONFIG];
+    }
+    else {
+        return serverRuntimeConfig;
+    }
+}
+exports.getServerRuntimeConfig = getServerRuntimeConfig;
+function setServerRuntimeConfig(config) {
+    if (isServer) {
+        globalThis[KEY_SERVER_RUNTIME_CONFIG] = config;
+    }
+    else {
+        serverRuntimeConfig = config;
+    }
+}
+exports.setServerRuntimeConfig = setServerRuntimeConfig;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shuvi/platform-shared",
-  "version": "1.0.0-rc.14",
+  "version": "1.0.0-rc.17",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/shuvijs/shuvi.git",
@@ -83,18 +83,18 @@
     "node": ">= 12.0.0"
   },
   "dependencies": {
-    "@shuvi/hook": "1.0.0-rc.14",
+    "@shuvi/hook": "1.0.0-rc.17",
     "@shuvi/redox": "0.0.6",
-    "@shuvi/router": "1.0.0-rc.14",
-    "@shuvi/runtime": "1.0.0-rc.14",
-    "@shuvi/service": "1.0.0-rc.14",
-    "@shuvi/shared": "1.0.0-rc.14",
-    "@shuvi/toolpack": "1.0.0-rc.14",
-    "@shuvi/utils": "1.0.0-rc.14",
+    "@shuvi/router": "1.0.0-rc.17",
+    "@shuvi/runtime": "1.0.0-rc.17",
+    "@shuvi/service": "1.0.0-rc.17",
+    "@shuvi/shared": "1.0.0-rc.17",
+    "@shuvi/toolpack": "1.0.0-rc.17",
+    "@shuvi/utils": "1.0.0-rc.17",
     "redux": "4.1.2"
   },
   "peerDependencies": {
-    "@shuvi/service": "1.0.0-rc.14"
+    "@shuvi/service": "1.0.0-rc.17"
   },
   "devDependencies": {
     "@types/minimatch": "3.0.5"

package/shuvi-type-extensions-runtime.d.ts

@@ -35,11 +35,6 @@ declare module '@shuvi/app/core/setRuntimeConfig' {
   export default function setRuntimeConfig(config: IRuntimeConfig): void;
 }
 
-declare module '@shuvi/app/core/setPublicRuntimeConfig' {
-  import { IRuntimeConfig } from '@shuvi/platform-shared/shared';
-  export default function setPublicRuntimeConfig(config: IRuntimeConfig): void;
-}
-
 declare module '@shuvi/app/user/error' {
   const Error: any;
   export default Error;

package/lib/node/project/file-presets/files/app/core/setPublicRuntimeConfig.js.d.ts

@@ -1,2 +0,0 @@
-declare const _default: () => Omit<import("@shuvi/service/lib/project/index").FileOptionWithoutId<string, any>, "name">;
-export default _default;

package/lib/node/project/file-presets/files/app/core/setPublicRuntimeConfig.js.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const __1 = require("../../..");
-const paths_1 = require("../../../../../paths");
-exports.default = () => (0, __1.defineFile)({
-    content: () => `export { setPublicRuntimeConfig as default } from '${(0, paths_1.resolvePkgFile)('lib/shared/shuvi-singleton-runtimeConfig')}'`
-});