@inneropen/marvin-sdk 2.0.1 → 3.0.0

package/dist/platform.d.cts

@@ -1,4 +1,5 @@
-import { H as HttpClient } from './HttpClient-CLtgQGXH.cjs';
+import { H as HttpClient } from './HttpClient-CdF3IHM1.cjs';
+import { AuthToken } from './types/index.cjs';
 
 interface components {
     schemas: {
@@ -322,11 +323,6 @@ interface components {
          * @enum {string}
          */
         AuthMethod: "MARVIN" | "LDAP" | "OIDC";
-        /** Body_debug_openai_api_admin_debug_openai_post */
-        Body_debug_openai_api_admin_debug_openai_post: {
-            /** Image */
-            image?: string | null;
-        };
         /** Body_get_token_api_auth_token_post */
         Body_get_token_api_auth_token_post: {
             /**
@@ -506,19 +502,6 @@ interface components {
             /** Entryids */
             entryIds?: string[] | null;
         };
-        /**
-         * DebugResponse
-         * @description Schema for a standardized response from debugging endpoints.
-         *
-         *     Indicates the success status of a debug operation and provides an optional
-         *     response message or data string.
-         */
-        DebugResponse: {
-            /** Success */
-            success: boolean;
-            /** Response */
-            response?: string | null;
-        };
         /**
          * EmailInitationResponse
          * @description Schema for the response after attempting to send an email invitation.
@@ -665,9 +648,15 @@ interface components {
             } | null;
             /** Enabled */
             enabled: boolean;
-            /** Createdat */
+            /**
+             * Createdat
+             * Format: date-time
+             */
             createdAt: string;
-            /** Updateat */
+            /**
+             * Updateat
+             * Format: date-time
+             */
             updateAt: string;
         };
         /**
@@ -943,6 +932,27 @@ interface components {
             /** Order */
             order?: number | null;
         };
+        /**
+         * EntryTypeCapabilities
+         * @description Capabilities for a published entry type.
+         */
+        EntryTypeCapabilities: {
+            /**
+             * Publishable
+             * @default true
+             */
+            publishable: boolean;
+            /**
+             * Submittable
+             * @default false
+             */
+            submittable: boolean;
+            /**
+             * Routable
+             * @default true
+             */
+            routable: boolean;
+        };
         /**
          * EntryTypeCreate
          * @description Schema for creating an entry type.
@@ -968,6 +978,11 @@ interface components {
              * @default false
              */
             isSystem: boolean;
+            /**
+             * Isrendered
+             * @default false
+             */
+            isRendered: boolean;
             /**
              * Schema Json
              * @description Entry type schema definition (EntryTypeSchemaDefinition)
@@ -975,6 +990,20 @@ interface components {
             schema_json?: {
                 [key: string]: unknown;
             } | null;
+            /**
+             * Rendering Json
+             * @description Rendering configuration (RenderingDefinition)
+             */
+            rendering_json?: {
+                [key: string]: unknown;
+            } | null;
+            /**
+             * Capabilities Json
+             * @description Behavioral capabilities (CapabilitiesDefinition)
+             */
+            capabilities_json?: {
+                [key: string]: unknown;
+            } | null;
         };
         /**
          * EntryTypeRead
@@ -1005,6 +1034,11 @@ interface components {
             sortOrder: number;
             /** Issystem */
             isSystem: boolean;
+            /**
+             * Isrendered
+             * @default false
+             */
+            isRendered: boolean;
             /**
              * Schemajson
              * @description Entry type schema definition (EntryTypeSchemaDefinition)
@@ -1012,10 +1046,42 @@ interface components {
             schemaJson?: {
                 [key: string]: unknown;
             } | null;
+            /**
+             * Renderingjson
+             * @description Rendering configuration (RenderingDefinition)
+             */
+            renderingJson?: {
+                [key: string]: unknown;
+            } | null;
+            /**
+             * Capabilitiesjson
+             * @description Behavioral capabilities (CapabilitiesDefinition)
+             */
+            capabilitiesJson?: {
+                [key: string]: unknown;
+            } | null;
             /** Createdat */
             createdAt?: string | null;
             /** Updateat */
             updateAt?: string | null;
+            /** Warnings */
+            warnings?: string[] | null;
+        };
+        /**
+         * EntryTypeRendering
+         * @description Rendering configuration for a published entry type.
+         */
+        EntryTypeRendering: {
+            /** Renderer */
+            renderer?: string | null;
+            /** Package */
+            package?: string | null;
+            /** Version */
+            version?: string | null;
+            /** Config */
+            config?: {
+                [key: string]: unknown;
+            } | null;
         };
         /**
          * EntryTypeUpdate
@@ -1036,6 +1102,8 @@ interface components {
             sortOrder?: number | null;
             /** Issystem */
             isSystem?: boolean | null;
