10465976639

Committed 20 Aug 2024 05:43AM UTC coverage: 21.441% (-0.1%) from 21.543%

Build # 10465976639

Build Type

Pull #2607

github

Committed by

web-flow

Commit Message

Merge b3275b7bd into bc90b0e2a

Pull Request Pull Request #2607: [Chore] Upgrade to eslint 8.53.0 and prettier 2.8.8, fix lint and type errors

Run Details

710 of 7676 branches covered (9.25%)

Branch coverage included in aggregate %.

113 of 504 new or added lines in 144 files covered. (22.42%)

23 existing lines in 15 files now uncovered.

3728 of 13023 relevant lines covered (28.63%)

17.96 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

17.14

/src/cloud-providers/src/provider.ts

// SPDX-License-Identifier: MIT
// Copyright contributors to the kepler.gl project

import Upload from './upload';
import {MapData, ExportFileOptions, Millisecond, SavedMap} from '@kepler.gl/types';
import {ComponentType} from 'react';

export type MapItemLoadParams = {
  id: string;
  path: string;
};

export type MapListItem = {
  id: string;
  title: string;
  description: string;
  loadParams: any;
  imageUrl?: string;
  updatedAt?: Millisecond;
  privateMap?: boolean;
};

export type CloudUser = {
  name: string;
  email: string;
  thumbnail?: string;
};

export type Thumbnail = {
  width: number;
  height: number;
};

export type ProviderProps = {
  name?: string;
  displayName?: string;
  icon?: ComponentType<IconProps>;
  thumbnail?: Thumbnail;
};

export interface IconProps {
  height?: string;
  width?: string;
}

const NAME = 'cloud-provider';
const DISPLAY_NAME = 'Cloud Provider';
const THUMBNAIL = {width: 300, height: 200};
const ICON = Upload;
export const KEPLER_FORMAT = 'keplergl';
export const FILE_CONFLICT_MSG = 'file_conflict';

/**
 * The default provider class
 * @param {object} props
 * @param {string} props.name
 * @param {string} props.displayName
 * @param {React.Component} props.icon - React element
 * @param {object} props.thumbnail - thumbnail size object
 * @param {number} props.thumbnail.width - thumbnail width in pixels
 * @param {number} props.thumbnail.height - thumbnail height in pixels
 * @public
 * @example
 *
 * const myProvider = new Provider({
 *  name: 'foo',
 *  displayName: 'Foo Storage'
 *  icon: Icon,
 *  thumbnail: {width: 300, height: 200}
 * })
 */
export default class Provider {
  name: string;
  displayName: string;
  icon: ComponentType<IconProps>;
  thumbnail: Thumbnail;
  isNew = false;

  constructor(props: ProviderProps) {
    this.name = props.name || NAME;
    this.displayName = props.displayName || DISPLAY_NAME;
    this.icon = props.icon || ICON;
    this.thumbnail = props.thumbnail || THUMBNAIL;
  }

  /**
   * Whether this provider support upload map to a private storage. If truthy, user will be displayed with the storage save icon on the top right of the side bar.
   * @returns
   * @public
   */
  hasPrivateStorage(): boolean {
    return true;
  }

  /**
   * Whether this provider support share map via a public url, if truthy, user will be displayed with a share map via url under the export map option on the top right of the side bar
   * @returns
   * @public
   */
  hasSharingUrl(): boolean {
    return false;
  }

  /**
   * This method is called after user share a map, to display the share url.
   * @param fullUrl - Whether to return the full url with domain, or just the location
   * @returns shareUrl
   * @public
   */
  // eslint-disable-next-line @typescript-eslint/no-unused-vars
  getShareUrl(fullUrl = false): string {
    return '';
  }

  /**
   * This method is called by kepler.gl demo app to pushes a new location to history, becoming the current location.
   * @returns mapUrl
   * @public
   */
  // eslint-disable-next-line @typescript-eslint/no-unused-vars
  getMapUrl(loadParams: MapItemLoadParams): string {
    return '';
  }

  /**
   * This method is called to determine whether user already logged in to this provider
   * @public
   * @returns {Promise<string>} return the access token if a user already logged in
   */
  async getAccessToken(): Promise<string | null> {
    return Promise.reject('You must implement getAccessToken');
  }

  /**
   * This method is called to get the user name of the current user. It will be displayed in the cloud provider tile.
   * @public
   * @deprecated please use getUser
   * @returns true if a user already logged in
   */
  getUserName(): string {
    return '';
  }

  /**
   * return a Promise with the user object
   */
  async getUser(): Promise<CloudUser | null> {
    return Promise.reject('You must implement getUser');
  }

