@ui5/webcomponents-tools 0.0.0-38861c872 → 0.0.0-38f83ffef

package/lib/cem/types-internal.d.ts

@@ -1,4 +1,12 @@
-export type Privacy = "private" | "protected" | "public"
+/**
+ * @license
+ * Copyright (c) 2019 The Polymer Project Authors. All rights reserved.
+ * This code may only be used under the BSD style license found at http://polymer.github.io/LICENSE.txt
+ * The complete set of authors may be found at http://polymer.github.io/AUTHORS.txt
+ * The complete set of contributors may be found at http://polymer.github.io/CONTRIBUTORS.txt
+ * Code distributed by Google as part of the polymer project is also
+ * subject to an additional IP rights grant found at http://polymer.github.io/PATENTS.txt
+ */
 
 /**
  * The top-level interface of a custom elements manifest file.
@@ -15,14 +23,10 @@ export type Privacy = "private" | "protected" | "public"
  */
 export interface Package {
   /**
-   * Whether the package is deprecated.
-   * If the value is a string, it's the reason for the deprecation.
-   */
-  deprecated?: string | boolean
-  /**
-   * An array of the modules this package contains.
+   * The version of the schema used in this file.
    */
-  modules: JavaScriptModule[]
+  schemaVersion: string;
+
   /**
    * The Markdown to use for the main readme of this package.
    *
@@ -30,112 +34,137 @@ export interface Package {
    * file contains information irrelevant to custom element catalogs and
    * documentation viewers.
    */
-  readme?: string
+  readme?: string;
+
   /**
-   * The version of the schema used in this file.
+   * An array of the modules this package contains.
+   */
+  modules: Array<Module>;
+
+  /**
+   * Whether the package is deprecated.
+   * If the value is a string, it's the reason for the deprecation.
    */
-  schemaVersion: string
+  deprecated?: boolean | string;
 }
+
+// This type may expand in the future to include JSON, CSS, or HTML
+// modules.
+export type Module = JavaScriptModule;
+
 export interface JavaScriptModule {
+  kind: 'javascript-module';
+
   /**
-   * The declarations of a module.
-   *
-   * For documentation purposes, all declarations that are reachable from
-   * exports should be described here. Ie, functions and objects that may be
-   * properties of exported objects, or passed as arguments to functions.
+   * Path to the javascript file needed to be imported. 
+   * (not the path for example to a typescript file.)
    */
-  declarations?: (
-    | ClassDeclaration
-    | EnumDeclaration
-    | InterfaceDeclaration
-    | FunctionDeclaration
-    | MixinDeclaration
-    | VariableDeclaration
-    | CustomElementDeclaration
-    | CustomElementMixinDeclaration
-  )[]
+  path: string;
+
   /**
-   * Whether the module is deprecated.
-   * If the value is a string, it's the reason for the deprecation.
+   * A markdown summary suitable for display in a listing.
    */
-  deprecated?: string | boolean
+  summary?: string;
+
   /**
    * A markdown description of the module.
    */
-  description?: string
+  description?: string;
+
+  /**
+   * The declarations of a module.
+   *
+   * For documentation purposes, all declarations that are reachable from
+   * exports should be described here. Ie, functions and objects that may be
+   * properties of exported objects, or passed as arguments to functions.
+   */
+  declarations?: Array<Declaration>;
+
   /**
    * The exports of a module. This includes JavaScript exports and
    * custom element definitions.
    */
-  exports?: (JavaScriptExport | CustomElementExport)[]
-  kind: "javascript-module"
+  exports?: Array<Export>;
+
   /**
-   * Path to the javascript file needed to be imported.
-   * (not the path for example to a typescript file.)
+   * Whether the module is deprecated.
+   * If the value is a string, it's the reason for the deprecation.
    */
-  path: string
+  deprecated?: boolean | string;
+}
+
+export type Export = JavaScriptExport | CustomElementExport;
+
+export interface JavaScriptExport {
+  kind: 'js';
+
   /**
-   * A markdown summary suitable for display in a listing.
+   * The name of the exported symbol.
+   *
+   * JavaScript has a number of ways to export objects which determine the
+   * correct name to use.
+   *
+   * - Default exports must use the name "default".
+   * - Named exports use the name that is exported. If the export is renamed
+   *   with the "as" clause, use the exported name.
+   * - Aggregating exports (`* from`) should use the name `*`
    */
-  summary?: string
-}
-export interface ClassDeclaration {
-  _ui5package?: string
-  _ui5implements?: Reference[]
-  _ui5privacy?: Privacy
+  name: string;
+
   /**
-   * Marks when the field was
+   * A reference to the exported declaration.
+   *
+   * In the case of aggregating exports, the reference's `module` field must be
+   * defined and the `name` field must be `"*"`.
    */
-  _ui5since?: string
+  declaration: Reference;
+
   /**
-   * Whether the class or mixin is deprecated.
+   * Whether the export is deprecated. For example, the name of the export was changed.
    * If the value is a string, it's the reason for the deprecation.
    */
-  deprecated?: string | boolean
+  deprecated?: boolean | string;
+}
+
+/**
+ * A global custom element defintion, ie the result of a
+ * `customElements.define()` call.
+ *
+ * This is represented as an export because a definition makes the element
+ * available outside of the module it's defined it.
+ */
+export interface CustomElementExport {
+  kind: 'custom-element-definition';
+
   /**
-   * A markdown description of the class.
+   * The tag name of the custom element.
    */
-  description?: string
-  kind: "class"
-  members?: (ClassField | ClassMethod)[]
+  name: string;
+
   /**
-   * Any class mixins applied in the extends clause of this class.
-   *
-   * If mixins are applied in the class definition, then the true superclass
-   * of this class is the result of applying mixins in order to the superclass.
-   *
-   * Mixins must be listed in order of their application to the superclass or
-   * previous mixin application. This means that the innermost mixin is listed
-   * first. This may read backwards from the common order in JavaScript, but
-   * matches the order of language used to describe mixin application, like
-   * "S with A, B".
+   * A reference to the class or other declaration that implements the
+   * custom element.
    */
-  mixins?: Reference[]
-  name: string
-  source?: SourceReference
+  declaration: Reference;
+
   /**
-   * A markdown summary suitable for display in a listing.
+   * Whether the custom-element export is deprecated.
+   * For example, a future version will not register the custom element in this file.
+   * If the value is a string, it's the reason for the deprecation.
    */
-  summary?: string
-  /**
-   * A reference to an export of a module.
-   *
-   * All references are required to be publically accessible, so the canonical
-   * representation of a reference is the export it's available from.
-   *
-   * `package` should generally refer to an npm package name. If `package` is
-   * undefined then the reference is local to this package. If `module` is
-   * undefined the reference is local to the containing module.
-   *
-   * References to global symbols like `Array`, `HTMLElement`, or `Event` should
-   * use a `package` name of `"global:"`.
-   */
-  superclass?: {
-    module?: string
-    name: string
-    package?: string
-  }
+  deprecated?: boolean | string;
 }
