@structcms/api 0.1.0

package/dist/types-Zi0Iyow1.d.cts

@@ -0,0 +1,204 @@
+/**
+ * Represents a section within a page
+ */
+interface PageSection {
+    id: string;
+    type: string;
+    data: Record<string, unknown>;
+}
+/**
+ * Represents a CMS page with sections
+ */
+interface Page {
+    id: string;
+    slug: string;
+    pageType: string;
+    title: string;
+    sections: PageSection[];
+    createdAt: Date;
+    updatedAt: Date;
+}
+/**
+ * Input for creating a new page
+ */
+interface CreatePageInput {
+    slug?: string;
+    pageType: string;
+    title: string;
+    sections?: PageSection[];
+}
+/**
+ * Input for updating an existing page
+ */
+interface UpdatePageInput {
+    id: string;
+    slug?: string;
+    pageType?: string;
+    title?: string;
+    sections?: PageSection[];
+}
+/**
+ * Filter options for listing pages
+ */
+interface PageFilter {
+    pageType?: string;
+    limit?: number;
+    offset?: number;
+}
+/**
+ * Represents a navigation structure
+ */
+interface Navigation {
+    id: string;
+    name: string;
+    items: NavigationItem[];
+    updatedAt: Date;
+}
+/**
+ * A navigation item (recursive for nested menus)
+ */
+interface NavigationItem {
+    label: string;
+    href: string;
+    children?: NavigationItem[];
+}
+/**
+ * Input for creating a navigation
+ */
+interface CreateNavigationInput {
+    name: string;
+    items: NavigationItem[];
+}
+/**
+ * Input for updating a navigation
+ */
+interface UpdateNavigationInput {
+    id: string;
+    name?: string;
+    items?: NavigationItem[];
+}
+/**
+ * Storage adapter interface for page and navigation persistence
+ * This interface is Supabase-agnostic to allow future portability
+ */
+interface StorageAdapter {
+    /** Get a page by its slug */
+    getPage(slug: string): Promise<Page | null>;
+    /** Get a page by its ID */
+    getPageById(id: string): Promise<Page | null>;
+    /** Create a new page */
+    createPage(input: CreatePageInput): Promise<Page>;
+    /** Update an existing page */
+    updatePage(input: UpdatePageInput): Promise<Page>;
+    /** Delete a page by ID */
+    deletePage(id: string): Promise<void>;
+    /** List pages with optional filtering and pagination */
+    listPages(filter?: PageFilter): Promise<Page[]>;
+    /** Get a navigation by its name */
+    getNavigation(name: string): Promise<Navigation | null>;
+    /** Get a navigation by its ID */
+    getNavigationById(id: string): Promise<Navigation | null>;
+    /** Create a new navigation */
+    createNavigation(input: CreateNavigationInput): Promise<Navigation>;
+    /** Update an existing navigation */
+    updateNavigation(input: UpdateNavigationInput): Promise<Navigation>;
+    /** Delete a navigation by ID */
+    deleteNavigation(id: string): Promise<void>;
+    /** List all navigations */
+    listNavigations(): Promise<Navigation[]>;
+}
+
+/**
+ * Allowed MIME types for media uploads
+ */
+declare const ALLOWED_MIME_TYPES: readonly ["image/jpeg", "image/png", "image/gif", "image/webp", "image/svg+xml"];
+type AllowedMimeType = (typeof ALLOWED_MIME_TYPES)[number];
+/**
+ * Represents a media file stored in the CMS
+ */
+interface MediaFile {
+    id: string;
+    filename: string;
+    url: string;
+    mimeType: string;
+    size: number;
+    createdAt: Date;
+}
+/**
+ * Input for uploading a media file
+ * data accepts ArrayBuffer for platform-agnostic binary data
+ */
+interface UploadMediaInput {
+    filename: string;
+    mimeType: string;
+    size: number;
+    data: ArrayBuffer | Uint8Array;
+}
+/**
+ * Filter options for listing media files
+ */
+interface MediaFilter {
+    limit?: number;
+    offset?: number;
+    mimeType?: string;
+}
+/**
+ * Media adapter interface for file storage operations.
+ * This interface is Supabase-agnostic to allow future portability.
+ */
+interface MediaAdapter {
+    /**
+     * Upload a media file
+     */
+    upload(input: UploadMediaInput): Promise<MediaFile>;
+    /**
+     * Get a media file by ID
+     */
+    getMedia(id: string): Promise<MediaFile | null>;
+    /**
+     * List media files with optional filtering and pagination
+     */
+    listMedia(filter?: MediaFilter): Promise<MediaFile[]>;
+    /**
+     * Delete a media file by ID
+     */
+    deleteMedia(id: string): Promise<void>;
+}
+
+interface AuthUser {
+    id: string;
+    email: string;
+    metadata?: Record<string, unknown>;
+}
+interface AuthSession {
+    accessToken: string;
+    refreshToken?: string;
+    expiresAt?: Date;
+    user: AuthUser;
+}
+interface SignInWithOAuthInput {
+    provider: 'google' | 'github' | 'gitlab' | 'azure' | 'bitbucket';
+    redirectTo?: string;
+}
+interface SignInWithPasswordInput {
+    email: string;
+    password: string;
+}
+interface OAuthResponse {
+    url: string;
+    provider: string;
+}
+interface VerifySessionInput {
+    accessToken: string;
+    expiresAt?: Date | string;
+}
+interface AuthAdapter {
+    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>;
+}
+
+export { type AuthAdapter as A, type CreatePageInput as C, type MediaAdapter as M, type Navigation as N, type OAuthResponse as O, type Page as P, type StorageAdapter as S, type UpdatePageInput as U, type VerifySessionInput as V, type PageFilter as a, type CreateNavigationInput as b, type UpdateNavigationInput as c, type NavigationItem as d, type PageSection as e, type UploadMediaInput as f, type MediaFile as g, type MediaFilter as h, type SignInWithOAuthInput as i, type SignInWithPasswordInput as j, type AuthSession as k, type AuthUser as l, ALLOWED_MIME_TYPES as m, type AllowedMimeType as n };

