@basein/runner 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/LICENSE CHANGED
@@ -1,201 +1,201 @@
1
- Apache License
2
- Version 2.0, January 2004
3
- http://www.apache.org/licenses/
4
-
5
- TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
-
7
- 1. Definitions.
8
-
9
- "License" shall mean the terms and conditions for use, reproduction,
10
- and distribution as defined by Sections 1 through 9 of this document.
11
-
12
- "Licensor" shall mean the copyright owner or entity authorized by
13
- the copyright owner that is granting the License.
14
-
15
- "Legal Entity" shall mean the union of the acting entity and all
16
- other entities that control, are controlled by, or are under common
17
- control with that entity. For the purposes of this definition,
18
- "control" means (i) the power, direct or indirect, to cause the
19
- direction or management of such entity, whether by contract or
20
- otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
- outstanding shares, or (iii) beneficial ownership of such entity.
22
-
23
- "You" (or "Your") shall mean an individual or Legal Entity
24
- exercising permissions granted by this License.
25
-
26
- "Source" form shall mean the preferred form for making modifications,
27
- including but not limited to software source code, documentation
28
- source, and configuration files.
29
-
30
- "Object" form shall mean any form resulting from mechanical
31
- transformation or translation of a Source form, including but
32
- not limited to compiled object code, generated documentation,
33
- and conversions to other media types.
34
-
35
- "Work" shall mean the work of authorship, whether in Source or
36
- Object form, made available under the License, as indicated by a
37
- copyright notice that is included in or attached to the work
38
- (an example is provided in the Appendix below).
39
-
40
- "Derivative Works" shall mean any work, whether in Source or Object
41
- form, that is based on (or derived from) the Work and for which the
42
- editorial revisions, annotations, elaborations, or other modifications
43
- represent, as a whole, an original work of authorship. For the purposes
44
- of this License, Derivative Works shall not include works that remain
45
- separable from, or merely link (or bind by name) to the interfaces of,
46
- the Work and Derivative Works thereof.
47
-
48
- "Contribution" shall mean any work of authorship, including
49
- the original version of the Work and any modifications or additions
50
- to that Work or Derivative Works thereof, that is intentionally
51
- submitted to Licensor for inclusion in the Work by the copyright owner
52
- or by an individual or Legal Entity authorized to submit on behalf of
53
- the copyright owner. For the purposes of this definition, "submitted"
54
- means any form of electronic, verbal, or written communication sent
55
- to the Licensor or its representatives, including but not limited to
56
- communication on electronic mailing lists, source code control systems,
57
- and issue tracking systems that are managed by, or on behalf of, the
58
- Licensor for the purpose of discussing and improving the Work, but
59
- excluding communication that is conspicuously marked or otherwise
60
- designated in writing by the copyright owner as "Not a Contribution."
61
-
62
- "Contributor" shall mean Licensor and any individual or Legal Entity
63
- on behalf of whom a Contribution has been received by Licensor and
64
- subsequently incorporated within the Work.
65
-
66
- 2. Grant of Copyright License. Subject to the terms and conditions of
67
- this License, each Contributor hereby grants to You a perpetual,
68
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
- copyright license to reproduce, prepare Derivative Works of,
70
- publicly display, publicly perform, sublicense, and distribute the
71
- Work and such Derivative Works in Source or Object form.
72
-
73
- 3. Grant of Patent License. Subject to the terms and conditions of
74
- this License, each Contributor hereby grants to You a perpetual,
75
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
- (except as stated in this section) patent license to make, have made,
77
- use, offer to sell, sell, import, and otherwise transfer the Work,
78
- where such license applies only to those patent claims licensable
79
- by such Contributor that are necessarily infringed by their
80
- Contribution(s) alone or by combination of their Contribution(s)
81
- with the Work to which such Contribution(s) was submitted. If You
82
- institute patent litigation against any entity (including a
83
- cross-claim or counterclaim in a lawsuit) alleging that the Work
84
- or a Contribution incorporated within the Work constitutes direct
85
- or contributory patent infringement, then any patent licenses
86
- granted to You under this License for that Work shall terminate
87
- as of the date such litigation is filed.
88
-
89
- 4. Redistribution. You may reproduce and distribute copies of the
90
- Work or Derivative Works thereof in any medium, with or without
91
- modifications, and in Source or Object form, provided that You
92
- meet the following conditions:
93
-
94
- (a) You must give any other recipients of the Work or
95
- Derivative Works a copy of this License; and
96
-
97
- (b) You must cause any modified files to carry prominent notices
98
- stating that You changed the files; and
99
-
100
- (c) You must retain, in the Source form of any Derivative Works
101
- that You distribute, all copyright, patent, trademark, and
102
- attribution notices from the Source form of the Work,
103
- excluding those notices that do not pertain to any part of
104
- the Derivative Works; and
105
-
106
- (d) If the Work includes a "NOTICE" text file as part of its
107
- distribution, then any Derivative Works that You distribute must
108
- include a readable copy of the attribution notices contained
109
- within such NOTICE file, excluding those notices that do not
110
- pertain to any part of the Derivative Works, in at least one
111
- of the following places: within a NOTICE text file distributed
112
- as part of the Derivative Works; within the Source form or
113
- documentation, if provided along with the Derivative Works; or,
114
- within a display generated by the Derivative Works, if and
115
- wherever such third-party notices normally appear. The contents
116
- of the NOTICE file are for informational purposes only and
117
- do not modify the License. You may add Your own attribution
118
- notices within Derivative Works that You distribute, alongside
119
- or as an addendum to the NOTICE text from the Work, provided
120
- that such additional attribution notices cannot be construed
121
- as modifying the License.
122
-
123
- You may add Your own copyright statement to Your modifications and
124
- may provide additional or different license terms and conditions
125
- for use, reproduction, or distribution of Your modifications, or
126
- for any such Derivative Works as a whole, provided Your use,
127
- reproduction, and distribution of the Work otherwise complies with
128
- the conditions stated in this License.
129
-
130
- 5. Submission of Contributions. Unless You explicitly state otherwise,
131
- any Contribution intentionally submitted for inclusion in the Work
132
- by You to the Licensor shall be under the terms and conditions of
133
- this License, without any additional terms or conditions.
134
- Notwithstanding the above, nothing herein shall supersede or modify
135
- the terms of any separate license agreement you may have executed
136
- with Licensor regarding such Contributions.
137
-
138
- 6. Trademarks. This License does not grant permission to use the trade
139
- names, trademarks, service marks, or product names of the Licensor,
140
- except as required for reasonable and customary use in describing the
141
- origin of the Work and reproducing the content of the NOTICE file.
142
-
143
- 7. Disclaimer of Warranty. Unless required by applicable law or
144
- agreed to in writing, Licensor provides the Work (and each
145
- Contributor provides its Contributions) on an "AS IS" BASIS,
146
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
- implied, including, without limitation, any warranties or conditions
148
- of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
- PARTICULAR PURPOSE. You are solely responsible for determining the
150
- appropriateness of using or redistributing the Work and assume any
151
- risks associated with Your exercise of permissions under this License.
152
-
153
- 8. Limitation of Liability. In no event and under no legal theory,
154
- whether in tort (including negligence), contract, or otherwise,
155
- unless required by applicable law (such as deliberate and grossly
156
- negligent acts) or agreed to in writing, shall any Contributor be
157
- liable to You for damages, including any direct, indirect, special,
158
- incidental, or consequential damages of any character arising as a
159
- result of this License or out of the use or inability to use the
160
- Work (including but not limited to damages for loss of goodwill,
161
- work stoppage, computer failure or malfunction, or any and all
162
- other commercial damages or losses), even if such Contributor
163
- has been advised of the possibility of such damages.
164
-
165
- 9. Accepting Warranty or Additional Liability. While redistributing
166
- the Work or Derivative Works thereof, You may choose to offer,
167
- and charge a fee for, acceptance of support, warranty, indemnity,
168
- or other liability obligations and/or rights consistent with this
169
- License. However, in accepting such obligations, You may act only
170
- on Your own behalf and on Your sole responsibility, not on behalf
171
- of any other Contributor, and only if You agree to indemnify,
172
- defend, and hold each Contributor harmless for any liability
173
- incurred by, or claims asserted against, such Contributor by reason
174
- of your accepting any such warranty or additional liability.
175
-
176
- END OF TERMS AND CONDITIONS
177
-
178
- APPENDIX: How to apply the Apache License to your work.
179
-
180
- To apply the Apache License to your work, attach the following
181
- boilerplate notice, with the fields enclosed by brackets "[]"
182
- replaced with your own identifying information. (Don't include
183
- the brackets!) The text should be enclosed in the appropriate
184
- comment syntax for the file format. We also recommend that a
185
- file or class name and description of purpose be included on the
186
- same "printed page" as the copyright notice for easier
187
- identification within third-party archives.
188
-
189
- Copyright [yyyy] [name of copyright owner]
190
-
191
- Licensed under the Apache License, Version 2.0 (the "License");
192
- you may not use this file except in compliance with the License.
193
- You may obtain a copy of the License at
194
-
195
- http://www.apache.org/licenses/LICENSE-2.0
196
-
197
- Unless required by applicable law or agreed to in writing, software
198
- distributed under the License is distributed on an "AS IS" BASIS,
199
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
- See the License for the specific language governing permissions and
201
- limitations under the License.
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/README.md CHANGED
@@ -174,7 +174,7 @@ instead.
174
174
 
