@arcgis/lumina-compiler 4.32.0-next.13 → 4.32.0-next.131

package/LICENSE.md

@@ -1,6 +1,6 @@
 # Licensing
 
-COPYRIGHT © 2024 Esri
+COPYRIGHT © 2025 Esri
 
 All rights reserved under the copyright laws of the United States and applicable international laws, treaties, and conventions.
 

package/README.md

@@ -8,7 +8,7 @@ It is not intended to be used directly, but rather used as a dependency by other
 
 ## License
 
-COPYRIGHT © 2024 Esri
+COPYRIGHT © 2025 Esri
 
 All rights reserved under the copyright laws of the United States and applicable international laws, treaties, and conventions.
 

package/dist/context/index.d.ts

@@ -1,7 +1,7 @@
 import type { ConfigEnv, Plugin, ResolvedConfig, ViteDevServer } from "vite";
 import ts from "typescript";
 import type { ApiCssCustomProperty, ApiCustomElementDeclaration, ApiJson } from "@arcgis/api-extractor";
-import type { LuminaOptions, AssetSpec, AssetTransformer, DeclarationTextTransformer, ProvideAssetsOptions } from "../publicTypes";
+import type { LuminaOptions, AssetSpec, AssetTransformer, DeclarationTextTransformer, ProvideAssetsOptions, LintingOptions } from "../publicTypes";
 import type { ComponentPathMapping } from "../entrypoints/pathMapping";
 import type { DocsType } from "../docs/types";
 import type { ContextDirectories } from "./types";
