@gtcx/templates 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,282 @@
+import React, { ReactNode, Key } from 'react';
+import { PageHeaderAction, BreadcrumbItem } from '@gtcx/ui';
+export { BreadcrumbItem } from '@gtcx/ui';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { TableProps, DescriptionsProps } from 'antd';
+
+/**
+ * Template API types following ADR-0003 conventions.
+ * All templates should accept these standardized props for consistency.
+ */
+interface TemplateAction {
+    key: string;
+    label: string;
+    onAction?: () => void;
+    kind?: 'primary' | 'secondary' | 'danger' | 'link';
+    disabled?: boolean;
+    ariaLabel?: string;
+    icon?: ReactNode;
+}
+interface TemplateAudit {
+    summary?: string;
+    lastUpdatedAt?: string;
+    lastUpdatedBy?: string;
+    sourceSystem?: string;
+    evidenceUrl?: string;
+}
+interface TemplateFilters<TState = unknown> {
+    state: TState;
+    onChange: (next: TState) => void;
+    content?: ReactNode;
+}
+interface TemplateLayoutOverrides {
+    contentPadding?: number;
+    showBreadcrumbs?: boolean;
+}
+interface TemplateProps<TData = unknown> {
+    data?: TData;
+    actions?: TemplateAction[];
+    filters?: TemplateFilters;
+    audit?: TemplateAudit;
+    layout?: TemplateLayoutOverrides;
+}
+declare function templateActionsToPageHeaderActions(actions: TemplateAction[]): PageHeaderAction[];
+
+interface TemplateFrameProps<TData = unknown, TFilterState = unknown> {
+    title: string;
+    subtitle?: string;
+    breadcrumbs?: BreadcrumbItem[];
+    data?: TData;
+    actions?: TemplateAction[];
+    filters?: TemplateFilters<TFilterState>;
+    audit?: TemplateProps<TData>['audit'];
+    layout?: TemplateProps<TData>['layout'];
+    children: React.ReactNode;
+}
+/**
+ * TemplateFrame: standard page scaffold following ADR-0003 conventions.
+ * Composes PageHeader + optional filters slot + content slot + optional audit summary.
+ */
+declare function TemplateFrame<TData = unknown, TFilterState = unknown>({ title, subtitle, breadcrumbs, data: _data, actions, filters, audit, layout, children, }: TemplateFrameProps<TData, TFilterState>): react_jsx_runtime.JSX.Element;
+
+type KpiTrend = 'up' | 'down' | 'flat';
+interface KpiCardProps {
+    label: string;
+    value: ReactNode;
+    delta?: ReactNode;
+    trend?: KpiTrend;
+    helpText?: string;
+    icon?: ReactNode;
+    onClick?: () => void;
+}
+declare function KpiCard({ label, value, delta, trend, helpText, icon, onClick, }: KpiCardProps): react_jsx_runtime.JSX.Element;
+
+interface SectionCardProps {
+    title?: string;
+    subtitle?: string;
+    extra?: ReactNode;
+    children: ReactNode;
+    noPadding?: boolean;
+}
+declare function SectionCard({ title, subtitle, extra, children, noPadding, }: SectionCardProps): react_jsx_runtime.JSX.Element;
+
+interface BulkAction {
+    key: string;
+    label: string;
+    kind?: 'primary' | 'secondary' | 'danger' | 'link';
+    onAction: (selectedRowKeys: Key[]) => void;
+    disabled?: boolean;
+}
+interface BulkActionsBarProps {
+    selectedCount: number;
+    selectedRowKeys: Key[];
+    actions: BulkAction[];
+    onClear?: () => void;
+}
+declare function BulkActionsBar({ selectedCount, selectedRowKeys, actions, onClear, }: BulkActionsBarProps): react_jsx_runtime.JSX.Element | null;
+
+interface AuditEvent {
+    key: string;
+    at: string;
+    by?: string;
+    action: string;
+    description?: ReactNode;
+    sourceSystem?: string;
+    evidenceUrl?: string;
+}
+interface AuditTrailProps {
+    title?: string;
+    events: AuditEvent[];
+    loading?: boolean;
+    onLoadMore?: () => void;
+}
+declare function AuditTrail({ title, events, loading, onLoadMore, }: AuditTrailProps): react_jsx_runtime.JSX.Element;
+
+interface DashboardKpi {
+    key: string;
+    label: string;
+    value: ReactNode;
+    delta?: ReactNode;
+    trend?: KpiTrend;
+    helpText?: string;
+    icon?: ReactNode;
+    onClick?: () => void;
+}
+interface DashboardPanel {
+    key: string;
+    title: string;
+    subtitle?: string;
+    extra?: ReactNode;
+    content: ReactNode;
+    span?: number;
+}
+interface DashboardData {
+    kpis?: DashboardKpi[];
+    panels?: DashboardPanel[];
+}
+interface DashboardTemplateProps<TFilterState = unknown> {
+    title: string;
+    subtitle?: string;
+    breadcrumbs?: BreadcrumbItem[];
+    data?: DashboardData;
+    actions?: TemplateAction[];
+    filters?: TemplateFilters<TFilterState>;
+    audit?: TemplateProps<DashboardData>['audit'];
+    layout?: TemplateProps<DashboardData>['layout'];
+}
+
+declare function DashboardTemplate<TFilterState = unknown>({ title, subtitle, breadcrumbs, data, actions, filters, audit, layout, }: DashboardTemplateProps<TFilterState>): react_jsx_runtime.JSX.Element;
+
+interface ListData<TItem> {
+    items: TItem[];
+    loading?: boolean;
+    total?: number;
+}
+interface ListExportSpec {
+    key: string;
+    label: string;
+    onExport: () => void;
+    disabled?: boolean;
+    icon?: ReactNode;
+}
+interface ListBulkAction {
+    key: string;
+    label: string;
+    kind?: 'primary' | 'secondary' | 'danger' | 'link';
+    onAction: (selectedRowKeys: Key[]) => void;
+    disabled?: boolean;
+}
+interface ListSelection {
+    enabled: boolean;
+    bulkActions?: ListBulkAction[];
+    selectedRowKeys?: Key[];
+    onSelectionChange?: (next: Key[]) => void;
+    getAriaLabel?: (record: unknown, index?: number) => string;
+}
+interface ListTemplateProps<TItem, TFilterState = unknown> {
+    title: string;
+    subtitle?: string;
+    breadcrumbs?: BreadcrumbItem[];
+    data?: ListData<TItem>;
+    actions?: TemplateAction[];
+    filters?: TemplateFilters<TFilterState>;
+    audit?: TemplateProps<ListData<TItem>>['audit'];
+    layout?: TemplateProps<ListData<TItem>>['layout'];
+    table: Omit<TableProps<TItem>, 'dataSource' | 'loading'> & {
+        rowKey: TableProps<TItem>['rowKey'];
+    };
+    selection?: ListSelection;
+    exports?: ListExportSpec[];
+    tools?: ReactNode;
+}
+
+declare function ListTemplate<TItem extends object, TFilterState = unknown>({ title, subtitle, breadcrumbs, data, actions, filters, audit, layout, table, selection, exports, tools, }: ListTemplateProps<TItem, TFilterState>): react_jsx_runtime.JSX.Element;
+
+interface DetailSection {
+    key: string;
+    title: string;
+    extra?: ReactNode;
+    content: ReactNode;
+}
+interface DetailSummary {
+    items: DescriptionsProps['items'];
+    columns?: number;
+}
+interface DetailAuditTrail {
+    title?: string;
+    events: AuditEvent[];
+    loading?: boolean;
+    onLoadMore?: () => void;
+}
+interface DetailData {
+    summary?: DetailSummary;
+    sections?: DetailSection[];
+    auditTrail?: DetailAuditTrail;
+}
+interface DetailTemplateProps extends TemplateProps<DetailData> {
+    title: string;
+    subtitle?: string;
+    breadcrumbs?: BreadcrumbItem[];
+    actions?: TemplateAction[];
+}
+
+declare function DetailTemplate({ title, subtitle, breadcrumbs, data, actions, audit, layout, }: DetailTemplateProps): react_jsx_runtime.JSX.Element;
+
+interface AuthShellProps {
+    brand?: ReactNode;
+    title?: string;
+    subtitle?: string;
+    footer?: ReactNode;
+    children: ReactNode;
+    maxWidth?: number;
+}
+declare function AuthShell({ brand, title, subtitle, footer, children, maxWidth, }: AuthShellProps): react_jsx_runtime.JSX.Element;
+
+type ErrorStatus = 401 | 403 | 404 | 500;
+interface ErrorPageTemplateProps {
+    status: ErrorStatus;
+    title?: string;
+    message?: ReactNode;
+    actions?: TemplateAction[];
+    extra?: ReactNode;
+}
+declare function ErrorPageTemplate({ status, title, message, actions, extra, }: ErrorPageTemplateProps): react_jsx_runtime.JSX.Element;
+
+interface WizardStep {
+    key: string;
+    title: string;
+    description?: string;
+    content: ReactNode;
+}
+interface WizardData {
+    steps: WizardStep[];
+    currentStep?: number;
+}
+interface WizardTemplateProps extends TemplateProps<WizardData> {
+    title: string;
+    subtitle?: string;
+    breadcrumbs?: BreadcrumbItem[];
+    actions?: TemplateAction[];
+}
+
+declare function WizardTemplate({ title, subtitle, breadcrumbs, actions, data, filters, audit, layout, }: WizardTemplateProps): react_jsx_runtime.JSX.Element;
+
+interface SettingsSection {
+    key: string;
+    title: string;
+    subtitle?: string;
+    content: ReactNode;
+}
+interface SettingsData {
+    sections: SettingsSection[];
+}
+interface SettingsTemplateProps extends TemplateProps<SettingsData> {
+    title: string;
+    subtitle?: string;
+    breadcrumbs?: BreadcrumbItem[];
+    actions?: TemplateAction[];
+}
+
+declare function SettingsTemplate({ title, subtitle, breadcrumbs, actions, data, filters, audit, layout, }: SettingsTemplateProps): react_jsx_runtime.JSX.Element;
+
+export { type AuditEvent, AuditTrail, type AuditTrailProps, AuthShell, type AuthShellProps, type BulkAction, BulkActionsBar, type BulkActionsBarProps, type DashboardData, type DashboardKpi, type DashboardPanel, DashboardTemplate, type DashboardTemplateProps, type DetailAuditTrail, type DetailData, type DetailSection, type DetailSummary, DetailTemplate, type DetailTemplateProps, ErrorPageTemplate, type ErrorPageTemplateProps, type ErrorStatus, KpiCard, type KpiCardProps, type KpiTrend, type ListBulkAction, type ListData, type ListExportSpec, type ListSelection, ListTemplate, type ListTemplateProps, SectionCard, type SectionCardProps, type SettingsData, type SettingsSection, SettingsTemplate, type SettingsTemplateProps, type TemplateAction, type TemplateAudit, type TemplateFilters, TemplateFrame, type TemplateFrameProps, type TemplateLayoutOverrides, type TemplateProps, type WizardData, type WizardStep, WizardTemplate, type WizardTemplateProps, templateActionsToPageHeaderActions };

