@conversokit/shared 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.
- package/README.md +37 -0
- package/package.json +13 -1
package/README.md
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# @conversokit/shared
|
|
2
|
+
|
|
3
|
+
Shared Zod schemas, TypeScript types, and example fixtures consumed by every other ConversoKit package.
|
|
4
|
+
|
|
5
|
+
Part of [ConversoKit](https://github.com/Xyborg/ConversoKit) — a boilerplate for building ChatGPT Apps (Apps SDK / MCP) in <30 minutes.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
pnpm add @conversokit/shared
|
|
11
|
+
# or
|
|
12
|
+
npm install @conversokit/shared
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Usage
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
import { defineTool, WidgetConfig } from '@conversokit/shared';
|
|
19
|
+
import { z } from 'zod';
|
|
20
|
+
|
|
21
|
+
export const searchProducts = defineTool({
|
|
22
|
+
name: 'search_products',
|
|
23
|
+
description: 'Search the catalog',
|
|
24
|
+
inputSchema: z.object({ query: z.string() }),
|
|
25
|
+
outputSchema: z.object({ products: z.array(z.any()) }),
|
|
26
|
+
permissions: { requiresAuth: false, requiresConsent: false },
|
|
27
|
+
handler: async ({ input }) => ({ products: [] }),
|
|
28
|
+
});
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## Documentation
|
|
32
|
+
|
|
33
|
+
Full docs and runnable examples live in the [main repo](https://github.com/Xyborg/ConversoKit#readme).
|
|
34
|
+
|
|
35
|
+
## License
|
|
36
|
+
|
|
37
|
+
Apache-2.0 © Martín Aberastegue
|
package/package.json
CHANGED
|
@@ -1,8 +1,20 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@conversokit/shared",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "Shared Zod schemas, TypeScript types, and example fixtures consumed by every other ConversoKit package.",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
|
+
"keywords": [
|
|
7
|
+
"zod",
|
|
8
|
+
"schemas",
|
|
9
|
+
"types",
|
|
10
|
+
"contracts",
|
|
11
|
+
"conversokit",
|
|
12
|
+
"chatgpt-apps",
|
|
13
|
+
"mcp"
|
|
14
|
+
],
|
|
15
|
+
"engines": {
|
|
16
|
+
"node": ">=18.0.0"
|
|
17
|
+
},
|
|
6
18
|
"repository": {
|
|
7
19
|
"type": "git",
|
|
8
20
|
"url": "git+https://github.com/Xyborg/ConversoKit.git",
|