@air/api-core 0.1.1 → 0.1.2

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.
Files changed (2) hide show
  1. package/README.md +35 -0
  2. package/package.json +2 -2
package/README.md ADDED
@@ -0,0 +1,35 @@
1
+ # @air/api-core
2
+
3
+ Core HTTP engine for the [Air API SDK](https://github.com/AirLabsTeam/air-api-sdk).
4
+
5
+ This package provides the low-level HTTP client, pagination, error classes, and retry logic used by `@air/api-rest` and `@air/api-sdk`.
6
+
7
+ ## Installation
8
+
9
+ Most users should install `@air/api-sdk` instead, which includes this package:
10
+
11
+ ```bash
12
+ npm install @air/api-sdk
13
+ ```
14
+
15
+ If you only need the core HTTP primitives:
16
+
17
+ ```bash
18
+ npm install @air/api-core
19
+ ```
20
+
21
+ ## What's included
22
+
23
+ - `AirClient` — HTTP client with automatic retries, timeouts, and header management
24
+ - `PagePromise` / `CursorPage` — async-iterable pagination
25
+ - Error classes — `APIError`, `BadRequestError`, `AuthenticationError`, `NotFoundError`, `RateLimitError`, `ConnectionError`, `TimeoutError`, etc.
26
+ - Retry logic with exponential backoff for transient failures
27
+
28
+ ## Documentation
29
+
30
+ - [Air Developer Docs](https://developer.air.inc/) — API reference and guides
31
+ - [GitHub Repository](https://github.com/AirLabsTeam/air-api-sdk) — source code and examples
32
+
33
+ ## License
34
+
35
+ MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@air/api-core",
3
- "version": "0.1.1",
3
+ "version": "0.1.2",
4
4
  "type": "module",
5
5
  "description": "Core HTTP engine for Air API SDK",
6
6
  "main": "./dist/index.cjs",
@@ -39,5 +39,5 @@
39
39
  "url": "https://github.com/AirLabsTeam/air-api-sdk.git",
40
40
  "directory": "packages/core"
41
41
  },
42
- "license": "UNLICENSED"
42
+ "license": "MIT"
43
43
  }