lokicms-plugin-stripe 1.0.0

package/src/types.ts

@@ -0,0 +1,214 @@
+/**
+ * Stripe Plugin Types
+ */
+
+import type { Hono } from 'hono';
+import type { z } from 'zod';
+
+// ============================================================================
+// Plugin API Types (from LokiCMS)
+// ============================================================================
+
+export interface PluginLifecycle {
+  onLoad?: () => Promise<void> | void;
+  onEnable?: () => Promise<void> | void;
+  onDisable?: () => Promise<void> | void;
+}
+
+export interface MCPToolDefinition {
+  name?: string;
+  description: string;
+  inputSchema: z.ZodType;
+  handler: (args: unknown) => Promise<unknown>;
+}
+
+export interface HookRegistrar {
+  on(hookName: string, handler: (payload: unknown) => Promise<unknown> | void, priority?: number): void;
+  off(hookName: string, handler: (payload: unknown) => Promise<unknown> | void): void;
+}
+
+export interface RouteRegistrar {
+  register(routes: Hono): void;
+  getBasePath(): string;
+}
+
+export interface MCPRegistrar {
+  registerTool(name: string, tool: MCPToolDefinition): void;
+  unregisterTool(name: string): void;
+}
+
+export interface ContentTypeFieldDefinition {
+  name: string;
+  label: string;
+  type: string;
+  required?: boolean;
+  description?: string;
+  defaultValue?: unknown;
+  validation?: Record<string, unknown>;
+}
+
+export interface ContentTypeRegistration {
+  name: string;
+  slug: string;
+  description?: string;
+  fields: ContentTypeFieldDefinition[];
+  titleField?: string;
+}
+
+export interface ContentTypeRegistrar {
+  register(contentType: ContentTypeRegistration): Promise<void>;
+  unregister(slug: string): Promise<void>;
+}
+
+export interface ConfigAccessor {
+  get<T = unknown>(key: string, defaultValue?: T): T;
+  getAll(): Record<string, unknown>;
+}
+
+export interface PluginLogger {
+  debug(message: string, ...args: unknown[]): void;
+  info(message: string, ...args: unknown[]): void;
+  warn(message: string, ...args: unknown[]): void;
+  error(message: string, ...args: unknown[]): void;
+}
+
+export interface PluginServices {
+  entries: {
+    create: (input: unknown, authorId: string, authorName?: string) => Promise<unknown>;
+    findById: (id: string) => Promise<unknown>;
+    findBySlug: (contentType: string, slug: string) => Promise<unknown>;
+    findAll: (filters?: unknown) => Promise<unknown>;
+    update: (id: string, input: unknown) => Promise<unknown>;
+    delete: (id: string) => Promise<void>;
+  };
+  users: {
+    findById: (id: string) => Promise<unknown>;
+    findByEmail: (email: string) => Promise<unknown>;
+  };
+}
+
+export interface PluginAPI {
+  readonly pluginName: string;
+  readonly services: PluginServices;
+  hooks: HookRegistrar;
+  routes: RouteRegistrar;
+  mcp: MCPRegistrar;
+  database: unknown;
+  contentTypes: ContentTypeRegistrar;
+  config: ConfigAccessor;
+  logger: PluginLogger;
+}
+
+export interface PluginDefinition {
+  name: string;
+  displayName?: string;
+  version: string;
+  description?: string;
+  lifecycle?: PluginLifecycle;
+  setup: (api: PluginAPI) => Promise<void> | void;
+}
+
+// ============================================================================
+// Stripe Plugin Specific Types
+// ============================================================================
+
+export interface StripeConfig {
+  secretKey: string;
+  webhookSecret: string;
+  successUrl: string;
+  cancelUrl: string;
+  portalReturnUrl: string;
+  currency: string;
+}
+
+export type PriceType = 'one_time' | 'recurring';
+export type PriceInterval = 'day' | 'week' | 'month' | 'year';
+export type SubscriptionStatus =
+  | 'active'
+  | 'canceled'
+  | 'incomplete'
+  | 'incomplete_expired'
+  | 'past_due'
+  | 'trialing'
+  | 'unpaid'
+  | 'paused';
+
+export type InvoiceStatus = 'draft' | 'open' | 'paid' | 'void' | 'uncollectible';
+
+export interface StripeProduct {
+  id: string;
+  name: string;
+  description?: string;
+  active: boolean;
+  metadata?: Record<string, string>;
+}
+
+export interface StripePrice {
+  id: string;
+  productId: string;
+  active: boolean;
+  currency: string;
+  unitAmount: number;
+  type: PriceType;
+  interval?: PriceInterval;
+  intervalCount?: number;
+  trialPeriodDays?: number;
+}
+
+export interface StripeCustomer {
+  id: string;
+  email: string;
+  name?: string;
+  metadata?: Record<string, string>;
+}
+
+export interface StripeSubscription {
+  id: string;
+  customerId: string;
+  priceId: string;
+  status: SubscriptionStatus;
+  currentPeriodStart: number;
+  currentPeriodEnd: number;
+  cancelAtPeriodEnd: boolean;
+  canceledAt?: number;
+  trialStart?: number;
+  trialEnd?: number;
+}
+
+export interface StripeInvoice {
+  id: string;
+  customerId: string;
+  subscriptionId?: string;
+  status: InvoiceStatus;
+  amountDue: number;
+  amountPaid: number;
+  currency: string;
+  hostedInvoiceUrl?: string;
+  invoicePdf?: string;
+  paidAt?: number;
+}
+
+export interface CheckoutSessionParams {
+  priceId: string;
+  customerId?: string;
+  customerEmail?: string;
+  userId?: string;
+  mode: 'payment' | 'subscription';
+  quantity?: number;
+  trialPeriodDays?: number;
+  metadata?: Record<string, string>;
+}
+
+export interface PortalSessionParams {
+  customerId: string;
+  returnUrl?: string;
+}
+
+export interface WebhookEvent {
+  id: string;
+  type: string;
+  data: {
+    object: unknown;
+    previous_attributes?: unknown;
+  };
+}