package/dist/types-Zi0Iyow1.d.ts

@@ -0,0 +1,204 @@
+/**
+ * Represents a section within a page
+ */
+interface PageSection {
+    id: string;
+    type: string;
+    data: Record<string, unknown>;
+}
+/**
+ * Represents a CMS page with sections
+ */
+interface Page {
+    id: string;
+    slug: string;
+    pageType: string;
+    title: string;
+    sections: PageSection[];
+    createdAt: Date;
+    updatedAt: Date;
+}
+/**
+ * Input for creating a new page
+ */
+interface CreatePageInput {
+    slug?: string;
+    pageType: string;
+    title: string;
+    sections?: PageSection[];
+}
+/**
+ * Input for updating an existing page
+ */
+interface UpdatePageInput {
+    id: string;
+    slug?: string;
+    pageType?: string;
+    title?: string;
+    sections?: PageSection[];
+}
+/**
+ * Filter options for listing pages
+ */
+interface PageFilter {
+    pageType?: string;
+    limit?: number;
+    offset?: number;
+}
+/**
+ * Represents a navigation structure
+ */
+interface Navigation {
+    id: string;
+    name: string;
+    items: NavigationItem[];
+    updatedAt: Date;
+}
+/**
+ * A navigation item (recursive for nested menus)
+ */
+interface NavigationItem {
+    label: string;
+    href: string;
+    children?: NavigationItem[];
+}
+/**
+ * Input for creating a navigation
+ */
+interface CreateNavigationInput {
+    name: string;
+    items: NavigationItem[];
+}
+/**
+ * Input for updating a navigation
+ */
+interface UpdateNavigationInput {
+    id: string;
+    name?: string;
+    items?: NavigationItem[];
+}
+/**
+ * Storage adapter interface for page and navigation persistence
+ * This interface is Supabase-agnostic to allow future portability
+ */
+interface StorageAdapter {
+    /** Get a page by its slug */
+    getPage(slug: string): Promise<Page | null>;
+    /** Get a page by its ID */
+    getPageById(id: string): Promise<Page | null>;
+    /** Create a new page */
+    createPage(input: CreatePageInput): Promise<Page>;
+    /** Update an existing page */
+    updatePage(input: UpdatePageInput): Promise<Page>;
+    /** Delete a page by ID */
+    deletePage(id: string): Promise<void>;
+    /** List pages with optional filtering and pagination */
+    listPages(filter?: PageFilter): Promise<Page[]>;
+    /** Get a navigation by its name */
+    getNavigation(name: string): Promise<Navigation | null>;
+    /** Get a navigation by its ID */
+    getNavigationById(id: string): Promise<Navigation | null>;
+    /** Create a new navigation */
+    createNavigation(input: CreateNavigationInput): Promise<Navigation>;
+    /** Update an existing navigation */
+    updateNavigation(input: UpdateNavigationInput): Promise<Navigation>;
+    /** Delete a navigation by ID */
+    deleteNavigation(id: string): Promise<void>;
+    /** List all navigations */
+    listNavigations(): Promise<Navigation[]>;
+}
+
+/**
+ * Allowed MIME types for media uploads
+ */
+declare const ALLOWED_MIME_TYPES: readonly ["image/jpeg", "image/png", "image/gif", "image/webp", "image/svg+xml"];
+type AllowedMimeType = (typeof ALLOWED_MIME_TYPES)[number];
+/**
+ * Represents a media file stored in the CMS
+ */
+interface MediaFile {
+    id: string;
+    filename: string;
+    url: string;
+    mimeType: string;
+    size: number;
+    createdAt: Date;
+}
+/**
+ * Input for uploading a media file
+ * data accepts ArrayBuffer for platform-agnostic binary data
+ */
+interface UploadMediaInput {
+    filename: string;
+    mimeType: string;
+    size: number;
+    data: ArrayBuffer | Uint8Array;
+}
+/**
+ * Filter options for listing media files
+ */
+interface MediaFilter {
+    limit?: number;
+    offset?: number;
+    mimeType?: string;
+}
+/**
+ * Media adapter interface for file storage operations.
+ * This interface is Supabase-agnostic to allow future portability.
+ */
+interface MediaAdapter {
+    /**
+     * Upload a media file
+     */
+    upload(input: UploadMediaInput): Promise<MediaFile>;
+    /**
+     * Get a media file by ID
+     */
+    getMedia(id: string): Promise<MediaFile | null>;
+    /**
+     * List media files with optional filtering and pagination
+     */
+    listMedia(filter?: MediaFilter): Promise<MediaFile[]>;
+    /**
+     * Delete a media file by ID
+     */
+    deleteMedia(id: string): Promise<void>;
+}
+
+interface AuthUser {
+    id: string;
+    email: string;
+    metadata?: Record<string, unknown>;
+}
+interface AuthSession {
+    accessToken: string;
+    refreshToken?: string;
+    expiresAt?: Date;
+    user: AuthUser;
+}
+interface SignInWithOAuthInput {
+    provider: 'google' | 'github' | 'gitlab' | 'azure' | 'bitbucket';
+    redirectTo?: string;
+}
+interface SignInWithPasswordInput {
+    email: string;
+    password: string;
+}
+interface OAuthResponse {
+    url: string;
+    provider: string;
+}
+interface VerifySessionInput {
+    accessToken: string;
+    expiresAt?: Date | string;
+}
+interface AuthAdapter {
+    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>;
+}
+
+export { type AuthAdapter as A, type CreatePageInput as C, type MediaAdapter as M, type Navigation as N, type OAuthResponse as O, type Page as P, type StorageAdapter as S, type UpdatePageInput as U, type VerifySessionInput as V, type PageFilter as a, type CreateNavigationInput as b, type UpdateNavigationInput as c, type NavigationItem as d, type PageSection as e, type UploadMediaInput as f, type MediaFile as g, type MediaFilter as h, type SignInWithOAuthInput as i, type SignInWithPasswordInput as j, type AuthSession as k, type AuthUser as l, ALLOWED_MIME_TYPES as m, type AllowedMimeType as n };

