@sjcx/vorma 0.0.0-pre.6 → 0.0.0-pre.8

package/LICENSE

@@ -1,4 +1,17 @@
-MIT
+LICENSE
+
+Copyright 2023 Samuel J. Cook
+
+This software is licensed under either of:
+
+  (i)  the MIT License; or
+  (ii) the Apache License, Version 2.0,
+
+at your option. Each license is below.
+
+---BEGIN MIT LICENSE---
+
+MIT License
 
 Copyright 2023 Samuel J. Cook
 
@@ -18,3 +31,186 @@ 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.
+
+---END MIT LICENSE---
+
+---BEGIN APACHE LICENSE, VERSION 2.0---
+
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+---END APACHE LICENSE, VERSION 2.0---

package/dist/build/assets/css-static-public-assets.d.ts

@@ -0,0 +1,22 @@
+import { type Plugin, type RenderBuiltAssetUrl } from "vite";
+import type { StaticPublicAssetProjection } from "./static-public-assets.ts";
+export type CssStaticPublicAssets = {
+    readonly jsAssets: ReadonlyMap<string, ReadonlyArray<JsAssetReference>>;
+    /** The plugins that resolve `@public/` URLs and record the assets that scripts reference. */
+    readonly plugins: ReadonlyArray<Plugin>;
+    readonly updateStaticPublicAssets: (staticPublicAssets: Pick<StaticPublicAssetProjection, "staticPublicAssetUrls">) => void;
+};
+/** Native URL-hook metadata for nonblocking resource hints. */
+export type JsAssetReference = {
+    readonly fileName: string;
+    readonly renderedUrl: ReturnType<RenderBuiltAssetUrl>;
+};
+/**
+ * Resolves `@public/` URLs in the stylesheets that Vite compiles, after
+ * Vite's own CSS processing, so that the application's PostCSS configuration
+ * and its CSS transformer run as they do without Vorma. The replacement runs
+ * before Vite extracts and hashes the stylesheet, so the stylesheet's file
+ * name follows the hashed URLs that it contains. Static public assets are already
+ * published.
+ */
+export declare function createCssStaticPublicAssets(staticPublicAssets: Pick<StaticPublicAssetProjection, "staticPublicAssetUrls">): CssStaticPublicAssets;

package/dist/build/assets/static-public-asset-plugin.d.ts

@@ -0,0 +1,20 @@
+import type { Plugin } from "vite";
+import type { StaticPublicAssetLookup } from "../inspection/inspect-projects.ts";
+import type { StaticPublicAsset } from "./static-public-assets.ts";
+/** The asset key as the static public assets map spells it: without a leading slash. */
+export declare function normalizeStaticPublicAssetKey(key: string): string;
+type StaticPublicAssetPluginInput = {
+    readonly lookups: ReadonlyArray<StaticPublicAssetLookup>;
+    readonly sourceTexts: ReadonlyMap<string, string>;
+    readonly staticPublicAssets: ReadonlyArray<StaticPublicAsset>;
+    readonly publicDir: string;
+    /** Native retained file references, keyed by the compiler's preliminary chunk filename. */
+    readonly referencedAssets: Map<string, Set<string>>;
+};
+type StaticPublicAssetPluginApi = {
+    readonly updateInput: (input: StaticPublicAssetPluginInput) => void;
+};
+export declare function createStaticPublicAssetPlugin(input: StaticPublicAssetPluginInput): Plugin<StaticPublicAssetPluginApi> & {
+    readonly api: StaticPublicAssetPluginApi;
+};
+export {};

package/dist/build/assets/static-public-assets.d.ts

@@ -0,0 +1,44 @@
+import { Effect } from "effect";
+import * as FileSystem from "effect/FileSystem";
+import * as Path from "effect/Path";
+import type { ApplicationSourceLayout } from "../config/source-layout.ts";
+export type StaticPublicAssetIssue = {
+    readonly _tag: "StaticPublicAssetIssue";
+    readonly sourcePath: string;
+    readonly msg: string;
+    readonly cause?: unknown;
+};
+export type StaticPublicAsset = {
+    readonly sourceKey: string;
+    readonly sourcePath: string;
+    /** Relative to the published public directory, with decoded path segments. */
+    readonly fileName: string;
+    readonly url: string;
+    readonly hash: string;
+};
+export type StaticPublicAssetProjection = {
+    readonly assets: ReadonlyArray<StaticPublicAsset>;
+    readonly staticPublicAssetUrls: Readonly<Record<string, string>>;
+    readonly uniqueStaticPublicAssetUrls: ReadonlyArray<string>;
+};
+/** The exact names that the public directory never publishes, at any depth. */
+export declare const IGNORED_STATIC_PUBLIC_ASSET_NAMES: ReadonlySet<string>;
+/** The prefix of the names that the public directory never publishes, at any depth. */
+export declare const IGNORED_STATIC_PUBLIC_ASSET_NAME_PREFIX = ".env.";
+/**
+ * Whether the public directory skips a file of this name: env files hold
+ * secrets by convention, and everything in the public output is public.
+ */
+export declare function testIgnoredStaticPublicAssetName(name: string): boolean;
+/**
+ * Hashes and publishes each static public asset's exact bytes, retaining only
+ * metadata. Entries named `.DS_Store` or `.env`, or starting with `.env.`, are
+ * skipped at every depth.
+ */
+export declare function collectStaticPublicAssets(config: ApplicationSourceLayout): Effect.Effect<StaticPublicAssetProjection, StaticPublicAssetIssue, FileSystem.FileSystem | Path.Path>;
+/** An asset key union type, one key per line, at the given tab depth. */
+export declare function renderAssetKeyDeclaration(input: {
+    readonly prefix: string;
+    readonly assets: ReadonlyArray<StaticPublicAsset>;
+    readonly depth: number;
+}): string;

