@farthershore/client 0.1.0 → 0.3.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.
Files changed (35) hide show
  1. package/CHANGELOG.md +172 -0
  2. package/README.md +9 -8
  3. package/dist/index.js +105 -54
  4. package/dist/types/api.generated.d.ts +21 -7
  5. package/dist/types/generated/schemas.d.ts +3683 -0
  6. package/dist/types/helpers/wait-for-frontend-build.d.ts +12 -4
  7. package/dist/types/index.d.ts +2 -2
  8. package/dist/types/operations/agents.d.ts +204 -12
  9. package/dist/types/operations/agreements.d.ts +139 -9
  10. package/dist/types/operations/analytics.d.ts +27 -5
  11. package/dist/types/operations/audit-notifications.d.ts +64 -7
  12. package/dist/types/operations/auth.d.ts +12 -4
  13. package/dist/types/operations/backends.d.ts +211 -9
  14. package/dist/types/operations/billing.d.ts +60 -4
  15. package/dist/types/operations/businesses.d.ts +744 -27
  16. package/dist/types/operations/change-sets.d.ts +426 -7
  17. package/dist/types/operations/consumers.d.ts +133 -14
  18. package/dist/types/operations/define.d.ts +16 -5
  19. package/dist/types/operations/environments.d.ts +40 -4
  20. package/dist/types/operations/frontend.d.ts +20 -2
  21. package/dist/types/operations/index.d.ts +3941 -193
  22. package/dist/types/operations/maker-tokens.d.ts +175 -11
  23. package/dist/types/operations/organizations.d.ts +321 -19
  24. package/dist/types/operations/personas.d.ts +98 -8
  25. package/dist/types/operations/plans-usage.d.ts +69 -3
  26. package/dist/types/operations/platform.d.ts +420 -12
  27. package/dist/types/operations/portal.d.ts +409 -16
  28. package/dist/types/operations/promo-codes.d.ts +126 -6
  29. package/dist/types/operations/variables.d.ts +170 -7
  30. package/dist/types/operations/webhooks.d.ts +77 -14
  31. package/dist/types/surface-types.d.ts +25 -3
  32. package/dist/types/transport.d.ts +5 -10
  33. package/dist/types/types.d.ts +385 -411
  34. package/dist/types/version.d.ts +2 -2
  35. package/package.json +1 -1
@@ -1,4 +1,3 @@
1
- import type { RuntimeTokenSummary } from "../types.js";
2
1
  type BusinessRef = {
3
2
  businessId: string;
4
3
  };
@@ -13,7 +12,27 @@ type ScopeFilter = BusinessRef & {
13
12
  offset?: number;
14
13
  };
