outbound-sdk 0.0.0-stage → 0.2.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 +21 -0
- package/README.md +119 -2
- package/dist/alerts/index.d.ts +2 -0
- package/dist/alerts/index.js +140 -0
- package/dist/alerts/plugin.d.ts +58 -0
- package/dist/audit/index.d.ts +33 -0
- package/dist/audit/index.js +60 -0
- package/dist/benchmarks/index.d.ts +29 -0
- package/dist/benchmarks/index.js +72 -0
- package/dist/budget/index.d.ts +21 -0
- package/dist/budget/index.js +71 -0
- package/dist/cache/index.d.ts +31 -0
- package/dist/cache/index.js +11 -0
- package/dist/cards/content.d.ts +43 -0
- package/dist/cards/copy-cards.d.ts +2 -0
- package/dist/cards/format.d.ts +39 -0
- package/dist/cards/index.d.ts +9 -0
- package/dist/cards/index.js +2070 -0
- package/dist/cards/notify-cards.d.ts +14 -0
- package/dist/cards/ops-cards.d.ts +2 -0
- package/dist/cards/parts.d.ts +22 -0
- package/dist/cards/people-cards.d.ts +2 -0
- package/dist/cards/render.d.ts +28 -0
- package/dist/cards/sender-cards.d.ts +2 -0
- package/dist/cards/slack-rich.d.ts +19 -0
- package/dist/cards/slack-text.d.ts +10 -0
- package/dist/cards/slack.d.ts +21 -0
- package/dist/cards/spec.d.ts +86 -0
- package/dist/cards/tool-cards.d.ts +4 -0
- package/dist/chunks/chunk-4O2HRTTI.js +75 -0
- package/dist/chunks/chunk-4PSO6JEK.js +357 -0
- package/dist/chunks/chunk-6CVZOUHB.js +152 -0
- package/dist/chunks/chunk-AFU5E5QB.js +714 -0
- package/dist/chunks/chunk-DJ2IUQEU.js +111 -0
- package/dist/chunks/chunk-E7JHLNLG.js +187 -0
- package/dist/chunks/chunk-FHKSLCVW.js +154 -0
- package/dist/chunks/chunk-FKH5N47I.js +40 -0
- package/dist/chunks/chunk-HZCTYL22.js +29 -0
- package/dist/chunks/chunk-IPUYZD4O.js +25 -0
- package/dist/chunks/chunk-IVH3NMQZ.js +61 -0
- package/dist/chunks/chunk-LVYG7XZJ.js +45 -0
- package/dist/chunks/chunk-NAKXLBA6.js +30 -0
- package/dist/chunks/chunk-NAWZ73QS.js +22 -0
- package/dist/chunks/chunk-PMSSUWD7.js +636 -0
- package/dist/chunks/chunk-PURHK3JU.js +432 -0
- package/dist/chunks/chunk-R3Y56YVF.js +43 -0
- package/dist/chunks/chunk-RCZ7ZZFU.js +92 -0
- package/dist/chunks/chunk-SBIZDCRY.js +106 -0
- package/dist/chunks/chunk-U2D34ARZ.js +41 -0
- package/dist/chunks/chunk-UAT3JSJZ.js +331 -0
- package/dist/chunks/chunk-VQSCHOBV.js +111 -0
- package/dist/chunks/chunk-XC6CZP73.js +80 -0
- package/dist/chunks/chunk-XNFESPZH.js +2307 -0
- package/dist/chunks/chunk-YOTW5ESM.js +118 -0
- package/dist/cli/bin.d.ts +2 -0
- package/dist/cli/bin.js +35 -0
- package/dist/cli/commands.d.ts +19 -0
- package/dist/cli/config.d.ts +22 -0
- package/dist/cli/index.d.ts +17 -0
- package/dist/cli/index.js +30 -0
- package/dist/cli/mcp.d.ts +14 -0
- package/dist/cli/stdio.d.ts +9 -0
- package/dist/clients/index.d.ts +2 -0
- package/dist/clients/index.js +117 -0
- package/dist/clients/plugin.d.ts +42 -0
- package/dist/combine/account.d.ts +4 -0
- package/dist/combine/adapter.d.ts +9 -0
- package/dist/combine/index.d.ts +2 -0
- package/dist/combine/index.js +420 -0
- package/dist/combine/route.d.ts +24 -0
- package/dist/exporter/index.d.ts +29 -0
- package/dist/exporter/index.js +77 -0
- package/dist/failover/index.d.ts +11 -0
- package/dist/failover/index.js +45 -0
- package/dist/fixtures/index.d.ts +27 -0
- package/dist/fixtures/index.js +260 -0
- package/dist/fixtures/scrub.d.ts +5 -0
- package/dist/heyreach/account.d.ts +11 -0
- package/dist/heyreach/adapter.d.ts +5 -0
- package/dist/heyreach/capabilities.d.ts +70 -0
- package/dist/heyreach/client.d.ts +18 -0
- package/dist/heyreach/inbox.d.ts +7 -0
- package/dist/heyreach/index.d.ts +25 -0
- package/dist/heyreach/index.js +1931 -0
- package/dist/heyreach/leads.d.ts +4 -0
- package/dist/heyreach/lookup.d.ts +15 -0
- package/dist/heyreach/map-account.d.ts +31 -0
- package/dist/heyreach/map-sequence.d.ts +5 -0
- package/dist/heyreach/map-stats.d.ts +13 -0
- package/dist/heyreach/map.d.ts +37 -0
- package/dist/heyreach/native-organization.d.ts +128 -0
- package/dist/heyreach/native-voice.d.ts +106 -0
- package/dist/heyreach/native.d.ts +496 -0
- package/dist/heyreach/paging.d.ts +7 -0
- package/dist/heyreach/webhooks.d.ts +3 -0
- package/dist/identity/index.d.ts +3 -0
- package/dist/identity/index.js +159 -0
- package/dist/identity/keys.d.ts +9 -0
- package/dist/identity/plugin.d.ts +34 -0
- package/dist/index.d.ts +33 -0
- package/dist/index.js +131 -0
- package/dist/insights/copy/copy-audit.d.ts +55 -0
- package/dist/insights/copy/copy-checks.d.ts +44 -0
- package/dist/insights/copy/copy-reuse.d.ts +59 -0
- package/dist/insights/copy/index.d.ts +67 -0
- package/dist/insights/copy/reply-timing.d.ts +63 -0
- package/dist/insights/copy/shared.d.ts +53 -0
- package/dist/insights/copy/step-funnel.d.ts +66 -0
- package/dist/insights/copy/variant-test.d.ts +64 -0
- package/dist/insights/define.d.ts +98 -0
- package/dist/insights/index.d.ts +10 -0
- package/dist/insights/index.js +4937 -0
- package/dist/insights/ops/anomalies.d.ts +80 -0
- package/dist/insights/ops/campaign-diagnosis.d.ts +39 -0
- package/dist/insights/ops/campaign-ranking.d.ts +56 -0
- package/dist/insights/ops/channel-mix.d.ts +44 -0
- package/dist/insights/ops/client-report.d.ts +76 -0
- package/dist/insights/ops/diagnosis-checks.d.ts +48 -0
- package/dist/insights/ops/index.d.ts +135 -0
- package/dist/insights/ops/period-comparison.d.ts +86 -0
- package/dist/insights/ops/pipeline-forecast.d.ts +44 -0
- package/dist/insights/ops/shared.d.ts +155 -0
- package/dist/insights/ops/tag-rollup.d.ts +32 -0
- package/dist/insights/people/account-summary.d.ts +68 -0
- package/dist/insights/people/dropped-replies.d.ts +51 -0
- package/dist/insights/people/find.d.ts +18 -0
- package/dist/insights/people/hot-leads.d.ts +67 -0
- package/dist/insights/people/index.d.ts +88 -0
- package/dist/insights/people/lead-collisions.d.ts +43 -0
- package/dist/insights/people/person-summary.d.ts +46 -0
- package/dist/insights/people/personalization-gaps.d.ts +60 -0
- package/dist/insights/people/read.d.ts +40 -0
- package/dist/insights/people/suppression-check.d.ts +53 -0
- package/dist/insights/plugin.d.ts +40 -0
- package/dist/insights/registry.d.ts +335 -0
- package/dist/insights/senders/bounce-watch.d.ts +70 -0
- package/dist/insights/senders/domain-health.d.ts +69 -0
- package/dist/insights/senders/index.d.ts +74 -0
- package/dist/insights/senders/read.d.ts +37 -0
- package/dist/insights/senders/sender-capacity.d.ts +67 -0
- package/dist/insights/senders/sender-load.d.ts +52 -0
- package/dist/insights/senders/settings-audit.d.ts +48 -0
- package/dist/insights/senders/warmup-readiness.d.ts +39 -0
- package/dist/insights/stats.d.ts +45 -0
- package/dist/insights/tools.d.ts +16 -0
- package/dist/insights/types.d.ts +4 -0
- package/dist/instantly/adapter-account.d.ts +5 -0
- package/dist/instantly/adapter-mail.d.ts +3 -0
- package/dist/instantly/adapter.d.ts +7 -0
- package/dist/instantly/capabilities.d.ts +85 -0
- package/dist/instantly/client.d.ts +24 -0
- package/dist/instantly/index.d.ts +27 -0
- package/dist/instantly/index.js +2627 -0
- package/dist/instantly/map-account.d.ts +38 -0
- package/dist/instantly/map-lead.d.ts +18 -0
- package/dist/instantly/map-stats.d.ts +25 -0
- package/dist/instantly/map.d.ts +22 -0
- package/dist/instantly/native-agents-sales.d.ts +161 -0
- package/dist/instantly/native-agents.d.ts +156 -0
- package/dist/instantly/native-campaigns.d.ts +101 -0
- package/dist/instantly/native-leads.d.ts +93 -0
- package/dist/instantly/native-params.d.ts +7 -0
- package/dist/instantly/native-search.d.ts +82 -0
- package/dist/instantly/native-senders.d.ts +182 -0
- package/dist/instantly/native-supersearch.d.ts +149 -0
- package/dist/instantly/native-workspace.d.ts +170 -0
- package/dist/instantly/native.d.ts +1081 -0
- package/dist/instantly/pages.d.ts +29 -0
- package/dist/instantly/stats.d.ts +5 -0
- package/dist/instantly/webhooks.d.ts +3 -0
- package/dist/internal/adapter.d.ts +211 -0
- package/dist/internal/capabilities.d.ts +104 -0
- package/dist/internal/client.d.ts +15 -0
- package/dist/internal/concurrency.d.ts +8 -0
- package/dist/internal/cursor.d.ts +10 -0
- package/dist/internal/engine/budget.d.ts +44 -0
- package/dist/internal/engine/engine.d.ts +45 -0
- package/dist/internal/engine/rate-store.d.ts +25 -0
- package/dist/internal/engine/request.d.ts +34 -0
- package/dist/internal/engine/retry.d.ts +21 -0
- package/dist/internal/engine/runtime.d.ts +13 -0
- package/dist/internal/entities-account.d.ts +205 -0
- package/dist/internal/entities.d.ts +493 -0
- package/dist/internal/env.d.ts +4 -0
- package/dist/internal/errors.d.ts +62 -0
- package/dist/internal/fields.d.ts +462 -0
- package/dist/internal/hooks.d.ts +55 -0
- package/dist/internal/json.d.ts +49 -0
- package/dist/internal/lead-fields.d.ts +21 -0
- package/dist/internal/lead-status.d.ts +13 -0
- package/dist/internal/limits.d.ts +34 -0
- package/dist/internal/metrics.d.ts +64 -0
- package/dist/internal/native.d.ts +81 -0
- package/dist/internal/outbound/api.d.ts +292 -0
- package/dist/internal/outbound/collections.d.ts +31 -0
- package/dist/internal/outbound/core.d.ts +36 -0
- package/dist/internal/outbound/create.d.ts +16 -0
- package/dist/internal/outbound/handles.d.ts +7 -0
- package/dist/internal/outbound/native.d.ts +4 -0
- package/dist/internal/outbound/operation-shared.d.ts +28 -0
- package/dist/internal/outbound/operations-account.d.ts +41 -0
- package/dist/internal/outbound/operations.d.ts +42 -0
- package/dist/internal/outbound/outbound.d.ts +67 -0
- package/dist/internal/outbound/plugins.d.ts +40 -0
- package/dist/internal/outbound/raw.d.ts +9 -0
- package/dist/internal/outbound/specs-account.d.ts +20 -0
- package/dist/internal/outbound/specs.d.ts +14 -0
- package/dist/internal/outbound/stats.d.ts +7 -0
- package/dist/internal/outbound/validate.d.ts +5 -0
- package/dist/internal/outbound/walker.d.ts +22 -0
- package/dist/internal/page.d.ts +14 -0
- package/dist/internal/record.d.ts +36 -0
- package/dist/internal/records.d.ts +7 -0
- package/dist/internal/redact.d.ts +18 -0
- package/dist/internal/ref.d.ts +16 -0
- package/dist/internal/sequence.d.ts +14 -0
- package/dist/internal/sha256.d.ts +6 -0
- package/dist/internal/text.d.ts +11 -0
- package/dist/internal/url.d.ts +9 -0
- package/dist/loader/index.d.ts +24 -0
- package/dist/loader/index.js +16 -0
- package/dist/memory/account-reads.d.ts +5 -0
- package/dist/memory/account.d.ts +81 -0
- package/dist/memory/adapter.d.ts +16 -0
- package/dist/memory/data.d.ts +137 -0
- package/dist/memory/demo.d.ts +7 -0
- package/dist/memory/index.d.ts +5 -0
- package/dist/memory/index.js +867 -0
- package/dist/memory/stats.d.ts +6 -0
- package/dist/memory/store.d.ts +18 -0
- package/dist/providers/index.d.ts +22 -0
- package/dist/providers/index.js +10 -0
- package/dist/reconcile/index.d.ts +2 -0
- package/dist/reconcile/index.js +72 -0
- package/dist/reconcile/plugin.d.ts +55 -0
- package/dist/redact/index.d.ts +2 -0
- package/dist/redact/index.js +197 -0
- package/dist/redact/plugin.d.ts +22 -0
- package/dist/redis/index.d.ts +41 -0
- package/dist/redis/index.js +114 -0
- package/dist/smartlead/account.d.ts +5 -0
- package/dist/smartlead/adapter.d.ts +5 -0
- package/dist/smartlead/capabilities.d.ts +87 -0
- package/dist/smartlead/client.d.ts +18 -0
- package/dist/smartlead/hmac.d.ts +7 -0
- package/dist/smartlead/index.d.ts +24 -0
- package/dist/smartlead/index.js +2329 -0
- package/dist/smartlead/leads.d.ts +9 -0
- package/dist/smartlead/lookup.d.ts +8 -0
- package/dist/smartlead/mail.d.ts +5 -0
- package/dist/smartlead/map-account.d.ts +34 -0
- package/dist/smartlead/map-messages.d.ts +31 -0
- package/dist/smartlead/map-stats.d.ts +36 -0
- package/dist/smartlead/map.d.ts +62 -0
- package/dist/smartlead/native-analytics.d.ts +242 -0
- package/dist/smartlead/native-campaigns.d.ts +211 -0
- package/dist/smartlead/native-inbox.d.ts +141 -0
- package/dist/smartlead/native-params.d.ts +12 -0
- package/dist/smartlead/native-services.d.ts +204 -0
- package/dist/smartlead/native.d.ts +785 -0
- package/dist/smartlead/shared.d.ts +29 -0
- package/dist/smartlead/stats.d.ts +5 -0
- package/dist/smartlead/webhooks.d.ts +3 -0
- package/dist/sync/index.d.ts +2 -0
- package/dist/sync/index.js +158 -0
- package/dist/sync/plugin.d.ts +58 -0
- package/dist/tools/account-tools.d.ts +21 -0
- package/dist/tools/ai-sdk.d.ts +8 -0
- package/dist/tools/ai-sdk.js +28 -0
- package/dist/tools/campaign-tools.d.ts +59 -0
- package/dist/tools/claude-agent.d.ts +18 -0
- package/dist/tools/claude-agent.js +42 -0
- package/dist/tools/index.d.ts +28 -0
- package/dist/tools/index.js +22 -0
- package/dist/tools/people-tools.d.ts +19 -0
- package/dist/tools/registry.d.ts +34 -0
- package/dist/tools/shared.d.ts +75 -0
- package/dist/tracing/index.d.ts +25 -0
- package/dist/tracing/index.js +69 -0
- package/dist/webhooks/index.d.ts +3 -0
- package/dist/webhooks/index.js +227 -0
- package/dist/webhooks/parse.d.ts +41 -0
- package/dist/webhooks/secret.d.ts +4 -0
- package/package.json +181 -4
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
/** The variable's value, or `undefined` when it is unset or empty. */
|
|
2
|
+
export declare const readEnv: (name: string) => string | undefined;
|
|
3
|
+
/** An explicit option, else the environment variable, else `Unauthorized`. */
|
|
4
|
+
export declare const requireCredential: (explicit: string | undefined, envName: string, provider: string) => string;
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
import type { Json, JsonObject } from "./json.ts";
|
|
2
|
+
export type OutboundErrorCode = "Invalid" | "NotFound" | "Provider" | "RateLimited" | "Unauthorized" | "Unsupported";
|
|
3
|
+
export interface OutboundErrorOptions {
|
|
4
|
+
/**
|
|
5
|
+
* The original error or vendor response, for debugging. It is kept as a
|
|
6
|
+
* copy with secrets and email addresses removed, because loggers print the
|
|
7
|
+
* cause chain.
|
|
8
|
+
*/
|
|
9
|
+
readonly cause?: unknown;
|
|
10
|
+
readonly provider?: string | undefined;
|
|
11
|
+
/** The HTTP status that produced this error, when there was one. */
|
|
12
|
+
readonly status?: number | undefined;
|
|
13
|
+
/** How long the vendor asked us to wait. Set on `RateLimited`. */
|
|
14
|
+
readonly retryAfterMs?: number | undefined;
|
|
15
|
+
readonly aborted?: boolean | undefined;
|
|
16
|
+
readonly timedOut?: boolean | undefined;
|
|
17
|
+
/** Secrets to strip from the message. */
|
|
18
|
+
readonly secrets?: readonly string[] | undefined;
|
|
19
|
+
}
|
|
20
|
+
declare const BRAND: unique symbol;
|
|
21
|
+
/**
|
|
22
|
+
* The one error class the SDK throws. Branch on `code`, never on a subclass.
|
|
23
|
+
*/
|
|
24
|
+
export declare class OutboundError extends Error {
|
|
25
|
+
readonly name = "OutboundError";
|
|
26
|
+
readonly code: OutboundErrorCode;
|
|
27
|
+
readonly provider: string | undefined;
|
|
28
|
+
readonly status: number | undefined;
|
|
29
|
+
readonly retryAfterMs: number | undefined;
|
|
30
|
+
readonly aborted: boolean;
|
|
31
|
+
readonly timedOut: boolean;
|
|
32
|
+
/** `true` when retrying the same call cannot succeed. */
|
|
33
|
+
readonly permanent: boolean;
|
|
34
|
+
readonly [BRAND] = true;
|
|
35
|
+
constructor(code: OutboundErrorCode, message: string, options?: OutboundErrorOptions);
|
|
36
|
+
/** Type guard that also recognises errors from another copy of the package. */
|
|
37
|
+
static is(cause: unknown): cause is OutboundError;
|
|
38
|
+
}
|
|
39
|
+
/** What the request engine hands an adapter's `mapError`. */
|
|
40
|
+
export interface HttpFailure {
|
|
41
|
+
readonly status: number;
|
|
42
|
+
readonly body: Json | undefined;
|
|
43
|
+
readonly retryAfterMs: number | undefined;
|
|
44
|
+
}
|
|
45
|
+
export declare const isHttpFailure: (cause: unknown) => cause is HttpFailure;
|
|
46
|
+
export interface ErrorMapperOptions {
|
|
47
|
+
readonly secrets?: readonly string[];
|
|
48
|
+
/** Per-status overrides for vendors that use a status unconventionally. */
|
|
49
|
+
readonly statusCodes?: Readonly<Record<number, OutboundErrorCode>>;
|
|
50
|
+
}
|
|
51
|
+
export type ErrorMapper = (cause: unknown) => OutboundError;
|
|
52
|
+
/**
|
|
53
|
+
* Builds an adapter's `mapError`. HTTP failures map by status; anything else
|
|
54
|
+
* becomes a retryable `Provider` error with the original kept in `cause`.
|
|
55
|
+
*/
|
|
56
|
+
export declare const makeErrorMapper: (provider: string, options?: ErrorMapperOptions) => ErrorMapper;
|
|
57
|
+
/**
|
|
58
|
+
* A vendor response that must be one object. Anything else is the vendor's
|
|
59
|
+
* fault, so it is a `Provider` error with the adapter's own message.
|
|
60
|
+
*/
|
|
61
|
+
export declare const requireObject: (body: Json | undefined, provider: string, message: string) => JsonObject;
|
|
62
|
+
export {};
|
|
@@ -0,0 +1,462 @@
|
|
|
1
|
+
import type { z } from "zod";
|
|
2
|
+
/** Every record the SDK returns, by the name the coverage uses for it. */
|
|
3
|
+
export declare const RECORD_SCHEMAS: {
|
|
4
|
+
readonly blockEntry: z.ZodObject<{
|
|
5
|
+
createdAt: z.ZodNullable<z.ZodISODateTime>;
|
|
6
|
+
kind: z.ZodEnum<{
|
|
7
|
+
email: "email";
|
|
8
|
+
linkedin: "linkedin";
|
|
9
|
+
other: "other";
|
|
10
|
+
company: "company";
|
|
11
|
+
domain: "domain";
|
|
12
|
+
}>;
|
|
13
|
+
value: z.ZodString;
|
|
14
|
+
provider: z.ZodString;
|
|
15
|
+
raw: z.ZodJSONSchema;
|
|
16
|
+
ref: z.ZodString;
|
|
17
|
+
schemaVersion: z.ZodLiteral<1>;
|
|
18
|
+
sourceId: z.ZodString;
|
|
19
|
+
workspaceId: z.ZodString;
|
|
20
|
+
}, z.core.$strip>;
|
|
21
|
+
readonly campaign: z.ZodObject<{
|
|
22
|
+
channel: z.ZodEnum<{
|
|
23
|
+
email: "email";
|
|
24
|
+
linkedin: "linkedin";
|
|
25
|
+
}>;
|
|
26
|
+
createdAt: z.ZodNullable<z.ZodISODateTime>;
|
|
27
|
+
name: z.ZodString;
|
|
28
|
+
status: z.ZodEnum<{
|
|
29
|
+
active: "active";
|
|
30
|
+
archived: "archived";
|
|
31
|
+
completed: "completed";
|
|
32
|
+
draft: "draft";
|
|
33
|
+
paused: "paused";
|
|
34
|
+
unknown: "unknown";
|
|
35
|
+
}>;
|
|
36
|
+
tags: z.ZodArray<z.ZodString>;
|
|
37
|
+
provider: z.ZodString;
|
|
38
|
+
raw: z.ZodJSONSchema;
|
|
39
|
+
ref: z.ZodString;
|
|
40
|
+
schemaVersion: z.ZodLiteral<1>;
|
|
41
|
+
sourceId: z.ZodString;
|
|
42
|
+
workspaceId: z.ZodString;
|
|
43
|
+
}, z.core.$strip>;
|
|
44
|
+
readonly campaignProgress: z.ZodObject<{
|
|
45
|
+
blocked: z.ZodNullable<z.ZodNumber>;
|
|
46
|
+
campaignRef: z.ZodString;
|
|
47
|
+
completed: z.ZodNullable<z.ZodNumber>;
|
|
48
|
+
failed: z.ZodNullable<z.ZodNumber>;
|
|
49
|
+
inProgress: z.ZodNullable<z.ZodNumber>;
|
|
50
|
+
leads: z.ZodNullable<z.ZodNumber>;
|
|
51
|
+
notStarted: z.ZodNullable<z.ZodNumber>;
|
|
52
|
+
stopped: z.ZodNullable<z.ZodNumber>;
|
|
53
|
+
provider: z.ZodString;
|
|
54
|
+
raw: z.ZodJSONSchema;
|
|
55
|
+
ref: z.ZodString;
|
|
56
|
+
schemaVersion: z.ZodLiteral<1>;
|
|
57
|
+
sourceId: z.ZodString;
|
|
58
|
+
workspaceId: z.ZodString;
|
|
59
|
+
}, z.core.$strip>;
|
|
60
|
+
readonly campaignSettings: z.ZodObject<{
|
|
61
|
+
campaignRef: z.ZodString;
|
|
62
|
+
dailyLimit: z.ZodNullable<z.ZodNumber>;
|
|
63
|
+
dailyNewLeads: z.ZodNullable<z.ZodNumber>;
|
|
64
|
+
endDate: z.ZodNullable<z.ZodISODate>;
|
|
65
|
+
gapMinutes: z.ZodNullable<z.ZodNumber>;
|
|
66
|
+
plainText: z.ZodNullable<z.ZodBoolean>;
|
|
67
|
+
schedule: z.ZodArray<z.ZodObject<{
|
|
68
|
+
days: z.ZodArray<z.ZodNumber>;
|
|
69
|
+
from: z.ZodNullable<z.ZodString>;
|
|
70
|
+
name: z.ZodNullable<z.ZodString>;
|
|
71
|
+
timezone: z.ZodNullable<z.ZodString>;
|
|
72
|
+
to: z.ZodNullable<z.ZodString>;
|
|
73
|
+
}, z.core.$strip>>;
|
|
74
|
+
startDate: z.ZodNullable<z.ZodISODate>;
|
|
75
|
+
stopOnAutoReply: z.ZodNullable<z.ZodBoolean>;
|
|
76
|
+
stopOnReply: z.ZodNullable<z.ZodBoolean>;
|
|
77
|
+
tracking: z.ZodObject<{
|
|
78
|
+
clicks: z.ZodNullable<z.ZodBoolean>;
|
|
79
|
+
opens: z.ZodNullable<z.ZodBoolean>;
|
|
80
|
+
}, z.core.$strip>;
|
|
81
|
+
provider: z.ZodString;
|
|
82
|
+
raw: z.ZodJSONSchema;
|
|
83
|
+
ref: z.ZodString;
|
|
84
|
+
schemaVersion: z.ZodLiteral<1>;
|
|
85
|
+
sourceId: z.ZodString;
|
|
86
|
+
workspaceId: z.ZodString;
|
|
87
|
+
}, z.core.$strip>;
|
|
88
|
+
readonly lead: z.ZodObject<{
|
|
89
|
+
bounced: z.ZodNullable<z.ZodBoolean>;
|
|
90
|
+
campaignRef: z.ZodNullable<z.ZodString>;
|
|
91
|
+
company: z.ZodNullable<z.ZodString>;
|
|
92
|
+
companyLinkedinUrl: z.ZodNullable<z.ZodString>;
|
|
93
|
+
createdAt: z.ZodNullable<z.ZodISODateTime>;
|
|
94
|
+
custom: z.ZodRecord<z.ZodString, z.ZodString>;
|
|
95
|
+
email: z.ZodNullable<z.ZodString>;
|
|
96
|
+
engagement: z.ZodNullable<z.ZodObject<{
|
|
97
|
+
clicks: z.ZodNullable<z.ZodNumber>;
|
|
98
|
+
lastContactedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
99
|
+
lastOpenedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
100
|
+
lastRepliedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
101
|
+
opens: z.ZodNullable<z.ZodNumber>;
|
|
102
|
+
replies: z.ZodNullable<z.ZodNumber>;
|
|
103
|
+
repliedStepIndex: z.ZodNullable<z.ZodNumber>;
|
|
104
|
+
stepIndex: z.ZodNullable<z.ZodNumber>;
|
|
105
|
+
}, z.core.$strip>>;
|
|
106
|
+
firstName: z.ZodNullable<z.ZodString>;
|
|
107
|
+
interest: z.ZodNullable<z.ZodString>;
|
|
108
|
+
interestCategory: z.ZodNullable<z.ZodEnum<{
|
|
109
|
+
unknown: "unknown";
|
|
110
|
+
bounce: "bounce";
|
|
111
|
+
negative: "negative";
|
|
112
|
+
neutral: "neutral";
|
|
113
|
+
ooo: "ooo";
|
|
114
|
+
positive: "positive";
|
|
115
|
+
unsubscribe: "unsubscribe";
|
|
116
|
+
}>>;
|
|
117
|
+
lastName: z.ZodNullable<z.ZodString>;
|
|
118
|
+
linkedinUrl: z.ZodNullable<z.ZodString>;
|
|
119
|
+
location: z.ZodNullable<z.ZodString>;
|
|
120
|
+
phone: z.ZodNullable<z.ZodString>;
|
|
121
|
+
progress: z.ZodEnum<{
|
|
122
|
+
active: "active";
|
|
123
|
+
completed: "completed";
|
|
124
|
+
paused: "paused";
|
|
125
|
+
unknown: "unknown";
|
|
126
|
+
}>;
|
|
127
|
+
replied: z.ZodNullable<z.ZodBoolean>;
|
|
128
|
+
status: z.ZodEnum<{
|
|
129
|
+
active: "active";
|
|
130
|
+
completed: "completed";
|
|
131
|
+
paused: "paused";
|
|
132
|
+
unknown: "unknown";
|
|
133
|
+
bounced: "bounced";
|
|
134
|
+
replied: "replied";
|
|
135
|
+
unsubscribed: "unsubscribed";
|
|
136
|
+
}>;
|
|
137
|
+
tags: z.ZodArray<z.ZodString>;
|
|
138
|
+
title: z.ZodNullable<z.ZodString>;
|
|
139
|
+
unsubscribed: z.ZodNullable<z.ZodBoolean>;
|
|
140
|
+
website: z.ZodNullable<z.ZodString>;
|
|
141
|
+
provider: z.ZodString;
|
|
142
|
+
raw: z.ZodJSONSchema;
|
|
143
|
+
ref: z.ZodString;
|
|
144
|
+
schemaVersion: z.ZodLiteral<1>;
|
|
145
|
+
sourceId: z.ZodString;
|
|
146
|
+
workspaceId: z.ZodString;
|
|
147
|
+
}, z.core.$strip>;
|
|
148
|
+
readonly leadList: z.ZodObject<{
|
|
149
|
+
createdAt: z.ZodNullable<z.ZodISODateTime>;
|
|
150
|
+
kind: z.ZodEnum<{
|
|
151
|
+
leads: "leads";
|
|
152
|
+
companies: "companies";
|
|
153
|
+
}>;
|
|
154
|
+
name: z.ZodString;
|
|
155
|
+
size: z.ZodNullable<z.ZodNumber>;
|
|
156
|
+
provider: z.ZodString;
|
|
157
|
+
raw: z.ZodJSONSchema;
|
|
158
|
+
ref: z.ZodString;
|
|
159
|
+
schemaVersion: z.ZodLiteral<1>;
|
|
160
|
+
sourceId: z.ZodString;
|
|
161
|
+
workspaceId: z.ZodString;
|
|
162
|
+
}, z.core.$strip>;
|
|
163
|
+
readonly message: z.ZodObject<{
|
|
164
|
+
direction: z.ZodEnum<{
|
|
165
|
+
in: "in";
|
|
166
|
+
out: "out";
|
|
167
|
+
}>;
|
|
168
|
+
bodyHtml: z.ZodNullable<z.ZodString>;
|
|
169
|
+
bodyText: z.ZodNullable<z.ZodString>;
|
|
170
|
+
campaignRef: z.ZodNullable<z.ZodString>;
|
|
171
|
+
channel: z.ZodEnum<{
|
|
172
|
+
email: "email";
|
|
173
|
+
linkedin: "linkedin";
|
|
174
|
+
}>;
|
|
175
|
+
leadRef: z.ZodNullable<z.ZodString>;
|
|
176
|
+
senderRef: z.ZodNullable<z.ZodString>;
|
|
177
|
+
sentAt: z.ZodNullable<z.ZodISODateTime>;
|
|
178
|
+
stepIndex: z.ZodNullable<z.ZodNumber>;
|
|
179
|
+
subject: z.ZodNullable<z.ZodString>;
|
|
180
|
+
threadId: z.ZodNullable<z.ZodString>;
|
|
181
|
+
variantKey: z.ZodNullable<z.ZodString>;
|
|
182
|
+
provider: z.ZodString;
|
|
183
|
+
raw: z.ZodJSONSchema;
|
|
184
|
+
ref: z.ZodString;
|
|
185
|
+
schemaVersion: z.ZodLiteral<1>;
|
|
186
|
+
sourceId: z.ZodString;
|
|
187
|
+
workspaceId: z.ZodString;
|
|
188
|
+
}, z.core.$strip>;
|
|
189
|
+
readonly metricRow: z.ZodObject<{
|
|
190
|
+
bounced: z.ZodNullable<z.ZodNumber>;
|
|
191
|
+
clicked: z.ZodNullable<z.ZodNumber>;
|
|
192
|
+
clickedTotal: z.ZodNullable<z.ZodNumber>;
|
|
193
|
+
connectionsAccepted: z.ZodNullable<z.ZodNumber>;
|
|
194
|
+
connectionsSent: z.ZodNullable<z.ZodNumber>;
|
|
195
|
+
contacted: z.ZodNullable<z.ZodNumber>;
|
|
196
|
+
contentHash: z.ZodNullable<z.ZodString>;
|
|
197
|
+
date: z.ZodNullable<z.ZodISODate>;
|
|
198
|
+
delivered: z.ZodNullable<z.ZodNumber>;
|
|
199
|
+
evidence: z.ZodEnum<{
|
|
200
|
+
derived: "derived";
|
|
201
|
+
exact: "exact";
|
|
202
|
+
sampled: "sampled";
|
|
203
|
+
}>;
|
|
204
|
+
inmailsSent: z.ZodNullable<z.ZodNumber>;
|
|
205
|
+
opened: z.ZodNullable<z.ZodNumber>;
|
|
206
|
+
openedTotal: z.ZodNullable<z.ZodNumber>;
|
|
207
|
+
positive: z.ZodNullable<z.ZodNumber>;
|
|
208
|
+
provider: z.ZodString;
|
|
209
|
+
replied: z.ZodNullable<z.ZodNumber>;
|
|
210
|
+
repliedAuto: z.ZodNullable<z.ZodNumber>;
|
|
211
|
+
schemaVersion: z.ZodLiteral<1>;
|
|
212
|
+
scope: z.ZodEnum<{
|
|
213
|
+
campaign: "campaign";
|
|
214
|
+
sender: "sender";
|
|
215
|
+
step: "step";
|
|
216
|
+
workspace: "workspace";
|
|
217
|
+
}>;
|
|
218
|
+
scopeRef: z.ZodString;
|
|
219
|
+
sent: z.ZodNullable<z.ZodNumber>;
|
|
220
|
+
stepIndex: z.ZodNullable<z.ZodNumber>;
|
|
221
|
+
timezone: z.ZodNullable<z.ZodString>;
|
|
222
|
+
unsubscribed: z.ZodNullable<z.ZodNumber>;
|
|
223
|
+
variantKey: z.ZodNullable<z.ZodString>;
|
|
224
|
+
workspaceId: z.ZodString;
|
|
225
|
+
}, z.core.$strip>;
|
|
226
|
+
readonly placementTest: z.ZodObject<{
|
|
227
|
+
campaignRef: z.ZodNullable<z.ZodString>;
|
|
228
|
+
createdAt: z.ZodNullable<z.ZodISODateTime>;
|
|
229
|
+
endsAt: z.ZodNullable<z.ZodISODateTime>;
|
|
230
|
+
kind: z.ZodNullable<z.ZodEnum<{
|
|
231
|
+
automated: "automated";
|
|
232
|
+
one_time: "one_time";
|
|
233
|
+
}>>;
|
|
234
|
+
name: z.ZodString;
|
|
235
|
+
nextRunAt: z.ZodNullable<z.ZodISODateTime>;
|
|
236
|
+
startsAt: z.ZodNullable<z.ZodISODateTime>;
|
|
237
|
+
status: z.ZodEnum<{
|
|
238
|
+
active: "active";
|
|
239
|
+
completed: "completed";
|
|
240
|
+
paused: "paused";
|
|
241
|
+
unknown: "unknown";
|
|
242
|
+
}>;
|
|
243
|
+
provider: z.ZodString;
|
|
244
|
+
raw: z.ZodJSONSchema;
|
|
245
|
+
ref: z.ZodString;
|
|
246
|
+
schemaVersion: z.ZodLiteral<1>;
|
|
247
|
+
sourceId: z.ZodString;
|
|
248
|
+
workspaceId: z.ZodString;
|
|
249
|
+
}, z.core.$strip>;
|
|
250
|
+
readonly reply: z.ZodObject<{
|
|
251
|
+
category: z.ZodEnum<{
|
|
252
|
+
unknown: "unknown";
|
|
253
|
+
bounce: "bounce";
|
|
254
|
+
negative: "negative";
|
|
255
|
+
neutral: "neutral";
|
|
256
|
+
ooo: "ooo";
|
|
257
|
+
positive: "positive";
|
|
258
|
+
unsubscribe: "unsubscribe";
|
|
259
|
+
}>;
|
|
260
|
+
categorySource: z.ZodNullable<z.ZodEnum<{
|
|
261
|
+
vendor: "vendor";
|
|
262
|
+
lead: "lead";
|
|
263
|
+
rule: "rule";
|
|
264
|
+
}>>;
|
|
265
|
+
direction: z.ZodLiteral<"in">;
|
|
266
|
+
isAuto: z.ZodNullable<z.ZodBoolean>;
|
|
267
|
+
unread: z.ZodNullable<z.ZodBoolean>;
|
|
268
|
+
bodyHtml: z.ZodNullable<z.ZodString>;
|
|
269
|
+
bodyText: z.ZodNullable<z.ZodString>;
|
|
270
|
+
campaignRef: z.ZodNullable<z.ZodString>;
|
|
271
|
+
channel: z.ZodEnum<{
|
|
272
|
+
email: "email";
|
|
273
|
+
linkedin: "linkedin";
|
|
274
|
+
}>;
|
|
275
|
+
leadRef: z.ZodNullable<z.ZodString>;
|
|
276
|
+
senderRef: z.ZodNullable<z.ZodString>;
|
|
277
|
+
sentAt: z.ZodNullable<z.ZodISODateTime>;
|
|
278
|
+
stepIndex: z.ZodNullable<z.ZodNumber>;
|
|
279
|
+
subject: z.ZodNullable<z.ZodString>;
|
|
280
|
+
threadId: z.ZodNullable<z.ZodString>;
|
|
281
|
+
variantKey: z.ZodNullable<z.ZodString>;
|
|
282
|
+
provider: z.ZodString;
|
|
283
|
+
raw: z.ZodJSONSchema;
|
|
284
|
+
ref: z.ZodString;
|
|
285
|
+
schemaVersion: z.ZodLiteral<1>;
|
|
286
|
+
sourceId: z.ZodString;
|
|
287
|
+
workspaceId: z.ZodString;
|
|
288
|
+
}, z.core.$strip>;
|
|
289
|
+
readonly sender: z.ZodObject<{
|
|
290
|
+
address: z.ZodNullable<z.ZodString>;
|
|
291
|
+
dailyLimit: z.ZodNullable<z.ZodNumber>;
|
|
292
|
+
kind: z.ZodEnum<{
|
|
293
|
+
linkedin: "linkedin";
|
|
294
|
+
mailbox: "mailbox";
|
|
295
|
+
}>;
|
|
296
|
+
linkedinUrl: z.ZodNullable<z.ZodString>;
|
|
297
|
+
mailProvider: z.ZodNullable<z.ZodEnum<{
|
|
298
|
+
google: "google";
|
|
299
|
+
microsoft: "microsoft";
|
|
300
|
+
other: "other";
|
|
301
|
+
smtp: "smtp";
|
|
302
|
+
}>>;
|
|
303
|
+
name: z.ZodNullable<z.ZodString>;
|
|
304
|
+
status: z.ZodEnum<{
|
|
305
|
+
error: "error";
|
|
306
|
+
active: "active";
|
|
307
|
+
paused: "paused";
|
|
308
|
+
unknown: "unknown";
|
|
309
|
+
disconnected: "disconnected";
|
|
310
|
+
}>;
|
|
311
|
+
tags: z.ZodArray<z.ZodString>;
|
|
312
|
+
warmup: z.ZodNullable<z.ZodObject<{
|
|
313
|
+
enabled: z.ZodNullable<z.ZodBoolean>;
|
|
314
|
+
score: z.ZodNullable<z.ZodNumber>;
|
|
315
|
+
}, z.core.$strip>>;
|
|
316
|
+
provider: z.ZodString;
|
|
317
|
+
raw: z.ZodJSONSchema;
|
|
318
|
+
ref: z.ZodString;
|
|
319
|
+
schemaVersion: z.ZodLiteral<1>;
|
|
320
|
+
sourceId: z.ZodString;
|
|
321
|
+
workspaceId: z.ZodString;
|
|
322
|
+
}, z.core.$strip>;
|
|
323
|
+
readonly senderHealth: z.ZodObject<{
|
|
324
|
+
blacklisted: z.ZodNullable<z.ZodBoolean>;
|
|
325
|
+
checkedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
326
|
+
connected: z.ZodNullable<z.ZodBoolean>;
|
|
327
|
+
dns: z.ZodObject<{
|
|
328
|
+
dkim: z.ZodNullable<z.ZodBoolean>;
|
|
329
|
+
dmarc: z.ZodNullable<z.ZodBoolean>;
|
|
330
|
+
mx: z.ZodNullable<z.ZodBoolean>;
|
|
331
|
+
spf: z.ZodNullable<z.ZodBoolean>;
|
|
332
|
+
}, z.core.$strip>;
|
|
333
|
+
domain: z.ZodNullable<z.ZodString>;
|
|
334
|
+
issues: z.ZodArray<z.ZodString>;
|
|
335
|
+
senderRef: z.ZodString;
|
|
336
|
+
warmup: z.ZodNullable<z.ZodObject<{
|
|
337
|
+
inbox: z.ZodNullable<z.ZodNumber>;
|
|
338
|
+
received: z.ZodNullable<z.ZodNumber>;
|
|
339
|
+
score: z.ZodNullable<z.ZodNumber>;
|
|
340
|
+
sent: z.ZodNullable<z.ZodNumber>;
|
|
341
|
+
spam: z.ZodNullable<z.ZodNumber>;
|
|
342
|
+
}, z.core.$strip>>;
|
|
343
|
+
provider: z.ZodString;
|
|
344
|
+
raw: z.ZodJSONSchema;
|
|
345
|
+
ref: z.ZodString;
|
|
346
|
+
schemaVersion: z.ZodLiteral<1>;
|
|
347
|
+
sourceId: z.ZodString;
|
|
348
|
+
workspaceId: z.ZodString;
|
|
349
|
+
}, z.core.$strip>;
|
|
350
|
+
readonly sequence: z.ZodObject<{
|
|
351
|
+
campaignRef: z.ZodString;
|
|
352
|
+
kind: z.ZodEnum<{
|
|
353
|
+
main: "main";
|
|
354
|
+
subsequence: "subsequence";
|
|
355
|
+
}>;
|
|
356
|
+
name: z.ZodNullable<z.ZodString>;
|
|
357
|
+
steps: z.ZodArray<z.ZodObject<{
|
|
358
|
+
action: z.ZodString;
|
|
359
|
+
branch: z.ZodNullable<z.ZodString>;
|
|
360
|
+
delayDays: z.ZodNullable<z.ZodNumber>;
|
|
361
|
+
index: z.ZodNumber;
|
|
362
|
+
parentIndex: z.ZodNullable<z.ZodNumber>;
|
|
363
|
+
variants: z.ZodArray<z.ZodObject<{
|
|
364
|
+
body: z.ZodNullable<z.ZodString>;
|
|
365
|
+
contentHash: z.ZodString;
|
|
366
|
+
subject: z.ZodNullable<z.ZodString>;
|
|
367
|
+
variantKey: z.ZodString;
|
|
368
|
+
}, z.core.$strip>>;
|
|
369
|
+
}, z.core.$strip>>;
|
|
370
|
+
provider: z.ZodString;
|
|
371
|
+
raw: z.ZodJSONSchema;
|
|
372
|
+
ref: z.ZodString;
|
|
373
|
+
schemaVersion: z.ZodLiteral<1>;
|
|
374
|
+
sourceId: z.ZodString;
|
|
375
|
+
workspaceId: z.ZodString;
|
|
376
|
+
}, z.core.$strip>;
|
|
377
|
+
readonly tag: z.ZodObject<{
|
|
378
|
+
description: z.ZodNullable<z.ZodString>;
|
|
379
|
+
name: z.ZodString;
|
|
380
|
+
provider: z.ZodString;
|
|
381
|
+
raw: z.ZodJSONSchema;
|
|
382
|
+
ref: z.ZodString;
|
|
383
|
+
schemaVersion: z.ZodLiteral<1>;
|
|
384
|
+
sourceId: z.ZodString;
|
|
385
|
+
workspaceId: z.ZodString;
|
|
386
|
+
}, z.core.$strip>;
|
|
387
|
+
readonly webhook: z.ZodObject<{
|
|
388
|
+
active: z.ZodNullable<z.ZodBoolean>;
|
|
389
|
+
campaignRefs: z.ZodArray<z.ZodString>;
|
|
390
|
+
createdAt: z.ZodNullable<z.ZodISODateTime>;
|
|
391
|
+
eventTypes: z.ZodArray<z.ZodEnum<{
|
|
392
|
+
unknown: "unknown";
|
|
393
|
+
"campaign.status_changed": "campaign.status_changed";
|
|
394
|
+
"lead.status_changed": "lead.status_changed";
|
|
395
|
+
"lead.unsubscribed": "lead.unsubscribed";
|
|
396
|
+
"linkedin.connection_accepted": "linkedin.connection_accepted";
|
|
397
|
+
"linkedin.connection_sent": "linkedin.connection_sent";
|
|
398
|
+
"linkedin.message_received": "linkedin.message_received";
|
|
399
|
+
"linkedin.message_sent": "linkedin.message_sent";
|
|
400
|
+
"meeting.booked": "meeting.booked";
|
|
401
|
+
"message.bounced": "message.bounced";
|
|
402
|
+
"message.clicked": "message.clicked";
|
|
403
|
+
"message.opened": "message.opened";
|
|
404
|
+
"message.sent": "message.sent";
|
|
405
|
+
"reply.categorized": "reply.categorized";
|
|
406
|
+
"reply.received": "reply.received";
|
|
407
|
+
"sender.status_changed": "sender.status_changed";
|
|
408
|
+
}>>;
|
|
409
|
+
events: z.ZodArray<z.ZodString>;
|
|
410
|
+
name: z.ZodNullable<z.ZodString>;
|
|
411
|
+
url: z.ZodString;
|
|
412
|
+
provider: z.ZodString;
|
|
413
|
+
raw: z.ZodJSONSchema;
|
|
414
|
+
ref: z.ZodString;
|
|
415
|
+
schemaVersion: z.ZodLiteral<1>;
|
|
416
|
+
sourceId: z.ZodString;
|
|
417
|
+
workspaceId: z.ZodString;
|
|
418
|
+
}, z.core.$strip>;
|
|
419
|
+
readonly workspace: z.ZodObject<{
|
|
420
|
+
name: z.ZodString;
|
|
421
|
+
provider: z.ZodString;
|
|
422
|
+
raw: z.ZodJSONSchema;
|
|
423
|
+
ref: z.ZodString;
|
|
424
|
+
schemaVersion: z.ZodLiteral<1>;
|
|
425
|
+
sourceId: z.ZodString;
|
|
426
|
+
workspaceId: z.ZodString;
|
|
427
|
+
}, z.core.$strip>;
|
|
428
|
+
};
|
|
429
|
+
export type RecordName = keyof typeof RECORD_SCHEMAS;
|
|
430
|
+
/**
|
|
431
|
+
* `exact`: the vendor reports the field and the adapter reads it. `derived`:
|
|
432
|
+
* the adapter computes it, or takes it from a neighbouring record. `false`:
|
|
433
|
+
* this adapter never fills it, so it is always empty (`null`, `[]`, `{}` or
|
|
434
|
+
* `unknown`).
|
|
435
|
+
*/
|
|
436
|
+
export type FieldGrade = "derived" | "exact" | false;
|
|
437
|
+
type Identity = "provider" | "raw" | "ref" | "schemaVersion" | "sourceId" | "workspaceId";
|
|
438
|
+
type FieldOf<Name extends RecordName> = Exclude<keyof z.infer<(typeof RECORD_SCHEMAS)[Name]>, Identity>;
|
|
439
|
+
/**
|
|
440
|
+
* What an adapter declares: for each record, the fields it derives or never
|
|
441
|
+
* fills, or `false` for a record it never returns.
|
|
442
|
+
*/
|
|
443
|
+
export type FieldDeclaration = {
|
|
444
|
+
readonly [Name in RecordName]?: false | {
|
|
445
|
+
readonly [Field in FieldOf<Name>]?: "derived" | false;
|
|
446
|
+
};
|
|
447
|
+
};
|
|
448
|
+
/** Every field of every record, with its grade. */
|
|
449
|
+
export type FieldCoverage = {
|
|
450
|
+
readonly [Name in RecordName]: Readonly<Record<string, FieldGrade>>;
|
|
451
|
+
};
|
|
452
|
+
export declare const RECORD_NAMES: RecordName[];
|
|
453
|
+
/** The fields of a record that an adapter maps, in the schema's order. */
|
|
454
|
+
export declare const fieldsOf: (name: RecordName) => string[];
|
|
455
|
+
/** The full coverage behind a declaration. Saying nothing means `exact`. */
|
|
456
|
+
export declare const resolveFields: (declared?: FieldDeclaration) => FieldCoverage;
|
|
457
|
+
/**
|
|
458
|
+
* The coverage of several adapters read as one: a field is filled when any
|
|
459
|
+
* of them fills it, and `exact` when any of them reads it from its vendor.
|
|
460
|
+
*/
|
|
461
|
+
export declare const mergeFields: (coverages: readonly FieldCoverage[]) => FieldCoverage;
|
|
462
|
+
export {};
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
export interface ActionEvent {
|
|
2
|
+
/** The operation, for example `campaigns.list`. */
|
|
3
|
+
readonly action: string;
|
|
4
|
+
readonly provider: string;
|
|
5
|
+
readonly workspaceId: string;
|
|
6
|
+
readonly durationMs: number;
|
|
7
|
+
/** Vendor requests the call made. */
|
|
8
|
+
readonly requests: number;
|
|
9
|
+
readonly throttledMs: number;
|
|
10
|
+
}
|
|
11
|
+
export interface ErrorEvent {
|
|
12
|
+
readonly action: string;
|
|
13
|
+
readonly provider: string;
|
|
14
|
+
readonly workspaceId: string;
|
|
15
|
+
readonly error: Error;
|
|
16
|
+
}
|
|
17
|
+
export interface RetryEvent {
|
|
18
|
+
readonly provider: string;
|
|
19
|
+
/** The attempt that failed, starting at 1. */
|
|
20
|
+
readonly attempt: number;
|
|
21
|
+
readonly delayMs: number;
|
|
22
|
+
readonly reason: string;
|
|
23
|
+
/** The request URL with secrets removed. */
|
|
24
|
+
readonly url: string;
|
|
25
|
+
}
|
|
26
|
+
export interface ThrottleEvent {
|
|
27
|
+
readonly provider: string;
|
|
28
|
+
readonly lane: string;
|
|
29
|
+
readonly waitMs: number;
|
|
30
|
+
}
|
|
31
|
+
export interface RequestEvent {
|
|
32
|
+
readonly provider: string;
|
|
33
|
+
readonly method: string;
|
|
34
|
+
/** The request URL with secrets removed. */
|
|
35
|
+
readonly url: string;
|
|
36
|
+
readonly lane: string;
|
|
37
|
+
/** The HTTP status, or `null` when no response arrived. */
|
|
38
|
+
readonly status: number | null;
|
|
39
|
+
readonly durationMs: number;
|
|
40
|
+
/** Which attempt this was, starting at 1. */
|
|
41
|
+
readonly attempt: number;
|
|
42
|
+
}
|
|
43
|
+
type Hook<Event> = (event: Event) => void | Promise<void>;
|
|
44
|
+
export interface OutboundHooks {
|
|
45
|
+
readonly onAction?: Hook<ActionEvent> | undefined;
|
|
46
|
+
readonly onError?: Hook<ErrorEvent> | undefined;
|
|
47
|
+
/** Fires once per HTTP request, after it settles. */
|
|
48
|
+
readonly onRequest?: Hook<RequestEvent> | undefined;
|
|
49
|
+
readonly onRetry?: Hook<RetryEvent> | undefined;
|
|
50
|
+
readonly onThrottle?: Hook<ThrottleEvent> | undefined;
|
|
51
|
+
}
|
|
52
|
+
export declare const fire: <Event>(hook: Hook<Event> | undefined, event: Event) => void;
|
|
53
|
+
/** One set of hooks that calls every set given, in order. */
|
|
54
|
+
export declare const mergeHooks: (all: readonly (OutboundHooks | undefined)[]) => OutboundHooks;
|
|
55
|
+
export {};
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
export type Json = string | number | boolean | null | Json[] | JsonObject;
|
|
2
|
+
export interface JsonObject {
|
|
3
|
+
[key: string]: Json;
|
|
4
|
+
}
|
|
5
|
+
export declare const isJsonObject: (value: Json | undefined) => value is JsonObject;
|
|
6
|
+
export declare const isJsonArray: (value: Json | undefined) => value is Json[];
|
|
7
|
+
export declare const isString: (value: Json | undefined) => value is string;
|
|
8
|
+
export declare const isNumber: (value: Json | undefined) => value is number;
|
|
9
|
+
export declare const isBoolean: (value: Json | undefined) => value is boolean;
|
|
10
|
+
/** Reads `key` when `value` is an object, otherwise `undefined`. */
|
|
11
|
+
export declare const field: (value: Json | undefined, key: string) => Json | undefined;
|
|
12
|
+
/** A non-empty trimmed string, or `null`. Numbers become strings. */
|
|
13
|
+
export declare const text: (value: Json | undefined) => string | null;
|
|
14
|
+
/** A finite number, or `null`. Numeric strings are parsed. */
|
|
15
|
+
export declare const count: (value: Json | undefined) => number | null;
|
|
16
|
+
/** A first and a last name as one, or `null` when the vendor gave neither. */
|
|
17
|
+
export declare const fullName: (first: Json | undefined, last: Json | undefined) => string | null;
|
|
18
|
+
export declare const flag: (value: Json | undefined) => boolean | null;
|
|
19
|
+
export declare const list: (value: Json | undefined) => Json[];
|
|
20
|
+
export declare const objects: (value: Json | undefined) => JsonObject[];
|
|
21
|
+
/** An ISO 8601 UTC timestamp, or `null` when the value is not a date. */
|
|
22
|
+
export declare const timestamp: (value: Json | undefined) => string | null;
|
|
23
|
+
/** A lowercased, trimmed email address, or `null`. */
|
|
24
|
+
export declare const emailAddress: (value: Json | undefined) => string | null;
|
|
25
|
+
/** Parses a JSON string, returning `undefined` when it is not valid JSON. */
|
|
26
|
+
export declare const parseJson: (source: string) => Json | undefined;
|
|
27
|
+
/** An object's scalar values as strings, for a lead's custom fields. */
|
|
28
|
+
export declare const stringMap: (value: Json | undefined) => {
|
|
29
|
+
[k: string]: string;
|
|
30
|
+
};
|
|
31
|
+
/** A JSON object without the keys whose value is `null` or `undefined`. */
|
|
32
|
+
export declare const compactObject: (entries: Readonly<Record<string, Json | undefined>>) => JsonObject;
|
|
33
|
+
/**
|
|
34
|
+
* A typed value as plain JSON, the way `JSON.stringify` would write it:
|
|
35
|
+
* `undefined` keys are dropped and anything that is not JSON becomes `null`.
|
|
36
|
+
*/
|
|
37
|
+
export declare const toJson: <Value>(value: Value) => Json;
|
|
38
|
+
/**
|
|
39
|
+
* Says which key of `input` is not one of `known`, or `undefined` when every
|
|
40
|
+
* key is. Used so an input that would be ignored is refused instead.
|
|
41
|
+
*/
|
|
42
|
+
export declare const unknownKey: (known: readonly string[], input: Json | undefined) => string | undefined;
|
|
43
|
+
/**
|
|
44
|
+
* A copy of `value` without any key that matches `secret`, at any depth. A
|
|
45
|
+
* vendor payload kept on a record's `raw` can carry a mailbox password, a
|
|
46
|
+
* webhook's signing secret or the headers it sends, and none of them belongs
|
|
47
|
+
* in a record a caller logs or stores.
|
|
48
|
+
*/
|
|
49
|
+
export declare const withoutKeys: (value: Json, secret: RegExp) => Json;
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import type { Adapter } from "./adapter.ts";
|
|
2
|
+
import type { Lead } from "./entities.ts";
|
|
3
|
+
import type { FieldDeclaration } from "./fields.ts";
|
|
4
|
+
declare const MAPPABLE: readonly ["company", "companyLinkedinUrl", "linkedinUrl", "location", "phone", "title", "website"];
|
|
5
|
+
type Mappable = (typeof MAPPABLE)[number];
|
|
6
|
+
/**
|
|
7
|
+
* A lead field and the name of the custom field that holds it, for example
|
|
8
|
+
* `{ title: "job_title" }`. The name is matched exactly.
|
|
9
|
+
*/
|
|
10
|
+
export type LeadFieldMap = Readonly<Partial<Record<Mappable, string>>>;
|
|
11
|
+
/** `lead` with each mapped field the vendor left empty read from `custom`. */
|
|
12
|
+
export declare const fillFromCustom: (lead: Lead, map: LeadFieldMap) => Lead;
|
|
13
|
+
type LeadReaders = Pick<Adapter, "getLead" | "listLeads">;
|
|
14
|
+
/** The adapter's lead reads, with the mapped fields filled on every lead. */
|
|
15
|
+
export declare const withLeadFields: <Readers extends LeadReaders>(readers: Readers, map: LeadFieldMap | undefined) => Readers;
|
|
16
|
+
/**
|
|
17
|
+
* The adapter's field declaration once a map is given: a field it never
|
|
18
|
+
* filled is now worked out from a custom field, so it is `derived`.
|
|
19
|
+
*/
|
|
20
|
+
export declare const withMappedFields: (declared: FieldDeclaration, map: LeadFieldMap | undefined) => FieldDeclaration;
|
|
21
|
+
export {};
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type { Lead, LeadProgress } from "./entities.ts";
|
|
2
|
+
export interface LeadOutcome {
|
|
3
|
+
/** `true` once the lead replied. `null` when the vendor does not say. */
|
|
4
|
+
readonly replied: boolean | null;
|
|
5
|
+
readonly bounced: boolean | null;
|
|
6
|
+
readonly unsubscribed: boolean | null;
|
|
7
|
+
}
|
|
8
|
+
/**
|
|
9
|
+
* The four status fields of a lead. `status` is the outcome when one is
|
|
10
|
+
* known, in the order unsubscribed, bounced, replied, and the progress
|
|
11
|
+
* otherwise.
|
|
12
|
+
*/
|
|
13
|
+
export declare const leadStanding: (progress: LeadProgress, outcome: LeadOutcome) => Pick<Lead, "bounced" | "progress" | "replied" | "status" | "unsubscribed">;
|