@arcgis/lumina-compiler 4.31.0-next.100

package/dist/entrypoints/handleComponentImports.d.ts

@@ -0,0 +1,13 @@
+import type ts from "typescript";
+import type { JsxContext } from "../jsxToLitHtml/types";
+/**
+ * Instead of adding imports to the component source file, take note of imports
+ * that need to be added and have addNonLazyImports() add them to component's
+ * component-name/index.js (rather than component-name/customElement.js)
+ *
+ * Since component-name/index.js file is only imported in non-lazy builds, it
+ * will make sure to bundle-in used components. In lazy builds, it is expected
+ * that "defineCustomElements()" of some sort is called separately to load the
+ * components this file depends on.
+ */
+export declare function handleComponentImports(context: JsxContext): ts.ImportDeclaration[];

package/dist/entrypoints/pathMapping.d.ts

@@ -0,0 +1,25 @@
+import type { CompilerContext } from "../context";
+import type { ComponentManifest } from "../manifests/utils";
+/**
+ * A mapping between a path to a component folder in src/components and it's
+ * tag name.
+ *
+ * @example
+ * ```json
+ * {
+ *   "root": {
+ *     "": "arcgis-root",
+ *   },
+ *   "counter": {
+ *     "": "arcgis-counter",
+ *     "sub-counter": "arcgis-sub-counter",
+ *   },
+ * }
+ * ```
+ */
+export type ComponentPathMapping = Record<string, PathMappingInterface | string>;
+interface PathMappingInterface extends ComponentPathMapping {
+}
+export declare function addComponentPathMapping(component: ComponentManifest, context: CompilerContext): string;
+export declare function renameComponentFolder(filePath: string, pathBase: string, context: Pick<CompilerContext, "componentPathMapping">): string;
+export {};

package/dist/entrypoints/resolveTagName.d.ts

@@ -0,0 +1,14 @@
+import type { ResolvedDependencyComponent } from "../dependencies/discover";
+import type { ModulePath } from "../manifests/complexTypes/transformUtils";
+import type { ExtendedComponentManifest } from "../manifests/complexTypes/types";
+import type { CompilerContext } from "../context";
+/**
+ * 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;
+export declare function modulePathToString(resolvedPath: ModulePath, distRelativeCwd: string): string;
+export declare function getLocalDefinedComponentsFromManifest(manifest: ExtendedComponentManifest): Readonly<Record<string, ResolvedDependencyComponent>>;
+export declare const exportsForTests: {
+    modulePathToString: typeof modulePathToString;
+};

package/dist/entrypoints/resolveTagName.spec.d.ts

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

package/dist/frameworkTypes/index.d.ts

@@ -0,0 +1,15 @@
+import type { CompilerContext } from "../context";
+import type { Plugin } from "vite";
+/**
+ * Generate component typings for vanilla JavaScript and JSX frameworks.
+ *
+ * Unfortunately, there are differences in how web components are interpreted
+ * across JSX libraries (differences in html attribute names like `class` vs
+ * `className`, event name case casting like `onArcgisClick` and
+ * `onarcgisClick`, ref typing like `HTMLElement|null` or
+ * `HTMLElement|undefined`, or `HTMLElement`, event callback typing and etc,
+ * like synthetic events or native events) that make it difficult to ship a
+ * "generic" typing that works for all JSX libraries out there, so we have to
+ * generate separate for each.
+ */
+export declare function generateFrameworkTypes(context: CompilerContext): Plugin;

package/dist/frameworkTypes/lumina.d.ts

@@ -0,0 +1,5 @@
+import type { ComponentManifest } from "../manifests/utils";
+/**
+ * @see https://github.com/preactjs/preact/issues/1180#issuecomment-643681851
+ */
+export declare const generateLuminaTypes: (components: ComponentManifest[]) => string;

package/dist/frameworkTypes/preact.d.ts

@@ -0,0 +1,6 @@
+import type { ComponentManifest } from "../manifests/utils";
+/**
+ * @see https://github.com/preactjs/preact/issues/1180#issuecomment-643681851
+ * @see https://github.com/preactjs/preact/pull/1448/files
+ */
+export declare function generatePreactTypes(components: ComponentManifest[]): string;

package/dist/frameworkTypes/react.d.ts

@@ -0,0 +1,6 @@
+import type { ComponentManifest } from "../manifests/utils";
+/**
+ * @see https://react.dev/blog/2024/04/25/react-19-upgrade-guide#the-jsx-namespace-in-typescript
+ * @see https://github.com/preactjs/preact/issues/1180#issuecomment-643681851
+ */
+export declare function generateReactTypes(components: ComponentManifest[]): string;

package/dist/frameworkTypes/stencil.d.ts

@@ -0,0 +1,5 @@
+import type { ComponentManifest } from "../manifests/utils";
+/**
+ * @see https://github.com/preactjs/preact/issues/1180#issuecomment-643681851
+ */
+export declare const generateStencilTypes: (components: ComponentManifest[]) => string;

package/dist/frameworkTypes/utils.d.ts

@@ -0,0 +1,8 @@
+import type { CompilerContext } from "../context";
+import type { ExtendedManifestField } from "../manifests/complexTypes/types";
+import type { ComponentManifest } from "../manifests/utils";
+/** Generate a string for importing component types */
+export declare const generateComponentTypeImports: (context: CompilerContext) => string;
+export declare const isPropertyEscapeNeeded: (name: string) => boolean;
+export declare const maybeEscapePropertyName: (name: string) => string;
+export declare function getComponentExtend(name: string, members?: ComponentManifest["members"] & Partial<ExtendedManifestField>): readonly [extend: string, helperTypes: string];

package/dist/frameworkTypes/vanilla.d.ts

@@ -0,0 +1,3 @@
+import type { ComponentManifest } from "../manifests/utils";
+/** Add component types for HTML */
+export declare const addComponentTypes: (components: ComponentManifest[], indexTsCode: string, typeImports: string) => string;

package/dist/index.d.ts

@@ -0,0 +1,29 @@
+export { useLumina } from "./useLumina";
+export * from "./publicTypes";
+export { inferCdnUrl } from "./defaultAssetsUrl";
+export type { CompilerContext } from "./context";
+export type { ExtendedComponentManifest } from "./manifests/complexTypes/types";
+import { initializeComponentDependencies } from "./dependencies/discover";
+import { updateLuminaTs } from "./dependencies/updateLumina";
+import { findDeclaredComponents } from "./manifests/customElementDecoratorPlugins";
+/**
+ * These are exposed only for usage by the @arcgis/stencil-to-lumina codemod
+ *
+ * @internal
+ */
+export declare const exportsForCodemod: {
+    initializeComponentDependencies: typeof initializeComponentDependencies;
+    updateLuminaTs: typeof updateLuminaTs;
+    propertyToAttributeMappings: {
+        common: import("./jsxToLitHtml/config").ElementPropertyToAttributeMappings;
+        perElement: Record<string, import("./jsxToLitHtml/config").ElementPropertyToAttributeMappings | undefined>;
+    };
+    findDeclaredComponents: typeof findDeclaredComponents;
+    nativeEvents: Set<string>;
+    svgElements: Set<string>;
+    mathMlElements: Set<string>;
+    alwaysAttributes: Set<string>;
+    nativeAlwaysAttributes: Set<string>;
+    htmlAlwaysAttributes: Record<string, Set<string>>;
+    isPropertyEscapeNeeded: (name: string) => boolean;
+};