@arcgis/lumina-compiler 4.32.0-next.21 → 4.32.0-next.23

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,16 @@
  *
  * 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>;
+export declare function findDeclaredComponentsInFile(code: string, fileName: string): 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;
+declare function validateTagName(tagName: string, className: string): void;
 export declare const exportsForTests: {
     findDeclaredComponents: typeof findDeclaredComponents;
+    validateTagName: typeof validateTagName;
 };
 export {};