@ysk-kit/contracts 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 YSK Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/api/api-keys.d.ts

@@ -0,0 +1,220 @@
+import { z } from 'zod';
+export declare const apiKeysContract: {
+    list: {
+        summary: "List my API keys";
+        method: "GET";
+        path: "/v1/me/api-keys";
+        responses: {
+            200: z.ZodObject<{
+                ok: z.ZodLiteral<true>;
+                data: z.ZodArray<z.ZodObject<{
+                    id: z.ZodString;
+                    name: z.ZodString;
+                    prefix: z.ZodString;
+                    last4: z.ZodString;
+                    permissions: z.ZodArray<z.ZodEnum<{
+                        "user.create": "user.create";
+                        "user.suspend": "user.suspend";
+                        "audit.read": "audit.read";
+                        "file.upload": "file.upload";
+                        "llm.use": "llm.use";
+                        "billing.checkout": "billing.checkout";
+                    }>>;
+                    createdAt: z.ZodISODateTime;
+                    lastUsedAt: z.ZodNullable<z.ZodISODateTime>;
+                }, z.core.$strip>>;
+            }, z.core.$strip>;
+            401: z.ZodObject<{
+                ok: z.ZodLiteral<false>;
+                error: z.ZodObject<{
+                    code: z.ZodEnum<{
+                        VALIDATION_FAILED: "VALIDATION_FAILED";
+                        UNAUTHENTICATED: "UNAUTHENTICATED";
+                        FORBIDDEN: "FORBIDDEN";
+                        NOT_FOUND: "NOT_FOUND";
+                        CONFLICT: "CONFLICT";
+                        RATE_LIMITED: "RATE_LIMITED";
+                        INTERNAL: "INTERNAL";
+                    }>;
+                    message: z.ZodString;
+                    details: z.ZodOptional<z.ZodUnknown>;
+                    requestId: z.ZodOptional<z.ZodString>;
+                }, z.core.$strip>;
+            }, z.core.$strip>;
+            403: z.ZodObject<{
+                ok: z.ZodLiteral<false>;
+                error: z.ZodObject<{
+                    code: z.ZodEnum<{
+                        VALIDATION_FAILED: "VALIDATION_FAILED";
+                        UNAUTHENTICATED: "UNAUTHENTICATED";
+                        FORBIDDEN: "FORBIDDEN";
+                        NOT_FOUND: "NOT_FOUND";
+                        CONFLICT: "CONFLICT";
+                        RATE_LIMITED: "RATE_LIMITED";
+                        INTERNAL: "INTERNAL";
+                    }>;
+                    message: z.ZodString;
+                    details: z.ZodOptional<z.ZodUnknown>;
+                    requestId: z.ZodOptional<z.ZodString>;
+                }, z.core.$strip>;
+            }, z.core.$strip>;
+        };
+    };
+    create: {
+        summary: "Create an API key (token shown once)";
+        method: "POST";
+        body: z.ZodObject<{
+            name: z.ZodString;
+            permissions: z.ZodArray<z.ZodEnum<{
+                "user.create": "user.create";
+                "user.suspend": "user.suspend";
+                "audit.read": "audit.read";
+                "file.upload": "file.upload";
+                "llm.use": "llm.use";
+                "billing.checkout": "billing.checkout";
+            }>>;
+        }, z.core.$strip>;
+        path: "/v1/me/api-keys";
+        responses: {
+            201: z.ZodObject<{
+                ok: z.ZodLiteral<true>;
+                data: z.ZodObject<{
+                    id: z.ZodString;
+                    name: z.ZodString;
+                    prefix: z.ZodString;
+                    last4: z.ZodString;
+                    permissions: z.ZodArray<z.ZodEnum<{
+                        "user.create": "user.create";
+                        "user.suspend": "user.suspend";
+                        "audit.read": "audit.read";
+                        "file.upload": "file.upload";
+                        "llm.use": "llm.use";
+                        "billing.checkout": "billing.checkout";
+                    }>>;
+                    createdAt: z.ZodISODateTime;
+                    lastUsedAt: z.ZodNullable<z.ZodISODateTime>;
+                    token: z.ZodString;
+                }, z.core.$strip>;
+            }, z.core.$strip>;
+            401: z.ZodObject<{
+                ok: z.ZodLiteral<false>;
+                error: z.ZodObject<{
+                    code: z.ZodEnum<{
+                        VALIDATION_FAILED: "VALIDATION_FAILED";
+                        UNAUTHENTICATED: "UNAUTHENTICATED";
+                        FORBIDDEN: "FORBIDDEN";
+                        NOT_FOUND: "NOT_FOUND";
+                        CONFLICT: "CONFLICT";
+                        RATE_LIMITED: "RATE_LIMITED";
+                        INTERNAL: "INTERNAL";
+                    }>;
+                    message: z.ZodString;
+                    details: z.ZodOptional<z.ZodUnknown>;
+                    requestId: z.ZodOptional<z.ZodString>;
+                }, z.core.$strip>;
+            }, z.core.$strip>;
+            403: z.ZodObject<{
+                ok: z.ZodLiteral<false>;
+                error: z.ZodObject<{
+                    code: z.ZodEnum<{
+                        VALIDATION_FAILED: "VALIDATION_FAILED";
+                        UNAUTHENTICATED: "UNAUTHENTICATED";
+                        FORBIDDEN: "FORBIDDEN";
+                        NOT_FOUND: "NOT_FOUND";
+                        CONFLICT: "CONFLICT";
+                        RATE_LIMITED: "RATE_LIMITED";
+                        INTERNAL: "INTERNAL";
+                    }>;
+                    message: z.ZodString;
+                    details: z.ZodOptional<z.ZodUnknown>;
+                    requestId: z.ZodOptional<z.ZodString>;
+                }, z.core.$strip>;
+            }, z.core.$strip>;
+            422: z.ZodObject<{
+                ok: z.ZodLiteral<false>;
+                error: z.ZodObject<{
+                    code: z.ZodEnum<{
+                        VALIDATION_FAILED: "VALIDATION_FAILED";
+                        UNAUTHENTICATED: "UNAUTHENTICATED";
+                        FORBIDDEN: "FORBIDDEN";
+                        NOT_FOUND: "NOT_FOUND";
+                        CONFLICT: "CONFLICT";
+                        RATE_LIMITED: "RATE_LIMITED";
+                        INTERNAL: "INTERNAL";
+                    }>;
+                    message: z.ZodString;
+                    details: z.ZodOptional<z.ZodUnknown>;
+                    requestId: z.ZodOptional<z.ZodString>;
+                }, z.core.$strip>;
+            }, z.core.$strip>;
+        };
+    };
+    revoke: {
+        pathParams: z.ZodObject<{
+            id: z.ZodString;
+        }, z.core.$strip>;
+        summary: "Revoke an API key";
+        method: "DELETE";
+        path: "/v1/me/api-keys/:id";
+        responses: {
+            200: z.ZodObject<{
+                ok: z.ZodLiteral<true>;
+                data: z.ZodObject<{
+                    revoked: z.ZodLiteral<true>;
+                }, z.core.$strip>;
+            }, z.core.$strip>;
+            401: z.ZodObject<{
+                ok: z.ZodLiteral<false>;
+                error: z.ZodObject<{
+                    code: z.ZodEnum<{
+                        VALIDATION_FAILED: "VALIDATION_FAILED";
+                        UNAUTHENTICATED: "UNAUTHENTICATED";
+                        FORBIDDEN: "FORBIDDEN";
+                        NOT_FOUND: "NOT_FOUND";
+                        CONFLICT: "CONFLICT";
+                        RATE_LIMITED: "RATE_LIMITED";
+                        INTERNAL: "INTERNAL";
+                    }>;
+                    message: z.ZodString;
+                    details: z.ZodOptional<z.ZodUnknown>;
+                    requestId: z.ZodOptional<z.ZodString>;
+                }, z.core.$strip>;
+            }, z.core.$strip>;
+            403: z.ZodObject<{
+                ok: z.ZodLiteral<false>;
+                error: z.ZodObject<{
+                    code: z.ZodEnum<{
+                        VALIDATION_FAILED: "VALIDATION_FAILED";
+                        UNAUTHENTICATED: "UNAUTHENTICATED";
+                        FORBIDDEN: "FORBIDDEN";
+                        NOT_FOUND: "NOT_FOUND";
+                        CONFLICT: "CONFLICT";
+                        RATE_LIMITED: "RATE_LIMITED";
+                        INTERNAL: "INTERNAL";
+                    }>;
+                    message: z.ZodString;
+                    details: z.ZodOptional<z.ZodUnknown>;
+                    requestId: z.ZodOptional<z.ZodString>;
+                }, z.core.$strip>;
+            }, z.core.$strip>;
+            404: z.ZodObject<{
+                ok: z.ZodLiteral<false>;
+                error: z.ZodObject<{
+                    code: z.ZodEnum<{
+                        VALIDATION_FAILED: "VALIDATION_FAILED";
+                        UNAUTHENTICATED: "UNAUTHENTICATED";
+                        FORBIDDEN: "FORBIDDEN";
+                        NOT_FOUND: "NOT_FOUND";
+                        CONFLICT: "CONFLICT";
+                        RATE_LIMITED: "RATE_LIMITED";
+                        INTERNAL: "INTERNAL";
+                    }>;
+                    message: z.ZodString;
+                    details: z.ZodOptional<z.ZodUnknown>;
+                    requestId: z.ZodOptional<z.ZodString>;
+                }, z.core.$strip>;
+            }, z.core.$strip>;
+        };
+    };
+};
+//# sourceMappingURL=api-keys.d.ts.map

