feat(refs): support direct declarations of Refs

package.json

@@ -76,13 +76,13 @@
     "postinstall": "[ -d .git ] && npx husky install || exit 0"
   },
   "dependencies": {
-    "@ehmpathy/error-fns": "1.3.1",
+    "@ehmpathy/error-fns": "1.3.7",
     "@oclif/core": "3.26.6",
     "@oclif/plugin-help": "6.0.22",
     "chalk": "2.4.2",
     "change-case": "4.1.1",
     "domain-objects": "0.22.1",
-    "domain-objects-metadata": "0.7.4",
+    "domain-objects-metadata": "0.7.5",
     "fast-glob": "3.2.2",
     "joi": "17.4.0",
     "lodash.omit": "4.5.0",

src/domain/objects/SqlSchemaReferenceMetadata.ts

@@ -3,7 +3,19 @@ import { DomainObjectReferenceMetadata } from 'domain-objects-metadata';
 import Joi from 'joi';
 
 export enum SqlSchemaReferenceMethod {
+  /**
+   * .what = when a domain literal is directly nested in another domain object
+   */
   DIRECT_BY_NESTING = 'DIRECT_BY_NESTING',
+
+  /**
+   * .what = when a domain object is explicitly referenced, via Ref<>, in another domain object
+   */
+  DIRECT_BY_DECLARATION = 'DIRECT_BY_DECLARATION',
+
+  /**
+   * .what = when a domain object is implicitly referenced, via uuid, in another domain object
+   */
   IMPLICIT_BY_UUID = 'IMPLICIT_BY_UUID',
 }
 

src/logic/__test_assets__/exampleProject/src/domain/objects/Carriage.ts

@@ -16,7 +16,7 @@ export interface Carriage {
   capacity: number; // for passenger carriages, number of passengers; for freight, the volume
 }
 export class Carriage extends DomainEntity<Carriage> implements Carriage {
-  public static primary = ['uuid'] as const; // there is nothing that naturally identifies a carriage -> it is unique only on the unique identifier tracked in our db
-  public static unique = ['uuid'] as const; // there is nothing that naturally identifies a carriage -> it is unique only on the unique identifier tracked in our db
+  public static primary = ['uuid'] as const;
+  public static unique = ['cin'] as const;
   public static updatable = [];
 }

src/logic/__test_assets__/exampleProject/src/domain/objects/CarriageCargo.ts

@@ -0,0 +1,35 @@
+import { DomainEntity, Ref } from 'domain-objects';
+import { Carriage } from './Carriage';
+
+/**
+ * .what = cargo which has been allocated to a carriage at a given point in time
+ */
+export interface CarriageCargo {
+  id?: number;
+  uuid?: string;
+
+  /**
+   * the itinerary during which it is allocated
+   */
+  itineraryUuid: string; // todo: ref to an itinerary once we declare it
+
+  /**
+   * the carriage it has been allocated to
+   */
+  carriageRef: Ref<typeof Carriage>;
+
+  /**
+   * the slot that it has been allocated to on the carriage
+   */
+  slot: number;
+
+  /**
+   * the cargo that has been allocated
+   */
+  cargoExid: null | string;
+}
+export class CarriageCargo extends DomainEntity<CarriageCargo> implements CarriageCargo {
+  public static primary = ['uuid'] as const;
+  public static unique = ['itineraryUuid', 'carriageRef', 'slot'] as const;
+  public static updatable = ['cargoExid'];
+}

src/logic/__test_assets__/exampleProject/src/domain/objects/index.ts

@@ -1,4 +1,5 @@
 export * from './AsyncTaskPredictStationCongestion'
+export * from './CarriageCargo';
 export * from './Carriage';
 export * from './Certificate';
 export * from './Engineer';

src/logic/commands/generate.integration.test.ts

@@ -264,7 +264,6 @@ describe('generate', () => {
     describe('carriageDao', () => {
       it('it should be able to upsert', async () => {
         const carriage = new Carriage({
-          uuid: uuid(),
           cin: 'carriage-to-test',
           carries: CarriagePurpose.FREIGHT,
           capacity: 821,
@@ -359,7 +358,7 @@ describe('generate', () => {
         );
         const foundCarriage = await carriageDao.findByUnique(
           {
-            uuid: carriage.uuid,
+            cin: carriage.cin,
           },
           { dbConnection },
         );