15
14
  export declare const backendOperations: {
16
- "backends.read": import("./define.js").OperationEntry<ScopeFilter, unknown>;
15
+ "backends.read": import("./define.js").OperationEntry<ScopeFilter, {
16
+ data: import("../generated/schemas.js").components["schemas"]["Backend"][];
17
+ pagination: {
18
+ total: number;
19
+ limit: number;
20
+ offset: number;
21
+ hasMore: boolean;
22
+ };
23
+ scope: "all" | "production" | "environment";
24
+ environmentId: string | null;
25
+ }, {
26
+ data: import("../generated/schemas.js").components["schemas"]["Backend"][];
27
+ pagination: {
28
+ total: number;
29
+ limit: number;
30
+ offset: number;
31
+ hasMore: boolean;
32
+ };
33
+ scope: "all" | "production" | "environment";
34
+ environmentId: string | null;
35
+ }>;
17
36
  "backends.create": import("./define.js").OperationEntry<BusinessRef & {
18
37
  name: string;
19
38
  slug?: string;
@@ -24,17 +43,102 @@ export declare const backendOperations: {
24
43
  runtime?: string | null;
25
44
  originUrl?: string | null;
26
45
  isDefault?: boolean;
27
- }, unknown>;
46
+ }, {
47
+ id: string;
48
+ businessId: string;
49
+ environmentId: string | null;
50
+ name: string;
51
+ slug: string;
52
+ transportMode: "direct" | "tunnel";
53
+ runner: ("embedded" | "sidecar") | null;
54
+ runtime: string | null;
55
+ verificationRequired: boolean;
56
+ originUrl: string | null;
57
+ isDefault: boolean;
58
+ status: "registered" | "building" | "deployed" | "tunnel_connected" | "healthy" | "unhealthy" | "verification_failed" | "provision_failed" | "disabled";
59
+ lastSeenAt: string | null;
60
+ createdAt: string;
61
+ updated?: true;
62
+ }, {
63
+ action: "create" | "update";
64
+ backend: {
65
+ businessId: string;
66
+ environmentId: string | null;
67
+ name: string;
68
+ slug: string;
69
+ transportMode: "direct" | "tunnel";
70
+ runner: ("embedded" | "sidecar") | null;
71
+ runtime: string | null;
72
+ originUrl: string | null;
73
+ isDefault: boolean;
74
+ };
75
+ }>;
28
76
  "backends.bind": import("./define.js").OperationEntry<BusinessRef & {
29
77
  /** The logical backend slug or id. */
30
78
  backend: string;
31
79
  environmentId?: string | null;
32
80
  originUrl: string;
33
- }, unknown>;
81
+ }, {
82
+ id: string;
83
+ businessId: string;
84
+ environmentId: string | null;
85
+ name: string;
86
+ slug: string;
87
+ transportMode: "direct" | "tunnel";
88
+ runner: ("embedded" | "sidecar") | null;
89
+ runtime: string | null;
90
+ verificationRequired: boolean;
91
+ originUrl: string | null;
92
+ isDefault: boolean;
93
+ status: "registered" | "building" | "deployed" | "tunnel_connected" | "healthy" | "unhealthy" | "verification_failed" | "provision_failed" | "disabled";
94
+ lastSeenAt: string | null;
95
+ createdAt: string;
96
+ }, {
97
+ id: string;
98
+ businessId: string;
99
+ environmentId: string | null;
100
+ name: string;
101
+ slug: string;
102
+ transportMode: "direct" | "tunnel";
103
+ runner: ("embedded" | "sidecar") | null;
104
+ runtime: string | null;
105
+ verificationRequired: boolean;
106
+ originUrl: string | null;
107
+ isDefault: boolean;
108
+ status: "registered" | "building" | "deployed" | "tunnel_connected" | "healthy" | "unhealthy" | "verification_failed" | "provision_failed" | "disabled";
109
+ lastSeenAt: string | null;
110
+ createdAt: string;
111
+ }>;
34
112
  "backends.delete": import("./define.js").OperationEntry<BusinessRef & {
35
113
  backendId: string;
36
- }, unknown>;
37
- "runtimeTokens.read": import("./define.js").OperationEntry<ScopeFilter, unknown>;
114
+ }, {
115
+ id: string;
116
+ deleted: true;
117
+ }, {
118
+ id: string;
119
+ deleted: true;
120
+ }>;
121
+ "runtimeTokens.read": import("./define.js").OperationEntry<ScopeFilter, {
122
+ data: import("../generated/schemas.js").components["schemas"]["RuntimeToken"][];
123
+ pagination: {
124
+ total: number;
125
+ limit: number;
126
+ offset: number;
127
+ hasMore: boolean;
128
+ };
129
+ scope: "all" | "production" | "environment";
130
+ environmentId: string | null;
131
+ }, {
132
+ data: import("../generated/schemas.js").components["schemas"]["RuntimeToken"][];
133
+ pagination: {
134
+ total: number;
135
+ limit: number;
136
+ offset: number;
137
+ hasMore: boolean;
138
+ };
139
+ scope: "all" | "production" | "environment";
140
+ environmentId: string | null;
141
+ }>;
38
142
  "runtimeTokens.mint": import("./define.js").OperationEntry<BusinessRef & {
39
143
  environmentId?: string | null;
40
144
  backendId?: string | null;
@@ -42,12 +146,110 @@ export declare const backendOperations: {
42
146
  operations?: string[];
43
147
  allowedMeters?: string[];
44
148
  allowedRoutes?: string[];
45
- }, unknown>;
149
+ }, {
150
+ id: string;
151
+ businessId: string;
152
+ environmentId: string | null;
153
+ backendId: string | null;
154
+ kind: "live" | "test";
155
+ lastFour: string;
156
+ operations: ("gateway_verification" | "metering" | "health" | "tunnel" | "drift_report")[];
157
+ allowedMeters: string[];
158
+ allowedRoutes: string[];
159
+ status: "active" | "revoked";
160
+ rotatedFromId: string | null;
161
+ createdAt: string;
162
+ revokedAt: string | null;
163
+ lastUsedAt: string | null;
164
+ envVar: "FS_RUNTIME_TOKEN";
165
+ token: string;
166
+ }, {
167
+ id: string;
168
+ businessId: string;
169
+ environmentId: string | null;
170
+ backendId: string | null;
171
+ kind: "live" | "test";
172
+ lastFour: string;
173
+ operations: ("gateway_verification" | "metering" | "health" | "tunnel" | "drift_report")[];
174
+ allowedMeters: string[];
175
+ allowedRoutes: string[];
176
+ status: "active" | "revoked";
177
+ rotatedFromId: string | null;
178
+ createdAt: string;
179
+ revokedAt: string | null;
180
+ lastUsedAt: string | null;
181
+ envVar: "FS_RUNTIME_TOKEN";
182
+ token: string;
183
+ }>;
46
184
  "runtimeTokens.rotate": import("./define.js").OperationEntry<BusinessRef & {
47
185
  tokenId: string;
48
- }, unknown>;
186
+ }, {
187
+ id: string;
188
+ businessId: string;
189
+ environmentId: string | null;
190
+ backendId: string | null;
191
+ kind: "live" | "test";
192
+ lastFour: string;
193
+ operations: ("gateway_verification" | "metering" | "health" | "tunnel" | "drift_report")[];
194
+ allowedMeters: string[];
195
+ allowedRoutes: string[];
196
+ status: "active" | "revoked";
197
+ rotatedFromId: string | null;
198
+ createdAt: string;
199
+ revokedAt: string | null;
200
+ lastUsedAt: string | null;
201
+ envVar: "FS_RUNTIME_TOKEN";
202
+ token: string;
203
+ }, {
204
+ id: string;
205
+ businessId: string;
206
+ environmentId: string | null;
207
+ backendId: string | null;
208
+ kind: "live" | "test";
209
+ lastFour: string;
210
+ operations: ("gateway_verification" | "metering" | "health" | "tunnel" | "drift_report")[];
211
+ allowedMeters: string[];
212
+ allowedRoutes: string[];
213
+ status: "active" | "revoked";
214
+ rotatedFromId: string | null;
215
+ createdAt: string;
216
+ revokedAt: string | null;
217
+ lastUsedAt: string | null;
218
+ envVar: "FS_RUNTIME_TOKEN";
219
+ token: string;
220
+ }>;
49
221
  "runtimeTokens.revoke": import("./define.js").OperationEntry<BusinessRef & {
50
222
  tokenId: string;
51
- }, RuntimeTokenSummary>;
223
+ }, {
224
+ id: string;
225
+ businessId: string;
226
+ environmentId: string | null;
227
+ backendId: string | null;
228
+ kind: "live" | "test";
229
+ lastFour: string;
230
+ operations: ("gateway_verification" | "metering" | "health" | "tunnel" | "drift_report")[];
231
+ allowedMeters: string[];
232
+ allowedRoutes: string[];
233
+ status: "active" | "revoked";
234
+ rotatedFromId: string | null;
235
+ createdAt: string;
236
+ revokedAt: string | null;
237
+ lastUsedAt: string | null;
238
+ }, {
239
+ id: string;
240
+ businessId: string;
241
+ environmentId: string | null;
242
+ backendId: string | null;
243
+ kind: "live" | "test";
244
+ lastFour: string;
245
+ operations: ("gateway_verification" | "metering" | "health" | "tunnel" | "drift_report")[];
246
+ allowedMeters: string[];
247
+ allowedRoutes: string[];
248
+ status: "active" | "revoked";
249
+ rotatedFromId: string | null;
250
+ createdAt: string;
251
+ revokedAt: string | null;
252
+ lastUsedAt: string | null;
253
+ }>;
52
254
  };
