@chubbyts/chubbyts-decode-encode 2.4.1 → 2.5.1

package/README.md

@@ -24,6 +24,8 @@ A simple decode/encode solution for json / jsonx / url-encoded / xml / yaml.
 ## Requirements
 
  * node: 22
+ * [@chubbyts/chubbyts-dic-config-factory][9]: ^1.0.0
+ * [@chubbyts/chubbyts-dic-types][7]: ^2.3.0
  * [@chubbyts/chubbyts-throwable-to-error][2]: ^2.3.0
  * [fast-xml-builder][3]: ^1.3.0
  * [fast-xml-parser][4]: ^5.10.1
@@ -35,7 +37,7 @@ A simple decode/encode solution for json / jsonx / url-encoded / xml / yaml.
 Through [NPM](https://www.npmjs.com) as [@chubbyts/chubbyts-decode-encode][1].
 
 ```ts
-npm i @chubbyts/chubbyts-decode-encode@^2.4.1
+npm i @chubbyts/chubbyts-decode-encode@^2.5.1
 ```
 
 ## Usage
@@ -174,6 +176,71 @@ const contentType = yamlTypeEncoder.contentType;
 // contentTypes: 'application/x-yaml'
 ```
 
+### Service factories (chubbyts-dic-config)
+
+The package ships service factories (abstract factories built on [chubbyts-dic-config-factory][9]) for a [chubbyts-dic-config][8] (or any [chubbyts-dic-types][7] compatible) container within `@chubbyts/chubbyts-decode-encode/dist/service-factory`:
+
+ * `typeDecodersServiceFactory`: all shipped type decoders (json, jsonx, urlencoded, yaml)
+ * `typeEncodersServiceFactory`: all shipped type encoders (json, jsonx, urlencoded, yaml), `config.debug` enables pretty printing for json / jsonx
+ * `decoderServiceFactory`: the decoder, built from the `typeDecoders` service if registered, the shipped type decoders otherwise
+ * `encoderServiceFactory`: the encoder, built from the `typeEncoders` service if registered, the shipped type encoders otherwise
+
+```ts
+import type { ConfigFactory } from '@chubbyts/chubbyts-dic-config/dist/dic-config';
+import { createContainerByConfigFactory } from '@chubbyts/chubbyts-dic-config/dist/dic-config';
+import type { Decoder } from '@chubbyts/chubbyts-decode-encode/dist/decoder/decoder';
+import type { Encoder } from '@chubbyts/chubbyts-decode-encode/dist/encoder/encoder';
+import { decoderServiceFactory, encoderServiceFactory } from '@chubbyts/chubbyts-decode-encode/dist/service-factory';
+
+const container = createContainerByConfigFactory({
+  debug: false,
+  dependencies: {
+    factories: new Map<string, ConfigFactory>([
+      ['decoder', decoderServiceFactory()],
+      ['encoder', encoderServiceFactory()],
+    ]),
+  },
+})();
+
+const decoder = container.get<Decoder>('decoder');
+const encoder = container.get<Encoder>('encoder');
+```
+
+To replace the type decoders / encoders, register a `typeDecoders` / `typeEncoders` service:
+
+```ts
+import type { TypeDecoder } from '@chubbyts/chubbyts-decode-encode/dist/decoder/decoder';
+import { createJsonTypeDecoder } from '@chubbyts/chubbyts-decode-encode/dist/decoder/json-type-decoder';
+
+const container = createContainerByConfigFactory({
+  dependencies: {
+    factories: new Map<string, ConfigFactory>([
+      ['decoder', decoderServiceFactory()],
+      ['typeDecoders', (): Array<TypeDecoder> => [createJsonTypeDecoder(), createCustomTypeDecoder()]],
+    ]),
+  },
+})();
+```
+
+#### With names
+
+To use different decoders / encoders in different parts of an application, the same factories can be registered multiple times with a name, which gets appended to each service id (`decoderapi`, `typeDecodersapi`, ...).
+
+```ts
+const container = createContainerByConfigFactory({
+  dependencies: {
+    factories: new Map<string, ConfigFactory>([
+      ['decoder', decoderServiceFactory()],
+      ['decoderapi', decoderServiceFactory('api')],
+      ['typeDecodersapi', (): Array<TypeDecoder> => [createJsonTypeDecoder()]],
+    ]),
+  },
+})();
+
+const decoder = container.get<Decoder>('decoder'); // all shipped type decoders
+const apiDecoder = container.get<Decoder>('decoderapi'); // json only
+```
+
 ## Copyright
 
 2026 Dominik Zogg
@@ -184,3 +251,6 @@ const contentType = yamlTypeEncoder.contentType;
 [4]: https://www.npmjs.com/package/fast-xml-parser
 [5]: https://www.npmjs.com/package/qs
 [6]: https://www.npmjs.com/package/yaml
+[7]: https://www.npmjs.com/package/@chubbyts/chubbyts-dic-types
+[8]: https://www.npmjs.com/package/@chubbyts/chubbyts-dic-config
+[9]: https://www.npmjs.com/package/@chubbyts/chubbyts-dic-config-factory

package/dist/service-factory.d.ts

@@ -0,0 +1,6 @@
+import type { Decoder, TypeDecoder } from './decoder/decoder.js';
+import type { Encoder, TypeEncoder } from './encoder/encoder.js';
+export declare const typeDecodersServiceFactory: import("@chubbyts/chubbyts-dic-config-factory/dist/dic-config-factory").AbstractFactory<TypeDecoder[]>;
+export declare const decoderServiceFactory: import("@chubbyts/chubbyts-dic-config-factory/dist/dic-config-factory").AbstractFactory<Decoder>;
+export declare const typeEncodersServiceFactory: import("@chubbyts/chubbyts-dic-config-factory/dist/dic-config-factory").AbstractFactory<TypeEncoder[]>;
+export declare const encoderServiceFactory: import("@chubbyts/chubbyts-dic-config-factory/dist/dic-config-factory").AbstractFactory<Encoder>;

package/dist/service-factory.js

@@ -0,0 +1,29 @@
+import { createAbstractFactory } from '@chubbyts/chubbyts-dic-config-factory/dist/dic-config-factory';
+import { createDecoder } from './decoder/decoder.js';
+import { createJsonTypeDecoder } from './decoder/json-type-decoder.js';
+import { createJsonxTypeDecoder } from './decoder/jsonx-type-decoder.js';
+import { createUrlEncodedTypeDecoder } from './decoder/url-encoded-type-decoder.js';
+import { createYamlTypeDecoder } from './decoder/yaml-type-decoder.js';
+import { createEncoder } from './encoder/encoder.js';
+import { createJsonTypeEncoder } from './encoder/json-type-encoder.js';
+import { createJsonxTypeEncoder } from './encoder/jsonx-type-encoder.js';
+import { createUrlEncodedTypeEncoder } from './encoder/url-encoded-type-encoder.js';
+import { createYamlTypeEncoder } from './encoder/yaml-type-encoder.js';
+export const typeDecodersServiceFactory = createAbstractFactory(() => {
+    return [createJsonTypeDecoder(), createJsonxTypeDecoder(), createUrlEncodedTypeDecoder(), createYamlTypeDecoder()];
+});
+export const decoderServiceFactory = createAbstractFactory((container, { resolveDependency }) => {
+    return createDecoder(resolveDependency(container, 'typeDecoders', typeDecodersServiceFactory));
+});
+export const typeEncodersServiceFactory = createAbstractFactory((container) => {
+    const { debug = false } = container.get('config');
+    return [
+        createJsonTypeEncoder(debug),
+        createJsonxTypeEncoder(debug),
+        createUrlEncodedTypeEncoder(),
+        createYamlTypeEncoder(),
+    ];
+});
+export const encoderServiceFactory = createAbstractFactory((container, { resolveDependency }) => {
+    return createEncoder(resolveDependency(container, 'typeEncoders', typeEncodersServiceFactory));
+});

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@chubbyts/chubbyts-decode-encode",
   "type": "module",
-  "version": "2.4.1",
+  "version": "2.5.1",
   "description": "A simple decode/encode solution for json / jsonx / url-encoded / xml / yaml.",
   "keywords": [
     "chubbyts",
@@ -54,6 +54,8 @@
     "node": ">=22"
   },
   "dependencies": {
+    "@chubbyts/chubbyts-dic-config-factory": "^1.0.0",
+    "@chubbyts/chubbyts-dic-types": "^2.3.0",
     "@chubbyts/chubbyts-throwable-to-error": "^2.3.0",
     "fast-xml-builder": "^1.3.0",
     "fast-xml-parser": "^5.10.1",
@@ -61,6 +63,7 @@
     "yaml": "^2.9.0"
   },
   "devDependencies": {
+    "@chubbyts/chubbyts-dic-config": "^2.3.0",
     "@chubbyts/chubbyts-function-mock": "^2.3.0",
     "@chubbyts/chubbyts-oxlint": "^1.0.0",
     "@stryker-mutator/core": "^9.6.1",