@purpleschool/gptbot-tools 0.1.11 → 0.1.13

package/build/common/enums/file-type.enum.js

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

package/build/common/enums/index.js

@@ -17,3 +17,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./reasoning-effort.enum"), exports);
 __exportStar(require("./user-reaction.enum"), exports);
 __exportStar(require("./tool-model-status.enum"), exports);
+__exportStar(require("./file-type.enum"), exports);

package/build/presentation/commands/create-presentation.command.js

@@ -14,7 +14,6 @@ var CreatePresentationCommand;
         languageId: zod_1.z.string(),
         prompt: zod_1.z.string(),
         slideCount: zod_1.z.number(),
-        titlePage: models_1.PresentationTitlePageSchema.optional().nullable(),
         targetAudience: zod_1.z.nativeEnum(enums_1.PRESENTATION_TARGET_AUDIENCE).optional(),
     });
     CreatePresentationCommand.ResponseSchema = (0, common_1.ICommandResponseSchema)(models_1.PresentationSchema);

package/build/presentation/commands/generate-slides.command.js

@@ -12,6 +12,7 @@ var GenerateSlidesCommand;
         unregisteredUserId: zod_1.z.string().uuid().nullable().optional(),
         tokenReservationId: zod_1.z.string().uuid(),
         precalculatedPrice: zod_1.z.number(),
+        titlePage: models_1.PresentationTitlePageSchema.optional().nullable(),
     });
     GenerateSlidesCommand.ResponseSchema = (0, common_1.ICommandResponseSchema)(models_1.PresentationSchema);
 })(GenerateSlidesCommand || (exports.GenerateSlidesCommand = GenerateSlidesCommand = {}));

package/build/writer/commands/collect-sources.command.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CollectWriterDocumentSourcesCommand = void 0;
+const zod_1 = require("zod");
+const command_response_schema_1 = require("../../common/models/command-response.schema");
+const models_1 = require("../models");
+var CollectWriterDocumentSourcesCommand;
+(function (CollectWriterDocumentSourcesCommand) {
+    CollectWriterDocumentSourcesCommand.RequestSchema = zod_1.z.object({
+        uuid: zod_1.z.string().uuid(),
+        userId: zod_1.z.string().uuid().nullable().optional(),
+        unregisteredUserId: zod_1.z.string().uuid().nullable().optional(),
+    });
+    CollectWriterDocumentSourcesCommand.ResponseSchema = (0, command_response_schema_1.ICommandResponseSchema)(models_1.WriterDocumentSchema);
+})(CollectWriterDocumentSourcesCommand || (exports.CollectWriterDocumentSourcesCommand = CollectWriterDocumentSourcesCommand = {}));

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

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfirmSourceCitationMetadataCommand = void 0;
+const zod_1 = require("zod");
+const command_response_schema_1 = require("../../common/models/command-response.schema");
+const writer_source_schema_1 = require("../models/writer-source.schema");
+const writer_source_bibliographic_metadata_schema_1 = require("../models/writer-source-bibliographic-metadata.schema");
+var ConfirmSourceCitationMetadataCommand;
+(function (ConfirmSourceCitationMetadataCommand) {
+    ConfirmSourceCitationMetadataCommand.RequestSchema = zod_1.z.object({
+        documentId: zod_1.z.string().uuid(),
+        sourceId: zod_1.z.string().uuid(),
+        bibliographicMetadata: writer_source_bibliographic_metadata_schema_1.WriterSourceBibliographicMetadataSchema,
+        userId: zod_1.z.string().uuid().nullable().optional(),
+        unregisteredUserId: zod_1.z.string().uuid().nullable().optional(),
+    });
+    ConfirmSourceCitationMetadataCommand.ResponseSchema = (0, command_response_schema_1.ICommandResponseSchema)(writer_source_schema_1.WriterSourceSchema);
+})(ConfirmSourceCitationMetadataCommand || (exports.ConfirmSourceCitationMetadataCommand = ConfirmSourceCitationMetadataCommand = {}));

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

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GenerateWriterDocumentOutlineCommand = void 0;
+const zod_1 = require("zod");
+const command_response_schema_1 = require("../../common/models/command-response.schema");
+const models_1 = require("../models");
+var GenerateWriterDocumentOutlineCommand;
+(function (GenerateWriterDocumentOutlineCommand) {
+    GenerateWriterDocumentOutlineCommand.RequestSchema = zod_1.z.object({
+        uuid: zod_1.z.string().uuid(),
+        numPages: zod_1.z.number(),
+        description: zod_1.z.string().nullable().optional(),
+        userId: zod_1.z.string().uuid().nullable().optional(),
+        unregisteredUserId: zod_1.z.string().uuid().nullable().optional(),
+    });
+    GenerateWriterDocumentOutlineCommand.ResponseSchema = (0, command_response_schema_1.ICommandResponseSchema)(models_1.WriterDocumentSchema);
+})(GenerateWriterDocumentOutlineCommand || (exports.GenerateWriterDocumentOutlineCommand = GenerateWriterDocumentOutlineCommand = {}));

