@shophost/rest-api 0.1.0

package/src/contracts/customers.contract.js

@@ -0,0 +1,119 @@
+import { z } from "zod";
+import { c } from "../lib/ts-rest";
+import { ErrorSchema } from "../schemas/error.schema";
+import { HeaderSchema } from "../schemas/headers.schema";
+import { PaginationMetaSchema, PaginationQuerySchema, } from "../schemas/pagination.schema";
+import { CreateRecipientSchema, RecipientSchema, UpdateCustomerSchema, } from "../schemas/recipient.schema";
+export const customersContract = c.router({
+    getCustomers: {
+        method: "GET",
+        path: "/:organizationId/customers",
+        summary: "Get Customers",
+        description: "Fetches a paginated list of customers for a specific organization",
+        query: PaginationQuerySchema,
+        headers: HeaderSchema,
+        responses: {
+            200: z.object({
+                meta: PaginationMetaSchema,
+                list: z.array(RecipientSchema),
+            }),
+            400: ErrorSchema,
+            401: ErrorSchema,
+        },
+        pathParams: z.object({
+            organizationId: z.string().openapi({
+                example: "cju0z9k4z0000l1qg5z1z1z1z",
+                description: "ID of the organization",
+            }),
+        }),
+    },
+    createCustomer: {
+        method: "POST",
+        path: "/:organizationId/customers",
+        summary: "Create Customer",
+        description: "Creates a new customer for a specific organization",
+        headers: HeaderSchema,
+        body: CreateRecipientSchema,
+        responses: {
+            201: RecipientSchema,
+            400: ErrorSchema,
+            401: ErrorSchema,
+            404: ErrorSchema,
+        },
+        pathParams: z.object({
+            organizationId: z.string().openapi({
+                example: "cju0z9k4z0000l1qg5z1z1z1z",
+                description: "ID of the organization",
+            }),
+        }),
+    },
+    getCustomer: {
+        method: "GET",
+        path: "/:organizationId/customers/:id",
+        responses: {
+            200: RecipientSchema,
+            401: ErrorSchema,
+            404: ErrorSchema,
+        },
+        summary: "Get Customer",
+        headers: HeaderSchema,
+        pathParams: z.object({
+            organizationId: z.string().openapi({
+                example: "cju0z9k4z0000l1qg5z1z1z1z",
+                description: "ID of the organization",
+            }),
+            id: z.string().openapi({
+                example: "clf9876543210abcdef",
+                description: "ID of the customer",
+            }),
+        }),
+    },
+    updateCustomer: {
+        method: "PUT",
+        path: "/:organizationId/customers/:id",
+        summary: "Update Customer",
+        description: "Updates an existing customer",
+        body: UpdateCustomerSchema,
+        headers: HeaderSchema,
+        responses: {
+            200: RecipientSchema,
+            400: ErrorSchema,
+            401: ErrorSchema,
+            404: ErrorSchema,
+        },
+        pathParams: z.object({
+            organizationId: z.string().openapi({
+                example: "cju0z9k4z0000l1qg5z1z1z1z",
+                description: "ID of the organization",
+            }),
+            id: z.string().openapi({
+                example: "clf9876543210abcdef",
+                description: "ID of the customer",
+            }),
+        }),
+    },
+    deleteCustomer: {
+        method: "DELETE",
+        path: "/:organizationId/customers/:id",
+        summary: "Delete Customer",
+        description: "Soft deletes a customer",
+        headers: HeaderSchema,
+        responses: {
+            204: c.noBody(),
+            400: ErrorSchema,
+            401: ErrorSchema,
+            404: ErrorSchema,
+        },
+        pathParams: z.object({
+            organizationId: z.string().openapi({
+                example: "cju0z9k4z0000l1qg5z1z1z1z",
+                description: "ID of the organization",
+            }),
+            id: z.string().openapi({
+                example: "clf9876543210abcdef",
+                description: "ID of the customer",
+            }),
+        }),
+    },
+});
+//# sourceMappingURL=customers.contract.js.map