+            /** Isrendered */
+            isRendered?: boolean | null;
             /**
              * Schema Json
              * @description Entry type schema definition (EntryTypeSchemaDefinition)
@@ -1043,6 +1111,20 @@ interface components {
             schema_json?: {
                 [key: string]: unknown;
             } | null;
+            /**
+             * Rendering Json
+             * @description Rendering configuration (RenderingDefinition)
+             */
+            rendering_json?: {
+                [key: string]: unknown;
+            } | null;
+            /**
+             * Capabilities Json
+             * @description Behavioral capabilities (CapabilitiesDefinition)
+             */
+            capabilities_json?: {
+                [key: string]: unknown;
+            } | null;
         };
         /**
          * EntryUpdate
@@ -2096,6 +2178,7 @@ interface components {
             title: string;
             /** Entrytype */
             entryType: string;
+            entryTypeInfo?: components["schemas"]["PublishedEntryTypeInfo"] | null;
             /** Summary */
             summary?: string | null;
             /** Publishedat */
@@ -2137,6 +2220,7 @@ interface components {
             title: string;
             /** Entrytype */
             entryType: string;
+            entryTypeInfo?: components["schemas"]["PublishedEntryTypeInfo"] | null;
             /** Summary */
             summary?: string | null;
             /** Data */
@@ -2167,6 +2251,56 @@ interface components {
             /** Order */
             order?: number | null;
         };
+        /**
+         * PublishedEntryTypeInfo
+         * @description Flattened entry type rendering and capabilities info for published entries.
+         */
+        PublishedEntryTypeInfo: {
+            /** Slug */
+            slug: string;
+            /** Renderer */
+            renderer?: string | null;
+            /** Package */
+            package?: string | null;
+            /** Version */
+            version?: string | null;
+            /** Config */
+            config?: {
+                [key: string]: unknown;
+            } | null;
+            /**
+             * Publishable
+             * @default true
+             */
+            publishable: boolean;
+            /**
+             * Submittable
+             * @default false
+             */
+            submittable: boolean;
+            /**
+             * Routable
+             * @default true
+             */
+            routable: boolean;
+        };
+        /**
+         * PublishedEntryTypeRead
+         * @description Schema for entry types in the publishing API.
+         */
+        PublishedEntryTypeRead: {
+            /** Slug */
+            slug: string;
+            /** Name */
+            name: string;
+            /**
+             * Isrendered
+             * @default false
+             */
+            isRendered: boolean;
+            rendering?: components["schemas"]["EntryTypeRendering"] | null;
+            capabilities?: components["schemas"]["EntryTypeCapabilities"] | null;
+        };
         /**
          * PublishedFormRead
          * @description Schema for published forms in the publishing API.
@@ -3396,9 +3530,19 @@ declare class ResourcesModule {
  * CRUD operations and file upload for assets
  */
 
+interface FileUploadOptions {
+    /** Maximum file size in bytes (default: 100MB) */
+    maxFileSize?: number;
+    /** Allowed MIME types (if not provided, all types allowed) */
+    allowedMimeTypes?: string[];
+}
 declare class AssetsModule {
     private http;
     constructor(http: HttpClient);
+    /**
+     * Validate file before upload
+     */
+    private validateFile;
     /**
      * List all assets
      */
@@ -3412,9 +3556,22 @@ declare class AssetsModule {
      *
      * @param file - The file to upload (File or Blob)
      * @param metadata - Asset metadata (slug, name, altText, description, metadata)
+     * @param options - Upload options (file size limits, allowed types)
      * @returns The created asset with extracted metadata
+     *
+     * @example
+     * ```typescript
+     * // Upload with default limits (100MB, all types)
+     * const asset = await assets.upload(file, { slug: 'my-image', name: 'My Image' });
+     *
+     * // Upload with restrictions
+     * const asset = await assets.upload(file,
+     *   { slug: 'avatar', name: 'Avatar' },
+     *   { maxFileSize: 5 * 1024 * 1024, allowedMimeTypes: ['image/*'] }
+     * );
+     * ```
      */
-    upload(file: File | Blob, metadata: PlatformAssetUpload): Promise<PlatformAsset>;
+    upload(file: File | Blob, metadata: PlatformAssetUpload, options?: FileUploadOptions): Promise<PlatformAsset>;
     /**
      * Update an asset (editable fields only: slug, name, altText, description, metadata)
      */
@@ -3423,6 +3580,11 @@ declare class AssetsModule {
      * Delete an asset (removes file from storage and database)
      */
     delete(id: string): Promise<void>;
+    /**
+     * Get download URL for an asset file
+     * Use this to create download links or fetch the file directly
+     */
+    getDownloadUrl(id: string, baseUrl?: string): string;
 }
 
 /**
@@ -3475,7 +3637,10 @@ interface EntryTypeCreate {
     icon?: string;
     color?: string;
     sortOrder?: number;
+    isRendered?: boolean;
     schemaJson?: Record<string, unknown>;
+    renderingJson?: Record<string, unknown>;
+    capabilitiesJson?: Record<string, unknown>;
 }
 interface EntryTypeUpdate {
     name?: string;
@@ -3484,7 +3649,10 @@ interface EntryTypeUpdate {
     icon?: string;
     color?: string;
     sortOrder?: number;
+    isRendered?: boolean;
     schemaJson?: Record<string, unknown>;
+    renderingJson?: Record<string, unknown>;
+    capabilitiesJson?: Record<string, unknown>;
 }
 declare class EntryTypesModule {
     private http;
@@ -3571,11 +3739,21 @@ interface WorkspaceUpdate {
     name?: string;
     description?: string | null;
 }
+/**
+ * Workspace preferences - dynamic key-value store
+ * Common keys include: theme, locale, notifications, etc.
+ */
 interface WorkspacePreferences {
-    [key: string]: any;
+    theme?: string;
+    locale?: string;
+    notifications?: boolean;
+    [key: string]: unknown;
 }
 interface WorkspacePreferencesUpdate {
-    [key: string]: any;
+    theme?: string;
+    locale?: string;
+    notifications?: boolean;
+    [key: string]: unknown;
 }
 declare class WorkspacesModule {
     private http;
@@ -3609,6 +3787,13 @@ declare class WorkspacesModule {
      * Delete a workspace (requires SUPER_ADMIN)
      */
     delete(id: string, force?: boolean): Promise<void>;
+    /**
+     * Export workspace data as JSON (collections, entry types, entries, site config)
+     */
+    export(options?: {
+        includeSystemTypes?: boolean;
+        pretty?: boolean;
+    }): Promise<Record<string, unknown>>;
     /**
      * Get workspace preferences
      */
@@ -3657,7 +3842,19 @@ declare class InvitesModule {
     delete(tokenId: string): Promise<void>;
     /**
      * Generate invitation URL from a token
-     * Uses MARVIN_FRONTEND_URL for the base URL, falls back to MARVIN_API_URL with common port mappings
+     *
+     * @param token - Invitation token
+     * @param baseUrl - Base URL for the frontend (required in browser environments)
+     * @returns Full invitation URL
+     *
+     * @example
+     * ```typescript
+     * // Node.js (can use env vars)
+     * const url = invites.getInvitationUrl(token);
+     *
+     * // Browser (must provide baseUrl)
+     * const url = invites.getInvitationUrl(token, 'https://app.example.com');
+     * ```
      */
     getInvitationUrl(token: string, baseUrl?: string): string;
 }
@@ -3743,6 +3940,10 @@ interface WebhookUpdate {
 declare class WebhooksModule {
     private http;
     constructor(http: HttpClient);
+    /**
+     * Validate webhook URL to prevent SSRF attacks
+     */
+    private validateWebhookUrl;
     /**
      * List all webhooks for the current workspace
      */
@@ -3753,10 +3954,12 @@ declare class WebhooksModule {
     get(id: string): Promise<Webhook>;
     /**
      * Create a new webhook
+     * Validates URL to prevent SSRF attacks
      */
     create(data: WebhookCreate): Promise<Webhook>;
     /**
      * Update a webhook
+     * Validates URL if provided to prevent SSRF attacks
      */
     update(id: string, data: WebhookUpdate): Promise<Webhook>;
     /**
@@ -3836,7 +4039,22 @@ declare class AdminUsersModule {
  */
 
 type AdminAboutInfo = components['schemas']['AdminAboutInfo'];
+/**
+ * Email settings returned from API (read-only)
+ * Password is never returned for security reasons
+ */
 interface EmailSettings {
+    host?: string;
+    port?: number;
+    username?: string;
+    from?: string;
+    useTls?: boolean;
+}
+/**
+ * Email settings for updates (write-only)
+ * Password can be provided to update settings
+ */
+interface EmailSettingsUpdate {
     host?: string;
     port?: number;
     username?: string;
@@ -3852,6 +4070,18 @@ interface SystemStatistics {
     resources?: number;
     assets?: number;
 }
+interface StartupInfo {
+    version: string;
+    api_port: number;
+    api_docs: boolean;
+    database_url: string;
+    database_provider: string;
+    default_group?: string;
+    allow_signup: boolean;
+    theme?: string;
+    custom_middleware?: string[];
+    [key: string]: unknown;
+}
 declare class AdminSystemModule {
     private http;
     constructor(http: HttpClient);
@@ -3868,7 +4098,7 @@ declare class AdminSystemModule {
     /**
      * Get startup information
      */
-    getStartupInfo(): Promise<any>;
+    getStartupInfo(): Promise<StartupInfo>;
     /**
      * Get system statistics
      */
@@ -3879,8 +4109,9 @@ declare class AdminSystemModule {
     getEmailSettings(): Promise<EmailSettings>;
     /**
      * Update email settings
+     * Note: Password field is write-only and will not be returned in response
      */
-    updateEmailSettings(data: EmailSettings): Promise<EmailSettings>;
+    updateEmailSettings(data: EmailSettingsUpdate): Promise<EmailSettings>;
 }
 
 /**
@@ -4138,10 +4369,6 @@ declare class EventLogModule {
  * Authenticated session management (logout, refresh)
  */
 
-interface AuthToken {
-    accessToken: string;
-    tokenType: string;
-}
 declare class AuthModule {
     private http;
     constructor(http: HttpClient);
@@ -4212,7 +4439,7 @@ interface EmailTemplateSummary {
     description?: string;
     enabled: boolean;
     created_at: string;
-    update_at: string;
+    updated_at: string;
 }
 interface EmailTemplateRead extends EmailTemplateSummary {
     subject: string;
@@ -4366,6 +4593,13 @@ declare class ScheduledTasksModule {
 declare class FormsModule {
     private http;
     constructor(http: HttpClient);
+    /**
+     * Validate form submission data
+     * - Prevents XSS by checking for script tags
+     * - Validates data is a proper object
+     * - Checks for reasonable size limits
+     */
+    private validateFormData;
     /**
      * List all forms
      */
@@ -4396,6 +4630,7 @@ declare class FormsModule {
     getPublishedForm(slug: string): Promise<PlatformForm>;
     /**
      * Submit data to a published form (Publishing API - public access)
+     * Validates data before submission to prevent XSS and malicious content
      */
     submitForm(slug: string, data: Record<string, unknown>): Promise<PlatformFormSubmission>;
 }
@@ -4407,10 +4642,11 @@ declare class FormsModule {
  */
 
 interface PlatformClientConfig {
-    apiUrl: string;
+    apiUrl?: string;
     userToken?: string;
     credentials?: RequestCredentials;
 }
+declare function createPlatformConfigFromEnv(overrides?: Partial<PlatformClientConfig>): PlatformClientConfig;
 declare class PlatformClient extends HttpClient {
     entries: EntriesModule;
     collections: CollectionsModule;
@@ -4438,7 +4674,23 @@ declare class PlatformClient extends HttpClient {
 }
 /**
  * Create a Platform API client
+ *
+ * @example
+ * ```ts
+ * // From environment (MARVIN_API_URL, MARVIN_USER_TOKEN)
+ * const platform = createPlatformClient();
+ *
+ * // With explicit user token (for programmatic admin)
+ * const platform = createPlatformClient({
+ *   userToken: 'user-token-here'
+ * });
+ *
+ * // Browser with session cookies (admin UI)
+ * const platform = createPlatformClient({
+ *   credentials: 'include'
+ * });
+ * ```
  */
-declare function createPlatformClient(config: PlatformClientConfig): PlatformClient;
+declare function createPlatformClient(config?: Partial<PlatformClientConfig>): PlatformClient;
 
-export { APIClientsModule, type AdminAboutInfo, AdminMaintenanceModule, AdminSystemModule, AdminUsersModule, type ApiToken, type ApiTokenCreate, type ApiTokenWithToken, type AppTheme, AssetsModule, AuthModule, type AuthToken, CollectionsModule, type EmailInvitationRequest, type EmailSettings, type EmailTemplateCreate, type EmailTemplateRead, type EmailTemplateSummary, type EmailTemplateUpdate, EmailTemplatesClient, EntriesModule, EntryTypesModule, type EventLogEntry, EventLogModule, type EventLogQueryParams, type EventLogSummary, type EventOption, EventsModule, FormsModule, type InviteTokenCreate, type InviteTokenPagination, type InviteTokenSummary, InvitesModule, type MaintenanceStorageDetails, type MaintenanceSummary, type Notification, type NotificationCreate, type NotificationUpdate, NotificationsModule, type PasswordChange, type PasswordResetTokenRequest, type PasswordResetTokenResponse, type PlatformAPIClient, type PlatformAPIClientCreate, type PlatformAPIClientUpdate, type PlatformAPIClientWithToken, type PlatformAsset, type PlatformAssetUpdate, PlatformClient, type PlatformClientConfig, type PlatformCollection, type PlatformCollectionCreate, type PlatformCollectionUpdate, type PlatformEntry, type PlatformEntryCreate, type PlatformEntryType, type PlatformEntryUpdate, type PlatformForm, type PlatformFormCreate, type PlatformFormSubmission, type PlatformFormUpdate, type PlatformResource, type PlatformResourceCreate, type PlatformResourceUpdate, type PlatformWorkspaceMember, type PlatformWorkspaceMemberCreate, type PlatformWorkspaceMemberUpdate, ResourcesModule, type ScheduledTask, type ScheduledTaskCreate, type ScheduledTaskExecutionLog, type ScheduledTaskUpdate, ScheduledTasksModule, type SystemStatistics, type TaskTypeInfo, type TestEmailRequest, type TestEmailResponse, ThemeModule, type UnlockUserRequest, type User, type UserCreate, UserModule, type UserPagination, type UserProfile, type UserProfileUpdate, type UserSummary, type UserUpdate, type Webhook, type WebhookCreate, type WebhookMethod, type WebhookPagination, type WebhookUpdate, WebhooksModule, type Workspace, type WorkspaceActivationRequest, type WorkspaceCreate, WorkspaceMembersModule, type WorkspacePreferences, type WorkspacePreferencesUpdate, type WorkspaceUpdate, type WorkspaceWithMembership, WorkspacesModule, createPlatformClient };
+export { APIClientsModule, type AdminAboutInfo, AdminMaintenanceModule, AdminSystemModule, AdminUsersModule, type ApiToken, type ApiTokenCreate, type ApiTokenWithToken, type AppTheme, AssetsModule, AuthModule, CollectionsModule, type EmailInvitationRequest, type EmailSettings, type EmailSettingsUpdate, type EmailTemplateCreate, type EmailTemplateRead, type EmailTemplateSummary, type EmailTemplateUpdate, EmailTemplatesClient, EntriesModule, EntryTypesModule, type EventLogEntry, EventLogModule, type EventLogQueryParams, type EventLogSummary, type EventOption, EventsModule, FormsModule, type InviteTokenCreate, type InviteTokenPagination, type InviteTokenSummary, InvitesModule, type MaintenanceStorageDetails, type MaintenanceSummary, type Notification, type NotificationCreate, type NotificationUpdate, NotificationsModule, type PasswordChange, type PasswordResetTokenRequest, type PasswordResetTokenResponse, type PlatformAPIClient, type PlatformAPIClientCreate, type PlatformAPIClientUpdate, type PlatformAPIClientWithToken, type PlatformAsset, type PlatformAssetUpdate, PlatformClient, type PlatformClientConfig, type PlatformCollection, type PlatformCollectionCreate, type PlatformCollectionUpdate, type PlatformEntry, type PlatformEntryCreate, type PlatformEntryType, type PlatformEntryUpdate, type PlatformForm, type PlatformFormCreate, type PlatformFormSubmission, type PlatformFormUpdate, type PlatformResource, type PlatformResourceCreate, type PlatformResourceUpdate, type PlatformWorkspaceMember, type PlatformWorkspaceMemberCreate, type PlatformWorkspaceMemberUpdate, ResourcesModule, type ScheduledTask, type ScheduledTaskCreate, type ScheduledTaskExecutionLog, type ScheduledTaskUpdate, ScheduledTasksModule, type StartupInfo, type SystemStatistics, type TaskTypeInfo, type TestEmailRequest, type TestEmailResponse, ThemeModule, type UnlockUserRequest, type User, type UserCreate, UserModule, type UserPagination, type UserProfile, type UserProfileUpdate, type UserSummary, type UserUpdate, type Webhook, type WebhookCreate, type WebhookMethod, type WebhookPagination, type WebhookUpdate, WebhooksModule, type Workspace, type WorkspaceActivationRequest, type WorkspaceCreate, WorkspaceMembersModule, type WorkspacePreferences, type WorkspacePreferencesUpdate, type WorkspaceUpdate, type WorkspaceWithMembership, WorkspacesModule, createPlatformClient, createPlatformConfigFromEnv };