@duplojs/agents-kit 0.1.0-beta.3 → 0.1.0-beta.6

package/docs/concepts/05-type-driven-design/fixtures/business/applications/useCases/withdrawBook.ts

@@ -0,0 +1,32 @@
+import * as DInvocation from "@duplojs/lang/invocation";
+import * as DEither from "@duplojs/lang/either";
+import { type Book, withdrawBook } from "../../domains";
+import { BookRepositoryPort, WaitingListEntryRepositoryPort } from "../ports";
+
+export const WithdrawBookUseCase = DInvocation.createReader(
+	{
+		BookRepositoryPort,
+		WaitingListEntryRepositoryPort,
+	},
+	({
+		bookRepository,
+		waitingListEntryRepository,
+	}) => (
+		params: {
+			book: Book.Entity & (Book.AvailableFlag | Book.ReservedFlag);
+		},
+	) => DEither.rightAsyncPipe(
+		params.book,
+		(book) => DInvocation.consumeWorkflow(
+			withdrawBook(book),
+			{
+				"commit/withdrawn-book": bookRepository.save,
+				"iterate/active-waiting-list-entries-for-withdrawn-book": {
+					getIterator: waitingListEntryRepository.findAllActiveByBook,
+					concurrency: 5,
+				},
+				"commit/cancelled-waiting-list-entry": waitingListEntryRepository.save,
+			},
+		),
+	),
+);

package/docs/concepts/05-type-driven-design/fixtures/business/domains/aggregates/clientGiveBackBook.ts

@@ -1,15 +1,74 @@
 import * as DInvocation from "@duplojs/lang/invocation";
-import { ClientGiveBackBook, ReturnBookFact, type Client } from "../entities";
+import { ClientGiveBackBook, ReturnBookFact, ReserveBookFact, PrepareWaitingListEntryFact } from "../entities";
 import * as DEither from "@duplojs/lang/either";
-import { type BookRepository } from "../repositories";
-
-export function clientGiveBackBook(
-	client: Client.Entity & Client.HaveBookFlag,
-) {
-	return DInvocation.createResolver({
-		client: DEither.unwrapRight(ClientGiveBackBook.run(client)),
-		book: DEither.unwrapRight(ReturnBookFact.run(client)),
-	})<{
-		rankBookAvailability: BookRepository["rankAvailability"];
-	}>();
-}
+import { type BookRepository, type WaitingListEntryRepository } from "../repositories";
+import * as DCommon from "@duplojs/lang/common";
+import { type refineLinkBetweenClientAndBorrowedBook } from "../refinements";
+
+export const clientGiveBackBook = DInvocation.createWorkflow(
+	({ commit, resolve }) => function *(
+		clientWithBorrowedBook: DInvocation.GetEvidenceResult<
+			typeof refineLinkBetweenClientAndBorrowedBook,
+			"client-with-borrowed-book"
+		>,
+	) {
+		const givenBackBook = DCommon.pipe(
+			clientWithBorrowedBook,
+			ReturnBookFact.run,
+			DEither.unwrapRight,
+		);
+
+		const clientGivenBackBook = DCommon.pipe(
+			clientWithBorrowedBook,
+			ClientGiveBackBook.run,
+			DEither.unwrapRight,
+		);
+
+		const selection: DInvocation.GetEvidenceResult<
+			WaitingListEntryRepository["findNextPendingForBook"],
+			"next-pending-waiting-list-entry" | "no-pending-waiting-list-entry"
+		> = yield *resolve("next-pending-waiting-list-entry", givenBackBook);
+
+		if (selection.waitingListEntry === null) {
+			yield *commit("book-and-client", {
+				givenBackBook,
+				clientGivenBackBook,
+			});
+
+			yield *commit("rank-availability", givenBackBook)
+				.withSignature<BookRepository["rankAvailability"]>();
+
+			return DEither.result("book-returned-without-waiting-list-entry", {
+				book: givenBackBook,
+				client: clientGivenBackBook,
+			});
+		}
+
+		const reservedBook = DCommon.pipe(
+			selection,
+			ReserveBookFact.run,
+			DEither.unwrapRight,
+		);
+
+		const readyWaitingListEntry = DCommon.pipe(
+			selection.waitingListEntry,
+			PrepareWaitingListEntryFact.run,
+			DEither.unwrapRight,
+		);
+
+		yield *commit("book-client-and-waiting-list-entry", {
+			reservedBook,
+			clientGivenBackBook,
+			readyWaitingListEntry,
+		});
+
+		yield *commit("rank-availability", reservedBook)
+			.withSignature<BookRepository["rankAvailability"]>();
+
+		return DEither.result("book-returned-and-reserved", {
+			book: reservedBook,
+			client: clientGivenBackBook,
+			waitingListEntry: readyWaitingListEntry,
+		});
+	},
+);

