@sudobility/building_blocks 0.0.16 → 0.0.18

package/dist/components/index.d.ts

@@ -3,3 +3,5 @@ export * from './breadcrumbs';
 export * from './footer';
 export * from './layout';
 export * from './settings';
+export * from './subscription';
+export * from './pages';

package/dist/components/pages/app-privacy-policy-page.d.ts

@@ -0,0 +1,137 @@
+import React, { type ReactNode, type ComponentType } from 'react';
+/**
+ * Configuration for a content section with a list
+ */
+export interface PrivacySectionWithList {
+    /** Section title */
+    title: string;
+    /** Optional description before the list */
+    description?: string;
+    /** List items */
+    items: string[];
+}
+/**
+ * Configuration for a content section with paragraph text
+ */
+export interface PrivacySectionWithContent {
+    /** Section title */
+    title: string;
+    /** Paragraph content */
+    content: string;
+}
+/**
+ * Configuration for a subsection (h3 level)
+ */
+export interface PrivacySubsection {
+    /** Subsection title */
+    title: string;
+    /** List items */
+    items: string[];
+}
+/**
+ * Contact information configuration
+ */
+export interface PrivacyContactInfo {
+    /** Email label (e.g., "Email:") */
+    emailLabel: string;
+    /** Email address */
+    email: string;
+    /** Website label (e.g., "Website:") */
+    websiteLabel: string;
+    /** Website URL */
+    websiteUrl: string;
+    /** Data Protection Officer label */
+    dpoLabel: string;
+    /** DPO email */
+    dpoEmail: string;
+    /** GDPR section title */
+    gdprTitle: string;
+    /** GDPR section content */
+    gdprContent: string;
+}
+/**
+ * All text content for the privacy policy page
+ */
+export interface PrivacyPolicyPageText {
+    /** Page heading */
+    heading: string;
+    /** Last updated label */
+    lastUpdatedLabel: string;
+    /** Introduction section */
+    introduction: PrivacySectionWithContent;
+    /** Information We Collect section */
+    informationWeCollect: {
+        title: string;
+        youProvide: PrivacySubsection;
+        automatic: PrivacySubsection;
+    };
+    /** How We Use Your Information section */
+    howWeUse: PrivacySectionWithList;
+    /** Information Sharing section */
+    informationSharing: PrivacySectionWithList;
+    /** Data Security section */
+    dataSecurity: PrivacySectionWithList;
+    /** Data Retention section */
+    dataRetention: PrivacySectionWithContent;
+    /** Your Privacy Rights section */
+    privacyRights: PrivacySectionWithList;
+    /** Web3 Considerations section (optional) */
+    web3Considerations?: PrivacySectionWithList;
+    /** International Transfers section */
+    internationalTransfers: PrivacySectionWithContent;
+    /** Children's Privacy section */
+    childrensPrivacy: PrivacySectionWithContent;
+    /** Cookies section */
+    cookies: PrivacySectionWithContent;
+    /** Changes to Policy section */
+    changes: PrivacySectionWithContent;
+    /** Contact section */
+    contact: {
+        title: string;
+        description: string;
+        info: PrivacyContactInfo;
+    };
+}
+/**
+ * Props for AppPrivacyPolicyPage component
+ */
+export interface AppPrivacyPolicyPageProps {
+    /** All text content (must be provided by consumer) */
+    text: PrivacyPolicyPageText;
+    /** Current date for "last updated" display */
+    lastUpdatedDate?: string;
+    /** Optional wrapper component for the page layout */
+    PageWrapper?: ComponentType<{
+        children: ReactNode;
+    }>;
+    /** Optional className for the container */
+    className?: string;
+}
+/**
+ * AppPrivacyPolicyPage - A reusable privacy policy page component
+ *
+ * Displays a comprehensive privacy policy with:
+ * - Standard legal sections
+ * - Optional Web3-specific considerations
+ * - Contact information with GDPR notice
+ *
+ * All text content must be provided by the consumer app.
+ *
+ * @example
+ * ```tsx
+ * <AppPrivacyPolicyPage
+ *   text={{
+ *     heading: "Privacy Policy",
+ *     lastUpdatedLabel: "Last updated",
+ *     introduction: {
+ *       title: "Introduction",
+ *       content: "We respect your privacy..."
+ *     },
+ *     // ... other sections
+ *   }}
+ *   lastUpdatedDate="January 1, 2025"
+ * />
+ * ```
+ */
+export declare const AppPrivacyPolicyPage: React.FC<AppPrivacyPolicyPageProps>;
+export default AppPrivacyPolicyPage;

