@shrub/vue-server 0.5.26

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 jjvainav
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/esm/index.js

@@ -0,0 +1,2 @@
+export * from "./module";
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsY0FBYyxVQUFVLENBQUMifQ==

package/dist/esm/model-service.js

@@ -0,0 +1,28 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import { Singleton } from "@shrub/core";
+import { ModelService } from "@shrub/model";
+import { JSONSerializer } from "@sprig/serialization";
+let ServerModelService = class ServerModelService extends ModelService {
+    get hasModels() {
+        for (const key of Object.keys(this.models)) {
+            // make sure the property has an actual object and not just undefined/null
+            if (this.models[key]) {
+                return true;
+            }
+        }
+        return false;
+    }
+    serialize() {
+        return new JSONSerializer().serialize(this.models);
+    }
+};
+ServerModelService = __decorate([
+    Singleton
+], ServerModelService);
+export { ServerModelService };
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibW9kZWwtc2VydmljZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9tb2RlbC1zZXJ2aWNlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7OztBQUFBLE9BQU8sRUFBRSxTQUFTLEVBQUUsTUFBTSxhQUFhLENBQUM7QUFDeEMsT0FBTyxFQUFFLFlBQVksRUFBRSxNQUFNLGNBQWMsQ0FBQztBQUM1QyxPQUFPLEVBQUUsY0FBYyxFQUFFLE1BQU0sc0JBQXNCLENBQUM7QUFHdEQsSUFBYSxrQkFBa0IsR0FBL0IsTUFBYSxrQkFBbUIsU0FBUSxZQUFZO0lBQ2hELElBQUksU0FBUztRQUNULEtBQUssTUFBTSxHQUFHLElBQUksTUFBTSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDLEVBQUU7WUFDeEMsMEVBQTBFO1lBQzFFLElBQUksSUFBSSxDQUFDLE1BQU0sQ0FBQyxHQUFHLENBQUMsRUFBRTtnQkFDbEIsT0FBTyxJQUFJLENBQUM7YUFDZjtTQUNKO1FBRUQsT0FBTyxLQUFLLENBQUM7SUFDakIsQ0FBQztJQUVELFNBQVM7UUFDTCxPQUFPLElBQUksY0FBYyxFQUFFLENBQUMsU0FBUyxDQUFDLElBQUksQ0FBQyxNQUFNLENBQUMsQ0FBQztJQUN2RCxDQUFDO0NBQ0osQ0FBQTtBQWZZLGtCQUFrQjtJQUQ5QixTQUFTO0dBQ0csa0JBQWtCLENBZTlCO1NBZlksa0JBQWtCIn0=

package/dist/esm/module.js

