fixup mutator generation to allow deletes

ROADMAP.md

@@ -20,7 +20,7 @@
    1. Add another backend (besides SQL), e.g. redis
    2. Test hops across backends (e.g., SQL->Neo hop)
 8. Junction Edges
-9.  Abstract Edges
+9. Abstract Edges
 10. Neo/Tinkerpop/RedisGraph junction like edge defs
 11. Privacy rules
 12. Semantic types for fields
@@ -31,4 +31,5 @@
 17. Purpose limitation
 18. Byzantine fault tolerance
 19. Consistency / integrity rules
-20. Triggers / Observers
+20. Triggers / Observers
+21. Property testing and zod?

TODO.md

@@ -1,5 +1,6 @@
 # 5/16
 
+- incorporate zod for schemas and test generation?
 - ensure the cache we're using is pegged to the right viewer??
 - generate static query all method for node classes
 - in spec.createFrom -- check cache first and either

extensions/mutation-codegen/src/typescript/GenTypescriptMutations.ts

@@ -33,16 +33,26 @@ ${this.getCode()}
   }
 
   private getCode(): string {
-    return `export default class ${this.schema.name}Mutations {
-      constructor(
-        private mutator: ICreateOrUpdateBuilder<${this.schema.name}, Data>
-      ) {}
-
-      static for(model?: ${this.schema.name}) {
-        if (model) {
-          return new ${this.schema.name}Mutations(new UpdateMutationBuilder(spec, model))
-        }
-        return new ${this.schema.name}Mutations(new CreateMutationBuilder(spec));
+    return `export default class ${this.schema.name}Mutations extends MutationsBase<${
+      this.schema.name
+    }, Data> {
+      private constructor(
+        ctx: Context,
+        mutator: ICreateOrUpdateBuilder<${this.schema.name}, Data>
+      ) {
+        super(ctx, mutator);
+      }
+
+      static update(model: ${this.schema.name}) {
+        return new ${this.schema.name}Mutations(model.ctx, new UpdateMutationBuilder(spec, model))
+      }
+
+      static create(ctx: Context) {
+        return new ${this.schema.name}Mutations(ctx, new CreateMutationBuilder(spec));
+      }
+
+      static delete(model: ${this.schema.name}) {
+        return new ${this.schema.name}Mutations(model.ctx, new DeleteMutationBuilder(spec, model));
       }
 
       ${this.getMutationMethodsCode()}
@@ -52,12 +62,15 @@ ${this.getCode()}
   private collectImports(): Import[] {
     return [
       tsImport('{ICreateOrUpdateBuilder}', null, '@aphro/mutator-runtime-ts'),
+      tsImport('{Context}', null, '@aphro/context-runtime-ts'),
+      tsImport('{MutationsBase}', null, '@aphro/mutator-runtime-ts'),
       tsImport(this.schema.name, null, `./${this.schema.name}.js`),
       tsImport(this.schema.name, null, `./${this.schema.name}.js`),
       tsImport('{default}', 'spec', `./${nodeFn.specName(this.schema.name)}.js`),
       tsImport('{Data}', null, `./${this.schema.name}.js`),
       tsImport('{UpdateMutationBuilder}', null, '@aphro/mutator-runtime-ts'),
       tsImport('{CreateMutationBuilder}', null, '@aphro/mutator-runtime-ts'),
+      tsImport('{DeleteMutationBuilder}', null, '@aphro/mutator-runtime-ts'),
       ...this.collectImportsForMutations(),
     ];
   }

packages/integration-tests-ts/src/generated/ComponentMutations.ts

@@ -1,20 +1,39 @@
-// SIGNED-SOURCE: <e982446922c03897e3f9dfa074b543e5>
+// SIGNED-SOURCE: <5cfb580ac56d1e8824cb7f2b85e4d750>
 import { ICreateOrUpdateBuilder } from "@aphro/mutator-runtime-ts";
+import { Context } from "@aphro/context-runtime-ts";
+import { MutationsBase } from "@aphro/mutator-runtime-ts";
 import Component from "./Component.js";
 import { default as spec } from "./ComponentSpec.js";
 import { Data } from "./Component.js";
 import { UpdateMutationBuilder } from "@aphro/mutator-runtime-ts";
 import { CreateMutationBuilder } from "@aphro/mutator-runtime-ts";
+import { DeleteMutationBuilder } from "@aphro/mutator-runtime-ts";
 import Slide from "./Slide.js";
 
-export default class ComponentMutations {
-  constructor(private mutator: ICreateOrUpdateBuilder<Component, Data>) {}
+export default class ComponentMutations extends MutationsBase<Component, Data> {
+  private constructor(
+    ctx: Context,
+    mutator: ICreateOrUpdateBuilder<Component, Data>
+  ) {
+    super(ctx, mutator);
+  }
+
+  static update(model: Component) {
+    return new ComponentMutations(
+      model.ctx,
+      new UpdateMutationBuilder(spec, model)
+    );
+  }
+
+  static create(ctx: Context) {
+    return new ComponentMutations(ctx, new CreateMutationBuilder(spec));
+  }
 
-  static for(model?: Component) {
-    if (model) {
-      return new ComponentMutations(new UpdateMutationBuilder(spec, model));
-    }
-    return new ComponentMutations(new CreateMutationBuilder(spec));
+  static delete(model: Component) {
+    return new ComponentMutations(
+      model.ctx,
+      new DeleteMutationBuilder(spec, model)
+    );
   }
 
   create(subtype: "Text" | "Embed", slide: Slide, content: string): this {

packages/integration-tests-ts/src/generated/DeckMutations.ts

@@ -1,21 +1,34 @@
-// SIGNED-SOURCE: <55f3bde1cccb173b79f70aa8420420d4>
+// SIGNED-SOURCE: <3490a94ac2aeb68ef2a4e735c062099b>
 import { ICreateOrUpdateBuilder } from "@aphro/mutator-runtime-ts";
+import { Context } from "@aphro/context-runtime-ts";
+import { MutationsBase } from "@aphro/mutator-runtime-ts";
 import Deck from "./Deck.js";
 import { default as spec } from "./DeckSpec.js";
 import { Data } from "./Deck.js";
 import { UpdateMutationBuilder } from "@aphro/mutator-runtime-ts";
 import { CreateMutationBuilder } from "@aphro/mutator-runtime-ts";
+import { DeleteMutationBuilder } from "@aphro/mutator-runtime-ts";
 import User from "./User.js";
 import Slide from "./Slide.js";
 
-export default class DeckMutations {
-  constructor(private mutator: ICreateOrUpdateBuilder<Deck, Data>) {}
+export default class DeckMutations extends MutationsBase<Deck, Data> {
+  private constructor(
+    ctx: Context,
+    mutator: ICreateOrUpdateBuilder<Deck, Data>
+  ) {
+    super(ctx, mutator);
+  }
+
+  static update(model: Deck) {
+    return new DeckMutations(model.ctx, new UpdateMutationBuilder(spec, model));
+  }
+
+  static create(ctx: Context) {
+    return new DeckMutations(ctx, new CreateMutationBuilder(spec));
+  }
 
-  static for(model?: Deck) {
-    if (model) {
-      return new DeckMutations(new UpdateMutationBuilder(spec, model));
-    }
-    return new DeckMutations(new CreateMutationBuilder(spec));
+  static delete(model: Deck) {
+    return new DeckMutations(model.ctx, new DeleteMutationBuilder(spec, model));
   }
 
   create(name: string, owner: User, selectedSlide: Slide | null): this {

packages/integration-tests-ts/src/generated/SlideMutations.ts

@@ -1,20 +1,39 @@
-// SIGNED-SOURCE: <2d675ae3a2673b61e5e1c372771b4633>
+// SIGNED-SOURCE: <f35b443976bc9dcd0a583a415f63bbc4>
 import { ICreateOrUpdateBuilder } from "@aphro/mutator-runtime-ts";
+import { Context } from "@aphro/context-runtime-ts";
+import { MutationsBase } from "@aphro/mutator-runtime-ts";
 import Slide from "./Slide.js";
 import { default as spec } from "./SlideSpec.js";
 import { Data } from "./Slide.js";
 import { UpdateMutationBuilder } from "@aphro/mutator-runtime-ts";
 import { CreateMutationBuilder } from "@aphro/mutator-runtime-ts";
+import { DeleteMutationBuilder } from "@aphro/mutator-runtime-ts";
 import Deck from "./Deck.js";
 
-export default class SlideMutations {
-  constructor(private mutator: ICreateOrUpdateBuilder<Slide, Data>) {}
+export default class SlideMutations extends MutationsBase<Slide, Data> {
+  private constructor(
+    ctx: Context,
+    mutator: ICreateOrUpdateBuilder<Slide, Data>
+  ) {
+    super(ctx, mutator);
+  }
+
+  static update(model: Slide) {
+    return new SlideMutations(
+      model.ctx,
+      new UpdateMutationBuilder(spec, model)
+    );
+  }
+
+  static create(ctx: Context) {
+    return new SlideMutations(ctx, new CreateMutationBuilder(spec));
+  }
 
-  static for(model?: Slide) {
-    if (model) {
-      return new SlideMutations(new UpdateMutationBuilder(spec, model));
-    }
-    return new SlideMutations(new CreateMutationBuilder(spec));
+  static delete(model: Slide) {
+    return new SlideMutations(
+      model.ctx,
+      new DeleteMutationBuilder(spec, model)
+    );
   }
 
   create(deck: Deck, order: number): this {

packages/integration-tests-ts/src/generated/UserMutations.ts

@@ -1,19 +1,32 @@
-// SIGNED-SOURCE: <b99750e12dbb708a7a622941d023b786>
+// SIGNED-SOURCE: <6f271dc110baedb012d220e6d5ed9943>
 import { ICreateOrUpdateBuilder } from "@aphro/mutator-runtime-ts";
+import { Context } from "@aphro/context-runtime-ts";
+import { MutationsBase } from "@aphro/mutator-runtime-ts";
 import User from "./User.js";
 import { default as spec } from "./UserSpec.js";
 import { Data } from "./User.js";
 import { UpdateMutationBuilder } from "@aphro/mutator-runtime-ts";
 import { CreateMutationBuilder } from "@aphro/mutator-runtime-ts";
+import { DeleteMutationBuilder } from "@aphro/mutator-runtime-ts";
 
-export default class UserMutations {
-  constructor(private mutator: ICreateOrUpdateBuilder<User, Data>) {}
+export default class UserMutations extends MutationsBase<User, Data> {
+  private constructor(
+    ctx: Context,
+    mutator: ICreateOrUpdateBuilder<User, Data>
+  ) {
+    super(ctx, mutator);
+  }
+
+  static update(model: User) {
+    return new UserMutations(model.ctx, new UpdateMutationBuilder(spec, model));
+  }
+
+  static create(ctx: Context) {
+    return new UserMutations(ctx, new CreateMutationBuilder(spec));
+  }
 
-  static for(model?: User) {
-    if (model) {
-      return new UserMutations(new UpdateMutationBuilder(spec, model));
-    }
-    return new UserMutations(new CreateMutationBuilder(spec));
+  static delete(model: User) {
+    return new UserMutations(model.ctx, new DeleteMutationBuilder(spec, model));
   }
 
   create(name: string): this {

packages/mutator-runtime-ts/src/MutationsBase.ts

@@ -1,12 +1,12 @@
 import { IModel } from '@aphro/model-runtime-ts';
-import { ICreateOrUpdateBuilder } from './Mutator.js';
+import { IMutationBuilder } from './Mutator.js';
 import { Changeset, ChangesetOptions } from './Changeset.js';
 import { commit } from './commit.js';
 import { Context } from '@aphro/context-runtime-ts';
 
 export default abstract class MutationsBase<M extends IModel<D>, D extends Object> {
   readonly ctx: Context;
-  constructor(ctx: Context, protected mutator: ICreateOrUpdateBuilder<M, D>) {
+  constructor(ctx: Context, protected mutator: IMutationBuilder<M, D>) {
     this.ctx = ctx;
   }
 

packages/mutator-runtime-ts/src/Mutator.ts

@@ -9,6 +9,9 @@ import {
 
 export interface IMutationBuilder<M extends IModel<D>, D extends Object> {
   toChangeset(options?: ChangesetOptions): Changeset<M, D>;
+  // TODO: remove this once we get mutations generation complete
+  // we don't need `set` for `delete`
+  set(newData: Partial<D>): this;
 }
 
 export interface ICreateOrUpdateBuilder<M extends IModel<D>, D extends Object>
@@ -22,6 +25,9 @@ abstract class MutationBuilder<M extends IModel<D>, D extends Object>
 {
   constructor(protected spec: ModelSpec<M, D>, protected data: Partial<D>) {}
   abstract toChangeset(): Changeset<M, D>;
+  set(newData: Partial<D>): this {
+    throw new Error('You cannot call `set` when deleting something');
+  }
 }
 
 abstract class CreateOrUpdateBuilder<M extends IModel<D>, D extends Object> extends MutationBuilder<

packages/mutator-runtime-ts/src/index.ts

@@ -1,2 +1,3 @@
 export * from './Mutator.js';
 export * from './commit.js';
+export { default as MutationsBase } from './MutationsBase.js';