+
+export type Declaration =
+  | ClassDeclaration
+  | FunctionDeclaration
+  | MixinDeclaration
+  | VariableDeclaration
+  | CustomElementDeclaration
+  | EnumDeclaration
+  | InterfaceDeclaration
+  | CustomElementMixinDeclaration;
+
 /**
  * A reference to an export of a module.
  *
@@ -150,44 +179,12 @@ export interface ClassDeclaration {
  * use a `package` name of `"global:"`.
  */
 export interface Reference {
-  module?: string
-  name: string
-  package?: string
-}
-export interface ClassField {
-  _ui5validator?: string
-  _ui5formProperty?: boolean
-  _ui5formEvents?: string
-  /**
-   * Marks when the field was introduced
-   */
-  _ui5since?: string
-  default?: string
-  /**
-   * Whether the property is deprecated.
-   * If the value is a string, it's the reason for the deprecation.
-   */
-  deprecated?: string | boolean
-  /**
-   * A markdown description of the field.
-   */
-  description?: string
-  inheritedFrom?: Reference
-  kind: "field"
-  name: string
-  privacy?: Privacy
-  /**
-   * Whether the property is read-only.
-   */
-  readonly?: boolean
-  source?: SourceReference
-  static?: boolean
-  /**
-   * A markdown summary suitable for display in a listing.
-   */
-  summary?: string
-  type?: Type
+  name: string;
+  package?: string;
+  module?: string;
+  inheritedFrom?: Reference;
 }
+
 /**
  * A reference to the source of a declaration or member.
  */
@@ -195,432 +192,340 @@ export interface SourceReference {
   /**
    * An absolute URL to the source (ie. a GitHub URL).
    */
-  href: string
-}
-export interface Type {
-  /**
-   * An array of references to the types in the type string.
-   *
-   * These references have optional indices into the type string so that tools
-   * can understand the references in the type string independently of the type
-   * system and syntax. For example, a documentation viewer could display the
-   * type `Array<FooElement | BarElement>` with cross-references to `FooElement`
-   * and `BarElement` without understanding arrays, generics, or union types.
-   */
-  references?: TypeReference[]
-  source?: SourceReference
-  /**
-   * The full string representation of the type, in whatever type syntax is
-   * used, such as JSDoc, Closure, or TypeScript.
-   */
-  text: string
+  href: string;
 }
+
 /**
- * A reference that is associated with a type string and optionally a range
- * within the string.
+ * A description of a custom element class.
  *
- * Start and end must both be present or not present. If they're present, they
- * are indices into the associated type string. If they are missing, the entire
- * type string is the symbol referenced and the name should match the type
- * string.
+ * Custom elements are JavaScript classes, so this extends from
+ * `ClassDeclaration` and adds custom-element-specific features like
+ * attributes, events, and slots.
+ *
+ * Note that `tagName` in this interface is optional. Tag names are not
+ * neccessarily part of a custom element class, but belong to the definition
+ * (often called the "registration") or the `customElements.define()` call.
+ *
+ * Because classes and tag names can only be registered once, there's a
+ * one-to-one relationship between classes and tag names. For ease of use,
+ * we allow the tag name here.
+ *
+ * Some packages define and register custom elements in separate modules. In
+ * these cases one `Module` should contain the `CustomElement` without a
+ * tagName, and another `Module` should contain the
+ * `CustomElementExport`.
  */