package/dist/api/api-keys.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-keys.d.ts","sourceRoot":"","sources":["../../src/api/api-keys.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAMxB,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA+B1B,CAAC"}

package/dist/api/api-keys.js

@@ -0,0 +1,38 @@
+import { initContract } from '@ts-rest/core';
+import { z } from 'zod';
+import { ApiKeyDtoSchema, CreateApiKeyCommandSchema, CreatedApiKeyDtoSchema } from '../dto/api-key';
+import { ErrSchema, OkSchema } from '../errors/envelope';
+const c = initContract();
+export const apiKeysContract = c.router({
+    list: {
+        method: 'GET',
+        path: '/v1/me/api-keys',
+        responses: { 200: OkSchema(z.array(ApiKeyDtoSchema)), 401: ErrSchema, 403: ErrSchema },
+        summary: 'List my API keys',
+    },
+    create: {
+        method: 'POST',
+        path: '/v1/me/api-keys',
+        body: CreateApiKeyCommandSchema,
+        responses: {
+            201: OkSchema(CreatedApiKeyDtoSchema),
+            401: ErrSchema,
+            403: ErrSchema,
+            422: ErrSchema,
+        },
+        summary: 'Create an API key (token shown once)',
+    },
+    revoke: {
+        method: 'DELETE',
+        path: '/v1/me/api-keys/:id',
+        pathParams: z.object({ id: z.string().uuid() }),
+        responses: {
+            200: OkSchema(z.object({ revoked: z.literal(true) })),
+            401: ErrSchema,
+            403: ErrSchema,
+            404: ErrSchema,
+        },
+        summary: 'Revoke an API key',
+    },
+});
+//# sourceMappingURL=api-keys.js.map