package/dist/build/build-application.d.ts

@@ -0,0 +1,18 @@
+import { Effect, Path } from "effect";
+import type { ResolvedVormaConfig } from "./config/resolve-config.ts";
+/**
+ * Builds and publishes one production application while holding the build
+ * directory's lock, as `vorma build` does. `resolved` is the decoded and
+ * resolved configuration, in which every configured path is resolved against
+ * the directory of the configuration file that `core.importMetaUrl`
+ * identifies. The Vite configuration is the one that `client.viteConfigFile`
+ * names, whose `vorma({ config })` plugin receives the same configuration. The
+ * build writes into a staging directory inside the build directory and
+ * publishes it when it completes. It fails with every issue that it found,
+ * each described by its message.
+ */
+export declare function buildVormaApplication(input: {
+    readonly resolved: ResolvedVormaConfig;
+}): Effect.Effect<{
+    clientBuildId: string;
+}, import("./issues.ts").VormaBuildIssues, import("effect/process/ChildProcessSpawner").ChildProcessSpawner | import("effect/FileSystem").FileSystem | Path.Path>;

package/dist/build/{bundle-client.d.ts → bundling/bundle-client.d.ts}

@@ -1,10 +1,21 @@
-import { type ClientModule, type ClientViewModule } from "@vorma/protocol";
 import { Effect } from "effect";
 import * as FileSystem from "effect/FileSystem";
 import * as Path from "effect/Path";
-import type { ApplicationGeneration } from "./generate-application.ts";
+import type { ApplicationGeneration } from "../generation/generate-application.ts";
+import { type ClientModule } from "../publication/build-metadata.ts";
+/**
+ * The ids of the modules that Vorma names. Rolldown identifies a module by
+ * the form that Vite's `normalizePath` gives its path, so every comparison
+ * with a module id uses these.
+ */
+type EntryModuleIds = {
+    readonly clientEntry: string;
+    readonly criticalCssEntry: string | undefined;
+};
+export declare function getEntryModuleIds(generation: ApplicationGeneration): EntryModuleIds;
 export type ClientBundleIssue = {
     readonly _tag: "ClientBundleIssue";
+    readonly msg: string;
     readonly cause: unknown;
 };
 export type ClientBundle = {
@@ -12,7 +23,6 @@ export type ClientBundle = {
     readonly outputs: ReadonlyArray<{
         readonly fileName: string;
         readonly source: string | Uint8Array;
-        readonly immutable: boolean;
     }>;
     readonly chunks: ReadonlyArray<{
         readonly fileName: string;
@@ -23,7 +33,8 @@ export type ClientBundle = {
         readonly dynamicImports: ReadonlyArray<string>;
     }>;
     readonly clientEntry: ClientModule;
-    readonly clientViews: Readonly<Record<string, ClientViewModule>>;
+    readonly clientViews: Readonly<Record<string, ClientModule>>;
 };
-/** Builds browser entries directly into Vorma's prepared public directory. */
+/** Builds browser entries directly into the build directory's prepared public directory. */
 export declare function bundleClient(generation: ApplicationGeneration): Effect.Effect<ClientBundle, ClientBundleIssue, FileSystem.FileSystem | Path.Path>;
+export {};

package/dist/build/{client-output-hashing.d.ts → bundling/client-output-hashing.d.ts}

@@ -1,3 +1,3 @@
 import type { Plugin } from "vite";
 /** Native naming retains Vite's content hashing and dependency URL rewriting. */
-export declare function createClientOutputHashingPlugin(immutableFiles: Set<string>): Plugin;
+export declare function createClientOutputHashingPlugin(): Plugin;

package/dist/build/bundling/critical-css.d.ts

@@ -0,0 +1,19 @@
+import { Result } from "effect";
+import type { Rollup } from "vite";
+/**
+ * The critical stylesheet, minified whatever the application's Vite `minify`
+ * and `cssMinify` settings are. Vorma inlines it into every document that it
+ * serves, so its size costs every page load.
+ */
+export declare function minifyCriticalCss(input: {
+    readonly css: string;
+}): Result.Result<string, string>;
+/**
+ * Finds the configured critical stylesheet through Vite's module-to-CSS
+ * association. `sourceId` is the critical CSS entry's module id, the form in
+ * which each output names its modules.
+ */
+export declare function findCriticalCssFileName(input: {
+    readonly sourceId: string | undefined;
+    readonly outputs: ReadonlyArray<Rollup.OutputAsset | Rollup.OutputChunk>;
+}): Result.Result<string | undefined, string>;