@opra/common 1.1.0 → 1.2.0

package/cjs/document/data-type/api-field.js

@@ -35,7 +35,8 @@ exports.ApiField = function (...args) {
     _this.fixed = initArgs.fixed;
     _this.required = initArgs.required;
     _this.exclusive = initArgs.exclusive;
-    _this.translatable = initArgs.translatable;
+    _this.localisation = initArgs.localisation;
+    _this.keyField = initArgs.keyField;
     _this.deprecated = initArgs.deprecated;
     _this.readonly = initArgs.readonly;
     _this.writeonly = initArgs.writeonly;
@@ -57,7 +58,8 @@ class ApiFieldClass extends document_element_js_1.DocumentElement {
             fixed: this.fixed,
             required: this.required || undefined,
             exclusive: this.exclusive || undefined,
-            translatable: this.translatable || undefined,
+            localisation: this.localisation || undefined,
+            keyField: this.keyField || undefined,
             deprecated: this.deprecated || undefined,
             readonly: this.readonly || undefined,
             writeonly: this.writeonly || undefined,

package/cjs/document/data-type/complex-type.js

@@ -24,8 +24,6 @@ exports.ComplexType = function (...args) {
     complex_type_base_js_1.ComplexTypeBase.call(this, owner, initArgs, context);
     const _this = (0, ts_gems_1.asMutable)(this);
     _this.kind = index_js_2.OpraSchema.ComplexType.Kind;
-    _this.additionalFields = initArgs.additionalFields;
-    _this.keyField = initArgs.keyField;
     if (initArgs.base) {
         context.enter('.base', () => {
             // noinspection SuspiciousTypeOfGuard
@@ -33,15 +31,18 @@ exports.ComplexType = function (...args) {
                 throw new TypeError(`"${initArgs.base.kind}" can't be set as base for a "${this.kind}"`);
             }
             _this.base = initArgs.base;
-            if (_this.additionalFields == null && _this.base.additionalFields) {
-                _this.additionalFields = _this.base.additionalFields;
-            }
+            _this.additionalFields = _this.base.additionalFields;
+            _this.keyField = _this.base.keyField;
             /** Copy fields from base */
             for (const v of _this.base.fields.values()) {
                 this.fields.set(v.name, new api_field_js_1.ApiField(this, v));
             }
         });
     }
+    if (initArgs.additionalFields !== undefined)
+        _this.additionalFields = initArgs.additionalFields;
+    if (initArgs.keyField !== undefined)
+        _this.keyField = initArgs.keyField;
     _this.ctor = initArgs.ctor || _this.base?.ctor;
     /** Add own fields */
     if (initArgs.fields) {

package/cjs/document/decorators/http-operation-entity.decorator.js

@@ -331,6 +331,77 @@ http_operation_js_1.HttpOperation.Entity.Get = function (arg0, arg1) {
     });
     return decorator;
 };
+/**
+ * HttpOperation.Entity.Replace
+ */
+http_operation_js_1.HttpOperation.Entity.Replace = function (arg0, arg1) {
+    let args;
+    if (typeof arg0 === 'object' && !arg0[constants_js_1.DATATYPE_METADATA]) {
+        args = arg0;
+    }
+    else
+        args = { ...arg1, type: arg0 };
+    /** Initialize the decorator and the chain */
+    const decoratorChain = [];
+    const decorator = (0, http_operation_decorator_js_1.HttpOperationDecoratorFactory)(decoratorChain, {
+        method: 'POST',
+        ...args,
+        composition: 'Entity.Replace',
+    });
+    decorator
+        .QueryParam('projection', {
+        description: 'Determines fields projection',
+        type: new index_js_2.FieldPathType({
+            dataType: args.type,
+            allowSigns: 'each',
+        }),
+        isArray: true,
+        arraySeparator: ',',
+    })
+        .Response(index_js_1.HttpStatusCode.OK, {
+        description: 'Operation is successful. Returns OperationResult with "payload" field that contains the resource asked for.',
+        contentType: index_js_1.MimeTypes.opra_response_json,
+        type: args.type,
+        partial: 'deep',
+    })
+        .Response(index_js_1.HttpStatusCode.NO_CONTENT, {
+        description: 'Operation is successful but no resource found',
+    })
+        .Response(index_js_1.HttpStatusCode.UNPROCESSABLE_ENTITY, {
+        description: 'The request was well-formed but was unable to process operation due to one or many errors.',
+        contentType: index_js_1.MimeTypes.opra_response_json,
+    });
+    /**
+     *
+     */
+    decorator.KeyParam = (name, prmOptions) => {
+        const paramMeta = typeof prmOptions === 'string' || typeof prmOptions === 'function'
+            ? {
+                name,
+                location: 'path',
+                type: prmOptions,
+                keyParam: true,
+            }
+            : {
+                ...prmOptions,
+                name,
+                location: 'path',
+                keyParam: true,
+            };
+        decorator.PathParam(name, paramMeta);
+        decoratorChain.push((meta) => {
+            if (!meta.path?.includes(':' + name))
+                meta.path = (meta.path || '') + '@:' + name;
+            meta.mergePath = true;
+        });
+        return decorator;
+    };
+    decoratorChain.push((operationMeta) => {
+        const compositionOptions = (operationMeta.compositionOptions = operationMeta.compositionOptions || {});
+        compositionOptions.type = getDataTypeName(args.type);
+    });
+    return decorator;
+};
 /**
  * HttpOperation.Entity.UpdateMany
  */

package/cjs/document/factory/data-type.factory.js

@@ -284,6 +284,7 @@ class DataTypeFactory {
     }
     static async _prepareComplexTypeArgs(context, owner, initArgs, metadata) {
         await this._prepareDataTypeArgs(context, initArgs, metadata);
+        initArgs.keyField = metadata.keyField;
         await context.enterAsync('.base', async () => {
             let baseArgs;
             if (metadata.base) {

package/esm/document/data-type/api-field.js

@@ -32,7 +32,8 @@ export const ApiField = function (...args) {
     _this.fixed = initArgs.fixed;
     _this.required = initArgs.required;
     _this.exclusive = initArgs.exclusive;
-    _this.translatable = initArgs.translatable;
+    _this.localisation = initArgs.localisation;
+    _this.keyField = initArgs.keyField;
     _this.deprecated = initArgs.deprecated;
     _this.readonly = initArgs.readonly;
     _this.writeonly = initArgs.writeonly;
@@ -54,7 +55,8 @@ class ApiFieldClass extends DocumentElement {
             fixed: this.fixed,
             required: this.required || undefined,
             exclusive: this.exclusive || undefined,
-            translatable: this.translatable || undefined,
+            localisation: this.localisation || undefined,
+            keyField: this.keyField || undefined,
             deprecated: this.deprecated || undefined,
             readonly: this.readonly || undefined,
             writeonly: this.writeonly || undefined,

package/esm/document/data-type/complex-type.js

@@ -21,8 +21,6 @@ export const ComplexType = function (...args) {
     ComplexTypeBase.call(this, owner, initArgs, context);
     const _this = asMutable(this);
     _this.kind = OpraSchema.ComplexType.Kind;
-    _this.additionalFields = initArgs.additionalFields;
-    _this.keyField = initArgs.keyField;
     if (initArgs.base) {
         context.enter('.base', () => {
             // noinspection SuspiciousTypeOfGuard
@@ -30,15 +28,18 @@ export const ComplexType = function (...args) {
                 throw new TypeError(`"${initArgs.base.kind}" can't be set as base for a "${this.kind}"`);
             }
             _this.base = initArgs.base;
-            if (_this.additionalFields == null && _this.base.additionalFields) {
-                _this.additionalFields = _this.base.additionalFields;
-            }
+            _this.additionalFields = _this.base.additionalFields;
+            _this.keyField = _this.base.keyField;
             /** Copy fields from base */
             for (const v of _this.base.fields.values()) {
                 this.fields.set(v.name, new ApiField(this, v));
             }
         });
     }
+    if (initArgs.additionalFields !== undefined)
+        _this.additionalFields = initArgs.additionalFields;
+    if (initArgs.keyField !== undefined)
+        _this.keyField = initArgs.keyField;
     _this.ctor = initArgs.ctor || _this.base?.ctor;
     /** Add own fields */
     if (initArgs.fields) {

package/esm/document/decorators/http-operation-entity.decorator.js

@@ -329,6 +329,77 @@ HttpOperation.Entity.Get = function (arg0, arg1) {
     });
     return decorator;
 };
+/**
+ * HttpOperation.Entity.Replace
+ */
+HttpOperation.Entity.Replace = function (arg0, arg1) {
+    let args;
+    if (typeof arg0 === 'object' && !arg0[DATATYPE_METADATA]) {
+        args = arg0;
+    }
+    else
+        args = { ...arg1, type: arg0 };
+    /** Initialize the decorator and the chain */
+    const decoratorChain = [];
+    const decorator = HttpOperationDecoratorFactory(decoratorChain, {
+        method: 'POST',
+        ...args,
+        composition: 'Entity.Replace',
+    });
+    decorator
+        .QueryParam('projection', {
+        description: 'Determines fields projection',
+        type: new FieldPathType({
+            dataType: args.type,
+            allowSigns: 'each',
+        }),
+        isArray: true,
+        arraySeparator: ',',
+    })
+        .Response(HttpStatusCode.OK, {
+        description: 'Operation is successful. Returns OperationResult with "payload" field that contains the resource asked for.',
+        contentType: MimeTypes.opra_response_json,
+        type: args.type,
+        partial: 'deep',
+    })
+        .Response(HttpStatusCode.NO_CONTENT, {
+        description: 'Operation is successful but no resource found',
+    })
+        .Response(HttpStatusCode.UNPROCESSABLE_ENTITY, {
+        description: 'The request was well-formed but was unable to process operation due to one or many errors.',
+        contentType: MimeTypes.opra_response_json,
+    });
+    /**
+     *
+     */
+    decorator.KeyParam = (name, prmOptions) => {
+        const paramMeta = typeof prmOptions === 'string' || typeof prmOptions === 'function'
+            ? {
+                name,
+                location: 'path',
+                type: prmOptions,
+                keyParam: true,
+            }
+            : {
+                ...prmOptions,
+                name,
+                location: 'path',
+                keyParam: true,
+            };
+        decorator.PathParam(name, paramMeta);
+        decoratorChain.push((meta) => {
+            if (!meta.path?.includes(':' + name))
+                meta.path = (meta.path || '') + '@:' + name;
+            meta.mergePath = true;
+        });
+        return decorator;
+    };
+    decoratorChain.push((operationMeta) => {
+        const compositionOptions = (operationMeta.compositionOptions = operationMeta.compositionOptions || {});
+        compositionOptions.type = getDataTypeName(args.type);
+    });
+    return decorator;
+};
 /**
  * HttpOperation.Entity.UpdateMany
  */

package/esm/document/factory/data-type.factory.js

@@ -281,6 +281,7 @@ export class DataTypeFactory {
     }
     static async _prepareComplexTypeArgs(context, owner, initArgs, metadata) {
         await this._prepareDataTypeArgs(context, initArgs, metadata);
+        initArgs.keyField = metadata.keyField;
         await context.enterAsync('.base', async () => {
             let baseArgs;
             if (metadata.base) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opra/common",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Opra common package",
   "author": "Panates",
   "license": "MIT",

package/types/document/data-type/api-field.d.ts

@@ -62,7 +62,8 @@ declare class ApiFieldClass extends DocumentElement {
     readonly fixed?: any;
     readonly required?: boolean;
     readonly exclusive?: boolean;
-    readonly translatable?: boolean;
+    readonly localisation?: boolean;
+    readonly keyField?: string;
     readonly deprecated?: boolean | string;
     readonly readonly?: boolean;
     readonly writeonly?: boolean;

package/types/document/decorators/http-operation-entity.decorator.d.ts

@@ -23,6 +23,8 @@ declare module '../http/http-operation.js' {
         FindMany(args: HttpOperation.Entity.FindManyArgs): HttpOperation.Entity.FindManyDecorator;
         Get(type: Type | string, options?: StrictOmit<HttpOperation.Entity.GetArgs, 'type'>): HttpOperation.Entity.GetDecorator;
         Get(args: HttpOperation.Entity.GetArgs): HttpOperation.Entity.GetDecorator;
+        Replace(type: Type | string, options?: StrictOmit<HttpOperation.Entity.UpdateArgs, 'type'>): HttpOperation.Entity.ReplaceDecorator;
+        Replace(args: HttpOperation.Entity.ReplaceArgs): HttpOperation.Entity.ReplaceDecorator;
         Update(type: Type | string, options?: StrictOmit<HttpOperation.Entity.UpdateArgs, 'type'>): HttpOperation.Entity.UpdateDecorator;
         Update(args: HttpOperation.Entity.UpdateArgs): HttpOperation.Entity.UpdateDecorator;
         UpdateMany(type: Type | string, options?: StrictOmit<HttpOperation.Entity.UpdateManyArgs, 'type'>): HttpOperation.Entity.UpdateManyDecorator;
@@ -73,6 +75,13 @@ declare module '../http/http-operation.js' {
             interface GetArgs extends StrictOmit<HttpOperation.Options, 'method' | 'requestBody'> {
                 type: Type | string;
             }
+            /** Replace */
+            interface ReplaceDecorator extends HttpOperationDecorator {
+                KeyParam(name: string, optionsOrType?: StrictOmit<HttpParameter.Options, 'location'> | string | TypeThunkAsync): this;
+            }
+            interface ReplaceArgs extends StrictOmit<HttpOperation.Options, 'method' | 'requestBody'> {
+                type: Type | string;
+            }
             /** Update */
             interface UpdateDecorator extends HttpOperationDecorator {
                 KeyParam(name: string, optionsOrType?: StrictOmit<HttpParameter.Options, 'location'> | string | TypeThunkAsync): this;

package/types/schema/data-type/field.interface.d.ts

@@ -9,10 +9,6 @@ export type Field = {
      * Defines the description of the field
      */
     description?: string;
-    /**
-     * Indicates if the field value is an array
-     */
-    isArray?: boolean;
     /**
      * Defines the default value of the field
      */
@@ -39,9 +35,17 @@ export type Field = {
      */
     exclusive?: boolean;
     /**
-     * If true, this Field is a candidate for translations
+     * Indicates if the field value is an array
+     */
+    isArray?: boolean;
+    /**
+     * Indicates key field when this field is a ComplexType array
+     */
+    keyField?: string;
+    /**
+     * If true, this Field is a candidate for localisation
      */
-    translatable?: boolean;
+    localisation?: boolean;
     /**
      * Defines example values for the field
      */