@microsoft/dev-tunnels-contracts 1.3.6 → 1.3.37

package/tunnelEndpoint.d.ts

@@ -1,77 +1,77 @@
-import { TunnelConnectionMode } from './tunnelConnectionMode';
-/**
- * Base class for tunnel connection parameters.
- *
- * A tunnel endpoint specifies how and where hosts and clients can connect to a tunnel.
- * There is a subclass for each connection mode, each having different connection
- * parameters. A tunnel may have multiple endpoints for one host (or multiple hosts), and
- * clients can select their preferred endpoint(s) from those depending on network
- * environment or client capabilities.
- */
-export interface TunnelEndpoint {
-    /**
-     * Gets or sets the ID of this endpoint.
-     */
-    id?: string;
-    /**
-     * Gets or sets the connection mode of the endpoint.
-     *
-     * This property is required when creating or updating an endpoint.  The subclass type
-     * is also an indication of the connection mode, but this property is necessary to
-     * determine the subclass type when deserializing.
-     */
-    connectionMode: TunnelConnectionMode;
-    /**
-     * Gets or sets the ID of the host that is listening on this endpoint.
-     *
-     * This property is required when creating or updating an endpoint.  If the host
-     * supports multiple connection modes, the host's ID is the same for all the endpoints
-     * it supports. However different hosts may simultaneously accept connections at
-     * different endpoints for the same tunnel, if enabled in tunnel options.
-     */
-    hostId: string;
-    /**
-     * Gets or sets an array of public keys, which can be used by clients to authenticate
-     * the host.
-     */
-    hostPublicKeys?: string[];
-    /**
-     * Gets or sets a string used to format URIs where a web client can connect to ports
-     * of the tunnel. The string includes a {@link TunnelEndpoint.portToken} that must be
-     * replaced with the actual port number.
-     */
-    portUriFormat?: string;
-    /**
-     * Gets or sets the URI where a web client can connect to the default port of the
-     * tunnel.
-     */
-    tunnelUri?: string;
-    /**
-     * Gets or sets a string used to format ssh command where ssh client can connect to
-     * shared ssh port of the tunnel. The string includes a {@link
-     * TunnelEndpoint.portToken} that must be replaced with the actual port number.
-     */
-    portSshCommandFormat?: string;
-    /**
-     * Gets or sets the Ssh command where the Ssh client can connect to the default ssh
-     * port of the tunnel.
-     */
-    tunnelSshCommand?: string;
-    /**
-     * Gets or sets the Ssh gateway public key which should be added to the
-     * authorized_keys file so that tunnel service can connect to the shared ssh server.
-     */
-    sshGatewayPublicKey?: string;
-}
-/**
- * Token included in {@link TunnelEndpoint.portUriFormat} and {@link
- * TunnelEndpoint.portSshCommandFormat} that is to be replaced by a specified port number.
- */
-export declare const portToken = "{port}";
-import { getPortUri, getPortSshCommand } from './tunnelEndpointStatics';
-export declare const TunnelEndpoint: {
-    portToken: string;
-    getPortUri: typeof getPortUri;
-    getPortSshCommand: typeof getPortSshCommand;
-};
+import { TunnelConnectionMode } from './tunnelConnectionMode';
+/**
+ * Base class for tunnel connection parameters.
+ *
+ * A tunnel endpoint specifies how and where hosts and clients can connect to a tunnel.
+ * There is a subclass for each connection mode, each having different connection
+ * parameters. A tunnel may have multiple endpoints for one host (or multiple hosts), and
+ * clients can select their preferred endpoint(s) from those depending on network
+ * environment or client capabilities.
+ */
+export interface TunnelEndpoint {
+    /**
+     * Gets or sets the ID of this endpoint.
+     */
+    id?: string;
+    /**
+     * Gets or sets the connection mode of the endpoint.
+     *
+     * This property is required when creating or updating an endpoint.  The subclass type
+     * is also an indication of the connection mode, but this property is necessary to
+     * determine the subclass type when deserializing.
+     */
+    connectionMode: TunnelConnectionMode;
+    /**
+     * Gets or sets the ID of the host that is listening on this endpoint.
+     *
+     * This property is required when creating or updating an endpoint.  If the host
+     * supports multiple connection modes, the host's ID is the same for all the endpoints
+     * it supports. However different hosts may simultaneously accept connections at
+     * different endpoints for the same tunnel, if enabled in tunnel options.
+     */
+    hostId: string;
+    /**
+     * Gets or sets an array of public keys, which can be used by clients to authenticate
+     * the host.
+     */
+    hostPublicKeys?: string[];
+    /**
+     * Gets or sets a string used to format URIs where a web client can connect to ports
+     * of the tunnel. The string includes a {@link TunnelEndpoint.portToken} that must be
+     * replaced with the actual port number.
+     */
+    portUriFormat?: string;
+    /**
+     * Gets or sets the URI where a web client can connect to the default port of the
+     * tunnel.
+     */
+    tunnelUri?: string;
+    /**
+     * Gets or sets a string used to format ssh command where ssh client can connect to
+     * shared ssh port of the tunnel. The string includes a {@link
+     * TunnelEndpoint.portToken} that must be replaced with the actual port number.
+     */
+    portSshCommandFormat?: string;
+    /**
+     * Gets or sets the Ssh command where the Ssh client can connect to the default ssh
+     * port of the tunnel.
+     */
+    tunnelSshCommand?: string;
+    /**
+     * Gets or sets the Ssh gateway public key which should be added to the
+     * authorized_keys file so that tunnel service can connect to the shared ssh server.
+     */
+    sshGatewayPublicKey?: string;
+}
+/**
+ * Token included in {@link TunnelEndpoint.portUriFormat} and {@link
+ * TunnelEndpoint.portSshCommandFormat} that is to be replaced by a specified port number.
+ */
+export declare const portToken = "{port}";
+import { getPortUri, getPortSshCommand } from './tunnelEndpointStatics';
+export declare const TunnelEndpoint: {
+    portToken: string;
+    getPortUri: typeof getPortUri;
+    getPortSshCommand: typeof getPortSshCommand;
+};
 //# sourceMappingURL=tunnelEndpoint.d.ts.map

