@dalmore/api-contracts 0.0.0-dev.5e42638 → 0.0.0-dev.685c0b3

package/contracts/clients/api-keys/index.d.ts

@@ -0,0 +1,374 @@
+import { z } from 'zod';
+export declare const apiKeysContract: {
+    getApiKeys: {
+        method: "GET";
+        metadata: {
+            auth: boolean;
+        };
+        query: z.ZodObject<{
+            page: z.ZodDefault<z.ZodOptional<z.ZodEffects<z.ZodNumber, number, number>>>;
+            limit: z.ZodDefault<z.ZodOptional<z.ZodEffects<z.ZodNumber, number, number>>>;
+        }, "strip", z.ZodTypeAny, {
+            page: number;
+            limit: number;
+        }, {
+            page?: number | undefined;
+            limit?: number | undefined;
+        }>;
+        summary: "Get API Keys";
+        path: "api-keys";
+        responses: {
+            200: z.ZodObject<{
+                items: z.ZodArray<z.ZodObject<{
+                    __entity: z.ZodOptional<z.ZodString>;
+                    createdAt: z.ZodUnion<[z.ZodString, z.ZodDate]>;
+                    updatedAt: z.ZodUnion<[z.ZodString, z.ZodDate]>;
+                    deletedAt: z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodDate]>>;
+                } & {
+                    id: z.ZodEffects<z.ZodString, string, string>;
+                    name: z.ZodString;
+                    description: z.ZodNullable<z.ZodString>;
+                    key: z.ZodString;
+                    keyHash: z.ZodString;
+                    active: z.ZodBoolean;
+                    lastUsedAt: z.ZodNullable<z.ZodDate>;
+                    accountId: z.ZodString;
+                    roleId: z.ZodNullable<z.ZodString>;
+                }, "strip", z.ZodTypeAny, {
+                    id: string;
+                    createdAt: string | Date;
+                    updatedAt: string | Date;
+                    deletedAt: string | Date | null;
+                    key: string;
+                    active: boolean;
+                    accountId: string;
+                    name: string;
+                    roleId: string | null;
+                    description: string | null;
+                    lastUsedAt: Date | null;
+                    keyHash: string;
+                    __entity?: string | undefined;
+                }, {
+                    id: string;
+                    createdAt: string | Date;
+                    updatedAt: string | Date;
+                    deletedAt: string | Date | null;
+                    key: string;
+                    active: boolean;
+                    accountId: string;
+                    name: string;
+                    roleId: string | null;
+                    description: string | null;
+                    lastUsedAt: Date | null;
+                    keyHash: string;
+                    __entity?: string | undefined;
+                }>, "many">;
+                meta: z.ZodObject<{
+                    itemCount: z.ZodNumber;
+                    totalItems: z.ZodOptional<z.ZodNumber>;
+                    itemsPerPage: z.ZodNumber;
+                    totalPages: z.ZodOptional<z.ZodNumber>;
+                    currentPage: z.ZodNumber;
+                }, "strip", z.ZodTypeAny, {
+                    itemCount: number;
+                    itemsPerPage: number;
+                    currentPage: number;
+                    totalItems?: number | undefined;
+                    totalPages?: number | undefined;
+                }, {
+                    itemCount: number;
+                    itemsPerPage: number;
+                    currentPage: number;
+                    totalItems?: number | undefined;
+                    totalPages?: number | undefined;
+                }>;
+            }, "strip", z.ZodTypeAny, {
+                items: {
+                    id: string;
+                    createdAt: string | Date;
+                    updatedAt: string | Date;
+                    deletedAt: string | Date | null;
+                    key: string;
+                    active: boolean;
+                    accountId: string;
+                    name: string;
+                    roleId: string | null;
+                    description: string | null;
+                    lastUsedAt: Date | null;
+                    keyHash: string;
+                    __entity?: string | undefined;
+                }[];
+                meta: {
+                    itemCount: number;
+                    itemsPerPage: number;
+                    currentPage: number;
+                    totalItems?: number | undefined;
+                    totalPages?: number | undefined;
+                };
+            }, {
+                items: {
+                    id: string;
+                    createdAt: string | Date;
+                    updatedAt: string | Date;
+                    deletedAt: string | Date | null;
+                    key: string;
+                    active: boolean;
+                    accountId: string;
+                    name: string;
+                    roleId: string | null;
+                    description: string | null;
+                    lastUsedAt: Date | null;
+                    keyHash: string;
+                    __entity?: string | undefined;
+                }[];
+                meta: {
+                    itemCount: number;
+                    itemsPerPage: number;
+                    currentPage: number;
+                    totalItems?: number | undefined;
+                    totalPages?: number | undefined;
+                };
+            }>;
+            401: z.ZodObject<{
+                status: z.ZodNumber;
+                message: z.ZodString;
+                errors: z.ZodArray<z.ZodString, "many">;
+            }, "strip", z.ZodTypeAny, {
+                message: string;
+                status: number;
+                errors: string[];
+            }, {
+                message: string;
+                status: number;
+                errors: string[];
+            }>;
+            403: z.ZodObject<{
+                status: z.ZodNumber;
+                message: z.ZodString;
+                errors: z.ZodArray<z.ZodString, "many">;
+            }, "strip", z.ZodTypeAny, {
+                message: string;
+                status: number;
+                errors: string[];
+            }, {
+                message: string;
+                status: number;
+                errors: string[];
+            }>;
+        };
+    };
+    getApiKey: {
+        method: "GET";
+        metadata: {
+            auth: boolean;
+        };
+        pathParams: z.ZodObject<{
+            id: z.ZodEffects<z.ZodString, string, string>;
+        }, "strip", z.ZodTypeAny, {
+            id: string;
+        }, {
+            id: string;
+        }>;
+        summary: "Get API Key";
+        path: "api-keys/:id";
+        responses: {
+            200: z.ZodObject<{
+                __entity: z.ZodOptional<z.ZodString>;
+                createdAt: z.ZodUnion<[z.ZodString, z.ZodDate]>;
+                updatedAt: z.ZodUnion<[z.ZodString, z.ZodDate]>;
+                deletedAt: z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodDate]>>;
+            } & {
+                id: z.ZodEffects<z.ZodString, string, string>;
+                name: z.ZodString;
+                description: z.ZodNullable<z.ZodString>;
+                key: z.ZodString;
+                keyHash: z.ZodString;
+                active: z.ZodBoolean;
+                lastUsedAt: z.ZodNullable<z.ZodDate>;
+                accountId: z.ZodString;
+                roleId: z.ZodNullable<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                id: string;
+                createdAt: string | Date;
+                updatedAt: string | Date;
+                deletedAt: string | Date | null;
+                key: string;
+                active: boolean;
+                accountId: string;
+                name: string;
+                roleId: string | null;
+                description: string | null;
+                lastUsedAt: Date | null;
+                keyHash: string;
+                __entity?: string | undefined;
+            }, {
+                id: string;
+                createdAt: string | Date;
+                updatedAt: string | Date;
+                deletedAt: string | Date | null;
+                key: string;
+                active: boolean;
+                accountId: string;
+                name: string;
+                roleId: string | null;
+                description: string | null;
+                lastUsedAt: Date | null;
+                keyHash: string;
+                __entity?: string | undefined;
+            }>;
+            401: z.ZodObject<{
+                status: z.ZodNumber;
+                message: z.ZodString;
+                errors: z.ZodArray<z.ZodString, "many">;
+            }, "strip", z.ZodTypeAny, {
+                message: string;
+                status: number;
+                errors: string[];
+            }, {
+                message: string;
+                status: number;
+                errors: string[];
+            }>;
+            403: z.ZodObject<{
+                status: z.ZodNumber;
+                message: z.ZodString;
+                errors: z.ZodArray<z.ZodString, "many">;
+            }, "strip", z.ZodTypeAny, {
+                message: string;
+                status: number;
+                errors: string[];
+            }, {
+                message: string;
+                status: number;
+                errors: string[];
+            }>;
+            404: z.ZodObject<{
+                status: z.ZodNumber;
+                message: z.ZodString;
+                errors: z.ZodArray<z.ZodString, "many">;
+            }, "strip", z.ZodTypeAny, {
+                message: string;
+                status: number;
+                errors: string[];
+            }, {
+                message: string;
+                status: number;
+                errors: string[];
+            }>;
+        };
+    };
+    deactivateApiKey: {
+        method: "PATCH";
+        metadata: {
+            auth: boolean;
+        };
+        body: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+        pathParams: z.ZodObject<{
+            id: z.ZodEffects<z.ZodString, string, string>;
+        }, "strip", z.ZodTypeAny, {
+            id: string;
+        }, {
+            id: string;
+        }>;
+        summary: "Deactivate API Key by id";
+        path: "api-keys/:id/deactivate";
+        responses: {
+            202: z.ZodObject<{
+                __entity: z.ZodOptional<z.ZodString>;
+                createdAt: z.ZodUnion<[z.ZodString, z.ZodDate]>;
+                updatedAt: z.ZodUnion<[z.ZodString, z.ZodDate]>;
+                deletedAt: z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodDate]>>;
+            } & {
+                id: z.ZodEffects<z.ZodString, string, string>;
+                name: z.ZodString;
+                description: z.ZodNullable<z.ZodString>;
+                key: z.ZodString;
+                keyHash: z.ZodString;
+                active: z.ZodBoolean;
+                lastUsedAt: z.ZodNullable<z.ZodDate>;
+                accountId: z.ZodString;
+                roleId: z.ZodNullable<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                id: string;
+                createdAt: string | Date;
+                updatedAt: string | Date;
+                deletedAt: string | Date | null;
+                key: string;
+                active: boolean;
+                accountId: string;
+                name: string;
+                roleId: string | null;
+                description: string | null;
+                lastUsedAt: Date | null;
+                keyHash: string;
+                __entity?: string | undefined;
+            }, {
+                id: string;
+                createdAt: string | Date;
+                updatedAt: string | Date;
+                deletedAt: string | Date | null;
+                key: string;
+                active: boolean;
+                accountId: string;
+                name: string;
+                roleId: string | null;
+                description: string | null;
+                lastUsedAt: Date | null;
+                keyHash: string;
+                __entity?: string | undefined;
+            }>;
+            400: z.ZodObject<{
+                status: z.ZodNumber;
+                message: z.ZodString;
+                errors: z.ZodArray<z.ZodString, "many">;
+            }, "strip", z.ZodTypeAny, {
+                message: string;
+                status: number;
+                errors: string[];
+            }, {
+                message: string;
+                status: number;
+                errors: string[];
+            }>;
+            401: z.ZodObject<{
+                status: z.ZodNumber;
+                message: z.ZodString;
+                errors: z.ZodArray<z.ZodString, "many">;
+            }, "strip", z.ZodTypeAny, {
+                message: string;
+                status: number;
+                errors: string[];
+            }, {
+                message: string;
+                status: number;
+                errors: string[];
+            }>;
+            404: z.ZodObject<{
+                status: z.ZodNumber;
+                message: z.ZodString;
+                errors: z.ZodArray<z.ZodString, "many">;
+            }, "strip", z.ZodTypeAny, {
+                message: string;
+                status: number;
+                errors: string[];
+            }, {
+                message: string;
+                status: number;
+                errors: string[];
+            }>;
+            500: z.ZodObject<{
+                status: z.ZodNumber;
+                message: z.ZodString;
+                errors: z.ZodArray<z.ZodString, "many">;
+            }, "strip", z.ZodTypeAny, {
+                message: string;
+                status: number;
+                errors: string[];
+            }, {
+                message: string;
+                status: number;
+                errors: string[];
+            }>;
+        };
+    };
+};

