@ossy/analytics 3.0.8 → 3.4.0

package/README.md

@@ -0,0 +1,30 @@
+# @ossy/analytics
+
+Analytics feature package for the Ossy platform. Shows **workspace-scoped** traffic and insight KPIs.
+
+Platform-wide (ops) insights belong in a future back-office surface — see [ADR 0014](../../docs/adr/0014-system-insights-in-back-office.md).
+
+## Pages
+
+| Page | Path | Audience |
+|------|------|----------|
+| `analytics/home` | `/analytics` · `/analys` | Workspace members (entitled package) |
+
+## Actions
+
+| Action | Access | Notes |
+|--------|--------|-------|
+| `@ossy/analytics/actions/get-workspace-kpis` | `workspace` | Member count + non-removed resource count for the current workspace |
+| `@ossy/resources/actions/get-page-view-stats` | `workspace` | Page-view aggregates (implemented in `@ossy/resources`) |
+
+## Client usage
+
+```js
+import { GetWorkspaceKpis } from '@ossy/analytics'
+
+await sdk.invoke(GetWorkspaceKpis, {})
+```
+
+## Preview
+
+Enable Analytics in workspace entitlements (or `devEntitlements` in `@ossy/app-test`), then open `/analytics`.

package/package.json

@@ -1,13 +1,16 @@
 {
   "name": "@ossy/analytics",
-  "description": "Analytics module — workspace analytics for website traffic",
-  "version": "3.0.8",
+  "description": "Analytics module — workspace insight KPIs",
+  "version": "3.4.0",
   "type": "module",
   "main": "./src/index.js",
   "module": "./src/index.js",
   "exports": {
     ".": "./src/index.js"
   },
+  "scripts": {
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest --verbose"
+  },
   "author": "Ossy <yourfriends@ossy.se> (https://ossy.se)",
   "license": "MIT",
   "ossy": {
@@ -21,11 +24,20 @@
     "/src",
     "README.md"
   ],
+  "dependencies": {
+    "@ossy/event-store": "^3.4.0",
+    "@ossy/workspaces": "^3.4.0"
+  },
   "peerDependencies": {
     "@ossy/design-system": "*",
     "@ossy/resources": "*",
     "@ossy/sdk-react": "*",
+    "@ossy/workspaces": "*",
     "react": "*"
   },
-  "gitHead": "980b380c9dee0de78ef3ebabe86efcec1c223a9a"
+  "devDependencies": {
+    "@jest/globals": "^30.2.0",
+    "jest": "^30.2.0"
+  },
+  "gitHead": "d36b69444268d172bc3e8e1dc77e67afc63f8650"
 }

package/src/Definition.js

@@ -1,7 +1,7 @@
 export const Definition = {
   id: 'analytics',
   title: 'Analytics',
-  description: 'Workspace analytics for website traffic and top performing pages.',
+  description: 'Workspace insight KPIs for members, resources, and traffic.',
   icon: 'chart',
   status: ['beta'],
 }

package/src/analytics.page.jsx

@@ -1,6 +1,7 @@
 import React, { useMemo } from 'react'
 import { Text, View, Page, useLocale } from '@ossy/design-system'
 import { usePageViewStats } from './usePageViewStats.js'
+import { useWorkspaceKpis } from './useWorkspaceKpis.js'
 import { useSdk } from '@ossy/sdk-react'
 import { GetWorkspace } from '@ossy/workspaces'
 
@@ -35,12 +36,15 @@ export default function AnalyticsPage() {
     return { from: now - 30 * 24 * 60 * 60 * 1000, to: now }
   }, [])
 
