errors.js

// Copyright (c) 2020 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

'use strict';

var TypedError = require('error/typed');

module.exports.TypeIdMismatch = TypedError({
    type: 'thrift-typeid-mismatch',
    message: 'encoded {what} typeid {encoded} doesn\'t match ' +
        'expected type "{expected}" (id: {expectedId})',
    encoded: null,
    expected: null,
    expectedId: null,
    what: null
});

module.exports.MapKeyTypeIdMismatch = TypedError({
    type: 'thrift-map-key-typeid-mismatch',
    message: 'encoded map key typeid {encoded} doesn\'t match ' +
        'expected type "{expected}" (id: {expectedId})',
    encoded: null,
    expected: null,
    expectedId: null
});

module.exports.MapValTypeIdMismatch = TypedError({
    type: 'thrift-map-val-typeid-mismatch',
    message: 'encoded map value typeid {encoded} doesn\'t match ' +
        'expected type "{expected}" (id: {expectedId})',
    encoded: null,
    expected: null,
    expectedId: null
});

module.exports.InvalidSizeError = TypedError({
    type: 'thrift-invalid-size',
    message: 'invalid size {size} of {what}; expects non-negative number',
    size: null,
    what: null
});

module.exports.InvalidTypeidError = TypedError({
    type: 'thrift-invalid-typeid',
    message: 'invalid typeid {typeid} of {what}' +
        '; expects one of the values in TYPE',
    typeid: null,
    what: null
});

module.exports.UnexpectedFieldValueTypeidError = TypedError({
    type: 'thrift-unexpected-field-value-typeid',
    message: 'unexpected typeid {typeid} ({typeName}) for field "{fieldName}"' +
        ' with id {fieldId} on {structName};' +
        ' expected {expectedTypeid} ({expectedTypeName})',
    typeid: null,
    typeName: null,
    expectedTypeid: null,
    expectedTypeName: null,
    fieldName: null,
    fieldId: null,
    structName: null
});

module.exports.FieldRequiredError = TypedError({
    type: 'thrift-required-field',
    message: 'missing required field "{name}" with id {id} on {structName}',
    name: null,
    id: null,
    structName: null
});

module.exports.UnexpectedMapTypeAnnotation = TypedError({
    type: 'thrift-unexpected-map-type-annotation',
    message: 'unexpected map js.type annotation "{mapType}"',
    mapType: null
});

module.exports.InvalidEnumerationTypeError = TypedError({
    type: 'thrift-invalid-enumeration-type',
    message: 'name must be a string for enumeration {enumName}, got: {name} ({nameType})',
    enumName: null,
    name: null,
    nameType: null
});

module.exports.InvalidEnumerationNameError = TypedError({
    type: 'thrift-invalid-enumeration-name',
    message: 'name must be a valid member of enumeration {enumName}, got: {name}',
    enumName: null,
    name: null
});

module.exports.InvalidEnumerationValueError = TypedError({
    type: 'thrift-invalid-enumeration-value',
    message: 'value must be a valid member of enumeration {enumName}, got: {value}',
    enumName: null,
    value: null
});

// Thrift Message Envelope

module.exports.UnrecognizedMessageEnvelopeVersion = TypedError({
    type: 'thrift-unrecognized-message-envelope-version',
    message: 'unrecognized Thrift message envelope version: {version}',
    version: null
});

module.exports.UnrecognizedMessageEnvelopeType = TypedError({
    type: 'thrift-unrecognized-message-envelope-type',
    message: 'unrecognized Thrift message envelope type: {value}',
    value: null
});

module.exports.InvalidMessageEnvelopeTypeName = TypedError({
    type: 'thrift-invalid-message-envelope-type-name',
    message: 'invalid Thrift message envelope type name: {name}',
    name: null
});