kirby-types 1.1.1 → 1.2.0

package/src/panel/api.d.ts

@@ -71,41 +71,33 @@ export interface PanelApiAuth {
    * @param data - Login credentials
    * @returns User data
    */
-  login: (data: PanelApiLoginData) => Promise<unknown>;
+  login: (data: PanelApiLoginData) => Promise<any>;
 
   /**
    * Logs out the current user.
    */
-  logout: () => Promise<void>;
+  logout: () => Promise<any>;
 
   /**
    * Pings the server to keep session alive.
    */
-  ping: () => Promise<void>;
+  ping: () => Promise<any>;
 
   /**
    * Gets the current user.
    *
    * @param query - Query parameters
-   * @param options - Request options
    * @returns User data
    */
-  user: (
-    query?: Record<string, unknown>,
-    options?: PanelApiRequestOptions,
-  ) => Promise<unknown>;
+  user: (query?: Record<string, any>) => Promise<any>;
 
   /**
    * Verifies a 2FA code.
    *
    * @param code - Verification code
-   * @param data - Additional data
    * @returns Verification result
    */
-  verifyCode: (
-    code: string,
-    data?: Record<string, unknown>,
-  ) => Promise<unknown>;
+  verifyCode: (code: string) => Promise<any>;
 }
 
 // -----------------------------------------------------------------------------
@@ -130,7 +122,7 @@ export interface PanelApiFiles {
     parent: string | null,
     filename: string,
     to: string,
-  ) => Promise<unknown>;
+  ) => Promise<any>;
 
   /**
    * Deletes a file.
@@ -138,7 +130,7 @@ export interface PanelApiFiles {
    * @param parent - Parent page/site path
    * @param filename - Filename to delete
    */
-  delete: (parent: string | null, filename: string) => Promise<void>;
+  delete: (parent: string | null, filename: string) => Promise<any>;
 
   /**
    * Gets a file.
@@ -151,8 +143,8 @@ export interface PanelApiFiles {
   get: (
     parent: string | null,
     filename: string,
-    query?: Record<string, unknown>,
-  ) => Promise<unknown>;
+    query?: Record<string, any>,
+  ) => Promise<any>;
 
   /**
    * Converts file ID/UUID to API format.
@@ -183,8 +175,8 @@ export interface PanelApiFiles {
   update: (
     parent: string | null,
     filename: string,
-    data: Record<string, unknown>,
-  ) => Promise<unknown>;
+    data: Record<string, any>,
+  ) => Promise<any>;
 
   /**
    * Gets API URL for a file.
@@ -228,18 +220,17 @@ export interface PanelApiLanguages {
   /**
    * Creates a new language.
    *
-   * @param code - Language code
-   * @param data - Language data
+   * @param data - Language data (including code)
    * @returns Created language
    */
-  create: (code: string, data: PanelApiLanguageData) => Promise<unknown>;
+  create: (data: PanelApiLanguageData) => Promise<any>;
 
   /**
    * Deletes a language.
    *
    * @param code - Language code
    */
-  delete: (code: string) => Promise<void>;
+  delete: (code: string) => Promise<any>;
 
   /**
    * Gets a language.
@@ -247,14 +238,14 @@ export interface PanelApiLanguages {
    * @param code - Language code
    * @returns Language data
    */
-  get: (code: string) => Promise<unknown>;
+  get: (code: string) => Promise<any>;
 
   /**
    * Lists all languages.
    *
    * @returns Array of languages
    */
-  list: () => Promise<unknown[]>;
+  list: () => Promise<any[]>;
 
   /**
    * Updates a language.
@@ -263,10 +254,7 @@ export interface PanelApiLanguages {
    * @param data - Updated data
    * @returns Updated language
    */
-  update: (
-    code: string,
-    data: Partial<PanelApiLanguageData>,
-  ) => Promise<unknown>;
+  update: (code: string, data: Partial<PanelApiLanguageData>) => Promise<any>;
 }
 
 // -----------------------------------------------------------------------------
