Skip to content

Commit

Permalink
Merge pull request #18 from apache-superset/kristw--rename-core
Browse files Browse the repository at this point in the history
rename core package to connection
  • Loading branch information
kristw authored and zhaoyongjie committed Nov 25, 2021
1 parent e7d6986 commit a6e7492
Show file tree
Hide file tree
Showing 19 changed files with 12 additions and 12 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ applications that leverage a Superset backend :chart_with_upwards_trend:

| Package | Version |
|--|--|
| [@superset-ui/core](https://github.com/apache-superset/superset-ui/tree/master/packages/superset-ui-core) | [![Version](https://img.shields.io/npm/v/@superset-ui/core.svg?style=flat-square)](https://img.shields.io/npm/v/@superset-ui/core.svg?style=flat) |
| [@superset-ui/connection](https://github.com/apache-superset/superset-ui/tree/master/packages/superset-ui-connection) | [![Version](https://img.shields.io/npm/v/@superset-ui/connection.svg?style=flat-square)](https://img.shields.io/npm/v/@superset-ui/connection.svg?style=flat) |
| [@superset-ui/translation](https://github.com/apache-superset/superset-ui/tree/master/packages/superset-ui-translation) | [![Version](https://img.shields.io/npm/v/@superset-ui/translation.svg?style=flat-square)](https://img.shields.io/npm/v/@superset-ui/translation.svg?style=flat) |

#### Coming :soon:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
## `@superset-ui/core`
## @superset-ui/connection

[![Version](https://img.shields.io/npm/v/@superset-ui/core.svg?style=flat)](https://img.shields.io/npm/v/@superset-ui/core.svg?style=flat)
[![Version](https://img.shields.io/npm/v/@superset-ui/connection.svg?style=flat)](https://img.shields.io/npm/v/@superset-ui/connection.svg?style=flat)

Core modules for Superset:
Connection modules for Superset:

- `SupersetClient` requests and authentication
- (future) `i18n` locales and translation
Expand All @@ -27,14 +27,14 @@ a high-level it supports:

```javascript
// appSetup.js
import { SupersetClient } from `@superset-ui/core`;
// or import SupersetClient from `@superset-ui/core/lib|esm/SupersetClient`;
import { SupersetClient } from `@superset-ui/connection`;
// or import SupersetClient from `@superset-ui/connection/lib|esm/SupersetClient`;

SupersetClient.configure(...clientConfig);
SupersetClient.init(); // CSRF auth, can also chain `.configure().init();

// anotherFile.js
import { SupersetClient } from `@superset-ui/core`;
import { SupersetClient } from `@superset-ui/connection`;

SupersetClient.post(...requestConfig)
.then(({ request, json }) => ...)
Expand Down Expand Up @@ -75,7 +75,7 @@ The following flags can be passed on a per-request call `SupersetClient.get/post
Per-request aborting is implemented through the `AbortController` API:

```javascript
import { SupersetClient } from '@superset-ui/core';
import { SupersetClient } from '@superset-ui/connection';
import AbortController from 'abortcontroller-polyfill';

const controller = new AbortController();
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@superset-ui/core",
"version": "0.2.0",
"description": "Superset UI core 🤖",
"name": "@superset-ui/connection",
"version": "0.0.0",
"description": "Superset UI connection",
"sideEffects": false,
"main": "lib/index.js",
"module": "esm/index.js",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## `@superset-ui/translation`
## @superset-ui/translation

[![Version](https://img.shields.io/npm/v/@superset-ui/translation.svg?style=flat)](https://img.shields.io/npm/v/@superset-ui/translation.svg?style=flat)

Expand Down

0 comments on commit a6e7492

Please sign in to comment.