@basein/runner 0.1.0 → 0.2.0

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
@@ -51,11 +51,18 @@ byte-for-byte.
51
51
 
52
52
  ```bash
53
53
  export BIR_AUTH_URL=https://your-basein-service # required to record anything
54
- bir login # once
54
+ bir login # once; approve it in the browser
55
55
  bir-hooks # leave running; Ctrl-C to stop
56
56
  claude # your session, now recorded
57
57
  ```
58
58
 
59
+ `bir login` prints a link and a short code and waits for you to approve it in
60
+ the browser — the OAuth device grant, the same shape `gh auth login` uses. It
61
+ never handles a password, so it works for accounts that only sign in with
62
+ Google, and the link can be opened on any device, which is what makes it usable
63
+ on a headless runner. `--no-browser` prints the link without opening one;
64
+ `--password` is the deprecated email-and-password prompt, removed next release.
65
+
59
66
  Check it:
60
67
 
61
68
  ```bash
@@ -174,7 +181,7 @@ instead.
174
181
 
175
182
  | Variable | Effect |
176
183
  |---|---|
177
- | `BIR_AUTH_URL` | BaseIn auth-service. **Unset means nothing is recorded** — everything else still works. |
184
+ | `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
185
  | `BIR_AUTH_DISABLE=1` | Skip authentication (local dev / CI). |
179
186
  | `BIR_CONTROL_PORT` | Preferred control-server port (default 53411). |
