@robinpath/vercel 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 CHANGED
@@ -1,124 +1,124 @@
1
- # @robinpath/vercel
2
-
3
- > Vercel module for RobinPath.
4
-
5
- ![Category](https://img.shields.io/badge/category-DevOps-blue) ![Functions](https://img.shields.io/badge/functions-30-green) ![Auth](https://img.shields.io/badge/auth-Bearer%20Token-orange) ![License](https://img.shields.io/badge/license-MIT-brightgreen)
6
-
7
- ## Why use this module?
8
-
9
- The `vercel` module lets you:
10
-
11
- - List all projects in the authenticated account
12
- - Get details of a project by ID or name
13
- - Create a new Vercel project
14
- - Update settings of an existing project
15
- - Delete a Vercel project
16
-
17
- All functions are callable directly from RobinPath scripts with a simple, consistent API.
18
-
19
- ## Installation
20
-
21
- ```bash
22
- npm install @robinpath/vercel
23
- ```
24
-
25
- ## Quick Start
26
-
27
- **1. Set up credentials**
28
-
29
- ```robinpath
30
- vercel.setToken "my-vercel-token"
31
- ```
32
-
33
- **2. List all projects in the authenticated account**
34
-
35
- ```robinpath
36
- vercel.listProjects {"limit": 20, "search": "my-app"}
37
- ```
38
-
39
- ## Available Functions
40
-
41
- | Function | Description |
42
- |----------|-------------|
43
- | `vercel.setToken` | Set the Vercel API bearer token for authentication |
44
- | `vercel.listProjects` | List all projects in the authenticated account |
45
- | `vercel.getProject` | Get details of a project by ID or name |
46
- | `vercel.createProject` | Create a new Vercel project |
47
- | `vercel.updateProject` | Update settings of an existing project |
48
- | `vercel.deleteProject` | Delete a Vercel project |
49
- | `vercel.listDeployments` | List deployments, optionally filtered by project, state, or target |
50
- | `vercel.getDeployment` | Get details of a specific deployment |
51
- | `vercel.createDeployment` | Create a new deployment with files |
52
- | `vercel.cancelDeployment` | Cancel an in-progress deployment |
53
- | `vercel.deleteDeployment` | Delete a deployment |
54
- | `vercel.redeployDeployment` | Redeploy an existing deployment (create from existing) |
55
- | `vercel.listDomains` | List all domains in the authenticated account |
56
- | `vercel.getDomain` | Get information about a specific domain |
57
- | `vercel.addDomain` | Register a new domain to the account |
58
- | `vercel.removeDomain` | Remove a domain from the account |
59
- | `vercel.listProjectDomains` | List all domains assigned to a project |
60
- | `vercel.addProjectDomain` | Add a domain to a project |
61
- | `vercel.removeProjectDomain` | Remove a domain from a project |
62
- | `vercel.getDomainConfig` | Get DNS configuration for a domain |
63
- | `vercel.verifyDomain` | Verify a domain attached to a project |
64
- | `vercel.listEnvVars` | List all environment variables for a project |
65
- | `vercel.getEnvVar` | Get details of a specific environment variable |
66
- | `vercel.createEnvVar` | Create a new environment variable for a project |
67
- | `vercel.updateEnvVar` | Update an existing environment variable |
68
- | `vercel.deleteEnvVar` | Delete an environment variable from a project |
69
- | `vercel.getUser` | Get the authenticated user's profile |
70
- | `vercel.listTeams` | List all teams the authenticated user belongs to |
71
- | `vercel.getTeam` | Get details of a specific team |
72
- | `vercel.getDeploymentLogs` | Get build logs for a deployment |
73
-
74
- ## Examples
75
-
76
- ### List all projects in the authenticated account
77
-
78
- ```robinpath
79
- vercel.listProjects {"limit": 20, "search": "my-app"}
80
- ```
81
-
82
- ### Get details of a project by ID or name
83
-
84
- ```robinpath
85
- vercel.getProject "my-project"
86
- ```
87
-
88
- ### Create a new Vercel project
89
-
90
- ```robinpath
91
- vercel.createProject "my-app" {"framework": "nextjs"}
92
- ```
93
-
94
- ## Integration with RobinPath
95
-
96
- ```typescript
97
- import { RobinPath } from "@wiredwp/robinpath";
98
- import Module from "@robinpath/vercel";
99
-
100
- const rp = new RobinPath();
101
- rp.registerModule(Module.name, Module.functions);
102
- rp.registerModuleMeta(Module.name, Module.functionMetadata);
103
-
104
- const result = await rp.executeScript(`
105
- vercel.setToken "my-vercel-token"
106
- vercel.listProjects {"limit": 20, "search": "my-app"}
107
- `);
108
- ```
109
-
110
- ## Full API Reference
111
-
112
- See [MODULE.md](./MODULE.md) for complete documentation including all parameters, return types, error handling, and advanced examples.
113
-
114
- ## Related Modules
115
-
116
- - [`@robinpath/docker`](../docker) — Docker module for complementary functionality
117
- - [`@robinpath/git`](../git) — Git module for complementary functionality
118
- - [`@robinpath/github`](../github) — GitHub module for complementary functionality
119
- - [`@robinpath/gitlab`](../gitlab) — GitLab module for complementary functionality
120
- - [`@robinpath/netlify`](../netlify) — Netlify module for complementary functionality
121
-
122
- ## License
123
-
124
- MIT
1
+ # @robinpath/vercel
2
+
3
+ > Vercel module for RobinPath.
4
+
5
+ ![Category](https://img.shields.io/badge/category-DevOps-blue) ![Functions](https://img.shields.io/badge/functions-30-green) ![Auth](https://img.shields.io/badge/auth-Bearer%20Token-orange) ![License](https://img.shields.io/badge/license-MIT-brightgreen)
6
+
7
+ ## Why use this module?
8
+
9
+ The `vercel` module lets you:
10
+
11
+ - List all projects in the authenticated account
12
+ - Get details of a project by ID or name
13
+ - Create a new Vercel project
14
+ - Update settings of an existing project
15
+ - Delete a Vercel project
16
+
17
+ All functions are callable directly from RobinPath scripts with a simple, consistent API.
18
+
19
+ ## Installation
20
+
21
+ ```bash
22
+ npm install @robinpath/vercel
23
+ ```
24
+
25
+ ## Quick Start
26
+
27
+ **1. Set up credentials**
28
+
29
+ ```robinpath
30
+ vercel.setToken "my-vercel-token"
31
+ ```
32
+
33
+ **2. List all projects in the authenticated account**
34
+
35
+ ```robinpath
36
+ vercel.listProjects {"limit": 20, "search": "my-app"}
37
+ ```
38
+
39
+ ## Available Functions
40
+
41
+ | Function | Description |
42
+ |----------|-------------|
43
+ | `vercel.setToken` | Set the Vercel API bearer token for authentication |
44
+ | `vercel.listProjects` | List all projects in the authenticated account |
45
+ | `vercel.getProject` | Get details of a project by ID or name |
46
+ | `vercel.createProject` | Create a new Vercel project |
47
+ | `vercel.updateProject` | Update settings of an existing project |
48
+ | `vercel.deleteProject` | Delete a Vercel project |
49
+ | `vercel.listDeployments` | List deployments, optionally filtered by project, state, or target |
50
+ | `vercel.getDeployment` | Get details of a specific deployment |
51
+ | `vercel.createDeployment` | Create a new deployment with files |
52
+ | `vercel.cancelDeployment` | Cancel an in-progress deployment |
53
+ | `vercel.deleteDeployment` | Delete a deployment |
54
+ | `vercel.redeployDeployment` | Redeploy an existing deployment (create from existing) |
55
+ | `vercel.listDomains` | List all domains in the authenticated account |
56
+ | `vercel.getDomain` | Get information about a specific domain |
57
+ | `vercel.addDomain` | Register a new domain to the account |
58
+ | `vercel.removeDomain` | Remove a domain from the account |
59
+ | `vercel.listProjectDomains` | List all domains assigned to a project |
60
+ | `vercel.addProjectDomain` | Add a domain to a project |
61
+ | `vercel.removeProjectDomain` | Remove a domain from a project |
62
+ | `vercel.getDomainConfig` | Get DNS configuration for a domain |
63
+ | `vercel.verifyDomain` | Verify a domain attached to a project |
64
+ | `vercel.listEnvVars` | List all environment variables for a project |
65
+ | `vercel.getEnvVar` | Get details of a specific environment variable |
66
+ | `vercel.createEnvVar` | Create a new environment variable for a project |
67
+ | `vercel.updateEnvVar` | Update an existing environment variable |
68
+ | `vercel.deleteEnvVar` | Delete an environment variable from a project |
69
+ | `vercel.getUser` | Get the authenticated user's profile |
70
+ | `vercel.listTeams` | List all teams the authenticated user belongs to |
71
+ | `vercel.getTeam` | Get details of a specific team |
72
+ | `vercel.getDeploymentLogs` | Get build logs for a deployment |
73
+
74
+ ## Examples
75
+
76
+ ### List all projects in the authenticated account
77
+
78
+ ```robinpath
79
+ vercel.listProjects {"limit": 20, "search": "my-app"}
80
+ ```
81
+
82
+ ### Get details of a project by ID or name
83
+
84
+ ```robinpath
85
+ vercel.getProject "my-project"
86
+ ```
87
+
88
+ ### Create a new Vercel project
89
+
90
+ ```robinpath
91
+ vercel.createProject "my-app" {"framework": "nextjs"}
92
+ ```
93
+
94
+ ## Integration with RobinPath
95
+
96
+ ```typescript
97
+ import { RobinPath } from "@wiredwp/robinpath";
98
+ import Module from "@robinpath/vercel";
99
+
100
+ const rp = new RobinPath();
101
+ rp.registerModule(Module.name, Module.functions);
102
+ rp.registerModuleMeta(Module.name, Module.functionMetadata);
103
+
104
+ const result = await rp.executeScript(`
105
+ vercel.setToken "my-vercel-token"
106
+ vercel.listProjects {"limit": 20, "search": "my-app"}
107
+ `);
108
+ ```
109
+
110
+ ## Full API Reference
111
+
112
+ See [MODULE.md](./MODULE.md) for complete documentation including all parameters, return types, error handling, and advanced examples.
113
+
114
+ ## Related Modules
115
+
116
+ - [`@robinpath/docker`](../docker) — Docker module for complementary functionality
117
+ - [`@robinpath/git`](../git) — Git module for complementary functionality
118
+ - [`@robinpath/github`](../github) — GitHub module for complementary functionality
119
+ - [`@robinpath/gitlab`](../gitlab) — GitLab module for complementary functionality
120
+ - [`@robinpath/netlify`](../netlify) — Netlify module for complementary functionality
121
+
122
+ ## License
123
+
124
+ MIT
package/package.json CHANGED
@@ -1,13 +1,42 @@
1
1
  {
2
2
  "name": "@robinpath/vercel",
3
- "version": "0.1.0",
4
- "publishConfig": { "access": "public" },
3
+ "version": "0.1.1",
4
+ "publishConfig": {
5
+ "access": "public"
6
+ },
5
7
  "type": "module",
6
8
  "main": "dist/index.js",
7
9
  "types": "dist/index.d.ts",
8
- "exports": { ".": { "import": "./dist/index.js", "types": "./dist/index.d.ts" } },
9
- "files": ["dist"],
10
- "scripts": { "build": "tsc" },
11
- "peerDependencies": { "@wiredwp/robinpath": ">=0.20.0" },
12
- "devDependencies": { "@wiredwp/robinpath": "^0.30.1", "typescript": "^5.6.0" }
10
+ "exports": {
11
+ ".": {
12
+ "import": "./dist/index.js",
13
+ "types": "./dist/index.d.ts"
14
+ }
15
+ },
16
+ "files": [
17
+ "dist"
18
+ ],
19
+ "scripts": {
20
+ "build": "tsc"
21
+ },
22
+ "peerDependencies": {
23
+ "@robinpath/core": ">=0.20.0"
24
+ },
25
+ "devDependencies": {
26
+ "@robinpath/core": "^0.30.1",
27
+ "typescript": "^5.6.0"
28
+ },
29
+ "description": "Vercel module for RobinPath.",
30
+ "keywords": [
31
+ "vercel",
32
+ "devops"
33
+ ],
34
+ "license": "MIT",
35
+ "robinpath": {
36
+ "category": "devops",
37
+ "type": "integration",
38
+ "auth": "bearer-token",
39
+ "functionCount": 30,
40
+ "baseUrl": "https://api.vercel.com"
41
+ }
13
42
  }
package/dist/index.d.ts DELETED
@@ -1,6 +0,0 @@
1
- import type { ModuleAdapter } from "@wiredwp/robinpath";
2
- declare const VercelModule: ModuleAdapter;
3
- export default VercelModule;
4
- export { VercelModule };
5
- export { VercelFunctions, VercelFunctionMetadata, VercelModuleMetadata } from "./vercel.js";
6
- //# sourceMappingURL=index.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAGxD,QAAA,MAAM,YAAY,EAAE,aAMnB,CAAC;AAEF,eAAe,YAAY,CAAC;AAC5B,OAAO,EAAE,YAAY,EAAE,CAAC;AACxB,OAAO,EAAE,eAAe,EAAE,sBAAsB,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC"}
package/dist/index.js DELETED
@@ -1,12 +0,0 @@
1
- import { VercelFunctions, VercelFunctionMetadata, VercelModuleMetadata } from "./vercel.js";
2
- const VercelModule = {
3
- name: "vercel",
4
- functions: VercelFunctions,
5
- functionMetadata: VercelFunctionMetadata,
6
- moduleMetadata: VercelModuleMetadata,
7
- global: false,
8
- }; // as ModuleAdapter
9
- export default VercelModule;
10
- export { VercelModule };
11
- export { VercelFunctions, VercelFunctionMetadata, VercelModuleMetadata } from "./vercel.js";
12
- //# sourceMappingURL=index.js.map
package/dist/index.js.map DELETED
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,sBAAsB,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAE5F,MAAM,YAAY,GAAkB;IAClC,IAAI,EAAE,QAAQ;IACd,SAAS,EAAE,eAAe;IAC1B,gBAAgB,EAAE,sBAA6B;IAC/C,cAAc,EAAE,oBAA2B;IAC3C,MAAM,EAAE,KAAK;CACd,CAAC,CAAC,mBAAmB;AAEtB,eAAe,YAAY,CAAC;AAC5B,OAAO,EAAE,YAAY,EAAE,CAAC;AACxB,OAAO,EAAE,eAAe,EAAE,sBAAsB,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC"}