@pix.js/core/dist/index.d.cts

Core functions for Pix.js

import { z } from 'zod';

declare enum PointOfInitiationMethod {
    OnTimeOnly = 12
}
declare enum PixKeyType {
    Cpf = "CPF",
    Cnpj = "CNPJ",
    Email = "EMAIL",
    Phone = "PHONE",
    Evp = "EVP"
}
declare enum PixQrCodeType {
    Static = "STATIC",
    Dynamic = "DYNAMIC"
}
declare class ParserError extends Error {
    constructor(message: string);
}

declare const staticPixSchema: z.ZodEffects<z.ZodObject<{
    merchantAccountInfo: z.ZodEffects<z.ZodObject<{
        gui: z.ZodString;
        key: z.ZodString;
        merchantAdditionalInfo: z.ZodOptional<z.ZodString>;
        fss: z.ZodOptional<z.ZodString>;
    }, "strip", z.ZodTypeAny, {
        gui: string;
        key: string;
        merchantAdditionalInfo?: string | undefined;
        fss?: string | undefined;
    }, {
        gui: string;
        key: string;
        merchantAdditionalInfo?: string | undefined;
        fss?: string | undefined;
    }>, {
        gui: string;
        key: string;
        merchantAdditionalInfo?: string | undefined;
        fss?: string | undefined;
    }, {
        gui: string;
        key: string;
        merchantAdditionalInfo?: string | undefined;
        fss?: string | undefined;
    }>;
    value: z.ZodOptional<z.ZodNumber>;
    merchantCategoryCode: z.ZodString;
    transactionCurrency: z.ZodString;
    countryCode: z.ZodString;
    merchantName: z.ZodString;
    merchantCity: z.ZodString;
    additionalData: z.ZodObject<{
        txId: z.ZodString;
    }, "strip", z.ZodTypeAny, {
        txId: string;
    }, {
        txId: string;
    }>;
    postalCode: z.ZodOptional<z.ZodString>;
    unreservedTemplate: z.ZodOptional<z.ZodEffects<z.ZodObject<{
        gui: z.ZodOptional<z.ZodString>;
        url: z.ZodOptional<z.ZodString>;
    }, "strip", z.ZodTypeAny, {
        gui?: string | undefined;
        url?: string | undefined;
    }, {
        gui?: string | undefined;
        url?: string | undefined;
    }>, {
        gui?: string | undefined;
        url?: string | undefined;
    }, {
        gui?: string | undefined;
        url?: string | undefined;
    }>>;
}, "strip", z.ZodTypeAny, {
    merchantAccountInfo: {
        gui: string;
        key: string;
        merchantAdditionalInfo?: string | undefined;
        fss?: string | undefined;
    };
    merchantCategoryCode: string;
    transactionCurrency: string;
    countryCode: string;
    merchantName: string;
    merchantCity: string;
    additionalData: {
        txId: string;
    };
    value?: number | undefined;
    postalCode?: string | undefined;
    unreservedTemplate?: {
        gui?: string | undefined;
        url?: string | undefined;
    } | undefined;
}, {
    merchantAccountInfo: {
        gui: string;
        key: string;
        merchantAdditionalInfo?: string | undefined;
        fss?: string | undefined;
    };
    merchantCategoryCode: string;
    transactionCurrency: string;
    countryCode: string;
    merchantName: string;
    merchantCity: string;
    additionalData: {
        txId: string;
    };
    value?: number | undefined;
    postalCode?: string | undefined;
    unreservedTemplate?: {
        gui?: string | undefined;
        url?: string | undefined;
    } | undefined;
}>, {
    merchantAccountInfo: {
        gui: string;
        key: string;
        merchantAdditionalInfo?: string | undefined;
        fss?: string | undefined;
    };
    merchantCategoryCode: string;
    transactionCurrency: string;
    countryCode: string;
    merchantName: string;
    merchantCity: string;
    additionalData: {
        txId: string;
    };
    value?: number | undefined;
    postalCode?: string | undefined;
    unreservedTemplate?: {
        gui?: string | undefined;
        url?: string | undefined;
    } | undefined;
}, {
    merchantAccountInfo: {
        gui: string;
        key: string;
        merchantAdditionalInfo?: string | undefined;
        fss?: string | undefined;
    };
    merchantCategoryCode: string;
    transactionCurrency: string;
    countryCode: string;
    merchantName: string;
    merchantCity: string;
    additionalData: {
        txId: string;
    };
    value?: number | undefined;
    postalCode?: string | undefined;
    unreservedTemplate?: {
        gui?: string | undefined;
        url?: string | undefined;
    } | undefined;
}>;
declare const dynamicPixSchema: z.ZodEffects<z.ZodObject<{
    merchantAccountInfo: z.ZodEffects<z.ZodObject<{
        gui: z.ZodString;
        url: z.ZodString;
        merchantAdditionalInfo: z.ZodOptional<z.ZodString>;
        fss: z.ZodOptional<z.ZodString>;
    }, "strip", z.ZodTypeAny, {
        gui: string;
        url: string;
        merchantAdditionalInfo?: string | undefined;
        fss?: string | undefined;
    }, {
        gui: string;
        url: string;
        merchantAdditionalInfo?: string | undefined;
        fss?: string | undefined;
    }>, {
        gui: string;
        url: string;
        merchantAdditionalInfo?: string | undefined;
        fss?: string | undefined;
    }, {
        gui: string;
        url: string;
        merchantAdditionalInfo?: string | undefined;
        fss?: string | undefined;
    }>;
    pointOfInitiationMethod: z.ZodOptional<z.ZodNativeEnum<typeof PointOfInitiationMethod>>;
    value: z.ZodOptional<z.ZodNumber>;
    merchantCategoryCode: z.ZodString;
    transactionCurrency: z.ZodString;
    countryCode: z.ZodString;
    merchantName: z.ZodString;
    merchantCity: z.ZodString;
    additionalData: z.ZodObject<{
        txId: z.ZodString;
    }, "strip", z.ZodTypeAny, {
        txId: string;
    }, {
        txId: string;
    }>;
    postalCode: z.ZodOptional<z.ZodString>;
    unreservedTemplate: z.ZodOptional<z.ZodEffects<z.ZodObject<{
        gui: z.ZodOptional<z.ZodString>;
        url: z.ZodOptional<z.ZodString>;
    }, "strip", z.ZodTypeAny, {
        gui?: string | undefined;
        url?: string | undefined;
    }, {
        gui?: string | undefined;
        url?: string | undefined;
    }>, {
        gui?: string | undefined;
        url?: string | undefined;
    }, {
        gui?: string | undefined;
        url?: string | undefined;
    }>>;
}, "strip", z.ZodTypeAny, {
    merchantAccountInfo: {
        gui: string;
        url: string;
        merchantAdditionalInfo?: string | undefined;
        fss?: string | undefined;
    };
    merchantCategoryCode: string;
    transactionCurrency: string;
    countryCode: string;
    merchantName: string;
    merchantCity: string;
    additionalData: {
        txId: string;
    };
    value?: number | undefined;
    postalCode?: string | undefined;
    unreservedTemplate?: {
        gui?: string | undefined;
        url?: string | undefined;
    } | undefined;
    pointOfInitiationMethod?: PointOfInitiationMethod | undefined;
}, {
    merchantAccountInfo: {
        gui: string;
        url: string;
        merchantAdditionalInfo?: string | undefined;
        fss?: string | undefined;
    };
    merchantCategoryCode: string;
    transactionCurrency: string;
    countryCode: string;
    merchantName: string;
    merchantCity: string;
    additionalData: {
        txId: string;
    };
    value?: number | undefined;
    postalCode?: string | undefined;
    unreservedTemplate?: {
        gui?: string | undefined;
        url?: string | undefined;
    } | undefined;
    pointOfInitiationMethod?: PointOfInitiationMethod | undefined;
}>, {
    merchantAccountInfo: {
        gui: string;
        url: string;
        merchantAdditionalInfo?: string | undefined;
        fss?: string | undefined;
    };
    merchantCategoryCode: string;
    transactionCurrency: string;
    countryCode: string;
    merchantName: string;
    merchantCity: string;
    additionalData: {
        txId: string;
    };
    value?: number | undefined;
    postalCode?: string | undefined;
    unreservedTemplate?: {
        gui?: string | undefined;
        url?: string | undefined;
    } | undefined;
    pointOfInitiationMethod?: PointOfInitiationMethod | undefined;
}, {
    merchantAccountInfo: {
        gui: string;
        url: string;
        merchantAdditionalInfo?: string | undefined;
        fss?: string | undefined;
    };
    merchantCategoryCode: string;
    transactionCurrency: string;
    countryCode: string;
    merchantName: string;
    merchantCity: string;
    additionalData: {
        txId: string;
    };
    value?: number | undefined;
    postalCode?: string | undefined;
    unreservedTemplate?: {
        gui?: string | undefined;
        url?: string | undefined;
    } | undefined;
    pointOfInitiationMethod?: PointOfInitiationMethod | undefined;
}>;
type StaticPixPayload = z.infer<typeof staticPixSchema>;
type DynamicPixPayload = z.infer<typeof dynamicPixSchema>;