package/src/contracts/customers.contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"customers.contract.js","sourceRoot":"","sources":["../../../../../packages/rest-api/src/contracts/customers.contract.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,CAAC,EAAE,MAAM,gBAAgB,CAAC;AACnC,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EACL,oBAAoB,EACpB,qBAAqB,GACtB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,qBAAqB,EACrB,eAAe,EACf,oBAAoB,GACrB,MAAM,6BAA6B,CAAC;AAErC,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,YAAY,EAAE;QACZ,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,4BAA4B;QAClC,OAAO,EAAE,eAAe;QACxB,WAAW,EACT,mEAAmE;QACrE,KAAK,EAAE,qBAAqB;QAC5B,OAAO,EAAE,YAAY;QACrB,SAAS,EAAE;YACT,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC;gBACZ,IAAI,EAAE,oBAAoB;gBAC1B,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC;aAC/B,CAAC;YACF,GAAG,EAAE,WAAW;YAChB,GAAG,EAAE,WAAW;SACjB;QACD,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC;YACnB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC;gBACjC,OAAO,EAAE,2BAA2B;gBACpC,WAAW,EAAE,wBAAwB;aACtC,CAAC;SACH,CAAC;KACH;IACD,cAAc,EAAE;QACd,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,4BAA4B;QAClC,OAAO,EAAE,iBAAiB;QAC1B,WAAW,EAAE,oDAAoD;QACjE,OAAO,EAAE,YAAY;QACrB,IAAI,EAAE,qBAAqB;QAC3B,SAAS,EAAE;YACT,GAAG,EAAE,eAAe;YACpB,GAAG,EAAE,WAAW;YAChB,GAAG,EAAE,WAAW;YAChB,GAAG,EAAE,WAAW;SACjB;QACD,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC;YACnB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC;gBACjC,OAAO,EAAE,2BAA2B;gBACpC,WAAW,EAAE,wBAAwB;aACtC,CAAC;SACH,CAAC;KACH;IACD,WAAW,EAAE;QACX,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,gCAAgC;QACtC,SAAS,EAAE;YACT,GAAG,EAAE,eAAe;YACpB,GAAG,EAAE,WAAW;YAChB,GAAG,EAAE,WAAW;SACjB;QACD,OAAO,EAAE,cAAc;QACvB,OAAO,EAAE,YAAY;QACrB,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC;YACnB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC;gBACjC,OAAO,EAAE,2BAA2B;gBACpC,WAAW,EAAE,wBAAwB;aACtC,CAAC;YACF,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC;gBACrB,OAAO,EAAE,qBAAqB;gBAC9B,WAAW,EAAE,oBAAoB;aAClC,CAAC;SACH,CAAC;KACH;IACD,cAAc,EAAE;QACd,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,gCAAgC;QACtC,OAAO,EAAE,iBAAiB;QAC1B,WAAW,EAAE,8BAA8B;QAC3C,IAAI,EAAE,oBAAoB;QAC1B,OAAO,EAAE,YAAY;QACrB,SAAS,EAAE;YACT,GAAG,EAAE,eAAe;YACpB,GAAG,EAAE,WAAW;YAChB,GAAG,EAAE,WAAW;YAChB,GAAG,EAAE,WAAW;SACjB;QACD,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC;YACnB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC;gBACjC,OAAO,EAAE,2BAA2B;gBACpC,WAAW,EAAE,wBAAwB;aACtC,CAAC;YACF,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC;gBACrB,OAAO,EAAE,qBAAqB;gBAC9B,WAAW,EAAE,oBAAoB;aAClC,CAAC;SACH,CAAC;KACH;IACD,cAAc,EAAE;QACd,MAAM,EAAE,QAAQ;QAChB,IAAI,EAAE,gCAAgC;QACtC,OAAO,EAAE,iBAAiB;QAC1B,WAAW,EAAE,yBAAyB;QACtC,OAAO,EAAE,YAAY;QACrB,SAAS,EAAE;YACT,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;YACf,GAAG,EAAE,WAAW;YAChB,GAAG,EAAE,WAAW;YAChB,GAAG,EAAE,WAAW;SACjB;QACD,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC;YACnB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC;gBACjC,OAAO,EAAE,2BAA2B;gBACpC,WAAW,EAAE,wBAAwB;aACtC,CAAC;YACF,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC;gBACrB,OAAO,EAAE,qBAAqB;gBAC9B,WAAW,EAAE,oBAAoB;aAClC,CAAC;SACH,CAAC;KACH;CACF,CAAC,CAAC"}

package/src/contracts/files.contract.d.ts

