Apostrophe 3 Beta 2

[agilbert]

Release of Beta 2

Hey everyone, our latest release was published late last week.

The team is excited to be in a phase of tightening bolts and getting A3 ready for a stable release in June. You'll see below that we've been focusing on QA and polish of the overall editorial flow now that we have draft/live toggle and a full permissions system in place in the core.

Read on for the detailed release notes.

Apostrophe 3.0.0-beta.2

Breaks

• The updateModified: false option, formerly supported only by apos.doc.update, has been renamed to setModified: false and is now supported by apos.doc.insert as well. If explicitly set to false, the insert and update methods will leave the modified property alone, rather than trying to detect or infer whether a change has been made to the draft relative to the published version.
• The permission module no longer takes an interestingTypes option. Instead, doc type managers may set their showPermissions option to true to always be broken out separately in the permissions explorer, or explicitly set it to false to never be mentioned at all, even on a list of typical piece types that have the same permissions. This allows module creators to ship the right options with their modules rather than requiring the developer to hand-configure interestingTypes.
• When editing users, the permissions explorer no longer lists "submitted draft" as a piece type.
• Removed apos.adminBar.group method, which is unlikely to be needed in 3.x. One can group admin bar items into dropdowns via the groups option.
• Raw HTML is no longer permitted in an apos.notify message parameter. Instead, options.buttons is available. If present, it must be an array of objects with type and label properties. If type is 'event' then that button object must have name and data properties, and when clicked the button will trigger an apos bus event of the given name with the provided data object. Currently 'event' is the only supported value for type.

Adds

• The name @apostrophecms/any-page-type is now accepted for relationships that should match any page. With this change, the doc type manager module name and the type name are now identical for all types in 3.x. However, for backwards compatibility @apostrophecms/page is still accepted. apos.doc.getManager will accept either name.
• Sets the project root-level views directory as the default fallback views directory. This is no longer a necessary configuration in projects unless they want to change it on the @apostrophecms/template option viewsFolderFallback.
• The new afterAposScripts nunjucks block allows for pushing markup after Apostrophe's asset bundle script tag, at the end of the body. This is a useful way to add a script tag for Webpack's hot reload capabilities in development while still ensuring that Apostrophe's utility methods are available first, like they are in production.
• An uploadfs option may be passed to the @apostrophecms/asset module, in order to pass options configuring a separate instance of uploadfs specifically for the static assets. The @apostrophecms/uploadfs module now exports a method to instantiate an uploadfs instance. The default behavior, in which user-uploaded attachments and static assets share a single instance of uploadfs, is unchanged. Note that asset builds never use uploadfs unless APOS_UPLOADFS_ASSETS=1 is set in the environment.
• AposButtonSplit is a new UI component that combines a button with a context menu. Users can act on a primary action or change the button's function via menu button to the right of the button itself.
• Developers can now pass options to the color schema field by passing a pickerOptions object through your field. This allows for modifying/removing the default color palette, changing the resulting color format, and disabling various UI. For full set of options see this example.
• AposModal now emits a ready event when it is fully painted and can be interacted with by users or code.
• The video widget is now compatible with Vimeo private videos when the domain is on the allowlist in Vimeo.

Fixes

• Piece types like users that have a slug prefix no longer trigger a false positive as being "modified" when you first click the "New" button.
• The name option to widget modules, which never worked in 3.x, has been officially removed. The name of the widget type is always the name of the module, with the widget suffix removed.
• The home page and other parked pages should not immediately show as "pending changes."
• In-context editing works properly when the current browser URL has a hash (portion beginning with #), enabling the use of the hash for project-specific work. Thanks to Štěpán Jákl for reporting the issue.
• When present, the apos.http.addQueryToUrl method preserves the hash of the URL intact.
• The home page and other parked pages should not immediately show as "pending changes."
• The browser-side apos.http.parseQuery function now handles objects and arrays properly again.
• The in-context menu for documents has been refactored as a smart component that carries out actions on its own, eliminating a great deal of redundant code, props and events.
• Added additional retries when binding to the port in a dev environment.
• The "Submit" button in the admin bar updates properly to "Submitted" if the submission happens in the page settings modal.
• Skipping positional arguments in fragments now works as expected.
• The rich text editor now supports specifying a styles array with no p tags properly. A newly added rich text widget initially contains an element with the first style, rather than always a paragraph. If no styles are configured, a p tag is assumed. Thanks to Stepan Jakl for reporting the issue.

Changes

• Editor modal's Save button (publish / save draft / submit) now updated to use the AposSplitButton component. Editors can choose from several follow-up actions that occur after save, including creating another piece of content of the same type, being taken to the in-context version of the document, or being returned to the manager. Editor's selection is saved in localstorage, creating a remembered preference per content type.

Apostrophe 2.119

apostrophe (core) 2.119.0

• When enableAltField option is set to true, we now copy the alt field from apostrophe-images schema to the attachment piece when using apos.attachments.all (and methods that use it).
• Passes referring URLs to video services such as Vimeo, allowing the embedding of private videos if the domain is on the allowlist in vimeo.
• By default Apostrophe grants the edit privilege on all piece types if a user has the admin privilege for any piece type. Passing the typeAdminsCanEditAllTypes: false option to the apostrophe-permissions module now disables this surprising behavior. Thanks to zindarato for this contribution.

apostrophe-seo 1.5.0

• Adds possibility to set headers in config, if requesting the page needs authentication.

apostrophe-headless 2.12.0

• Adds ability to pass cors config to the module.

apostrophe-pieces-export 2.4.0

• Improvements to the workflow filter. Thanks to Thanks to Eduardo Correal for these contributions.

apostrophe-pieces-import 2.2.0

• Error messages are now displayed in the import modal.

apostrophe-multisite 2.11.0

• Mixed-case values for shortName and prodHostname are now normalized to lower case. Without this they do not match any web requests, resulting in a notfound message. A migration is included to take care of this in existing databases.

oembetter 1.0.0

• Allows custom headers to be passed in as an option, for instance to support Vimeo embeds of private videos. Changed the option name for authorized oembed sources to "allowlist." Published first offical stable release, after many years of stability.

uploadfs 1.18.2

• Addressed npm audit complaints about mkdirp by using a simple mkdirp implementation that has no legacy compatibility issues.
• Addressed npm audit complaints about mocha and friends by upgrading mocha.
• There are currently npm audit warnings about azure-storage, however a fix for this is forthcoming according to the upstream maintainers, and the existing semver ranges in this package will pick it up on npm audit when released.