180
187
  | `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. |
@@ -1,21 +1,35 @@
1
1
  /**
2
- * auth client — ported from RRepeat's `src/auth/client.ts` (Phase 4.1).
2
+ * auth client — the CLI's session with the BaseIn service.
3
3
  *
4
- * Authenticates the CLI user against the BaseIn auth-service and returns a JWT
5
- * session. Every recording call carries that access token; the recording's owner
6
- * is the JWT subject on the server side, which is what makes tenancy work
7
- * without BaseInstRunner knowing anything about it.
4
+ * Every recording call carries an access token; the recording's owner is the
5
+ * JWT subject on the server side, which is what makes tenancy work without
6
+ * BaseInstRunner knowing anything about it.
7
+ *
8
+ * TWO HALVES, AND ONLY ONE OF THEM MAY PROMPT.
9
+ *
10
+ * `authenticate()` is the silent half, and every process calls it — `bir-hooks`
11
+ * at startup, each `bir-proxy`, and the CLI:
8
12
  *
9
- * Flow:
10
13
  * 1. Load the cached session from ~/.baseinstrunner/credentials.json.
11
14
  * 2. If the access token is still valid, reuse it.
12
15
  * 3. Else if a refresh token is present, POST /auth/refresh (silent).
13
- * 4. Else prompt for email + password and POST /auth/login.
14
- * 5. Persist the result (mode 0600) and return it.
16
+ * 4. Else give up and return undefined.
17
+ *
18
+ * It used to have a fifth step — prompt for a password — and that had to go
19
+ * when sign-in moved to the browser. A device flow prints a code and waits up
20
+ * to ten minutes for someone to approve it in a browser; a control server doing
21
+ * that at startup, possibly under a supervisor where nobody can see the code,
22
+ * would hang instead of degrading. So interaction lives in `deviceLogin()`,
23
+ * which only `bir login` calls.
15
24
  *
16
- * WHY IT NEVER `process.exit`s: `bir-proxy` runs inside the host's process tree.
17
- * Failing to authenticate must degrade to not-recording (§10), not kill a server
18
- * the host is waiting on. Callers get `undefined` and decide.
25
+ * `deviceLogin()` is the interactive half: the OAuth 2.0 device authorization
26
+ * grant (RFC 8628). It mints a code, prints a link, and polls until the person
27
+ * approves in the console. It never handles a password, which is what makes it
28
+ * work for Google-only accounts — they have no password to type.
29
+ *
30
+ * WHY NOTHING HERE `process.exit`s: `bir-proxy` runs inside the host's process
31
+ * tree. Failing to authenticate must degrade to not-recording (§10), not kill a
32
+ * server the host is waiting on. Callers get `undefined` and decide.
19
33
  *
20
34
  * Config:
21
35
  * BIR_AUTH_URL base URL of the BaseIn auth-service (required).
@@ -36,8 +50,13 @@ export interface AuthSession {
36
50
  export interface AuthenticateOptions {
37
51
  /** Base URL of the auth service. Defaults to BIR_AUTH_URL. */
38
52
  authUrl?: string;
39
- /** Never prompt: fail (return undefined) if no valid/refreshable session exists. */
40
- nonInteractive?: boolean;
53
+ }
54
+ interface AuthResponse {
55
+ accessToken: string;
56
+ refreshToken: string;
57
+ /** Access token lifetime in seconds. */
58
+ expiresIn: number;
59
+ user: AuthUser;
41
60
  }
42
61
  /**
43
62
  * Where the cached session lives.
@@ -77,9 +96,129 @@ export declare function resolveAuthUrl(opts?: AuthenticateOptions): string;
77
96
  * configure is worse than failing.
78
97
  */
79
98
  export declare function normalizeAuthUrl(baseUrl: string, fetchImpl?: typeof fetch): Promise<string>;
99
+ /**
100
+ * The hint printed whenever `BIR_AUTH_URL` turns out not to be the API. Kept in
101
+ * one place so `bir login`, `bir doctor` and the interactive prompt agree.
102
+ */
103
+ export declare const AUTH_URL_HINT: string;
104
+ /**
105
+ * Is there a BaseIn service at `baseUrl`? Returns `undefined` when there is,
106
+ * else one line saying what answered instead.
107
+ *
108
+ * WHY THIS EXISTS. Pointing `BIR_AUTH_URL` at the *website* instead of the API
109
+ * (`https://example.com` is the docs, `https://api.example.com` the service) is
110
+ * the easiest mistake to make and the hardest to read back: the static site
111
+ * answers `GET /health` with 200 and a page, so nothing objects until the
112
+ * password has already been POSTed to it and it says `405 Method Not Allowed`
113
+ * — a message about HTTP verbs, for a problem about hosts. Observed on a first
114
+ * sign-in; the user tried the app URL next and got a redirect.
115
+ *
116
+ * So, before anyone types a password: expect the health endpoint to answer
117
+ * with JSON. A website answers with HTML; a wrong port answers with nothing.
118
+ * The check is deliberately loose about the body — deployments differ — and
119
+ * strict about the content type, which is what separates a service from a page.
120
+ */
121
+ export declare function describeAuthService(baseUrl: string, fetchImpl?: typeof fetch): Promise<string | undefined>;
80
122
  /**
81
123
  * Authenticate and return a valid session, or `undefined` when none can be
82
124
  * obtained. Callers degrade to not-recording rather than failing the session.
83
125
  */
84
126
  export declare function authenticate(opts?: AuthenticateOptions): Promise<AuthSession | undefined>;
