@astro-my/idc-code v1.0.24

Identity Status and Error Codes

Constants enumerating the Identity status and error codes.

This package is a simple collection of all the possible error codes, identity as a whole can throw. Refer this for mapping error codes with appropriate description/messages.

All status codes defined in RFC1945 (HTTP/1.0), RFC2616 (HTTP/1.1), RFC2518 (WebDAV), RFC6585 (Additional HTTP Status Codes), and RFC7538 (Permanent Redirect) are supported.

The error codes depends on the services. Preferred naming convention is to start the error code with initial of service name, for eg any error code relating to template service will start from TS

Completely library agnostic. No dependencies.

Installation

npm install @astro-my/idc-code --save

or

yarn add @astro-my/idc-code

Usage

const ICode = require('@astro-my/idc-code');
response
	.status(ICode.HTTP.OK)
	.send('ok');

response
	.status(ICode.HTTP.INTERNAL_SERVER_ERROR)
	.send({
		error: ICode.getStatusText('HTTP.INTERNAL_SERVER_ERROR')
	});

const template = Template.findOne('123');
if(!template) {
    // it will throw 'TS001'
    throw ICode.TEMPLATE_SERVICE.TEMPLATE_NOT_FOUND;
}

For developers, who need to add their own error/status code

You need to create one new file, under codes folder. If you are creating error codes for services then for clarity, its strongly recemonded to put it under codes/services folder.

// store will give you peristent storage on disk, so that the error codes/status you are going to generate will be saved to retrive the description later on
// create is a helper function to register your service
const { store, create } = require('../../store');

const SERVICE = 'TEMPLATE_SERVICE';
// create new service in store
create(SERVICE);

// this is how you define new statuses
store[SERVICE][exports.TEMPLATE_NOT_FOUND = 'TS001'] = 'Template you are looking for doesn\'t exist';

Once done, just import this file in index.js and expose it for outer world :)

Codes

HTTP CODES

Common Error Code

Template Service

OIDC Proxy Service

Identity Middleware Portal

Identity Email Service

Identity Account Service

Identity Token Service