@bslau/hmm_prisma_schema 1.1.18 → 1.1.20

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bslau/hmm_prisma_schema",
-  "version": "1.1.18",
+  "version": "1.1.20",
   "main": "index.js",
   "author": "CIPA Development Team",
   "license": "ISC",
@@ -11,6 +11,9 @@
   "scripts": {
     "generate": "npx prisma generate",
     "postinstall": "npm run generate",
+    "prisma:apply": "npx prisma migrate dev",
+    "prisma:create": "npx prisma migrate dev --create-only",
+    "prisma:deploy": "npx prisma migrate deploy",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "types": "./index.d.ts",

package/prisma/migrations/20250318033837_393775_torp_trip_campaigns/migration.sql

@@ -0,0 +1,64 @@
+BEGIN TRY
+
+BEGIN TRAN;
+
+-- CreateTable
+CREATE TABLE [dbo].[CampaignRebricking] (
+    [id] INT NOT NULL IDENTITY(1,1),
+    [torpedoId] INT NOT NULL,
+    [startTime] DATETIMEOFFSET NOT NULL CONSTRAINT [CampaignRebricking_startTime_df] DEFAULT CURRENT_TIMESTAMP,
+    [endTime] DATETIMEOFFSET,
+    CONSTRAINT [CampaignRebricking_pkey] PRIMARY KEY CLUSTERED ([id])
+);
+
+-- CreateTable
+CREATE TABLE [dbo].[CampaignSurvey] (
+    [id] INT NOT NULL IDENTITY(1,1),
+    [torpedoId] INT NOT NULL,
+    [startTime] DATETIMEOFFSET NOT NULL CONSTRAINT [CampaignSurvey_startTime_df] DEFAULT CURRENT_TIMESTAMP,
+    [endTime] DATETIMEOFFSET,
+    CONSTRAINT [CampaignSurvey_pkey] PRIMARY KEY CLUSTERED ([id])
+);
+
+-- CreateTable
+CREATE TABLE [dbo].[TorpedoTrip] (
+    [id] INT NOT NULL IDENTITY(1,1),
+    [campaignRebrickingId] INT NOT NULL,
+    [campaignSurveyId] INT NOT NULL,
+    [hotMetalId] INT NOT NULL,
+    [torpedoId] INT NOT NULL,
+    [startTime] DATETIMEOFFSET NOT NULL CONSTRAINT [TorpedoTrip_startTime_df] DEFAULT CURRENT_TIMESTAMP,
+    [endTime] DATETIMEOFFSET,
+    CONSTRAINT [TorpedoTrip_pkey] PRIMARY KEY CLUSTERED ([id])
+);
+
+-- AddForeignKey
+ALTER TABLE [dbo].[CampaignRebricking] ADD CONSTRAINT [CampaignRebricking_torpedoId_fkey] FOREIGN KEY ([torpedoId]) REFERENCES [dbo].[Torpedo]([torpedoId]) ON DELETE NO ACTION ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE [dbo].[CampaignSurvey] ADD CONSTRAINT [CampaignSurvey_torpedoId_fkey] FOREIGN KEY ([torpedoId]) REFERENCES [dbo].[Torpedo]([torpedoId]) ON DELETE NO ACTION ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE [dbo].[TorpedoTrip] ADD CONSTRAINT [TorpedoTrip_campaignRebrickingId_fkey] FOREIGN KEY ([campaignRebrickingId]) REFERENCES [dbo].[CampaignRebricking]([id]) ON DELETE NO ACTION ON UPDATE NO ACTION;
+
+-- AddForeignKey
+ALTER TABLE [dbo].[TorpedoTrip] ADD CONSTRAINT [TorpedoTrip_campaignSurveyId_fkey] FOREIGN KEY ([campaignSurveyId]) REFERENCES [dbo].[CampaignSurvey]([id]) ON DELETE NO ACTION ON UPDATE NO ACTION;
+
+-- AddForeignKey
+ALTER TABLE [dbo].[TorpedoTrip] ADD CONSTRAINT [TorpedoTrip_hotMetalId_fkey] FOREIGN KEY ([hotMetalId]) REFERENCES [dbo].[HotMetal]([id]) ON DELETE NO ACTION ON UPDATE NO ACTION;
+
+-- AddForeignKey
+ALTER TABLE [dbo].[TorpedoTrip] ADD CONSTRAINT [TorpedoTrip_torpedoId_fkey] FOREIGN KEY ([torpedoId]) REFERENCES [dbo].[Torpedo]([torpedoId]) ON DELETE NO ACTION ON UPDATE NO ACTION;
+
+COMMIT TRAN;
+
+END TRY
+BEGIN CATCH
+
+IF @@TRANCOUNT > 0
+BEGIN
+    ROLLBACK TRAN;
+END;
+THROW
+
+END CATCH

package/prisma/migrations/20250324223645_393918_torp_cycle/migration.sql

@@ -0,0 +1,43 @@
+BEGIN TRY
+
+BEGIN TRAN;
+
+-- AlterTable
+ALTER TABLE [dbo].[EventTorpedoMovement] ADD [torpedoCycleId] INT,
+[torpedoStateId] INT NOT NULL CONSTRAINT [EventTorpedoMovement_torpedoStateId_df] DEFAULT 0,
+[torpedoTripId] INT;
+
+-- CreateTable
+CREATE TABLE [dbo].[TorpedoCycle] (
+    [id] INT NOT NULL IDENTITY(1,1),
+    [hotMetalId] INT NOT NULL,
+    [torpedoId] INT NOT NULL,
+    [startTime] DATETIMEOFFSET NOT NULL CONSTRAINT [TorpedoCycle_startTime_df] DEFAULT CURRENT_TIMESTAMP,
+    [endTime] DATETIMEOFFSET,
+    CONSTRAINT [TorpedoCycle_pkey] PRIMARY KEY CLUSTERED ([id])
+);
+
+-- AddForeignKey
+ALTER TABLE [dbo].[EventTorpedoMovement] ADD CONSTRAINT [EventTorpedoMovement_torpedoCycleId_fkey] FOREIGN KEY ([torpedoCycleId]) REFERENCES [dbo].[TorpedoCycle]([id]) ON DELETE SET NULL ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE [dbo].[EventTorpedoMovement] ADD CONSTRAINT [EventTorpedoMovement_torpedoTripId_fkey] FOREIGN KEY ([torpedoTripId]) REFERENCES [dbo].[TorpedoTrip]([id]) ON DELETE SET NULL ON UPDATE CASCADE;
+
+-- AddForeignKey
+ALTER TABLE [dbo].[TorpedoCycle] ADD CONSTRAINT [TorpedoCycle_hotMetalId_fkey] FOREIGN KEY ([hotMetalId]) REFERENCES [dbo].[HotMetal]([id]) ON DELETE NO ACTION ON UPDATE NO ACTION;
+
+-- AddForeignKey
+ALTER TABLE [dbo].[TorpedoCycle] ADD CONSTRAINT [TorpedoCycle_torpedoId_fkey] FOREIGN KEY ([torpedoId]) REFERENCES [dbo].[Torpedo]([torpedoId]) ON DELETE NO ACTION ON UPDATE NO ACTION;
+
+COMMIT TRAN;
+
+END TRY
+BEGIN CATCH
+
+IF @@TRANCOUNT > 0
+BEGIN
+    ROLLBACK TRAN;
+END;
+THROW
+
+END CATCH

package/prisma/schema.prisma

@@ -8,6 +8,43 @@ datasource db {
   shadowDatabaseUrl = env("SHADOW_DATABASE_URL")
 }
 
+/// **REBRICKING CAMPAIGN**
+///
+/// The entire lifespan of _Torpedo_ lining, from installation to removal.
+///
+/// This indicates the entire refractory lining (or just working lining) is
+/// removed and the tonnes and trips on the lining are reset.
+model CampaignRebricking {
+  id           Int           @id @default(autoincrement())
+  torpedo      Torpedo       @relation(fields: [torpedoId], references: [torpedoId], onDelete: NoAction, onUpdate: Cascade)
+  torpedoId    Int
+  torpedoTrips TorpedoTrip[]
+  startTime    DateTime      @default(now()) @db.DateTimeOffset
+  endTime      DateTime?     @db.DateTimeOffset
+}
+
+/// **SURVEY CAMPAIGN**
+///
+/// A period of continual operation between OOS inspections (~2 annually).
+///
+/// From OOS to OOS, used for _Torpedo Ladle_ refractory inspections, based on
+/// number of tonnes carried, typically carried out once or twice a year (on
+/// average). The total tonnes and _Trips_ on the lining are not reset.
+model CampaignSurvey {
+  id           Int           @id @default(autoincrement())
+  torpedo      Torpedo       @relation(fields: [torpedoId], references: [torpedoId], onDelete: NoAction, onUpdate: Cascade)
+  torpedoId    Int
+  torpedoTrips TorpedoTrip[]
+  startTime    DateTime      @default(now()) @db.DateTimeOffset
+  endTime      DateTime?     @db.DateTimeOffset
+}
+
+/// **CAST**
+///
+/// A (parent) lot of molten iron produced by a **Blast Furnace**.
+///
+/// Contains properties that describe when the _Cast_ was produced and its
+/// measured physical values.
 model Cast {
   id                       Int        @id @default(autoincrement())
   sequenceCastBlastFurnace Int        @unique(sort: Desc)
@@ -53,26 +90,41 @@ model Cast {
   hotMetalCollection       HotMetal[]
 }
 
+/// **TORPEDO MOVEMENT EVENT**
+///
+/// Capture the details of a _Torpedo Movement_ triggered by a **HMC Operator**.
+///
+/// Each movement event captures the _Torpedo's_ operational _State_, and is
+/// tracked within the context of the current _Trip_ and _Cycle_ - primarily for
+/// reporting purposes.
 model EventTorpedoMovement {
-  id                    Int          @id @default(autoincrement())
+  id                    Int           @id @default(autoincrement())
   torpedoId             Int
-  torpedo               Torpedo      @relation(fields: [torpedoId], references: [torpedoId])
-  eventTime             DateTime     @db.DateTimeOffset
-  originStation         Station      @relation(name: "originStation-movement", fields: [originStationId], references: [id], onDelete: NoAction, onUpdate: Cascade)
+  torpedo               Torpedo       @relation(fields: [torpedoId], references: [torpedoId])
+  torpedoStateId        Int           @default(0)
+  eventTime             DateTime      @db.DateTimeOffset
+  originStation         Station       @relation(name: "originStation-movement", fields: [originStationId], references: [id], onDelete: NoAction, onUpdate: Cascade)
   originStationId       Int
-  originLocation        Location     @relation(name: "originLocation-movement", fields: [originLocationId], references: [id], onDelete: NoAction, onUpdate: Cascade)
+  originLocation        Location      @relation(name: "originLocation-movement", fields: [originLocationId], references: [id], onDelete: NoAction, onUpdate: Cascade)
   originLocationId      Int
-  destinationStation    Station      @relation(name: "destinationStation-movement", fields: [destinationStationId], references: [id], onDelete: NoAction, onUpdate: NoAction)
+  destinationStation    Station       @relation(name: "destinationStation-movement", fields: [destinationStationId], references: [id], onDelete: NoAction, onUpdate: NoAction)
   destinationStationId  Int
-  destinationLocation   Location     @relation(name: "destinationLocation-movement", fields: [destinationLocationId], references: [id], onDelete: NoAction, onUpdate: NoAction)
+  destinationLocation   Location      @relation(name: "destinationLocation-movement", fields: [destinationLocationId], references: [id], onDelete: NoAction, onUpdate: NoAction)
   destinationLocationId Int
-  event                 EventTracker @relation(fields: [eventId], references: [id])
-  eventId               Int          @unique
+  event                 EventTracker  @relation(fields: [eventId], references: [id])
+  eventId               Int           @unique
   userId                String?
-  createdAt             DateTime     @default(now())
-  updatedAt             DateTime     @updatedAt
+  torpedoCycle          TorpedoCycle? @relation(fields: [torpedoCycleId], references: [id])
+  torpedoCycleId        Int?
+  torpedoTrip           TorpedoTrip?  @relation(fields: [torpedoTripId], references: [id])
+  torpedoTripId         Int?
+  createdAt             DateTime      @default(now())
+  updatedAt             DateTime      @updatedAt
 }
 
+/// **EVENT TRACKER**
+///
+/// Represents a generic system _Event_, which maps to its model instance.
 model EventTracker {
   id              Int                   @id @default(autoincrement())
   eventTime       DateTime              @db.DateTimeOffset
@@ -81,6 +133,9 @@ model EventTracker {
   torpedoMovement EventTorpedoMovement?
 }
 
+/// **HOT METAL HANDLER COMMENT**
+///
+/// Stores comments for specific _Torpedoes_, logged by **Maintenance Users**.
 model HMHComment {
   id        Int       @id @default(autoincrement())
   torpedo   Torpedo   @relation(fields: [torpedoId], references: [torpedoId], onDelete: NoAction, onUpdate: Cascade)
@@ -91,6 +146,12 @@ model HMHComment {
   updatedAt DateTime? @updatedAt
 }
 
+/// **HOT METAL**
+///
+/// A (child) sub-lot, or batch, of molten iron produced by a **Blast Furnace**.
+///
+/// Contains properties that describe when the _Hot Metal_ was produced and its
+/// measured physical values.
 model HotMetal {
   id                        Int                 @id @default(autoincrement())
   mesId                     Int?
@@ -99,6 +160,8 @@ model HotMetal {
   torpedo                   Torpedo             @relation(fields: [torpedoId], references: [torpedoId], onDelete: NoAction, onUpdate: Cascade)
   torpedoId                 Int
   labResult                 HotMetalLabResult[]
+  torpedoCycle              TorpedoCycle[]
+  torpedoTrip               TorpedoTrip[]
   dateTimeStartFill         DateTime?           @db.DateTimeOffset
   dateTimeEndFill           DateTime?           @db.DateTimeOffset
   identityBlastFurnace      Int
@@ -154,6 +217,13 @@ model HotMetal {
   @@unique(name: "cast_torpedo_id", [castSequence, torpedoId])
 }
 
+/// **LAB RESULT**
+///
+/// _Hot Metal_ testing data from the **LIMS** laboratory integration.
+///
+/// Describes the time, type, and chemical analysis properties for a batch of
+/// _Hot Metal_. Samples are typically taken when filling at the **Blast Furnace**,
+/// and following **Desulphurisation** treatment(s).
 model HotMetalLabResult {
   id                   Int      @id @default(autoincrement())
   testSampleId         String   @unique(sort: Desc)
@@ -177,6 +247,12 @@ model HotMetalLabResult {
   updatedAt            DateTime @updatedAt
 }
 
+/// **LOCATION**
+///
+/// An operational location where _Torpedoes_ may be placed during use.
+///
+/// Within the context of **HMM**, a _Location_ defines the physical place where a
+/// _Torpedo_ is located, which is more precise than its _Station_.
 model Location {
   id                               Int                    @id @default(autoincrement())
   name                             String
@@ -189,6 +265,12 @@ model Location {
   torpedoLocations                 TorpedoLocation[]
 }
 
+/// **STATION**
+///
+/// A logical location where different _Torpedo_ operations may occur.
+///
+/// _Stations_ are logical groupings of physical locations that are linked based
+/// on their (general) operational purpose.
 model Station {
   id                               Int                    @id @default(autoincrement())
   name                             String
@@ -201,6 +283,14 @@ model Station {
   eventsTorpedoMovementDestination EventTorpedoMovement[] @relation(name: "destinationStation-movement")
 }
 
+/// **TORPEDO LADLE**
+///
+/// Physical rail-based equipment used to carry _Hot Metal_ between _Locations_.
+///
+/// _Torpedoes_ carry out work and undergo maintenance in their normal operation.
+/// Their job is to get _Hot Metal_ from the **Blast Furnace(s)** to the **BOS**. The
+/// system cares about how efficiently that's happening, and how much total
+/// work they do.
 model Torpedo {
   id                       Int                    @id @default(autoincrement())
   torpedoId                Int                    @unique(sort: Desc)
@@ -227,12 +317,19 @@ model Torpedo {
   torpedoComments          TorpedoComment[]
   hmhComments              HMHComment[]
   eventsTorpedoMovement    EventTorpedoMovement[]
+  campaignsRebricking      CampaignRebricking[]
+  campaignsSurvey          CampaignSurvey[]
+  torpedoCycle             TorpedoCycle[]
+  torpedoTrips             TorpedoTrip[]
   torpedoState             TorpedoState?          @relation(fields: [torpedoStateId], references: [id])
   torpedoStateId           Int?
   createdAt                DateTime               @default(now())
   updatedAt                DateTime               @updatedAt
 }
 
+/// **TORPEDO COMMENT**
+///
+/// Stores comments for specific _Torpedoes_, logged by **HMC Operators**.
 model TorpedoComment {
   id        Int       @id @default(autoincrement())
   torpedo   Torpedo   @relation(fields: [torpedoId], references: [torpedoId], onDelete: NoAction, onUpdate: Cascade)
@@ -243,6 +340,30 @@ model TorpedoComment {
   updatedAt DateTime? @updatedAt
 }
 
+/// **TORPEDO CYCLE**
+///
+/// Used to capture each period between consecutive _Torpedo_ filling events.
+///
+/// Defined by: 
+/// - Start: **Blast Furnace** finish filling _Torpedo Ladle_
+/// - End: Next **Blast Furnace** finish filling _Torpedo Ladle_
+model TorpedoCycle {
+  id                    Int                    @id @default(autoincrement())
+  hotMetal              HotMetal               @relation(fields: [hotMetalId], references: [id], onDelete: NoAction, onUpdate: NoAction)
+  hotMetalId            Int
+  torpedo               Torpedo                @relation(fields: [torpedoId], references: [torpedoId], onDelete: NoAction, onUpdate: NoAction)
+  torpedoId             Int
+  eventsTorpedoMovement EventTorpedoMovement[]
+  startTime             DateTime               @default(now()) @db.DateTimeOffset
+  endTime               DateTime?              @db.DateTimeOffset
+}
+
+/// **TORPEDO LOCATION**
+///
+/// Defines the current operational _Location_ for each _Torpedo_.
+///
+/// The `position` property is only significant for _Stations_, representing
+/// their physical sequence on the actual rail siding that they're occupying.
 model TorpedoLocation {
   stationId  Int
   station    Station  @relation(fields: [stationId], references: [id], onDelete: NoAction, onUpdate: Cascade)
@@ -257,6 +378,9 @@ model TorpedoLocation {
   @@id([stationId, position])
 }
 
+/// **TORPEDO STATE**
+///
+/// Describes a valid operational _State_ that a _Torpedo_ can be assigned.
 model TorpedoState {
   id          Int       @id @default(autoincrement())
   name        String    @unique
@@ -264,3 +388,25 @@ model TorpedoState {
   description String
   torpedoes   Torpedo[]
 }
+
+/// **TORPEDO TRIP (ON LINING)**
+///
+/// The period between finishing a fill, and consuming that _Hot Metal_.
+///
+/// Defined by:
+/// - Start: **Blast Furnace** finish filling _Torpedo Ladle_
+/// - End: _Torpedo Ladle_ fully emptied at **BOS Weighbridge** or **21 Dump**
+model TorpedoTrip {
+  id                    Int                    @id @default(autoincrement())
+  campaignRebricking    CampaignRebricking     @relation(fields: [campaignRebrickingId], references: [id], onDelete: NoAction, onUpdate: NoAction)
+  campaignRebrickingId  Int
+  campaignSurvey        CampaignSurvey         @relation(fields: [campaignSurveyId], references: [id], onDelete: NoAction, onUpdate: NoAction)
+  campaignSurveyId      Int
+  hotMetal              HotMetal               @relation(fields: [hotMetalId], references: [id], onDelete: NoAction, onUpdate: NoAction)
+  hotMetalId            Int
+  torpedo               Torpedo                @relation(fields: [torpedoId], references: [torpedoId], onDelete: NoAction, onUpdate: NoAction)
+  torpedoId             Int
+  eventsTorpedoMovement EventTorpedoMovement[]
+  startTime             DateTime               @default(now()) @db.DateTimeOffset
+  endTime               DateTime?              @db.DateTimeOffset
+}