package/dist/components/pages/app-sitemap-page.d.ts

@@ -0,0 +1,116 @@
+import React, { type ComponentType, type ReactNode } from 'react';
+import type { LinkComponentProps } from '../../types';
+/**
+ * Configuration for a single sitemap link
+ */
+export interface SitemapLink {
+    /** URL path */
+    path: string;
+    /** Display label */
+    label: string;
+    /** Optional description */
+    description?: string;
+}
+/**
+ * Configuration for a sitemap section
+ */
+export interface SitemapSection {
+    /** Section title */
+    title: string;
+    /** Section icon type (optional) */
+    icon?: 'home' | 'document' | 'envelope' | 'cog' | 'language';
+    /** Links in this section */
+    links: SitemapLink[];
+}
+/**
+ * Configuration for a language option
+ */
+export interface LanguageOption {
+    /** Language code (e.g., 'en', 'es') */
+    code: string;
+    /** Display name */
+    name: string;
+    /** Flag emoji */
+    flag: string;
+}
+/**
+ * Configuration for quick action buttons
+ */
+export interface QuickLink {
+    /** URL path */
+    path: string;
+    /** Display label */
+    label: string;
+    /** Button variant */
+    variant: 'primary' | 'secondary' | 'outline';
+    /** Optional icon */
+    icon?: 'envelope' | 'document';
+}
+/**
+ * Text content for the sitemap page
+ */
+export interface SitemapPageText {
+    /** Page title */
+    title: string;
+    /** Page subtitle */
+    subtitle: string;
+    /** Languages section title */
+    languagesSectionTitle: string;
+    /** Languages section description */
+    languagesDescription: string;
+    /** Quick links section title */
+    quickLinksTitle: string;
+}
+/**
+ * Props for AppSitemapPage component
+ */
+export interface AppSitemapPageProps {
+    /** All text content (must be provided by consumer) */
+    text: SitemapPageText;
+    /** Sitemap sections */
+    sections: SitemapSection[];
+    /** Available languages */
+    languages: LanguageOption[];
+    /** Quick action links */
+    quickLinks?: QuickLink[];
+    /** Custom Link component for navigation */
+    LinkComponent: ComponentType<LinkComponentProps & {
+        language?: string;
+    }>;
+    /** Optional wrapper component for the page layout */
+    PageWrapper?: ComponentType<{
+        children: ReactNode;
+    }>;
+    /** Optional className for the container */
+    className?: string;
+}
+/**
+ * AppSitemapPage - A reusable sitemap page component
+ *
+ * Displays a comprehensive sitemap with:
+ * - Language selector
+ * - Organized sections with links
+ * - Quick action buttons
+ *
+ * All text content must be provided by the consumer app.
+ *
+ * @example
+ * ```tsx
+ * <AppSitemapPage
+ *   text={{
+ *     title: "Sitemap",
+ *     subtitle: "Explore all pages",
+ *     languagesSectionTitle: "Languages",
+ *     languagesDescription: "Available in multiple languages",
+ *     quickLinksTitle: "Quick Links"
+ *   }}
+ *   sections={[
+ *     { title: "Main", icon: "home", links: [{ path: "/", label: "Home" }] }
+ *   ]}
+ *   languages={[{ code: "en", name: "English", flag: "🇺🇸" }]}
+ *   LinkComponent={LocalizedLink}
+ * />
+ * ```
+ */
+export declare const AppSitemapPage: React.FC<AppSitemapPageProps>;
+export default AppSitemapPage;

package/dist/components/pages/app-terms-of-service-page.d.ts

