-
Notifications
You must be signed in to change notification settings - Fork 673
Expand file tree
/
Copy pathworkspaceApi.ts
More file actions
824 lines (743 loc) · 19.9 KB
/
Copy pathworkspaceApi.ts
File metadata and controls
824 lines (743 loc) · 19.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
import axios from 'axios'
import { attachUnifiedRemintInterceptor } from '@/platform/auth/unified/remintRetry'
import type { SubscriptionTier } from '@/platform/cloud/subscription/constants/tierPricing'
import type {
WorkspaceId,
WorkspaceInviteId
} from '@/platform/workspace/workspaceTypes'
import { api } from '@/scripts/api'
import { useAuthStore } from '@/stores/authStore'
import type { UserId } from '@/types/authTypes'
export type WorkspaceType = 'personal' | 'team'
export type WorkspaceRole = 'owner' | 'member'
export type BillingRail = 'legacy_stripe' | 'stripe'
interface Workspace {
id: WorkspaceId
name: string
type: WorkspaceType
created_at: string
joined_at: string
}
export interface WorkspaceWithRole extends Workspace {
role: WorkspaceRole
subscription_tier?: SubscriptionTier
}
export interface Member {
id: UserId
name: string
email: string
joined_at: string
role: WorkspaceRole
// True when this member is the workspace's original owner/creator
// (member.id == workspace.created_by_user_id). Used for personal creator
// protections and Team-to-personal downgrade eligibility.
// Optional: the cloud OpenAPI does not carry this field yet.
is_original_owner?: boolean
// Per-member monthly credit limit UI (FE-1277). The cloud OpenAPI carries
// neither usage nor limit yet; persistence and real usage land in FE-1278.
credits_used_this_month?: number
monthly_credit_limit?: number | null
}
interface PaginationInfo {
offset: number
limit: number
total: number
}
interface ListMembersResponse {
members: Member[]
pagination: PaginationInfo
}
export interface ListMembersParams {
offset?: number
limit?: number
}
export interface PendingInvite {
id: WorkspaceInviteId
email: string
invited_at: string
expires_at: string
}
interface ListInvitesResponse {
invites: PendingInvite[]
}
interface CreateInviteRequest {
email: string
}
interface AcceptInviteResponse {
workspace_id: WorkspaceId
workspace_name: string
}
interface CreateWorkspacePayload {
name: string
}
interface UpdateWorkspacePayload {
name: string
}
interface ListWorkspacesResponse {
workspaces: WorkspaceWithRole[]
}
export type { SubscriptionTier }
export type SubscriptionDuration = 'MONTHLY' | 'ANNUAL'
type PlanAvailabilityReason =
| 'same_plan'
| 'incompatible_transition'
| 'requires_team'
| 'requires_personal'
| 'exceeds_max_seats'
interface PlanAvailability {
available: boolean
reason?: PlanAvailabilityReason
}
interface PlanSeatSummary {
seat_count: number
total_cost_cents: number
total_credits_cents: number
}
export interface Plan {
slug: string
tier: SubscriptionTier
duration: SubscriptionDuration
price_cents: number
credits_cents: number
max_seats: number
availability: PlanAvailability
seat_summary: PlanSeatSummary
}
interface TeamCreditStopPrice {
list_price_cents: number
price_cents: number
}
interface TeamCreditStop {
id: string
credits: number
monthly: TeamCreditStopPrice
yearly: TeamCreditStopPrice
}
export interface TeamCreditStops {
default_stop_index: number
stops: TeamCreditStop[]
}
interface BillingPlansResponse {
current_plan_slug?: string
plans: Plan[]
team_credit_stops?: TeamCreditStops
}
type SubscriptionTransitionType =
| 'new_subscription'
| 'upgrade'
| 'downgrade'
| 'duration_change'
interface PreviewSubscribeRequest {
plan_slug: string
team_credit_stop_id?: string
billing_cycle?: SubscribeBillingCycle
}
type SubscribeBillingCycle = 'monthly' | 'yearly'
interface SubscribeRequest {
plan_slug: string
idempotency_key?: string
return_url?: string
cancel_url?: string
/** Required for the per-credit Team plan; selects the slider stop. */
team_credit_stop_id?: string
billing_cycle?: SubscribeBillingCycle
/** Required to change plans while the current subscription is cancelled; server rejects the change without it. */
confirm_reactivation?: boolean
}
export interface SubscribeOptions {
returnUrl?: string
cancelUrl?: string
teamCreditStopId?: string
billingCycle?: SubscribeBillingCycle
confirmReactivation?: boolean
}
export interface PreviewSubscribeOptions {
teamCreditStopId?: string
billingCycle?: SubscribeBillingCycle
}
type SubscribeStatus = 'subscribed' | 'needs_payment_method' | 'pending_payment'
export interface SubscribeResponse {
billing_op_id: string
status: SubscribeStatus
effective_at?: string
payment_method_url?: string
}
interface CancelSubscriptionRequest {
idempotency_key?: string
}
interface CancelSubscriptionResponse {
billing_op_id: string
cancel_at: string
}
interface ResubscribeRequest {
idempotency_key?: string
}
interface ResubscribeResponse {
billing_op_id: string
status: 'active'
message?: string
}
interface PaymentPortalRequest {
return_url?: string
}
interface PaymentPortalResponse {
url: string
}
interface PreviewPlanInfo {
slug: string
tier: SubscriptionTier
duration: SubscriptionDuration
price_cents: number
credits_cents: number
seat_summary: PlanSeatSummary
period_start?: string
period_end?: string
}
export interface PreviewSubscribeResponse {
allowed: boolean
reason?: string
transition_type: SubscriptionTransitionType
effective_at: string
is_immediate: boolean
cost_today_cents: number
cost_next_period_cents: number
credits_today_cents: number
credits_next_period_cents: number
current_plan?: PreviewPlanInfo
new_plan: PreviewPlanInfo
}
export type BillingSubscriptionStatus =
| 'active'
| 'scheduled'
| 'ended'
| 'canceled'
export type BillingStatus =
| 'awaiting_payment_method'
| 'pending_payment'
| 'paid'
| 'payment_failed'
// A Stripe-paused subscription stays `active` on the activity axis; the pause
// is a payment-lifecycle fact. Not emitted until cloud#5075 ships.
| 'paused'
| 'inactive'
export interface CurrentTeamCreditStop {
id: string
credits_monthly: number
stop_usd: number
}
export interface BillingStatusResponse {
is_active: boolean
billing_rail?: BillingRail
subscription_status?: BillingSubscriptionStatus
subscription_tier?: SubscriptionTier
subscription_duration?: SubscriptionDuration
plan_slug?: string
billing_status?: BillingStatus
has_funds: boolean
cancel_at?: string
renewal_date?: string
team_credit_stop?: CurrentTeamCreditStop
}
export interface BillingBalanceResponse {
amount_micros: number
prepaid_balance_micros?: number
cloud_credit_balance_micros?: number
pending_charges_micros?: number
effective_balance_micros?: number
currency: string
}
interface CreateTopupRequest {
amount_cents: number
idempotency_key?: string
}
type TopupStatus = 'pending' | 'completed' | 'failed'
export interface CreateTopupResponse {
billing_op_id: string
topup_id: string
status: TopupStatus
amount_cents: number
}
type BillingOpStatus = 'pending' | 'succeeded' | 'failed'
export interface BillingOpStatusResponse {
id: string
status: BillingOpStatus
error_message?: string
started_at: string
completed_at?: string
}
interface BillingEvent {
event_type: string
event_id: string
params?: Record<string, unknown>
createdAt: string
}
interface BillingEventsResponse {
total: number
events: BillingEvent[]
page: number
limit: number
totalPages: number
}
interface GetBillingEventsParams {
page?: number
limit?: number
}
export class WorkspaceApiError extends Error {
constructor(
message: string,
public readonly status?: number,
public readonly code?: string
) {
super(message)
this.name = 'WorkspaceApiError'
}
}
const workspaceApiClient = axios.create({
headers: {
'Content-Type': 'application/json'
}
})
// acceptInvite opts out via __skipUnifiedRemint (it is deliberately Firebase-authed).
attachUnifiedRemintInterceptor(workspaceApiClient)
async function getAuthHeaderOrThrow() {
return useAuthStore().getAuthHeaderOrThrow()
}
function handleAxiosError(err: unknown): never {
if (axios.isAxiosError(err)) {
const status = err.response?.status
const message = err.response?.data?.message ?? err.message
// Response data is untyped: keep a non-string code out of the string
// contract, so callers comparing against it cannot match on a surprise.
const rawCode: unknown = err.response?.data?.code
const code = typeof rawCode === 'string' ? rawCode : undefined
throw new WorkspaceApiError(message, status, code)
}
throw err
}
export const workspaceApi = {
/**
* List all workspaces the user has access to
* GET /api/workspaces
*/
async list(): Promise<ListWorkspacesResponse> {
const headers = await getAuthHeaderOrThrow()
try {
const response = await workspaceApiClient.get<ListWorkspacesResponse>(
api.apiURL('/workspaces'),
{ headers }
)
return response.data
} catch (err) {
handleAxiosError(err)
}
},
/**
* Create a new workspace
* POST /api/workspaces
*/
async create(payload: CreateWorkspacePayload): Promise<WorkspaceWithRole> {
const headers = await getAuthHeaderOrThrow()
try {
const response = await workspaceApiClient.post<WorkspaceWithRole>(
api.apiURL('/workspaces'),
payload,
{ headers }
)
return response.data
} catch (err) {
handleAxiosError(err)
}
},
/**
* Update workspace name
* PATCH /api/workspaces/:id
*/
async update(
workspaceId: WorkspaceId,
payload: UpdateWorkspacePayload
): Promise<WorkspaceWithRole> {
const headers = await getAuthHeaderOrThrow()
try {
const response = await workspaceApiClient.patch<WorkspaceWithRole>(
api.apiURL(`/workspaces/${workspaceId}`),
payload,
{ headers }
)
return response.data
} catch (err) {
handleAxiosError(err)
}
},
/**
* Delete a workspace (owner only)
* DELETE /api/workspaces/:id
*/
async delete(workspaceId: WorkspaceId): Promise<void> {
const headers = await getAuthHeaderOrThrow()
try {
await workspaceApiClient.delete(
api.apiURL(`/workspaces/${workspaceId}`),
{
headers
}
)
} catch (err) {
handleAxiosError(err)
}
},
/**
* Leave the current workspace.
* POST /api/workspace/leave
*/
async leave(): Promise<void> {
const headers = await getAuthHeaderOrThrow()
try {
await workspaceApiClient.post(api.apiURL('/workspace/leave'), null, {
headers
})
} catch (err) {
handleAxiosError(err)
}
},
/**
* List workspace members (paginated).
* GET /api/workspace/members
*/
async listMembers(params?: ListMembersParams): Promise<ListMembersResponse> {
const headers = await getAuthHeaderOrThrow()
try {
const response = await workspaceApiClient.get<ListMembersResponse>(
api.apiURL('/workspace/members'),
{ headers, params }
)
return response.data
} catch (err) {
handleAxiosError(err)
}
},
/**
* Remove a member from the workspace.
* DELETE /api/workspace/members/:userId
*/
async removeMember(userId: UserId): Promise<void> {
const headers = await getAuthHeaderOrThrow()
try {
await workspaceApiClient.delete(
api.apiURL(`/workspace/members/${userId}`),
{ headers }
)
} catch (err) {
handleAxiosError(err)
}
},
/**
* Change a member's role (member ↔ owner).
* PATCH /api/workspace/members/:userId
*/
async updateMemberRole(userId: UserId, role: WorkspaceRole): Promise<Member> {
const headers = await getAuthHeaderOrThrow()
try {
const response = await workspaceApiClient.patch<Member>(
api.apiURL(`/workspace/members/${userId}`),
{ role },
{ headers }
)
return response.data
} catch (err) {
handleAxiosError(err)
}
},
/**
* List pending invites for the workspace.
* GET /api/workspace/invites
*/
async listInvites(): Promise<ListInvitesResponse> {
const headers = await getAuthHeaderOrThrow()
try {
const response = await workspaceApiClient.get<ListInvitesResponse>(
api.apiURL('/workspace/invites'),
{ headers }
)
return response.data
} catch (err) {
handleAxiosError(err)
}
},
/**
* Create an invite for the workspace.
* POST /api/workspace/invites
*/
async createInvite(payload: CreateInviteRequest): Promise<PendingInvite> {
const headers = await getAuthHeaderOrThrow()
try {
const response = await workspaceApiClient.post<PendingInvite>(
api.apiURL('/workspace/invites'),
payload,
{ headers }
)
return response.data
} catch (err) {
handleAxiosError(err)
}
},
/**
* Revoke a pending invite.
* DELETE /api/workspace/invites/:inviteId
*/
async revokeInvite(inviteId: WorkspaceInviteId): Promise<void> {
const headers = await getAuthHeaderOrThrow()
try {
await workspaceApiClient.delete(
api.apiURL(`/workspace/invites/${inviteId}`),
{ headers }
)
} catch (err) {
handleAxiosError(err)
}
},
async resendInvite(inviteId: WorkspaceInviteId): Promise<PendingInvite> {
const headers = await getAuthHeaderOrThrow()
try {
const response = await workspaceApiClient.post<PendingInvite>(
api.apiURL(`/workspace/invites/${encodeURIComponent(inviteId)}/resend`),
null,
{ headers }
)
return response.data
} catch (err) {
handleAxiosError(err)
}
},
/**
* Accept a workspace invite.
* POST /api/invites/:token/accept
* Uses Firebase auth (user identity) since the user isn't yet a workspace member.
*/
async acceptInvite(token: string): Promise<AcceptInviteResponse> {
const headers = await useAuthStore().getFirebaseAuthHeaderOrThrow()
try {
const response = await workspaceApiClient.post<AcceptInviteResponse>(
api.apiURL(`/invites/${token}/accept`),
null,
{ headers, __skipUnifiedRemint: true }
)
return response.data
} catch (err) {
handleAxiosError(err)
}
},
/**
* Get billing status for the current workspace
* GET /api/billing/status
*/
async getBillingStatus(): Promise<BillingStatusResponse> {
const headers = await getAuthHeaderOrThrow()
try {
const response = await workspaceApiClient.get<BillingStatusResponse>(
api.apiURL('/billing/status'),
{ headers }
)
return response.data
} catch (err) {
handleAxiosError(err)
}
},
/**
* Get credit balance for the current workspace
* GET /api/billing/balance
*/
async getBillingBalance(): Promise<BillingBalanceResponse> {
const headers = await getAuthHeaderOrThrow()
try {
const response = await workspaceApiClient.get<BillingBalanceResponse>(
api.apiURL('/billing/balance'),
{ headers }
)
return response.data
} catch (err) {
handleAxiosError(err)
}
},
/**
* Get available subscription plans
* GET /api/billing/plans
*/
async getBillingPlans(): Promise<BillingPlansResponse> {
const headers = await getAuthHeaderOrThrow()
try {
const response = await workspaceApiClient.get<BillingPlansResponse>(
api.apiURL('/billing/plans'),
{ headers }
)
return response.data
} catch (err) {
handleAxiosError(err)
}
},
/**
* Preview subscription change
* POST /api/billing/preview-subscribe
*/
async previewSubscribe(
planSlug: string,
options: PreviewSubscribeOptions = {}
): Promise<PreviewSubscribeResponse> {
const headers = await getAuthHeaderOrThrow()
try {
const response = await workspaceApiClient.post<PreviewSubscribeResponse>(
api.apiURL('/billing/preview-subscribe'),
{
plan_slug: planSlug,
team_credit_stop_id: options.teamCreditStopId,
billing_cycle: options.billingCycle
} satisfies PreviewSubscribeRequest,
{ headers }
)
return response.data
} catch (err) {
handleAxiosError(err)
}
},
/**
* Subscribe to a billing plan
* POST /api/billing/subscribe
*/
async subscribe(
planSlug: string,
options: SubscribeOptions = {}
): Promise<SubscribeResponse> {
const headers = await getAuthHeaderOrThrow()
try {
const response = await workspaceApiClient.post<SubscribeResponse>(
api.apiURL('/billing/subscribe'),
{
plan_slug: planSlug,
return_url: options.returnUrl,
cancel_url: options.cancelUrl,
team_credit_stop_id: options.teamCreditStopId,
billing_cycle: options.billingCycle,
confirm_reactivation: options.confirmReactivation
} satisfies SubscribeRequest,
{ headers }
)
return response.data
} catch (err) {
handleAxiosError(err)
}
},
/**
* Cancel current subscription
* POST /api/billing/subscription/cancel
*/
async cancelSubscription(
idempotencyKey?: string
): Promise<CancelSubscriptionResponse> {
const headers = await getAuthHeaderOrThrow()
try {
const response =
await workspaceApiClient.post<CancelSubscriptionResponse>(
api.apiURL('/billing/subscription/cancel'),
{
idempotency_key: idempotencyKey
} satisfies CancelSubscriptionRequest,
{ headers }
)
return response.data
} catch (err) {
handleAxiosError(err)
}
},
/**
* Resubscribe (undo cancel) before period ends
* POST /api/billing/subscription/resubscribe
*/
async resubscribe(idempotencyKey?: string): Promise<ResubscribeResponse> {
const headers = await getAuthHeaderOrThrow()
try {
const response = await workspaceApiClient.post<ResubscribeResponse>(
api.apiURL('/billing/subscription/resubscribe'),
{ idempotency_key: idempotencyKey } satisfies ResubscribeRequest,
{ headers }
)
return response.data
} catch (err) {
handleAxiosError(err)
}
},
/**
* Get Stripe payment portal URL for managing payment methods
* POST /api/billing/payment-portal
*/
async getPaymentPortalUrl(
returnUrl?: string
): Promise<PaymentPortalResponse> {
const headers = await getAuthHeaderOrThrow()
try {
const response = await workspaceApiClient.post<PaymentPortalResponse>(
api.apiURL('/billing/payment-portal'),
{ return_url: returnUrl } satisfies PaymentPortalRequest,
{ headers }
)
return response.data
} catch (err) {
handleAxiosError(err)
}
},
/**
* Create a credit top-up
* POST /api/billing/topup
*/
async createTopup(
amountCents: number,
idempotencyKey?: string
): Promise<CreateTopupResponse> {
const headers = await getAuthHeaderOrThrow()
try {
const response = await workspaceApiClient.post<CreateTopupResponse>(
api.apiURL('/billing/topup'),
{
amount_cents: amountCents,
idempotency_key: idempotencyKey
} satisfies CreateTopupRequest,
{ headers }
)
return response.data
} catch (err) {
handleAxiosError(err)
}
},
/**
* Get billing events
* GET /api/billing/events
*/
async getBillingEvents(
params?: GetBillingEventsParams
): Promise<BillingEventsResponse> {
const headers = await getAuthHeaderOrThrow()
try {
const response = await workspaceApiClient.get<BillingEventsResponse>(
api.apiURL('/billing/events'),
{ headers, params }
)
return response.data
} catch (err) {
handleAxiosError(err)
}
},
/**
* Get billing operation status
* GET /api/billing/ops/:id
*/
async getBillingOpStatus(opId: string): Promise<BillingOpStatusResponse> {
const headers = await getAuthHeaderOrThrow()
try {
const response = await workspaceApiClient.get<BillingOpStatusResponse>(
api.apiURL(`/billing/ops/${opId}`),
{ headers }
)
return response.data
} catch (err) {
handleAxiosError(err)
}
}
}