@apiquest/types 1.0.2 → 1.0.3
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 +52 -0
- package/package.json +27 -22
- package/src/index.ts +823 -823
- package/tsconfig.json +21 -21
package/README.md
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# @apiquest/types
|
|
2
|
+
|
|
3
|
+
Shared TypeScript type definitions for the ApiQuest ecosystem.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @apiquest/types
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type {
|
|
15
|
+
Collection,
|
|
16
|
+
Request,
|
|
17
|
+
Folder,
|
|
18
|
+
Environment,
|
|
19
|
+
RunOptions,
|
|
20
|
+
RunResult,
|
|
21
|
+
IProtocolPlugin,
|
|
22
|
+
IAuthPlugin,
|
|
23
|
+
IValueProviderPlugin
|
|
24
|
+
} from '@apiquest/types';
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Type Exports
|
|
28
|
+
|
|
29
|
+
- **Collection Types:** Collection, Request, Folder, CollectionItem, CollectionInfo
|
|
30
|
+
- **Auth Types:** Auth, BearerAuth, BasicAuth, ApiKeyAuth, OAuth2Auth
|
|
31
|
+
- **Environment:** Environment, Variable
|
|
32
|
+
- **Runtime:** RunOptions, RunResult, RuntimeOptions
|
|
33
|
+
- **Plugins:** IProtocolPlugin, IAuthPlugin, IValueProviderPlugin
|
|
34
|
+
- **Execution:** ExecutionContext, ProtocolResponse, ValidationResult
|
|
35
|
+
|
|
36
|
+
## Schema
|
|
37
|
+
|
|
38
|
+
JSON Schema: https://apiquest.net/schemas/collection-v1.0.json
|
|
39
|
+
|
|
40
|
+
## Compatibility
|
|
41
|
+
|
|
42
|
+
- TypeScript 5.0+
|
|
43
|
+
- Used with `@apiquest/fracture` and plugin development
|
|
44
|
+
|
|
45
|
+
## Documentation
|
|
46
|
+
|
|
47
|
+
- [Fracture Documentation](https://apiquest.net/docs/fracture)
|
|
48
|
+
- [Schema Specification](https://apiquest.net/schemas/collection-v1.0.json)
|
|
49
|
+
|
|
50
|
+
## License
|
|
51
|
+
|
|
52
|
+
Dual-licensed under AGPL-3.0-or-later and commercial license. See LICENSE.txt for details.
|
package/package.json
CHANGED
|
@@ -1,22 +1,27 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "@apiquest/types",
|
|
3
|
-
"version": "1.0.
|
|
4
|
-
"description": "Shared TypeScript types for ApiQuest",
|
|
5
|
-
"type": "module",
|
|
6
|
-
"main": "dist/index.js",
|
|
7
|
-
"types": "dist/index.d.ts",
|
|
8
|
-
"
|
|
9
|
-
"
|
|
10
|
-
"
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
"
|
|
15
|
-
"
|
|
16
|
-
|
|
17
|
-
"
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
"
|
|
21
|
-
|
|
22
|
-
|
|
1
|
+
{
|
|
2
|
+
"name": "@apiquest/types",
|
|
3
|
+
"version": "1.0.3",
|
|
4
|
+
"description": "Shared TypeScript types for ApiQuest",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"main": "dist/index.js",
|
|
7
|
+
"types": "dist/index.d.ts",
|
|
8
|
+
"repository": {
|
|
9
|
+
"type": "git",
|
|
10
|
+
"url": "https://github.com/hh-apiquest/fracture.git",
|
|
11
|
+
"directory": "packages/types"
|
|
12
|
+
},
|
|
13
|
+
"scripts": {
|
|
14
|
+
"build": "tsc",
|
|
15
|
+
"watch": "tsc --watch"
|
|
16
|
+
},
|
|
17
|
+
"keywords": [
|
|
18
|
+
"apiquest",
|
|
19
|
+
"types",
|
|
20
|
+
"schema"
|
|
21
|
+
],
|
|
22
|
+
"author": "ApiQuest",
|
|
23
|
+
"license": "AGPL-3.0-or-later",
|
|
24
|
+
"devDependencies": {
|
|
25
|
+
"typescript": "^5.3.3"
|
|
26
|
+
}
|
|
27
|
+
}
|