package/docs/concepts/05-type-driven-design/fixtures/business/domains/aggregates/clientRentBook.ts

@@ -2,15 +2,41 @@ import * as DInvocation from "@duplojs/lang/invocation";
 import { BookRentalFact, ClientRentBookFact, type Book, type Client } from "../entities";
 import * as DEither from "@duplojs/lang/either";
 import { type EmailRepository } from "../repositories/email";
+import * as DCommon from "@duplojs/lang/common";
 
-export function clientRentBook(
-	client: Client.Entity & Client.CanRentBookFlag,
-	book: Book.Entity & Book.AvailableFlag,
-) {
-	return DInvocation.createResolver({
-		client: DEither.unwrapRight(ClientRentBookFact.run(client, book)),
-		book: DEither.unwrapRight(BookRentalFact.run(client, book)),
-	})<{
-		sendInformationalEmail: EmailRepository["sendRentInformationalEmail"];
-	}>();
-}
+export const clientRentBook = DInvocation.createWorkflow(
+	({ commit }) => function *(
+		params: {
+			client: Client.Entity & Client.CanRentBookFlag;
+			book: Book.Entity & Book.AvailableFlag;
+		},
+	) {
+		const clientWithBorrowedBook = DCommon.pipe(
+			params,
+			ClientRentBookFact.run,
+			DEither.unwrapRight,
+		);
+
+		const borrowedBook = DCommon.pipe(
+			params,
+			BookRentalFact.run,
+			DEither.unwrapRight,
+		);
+
+		yield *commit("book-and-client", {
+			borrowedBook,
+			clientWithBorrowedBook,
+		});
+
+		yield *commit("send-informational-email", {
+			book: borrowedBook,
+			client: clientWithBorrowedBook,
+		})
+			.withSignature<EmailRepository["sendRentInformationalEmail"]>();
+
+		return {
+			book: borrowedBook,
+			client: clientWithBorrowedBook,
+		};
+	},
+);

package/docs/concepts/05-type-driven-design/fixtures/business/domains/aggregates/createBook.ts

@@ -1,21 +1,33 @@
-import type * as DInvocation from "@duplojs/lang/invocation";
+import * as DInvocation from "@duplojs/lang/invocation";
 import { type BookRepository } from "../repositories";
 import { CreateBookFact } from "../entities";
+import * as DCommon from "@duplojs/lang/common";
+import * as DEither from "@duplojs/lang/either";
 
