ontotext-yasgui-web-component 0.0.1

package/dist/types/components/ontotext-yasgui-web-component/ontotext-yasgui-web-component.d.ts

@@ -0,0 +1,21 @@
+import { EventEmitter } from '../../stencil-public-runtime';
+import { YasguiConfiguration } from '../../models/yasgui-configuration';
+import { OntotextYasgui } from '../../models/ontotext-yasgui';
+export declare class OntotextYasguiWebComponent {
+  private yasguiBuilder;
+  el: HTMLElement;
+  config: YasguiConfiguration;
+  queryExecuted: EventEmitter;
+  yasgui: OntotextYasgui;
+  constructor();
+  componentWillLoad(): void;
+  componentDidLoad(): void;
+  onWindowResize(event: any): void;
+  configurationChanged(newConfig: YasguiConfiguration): void;
+  setQuery(query: string): Promise<void>;
+  disconnectedCallback(): void;
+  render(): any;
+  private init;
+  private addOnQueryListener;
+  private destroy;
+}

package/dist/types/components.d.ts

@@ -0,0 +1,46 @@
+/* eslint-disable */
+/* tslint:disable */
+/**
+ * This is an autogenerated file created by the Stencil compiler.
+ * It contains typing information for all components that exist in this project.
+ */
+import { HTMLStencilElement, JSXBase } from "./stencil-public-runtime";
+import { YasguiConfiguration } from "./models/yasgui-configuration";
+export namespace Components {
+    interface OntotextYasgui {
+        "config": YasguiConfiguration;
+        "setQuery": (query: string) => Promise<void>;
+    }
+}
+export interface OntotextYasguiCustomEvent<T> extends CustomEvent<T> {
+    detail: T;
+    target: HTMLOntotextYasguiElement;
+}
+declare global {
+    interface HTMLOntotextYasguiElement extends Components.OntotextYasgui, HTMLStencilElement {
+    }
+    var HTMLOntotextYasguiElement: {
+        prototype: HTMLOntotextYasguiElement;
+        new (): HTMLOntotextYasguiElement;
+    };
+    interface HTMLElementTagNameMap {
+        "ontotext-yasgui": HTMLOntotextYasguiElement;
+    }
+}
+declare namespace LocalJSX {
+    interface OntotextYasgui {
+        "config"?: YasguiConfiguration;
+        "onQueryExecuted"?: (event: OntotextYasguiCustomEvent<any>) => void;
+    }
+    interface IntrinsicElements {
+        "ontotext-yasgui": OntotextYasgui;
+    }
+}
+export { LocalJSX as JSX };
+declare module "@stencil/core" {
+    export namespace JSX {
+        interface IntrinsicElements {
+            "ontotext-yasgui": LocalJSX.OntotextYasgui & JSXBase.HTMLAttributes<HTMLOntotextYasguiElement>;
+        }
+    }
+}

package/dist/types/index.d.ts

@@ -0,0 +1 @@
+export * from './components';

package/dist/types/models/ontotext-yasgui.d.ts

@@ -0,0 +1,17 @@
+import { Yasgui } from '../../../Yasgui/packages/yasgui';
+import { YasguiConfiguration } from './yasgui-configuration';
+export declare class OntotextYasgui {
+  private yasgui;
+  constructor(yasgui: Yasgui, config: YasguiConfiguration);
+  setQuery(query: string): void;
+  getQuery(): string;
+  /**
+   * Initializes ontotext-yasgui component.
+   *
+   * @param config
+   * @private
+   */
+  private init;
+  addYasqeListener(eventName: any, callback: any): void;
+  destroy(): void;
+}

package/dist/types/models/yasgui-configuration.d.ts

@@ -0,0 +1,40 @@
+import { Config } from '../../../Yasgui/packages/yasgui';
+export interface YasguiConfiguration {
+  /**
+   * The default yasgui config.
+   */
+  yasguiConfig: Config;
+  /**
+   * Configure what part of the yasgui should be rendered.
+   */
+  render: RenderingMode;
+  /**
+   * Configure the yasgui layout orientation.
+   */
+  orientation: Orientation;
+  /**
+   * Default query when a tab is opened.
+   */
+  query?: string;
+  /**
+   * Initial query when yasgui is rendered if not set the default query will be set.
+   */
+  initialQuery?: string;
+  /**
+   * If the yasgui tabs should be rendered or not.
+   */
+  showEditorTabs: boolean;
+  /**
+   * If the yasr tabs should be rendered or not.
+   */
+  showResultTabs: boolean;
+}
+export declare enum RenderingMode {
+  YASGUI = "mode-yasgui",
+  YASQE = "mode-yasqe",
+  YASR = "mode-yasr"
+}
+export declare enum Orientation {
+  VERTICAL = "orientation-vertical",
+  HORIZONTAL = "orientation-horizontal"
+}

