@stll/folio-core 0.8.0 → 0.10.0

package/dist/docx/capabilities.js

@@ -1,322 +0,0 @@
-import { TaggedError } from "better-result";
-//#region src/docx/capabilities.ts
-const FOLIO_DOCX_CAPABILITY_MANIFEST_VERSION = 1;
-const FOLIO_DOCX_CAPABILITY_HOSTS = Object.freeze(["browser", "server"]);
-const FOLIO_DOCX_COMPATIBILITY_HOSTS = Object.freeze([...FOLIO_DOCX_CAPABILITY_HOSTS, "unknown"]);
-const FOLIO_DOCX_PROFILES = Object.freeze(["strict", "transitional"]);
-const FOLIO_DOCX_COMPATIBILITY_PROFILES = Object.freeze([...FOLIO_DOCX_PROFILES, "unknown"]);
-const FOLIO_DOCX_CAPABILITY_OPERATIONS = Object.freeze([
-	"create",
-	"edit",
-	"preserve",
-	"read",
-	"render"
-]);
-const FOLIO_DOCX_SUPPORT_STATES = Object.freeze([
-	"supported",
-	"partial",
-	"unsupported"
-]);
-const FOLIO_DOCX_CAPABILITY_IDS = Object.freeze([
-	"comments",
-	"contentControls",
-	"fields",
-	"headersFooters",
-	"hyperlinks",
-	"images",
-	"math",
-	"notes",
-	"numbering",
-	"opaqueDrawing",
-	"paragraphs",
-	"sections",
-	"styles",
-	"tables",
-	"trackedChanges"
-]);
-const TRANSITIONAL_PROFILE_COVERAGE = Object.freeze(["transitional"]);
-const STRUCTURED_FEATURE_SUPPORT = Object.freeze({
-	create: "supported",
-	edit: "supported",
-	preserve: "supported",
-	read: "supported",
-	render: "partial"
-});
-const PARTIAL_AUTHORING_FEATURE_SUPPORT = Object.freeze({
-	create: "partial",
-	edit: "partial",
-	preserve: "supported",
-	read: "supported",
-	render: "partial"
-});
-const COMMENTS_CAPABILITY = Object.freeze({
-	id: "comments",
-	feature: "comments",
-	hosts: FOLIO_DOCX_CAPABILITY_HOSTS,
-	profiles: TRANSITIONAL_PROFILE_COVERAGE,
-	support: STRUCTURED_FEATURE_SUPPORT,
-	evidence: Object.freeze([{
-		type: "test",
-		path: "packages/core/src/docx/commentReplyThreads.test.ts"
-	}, {
-		type: "test",
-		path: "packages/core/src/prosemirror/commands/comments.test.ts"
-	}])
-});
-const CONTENT_CONTROLS_CAPABILITY = Object.freeze({
-	id: "contentControls",
-	feature: "contentControls",
-	hosts: FOLIO_DOCX_CAPABILITY_HOSTS,
-	profiles: TRANSITIONAL_PROFILE_COVERAGE,
-	support: Object.freeze({
-		...PARTIAL_AUTHORING_FEATURE_SUPPORT,
-		edit: "supported"
-	}),
-	evidence: Object.freeze([{
-		type: "test",
-		path: "packages/core/src/content-controls/contentControls.test.ts"
-	}, {
-		type: "test",
-		path: "packages/core/src/docx/sdtRoundtrip.property.test.ts"
-	}])
-});
-const FIELDS_CAPABILITY = Object.freeze({
-	id: "fields",
-	feature: "fields",
-	hosts: FOLIO_DOCX_CAPABILITY_HOSTS,
-	profiles: TRANSITIONAL_PROFILE_COVERAGE,
-	support: PARTIAL_AUTHORING_FEATURE_SUPPORT,
-	evidence: Object.freeze([{
-		type: "test",
-		path: "packages/core/src/fields/evaluateField.test.ts"
-	}, {
-		type: "test",
-		path: "packages/core/src/prosemirror/extensions/nodes/FieldExtension.test.ts"
-	}])
-});
-const HEADERS_FOOTERS_CAPABILITY = Object.freeze({
-	id: "headersFooters",
-	feature: "headersFooters",
-	hosts: FOLIO_DOCX_CAPABILITY_HOSTS,
-	profiles: TRANSITIONAL_PROFILE_COVERAGE,
-	support: STRUCTURED_FEATURE_SUPPORT,
-	evidence: Object.freeze([{
-		type: "test",
-		path: "packages/core/src/docx/headerFooterParser.test.ts"
-	}, {
-		type: "test",
-		path: "packages/core/src/docx/headerFooterMaterialize.test.ts"
-	}])
-});
-const HYPERLINKS_CAPABILITY = Object.freeze({
-	id: "hyperlinks",
-	feature: "hyperlinks",
-	hosts: FOLIO_DOCX_CAPABILITY_HOSTS,
-	profiles: TRANSITIONAL_PROFILE_COVERAGE,
-	support: PARTIAL_AUTHORING_FEATURE_SUPPORT,
-	evidence: Object.freeze([{
-		type: "test",
-		path: "packages/core/src/docx/hyperlinkParser.test.ts"
-	}, {
-		type: "test",
-		path: "packages/core/src/prosemirror/conversion/toProseDoc-hyperlink-content.test.ts"
-	}])
-});
-const IMAGES_CAPABILITY = Object.freeze({
-	id: "images",
-	feature: "images",
-	hosts: FOLIO_DOCX_CAPABILITY_HOSTS,
-	profiles: TRANSITIONAL_PROFILE_COVERAGE,
-	support: Object.freeze({
-		...PARTIAL_AUTHORING_FEATURE_SUPPORT,
-		edit: "supported"
-	}),
-	evidence: Object.freeze([{
-		type: "test",
-		path: "packages/core/src/docx/__tests__/image-crop-roundtrip.test.ts"
-	}, {
-		type: "test",
-		path: "packages/core/src/prosemirror/commands/image.test.ts"
-	}])
-});
-const MATH_CAPABILITY = Object.freeze({
-	id: "math",
-	feature: "math",
-	hosts: FOLIO_DOCX_CAPABILITY_HOSTS,
-	profiles: TRANSITIONAL_PROFILE_COVERAGE,
-	support: PARTIAL_AUTHORING_FEATURE_SUPPORT,
-	evidence: Object.freeze([{
-		type: "test",
-		path: "packages/core/src/docx/mathToMathml.test.ts"
-	}, {
-		type: "test",
-		path: "packages/core/src/docx/serializer/math-roundtrip.test.ts"
-	}])
-});
-const NOTES_CAPABILITY = Object.freeze({
-	id: "notes",
-	feature: "notes",
-	hosts: FOLIO_DOCX_CAPABILITY_HOSTS,
-	profiles: TRANSITIONAL_PROFILE_COVERAGE,
-	support: Object.freeze({
-		create: "partial",
-		edit: "supported",
-		preserve: "supported",
-		read: "supported",
-		render: "partial"
-	}),
-	evidence: Object.freeze([{
-		type: "test",
-		path: "packages/core/src/docx/noteSave.test.ts"
-	}, {
-		type: "test",
-		path: "packages/core/src/layout-bridge/convert/footnoteLayout-collect.test.ts"
-	}])
-});
-const NUMBERING_CAPABILITY = Object.freeze({
-	id: "numbering",
-	feature: "numbering",
-	hosts: FOLIO_DOCX_CAPABILITY_HOSTS,
-	profiles: TRANSITIONAL_PROFILE_COVERAGE,
-	support: Object.freeze({
-		create: "partial",
-		edit: "supported",
-		preserve: "supported",
-		read: "supported",
-		render: "partial"
-	}),
-	evidence: Object.freeze([{
-		type: "test",
-		path: "packages/core/src/docx/numberingParser-custom-format.test.ts"
-	}, {
-		type: "test",
-		path: "packages/core/src/docx/numberingSave.test.ts"
-	}])
-});
-const OPAQUE_DRAWING_CAPABILITY = Object.freeze({
-	id: "opaqueDrawing",
-	feature: "drawings",
-	hosts: FOLIO_DOCX_CAPABILITY_HOSTS,
-	profiles: TRANSITIONAL_PROFILE_COVERAGE,
-	support: Object.freeze({
-		create: "unsupported",
-		edit: "unsupported",
-		preserve: "supported",
-		read: "supported",
-		render: "partial"
-	}),
-	evidence: Object.freeze([{
-		type: "test",
-		path: "packages/core/src/docx/compatibility.test.ts"
-	}, {
-		type: "test",
-		path: "packages/core/src/docx/rezip.test.ts"
-	}])
-});
-const PARAGRAPHS_CAPABILITY = Object.freeze({
-	id: "paragraphs",
-	feature: "paragraphs",
-	hosts: FOLIO_DOCX_CAPABILITY_HOSTS,
-	profiles: TRANSITIONAL_PROFILE_COVERAGE,
-	support: STRUCTURED_FEATURE_SUPPORT,
-	evidence: Object.freeze([{
-		type: "test",
-		path: "packages/core/src/docx/paragraphParser.test.ts"
-	}, {
-		type: "test",
-		path: "packages/core/src/docx/serializer/paragraphSerializer.test.ts"
-	}])
-});
-const SECTIONS_CAPABILITY = Object.freeze({
-	id: "sections",
-	feature: "sections",
-	hosts: FOLIO_DOCX_CAPABILITY_HOSTS,
-	profiles: TRANSITIONAL_PROFILE_COVERAGE,
-	support: STRUCTURED_FEATURE_SUPPORT,
-	evidence: Object.freeze([{
-		type: "test",
-		path: "packages/core/src/docx/serializer/sectionPropertiesSerializer.test.ts"
-	}, {
-		type: "test",
-		path: "packages/core/src/prosemirror/commands/sectionBreak.test.ts"
-	}])
-});
-const STYLES_CAPABILITY = Object.freeze({
-	id: "styles",
-	feature: "styles",
-	hosts: FOLIO_DOCX_CAPABILITY_HOSTS,
-	profiles: TRANSITIONAL_PROFILE_COVERAGE,
-	support: Object.freeze({
-		create: "partial",
-		edit: "partial",
-		preserve: "supported",
-		read: "supported",
-		render: "partial"
-	}),
-	evidence: Object.freeze([{
-		type: "test",
-		path: "packages/core/src/docx/styleParser.test.ts"
-	}, {
-		type: "test",
-		path: "packages/core/src/prosemirror/conversion/characterStyleRoundtrip.test.ts"
-	}])
-});
-const TABLES_CAPABILITY = Object.freeze({
-	id: "tables",
-	feature: "tables",
-	hosts: FOLIO_DOCX_CAPABILITY_HOSTS,
-	profiles: TRANSITIONAL_PROFILE_COVERAGE,
-	support: STRUCTURED_FEATURE_SUPPORT,
-	evidence: Object.freeze([{
-		type: "test",
-		path: "packages/core/src/docx/tableParser.test.ts"
-	}, {
-		type: "test",
-		path: "packages/core/src/prosemirror/conversion/tableBordersRoundtrip.test.ts"
-	}])
-});
-const TRACKED_CHANGES_CAPABILITY = Object.freeze({
-	id: "trackedChanges",
-	feature: "revisions",
-	hosts: FOLIO_DOCX_CAPABILITY_HOSTS,
-	profiles: TRANSITIONAL_PROFILE_COVERAGE,
-	support: STRUCTURED_FEATURE_SUPPORT,
-	evidence: Object.freeze([{
-		type: "test",
-		path: "packages/core/src/redline.test.ts"
-	}, {
-		type: "test",
-		path: "packages/core/src/prosemirror/plugins/suggestionMode.test.ts"
-	}])
-});
-const FOLIO_DOCX_CAPABILITY_MANIFEST = Object.freeze({
-	version: 1,
-	capabilities: Object.freeze({
-		comments: COMMENTS_CAPABILITY,
-		contentControls: CONTENT_CONTROLS_CAPABILITY,
-		fields: FIELDS_CAPABILITY,
-		headersFooters: HEADERS_FOOTERS_CAPABILITY,
-		hyperlinks: HYPERLINKS_CAPABILITY,
-		images: IMAGES_CAPABILITY,
-		math: MATH_CAPABILITY,
-		notes: NOTES_CAPABILITY,
-		numbering: NUMBERING_CAPABILITY,
-		opaqueDrawing: OPAQUE_DRAWING_CAPABILITY,
-		paragraphs: PARAGRAPHS_CAPABILITY,
-		sections: SECTIONS_CAPABILITY,
-		styles: STYLES_CAPABILITY,
-		tables: TABLES_CAPABILITY,
-		trackedChanges: TRACKED_CHANGES_CAPABILITY
-	})
-});
-var InvalidFolioDocxCapabilityIdError = class extends TaggedError("InvalidFolioDocxCapabilityIdError")() {};
-const isFolioDocxCapabilityId = (value) => FOLIO_DOCX_CAPABILITY_IDS.some((id) => id === value);
-const getFolioDocxCapability = (id) => {
-	if (!isFolioDocxCapabilityId(id)) throw new InvalidFolioDocxCapabilityIdError({
-		message: "Invalid DOCX capability id.",
-		receivedId: id
-	});
-	return FOLIO_DOCX_CAPABILITY_MANIFEST.capabilities[id];
-};
-//#endregion
-export { FOLIO_DOCX_CAPABILITY_HOSTS, FOLIO_DOCX_CAPABILITY_IDS, FOLIO_DOCX_CAPABILITY_MANIFEST, FOLIO_DOCX_CAPABILITY_MANIFEST_VERSION, FOLIO_DOCX_CAPABILITY_OPERATIONS, FOLIO_DOCX_COMPATIBILITY_HOSTS, FOLIO_DOCX_COMPATIBILITY_PROFILES, FOLIO_DOCX_PROFILES, FOLIO_DOCX_SUPPORT_STATES, InvalidFolioDocxCapabilityIdError, getFolioDocxCapability, isFolioDocxCapabilityId };