feat(deps): change to stable SDK

Author: vandaeldev

README.md

@@ -20,6 +20,7 @@ On service initialization, it sets up a single connection with the configuration
 |ngx-surreal|Angular |SurrealDB   |
 |-----------|--------|------------|
 |^0.2.1     |>=18.0.0|^1.0.0      |
+|^1.0.0     |>=18.0.0|^2.0.0      |
 
 ## Installation
 
@@ -93,12 +94,23 @@ export class AppModule {}
 The type definition for `SurrealConfig` is as follows:
 
 ```ts
-import type { ConnectionOptions } from 'surrealdb.js';
+import type { Surreal } from 'surrealdb';
 
+export type ConnectionOptions = Parameters<Surreal['connect']>[1];
 export type SurrealConfig = ConnectionOptions & { url: string };
 ```
 
-See for all connection options the [definition for the `ConnectionOptions` type](https://github.com/surrealdb/surrealdb.js/blob/main/src/types.ts#L195).
+The following options are available for configuration:
+
+```ts
+url: string;
+namespace?: string;
+database?: string;
+auth?: AnyAuth | Token;
+prepare?: (connection: Surreal) => unknown;
+versionCheck?: boolean;
+versionCheckTimeout?: number;
+```
 
 ## Usage
 
@@ -158,7 +170,7 @@ export class ExampleComponent implements OnInit {
 }
 ```
 
-See for more examples and all available methods the [SurrealDB JavaScript SDK](https://surrealdb.com/docs/sdk/javascript/setup#sdk-methods).
+See for more examples and all available methods the [SurrealDB JavaScript SDK](https://surrealdb.com/docs/sdk/javascript/core).
 
 ## Links
 

ng-package.json

@@ -4,5 +4,5 @@
   "lib": {
     "entryFile": "src/public-api.ts"
   },
-  "allowedNonPeerDependencies": ["surrealdb.js"]
+  "allowedNonPeerDependencies": ["surrealdb"]
 }

package.json

@@ -1,7 +1,12 @@
 {
   "name": "ngx-surreal",
   "description": "Lightweight Angular wrapper for the SurrealDB JavaScript SDK",
-  "keywords": ["surrealdb", "angular", "database", "client"],
+  "keywords": [
+    "surrealdb",
+    "angular",
+    "database",
+    "client"
+  ],
   "version": "0.1.2",
   "engines": {
     "node": ">=18.0.0"
@@ -21,8 +26,8 @@
     "rxjs": "^7.8.1"
   },
   "dependencies": {
-    "surrealdb.js": "1.0.0-beta.9",
-    "tslib": "^2.3.0"
+    "surrealdb": "^1.0.0",
+    "tslib": "^2.7.0"
   },
   "devDependencies": {
     "rxjs": "^7.8.1"

pnpm-lock.yaml

@@ -1,5 +1,6 @@
-import type { ConnectionOptions, Prettify } from 'surrealdb.js';
+import type { Surreal, Prettify } from 'surrealdb';
 
+export type ConnectionOptions = Parameters<Surreal['connect']>[1];
 export type SurrealConfig = ConnectionOptions & { url: string };
 export type PrettyRecord = Prettify<Record<string, unknown>>;
 

src/lib/surreal.config.ts

@@ -1,8 +1,8 @@
 import { computed, inject, Injectable } from '@angular/core';
 import { from, type Observable } from 'rxjs';
-import { type ActionResult, type Patch, Surreal, type UUID, type RecordId as _RecordId, type StringRecordId, type AnyAuth, type ScopeAuth } from 'surrealdb.js';
-import { SURREAL_CONFIG_TOKEN } from './surreal.module';
+import { type RecordId as _RecordId, type ActionResult, type AnyAuth, type Patch, type ScopeAuth, type StringRecordId, Surreal, type Uuid } from 'surrealdb';
 import type { PrettyRecord, SurrealUseOptions } from './surreal.config';
+import { SURREAL_CONFIG_TOKEN } from './surreal.module';
 
 type RecordId<Tb extends string = string> = _RecordId<Tb> | StringRecordId;
 
@@ -130,7 +130,7 @@ export class SurrealService {
    * @param callback - Callback function that receives updates.
    * @param diff - If set to true, will return a set of patches instead of complete records
    */
-  public live<Result extends Record<string, unknown> | Patch = Record<string, unknown>>(...args: Parameters<Surreal['live']>): Observable<UUID> {
+  public live<Result extends Record<string, unknown> | Patch = Record<string, unknown>>(...args: Parameters<Surreal['live']>): Observable<Uuid> {
     return from(this.db.live<Result>(...args));
   }
 
@@ -260,7 +260,7 @@ export class SurrealService {
    * Stop listening for live query responses for a uuid
    * @param queryUuid - The LQ uuid that you want to stop listening to.
    */
-  public unsubscribeLive<Result extends Record<string, unknown> | Patch = Record<string, unknown>>(queryUuid: UUID) {
+  public unsubscribeLive<Result extends Record<string, unknown> | Patch = Record<string, unknown>>(queryUuid: Uuid) {
     return from(this.db.unSubscribeLive<Result>(queryUuid, () => void 0));
   }
 

src/lib/surreal.service.ts

@@ -1,4 +1,4 @@
 export * from './lib/surreal.module';
 export * from './lib/surreal.service';
 export * from './lib/surreal.config';
-export { RecordId, StringRecordId, PreparedQuery, UUID, Patch, LiveHandler } from 'surrealdb.js';
+export { RecordId, StringRecordId, PreparedQuery, Uuid, Patch, LiveHandler } from 'surrealdb';