@@ -284,7 +272,7 @@ export interface PanelApiPageCreateData {
   /** Page template */
   template?: string;
   /** Initial content */
-  content?: Record<string, unknown>;
+  content?: Record<string, any>;
   /** Initial status */
   status?: "draft" | "unlisted" | "listed";
 }
@@ -311,7 +299,7 @@ export interface PanelApiPages {
    * @param parent - Page ID
    * @returns Blueprint data
    */
-  blueprint: (parent: string) => Promise<unknown>;
+  blueprint: (parent: string) => Promise<any>;
 
   /**
    * Gets available blueprints for a page.
@@ -320,7 +308,7 @@ export interface PanelApiPages {
    * @param section - Section name
    * @returns Array of blueprints
    */
-  blueprints: (parent: string, section?: string) => Promise<unknown[]>;
+  blueprints: (parent: string, section?: string) => Promise<any[]>;
 
   /**
    * Changes a page's slug.
@@ -329,7 +317,7 @@ export interface PanelApiPages {
    * @param slug - New slug
    * @returns Updated page
    */
-  changeSlug: (id: string, slug: string) => Promise<unknown>;
+  changeSlug: (id: string, slug: string) => Promise<any>;
 
   /**
    * Changes a page's status.
@@ -343,7 +331,7 @@ export interface PanelApiPages {
     id: string,
     status: "draft" | "unlisted" | "listed",
     position?: number,
-  ) => Promise<unknown>;
+  ) => Promise<any>;
 
   /**
    * Changes a page's template.
@@ -352,7 +340,7 @@ export interface PanelApiPages {
    * @param template - New template
    * @returns Updated page
    */
-  changeTemplate: (id: string, template: string) => Promise<unknown>;
+  changeTemplate: (id: string, template: string) => Promise<any>;
 
   /**
    * Changes a page's title.
@@ -361,7 +349,7 @@ export interface PanelApiPages {
    * @param title - New title
    * @returns Updated page
    */
-  changeTitle: (id: string, title: string) => Promise<unknown>;
+  changeTitle: (id: string, title: string) => Promise<any>;
 
   /**
    * Searches children pages.
@@ -370,7 +358,7 @@ export interface PanelApiPages {
    * @param query - Search query
    * @returns Search results
    */
-  children: (id: string, query?: PanelApiSearchQuery) => Promise<unknown>;
+  children: (id: string, query?: PanelApiSearchQuery) => Promise<any>;
 
   /**
    * Creates a new page.
@@ -379,10 +367,7 @@ export interface PanelApiPages {
    * @param data - Page data
    * @returns Created page
    */
-  create: (
-    parent: string | null,
-    data: PanelApiPageCreateData,
-  ) => Promise<unknown>;
+  create: (parent: string | null, data: PanelApiPageCreateData) => Promise<any>;
 
   /**
    * Deletes a page.
@@ -390,7 +375,7 @@ export interface PanelApiPages {
    * @param id - Page ID
    * @param data - Delete options
    */
-  delete: (id: string, data?: { force?: boolean }) => Promise<void>;
+  delete: (id: string, data?: { force?: boolean }) => Promise<any>;
 
   /**
    * Duplicates a page.
@@ -404,7 +389,7 @@ export interface PanelApiPages {
     id: string,
     slug: string,
     options?: PanelApiPageDuplicateOptions,
-  ) => Promise<unknown>;
+  ) => Promise<any>;
 
   /**
    * Gets a page.
@@ -413,7 +398,7 @@ export interface PanelApiPages {
    * @param query - Query parameters
    * @returns Page data
    */
-  get: (id: string, query?: Record<string, unknown>) => Promise<unknown>;
+  get: (id: string, query?: Record<string, any>) => Promise<any>;
 
   /**
    * Converts page ID/UUID to API format.
@@ -430,7 +415,7 @@ export interface PanelApiPages {
    * @param query - Search query
    * @returns Search results
    */
-  files: (id: string, query?: PanelApiSearchQuery) => Promise<unknown>;
+  files: (id: string, query?: PanelApiSearchQuery) => Promise<any>;
 
   /**
    * Gets Panel link for a page.
@@ -455,10 +440,7 @@ export interface PanelApiPages {
    * @param query - Search query
    * @returns Search results
    */
-  search: (
-    parent: string | null,
-    query?: PanelApiSearchQuery,
-  ) => Promise<unknown>;
+  search: (parent: string | null, query?: PanelApiSearchQuery) => Promise<any>;
 
   /**
    * Updates a page's content.
@@ -467,7 +449,7 @@ export interface PanelApiPages {
    * @param data - Content data
    * @returns Updated page
    */
-  update: (id: string, data: Record<string, unknown>) => Promise<unknown>;
+  update: (id: string, data: Record<string, any>) => Promise<any>;
 
   /**
    * Gets API URL for a page.
@@ -495,16 +477,15 @@ export interface PanelApiRoles {
    * @param name - Role name
    * @returns Role data
    */
-  get: (name: string) => Promise<unknown>;
+  get: (name: string) => Promise<any>;
 
   /**
    * Lists available roles.
    *
-   * @param user - User ID for context
-   * @param query - Query parameters
+   * @param params - Query parameters
    * @returns Array of roles
    */
-  list: (user?: string, query?: Record<string, unknown>) => Promise<unknown[]>;
+  list: (params?: Record<string, any>) => Promise<any[]>;
 }
 
 // -----------------------------------------------------------------------------
