mvom - npm Package Compare versions

Comparing version 3.0.0-rc.6 to 3.0.0

CHANGELOG.md

@@ -10,2 +10,8 @@ # Changelog
 
+## [3.0.0]
+
+### Added
+
+- Change output of `Connection` date/time methods to use the `ISOCalendarDate`, `ISOCalendarDateTime`, and `ISOTime` templated string literal types as return values to ensure consistency with inferred schema types ([#805](https://github.com/STORIS/mvom/pull/805))
+
 ## [3.0.0-rc.6]
@@ -515,3 +521,4 @@
 
-[unreleased]: https://github.com/storis/mvom/compare/3.0.0-rc.6...HEAD
+[unreleased]: https://github.com/storis/mvom/compare/3.0.0...HEAD
+[3.0.0]: https://github.com/storis/mvom/compare/3.0.0-rc.6...3.0.0
 [3.0.0-rc.6]: https://github.com/storis/mvom/compare/3.0.0-rc.5...3.0.0-rc.6
@@ -518,0 +525,0 @@ [3.0.0-rc.5]: https://github.com/storis/mvom/compare/3.0.0-rc.4...3.0.0-rc.5

Connection.d.ts

@@ -7,3 +7,3 @@ import type http from 'http';
 import type Schema from './Schema';
-import type { DbServerLimits, DbSubroutineInputOptionsMap, DbSubroutineResponseTypesMap, DbSubroutineSetupOptions } from './types';
+import type { DbServerLimits, DbSubroutineInputOptionsMap, DbSubroutineResponseTypesMap, DbSubroutineSetupOptions, ISOCalendarDate, ISOCalendarDateTime, ISOTime } from './types';
 export interface CreateConnectionOptions {
@@ -90,7 +90,7 @@ /** Optional logger instance */
     /** Get the current ISOCalendarDate from the database */
-    getDbDate({ requestId }?: GetDbDateOptions): Promise<string>;
+    getDbDate({ requestId }?: GetDbDateOptions): Promise<ISOCalendarDate>;
     /** Get the current ISOCalendarDateTime from the database */
-    getDbDateTime({ requestId }?: GetDbDateTimeOptions): Promise<string>;
+    getDbDateTime({ requestId, }?: GetDbDateTimeOptions): Promise<ISOCalendarDateTime>;
     /** Get the current ISOTime from the database */
-    getDbTime({ requestId }?: GetDbTimeOptions): Promise<string>;
+    getDbTime({ requestId }?: GetDbTimeOptions): Promise<ISOTime>;
     /** Get the multivalue database server limits */
@@ -97,0 +97,0 @@ getDbLimits({ requestId }?: GetDbLimitsOptions): Promise<DbServerLimits>;

index.d.ts

 export { default as Connection } from './Connection';
 export { default as Document, type DocumentData, type DocumentConstructorOptions, type DocumentCompositeValue, } from './Document';
 export type { SchemaFilter, SchemaFilterKeys, Filter, QueryConstructorOptions, SortCriteria, } from './Query';
-export { default as Schema, type SchemaDefinition, type DictionariesOption, type SchemaConstructorOptions, type ISOCalendarDate, type ISOCalendarDateTime, type ISOTime, type FlattenDocument, type InferDocumentObject, type InferModelObject, type InferSchemaPaths, } from './Schema';
+export { default as Schema, type SchemaDefinition, type DictionariesOption, type SchemaConstructorOptions, type FlattenDocument, type InferDocumentObject, type InferModelObject, type InferSchemaPaths, } from './Schema';
 export type { ModelConstructor, ModelConstructorOptions, Model, ModelCompositeValue, IncrementOperation, ModelIncrementResult, } from './compileModel';
 export { MvisError, DataValidationError, DbServerError, ForeignKeyValidationError, InvalidParameterError, InvalidServerFeaturesError, RecordLockedError, RecordNotFoundError, RecordVersionError, TimeoutError, TransformDataError, UnknownError, } from './errors';
 export type { SchemaTypeDefinitionBoolean, SchemaTypeDefinitionISOCalendarDateTime, SchemaTypeDefinitionISOCalendarDate, SchemaTypeDefinitionISOTime, SchemaTypeDefinitionNumber, SchemaTypeDefinitionString, } from './schemaType';
-export type { EncryptFn, DecryptFn, MvRecord } from './types';
+export type { EncryptFn, DecryptFn, MvRecord, ISOCalendarDate, ISOCalendarDateTime, ISOTime, } from './types';

package.json

 {
   "name": "mvom",
   "private": false,
-  "version": "3.0.0-rc.6",
+  "version": "3.0.0",
   "description": "Multivalue Object Mapper",
@@ -25,3 +25,3 @@ "main": "index.js",
     "axios": "^1.7.7",
-    "date-fns": "^3.6.0",
+    "date-fns": "^4.1.0",
     "fs-extra": "^11.2.0",
@@ -28,0 +28,0 @@ "lodash": "^4.17.21"

Query.d.ts

 import type Connection from './Connection';
 import type LogHandler from './LogHandler';
-import type { DictionariesOption, DictionaryDefinition, DictionaryTypeDefinitionBoolean, DictionaryTypeDefinitionISOCalendarDate, DictionaryTypeDefinitionISOCalendarDateTime, DictionaryTypeDefinitionISOTime, DictionaryTypeDefinitionNumber, DictionaryTypeDefinitionString, FlattenDocument, ISOCalendarDate, ISOCalendarDateTime, ISOTime, SchemaDefinition, SchemaTypeDefinition } from './Schema';
+import type { DictionariesOption, DictionaryDefinition, DictionaryTypeDefinitionBoolean, DictionaryTypeDefinitionISOCalendarDate, DictionaryTypeDefinitionISOCalendarDateTime, DictionaryTypeDefinitionISOTime, DictionaryTypeDefinitionNumber, DictionaryTypeDefinitionString, FlattenDocument, SchemaDefinition, SchemaTypeDefinition } from './Schema';
 import type Schema from './Schema';
 import type { SchemaTypeDefinitionScalar } from './schemaType';
-import type { DbDocument, DbSubroutineSetupOptions } from './types';
+import type { DbDocument, DbSubroutineSetupOptions, ISOCalendarDate, ISOCalendarDateTime, ISOTime } from './types';
 export interface QueryConstructorOptions<TSchema extends Schema | null> {
@@ -8,0 +8,0 @@ /** Skip the first _n_ results */

Schema.d.ts

 import type { RequiredModelMeta } from './compileModel';
 import type { BaseSchemaType, SchemaTypeDefinitionBoolean, SchemaTypeDefinitionISOCalendarDate, SchemaTypeDefinitionISOCalendarDateTime, SchemaTypeDefinitionISOTime, SchemaTypeDefinitionNumber, SchemaTypeDefinitionScalar, SchemaTypeDefinitionString, SchemaTypePath } from './schemaType';
-import type { DataTransformer, DecryptFn, EncryptFn, FlattenObject, MarkRequired, Remap } from './types';
+import type { DataTransformer, DecryptFn, EncryptFn, FlattenObject, ISOCalendarDate, ISOCalendarDateTime, ISOTime, MarkRequired, Remap } from './types';
 export type SchemaTypeDefinition = Schema | SchemaTypeDefinitionScalar | SchemaDefinition | SchemaTypeDefinitionArray;
@@ -39,8 +39,2 @@ type SchemaTypeDefinitionArray = readonly [Schema] | readonly [SchemaTypeDefinitionScalar] | readonly [[SchemaTypeDefinitionScalar]] | readonly [SchemaDefinition];
 }
-/** Format of ISOCalendarDate output */
-export type ISOCalendarDate = `${number}-${number}-${number}`;
-/** Format of ISOTime output */
-export type ISOTime = `${number}:${number}:${number}.${number}`;
-/** Format of ISOCalendarDateTime output */
-export type ISOCalendarDateTime = `${ISOCalendarDate}T${ISOTime}`;
 /** Infer whether a schema type definition is required and union the result with null if it is not */
@@ -47,0 +41,0 @@ type InferRequiredType<TScalar, TType> = TScalar extends {

Schema.js

@@ -14,8 +14,2 @@ "use strict";
 
-/** Format of ISOCalendarDate output */
-
-/** Format of ISOTime output */
-
-/** Format of ISOCalendarDateTime output */
-
 /** Infer whether a schema type definition is required and union the result with null if it is not */
@@ -22,0 +16,0 @@

types/Miscellaneous.d.ts

 export type MvDataType = string | null | undefined;
 export type MvAttribute = MvDataType | (MvDataType | MvDataType[])[];
 export type MvRecord = MvAttribute[];
+/** Format of ISOCalendarDate output */
+export type ISOCalendarDate = `${number}-${number}-${number}`;
+/** Format of ISOTime output */
+export type ISOTime = `${number}:${number}:${number}.${number}`;
+/** Format of ISOCalendarDateTime output */
+export type ISOCalendarDateTime = `${ISOCalendarDate}T${ISOTime}`;

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

305738

increased by0.11%

Number of low quality alerts

1

decreased by-50%

Worsened metrics

Lines of code

5462

decreased by-0.05%

Dependency changes

• + Addeddate-fns@4.1.0(transitive)

• - Removeddate-fns@3.6.0(transitive)

• Updateddate-fns@^4.1.0