a6eb943825
This provides a simple interface for gr-change-actions for use by the JS API. It allows the author to not have to worry about implementation details of the element itself, while still providing a reduced-surface API contract that can be tested as the underlying element evolves. Feature: Issue 3915 Change-Id: I2f82060ea14adef93a7018b79bf7cf10b84e5735
97 lines
3.1 KiB
JavaScript
97 lines
3.1 KiB
JavaScript
// Copyright (C) 2016 The Android Open Source Project
|
||
//
|
||
// 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.
|
||
(function(window) {
|
||
'use strict';
|
||
|
||
var API_VERSION = '0.1';
|
||
|
||
// GWT JSNI uses $wnd to refer to window.
|
||
// http://www.gwtproject.org/doc/latest/DevGuideCodingBasicsJSNI.html
|
||
window.$wnd = window;
|
||
|
||
function Plugin(opt_url) {
|
||
if (!opt_url) {
|
||
console.warn('Plugin not being loaded from /plugins base path.',
|
||
'Unable to determine name.');
|
||
return;
|
||
}
|
||
|
||
this._url = new URL(opt_url);
|
||
if (this._url.pathname.indexOf('/plugins') !== 0) {
|
||
console.warn('Plugin not being loaded from /plugins base path:',
|
||
this._url.href, '— Unable to determine name.');
|
||
return;
|
||
}
|
||
this._name = this._url.pathname.split('/')[2];
|
||
}
|
||
|
||
Plugin._sharedAPIElement = document.createElement('gr-js-api-interface');
|
||
|
||
Plugin.prototype._name = '';
|
||
|
||
Plugin.prototype.getPluginName = function() {
|
||
return this._name;
|
||
};
|
||
|
||
Plugin.prototype.on = function(eventName, callback) {
|
||
Plugin._sharedAPIElement.addEventCallback(eventName, callback);
|
||
};
|
||
|
||
Plugin.prototype.url = function(opt_path) {
|
||
return this._url.origin + '/plugins/' + this._name + (opt_path || '/');
|
||
};
|
||
|
||
Plugin.prototype.changeActions = function() {
|
||
return new GrChangeActionsInterface(Plugin._sharedAPIElement.getElement(
|
||
Plugin._sharedAPIElement.Element.CHANGE_ACTIONS));
|
||
};
|
||
|
||
var Gerrit = window.Gerrit || {};
|
||
|
||
Gerrit.getPluginName = function() {
|
||
console.warn('Gerrit.getPluginName is not supported in PolyGerrit.',
|
||
'Please use self.getPluginName() instead.');
|
||
};
|
||
|
||
Gerrit.css = function(rulesStr) {
|
||
if (!Gerrit._customStyleSheet) {
|
||
var styleEl = document.createElement('style');
|
||
document.head.appendChild(styleEl);
|
||
Gerrit._customStyleSheet = styleEl.sheet;
|
||
}
|
||
|
||
var name = '__pg_js_api_class_' + Gerrit._customStyleSheet.cssRules.length;
|
||
Gerrit._customStyleSheet.insertRule('.' + name + '{' + rulesStr + '}', 0);
|
||
return name;
|
||
};
|
||
|
||
Gerrit.install = function(callback, opt_version, opt_src) {
|
||
if (opt_version && opt_version !== API_VERSION) {
|
||
console.warn('Only version ' + API_VERSION +
|
||
' is supported in PolyGerrit. ' + opt_version + ' was given.');
|
||
return;
|
||
}
|
||
|
||
// TODO(andybons): Polyfill currentScript for IE10/11 (edge supports it).
|
||
var src = opt_src || (document.currentScript && document.currentScript.src);
|
||
callback(new Plugin(src));
|
||
};
|
||
|
||
Gerrit.installGwt = function() {
|
||
// NOOP since PolyGerrit doesn’t support GWT plugins.
|
||
};
|
||
|
||
window.Gerrit = Gerrit;
|
||
})(window);
|