Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Chore]: Technical: Isolate schemas #1962

Merged
merged 2 commits into from
Sep 2, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
"./src/middleware",
"./src/deckgl-layers",
"./src/layers",
"./src/schemas",
"./src/table",
"./src/cloud-providers",
"./src/processors",
Expand Down Expand Up @@ -63,7 +64,7 @@
"start:web": "yarn install-and-start -- website start",
"start:https": "yarn install-and-start -- examples/demo-app start-local-https",
"start:e2e": "yarn install-and-start -- examples/demo-app start-local-e2e",
"build": "rm -fr dist && babel src/{actions,components,middleware,reducers,cloud-providers,connect,localization,schemas,tasks} --out-dir dist --source-maps inline --extensions '.ts,.tsx,.js,.jsx' --ignore '**/*.d.ts'",
"build": "rm -fr dist && babel src/{actions,components,middleware,reducers,cloud-providers,connect,localization,tasks} --out-dir dist --source-maps inline --extensions '.ts,.tsx,.js,.jsx' --ignore '**/*.d.ts'",
"build:umd": "webpack --config ./webpack/umd.js --progress --env.prod",
"build:types": "tsc --project tsconfig.production.json",
"analyze": "yarn analyze:bundle",
Expand Down
2 changes: 1 addition & 1 deletion src/components/geocoder-panel.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import React, {Component, ComponentType} from 'react';
import styled from 'styled-components';
import {processRowObject} from '@kepler.gl/processors';
import {FlyToInterpolator} from '@deck.gl/core';
import KeplerGlSchema from 'schemas';
import KeplerGlSchema from '@kepler.gl/schemas';
import {getCenterAndZoomFromBounds} from '@kepler.gl/utils';

import Geocoder, {Result} from './geocoder/geocoder';
Expand Down
3 changes: 1 addition & 2 deletions src/processors/src/data-processor.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,8 @@ import {
getFieldsFromData,
toArray
} from '@kepler.gl/utils';
import {KeplerGlSchema, ParsedDataset, SavedMap} from 'schemas';
import {KeplerGlSchema, ParsedDataset, SavedMap, LoadedMap} from '@kepler.gl/schemas';
import {Feature} from '@nebula.gl/edit-modes';
import {LoadedMap} from 'schemas/schema-manager';

// if any of these value occurs in csv, parse it to null;
// const CSV_NULLS = ['', 'null', 'NULL', 'Null', 'NaN', '/N'];
Expand Down
8 changes: 7 additions & 1 deletion src/reducers/src/vis-state-merger.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,13 @@ import {isObject, arrayInsert, getInitialMapLayersForSplitMap} from '@kepler.gl/

import {LayerColumns, LayerColumn, Layer} from '@kepler.gl/layers';
import {LAYER_BLENDINGS} from '@kepler.gl/constants';
import {CURRENT_VERSION, Merger, VisState, VisStateMergers, visStateSchema} from 'schemas';
import {
CURRENT_VERSION,
Merger,
VisState,
VisStateMergers,
visStateSchema
} from '@kepler.gl/schemas';

import {ParsedConfig} from 'schemas';
import {ParsedLayer, SavedInteractionConfig, TooltipInfo} from '@kepler.gl/types';
Expand Down
2 changes: 1 addition & 1 deletion src/reducers/src/vis-state-updaters.ts
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ import {
} from '@kepler.gl/constants';
import {pick_, merge_, swap_} from './composer-helpers';

import KeplerGLSchema, {VisState} from 'schemas';
import KeplerGLSchema, {VisState} from '@kepler.gl/schemas';

import {Filter, InteractionConfig, AnimationConfig, Editor} from '@kepler.gl/types';
import {Loader} from '@loaders.gl/loader-utils';
Expand Down
66 changes: 66 additions & 0 deletions src/schemas/babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
// Copyright (c) 2022 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

const KeplerPackage = require('./package');

