@chubbyts/chubbyts-decode-encode 1.0.2 → 1.1.0

package/README.md

@@ -24,16 +24,17 @@ A simple decode/encode solution for json / jsonx / url-encoded / xml / yaml.
 ## Requirements
 
  * node: 14
- * [fast-xml-parser][2]: ^4.0.8
- * [qs][3]: ^6.10.5
- * [yaml][4]: ^2.1.1
+ * [@chubbyts/chubbyts-throwable-to-error][2]: ^1.0.0
+ * [fast-xml-parser][3]: ^4.0.8
+ * [qs][4]: ^6.10.5
+ * [yaml][5]: ^2.1.1
 
 ## Installation
 
 Through [NPM](https://www.npmjs.com) as [@chubbyts/chubbyts-decode-encode][1].
 
 ```ts
-npm i @chubbyts/chubbyts-decode-encode@^1.0.2
+npm i @chubbyts/chubbyts-decode-encode@^1.1.0
 ```
 
 ## Usage
@@ -47,7 +48,7 @@ import { createDecoder } from '@chubbyts/chubbyts-decode-encode/dist/decoder';
 import { createJsonTypeDecoder } from '@chubbyts/chubbyts-decode-encode/dist/decoder/json-type-decoder';
 
 const decoder = createDecoder([createJsonTypeDecoder()]);
-const data = decoder.decode('{"key":"value"}', 'application/json');
+const data = decoder.decode('{"key":"value"}', 'application/json'); // or with 3th argument, for example { user: 'username1' }
 // data: {key: "value"}
 const contentTypes = decoder.contentTypes;
 // contentTypes: ['application/json']
@@ -87,7 +88,7 @@ const contentType = jsonxTypeDecoder.contentType;
 ```ts
 import { createUrlEncodedTypeDecoder } from '@chubbyts/chubbyts-decode-encode/dist/decoder/url-encoded-type-decoder';
 
-const urlEncodedTypeDecoder = createUrlEncodedTypeDecoder();\"
+const urlEncodedTypeDecoder = createUrlEncodedTypeDecoder();
 const data = urlEncodedTypeDecoder.decode('key=value');
 // data: {key: "value"}
 const contentType = urlEncodedTypeDecoder.contentType;
@@ -115,7 +116,7 @@ import { createEncoder } from '@chubbyts/chubbyts-encode-encode/dist/encoder';
 import { createJsonTypeEncoder } from '@chubbyts/chubbyts-encode-encode/dist/encoder/json-type-encoder';
 
 const encoder = createEncoder([createJsonTypeEncoder()]);
-const encodedData = encoder.encode({key: "value"}, 'application/json');dec
+const encodedData = encoder.encode({key: "value"}, 'application/json'); // or with 3th argument, for example { user: 'username1' }
 // encodedData: {"key":"value"}
 const contentTypes = encoder.contentTypes;
 // contentTypes: ['application/json']
@@ -177,6 +178,7 @@ const contentType = yamlTypeEncoder.contentType;
 Dominik Zogg 2022
 
 [1]: https://www.npmjs.com/package/@chubbyts/chubbyts-decode-encode
-[2]: https://www.npmjs.com/package/fast-xml-parser
-[3]: https://www.npmjs.com/package/qs
-[4]: https://www.npmjs.com/package/yaml
+[2]: https://www.npmjs.com/package/@chubbyts/chubbyts-throwable-to-error
+[3]: https://www.npmjs.com/package/fast-xml-parser
+[4]: https://www.npmjs.com/package/qs
+[5]: https://www.npmjs.com/package/yaml

package/dist/decoder/index.d.ts

@@ -1,10 +1,12 @@
 import { Data } from '..';
+export declare class DecodeError extends Error {
+}
 export declare type TypeDecoder = {
     decode: (encodedData: string) => Data;
     contentType: string;
 };
 export declare type Decoder = {
-    decode: (encodedData: string, contentType: string) => Data;
+    decode: (encodedData: string, contentType: string, context?: Record<string, unknown>) => Data;
     contentTypes: Array<string>;
 };
 export declare const createDecoder: (decoderTypes: Array<TypeDecoder>) => Decoder;

package/dist/decoder/index.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createDecoder = void 0;
+exports.createDecoder = exports.DecodeError = void 0;
+class DecodeError extends Error {
+}
+exports.DecodeError = DecodeError;
 const createDecoder = (decoderTypes) => {
     const decoderTypeMap = new Map(decoderTypes.map((DecoderType) => [DecoderType.contentType, DecoderType]));
     const contentTypes = Array.from(decoderTypeMap.keys());

package/dist/decoder/json-type-decoder.js

@@ -1,9 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createJsonTypeDecoder = void 0;
+const throwable_to_error_1 = require("@chubbyts/chubbyts-throwable-to-error/dist/throwable-to-error");
+const _1 = require(".");
 const createJsonTypeDecoder = () => {
     const decode = (encodedData) => {
-        return JSON.parse(encodedData);
+        try {
+            return JSON.parse(encodedData);
+        }
+        catch (e) {
+            const error = (0, throwable_to_error_1.throwableToError)(e);
+            const decodeError = new _1.DecodeError(error.message);
+            decodeError.stack = error.stack;
+            throw decodeError;
+        }
     };
     const contentType = 'application/json';
     return {

package/dist/decoder/jsonx-type-decoder.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createJsonxTypeDecoder = void 0;
+const _1 = require(".");
 const fast_xml_parser_1 = require("fast-xml-parser");
 const jsonx_datatypes_1 = require("../jsonx-datatypes");
+const throwable_to_error_1 = require("@chubbyts/chubbyts-throwable-to-error/dist/throwable-to-error");
 const decodeHtmlEntities = (string) => string.replace(/&#\d+;/gm, (code) => String.fromCharCode(code.match(/\d+/)[0]));
 const isWithName = (node) => typeof node === 'object' &&
     null !== node &&
@@ -77,9 +79,16 @@ const convertObjectNode = (node) => {
 };
 const createJsonxTypeDecoder = () => {
     const decode = (encodedData) => {
-        const parser = new fast_xml_parser_1.XMLParser({ preserveOrder: true, ignoreAttributes: false, htmlEntities: false });
-        const parsedData = parser.parse(encodedData);
-        return convertNode(parsedData[1]);
+        try {
+            const parser = new fast_xml_parser_1.XMLParser({ preserveOrder: true, ignoreAttributes: false, htmlEntities: false });
+            return convertNode(parser.parse(encodedData)[1]);
+        }
+        catch (e) {
+            const error = (0, throwable_to_error_1.throwableToError)(e);
+            const decodeError = new _1.DecodeError(error.message);
+            decodeError.stack = error.stack;
+            throw decodeError;
+        }
     };
     const contentType = 'application/jsonx+xml';
     return {

package/dist/decoder/yaml-type-decoder.js

@@ -1,10 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createYamlTypeDecoder = void 0;
+const _1 = require(".");
 const yaml_1 = require("yaml");
+const throwable_to_error_1 = require("@chubbyts/chubbyts-throwable-to-error/dist/throwable-to-error");
 const createYamlTypeDecoder = () => {
     const decode = (encodedData) => {
-        return (0, yaml_1.parse)(encodedData);
+        try {
+            return (0, yaml_1.parse)(encodedData);
+        }
+        catch (e) {
+            const error = (0, throwable_to_error_1.throwableToError)(e);
+            const decodeError = new _1.DecodeError(error.message);
+            decodeError.stack = error.stack;
+            throw decodeError;
+        }
     };
     const contentType = 'application/x-yaml';
     return {

package/dist/encoder/index.d.ts

@@ -1,10 +1,12 @@
 import { Data } from '..';
+export declare class EncodeError extends Error {
+}
 export declare type TypeEncoder = {
     encode: (data: Data) => string;
     contentType: string;
 };
 export declare type Encoder = {
-    encode: (data: Data, contentType: string) => string;
+    encode: (data: Data, contentType: string, context?: Record<string, unknown>) => string;
     contentTypes: Array<string>;
 };
 export declare const createEncoder: (encoderTypes: Array<TypeEncoder>) => Encoder;

package/dist/encoder/index.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createEncoder = void 0;
+exports.createEncoder = exports.EncodeError = void 0;
+class EncodeError extends Error {
+}
+exports.EncodeError = EncodeError;
 const createEncoder = (encoderTypes) => {
     const encoderTypeMap = new Map(encoderTypes.map((encoderType) => [encoderType.contentType, encoderType]));
     const contentTypes = Array.from(encoderTypeMap.keys());

package/dist/encoder/jsonx-type-encoder.js

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createJsonxTypeEncoder = void 0;
+const _1 = require(".");
 const __1 = require("..");
 const jsonx_datatypes_1 = require("../jsonx-datatypes");
 const fast_xml_parser_1 = require("fast-xml-parser");
+const throwable_to_error_1 = require("@chubbyts/chubbyts-throwable-to-error/dist/throwable-to-error");
 const encodeHtmlEntities = (string) => string.replace(/[\u00A0-\u9999<>\&]/g, (i) => '&#' + i.charCodeAt(0) + ';');
 const createXmlNode = () => {
     return {
@@ -147,20 +149,28 @@ const createObjectNode = (value, key = undefined) => {
     };
 };
 const createJsonxTypeEncoder = (prettyPrint = false) => {
+    const builder = new fast_xml_parser_1.XMLBuilder({
+        preserveOrder: true,
+        ignoreAttributes: false,
+        processEntities: false,
+        format: prettyPrint,
+    });
     const encode = (data) => {
-        const builder = new fast_xml_parser_1.XMLBuilder({
-            preserveOrder: true,
-            ignoreAttributes: false,
-            processEntities: false,
-            format: prettyPrint,
-        });
-        return builder.build([
-            createXmlNode(),
-            {
-                ...createNode(data),
-                ...createJsonxAttributes(),
-            },
-        ]);
+        try {
+            return builder.build([
+                createXmlNode(),
+                {
+                    ...createNode(data),
+                    ...createJsonxAttributes(),
+                },
+            ]);
+        }
+        catch (e) {
+            const error = (0, throwable_to_error_1.throwableToError)(e);
+            const decodeError = new _1.EncodeError(error.message);
+            decodeError.stack = error.stack;
+            throw decodeError;
+        }
     };
     const contentType = 'application/jsonx+xml';
     return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chubbyts/chubbyts-decode-encode",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "A simple decode/encode solution for json / jsonx / url-encoded / xml / yaml.",
   "keywords": [
     "chubbyts",
@@ -48,6 +48,7 @@
     "node": ">=14"
   },
   "dependencies": {
+    "@chubbyts/chubbyts-throwable-to-error": "^1.0.0",
     "fast-xml-parser": "^4.0.8",
     "qs": "^6.10.5",
     "yaml": "^2.1.1"