jg-publishing-guides 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/API.md +1 -1
- package/CHANGELOG.md +6 -0
- package/dist/guide/validations.js +4 -11
- package/dist/guide/validations.js.map +1 -1
- package/package.json +1 -1
package/API.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# <a id="api-reference"></a>jg-publishing-guides API reference
|
|
2
2
|
|
|
3
|
-
Every export of `jg-publishing-guides@1.0.
|
|
3
|
+
Every export of `jg-publishing-guides@1.0.1`, 9 in all, with its signature, its errors, and an example. It's generated from the package's TSDoc.
|
|
4
4
|
|
|
5
5
|
- Functions: [`renderPublishingGuide`](#api-renderPublishingGuide)
|
|
6
6
|
- Constants: [`ERRORS`](#api-ERRORS)
|
package/CHANGELOG.md
CHANGED
|
@@ -76,17 +76,10 @@ const registerStep = (step, ids) => {
|
|
|
76
76
|
const id = step.id ?? step.channel;
|
|
77
77
|
if (typeof id !== 'string' || !/^[a-z][a-z0-9-]*$/u.test(id) || id.length > 64)
|
|
78
78
|
invalidGuide('Channel IDs must be portable lowercase identifiers.');
|
|
79
|
-
const suffixes = [
|
|
80
|
-
|
|
81
|
-
'-
|
|
82
|
-
|
|
83
|
-
'-media',
|
|
84
|
-
'-review',
|
|
85
|
-
'-caption',
|
|
86
|
-
'-caption-status',
|
|
87
|
-
'-title',
|
|
88
|
-
'-title-status',
|
|
89
|
-
];
|
|
79
|
+
const suffixes = ['', '-start', '-copy', '-media', '-review', '-caption', '-caption-status'];
|
|
80
|
+
if (step.documentTitle !== undefined || step.postTitle !== undefined) {
|
|
81
|
+
suffixes.push('-title', '-title-status');
|
|
82
|
+
}
|
|
90
83
|
if (step.documentTitle === undefined) {
|
|
91
84
|
for (let index = 1; index <= step.media.length; index += 1)
|
|
92
85
|
suffixes.push(`-alt-${index}`, `-alt-${index}-status`);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"validations.js","sourceRoot":"","sources":["../../src/guide/validations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAUzC,qDAAqD;AACrD,MAAM,CAAC,MAAM,MAAM,GAAG,EAAE,wBAAwB,EAAE,0BAA0B,EAAW,CAAC;AAExF,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAqB;IAC3C,GAAG;IACH,UAAU;IACV,WAAW;IACX,QAAQ;IACR,UAAU;IACV,SAAS;IACT,SAAS;IACT,SAAS;IACT,QAAQ;IACR,MAAM;CACP,CAAC,CAAC;AACH,MAAM,cAAc,GAAG,yBAAyB,CAAC;AACjD,MAAM,aAAa,GAAG,iDAAiD,CAAC;AACxE,MAAM,kBAAkB,GAAG,kBAAkB,CAAC;AAC9C,MAAM,SAAS,GAAG,EAAE,CAAC;AACrB,MAAM,cAAc,GAAG,EAAE,GAAG,IAAI,CAAC;AACjC,MAAM,qBAAqB,GAAG,MAAM,CAAC;AAErC;;;GAGG;AACH,MAAM,CAAC,MAAM,YAAY,GAA8B,CAAC,MAAM,EAAE,EAAE;IAChE,MAAM,IAAI,SAAS,CAAC,2CAA2C,MAAM,EAAE,EAAE;QACvE,IAAI,EAAE,MAAM,CAAC,wBAAwB;KACtC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,MAAM,GAAG,CAAC,IAAa,EAAkB,EAAE,CAC/C,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAEnF,MAAM,cAAc,GAAG,CAAC,IAAa,EAAkB,EAAE,CACvD,OAAO,IAAI,KAAK,QAAQ;IACxB,IAAI,CAAC,MAAM,IAAI,GAAG;IAClB,IAAI;SACD,KAAK,CAAC,GAAG,CAAC;SACV,KAAK,CACJ,CAAC,IAAI,EAAE,EAAE,CACP,IAAI,CAAC,MAAM,IAAI,EAAE;QACjB,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC;QACzB,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;QACnB,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAC5B,CAAC;AAEN,MAAM,WAAW,GAAG,CAAC,IAAY,EAAW,EAAE,CAC5C,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,IAAI,GAAG,CAAC,IAAI,IAAI,IAAI,qBAAqB,CAAC;AAE1E;;;;GAIG;AACH,MAAM,UAAU,GAAG,CAAC,KAA6B,EAAqC,EAAE;IACtF,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,MAAM,GAAG,SAAS;QACvE,YAAY,CAAC,gCAAgC,CAAC,CAAC;IACjD,MAAM,KAAK,GAAG,CAAC,iBAAiB,EAAE,YAAY,CAAC,CAAC;IAChD,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAgC,CAAC;IACzD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,IACE,CAAC,IAAI;YACL,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;YACnB,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;YACrB,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC;YAC1B,CAAC,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;YAE/C,YAAY,CAAC,oEAAoE,CAAC,CAAC;QACrF,IACE,KAAK,CAAC,IAAI,CACR,CAAC,IAAI,EAAE,EAAE,CACP,IAAI,KAAK,IAAI,CAAC,IAAI;YAClB,IAAI,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,IAAI,GAAG,CAAC;YAChC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,IAAI,GAAG,CAAC,CACnC;YAED,YAAY,CAAC,gDAAgD,CAAC,CAAC;QACjE,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,IAAI,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACjF,YAAY,CAAC,mDAAmD,CAAC,CAAC;QACpE,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC9B,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,YAAY,GAAG,CAAC,IAA0B,EAAE,GAAgB,EAAU,EAAE;IAC5E,MAAM,EAAE,GAAG,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,OAAO,CAAC;IACnC,IAAI,OAAO,EAAE,KAAK,QAAQ,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,EAAE;QAC5E,YAAY,CAAC,qDAAqD,CAAC,CAAC;IACtE,MAAM,QAAQ,GAAG;QACf,EAAE;QACF,QAAQ;QACR,OAAO;QACP,QAAQ;QACR,SAAS;QACT,UAAU;QACV,iBAAiB;QACjB,QAAQ;QACR,eAAe;KAChB,CAAC;IACF,IAAI,IAAI,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;QACrC,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,IAAI,CAAC;YACxD,QAAQ,CAAC,IAAI,CAAC,QAAQ,KAAK,EAAE,EAAE,QAAQ,KAAK,SAAS,CAAC,CAAC;IAC3D,CAAC;IACD,KAAK,MAAM,MAAM,IAAI,QAAQ,EAAE,CAAC;QAC9B,MAAM,MAAM,GAAG,EAAE,GAAG,MAAM,CAAC;QAC3B,IAAI,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC;YAAE,YAAY,CAAC,sCAAsC,CAAC,CAAC;QAC1E,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAClB,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAC3B,KAAuB,EACvB,IAAiC,EACjC,MAA8B,EACxB,EAAE;IACR,IACE,CAAC,KAAK;QACN,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;QACpB,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC;QACtB,CAAC,MAAM,KAAK,IAAI,IAAI,MAAM,KAAK,IAAI,CAAC;QAEpC,YAAY,CAAC,qDAAqD,CAAC,CAAC;IACtE,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACtC,IAAI,CAAC,CAAC,IAAI,YAAY,GAAG,CAAC;QAAE,YAAY,CAAC,iDAAiD,CAAC,CAAC;IAC5F,KAAK,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;QAChC,IACE,OAAO,IAAI,KAAK,QAAQ;YACxB,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC;YAChB,CAAC,MAAM,CAAC,IAAI,CAAC;YACb,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,cAAc;YAExC,YAAY,CAAC,iEAAiE,CAAC,CAAC;IACpF,CAAC;IAED,MAAM,EAAE,WAAW,EAAE,GAAG,KAAK,CAAC;IAC9B,IAAI,WAAW,KAAK,SAAS;QAAE,OAAO;IACtC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,IAAI,WAAW,CAAC,MAAM,GAAG,SAAS;QACzF,YAAY,CAAC,wCAAwC,CAAC,CAAC;IAEzD,MAAM,GAAG,GAAG,IAAI,GAAG,EAAU,CAAC;IAC9B,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAgC,CAAC;IACzD,KAAK,MAAM,IAAI,IAAI,WAAW,EAAE,CAAC;QAC/B,IACE,CAAC,IAAI;YACL,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC;YAC3B,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC;YAC1B,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,SAAS;YAC7B,CAAC,IAAI,CAAC,KAAK,KAAK,SAAS,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAEjD,YAAY,CAAC,yDAAyD,CAAC,CAAC;QAC1E,MAAM,EAAE,GAAG,YAAY,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QACnC,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YAChC,MAAM,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC7C,IACE,IAAI,CAAC,OAAO,KAAK,WAAW;gBAC5B,CAAC,QAAQ;gBACT,QAAQ,CAAC,OAAO,KAAK,WAAW;gBAChC,QAAQ,CAAC,QAAQ,KAAK,SAAS;gBAC/B,QAAQ,CAAC,EAAE,KAAK,IAAI,CAAC,QAAQ;gBAC7B,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC;gBACvB,CAAC,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACvD,IAAI,CAAC,SAAS,KAAK,SAAS;gBAC5B,IAAI,CAAC,aAAa,KAAK,SAAS;gBAEhC,YAAY,CACV,kFAAkF,CACnF,CAAC;QACN,CAAC;aAAM,CAAC;YACN,IACE,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC;gBACvB,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC;gBACrB,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,KAAK,CAAC,MAAM;gBAE9C,YAAY,CAAC,sEAAsE,CAAC,CAAC;YACvF,IACE,IAAI,CAAC,SAAS,KAAK,SAAS;gBAC5B,CAAC,IAAI,CAAC,OAAO,KAAK,QAAQ,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBAE3F,YAAY,CAAC,mDAAmD,CAAC,CAAC;YACpE,IAAI,IAAI,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;gBACrC,IACE,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC;oBAC3B,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC;oBACvB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC;oBAChC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,KAAK,MAAM;oBAEzC,YAAY,CAAC,qDAAqD,CAAC,CAAC;YACxE,CAAC;iBAAM,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,KAAK,OAAO,CAAC,EAAE,CAAC;gBAC1E,YAAY,CAAC,qDAAqD,CAAC,CAAC;YACtE,CAAC;QACH,CAAC;QACD,QAAQ,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;IACzB,CAAC;AACH,CAAC,CAAC","sourcesContent":["import { Exception } from 'jg-exception';\n\nimport type {\n IPublishingChannel,\n IPublishingGuide,\n IPublishingGuideFile,\n IPublishingGuideLocale,\n IPublishingGuideStep,\n} from './types.js';\n\n// stable public code for presentation input failures\nexport const ERRORS = { INVALID_PUBLISHING_GUIDE: 'INVALID_PUBLISHING_GUIDE' } as const;\n\nconst CHANNELS = new Set<IPublishingChannel>([\n 'x',\n 'linkedin',\n 'instagram',\n 'tiktok',\n 'facebook',\n 'threads',\n 'bluesky',\n 'youtube',\n 'github',\n 'post',\n]);\nconst PATH_COMPONENT = /^[a-z0-9][a-z0-9._-]*$/u;\nconst RESERVED_NAME = /^(?:con|prn|aux|nul|com[1-9]|lpt[1-9])(?:\\.|$)/u;\nconst CONTROL_CHARACTERS = /[^\\P{Cc}\\n\\r\\t]/u;\nconst MAX_FILES = 64;\nconst MAX_COPY_BYTES = 64 * 1024;\nconst MAX_PREVIEW_DIMENSION = 16_384;\n\n/**\n * Rejects a broken presentation contract with an operation-specific diagnostic.\n * @param detail The failed validation.\n */\nexport const invalidGuide: (detail: string) => never = (detail) => {\n throw new Exception(`The publishing guide input is invalid.: ${detail}`, {\n code: ERRORS.INVALID_PUBLISHING_GUIDE,\n });\n};\n\nconst isText = (text: unknown): text is string =>\n typeof text === 'string' && text.trim() !== '' && !CONTROL_CHARACTERS.test(text);\n\nconst isPortablePath = (path: unknown): path is string =>\n typeof path === 'string' &&\n path.length <= 160 &&\n path\n .split('/')\n .every(\n (part) =>\n part.length <= 64 &&\n PATH_COMPONENT.test(part) &&\n !part.endsWith('.') &&\n !RESERVED_NAME.test(part),\n );\n\nconst isDimension = (size: number): boolean =>\n Number.isSafeInteger(size) && size > 0 && size <= MAX_PREVIEW_DIMENSION;\n\n/**\n * Checks the selected local filenames and preview attributes without accessing the files.\n * @param files The selected files.\n * @returns A file lookup by portable output path.\n */\nconst indexFiles = (files: IPublishingGuideFile[]): Map<string, IPublishingGuideFile> => {\n if (!Array.isArray(files) || files.length < 1 || files.length > MAX_FILES)\n invalidGuide('Select between 1 and 64 files.');\n const names = ['start-here.html', 'readme.txt'];\n const selected = new Map<string, IPublishingGuideFile>();\n for (const file of files) {\n if (\n !file ||\n !isText(file.label) ||\n !isText(file.details) ||\n !isPortablePath(file.path) ||\n !['file', 'image', 'video'].includes(file.kind)\n )\n invalidGuide('Every file needs portable output, a known kind and literal labels.');\n if (\n names.some(\n (name) =>\n name === file.path ||\n name.startsWith(`${file.path}/`) ||\n file.path.startsWith(`${name}/`),\n )\n )\n invalidGuide('File paths collide or replace a viewing guide.');\n if (file.kind !== 'file' && (!isDimension(file.width) || !isDimension(file.height)))\n invalidGuide('Images and videos need positive pixel dimensions.');\n selected.set(file.path, file);\n names.push(file.path);\n }\n return selected;\n};\n\n/**\n * Confirms that a channel's ID and every generated anchor remain unique.\n * @param step The channel step.\n * @param ids The generated document IDs.\n * @returns The channel's ID.\n */\nconst registerStep = (step: IPublishingGuideStep, ids: Set<string>): string => {\n const id = step.id ?? step.channel;\n if (typeof id !== 'string' || !/^[a-z][a-z0-9-]*$/u.test(id) || id.length > 64)\n invalidGuide('Channel IDs must be portable lowercase identifiers.');\n const suffixes = [\n '',\n '-start',\n '-copy',\n '-media',\n '-review',\n '-caption',\n '-caption-status',\n '-title',\n '-title-status',\n ];\n if (step.documentTitle === undefined) {\n for (let index = 1; index <= step.media.length; index += 1)\n suffixes.push(`-alt-${index}`, `-alt-${index}-status`);\n }\n for (const suffix of suffixes) {\n const anchor = id + suffix;\n if (ids.has(anchor)) invalidGuide('Channel IDs or step anchors collide.');\n ids.add(anchor);\n }\n return id;\n};\n\n/**\n * Validates the relationships the page renders. Selection and publication authority stay upstream.\n * @param guide The publishing presentation.\n * @param copy Literal text by selected file path.\n * @param locale The supplied interface language.\n */\nexport const validateGuide = (\n guide: IPublishingGuide,\n copy: ReadonlyMap<string, string>,\n locale: IPublishingGuideLocale,\n): void => {\n if (\n !guide ||\n !isText(guide.title) ||\n !isText(guide.summary) ||\n (locale !== 'en' && locale !== 'es')\n )\n invalidGuide('A title, summary and supported locale are required.');\n const files = indexFiles(guide.files);\n if (!(copy instanceof Map)) invalidGuide('Supply literal copy as a map of selected files.');\n for (const [path, text] of copy) {\n if (\n typeof path !== 'string' ||\n !files.has(path) ||\n !isText(text) ||\n Buffer.byteLength(text) > MAX_COPY_BYTES\n )\n invalidGuide('Copy must be selected nonblank text of at most 64 KiB per file.');\n }\n\n const { walkthrough } = guide;\n if (walkthrough === undefined) return;\n if (!Array.isArray(walkthrough) || walkthrough.length < 1 || walkthrough.length > MAX_FILES)\n invalidGuide('Supply between 1 and 64 channel steps.');\n\n const ids = new Set<string>();\n const previous = new Map<string, IPublishingGuideStep>();\n for (const step of walkthrough) {\n if (\n !step ||\n !CHANNELS.has(step.channel) ||\n !Array.isArray(step.media) ||\n step.media.length > MAX_FILES ||\n (step.label !== undefined && !isText(step.label))\n )\n invalidGuide('Each step needs a supported channel and an upload list.');\n const id = registerStep(step, ids);\n if (step.repostOf !== undefined) {\n const original = previous.get(step.repostOf);\n if (\n step.channel !== 'instagram' ||\n !original ||\n original.channel !== 'instagram' ||\n original.repostOf !== undefined ||\n original.id !== step.repostOf ||\n step.media.length !== 0 ||\n (step.caption !== undefined && !copy.has(step.caption)) ||\n step.postTitle !== undefined ||\n step.documentTitle !== undefined\n )\n invalidGuide(\n 'Reposts must reference an earlier Instagram original and select no upload media.',\n );\n } else {\n if (\n !copy.has(step.caption) ||\n step.media.length < 1 ||\n new Set(step.media).size !== step.media.length\n )\n invalidGuide('Each original step needs a selected caption and unique upload files.');\n if (\n step.postTitle !== undefined &&\n (step.channel !== 'tiktok' || step.postTitle === step.caption || !copy.has(step.postTitle))\n )\n invalidGuide('A TikTok title must select separate literal copy.');\n if (step.documentTitle !== undefined) {\n if (\n !isText(step.documentTitle) ||\n step.media.length !== 1 ||\n !step.media[0]?.endsWith('.pdf') ||\n files.get(step.media[0])?.kind !== 'file'\n )\n invalidGuide('A document step needs a title and one selected PDF.');\n } else if (!step.media.every((path) => files.get(path)?.kind === 'image')) {\n invalidGuide('An image upload step must refer to selected images.');\n }\n }\n previous.set(id, step);\n }\n};\n"]}
|
|
1
|
+
{"version":3,"file":"validations.js","sourceRoot":"","sources":["../../src/guide/validations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAUzC,qDAAqD;AACrD,MAAM,CAAC,MAAM,MAAM,GAAG,EAAE,wBAAwB,EAAE,0BAA0B,EAAW,CAAC;AAExF,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAqB;IAC3C,GAAG;IACH,UAAU;IACV,WAAW;IACX,QAAQ;IACR,UAAU;IACV,SAAS;IACT,SAAS;IACT,SAAS;IACT,QAAQ;IACR,MAAM;CACP,CAAC,CAAC;AACH,MAAM,cAAc,GAAG,yBAAyB,CAAC;AACjD,MAAM,aAAa,GAAG,iDAAiD,CAAC;AACxE,MAAM,kBAAkB,GAAG,kBAAkB,CAAC;AAC9C,MAAM,SAAS,GAAG,EAAE,CAAC;AACrB,MAAM,cAAc,GAAG,EAAE,GAAG,IAAI,CAAC;AACjC,MAAM,qBAAqB,GAAG,MAAM,CAAC;AAErC;;;GAGG;AACH,MAAM,CAAC,MAAM,YAAY,GAA8B,CAAC,MAAM,EAAE,EAAE;IAChE,MAAM,IAAI,SAAS,CAAC,2CAA2C,MAAM,EAAE,EAAE;QACvE,IAAI,EAAE,MAAM,CAAC,wBAAwB;KACtC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,MAAM,GAAG,CAAC,IAAa,EAAkB,EAAE,CAC/C,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAEnF,MAAM,cAAc,GAAG,CAAC,IAAa,EAAkB,EAAE,CACvD,OAAO,IAAI,KAAK,QAAQ;IACxB,IAAI,CAAC,MAAM,IAAI,GAAG;IAClB,IAAI;SACD,KAAK,CAAC,GAAG,CAAC;SACV,KAAK,CACJ,CAAC,IAAI,EAAE,EAAE,CACP,IAAI,CAAC,MAAM,IAAI,EAAE;QACjB,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC;QACzB,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;QACnB,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAC5B,CAAC;AAEN,MAAM,WAAW,GAAG,CAAC,IAAY,EAAW,EAAE,CAC5C,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,IAAI,GAAG,CAAC,IAAI,IAAI,IAAI,qBAAqB,CAAC;AAE1E;;;;GAIG;AACH,MAAM,UAAU,GAAG,CAAC,KAA6B,EAAqC,EAAE;IACtF,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,MAAM,GAAG,SAAS;QACvE,YAAY,CAAC,gCAAgC,CAAC,CAAC;IACjD,MAAM,KAAK,GAAG,CAAC,iBAAiB,EAAE,YAAY,CAAC,CAAC;IAChD,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAgC,CAAC;IACzD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,IACE,CAAC,IAAI;YACL,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;YACnB,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;YACrB,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC;YAC1B,CAAC,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;YAE/C,YAAY,CAAC,oEAAoE,CAAC,CAAC;QACrF,IACE,KAAK,CAAC,IAAI,CACR,CAAC,IAAI,EAAE,EAAE,CACP,IAAI,KAAK,IAAI,CAAC,IAAI;YAClB,IAAI,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,IAAI,GAAG,CAAC;YAChC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,IAAI,GAAG,CAAC,CACnC;YAED,YAAY,CAAC,gDAAgD,CAAC,CAAC;QACjE,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,IAAI,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACjF,YAAY,CAAC,mDAAmD,CAAC,CAAC;QACpE,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC9B,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,YAAY,GAAG,CAAC,IAA0B,EAAE,GAAgB,EAAU,EAAE;IAC5E,MAAM,EAAE,GAAG,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,OAAO,CAAC;IACnC,IAAI,OAAO,EAAE,KAAK,QAAQ,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,EAAE;QAC5E,YAAY,CAAC,qDAAqD,CAAC,CAAC;IACtE,MAAM,QAAQ,GAAG,CAAC,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,iBAAiB,CAAC,CAAC;IAC7F,IAAI,IAAI,CAAC,aAAa,KAAK,SAAS,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;QACrE,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;IAC3C,CAAC;IACD,IAAI,IAAI,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;QACrC,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,IAAI,CAAC;YACxD,QAAQ,CAAC,IAAI,CAAC,QAAQ,KAAK,EAAE,EAAE,QAAQ,KAAK,SAAS,CAAC,CAAC;IAC3D,CAAC;IACD,KAAK,MAAM,MAAM,IAAI,QAAQ,EAAE,CAAC;QAC9B,MAAM,MAAM,GAAG,EAAE,GAAG,MAAM,CAAC;QAC3B,IAAI,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC;YAAE,YAAY,CAAC,sCAAsC,CAAC,CAAC;QAC1E,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAClB,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAC3B,KAAuB,EACvB,IAAiC,EACjC,MAA8B,EACxB,EAAE;IACR,IACE,CAAC,KAAK;QACN,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;QACpB,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC;QACtB,CAAC,MAAM,KAAK,IAAI,IAAI,MAAM,KAAK,IAAI,CAAC;QAEpC,YAAY,CAAC,qDAAqD,CAAC,CAAC;IACtE,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACtC,IAAI,CAAC,CAAC,IAAI,YAAY,GAAG,CAAC;QAAE,YAAY,CAAC,iDAAiD,CAAC,CAAC;IAC5F,KAAK,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;QAChC,IACE,OAAO,IAAI,KAAK,QAAQ;YACxB,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC;YAChB,CAAC,MAAM,CAAC,IAAI,CAAC;YACb,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,cAAc;YAExC,YAAY,CAAC,iEAAiE,CAAC,CAAC;IACpF,CAAC;IAED,MAAM,EAAE,WAAW,EAAE,GAAG,KAAK,CAAC;IAC9B,IAAI,WAAW,KAAK,SAAS;QAAE,OAAO;IACtC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,IAAI,WAAW,CAAC,MAAM,GAAG,SAAS;QACzF,YAAY,CAAC,wCAAwC,CAAC,CAAC;IAEzD,MAAM,GAAG,GAAG,IAAI,GAAG,EAAU,CAAC;IAC9B,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAgC,CAAC;IACzD,KAAK,MAAM,IAAI,IAAI,WAAW,EAAE,CAAC;QAC/B,IACE,CAAC,IAAI;YACL,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC;YAC3B,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC;YAC1B,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,SAAS;YAC7B,CAAC,IAAI,CAAC,KAAK,KAAK,SAAS,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAEjD,YAAY,CAAC,yDAAyD,CAAC,CAAC;QAC1E,MAAM,EAAE,GAAG,YAAY,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QACnC,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YAChC,MAAM,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC7C,IACE,IAAI,CAAC,OAAO,KAAK,WAAW;gBAC5B,CAAC,QAAQ;gBACT,QAAQ,CAAC,OAAO,KAAK,WAAW;gBAChC,QAAQ,CAAC,QAAQ,KAAK,SAAS;gBAC/B,QAAQ,CAAC,EAAE,KAAK,IAAI,CAAC,QAAQ;gBAC7B,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC;gBACvB,CAAC,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACvD,IAAI,CAAC,SAAS,KAAK,SAAS;gBAC5B,IAAI,CAAC,aAAa,KAAK,SAAS;gBAEhC,YAAY,CACV,kFAAkF,CACnF,CAAC;QACN,CAAC;aAAM,CAAC;YACN,IACE,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC;gBACvB,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC;gBACrB,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,KAAK,CAAC,MAAM;gBAE9C,YAAY,CAAC,sEAAsE,CAAC,CAAC;YACvF,IACE,IAAI,CAAC,SAAS,KAAK,SAAS;gBAC5B,CAAC,IAAI,CAAC,OAAO,KAAK,QAAQ,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBAE3F,YAAY,CAAC,mDAAmD,CAAC,CAAC;YACpE,IAAI,IAAI,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;gBACrC,IACE,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC;oBAC3B,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC;oBACvB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC;oBAChC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,KAAK,MAAM;oBAEzC,YAAY,CAAC,qDAAqD,CAAC,CAAC;YACxE,CAAC;iBAAM,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,KAAK,OAAO,CAAC,EAAE,CAAC;gBAC1E,YAAY,CAAC,qDAAqD,CAAC,CAAC;YACtE,CAAC;QACH,CAAC;QACD,QAAQ,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;IACzB,CAAC;AACH,CAAC,CAAC","sourcesContent":["import { Exception } from 'jg-exception';\n\nimport type {\n IPublishingChannel,\n IPublishingGuide,\n IPublishingGuideFile,\n IPublishingGuideLocale,\n IPublishingGuideStep,\n} from './types.js';\n\n// stable public code for presentation input failures\nexport const ERRORS = { INVALID_PUBLISHING_GUIDE: 'INVALID_PUBLISHING_GUIDE' } as const;\n\nconst CHANNELS = new Set<IPublishingChannel>([\n 'x',\n 'linkedin',\n 'instagram',\n 'tiktok',\n 'facebook',\n 'threads',\n 'bluesky',\n 'youtube',\n 'github',\n 'post',\n]);\nconst PATH_COMPONENT = /^[a-z0-9][a-z0-9._-]*$/u;\nconst RESERVED_NAME = /^(?:con|prn|aux|nul|com[1-9]|lpt[1-9])(?:\\.|$)/u;\nconst CONTROL_CHARACTERS = /[^\\P{Cc}\\n\\r\\t]/u;\nconst MAX_FILES = 64;\nconst MAX_COPY_BYTES = 64 * 1024;\nconst MAX_PREVIEW_DIMENSION = 16_384;\n\n/**\n * Rejects a broken presentation contract with an operation-specific diagnostic.\n * @param detail The failed validation.\n */\nexport const invalidGuide: (detail: string) => never = (detail) => {\n throw new Exception(`The publishing guide input is invalid.: ${detail}`, {\n code: ERRORS.INVALID_PUBLISHING_GUIDE,\n });\n};\n\nconst isText = (text: unknown): text is string =>\n typeof text === 'string' && text.trim() !== '' && !CONTROL_CHARACTERS.test(text);\n\nconst isPortablePath = (path: unknown): path is string =>\n typeof path === 'string' &&\n path.length <= 160 &&\n path\n .split('/')\n .every(\n (part) =>\n part.length <= 64 &&\n PATH_COMPONENT.test(part) &&\n !part.endsWith('.') &&\n !RESERVED_NAME.test(part),\n );\n\nconst isDimension = (size: number): boolean =>\n Number.isSafeInteger(size) && size > 0 && size <= MAX_PREVIEW_DIMENSION;\n\n/**\n * Checks the selected local filenames and preview attributes without accessing the files.\n * @param files The selected files.\n * @returns A file lookup by portable output path.\n */\nconst indexFiles = (files: IPublishingGuideFile[]): Map<string, IPublishingGuideFile> => {\n if (!Array.isArray(files) || files.length < 1 || files.length > MAX_FILES)\n invalidGuide('Select between 1 and 64 files.');\n const names = ['start-here.html', 'readme.txt'];\n const selected = new Map<string, IPublishingGuideFile>();\n for (const file of files) {\n if (\n !file ||\n !isText(file.label) ||\n !isText(file.details) ||\n !isPortablePath(file.path) ||\n !['file', 'image', 'video'].includes(file.kind)\n )\n invalidGuide('Every file needs portable output, a known kind and literal labels.');\n if (\n names.some(\n (name) =>\n name === file.path ||\n name.startsWith(`${file.path}/`) ||\n file.path.startsWith(`${name}/`),\n )\n )\n invalidGuide('File paths collide or replace a viewing guide.');\n if (file.kind !== 'file' && (!isDimension(file.width) || !isDimension(file.height)))\n invalidGuide('Images and videos need positive pixel dimensions.');\n selected.set(file.path, file);\n names.push(file.path);\n }\n return selected;\n};\n\n/**\n * Confirms that a channel's ID and every generated anchor remain unique.\n * @param step The channel step.\n * @param ids The generated document IDs.\n * @returns The channel's ID.\n */\nconst registerStep = (step: IPublishingGuideStep, ids: Set<string>): string => {\n const id = step.id ?? step.channel;\n if (typeof id !== 'string' || !/^[a-z][a-z0-9-]*$/u.test(id) || id.length > 64)\n invalidGuide('Channel IDs must be portable lowercase identifiers.');\n const suffixes = ['', '-start', '-copy', '-media', '-review', '-caption', '-caption-status'];\n if (step.documentTitle !== undefined || step.postTitle !== undefined) {\n suffixes.push('-title', '-title-status');\n }\n if (step.documentTitle === undefined) {\n for (let index = 1; index <= step.media.length; index += 1)\n suffixes.push(`-alt-${index}`, `-alt-${index}-status`);\n }\n for (const suffix of suffixes) {\n const anchor = id + suffix;\n if (ids.has(anchor)) invalidGuide('Channel IDs or step anchors collide.');\n ids.add(anchor);\n }\n return id;\n};\n\n/**\n * Validates the relationships the page renders. Selection and publication authority stay upstream.\n * @param guide The publishing presentation.\n * @param copy Literal text by selected file path.\n * @param locale The supplied interface language.\n */\nexport const validateGuide = (\n guide: IPublishingGuide,\n copy: ReadonlyMap<string, string>,\n locale: IPublishingGuideLocale,\n): void => {\n if (\n !guide ||\n !isText(guide.title) ||\n !isText(guide.summary) ||\n (locale !== 'en' && locale !== 'es')\n )\n invalidGuide('A title, summary and supported locale are required.');\n const files = indexFiles(guide.files);\n if (!(copy instanceof Map)) invalidGuide('Supply literal copy as a map of selected files.');\n for (const [path, text] of copy) {\n if (\n typeof path !== 'string' ||\n !files.has(path) ||\n !isText(text) ||\n Buffer.byteLength(text) > MAX_COPY_BYTES\n )\n invalidGuide('Copy must be selected nonblank text of at most 64 KiB per file.');\n }\n\n const { walkthrough } = guide;\n if (walkthrough === undefined) return;\n if (!Array.isArray(walkthrough) || walkthrough.length < 1 || walkthrough.length > MAX_FILES)\n invalidGuide('Supply between 1 and 64 channel steps.');\n\n const ids = new Set<string>();\n const previous = new Map<string, IPublishingGuideStep>();\n for (const step of walkthrough) {\n if (\n !step ||\n !CHANNELS.has(step.channel) ||\n !Array.isArray(step.media) ||\n step.media.length > MAX_FILES ||\n (step.label !== undefined && !isText(step.label))\n )\n invalidGuide('Each step needs a supported channel and an upload list.');\n const id = registerStep(step, ids);\n if (step.repostOf !== undefined) {\n const original = previous.get(step.repostOf);\n if (\n step.channel !== 'instagram' ||\n !original ||\n original.channel !== 'instagram' ||\n original.repostOf !== undefined ||\n original.id !== step.repostOf ||\n step.media.length !== 0 ||\n (step.caption !== undefined && !copy.has(step.caption)) ||\n step.postTitle !== undefined ||\n step.documentTitle !== undefined\n )\n invalidGuide(\n 'Reposts must reference an earlier Instagram original and select no upload media.',\n );\n } else {\n if (\n !copy.has(step.caption) ||\n step.media.length < 1 ||\n new Set(step.media).size !== step.media.length\n )\n invalidGuide('Each original step needs a selected caption and unique upload files.');\n if (\n step.postTitle !== undefined &&\n (step.channel !== 'tiktok' || step.postTitle === step.caption || !copy.has(step.postTitle))\n )\n invalidGuide('A TikTok title must select separate literal copy.');\n if (step.documentTitle !== undefined) {\n if (\n !isText(step.documentTitle) ||\n step.media.length !== 1 ||\n !step.media[0]?.endsWith('.pdf') ||\n files.get(step.media[0])?.kind !== 'file'\n )\n invalidGuide('A document step needs a title and one selected PDF.');\n } else if (!step.media.every((path) => files.get(path)?.kind === 'image')) {\n invalidGuide('An image upload step must refer to selected images.');\n }\n }\n previous.set(id, step);\n }\n};\n"]}
|