Repository navigation
Standardize bundle assets and refresh shipped implementations - #15
skylartaylor wants to merge 2 commits into
Conversation
|
@SiteRelEnby @pluralspaceapp I refreshed and consolidated the OpenPlural bundle proposal using the current Sheaf implementation, the available PluralSpace export, and the shipped PluralSpace import UI. GitHub does not allow formal review requests for non-collaborators, so I am tagging you here instead. The PR body has focused implementation questions for each of you; Sheaf PR #12 is incorporated with its maintainer-authored wording preserved where possible. (edited to correct an earlier ping to the wrong account - sorry about that.) |
|
I think it's worth going ahead with |
SiteRelEnby
left a comment
There was a problem hiding this comment.
#17 has some changes worth merging, lmk if you want to do the honors or us, you got your PR in first so your call and I think we each caught some stuff the other missed.
|
as for |
This updates the v0.1 ZIP proposal based on what Sheaf and PluralSpace now ship. It also incorporates the corrections from #12 and keeps SiteRelEnby's wording where it still matches the current source.
This PR proposes:
.pluralport.zip. Existing.openplural.zipfiles will continue to work, and importers may also accept.openplural.openplural.json, the version is stillopenplural_version: "0.1", and the optional marker file is stillopenplural-version-0.1.assets/, andAsset.bundle_pathpoints to each file. For compatibility, importers should also understand Sheaf's currentextensions.sheaf.bundle_path. Older exports may point to files undermedia/; importers can follow those paths, but should not automatically import everything in that folder.openplural.jsonfor the export data. A ZIP may also include a README or an app-specific manifest, but v0.1 does not define a shared manifest format or a way to encrypt the ZIP.There are two smaller clarifications as well.
capabilities.modulescan help an importer preview a file, but it should not cause data that is actually present to be ignored. If a relationship refers to a missing relationship type, the importer should keep the relationship and report the problem instead of inventing a type.I checked the current Sheaf and Ampersand source, the current PluralPort converters, the PluralSpace export from 2026-07-05, and PluralSpace's public import screen on 2026-08-12. PluralSpace's server-side import mapping and full round-trip behavior are still unverified, and the docs say so.
Source versions checked: Sheaf
96c17ef1e36b6be70f8f683ebde78cf06ced75fc, Ampersand38101d87e500dd21905f4deb2496f1b1b0ca9a48, and PluralPort7df6357b7f4ee027e50431cf67540ff5715f4a41.This only changes the preferred filename; it does not change the v0.1 data inside the ZIP. The rest of the OpenPlural to PluralPort rename will stay in a separate PR so this change is easier to review.
@SiteRelEnby, Sheaf appears to recognize ZIP files by their contents rather than their names, and its file picker accepts
.zip. Could you check whether any other Sheaf client or deployment would have trouble with.pluralport.zip, and whether theAsset.bundle_pathand relationship wording match the current implementation?@pluralspaceapp, could you confirm that PluralSpace will accept a ZIP named
.pluralport.zip, and that the description of its current import/export behavior is fair? (I originally tagged the wrong account here; sorry about that.)If this covers everything from #12, we can close #12 in favor of this PR.
Closes #9.