@stencil/dev-server 0.0.19-0 → 5.0.0-alpha.1

package/{LICENSE → LICENSE.md}

@@ -1,6 +1,6 @@
-MIT License
+The MIT License (MIT)
 
-Copyright (c) 2017 Josh Thomas
+Copyright (c) 2019-present Drifty Co.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -9,13 +9,19 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+-----------------------------------------
+Third-party components, software, and/or libraries (collectively, "components")
+are included under the licenses specified by their authors. For information
+about these third-party licenses, refer to the separate legal notices governing
+such components at NOTICE file at the top level of the package.

package/dist/client/index.d.ts

@@ -0,0 +1,132 @@
+import { CompilerBuildResults, Diagnostic, HmrStyleUpdate, HotModuleReplacement, PrintLine } from "@stencil/core/compiler";
+
+//#region src/client/types.d.ts
+interface DevClientWindow extends Window {
+  's-dev-server'?: boolean;
+  's-initial-load'?: boolean;
+  's-build-id'?: number;
+  devServerConfig?: DevClientConfig;
+  WebSocket: typeof WebSocket;
+}
+interface DevClientConfig {
+  basePath: string;
+  editors: DevServerEditor[];
+  reloadStrategy: 'hmr' | 'pageReload' | null;
+  socketUrl?: string;
+}
+interface DevServerEditor {
+  id: string;
+  name?: string;
+}
+interface DevServerMessage {
+  buildResults?: CompilerBuildResults;
+  buildLog?: BuildLog;
+  isActivelyBuilding?: boolean;
+  requestBuildResults?: boolean;
+}
+interface BuildLog {
+  buildId: number;
+  messages: string[];
+  progress: number;
+}
+interface HostElement extends Element {
+  's-hmr'?: (versionId: string) => void;
+}
+interface OpenInEditorData {
+  file?: string;
+  line?: number;
+  column?: number;
+  editor?: string;
+}
+interface HmrResults {
+  updatedComponents: string[];
+  updatedExternalStyles: string[];
+  updatedInlineStyles: string[];
+  updatedImages: string[];
+  versionId: string;
+}
+//#endregion
+//#region src/client/constants.d.ts
+/**
+ * Client-side constants for dev server.
+ */
+declare const DEV_SERVER_URL = "/~dev-server";
+declare const DEV_SERVER_INIT_URL = "/~dev-server-init";
+declare const OPEN_IN_EDITOR_URL = "/~dev-server-open-in-editor";
+declare const BUILD_LOG = "devserver:buildlog";
+declare const BUILD_RESULTS = "devserver:buildresults";
+declare const BUILD_STATUS = "devserver:buildstatus";
+declare const NODE_TYPE_ELEMENT = 1;
+declare const NODE_TYPE_DOCUMENT_FRAGMENT = 11;
+declare const RECONNECT_ATTEMPTS = 1000;
+declare const RECONNECT_RETRY_MS = 2500;
+declare const NORMAL_CLOSURE_CODE = 1000;
+declare const REQUEST_BUILD_RESULTS_INTERVAL_MS = 500;
+//#endregion
+//#region src/client/error.d.ts
+interface AppErrorData {
+  window: Window;
+  buildResults: any;
+  openInEditor?: OpenInEditorCallback;
+}
+type OpenInEditorCallback = (data: {
+  file: string;
+  line: number;
+  column: number;
+}) => void;
+interface AppErrorResults {
+  diagnostics: Diagnostic[];
+  status: null | string;
+}
+declare const appError: (data: AppErrorData) => AppErrorResults;
+declare const clearAppErrorModal: (data: {
+  window: Window;
+}) => void;
+//#endregion
+//#region src/client/events.d.ts
+declare const emitBuildLog: (win: Window, buildLog: BuildLog) => void;
+declare const emitBuildResults: (win: Window, buildResults: CompilerBuildResults) => void;
+declare const emitBuildStatus: (win: Window, buildStatus: string) => void;
+declare const onBuildLog: (win: Window, cb: (buildLog: BuildLog) => void) => void;
+declare const onBuildResults: (win: Window, cb: (buildResults: CompilerBuildResults) => void) => void;
+declare const onBuildStatus: (win: Window, cb: (buildStatus: string) => void) => void;
+//#endregion
+//#region src/client/hmr/window.d.ts
+interface HmrWindowData {
+  window: Window;
+  hmr: HotModuleReplacement;
+}
+declare const hmrWindow: (data: HmrWindowData) => HmrResults;
+//#endregion
+//#region src/client/logger.d.ts
+declare const logBuild: (msg: string) => void;
+declare const logReload: (msg: string) => void;
+declare const logWarn: (prefix: string, msg: string) => void;
+declare const logDisabled: (prefix: string, msg: string) => void;
+declare const logDiagnostic: (diag: Diagnostic) => void;
+//#endregion
+//#region src/client/status.d.ts
+/**
+ * Build status and favicon utilities for dev server client.
+ */
+declare const initBuildStatus: (data: {
+  window: Window;
+}) => void;
+declare const updateFavIcon: (linkElm: HTMLLinkElement, status: string) => void;
+declare const initBuildProgress: (data: {
+  window: Window;
+}) => void;
+//#endregion
+//#region src/client/websocket.d.ts
+declare const initClientWebSocket: (win: DevClientWindow, config: DevClientConfig) => void;
+//#endregion
+//#region src/client/index.d.ts
+/**
+ * Initialize the dev server client in the browser.
+ *
+ * @param win - the dev client window object
+ * @param config - the dev client configuration
+ */
+declare const initDevClient: (win: DevClientWindow, config: DevClientConfig) => void;
+//#endregion
+export { BUILD_LOG, BUILD_RESULTS, BUILD_STATUS, BuildLog, type CompilerBuildResults, DEV_SERVER_INIT_URL, DEV_SERVER_URL, DevClientConfig, DevClientWindow, DevServerEditor, DevServerMessage, type Diagnostic, HmrResults, type HmrStyleUpdate, HostElement, type HotModuleReplacement, NODE_TYPE_DOCUMENT_FRAGMENT, NODE_TYPE_ELEMENT, NORMAL_CLOSURE_CODE, OPEN_IN_EDITOR_URL, OpenInEditorData, type PrintLine, RECONNECT_ATTEMPTS, RECONNECT_RETRY_MS, REQUEST_BUILD_RESULTS_INTERVAL_MS, appError, clearAppErrorModal, emitBuildLog, emitBuildResults, emitBuildStatus, hmrWindow, initBuildProgress, initBuildStatus, initClientWebSocket, initDevClient, logBuild, logDiagnostic, logDisabled, logReload, logWarn, onBuildLog, onBuildResults, onBuildStatus, updateFavIcon };