Skip to content

Commit e4c3eaa

Browse files
Prepare release 3.5.0-rc0 (#785)
## Usage and product changes Bump version, prepare release notes
1 parent 281a8aa commit e4c3eaa

File tree

2 files changed

+13
-93
lines changed

2 files changed

+13
-93
lines changed

RELEASE_NOTES_LATEST.md

Lines changed: 12 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ Documentation: https://typedb.com/docs/drivers/rust/overview
99

1010

1111
```sh
12-
cargo add typedb-driver@3.4.4
12+
cargo add typedb-driver@3.5.0-rc0
1313
```
1414

1515

1616
### Java driver
1717

18-
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/)
18+
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/)
1919
Documentation: https://typedb.com/docs/drivers/java/overview
2020

2121
```xml
@@ -29,7 +29,7 @@ Documentation: https://typedb.com/docs/drivers/java/overview
2929
<dependency>
3030
<groupid>com.typedb</groupid>
3131
<artifactid>typedb-driver</artifactid>
32-
<version>3.4.4</version>
32+
<version>3.5.0-rc0</version>
3333
</dependency>
3434
</dependencies>
3535
```
@@ -42,7 +42,7 @@ Documentation: https://typedb.com/docs/drivers/python/overview
4242
Available through https://pypi.org
4343

4444
```
45-
pip install typedb-driver==3.4.4
45+
pip install typedb-driver==3.5.0rc0
4646
```
4747

4848
### HTTP Typescript driver
@@ -53,98 +53,18 @@ NPM package: https://www.npmjs.com/package/typedb-driver-http
5353
Documentation: https://typedb.com/docs/drivers/
5454

5555
```
56-
npm install typedb-driver-http@3.4.4
56+
npm install typedb-driver-http@3.5.0-rc0
5757
```
5858

5959
## New Features
60-
61-
- **Typescript HTTP driver**
62-
63-
Add a relatively slim typescript driver based on our HTTP API, adapted from code used for this purpose in `typedb-studio`.
64-
65-
This driver is published to `npm` under the name `typedb-driver-http` through the same process as the old `nodejs` driver.
66-
67-
68-
- **Typescript HTTP driver docs generation**
69-
70-
Introduce docs generation for the Typescript HTTP driver, based on the existing strategy for the NodeJS driver.
71-
72-
We divide the docs into:
73-
74-
- Connection
75-
- Response
76-
- Concept
77-
- Query Structure
78-
79-
within each section, static functions are grouped into a specific `Static Functions` section.
80-
81-
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`).
82-
83-
We also implement functionality for handling:
84-
- type aliases
85-
- indexable properties (e.g. `[varName: string]: Concept`)
86-
87-
60+
- **Update the HTTP-TS driver with analyze endpoint response**
61+
Update the HTTP-TS driver with the response structure for the analyze endpoint
8862

8963
## Bugs Fixed
90-
91-
92-
## Code Refactors
93-
64+
- **Fix database importer decoding error**
65+
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.
9466

9567
## Other Improvements
96-
- **Enforce explicit https addresses for TLS connections**
97-
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`.
98-
99-
100-
- **Enable TLS by default in Python**
101-
102-
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.
103-
104-
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.
105-
106-
107-
- **Ensure PNPM config in CI matches config locally**
108-
109-
We add an `.npmrc` file to ensure the PNPM config in local machines and CI match so that installation succeeds in CI.
110-
111-
112-
- **Install PNPM deps in CI release pipeline**
113-
114-
The release pipeline in CI now correctly installs PNPM dependencies for the HTTP TS driver.
115-
116-
117-
- **Make the HTTP TypeScript driver dual-module (CJS+ESM)**
118-
119-
The HTTP TypeScript driver is now dual-module, offering both CommonJS and ES Module support.
120-
121-
122-
- **Set HTTP Typescript driver dependencies as dev dependencies**
123-
124-
We set all dependencies of the Typescript HTTP driver as dev dependencies, as they aren't required at runtime.
125-
126-
127-
- **Rename docs antora module**
128-
129-
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.
130-
131-
- **Revert the HTTP driver to a CommonJS package**
132-
133-
We convert `typedb-driver-http` back into using `commonjs`. This allows us to also revert `import`/`export` syntax to not require file extensions.
134-
135-
136-
- **Correct the package and tsconfig for HTTP driver**
137-
138-
We fix issues in `package.json` that prevented `typedb-driver-http` from being used correctly
139-
140-
141-
- **Fix CircleCI release configuration for HTTP driver**
142-
143-
We fix a typo that made the CircleCI release configuration invalid.
144-
145-
146-
- **Use release version of typedb server artifact**
147-
148-
- **Update to latest typedb server artifact**
149-
150-
68+
- **Fix links**
69+
70+
- **Update READMEs**

VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
3.4.4
1+
3.5.0-rc0

0 commit comments

Comments
 (0)