package/tunnelEndpoint.js

@@ -1,21 +1,21 @@
-"use strict";
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-// Generated from ../../../cs/src/Contracts/TunnelEndpoint.cs
-/* eslint-disable */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TunnelEndpoint = exports.portToken = void 0;
-/**
- * Token included in {@link TunnelEndpoint.portUriFormat} and {@link
- * TunnelEndpoint.portSshCommandFormat} that is to be replaced by a specified port number.
- */
-exports.portToken = '{port}';
-// Import static members from a non-generated file,
-// and re-export them as an object with the same name as the interface.
-const tunnelEndpointStatics_1 = require("./tunnelEndpointStatics");
-exports.TunnelEndpoint = {
-    portToken: exports.portToken,
-    getPortUri: tunnelEndpointStatics_1.getPortUri,
-    getPortSshCommand: tunnelEndpointStatics_1.getPortSshCommand,
-};
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+// Generated from ../../../cs/src/Contracts/TunnelEndpoint.cs
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TunnelEndpoint = exports.portToken = void 0;
+/**
+ * Token included in {@link TunnelEndpoint.portUriFormat} and {@link
+ * TunnelEndpoint.portSshCommandFormat} that is to be replaced by a specified port number.
+ */
+exports.portToken = '{port}';
+// Import static members from a non-generated file,
+// and re-export them as an object with the same name as the interface.
+const tunnelEndpointStatics_1 = require("./tunnelEndpointStatics");
+exports.TunnelEndpoint = {
+    portToken: exports.portToken,
+    getPortUri: tunnelEndpointStatics_1.getPortUri,
+    getPortSshCommand: tunnelEndpointStatics_1.getPortSshCommand,
+};
 //# sourceMappingURL=tunnelEndpoint.js.map

