@sdeverywhere/check-ui-shell 0.2.25 → 0.2.27

package/dist/index.d.ts

@@ -1,102 +1,105 @@
-import { SuiteSummary, ConfigOptions } from '@sdeverywhere/check-core';
-
+import { ConfigOptions, SuiteSummary } from "@sdeverywhere/check-core";
+//#region src/components/bundle/bundle-spec.d.ts
 /**
  * Describes the location of a model-check bundle file.
  */
 interface BundleLocation {
-    /** The URL for the bundle JS file. */
-    url: string;
-    /** The display name of the bundle. */
-    name: string;
-    /** The last modified date of the bundle in ISO 8601 format. */
-    lastModified: string;
+  /** The URL for the bundle JS file. */
+  url: string;
+  /** The display name of the bundle. */
+  name: string;
+  /** The last modified date of the bundle in ISO 8601 format. */
+  lastModified: string;
 }
 /**
  * Describes a model-check bundle file that can be loaded from the network or from a local file.
  */
 interface BundleSpec {
-    /** The remote location of the bundle file. */
-    remote?: BundleLocation;
-    /** The local location of the bundle file. */
-    local?: BundleLocation;
+  /** The remote location of the bundle file. */
+  remote?: BundleLocation;
+  /** The local location of the bundle file. */
+  local?: BundleLocation;
 }
-
+//#endregion
+//#region src/components/bundle/bundle-selector-config.d.ts
 /**
  * Configuration options for the `BundleSelector` component.
  */
 interface BundleSelectorConfig {
-    /**
-     * The URL of the initial "left" bundle.
-     */
-    bundleUrlL?: string;
-    /**
-     * The URL of the initial "right" bundle.
-     */
-    bundleUrlR?: string;
-    /**
-     * Optional URL to a JSON file containing the list of remote bundles.
-     *
-     * The URL should point to a JSON file that contains an array of `BundleLocation` objects.
-     */
-    remoteBundlesUrl?: string;
-    /**
-     * Get the list of locally available bundles.
-     *
-     * This function is invoked when the bundle selector is initialized to fetch the list of bundles
-     * that are available in the local bundles directory.
-     *
-     * @returns A promise that resolves to an array of bundle locations.
-     */
-    getLocalBundles?: () => Promise<BundleLocation[]>;
-    /**
-     * Download a remote bundle from the network to the local bundles directory.
-     *
-     * This function is invoked when the user clicks the download button for a bundle in the bundle selector.
-     * The implementation should fetch the bundle's JS file from the remote URL and save it to the local
-     * bundles directory.
-     *
-     * @param bundle The bundle to download.
-     */
-    downloadBundle?: (bundle: BundleSpec) => void;
-    /**
-     * Copy a local bundle file to a new name.
-     *
-     * This function is invoked when the user clicks the copy button for a bundle in the bundle selector.
-     * The implementation should copy the bundle file to the local bundle directory with the new name.
-     *
-     * @param bundle The bundle to copy.
-     * @param newName The new name for the copied bundle.
-     */
-    copyBundle?: (bundle: BundleSpec, newName: string) => void;
-    /**
-     * Add a listener that is notified when there are file system changes detected in the
-     * local bundles directory.
-     *
-     * This function is invoked when the bundle selector is initialized.  The implementation should
-     * register the given listener function, which will be invoked when there are file system changes.
-     *
-     * @param listener The function to invoke when there are file system changes detected in the
-     * local bundles directory.
-     */
-    onBundlesChanged?: (listener: () => void) => void;
+  /**
+   * The URL of the initial "left" bundle.
+   */
+  bundleUrlL?: string;
+  /**
+   * The URL of the initial "right" bundle.
+   */
+  bundleUrlR?: string;
+  /**
+   * Optional URL to a JSON file containing the list of remote bundles.
+   *
+   * The URL should point to a JSON file that contains an array of `BundleLocation` objects.
+   */
+  remoteBundlesUrl?: string;
+  /**
+   * Get the list of locally available bundles.
+   *
+   * This function is invoked when the bundle selector is initialized to fetch the list of bundles
+   * that are available in the local bundles directory.
+   *
+   * @returns A promise that resolves to an array of bundle locations.
+   */
+  getLocalBundles?: () => Promise<BundleLocation[]>;
+  /**
+   * Download a remote bundle from the network to the local bundles directory.
+   *
+   * This function is invoked when the user clicks the download button for a bundle in the bundle selector.
+   * The implementation should fetch the bundle's JS file from the remote URL and save it to the local
+   * bundles directory.
+   *
+   * @param bundle The bundle to download.
+   */
+  downloadBundle?: (bundle: BundleSpec) => void;
+  /**
+   * Copy a local bundle file to a new name.
+   *
+   * This function is invoked when the user clicks the copy button for a bundle in the bundle selector.
+   * The implementation should copy the bundle file to the local bundle directory with the new name.
+   *
+   * @param bundle The bundle to copy.
+   * @param newName The new name for the copied bundle.
+   */
+  copyBundle?: (bundle: BundleSpec, newName: string) => void;
+  /**
+   * Add a listener that is notified when there are file system changes detected in the
+   * local bundles directory.
+   *
+   * This function is invoked when the bundle selector is initialized.  The implementation should
+   * register the given listener function, which will be invoked when there are file system changes.
+   *
+   * @param listener The function to invoke when there are file system changes detected in the
+   * local bundles directory.
+   */
+  onBundlesChanged?: (listener: () => void) => void;
 }
-
+//#endregion
+//#region src/app-shell-options.d.ts
 interface AppShellOptions {
-    /** The ID of the container element that will host the app shell (default is 'app-shell-container'). */
-    containerId?: string;
-    /**
-     * An object containing the results of a model-check run.  This is used when generating a report
-     * that already has the test results available so that they don't need to be run again when the
-     * user opens the report in the browser.
-     */
-    suiteSummary?: SuiteSummary;
-    /**
-     * The options used to configure the bundle selector component.  This is only used in local
-     * development mode and will be ignored when building for production.
-     */
-    bundleSelectorConfig?: BundleSelectorConfig;
+  /** The ID of the container element that will host the app shell (default is 'app-shell-container'). */
+  containerId?: string;
+  /**
+   * An object containing the results of a model-check run.  This is used when generating a report
+   * that already has the test results available so that they don't need to be run again when the
+   * user opens the report in the browser.
+   */
+  suiteSummary?: SuiteSummary;
+  /**
+   * The options used to configure the bundle selector component.  This is only used in local
+   * development mode and will be ignored when building for production.
+   */
+  bundleSelectorConfig?: BundleSelectorConfig;
 }
-
-declare function initAppShell(configOptions: ConfigOptions, appShellOptions?: AppShellOptions): void;
-
-export { type AppShellOptions, type BundleLocation, type BundleSelectorConfig, type BundleSpec, initAppShell };
+//#endregion
+//#region src/app-init.d.ts
+export declare function initAppShell(configOptions: ConfigOptions, appShellOptions?: AppShellOptions): void;
+//#endregion
+export type { AppShellOptions, BundleLocation, BundleSelectorConfig, BundleSpec };