@@ -522,35 +503,30 @@ export interface PanelApiSite {
    *
    * @returns Blueprint data
    */
-  blueprint: () => Promise<unknown>;
+  blueprint: () => Promise<any>;
 
   /**
    * Gets available blueprints for the site.
    *
    * @returns Array of blueprints
    */
-  blueprints: () => Promise<unknown[]>;
+  blueprints: () => Promise<any[]>;
 
   /**
    * Changes the site title.
    *
    * @param title - New title
-   * @param language - Language code
    * @returns Updated site
    */
-  changeTitle: (title: string, language?: string) => Promise<unknown>;
+  changeTitle: (title: string) => Promise<any>;
 
   /**
    * Searches site children.
    *
    * @param query - Search query
-   * @param options - Query options
    * @returns Search results
    */
-  children: (
-    query?: PanelApiSearchQuery,
-    options?: Record<string, unknown>,
-  ) => Promise<unknown>;
+  children: (query?: PanelApiSearchQuery) => Promise<any>;
 
   /**
    * Gets the site.
@@ -558,19 +534,15 @@ export interface PanelApiSite {
    * @param query - Query parameters
    * @returns Site data
    */
-  get: (query?: Record<string, unknown>) => Promise<unknown>;
+  get: (query?: Record<string, any>) => Promise<any>;
 
   /**
    * Updates the site content.
    *
    * @param data - Content data
-   * @param language - Language code
    * @returns Updated site
    */
-  update: (
-    data: Record<string, unknown>,
-    language?: string,
-  ) => Promise<unknown>;
+  update: (data: Record<string, any>) => Promise<any>;
 }
 
 // -----------------------------------------------------------------------------
@@ -611,31 +583,23 @@ export interface PanelApiSystem {
    * @param query - Query parameters
    * @returns System data
    */
-  get: (query?: Record<string, unknown>) => Promise<unknown>;
+  get: (query?: Record<string, any>) => Promise<any>;
 
   /**
    * Installs Kirby with initial user.
    *
    * @param data - Installation data
-   * @param query - Query parameters
    * @returns Installation result
    */
-  install: (
-    data: PanelApiSystemInstallData,
-    query?: Record<string, unknown>,
-  ) => Promise<unknown>;
+  install: (data: PanelApiSystemInstallData) => Promise<any>;
 
   /**
    * Registers a license.
    *
    * @param data - Registration data
-   * @param query - Query parameters
    * @returns Registration result
    */
-  register: (
-    data: PanelApiSystemRegisterData,
-    query?: Record<string, unknown>,
-  ) => Promise<unknown>;
+  register: (data: PanelApiSystemRegisterData) => Promise<any>;
 }
 
 // -----------------------------------------------------------------------------
