LPS-X Converts Address utilities to TS

liferay-frontend · jbalsas · Aug 18, 2021 · Aug 19, 2021 · Aug 19, 2021 · Aug 19, 2021
commit 5f872ac9af17f360ea10dd8be5ca269028afae5e
@@ -41,8 +41,8 @@ import {showTooltip} from './portal/tooltip.es';
 import portlet, {minimizePortlet} from './portlet/portlet.es';
 import SideNavigation from './side_navigation.es';
 import addParams from './util/add_params';
-import getCountries from './util/address/get_countries.es';
-import getRegions from './util/address/get_regions.es';
+import getCountries from './util/address/get_countries';
+import getRegions from './util/address/get_regions';
 import fetch from './util/fetch';
 import focusFormField from './util/focus_form_field';
 import getFormElement from './util/form/get_form_element';

diff --git a/...s/apps/frontend-js/frontend-js-web/src/main/resources/META-INF/resources/liferay/types.ts b/...s/apps/frontend-js/frontend-js-web/src/main/resources/META-INF/resources/liferay/types.ts
@@ -81,6 +81,14 @@ export interface ILiferay {
 		[key: string]: any;
 	};
 
+	Service: {
+		(
+			serviceName: string,
+			payload: any,
+			callback: (...args: any[]) => void
+		): void;
+	};
+
 	ThemeDisplay: {
 		readonly getBCP47LanguageId: () => string;
 		readonly getCanonicalURL: () => string;
@@ -132,7 +140,7 @@ export interface ILiferay {
 	readonly currentURLEncoded: string;
 }
 
-// Properties from `frontend-js-web/events`
+// Properties from `frontend-js-web/liferay/events`
 
 export type Callback = (...args: any[]) => void;
 
@@ -161,12 +169,16 @@ export interface ILiferay {
 
 declare global {
 	var Liferay: ILiferay;
+
+	// From frontend-js-web/liferay/events.js
+
 	var submitForm: (
 		form: HTMLFormElement,
 		action?: string,
 		singleSubmit?: boolean,
 		validate?: boolean
 	) => void;
+
 	interface Window {
 		Liferay: ILiferay;
 	}

@@ -12,12 +12,16 @@
  * details.
  */
 
+interface Country {
+	countryId: string;
+	name: string;
+	nameCurrentValue: string;
+}
+
 /**
  * Returns a list of countries
- * @callback callback
- * @return {array} Array of countries
  */
-export default function getCountries(callback) {
+export default function getCountries(callback: (countries: Country[]) => void) {
 	if (typeof callback !== 'function') {
 		throw new TypeError('Parameter callback must be a function');
 	}

@@ -12,13 +12,20 @@
  * details.
  */
 
+interface Region {
+	countryId: string;
+	name: string;
+	regionCode: string;
+	regionId: string;
+}
+
 /**
  * Returns a list of regions by country
- * @callback callback
- * @param {!string} selectKey The selected region ID
- * @return {array} Array of regions by country
  */
-export default function getRegions(callback, selectKey) {
+export default function getRegions(
+	callback: (countries: Region[]) => void,
+	selectKey?: string
+) {
 	if (typeof callback !== 'function') {
 		throw new TypeError('Parameter callback must be a function');
 	}

@@ -12,12 +12,10 @@
  * details.
  */
 
-'use strict';
-
-import getCountries from '../../../../src/main/resources/META-INF/resources/liferay/util/address/get_countries.es';
+import getCountries from '../../../../src/main/resources/META-INF/resources/liferay/util/address/get_countries';
 
 describe('Liferay.Address.getCountries', () => {
 	it('throws an error if the callback parameter is not a function', () => {
-		expect(() => getCountries('')).toThrow('must be a function');
+		expect(() => getCountries('' as any)).toThrow('must be a function');
 	});
 });
@@ -12,16 +12,16 @@
  * details.
  */
 
-'use strict';
-
-import getRegions from '../../../../src/main/resources/META-INF/resources/liferay/util/address/get_regions.es';
+import getRegions from '../../../../src/main/resources/META-INF/resources/liferay/util/address/get_regions';
 
 describe('Liferay.Address.getRegions', () => {
 	it('throws an error if the callback parameter is not a function', () => {
-		expect(() => getRegions('')).toThrow('must be a function');
+		expect(() => getRegions('' as any)).toThrow('must be a function');
 	});
 
 	it('throws an error if the selectKey parameter is not a string', () => {
-		expect(() => getRegions(() => {}, {})).toThrow('must be a string');
+		expect(() => getRegions(() => {}, {} as any)).toThrow(
+			'must be a string'
+		);
 	});
 });
@@ -78,6 +78,9 @@ export interface ILiferay {
         readonly UPLOAD_SERVLET_REQUEST_IMPL_MAX_SIZE: number;
         [key: string]: any;
     };
+    Service: {
+        (serviceName: string, payload: any, callback: (...args: any[]) => void): void;
+    };
     ThemeDisplay: {
         readonly getBCP47LanguageId: () => string;
         readonly getCanonicalURL: () => string;

@@ -0,0 +1,23 @@
+/**
+ * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
+ *
+ * This library is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU Lesser General Public License as published by the Free
+ * Software Foundation; either version 2.1 of the License, or (at your option)
+ * any later version.
+ *
+ * This library is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+ * details.
+ */
+interface Country {
+    countryId: string;
+    name: string;
+    nameCurrentValue: string;
+}
+/**
+ * Returns a list of countries
+ */
+export default function getCountries(callback: (countries: Country[]) => void): void;
+export {};
@@ -0,0 +1,24 @@
+/**
+ * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
+ *
+ * This library is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU Lesser General Public License as published by the Free
+ * Software Foundation; either version 2.1 of the License, or (at your option)
+ * any later version.
+ *
+ * This library is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+ * details.
+ */
+interface Region {
+    countryId: string;
+    name: string;
+    regionCode: string;
+    regionId: string;
+}
+/**
+ * Returns a list of regions by country
+ */
+export default function getRegions(callback: (countries: Region[]) => void, selectKey?: string): void;
+export {};
@@ -0,0 +1,14 @@
+/**
+ * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
+ *
+ * This library is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU Lesser General Public License as published by the Free
+ * Software Foundation; either version 2.1 of the License, or (at your option)
+ * any later version.
+ *
+ * This library is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+ * details.
+ */
+export {};
@@ -0,0 +1,14 @@
+/**
+ * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
+ *
+ * This library is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU Lesser General Public License as published by the Free
+ * Software Foundation; either version 2.1 of the License, or (at your option)
+ * any later version.
+ *
+ * This library is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+ * details.
+ */
+export {};