Added target for reference fields (#2)

ronin-co · Oct 29, 2024 · 69e0c02 · 69e0c02
1 parent b2cb2a7
commit 69e0c02
Show file tree

Hide file tree

Showing 8 changed files with 39 additions and 38 deletions.
diff --git a/src/instructions/to.ts b/src/instructions/to.ts
@@ -150,9 +150,9 @@ export const handleTo = (
       );
 
       const composeStatement = (subQueryType: 'create' | 'drop', value?: unknown) => {
-        const origin =
+        const source =
           queryType === 'create' ? { id: toInstruction.id } : withInstruction;
-        const recordDetails: Record<string, unknown> = { origin };
+        const recordDetails: Record<string, unknown> = { source };
 
         if (value) recordDetails.target = value;
 

diff --git a/src/types/schema.ts b/src/types/schema.ts
@@ -15,7 +15,7 @@ type SchemaFieldNormal = SchemaFieldBasics & {
 
 export type SchemaFieldReference = SchemaFieldBasics & {
   type: 'reference';
-  schema: string;
+  target: string;
   kind?: 'one' | 'many';
 };
 

diff --git a/src/utils/schema.ts b/src/utils/schema.ts
@@ -180,7 +180,7 @@ const SYSTEM_FIELDS: Array<SchemaField> = [
   {
     name: 'RONIN - Created By',
     type: 'reference',
-    schema: 'account',
+    target: 'account',
     slug: 'ronin.createdBy',
   },
   {
@@ -191,7 +191,7 @@ const SYSTEM_FIELDS: Array<SchemaField> = [
   {
     name: 'RONIN - Updated By',
     type: 'reference',
-    schema: 'account',
+    target: 'account',
     slug: 'ronin.updatedBy',
   },
 ];
@@ -227,9 +227,10 @@ const SYSTEM_SCHEMAS: Array<Schema> = [
     fields: [
       ...SYSTEM_FIELDS,
       { slug: 'name', type: 'string' },
-      { slug: 'slug', type: 'string' },
-      { slug: 'type', type: 'string' },
-      { slug: 'schema', type: 'reference', schema: 'schema' },
+      { slug: 'slug', type: 'string', required: true },
+      { slug: 'type', type: 'string', required: true },
+      { slug: 'schema', type: 'reference', target: 'schema' },
+      { slug: 'target', type: 'reference', target: 'schema' },
       { slug: 'required', type: 'boolean' },
       { slug: 'defaultValue', type: 'string' },
       { slug: 'unique', type: 'boolean' },
@@ -258,7 +259,7 @@ export const addSystemSchemas = (schemas: Array<Schema>): Array<Schema> => {
     // different queries in the codebase of an application.
     for (const field of schema.fields || []) {
       if (field.type === 'reference' && !field.slug.startsWith('ronin.')) {
-        const relatedSchema = getSchemaBySlug(list, field.schema);
+        const relatedSchema = getSchemaBySlug(list, field.target);
 
         let fieldSlug = relatedSchema.slug;
 
@@ -274,14 +275,14 @@ export const addSystemSchemas = (schemas: Array<Schema>): Array<Schema> => {
             slug: fieldSlug,
             fields: [
               {
-                slug: 'origin',
+                slug: 'source',
                 type: 'reference',
-                schema: schema.slug,
+                target: schema.slug,
               },
               {
                 slug: 'target',
                 type: 'reference',
-                schema: relatedSchema.slug,
+                target: relatedSchema.slug,
               },
             ],
           });
@@ -303,7 +304,7 @@ export const addSystemSchemas = (schemas: Array<Schema>): Array<Schema> => {
 
         // Additionally, add a default shortcut for resolving the child records in the
         // related schema.
-        const relatedSchemaToModify = list.find((schema) => schema.slug === field.schema);
+        const relatedSchemaToModify = list.find((schema) => schema.slug === field.target);
         if (!relatedSchemaToModify) throw new Error('Missing related schema');
 
         relatedSchemaToModify.including = {

diff --git a/src/utils/statement.ts b/src/utils/statement.ts
@@ -229,7 +229,7 @@ export const composeConditions = (
         // This can be either a string or an object with conditions such as `being`.
         recordTarget = values[0];
       } else {
-        const relatedSchema = getSchemaBySlug(schemas, schemaField.schema);
+        const relatedSchema = getSchemaBySlug(schemas, schemaField.target);
 
         const subQuery: Query = {
           get: {

diff --git a/tests/instructions/for.test.ts b/tests/instructions/for.test.ts
@@ -31,12 +31,12 @@ test('get single record for pre-defined condition', () => {
         {
           slug: 'account',
           type: 'reference',
-          schema: 'account',
+          target: 'account',
         },
         {
           slug: 'space',
           type: 'reference',
-          schema: 'space',
+          target: 'space',
         },
         {
           slug: 'activeAt',
@@ -51,7 +51,7 @@ test('get single record for pre-defined condition', () => {
         {
           slug: 'space',
           type: 'reference',
-          schema: 'space',
+          target: 'space',
         },
       ],
       for: {
@@ -99,12 +99,12 @@ test('get single record for pre-defined condition containing sub query', () => {
         {
           slug: 'account',
           type: 'reference',
-          schema: 'account',
+          target: 'account',
         },
         {
           slug: 'space',
           type: 'reference',
-          schema: 'space',
+          target: 'space',
         },
         {
           slug: 'activeAt',
@@ -119,7 +119,7 @@ test('get single record for pre-defined condition containing sub query', () => {
         {
           slug: 'space',
           type: 'reference',
-          schema: 'space',
+          target: 'space',
         },
       ],
       for: {
@@ -177,12 +177,12 @@ test('get single record for pre-defined field containing sub query', () => {
         {
           slug: 'account',
           type: 'reference',
-          schema: 'account',
+          target: 'account',
         },
         {
           slug: 'space',
           type: 'reference',
-          schema: 'space',
+          target: 'space',
         },
         {
           slug: 'activeAt',
@@ -197,7 +197,7 @@ test('get single record for pre-defined field containing sub query', () => {
         {
           slug: 'space',
           type: 'reference',
-          schema: 'space',
+          target: 'space',
         },
       ],
       for: {

diff --git a/tests/instructions/including.test.ts b/tests/instructions/including.test.ts
@@ -25,7 +25,7 @@ test('get single record including parent record (many-to-one)', () => {
         {
           slug: 'account',
           type: 'reference',
-          schema: 'account',
+          target: 'account',
           kind: 'one',
         },
       ],
@@ -57,7 +57,7 @@ test('get single record including child records (one-to-many, defined manually)'
         {
           slug: 'comments',
           type: 'reference',
-          schema: 'comment',
+          target: 'comment',
           kind: 'many',
         },
       ],
@@ -97,7 +97,7 @@ test('get single record including child records (one-to-many, defined automatica
         {
           slug: 'account',
           type: 'reference',
-          schema: 'account',
+          target: 'account',
         },
       ],
     },

diff --git a/tests/instructions/to.test.ts b/tests/instructions/to.test.ts
@@ -78,7 +78,7 @@ test('set single record to new one-cardinality reference field', () => {
         {
           slug: 'account',
           type: 'reference',
-          schema: 'account',
+          target: 'account',
         },
       ],
     },
@@ -119,7 +119,7 @@ test('set single record to new many-cardinality reference field', () => {
         {
           slug: 'comments',
           type: 'reference',
-          schema: 'comment',
+          target: 'comment',
           kind: 'many',
         },
       ],
@@ -139,8 +139,8 @@ test('set single record to new many-cardinality reference field', () => {
   const { writeStatements, readStatement, values } = compileQueryInput(query, schemas);
 
   expect(writeStatements).toEqual([
-    'DELETE FROM "ronin_posts_comments" WHERE ("origin" = ?1)',
-    'INSERT INTO "ronin_posts_comments" ("origin", "target", "id", "ronin.createdAt", "ronin.updatedAt") VALUES (?2, (SELECT "id" FROM "comments" WHERE ("content" = ?3) LIMIT 1), ?4, ?5, ?6)',
+    'DELETE FROM "ronin_posts_comments" WHERE ("source" = ?1)',
+    'INSERT INTO "ronin_posts_comments" ("source", "target", "id", "ronin.createdAt", "ronin.updatedAt") VALUES (?2, (SELECT "id" FROM "comments" WHERE ("content" = ?3) LIMIT 1), ?4, ?5, ?6)',
   ]);
 
   expect(readStatement).toBe(
@@ -187,7 +187,7 @@ test('set single record to new many-cardinality reference field (add)', () => {
         {
           slug: 'comments',
           type: 'reference',
-          schema: 'comment',
+          target: 'comment',
           kind: 'many',
         },
       ],
@@ -207,7 +207,7 @@ test('set single record to new many-cardinality reference field (add)', () => {
   const { writeStatements, readStatement, values } = compileQueryInput(query, schemas);
 
   expect(writeStatements).toEqual([
-    'INSERT INTO "ronin_posts_comments" ("origin", "target", "id", "ronin.createdAt", "ronin.updatedAt") VALUES (?1, (SELECT "id" FROM "comments" WHERE ("content" = ?2) LIMIT 1), ?3, ?4, ?5)',
+    'INSERT INTO "ronin_posts_comments" ("source", "target", "id", "ronin.createdAt", "ronin.updatedAt") VALUES (?1, (SELECT "id" FROM "comments" WHERE ("content" = ?2) LIMIT 1), ?3, ?4, ?5)',
   ]);
 
   expect(readStatement).toBe(
@@ -253,7 +253,7 @@ test('set single record to new many-cardinality reference field (delete)', () =>
         {
           slug: 'comments',
           type: 'reference',
-          schema: 'comment',
+          target: 'comment',
           kind: 'many',
         },
       ],
@@ -273,7 +273,7 @@ test('set single record to new many-cardinality reference field (delete)', () =>
   const { writeStatements, readStatement, values } = compileQueryInput(query, schemas);
 
   expect(writeStatements).toEqual([
-    'DELETE FROM "ronin_posts_comments" WHERE ("origin" = ?1 AND "target" = (SELECT "id" FROM "comments" WHERE ("content" = ?2) LIMIT 1))',
+    'DELETE FROM "ronin_posts_comments" WHERE ("source" = ?1 AND "target" = (SELECT "id" FROM "comments" WHERE ("content" = ?2) LIMIT 1))',
   ]);
 
   expect(readStatement).toBe(
@@ -553,7 +553,7 @@ test('set single record to new grouped reference field', () => {
         {
           slug: 'billing.manager',
           type: 'reference',
-          schema: 'account',
+          target: 'account',
         },
       ],
     },

diff --git a/tests/instructions/with.test.ts b/tests/instructions/with.test.ts
@@ -505,7 +505,7 @@ test('get single record with reference field', () => {
         {
           slug: 'account',
           type: 'reference',
-          schema: 'account',
+          target: 'account',
         },
       ],
     },
@@ -544,7 +544,7 @@ test('get single record with reference field and id', () => {
         {
           slug: 'account',
           type: 'reference',
-          schema: 'account',
+          target: 'account',
         },
       ],
     },
@@ -583,7 +583,7 @@ test('get single record with reference field and id with condition', () => {
         {
           slug: 'account',
           type: 'reference',
-          schema: 'account',
+          target: 'account',
         },
       ],
     },