v17.1.0

balena-io · Jun 19, 2024 · e43632a · e43632a
1 parent 4eff783
commit e43632a
Show file tree

Hide file tree

Showing 4 changed files with 327 additions and 3 deletions.
diff --git a/.versionbot/CHANGELOG.yml b/.versionbot/CHANGELOG.yml
@@ -1,3 +1,253 @@
+- commits:
+    - subject: Add dev model typings
+      hash: c276ef4fb8482a246c25940d617d76b76847eff8
+      body: ""
+      footer:
+        Change-type: patch
+        change-type: patch
+      author: Pagan Gazzard
+      nested: []
+    - subject: Add migration model typings
+      hash: 561525db0d761c10cc2d98aa7a1a19d221ac7e37
+      body: ""
+      footer:
+        Change-type: patch
+        change-type: patch
+      author: Pagan Gazzard
+      nested: []
+    - subject: Add auth model typings
+      hash: 694aa926c23ea10707c602b5b8ab53520c60c7c5
+      body: ""
+      footer:
+        Change-type: patch
+        change-type: patch
+      author: Pagan Gazzard
+      nested: []
+    - subject: Switch API typings to an interface so it can be overridden/merged
+      hash: 09b0c893ade5c0daacd561a067f43f172380f0bf
+      body: ""
+      footer:
+        Change-type: minor
+        change-type: minor
+      author: Pagan Gazzard
+      nested: []
+    - subject: Allow passing model typings when instantiating an internal pinejs client
+      hash: a77c7d05447dc2f3d4310069f6479f538b3a8f22
+      body: |
+        Update @balena/abstract-sql-compiler from 9.1.4 to 9.2.0
+        Update @balena/abstract-sql-to-typescript 3.1.1 to 3.2.1
+        Update @balena/sbvr-types from 7.1.1 to 7.1.3
+        Update pinejs-client-core from 6.14.6 to 6.15.1
+      footer:
+        Change-type: minor
+        change-type: minor
+      author: Pagan Gazzard
+      nested:
+        - commits:
+            - subject: Adds `EndsWithNode` and `ContainsNode` typings
+              hash: bb2233220c988afaece120ece38e035c8dd14b02
+              body: ""
+              footer:
+                Change-type: minor
+                change-type: minor
+              author: Pagan Gazzard
+              nested: []
+          version: abstract-sql-compiler-9.2.0
+          title: ""
+          date: 2024-06-12T13:14:07.807Z
+        - commits:
+            - subject: Correctly type the `POST` result as being fully deferred
+              hash: 1055a00e740dd2cbf3e418408bed6c5f89b8db0f
+              body: >
+                Previously it did not state so the expanded versions were
+                available in
+
+                the typings even though the result would never actually include
+                them
+              footer:
+                Change-type: patch
+                change-type: patch
+              author: Pagan Gazzard
+              nested: []
+          version: pinejs-client-js-6.15.1
+          title: ""
+          date: 2024-06-17T16:15:56.769Z
+        - commits:
+            - subject: Add support for using model specific typings
+              hash: 1077e19ef18cc4cede4d6401496a016fef459150
+              body: >
+                This requires passing the model typings when creating the
+                pinejs-client
+
+                instance and will mean that any usage after that will be type
+                checked
+
+                to limit to resources/properties that exist on the model. This
+                covers
+
+                almost all usage but there are some cases we cannot cover as we
+                would
+
+                need typescript support for partial inference of generics, eg
+                for
+
+                lambdas, or to make major changes to the querying interface.
+
+                This work should also be fully backwards compatible such that if
+                you do
+
+                not provide model typings then all typings should continue to
+                work as
+
+                previously
+              footer:
+                Change-type: minor
+                change-type: minor
+              author: Pagan Gazzard
+              nested: []
+          version: pinejs-client-js-6.15.0
+          title: ""
+          date: 2024-06-14T10:45:40.382Z
+        - commits:
+            - subject: Deprecate passing `url` to helper functions
+              hash: 5ad1d4a417e2631d70acf7192b7132366a77be3b
+              body: >
+                The intention is that these are use as helpers functions to
+                build the
+
+                url from an object and so passing a `url` directly is not really
+                the
+
+                intent and interferes with improving the typings for the
+                intended case.
+
+                It is still possible to pass urls directly to the `request`
+                function if
+
+                it is essential but the true answer is to support building those
+                urls,
+
+                and using `prepare` if it is necessary
+              footer:
+                Change-type: patch
+                change-type: patch
+              author: Pagan Gazzard
+              nested: []
+          version: pinejs-client-js-6.14.13
+          title: ""
+          date: 2024-06-12T13:09:45.863Z
+        - commits:
+            - subject: Type `upsert` and `getOrCreate` as not accepting a `url`
+              hash: f5261feec2d9fd45bb52885d0aed9482f743df5a
+              body: >
+                This is because they are not designed to support using a `url`
+                and are
+
+                likely to break in very weird and unexpected ways, and as such
+                removing
+
+                it from the typing should reduce potential for surprising errors
+              footer:
+                Change-type: patch
+                change-type: patch
+              author: Pagan Gazzard
+              nested: []
+          version: pinejs-client-js-6.14.12
+          title: ""
+          date: 2024-06-12T11:12:46.444Z
+        - commits:
+            - subject: Include comments in generated output so that jsdoc is available
+              hash: 0a20be620a68b92ef95ce735eeebe3de0d754b7f
+              body: ""
+              footer:
+                Change-type: patch
+                change-type: patch
+              author: Pagan Gazzard
+              nested: []
+          version: pinejs-client-js-6.14.11
+          title: ""
+          date: 2024-06-11T15:00:11.283Z
+        - commits:
+            - subject: "Tests: improve typing of tests"
+              hash: d970b64c9400e11ee55c29f16fe489c45b16a957
+              body: ""
+              footer:
+                Change-type: patch
+                change-type: patch
+              author: Pagan Gazzard
+              nested: []
+          version: pinejs-client-js-6.14.10
+          title: ""
+          date: 2024-06-11T01:32:26.832Z
+        - commits:
+            - subject: Add `$filter` to nested `$count` typings
+              hash: 2774bd0e8b03d6d204df41c2d4ebf3a9d039057e
+              body: ""
+              footer:
+                Change-type: patch
+                change-type: patch
+              author: Pagan Gazzard
+              nested: []
+          version: pinejs-client-js-6.14.9
+          title: ""
+          date: 2024-06-10T15:33:59.941Z
+        - commits:
+            - subject: "Tests: remove unnecessary/unintended returns"
+              hash: b51e379e6a5b1c6cbc5cb83d6dcf537bc6776b05
+              body: ""
+              footer:
+                Change-type: patch
+                change-type: patch
+              author: Pagan Gazzard
+              nested: []
+          version: pinejs-client-js-6.14.8
+          title: ""
+          date: 2024-06-10T13:36:27.251Z
+        - commits:
+            - subject: Fix using top level $count downstream
+              hash: 03553a4d582ac8354bf2adc47fbe63fefb587042
+              body: >
+                It's unclear why this doesn't cause typing issues within
+
+                pinejs-client-core itself but it does fail when using it
+                downstream
+              footer:
+                Change-type: patch
+                change-type: patch
+              author: Pagan Gazzard
+              nested: []
+          version: pinejs-client-js-6.14.7
+          title: ""
+          date: 2024-06-06T13:32:31.757Z
+        - commits:
+            - subject: Add typings for all abstract sql fragments, fixing where necessary
+              hash: b84c335877236e3d389df064b3e7b2acd1a656ae
+              body: ""
+              footer:
+                Change-type: patch
+                change-type: patch
+              author: Pagan Gazzard
+          version: sbvr-types-7.1.3
+          title: ""
+          date: 2024-06-12T21:08:39.814Z
+        - 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: sbvr-types-7.1.2
+          title: ""
+          date: 2024-06-12T12:19:17.354Z
+  version: 17.1.0
+  title: ""
+  date: 2024-06-19T11:03:56.289Z
 - commits:
     - subject: Improve `result` typing for `POSTRUN`/`PRERESPOND` hooks
       hash: adec8e6cfb12d75109627a582c948d6f950d0989

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,80 @@ 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/).
 
