@opra/common 1.0.0-alpha.8 → 1.0.0-beta.1

package/cjs/helpers/type-guards.js

@@ -1,6 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isAsyncIterable = exports.isIterable = exports.isURL = exports.isFormData = exports.isBlob = exports.isReadableStream = exports.isWritable = exports.isReadable = exports.isStream = exports.isConstructor = void 0;
+exports.isConstructor = isConstructor;
+exports.isStream = isStream;
+exports.isReadable = isReadable;
+exports.isWritable = isWritable;
+exports.isReadableStream = isReadableStream;
+exports.isBlob = isBlob;
+exports.isFormData = isFormData;
+exports.isURL = isURL;
+exports.isIterable = isIterable;
+exports.isAsyncIterable = isAsyncIterable;
 function isConstructor(fn) {
     return (typeof fn === 'function' &&
         fn.prototype &&
@@ -8,26 +17,21 @@ function isConstructor(fn) {
         fn.prototype.constructor.name !== 'Function' &&
         fn.prototype.constructor.name !== 'embedded');
 }
-exports.isConstructor = isConstructor;
 function isStream(x) {
     return x !== null && typeof x === 'object' && typeof x.pipe === 'function';
 }
-exports.isStream = isStream;
 function isReadable(x) {
     return isStream(x) && typeof x._read === 'function' && typeof x._readableState === 'object';
 }
-exports.isReadable = isReadable;
 function isWritable(x) {
     return isStream(x) && typeof x._write === 'function';
 }
-exports.isWritable = isWritable;
 function isReadableStream(x) {
     return (isStream(x) &&
         typeof x.getReader === 'function' &&
         typeof x.pipeThrough === 'function' &&
         typeof x.pipeTo === 'function');
 }
-exports.isReadableStream = isReadableStream;
 function isBlob(x) {
     return (x !== null &&
         typeof x === 'object' &&
@@ -35,7 +39,6 @@ function isBlob(x) {
         typeof x.arrayBuffer === 'function' &&
         typeof x.stream === 'function');
 }
-exports.isBlob = isBlob;
 function isFormData(x) {
     return (x !== null &&
         typeof x.constructor === 'function' &&
@@ -43,16 +46,12 @@ function isFormData(x) {
         typeof x.append === 'function' &&
         typeof x.getAll === 'function');
 }
-exports.isFormData = isFormData;
 function isURL(x) {
     return x !== null && typeof x == 'object' && typeof x.host === 'string' && typeof x.href === 'string';
 }
-exports.isURL = isURL;
 function isIterable(x) {
     return Symbol.iterator in x;
 }
-exports.isIterable = isIterable;
 function isAsyncIterable(x) {
     return Symbol.asyncIterator in x;
 }
-exports.isAsyncIterable = isAsyncIterable;

package/cjs/i18n/string-utils.js

@@ -1,13 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.unescapeString = exports.escapeString = void 0;
+exports.escapeString = escapeString;
+exports.unescapeString = unescapeString;
 const unescapeRegEx = /\\(.)/g;
 const escapeRegEx = /(\\)/g;
 function escapeString(s) {
     return s.replace(escapeRegEx, '\\\\');
 }
-exports.escapeString = escapeString;
 function unescapeString(s) {
     return s.replace(unescapeRegEx, '$1');
 }
-exports.unescapeString = unescapeString;

package/cjs/i18n/translate.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.translate = void 0;
+exports.translate = translate;
 const string_utils_js_1 = require("./string-utils.js");
 const bracketRegEx = /(\))/g;
 function translate(key, arg0, arg1) {
@@ -12,4 +12,3 @@ function translate(key, arg0, arg1) {
         (fallback ? '?' + (0, string_utils_js_1.escapeString)(fallback).replace(bracketRegEx, '\\$1') : '') +
         ')');
 }
-exports.translate = translate;

package/cjs/schema/index.js

@@ -2,30 +2,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OpraSchema = void 0;
 const tslib_1 = require("tslib");
-const constants_ = tslib_1.__importStar(require("./constants.js"));
-const complexType_ = tslib_1.__importStar(require("./data-type/complex-type.interface.js"));
-const enumType_ = tslib_1.__importStar(require("./data-type/enum-type.interface.js"));
-const mappedType_ = tslib_1.__importStar(require("./data-type/mapped-type.interface.js"));
-const mixinType_ = tslib_1.__importStar(require("./data-type/mixin-type.interface.js"));
-const simpleType_ = tslib_1.__importStar(require("./data-type/simple-type.interface.js"));
-const controller_ = tslib_1.__importStar(require("./http/http-controller.interface.js"));
-const operation_ = tslib_1.__importStar(require("./http/http-operation.interface.js"));
-const typeGuards_ = tslib_1.__importStar(require("./type-guards.js"));
-var OpraSchema;
-(function (OpraSchema) {
-    OpraSchema.SpecVersion = constants_.SpecVersion;
-    OpraSchema.ComplexType = complexType_.ComplexType;
-    OpraSchema.EnumType = enumType_.EnumType;
-    OpraSchema.MappedType = mappedType_.MappedType;
-    OpraSchema.MixinType = mixinType_.MixinType;
-    OpraSchema.SimpleType = simpleType_.SimpleType;
-    OpraSchema.HttpController = controller_.HttpController;
-    OpraSchema.HttpOperation = operation_.HttpOperation;
-    OpraSchema.isComplexType = typeGuards_.isComplexType;
-    OpraSchema.isDataType = typeGuards_.isDataType;
-    OpraSchema.isSimpleType = typeGuards_.isSimpleType;
-    OpraSchema.isMixinType = typeGuards_.isMixinType;
-    OpraSchema.isMappedType = typeGuards_.isMappedType;
-    OpraSchema.isEnumType = typeGuards_.isEnumType;
-    OpraSchema.isHttpController = typeGuards_.isHttpController;
-})(OpraSchema || (exports.OpraSchema = OpraSchema = {}));
+const OpraSchema = tslib_1.__importStar(require("./opra-schema.js"));
+exports.OpraSchema = OpraSchema;

package/cjs/schema/opra-schema.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./api-document.interface.js"), exports);
+tslib_1.__exportStar(require("./constants.js"), exports);
+tslib_1.__exportStar(require("./data-type/complex-type.interface.js"), exports);
+tslib_1.__exportStar(require("./data-type/data-type.interface.js"), exports);
+tslib_1.__exportStar(require("./data-type/enum-type.interface.js"), exports);
+tslib_1.__exportStar(require("./data-type/field.interface.js"), exports);
+tslib_1.__exportStar(require("./data-type/mapped-type.interface.js"), exports);
+tslib_1.__exportStar(require("./data-type/mixin-type.interface.js"), exports);
+tslib_1.__exportStar(require("./data-type/simple-type.interface.js"), exports);
+tslib_1.__exportStar(require("./data-type-container.interface.js"), exports);
+tslib_1.__exportStar(require("./http/http-controller.interface.js"), exports);
+tslib_1.__exportStar(require("./http/http-media-type.interface.js"), exports);
+tslib_1.__exportStar(require("./http/http-multipart-field.interface.js"), exports);
+tslib_1.__exportStar(require("./http/http-operation.interface.js"), exports);
+tslib_1.__exportStar(require("./http/http-operation-response.interface.js"), exports);
+tslib_1.__exportStar(require("./http/http-parameter.interface.js"), exports);
+tslib_1.__exportStar(require("./http/http-request-body.interface.js"), exports);
+tslib_1.__exportStar(require("./http/http-status-range.interface.js"), exports);
+tslib_1.__exportStar(require("./type-guards.js"), exports);
+tslib_1.__exportStar(require("./types.js"), exports);
+tslib_1.__exportStar(require("./value.interface.js"), exports);

package/cjs/schema/type-guards.js

@@ -1,6 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isHttpController = exports.isEnumType = exports.isMappedType = exports.isMixinType = exports.isSimpleType = exports.isComplexType = exports.isDataType = void 0;
+exports.isDataType = isDataType;
+exports.isComplexType = isComplexType;
+exports.isSimpleType = isSimpleType;
+exports.isMixinType = isMixinType;
+exports.isMappedType = isMappedType;
+exports.isEnumType = isEnumType;
+exports.isHttpController = isHttpController;
 const complex_type_interface_js_1 = require("./data-type/complex-type.interface.js");
 const enum_type_interface_js_1 = require("./data-type/enum-type.interface.js");
 const mapped_type_interface_js_1 = require("./data-type/mapped-type.interface.js");
@@ -16,28 +22,21 @@ function isDataType(obj) {
             obj.kind === simple_type_interface_js_1.SimpleType.Kind ||
             obj.kind === mixin_type_interface_js_1.MixinType.Kind));
 }
