MockProvider

Defined in: packages/provider/src/providers/mock/mock.provider.ts:101

Core provider interface for sending messages.

All providers must implement this interface. Optional capabilities (balance, templates, delivery status) are exposed via separate interfaces.

Example

class MyProvider implements Provider {
  readonly id = "my-provider";
  readonly name = "My Provider";
  readonly supportedTypes = ["SMS", "LMS"] as const;

  async healthCheck() { return { healthy: true, issues: [] }; }
  async send(params) { ... }
}

Implements

Constructors

Constructor

new MockProvider(options?): MockProvider

Defined in: packages/provider/src/providers/mock/mock.provider.ts:150

Parameters

options?

MockProviderOptions = {}

Returns

MockProvider

Properties

calls

calls: SendOptions[] = []

Defined in: packages/provider/src/providers/mock/mock.provider.ts:131

id

readonly id: string

Defined in: packages/provider/src/providers/mock/mock.provider.ts:108

Unique identifier for this provider instance. Used for routing and logging.

Example

"solapi"

Implementation of

Provider.id

name

readonly name: "Mock Provider" = "Mock Provider"

Defined in: packages/provider/src/providers/mock/mock.provider.ts:109

Human-readable name for display purposes.

Example

"SOLAPI"

Implementation of

Provider.name

supportedTypes

readonly supportedTypes: readonly MessageType[]

Defined in: packages/provider/src/providers/mock/mock.provider.ts:110

Message types this provider supports. Messages of unsupported types will be rejected.

Implementation of

Provider.supportedTypes

transportCapabilities

readonly transportCapabilities: object

Defined in: packages/provider/src/providers/mock/mock.provider.ts:126

Per-operation transport features supported by this provider. Missing declarations must be treated as unsupported.

abortSignal

readonly abortSignal: "supported" = "supported"

injectableFetch

readonly injectableFetch: "unsupported" = "unsupported"

Implementation of

Provider.transportCapabilities

Methods

addKakaoChannel()

addKakaoChannel(params): Promise<Result<KakaoChannel, KMsgError>>

Defined in: packages/provider/src/providers/mock/mock.provider.ts:568

Add a Kakao channel after authentication.

Parameters

params

authNum

string

categoryCode

string

phoneNumber

string

plusId

string

Returns

Promise<Result<KakaoChannel, KMsgError>>

Implementation of

KakaoChannelProvider.addKakaoChannel

clearHistory()

clearHistory(): void

Defined in: packages/provider/src/providers/mock/mock.provider.ts:401

Returns

void

clearScenario()

clearScenario(): void

Defined in: packages/provider/src/providers/mock/mock.provider.ts:310

Returns

void

createTemplate()

createTemplate(input, _ctx?): Promise<Result<Template, KMsgError>>

Defined in: packages/provider/src/providers/mock/mock.provider.ts:406

Create a new template.

Parameters

deleteTemplate()

deleteTemplate(code, _ctx?): Promise<Result<void, KMsgError>>

Defined in: packages/provider/src/providers/mock/mock.provider.ts:455

Delete a template by code.

Parameters

code

string

_ctx?

TemplateContext

Returns

Promise<Result<void, KMsgError>>

Implementation of

TemplateProvider.deleteTemplate

getDeliveryStatus()

getDeliveryStatus(query, context?): Promise<Result<DeliveryStatusResult | null, KMsgError>>

Defined in: packages/provider/src/providers/mock/mock.provider.ts:320

Reports the status of a message this provider sent. Sent messages read as DELIVERED until setDeliveryStatus changes them; an unknown providerMessageId reads as not found.

Parameters

query

DeliveryStatusQuery

context?

ProviderRequestContext

Returns

Promise<Result<DeliveryStatusResult | null, KMsgError>>

Implementation of

Provider.getDeliveryStatus

getHistory()

getHistory(): SendOptions[]

Defined in: packages/provider/src/providers/mock/mock.provider.ts:397

Returns

SendOptions[]

getOnboardingSpec()

getOnboardingSpec(): ProviderOnboardingSpec

Defined in: packages/provider/src/providers/mock/mock.provider.ts:141