package/tunnelEndpointStatics.d.ts

@@ -1,20 +1,20 @@
-import { TunnelEndpoint as ITunnelEndpoint } from './tunnelEndpoint';
-/**
- * Gets a URI where a web client can connect to a tunnel port.
- *
- * Requests to the URI may result in HTTP 307 redirections, so the client may need to
- * follow the redirection in order to connect to the port.
- *
- * If the port is not currently shared via the tunnel, or if a host is not currently
- * connected to the tunnel, then requests to the port URI may result in a 502 Bad Gateway
- * response.
- *
- * @param endpoint The tunnel endpoint containing connection information.
- * @param portNumber The port number to connect to; the port is assumed to be
- * separately shared by a tunnel host.
- * @returns URI for the requested port, or `undefined` if the endpoint does not support
- * web client connections.
- */
-export declare function getPortUri(endpoint: ITunnelEndpoint, portNumber?: number): string | undefined;
-export declare function getPortSshCommand(endpoint: ITunnelEndpoint, portNumber?: number): string | undefined;
+import { TunnelEndpoint as ITunnelEndpoint } from './tunnelEndpoint';
+/**
+ * Gets a URI where a web client can connect to a tunnel port.
+ *
+ * Requests to the URI may result in HTTP 307 redirections, so the client may need to
+ * follow the redirection in order to connect to the port.
+ *
+ * If the port is not currently shared via the tunnel, or if a host is not currently
+ * connected to the tunnel, then requests to the port URI may result in a 502 Bad Gateway
+ * response.
+ *
+ * @param endpoint The tunnel endpoint containing connection information.
+ * @param portNumber The port number to connect to; the port is assumed to be
+ * separately shared by a tunnel host.
+ * @returns URI for the requested port, or `undefined` if the endpoint does not support
+ * web client connections.
+ */
+export declare function getPortUri(endpoint: ITunnelEndpoint, portNumber?: number): string | undefined;
+export declare function getPortSshCommand(endpoint: ITunnelEndpoint, portNumber?: number): string | undefined;
 //# sourceMappingURL=tunnelEndpointStatics.d.ts.map

package/tunnelEndpointStatics.js