package/dist/api/api-keys.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-keys.js","sourceRoot":"","sources":["../../src/api/api-keys.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,eAAe,EAAE,yBAAyB,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AACpG,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAEzD,MAAM,CAAC,GAAG,YAAY,EAAE,CAAC;AAEzB,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,IAAI,EAAE;QACJ,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,iBAAiB;QACvB,SAAS,EAAE,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,EAAE,SAAS,EAAE;QACtF,OAAO,EAAE,kBAAkB;KAC5B;IACD,MAAM,EAAE;QACN,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,iBAAiB;QACvB,IAAI,EAAE,yBAAyB;QAC/B,SAAS,EAAE;YACT,GAAG,EAAE,QAAQ,CAAC,sBAAsB,CAAC;YACrC,GAAG,EAAE,SAAS;YACd,GAAG,EAAE,SAAS;YACd,GAAG,EAAE,SAAS;SACf;QACD,OAAO,EAAE,sCAAsC;KAChD;IACD,MAAM,EAAE;QACN,MAAM,EAAE,QAAQ;QAChB,IAAI,EAAE,qBAAqB;QAC3B,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC;QAC/C,SAAS,EAAE;YACT,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACrD,GAAG,EAAE,SAAS;YACd,GAAG,EAAE,SAAS;YACd,GAAG,EAAE,SAAS;SACf;QACD,OAAO,EAAE,mBAAmB;KAC7B;CACF,CAAC,CAAC"}

package/dist/api/audit.d.ts

