@arcgis/api-extractor 5.2.0-next.13 → 5.2.0-next.130

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.
package/LICENSE.md CHANGED
@@ -1,12 +1,14 @@
1
1
  # Licensing
2
2
 
3
- COPYRIGHT © Esri
3
+ COPYRIGHT Esri
4
4
 
5
5
  All rights reserved under the copyright laws of the United States and applicable international laws, treaties, and conventions.
6
6
 
7
- 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.
7
+ This material is licensed for use under the Esri Master License Agreement (MLA), and is bound by the terms of that agreement.
8
8
  You may redistribute and use this code without modification, provided you adhere to the terms of the MLA and include this copyright notice.
9
9
 
10
+ See use restrictions at https://www.esri.com/content/dam/esrisites/en-us/media/legal/ma-full/ma-full.pdf.
11
+
10
12
  For additional information, contact:
11
13
  Environmental Systems Research Institute, Inc.
12
14
  Attn: Contracts and Legal Services Department
package/README.md CHANGED
@@ -8,5 +8,5 @@ It is not intended to be used directly, but rather used as a dependency by other
8
8
 
9
9
  ## License
10
10
 
11
- 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.1/LICENSE.txt.
12
- For third party notices, see https://js.arcgis.com/5.1/third-party-notices.txt.
11
+ 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.2/LICENSE.txt.
12
+ For third party notices, see https://js.arcgis.com/5.2/third-party-notices.txt.
package/dist/apiJson.d.ts CHANGED
@@ -452,23 +452,14 @@ export interface ApiWithInheritance {
452
452
  }
453
453
 
454
454
  /** @see [MDN Slot](https://developer.mozilla.org/docs/Web/HTML/Element/slot) */
