From c857eac69e35e770c248d2437c1e5e7aa4f458f1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micka=C3=ABl=20Menu?= Date: Tue, 14 May 2024 16:08:49 +0200 Subject: [PATCH] Rename `archive` Link property --- CHANGELOG.md | 4 ++++ .../readium/r2/shared/util/archive/ArchiveProperties.kt | 2 +- .../org/readium/r2/shared/util/resource/PropertiesTest.kt | 8 ++++---- 3 files changed, 9 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 80c6c2313f..c3fa0b7a97 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -16,6 +16,10 @@ All notable changes to this project will be documented in this file. Take a look * All the APIs using or returning a `Date` objects are now using a custom `Instant` type. +#### Shared + +* The `Link` property key for archive-based publication assets (e.g. an EPUB/ZIP) is now `https://readium.org/webpub-manifest/properties#archive` instead of `archive`. + #### LCP * [#493](https://github.com/readium/kotlin-toolkit/discussions/493) The LCP module does not require the Bluetooth permissions anymore to derive the device name. diff --git a/readium/shared/src/main/java/org/readium/r2/shared/util/archive/ArchiveProperties.kt b/readium/shared/src/main/java/org/readium/r2/shared/util/archive/ArchiveProperties.kt index a1920221bf..c45fb03b31 100644 --- a/readium/shared/src/main/java/org/readium/r2/shared/util/archive/ArchiveProperties.kt +++ b/readium/shared/src/main/java/org/readium/r2/shared/util/archive/ArchiveProperties.kt @@ -48,7 +48,7 @@ public data class ArchiveProperties( } } -private const val ARCHIVE_KEY = "archive" +private const val ARCHIVE_KEY = "https://readium.org/webpub-manifest/properties#archive" public val Resource.Properties.archive: ArchiveProperties? get() = (this[ARCHIVE_KEY] as? Map<*, *>) diff --git a/readium/shared/src/test/java/org/readium/r2/shared/util/resource/PropertiesTest.kt b/readium/shared/src/test/java/org/readium/r2/shared/util/resource/PropertiesTest.kt index befffd96b7..50bd66f2e8 100644 --- a/readium/shared/src/test/java/org/readium/r2/shared/util/resource/PropertiesTest.kt +++ b/readium/shared/src/test/java/org/readium/r2/shared/util/resource/PropertiesTest.kt @@ -24,7 +24,7 @@ class PropertiesTest { ArchiveProperties(entryLength = 8273, isEntryCompressed = true), Resource.Properties( mapOf( - "archive" to mapOf( + "https://readium.org/webpub-manifest/properties#archive" to mapOf( "entryLength" to 8273, "isEntryCompressed" to true ) @@ -38,7 +38,7 @@ class PropertiesTest { assertNull( Resource.Properties( mapOf( - "archive" to mapOf( + "https://readium.org/webpub-manifest/properties#archive" to mapOf( "foo" to "bar" ) ) @@ -51,7 +51,7 @@ class PropertiesTest { assertNull( Resource.Properties( mapOf( - "archive" to mapOf( + "https://readium.org/webpub-manifest/properties#archive" to mapOf( "isEntryCompressed" to true ) ) @@ -61,7 +61,7 @@ class PropertiesTest { assertNull( Resource.Properties( mapOf( - "archive" to mapOf( + "https://readium.org/webpub-manifest/properties#archive" to mapOf( "entryLength" to 8273 ) )