[fabric-core] Improve some JSDocs, improve some names, and re-organice some files

packages/fabric/core/src/domain/entity/files/domain-file.ts

@@ -1,5 +1,5 @@
+import { BaseFile } from "../../../files/base-file.js";
 import { Entity } from "../entity.js";
-import { BaseFile } from "./base-file.js";
 
 /**
  * Represents a file as managed by the domain.

packages/fabric/core/src/domain/entity/files/image-file.ts

@@ -1,5 +1,5 @@
+import { ImageMimeType } from "../../../files/mime-type.js";
 import { DomainFile } from "./domain-file.js";
-import { ImageMimeType } from "./mime-type.js";
 
 /**
  * Represents an image file.

packages/fabric/core/src/domain/entity/files/index.ts

@@ -1,10 +1,2 @@
-export * from "./base-file.js";
-export * from "./bytes.js";
 export * from "./domain-file.js";
 export * from "./image-file.js";
-export * from "./invalid-file-type-error.js";
-export * from "./is-mime-type.js";
-export * from "./is-uploaded-file.js";
-export * from "./media-file.js";
-export * from "./mime-type.js";
-export * from "./uploaded-file.js";

packages/fabric/core/src/domain/entity/index.ts

@@ -1,2 +1 @@
 export * from "./entity.js";
-export * from "./files/index.js";

packages/fabric/core/src/domain/events/event.ts

@@ -1,5 +1,8 @@
 import { TaggedVariant } from "../../variant/variant.js";
 
+/**
+ * An event is a tagged variant with a payload and a timestamp.
+ */
 export interface Event<TTag extends string, TPayload>
   extends TaggedVariant<TTag> {
   payload: TPayload;

packages/fabric/core/src/domain/security/policy-map.ts

@@ -1,3 +1,6 @@
+/**
+ * A PolicyMap maps user types to their security policies.
+ */
 export type PolicyMap<
   UserType extends string,
   PolicyType extends string,

packages/fabric/core/src/domain/types/index.ts

@@ -1,3 +1,3 @@
 export * from "./email.js";
-export * from "./sem-ver.js";
+export * from "./semver.js";
 export * from "./uuid.js";

packages/fabric/core/src/domain/use-case/use-case.ts

@@ -3,11 +3,6 @@ import { AsyncResult } from "../../result/async-result.js";
 
 /**
  * A use case is a piece of domain logic that can be executed.
- *
- * It can be one of two types:
- *
- *  - `Query`: A use case that only reads data.
- *  - `Command`: A use case that modifies data.
  */
 export type UseCase<
   TDependencies,

packages/fabric/core/src/error/is-error.ts

@@ -1,15 +1,8 @@
-import { VariantTag } from "../variant/variant.js";
 import { TaggedError } from "./tagged-error.js";
 
 /**
  * Indicates if a value is an error.
- *
- * In case it is an error, the type of the error is able to be inferred.
  */
 export function isError(err: unknown): err is TaggedError<string> {
-  return (
+  return err instanceof TaggedError;
-    err instanceof Error &&
-    VariantTag in err &&
-    typeof err[VariantTag] === "string"
-  );
 }

packages/fabric/core/src/error/tagged-error.ts

@@ -1,9 +1,7 @@
 import { TaggedVariant, VariantTag } from "../variant/index.js";
 
 /**
- * Un TaggedError es un error que tiene un tag que lo identifica, lo cual
+ * A TaggedError is a tagged variant with an error message.
- * permite a los consumidores de la instancia de error identificar el tipo de
- * error que ocurrió.
  */
 export class TaggedError<Tag extends string>
   extends Error

packages/fabric/core/src/error/unexpected-error.ts

@@ -1,11 +1,11 @@
 import { TaggedError } from "./tagged-error.js";
 
 /**
- * `UnexpectedError` representa cualquier tipo de error inesperado.
+ * `UnexpectedError` represents any type of unexpected error.
  *
- * Este error se utiliza para representar errores que no deberían ocurrir en
+ * This error is used to represent errors that should not occur in
- * la lógica de la aplicación, pero que siempre podrían suceder y
+ * the application logic, but that could always happen and
- * debemos estar preparados para manejarlos.
+ * we must be prepared to handle.
  */
 export class UnexpectedError extends TaggedError<"UnexpectedError"> {
   constructor() {

packages/fabric/core/src/files/index.ts

@@ -0,0 +1,8 @@
+export * from "./base-file.js";
+export * from "./bytes.js";
+export * from "./invalid-file-type-error.js";
+export * from "./is-mime-type.js";
+export * from "./is-uploaded-file.js";
+export * from "./media-file.js";
+export * from "./mime-type.js";
+export * from "./uploaded-file.js";

packages/fabric/core/src/files/invalid-file-type-error.ts

@@ -1,4 +1,4 @@
-import { TaggedError } from "../../../error/tagged-error.js";
+import { TaggedError } from "../error/tagged-error.js";
 
 export class InvalidFileTypeError extends TaggedError<"InvalidFileTypeError"> {
   constructor() {

packages/fabric/core/src/files/is-mime-type.ts

@@ -5,7 +5,7 @@ import { MimeType } from "./mime-type.js";
  */
 export function isMimeType<T extends MimeType>(
   expectedMimeType: T,
-  actualFileType: string,
+  actualMimeType: string,
-): actualFileType is T {
+): actualMimeType is T {
-  return actualFileType.match("^" + expectedMimeType + "$") !== null;
+  return actualMimeType.match("^" + expectedMimeType + "$") !== null;
 }

packages/fabric/core/src/files/is-uploaded-file.ts

@@ -1,5 +1,5 @@
 import validator from "validator";
-import { isRecord } from "../../../record/is-record.js";
+import { isRecord } from "../record/is-record.js";
 import { InMemoryFile } from "./uploaded-file.js";
 
 const { isBase64, isMimeType } = validator;

packages/fabric/core/src/files/media-file.ts

@@ -1,4 +1,4 @@
-import { DomainFile } from "./domain-file.js";
+import { DomainFile } from "../domain/entity/files/domain-file.js";
 
 /**
  * Represents a media file, either an image, a video or an audio file.

packages/fabric/core/src/files/uploaded-file.ts

@@ -1,4 +1,4 @@
-import { Base64String } from "../../types/base-64.js";
+import { Base64String } from "../domain/types/base-64.js";
 import { BaseFile } from "./base-file.js";
 
 /**

packages/fabric/core/src/time/timeout.spec.ts

@@ -32,7 +32,7 @@ describe("timeout", () => {
     },
   );
 
-  test("using ms we can define a timeout in milliseconds", async () => {
+  test("using timeout we can define a timeout in milliseconds", async () => {
     const start = Date.now();
     await timeout(100);
     const end = Date.now();