@@ -0,0 +1,114 @@
+import Vue from "vue";
+import { ModuleLoader } from "@shrub/core";
+import { IModelService, ModelModule } from "@shrub/model";
+import { IVueConfiguration, VueModule } from "@shrub/vue";
+import { ServerModelService } from "./model-service";
+/**
+ * Loads the specified modules (along with the VueServerModule) and returns a Vue SSR render handler.
+ * Example usage in the server entry file:
+ *
+ * export default bootstrap([modules]);
+ *
+ * Note: modules will be loaded/created for each request so it's important that module instances passed
+ * into the bootstrap function not maintain state.
+ */
+export function bootstrap(modules, builder) {
+    modules = [...modules, VueServerModule];
+    return async (context) => {
+        // modules are loaded asynchronously so wait for them to finish loading and grab the modules collection
+        const collection = await ModuleLoader.load({ modules, settings: context.settings });
+        if (context.models) {
+            // inject the model objects so that they are available when rendering server-side
+            const service = collection.services.get(IModelService);
+            for (const key in context.models) {
+                service.set(key, context.models[key]);
+            }
+        }
+        if (context.beginRender) {
+            // this allows server components the ability to configure the service collection before rendering it server-side
+            // the services collection captured/used by the current module is the same one passed into the component when rendered
+            await context.beginRender(collection.services);
+        }
+        const instance = collection.getInstance(VueServerModule);
+        let { app, router } = instance.createApp();
+        context.rendered = () => {
+            // if model state has been captured during SSR set it as the context so it can be loaded client side
+            const modelService = app.$services.get(IModelService);
+            if (modelService.hasModels) {
+                // by setting context.state Vue will inline a global __INITIAL_STATE__ variable
+                // https://ssr.vuejs.org/api/#template
+                context.state = modelService.serialize();
+            }
+        };
+        // if a 'builder' is provided invoke it now to allow extending the Vue app instance
+        app = builder ? await builder(context, app) : app;
+        if (router && context.url) {
+            // if a router and request url are avaiable update the router to use the request url as its route location
+            router.push(context.url);
+            // wait until the router has resolved
+            return new Promise((resolve, reject) => router.onReady(() => {
+                if (!router.getMatchedComponents().length) {
+                    // no routes matched the request url so reject with a 404
+                    return reject({ code: 404 });
+                }
+                resolve(app);
+            }, reject));
+        }
+        return app;
+    };
+}
+/** Vue module for server side rendered components. */
+export class VueServerModule {
+    constructor() {
+        this.name = "vue-server";
+        this.dependencies = [
+            ModelModule,
+            VueModule
+        ];
+    }
+    initialize(init) {
+        // override the vue configuration to prevent mounting to an html element
+        init.config(IVueConfiguration).register(({ services }) => ({
+            mount: (component, options) => {
+                if (this.component) {
+                    throw new Error("A Vue component has already been mounted.");
+                }
+                this.services = services;
+                this.component = component;
+                this.mountOptions = options;
+            }
+        }));
+    }
+    configureServices(registration) {
+        registration.register(IModelService, ServerModelService);
+    }
+    createApp() {
+        if (!this.component) {
+            throw new Error("Vue component has not been mounted.");
+        }
+        const options = this.getComponentOptions();
+        const app = new Vue({
+            services: this.services,
+            render: h => h(this.component, this.getData()),
+            ...options
+        });
+        return { app, router: options.router };
+    }
+    getComponentOptions() {
+        if (this.mountOptions && this.mountOptions.options) {
+            return typeof this.mountOptions.options === "function"
+                ? this.mountOptions.options()
+                : this.mountOptions.options;
+        }
+        return {};
+    }
+    getData() {
+        if (this.mountOptions && this.mountOptions.data) {
+            return typeof this.mountOptions.data === "function"
+                ? this.mountOptions.data()
+                : this.mountOptions.data;
+        }
+        return undefined;
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibW9kdWxlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL21vZHVsZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEdBQW9DLE1BQU0sS0FBSyxDQUFDO0FBRXZELE9BQU8sRUFBc0osWUFBWSxFQUFFLE1BQU0sYUFBYSxDQUFDO0FBQy9MLE9BQU8sRUFBRSxhQUFhLEVBQUUsV0FBVyxFQUFFLE1BQU0sY0FBYyxDQUFDO0FBQzFELE9BQU8sRUFBRSxpQkFBaUIsRUFBb0IsU0FBUyxFQUFFLE1BQU0sWUFBWSxDQUFDO0FBQzVFLE9BQU8sRUFBRSxrQkFBa0IsRUFBRSxNQUFNLGlCQUFpQixDQUFDO0FBcUNyRDs7Ozs7Ozs7R0FRRztBQUNILE1BQU0sVUFBVSxTQUFTLENBQUMsT0FBc0MsRUFBRSxPQUFxQztJQUNuRyxPQUFPLEdBQUcsQ0FBQyxHQUFHLE9BQU8sRUFBRSxlQUFlLENBQUMsQ0FBQztJQUN4QyxPQUFPLEtBQUssRUFBQyxPQUFPLEVBQUMsRUFBRTtRQUNuQix1R0FBdUc7UUFDdkcsTUFBTSxVQUFVLEdBQUcsTUFBTSxZQUFZLENBQUMsSUFBSSxDQUFDLEVBQUUsT0FBTyxFQUFFLFFBQVEsRUFBRSxPQUFPLENBQUMsUUFBUSxFQUFFLENBQUMsQ0FBQztRQUVwRixJQUFJLE9BQU8sQ0FBQyxNQUFNLEVBQUU7WUFDaEIsaUZBQWlGO1lBQ2pGLE1BQU0sT0FBTyxHQUFHLFVBQVUsQ0FBQyxRQUFRLENBQUMsR0FBRyxDQUFDLGFBQWEsQ0FBQyxDQUFDO1lBQ3ZELEtBQUssTUFBTSxHQUFHLElBQUksT0FBTyxDQUFDLE1BQU0sRUFBRTtnQkFDOUIsT0FBTyxDQUFDLEdBQUcsQ0FBQyxHQUFHLEVBQUUsT0FBTyxDQUFDLE1BQU0sQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDO2FBQ3pDO1NBQ0o7UUFFRCxJQUFJLE9BQU8sQ0FBQyxXQUFXLEVBQUU7WUFDckIsZ0hBQWdIO1lBQ2hILHNIQUFzSDtZQUN0SCxNQUFNLE9BQU8sQ0FBQyxXQUFXLENBQUMsVUFBVSxDQUFDLFFBQVEsQ0FBQyxDQUFDO1NBQ2xEO1FBRUQsTUFBTSxRQUFRLEdBQUcsVUFBVSxDQUFDLFdBQVcsQ0FBQyxlQUFlLENBQUMsQ0FBQztRQUN6RCxJQUFJLEVBQUUsR0FBRyxFQUFFLE1BQU0sRUFBRSxHQUFHLFFBQVEsQ0FBQyxTQUFTLEVBQUUsQ0FBQztRQUUzQyxPQUFPLENBQUMsUUFBUSxHQUFHLEdBQUcsRUFBRTtZQUNwQixvR0FBb0c7WUFDcEcsTUFBTSxZQUFZLEdBQXVCLEdBQUcsQ0FBQyxTQUFTLENBQUMsR0FBRyxDQUFDLGFBQWEsQ0FBQyxDQUFDO1lBQzFFLElBQUksWUFBWSxDQUFDLFNBQVMsRUFBRTtnQkFDeEIsK0VBQStFO2dCQUMvRSxzQ0FBc0M7Z0JBQ3RDLE9BQU8sQ0FBQyxLQUFLLEdBQUcsWUFBWSxDQUFDLFNBQVMsRUFBRSxDQUFDO2FBQzVDO1FBQ0wsQ0FBQyxDQUFDO1FBRUYsbUZBQW1GO1FBQ25GLEdBQUcsR0FBRyxPQUFPLENBQUMsQ0FBQyxDQUFDLE1BQU0sT0FBTyxDQUFDLE9BQU8sRUFBRSxHQUFHLENBQUMsQ0FBQyxDQUFDLENBQUMsR0FBRyxDQUFDO1FBRWxELElBQUksTUFBTSxJQUFJLE9BQU8sQ0FBQyxHQUFHLEVBQUU7WUFDdkIsMEdBQTBHO1lBQzFHLE1BQU0sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxDQUFDO1lBRXpCLHFDQUFxQztZQUNyQyxPQUFPLElBQUksT0FBTyxDQUFNLENBQUMsT0FBTyxFQUFFLE1BQU0sRUFBRSxFQUFFLENBQUMsTUFBTyxDQUFDLE9BQU8sQ0FBQyxHQUFHLEVBQUU7Z0JBQzlELElBQUksQ0FBQyxNQUFPLENBQUMsb0JBQW9CLEVBQUUsQ0FBQyxNQUFNLEVBQUU7b0JBQ3hDLHlEQUF5RDtvQkFDekQsT0FBTyxNQUFNLENBQUMsRUFBRSxJQUFJLEVBQUUsR0FBRyxFQUFFLENBQUMsQ0FBQztpQkFDaEM7Z0JBRUQsT0FBTyxDQUFDLEdBQUcsQ0FBQyxDQUFDO1lBQ2pCLENBQUMsRUFDRCxNQUFNLENBQUMsQ0FBQyxDQUFDO1NBQ1o7UUFFRCxPQUFPLEdBQUcsQ0FBQztJQUNmLENBQUMsQ0FBQztBQUNOLENBQUM7QUFFRCxzREFBc0Q7QUFDdEQsTUFBTSxPQUFPLGVBQWU7SUFBNUI7UUFLYSxTQUFJLEdBQUcsWUFBWSxDQUFDO1FBQ3BCLGlCQUFZLEdBQUc7WUFDcEIsV0FBVztZQUNYLFNBQVM7U0FDWixDQUFDO0lBdUROLENBQUM7SUFyREcsVUFBVSxDQUFDLElBQXdCO1FBQy9CLHdFQUF3RTtRQUN4RSxJQUFJLENBQUMsTUFBTSxDQUFDLGlCQUFpQixDQUFDLENBQUMsUUFBUSxDQUFDLENBQUMsRUFBRSxRQUFRLEVBQXVCLEVBQUUsRUFBRSxDQUFDLENBQUM7WUFDNUUsS0FBSyxFQUFFLENBQUMsU0FBUyxFQUFFLE9BQU8sRUFBRSxFQUFFO2dCQUMxQixJQUFJLElBQUksQ0FBQyxTQUFTLEVBQUU7b0JBQ2hCLE1BQU0sSUFBSSxLQUFLLENBQUMsMkNBQTJDLENBQUMsQ0FBQztpQkFDaEU7Z0JBRUQsSUFBSSxDQUFDLFFBQVEsR0FBRyxRQUFRLENBQUM7Z0JBQ3pCLElBQUksQ0FBQyxTQUFTLEdBQUcsU0FBUyxDQUFDO2dCQUMzQixJQUFJLENBQUMsWUFBWSxHQUFHLE9BQU8sQ0FBQztZQUNoQyxDQUFDO1NBQ0osQ0FBQyxDQUFDLENBQUM7SUFDUixDQUFDO0lBRUQsaUJBQWlCLENBQUMsWUFBa0M7UUFDaEQsWUFBWSxDQUFDLFFBQVEsQ0FBQyxhQUFhLEVBQUUsa0JBQWtCLENBQUMsQ0FBQztJQUM3RCxDQUFDO0lBRUQsU0FBUztRQUNMLElBQUksQ0FBQyxJQUFJLENBQUMsU0FBUyxFQUFFO1lBQ2pCLE1BQU0sSUFBSSxLQUFLLENBQUMscUNBQXFDLENBQUMsQ0FBQztTQUMxRDtRQUVELE1BQU0sT0FBTyxHQUFHLElBQUksQ0FBQyxtQkFBbUIsRUFBRSxDQUFDO1FBQzNDLE1BQU0sR0FBRyxHQUFHLElBQUksR0FBRyxDQUFDO1lBQ2hCLFFBQVEsRUFBRSxJQUFJLENBQUMsUUFBUTtZQUN2QixNQUFNLEVBQUUsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLFNBQVMsRUFBRSxJQUFJLENBQUMsT0FBTyxFQUFFLENBQUM7WUFDOUMsR0FBRyxPQUFPO1NBQ2IsQ0FBQyxDQUFDO1FBRUgsT0FBTyxFQUFFLEdBQUcsRUFBRSxNQUFNLEVBQUUsT0FBTyxDQUFDLE1BQU0sRUFBRSxDQUFDO0lBQzNDLENBQUM7SUFFTyxtQkFBbUI7UUFDdkIsSUFBSSxJQUFJLENBQUMsWUFBWSxJQUFJLElBQUksQ0FBQyxZQUFZLENBQUMsT0FBTyxFQUFFO1lBQ2hELE9BQU8sT0FBTyxJQUFJLENBQUMsWUFBWSxDQUFDLE9BQU8sS0FBSyxVQUFVO2dCQUNsRCxDQUFDLENBQUMsSUFBSSxDQUFDLFlBQVksQ0FBQyxPQUFPLEVBQUU7Z0JBQzdCLENBQUMsQ0FBQyxJQUFJLENBQUMsWUFBWSxDQUFDLE9BQU8sQ0FBQztTQUNuQztRQUVELE9BQU8sRUFBRSxDQUFDO0lBQ2QsQ0FBQztJQUVPLE9BQU87UUFDWCxJQUFJLElBQUksQ0FBQyxZQUFZLElBQUksSUFBSSxDQUFDLFlBQVksQ0FBQyxJQUFJLEVBQUU7WUFDN0MsT0FBTyxPQUFPLElBQUksQ0FBQyxZQUFZLENBQUMsSUFBSSxLQUFLLFVBQVU7Z0JBQy9DLENBQUMsQ0FBQyxJQUFJLENBQUMsWUFBWSxDQUFDLElBQUksRUFBRTtnQkFDMUIsQ0FBQyxDQUFDLElBQUksQ0FBQyxZQUFZLENBQUMsSUFBSSxDQUFDO1NBQ2hDO1FBRUQsT0FBTyxTQUFTLENBQUM7SUFDckIsQ0FBQztDQUNKIn0=

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from "./module";

package/dist/index.js

@@ -0,0 +1,14 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./module"), exports);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7O0FBQUEsMkNBQXlCIn0=

package/dist/model-service.d.ts

@@ -0,0 +1,5 @@
+import { ModelService } from "@shrub/model";
+export declare class ServerModelService extends ModelService {
+    get hasModels(): boolean;
+    serialize(): any;
+}

package/dist/model-service.js

@@ -0,0 +1,31 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServerModelService = void 0;
+const core_1 = require("@shrub/core");
+const model_1 = require("@shrub/model");
+const serialization_1 = require("@sprig/serialization");
+let ServerModelService = class ServerModelService extends model_1.ModelService {
+    get hasModels() {
+        for (const key of Object.keys(this.models)) {
+            // make sure the property has an actual object and not just undefined/null
+            if (this.models[key]) {
+                return true;
+            }
+        }
+        return false;
+    }
+    serialize() {
+        return new serialization_1.JSONSerializer().serialize(this.models);
+    }
+};
+ServerModelService = __decorate([
+    core_1.Singleton
+], ServerModelService);
+exports.ServerModelService = ServerModelService;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibW9kZWwtc2VydmljZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9tb2RlbC1zZXJ2aWNlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7OztBQUFBLHNDQUF3QztBQUN4Qyx3Q0FBNEM7QUFDNUMsd0RBQXNEO0FBR3RELElBQWEsa0JBQWtCLEdBQS9CLE1BQWEsa0JBQW1CLFNBQVEsb0JBQVk7SUFDaEQsSUFBSSxTQUFTO1FBQ1QsS0FBSyxNQUFNLEdBQUcsSUFBSSxNQUFNLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxNQUFNLENBQUMsRUFBRTtZQUN4QywwRUFBMEU7WUFDMUUsSUFBSSxJQUFJLENBQUMsTUFBTSxDQUFDLEdBQUcsQ0FBQyxFQUFFO2dCQUNsQixPQUFPLElBQUksQ0FBQzthQUNmO1NBQ0o7UUFFRCxPQUFPLEtBQUssQ0FBQztJQUNqQixDQUFDO0lBRUQsU0FBUztRQUNMLE9BQU8sSUFBSSw4QkFBYyxFQUFFLENBQUMsU0FBUyxDQUFDLElBQUksQ0FBQyxNQUFNLENBQUMsQ0FBQztJQUN2RCxDQUFDO0NBQ0osQ0FBQTtBQWZZLGtCQUFrQjtJQUQ5QixnQkFBUztHQUNHLGtCQUFrQixDQWU5QjtBQWZZLGdEQUFrQiJ9

package/dist/module.d.ts

@@ -0,0 +1,61 @@
+import Vue from "vue";
+import Router from "vue-router";
+import { IModule, IModuleInitializer, IModuleSettingsCollection, IServiceCollection, IServiceRegistration, ModuleInstanceOrConstructor } from "@shrub/core";
+import { ModelModule } from "@shrub/model";
+import { VueModule } from "@shrub/vue";
+/**
+ * Defines a user context that gets passed into the SSR render function.
+ * Vue checks for and uses a few properties internally and the rest are
+ * user defined and used by the render function itself.
+ */
+export interface IVueSSRContext {
+    /** An optional callback that the vue-server module will invoke just before the Vue app/component is rendered. */
+    beginRender?: (services: IServiceCollection) => Promise<void>;
+    /** An optional callback that Vue will invoke when the app as finished rendering. */
+    rendered?: (context: IVueSSRContext) => void;
+    /** Optional set of models that will get injected before rendering server-side and also serialized and set as the state to pass to the client. */
+    models?: {
+        readonly [key: string]: any;
+    };
+    /** Optional module settings that will be passed down to the modules when rendering server-side. */
+    settings?: IModuleSettingsCollection;
+    /** Opional url identifying the current request url and is needed when the main SSR component uses a vue-router. */
+    url?: string;
+    [key: string]: any;
+}
+/** The render function expected to be exported for Vue SSR rendering. */
+export interface IVueSSRRenderHandler {
+    (context: IVueSSRContext): Promise<Vue>;
+}
+/** The callback for extending the Vue SSR render handling function. */
+export interface IVueSSRRenderHandlerBuilder {
+    (context: IVueSSRContext, app: Vue): Promise<Vue>;
+}
+/** The result when creating a Vue app for SSR rendering. */
+export interface IVueSSRCreateResult {
+    readonly app: Vue;
+    readonly router?: Router;
+}
+/**
+ * Loads the specified modules (along with the VueServerModule) and returns a Vue SSR render handler.
+ * Example usage in the server entry file:
+ *
+ * export default bootstrap([modules]);
+ *
+ * Note: modules will be loaded/created for each request so it's important that module instances passed
+ * into the bootstrap function not maintain state.
+ */
+export declare function bootstrap(modules: ModuleInstanceOrConstructor[], builder?: IVueSSRRenderHandlerBuilder): IVueSSRRenderHandler;
+/** Vue module for server side rendered components. */
+export declare class VueServerModule implements IModule {
+    private services?;
+    private component?;
+    private mountOptions?;
+    readonly name = "vue-server";
+    readonly dependencies: (typeof ModelModule | typeof VueModule)[];
+    initialize(init: IModuleInitializer): void;
+    configureServices(registration: IServiceRegistration): void;
+    createApp(): IVueSSRCreateResult;
+    private getComponentOptions;
+    private getData;
+}

package/dist/module.js

@@ -0,0 +1,122 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VueServerModule = exports.bootstrap = void 0;
+const vue_1 = __importDefault(require("vue"));
+const core_1 = require("@shrub/core");
+const model_1 = require("@shrub/model");
+const vue_2 = require("@shrub/vue");
+const model_service_1 = require("./model-service");
+/**
+ * Loads the specified modules (along with the VueServerModule) and returns a Vue SSR render handler.
+ * Example usage in the server entry file:
+ *
+ * export default bootstrap([modules]);
+ *
+ * Note: modules will be loaded/created for each request so it's important that module instances passed
+ * into the bootstrap function not maintain state.
+ */
+function bootstrap(modules, builder) {
+    modules = [...modules, VueServerModule];
+    return async (context) => {
+        // modules are loaded asynchronously so wait for them to finish loading and grab the modules collection
+        const collection = await core_1.ModuleLoader.load({ modules, settings: context.settings });
+        if (context.models) {
+            // inject the model objects so that they are available when rendering server-side
+            const service = collection.services.get(model_1.IModelService);
+            for (const key in context.models) {
+                service.set(key, context.models[key]);
+            }
+        }
+        if (context.beginRender) {
+            // this allows server components the ability to configure the service collection before rendering it server-side
+            // the services collection captured/used by the current module is the same one passed into the component when rendered
+            await context.beginRender(collection.services);
+        }
+        const instance = collection.getInstance(VueServerModule);
+        let { app, router } = instance.createApp();
+        context.rendered = () => {
+            // if model state has been captured during SSR set it as the context so it can be loaded client side
+            const modelService = app.$services.get(model_1.IModelService);
+            if (modelService.hasModels) {
+                // by setting context.state Vue will inline a global __INITIAL_STATE__ variable
+                // https://ssr.vuejs.org/api/#template
+                context.state = modelService.serialize();
+            }
+        };
+        // if a 'builder' is provided invoke it now to allow extending the Vue app instance
+        app = builder ? await builder(context, app) : app;
+        if (router && context.url) {
+            // if a router and request url are avaiable update the router to use the request url as its route location
+            router.push(context.url);
+            // wait until the router has resolved
+            return new Promise((resolve, reject) => router.onReady(() => {
+                if (!router.getMatchedComponents().length) {
+                    // no routes matched the request url so reject with a 404
+                    return reject({ code: 404 });
+                }
+                resolve(app);
+            }, reject));
+        }
+        return app;
+    };
+}
+exports.bootstrap = bootstrap;
+/** Vue module for server side rendered components. */
+class VueServerModule {
+    constructor() {
+        this.name = "vue-server";
+        this.dependencies = [
+            model_1.ModelModule,
+            vue_2.VueModule
+        ];
+    }
+    initialize(init) {
+        // override the vue configuration to prevent mounting to an html element
+        init.config(vue_2.IVueConfiguration).register(({ services }) => ({
+            mount: (component, options) => {
+                if (this.component) {
+                    throw new Error("A Vue component has already been mounted.");
+                }
+                this.services = services;
+                this.component = component;
+                this.mountOptions = options;
+            }
+        }));
+    }
+    configureServices(registration) {
+        registration.register(model_1.IModelService, model_service_1.ServerModelService);
+    }
+    createApp() {
+        if (!this.component) {
+            throw new Error("Vue component has not been mounted.");
+        }
+        const options = this.getComponentOptions();
+        const app = new vue_1.default({
+            services: this.services,
+            render: h => h(this.component, this.getData()),
+            ...options
+        });
+        return { app, router: options.router };
+    }
+    getComponentOptions() {
+        if (this.mountOptions && this.mountOptions.options) {
+            return typeof this.mountOptions.options === "function"
+                ? this.mountOptions.options()
+                : this.mountOptions.options;
+        }
+        return {};
+    }
+    getData() {
+        if (this.mountOptions && this.mountOptions.data) {
+            return typeof this.mountOptions.data === "function"
+                ? this.mountOptions.data()
+                : this.mountOptions.data;
+        }
+        return undefined;
+    }
+}
+exports.VueServerModule = VueServerModule;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibW9kdWxlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL21vZHVsZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7QUFBQSw4Q0FBdUQ7QUFFdkQsc0NBQStMO0FBQy9MLHdDQUEwRDtBQUMxRCxvQ0FBNEU7QUFDNUUsbURBQXFEO0FBcUNyRDs7Ozs7Ozs7R0FRRztBQUNILFNBQWdCLFNBQVMsQ0FBQyxPQUFzQyxFQUFFLE9BQXFDO0lBQ25HLE9BQU8sR0FBRyxDQUFDLEdBQUcsT0FBTyxFQUFFLGVBQWUsQ0FBQyxDQUFDO0lBQ3hDLE9BQU8sS0FBSyxFQUFDLE9BQU8sRUFBQyxFQUFFO1FBQ25CLHVHQUF1RztRQUN2RyxNQUFNLFVBQVUsR0FBRyxNQUFNLG1CQUFZLENBQUMsSUFBSSxDQUFDLEVBQUUsT0FBTyxFQUFFLFFBQVEsRUFBRSxPQUFPLENBQUMsUUFBUSxFQUFFLENBQUMsQ0FBQztRQUVwRixJQUFJLE9BQU8sQ0FBQyxNQUFNLEVBQUU7WUFDaEIsaUZBQWlGO1lBQ2pGLE1BQU0sT0FBTyxHQUFHLFVBQVUsQ0FBQyxRQUFRLENBQUMsR0FBRyxDQUFDLHFCQUFhLENBQUMsQ0FBQztZQUN2RCxLQUFLLE1BQU0sR0FBRyxJQUFJLE9BQU8sQ0FBQyxNQUFNLEVBQUU7Z0JBQzlCLE9BQU8sQ0FBQyxHQUFHLENBQUMsR0FBRyxFQUFFLE9BQU8sQ0FBQyxNQUFNLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQzthQUN6QztTQUNKO1FBRUQsSUFBSSxPQUFPLENBQUMsV0FBVyxFQUFFO1lBQ3JCLGdIQUFnSDtZQUNoSCxzSEFBc0g7WUFDdEgsTUFBTSxPQUFPLENBQUMsV0FBVyxDQUFDLFVBQVUsQ0FBQyxRQUFRLENBQUMsQ0FBQztTQUNsRDtRQUVELE1BQU0sUUFBUSxHQUFHLFVBQVUsQ0FBQyxXQUFXLENBQUMsZUFBZSxDQUFDLENBQUM7UUFDekQsSUFBSSxFQUFFLEdBQUcsRUFBRSxNQUFNLEVBQUUsR0FBRyxRQUFRLENBQUMsU0FBUyxFQUFFLENBQUM7UUFFM0MsT0FBTyxDQUFDLFFBQVEsR0FBRyxHQUFHLEVBQUU7WUFDcEIsb0dBQW9HO1lBQ3BHLE1BQU0sWUFBWSxHQUF1QixHQUFHLENBQUMsU0FBUyxDQUFDLEdBQUcsQ0FBQyxxQkFBYSxDQUFDLENBQUM7WUFDMUUsSUFBSSxZQUFZLENBQUMsU0FBUyxFQUFFO2dCQUN4QiwrRUFBK0U7Z0JBQy9FLHNDQUFzQztnQkFDdEMsT0FBTyxDQUFDLEtBQUssR0FBRyxZQUFZLENBQUMsU0FBUyxFQUFFLENBQUM7YUFDNUM7UUFDTCxDQUFDLENBQUM7UUFFRixtRkFBbUY7UUFDbkYsR0FBRyxHQUFHLE9BQU8sQ0FBQyxDQUFDLENBQUMsTUFBTSxPQUFPLENBQUMsT0FBTyxFQUFFLEdBQUcsQ0FBQyxDQUFDLENBQUMsQ0FBQyxHQUFHLENBQUM7UUFFbEQsSUFBSSxNQUFNLElBQUksT0FBTyxDQUFDLEdBQUcsRUFBRTtZQUN2QiwwR0FBMEc7WUFDMUcsTUFBTSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLENBQUM7WUFFekIscUNBQXFDO1lBQ3JDLE9BQU8sSUFBSSxPQUFPLENBQU0sQ0FBQyxPQUFPLEVBQUUsTUFBTSxFQUFFLEVBQUUsQ0FBQyxNQUFPLENBQUMsT0FBTyxDQUFDLEdBQUcsRUFBRTtnQkFDOUQsSUFBSSxDQUFDLE1BQU8sQ0FBQyxvQkFBb0IsRUFBRSxDQUFDLE1BQU0sRUFBRTtvQkFDeEMseURBQXlEO29CQUN6RCxPQUFPLE1BQU0sQ0FBQyxFQUFFLElBQUksRUFBRSxHQUFHLEVBQUUsQ0FBQyxDQUFDO2lCQUNoQztnQkFFRCxPQUFPLENBQUMsR0FBRyxDQUFDLENBQUM7WUFDakIsQ0FBQyxFQUNELE1BQU0sQ0FBQyxDQUFDLENBQUM7U0FDWjtRQUVELE9BQU8sR0FBRyxDQUFDO0lBQ2YsQ0FBQyxDQUFDO0FBQ04sQ0FBQztBQXRERCw4QkFzREM7QUFFRCxzREFBc0Q7QUFDdEQsTUFBYSxlQUFlO0lBQTVCO1FBS2EsU0FBSSxHQUFHLFlBQVksQ0FBQztRQUNwQixpQkFBWSxHQUFHO1lBQ3BCLG1CQUFXO1lBQ1gsZUFBUztTQUNaLENBQUM7SUF1RE4sQ0FBQztJQXJERyxVQUFVLENBQUMsSUFBd0I7UUFDL0Isd0VBQXdFO1FBQ3hFLElBQUksQ0FBQyxNQUFNLENBQUMsdUJBQWlCLENBQUMsQ0FBQyxRQUFRLENBQUMsQ0FBQyxFQUFFLFFBQVEsRUFBdUIsRUFBRSxFQUFFLENBQUMsQ0FBQztZQUM1RSxLQUFLLEVBQUUsQ0FBQyxTQUFTLEVBQUUsT0FBTyxFQUFFLEVBQUU7Z0JBQzFCLElBQUksSUFBSSxDQUFDLFNBQVMsRUFBRTtvQkFDaEIsTUFBTSxJQUFJLEtBQUssQ0FBQywyQ0FBMkMsQ0FBQyxDQUFDO2lCQUNoRTtnQkFFRCxJQUFJLENBQUMsUUFBUSxHQUFHLFFBQVEsQ0FBQztnQkFDekIsSUFBSSxDQUFDLFNBQVMsR0FBRyxTQUFTLENBQUM7Z0JBQzNCLElBQUksQ0FBQyxZQUFZLEdBQUcsT0FBTyxDQUFDO1lBQ2hDLENBQUM7U0FDSixDQUFDLENBQUMsQ0FBQztJQUNSLENBQUM7SUFFRCxpQkFBaUIsQ0FBQyxZQUFrQztRQUNoRCxZQUFZLENBQUMsUUFBUSxDQUFDLHFCQUFhLEVBQUUsa0NBQWtCLENBQUMsQ0FBQztJQUM3RCxDQUFDO0lBRUQsU0FBUztRQUNMLElBQUksQ0FBQyxJQUFJLENBQUMsU0FBUyxFQUFFO1lBQ2pCLE1BQU0sSUFBSSxLQUFLLENBQUMscUNBQXFDLENBQUMsQ0FBQztTQUMxRDtRQUVELE1BQU0sT0FBTyxHQUFHLElBQUksQ0FBQyxtQkFBbUIsRUFBRSxDQUFDO1FBQzNDLE1BQU0sR0FBRyxHQUFHLElBQUksYUFBRyxDQUFDO1lBQ2hCLFFBQVEsRUFBRSxJQUFJLENBQUMsUUFBUTtZQUN2QixNQUFNLEVBQUUsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLFNBQVMsRUFBRSxJQUFJLENBQUMsT0FBTyxFQUFFLENBQUM7WUFDOUMsR0FBRyxPQUFPO1NBQ2IsQ0FBQyxDQUFDO1FBRUgsT0FBTyxFQUFFLEdBQUcsRUFBRSxNQUFNLEVBQUUsT0FBTyxDQUFDLE1BQU0sRUFBRSxDQUFDO0lBQzNDLENBQUM7SUFFTyxtQkFBbUI7UUFDdkIsSUFBSSxJQUFJLENBQUMsWUFBWSxJQUFJLElBQUksQ0FBQyxZQUFZLENBQUMsT0FBTyxFQUFFO1lBQ2hELE9BQU8sT0FBTyxJQUFJLENBQUMsWUFBWSxDQUFDLE9BQU8sS0FBSyxVQUFVO2dCQUNsRCxDQUFDLENBQUMsSUFBSSxDQUFDLFlBQVksQ0FBQyxPQUFPLEVBQUU7Z0JBQzdCLENBQUMsQ0FBQyxJQUFJLENBQUMsWUFBWSxDQUFDLE9BQU8sQ0FBQztTQUNuQztRQUVELE9BQU8sRUFBRSxDQUFDO0lBQ2QsQ0FBQztJQUVPLE9BQU87UUFDWCxJQUFJLElBQUksQ0FBQyxZQUFZLElBQUksSUFBSSxDQUFDLFlBQVksQ0FBQyxJQUFJLEVBQUU7WUFDN0MsT0FBTyxPQUFPLElBQUksQ0FBQyxZQUFZLENBQUMsSUFBSSxLQUFLLFVBQVU7Z0JBQy9DLENBQUMsQ0FBQyxJQUFJLENBQUMsWUFBWSxDQUFDLElBQUksRUFBRTtnQkFDMUIsQ0FBQyxDQUFDLElBQUksQ0FBQyxZQUFZLENBQUMsSUFBSSxDQUFDO1NBQ2hDO1FBRUQsT0FBTyxTQUFTLENBQUM7SUFDckIsQ0FBQztDQUNKO0FBaEVELDBDQWdFQyJ9

package/package.json

@@ -0,0 +1,40 @@
+{
+    "name": "@shrub/vue-server",
+    "description": "A module that extends the Vue module for server-side rendering support.",
+    "version": "0.5.26",
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/jjvainav/shrub.git"
+    },
+    "main": "dist/index.js",
+    "module": "dist/esm/index.js",
+    "typings": "dist/index.d.ts",
+    "files": [
+        "dist"
+    ],
+    "publishConfig": {
+        "access": "public"
+    },
+    "engines": {
+        "node": ">=10.18.0"
+    },
+    "scripts": {
+        "build": "tsc -b .",
+        "build:esm": "tsc -p tsconfig.esm.json",
+        "clean": "rimraf ./dist && rimraf tsconfig.tsbuildinfo",
+        "watch": "tsc -b . -w"
+    },
+    "dependencies": {
+        "vue": "^2.6.10",
+        "vue-router": "^3.1.3",
+        "vue-server-renderer": "^2.6.10"
+    },
+    "devDependencies": {
+        "@shrub/core": "0.5.26",
+        "@shrub/model": "0.5.26",
+        "@shrub/vue": "0.5.26",
+        "@sprig/serialization": "0.1.69"
+    },
+    "gitHead": "bd8e68fee891bb035f6506401851cf993c1c614e"
+}