@opra/common 1.8.0 → 1.9.0

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

@@ -108,8 +108,8 @@ function EnumTypeFactory(enumSource, ...args) {
     const metadata = {
         kind: index_js_2.OpraSchema.EnumType.Kind,
         attributes,
-        base: options.base,
-        name: options.name,
+        base: options?.base,
+        name: options?.name,
         description: options?.description,
     };
     Object.defineProperty(enumSource, constants_js_1.DATATYPE_METADATA, {

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

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_js_1 = require("../../enums/index.js");
+const constants_js_1 = require("../constants.js");
+const index_js_2 = require("../data-type/extended-types/index.js");
+const http_operation_js_1 = require("../http/http-operation.js");
+const http_operation_decorator_js_1 = require("./http-operation.decorator.js");
+const http_operation_entity_decorator_js_1 = require("./http-operation-entity.decorator.js");
+/**
+ *
+ */
+http_operation_js_1.HttpOperation.Entity.Create = 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.Create',
+        requestBody: {
+            immediateFetch: true,
+            ...args.requestBody,
+            required: true,
+        },
+    });
+    decorator
+        .QueryParam('projection', {
+        description: 'Determines fields projection',
+        type: new index_js_2.FieldPathType({
+            dataType: args.type,
+            allowSigns: 'each',
+        }),
+        isArray: true,
+        arraySeparator: ',',
+    })
+        .RequestContent(args.requestBody?.type || args.type)
+        .Response(index_js_1.HttpStatusCode.CREATED, {
+        description: 'Operation is successful. Returns OperationResult with "payload" field that contains the created resource.',
+        contentType: index_js_1.MimeTypes.opra_response_json,
+        type: args.type,
+        partial: 'deep',
+    })
+        .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,
+    });
+    decoratorChain.push((operationMeta) => {
+        const compositionOptions = (operationMeta.compositionOptions =
+            operationMeta.compositionOptions || {});
+        compositionOptions.type = (0, http_operation_entity_decorator_js_1.getDataTypeName)(args.type);
+    });
+    return decorator;
+};

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

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_js_1 = require("../../enums/index.js");
+const constants_js_1 = require("../constants.js");
+const http_operation_js_1 = require("../http/http-operation.js");
+const http_operation_decorator_js_1 = require("./http-operation.decorator.js");
+const http_operation_entity_decorator_js_1 = require("./http-operation-entity.decorator.js");
+/**
+ * HttpOperation.Entity.DeleteMany
+ */
+http_operation_js_1.HttpOperation.Entity.DeleteMany = 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: 'DELETE',
+        ...args,
+        composition: 'Entity.DeleteMany',
+    });
+    decorator
+        .Response(index_js_1.HttpStatusCode.OK, {
+        description: 'Operation is successful. Returns OperationResult with "affected" field.',
+        contentType: index_js_1.MimeTypes.opra_response_json,
+    })
+        .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,
+    });
+    decoratorChain.push((operationMeta) => {
+        const compositionOptions = (operationMeta.compositionOptions =
+            operationMeta.compositionOptions || {});
+        compositionOptions.type = (0, http_operation_entity_decorator_js_1.getDataTypeName)(args.type);
+    });
+    decorator.Filter = (0, http_operation_entity_decorator_js_1.createFilterDecorator)(decorator, decoratorChain, args.type);
+    return decorator;
+};

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

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_js_1 = require("../../enums/index.js");
+const constants_js_1 = require("../constants.js");
+const http_operation_js_1 = require("../http/http-operation.js");
+const http_operation_decorator_js_1 = require("./http-operation.decorator.js");
+const http_operation_entity_decorator_js_1 = require("./http-operation-entity.decorator.js");
+/**
+ * HttpOperation.Entity.Delete
+ */
+http_operation_js_1.HttpOperation.Entity.Delete = 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: 'DELETE',
+        ...args,
+        composition: 'Entity.Delete',
+    });
+    decorator
+        .Response(index_js_1.HttpStatusCode.OK, {
+        description: 'Operation is successful. Returns OperationResult with "affected" field.',
+        contentType: index_js_1.MimeTypes.opra_response_json,
+    })
+        .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,
+    });
+    decoratorChain.push((operationMeta) => {
+        const compositionOptions = (operationMeta.compositionOptions =
+            operationMeta.compositionOptions || {});
+        compositionOptions.type = (0, http_operation_entity_decorator_js_1.getDataTypeName)(args.type);
+    });
+    decorator.KeyParam = (0, http_operation_entity_decorator_js_1.createKeyParamDecorator)(decorator, decoratorChain);
+    return decorator;
+};

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

