@rolder-kit/surreal-db 0.1.0-alpha.0

package/dist/deserialize.d.ts

@@ -0,0 +1,17 @@
+import { RecordId } from 'surrealdb';
+/**
+ * Type that converts specified string paths to RecordId, others stay as their original types
+ */
+type DeserializeResult<T, IdPaths extends string = never> = T extends string ? RecordId<string> : T extends (infer U)[] ? U extends object ? {
+    [K in keyof U]: K extends IdPaths ? RecordId<string> : U[K];
+}[] : DeserializeResult<U, IdPaths>[] : T extends object ? T extends Date ? T : {
+    [K in keyof T]: K extends IdPaths ? RecordId<string> : T[K];
+} : T;
+/**
+ * Deserializes DTO back to SurrealDB Record recursively based on specified ID paths
+ */
+export declare function deserialize<T, K extends keyof T & string>(dto: T[], idPaths: K[]): DeserializeResult<T, K>[];
+export declare function deserialize<T, K extends keyof T & string>(dto: T, idPaths: K[]): DeserializeResult<T, K>;
+export declare function deserialize<T>(dto: T[]): DeserializeResult<T>[];
+export declare function deserialize<T>(dto: T): DeserializeResult<T>;
+export {};

package/dist/deserialize.js

@@ -0,0 +1,46 @@
+import { RecordId } from "surrealdb";
+const extractTableName = (str)=>{
+    const match = str.match(/^([^:]+):/);
+    return match ? match[1] : null;
+};
+const isRecordIdFormat = (str)=>/^[^:]+:.+$/.test(str);
+function deserialize(dto, idPaths) {
+    if (Array.isArray(dto)) return dto.map((item)=>convertStringsToRecordIds(item, idPaths || []));
+    return convertStringsToRecordIds(dto, idPaths || []);
+}
+const convertStringsToRecordIds = (obj, idPaths, currentPath = '')=>{
+    if (null == obj) return obj;
+    if (Array.isArray(obj)) {
+        if (idPaths.includes(currentPath)) return obj.map((item)=>{
+            if ('string' == typeof item && isRecordIdFormat(item)) {
+                const tableName = extractTableName(item);
+                if (tableName) return new RecordId(tableName, item.split(':')[1]);
+            }
+            return item;
+        });
+        return obj.map((item, index)=>convertStringsToRecordIds(item, idPaths, `${currentPath}[${index}]`));
+    }
+    if ('object' == typeof obj && !(obj instanceof Date)) {
+        const result = {};
+        for (const [key, value] of Object.entries(obj)){
+            const fieldPath = currentPath ? `${currentPath}.${key}` : key;
+            if ('string' == typeof value) {
+                const shouldConvert = idPaths.includes(fieldPath) && isRecordIdFormat(value);
+                if (shouldConvert) {
+                    const tableName = extractTableName(value);
+                    if (tableName) result[key] = new RecordId(tableName, value.split(':')[1]);
+                    else result[key] = value;
+                } else result[key] = value;
+            } else result[key] = convertStringsToRecordIds(value, idPaths, fieldPath);
+        }
+        return result;
+    }
+    if ('string' == typeof obj) {
+        if (0 === idPaths.length && isRecordIdFormat(obj)) {
+            const tableName = extractTableName(obj);
+            if (tableName) return new RecordId(tableName, obj.split(':')[1]);
+        }
+    }
+    return obj;
+};
+export { deserialize };

package/dist/getAuthedDBSession.d.ts

@@ -0,0 +1,5 @@
+import type { SurrealSession } from 'surrealdb';
+import type { SurrealDBProps } from './types';
+export declare const getAuthedDBSession: (user: {
+    id: string;
+}, token: string, surrealDBProps?: SurrealDBProps) => Promise<SurrealSession>;

package/dist/getAuthedDBSession.js

@@ -0,0 +1,13 @@
+import { getDBInstance } from "./getDBInstance.js";
+const sessions = new Map();
+const getAuthedDBSession = async (user, token, surrealDBProps = {})=>{
+    const db = await getDBInstance(surrealDBProps);
+    if (sessions.has(user.id)) return sessions.get(user.id);
+    {
+        const dbSession = await db.newSession();
+        sessions.set(user.id, dbSession);
+        await dbSession.authenticate(token);
+        return dbSession;
+    }
+};
+export { getAuthedDBSession };

package/dist/getDBInstance.d.ts

@@ -0,0 +1,3 @@
+import { Surreal } from 'surrealdb';
+import type { SurrealDBProps } from './types';
+export declare const getDBInstance: (params?: SurrealDBProps | undefined) => Promise<Surreal>;

package/dist/getDBInstance.js

@@ -0,0 +1,30 @@
+import { Surreal, applyDiagnostics, createRemoteEngines } from "surrealdb";
+let db = null;
+const getDBInstance = async (params = {})=>{
+    if (db?.isConnected) return db;
+    const instance = new Surreal(params.debug ? {
+        engines: applyDiagnostics(createRemoteEngines(), (event)=>{
+            console.log('Surreal debug:', event);
+        })
+    } : void 0);
+    try {
+        const url = params.url || process.env.SURREALDB_URL;
+        if (!url) throw new Error('Missing required SurrealDB URL');
+        const namespace = params.namespace || process.env.SURREALDB_NAMESPACE;
+        if (!namespace) throw new Error('Missing required SurrealDB namespace');
+        const database = params.database || process.env.SURREALDB_DATABASE;
+        if (!database) throw new Error('Missing required SurrealDB database');
+        await instance.connect(url);
+        await instance.use({
+            namespace,
+            database
+        });
+        db = instance;
+        return instance;
+    } catch (error) {
+        console.error('Failed to connect to SurrealDB:', error);
+        db = null;
+        throw error;
+    }
+};
+export { getDBInstance };

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * from 'surrealdb';
+export * from './deserialize';
+export * from './getAuthedDBSession';
+export * from './getDBInstance';
+export * from './types';

package/dist/index.js

@@ -0,0 +1,5 @@
+export * from "surrealdb";
+export * from "./deserialize.js";
+export * from "./getAuthedDBSession.js";
+export * from "./getDBInstance.js";
+export * from "./types.js";

package/dist/types.d.ts

@@ -0,0 +1,10 @@
+import type { CodecOptions } from 'surrealdb';
+export interface SurrealDBProps {
+    url?: string;
+    namespace?: string;
+    database?: string;
+    username?: string;
+    password?: string;
+    codecOptions?: CodecOptions;
+    debug?: boolean;
+}

package/package.json

@@ -0,0 +1,24 @@
+{
+	"name": "@rolder-kit/surreal-db",
+	"version": "0.1.0-alpha.0",
+	"type": "module",
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"import": "./dist/index.js"
+		}
+	},
+	"sideEffects": false,
+	"files": [
+		"dist"
+	],
+	"scripts": {
+		"build": "rslib build",
+		"dev": "rslib build --watch",
+		"prepublishOnly": "bun run build",
+		"check": "biome check --write && tsc --noEmit"
+	},
+	"dependencies": {
+		"surrealdb": "^2.0.0-alpha.18"
+	}
+}