memorial-ui-component-library 1.0.2 → 1.1.0

package/types/dialog.d.ts

@@ -1,643 +1,643 @@
-import { MemorialUIComponent, MemorialUIPluginComponent } from './component';
-import { VueConstructor, PluginObject } from 'vue';
-import { SdDialogPluginOptions } from './options';
-import { RuleProperty } from './async-validator';
-
-declare module 'vue/types/vue' {
-  interface Vue {
-    /** Dialog controller*/
-    $dialog: typeof SdDialogController;
-  }
-}
-
-/**
- * Callbacks to execute when certain life-cycle hooks are reached.
- */
-export declare interface DialogHooks<ReturnType> {
-  /**
-   * Indicates that the dialog was successfully closed.
-   * @param result The result returned by the dialog instance.
-   */
-  close?: (
-    result: ReturnType,
-    cancel: (message?: string | Error) => void
-  ) => any | void;
-  /**
-   * Indicates that that dialog was closed by cancellation.
-   * @param message The error or message that described the reason for cancellation.
-   */
-  cancel?: (message: string | Error) => void;
-
-  /**
-   * Indicates that the dialog was closed in error.
-   * @param err The error or message that occurred.
-   */
-  error?: (err: string | Error) => void;
-}
-
-export declare class SdDialog<
-  TReturn,
-  TPayload,
-  TContainerPayload
-> extends MemorialUIPluginComponent {
-  /**
-   * Vue templates for common use cases.
-   */
-  static templates: {
-    alert: typeof SdAlertDialog;
-    confirm: typeof SdConfirmDialog;
-    prompt: typeof SdPromptDialog;
-  };
-
-  /**
-   * Attaches the dialog components to the app root. NOTE: This function is not necessary in Nuxt apps.
-   * @param app Root Vue app instance.
-   */
-  static attach(app?: VueConstructor): void;
-
-  /**
-   * Payload scoped to the dialog accessible within extended component template.
-   */
-  payload?: TPayload;
-
-  /**
-   * Payload scoped and accessible to the entire container controlling the dialog.
-   */
-  containerPayload?: TContainerPayload;
-
-  /**
-   * Container the dialog is mounted within.
-   */
-  container: SdDialogContainer<TContainerPayload>;
-
-  /** Unique dialog id. */
-  readonly id: string;
-
-  /**
-   * Destroys the dialog indicating that the instance life-cycle was completed.
-   * @param data Optional data returned by the dialog instance.
-   */
-  close(data: TReturn): Promise<void>;
-
-  /**
-   * Destroys the dialog indicating that the instance life-cycle was cancelled.
-   * @param message Optional message indicating why the dialog was cancelled.
-   */
-  cancel(message?: string | Error): Promise<void>;
-
-  /**
-   * Destroys the dialog indicating that an error has occurred.
-   * @param message The error or message that occurred.
-   */
-  error(message: string | Error): Promise<void>;
-}
-
-export declare class SdDialogNode<
-  TPrecedingResult,
-  TOwnResult,
-  TPayload,
-  TContainerScopeData
-> extends SdDialog<TOwnResult, TPayload, TContainerScopeData> {
-  /**
-   * Result returned by the preceding dialog in the sequence or graph.
-   */
-  precedingResult?: TPrecedingResult;
-}
-
-export declare class SdAlertDialog<TContainerPayload> extends SdDialog<
-  void,
-  SdAlertDialogOptions,
-  TContainerPayload
-> {
-  /**
-   * The alert's displayed title.
-   */
-  title: string;
-  /**
-   * The alert's message body.
-   */
-  message: string;
-}
-
-export declare class SdConfirmDialog<TContainerPayload> extends SdDialog<
-  boolean,
-  SdConfirmDialogOptions,
-  TContainerPayload
-> {
-  /**
-   * The confirmation's displayed title.
-   */
-  title: string;
-  /**
-   * The confirmation's message body.
-   */
-  message: string;
-}
-
-export declare class SdPromptDialog<TContainerPayload> extends SdDialog<
-  string,
-  SdPromptDialogOptions,
-  TContainerPayload
-> {
-  /**
-   * The prompts displayed title.
-   */
-  title: string;
-  /**
-   * The prompts message body.
-   */
-  message: string;
-}
-
-export declare class SdDialogContainer<
-  TContainerPayload
-> extends MemorialUIComponent {
-  /**
-   * Payload scoped and accessible to the entire container controlling the dialog.
-   */
-  containerPayload?: TContainerPayload;
-}
-
-export interface SdDialogOptions<TResult, TPayload> {
-  /**
-   * Payload scoped to the dialog accessible within extended component template.
-   */
-  payload?: TPayload;
-  /**
-   * Callbacks to execute when certain life-cycle hooks are reached.
-   */
-  hooks?: DialogHooks<TResult>;
-}
-
-export interface SdDialogSequenceOptions<TPrecedingResult, TResult, TPayload> {
-  /**
-   * Payload scoped to the dialog node and accessible within extended component template.
-   */
-  payload?: TPayload;
-  /**
-   * Callbacks to execute when specified life-cycle hooks are reached.
-   */
-  hooks?: DialogHooks<TResult>;
-  /**
-   * Validation functions which control the flow of execution.
-   */
-  execution?: {
-    /**
-     * Executed before proceeding to the next dialog.
-     * @param ownResult The result returned by the current dialog node.
-     * @param precedingResult The result returned by the previous dialog node
-     * @returns Boolean value indicating whether to proceed to the next dialog node.
-     */
-    beforeNext?: (
-      ownResult: TResult,
-      precedingResult: TPrecedingResult
-    ) => boolean | Promise<boolean>;
-  };
-}
-
-export interface SdAlertDialogOptions {
-  /**
-   * The title to display for the alert.
-   */
-  title: string;
-  /**
-   * The message body to display in the alert.
-   */
-  message: string;
-  /**
-   * Optional text to replace the contents of the close button.
-   */
-  closeButtonText?: string;
-}
-
-export interface SdConfirmDialogOptions {
-  /**
-   * The title to display for the confirmation.
-   */
-  title: string;
-  /**
-   * The message body to display in the confirmation.
-   */
-  message: string;
-  /**
-   * Whether to show a close button in the upper right corner of the dialog.
-   */
-  showClose?: boolean;
-  /**
-   * Optional text to replace the contents of the **Yes** button.
-   */
-  yesButtonText?: string;
-  /**
-   * Optional text to replace the contents of the **No** button.
-   */
-  noButtonText?: string;
-}
-
-export interface SdPromptDialogOptions {
-  /**
-   * The title to display for the prompt.
-   */
-  title: string;
-  /**
-   * The message body to display in the prompt.
-   */
-  message: string;
-  /**
-   * Whether an input value is required to successfully close the prompt.
-   */
-  inputRequired?: boolean;
-  /**
-   * Optional text to replace the default validation message in the event of an input validation error.
-   */
-  inputValidationMessage?: string;
-  /**
-   * Additional validation rules to apply to the input
-   */
-  rules?: RuleProperty[];
-  /**
-   * Whether to show a close button in the upper right corner of the dialog.
-   */
-  showClose?: boolean;
-  /**
-   * Optional text to replace the contents of the **Submit** button.
-   */
-  submitButtonText?: string;
-  /**
-   * Optional text to replace the contents of the **Cancel** button.
-   */
-  cancelButtonText?: string;
-}
-
-export declare class SdDialogInstance<TResult, TPayload> {
-  /**
-   * Displays the dialog.
-   * @returns A promise which gets resolved when the dialog is closed. Contains the result of the dialog.
-   */
-  showAsync(): Promise<TResult>;
-
-  /**
-   * Manually cancels the instance execution.
-   * @param message The message or error describing think reason for cancellation.
-   */
-  cancel(message: string | Error): void;
-}
-
-/**
- * Registers the entry node dialog node of the sequence.
- * @param ctor The Vue constructor of the template to display.
- * @param options Options used to configure the dialog.
- */
-interface DialogSequenceEntry<TSequencePayload> {
-  <TResult, TPayload>(
-    ctor: DialogNodeComponent<undefined, TResult, TPayload, TSequencePayload>,
-    options?: SdDialogSequenceOptions<undefined, TResult, TPayload>
-  ): {
-    /**
-     * Starts the dialog sequence by displaying the first registered node.
-     * @returns The result of the last dialog in the sequence.
-     */
-    startAsync(): Promise<TResult>;
-
-    /**
-     * Manually cancels the sequence execution.
-     * @param message The message or error describing think reason for cancellation.
-     */
-    cancel(message: string | Error): void;
-
-    /**
-     * Registers a node dialog node within the sequence.
-     * @param ctor The Vue constructor of the template to display.
-     * @param options Options used to configure the dialog.
-     */
-    register: DialogSequenceBuilder<TResult, TSequencePayload>;
-  };
-}
-
-/**
- * Registers a node dialog node within the sequence.
- * @param ctor The Vue constructor of the template to display.
- * @param options Options used to configure the dialog.
- */
-interface DialogSequenceBuilder<TPreviousResult, TSequencePayload> {
-  <TResult, TPayload>(
-    ctor: DialogNodeComponent<
-      TPreviousResult,
-      TResult,
-      TPayload,
-      TSequencePayload
-    >,
-    options?: SdDialogSequenceOptions<TPreviousResult, TResult, TPayload>
-  ): {
-    /**
-     * Starts the dialog sequence by displaying the first registered node.
-     * @returns The result of the last dialog in the sequence.
-     */
-    startAsync(): Promise<TResult>;
-
-    /**
-     * Manually cancels the sequence execution.
-     * @param message The message or error describing think reason for cancellation.
-     */
-    cancel(message: string | Error): void;
-
-    /**
-     * Registers a node dialog node within the sequence.
-     * @param ctor The Vue constructor of the template to display.
-     * @param options Options used to configure the dialog.
-     */
-    register: DialogSequenceBuilder<TResult, TSequencePayload>;
-  };
-}
-
-export declare class SdDialogSequence<TSequencePayload> {
-  /**
-   * Registers the entry node dialog node of the sequence.
-   * @param ctor The Vue constructor of the template to display.
-   * @param options Options used to configure the dialog.
-   */
-  register: DialogSequenceEntry<TSequencePayload>;
-}
-
-/**
- * Graph node configuration.
- */
-export type GraphNode<
-  TPrecedingResult = any,
-  TResult = any,
-  TPayload = any,
-  TContainerPayload = any
-> = {
-  /**
-   * The Vue constructor of the template to display.
-   */
-  ctor: DialogNodeComponent<
-    TPrecedingResult,
-    TResult,
-    TPayload,
-    TContainerPayload
-  >;
-} & SdDialogSequenceOptions<TPrecedingResult, TResult, TPayload>;
-
-export type TypeCaster = <TPR, TR, TP, TCP>(
-  node: GraphNode<TPR, TR, TP, TCP>
-) => GraphNode<TPR, TR, TP, TCP>;
-
-/**
- * Collection of nodes to include in the graph.
- */
-export interface GraphNodeList<TGraphPayload = any> {
-  [id: string]: GraphNode<any, any, any, TGraphPayload>;
-}
-
-/**
- * Mapping between node identifiers and the resolution of its destination node.
- */
-export type NodePathMap<TPayload> = {
-  [k in keyof GraphNodeList<TPayload>]: DestinationEdge<
-    GraphNodeList<TPayload>
-  >;
-};
-
-/**
- * Defines an edge identifier within the the graph.
- */
-export type DestinationEdge<TNodes> =
-  | (keyof TNodes)
-  | ((result: any, from: keyof TNodes) => (keyof TNodes) | null)
-  | null;
-
-/**
- * Function to declare an edge between two two graph nodes.
- * @param source The starting edge node.
- * @param destination The identifier or function to resolve an identifier of the end edge node.
- */
-export type EdgeCtor<TNodes> = (
-  source: keyof TNodes,
-  destination: DestinationEdge<TNodes>
-) => EdgeBuilder<TNodes>;
-
-/**
- * builder which defines the edges within a graph
- */
-export interface EdgeBuilder<TNodes> {
-  /**
-   * Function to declare an edge between two two graph nodes.
-   * @param source The starting edge node.
-   * @param destination The identifier or function to resolve an identifier of the end edge node.
-   */
-  edge: EdgeCtor<TNodes>;
-}
-
-export interface GraphBuilderEntry<TNodes extends GraphNodeList> {
-  /**
-   * Defines the entry (entry) node of the graph.
-   * @param node The identifier of the entry node.
-   * @param next Optionally defines the to destination node for the first graph edge.
-   * @returns An edge builder which defines the remaining edged within the graph.
-   */
-  entry<K extends keyof TNodes>(
-    node: K,
-    next?: DestinationEdge<TNodes>
-  ): EdgeBuilder<TNodes>;
-}
-
-/**
- * Factory which creates a the edge map of a graph.
- */
-export type GraphBuilderFactory<TNodes extends GraphNodeList> = (
-  builder: GraphBuilderEntry<TNodes>
-) => void;
-
-export declare class SdDialogGraph<TGraphPayload> {
-  /**
-   * Starts the dialog graph by displaying the entry node.
-   * @returns The result of the last dialog in the graph.
-   */
-  startAsync(): Promise<any>;
-
-  /**
-   * Manually cancels the graph execution.
-   * @param message The message or error describing think reason for cancellation.
-   */
-  cancel(message: string | Error): void;
-}
-
-export declare class SdDialogController {
-  /**
-   * Creates an instance of a single dialog.
-   * @param ctor The Vue constructor of the template to display.
-   * @param options Options used to configure the dialog.
-   */
-  static create<TReturn, TPayload, TContainerData>(
-    ctor: DialogComponent<TReturn, TPayload, TContainerData>,
-    options?: SdDialogOptions<TReturn, TPayload>
-  ): SdDialogInstance<TReturn, TPayload>;
-
-  /**
-   * Creates a sequence of dialog to progress through.
-   * @param payload Data accessible to all dialog nodes within the sequence.
-   */
-  static sequence<TSequencePayload>(
-    payload?: TSequencePayload
-  ): SdDialogSequence<TSequencePayload>;
-
-  /**
-   * Creates a bidirectional graph of dialog nodes to dynamically progress through.
-   * @param nodes The list of nodes to make up the graph.
-   * @param builder Factory used to configure the edges between nodes.
-   * @param payload Data accessible to all dialog nodes within the graph.
-   */
-  static graph<TGraphPayload>(
-    nodes: GraphNodeList<TGraphPayload>,
-    builder: GraphBuilderFactory<GraphNodeList<TGraphPayload>>,
-    payload?: TGraphPayload
-  ): SdDialogGraph<TGraphPayload>;
-
-  /**
-   * Creates an instance of an alert dialog.
-   * @param options Options used to configure the alert dialog.
-   * @param hooks Callbacks to execute when specified life-cycle hooks are reached.
-   */
-  static alert(
-    options: SdAlertDialogOptions,
-    hooks?: DialogHooks<void>
-  ): SdDialogInstance<void, SdAlertDialogOptions>;
-
-  /**
-   * Creates an instance of a confirmation dialog.
-   * @param options Options used to configure the confirmation dialog.
-   * @param hooks Callbacks to execute when specified life-cycle hooks are reached.
-   */
-  static confirm(
-    options: SdConfirmDialogOptions,
-    hooks?: DialogHooks<boolean>
-  ): SdDialogInstance<boolean, SdConfirmDialogOptions>;
-
-  /**
-   * Creates an instance of a prompt dialog.
-   * @param options Options used to configure the prompt dialog.
-   * @param hooks Callbacks to execute when specified life-cycle hooks are reached.
-   */
-  static prompt(
-    options: SdPromptDialogOptions,
-    hooks?: DialogHooks<boolean>
-  ): SdDialogInstance<any, SdPromptDialogOptions>;
-}
-
-export interface DialogComponentConstructor<
-  ReturnType,
-  Payload,
-  ContainerScopeData
-> {
-  new (): SdDialog<ReturnType, Payload, ContainerScopeData>;
-}
-
-export type GenericComponent<ReturnType, Payload, ContainerScopeData> =
-  | DialogComponentConstructor<ReturnType, Payload, ContainerScopeData>
-  | VueConstructor;
-
-export type ESModuleComponent<ReturnType, Payload, ContainerScopeData> =
-  | GenericComponent<ReturnType, Payload, ContainerScopeData>
-  | { default: GenericComponent<ReturnType, Payload, ContainerScopeData> };
-
-export type AsyncComponent<ReturnType, Payload, ContainerScopeData> = Promise<
-  ESModuleComponent<ReturnType, Payload, ContainerScopeData>
->;
-
-export type DialogComponent<ReturnType, Payload, ContainerScopeData> =
-  | ESModuleComponent<ReturnType, Payload, ContainerScopeData>
-  | AsyncComponent<ReturnType, Payload, ContainerScopeData>;
-
-// Node types
-export interface DialogNodeComponentConstructor<
-  PrecedingResult,
-  ReturnType,
-  Payload,
-  ContainerScopeData
-> {
-  new (): SdDialogNode<
-    PrecedingResult,
-    ReturnType,
-    Payload,
-    ContainerScopeData
-  >;
-}
-
-export type GenericDialogNodeComponent<
-  PrecedingResult,
-  ReturnType,
-  Payload,
-  ContainerScopeData
-> =
-  | DialogNodeComponentConstructor<
-      PrecedingResult,
-      ReturnType,
-      Payload,
-      ContainerScopeData
-    >
-  | VueConstructor;
-
-export type ESModuleDialogNodeComponent<
-  PrecedingResult,
-  ReturnType,
-  Payload,
-  ContainerScopeData
-> =
-  | GenericDialogNodeComponent<
-      PrecedingResult,
-      ReturnType,
-      Payload,
-      ContainerScopeData
-    >
-  | {
-      default: GenericDialogNodeComponent<
-        PrecedingResult,
-        ReturnType,
-        Payload,
-        ContainerScopeData
-      >;
-    };
-
-export type AsyncDialogNodeComponent<
-  PrecedingResult,
-  ReturnType,
-  Payload,
-  ContainerScopeData
-> = Promise<
-  ESModuleDialogNodeComponent<
-    PrecedingResult,
-    ReturnType,
-    Payload,
-    ContainerScopeData
-  >
->;
-
-export type DialogNodeComponent<
-  PrecedingResult,
-  ReturnType,
-  Payload,
-  ContainerScopeData
-> =
-  | ESModuleDialogNodeComponent<
-      PrecedingResult,
-      ReturnType,
-      Payload,
-      ContainerScopeData
-    >
-  | AsyncDialogNodeComponent<
-      PrecedingResult,
-      ReturnType,
-      Payload,
-      ContainerScopeData
-    >;
-
-declare const plugin: typeof SdDialog &
-  PluginObject<SdDialogPluginOptions> & {
-    /**
-     * Attached the dialog components to the app root. NOTE: This function is not necessary in Nuxt apps.
-     * @param app Root Vue app instance.
-     */
-    attach(app?: VueConstructor): void;
-  };
-
-export default plugin;
+import { MemorialUIComponent, MemorialUIPluginComponent } from './component';
+import { VueConstructor, PluginObject } from 'vue';
+import { SdDialogPluginOptions } from './options';
+import { RuleProperty } from './async-validator';
+
+declare module 'vue/types/vue' {
+  interface Vue {
+    /** Dialog controller*/
+    $dialog: typeof SdDialogController;
+  }
+}
+
+/**
+ * Callbacks to execute when certain life-cycle hooks are reached.
+ */
+export declare interface DialogHooks<ReturnType> {
+  /**
+   * Indicates that the dialog was successfully closed.
+   * @param result The result returned by the dialog instance.
+   */
+  close?: (
+    result: ReturnType,
+    cancel: (message?: string | Error) => void
+  ) => any | void;
+  /**
+   * Indicates that that dialog was closed by cancellation.
+   * @param message The error or message that described the reason for cancellation.
+   */
+  cancel?: (message: string | Error) => void;
+
+  /**
+   * Indicates that the dialog was closed in error.
+   * @param err The error or message that occurred.
+   */
+  error?: (err: string | Error) => void;
+}
+
+export declare class SdDialog<
+  TReturn,
+  TPayload,
+  TContainerPayload
+> extends MemorialUIPluginComponent {
+  /**
+   * Vue templates for common use cases.
+   */
+  static templates: {
+    alert: typeof SdAlertDialog;
+    confirm: typeof SdConfirmDialog;
+    prompt: typeof SdPromptDialog;
+  };
+
+  /**
+   * Attaches the dialog components to the app root. NOTE: This function is not necessary in Nuxt apps.
+   * @param app Root Vue app instance.
+   */
+  static attach(app?: VueConstructor): void;
+
+  /**
+   * Payload scoped to the dialog accessible within extended component template.
+   */
+  payload?: TPayload;
+
+  /**
+   * Payload scoped and accessible to the entire container controlling the dialog.
+   */
+  containerPayload?: TContainerPayload;
+
+  /**
+   * Container the dialog is mounted within.
+   */
+  container: SdDialogContainer<TContainerPayload>;
+
+  /** Unique dialog id. */
+  readonly id: string;
+
+  /**
+   * Destroys the dialog indicating that the instance life-cycle was completed.
+   * @param data Optional data returned by the dialog instance.
+   */
+  close(data: TReturn): Promise<void>;
+
+  /**
+   * Destroys the dialog indicating that the instance life-cycle was cancelled.
+   * @param message Optional message indicating why the dialog was cancelled.
+   */
+  cancel(message?: string | Error): Promise<void>;
+
+  /**
+   * Destroys the dialog indicating that an error has occurred.
+   * @param message The error or message that occurred.
+   */
+  error(message: string | Error): Promise<void>;
+}
+
+export declare class SdDialogNode<
+  TPrecedingResult,
+  TOwnResult,
+  TPayload,
+  TContainerScopeData
+> extends SdDialog<TOwnResult, TPayload, TContainerScopeData> {
+  /**
+   * Result returned by the preceding dialog in the sequence or graph.
+   */
+  precedingResult?: TPrecedingResult;
+}
+
+export declare class SdAlertDialog<TContainerPayload> extends SdDialog<
+  void,
+  SdAlertDialogOptions,
+  TContainerPayload
+> {
+  /**
+   * The alert's displayed title.
+   */
+  title: string;
+  /**
+   * The alert's message body.
+   */
+  message: string;
+}
+
+export declare class SdConfirmDialog<TContainerPayload> extends SdDialog<
+  boolean,
+  SdConfirmDialogOptions,
+  TContainerPayload
+> {
+  /**
+   * The confirmation's displayed title.
+   */
+  title: string;
+  /**
+   * The confirmation's message body.
+   */
+  message: string;
+}
+
+export declare class SdPromptDialog<TContainerPayload> extends SdDialog<
+  string,
+  SdPromptDialogOptions,
+  TContainerPayload
+> {
+  /**
+   * The prompts displayed title.
+   */
+  title: string;
+  /**
+   * The prompts message body.
+   */
+  message: string;
+}
+
+export declare class SdDialogContainer<
+  TContainerPayload
+> extends MemorialUIComponent {
+  /**
+   * Payload scoped and accessible to the entire container controlling the dialog.
+   */
+  containerPayload?: TContainerPayload;
+}
+
+export interface SdDialogOptions<TResult, TPayload> {
+  /**
+   * Payload scoped to the dialog accessible within extended component template.
+   */
+  payload?: TPayload;
+  /**
+   * Callbacks to execute when certain life-cycle hooks are reached.
+   */
+  hooks?: DialogHooks<TResult>;
+}
+
+export interface SdDialogSequenceOptions<TPrecedingResult, TResult, TPayload> {
+  /**
+   * Payload scoped to the dialog node and accessible within extended component template.
+   */
+  payload?: TPayload;
+  /**
+   * Callbacks to execute when specified life-cycle hooks are reached.
+   */
+  hooks?: DialogHooks<TResult>;
+  /**
+   * Validation functions which control the flow of execution.
+   */
+  execution?: {
+    /**
+     * Executed before proceeding to the next dialog.
+     * @param ownResult The result returned by the current dialog node.
+     * @param precedingResult The result returned by the previous dialog node
+     * @returns Boolean value indicating whether to proceed to the next dialog node.
+     */
+    beforeNext?: (
+      ownResult: TResult,
+      precedingResult: TPrecedingResult
+    ) => boolean | Promise<boolean>;
+  };
+}
+
+export interface SdAlertDialogOptions {
+  /**
+   * The title to display for the alert.
+   */
+  title: string;
+  /**
+   * The message body to display in the alert.
+   */
+  message: string;
+  /**
+   * Optional text to replace the contents of the close button.
+   */
+  closeButtonText?: string;
+}
+
+export interface SdConfirmDialogOptions {
+  /**
+   * The title to display for the confirmation.
+   */
+  title: string;
+  /**
+   * The message body to display in the confirmation.
+   */
+  message: string;
+  /**
+   * Whether to show a close button in the upper right corner of the dialog.
+   */
+  showClose?: boolean;
+  /**
+   * Optional text to replace the contents of the **Yes** button.
+   */
+  yesButtonText?: string;
+  /**
+   * Optional text to replace the contents of the **No** button.
+   */
+  noButtonText?: string;
+}
+
+export interface SdPromptDialogOptions {
+  /**
+   * The title to display for the prompt.
+   */
+  title: string;
+  /**
+   * The message body to display in the prompt.
+   */
+  message: string;
+  /**
+   * Whether an input value is required to successfully close the prompt.
+   */
+  inputRequired?: boolean;
+  /**
+   * Optional text to replace the default validation message in the event of an input validation error.
+   */
+  inputValidationMessage?: string;
+  /**
+   * Additional validation rules to apply to the input
+   */
+  rules?: RuleProperty[];
+  /**
+   * Whether to show a close button in the upper right corner of the dialog.
+   */
+  showClose?: boolean;
+  /**
+   * Optional text to replace the contents of the **Submit** button.
+   */
+  submitButtonText?: string;
+  /**
+   * Optional text to replace the contents of the **Cancel** button.
+   */
+  cancelButtonText?: string;
+}
+
+export declare class SdDialogInstance<TResult, TPayload> {
+  /**
+   * Displays the dialog.
+   * @returns A promise which gets resolved when the dialog is closed. Contains the result of the dialog.
+   */
+  showAsync(): Promise<TResult>;
+
+  /**
+   * Manually cancels the instance execution.
+   * @param message The message or error describing think reason for cancellation.
+   */
+  cancel(message: string | Error): void;
+}
+
+/**
+ * Registers the entry node dialog node of the sequence.
+ * @param ctor The Vue constructor of the template to display.
+ * @param options Options used to configure the dialog.
+ */
+interface DialogSequenceEntry<TSequencePayload> {
+  <TResult, TPayload>(
+    ctor: DialogNodeComponent<undefined, TResult, TPayload, TSequencePayload>,
+    options?: SdDialogSequenceOptions<undefined, TResult, TPayload>
+  ): {
+    /**
+     * Starts the dialog sequence by displaying the first registered node.
+     * @returns The result of the last dialog in the sequence.
+     */
+    startAsync(): Promise<TResult>;
+
+    /**
+     * Manually cancels the sequence execution.
+     * @param message The message or error describing think reason for cancellation.
+     */
+    cancel(message: string | Error): void;
+
+    /**
+     * Registers a node dialog node within the sequence.
+     * @param ctor The Vue constructor of the template to display.
+     * @param options Options used to configure the dialog.
+     */
+    register: DialogSequenceBuilder<TResult, TSequencePayload>;
+  };
+}
+
+/**
+ * Registers a node dialog node within the sequence.
+ * @param ctor The Vue constructor of the template to display.
+ * @param options Options used to configure the dialog.
+ */
+interface DialogSequenceBuilder<TPreviousResult, TSequencePayload> {
+  <TResult, TPayload>(
+    ctor: DialogNodeComponent<
+      TPreviousResult,
+      TResult,
+      TPayload,
+      TSequencePayload
+    >,
+    options?: SdDialogSequenceOptions<TPreviousResult, TResult, TPayload>
+  ): {
+    /**
+     * Starts the dialog sequence by displaying the first registered node.
+     * @returns The result of the last dialog in the sequence.
+     */
+    startAsync(): Promise<TResult>;
+
+    /**
+     * Manually cancels the sequence execution.
+     * @param message The message or error describing think reason for cancellation.
+     */
+    cancel(message: string | Error): void;
+
+    /**
+     * Registers a node dialog node within the sequence.
+     * @param ctor The Vue constructor of the template to display.
+     * @param options Options used to configure the dialog.
+     */
+    register: DialogSequenceBuilder<TResult, TSequencePayload>;
+  };
+}
+
+export declare class SdDialogSequence<TSequencePayload> {
+  /**
+   * Registers the entry node dialog node of the sequence.
+   * @param ctor The Vue constructor of the template to display.
+   * @param options Options used to configure the dialog.
+   */
+  register: DialogSequenceEntry<TSequencePayload>;
+}
+
+/**
+ * Graph node configuration.
+ */
+export type GraphNode<
+  TPrecedingResult = any,
+  TResult = any,
+  TPayload = any,
+  TContainerPayload = any
+> = {
+  /**
+   * The Vue constructor of the template to display.
+   */
+  ctor: DialogNodeComponent<
+    TPrecedingResult,
+    TResult,
+    TPayload,
+    TContainerPayload
+  >;
+} & SdDialogSequenceOptions<TPrecedingResult, TResult, TPayload>;
+
+export type TypeCaster = <TPR, TR, TP, TCP>(
+  node: GraphNode<TPR, TR, TP, TCP>
+) => GraphNode<TPR, TR, TP, TCP>;
+
+/**
+ * Collection of nodes to include in the graph.
+ */
+export interface GraphNodeList<TGraphPayload = any> {
+  [id: string]: GraphNode<any, any, any, TGraphPayload>;
+}
+
+/**
+ * Mapping between node identifiers and the resolution of its destination node.
+ */
+export type NodePathMap<TPayload> = {
+  [k in keyof GraphNodeList<TPayload>]: DestinationEdge<
+    GraphNodeList<TPayload>
+  >;
+};
+
+/**
+ * Defines an edge identifier within the the graph.
+ */
+export type DestinationEdge<TNodes> =
+  | (keyof TNodes)
+  | ((result: any, from: keyof TNodes) => (keyof TNodes) | null)
+  | null;
+
+/**
+ * Function to declare an edge between two two graph nodes.
+ * @param source The starting edge node.
+ * @param destination The identifier or function to resolve an identifier of the end edge node.
+ */
+export type EdgeCtor<TNodes> = (
+  source: keyof TNodes,
+  destination: DestinationEdge<TNodes>
+) => EdgeBuilder<TNodes>;
+
+/**
+ * builder which defines the edges within a graph
+ */
+export interface EdgeBuilder<TNodes> {
+  /**
+   * Function to declare an edge between two two graph nodes.
+   * @param source The starting edge node.
+   * @param destination The identifier or function to resolve an identifier of the end edge node.
+   */
+  edge: EdgeCtor<TNodes>;
+}
+
+export interface GraphBuilderEntry<TNodes extends GraphNodeList> {
+  /**
+   * Defines the entry (entry) node of the graph.
+   * @param node The identifier of the entry node.
+   * @param next Optionally defines the to destination node for the first graph edge.
+   * @returns An edge builder which defines the remaining edged within the graph.
+   */
+  entry<K extends keyof TNodes>(
+    node: K,
+    next?: DestinationEdge<TNodes>
+  ): EdgeBuilder<TNodes>;
+}
+
+/**
+ * Factory which creates a the edge map of a graph.
+ */
+export type GraphBuilderFactory<TNodes extends GraphNodeList> = (
+  builder: GraphBuilderEntry<TNodes>
+) => void;
+
+export declare class SdDialogGraph<TGraphPayload> {
+  /**
+   * Starts the dialog graph by displaying the entry node.
+   * @returns The result of the last dialog in the graph.
+   */
+  startAsync(): Promise<any>;
+
+  /**
+   * Manually cancels the graph execution.
+   * @param message The message or error describing think reason for cancellation.
+   */
+  cancel(message: string | Error): void;
+}
+
+export declare class SdDialogController {
+  /**
+   * Creates an instance of a single dialog.
+   * @param ctor The Vue constructor of the template to display.
+   * @param options Options used to configure the dialog.
+   */
+  static create<TReturn, TPayload, TContainerData>(
+    ctor: DialogComponent<TReturn, TPayload, TContainerData>,
+    options?: SdDialogOptions<TReturn, TPayload>
+  ): SdDialogInstance<TReturn, TPayload>;
+
+  /**
+   * Creates a sequence of dialog to progress through.
+   * @param payload Data accessible to all dialog nodes within the sequence.
+   */
+  static sequence<TSequencePayload>(
+    payload?: TSequencePayload
+  ): SdDialogSequence<TSequencePayload>;
+
+  /**
+   * Creates a bidirectional graph of dialog nodes to dynamically progress through.
+   * @param nodes The list of nodes to make up the graph.
+   * @param builder Factory used to configure the edges between nodes.
+   * @param payload Data accessible to all dialog nodes within the graph.
+   */
+  static graph<TGraphPayload>(
+    nodes: GraphNodeList<TGraphPayload>,
+    builder: GraphBuilderFactory<GraphNodeList<TGraphPayload>>,
+    payload?: TGraphPayload
+  ): SdDialogGraph<TGraphPayload>;
+
+  /**
+   * Creates an instance of an alert dialog.
+   * @param options Options used to configure the alert dialog.
+   * @param hooks Callbacks to execute when specified life-cycle hooks are reached.
+   */
+  static alert(
+    options: SdAlertDialogOptions,
+    hooks?: DialogHooks<void>
+  ): SdDialogInstance<void, SdAlertDialogOptions>;
+
+  /**
+   * Creates an instance of a confirmation dialog.
+   * @param options Options used to configure the confirmation dialog.
+   * @param hooks Callbacks to execute when specified life-cycle hooks are reached.
+   */
+  static confirm(
+    options: SdConfirmDialogOptions,
+    hooks?: DialogHooks<boolean>
+  ): SdDialogInstance<boolean, SdConfirmDialogOptions>;
+
+  /**
+   * Creates an instance of a prompt dialog.
+   * @param options Options used to configure the prompt dialog.
+   * @param hooks Callbacks to execute when specified life-cycle hooks are reached.
+   */
+  static prompt(
+    options: SdPromptDialogOptions,
+    hooks?: DialogHooks<boolean>
+  ): SdDialogInstance<any, SdPromptDialogOptions>;
+}
+
+export interface DialogComponentConstructor<
+  ReturnType,
+  Payload,
+  ContainerScopeData
+> {
+  new (): SdDialog<ReturnType, Payload, ContainerScopeData>;
+}
+
+export type GenericComponent<ReturnType, Payload, ContainerScopeData> =
+  | DialogComponentConstructor<ReturnType, Payload, ContainerScopeData>
+  | VueConstructor;
+
+export type ESModuleComponent<ReturnType, Payload, ContainerScopeData> =
+  | GenericComponent<ReturnType, Payload, ContainerScopeData>
+  | { default: GenericComponent<ReturnType, Payload, ContainerScopeData> };
+
+export type AsyncComponent<ReturnType, Payload, ContainerScopeData> = Promise<
+  ESModuleComponent<ReturnType, Payload, ContainerScopeData>
+>;
+
+export type DialogComponent<ReturnType, Payload, ContainerScopeData> =
+  | ESModuleComponent<ReturnType, Payload, ContainerScopeData>
+  | AsyncComponent<ReturnType, Payload, ContainerScopeData>;
+
+// Node types
+export interface DialogNodeComponentConstructor<
+  PrecedingResult,
+  ReturnType,
+  Payload,
+  ContainerScopeData
+> {
+  new (): SdDialogNode<
+    PrecedingResult,
+    ReturnType,
+    Payload,
+    ContainerScopeData
+  >;
+}
+
+export type GenericDialogNodeComponent<
+  PrecedingResult,
+  ReturnType,
+  Payload,
+  ContainerScopeData
+> =
+  | DialogNodeComponentConstructor<
+      PrecedingResult,
+      ReturnType,
+      Payload,
+      ContainerScopeData
+    >
+  | VueConstructor;
+
+export type ESModuleDialogNodeComponent<
+  PrecedingResult,
+  ReturnType,
+  Payload,
+  ContainerScopeData
+> =
+  | GenericDialogNodeComponent<
+      PrecedingResult,
+      ReturnType,
+      Payload,
+      ContainerScopeData
+    >
+  | {
+      default: GenericDialogNodeComponent<
+        PrecedingResult,
+        ReturnType,
+        Payload,
+        ContainerScopeData
+      >;
+    };
+
+export type AsyncDialogNodeComponent<
+  PrecedingResult,
+  ReturnType,
+  Payload,
+  ContainerScopeData
+> = Promise<
+  ESModuleDialogNodeComponent<
+    PrecedingResult,
+    ReturnType,
+    Payload,
+    ContainerScopeData
+  >
+>;
+
+export type DialogNodeComponent<
+  PrecedingResult,
+  ReturnType,
+  Payload,
+  ContainerScopeData
+> =
+  | ESModuleDialogNodeComponent<
+      PrecedingResult,
+      ReturnType,
+      Payload,
+      ContainerScopeData
+    >
+  | AsyncDialogNodeComponent<
+      PrecedingResult,
+      ReturnType,
+      Payload,
+      ContainerScopeData
+    >;
+
+declare const plugin: typeof SdDialog &
+  PluginObject<SdDialogPluginOptions> & {
+    /**
+     * Attached the dialog components to the app root. NOTE: This function is not necessary in Nuxt apps.
+     * @param app Root Vue app instance.
+     */
+    attach(app?: VueConstructor): void;
+  };
+
+export default plugin;