@webpieces/client 0.0.0-dev
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +43 -0
- package/package.json +28 -0
- package/src/index.js +13 -0
- package/src/index.js.map +1 -0
package/README.md
ADDED
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# @webpieces/client
|
|
2
|
+
|
|
3
|
+
Umbrella package for WebPieces client-side development. This package installs all necessary dependencies for building WebPieces client applications.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @webpieces/client
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## What's Included
|
|
12
|
+
|
|
13
|
+
This package installs:
|
|
14
|
+
|
|
15
|
+
- `@webpieces/http-client` - Type-safe HTTP client generation from API definitions
|
|
16
|
+
- `@webpieces/http-api` - HTTP API decorators for REST APIs
|
|
17
|
+
|
|
18
|
+
## Usage
|
|
19
|
+
|
|
20
|
+
After installation, import from the constituent packages:
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
import { createApiClient } from '@webpieces/http-client';
|
|
24
|
+
import { Post, Get, ApiInterface } from '@webpieces/http-api';
|
|
25
|
+
|
|
26
|
+
// Your client code here...
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## Version Compatibility
|
|
30
|
+
|
|
31
|
+
All @webpieces packages use lock-step versioning. Always use matching versions:
|
|
32
|
+
|
|
33
|
+
```json
|
|
34
|
+
{
|
|
35
|
+
"dependencies": {
|
|
36
|
+
"@webpieces/client": "0.2.10"
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## License
|
|
42
|
+
|
|
43
|
+
Apache-2.0
|
package/package.json
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@webpieces/client",
|
|
3
|
+
"version": "0.0.0-dev",
|
|
4
|
+
"description": "Umbrella package for WebPieces client-side dependencies",
|
|
5
|
+
"type": "commonjs",
|
|
6
|
+
"author": "Dean Hiller",
|
|
7
|
+
"license": "Apache-2.0",
|
|
8
|
+
"repository": {
|
|
9
|
+
"type": "git",
|
|
10
|
+
"url": "https://github.com/deanhiller/webpieces-ts.git",
|
|
11
|
+
"directory": "packages/client"
|
|
12
|
+
},
|
|
13
|
+
"keywords": [
|
|
14
|
+
"webpieces",
|
|
15
|
+
"client",
|
|
16
|
+
"http-client",
|
|
17
|
+
"umbrella"
|
|
18
|
+
],
|
|
19
|
+
"publishConfig": {
|
|
20
|
+
"access": "public"
|
|
21
|
+
},
|
|
22
|
+
"dependencies": {
|
|
23
|
+
"@webpieces/http-client": "0.0.0-dev",
|
|
24
|
+
"@webpieces/http-api": "0.0.0-dev"
|
|
25
|
+
},
|
|
26
|
+
"types": "./src/index.d.ts",
|
|
27
|
+
"main": "./src/index.js"
|
|
28
|
+
}
|
package/src/index.js
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* @webpieces/client - Umbrella package for client-side dependencies
|
|
4
|
+
*
|
|
5
|
+
* This is a Maven-style umbrella package that installs all client-side dependencies.
|
|
6
|
+
* Do not import from this package directly. Instead, import from constituent packages:
|
|
7
|
+
*
|
|
8
|
+
* @example
|
|
9
|
+
* import { createApiClient } from '@webpieces/http-client';
|
|
10
|
+
* import { ApiInterface, Post, Get } from '@webpieces/http-api';
|
|
11
|
+
*/
|
|
12
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
13
|
+
//# sourceMappingURL=index.js.map
|
package/src/index.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/client/src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG","sourcesContent":["/**\n * @webpieces/client - Umbrella package for client-side dependencies\n *\n * This is a Maven-style umbrella package that installs all client-side dependencies.\n * Do not import from this package directly. Instead, import from constituent packages:\n *\n * @example\n * import { createApiClient } from '@webpieces/http-client';\n * import { ApiInterface, Post, Get } from '@webpieces/http-api';\n */\n\n// This file exists only to satisfy build requirements.\n// Users should import from constituent packages, not from this umbrella package.\nexport {};\n"]}
|