Get the onboarding specification for this provider. Used by tooling to guide provider configuration.

Returns

ProviderOnboardingSpec

Implementation of

Provider.getOnboardingSpec

getTemplate()

getTemplate(code, _ctx?): Promise<Result<Template, KMsgError>>

Defined in: packages/provider/src/providers/mock/mock.provider.ts:471

Get a template by code.

Parameters

code

string

_ctx?

TemplateContext

Returns

Promise<Result<Template, KMsgError>>

Implementation of

TemplateProvider.getTemplate

healthCheck()

healthCheck(): Promise<{ healthy: boolean; issues: never[]; }>

Defined in: packages/provider/src/providers/mock/mock.provider.ts:186

Check if the provider is operational. Used for health monitoring and circuit breaker decisions.

Returns

Promise<{ healthy: boolean; issues: never[]; }>

Implementation of

Provider.healthCheck

listKakaoChannelCategories()

listKakaoChannelCategories(): Promise<Result<KakaoChannelCategories, KMsgError>>

Defined in: packages/provider/src/providers/mock/mock.provider.ts:535

List available channel categories for registration.

Returns

Promise<Result<KakaoChannelCategories, KMsgError>>

Implementation of

KakaoChannelProvider.listKakaoChannelCategories

listKakaoChannels()

listKakaoChannels(params?): Promise<Result<KakaoChannel[], KMsgError>>

Defined in: packages/provider/src/providers/mock/mock.provider.ts:521

List registered Kakao channels.

Parameters

params?

plusId?

string

senderKey?

string

Returns

Promise<Result<KakaoChannel[], KMsgError>>

Implementation of

KakaoChannelProvider.listKakaoChannels

listTemplates()

listTemplates(params?, _ctx?): Promise<Result<Template[], KMsgError>>

Defined in: packages/provider/src/providers/mock/mock.provider.ts:487

List templates with optional filtering and pagination.

Parameters

params?

limit?

number

page?

number

status?

string

_ctx?

TemplateContext

Returns

Promise<Result<Template[], KMsgError>>

Implementation of

TemplateProvider.listTemplates

mockFailure()

mockFailure(count): void

Defined in: packages/provider/src/providers/mock/mock.provider.ts:300

Parameters

count

number

Returns

void

mockScenario()

mockScenario(steps): void

Defined in: packages/provider/src/providers/mock/mock.provider.ts:305

Parameters

steps

MockSendScenarioStep[]

Returns

void

mockSuccess()

mockSuccess(): void

Defined in: packages/provider/src/providers/mock/mock.provider.ts:295

Returns

void

requestKakaoChannelAuth()

requestKakaoChannelAuth(params): Promise<Result<void, KMsgError>>

Defined in: packages/provider/src/providers/mock/mock.provider.ts:552

Request authentication SMS for channel registration.

Parameters

params

phoneNumber

string

plusId

string

Returns

Promise<Result<void, KMsgError>>

Implementation of

KakaoChannelProvider.requestKakaoChannelAuth

requestTemplateInspection()

requestTemplateInspection(code, _ctx?): Promise<Result<void, KMsgError>>

Defined in: packages/provider/src/providers/mock/mock.provider.ts:506

Request inspection for a template (submits for approval review).

Parameters

code

string

_ctx?

TemplateContext

Returns

Promise<Result<void, KMsgError>>

Implementation of

TemplateInspectionProvider.requestTemplateInspection

send()

send(params, context?): Promise<Result<SendResult, KMsgError>>

Defined in: packages/provider/src/providers/mock/mock.provider.ts:190

Send a message through this provider.

Parameters

params

SendOptions

context?

ProviderRequestContext

Returns

Promise<Result<SendResult, KMsgError>>

Result with SendResult on success, KMsgError on failure.

Implementation of

Provider.send

setDeliveryStatus()

setDeliveryStatus(providerMessageId, status, details?): void

Defined in: packages/provider/src/providers/mock/mock.provider.ts:340

Sets what getDeliveryStatus reports for a message this provider sent, for example FAILED with a provider status code to exercise failure paths. Throws for an id it did not send, so a typo in a test fails loudly.