@arcgis/lumina-compiler 5.0.0-next.6 → 5.0.0-next.61

package/dist/context/index.d.ts

@@ -1,6 +1,6 @@
 import { ConfigEnv, Plugin, ResolvedConfig, ViteDevServer } from 'vite';
 import { default as ts } from 'typescript';
-import { ApiCssCustomProperty, ApiCustomElementDeclaration, ApiJson } from '@arcgis/api-extractor';
+import { ApiCssCustomProperty, ApiCustomElementDeclaration, ApiJson, unsafeGetUndocumentedPrinter } from '@arcgis/api-extractor';
 import { LuminaOptions, AssetSpec, AssetTransformer, DeclarationTextTransformer, ProvideAssetsOptions, LintingOptions } from '../publicTypes';
 import { ComponentPathMapping } from '../entrypoints/pathMapping';
 import { DocsType } from '../docs/types';
@@ -9,7 +9,6 @@ import { makeLoaders, computeServeOnlyDependencies } from '../dependencies/loade
 import { parseStoryFiles } from '../extractor/parseStoryFiles';
 import { CustomElementInterdependencies } from '../entrypoints/config';
 import { getCompilerOptionsForPrinter } from '../transformers';
-import { getPrinter } from '../transformers/internalTypeScriptApis';
 import { getLocalDefinedComponentsFromApiJson } from '../entrypoints/resolveTagName';
 import { Deferred } from '@arcgis/toolkit/promise';
 export declare class CompilerContext {
@@ -316,7 +315,7 @@ export declare class CompilerContext {
      *
      * @private
      */
-    _typeScriptPrinter: ReturnType<typeof getPrinter>;
+    _typeScriptPrinter: ReturnType<typeof unsafeGetUndocumentedPrinter>;
     /**
      * Cached RegExp for replacing occurrences of `ArcgisCounter["el"]` with
      * `HtmlElementArcgisCounter`.
@@ -333,8 +332,6 @@ export declare class CompilerContext {
      * @private
      */
     _updateLuminaTsPromise?: Promise<void>;
-    normalizedDocumentationUrl: string;
-    alternativeDocumentationUrl: string;
     private _didCallOptions;
     /** @private */
     _originalRollupInputOptions?: Record<string, string> | undefined;

package/dist/dependencies/updateLumina.d.ts

@@ -1,7 +1,8 @@
 import { ResolvedDependencyComponents } from './discover';
-import { VitestBrowserModeProvider } from '../testing/vitestTypes';
-export declare function updateLuminaTs(dependencies: readonly ResolvedDependencyComponents[], srcDir: string, hasCore: boolean, browserProvider?: VitestBrowserModeProvider, packageJson?: import('@arcgis/components-build-utils').MiniPackageJson): Promise<boolean>;
-declare function produceLuminaTs(dependencies: readonly ResolvedDependencyComponents[], hasCore: boolean, browserProvider?: VitestBrowserModeProvider, packageJson?: import('@arcgis/components-build-utils').MiniPackageJson): string;
+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;
 export declare const exportsForTests: {
     produceLuminaTs: typeof produceLuminaTs;
 };

package/dist/entrypoints/config.d.ts

@@ -16,4 +16,3 @@ export type CustomElementInterdependencies = Record<string, {
     referencedDeferredTagNames: string[];
     readonly referencedBy: string[];
 }>;
-export declare const defaultBrowserTestProvider = "playwright";

package/dist/extractor/{extractor.d.ts → LuminaApiExtractor.d.ts}

@@ -1,19 +1,22 @@
 import { default as ts } from 'typescript';
-import { ApiExtractor, ApiAttribute, ApiClassMethod, ApiCustomElementDeclaration, ApiCustomElementField, ApiCustomElementMember, ApiDeclaration, ApiEvent, ApiExport, ApiJson, ApiModule, ApiReference, CopyDocDefinitions } from '@arcgis/api-extractor';
+import { ApiExtractor, ApiAttribute, ApiClassMethod, ApiCustomElementDeclaration, ApiCustomElementField, ApiCustomElementMember, ApiDeclaration, ApiEvent, ApiJson, ApiModule, ApiReference, CopyDocDefinitions } from '@arcgis/api-extractor';
 import { CompilerContext } from '../context';
 export declare class LuminaApiExtractor extends ApiExtractor {
     context: CompilerContext;
-    protected isPathOnly: boolean;
-    constructor(context: CompilerContext, isPathOnly: boolean);
+    protected isPatchOnly: boolean;
+    constructor(context: CompilerContext, isPatchOnly: boolean);
     protected localCssImports?: Set<string>;
-    protected localDeclaredComponents: Map<string, string>;
-    protected indexedComponents: Map<string, ApiCustomElementDeclaration>;
-    protected apiComponent: ApiCustomElementDeclaration;
+    protected localTagName: string | undefined;
+    protected localClassName: string | undefined;
     protected pairedSetter: ts.SetAccessorDeclaration | undefined;
-    protected copyDocDefinitions: CopyDocDefinitions | undefined;
+    protected copyDocDefinitions: CopyDocDefinitions;
+    apiComponent: ApiCustomElementDeclaration;
+    indexedComponents: Map<string, ApiCustomElementDeclaration>;
+    moduleName: string;
+    resolveJsDocLink: (completeMatch: string, match: string) => string;
     extract(files: readonly ts.SourceFile[]): ApiJson;
-    protected extractModules(files: readonly ts.SourceFile[]): ApiModule[];
-    protected extractDeclarations(module: ts.SourceFile): ApiDeclaration[];
+    extractModules(files: readonly ts.SourceFile[]): ApiModule[];
+    extractModule(module: ts.SourceFile): ApiModule;
     protected extractDeclaration(statement: ts.Statement): ApiDeclaration | undefined;
     protected collectCssImports(node: ts.ImportDeclaration): void;
     protected extractComponentDeclaration(node: ts.ClassDeclaration): ApiCustomElementDeclaration | undefined;
@@ -38,17 +41,23 @@ export declare class LuminaApiExtractor extends ApiExtractor {
      * Infer attributes based on public component members.
      */
     protected inferAttributes(members: ApiCustomElementMember[]): ApiAttribute[];
-    protected inferExport(declaration: ApiDeclaration): ApiExport | undefined;
-    protected inferCustomElementExport(declaration: ApiCustomElementDeclaration): ApiExport;
+    protected resolveInheritance(superClassModule: string, modules: ApiModule[]): false | {
+        inheritanceData: ApiReference;
+        declaration: import('@arcgis/api-extractor').ApiClassDeclaration | import('@arcgis/api-extractor').ApiMixinDeclaration;
+        hasSettableField: boolean;
+        indexedMembers: Map<string, import('@arcgis/api-extractor').ApiClassMember | ApiCustomElementMember | undefined> | undefined;
+        indexedEvents: Record<string, ApiEvent> | undefined;
+        indexedAttributes: Record<string, ApiAttribute> | undefined;
+        indexedSlots: Record<string, import('@arcgis/api-extractor').ApiSlot> | undefined;
+        indexedCssParts: Record<string, import('@arcgis/api-extractor').ApiCssPart> | undefined;
+        indexedCssProperties: Record<string, import('@arcgis/api-extractor').ApiCssCustomProperty> | undefined;
+        indexedCssStates: Record<string, import('@arcgis/api-extractor').ApiCssCustomState> | undefined;
+    };
     /**
-     * Inherit public members from a superclass. For this to work, the superclass
-     * needs to be in a a file named like a component
-     * (src/components/name/name.tsx), even if it is not a standalone component.
+     * Overwrite point
+     *
+     * FINAL: jsapi-extractor has a more efficient implementation because it
+     * has to deal with inheritance a lot. Unify it with Lumina.
      */
-    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.
-     */
-    protected resolveInheritance(superClassName: string, modules: ApiModule[]): ApiCustomElementDeclaration | undefined;
+    protected findSuperclassDeclaration(className: string, modules: ApiModule[]): readonly [string, ApiCustomElementDeclaration] | false;
 }

package/dist/extractor/apiJsonUtils.d.ts

@@ -1,4 +1,5 @@
 import { default as ts } from 'typescript';
 import { ApiClassMethod, ApiCustomElementDeclaration, ApiCustomElementField, ApiJson, ApiModule } from '@arcgis/api-extractor';
 export declare function findMember(component: Pick<ApiCustomElementDeclaration, "members" | "name">, memberNode: ts.AccessorDeclaration | ts.MethodDeclaration | ts.PropertyDeclaration): ApiClassMethod | ApiCustomElementField | undefined;
-export declare function findApiModule(filePath: string, rootDir: string, apiJson: ApiJson): ApiModule | undefined;
+export declare function findApiModule(filePath: string, extractRootDir: string, apiJson: ApiJson): ApiModule | undefined;
+export declare function apiMethodReturnsPromise(apiMethod: ApiClassMethod): boolean;

package/dist/extractor/declaration.d.ts

@@ -1,7 +1,7 @@
 import { FileTransformer, DeclarationTextTransformer } from '../publicTypes';
 export declare const removeDeclarationFromDts: DeclarationTextTransformer;
 export declare const addCustomElementDecoratorTransformer: FileTransformer;
-export declare function findDeclaredComponents(code: string): readonly (readonly [string, string])[] | undefined;
+export declare function findDeclaredComponent(code: string): readonly [tagName: string, className: string] | undefined;
 export declare const exportsForTests: {
-    findDeclaredComponents: typeof findDeclaredComponents;
+    findDeclaredComponent: typeof findDeclaredComponent;
 };

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

@@ -6,4 +6,3 @@ import { CompilerContext } from '../../context';
  * Even name is derived by converting property name to kebab-case.
  */
 export declare function extractComponentEvent(propertyDeclaration: ts.PropertyDeclaration, name: string, context: CompilerContext, sourceFile: ts.SourceFile): ApiEvent | undefined;
-export declare function extractBooleanInitializer(initializer: ts.Expression, sourceFile: ts.SourceFile): boolean;

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

@@ -2,10 +2,3 @@ import { default as ts } from 'typescript';
 import { ContextDirectories } from '../../context/types';
 import { ApiClassMethod } from '@arcgis/api-extractor';
 export declare function extractComponentMethodDetails(node: ts.MethodDeclaration, method: ApiClassMethod, checker: ts.TypeChecker, sourceFile: ts.SourceFile, dirs: ContextDirectories): void;
-/**
- * Inspired by https://github.com/bennypowers/cem-plugins/blob/main/plugins/cem-plugin-async-function/index.js
- *
- * That package works, but uses outdated peerDependency and the author doesn't
- * wish to update it. Refactoring it, and adding TypeScript typings
- */
-export declare const isAsync: (nodeDeclaration: ts.MethodDeclaration) => boolean;

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

@@ -1,9 +1,4 @@
 import { default as ts } from 'typescript';
-import { ApiType, ApiTypeReference } from '@arcgis/api-extractor';
+import { ApiType } from '@arcgis/api-extractor';
 import { CompilerContext } from '../../context';
 export declare const getComplexPropertyType: (context: CompilerContext, typeContainerNode: ts.AccessorDeclaration | ts.PropertyDeclaration, isRequired: boolean, sourceFile: ts.SourceFile) => ApiType;
-/**
- * Associate a start and end index with each type reference. Drop unresolved
- * references.
- */
-export declare function findReferenceRanges(references: ApiTypeReference[], resolvedString: string): ApiTypeReference[] | undefined;

package/dist/extractor/index.d.ts

@@ -1,5 +1,6 @@
 import { CompilerContext } from '../context';
 import { ApiCustomElementDeclaration, ApiJson } from '@arcgis/api-extractor';
+import { LuminaApiExtractor } from './LuminaApiExtractor';
 /**
  * Build the complete api.json, either once during build, or in serve mode if
  * full-reload is needed.
@@ -9,4 +10,5 @@ export declare function buildApiJson(context: CompilerContext, reFetchComponentE
  * Update the api.json for a single file on hot reload
  */
 export declare function patchApiJson(context: CompilerContext, fileName: string, code: string): ApiCustomElementDeclaration[] | undefined;
-export declare function postProcessComponent(component: ApiCustomElementDeclaration, context: CompilerContext, indexedComponents: Map<string, ApiCustomElementDeclaration>): void;
+export declare function postProcessComponent(component: ApiCustomElementDeclaration, extractor: LuminaApiExtractor): void;
+export declare const jsDocLinkToMarkdown: (extractor: LuminaApiExtractor) => (completeMatch: string, match: string) => string;

package/dist/index.d.ts

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