declare const toDynamicPix: (payload: DynamicPixPayload) => string;
declare const parseDynamicPix: (payload: string) => DynamicPixPayload;
declare const isDynamicPix: (payload: string) => boolean;

declare const pixKeyRegexes: {
    email: RegExp;
    phone: RegExp;
    random: RegExp;
};
declare function isCPF(cpf: string): boolean;
declare function isCNPJ(cnpj: string): boolean;
declare const keyDetector: {
    isCPF: (key: string) => boolean;
    isCNPJ: (key: string) => boolean;
    isEmail: (key: string) => boolean;
    isPhone: (key: string) => boolean;
    isRandom: (key: string) => boolean;
};
declare const getPixKeyType: (key: string) => PixKeyType;

declare const toStaticPix: (payload: StaticPixPayload) => string;
declare const parseStaticPix: (payload: string) => StaticPixPayload;
declare const isStaticPix: (payload: string) => boolean;

export { type DynamicPixPayload, ParserError, PixKeyType, PixQrCodeType, PointOfInitiationMethod, type StaticPixPayload, dynamicPixSchema, getPixKeyType, isCNPJ, isCPF, isDynamicPix, isStaticPix, keyDetector, parseDynamicPix, parseStaticPix, pixKeyRegexes, staticPixSchema, toDynamicPix, toStaticPix };