@assemblis/contracts 0.1.1 → 0.1.3

package/dist/schemas/utils.d.ts

@@ -1,11 +1,3 @@
 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
-	>
->;
+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

@@ -1,57 +1,31 @@
-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']
->;
+import z, { ZodType } from 'zod';
+import { AssembliesListSchema, AssemblyDetailSchema, AssemblyOverviewSchema, FeedbackSchema, LogSchema, PatchAccountReportsIdPublishSchema, PinListSchema, PinSchema, PostAccountReportsIdCoverImageSchema, RegisterSchema, SurveyResponseSchema, SurveySchema } from '../schemas';
+import { ApiRestMethod } from './enums';
+export type ApiEndpointSchema = {
+    endpoint: (...params: string[]) => string;
+    method: ApiRestMethod;
+    payload: ZodType;
+    response: ZodType;
+};
+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 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']
->;
+export type SurveyResponseResponse = z.infer<(typeof SurveyResponseSchema)['response']>;

package/dist/types/enums.d.ts

@@ -1,27 +1,27 @@
 export declare enum ApiRestMethod {
-	GET = 'GET',
-	POST = 'POST',
-	PUT = 'PUT',
-	PATCH = 'PATCH'
+    GET = "GET",
+    POST = "POST",
+    PUT = "PUT",
+    PATCH = "PATCH"
 }
 export declare enum ApiRouteParameter {
-	ID = ':ID',
-	NAME = ':NAME'
+    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'
+    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'
+    DELIBERATION = "deliberation",
+    DEMOGRAPHIC_DATA = "demographic-data",
+    PRE_ASSEMBLY = "pre-assembly",
+    POST_ASSEMBLY = "post-assembly"
 }

package/dist/types/types.d.ts

@@ -1,5 +1,6 @@
 import z from 'zod';
-import { ReportSchema, UserSchema, ReportContentSchema } from '../schemas/base';
+import { ReportSchema, UserSchema, ReportContentSchema, ImageSchema } from '../schemas/base';
+export type Image = z.infer<typeof ImageSchema>;
 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.1.1",
+	"version": "0.1.3",
 	"private": false,
 	"type": "module",
 	"main": "./dist/index.js",

package/src/schemas/api.ts

@@ -1,43 +1,67 @@
 import z from 'zod';
+
+import { ApiEndpoint, ApiRestMethod } from '../types';
+
 import { ImageSchema, ReportContentSchema, ReportSchema } from './base';
 import { isoDateString, maybe } from './utils';
 
 export const GetAccountReportsSchema = {
+	endpoint: () => ApiEndpoint.ACCOUNT_REPORTS,
+	method: ApiRestMethod.GET,
 	payload: z.never(),
 	response: z.object({ reports: ReportSchema.array() })
 };
 
 export const GetAccountReportsIdSchema = {
+	endpoint: (reportId: string) => `${ApiEndpoint.ACCOUNT_REPORTS}/${reportId}`,
+	method: ApiRestMethod.GET,
 	payload: z.never(),
 	response: ReportSchema
 };
 
 export const PostAccountReportsSchema = {
+	endpoint: () => ApiEndpoint.ACCOUNT_REPORTS,
+	method: ApiRestMethod.POST,
 	payload: maybe(ReportContentSchema.omit({ cover_image_id: true })),
 	response: ReportSchema
 };
 
 export const PutAccountReportsIdContentSchema = {
+	endpoint: (reportId: string) =>
+		`${ApiEndpoint.ACCOUNT_REPORTS}/${reportId}/content`,
+	method: ApiRestMethod.PUT,
 	payload: ReportContentSchema.omit({ cover_image_id: true }),
 	response: ReportSchema
 };
 
 export const PatchAccountReportsIdDiscardSchema = {
+	endpoint: (reportId: string) =>
+		`${ApiEndpoint.ACCOUNT_REPORTS}/${reportId}/discard`,
+	method: ApiRestMethod.PATCH,
 	payload: z.never(),
 	response: maybe(ReportSchema)
 };
 
 export const PatchAccountReportsIdPublishSchema = {
+	endpoint: (reportId: string) =>
+		`${ApiEndpoint.ACCOUNT_REPORTS}/${reportId}/publish`,
+	method: ApiRestMethod.PATCH,
 	payload: z.object({ published_at: isoDateString }),
 	response: ReportSchema
 };
 
 export const PatchAccountReportsIdUnpublishSchema = {
+	endpoint: (reportId: string) =>
+		`${ApiEndpoint.ACCOUNT_REPORTS}/${reportId}/unpublish`,
+	method: ApiRestMethod.PATCH,
 	payload: z.never(),
 	response: ReportSchema
 };
 
 export const PostAccountReportsIdCoverImageSchema = {
+	endpoint: (reportId: string) =>
+		`${ApiEndpoint.ACCOUNT_REPORTS}/${reportId}/cover-image`,
+	method: ApiRestMethod.POST,
 	payload: ImageSchema.pick({ alt: true }),
 	response: ReportSchema
 };