@@ -0,0 +1,107 @@
+import React, { type ReactNode, type ComponentType } from 'react';
+/**
+ * Configuration for a section with paragraph content
+ */
+export interface TermsSectionWithContent {
+    /** Section title */
+    title: string;
+    /** Paragraph content (can include HTML for links) */
+    content: string;
+    /** Whether content contains HTML that should be rendered */
+    isHtml?: boolean;
+}
+/**
+ * Configuration for a section with a list
+ */
+export interface TermsSectionWithList {
+    /** Section title */
+    title: string;
+    /** Optional description before the list */
+    description?: string;
+    /** List items */
+    items: string[];
+    /** Optional additional content after the list */
+    additionalContent?: string;
+}
+/**
+ * Contact information configuration
+ */
+export interface TermsContactInfo {
+    /** Email label (e.g., "Email:") */
+    emailLabel: string;
+    /** Email address */
+    email: string;
+    /** Website label (e.g., "Website:") */
+    websiteLabel: string;
+    /** Website URL */
+    websiteUrl: string;
+}
+/**
+ * All text content for the terms of service page
+ */
+export interface TermsOfServicePageText {
+    /** Page title */
+    title: string;
+    /** Last updated text (with placeholder for date) */
+    lastUpdated: string;
+    /** All sections in order */
+    sections: Array<TermsSectionWithContent | TermsSectionWithList>;
+    /** Contact information */
+    contact: {
+        /** Section title */
+        title: string;
+        /** Section description */
+        description: string;
+        /** Whether description contains HTML */
+        isHtml?: boolean;
+        /** Contact details */
+        info: TermsContactInfo;
+    };
+}
+/**
+ * Props for AppTermsOfServicePage component
+ */
+export interface AppTermsOfServicePageProps {
+    /** All text content (must be provided by consumer) */
+    text: TermsOfServicePageText;
+    /** Current date for "last updated" display */
+    lastUpdatedDate?: string;
+    /** Optional wrapper component for the page layout */
+    PageWrapper?: ComponentType<{
+        children: ReactNode;
+    }>;
+    /** Optional className for the container */
+    className?: string;
+}
+/**
+ * AppTermsOfServicePage - A reusable terms of service page component
+ *
+ * Displays a comprehensive terms of service document with:
+ * - Flexible section structure (content or list-based)
+ * - Contact information
+ * - Support for HTML content in specific sections
+ *
+ * All text content must be provided by the consumer app.
+ *
+ * @example
+ * ```tsx
+ * <AppTermsOfServicePage
+ *   text={{
+ *     title: "Terms of Service",
+ *     lastUpdated: "Last updated: {{date}}",
+ *     sections: [
+ *       { title: "Acceptance", content: "By using..." },
+ *       { title: "User Responsibilities", items: ["Item 1", "Item 2"] }
+ *     ],
+ *     contact: {
+ *       title: "Contact",
+ *       description: "Questions?",
+ *       info: { emailLabel: "Email:", email: "support@example.com", ... }
+ *     }
+ *   }}
+ *   lastUpdatedDate="January 1, 2025"
+ * />
+ * ```
+ */
+export declare const AppTermsOfServicePage: React.FC<AppTermsOfServicePageProps>;
+export default AppTermsOfServicePage;

package/dist/components/pages/index.d.ts

@@ -0,0 +1,6 @@
+export { AppSitemapPage } from './app-sitemap-page';
+export type { AppSitemapPageProps, SitemapPageText, SitemapSection, SitemapLink, LanguageOption, QuickLink, } from './app-sitemap-page';
+export { AppPrivacyPolicyPage } from './app-privacy-policy-page';
+export type { AppPrivacyPolicyPageProps, PrivacyPolicyPageText, PrivacySectionWithList, PrivacySectionWithContent, PrivacySubsection, PrivacyContactInfo, } from './app-privacy-policy-page';
+export { AppTermsOfServicePage } from './app-terms-of-service-page';
+export type { AppTermsOfServicePageProps, TermsOfServicePageText, TermsSectionWithContent, TermsSectionWithList, TermsContactInfo, } from './app-terms-of-service-page';

package/dist/components/subscription/AppPricingPage.d.ts

