@kui-shell/core
Version:
An Electron-based shell for cloud-native development
112 lines • 3.03 kB
JavaScript
/*
* Copyright 2018 The Kubernetes Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/* eslint-disable @typescript-eslint/explicit-member-accessibility */
import Debug from 'debug';
const debug = Debug('core/capabilities');
debug('loading');
import { isOffline } from '../api/Client';
/**
* Are we running headless, in electron, or in a browser?
*
*/
export var Media;
(function (Media) {
Media[Media["Unknown"] = 0] = "Unknown";
Media[Media["Headless"] = 1] = "Headless";
Media[Media["Electron"] = 2] = "Electron";
Media[Media["Browser"] = 3] = "Browser";
})(Media || (Media = {}));
/**
* Current state of capabilities
*
*/
class State {
constructor() {
this.assertedLocalAccess = false;
this.hasLocalAccess = true;
// may change as media changes or assertLocalAccess is called
this.hasProxy = false;
this.media = Media.Unknown;
}
}
const state = new State();
/**
* Update the media, e.g. to indicate that we are running in a browser
* context versus an Electron context.
*
*/
export const setMedia = (media) => {
debug('setMedia %s', Media[media]);
state.media = media;
if (!state.assertedLocalAccess && media === Media.Browser) {
state.hasLocalAccess = false;
}
};
/**
* What is our presentation media?
*
*/
export const getMedia = () => state.media;
export const isHeadless = () => state.media === Media.Headless;
export const inElectron = () => state.media === Media.Electron;
export const inBrowser = () => {
if (state.media === Media.Browser) {
return true;
}
if (isOffline() ||
(!isHeadless() && typeof document !== 'undefined' && document.body.classList.contains('not-electron'))) {
setMedia(Media.Browser);
return true;
}
else {
return false;
}
};
/**
* Is Kui supported by a remote proxy?
*
*/
export const hasProxy = () => state.hasProxy;
/**
* Assert that Kui is supported by a remote proxy
*
*/
export const assertHasProxy = () => {
state.hasProxy = true;
};
/**
* Are we the Kui proxy?
*
*/
export const inProxy = () => {
return process.env.KUI_REPL_MODE !== undefined;
};
/**
* Do we have access to a local system?
*
*/
export const hasLocalAccess = () => {
return state.hasLocalAccess;
};
/**
* Assert that we have local access, even if the default behavior
* would indicate otherwise
*
*/
export const assertLocalAccess = () => {
state.hasLocalAccess = true;
};
//# sourceMappingURL=capabilities.js.map