package/build/writer/commands/index.js

@@ -22,6 +22,7 @@ __exportStar(require("./update-writer-document-title-page.command"), exports);
 __exportStar(require("./toggle-writer-document-title-page.command"), exports);
 __exportStar(require("./export-writer-document-as-docx.command"), exports);
 __exportStar(require("./generate-document-contents.command"), exports);
+__exportStar(require("./generate-document-outline.command"), exports);
 __exportStar(require("./get-writer-content-generation-price.command"), exports);
 __exportStar(require("./writer-paraphrase.command"), exports);
 __exportStar(require("./writer-extend-text.command"), exports);
@@ -30,3 +31,6 @@ __exportStar(require("./writer-fix-errors.command"), exports);
 __exportStar(require("./writer-generate-text.command"), exports);
 __exportStar(require("./update-writer-document-contents.command"), exports);
 __exportStar(require("./set-reaction-writer-document.command"), exports);
+__exportStar(require("./collect-sources.command"), exports);
+__exportStar(require("./upload-writer-source.command"), exports);
+__exportStar(require("./confirm-source-citation-metadata.command"), exports);

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

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UploadWriterSourceCommand = void 0;
+const zod_1 = require("zod");
+const command_response_schema_1 = require("../../common/models/command-response.schema");
+const models_1 = require("../models");
+var UploadWriterSourceCommand;
+(function (UploadWriterSourceCommand) {
+    UploadWriterSourceCommand.RequestSchema = zod_1.z.object({
+        documentId: zod_1.z.string().uuid(),
+        fileId: zod_1.z.string().uuid(),
+        fileUrl: zod_1.z.string().url(),
+        fileType: zod_1.z.enum(['PDF', 'DOCX']),
+        userId: zod_1.z.string().uuid().nullable().optional(),
+        unregisteredUserId: zod_1.z.string().uuid().nullable().optional(),
+    });
+    UploadWriterSourceCommand.ResponseSchema = (0, command_response_schema_1.ICommandResponseSchema)(models_1.WriterSourceSchema);
+})(UploadWriterSourceCommand || (exports.UploadWriterSourceCommand = UploadWriterSourceCommand = {}));

package/build/writer/enums/index.js

@@ -20,3 +20,6 @@ __exportStar(require("./writer-ai-action-type.enum"), exports);
 __exportStar(require("./writer-document-section-type.enum"), exports);
 __exportStar(require("./writer-document-stage.enum"), exports);
 __exportStar(require("./writer-content-generation-strategy.enum"), exports);
+__exportStar(require("./writer-source-type.enum"), exports);
+__exportStar(require("./writer-source-origin.enum"), exports);
+__exportStar(require("./writer-source-status.enum"), exports);

package/build/writer/enums/writer-document-stage.enum.js

