@farm.js/polar 0.1.0-beta.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 +22 -0
- package/README.md +11 -0
- package/dist/client.d.ts +245 -0
- package/dist/client.d.ts.map +1 -0
- package/dist/client.js +75 -0
- package/dist/index.d.ts +163 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +1088 -0
- package/package.json +42 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2024 Farm.js Team
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
22
|
+
|
package/README.md
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# @farm.js/polar
|
|
2
|
+
|
|
3
|
+
Polar billing integration for Farm.js
|
|
4
|
+
|
|
5
|
+
Farm.js is currently in beta.
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @farm.js/polar@beta
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
See the [Farm.js repository](https://github.com/farming-labs/farm.js) for documentation, examples, and support.
|
package/dist/client.d.ts
ADDED
|
@@ -0,0 +1,245 @@
|
|
|
1
|
+
import type { FarmIntegrationAPIOperation } from "@farm.js/core/client";
|
|
2
|
+
import { type InferPathInferredClientAPI, type PathInferredClientOperation } from "@farm.js/integration-utils/integration";
|
|
3
|
+
export type PolarBillingStatus = "free" | "trialing" | "active" | "past_due" | "canceled" | "unpaid" | "incomplete";
|
|
4
|
+
export type PolarBillingMeterState = "ok" | "soft_limit_reached" | "hard_limit_reached" | "blocked_past_due" | "customer_missing" | "meter_missing";
|
|
5
|
+
export type PolarBillingUsageProperties = Record<string, string | number | boolean>;
|
|
6
|
+
export type PolarBillingProductKind = "subscription" | "one_time";
|
|
7
|
+
export interface PolarCatalogMeterPrice {
|
|
8
|
+
key: string;
|
|
9
|
+
eventName: string;
|
|
10
|
+
meterId: string;
|
|
11
|
+
unit: string | null;
|
|
12
|
+
currency: string | null;
|
|
13
|
+
unitAmountDecimal: string | null;
|
|
14
|
+
capAmount: number | null;
|
|
15
|
+
summary: string | null;
|
|
16
|
+
}
|
|
17
|
+
export interface PolarCatalogProduct {
|
|
18
|
+
id: string;
|
|
19
|
+
productId: string | null;
|
|
20
|
+
name: string;
|
|
21
|
+
description: string | null;
|
|
22
|
+
kind: PolarBillingProductKind;
|
|
23
|
+
planId: string | null;
|
|
24
|
+
trialDays: number | null;
|
|
25
|
+
public: boolean;
|
|
26
|
+
currency: string | null;
|
|
27
|
+
unitAmount: number | null;
|
|
28
|
+
interval: "day" | "week" | "month" | "year" | null;
|
|
29
|
+
intervalCount: number | null;
|
|
30
|
+
meterPrices: PolarCatalogMeterPrice[];
|
|
31
|
+
metadata: Record<string, string>;
|
|
32
|
+
}
|
|
33
|
+
export interface PolarCheckoutInput {
|
|
34
|
+
productId: string;
|
|
35
|
+
customerEmail?: string;
|
|
36
|
+
successPath?: string;
|
|
37
|
+
cancelPath?: string;
|
|
38
|
+
metadata?: Record<string, string>;
|
|
39
|
+
}
|
|
40
|
+
export interface PolarCheckoutResult {
|
|
41
|
+
productId: string;
|
|
42
|
+
planId: string | null;
|
|
43
|
+
checkoutId: string;
|
|
44
|
+
redirectTo: string;
|
|
45
|
+
mode: "payment" | "subscription";
|
|
46
|
+
}
|
|
47
|
+
export interface PolarPortalInput {
|
|
48
|
+
returnTo?: string;
|
|
49
|
+
}
|
|
50
|
+
export interface PolarPortalResult {
|
|
51
|
+
customerId: string;
|
|
52
|
+
redirectTo: string;
|
|
53
|
+
}
|
|
54
|
+
export interface PolarBillingStatusResult {
|
|
55
|
+
owner: {
|
|
56
|
+
kind: "user" | "organization";
|
|
57
|
+
id: string;
|
|
58
|
+
email?: string;
|
|
59
|
+
} | null;
|
|
60
|
+
externalCustomerId: string | null;
|
|
61
|
+
customerId: string | null;
|
|
62
|
+
planId: string;
|
|
63
|
+
productId: string | null;
|
|
64
|
+
status: PolarBillingStatus;
|
|
65
|
+
subscriptionId: string | null;
|
|
66
|
+
currentPeriodStart: string | null;
|
|
67
|
+
currentPeriodEnd: string | null;
|
|
68
|
+
cancelAtPeriodEnd: boolean;
|
|
69
|
+
trialEndsAt: string | null;
|
|
70
|
+
features: Record<string, boolean>;
|
|
71
|
+
limits: Record<string, number>;
|
|
72
|
+
entitlements: Record<string, unknown>;
|
|
73
|
+
}
|
|
74
|
+
export interface PolarBillingFeaturesResult {
|
|
75
|
+
planId: string;
|
|
76
|
+
features: Record<string, boolean>;
|
|
77
|
+
}
|
|
78
|
+
export interface PolarBillingLimitsResult {
|
|
79
|
+
planId: string;
|
|
80
|
+
limits: Record<string, number>;
|
|
81
|
+
}
|
|
82
|
+
export interface PolarBillingUsageInput {
|
|
83
|
+
key: string;
|
|
84
|
+
}
|
|
85
|
+
export interface PolarBillingUsageResult {
|
|
86
|
+
planId: string;
|
|
87
|
+
key: string;
|
|
88
|
+
used: number | null;
|
|
89
|
+
limit: number | null;
|
|
90
|
+
remaining: number | null;
|
|
91
|
+
}
|
|
92
|
+
export interface PolarBillingMeterUsageInput {
|
|
93
|
+
key: string;
|
|
94
|
+
}
|
|
95
|
+
export interface PolarBillingMeterUsageResult {
|
|
96
|
+
planId: string;
|
|
97
|
+
productId: string | null;
|
|
98
|
+
key: string;
|
|
99
|
+
eventName: string;
|
|
100
|
+
meterId: string;
|
|
101
|
+
meterName: string | null;
|
|
102
|
+
aggregation: string;
|
|
103
|
+
quantityMetadataKey: string | null;
|
|
104
|
+
activeMeterIds: string[];
|
|
105
|
+
customerId: string | null;
|
|
106
|
+
subscriptionId: string | null;
|
|
107
|
+
subscriptionStatus: PolarBillingStatus;
|
|
108
|
+
currentPeriodStart: string | null;
|
|
109
|
+
currentPeriodEnd: string | null;
|
|
110
|
+
currentPeriodUsed: number;
|
|
111
|
+
creditedUnits: number | null;
|
|
112
|
+
balance: number | null;
|
|
113
|
+
currency: string | null;
|
|
114
|
+
baseSubscriptionAmount: number | null;
|
|
115
|
+
meterUnitAmount: string | null;
|
|
116
|
+
meterCapAmount: number | null;
|
|
117
|
+
chargeSource: "subscription_meter" | "catalog_rate";
|
|
118
|
+
estimatedMeterChargeAmount: number | null;
|
|
119
|
+
estimatedCombinedAmount: number | null;
|
|
120
|
+
includedLimit: number | null;
|
|
121
|
+
softLimit: number | null;
|
|
122
|
+
hardLimit: number | null;
|
|
123
|
+
remainingIncluded: number | null;
|
|
124
|
+
remainingHard: number | null;
|
|
125
|
+
state: PolarBillingMeterState;
|
|
126
|
+
warning: string | null;
|
|
127
|
+
}
|
|
128
|
+
export type PolarBillingCurrentChargeLineKind = "base_subscription" | "metered_usage";
|
|
129
|
+
export interface PolarBillingCurrentChargeLine {
|
|
130
|
+
key: string | null;
|
|
131
|
+
kind: PolarBillingCurrentChargeLineKind;
|
|
132
|
+
label: string;
|
|
133
|
+
amount: number | null;
|
|
134
|
+
currency: string;
|
|
135
|
+
quantity: number | null;
|
|
136
|
+
includedUnits: number | null;
|
|
137
|
+
overageUnits: number | null;
|
|
138
|
+
billedBuckets: number | null;
|
|
139
|
+
billingUnits: number | null;
|
|
140
|
+
unitAmountDecimal: string | null;
|
|
141
|
+
}
|
|
142
|
+
export interface PolarBillingCurrentChargesResult {
|
|
143
|
+
owner: {
|
|
144
|
+
kind: "user" | "organization";
|
|
145
|
+
id: string;
|
|
146
|
+
email?: string;
|
|
147
|
+
} | null;
|
|
148
|
+
externalCustomerId: string | null;
|
|
149
|
+
customerId: string | null;
|
|
150
|
+
planId: string;
|
|
151
|
+
productId: string | null;
|
|
152
|
+
subscriptionId: string | null;
|
|
153
|
+
subscriptionStatus: PolarBillingStatus;
|
|
154
|
+
currency: string;
|
|
155
|
+
currentPeriodStart: string | null;
|
|
156
|
+
currentPeriodEnd: string | null;
|
|
157
|
+
baseSubscriptionAmount: number | null;
|
|
158
|
+
pendingMeterChargeAmount: number | null;
|
|
159
|
+
estimatedTotalAmount: number | null;
|
|
160
|
+
lineItems: PolarBillingCurrentChargeLine[];
|
|
161
|
+
}
|
|
162
|
+
export interface PolarBillingReportUsageInput {
|
|
163
|
+
key: string;
|
|
164
|
+
quantity: number;
|
|
165
|
+
idempotencyKey: string;
|
|
166
|
+
occurredAt?: string;
|
|
167
|
+
properties?: PolarBillingUsageProperties;
|
|
168
|
+
}
|
|
169
|
+
export interface PolarBillingReportUsageResult {
|
|
170
|
+
key: string;
|
|
171
|
+
quantity: number;
|
|
172
|
+
customerId: string | null;
|
|
173
|
+
eventName: string;
|
|
174
|
+
eventIdentifier: string;
|
|
175
|
+
occurredAt: string;
|
|
176
|
+
currentPeriodUsed: number | null;
|
|
177
|
+
projectedCurrentPeriodUsed: number | null;
|
|
178
|
+
softLimit: number | null;
|
|
179
|
+
hardLimit: number | null;
|
|
180
|
+
state: PolarBillingMeterState;
|
|
181
|
+
warning: string | null;
|
|
182
|
+
}
|
|
183
|
+
export interface PolarBillingCheckInput {
|
|
184
|
+
key: string;
|
|
185
|
+
amount?: number;
|
|
186
|
+
}
|
|
187
|
+
export interface PolarBillingCheckResult {
|
|
188
|
+
planId: string;
|
|
189
|
+
key: string;
|
|
190
|
+
amount: number;
|
|
191
|
+
used: number | null;
|
|
192
|
+
limit: number | null;
|
|
193
|
+
remaining: number | null;
|
|
194
|
+
allowed: boolean;
|
|
195
|
+
}
|
|
196
|
+
export interface PolarClientPathOptions {
|
|
197
|
+
productsPath?: string;
|
|
198
|
+
statusPath?: string;
|
|
199
|
+
currentChargesPath?: string;
|
|
200
|
+
featuresPath?: string;
|
|
201
|
+
limitsPath?: string;
|
|
202
|
+
usagePath?: string;
|
|
203
|
+
meterUsagePath?: string;
|
|
204
|
+
reportUsagePath?: string;
|
|
205
|
+
checkPath?: string;
|
|
206
|
+
checkoutPath?: string;
|
|
207
|
+
portalPath?: string;
|
|
208
|
+
}
|
|
209
|
+
type ResolvedPolarClientPath<TPath extends string | undefined, TDefault extends string> = TPath extends string ? TPath : TDefault;
|
|
210
|
+
type PolarDefaultClientPaths = {
|
|
211
|
+
productsPath: "/billing/products";
|
|
212
|
+
statusPath: "/billing/status";
|
|
213
|
+
currentChargesPath: "/billing/current-charges";
|
|
214
|
+
featuresPath: "/billing/features";
|
|
215
|
+
limitsPath: "/billing/limits";
|
|
216
|
+
usagePath: "/billing/usage";
|
|
217
|
+
meterUsagePath: "/billing/meter-usage";
|
|
218
|
+
reportUsagePath: "/billing/report-usage";
|
|
219
|
+
checkPath: "/billing/check";
|
|
220
|
+
checkoutPath: "/billing/checkout";
|
|
221
|
+
portalPath: "/billing/portal";
|
|
222
|
+
};
|
|
223
|
+
type PolarGetOperation<TResponse> = FarmIntegrationAPIOperation<never, never, TResponse, false, "GET">;
|
|
224
|
+
type PolarPostOperation<TBody, TResponse> = FarmIntegrationAPIOperation<TBody, never, TResponse, false, "POST">;
|
|
225
|
+
type PolarClientEntry<TPath extends string, TOperation extends FarmIntegrationAPIOperation<any, any, any, any, any>> = PathInferredClientOperation<TPath, TOperation>;
|
|
226
|
+
type PolarClientEntries<TInput extends PolarClientPathOptions = {}> = [
|
|
227
|
+
PolarClientEntry<ResolvedPolarClientPath<TInput["productsPath"], "/billing/products">, PolarGetOperation<PolarCatalogProduct[]>>,
|
|
228
|
+
PolarClientEntry<ResolvedPolarClientPath<TInput["statusPath"], "/billing/status">, PolarGetOperation<PolarBillingStatusResult>>,
|
|
229
|
+
PolarClientEntry<ResolvedPolarClientPath<TInput["currentChargesPath"], "/billing/current-charges">, PolarGetOperation<PolarBillingCurrentChargesResult>>,
|
|
230
|
+
PolarClientEntry<ResolvedPolarClientPath<TInput["featuresPath"], "/billing/features">, PolarGetOperation<PolarBillingFeaturesResult>>,
|
|
231
|
+
PolarClientEntry<ResolvedPolarClientPath<TInput["limitsPath"], "/billing/limits">, PolarGetOperation<PolarBillingLimitsResult>>,
|
|
232
|
+
PolarClientEntry<ResolvedPolarClientPath<TInput["usagePath"], "/billing/usage">, PolarPostOperation<PolarBillingUsageInput, PolarBillingUsageResult>>,
|
|
233
|
+
PolarClientEntry<ResolvedPolarClientPath<TInput["meterUsagePath"], "/billing/meter-usage">, PolarPostOperation<PolarBillingMeterUsageInput, PolarBillingMeterUsageResult>>,
|
|
234
|
+
PolarClientEntry<ResolvedPolarClientPath<TInput["reportUsagePath"], "/billing/report-usage">, PolarPostOperation<PolarBillingReportUsageInput, PolarBillingReportUsageResult>>,
|
|
235
|
+
PolarClientEntry<ResolvedPolarClientPath<TInput["checkPath"], "/billing/check">, PolarPostOperation<PolarBillingCheckInput, PolarBillingCheckResult>>,
|
|
236
|
+
PolarClientEntry<ResolvedPolarClientPath<TInput["checkoutPath"], "/billing/checkout">, PolarPostOperation<PolarCheckoutInput, PolarCheckoutResult>>,
|
|
237
|
+
PolarClientEntry<ResolvedPolarClientPath<TInput["portalPath"], "/billing/portal">, PolarPostOperation<PolarPortalInput, PolarPortalResult>>
|
|
238
|
+
];
|
|
239
|
+
export type PolarClientAPI<TInput extends PolarClientPathOptions = {}> = InferPathInferredClientAPI<PolarClientEntries<TInput>>;
|
|
240
|
+
export type PolarDefaultClientAPI = InferPathInferredClientAPI<PolarClientEntries<PolarDefaultClientPaths>>;
|
|
241
|
+
export declare function createPolarClientApi(): PolarDefaultClientAPI;
|
|
242
|
+
export declare function createPolarClientApi<const TInput extends PolarClientPathOptions>(input: TInput): PolarClientAPI<TInput>;
|
|
243
|
+
export declare const polarClient: PolarDefaultClientAPI;
|
|
244
|
+
export {};
|
|
245
|
+
//# sourceMappingURL=client.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,sBAAsB,CAAC;AAExE,OAAO,EAEL,KAAK,0BAA0B,EAC/B,KAAK,2BAA2B,EACjC,MAAM,wCAAwC,CAAC;AAEhD,MAAM,MAAM,kBAAkB,GAC1B,MAAM,GACN,UAAU,GACV,QAAQ,GACR,UAAU,GACV,UAAU,GACV,QAAQ,GACR,YAAY,CAAC;AAEjB,MAAM,MAAM,sBAAsB,GAC9B,IAAI,GACJ,oBAAoB,GACpB,oBAAoB,GACpB,kBAAkB,GAClB,kBAAkB,GAClB,eAAe,CAAC;AAEpB,MAAM,MAAM,2BAA2B,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;AAEpF,MAAM,MAAM,uBAAuB,GAAG,cAAc,GAAG,UAAU,CAAC;AAElE,MAAM,WAAW,sBAAsB;IACrC,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,IAAI,EAAE,uBAAuB,CAAC;IAC9B,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,MAAM,EAAE,OAAO,CAAC;IAChB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,QAAQ,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI,CAAC;IACnD,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,WAAW,EAAE,sBAAsB,EAAE,CAAC;IACtC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC;AAED,MAAM,WAAW,kBAAkB;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,mBAAmB;IAClC,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,SAAS,GAAG,cAAc,CAAC;CAClC;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,iBAAiB;IAChC,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE;QACL,IAAI,EAAE,MAAM,GAAG,cAAc,CAAC;QAC9B,EAAE,EAAE,MAAM,CAAC;QACX,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,GAAG,IAAI,CAAC;IACT,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,MAAM,EAAE,kBAAkB,CAAC;IAC3B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,iBAAiB,EAAE,OAAO,CAAC;IAC3B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACvC;AAED,MAAM,WAAW,0BAA0B;IACzC,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,wBAAwB;IACvC,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAChC;AAED,MAAM,WAAW,sBAAsB;IACrC,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,2BAA2B;IAC1C,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,4BAA4B;IAC3C,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,kBAAkB,EAAE,kBAAkB,CAAC;IACvC,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,sBAAsB,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,YAAY,EAAE,oBAAoB,GAAG,cAAc,CAAC;IACpD,0BAA0B,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1C,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAC;IACvC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,KAAK,EAAE,sBAAsB,CAAC;IAC9B,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,MAAM,iCAAiC,GAAG,mBAAmB,GAAG,eAAe,CAAC;AAEtF,MAAM,WAAW,6BAA6B;IAC5C,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,IAAI,EAAE,iCAAiC,CAAC;IACxC,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;CAClC;AAED,MAAM,WAAW,gCAAgC;IAC/C,KAAK,EAAE;QACL,IAAI,EAAE,MAAM,GAAG,cAAc,CAAC;QAC9B,EAAE,EAAE,MAAM,CAAC;QACX,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,GAAG,IAAI,CAAC;IACT,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,kBAAkB,EAAE,kBAAkB,CAAC;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,sBAAsB,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC,wBAAwB,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,SAAS,EAAE,6BAA6B,EAAE,CAAC;CAC5C;AAED,MAAM,WAAW,4BAA4B;IAC3C,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,2BAA2B,CAAC;CAC1C;AAED,MAAM,WAAW,6BAA6B;IAC5C,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,0BAA0B,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1C,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,KAAK,EAAE,sBAAsB,CAAC;IAC9B,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,WAAW,sBAAsB;IACrC,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,sBAAsB;IACrC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,KAAK,uBAAuB,CAC1B,KAAK,SAAS,MAAM,GAAG,SAAS,EAChC,QAAQ,SAAS,MAAM,IACrB,KAAK,SAAS,MAAM,GAAG,KAAK,GAAG,QAAQ,CAAC;AAE5C,KAAK,uBAAuB,GAAG;IAC7B,YAAY,EAAE,mBAAmB,CAAC;IAClC,UAAU,EAAE,iBAAiB,CAAC;IAC9B,kBAAkB,EAAE,0BAA0B,CAAC;IAC/C,YAAY,EAAE,mBAAmB,CAAC;IAClC,UAAU,EAAE,iBAAiB,CAAC;IAC9B,SAAS,EAAE,gBAAgB,CAAC;IAC5B,cAAc,EAAE,sBAAsB,CAAC;IACvC,eAAe,EAAE,uBAAuB,CAAC;IACzC,SAAS,EAAE,gBAAgB,CAAC;IAC5B,YAAY,EAAE,mBAAmB,CAAC;IAClC,UAAU,EAAE,iBAAiB,CAAC;CAC/B,CAAC;AAEF,KAAK,iBAAiB,CAAC,SAAS,IAAI,2BAA2B,CAC7D,KAAK,EACL,KAAK,EACL,SAAS,EACT,KAAK,EACL,KAAK,CACN,CAAC;AAEF,KAAK,kBAAkB,CAAC,KAAK,EAAE,SAAS,IAAI,2BAA2B,CACrE,KAAK,EACL,KAAK,EACL,SAAS,EACT,KAAK,EACL,MAAM,CACP,CAAC;AAEF,KAAK,gBAAgB,CACnB,KAAK,SAAS,MAAM,EACpB,UAAU,SAAS,2BAA2B,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,IACrE,2BAA2B,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;AAEnD,KAAK,kBAAkB,CAAC,MAAM,SAAS,sBAAsB,GAAG,EAAE,IAAI;IACpE,gBAAgB,CACd,uBAAuB,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,mBAAmB,CAAC,EACpE,iBAAiB,CAAC,mBAAmB,EAAE,CAAC,CACzC;IACD,gBAAgB,CACd,uBAAuB,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,iBAAiB,CAAC,EAChE,iBAAiB,CAAC,wBAAwB,CAAC,CAC5C;IACD,gBAAgB,CACd,uBAAuB,CAAC,MAAM,CAAC,oBAAoB,CAAC,EAAE,0BAA0B,CAAC,EACjF,iBAAiB,CAAC,gCAAgC,CAAC,CACpD;IACD,gBAAgB,CACd,uBAAuB,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,mBAAmB,CAAC,EACpE,iBAAiB,CAAC,0BAA0B,CAAC,CAC9C;IACD,gBAAgB,CACd,uBAAuB,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,iBAAiB,CAAC,EAChE,iBAAiB,CAAC,wBAAwB,CAAC,CAC5C;IACD,gBAAgB,CACd,uBAAuB,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,gBAAgB,CAAC,EAC9D,kBAAkB,CAAC,sBAAsB,EAAE,uBAAuB,CAAC,CACpE;IACD,gBAAgB,CACd,uBAAuB,CAAC,MAAM,CAAC,gBAAgB,CAAC,EAAE,sBAAsB,CAAC,EACzE,kBAAkB,CAAC,2BAA2B,EAAE,4BAA4B,CAAC,CAC9E;IACD,gBAAgB,CACd,uBAAuB,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAAE,uBAAuB,CAAC,EAC3E,kBAAkB,CAAC,4BAA4B,EAAE,6BAA6B,CAAC,CAChF;IACD,gBAAgB,CACd,uBAAuB,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,gBAAgB,CAAC,EAC9D,kBAAkB,CAAC,sBAAsB,EAAE,uBAAuB,CAAC,CACpE;IACD,gBAAgB,CACd,uBAAuB,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,mBAAmB,CAAC,EACpE,kBAAkB,CAAC,kBAAkB,EAAE,mBAAmB,CAAC,CAC5D;IACD,gBAAgB,CACd,uBAAuB,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,iBAAiB,CAAC,EAChE,kBAAkB,CAAC,gBAAgB,EAAE,iBAAiB,CAAC,CACxD;CACF,CAAC;AAEF,MAAM,MAAM,cAAc,CAAC,MAAM,SAAS,sBAAsB,GAAG,EAAE,IAAI,0BAA0B,CACjG,kBAAkB,CAAC,MAAM,CAAC,CAC3B,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG,0BAA0B,CAC5D,kBAAkB,CAAC,uBAAuB,CAAC,CAC5C,CAAC;AAEF,wBAAgB,oBAAoB,IAAI,qBAAqB,CAAC;AAC9D,wBAAgB,oBAAoB,CAAC,KAAK,CAAC,MAAM,SAAS,sBAAsB,EAC9E,KAAK,EAAE,MAAM,GACZ,cAAc,CAAC,MAAM,CAAC,CAAC;AAgI1B,eAAO,MAAM,WAAW,EAAE,qBAA8C,CAAC"}
|
package/dist/client.js
ADDED
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
import { api } from "@farm.js/core/client";
|
|
2
|
+
import { createPathInferredClientApi, } from "@farm.js/integration-utils/integration";
|
|
3
|
+
export function createPolarClientApi(input) {
|
|
4
|
+
const productsPath = (input?.productsPath ?? "/billing/products");
|
|
5
|
+
const statusPath = (input?.statusPath ?? "/billing/status");
|
|
6
|
+
const currentChargesPath = (input?.currentChargesPath ??
|
|
7
|
+
"/billing/current-charges");
|
|
8
|
+
const featuresPath = (input?.featuresPath ?? "/billing/features");
|
|
9
|
+
const limitsPath = (input?.limitsPath ?? "/billing/limits");
|
|
10
|
+
const usagePath = (input?.usagePath ?? "/billing/usage");
|
|
11
|
+
const meterUsagePath = (input?.meterUsagePath ??
|
|
12
|
+
"/billing/meter-usage");
|
|
13
|
+
const reportUsagePath = (input?.reportUsagePath ??
|
|
14
|
+
"/billing/report-usage");
|
|
15
|
+
const checkPath = (input?.checkPath ?? "/billing/check");
|
|
16
|
+
const checkoutPath = (input?.checkoutPath ?? "/billing/checkout");
|
|
17
|
+
const portalPath = (input?.portalPath ?? "/billing/portal");
|
|
18
|
+
return createPathInferredClientApi({
|
|
19
|
+
path: productsPath,
|
|
20
|
+
operation: api.get(productsPath, {
|
|
21
|
+
responseFormat: "json",
|
|
22
|
+
}),
|
|
23
|
+
}, {
|
|
24
|
+
path: statusPath,
|
|
25
|
+
operation: api.get(statusPath, {
|
|
26
|
+
responseFormat: "json",
|
|
27
|
+
}),
|
|
28
|
+
}, {
|
|
29
|
+
path: currentChargesPath,
|
|
30
|
+
operation: api.get(currentChargesPath, {
|
|
31
|
+
responseFormat: "json",
|
|
32
|
+
}),
|
|
33
|
+
}, {
|
|
34
|
+
path: featuresPath,
|
|
35
|
+
operation: api.get(featuresPath, {
|
|
36
|
+
responseFormat: "json",
|
|
37
|
+
}),
|
|
38
|
+
}, {
|
|
39
|
+
path: limitsPath,
|
|
40
|
+
operation: api.get(limitsPath, {
|
|
41
|
+
responseFormat: "json",
|
|
42
|
+
}),
|
|
43
|
+
}, {
|
|
44
|
+
path: usagePath,
|
|
45
|
+
operation: api.post(usagePath, {
|
|
46
|
+
responseFormat: "json",
|
|
47
|
+
}),
|
|
48
|
+
}, {
|
|
49
|
+
path: meterUsagePath,
|
|
50
|
+
operation: api.post(meterUsagePath, {
|
|
51
|
+
responseFormat: "json",
|
|
52
|
+
}),
|
|
53
|
+
}, {
|
|
54
|
+
path: reportUsagePath,
|
|
55
|
+
operation: api.post(reportUsagePath, {
|
|
56
|
+
responseFormat: "json",
|
|
57
|
+
}),
|
|
58
|
+
}, {
|
|
59
|
+
path: checkPath,
|
|
60
|
+
operation: api.post(checkPath, {
|
|
61
|
+
responseFormat: "json",
|
|
62
|
+
}),
|
|
63
|
+
}, {
|
|
64
|
+
path: checkoutPath,
|
|
65
|
+
operation: api.post(checkoutPath, {
|
|
66
|
+
responseFormat: "json",
|
|
67
|
+
}),
|
|
68
|
+
}, {
|
|
69
|
+
path: portalPath,
|
|
70
|
+
operation: api.post(portalPath, {
|
|
71
|
+
responseFormat: "json",
|
|
72
|
+
}),
|
|
73
|
+
});
|
|
74
|
+
}
|
|
75
|
+
export const polarClient = createPolarClientApi();
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,163 @@
|
|
|
1
|
+
import { Polar } from "@polar-sh/sdk";
|
|
2
|
+
import { validateEvent as validatePolarWebhookEvent } from "@polar-sh/sdk/webhooks";
|
|
3
|
+
import { type FarmIntegration, type FarmIntegrationHandlerContext, type FarmIntegrationLogger } from "@farm.js/core";
|
|
4
|
+
import type { FarmWebhookConfig, FarmWebhookEvent } from "@farm.js/integration-utils/webhooks";
|
|
5
|
+
import { type PolarBillingProductKind, type PolarClientAPI, type PolarDefaultClientAPI } from "./client.js";
|
|
6
|
+
export type { PolarBillingCurrentChargeLine, PolarBillingCurrentChargesResult, PolarBillingCheckInput, PolarBillingCheckResult, PolarBillingFeaturesResult, PolarBillingLimitsResult, PolarBillingMeterState, PolarBillingMeterUsageInput, PolarBillingMeterUsageResult, PolarBillingReportUsageInput, PolarBillingReportUsageResult, PolarBillingStatusResult, PolarBillingUsageInput, PolarClientAPI, PolarDefaultClientAPI, PolarBillingUsageProperties, PolarBillingUsageResult, PolarCatalogMeterPrice, PolarCatalogProduct, PolarCheckoutInput, PolarCheckoutResult, PolarPortalInput, PolarPortalResult, } from "./client.js";
|
|
7
|
+
export { polarClient } from "./client.js";
|
|
8
|
+
type PolarValidatedWebhookPayload = ReturnType<typeof validatePolarWebhookEvent>;
|
|
9
|
+
export interface PolarWebhookEvent extends FarmWebhookEvent<"polar", PolarValidatedWebhookPayload["type"], PolarValidatedWebhookPayload["data"], PolarValidatedWebhookPayload> {
|
|
10
|
+
}
|
|
11
|
+
export type PolarWebhookConfig = FarmWebhookConfig<PolarWebhookEvent>;
|
|
12
|
+
export type PolarBillingOwner = {
|
|
13
|
+
kind: "user" | "organization";
|
|
14
|
+
id: string;
|
|
15
|
+
email?: string;
|
|
16
|
+
};
|
|
17
|
+
export type PolarBillingFeatures = Record<string, boolean>;
|
|
18
|
+
export type PolarBillingLimits = Record<string, number>;
|
|
19
|
+
export type PolarBillingEntitlements = Record<string, unknown>;
|
|
20
|
+
export type PolarBillingMeterAggregation = "sum" | "count" | "last";
|
|
21
|
+
export type PolarBillingMeterIngestion = "raw" | "pre_aggregated";
|
|
22
|
+
export interface PolarBillingPlanLimitReference {
|
|
23
|
+
planId: string;
|
|
24
|
+
key?: string;
|
|
25
|
+
}
|
|
26
|
+
export type PolarBillingSoftLimit = "plan_limit" | number | PolarBillingPlanLimitReference | `plans.${string}.limit.${string}` | `plans.${string}.limits.${string}`;
|
|
27
|
+
export interface PolarBillingPlan {
|
|
28
|
+
public?: boolean;
|
|
29
|
+
features?: PolarBillingFeatures;
|
|
30
|
+
limits?: PolarBillingLimits;
|
|
31
|
+
entitlements?: PolarBillingEntitlements;
|
|
32
|
+
trial?: {
|
|
33
|
+
days: number;
|
|
34
|
+
oncePerOwner?: boolean;
|
|
35
|
+
};
|
|
36
|
+
}
|
|
37
|
+
export interface PolarBillingMeterGuard {
|
|
38
|
+
softLimit?: PolarBillingSoftLimit;
|
|
39
|
+
hardLimit?: number;
|
|
40
|
+
hardOverage?: number;
|
|
41
|
+
hardLimitByPlan?: Record<string, number>;
|
|
42
|
+
hardOverageByPlan?: Record<string, number>;
|
|
43
|
+
blockOnPastDue?: boolean;
|
|
44
|
+
}
|
|
45
|
+
export interface PolarBillingMeterProviderOptions {
|
|
46
|
+
meterId: string;
|
|
47
|
+
quantityMetadataKey?: string;
|
|
48
|
+
}
|
|
49
|
+
export interface PolarBillingProductStripeOptions {
|
|
50
|
+
priceId?: string;
|
|
51
|
+
seatPriceId?: string;
|
|
52
|
+
meterPriceIds?: Record<string, string>;
|
|
53
|
+
lookupKey?: string;
|
|
54
|
+
}
|
|
55
|
+
export interface PolarBillingProductPolarOptions {
|
|
56
|
+
productId?: string;
|
|
57
|
+
}
|
|
58
|
+
export interface PolarBillingMeter {
|
|
59
|
+
aggregation: PolarBillingMeterAggregation;
|
|
60
|
+
ingestion?: PolarBillingMeterIngestion;
|
|
61
|
+
window?: "hour" | "day";
|
|
62
|
+
eventName: string;
|
|
63
|
+
unit?: string;
|
|
64
|
+
guard?: PolarBillingMeterGuard;
|
|
65
|
+
polar?: PolarBillingMeterProviderOptions;
|
|
66
|
+
meterId?: string;
|
|
67
|
+
quantityMetadataKey?: string;
|
|
68
|
+
}
|
|
69
|
+
export interface PolarBillingProduct {
|
|
70
|
+
public?: boolean;
|
|
71
|
+
name?: string;
|
|
72
|
+
description?: string;
|
|
73
|
+
kind: PolarBillingProductKind;
|
|
74
|
+
planId?: string;
|
|
75
|
+
stripe?: PolarBillingProductStripeOptions;
|
|
76
|
+
polar?: PolarBillingProductPolarOptions;
|
|
77
|
+
productId?: string;
|
|
78
|
+
currency?: string;
|
|
79
|
+
unitAmount?: number;
|
|
80
|
+
interval?: "day" | "week" | "month" | "year";
|
|
81
|
+
intervalCount?: number;
|
|
82
|
+
metadata?: Record<string, string>;
|
|
83
|
+
}
|
|
84
|
+
export interface PolarBillingHookTools {
|
|
85
|
+
ctx: FarmIntegrationHandlerContext;
|
|
86
|
+
polar: Polar;
|
|
87
|
+
}
|
|
88
|
+
export interface PolarBillingUsageOptions {
|
|
89
|
+
resolve(owner: PolarBillingOwner, key: string, tools: PolarBillingHookTools): Promise<number | null> | number | null;
|
|
90
|
+
}
|
|
91
|
+
export interface PolarBillingHooks {
|
|
92
|
+
onUsageReported?(payload: {
|
|
93
|
+
owner: PolarBillingOwner;
|
|
94
|
+
key: string;
|
|
95
|
+
quantity: number;
|
|
96
|
+
idempotencyKey: string;
|
|
97
|
+
occurredAt: string;
|
|
98
|
+
eventName: string;
|
|
99
|
+
customerId: string | null;
|
|
100
|
+
projectedCurrentPeriodUsed: number | null;
|
|
101
|
+
}, tools: PolarBillingHookTools): Promise<void> | void;
|
|
102
|
+
}
|
|
103
|
+
export interface PolarBillingOptions {
|
|
104
|
+
resolveOwner(context: FarmIntegrationHandlerContext): Promise<PolarBillingOwner | null> | PolarBillingOwner | null;
|
|
105
|
+
resolveExternalCustomerId?(owner: PolarBillingOwner, tools: PolarBillingHookTools): Promise<string> | string;
|
|
106
|
+
plans?: Record<string, PolarBillingPlan>;
|
|
107
|
+
products?: Record<string, PolarBillingProduct>;
|
|
108
|
+
usage?: PolarBillingUsageOptions;
|
|
109
|
+
meters?: Record<string, PolarBillingMeter>;
|
|
110
|
+
hooks?: PolarBillingHooks;
|
|
111
|
+
}
|
|
112
|
+
export interface PolarIntegrationInput {
|
|
113
|
+
accessToken?: string;
|
|
114
|
+
server?: "sandbox" | "production";
|
|
115
|
+
appBaseUrl?: string;
|
|
116
|
+
webhooks?: PolarWebhookConfig;
|
|
117
|
+
productsPath?: string;
|
|
118
|
+
statusPath?: string;
|
|
119
|
+
currentChargesPath?: string;
|
|
120
|
+
featuresPath?: string;
|
|
121
|
+
limitsPath?: string;
|
|
122
|
+
usagePath?: string;
|
|
123
|
+
meterUsagePath?: string;
|
|
124
|
+
reportUsagePath?: string;
|
|
125
|
+
checkPath?: string;
|
|
126
|
+
checkoutPath?: string;
|
|
127
|
+
portalPath?: string;
|
|
128
|
+
billing: PolarBillingOptions;
|
|
129
|
+
log?: FarmIntegrationLogger;
|
|
130
|
+
}
|
|
131
|
+
type ResolvedPolarIntegrationPath<TPath extends string | undefined, TDefault extends string> = TPath extends string ? TPath : TDefault;
|
|
132
|
+
type PolarResolvedApiInput<TInput extends PolarIntegrationInput> = {
|
|
133
|
+
readonly productsPath: ResolvedPolarIntegrationPath<TInput["productsPath"], "/billing/products">;
|
|
134
|
+
readonly statusPath: ResolvedPolarIntegrationPath<TInput["statusPath"], "/billing/status">;
|
|
135
|
+
readonly currentChargesPath: ResolvedPolarIntegrationPath<TInput["currentChargesPath"], "/billing/current-charges">;
|
|
136
|
+
readonly featuresPath: ResolvedPolarIntegrationPath<TInput["featuresPath"], "/billing/features">;
|
|
137
|
+
readonly limitsPath: ResolvedPolarIntegrationPath<TInput["limitsPath"], "/billing/limits">;
|
|
138
|
+
readonly usagePath: ResolvedPolarIntegrationPath<TInput["usagePath"], "/billing/usage">;
|
|
139
|
+
readonly meterUsagePath: ResolvedPolarIntegrationPath<TInput["meterUsagePath"], "/billing/meter-usage">;
|
|
140
|
+
readonly reportUsagePath: ResolvedPolarIntegrationPath<TInput["reportUsagePath"], "/billing/report-usage">;
|
|
141
|
+
readonly checkPath: ResolvedPolarIntegrationPath<TInput["checkPath"], "/billing/check">;
|
|
142
|
+
readonly checkoutPath: ResolvedPolarIntegrationPath<TInput["checkoutPath"], "/billing/checkout">;
|
|
143
|
+
readonly portalPath: ResolvedPolarIntegrationPath<TInput["portalPath"], "/billing/portal">;
|
|
144
|
+
};
|
|
145
|
+
type PolarDefaultPathInput = {
|
|
146
|
+
productsPath?: undefined;
|
|
147
|
+
statusPath?: undefined;
|
|
148
|
+
currentChargesPath?: undefined;
|
|
149
|
+
featuresPath?: undefined;
|
|
150
|
+
limitsPath?: undefined;
|
|
151
|
+
usagePath?: undefined;
|
|
152
|
+
meterUsagePath?: undefined;
|
|
153
|
+
reportUsagePath?: undefined;
|
|
154
|
+
checkPath?: undefined;
|
|
155
|
+
checkoutPath?: undefined;
|
|
156
|
+
portalPath?: undefined;
|
|
157
|
+
};
|
|
158
|
+
type PolarIntegrationResult<TApi> = Omit<FarmIntegration, "api"> & {
|
|
159
|
+
api: TApi;
|
|
160
|
+
};
|
|
161
|
+
export declare function polar<const TInput extends PolarIntegrationInput & PolarDefaultPathInput>(input: TInput): PolarIntegrationResult<PolarDefaultClientAPI>;
|
|
162
|
+
export declare function polar<const TInput extends PolarIntegrationInput>(input: TInput): PolarIntegrationResult<PolarClientAPI<PolarResolvedApiInput<TInput>>>;
|
|
163
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AAKtC,OAAO,EACL,aAAa,IAAI,yBAAyB,EAE3C,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAGL,KAAK,eAAe,EAEpB,KAAK,6BAA6B,EAClC,KAAK,qBAAqB,EAC3B,MAAM,eAAe,CAAC;AAOvB,OAAO,KAAK,EAEV,iBAAiB,EACjB,gBAAgB,EACjB,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAYL,KAAK,uBAAuB,EAU5B,KAAK,cAAc,EACnB,KAAK,qBAAqB,EAK3B,MAAM,aAAa,CAAC;AAErB,YAAY,EACV,6BAA6B,EAC7B,gCAAgC,EAChC,sBAAsB,EACtB,uBAAuB,EACvB,0BAA0B,EAC1B,wBAAwB,EACxB,sBAAsB,EACtB,2BAA2B,EAC3B,4BAA4B,EAC5B,4BAA4B,EAC5B,6BAA6B,EAC7B,wBAAwB,EACxB,sBAAsB,EACtB,cAAc,EACd,qBAAqB,EACrB,2BAA2B,EAC3B,uBAAuB,EACvB,sBAAsB,EACtB,mBAAmB,EACnB,kBAAkB,EAClB,mBAAmB,EACnB,gBAAgB,EAChB,iBAAiB,GAClB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,KAAK,4BAA4B,GAAG,UAAU,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAEjF,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB,CACzD,OAAO,EACP,4BAA4B,CAAC,MAAM,CAAC,EACpC,4BAA4B,CAAC,MAAM,CAAC,EACpC,4BAA4B,CAC7B;CAAG;AAEJ,MAAM,MAAM,kBAAkB,GAAG,iBAAiB,CAAC,iBAAiB,CAAC,CAAC;AAEtE,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,MAAM,GAAG,cAAc,CAAC;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAC3D,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACxD,MAAM,MAAM,wBAAwB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAC/D,MAAM,MAAM,4BAA4B,GAAG,KAAK,GAAG,OAAO,GAAG,MAAM,CAAC;AACpE,MAAM,MAAM,0BAA0B,GAAG,KAAK,GAAG,gBAAgB,CAAC;AAClE,MAAM,WAAW,8BAA8B;IAC7C,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AACD,MAAM,MAAM,qBAAqB,GAC7B,YAAY,GACZ,MAAM,GACN,8BAA8B,GAC9B,SAAS,MAAM,UAAU,MAAM,EAAE,GACjC,SAAS,MAAM,WAAW,MAAM,EAAE,CAAC;AAEvC,MAAM,WAAW,gBAAgB;IAC/B,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,oBAAoB,CAAC;IAChC,MAAM,CAAC,EAAE,kBAAkB,CAAC;IAC5B,YAAY,CAAC,EAAE,wBAAwB,CAAC;IACxC,KAAK,CAAC,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;QACb,YAAY,CAAC,EAAE,OAAO,CAAC;KACxB,CAAC;CACH;AAED,MAAM,WAAW,sBAAsB;IACrC,SAAS,CAAC,EAAE,qBAAqB,CAAC;IAClC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzC,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC3C,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,gCAAgC;IAC/C,OAAO,EAAE,MAAM,CAAC;IAChB,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED,MAAM,WAAW,gCAAgC;IAC/C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACvC,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,+BAA+B;IAC9C,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,iBAAiB;IAChC,WAAW,EAAE,4BAA4B,CAAC;IAC1C,SAAS,CAAC,EAAE,0BAA0B,CAAC;IACvC,MAAM,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,sBAAsB,CAAC;IAC/B,KAAK,CAAC,EAAE,gCAAgC,CAAC;IACzC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,uBAAuB,CAAC;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,gCAAgC,CAAC;IAC1C,KAAK,CAAC,EAAE,+BAA+B,CAAC;IACxC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;IAC7C,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,qBAAqB;IACpC,GAAG,EAAE,6BAA6B,CAAC;IACnC,KAAK,EAAE,KAAK,CAAC;CACd;AAED,MAAM,WAAW,wBAAwB;IACvC,OAAO,CACL,KAAK,EAAE,iBAAiB,EACxB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,qBAAqB,GAC3B,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,MAAM,GAAG,IAAI,CAAC;CAC3C;AAED,MAAM,WAAW,iBAAiB;IAChC,eAAe,CAAC,CACd,OAAO,EAAE;QACP,KAAK,EAAE,iBAAiB,CAAC;QACzB,GAAG,EAAE,MAAM,CAAC;QACZ,QAAQ,EAAE,MAAM,CAAC;QACjB,cAAc,EAAE,MAAM,CAAC;QACvB,UAAU,EAAE,MAAM,CAAC;QACnB,SAAS,EAAE,MAAM,CAAC;QAClB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAC1B,0BAA0B,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3C,EACD,KAAK,EAAE,qBAAqB,GAC3B,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,mBAAmB;IAClC,YAAY,CACV,OAAO,EAAE,6BAA6B,GACrC,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC,GAAG,iBAAiB,GAAG,IAAI,CAAC;IAChE,yBAAyB,CAAC,CACxB,KAAK,EAAE,iBAAiB,EACxB,KAAK,EAAE,qBAAqB,GAC3B,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IACzC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;IAC/C,KAAK,CAAC,EAAE,wBAAwB,CAAC;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IAC3C,KAAK,CAAC,EAAE,iBAAiB,CAAC;CAC3B;AAED,MAAM,WAAW,qBAAqB;IACpC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,SAAS,GAAG,YAAY,CAAC;IAClC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,kBAAkB,CAAC;IAC9B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,mBAAmB,CAAC;IAC7B,GAAG,CAAC,EAAE,qBAAqB,CAAC;CAC7B;AAqCD,KAAK,4BAA4B,CAC/B,KAAK,SAAS,MAAM,GAAG,SAAS,EAChC,QAAQ,SAAS,MAAM,IACrB,KAAK,SAAS,MAAM,GAAG,KAAK,GAAG,QAAQ,CAAC;AAE5C,KAAK,qBAAqB,CAAC,MAAM,SAAS,qBAAqB,IAAI;IACjE,QAAQ,CAAC,YAAY,EAAE,4BAA4B,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,mBAAmB,CAAC,CAAC;IACjG,QAAQ,CAAC,UAAU,EAAE,4BAA4B,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,iBAAiB,CAAC,CAAC;IAC3F,QAAQ,CAAC,kBAAkB,EAAE,4BAA4B,CACvD,MAAM,CAAC,oBAAoB,CAAC,EAC5B,0BAA0B,CAC3B,CAAC;IACF,QAAQ,CAAC,YAAY,EAAE,4BAA4B,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,mBAAmB,CAAC,CAAC;IACjG,QAAQ,CAAC,UAAU,EAAE,4BAA4B,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,iBAAiB,CAAC,CAAC;IAC3F,QAAQ,CAAC,SAAS,EAAE,4BAA4B,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,gBAAgB,CAAC,CAAC;IACxF,QAAQ,CAAC,cAAc,EAAE,4BAA4B,CACnD,MAAM,CAAC,gBAAgB,CAAC,EACxB,sBAAsB,CACvB,CAAC;IACF,QAAQ,CAAC,eAAe,EAAE,4BAA4B,CACpD,MAAM,CAAC,iBAAiB,CAAC,EACzB,uBAAuB,CACxB,CAAC;IACF,QAAQ,CAAC,SAAS,EAAE,4BAA4B,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,gBAAgB,CAAC,CAAC;IACxF,QAAQ,CAAC,YAAY,EAAE,4BAA4B,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,mBAAmB,CAAC,CAAC;IACjG,QAAQ,CAAC,UAAU,EAAE,4BAA4B,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,iBAAiB,CAAC,CAAC;CAC5F,CAAC;AAEF,KAAK,qBAAqB,GAAG;IAC3B,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB,UAAU,CAAC,EAAE,SAAS,CAAC;IACvB,kBAAkB,CAAC,EAAE,SAAS,CAAC;IAC/B,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB,UAAU,CAAC,EAAE,SAAS,CAAC;IACvB,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,cAAc,CAAC,EAAE,SAAS,CAAC;IAC3B,eAAe,CAAC,EAAE,SAAS,CAAC;IAC5B,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB,UAAU,CAAC,EAAE,SAAS,CAAC;CACxB,CAAC;AAEF,KAAK,sBAAsB,CAAC,IAAI,IAAI,IAAI,CAAC,eAAe,EAAE,KAAK,CAAC,GAAG;IACjE,GAAG,EAAE,IAAI,CAAC;CACX,CAAC;AAikBF,wBAAgB,KAAK,CAAC,KAAK,CAAC,MAAM,SAAS,qBAAqB,GAAG,qBAAqB,EACtF,KAAK,EAAE,MAAM,GACZ,sBAAsB,CAAC,qBAAqB,CAAC,CAAC;AACjD,wBAAgB,KAAK,CAAC,KAAK,CAAC,MAAM,SAAS,qBAAqB,EAC9D,KAAK,EAAE,MAAM,GACZ,sBAAsB,CAAC,cAAc,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC"}
|