-export function createBook(
-	params: {
-		id: DInvocation.GetEvidenceResult<
-			BookRepository["generateId"],
-			"generated"
-		>;
-		title: DInvocation.GetEvidenceResult<
-			BookRepository["titleIsAlreadyRegistered"],
-			"title-not-registered"
-		>;
+export const createBook = DInvocation.createWorkflow(
+	({ commit }) => function *(
+		params: {
+			id: DInvocation.GetEvidenceResult<
+				BookRepository["generateId"],
+				"generated"
+			>;
+			title: DInvocation.GetEvidenceResult<
+				BookRepository["titleIsAlreadyRegistered"],
+				"title-not-registered"
+			>;
+		},
+	) {
+		const createdBook = DCommon.pipe(
+			{
+				id: params.id,
+				title: params.title,
+			},
+			CreateBookFact.run,
+			DEither.unwrapRight,
+		);
+
+		yield *commit("book", createdBook);
+
+		return createdBook;
 	},
-) {
-	return CreateBookFact.run({
-		id: params.id,
-		title: params.title,
-	});
-}
+);

package/docs/concepts/05-type-driven-design/fixtures/business/domains/aggregates/index.ts

@@ -1,3 +1,4 @@
 export * from "./clientGiveBackBook";
 export * from "./clientRentBook";
 export * from "./createBook";
+export * from "./withdrawBook";

package/docs/concepts/05-type-driven-design/fixtures/business/domains/aggregates/withdrawBook.ts

@@ -0,0 +1,37 @@
+import * as DInvocation from "@duplojs/lang/invocation";
+import * as DCommon from "@duplojs/lang/common";
+import * as DEither from "@duplojs/lang/either";
+import { type Book, WithdrawBookFact, CancelWaitingListEntryFact } from "../entities";
+import { type WaitingListEntryRepository } from "../repositories";
+
+export const withdrawBook = DInvocation.createWorkflow(
+	({ commit, iterate }) => function *(book: Book.Entity & (Book.AvailableFlag | Book.ReservedFlag)) {
+		const withdrawnBook = DCommon.pipe(
+			book,
+			WithdrawBookFact.run,
+			DEither.unwrapRight,
+		);
+
+		yield *commit("withdrawn-book", withdrawnBook);
+
+		yield *iterate("active-waiting-list-entries-for-withdrawn-book", withdrawnBook)(function *(
+			linkedWaitingListEntry: DInvocation.GetEvidenceResult<
+				WaitingListEntryRepository["findAllActiveByBook"],
+				"active-waiting-list-entry-for-withdrawn-book"
+			>,
+		) {
+			const cancelledWaitingListEntry = DCommon.pipe(
+				{
+					waitingListEntry: linkedWaitingListEntry.waitingListEntry,
+					reason: "book-withdrawn",
+				},
+				CancelWaitingListEntryFact.run,
+				DEither.unwrapRight,
+			);
+
+			yield *commit("cancelled-waiting-list-entry", cancelledWaitingListEntry);
+		});
+
+		return withdrawnBook;
+	},
+);

package/docs/concepts/05-type-driven-design/fixtures/business/domains/entities/book/facts/create.ts

@@ -2,15 +2,13 @@ import * as DModeling from "@duplojs/lang/modeling";
 import { Book } from "..";
 import * as DCommon from "@duplojs/lang/common";
 
-export type CreateBookFact = DModeling.Fact<
+export const CreateBookFact = DModeling.createFact<
 	"CreateBook",
 	{
 		id: Book.Id;
+		title: Book.Title;
 		state: Book.AvailableState;
-	}
->;
-export const CreateBookFact = DModeling.createFact<
-	CreateBookFact,
+	},
 	typeof Book.Entity
 >("CreateBook")(
 	({ applyFact }) => (
@@ -32,3 +30,4 @@ export const CreateBookFact = DModeling.createFact<
 		);
 	},
 );
+export type CreateBookFact = DModeling.GetFact<typeof CreateBookFact>;

package/docs/concepts/05-type-driven-design/fixtures/business/domains/entities/book/facts/index.ts

@@ -1,3 +1,5 @@
 export * from "./create";
 export * from "./rental";
 export * from "./returnBook";
+export * from "./reserve";
+export * from "./withdraw";

package/docs/concepts/05-type-driven-design/fixtures/business/domains/entities/book/facts/rental.ts

@@ -3,24 +3,23 @@ import { type Client } from "../../client";
 import { Book } from "..";
 import * as DCommon from "@duplojs/lang/common";
 
-export type BookRentalFact = DModeling.Fact<
-	"BookRental",
-	Book.BorrowedState
->;
 export const BookRentalFact = DModeling.createFact<
-	BookRentalFact,
+	"BookRental",
+	Book.BorrowedState,
 	typeof Book.Entity
 >("BookRental")(
 	({ applyFact }) => (
-		client: Client.Entity & Client.CanRentBookFlag,
-		book: Book.Entity & Book.AvailableFlag,
+		params: {
+			client: Client.Entity & Client.CanRentBookFlag;
+			book: Book.Entity & Book.AvailableFlag;
+		},
 	) => {
 		const borrowedState = Book.BorrowedState.new({
-			currentBorrowerId: client.id,
+			currentBorrowerId: params.client.id,
 		});
 
 		return DCommon.pipe(
-			book,
+			params.book,
 			Book.Entity.update({
 				state: borrowedState,
 			}),
@@ -29,3 +28,4 @@ export const BookRentalFact = DModeling.createFact<
 		);
 	},
 );