package/package.json

@@ -0,0 +1,78 @@
+{
+  "name": "@structcms/api",
+  "version": "0.1.0",
+  "description": "Storage, domain API, and delivery API for StructCMS",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./next": {
+      "import": {
+        "types": "./dist/next/index.d.ts",
+        "default": "./dist/next/index.js"
+      },
+      "require": {
+        "types": "./dist/next/index.d.cts",
+        "default": "./dist/next/index.cjs"
+      }
+    },
+    "./supabase": {
+      "import": {
+        "types": "./dist/supabase/index.d.ts",
+        "default": "./dist/supabase/index.js"
+      },
+      "require": {
+        "types": "./dist/supabase/index.d.cts",
+        "default": "./dist/supabase/index.cjs"
+      }
+    }
+  },
+  "files": ["dist", "README.md", "LICENSE"],
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit",
+    "gen:types": "npx supabase gen types typescript --project-id arwaynscjejiwpcurnjs > src/types/database.types.ts",
+    "test": "vitest"
+  },
+  "dependencies": {
+    "@supabase/supabase-js": "^2.45.0",
+    "sanitize-html": "^2.17.0"
+  },
+  "devDependencies": {
+    "@types/sanitize-html": "^2.16.0",
+    "typescript": "~5.7.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "MIT",
+  "author": "Sebastian Krischer",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/skrischer/structcms.git",
+    "directory": "packages/api"
+  },
+  "keywords": [
+    "cms",
+    "headless-cms",
+    "api",
+    "supabase",
+    "storage",
+    "media",
+    "content-api",
+    "nextjs"
+  ]
+}