@@ -0,0 +1,75 @@
+export declare const auditContract: {
+    list: {
+        query: import("zod").ZodObject<{
+            cursor: import("zod").ZodOptional<import("zod").ZodString>;
+            limit: import("zod").ZodDefault<import("zod").ZodCoercedNumber<unknown>>;
+        }, import("zod/v4/core").$strip>;
+        summary: "List audit logs";
+        method: "GET";
+        path: "/v1/audit-logs";
+        responses: {
+            200: import("zod").ZodObject<{
+                ok: import("zod").ZodLiteral<true>;
+                data: import("zod").ZodObject<{
+                    items: import("zod").ZodArray<import("zod").ZodObject<{
+                        id: import("zod").ZodString;
+                        actorId: import("zod").ZodNullable<import("zod").ZodString>;
+                        action: import("zod").ZodEnum<{
+                            "user.create": "user.create";
+                            "user.suspend": "user.suspend";
+                            "file.upload": "file.upload";
+                            "auth.register": "auth.register";
+                            "auth.login": "auth.login";
+                            "auth.logout": "auth.logout";
+                            "auth.reset": "auth.reset";
+                            "org.create": "org.create";
+                            "org.invite": "org.invite";
+                            "org.member.remove": "org.member.remove";
+                            "api_key.create": "api_key.create";
+                            "api_key.revoke": "api_key.revoke";
+                        }>;
+                        resourceType: import("zod").ZodString;
+                        resourceId: import("zod").ZodString;
+                        createdAt: import("zod").ZodISODateTime;
+                    }, import("zod/v4/core").$strip>>;
+                    nextCursor: import("zod").ZodNullable<import("zod").ZodString>;
+                }, import("zod/v4/core").$strip>;
+            }, import("zod/v4/core").$strip>;
+            401: import("zod").ZodObject<{
+                ok: import("zod").ZodLiteral<false>;
+                error: import("zod").ZodObject<{
+                    code: import("zod").ZodEnum<{
+                        VALIDATION_FAILED: "VALIDATION_FAILED";
+                        UNAUTHENTICATED: "UNAUTHENTICATED";
+                        FORBIDDEN: "FORBIDDEN";
+                        NOT_FOUND: "NOT_FOUND";
+                        CONFLICT: "CONFLICT";
+                        RATE_LIMITED: "RATE_LIMITED";
+                        INTERNAL: "INTERNAL";
+                    }>;
+                    message: import("zod").ZodString;
+                    details: import("zod").ZodOptional<import("zod").ZodUnknown>;
+                    requestId: import("zod").ZodOptional<import("zod").ZodString>;
+                }, import("zod/v4/core").$strip>;
+            }, import("zod/v4/core").$strip>;
+            403: import("zod").ZodObject<{
+                ok: import("zod").ZodLiteral<false>;
+                error: import("zod").ZodObject<{
+                    code: import("zod").ZodEnum<{
+                        VALIDATION_FAILED: "VALIDATION_FAILED";
+                        UNAUTHENTICATED: "UNAUTHENTICATED";
+                        FORBIDDEN: "FORBIDDEN";
+                        NOT_FOUND: "NOT_FOUND";
+                        CONFLICT: "CONFLICT";
+                        RATE_LIMITED: "RATE_LIMITED";
+                        INTERNAL: "INTERNAL";
+                    }>;
+                    message: import("zod").ZodString;
+                    details: import("zod").ZodOptional<import("zod").ZodUnknown>;
+                    requestId: import("zod").ZodOptional<import("zod").ZodString>;
+                }, import("zod/v4/core").$strip>;
+            }, import("zod/v4/core").$strip>;
+        };
+    };
+};
+//# sourceMappingURL=audit.d.ts.map

package/dist/api/audit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"audit.d.ts","sourceRoot":"","sources":["../../src/api/audit.ts"],"names":[],"mappings":"AAOA,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAYxB,CAAC"}

package/dist/api/audit.js

@@ -0,0 +1,19 @@
+import { initContract } from '@ts-rest/core';
+import { PaginatedAuditLogsSchema } from '../dto/audit';
+import { PageQuerySchema } from '../dto/user';
+import { ErrSchema, OkSchema } from '../errors/envelope';
+const c = initContract();
+export const auditContract = c.router({
+    list: {
+        method: 'GET',
+        path: '/v1/audit-logs',
+        query: PageQuerySchema,
+        responses: {
+            200: OkSchema(PaginatedAuditLogsSchema),
+            401: ErrSchema,
+            403: ErrSchema,
+        },
+        summary: 'List audit logs',
+    },
+});
+//# sourceMappingURL=audit.js.map

package/dist/api/audit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"audit.js","sourceRoot":"","sources":["../../src/api/audit.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAEzD,MAAM,CAAC,GAAG,YAAY,EAAE,CAAC;AAEzB,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC;IACpC,IAAI,EAAE;QACJ,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,gBAAgB;QACtB,KAAK,EAAE,eAAe;QACtB,SAAS,EAAE;YACT,GAAG,EAAE,QAAQ,CAAC,wBAAwB,CAAC;YACvC,GAAG,EAAE,SAAS;YACd,GAAG,EAAE,SAAS;SACf;QACD,OAAO,EAAE,iBAAiB;KAC3B;CACF,CAAC,CAAC"}