Merge remote-tracking branch 'origin/release_4.5'

Author: kriszyp

docs/SUMMARY.md

@@ -26,7 +26,6 @@
   * [Users and Roles](developers/operations-api/users-and-roles.md)
   * [Clustering](developers/operations-api/clustering.md)
     * [Clustering with NATS](developers/operations-api/clustering-nats.md)
-  * [Custom Functions](developers/operations-api/custom-functions.md)
   * [Components](developers/operations-api/components.md)
   * [Registration](developers/operations-api/registration.md)
   * [Jobs](developers/operations-api/jobs.md)
@@ -122,9 +121,18 @@
   * [Resource Class](technical-details/reference/resource.md)
   * [Transactions](technical-details/reference/transactions.md)
   * [Storage Algorithm](technical-details/reference/storage-algorithm.md)
+  * [Blob](technical-details/reference/blob.md)
 * [Release Notes](technical-details/release-notes/README.md)
   * [Harper Tucker (Version 4)](technical-details/release-notes/4.tucker/README.md)
     * [4.6.0](technical-details/release-notes/4.tucker/4.6.0.md)
+    * [4.5.10](technical-details/release-notes/4.tucker/4.5.10.md)
+    * [4.5.9](technical-details/release-notes/4.tucker/4.5.9.md)
+    * [4.5.8](technical-details/release-notes/4.tucker/4.5.8.md)
+    * [4.5.7](technical-details/release-notes/4.tucker/4.5.7.md)
+    * [4.5.6](technical-details/release-notes/4.tucker/4.5.6.md)
+    * [4.5.5](technical-details/release-notes/4.tucker/4.5.5.md)
+    * [4.5.4](technical-details/release-notes/4.tucker/4.5.4.md)
+    * [4.5.3](technical-details/release-notes/4.tucker/4.5.3.md)
     * [4.5.2](technical-details/release-notes/4.tucker/4.5.2.md)
     * [4.5.1](technical-details/release-notes/4.tucker/4.5.1.md)
     * [4.5.0](technical-details/release-notes/4.tucker/4.5.0.md)

docs/developers/applications/defining-schemas.md