127
+ /**
128
+ * The service has no device endpoints — it predates browser sign-in.
129
+ *
130
+ * Thrown so `bir login` can fall back to the password flow rather than leaving
131
+ * someone stranded on a runner that is newer than the service it talks to.
132
+ */
133
+ export declare class DeviceFlowUnsupported extends Error {
134
+ constructor();
135
+ }
136
+ /** The CLI's view of a started device authorization. */
137
+ export interface DeviceCodeGrant {
138
+ deviceCode: string;
139
+ userCode: string;
140
+ verificationUri: string;
141
+ verificationUriComplete?: string;
142
+ expiresIn: number;
143
+ interval: number;
144
+ }
145
+ /**
146
+ * Start a sign-in. Returns the codes; the caller shows one and polls with the
147
+ * other.
148
+ *
149
+ * `clientName`/`clientVersion` are shown on the approval page so the person can
150
+ * tell their own `bir login` from somebody else's — the one defence a device
151
+ * flow has against being talked into approving a stranger's code.
152
+ */
153
+ export declare function startDeviceCode(authUrl: string, client: {
154
+ name?: string;
155
+ version?: string;
156
+ }, fetchImpl?: typeof fetch): Promise<DeviceCodeGrant>;
157
+ /** The user gave up, or the code died before anyone approved it. */
158
+ export declare class DeviceFlowAborted extends Error {
159
+ readonly reason: "access_denied" | "expired_token" | "timeout" | "cancelled";
160
+ constructor(message: string, reason: "access_denied" | "expired_token" | "timeout" | "cancelled");
161
+ }
162
+ export interface PollOptions {
163
+ interval: number;
164
+ expiresIn: number;
165
+ fetchImpl?: typeof fetch;
166
+ /** Injected so tests run in milliseconds rather than minutes. */
167
+ sleep?: (ms: number) => Promise<void>;
168
+ signal?: AbortSignal;
169
+ now?: () => number;
170
+ }
171
+ /**
172
+ * Poll until the sign-in is approved, refused, or dies.
173
+ *
174
+ * RFC 8628 §3.5's loop, including the part people skip: `slow_down` is not an
175
+ * error, it is the server asking for a longer gap, and the interval must
176
+ * *stay* longer afterwards. Ignoring it turns a slow client into a blocked one.
177
+ */
178
+ export declare function pollDeviceToken(authUrl: string, deviceCode: string, opts: PollOptions): Promise<AuthResponse>;
179
+ /**
180
+ * Open a URL in the user's browser. Best effort, and never fatal.
181
+ *
182
+ * No dependency and no shell: this package ships zero runtime dependencies, and
183
+ * passing a URL through a shell is how a URL becomes a command. The link is
184
+ * printed either way, so a failure here costs nothing.
185
+ */
186
+ export declare function openBrowser(url: string): void;
187
+ export interface DeviceLoginOptions {
188
+ /** `--no-browser`, or a machine where opening one is wrong. */
189
+ openBrowser?: boolean;
190
+ fetchImpl?: typeof fetch;
191
+ sleep?: (ms: number) => Promise<void>;
192
+ signal?: AbortSignal;
193
+ /** Where the human-readable lines go. stderr, so stdout stays parseable. */
194
+ write?: (text: string) => void;
195
+ }
196
+ /**
197
+ * Sign in through the browser and cache the session.
198
+ *
199
+ * Everything a person sees goes to stderr: `bir login`'s stdout is one line
200
+ * that a script may read, and the code block is not it.
201
+ */
202
+ export declare function deviceLogin(authUrl: string, opts?: DeviceLoginOptions): Promise<AuthSession | undefined>;
203
+ /**
204
+ * Sign in with an email and a password.
205
+ *
206
+ * DEPRECATED, and kept for exactly two cases: `bir login --password`, and a
207
+ * runner talking to a service that predates the device endpoints. Both go in
208
+ * the release after this one, and this function goes with them.
209
+ *
210
+ * It cannot work at all for an account created through Google — there is no
211
+ * password on it to send — which is the main reason sign-in moved.
212
+ */
213
+ export declare function legacyPasswordLogin(authUrl: string): Promise<AuthSession | undefined>;
214
+ /**
215
+ * Sign out: revoke the refresh token server-side, then forget it locally.
216
+ *
217
+ * Deleting the file alone left the token live for its full 30 days, which made
218
+ * `bir logout` a tidy-up rather than a revocation. The endpoint is idempotent
219
+ * and its failure is not worth blocking on — the local half must happen either
220
+ * way, or "logged out" would be a lie on a machine with no network.
221
+ */
222
+ export declare function logout(authUrl?: string): Promise<void>;
223
+ export {};
85
224
  //# sourceMappingURL=client.d.ts.map