455
- export interface ApiSlot extends ApiWithDescription, ApiWithUnusedSummary {
455
+ export interface ApiSlot extends ApiWithDescription, ApiWithDocsTags, ApiWithDeprecated, ApiWithUnusedSummary {
456
456
  /**
457
457
  * The slot name, or the empty string for an unnamed slot.
458
458
  *
459
459
  * @example "header"
460
460
  */
461
461
  name: string;
462
- /**
463
- * Whether the slot is deprecated.
464
- * If the value is a string, it's the reason for the deprecation.
465
- *
466
- * @deprecated
467
- * Not used by `@arcgis/api-extractor`. Preserved in types for compatibility
468
- * with custom-elements-manifest.
469
- * @default false
470
- */
471
- deprecated?: string | true;
462
+ type?: ApiType;
472
463
  }
473
464
 
474
465
  /**
@@ -476,19 +467,10 @@ export interface ApiSlot extends ApiWithDescription, ApiWithUnusedSummary {
476
467
  *
477
468
  * @see https://developer.mozilla.org/docs/Web/CSS/CSS_shadow_parts
478
469
  */
479
- export interface ApiCssPart extends ApiWithDescription, ApiWithUnusedSummary {
470
+ export interface ApiCssPart extends ApiWithDescription, ApiWithDocsTags, ApiWithDeprecated, ApiWithUnusedSummary {
480
471
  /** @example "tab" */
481
472
  name: string;
482
- /**
483
- * Whether the CSS shadow part is deprecated.
484
- * If the value is a string, it's the reason for the deprecation.
485
- *
486
- * @deprecated
487
- * Not used by `@arcgis/api-extractor`. Preserved in types for compatibility
488
- * with custom-elements-manifest.
489
- * @default false
490
- */
491
- deprecated?: string | true;
473
+ type?: ApiType;
492
474
  }
493
475
 
494
476
  /**
@@ -496,7 +478,7 @@ export interface ApiCssPart extends ApiWithDescription, ApiWithUnusedSummary {
496
478
  *
497
479
  * @see https://developer.mozilla.org/docs/Web/API/CustomStateSet
498
480
  */
499
- export interface ApiCssCustomState extends ApiWithDescription, ApiWithUnusedSummary {
481
+ export interface ApiCssCustomState extends ApiWithDescription, ApiWithDocsTags, ApiWithDeprecated, ApiWithUnusedSummary {
500
482
  /**
501
483
  * The name of the state. Note: Unlike CSS custom properties, custom states
502
484
  * do not have a leading `--`.
@@ -504,55 +486,28 @@ export interface ApiCssCustomState extends ApiWithDescription, ApiWithUnusedSumm
504
486
  * @example "active"
505
487
  */
506
488
  name: string;
507
- /**
508
- * Whether the CSS custom state is deprecated.
509
- * If the value is a string, it's the reason for the deprecation.
510
- *
511
- * @deprecated
512
- * Not used by `@arcgis/api-extractor`. Preserved in types for compatibility
513
- * with custom-elements-manifest.
514
- * @default false
515
- */
516
- deprecated?: string | true;
517
489
  }
518
490
 
519
- export interface ApiCssCustomProperty extends ApiWithDescription, ApiWithUnusedSummary {
491
+ export interface ApiCssCustomProperty extends ApiWithDescription, ApiWithDocsTags, ApiWithDeprecated, ApiWithUnusedSummary {
520
492
  /**
521
493
  * The name of the property, including leading `--`.
522
494
  *
523
495
  * @example "--calcite-text-color"
524
496
  */
525
497
  name: string;
498
+ type?: ApiType;
526
499
  /**
527
- * The expected syntax of the defined property. Defaults to "*".
528
- *
529
- * The syntax must be a valid CSS
530
- * [syntax string](https://developer.mozilla.org/docs/Web/CSS/@property/syntax)
531
- * as defined in the CSS Properties and Values API.
532
- *
533
- * Examples:
534
- *
535
- * "<color>": accepts a color
536
- * "<length> | <percentage>": accepts lengths or percentages but not calc expressions with a combination of the two
537
- * "small | medium | large": accepts one of these values set as custom indents.
538
- * "*": any valid token
500
+ * A [CSS syntax string](https://developer.mozilla.org/en-US/docs/Web/CSS/@property/syntax)
539
501
  *
540
502
  * @deprecated
541
503
  * Not used by `@arcgis/api-extractor`. Preserved in types for compatibility
542
504
  * with custom-elements-manifest.
505
+ *
506
+ * We use [ApiCssCustomProperty](https://developers.arcgis.com/javascript/latest/references/api-extractor/apiJson/#ApiCssCustomProperty-) instead, which is more
507
+ * powerful, and we have existing utils for dealing with it.
543
508
  */
544
509
  syntax?: string;
545
510
  default?: string;
546
- /**
547
- * Whether the CSS custom property is deprecated.
548
- * If the value is a string, it's the reason for the deprecation.
549
- *
550
- * @deprecated
551
- * Not used by `@arcgis/api-extractor`. Preserved in types for compatibility
552
- * with custom-elements-manifest.
553
- * @default false
554
- */
555
- deprecated?: string | true;
556
511
  }
557
512
 
558
513
  export interface ApiType extends ApiWithUnusedSource {
@@ -646,6 +601,7 @@ export interface ApiTypeParameter {
646
601
  /** The common interface of classes and mixins. */
647
602
  export interface ApiClassDeclaration extends ApiObjectLikeDeclaration, ApiWithEvents {
648
603
  kind: "class";
604
+ abstract?: true;
649
605
  /**
650
606
  * The superclass of this class.
651
607
  *
@@ -775,7 +731,7 @@ export interface ApiCustomElementField extends ApiClassField {
775
731
  *
776
732
  * > Not present in vanilla custom-elements-manifest.
777
733
  *
778
- * @deprecated fuse regular .readonly field instead
734
+ * @deprecated use regular .readonly field instead
779
735
  * @default false
780
736
  */
781
737
  docsOnlyReadonly?: true;