Skip to content

Allow single IPTC keyword in metadata #778

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
liam-lloyd merged 1 commit into from
Jun 16, 2026
Merged

Allow single IPTC keyword in metadata #778

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions packages/metadata_attacher/src/fixtures/single_keyword_mets.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<?xml version="1.0" encoding="UTF-8"?>
<mets:mets xmlns:mets="http://www.loc.gov/METS/" xmlns:premis="info:lc/xmlns/premis-v2" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
<mets:amdSec>
<mets:techMD>
<mets:mdWrap>
<mets:xmlData>
<premis:object>
<premis:originalName>objects/710a1def-caf8-48f2-8eee-0848b4cfda10</premis:originalName>
<premis:objectCharacteristics>
<premis:objectCharacteristicsExtension>
<rdf:RDF>
<rdf:Description xmlns:File="http://ns.exiftool.org/File/1.0/">
<ExifTool:ExifToolVersion>12.40</ExifTool:ExifToolVersion>
<File:MIMEType>image/jpeg</File:MIMEType>
<IPTC:Keywords>nature</IPTC:Keywords>
</rdf:Description>
</rdf:RDF>
</premis:objectCharacteristicsExtension>
</premis:objectCharacteristics>
</premis:object>
</mets:xmlData>
</mets:mdWrap>
</mets:techMD>
</mets:amdSec>
</mets:mets>
51 changes: 51 additions & 0 deletions packages/metadata_attacher/src/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -675,6 +675,57 @@ describe("handler", () => {
);
});

test("should extract a single IPTC keyword provided as a string", async () => {
const metsContent = await loadMetsFile("single_keyword_mets.xml");
mockS3Send.mockResolvedValue({
Body: {
transformToString: jest.fn().mockResolvedValue(metsContent),
},
});

const event = {
Records: [
{
messageId: "1",
receiptHandle: "1",
body: JSON.stringify({
Message: JSON.stringify({
Records: [
{
s3: {
bucket: {
name: "test-bucket",
},
object: {
key: "access_copies/53f9/8c3d/a29e/4fbf/8a4a/4fd9/991e/313d/1_upload-4a64ba7c-ceac-4547-ac13-c487b2711d5a/METS.4a64ba7c-ceac-4547-ac13-c487b2711d5a.xml",
},
},
},
],
}),
}),
attributes: {
ApproximateReceiveCount: "1",
SentTimestamp: "1",
SenderId: "1",
ApproximateFirstReceiveTimestamp: "1",
},
messageAttributes: {},
md5OfBody: "1",
eventSource: "1",
eventSourceARN: "1",
awsRegion: "1",
},
],
};

await handler(event, mock<Context>(), jest.fn());

const recordMetadata = await getRecordMetadata("1");
expect(recordMetadata).toBeDefined();
expect(recordMetadata?.tags).toEqual(["nature"]);
});

test("should handle database error gracefully", async () => {
const metsContent = await loadMetsFile("sample_mets.xml");
mockS3Send.mockResolvedValue({
Expand Down
7 changes: 5 additions & 2 deletions packages/metadata_attacher/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,10 +127,13 @@ const getPhotoMetadata = (
rdfMetadata["ExifIFD:DateTimeOriginal"],
rdfMetadata["ExifIFD:OffsetTimeOriginal"],
);
const { "IPTC:Keywords": iptcKeywords } = rdfMetadata;
const tags =
rdfMetadata["IPTC:Keywords"] === undefined
iptcKeywords === undefined
? undefined
: rdfMetadata["IPTC:Keywords"]["rdf:Bag"]["rdf:li"];
: typeof iptcKeywords === "string"
? [iptcKeywords]
: iptcKeywords["rdf:Bag"]["rdf:li"];

return {
creationTime:
Expand Down
1 change: 1 addition & 0 deletions packages/metadata_attacher/src/models.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ export interface RdfMetadata {
"IPTC:ObjectName": string | undefined;
"IPTC:Caption-Abstract": string | undefined;
"IPTC:Keywords":
| string
| {
"rdf:Bag": {
"rdf:li": string[];
Expand Down
15 changes: 10 additions & 5 deletions packages/metadata_attacher/src/validators.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,16 @@ const rdfMetadataSchema = Joi.object({
"File:MIMEType": Joi.string().required(),
"IPTC:ObjectName": Joi.string().optional().empty(""),
"IPTC:Caption-Abstract": Joi.string().optional().empty(""),
"IPTC:Keywords": Joi.object({
"rdf:Bag": Joi.object({
"rdf:li": Joi.array().items(Joi.string()).required(),
}).required(),
}).optional(),
"IPTC:Keywords": Joi.alternatives()
.try(
Joi.string(),
Joi.object({
"rdf:Bag": Joi.object({
"rdf:li": Joi.array().items(Joi.string()).required(),
}).required(),
}),
)
.optional(),
"ExifIFD:Title": Joi.string().optional().empty(""),
"ExifIFD:UserComment": Joi.string().optional().empty(""),
"ExifIFD:Comments": Joi.string().optional().empty(""),
Expand Down
Loading