175
175
  | Variable | Effect |
176
176
  |---|---|
177
- | `BIR_AUTH_URL` | BaseIn auth-service. **Unset means nothing is recorded** — everything else still works. |
177
+ | `BIR_AUTH_URL` | BaseIn auth-service — the **API** address (normally `https://api.<your-domain>`), not the docs or app website. **Unset means nothing is recorded** — everything else still works. |
178
178
  | `BIR_AUTH_DISABLE=1` | Skip authentication (local dev / CI). |
179
179
  | `BIR_CONTROL_PORT` | Preferred control-server port (default 53411). |
180
180
  | `BIR_CONTROL_URL` / `BIR_CONTROL_TOKEN` | Point a proxy at a control server directly, bypassing discovery. Injected into generated config; the only reliable channel for an SDK session. |
@@ -77,6 +77,29 @@ export declare function resolveAuthUrl(opts?: AuthenticateOptions): string;
77
77
  * configure is worse than failing.
78
78
  */
79
79
  export declare function normalizeAuthUrl(baseUrl: string, fetchImpl?: typeof fetch): Promise<string>;
80
+ /**
81
+ * The hint printed whenever `BIR_AUTH_URL` turns out not to be the API. Kept in
82
+ * one place so `bir login`, `bir doctor` and the interactive prompt agree.
83
+ */
84
+ export declare const AUTH_URL_HINT: string;
85
+ /**
86
+ * Is there a BaseIn service at `baseUrl`? Returns `undefined` when there is,
87
+ * else one line saying what answered instead.
88
+ *
89
+ * WHY THIS EXISTS. Pointing `BIR_AUTH_URL` at the *website* instead of the API
90
+ * (`https://example.com` is the docs, `https://api.example.com` the service) is
91
+ * the easiest mistake to make and the hardest to read back: the static site
92
+ * answers `GET /health` with 200 and a page, so nothing objects until the
93
+ * password has already been POSTed to it and it says `405 Method Not Allowed`
94
+ * — a message about HTTP verbs, for a problem about hosts. Observed on a first
95
+ * sign-in; the user tried the app URL next and got a redirect.
96
+ *
97
+ * So, before anyone types a password: expect the health endpoint to answer
98
+ * with JSON. A website answers with HTML; a wrong port answers with nothing.
99
+ * The check is deliberately loose about the body — deployments differ — and
100
+ * strict about the content type, which is what separates a service from a page.
101
+ */
102
+ export declare function describeAuthService(baseUrl: string, fetchImpl?: typeof fetch): Promise<string | undefined>;
80
103
  /**
81
104
  * Authenticate and return a valid session, or `undefined` when none can be
82
105
  * obtained. Callers degrade to not-recording rather than failing the session.
@@ -159,6 +159,65 @@ export async function normalizeAuthUrl(baseUrl, fetchImpl = fetch) {
159
159
  });
160
160
  return base;
161
161
  }
162
+ /** How long the pre-flight `/health` probe may take. It is one small GET. */
163
+ const PROBE_TIMEOUT_MS = 5_000;
164
+ /**
165
+ * The hint printed whenever `BIR_AUTH_URL` turns out not to be the API. Kept in
166
+ * one place so `bir login`, `bir doctor` and the interactive prompt agree.
167
+ */
168
+ export const AUTH_URL_HINT = "BIR_AUTH_URL must be the BaseIn API address (for example https://api.example.com), " +
169
+ "not the documentation or app website. Set it, then open a fresh terminal — " +
170
+ "an existing one keeps the value it started with";
171
+ function causeText(err) {
172
+ const cause = err?.cause;
173
+ return cause?.code ?? cause?.message ?? errText(err);
174
+ }
175
+ /**
176
+ * Is there a BaseIn service at `baseUrl`? Returns `undefined` when there is,
177
+ * else one line saying what answered instead.
178
+ *
179
+ * WHY THIS EXISTS. Pointing `BIR_AUTH_URL` at the *website* instead of the API
180
+ * (`https://example.com` is the docs, `https://api.example.com` the service) is
181
+ * the easiest mistake to make and the hardest to read back: the static site
182
+ * answers `GET /health` with 200 and a page, so nothing objects until the
183
+ * password has already been POSTed to it and it says `405 Method Not Allowed`
184
+ * — a message about HTTP verbs, for a problem about hosts. Observed on a first
185
+ * sign-in; the user tried the app URL next and got a redirect.
186
+ *
187
+ * So, before anyone types a password: expect the health endpoint to answer
188
+ * with JSON. A website answers with HTML; a wrong port answers with nothing.
189
+ * The check is deliberately loose about the body — deployments differ — and
190
+ * strict about the content type, which is what separates a service from a page.
191
+ */
192
+ export async function describeAuthService(baseUrl, fetchImpl = fetch) {
193
+ const base = baseUrl.replace(/\/+$/, "");
194
+ if (!base)
195
+ return "no URL configured";
196
+ let res;
197
+ try {
198
+ res = await fetchImpl(`${base}/health`, {
199
+ method: "GET",
200
+ headers: { accept: "application/json" },
201
+ redirect: "manual",
202
+ signal: AbortSignal.timeout(PROBE_TIMEOUT_MS),
203
+ });
204
+ }
205
+ catch (err) {
206
+ return `unreachable (${causeText(err)})`;
207
+ }
208
+ if (res.status >= 300 && res.status < 400) {
209
+ return `redirects to ${res.headers.get("location") ?? "somewhere else"} — use the final address`;
210
+ }
211
+ const type = (res.headers.get("content-type") ?? "").toLowerCase();
212
+ if (!res.ok) {
213
+ return `GET /health answered HTTP ${res.status}${type.includes("html") ? " with a web page" : ""}`;
214
+ }
215
+ if (!type.includes("json")) {
216
+ const what = type.includes("html") ? "a web page" : type ? `'${type}'` : "no content type";
217
+ return `GET /health answered ${what} instead of JSON — that is a website, not the BaseIn API`;
218
+ }
219
+ return undefined;
220
+ }
162
221
  function prompt(question) {
163
222
  const rl = createInterface({ input: process.stdin, output: process.stderr });
164
223
  return new Promise((resolve) => {
@@ -215,7 +274,13 @@ async function postJson(url, body) {
215
274
  });
216
275
  if (!res.ok) {
217
276
  const text = await res.text().catch(() => "");
218
- throw new Error(`HTTP ${res.status} ${res.statusText}${text ? ` — ${text}` : ""}`);
277
+ const isHtml = (res.headers.get("content-type") ?? "").includes("html") || /^\s*<(!doctype|html)/i.test(text);
278
+ const detail = isHtml
279
+ ? " — the answer was a web page, not JSON: this URL is a website, not the BaseIn API"
280
+ : text
281
+ ? ` — ${text.length > 300 ? `${text.slice(0, 300)}…` : text}`
282
+ : "";
283
+ throw new Error(`HTTP ${res.status} ${res.statusText}${detail}`);
219
284
  }
220
285
  return (await res.json());
221
286
  }
@@ -264,7 +329,14 @@ export async function authenticate(opts) {
264
329
  });
