Specify the name of a view in an options object

Author: coolreader18

crates/bindings-typescript/src/server/schema.ts

@@ -26,6 +26,7 @@ import {
   defineView,
   type AnonymousViewFn,
   type ViewFn,
+  type ViewOpts,
   type ViewReturnTypeBuilder,
 } from './views';
 
@@ -282,27 +283,27 @@ class Schema<S extends UntypedSchemaDef> {
   }
 
   view<Ret extends ViewReturnTypeBuilder>(
-    name: string,
+    opts: ViewOpts,
     ret: Ret,
     fn: ViewFn<S, {}, Ret>
   ): void {
-    defineView(name, false, {}, ret, fn);
+    defineView(opts, false, {}, ret, fn);
   }
 
   // TODO: re-enable once parameterized views are supported in SQL
   // view<Ret extends ViewReturnTypeBuilder>(
-  //   name: string,
+  //   opts: ViewOpts,
   //   ret: Ret,
   //   fn: ViewFn<S, {}, Ret>
   // ): void;
   // view<Params extends ParamsObj, Ret extends ViewReturnTypeBuilder>(
-  //   name: string,
+  //   opts: ViewOpts,
   //   params: Params,
   //   ret: Ret,
   //   fn: ViewFn<S, {}, Ret>
   // ): void;
   // view<Params extends ParamsObj, Ret extends ViewReturnTypeBuilder>(
-  //   name: string,
+  //   opts: ViewOpts,
   //   paramsOrRet: Ret | Params,
   //   retOrFn: ViewFn<S, {}, Ret> | Ret,
   //   maybeFn?: ViewFn<S, Params, Ret>
@@ -315,27 +316,27 @@ class Schema<S extends UntypedSchemaDef> {
   // }
 
   anyonymousView<Ret extends ViewReturnTypeBuilder>(
-    name: string,
+    opts: ViewOpts,
     ret: Ret,
     fn: AnonymousViewFn<S, {}, Ret>
   ): void {
-    defineView(name, true, {}, ret, fn);
+    defineView(opts, true, {}, ret, fn);
   }
 
   // TODO: re-enable once parameterized views are supported in SQL
   // anyonymousView<Ret extends ViewReturnTypeBuilder>(
-  //   name: string,
+  //   opts: ViewOpts,
   //   ret: Ret,
   //   fn: AnonymousViewFn<S, {}, Ret>
   // ): void;
   // anyonymousView<Params extends ParamsObj, Ret extends ViewReturnTypeBuilder>(
-  //   name: string,
+  //   opts: ViewOpts,
   //   params: Params,
   //   ret: Ret,
   //   fn: AnonymousViewFn<S, {}, Ret>
   // ): void;
   // anyonymousView<Params extends ParamsObj, Ret extends ViewReturnTypeBuilder>(
-  //   name: string,
+  //   opts: ViewOpts,
   //   paramsOrRet: Ret | Params,
   //   retOrFn: AnonymousViewFn<S, {}, Ret> | Ret,
   //   maybeFn?: AnonymousViewFn<S, Params, Ret>

crates/bindings-typescript/src/server/views.ts

@@ -24,6 +24,11 @@ export type ReadonlyDbView<SchemaDef extends UntypedSchemaDef> = {
   readonly [Tbl in SchemaDef['tables'][number] as Tbl['name']]: ReadonlyTable<Tbl>;
 };
 
+export type ViewOpts = {
+  name: string;
+  public: true;
+};
+
 export type ViewFn<
   S extends UntypedSchemaDef,
   Params extends ParamsObj,
@@ -52,7 +57,7 @@ export function defineView<
   Params extends ParamsObj,
   Ret extends ViewReturnTypeBuilder,
 >(
-  name: string,
+  opts: ViewOpts,
   anon: Anonymous,
   params: Params,
   ret: Ret,
@@ -70,9 +75,9 @@ export function defineView<
   MODULE_DEF.miscExports.push({
     tag: 'View',
     value: {
-      name,
+      name: opts.name,
       index: (anon ? ANON_VIEWS : VIEWS).length,
-      isPublic: true,
+      isPublic: opts.public,
       isAnonymous: anon,
       params: paramType,
       returnType: ret.algebraicType,

modules/module-test-ts/src/index.ts

@@ -219,7 +219,7 @@ const spacetimedb = schema(
 // ─────────────────────────────────────────────────────────────────────────────
 
 spacetimedb.view(
-  'my_player',
+  { name: 'my_player', public: true },
   playerLikeRow.optional(),
   // FIXME: this should not be necessary; change `OptionBuilder` to accept `null|undefined` for `none`
   ctx => ctx.db.player.identity.find(ctx.sender) ?? undefined