@@ -4,9 +4,15 @@ exports.WRITER_DOCUMENT_STAGE = void 0;
 var WRITER_DOCUMENT_STAGE;
 (function (WRITER_DOCUMENT_STAGE) {
     WRITER_DOCUMENT_STAGE["CREATED"] = "CREATED";
+    WRITER_DOCUMENT_STAGE["ANALYZING_TOPIC"] = "ANALYZING_TOPIC";
+    WRITER_DOCUMENT_STAGE["TOPIC_ANALYZED"] = "TOPIC_ANALYZED";
+    WRITER_DOCUMENT_STAGE["TOPIC_ANALYSIS_FAILED"] = "TOPIC_ANALYSIS_FAILED";
     WRITER_DOCUMENT_STAGE["GENERATING_OUTLINE"] = "GENERATING_OUTLINE";
     WRITER_DOCUMENT_STAGE["OUTLINE_GENERATED"] = "OUTLINE_GENERATED";
     WRITER_DOCUMENT_STAGE["OUTLINE_GENERATION_FAILED"] = "OUTLINE_GENERATION_FAILED";
+    WRITER_DOCUMENT_STAGE["COLLECTING_SOURCES"] = "COLLECTING_SOURCES";
+    WRITER_DOCUMENT_STAGE["SOURCES_COLLECTED"] = "SOURCES_COLLECTED";
+    WRITER_DOCUMENT_STAGE["SOURCES_COLLECTION_FAILED"] = "SOURCES_COLLECTION_FAILED";
     WRITER_DOCUMENT_STAGE["GENERATING_CONTENT"] = "GENERATING_CONTENT";
     WRITER_DOCUMENT_STAGE["CONTENT_GENERATED"] = "CONTENT_GENERATED";
     WRITER_DOCUMENT_STAGE["CONTENT_GENERATION_FAILED"] = "CONTENT_GENERATION_FAILED";

package/build/writer/enums/writer-source-origin.enum.js

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

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

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

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

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

package/build/writer/models/index.js

@@ -21,3 +21,5 @@ __exportStar(require("./writer-document-outline.schema"), exports);
 __exportStar(require("./writer-document-title-page.schema"), exports);
 __exportStar(require("./writer-document.schema"), exports);
 __exportStar(require("./writer-document-type.schema"), exports);
+__exportStar(require("./writer-source.schema"), exports);
+__exportStar(require("./writer-source-bibliographic-metadata.schema"), exports);

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

@@ -10,9 +10,9 @@ exports.WriterDocumentTypeSchema = zod_1.z.object({
     order: zod_1.z.number(),
     minPages: zod_1.z.number(),
     maxPages: zod_1.z.number(),
+    skipSources: zod_1.z.boolean(),
     pageRange: zod_1.z.array(zod_1.z.number()),
     needsTableOfContents: zod_1.z.boolean(),
-    needsCitations: zod_1.z.boolean(),
     createdAt: zod_1.z.date(),
     updatedAt: zod_1.z.date(),
 });

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

@@ -22,6 +22,9 @@ exports.WriterDocumentSchema = zod_1.z.object({
     modelId: zod_1.z.string().nullable(),
     reaction: zod_1.z.nativeEnum(common_1.USER_REACTION).nullable(),
     dislikeReason: zod_1.z.string().nullable(),
+    description: zod_1.z.string().nullable(),
+    internalError: zod_1.z.string().nullable(),
+    skipSources: zod_1.z.boolean(),
     pages: zod_1.z.number(),
     isDeleted: zod_1.z.boolean(),
     tokenReservationId: zod_1.z.string().nullable().optional(),

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

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WriterSourceBibliographicMetadataSchema = exports.JournalArticleBibliographicMetadataSchema = exports.BookBibliographicMetadataSchema = void 0;
+const zod_1 = require("zod");
+const enums_1 = require("../enums");
+exports.BookBibliographicMetadataSchema = zod_1.z.object({
+    type: zod_1.z.literal(enums_1.WRITER_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(enums_1.WRITER_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.WriterSourceBibliographicMetadataSchema = zod_1.z.discriminatedUnion('type', [
+    exports.BookBibliographicMetadataSchema,
+    exports.JournalArticleBibliographicMetadataSchema,
+]);

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

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WriterSourceSchema = void 0;
+const zod_1 = require("zod");
+const enums_1 = require("../enums");
+const writer_source_bibliographic_metadata_schema_1 = require("./writer-source-bibliographic-metadata.schema");
+exports.WriterSourceSchema = zod_1.z.object({
+    uuid: zod_1.z.string().uuid(),
+    query: zod_1.z.string().nullable(),
+    url: zod_1.z.string(),
+    snippet: zod_1.z.string().nullable(),
+    inclusionReason: zod_1.z.string().nullable(),
+    sourceOrigin: zod_1.z.nativeEnum(enums_1.WRITER_SOURCE_ORIGIN),
+    content: zod_1.z.string().nullable(),
+    documentId: zod_1.z.string().uuid(),
+    fileId: zod_1.z.string().nullable(),
+    citation: zod_1.z.string().nullable(),
+    status: zod_1.z.nativeEnum(enums_1.WRITER_SOURCE_STATUS),
+    bibliographicMetadata: writer_source_bibliographic_metadata_schema_1.WriterSourceBibliographicMetadataSchema.nullable(),
+    createdAt: zod_1.z.date(),
+    updatedAt: zod_1.z.date(),
+});

package/build/writer/queries/get-writer-document-sources.query.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetWriterDocumentSourcesQueryContract = void 0;
+const zod_1 = require("zod");
+const command_response_schema_1 = require("../../common/models/command-response.schema");
+const models_1 = require("../models");
+var GetWriterDocumentSourcesQueryContract;
+(function (GetWriterDocumentSourcesQueryContract) {
+    GetWriterDocumentSourcesQueryContract.RequestSchema = zod_1.z.object({
+        uuid: zod_1.z.string().uuid(),
+        userId: zod_1.z.string().uuid().nullable().optional(),
+        unregisteredUserId: zod_1.z.string().uuid().nullable().optional(),
+    });
+    GetWriterDocumentSourcesQueryContract.ResponseSchema = (0, command_response_schema_1.ICommandResponseSchema)(zod_1.z.array(models_1.WriterSourceSchema));
+})(GetWriterDocumentSourcesQueryContract || (exports.GetWriterDocumentSourcesQueryContract = GetWriterDocumentSourcesQueryContract = {}));

package/build/writer/queries/index.js

@@ -17,3 +17,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./find-writer-documents.query"), exports);
 __exportStar(require("./get-writer-config.query"), exports);
 __exportStar(require("./find-writer-document-by-uuid.query"), exports);
+__exportStar(require("./get-writer-document-sources.query"), exports);

package/build/writer/routes/writer.routes.js

@@ -13,6 +13,11 @@ exports.WRITER_AMQP_ROUTES = {
     TOGGLE_DOCUMENT_TITLE_PAGE: 'tools.writer.toggle-document-title-page.rpc',
     UPDATE_DOCUMENT_CONTENTS: 'tools.writer.update-document-contents.rpc',
     GENERATE_DOCUMENT_CONTENTS: 'tools.writer.generate-document-contents.rpc',
+    GENERATE_DOCUMENT_OUTLINE: 'tools.writer.generate-document-outline.rpc',
+    COLLECT_SOURCES: 'tools.writer.collect-sources.rpc',
+    GET_DOCUMENT_SOURCES: 'tools.writer.get-document-sources.rpc',
+    UPLOAD_SOURCE: 'tools.writer.upload-source.rpc',
+    CONFIRM_SOURCE_CITATION_METADATA: 'tools.writer.confirm-source-citation-metadata.rpc',
     GET_CONTENT_GENERATION_PRICE: 'tools.writer.content-generation.get-price.rpc',
     PARAPHRASE: 'tools.writer.actions.paraphrase.rpc',
     EXTEND_TEXT: 'tools.writer.actions.extend-text.rpc',

package/common/enums/file-type.enum.ts

@@ -0,0 +1,4 @@
+export enum FILE_TYPE {
+    PDF = 'PDF',
+    DOCX = 'DOCX',
+}

package/common/enums/index.ts

@@ -1,3 +1,4 @@
 export * from './reasoning-effort.enum';
 export * from './user-reaction.enum';
 export * from './tool-model-status.enum';
+export * from './file-type.enum';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@purpleschool/gptbot-tools",
-  "version": "0.1.11",
+  "version": "0.1.13",
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "scripts": {

package/presentation/commands/create-presentation.command.ts

@@ -1,6 +1,6 @@
 import { z } from 'zod';
 import { ICommandResponseSchema } from '../../common';
-import { PresentationSchema, PresentationTitlePageSchema } from '../models';
+import { PresentationSchema } from '../models';
 import { PRESENTATION_TARGET_AUDIENCE } from '../enums';
 
 export namespace CreatePresentationCommand {
@@ -11,7 +11,6 @@ export namespace CreatePresentationCommand {
         languageId: z.string(),
         prompt: z.string(),
         slideCount: z.number(),
-        titlePage: PresentationTitlePageSchema.optional().nullable(),
         targetAudience: z.nativeEnum(PRESENTATION_TARGET_AUDIENCE).optional(),
     });
     export type Request = z.infer<typeof RequestSchema>;

package/presentation/commands/generate-slides.command.ts

@@ -1,6 +1,6 @@
 import { z } from 'zod';
 import { ICommandResponseSchema } from '../../common';
-import { PresentationSchema } from '../models';
+import { PresentationSchema, PresentationTitlePageSchema } from '../models';
 
 export namespace GenerateSlidesCommand {
     export const RequestSchema = z.object({
@@ -9,6 +9,7 @@ export namespace GenerateSlidesCommand {
         unregisteredUserId: z.string().uuid().nullable().optional(),
         tokenReservationId: z.string().uuid(),
         precalculatedPrice: z.number(),
+        titlePage: PresentationTitlePageSchema.optional().nullable(),
     });
     export type Request = z.infer<typeof RequestSchema>;
 

package/writer/commands/collect-sources.command.ts

@@ -0,0 +1,15 @@
+import { z } from 'zod';
+import { ICommandResponseSchema } from '../../common/models/command-response.schema';
+import { WriterDocumentSchema } from '../models';
+
+export namespace CollectWriterDocumentSourcesCommand {
+    export const RequestSchema = z.object({
+        uuid: z.string().uuid(),
+        userId: z.string().uuid().nullable().optional(),
+        unregisteredUserId: z.string().uuid().nullable().optional(),
+    });
+    export type Request = z.infer<typeof RequestSchema>;
+
+    export const ResponseSchema = ICommandResponseSchema(WriterDocumentSchema);
+    export type Response = z.infer<typeof ResponseSchema>;
+}

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

@@ -0,0 +1,18 @@
+import { z } from 'zod';
+import { ICommandResponseSchema } from '../../common/models/command-response.schema';
+import { WriterSourceSchema } from '../models/writer-source.schema';
+import { WriterSourceBibliographicMetadataSchema } from '../models/writer-source-bibliographic-metadata.schema';
+
+export namespace ConfirmSourceCitationMetadataCommand {
+    export const RequestSchema = z.object({
+        documentId: z.string().uuid(),
+        sourceId: z.string().uuid(),
+        bibliographicMetadata: WriterSourceBibliographicMetadataSchema,
+        userId: z.string().uuid().nullable().optional(),
+        unregisteredUserId: z.string().uuid().nullable().optional(),
+    });
+    export type Request = z.infer<typeof RequestSchema>;
+
+    export const ResponseSchema = ICommandResponseSchema(WriterSourceSchema);
+    export type Response = z.infer<typeof ResponseSchema>;
+}

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

@@ -0,0 +1,17 @@
+import { z } from 'zod';
+import { ICommandResponseSchema } from '../../common/models/command-response.schema';
+import { WriterDocumentSchema } from '../models';
+
+export namespace GenerateWriterDocumentOutlineCommand {
+    export const RequestSchema = z.object({
+        uuid: z.string().uuid(),
+        numPages: z.number(),
+        description: z.string().nullable().optional(),
+        userId: z.string().uuid().nullable().optional(),
+        unregisteredUserId: z.string().uuid().nullable().optional(),
+    });
+    export type Request = z.infer<typeof RequestSchema>;
+
+    export const ResponseSchema = ICommandResponseSchema(WriterDocumentSchema);
+    export type Response = z.infer<typeof ResponseSchema>;
+}

package/writer/commands/index.ts

@@ -6,6 +6,7 @@ export * from './update-writer-document-title-page.command';
 export * from './toggle-writer-document-title-page.command';
 export * from './export-writer-document-as-docx.command';
 export * from './generate-document-contents.command';
+export * from './generate-document-outline.command';
 export * from './get-writer-content-generation-price.command';
 export * from './writer-paraphrase.command';
 export * from './writer-extend-text.command';
@@ -14,3 +15,6 @@ export * from './writer-fix-errors.command';
 export * from './writer-generate-text.command';
 export * from './update-writer-document-contents.command';
 export * from './set-reaction-writer-document.command';
+export * from './collect-sources.command';
+export * from './upload-writer-source.command';
+export * from './confirm-source-citation-metadata.command';

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

@@ -0,0 +1,18 @@
+import { z } from 'zod';
+import { ICommandResponseSchema } from '../../common/models/command-response.schema';
+import { WriterSourceSchema } from '../models';
+
+export namespace UploadWriterSourceCommand {
+    export const RequestSchema = z.object({
+        documentId: z.string().uuid(),
+        fileId: z.string().uuid(),
+        fileUrl: z.string().url(),
+        fileType: z.enum(['PDF', 'DOCX']),
+        userId: z.string().uuid().nullable().optional(),
+        unregisteredUserId: z.string().uuid().nullable().optional(),
+    });
+    export type Request = z.infer<typeof RequestSchema>;
+
+    export const ResponseSchema = ICommandResponseSchema(WriterSourceSchema);
+    export type Response = z.infer<typeof ResponseSchema>;
+}

package/writer/enums/index.ts

@@ -4,3 +4,6 @@ export * from './writer-ai-action-type.enum';
 export * from './writer-document-section-type.enum';
 export * from './writer-document-stage.enum';
 export * from './writer-content-generation-strategy.enum';
+export * from './writer-source-type.enum';
+export * from './writer-source-origin.enum';
+export * from './writer-source-status.enum';

package/writer/enums/writer-document-stage.enum.ts

@@ -1,10 +1,18 @@
 export enum WRITER_DOCUMENT_STAGE {
     CREATED = 'CREATED',
 
+    ANALYZING_TOPIC = 'ANALYZING_TOPIC',
+    TOPIC_ANALYZED = 'TOPIC_ANALYZED',
+    TOPIC_ANALYSIS_FAILED = 'TOPIC_ANALYSIS_FAILED',
+
     GENERATING_OUTLINE = 'GENERATING_OUTLINE',
     OUTLINE_GENERATED = 'OUTLINE_GENERATED',
     OUTLINE_GENERATION_FAILED = 'OUTLINE_GENERATION_FAILED',
 
+    COLLECTING_SOURCES = 'COLLECTING_SOURCES',
+    SOURCES_COLLECTED = 'SOURCES_COLLECTED',
+    SOURCES_COLLECTION_FAILED = 'SOURCES_COLLECTION_FAILED',
+
     GENERATING_CONTENT = 'GENERATING_CONTENT',
     CONTENT_GENERATED = 'CONTENT_GENERATED',
     CONTENT_GENERATION_FAILED = 'CONTENT_GENERATION_FAILED',

package/writer/enums/writer-source-origin.enum.ts

@@ -0,0 +1,4 @@
+export enum WRITER_SOURCE_ORIGIN {
+    WEB_SEARCH = 'WEB_SEARCH',
+    USER_UPLOAD = 'USER_UPLOAD',
+}

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

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

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

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

package/writer/models/index.ts

@@ -5,3 +5,5 @@ export * from './writer-document-outline.schema';
 export * from './writer-document-title-page.schema';
 export * from './writer-document.schema';
 export * from './writer-document-type.schema';
+export * from './writer-source.schema';
+export * from './writer-source-bibliographic-metadata.schema';

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

@@ -8,9 +8,9 @@ export const WriterDocumentTypeSchema = z.object({
     order: z.number(),
     minPages: z.number(),
     maxPages: z.number(),
+    skipSources: z.boolean(),
     pageRange: z.array(z.number()),
     needsTableOfContents: z.boolean(),
-    needsCitations: z.boolean(),
     createdAt: z.date(),
     updatedAt: z.date(),
 });

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

@@ -20,6 +20,9 @@ export const WriterDocumentSchema = z.object({
     modelId: z.string().nullable(),
     reaction: z.nativeEnum(USER_REACTION).nullable(),
     dislikeReason: z.string().nullable(),
+    description: z.string().nullable(),
+    internalError: z.string().nullable(),
+    skipSources: z.boolean(),
     pages: z.number(),
     isDeleted: z.boolean(),
     tokenReservationId: z.string().nullable().optional(),

package/writer/models/writer-source-bibliographic-metadata.schema.ts

@@ -0,0 +1,31 @@
+import { z } from 'zod';
+import { WRITER_SOURCE_TYPE } from '../enums';
+
+export const BookBibliographicMetadataSchema = z.object({
+    type: z.literal(WRITER_SOURCE_TYPE.BOOK),
+    title: z.string(),
+    authors: z.string(),
+    year: z.number(),
+    publicationCity: z.string(),
+    publisher: z.string(),
+    pageCount: z.number().nullable(),
+});
+
+export const JournalArticleBibliographicMetadataSchema = z.object({
+    type: z.literal(WRITER_SOURCE_TYPE.JOURNAL_ARTICLE),
+    title: z.string(),
+    authors: z.string(),
+    year: z.number(),
+    journalName: z.string(),
+    issueNumber: z.string(),
+    pageRange: z.string(),
+});
+
+export const WriterSourceBibliographicMetadataSchema = z.discriminatedUnion('type', [
+    BookBibliographicMetadataSchema,
+    JournalArticleBibliographicMetadataSchema,
+]);
+
+export type WriterSourceBibliographicMetadata = z.infer<
+    typeof WriterSourceBibliographicMetadataSchema
+>;

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

@@ -0,0 +1,22 @@
+import { z } from 'zod';
+import { WRITER_SOURCE_ORIGIN, WRITER_SOURCE_STATUS } from '../enums';
+import { WriterSourceBibliographicMetadataSchema } from './writer-source-bibliographic-metadata.schema';
+
+export const WriterSourceSchema = z.object({
+    uuid: z.string().uuid(),
+    query: z.string().nullable(),
+    url: z.string(),
+    snippet: z.string().nullable(),
+    inclusionReason: z.string().nullable(),
+    sourceOrigin: z.nativeEnum(WRITER_SOURCE_ORIGIN),
+    content: z.string().nullable(),
+    documentId: z.string().uuid(),
+    fileId: z.string().nullable(),
+    citation: z.string().nullable(),
+    status: z.nativeEnum(WRITER_SOURCE_STATUS),
+    bibliographicMetadata: WriterSourceBibliographicMetadataSchema.nullable(),
+    createdAt: z.date(),
+    updatedAt: z.date(),
+});
+
+export type WriterSource = z.infer<typeof WriterSourceSchema>;

package/writer/queries/get-writer-document-sources.query.ts

@@ -0,0 +1,15 @@
+import { z } from 'zod';
+import { ICommandResponseSchema } from '../../common/models/command-response.schema';
+import { WriterSourceSchema } from '../models';
+
+export namespace GetWriterDocumentSourcesQueryContract {
+    export const RequestSchema = z.object({
+        uuid: z.string().uuid(),
+        userId: z.string().uuid().nullable().optional(),
+        unregisteredUserId: z.string().uuid().nullable().optional(),
+    });
+    export type Request = z.infer<typeof RequestSchema>;
+
+    export const ResponseSchema = ICommandResponseSchema(z.array(WriterSourceSchema));
+    export type Response = z.infer<typeof ResponseSchema>;
+}

package/writer/queries/index.ts

@@ -1,3 +1,4 @@
 export * from './find-writer-documents.query';
 export * from './get-writer-config.query';
 export * from './find-writer-document-by-uuid.query';
+export * from './get-writer-document-sources.query';

package/writer/routes/writer.routes.ts

@@ -10,6 +10,11 @@ export const WRITER_AMQP_ROUTES = {
     TOGGLE_DOCUMENT_TITLE_PAGE: 'tools.writer.toggle-document-title-page.rpc',
     UPDATE_DOCUMENT_CONTENTS: 'tools.writer.update-document-contents.rpc',
     GENERATE_DOCUMENT_CONTENTS: 'tools.writer.generate-document-contents.rpc',
+    GENERATE_DOCUMENT_OUTLINE: 'tools.writer.generate-document-outline.rpc',
+    COLLECT_SOURCES: 'tools.writer.collect-sources.rpc',
+    GET_DOCUMENT_SOURCES: 'tools.writer.get-document-sources.rpc',
+    UPLOAD_SOURCE: 'tools.writer.upload-source.rpc',
+    CONFIRM_SOURCE_CITATION_METADATA: 'tools.writer.confirm-source-citation-metadata.rpc',
     GET_CONTENT_GENERATION_PRICE: 'tools.writer.content-generation.get-price.rpc',
     PARAPHRASE: 'tools.writer.actions.paraphrase.rpc',
     EXTEND_TEXT: 'tools.writer.actions.extend-text.rpc',