@@ -41,6 +41,8 @@ By default the table name is inherited from the type name (in this case the tabl
 * `@table(expiration: 3600)` - Sets an expiration time on entries in the table before they are automatically cleared (primarily useful for caching tables). This is specified in seconds.
 * `@table(audit: true)` - This enables the audit log for the table so that a history of record changes are recorded. This defaults to [configuration file's setting for `auditLog`](../../deployments/configuration.md#logging).
 
+Database naming: the default "data" database is generally a good default choice for tables in applications that will not be reused in other applications (and don't need to worry about staying in a separate namespace). Application with many tables may wish to organize the tables into separate databases (but remember that transactions do not preserve atomicity across different databases, only across tables in the same database). For components that are designed for re-use, it is recommended that you use a database name that is specific to the component (e.g. "my-component-data") to avoid name collisions with other components.
+
 #### `@export`
 
 This indicates that the specified table should be exported as a resource that is accessible as an externally available endpoints, through REST, MQTT, or any of the external resource APIs.

docs/developers/operations-api/custom-functions.md

@@ -1,5 +1,7 @@
 # Custom Functions
 
+*These operations are deprecated.*
+
 ## Custom Functions Status
 
 Returns the state of the Custom functions server. This includes whether it is enabled, upon which port it is listening, and where its root project directory is located on the host machine.

docs/technical-details/reference/blob.md

@@ -1,4 +1,6 @@
-Blobs are binary large objects that can used to store any type of unstructured/binary data and is designed for large content. Blobs support streaming and feature better performance for content larger than about 20KB. Blobs are built off the native JavaScript `Blob` type, and HarperDB extends the native `Blob` type for integrated storage with the database. To use blobs, you would generally want to declare a field as a `Blob` type in your schema:
+# Blob
+
+Blobs are binary large objects that can be used to store any type of unstructured/binary data and is designed for large content. Blobs support streaming and feature better performance for content larger than about 20KB. Blobs are built off the native JavaScript `Blob` type, and HarperDB extends the native `Blob` type for integrated storage with the database. To use blobs, you would generally want to declare a field as a `Blob` type in your schema:
 ```graphql
 type MyTable {
 	id: Any! @primaryKey
@@ -91,4 +93,4 @@ if (blob.size === undefined) {
 
 ```
 
-See the [configuration](../../deployments/configuration.md) documentation for more information on configuring where blob are stored. 
+See the [configuration](../../deployments/configuration.md) documentation for more information on configuring where blob are stored. 

docs/technical-details/reference/globals.md

@@ -262,4 +262,24 @@ This records the provided value as a metric into Harper's analytics. Harper effi
 This returns the user object with permissions/authorization information based on the provided username. This does not verify the password, so it is generally used for looking up users by username. If you want to verify a user by password, use [`server.authenticateUser`](globals.md#serverauthenticateuserusername-password-user).
 
 ### `server.authenticateUser(username, password): Promise<User>`
-This returns the user object with permissions/authorization information based on the provided username. The password will be verified before returning the user object (if the password is incorrect, an error will be thrown).
+This returns the user object with permissions/authorization information based on the provided username. The password will be verified before returning the user object (if the password is incorrect, an error will be thrown).
+
+### `server.resources: Resources`
+This provides access to the map of all registered resources. This is the central registry in Harper for registering any resources to be exported for use by REST, MQTT, or other components. Components that want to register resources should use the `server.resources.set(name, resource)` method to add to this map. Exported resources can be found by passing in a path to `server.resources.getMatch(path)` which will find any resource that matches the path or beginning of the path.
+
+#### `server.resources.set(name, resource, exportTypes?)`
+Register a resource with the server. For example:
+```
+class NewResource extends Resource {
+}
+server.resources.set('NewResource', Resource);
+// or limit usage:
+server.resources.set('NewResource', Resource, { rest: true, mqtt: false, 'my-protocol': true });
+```
+#### `server.resources.getMatch(path, exportType?)`
+Find a resource that matches the path. For example:
+```
+server.resources.getMatch('/NewResource/some-id');
+// or specify the export/protocol type, to allow it to be limited:
+server.resources.getMatch('/NewResource/some-id', 'my-protocol');
+```

docs/technical-details/reference/resource.md

@@ -178,7 +178,7 @@ This is called by the default `put` and `patch` handlers to update a record. `pu
 
 ### `delete(queryOrProperty?): Resource|void|Response`
 
-This will delete this record or resource, and is called for HTTP DELETE requests. You can define or override this method to define how records should be deleted. The default `delete` method on tables (`super.put(record)`) deletes the record from the table as part of the current transaction.
+This will delete this record or resource, and is called for HTTP DELETE requests. You can define or override this method to define how records should be deleted. The default `delete` method on tables (`super.delete(record)`) deletes the record from the table as part of the current transaction.
 
 ### `publish(message): Resource|void|Response`
 

docs/technical-details/release-notes/4.tucker/4.5.0.md

@@ -67,4 +67,7 @@ Glob file handling for specifying files used by components has been improved for
 ### Table.getRecordCount
 `Table.getRecordCount()` is now available to get the number of records in a table.
 
+### Removal of record counts from REST API
+Previously the root path for a resource in the REST API would return a record count. However, this is a significant performance hazard and was never documented to exist, so this has been removed to ensure better performance and reliability.
+
 Note that downgrading from 4.5 to 4.4 is *not* supported.

docs/technical-details/release-notes/4.tucker/4.5.10.md

@@ -0,0 +1,5 @@
+### HarperDB 4.5.10
+5/20/2025
+
+* Expose the `resources` map for being able to set and access custom resources
+* Fix for cleaning up blob files that are used when a database is deleted

docs/technical-details/release-notes/4.tucker/4.5.3.md

@@ -0,0 +1,5 @@
+### HarperDB 4.5.3
+4/3/2025
+
+* Fix for immediately reloading updated certificates and private key files to ensure that certificates properly match the private key
+* Fix for analytics of storage size when tables are deleted

docs/technical-details/release-notes/4.tucker/4.5.4.md

@@ -0,0 +1,6 @@
+### HarperDB 4.5.4
+4/11/2025
+
+* Fix for replication of (non-retained) published messages
+* Make cookie domain be configurable to allow for cookies shared across sub-hostnames
+* Fix for on-demand loading of shared blobs