shiplightai 0.1.102 → 0.1.104

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/CHANGELOG.md CHANGED
@@ -2,6 +2,32 @@
2
2
 
3
3
  All notable changes to `shiplightai` are documented here. This file is generated automatically at release time from the commits that touch the published package and its bundled SDK.
4
4
 
5
+ ## 0.1.104 (2026-09-08)
6
+
7
+ ### Other Changes
8
+
9
+ - Pin @shiplightai/devtools-assets exactly, and guard the pin (83bdf30)
10
+ - Initial commit (de28541)
11
+
12
+ ## 0.1.103 (2026-09-02)
13
+
14
+ ### Features
15
+
16
+ - **telemetry:** add CLI command telemetry, share one client with the MCP server (bc3ba52)
17
+ - **cli:** replace login/logout with setup-api-token, retire legacy proxy hosts (4460953)
18
+
19
+ ### Bug Fixes
20
+
21
+ - **telemetry:** name both opt-out switches in the first-run notice (5344464)
22
+ - **telemetry:** track setup-api-token, not the retired login/logout (df97829)
23
+ - **cli:** unify URL self-healing policy (0f8333c)
24
+ - **cli:** disable self-healing for URL navigation (86fe8d5)
25
+
26
+ ### Other Changes
27
+
28
+ - **telemetry:** split the two opt-out switches, unexport the collector constants (a52c8cf)
29
+ - rebuild workspace dependencies before package-level test and typecheck (9ada4a3)
30
+
5
31
  ## 0.1.102 (2026-08-27)
6
32
 
7
33
  ### Features
@@ -61,9 +87,9 @@ All notable changes to `shiplightai` are documented here. This file is generated
61
87
  - **cli:** drop nine dependencies with no import site (d5440ea)
62
88
  - **types:** remove five modules no consumer imports (f0fe08b)
63
89
  - **cli:** fold the yaml-transpiler into apps/cli, drop shiplight-tools (efe2c8c)
64
- - extract the debugger UI into packages/debugger-ui, drop @loggia/common (995da96)
90
+ - extract the debugger UI into packages/debugger-ui, drop the internal shared package (995da96)
65
91
  - remove the unreachable export surface from shiplight-tools (c923356)
66
- - remove the v1 Loggia cloud workspaces (e033cef)
92
+ - remove the retired hosted-product workspaces (e033cef)
67
93
 
68
94
  ## 0.1.99 (2026-08-10)
69
95
 
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Shiplight
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -11,8 +11,9 @@ Scaffold a new test project in under a minute:
11
11
  ```bash
12
12
  npx shiplightai@latest create ./my-tests
13
13
  cd my-tests
14
- cp .env.example .env # then set one of GOOGLE_API_KEY, ANTHROPIC_API_KEY, OPENAI_API_KEY
14
+ cp .env.example .env # configure credentials after install
15
15
  npm install
16
+ npx shiplight setup-api-token # writes SHIPLIGHT_API_TOKEN; skip if using a provider key
16
17
  npx playwright install chromium
17
18
  npx shiplight test # runs the scaffolded starter test
18
19
  ```
@@ -29,14 +30,15 @@ npm install shiplightai
29
30
 
30
31
  Every command is invoked via `npx shiplight <command>` from inside a project that has `shiplightai` installed.
31
32
 
32
- | Command | Purpose |
33
- |---|---|
34
- | `shiplight create <path>` | Scaffold a new test project |
35
- | `shiplight test [args]` | Run your YAML and Playwright test suite (forwards all Playwright flags) |
36
- | `shiplight debug <file>` | Launch the interactive visual debugger for a YAML test. The server picks a free port automatically; the chosen URL is printed on startup. Pass `--port N` for a stable URL (CI, bookmarks). Multiple concurrent `shiplight debug` invocations work without any port coordination. |
37
- | `shiplight report [folder]` | Regenerate or merge HTML reports |
38
- | `shiplight transpile [glob]` | Transpile YAML tests to `.yaml.spec.ts` (usually automatic). `--strict` fails while statements are still unenriched drafts (no captured `action`/`js`) |
39
- | `shiplight spec <topic>` | Print an authoring reference: `yaml` (the test language spec) or `actions` (every action and its parameters) |
33
+ | Command | Purpose |
34
+ | ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
35
+ | `shiplight setup-api-token` | Authenticate with Shiplight and write `SHIPLIGHT_API_TOKEN` to the current project's `.env` |
36
+ | `shiplight create <path>` | Scaffold a new test project |
37
+ | `shiplight test [args]` | Run your YAML and Playwright test suite (forwards all Playwright flags) |
38
+ | `shiplight debug <file>` | Launch the interactive visual debugger for a YAML test. The server picks a free port automatically; the chosen URL is printed on startup. Pass `--port N` for a stable URL (CI, bookmarks). Multiple concurrent `shiplight debug` invocations work without any port coordination. |
39
+ | `shiplight report [folder]` | Regenerate or merge HTML reports |
40
+ | `shiplight transpile [glob]` | Transpile YAML tests to `.yaml.spec.ts` (usually automatic). `--strict` fails while statements are still unenriched drafts (no captured `action`/`js`) |
41
+ | `shiplight spec <topic>` | Print an authoring reference: `yaml` (the test language spec) or `actions` (every action and its parameters) |
40
42
 
41
43
  Full reference with flags, options, and troubleshooting: **[docs.shiplight.ai/local/cli-reference](https://docs.shiplight.ai/local/cli-reference)**.
42
44
 
@@ -99,9 +101,12 @@ For the YAML statement language, authentication, variables, templates, and custo
99
101
 
100
102
  ## Environment variables
101
103
 
102
- Set at least one LLM provider API key in `.env` before running tests:
104
+ Run `npx shiplight setup-api-token` to configure Shiplight's LLM proxy, or set
105
+ at least one provider API key in `.env` before running tests:
103
106
 
104
107
  ```
108
+ SHIPLIGHT_API_TOKEN=...
109
+ # or
105
110
  GOOGLE_API_KEY=...
106
111
  # or ANTHROPIC_API_KEY=sk-ant-...
107
112
  # or OPENAI_API_KEY=sk-...
@@ -111,6 +116,23 @@ The AI model is auto-selected from the first key set. Override with `WEB_AGENT_M
111
116
 
112
117
  Shiplight uses an **explicit env var allowlist**: only the vars it forwards into its internal SDK config are accessible to the agent. Any env var not on the list is invisible to the SDK by design. Full list (`OPENAI_BASE_URL`, Vertex AI routing, Mailgun keys, etc.): **[docs.shiplight.ai/local/cli-reference#environment-variables](https://docs.shiplight.ai/local/cli-reference)**.
113
118
 
119
+ ## Telemetry
120
+
121
+ The CLI sends one anonymous event per invocation: the subcommand name (`test`,
122
+ `debug`, …), the CLI version, your OS, CPU architecture, Node version, and
123
+ whether the run looks like CI. Nothing else — no arguments, file paths, URLs,
124
+ test content, or account data. Commands we do not ship are reported as
125
+ `unknown` rather than by name, so a mistyped path never leaves your machine.
126
+ Runs are grouped by a one-way SHA-256 hash of host, user, platform and
127
+ architecture; the inputs to that hash are never transmitted.
128
+
129
+ Opt out with either:
130
+
131
+ ```
132
+ SHIPLIGHT_TELEMETRY=0
133
+ DO_NOT_TRACK=1
134
+ ```
135
+
114
136
  ## Requirements
115
137
 
116
138
  - **Node.js >= 22**