ddex-json-codec 0.3.1 → 0.4.2

package/dist/index.d.mts

@@ -350,7 +350,7 @@ declare function xmlToJson(xml: string): DdexMessage;
 /**
  * DdexMessageをXML文字列に変換する
  */
-declare function jsonToXml(message: DdexMessage, version?: ErnVersion): string;
+declare function jsonToXml(message: DdexMessage): string;
 //#endregion
 //#region src/version/detect.d.ts
 /**
@@ -364,4 +364,28 @@ declare function jsonToXml(message: DdexMessage, version?: ErnVersion): string;
  */
 declare function detectVersion(xml: string): ErnVersion;
 //#endregion
-export { type Artist, type ArtistRole, type CLine, type Contributor, type DdexMessage, type DdexMessage38, type DdexMessage4, type DdexMessageBase, type Deal, type DealTerms, type DisplayArtist, type DisplayTitle, type ErnMajorVersion, type ErnVersion, type ErnVersion38, type ErnVersion4, type FileDetails, type Genre, type HashSum, type Image, type Image38, type Image4, type ImageBase, type ImageDetailsByTerritory, type ImageId, type IndirectResourceContributor, type MessageHeader, type MessageParty, type PLine, type Party, type PartyName, type Release, type Release38, type Release4, type ReleaseBase, type ReleaseDeal, type ReleaseDetailsByTerritory, type ReleaseId, type ReleaseResourceReference, type ResourceContributor, type ResourceGroup, type SoundRecording, type SoundRecording38, type SoundRecording4, type SoundRecordingBase, type SoundRecordingDetailsByTerritory, type TechnicalImageDetails, type TechnicalSoundRecordingDetails, type TextWithAttribute, type Title, type TrackRelease, type Usage, detectVersion, jsonToXml, xmlToJson };
+//#region src/converter/version/index.d.ts
+interface ConversionWarning {
+  type: 'field_dropped' | 'structure_changed';
+  path: string;
+  message: string;
+}
+interface ConversionResult {
+  result: DdexMessage;
+  warnings: ConversionWarning[];
+}
+/**
+ * DdexMessage をターゲットメジャーバージョンに変換する
+ * パッチバージョンは各メジャーの最新が使われる (3.8.3 / 4.3.2)
+ */
+declare function convertDdexMessage(message: DdexMessage, target: ErnMajorVersion): ConversionResult;
+//#endregion
+//#region src/index.d.ts
+/**
+ * DDEX XML文字列をターゲットメジャーバージョンに変換する
+ */
+declare function convertDdexVersion(xml: string, target: ErnMajorVersion): ConversionResult & {
+  xml: string;
+};
+//#endregion
+export { type Artist, type ArtistRole, type CLine, type Contributor, type ConversionResult, type ConversionWarning, type DdexMessage, type DdexMessage38, type DdexMessage4, type DdexMessageBase, type Deal, type DealTerms, type DisplayArtist, type DisplayTitle, type ErnMajorVersion, type ErnVersion, type ErnVersion38, type ErnVersion4, type FileDetails, type Genre, type HashSum, type Image, type Image38, type Image4, type ImageBase, type ImageDetailsByTerritory, type ImageId, type IndirectResourceContributor, type MessageHeader, type MessageParty, type PLine, type Party, type PartyName, type Release, type Release38, type Release4, type ReleaseBase, type ReleaseDeal, type ReleaseDetailsByTerritory, type ReleaseId, type ReleaseResourceReference, type ResourceContributor, type ResourceGroup, type SoundRecording, type SoundRecording38, type SoundRecording4, type SoundRecordingBase, type SoundRecordingDetailsByTerritory, type TechnicalImageDetails, type TechnicalSoundRecordingDetails, type TextWithAttribute, type Title, type TrackRelease, type Usage, convertDdexMessage, convertDdexVersion, xmlToJson as ddexToJson, detectVersion as detectDdexVersion, jsonToXml as jsonToDdex };

package/dist/index.mjs

