@assemblis/contracts 0.0.12 → 0.1.0

package/dist/schemas/utils.d.ts

@@ -0,0 +1,11 @@
+import z, { ZodType } from 'zod';
+export declare const isoDateString: z.ZodISODateTime;
+export declare const maybe: <T extends ZodType<unknown>>(
+	_: T
+) => z.ZodPipe<
+	z.ZodOptional<z.ZodNullable<T>>,
+	z.ZodTransform<
+		Awaited<NonNullable<z.core.output<T>>> | null,
+		z.core.output<T> | null | undefined
+	>
+>;

package/dist/types/api.d.ts

@@ -0,0 +1,57 @@
+import z from 'zod';
+import {
+	AssembliesListSchema,
+	AssemblyDetailSchema,
+	AssemblyOverviewSchema,
+	FeedbackSchema,
+	LogSchema,
+	PatchAccountReportsIdPublishSchema,
+	PinListSchema,
+	PinSchema,
+	PostAccountReportsIdCoverImageSchema,
+	RegisterSchema,
+	SurveyResponseSchema,
+	SurveySchema
+} from '../schemas';
+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']
+>;

package/dist/types/enums.d.ts

@@ -0,0 +1,27 @@
+export declare enum ApiRestMethod {
+	GET = 'GET',
+	POST = 'POST',
+	PUT = 'PUT',
+	PATCH = 'PATCH'
+}
+export declare enum ApiRouteParameter {
+	ID = ':ID',
+	NAME = ':NAME'
+}
+export declare enum ApiEndpoint {
+	ACCOUNT_REPORTS = '/account/reports',
+	ASSEMBLIES = '/assemblies',
+	FEEDBACK = '/feedback',
+	INTEREST_ASSEMBLIS = '/interest/assemblis',
+	INTEREST_MUTIRAO = '/interest/mutirao',
+	LOGS = '/logs',
+	PINS = '/pins',
+	SURVEYS = '/surveys',
+	SURVEY_RESPONSES = '/assemblies/:ID/survey-responses/:NAME'
+}
+export declare enum SurveyName {
+	DELIBERATION = 'deliberation',
+	DEMOGRAPHIC_DATA = 'demographic-data',
+	PRE_ASSEMBLY = 'pre-assembly',
+	POST_ASSEMBLY = 'post-assembly'
+}

package/dist/types/index.d.ts

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

package/dist/types/types.d.ts

@@ -0,0 +1,5 @@
+import z from 'zod';
+import { ReportSchema, UserSchema, ReportContentSchema } from '../schemas/base';
+export type Report = z.infer<typeof ReportSchema>;
+export type ReportContent = z.infer<typeof ReportContentSchema>;
+export type User = z.infer<typeof UserSchema>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@assemblis/contracts",
-	"version": "0.0.12",
+	"version": "0.1.0",
 	"private": false,
 	"type": "module",
 	"main": "./dist/index.js",

package/src/schemas/api.ts

@@ -0,0 +1,43 @@
+import z from 'zod';
+import { ImageSchema, ReportContentSchema, ReportSchema } from './base';
+import { isoDateString, maybe } from './utils';
+
+export const GetAccountReportsSchema = {
+	payload: z.never(),
+	response: z.object({ reports: ReportSchema.array() })
+};
+
+export const GetAccountReportsIdSchema = {
+	payload: z.never(),
+	response: ReportSchema
+};
+
+export const PostAccountReportsSchema = {
+	payload: maybe(ReportContentSchema.omit({ cover_image_id: true })),
+	response: ReportSchema
+};
+
+export const PutAccountReportsIdContentSchema = {
+	payload: ReportContentSchema.omit({ cover_image_id: true }),
+	response: ReportSchema
+};
+
+export const PatchAccountReportsIdDiscardSchema = {
+	payload: z.never(),
+	response: maybe(ReportSchema)
+};
+
+export const PatchAccountReportsIdPublishSchema = {
+	payload: z.object({ published_at: isoDateString }),
+	response: ReportSchema
+};
+
+export const PatchAccountReportsIdUnpublishSchema = {
+	payload: z.never(),
+	response: ReportSchema
+};
+
+export const PostAccountReportsIdCoverImageSchema = {
+	payload: ImageSchema.pick({ alt: true }),
+	response: ReportSchema
+};