+export type BookRentalFact = DModeling.GetFact<typeof BookRentalFact>;

package/docs/concepts/05-type-driven-design/fixtures/business/domains/entities/book/facts/reserve.ts

@@ -0,0 +1,37 @@
+import * as DModeling from "@duplojs/lang/modeling";
+import * as DCommon from "@duplojs/lang/common";
+import { Book } from "..";
+import { type Client } from "../../client";
+import { type WaitingListEntry } from "../../waitingListEntry";
+
+export const ReserveBookFact = DModeling.createFact<
+	"ReserveBook",
+	{
+		waitingListEntryId: WaitingListEntry.Id;
+		clientId: Client.Id;
+	},
+	typeof Book.Entity
+>("ReserveBook")(
+	({ applyFact }) => (
+		params: {
+			book: Book.Entity & Book.AvailableFlag;
+			waitingListEntry: WaitingListEntry.Entity & WaitingListEntry.PendingFlag;
+		},
+	) => {
+		const payload = {
+			waitingListEntryId: params.waitingListEntry.id,
+			clientId: params.waitingListEntry.clientId,
+		};
+		const state = Book.ReservedState.new({
+			waitingListEntryId: payload.waitingListEntryId,
+		});
+
+		return DCommon.pipe(
+			params.book,
+			Book.Entity.update({ state }),
+			Book.ReservedFlag.append(state),
+			applyFact(payload),
+		);
+	},
+);
+export type ReserveBookFact = DModeling.GetFact<typeof ReserveBookFact>;

package/docs/concepts/05-type-driven-design/fixtures/business/domains/entities/book/facts/returnBook.ts

@@ -1,21 +1,22 @@
 import * as DModeling from "@duplojs/lang/modeling";
-import { Client } from "../../client";
+import { type Client } from "../../client";
 import { Book } from "..";
 import * as DCommon from "@duplojs/lang/common";
 
-export type ReturnBookFact = DModeling.Fact<
-	"ReturnBook",
-	Client.Id
->;
 export const ReturnBookFact = DModeling.createFact<
-	ReturnBookFact,
+	"ReturnBook",
+	Client.Id,
 	typeof Book.Entity
 >("ReturnBook")(
 	({ applyFact }) => (
-		client: Client.Entity & Client.HaveBookFlag,
+		{
+			client,
+			book,
+		}: {
+			client: Client.Entity;
+			book: Book.Entity & Book.BorrowedFlag;
+		},
 	) => {
-		const book = Client.HaveBookFlag.getPayload(client);
-
 		const availableState = Book.AvailableState.new({});
 
 		return DCommon.pipe(
@@ -28,3 +29,4 @@ export const ReturnBookFact = DModeling.createFact<
 		);
 	},
 );
+export type ReturnBookFact = DModeling.GetFact<typeof ReturnBookFact>;

package/docs/concepts/05-type-driven-design/fixtures/business/domains/entities/book/facts/withdraw.ts

@@ -0,0 +1,21 @@
+import * as DModeling from "@duplojs/lang/modeling";
+import * as DCommon from "@duplojs/lang/common";
+import { Book } from "..";
+
+export const WithdrawBookFact = DModeling.createFact<
+	"WithdrawBook",
+	Book.WithdrawnState,
+	typeof Book.Entity
+>("WithdrawBook")(
+	({ applyFact }) => (book: Book.Entity & (Book.AvailableFlag | Book.ReservedFlag)) => {
+		const state = Book.WithdrawnState.new({});
+
+		return DCommon.pipe(
+			book,
+			Book.Entity.update({ state }),
+			Book.WithdrawnFlag.append(state),
+			applyFact(state),
+		);
+	},
+);
+export type WithdrawBookFact = DModeling.GetFact<typeof WithdrawBookFact>;

package/docs/concepts/05-type-driven-design/fixtures/business/domains/entities/book/index.ts

@@ -3,7 +3,8 @@ import * as DModeling from "@duplojs/lang/modeling";
 import { Client } from "../client";
 import * as DPattern from "@duplojs/lang/pattern";
 import * as DEither from "@duplojs/lang/either";
