@purpleschool/student-works 0.0.5 → 0.0.8

package/api/controller/http/writer.ts

@@ -14,6 +14,8 @@ export const WRITER_ROUTES = {
         `documents/${docId}/sources/${sourceId}/confirm`,
     GENERATE_CONTENTS: (uuid: string) => `documents/${uuid}/generate`,
     UPDATE_OUTLINE: (uuid: string) => `documents/${uuid}/outline`,
+    UPDATE_TITLE_PAGE: (uuid: string) => `documents/${uuid}/title-page`,
+    TOGGLE_TITLE_PAGE: (uuid: string) => `documents/${uuid}/title-page/toggle`,
     DELETE_DOCUMENT: (uuid: string) => `documents/${uuid}`,
     UPDATE_CONTENTS: (uuid: string) => `documents/${uuid}/contents`,
     DELETE_ALL_DOCUMENTS: 'documents',

package/api/routes.ts

@@ -107,6 +107,10 @@ export const REST_API = {
             `${ROOT}/${CONTROLLERS.WRITER_CONTROLLER_PRIVATE}/${CONTROLLERS.WRITER_ROUTES.GENERATE_CONTENTS(uuid)}`,
         UPDATE_OUTLINE: (uuid: string) =>
             `${ROOT}/${CONTROLLERS.WRITER_CONTROLLER_PRIVATE}/${CONTROLLERS.WRITER_ROUTES.UPDATE_OUTLINE(uuid)}`,
+        UPDATE_TITLE_PAGE: (uuid: string) =>
+            `${ROOT}/${CONTROLLERS.WRITER_CONTROLLER_PRIVATE}/${CONTROLLERS.WRITER_ROUTES.UPDATE_TITLE_PAGE(uuid)}`,
+        TOGGLE_TITLE_PAGE: (uuid: string) =>
+            `${ROOT}/${CONTROLLERS.WRITER_CONTROLLER_PRIVATE}/${CONTROLLERS.WRITER_ROUTES.TOGGLE_TITLE_PAGE(uuid)}`,
         DELETE_DOCUMENT: (uuid: string) =>
             `${ROOT}/${CONTROLLERS.WRITER_CONTROLLER_PRIVATE}/${CONTROLLERS.WRITER_ROUTES.DELETE_DOCUMENT(uuid)}`,
         UPDATE_CONTENTS: (uuid: string) =>

package/build/api/controller/http/writer.js

@@ -15,6 +15,8 @@ exports.WRITER_ROUTES = {
     CONFIRM_SOURCE_CITATION_METADATA: (docId, sourceId) => `documents/${docId}/sources/${sourceId}/confirm`,
     GENERATE_CONTENTS: (uuid) => `documents/${uuid}/generate`,
     UPDATE_OUTLINE: (uuid) => `documents/${uuid}/outline`,
+    UPDATE_TITLE_PAGE: (uuid) => `documents/${uuid}/title-page`,
+    TOGGLE_TITLE_PAGE: (uuid) => `documents/${uuid}/title-page/toggle`,
     DELETE_DOCUMENT: (uuid) => `documents/${uuid}`,
     UPDATE_CONTENTS: (uuid) => `documents/${uuid}/contents`,
     DELETE_ALL_DOCUMENTS: 'documents',

package/build/api/routes.js

@@ -119,6 +119,8 @@ exports.REST_API = {
         CONFIRM_SOURCE_CITATION_METADATA: (docId, sourceId) => `${exports.ROOT}/${CONTROLLERS.WRITER_CONTROLLER_PRIVATE}/${CONTROLLERS.WRITER_ROUTES.CONFIRM_SOURCE_CITATION_METADATA(docId, sourceId)}`,
         GENERATE_CONTENTS: (uuid) => `${exports.ROOT}/${CONTROLLERS.WRITER_CONTROLLER_PRIVATE}/${CONTROLLERS.WRITER_ROUTES.GENERATE_CONTENTS(uuid)}`,
         UPDATE_OUTLINE: (uuid) => `${exports.ROOT}/${CONTROLLERS.WRITER_CONTROLLER_PRIVATE}/${CONTROLLERS.WRITER_ROUTES.UPDATE_OUTLINE(uuid)}`,
+        UPDATE_TITLE_PAGE: (uuid) => `${exports.ROOT}/${CONTROLLERS.WRITER_CONTROLLER_PRIVATE}/${CONTROLLERS.WRITER_ROUTES.UPDATE_TITLE_PAGE(uuid)}`,
+        TOGGLE_TITLE_PAGE: (uuid) => `${exports.ROOT}/${CONTROLLERS.WRITER_CONTROLLER_PRIVATE}/${CONTROLLERS.WRITER_ROUTES.TOGGLE_TITLE_PAGE(uuid)}`,
         DELETE_DOCUMENT: (uuid) => `${exports.ROOT}/${CONTROLLERS.WRITER_CONTROLLER_PRIVATE}/${CONTROLLERS.WRITER_ROUTES.DELETE_DOCUMENT(uuid)}`,
         UPDATE_CONTENTS: (uuid) => `${exports.ROOT}/${CONTROLLERS.WRITER_CONTROLLER_PRIVATE}/${CONTROLLERS.WRITER_ROUTES.UPDATE_CONTENTS(uuid)}`,
         DELETE_ALL_DOCUMENTS: `${exports.ROOT}/${CONTROLLERS.WRITER_CONTROLLER_PRIVATE}/${CONTROLLERS.WRITER_ROUTES.DELETE_ALL_DOCUMENTS}`,

package/build/commands/writer/index.js

@@ -36,3 +36,5 @@ __exportStar(require("./set-reaction.writer-document.command"), exports);
 __exportStar(require("./discard-writer-source.command"), exports);
 __exportStar(require("./upload-writer-source.command"), exports);
 __exportStar(require("./confirm-source-citation-metadata.command"), exports);
+__exportStar(require("./update-writer-document-title-page.command"), exports);
+__exportStar(require("./toggle-writer-document-title-page.command"), exports);

package/build/commands/writer/toggle-writer-document-title-page.command.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ToggleWriterDocumentTitlePageCommand = void 0;
+const zod_1 = require("zod");
+var ToggleWriterDocumentTitlePageCommand;
+(function (ToggleWriterDocumentTitlePageCommand) {
+    ToggleWriterDocumentTitlePageCommand.RequestBodySchema = zod_1.z.object({
+        enabled: zod_1.z.boolean(),
+    });
+    ToggleWriterDocumentTitlePageCommand.RequestParamsSchema = zod_1.z.object({
+        uuid: zod_1.z.string().uuid(),
+    });
+    ToggleWriterDocumentTitlePageCommand.ResponseSchema = zod_1.z.object({
+        data: zod_1.z.object({
+            enabled: zod_1.z.boolean(),
+        }),
+    });
+})(ToggleWriterDocumentTitlePageCommand || (exports.ToggleWriterDocumentTitlePageCommand = ToggleWriterDocumentTitlePageCommand = {}));

package/build/commands/writer/update-writer-document-title-page.command.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpdateWriterDocumentTitlePageCommand = void 0;
+const zod_1 = require("zod");
+const models_1 = require("../../models");
+var UpdateWriterDocumentTitlePageCommand;
+(function (UpdateWriterDocumentTitlePageCommand) {
+    UpdateWriterDocumentTitlePageCommand.RequestBodySchema = zod_1.z.object({
+        titlePage: models_1.WriterDocumentTitlePageSchema,
+    });
+    UpdateWriterDocumentTitlePageCommand.RequestParamsSchema = zod_1.z.object({
+        uuid: zod_1.z.string().uuid(),
+    });
+    UpdateWriterDocumentTitlePageCommand.ResponseSchema = zod_1.z.object({
+        data: models_1.WriterDocumentTitlePageSchema,
+    });
+})(UpdateWriterDocumentTitlePageCommand || (exports.UpdateWriterDocumentTitlePageCommand = UpdateWriterDocumentTitlePageCommand = {}));

package/build/constants/errors/errors.js

@@ -870,6 +870,22 @@ exports.ERRORS = {
         code: 'WRITER_SOURCE_006',
         httpCode: 400,
     },
+    // WRITER - TITLE PAGE TEMPLATE
+    WRITER_TITLE_PAGE_TEMPLATE_NOT_FOUND: {
+        message: 'Шаблон титульной страницы Writer не найден',
+        code: 'WRITER_TITLE_PAGE_TEMPLATE_001',
+        httpCode: 404,
+    },
+    WRITER_TITLE_PAGE_TEMPLATE_FIND_ERROR: {
+        message: 'Ошибка при поиске шаблона титульной страницы Writer',
+        code: 'WRITER_TITLE_PAGE_TEMPLATE_002',
+        httpCode: 500,
+    },
+    WRITER_TITLE_PAGE_TEMPLATE_SAVE_ERROR: {
+        message: 'Ошибка при сохранении шаблона титульной страницы Writer',
+        code: 'WRITER_TITLE_PAGE_TEMPLATE_003',
+        httpCode: 500,
+    },
     // WRITER - GENERATION
     WRITER_GENERATE_OUTLINE_ERROR: {
         message: 'Ошибка при генерации плана',

package/build/models/writer/writer-document-title-page.schema.js

@@ -2,8 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WriterDocumentTitlePageSchema = void 0;
 const zod_1 = require("zod");
-exports.WriterDocumentTitlePageSchema = zod_1.z
-    .object({
+exports.WriterDocumentTitlePageSchema = zod_1.z.object({
     fullName: zod_1.z.string().min(1).max(200).optional().nullable(),
     city: zod_1.z.string().min(1).max(200).optional().nullable(),
     institutionName: zod_1.z.string().min(1).max(300).optional().nullable(),
@@ -11,5 +10,4 @@ exports.WriterDocumentTitlePageSchema = zod_1.z
     specialtyName: zod_1.z.string().min(1).max(200).optional().nullable(),
     group: zod_1.z.string().min(1).max(100).optional().nullable(),
     subject: zod_1.z.string().min(1).max(200).optional().nullable(),
-})
-    .nullable();
+});

package/build/models/writer/writer-document.schema.js

@@ -12,12 +12,15 @@ exports.WriterDocumentSchema = zod_1.z.object({
     typeId: zod_1.z.string(),
     stage: zod_1.z.nativeEnum(constants_1.WRITER_DOCUMENT_STAGE),
     outline: writer_document_outline_schema_1.WriterDocumentOutlineSchema,
-    titlePage: writer_document_title_page_schema_1.WriterDocumentTitlePageSchema,
+    isTitlePageEnabled: zod_1.z.boolean(),
+    titlePage: writer_document_title_page_schema_1.WriterDocumentTitlePageSchema.nullable(),
     sourceMd: zod_1.z.string().nullable(),
     finalMd: zod_1.z.string().nullable(),
     userId: zod_1.z.string().nullable(),
     unregisteredUserId: zod_1.z.string().nullable(),
     modelId: zod_1.z.string().nullable(),
+    description: zod_1.z.string().nullable(),
+    error: zod_1.z.string().nullable(),
     reaction: zod_1.z.nativeEnum(constants_1.USER_REACTION).nullable(),
     pages: zod_1.z.number().nullable(),
     createdAt: zod_1.z.date(),

package/commands/writer/index.ts

@@ -20,3 +20,5 @@ export * from './set-reaction.writer-document.command';
 export * from './discard-writer-source.command';
 export * from './upload-writer-source.command';
 export * from './confirm-source-citation-metadata.command';
+export * from './update-writer-document-title-page.command';
+export * from './toggle-writer-document-title-page.command';

package/commands/writer/toggle-writer-document-title-page.command.ts

@@ -0,0 +1,20 @@
+import { z } from 'zod';
+
+export namespace ToggleWriterDocumentTitlePageCommand {
+    export const RequestBodySchema = z.object({
+        enabled: z.boolean(),
+    });
+    export type RequestBody = z.infer<typeof RequestBodySchema>;
+
+    export const RequestParamsSchema = z.object({
+        uuid: z.string().uuid(),
+    });
+    export type RequestParams = z.infer<typeof RequestParamsSchema>;
+
+    export const ResponseSchema = z.object({
+        data: z.object({
+            enabled: z.boolean(),
+        }),
+    });
+    export type Response = z.infer<typeof ResponseSchema>;
+}

package/commands/writer/update-writer-document-title-page.command.ts

@@ -0,0 +1,19 @@
+import { z } from 'zod';
+import { WriterDocumentTitlePageSchema } from '../../models';
+
+export namespace UpdateWriterDocumentTitlePageCommand {
+    export const RequestBodySchema = z.object({
+        titlePage: WriterDocumentTitlePageSchema,
+    });
+    export type RequestBody = z.infer<typeof RequestBodySchema>;
+
+    export const RequestParamsSchema = z.object({
+        uuid: z.string().uuid(),
+    });
+    export type RequestParams = z.infer<typeof RequestParamsSchema>;
+
+    export const ResponseSchema = z.object({
+        data: WriterDocumentTitlePageSchema,
+    });
+    export type Response = z.infer<typeof ResponseSchema>;
+}

package/constants/errors/errors.ts

@@ -867,6 +867,22 @@ export const ERRORS = {
         code: 'WRITER_SOURCE_006',
         httpCode: 400,
     },
+    // WRITER - TITLE PAGE TEMPLATE
+    WRITER_TITLE_PAGE_TEMPLATE_NOT_FOUND: {
+        message: 'Шаблон титульной страницы Writer не найден',
+        code: 'WRITER_TITLE_PAGE_TEMPLATE_001',
+        httpCode: 404,
+    },
+    WRITER_TITLE_PAGE_TEMPLATE_FIND_ERROR: {
+        message: 'Ошибка при поиске шаблона титульной страницы Writer',
+        code: 'WRITER_TITLE_PAGE_TEMPLATE_002',
+        httpCode: 500,
+    },
+    WRITER_TITLE_PAGE_TEMPLATE_SAVE_ERROR: {
+        message: 'Ошибка при сохранении шаблона титульной страницы Writer',
+        code: 'WRITER_TITLE_PAGE_TEMPLATE_003',
+        httpCode: 500,
+    },
     // WRITER - GENERATION
     WRITER_GENERATE_OUTLINE_ERROR: {
         message: 'Ошибка при генерации плана',

package/models/writer/writer-document-title-page.schema.ts

@@ -1,15 +1,13 @@
 import { z } from 'zod';
 
-export const WriterDocumentTitlePageSchema = z
-    .object({
-        fullName: z.string().min(1).max(200).optional().nullable(),
-        city: z.string().min(1).max(200).optional().nullable(),
-        institutionName: z.string().min(1).max(300).optional().nullable(),
-        facultyName: z.string().min(1).max(200).optional().nullable(),
-        specialtyName: z.string().min(1).max(200).optional().nullable(),
-        group: z.string().min(1).max(100).optional().nullable(),
-        subject: z.string().min(1).max(200).optional().nullable(),
-    })
-    .nullable();
+export const WriterDocumentTitlePageSchema = z.object({
+    fullName: z.string().min(1).max(200).optional().nullable(),
+    city: z.string().min(1).max(200).optional().nullable(),
+    institutionName: z.string().min(1).max(300).optional().nullable(),
+    facultyName: z.string().min(1).max(200).optional().nullable(),
+    specialtyName: z.string().min(1).max(200).optional().nullable(),
+    group: z.string().min(1).max(100).optional().nullable(),
+    subject: z.string().min(1).max(200).optional().nullable(),
+});
 
 export type WriterDocumentTitlePage = z.infer<typeof WriterDocumentTitlePageSchema>;

package/models/writer/writer-document.schema.ts

@@ -10,12 +10,15 @@ export const WriterDocumentSchema = z.object({
     typeId: z.string(),
     stage: z.nativeEnum(WRITER_DOCUMENT_STAGE),
     outline: WriterDocumentOutlineSchema,
-    titlePage: WriterDocumentTitlePageSchema,
+    isTitlePageEnabled: z.boolean(),
+    titlePage: WriterDocumentTitlePageSchema.nullable(),
     sourceMd: z.string().nullable(),
     finalMd: z.string().nullable(),
     userId: z.string().nullable(),
     unregisteredUserId: z.string().nullable(),
     modelId: z.string().nullable(),
+    description: z.string().nullable(),
+    error: z.string().nullable(),
     reaction: z.nativeEnum(USER_REACTION).nullable(),
     pages: z.number().nullable(),
     createdAt: z.date(),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@purpleschool/student-works",
-  "version": "0.0.5",
+  "version": "0.0.8",
   "description": "",
   "main": "build/index.js",
   "types": "build/index.d.ts",