package/src/schemas/base.ts

@@ -0,0 +1,58 @@
+// Base type schemas
+
+import z from 'zod';
+import { isoDateString, maybe } from './utils';
+
+export const ImageSchema = z.object({
+	id: z.uuid(),
+	created_at: isoDateString,
+	updated_at: isoDateString,
+	uri: z.string(),
+	alt: z.string(),
+	src: z.string(),
+	sizes: z.string(),
+	srcset: z.string()
+});
+
+export const OptionSchema = z.object({
+	label: z.string(),
+	value: z.coerce.number().int()
+});
+
+export const ReportContentSchema = z.object({
+	published_at: maybe(isoDateString),
+	title: maybe(z.string()),
+	description: maybe(z.string()),
+	location: maybe(z.string()),
+	outputs: maybe(z.string().array()),
+	initiation_type: maybe(z.string()),
+	recruitment_method: maybe(z.string()),
+	recruitment_description: maybe(z.string()),
+	participant_count: maybe(z.int()),
+	organiser_reflections: maybe(z.string()),
+	organiser_report_url: maybe(z.string()),
+	location_details: maybe(z.string()),
+	date: maybe(z.string()),
+	duration: maybe(z.int()),
+	contact_information_url: maybe(z.string()),
+	cover_image_id: maybe(z.string())
+});
+
+export const ReportSchema = z.object({
+	id: z.uuid(),
+	created_at: isoDateString,
+	updated_at: isoDateString,
+	published_at: maybe(isoDateString),
+	viewer_password: z.string(),
+	draft_content: maybe(ReportContentSchema),
+	published_content: maybe(ReportContentSchema),
+	media: z.object({ images: ImageSchema.array() })
+});
+
+export const UserSchema = z.object({
+	id: z.uuid(),
+	created_at: isoDateString,
+	updated_at: isoDateString,
+	sub: z.string(),
+	is_mutirao: z.boolean()
+});

package/src/schemas/index.ts

@@ -0,0 +1,2 @@
+export * from './api';
+export * from './legacy';

package/src/{schemas.ts → schemas/legacy.ts}

@@ -1,24 +1,43 @@
-import z, { type ZodType } from 'zod';
+import z from 'zod';
+import { isoDateString, maybe } from './utils';
+import { OptionSchema } from './base';
 
-const maybe = <T extends ZodType<unknown>>(_: T) =>
-	_.nullish().transform((_) => _ ?? null);
+export const FeedbackSchema = {
+	payload: z.object({
+		route: z.string(),
+		text: z.string(),
+		metadata: z.unknown()
+	}),
+	response: z.string()
+};
 
-const OptionSchema = z.object({
-	label: z.string(),
-	value: z.coerce.number().int()
-});
+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 UserSchema = {
-	payload: z.undefined(),
-	response: z.object({
-		id: z.uuid(),
-		created_at: z.coerce.date(),
-		updated_at: z.coerce.date(),
-		sub: z.string(),
-		is_mutirao: z.boolean()
-	})
+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(),
@@ -29,8 +48,8 @@ export const SurveySchema = {
 	payload: z.undefined(),
 	response: z.object({
 		id: z.uuid(),
-		created_at: z.coerce.date(),
-		updated_at: z.coerce.date(),
+		created_at: isoDateString,
+		updated_at: isoDateString,
 		name: z.string(),
 		sections: z
 			.object({
@@ -80,7 +99,7 @@ const TaskSchema = z.object({
 
 // Assembly Overviews
 const BaseAssemblyOverviewSchema = z.object({
-	published_at: maybe(z.coerce.date()),
+	published_at: maybe(isoDateString),
 	name: z.string(),
 	about: maybe(z.string()),
 	topics: z.string().array(),
@@ -91,8 +110,8 @@ export const AssemblyOverviewSchema = {
 	payload: BaseAssemblyOverviewSchema,
 	response: BaseAssemblyOverviewSchema.extend({
 		id: z.uuid(),
-		created_at: z.coerce.date(),
-		updated_at: z.coerce.date(),
+		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 })
@@ -115,7 +134,7 @@ const OrganisationSchema = z.object({
 const EventDetailsSchema = z.object({
 	visible_on_profile: z.boolean(),
 	registration_link: maybe(z.string()),
-	start_date: maybe(z.coerce.date())
+	start_date: maybe(isoDateString)
 });
 const StorySchema = z.object({
 	visible_on_profile: z.boolean(),
@@ -187,50 +206,50 @@ export const AssemblyDetailSchema = {
 		organisation: maybe(
 			OrganisationSchema.extend({
 				id: z.uuid(),
-				created_at: z.coerce.date(),
-				updated_at: z.coerce.date()
+				created_at: isoDateString,
+				updated_at: isoDateString
 			})
 		),
 		event_details: maybe(
 			EventDetailsSchema.extend({
-				created_at: z.coerce.date(),
-				updated_at: z.coerce.date()
+				created_at: isoDateString,
+				updated_at: isoDateString
 			})
 		),
 		story: maybe(
 			StorySchema.extend({
-				created_at: z.coerce.date(),
-				updated_at: z.coerce.date()
+				created_at: isoDateString,
+				updated_at: isoDateString
 			})
 		),
 		supporters: maybe(
 			SupportersSchema.extend({
-				created_at: z.coerce.date(),
-				updated_at: z.coerce.date()
+				created_at: isoDateString,
+				updated_at: isoDateString
 			})
 		),
 		funders: maybe(
 			FundersSchema.extend({
-				created_at: z.coerce.date(),
-				updated_at: z.coerce.date()
+				created_at: isoDateString,
+				updated_at: isoDateString
 			})
 		),
 		facilitation: maybe(
 			FacilitationSchema.extend({
-				created_at: z.coerce.date(),
-				updated_at: z.coerce.date()
+				created_at: isoDateString,
+				updated_at: isoDateString
 			})
 		),
 		participants: maybe(
 			ParticipantsSchema.extend({
-				created_at: z.coerce.date(),
-				updated_at: z.coerce.date()
+				created_at: isoDateString,
+				updated_at: isoDateString
 			})
 		),
 		support: maybe(
 			SupportSchema.extend({
-				created_at: z.coerce.date(),
-				updated_at: z.coerce.date()
+				created_at: isoDateString,
+				updated_at: isoDateString
 			})
 		),
 		action_plan: maybe(
@@ -238,37 +257,37 @@ export const AssemblyDetailSchema = {
 				actions: ActionSchema.omit({ assembly_id: true })
 					.extend({
 						id: z.uuid(),
-						created_at: z.coerce.date(),
-						updated_at: z.coerce.date(),
+						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(),
-								updated_at: z.coerce.date()
+								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(),
-						updated_at: z.coerce.date()
+						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(),
-					updated_at: z.coerce.date()
+					created_at: z.coerce.date().transform((_) => _.toISOString()),
+					updated_at: z.coerce.date().transform((_) => _.toISOString())
 				})
 			)
 		),
 		surveys: maybe(
 			SurveyDetailsSchema.extend({
-				created_at: z.coerce.date(),
-				updated_at: z.coerce.date()
+				created_at: z.coerce.date().transform((_) => _.toISOString()),
+				updated_at: z.coerce.date().transform((_) => _.toISOString())
 			}).extend({
 				data: z.record(
 					z.string(),
@@ -282,44 +301,7 @@ export const AssemblyDetailSchema = {
 	})
 };
 
-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()
-};
-
+// Pins
 export const PinSchema = {
 	payload: z.object({
 		country: z.string(),
@@ -328,8 +310,8 @@ export const PinSchema = {
 	}),
 	response: z.object({
 		id: z.uuid(),
-		created_at: z.coerce.date(),
-		updated_at: z.coerce.date(),
+		created_at: z.coerce.date().transform((_) => _.toISOString()),
+		updated_at: z.coerce.date().transform((_) => _.toISOString()),
 		country: z.string(),
 		text: maybe(z.string()),
 		hide: z.boolean(),

package/src/schemas/utils.ts

@@ -0,0 +1,5 @@
+import z, { ZodType } from 'zod';
+
+export const isoDateString = z.iso.datetime();
+export const maybe = <T extends ZodType<unknown>>(_: T) =>
+	_.nullish().transform((_) => _ ?? null);

package/src/{types.ts → types/api.ts}

@@ -5,43 +5,21 @@ import {
 	AssemblyOverviewSchema,
 	FeedbackSchema,
 	LogSchema,
+	PatchAccountReportsIdPublishSchema,
 	PinListSchema,
 	PinSchema,
+	PostAccountReportsIdCoverImageSchema,
 	RegisterSchema,
 	SurveyResponseSchema,
-	SurveySchema,
-	UserSchema
-} from './schemas';
+	SurveySchema
+} from '../schemas';
 
-export enum ApiRestMethod {
-	GET = 'GET',
-	POST = 'POST',
-	PUT = 'PUT',
-	PATCH = 'PATCH'
-}
-
-export enum ApiRouteParameter {
-	ID = ':ID',
-	NAME = ':NAME'
-}
-
-export enum ApiEndpoint {
-	ASSEMBLIES = '/assemblies',
-	FEEDBACK = '/feedback',
-	INTEREST_ASSEMBLIS = '/interest/assemblis',
-	INTEREST_MUTIRAO = '/interest/mutirao',
-	LOGS = '/logs',
-	PINS = '/pins',
-	SURVEYS = '/surveys',
-	SURVEY_RESPONSES = '/assemblies/:ID/survey-responses/:NAME'
-}
-
-export enum SurveyName {
-	DELIBERATION = 'deliberation',
-	DEMOGRAPHIC_DATA = 'demographic-data',
-	PRE_ASSEMBLY = 'pre-assembly',
-	POST_ASSEMBLY = 'post-assembly'
-}
+export type PublishReportPayload = z.infer<
+	(typeof PatchAccountReportsIdPublishSchema)['payload']
+>;
+export type ImageMetadataPayload = z.infer<
+	(typeof PostAccountReportsIdCoverImageSchema)['payload']
+>;
 
 export type AssemblyDetailPayload = z.infer<
 	(typeof AssemblyDetailSchema)['payload']
@@ -61,7 +39,6 @@ export type SurveyPayload = z.infer<(typeof SurveySchema)['payload']>;
 export type SurveyResponsePayload = z.infer<
 	(typeof SurveyResponseSchema)['payload']
 >;
-export type UserPayload = z.infer<(typeof UserSchema)['payload']>;
 
 export type AssemblyDetailResponse = z.infer<
 	(typeof AssemblyDetailSchema)['response']
@@ -81,4 +58,3 @@ export type SurveyResponse = z.infer<(typeof SurveySchema)['response']>;
 export type SurveyResponseResponse = z.infer<
 	(typeof SurveyResponseSchema)['response']
 >;
-export type UserResponse = z.infer<(typeof UserSchema)['response']>;

package/src/types/enums.ts

@@ -0,0 +1,30 @@
+export enum ApiRestMethod {
+	GET = 'GET',
+	POST = 'POST',
+	PUT = 'PUT',
+	PATCH = 'PATCH'
+}
+
+export enum ApiRouteParameter {
+	ID = ':ID',
+	NAME = ':NAME'
+}
+
+export enum ApiEndpoint {
+	ACCOUNT_REPORTS = '/account/reports',
+	ASSEMBLIES = '/assemblies',
+	FEEDBACK = '/feedback',
+	INTEREST_ASSEMBLIS = '/interest/assemblis',
+	INTEREST_MUTIRAO = '/interest/mutirao',
+	LOGS = '/logs',
+	PINS = '/pins',
+	SURVEYS = '/surveys',
+	SURVEY_RESPONSES = '/assemblies/:ID/survey-responses/:NAME'
+}
+
+export enum SurveyName {
+	DELIBERATION = 'deliberation',
+	DEMOGRAPHIC_DATA = 'demographic-data',
+	PRE_ASSEMBLY = 'pre-assembly',
+	POST_ASSEMBLY = 'post-assembly'
+}

package/src/types/index.ts

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

package/src/types/types.ts

@@ -0,0 +1,6 @@
+import z from 'zod';
+import { ReportSchema, UserSchema, ReportContentSchema } from '../schemas/base';
+
+export type Report = z.infer<typeof ReportSchema>;
+export type ReportContent = z.infer<typeof ReportContentSchema>;
+export type User = z.infer<typeof UserSchema>;