@reviewskits/types 0.0.1 → 0.0.4
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 +42 -7
- package/package.json +22 -2
package/README.md
CHANGED
|
@@ -1,15 +1,50 @@
|
|
|
1
|
-
# types
|
|
1
|
+
# @reviewskits/types
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
<div align="center">
|
|
4
|
+
<img src="https://raw.githubusercontent.com/reviews-kits-team/reviews-kits/main/apps/docs/docs/public/logo.svg" alt="ReviewsKits Logo" width="120" />
|
|
5
|
+
<h3>Shared TypeScript Definitions for ReviewsKits</h3>
|
|
6
|
+
<p>The core type definitions and interfaces used across the ReviewsKits ecosystem.</p>
|
|
7
|
+
</div>
|
|
8
|
+
|
|
9
|
+
<p align="center">
|
|
10
|
+
<a href="https://docs.reviewskits.com"><strong>Explore the docs »</strong></a>
|
|
11
|
+
<br />
|
|
12
|
+
<br />
|
|
13
|
+
<a href="https://reviewskits.com">Website</a>
|
|
14
|
+
·
|
|
15
|
+
<a href="https://docs.reviewskits.com">Documentation</a>
|
|
16
|
+
</p>
|
|
17
|
+
|
|
18
|
+
## 📦 About
|
|
19
|
+
|
|
20
|
+
This package contains the shared TypeScript types, interfaces, and enums used by:
|
|
21
|
+
- `@reviewskits/react`
|
|
22
|
+
- `@reviewskits/vue`
|
|
23
|
+
- ReviewsKits Backend API
|
|
24
|
+
|
|
25
|
+
## 🚀 Installation
|
|
26
|
+
|
|
27
|
+
This package is typically installed automatically as a dependency of the official SDKs. If you need it directly:
|
|
4
28
|
|
|
5
29
|
```bash
|
|
6
|
-
bun
|
|
30
|
+
bun add @reviewskits/types
|
|
31
|
+
# or
|
|
32
|
+
npm install @reviewskits/types
|
|
7
33
|
```
|
|
8
34
|
|
|
9
|
-
|
|
35
|
+
## 💻 Usage
|
|
10
36
|
|
|
11
|
-
|
|
12
|
-
|
|
37
|
+
Most types are exported directly from the root:
|
|
38
|
+
|
|
39
|
+
```typescript
|
|
40
|
+
import type { Review, ReviewsKitConfig } from '@reviewskits/types'
|
|
41
|
+
|
|
42
|
+
const myConfig: ReviewsKitConfig = {
|
|
43
|
+
pk: 'YOUR_PUBLIC_KEY',
|
|
44
|
+
host: 'https://api.reviewskits.com'
|
|
45
|
+
}
|
|
13
46
|
```
|
|
14
47
|
|
|
15
|
-
|
|
48
|
+
## ⚖️ License
|
|
49
|
+
|
|
50
|
+
MIT © [ReviewsKits](https://reviewskits.com)
|
package/package.json
CHANGED
|
@@ -1,9 +1,27 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@reviewskits/types",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.4",
|
|
4
|
+
"description": "Shared TypeScript definitions for ReviewsKits",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"reviewskits",
|
|
7
|
+
"testimonials",
|
|
8
|
+
"types",
|
|
9
|
+
"typescript",
|
|
10
|
+
"sdk"
|
|
11
|
+
],
|
|
12
|
+
"homepage": "https://reviewskits.com",
|
|
13
|
+
"repository": {
|
|
14
|
+
"type": "git",
|
|
15
|
+
"url": "https://github.com/reviews-kits-team/reviews-kits.git",
|
|
16
|
+
"directory": "packages/types"
|
|
17
|
+
},
|
|
18
|
+
"bugs": {
|
|
19
|
+
"url": "https://github.com/reviews-kits-team/reviews-kits/issues"
|
|
20
|
+
},
|
|
4
21
|
"files": [
|
|
5
22
|
"dist"
|
|
6
23
|
],
|
|
24
|
+
"sideEffects": false,
|
|
7
25
|
"module": "./dist/index.js",
|
|
8
26
|
"main": "./dist/index.js",
|
|
9
27
|
"types": "./dist/index.d.ts",
|
|
@@ -14,10 +32,12 @@
|
|
|
14
32
|
"test": "echo 'No tests yet'"
|
|
15
33
|
},
|
|
16
34
|
"private": false,
|
|
35
|
+
"author": "ReviewsKits Team",
|
|
36
|
+
"license": "MIT",
|
|
17
37
|
"devDependencies": {
|
|
18
38
|
"@types/bun": "latest"
|
|
19
39
|
},
|
|
20
40
|
"peerDependencies": {
|
|
21
41
|
"typescript": "^5.9.3"
|
|
22
42
|
}
|
|
23
|
-
}
|
|
43
|
+
}
|