@assemblis/contracts 0.2.5 → 1.0.0

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()
-	})
-};

package/src/types/api.ts

@@ -1,66 +0,0 @@
-import z from 'zod';
-import {
-	PatchAccountReportsIdPublishSchema,
-	PostAccountReportsIdCoverImageSchema,
-	PutAccountReportsIdContentSchema,
-	LogSchema,
-	PinListSchema,
-	PinSchema
-} from '../schemas';
-import {
-	AssembliesListSchema,
-	AssemblyDetailSchema,
-	AssemblyOverviewSchema,
-	FeedbackSchema,
-	RegisterSchema,
-	SurveyResponseSchema,
-	SurveySchema
-} from '../schemas/legacy';
-
-export type PutAccountReportsIdContentPayload = z.infer<
-	(typeof PutAccountReportsIdContentSchema)['payload']
->;
-export type PublishReportPayload = z.infer<
-	(typeof PatchAccountReportsIdPublishSchema)['payload']
->;
-export type ImageMetadataPayload = z.infer<
-	(typeof PostAccountReportsIdCoverImageSchema)['payload']
->;
-
-export type AssemblyDetailPayload = z.infer<
-	(typeof AssemblyDetailSchema)['payload']
->;
-export type AssemblyOverviewPayload = z.infer<
-	(typeof AssemblyOverviewSchema)['payload']
->;
-export type AssembliesListPayload = z.infer<
-	(typeof AssembliesListSchema)['payload']
->;
-export type FeedbackPayload = z.infer<(typeof FeedbackSchema)['payload']>;
-export type LogPayload = z.infer<(typeof LogSchema)['payload']>;
-export type PinPayload = z.infer<(typeof PinSchema)['payload']>;
-export type PinListPayload = z.infer<(typeof PinListSchema)['payload']>;
-export type RegisterPayload = z.infer<(typeof RegisterSchema)['payload']>;
-export type SurveyPayload = z.infer<(typeof SurveySchema)['payload']>;
-export type SurveyResponsePayload = z.infer<
-	(typeof SurveyResponseSchema)['payload']
->;
-
-export type AssemblyDetailResponse = z.infer<
-	(typeof AssemblyDetailSchema)['response']
->;
-export type AssemblyOverviewResponse = z.infer<
-	(typeof AssemblyOverviewSchema)['response']
->;
-export type AssembliesListResponse = z.infer<
-	(typeof AssembliesListSchema)['response']
->;
-export type FeedbackResponse = z.infer<(typeof FeedbackSchema)['response']>;
-export type LogResponse = z.infer<(typeof LogSchema)['response']>;
-export type PinResponse = z.infer<(typeof PinSchema)['response']>;
-export type PinListResponse = z.infer<(typeof PinListSchema)['response']>;
-export type RegisterResponse = z.infer<(typeof RegisterSchema)['response']>;
-export type SurveyResponse = z.infer<(typeof SurveySchema)['response']>;
-export type SurveyResponseResponse = z.infer<
-	(typeof SurveyResponseSchema)['response']
->;