jmap-kit
    Preparing search index...

    Type Alias CapabilityDefinition

    Capability definition with plugins

    type CapabilityDefinition = {
        invocations: Partial<Record<JMAPDataType, InvocationFactoryCollection>>;
        schema?: {
            accountCapability?: StandardSchemaV1;
            serverCapability?: StandardSchemaV1;
        };
        transformers?: TransformationPlugin<
            Exclude<PluginLifecycleHook, "pre-build">,
        >[];
        uri: JMAPCapability;
        validators?: ValidationPlugin<ValidationPluginLifecycleHook, any>[];
    }
    Index

    Properties

    invocations schema? transformers? uri validators?

    Properties

    invocations: Partial<Record<JMAPDataType, InvocationFactoryCollection>>

    The invocation factories organised by invocation type

    schema?: {
        accountCapability?: StandardSchemaV1;
        serverCapability?: StandardSchemaV1;
    }

    StandardSchema validators for this capability's session data.

    These schemas validate the capability's slice of the JMAP session object during connection. Any validation library that implements the StandardSchema interface can be used, keeping this library decoupled from a specific validation library.

    Type Declaration

    • OptionalaccountCapability?: StandardSchemaV1

      Schema for account.accountCapabilities[uri]

    • OptionalserverCapability?: StandardSchemaV1

      Schema for session.capabilities[uri]

    StandardSchema specification

    transformers?: TransformationPlugin<Exclude<PluginLifecycleHook, "pre-build">>[]

    Transformation plugins for this capability

    uri: JMAPCapability

    The capability URI

    validators?: ValidationPlugin<ValidationPluginLifecycleHook, any>[]

    Validation plugins for this capability

    Settings

    Member Visibility

    On This Page

    Properties