@porulle/core 0.6.0 → 0.8.0

package/dist/interfaces/rest/schemas/documents.d.ts

@@ -0,0 +1,509 @@
+import { z } from "@hono/zod-openapi";
+export declare const EmailInvoiceBodySchema: z.ZodObject<{
+    to: z.ZodEmail;
+}, z.core.$strip>;
+export declare const invoicePdfRoute: {
+    method: "get";
+    path: "/{id}/invoice.pdf";
+    tags: string[];
+    summary: string;
+    request: {
+        params: z.ZodObject<{
+            id: z.ZodUUID;
+        }, z.core.$strip>;
+    };
+    responses: {
+        400: {
+            readonly content: {
+                readonly "application/json": {
+                    readonly schema: z.ZodObject<{
+                        error: z.ZodObject<{
+                            code: z.ZodString;
+                            message: z.ZodString;
+                            details: z.ZodOptional<z.ZodObject<{
+                                issues: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                                    path: z.ZodString;
+                                    message: z.ZodString;
+                                    code: z.ZodString;
+                                }, z.core.$strip>>>;
+                            }, z.core.$strip>>;
+                        }, z.core.$strip>;
+                    }, z.core.$strip>;
+                };
+            };
+            readonly description: "Business logic error.";
+        };
+        401: {
+            readonly content: {
+                readonly "application/json": {
+                    readonly schema: z.ZodObject<{
+                        error: z.ZodObject<{
+                            code: z.ZodString;
+                            message: z.ZodString;
+                            details: z.ZodOptional<z.ZodObject<{
+                                issues: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                                    path: z.ZodString;
+                                    message: z.ZodString;
+                                    code: z.ZodString;
+                                }, z.core.$strip>>>;
+                            }, z.core.$strip>>;
+                        }, z.core.$strip>;
+                    }, z.core.$strip>;
+                };
+            };
+            readonly description: "Authentication required.";
+        };
+        403: {
+            readonly content: {
+                readonly "application/json": {
+                    readonly schema: z.ZodObject<{
+                        error: z.ZodObject<{
+                            code: z.ZodString;
+                            message: z.ZodString;
+                            details: z.ZodOptional<z.ZodObject<{
+                                issues: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                                    path: z.ZodString;
+                                    message: z.ZodString;
+                                    code: z.ZodString;
+                                }, z.core.$strip>>>;
+                            }, z.core.$strip>>;
+                        }, z.core.$strip>;
+                    }, z.core.$strip>;
+                };
+            };
+            readonly description: "Insufficient permissions.";
+        };
+        404: {
+            readonly content: {
+                readonly "application/json": {
+                    readonly schema: z.ZodObject<{
+                        error: z.ZodObject<{
+                            code: z.ZodString;
+                            message: z.ZodString;
+                            details: z.ZodOptional<z.ZodObject<{
+                                issues: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                                    path: z.ZodString;
+                                    message: z.ZodString;
+                                    code: z.ZodString;
+                                }, z.core.$strip>>>;
+                            }, z.core.$strip>>;
+                        }, z.core.$strip>;
+                    }, z.core.$strip>;
+                };
+            };
+            readonly description: "Resource not found.";
+        };
+        422: {
+            readonly content: {
+                readonly "application/json": {
+                    readonly schema: z.ZodObject<{
+                        error: z.ZodObject<{
+                            code: z.ZodString;
+                            message: z.ZodString;
+                            details: z.ZodOptional<z.ZodObject<{
+                                issues: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                                    path: z.ZodString;
+                                    message: z.ZodString;
+                                    code: z.ZodString;
+                                }, z.core.$strip>>>;
+                            }, z.core.$strip>>;
+                        }, z.core.$strip>;
+                    }, z.core.$strip>;
+                };
+            };
+            readonly description: "Validation error.";
+        };
+        200: {
+            content: {
+                "application/pdf": {
+                    schema: z.ZodAny;
+                };
+            };
+            description: string;
+        };
+    };
+} & {
+    getRoutingPath(): "/:id/invoice.pdf";
+};
+export declare const invoiceHtmlRoute: {
+    method: "get";
+    path: "/{id}/invoice.html";
+    tags: string[];
+    summary: string;
+    request: {
+        params: z.ZodObject<{
+            id: z.ZodUUID;
+        }, z.core.$strip>;
+    };
+    responses: {
+        400: {
+            readonly content: {
+                readonly "application/json": {
+                    readonly schema: z.ZodObject<{
+                        error: z.ZodObject<{
+                            code: z.ZodString;
+                            message: z.ZodString;
+                            details: z.ZodOptional<z.ZodObject<{
+                                issues: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                                    path: z.ZodString;
+                                    message: z.ZodString;
+                                    code: z.ZodString;
+                                }, z.core.$strip>>>;
+                            }, z.core.$strip>>;
+                        }, z.core.$strip>;
+                    }, z.core.$strip>;
+                };
+            };
+            readonly description: "Business logic error.";
+        };
+        401: {
+            readonly content: {
+                readonly "application/json": {
+                    readonly schema: z.ZodObject<{
+                        error: z.ZodObject<{
+                            code: z.ZodString;
+                            message: z.ZodString;
+                            details: z.ZodOptional<z.ZodObject<{
+                                issues: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                                    path: z.ZodString;
+                                    message: z.ZodString;
+                                    code: z.ZodString;
+                                }, z.core.$strip>>>;
+                            }, z.core.$strip>>;
+                        }, z.core.$strip>;
+                    }, z.core.$strip>;
+                };
+            };
+            readonly description: "Authentication required.";
+        };
+        403: {
+            readonly content: {
+                readonly "application/json": {
+                    readonly schema: z.ZodObject<{
+                        error: z.ZodObject<{
+                            code: z.ZodString;
+                            message: z.ZodString;
+                            details: z.ZodOptional<z.ZodObject<{
+                                issues: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                                    path: z.ZodString;
+                                    message: z.ZodString;
+                                    code: z.ZodString;
+                                }, z.core.$strip>>>;
+                            }, z.core.$strip>>;
+                        }, z.core.$strip>;
+                    }, z.core.$strip>;
+                };
+            };
+            readonly description: "Insufficient permissions.";
+        };
+        404: {
+            readonly content: {
+                readonly "application/json": {
+                    readonly schema: z.ZodObject<{
+                        error: z.ZodObject<{
+                            code: z.ZodString;
+                            message: z.ZodString;
+                            details: z.ZodOptional<z.ZodObject<{
+                                issues: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                                    path: z.ZodString;
+                                    message: z.ZodString;
+                                    code: z.ZodString;
+                                }, z.core.$strip>>>;
+                            }, z.core.$strip>>;
+                        }, z.core.$strip>;
+                    }, z.core.$strip>;
+                };
+            };
+            readonly description: "Resource not found.";
+        };
+        422: {
+            readonly content: {
+                readonly "application/json": {
+                    readonly schema: z.ZodObject<{
+                        error: z.ZodObject<{
+                            code: z.ZodString;
+                            message: z.ZodString;
+                            details: z.ZodOptional<z.ZodObject<{
+                                issues: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                                    path: z.ZodString;
+                                    message: z.ZodString;
+                                    code: z.ZodString;
+                                }, z.core.$strip>>>;
+                            }, z.core.$strip>>;
+                        }, z.core.$strip>;
+                    }, z.core.$strip>;
+                };
+            };
+            readonly description: "Validation error.";
+        };
+        200: {
+            content: {
+                "text/html": {
+                    schema: z.ZodString;
+                };
+            };
+            description: string;
+        };
+    };
+} & {
+    getRoutingPath(): "/:id/invoice.html";
+};
+export declare const receiptHtmlRoute: {
+    method: "get";
+    path: "/{id}/receipt.html";
+    tags: string[];
+    summary: string;
+    request: {
+        params: z.ZodObject<{
+            id: z.ZodUUID;
+        }, z.core.$strip>;
+    };
+    responses: {
+        400: {
+            readonly content: {
+                readonly "application/json": {
+                    readonly schema: z.ZodObject<{
+                        error: z.ZodObject<{
+                            code: z.ZodString;
+                            message: z.ZodString;
+                            details: z.ZodOptional<z.ZodObject<{
+                                issues: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                                    path: z.ZodString;
+                                    message: z.ZodString;
+                                    code: z.ZodString;
+                                }, z.core.$strip>>>;
+                            }, z.core.$strip>>;
+                        }, z.core.$strip>;
+                    }, z.core.$strip>;
+                };
+            };
+            readonly description: "Business logic error.";
+        };
+        401: {
+            readonly content: {
+                readonly "application/json": {
+                    readonly schema: z.ZodObject<{
+                        error: z.ZodObject<{
+                            code: z.ZodString;
+                            message: z.ZodString;
+                            details: z.ZodOptional<z.ZodObject<{
+                                issues: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                                    path: z.ZodString;
+                                    message: z.ZodString;
+                                    code: z.ZodString;
+                                }, z.core.$strip>>>;
+                            }, z.core.$strip>>;
+                        }, z.core.$strip>;
+                    }, z.core.$strip>;
+                };
+            };
+            readonly description: "Authentication required.";
+        };
+        403: {
+            readonly content: {
+                readonly "application/json": {
+                    readonly schema: z.ZodObject<{
+                        error: z.ZodObject<{
+                            code: z.ZodString;
+                            message: z.ZodString;
+                            details: z.ZodOptional<z.ZodObject<{
+                                issues: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                                    path: z.ZodString;
+                                    message: z.ZodString;
+                                    code: z.ZodString;
+                                }, z.core.$strip>>>;
+                            }, z.core.$strip>>;
+                        }, z.core.$strip>;
+                    }, z.core.$strip>;
+                };
+            };
+            readonly description: "Insufficient permissions.";
+        };
+        404: {
+            readonly content: {
+                readonly "application/json": {
+                    readonly schema: z.ZodObject<{
+                        error: z.ZodObject<{
+                            code: z.ZodString;
+                            message: z.ZodString;
+                            details: z.ZodOptional<z.ZodObject<{
+                                issues: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                                    path: z.ZodString;
+                                    message: z.ZodString;
+                                    code: z.ZodString;
+                                }, z.core.$strip>>>;
+                            }, z.core.$strip>>;
+                        }, z.core.$strip>;
+                    }, z.core.$strip>;
+                };
+            };
+            readonly description: "Resource not found.";
+        };
+        422: {
+            readonly content: {
+                readonly "application/json": {
+                    readonly schema: z.ZodObject<{
+                        error: z.ZodObject<{
+                            code: z.ZodString;
+                            message: z.ZodString;
+                            details: z.ZodOptional<z.ZodObject<{
+                                issues: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                                    path: z.ZodString;
+                                    message: z.ZodString;
+                                    code: z.ZodString;
+                                }, z.core.$strip>>>;
+                            }, z.core.$strip>>;
+                        }, z.core.$strip>;
+                    }, z.core.$strip>;
+                };
+            };
+            readonly description: "Validation error.";
+        };
+        200: {
+            content: {
+                "text/html": {
+                    schema: z.ZodString;
+                };
+            };
+            description: string;
+        };
+    };
+} & {
+    getRoutingPath(): "/:id/receipt.html";
+};
+export declare const emailInvoiceRoute: {
+    method: "post";
+    path: "/{id}/invoice/email";
+    tags: string[];
+    summary: string;
+    request: {
+        params: z.ZodObject<{
+            id: z.ZodUUID;
+        }, z.core.$strip>;
+        body: {
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        to: z.ZodEmail;
+                    }, z.core.$strip>;
+                };
+            };
+            required: true;
+        };
+    };
+    responses: {
+        400: {
+            readonly content: {
+                readonly "application/json": {
+                    readonly schema: z.ZodObject<{
+                        error: z.ZodObject<{
+                            code: z.ZodString;
+                            message: z.ZodString;
+                            details: z.ZodOptional<z.ZodObject<{
+                                issues: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                                    path: z.ZodString;
+                                    message: z.ZodString;
+                                    code: z.ZodString;
+                                }, z.core.$strip>>>;
+                            }, z.core.$strip>>;
+                        }, z.core.$strip>;
+                    }, z.core.$strip>;
+                };
+            };
+            readonly description: "Business logic error.";
+        };
+        401: {
+            readonly content: {
+                readonly "application/json": {
+                    readonly schema: z.ZodObject<{
+                        error: z.ZodObject<{
+                            code: z.ZodString;
+                            message: z.ZodString;
+                            details: z.ZodOptional<z.ZodObject<{
+                                issues: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                                    path: z.ZodString;
+                                    message: z.ZodString;
+                                    code: z.ZodString;
+                                }, z.core.$strip>>>;
+                            }, z.core.$strip>>;
+                        }, z.core.$strip>;
+                    }, z.core.$strip>;
+                };
+            };
+            readonly description: "Authentication required.";
+        };
+        403: {
+            readonly content: {
+                readonly "application/json": {
+                    readonly schema: z.ZodObject<{
+                        error: z.ZodObject<{
+                            code: z.ZodString;
+                            message: z.ZodString;
+                            details: z.ZodOptional<z.ZodObject<{
+                                issues: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                                    path: z.ZodString;
+                                    message: z.ZodString;
+                                    code: z.ZodString;
+                                }, z.core.$strip>>>;
+                            }, z.core.$strip>>;
+                        }, z.core.$strip>;
+                    }, z.core.$strip>;
+                };
+            };
+            readonly description: "Insufficient permissions.";
+        };
+        404: {
+            readonly content: {
+                readonly "application/json": {
+                    readonly schema: z.ZodObject<{
+                        error: z.ZodObject<{
+                            code: z.ZodString;
+                            message: z.ZodString;
+                            details: z.ZodOptional<z.ZodObject<{
+                                issues: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                                    path: z.ZodString;
+                                    message: z.ZodString;
+                                    code: z.ZodString;
+                                }, z.core.$strip>>>;
+                            }, z.core.$strip>>;
+                        }, z.core.$strip>;
+                    }, z.core.$strip>;
+                };
+            };
+            readonly description: "Resource not found.";
+        };
+        422: {
+            readonly content: {
+                readonly "application/json": {
+                    readonly schema: z.ZodObject<{
+                        error: z.ZodObject<{
+                            code: z.ZodString;
+                            message: z.ZodString;
+                            details: z.ZodOptional<z.ZodObject<{
+                                issues: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                                    path: z.ZodString;
+                                    message: z.ZodString;
+                                    code: z.ZodString;
+                                }, z.core.$strip>>>;
+                            }, z.core.$strip>>;
+                        }, z.core.$strip>;
+                    }, z.core.$strip>;
+                };
+            };
+            readonly description: "Validation error.";
+        };
+        200: {
+            content: {
+                "application/json": {
+                    schema: z.ZodObject<{
+                        data: z.ZodAny;
+                    }, z.core.$strip>;
+                };
+            };
+            description: string;
+        };
+    };
+} & {
+    getRoutingPath(): "/:id/invoice/email";
+};
+//# sourceMappingURL=documents.d.ts.map