-import { type CreateBookFact, type BookRentalFact, type ReturnBookFact } from "./facts";
+import { type CreateBookFact, type BookRentalFact, type ReturnBookFact, type ReserveBookFact, type WithdrawBookFact } from "./facts";
+import { WaitingListEntry } from "../waitingListEntry";
 
 export * from "./facts";
 
@@ -33,12 +34,22 @@ export namespace Book {
 	);
 	export type BorrowedState = DDataStructure.StructureValue<typeof BorrowedState>;
 
+	export const ReservedState = DModeling.createTaggedObject("ReservedState", {
+		waitingListEntryId: WaitingListEntry.Id,
+	});
+	export type ReservedState = DDataStructure.StructureValue<typeof ReservedState>;
+
+	export const WithdrawnState = DModeling.createTaggedObject("WithdrawnState", {});
+	export type WithdrawnState = DDataStructure.StructureValue<typeof WithdrawnState>;
+
 	export const Entity = namespace.createEntity(() => ({
 		id: Id,
 		title: Title,
 		state: DDataStructure.union([
 			AvailableState,
 			BorrowedState,
+			ReservedState,
+			WithdrawnState,
 		]),
 	}));
 	export type Entity = DDataStructure.StructureValue<typeof Entity>;
@@ -47,25 +58,37 @@ export namespace Book {
 		| CreateBookFact
 		| BookRentalFact
 		| ReturnBookFact
+		| ReserveBookFact
+		| WithdrawBookFact
 	);
 
-	export type AvailableFlag = DModeling.Flag<
-		"Available",
-		AvailableState
-	>;
 	export const AvailableFlag = DModeling.createFlag<
-		AvailableFlag,
+		"Available",
+		AvailableState,
 		typeof Entity
 	>("Available");
+	export type AvailableFlag = DModeling.GetFlag<typeof AvailableFlag>;
 
-	export type BorrowedFlag = DModeling.Flag<
-		"Borrowed",
-		BorrowedState
-	>;
 	export const BorrowedFlag = DModeling.createFlag<
-		BorrowedFlag,
+		"Borrowed",
+		BorrowedState,
 		typeof Entity
 	>("Borrowed");
+	export type BorrowedFlag = DModeling.GetFlag<typeof BorrowedFlag>;
+
+	export const ReservedFlag = DModeling.createFlag<
+		"Reserved",
+		ReservedState,
+		typeof Entity
+	>("Reserved");
+	export type ReservedFlag = DModeling.GetFlag<typeof ReservedFlag>;
+
+	export const WithdrawnFlag = DModeling.createFlag<
+		"Withdrawn",
+		WithdrawnState,
+		typeof Entity
+	>("Withdrawn");
+	export type WithdrawnFlag = DModeling.GetFlag<typeof WithdrawnFlag>;
 
 	export function refineState<
 		GenericEntity extends Entity,
@@ -81,6 +104,14 @@ export namespace Book {
 					"BorrowedState",
 					BorrowedFlag.append(entity, state),
 				),
+				ReservedState: (state) => DEither.result(
+					"ReservedState",
+					ReservedFlag.append(entity, state),
+				),
+				WithdrawnState: (state) => DEither.result(
+					"WithdrawnState",
+					WithdrawnFlag.append(entity, state),
+				),
 			},
 		);
 	}

package/docs/concepts/05-type-driven-design/fixtures/business/domains/entities/client/facts/giveBackBook.ts

@@ -4,22 +4,23 @@ import { type Book } from "../../book";
 import * as DArray from "@duplojs/lang/array";
 import * as DCommon from "@duplojs/lang/common";
 
-export type ClientGiveBackBook = DModeling.Fact<
-	"ClientGiveBackBook",
-	Book.Entity
->;
 export const ClientGiveBackBook = DModeling.createFact<
-	ClientGiveBackBook,
+	"ClientGiveBackBook",
+	Book.Entity,
 	typeof Client.Entity
 >("ClientGiveBackBook")(
 	({ applyFact }) => (
-		client: Client.Entity & Client.HaveBookFlag,
+		{
+			client,
+			book,
+		}: {
+			client: Client.Entity;
+			book: Book.Entity & Book.BorrowedFlag;
+		},
 	) => {
-		const book = Client.HaveBookFlag.getPayload(client);
-
 		const borrowedBooks = DArray.filter(
 			client.borrowedBooks,
-			(bookId) => bookId === book.id,
+			(bookId) => bookId !== book.id,
 		);
 
 		return DCommon.pipe(
@@ -31,3 +32,4 @@ export const ClientGiveBackBook = DModeling.createFact<
 		);
 	},
 );