-exports.isDataType = isDataType;
 function isComplexType(obj) {
     return obj && typeof obj === 'object' && obj.kind === complex_type_interface_js_1.ComplexType.Kind;
 }
-exports.isComplexType = isComplexType;
 function isSimpleType(obj) {
     return obj && typeof obj === 'object' && obj.kind === simple_type_interface_js_1.SimpleType.Kind;
 }
-exports.isSimpleType = isSimpleType;
 function isMixinType(obj) {
     return obj && typeof obj === 'object' && obj.kind === mixin_type_interface_js_1.MixinType.Kind;
 }
-exports.isMixinType = isMixinType;
 function isMappedType(obj) {
     return obj && typeof obj === 'object' && obj.kind === mapped_type_interface_js_1.MappedType.Kind;
 }
-exports.isMappedType = isMappedType;
 function isEnumType(obj) {
     return obj && typeof obj === 'object' && obj.kind === enum_type_interface_js_1.EnumType.Kind;
 }
-exports.isEnumType = isEnumType;
 function isHttpController(obj) {
     return obj && typeof obj === 'object' && obj.kind === http_controller_interface_js_1.HttpController.Kind;
 }
-exports.isHttpController = isHttpController;

package/esm/document/api-document.js

@@ -1,4 +1,5 @@
 var _a;
