coil-customer-sdk 0.1.1

Stable customer extension interfaces for the Coil framework.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

use std::sync::Arc;

use crate::{
    BackendError, CheckoutHooks, CmsHooks, CustomerPluginDescriptor, VerifiedWebhookAssetHooks,
    VerifiedWebhookHooks,
};

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum RegisteredHookKind {
    Checkout,
    CmsPagePublish,
    VerifiedWebhook,
    VerifiedWebhookAssets,
}

impl RegisteredHookKind {
    pub const fn as_str(self) -> &'static str {
        match self {
            Self::Checkout => "checkout",
            Self::CmsPagePublish => "cms.page_publish",
            Self::VerifiedWebhook => "verified_webhook",
            Self::VerifiedWebhookAssets => "verified_webhook.assets",
        }
    }
}

pub trait CustomerHookRegistry {
    fn register_checkout_hooks(
        &mut self,
        hooks: Arc<dyn CheckoutHooks>,
    ) -> Result<(), BackendError>;

    fn register_cms_hooks(&mut self, hooks: Arc<dyn CmsHooks>) -> Result<(), BackendError>;

    fn register_verified_webhook_hooks(
        &mut self,
        hooks: Arc<dyn VerifiedWebhookHooks>,
    ) -> Result<(), BackendError>;

    fn register_verified_webhook_asset_hooks(
        &mut self,
        hooks: Arc<dyn VerifiedWebhookAssetHooks>,
    ) -> Result<(), BackendError>;
}

pub trait CustomerBackendPlugin: Send + Sync + 'static {
    fn descriptor(&self) -> CustomerPluginDescriptor;

    fn register(&self, registry: &mut dyn CustomerHookRegistry) -> Result<(), BackendError>;
}