package/dist/index.d.ts

@@ -0,0 +1,43 @@
+export type { TemplateAction, TemplateAudit, TemplateFilters, TemplateLayoutOverrides, TemplateProps, BreadcrumbItem, } from './types';
+export { templateActionsToPageHeaderActions } from './types';
+export { TemplateFrame } from './template-frame';
+export type { TemplateFrameProps } from './template-frame';
+export { KpiCard } from './components/kpi-card';
+export type { KpiCardProps, KpiTrend } from './components/kpi-card';
+export { SectionCard } from './components/section-card';
+export type { SectionCardProps } from './components/section-card';
+export { BulkActionsBar } from './components/bulk-actions';
+export type { BulkAction, BulkActionsBarProps } from './components/bulk-actions';
+export { AuditTrail } from './components/audit-trail';
+export type { AuditEvent, AuditTrailProps } from './components/audit-trail';
+export { DashboardTemplate } from './templates/dashboard';
+export type { DashboardData, DashboardKpi, DashboardPanel, DashboardTemplateProps, } from './templates/dashboard';
+export { ListTemplate } from './templates/list';
+export type { ListData, ListExportSpec, ListBulkAction, ListSelection, ListTemplateProps, } from './templates/list';
+export { DetailTemplate } from './templates/detail';
+export type { DetailData, DetailSection, DetailSummary, DetailAuditTrail, DetailTemplateProps, } from './templates/detail';
+export { ErrorPageTemplate } from './templates/error';
+export type { ErrorStatus, ErrorPageTemplateProps } from './templates/error';
+export { WizardTemplate } from './templates/wizard';
+export type { WizardData, WizardStep, WizardTemplateProps } from './templates/wizard';
+export { SettingsTemplate } from './templates/settings';
+export type { SettingsData, SettingsSection, SettingsTemplateProps } from './templates/settings';
+export { AuthShell } from './templates/auth-shell';
+export type { AuthShellProps } from './templates/auth-shell';
+export { ProfileTemplate } from './templates/profile';
+export type { ProfileData, ProfileStat, ProfileTab, ProfileTemplateProps, } from './templates/profile';
+export { BillingTemplate } from './templates/billing';
+export type { BillingData, BillingPlan, PaymentMethod, Invoice, BillingTemplateProps, } from './templates/billing';
+export { SecurityTemplate } from './templates/security';
+export type { SecurityData, SecuritySession, SecurityDevice, SecurityLog, SecurityTemplateProps, } from './templates/security';
+export { MembersTemplate } from './templates/members';
+export type { MembersData, TeamMember, TeamRole, MembersTemplateProps } from './templates/members';
+export { NotificationsTemplate } from './templates/notifications';
+export type { NotificationsData, NotificationChannel, NotificationGroup, NotificationsTemplateProps, } from './templates/notifications';
+export { ActivityTemplate } from './templates/activity';
+export type { ActivityData, ActivityEvent, ActivityTemplateProps } from './templates/activity';
+export { InviteTemplate } from './templates/invite';
+export type { InviteData, InviteReward, InviteTemplateProps } from './templates/invite';
+export { ProjectsTemplate } from './templates/projects';
+export type { ProjectsData, Project, ProjectMember, ProjectsTemplateProps, } from './templates/projects';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,YAAY,EACV,cAAc,EACd,aAAa,EACb,eAAe,EACf,uBAAuB,EACvB,aAAa,EACb,cAAc,GACf,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,kCAAkC,EAAE,MAAM,SAAS,CAAC;AAG7D,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,YAAY,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAG3D,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAChD,YAAY,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAEpE,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACxD,YAAY,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAElE,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,YAAY,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAEjF,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,YAAY,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAG5E,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,YAAY,EACV,aAAa,EACb,YAAY,EACZ,cAAc,EACd,sBAAsB,GACvB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,YAAY,EACV,QAAQ,EACR,cAAc,EACd,cAAc,EACd,aAAa,EACb,iBAAiB,GAClB,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,YAAY,EACV,UAAU,EACV,aAAa,EACb,aAAa,EACb,gBAAgB,EAChB,mBAAmB,GACpB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACtD,YAAY,EAAE,WAAW,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAE7E,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,YAAY,EAAE,UAAU,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAEtF,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,YAAY,EAAE,YAAY,EAAE,eAAe,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAEjG,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,YAAY,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAE7D,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACtD,YAAY,EACV,WAAW,EACX,WAAW,EACX,UAAU,EACV,oBAAoB,GACrB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACtD,YAAY,EACV,WAAW,EACX,WAAW,EACX,aAAa,EACb,OAAO,EACP,oBAAoB,GACrB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,YAAY,EACV,YAAY,EACZ,eAAe,EACf,cAAc,EACd,WAAW,EACX,qBAAqB,GACtB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACtD,YAAY,EAAE,WAAW,EAAE,UAAU,EAAE,QAAQ,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAEnG,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAClE,YAAY,EACV,iBAAiB,EACjB,mBAAmB,EACnB,iBAAiB,EACjB,0BAA0B,GAC3B,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,YAAY,EAAE,YAAY,EAAE,aAAa,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAE/F,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,YAAY,EAAE,UAAU,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAExF,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,YAAY,EACV,YAAY,EACZ,OAAO,EACP,aAAa,EACb,qBAAqB,GACtB,MAAM,sBAAsB,CAAC"}