@cargo-ai/types 1.0.1 → 1.0.2
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 +47 -0
- package/package.json +8 -2
package/README.md
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# Cargo Types
|
|
2
|
+
|
|
3
|
+
Shared TypeScript types and domain models for Cargo.
|
|
4
|
+
|
|
5
|
+
This package provides the canonical type definitions and domain structures used across Cargo products (e.g. **@cargo-ai/api**, backends, and internal tooling). It includes Zod schemas and domain-specific utilities where applicable.
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install @@cargo-ai/types
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Dependency
|
|
14
|
+
|
|
15
|
+
`@cargo-ai/types` depends on **@cargo-ai/utils**. Install it if your environment does not already provide it:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
npm install @cargo-ai/utils
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Contents
|
|
22
|
+
|
|
23
|
+
Domain-oriented types and helpers for:
|
|
24
|
+
|
|
25
|
+
- **Ai** – AI resources, agents, MCP servers, files, templates
|
|
26
|
+
- **Billing** – billing and subscription types
|
|
27
|
+
- **Connection** – connectors, integrations, filters, extractors
|
|
28
|
+
- **Expression** – expression types and `ExpressionUtils`
|
|
29
|
+
- **Orchestration** – workflows, plays, tools, templates, `OrchestrationUtils`
|
|
30
|
+
- **RevenueOrganization** – members, capacities, territories
|
|
31
|
+
- **Segmentation** – segment types
|
|
32
|
+
- **Storage** – datasets, models, relationships, columns
|
|
33
|
+
- **SystemOfRecordIntegration** – system of records, clients
|
|
34
|
+
- **UserManagement** – user and permission types
|
|
35
|
+
- **WorkspaceManagement** – workspaces, folders, roles, tokens
|
|
36
|
+
- **Global** – shared utilities used across domains
|
|
37
|
+
|
|
38
|
+
Use these types when you need to type payloads, validate data, or share structures with the Cargo API and backend without depending on the full **@cargo-ai/api** client.
|
|
39
|
+
|
|
40
|
+
## Requirements
|
|
41
|
+
|
|
42
|
+
- Node.js 22.x
|
|
43
|
+
- TypeScript (for types)
|
|
44
|
+
|
|
45
|
+
## License
|
|
46
|
+
|
|
47
|
+
See the root of the repository for license information.
|
package/package.json
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cargo-ai/types",
|
|
3
|
+
"description": "Shared TypeScript types and domain models for Cargo.",
|
|
3
4
|
"private": false,
|
|
5
|
+
"license": "UNLICENSED",
|
|
4
6
|
"engines": {
|
|
5
7
|
"node": "22.x"
|
|
6
8
|
},
|
|
@@ -9,6 +11,10 @@
|
|
|
9
11
|
},
|
|
10
12
|
"type": "module",
|
|
11
13
|
"exports": "./build/src/index.js",
|
|
14
|
+
"files": [
|
|
15
|
+
"build",
|
|
16
|
+
"README.md"
|
|
17
|
+
],
|
|
12
18
|
"scripts": {
|
|
13
19
|
"afterinstall": "npm run build",
|
|
14
20
|
"dev": "tsc --watch",
|
|
@@ -20,7 +26,7 @@
|
|
|
20
26
|
"format:check": "prettier --check ."
|
|
21
27
|
},
|
|
22
28
|
"dependencies": {
|
|
23
|
-
"@cargo-ai/utils": "^1.0.
|
|
29
|
+
"@cargo-ai/utils": "^1.0.5"
|
|
24
30
|
},
|
|
25
31
|
"devDependencies": {
|
|
26
32
|
"@types/node": "^20.10.8",
|
|
@@ -34,5 +40,5 @@
|
|
|
34
40
|
"typescript": "5.3.2",
|
|
35
41
|
"zod": "3.25.76"
|
|
36
42
|
},
|
|
37
|
-
"version": "1.0.
|
|
43
|
+
"version": "1.0.2"
|
|
38
44
|
}
|