@@ -0,0 +1,152 @@
+export declare const filesContract: {
+    createTemporaryFile: {
+        description: "Creates a temporary file record and returns its ID";
+        method: "POST";
+        summary: "Create Temporary File";
+        body: import("zod").ZodObject<{
+            mimeType: import("zod").ZodString;
+            size: import("zod").ZodNumber;
+            filename: import("zod").ZodString;
+            organizationId: import("zod").ZodOptional<import("zod").ZodString>;
+        }, "strip", import("zod").ZodTypeAny, {
+            mimeType: string;
+            size: number;
+            filename: string;
+            organizationId?: string | undefined;
+        }, {
+            mimeType: string;
+            size: number;
+            filename: string;
+            organizationId?: string | undefined;
+        }>;
+        path: "/files";
+        headers: import("zod").ZodOptional<import("zod").ZodObject<{
+            "accept-language": import("zod").ZodOptional<import("zod").ZodString>;
+            cookie: import("zod").ZodOptional<import("zod").ZodString>;
+        }, "strip", import("zod").ZodTypeAny, {
+            "accept-language"?: string | undefined;
+            cookie?: string | undefined;
+        }, {
+            "accept-language"?: string | undefined;
+            cookie?: string | undefined;
+        }>>;
+        responses: {
+            201: import("zod").ZodObject<{
+                id: import("zod").ZodString;
+                url: import("zod").ZodString;
+                mimeType: import("zod").ZodString;
+                size: import("zod").ZodNumber;
+                filename: import("zod").ZodString;
+            }, "strip", import("zod").ZodTypeAny, {
+                id: string;
+                mimeType: string;
+                size: number;
+                filename: string;
+                url: string;
+            }, {
+                id: string;
+                mimeType: string;
+                size: number;
+                filename: string;
+                url: string;
+            }>;
+        };
+    };
+    getVercelToken: {
+        description: "Returns a Vercel token";
+        method: "POST";
+        summary: "Get Vercel Token";
+        body: import("zod").ZodDiscriminatedUnion<"type", [import("zod").ZodObject<{
+            type: import("zod").ZodLiteral<"blob.generate-client-token">;
+            payload: import("zod").ZodObject<{
+                pathname: import("zod").ZodString;
+                callbackUrl: import("zod").ZodString;
+                multipart: import("zod").ZodBoolean;
+                clientPayload: import("zod").ZodNullable<import("zod").ZodString>;
+            }, "strip", import("zod").ZodTypeAny, {
+                pathname: string;
+                callbackUrl: string;
+                multipart: boolean;
+                clientPayload: string | null;
+            }, {
+                pathname: string;
+                callbackUrl: string;
+                multipart: boolean;
+                clientPayload: string | null;
+            }>;
+        }, "strip", import("zod").ZodTypeAny, {
+            type: "blob.generate-client-token";
+            payload: {
+                pathname: string;
+                callbackUrl: string;
+                multipart: boolean;
+                clientPayload: string | null;
+            };
+        }, {
+            type: "blob.generate-client-token";
+            payload: {
+                pathname: string;
+                callbackUrl: string;
+                multipart: boolean;
+                clientPayload: string | null;
+            };
+        }>, import("zod").ZodObject<{
+            type: import("zod").ZodLiteral<"blob.upload-completed">;
+            payload: import("zod").ZodObject<{
+                blob: import("zod").ZodAny;
+                tokenPayload: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodString>>;
+            }, "strip", import("zod").ZodTypeAny, {
+                blob?: any;
+                tokenPayload?: string | null | undefined;
+            }, {
+                blob?: any;
+                tokenPayload?: string | null | undefined;
+            }>;
+        }, "strip", import("zod").ZodTypeAny, {
+            type: "blob.upload-completed";
+            payload: {
+                blob?: any;
+                tokenPayload?: string | null | undefined;
+            };
+        }, {
+            type: "blob.upload-completed";
+            payload: {
+                blob?: any;
+                tokenPayload?: string | null | undefined;
+            };
+        }>]>;
+        path: "/files/token/vercel";
+        headers: import("zod").ZodOptional<import("zod").ZodObject<{
+            "accept-language": import("zod").ZodOptional<import("zod").ZodString>;
+            cookie: import("zod").ZodOptional<import("zod").ZodString>;
+        }, "strip", import("zod").ZodTypeAny, {
+            "accept-language"?: string | undefined;
+            cookie?: string | undefined;
+        }, {
+            "accept-language"?: string | undefined;
+            cookie?: string | undefined;
+        }>>;
+        responses: {
+            200: import("zod").ZodDiscriminatedUnion<"type", [import("zod").ZodObject<{
+                type: import("zod").ZodLiteral<"blob.generate-client-token">;
+                clientToken: import("zod").ZodString;
+            }, "strip", import("zod").ZodTypeAny, {
+                type: "blob.generate-client-token";
+                clientToken: string;
+            }, {
+                type: "blob.generate-client-token";
+                clientToken: string;
+            }>, import("zod").ZodObject<{
+                type: import("zod").ZodLiteral<"blob.upload-completed">;
+                response: import("zod").ZodLiteral<"ok">;
+            }, "strip", import("zod").ZodTypeAny, {
+                type: "blob.upload-completed";
+                response: "ok";
+            }, {
+                type: "blob.upload-completed";
+                response: "ok";
+            }>]>;
+            204: typeof import("@ts-rest/core").ContractNoBody;
+        };
+    };
+};

package/src/contracts/files.contract.js