@@ -0,0 +1,86 @@
+/**
+ * @fileoverview App Pricing Page
+ * @description Public pricing page for displaying subscription options
+ */
+/** Product from subscription provider */
+export interface PricingProduct {
+    identifier: string;
+    title: string;
+    price: string;
+    priceString: string;
+    period?: string;
+}
+/** FAQ item */
+export interface FAQItem {
+    question: string;
+    answer: string;
+}
+/** All localized labels for the pricing page */
+export interface PricingPageLabels {
+    title: string;
+    subtitle: string;
+    periodYear: string;
+    periodMonth: string;
+    periodWeek: string;
+    billingMonthly: string;
+    billingYearly: string;
+    freeTierTitle: string;
+    freeTierPrice: string;
+    freeTierFeatures: string[];
+    currentPlanBadge: string;
+    mostPopularBadge: string;
+    ctaLogIn: string;
+    ctaTryFree: string;
+    ctaUpgrade: string;
+    faqTitle: string;
+}
+/** Formatter functions for dynamic strings */
+export interface PricingPageFormatters {
+    /** Format savings badge: "Save 20%" */
+    formatSavePercent: (percent: number) => string;
+    /** Get features for a product by its identifier */
+    getProductFeatures: (productId: string) => string[];
+}
+/** Package ID to entitlement mapping */
+export interface EntitlementMap {
+    [packageId: string]: string;
+}
+/** Entitlement to level mapping for comparing plan tiers */
+export interface EntitlementLevels {
+    [entitlement: string]: number;
+}
+export interface AppPricingPageProps {
+    /** Available subscription products */
+    products: PricingProduct[];
+    /** Whether user is authenticated */
+    isAuthenticated: boolean;
+    /** Whether user has an active subscription */
+    hasActiveSubscription: boolean;
+    /** Current subscription product identifier (if any) */
+    currentProductIdentifier?: string;
+    /** User ID used for subscription (the selected entity's ID when logged in) */
+    subscriptionUserId?: string;
+    /** All localized labels */
+    labels: PricingPageLabels;
+    /** Formatter functions */
+    formatters: PricingPageFormatters;
+    /** Package ID to entitlement mapping for calculating savings */
+    entitlementMap: EntitlementMap;
+    /** Entitlement to level mapping for comparing tiers (higher = better) */
+    entitlementLevels: EntitlementLevels;
+    /** Called when user clicks on a plan */
+    onPlanClick: (planIdentifier: string) => void;
+    /** Called when user clicks on free plan */
+    onFreePlanClick: () => void;
+    /** Optional FAQ items */
+    faqItems?: FAQItem[];
+    /** Optional className for the container */
+    className?: string;
+}
+/**
+ * Public pricing page for displaying subscription options.
+ * - Non-authenticated: Free tile shows "Try it for Free", paid tiles show "Log in to Continue"
+ * - Authenticated on free: Free tile shows "Current Plan" badge (no CTA), paid tiles show "Upgrade"
+ * - Authenticated with subscription: Current plan shows badge (no CTA), higher tiers show "Upgrade"
+ */
+export declare function AppPricingPage({ products, isAuthenticated, hasActiveSubscription, currentProductIdentifier, labels, formatters, entitlementMap, entitlementLevels, onPlanClick, onFreePlanClick, faqItems, className, }: AppPricingPageProps): import("react/jsx-runtime").JSX.Element;

package/dist/components/subscription/AppSubscriptionsPage.d.ts

