@referalli/sdk 0.0.0-stage → 0.3.20
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 +128 -0
- package/LICENSE +21 -0
- package/README.md +236 -2
- package/dist/cjs/attribution.d.ts +105 -0
- package/dist/cjs/attribution.js +200 -0
- package/dist/cjs/browser.d.ts +41 -0
- package/dist/cjs/browser.js +88 -0
- package/dist/cjs/client.d.ts +97 -0
- package/dist/cjs/client.js +301 -0
- package/dist/cjs/consent/adapters/cookiebot.d.ts +7 -0
- package/dist/cjs/consent/adapters/cookiebot.js +49 -0
- package/dist/cjs/consent/adapters/cookiemunch.d.ts +8 -0
- package/dist/cjs/consent/adapters/cookiemunch.js +56 -0
- package/dist/cjs/consent/adapters/custom.d.ts +8 -0
- package/dist/cjs/consent/adapters/custom.js +39 -0
- package/dist/cjs/consent/adapters/didomi.d.ts +9 -0
- package/dist/cjs/consent/adapters/didomi.js +67 -0
- package/dist/cjs/consent/adapters/gcm.d.ts +10 -0
- package/dist/cjs/consent/adapters/gcm.js +78 -0
- package/dist/cjs/consent/adapters/gpp.d.ts +9 -0
- package/dist/cjs/consent/adapters/gpp.js +92 -0
- package/dist/cjs/consent/adapters/none.d.ts +3 -0
- package/dist/cjs/consent/adapters/none.js +30 -0
- package/dist/cjs/consent/adapters/onetrust.d.ts +8 -0
- package/dist/cjs/consent/adapters/onetrust.js +71 -0
- package/dist/cjs/consent/adapters/osano.d.ts +9 -0
- package/dist/cjs/consent/adapters/osano.js +71 -0
- package/dist/cjs/consent/adapters/tcf.d.ts +8 -0
- package/dist/cjs/consent/adapters/tcf.js +79 -0
- package/dist/cjs/consent/adapters/termly.d.ts +10 -0
- package/dist/cjs/consent/adapters/termly.js +61 -0
- package/dist/cjs/consent/adapters/usercentrics.d.ts +9 -0
- package/dist/cjs/consent/adapters/usercentrics.js +106 -0
- package/dist/cjs/consent/conformance.d.ts +22 -0
- package/dist/cjs/consent/conformance.js +33 -0
- package/dist/cjs/consent/gate.d.ts +23 -0
- package/dist/cjs/consent/gate.js +220 -0
- package/dist/cjs/consent/port.d.ts +105 -0
- package/dist/cjs/consent/port.js +72 -0
- package/dist/cjs/consent/registry.d.ts +17 -0
- package/dist/cjs/consent/registry.js +61 -0
- package/dist/cjs/consent/served.d.ts +15 -0
- package/dist/cjs/consent/served.js +26 -0
- package/dist/cjs/core.d.ts +77 -0
- package/dist/cjs/core.js +64 -0
- package/dist/cjs/errors.d.ts +42 -0
- package/dist/cjs/errors.generated.d.ts +183 -0
- package/dist/cjs/errors.generated.js +279 -0
- package/dist/cjs/errors.js +47 -0
- package/dist/cjs/generated.d.ts +15146 -0
- package/dist/cjs/generated.js +625 -0
- package/dist/cjs/index.d.ts +22 -0
- package/dist/cjs/index.js +93 -0
- package/dist/cjs/mobile.d.ts +66 -0
- package/dist/cjs/mobile.js +69 -0
- package/dist/cjs/node.d.ts +209 -0
- package/dist/cjs/node.js +140 -0
- package/dist/cjs/outbox.d.ts +186 -0
- package/dist/cjs/outbox.js +324 -0
- package/dist/cjs/package.json +3 -0
- package/dist/cjs/resources.generated.d.ts +6002 -0
- package/dist/cjs/resources.generated.js +2090 -0
- package/dist/cjs/served.d.ts +25 -0
- package/dist/cjs/served.js +214 -0
- package/dist/cjs/sha256.d.ts +2 -0
- package/dist/cjs/sha256.js +86 -0
- package/dist/cjs/snippet.d.ts +99 -0
- package/dist/cjs/snippet.js +213 -0
- package/dist/cjs/stripe-events.d.ts +25 -0
- package/dist/cjs/stripe-events.js +117 -0
- package/dist/cjs/version.d.ts +2 -0
- package/dist/cjs/version.js +5 -0
- package/dist/cjs/webhooks.d.ts +76 -0
- package/dist/cjs/webhooks.js +159 -0
- package/dist/esm/attribution.d.ts +105 -0
- package/dist/esm/attribution.js +186 -0
- package/dist/esm/browser.d.ts +41 -0
- package/dist/esm/browser.js +68 -0
- package/dist/esm/client.d.ts +97 -0
- package/dist/esm/client.js +297 -0
- package/dist/esm/consent/adapters/cookiebot.d.ts +7 -0
- package/dist/esm/consent/adapters/cookiebot.js +46 -0
- package/dist/esm/consent/adapters/cookiemunch.d.ts +8 -0
- package/dist/esm/consent/adapters/cookiemunch.js +53 -0
- package/dist/esm/consent/adapters/custom.d.ts +8 -0
- package/dist/esm/consent/adapters/custom.js +36 -0
- package/dist/esm/consent/adapters/didomi.d.ts +9 -0
- package/dist/esm/consent/adapters/didomi.js +64 -0
- package/dist/esm/consent/adapters/gcm.d.ts +10 -0
- package/dist/esm/consent/adapters/gcm.js +75 -0
- package/dist/esm/consent/adapters/gpp.d.ts +9 -0
- package/dist/esm/consent/adapters/gpp.js +89 -0
- package/dist/esm/consent/adapters/none.d.ts +3 -0
- package/dist/esm/consent/adapters/none.js +27 -0
- package/dist/esm/consent/adapters/onetrust.d.ts +8 -0
- package/dist/esm/consent/adapters/onetrust.js +68 -0
- package/dist/esm/consent/adapters/osano.d.ts +9 -0
- package/dist/esm/consent/adapters/osano.js +68 -0
- package/dist/esm/consent/adapters/tcf.d.ts +8 -0
- package/dist/esm/consent/adapters/tcf.js +76 -0
- package/dist/esm/consent/adapters/termly.d.ts +10 -0
- package/dist/esm/consent/adapters/termly.js +58 -0
- package/dist/esm/consent/adapters/usercentrics.d.ts +9 -0
- package/dist/esm/consent/adapters/usercentrics.js +103 -0
- package/dist/esm/consent/conformance.d.ts +22 -0
- package/dist/esm/consent/conformance.js +30 -0
- package/dist/esm/consent/gate.d.ts +23 -0
- package/dist/esm/consent/gate.js +217 -0
- package/dist/esm/consent/port.d.ts +105 -0
- package/dist/esm/consent/port.js +67 -0
- package/dist/esm/consent/registry.d.ts +17 -0
- package/dist/esm/consent/registry.js +55 -0
- package/dist/esm/consent/served.d.ts +15 -0
- package/dist/esm/consent/served.js +22 -0
- package/dist/esm/core.d.ts +77 -0
- package/dist/esm/core.js +60 -0
- package/dist/esm/errors.d.ts +42 -0
- package/dist/esm/errors.generated.d.ts +183 -0
- package/dist/esm/errors.generated.js +231 -0
- package/dist/esm/errors.js +40 -0
- package/dist/esm/generated.d.ts +15146 -0
- package/dist/esm/generated.js +622 -0
- package/dist/esm/index.d.ts +22 -0
- package/dist/esm/index.js +22 -0
- package/dist/esm/mobile.d.ts +66 -0
- package/dist/esm/mobile.js +64 -0
- package/dist/esm/node.d.ts +209 -0
- package/dist/esm/node.js +135 -0
- package/dist/esm/outbox.d.ts +186 -0
- package/dist/esm/outbox.js +316 -0
- package/dist/esm/package.json +3 -0
- package/dist/esm/resources.generated.d.ts +6002 -0
- package/dist/esm/resources.generated.js +2086 -0
- package/dist/esm/served.d.ts +25 -0
- package/dist/esm/served.js +207 -0
- package/dist/esm/sha256.d.ts +2 -0
- package/dist/esm/sha256.js +82 -0
- package/dist/esm/snippet.d.ts +99 -0
- package/dist/esm/snippet.js +210 -0
- package/dist/esm/stripe-events.d.ts +25 -0
- package/dist/esm/stripe-events.js +114 -0
- package/dist/esm/version.d.ts +2 -0
- package/dist/esm/version.js +2 -0
- package/dist/esm/webhooks.d.ts +76 -0
- package/dist/esm/webhooks.js +153 -0
- package/dist/tsconfig.build.tsbuildinfo +1 -0
- package/dist/tsconfig.cjs.tsbuildinfo +1 -0
- package/package.json +105 -4
- package/src/attribution.ts +216 -0
- package/src/browser.ts +107 -0
- package/src/client.ts +351 -0
- package/src/codegen.ts +130 -0
- package/src/consent/adapters/cookiebot.ts +42 -0
- package/src/consent/adapters/cookiemunch.ts +49 -0
- package/src/consent/adapters/custom.ts +37 -0
- package/src/consent/adapters/didomi.ts +59 -0
- package/src/consent/adapters/gcm.ts +68 -0
- package/src/consent/adapters/gpp.ts +81 -0
- package/src/consent/adapters/none.ts +28 -0
- package/src/consent/adapters/onetrust.ts +64 -0
- package/src/consent/adapters/osano.ts +63 -0
- package/src/consent/adapters/tcf.ts +67 -0
- package/src/consent/adapters/termly.ts +54 -0
- package/src/consent/adapters/usercentrics.ts +97 -0
- package/src/consent/conformance.ts +47 -0
- package/src/consent/gate.ts +216 -0
- package/src/consent/port.ts +148 -0
- package/src/consent/registry.ts +60 -0
- package/src/consent/served.ts +24 -0
- package/src/core.ts +127 -0
- package/src/errors.generated.ts +277 -0
- package/src/errors.ts +57 -0
- package/src/generated.ts +14540 -0
- package/src/index.ts +100 -0
- package/src/mobile.ts +96 -0
- package/src/node.ts +291 -0
- package/src/outbox.ts +452 -0
- package/src/resources.generated.ts +2097 -0
- package/src/served.ts +229 -0
- package/src/sha256.ts +82 -0
- package/src/snippet.ts +305 -0
- package/src/stripe-events.ts +130 -0
- package/src/version.ts +2 -0
- package/src/webhooks.ts +207 -0
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import { consentGate } from './gate.js';
|
|
2
|
+
import { AUTO_ORDER } from './port.js';
|
|
3
|
+
import { adapterOf } from './registry.js';
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* The consent gate and adapters as JavaScript source, for the served aff.js.
|
|
7
|
+
* Built from the same functions the module build runs (their source text), so
|
|
8
|
+
* there is one implementation. `__name` is a no-op stand-in for the helper
|
|
9
|
+
* esbuild (tsx, vitest) inserts into function bodies under keepNames.
|
|
10
|
+
*
|
|
11
|
+
* `ids`: the adapters to inline (default: all of `auto`'s, in order).
|
|
12
|
+
*/
|
|
13
|
+
export function consentSource(ids: readonly string[] = AUTO_ORDER): { gate: string; adapters: string; order: string } {
|
|
14
|
+
const list = AUTO_ORDER.filter((id) => ids.includes(id));
|
|
15
|
+
const adapters = list.map((id) => `${JSON.stringify(id)}:(${String(adapterOf(id)!.factory)})`).join(',\n');
|
|
16
|
+
return {
|
|
17
|
+
gate: `(${String(consentGate)})`,
|
|
18
|
+
adapters: `{${adapters}}`,
|
|
19
|
+
order: JSON.stringify(list),
|
|
20
|
+
};
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
/** The no-op `__name` shim (see consentSource). */
|
|
24
|
+
export const NAME_SHIM = 'var __name=function(t){return t;};';
|
package/src/core.ts
ADDED
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
import { ReferalliError } from './errors.js';
|
|
2
|
+
|
|
3
|
+
export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
|
|
4
|
+
|
|
5
|
+
/** One operation in the generated table. */
|
|
6
|
+
export interface OperationSpec {
|
|
7
|
+
method: HttpMethod;
|
|
8
|
+
path: string;
|
|
9
|
+
pathParams: readonly string[];
|
|
10
|
+
/** Query parameters, by wire name. */
|
|
11
|
+
query: readonly string[];
|
|
12
|
+
body: boolean;
|
|
13
|
+
kind: 'json' | 'list' | 'text' | 'empty';
|
|
14
|
+
/** Callable without an API key. */
|
|
15
|
+
public?: boolean;
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
/** Per-request overrides. */
|
|
19
|
+
export interface RequestOptions {
|
|
20
|
+
/**
|
|
21
|
+
* Sent as `Idempotency-Key`. Every POST gets a generated one when you don't
|
|
22
|
+
* pass it, and the same key is reused on every retry.
|
|
23
|
+
*/
|
|
24
|
+
idempotencyKey?: string;
|
|
25
|
+
/** Milliseconds before the request is abandoned (and retried, if it can be). */
|
|
26
|
+
timeout?: number;
|
|
27
|
+
maxRetries?: number;
|
|
28
|
+
signal?: AbortSignal;
|
|
29
|
+
headers?: Record<string, string>;
|
|
30
|
+
/** Override the `referalli-version` for this request (`null` sends none). */
|
|
31
|
+
apiVersion?: string | null;
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
/** Query values the SDK can encode. Arrays repeat the key; dates are ISO 8601. */
|
|
35
|
+
export type QueryValue = string | number | boolean | Date | null | undefined | ReadonlyArray<string | number | boolean>;
|
|
36
|
+
|
|
37
|
+
export interface OperationInput {
|
|
38
|
+
path?: Record<string, string>;
|
|
39
|
+
query?: object;
|
|
40
|
+
body?: unknown;
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
/** Cursor paging params every list operation accepts. */
|
|
44
|
+
export interface PageParams {
|
|
45
|
+
/** 1–100 items per page. */
|
|
46
|
+
limit?: number;
|
|
47
|
+
starting_after?: string;
|
|
48
|
+
ending_before?: string;
|
|
49
|
+
'created[gte]'?: string;
|
|
50
|
+
'created[lte]'?: string;
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
/** The list envelope (referalli-version 2026-11-01 and later). */
|
|
54
|
+
export interface ListEnvelope<T> {
|
|
55
|
+
object: 'list';
|
|
56
|
+
data: T[];
|
|
57
|
+
has_more: boolean;
|
|
58
|
+
next_cursor: string | null;
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
/** What the generated resources call into (the client implements it). */
|
|
62
|
+
export interface Transport {
|
|
63
|
+
op<R>(id: string, input: OperationInput, options?: RequestOptions): Promise<R>;
|
|
64
|
+
list<Item, Page extends ListEnvelope<Item>>(id: string, input: OperationInput, options?: RequestOptions): ListPromise<Item, Page>;
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
/**
|
|
68
|
+
* A list call. Await it for the first page, or iterate it with `for await`
|
|
69
|
+
* to get every item, fetching further pages (`starting_after`) as you go.
|
|
70
|
+
* Nothing is requested until you do one or the other.
|
|
71
|
+
*/
|
|
72
|
+
export class ListPromise<Item, Page extends ListEnvelope<Item> = ListEnvelope<Item>> implements PromiseLike<Page>, AsyncIterable<Item> {
|
|
73
|
+
private first: Promise<Page> | null = null;
|
|
74
|
+
|
|
75
|
+
constructor(private readonly fetchPage: (cursor: string | undefined) => Promise<Page>) {}
|
|
76
|
+
|
|
77
|
+
private firstPage(): Promise<Page> {
|
|
78
|
+
this.first ??= this.fetchPage(undefined).then(checkPage);
|
|
79
|
+
return this.first;
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
then<A = Page, B = never>(onfulfilled?: ((page: Page) => A | PromiseLike<A>) | null, onrejected?: ((reason: unknown) => B | PromiseLike<B>) | null): Promise<A | B> {
|
|
83
|
+
return this.firstPage().then(onfulfilled, onrejected);
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
catch<B = never>(onrejected?: ((reason: unknown) => B | PromiseLike<B>) | null): Promise<Page | B> {
|
|
87
|
+
return this.firstPage().catch(onrejected);
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
finally(onfinally?: (() => void) | null): Promise<Page> {
|
|
91
|
+
return this.firstPage().finally(onfinally);
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
/** Every page, starting with the first. */
|
|
95
|
+
async *pages(): AsyncGenerator<Page, void, undefined> {
|
|
96
|
+
let page = await this.firstPage();
|
|
97
|
+
for (;;) {
|
|
98
|
+
yield page;
|
|
99
|
+
if (!page.has_more || !page.next_cursor) return;
|
|
100
|
+
page = checkPage(await this.fetchPage(page.next_cursor));
|
|
101
|
+
}
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
async *[Symbol.asyncIterator](): AsyncGenerator<Item, void, undefined> {
|
|
105
|
+
for await (const page of this.pages()) yield* page.data;
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
/** Collect items into an array, stopping at `limit` (default 10,000) so a runaway list can't exhaust memory. */
|
|
109
|
+
async toArray(opts: { limit?: number } = {}): Promise<Item[]> {
|
|
110
|
+
const limit = opts.limit ?? 10_000;
|
|
111
|
+
const out: Item[] = [];
|
|
112
|
+
if (limit <= 0) return out;
|
|
113
|
+
for await (const item of this) {
|
|
114
|
+
out.push(item);
|
|
115
|
+
if (out.length >= limit) break;
|
|
116
|
+
}
|
|
117
|
+
return out;
|
|
118
|
+
}
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
function checkPage<P>(page: P): P {
|
|
122
|
+
const p = page as unknown as ListEnvelope<unknown> | null;
|
|
123
|
+
if (!p || typeof p !== 'object' || !Array.isArray(p.data)) {
|
|
124
|
+
throw new ReferalliError('the API did not return a list page: send referalli-version 2026-11-01 or later (the SDK default)');
|
|
125
|
+
}
|
|
126
|
+
return page;
|
|
127
|
+
}
|
|
@@ -0,0 +1,277 @@
|
|
|
1
|
+
// Generated from the Referalli OpenAPI document by packages/sdkgen. Do not edit by hand:
|
|
2
|
+
// run `pnpm --filter referalli gen` after changing the API.
|
|
3
|
+
import { ApiError } from './errors.js';
|
|
4
|
+
|
|
5
|
+
/** `validation_error` (HTTP 400). */
|
|
6
|
+
export class ValidationError extends ApiError {
|
|
7
|
+
override readonly name: string = "ValidationError";
|
|
8
|
+
}
|
|
9
|
+
|
|
10
|
+
/** `mode_mismatch` (HTTP 400). */
|
|
11
|
+
export class ModeMismatchError extends ApiError {
|
|
12
|
+
override readonly name: string = "ModeMismatchError";
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
/** `bad_request` (HTTP 400). */
|
|
16
|
+
export class BadRequestError extends ApiError {
|
|
17
|
+
override readonly name: string = "BadRequestError";
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
/** `invalid_handoff_token` (HTTP 400). */
|
|
21
|
+
export class InvalidHandoffTokenError extends ApiError {
|
|
22
|
+
override readonly name: string = "InvalidHandoffTokenError";
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
/** `unauthorized` (HTTP 401). */
|
|
26
|
+
export class AuthenticationError extends ApiError {
|
|
27
|
+
override readonly name: string = "AuthenticationError";
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
/** `step_up_required` (HTTP 401). */
|
|
31
|
+
export class StepUpRequiredError extends ApiError {
|
|
32
|
+
override readonly name: string = "StepUpRequiredError";
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
/** `reauth_required` (HTTP 401). */
|
|
36
|
+
export class ReauthRequiredError extends ApiError {
|
|
37
|
+
override readonly name: string = "ReauthRequiredError";
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
/** `payment_required` (HTTP 402). */
|
|
41
|
+
export class PaymentRequiredError extends ApiError {
|
|
42
|
+
override readonly name: string = "PaymentRequiredError";
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
/** `forbidden` (HTTP 403). */
|
|
46
|
+
export class PermissionDeniedError extends ApiError {
|
|
47
|
+
override readonly name: string = "PermissionDeniedError";
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
/** `webhooks_disabled` (HTTP 403). */
|
|
51
|
+
export class WebhooksDisabledError extends ApiError {
|
|
52
|
+
override readonly name: string = "WebhooksDisabledError";
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
/** `sso_required` (HTTP 403). */
|
|
56
|
+
export class SsoRequiredError extends ApiError {
|
|
57
|
+
override readonly name: string = "SsoRequiredError";
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
/** `access_suspended` (HTTP 403). */
|
|
61
|
+
export class AccessSuspendedError extends ApiError {
|
|
62
|
+
override readonly name: string = "AccessSuspendedError";
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
/** `program_scoped_key` (HTTP 403). */
|
|
66
|
+
export class ProgramScopedKeyError extends ApiError {
|
|
67
|
+
override readonly name: string = "ProgramScopedKeyError";
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
/** `restricted_session` (HTTP 403). */
|
|
71
|
+
export class RestrictedSessionError extends ApiError {
|
|
72
|
+
override readonly name: string = "RestrictedSessionError";
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
/** `not_found` (HTTP 404). */
|
|
76
|
+
export class NotFoundError extends ApiError {
|
|
77
|
+
override readonly name: string = "NotFoundError";
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
/** `not_enrolled` (HTTP 404). */
|
|
81
|
+
export class NotEnrolledError extends ApiError {
|
|
82
|
+
override readonly name: string = "NotEnrolledError";
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
/** `conflict` (HTTP 409). */
|
|
86
|
+
export class ConflictError extends ApiError {
|
|
87
|
+
override readonly name: string = "ConflictError";
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
/** `idempotency_in_progress` (HTTP 409). */
|
|
91
|
+
export class IdempotencyInProgressError extends ApiError {
|
|
92
|
+
override readonly name: string = "IdempotencyInProgressError";
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
/** `stripe_key_required` (HTTP 409). */
|
|
96
|
+
export class StripeKeyRequiredError extends ApiError {
|
|
97
|
+
override readonly name: string = "StripeKeyRequiredError";
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
/** `credit_credentials_required` (HTTP 409). */
|
|
101
|
+
export class CreditCredentialsRequiredError extends ApiError {
|
|
102
|
+
override readonly name: string = "CreditCredentialsRequiredError";
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
/** `api_key_expired` (HTTP 409). */
|
|
106
|
+
export class ApiKeyExpiredError extends ApiError {
|
|
107
|
+
override readonly name: string = "ApiKeyExpiredError";
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
/** `replay` (HTTP 409). */
|
|
111
|
+
export class ReplayError extends ApiError {
|
|
112
|
+
override readonly name: string = "ReplayError";
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
/** `live_mode_only` (HTTP 409). */
|
|
116
|
+
export class LiveModeOnlyError extends ApiError {
|
|
117
|
+
override readonly name: string = "LiveModeOnlyError";
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
/** `test_mode_only` (HTTP 409). */
|
|
121
|
+
export class TestModeOnlyError extends ApiError {
|
|
122
|
+
override readonly name: string = "TestModeOnlyError";
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
/** `test_mode_unsupported` (HTTP 409). */
|
|
126
|
+
export class TestModeUnsupportedError extends ApiError {
|
|
127
|
+
override readonly name: string = "TestModeUnsupportedError";
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
/** `gone` (HTTP 410). */
|
|
131
|
+
export class GoneError extends ApiError {
|
|
132
|
+
override readonly name: string = "GoneError";
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
/** `idempotency_key_reused` (HTTP 422). */
|
|
136
|
+
export class IdempotencyKeyReusedError extends ApiError {
|
|
137
|
+
override readonly name: string = "IdempotencyKeyReusedError";
|
|
138
|
+
}
|
|
139
|
+
|
|
140
|
+
/** `stripe_key_invalid` (HTTP 422). */
|
|
141
|
+
export class StripeKeyInvalidError extends ApiError {
|
|
142
|
+
override readonly name: string = "StripeKeyInvalidError";
|
|
143
|
+
}
|
|
144
|
+
|
|
145
|
+
/** `stripe_key_wrong_mode` (HTTP 422). */
|
|
146
|
+
export class StripeKeyWrongModeError extends ApiError {
|
|
147
|
+
override readonly name: string = "StripeKeyWrongModeError";
|
|
148
|
+
}
|
|
149
|
+
|
|
150
|
+
/** `stripe_key_permission` (HTTP 422). */
|
|
151
|
+
export class StripeKeyPermissionError extends ApiError {
|
|
152
|
+
override readonly name: string = "StripeKeyPermissionError";
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
/** `unknown_topic` (HTTP 422). */
|
|
156
|
+
export class UnknownTopicError extends ApiError {
|
|
157
|
+
override readonly name: string = "UnknownTopicError";
|
|
158
|
+
}
|
|
159
|
+
|
|
160
|
+
/** `billing_connection_no_key` (HTTP 409). */
|
|
161
|
+
export class BillingConnectionNoKeyError extends ApiError {
|
|
162
|
+
override readonly name: string = "BillingConnectionNoKeyError";
|
|
163
|
+
}
|
|
164
|
+
|
|
165
|
+
/** `provider_credentials_invalid` (HTTP 422). */
|
|
166
|
+
export class ProviderCredentialsInvalidError extends ApiError {
|
|
167
|
+
override readonly name: string = "ProviderCredentialsInvalidError";
|
|
168
|
+
}
|
|
169
|
+
|
|
170
|
+
/** `provider_credentials_wrong_mode` (HTTP 422). */
|
|
171
|
+
export class ProviderCredentialsWrongModeError extends ApiError {
|
|
172
|
+
override readonly name: string = "ProviderCredentialsWrongModeError";
|
|
173
|
+
}
|
|
174
|
+
|
|
175
|
+
/** `provider_permission` (HTTP 422). */
|
|
176
|
+
export class ProviderPermissionError extends ApiError {
|
|
177
|
+
override readonly name: string = "ProviderPermissionError";
|
|
178
|
+
}
|
|
179
|
+
|
|
180
|
+
/** `payload_too_large` (HTTP 413). */
|
|
181
|
+
export class PayloadTooLargeError extends ApiError {
|
|
182
|
+
override readonly name: string = "PayloadTooLargeError";
|
|
183
|
+
}
|
|
184
|
+
|
|
185
|
+
/** `unsupported_media_type` (HTTP 415). */
|
|
186
|
+
export class UnsupportedMediaTypeError extends ApiError {
|
|
187
|
+
override readonly name: string = "UnsupportedMediaTypeError";
|
|
188
|
+
}
|
|
189
|
+
|
|
190
|
+
/** `connection_paused` (HTTP 423). */
|
|
191
|
+
export class ConnectionPausedError extends ApiError {
|
|
192
|
+
override readonly name: string = "ConnectionPausedError";
|
|
193
|
+
}
|
|
194
|
+
|
|
195
|
+
/** `rate_limited` (HTTP 429). */
|
|
196
|
+
export class RateLimitedError extends ApiError {
|
|
197
|
+
override readonly name: string = "RateLimitedError";
|
|
198
|
+
}
|
|
199
|
+
|
|
200
|
+
/** `internal_error` (HTTP 500). */
|
|
201
|
+
export class InternalServerError extends ApiError {
|
|
202
|
+
override readonly name: string = "InternalServerError";
|
|
203
|
+
}
|
|
204
|
+
|
|
205
|
+
/** `atlas_error` (HTTP 502). */
|
|
206
|
+
export class AtlasError extends ApiError {
|
|
207
|
+
override readonly name: string = "AtlasError";
|
|
208
|
+
}
|
|
209
|
+
|
|
210
|
+
/** `stripe_unavailable` (HTTP 502). */
|
|
211
|
+
export class StripeUnavailableError extends ApiError {
|
|
212
|
+
override readonly name: string = "StripeUnavailableError";
|
|
213
|
+
}
|
|
214
|
+
|
|
215
|
+
/** `provider_unavailable` (HTTP 502). */
|
|
216
|
+
export class ProviderUnavailableError extends ApiError {
|
|
217
|
+
override readonly name: string = "ProviderUnavailableError";
|
|
218
|
+
}
|
|
219
|
+
|
|
220
|
+
/** `sso_provider_error` (HTTP 502). */
|
|
221
|
+
export class SsoProviderError extends ApiError {
|
|
222
|
+
override readonly name: string = "SsoProviderError";
|
|
223
|
+
}
|
|
224
|
+
|
|
225
|
+
/** `sso_not_configured` (HTTP 503). */
|
|
226
|
+
export class SsoNotConfiguredError extends ApiError {
|
|
227
|
+
override readonly name: string = "SsoNotConfiguredError";
|
|
228
|
+
}
|
|
229
|
+
|
|
230
|
+
/** The error class for each API error code. */
|
|
231
|
+
export const errorClasses: Record<string, typeof ApiError> = {
|
|
232
|
+
validation_error: ValidationError,
|
|
233
|
+
mode_mismatch: ModeMismatchError,
|
|
234
|
+
bad_request: BadRequestError,
|
|
235
|
+
invalid_handoff_token: InvalidHandoffTokenError,
|
|
236
|
+
unauthorized: AuthenticationError,
|
|
237
|
+
step_up_required: StepUpRequiredError,
|
|
238
|
+
reauth_required: ReauthRequiredError,
|
|
239
|
+
payment_required: PaymentRequiredError,
|
|
240
|
+
forbidden: PermissionDeniedError,
|
|
241
|
+
webhooks_disabled: WebhooksDisabledError,
|
|
242
|
+
sso_required: SsoRequiredError,
|
|
243
|
+
access_suspended: AccessSuspendedError,
|
|
244
|
+
program_scoped_key: ProgramScopedKeyError,
|
|
245
|
+
restricted_session: RestrictedSessionError,
|
|
246
|
+
not_found: NotFoundError,
|
|
247
|
+
not_enrolled: NotEnrolledError,
|
|
248
|
+
conflict: ConflictError,
|
|
249
|
+
idempotency_in_progress: IdempotencyInProgressError,
|
|
250
|
+
stripe_key_required: StripeKeyRequiredError,
|
|
251
|
+
credit_credentials_required: CreditCredentialsRequiredError,
|
|
252
|
+
api_key_expired: ApiKeyExpiredError,
|
|
253
|
+
replay: ReplayError,
|
|
254
|
+
live_mode_only: LiveModeOnlyError,
|
|
255
|
+
test_mode_only: TestModeOnlyError,
|
|
256
|
+
test_mode_unsupported: TestModeUnsupportedError,
|
|
257
|
+
gone: GoneError,
|
|
258
|
+
idempotency_key_reused: IdempotencyKeyReusedError,
|
|
259
|
+
stripe_key_invalid: StripeKeyInvalidError,
|
|
260
|
+
stripe_key_wrong_mode: StripeKeyWrongModeError,
|
|
261
|
+
stripe_key_permission: StripeKeyPermissionError,
|
|
262
|
+
unknown_topic: UnknownTopicError,
|
|
263
|
+
billing_connection_no_key: BillingConnectionNoKeyError,
|
|
264
|
+
provider_credentials_invalid: ProviderCredentialsInvalidError,
|
|
265
|
+
provider_credentials_wrong_mode: ProviderCredentialsWrongModeError,
|
|
266
|
+
provider_permission: ProviderPermissionError,
|
|
267
|
+
payload_too_large: PayloadTooLargeError,
|
|
268
|
+
unsupported_media_type: UnsupportedMediaTypeError,
|
|
269
|
+
connection_paused: ConnectionPausedError,
|
|
270
|
+
rate_limited: RateLimitedError,
|
|
271
|
+
internal_error: InternalServerError,
|
|
272
|
+
atlas_error: AtlasError,
|
|
273
|
+
stripe_unavailable: StripeUnavailableError,
|
|
274
|
+
provider_unavailable: ProviderUnavailableError,
|
|
275
|
+
sso_provider_error: SsoProviderError,
|
|
276
|
+
sso_not_configured: SsoNotConfiguredError,
|
|
277
|
+
};
|
package/src/errors.ts
ADDED
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
/** Base class for every error this SDK throws. */
|
|
2
|
+
export class ReferalliError extends Error {
|
|
3
|
+
override readonly name: string = 'ReferalliError';
|
|
4
|
+
}
|
|
5
|
+
|
|
6
|
+
/** The API could not be reached (network failure), after any retries. */
|
|
7
|
+
export class ApiConnectionError extends ReferalliError {
|
|
8
|
+
override readonly name: string = 'ApiConnectionError';
|
|
9
|
+
|
|
10
|
+
constructor(message: string, options?: { cause?: unknown }) {
|
|
11
|
+
super(message, options);
|
|
12
|
+
}
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
/** The request took longer than `timeout`, after any retries. */
|
|
16
|
+
export class ApiTimeoutError extends ApiConnectionError {
|
|
17
|
+
override readonly name: string = 'ApiTimeoutError';
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
export interface ApiErrorInit {
|
|
21
|
+
status: number;
|
|
22
|
+
code: string;
|
|
23
|
+
message: string;
|
|
24
|
+
requestId?: string | null;
|
|
25
|
+
docsUrl?: string | null;
|
|
26
|
+
details?: unknown;
|
|
27
|
+
/** Seconds the API asked us to wait (`Retry-After`), if it said. */
|
|
28
|
+
retryAfter?: number | null;
|
|
29
|
+
headers?: Record<string, string>;
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
/**
|
|
33
|
+
* The API answered with an error. `code` is stable (see
|
|
34
|
+
* https://referalli.com/docs/errors-and-limits); each code has its own
|
|
35
|
+
* subclass (`NotFoundError`, `RateLimitedError`, …) so you can `instanceof`.
|
|
36
|
+
*/
|
|
37
|
+
export class ApiError extends ReferalliError {
|
|
38
|
+
override readonly name: string = 'ApiError';
|
|
39
|
+
readonly status: number;
|
|
40
|
+
readonly code: string;
|
|
41
|
+
readonly requestId: string | null;
|
|
42
|
+
readonly docsUrl: string | null;
|
|
43
|
+
readonly details: unknown;
|
|
44
|
+
readonly retryAfter: number | null;
|
|
45
|
+
readonly headers: Record<string, string>;
|
|
46
|
+
|
|
47
|
+
constructor(init: ApiErrorInit) {
|
|
48
|
+
super(`${init.code} (${init.status}): ${init.message}`);
|
|
49
|
+
this.status = init.status;
|
|
50
|
+
this.code = init.code;
|
|
51
|
+
this.requestId = init.requestId ?? null;
|
|
52
|
+
this.docsUrl = init.docsUrl ?? null;
|
|
53
|
+
this.details = init.details;
|
|
54
|
+
this.retryAfter = init.retryAfter ?? null;
|
|
55
|
+
this.headers = init.headers ?? {};
|
|
56
|
+
}
|
|
57
|
+
}
|