@ctx-core/error - npm Package Compare versions

Comparing version 3.0.10 to 4.0.0

lib.js

@@ -1,2 +0,308 @@
-require = require('esm')(module)
-module.exports = require('./lib.mjs')
+/**
+ * Error functions
+ * @module @ctx-core/error/lib
+ */
+import { assign, clone, defaults } from '@ctx-core/object/lib.js'
+import { log, error, debug } from '@ctx-core/logger/lib.js'
+const logPrefix = '@ctx-core/error/lib.js'
+/**
+ * ctx used to throw & catch errors
+ * @typedef {module:ctx-core/object/lib~ctx} ctx__error
+ * @property {string} error_message - Message to print to the console.error
+ * @property {string} type='@ctx-core/error/lib~ctx__error'
+ */
+/**
+ * Throws an error
+ * @param {module:ctx-core/object/lib~ctx} ctx - The ctx
+ * @param {Object} ctx.ctx__error - The ctx__error to be assigned to & thrown
+ * @param {Object|string} ctx__error - Assigned or coerced into ctx.ctx__error
+ * @param {string} ctx__error.error_message - The error message
+ * @param {...module:ctx-core/error/lib~ctx__error} ctx__error - Assigned into ctx.ctx__error
+ * @throws Decorate & throw error given by the arguments.
+ */
+export function throw__error(ctx, ctx__error__param, ...ARR__ctx__error) {
+	log(`${logPrefix}|throw__error`)
+	const ctx__error =
+		_ctx__error__log(
+			ctx,
+			ctx__error__param,
+			...ARR__ctx__error)
+	throw ctx__error
+}
+export function print__error(ctx__error) {
+	log(`${logPrefix}|http__error`)
+	const { error_message__http = 'Error' } = ctx__error
+	const body = JSON.stringify({ error_message: error_message__http })
+	error(
+		`${logPrefix}|use__error|catch
+			 ${ctx__error}
+			 ${body}
+			 ${ctx__error.error_message}
+			 ${ctx__error.stack}`)
+}
+export function _ctx__error__log(
+	ctx,
+	ctx__error__param,
+	...ARR__ctx__error
+) {
+	log(`${logPrefix}|_ctx__error__log`)
+	const ctx__error =
+		_ctx__error(
+			ctx__error__param,
+			...ARR__ctx__error)
+	console__error(ctx__error)
+	return ctx__error
+}
+export function console__error(ctx__error) {
+	log(`${logPrefix}|console__error`)
+	const error_message__ =
+		ctx__error.error_message
+		|| ctx__error && ctx__error.toString()
+		|| 'throw__error: Unknown Error'
+	const stack =
+		ctx__error
+		&& ctx__error.stack
+	const error_message =
+		`\n${stack}\n${error_message__}`
+	error(`${logPrefix}|throw__error\n${error_message}\n${JSON.stringify(ctx__error)}`)
+}
+/**
+ * Assigns & coerces to ctx.ctx__error
+ * @return {module:ctx-core/object/lib~ctx} The ctx with ctx.ctx__error
+ * @param {module:ctx-core/object/lib~ctx} ctx - The ctx to be assigned to
+ * @param {ctx__error|string} ctx__error__or__error_message - Assigned or coerced into ctx.ctx__error
+ * @param {...module:ctx-core/error/lib~ctx__error} ctx__error - Assigned or coerced into ctx.ctx__error
+ */
+export function _ctx__error(
+	ctx__error__or__error_message,
+	...ARR__ctx__error
+) {
+	log(`${logPrefix}|_ctx__error`)
+	const ctx__error =
+		_ctx__error__defaults(
+			(ctx__error__or__error_message
+				&& ctx__error__or__error_message.ctx__error)
+			|| ((typeof ctx__error__or__error_message === 'object')
+			&& ctx__error__or__error_message)
+			|| {})
+	assign(
+		ctx__error,
+		ctx__error__or__error_message,
+		...ARR__ctx__error)
+	const error_message__ =
+		ctx__error__or__error_message
+		&& ctx__error__or__error_message.toString()
+	const error_message =
+		((error_message__ !== '[object Object]')
+			&& error_message__)
+		|| (ctx__error__or__error_message
+		&& ctx__error__or__error_message.error_message)
+		|| (ctx__error && ctx__error.error_message)
+	ctx__error.error_message = error_message
+	return ctx__error
+}
+function _ctx__error__defaults(ctx__error) {
+	defaults(
+		ctx__error,
+		{
+			type: '@ctx-core/error/lib~ctx__error',
+			error_message: ''
+		})
+	return ctx__error
+}
+/**
+ * Bad Request error with ctx.status__http 400.
+ * @typedef bad_request
+ * @see {@link throw__error}
+ * @example
+ * throw__bad_request(ctx) // Bad Request
+ */
+/**
+ * Throws an bad_request error (HTTP 400)
+ * @param {...module:ctx-core/error/lib~ctx__error} ctx__error
+ * @throws {bad_request}
+ */
+export function throw__bad_request(ctx, ...ARR__ctx__error) {
+	log(`${logPrefix}|throw__bad_request`)
+	throw__error(
+		ctx,
+		{
+			type: 'bad_request',
+			error_message: 'Bad Request',
+			status__http: 400,
+			error_message__http: 'Bad Request'
+		},
+		...ARR__ctx__error)
+}
+/**
+ * Unauthorized error with ctx.status__http 401.
+ * @typedef unauthorized
+ * @see {@link throw__error}
+ * @example
+ * throw__unauthorized(ctx) // Unauthorized
+ */
+/**
+ * Throws an unauthorized error (HTTP 401)
+ * @param {...module:ctx-core/error/lib~ctx__error} ctx__error
+ * @throws {unauthorized}
+ */
+export function throw__unauthorized(ctx, ...ARR__ctx__error) {
+	log(`${logPrefix}|throw__unauthorized`)
+	throw__error(
+		ctx,
+		{
+			type: 'unauthorized',
+			error_message: 'Unauthorized',
+			status__http: 401,
+			error_message__http: 'Unauthorized'
+		},
+		...ARR__ctx__error)
+}
+/**
+ * Bad Credentials Auth Error
+ * @typedef bad_credentials
+ * @see {@link throw__error}
+ * @example
+ * throw__bad_credentials(ctx) // Unauthorized
+ */
+/**
+ * Throws a Bad Credentials error (HTTP 401)
+ * @param {...module:ctx-core/error/lib~ctx__error} ctx__error
+ * @throws {bad_credentials}
+ */
+export function throw__bad_credentials(ctx, ...ARR__ctx__error) {
+	log(`${logPrefix}|throw__bad_credentials`)
+	throw__error(
+		ctx,
+		{
+			type: 'bad_credentials',
+			status__http: 401,
+			error_message__http: 'Unauthorized'
+		},
+		...ARR__ctx__error)
+}
+/**
+ * Not Found Error
+ * @typedef not_found
+ * @see {@link throw__error}
+ * @example
+ * throw__not_found(ctx) // Unauthorized
+ */
+/**
+ * Throws a Not Found error (HTTP 401)
+ * @param {...module:ctx-core/error/lib~ctx__error} ctx__error
+ * @throws {not_found}
+ */
+export function throw__not_found(ctx, ...ARR__ctx__error) {
+	log(`${logPrefix}|not_found`)
+	throw__error(
+		ctx,
+		{
+			type: 'not_found',
+			status__http: 404,
+			error_message__http: 'Not Found'
+		},
+		...ARR__ctx__error)
+}
+/**
+ * Missing Argument error.
+ * @typedef missing_argument
+ * @see {@link throw__error}
+ * @example
+ * throw__missing_argument(ctx, {key: 'ctx.foobar', type: 'baz__agent'}) // ctx.foobar is not defined - baz__agent
+ */
+/**
+ * Throws a missing_argument error (HTTP 500)
+ * @param {...module:ctx-core/error/lib~ctx__error} ctx__error
+ * @throws {missing_argument} throw missing_argument error
+ */
+export function throw__missing_argument(ctx, ...ARR__ctx__error) {
+	log(`${logPrefix}|throw__missing_argument`)
+	const ctx__error = clone(...ARR__ctx__error)
+	throw__error(
+		ctx,
+		{
+			type: 'missing_argument',
+			error_message: `${ctx__error.key} is not defined - ${ctx__error.type || 'Unknown Type'}`,
+			status__http: 500,
+			error_message__http: 'Error'
+		},
+		ctx__error)
+}
+/**
+ * Invalid Argument error.
+ * @typedef invalid_argument
+ * @see {@link throw__error}
+ * @example
+ * throw__invalid_argument(ctx, {key: 'ctx.foobar'}) // ctx.foobar is invalid
+ */
+/**
+ * Throws a invalid_argument error (HTTP 500)
+ * @param {...module:ctx-core/error/lib~ctx__error} ctx__error
+ * @throws {invalid_argument}
+ */
+export function throw__invalid_argument(ctx, ...ARR__ctx__error) {
+	log(`${logPrefix}|throw__invalid_argument`)
+	const ctx__error = clone(...ARR__ctx__error)
+	throw__error(
+		ctx,
+		{
+			type: 'invalid_argument',
+			error_message: `${ctx__error.key} is invalid`,
+			status__http: 500,
+			error_message__http: 'Error'
+		},
+		ctx__error)
+}
+/**
+ * Invalid State error.
+ * @typedef invalid_state
+ * @see {@link throw__error}
+ * @example
+ * throw__invalid_state(ctx, {key: 'ctx.foobar'}) // ctx.foobar is in an invalid state
+ */
+/**
+ * Throws a invalid_state error (HTTP 500)
+ * @param {...module:ctx-core/error/lib~ctx__error} ctx__error
+ * @param {...module:ctx-core/error/lib~ctx__error.reason} ctx__error.reason - The reason for the invalid state.
+ * @throws {invalid_state}
+ */
+export function throw__invalid_state(ctx, ...ARR__ctx__error) {
+	log(`${logPrefix}|throw__invalid_state`)
+	const ctx__error = clone(...ARR__ctx__error)
+	const reason =
+		ctx__error.reason
+		|| 'No reason given.'
+	throw__error(
+		ctx,
+		{
+			type: 'invalid_state',
+			error_message: `${ctx__error.key} is in an invalid state. ${reason}`,
+			status__http: 500,
+			error_message__http: 'Error'
+		},
+		ctx__error)
+}
+/**
+ * Bad Gateway http error with ctx.status__http 502.
+ * @typedef bad_gateway
+ * @see {@link throw__error}
+ * @example
+ * throw__bad_gateway(ctx) // Bad Gateway
+ */
+/**
+ * Throws a bad_gateway error (HTTP 502)
+ * @param {...module:ctx-core/error/lib~ctx__error} ctx__error
+ * @throws {bad_gateway}
+ */
+export function throw__bad_gateway(ctx, ...ARR__ctx__error) {
+	log(`${logPrefix}|throw__bad_gateway`)
+	throw__error(
+		ctx,
+		{
+			type: 'bad_gateway',
+			status__http: 502,
+			error_message__http: 'Bad Gateway'
+		},
+		...ARR__ctx__error)
+}

