@assemblis/contracts 0.2.6 → 1.1.0

package/src/schemas/api.ts

@@ -3,32 +3,33 @@ import z from 'zod';
 import { ApiEndpoint, ApiRestMethod } from '../types';
 
 import {
+	AssemblySchema,
 	ImageSchema,
 	InterestSchema,
+	LogSchema,
+	PinSchema,
+	RegisterSchema,
 	ReportContentSchema,
 	ReportSchema
 } from './base';
 import { isoDateString, maybe } from './utils';
 
-type AccountEndpoint = `/account/${string}`;
-
 export const GetAccountReportsSchema = {
-	endpoint: (): AccountEndpoint => ApiEndpoint.ACCOUNT_REPORTS,
+	endpoint: ApiEndpoint.ACCOUNT_REPORTS as const,
 	method: ApiRestMethod.GET,
 	payload: z.never(),
 	response: z.object({ reports: ReportSchema.array(), total: z.int() })
 };
 
 export const GetAccountReportsIdSchema = {
-	endpoint: (reportId: string): AccountEndpoint =>
-		`${ApiEndpoint.ACCOUNT_REPORTS}/${reportId}`,
+	endpoint: `${ApiEndpoint.ACCOUNT_REPORTS}/:client_id` as const,
 	method: ApiRestMethod.GET,
 	payload: z.never(),
 	response: maybe(ReportSchema)
 };
 
 export const PostAccountReportsSchema = {
-	endpoint: (): AccountEndpoint => ApiEndpoint.ACCOUNT_REPORTS,
+	endpoint: ApiEndpoint.ACCOUNT_REPORTS as const,
 	method: ApiRestMethod.POST,
 	payload: z.object({
 		client_id: z.uuid(),
@@ -38,8 +39,7 @@ export const PostAccountReportsSchema = {
 };
 
 export const PutAccountReportsIdContentSchema = {
-	endpoint: (clientId: string): AccountEndpoint =>
-		`${ApiEndpoint.ACCOUNT_REPORTS}/${clientId}/content`,
+	endpoint: `${ApiEndpoint.ACCOUNT_REPORTS}/:client_id/content` as const,
 	method: ApiRestMethod.PUT,
 	payload: ReportContentSchema.omit({
 		published_at: true,
@@ -49,54 +49,116 @@ export const PutAccountReportsIdContentSchema = {
 };
 
 export const PatchAccountReportsIdDiscardSchema = {
-	endpoint: (clientId: string): AccountEndpoint =>
-		`${ApiEndpoint.ACCOUNT_REPORTS}/${clientId}/discard`,
+	endpoint: `${ApiEndpoint.ACCOUNT_REPORTS}/:client_id/discard` as const,
 	method: ApiRestMethod.PATCH,
 	payload: z.nullish(z.object()),
 	response: maybe(ReportSchema)
 };
 
 export const PatchAccountReportsIdPublishSchema = {
-	endpoint: (clientId: string): AccountEndpoint =>
-		`${ApiEndpoint.ACCOUNT_REPORTS}/${clientId}/publish`,
+	endpoint: `${ApiEndpoint.ACCOUNT_REPORTS}/:client_id/publish` as const,
 	method: ApiRestMethod.PATCH,
 	payload: z.object({ published_at: isoDateString }),
 	response: ReportSchema
 };
 
 export const PatchAccountReportsIdUnpublishSchema = {
-	endpoint: (clientId: string): AccountEndpoint =>
-		`${ApiEndpoint.ACCOUNT_REPORTS}/${clientId}/unpublish`,
+	endpoint: `${ApiEndpoint.ACCOUNT_REPORTS}/:client_id/unpublish` as const,
 	method: ApiRestMethod.PATCH,
 	payload: z.nullish(z.object()),
 	response: ReportSchema
 };
 
 export const PostAccountReportsIdCoverImageSchema = {
-	endpoint: (clientId: string): AccountEndpoint =>
-		`${ApiEndpoint.ACCOUNT_REPORTS}/${clientId}/cover-image`,
+	endpoint: `${ApiEndpoint.ACCOUNT_REPORTS}/:client_id/cover-image` as const,
 	method: ApiRestMethod.POST,
 	payload: ImageSchema.pick({ alt: true }),
 	response: ReportSchema
 };
 
 export const PostInterestSchema = {
-	endpoint: () => ApiEndpoint.INTEREST,
+	endpoint: ApiEndpoint.INTEREST as const,
 	method: ApiRestMethod.POST,
 	payload: InterestSchema,
 	response: z.string()
 };
 
+export const PostInterestAssemblisSchema = {
+	endpoint: `${ApiEndpoint.INTEREST}/assemblis` as const,
+	method: ApiRestMethod.POST,
+	payload: InterestSchema.omit({ listIds: true }),
+	response: z.string()
+};
+
 export const GetReportsSchema = {
-	endpoint: () => ApiEndpoint.REPORTS,
+	endpoint: ApiEndpoint.REPORTS as const,
 	method: ApiRestMethod.GET,
 	payload: z.never(),
-	response: z.object({ reports: ReportSchema.array() })
+	response: z.object({
+		reports: ReportSchema.array(),
+		total: z.int()
+	})
 };
 
-export const GetReportsIdSchema = {
-	endpoint: (slug: string) => `${ApiEndpoint.REPORTS}/${slug}`,
+export const GetReportsSlugSchema = {
+	endpoint: `${ApiEndpoint.REPORTS}/:slug` as const,
 	method: ApiRestMethod.GET,
 	payload: z.never(),
 	response: maybe(ReportSchema)
 };
+
+export const GetPinsSchema = {
+	endpoint: ApiEndpoint.PINS as const,
+	method: ApiRestMethod.GET,
+	payload: z.never(),
+	response: z.object({
+		assemblies: AssemblySchema.array(),
+		pins: PinSchema.array()
+	})
+};
+
+export const PostPinSchema = {
+	endpoint: ApiEndpoint.PINS as const,
+	method: ApiRestMethod.POST,
+	payload: z.object({
+		country: z.string(),
+		email: z.string(),
+		text: maybe(z.string())
+	}),
+	response: PinSchema
+};
+
+export const PatchPinHideSchema = {
+	endpoint: `${ApiEndpoint.PINS}/:id/hide` as const,
+	method: ApiRestMethod.PATCH,
+	payload: z.never(),
+	response: PinSchema
+};
+
+export const GetPingSchema = {
+	endpoint: ApiEndpoint.PING as const,
+	method: ApiRestMethod.GET,
+	payload: z.never(),
+	response: z.never()
+};
+
+export const PostLogsInfoSchema = {
+	endpoint: `${ApiEndpoint.LOGS}/info` as const,
+	method: ApiRestMethod.POST,
+	payload: LogSchema,
+	response: z.string()
+};
+
+export const PostLogsErrorSchema = {
+	endpoint: `${ApiEndpoint.LOGS}/error` as const,
+	method: ApiRestMethod.POST,
+	payload: LogSchema,
+	response: z.string()
+};
+
+export const PostRegisterSchema = {
+	endpoint: ApiEndpoint.REGISTER as const,
+	method: ApiRestMethod.POST,
+	payload: RegisterSchema,
+	response: z.string()
+};

package/src/schemas/base.ts

@@ -1,6 +1,7 @@
 // Base type schemas
 
 import z from 'zod';
+
 import { isoDateString, maybe } from './utils';
 
 export const ImageSchema = z.object({
@@ -32,12 +33,11 @@ export const InterestSchema = z.object({
 	organisation: z
 		.string()
 		.nullish()
-		.transform((_) => _ ?? undefined)
-});
-
-export const OptionSchema = z.object({
-	label: z.string(),
-	value: z.coerce.number().int()
+		.transform((_) => _ ?? undefined),
+	has_assemblis_account: z
+		.boolean()
+		.nullish()
+		.transform((_) => _ ?? false)
 });
 
 export const ReportContentSchema = z.object({
@@ -80,3 +80,49 @@ export const UserSchema = z.object({
 	sub: z.string(),
 	is_mutirao: z.boolean()
 });
+
+// Pins
+export const AssemblySchema = z.object({
+	id: z.uuid(),
+	created_at: isoDateString,
+	updated_at: isoDateString,
+	image_src: maybe(z.string()),
+	has_image: z.boolean().meta({ deprecated: true }),
+	user_id: z.uuid().meta({ deprecated: true }),
+	published_at: maybe(isoDateString),
+	name: z.string(),
+	about: maybe(z.string()),
+	topics: z.string().array(),
+	country: maybe(z.string()),
+	hide: z.boolean().default(false)
+});
+
+export const PinSchema = z.object({
+	id: z.uuid(),
+	created_at: z.coerce.date().transform((_) => _.toISOString()),
+	updated_at: z.coerce.date().transform((_) => _.toISOString()),
+	country: z.string(),
+	text: maybe(z.string()),
+	hide: z.boolean(),
+	image_src: maybe(z.string()),
+	has_image: z.boolean().meta({ deprecated: true })
+});
+
+export const LogSchema = z.object({
+	message: z.string().optional(),
+	data: z.record(z.string(), z.string().optional()).optional(),
+	metadata: z.object({
+		origin: z.string(),
+		route: z.string(),
+		status: z.number()
+	})
+});
+
+export const RegisterSchema = z.object({
+	type: z.literal('user.created'),
+	object: z.literal('event'),
+	data: z.object({
+		id: z.string(),
+		email_addresses: z.object({ email_address: z.string() }).array()
+	})
+});

package/src/schemas/index.ts

@@ -1,2 +1,2 @@
 export * from './api';
-export * from './legacy';
+export { resolvePath, type ExtractParams } from './utils';

package/src/schemas/utils.ts

@@ -3,3 +3,20 @@ import z, { ZodType } from 'zod';
 export const isoDateString = z.coerce.date().transform((_) => _.toISOString());
 export const maybe = <T extends ZodType<unknown>>(_: T) =>
 	_.nullish().transform((_) => _ ?? null);
+
+export type ExtractParams<T extends string> =
+	T extends `${string}:${infer Param}/${infer Rest}`
+		? Param | ExtractParams<`/${Rest}`>
+		: T extends `${string}:${infer Param}`
+		? Param
+		: never;
+
+export function resolvePath<T extends string>(
+	template: T,
+	params: Record<ExtractParams<T>, string>
+): string {
+	return (Object.keys(params) as ExtractParams<T>[]).reduce(
+		(path, key) => path.replace(`:${key}`, params[key]),
+		template as string
+	);
+}

package/src/types/enums.ts

@@ -1,26 +1,19 @@
-export enum ApiRestMethod {
-	GET = 'GET',
-	POST = 'POST',
-	PUT = 'PUT',
-	PATCH = 'PATCH'
-}
-
-export enum ApiRouteParameter {
-	ID = ':ID',
-	NAME = ':NAME'
-}
-
 export enum ApiEndpoint {
+	ACCOUNT = '/account',
 	ACCOUNT_REPORTS = '/account/reports',
-	ASSEMBLIES = '/assemblies',
-	FEEDBACK = '/feedback',
 	INTEREST = '/interest',
-	INTEREST_ASSEMBLIS = '/interest/assemblis',
 	LOGS = '/logs',
+	PING = '/ping',
 	PINS = '/pins',
-	REPORTS = '/reports',
-	SURVEYS = '/surveys',
-	SURVEY_RESPONSES = '/assemblies/:ID/survey-responses/:NAME'
+	REGISTER = '/register',
+	REPORTS = '/reports'
+}
+
+export enum ApiRestMethod {
+	GET = 'GET',
+	POST = 'POST',
+	PUT = 'PUT',
+	PATCH = 'PATCH'
 }
 
 export enum ReportState {
@@ -29,10 +22,3 @@ export enum ReportState {
 	PUBLISHED = 'PUBLISHED',
 	CHANGED = 'CHANGED'
 }
-
-export enum SurveyName {
-	DELIBERATION = 'deliberation',
-	DEMOGRAPHIC_DATA = 'demographic-data',
-	PRE_ASSEMBLY = 'pre-assembly',
-	POST_ASSEMBLY = 'post-assembly'
-}

package/src/types/index.ts

@@ -1,3 +1,2 @@
-export * from './api';
 export * from './enums';
 export * from './types';

package/src/types/types.ts

@@ -1,12 +1,15 @@
 import z from 'zod';
+
 import {
-	ReportSchema,
-	UserSchema,
+	ImageSchema,
+	PinSchema,
 	ReportContentSchema,
-	ImageSchema
+	ReportSchema,
+	UserSchema
 } from '../schemas/base';
 
 export type Image = z.infer<typeof ImageSchema>;
+export type Pin = z.infer<typeof PinSchema>;
 export type Report = z.infer<typeof ReportSchema>;
 export type ReportContent = z.infer<typeof ReportContentSchema>;
 export type User = z.infer<typeof UserSchema>;

package/src/schemas/legacy.ts

@@ -1,328 +0,0 @@
-import z from 'zod';
-import { isoDateString, maybe } from './utils';
-import { OptionSchema } from './base';
-
-export const FeedbackSchema = {
-	payload: z.object({
-		route: z.string(),
-		text: z.string(),
-		metadata: z.unknown()
-	}),
-	response: z.string()
-};
-
-export const LogSchema = {
-	payload: z.object({
-		message: z.string().optional(),
-		data: z.record(z.string(), z.string().optional()).optional(),
-		metadata: z.object({
-			origin: z.string(),
-			route: z.string(),
-			status: z.number()
-		})
-	}),
-	response: z.string()
-};
-
-export const RegisterSchema = {
-	payload: z.object({
-		type: z.literal('user.created'),
-		object: z.literal('event'),
-		data: z.object({
-			id: z.string(),
-			email_addresses: z.object({ email_address: z.string() }).array()
-		})
-	}),
-	response: z.string()
-};
-
-/** Deprecated */
-
-// Surveys
-const SurveyQuestionSchema = z.object({
-	id: z.uuid(),
-	text: z.string()
-});
-
-export const SurveySchema = {
-	payload: z.undefined(),
-	response: z.object({
-		id: z.uuid(),
-		created_at: isoDateString,
-		updated_at: isoDateString,
-		name: z.string(),
-		sections: z
-			.object({
-				primary: SurveyQuestionSchema,
-				secondary: SurveyQuestionSchema.array(),
-				options: OptionSchema.array()
-			})
-			.array()
-	})
-};
-
-export const SurveyResponseSchema = {
-	payload: z.object({
-		answers: z
-			.object({
-				question_id: z.uuid(),
-				answer_value: z.coerce.number().int()
-			})
-			.array()
-	}),
-	response: z.object({
-		total: z.number().int()
-	})
-};
-
-// Action Plans
-const ActionPlanSchema = z.object({
-	visible_on_profile: z.boolean(),
-	description: maybe(z.string())
-});
-
-const ActionSchema = z.object({
-	text: z.string(),
-	agreed: maybe(z.coerce.number().int()),
-	against: maybe(z.coerce.number().int()),
-	abstained: maybe(z.coerce.number().int()),
-	include_in_action_plan: z.boolean().default(true),
-	assembly_id: z.uuid()
-});
-
-const TaskSchema = z.object({
-	text: z.string(),
-	complete: z.boolean().default(false),
-	action_id: z.uuid(),
-	assembly_id: z.uuid()
-});
-
-// Assembly Overviews
-const BaseAssemblyOverviewSchema = z.object({
-	published_at: maybe(isoDateString),
-	name: z.string(),
-	about: maybe(z.string()),
-	topics: z.string().array(),
-	country: maybe(z.string()),
-	hide: z.boolean().default(false)
-});
-export const AssemblyOverviewSchema = {
-	payload: BaseAssemblyOverviewSchema,
-	response: BaseAssemblyOverviewSchema.extend({
-		id: z.uuid(),
-		created_at: isoDateString,
-		updated_at: isoDateString,
-		image_src: maybe(z.string()),
-		has_image: z.boolean().meta({ deprecated: true }),
-		user_id: z.uuid().meta({ deprecated: true })
-	})
-};
-export const AssembliesListSchema = {
-	payload: z.undefined(),
-	response: z.object({
-		assemblies: AssemblyOverviewSchema.response.array()
-	})
-};
-
-// Assembly Details
-const OrganisationSchema = z.object({
-	visible_on_profile: z.boolean(),
-	name: maybe(z.string()),
-	description: maybe(z.string()),
-	type: maybe(z.string())
-});
-const EventDetailsSchema = z.object({
-	visible_on_profile: z.boolean(),
-	registration_link: maybe(z.string()),
-	start_date: maybe(isoDateString)
-});
-const StorySchema = z.object({
-	visible_on_profile: z.boolean(),
-	background: maybe(z.string())
-});
-const SupportersSchema = z.object({
-	visible_on_profile: z.boolean(),
-	organisation_types: z.string().array(),
-	description: maybe(z.string())
-});
-const FundersSchema = z.object({
-	visible_on_profile: z.boolean(),
-	organisation_types: z.string().array(),
-	description: maybe(z.string())
-});
-const FacilitationSchema = z.object({
-	visible_on_profile: z.boolean(),
-	decision_method: maybe(z.string())
-});
-const ParticipantsSchema = z.object({
-	visible_on_profile: z.boolean(),
-	recruitment_method: maybe(z.string()),
-	community: maybe(z.string())
-});
-const SupportSchema = z.object({
-	visible_on_profile: z.boolean(),
-	support_options: z.string().array()
-});
-const SurveyDetailsSchema = z.object({
-	visible_on_profile: z.boolean()
-});
-export const AssemblyDetailSchema = {
-	payload: AssemblyOverviewSchema.payload.extend({
-		organisation: maybe(
-			OrganisationSchema.extend({
-				id: z.uuid().optional()
-			})
-		),
-		event_details: maybe(EventDetailsSchema),
-		story: maybe(StorySchema),
-		supporters: maybe(SupportersSchema),
-		funders: maybe(FundersSchema),
-		facilitation: maybe(FacilitationSchema),
-		participants: maybe(ParticipantsSchema),
-		support: maybe(SupportSchema),
-		action_plan: maybe(
-			ActionPlanSchema.extend({
-				actions: ActionSchema.omit({ assembly_id: true })
-					.extend({
-						id: z.uuid().optional(),
-						tasks: TaskSchema.omit({
-							action_id: true,
-							assembly_id: true
-						})
-							.extend({
-								id: z.uuid().optional()
-							})
-							.array(),
-						updates: z.unknown().array()
-					})
-					.array(),
-				updates: z.unknown().array()
-			})
-		),
-		surveys: maybe(SurveyDetailsSchema)
-	}),
-	response: AssemblyOverviewSchema.response.omit({ user_id: true }).extend({
-		is_own: z.boolean(),
-		organisation: maybe(
-			OrganisationSchema.extend({
-				id: z.uuid(),
-				created_at: isoDateString,
-				updated_at: isoDateString
-			})
-		),
-		event_details: maybe(
-			EventDetailsSchema.extend({
-				created_at: isoDateString,
-				updated_at: isoDateString
-			})
-		),
-		story: maybe(
-			StorySchema.extend({
-				created_at: isoDateString,
-				updated_at: isoDateString
-			})
-		),
-		supporters: maybe(
-			SupportersSchema.extend({
-				created_at: isoDateString,
-				updated_at: isoDateString
-			})
-		),
-		funders: maybe(
-			FundersSchema.extend({
-				created_at: isoDateString,
-				updated_at: isoDateString
-			})
-		),
-		facilitation: maybe(
-			FacilitationSchema.extend({
-				created_at: isoDateString,
-				updated_at: isoDateString
-			})
-		),
-		participants: maybe(
-			ParticipantsSchema.extend({
-				created_at: isoDateString,
-				updated_at: isoDateString
-			})
-		),
-		support: maybe(
-			SupportSchema.extend({
-				created_at: isoDateString,
-				updated_at: isoDateString
-			})
-		),
-		action_plan: maybe(
-			ActionPlanSchema.extend({
-				actions: ActionSchema.omit({ assembly_id: true })
-					.extend({
-						id: z.uuid(),
-						created_at: isoDateString,
-						updated_at: z.coerce.date().transform((_) => _.toISOString()),
-						tasks: TaskSchema.omit({
-							action_id: true,
-							assembly_id: true
-						})
-							.extend({
-								id: z.uuid(),
-								created_at: z.coerce.date().transform((_) => _.toISOString()),
-								updated_at: z.coerce.date().transform((_) => _.toISOString())
-							})
-							.array(),
-						updates: z.unknown().array()
-					})
-					.extend({
-						created_at: z.coerce.date().transform((_) => _.toISOString()),
-						updated_at: z.coerce.date().transform((_) => _.toISOString())
-					})
-					.array(),
-				updates: z.unknown().array()
-			}).and(
-				z.object({
-					created_at: z.coerce.date().transform((_) => _.toISOString()),
-					updated_at: z.coerce.date().transform((_) => _.toISOString())
-				})
-			)
-		),
-		surveys: maybe(
-			SurveyDetailsSchema.extend({
-				created_at: z.coerce.date().transform((_) => _.toISOString()),
-				updated_at: z.coerce.date().transform((_) => _.toISOString())
-			}).extend({
-				data: z.record(
-					z.string(),
-					z.object({
-						total: z.number().int(),
-						responses: z.record(z.string(), OptionSchema.array())
-					})
-				)
-			})
-		)
-	})
-};
-
-// Pins
-export const PinSchema = {
-	payload: z.object({
-		country: z.string(),
-		email: z.string(),
-		text: maybe(z.string())
-	}),
-	response: z.object({
-		id: z.uuid(),
-		created_at: z.coerce.date().transform((_) => _.toISOString()),
-		updated_at: z.coerce.date().transform((_) => _.toISOString()),
-		country: z.string(),
-		text: maybe(z.string()),
-		hide: z.boolean(),
-		image_src: maybe(z.string()),
-		has_image: z.boolean().meta({ deprecated: true })
-	})
-};
-export const PinListSchema = {
-	payload: z.undefined(),
-	response: z.object({
-		assemblies: AssemblyOverviewSchema.response.array(),
-		pins: PinSchema.response.array()
-	})
-};