@appsemble/node-utils 0.28.12 → 0.29.1

package/README.md

@@ -1,9 +1,9 @@
-# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.28.12/config/assets/logo.svg) Appsemble Node Utilities
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.29.1/config/assets/logo.svg) Appsemble Node Utilities
 
 > NodeJS utilities used by Appsemble internally.
 
 [![npm](https://img.shields.io/npm/v/@appsemble/node-utils)](https://www.npmjs.com/package/@appsemble/node-utils)
-[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.28.12/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.28.12)
+[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.29.1/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.29.1)
 [![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io)
 
 ## Table of Contents
@@ -26,5 +26,5 @@ compatibility is not guaranteed.
 
 ## License
 
-[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.28.12/LICENSE.md) ©
+[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.29.1/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/node-utils",
-  "version": "0.28.12",
+  "version": "0.29.1",
   "description": "NodeJS utilities used by Appsemble internally.",
   "keywords": [
     "app",
@@ -38,8 +38,8 @@
     "test": "vitest"
   },
   "dependencies": {
-    "@appsemble/types": "0.28.12",
-    "@appsemble/utils": "0.28.12",
+    "@appsemble/types": "0.29.1",
+    "@appsemble/utils": "0.29.1",
     "@formatjs/fast-memoize": "^2.0.0",
     "@fortawesome/fontawesome-free": "^6.0.0",
     "@koa/cors": "^4.0.0",

package/scim.d.ts

@@ -1,26 +1,20 @@
+import { type Context } from 'koa';
 /**
  * The SCIM protocol uses the HTTP response status codes defined in
  * [Section 6 of [RFC7231]](https://datatracker.ietf.org/doc/html/rfc7231#section-6) to indicate
- * operation success or failure. In addition to returning an HTTP response code, implementers
+ * operation success or failure.
+ *
+ * In addition to returning an HTTP response code, implementers
  * **MUST** return the errors in the body of the response in a JSON format, using the attributes
- * described below. Error responses are identified using the following "schema" URI:
+ * described below.
+ *
+ * Error responses are identified using the following "schema" URI:
  * `"urn:ietf:params:scim:api:messages:2.0:Error"`.
  *
+ * @param condition The condition to check.
+ * @param ctx The Koa context used to throw the error response.
+ * @param status The HTTP status code (see [Section 6 of [RFC7231]](https://datatracker.ietf.org/doc/html/rfc7231#section-6)) expressed as a JSON string.
+ * @param detail A detailed human-readable message.
  * @see https://datatracker.ietf.org/doc/html/rfc7644#section-3.12
  */
-export declare class SCIMError extends Error {
-    schemas: string[];
-    /**
-     * The HTTP status code (see
-     * [Section 6 of [RFC7231]](https://datatracker.ietf.org/doc/html/rfc7231#section-6)) expressed as
-     * a JSON string.
-     */
-    status: string;
-    /**
-     * A detailed human-readable message.
-     */
-    detail: string;
-    constructor(status: number, detail: string);
-    toJSON(): Pick<SCIMError, 'detail' | 'schemas' | 'status'>;
-}
-export declare function scimAssert(condition: unknown, status: number, detail: string): asserts condition;
+export declare function scimAssert(condition: unknown, ctx: Context, status: number, detail: string): asserts condition;

package/scim.js

@@ -1,32 +1,30 @@
 /**
  * The SCIM protocol uses the HTTP response status codes defined in
  * [Section 6 of [RFC7231]](https://datatracker.ietf.org/doc/html/rfc7231#section-6) to indicate
- * operation success or failure. In addition to returning an HTTP response code, implementers
+ * operation success or failure.
+ *
+ * In addition to returning an HTTP response code, implementers
  * **MUST** return the errors in the body of the response in a JSON format, using the attributes
- * described below. Error responses are identified using the following "schema" URI:
+ * described below.
+ *
+ * Error responses are identified using the following "schema" URI:
  * `"urn:ietf:params:scim:api:messages:2.0:Error"`.
  *
+ * @param condition The condition to check.
+ * @param ctx The Koa context used to throw the error response.
+ * @param status The HTTP status code (see [Section 6 of [RFC7231]](https://datatracker.ietf.org/doc/html/rfc7231#section-6)) expressed as a JSON string.
+ * @param detail A detailed human-readable message.
  * @see https://datatracker.ietf.org/doc/html/rfc7644#section-3.12
  */
-export class SCIMError extends Error {
-    constructor(status, detail) {
-        super(detail);
-        this.schemas = ['urn:ietf:params:scim:api:messages:2.0:Error'];
-        this.detail = detail;
-        this.name = 'SCIMError';
-        this.status = String(status);
-    }
-    toJSON() {
-        return {
-            detail: this.detail,
-            schemas: this.schemas,
-            status: this.status,
-        };
-    }
-}
-export function scimAssert(condition, status, detail) {
+export function scimAssert(condition, ctx, status, detail) {
     if (!condition) {
-        throw new SCIMError(status, detail);
+        ctx.status = status;
+        ctx.body = {
+            detail,
+            schemas: ['urn:ietf:params:scim:api:messages:2.0:Error'],
+            status,
+        };
+        ctx.throw();
     }
 }
 //# sourceMappingURL=scim.js.map