@balena/sbvr-types 7.1.1 → 7.1.2

package/.versionbot/CHANGELOG.yml

@@ -1,3 +1,16 @@
+- commits:
+    - subject: Explicitly type the `compare` function for `hashed`
+      hash: 6ece56f531ba9507fb090003bd3216e90b2f583b
+      body: |
+        This avoids the need for downstream users to have the bcrypt types
+        available whilst also avoiding accidental breaking changes
+      footer:
+        Change-type: patch
+        change-type: patch
+      author: Pagan Gazzard
+  version: 7.1.2
+  title: ""
+  date: 2024-06-12T12:14:00.325Z
 - commits:
     - subject: Accept `Date` for the write types of `Date Time`/`Date`/`Time`
       hash: eb03c8fb593fad76c74dad57a3d45625daf44d76
@@ -8,7 +21,7 @@
       author: Pagan Gazzard
   version: 7.1.1
   title: ""
-  date: 2024-06-03T18:07:36.309Z
+  date: 2024-06-04T09:59:12.864Z
 - commits:
     - subject: Export typescript read/write types for each sbvr type
       hash: 66b9a012e242533372ce34a73e31f6e3aac93d91

package/CHANGELOG.md

@@ -4,8 +4,13 @@ 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/).
 
+# v7.1.2
+## (2024-06-12)
+
+* Explicitly type the `compare` function for `hashed` [Pagan Gazzard]
+
 # v7.1.1
-## (2024-06-03)
+## (2024-06-04)
 
 * Accept `Date` for the write types of `Date Time`/`Date`/`Time` [Pagan Gazzard]
 

package/out/types/hashed.d.ts

@@ -1,4 +1,4 @@
-import type * as Bcrypt from 'bcrypt';
+/// <reference types="node" />
 import * as TypeUtils from '../type-utils';
 export declare const types: {
     postgres: string;
@@ -11,5 +11,5 @@ export declare const types: {
 export type Types = TypeUtils.TsTypes<string, string>;
 type DbWriteType = string;
 export declare const validate: TypeUtils.Validate<Types['Write'], DbWriteType>;
-export declare const compare: typeof Bcrypt.compare;
+export declare const compare: (data: string | Buffer, encrypted: string) => Promise<boolean>;
 export {};

package/out/types/hashed.js.map

@@ -1 +1 @@
-{"version":3,"file":"hashed.js","sourceRoot":"","sources":["../../src/types/hashed.ts"],"names":[],"mappings":";;;AAEA,2CAA2C;AAE3C,IAAI,MAAqB,CAAC;AAC1B,IAAI,CAAC;IACJ,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;AAC5B,CAAC;AAAC,MAAM,CAAC;IACR,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;AAC9B,CAAC;AAEY,QAAA,KAAK,GAAG;IACpB,QAAQ,EAAE,UAAU;IACpB,KAAK,EAAE,UAAU;IACjB,MAAM,EAAE,UAAU;IAClB,KAAK,EAAE;QACN,IAAI,EAAE,YAAY;KAClB;CACD,CAAC;AAKW,QAAA,QAAQ,GACpB,SAAS,CAAC,QAAQ,CAAC,aAAa,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;IAChD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;IACpC,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;AACjC,CAAC,CAAC,CAAC;AAES,QAAA,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC"}
+{"version":3,"file":"hashed.js","sourceRoot":"","sources":["../../src/types/hashed.ts"],"names":[],"mappings":";;;AAEA,2CAA2C;AAE3C,IAAI,MAAqB,CAAC;AAC1B,IAAI,CAAC;IACJ,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;AAC5B,CAAC;AAAC,MAAM,CAAC;IACR,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;AAC9B,CAAC;AAEY,QAAA,KAAK,GAAG;IACpB,QAAQ,EAAE,UAAU;IACpB,KAAK,EAAE,UAAU;IACjB,MAAM,EAAE,UAAU;IAClB,KAAK,EAAE;QACN,IAAI,EAAE,YAAY;KAClB;CACD,CAAC;AAKW,QAAA,QAAQ,GACpB,SAAS,CAAC,QAAQ,CAAC,aAAa,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;IAChD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;IACpC,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;AACjC,CAAC,CAAC,CAAC;AAES,QAAA,OAAO,GAGI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@balena/sbvr-types",
-  "version": "7.1.1",
+  "version": "7.1.2",
   "description": "SBVR type definitions.",
   "main": "out",
   "scripts": {
@@ -51,6 +51,6 @@
     "npm": ">=8.1.0"
   },
   "versionist": {
-    "publishedAt": "2024-06-03T18:07:36.442Z"
+    "publishedAt": "2024-06-12T12:14:00.451Z"
   }
 }

package/src/types/hashed.ts

@@ -30,4 +30,7 @@ export const validate: TypeUtils.Validate<Types['Write'], DbWriteType> =
 		return bcrypt.hash(value, salt);
 	});
 
-export const compare = bcrypt.compare.bind(bcrypt);
+export const compare: (
+	data: string | Buffer,
+	encrypted: string,
+) => Promise<boolean> = bcrypt.compare.bind(bcrypt);