  /**
   * This return a standard error that will trigger the overwrite map modal
   */
  getFileConflictError() {
    return new Error(FILE_CONFLICT_MSG);
  }

  /**
   * This method will be called when user click the login button in the cloud provider tile.
   * Upon login success and return the user Object {name, email, abbreviated}
   * @public
   */
  async login() {
    return Promise.reject(new Error('you must implement the `login` method'));
  }

  /**
   * This method will be called when user click the logout button under the cloud provider tile.
   * Upon login success
   * @public
   */
  async logout(): Promise<void> {
    return Promise.reject(new Error('you must implement the `logout` method'));
  }

  /**
   * This method will be called to upload map for saving and sharing. Kepler.gl will package map data, config, title, description and thumbnail for upload to storage.
   * With the option to overwrite already saved map, and upload as private or public map.
   *
   * @param {Object} param
   * @param {Object} param.mapData - the map object
   * @param {Object} param.mapData.map - {datasets. config, info: {title, description}}
   * @param {Blob} param.mapData.thumbnail - A thumbnail of current map. thumbnail size can be defined by provider by this.thumbnail
   * @param {object} [param.options]
   * @param {boolean} [param.options.overwrite] - whether user choose to overwrite already saved map under the same name
   * @param {boolean} [param.options.isPublic] - whether user wish to share the map with others. if isPublic is truthy, kepler will call this.getShareUrl() to display an URL they can share with others
   * @public
   */
  async uploadMap({
    // eslint-disable-next-line @typescript-eslint/no-unused-vars
    mapData,
    // eslint-disable-next-line @typescript-eslint/no-unused-vars
    options = {}
  }: {
    mapData: MapData;
    options: ExportFileOptions;
  }): Promise<MapListItem> {
    return Promise.reject('You must implement uploadMap');
  }

  /**
   * This method is called to get a list of maps saved by the current logged in user.
   * @returns visualizations an array of Viz objects
   * @public
   * @example
   *  async listMaps() {
   *    return [
   *      {
   *        id: 'a',
   *        title: 'My map',
   *        description: 'My first kepler map',
   *        imageUrl: 'http://',
   *        updatedAt: 1582677787000,
   *        privateMap: false,
   *        loadParams: {}
   *      }
   *    ];
   *  }
   */
  async listMaps(): Promise<MapListItem[]> {
    return [];
  }

  /**
   * This method will be called when user select a map to load from the storage map viewer
   * @param {*} loadParams - the loadParams property of each visualization object
   * @returns mapResponse - the map object containing dataset config info and format option
   * @public
   * @example
   * async downloadMap(loadParams) {
   *  const mockResponse = {
   *    map: {
   *      datasets: [],
   *      config: {},
   *      info: {
   *        app: 'kepler.gl',
   *        created_at: ''
   *        title: 'test map',
   *        description: 'Hello this is my test dropbox map'
   *      }
   *    },
   *    // pass csv here if your provider currently only support save / load file as csv
   *    format: 'keplergl'
   *  };
   *
   *  return downloadMap;
   * }
   */
  // eslint-disable-next-line @typescript-eslint/no-unused-vars
  async downloadMap(loadParams): Promise<{map: SavedMap; format: string}> {
    return Promise.reject('You must implement downloadMap');
  }

  /**
   * @return {string} return the storage location url for the current provider
   * @public
   */
  getManagementUrl(): string {
    throw new Error('You must implement getManagementUrl');
  }

  /**
   * @typedef {Object} Viz
   * @property {string} id - An unique id
   * @property {string} title - The title of the map
   * @property {string} description - The description of the map
   * @property {string} imageUrl - The imageUrl of the map
   * @property {number} updatedAt - An epoch timestamp in milliseconds
   * @property {boolean} privateMap - Optional, whether if this map is private to the user, or can be accessed by others via URL
   * @property {*} loadParams - A property to be passed to `downloadMap`
   * @public
   */

  /**
   * The returned object of `downloadMap`. The response object should contain: datasets: [], config: {}, and info: {}
   * each dataset object should be {info: {id, label}, data: {...}}
   * to inform how kepler should process your data object, pass in `format`
   * @typedef {Object} MapResponse
   * @property {Object} map
   * @property {Array<Object>} map.datasets
   * @property {Object} map.config
   * @property {Object} map.info
   * @property {string} format - one of 'csv': csv file string, 'geojson': geojson object, 'row': row object, 'keplergl': datasets array saved using KeplerGlSchema.save
   * @public
   */
}