-export interface TypeReference {
-  end?: number
-  module?: string
-  name: string
-  package?: string
-  start?: number
-}
-export interface ClassMethod {
+// Note: this needs to be an interface to be included in the generated JSON
+// Schema output.
+export interface CustomElementDeclaration
+  extends ClassDeclaration,
+  CustomElement {
+  _ui5abstract?: boolean
   /**
    * Marks when the field was introduced
    */
   _ui5since?: string
+}
+
+/**
+ * The additional fields that a custom element adds to classes and mixins.
+ */
+export interface CustomElement extends ClassLike {
   /**
-   * Whether the function is deprecated.
-   * If the value is a string, it's the reason for the deprecation.
+   * An optional tag name that should be specified if this is a
+   * self-registering element.
+   *
+   * Self-registering elements must also include a CustomElementExport
+   * in the module's exports.
    */
-  deprecated?: string | boolean
+  tagName?: string;
+
   /**
-   * A markdown description.
+   * The attributes that this element is known to understand.
    */
-  description?: string
-  inheritedFrom?: Reference
-  kind: "method"
-  name: string
-  parameters?: Parameter[]
-  privacy?: Privacy
-  return?: {
-    /**
-     * A markdown description.
-     */
-    description?: string
-    /**
-     * A markdown summary suitable for display in a listing.
-     */
-    summary?: string
-    type?: Type
-    [k: string]: unknown
-  }
-  source?: SourceReference
-  static?: boolean
+  attributes?: Attribute[];
+
   /**
-   * A markdown summary suitable for display in a listing.
+   * The events that this element fires.
    */
-  summary?: string
-}
-export interface Parameter {
-  _ui5privacy?: Privacy
+  events?: Event[];
+
   /**
-   * Marks when the field was introduced
+   * The shadow dom content slots that this element accepts.
    */
-  _ui5since?: string
-  default?: string
+  slots?: Slot[];
+
+  cssParts?: CssPart[];
+
+  cssProperties?: CssCustomProperty[];
+
+  demos?: Demo[];
+
   /**
-   * Whether the property is deprecated.
-   * If the value is a string, it's the reason for the deprecation.
+   * Distinguishes a regular JavaScript class from a
+   * custom element class
    */
-  deprecated?: string | boolean
+  customElement: true;
+}
+
+export interface Attribute {
+  name: string;
+
   /**
-   * A markdown description of the field.
+   * A markdown summary suitable for display in a listing.
    */
-  description?: string
-  name: string
+  summary?: string;
+
   /**
-   * Whether the parameter is optional. Undefined implies non-optional.
+   * A markdown description.
    */
-  optional?: boolean
+  description?: string;
+
+  inheritedFrom?: Reference;
+
   /**
-   * Whether the property is read-only.
+   * The type that the attribute will be serialized/deserialized as.
    */
-  readonly?: boolean
+  type?: Type;
+
   /**
-   * Whether the parameter is a rest parameter. Only the last parameter may be a rest parameter.
-   * Undefined implies single parameter.
+   * The default value of the attribute, if any.
+   *
+   * As attributes are always strings, this is the actual value, not a human
+   * readable description.
    */
-  rest?: boolean
+  default?: string;
+
   /**
-   * A markdown summary suitable for display in a listing.
+   * The name of the field this attribute is associated with, if any.
+   */
+  fieldName?: string;
+
+  /**
+   * Whether the attribute is deprecated.
+   * If the value is a string, it's the reason for the deprecation.
    */
-  summary?: string
-  type?: Type
+  deprecated?: boolean | string;
 }
-export interface EnumDeclaration {
-  _ui5package?: string
+
+export interface EnumDeclaration extends ClassLike {
+  kind: "enum"
+}
+
+export interface InterfaceDeclaration extends ClassLike {
+  kind: "interface"
+}
+
+export interface Event {
+  _ui5parameters?: Parameter[]
   _ui5privacy?: Privacy
   /**
-   * Marks when the field was introduced
+   * Whether the event is preventable.
    */
-  _ui5since?: string
+  _ui5allowPreventDefault?: boolean;
+
   /**
-   * Whether the class or mixin is deprecated.
-   * If the value is a string, it's the reason for the deprecation.
+   * Whether the event is cancelable.
    */
-  deprecated?: string | boolean
+  _ui5Cancelable?: boolean;
+
   /**
-   * A markdown description of the class.
+   * Whether the event is bubbles.
    */
-  description?: string
-  kind: "enum"
-  members?: ClassField[]
-  /**
-   * Any class mixins applied in the extends clause of this class.
-   *
-   * If mixins are applied in the class definition, then the true superclass
-   * of this class is the result of applying mixins in order to the superclass.
-   *
-   * Mixins must be listed in order of their application to the superclass or
-   * previous mixin application. This means that the innermost mixin is listed
-   * first. This may read backwards from the common order in JavaScript, but
-   * matches the order of language used to describe mixin application, like
-   * "S with A, B".
-   */
-  mixins?: Reference[]
-  name: string
-  source?: SourceReference
-  /**
-   * A markdown summary suitable for display in a listing.
-   */
-  summary?: string
-  /**
-   * A reference to an export of a module.
-   *
-   * All references are required to be publically accessible, so the canonical
-   * representation of a reference is the export it's available from.
-   *
-   * `package` should generally refer to an npm package name. If `package` is
-   * undefined then the reference is local to this package. If `module` is
-   * undefined the reference is local to the containing module.
-   *
-   * References to global symbols like `Array`, `HTMLElement`, or `Event` should
-   * use a `package` name of `"global:"`.
-   */
-  superclass?: {
-    module?: string
-    name: string
-    package?: string
-  }
-}
-export interface InterfaceDeclaration {
-  _ui5package?: string
-  _ui5privacy?: Privacy
+  _ui5Bubbles?: boolean;
+
   /**
    * Marks when the field was introduced
    */
   _ui5since?: string
+  name: string;
+
   /**
-   * Whether the class or mixin is deprecated.
-   * If the value is a string, it's the reason for the deprecation.
+   * A markdown summary suitable for display in a listing.
    */
-  deprecated?: string | boolean
+  summary?: string;
+
   /**
-   * A markdown description of the class.
+   * A markdown description.
    */
-  description?: string
-  kind: "interface"
+  description?: string;
+
   /**
-   * Any class mixins applied in the extends clause of this class.
-   *
-   * If mixins are applied in the class definition, then the true superclass
-   * of this class is the result of applying mixins in order to the superclass.
-   *
-   * Mixins must be listed in order of their application to the superclass or
-   * previous mixin application. This means that the innermost mixin is listed
-   * first. This may read backwards from the common order in JavaScript, but
-   * matches the order of language used to describe mixin application, like
-   * "S with A, B".
+   * The type of the event object that's fired.
    */
-  mixins?: Reference[]
-  name: string
-  source?: SourceReference
+  type: Type;
+
+  inheritedFrom?: Reference;
+
   /**
-   * A markdown summary suitable for display in a listing.
+   * Whether the event is deprecated.
+   * If the value is a string, it's the reason for the deprecation.
    */
-  summary?: string
-  /**
-   * A reference to an export of a module.
-   *
-   * All references are required to be publically accessible, so the canonical
-   * representation of a reference is the export it's available from.
-   *
-   * `package` should generally refer to an npm package name. If `package` is
-   * undefined then the reference is local to this package. If `module` is
-   * undefined the reference is local to the containing module.
-   *
-   * References to global symbols like `Array`, `HTMLElement`, or `Event` should
-   * use a `package` name of `"global:"`.
-   */
-  superclass?: {
-    module?: string
-    name: string
-    package?: string
-  }
+  deprecated?: boolean | string;
 }
-export interface FunctionDeclaration {
-  _ui5package?: string
+
+export interface Slot {
+  _ui5propertyName?: string
+  _ui5type?: Type
+  _ui5privacy?: Privacy
   /**
    * Marks when the field was introduced
    */
   _ui5since?: string
   /**
-   * Whether the function is deprecated.
-   * If the value is a string, it's the reason for the deprecation.
+   * The slot name, or the empty string for an unnamed slot.
    */
-  deprecated?: string | boolean
+  name: string;
+
+  /**
+   * A markdown summary suitable for display in a listing.
+   */
+  summary?: string;
+
   /**
    * A markdown description.
    */
-  description?: string
-  kind: "function"
-  name: string
-  parameters?: Parameter[]
-  return?: {
-    /**
-     * A markdown description.
-     */
-    description?: string
-    /**
-     * A markdown summary suitable for display in a listing.
-     */
-    summary?: string
-    type?: Type
-    [k: string]: unknown
-  }
-  source?: SourceReference
+  description?: string;
+
   /**
-   * A markdown summary suitable for display in a listing.
+   * Whether the slot is deprecated.
+   * If the value is a string, it's the reason for the deprecation.
    */
-  summary?: string
+  deprecated?: boolean | string;
 }
+
 /**
- * A description of a class mixin.
- *
- * Mixins are functions which generate a new subclass of a given superclass.
- * This interfaces describes the class and custom element features that
- * are added by the mixin. As such, it extends the CustomElement interface and
- * ClassLike interface.
- *
- * Since mixins are functions, it also extends the FunctionLike interface. This
- * means a mixin is callable, and has parameters and a return type.
- *
- * The return type is often hard or impossible to accurately describe in type
- * systems like TypeScript. It requires generics and an `extends` operator
- * that TypeScript lacks. Therefore it's recommended that the return type is
- * left empty. The most common form of a mixin function takes a single
- * argument, so consumers of this interface should assume that the return type
- * is the single argument subclassed by this declaration.
- *
- * A mixin should not have a superclass. If a mixins composes other mixins,
- * they should be listed in the `mixins` field.
- *
- * See [this article]{@link https://justinfagnani.com/2015/12/21/real-mixins-with-javascript-classes/}
- * for more information on the classmixin pattern in JavaScript.
+ * The description of a CSS Part
  */
-export interface MixinDeclaration {
-  _ui5package?: string
+export interface CssPart {
+  name: string;
+
   /**
-   * Whether the class or mixin is deprecated.
-   * If the value is a string, it's the reason for the deprecation.
+   * A markdown summary suitable for display in a listing.
    */
-  deprecated?: string | boolean
+  summary?: string;
+
   /**
-   * A markdown description of the class.
+   * A markdown description.
    */
-  description?: string
-  kind: "mixin"
-  members?: (ClassField | ClassMethod)[]
+  description?: string;
+
   /**
-   * Any class mixins applied in the extends clause of this class.
-   *
-   * If mixins are applied in the class definition, then the true superclass
-   * of this class is the result of applying mixins in order to the superclass.
-   *
-   * Mixins must be listed in order of their application to the superclass or
-   * previous mixin application. This means that the innermost mixin is listed
-   * first. This may read backwards from the common order in JavaScript, but
-   * matches the order of language used to describe mixin application, like
-   * "S with A, B".
+   * Whether the CSS shadow part is deprecated.
+   * If the value is a string, it's the reason for the deprecation.
    */
-  mixins?: Reference[]
-  name: string
-  parameters?: Parameter[]
-  return?: {
-    /**
-     * A markdown description.
-     */
-    description?: string
-    /**
-     * A markdown summary suitable for display in a listing.
-     */
-    summary?: string
-    type?: Type
-    [k: string]: unknown
-  }
-  source?: SourceReference
+  deprecated?: boolean | string;
+
+  inheritedFrom?: Reference;
+}
+
+export interface CssCustomProperty {
   /**
-   * A markdown summary suitable for display in a listing.
+   * The name of the property, including leading `--`.
    */
-  summary?: string
+  name: string;
+
   /**
-   * A reference to an export of a module.
+   * The expected syntax of the defined property. Defaults to "*".
    *
-   * All references are required to be publically accessible, so the canonical
-   * representation of a reference is the export it's available from.
+   * The syntax must be a valid CSS [syntax string](https://developer.mozilla.org/en-US/docs/Web/CSS/@property/syntax)
+   * as defined in the CSS Properties and Values API.
    *
-   * `package` should generally refer to an npm package name. If `package` is
-   * undefined then the reference is local to this package. If `module` is
-   * undefined the reference is local to the containing module.
+   * Examples:
    *
-   * References to global symbols like `Array`, `HTMLElement`, or `Event` should
-   * use a `package` name of `"global:"`.
-   */
-  superclass?: {
-    module?: string
-    name: string
-    package?: string
-  }
-}
-export interface VariableDeclaration {
-  _ui5package?: string
-  default?: string
+   * "<color>": accepts a color
+   * "<length> | <percentage>": accepts lengths or percentages but not calc expressions with a combination of the two
+   * "small | medium | large": accepts one of these values set as custom idents.
+   * "*": any valid token
+   */
+  syntax?: string;
+
+  default?: string;
+
   /**
-   * Whether the property is deprecated.
-   * If the value is a string, it's the reason for the deprecation.
+   * A markdown summary suitable for display in a listing.
    */
-  deprecated?: string | boolean
+  summary?: string;
+
   /**
-   * A markdown description of the field.
+   * A markdown description.
    */
-  description?: string
-  kind: "variable"
-  name: string
+  description?: string;
+
   /**
-   * Whether the property is read-only.
+   * Whether the CSS custom property is deprecated.
+   * If the value is a string, it's the reason for the deprecation.
    */
-  readonly?: boolean
-  source?: SourceReference
+  deprecated?: boolean | string;
+}
+
+export interface Type {
   /**
-   * A markdown summary suitable for display in a listing.
+   * The full string representation of the type, in whatever type syntax is
+   * used, such as JSDoc, Closure, or TypeScript.
+   */
+  text: string;
+
+  /**
+   * An array of references to the types in the type string.
+   *
+   * These references have optional indices into the type string so that tools
+   * can understand the references in the type string independently of the type
+   * system and syntax. For example, a documentation viewer could display the
+   * type `Array<FooElement | BarElement>` with cross-references to `FooElement`
+   * and `BarElement` without understanding arrays, generics, or union types.
    */
-  summary?: string
-  type?: Type
+  references?: TypeReference[];
+
+  source?: SourceReference;
 }
+
 /**
- * A description of a custom element class.
- *
- * Custom elements are JavaScript classes, so this extends from
- * `ClassDeclaration` and adds custom-element-specific features like
- * attributes, events, and slots.
- *
- * Note that `tagName` in this interface is optional. Tag names are not
- * neccessarily part of a custom element class, but belong to the definition
- * (often called the "registration") or the `customElements.define()` call.
- *
- * Because classes and tag names can only be registered once, there's a
- * one-to-one relationship between classes and tag names. For ease of use,
- * we allow the tag name here.
+ * A reference that is associated with a type string and optionally a range
+ * within the string.
  *
- * Some packages define and register custom elements in separate modules. In
- * these cases one `Module` should contain the `CustomElement` without a
- * tagName, and another `Module` should contain the
- * `CustomElementExport`.
+ * Start and end must both be present or not present. If they're present, they
+ * are indices into the associated type string. If they are missing, the entire
+ * type string is the symbol referenced and the name should match the type
+ * string.
+ */
+export interface TypeReference extends Reference {
+  start?: number;
+  end?: number;
+}
+
+/**
+ * The common interface of classes and mixins.
  */
-export interface CustomElementDeclaration {
-  _ui5package?: string
+export interface ClassLike {
+  _ui5experimental?: boolean | string
   _ui5implements?: Reference[]
-  _ui5abstract?: boolean
   _ui5privacy?: Privacy
   /**
    * Marks when the field was introduced
    */
   _ui5since?: string
+  name: string;
+
   /**
-   * The attributes that this element is known to understand.
-   */
-  attributes?: Attribute[]
-  cssParts?: CssPart[]
-  cssProperties?: CssCustomProperty[]
-  /**
-   * Distinguishes a regular JavaScript class from a
-   * custom element class
-   */
-  customElement: true
-  demos?: Demo[]
-  /**
-   * Whether the class or mixin is deprecated.
-   * If the value is a string, it's the reason for the deprecation.
+   * A markdown summary suitable for display in a listing.
    */
-  deprecated?: string | boolean
+  summary?: string;
+
   /**
    * A markdown description of the class.
    */
-  description?: string
+  description?: string;
+
   /**
-   * The events that this element fires.
+   * The superclass of this class.
+   *
+   * If this class is defined with mixin applications, the prototype chain
+   * includes the mixin applications and the true superclass is computed
+   * from them.
    */
-  events?: Event[]
-  kind: "class"
-  members?: (ClassField | ClassMethod)[]
+  superclass?: Reference;
+
   /**
    * Any class mixins applied in the extends clause of this class.
    *
@@ -632,401 +537,275 @@ export interface CustomElementDeclaration {
    * first. This may read backwards from the common order in JavaScript, but
    * matches the order of language used to describe mixin application, like
    * "S with A, B".
-   */
-  mixins?: Reference[]
-  name: string
-  /**
-   * The shadow dom content slots that this element accepts.
-   */
-  slots?: Slot[]
-  source?: SourceReference
-  /**
-   * A markdown summary suitable for display in a listing.
-   */
-  summary?: string
-  /**
-   * A reference to an export of a module.
-   *
-   * All references are required to be publically accessible, so the canonical
-   * representation of a reference is the export it's available from.
-   *
-   * `package` should generally refer to an npm package name. If `package` is
-   * undefined then the reference is local to this package. If `module` is
-   * undefined the reference is local to the containing module.
-   *
-   * References to global symbols like `Array`, `HTMLElement`, or `Event` should
-   * use a `package` name of `"global:"`.
-   */
-  superclass?: {
-    module?: string
-    name: string
-    package?: string
-  }
-  /**
-   * An optional tag name that should be specified if this is a
-   * self-registering element.
-   *
-   * Self-registering elements must also include a CustomElementExport
-   * in the module's exports.
-   */
-  tagName?: string
-}
-export interface Attribute {
-  /**
-   * The default value of the attribute, if any.
    *
-   * As attributes are always strings, this is the actual value, not a human
-   * readable description.
-   */
-  default?: string
+   * @example
+   *
+   * ```javascript
+   * class T extends B(A(S)) {}
+   * ```
+   *
+   * is described by:
+   * ```json
+   * {
+   *   "kind": "class",
+   *   "superclass": {
+   *     "name": "S"
+   *   },
+   *   "mixins": [
+   *     {
+   *       "name": "A"
+   *     },
+   *     {
+   *       "name": "B"
+   *     },
+   *   ]
+   * }
+   * ```
+   */
+  mixins?: Array<Reference>;
+  members?: Array<ClassMember>;
+
+  source?: SourceReference;
+
   /**
-   * Whether the attribute is deprecated.
+   * Whether the class or mixin is deprecated.
    * If the value is a string, it's the reason for the deprecation.
    */
-  deprecated?: string | boolean
-  /**
-   * A markdown description.
-   */
-  description?: string
-  /**
-   * The name of the field this attribute is associated with, if any.
-   */
-  fieldName?: string
-  inheritedFrom?: Reference
-  name: string
-  /**
-   * A markdown summary suitable for display in a listing.
-   */
-  summary?: string
-  /**
-   * The type that the attribute will be serialized/deserialized as.
-   */
-  type?: {
-    /**
-     * An array of references to the types in the type string.
-     *
-     * These references have optional indices into the type string so that tools
-     * can understand the references in the type string independently of the type
-     * system and syntax. For example, a documentation viewer could display the
-     * type `Array<FooElement | BarElement>` with cross-references to `FooElement`
-     * and `BarElement` without understanding arrays, generics, or union types.
-     */
-    references?: TypeReference[]
-    source?: SourceReference
-    /**
-     * The full string representation of the type, in whatever type syntax is
-     * used, such as JSDoc, Closure, or TypeScript.
-     */
-    text: string
-  }
+  deprecated?: boolean | string;
 }
+
+export interface ClassDeclaration extends ClassLike {
+  kind: 'class';
+}
+
+export type ClassMember = ClassField | ClassMethod;
+
 /**
- * The description of a CSS Part
+ * The common interface of variables, class fields, and function
+ * parameters.
  */
-export interface CssPart {
-  /**
-   * Whether the CSS shadow part is deprecated.
-   * If the value is a string, it's the reason for the deprecation.
-   */
-  deprecated?: string | boolean
+export interface PropertyLike {
+  name: string;
+
   /**
-   * A markdown description.
+   * A markdown summary suitable for display in a listing.
    */
-  description?: string
-  name: string
+  summary?: string;
+
   /**
-   * A markdown summary suitable for display in a listing.
+   * A markdown description of the field.
    */
-  summary?: string
-}
-export interface CssCustomProperty {
-  default?: string
+  description?: string;
+
+  type?: Type;
+
+  default?: string;
+
   /**
-   * Whether the CSS custom property is deprecated.
+   * Whether the property is deprecated.
    * If the value is a string, it's the reason for the deprecation.
    */
-  deprecated?: string | boolean
+  deprecated?: boolean | string;
+
   /**
-   * A markdown description.
+   * Whether the property is read-only.
    */
-  description?: string
+  readonly?: boolean;
+}
+
+export interface ClassField extends PropertyLike {
+  _ui5noAttribute?: boolean;
+  _ui5validator?: string
+  _ui5formProperty?: boolean
+  _ui5formEvents?: string
   /**
-   * The name of the property, including leading `--`.
+   * Marks when the field was introduced
    */
-  name: string
+  _ui5since?: string
+  kind: 'field';
+  static?: boolean;
+  privacy?: Privacy;
+  inheritedFrom?: Reference;
+  source?: SourceReference;
+}
+
+/**
+ * Additional metadata for fields on custom elements.
+ */
+export interface CustomElementField extends ClassField {
   /**
-   * A markdown summary suitable for display in a listing.
+   * The corresponding attribute name if there is one.
+   * 
+   * If this property is defined, the attribute must be listed in the classes'
+   * `attributes` array.
    */
-  summary?: string
+  attribute?: string;
+
   /**
-   * The expected syntax of the defined property. Defaults to "*".
-   *
-   * The syntax must be a valid CSS [syntax string](https://developer.mozilla.org/en-US/docs/Web/CSS/@property/syntax)
-   * as defined in the CSS Properties and Values API.
-   *
-   * Examples:
+   * If the property reflects to an attribute.
    *
-   * "<color>": accepts a color
-   * "<length> | <percentage>": accepts lengths or percentages but not calc expressions with a combination of the two
-   * "small | medium | large": accepts one of these values set as custom idents.
-   * "*": any valid token
+   * If this is true, the `attribute` property must be defined.
    */
-  syntax?: string
+  reflects?: boolean;
 }
-export interface Demo {
-  /**
-   * A markdown description of the demo.
-   */
-  description?: string
-  source?: SourceReference
+
+export interface ClassMethod extends FunctionLike {
   /**
-   * Relative URL of the demo if it's published with the package. Absolute URL
-   * if it's hosted.
+   * Marks when the field was introduced
    */
-  url: string
+  _ui5since?: string
+  kind: 'method';
+  static?: boolean;
+  privacy?: Privacy;
+  inheritedFrom?: Reference;
+  source?: SourceReference;
 }
-export interface Event {
-  _ui5parameters?: Parameter[]
-  _ui5privacy?: Privacy
-  /**
-   * Whether the parameter is optional. Undefined implies non-optional.
-   */
-  _ui5allowPreventDefault?: boolean
+
+/**
+ * A description of a class mixin.
+ *
+ * Mixins are functions which generate a new subclass of a given superclass.
+ * This interfaces describes the class and custom element features that
+ * are added by the mixin. As such, it extends the CustomElement interface and
+ * ClassLike interface.
+ *
+ * Since mixins are functions, it also extends the FunctionLike interface. This
+ * means a mixin is callable, and has parameters and a return type.
+ *
+ * The return type is often hard or impossible to accurately describe in type
+ * systems like TypeScript. It requires generics and an `extends` operator
+ * that TypeScript lacks. Therefore it's recommended that the return type is
+ * left empty. The most common form of a mixin function takes a single
+ * argument, so consumers of this interface should assume that the return type
+ * is the single argument subclassed by this declaration.
+ *
+ * A mixin should not have a superclass. If a mixins composes other mixins,
+ * they should be listed in the `mixins` field.
+ *
+ * See [this article]{@link https://justinfagnani.com/2015/12/21/real-mixins-with-javascript-classes/}
+ * for more information on the classmixin pattern in JavaScript.
+ *
+ * @example
+ *
+ * This JavaScript mixin declaration:
+ * ```javascript
+ * const MyMixin = (base) => class extends base {
+ *   foo() { ... }
+ * }
+ * ```
+ *
+ * Is described by this JSON:
+ * ```json
+ * {
+ *   "kind": "mixin",
+ *   "name": "MyMixin",
+ *   "parameters": [
+ *     {
+ *       "name": "base",
+ *     }
+ *   ],
+ *   "members": [
+ *     {
+ *       "kind": "method",
+ *       "name": "foo",
+ *     }
+ *   ]
+ * }
+ * ```
+ */
+export interface MixinDeclaration extends ClassLike, FunctionLike {
+  kind: 'mixin';
+}
+
+/**
+ * A class mixin that also adds custom element related properties.
+ */
+// Note: this needs to be an interface to be included in the generated JSON
+// Schema output.
+export interface CustomElementMixinDeclaration
+  extends MixinDeclaration,
+  CustomElement { }
+
+export interface VariableDeclaration extends PropertyLike {
+  kind: 'variable';
+  source?: SourceReference;
+}
+
+export interface FunctionDeclaration extends FunctionLike {
   /**
    * Marks when the field was introduced
    */
   _ui5since?: string
-  /**
-   * Whether the event is deprecated.
-   * If the value is a string, it's the reason for the deprecation.
-   */
-  deprecated?: string | boolean
-  /**
-   * A markdown description.
-   */
-  description?: string
-  inheritedFrom?: Reference
-  name: string
-  /**
-   * A markdown summary suitable for display in a listing.
-   */
-  summary?: string
-  /**
-   * The type of the event object that's fired.
-   */
-  type: {
-    /**
-     * An array of references to the types in the type string.
-     *
-     * These references have optional indices into the type string so that tools
-     * can understand the references in the type string independently of the type
-     * system and syntax. For example, a documentation viewer could display the
-     * type `Array<FooElement | BarElement>` with cross-references to `FooElement`
-     * and `BarElement` without understanding arrays, generics, or union types.
-     */
-    references?: TypeReference[]
-    source?: SourceReference
-    /**
-     * The full string representation of the type, in whatever type syntax is
-     * used, such as JSDoc, Closure, or TypeScript.
-     */
-    text: string
-  }
+  kind: 'function';
+  source?: SourceReference;
 }
-export interface Slot {
-  _ui5propertyName?: string
-  _ui5type?: Type
+
+export interface Parameter extends PropertyLike {
   _ui5privacy?: Privacy
   /**
    * Marks when the field was introduced
    */
   _ui5since?: string
   /**
-   * Whether the slot is deprecated.
-   * If the value is a string, it's the reason for the deprecation.
-   */
-  deprecated?: string | boolean
-  /**
-   * A markdown description.
-   */
-  description?: string
-  /**
-   * The slot name, or the empty string for an unnamed slot.
+   * Whether the parameter is optional. Undefined implies non-optional.
    */
-  name: string
+  optional?: boolean;
   /**
-   * A markdown summary suitable for display in a listing.
+   * Whether the parameter is a rest parameter. Only the last parameter may be a rest parameter.
+   * Undefined implies single parameter.
    */
-  summary?: string
+  rest?: boolean;
 }
-/**
- * A class mixin that also adds custom element related properties.
- */
-export interface CustomElementMixinDeclaration {
-  _ui5package?: string
+
+export interface FunctionLike {
+  name: string;
+
   /**
-   * The attributes that this element is known to understand.
+   * A markdown summary suitable for display in a listing.
    */
-  attributes?: Attribute[]
-  cssParts?: CssPart[]
-  cssProperties?: CssCustomProperty[]
+  summary?: string;
+
   /**
-   * Distinguishes a regular JavaScript class from a
-   * custom element class
+   * A markdown description.
    */
-  customElement: true
-  demos?: Demo[]
+  description?: string;
+
   /**
-   * Whether the class or mixin is deprecated.
+   * Whether the function is deprecated.
    * If the value is a string, it's the reason for the deprecation.
    */
-  deprecated?: string | boolean
-  /**
-   * A markdown description of the class.
-   */
-  description?: string
-  /**
-   * The events that this element fires.
-   */
-  events?: Event[]
-  kind: "mixin"
-  members?: (ClassField | ClassMethod)[]
-  /**
-   * Any class mixins applied in the extends clause of this class.
-   *
-   * If mixins are applied in the class definition, then the true superclass
-   * of this class is the result of applying mixins in order to the superclass.
-   *
-   * Mixins must be listed in order of their application to the superclass or
-   * previous mixin application. This means that the innermost mixin is listed
-   * first. This may read backwards from the common order in JavaScript, but
-   * matches the order of language used to describe mixin application, like
-   * "S with A, B".
-   */
-  mixins?: Reference[]
-  name: string
-  parameters?: Parameter[]
+  deprecated?: boolean | string;
+
+  parameters?: Parameter[];
+
   return?: {
+    type?: Type;
+
     /**
-     * A markdown description.
+     * A markdown summary suitable for display in a listing.
      */
-    description?: string
+    summary?: string;
+
     /**
-     * A markdown summary suitable for display in a listing.
+     * A markdown description.
      */
-    summary?: string
-    type?: Type
-    [k: string]: unknown
-  }
-  /**
-   * The shadow dom content slots that this element accepts.
-   */
-  slots?: Slot[]
-  source?: SourceReference
-  /**
-   * A markdown summary suitable for display in a listing.
-   */
-  summary?: string
-  /**
-   * A reference to an export of a module.
-   *
-   * All references are required to be publically accessible, so the canonical
-   * representation of a reference is the export it's available from.
-   *
-   * `package` should generally refer to an npm package name. If `package` is
-   * undefined then the reference is local to this package. If `module` is
-   * undefined the reference is local to the containing module.
-   *
-   * References to global symbols like `Array`, `HTMLElement`, or `Event` should
-   * use a `package` name of `"global:"`.
-   */
-  superclass?: {
-    module?: string
-    name: string
-    package?: string
-  }
-  /**
-   * An optional tag name that should be specified if this is a
-   * self-registering element.
-   *
-   * Self-registering elements must also include a CustomElementExport
-   * in the module's exports.
-   */
-  tagName?: string
-}
-export interface JavaScriptExport {
-  /**
-   * A reference to an export of a module.
-   *
-   * All references are required to be publically accessible, so the canonical
-   * representation of a reference is the export it's available from.
-   *
-   * `package` should generally refer to an npm package name. If `package` is
-   * undefined then the reference is local to this package. If `module` is
-   * undefined the reference is local to the containing module.
-   *
-   * References to global symbols like `Array`, `HTMLElement`, or `Event` should
-   * use a `package` name of `"global:"`.
-   */
-  declaration: {
-    module?: string
-    name: string
-    package?: string
-  }
-  /**
-   * Whether the export is deprecated. For example, the name of the export was changed.
-   * If the value is a string, it's the reason for the deprecation.
-   */
-  deprecated?: string | boolean
-  kind: "js"
-  /**
-   * The name of the exported symbol.
-   *
-   * JavaScript has a number of ways to export objects which determine the
-   * correct name to use.
-   *
-   * - Default exports must use the name "default".
-   * - Named exports use the name that is exported. If the export is renamed
-   *   with the "as" clause, use the exported name.
-   * - Aggregating exports (`* from`) should use the name `*`
-   */
-  name: string
+    description?: string;
+  };
 }
-/**
- * A global custom element defintion, ie the result of a
- * `customElements.define()` call.
- *
- * This is represented as an export because a definition makes the element
- * available outside of the module it's defined it.
- */
-export interface CustomElementExport {
-  /**
-   * A reference to an export of a module.
-   *
-   * All references are required to be publically accessible, so the canonical
-   * representation of a reference is the export it's available from.
-   *
-   * `package` should generally refer to an npm package name. If `package` is
-   * undefined then the reference is local to this package. If `module` is
-   * undefined the reference is local to the containing module.
-   *
-   * References to global symbols like `Array`, `HTMLElement`, or `Event` should
-   * use a `package` name of `"global:"`.
-   */
-  declaration: {
-    module?: string
-    name: string
-    package?: string
-  }
+
+export type Privacy = 'public' | 'private' | 'protected';
+
+export interface Demo {
   /**
-   * Whether the custom-element export is deprecated.
-   * For example, a future version will not register the custom element in this file.
-   * If the value is a string, it's the reason for the deprecation.
+   * A markdown description of the demo.
    */
-  deprecated?: string | boolean
-  kind: "custom-element-definition"
+  description?: string;
+
   /**
-   * The tag name of the custom element.
+   * Relative URL of the demo if it's published with the package. Absolute URL
+   * if it's hosted.
    */
-  name: string
-}
+  url: string;
+
+  source?: SourceReference;
+}