@balena/sbvr-types 4.0.1 → 4.0.2

package/.versionbot/CHANGELOG.yml

@@ -1,3 +1,14 @@
+- commits:
+    - subject: Improve typings
+      hash: a5fd4a319cd0336afc5a765af9e1a1eec851f2c3
+      body: ""
+      footer:
+        Change-type: patch
+        change-type: patch
+      author: Pagan Gazzard
+  version: 4.0.2
+  title: ""
+  date: 2023-05-03T11:37:17.650Z
 - commits:
     - subject: "boolean: Avoid unnecessary array creation to reduce GCs"
       hash: 5ba948cd5f42844974d43dc19f1c371e56376fc8
@@ -8,7 +19,7 @@
       author: Thodoris Greasidis
   version: 4.0.1
   title: ""
-  date: 2023-05-02T09:44:46.040Z
+  date: 2023-05-02T13:39:37.722Z
 - commits:
     - subject: Add test cases for Objects in JSON validate
       hash: be8fc31c3754186dd4c43ca8d4c056b0def7ffbd

package/CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file
 automatically by Versionist. DO NOT EDIT THIS FILE MANUALLY!
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+# v4.0.2
+## (2023-05-03)
+
+* Improve typings [Pagan Gazzard]
+
 # v4.0.1
 ## (2023-05-02)
 

package/out/index.d.ts

@@ -1,12 +1,43 @@
-import type { SbvrType } from './type-utils';
+import * as BigInteger from './types/big-integer';
+import * as BigSerial from './types/big-serial';
+import * as Boolean from './types/boolean';
+import * as CaseInsensitiveText from './types/case-insensitive-text';
+import * as Color from './types/color';
+import * as ConceptType from './types/concept-type';
+import * as Date from './types/date';
+import * as DateTime from './types/date-time';
+import * as File from './types/file';
+import * as ForeignKey from './types/foreign-key';
+import * as Hashed from './types/hashed';
+import * as Integer from './types/integer';
+import * as Interval from './types/interval';
+import * as JSON from './types/json';
+import * as Real from './types/real';
+import * as Serial from './types/serial';
+import * as SHA from './types/sha';
+import * as ShortText from './types/short-text';
+import * as Text from './types/text';
+import * as Time from './types/time';
 declare const _default: {
-    [fieldType: string]: SbvrType;
-    Hashed: SbvrType & {
-        compare: (str: string, hash: string) => Promise<boolean>;
-    };
-    SHA: SbvrType & {
-        validateSync: (value: string) => string;
-        compare: (str: string, hash: string) => Promise<boolean>;
-    };
+    'Big Integer': typeof BigInteger;
+    'Big Serial': typeof BigSerial;
+    Boolean: typeof Boolean;
+    'Case Insensitive Text': typeof CaseInsensitiveText;
+    Color: typeof Color;
+    ConceptType: typeof ConceptType;
+    'Date Time': typeof DateTime;
+    Date: typeof Date;
+    File: typeof File;
+    ForeignKey: typeof ForeignKey;
+    Hashed: typeof Hashed;
+    Integer: typeof Integer;
+    Interval: typeof Interval;
+    JSON: typeof JSON;
+    Real: typeof Real;
+    Serial: typeof Serial;
+    SHA: typeof SHA;
+    'Short Text': typeof ShortText;
+    Text: typeof Text;
+    Time: typeof Time;
 };
 export = _default;

package/out/type-utils.d.ts

@@ -14,7 +14,7 @@ export interface SbvrType {
         websql: DatabaseType;
     };
     fetchProcessing?: (field: any) => any;
