@intlayer/backend-contract 0.0.0-stage → 9.6.0

package/dist/esm/user.mjs

@@ -0,0 +1,149 @@
+import { defineRoute, defineRouteGroup } from "./defineRoute.mjs";
+import { paginatedResponseSchema, responseDataSchema } from "./responseData.mjs";
+import { dateTimeSchema, objectIdSchema, paginationQueryShape, repeatableQueryValueSchema } from "./common.mjs";
+import { z } from "zod/mini";
+
+//#region src/user.ts
+/** Mailing lists a user can subscribe to. */
+const emailsListSchema = z.enum(["newsLetter"]);
+/** Mailing list names, usable as values (`EmailsList.NEWS_LETTER`). */
+const EmailsList = { NEWS_LETTER: "newsLetter" };
+/** User as returned by the API (auth provider and session internals stripped). */
+const userSchema = z.looseObject({
+	id: z.string(),
+	email: z.string(),
+	emailVerified: z.boolean(),
+	name: z.string(),
+	image: z.optional(z.nullable(z.string())),
+	phone: z.optional(z.string()),
+	dateOfBirth: z.optional(dateTimeSchema),
+	emailsList: z.optional(z.partialRecord(emailsListSchema, z.boolean())),
+	/** Stripe customer id. */
+	customerId: z.optional(z.string()),
+	role: z.optional(z.nullable(z.string())),
+	lastLoginMethod: z.optional(z.enum([
+		"email",
+		"google",
+		"github",
+		"passkey"
+	])),
+	lang: z.optional(z.string()),
+	lastActiveOrganizationId: z.optional(z.nullable(z.string())),
+	lastActiveProjectId: z.optional(z.nullable(z.string())),
+	createdAt: dateTimeSchema,
+	updatedAt: dateTimeSchema
+});
+const userIdParamsSchema = z.object({ userId: objectIdSchema });
+/** REST contract of the `/api/user` routes. */
+const userContract = defineRouteGroup({
+	prefix: "/api/user",
+	tag: "User",
+	routes: {
+		getSetupStatus: defineRoute({
+			method: "GET",
+			path: "/setup",
+			summary: "Whether the instance still needs its first admin (self-hosted)",
+			schemas: { response: { 200: responseDataSchema(z.object({ isSetupRequired: z.boolean() })) } }
+		}),
+		getUsers: defineRoute({
+			method: "GET",
+			path: "/",
+			summary: "List users (organization members, or all for admins)",
+			schemas: {
+				querystring: z.looseObject({
+					...paginationQueryShape,
+					ids: z.optional(repeatableQueryValueSchema),
+					firstName: z.optional(z.string()),
+					lastName: z.optional(z.string()),
+					email: z.optional(z.string()),
+					emailVerified: z.optional(z.string()),
+					role: z.optional(z.string()),
+					search: z.optional(z.string()),
+					sortBy: z.optional(z.string()),
+					sortOrder: z.optional(z.string()),
+					/** Admin only: list every user. */
+					fetchAll: z.optional(z.enum(["true", "false"]))
+				}),
+				response: { 200: paginatedResponseSchema(userSchema) }
+			}
+		}),
+		updateUser: defineRoute({
+			method: "PUT",
+			path: "/",
+			summary: "Update a user profile",
+			schemas: {
+				/**
+				* Allow-list. `role`, `emailVerified` and `email` are honoured for
+				* admins only (users change their email through the verified auth
+				* flow). A new `email` is unverified unless `emailVerified` is sent.
+				*/
+				body: z.object({
+					id: objectIdSchema,
+					name: z.optional(z.string().check(z.minLength(1))),
+					email: z.optional(z.string().check(z.email())),
+					phone: z.optional(z.string()),
+					image: z.optional(z.nullable(z.string())),
+					lang: z.optional(z.string()),
+					emailVerified: z.optional(z.boolean()),
+					role: z.optional(z.nullable(z.string()))
+				}),
+				response: { 200: responseDataSchema(userSchema) }
+			}
+		}),
+		createUser: defineRoute({
+			method: "POST",
+			path: "/",
+			summary: "Admin only: create a user (sign-up goes through auth)",
+			schemas: {
+				body: z.object({
+					email: z.string().check(z.minLength(1)),
+					name: z.optional(z.string())
+				}),
+				response: { 200: responseDataSchema(userSchema) }
+			}
+		}),
+		getUserById: defineRoute({
+			method: "GET",
+			path: "/:userId",
+			summary: "Get a user",
+			schemas: {
+				params: userIdParamsSchema,
+				response: { 200: responseDataSchema(userSchema) }
+			}
+		}),
+		getUserByEmail: defineRoute({
+			method: "GET",
+			path: "/email/:email",
+			summary: "Get a user by email",
+			schemas: {
+				params: z.object({ email: z.string().check(z.minLength(1)) }),
+				response: { 200: responseDataSchema(userSchema) }
+			}
+		}),
+		deleteUser: defineRoute({
+			method: "DELETE",
+			path: "/:userId",
+			summary: "Delete a user",
+			schemas: {
+				params: userIdParamsSchema,
+				response: { 200: responseDataSchema(userSchema) }
+			}
+		}),
+		verifyEmailStatusSSE: defineRoute({
+			method: "GET",
+			path: "/verify-email-status/:userId",
+			summary: "Email verification status (server-sent events stream)",
+			schemas: { params: userIdParamsSchema }
+		}),
+		uploadAvatar: defineRoute({
+			method: "POST",
+			path: "/avatar",
+			summary: "Upload the avatar of the signed-in user (raw image body)",
+			schemas: { response: { 200: responseDataSchema(userSchema) } }
+		})
+	}
+});
+
+//#endregion
+export { EmailsList, emailsListSchema, userContract, userSchema };
+//# sourceMappingURL=user.mjs.map

