@arcgis/lumina-compiler 4.33.0-next.111 → 4.33.0-next.113

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -63,28 +63,7 @@ type Chunk = {
63
63
  * ```
64
64
  */
65
65
  declare function transformChunk(chunk: Chunk, chunks: Map<string, Chunk>): void;
66
- /**
67
- * @example Dynamic core import
68
- * ```diff
69
- * -import("core/Handles");
70
- * +$arcgis.t(m=>m[0],"core/Handles")
71
- * ```
72
- *
73
- * @example Dynamic import of a chunk with top-level await
74
- * ```diff
75
- * -import("./chunk.js");
76
- * +import("./chunk.js").then(m=>m.default)
77
- * ```
78
- *
79
- * @example Dynamic import of a chunk with top-level await and single export that got inlined
80
- * ```diff
81
- * -import("./chunk.js");
82
- * +import("./chunk.js").then(m=>m.default.then(e=>({ArcgisHome:e})))
83
- * ```
84
- */
85
- declare function transformDynamicCoreImports(code: string, chunks: Map<string, Chunk>): string;
86
66
  export declare const exportsForTests: {
87
- transformDynamicCoreImports: typeof transformDynamicCoreImports;
88
67
  transformChunk: typeof transformChunk;
89
68
  };
90
69
  export {};
@@ -6,7 +6,7 @@ import { PluginOptions as VitePluginDtsOptions } from 'vite-plugin-dts';
6
6
  import { ExternalsOptions as RollupPluginNodeExternalsOptions } from 'rollup-plugin-node-externals';
7
7
  import { WebTypesOptions } from './docs/webTypes/types';
8
8
  import { VsCodeDocOptions } from './docs/vsCodeCustomData/types';
9
- import { ApiJson, ApiModule } from '@arcgis/api-extractor';
9
+ import { ApiJson, ApiModule, CopyDocDefinitions } from '@arcgis/api-extractor';
10
10
  import { LuminaApiExtractor } from './extractor/extractor';
11
11
  /**
12
12
  * `useLumina()` returns an array of Vite plugins. The array additionally
@@ -70,6 +70,7 @@ export type BuildOptions = {
70
70
  * Configuration for CDN build.
71
71
  */
72
72
  readonly cdn?: BuildCdnOptions;
73
+ /** @deprecated Use Storybook build or separate test app package. */
73
74
  readonly webApp?: {
74
75
  /**
75
76
  * If set, will produce a web app build, based on index.html files and
@@ -285,6 +286,7 @@ export type PuppeteerTestingOptions = {
285
286
  readonly launchOptions?: Record<string, unknown>;
286
287
  };
287
288
  export type GenerateDocumentationOptions = {
289
+ readonly copyDefinitions?: CopyDocDefinitions;
288
290
  /**
289
291
  * The name of the file to write the api.json to. api.json is a file format
290
292
  * based on custom-elements-manifest that describes all the components in the
@@ -297,22 +299,39 @@ export type GenerateDocumentationOptions = {
297
299
  * The name of the file to write the Stencil-like docs JSON to.
298
300
  * For backwards compatibility.
299
301
  *
302
+ * @deprecated Use api.json instead.
300
303
  * @default "docs/docs.json"
301
304
  * @see https://stenciljs.com/docs/docs-json
302
305
  */
303
306
  readonly stencilLikeDocsJsonFileName?: string | false;
307
+ /**
308
+ * Get a prefix for a public-facing URL for each component story.
309
+ *
310
+ * @example
311
+ * Set this to "https://developers.arcgis.com/javascript/latest/storybook/map-components/".
312
+ * This will produce URLs like
313
+ * "https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-area-measurement-2d--demo&singleStory=true"
314
+ * @see https://qawebgis.esri.com/components/lumina/storybook
315
+ */
316
+ readonly publicStoryUrlPrefix?: string;
304
317
  /**
305
318
  * Provide a URL to a page that documents the component.
306
319
  * This URL will be visible in VS Code and IntelliJ when hovering over a
307
320
  * component tag in an .html file
321
+ *
322
+ * @example (tagName) => `https://developers.arcgis.com/javascript/latest/references/map-components/${tagName}/`
308
323
  */
309
- readonly getComponentDocsUrl?: (tag: string, name: string) => string | undefined;
324
+ readonly getComponentDocsUrl?: (tagName: string, className: string) => string | undefined;
310
325
  /**
311
326
  * Provide a URL to a page that documents the component.
312
327
  * This URL will be visible in VS Code and IntelliJ when hovering over a
313
328
  * component tag in an .html file
329
+ *
330
+ * If you wish to provide multiple URLs, use "getPublicStoryUrl" instead.
331
+ *
332
+ * @example (tagName) => `https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/${tagName}--demo&singleStory=true`
314
333
  */
315
- readonly getComponentDemoUrl?: (tag: string, name: string) => string | undefined;
334
+ readonly getComponentDemoUrl?: (tagName: string, className: string) => string | undefined;
316
335
  /**
317
336
  * Additional options for web component documentation for VS Code. This
318
337
  * documentation provides intellisense when editing .html and .css files.
@@ -437,7 +456,7 @@ export type ApiJsonOptions = {
437
456
  *
438
457
  * @default LuminaApiExtractor
439
458
  */
440
- readonly Extractor: typeof LuminaApiExtractor;
459
+ readonly Extractor?: typeof LuminaApiExtractor;
441
460
  /**
442
461
  * This function will be called after the api.json is created but before it is
443
462
  * used to generate any output files.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@arcgis/lumina-compiler",
3
- "version": "4.33.0-next.111",
3
+ "version": "4.33.0-next.113",
4
4
  "type": "module",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.js",
@@ -18,9 +18,9 @@
18
18
  ],
19
19
  "license": "SEE LICENSE IN LICENSE.md",
20
20
  "dependencies": {
21
- "@arcgis/api-extractor": "4.33.0-next.111",
22
- "@arcgis/components-build-utils": "4.33.0-next.111",
23
- "@arcgis/components-utils": "4.33.0-next.111",
21
+ "@arcgis/api-extractor": "4.33.0-next.113",
22
+ "@arcgis/components-build-utils": "4.33.0-next.113",
23
+ "@arcgis/components-utils": "4.33.0-next.113",
24
24
  "chalk": "^5.3.0",
25
25
  "esbuild": "^0.24.0",
26
26
  "glob": "^11.0.0",
@@ -37,6 +37,6 @@
37
37
  "vitest-fail-on-console": "^0.7.1"
38
38
  },
39
39
  "peerDependencies": {
40
- "@arcgis/lumina": "~4.33.0-next.111"
40
+ "@arcgis/lumina": "~4.33.0-next.113"
41
41
  }
42
42
  }
@@ -1,11 +0,0 @@
1
- import { default as ts } from 'typescript';
2
- import { ApiCustomElementDeclaration, ApiCustomElementField, ApiDocsTag } from '@arcgis/api-extractor';
3
- export declare function symbolToDocs(checker: ts.TypeChecker, symbol: ts.Signature | ts.Symbol): {
4
- description: ApiCustomElementField["description"];
5
- docsTags: ApiDocsTag[];
6
- };
7
- export declare const internalJsDocTag = "internal";
8
- export declare const findDecorator: ({ modifiers }: {
9
- modifiers?: readonly ts.ModifierLike[];
10
- }, name: string) => ts.CallExpression | undefined;
11
- export declare function setJsDocFields(node: ts.PropertyName, checker: ts.TypeChecker, api: Partial<Pick<ApiCustomElementField, "default" | "deprecated" | "description" | "docsTags" | "privacy" | "readonly" | "summary"> & Pick<ApiCustomElementDeclaration, "cssParts" | "cssProperties" | "cssStates" | "slots">>, docs?: ReturnType<typeof symbolToDocs>): void;