@korala/public-dtos 1.0.0 → 1.0.1
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 +49 -0
- package/package.json +4 -7
package/README.md
ADDED
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# @korala/public-dtos
|
|
2
|
+
|
|
3
|
+
TypeScript type definitions for the [Korala](https://korala.ai) document signing API.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @korala/public-dtos
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import {
|
|
15
|
+
DocumentStatus,
|
|
16
|
+
FieldType,
|
|
17
|
+
type DocumentDto,
|
|
18
|
+
type SignerDto,
|
|
19
|
+
} from '@korala/public-dtos';
|
|
20
|
+
|
|
21
|
+
function isComplete(doc: DocumentDto): boolean {
|
|
22
|
+
return doc.status === DocumentStatus.Completed;
|
|
23
|
+
}
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
> **Note:** Most users should use `@korala/api-client` which re-exports all types from this package. Install this package directly only if you need the types without the API client.
|
|
27
|
+
|
|
28
|
+
## Exported Types
|
|
29
|
+
|
|
30
|
+
### Enums
|
|
31
|
+
|
|
32
|
+
| Enum | Values |
|
|
33
|
+
|------|--------|
|
|
34
|
+
| `DocumentStatus` | `Draft`, `Pending`, `Completed`, `Voided`, `Declined` |
|
|
35
|
+
| `FieldType` | `Signature`, `Initials`, `Date`, `Text`, `Checkbox` |
|
|
36
|
+
| `AuthMethod` | `Bearer`, `Hmac` |
|
|
37
|
+
| `SignerStatus` | `Pending`, `Viewed`, `Signed`, `Declined` |
|
|
38
|
+
|
|
39
|
+
### DTOs
|
|
40
|
+
|
|
41
|
+
Documents, signers, fields, templates, webhooks, signatures, and all request/response types used by the Korala API.
|
|
42
|
+
|
|
43
|
+
## Documentation
|
|
44
|
+
|
|
45
|
+
Full API documentation at [docs.korala.ai](https://docs.korala.ai).
|
|
46
|
+
|
|
47
|
+
## License
|
|
48
|
+
|
|
49
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,13 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@korala/public-dtos",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"description": "Public TypeScript types for the Korala document signing API",
|
|
5
5
|
"license": "MIT",
|
|
6
|
-
"
|
|
7
|
-
"type": "git",
|
|
8
|
-
"url": "git+https://github.com/korala-ai/korala.git",
|
|
9
|
-
"directory": "packages/public-dtos"
|
|
10
|
-
},
|
|
6
|
+
"homepage": "https://docs.korala.ai",
|
|
11
7
|
"main": "./dist/index.js",
|
|
12
8
|
"types": "./dist/index.d.ts",
|
|
13
9
|
"exports": {
|
|
@@ -18,7 +14,8 @@
|
|
|
18
14
|
}
|
|
19
15
|
},
|
|
20
16
|
"files": [
|
|
21
|
-
"dist"
|
|
17
|
+
"dist",
|
|
18
|
+
"README.md"
|
|
22
19
|
],
|
|
23
20
|
"publishConfig": {
|
|
24
21
|
"access": "public"
|