@tiboli/types 0.0.10 → 0.0.12

package/README.md

@@ -5,3 +5,120 @@ Here you can find all the type definitions for [TiBoLi](https://tiboli.tech4web.
 ## Contributing
 
 If you want to Contribute, make sure to follow the Guidelines highlighted in `CONTRIBUTING.md`
+
+## Documentation
+
+The following Zod schemas define the structure of the core data entities and their corresponding creation and update payloads.
+
+### Book
+
+Represents a book in the library.
+
+| Field    | Type      | Description                   |
+| -------- | --------- | ----------------------------- |
+| `id`     | `integer` | Unique identifier of the book |
+| `title`  | `string`  | Title of the book             |
+| `author` | `string`  | Author of the book            |
+
+#### Variants
+
+* **`BookSchema`** — Complete book object.
+* **`BookCreationSchema`** — Book data for creation. Omits `id`.
+* **`BookUpdateSchema`** — Partial book update. Requires `id`; all other fields are optional.
+
+---
+
+### Copy
+
+Represents a physical copy of a book.
+
+| Field    | Type      | Description                         |
+| -------- | --------- | ----------------------------------- |
+| `id`     | `integer` | Unique identifier of the copy       |
+| `bookId` | `integer` | ID of the book this copy belongs to |
+
+#### Variants
+
+* **`CopySchema`** — Complete copy object.
+* **`CopyCreationSchema`** — Copy data for creation. Omits `id`.
+* **`CopyUpdateSchema`** — Partial copy update. Requires `id`; all other fields are optional.
+
+---
+
+### Customer
+
+Represents a customer or borrower in the library.
+
+| Field      | Type      | Description                         |
+| ---------- | --------- | ----------------------------------- |
+| `id`       | `integer` | Unique identifier of the customer   |
+| `name`     | `string`  | First name of the customer          |
+| `lastname` | `string`  | Last name of the customer           |
+| `email`    | `email`   | Valid email address of the customer |
+
+#### Variants
+
+* **`CustomerSchema`** — Complete customer object.
+* **`CustomerCreationSchema`** — Customer data for creation. Omits `id`.
+* **`CustomerUpdateSchema`** — Partial customer update. Requires `id`; all other fields are optional.
+
+---
+
+### Group
+
+Represents a group of customers.
+
+| Field  | Type      | Description                    |
+| ------ | --------- | ------------------------------ |
+| `id`   | `integer` | Unique identifier of the group |
+| `name` | `string`  | Name of the group              |
+
+#### Variants
+
+* **`GroupSchema`** — Complete group object.
+* **`GroupCreationSchema`** — Group data for creation. Omits `id`.
+* **`GroupUpdateSchema`** — Partial group update. Requires `id`; all other fields are optional.
+
+---
+
+### Loan
+
+Represents a loan of a physical book copy to a customer.
+
+| Field        | Type      | Description                              |
+| ------------ | --------- | ---------------------------------------- |
+| `id`         | `integer` | Unique identifier of the loan            |
+| `copyId`     | `integer` | ID of the borrowed book copy             |
+| `customerId` | `integer` | ID of the customer who borrowed the copy |
+| `lentDate`   | `date`    | Date on which the copy was lent          |
+| `dueDate`    | `date`    | Date on which the copy is due            |
+| `returnDate` | `date`    | Date on which the copy was returned      |
+
+#### Variants
+
+* **`LoanSchema`** — Complete loan object.
+* **`LoanCreationSchema`** — Loan data for creation. Omits `id`.
+* **`LoanUpdateSchema`** — Partial loan update. Requires `id`; all other fields are optional.
+
+### Schema Variants
+
+All entities follow the same pattern:
+
+```text
+EntitySchema
+├── EntityCreationSchema
+│   └── Omits `id`
+└── EntityUpdateSchema
+    ├── Requires `id`
+    └── Makes all other fields optional
+```
+
+This allows the schemas to be reused consistently for validating complete entities, creation requests, and partial update requests.
+
+### Inferred types
+
+Each of the Schemas get's a Type inferred using `z.infer`. The types are named `Attributes` instead of Schemas. For instance.
+
+- `EntitySchema` -> `EntityAttributes`
+- `EntityCreationSchema` -> `EntityCreationAttributes`
+

package/dist/cjs/classes/errors.class.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InternalServerError = exports.MalformedRequestError = exports.NotFoundError = exports.HttpError = exports.BaseError = void 0;
+/**
+ * Defines the Base Error class for handling Errors.
+ * @param {string} message Error message. Should be representing to the error
+ * @param {ErrorParameters} options Parameters for the Error, like cause and context.
+ * @returns {undefined}
+ */
+class BaseError extends Error {
+    context;
+    constructor(message, options = {}) {
+        const { cause, context } = options;
+        super(message, { cause });
+        this.name = this.constructor.name;
+        this.context = context;
+    }
+}
+exports.BaseError = BaseError;
+class HttpError extends BaseError {
+    statusCode;
+    descriptorString;
+    constructor(message, status, descriptor, options = {}) {
+        super(message, options);
+        this.statusCode = status;
+        this.descriptorString = descriptor;
+    }
+    toResponse() {
+        return this.descriptorString;
+    }
+}
+exports.HttpError = HttpError;
+class NotFoundError extends HttpError {
+    constructor(message, options = {}) {
+        super(message, 404, 'Entity not found', options);
+    }
+}
+exports.NotFoundError = NotFoundError;
+class MalformedRequestError extends HttpError {
+    constructor(message, options = {}) {
+        super(message, 400, 'Malformed Request', options);
+    }
+}
+exports.MalformedRequestError = MalformedRequestError;
+class InternalServerError extends HttpError {
+    constructor(message, options = {}) {
+        super(message, 500, 'Internal Server Error', options);
+    }
+}
+exports.InternalServerError = InternalServerError;

package/dist/cjs/classes/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InternalServerError = exports.MalformedRequestError = exports.NotFoundError = exports.HttpError = exports.BaseError = void 0;
+var errors_class_js_1 = require("./errors.class.js");
+Object.defineProperty(exports, "BaseError", { enumerable: true, get: function () { return errors_class_js_1.BaseError; } });
+Object.defineProperty(exports, "HttpError", { enumerable: true, get: function () { return errors_class_js_1.HttpError; } });
+Object.defineProperty(exports, "NotFoundError", { enumerable: true, get: function () { return errors_class_js_1.NotFoundError; } });
+Object.defineProperty(exports, "MalformedRequestError", { enumerable: true, get: function () { return errors_class_js_1.MalformedRequestError; } });
+Object.defineProperty(exports, "InternalServerError", { enumerable: true, get: function () { return errors_class_js_1.InternalServerError; } });

package/dist/cjs/{index.cjs → index.js}

@@ -16,3 +16,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./schemas"), exports);
 __exportStar(require("./types"), exports);
+__exportStar(require("./classes"), exports);

package/dist/cjs/package.json

@@ -0,0 +1,3 @@
+{
+	"type": "commonjs"
+}

package/dist/cjs/types/utility.type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/esm/classes/errors.class.js

@@ -0,0 +1,43 @@
+/**
+ * Defines the Base Error class for handling Errors.
+ * @param {string} message Error message. Should be representing to the error
+ * @param {ErrorParameters} options Parameters for the Error, like cause and context.
+ * @returns {undefined}
+ */
+export class BaseError extends Error {
+    context;
+    constructor(message, options = {}) {
+        const { cause, context } = options;
+        super(message, { cause });
+        this.name = this.constructor.name;
+        this.context = context;
+    }
+}
+export class HttpError extends BaseError {
+    statusCode;
+    descriptorString;
+    constructor(message, status, descriptor, options = {}) {
+        super(message, options);
+        this.statusCode = status;
+        this.descriptorString = descriptor;
+    }
+    toResponse() {
+        return this.descriptorString;
+    }
+}
+export class NotFoundError extends HttpError {
+    constructor(message, options = {}) {
+        super(message, 404, 'Entity not found', options);
+    }
+}
+export class MalformedRequestError extends HttpError {
+    constructor(message, options = {}) {
+        super(message, 400, 'Malformed Request', options);
+    }
+}
+export class InternalServerError extends HttpError {
+    constructor(message, options = {}) {
+        super(message, 500, 'Internal Server Error', options);
+    }
+}
+//# sourceMappingURL=errors.class.js.map

package/dist/esm/classes/errors.class.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.class.js","sourceRoot":"","sources":["../../../src/classes/errors.class.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AAEH,MAAM,OAAO,SAAU,SAAQ,KAAK;IACnB,OAAO,CAAY;IAEnC,YAAY,OAAe,EAAE,UAA2B,EAAE;QACzD,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;QAEnC,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAC1B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;QAElC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACxB,CAAC;CACD;AAED,MAAM,OAAO,SAAU,SAAQ,SAAS;IACvB,UAAU,CAAS;IACnB,gBAAgB,CAAS;IAEzC,YACC,OAAe,EACf,MAAc,EACd,UAAkB,EAClB,UAA2B,EAAE;QAE7B,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACxB,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC;QACzB,IAAI,CAAC,gBAAgB,GAAG,UAAU,CAAC;IACpC,CAAC;IACM,UAAU;QAChB,OAAO,IAAI,CAAC,gBAAgB,CAAC;IAC9B,CAAC;CACD;AACD,MAAM,OAAO,aAAc,SAAQ,SAAS;IAC3C,YAAY,OAAe,EAAE,UAA2B,EAAE;QACzD,KAAK,CAAC,OAAO,EAAE,GAAG,EAAE,kBAAkB,EAAE,OAAO,CAAC,CAAC;IAClD,CAAC;CACD;AACD,MAAM,OAAO,qBAAsB,SAAQ,SAAS;IACnD,YAAY,OAAe,EAAE,UAA2B,EAAE;QACzD,KAAK,CAAC,OAAO,EAAE,GAAG,EAAE,mBAAmB,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;CACD;AAED,MAAM,OAAO,mBAAoB,SAAQ,SAAS;IACjD,YAAY,OAAe,EAAE,UAA2B,EAAE;QACzD,KAAK,CAAC,OAAO,EAAE,GAAG,EAAE,uBAAuB,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;CACD"}

package/dist/esm/classes/index.js

@@ -0,0 +1,2 @@
+export { BaseError, HttpError, NotFoundError, MalformedRequestError, InternalServerError, } from './errors.class.js';
+//# sourceMappingURL=index.js.map

package/dist/esm/classes/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/classes/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,SAAS,EACT,SAAS,EACT,aAAa,EACb,qBAAqB,EACrB,mBAAmB,GACnB,MAAM,mBAAmB,CAAC"}

package/dist/esm/index.js

@@ -1,3 +1,4 @@
 export * from './schemas';
 export * from './types';
+export * from './classes';
 //# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,WAAW,CAAC"}

package/dist/esm/types/utility.type.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=utility.type.js.map

package/dist/esm/types/utility.type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utility.type.js","sourceRoot":"","sources":["../../../src/types/utility.type.ts"],"names":[],"mappings":""}

package/dist/types/classes/errors.class.d.ts

@@ -0,0 +1,26 @@
+import { ErrorParameters, Jsonable } from '../types';
+/**
+ * Defines the Base Error class for handling Errors.
+ * @param {string} message Error message. Should be representing to the error
+ * @param {ErrorParameters} options Parameters for the Error, like cause and context.
+ * @returns {undefined}
+ */
+export declare class BaseError extends Error {
+    readonly context?: Jsonable;
+    constructor(message: string, options?: ErrorParameters);
+}
+export declare class HttpError extends BaseError {
+    readonly statusCode: number;
+    readonly descriptorString: string;
+    constructor(message: string, status: number, descriptor: string, options?: ErrorParameters);
+    toResponse(): string;
+}
+export declare class NotFoundError extends HttpError {
+    constructor(message: string, options?: ErrorParameters);
+}
+export declare class MalformedRequestError extends HttpError {
+    constructor(message: string, options?: ErrorParameters);
+}
+export declare class InternalServerError extends HttpError {
+    constructor(message: string, options?: ErrorParameters);
+}

package/dist/types/classes/index.d.ts

@@ -0,0 +1 @@
+export { BaseError, HttpError, NotFoundError, MalformedRequestError, InternalServerError, } from './errors.class.js';

package/dist/types/index.d.ts

@@ -1,2 +1,3 @@
 export * from './schemas';
 export * from './types';
+export * from './classes';

package/dist/types/types/index.d.ts

@@ -3,3 +3,4 @@ export { CopyAttributes, CopyCreationAttributes, CopyUpdateAttributes } from './
 export { CustomerAttributes, CustomerCreationAttributes, CustomerUpdateAttributes, } from './customer.type';
 export { GroupAttributes, GroupCreationAttributes, GroupUpdateAttributes } from './group.types';
 export { LoanAttributes, LoanCreationAttributes, LoanUpdateAttributes } from './loan.type';
+export { Jsonable, ErrorParameters } from './utility.type.js';

package/dist/types/types/utility.type.d.ts

@@ -0,0 +1,9 @@
+export type Jsonable = string | number | boolean | null | undefined | readonly Jsonable[] | {
+    readonly [key: string]: Jsonable;
+} | {
+    toJSON(): Jsonable;
+};
+export type ErrorParameters = {
+    context?: Jsonable;
+    cause?: Jsonable;
+};

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@tiboli/types",
 	"scope": "@tiboli",
-	"version": "0.0.10",
+	"version": "0.0.12",
 	"description": "Typedefinitions for Tiboli",
 	"keywords": [
 		"tiboli",
@@ -15,24 +15,24 @@
 	"files": [
 		"dist"
 	],
-	"main": "./dist/cjs/index.cjs",
+	"main": "./dist/cjs/index.js",
 	"module": "./dist/esm/index.js",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
 			"types": "./dist/types/index.d.ts",
 			"import": "./dist/esm/index.js",
-			"require": "./dist/cjs/index.cjs"
+			"require": "./dist/cjs/index.js"
 		},
 		"./schemas": {
 			"types": "./dist/types/schemas/index.d.ts",
 			"import": "./dist/esm/schemas/index.js",
-			"require": "./dist/cjs/schemas/index.cjs"
+			"require": "./dist/cjs/schemas/index.js"
 		},
 		"./types": {
 			"types": "./dist/types/types/index.d.ts",
 			"import": "./dist/esm/types/index.js",
-			"require": "./dist/cjs/types/index.cjs"
+			"require": "./dist/cjs/types/index.js"
 		}
 	},
 	"scripts": {
@@ -45,6 +45,7 @@
 		"dev": "tsx watch -r tsconfig-paths/register src",
 		"prepare": "husky",
 		"lint": "eslint --max-warnings=0 .",
+		"lint:fix": "eslint --max-warnings=0 --fix .",
 		"lint:staged": "lint-staged",
 		"test": "jest --passWithNoTests"
 	},