@arcgis/lumina-compiler 4.31.0-next.100

package/dist/plugins/loadLitCss.d.ts

@@ -0,0 +1,89 @@
+/**
+ * This file has a companion `@arcgis/lumina/typings/loadLitCss.d.ts`. Edits
+ * to this file may need to be reflected there too
+ */
+import type { Plugin } from "vite";
+import type { CompilerContext } from "../context";
+/**
+ * The `.adoptedStyleSheets` API is very convenient, but it has one issue: it
+ * has higher precedence order than the `<link>` or `<style>` tags. This API was
+ * designed with apps in mind, not libraries.
+ *
+ * As a workaround, we are wrapping the CSS in a `@layer {}` syntax to reduce
+ * it's precedence.
+ *
+ * More information:
+ * https://discord.com/channels/1012791295170859069/1274527043614150708
+ */
+export declare const layeredCssFlag = "?layered";
+/**
+ * During build, we insert a side-effect import into the loader.ts file purely
+ * so that the transform() is triggered for that file so that we can piggy back
+ * on the transformed output (and create a separate .css file out of it). We do
+ * not intend for such file to be included in the JS bundle in the NPM build.
+ * Such import will be dropped by the minifier.
+ *
+ * It's a bit hacky, but that is needed to workaround this Vite behavior:
+ * https://github.com/vitejs/vite/pull/11469#:~:text=Further%2C%20this.load%20is%20supposed%20to%20trigger%20transform%20and%20moduleParsed%20%2D%20this%20does%20not%20(in%20accordance%20with%20vite%27s%20on%2Ddemand%20nature
+ */
+export declare const globalCssFlag = "?global";
+/**
+ * Given a CSS file like:
+ *
+ * ```css
+ * // counter.css
+ * :host {
+ *   display: flex;
+ *   gap: 1rem;
+ * }
+ * button {
+ *   padding: 1rem;
+ * }
+ * ```
+ *
+ * and an import like this:
+ *
+ * ```ts
+ * import styles from './counter.css';
+ * export class ArcgisCounter extends LitElement {
+ *  static override styles = [styles];
+ * }
+ * ```
+ *
+ * This plugin will tell Vite to inline the css file (rather than produce a
+ * separate asset). Vite transformer will transform the css file into this:
+ *
+ * ```js
+ * export default ":host{display:flex;gap:1rem}button{padding:1rem}"
+ * ```
+ *
+ * Then, we augment it into this:
+ * ```js
+ * import { css } from 'lit';
+ * const styles = css`:host{display:flex;gap:1rem}button{padding:1rem}`;
+ * export default styles;
+ * ```
+ *
+ * The Lumina runtime later loads it like this:
+ *
+ * ```js
+ * host.adoptedStyleSheets = [...document.adoptedStyleSheets, styles.styleSheet];
+ * // Host is the shadow root of the component for shadow root components. Host
+ * // is the document for non-shadow root components or global styles.
+ * ```
+ *
+ * @remarks
+ * We inline the css rather than produce a separate asset because:
+ * - Loading assets adds complexity:
+ *   - need to call getAssetPath() to get correct asset location
+ *     (can't do that easily in a .css file)
+ *   - the consuming application might not have had the chance to call
+ *     setAssetPath() yet when getAssetPath() is called by us
+ *   - the network request might fail
+ * - Loading assets creates "a flash of unstyled content" issue (i.e font
+ *   changing after being loaded)
+ *
+ * Same goes for assets references inside the css file (icons and fonts) - they
+ * will be inlined as base64 to simplify our life.
+ */
+export declare const loadLitCss: (context: CompilerContext) => Plugin;

package/dist/plugins/printTotalBuildSize.d.ts

@@ -0,0 +1,7 @@
+import type { Plugin } from "vite";
+import type { CompilerContext } from "../context";
+/**
+ * Augmenting vite's default reporter to not just report bundle sizes, but to
+ * also print the total size
+ */
+export declare const printTotalBuildSize: (context: CompilerContext) => Plugin;

package/dist/plugins/provideAssets.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Utilities for making Vite copy assets to the output folder during build or
+ * serve them when in serve mode
+ *
+ * This is similar to Vite's public directory, except that you can provide
+ * multiple directories and re-map the path at which the files are served.
+ *
+ * @remarks
+ * The functionality is similar to
+ * https://github.com/nguyenbatranvan/vite-multiple-assets/blob/main/packages/libs/index.ts
+ *
+ * But with improvements:
+ * - support scoping assets
+ * - copy files in parallel rather than sequentially
+ * - greater type safety and uses modern Node.js features
+ * - transform the assets (i.e minify JSON)
+ */
+import type { CompilerContext } from "../context";
+import type { AssetSpec, AssetTransformer } from "../publicTypes";
+import type { ContextDirectories } from "../context/types";
+export declare function serveAssets(context: CompilerContext, assets: AssetSpec[], transformers?: AssetTransformer[]): void;
+export declare function writeAssets(context: CompilerContext, assets: AssetSpec[], transformers?: AssetTransformer[]): Promise<void>;
+/**
+ * If trying to serve a file and destination does not include file name, take
+ * file name from source
+ */
+declare function addImplicitDistFileName(spec: AssetSpec): string;
+/**
+ * Taking an absolute or relative destination path, resolve it as follows:
+ * - Make absolute path be relative to the output base
+ * - Prepend relative path with the serve base
+ * - Ensure the resulting path does not escape above the output directory
+ * - Ensure the path separators are correct for the current system
+ */
+declare function resolveDistPath({ dist, distCdnAssets }: Pick<ContextDirectories, "dist" | "distCdnAssets">, rawDestination: string): string;
+/**
+ * Take a resolved absolute file path in the dist directory, and from it infer
+ * the path at which the file will be served.
+ */
+declare function resolveServePath(baseUrl: string, resolvedDistPath: string, distCdnDir: string): string;
+/**
+ * Given an array of absolute paths, make sure a parent directory for each file
+ * exists
+ */
+export declare function makeDirectoriesForFiles(files: readonly string[]): Promise<void>;
+export declare const minifyJsonTransformer: AssetTransformer;
+export declare const defaultAssetTransformers: AssetTransformer[];
+export declare const exportsForTests: {
+    addImplicitDistFileName: typeof addImplicitDistFileName;
+    resolveDistPath: typeof resolveDistPath;
+    resolveServePath: typeof resolveServePath;
+};
+export {};

package/dist/plugins/provideAssets.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/plugins/setAssetsPath.d.ts

@@ -0,0 +1,10 @@
+import type { Plugin } from "vite";
+import type { CompilerContext } from "../context";
+/**
+ * Plugin to set the base URL for assets in the package
+ *
+ * @remarks
+ * In `@arcgis/storybook-utils` this plugin is removed so that the original
+ * base URL is used (./)
+ */
+export declare const setAssetPath: (context: CompilerContext) => Plugin;

package/dist/plugins/updatePackageJson.d.ts

@@ -0,0 +1,9 @@
+import type { MiniPackageJson } from "../utils/packageJson";
+import type { CompilerContext } from "../context";
+import type { Plugin } from "vite";
+export declare const updatePackageJson: (context: CompilerContext) => Plugin;
+declare function doPackageJsonUpdate(packageJson: MiniPackageJson, context: Pick<CompilerContext, "dir" | "documentationFileNames">): MiniPackageJson | undefined;
+export declare const exportsForTests: {
+    doPackageJsonUpdate: typeof doPackageJsonUpdate;
+};
+export {};

package/dist/plugins/updatePackageJson.spec.d.ts

@@ -0,0 +1 @@
+export {};