@porulle/core 0.7.0 → 0.8.0

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

@@ -0,0 +1,397 @@
+import { z } from "@hono/zod-openapi";
+export declare const GeneralSettingsPatchSchema: z.ZodObject<{
+    currency: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    timezone: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    locale: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strict>;
+export declare const BrandingSettingsPatchSchema: z.ZodObject<{
+    storeName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    receiptHeader: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    receiptFooter: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    logoUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    address: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    phone: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    email: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    taxId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strict>;
+export declare const PoliciesSettingsPatchSchema: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>;
+export declare const KNOWN_GROUP_SCHEMAS: Record<string, z.ZodTypeAny>;
+export declare const getAllSettingsRoute: {
+    method: "get";
+    path: "/";
+    tags: string[];
+    summary: string;
+    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(): "/";
+};
+export declare const getSettingsGroupRoute: {
+    method: "get";
+    path: "/{group}";
+    tags: string[];
+    summary: string;
+    request: {
+        params: z.ZodObject<{
+            group: z.ZodString;
+        }, 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/json": {
+                    schema: z.ZodObject<{
+                        data: z.ZodAny;
+                    }, z.core.$strip>;
+                };
+            };
+            description: string;
+        };
+    };
+} & {
+    getRoutingPath(): "/:group";
+};
+export declare const patchSettingsGroupRoute: {
+    method: "patch";
+    path: "/{group}";
+    tags: string[];
+    summary: string;
+    request: {
+        params: z.ZodObject<{
+            group: z.ZodString;
+        }, z.core.$strip>;
+        body: {
+            content: {
+                "application/json": {
+                    schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+                };
+            };
+            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(): "/:group";
+};
+//# sourceMappingURL=settings.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"settings.d.ts","sourceRoot":"","sources":["../../../../src/interfaces/rest/schemas/settings.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAe,MAAM,mBAAmB,CAAC;AAenD,eAAO,MAAM,0BAA0B;;;;kBAI5B,CAAC;AAEZ,eAAO,MAAM,2BAA2B;;;;;;;;;kBAS7B,CAAC;AAEZ,eAAO,MAAM,2BAA2B,oGAGvC,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,UAAU,CAI5D,CAAC;AAeF,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAS9B,CAAC;AAEH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAUhC,CAAC;AAEH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAalC,CAAC"}

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

@@ -0,0 +1,79 @@
+import { z, createRoute } from "@hono/zod-openapi";
+import { errorResponses } from "./shared.js";
+function isValidTimezone(tz) {
+    try {
+        new Intl.DateTimeFormat("en-US", { timeZone: tz });
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+// Known typed groups. Every field is optional (PATCH is a partial merge) and
+// nullable (null deletes the key). Unknown groups accept any flat JSON object
+// so plugins can namespace their own settings.
+export const GeneralSettingsPatchSchema = z.object({
+    currency: z.string().regex(/^[A-Z]{3}$/, "ISO 4217 uppercase code").nullable().optional(),
+    timezone: z.string().refine(isValidTimezone, "Must be a valid IANA timezone (e.g. Asia/Colombo)").nullable().optional(),
+    locale: z.string().min(2).nullable().optional(),
+}).strict();
+export const BrandingSettingsPatchSchema = z.object({
+    storeName: z.string().nullable().optional(),
+    receiptHeader: z.string().nullable().optional(),
+    receiptFooter: z.string().nullable().optional(),
+    logoUrl: z.string().nullable().optional(),
+    address: z.string().nullable().optional(),
+    phone: z.string().nullable().optional(),
+    email: z.string().nullable().optional(),
+    taxId: z.string().nullable().optional(),
+}).strict();
+export const PoliciesSettingsPatchSchema = z.record(z.string(), z.union([z.string(), z.number(), z.boolean(), z.null()]));
+export const KNOWN_GROUP_SCHEMAS = {
+    general: GeneralSettingsPatchSchema,
+    branding: BrandingSettingsPatchSchema,
+    policies: PoliciesSettingsPatchSchema,
+};
+const GroupParam = z.object({
+    group: z.string().regex(/^[a-z][a-z0-9_-]*$/).openapi({ example: "branding" }),
+});
+const SettingsPatchBodySchema = z
+    .record(z.string(), z.unknown())
+    .openapi("SettingsPatchRequest", {
+    description: "Shallow merge into the group: keys overwrite, null deletes a key. Known groups (general, branding, policies) are validated.",
+});
+const DataResponse = z.object({ data: z.any() }).openapi("SettingsResponse");
+export const getAllSettingsRoute = createRoute({
+    method: "get",
+    path: "/",
+    tags: ["Settings"],
+    summary: "Get all settings groups for the organization",
+    responses: {
+        200: { content: { "application/json": { schema: DataResponse } }, description: "All settings groups" },
+        ...errorResponses,
+    },
+});
+export const getSettingsGroupRoute = createRoute({
+    method: "get",
+    path: "/{group}",
+    tags: ["Settings"],
+    summary: "Get one settings group",
+    request: { params: GroupParam },
+    responses: {
+        200: { content: { "application/json": { schema: DataResponse } }, description: "Settings group (empty object if unset)" },
+        ...errorResponses,
+    },
+});
+export const patchSettingsGroupRoute = createRoute({
+    method: "patch",
+    path: "/{group}",
+    tags: ["Settings"],
+    summary: "Merge values into a settings group",
+    request: {
+        params: GroupParam,
+        body: { content: { "application/json": { schema: SettingsPatchBodySchema } }, required: true },
+    },
+    responses: {
+        200: { content: { "application/json": { schema: DataResponse } }, description: "The merged group value" },
+        ...errorResponses,
+    },
+});