@@ -654,14 +618,14 @@ export interface PanelApiTranslations {
    * @param code - Translation code
    * @returns Translation data
    */
-  get: (code: string) => Promise<unknown>;
+  get: (code: string) => Promise<any>;
 
   /**
    * Lists all translations.
    *
    * @returns Array of translations
    */
-  list: () => Promise<unknown[]>;
+  list: () => Promise<any[]>;
 }
 
 // -----------------------------------------------------------------------------
@@ -696,19 +660,16 @@ export interface PanelApiUsers {
    * @param id - User ID
    * @returns Blueprint data
    */
-  blueprint: (id: string) => Promise<unknown>;
+  blueprint: (id: string) => Promise<any>;
 
   /**
    * Gets available blueprints for users.
    *
-   * @param user - User ID for context
-   * @param query - Query parameters
+   * @param id - User ID for context
+   * @param section - Section name to filter by
    * @returns Array of blueprints
    */
-  blueprints: (
-    user?: string,
-    query?: Record<string, unknown>,
-  ) => Promise<unknown[]>;
+  blueprints: (id: string, section?: string) => Promise<any[]>;
 
   /**
    * Changes a user's email.
@@ -717,7 +678,7 @@ export interface PanelApiUsers {
    * @param email - New email
    * @returns Updated user
    */
-  changeEmail: (id: string, email: string) => Promise<unknown>;
+  changeEmail: (id: string, email: string) => Promise<any>;
 
   /**
    * Changes a user's language.
@@ -726,7 +687,7 @@ export interface PanelApiUsers {
    * @param language - New language code
    * @returns Updated user
    */
-  changeLanguage: (id: string, language: string) => Promise<unknown>;
+  changeLanguage: (id: string, language: string) => Promise<any>;
 
   /**
    * Changes a user's name.
@@ -735,21 +696,21 @@ export interface PanelApiUsers {
    * @param name - New name
    * @returns Updated user
    */
-  changeName: (id: string, name: string) => Promise<unknown>;
+  changeName: (id: string, name: string) => Promise<any>;
 
   /**
    * Changes a user's password.
    *
    * @param id - User ID
    * @param password - New password
-   * @param confirmation - Password confirmation
+   * @param currentPassword - Current password for verification
    * @returns Updated user
    */
   changePassword: (
     id: string,
     password: string,
-    confirmation: string,
-  ) => Promise<unknown>;
+    currentPassword: string,
+  ) => Promise<any>;
 
   /**
    * Changes a user's role.
@@ -758,30 +719,29 @@ export interface PanelApiUsers {
    * @param role - New role
    * @returns Updated user
    */
-  changeRole: (id: string, role: string) => Promise<unknown>;
+  changeRole: (id: string, role: string) => Promise<any>;
 
   /**
    * Creates a new user.
    *
-   * @param id - User ID (usually email)
-   * @param data - User data
+   * @param data - User data (including email as identifier)
    * @returns Created user
    */
-  create: (id: string, data: PanelApiUserCreateData) => Promise<unknown>;
+  create: (data: PanelApiUserCreateData) => Promise<any>;
 
   /**
    * Deletes a user.
    *
    * @param id - User ID
    */
-  delete: (id: string) => Promise<void>;
+  delete: (id: string) => Promise<any>;
 
   /**
    * Deletes a user's avatar.
    *
    * @param id - User ID
    */
-  deleteAvatar: (id: string) => Promise<void>;
+  deleteAvatar: (id: string) => Promise<any>;
 
   /**
    * Gets a user.
@@ -790,7 +750,7 @@ export interface PanelApiUsers {
    * @param query - Query parameters
    * @returns User data
    */