+export type ClientGiveBackBook = DModeling.GetFact<typeof ClientGiveBackBook>;

package/docs/concepts/05-type-driven-design/fixtures/business/domains/entities/client/facts/rentBook.ts

@@ -4,25 +4,24 @@ import { type Book } from "../../book";
 import * as DArray from "@duplojs/lang/array";
 import * as DCommon from "@duplojs/lang/common";
 
-export type ClientRentBookFact = DModeling.Fact<
-	"ClientRentBookFact",
-	Client.Entity["borrowedBooks"]
->;
 export const ClientRentBookFact = DModeling.createFact<
-	ClientRentBookFact,
+	"ClientRentBookFact",
+	Client.Entity["borrowedBooks"],
 	typeof Client.Entity
 >("ClientRentBookFact")(
 	({ applyFact }) => (
-		client: Client.Entity & Client.CanRentBookFlag,
-		book: Book.Entity & Book.AvailableFlag,
+		params: {
+			client: Client.Entity & Client.CanRentBookFlag;
+			book: Book.Entity & Book.AvailableFlag;
+		},
 	) => {
 		const borrowedBooks = DArray.push(
-			Client.CanRentBookFlag.getPayload(client),
-			book.id,
+			Client.CanRentBookFlag.getPayload(params.client),
+			params.book.id,
 		);
 
 		return DCommon.pipe(
-			client,
+			params.client,
 			Client.Entity.update({
 				borrowedBooks,
 			}),
@@ -30,3 +29,4 @@ export const ClientRentBookFact = DModeling.createFact<
 		);
 	},
 );
+export type ClientRentBookFact = DModeling.GetFact<typeof ClientRentBookFact>;

package/docs/concepts/05-type-driven-design/fixtures/business/domains/entities/client/index.ts

@@ -27,23 +27,19 @@ export namespace Client {
 		| ClientGiveBackBook
 	);
 
-	export type CanRentBookFlag = DModeling.Flag<
-		"CanRentBook",
-		readonly Book.Id[] & DArray.MaxElements<4>
-	>;
 	export const CanRentBookFlag = DModeling.createFlag<
-		CanRentBookFlag,
+		"CanRentBook",
+		readonly Book.Id[] & DArray.MaxElements<4>,
 		typeof Entity
 	>("CanRentBook");
+	export type CanRentBookFlag = DModeling.GetFlag<typeof CanRentBookFlag>;
 
-	export type NoBookRentalSlotsAvailableFlag = DModeling.Flag<
-		"NoBookRentalSlotsAvailable",
-		undefined
-	>;
 	export const NoBookRentalSlotsAvailableFlag = DModeling.createFlag<
-		NoBookRentalSlotsAvailableFlag,
+		"NoBookRentalSlotsAvailable",
+		undefined,
 		typeof Entity
 	>("NoBookRentalSlotsAvailable");
+	export type NoBookRentalSlotsAvailableFlag = DModeling.GetFlag<typeof NoBookRentalSlotsAvailableFlag>;
 
 	export function canRentBook<
 		GenericEntity extends Entity,
@@ -60,23 +56,4 @@ export namespace Client {
 			);
 		}
 	}
-
-	export type HaveBookFlag = DModeling.Flag<
-		"HaveBook",
-		Book.Entity
-	>;
-	export const HaveBookFlag = DModeling.createFlag<
-		HaveBookFlag,
-		typeof Entity
-	>("HaveBook");
-	export function clientHaveBook(client: Entity, book: Book.Entity) {
-		if (DArray.includes(client.borrowedBooks, book.id)) {
-			return DEither.right(
-				"client-have-book",
-				HaveBookFlag.append(client, book),
-			);
-		}
-
-		return DEither.left("client-not-have-book");
-	}
 }

package/docs/concepts/05-type-driven-design/fixtures/business/domains/entities/index.ts

@@ -1,2 +1,3 @@
 export * from "./book";
 export * from "./client";
+export * from "./waitingListEntry";