package/contracts/clients/api-keys/index.js

@@ -0,0 +1,59 @@
+import { initContract } from '@ts-rest/core';
+import { ForbiddenError, NotFoundError, UnauthorizedError, InternalError, ApiKeyZod, IPaginatedApiKeys, PaginationOptionsZod, BadRequestError, apiKeyIdSchema, } from '../../../common/types/index.js';
+import { z } from 'zod';
+const c = initContract();
+export const apiKeysContract = c.router({
+    getApiKeys: {
+        summary: 'Get API Keys',
+        method: 'GET',
+        path: '',
+        metadata: {
+            auth: true,
+        },
+        query: PaginationOptionsZod,
+        responses: {
+            200: IPaginatedApiKeys,
+            401: UnauthorizedError,
+            403: ForbiddenError,
+        },
+    },
+    getApiKey: {
+        summary: 'Get API Key',
+        method: 'GET',
+        path: '/:id',
+        metadata: {
+            auth: true,
+        },
+        pathParams: z.object({
+            id: apiKeyIdSchema,
+        }),
+        responses: {
+            200: ApiKeyZod,
+            401: UnauthorizedError,
+            403: ForbiddenError,
+            404: NotFoundError,
+        },
+    },
+    deactivateApiKey: {
+        summary: 'Deactivate API Key by id',
+        method: 'PATCH',
+        path: '/:id/deactivate',
+        metadata: {
+            auth: true,
+        },
+        pathParams: z.object({
+            id: apiKeyIdSchema,
+        }),
+        body: z.object({}),
+        responses: {
+            202: ApiKeyZod,
+            400: BadRequestError,
+            401: UnauthorizedError,
+            404: NotFoundError,
+            500: InternalError,
+        },
+    },
+}, {
+    pathPrefix: 'api-keys',
+});
+//# sourceMappingURL=index.js.map

