@opendatalabs/connect 0.8.0 → 0.8.1-canary.185157c
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 +100 -0
- package/dist/cli/bin.d.ts +3 -0
- package/dist/cli/bin.d.ts.map +1 -0
- package/dist/cli/bin.js +7 -0
- package/dist/cli/bin.js.map +1 -0
- package/dist/cli/index.d.ts +2 -0
- package/dist/cli/index.d.ts.map +1 -0
- package/dist/cli/index.js +612 -0
- package/dist/cli/index.js.map +1 -0
- package/dist/cli/main.d.ts +2 -0
- package/dist/cli/main.d.ts.map +1 -0
- package/dist/cli/main.js +2 -0
- package/dist/cli/main.js.map +1 -0
- package/dist/connectors/index.d.ts +2 -0
- package/dist/connectors/index.d.ts.map +1 -0
- package/dist/connectors/index.js +2 -0
- package/dist/connectors/index.js.map +1 -0
- package/dist/connectors/registry.d.ts +30 -0
- package/dist/connectors/registry.d.ts.map +1 -0
- package/dist/connectors/registry.js +166 -0
- package/dist/connectors/registry.js.map +1 -0
- package/dist/core/cli-types.d.ts +121 -0
- package/dist/core/cli-types.d.ts.map +1 -0
- package/dist/core/cli-types.js +63 -0
- package/dist/core/cli-types.js.map +1 -0
- package/dist/core/index.d.ts +3 -0
- package/dist/core/index.d.ts.map +1 -1
- package/dist/core/index.js +3 -0
- package/dist/core/index.js.map +1 -1
- package/dist/core/paths.d.ts +8 -0
- package/dist/core/paths.d.ts.map +1 -0
- package/dist/core/paths.js +25 -0
- package/dist/core/paths.js.map +1 -0
- package/dist/core/state-store.d.ts +16 -0
- package/dist/core/state-store.d.ts.map +1 -0
- package/dist/core/state-store.js +23 -0
- package/dist/core/state-store.js.map +1 -0
- package/dist/core/types.d.ts +4 -0
- package/dist/core/types.d.ts.map +1 -1
- package/dist/personal-server/index.d.ts +8 -0
- package/dist/personal-server/index.d.ts.map +1 -0
- package/dist/personal-server/index.js +76 -0
- package/dist/personal-server/index.js.map +1 -0
- package/dist/react/useVanaData.d.ts +1 -1
- package/dist/react/useVanaData.d.ts.map +1 -1
- package/dist/react/useVanaData.js +22 -9
- package/dist/react/useVanaData.js.map +1 -1
- package/dist/runtime/core/contracts.d.ts +69 -0
- package/dist/runtime/core/contracts.d.ts.map +1 -0
- package/dist/runtime/core/contracts.js +2 -0
- package/dist/runtime/core/contracts.js.map +1 -0
- package/dist/runtime/core/index.d.ts +2 -0
- package/dist/runtime/core/index.d.ts.map +1 -0
- package/dist/runtime/core/index.js +2 -0
- package/dist/runtime/core/index.js.map +1 -0
- package/dist/runtime/index.d.ts +4 -0
- package/dist/runtime/index.d.ts.map +1 -0
- package/dist/runtime/index.js +3 -0
- package/dist/runtime/index.js.map +1 -0
- package/dist/runtime/managed-playwright.d.ts +33 -0
- package/dist/runtime/managed-playwright.d.ts.map +1 -0
- package/dist/runtime/managed-playwright.js +113 -0
- package/dist/runtime/managed-playwright.js.map +1 -0
- package/dist/runtime/playwright/browser.d.ts +11 -0
- package/dist/runtime/playwright/browser.d.ts.map +1 -0
- package/dist/runtime/playwright/browser.js +208 -0
- package/dist/runtime/playwright/browser.js.map +1 -0
- package/dist/runtime/playwright/in-process-run.d.ts +6 -0
- package/dist/runtime/playwright/in-process-run.d.ts.map +1 -0
- package/dist/runtime/playwright/in-process-run.js +519 -0
- package/dist/runtime/playwright/in-process-run.js.map +1 -0
- package/dist/runtime/playwright/index.d.ts +3 -0
- package/dist/runtime/playwright/index.d.ts.map +1 -0
- package/dist/runtime/playwright/index.js +3 -0
- package/dist/runtime/playwright/index.js.map +1 -0
- package/dist/runtime/repo-paths.d.ts +2 -0
- package/dist/runtime/repo-paths.d.ts.map +1 -0
- package/dist/runtime/repo-paths.js +36 -0
- package/dist/runtime/repo-paths.js.map +1 -0
- package/dist/server/config.d.ts +2 -0
- package/dist/server/config.d.ts.map +1 -1
- package/dist/server/config.js +1 -0
- package/dist/server/config.js.map +1 -1
- package/dist/server/connect.d.ts.map +1 -1
- package/dist/server/connect.js +7 -0
- package/dist/server/connect.js.map +1 -1
- package/package.json +35 -4
package/README.md
CHANGED
|
@@ -72,6 +72,106 @@ Then, in your dev version of DataConnect (likely built from the `main` branch) y
|
|
|
72
72
|
|
|
73
73
|
If you prefer to integrate the SDK into an existing project, follow the steps below.
|
|
74
74
|
|
|
75
|
+
## Headless CLI
|
|
76
|
+
|
|
77
|
+
`vana-connect` now also ships a local collection CLI for connector setup and data export flows.
|
|
78
|
+
|
|
79
|
+
### Install
|
|
80
|
+
|
|
81
|
+
If you are evaluating this branch before it lands on `main`, use the prerelease path in the next section. The stable install commands below are the intended post-merge install path.
|
|
82
|
+
|
|
83
|
+
macOS and Linux:
|
|
84
|
+
|
|
85
|
+
```bash
|
|
86
|
+
curl -fsSL https://raw.githubusercontent.com/vana-com/vana-connect/main/install/install.sh | sh
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
Windows PowerShell:
|
|
90
|
+
|
|
91
|
+
```powershell
|
|
92
|
+
iwr https://raw.githubusercontent.com/vana-com/vana-connect/main/install/install.ps1 -useb | iex
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
Both installers fetch the latest GitHub release asset for your platform, verify its checksum, and install `vana` without requiring Node or npm.
|
|
96
|
+
|
|
97
|
+
### Canary / prerelease testing
|
|
98
|
+
|
|
99
|
+
If you are testing an unreleased branch build, install from the branch installer and pass the prerelease tag explicitly.
|
|
100
|
+
|
|
101
|
+
macOS and Linux:
|
|
102
|
+
|
|
103
|
+
```bash
|
|
104
|
+
curl -fsSL https://raw.githubusercontent.com/vana-com/vana-connect/feat/connect-cli-v1/install/install.sh | sh -s -- --version canary-feat-connect-cli-v1
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
Windows PowerShell:
|
|
108
|
+
|
|
109
|
+
```powershell
|
|
110
|
+
& ([scriptblock]::Create((iwr https://raw.githubusercontent.com/vana-com/vana-connect/feat/connect-cli-v1/install/install.ps1 -useb).Content)) --version canary-feat-connect-cli-v1
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
The current hosted prerelease is:
|
|
114
|
+
|
|
115
|
+
`canary-feat-connect-cli-v1`
|
|
116
|
+
|
|
117
|
+
Release page:
|
|
118
|
+
|
|
119
|
+
`https://github.com/vana-com/vana-connect/releases/tag/canary-feat-connect-cli-v1`
|
|
120
|
+
|
|
121
|
+
If you want the npm package path as a fallback:
|
|
122
|
+
|
|
123
|
+
```bash
|
|
124
|
+
npx -y @opendatalabs/connect status
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
### Commands
|
|
128
|
+
|
|
129
|
+
```bash
|
|
130
|
+
vana sources
|
|
131
|
+
vana connect github
|
|
132
|
+
vana status
|
|
133
|
+
vana setup
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
### Local development
|
|
137
|
+
|
|
138
|
+
From this repo:
|
|
139
|
+
|
|
140
|
+
```bash
|
|
141
|
+
pnpm install
|
|
142
|
+
pnpm build
|
|
143
|
+
node dist/cli/bin.js status
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
The CLI installs its local browser runtime under `~/.dataconnect/`.
|
|
147
|
+
That runtime is bundled from `vana-connect` itself, so `vana setup` does not require a separate `data-connect` checkout.
|
|
148
|
+
|
|
149
|
+
To build a standalone launcher plus app payload locally:
|
|
150
|
+
|
|
151
|
+
```bash
|
|
152
|
+
pnpm build
|
|
153
|
+
pnpm build:sea
|
|
154
|
+
./artifacts/sea/vana-linux-x64/vana status --json
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
`pnpm build:sea` uses Node 25's `--build-sea` flow to create a small `vana` launcher and packages the real app payload next to it under `app/`.
|
|
158
|
+
It produces a platform-specific release directory plus a release archive and matching checksum file under `artifacts/sea/`.
|
|
159
|
+
|
|
160
|
+
### Programmatic runtime access
|
|
161
|
+
|
|
162
|
+
If you are building an app surface like DataConnect Desktop or a hosted orchestration layer, use the SDK modules instead of shelling out to the CLI where possible.
|
|
163
|
+
|
|
164
|
+
```ts
|
|
165
|
+
import { ManagedPlaywrightRuntime } from "@opendatalabs/connect/runtime";
|
|
166
|
+
import { listAvailableSources } from "@opendatalabs/connect/connectors";
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
Intended split:
|
|
170
|
+
|
|
171
|
+
- app surfaces consume SDK/runtime APIs
|
|
172
|
+
- agent skills consume the CLI
|
|
173
|
+
- `data-connectors` remains the connector and schema source of truth
|
|
174
|
+
|
|
75
175
|
### Installation
|
|
76
176
|
|
|
77
177
|
```bash
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"bin.d.ts","sourceRoot":"","sources":["../../src/cli/bin.ts"],"names":[],"mappings":""}
|
package/dist/cli/bin.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"bin.js","sourceRoot":"","sources":["../../src/cli/bin.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEpC,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAC5C,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;IACjC,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;AAC9B,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/cli/index.ts"],"names":[],"mappings":"AAmDA,wBAAsB,MAAM,CAAC,IAAI,WAAe,GAAG,OAAO,CAAC,MAAM,CAAC,CA2CjE"}
|