53
255
  export {};
@@ -3,13 +3,69 @@ type BusinessRef = {
3
3
  businessId: string;
4
4
  };
5
5
  export declare const billingOperations: {
6
- "billing.stripe.read": import("./define.js").OperationEntry<BusinessRef, unknown>;
6
+ "billing.stripe.read": import("./define.js").OperationEntry<BusinessRef, {
7
+ connected: boolean;
8
+ source: "business" | "organization";
9
+ isOverride: boolean;
10
+ chargesEnabled: boolean;
11
+ cardPaymentsEnabled: boolean;
12
+ }, {
13
+ connected: boolean;
14
+ source: "business" | "organization";
15
+ isOverride: boolean;
16
+ chargesEnabled: boolean;
17
+ cardPaymentsEnabled: boolean;
18
+ }>;
7
19
  "billing.stripe.delete": import("./define.js").OperationEntry<BusinessRef & {
8
20
  deleteAccount?: boolean;
9
- }, unknown>;
10
- "billing.taxSettings.read": import("./define.js").OperationEntry<BusinessRef, unknown>;
21
+ }, {
22
+ disconnected: true;
23
+ }, {
24
+ disconnected: true;
25
+ }>;
26
+ "billing.taxSettings.read": import("./define.js").OperationEntry<BusinessRef, {
27
+ status: "active" | "pending";
28
+ defaults: {
29
+ taxBehavior: ("exclusive" | "inclusive" | "inferred_by_currency") | null;
30
+ taxCode: string | null;
31
+ };
32
+ headOffice: {
33
+ address: import("../generated/schemas.js").components["schemas"]["TaxAddress"];
34
+ } | null;
35
+ missingFields: string[];
36
+ }, {
37
+ status: "active" | "pending";
38
+ defaults: {
39
+ taxBehavior: ("exclusive" | "inclusive" | "inferred_by_currency") | null;
40
+ taxCode: string | null;
41
+ };
42
+ headOffice: {
43
+ address: import("../generated/schemas.js").components["schemas"]["TaxAddress"];
44
+ } | null;
45
+ missingFields: string[];
46
+ }>;
11
47
  "billing.taxSettings.update": import("./define.js").OperationEntry<BusinessRef & {
12
48
  body: RequestBody;
13
- }, unknown>;
49
+ }, {
50
+ status: "active" | "pending";
51
+ defaults: {
52
+ taxBehavior: ("exclusive" | "inclusive" | "inferred_by_currency") | null;
53
+ taxCode: string | null;
54
+ };
55
+ headOffice: {
56
+ address: import("../generated/schemas.js").components["schemas"]["TaxAddress"];
57
+ } | null;
58
+ missingFields: string[];
59
+ }, {
60
+ status: "active" | "pending";
61
+ defaults: {
62
+ taxBehavior: ("exclusive" | "inclusive" | "inferred_by_currency") | null;
63
+ taxCode: string | null;
64
+ };
65
+ headOffice: {
66
+ address: import("../generated/schemas.js").components["schemas"]["TaxAddress"];
67
+ } | null;
68
+ missingFields: string[];
69
+ }>;
14
70
  };
15
71
  export {};