@@ -1,49 +1,49 @@
-"use strict";
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getPortSshCommand = exports.getPortUri = void 0;
-const tunnelEndpoint_1 = require("./tunnelEndpoint");
-/**
- * Gets a URI where a web client can connect to a tunnel port.
- *
- * Requests to the URI may result in HTTP 307 redirections, so the client may need to
- * follow the redirection in order to connect to the port.
- *
- * If the port is not currently shared via the tunnel, or if a host is not currently
- * connected to the tunnel, then requests to the port URI may result in a 502 Bad Gateway
- * response.
- *
- * @param endpoint The tunnel endpoint containing connection information.
- * @param portNumber The port number to connect to; the port is assumed to be
- * separately shared by a tunnel host.
- * @returns URI for the requested port, or `undefined` if the endpoint does not support
- * web client connections.
- */
-function getPortUri(endpoint, portNumber) {
-    if (!endpoint) {
-        throw new TypeError('A tunnel endpoint is required.');
-    }
-    if (typeof portNumber !== 'number' && !endpoint.tunnelUri) {
-        return endpoint.tunnelUri;
-    }
-    if (typeof portNumber !== 'number' || !endpoint.portUriFormat) {
-        return undefined;
-    }
-    return endpoint.portUriFormat.replace(tunnelEndpoint_1.portToken, portNumber.toString());
-}
-exports.getPortUri = getPortUri;
-function getPortSshCommand(endpoint, portNumber) {
-    if (!endpoint) {
-        throw new TypeError('A tunnel endpoint is required.');
-    }
-    if (typeof portNumber !== 'number' && !endpoint.tunnelSshCommand) {
-        return endpoint.tunnelSshCommand;
-    }
-    if (typeof portNumber !== 'number' || !endpoint.portSshCommandFormat) {
-        return undefined;
-    }
-    return endpoint.portSshCommandFormat.replace(tunnelEndpoint_1.portToken, portNumber.toString());
-}
-exports.getPortSshCommand = getPortSshCommand;
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPortSshCommand = exports.getPortUri = void 0;
+const tunnelEndpoint_1 = require("./tunnelEndpoint");
+/**
+ * Gets a URI where a web client can connect to a tunnel port.
+ *
+ * Requests to the URI may result in HTTP 307 redirections, so the client may need to
+ * follow the redirection in order to connect to the port.
+ *
+ * If the port is not currently shared via the tunnel, or if a host is not currently
+ * connected to the tunnel, then requests to the port URI may result in a 502 Bad Gateway
+ * response.
+ *
+ * @param endpoint The tunnel endpoint containing connection information.
+ * @param portNumber The port number to connect to; the port is assumed to be
+ * separately shared by a tunnel host.
+ * @returns URI for the requested port, or `undefined` if the endpoint does not support
+ * web client connections.
+ */
+function getPortUri(endpoint, portNumber) {
+    if (!endpoint) {
+        throw new TypeError('A tunnel endpoint is required.');
+    }
+    if (typeof portNumber !== 'number' && !endpoint.tunnelUri) {
+        return endpoint.tunnelUri;
+    }
+    if (typeof portNumber !== 'number' || !endpoint.portUriFormat) {
+        return undefined;
+    }
+    return endpoint.portUriFormat.replace(tunnelEndpoint_1.portToken, portNumber.toString());
+}
+exports.getPortUri = getPortUri;
+function getPortSshCommand(endpoint, portNumber) {
+    if (!endpoint) {
+        throw new TypeError('A tunnel endpoint is required.');
+    }
+    if (typeof portNumber !== 'number' && !endpoint.tunnelSshCommand) {
+        return endpoint.tunnelSshCommand;
+    }
+    if (typeof portNumber !== 'number' || !endpoint.portSshCommandFormat) {
+        return undefined;
+    }
+    return endpoint.portSshCommandFormat.replace(tunnelEndpoint_1.portToken, portNumber.toString());
+}
+exports.getPortSshCommand = getPortSshCommand;
 //# sourceMappingURL=tunnelEndpointStatics.js.map

package/tunnelEvent.d.ts

@@ -1,49 +1,49 @@
-/**
- * Data contract for tunnel client events reported to the tunnel service.
- */
-export interface TunnelEvent {
-    /**
-     * Gets or sets the UTC timestamp of the event (using the client's clock).
-     */
-    timestamp?: Date;
-    /**
-     * Gets or sets name of the event. This should be a short descriptive identifier.
-     */
-    name: string;
-    /**
-     * Gets or sets the severity of the event, such as {@link TunnelEvent.info}, {@link
-     * TunnelEvent.warning}, or {@link TunnelEvent.error}.
-     *
-     * If not specified, the default severity is "info".
-     */
-    severity?: string;
-    /**
-     * Gets or sets optional unstructured details about the event, such as a message or
-     * description. For warning or error events this may include a stack trace.
-     */
-    details?: string;
-    /**
-     * Gets or sets semi-structured event properties.
-     */
-    properties?: {
-        [key: string]: string;
-    };
-}
-/**
- * Default event severity.
- */
-export declare const info = "info";
-/**
- * Warning event severity.
- */
-export declare const warning = "warning";
-/**
- * Error event severity.
- */
-export declare const error = "error";
-export declare const TunnelEvent: {
-    info: string;
-    warning: string;
-    error: string;
-};
+/**
+ * Data contract for tunnel client events reported to the tunnel service.
+ */
+export interface TunnelEvent {
+    /**
+     * Gets or sets the UTC timestamp of the event (using the client's clock).
+     */
+    timestamp?: Date;
+    /**
+     * Gets or sets name of the event. This should be a short descriptive identifier.
+     */
+    name: string;
+    /**
+     * Gets or sets the severity of the event, such as {@link TunnelEvent.info}, {@link
+     * TunnelEvent.warning}, or {@link TunnelEvent.error}.
+     *
+     * If not specified, the default severity is "info".
+     */
+    severity?: string;
+    /**
+     * Gets or sets optional unstructured details about the event, such as a message or
+     * description. For warning or error events this may include a stack trace.
+     */
+    details?: string;
+    /**
+     * Gets or sets semi-structured event properties.
+     */
+    properties?: {
+        [key: string]: string;
+    };
+}
+/**
+ * Default event severity.
+ */
+export declare const info = "info";
+/**
+ * Warning event severity.
+ */
+export declare const warning = "warning";
+/**
+ * Error event severity.
+ */
+export declare const error = "error";
+export declare const TunnelEvent: {
+    info: string;
+    warning: string;
+    error: string;
+};
 //# sourceMappingURL=tunnelEvent.d.ts.map

