MockProvider

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

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

• Provider
• TemplateProvider
• TemplateInspectionProvider
• KakaoChannelProvider

Constructors

Constructor

new MockProvider(): MockProvider

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

Returns

MockProvider

Properties

calls

calls: SendOptions[] = []

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

---

id

readonly id: "mock" = "mock"

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

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:70

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:71

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

Implementation of

Provider.supportedTypes

Methods

addKakaoChannel()

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

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

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:259

Returns

void

---

clearScenario()

clearScenario(): void

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

Returns

void

---

createTemplate()

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

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

Create a new template.

Parameters

input

TemplateCreateInput

_ctx?

TemplateContext

Returns

Promise<Result<Template, KMsgError>>

Implementation of

TemplateProvider.createTemplate

---

deleteTemplate()

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

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

Delete a template by code.

Parameters

code

string

_ctx?

TemplateContext

Returns

Promise<Result<void, KMsgError>>

Implementation of

TemplateProvider.deleteTemplate

---

getHistory()

getHistory(): SendOptions[]

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

Returns

SendOptions[]

---

getOnboardingSpec()

getOnboardingSpec(): ProviderOnboardingSpec

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

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:328

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:133

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:392

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:378

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:344

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:221

Parameters

count

number

Returns

void

---

mockScenario()

mockScenario(steps): void

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

Parameters

steps

MockSendScenarioStep[]

Returns

void

---

mockSuccess()

mockSuccess(): void

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

Returns

void

---

requestKakaoChannelAuth()

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

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

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:363

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): Promise<Result<SendResult, KMsgError>>

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

Send a message through this provider.

Parameters

params

SendOptions

Returns

Promise<Result<SendResult, KMsgError>>

Result with SendResult on success, KMsgError on failure.

Implementation of

Provider.send

---

updateTemplate()

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

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

Update an existing template by code.

Parameters

code

string

patch

TemplateUpdateInput

_ctx?

TemplateContext

Returns

Promise<Result<Template, KMsgError>>

Implementation of

TemplateProvider.updateTemplate