+# v17.1.0
+## (2024-06-19)
+
+* Add dev model typings [Pagan Gazzard]
+* Add migration model typings [Pagan Gazzard]
+* Add auth model typings [Pagan Gazzard]
+* Switch API typings to an interface so it can be overridden/merged [Pagan Gazzard]
+
+<details>
+<summary> Allow passing model typings when instantiating an internal pinejs client [Pagan Gazzard] </summary>
+
+> ## abstract-sql-compiler-9.2.0
+> ### (2024-06-12)
+> 
+> * Adds `EndsWithNode` and `ContainsNode` typings [Pagan Gazzard]
+> 
+> ## pinejs-client-js-6.15.1
+> ### (2024-06-17)
+> 
+> * Correctly type the `POST` result as being fully deferred [Pagan Gazzard]
+> 
+> ## pinejs-client-js-6.15.0
+> ### (2024-06-14)
+> 
+> * Add support for using model specific typings [Pagan Gazzard]
+> 
+> ## pinejs-client-js-6.14.13
+> ### (2024-06-12)
+> 
+> * Deprecate passing `url` to helper functions [Pagan Gazzard]
+> 
+> ## pinejs-client-js-6.14.12
+> ### (2024-06-12)
+> 
+> * Type `upsert` and `getOrCreate` as not accepting a `url` [Pagan Gazzard]
+> 
+> ## pinejs-client-js-6.14.11
+> ### (2024-06-11)
+> 
+> * Include comments in generated output so that jsdoc is available [Pagan Gazzard]
+> 
+> ## pinejs-client-js-6.14.10
+> ### (2024-06-11)
+> 
+> * Tests: improve typing of tests [Pagan Gazzard]
+> 
+> ## pinejs-client-js-6.14.9
+> ### (2024-06-10)
+> 
+> * Add `$filter` to nested `$count` typings [Pagan Gazzard]
+> 
+> ## pinejs-client-js-6.14.8
+> ### (2024-06-10)
+> 
+> * Tests: remove unnecessary/unintended returns [Pagan Gazzard]
+> 
+> ## pinejs-client-js-6.14.7
+> ### (2024-06-06)
+> 
+> * Fix using top level $count downstream [Pagan Gazzard]
+> 
+> ## sbvr-types-7.1.3
+> ### (2024-06-12)
+> 
+> * Add typings for all abstract sql fragments, fixing where necessary [Pagan Gazzard]
+> 
+> ## sbvr-types-7.1.2
+> ### (2024-06-12)
+> 
+> * Explicitly type the `compare` function for `hashed` [Pagan Gazzard]
+> 
+
+</details>
+
 # v17.0.3
 ## (2024-06-18)
 

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-17.0.3
+17.1.0
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@balena/pinejs",
-  "version": "17.0.3",
+  "version": "17.1.0",
   "main": "out/server-glue/module",
   "type": "commonjs",
   "repository": "[email protected]:balena-io/pinejs.git",
@@ -146,6 +146,6 @@
     "recursive": true
   },
   "versionist": {
-    "publishedAt": "2024-06-18T17:07:46.898Z"
+    "publishedAt": "2024-06-19T11:03:58.149Z"
   }
 }