jmap-kit
    Preparing search index...

    Registry for managing JMAP capabilities

    The registry stores capability definitions and provides methods to register, unregister, and query capabilities. The Core capability is always registered and cannot be unregistered.

    Implements

    Index

    Constructors

    Methods

    • Execute transformers for the post-serialization hook

      Parameters

      • options: { context: PluginContext<"post-serialization">; hook?: "post-serialization" }

        The transformer execution context containing hook type and context data

        • context: PluginContext<"post-serialization">

          The context data to transform

        • Optionalhook?: "post-serialization"

          The lifecycle hook to execute transformers for

      Returns Promise<{ body: string | Blob | ArrayBuffer | File; headers: Headers }>

      A Promise resolving to the transformed data

    • Validate a single capability definition's schemas against session data without requiring the capability to be registered.

      Parameters

      • capability: CapabilityDefinition

        The capability definition to validate

      • serverCapabilities: Record<string, unknown>

        The server capabilities from the session

      • accounts: Record<string, { accountCapabilities: Record<string, unknown> }>

        The accounts from the session

      Returns Promise<
          {
              accountCapabilities: (
                  { errors: Error[]; valid: false } & {
                      accountId: string;
                      uri: keyof JMAPServerCapabilities;
                  }
              )[];
              serverCapabilities: (
                  { errors: Error[]; valid: false } & {
                      uri: keyof JMAPServerCapabilities;
                  }
              )[];
          },
      >

      An object containing arrays of server and account capability validation failures