const PRESETS = ['@babel/preset-env', '@babel/preset-react', '@babel/preset-typescript'];
const PLUGINS = [
['@babel/plugin-transform-typescript', {isTSX: true, allowDeclareFields: true}],
'@babel/plugin-transform-modules-commonjs',
'@babel/plugin-proposal-class-properties',
'@babel/plugin-proposal-export-namespace-from',
'@babel/plugin-proposal-optional-chaining',
[
'@babel/transform-runtime',
{
regenerator: true
}
],
[
'search-and-replace',
{
rules: [
{
search: '__PACKAGE_VERSION__',
replace: KeplerPackage.version
}
]
}
]
];
const ENV = {
test: {
plugins: ['istanbul']
},
debug: {
sourceMaps: 'inline',
retainLines: true
}
};

module.exports = function babel(api) {
api.cache(true);

return {
presets: PRESETS,
plugins: PLUGINS,
env: ENV
};
};
65 changes: 65 additions & 0 deletions src/schemas/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
{
"name": "@kepler.gl/schemas",
"author": "Shan He <shan@uber.com>",
"version": "2.5.5",
"description": "kepler.gl schemas used by kepler.gl components, actions and reducers",
"license": "MIT",
"main": "dist/index.js",
"types": "index.d.ts",
"keywords": [
"babel",
"es6",
"react",
"webgl",
"visualization",
"deck.gl"
],
"repository": {
"type": "git",
"url": "https://github.com/keplergl/kepler.gl.git"
},
"scripts": {
"build": "rm -fr dist && babel src --out-dir dist --source-maps inline --extensions '.ts,.tsx,.js,.jsx' --ignore '**/*.d.ts'",
"build:umd": "webpack --config ./webpack/umd.js --progress --env.prod",
"build:types": "tsc --project ./tsconfig.production.json",
"prepublish": "uber-licence && yarn build && yarn build:types",
"stab": "mkdir -p dist && touch dist/index.js"
},
"files": [
"dist",
"umd"
],
"dependencies": {
"@babel/runtime": "^7.12.1",
"colorbrewer": "^1.5.0",
"d3-scale": "^3.2.3",
"global": "^4.3.0",
"keymirror": "^0.1.1",
"react-map-gl-draw": "0.14.8",
"@kepler.gl/types": "2.5.5"
},
"exports": {
".": "./dist/index.js",
"./*": "./dist/*"
},
"typesVersions": {
"*": {
"*": ["dist/*"]
}
},
"nyc": {
"sourceMap": false,
"instrument": false
},
"engines": {
"node": ">=12.0.0"
},
"maintainers": [
"Shan He <heshan0131@gmail.com>",
"Giuseppe Macri <gmacri@uber.com>"
],
"volta": {
"node": "12.22.0",
"yarn": "1.22.17"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,8 @@
import pick from 'lodash.pick';
import {console as globalConsole} from 'global/window';

import {ProtoDataset} from '@kepler.gl/types';
import {ProtoDataset, RGBColor} from '@kepler.gl/types';
import {KeplerTable} from '@kepler.gl/table';
import {RGBColor} from 'types';
import {VERSIONS} from './versions';
import Schema from './schema';
import {getFieldsFromData, getSampleForTypeAnalyze} from '@kepler.gl/utils';
Expand Down
3 changes: 2 additions & 1 deletion src/schemas/index.ts → src/schemas/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@ export {
export type {
ParsedConfig,
SavedConfigV1,
SavedMap
SavedMap,
LoadedMap
} from './schema-manager';
export {CURRENT_VERSION, VERSIONS} from './versions';
export {
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
35 changes: 35 additions & 0 deletions src/schemas/tsconfig.production.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
{
"compilerOptions": {
"target": "es2020",
"allowJs": false,
"checkJs": false,
"jsx": "react",
"module": "esnext",
"moduleResolution": "node",
"declaration":true,
"emitDeclarationOnly":true,
"noImplicitAny": false,
"noImplicitReturns": true,
"noImplicitThis": true,
"noUnusedLocals": true,
"outDir": "dist",
"sourceMap": true,
"strictNullChecks": true,
"suppressImplicitAnyIndexErrors": false,
"esModuleInterop": true,
"allowSyntheticDefaultImports": true,
"skipLibCheck": true,
"strict": true,
"resolveJsonModule": true,
"isolatedModules": true,
"baseUrl": "./src",
"paths": {
"*": ["*"]
}
},
"include": [
"src"
],
"exclude": [
]
}
120 changes: 120 additions & 0 deletions src/schemas/webpack/umd.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
// Copyright (c) 2022 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

const resolve = require('path').resolve;
const join = require('path').join;

// Import package.json to read version
const KeplerPackage = require('../package');

const SRC_DIR = resolve(__dirname, '../src');
const OUTPUT_DIR = resolve(__dirname, '../umd');

const LIBRARY_BUNDLE_CONFIG = env => ({
entry: {
KeplerGl: join(SRC_DIR, 'index.ts')
},

// Silence warnings about big bundles
stats: {
warnings: false
},

output: {
// Generate the bundle in dist folder
path: OUTPUT_DIR,
filename: 'keplergl.min.js',
globalObject: 'this',
library: '[name]',
libraryTarget: 'umd'
},

// let's put everything in
externals: {
react: {
root: 'React',
commonjs2: 'react',
commonjs: 'react',
amd: 'react',
umd: 'react'
},
'react-dom': {
root: 'ReactDOM',
commonjs2: 'react-dom',
commonjs: 'react-dom',
amd: 'react-dom',
umd: 'react-dom'
},
redux: {
root: 'Redux',
commonjs2: 'redux',
commonjs: 'redux',
amd: 'redux',
umd: 'redux'
},
'react-redux': {
root: 'ReactRedux',
commonjs2: 'react-redux',
commonjs: 'react-redux',
amd: 'react-redux',
umd: 'react-redux'
},
'styled-components': {
commonjs: 'styled-components',
commonjs2: 'styled-components',
amd: 'styled-components',
root: 'styled'
}
},
resolve: {
extensions: ['.tsx', '.ts', '.js'],
modules: ['node_modules', SRC_DIR]
},
module: {
rules: [
{
test: /\.(js|ts|tsx)$/,
loader: 'babel-loader',
include: [SRC_DIR],
options: {
plugins: [
[
'search-and-replace',
{
rules: [
{
search: '__PACKAGE_VERSION__',
replace: KeplerPackage.version
}
]
}
]
]
}
}
]
},

node: {
fs: 'empty'
}
});

module.exports = env => LIBRARY_BUNDLE_CONFIG(env);
2 changes: 1 addition & 1 deletion test/node/reducers/map-style-test.js
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ import {
getInitialInputStyle
} from '@kepler.gl/reducers';
import {keplerGlInit, receiveMapConfig} from '@kepler.gl/actions';
import SchemaManager from 'schemas';
import SchemaManager from '@kepler.gl/schemas';
import {DEFAULT_MAP_STYLES, DEFAULT_MAPBOX_API_URL} from '@kepler.gl/constants';

// helpers
Expand Down
2 changes: 1 addition & 1 deletion test/node/reducers/vis-state-merger-test.js
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ import {
defaultInteractionConfig
} from '@kepler.gl/reducers';

import SchemaManager from 'schemas';
import SchemaManager from '@kepler.gl/schemas';
import {processKeplerglJSON} from '@kepler.gl/processors';
import {updateVisData, receiveMapConfig, addDataToMap} from '@kepler.gl/actions';

Expand Down
2 changes: 1 addition & 1 deletion test/node/schemas/dataset-schema-test.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

import test from 'tape';
import cloneDeep from 'lodash.clonedeep';
import SchemaManager from 'schemas';
import SchemaManager from '@kepler.gl/schemas';

// fixtures
import {
Expand Down