@arcgis/lumina-compiler 5.0.0-next.99 → 5.0.0

package/LICENSE.md

@@ -4,10 +4,14 @@ COPYRIGHT © Esri
 
 All rights reserved under the copyright laws of the United States and applicable international laws, treaties, and conventions.
 
-This material is licensed for use under the Esri Master License Agreement (MLA), and is bound by the terms of that agreement. You may redistribute and use this code without modification, provided you adhere to the terms of the MLA and include this copyright notice.
+This material is licensed for use under the [Esri Master License Agreement (MLA)](https://www.esri.com/content/dam/esrisites/en-us/media/legal/ma-full/ma-full.pdf), and is bound by the terms of that agreement.
+You may redistribute and use this code without modification, provided you adhere to the terms of the MLA and include this copyright notice.
 
-See use restrictions at http://www.esri.com/legal/pdfs/mla_e204_e300/english
+For additional information, contact:
+Environmental Systems Research Institute, Inc.
+Attn: Contracts and Legal Services Department
+380 New York Street
+Redlands, California, USA 92373
+USA
 
-For additional information, contact: Environmental Systems Research Institute, Inc. Attn: Contracts and Legal Services Department 380 New York Street Redlands, California, USA 92373 USA
-
-email: contracts@esri.com
+email: legal@esri.com

package/README.md

@@ -1,4 +1,4 @@
-# ArcGIS Maps SDK for JavaScript - Lit
+# ArcGIS Maps SDK for JavaScript - Lumina Compiler
 
 **No Esri Technical Support included.**
 
@@ -8,6 +8,5 @@ It is not intended to be used directly, but rather used as a dependency by other
 
 ## License
 
-COPYRIGHT © Esri
-
-This package is licensed under the terms described in the `LICENSE.md` file, located in the root of the package.
+This package is licensed under the terms described in the `LICENSE.md` file, located in the root of the package, and at https://js.arcgis.com/5.0/LICENSE.txt.
+For third party notices, see https://js.arcgis.com/5.0/third-party-notices.txt.

package/dist/context/index.d.ts

@@ -1,49 +1,16 @@
 import { ConfigEnv, Plugin, ResolvedConfig, ViteDevServer } from 'vite';
 import { default as ts } from 'typescript';
-import { ApiCssCustomProperty, ApiCustomElementDeclaration, ApiJson, unsafeGetUndocumentedPrinter } from '@arcgis/api-extractor';
-import { LuminaOptions, AssetSpec, AssetTransformer, DeclarationTextTransformer, ProvideAssetsOptions, LintingOptions } from '../publicTypes.ts';
-import { ComponentPathMapping } from '../entrypoints/pathMapping.ts';
+import { ApiCustomElementDeclaration, ApiJson } from '@arcgis/api-extractor/apiJson';
+import { LuminaOptions, AssetSpec, AssetTransformer, ProvideAssetsOptions, LintingOptions } from '../publicTypes.ts';
 import { DocsType } from '../docs/types.ts';
 import { ContextDirectories } from './types.ts';
 import { makeLoaders, computeServeOnlyDependencies } from '../dependencies/loaders.ts';
-import { parseStoryFiles } from '../extractor/parseStoryFiles.ts';
 import { CustomElementInterdependencies } from '../entrypoints/config.ts';
-import { getCompilerOptionsForPrinter } from '../transformers/index.ts';
 import { getLocalDefinedComponentsFromApiJson } from '../entrypoints/resolveTagName.ts';
-import { Deferred } from '@arcgis/toolkit/promise';
+import { unsafeGetUndocumentedPrinter } from '@arcgis/api-extractor/utils/internalTypeScriptApis';
+import { ApiExtractor } from '@arcgis/api-extractor/extractor/ApiExtractor';
+import { ApiExtractorPluginConfig } from '@arcgis/api-extractor/vite/plugin';
 export declare class CompilerContext {
-    /**
-     * The path to the resolved TypeScript configuration
-     */
-    typeScriptConfigPath: string;
-    /**
-     * The parsed TypeScript configuration
-     */
-    typeScriptConfig: ts.CompilerOptions;
-    /**
-     * An instance of TypeScript program. Contains all .tsx source files present
-     * in the project.
-     *
-     * TypeScript program is created only in build mode and in storybook. It
-     * is not created in serve.
-     */
-    typeScriptProgram?: ts.Program;
-    /**
-     * An instance of TypeScript type checker.
-     *
-     * TypeScript type checker is created only in build mode and in storybook. It
-     * is not created in serve.
-     */
-    typeScriptTypeChecker?: ts.TypeChecker;
-    /**
-     * A TypeScript watcher program. Created only when running under Storybook in
-     * serve mode.
-     */
-    typeScriptWatchProgram?: ts.WatchOfConfigFile<ts.BuilderProgram>;
-    /**
-     * An instance of TypeScript compiler host
-     */
-    typeScriptHost: ts.CompilerHost;
     /**
      * TypeScript source file instances created in serve mode
      *
@@ -51,13 +18,12 @@ export declare class CompilerContext {
      */
     private readonly _typeScriptSourceFiles;
     /**
-     * Used in Storybook watch mode. Resolves once TypeScript program is
-     * re-created in response to a file change. This is used to halt the Vite from
-     * doing hot-module-reload until the TypeScript program is re-created.
+     * A promise for after tsconfig.json and api-extractor.config.ts are loaded
+     * and list of files in current project are resolved.
      *
      * @private
      */
-    _typeScriptReload?: Deferred<void>;
+    configsPromise: Promise<void>;
     /**
      * Whether minification is enabled for transformed JSX (lit-html templates)
      * and generated component code.
@@ -83,11 +49,15 @@ export declare class CompilerContext {
      * @private
      */
     readonly _plugin: Plugin;
-    private _startCollectingComponentStories;
     /**
      * List of directories of common interest to the compiler
      */
     dir: ContextDirectories;
+    apiExtractor: ApiExtractor | undefined;
+    /**
+     * @private
+     */
+    apiExtractorPluginConfig: ApiExtractorPluginConfig;
     /**
      * The api.json stores information about the structure of all components in
      * the package (their properties, methods, events, JSDoc and etc).
@@ -109,38 +79,17 @@ export declare class CompilerContext {
      * Resolves once api.json is first generated during a given build run.
      * @private
      */
-    apiJsonDeferred: Deferred<void>;
+    apiJsonDeferred: PromiseWithResolvers<void> | undefined;
     /**
      * In some test environments, api.json will never be produced.
      */
     apiJsonEnabled: boolean;
-    /**
-     * @private
-     */
-    _componentPathMapping: ComponentPathMapping;
     /**
      * Cached result of getLocalDefinedComponentsFromApiJson() call
      *
      * @private
      */
     _localDefinedComponents?: ReturnType<typeof getLocalDefinedComponentsFromApiJson>;
-    /**
-     * Mapping of css files and which components they are imported in.
-     *
-     * @private
-     */
-    readonly _cssImports: Map<string, Set<string> | undefined>;
-    /**
-     * Mapping of CSS file names to docs extracted from them.
-     *
-     * CSS files are read during the file transform stage, which is after the
-     * api.json is extracted. This unfortunately means that we have to mutate
-     * the api.json after the fact to add the CSS docs. Furthermore, when api.json
-     * is re-generated, we need to re-add the CSS docs previously extracted.
-     *
-     * @private
-     */
-    _cssDocs?: Map<string, ApiCssCustomProperty[] | undefined>;
     /**
      * The environment that Vite is running in
      *
@@ -218,15 +167,6 @@ export declare class CompilerContext {
      */
     isFullApiExtraction: boolean;
     readonly banner: string;
-    /**
-     * `@arcgis/lumina-compiler` plugins may register additional `.d.ts`
-     * transformers. For public consumption of Lumina, instead of using this
-     * option, use the `types.declarationTextTransformers` option on the
-     * `useLumina` Vite plugin.
-     *
-     * @private
-     */
-    readonly _declarationTextTransformers: DeclarationTextTransformer[];
     /**
      * Options passed to `useLumina()`
      */
@@ -259,16 +199,10 @@ export declare class CompilerContext {
     assetsToProvide: ProvideAssetsOptions[] | undefined;
     /**
      * A promise that resolves to list of file names that declare one or more
-     * components
+     * components. This promise only represents the initial scan and is not updated
+     * in watch or serve mode.
      */
-    componentFilesPromise: Promise<typeof this.componentFiles>;
-    /**
-     * A list of file names that declare one or more components
-     */
-    componentFiles: string[];
-    componentStoryFiles: string[];
-    componentStoriesPromise?: Promise<void>;
-    componentStories?: Awaited<ReturnType<typeof parseStoryFiles>>;
+    componentFilesPromise: Promise<string[]>;
     /**
      * Style for hiding custom elements before they are loaded. This is appended
      * to the global stylesheet.
@@ -303,12 +237,6 @@ export declare class CompilerContext {
      * @private
      */
     _customElementDependencies: CustomElementInterdependencies;
-    /**
-     * Result of getCompilerOptionsForPrinter() call.
-     *
-     * @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.
@@ -316,23 +244,12 @@ export declare class CompilerContext {
      * @private
      */
     _typeScriptPrinter: ReturnType<typeof unsafeGetUndocumentedPrinter>;
-    /**
-     * Cached RegExp for replacing occurrences of `ArcgisCounter["el"]` with
-     * `HtmlElementArcgisCounter`.
-     *
-     * @private
-     */
-    _htmlElementReferencesReplacer?: {
-        regex: RegExp;
-        replacements: Record<string, string>;
-    };
     private _silencedRules;
     /**
      * Promise that resolves once src/lumina.ts is updated
      * @private
      */
     _updateLuminaTsPromise?: Promise<void>;
-    private _didCallOptions;
     /** @private */
     _originalRollupInputOptions?: Record<string, string> | undefined;
     constructor(options: LuminaOptions);

package/dist/context/typeScript.d.ts

@@ -1,19 +1,6 @@
-import { default as ts } from 'typescript';
 import { CompilerContext } from './index.ts';
-/**
- * In build mode, vite-plugin-dts already parses tsconfig. However, it
- * overwrites the resolved tsconfig.target with ESNext, which is not what we
- * want (we need the real tsconfig.target for the CDN build). Thus, we have
- * to resolve the tsconfig ahead of time manually.
- *
- * In dev server, practically the only use for a TypeScript config is the
- * getPrinter() call. It's also used in ts.createSourceFile(), but looks
- * like that can be safely called with the latest target.
- */
-export declare function loadTypeScriptConfig(context: CompilerContext): void;
 /**
  * Convert TypeScript ECMA target version number into an ESBuild target version
  * string
  */
-export declare function resolveTargetVersion(typeScriptConfig: Pick<ts.CompilerOptions, "target">): string;
-export declare function loadTypeScript(context: CompilerContext, withSourceMap: boolean): void;
+export declare function resolveTargetVersion(context: CompilerContext): string;

package/dist/context/utils.d.ts

@@ -1,4 +1,4 @@
-export declare function inferPreamble(packageJson?: import('@arcgis/components-build-utils').MiniPackageJson): string;
+export declare function inferPreamble(packageJson?: import('@arcgis/components-build-utils').PackageJson): string;
 export declare const preambleToComment: (preamble: string) => string;
 export declare const throwOnReadBeforeSet: (createdDuring: string) => PropertyDecorator;
 export declare function normalizeDocumentationFileName(fileName: string): string;

package/dist/dependencies/discover.d.ts

@@ -1,7 +1,6 @@
-import { MiniPackageJson } from '@arcgis/components-build-utils';
-import { ModulePath } from '../extractor/helpers/resolveType.ts';
+import { PackageJson } from '@arcgis/components-build-utils';
 import { WebTypes } from '../docs/webTypes/types.ts';
-import { ApiJson } from '@arcgis/api-extractor';
+import { ApiJson } from '@arcgis/api-extractor/apiJson';
 import { LuminaOptions } from '../publicTypes.ts';
 export type ResolvedDependencyComponents = {
     readonly packageName: string;
@@ -9,9 +8,11 @@ export type ResolvedDependencyComponents = {
     readonly components: Readonly<Record<string, ResolvedDependencyComponent>>;
     readonly cdnUrl?: string;
     readonly packageLocation: string;
-    readonly packageJson: MiniPackageJson;
+    readonly packageJson: PackageJson;
 };
-export type ResolvedDependencyComponent = ModulePath & {
+export type ResolvedDependencyComponent = {
+    modulePath: string;
+    packageName: string | undefined;
     /**
      * If jsx property has a static value, and we see that an equivalent attribute
      * exists, jsx property will be converted to an attribute rather than
@@ -58,11 +59,12 @@ export declare function findPackageComponents(packageName: string, cwd?: string)
 /**
  * Given the custom element manifest, find custom elements defined in it
  */
-export declare function manifestToDependencyComponents(manifest: Partial<ApiJson>, dependency: Omit<ModulePath, "moduleName"> & {
+export declare function manifestToDependencyComponents(manifest: Partial<ApiJson>, dependency: {
+    readonly packageName: string | undefined;
     readonly getImportPath: (tagName: string) => string;
 }, computeRequiredProperties?: boolean): ResolvedDependencyComponents["components"];
-export declare const webTypesToDependencyComponents: (webTypes: Partial<WebTypes>, dependency: Omit<ModulePath, "moduleName"> & {
-    readonly packageRoot: string | undefined;
+export declare const webTypesToDependencyComponents: (webTypes: Partial<WebTypes>, dependency: {
+    readonly packageName: string;
     readonly getImportPath: (tagName: string) => string;
 }) => ResolvedDependencyComponents["components"];
 export declare const inferDependencyComponentModuleName: (usesExports: boolean, tagName: string) => string;

package/dist/dependencies/updateLumina.d.ts

@@ -1,8 +1,8 @@
 import { ResolvedDependencyComponents } from './discover.ts';
 export declare function updateLuminaTs(dependencies: readonly ResolvedDependencyComponents[], srcDir: string, hasCore: boolean, 
 /** Preserved positional argument for compatibility because codemod was passing it */
-_unused?: never, packageJson?: import('@arcgis/components-build-utils').MiniPackageJson): Promise<boolean>;
-declare function produceLuminaTs(dependencies: readonly ResolvedDependencyComponents[], hasCore: boolean, packageJson?: import('@arcgis/components-build-utils').MiniPackageJson): string;
+_unused?: never, packageJson?: import('@arcgis/components-build-utils').PackageJson): Promise<boolean>;
+declare function produceLuminaTs(dependencies: readonly ResolvedDependencyComponents[], hasCore: boolean, packageJson?: import('@arcgis/components-build-utils').PackageJson): string;
 export declare const exportsForTests: {
     produceLuminaTs: typeof produceLuminaTs;
 };

package/dist/docs/config.d.ts

@@ -1,2 +1,9 @@
+import { CompilerContext } from '../context/index.ts';
 import { DocsType } from './types.ts';
 export declare const defaultDocsFileNames: Record<DocsType, string>;
+/**
+ * Minify docs .json files to reduce node_modules size (otherwise they account
+ * for 50% of component package size). Don't minify if Lumina is running in AWC's
+ * test package to allow for build snapshot diffs
+ */
+export declare const getDocsFileIndent: (context: CompilerContext) => 2 | undefined;

package/dist/docs/stencilDocsJson.d.ts

@@ -1,5 +1,5 @@
 import { CompilerContext } from '../context/index.ts';
-import { ApiDocsTag } from '@arcgis/api-extractor';
+import { ApiDocsTag } from '@arcgis/api-extractor/apiJson';
 /**
  * To avoid having a dependency on Stencil, we inline Stencil types rather than
  * importing them.

package/dist/docs/vsCodeCustomData/index.d.ts

@@ -1,5 +1,5 @@
 import { VsCodeHtmlDocs, VsCodeCssDocs } from './types.ts';
-import { ApiCustomElementDeclaration } from '@arcgis/api-extractor';
+import { ApiCustomElementDeclaration } from '@arcgis/api-extractor/apiJson';
 /**
  * Originally based on
  * https://github.com/break-stuff/cem-tools/tree/main/packages/vs-code-integration

package/dist/docs/vsCodeCustomData/utils.d.ts

@@ -1,3 +1,3 @@
 import { VsCodeTag } from './types.ts';
-import { ApiCustomElementDeclaration } from '@arcgis/api-extractor';
+import { ApiCustomElementDeclaration } from '@arcgis/api-extractor/apiJson';
 export declare const getTagList: (components: ApiCustomElementDeclaration[]) => VsCodeTag[];

package/dist/docs/webTypes/description.d.ts

@@ -1,4 +1,4 @@
-import { ApiClassMember, ApiCssCustomProperty, ApiCssPart, ApiCustomElementDeclaration, ApiEvent, ApiSlot } from '@arcgis/api-extractor';
+import { ApiClassMember, ApiCssCustomProperty, ApiCssPart, ApiCustomElementDeclaration, ApiEvent, ApiSlot } from '@arcgis/api-extractor/apiJson';
 export declare function getComponentDetailsTemplate(component: ApiCustomElementDeclaration): string;
 export declare const getSlotsTemplate: (slots?: ApiSlot[]) => string;
 export declare const getEventsTemplate: (events?: ApiEvent[]) => string;

package/dist/docs/webTypes/index.d.ts

@@ -1,5 +1,5 @@
 import { WebTypesOptions, WebTypesElement, WebTypes } from './types.ts';
-import { ApiCustomElementDeclaration } from '@arcgis/api-extractor';
+import { ApiCustomElementDeclaration } from '@arcgis/api-extractor/apiJson';
 /**
  * Originally based on
  * https://github.com/break-stuff/cem-tools/tree/main/packages/jet-brains-integration

package/dist/docs/webTypes/utils.d.ts

@@ -1,6 +1,6 @@
-import { ApiCustomElementDeclaration } from '@arcgis/api-extractor';
+import { ApiCustomElementDeclaration } from '@arcgis/api-extractor/apiJson';
 import { WebTypesAttribute, WebTypesCssProperty, WebTypesPseudoElement } from './types.ts';
 export declare const getCssPropertyList: (components: ApiCustomElementDeclaration[]) => WebTypesCssProperty[];
 export declare const getCssPartList: (components: ApiCustomElementDeclaration[]) => WebTypesPseudoElement[];
-export declare const getComponentAttributes: (component: ApiCustomElementDeclaration) => WebTypesAttribute[];
+export declare function getComponentAttributes(component: ApiCustomElementDeclaration): WebTypesAttribute[];
 export declare const formatDescription: (description?: string, deprecated?: boolean | string) => string;

package/dist/entrypoints/dtsUtils.d.ts

@@ -1,7 +1,5 @@
-import { DeclarationTextTransformer } from '../publicTypes.ts';
 import { path } from '@arcgis/components-build-utils';
 import { CompilerContext } from '../context/index.ts';
-export declare const rewriteDtsComponentFileNames: DeclarationTextTransformer;
 export declare const rePath: RegExp;
 /**
  * Rewrite references to `./components/component-folder-name/component-file-name.js` with
@@ -11,7 +9,7 @@ export declare const rePath: RegExp;
  * Assuming content includes POSIX paths only (as that's what import specifiers
  * in ECMAScript use)
  */
-export declare const rewriteComponentImportSpecifiers: (code: string, context: Pick<CompilerContext, "_componentPathMapping" | "dir">, cwd: string, originalCwd: string) => string;
+export declare const rewriteComponentImportSpecifiers: (code: string, context: Pick<CompilerContext, "apiExtractor" | "dir">, cwd: string, originalCwd: string) => string;
 /**
  * The result of relative() is a path that does not start with `./`.
  * In import statements the path must begin with ../ or ./ to be interpreted as

package/dist/entrypoints/findUtils.d.ts

@@ -1,16 +1,6 @@
-import { CompilerContext } from '../context/index.ts';
 /**
  * @example
  * `src/components/component-name/component-name.tsx` =>
  * `./components/component-name/customElement`
  */
 export declare const entrypointPathToDistPath: (sourceFileName: string, srcPath?: string) => string;
-/**
- * Finds all components in the src/components folder. With support for nested
- * components (looking for .tsx files whose name matches their folder name)
- */
-export declare const findComponentFiles: (context: CompilerContext, componentsDirectory: string, searchBase?: string) => Promise<string[]>;
-/**
- * Check if absolute file path looks like a component entrypoint
- */
-export declare function pathIsEntrypoint(absolutePath: string, componentsFolder: string): boolean;

package/dist/entrypoints/resolveTagName.d.ts

@@ -1,12 +1,17 @@
 import { ResolvedDependencyComponent } from '../dependencies/discover.ts';
-import { ModulePath } from '../extractor/helpers/resolveType.ts';
 import { CompilerContext } from '../context/index.ts';
 /**
  * Automatically add imports as appropriate for all referenced internally defined
  * and externally defined custom elements
  */
-export declare function resolveTagName(context: CompilerContext, tagName: string, fileName: string): ModulePath | undefined;
-export declare function modulePathToString(resolvedPath: ModulePath, distRelativeCwd: string): string;
+export declare function resolveTagName(context: CompilerContext, tagName: string, fileName: string): {
+    packageName: string | undefined;
+    modulePath: string;
+} | undefined;
+export declare function modulePathToString(resolvedPath: {
+    packageName: string | undefined;
+    modulePath: string;
+}, distRelativeCwd: string): string;
 export declare function getLocalDefinedComponentsFromApiJson(context: Pick<CompilerContext, "_localDefinedComponents" | "privateApiJson" | "viteCommand">): Readonly<Record<string, ResolvedDependencyComponent>>;
 export declare const exportsForTests: {
     modulePathToString: typeof modulePathToString;

package/dist/index.d.ts

@@ -1,11 +1,9 @@
 import { initializeComponentDependencies } from './dependencies/discover.ts';
 import { updateLuminaTs } from './dependencies/updateLumina.ts';
-import { findDeclaredComponent } from './extractor/declaration.ts';
 export { useLumina } from './useLumina.ts';
 export type * from './publicTypes.ts';
 export { inferCdnUrl } from './defaultAssetsUrl.ts';
 export type { CompilerContext } from './context/index.ts';
-export { LuminaApiExtractor } from './extractor/LuminaApiExtractor.ts';
 /**
  * These are exposed only for usage by the @arcgis/stencil-to-lumina codemod
  *
@@ -18,12 +16,10 @@ export declare const exportsForCodemod: {
         readonly common: Required<import('./jsxToLitHtml/config.ts').ElementPropertyToAttributeMappings>;
         readonly perElement: Record<string, import('./jsxToLitHtml/config.ts').ElementPropertyToAttributeMappings | undefined>;
     };
-    findDeclaredComponent: typeof findDeclaredComponent;
     nativeEvents: Set<string>;
     svgElements: Set<string>;
     mathMlElements: Set<string>;
     alwaysAttributes: Set<string>;
     nativeAlwaysAttributes: Set<string>;
     htmlAlwaysAttributes: Record<string, Set<string> | undefined>;
-    isPropertyEscapeNeeded: (name: string) => boolean;
 };