@pelican.ts/sdk 0.3.3-next.6 → 0.3.4-next.1

package/dist/index.d.mts

@@ -11,7 +11,6 @@ type ExactlyOneKey<K extends keyof any, V, KK extends keyof any = K> = {
         [Q in keyof O]: O[Q];
     } : never;
 }[K];
-type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;
 type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
 type Nullable<T> = T | null;
 
@@ -1511,7 +1510,7 @@ type Egg = {
     description: string;
     features: string[];
     tags: string[];
-    docker_image: string;
+    docker_image: Nullable<string>;
     docker_images: Record<string, string>;
     config: {
         files: Record<string, FileConfig>;
@@ -1537,6 +1536,38 @@ type FileConfig = {
     parser: string;
     find: Record<string, string>;
 };
+type ApplicationEggVariable = Omit<EggVariable, "server_value" | "is_editable" | "rules"> & {
+    rules: string[];
+    sort: number;
+    user_viewable: boolean;
+    user_editable: boolean;
+};
+type ExportedEgg = {
+    meta: {
+        version: "PLCN_v3";
+        update_url: Nullable<string>;
+    };
+    exported_at: string;
+    name: number;
+    author: string;
+    description: string;
+    uuid: string;
+    image: Nullable<string>;
+    docker_images: Record<string, string>;
+    features: string[];
+    tags: string[];
+    file_denylist: string[];
+    startup_commands: Record<string, string>;
+    config: Omit<Egg["config"], "extends" | "file_denylist">;
+    scripts: {
+        installation: {
+            script: string;
+            container: string;
+            entrypoint: string;
+        };
+    };
+    variables: ApplicationEggVariable[];
+};
 
 declare class Eggs {
     private readonly r;
@@ -1544,6 +1575,7 @@ declare class Eggs {
     list: () => Promise<Egg[]>;
     info: (id: number) => Promise<Egg>;
     export: (id: number, format: "json" | "yaml") => Promise<string>;
+    infoExportable: (id: number) => Promise<ExportedEgg>;
 }
 
 type Mount = {

package/dist/index.d.ts

@@ -11,7 +11,6 @@ type ExactlyOneKey<K extends keyof any, V, KK extends keyof any = K> = {
         [Q in keyof O]: O[Q];
     } : never;
 }[K];
-type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;
 type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
 type Nullable<T> = T | null;
 
@@ -1511,7 +1510,7 @@ type Egg = {
     description: string;
     features: string[];
     tags: string[];
-    docker_image: string;
+    docker_image: Nullable<string>;
     docker_images: Record<string, string>;
     config: {
         files: Record<string, FileConfig>;
@@ -1537,6 +1536,38 @@ type FileConfig = {
     parser: string;
     find: Record<string, string>;
 };
+type ApplicationEggVariable = Omit<EggVariable, "server_value" | "is_editable" | "rules"> & {
+    rules: string[];
+    sort: number;
+    user_viewable: boolean;
+    user_editable: boolean;
+};
+type ExportedEgg = {
+    meta: {
+        version: "PLCN_v3";
+        update_url: Nullable<string>;
+    };
+    exported_at: string;
+    name: number;
+    author: string;
+    description: string;
+    uuid: string;
+    image: Nullable<string>;
+    docker_images: Record<string, string>;
+    features: string[];
+    tags: string[];
+    file_denylist: string[];
+    startup_commands: Record<string, string>;
+    config: Omit<Egg["config"], "extends" | "file_denylist">;
+    scripts: {
+        installation: {
+            script: string;
+            container: string;
+            entrypoint: string;
+        };
+    };
+    variables: ApplicationEggVariable[];
+};
 
 declare class Eggs {
     private readonly r;
@@ -1544,6 +1575,7 @@ declare class Eggs {
     list: () => Promise<Egg[]>;
     info: (id: number) => Promise<Egg>;
     export: (id: number, format: "json" | "yaml") => Promise<string>;
+    infoExportable: (id: number) => Promise<ExportedEgg>;
 }
 
 type Mount = {

package/dist/index.js

@@ -1919,6 +1919,10 @@ var Eggs = class {
     });
     return data;
   };
+  infoExportable = async (id) => {
+    const { data } = await this.r.get(`/eggs/${id}/export`);
+    return data;
+  };
 };
 
 // src/api/application/mounts.ts

package/dist/index.mjs

@@ -1882,6 +1882,10 @@ var Eggs = class {
     });
     return data;
   };
+  infoExportable = async (id) => {
+    const { data } = await this.r.get(`/eggs/${id}/export`);
+    return data;
+  };
 };
 
 // src/api/application/mounts.ts

package/dist/types.d.ts

@@ -849,7 +849,7 @@ type Egg = {
     description: string;
     features: string[];
     tags: string[];
-    docker_image: string;
+    docker_image: Nullable<string>;
     docker_images: Record<string, string>;
     config: {
         files: Record<string, FileConfig>;
@@ -875,6 +875,38 @@ type FileConfig = {
     parser: string;
     find: Record<string, string>;
 };
+type ApplicationEggVariable = Omit<EggVariable, "server_value" | "is_editable" | "rules"> & {
+    rules: string[];
+    sort: number;
+    user_viewable: boolean;
+    user_editable: boolean;
+};
+type ExportedEgg = {
+    meta: {
+        version: "PLCN_v3";
+        update_url: Nullable<string>;
+    };
+    exported_at: string;
+    name: number;
+    author: string;
+    description: string;
+    uuid: string;
+    image: Nullable<string>;
+    docker_images: Record<string, string>;
+    features: string[];
+    tags: string[];
+    file_denylist: string[];
+    startup_commands: Record<string, string>;
+    config: Omit<Egg["config"], "extends" | "file_denylist">;
+    scripts: {
+        installation: {
+            script: string;
+            container: string;
+            entrypoint: string;
+        };
+    };
+    variables: ApplicationEggVariable[];
+};
 
 type ApplicationUser = {
     id: number;
@@ -1132,4 +1164,4 @@ type Permission = {
     keys: Record<string, string>;
 };
 
-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 };
+export { type APIKey, type Allocation, type AllocationRel, type ApplicationEggVariable, 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 ExportedEgg, 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,6 +1,6 @@
 {
   "name": "@pelican.ts/sdk",
-  "version": "0.3.3-next.6",
+  "version": "0.3.4-next.1",
   "description": "Pelican panel SDK for TypeScript",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",

package/src/api/application/eggs.ts

@@ -1,6 +1,6 @@
 import {AxiosInstance} from "axios";
 import {GenericListResponse, GenericResponse} from "@/api/base/types";
-import {Egg} from "@/api/application/types/egg";
+import {Egg, ExportedEgg} from "@/api/application/types/egg";
 
 // TODO: API is incomplete
 
@@ -28,4 +28,9 @@ export class Eggs {
         })
         return data
     }
+
+    infoExportable = async (id: number): Promise<ExportedEgg> => {
+        const {data} = await this.r.get<ExportedEgg>(`/eggs/${id}/export`)
+        return data
+    }
 }

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

@@ -1,4 +1,5 @@
 import {Nullable} from "@/utils/types";
+import {EggVariable} from "@/api/common/types";
 
 export type Egg = {
     id: number,
@@ -8,7 +9,7 @@ export type Egg = {
     description: string,
     features: string[],
     tags: string[],
-    docker_image: string,
+    docker_image: Nullable<string>,
     docker_images: Record<string, string>,
     config: {
         files: Record<string, FileConfig>
@@ -34,4 +35,38 @@ export type Egg = {
 type FileConfig = {
     parser: string,
     find: Record<string, string>
+}
+
+export type ApplicationEggVariable = Omit<EggVariable, "server_value" | "is_editable" | "rules"> & {
+    rules: string[],
+    sort: number,
+    user_viewable: boolean,
+    user_editable: boolean,
+}
+
+export type ExportedEgg = {
+    meta: {
+        version: "PLCN_v3",
+        update_url: Nullable<string>
+    },
+    exported_at: string,
+    name: number,
+    author: string,
+    description: string,
+    uuid: string,
+    image: Nullable<string>
+    docker_images: Record<string, string>,
+    features: string[],
+    tags: string[],
+    file_denylist: string[],
+    startup_commands: Record<string, string>,
+    config: Omit<Egg["config"], "extends" | "file_denylist">
+    scripts: {
+        installation: {
+            script: string,
+            container: string,
+            entrypoint: string
+        }
+    },
+    variables: ApplicationEggVariable[]
 }

package/src/utils/types.ts

@@ -5,7 +5,6 @@ export type ExactlyOneKey<K extends keyof any, V, KK extends keyof any = K> =
         { [Q in keyof O]: O[Q] } : never
     }[K];
 
-export type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>
 export type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>