@blinkk/root 1.0.0-beta.0 → 1.0.0-beta.10

package/dist/{config-872b068d.d.ts → types-8310f09f.d.ts}

@@ -1,6 +1,6 @@
 import { Express, Request as Request$1, Response as Response$1, NextFunction as NextFunction$1 } from 'express';
 import { ComponentType } from 'preact';
-import { ViteDevServer, PluginOption, UserConfig } from 'vite';
+import { PluginOption, UserConfig, ViteDevServer } from 'vite';
 import { Options } from 'html-minifier-terser';
 import { HTMLBeautifyOptions } from 'js-beautify';
 
@@ -30,6 +30,136 @@ interface AssetMap {
     get: (src: string) => Promise<Asset | null>;
 }
 
+declare type MaybePromise<T> = T | Promise<T>;
+declare type ConfigureServerHook = (server: Server, options: ConfigureServerOptions) => MaybePromise<void> | MaybePromise<() => void>;
+interface ConfigureServerOptions {
+    type: 'dev' | 'preview' | 'prod';
+    rootConfig: RootConfig;
+}
+interface Plugin {
+    [key: string]: any;
+    /** The name of the plugin. */
+    name?: string;
+    /**
+     * Configures the root.js express server. Any middleware defined by the plugin
+     * will be added to the server first. If a callback fn is returned, it will
+     * be called after the root.js middlewares are added.
+     */
+    configureServer?: ConfigureServerHook;
+    /**
+     * Returns a list of deps to bundle for ssr. The files will be bundled and
+     * output to `dist/server/`. The return value should be a map of
+     * `{output filename => input filepath}`.
+     *
+     * E.g. a value of `{foo: 'path/to/bar.js'}` will output `dist/server/foo.js`.
+     *
+     * @experimental This config is subject to change to be incorporated into a
+     * broader config option called "ssr" or "ssrOptions".
+     */
+    ssrInput?: () => {
+        [entryAlias: string]: string;
+    };
+    /** Adds vite plugins. */
+    vitePlugins?: PluginOption[];
+}
+/**
+ * Runs the pre-hook configureServer method of every plugin, calls a callback
+ * function, and then runs the configureServer's post-hook if provided. Plugins
+ * provide a post-hook by returning a callback function from configureServer.
+ */
+declare function configureServerPlugins(server: Server, callback: () => Promise<void>, plugins: Plugin[], options: ConfigureServerOptions): Promise<void>;
+declare function getVitePlugins(plugins: Plugin[]): PluginOption[];
+
+declare type HtmlMinifyOptions = Options;
+
+declare type HtmlPrettyOptions = HTMLBeautifyOptions;
+
+interface RootUserConfig {
+    /**
+     * Canonical domain the website will serve on. Useful for things like the
+     * sitemap, SEO tags, etc.
+     */
+    domain?: string;
+    /**
+     * Config for auto-injecting custom element dependencies.
+     */
+    elements?: {
+        /**
+         * A list of directories to use to look for custom elements. The dir path
+         * should be relative to the project dir, e.g. "path/to/elements".
+         */
+        include?: string[];
+        /**
+         * A list of RegEx patterns to exclude. The string passed to the RegEx is
+         * the file URL relative to the project root, e.g. "/elements/foo/foo.ts".
+         */
+        exclude?: RegExp[];
+    };
+    /**
+     * Config options for localization and internationalization.
+     */
+    i18n?: RootI18nConfig;
+    /**
+     * Config options for the Root.js express server.
+     */
+    server?: RootServerConfig;
+    /**
+     * Vite config.
+     * @see {@link https://vitejs.dev/config/} for more information.
+     */
+    vite?: UserConfig;
+    /**
+     * Whether to automatically minify HTML output. This is enabled by default,
+     * in order to disable, pass `minifyHtml: false` to root.config.ts.
+     */
+    minifyHtml?: boolean;
+    /**
+     * Options to pass to html-minifier-terser.
+     */
+    minifyHtmlOptions?: HtmlMinifyOptions;
+    /**
+     * Whether to pretty print HTML output.
+     */
+    prettyHtml?: boolean;
+    /**
+     * Options to pass to js-beautify.
+     */
+    prettyHtmlOptions?: HtmlPrettyOptions;
+    /**
+     * Whether to include a sitemap.xml file to the build output.
+     */
+    sitemap?: boolean;
+    /**
+     * Plugins.
+     */
+    plugins?: Plugin[];
+}
+declare type RootConfig = RootUserConfig & {
+    rootDir: string;
+};
+interface RootI18nConfig {
+    /**
+     * Locales enabled for the site.
+     */
+    locales?: string[];
+    /**
+     * The default locale to use. Defaults is `en`.
+     */
+    defaultLocale?: string;
+    /**
+     * URL format for localized content. Default is `/{locale}/{path}`.
+     */
+    urlFormat?: string;
+}
+interface RootServerConfig {
+    /**
+     * An array of middleware to add to the express server. These middleware are
+     * added to the beginning of the express app.
+     */
+    middlewares?: Array<(req: Request, res: Response, next: NextFunction) => void | Promise<void>>;
+}
+declare function defineConfig(config: RootUserConfig): RootUserConfig;
+
 interface ElementSourceFile {
     /** Full file path. */
     filePath: string;
@@ -54,6 +184,16 @@ declare class ElementGraph {
     constructor(sourceFiles: {
         [tagName: string]: ElementSourceFile;
     });
+    toJson(): {
+        sourceFiles: {
+            [tagName: string]: ElementSourceFile;
+        };
+        deps: Record<string, string[]>;
+    };
+    static fromJson(data: {
+        deps: any;
+        sourceFiles: any;
+    }): ElementGraph;
     getDeps(tagName: string, visited?: Set<string>): string[];
     /**
      * Parses an element's source file for usage of other custom elements.
@@ -210,134 +350,4 @@ interface Route {
     localeRoutePath: string;
 }
 
-declare type MaybePromise<T> = T | Promise<T>;
-declare type ConfigureServerHook = (server: Server, options: ConfigureServerOptions) => MaybePromise<void> | MaybePromise<() => void>;
-interface ConfigureServerOptions {
-    type: 'dev' | 'preview' | 'prod';
-    rootConfig: RootConfig;
-}
-interface Plugin {
-    [key: string]: any;
-    /** The name of the plugin. */
-    name?: string;
-    /**
-     * Configures the root.js express server. Any middleware defined by the plugin
-     * will be added to the server first. If a callback fn is returned, it will
-     * be called after the root.js middlewares are added.
-     */
-    configureServer?: ConfigureServerHook;
-    /**
-     * Returns a list of deps to bundle for ssr. The files will be bundled and
-     * output to `dist/server/`. The return value should be a map of
-     * `{output filename => input filepath}`.
-     *
-     * E.g. a value of `{foo: 'path/to/bar.js'}` will output `dist/server/foo.js`.
-     *
-     * @experimental This config is subject to change to be incorporated into a
-     * broader config option called "ssr" or "ssrOptions".
-     */
-    ssrInput?: () => {
-        [entryAlias: string]: string;
-    };
-    /** Adds vite plugins. */
-    vitePlugins?: PluginOption[];
-}
-/**
- * Runs the pre-hook configureServer method of every plugin, calls a callback
- * function, and then runs the configureServer's post-hook if provided. Plugins
- * provide a post-hook by returning a callback function from configureServer.
- */
-declare function configureServerPlugins(server: Server, callback: () => Promise<void>, plugins: Plugin[], options: ConfigureServerOptions): Promise<void>;
-declare function getVitePlugins(plugins: Plugin[]): PluginOption[];
-
-declare type HtmlMinifyOptions = Options;
-
-declare type HtmlPrettyOptions = HTMLBeautifyOptions;
-
-interface RootUserConfig {
-    /**
-     * Canonical domain the website will serve on. Useful for things like the
-     * sitemap, SEO tags, etc.
-     */
-    domain?: string;
-    /**
-     * Config for auto-injecting custom element dependencies.
-     */
-    elements?: {
-        /**
-         * A list of directories to use to look for custom elements. The dir path
-         * should be relative to the project dir, e.g. "path/to/elements".
-         */
-        include?: string[];
-        /**
-         * A list of RegEx patterns to exclude. The string passed to the RegEx is
-         * the file URL relative to the project root, e.g. "/elements/foo/foo.ts".
-         */
-        exclude?: RegExp[];
-    };
-    /**
-     * Config options for localization and internationalization.
-     */
-    i18n?: RootI18nConfig;
-    /**
-     * Config options for the Root.js express server.
-     */
-    server?: RootServerConfig;
-    /**
-     * Vite config.
-     * @see {@link https://vitejs.dev/config/} for more information.
-     */
-    vite?: UserConfig;
-    /**
-     * Whether to automatically minify HTML output. This is enabled by default,
-     * in order to disable, pass `minifyHtml: false` to root.config.ts.
-     */
-    minifyHtml?: boolean;
-    /**
-     * Options to pass to html-minifier-terser.
-     */
-    minifyHtmlOptions?: HtmlMinifyOptions;
-    /**
-     * Whether to pretty print HTML output.
-     */
-    prettyHtml?: boolean;
-    /**
-     * Options to pass to js-beautify.
-     */
-    prettyHtmlOptions?: HtmlPrettyOptions;
-    /**
-     * Whether to include a sitemap.xml file to the build output.
-     */
-    sitemap?: boolean;
-    /**
-     * Plugins.
-     */
-    plugins?: Plugin[];
-}
-declare type RootConfig = RootUserConfig & {
-    rootDir: string;
-};
-interface RootI18nConfig {
-    /**
-     * Locales enabled for the site.
-     */
-    locales?: string[];
-    /**
-     * The default locale to use. Defaults is `en`.
-     */
-    defaultLocale?: string;
-    /**
-     * URL format for localized content. Default is `/{locale}/{path}`.
-     */
-    urlFormat?: string;
-}
-interface RootServerConfig {
-    /**
-     * An array of middleware to add to the express server. These middleware are
-     * added to the beginning of the express app.
-     */
-    middlewares?: Array<(req: Request, res: Response, next: NextFunction) => void | Promise<void>>;
-}
-declare function defineConfig(config: RootUserConfig): RootUserConfig;
-
 export { ConfigureServerHook as C, GetStaticProps as G, HandlerContext as H, NextFunction as N, Plugin as P, Route as R, Server as S, RootUserConfig as a, RootConfig as b, RootI18nConfig as c, RootServerConfig as d, defineConfig as e, ConfigureServerOptions as f, configureServerPlugins as g, getVitePlugins as h, RouteParams as i, GetStaticPaths as j, Request as k, Response as l, Handler as m, RouteModule as n, Renderer as o };

package/package.json

@@ -1,14 +1,20 @@
 {
   "name": "@blinkk/root",
-  "version": "1.0.0-beta.0",
+  "version": "1.0.0-beta.10",
   "author": "s@blinkk.com",
   "license": "MIT",
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=16.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/blinkk/rootjs.git",
+    "directory": "packages/root"
   },
   "files": [
     "bin/*",
-    "dist/**/*"
+    "dist/**/*",
+    "client.d.ts"
   ],
   "bin": {
     "root": "./bin/root.js"
@@ -21,6 +27,7 @@
       "types": "./dist/core.d.ts",
       "import": "./dist/core.js"
     },
+    "./client": "./client.d.ts",
     "./*": {
       "types": "./dist/*.d.ts",
       "import": "./dist/*.js"
@@ -34,7 +41,6 @@
     "express": "^4.18.1",
     "fs-extra": "^10.1.0",
     "html-minifier-terser": "^7.0.0",
-    "joycon": "^3.1.1",
     "js-beautify": "^1.14.7",
     "kleur": "^4.1.5",
     "sass": "^1.49.9",

package/dist/chunk-GGQGZ7ZE.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/utils/elements.ts","../src/render/html-minify.ts","../src/render/html-pretty.ts"],"sourcesContent":["export const ELEMENT_RE = /^[a-z][\\w-]*-[\\w-]*$/;\nexport const HTML_ELEMENTS_REGEX = /<([a-z][\\w-]*-[\\w-]*)/g;\n\n/**\n * Returns true if the tagName is a valid custom element tag.\n */\nexport function isValidTagName(tagName: string) {\n  return ELEMENT_RE.test(tagName);\n}\n\n/**\n * Returns a list of custom elements used in a src string (e.g. HTML, jsx, lit).\n * NOTE: the impl uses a simple regex, so tagNames used in comments and attr\n * values may be included.\n */\nexport function parseTagNames(src: string): string[] {\n  const tagNames = new Set<string>();\n  const matches = Array.from(src.matchAll(HTML_ELEMENTS_REGEX));\n  for (const match of matches) {\n    const tagName = match[1];\n    tagNames.add(tagName);\n  }\n  return Array.from(tagNames);\n}\n","import {createRequire} from 'module';\nconst require = createRequire(import.meta.url);\nconst {minify} = require('html-minifier-terser');\nimport type {Options} from 'html-minifier-terser';\n\nexport type HtmlMinifyOptions = Options;\n\nexport async function htmlMinify(\n  html: string,\n  options?: HtmlMinifyOptions\n): Promise<string> {\n  const minifyOptions = options || {\n    collapseWhitespace: true,\n    removeComments: true,\n    preserveLineBreaks: true,\n  };\n  try {\n    const min = await minify(html, minifyOptions);\n    return min.trimStart();\n  } catch (e) {\n    console.error('failed to minify html:', e);\n    return html;\n  }\n}\n","import {createRequire} from 'module';\nconst require = createRequire(import.meta.url);\nconst beautify = require('js-beautify');\nimport type {HTMLBeautifyOptions} from 'js-beautify';\n\nexport type HtmlPrettyOptions = HTMLBeautifyOptions;\n\nexport async function htmlPretty(\n  html: string,\n  options?: HtmlPrettyOptions\n): Promise<string> {\n  const prettyOptions = options || {\n    indent_size: 0,\n    end_with_newline: true,\n    extra_liners: [],\n  };\n  try {\n    const output = beautify.html(html, prettyOptions);\n    return output.trimStart();\n  } catch (e) {\n    console.error('failed to pretty html:', e);\n    return html;\n  }\n}\n"],"mappings":";AAAO,IAAM,aAAa;AACnB,IAAM,sBAAsB;AAK5B,SAAS,eAAe,SAAiB;AAC9C,SAAO,WAAW,KAAK,OAAO;AAChC;AAOO,SAAS,cAAc,KAAuB;AACnD,QAAM,WAAW,oBAAI,IAAY;AACjC,QAAM,UAAU,MAAM,KAAK,IAAI,SAAS,mBAAmB,CAAC;AAC5D,aAAW,SAAS,SAAS;AAC3B,UAAM,UAAU,MAAM;AACtB,aAAS,IAAI,OAAO;AAAA,EACtB;AACA,SAAO,MAAM,KAAK,QAAQ;AAC5B;;;ACvBA,SAAQ,qBAAoB;AAC5B,IAAMA,WAAU,cAAc,YAAY,GAAG;AAC7C,IAAM,EAAC,OAAM,IAAIA,SAAQ,sBAAsB;AAK/C,eAAsB,WACpB,MACA,SACiB;AACjB,QAAM,gBAAgB,WAAW;AAAA,IAC/B,oBAAoB;AAAA,IACpB,gBAAgB;AAAA,IAChB,oBAAoB;AAAA,EACtB;AACA,MAAI;AACF,UAAM,MAAM,MAAM,OAAO,MAAM,aAAa;AAC5C,WAAO,IAAI,UAAU;AAAA,EACvB,SAAS,GAAP;AACA,YAAQ,MAAM,0BAA0B,CAAC;AACzC,WAAO;AAAA,EACT;AACF;;;ACvBA,SAAQ,iBAAAC,sBAAoB;AAC5B,IAAMC,WAAUD,eAAc,YAAY,GAAG;AAC7C,IAAM,WAAWC,SAAQ,aAAa;AAKtC,eAAsB,WACpB,MACA,SACiB;AACjB,QAAM,gBAAgB,WAAW;AAAA,IAC/B,aAAa;AAAA,IACb,kBAAkB;AAAA,IAClB,cAAc,CAAC;AAAA,EACjB;AACA,MAAI;AACF,UAAM,SAAS,SAAS,KAAK,MAAM,aAAa;AAChD,WAAO,OAAO,UAAU;AAAA,EAC1B,SAAS,GAAP;AACA,YAAQ,MAAM,0BAA0B,CAAC;AACzC,WAAO;AAAA,EACT;AACF;","names":["require","createRequire","require"]}