@fayz-ai/plugin-admin 0.1.0

package/src/index.ts

@@ -0,0 +1,133 @@
+import React from 'react'
+import type { PluginManifest } from '@fayz-ai/core'
+import { createSafeDataProvider, registerTranslations } from '@fayz-ai/core'
+import type { ResolvedAdminConfig, AdminPluginLabels } from './AdminContext'
+import type { AdminDataProvider, AdminSettingsSnapshot } from './data/types'
+import type { AdminPluginOptions } from './types'
+import { createMockAdminProvider } from './data/mock'
+import { createSupabaseAdminProvider } from './data/supabase'
+import { createAdminStore } from './store'
+import { adminLocales } from './locales'
+import { AdminPage } from './AdminPage'
+
+// ---------------------------------------------------------------------------
+// Defaults
+// ---------------------------------------------------------------------------
+
+const DEFAULT_LABELS: AdminPluginLabels = {
+  pageTitle: 'Admin',
+  pageSubtitle: "Your app's layout, navigation, and branding.",
+}
+
+// ---------------------------------------------------------------------------
+// Config resolver
+// ---------------------------------------------------------------------------
+
+function resolveConfig(options?: AdminPluginOptions): ResolvedAdminConfig {
+  return {
+    labels: DEFAULT_LABELS,
+    layout: options?.layout ?? 'sidebar',
+    moduleNav: options?.moduleNav ?? 'tabs',
+    mobileHeader: options?.mobileHeader ?? 'minimal',
+    navTransition: options?.navTransition ?? 'slide',
+    orgSettings: options?.orgSettings ?? true,
+    branding: options?.branding ?? true,
+  }
+}
+
+function toSnapshot(config: ResolvedAdminConfig): AdminSettingsSnapshot {
+  const { labels: _labels, ...snapshot } = config
+  return snapshot
+}
+
+// ---------------------------------------------------------------------------
+// Factory
+// ---------------------------------------------------------------------------
+
+export function createAdminPlugin(options?: AdminPluginOptions): PluginManifest {
+  const config = resolveConfig(options)
+  // Register locales globally so the plugin's translations resolve even when the
+  // host shell does not mount @fayz-ai/core's I18nProvider (incremental de-bridge).
+  registerTranslations(adminLocales)
+  const snapshot = toSnapshot(config)
+  const provider = options?.dataProvider ?? createSafeDataProvider(
+    () => createSupabaseAdminProvider(snapshot),
+    () => createMockAdminProvider(snapshot),
+  )
+  const store = createAdminStore(provider)
+
+  const PageComponent: React.FC<unknown> = () =>
+    React.createElement(AdminPage, { config, provider, store })
+
+  return {
+    id: 'admin',
+    name: config.labels.pageTitle,
+    icon: 'LayoutTemplate',
+    version: '1.0.0',
+    scope: options?.scope ?? 'universal',
+    verticalId: options?.verticalId,
+    // Shell/admin-config is a Panel-side concept (layout, module nav, branding
+    // for an admin app) — targets the saas/admin-template world, not the
+    // ecommerce storefront. Same declaration plugin-crm uses for its
+    // business-ops surface.
+    scaffolds: ['saas'],
+    defaultEnabled: true,
+    dependencies: [],
+    declaredFeatures: [
+      { id: 'admin', label: config.labels.pageTitle, group: config.labels.pageTitle },
+    ],
+
+    navigation: [
+      {
+        section: 'secondary',
+        position: 90,
+        label: config.labels.pageTitle,
+        route: '/admin',
+        icon: 'LayoutTemplate',
+        permission: { feature: 'admin', action: 'read' as const },
+      },
+    ],
+
+    routes: [
+      {
+        path: '/admin',
+        component: PageComponent as unknown as React.ComponentType<unknown>,
+        permission: { feature: 'admin', action: 'read' as const },
+      },
+    ],
+
+    widgets: [],
+
+    aiTools: [
+      {
+        id: 'admin.get-shell-settings',
+        name: 'getShellSettings',
+        description: 'Returns the app shell configuration: layout variant, module nav style, mobile header treatment, and whether org/branding settings are shown.',
+        icon: 'LayoutTemplate',
+        mode: 'read' as const,
+        category: 'Admin',
+        parameters: {
+          type: 'object' as const,
+          properties: {},
+        },
+        suggestions: [
+          { label: 'What layout is this app using?' },
+          { label: 'Is branding customization on?' },
+        ],
+        permission: { feature: 'admin', action: 'read' as const },
+      },
+    ],
+
+    settings: [],
+
+    locales: adminLocales,
+  }
+}
+
+// ---------------------------------------------------------------------------
+// Re-exports
+// ---------------------------------------------------------------------------
+
+export type { AdminDataProvider, AdminSettingsSnapshot } from './data/types'
+export type { ResolvedAdminConfig, AdminPluginLabels } from './AdminContext'
+export type { AdminPluginOptions } from './types'

package/src/locales/en.ts