@@ -0,0 +1,114 @@
+/**
+ * @fileoverview App Subscriptions Page
+ * @description Page for managing app subscriptions and viewing rate limits
+ */
+import type { RateLimitsConfigData } from '@sudobility/types';
+/** Product from subscription provider */
+export interface SubscriptionProduct {
+    identifier: string;
+    title: string;
+    price: string;
+    priceString: string;
+    period?: string;
+    freeTrialPeriod?: string;
+    introPrice?: string;
+}
+/** Current subscription state */
+export interface CurrentSubscription {
+    isActive: boolean;
+    productIdentifier?: string;
+    expirationDate?: Date;
+    willRenew?: boolean;
+}
+/** Subscription context value passed from consumer */
+export interface SubscriptionContextValue {
+    products: SubscriptionProduct[];
+    currentSubscription: CurrentSubscription | null;
+    isLoading: boolean;
+    error: string | null;
+    purchase: (productId: string) => Promise<boolean>;
+    restore: () => Promise<boolean>;
+    clearError: () => void;
+}
+/** All localized labels for the subscription page */
+export interface SubscriptionPageLabels {
+    title: string;
+    errorTitle: string;
+    purchaseError: string;
+    restoreError: string;
+    restoreNoPurchases: string;
+    periodYear: string;
+    periodMonth: string;
+    periodWeek: string;
+    billingMonthly: string;
+    billingYearly: string;
+    unlimited: string;
+    unlimitedRequests: string;
+    currentStatusLabel: string;
+    statusActive: string;
+    statusInactive: string;
+    statusInactiveMessage: string;
+    labelPlan: string;
+    labelPremium: string;
+    labelExpires: string;
+    labelWillRenew: string;
+    labelMonthlyUsage: string;
+    labelDailyUsage: string;
+    yes: string;
+    no: string;
+    buttonSubscribe: string;
+    buttonPurchasing: string;
+    buttonRestore: string;
+    buttonRestoring: string;
+    noProducts: string;
+    noProductsForPeriod: string;
+    freeTierTitle: string;
+    freeTierPrice: string;
+    freeTierFeatures: string[];
+    currentPlanBadge: string;
+}
+/** Formatter functions for dynamic strings */
+export interface SubscriptionPageFormatters {
+    /** Format rate limit: "1,000 requests/hour" */
+    formatHourlyLimit: (limit: string) => string;
+    /** Format rate limit: "10,000 requests/day" */
+    formatDailyLimit: (limit: string) => string;
+    /** Format rate limit: "100,000 requests/month" */
+    formatMonthlyLimit: (limit: string) => string;
+    /** Format trial period: "7 days free trial" */
+    formatTrialDays: (count: number) => string;
+    /** Format trial period: "2 weeks free trial" */
+    formatTrialWeeks: (count: number) => string;
+    /** Format trial period: "1 month free trial" */
+    formatTrialMonths: (count: number) => string;
+    /** Format savings badge: "Save 20%" */
+    formatSavePercent: (percent: number) => string;
+    /** Format intro price note */
+    formatIntroNote: (price: string) => string;
+}
+export interface AppSubscriptionsPageProps {
+    /** Subscription context value */
+    subscription: SubscriptionContextValue;
+    /** Rate limit configuration */
+    rateLimitsConfig?: RateLimitsConfigData | null;
+    /** User ID used for subscription (the selected entity's ID when logged in) */
+    subscriptionUserId?: string;
+    /** All localized labels */
+    labels: SubscriptionPageLabels;
+    /** Formatter functions for dynamic strings */
+    formatters: SubscriptionPageFormatters;
+    /** Package ID to entitlement mapping */
+    packageEntitlementMap?: Record<string, string>;
+    /** Called when purchase succeeds */
+    onPurchaseSuccess?: () => void;
+    /** Called when restore succeeds */
+    onRestoreSuccess?: () => void;
+    /** Called on error */
+    onError?: (title: string, message: string) => void;
+    /** Called on warning */
+    onWarning?: (title: string, message: string) => void;
+}
+/**
+ * Page for managing app subscriptions.
+ */
+export declare function AppSubscriptionsPage({ subscription, rateLimitsConfig, labels, formatters, packageEntitlementMap, onPurchaseSuccess, onRestoreSuccess, onError, onWarning, }: AppSubscriptionsPageProps): import("react/jsx-runtime").JSX.Element;

package/dist/components/subscription/index.d.ts

@@ -0,0 +1,4 @@
+export { AppSubscriptionsPage } from './AppSubscriptionsPage';
+export type { AppSubscriptionsPageProps, SubscriptionProduct, CurrentSubscription, SubscriptionContextValue, SubscriptionPageLabels, SubscriptionPageFormatters, } from './AppSubscriptionsPage';
+export { AppPricingPage } from './AppPricingPage';
+export type { AppPricingPageProps, PricingProduct, FAQItem, PricingPageLabels, PricingPageFormatters, EntitlementMap, EntitlementLevels, } from './AppPricingPage';