package/dist/interfaces/rest/schemas/documents.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"documents.d.ts","sourceRoot":"","sources":["../../../../src/interfaces/rest/schemas/documents.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAe,MAAM,mBAAmB,CAAC;AAOnD,eAAO,MAAM,sBAAsB;;iBAEF,CAAC;AAIlC,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAa1B,CAAC;AAEH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAa3B,CAAC;AAEH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAa3B,CAAC;AAEH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAa5B,CAAC"}

package/dist/interfaces/rest/schemas/documents.js

@@ -0,0 +1,65 @@
+import { z, createRoute } from "@hono/zod-openapi";
+import { errorResponses } from "./shared.js";
+const IdParam = z.object({
+    id: z.uuid().openapi({ example: "550e8400-e29b-41d4-a716-446655440000" }),
+});
+export const EmailInvoiceBodySchema = z.object({
+    to: z.email().openapi({ example: "customer@example.com" }),
+}).openapi("EmailInvoiceRequest");
+const DataResponse = z.object({ data: z.any() }).openapi("DocumentActionResponse");
+export const invoicePdfRoute = createRoute({
+    method: "get",
+    path: "/{id}/invoice.pdf",
+    tags: ["Documents"],
+    summary: "Render the order's invoice as PDF (issues a fiscal invoice number on first render)",
+    request: { params: IdParam },
+    responses: {
+        200: {
+            content: { "application/pdf": { schema: z.any().openapi({ type: "string", format: "binary" }) } },
+            description: "The rendered PDF invoice.",
+        },
+        ...errorResponses,
+    },
+});
+export const invoiceHtmlRoute = createRoute({
+    method: "get",
+    path: "/{id}/invoice.html",
+    tags: ["Documents"],
+    summary: "Render the order's invoice as HTML",
+    request: { params: IdParam },
+    responses: {
+        200: {
+            content: { "text/html": { schema: z.string() } },
+            description: "The rendered HTML invoice.",
+        },
+        ...errorResponses,
+    },
+});
+export const receiptHtmlRoute = createRoute({
+    method: "get",
+    path: "/{id}/receipt.html",
+    tags: ["Documents"],
+    summary: "Render the order's receipt as HTML",
+    request: { params: IdParam },
+    responses: {
+        200: {
+            content: { "text/html": { schema: z.string() } },
+            description: "The rendered HTML receipt.",
+        },
+        ...errorResponses,
+    },
+});
+export const emailInvoiceRoute = createRoute({
+    method: "post",
+    path: "/{id}/invoice/email",
+    tags: ["Documents"],
+    summary: "Email the order's invoice via the configured email adapter",
+    request: {
+        params: IdParam,
+        body: { content: { "application/json": { schema: EmailInvoiceBodySchema } }, required: true },
+    },
+    responses: {
+        200: { content: { "application/json": { schema: DataResponse } }, description: "Invoice emailed." },
+        ...errorResponses,
+    },
+});