@@ -64,14 +64,17 @@ export declare class CompilerContext {
      */
     shouldMinify: boolean;
     /**
-     * Like this.shouldMinifyStrict, but true when in test mode. Reasons:
+     * Like this.shouldMinify, but true when in test mode. Reasons:
      * - If accessing .textContent, the whitespace amount differs between minified
      *   and non-minified lit-html templates. In Stencil's JSX this was not the
      *   case. To ease migration of tests, we minify lit-html in tests too.
      * - From the above, you can see that minification does change semantics in
      *   some cases. To have tests be truer to the real world, we minify in tests.
+     *
+     * Also, true during build as per
+     * https://devtopia.esri.com/WebGIS/arcgis-web-components/issues/2084
      */
-    shouldMinifyStrict: boolean;
+    shouldMinifyJsx: boolean;
     /**
      *
      * A vite plugin that sets the initial context information based on Vite
@@ -288,21 +291,21 @@ export declare class CompilerContext {
     /**
      * Result of getCompilerOptionsForPrinter() call.
      *
-     * @internal
+     * @private
      */
     _compilerOptionsForPrinter: ReturnType<typeof getCompilerOptionsForPrinter>;
     /**
      * Cached result of getPrinter() call. Cached to not needlessly create and
      * throw away a printer instance for each transformed file.
      *
-     * @internal
+     * @private
      */
     _typeScriptPrinter: ReturnType<typeof getPrinter>;
     /**
      * Cached RegExp for replacing occurrences of `ArcgisCounter["el"]` with
      * `HtmlElementArcgisCounter`.
      *
-     * @internal
+     * @private
      */
     _htmlElementReferencesReplacer?: {
         regex: RegExp;
@@ -312,9 +315,15 @@ export declare class CompilerContext {
      * Mapping between component tag name and public properties in that component
      * whose type depends on another property.
      *
-     * @internal
+     * @private
      */
     _typeDependencies: Map<string, Set<string>>;
+    private _silencedRules;
+    /**
+     * Promise that resolves once src/lumina.ts is updated
+     * @private
+     */
+    _updateLuminaTsPromise?: Promise<void>;
     constructor(options: LuminaOptions);
     private _inferBuildSetup;
     /**
@@ -351,4 +360,5 @@ export declare class CompilerContext {
      * ```
      */
     provideAssets(assets: AssetSpec[], transformers?: AssetTransformer[], apply?: CompilerContext["viteCommand"]): void;
+    logLintError(rule: keyof LintingOptions["silence"], absoluteFilePath: string, error: string): void;
 }

package/dist/context/typeScript.d.ts

@@ -16,4 +16,4 @@ export declare function loadTypeScriptConfig(context: CompilerContext): void;
  * string
  */
 export declare function resolveTargetVersion(typeScriptConfig: Pick<ts.CompilerOptions, "target">): string;
-export declare function loadTypeScript(context: CompilerContext): void;
+export declare function loadTypeScript(context: CompilerContext, withSourceMap: boolean): void;

package/dist/dependencies/index.d.ts

@@ -10,3 +10,4 @@ export declare const doLoadersApply: (context: CompilerContext, htmlContext?: In
  *
  */
 export declare const provideDependencySupport: (context: CompilerContext) => Plugin;
+export declare const luminaTsUpdatedMessage: string;

package/dist/dependencies/updateLumina.d.ts

@@ -1,6 +1,6 @@
 import type { ResolvedDependencyComponents } from "./discover";
 import type { BrowserConfigOptions } from "vitest/node";
-export declare function updateLuminaTs(dependencies: readonly ResolvedDependencyComponents[], srcDir: string, hasCore: boolean, browserProvider?: BrowserConfigOptions["provider"], packageJson?: import("@arcgis/components-build-utils").MiniPackageJson): Promise<void>;
+export declare function updateLuminaTs(dependencies: readonly ResolvedDependencyComponents[], srcDir: string, hasCore: boolean, browserProvider?: BrowserConfigOptions["provider"], packageJson?: import("@arcgis/components-build-utils").MiniPackageJson): Promise<boolean>;
 declare function produceLuminaTs(dependencies: readonly ResolvedDependencyComponents[], hasCore: boolean, browserProvider?: BrowserConfigOptions["provider"], packageJson?: import("@arcgis/components-build-utils").MiniPackageJson): string;
 export declare const exportsForTests: {
     produceLuminaTs: typeof produceLuminaTs;

package/dist/docs/stencilDocsJson.d.ts

@@ -1,5 +1,109 @@
-import type { JsonDocs } from "@stencil/core/internal";
+import type { ComponentCompilerTypeReferences } from "@stencil/core/internal";
 import type { CompilerContext } from "../context";
+import { type ApiDocsTag } from "@arcgis/api-extractor";
+/**
+ * To avoid having a dependency on Stencil, we inline Stencil types rather than
+ * importing them.
+ */
+export interface JsonDocs {
+    components: JsonDocsComponent[];
+    timestamp: string;
+    compiler: {
+        name: string;
+        version: string;
+        typescriptVersion: string;
+    };
+    typeLibrary: Record<string, never>;
+}
+interface JsonDocsComponent {
+    filePath?: string;
+    encapsulation: "none" | "scoped" | "shadow";
+    tag: string;
+    readme: string;
+    docs: string;
+    docsTags: ApiDocsTag[];
+    overview?: string;
+    usage: Record<string, string>;
+    props: JsonDocsProp[];
+    methods: JsonDocsMethod[];
+    events: JsonDocsEvent[];
+    listeners: never[];
+    styles: {
+        name: string;
+        docs: string;
+        annotation: string;
+        mode: string | undefined;
+    }[];
+    slots: {
+        name: string;
+        docs: string;
+    }[];
+    parts: {
+        name: string;
+        docs: string;
+    }[];
+    dependents: string[];
+    dependencies: string[];
+    dependencyGraph: Record<string, never>;
+    deprecation?: string;
+}
+interface JsonDocsEvent {
+    event: string;
+    bubbles: boolean;
+    cancelable: boolean;
+    composed: boolean;
+    complexType: ComplexType;
+    docs: string;
+    docsTags: ApiDocsTag[];
+    deprecation?: string;
+    detail: string;
+}
+interface ComponentCompilerMethodComplexType {
+    signature: string;
+    parameters: {
+        name: string;
+        type: string;
+        docs: string;
+    }[];
+    references: ComponentCompilerTypeReferences;
+    return: string;
+}
+interface JsonDocsMethod {
+    name: string;
+    docs: string;
+    docsTags: ApiDocsTag[];
+    deprecation?: string;
+    signature: string;
+    returns: {
+        type: string;
+        docs: string;
+    };
+    parameters: ComponentCompilerMethodComplexType["parameters"];
+    complexType: ComponentCompilerMethodComplexType;
+}
+interface ComplexType {
+    original: string;
+    resolved: string;
+    references: ComponentCompilerTypeReferences;
+}
+export interface JsonDocsProp {
+    name: string;
+    complexType?: ComplexType;
+    type: string;
+    mutable: boolean;
+    attr?: string;
+    reflectToAttr: boolean;
+    docs: string;
+    docsTags: ApiDocsTag[];
+    default?: string;
+    deprecation?: string;
+    values: {
+        value?: string;
+        type: string;
+    }[];
+    optional: boolean;
+    required: boolean;
+}
 /**
  * Create a stencil-compatible docs.json file describing the library components.
  *
@@ -9,6 +113,8 @@ import type { CompilerContext } from "../context";
  * Since they are similar in content, generating a Stencil-compatible docs.json
  * will smooth the migration path.
  *
+ * REFACTOR: drop support for stencil compatible docs.json at some point
+ *
  * @remarks
  * To make it easier for people to diff the docs.json before and after migration
  * to Lit, we make sure that the order of properties matches what Stencil
@@ -16,3 +122,4 @@ import type { CompilerContext } from "../context";
  * https://github.com/ionic-team/stencil/blob/9f5f9cdd023b8c8dfb5417a1a970605ba724ae28/src/compiler/docs/generate-doc-data.ts#L98
  */
 export declare const generateStencilDocsJson: (context: CompilerContext) => JsonDocs;
+export {};

package/dist/docs/steniclDocsJson.test.d.ts

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

package/dist/extractor/declaration.d.ts

@@ -34,16 +34,11 @@
  *
  * FEATURE: for usages in tests, allow `static override tagName = "te-st";` to define a component? and adapt transformers and plugins to look for nested components too when context.isInTest
  */
-import ts from "typescript";
 import type { FileTransformer } from "../publicTypes";
 import type { DeclarationTextTransformer } from "../publicTypes";
 export declare const removeDeclarationFromDts: DeclarationTextTransformer;
 export declare const addCustomElementDecoratorTransformer: FileTransformer;
-export declare function findDeclaredComponentsInFile(file: ts.SourceFile): Map<string, string>;
-type DeclaredComponents = readonly (readonly [string, string])[];
-export declare function findDeclaredComponents(code: string): DeclaredComponents | undefined;
-export declare function validateTagName(tagName: string, className: string): void;
+export declare function findDeclaredComponents(code: string): readonly (readonly [string, string])[] | undefined;
 export declare const exportsForTests: {
     findDeclaredComponents: typeof findDeclaredComponents;
 };
-export {};

package/dist/extractor/extractor.d.ts

@@ -1,6 +1,6 @@
 import ts from "typescript";
 import { ApiExtractor } from "@arcgis/api-extractor";
-import type { ApiAttribute, ApiClassMethod, ApiCustomElementDeclaration, ApiCustomElementField, ApiCustomElementMember, ApiDeclaration, ApiEvent, ApiExport, ApiJson, ApiModule } from "@arcgis/api-extractor";
+import type { ApiAttribute, ApiClassMethod, ApiCustomElementDeclaration, ApiCustomElementField, ApiCustomElementMember, ApiDeclaration, ApiEvent, ApiExport, ApiJson, ApiModule, ApiReference } from "@arcgis/api-extractor";
 import type { CompilerContext } from "../context";
 export declare class LuminaApiExtractor extends ApiExtractor {
     context: CompilerContext;
@@ -44,7 +44,7 @@ export declare class LuminaApiExtractor extends ApiExtractor {
      * needs to be in a a file named like a component
      * (src/components/name/name.tsx), even if it is not a standalone component.
      */
-    protected inheritMembers(component: ApiCustomElementDeclaration, modules: ApiModule[], existingMembers?: Set<string>, existingAttributes?: Set<string>, existingEvents?: Set<string>): void;
+    protected inheritMembers(component: ApiCustomElementDeclaration, modules: ApiModule[], superClass?: ApiReference, existingMembers?: Set<string>, existingAttributes?: Set<string>, existingEvents?: Set<string>): void;
     private _resolvedInheritance;
     /**
      * Based on the superclass name, find the actual declaration in the modules.

package/dist/extractor/helpers/resolveType.d.ts

@@ -1,7 +1,8 @@
 import ts from "typescript";
 import type { ContextDirectories } from "../../context/types";
-import { type ApiReference } from "@arcgis/api-extractor";
+import { type ApiType } from "@arcgis/api-extractor";
 export declare const addPropMetadataPluginName = "@arcgis/lumina:addPropMetadata";
+export declare function resolveType(checker: ts.TypeChecker, type: ts.Type, sourceFile: ts.SourceFile, dirs: ContextDirectories, stripNullish?: boolean): ApiType;
 /**
  * Formats a TypeScript `TypeNode` entity as a string
  *
@@ -21,10 +22,6 @@ export declare const addPropMetadataPluginName = "@arcgis/lumina:addPropMetadata
  */
 export declare function typeNodeToString(typeNode: ts.TypeNode): string;
 export declare const typeFormatFlags: number;
-export declare function typeToResolvedTypeNodeWithReferences(checker: ts.TypeChecker, type: ts.Type, sourceFile: ts.SourceFile, dirs: ContextDirectories): {
-    typeNode: ts.TypeNode;
-    references: ApiReference[];
-};
 /**
  * Given an absolute path to a module, parse the package name and module name
  * in case of external module reference, or return relative path in case of

package/dist/extractor/helpers/typeValue.d.ts

@@ -38,7 +38,7 @@ import ts from "typescript";
  * Based on Stencil's resolveType function:
  * https://github.com/ionic-team/stencil/blob/b40ebb937869aa16f9adc672129639167406cd07/src/compiler/transformers/transform-utils.ts#L616
  */
-export declare function typeNodeToTypeValues(typeNode: ts.TypeNode): ApiValue[];
+export declare function typeNodeToTypeValues(typeNode: ts.TypeNode): ApiValue[] | undefined;
 export declare const hasLiteralTypeValue: (typeValues: ApiValue[] | undefined) => boolean;
 /**
  * If there is only a single type value, and it is of non-literal type, then

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 export { useLumina } from "./useLumina";
-export * from "./publicTypes";
+export type * from "./publicTypes";
 export { inferCdnUrl } from "./defaultAssetsUrl";
 export type { CompilerContext } from "./context";
 export { LuminaApiExtractor } from "./extractor/extractor";