265
330
  return undefined;
266
331
  }
267
- process.stderr.write(`[bir] Sign in to ${authUrl}\n`);
332
+ // Never send a password to something that is not the service. The website
333
+ // answers 405 *after* the credentials have been posted to it; check first.
334
+ const problem = await describeAuthService(authUrl);
335
+ if (problem) {
336
+ logLine("auth.not_a_service", { url: authUrl, problem, why: AUTH_URL_HINT });
337
+ return undefined;
338
+ }
339
+ process.stderr.write(`[bir] Sign in to ${authUrl} (BIR_AUTH_URL)\n`);
268
340
  const email = await prompt("Email: ");
269
341
  const password = await promptPassword("Password: ");
270
342
  if (!email || !password) {
@@ -277,7 +349,7 @@ export async function authenticate(opts) {
277
349
  return session;
278
350
  }
279
351
  catch (err) {
280
- logLine("auth.login_failed", { error: errText(err) });
352
+ logLine("auth.login_failed", { url: `${authUrl}/auth/login`, error: errText(err) });
281
353
  return undefined;
282
354
  }
283
355
  }
package/dist/bin/bir.js CHANGED
@@ -28,7 +28,7 @@ import { isScenarioServer, isWrapped, PACKAGE_NAME, readSidecar, scenarioEntry,
28
28
  import { isRemote, resolveServers } from "../config/resolve.js";
29
29
  import { buildHooksBlock, claudeCodePaths, fileForScope, installHooks, readTextOrNull, setServerEntry, sha256, uninstallHooks, } from "../config/adapters/claude-code.js";
30
30
  import { readGenericServers, setGenericServerEntry } from "../config/adapters/generic.js";
31
- import { clearCredentials, authenticate, resolveAuthUrl, normalizeAuthUrl } from "../auth/client.js";
31
+ import { AUTH_URL_HINT, authenticate, clearCredentials, describeAuthService, normalizeAuthUrl, resolveAuthUrl, } from "../auth/client.js";
32
32
  import { DEFAULT_CONTROL_PORT } from "../control/server.js";
33
33
  import { errText } from "../util/log.js";
34
34
  import { packageVersion } from "../util/version.js";
@@ -538,12 +538,31 @@ async function doctor(args) {
538
538
  notes.push("could not verify recording: no control server to ask, and BIR_AUTH_URL is " +
539
539
  "unset in this shell (which is not where the proxies read it from)");
540
540
  }
541
+ // WHAT *THIS* SHELL WOULD TALK TO. `bir login` and `bir scenario` run here,
542
+ // so this shell's BIR_AUTH_URL is evidence about them, if not about the
543
+ // recorder. The one mistake worth catching is a URL that is a website rather
544
+ // than the API: it answers `GET /health` with a page, so nothing else notices
545
+ // until a password has been posted to it and it says `405`.
546
+ const shellAuthUrl = resolveAuthUrl();
547
+ const shellAuthProblem = shellAuthUrl ? await describeAuthService(shellAuthUrl) : undefined;
548
+ if (shellAuthProblem) {
549
+ problems.push(`BIR_AUTH_URL in this shell (${shellAuthUrl}) is not a BaseIn service: ${shellAuthProblem}. ` +
550
+ `\`bir login\` and \`bir scenario\` here will fail — ${AUTH_URL_HINT}`);
551
+ }
541
552
  const sidecar = readSidecar();
542
553
  if (sidecar.controlPort && discovery && !discovery.url.endsWith(`:${sidecar.controlPort}`)) {
543
554
  problems.push(`hooks were installed for port ${sidecar.controlPort} but the control server is on ${discovery.url}`);
544
555
  }
545
556
  if (args.json) {
546
- out(JSON.stringify({ ok: problems.length === 0, problems, notes, health, wrapped: wantWrapped }, null, 2));
557
+ out(JSON.stringify({
558
+ ok: problems.length === 0,
559
+ problems,
560
+ notes,
561
+ health,
562
+ wrapped: wantWrapped,
563
+ shellAuthUrl: shellAuthUrl || null,
564
+ shellAuthProblem: shellAuthProblem ?? null,
565
+ }, null, 2));
547
566
  return problems.length === 0 ? 0 : 1;
548
567
  }
549
568
  // Replay first, and loudly. It auto-approves tool calls in the session and
@@ -567,6 +586,9 @@ async function doctor(args) {
567
586
  out(`Wrapped in config : ${wantWrapped.join(", ") || "(none)"}`);
568
587
  out(`Registered proxies: ${[...registered].join(", ") || "(none)"}`);
569
588
  out(`Control server : ${discovery?.url ?? "not running"}`);
589
+ out(`BaseIn (shell) : ${shellAuthUrl
590
+ ? `${shellAuthUrl}${shellAuthProblem ? " — NOT a BaseIn service, see below" : " (answers /health)"}`
591
+ : "(BIR_AUTH_URL not set in this shell)"}`);
570
592
  out(`Recording tier : ${discovery && health ? "bound (Tier 1)" : "standalone (Tier 2)"}`);
571
593
  out(`Recording : ${health ? (health.recording === false ? "no — see below" : "yes") : "unknown (no control server to ask)"}`);
572
594
  if (health?.lossy)
@@ -853,10 +875,24 @@ async function main() {
853
875
  case "replay":
854
876
  return replayCommand(args);
855
877
  case "login": {
856
- const session = await authenticate();
878
+ // Settle the URL the way every other command does, then refuse to ask for
879
+ // a password when what is there is not the service. "Signed in" must mean
880
+ // the service at BIR_AUTH_URL accepted these credentials — not that a
881
+ // cached token exists for some other address.
882
+ const configured = resolveAuthUrl();
883
+ const baseUrl = configured ? await normalizeAuthUrl(configured) : "";
884
+ if (baseUrl) {
885
+ const problem = await describeAuthService(baseUrl);
886
+ if (problem) {
887
+ process.stderr.write(`[bir] ${baseUrl} is not a BaseIn service: ${problem}\n`);
888
+ process.stderr.write(`[bir] ${AUTH_URL_HINT}\n`);
889
+ return 1;
890
+ }
891
+ }
892
+ const session = await authenticate(baseUrl ? { authUrl: baseUrl } : undefined);
857
893
  if (!session)
858
894
  return 1;
859
- out(`Signed in as ${session.user.email}.`);
895
+ out(`Signed in to ${baseUrl} as ${session.user.email}.`);
860
896
  return 0;
861
897
  }
862
898
  case "logout":
@@ -130,6 +130,14 @@ The service address did not stick. Close the terminal, open a new one, and check
130
130
  `echo $env:BIR_AUTH_URL` (Windows) or `echo $BIR_AUTH_URL` (macOS). If it is
131
131
  empty, run the install script again with the `-AuthUrl` / `BIR_AUTH_URL` value.
132
132
 
133
+ ### "bir login says … is not a BaseIn service" (or `HTTP 405 Method Not Allowed`)
134
+
135
+ `BIR_AUTH_URL` points at a website — the docs or app address — instead of the
136
+ API. It must be the service address, normally `https://api.<your-domain>`. Fix
137
+ the value, then **open a fresh terminal**: an existing one keeps the value it
138
+ started with, even after the install script or a settings change updates it.
139
+ `bir doctor` prints what the current terminal has on its `BaseIn (shell)` line.
140
+
133
141
  ### "bir is not recognised as a command"
134
142
 
135
143
  The install worked but your terminal has not noticed yet. **Close the terminal
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@basein/runner",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "A recording MCP proxy: sits between any MCP client and its MCP servers, executes each call on the client's behalf, and records the run as a reusable BaseIn scenario.",
5
5
  "type": "module",
6
6
  "license": "MIT",