package/dist/esm/user.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.mjs","names":[],"sources":["../../src/user.ts"],"sourcesContent":["import { z } from 'zod/mini';\nimport {\n  dateTimeSchema,\n  objectIdSchema,\n  paginationQueryShape,\n  repeatableQueryValueSchema,\n} from './common';\nimport {\n  defineRoute,\n  defineRouteGroup,\n  type RouteBodyInput,\n  type RouteParams,\n  type RouteQuerystring,\n} from './defineRoute';\nimport {\n  type PaginatedResponse,\n  paginatedResponseSchema,\n  type ResponseData,\n  responseDataSchema,\n} from './responseData';\n\n/** Mailing lists a user can subscribe to. */\nexport const emailsListSchema = z.enum(['newsLetter']);\n\n/** Mailing list names, usable as values (`EmailsList.NEWS_LETTER`). */\nexport const EmailsList = { NEWS_LETTER: 'newsLetter' } as const;\nexport type EmailsList = z.output<typeof emailsListSchema>;\n\n/** User as returned by the API (auth provider and session internals stripped). */\nexport const userSchema = z.looseObject({\n  id: z.string(),\n  email: z.string(),\n  emailVerified: z.boolean(),\n  name: z.string(),\n  image: z.optional(z.nullable(z.string())),\n  phone: z.optional(z.string()),\n  dateOfBirth: z.optional(dateTimeSchema),\n  emailsList: z.optional(z.partialRecord(emailsListSchema, z.boolean())),\n  /** Stripe customer id. */\n  customerId: z.optional(z.string()),\n  role: z.optional(z.nullable(z.string())),\n  lastLoginMethod: z.optional(z.enum(['email', 'google', 'github', 'passkey'])),\n  lang: z.optional(z.string()),\n  lastActiveOrganizationId: z.optional(z.nullable(z.string())),\n  lastActiveProjectId: z.optional(z.nullable(z.string())),\n  createdAt: dateTimeSchema,\n  updatedAt: dateTimeSchema,\n});\n\nexport type UserAPI = z.output<typeof userSchema>;\n\nconst userIdParamsSchema = z.object({ userId: objectIdSchema });\n\n/** REST contract of the `/api/user` routes. */\nexport const userContract = defineRouteGroup({\n  prefix: '/api/user',\n  tag: 'User',\n  routes: {\n    getSetupStatus: defineRoute({\n      method: 'GET',\n      path: '/setup',\n      summary: 'Whether the instance still needs its first admin (self-hosted)',\n      schemas: {\n        response: {\n          200: responseDataSchema(z.object({ isSetupRequired: z.boolean() })),\n        },\n      },\n    }),\n    getUsers: defineRoute({\n      method: 'GET',\n      path: '/',\n      summary: 'List users (organization members, or all for admins)',\n      schemas: {\n        querystring: z.looseObject({\n          ...paginationQueryShape,\n          ids: z.optional(repeatableQueryValueSchema),\n          firstName: z.optional(z.string()),\n          lastName: z.optional(z.string()),\n          email: z.optional(z.string()),\n          emailVerified: z.optional(z.string()),\n          role: z.optional(z.string()),\n          search: z.optional(z.string()),\n          sortBy: z.optional(z.string()),\n          sortOrder: z.optional(z.string()),\n          /** Admin only: list every user. */\n          fetchAll: z.optional(z.enum(['true', 'false'])),\n        }),\n        response: { 200: paginatedResponseSchema(userSchema) },\n      },\n    }),\n    updateUser: defineRoute({\n      method: 'PUT',\n      path: '/',\n      summary: 'Update a user profile',\n      schemas: {\n        /**\n         * Allow-list. `role`, `emailVerified` and `email` are honoured for\n         * admins only (users change their email through the verified auth\n         * flow). A new `email` is unverified unless `emailVerified` is sent.\n         */\n        body: z.object({\n          id: objectIdSchema,\n          name: z.optional(z.string().check(z.minLength(1))),\n          email: z.optional(z.string().check(z.email())),\n          phone: z.optional(z.string()),\n          image: z.optional(z.nullable(z.string())),\n          lang: z.optional(z.string()),\n          emailVerified: z.optional(z.boolean()),\n          role: z.optional(z.nullable(z.string())),\n        }),\n        response: { 200: responseDataSchema(userSchema) },\n      },\n    }),\n    createUser: defineRoute({\n      method: 'POST',\n      path: '/',\n      summary: 'Admin only: create a user (sign-up goes through auth)',\n      schemas: {\n        body: z.object({\n          email: z.string().check(z.minLength(1)),\n          name: z.optional(z.string()),\n        }),\n        response: { 200: responseDataSchema(userSchema) },\n      },\n    }),\n    getUserById: defineRoute({\n      method: 'GET',\n      path: '/:userId',\n      summary: 'Get a user',\n      schemas: {\n        params: userIdParamsSchema,\n        response: { 200: responseDataSchema(userSchema) },\n      },\n    }),\n    getUserByEmail: defineRoute({\n      method: 'GET',\n      path: '/email/:email',\n      summary: 'Get a user by email',\n      schemas: {\n        params: z.object({ email: z.string().check(z.minLength(1)) }),\n        response: { 200: responseDataSchema(userSchema) },\n      },\n    }),\n    deleteUser: defineRoute({\n      method: 'DELETE',\n      path: '/:userId',\n      summary: 'Delete a user',\n      schemas: {\n        params: userIdParamsSchema,\n        response: { 200: responseDataSchema(userSchema) },\n      },\n    }),\n    verifyEmailStatusSSE: defineRoute({\n      method: 'GET',\n      path: '/verify-email-status/:userId',\n      summary: 'Email verification status (server-sent events stream)',\n      schemas: {\n        params: userIdParamsSchema,\n      },\n    }),\n    uploadAvatar: defineRoute({\n      method: 'POST',\n      path: '/avatar',\n      summary: 'Upload the avatar of the signed-in user (raw image body)',\n      schemas: {\n        response: { 200: responseDataSchema(userSchema) },\n      },\n    }),\n  },\n});\n\n/** Route definitions of the `/api/user` group, by name. */\nexport type UserRoutes = (typeof userContract)['routes'];\n\nexport type GetSetupStatusResult = ResponseData<{ isSetupRequired: boolean }>;\nexport type GetUsersParams = RouteQuerystring<UserRoutes['getUsers']>;\nexport type GetUsersResult = PaginatedResponse<UserAPI>;\nexport type UpdateUserBody = RouteBodyInput<UserRoutes['updateUser']>;\nexport type UpdateUserResult = ResponseData<UserAPI>;\nexport type CreateUserBody = RouteBodyInput<UserRoutes['createUser']>;\nexport type CreateUserResult = ResponseData<UserAPI>;\nexport type GetUserByIdParams = RouteParams<UserRoutes['getUserById']>;\nexport type GetUserByIdResult = ResponseData<UserAPI>;\nexport type GetUserByEmailParams = RouteParams<UserRoutes['getUserByEmail']>;\nexport type GetUserByEmailResult = ResponseData<UserAPI>;\nexport type DeleteUserParams = RouteParams<UserRoutes['deleteUser']>;\nexport type DeleteUserResult = ResponseData<UserAPI>;\nexport type UploadUserAvatarResult = ResponseData<UserAPI>;\n"],"mappings":";;;;;;;AAsBA,MAAa,mBAAmB,EAAE,KAAK,CAAC,YAAY,CAAC;;AAGrD,MAAa,aAAa,EAAE,aAAa,aAAa;;AAItD,MAAa,aAAa,EAAE,YAAY;CACtC,IAAI,EAAE,OAAO;CACb,OAAO,EAAE,OAAO;CAChB,eAAe,EAAE,QAAQ;CACzB,MAAM,EAAE,OAAO;CACf,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;CACxC,OAAO,EAAE,SAAS,EAAE,OAAO,CAAC;CAC5B,aAAa,EAAE,SAAS,cAAc;CACtC,YAAY,EAAE,SAAS,EAAE,cAAc,kBAAkB,EAAE,QAAQ,CAAC,CAAC;;CAErE,YAAY,EAAE,SAAS,EAAE,OAAO,CAAC;CACjC,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;CACvC,iBAAiB,EAAE,SAAS,EAAE,KAAK;EAAC;EAAS;EAAU;EAAU;CAAS,CAAC,CAAC;CAC5E,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC;CAC3B,0BAA0B,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;CAC3D,qBAAqB,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;CACtD,WAAW;CACX,WAAW;AACb,CAAC;AAID,MAAM,qBAAqB,EAAE,OAAO,EAAE,QAAQ,eAAe,CAAC;;AAG9D,MAAa,eAAe,iBAAiB;CAC3C,QAAQ;CACR,KAAK;CACL,QAAQ;EACN,gBAAgB,YAAY;GAC1B,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS,EACP,UAAU,EACR,KAAK,mBAAmB,EAAE,OAAO,EAAE,iBAAiB,EAAE,QAAQ,EAAE,CAAC,CAAC,EACpE,EACF;EACF,CAAC;EACD,UAAU,YAAY;GACpB,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,aAAa,EAAE,YAAY;KACzB,GAAG;KACH,KAAK,EAAE,SAAS,0BAA0B;KAC1C,WAAW,EAAE,SAAS,EAAE,OAAO,CAAC;KAChC,UAAU,EAAE,SAAS,EAAE,OAAO,CAAC;KAC/B,OAAO,EAAE,SAAS,EAAE,OAAO,CAAC;KAC5B,eAAe,EAAE,SAAS,EAAE,OAAO,CAAC;KACpC,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC;KAC3B,QAAQ,EAAE,SAAS,EAAE,OAAO,CAAC;KAC7B,QAAQ,EAAE,SAAS,EAAE,OAAO,CAAC;KAC7B,WAAW,EAAE,SAAS,EAAE,OAAO,CAAC;;KAEhC,UAAU,EAAE,SAAS,EAAE,KAAK,CAAC,QAAQ,OAAO,CAAC,CAAC;IAChD,CAAC;IACD,UAAU,EAAE,KAAK,wBAAwB,UAAU,EAAE;GACvD;EACF,CAAC;EACD,YAAY,YAAY;GACtB,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;;;;;;IAMP,MAAM,EAAE,OAAO;KACb,IAAI;KACJ,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC;KACjD,OAAO,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KAC7C,OAAO,EAAE,SAAS,EAAE,OAAO,CAAC;KAC5B,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;KACxC,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC;KAC3B,eAAe,EAAE,SAAS,EAAE,QAAQ,CAAC;KACrC,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IACzC,CAAC;IACD,UAAU,EAAE,KAAK,mBAAmB,UAAU,EAAE;GAClD;EACF,CAAC;EACD,YAAY,YAAY;GACtB,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,MAAM,EAAE,OAAO;KACb,OAAO,EAAE,OAAO,CAAC,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;KACtC,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC;IAC7B,CAAC;IACD,UAAU,EAAE,KAAK,mBAAmB,UAAU,EAAE;GAClD;EACF,CAAC;EACD,aAAa,YAAY;GACvB,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,QAAQ;IACR,UAAU,EAAE,KAAK,mBAAmB,UAAU,EAAE;GAClD;EACF,CAAC;EACD,gBAAgB,YAAY;GAC1B,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC;IAC5D,UAAU,EAAE,KAAK,mBAAmB,UAAU,EAAE;GAClD;EACF,CAAC;EACD,YAAY,YAAY;GACtB,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,QAAQ;IACR,UAAU,EAAE,KAAK,mBAAmB,UAAU,EAAE;GAClD;EACF,CAAC;EACD,sBAAsB,YAAY;GAChC,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS,EACP,QAAQ,mBACV;EACF,CAAC;EACD,cAAc,YAAY;GACxB,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS,EACP,UAAU,EAAE,KAAK,mBAAmB,UAAU,EAAE,EAClD;EACF,CAAC;CACH;AACF,CAAC"}