package.json

 {
 	"name": "@ctx-core/error",
-	"version": "3.0.10",
+	"version": "4.0.0",
 	"description": "ctx-core error",
@@ -24,7 +24,6 @@ "main": "lib.js",
 	"dependencies": {
-		"@ctx-core/logger": "^2.2.12",
-		"@ctx-core/object": "^2.6.0",
-		"esm": "^3.0.84"
+		"@ctx-core/logger": "^3.0.0",
+		"@ctx-core/object": "^3.0.0"
 	},
-	"gitHead": "ef8c06c1b6e6183cce5b0836c59761cce170a6e9"
+	"gitHead": "7d0d73495e67101da1ad8aeb87a7b9918b4689c1"
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Dependency count

2

decreased by-33.33%

Worsened metrics

Total package byte prevSize

9193

decreased by-1.02%

Number of package files

2

decreased by-33.33%

Lines of code

308

decreased by-0.32%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Added@ctx-core/function@6.0.0(transitive)

• + Added@ctx-core/logger@3.1.28(transitive)

• + Added@ctx-core/object@3.3.0(transitive)

• + Addedansi-styles@4.3.0(transitive)

• + Addedchalk@4.1.2(transitive)

• + Addedcolor-convert@2.0.1(transitive)

• + Addedcolor-name@1.1.4(transitive)

• + Addedhas-flag@4.0.0(transitive)

• + Addedsupports-color@7.2.0(transitive)

• - Removedesm@^3.0.84

• - Removed@ctx-core/function@4.2.0(transitive)

• - Removed@ctx-core/logger@2.2.12(transitive)

• - Removed@ctx-core/object@2.6.0(transitive)

• - Removedansi-styles@3.2.1(transitive)

• - Removedchalk@2.4.2(transitive)

• - Removedcolor-convert@1.9.3(transitive)

• - Removedcolor-name@1.1.3(transitive)

• - Removedescape-string-regexp@1.0.5(transitive)

• - Removedesm@3.2.25(transitive)

• - Removedhas-flag@3.0.0(transitive)

• - Removedsupports-color@5.5.0(transitive)

• Updated@ctx-core/logger@^3.0.0

• Updated@ctx-core/object@^3.0.0