@opra/common 0.31.2 → 0.31.4

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

@@ -11,8 +11,6 @@ const enum_type_js_1 = require("../data-type/enum-type.js");
 const mapped_type_js_1 = require("../data-type/mapped-type.js");
 const mixin_type_js_1 = require("../data-type/mixin-type.js");
 const simple_type_js_1 = require("../data-type/simple-type.js");
-const metadata_mode_enum_js_1 = require("../resource/enums/metadata-mode.enum.js");
-const operation_result_type_js_1 = require("../resource/types/operation-result.type.js");
 const type_document_js_1 = require("../type-document.js");
 /**
  * @class TypeDocumentFactory
@@ -99,10 +97,9 @@ class TypeDocumentFactory {
                 }
             },
             types: [index_js_3.AnyType, index_js_3.Base64Type, index_js_3.BigintType, index_js_3.BooleanType,
-                index_js_3.DateType, index_js_3.UuidType, index_js_3.IntegerType, index_js_3.NullType,
-                index_js_3.NumberType, index_js_3.ObjectType, index_js_3.ObjectIdType, index_js_3.StringType,
-                index_js_3.TimeType, index_js_3.TimestampType,
-                operation_result_type_js_1.OperationResult, metadata_mode_enum_js_1.MetadataMode,
+                index_js_3.DateType, index_js_3.IntegerType, index_js_3.NullType, index_js_3.NumberType, index_js_3.ObjectIdType,
+                index_js_3.ObjectType, index_js_3.ApproxDateType, index_js_3.ApproxDatetimeType,
+                index_js_3.StringType, index_js_3.DatetimeType, index_js_3.TimeType, index_js_3.UuidType
             ]
         };
         const factory = new TypeDocumentFactory();

package/cjs/document/resource/types/operation-result.type.js

@@ -4,12 +4,13 @@ exports.OperationResult = void 0;
 const tslib_1 = require("tslib");
 const complex_type_js_1 = require("../../data-type/complex-type.js");
 const field_js_1 = require("../../data-type/field.js");
-let OperationResult = exports.OperationResult = class OperationResult {
+let OperationResult = class OperationResult {
     constructor(init) {
         if (init)
             Object.assign(this, init);
     }
 };
+exports.OperationResult = OperationResult;
 tslib_1.__decorate([
     (0, field_js_1.ApiField)()
 ], OperationResult.prototype, "context", void 0);

package/cjs/document/type-document.js

@@ -23,7 +23,7 @@ class TypeDocument extends document_base_js_1.DocumentBase {
         this._designCtorMap.set(Number, 'number');
         this._designCtorMap.set(Boolean, 'boolean');
         this._designCtorMap.set(Object, 'any');
-        this._designCtorMap.set(Date, 'timestamp');
+        this._designCtorMap.set(Date, 'datetime');
         this._designCtorMap.set(BigIntConstructor, 'bigint');
         this._designCtorMap.set(ArrayBuffer, 'base64');
         this._designCtorMap.set(SharedArrayBuffer, 'base64');

package/esm/document/data-type/builtin/any.type.js

@@ -1,9 +1,10 @@
 import { __decorate } from "tslib";
 import { SimpleType } from '../simple-type.js';
-export let AnyType = class AnyType {
+let AnyType = class AnyType {
 };
 AnyType = __decorate([
     SimpleType({
         description: 'Represents any value'
     })
 ], AnyType);
+export { AnyType };

package/esm/document/data-type/builtin/approx-date.type.js

@@ -0,0 +1,18 @@
+import { __decorate } from "tslib";
+import { isDateString } from 'valgen';
+import { SimpleType } from '../simple-type.js';
+let ApproxDateType = class ApproxDateType {
+};
+ApproxDateType = __decorate([
+    SimpleType({
+        description: 'An approximate date value',
+        example: [
+            '2021-04-18',
+            '2021-04',
+            '2021',
+        ],
+        decoder: isDateString({ trim: 'date' }),
+        encoder: isDateString({ trim: 'date' })
+    })
+], ApproxDateType);
+export { ApproxDateType };

package/esm/document/data-type/builtin/approx-datetime.type.js

@@ -0,0 +1,21 @@
+import { __decorate } from "tslib";
+import { isDateString } from 'valgen';
+import { SimpleType } from '../simple-type.js';
+let ApproxDatetimeType = class ApproxDatetimeType {
+};
+ApproxDatetimeType = __decorate([
+    SimpleType({
+        description: 'An approximate datetime value.',
+        example: [
+            '2021-04-18T22:30:15+01:00',
+            '2021-04-18T22:30:15',
+            '2021-04-18 22:30',
+            '2021-04-18',
+            '2021-04',
+            '2021',
+        ],
+        decoder: isDateString(),
+        encoder: isDateString()
+    })
+], ApproxDatetimeType);
+export { ApproxDatetimeType };

package/esm/document/data-type/builtin/base64.type.js

@@ -1,7 +1,7 @@
 import { __decorate } from "tslib";
 import { isBase64 } from 'valgen';
 import { SimpleType } from '../simple-type.js';
-export let Base64Type = class Base64Type {
+let Base64Type = class Base64Type {
 };
 Base64Type = __decorate([
     SimpleType({
@@ -10,3 +10,4 @@ Base64Type = __decorate([
         encoder: isBase64(),
     })
 ], Base64Type);
+export { Base64Type };

package/esm/document/data-type/builtin/bigint.type.js

@@ -1,7 +1,7 @@
 import { __decorate } from "tslib";
 import { isBigint, isString, pipe } from 'valgen';
 import { SimpleType } from '../simple-type.js';
-export let BigintType = class BigintType {
+let BigintType = class BigintType {
 };
 BigintType = __decorate([
     SimpleType({
@@ -10,3 +10,4 @@ BigintType = __decorate([
         encoder: pipe(isBigint(), isString())
     })
 ], BigintType);
+export { BigintType };

package/esm/document/data-type/builtin/boolean.type.js

@@ -1,7 +1,7 @@
 import { __decorate } from "tslib";
 import { isBoolean } from 'valgen';
 import { SimpleType } from '../simple-type.js';
-export let BooleanType = class BooleanType {
+let BooleanType = class BooleanType {
 };
 BooleanType = __decorate([
     SimpleType({
@@ -10,3 +10,4 @@ BooleanType = __decorate([
         encoder: isBoolean()
     })
 ], BooleanType);
+export { BooleanType };

package/esm/document/data-type/builtin/date.type.js

@@ -1,19 +1,14 @@
 import { __decorate } from "tslib";
 import { isDate, isDateString } from 'valgen';
 import { SimpleType } from '../simple-type.js';
-export let DateType = class DateType {
+let DateType = class DateType {
 };
 DateType = __decorate([
     SimpleType({
-        description: 'Date only string, for example, 2021-04-18',
-        decoder: isDate({
-            format: ['YYYY-MM-DD', 'YYYY',
-                'YYYY-MM-DDTHH:mm:ss',
-                'YYYY-MM-DDTHH:mm',
-                'YYYY-MM-DD HH:mm:ss',
-                'YYYY-MM-DD HH:mm'
-            ]
-        }),
-        encoder: isDateString({ format: 'YYYY-MM-DD' })
+        description: 'A date without time',
+        example: ['2021-04-18'],
+        decoder: isDate({ precision: 'date' }),
+        encoder: isDateString({ precision: 'date', trim: 'date' })
     })
 ], DateType);
+export { DateType };

package/esm/document/data-type/builtin/datetime.type.js

@@ -0,0 +1,18 @@
+import { __decorate } from "tslib";
+import { isDate, isDateString } from 'valgen';
+import { SimpleType } from '../simple-type.js';
+let DatetimeType = class DatetimeType {
+};
+DatetimeType = __decorate([
+    SimpleType({
+        description: 'A full datetime value',
+        example: [
+            '2021-04-18T22:30:15',
+            '2021-04-18 22:30:15',
+            '2021-04-18 22:30'
+        ],
+        decoder: isDate({ precision: 'time' }),
+        encoder: isDateString({ precision: 'time', trim: 'time' })
+    })
+], DatetimeType);
+export { DatetimeType };

package/esm/document/data-type/builtin/index.js

@@ -1,8 +1,11 @@
 export * from './any.type.js';
+export * from './approx-date.type.js';
+export * from './approx-datetime.type.js';
 export * from './base64.type.js';
 export * from './bigint.type.js';
 export * from './boolean.type.js';
 export * from './date.type.js';
+export * from './datetime.type.js';
 export * from './uuid.type.js';
 export * from './integer.type.js';
 export * from './null.type.js';
@@ -11,4 +14,3 @@ export * from './object.type.js';
 export * from './object-id.type.js';
 export * from './string.type.js';
 export * from './time.type.js';
-export * from './timestamp.type.js';

package/esm/document/data-type/builtin/integer.type.js

@@ -1,7 +1,7 @@
 import { __decorate } from "tslib";
 import { isInteger } from 'valgen';
 import { SimpleType } from '../simple-type.js';
-export let IntegerType = class IntegerType {
+let IntegerType = class IntegerType {
 };
 IntegerType = __decorate([
     SimpleType({
@@ -10,3 +10,4 @@ IntegerType = __decorate([
         encoder: isInteger()
     })
 ], IntegerType);
+export { IntegerType };

package/esm/document/data-type/builtin/null.type.js

@@ -1,7 +1,7 @@
 import { __decorate } from "tslib";
 import { isNull } from 'valgen';
 import { SimpleType } from '../simple-type.js';
-export let NullType = class NullType {
+let NullType = class NullType {
 };
 NullType = __decorate([
     SimpleType({
@@ -10,3 +10,4 @@ NullType = __decorate([
         encoder: isNull()
     })
 ], NullType);
+export { NullType };

package/esm/document/data-type/builtin/number.type.js

@@ -1,7 +1,7 @@
 import { __decorate } from "tslib";
 import { isNumber } from 'valgen';
 import { SimpleType } from '../simple-type.js';
-export let NumberType = class NumberType {
+let NumberType = class NumberType {
 };
 NumberType = __decorate([
     SimpleType({
@@ -10,3 +10,4 @@ NumberType = __decorate([
         encoder: isNumber()
     })
 ], NumberType);
+export { NumberType };

package/esm/document/data-type/builtin/object-id.type.js

@@ -1,7 +1,7 @@
 import { __decorate } from "tslib";
 import { isObjectId, isString, pipe } from 'valgen';
 import { SimpleType } from '../simple-type.js';
-export let ObjectIdType = class ObjectIdType {
+let ObjectIdType = class ObjectIdType {
 };
 ObjectIdType = __decorate([
     SimpleType({
@@ -10,3 +10,4 @@ ObjectIdType = __decorate([
         encoder: pipe(isObjectId(), isString())
     })
 ], ObjectIdType);
+export { ObjectIdType };

package/esm/document/data-type/builtin/object.type.js

@@ -1,6 +1,6 @@
 import { __decorate } from "tslib";
 import { ComplexType } from '../complex-type.js';
-export let ObjectType = class ObjectType {
+let ObjectType = class ObjectType {
 };
 ObjectType = __decorate([
     ComplexType({
@@ -10,3 +10,4 @@ ObjectType = __decorate([
         ctor: Object
     })
 ], ObjectType);
+export { ObjectType };

package/esm/document/data-type/builtin/string.type.js

@@ -1,7 +1,7 @@
 import { __decorate } from "tslib";
 import { isString } from 'valgen';
 import { SimpleType } from '../simple-type.js';
-export let StringType = class StringType {
+let StringType = class StringType {
 };
 StringType = __decorate([
     SimpleType({
@@ -10,3 +10,4 @@ StringType = __decorate([
         encoder: isString(),
     })
 ], StringType);
+export { StringType };

package/esm/document/data-type/builtin/time.type.js

@@ -1,17 +1,20 @@
 import { __decorate } from "tslib";
-import { isDateString } from 'valgen';
+import { isMatches } from 'valgen';
 import { SimpleType } from '../simple-type.js';
-export let TimeType = class TimeType {
+const TIME_PATTERN = /^([0-1][0-9]|2[0-4]):([0-5][0-9])(?::([0-5][0-9]))?$/;
+let TimeType = class TimeType {
 };
 TimeType = __decorate([
     SimpleType({
         description: 'Time string in 24h format, for example, 18:23:00',
-        decoder: isDateString({
-            format: ['HH:mm:ss', 'HH:mm'],
+        decoder: isMatches(TIME_PATTERN, {
+            formatName: 'time',
             onFail: () => '{{label}} is not a valid time'
         }),
-        encoder: isDateString({ format: ['HH:mm:ss', 'HH:mm'],
+        encoder: isMatches(TIME_PATTERN, {
+            formatName: 'time',
             onFail: () => '{{label}} is not a valid time'
         })
     })
 ], TimeType);
+export { TimeType };

package/esm/document/data-type/builtin/uuid.type.js

@@ -1,7 +1,7 @@
 import { __decorate } from "tslib";
 import { isUUID } from 'valgen';
 import { SimpleType } from '../simple-type.js';
-export let UuidType = class UuidType {
+let UuidType = class UuidType {
 };
 UuidType = __decorate([
     SimpleType({
@@ -10,3 +10,4 @@ UuidType = __decorate([
         encoder: isUUID()
     })
 ], UuidType);
+export { UuidType };

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

@@ -5,13 +5,13 @@ export class FieldClass {
         this.owner = owner;
         this.origin = init.origin || owner;
         this.type = init.type;
+        this.designType = init.designType;
         this.name = init.name;
         this.description = init.description;
         this.isArray = init.isArray;
         this.default = init.default;
         this.fixed = init.fixed;
         this.required = init.required;
-        this.nullish = init.nullish;
         this.readonly = init.readonly;
         this.writeonly = init.writeonly;
         this.exclusive = init.exclusive;
@@ -31,7 +31,6 @@ export class FieldClass {
             default: this.default,
             fixed: this.fixed,
             required: this.required,
-            nullish: this.nullish,
             readonly: this.readonly,
             writeonly: this.writeonly,
             exclusive: this.exclusive,
@@ -45,7 +44,7 @@ export class FieldClass {
             return vg.isUndefined();
         if (options?.operation === 'write' && this.readonly)
             return vg.isUndefined();
-        let fn = this.type.generateCodec(codec, options);
+        let fn = this.type.generateCodec(codec, { ...options, designType: this.designType });
         if (this.isArray)
             fn = vg.isArray(fn);
         return !options?.partial && this.required ? vg.required(fn) : vg.optional(fn);

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

@@ -2,14 +2,12 @@ import { validator } from 'valgen';
 import { cloneObject, isConstructor, resolveThunk, ResponsiveMap } from '../../helpers/index.js';
 import { OpraSchema } from '../../schema/index.js';
 import { DATATYPE_METADATA } from '../constants.js';
-import { AnyType, Base64Type, BigintType, BooleanType, DateType, IntegerType, NullType, NumberType, ObjectIdType, ObjectType, StringType, TimestampType, TimeType, UuidType } from '../data-type/builtin/index.js';
+import { AnyType, ApproxDatetimeType, ApproxDateType, Base64Type, BigintType, BooleanType, DatetimeType, DateType, IntegerType, NullType, NumberType, ObjectIdType, ObjectType, StringType, TimeType, UuidType } from '../data-type/builtin/index.js';
 import { ComplexType } from '../data-type/complex-type.js';
 import { EnumType } from '../data-type/enum-type.js';
 import { MappedType } from '../data-type/mapped-type.js';
 import { MixinType } from '../data-type/mixin-type.js';
 import { SimpleType } from '../data-type/simple-type.js';
-import { MetadataMode } from '../resource/enums/metadata-mode.enum.js';
-import { OperationResult } from '../resource/types/operation-result.type.js';
 import { TypeDocument } from '../type-document.js';
 /**
  * @class TypeDocumentFactory
@@ -96,10 +94,9 @@ export class TypeDocumentFactory {
                 }
             },
             types: [AnyType, Base64Type, BigintType, BooleanType,
-                DateType, UuidType, IntegerType, NullType,
-                NumberType, ObjectType, ObjectIdType, StringType,
-                TimeType, TimestampType,
-                OperationResult, MetadataMode,
+                DateType, IntegerType, NullType, NumberType, ObjectIdType,
+                ObjectType, ApproxDateType, ApproxDatetimeType,
+                StringType, DatetimeType, TimeType, UuidType
             ]
         };
         const factory = new TypeDocumentFactory();

package/esm/document/resource/types/operation-result.type.js

@@ -1,7 +1,7 @@
 import { __decorate } from "tslib";
 import { ComplexType } from '../../data-type/complex-type.js';
 import { ApiField } from '../../data-type/field.js';
-export let OperationResult = class OperationResult {
+let OperationResult = class OperationResult {
     constructor(init) {
         if (init)
             Object.assign(this, init);
@@ -39,3 +39,4 @@ OperationResult = __decorate([
         description: 'Operation result'
     })
 ], OperationResult);
+export { OperationResult };

package/esm/document/type-document.js

@@ -20,7 +20,7 @@ export class TypeDocument extends DocumentBase {
         this._designCtorMap.set(Number, 'number');
         this._designCtorMap.set(Boolean, 'boolean');
         this._designCtorMap.set(Object, 'any');
-        this._designCtorMap.set(Date, 'timestamp');
+        this._designCtorMap.set(Date, 'datetime');
         this._designCtorMap.set(BigIntConstructor, 'bigint');
         this._designCtorMap.set(ArrayBuffer, 'base64');
         this._designCtorMap.set(SharedArrayBuffer, 'base64');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opra/common",
-  "version": "0.31.2",
+  "version": "0.31.4",
   "description": "Opra common package",
   "author": "Panates",
   "license": "MIT",
@@ -45,15 +45,15 @@
     "putil-varhelpers": "^1.6.5",
     "reflect-metadata": "^0.1.13",
     "uid": "^2.0.1",
-    "valgen": "^4.1.0"
+    "valgen": "^4.2.2"
   },
   "devDependencies": {
     "@browsery/fs": "^0.4.0",
     "@browsery/stream": "^0.6.0",
     "@browsery/util": "^0.4.0",
-    "@types/encodeurl": "^1.0.0",
-    "@types/validator": "^13.11.3",
-    "@types/lodash.omit": "^4.5.8",
+    "@types/encodeurl": "^1.0.2",
+    "@types/lodash.omit": "^4.5.9",
+    "@types/validator": "^13.11.6",
     "path-browserify": "^1.0.1",
     "ts-gems": "^2.5.0"
   },

package/types/document/data-type/builtin/approx-date.type.d.ts

@@ -0,0 +1,2 @@
+export declare class ApproxDateType {
+}

package/types/document/data-type/builtin/approx-datetime.type.d.ts

@@ -0,0 +1,2 @@
+export declare class ApproxDatetimeType {
+}

package/types/document/data-type/builtin/datetime.type.d.ts

@@ -0,0 +1,2 @@
+export declare class DatetimeType {
+}

package/types/document/data-type/builtin/index.d.ts

@@ -1,8 +1,11 @@
 export * from './any.type.js';
+export * from './approx-date.type.js';
+export * from './approx-datetime.type.js';
 export * from './base64.type.js';
 export * from './bigint.type.js';
 export * from './boolean.type.js';
 export * from './date.type.js';
+export * from './datetime.type.js';
 export * from './uuid.type.js';
 export * from './integer.type.js';
 export * from './null.type.js';
@@ -11,4 +14,3 @@ export * from './object.type.js';
 export * from './object-id.type.js';
 export * from './string.type.js';
 export * from './time.type.js';
-export * from './timestamp.type.js';

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

@@ -30,6 +30,7 @@ export declare namespace DataType {
     interface InitArguments {
         name?: string;
         description?: string;
+        example?: string | string[];
     }
     interface DecoratorOptions extends InitArguments {
     }
@@ -45,5 +46,6 @@ export declare namespace DataType {
         partial?: boolean;
         operation?: 'read' | 'write';
         overwriteFields?: ResponsiveMap<ApiField.InitArguments>;
+        designType?: Type;
     }
 }

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

@@ -1,3 +1,4 @@
+import { Type } from 'ts-gems';
 import * as vg from 'valgen';
 import type { OpraSchema } from '../../schema/index.js';
 import type { ComplexType } from './complex-type.js';
@@ -8,12 +9,12 @@ export declare class FieldClass {
     readonly origin?: ComplexType;
     readonly type: DataType;
     readonly name: string;
+    readonly designType?: Type;
     description?: string;
     isArray?: boolean;
     default?: any;
     fixed?: string | number | boolean;
     required?: boolean;
-    nullish?: boolean;
     readonly?: boolean;
     writeonly?: boolean;
     exclusive?: boolean;

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

@@ -28,6 +28,7 @@ export declare namespace ApiField {
     interface InitArguments extends StrictOmit<OpraSchema.Field, 'type'> {
         name: string;
         type: DataType;
+        designType?: Type;
         origin?: ComplexType;
     }
     interface DecoratorOptions extends Partial<StrictOmit<OpraSchema.Field, 'isArray' | 'type'>> {

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

@@ -25,10 +25,6 @@ export type Field = {
      * Defines if field value required in create operation
      */
     required?: boolean;
