Rename sourceContent -> knowledgeSourceContent

Author: hejny

CHANGELOG.md

@@ -681,7 +681,10 @@ Compile via remote server
 
 ### `0.83.0` _(2025-01-20)_
 
-Export parsing internals to `@promptbook/editable`
+`@promptbook/editable`
+
+-   Export parsing internals to `@promptbook/editable`
+-   Rename `sourceContent` -> `knowledgeSourceContent`
 
 ## In pre-release
 

src/commands/KNOWLEDGE/KnowledgeCommand.ts

@@ -8,5 +8,5 @@ import type { string_knowledge_source_content } from '../../types/typeAliases';
  */
 export type KnowledgeCommand = {
     readonly type: 'KNOWLEDGE';
-    readonly sourceContent: string_knowledge_source_content;
+    readonly knowledgeSourceContent: string_knowledge_source_content;
 };

src/commands/KNOWLEDGE/knowledgeCommand.test.ts

@@ -6,12 +6,12 @@ describe('how KNOWLEDGE command in .book.md files works', () => {
     it('should parse KNOWLEDGE command', () => {
         expect(parseCommand('KNOWLEDGE https://www.pavolhejny.com/', 'PIPELINE_HEAD')).toEqual({
             type: 'KNOWLEDGE',
-            sourceContent: 'https://www.pavolhejny.com/',
+            knowledgeSourceContent: 'https://www.pavolhejny.com/',
         });
         expect(parseCommand('KNOWLEDGE ./hejny-cv.pdf', 'PIPELINE_HEAD')).toEqual({
             //                          <- TODO: [😿] Allow ONLY files scoped in the (sub)directory NOT ../ and test it
             type: 'KNOWLEDGE',
-            sourceContent: './hejny-cv.pdf',
+            knowledgeSourceContent: './hejny-cv.pdf',
         });
     });
 

src/commands/KNOWLEDGE/utils/knowledgeSourceContentToName.ts

@@ -8,7 +8,7 @@ import { normalizeToKebabCase } from '../../../utils/normalization/normalize-to-
  *
  * @public exported from `@promptbook/editable`
  */
-export function knowledgeSourceContentToName(sourceContent: string_knowledge_source_content): string_name {
+export function knowledgeSourceContentToName(knowledgeSourceContent: string_knowledge_source_content): string_name {
     const hash = sha256(hexEncoder.parse(JSON.stringify(sourceContent)))
         //    <- TODO: [🥬] Encapsulate sha256 to some private utility function
         .toString(/* hex */)

src/commands/KNOWLEDGE/utils/sourceContentToName.ts

@@ -8,7 +8,7 @@ import { normalizeToKebabCase } from '../../../utils/normalization/normalize-to-
  *
  * @public exported from `@promptbook/editable`
  */
-export function knowledgeSourceContentToName(sourceContent: string_knowledge_source_content): string_name {
+export function knowledgeSourceContentToName(knowledgeSourceContent: string_knowledge_source_content): string_name {
     const hash = sha256(hexEncoder.parse(JSON.stringify(sourceContent)))
         //    <- TODO: [🥬] Encapsulate sha256 to some private utility function
         .toString(/* hex */)

src/commands/SECTION/sectionCommandParser.ts

@@ -8,10 +8,12 @@ import { SectionTypes } from '../../types/SectionType';
 import type { string_markdown_text } from '../../types/typeAliases';
 import { keepUnused } from '../../utils/organization/keepUnused';
 import { knowledgeCommandParser } from '../KNOWLEDGE/knowledgeCommandParser';
-import type { $PipelineJson } from '../_common/types/CommandParser';
-import type { $TaskJson } from '../_common/types/CommandParser';
-import type { CommandParserInput } from '../_common/types/CommandParser';
-import type { PipelineTaskCommandParser } from '../_common/types/CommandParser';
+import type {
+    $PipelineJson,
+    $TaskJson,
+    CommandParserInput,
+    PipelineTaskCommandParser,
+} from '../_common/types/CommandParser';
 import type { SectionCommand } from './SectionCommand';
 
 /**
@@ -192,7 +194,7 @@ export const sectionCommandParser: PipelineTaskCommandParser<SectionCommand> = {
             knowledgeCommandParser.$applyToPipelineJson(
                 {
                     type: 'KNOWLEDGE',
-                    sourceContent: $taskJson.content, // <- TODO: [🐝][main] !!3 Work with KNOWLEDGE which not referring to the source file or website, but its content itself
+                    knowledgeSourceContent: $taskJson.content, // <- TODO: [🐝][main] !!3 Work with KNOWLEDGE which not referring to the source file or website, but its content itself
                 },
                 $pipelineJson,
             );

src/pipeline/PipelineJson/KnowledgeSourceJson.ts

@@ -1,6 +1,4 @@
-import type { number_id } from '../../types/typeAliases';
-import type { string_knowledge_source_content } from '../../types/typeAliases';
-import type { string_name } from '../../types/typeAliases';
+import type { number_id, string_knowledge_source_content, string_name } from '../../types/typeAliases';
 
 /**
  * Defines one source of knowledge in the pipeline
@@ -26,7 +24,7 @@ export type KnowledgeSourceJson = {
      * For example `"Pavol Hejný has web https://pavolhejny.com/"`
      * For example `"Pavol Hejný is web developer and creator of Promptbook and Collboard"`
      */
-    readonly sourceContent: string_knowledge_source_content;
+    readonly knowledgeSourceContent: string_knowledge_source_content;
 };
 
 /**

src/scrapers/document-legacy/LegacyDocumentScraper.test.ts

@@ -26,7 +26,7 @@ describe('how creating knowledge from docx works', () => {
                 legacyDocumentScraperPromise,
                 makeKnowledgeSourceHandler(
                     {
-                        sourceContent: '10-simple.doc',
+                        knowledgeSourceContent: '10-simple.doc',
                     },
                     { fs: $provideFilesystemForNode() },
                     { rootDirname },
@@ -47,7 +47,7 @@ describe('how creating knowledge from docx works', () => {
                 legacyDocumentScraperPromise,
                 makeKnowledgeSourceHandler(
                     {
-                        sourceContent: '10-simple.rtf',
+                        knowledgeSourceContent: '10-simple.rtf',
                     },
                     { fs: $provideFilesystemForNode() },
                     { rootDirname },
@@ -68,7 +68,7 @@ describe('how creating knowledge from docx works', () => {
                 legacyDocumentScraperPromise,
                 makeKnowledgeSourceHandler(
                     {
-                        sourceContent: '10-simple.doc',
+                        knowledgeSourceContent: '10-simple.doc',
                     },
                     { fs: $provideFilesystemForNode() },
                     { rootDirname },

src/scrapers/document-legacy/playground/legacy-document-scraper-playground.ts

@@ -51,7 +51,7 @@ async function playground() {
 
     const knowledge = await legacyDocumentScraper.scrape(
         await makeKnowledgeSourceHandler(
-            { sourceContent: example },
+            { knowledgeSourceContent: example },
             { fs: $provideFilesystemForNode() },
             { rootDirname },
         ),

src/scrapers/document/DocumentScraper.test.ts

@@ -27,7 +27,7 @@ describe('how creating knowledge from docx works', () => {
                 documentScraperPromise,
                 makeKnowledgeSourceHandler(
                     {
-                        sourceContent: '10-simple.docx',
+                        knowledgeSourceContent: '10-simple.docx',
                     },
                     { fs: $provideFilesystemForNode() },
                     { rootDirname },
@@ -48,7 +48,7 @@ describe('how creating knowledge from docx works', () => {
                 documentScraperPromise,
                 makeKnowledgeSourceHandler(
                     {
-                        sourceContent: '10-simple.odt',
+                        knowledgeSourceContent: '10-simple.odt',
                     },
                     { fs: $provideFilesystemForNode() },
                     { rootDirname },
@@ -69,7 +69,7 @@ describe('how creating knowledge from docx works', () => {
                 documentScraperPromise,
                 makeKnowledgeSourceHandler(
                     {
-                        sourceContent: '10-simple.docx',
+                        knowledgeSourceContent: '10-simple.docx',
                     },
                     { fs: $provideFilesystemForNode() },
                     { rootDirname },

src/scrapers/document/playground/document-scraper-playground.ts

@@ -51,7 +51,7 @@ async function playground() {
 
     const knowledge = await documentScraper.scrape(
         await makeKnowledgeSourceHandler(
-            { sourceContent: example },
+            { knowledgeSourceContent: example },
             { fs: $provideFilesystemForNode() },
             { rootDirname },
         ),

src/scrapers/markdown/MarkdownScraper.test.ts

@@ -25,7 +25,7 @@ describe('how creating knowledge from markdown works', () => {
                 .then(() =>
                     makeKnowledgeSourceHandler(
                         {
-                            sourceContent: '10-simple.md',
+                            knowledgeSourceContent: '10-simple.md',
                         },
                         { fs: $provideFilesystemForNode() },
                         { rootDirname },
@@ -46,7 +46,7 @@ describe('how creating knowledge from markdown works', () => {
                 .then(() =>
                     makeKnowledgeSourceHandler(
                         {
-                            sourceContent: '10-simple.md',
+                            knowledgeSourceContent: '10-simple.md',
                         },
                         { fs: $provideFilesystemForNode() },
                         { rootDirname },

src/scrapers/markdown/playground/markdown-scraper-playground.ts

@@ -45,7 +45,7 @@ async function playground() {
 
     const knowledge = await markdownScraper.scrape(
         await makeKnowledgeSourceHandler(
-            { sourceContent: example },
+            { knowledgeSourceContent: example },
             { fs: $provideFilesystemForNode() },
             { rootDirname },
         ),

src/scrapers/pdf/playground/pdf-scraper-playground.ts

@@ -46,7 +46,7 @@ async function playground() {
 
     const knowledge = await pdfScraper.scrape(
         await makeKnowledgeSourceHandler(
-            { sourceContent: example },
+            { knowledgeSourceContent: example },
             { fs: $provideFilesystemForNode() },
             { rootDirname },
         ),

src/scrapers/website/playground/website-scraper-playground.ts

@@ -46,7 +46,7 @@ async function playground() {
     );
 
     const source = await makeKnowledgeSourceHandler(
-        { sourceContent: example },
+        { knowledgeSourceContent: example },
         { fs: $provideFilesystemForNode() },
         { rootDirname },
     );