package/contracts/clients/api-keys/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EACL,cAAc,EACd,aAAa,EACb,iBAAiB,EACjB,aAAa,EACb,SAAS,EACT,iBAAiB,EACjB,oBAAoB,EACpB,eAAe,EACf,cAAc,GACf,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,CAAC,GAAG,YAAY,EAAE,CAAC;AAEzB,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CACrC;IACE,UAAU,EAAE;QACV,OAAO,EAAE,cAAc;QACvB,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,EAAE;QACR,QAAQ,EAAE;YACR,IAAI,EAAE,IAAI;SACX;QACD,KAAK,EAAE,oBAAoB;QAC3B,SAAS,EAAE;YACT,GAAG,EAAE,iBAAiB;YACtB,GAAG,EAAE,iBAAiB;YACtB,GAAG,EAAE,cAAc;SACpB;KACF;IACD,SAAS,EAAE;QACT,OAAO,EAAE,aAAa;QACtB,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,MAAM;QACZ,QAAQ,EAAE;YACR,IAAI,EAAE,IAAI;SACX;QACD,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC;YACnB,EAAE,EAAE,cAAc;SACnB,CAAC;QACF,SAAS,EAAE;YACT,GAAG,EAAE,SAAS;YACd,GAAG,EAAE,iBAAiB;YACtB,GAAG,EAAE,cAAc;YACnB,GAAG,EAAE,aAAa;SACnB;KACF;IACD,gBAAgB,EAAE;QAChB,OAAO,EAAE,0BAA0B;QACnC,MAAM,EAAE,OAAO;QACf,IAAI,EAAE,iBAAiB;QACvB,QAAQ,EAAE;YACR,IAAI,EAAE,IAAI;SACX;QACD,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC;YACnB,EAAE,EAAE,cAAc;SACnB,CAAC;QACF,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC;QAClB,SAAS,EAAE;YACT,GAAG,EAAE,SAAS;YACd,GAAG,EAAE,eAAe;YACpB,GAAG,EAAE,iBAAiB;YACtB,GAAG,EAAE,aAAa;YAClB,GAAG,EAAE,aAAa;SACnB;KACF;CACF,EACD;IACE,UAAU,EAAE,UAAU;CACvB,CACF,CAAC"}