@pelican.ts/sdk 0.3.3-next.3 → 0.3.3-next.5

package/dist/index.d.mts

@@ -556,6 +556,7 @@ declare class Client$1 {
     account: Account;
     private readonly r;
     constructor(requester: AxiosInstance);
+    get $r(): AxiosInstance;
     listPermissions: () => Promise<Record<string, Permission>>;
     listServers: (type?: "accessible" | "mine" | "admin" | "admin-all", page?: number, per_page?: number, include?: ("egg" | "subusers")[]) => Promise<Server[]>;
     server: (uuid: string) => ServerClient;
@@ -608,6 +609,19 @@ type ApplicationUser = {
         servers: GenericListResponse<GenericResponse<ApplicationServer>>;
     };
 };
+type ApplicationUserApiKey = {
+    id: number;
+    user_id: number;
+    key_type: 1;
+    identifier: string;
+    memo: string;
+    allowed_ips: Array<string>;
+    permissions: [];
+    last_used_at: Nullable<string>;
+    expires_at: Nullable<string>;
+    created_at: string;
+    updated_at: string;
+};
 
 declare class Users {
     private readonly r;
@@ -624,6 +638,13 @@ declare class Users {
     delete: (id: number) => Promise<void>;
     addRoles: (id: number, roles: number[]) => Promise<void>;
     removeRoles: (id: number, roles: number[]) => Promise<void>;
+    apiKeys: {
+        list: (id: number) => Promise<ApplicationUserApiKey[]>;
+        create: (id: number, description: string, allowed_ips?: string[]) => Promise<ApplicationUserApiKey & {
+            secret_token: string;
+        }>;
+        delete: (id: number, identifier: string) => Promise<void>;
+    };
 }
 type ListType = {
     include?: ("servers")[];
@@ -1571,6 +1592,7 @@ declare class Client {
     eggs: Eggs;
     mounts: Mounts;
     constructor(requester: AxiosInstance);
+    get $r(): AxiosInstance;
     listServers: (search?: string, page?: number) => Promise<ApplicationServer[]>;
     createServer: (opts: z.infer<typeof CreateServerSchema>) => Promise<ApplicationServer>;
     getServerByExternalId: (external_id: string, include?: ("egg" | "subusers")[]) => Promise<ApplicationServer>;

package/dist/index.d.ts

@@ -556,6 +556,7 @@ declare class Client$1 {
     account: Account;
     private readonly r;
     constructor(requester: AxiosInstance);
+    get $r(): AxiosInstance;
     listPermissions: () => Promise<Record<string, Permission>>;
     listServers: (type?: "accessible" | "mine" | "admin" | "admin-all", page?: number, per_page?: number, include?: ("egg" | "subusers")[]) => Promise<Server[]>;
     server: (uuid: string) => ServerClient;
@@ -608,6 +609,19 @@ type ApplicationUser = {
         servers: GenericListResponse<GenericResponse<ApplicationServer>>;
     };
 };
+type ApplicationUserApiKey = {
+    id: number;
+    user_id: number;
+    key_type: 1;
+    identifier: string;
+    memo: string;
+    allowed_ips: Array<string>;
+    permissions: [];
+    last_used_at: Nullable<string>;
+    expires_at: Nullable<string>;
+    created_at: string;
+    updated_at: string;
+};
 
 declare class Users {
     private readonly r;
@@ -624,6 +638,13 @@ declare class Users {
     delete: (id: number) => Promise<void>;
     addRoles: (id: number, roles: number[]) => Promise<void>;
     removeRoles: (id: number, roles: number[]) => Promise<void>;
+    apiKeys: {
+        list: (id: number) => Promise<ApplicationUserApiKey[]>;
+        create: (id: number, description: string, allowed_ips?: string[]) => Promise<ApplicationUserApiKey & {
+            secret_token: string;
+        }>;
+        delete: (id: number, identifier: string) => Promise<void>;
+    };
 }
 type ListType = {
     include?: ("servers")[];
@@ -1571,6 +1592,7 @@ declare class Client {
     eggs: Eggs;
     mounts: Mounts;
     constructor(requester: AxiosInstance);
+    get $r(): AxiosInstance;
     listServers: (search?: string, page?: number) => Promise<ApplicationServer[]>;
     createServer: (opts: z.infer<typeof CreateServerSchema>) => Promise<ApplicationServer>;
     getServerByExternalId: (external_id: string, include?: ("egg" | "subusers")[]) => Promise<ApplicationServer>;

package/dist/index.js

@@ -901,6 +901,9 @@ var Client = class {
     this.r = requester;
     this.account = new Account(requester);
   }
+  get $r() {
+    return this.r;
+  }
   listPermissions = async () => {
     const { data } = await this.r.get("/permissions");
     return data.attributes.permissions;
@@ -1546,6 +1549,20 @@ var Users = class {
     import_zod7.default.number().positive().parse(id);
     await this.r.patch(`/users/${id}/roles/remove`, { roles });
   };
+  apiKeys = {
+    list: async (id) => {
+      const { data } = await this.r.get(`/users/${id}/roles/api-keys`);
+      return data.data.map((k) => k.attributes);
+    },
+    create: async (id, description, allowed_ips) => {
+      allowed_ips = import_zod7.default.array(import_zod7.default.ipv4()).optional().parse(allowed_ips);
+      const { data } = await this.r.post(`/users/${id}/roles/api-keys`, { description, allowed_ips });
+      return { ...data.attributes, secret_token: data.meta.secret_token };
+    },
+    delete: async (id, identifier) => {
+      await this.r.delete(`/users/${id}/roles/api-keys/${identifier}`);
+    }
+  };
 };
 var CreateSchema = import_zod7.default.object({
   email: import_zod7.default.email(),
@@ -1989,6 +2006,9 @@ var Client2 = class {
     this.eggs = new Eggs(requester);
     this.mounts = new Mounts(requester);
   }
+  get $r() {
+    return this.r;
+  }
   listServers = async (search, page = 1) => {
     const { data } = await this.r.get("/servers", {
       params: { search, page }

package/dist/index.mjs

@@ -864,6 +864,9 @@ var Client = class {
     this.r = requester;
     this.account = new Account(requester);
   }
+  get $r() {
+    return this.r;
+  }
   listPermissions = async () => {
     const { data } = await this.r.get("/permissions");
     return data.attributes.permissions;
@@ -1509,6 +1512,20 @@ var Users = class {
     z7.number().positive().parse(id);
     await this.r.patch(`/users/${id}/roles/remove`, { roles });
   };
+  apiKeys = {
+    list: async (id) => {
+      const { data } = await this.r.get(`/users/${id}/roles/api-keys`);
+      return data.data.map((k) => k.attributes);
+    },
+    create: async (id, description, allowed_ips) => {
+      allowed_ips = z7.array(z7.ipv4()).optional().parse(allowed_ips);
+      const { data } = await this.r.post(`/users/${id}/roles/api-keys`, { description, allowed_ips });
+      return { ...data.attributes, secret_token: data.meta.secret_token };
+    },
+    delete: async (id, identifier) => {
+      await this.r.delete(`/users/${id}/roles/api-keys/${identifier}`);
+    }
+  };
 };
 var CreateSchema = z7.object({
   email: z7.email(),
@@ -1952,6 +1969,9 @@ var Client2 = class {
     this.eggs = new Eggs(requester);
     this.mounts = new Mounts(requester);
   }
+  get $r() {
+    return this.r;
+  }
   listServers = async (search, page = 1) => {
     const { data } = await this.r.get("/servers", {
       params: { search, page }

package/dist/types.d.ts

@@ -892,6 +892,19 @@ type ApplicationUser = {
         servers: GenericListResponse<GenericResponse<ApplicationServer>>;
     };
 };
+type ApplicationUserApiKey = {
+    id: number;
+    user_id: number;
+    key_type: 1;
+    identifier: string;
+    memo: string;
+    allowed_ips: Array<string>;
+    permissions: [];
+    last_used_at: Nullable<string>;
+    expires_at: Nullable<string>;
+    created_at: string;
+    updated_at: string;
+};
 
 type ServerStatus = 'starting' | 'stopping' | 'online' | 'offline';
 declare enum SERVER_SIGNAL {
@@ -1119,4 +1132,4 @@ type Permission = {
     keys: Record<string, string>;
 };
 
-export { type APIKey, type Allocation, type AllocationRel, type ApplicationServer, type ApplicationUser, type AuthSuccessWsEvent, type BackupCompletedEvent, type BackupCompletedJson, type BackupRestoreCompletedEvent, type ConsoleLogWsEvent, type Container, type DaemonErrorEvent, type DaemonMessageEvent, type DatabaseHost, type Egg, type EggVariable, type FeatureLimits, type FileObject, type InstallCompletedEvent, type InstallOutputEvent, type InstallStartedEvent, type JwtErrorEvent, type LanguagesType, type Location, type Mount, type Node, type NodeConfiguration, type Permission, type PowerState, type Role, SERVER_SIGNAL, SOCKET_EVENT, type SSHKey, type Schedule, type ScheduleTask, type Server, type ServerActivityLog, type ServerAllocation, type ServerBackup, type ServerDatabase, type ServerLimits, type ServerSignalOption, type ServerStats, type ServerStatus, type ServerSubuser, type StartupMeta, type StartupParams, type StatsWsEvent, type StatsWsJson, type StatusWsEvent, type SubuserPermission, type TimezonesType, type TokenExpiredWsEvent, type TokenExpiringWsEvent, type TransferLogsEvent, type TransferStatusEvent, type User, type WebsocketEvent, languagesSchema, timezonesSchema };
+export { type APIKey, type Allocation, type AllocationRel, type ApplicationServer, type ApplicationUser, type ApplicationUserApiKey, type AuthSuccessWsEvent, type BackupCompletedEvent, type BackupCompletedJson, type BackupRestoreCompletedEvent, type ConsoleLogWsEvent, type Container, type DaemonErrorEvent, type DaemonMessageEvent, type DatabaseHost, type Egg, type EggVariable, type FeatureLimits, type FileObject, type InstallCompletedEvent, type InstallOutputEvent, type InstallStartedEvent, type JwtErrorEvent, type LanguagesType, type Location, type Mount, type Node, type NodeConfiguration, type Permission, type PowerState, type Role, SERVER_SIGNAL, SOCKET_EVENT, type SSHKey, type Schedule, type ScheduleTask, type Server, type ServerActivityLog, type ServerAllocation, type ServerBackup, type ServerDatabase, type ServerLimits, type ServerSignalOption, type ServerStats, type ServerStatus, type ServerSubuser, type StartupMeta, type StartupParams, type StatsWsEvent, type StatsWsJson, type StatusWsEvent, type SubuserPermission, type TimezonesType, type TokenExpiredWsEvent, type TokenExpiringWsEvent, type TransferLogsEvent, type TransferStatusEvent, type User, type WebsocketEvent, languagesSchema, timezonesSchema };

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@pelican.ts/sdk",
-  "version": "0.3.3-next.3",
+  "version": "0.3.3-next.5",
   "description": "Pelican panel SDK for TypeScript",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
   "exports": {
     ".": {
+      "types": "./dist/index.d.ts",
       "require": "./dist/index.js",
-      "import": "./dist/index.mjs",
-      "types": "./dist/index.d.ts"
+      "import": "./dist/index.mjs"
     },
     "./types": {
       "types": "./dist/types.d.ts"

package/src/api/application/client.ts

@@ -30,6 +30,10 @@ export class Client {
         this.mounts = new Mounts(requester)
     }
 
+    get $r(): AxiosInstance {
+        return this.r
+    }
+
     listServers = async (
         search?: string,
         page: number = 1

package/src/api/application/types/user.ts

@@ -17,4 +17,18 @@ export type ApplicationUser = {
     relationships?: {
         servers: GenericListResponse<GenericResponse<ApplicationServer>>
     }
+}
+
+export type ApplicationUserApiKey = {
+    id: number,
+    user_id: number,
+    key_type: 1,
+    identifier: string,
+    memo: string,
+    allowed_ips: Array<string>,
+    permissions: [],
+    last_used_at: Nullable<string>,
+    expires_at: Nullable<string>,
+    created_at: string,
+    updated_at: string
 }

package/src/api/application/users.ts

@@ -1,10 +1,11 @@
 import {AxiosInstance} from "axios";
 import z from "zod";
 import {GenericListResponse, GenericResponse} from "@/api/base/types";
-import {ApplicationUser} from "@/api/application/types/user";
+import {ApplicationUser, ApplicationUserApiKey} from "@/api/application/types/user";
 import {ArrayQueryParams, SortParam} from "@/utils/transform";
 import {ExactlyOneKey} from "@/utils/types";
 import {languagesSchema, timezonesSchema} from "@/api/common/types/enums";
+import {APIKey} from "@/api/client/types";
 
 
 export class Users {
@@ -90,6 +91,27 @@ export class Users {
         z.number().positive().parse(id)
         await this.r.patch(`/users/${id}/roles/remove`, {roles})
     }
+
+    apiKeys = {
+        list: async (id: number): Promise<ApplicationUserApiKey[]> => {
+            const {data} = await this.r.get<
+                GenericListResponse<GenericResponse<ApplicationUserApiKey, "api_key">>
+            >(`/users/${id}/roles/api-keys`)
+            return data.data.map(k => k.attributes)
+        },
+
+        create: async (id: number, description: string, allowed_ips?: string[]): Promise<ApplicationUserApiKey & { secret_token: string }> => {
+            allowed_ips = z.array(z.ipv4()).optional().parse(allowed_ips)
+            const {data} = await this.r.post<
+                GenericResponse<ApplicationUserApiKey, "api_key", { secret_token: string }>
+            >(`/users/${id}/roles/api-keys`, {description, allowed_ips})
+            return {...data.attributes, secret_token: data.meta!.secret_token}
+        },
+
+        delete: async (id: number, identifier: string): Promise<void> => {
+            await this.r.delete(`/users/${id}/roles/api-keys/${identifier}`)
+        }
+    }
 }
 
 type ListType = {

package/src/api/client/client.ts

@@ -17,6 +17,10 @@ export class Client {
         this.account = new Account(requester)
     }
 
+    get $r(): AxiosInstance {
+        return this.r
+    }
+
     listPermissions = async (): Promise<Record<string, Permission>> => {
         const {data} = await this.r.get<
             GenericResponse<{ permissions: Record<string, Permission> }, "system_permissions">