[EdgeDB] RichText Scalar (#3050)

Author: CarsonF

dbschema/common.esdl

@@ -15,4 +15,6 @@ module default {
        )
     )
   );
+  
+  scalar type RichText extending json;
 }

dbschema/engagement.esdl

@@ -37,7 +37,7 @@ module default {
       rewrite insert, update using (.endDate if .status = Engagement::Status.InDevelopment else .initialEndDate);
     };
 
-    description: json;
+    description: RichText;
   }
 
   type LanguageEngagement extending Engagement {

dbschema/migrations/00043.edgeql

@@ -0,0 +1,15 @@
+CREATE MIGRATION m1wmrb3grzq5y55y5c447noyxdw26fcpatlu46n5f6ffh572opam6a
+    ONTO m1r3t2ku2jysgjliaq54y7saj4tuxecilnajoxgwa2blsb3p64svzq
+{
+  CREATE SCALAR TYPE default::RichText EXTENDING std::json;
+  ALTER TYPE default::Engagement {
+      ALTER PROPERTY description {
+          SET TYPE default::RichText;
+      };
+  };
+  ALTER TYPE default::Post {
+      ALTER PROPERTY body {
+          SET TYPE default::RichText;
+      };
+  };
+};

dbschema/post.esdl

@@ -14,7 +14,7 @@ module default {
 
     required type: Post::Type;
     required shareability: Post::Shareability;
-    required body: json;
+    required body: RichText;
 
     single property sensitivity := .container[is Project::ContextAware].sensitivity;
     single property isMember := .container[is Project::ContextAware].isMember;

src/core/edgedb/codecs/index.ts

@@ -1,3 +1,4 @@
+import { RichTextCodec } from './rich-text.codec';
 import { LuxonCalendarDateCodec, LuxonDateTimeCodec } from './temporal.codec';
 import { ScalarCodecClass } from './type.util';
 import { OurUUIDCodec } from './uuid.codec';
@@ -9,4 +10,5 @@ export const codecs: readonly ScalarCodecClass[] = [
   OurUUIDCodec,
   LuxonDateTimeCodec,
   LuxonCalendarDateCodec,
+  RichTextCodec,
 ];

src/core/edgedb/codecs/rich-text.codec.ts

@@ -0,0 +1,30 @@
+import { InvalidArgumentError } from 'edgedb';
+import { JSONCodec } from 'edgedb/dist/codecs/json.js';
+import { ReadBuffer, WriteBuffer } from 'edgedb/dist/primitives/buffer.js';
+import { RichTextDocument } from '~/common/rich-text.scalar';
+import { ScalarInfo } from './type.util';
+
+export class RichTextCodec extends JSONCodec {
+  static info: ScalarInfo = {
+    module: 'default',
+    type: 'RichText',
+    ts: RichTextDocument.name,
+    path: '~/common',
+  };
+  tsType = RichTextDocument.name;
+  importedType = true;
+
+  encode(buf: WriteBuffer, object: unknown) {
+    if (!(object instanceof RichTextDocument)) {
+      throw new InvalidArgumentError(
+        `a RichTextDocument was expected, got "${String(object)}"`,
+      );
+    }
+    super.encode(buf, object);
+  }
+
+  decode(buf: ReadBuffer): RichTextDocument {
+    const doc = super.decode(buf);
+    return RichTextDocument.from(doc);
+  }
+}