From 4055fbda6c7a899ab3c0576a37d55035b2c03691 Mon Sep 17 00:00:00 2001 From: Krishnan Govindraj Date: Mon, 8 Sep 2025 16:25:01 +0200 Subject: [PATCH 1/2] Bump version, prepare release notes --- RELEASE_NOTES_LATEST.md | 105 +++++----------------------------------- VERSION | 2 +- 2 files changed, 14 insertions(+), 93 deletions(-) diff --git a/RELEASE_NOTES_LATEST.md b/RELEASE_NOTES_LATEST.md index d89a055a17..b54b7e85f8 100644 --- a/RELEASE_NOTES_LATEST.md +++ b/RELEASE_NOTES_LATEST.md @@ -9,13 +9,13 @@ Documentation: https://typedb.com/docs/drivers/rust/overview ```sh -cargo add typedb-driver@3.4.4 +cargo add typedb-driver@3.5.0-rc0 ``` ### Java driver -Available through [https://repo.typedb.com](https://cloudsmith.io/~typedb/repos/public-release/packages/detail/maven/typedb-driver/3.4.4/a=noarch;xg=com.typedb/) +Available through [https://repo.typedb.com](https://cloudsmith.io/~typedb/repos/public-release/packages/detail/maven/typedb-driver/3.5.0-rc0/a=noarch;xg=com.typedb/) Documentation: https://typedb.com/docs/drivers/java/overview ```xml @@ -29,7 +29,7 @@ Documentation: https://typedb.com/docs/drivers/java/overview com.typedb typedb-driver - 3.4.4 + 3.5.0-rc0 ``` @@ -41,8 +41,9 @@ Documentation: https://typedb.com/docs/drivers/python/overview Available through https://pypi.org +[//]: # (TODO: Python's RC/Alpha/Beta versions are formatted differently. Don't foget to update manually until we make an automation) ``` -pip install typedb-driver==3.4.4 +pip install typedb-driver==3.5.0-rc0 ``` ### HTTP Typescript driver @@ -53,98 +54,18 @@ NPM package: https://www.npmjs.com/package/typedb-driver-http Documentation: https://typedb.com/docs/drivers/ ``` -npm install typedb-driver-http@3.4.4 +npm install typedb-driver-http@3.5.0-rc0 ``` ## New Features - -- **Typescript HTTP driver** - - Add a relatively slim typescript driver based on our HTTP API, adapted from code used for this purpose in `typedb-studio`. - - This driver is published to `npm` under the name `typedb-driver-http` through the same process as the old `nodejs` driver. - - -- **Typescript HTTP driver docs generation** - - Introduce docs generation for the Typescript HTTP driver, based on the existing strategy for the NodeJS driver. - - We divide the docs into: - - - Connection - - Response - - Concept - - Query Structure - - within each section, static functions are grouped into a specific `Static Functions` section. - - Additionally, `QueryConstraints`, `QueryVertices` in query structure; and `DriverParams` in connection are used as sub-categories (that is, `DriverParams`, `DriverParamsBasic`, and `DriverParamsTranslated` are all grouped under `DriverParams`). - - We also implement functionality for handling: - - type aliases - - indexable properties (e.g. `[varName: string]: Concept`) - - +- **Update the HTTP-TS driver with analyze endpoint response** + Update the HTTP-TS driver with the response structure for the analyze endpoint ## Bugs Fixed - - -## Code Refactors - +- **Fix database importer decoding error** + Stabilize the database import function by eliminating rare decoding errors that could occur during the import of large datasets. All the exported files that the import function could not process are still valid and should be correctly imported after the proposed changes. ## Other Improvements -- **Enforce explicit https addresses for TLS connections** - Drivers return explicit error messages when connection addresses and TLS options are mismatched. TLS connections require addresses to have `https`. Non-TLS connections require addresses not to have `https`. - - -- **Enable TLS by default in Python** - - We want to enable a secure-by-default setting in TypeDB Drivers. In Java and Rust, `DriverOptions` have to be explicitly set, and there are no defaults. However, Python features a disabled TLS default. While this is compatible with TypeDB CE, it's an insecure default & not compatible with TypeDB Cloud without explicitly enabling it. - - Instead, we set the default to TLS being __enabled__ in Python. This means when using an insecure, plaintext connection the user must explicitly set it, and is more likely to become aware of the plaintext communication. - - -- **Ensure PNPM config in CI matches config locally** - - We add an `.npmrc` file to ensure the PNPM config in local machines and CI match so that installation succeeds in CI. - - -- **Install PNPM deps in CI release pipeline** - - The release pipeline in CI now correctly installs PNPM dependencies for the HTTP TS driver. - - -- **Make the HTTP TypeScript driver dual-module (CJS+ESM)** - - The HTTP TypeScript driver is now dual-module, offering both CommonJS and ES Module support. - - -- **Set HTTP Typescript driver dependencies as dev dependencies** - - We set all dependencies of the Typescript HTTP driver as dev dependencies, as they aren't required at runtime. - - -- **Rename docs antora module** - - We rename the docs antora module used to host the generated driver references from `api-ref` to `external-typedb-driver`, to support refactoring in the typedb docs repository. - -- **Revert the HTTP driver to a CommonJS package** - - We convert `typedb-driver-http` back into using `commonjs`. This allows us to also revert `import`/`export` syntax to not require file extensions. - - -- **Correct the package and tsconfig for HTTP driver** - - We fix issues in `package.json` that prevented `typedb-driver-http` from being used correctly - - -- **Fix CircleCI release configuration for HTTP driver** - - We fix a typo that made the CircleCI release configuration invalid. - - -- **Use release version of typedb server artifact** - -- **Update to latest typedb server artifact** - - +- **Fix links** + +- **Update READMEs** diff --git a/VERSION b/VERSION index 5141b615b4..b57944e70d 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -3.4.4 \ No newline at end of file +3.5.0-rc0 \ No newline at end of file From da1f18535323dc840c41606cf9fe530a1cc71907 Mon Sep 17 00:00:00 2001 From: Krishnan Govindraj Date: Mon, 8 Sep 2025 18:16:04 +0200 Subject: [PATCH 2/2] Update release notes with fix for typedb-driver --- RELEASE_NOTES_LATEST.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/RELEASE_NOTES_LATEST.md b/RELEASE_NOTES_LATEST.md index b54b7e85f8..2ce76e93bf 100644 --- a/RELEASE_NOTES_LATEST.md +++ b/RELEASE_NOTES_LATEST.md @@ -41,9 +41,8 @@ Documentation: https://typedb.com/docs/drivers/python/overview Available through https://pypi.org -[//]: # (TODO: Python's RC/Alpha/Beta versions are formatted differently. Don't foget to update manually until we make an automation) ``` -pip install typedb-driver==3.5.0-rc0 +pip install typedb-driver==3.5.0rc0 ``` ### HTTP Typescript driver