1	// SPDX-License-Identifier: MIT
2	// Copyright contributors to the kepler.gl project
3
4	import Upload from './upload';
5	import {MapData, ExportFileOptions, Millisecond, SavedMap} from '@kepler.gl/types';
6	import {ComponentType} from 'react';
7
8	export type MapItemLoadParams = {
9	id: string;
10	path: string;
11	};
12
13	export type MapListItem = {
14	id: string;
15	title: string;
16	description: string;
17	loadParams: any;
18	imageUrl?: string;
19	updatedAt?: Millisecond;
20	privateMap?: boolean;
21	};
22
23	export type CloudUser = {
24	name: string;
25	email: string;
26	thumbnail?: string;
27	};
28
29	export type Thumbnail = {
30	width: number;
31	height: number;
32	};
33
34	export type ProviderProps = {
35	name?: string;
36	displayName?: string;
37	icon?: ComponentType<IconProps>;
38	thumbnail?: Thumbnail;
39	};
40
41	export interface IconProps {
42	height?: string;
43	width?: string;
44	}
45
46	const NAME = 'cloud-provider';	9✔
47	const DISPLAY_NAME = 'Cloud Provider';	9✔
48	const THUMBNAIL = {width: 300, height: 200};	9✔
49	const ICON = Upload;	9✔
50	export const KEPLER_FORMAT = 'keplergl';	9✔
51	export const FILE_CONFLICT_MSG = 'file_conflict';	9✔
52
53	/**
54	* The default provider class
55	* @param {object} props
56	* @param {string} props.name
57	* @param {string} props.displayName
58	* @param {React.Component} props.icon - React element
59	* @param {object} props.thumbnail - thumbnail size object
60	* @param {number} props.thumbnail.width - thumbnail width in pixels
61	* @param {number} props.thumbnail.height - thumbnail height in pixels
62	* @public
63	* @example
64	*
65	* const myProvider = new Provider({
66	* name: 'foo',
67	* displayName: 'Foo Storage'
68	* icon: Icon,
69	* thumbnail: {width: 300, height: 200}
70	* })
71	*/
72	export default class Provider {
73	name: string;
74	displayName: string;
75	icon: ComponentType<IconProps>;
76	thumbnail: Thumbnail;
NEW 77	isNew = false;	×
78
79	constructor(props: ProviderProps) {
80	this.name = props.name \|\| NAME;	×
81	this.displayName = props.displayName \|\| DISPLAY_NAME;	×
82	this.icon = props.icon \|\| ICON;	×
83	this.thumbnail = props.thumbnail \|\| THUMBNAIL;	×
84	}
85
86	/**
87	* Whether this provider support upload map to a private storage. If truthy, user will be displayed with the storage save icon on the top right of the side bar.
88	* @returns
89	* @public
90	*/
91	hasPrivateStorage(): boolean {
92	return true;	×
93	}
94
95	/**
96	* Whether this provider support share map via a public url, if truthy, user will be displayed with a share map via url under the export map option on the top right of the side bar
97	* @returns
98	* @public
99	*/
100	hasSharingUrl(): boolean {
101	return false;	×
102	}
103
104	/**
105	* This method is called after user share a map, to display the share url.
106	* @param fullUrl - Whether to return the full url with domain, or just the location
107	* @returns shareUrl
108	* @public
109	*/
110	// eslint-disable-next-line @typescript-eslint/no-unused-vars
111	getShareUrl(fullUrl = false): string {	×
UNCOV 112	return '';	×
113	}
114
115	/**
116	* This method is called by kepler.gl demo app to pushes a new location to history, becoming the current location.
117	* @returns mapUrl
118	* @public
119	*/
120	// eslint-disable-next-line @typescript-eslint/no-unused-vars
121	getMapUrl(loadParams: MapItemLoadParams): string {
122	return '';	×
123	}
124
125	/**
126	* This method is called to determine whether user already logged in to this provider
127	* @public
128	* @returns {Promise<string>} return the access token if a user already logged in
129	*/
130	async getAccessToken(): Promise<string \| null> {
131	return Promise.reject('You must implement getAccessToken');	×
132	}
133
134	/**
135	* This method is called to get the user name of the current user. It will be displayed in the cloud provider tile.
136	* @public
137	* @deprecated please use getUser
138	* @returns true if a user already logged in
139	*/
140	getUserName(): string {
141	return '';	×
142	}
143
144	/**
145	* return a Promise with the user object
146	*/
147	async getUser(): Promise<CloudUser \| null> {
148	return Promise.reject('You must implement getUser');	×
149	}
150
151	/**
152	* This return a standard error that will trigger the overwrite map modal
153	*/
154	getFileConflictError() {
155	return new Error(FILE_CONFLICT_MSG);	×
156	}
157
158	/**
159	* This method will be called when user click the login button in the cloud provider tile.
160	* Upon login success and return the user Object {name, email, abbreviated}
161	* @public
162	*/
163	async login() {
164	return Promise.reject(new Error('you must implement the `login` method'));	×
165	}
166
167	/**
168	* This method will be called when user click the logout button under the cloud provider tile.
169	* Upon login success
170	* @public
171	*/
172	async logout(): Promise<void> {
173	return Promise.reject(new Error('you must implement the `logout` method'));	×
174	}
175
176	/**
177	* This method will be called to upload map for saving and sharing. Kepler.gl will package map data, config, title, description and thumbnail for upload to storage.
178	* With the option to overwrite already saved map, and upload as private or public map.
179	*
180	* @param {Object} param
181	* @param {Object} param.mapData - the map object
182	* @param {Object} param.mapData.map - {datasets. config, info: {title, description}}
183	* @param {Blob} param.mapData.thumbnail - A thumbnail of current map. thumbnail size can be defined by provider by this.thumbnail
184	* @param {object} [param.options]
185	* @param {boolean} [param.options.overwrite] - whether user choose to overwrite already saved map under the same name
186	* @param {boolean} [param.options.isPublic] - whether user wish to share the map with others. if isPublic is truthy, kepler will call this.getShareUrl() to display an URL they can share with others
187	* @public
188	*/
189	async uploadMap({
190	// eslint-disable-next-line @typescript-eslint/no-unused-vars
191	mapData,
192	// eslint-disable-next-line @typescript-eslint/no-unused-vars
193	options = {}	×
194	}: {
195	mapData: MapData;
196	options: ExportFileOptions;
197	}): Promise<MapListItem> {
198	return Promise.reject('You must implement uploadMap');	×
199	}
200
201	/**
202	* This method is called to get a list of maps saved by the current logged in user.
203	* @returns visualizations an array of Viz objects
204	* @public
205	* @example
206	* async listMaps() {
207	* return [
208	* {
209	* id: 'a',
210	* title: 'My map',
211	* description: 'My first kepler map',
212	* imageUrl: 'http://',
213	* updatedAt: 1582677787000,
214	* privateMap: false,
215	* loadParams: {}
216	* }
217	* ];
218	* }
219	*/
220	async listMaps(): Promise<MapListItem[]> {
221	return [];	×
222	}
223
224	/**
225	* This method will be called when user select a map to load from the storage map viewer
226	* @param {*} loadParams - the loadParams property of each visualization object
227	* @returns mapResponse - the map object containing dataset config info and format option
228	* @public
229	* @example
230	* async downloadMap(loadParams) {
231	* const mockResponse = {
232	* map: {
233	* datasets: [],
234	* config: {},
235	* info: {
236	* app: 'kepler.gl',
237	* created_at: ''
238	* title: 'test map',
239	* description: 'Hello this is my test dropbox map'
240	* }
241	* },
242	* // pass csv here if your provider currently only support save / load file as csv
243	* format: 'keplergl'
244	* };
245	*
246	* return downloadMap;
247	* }
248	*/
249	// eslint-disable-next-line @typescript-eslint/no-unused-vars
250	async downloadMap(loadParams): Promise<{map: SavedMap; format: string}> {
251	return Promise.reject('You must implement downloadMap');	×
252	}
253
254	/**
255	* @return {string} return the storage location url for the current provider
256	* @public
257	*/
258	getManagementUrl(): string {
259	throw new Error('You must implement getManagementUrl');	×
260	}
261
262	/**
263	* @typedef {Object} Viz
264	* @property {string} id - An unique id
265	* @property {string} title - The title of the map
266	* @property {string} description - The description of the map
267	* @property {string} imageUrl - The imageUrl of the map
268	* @property {number} updatedAt - An epoch timestamp in milliseconds
269	* @property {boolean} privateMap - Optional, whether if this map is private to the user, or can be accessed by others via URL
270	* @property {*} loadParams - A property to be passed to `downloadMap`
271	* @public
272	*/
273
274	/**
275	* The returned object of `downloadMap`. The response object should contain: datasets: [], config: {}, and info: {}
276	* each dataset object should be {info: {id, label}, data: {...}}
277	* to inform how kepler should process your data object, pass in `format`
278	* @typedef {Object} MapResponse
279	* @property {Object} map
280	* @property {Array<Object>} map.datasets
281	* @property {Object} map.config
282	* @property {Object} map.info
283	* @property {string} format - one of 'csv': csv file string, 'geojson': geojson object, 'row': row object, 'keplergl': datasets array saved using KeplerGlSchema.save
284	* @public
285	*/
286	}

keplergl / kepler.gl / 10465976639

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous