@assemblis/contracts 0.2.5 → 1.0.0

package/dist/schemas/base.d.ts

@@ -17,10 +17,6 @@ export declare const InterestSchema: z.ZodObject<{
     country: z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodString>>, z.ZodTransform<string | undefined, string | null | undefined>>;
     organisation: z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodString>>, z.ZodTransform<string | undefined, string | null | undefined>>;
 }, z.core.$strip>;
-export declare const OptionSchema: z.ZodObject<{
-    label: z.ZodString;
-    value: z.ZodCoercedNumber<unknown>;
-}, z.core.$strip>;
 export declare const ReportContentSchema: z.ZodObject<{
     published_at: z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodCoercedDate<unknown>, z.ZodTransform<string, Date>>>>, z.ZodTransform<string | null, string | null | undefined>>;
     title: z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodString>>, z.ZodTransform<string | null, string | null | undefined>>;
@@ -40,17 +36,19 @@ export declare const ReportContentSchema: z.ZodObject<{
     cover_image_id: z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodString>>, z.ZodTransform<string | null, string | null | undefined>>;
 }, z.core.$strip>;
 export declare const ReportSchema: z.ZodObject<{
-    id: z.ZodUUID;
+    server_id: z.ZodUUID;
+    client_id: z.ZodUUID;
+    display_seq: z.ZodInt;
     created_at: z.ZodPipe<z.ZodCoercedDate<unknown>, z.ZodTransform<string, Date>>;
     updated_at: z.ZodPipe<z.ZodCoercedDate<unknown>, z.ZodTransform<string, Date>>;
     published_at: z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodCoercedDate<unknown>, z.ZodTransform<string, Date>>>>, z.ZodTransform<string | null, string | null | undefined>>;
     state: z.ZodEnum<{
         DISCARDED: "DISCARDED";
-        DRAFTED: "DRAFTED";
         PUBLISHED: "PUBLISHED";
         CHANGED: "CHANGED";
+        DRAFTED: "DRAFTED";
     }>;
-    viewer_password: z.ZodString;
+    slug: z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodString>>, z.ZodTransform<string | null, string | null | undefined>>;
     draft_content: z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodObject<{
         published_at: z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodCoercedDate<unknown>, z.ZodTransform<string, Date>>>>, z.ZodTransform<string | null, string | null | undefined>>;
         title: z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodString>>, z.ZodTransform<string | null, string | null | undefined>>;
@@ -174,3 +172,46 @@ export declare const UserSchema: z.ZodObject<{
     sub: z.ZodString;
     is_mutirao: z.ZodBoolean;
 }, z.core.$strip>;
+export declare const AssemblySchema: z.ZodObject<{
+    id: z.ZodUUID;
+    created_at: z.ZodPipe<z.ZodCoercedDate<unknown>, z.ZodTransform<string, Date>>;
+    updated_at: z.ZodPipe<z.ZodCoercedDate<unknown>, z.ZodTransform<string, Date>>;
+    image_src: z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodString>>, z.ZodTransform<string | null, string | null | undefined>>;
+    has_image: z.ZodBoolean;
+    user_id: z.ZodUUID;
+    published_at: z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodCoercedDate<unknown>, z.ZodTransform<string, Date>>>>, z.ZodTransform<string | null, string | null | undefined>>;
+    name: z.ZodString;
+    about: z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodString>>, z.ZodTransform<string | null, string | null | undefined>>;
+    topics: z.ZodArray<z.ZodString>;
+    country: z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodString>>, z.ZodTransform<string | null, string | null | undefined>>;
+    hide: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>;
+export declare const PinSchema: z.ZodObject<{
+    id: z.ZodUUID;
+    created_at: z.ZodPipe<z.ZodCoercedDate<unknown>, z.ZodTransform<string, Date>>;
+    updated_at: z.ZodPipe<z.ZodCoercedDate<unknown>, z.ZodTransform<string, Date>>;
+    country: z.ZodString;
+    text: z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodString>>, z.ZodTransform<string | null, string | null | undefined>>;
+    hide: z.ZodBoolean;
+    image_src: z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodString>>, z.ZodTransform<string | null, string | null | undefined>>;
+    has_image: z.ZodBoolean;
+}, z.core.$strip>;
+export declare const LogSchema: z.ZodObject<{
+    message: z.ZodOptional<z.ZodString>;
+    data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodOptional<z.ZodString>>>;
+    metadata: z.ZodObject<{
+        origin: z.ZodString;
+        route: z.ZodString;
+        status: z.ZodNumber;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export declare const RegisterSchema: z.ZodObject<{
+    type: z.ZodLiteral<"user.created">;
+    object: z.ZodLiteral<"event">;
+    data: z.ZodObject<{
+        id: z.ZodString;
+        email_addresses: z.ZodArray<z.ZodObject<{
+            email_address: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+}, z.core.$strip>;

package/dist/schemas/index.d.ts

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

package/dist/schemas/utils.d.ts

@@ -1,3 +1,5 @@
 import z, { ZodType } from 'zod';
 export declare const isoDateString: z.ZodPipe<z.ZodCoercedDate<unknown>, z.ZodTransform<string, Date>>;
 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>>;
+export type ExtractParams<T extends string> = T extends `${string}:${infer Param}/${infer Rest}` ? Param | ExtractParams<`/${Rest}`> : T extends `${string}:${infer Param}` ? Param : never;
+export declare function resolvePath<T extends string>(template: T, params: Record<ExtractParams<T>, string>): string;

package/dist/types/enums.d.ts

@@ -1,24 +1,18 @@
-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 = "/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 declare enum ApiRestMethod {
+    GET = "GET",
+    POST = "POST",
+    PUT = "PUT",
+    PATCH = "PATCH"
 }
 export declare enum ReportState {
     DISCARDED = "DISCARDED",
@@ -26,9 +20,3 @@ export declare enum ReportState {
     PUBLISHED = "PUBLISHED",
     CHANGED = "CHANGED"
 }
-export declare enum SurveyName {
-    DELIBERATION = "deliberation",
-    DEMOGRAPHIC_DATA = "demographic-data",
-    PRE_ASSEMBLY = "pre-assembly",
-    POST_ASSEMBLY = "post-assembly"
-}

package/dist/types/index.d.ts

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

package/dist/types/types.d.ts

@@ -1,6 +1,7 @@
 import z from 'zod';
-import { ReportSchema, UserSchema, ReportContentSchema, ImageSchema } from '../schemas/base';
+import { ImageSchema, PinSchema, ReportContentSchema, 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/package.json

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

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({
@@ -35,11 +36,6 @@ export const InterestSchema = z.object({
 		.transform((_) => _ ?? undefined)
 });
 
-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()),
@@ -60,12 +56,14 @@ export const ReportContentSchema = z.object({
 });
 
 export const ReportSchema = z.object({
-	id: z.uuid(),
+	server_id: z.uuid(),
+	client_id: z.uuid(),
+	display_seq: z.int(),
 	created_at: isoDateString,
 	updated_at: isoDateString,
 	published_at: maybe(isoDateString),
 	state: z.enum(['DISCARDED', 'DRAFTED', 'PUBLISHED', 'CHANGED']),
-	viewer_password: z.string(),
+	slug: maybe(z.string()),
 	draft_content: maybe(ReportContentSchema),
 	published_content: maybe(ReportContentSchema),
 	media: z.object({ images: ImageSchema.array() })
@@ -78,3 +76,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>;