@opra/sqb 1.0.0-alpha.3 → 1.0.0-alpha.4

package/cjs/sqb-entity-service.js

@@ -19,7 +19,8 @@ class SqbEntityService extends core_1.ServiceBase {
      */
     constructor(dataType, options) {
         super();
-        this._encoders = {};
+        this._inputCodecs = {};
+        this._outputCodecs = {};
         this._dataType_ = dataType;
         this.db = options?.db;
         this.$resourceName = options?.resourceName;
@@ -74,34 +75,34 @@ class SqbEntityService extends core_1.ServiceBase {
         throw new Error('resourceName is not defined');
     }
     /**
-     * Retrieves the encoder for the specified operation.
+     * Retrieves the codec for the specified operation.
      *
      * @param operation - The operation to retrieve the encoder for. Valid values are 'create' and 'update'.
      */
-    getEncoder(operation) {
-        let encoder = this._encoders[operation];
-        if (encoder)
-            return encoder;
-        const options = { projection: '*' };
+    getInputCodec(operation) {
+        let validator = this._inputCodecs[operation];
+        if (validator)
+            return validator;
+        const options = { projection: '*', ignoreReadonlyFields: true };
         if (operation === 'update')
             options.partial = 'deep';
         const dataType = this.dataType;
-        encoder = dataType.generateCodec('encode', options);
-        this._encoders[operation] = encoder;
-        return encoder;
+        validator = dataType.generateCodec('decode', options);
+        this._inputCodecs[operation] = validator;
+        return validator;
     }
     /**
-     * Retrieves the decoder.
+     * Retrieves the codec.
      */
-    getDecoder() {
-        let decoder = this._decoder;
-        if (decoder)
-            return decoder;
-        const options = { projection: '*', partial: 'deep' };
+    getOutputCodec(operation) {
+        let validator = this._outputCodecs[operation];
+        if (validator)
+            return validator;
+        const options = { projection: '*', partial: 'deep', ignoreWriteonlyFields: true };
         const dataType = this.dataType;
-        decoder = dataType.generateCodec('decode', options);
-        this._decoder = decoder;
-        return decoder;
+        validator = dataType.generateCodec('decode', options);
+        this._outputCodecs[operation] = validator;
+        return validator;
     }
     /**
      * Insert a new record into database
@@ -113,11 +114,12 @@ class SqbEntityService extends core_1.ServiceBase {
      * @protected
      */
     async _create(input, options) {
-        const encode = this.getEncoder('create');
-        const data = encode(input);
+        const inputCodec = this.getInputCodec('create');
+        const outputCodec = this.getOutputCodec('create');
+        const data = inputCodec(input);
         const out = await this._dbCreate(data, options);
         if (out)
-            return out;
+            return outputCodec(out);
         throw new common_1.InternalServerError(`Unknown error while creating document for "${this.getResourceName()}"`);
     }
     /**
@@ -181,7 +183,7 @@ class SqbEntityService extends core_1.ServiceBase {
      * @protected
      */
     async _findById(id, options) {
-        const decode = this.getDecoder();
+        const decode = this.getOutputCodec('find');
         const out = await this._dbFindById(id, options);
         return out ? decode(out) : undefined;
     }
@@ -193,7 +195,7 @@ class SqbEntityService extends core_1.ServiceBase {
      * @protected
      */
     async _findOne(options) {
-        const decode = this.getDecoder();
+        const decode = this.getOutputCodec('find');
         const out = await this._dbFindOne(options);
         return out ? decode(out) : undefined;
     }
@@ -205,7 +207,7 @@ class SqbEntityService extends core_1.ServiceBase {
      * @protected
      */
     async _findMany(options) {
-        const decode = this.getDecoder();
+        const decode = this.getOutputCodec('find');
         const out = await this._dbFindMany(options);
         if (out?.length) {
             return out.map(x => decode(x));
@@ -223,12 +225,12 @@ class SqbEntityService extends core_1.ServiceBase {
      * @protected
      */
     async _update(id, input, options) {
-        const encode = this.getEncoder('update');
-        const decode = this.getDecoder();
-        const data = encode(input);
+        const inputCodec = this.getInputCodec('update');
+        const data = inputCodec(input);
         const out = await this._dbUpdate(id, data, options);
+        const outputCodec = this.getOutputCodec('update');
         if (out)
-            return decode(out);
+            return outputCodec(out);
     }
     /**
      * Updates a record in the collection with the specified ID and returns updated record count
@@ -240,8 +242,8 @@ class SqbEntityService extends core_1.ServiceBase {
      * @protected
      */
     async _updateOnly(id, input, options) {
-        const encode = this.getEncoder('create');
-        const data = encode(input);
+        const inputCodec = this.getInputCodec('create');
+        const data = inputCodec(input);
         return await this._dbUpdateOnly(id, data, options);
     }
     /**
@@ -253,8 +255,8 @@ class SqbEntityService extends core_1.ServiceBase {
      * @protected
      */
     async _updateMany(input, options) {
-        const encode = this.getEncoder('update');
-        const data = encode(input);
+        const inputCodec = this.getInputCodec('update');
+        const data = inputCodec(input);
         return await this._dbUpdateMany(data, options);
     }
     /**

package/esm/sqb-entity-service.js

@@ -16,7 +16,8 @@ export class SqbEntityService extends ServiceBase {
      */
     constructor(dataType, options) {
         super();
-        this._encoders = {};
+        this._inputCodecs = {};
+        this._outputCodecs = {};
         this._dataType_ = dataType;
         this.db = options?.db;
         this.$resourceName = options?.resourceName;
@@ -71,34 +72,34 @@ export class SqbEntityService extends ServiceBase {
         throw new Error('resourceName is not defined');
     }
     /**
-     * Retrieves the encoder for the specified operation.
+     * Retrieves the codec for the specified operation.
      *
      * @param operation - The operation to retrieve the encoder for. Valid values are 'create' and 'update'.
      */
-    getEncoder(operation) {
-        let encoder = this._encoders[operation];
-        if (encoder)
-            return encoder;
-        const options = { projection: '*' };
+    getInputCodec(operation) {
+        let validator = this._inputCodecs[operation];
+        if (validator)
+            return validator;
+        const options = { projection: '*', ignoreReadonlyFields: true };
         if (operation === 'update')
             options.partial = 'deep';
         const dataType = this.dataType;
-        encoder = dataType.generateCodec('encode', options);
-        this._encoders[operation] = encoder;
-        return encoder;
+        validator = dataType.generateCodec('decode', options);
+        this._inputCodecs[operation] = validator;
+        return validator;
     }
     /**
-     * Retrieves the decoder.
+     * Retrieves the codec.
      */
-    getDecoder() {
-        let decoder = this._decoder;
-        if (decoder)
-            return decoder;
-        const options = { projection: '*', partial: 'deep' };
+    getOutputCodec(operation) {
+        let validator = this._outputCodecs[operation];
+        if (validator)
+            return validator;
+        const options = { projection: '*', partial: 'deep', ignoreWriteonlyFields: true };
         const dataType = this.dataType;
-        decoder = dataType.generateCodec('decode', options);
-        this._decoder = decoder;
-        return decoder;
+        validator = dataType.generateCodec('decode', options);
+        this._outputCodecs[operation] = validator;
+        return validator;
     }
     /**
      * Insert a new record into database
@@ -110,11 +111,12 @@ export class SqbEntityService extends ServiceBase {
      * @protected
      */
     async _create(input, options) {
-        const encode = this.getEncoder('create');
-        const data = encode(input);
+        const inputCodec = this.getInputCodec('create');
+        const outputCodec = this.getOutputCodec('create');
+        const data = inputCodec(input);
         const out = await this._dbCreate(data, options);
         if (out)
-            return out;
+            return outputCodec(out);
         throw new InternalServerError(`Unknown error while creating document for "${this.getResourceName()}"`);
     }
     /**
@@ -178,7 +180,7 @@ export class SqbEntityService extends ServiceBase {
      * @protected
      */
     async _findById(id, options) {
-        const decode = this.getDecoder();
+        const decode = this.getOutputCodec('find');
         const out = await this._dbFindById(id, options);
         return out ? decode(out) : undefined;
     }
@@ -190,7 +192,7 @@ export class SqbEntityService extends ServiceBase {
      * @protected
      */
     async _findOne(options) {
-        const decode = this.getDecoder();
+        const decode = this.getOutputCodec('find');
         const out = await this._dbFindOne(options);
         return out ? decode(out) : undefined;
     }
@@ -202,7 +204,7 @@ export class SqbEntityService extends ServiceBase {
      * @protected
      */
     async _findMany(options) {
-        const decode = this.getDecoder();
+        const decode = this.getOutputCodec('find');
         const out = await this._dbFindMany(options);
         if (out?.length) {
             return out.map(x => decode(x));
@@ -220,12 +222,12 @@ export class SqbEntityService extends ServiceBase {
      * @protected
      */
     async _update(id, input, options) {
-        const encode = this.getEncoder('update');
-        const decode = this.getDecoder();
-        const data = encode(input);
+        const inputCodec = this.getInputCodec('update');
+        const data = inputCodec(input);
         const out = await this._dbUpdate(id, data, options);
+        const outputCodec = this.getOutputCodec('update');
         if (out)
-            return decode(out);
+            return outputCodec(out);
     }
     /**
      * Updates a record in the collection with the specified ID and returns updated record count
@@ -237,8 +239,8 @@ export class SqbEntityService extends ServiceBase {
      * @protected
      */
     async _updateOnly(id, input, options) {
-        const encode = this.getEncoder('create');
-        const data = encode(input);
+        const inputCodec = this.getInputCodec('create');
+        const data = inputCodec(input);
         return await this._dbUpdateOnly(id, data, options);
     }
     /**
@@ -250,8 +252,8 @@ export class SqbEntityService extends ServiceBase {
      * @protected
      */
     async _updateMany(input, options) {
-        const encode = this.getEncoder('update');
-        const data = encode(input);
+        const inputCodec = this.getInputCodec('update');
+        const data = inputCodec(input);
         return await this._dbUpdateMany(data, options);
     }
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opra/sqb",
-  "version": "1.0.0-alpha.3",
+  "version": "1.0.0-alpha.4",
   "description": "Opra SQB adapter package",
   "author": "Panates",
   "license": "MIT",
@@ -18,8 +18,8 @@
     "postbuild": "cp README.md package.json ../../LICENSE ../../build/sqb && cp ../../package.cjs.json ../../build/sqb/cjs/package.json",
     "lint": "eslint . --max-warnings=0",
     "format": "prettier . --write --log-level=warn",
-    "test": "jest",
-    "cover": "jest --collect-coverage",
+    "test": "jest --passWithNoTests",
+    "cover": "jest --passWithNoTests --collect-coverage",
     "clean": "npm run clean:src && npm run clean:test && npm run clean:dist && npm run clean:cover",
     "clean:src": "ts-cleanup -s src --all",
     "clean:test": "ts-cleanup -s test --all",
@@ -35,7 +35,7 @@
     "ts-gems": "^3.4.0"
   },
   "peerDependencies": {
-    "@opra/core": "^1.0.0-alpha.3",
+    "@opra/core": "^1.0.0-alpha.4",
     "@sqb/connect": ">= 4.10.6"
   },
   "type": "module",

package/types/sqb-entity-service.d.ts

@@ -111,8 +111,8 @@ export declare class SqbEntityService<T extends object = object> extends Service
     protected _dataType: ComplexType;
     protected _dataTypeClass?: Type;
     protected _entityMetadata?: EntityMetadata;
-    protected _encoders: Record<string, IsObject.Validator<T>>;
-    protected _decoder?: IsObject.Validator<T>;
+    protected _inputCodecs: Record<string, IsObject.Validator<T>>;
+    protected _outputCodecs: Record<string, IsObject.Validator<T>>;
     /**
      * Represents a SqbClient or SqbConnection object
      */
@@ -178,15 +178,15 @@ export declare class SqbEntityService<T extends object = object> extends Service
      */
     getResourceName(): string;
     /**
-     * Retrieves the encoder for the specified operation.
+     * Retrieves the codec for the specified operation.
      *
      * @param operation - The operation to retrieve the encoder for. Valid values are 'create' and 'update'.
      */
-    getEncoder(operation: 'create' | 'update'): IsObject.Validator<T>;
+    getInputCodec(operation: string): IsObject.Validator<T>;
     /**
-     * Retrieves the decoder.
+     * Retrieves the codec.
      */
-    getDecoder(): IsObject.Validator<T>;
+    getOutputCodec(operation: string): IsObject.Validator<T>;
     /**
      * Insert a new record into database
      *