api.d.ts

import {
  XMLAttribute,
  XMLElement,
  XMLDocument,
  XMLAstNode,
} from "@xml-tools/ast";
import { DocumentCstNode } from "@xml-tools/parser";
import { IToken } from "chevrotain";
import {
  UI5Aggregation,
  UI5Class,
  UI5Event,
  UI5Namespace,
  UI5Prop,
  UI5Association,
  UI5EnumValue,
} from "@ui5-language-assistant/semantic-model-types/api";
import { CodeAssistSettings } from "@ui5-language-assistant/settings";
import { Context } from "@ui5-language-assistant/context";

export function getXMLViewCompletions(
  opts: GetXMLViewCompletionsOpts
): UI5XMLViewCompletion[];

export interface GetXMLViewCompletionsOpts {
  context: Context;
  offset: number;
  cst: DocumentCstNode;
  ast: XMLDocument;
  tokenVector: IToken[];
  settings: CodeAssistSettings;
}

export type UI5CompletionNode =
  | UI5Namespace
  | UI5Class
  | UI5Aggregation
  | UI5Event
  | UI5Prop
  | UI5Association
  | UI5EnumValue
  | BooleanValue;

export type UI5XMLViewCompletion =
  | UI5NodeXMLViewCompletion
  | BooleanValueInXMLAttributeValueCompletion;

export type UI5NodeXMLViewCompletion =
  | UI5ClassesInXMLTagNameCompletion
  | UI5AggregationsInXMLTagNameCompletion
  | UI5EnumsInXMLAttributeValueCompletion
  | UI5PropsInXMLAttributeKeyCompletion
  | UI5EventsInXMLAttributeKeyCompletion
  | UI5AssociationsInXMLAttributeKeyCompletion
  | UI5NamespacesInXMLAttributeKeyCompletion
  | UI5NamespacesInXMLAttributeValueCompletion;

export type UI5XMLViewCompletionTypeName =
  | "UI5ClassesInXMLTagName"
  | "UI5AggregationsInXMLTagName"
  | "UI5EnumsInXMLAttributeValue"
  | "UI5PropsInXMLAttributeKey"
  | "UI5EventsInXMLAttributeKey"
  | "UI5AssociationsInXMLAttributeKey"
  | "UI5NamespacesInXMLAttributeKey"
  | "UI5NamespacesInXMLAttributeValue"
  | "BooleanValueInXMLAttributeValue";

/**
 * Note that this interface does not deal with "Editor Behavior". e.g:
 * - The Text to insert may differ from the label.
 * - Additional text insertions may be needed:
 *   - Align open and close tags.
 *   - Add '>' to close a tag.
 *   - Add quotes to wrap an attribute's value.
 *
 * Rather it should  contain the completion "pure" data.
 */
export interface BaseXMLViewCompletion<
  XML extends XMLAstNode,
  UI5 extends UI5CompletionNode
> {
  type: UI5XMLViewCompletionTypeName;
  // The Node we want to suggest as a possible completion.
  // Note this carries all the additional semantic data (deprecated/description/...).
  ui5Node: UI5;

  // The specific ASTNode where the completion happened
  // may be useful for LSP Layer to implement Editor Level Logic.
  //   - e.g: the "additional text insertions" mentioned above.
  astNode: XML;
}

export interface UI5ClassesInXMLTagNameCompletion
  extends BaseXMLViewCompletion<XMLElement, UI5Class> {
  type: "UI5ClassesInXMLTagName";
}

export interface UI5AggregationsInXMLTagNameCompletion
  extends BaseXMLViewCompletion<XMLElement, UI5Aggregation> {
  type: "UI5AggregationsInXMLTagName";
}

export interface UI5EnumsInXMLAttributeValueCompletion
  extends BaseXMLViewCompletion<XMLAttribute, UI5EnumValue> {
  type: "UI5EnumsInXMLAttributeValue";
}

export interface UI5PropsInXMLAttributeKeyCompletion
  extends BaseXMLViewCompletion<XMLAttribute, UI5Prop> {
  type: "UI5PropsInXMLAttributeKey";
}

export interface UI5EventsInXMLAttributeKeyCompletion
  extends BaseXMLViewCompletion<XMLAttribute, UI5Event> {
  type: "UI5EventsInXMLAttributeKey";
}

export interface UI5AssociationsInXMLAttributeKeyCompletion
  extends BaseXMLViewCompletion<XMLAttribute, UI5Association> {
  type: "UI5AssociationsInXMLAttributeKey";
}

export interface UI5NamespacesInXMLAttributeKeyCompletion
  extends BaseXMLViewCompletion<XMLAttribute, UI5Namespace> {
  type: "UI5NamespacesInXMLAttributeKey";
}

export interface UI5NamespacesInXMLAttributeValueCompletion
  extends BaseXMLViewCompletion<XMLAttribute, UI5Namespace> {
  type: "UI5NamespacesInXMLAttributeValue";
}

export interface BooleanValue {
  kind: "BooleanValue";
  // The name of the suggestion
  name: string;
  // The literal value that we want to suggest as a possible completion
  value: boolean;
}

export interface BooleanValueInXMLAttributeValueCompletion
  extends BaseXMLViewCompletion<XMLAttribute, BooleanValue> {
  type: "BooleanValueInXMLAttributeValue";
}

/** Check if the suggestion is a UI5 semantic model xml completion according to its type property */
export function isUI5NodeXMLViewCompletion(
  suggestion: UI5XMLViewCompletion
): suggestion is UI5NodeXMLViewCompletion;