-  get: (id: string, query?: Record<string, unknown>) => Promise<unknown>;
+  get: (id: string, query?: Record<string, any>) => Promise<any>;
 
   /**
    * Gets Panel link for a user.
@@ -807,7 +767,7 @@ export interface PanelApiUsers {
    * @param query - Query parameters
    * @returns Array of users
    */
-  list: (query?: Record<string, unknown>) => Promise<unknown[]>;
+  list: (query?: Record<string, any>) => Promise<any[]>;
 
   /**
    * Gets roles available to a user.
@@ -815,7 +775,7 @@ export interface PanelApiUsers {
    * @param id - User ID
    * @returns Array of roles
    */
-  roles: (id: string) => Promise<unknown[]>;
+  roles: (id: string) => Promise<any[]>;
 
   /**
    * Searches users.
@@ -826,8 +786,8 @@ export interface PanelApiUsers {
    */
   search: (
     query?: PanelApiSearchQuery,
-    options?: Record<string, unknown>,
-  ) => Promise<unknown>;
+    options?: Record<string, any>,
+  ) => Promise<any>;
 
   /**
    * Updates a user's content.
@@ -836,7 +796,7 @@ export interface PanelApiUsers {
    * @param data - Content data
    * @returns Updated user
    */
-  update: (id: string, data: Record<string, unknown>) => Promise<unknown>;
+  update: (id: string, data: Record<string, any>) => Promise<any>;
 
   /**
    * Gets API URL for a user.
@@ -860,13 +820,13 @@ export interface PanelApiUsers {
  * @example
  * ```ts
  * // Get a page
- * const page = await panel.api.pages.get('home');
+ * const page = await panel.api.pages.get("home");
  *
  * // Create a new page
- * await panel.api.pages.create('blog', {
- *   slug: 'new-post',
- *   title: 'New Post',
- *   template: 'article'
+ * await panel.api.pages.create("blog", {
+ *   slug: "new-post",
+ *   title: "New Post",
+ *   template: "article"
  * });
  * ```
  *
@@ -906,7 +866,7 @@ export interface PanelApi {
     path: string,
     options?: PanelApiRequestOptions,
     silent?: boolean,
-  ) => Promise<unknown>;
+  ) => Promise<any>;
 
   /**
    * Makes a GET request.
@@ -919,10 +879,10 @@ export interface PanelApi {
    */
   get: (
     path: string,
-    query?: Record<string, unknown>,
+    query?: Record<string, any>,
     options?: PanelApiRequestOptions,
     silent?: boolean,
-  ) => Promise<unknown>;
+  ) => Promise<any>;
 
   /**
    * Makes a POST request.
@@ -931,16 +891,14 @@ export interface PanelApi {
    * @param data - Request body
    * @param options - Request options
    * @param silent - Skip loading indicator
-   * @param upload - Whether uploading file
    * @returns Response data
    */
   post: (
     path: string,
-    data?: unknown,
+    data?: any,
     options?: PanelApiRequestOptions,
     silent?: boolean,
-    upload?: boolean,
-  ) => Promise<unknown>;
+  ) => Promise<any>;
 
   /**
    * Makes a PATCH request.
@@ -953,10 +911,10 @@ export interface PanelApi {
    */
   patch: (
     path: string,
-    data?: unknown,
+    data?: any,
     options?: PanelApiRequestOptions,
     silent?: boolean,
-  ) => Promise<unknown>;
+  ) => Promise<any>;
 
   /**
    * Makes a DELETE request.
@@ -969,10 +927,10 @@ export interface PanelApi {
    */
   delete: (
     path: string,
-    data?: unknown,
+    data?: any,
     options?: PanelApiRequestOptions,
     silent?: boolean,
-  ) => Promise<unknown>;
+  ) => Promise<any>;
 
   /** Authentication methods */
   auth: PanelApiAuth;