hhe/vapor-po
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

feat: Adds some documenation comments

Browse Source
This commit is contained in:
Michael Housh
2025-01-27 10:20:33 -05:00
parent f3ffdbf41b
commit a7df4f349f
11 changed files with 78 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
Sources/SharedModels/Employee.swift
View File

@@ -1,6 +1,9 @@
import Dependencies
import Foundation
/// Represents an employee database model.
///
/// Employee's are who purchase orders can be generated for.
public struct Employee: Codable, Equatable, Identifiable, Sendable {
public var id: UUID
public var active: Bool
@@ -31,6 +34,8 @@ public struct Employee: Codable, Equatable, Identifiable, Sendable {
}
public extension Employee {
/// Represents the required fields for generating a new employee in the
/// database.
struct Create: Codable, Sendable, Equatable {
public let firstName: String
public let lastName: String
@@ -47,6 +52,8 @@ public extension Employee {
}
}
/// Represents the required fields for updating an existing employee in the
/// database.
struct Update: Codable, Sendable, Equatable {
public let firstName: String?
public let lastName: String?

11
Sources/SharedModels/PurchaseOrder.swift
View File

@@ -1,6 +1,11 @@
import Dependencies
import Foundation
/// Represents a purchase order database model.
///
/// A purchase order is generated on behalf of an `Employee` and issued to
/// a `VendorBranch`. It includes information about the customer / job it was created
/// for, the materials that were purchased, etc.
public struct PurchaseOrder: Codable, Equatable, Identifiable, Sendable {
public let id: Int
@@ -41,6 +46,7 @@ public struct PurchaseOrder: Codable, Equatable, Identifiable, Sendable {
public extension PurchaseOrder {
/// Represents the required fields for generating a new purchase order in the database.
struct Create: Codable, Sendable, Equatable {
public let id: Int?
@@ -73,6 +79,9 @@ public extension PurchaseOrder {
}
}
/// Represents the required fields for generating a new purchase order in the database,
/// without the user information who is issuing the request, which get's parsed from the
/// currently authenticated user's session and is used to generate the full `Create` request.
struct CreateIntermediate: Codable, Sendable, Equatable {
public let id: Int?
@@ -115,6 +124,8 @@ public extension PurchaseOrder {
}
}
/// Represents the context to search or filter purchase orders based on the
/// given parameters.
enum SearchContext: Sendable, Equatable {
case customer(String)
case vendor(VendorBranch.ID)

3
Sources/SharedModels/Routes/ApiRoute.swift
View File

@@ -4,6 +4,9 @@ import Foundation
public extension SiteRoute {
/// Represents api routes that can be interacted with.
///
/// These routes return json information, as opposed to html like the view routes.
enum Api: Sendable, Equatable {
case employee(EmployeeRoute)

1
Sources/SharedModels/Routes/SiteRoute.swift
View File

@@ -2,6 +2,7 @@ import CasePathsCore
import Foundation
@preconcurrency import URLRouting
/// Represents all the routes that our server can handle.
public enum SiteRoute: Sendable {
case api(SiteRoute.Api)
case health

4
Sources/SharedModels/Routes/ViewRoute.swift
View File

@@ -4,6 +4,10 @@ import Foundation
public extension SiteRoute {
// swiftlint:disable type_body_length
/// Represents view routes that can be interacted with.
///
/// These routes return html and are used to generate the web interface.
enum View: Sendable, Equatable {
case employee(SiteRoute.View.EmployeeRoute)

11
Sources/SharedModels/User.swift
View File

@@ -1,6 +1,11 @@
import Dependencies
import Foundation
/// Represents a user database model.
///
/// User's are who can login to the system and generate purchase orders, manage
/// employees, vendors, etc.
///
public struct User: Codable, Equatable, Identifiable, Sendable {
public var id: UUID
@@ -26,6 +31,7 @@ public struct User: Codable, Equatable, Identifiable, Sendable {
public extension User {
/// Represents the fields needed to generate a new user in the database.
struct Create: Codable, Sendable, Equatable {
public let username: String
public let email: String
@@ -45,6 +51,7 @@ public extension User {
}
}
/// Represents the fields needed for new user to login.
struct Login: Codable, Sendable, Equatable {
public let username: String?
public let email: String?
@@ -61,6 +68,7 @@ public extension User {
}
}
/// Represents the fields needed to reset the password of a user.
struct ResetPassword: Codable, Equatable, Sendable {
public let password: String
public let confirmPassword: String
@@ -74,6 +82,8 @@ public extension User {
}
}
/// Represents a user token that can be used to authenticate a user, typically
/// used for interacting with api routes remotely.
struct Token: Codable, Equatable, Identifiable, Sendable {
public let id: UUID
public let userID: User.ID
@@ -90,6 +100,7 @@ public extension User {
}
}
/// Represents the fields needed to update a user's attributes in the database.
struct Update: Codable, Equatable, Sendable {
public let username: String?
public let email: String?

6
Sources/SharedModels/Vendor.swift
View File

@@ -1,6 +1,10 @@
import Dependencies
import Foundation
/// Represents a vendor item in the database.
///
/// A vendor is parent item that contains one or more branches where purchase orders
/// can be issued to. It is primarily a name space to group related branches together.
public struct Vendor: Codable, Equatable, Identifiable, Sendable {
public var id: UUID
public var name: String
@@ -25,6 +29,7 @@ public struct Vendor: Codable, Equatable, Identifiable, Sendable {
public extension Vendor {
/// Represents the fields required to generate a new vendor in the database.
struct Create: Codable, Sendable, Equatable {
public let name: String
@@ -33,6 +38,7 @@ public extension Vendor {
}
}
/// Represents the fields required to update a vendor in the database.
struct Update: Codable, Sendable, Equatable {
public let name: String

11
Sources/SharedModels/VendorBranch.swift
View File

@@ -1,6 +1,10 @@
import Dependencies
import Foundation
/// Represents a vendor branch database model.
///
/// A vendor branch is who purchase orders can be issued to on behalf an `Employee`.
/// They are associated with a particular `Vendor`.
public struct VendorBranch: Codable, Equatable, Identifiable, Sendable {
public var id: UUID
public var name: String
@@ -24,6 +28,8 @@ public struct VendorBranch: Codable, Equatable, Identifiable, Sendable {
}
public extension VendorBranch {
/// Represents the fields required to generate a new vendor branch in the database.
struct Create: Codable, Sendable, Equatable {
public let name: String
public let vendorID: Vendor.ID
@@ -34,6 +40,10 @@ public extension VendorBranch {
}
}
/// Represents the details of a vendor branch, which includes the parent vendor item.
///
/// This is used in several of the views / api routes that require information about both the
/// vendor branch and it's associated parent vendor item.
struct Detail: Codable, Equatable, Identifiable, Sendable {
public var id: UUID
public var name: String
@@ -56,6 +66,7 @@ public extension VendorBranch {
}
}
/// Represents the fields that are used to update attributes of a vendor branch in the database.
struct Update: Codable, Sendable, Equatable {
public let name: String?