package/tunnelEvent.js

@@ -1,25 +1,25 @@
-"use strict";
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-// Generated from ../../../cs/src/Contracts/TunnelEvent.cs
-/* eslint-disable */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TunnelEvent = exports.error = exports.warning = exports.info = void 0;
-/**
- * Default event severity.
- */
-exports.info = 'info';
-/**
- * Warning event severity.
- */
-exports.warning = 'warning';
-/**
- * Error event severity.
- */
-exports.error = 'error';
-exports.TunnelEvent = {
-    info: exports.info,
-    warning: exports.warning,
-    error: exports.error,
-};
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+// Generated from ../../../cs/src/Contracts/TunnelEvent.cs
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TunnelEvent = exports.error = exports.warning = exports.info = void 0;
+/**
+ * Default event severity.
+ */
+exports.info = 'info';
+/**
+ * Warning event severity.
+ */
+exports.warning = 'warning';
+/**
+ * Error event severity.
+ */
+exports.error = 'error';
+exports.TunnelEvent = {
+    info: exports.info,
+    warning: exports.warning,
+    error: exports.error,
+};
 //# sourceMappingURL=tunnelEvent.js.map

package/tunnelHeaderNames.d.ts

@@ -1,28 +1,28 @@
-/**
- * Header names for http requests that Tunnel Service can handle
- */
-export declare enum TunnelHeaderNames {
-    /**
-     * Additional authorization header that can be passed to tunnel web forwarding to
-     * authenticate and authorize the client. The format of the value is the same as
-     * Authorization header that is sent to the Tunnel service by the tunnel SDK.
-     * Supported schemes: "tunnel" with the tunnel access JWT good for 'Connect' scope.
-     */
-    XTunnelAuthorization = "X-Tunnel-Authorization",
-    /**
-     * Request ID header that nginx ingress controller adds to all requests if it's not
-     * there.
-     */
-    XRequestID = "X-Request-ID",
-    /**
-     * Github Ssh public key which can be used to validate if it belongs to tunnel's
-     * owner.
-     */
-    XGithubSshKey = "X-Github-Ssh-Key",
-    /**
-     * Header that will skip the antiphishing page when connection to a tunnel through web
-     * forwarding.
-     */
-    XTunnelSkipAntiPhishingPage = "X-Tunnel-Skip-AntiPhishing-Page"
-}
+/**
+ * Header names for http requests that Tunnel Service can handle
+ */
+export declare enum TunnelHeaderNames {
+    /**
+     * Additional authorization header that can be passed to tunnel web forwarding to
+     * authenticate and authorize the client. The format of the value is the same as
+     * Authorization header that is sent to the Tunnel service by the tunnel SDK.
+     * Supported schemes: "tunnel" with the tunnel access JWT good for 'Connect' scope.
+     */
+    XTunnelAuthorization = "X-Tunnel-Authorization",
+    /**
+     * Request ID header that nginx ingress controller adds to all requests if it's not
+     * there.
+     */
+    XRequestID = "X-Request-ID",
+    /**
+     * Github Ssh public key which can be used to validate if it belongs to tunnel's
+     * owner.
+     */
+    XGithubSshKey = "X-Github-Ssh-Key",
+    /**
+     * Header that will skip the antiphishing page when connection to a tunnel through web
+     * forwarding.
+     */
+    XTunnelSkipAntiPhishingPage = "X-Tunnel-Skip-AntiPhishing-Page"
+}
 //# sourceMappingURL=tunnelHeaderNames.d.ts.map

