@structcms/api 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,365 @@
+import { S as StorageAdapter, P as Page, C as CreatePageInput, U as UpdatePageInput, a as PageFilter, N as Navigation, b as CreateNavigationInput, c as UpdateNavigationInput, d as NavigationItem, e as PageSection, M as MediaAdapter, f as UploadMediaInput, g as MediaFile, h as MediaFilter, A as AuthAdapter, i as SignInWithOAuthInput, O as OAuthResponse, j as SignInWithPasswordInput, k as AuthSession, V as VerifySessionInput, l as AuthUser } from './types-Zi0Iyow1.js';
+export { m as ALLOWED_MIME_TYPES, n as AllowedMimeType } from './types-Zi0Iyow1.js';
+import { SupabaseClient } from '@supabase/supabase-js';
+export { SupabaseAdapterFactoryConfig, SupabaseAdapterFactoryStorageConfig, SupabaseAdapters, createSupabaseAdapters } from './supabase/index.js';
+
+/**
+ * Storage adapter error with additional context
+ */
+declare class StorageError extends Error {
+    readonly code?: string | undefined;
+    readonly details?: string | undefined;
+    constructor(message: string, code?: string | undefined, details?: string | undefined);
+}
+/**
+ * Configuration for creating a Supabase storage adapter
+ */
+interface SupabaseStorageAdapterConfig {
+    client: SupabaseClient;
+}
+/**
+ * Supabase implementation of the StorageAdapter interface
+ */
+declare class SupabaseStorageAdapter implements StorageAdapter {
+    private client;
+    constructor(config: SupabaseStorageAdapterConfig);
+    getPage(slug: string): Promise<Page | null>;
+    getPageById(id: string): Promise<Page | null>;
+    createPage(input: CreatePageInput): Promise<Page>;
+    updatePage(input: UpdatePageInput): Promise<Page>;
+    deletePage(id: string): Promise<void>;
+    listPages(filter?: PageFilter): Promise<Page[]>;
+    getNavigation(name: string): Promise<Navigation | null>;
+    getNavigationById(id: string): Promise<Navigation | null>;
+    createNavigation(input: CreateNavigationInput): Promise<Navigation>;
+    updateNavigation(input: UpdateNavigationInput): Promise<Navigation>;
+    deleteNavigation(id: string): Promise<void>;
+    listNavigations(): Promise<Navigation[]>;
+}
+/**
+ * Creates a storage adapter using Supabase
+ */
+declare function createStorageAdapter(config: SupabaseStorageAdapterConfig): StorageAdapter;
+
+/**
+ * Error thrown when storage validation fails
+ */
+declare class StorageValidationError extends Error {
+    readonly code: string;
+    constructor(message: string, code: string);
+}
+/**
+ * Handler for creating a new page
+ * Generates a slug from the title if not provided and ensures uniqueness
+ */
+declare function handleCreatePage(adapter: StorageAdapter, input: CreatePageInput): Promise<Page>;
+/**
+ * Handler for updating an existing page
+ */
+declare function handleUpdatePage(adapter: StorageAdapter, input: UpdatePageInput): Promise<Page>;
+/**
+ * Handler for deleting a page by ID
+ */
+declare function handleDeletePage(adapter: StorageAdapter, id: string): Promise<void>;
+/**
+ * Handler for creating a new navigation
+ * Validates that the name is non-empty and unique
+ */
+declare function handleCreateNavigation(adapter: StorageAdapter, input: CreateNavigationInput): Promise<Navigation>;
+/**
+ * Handler for updating an existing navigation
+ */
+declare function handleUpdateNavigation(adapter: StorageAdapter, input: UpdateNavigationInput): Promise<Navigation>;
+/**
+ * Handler for deleting a navigation by ID
+ */
+declare function handleDeleteNavigation(adapter: StorageAdapter, id: string): Promise<void>;
+
+/**
+ * Generates a URL-safe slug from a title string.
+ *
+ * @param title - The title to convert to a slug
+ * @returns A URL-safe slug
+ *
+ * @example
+ * generateSlug('Hello World') // 'hello-world'
+ * generateSlug('Über uns') // 'ueber-uns'
+ * generateSlug('  Multiple   Spaces  ') // 'multiple-spaces'
+ */
+declare function generateSlug(title: string): string;
+/**
+ * Ensures a slug is unique by appending a numeric suffix if needed.
+ *
+ * @param slug - The base slug to make unique
+ * @param existingSlugs - Array of existing slugs to check against
+ * @returns A unique slug
+ *
+ * @example
+ * ensureUniqueSlug('hello', ['hello', 'world']) // 'hello-1'
+ * ensureUniqueSlug('hello', ['hello', 'hello-1']) // 'hello-2'
+ * ensureUniqueSlug('new', ['hello', 'world']) // 'new'
+ */
+declare function ensureUniqueSlug(slug: string, existingSlugs: string[]): string;
+
+/**
+ * Page response for delivery API
+ * Dates are serialized as ISO strings for JSON transport
+ */
+interface PageResponse {
+    id: string;
+    slug: string;
+    pageType: string;
+    title: string;
+    sections: PageSection[];
+    meta: {
+        createdAt: string;
+        updatedAt: string;
+    };
+}
+/**
+ * Navigation response for delivery API
+ */
+interface NavigationResponse {
+    id: string;
+    name: string;
+    items: NavigationItem[];
+    meta: {
+        updatedAt: string;
+    };
+}
+/**
+ * Filter options for listing pages via delivery API
+ */
+interface ListPagesOptions {
+    pageType?: string;
+    limit?: number;
+    offset?: number;
+}
+
+/**
+ * Handler for GET /api/cms/pages
+ * Returns all pages with resolved media references, optionally filtered by pageType
+ */
+declare function handleListPages(adapter: StorageAdapter, mediaAdapter: MediaAdapter, options?: ListPagesOptions): Promise<PageResponse[]>;
+/**
+ * Handler for GET /api/cms/pages/:slug
+ * Returns a single page by slug with resolved media references, or null if not found
+ */
+declare function handleGetPageBySlug(adapter: StorageAdapter, mediaAdapter: MediaAdapter, slug: string): Promise<PageResponse | null>;
+/**
+ * Handler for GET /api/cms/navigation/:name
+ * Returns a navigation by name, or null if not found
+ */
+declare function handleGetNavigation(adapter: StorageAdapter, name: string): Promise<NavigationResponse | null>;
+
+/**
+ * Media adapter error with additional context
+ */
+declare class MediaError extends Error {
+    readonly code?: string | undefined;
+    readonly details?: string | undefined;
+    constructor(message: string, code?: string | undefined, details?: string | undefined);
+}
+/**
+ * Configuration for creating a Supabase media adapter
+ */
+interface SupabaseMediaAdapterConfig {
+    client: SupabaseClient;
+    bucketName?: string;
+}
+/**
+ * Supabase implementation of the MediaAdapter interface
+ */
+declare class SupabaseMediaAdapter implements MediaAdapter {
+    private client;
+    private bucketName;
+    constructor(config: SupabaseMediaAdapterConfig);
+    /**
+     * Generates a unique storage path for a file
+     */
+    private generateStoragePath;
+    /**
+     * Constructs the public URL for a stored file
+     */
+    private getPublicUrl;
+    /**
+     * Maps a database row to MediaFile
+     */
+    private mapRowToMediaFile;
+    upload(input: UploadMediaInput): Promise<MediaFile>;
+    getMedia(id: string): Promise<MediaFile | null>;
+    listMedia(filter?: MediaFilter): Promise<MediaFile[]>;
+    deleteMedia(id: string): Promise<void>;
+}
+/**
+ * Creates a media adapter using Supabase
+ */
+declare function createMediaAdapter(config: SupabaseMediaAdapterConfig): MediaAdapter;
+
+/**
+ * Error thrown when media validation fails
+ */
+declare class MediaValidationError extends Error {
+    readonly code: string;
+    constructor(message: string, code: string);
+}
+/**
+ * Handler for uploading a media file
+ * Validates the file type and delegates to the adapter
+ */
+declare function handleUploadMedia(adapter: MediaAdapter, input: UploadMediaInput): Promise<MediaFile>;
+/**
+ * Handler for retrieving a media file by ID
+ */
+declare function handleGetMedia(adapter: MediaAdapter, id: string): Promise<MediaFile | null>;
+/**
+ * Handler for listing media files with optional filtering
+ */
+declare function handleListMedia(adapter: MediaAdapter, filter?: MediaFilter): Promise<MediaFile[]>;
+/**
+ * Handler for deleting a media file
+ */
+declare function handleDeleteMedia(adapter: MediaAdapter, id: string): Promise<void>;
+
+/**
+ * Resolves media references in page sections.
+ * Walks section data fields and replaces media IDs (UUIDs) with public URLs.
+ *
+ * Convention: Fields named "image", "media", "photo", "thumbnail", "avatar", "icon"
+ * or ending with "_image", "_media", etc. are treated as media references.
+ *
+ * Missing media is resolved to null.
+ */
+declare function resolveMediaReferences(sections: PageSection[], adapter: MediaAdapter): Promise<PageSection[]>;
+
+declare class AuthError extends Error {
+    readonly code?: string | undefined;
+    readonly details?: string | undefined;
+    constructor(message: string, code?: string | undefined, details?: string | undefined);
+}
+interface SupabaseAuthAdapterConfig {
+    client: SupabaseClient;
+}
+declare class SupabaseAuthAdapter implements AuthAdapter {
+    private client;
+    constructor(config: SupabaseAuthAdapterConfig);
+    private mapSupabaseUser;
+    signInWithOAuth(input: SignInWithOAuthInput): Promise<OAuthResponse>;
+    signInWithPassword(input: SignInWithPasswordInput): Promise<AuthSession>;
+    signOut(_accessToken: string): Promise<void>;
+    verifySession(input: VerifySessionInput): Promise<AuthUser | null>;
+    refreshSession(refreshToken: string): Promise<AuthSession>;
+    getCurrentUser(accessToken: string): Promise<AuthUser | null>;
+}
+declare function createAuthAdapter(config: SupabaseAuthAdapterConfig): AuthAdapter;
+
+declare class AuthValidationError extends Error {
+    constructor(message: string);
+}
+declare function handleSignInWithOAuth(adapter: AuthAdapter, input: SignInWithOAuthInput): Promise<OAuthResponse>;
+declare function handleSignInWithPassword(adapter: AuthAdapter, input: SignInWithPasswordInput): Promise<AuthSession>;
+declare function handleSignOut(adapter: AuthAdapter, accessToken: string): Promise<void>;
+declare function handleVerifySession(adapter: AuthAdapter, input: VerifySessionInput): Promise<AuthUser>;
+declare function handleRefreshSession(adapter: AuthAdapter, refreshToken: string): Promise<AuthSession>;
+declare function handleGetCurrentUser(adapter: AuthAdapter, accessToken: string): Promise<AuthUser | null>;
+
+interface AuthenticatedRequest {
+    user: AuthUser;
+    accessToken: string;
+}
+interface AuthMiddlewareConfig {
+    adapter: AuthAdapter;
+    extractToken?: (headers: Record<string, string | undefined>) => string | null;
+}
+declare function createAuthMiddleware(config: AuthMiddlewareConfig): (headers: Record<string, string | undefined>) => Promise<AuthenticatedRequest>;
+
+/**
+ * Export response for a single page with resolved media URLs
+ */
+interface PageExportResponse {
+    id: string;
+    slug: string;
+    pageType: string;
+    title: string;
+    sections: PageSection[];
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * Export response for all pages
+ */
+interface AllPagesExportResponse {
+    pages: PageExportResponse[];
+    exportedAt: string;
+}
+/**
+ * Export response for navigation structures
+ */
+interface NavigationExportResponse {
+    id: string;
+    name: string;
+    items: NavigationItem[];
+    updatedAt: string;
+}
+/**
+ * Export response for all navigations
+ */
+interface AllNavigationsExportResponse {
+    navigations: NavigationExportResponse[];
+    exportedAt: string;
+}
+/**
+ * Full site export response
+ */
+interface SiteExportResponse {
+    pages: PageExportResponse[];
+    navigations: NavigationExportResponse[];
+    media: MediaExportEntry[];
+    exportedAt: string;
+}
+/**
+ * Media entry in site export
+ */
+interface MediaExportEntry {
+    id: string;
+    filename: string;
+    url: string;
+    mimeType: string;
+    size: number;
+    createdAt: string;
+}
+
+/**
+ * Handler for GET /api/cms/export/pages/:slug
+ * Returns complete page JSON with resolved media URLs
+ */
+declare function handleExportPage(storageAdapter: StorageAdapter, mediaAdapter: MediaAdapter, slug: string): Promise<{
+    data: PageExportResponse;
+    contentDisposition: string;
+} | null>;
+/**
+ * Handler for GET /api/cms/export/pages
+ * Returns all pages as JSON array with resolved media URLs
+ */
+declare function handleExportAllPages(storageAdapter: StorageAdapter, mediaAdapter: MediaAdapter): Promise<{
+    data: AllPagesExportResponse;
+    contentDisposition: string;
+}>;
+/**
+ * Handler for GET /api/cms/export/navigation
+ * Returns all navigation structures as JSON
+ */
+declare function handleExportNavigations(storageAdapter: StorageAdapter): Promise<{
+    data: AllNavigationsExportResponse;
+    contentDisposition: string;
+}>;
+/**
+ * Handler for GET /api/cms/export
+ * Returns complete site content (pages, navigation, media metadata) as JSON
+ */
+declare function handleExportSite(storageAdapter: StorageAdapter, mediaAdapter: MediaAdapter): Promise<{
+    data: SiteExportResponse;
+    contentDisposition: string;
+}>;
+
+export { type AllNavigationsExportResponse, type AllPagesExportResponse, AuthAdapter, AuthError, type AuthMiddlewareConfig, AuthSession, AuthUser, AuthValidationError, type AuthenticatedRequest, CreateNavigationInput, CreatePageInput, type ListPagesOptions, MediaAdapter, MediaError, type MediaExportEntry, MediaFile, MediaFilter, MediaValidationError, Navigation, type NavigationExportResponse, NavigationItem, type NavigationResponse, OAuthResponse, Page, type PageExportResponse, PageFilter, type PageResponse, PageSection, SignInWithOAuthInput, SignInWithPasswordInput, type SiteExportResponse, StorageAdapter, StorageError, StorageValidationError, SupabaseAuthAdapter, type SupabaseAuthAdapterConfig, SupabaseMediaAdapter, type SupabaseMediaAdapterConfig, SupabaseStorageAdapter, type SupabaseStorageAdapterConfig, UpdateNavigationInput, UpdatePageInput, UploadMediaInput, VerifySessionInput, createAuthAdapter, createAuthMiddleware, createMediaAdapter, createStorageAdapter, ensureUniqueSlug, generateSlug, handleCreateNavigation, handleCreatePage, handleDeleteMedia, handleDeleteNavigation, handleDeletePage, handleExportAllPages, handleExportNavigations, handleExportPage, handleExportSite, handleGetCurrentUser, handleGetMedia, handleGetNavigation, handleGetPageBySlug, handleListMedia, handleListPages, handleRefreshSession, handleSignInWithOAuth, handleSignInWithPassword, handleSignOut, handleUpdateNavigation, handleUpdatePage, handleUploadMedia, handleVerifySession, resolveMediaReferences };