@lwc/ssr-compiler 0.0.1 → 6.6.1

package/LICENSE.md

@@ -0,0 +1,88 @@
+# LWC core license
+
+MIT LICENSE
+
+Copyright (c) 2024, Salesforce, Inc.
+All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS 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.
+
+# Licenses of bundled dependencies
+
+## @parse5/tools
+
+MIT license defined in package.json in v0.4.0.
+
+## entities
+
+Copyright (c) Felix Böhm
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+## estree-walker
+
+Copyright (c) 2015-20 [these people](https://github.com/Rich-Harris/estree-walker/graphs/contributors)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS 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.
+
+## observable-membrane
+
+MIT License
+
+Copyright (c) 2017 Salesforce
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS 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.
+
+## parse5
+
+Copyright (c) 2013-2019 Ivan Nikulin (ifaaan@gmail.com, https://github.com/inikulin)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS 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.

package/dist/compile-js/catalog-tmpls.d.ts

@@ -0,0 +1,8 @@
+import type { NodePath } from 'estree-toolkit';
+import type { ImportDeclaration } from 'estree';
+import type { ComponentMetaState } from './types';
+/**
+ * While traversing the component JS, this takes note of any .html files that are
+ * explicitly imported..
+ */
+export declare function catalogTmplImport(path: NodePath<ImportDeclaration>, state: ComponentMetaState): void;

package/dist/compile-js/generate-markup.d.ts

@@ -0,0 +1,15 @@
+import type { Program } from 'estree';
+import type { ComponentMetaState } from './types';
+/**
+ * This builds a generator function `generateMarkup` and adds it to the component JS's
+ * compilation output. `generateMarkup` acts as the glue between component JS and its
+ * template(s), including:
+ *
+ *  - managing reflection of attrs & props
+ *  - instantiating the component instance
+ *  - setting the internal state of that component instance
+ *  - invoking component lifecycle methods
+ *  - yielding the tag name & attributes
+ *  - deferring to the template function for yielding child content
+ */
+export declare function addGenerateMarkupExport(program: Program, state: ComponentMetaState, filename: string): void;

package/dist/compile-js/index.d.ts

@@ -0,0 +1,3 @@
+export default function compileJS(src: string, filename: string): {
+    code: string;
+};

package/dist/compile-js/lwc-import.d.ts

@@ -0,0 +1,10 @@
+import type { ImportDeclaration } from 'estree';
+import type { NodePath } from 'estree-toolkit';
+import type { ComponentMetaState } from './types';
+/**
+ * This accomplishes two things:
+ *
+ *  1. it replaces "lwc" with "@lwc/ssr-runtime" in an import specifier
+ *  2. it makes note of the local var name associated with the `LightningElement` import
+ */
+export declare function replaceLwcImport(path: NodePath<ImportDeclaration>, state: ComponentMetaState): void;

package/dist/compile-js/stylesheets.d.ts

@@ -0,0 +1,9 @@
+import type { NodePath } from 'estree-toolkit';
+import type { Program, ImportDeclaration } from 'estree';
+import type { ComponentMetaState } from './types';
+export declare function catalogStyleImport(path: NodePath<ImportDeclaration>, state: ComponentMetaState): void;
+/**
+ * This adds implicit style imports to the compiled component artifact.
+ */
+export declare function addStylesheetImports(ast: Program, state: ComponentMetaState, filepath: string): void;
+export declare function catalogStaticStylesheets(ids: string[], state: ComponentMetaState): void;

package/dist/compile-js/types.d.ts

@@ -0,0 +1,18 @@
+import type { traverse } from 'estree-toolkit';
+import type { Node } from 'estree';
+export type Visitors = Parameters<typeof traverse<Node, ComponentMetaState>>[1];
+export interface ComponentMetaState {
+    isLWC: boolean;
+    hasConstructor: boolean;
+    hasConnectedCallback: boolean;
+    hasRenderMethod: boolean;
+    hadRenderedCallback: boolean;
+    hadDisconnectedCallback: boolean;
+    hadErrorCallback: boolean;
+    lightningElementIdentifier: string | null;
+    lwcClassName: string | null;
+    tmplExplicitImports: Map<string, string> | null;
+    cssExplicitImports: Map<string, string> | null;
+    staticStylesheetIds: Set<string> | null;
+    reflectedPropsInPlay: Set<string>;
+}

package/dist/compile-template/comment.d.ts

@@ -0,0 +1,3 @@
+import type { Comment as IrComment } from '@lwc/template-compiler';
+import type { Transformer } from './types';
+export declare const Comment: Transformer<IrComment>;

package/dist/compile-template/component.d.ts

@@ -0,0 +1,3 @@
+import type { Component as IrComponent } from '@lwc/template-compiler';
+import type { Transformer } from './types';
+export declare const Component: Transformer<IrComponent>;

package/dist/compile-template/context.d.ts

@@ -0,0 +1,6 @@
+import type { ModuleDeclaration as EsModuleDeclaration, Statement as EsStatement } from 'estree';
+import type { TemplateOpts, TransformerContext } from './types';
+export declare function createNewContext(templateOptions: TemplateOpts): {
+    hoisted: Map<string, EsStatement | EsModuleDeclaration>;
+    cxt: TransformerContext;
+};

package/dist/compile-template/element.d.ts

@@ -0,0 +1,3 @@
+import type { Element as IrElement } from '@lwc/template-compiler';
+import type { Transformer } from './types';
+export declare const Element: Transformer<IrElement>;

package/dist/compile-template/expression.d.ts

@@ -0,0 +1,4 @@
+import type { ComplexExpression as IrComplexExpression, Expression as IrExpression } from '@lwc/template-compiler';
+import type { Expression as EsExpression } from 'estree';
+import type { TransformerContext } from './types';
+export declare function expressionIrToEs(node: IrExpression | IrComplexExpression, cxt: TransformerContext): EsExpression;

package/dist/compile-template/for-each.d.ts

@@ -0,0 +1,3 @@
+import type { ForEach as IrForEach } from '@lwc/template-compiler';
+import type { Transformer } from './types';
+export declare const ForEach: Transformer<IrForEach>;

package/dist/compile-template/if.d.ts

@@ -0,0 +1,4 @@
+import type { If as IrIf, IfBlock as IrIfBlock } from '@lwc/template-compiler';
+import type { Transformer } from './types';
+export declare const If: Transformer<IrIf>;
+export declare const IfBlock: Transformer<IrIfBlock>;

package/dist/compile-template/index.d.ts

@@ -0,0 +1,3 @@
+export default function compileTemplate(src: string, _filename: string): {
+    code: string;
+};

package/dist/compile-template/ir-to-es.d.ts

@@ -0,0 +1,9 @@
+import type { ChildNode as IrChildNode, Node as IrNode } from '@lwc/template-compiler';
+import type { Statement as EsStatement } from 'estree';
+import type { TemplateOpts, TransformerContext } from './types';
+export declare function irChildrenToEs(children: IrChildNode[], cxt: TransformerContext): EsStatement[];
+export declare function irToEs(node: IrNode, cxt: TransformerContext): EsStatement[];
+export declare function templateIrToEsTree(node: IrNode, contextOpts: TemplateOpts): {
+    hoisted: IterableIterator<import("estree").ModuleDeclaration | EsStatement>;
+    statements: EsStatement[];
+};

package/dist/compile-template/shared.d.ts

@@ -0,0 +1,6 @@
+import type { ImportDeclaration as EsImportDeclaration, Statement as EsStatement } from 'estree';
+export declare const bImportHtmlEscape: (...replacementNodes: (import("estree").Node | import("estree").Node[] | null)[]) => EsImportDeclaration;
+export declare const importHtmlEscapeKey = "import:htmlEscape";
+export declare function cleanStyleAttrVal(styleAttrVal: string): string;
+export declare const isValidIdentifier: (str: string) => boolean;
+export declare function optimizeAdjacentYieldStmts(statements: EsStatement[]): EsStatement[];

package/dist/compile-template/text.d.ts

@@ -0,0 +1,3 @@
+import type { Text as IrText } from '@lwc/template-compiler';
+import type { Transformer } from './types';
+export declare const Text: Transformer<IrText>;

package/dist/compile-template/types.d.ts

@@ -0,0 +1,16 @@
+import { Node as IrNode } from '@lwc/template-compiler';
+import type { ModuleDeclaration as EsModuleDeclaration, Statement as EsStatement } from 'estree';
+export type Transformer<T extends IrNode = IrNode> = (node: T, cxt: TransformerContext) => EsStatement[];
+export interface TransformerContext {
+    hoist: (stmt: EsStatement | EsModuleDeclaration, dedupeKey: string) => void;
+    pushLocalVars: (vars: string[]) => void;
+    popLocalVars: () => void;
+    isLocalVar: (varName: string | null | undefined) => boolean;
+    getUniqueVar: () => string;
+    templateOptions: TemplateOpts;
+    prevSibling?: IrNode;
+    nextSibling?: IrNode;
+}
+export interface TemplateOpts {
+    preserveComments: boolean;
+}

package/dist/estemplate.d.ts

@@ -0,0 +1,8 @@
+import type { Node as EsNode } from 'estree';
+export declare const placeholder = false;
+type ReplacementNode = EsNode | EsNode[] | null;
+type ReturnsBool = (node: EsNode | null) => boolean;
+export type Validator = ReturnsBool | typeof placeholder;
+export declare function esTemplate<RetType = EsNode, ArgTypes extends ReplacementNode[] = ReplacementNode[]>(javascriptSegments: TemplateStringsArray, ...validatorFns: Validator[]): (...replacementNodes: ArgTypes) => RetType;
+export declare function esTemplateWithYield<RetType = EsNode, ArgTypes extends ReplacementNode[] = ReplacementNode[]>(javascriptSegments: TemplateStringsArray, ...validatorFns: Validator[]): (...replacementNodes: ArgTypes) => RetType;
+export {};

package/dist/estree/builders.d.ts

@@ -0,0 +1,2 @@
+import type { ImportDeclaration } from 'estree';
+export declare const bImportDeclaration: (...replacementNodes: (import("estree").Node | import("estree").Node[] | null)[]) => ImportDeclaration;

package/dist/estree/validators.d.ts

@@ -0,0 +1,5 @@
+import type { Node } from 'estree';
+import type { Validator } from '../estemplate';
+export declare const isStringLiteral: (node: Node | null) => boolean;
+export declare const isIdentOrRenderCall: (node: Node | null) => boolean;
+export declare function isNullableOf(validator: Validator): (node: Node | null) => boolean;