alfresco-content-app/docs/extending/rule-migration-guide.md

Title

Title
Rule Migration Guide

Migrating rules to be ACA 5.1.1 compatible

As part of cleanup of the evaluators section in ACA 5.1.1, several rules from the application were removed and replaced with their alternatives. The biggest change involves the preference to use array based visibility rules instead of string based. What this means is that developers will now be able to provide a set of smaller visibility rules via array, instead of having to provide one single rule, which would internally call multiple smaller rules via code.

For e.g., for a rule app.canManageFileVersions, which was basically a combination of hasFileSelection(app.selection.file), isNotTrashcan (app.navigation.isNotTrashcan), and isNotLocked(app.selection.file.isNotLocked), earlier, the code used to look something like -

app.extensions.json

{
  "rules": {
    "visible": "canManageFileVersions"
  }
}

aca-content.module.ts -

extensions.setEvaluators({
  'app.canManageFileVersions': rules.canManageFileVersions,
  'app.selection.file': rules.hasFileSelection,
  'app.navigation.isNotTrashcan': rules.isNotTrashcan,
  'app.navigation.isTrashcan': rules.isTrashcan,
  'app.selection.file.isNotLocked': rules.isNotLocked
})

app.rules.ts -

import { isTrashcan } from './navigation.rules';

export const rules = {
  canManageFileVersions: () => hasFileSelection() && isNotTrashcan() && isNotLocked(),
  hasFileSelection: (context) => !!context?.selection?.file,
  isTrashcan: (context) => context.navigation.startsWith('/trashcan'),
  isNotTrashcan: (context) => !isTrashcan(context),
  isNotLocked: (context) => context.selection.file.entry.isLocked || context.selection.file.entry.properties?.['cm:lockType'] === 'READ_ONLY_LOCK'
}

Now, the visibility of this extension unit can be controlled in more compact way -

{
  "rules": {
    "visible": [
      "app.selection.file",
      "!app.navigation.isTrashcan",
      "!app.selection.file.isLocked"
    ]
  }
}

No further changes in aca-content.module.ts, or app.rules.ts is required, apart from removing the unused rules and functions

NOTE: Notice the use of the rule negation ! in the app.navigation.isTrashcan rule above, thereby removing another unneeded rule.

Below is a full list of rules that would need to be migrated, along with the corresponding set of rules that can be used in their place. Do note that the default OOTB ACA already has the migrations applied on extensions.json, and the changes would only need to be done on any extensions configuration that is custom to you. All old migrated rules have been removed from the code base, so performing this migration is necessary in order to ensure a stable Alfresco Content Application experience

Old rule	New Rule
app.navigation.isNotTrashcan	!app.navigation.isTrashcan
app.navigation.isNotFavorites	!app.navigation.isFavorites
app.navigation.isNotSharedFiles	!app.navigation.isSharedFiles
app.navigation.isNotLibraries	!app.navigation.isLibraries
app.navigation.isNotRecentFiles	!app.navigation.isRecentFiles
app.navigation.isNotSearchResults	!app.navigation.isSearchResults
canViewFile	app.selection.file !app.navigation.isTrashcan
app.canCreateLibrary	app.isContentServiceEnabled app.navigation.isLibraries
app.selection.canDownload	app.selection.notEmpty !app.navigation.isTrashcan app.selection.canDownload
isTrashcanItemSelected	app.navigation.isTrashcan app.selection.notEmpty
canLeaveLibrary	app.selection.library app.selection.hasLibraryRole
canShowInfoDrawer	app.selection.notEmpty !app.navigation.isLibraries !app.navigation.isTrashcan
app.toolbar.favorite.canEditMetadata	app.selection.library app.selection.library isLibraryManager
canToggleEditOffline	app.selection.file !app.navigation.isTrashcan canToggleFileLock
canEditFolder	app.selection.folder.canUpdate !app.navigation.isTrashcan
app.toolbar.favorite.canAdd	app.selection.notEmpty app.selection.canAddFavorite !app.navigation.isTrashcan !app.navigation.isRecentFiles !app.navigation.isSharedFiles !app.navigation.isSearchResults !app.navigation.isFavorites
app.toolbar.favorite.canRemove	app.selection.notEmpty app.selection.canRemoveFavorite !app.navigation.isTrashcan !app.navigation.isRecentFiles !app.navigation.isSharedFiles !app.navigation.isSearchResults !app.navigation.isFavorites
canCopyNode	app.selection.notEmpty !app.navigation.isTrashcan !app.navigation.isLibraries
canManageFileVersions	app.selection.file !app.navigation.isTrashcan !app.selection.file.isLocked
canManagePermissions	app.selection.first.canUpdate !app.navigation.isTrashcan !isSmartFolder !isMultiSelection
rules.canManageFolderRules	rules.isFolderRulesEnabled app.selection.folder.canUpdate !app.navigation.isTrashcan app.selection.folder !app.navigation.isFavorites !isSmartFolder
app.navigation.folder.canCreate	app.isContentServiceEnabled app.navigation.folder.canCreate
app.navigation.folder.canUpload	app.isContentServiceEnabled app.navigation.folder.canCreate
app.isUploadSupported	app.isContentServiceEnabled app.navigation.folder.canCreate
canToggleSharedLink	app.selection.file canToggleSharedLink
canToggleJoinLibrary	app.selection.library !app.selection.hasLibraryRole canToggleJoinLibrary
canShowExpand	!app.navigation.isLibraries !app.navigation.isDetails
canInfoPreview	app.navigation.isSearchResults !isMultiSelection !app.selection.folder !app.navigation.isPreview
app.selection.canDelete	!app.navigation.isTrashcan !app.navigation.isLibraries app.selection.notEmpty app.selection.canDelete
isLibraryManager	app.selection.library isLibraryManager

In addition to the above-mentioned migrations, the following set of rules were removed from the ACA codebase, since they were not being used by the application. If you still need access to these rules however, the original implementation can be found in legacy-rules.md. However, do note that since these rules have been removed from the ACA codebase, no support will be provided for them in the future. We advise that you should only use the provided rules as reference, and migrate your current implementation to use a different approach instead.

Rule
app.selection.file.canLock
app.selection.file.canUnlock
app.selection.file.isLockOwner
app.selection.file.canShare
app.selection.file.isShared
app.selection.canUnshare
app.selection.isPrivateLibrary
app.selection.hasNoLibraryRole
app.navigation.isLibraryFiles
app.navigation.isPersonalFiles
app.navigation.isSharedPreview
app.navigation.isFavoritesPreview
app.navigation.isSharedFileViewer
repository.isQuickShareEnabled
user.isAdmin