-    /**
-     * Defines if field value be nullish (undefined, null or empty)
-     */
-    nullish?: boolean;
     /**
      * Defines if the field is readonly
      */

package/cjs/document/data-type/builtin/timestamp.type.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TimestampType = void 0;
-const tslib_1 = require("tslib");
-const valgen_1 = require("valgen");
-const simple_type_js_1 = require("../simple-type.js");
-let TimestampType = exports.TimestampType = class TimestampType {
-};
-exports.TimestampType = TimestampType = tslib_1.__decorate([
-    (0, simple_type_js_1.SimpleType)({
-        description: 'Timestamp, for example, 2021-04-18T09:12:53',
-        decoder: (0, valgen_1.isDate)({
-            format: ['YYYY-MM-DDTHH:mm:ss', 'YYYY-MM-DD HH:mm:ss', 'YYYY-MM-DD', 'YYYY']
-        }),
-        encoder: (0, valgen_1.isDateString)({ format: 'YYYY-MM-DDTHH:mm:ss' })
-    })
-], TimestampType);

package/esm/document/data-type/builtin/timestamp.type.js

@@ -1,14 +0,0 @@
-import { __decorate } from "tslib";
-import { isDate, isDateString } from 'valgen';
-import { SimpleType } from '../simple-type.js';
-export let TimestampType = class TimestampType {
-};
-TimestampType = __decorate([
-    SimpleType({
-        description: 'Timestamp, for example, 2021-04-18T09:12:53',
-        decoder: isDate({
-            format: ['YYYY-MM-DDTHH:mm:ss', 'YYYY-MM-DD HH:mm:ss', 'YYYY-MM-DD', 'YYYY']
-        }),
-        encoder: isDateString({ format: 'YYYY-MM-DDTHH:mm:ss' })
-    })
-], TimestampType);

package/types/document/data-type/builtin/timestamp.type.d.ts

@@ -1,2 +0,0 @@
-export declare class TimestampType {
-}