xep0191.ts

// ====================================================================
// XEP-0191: Blocking Command
// --------------------------------------------------------------------
// Source: https://xmpp.org/extensions/xep-0191.html
// Version: 1.3 (2015-03-12)
// ====================================================================

import { JID } from '../JID';
import { childBoolean, DefinitionOptions, extendStanzaError, multipleChildAttribute } from '../jxt';
import { NS_BLOCKING, NS_BLOCKING_ERRORS } from '../Namespaces';

declare module './' {
    export interface IQPayload {
        blockList?: Blocking;
    }

    export interface StanzaError {
        blocked?: boolean;
    }
}

export interface Blocking {
    action: 'list' | 'block' | 'unblock';
    jids?: JID[];
}
export interface BlockingList extends Blocking {
    action: 'list';
    jids: JID[];
}

const Protocol: DefinitionOptions[] = [
    extendStanzaError({
        blocked: childBoolean(NS_BLOCKING_ERRORS, 'blocked')
    }),
    {
        element: 'blocklist',
        fields: {
            jids: multipleChildAttribute(null, 'item', 'jid')
        },
        namespace: NS_BLOCKING,
        path: 'iq.blockList',
        type: 'list',
        typeField: 'action'
    },
    {
        element: 'block',
        fields: {
            jids: multipleChildAttribute(null, 'item', 'jid')
        },
        namespace: NS_BLOCKING,
        path: 'iq.blockList',
        type: 'block',
        typeField: 'action'
    },
    {
        element: 'unblock',
        fields: {
            jids: multipleChildAttribute(null, 'item', 'jid')
        },
        namespace: NS_BLOCKING,
        path: 'iq.blockList',
        type: 'unblock',
        typeField: 'action'
    }
];
export default Protocol;