-  const { status, totalViews, dailyViews, topPaths } = usePageViewStats({
+  const pageViews = usePageViewStats({
     workspaceId: workspace?.id,
     from,
     to,
     limit: 10,
   })
+  const workspaceKpis = useWorkspaceKpis({ workspaceId: workspace?.id })
+
+  const { status, totalViews, dailyViews, topPaths } = pageViews
 
   return (
     <Page
@@ -48,63 +52,76 @@ export default function AnalyticsPage() {
       description="analytics.home.description"
     >
       <View gap="m">
-      {status === 'loading' && (
-        <View surface="primary" roundness="m" inset="m">
-          <Text>{t('analytics.home.loading')}</Text>
-        </View>
-      )}
+        {(workspaceKpis.status === 'loading' || status === 'loading') && (
+          <View surface="primary" roundness="m" inset="m">
+            <Text>{t('analytics.home.loading')}</Text>
+          </View>
+        )}
 
-      {status === 'error' && (
-        <View surface="primary" roundness="m" inset="m">
-          <Text>{t('analytics.home.error')}</Text>
-        </View>
-      )}
+        {workspaceKpis.status === 'error' && (
+          <View surface="primary" roundness="m" inset="m">
+            <Text>{t('analytics.home.workspaceKpisError')}</Text>
+          </View>
+        )}
 
-      {status === 'success' && (
-        <>
+        {workspaceKpis.status === 'success' && (
           <View layout="row" gap="m">
-            <SummaryCard label={t('analytics.home.totalPageViews')} value={`${totalViews}`} />
-            <SummaryCard label={t('analytics.home.trackedPages')} value={`${topPaths.length}`} />
-            <SummaryCard label={t('analytics.home.daysWithTraffic')} value={`${dailyViews.length}`} />
+            <SummaryCard label={t('analytics.home.members')} value={`${workspaceKpis.members}`} />
+            <SummaryCard label={t('analytics.home.resources')} value={`${workspaceKpis.resources}`} />
           </View>
+        )}
 
-          <View layout="row" gap="m" style={{ alignItems: 'flex-start' }}>
-            <View
-              surface="primary"
-              roundness="m"
-              inset="m"
-              gap="s"
-              style={{ border: '1px solid var(--separator)', flex: 1 }}
-            >
-              <Text variant="heading-secondary" as="h2" text="analytics.home.topPaths" />
-              {topPaths.length === 0 && <Text variant="small" text="analytics.home.noPageViews" />}
-              {topPaths.map((item) => (
-                <View key={item.path || 'unknown'} layout="row" justifyContent="space-between">
-                  <Text variant="small">{item.path || t('analytics.home.unknownPath')}</Text>
-                  <Text variant="small">{item.views}</Text>
-                </View>
-              ))}
+        {status === 'error' && (
+          <View surface="primary" roundness="m" inset="m">
+            <Text>{t('analytics.home.error')}</Text>
+          </View>
+        )}
+
+        {status === 'success' && (
+          <>
+            <View layout="row" gap="m">
+              <SummaryCard label={t('analytics.home.totalPageViews')} value={`${totalViews}`} />
+              <SummaryCard label={t('analytics.home.trackedPages')} value={`${topPaths.length}`} />
+              <SummaryCard label={t('analytics.home.daysWithTraffic')} value={`${dailyViews.length}`} />
             </View>
 
-            <View
-              surface="primary"
-              roundness="m"
-              inset="m"
-              gap="s"
-              style={{ border: '1px solid var(--separator)', flex: 1 }}
-            >
-              <Text variant="heading-secondary" as="h2" text="analytics.home.dailyPageViews" />
-              {dailyViews.length === 0 && <Text variant="small" text="analytics.home.noDailyData" />}
-              {dailyViews.map((item) => (
-                <View key={item.date} layout="row" justifyContent="space-between">
-                  <Text variant="small">{item.date}</Text>
-                  <Text variant="small">{item.views}</Text>
-                </View>
-              ))}
+            <View layout="row" gap="m" style={{ alignItems: 'flex-start' }}>
+              <View
+                surface="primary"
+                roundness="m"
+                inset="m"
+                gap="s"
+                style={{ border: '1px solid var(--separator)', flex: 1 }}
+              >
+                <Text variant="heading-secondary" as="h2" text="analytics.home.topPaths" />
+                {topPaths.length === 0 && <Text variant="small" text="analytics.home.noPageViews" />}
+                {topPaths.map((item) => (
+                  <View key={item.path || 'unknown'} layout="row" justifyContent="space-between">
+                    <Text variant="small">{item.path || t('analytics.home.unknownPath')}</Text>
+                    <Text variant="small">{item.views}</Text>
+                  </View>
+                ))}
+              </View>
+
+              <View
+                surface="primary"
+                roundness="m"
+                inset="m"
+                gap="s"
+                style={{ border: '1px solid var(--separator)', flex: 1 }}
+              >
+                <Text variant="heading-secondary" as="h2" text="analytics.home.dailyPageViews" />
+                {dailyViews.length === 0 && <Text variant="small" text="analytics.home.noDailyData" />}
+                {dailyViews.map((item) => (
+                  <View key={item.date} layout="row" justifyContent="space-between">
+                    <Text variant="small">{item.date}</Text>
+                    <Text variant="small">{item.views}</Text>
+                  </View>
+                ))}
+              </View>
             </View>
-          </View>
-        </>
-      )}
+          </>
+        )}
       </View>
     </Page>
   )

package/src/en.translations.json

@@ -1,9 +1,12 @@
 {
   "analytics/home.documentTitle": "Analytics",
   "analytics.home.title": "Analytics",
-  "analytics.home.description": "Workspace analytics for website traffic and top performing pages.",
+  "analytics.home.description": "Workspace insight KPIs for members, resources, and traffic.",
   "analytics.home.loading": "Loading analytics...",
   "analytics.home.error": "Could not load analytics data.",
+  "analytics.home.members": "Members",
+  "analytics.home.resources": "Resources",
+  "analytics.home.workspaceKpisError": "Could not load workspace KPIs.",
   "analytics.home.totalPageViews": "Total page views (30 days)",
   "analytics.home.trackedPages": "Tracked pages (30 days)",
   "analytics.home.daysWithTraffic": "Days with traffic",

package/src/get-workspace-kpis.action.js

@@ -0,0 +1,4 @@
+export const metadata = {
+  id: '@ossy/analytics/actions/get-workspace-kpis',
+  access: 'workspace',
+}

package/src/get-workspace-kpis.task.js

@@ -0,0 +1,27 @@
+import { Aggregate } from '@ossy/event-store'
+import { Workspace } from '@ossy/workspaces/server'
+
+export const metadata = { id: '@ossy/analytics/tasks/get-workspace-kpis' }
+
+const RESOURCE_SCHEMA_TYPE = { $regex: /^@[^/]+\/[^/]+\/schema\// }
+
+export async function run({ payload, req }) {
+  const workspaceId = payload?.workspaceId ?? req?.workspaceId
+  if (!workspaceId) throw Object.assign(new Error('workspaceId is required'), { status: 400 })
+
+  const workspace = await Aggregate.Of(Workspace, workspaceId).then(Aggregate.View())
+  const members = Array.isArray(workspace.users) ? workspace.users.length : 0
+
+  const resources = await Aggregate.Collection.countDocuments({
+    type: RESOURCE_SCHEMA_TYPE,
+    'state.belongsTo': workspace.id,
+    'state.status': { $ne: 'removed' },
+  })
+
+  return {
+    scope: 'workspace',
+    workspaceId: workspace.id,
+    members,
+    resources,
+  }
+}

package/src/get-workspace-kpis.task.spec.js

@@ -0,0 +1,61 @@
+import { beforeEach, describe, expect, it, jest } from '@jest/globals'
+
+const countDocuments = jest.fn()
+const ofMock = jest.fn()
+const viewMock = jest.fn()
+
+jest.unstable_mockModule('@ossy/event-store', () => ({
+  Aggregate: {
+    Of: ofMock,
+    View: viewMock,
+    Collection: { countDocuments },
+  },
+}))
+
+jest.unstable_mockModule('@ossy/workspaces/server', () => ({
+  Workspace: { name: 'Workspace' },
+}))
+
+const { run } = await import('./get-workspace-kpis.task.js')
+
+describe('get-workspace-kpis task', () => {
+  beforeEach(() => {
+    countDocuments.mockReset()
+    ofMock.mockReset()
+    viewMock.mockReset()
+  })
+
+  it('requires workspaceId', async () => {
+    await expect(run({ payload: {}, req: {} })).rejects.toMatchObject({
+      message: 'workspaceId is required',
+      status: 400,
+    })
+  })
+
+  it('returns member and resource counts for the workspace', async () => {
+    ofMock.mockReturnValue(Promise.resolve({ id: 'ws-1' }))
+    viewMock.mockReturnValue(() => ({ id: 'ws-1', users: ['u1', 'u2', 'u3'] }))
+    countDocuments.mockResolvedValue(7)
+
+    // Aggregate.Of(...).then(Aggregate.View()) — View() returns a function applied by then
+    ofMock.mockImplementation(() => ({
+      then(fn) {
+        return Promise.resolve(fn({ id: 'ws-1', users: ['u1', 'u2', 'u3'] }))
+      },
+    }))
+    viewMock.mockReturnValue((saved) => saved)
+
+    const result = await run({ payload: { workspaceId: 'ws-1' }, req: {} })
+
+    expect(result).toEqual({
+      scope: 'workspace',
+      workspaceId: 'ws-1',
+      members: 3,
+      resources: 7,
+    })
+    expect(countDocuments).toHaveBeenCalledWith(expect.objectContaining({
+      'state.belongsTo': 'ws-1',
+      'state.status': { $ne: 'removed' },
+    }))
+  })
+})

package/src/index.js

@@ -1 +1,2 @@
 export { Definition } from './Definition.js'
+export { metadata as GetWorkspaceKpis } from './get-workspace-kpis.action.js'

package/src/sv.translations.json

@@ -1,9 +1,12 @@
 {
   "analytics/home.documentTitle": "Analys",
   "analytics.home.title": "Analys",
-  "analytics.home.description": "Workspace-analys för webbtrafik och mest besökta sidor.",
+  "analytics.home.description": "Workspace-KPIer för medlemmar, resurser och trafik.",
   "analytics.home.loading": "Laddar analys...",
   "analytics.home.error": "Kunde inte ladda analysdata.",
+  "analytics.home.members": "Medlemmar",
+  "analytics.home.resources": "Resurser",
+  "analytics.home.workspaceKpisError": "Kunde inte ladda workspace-KPIer.",
   "analytics.home.totalPageViews": "Totala sidvisningar (30 dagar)",
   "analytics.home.trackedPages": "Spårade sidor (30 dagar)",
   "analytics.home.daysWithTraffic": "Dagar med trafik",

package/src/useWorkspaceKpis.js

@@ -0,0 +1,34 @@
+import { useEffect, useState } from 'react'
+import { useSdk } from '@ossy/sdk-react'
+import { metadata as GetWorkspaceKpis } from './get-workspace-kpis.action.js'
+
+export function useWorkspaceKpis({ workspaceId }) {
+  const sdk = useSdk()
+  const [status, setStatus] = useState('idle')
+  const [data, setData] = useState({
+    members: 0,
+    resources: 0,
+  })
+
+  useEffect(() => {
+    if (!workspaceId) return
+
+    setStatus('loading')
+    sdk.invoke(GetWorkspaceKpis, {})
+      .then((json) => {
+        setData({
+          members: json?.members || 0,
+          resources: json?.resources || 0,
+        })
+        setStatus('success')
+      })
+      .catch(() => {
+        setStatus('error')
+      })
+  }, [sdk, workspaceId])
+
+  return {
+    status,
+    ...data,
+  }
+}