@ms-cloudpack/cli 0.23.14 → 0.24.0

package/lib/types.d.ts

@@ -150,6 +150,28 @@ export interface PackageOverride {
     isInternal?: boolean;
     overrides: PackageJson;
 }
+export interface Route {
+    /**
+     * The url path part to match. Start paths with a leading slash, e.g. `'/my-route'`. You can also
+     * use wildcards (`*`), e.g. `'/my-route/*'` to match all paths starting with `'/my-route'`.
+     */
+    match: string;
+    /**
+     * The path relative to the app root to static assets. If this is provided, renderScript/exportEntry
+     * will be ignored.
+     */
+    staticPath?: string;
+    /**
+     * Path to a .js or .html file used for rendering the route. If a script is provided, it must
+     * export a default function implementing `CreateHtmlFunction` defined in `@ms-cloudpack/cli`.
+     */
+    renderScript?: string;
+    /**
+     * The key in the exports map which represents the entry point app script for this route.
+     * Default is '.', meaning the main package export key.
+     */
+    exportEntry?: string;
+}
 export interface DevServer {
     /**
      * The domain name of the server.
@@ -171,14 +193,56 @@ export interface DevServer {
     https?: HttpsConfig;
     /**
      * If provided, will override where the publicDir is located, relative to the app package folder.
-     * Defaults to `./public`.
+     * Defaults to `./public`. The same thing can be achieved with `routes`, using route: '*' and
+     * staticPath: './public', so the `publicPath` setting may be removed in the future.
      */
-    publicDir?: string;
+    publicPath?: string;
+    /**
+     * If provided, will register routes with the dev server to host various pages.
+     */
+    routes?: Route[];
 }
 /**
  * Per-application configuration for Cloudpack.
  */
 export interface CloudpackConfig {
+    /**
+     * An array of PackageOverride objects, used to provide overrides for packages without modifying their
+     * definitions directly. This is primarily used for providing exports maps for packages that don't have them.
+     */
     packageOverrides?: PackageOverride[];
+    /**
+     * A set of options for configuring how the dev server works.
+     */
     devServer?: DevServer;
 }
+/**
+ * The input options for a createHtml custom server render function.
+ */
+export type CreateHtmlOptions = {
+    session: Session;
+    route: Route;
+    baseUrl: string;
+    definition: PackageJson;
+    importMap: ImportMap;
+    overlayScript: string | undefined;
+    entryScript: string | undefined;
+    inlineScripts: string[];
+};
+/**
+ * The expected result of the createHtml custom server render function.
+ */
+export type CreateHtmlResult = string | {
+    html: string;
+    statusCode: number;
+};
+/**
+ * A custom server render function that can be used to override the default HTML response.
+ */
+export type CreateHtmlFunction = (options: CreateHtmlOptions) => Promise<CreateHtmlResult> | CreateHtmlResult;
+/**
+ * The expected shape of the createHtml custom server render function script.
+ */
+export type CreateHtmlScript = {
+    default: CreateHtmlFunction;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ms-cloudpack/cli",
-  "version": "0.23.14",
+  "version": "0.24.0",
   "description": "The Cloudpack command line interface - a tool for managing fast inner and outer looping in web apps.",
   "license": "MIT",
   "type": "module",
@@ -16,8 +16,8 @@
     "cloudpack": "./bin/cloudpack.js"
   },
   "dependencies": {
-    "@ms-cloudpack/bundler": "^0.9.3",
-    "@ms-cloudpack/create-express-app": "^1.1.5",
+    "@ms-cloudpack/bundler": "^0.9.5",
+    "@ms-cloudpack/create-express-app": "^1.2.0",
     "@ms-cloudpack/data-bus": "^0.1.1",
     "@ms-cloudpack/json-utilities": "^0.0.4",
     "@ms-cloudpack/overlay": "^0.11.3",
@@ -30,6 +30,7 @@
     "filenamify": "^5.1.0",
     "fs-extra": "^10.1.0",
     "glob": "^8.0.0",
+    "jsdom": "^21.1.0",
     "object-hash": "^3.0.0",
     "open": "^8.4.0",
     "p-queue": "^7.3.0",
@@ -43,6 +44,7 @@
     "@ms-cloudpack/scripts": "*",
     "@types/chokidar": "2.1.3",
     "@types/glob": "8.0.1",
+    "@types/jsdom": "20.0.1",
     "@types/object-hash": "3.0.2",
     "@types/uuid": "9.0.0",
     "@types/ws": "8.5.4"