feat: add ResourceIndicator extensions

Author: dschmidt

packages/web-pkg/src/composables/piniaStores/extensionRegistry/types.ts

@@ -5,12 +5,14 @@ import { Item } from '@ownclouders/web-client'
 import { FolderView } from '../../../ui'
 import { Component, Slot } from 'vue'
 import { StringUnionOrAnyString } from '../../../utils'
+import { ResourceIndicator } from '../../../helpers'
 
 export type ExtensionType = StringUnionOrAnyString<
   | 'action'
   | 'appMenuItem'
   | 'customComponent'
   | 'folderView'
+  | 'resourceIndicator'
   | 'search'
   | 'sidebarNav'
   | 'sidebarPanel'
@@ -67,6 +69,11 @@ export interface AppMenuItemExtension extends Extension {
   url?: string
 }
 
+export interface ResourceIndicatorExtension extends Extension {
+  type: 'resourceIndicator'
+  getResourceIndicators: (Resource) => ResourceIndicator[] | void
+}
+
 export type ExtensionPoint<T extends Extension> = {
   id: string
   extensionType: ExtensionType

packages/web-pkg/src/extensionPoints.ts

@@ -0,0 +1,14 @@
+import { Extension, ExtensionPoint, ResourceIndicatorExtension } from './'
+import { computed } from 'vue'
+
+export const resourceIndicatorExtensionPoint: ExtensionPoint<ResourceIndicatorExtension> = {
+  id: 'global.files.resource-indicator',
+  extensionType: 'resourceIndicator',
+  multiple: true
+}
+
+export const extensionPoints = () => {
+  return computed<ExtensionPoint<Extension>[]>(() => {
+    return [resourceIndicatorExtensionPoint]
+  })
+}

packages/web-pkg/src/helpers/statusIndicators.ts

@@ -1,6 +1,7 @@
 import { ShareTypes } from '@ownclouders/web-client'
 import { eventBus } from '../services'
 import { SideBarEventTopics } from '../composables/sideBar'
+import { useExtensionRegistry } from '../composables/piniaStores/extensionRegistry'
 import { Resource } from '@ownclouders/web-client'
 import { AncestorMetaData } from '../types'
 import {
@@ -10,6 +11,7 @@ import {
 } from '@ownclouders/web-client'
 import { User } from '@ownclouders/web-client/graph/generated'
 import { IconFillType } from './resource'
+import { resourceIndicatorExtensionPoint } from '../extensionPoints'
 
 // dummy to trick gettext string extraction into recognizing strings
 const $gettext = (str: string): string => {
@@ -157,5 +159,14 @@ export const getIndicators = ({
     }
   }
 
+  ;(useExtensionRegistry().requestExtensions(resourceIndicatorExtensionPoint) || []).forEach(
+    (extension) => {
+      const extensionIndicators = extension.getResourceIndicators(resource)
+      if (extensionIndicators) {
+        indicators.push(...extensionIndicators)
+      }
+    }
+  )
+
   return indicators
 }

packages/web-pkg/src/index.ts

@@ -3,6 +3,7 @@ export * from './components'
 export * from './composables'
 export * from './constants'
 export * from './errors'
+export * from './extensionPoints'
 export * from './helpers'
 export * from './http'
 export * from './observer'

packages/web-pkg/tests/unit/helpers/statusIndicator.spec.ts

@@ -3,10 +3,52 @@ import { Resource, SpaceResource } from '@ownclouders/web-client'
 import { getIndicators } from '../../../src/helpers/statusIndicators'
 import { User } from '@ownclouders/web-client/graph/generated'
 import { AncestorMetaDataValue } from '../../../src/types'
+import { ResourceIndicator } from '../../../src/helpers'
+import { createTestingPinia } from '@ownclouders/web-test-helpers'
+import {
+  ResourceIndicatorExtension,
+  useExtensionRegistry
+} from '../../../src/composables/piniaStores/extensionRegistry'
 
 describe('status indicators', () => {
   const user = mock<User>()
 
+  createTestingPinia()
+
+  describe('indicator extensions', () => {
+    it('should be requested from the extension registry', () => {
+      const space = mock<SpaceResource>({ driveType: 'project' })
+      const resource = mock<Resource>({ id: 'resource' })
+
+      const { requestExtensions } = useExtensionRegistry()
+      vi.mocked(requestExtensions<ResourceIndicatorExtension>).mockReturnValue([
+        {
+          id: 'test.files.resource-indicator.stub',
+          type: 'resourceIndicator',
+          extensionPointIds: ['global.files.resource-indicator'],
+          getResourceIndicators: (resource: Resource): ResourceIndicator[] => {
+            return [
+              {
+                id: 'some-id',
+                accessibleDescription: 'some accessible description',
+                label: 'some label',
+                icon: 'check_box_outline_blank',
+                fillType: 'line',
+                type: 'some-type',
+                category: 'system'
+              }
+            ]
+          }
+        } satisfies ResourceIndicatorExtension
+      ])
+
+      const indicators = getIndicators({ space, resource, ancestorMetaData: {}, user })
+
+      expect(requestExtensions).toHaveBeenCalled()
+      expect(indicators.some(({ id }) => id === 'some-id')).toBeTruthy()
+    })
+  })
+
   describe('locked indicator', () => {
     it.each([true, false])('should only be present if the file is locked', (locked) => {
       const space = mock<SpaceResource>({ id: 'space' })