@purpleschool/student-works 0.0.2 → 0.0.3

package/api/controller/http/writer.ts

@@ -10,6 +10,8 @@ export const WRITER_ROUTES = {
     GENERATE_OUTLINE: (uuid: string) => `documents/${uuid}/outline/generate`,
     COLLECT_SOURCES: (uuid: string) => `documents/${uuid}/sources/collect`,
     UPLOAD_SOURCE: (uuid: string) => `documents/${uuid}/sources/upload`,
+    CONFIRM_SOURCE_CITATION_METADATA: (docId: string, sourceId: string) =>
+        `documents/${docId}/sources/${sourceId}/confirm`,
     GENERATE_CONTENTS: (uuid: string) => `documents/${uuid}/generate`,
     UPDATE_OUTLINE: (uuid: string) => `documents/${uuid}/outline`,
     DELETE_DOCUMENT: (uuid: string) => `documents/${uuid}`,

package/api/routes.ts

@@ -101,6 +101,8 @@ export const REST_API = {
             `${ROOT}/${CONTROLLERS.WRITER_CONTROLLER_PRIVATE}/${CONTROLLERS.WRITER_ROUTES.COLLECT_SOURCES(uuid)}`,
         UPLOAD_SOURCE: (uuid: string) =>
             `${ROOT}/${CONTROLLERS.WRITER_CONTROLLER_PRIVATE}/${CONTROLLERS.WRITER_ROUTES.UPLOAD_SOURCE(uuid)}`,
+        CONFIRM_SOURCE_CITATION_METADATA: (docId: string, sourceId: string) =>
+            `${ROOT}/${CONTROLLERS.WRITER_CONTROLLER_PRIVATE}/${CONTROLLERS.WRITER_ROUTES.CONFIRM_SOURCE_CITATION_METADATA(docId, sourceId)}`,
         GENERATE_CONTENTS: (uuid: string) =>
             `${ROOT}/${CONTROLLERS.WRITER_CONTROLLER_PRIVATE}/${CONTROLLERS.WRITER_ROUTES.GENERATE_CONTENTS(uuid)}`,
         UPDATE_OUTLINE: (uuid: string) =>

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

@@ -12,6 +12,7 @@ exports.WRITER_ROUTES = {
     GENERATE_OUTLINE: (uuid) => `documents/${uuid}/outline/generate`,
     COLLECT_SOURCES: (uuid) => `documents/${uuid}/sources/collect`,
     UPLOAD_SOURCE: (uuid) => `documents/${uuid}/sources/upload`,
+    CONFIRM_SOURCE_CITATION_METADATA: (docId, sourceId) => `documents/${docId}/sources/${sourceId}/confirm`,
     GENERATE_CONTENTS: (uuid) => `documents/${uuid}/generate`,
     UPDATE_OUTLINE: (uuid) => `documents/${uuid}/outline`,
     DELETE_DOCUMENT: (uuid) => `documents/${uuid}`,

package/build/api/routes.js

@@ -116,6 +116,7 @@ exports.REST_API = {
         GENERATE_OUTLINE: (uuid) => `${exports.ROOT}/${CONTROLLERS.WRITER_CONTROLLER_PRIVATE}/${CONTROLLERS.WRITER_ROUTES.GENERATE_OUTLINE(uuid)}`,
         COLLECT_SOURCES: (uuid) => `${exports.ROOT}/${CONTROLLERS.WRITER_CONTROLLER_PRIVATE}/${CONTROLLERS.WRITER_ROUTES.COLLECT_SOURCES(uuid)}`,
         UPLOAD_SOURCE: (uuid) => `${exports.ROOT}/${CONTROLLERS.WRITER_CONTROLLER_PRIVATE}/${CONTROLLERS.WRITER_ROUTES.UPLOAD_SOURCE(uuid)}`,
+        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)}`,
         DELETE_DOCUMENT: (uuid) => `${exports.ROOT}/${CONTROLLERS.WRITER_CONTROLLER_PRIVATE}/${CONTROLLERS.WRITER_ROUTES.DELETE_DOCUMENT(uuid)}`,

package/build/commands/writer/confirm-source-citation-metadata.command.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfirmSourceCitationMetadataCommand = void 0;
+const zod_1 = require("zod");
+const models_1 = require("../../models");
+var ConfirmSourceCitationMetadataCommand;
+(function (ConfirmSourceCitationMetadataCommand) {
+    ConfirmSourceCitationMetadataCommand.RequestParamsSchema = zod_1.z.object({
+        documentId: zod_1.z.string().uuid(),
+        sourceId: zod_1.z.string().uuid(),
+    });
+    ConfirmSourceCitationMetadataCommand.RequestBodySchema = zod_1.z.object({
+        bibliographicMetadata: models_1.SourceBibliographicMetadataSchema,
+    });
+})(ConfirmSourceCitationMetadataCommand || (exports.ConfirmSourceCitationMetadataCommand = ConfirmSourceCitationMetadataCommand = {}));

package/build/commands/writer/generate-writer-document-contents.command.js

@@ -8,9 +8,7 @@ var GenerateWriterDocumentContentsCommand;
     GenerateWriterDocumentContentsCommand.RequestParamsSchema = zod_1.z.object({
         uuid: zod_1.z.string().uuid(),
     });
-    GenerateWriterDocumentContentsCommand.RequestBodySchema = zod_1.z.object({
-        modelId: zod_1.z.string().uuid(),
-    });
+    GenerateWriterDocumentContentsCommand.RequestBodySchema = zod_1.z.object({});
     GenerateWriterDocumentContentsCommand.ResponseSchema = zod_1.z.object({
         data: models_1.WriterDocumentSchema,
     });

package/build/commands/writer/generate-writer-document-outline.command.js

@@ -13,6 +13,7 @@ var GenerateWriterDocumentOutlineCommand;
         description: zod_1.z
             .string()
             .nullable()
+            .optional()
             .describe("If set to null existing description will be used. Otherwise replaces document's description"),
     });
     GenerateWriterDocumentOutlineCommand.ResponseSchema = zod_1.z.object({

package/build/commands/writer/index.js

@@ -35,3 +35,4 @@ __exportStar(require("./export-writer-document-as-docx.command"), exports);
 __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);

package/build/commands/writer/upload-writer-source.command.js

@@ -10,7 +10,6 @@ var UploadWriterSourceCommand;
     });
     UploadWriterSourceCommand.RequestBodySchema = zod_1.z.object({
         fileId: zod_1.z.string().uuid(),
-        title: zod_1.z.string().min(1).max(500),
     });
     UploadWriterSourceCommand.ResponseSchema = zod_1.z.object({
         data: models_1.WriterSourceSchema,

package/build/constants/writer/enums/index.js

@@ -14,6 +14,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./source-type.enum"), exports);
+__exportStar(require("./source-status.enum"), exports);
 __exportStar(require("./source-origin.enum"), exports);
 __exportStar(require("./writer-document-section-type.enum"), exports);
 __exportStar(require("./writer-document-stage.enum"), exports);

package/build/constants/writer/enums/source-status.enum.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SOURCE_STATUS = void 0;
+var SOURCE_STATUS;
+(function (SOURCE_STATUS) {
+    SOURCE_STATUS["READY"] = "READY";
+    SOURCE_STATUS["REQUIRES_CITATION_METADATA_CONFIRMATION"] = "REQUIRES_CITATION_METADATA_CONFIRMATION";
+    SOURCE_STATUS["DISCARDED"] = "DISCARDED";
+})(SOURCE_STATUS || (exports.SOURCE_STATUS = SOURCE_STATUS = {}));

package/build/constants/writer/enums/source-type.enum.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SOURCE_TYPE = void 0;
+var SOURCE_TYPE;
+(function (SOURCE_TYPE) {
+    SOURCE_TYPE["JOURNAL_ARTICLE"] = "JOURNAL_ARTICLE";
+    SOURCE_TYPE["BOOK"] = "BOOK";
+})(SOURCE_TYPE || (exports.SOURCE_TYPE = SOURCE_TYPE = {}));

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

@@ -7,6 +7,7 @@ exports.WriterDocumentTypeSchema = zod_1.z.object({
     uuid: zod_1.z.string().uuid(),
     title: zod_1.z.string(),
     icons: icon_variants_schema_1.IconVariantsSchema,
+    needsCitations: zod_1.z.boolean(),
     order: zod_1.z.number(),
     minPages: zod_1.z.number(),
     maxPages: zod_1.z.number(),

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

@@ -1,13 +1,39 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WriterSourceSchema = void 0;
+exports.WriterSourceSchema = exports.SourceBibliographicMetadataSchema = exports.JournalArticleBibliographicMetadataSchema = exports.BookBibliographicMetadataSchema = void 0;
 const zod_1 = require("zod");
 const constants_1 = require("../constants");
+exports.BookBibliographicMetadataSchema = zod_1.z.object({
+    type: zod_1.z.literal(constants_1.SOURCE_TYPE.BOOK),
+    title: zod_1.z.string(),
+    authors: zod_1.z.string(),
+    year: zod_1.z.number(),
+    publicationCity: zod_1.z.string(),
+    publisher: zod_1.z.string(),
+    pageCount: zod_1.z.number().nullable(),
+});
+exports.JournalArticleBibliographicMetadataSchema = zod_1.z.object({
+    type: zod_1.z.literal(constants_1.SOURCE_TYPE.JOURNAL_ARTICLE),
+    title: zod_1.z.string(),
+    authors: zod_1.z.string(),
+    year: zod_1.z.number(),
+    journalName: zod_1.z.string(),
+    issueNumber: zod_1.z.string(),
+    pageRange: zod_1.z.string(),
+});
+exports.SourceBibliographicMetadataSchema = zod_1.z.discriminatedUnion('type', [
+    exports.BookBibliographicMetadataSchema,
+    exports.JournalArticleBibliographicMetadataSchema,
+]);
 exports.WriterSourceSchema = zod_1.z.object({
     uuid: zod_1.z.string().uuid(),
-    title: zod_1.z.string(),
     url: zod_1.z.string().url(),
+    title: zod_1.z.string().nullable(),
+    type: zod_1.z.nativeEnum(constants_1.SOURCE_TYPE).nullable(),
     sourceOrigin: zod_1.z.nativeEnum(constants_1.SOURCE_ORIGIN),
+    citation: zod_1.z.string().nullable(),
+    status: zod_1.z.nativeEnum(constants_1.SOURCE_STATUS),
+    bibliographicMetadata: exports.SourceBibliographicMetadataSchema,
     createdAt: zod_1.z.date(),
     updatedAt: zod_1.z.date(),
 });

package/commands/writer/confirm-source-citation-metadata.command.ts

@@ -0,0 +1,15 @@
+import { z } from 'zod';
+import { SourceBibliographicMetadataSchema } from '../../models';
+
+export namespace ConfirmSourceCitationMetadataCommand {
+    export const RequestParamsSchema = z.object({
+        documentId: z.string().uuid(),
+        sourceId: z.string().uuid(),
+    });
+    export type RequestParams = z.infer<typeof RequestParamsSchema>;
+
+    export const RequestBodySchema = z.object({
+        bibliographicMetadata: SourceBibliographicMetadataSchema,
+    });
+    export type RequestBody = z.infer<typeof RequestBodySchema>;
+}

package/commands/writer/generate-writer-document-contents.command.ts

@@ -7,9 +7,7 @@ export namespace GenerateWriterDocumentContentsCommand {
     });
     export type RequestParams = z.infer<typeof RequestParamsSchema>;
 
-    export const RequestBodySchema = z.object({
-        modelId: z.string().uuid(),
-    });
+    export const RequestBodySchema = z.object({});
     export type RequestBody = z.infer<typeof RequestBodySchema>;
 
     export const ResponseSchema = z.object({

package/commands/writer/generate-writer-document-outline.command.ts

@@ -12,6 +12,7 @@ export namespace GenerateWriterDocumentOutlineCommand {
         description: z
             .string()
             .nullable()
+            .optional()
             .describe(
                 "If set to null existing description will be used. Otherwise replaces document's description",
             ),

package/commands/writer/index.ts

@@ -19,3 +19,4 @@ export * from './export-writer-document-as-docx.command';
 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';

package/commands/writer/upload-writer-source.command.ts

@@ -9,7 +9,6 @@ export namespace UploadWriterSourceCommand {
 
     export const RequestBodySchema = z.object({
         fileId: z.string().uuid(),
-        title: z.string().min(1).max(500),
     });
     export type RequestBody = z.infer<typeof RequestBodySchema>;
 

package/constants/writer/enums/index.ts

@@ -1,3 +1,5 @@
+export * from './source-type.enum';
+export * from './source-status.enum';
 export * from './source-origin.enum';
 export * from './writer-document-section-type.enum';
 export * from './writer-document-stage.enum';

package/constants/writer/enums/source-status.enum.ts

@@ -0,0 +1,5 @@
+export enum SOURCE_STATUS {
+    READY = 'READY',
+    REQUIRES_CITATION_METADATA_CONFIRMATION = 'REQUIRES_CITATION_METADATA_CONFIRMATION',
+    DISCARDED = 'DISCARDED',
+}

package/constants/writer/enums/source-type.enum.ts

@@ -0,0 +1,4 @@
+export enum SOURCE_TYPE {
+    JOURNAL_ARTICLE = 'JOURNAL_ARTICLE',
+    BOOK = 'BOOK',
+}

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

@@ -5,6 +5,7 @@ export const WriterDocumentTypeSchema = z.object({
     uuid: z.string().uuid(),
     title: z.string(),
     icons: IconVariantsSchema,
+    needsCitations: z.boolean(),
     order: z.number(),
     minPages: z.number(),
     maxPages: z.number(),

package/models/writer-source.schema.ts

@@ -1,13 +1,46 @@
 import { z } from 'zod';
-import { SOURCE_ORIGIN } from '../constants';
+import { SOURCE_ORIGIN, SOURCE_STATUS, SOURCE_TYPE } from '../constants';
+
+export const BookBibliographicMetadataSchema = z.object({
+    type: z.literal(SOURCE_TYPE.BOOK),
+    title: z.string(),
+    authors: z.string(),
+    year: z.number(),
+    publicationCity: z.string(),
+    publisher: z.string(),
+    pageCount: z.number().nullable(),
+});
+export type BookBibliographicMetadata = z.infer<typeof BookBibliographicMetadataSchema>;
+
+export const JournalArticleBibliographicMetadataSchema = z.object({
+    type: z.literal(SOURCE_TYPE.JOURNAL_ARTICLE),
+    title: z.string(),
+    authors: z.string(),
+    year: z.number(),
+    journalName: z.string(),
+    issueNumber: z.string(),
+    pageRange: z.string(),
+});
+export type JournalArticleBibliographicMetadata = z.infer<
+    typeof JournalArticleBibliographicMetadataSchema
+>;
+
+export const SourceBibliographicMetadataSchema = z.discriminatedUnion('type', [
+    BookBibliographicMetadataSchema,
+    JournalArticleBibliographicMetadataSchema,
+]);
+export type SourceBibliographicMetadata = z.infer<typeof SourceBibliographicMetadataSchema>;
 
 export const WriterSourceSchema = z.object({
     uuid: z.string().uuid(),
-    title: z.string(),
     url: z.string().url(),
+    title: z.string().nullable(),
+    type: z.nativeEnum(SOURCE_TYPE).nullable(),
     sourceOrigin: z.nativeEnum(SOURCE_ORIGIN),
+    citation: z.string().nullable(),
+    status: z.nativeEnum(SOURCE_STATUS),
+    bibliographicMetadata: SourceBibliographicMetadataSchema,
     createdAt: z.date(),
     updatedAt: z.date(),
 });
-
 export type WriterSource = z.infer<typeof WriterSourceSchema>;

package/package.json

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