@rikalabs/akter-cli 0.0.0-stage → 0.1.0-alpha.4

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 ADDED
@@ -0,0 +1,27 @@
1
+ # Changelog
2
+
3
+ ## 0.1.0-alpha.4 (2026-10-09)
4
+
5
+ - **Breaking cloud contract:** every environment uses customer Postgres through `DATABASE_URL`. `Environment.database`, when reported, is `{ source: "customer", state: "missing" | "reachable" | "unreachable", latency, latencyWarning, runnerCap }`. Latency is nullable p50 milliseconds; runner cap is a nullable integer. The managed source and provisioning, ready, read-only and failed states are removed.
6
+ - **Breaking billing contract:** base subscription plus compute unit-hours only. Removes storage allowances, caps, overage prices, meters, samples, per-project storage usage and managed database features. `QuotaExceeded.cap` is now `compute`, `connections` or `spend`; storage is no longer a quota. All types remain derived from Effect schemas at `@rikalabs/akter-cli/cloud-api`.
7
+ - `akter env list` prints names and update times without a `managed` marker. After a deployment reaches `live`, `akter deploy` confirms success and reads the database report, printing its latency warning and non-null runner cap, including zero, only for the completed rollout. A p50 above 5 ms warns without refusing the deployment; unknown measurements stay unknown. Failed or superseded diagnostic reads warn without changing the successful exit status.
8
+ - `akter deploy` keeps following a rollout through a brief control-plane outage. Transport failures, typed `Unavailable` (503) answers without a known `reason` and unreadable 5xx answers such as a proxy's 502 are retried with the delays `logs --follow` uses (1, 2, 4, then 8 seconds), and six consecutive failed reads stop it as before. Refusals, including an ended session, are never retried.
9
+ - The cloud API contract's `Authentication` middleware declares `Unavailable` (503) alongside `Unauthorized` and `Forbidden`, so every endpoint, including `/api/me`, decodes a session-store outage as a typed `Unavailable`. `akter whoami` then reports a temporary outage (exit 1) instead of an unreachable control plane (exit 2), and never asks you to log in again. This is additive for `/cloud-api` consumers; a server may now fail authentication with `Unavailable`.
10
+
11
+ ## 0.1.0-alpha.3 (2026-10-08)
12
+
13
+ The first CLI release, versioned with `@rikalabs/akter` on the `alpha` and `latest` dist-tags. This includes the unpublished alpha.2 draft and the final launch contract.
14
+
15
+ - Publishes as `@rikalabs/akter-cli` with the `akter` executable, compiled ESM and declarations for Node 24+ and Bun 1.4.2+. The inspector client is prebuilt; Node users do not need Bun. The private cloud API contract is bundled, not separately published.
16
+ - Exposes the cloud API contract as `@rikalabs/akter-cli/cloud-api`, with compiled JavaScript and declarations for npm consumers; importing it does not execute the CLI. Tagged pre-1.0 releases also advance `latest`, while verified main canaries publish only to `next`.
17
+ - Includes local `akter dev`, cloud login/logout/whoami, source deployment and `akter env list`, `set`, `unset` and `import`.
18
+ - Uses the matching alpha.3 framework and Effect/platform/SQL 4.0.2 cohort. Postgres and PGlite are the only framework backends; Neki is removed.
19
+ - **Breaking cloud contract:** environment databases report `{ source, state }`, without engine or Neki mode fields. Billing schemas remove command/read allowances and meters and deprecated compatibility fields, using compute unit-hours and pooled managed database storage. Hosted quota refusals use `QuotaExceeded.cap`; the separate spend, connection and storage quota errors are removed, and only a connections-cap refusal is retryable. Update applications importing `/cloud-api` to the new schema.
20
+ - **Breaking:** operator commands read `AKTER_OPERATOR_TOKEN`, not `DURABLE_OPERATOR_TOKEN`. There is no implicit alias; set the new variable or use `--token-env`.
21
+ - **Breaking:** the local inspector page and API use `/_akter/inspector`, not `/_durable/inspector`. Update bookmarks and requests.
22
+ - **Breaking:** hosted source deploys load `src/app.ts` with a generated Dockerfile; the API refuses `source.dockerfile`.
23
+ - Login defaults to `https://api.akter.dev`; select a preview or local API explicitly with `--api-url` or `AKTER_API_URL`.
24
+ - Adds `akter logs` to read customer runner output for a project (`--project`, default `AKTER_PROJECT`) and an environment (`--env`, default `production`) or one `--deployment`. `--since` takes 1 to 3600 seconds (default 300), and the server clamps the requested time into the last hour. `--limit` takes 1 to 200 lines per page (default 100), not a total. Without `--follow` it reads every page in the window and exits; `--follow` drains available pages at once, then long-polls for up to 20 seconds. Follow resumes from the last successful cursor after transport failures and typed `Unavailable` (503) responses, with capped exponential delays, and stops after six failed requests in a row. Authentication, authorization, missing-resource and unsupported-operation refusals are not retried. Ctrl-C cancels the request and exits with code 130. Control characters, Unicode line separators and bidirectional-formatting characters are replaced, and a trailing `…` marks a line clipped at 4096 UTF-8 bytes. Fly merges stdout and stderr, so its lines show stream `unknown`. Output is recent only and expired provider output cannot be recovered; build output is not included. See the [logs API contract](https://github.com/Rika-Labs/akter/blob/main/docs/api/07-cloud-logs.md).
25
+ - The initial CLI tarball still needs a one-time maintainer publish and trusted-publisher setup; subsequent releases use the OIDC-only `release.yml` workflow. Bumping the version does not publish it.
26
+
27
+ See the [framework changelog](https://github.com/Rika-Labs/akter/blob/main/packages/akter/CHANGELOG.md) and [alpha upgrade notes](https://docs.akter.dev/operations/alpha-upgrades) for runtime changes and the required stopped-runner database upgrade.
package/LICENSE ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
package/NOTICE ADDED
@@ -0,0 +1,8 @@
1
+ Akter
2
+ Copyright 2026 Rika Labs
3
+
4
+ This product includes software developed at Rika Labs.
5
+
6
+ Files under tooling/oxlint/anti-slop and research/ carry their own licences,
7
+ named beside them. They are development tooling and research material and are
8
+ not part of the published @rikalabs/akter package.
package/README.md CHANGED
@@ -1,3 +1,17 @@
1
- # Temporary Holding Version
1
+ # Akter CLI
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ The `akter` command-line tool runs Akter applications locally, checks deployments, inspects and repairs running actors, and connects to Akter Cloud.
4
+
5
+ Install the current alpha in a project with `bun add -d @rikalabs/akter-cli@alpha` or `npm i -D @rikalabs/akter-cli@alpha`, then run `bunx akter --help` or `npx akter --help`. For one-off use, run `npx -p @rikalabs/akter-cli@alpha akter login`; for a global install, run `npm i -g @rikalabs/akter-cli@alpha`. The package supports Node 24 or later and Bun 1.4.2 or later. Before 1.0, tagged alphas also advance `latest`; `next` is a separate channel for verified main canaries.
6
+
7
+ Run `akter dev --entry ./src/app.ts` for local development. The local inspector is served at `/_akter/inspector`. To use a local Akter Cloud control plane, set `AKTER_API_URL=http://localhost:3001` or pass `--api-url http://localhost:3001` to `akter login`.
8
+
9
+ The framework package, `@rikalabs/akter`, does not carry a second `akter` bin. This package is the one install path for the CLI, so `npx akter` and `bunx akter` resolve the same release.
10
+
11
+ Cloud applications can import the public API contract without running the CLI:
12
+
13
+ ```ts
14
+ import { CloudApi, ProjectId } from "@rikalabs/akter-cli/cloud-api"
15
+ ```
16
+
17
+ The subpath ships compiled JavaScript and declarations, using the application's shared Effect runtime. `@akter/cloud-api` is a private workspace, not a separately published package. Pin the same exact framework and CLI version in deployments.
@@ -0,0 +1,79 @@
1
+ import { Context, Schema } from "effect";
2
+ import { HttpApiMiddleware, HttpApiSecurity } from "effect/http-api";
3
+ import { Forbidden, Unauthorized, Unavailable } from "./errors.ts";
4
+ /** The cookie that carries the Better Auth session token over plain HTTP. */
5
+ export declare const sessionCookieName = "better-auth.session_token";
6
+ /** The same cookie as Better Auth names it when served over HTTPS. */
7
+ export declare const secureSessionCookieName = "__Secure-better-auth.session_token";
8
+ /** The request header that carries an organization API key. */
9
+ export declare const apiKeyHeaderName = "x-api-key";
10
+ /** A signed-in person, resolved from the session cookie or a CLI's bearer session token. */
11
+ export declare const SessionIdentity: Schema.TaggedStruct<"session", {
12
+ readonly userId: Schema.brand<Schema.String, "UserId">;
13
+ readonly sessionId: Schema.String;
14
+ readonly activeOrganizationId: Schema.NullOr<Schema.brand<Schema.String, "OrganizationId">>;
15
+ }>;
16
+ /** An organization-owned key; the key, never a person, is the actor. */
17
+ export declare const ApiKeyIdentity: Schema.TaggedStruct<"api-key", {
18
+ readonly keyId: Schema.brand<Schema.String, "ApiKeyId">;
19
+ readonly organizationId: Schema.brand<Schema.String, "OrganizationId">;
20
+ readonly permission: Schema.Literals<readonly ["read", "write", "admin"]>;
21
+ }>;
22
+ export declare const Identity: Schema.Union<readonly [Schema.TaggedStruct<"session", {
23
+ readonly userId: Schema.brand<Schema.String, "UserId">;
24
+ readonly sessionId: Schema.String;
25
+ readonly activeOrganizationId: Schema.NullOr<Schema.brand<Schema.String, "OrganizationId">>;
26
+ }>, Schema.TaggedStruct<"api-key", {
27
+ readonly keyId: Schema.brand<Schema.String, "ApiKeyId">;
28
+ readonly organizationId: Schema.brand<Schema.String, "OrganizationId">;
29
+ readonly permission: Schema.Literals<readonly ["read", "write", "admin"]>;
30
+ }>]>;
31
+ export type Identity = typeof Identity.Type;
32
+ declare const CurrentIdentity_base: Context.ServiceClass<CurrentIdentity, "@akter/cloud-api/auth/CurrentIdentity", {
33
+ readonly _tag: "session";
34
+ readonly userId: string & import("effect/Brand").Brand<"UserId">;
35
+ readonly sessionId: string;
36
+ readonly activeOrganizationId: (string & import("effect/Brand").Brand<"OrganizationId">) | null;
37
+ } | {
38
+ readonly _tag: "api-key";
39
+ readonly keyId: string & import("effect/Brand").Brand<"ApiKeyId">;
40
+ readonly organizationId: string & import("effect/Brand").Brand<"OrganizationId">;
41
+ readonly permission: "admin" | "read" | "write";
42
+ }>;
43
+ /** The verified caller of the current request, provided by `Authentication`. */
44
+ export declare class CurrentIdentity extends CurrentIdentity_base {
45
+ }
46
+ declare const Authentication_base: HttpApiMiddleware.ServiceClass<Authentication, "@akter/cloud-api/Authentication", {
47
+ requires: never;
48
+ provides: CurrentIdentity;
49
+ error: readonly [typeof Unauthorized, typeof Forbidden, typeof Unavailable];
50
+ clientError: never;
51
+ requiredForClient: false;
52
+ security: {
53
+ readonly session: HttpApiSecurity.ApiKey;
54
+ readonly secureSession: HttpApiSecurity.ApiKey;
55
+ readonly apiKey: HttpApiSecurity.ApiKey;
56
+ readonly bearer: HttpApiSecurity.Http;
57
+ };
58
+ }, HttpApiMiddleware.HttpApiMiddlewareSecurity<{
59
+ readonly session: HttpApiSecurity.ApiKey;
60
+ readonly secureSession: HttpApiSecurity.ApiKey;
61
+ readonly apiKey: HttpApiSecurity.ApiKey;
62
+ readonly bearer: HttpApiSecurity.Http;
63
+ }, CurrentIdentity, readonly [typeof Unauthorized, typeof Forbidden, typeof Unavailable], never>>;
64
+ /**
65
+ * Resolves who is calling. The server implements one handler per security
66
+ * scheme and fails `Unauthorized` when a scheme's credential is missing or
67
+ * invalid; the first scheme that succeeds provides `CurrentIdentity`. A cookie
68
+ * browser client sends credentials automatically, so no client implementation
69
+ * is required. `bearer` carries the session token a CLI receives from Better
70
+ * Auth's device authorization grant. A credential the server cannot check
71
+ * because its session store is down fails `Unavailable`, never
72
+ * `Unauthorized`, so every endpoint's client can tell an outage from a
73
+ * session that ended.
74
+ *
75
+ * @effect-expect-leaking HttpServerRequest | ParsedSearchParams | RouteContext
76
+ */
77
+ export declare class Authentication extends Authentication_base {
78
+ }
79
+ export {};
@@ -0,0 +1,312 @@
1
+ import { Schema } from "effect";
2
+ /**
3
+ * The plan of an organization with a billing account, tagged `known` like the
4
+ * organization's `KnownPlan`, so `Plan | UnboundPlan` is a tagged union.
5
+ */
6
+ export declare const Plan: Schema.TaggedStruct<"known", {
7
+ readonly id: Schema.Literals<readonly ["free", "pro", "team", "enterprise"]>;
8
+ readonly name: Schema.String;
9
+ readonly basePriceCents: Schema.Int;
10
+ readonly currency: Schema.Literal<"usd">;
11
+ readonly renewsAt: Schema.NullOr<Schema.DateTimeUtc>;
12
+ readonly monthToDateEstimateCents: Schema.Int;
13
+ readonly provisional: Schema.optionalKey<Schema.Boolean>;
14
+ readonly subscribedId: Schema.optionalKey<Schema.Literals<readonly ["free", "pro", "team", "enterprise"]>>;
15
+ readonly paymentStatus: Schema.optionalKey<Schema.Literals<readonly ["free", "active", "past_due", "unpaid", "canceled", "incomplete"]>>;
16
+ }>;
17
+ export type Plan = typeof Plan.Type;
18
+ /** A card on file. */
19
+ export declare const CardPaymentMethod: Schema.TaggedStruct<"card", {
20
+ readonly brand: Schema.String;
21
+ readonly lastFour: Schema.String;
22
+ readonly expiryMonth: Schema.Int;
23
+ readonly expiryYear: Schema.Int;
24
+ }>;
25
+ /**
26
+ * A Link account on file. Stripe reports only the account's email, which is null when Link holds
27
+ * none, and nothing about the card behind it.
28
+ */
29
+ export declare const LinkPaymentMethod: Schema.TaggedStruct<"link", {
30
+ readonly email: Schema.NullOr<Schema.String>;
31
+ }>;
32
+ export declare const PaymentMethod: Schema.Union<readonly [Schema.TaggedStruct<"card", {
33
+ readonly brand: Schema.String;
34
+ readonly lastFour: Schema.String;
35
+ readonly expiryMonth: Schema.Int;
36
+ readonly expiryYear: Schema.Int;
37
+ }>, Schema.TaggedStruct<"link", {
38
+ readonly email: Schema.NullOr<Schema.String>;
39
+ }>]>;
40
+ export type PaymentMethod = typeof PaymentMethod.Type;
41
+ export declare const SpendLimit: Schema.Struct<{
42
+ readonly limitCents: Schema.NullOr<Schema.Int>;
43
+ readonly currentSpendCents: Schema.Int;
44
+ }>;
45
+ export type SpendLimit = typeof SpendLimit.Type;
46
+ /**
47
+ * One cap as the edge's admission decides it now, whatever period is being
48
+ * reported, discriminated by `cap`. `limit` is null when the cap does not
49
+ * apply. `atCap` means usage has reached the limit; `refusing` means the edge
50
+ * would refuse the next new command, or for `connections` the next new
51
+ * connection. `reason` is `unbound` when the
52
+ * edge refuses everything because the organization has no billing account;
53
+ * such caps have no limit.
54
+ *
55
+ * `limit` and `used` are cents for `spend`, open connections for
56
+ * `connections`, compute unit-hours used in the current billing period for
57
+ * `compute`. Customer database storage is not metered, capped or billed.
58
+ */
59
+ export declare const CapState: Schema.Struct<{
60
+ readonly limit: Schema.NullOr<Schema.Finite>;
61
+ readonly used: Schema.Finite;
62
+ readonly atCap: Schema.Boolean;
63
+ readonly refusing: Schema.Boolean;
64
+ readonly reason: Schema.optionalKey<Schema.Literal<"unbound">>;
65
+ readonly cap: Schema.Literals<readonly ["spend", "connections", "compute"]>;
66
+ }>;
67
+ export type CapState = typeof CapState.Type;
68
+ /**
69
+ * `plan` is `unbound` when the organization has no billing account: it has no
70
+ * plan, price or allowances, and is never reported as Free. Its spend limit is
71
+ * then null and its current spend zero, since the edge admits nothing for it.
72
+ */
73
+ export declare const BillingSummary: Schema.Struct<{
74
+ readonly plan: Schema.Union<readonly [Schema.TaggedStruct<"known", {
75
+ readonly id: Schema.Literals<readonly ["free", "pro", "team", "enterprise"]>;
76
+ readonly name: Schema.String;
77
+ readonly basePriceCents: Schema.Int;
78
+ readonly currency: Schema.Literal<"usd">;
79
+ readonly renewsAt: Schema.NullOr<Schema.DateTimeUtc>;
80
+ readonly monthToDateEstimateCents: Schema.Int;
81
+ readonly provisional: Schema.optionalKey<Schema.Boolean>;
82
+ readonly subscribedId: Schema.optionalKey<Schema.Literals<readonly ["free", "pro", "team", "enterprise"]>>;
83
+ readonly paymentStatus: Schema.optionalKey<Schema.Literals<readonly ["free", "active", "past_due", "unpaid", "canceled", "incomplete"]>>;
84
+ }>, Schema.TaggedStruct<"unbound", {}>]>;
85
+ readonly paymentMethod: Schema.NullOr<Schema.Union<readonly [Schema.TaggedStruct<"card", {
86
+ readonly brand: Schema.String;
87
+ readonly lastFour: Schema.String;
88
+ readonly expiryMonth: Schema.Int;
89
+ readonly expiryYear: Schema.Int;
90
+ }>, Schema.TaggedStruct<"link", {
91
+ readonly email: Schema.NullOr<Schema.String>;
92
+ }>]>>;
93
+ readonly billingEmail: Schema.NullOr<Schema.brand<Schema.String, "Email">>;
94
+ readonly spendLimit: Schema.Struct<{
95
+ readonly limitCents: Schema.NullOr<Schema.Int>;
96
+ readonly currentSpendCents: Schema.Int;
97
+ }>;
98
+ readonly caps: Schema.optionalKey<Schema.$Array<Schema.Struct<{
99
+ readonly limit: Schema.NullOr<Schema.Finite>;
100
+ readonly used: Schema.Finite;
101
+ readonly atCap: Schema.Boolean;
102
+ readonly refusing: Schema.Boolean;
103
+ readonly reason: Schema.optionalKey<Schema.Literal<"unbound">>;
104
+ readonly cap: Schema.Literals<readonly ["spend", "connections", "compute"]>;
105
+ }>>>;
106
+ }>;
107
+ export type BillingSummary = typeof BillingSummary.Type;
108
+ export declare const SetSpendLimit: Schema.Struct<{
109
+ readonly limitCents: Schema.NullOr<Schema.Int>;
110
+ }>;
111
+ export type SetSpendLimit = typeof SetSpendLimit.Type;
112
+ export declare const Invoice: Schema.Struct<{
113
+ readonly id: Schema.brand<Schema.String, "InvoiceId">;
114
+ readonly number: Schema.String;
115
+ readonly periodStart: Schema.DateTimeUtc;
116
+ readonly periodEnd: Schema.DateTimeUtc;
117
+ readonly amountCents: Schema.Int;
118
+ readonly currency: Schema.Literal<"usd">;
119
+ readonly status: Schema.Literals<readonly ["draft", "open", "paid", "void", "uncollectible"]>;
120
+ readonly pdfUrl: Schema.NullOr<Schema.String>;
121
+ }>;
122
+ export type Invoice = typeof Invoice.Type;
123
+ /** The paid plan to move to; the server builds the checkout and return URLs. */
124
+ export declare const StartCheckout: Schema.Struct<{
125
+ readonly plan: Schema.Literals<readonly ["pro", "team", "enterprise"]>;
126
+ }>;
127
+ export type StartCheckout = typeof StartCheckout.Type;
128
+ /** A plan change on the existing subscription; payment confirmation can leave it pending. */
129
+ export declare const PlanChange: Schema.Struct<{
130
+ readonly requestId: Schema.String;
131
+ readonly status: Schema.Literals<readonly ["pending", "completed", "failed"]>;
132
+ }>;
133
+ export type PlanChange = typeof PlanChange.Type;
134
+ /** A hosted Stripe page the browser should navigate to. */
135
+ export declare const HostedSession: Schema.Struct<{
136
+ readonly url: Schema.String;
137
+ }>;
138
+ export type HostedSession = typeof HostedSession.Type;
139
+ /**
140
+ * What a plan offers, derived from the pricing configuration: billed compute
141
+ * overage, a hard compute cap, customer Postgres on every plan, and a paid
142
+ * subscription bought through checkout.
143
+ */
144
+ export declare const PlanFeature: Schema.Literals<readonly ["compute-overage", "compute-cap", "byo-database", "checkout"]>;
145
+ export type PlanFeature = typeof PlanFeature.Type;
146
+ /**
147
+ * One tier of the pricing configuration. `allowances.computeUnitHours` is the
148
+ * included compute unit-hours and `allowances.computeUnitHourCap` its hard
149
+ * stop (null when overage is billed instead at
150
+ * `overage.computeCentsPerUnitHour`). A machine size's hour bills the compute
151
+ * unit-hours `PlanCatalog.computeSizes` gives it.
152
+ *
153
+ * A provisional tier's prices are not yet published.
154
+ */
155
+ export declare const CatalogPlan: Schema.Struct<{
156
+ readonly id: Schema.Literals<readonly ["free", "pro", "team", "enterprise"]>;
157
+ readonly name: Schema.String;
158
+ readonly basePriceCents: Schema.Int;
159
+ readonly currency: Schema.Literal<"usd">;
160
+ readonly allowances: Schema.Struct<{
161
+ readonly computeUnitHours: Schema.Finite;
162
+ readonly computeUnitHourCap: Schema.NullOr<Schema.Finite>;
163
+ readonly concurrentConnections: Schema.Int;
164
+ }>;
165
+ readonly overage: Schema.Struct<{
166
+ readonly computeCentsPerUnitHour: Schema.Finite;
167
+ }>;
168
+ readonly features: Schema.$Array<Schema.Literals<readonly ["compute-overage", "compute-cap", "byo-database", "checkout"]>>;
169
+ readonly provisional: Schema.Boolean;
170
+ }>;
171
+ export type CatalogPlan = typeof CatalogPlan.Type;
172
+ /**
173
+ * One machine size's weight in compute units: an hour of the size bills
174
+ * `unitsPerHour` compute unit-hours. The weights come from the pricing
175
+ * configuration.
176
+ */
177
+ export declare const ComputeSize: Schema.Struct<{
178
+ readonly cpuKind: Schema.Literals<readonly ["shared", "performance"]>;
179
+ readonly cpus: Schema.Int;
180
+ readonly memoryMb: Schema.Int;
181
+ readonly unitsPerHour: Schema.Finite;
182
+ }>;
183
+ export type ComputeSize = typeof ComputeSize.Type;
184
+ /**
185
+ * Every plan, cheapest first; `provisional` is true while any plan's prices
186
+ * are provisional. `computeSizes` lists the compute unit weight of every
187
+ * machine size the platform runs.
188
+ */
189
+ export declare const PlanCatalog: Schema.Struct<{
190
+ readonly plans: Schema.$Array<Schema.Struct<{
191
+ readonly id: Schema.Literals<readonly ["free", "pro", "team", "enterprise"]>;
192
+ readonly name: Schema.String;
193
+ readonly basePriceCents: Schema.Int;
194
+ readonly currency: Schema.Literal<"usd">;
195
+ readonly allowances: Schema.Struct<{
196
+ readonly computeUnitHours: Schema.Finite;
197
+ readonly computeUnitHourCap: Schema.NullOr<Schema.Finite>;
198
+ readonly concurrentConnections: Schema.Int;
199
+ }>;
200
+ readonly overage: Schema.Struct<{
201
+ readonly computeCentsPerUnitHour: Schema.Finite;
202
+ }>;
203
+ readonly features: Schema.$Array<Schema.Literals<readonly ["compute-overage", "compute-cap", "byo-database", "checkout"]>>;
204
+ readonly provisional: Schema.Boolean;
205
+ }>>;
206
+ readonly computeSizes: Schema.$Array<Schema.Struct<{
207
+ readonly cpuKind: Schema.Literals<readonly ["shared", "performance"]>;
208
+ readonly cpus: Schema.Int;
209
+ readonly memoryMb: Schema.Int;
210
+ readonly unitsPerHour: Schema.Finite;
211
+ }>>;
212
+ readonly provisional: Schema.Boolean;
213
+ }>;
214
+ export type PlanCatalog = typeof PlanCatalog.Type;
215
+ /**
216
+ * `runnerHours` is measured in compute unit-hours (see `ComputeUsage`), not
217
+ * machine hours; raw machine hours are reported per machine size in
218
+ * `ComputeUsage.machineHours`.
219
+ */
220
+ export declare const UsageMeterName: Schema.Literal<"runnerHours">;
221
+ export type UsageMeterName = typeof UsageMeterName.Type;
222
+ export declare const UsageMeter: Schema.Struct<{
223
+ readonly meter: Schema.Literal<"runnerHours">;
224
+ readonly used: Schema.Finite;
225
+ readonly included: Schema.Finite;
226
+ readonly overage: Schema.Finite;
227
+ readonly overageCostCents: Schema.Finite;
228
+ }>;
229
+ export type UsageMeter = typeof UsageMeter.Type;
230
+ /**
231
+ * The published rules usage is priced by, sent with every usage report.
232
+ * `computeCentsPerUnitHour` prices compute unit-hours beyond the plan's
233
+ * allowance and is 0 where the plan bills no overage.
234
+ */
235
+ export declare const UsagePricing: Schema.Struct<{
236
+ readonly computeCentsPerUnitHour: Schema.Finite;
237
+ readonly provisional: Schema.optionalKey<Schema.Boolean>;
238
+ }>;
239
+ export type UsagePricing = typeof UsagePricing.Type;
240
+ /**
241
+ * Compute used by one machine size in one environment during the period:
242
+ * `machineHours` raw machine hours, billed as `computeUnitHours` at the
243
+ * size's `ComputeSize.unitsPerHour` in the plan catalog.
244
+ */
245
+ export declare const ComputeUsage: Schema.Struct<{
246
+ readonly cpuKind: Schema.Literals<readonly ["shared", "performance"]>;
247
+ readonly cpus: Schema.Int;
248
+ readonly memoryMb: Schema.Int;
249
+ readonly environmentId: Schema.brand<Schema.String, "EnvironmentId">;
250
+ readonly machineHours: Schema.Finite;
251
+ readonly computeUnitHours: Schema.Finite;
252
+ }>;
253
+ export type ComputeUsage = typeof ComputeUsage.Type;
254
+ /**
255
+ * `caps` describe now whatever `period` is reported. A project's
256
+ * `computeUnitHours` is its compute for the period and `compute` breaks it
257
+ * down by environment and machine size.
258
+ */
259
+ export declare const Usage: Schema.Struct<{
260
+ readonly period: Schema.String;
261
+ readonly meters: Schema.$Array<Schema.Struct<{
262
+ readonly meter: Schema.Literal<"runnerHours">;
263
+ readonly used: Schema.Finite;
264
+ readonly included: Schema.Finite;
265
+ readonly overage: Schema.Finite;
266
+ readonly overageCostCents: Schema.Finite;
267
+ }>>;
268
+ readonly caps: Schema.$Array<Schema.Struct<{
269
+ readonly limit: Schema.NullOr<Schema.Finite>;
270
+ readonly used: Schema.Finite;
271
+ readonly atCap: Schema.Boolean;
272
+ readonly refusing: Schema.Boolean;
273
+ readonly reason: Schema.optionalKey<Schema.Literal<"unbound">>;
274
+ readonly cap: Schema.Literals<readonly ["spend", "connections", "compute"]>;
275
+ }>>;
276
+ readonly byProject: Schema.$Array<Schema.Struct<{
277
+ readonly projectId: Schema.brand<Schema.String, "ProjectId">;
278
+ readonly name: Schema.String;
279
+ readonly computeUnitHours: Schema.Finite;
280
+ readonly compute: Schema.$Array<Schema.Struct<{
281
+ readonly cpuKind: Schema.Literals<readonly ["shared", "performance"]>;
282
+ readonly cpus: Schema.Int;
283
+ readonly memoryMb: Schema.Int;
284
+ readonly environmentId: Schema.brand<Schema.String, "EnvironmentId">;
285
+ readonly machineHours: Schema.Finite;
286
+ readonly computeUnitHours: Schema.Finite;
287
+ }>>;
288
+ readonly estimatedCostCents: Schema.Finite;
289
+ }>>;
290
+ readonly pricing: Schema.Struct<{
291
+ readonly computeCentsPerUnitHour: Schema.Finite;
292
+ readonly provisional: Schema.optionalKey<Schema.Boolean>;
293
+ }>;
294
+ }>;
295
+ export type Usage = typeof Usage.Type;
296
+ export declare const AuditEntry: Schema.Struct<{
297
+ readonly id: Schema.String;
298
+ readonly at: Schema.DateTimeUtc;
299
+ readonly actor: Schema.Struct<{
300
+ readonly kind: Schema.Literals<readonly ["user", "api-key"]>;
301
+ readonly id: Schema.String;
302
+ readonly name: Schema.NullOr<Schema.String>;
303
+ }>;
304
+ readonly action: Schema.String;
305
+ readonly target: Schema.Struct<{
306
+ readonly type: Schema.String;
307
+ readonly id: Schema.NullOr<Schema.String>;
308
+ readonly name: Schema.NullOr<Schema.String>;
309
+ }>;
310
+ readonly ipAddress: Schema.NullOr<Schema.String>;
311
+ }>;
312
+ export type AuditEntry = typeof AuditEntry.Type;