@@ -0,0 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_js_1 = require("../../enums/index.js");
+const constants_js_1 = require("../constants.js");
+const index_js_2 = require("../data-type/extended-types/index.js");
+const index_js_3 = require("../data-type/primitive-types/index.js");
+const http_operation_js_1 = require("../http/http-operation.js");
+const http_operation_decorator_js_1 = require("./http-operation.decorator.js");
+const http_operation_entity_decorator_js_1 = require("./http-operation-entity.decorator.js");
+/**
+ * HttpOperation.Entity.FindMany
+ */
+http_operation_js_1.HttpOperation.Entity.FindMany = 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: 'GET',
+        ...args,
+        composition: 'Entity.FindMany',
+    });
+    decorator
+        .Response(index_js_1.HttpStatusCode.OK, {
+        description: 'Operation is successful. Returns OperationResult with "payload" field that contains list of resources.',
+        contentType: index_js_1.MimeTypes.opra_response_json,
+        type: args.type,
+        partial: 'deep',
+        isArray: true,
+    })
+        .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,
+    })
+        .QueryParam('limit', {
+        description: 'Determines number of returning instances',
+        type: new index_js_3.IntegerType({ minValue: 1, maxValue: args.maxLimit }),
+    })
+        .QueryParam('skip', {
+        description: 'Determines number of returning instances',
+        type: new index_js_3.IntegerType({ minValue: 1 }),
+    })
+        .QueryParam('count', {
+        description: 'Counts all matching instances if enabled',
+        type: Boolean,
+    })
+        .QueryParam('projection', {
+        description: 'Determines fields projection',
+        type: new index_js_2.FieldPathType({
+            dataType: args.type,
+            allowSigns: 'each',
+        }),
+        isArray: true,
+        arraySeparator: ',',
+    });
+    decoratorChain.push((operationMeta) => {
+        const compositionOptions = (operationMeta.compositionOptions =
+            operationMeta.compositionOptions || {});
+        compositionOptions.type = (0, http_operation_entity_decorator_js_1.getDataTypeName)(args.type);
+        if (args.defaultLimit)
+            compositionOptions.defaultLimit = args.defaultLimit;
+        if (args.defaultProjection)
+            compositionOptions.defaultProjection = args.defaultProjection;
+        if (args.maxLimit)
+            compositionOptions.maxLimit = args.maxLimit;
+    });
+    decorator.Filter = (0, http_operation_entity_decorator_js_1.createFilterDecorator)(decorator, decoratorChain, args.type);
+    /**
+     *
+     */
+    decorator.DefaultSort = (...fields) => {
+        decoratorChain.push((operationMeta) => {
+            const compositionOptions = (operationMeta.compositionOptions =
+                operationMeta.compositionOptions || {});
+            compositionOptions.defaultSort = fields;
+        });
+        return decorator;
+    };
+    decorator.SortFields = (0, http_operation_entity_decorator_js_1.createSortFieldsDecorator)(decorator, decoratorChain);
+    return decorator;
+};

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

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_js_1 = require("../../enums/index.js");
+const constants_js_1 = require("../constants.js");
+const index_js_2 = require("../data-type/extended-types/index.js");
+const http_operation_js_1 = require("../http/http-operation.js");
+const http_operation_decorator_js_1 = require("./http-operation.decorator.js");
+const http_operation_entity_decorator_js_1 = require("./http-operation-entity.decorator.js");
+/**
+ * HttpOperation.Entity.Get
+ */
+http_operation_js_1.HttpOperation.Entity.Get = 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: 'GET',
+        ...args,
+        composition: 'Entity.Get',
+    });
+    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,
+    });
+    decoratorChain.push((operationMeta) => {
+        const compositionOptions = (operationMeta.compositionOptions =
+            operationMeta.compositionOptions || {});
+        compositionOptions.type = (0, http_operation_entity_decorator_js_1.getDataTypeName)(args.type);
+    });
+    decorator.KeyParam = (0, http_operation_entity_decorator_js_1.createKeyParamDecorator)(decorator, decoratorChain);
+    return decorator;
+};

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

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_js_1 = require("../../enums/index.js");
+const constants_js_1 = require("../constants.js");
+const index_js_2 = require("../data-type/extended-types/index.js");
+const http_operation_js_1 = require("../http/http-operation.js");
+const http_operation_decorator_js_1 = require("./http-operation.decorator.js");
+const http_operation_entity_decorator_js_1 = require("./http-operation-entity.decorator.js");
+/**
+ * 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,
+    });
+    decoratorChain.push((operationMeta) => {
+        const compositionOptions = (operationMeta.compositionOptions =
+            operationMeta.compositionOptions || {});
+        compositionOptions.type = (0, http_operation_entity_decorator_js_1.getDataTypeName)(args.type);
+    });
+    decorator.KeyParam = (0, http_operation_entity_decorator_js_1.createKeyParamDecorator)(decorator, decoratorChain);
+    return decorator;
+};

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

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_js_1 = require("../../enums/index.js");
+const constants_js_1 = require("../constants.js");
+const http_operation_js_1 = require("../http/http-operation.js");
+const http_operation_decorator_js_1 = require("./http-operation.decorator.js");
+const http_operation_entity_decorator_js_1 = require("./http-operation-entity.decorator.js");
+/**
+ * HttpOperation.Entity.UpdateMany
+ */
+http_operation_js_1.HttpOperation.Entity.UpdateMany = 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: 'PATCH',
+        ...args,
+        composition: 'Entity.UpdateMany',
+        requestBody: {
+            immediateFetch: true,
+            partial: 'deep',
+            allowPatchOperators: true,
+            keepKeyFields: true,
+            ...args.requestBody,
+            required: true,
+        },
+    });
+    decorator
+        .RequestContent(args.requestBody?.type || args.type)
+        .Response(index_js_1.HttpStatusCode.OK, {
+        description: 'Operation is successful. Returns OperationResult with "affected" field.',
+        contentType: index_js_1.MimeTypes.opra_response_json,
+    })
+        .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,
+    });
+    decoratorChain.push((operationMeta) => {
+        const compositionOptions = (operationMeta.compositionOptions =
+            operationMeta.compositionOptions || {});
+        compositionOptions.type = (0, http_operation_entity_decorator_js_1.getDataTypeName)(args.type);
+    });
+    decorator.Filter = (0, http_operation_entity_decorator_js_1.createFilterDecorator)(decorator, decoratorChain, args.type);
+    return decorator;
+};

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

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_js_1 = require("../../enums/index.js");
+const constants_js_1 = require("../constants.js");
+const index_js_2 = require("../data-type/extended-types/index.js");
+const http_operation_js_1 = require("../http/http-operation.js");
+const http_operation_decorator_js_1 = require("./http-operation.decorator.js");
+const http_operation_entity_decorator_js_1 = require("./http-operation-entity.decorator.js");
+/**
+ * HttpOperation.Entity.Update
+ */
+http_operation_js_1.HttpOperation.Entity.Update = 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: 'PATCH',
+        ...args,
+        composition: 'Entity.Update',
+        requestBody: {
+            partial: 'deep',
+            immediateFetch: true,
+            allowPatchOperators: true,
+            keepKeyFields: true,
+            ...args.requestBody,
+            required: true,
+        },
+    });
+    decorator
+        .QueryParam('projection', {
+        description: 'Determines fields projection',
+        type: new index_js_2.FieldPathType({
+            dataType: args.type,
+            allowSigns: 'each',
+        }),
+        isArray: true,
+        arraySeparator: ',',
+    })
+        .RequestContent(args.requestBody?.type || args.type)
+        .Response(index_js_1.HttpStatusCode.OK, {
+        description: 'Operation is successful. Returns OperationResult with "payload" field that contains updated resource.',
+        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,
+    });
+    decoratorChain.push((operationMeta) => {
+        const compositionOptions = (operationMeta.compositionOptions =
+            operationMeta.compositionOptions || {});
+        compositionOptions.type = (0, http_operation_entity_decorator_js_1.getDataTypeName)(args.type);
+    });
+    decorator.KeyParam = (0, http_operation_entity_decorator_js_1.createKeyParamDecorator)(decorator, decoratorChain);
+    decorator.Filter = (0, http_operation_entity_decorator_js_1.createFilterDecorator)(decorator, decoratorChain, args.type);
+    return decorator;
+};