Convert rest-client-behavior.js to .ts
This change shows how to import .js files from a .ts file. Change-Id: I432c92fdb989f1f6e32ef95aa011c846ec2e9019
This commit is contained in:
@@ -183,6 +183,9 @@ module.exports = {
|
||||
// The rule is required for .js files only, because typescript compiler
|
||||
// always checks import.
|
||||
"import/no-unresolved": 2,
|
||||
},
|
||||
"globals": {
|
||||
"goog": "readonly",
|
||||
}
|
||||
},
|
||||
{
|
||||
|
||||
@@ -14,11 +14,37 @@
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
import {BaseUrlBehavior} from '../base-url-behavior/base-url-behavior.js';
|
||||
import {ChangeStatus} from '../../constants/constants.js';
|
||||
import {
|
||||
BaseUrlBehavior,
|
||||
BaseUrlBehaviorInterface,
|
||||
} from '../base-url-behavior/base-url-behavior';
|
||||
import {ChangeStatus} from '../../constants/constants';
|
||||
|
||||
// WARNING: The types below can be completely wrong!
|
||||
// The types was added to avoid eslinter and typescript errors.
|
||||
// Correct typing requires more analysis and (probably) code changes.
|
||||
// This will be done later.
|
||||
type ChangeNum = string; // This can be wrong! See WARNING above
|
||||
type PatchNum = string; // This can be wrong! See WARNING above
|
||||
|
||||
// This can be wrong! See WARNING above
|
||||
interface Change {
|
||||
status: string; // This can be wrong! See WARNING above
|
||||
mergeable: boolean; // This can be wrong! See WARNING above
|
||||
work_in_progress: boolean; // This can be wrong! See WARNING above
|
||||
is_private: boolean; // This can be wrong! See WARNING above
|
||||
submittable: boolean; // This can be wrong! See WARNING above
|
||||
}
|
||||
|
||||
// This can be wrong! See WARNING above
|
||||
interface ChangeStatusesOptions {
|
||||
mergeable: boolean; // This can be wrong! See WARNING above
|
||||
submitEnabled: boolean; // This can be wrong! See WARNING above
|
||||
}
|
||||
|
||||
/** @polymerBehavior Gerrit.RESTClientBehavior */
|
||||
export const RESTClientBehavior = [{
|
||||
export const RESTClientBehavior = [
|
||||
{
|
||||
ChangeDiffType: {
|
||||
ADDED: 'ADDED',
|
||||
COPIED: 'COPIED',
|
||||
@@ -94,7 +120,7 @@ export const RESTClientBehavior = [{
|
||||
SKIP_DIFFSTAT: 23,
|
||||
},
|
||||
|
||||
listChangesOptionsToHex(...args) {
|
||||
listChangesOptionsToHex(...args: number[]) {
|
||||
let v = 0;
|
||||
for (let i = 0; i < args.length; i++) {
|
||||
v |= 1 << args[i];
|
||||
@@ -105,20 +131,29 @@ export const RESTClientBehavior = [{
|
||||
/**
|
||||
* @return {string}
|
||||
*/
|
||||
changeBaseURL(project, changeNum, patchNum) {
|
||||
let v = this.getBaseUrl() + '/changes/' +
|
||||
encodeURIComponent(project) + '~' + changeNum;
|
||||
changeBaseURL(
|
||||
this: BaseUrlBehaviorInterface,
|
||||
project: string,
|
||||
changeNum: ChangeNum,
|
||||
patchNum: PatchNum
|
||||
) {
|
||||
let v =
|
||||
this.getBaseUrl() +
|
||||
'/changes/' +
|
||||
encodeURIComponent(project) +
|
||||
'~' +
|
||||
changeNum;
|
||||
if (patchNum) {
|
||||
v += '/revisions/' + patchNum;
|
||||
}
|
||||
return v;
|
||||
},
|
||||
|
||||
changePath(changeNum) {
|
||||
changePath(this: BaseUrlBehaviorInterface, changeNum: ChangeNum) {
|
||||
return this.getBaseUrl() + '/c/' + changeNum;
|
||||
},
|
||||
|
||||
changeIsOpen(change) {
|
||||
changeIsOpen(change?: Change) {
|
||||
return change && change.status === ChangeStatus.NEW;
|
||||
},
|
||||
|
||||
@@ -128,23 +163,31 @@ export const RESTClientBehavior = [{
|
||||
*
|
||||
* @return {!Array}
|
||||
*/
|
||||
changeStatuses(change, opt_options) {
|
||||
changeStatuses(change: Change, opt_options?: ChangeStatusesOptions) {
|
||||
const states = [];
|
||||
if (change.status === ChangeStatus.MERGED) {
|
||||
states.push('Merged');
|
||||
} else if (change.status === ChangeStatus.ABANDONED) {
|
||||
states.push('Abandoned');
|
||||
} else if (change.mergeable === false ||
|
||||
(opt_options && opt_options.mergeable === false)) {
|
||||
} else if (
|
||||
change.mergeable === false ||
|
||||
(opt_options && opt_options.mergeable === false)
|
||||
) {
|
||||
// 'mergeable' prop may not always exist (@see Issue 6819)
|
||||
states.push('Merge Conflict');
|
||||
}
|
||||
if (change.work_in_progress) { states.push('WIP'); }
|
||||
if (change.is_private) { states.push('Private'); }
|
||||
if (change.work_in_progress) {
|
||||
states.push('WIP');
|
||||
}
|
||||
if (change.is_private) {
|
||||
states.push('Private');
|
||||
}
|
||||
|
||||
// If there are any pre-defined statuses, only return those. Otherwise,
|
||||
// will determine the derived status.
|
||||
if (states.length || !opt_options) { return states; }
|
||||
if (states.length || !opt_options) {
|
||||
return states;
|
||||
}
|
||||
|
||||
// If no missing requirements, either active or ready to submit.
|
||||
if (change.submittable && opt_options.submitEnabled) {
|
||||
@@ -160,14 +203,15 @@ export const RESTClientBehavior = [{
|
||||
* @param {!Object} change
|
||||
* @return {string}
|
||||
*/
|
||||
changeStatusString(change) {
|
||||
changeStatusString(change: Change) {
|
||||
return this.changeStatuses(change).join(', ');
|
||||
},
|
||||
},
|
||||
BaseUrlBehavior,
|
||||
},
|
||||
BaseUrlBehavior,
|
||||
];
|
||||
|
||||
// eslint-disable-next-line no-unused-vars
|
||||
// eslint-disable-next-line @typescript-eslint/ban-ts-ignore
|
||||
// @ts-ignore
|
||||
function defineEmptyMixin() {
|
||||
// This is a temporary function.
|
||||
// Polymer linter doesn't process correctly the following code:
|
||||
@@ -179,12 +223,27 @@ function defineEmptyMixin() {
|
||||
* @polymer
|
||||
* @mixinFunction
|
||||
*/
|
||||
const RESTClientMixin = base => // eslint-disable-line no-unused-vars
|
||||
const RESTClientMixin = (
|
||||
// eslint-disable-next-line @typescript-eslint/ban-ts-ignore
|
||||
// @ts-ignore
|
||||
base
|
||||
) =>
|
||||
class extends base {
|
||||
// eslint-disable-next-line @typescript-eslint/ban-ts-ignore
|
||||
// @ts-ignore
|
||||
changeStatusString(change) {}
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/ban-ts-ignore
|
||||
// @ts-ignore
|
||||
changeStatuses(change, opt_options) {}
|
||||
};
|
||||
// We can't apply @ts-ignore directly to RESTClientMixin - it breaks polylint
|
||||
// tests (polylinter expects that @polymer and @mixinFunction appear right
|
||||
// before the mixin definition). To workaround it and suppress error about
|
||||
// unused variable use a temporary variable.
|
||||
// eslint-disable-next-line @typescript-eslint/ban-ts-ignore
|
||||
// @ts-ignore
|
||||
const tmp = RESTClientMixin;
|
||||
}
|
||||
|
||||
// TODO(dmfilippov) Remove the following lines with assignments
|
||||
|
||||
23
polygerrit-ui/app/constants/constants.d.ts
vendored
Normal file
23
polygerrit-ui/app/constants/constants.d.ts
vendored
Normal file
@@ -0,0 +1,23 @@
|
||||
/**
|
||||
* @license
|
||||
* Copyright (C) 2020 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.
|
||||
*/
|
||||
|
||||
export type ChangeStatus = any;
|
||||
export namespace ChangeStatus {
|
||||
export const ABANDONED: string;
|
||||
export const MERGED: string;
|
||||
export const NEW: string;
|
||||
}
|
||||
@@ -15,6 +15,8 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
goog.declareModuleId('polygerrit.constants.constants');
|
||||
|
||||
/**
|
||||
* @enum
|
||||
* @desc Tab names for primary tabs on change view page.
|
||||
|
||||
@@ -15,6 +15,10 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
// We need to use goog.declareModuleId internally in google for TS-imports-JS
|
||||
// case. To avoid errors when goog is not available, the empty implementation is
|
||||
// added.
|
||||
window.goog = window.goog || {declareModuleId(name) {}};
|
||||
import './gr-app-init.js';
|
||||
import './font-roboto-local-loader.js';
|
||||
// Sets up global Polymer variable, because plugins requires it.
|
||||
|
||||
@@ -16,6 +16,10 @@
|
||||
*/
|
||||
|
||||
window.Gerrit = window.Gerrit || {};
|
||||
// We need to use goog.declareModuleId internally in google for TS-imports-JS
|
||||
// case. To avoid errors when goog is not available, the empty implementation is
|
||||
// added.
|
||||
window.goog = window.goog || {declareModuleId(name) {}};
|
||||
// TODO(dmfilippov): remove bundled-polymer.js imports when the following issue
|
||||
// https://github.com/Polymer/polymer-resin/issues/9 is resolved.
|
||||
// Because gr-diff.js is a shared component, it shouldn' pollute global
|
||||
|
||||
Reference in New Issue
Block a user