@ethioreview/review-widget-core 0.1.0 → 0.1.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.
Files changed (2) hide show
  1. package/README.md +34 -0
  2. package/package.json +15 -2
package/README.md ADDED
@@ -0,0 +1,34 @@
1
+ # `@ethioreview/review-widget-core`
2
+
3
+ `WidgetApiClient` and re-exports of shared widget types for EthioReview embeds.
4
+
5
+ **Docs:** [docs.ethioreview.com](https://docs.ethioreview.com/sdks/review-widget/packages)
6
+
7
+ ## Install
8
+
9
+ ```bash
10
+ npm install @ethioreview/review-widget-core
11
+ ```
12
+
13
+ ```ts
14
+ import { WidgetApiClient } from "@ethioreview/review-widget-core";
15
+
16
+ const client = new WidgetApiClient({
17
+ baseUrl: "https://api.ethioreview.com",
18
+ publicKey: "pk_test_YOUR_KEY",
19
+ });
20
+
21
+ const data = await client.resolveWidget("YOUR_WIDGET_ID");
22
+ ```
23
+
24
+ ## Related packages
25
+
26
+ | Package | Use for |
27
+ | ------- | ------- |
28
+ | [`@ethioreview/review-widget-core-client`](https://www.npmjs.com/package/@ethioreview/review-widget-core-client) | Lower-level `CoreClient` |
29
+ | [`@ethioreview/review-widget-react`](https://www.npmjs.com/package/@ethioreview/review-widget-react) | React UI on top of this client |
30
+ | [`@ethioreview/review-widget-next`](https://www.npmjs.com/package/@ethioreview/review-widget-next) | Next.js SSR helpers |
31
+
32
+ ## License
33
+
34
+ MIT · [github.com/ethioreview/review-widget](https://github.com/ethioreview/review-widget)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ethioreview/review-widget-core",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "type": "module",
5
5
  "exports": {
6
6
  ".": {
@@ -24,12 +24,25 @@
24
24
  "access": "public"
25
25
  },
26
26
  "dependencies": {
27
- "@ethioreview/review-widget-core-client": "0.1.0"
27
+ "@ethioreview/review-widget-core-client": "0.1.1"
28
28
  },
29
29
  "devDependencies": {
30
30
  "typescript": "^5.9.0",
31
31
  "vitest": "^3.2.4"
32
32
  },
33
+ "description": "WidgetApiClient and shared types for EthioReview review widgets",
34
+ "homepage": "https://docs.ethioreview.com/sdks/review-widget/overview",
35
+ "keywords": [
36
+ "ethioreview",
37
+ "reviews",
38
+ "testimonials",
39
+ "widget",
40
+ "embed"
41
+ ],
42
+ "bugs": {
43
+ "url": "https://github.com/ethioreview/review-widget/issues"
44
+ },
45
+ "license": "MIT",
33
46
  "scripts": {
34
47
  "build": "tsc -p tsconfig.json",
35
48
  "typecheck": "tsc -p tsconfig.json --noEmit",