@@ -0,0 +1,29 @@
+import { c } from "../lib/ts-rest";
+import { CreateTemporaryFileSchema, FileSchema, GetVercelTokenBody, GetVercelTokenResponse, } from "../schemas/file.schema";
+import { HeaderSchema } from "../schemas/headers.schema";
+export const filesContract = c.router({
+    createTemporaryFile: {
+        method: "POST",
+        path: "/files",
+        summary: "Create Temporary File",
+        description: "Creates a temporary file record and returns its ID",
+        headers: HeaderSchema,
+        body: CreateTemporaryFileSchema,
+        responses: {
+            201: FileSchema,
+        },
+    },
+    getVercelToken: {
+        method: "POST",
+        path: "/files/token/vercel",
+        summary: "Get Vercel Token",
+        description: "Returns a Vercel token",
+        headers: HeaderSchema,
+        body: GetVercelTokenBody,
+        responses: {
+            200: GetVercelTokenResponse,
+            204: c.noBody(),
+        },
+    },
+});
+//# sourceMappingURL=files.contract.js.map

package/src/contracts/files.contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"files.contract.js","sourceRoot":"","sources":["../../../../../packages/rest-api/src/contracts/files.contract.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,gBAAgB,CAAC;AACnC,OAAO,EACL,yBAAyB,EACzB,UAAU,EACV,kBAAkB,EAClB,sBAAsB,GACvB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAEzD,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC;IACpC,mBAAmB,EAAE;QACnB,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,uBAAuB;QAChC,WAAW,EAAE,oDAAoD;QACjE,OAAO,EAAE,YAAY;QACrB,IAAI,EAAE,yBAAyB;QAC/B,SAAS,EAAE;YACT,GAAG,EAAE,UAAU;SAChB;KACF;IACD,cAAc,EAAE;QACd,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,qBAAqB;QAC3B,OAAO,EAAE,kBAAkB;QAC3B,WAAW,EAAE,wBAAwB;QACrC,OAAO,EAAE,YAAY;QACrB,IAAI,EAAE,kBAAkB;QACxB,SAAS,EAAE;YACT,GAAG,EAAE,sBAAsB;YAC3B,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;SAChB;KACF;CACF,CAAC,CAAC"}

package/src/contracts/health.contract.d.ts

@@ -0,0 +1,38 @@
+import { z } from "zod";
+export declare const healthContract: {
+    ping: {
+        description: "Pings the relevancy score service to check its availability";
+        method: "GET";
+        summary: "Ping";
+        path: "/ping";
+        headers: z.ZodOptional<z.ZodObject<{
+            "accept-language": z.ZodOptional<z.ZodString>;
+            cookie: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            "accept-language"?: string | undefined;
+            cookie?: string | undefined;
+        }, {
+            "accept-language"?: string | undefined;
+            cookie?: string | undefined;
+        }>>;
+        responses: {
+            200: z.ZodObject<{
+                ok: z.ZodBoolean;
+            }, "strip", z.ZodTypeAny, {
+                ok: boolean;
+            }, {
+                ok: boolean;
+            }>;
+            500: z.ZodObject<{
+                status: z.ZodNumber;
+                message: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                message: string;
+                status: number;
+            }, {
+                message: string;
+                status: number;
+            }>;
+        };
+    };
+};

package/src/contracts/health.contract.js

@@ -0,0 +1,25 @@
+import { extendZodWithOpenApi } from "@anatine/zod-openapi";
+import { z } from "zod";
+import { c } from "../lib/ts-rest";
+import { ErrorSchema } from "../schemas/error.schema";
+import { HeaderSchema } from "../schemas/headers.schema";
+extendZodWithOpenApi(z);
+export const healthContract = c.router({
+    ping: {
+        method: "GET",
+        path: "/ping",
+        summary: "Ping",
+        description: "Pings the relevancy score service to check its availability",
+        headers: HeaderSchema,
+        responses: {
+            200: z.object({
+                ok: z.boolean().openapi({
+                    example: true,
+                    description: "Indicates if the service is available",
+                }),
+            }),
+            500: ErrorSchema,
+        },
+    },
+});
+//# sourceMappingURL=health.contract.js.map

package/src/contracts/health.contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"health.contract.js","sourceRoot":"","sources":["../../../../../packages/rest-api/src/contracts/health.contract.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,CAAC,EAAE,MAAM,gBAAgB,CAAC;AACnC,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAEzD,oBAAoB,CAAC,CAAC,CAAC,CAAC;AAExB,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,IAAI,EAAE;QACJ,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,OAAO;QACb,OAAO,EAAE,MAAM;QACf,WAAW,EAAE,6DAA6D;QAC1E,OAAO,EAAE,YAAY;QACrB,SAAS,EAAE;YACT,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC;gBACZ,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC;oBACtB,OAAO,EAAE,IAAI;oBACb,WAAW,EAAE,uCAAuC;iBACrD,CAAC;aACH,CAAC;YACF,GAAG,EAAE,WAAW;SACjB;KACF;CACF,CAAC,CAAC"}