DBConnection -> DbConnection + some comments (#137)

clockworklabs · Feb 11, 2025 · 066b92d · 066b92d
1 parent dd34adf
commit 066b92d
Show file tree

Hide file tree

Showing 54 changed files with 268 additions and 250 deletions.
diff --git a/examples/quickstart-chat/src/App.tsx b/examples/quickstart-chat/src/App.tsx
@@ -1,7 +1,7 @@
 import React, { useEffect, useState } from 'react';
 import './App.css';
 import {
-  DBConnection,
+  DbConnection,
   ErrorContext,
   EventContext,
   Message,
@@ -14,7 +14,7 @@ export type PrettyMessage = {
   text: string;
 };
 
-function useMessages(conn: DBConnection | null): Message[] {
+function useMessages(conn: DbConnection | null): Message[] {
   const [messages, setMessages] = useState<Message[]>([]);
 
   useEffect(() => {
@@ -45,7 +45,7 @@ function useMessages(conn: DBConnection | null): Message[] {
   return messages;
 }
 
-function useUsers(conn: DBConnection | null): Map<string, User> {
+function useUsers(conn: DbConnection | null): Map<string, User> {
   const [users, setUsers] = useState<Map<string, User>>(new Map());
 
   useEffect(() => {
@@ -88,10 +88,10 @@ function App() {
   const [newMessage, setNewMessage] = useState('');
   const [connected, setConnected] = useState<boolean>(false);
   const [identity, setIdentity] = useState<Identity | null>(null);
-  const [conn, setConn] = useState<DBConnection | null>(null);
+  const [conn, setConn] = useState<DbConnection | null>(null);
 
   useEffect(() => {
-    const subscribeToQueries = (conn: DBConnection, queries: string[]) => {
+    const subscribeToQueries = (conn: DbConnection, queries: string[]) => {
       let count = 0;
       for (const query of queries) {
         conn
@@ -107,7 +107,7 @@ function App() {
     };
 
     const onConnect = (
-      conn: DBConnection,
+      conn: DbConnection,
       identity: Identity,
       token: string
     ) => {
@@ -135,7 +135,7 @@ function App() {
     };
 
     setConn(
-      DBConnection.builder()
+      DbConnection.builder()
         .withUri('ws://localhost:3000')
         .withModuleName('quickstart-chat')
         .withToken(localStorage.getItem('auth_token') || '')

diff --git a/examples/quickstart-chat/src/module_bindings/identity_connected_reducer.ts b/examples/quickstart-chat/src/module_bindings/identity_connected_reducer.ts
@@ -11,9 +11,9 @@ import {
   BinaryReader,
   BinaryWriter,
   CallReducerFlags,
-  DBConnectionBuilder,
-  DBConnectionImpl,
-  DBContext,
+  DbConnectionBuilder,
+  DbConnectionImpl,
+  DbContext,
   ErrorContextInterface,
   Event,
   EventContextInterface,

diff --git a/examples/quickstart-chat/src/module_bindings/identity_disconnected_reducer.ts b/examples/quickstart-chat/src/module_bindings/identity_disconnected_reducer.ts
@@ -11,9 +11,9 @@ import {
   BinaryReader,
   BinaryWriter,
   CallReducerFlags,
-  DBConnectionBuilder,
-  DBConnectionImpl,
-  DBContext,
+  DbConnectionBuilder,
+  DbConnectionImpl,
+  DbContext,
   ErrorContextInterface,
   Event,
   EventContextInterface,

diff --git a/examples/quickstart-chat/src/module_bindings/index.ts b/examples/quickstart-chat/src/module_bindings/index.ts
@@ -11,9 +11,9 @@ import {
   BinaryReader,
   BinaryWriter,
   CallReducerFlags,
-  DBConnectionBuilder,
-  DBConnectionImpl,
-  DBContext,
+  DbConnectionBuilder,
+  DbConnectionImpl,
+  DbContext,
   ErrorContextInterface,
   Event,
   EventContextInterface,
@@ -81,24 +81,24 @@ const REMOTE_MODULE = {
       argsType: SetName.getTypeScriptAlgebraicType(),
     },
   },
-  // Constructors which are used by the DBConnectionImpl to
+  // Constructors which are used by the DbConnectionImpl to
   // extract type information from the generated RemoteModule.
   //
   // NOTE: This is not strictly necessary for `eventContextConstructor` because
   // all we do is build a TypeScript object which we could have done inside the
   // SDK, but if in the future we wanted to create a class this would be
   // necessary because classes have methods, so we'll keep it.
-  eventContextConstructor: (imp: DBConnectionImpl, event: Event<Reducer>) => {
+  eventContextConstructor: (imp: DbConnectionImpl, event: Event<Reducer>) => {
     return {
-      ...(imp as DBConnection),
+      ...(imp as DbConnection),
       event,
     };
   },
-  dbViewConstructor: (imp: DBConnectionImpl) => {
+  dbViewConstructor: (imp: DbConnectionImpl) => {
     return new RemoteTables(imp);
   },
   reducersConstructor: (
-    imp: DBConnectionImpl,
+    imp: DbConnectionImpl,
     setReducerFlags: SetReducerFlags
   ) => {
     return new RemoteReducers(imp, setReducerFlags);
@@ -118,7 +118,7 @@ export type Reducer =
 
 export class RemoteReducers {
   constructor(
-    private connection: DBConnectionImpl,
+    private connection: DbConnectionImpl,
     private setCallReducerFlags: SetReducerFlags
   ) {}
 
@@ -194,7 +194,7 @@ export class SetReducerFlags {
 }
 
 export class RemoteTables {
-  constructor(private connection: DBConnectionImpl) {}
+  constructor(private connection: DbConnectionImpl) {}
 
   get message(): MessageTableHandle {
     return new MessageTableHandle(
@@ -219,21 +219,21 @@ export class SubscriptionBuilder extends SubscriptionBuilderImpl<
   SetReducerFlags
 > {}
 
-export class DBConnection extends DBConnectionImpl<
+export class DbConnection extends DbConnectionImpl<
   RemoteTables,
   RemoteReducers,
   SetReducerFlags
 > {
-  static builder = (): DBConnectionBuilder<
-    DBConnection,
+  static builder = (): DbConnectionBuilder<
+    DbConnection,
     ErrorContext,
     SubscriptionEventContex
   > => {
-    return new DBConnectionBuilder<
-      DBConnection,
+    return new DbConnectionBuilder<
+      DbConnection,
       ErrorContext,
       SubscriptionEventContex
-    >(REMOTE_MODULE, (imp: DBConnectionImpl) => imp as DBConnection);
+    >(REMOTE_MODULE, (imp: DbConnectionImpl) => imp as DbConnection);
   };
   subscriptionBuilder = (): SubscriptionBuilder => {
     return new SubscriptionBuilder(this);

diff --git a/examples/quickstart-chat/src/module_bindings/message_table.ts b/examples/quickstart-chat/src/module_bindings/message_table.ts
@@ -11,9 +11,9 @@ import {
   BinaryReader,
   BinaryWriter,
   CallReducerFlags,
-  DBConnectionBuilder,
-  DBConnectionImpl,
-  DBContext,
+  DbConnectionBuilder,
+  DbConnectionImpl,
+  DbContext,
   ErrorContextInterface,
   Event,
   EventContextInterface,

diff --git a/examples/quickstart-chat/src/module_bindings/message_type.ts b/examples/quickstart-chat/src/module_bindings/message_type.ts
@@ -11,9 +11,9 @@ import {
   BinaryReader,
   BinaryWriter,
   CallReducerFlags,
-  DBConnectionBuilder,
-  DBConnectionImpl,
-  DBContext,
+  DbConnectionBuilder,
+  DbConnectionImpl,
+  DbContext,
   ErrorContextInterface,
   Event,
   EventContextInterface,

diff --git a/examples/quickstart-chat/src/module_bindings/send_message_reducer.ts b/examples/quickstart-chat/src/module_bindings/send_message_reducer.ts
@@ -11,9 +11,9 @@ import {
   BinaryReader,
   BinaryWriter,
   CallReducerFlags,
-  DBConnectionBuilder,
-  DBConnectionImpl,
-  DBContext,
+  DbConnectionBuilder,
+  DbConnectionImpl,
+  DbContext,
   ErrorContextInterface,
   Event,
   EventContextInterface,

diff --git a/examples/quickstart-chat/src/module_bindings/set_name_reducer.ts b/examples/quickstart-chat/src/module_bindings/set_name_reducer.ts
@@ -11,9 +11,9 @@ import {
   BinaryReader,
   BinaryWriter,
   CallReducerFlags,
-  DBConnectionBuilder,
-  DBConnectionImpl,
-  DBContext,
+  DbConnectionBuilder,
+  DbConnectionImpl,
+  DbContext,
   ErrorContextInterface,
   Event,
   EventContextInterface,

diff --git a/examples/quickstart-chat/src/module_bindings/user_table.ts b/examples/quickstart-chat/src/module_bindings/user_table.ts
@@ -11,9 +11,9 @@ import {
   BinaryReader,
   BinaryWriter,
   CallReducerFlags,
-  DBConnectionBuilder,
-  DBConnectionImpl,
-  DBContext,
+  DbConnectionBuilder,
+  DbConnectionImpl,
+  DbContext,
   ErrorContextInterface,
   Event,
   EventContextInterface,

diff --git a/examples/quickstart-chat/src/module_bindings/user_type.ts b/examples/quickstart-chat/src/module_bindings/user_type.ts
@@ -11,9 +11,9 @@ import {
   BinaryReader,
   BinaryWriter,
   CallReducerFlags,
-  DBConnectionBuilder,
-  DBConnectionImpl,
-  DBContext,
+  DbConnectionBuilder,
+  DbConnectionImpl,
+  DbContext,
   ErrorContextInterface,
   Event,
   EventContextInterface,

diff --git a/packages/sdk/README.md b/packages/sdk/README.md
@@ -23,9 +23,9 @@ You can use the package in the browser, using a bundler like vite/parcel/rsbuild
 In order to connect to a database you have to generate module bindings for your database.
 
 ```ts
-import { DBConnection } from './module_bindings';
+import { DbConnection } from './module_bindings';
 
-const connection = DBConnection.builder()
+const connection = DbConnection.builder()
   .withUri('ws://localhost:3000')
   .withModuleName('MODULE_NAME')
   .onDisconnect(() => {

diff --git a/packages/sdk/src/client_api/bsatn_row_list_type.ts b/packages/sdk/src/client_api/bsatn_row_list_type.ts
@@ -11,9 +11,9 @@ import {
   BinaryWriter,
   CallReducerFlags,
   ConnectionId,
-  DBConnectionBuilder,
-  DBConnectionImpl,
-  DBContext,
+  DbConnectionBuilder,
+  DbConnectionImpl,
+  DbContext,
   ErrorContextInterface,
   Event,
   EventContextInterface,

diff --git a/packages/sdk/src/client_api/call_reducer_type.ts b/packages/sdk/src/client_api/call_reducer_type.ts
@@ -11,9 +11,9 @@ import {
   BinaryWriter,
   CallReducerFlags,
   ConnectionId,
-  DBConnectionBuilder,
-  DBConnectionImpl,
-  DBContext,
+  DbConnectionBuilder,
+  DbConnectionImpl,
+  DbContext,
   ErrorContextInterface,
   Event,
   EventContextInterface,

diff --git a/packages/sdk/src/client_api/client_message_type.ts b/packages/sdk/src/client_api/client_message_type.ts
@@ -11,9 +11,9 @@ import {
   BinaryWriter,
   CallReducerFlags,
   ConnectionId,
-  DBConnectionBuilder,
-  DBConnectionImpl,
-  DBContext,
+  DbConnectionBuilder,
+  DbConnectionImpl,
+  DbContext,
   ErrorContextInterface,
   Event,
   EventContextInterface,

diff --git a/packages/sdk/src/client_api/compressable_query_update_type.ts b/packages/sdk/src/client_api/compressable_query_update_type.ts
@@ -11,9 +11,9 @@ import {
   BinaryWriter,
   CallReducerFlags,
   ConnectionId,
-  DBConnectionBuilder,
-  DBConnectionImpl,
-  DBContext,
+  DbConnectionBuilder,
+  DbConnectionImpl,
+  DbContext,
   ErrorContextInterface,
   Event,
   EventContextInterface,

diff --git a/packages/sdk/src/client_api/database_update_type.ts b/packages/sdk/src/client_api/database_update_type.ts
@@ -11,9 +11,9 @@ import {
   BinaryWriter,
   CallReducerFlags,
   ConnectionId,
-  DBConnectionBuilder,
-  DBConnectionImpl,
-  DBContext,
+  DbConnectionBuilder,
+  DbConnectionImpl,
+  DbContext,
   ErrorContextInterface,
   Event,
   EventContextInterface,

diff --git a/packages/sdk/src/client_api/energy_quanta_type.ts b/packages/sdk/src/client_api/energy_quanta_type.ts
@@ -11,9 +11,9 @@ import {
   BinaryWriter,
   CallReducerFlags,
   ConnectionId,
-  DBConnectionBuilder,
-  DBConnectionImpl,
-  DBContext,
+  DbConnectionBuilder,
+  DbConnectionImpl,
+  DbContext,
   ErrorContextInterface,
   Event,
   EventContextInterface,

diff --git a/packages/sdk/src/client_api/identity_token_type.ts b/packages/sdk/src/client_api/identity_token_type.ts
@@ -11,9 +11,9 @@ import {
   BinaryWriter,
   CallReducerFlags,
   ConnectionId,
-  DBConnectionBuilder,
-  DBConnectionImpl,
-  DBContext,
+  DbConnectionBuilder,
+  DbConnectionImpl,
+  DbContext,
   ErrorContextInterface,
   Event,
   EventContextInterface,