package/dist/types/services/yasgui/configuration/configurator.d.ts

@@ -0,0 +1,15 @@
+import { YasguiConfiguration } from '../../../models/yasgui-configuration';
+import { Config } from '../../../../../Yasgui/packages/yasgui';
+/**
+ * The configuration of the yasgui component is divided into many configurators for easy maintenance and extension of yasgui.
+ * Every configurator have to implement {@see Configurator} interface.
+ */
+export interface Configurator {
+  /**
+   * Apply configuration to <code>yasguiConfig</code> from <code>clientYasguiConfig</code>
+   * @param el - hte ontotext-yasgui element.
+   * @param config - configuration which is passing to yasgui constructor.
+   * @param yasguiConfig - configuration passed by client.
+   */
+  config(el: HTMLElement, config: Config, yasguiConfig: YasguiConfiguration): Config;
+}

package/dist/types/services/yasgui/configuration/yasgui-configuration-builder.d.ts

@@ -0,0 +1,18 @@
+import { YasguiConfiguration } from '../../../models/yasgui-configuration';
+import { Config } from '../../../../../Yasgui/packages/yasgui';
+/**
+ * Builder for yasgui configuration.
+ */
+declare class YasguiConfigurationBuilderDefinition {
+  private configurators;
+  constructor();
+  /**
+   * Builds a yasgui configuration.
+   * @param el - hte ontotext-yasgui element.
+   * @param config - custom configuration passed by client of component.
+   */
+  build(el: HTMLElement, config: YasguiConfiguration): Config;
+  private initConfigurators;
+}
+export declare const YasguiConfigurationBuilder: YasguiConfigurationBuilderDefinition;
+export {};

package/dist/types/services/yasgui/configuration/yasgui-configurator.d.ts

@@ -0,0 +1,14 @@
+import { Configurator } from './configurator';
+import { YasguiConfiguration } from '../../../models/yasgui-configuration';
+import { Config } from '../../../../../Yasgui/packages/yasgui';
+/**
+ * Manages all top configuration of yasgui.
+ */
+declare class YasguiConfiguratorDefinition implements Configurator {
+  private defaultYasguiConfig;
+  config(_el: HTMLElement, config: Config, yasguiConfig: YasguiConfiguration): Config;
+  private setRenderMode;
+  private setOrientation;
+}
+export declare const YasguiConfigurator: YasguiConfiguratorDefinition;
+export {};

package/dist/types/services/yasgui/configuration/yasqe-configurator.d.ts

@@ -0,0 +1,8 @@
+import { Configurator } from './configurator';
+import { YasguiConfiguration } from '../../../models/yasgui-configuration';
+import { Config } from '../../../../../Yasgui/packages/yasgui';
+declare class YasqeConfiguratorDefinition implements Configurator {
+  config(el: HTMLElement, config: Config, yasguiConfig: YasguiConfiguration): Config;
+}
+export declare const YasqeConfigurator: YasqeConfiguratorDefinition;
+export {};

package/dist/types/services/yasgui/configuration/yasr-configurator.d.ts

@@ -0,0 +1,8 @@
+import { Configurator } from './configurator';
+import { YasguiConfiguration } from '../../../models/yasgui-configuration';
+import { Config } from '../../../../../Yasgui/packages/yasgui';
+declare class YasrConfiguratorDefinition implements Configurator {
+  config(el: HTMLElement, config: Config, yasguiConfig: YasguiConfiguration): Config;
+}
+export declare const YasrConfigurator: YasrConfiguratorDefinition;
+export {};

package/dist/types/services/yasgui/yasgui-builder.d.ts

@@ -0,0 +1,20 @@
+import { YasguiConfiguration } from '../../models/yasgui-configuration';
+import { OntotextYasgui } from '../../models/ontotext-yasgui';
+/**
+ * Builder yasgui instance.
+ * It configures, creates an instance of yasgui and apply patches to created instance.
+ */
+declare class YasguiBuilderDefinition {
+  private yasguiConfigurationBuilder;
+  constructor();
+  /**
+   * Builds an instance of yasgui. The building of instances is a two-step process.
+   * A yasgui configuration is created on first step.
+   * The created instance is patched on second step.
+   * @param el - parent element of yasgui instance.
+   * @param config - configuration passed from client of component. It overrides default values of yasgui component.
+   */
+  build(el: HTMLElement, config: YasguiConfiguration): OntotextYasgui;
+}
+export declare const YasguiBuilder: YasguiBuilderDefinition;
+export {};