+import { md5 } from 'super-fast-md5';
 import { cloneObject, omitUndefined, ResponsiveMap } from '../helpers/index.js';
 import { OpraSchema } from '../schema/index.js';
 import { DataTypeMap } from './common/data-type-map.js';
@@ -13,6 +14,8 @@ export class ApiDocument extends DocumentElement {
     constructor() {
         super(null);
         this[_a] = new WeakMap();
+        this.id = '';
+        this.info = {};
         this.references = new ResponsiveMap();
         this.types = new DataTypeMap();
         this.node[kDataTypeMap] = this.types;
@@ -77,6 +80,14 @@ export class ApiDocument extends DocumentElement {
             out.api = this.api.toJSON();
         return out;
     }
+    invalidate() {
+        /** Generate id */
+        const x = this.export();
+        delete x.id;
+        this.id = md5(JSON.stringify(x));
+        /** Clear [kTypeNSMap] */
+        this[kTypeNSMap] = new WeakMap();
+    }
     _findDataType(nameOrCtor, visitedRefs) {
         let result = this.types.get(nameOrCtor);
         if (result || !this.references.size)

package/esm/document/common/api-base.js

@@ -4,7 +4,7 @@ import { DocumentElement } from './document-element.js';
 export class ApiBase extends DocumentElement {
     constructor(owner) {
         super(owner);
-        this.owner = owner;
+        this.name = 'OpraApi';
     }
     toJSON() {
         return omitUndefined({

package/esm/document/common/document-element.js

@@ -1,4 +1,5 @@
 import { asMutable } from 'ts-gems';
+import { uid } from 'uid';
 import { DocumentNode } from './document-node.js';
 /**
  *
@@ -8,6 +9,7 @@ export const DocumentElement = function (owner) {
     if (!this)
         throw new TypeError('"this" should be passed to call class constructor');
     const _this = asMutable(this);
+    _this.id = uid(16);
     Object.defineProperty(_this, 'node', {
         value: new DocumentNode(this, owner?.node),
         enumerable: false,

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

@@ -37,6 +37,7 @@ export const ApiField = function (...args) {
     _this.readonly = initArgs.readonly;
     _this.writeonly = initArgs.writeonly;
     _this.examples = initArgs.examples;
+    _this.hidden = initArgs.hidden;
 };
 /**
  *
@@ -48,15 +49,15 @@ class ApiFieldClass extends DocumentElement {
         return omitUndefined({
             type: typeName ? typeName : this.type?.toJSON(),
             description: this.description,
-            isArray: this.isArray,
+            isArray: this.isArray || undefined,
             default: this.default,
             fixed: this.fixed,
-            required: this.required,
-            exclusive: this.exclusive,
-            translatable: this.translatable,
-            deprecated: this.deprecated,
-            readonly: this.readonly,
-            writeonly: this.writeonly,
+            required: this.required || undefined,
+            exclusive: this.exclusive || undefined,
+            translatable: this.translatable || undefined,
+            deprecated: this.deprecated || undefined,
+            readonly: this.readonly || undefined,
+            writeonly: this.writeonly || undefined,
             examples: this.examples,
         });
     }

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

@@ -129,7 +129,7 @@ class ComplexTypeBaseClass extends DataType {
             }
         }
         return vg.isObject(schema, {
-            ctor: this.ctor,
+            ctor: this.name === 'object' ? Object : this.ctor,
             additionalFields,
             name: this.name,
             coerce: true,
@@ -144,7 +144,9 @@ class ComplexTypeBaseClass extends DataType {
         // Process fields
         let fieldName;
         for (const field of this.fields.values()) {
-            if ((context.ignoreReadonlyFields && field.readonly) || (context.ignoreWriteonlyFields && field.writeonly)) {
+            if ((context.ignoreReadonlyFields && field.readonly) ||
+                (context.ignoreWriteonlyFields && field.writeonly) ||
+                (context.ignoreHiddenFields && field.hidden)) {
                 schema[field.name] = vg.isUndefined({ coerce: true });
                 continue;
             }
@@ -166,7 +168,7 @@ class ComplexTypeBaseClass extends DataType {
             const fn = this._generateFieldCodec(codec, field, {
                 ...context,
                 partial: context.partial === 'deep' ? context.partial : undefined,
-                projection: projection !== '*' ? projection : p?.projection,
+                projection: typeof projection === 'object' ? projection[fieldName]?.projection || '*' : projection,
                 currentPath: currentPath + (currentPath ? '.' : '') + fieldName,
             });
             schema[fieldName] = context.partial || !field.required ? vg.optional(fn) : vg.required(fn);

package/esm/document/data-type/extended-types/date-string.type.js

@@ -33,7 +33,7 @@ __decorate([
     __metadata("design:type", String)
 ], DateStringType.prototype, "maxValue", void 0);
 DateStringType = __decorate([
-    SimpleType({
+    (SimpleType({
         description: 'Date string value',
         nameMappings: {
             js: 'string',
@@ -42,7 +42,7 @@ DateStringType = __decorate([
     })
         .Example('2021-04-18', 'Full date value')
         .Example('2021-04', 'Date value without day')
-        .Example('2021', 'Year only value'),
+        .Example('2021', 'Year only value')),
     __metadata("design:paramtypes", [Object])
 ], DateStringType);
 export { DateStringType };

package/esm/document/data-type/extended-types/date-time-string.type.js

@@ -33,7 +33,7 @@ __decorate([
     __metadata("design:type", String)
 ], DateTimeStringType.prototype, "maxValue", void 0);
 DateTimeStringType = __decorate([
-    SimpleType({
+    (SimpleType({
         description: 'DateTime string value',
         nameMappings: {
             js: 'string',
@@ -45,7 +45,7 @@ DateTimeStringType = __decorate([
         .Example('2021-04-18 22:30', 'Date-time value')
         .Example('2021-04-18', 'Date value')
         .Example('2021-04', 'Date value without day')
-        .Example('2021', 'Year only value'),
+        .Example('2021', 'Year only value')),
     __metadata("design:paramtypes", [Object])
 ], DateTimeStringType);
 export { DateTimeStringType };

package/esm/document/data-type/extended-types/date-time.type.js

@@ -47,7 +47,7 @@ __decorate([
     __metadata("design:type", String)
 ], DateTimeType.prototype, "maxValue", void 0);
 DateTimeType = __decorate([
-    SimpleType({
+    (SimpleType({
         description: 'A full datetime value',
         nameMappings: {
             js: 'string',
@@ -56,7 +56,7 @@ DateTimeType = __decorate([
     })
         .Example('2021-04-18T22:30:15')
         .Example('2021-04-18 22:30:15')
-        .Example('2021-04-18 22:30'),
+        .Example('2021-04-18 22:30')),
     __metadata("design:paramtypes", [Object])
 ], DateTimeType);
 export { DateTimeType };

package/esm/document/data-type/extended-types/date.type.js

@@ -47,13 +47,13 @@ __decorate([
     __metadata("design:type", String)
 ], DateType.prototype, "maxValue", void 0);
 DateType = __decorate([
-    SimpleType({
+    (SimpleType({
         description: 'A date without time',
         nameMappings: {
             js: 'Date',
             json: 'string',
         },
-    }).Example('2021-04-18', 'Full date value'),
+    }).Example('2021-04-18', 'Full date value')),
     __metadata("design:paramtypes", [Object])
 ], DateType);
 export { DateType };

package/esm/document/data-type/extended-types/email.type.js

@@ -79,13 +79,13 @@ __decorate([
     __metadata("design:type", String)
 ], EmailType.prototype, "blacklistedChars", void 0);
 EmailType = __decorate([
-    SimpleType({
+    (SimpleType({
         description: 'An email value',
         nameMappings: {
             js: 'string',
             json: 'string',
         },
-    }).Example('some.body@example.com'),
+    }).Example('some.body@example.com')),
     __metadata("design:paramtypes", [Object])
 ], EmailType);
 export { EmailType };

package/esm/document/data-type/extended-types/filter.type.js

@@ -62,7 +62,7 @@ const decodeFilter = (dataType, rules) => validator('decodeFilter', (input, cont
             return filter;
         }
         catch (e) {
-            context.fail(_this, `Not a valid filter expression. ${e.message}`, input, e.errors);
+            context.fail(_this, `Not a valid filter expression. ${e.message}`, input);
             return;
         }
     }

package/esm/document/data-type/extended-types/time.type.js

@@ -37,7 +37,7 @@ __decorate([
     __metadata("design:type", String)
 ], TimeType.prototype, "maxValue", void 0);
 TimeType = __decorate([
-    SimpleType({
+    (SimpleType({
         description: 'Time string in 24h format',
         nameMappings: {
             js: 'string',
@@ -45,7 +45,7 @@ TimeType = __decorate([
         },
     })
         .Example('18:23:00', 'Full time value')
-        .Example('18:23:00', 'Time value without seconds'),
+        .Example('18:23:00', 'Time value without seconds')),
     __metadata("design:paramtypes", [Object])
 ], TimeType);
 export { TimeType };

package/esm/document/data-type/extended-types/url.type.js

@@ -15,13 +15,13 @@ let UrlType = class UrlType {
     }
 };
 UrlType = __decorate([
-    SimpleType({
+    (SimpleType({
         description: 'A Uniform Resource Identifier Reference (RFC 3986 icon) value',
         nameMappings: {
             js: 'string',
             json: 'string',
         },
-    }).Example('http://tempuri.org'),
+    }).Example('http://tempuri.org')),
     __metadata("design:paramtypes", [Object])
 ], UrlType);
 export { UrlType };

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

@@ -1,4 +1,10 @@
 import { createMappedClass } from './utils/create-mapped-class.js';
+/**
+ * Create a new MappedType that omits given fields from base type
+ * @param baseType
+ * @param keys
+ * @param options
+ */
 /**
  *
  */

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

@@ -1,4 +1,10 @@
 import { createMappedClass } from './utils/create-mapped-class.js';
+/**
+ * Create a new MappedType that marks given or all fields as optional
+ * @param baseType
+ * @param keys
+ * @param options
+ */
 /**
  *
  */

package/esm/document/data-type/primitive-types/object.type.js

@@ -1,5 +1,4 @@
 import { __decorate, __metadata } from "tslib";
-import { DATATYPE_METADATA } from '../../constants.js';
 import { ComplexType } from '../complex-type.js';
 let ObjectType = class ObjectType {
     constructor(properties) {
@@ -16,5 +15,3 @@ ObjectType = __decorate([
     __metadata("design:paramtypes", [Object])
 ], ObjectType);
 export { ObjectType };
-const metadata = Reflect.getMetadata(DATATYPE_METADATA, ObjectType);
-metadata.ctor = Object;

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

@@ -83,12 +83,7 @@ class SimpleTypeClass extends DataType {
             properties = this.properties.toJSON(this.properties, this.owner);
         }
         else
-            properties = this.properties || {};
-        properties = Object.keys(this.attributes).reduce((o, k) => {
-            if (properties[k] !== undefined)
-                o[k] = properties[k];
-            return o;
-        }, {});
+            properties = this.properties ? cloneObject(this.properties) : {};
         const baseName = this.base ? this.node.getDataTypeNameWithNs(this.base) : undefined;
         const out = omitUndefined({
             ...DataType.prototype.toJSON.apply(this),

package/esm/document/decorators/api-field-decorator.js

@@ -1,4 +1,3 @@
-import { omitUndefined } from '../../helpers/index.js';
 import { OpraSchema } from '../../schema/index.js';
 import { DATATYPE_METADATA } from '../constants.js';
 export function ApiFieldDecorator(options) {
@@ -17,6 +16,6 @@ export function ApiFieldDecorator(options) {
         }
         else
             elemMeta.type = elemMeta.type || designType;
-        Reflect.defineMetadata(DATATYPE_METADATA, omitUndefined(metadata), target.constructor);
+        Reflect.defineMetadata(DATATYPE_METADATA, metadata, target.constructor);
     };
 }

package/esm/document/decorators/http-controller.decorator.js

@@ -2,7 +2,7 @@ import omit from 'lodash.omit';
 import merge from 'putil-merge';
 import { OpraSchema } from '../../schema/index.js';
 import { HTTP_CONTROLLER_METADATA } from '../constants.js';
-const CLASS_NAME_PATTERN = /^(.*)(Collection|Singleton|Resource|Controller)$/;
+const CLASS_NAME_PATTERN = /^(.*)(Controller)$/;
 export function HttpControllerDecoratorFactory(options) {
     const decoratorChain = [];
     /**