(wip) spike on adding top-level types to Paper

chadian · chadian · commit cae2122f62ff · 2022-06-10T13:19:55.000-04:00
diff --git a/packages/paper/src/paper.ts b/packages/paper/src/paper.ts
@@ -36,9 +36,12 @@ import {
 // > https://exploringjs.com/deep-js/ch_proxies.html
 setAutoFreeze(false);
 
-export class Paper<UserOperations extends OperationMap = OperationMap> {
-  protected history: DocumentStore[] = [];
-  protected current: DocumentStore;
+export class Paper<
+  SchemaTypes extends Record<string, any> = Record<string, any>,
+  UserOperations extends OperationMap = OperationMap
+> {
+  protected history: DocumentStore<SchemaTypes>[] = [];
+  protected current: DocumentStore<SchemaTypes>;
   protected sourceGraphQLSchema: GraphQLSchema;
   protected mutateQueue: Queue = new Queue();
 
@@ -57,7 +60,7 @@ export class Paper<UserOperations extends OperationMap = OperationMap> {
 
   constructor(graphqlSchema: Parameters<typeof createSchema>[0], options?: { operations?: UserOperations }) {
     const schema = createSchema(graphqlSchema);
-    this.current = createDocumentStore(schema);
+    this.current = createDocumentStore(schema) as DocumentStore<SchemaTypes>;
     this.sourceGraphQLSchema = schema;
 
     this.operations = {
@@ -66,8 +69,8 @@ export class Paper<UserOperations extends OperationMap = OperationMap> {
     };
   }
 
-  get data(): DocumentStore {
-    return proxyWrap(this.sourceGraphQLSchema, this.current);
+  get data(): DocumentStore<SchemaTypes> {
+    return proxyWrap(this.sourceGraphQLSchema, this.current) as DocumentStore<SchemaTypes>;
   }
 
   find(documentOrKey: KeyOrDocument): Document | undefined {
@@ -103,7 +106,7 @@ export class Paper<UserOperations extends OperationMap = OperationMap> {
 
     const next = await produce(current, async (draft) => {
       const { transactionResult, eventQueue } = await transaction<typeof operations>(
-        draft,
+        draft as DocumentStore<SchemaTypes>,
         schema,
         operations,
         hooks,
diff --git a/packages/paper/src/types.ts b/packages/paper/src/types.ts
@@ -7,15 +7,17 @@ export type DocumentKey = string;
 export type GraphQLTypeName = string;
 export type KeyOrDocument = DocumentKey | Document;
 
-export type Document = {
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  [k: string]: any;
+export type Document<T extends Record<string, any> = Record<string, any>> = T & {
   [DOCUMENT_KEY_SYMBOL]: DocumentKey;
   [DOCUMENT_CONNECTIONS_SYMBOL]: ConnectionsMap;
   [DOCUMENT_GRAPHQL_TYPENAME]: GraphQLTypeName;
   __typename: string;
 };
 
+type Special = Document<{ name: string }>;
+const a: Special = { name: 'hello' };
+console.log(a);
+
 export type DocumentPartial = Partial<Document>;
 
 // connections
@@ -25,7 +27,9 @@ type Connections = Array<DocumentKey>;
 
 // store
 
-export type DocumentStore<Typename extends string = string> = Record<Typename, Document[]>;
+export type DocumentStore<
+  SchemaTypes extends Record<string, Document<SchemaTypes[keyof SchemaTypes]>> = Record<string, any>
+> = Record<keyof SchemaTypes, Document<SchemaTypes[keyof SchemaTypes]>[]>;
 
 // operations
 
diff --git a/packages/paper/test/unit/paper.test.ts b/packages/paper/test/unit/paper.test.ts
@@ -21,11 +21,19 @@ const schemaString = `
 `;
 const graphqlSchema = buildSchema(schemaString);
 
+type Person = {
+  name: string;
+};
+
+type SchemaTypes = {
+  Person: Person;
+};
+
 describe('mutation operations', () => {
-  let paper: Paper;
+  let paper: Paper<SchemaTypes>;
 
   beforeEach(() => {
-    paper = new Paper(graphqlSchema);
+    paper = new Paper<SchemaTypes>(graphqlSchema);
   });
 
   it('can create a document', async () => {
