@lynx-js/template-webpack-plugin-canary 0.7.2 → 0.8.0-canary-20250617-241fa2c2

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @lynx-js/template-webpack-plugin
 
+## 0.8.0-canary-20250617115045-241fa2c26be69a72f12fb42d17df3790a5350438
+
+### Minor Changes
+
+- Remove `EncodeCSSOptions` and `encodeCSS` to ensure consistent encoding options are used across CSS HMR updates and the main template. ([#1033](https://github.com/lynx-family/lynx-stack/pull/1033))
+
 ## 0.7.2
 
 ### Patch Changes
@@ -32,7 +38,7 @@
   example:
 
   ```js
-  import { defineConfig } from '@lynx-js/rspeedy';
+  import { defineConfig } from "@lynx-js/rspeedy";
 
   export default defineConfig({
     output: {
@@ -127,7 +133,7 @@
 - Add `defaultOverflowVisible` option to `LynxTemplatePlugin`. ([#78](https://github.com/lynx-family/lynx-stack/pull/78))
 
   ```js
-  import { LynxTemplatePlugin } from '@lynx-js/template-webpack-plugin';
+  import { LynxTemplatePlugin } from "@lynx-js/template-webpack-plugin";
 
   new LynxTemplatePlugin({
     defaultOverflowVisible: false,
@@ -146,10 +152,10 @@
 - 1abf8f0: Add `entryNames` parameter to `beforeEncode` hook.
 
   ```js
-  import { LynxTemplatePlugin } from '@lynx-js/template-webpack-plugin';
+  import { LynxTemplatePlugin } from "@lynx-js/template-webpack-plugin";
 
   const hooks = LynxTemplatePlugin.getLynxTemplatePluginHooks(compilation);
-  hooks.beforeEncode.tap('MyPlugin', ({ entryNames }) => {
+  hooks.beforeEncode.tap("MyPlugin", ({ entryNames }) => {
     console.log(entryNames);
   });
   ```

package/lib/LynxEncodePlugin.d.ts

@@ -1,6 +1,4 @@
 import type { Compiler } from 'webpack';
-import type { EncodeCSSOptions } from './css/encode.js';
-import type { CSS } from './index.js';
 /**
  * The options for LynxEncodePluginOptions
  *
@@ -29,27 +27,6 @@ export declare class LynxEncodePlugin {
      */
     static BEFORE_EMIT_STAGE: number;
     constructor(options?: LynxEncodePluginOptions | undefined);
-    /**
-     * Encode CSS chunks into a template.
-     *
-     * @param cssChunks - The CSS chunks' content.
-     * @param options - The encode options.
-     * @returns The buffer of the template.
-     *
-     * @example
-     * ```
-     * (await encodeCSS(
-     *   '.red { color: red; }',
-     *   {
-     *     targetSdkVersion: '3.2',
-     *     enableCSSSelector: true,
-     *   },
-     * )).toString('base64'),
-     * ```
-     */
-    static encodeCSS(cssChunks: string[], options: EncodeCSSOptions, plugins?: CSS.Plugin[], encode?: (options: any) => Promise<{
-        buffer: Buffer;
-    }>): Promise<Buffer>;
     /**
      * `defaultOptions` is the default options that the {@link LynxEncodePlugin} uses.
      *
@@ -86,4 +63,3 @@ export declare class LynxEncodePluginImpl {
 }
 export declare function isDebug(): boolean;
 export declare function isRsdoctor(): boolean;
-export type { EncodeCSSOptions } from './css/encode.js';

package/lib/LynxEncodePlugin.js

@@ -24,30 +24,6 @@ export class LynxEncodePlugin {
     constructor(options) {
         this.options = options;
     }
-    /**
-     * Encode CSS chunks into a template.
-     *
-     * @param cssChunks - The CSS chunks' content.
-     * @param options - The encode options.
-     * @returns The buffer of the template.
-     *
-     * @example
-     * ```
-     * (await encodeCSS(
-     *   '.red { color: red; }',
-     *   {
-     *     targetSdkVersion: '3.2',
-     *     enableCSSSelector: true,
-     *   },
-     * )).toString('base64'),
-     * ```
-     */
-    static async encodeCSS(cssChunks, options, plugins, 
-    // biome-ignore lint/suspicious/noExplicitAny: <explanation>
-    encode) {
-        const { encodeCSS } = await import('./css/encode.js');
-        return encodeCSS(cssChunks, options, plugins, encode);
-    }
     /**
      * `defaultOptions` is the default options that the {@link LynxEncodePlugin} uses.
      *

package/lib/LynxTemplatePlugin.d.ts

@@ -2,6 +2,11 @@ import { AsyncSeriesBailHook, AsyncSeriesWaterfallHook, SyncWaterfallHook } from
 import type { Asset, Compilation, Compiler } from 'webpack';
 import type * as CSS from '@lynx-js/css-serializer';
 import { cssChunksToMap } from './css/cssChunksToMap.js';
+/**
+ * The options for encoding a Lynx bundle.
+ *
+ * @public
+ */
 export interface EncodeOptions {
     manifest: Record<string, string | undefined>;
     compilerOptions: Record<string, string | boolean>;
@@ -66,7 +71,7 @@ export interface TemplateHooks {
      */
     encode: AsyncSeriesBailHook<{
         encodeOptions: EncodeOptions;
-        intermediate: string;
+        intermediate?: string;
     }, {
         buffer: Buffer;
         debugInfo: string;

package/lib/index.d.ts

@@ -4,9 +4,9 @@
  * A webpack plugin that simplifies creation of `template.js` files to serve your bundles.
  */
 export { LynxTemplatePlugin } from './LynxTemplatePlugin.js';
-export type { LynxTemplatePluginOptions, TemplateHooks, } from './LynxTemplatePlugin.js';
+export type { LynxTemplatePluginOptions, TemplateHooks, EncodeOptions, } from './LynxTemplatePlugin.js';
 export { LynxEncodePlugin } from './LynxEncodePlugin.js';
-export type { LynxEncodePluginOptions, EncodeCSSOptions, } from './LynxEncodePlugin.js';
+export type { LynxEncodePluginOptions } from './LynxEncodePlugin.js';
 export { WebEncodePlugin } from './WebEncodePlugin.js';
 export * as CSSPlugins from './css/plugins/index.js';
 export * as CSS from './css/index.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lynx-js/template-webpack-plugin-canary",
-  "version": "0.7.2",
+  "version": "0.8.0-canary-20250617-241fa2c2",
   "description": "Simplifies creation of Lynx template files to serve your webpack bundles",
   "keywords": [
     "webpack",

package/lib/css/encode.d.ts

@@ -1,27 +0,0 @@
-import type { CSS } from '../index.js';
-/**
- * The options for encoding CSS.
- *
- * @public
- */
-export interface EncodeCSSOptions {
-    /**
-     * {@inheritdoc @lynx-js/react-rsbuild-plugin#PluginReactLynxOptions.enableCSSSelector}
-     */
-    enableCSSSelector: boolean;
-    /**
-     * {@inheritdoc @lynx-js/react-rsbuild-plugin#PluginReactLynxOptions.enableRemoveCSSScope}
-     */
-    enableRemoveCSSScope: boolean;
-    /**
-     * {@inheritdoc @lynx-js/react-rsbuild-plugin#PluginReactLynxOptions.enableCSSInvalidation}
-     */
-    enableCSSInvalidation: boolean;
-    /**
-     * {@inheritdoc @lynx-js/react-rsbuild-plugin#PluginReactLynxOptions.enableRemoveCSSScope}
-     */
-    targetSdkVersion: string;
-}
-export declare function encodeCSS(cssChunks: string[], { enableCSSSelector, enableRemoveCSSScope, enableCSSInvalidation, targetSdkVersion, }: EncodeCSSOptions, plugins?: CSS.Plugin[], encode?: (options: any) => Promise<{
-    buffer: Buffer;
-}>): Promise<Buffer>;

package/lib/css/encode.js

@@ -1,43 +0,0 @@
-// Copyright 2024 The Lynx Authors. All rights reserved.
-// Licensed under the Apache License Version 2.0 that can be found in the
-// LICENSE file in the root directory of this source tree.
-import { removeFunctionWhiteSpace } from '@lynx-js/css-serializer/dist/plugins/removeFunctionWhiteSpace.js';
-import { cssChunksToMap } from './cssChunksToMap.js';
-export async function encodeCSS(cssChunks, { enableCSSSelector, enableRemoveCSSScope, enableCSSInvalidation, targetSdkVersion, }, plugins = [removeFunctionWhiteSpace()], 
-// biome-ignore lint/suspicious/noExplicitAny: <explanation>
-encode = (options) => {
-    const buffer = Buffer.from(JSON.stringify(options));
-    return Promise.resolve({
-        buffer,
-    });
-}) {
-    const css = cssChunksToMap(cssChunks, plugins, enableCSSSelector);
-    const encodeOptions = {
-        compilerOptions: {
-            // Do not remove this, it will crash :)
-            enableFiberArch: true,
-            useLepusNG: true,
-            bundleModuleMode: 'ReturnByFunction',
-            enableCSSSelector,
-            enableCSSInvalidation,
-            targetSdkVersion,
-        },
-        sourceContent: {
-            appType: 'card',
-            config: {
-                lepusStrict: true,
-                enableRemoveCSSScope,
-            },
-        },
-        css,
-        manifest: {},
-        lepusCode: {
-            root: undefined,
-            lepusChunk: {},
-        },
-        customSections: {},
-    };
-    const { buffer } = await encode(encodeOptions);
-    return buffer;
-}
-//# sourceMappingURL=encode.js.map