@@ -1518,9 +1518,349 @@ function xmlToJson(xml) {
 /**
 * DdexMessageをXML文字列に変換する
 */
-function jsonToXml(message, version) {
-	const targetVersion = version ?? message.ernVersion;
-	return ConverterFactory.createJsonToXmlBuilder(targetVersion).build(message, targetVersion);
+function jsonToXml(message) {
+	return ConverterFactory.createJsonToXmlBuilder(message.ernVersion).build(message, message.ernVersion);
 }
 //#endregion
-export { detectVersion, jsonToXml, xmlToJson };
+//#region src/converter/version/index.ts
+const LATEST_PATCH = {
+	"3.8": "3.8.3",
+	"4": "4.3.2"
+};
+/**
+* DdexMessage をターゲットメジャーバージョンに変換する
+* パッチバージョンは各メジャーの最新が使われる (3.8.3 / 4.3.2)
+*/
+function convertDdexMessage(message, target) {
+	if (getMajorVersion(message.ernVersion) === target) return {
+		result: message,
+		warnings: []
+	};
+	if (target === "4") return convert38To4(message, LATEST_PATCH["4"]);
+	return convert4To38(message, LATEST_PATCH["3.8"]);
+}
+function convert38To4(msg, target) {
+	const warnings = [];
+	const partyMap = /* @__PURE__ */ new Map();
+	const resourceList = msg.resourceList.map((sr, i) => convertSoundRecording38To4(sr, i, partyMap, warnings));
+	const imageList = msg.imageList?.map((img) => ({
+		resourceReference: img.resourceReference,
+		type: img.type,
+		imageId: img.imageId,
+		parentalWarningType: img.detailsByTerritory?.[0]?.parentalWarningType,
+		technicalDetails: img.detailsByTerritory?.[0]?.technicalDetails
+	}));
+	const releaseList = msg.releaseList.map((r, i) => convertRelease38To4(r, i, partyMap, warnings));
+	const dealList = convertDealList38To4(msg.dealList, warnings);
+	const partyList = Array.from(partyMap.values());
+	return {
+		result: {
+			ernVersion: target,
+			messageHeader: msg.messageHeader,
+			updateIndicator: msg.updateIndicator,
+			resourceList,
+			imageList,
+			releaseList,
+			dealList,
+			partyList: partyList.length > 0 ? partyList : void 0
+		},
+		warnings
+	};
+}
+function convertSoundRecording38To4(sr, index, partyMap, warnings) {
+	const dbt = sr.detailsByTerritory?.[0];
+	if (sr.detailsByTerritory && sr.detailsByTerritory.length > 1) warnings.push({
+		type: "structure_changed",
+		path: `resourceList[${index}].detailsByTerritory`,
+		message: `${sr.detailsByTerritory.length} territories collapsed to first territory`
+	});
+	const displayArtists = (dbt?.displayArtists ?? sr.displayArtists).map((da) => ensurePartyReference(da, partyMap));
+	const contributors = convertResourceContributorsToContributors(dbt?.resourceContributors, partyMap);
+	if (dbt?.indirectResourceContributors?.length) warnings.push({
+		type: "field_dropped",
+		path: `resourceList[${index}].detailsByTerritory[0].indirectResourceContributors`,
+		message: "IndirectResourceContributors dropped (no equivalent in ERN 4)"
+	});
+	return {
+		resourceReference: sr.resourceReference,
+		type: sr.type,
+		soundRecordingId: sr.soundRecordingId,
+		displayArtists,
+		duration: sr.duration,
+		creationDate: sr.creationDate,
+		languageOfPerformance: sr.languageOfPerformance,
+		pLine: dbt?.pLine ?? sr.pLine,
+		displayTitleText: sr.referenceTitle?.titleText,
+		displayTitles: convertTitlesToDisplayTitles(dbt?.titles, dbt?.territoryCode?.[0]),
+		contributors: contributors.length > 0 ? contributors : void 0
+	};
+}
+function convertRelease38To4(r, index, partyMap, warnings) {
+	const dbt = r.detailsByTerritory?.[0];
+	if (r.detailsByTerritory && r.detailsByTerritory.length > 1) warnings.push({
+		type: "structure_changed",
+		path: `releaseList[${index}].detailsByTerritory`,
+		message: `${r.detailsByTerritory.length} territories collapsed to first territory`
+	});
+	const displayArtists = (dbt?.displayArtists ?? r.displayArtists).map((da) => ensurePartyReference(da, partyMap));
+	const releaseLabelReferences = dbt?.labelName ? [ensureLabelPartyReference(dbt.labelName, partyMap)] : void 0;
+	return {
+		releaseReference: r.releaseReference,
+		releaseType: r.releaseType,
+		releaseId: r.releaseId,
+		displayArtists,
+		releaseResourceReferences: r.releaseResourceReferences,
+		duration: r.duration,
+		pLine: r.pLine,
+		cLine: r.cLine,
+		displayTitleText: r.referenceTitle?.titleText,
+		displayTitles: convertTitlesToDisplayTitles(dbt?.titles, dbt?.territoryCode?.[0]),
+		releaseLabelReferences,
+		genre: dbt?.genre,
+		parentalWarningType: dbt?.parentalWarningType,
+		resourceGroup: dbt?.resourceGroup ?? r.resourceGroup
+	};
+}
+function convertDealList38To4(dealList, warnings) {
+	return dealList.map((rd, i) => ({
+		...rd,
+		deals: rd.deals.filter((d, j) => {
+			if (d.dealTerms.takeDown) {
+				warnings.push({
+					type: "structure_changed",
+					path: `dealList[${i}].deals[${j}]`,
+					message: "Deal with takeDown=true removed (ERN 4 uses deal absence for takedown)"
+				});
+				return false;
+			}
+			return true;
+		}).map((d) => ({
+			...d,
+			dealTerms: convertDealTerms38To4(d.dealTerms)
+		}))
+	}));
+}
+function convertDealTerms38To4(dt) {
+	return {
+		commercialModelType: dt.commercialModelType,
+		useTypes: dt.usage?.useTypes,
+		territoryCode: dt.territoryCode,
+		validityPeriod: dt.validityPeriod,
+		priceInformation: dt.priceInformation
+	};
+}
+function convert4To38(msg, target) {
+	const warnings = [];
+	const partyIndex = /* @__PURE__ */ new Map();
+	if (msg.partyList) for (const p of msg.partyList) partyIndex.set(p.partyReference, p);
+	const resourceList = msg.resourceList.map((sr, i) => convertSoundRecording4To38(sr, i, partyIndex, warnings));
+	const imageList = msg.imageList?.map((img) => ({
+		resourceReference: img.resourceReference,
+		type: img.type,
+		imageId: img.imageId,
+		detailsByTerritory: [{
+			territoryCode: ["Worldwide"],
+			parentalWarningType: img.parentalWarningType,
+			technicalDetails: img.technicalDetails
+		}]
+	}));
+	const releaseList = msg.releaseList.map((r, i) => convertRelease4To38(r, i, partyIndex, warnings));
+	if (msg.trackReleaseList?.length) warnings.push({
+		type: "field_dropped",
+		path: "trackReleaseList",
+		message: `${msg.trackReleaseList.length} TrackRelease(s) dropped (not available in ERN 3.8)`
+	});
+	if (msg.partyList?.some((p) => p.partyId?.length)) warnings.push({
+		type: "field_dropped",
+		path: "partyList[].partyId",
+		message: "PartyId (ISNI, IPN etc.) dropped (no storage in ERN 3.8 inline PartyName)"
+	});
+	const dealList = msg.dealList.map((rd) => ({
+		...rd,
+		deals: rd.deals.map((d) => ({
+			...d,
+			dealTerms: convertDealTerms4To38(d.dealTerms)
+		}))
+	}));
+	return {
+		result: {
+			ernVersion: target,
+			messageHeader: msg.messageHeader,
+			updateIndicator: msg.updateIndicator,
+			resourceList,
+			imageList,
+			releaseList,
+			dealList
+		},
+		warnings
+	};
+}
+function convertSoundRecording4To38(sr, _index, partyIndex, _warnings) {
+	const displayArtists = sr.displayArtists.map((da) => resolveInlineArtist(da, partyIndex));
+	const referenceTitle = sr.displayTitleText ? { titleText: sr.displayTitleText } : sr.displayTitles?.[0] ? {
+		titleText: sr.displayTitles[0].titleText,
+		subTitle: sr.displayTitles[0].subTitle
+	} : void 0;
+	const titles = convertDisplayTitlesToTitles(sr.displayTitles);
+	const resourceContributors = sr.contributors?.map((c) => resolveContributorToResourceContributor(c, partyIndex));
+	const dbt = {
+		territoryCode: ["Worldwide"],
+		displayArtists,
+		titles,
+		pLine: sr.pLine
+	};
+	if (resourceContributors?.length) dbt.resourceContributors = resourceContributors;
+	return {
+		resourceReference: sr.resourceReference,
+		type: sr.type,
+		soundRecordingId: sr.soundRecordingId,
+		displayArtists,
+		duration: sr.duration,
+		creationDate: sr.creationDate,
+		languageOfPerformance: sr.languageOfPerformance,
+		pLine: sr.pLine,
+		referenceTitle,
+		detailsByTerritory: [dbt]
+	};
+}
+function convertRelease4To38(r, _index, partyIndex, _warnings) {
+	const displayArtists = r.displayArtists.map((da) => resolveInlineArtist(da, partyIndex));
+	const referenceTitle = r.displayTitleText ? { titleText: r.displayTitleText } : r.displayTitles?.[0] ? {
+		titleText: r.displayTitles[0].titleText,
+		subTitle: r.displayTitles[0].subTitle
+	} : void 0;
+	const titles = convertDisplayTitlesToTitles(r.displayTitles);
+	let labelName;
+	if (r.releaseLabelReferences?.[0]) labelName = partyIndex.get(r.releaseLabelReferences[0])?.partyName?.[0]?.fullName ?? r.releaseLabelReferences[0];
+	const dbt = {
+		territoryCode: ["Worldwide"],
+		displayArtists,
+		titles,
+		labelName,
+		genre: r.genre,
+		parentalWarningType: r.parentalWarningType,
+		resourceGroup: r.resourceGroup
+	};
+	return {
+		releaseReference: r.releaseReference,
+		releaseType: r.releaseType,
+		releaseId: r.releaseId,
+		displayArtists,
+		releaseResourceReferences: r.releaseResourceReferences,
+		duration: r.duration,
+		pLine: r.pLine,
+		cLine: r.cLine,
+		referenceTitle,
+		detailsByTerritory: [dbt],
+		resourceGroup: r.resourceGroup
+	};
+}
+function convertDealTerms4To38(dt) {
+	return {
+		commercialModelType: dt.commercialModelType,
+		usage: dt.useTypes ? { useTypes: dt.useTypes } : void 0,
+		territoryCode: dt.territoryCode,
+		validityPeriod: dt.validityPeriod,
+		priceInformation: dt.priceInformation
+	};
+}
+function convertResourceContributorsToContributors(contributors, partyMap) {
+	if (!contributors?.length) return [];
+	return contributors.map((c) => {
+		const ref = generatePartyReference(c.name);
+		if (!partyMap.has(ref)) partyMap.set(ref, {
+			partyReference: ref,
+			partyName: [{ fullName: c.name }]
+		});
+		return {
+			contributorPartyReference: ref,
+			name: c.name,
+			role: c.role,
+			sequenceNumber: c.sequenceNumber
+		};
+	});
+}
+function generatePartyReference(name) {
+	return `P${name.replace(/[^a-zA-Z0-9]/g, "") || "Unknown"}`;
+}
+function ensurePartyReference(da, partyMap) {
+	if (da.artist.partyReference) return da;
+	const ref = generatePartyReference(da.artist.name);
+	if (!partyMap.has(ref)) {
+		const partyNames = da.artist.names?.length ? da.artist.names : [{ fullName: da.artist.name }];
+		partyMap.set(ref, {
+			partyReference: ref,
+			partyName: partyNames
+		});
+	}
+	return {
+		...da,
+		artist: {
+			...da.artist,
+			partyReference: ref
+		}
+	};
+}
+function ensureLabelPartyReference(labelName, partyMap) {
+	const ref = generatePartyReference(labelName);
+	if (!partyMap.has(ref)) partyMap.set(ref, {
+		partyReference: ref,
+		partyName: [{ fullName: labelName }]
+	});
+	return ref;
+}
+function resolveInlineArtist(da, partyIndex) {
+	if (!da.artist.partyReference) return da;
+	const party = partyIndex.get(da.artist.partyReference);
+	const name = party?.partyName?.[0]?.fullName ?? da.artist.name;
+	const names = party?.partyName && party.partyName.length > 1 ? party.partyName : da.artist.names;
+	return {
+		...da,
+		artist: {
+			name,
+			names,
+			roles: da.artist.roles
+		}
+	};
+}
+function resolveContributorToResourceContributor(c, partyIndex) {
+	return {
+		name: partyIndex.get(c.contributorPartyReference)?.partyName?.[0]?.fullName ?? c.name ?? c.contributorPartyReference,
+		role: c.role,
+		sequenceNumber: c.sequenceNumber
+	};
+}
+function convertTitlesToDisplayTitles(titles, territoryCode) {
+	if (!titles?.length) return void 0;
+	return titles.map((t, i) => ({
+		titleText: t.titleText,
+		subTitle: t.subTitle,
+		applicableTerritoryCode: territoryCode ?? "Worldwide",
+		languageAndScriptCode: t.languageAndScriptCode,
+		isDefault: i === 0 ? true : void 0
+	}));
+}
+function convertDisplayTitlesToTitles(displayTitles) {
+	if (!displayTitles?.length) return void 0;
+	return displayTitles.map((dt) => ({
+		titleText: dt.titleText,
+		subTitle: dt.subTitle,
+		titleType: "DisplayTitle",
+		languageAndScriptCode: dt.languageAndScriptCode
+	}));
+}
+//#endregion
+//#region src/index.ts
+/**
+* DDEX XML文字列をターゲットメジャーバージョンに変換する
+*/
+function convertDdexVersion(xml, target) {
+	const { result, warnings } = convertDdexMessage(xmlToJson(xml), target);
+	return {
+		result,
+		xml: jsonToXml(result),
+		warnings
+	};
+}
+//#endregion
+export { convertDdexMessage, convertDdexVersion, xmlToJson as ddexToJson, detectVersion as detectDdexVersion, jsonToXml as jsonToDdex };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "ddex-json-codec",
   "type": "module",
-  "version": "0.3.1",
+  "version": "0.4.2",
   "description": "DDEX ERN XML ↔ JSON converter for TypeScript",
   "license": "MIT",
   "author": "kazhs",
@@ -31,6 +31,13 @@
   "files": [
     "dist"
   ],
+  "scripts": {
+    "build": "vp pack",
+    "dev": "vp pack --watch",
+    "test": "vp test",
+    "check": "vp check",
+    "prepublishOnly": "pnpm run build"
+  },
   "dependencies": {
     "fast-xml-parser": "^5.3.0"
   },
@@ -42,13 +49,14 @@
     "vitest": "npm:@voidzero-dev/vite-plus-test@latest",
     "vite-plus": "latest"
   },
+  "pnpm": {
+    "overrides": {
+      "vite": "npm:@voidzero-dev/vite-plus-core@latest",
+      "vitest": "npm:@voidzero-dev/vite-plus-test@latest"
+    }
+  },
+  "packageManager": "pnpm@10.32.1",
   "engines": {
     "node": ">=20"
-  },
-  "scripts": {
-    "build": "vp pack",
-    "dev": "vp pack --watch",
-    "test": "vp test",
-    "check": "vp check"
   }
-}
+}