Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions crates/bindings-typescript/src/react/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@ export * from './SpacetimeDBProvider.ts';
export { useSpacetimeDB } from './useSpacetimeDB.ts';
export { useTable } from './useTable.ts';
export { useReducer } from './useReducer.ts';
export { useProcedure } from './useProcedure.ts';
60 changes: 60 additions & 0 deletions crates/bindings-typescript/src/react/useProcedure.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
import { useCallback, useEffect, useRef } from 'react';
import type { UntypedProcedureDef } from '../sdk/procedures';
import { useSpacetimeDB } from './useSpacetimeDB';
import type {
ProcedureParamsType,
ProcedureReturnType,
} from '../sdk/type_utils';

export function useProcedure<ProcedureDef extends UntypedProcedureDef>(
procedureDef: ProcedureDef
): (
...params: ProcedureParamsType<ProcedureDef>
) => Promise<ProcedureReturnType<ProcedureDef>> {
const { getConnection, isActive } = useSpacetimeDB();
const procedureName = procedureDef.accessorName;

// Holds calls made before the connection exists
const queueRef = useRef<
{
params: ProcedureParamsType<ProcedureDef>;
resolve: (val: any) => void;
reject: (err: unknown) => void;
}[]
>([]);

// Flush when we finally have a connection
useEffect(() => {
const conn = getConnection();
if (!conn) {
return;
}
const fn = (conn.procedures as any)[procedureName] as (
...p: ProcedureParamsType<ProcedureDef>
) => Promise<ProcedureReturnType<ProcedureDef>>;
if (queueRef.current.length) {
const pending = queueRef.current.splice(0);
for (const item of pending) {
fn(...item.params).then(item.resolve, item.reject);
}
}
}, [getConnection, procedureName, isActive]);

return useCallback(
(...params: ProcedureParamsType<ProcedureDef>) => {
const conn = getConnection();
if (!conn) {
return new Promise<ProcedureReturnType<ProcedureDef>>(
(resolve, reject) => {
queueRef.current.push({ params, resolve, reject });
}
);
}
const fn = (conn.procedures as any)[procedureName] as (
...p: ProcedureParamsType<ProcedureDef>
) => Promise<ProcedureReturnType<ProcedureDef>>;
return fn(...params);
},
[getConnection, procedureName]
);
}
11 changes: 10 additions & 1 deletion crates/bindings-typescript/src/sdk/type_utils.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import type { InferTypeOfRow } from '.';
import type { Infer, InferTypeOfRow } from '.';
import type { Prettify } from '../lib/type_util';
import type { UntypedProcedureDef } from './procedures';
import type { UntypedReducerDef } from './reducers';

export type IsEmptyObject<T> = [keyof T] extends [never] ? true : false;
Expand All @@ -8,3 +9,11 @@ export type MaybeParams<T> = IsEmptyObject<T> extends true ? [] : [params: T];
export type ParamsType<R extends UntypedReducerDef> = MaybeParams<
Prettify<InferTypeOfRow<R['params']>>
>;

export type ProcedureParamsType<P extends UntypedProcedureDef> = MaybeParams<
Prettify<InferTypeOfRow<P['params']>>
>;

export type ProcedureReturnType<P extends UntypedProcedureDef> = Infer<
P['returnType']
>;
6 changes: 6 additions & 0 deletions crates/codegen/src/typescript.rs
Original file line number Diff line number Diff line change
Expand Up @@ -295,6 +295,12 @@ impl Lang for TypeScript {
out,
"export const reducers = __convertToAccessorMap(reducersSchema.reducersType.reducers);"
);
writeln!(out);
writeln!(out, "/** The procedures available in this remote SpacetimeDB module. */");
writeln!(
out,
"export const procedures = __convertToAccessorMap(proceduresSchema.procedures);"
);

// Write type aliases for EventContext, ReducerEventContext, SubscriptionEventContext, ErrorContext
writeln!(out);
Expand Down