package/tunnelHeaderNames.js

@@ -1,36 +1,36 @@
-"use strict";
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-// Generated from ../../../cs/src/Contracts/TunnelHeaderNames.cs
-/* eslint-disable */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TunnelHeaderNames = void 0;
-/**
- * Header names for http requests that Tunnel Service can handle
- */
-var TunnelHeaderNames;
-(function (TunnelHeaderNames) {
-    /**
-     * Additional authorization header that can be passed to tunnel web forwarding to
-     * authenticate and authorize the client. The format of the value is the same as
-     * Authorization header that is sent to the Tunnel service by the tunnel SDK.
-     * Supported schemes: "tunnel" with the tunnel access JWT good for 'Connect' scope.
-     */
-    TunnelHeaderNames["XTunnelAuthorization"] = "X-Tunnel-Authorization";
-    /**
-     * Request ID header that nginx ingress controller adds to all requests if it's not
-     * there.
-     */
-    TunnelHeaderNames["XRequestID"] = "X-Request-ID";
-    /**
-     * Github Ssh public key which can be used to validate if it belongs to tunnel's
-     * owner.
-     */
-    TunnelHeaderNames["XGithubSshKey"] = "X-Github-Ssh-Key";
-    /**
-     * Header that will skip the antiphishing page when connection to a tunnel through web
-     * forwarding.
-     */
-    TunnelHeaderNames["XTunnelSkipAntiPhishingPage"] = "X-Tunnel-Skip-AntiPhishing-Page";
-})(TunnelHeaderNames = exports.TunnelHeaderNames || (exports.TunnelHeaderNames = {}));
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+// Generated from ../../../cs/src/Contracts/TunnelHeaderNames.cs
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TunnelHeaderNames = void 0;
+/**
+ * Header names for http requests that Tunnel Service can handle
+ */
+var TunnelHeaderNames;
+(function (TunnelHeaderNames) {
+    /**
+     * Additional authorization header that can be passed to tunnel web forwarding to
+     * authenticate and authorize the client. The format of the value is the same as
+     * Authorization header that is sent to the Tunnel service by the tunnel SDK.
+     * Supported schemes: "tunnel" with the tunnel access JWT good for 'Connect' scope.
+     */
+    TunnelHeaderNames["XTunnelAuthorization"] = "X-Tunnel-Authorization";
+    /**
+     * Request ID header that nginx ingress controller adds to all requests if it's not
+     * there.
+     */
+    TunnelHeaderNames["XRequestID"] = "X-Request-ID";
+    /**
+     * Github Ssh public key which can be used to validate if it belongs to tunnel's
+     * owner.
+     */
+    TunnelHeaderNames["XGithubSshKey"] = "X-Github-Ssh-Key";
+    /**
+     * Header that will skip the antiphishing page when connection to a tunnel through web
+     * forwarding.
+     */
+    TunnelHeaderNames["XTunnelSkipAntiPhishingPage"] = "X-Tunnel-Skip-AntiPhishing-Page";
+})(TunnelHeaderNames = exports.TunnelHeaderNames || (exports.TunnelHeaderNames = {}));
 //# sourceMappingURL=tunnelHeaderNames.js.map