-    validate: (value: any, required?: boolean) => Promise<any>;
+    validate: (value: any, required: boolean) => Promise<any>;
 }
 export declare const nativeFactTypeTemplates: {
     equality: {
@@ -30,21 +30,21 @@ export declare const validate: {
     checkRequired: <T>(validateFn: (value: any) => T) => {
         (value: any, required: true): Promise<T>;
         (value: undefined | null, required: false): Promise<null>;
-        <U>(value: U, required: boolean): Promise<T | null>;
+        (value: any, required: boolean): Promise<T | null>;
     };
     integer: {
         (value: any, required: true): Promise<number>;
         (value: undefined | null, required: false): Promise<null>;
-        <U_1>(value: U_1, required: boolean): Promise<number | null>;
+        (value: any, required: boolean): Promise<number | null>;
     };
     text: (length?: number) => {
         (value: any, required: true): Promise<string>;
         (value: undefined | null, required: false): Promise<null>;
-        <U_2>(value: U_2, required: boolean): Promise<string | null>;
+        (value: any, required: boolean): Promise<string | null>;
     };
     date: {
         (value: any, required: true): Promise<Date>;
         (value: undefined | null, required: false): Promise<null>;
-        <U_3>(value: U_3, required: boolean): Promise<Date | null>;
+        (value: any, required: boolean): Promise<Date | null>;
     };
 };

package/out/type-utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"type-utils.js","sourceRoot":"","sources":["../src/type-utils.ts"],"names":[],"mappings":";;;AAmBA,MAAM,aAAa,GAAG,CAAI,UAA6B,EAAE,EAAE;IAI1D,KAAK,UAAU,QAAQ,CAAI,KAAQ,EAAE,QAAiB;QACrD,IAAI,KAAK,IAAI,IAAI,EAAE;YAClB,IAAI,QAAQ,EAAE;gBACb,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;aAClC;YACD,OAAO,IAAI,CAAC;SACZ;QACD,OAAO,UAAU,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;IACD,OAAO,QAAQ,CAAC;AACjB,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAG;IAChB,aAAa,EAAE,CAAC,IAAY,EAAE,EAAU,EAAE,EAAE,CAAC,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE,CAAC;CACjE,CAAC;AACW,QAAA,uBAAuB,GAAG;IACtC,QAAQ;IACR,UAAU,EAAE;QACX,cAAc,EAAE,CAAC,IAAY,EAAE,EAAU,EAAE,EAAE,CAAC,CAAC,UAAU,EAAE,IAAI,EAAE,EAAE,CAAC;QACpE,0BAA0B,EAAE,CAAC,IAAY,EAAE,EAAU,EAAE,EAAE,CAAC;YACzD,iBAAiB;YACjB,IAAI;YACJ,EAAE;SACF;QACD,GAAG,QAAQ;KACX;CACD,CAAC;AAEW,QAAA,QAAQ,GAAG;IACvB,aAAa;IACb,OAAO,EAAE,aAAa,CAAC,CAAC,KAAU,EAAE,EAAE;QACrC,MAAM,cAAc,GAAG,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAC3C,IAAI,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,EAAE;YACjC,MAAM,IAAI,KAAK,CAAC,mBAAmB,GAAG,KAAK,CAAC,CAAC;SAC7C;QACD,OAAO,cAAc,CAAC;IACvB,CAAC,CAAC;IACF,IAAI,EAAE,CAAC,MAAe,EAAE,EAAE,CACzB,aAAa,CAAC,CAAC,KAAU,EAAE,EAAE;QAC5B,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC9B,MAAM,IAAI,KAAK,CAAC,mBAAmB,GAAG,KAAK,CAAC,CAAC;SAC7C;QACD,IAAI,MAAM,IAAI,IAAI,IAAI,KAAK,CAAC,MAAM,GAAG,MAAM,EAAE;YAC5C,MAAM,IAAI,KAAK,CACd,cAAc,GAAG,MAAM,GAAG,eAAe,GAAG,KAAK,CAAC,MAAM,GAAG,GAAG,CAC9D,CAAC;SACF;QACD,OAAO,KAAK,CAAC;IACd,CAAC,CAAC;IACH,IAAI,EAAE,aAAa,CAAC,CAAC,KAAU,EAAE,EAAE;QAClC,IAAI,cAAc,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;QACnC,IAAI,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,EAAE;YACjC,cAAc,GAAG,KAAK,CAAC;SACvB;QACD,MAAM,aAAa,GAAG,IAAI,IAAI,CAAC,cAAc,CAAC,CAAC;QAC/C,IAAI,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC,EAAE;YAC1C,MAAM,IAAI,KAAK,CAAC,uBAAuB,GAAG,KAAK,CAAC,CAAC;SACjD;QACD,OAAO,aAAa,CAAC;IACtB,CAAC,CAAC;CACF,CAAC"}
+{"version":3,"file":"type-utils.js","sourceRoot":"","sources":["../src/type-utils.ts"],"names":[],"mappings":";;;AAmBA,MAAM,aAAa,GAAG,CAAI,UAA6B,EAAE,EAAE;IAI1D,KAAK,UAAU,QAAQ,CAAC,KAAU,EAAE,QAAiB;QACpD,IAAI,KAAK,IAAI,IAAI,EAAE;YAClB,IAAI,QAAQ,EAAE;gBACb,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;aAClC;YACD,OAAO,IAAI,CAAC;SACZ;QACD,OAAO,UAAU,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;IACD,OAAO,QAAQ,CAAC;AACjB,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAG;IAChB,aAAa,EAAE,CAAC,IAAY,EAAE,EAAU,EAAE,EAAE,CAAC,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE,CAAC;CACjE,CAAC;AACW,QAAA,uBAAuB,GAAG;IACtC,QAAQ;IACR,UAAU,EAAE;QACX,cAAc,EAAE,CAAC,IAAY,EAAE,EAAU,EAAE,EAAE,CAAC,CAAC,UAAU,EAAE,IAAI,EAAE,EAAE,CAAC;QACpE,0BAA0B,EAAE,CAAC,IAAY,EAAE,EAAU,EAAE,EAAE,CAAC;YACzD,iBAAiB;YACjB,IAAI;YACJ,EAAE;SACF;QACD,GAAG,QAAQ;KACX;CACD,CAAC;AAEW,QAAA,QAAQ,GAAG;IACvB,aAAa;IACb,OAAO,EAAE,aAAa,CAAC,CAAC,KAAU,EAAE,EAAE;QACrC,MAAM,cAAc,GAAG,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAC3C,IAAI,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,EAAE;YACjC,MAAM,IAAI,KAAK,CAAC,mBAAmB,GAAG,KAAK,CAAC,CAAC;SAC7C;QACD,OAAO,cAAc,CAAC;IACvB,CAAC,CAAC;IACF,IAAI,EAAE,CAAC,MAAe,EAAE,EAAE,CACzB,aAAa,CAAC,CAAC,KAAU,EAAE,EAAE;QAC5B,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC9B,MAAM,IAAI,KAAK,CAAC,mBAAmB,GAAG,KAAK,CAAC,CAAC;SAC7C;QACD,IAAI,MAAM,IAAI,IAAI,IAAI,KAAK,CAAC,MAAM,GAAG,MAAM,EAAE;YAC5C,MAAM,IAAI,KAAK,CACd,cAAc,GAAG,MAAM,GAAG,eAAe,GAAG,KAAK,CAAC,MAAM,GAAG,GAAG,CAC9D,CAAC;SACF;QACD,OAAO,KAAK,CAAC;IACd,CAAC,CAAC;IACH,IAAI,EAAE,aAAa,CAAC,CAAC,KAAU,EAAE,EAAE;QAClC,IAAI,cAAc,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;QACnC,IAAI,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,EAAE;YACjC,cAAc,GAAG,KAAK,CAAC;SACvB;QACD,MAAM,aAAa,GAAG,IAAI,IAAI,CAAC,cAAc,CAAC,CAAC;QAC/C,IAAI,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC,EAAE;YAC1C,MAAM,IAAI,KAAK,CAAC,uBAAuB,GAAG,KAAK,CAAC,CAAC;SACjD;QACD,OAAO,aAAa,CAAC;IACtB,CAAC,CAAC;CACF,CAAC"}

package/out/types/big-integer.d.ts

@@ -21,5 +21,5 @@ export declare const nativeFactTypes: {
 export declare const validate: {
     (value: any, required: true): Promise<number>;
     (value: null | undefined, required: false): Promise<null>;
-    <U>(value: U, required: boolean): Promise<number | null>;
+    (value: any, required: boolean): Promise<number | null>;
 };

package/out/types/big-serial.d.ts

@@ -10,5 +10,5 @@ export declare const types: {
 export declare const validate: {
     (value: any, required: true): Promise<number>;
     (value: null | undefined, required: false): Promise<null>;
-    <U>(value: U, required: boolean): Promise<number | null>;
+    (value: any, required: boolean): Promise<number | null>;
 };

package/out/types/boolean.d.ts

@@ -11,5 +11,5 @@ export declare const fetchProcessing: (data: any) => boolean;
 export declare const validate: {
     (value: any, required: true): Promise<boolean>;
     (value: null | undefined, required: false): Promise<null>;
-    <U>(value: U, required: boolean): Promise<boolean | null>;
+    (value: any, required: boolean): Promise<boolean | null>;
 };

package/out/types/case-insensitive-text.d.ts

@@ -9,5 +9,5 @@ export declare const types: {
 export declare const validate: {
     (value: any, required: true): Promise<string>;
     (value: null | undefined, required: false): Promise<null>;
-    <U>(value: U, required: boolean): Promise<string | null>;
+    (value: any, required: boolean): Promise<string | null>;
 };

package/out/types/color.d.ts

@@ -24,5 +24,5 @@ export declare const fetchProcessing: (data: number) => {
 export declare const validate: {
     (value: any, required: true): Promise<number>;
     (value: null | undefined, required: false): Promise<null>;
-    <U>(value: U, required: boolean): Promise<number | null>;
+    (value: any, required: boolean): Promise<number | null>;
 };

package/out/types/concept-type.d.ts

@@ -21,5 +21,5 @@ export declare const nativeFactTypes: {
 export declare const validate: {
     (value: any, required: true): Promise<number>;
     (value: null | undefined, required: false): Promise<null>;
-    <U>(value: U, required: boolean): Promise<number | null>;
+    (value: any, required: boolean): Promise<number | null>;
 };

package/out/types/date-time.d.ts

@@ -19,5 +19,5 @@ export declare const nativeNames: {
 export declare const validate: {
     (value: any, required: true): Promise<Date>;
     (value: null | undefined, required: false): Promise<null>;
-    <U>(value: U, required: boolean): Promise<Date | null>;
+    (value: any, required: boolean): Promise<Date | null>;
 };

package/out/types/date.d.ts

@@ -16,5 +16,5 @@ export declare const nativeFactTypes: {
 export declare const validate: {
     (value: any, required: true): Promise<Date>;
     (value: null | undefined, required: false): Promise<null>;
-    <U>(value: U, required: boolean): Promise<Date | null>;
+    (value: any, required: boolean): Promise<Date | null>;
 };

package/out/types/file.d.ts

@@ -10,5 +10,5 @@ export declare const types: {
 export declare const validate: {
     (value: any, required: true): Promise<Buffer>;
     (value: null | undefined, required: false): Promise<null>;
-    <U>(value: U, required: boolean): Promise<Buffer | null>;
+    (value: any, required: boolean): Promise<Buffer | null>;
 };

package/out/types/foreign-key.d.ts

@@ -21,5 +21,5 @@ export declare const nativeFactTypes: {
 export declare const validate: {
     (value: any, required: true): Promise<number>;
     (value: null | undefined, required: false): Promise<null>;
-    <U>(value: U, required: boolean): Promise<number | null>;
+    (value: any, required: boolean): Promise<number | null>;
 };

package/out/types/hashed.d.ts

@@ -10,6 +10,6 @@ export declare const types: {
 export declare const validate: {
     (value: any, required: true): Promise<Promise<string>>;
     (value: null | undefined, required: false): Promise<null>;
-    <U>(value: U, required: boolean): Promise<Promise<string> | null>;
+    (value: any, required: boolean): Promise<Promise<string> | null>;
 };
 export declare const compare: typeof Bcrypt.compare;

package/out/types/integer.d.ts

@@ -21,5 +21,5 @@ export declare const nativeFactTypes: {
 export declare const validate: {
     (value: any, required: true): Promise<number>;
     (value: null | undefined, required: false): Promise<null>;
-    <U>(value: U, required: boolean): Promise<number | null>;
+    (value: any, required: boolean): Promise<number | null>;
 };

package/out/types/interval.d.ts

@@ -9,5 +9,5 @@ export declare const types: {
 export declare const validate: {
     (value: any, required: true): Promise<number>;
     (value: null | undefined, required: false): Promise<null>;
-    <U>(value: U, required: boolean): Promise<number | null>;
+    (value: any, required: boolean): Promise<number | null>;
 };

package/out/types/json.d.ts

@@ -10,5 +10,5 @@ export declare const fetchProcessing: (data: any) => any;
 export declare const validate: {
     (value: any, required: true): Promise<string>;
     (value: null | undefined, required: false): Promise<null>;
-    <U>(value: U, required: boolean): Promise<string | null>;
+    (value: any, required: boolean): Promise<string | null>;
 };

package/out/types/real.d.ts

@@ -21,5 +21,5 @@ export declare const nativeFactTypes: {
 export declare const validate: {
     (value: any, required: true): Promise<number>;
     (value: null | undefined, required: false): Promise<null>;
-    <U>(value: U, required: boolean): Promise<number | null>;
+    (value: any, required: boolean): Promise<number | null>;
 };

package/out/types/serial.d.ts

@@ -10,5 +10,5 @@ export declare const types: {
 export declare const validate: {
     (value: any, required: true): Promise<number>;
     (value: null | undefined, required: false): Promise<null>;
-    <U>(value: U, required: boolean): Promise<number | null>;
+    (value: any, required: boolean): Promise<number | null>;
 };

package/out/types/sha.d.ts

@@ -10,6 +10,6 @@ export declare const validateSync: (value: string) => string;
 export declare const validate: {
     (value: any, required: true): Promise<string>;
     (value: null | undefined, required: false): Promise<null>;
-    <U>(value: U, required: boolean): Promise<string | null>;
+    (value: any, required: boolean): Promise<string | null>;
 };
 export declare const compare: (value: string, result: string) => Promise<boolean>;

package/out/types/short-text.d.ts

@@ -9,5 +9,5 @@ export declare const types: {
 export declare const validate: {
     (value: any, required: true): Promise<string>;
     (value: null | undefined, required: false): Promise<null>;
-    <U>(value: U, required: boolean): Promise<string | null>;
+    (value: any, required: boolean): Promise<string | null>;
 };

package/out/types/text.d.ts

@@ -22,5 +22,5 @@ export declare const nativeFactTypes: {
 export declare const validate: {
     (value: any, required: true): Promise<string>;
     (value: null | undefined, required: false): Promise<null>;
-    <U>(value: U, required: boolean): Promise<string | null>;
+    (value: any, required: boolean): Promise<string | null>;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@balena/sbvr-types",
-  "version": "4.0.1",
+  "version": "4.0.2",
   "description": "SBVR type definitions.",
   "main": "out",
   "scripts": {
@@ -54,6 +54,6 @@
     "npm": ">=8.1.0"
   },
   "versionist": {
-    "publishedAt": "2023-05-02T09:44:46.264Z"
+    "publishedAt": "2023-05-03T11:37:17.824Z"
   }
 }

package/src/index.ts

@@ -42,7 +42,7 @@ export = {
 	'Short Text': ShortText,
 	Text,
 	Time,
-} as {
+} satisfies {
 	Hashed: SbvrType & {
 		compare: (str: string, hash: string) => Promise<boolean>;
 	};

package/src/type-utils.ts

@@ -14,14 +14,14 @@ export interface SbvrType {
 		websql: DatabaseType;
 	};
 	fetchProcessing?: (field: any) => any;
-	validate: (value: any, required?: boolean) => Promise<any>;
+	validate: (value: any, required: boolean) => Promise<any>;
 }
 
 const checkRequired = <T>(validateFn: (value: any) => T) => {
 	function runCheck(value: any, required: true): Promise<T>;
 	function runCheck(value: undefined | null, required: false): Promise<null>;
-	function runCheck<U>(value: U, required: boolean): Promise<T | null>;
-	async function runCheck<U>(value: U, required: boolean): Promise<T | null> {
+	function runCheck(value: any, required: boolean): Promise<T | null>;
+	async function runCheck(value: any, required: boolean): Promise<T | null> {
 		if (value == null) {
 			if (required) {
 				throw new Error('cannot be null');