@@ -0,0 +1,17 @@
+export const en: Record<string, string> = {
+  'admin.layout.title': 'Layout',
+  'admin.layout.sidebar': 'Sidebar',
+  'admin.layout.topbar': 'Topbar',
+  'admin.layout.minimal': 'Minimal',
+  'admin.moduleNav.title': 'Module navigation',
+  'admin.moduleNav.rail': 'Side rail for the installed modules',
+  'admin.moduleNav.tabs': 'Tabs for the installed modules',
+  'admin.mobileHeader.title': 'Mobile header',
+  'admin.mobileHeader.minimal': 'Minimal header bar',
+  'admin.mobileHeader.transparent': 'Transparent, edge-to-edge content',
+  'admin.mobileHeader.hidden': 'Hidden',
+  'admin.branding.title': 'Branding',
+  'admin.branding.on': 'Org branding settings are visible to operators',
+  'admin.branding.off': 'Org branding settings are hidden',
+  'admin.readOnlyNotice': 'Read-only preview. Editing these settings here is coming soon — for now they are set in your app config.',
+}

package/src/locales/index.ts

@@ -0,0 +1,7 @@
+import { en } from './en'
+import { ptBR } from './pt-BR'
+
+export const adminLocales: Record<string, Record<string, string>> = {
+  en,
+  'pt-BR': ptBR,
+}

package/src/locales/pt-BR.ts

@@ -0,0 +1,17 @@
+export const ptBR: Record<string, string> = {
+  'admin.layout.title': 'Layout',
+  'admin.layout.sidebar': 'Barra lateral',
+  'admin.layout.topbar': 'Barra superior',
+  'admin.layout.minimal': 'Minimalista',
+  'admin.moduleNav.title': 'Navegação dos módulos',
+  'admin.moduleNav.rail': 'Barra lateral para os módulos instalados',
+  'admin.moduleNav.tabs': 'Abas para os módulos instalados',
+  'admin.mobileHeader.title': 'Cabeçalho mobile',
+  'admin.mobileHeader.minimal': 'Cabeçalho minimalista',
+  'admin.mobileHeader.transparent': 'Transparente, conteúdo de ponta a ponta',
+  'admin.mobileHeader.hidden': 'Oculto',
+  'admin.branding.title': 'Identidade visual',
+  'admin.branding.on': 'As configurações de marca estão visíveis para operadores',
+  'admin.branding.off': 'As configurações de marca estão ocultas',
+  'admin.readOnlyNotice': 'Pré-visualização somente leitura. A edição por aqui chega em breve — por enquanto essas opções são definidas na configuração do app.',
+}

package/src/store.ts

@@ -0,0 +1,29 @@
+import { createStore, type StoreApi } from 'zustand/vanilla'
+import { dedup } from '@fayz-ai/saas'
+import type { AdminDataProvider, AdminSettingsSnapshot } from './data/types'
+
+export interface AdminUIState {
+  settings: AdminSettingsSnapshot | null
+  settingsLoading: boolean
+
+  fetchSettings(): Promise<void>
+}
+
+export function createAdminStore(provider: AdminDataProvider): StoreApi<AdminUIState> {
+  return createStore<AdminUIState>((set) => ({
+    settings: null,
+    settingsLoading: false,
+
+    async fetchSettings() {
+      return dedup('admin:settings', async () => {
+        set({ settingsLoading: true })
+        try {
+          const settings = await provider.getSettings()
+          set({ settings, settingsLoading: false })
+        } catch {
+          set({ settingsLoading: false })
+        }
+      })
+    },
+  }))
+}

package/src/types.ts

@@ -0,0 +1,35 @@
+// ---------------------------------------------------------------------------
+// Admin Plugin — Options
+// ---------------------------------------------------------------------------
+// These fields surface the app's existing shell config (FayzAppConfig in
+// @fayz-ai/saas — see packages/saas/src/app/config.ts): layout, moduleNav,
+// mobileHeader, navTransition, orgSettings, and branding. They do not
+// introduce a new config shape — this plugin only reflects what's already
+// resolved at `defineSaas` time. There is no runtime write path yet: see
+// README.md for the follow-up.
+// ---------------------------------------------------------------------------
+
+import type { PluginScope, VerticalId } from '@fayz-ai/core'
+import type { AdminDataProvider } from './data/types'
+
+export interface AdminPluginOptions {
+  /** Shell layout variant (mirrors FayzAppConfig.layout). Default: 'sidebar'. */
+  layout?: 'sidebar' | 'topbar' | 'minimal'
+  /** How module-internal navigation renders (mirrors FayzAppConfig.moduleNav). Default: 'tabs'. */
+  moduleNav?: 'rail' | 'tabs'
+  /** Mobile header treatment (mirrors FayzAppConfig.mobileHeader). Default: 'minimal'. */
+  mobileHeader?: 'minimal' | 'transparent' | 'hidden'
+  /** Page navigation animation (mirrors FayzAppConfig.navTransition). Default: 'slide'. */
+  navTransition?: 'slide' | 'fade' | 'none'
+  /** Show org-level settings tabs (mirrors FayzAppConfig.orgSettings). Default: true. */
+  orgSettings?: boolean
+  /** Show branding/company settings tabs (mirrors FayzAppConfig.branding). Default: true. */
+  branding?: boolean
+
+  /** Plugin scope */
+  scope?: PluginScope
+  /** Vertical ID */
+  verticalId?: VerticalId
+  /** Data provider override (defaults to safe auto-selection) */
+  dataProvider?: AdminDataProvider
+}