@pelican.ts/sdk 0.4.16-next.3 → 0.5.0

package/dist/index.js

@@ -727,6 +727,7 @@ var timezonesSchema = import_zod7.default.enum([
 var CreateSchema = import_zod8.default.object({
   email: import_zod8.default.email(),
   external_id: import_zod8.default.string().max(255).optional(),
+  is_managed_externally: import_zod8.default.boolean().optional().default(false),
   username: import_zod8.default.string().min(1).max(255),
   password: import_zod8.default.string().optional(),
   language: languagesSchema,
@@ -1735,6 +1736,9 @@ var Account2 = class {
   language;
   image;
   admin;
+  /**
+   * Has currently no significance
+   */
   root_admin;
   $has2faEnabled;
   get has2faEnabled() {
@@ -1792,14 +1796,24 @@ var ServerAllocation = class {
     this.$notes = alloc.notes;
     this.port = alloc.port;
   }
+  /**
+   * Set description for this allocation
+   * @param notes
+   */
   setNotes = async (notes) => {
     const data = await this.client.allocations.setNotes(this.id, notes);
     this.$notes = data.notes;
   };
+  /**
+   * Make port primary
+   */
   makeDefault = async () => {
     const data = await this.client.allocations.setPrimary(this.id);
     this.$isDefault = data.is_default;
   };
+  /**
+   * Remove allocation (if user is allowed to manage allocations by themselves)
+   */
   unassign = async () => this.client.allocations.unassign(this.id);
 };
 
@@ -1860,6 +1874,9 @@ var ServerDatabase = class {
     this.$password = database.relationships?.password.attributes.password;
     this.username = database.username;
   }
+  /**
+   * Reset password to a random one, password will be updated in this ServerDatabase instance
+   */
   rotatePassword = async () => {
     const data = await this.client.databases.rotatePassword(this.id);
     this.$password = data.relationships?.password.attributes.password;
@@ -1896,6 +1913,12 @@ var ServerFile = class _ServerFile {
     this.size = file.size;
     this.path = import_node_path.default.join(dir, this.name);
   }
+  /**
+   * Is this file an archive
+   *
+   * @remarks
+   * It uses extension check instead of mimetype as Pelican currently has some issue with mimetypes
+   */
   get isArchive() {
     return [
       "zip",
@@ -1935,15 +1958,24 @@ var ServerSchedule = class {
   client;
   createdAt;
   $cron;
+  /**
+   * CRON representation of schedule
+   */
   get cron() {
     return { ...this.$cron };
   }
   id;
   $isActive;
+  /**
+   * Is this schedule enabled
+   */
   get isActive() {
     return this.$isActive;
   }
   $isProcessing;
+  /**
+   * Is this schedule currently running
+   */
   get isProcessing() {
     return this.$isProcessing;
   }
@@ -1954,6 +1986,9 @@ var ServerSchedule = class {
   }
   nextRunAt;
   $onlyWhenOnline;
+  /**
+   * Should schedule run only if server is online
+   */
   get onlyWhenOnline() {
     return this.$onlyWhenOnline;
   }
@@ -1994,28 +2029,46 @@ var ServerScheduleTask = class {
   client;
   scheduleId;
   $action;
+  /**
+   * Task action (command would likely need server to be online)
+   */
   get action() {
     return this.$action;
   }
   $continueOnFailure;
+  /**
+   * Should we fail on error or continue with other tasks?
+   */
   get continueOnFailure() {
     return this.$continueOnFailure;
   }
   createdAt;
   id;
   $isQueued;
+  /**
+   * Is this task queued right now?
+   */
   get isQueued() {
     return this.$isQueued;
   }
   $payload;
+  /**
+   * Whatever task should do: command to execute, power action or list of files to backup
+   */
   get payload() {
     return this.$payload;
   }
   $sequenceId;
+  /**
+   * Order of this task in defined schedule
+   */
   get sequenceId() {
     return this.$sequenceId;
   }
   $timeOffset;
+  /**
+   * Time offset in seconds relative to schedule start time
+   */
   get timeOffset() {
     return this.$timeOffset;
   }
@@ -2058,6 +2111,10 @@ var ServerUser = class {
   language;
   image;
   admin;
+  /**
+   * Currently unused
+   * @deprecated
+   */
   root_admin;
   has2faEnabled;
   createdAt;
@@ -2107,7 +2164,8 @@ var Server = class {
   }
   /**
    * Node name used by this server
-   * @
+   * @remarks
+   * This is the name of the node used by this server, not the ID
    */
   node;
   isNodeUnderMaintenance;
@@ -2117,6 +2175,9 @@ var Server = class {
     return this.$description;
   }
   limits;
+  /**
+   * It's a Startup command used to start the server
+   */
   invocation;
   $dockerImage;
   get dockerImage() {
@@ -2129,8 +2190,17 @@ var Server = class {
   isInstalling;
   isTransferring;
   allocations;
+  /**
+   * Egg variables
+   */
   variables;
+  /**
+   * Egg used by this server, available only if request had include=egg
+   */
   egg;
+  /**
+   * Server subusers, available only if request had include=subusers
+   */
   subusers;
   constructor(client, server) {
     this.client = client;
@@ -2185,6 +2255,14 @@ var Server = class {
     const data = await this.client.databases.list(opts.include, opts.page);
     return data.map((d) => new ServerDatabase(this.client, d));
   };
+  /**
+   * Create a database
+   * @param database - optional database name (leave blank for autogenerated)
+   * @param remote - allow connections from (ip, % or anything db-wise)
+   *
+   * @remarks
+   * I have no idea why API endpoint doesn't allow to select database host
+   */
   createDatabase = async (database, remote) => {
     const data = await this.client.databases.create(database, remote);
     return new ServerDatabase(this.client, data);
@@ -2209,6 +2287,9 @@ var Server = class {
     const data = await this.client.allocations.list();
     return data.map((d) => new ServerAllocation(this.client, d));
   };
+  /**
+   * Create new allocation (if user is allowed to manage allocations by themselves)
+   */
   createAllocation = async () => {
     const data = await this.client.allocations.autoAssign();
     return new ServerAllocation(this.client, data);
@@ -2220,6 +2301,9 @@ var Server = class {
   createFolder = async (...opts) => this.client.files.createFolder(...opts);
   uploadFile = async (...opts) => this.client.files.upload(...opts);
   uploadFileGetUrl = async (...opts) => this.client.files.uploadGetUrl(...opts);
+  /**
+   * Make wings agent download file or archive folder from specified URL instead of uploading directly
+   */
   pullFileFromRemote = async (...opts) => this.client.files.pullFromRemote(...opts);
   compressMultipleFiles = async (...opts) => this.client.files.compress(...opts);
   renameMultipleFiles = async (...opts) => this.client.files.rename(...opts);
@@ -2228,10 +2312,18 @@ var Server = class {
     const data = await this.client.users.list();
     return data.map((d) => new ServerUser(this.client, d));
   };
+  /**
+   * Create a subuser
+   * @param email
+   * @param permissions
+   */
   createUser = async (email, permissions) => {
     const data = await this.client.users.create(email, permissions);
     return new ServerUser(this.client, data);
   };
+  /**
+   * Get server egg variables and startup commands
+   */
   getStartupInfo = async () => this.client.startup.list();
   setStartupVariable = async (key, value) => this.client.startup.set(key, value);
 };
@@ -2265,6 +2357,15 @@ var Client3 = class {
    * List servers
    *
    * @param opts Filtering options (all optional)
+   *
+   * @remarks
+   * `type` — Server access type (Default: accessible)
+   *
+   * Variants:
+   * - `accessible` — your servers and servers you have access to as a subuser
+   * - `mine` — only your servers
+   * - `admin` — only servers you have admin access to (excluding yours)
+   * - `admin-all` — all servers you have admin access to
    */
   listServers = async (opts = { type: "accessible", page: 1, per_page: 50 }) => {
     const data = await this.client.listServers(

package/dist/index.mjs

@@ -682,6 +682,7 @@ var timezonesSchema = z7.enum([
 var CreateSchema = z8.object({
   email: z8.email(),
   external_id: z8.string().max(255).optional(),
+  is_managed_externally: z8.boolean().optional().default(false),
   username: z8.string().min(1).max(255),
   password: z8.string().optional(),
   language: languagesSchema,
@@ -1690,6 +1691,9 @@ var Account2 = class {
   language;
   image;
   admin;
+  /**
+   * Has currently no significance
+   */
   root_admin;
   $has2faEnabled;
   get has2faEnabled() {
@@ -1747,14 +1751,24 @@ var ServerAllocation = class {
     this.$notes = alloc.notes;
     this.port = alloc.port;
   }
+  /**
+   * Set description for this allocation
+   * @param notes
+   */
   setNotes = async (notes) => {
     const data = await this.client.allocations.setNotes(this.id, notes);
     this.$notes = data.notes;
   };
+  /**
+   * Make port primary
+   */
   makeDefault = async () => {
     const data = await this.client.allocations.setPrimary(this.id);
     this.$isDefault = data.is_default;
   };
+  /**
+   * Remove allocation (if user is allowed to manage allocations by themselves)
+   */
   unassign = async () => this.client.allocations.unassign(this.id);
 };
 
@@ -1815,6 +1829,9 @@ var ServerDatabase = class {
     this.$password = database.relationships?.password.attributes.password;
     this.username = database.username;
   }
+  /**
+   * Reset password to a random one, password will be updated in this ServerDatabase instance
+   */
   rotatePassword = async () => {
     const data = await this.client.databases.rotatePassword(this.id);
     this.$password = data.relationships?.password.attributes.password;
@@ -1851,6 +1868,12 @@ var ServerFile = class _ServerFile {
     this.size = file.size;
     this.path = path.join(dir, this.name);
   }
+  /**
+   * Is this file an archive
+   *
+   * @remarks
+   * It uses extension check instead of mimetype as Pelican currently has some issue with mimetypes
+   */
   get isArchive() {
     return [
       "zip",
@@ -1890,15 +1913,24 @@ var ServerSchedule = class {
   client;
   createdAt;
   $cron;
+  /**
+   * CRON representation of schedule
+   */
   get cron() {
     return { ...this.$cron };
   }
   id;
   $isActive;
+  /**
+   * Is this schedule enabled
+   */
   get isActive() {
     return this.$isActive;
   }
   $isProcessing;
+  /**
+   * Is this schedule currently running
+   */
   get isProcessing() {
     return this.$isProcessing;
   }
@@ -1909,6 +1941,9 @@ var ServerSchedule = class {
   }
   nextRunAt;
   $onlyWhenOnline;
+  /**
+   * Should schedule run only if server is online
+   */
   get onlyWhenOnline() {
     return this.$onlyWhenOnline;
   }
@@ -1949,28 +1984,46 @@ var ServerScheduleTask = class {
   client;
   scheduleId;
   $action;
+  /**
+   * Task action (command would likely need server to be online)
+   */
   get action() {
     return this.$action;
   }
   $continueOnFailure;
+  /**
+   * Should we fail on error or continue with other tasks?
+   */
   get continueOnFailure() {
     return this.$continueOnFailure;
   }
   createdAt;
   id;
   $isQueued;
+  /**
+   * Is this task queued right now?
+   */
   get isQueued() {
     return this.$isQueued;
   }
   $payload;
+  /**
+   * Whatever task should do: command to execute, power action or list of files to backup
+   */
   get payload() {
     return this.$payload;
   }
   $sequenceId;
+  /**
+   * Order of this task in defined schedule
+   */
   get sequenceId() {
     return this.$sequenceId;
   }
   $timeOffset;
+  /**
+   * Time offset in seconds relative to schedule start time
+   */
   get timeOffset() {
     return this.$timeOffset;
   }
@@ -2013,6 +2066,10 @@ var ServerUser = class {
   language;
   image;
   admin;
+  /**
+   * Currently unused
+   * @deprecated
+   */
   root_admin;
   has2faEnabled;
   createdAt;
@@ -2062,7 +2119,8 @@ var Server = class {
   }
   /**
    * Node name used by this server
-   * @
+   * @remarks
+   * This is the name of the node used by this server, not the ID
    */
   node;
   isNodeUnderMaintenance;
@@ -2072,6 +2130,9 @@ var Server = class {
     return this.$description;
   }
   limits;
+  /**
+   * It's a Startup command used to start the server
+   */
   invocation;
   $dockerImage;
   get dockerImage() {
@@ -2084,8 +2145,17 @@ var Server = class {
   isInstalling;
   isTransferring;
   allocations;
+  /**
+   * Egg variables
+   */
   variables;
+  /**
+   * Egg used by this server, available only if request had include=egg
+   */
   egg;
+  /**
+   * Server subusers, available only if request had include=subusers
+   */
   subusers;
   constructor(client, server) {
     this.client = client;
@@ -2140,6 +2210,14 @@ var Server = class {
     const data = await this.client.databases.list(opts.include, opts.page);
     return data.map((d) => new ServerDatabase(this.client, d));
   };
+  /**
+   * Create a database
+   * @param database - optional database name (leave blank for autogenerated)
+   * @param remote - allow connections from (ip, % or anything db-wise)
+   *
+   * @remarks
+   * I have no idea why API endpoint doesn't allow to select database host
+   */
   createDatabase = async (database, remote) => {
     const data = await this.client.databases.create(database, remote);
     return new ServerDatabase(this.client, data);
@@ -2164,6 +2242,9 @@ var Server = class {
     const data = await this.client.allocations.list();
     return data.map((d) => new ServerAllocation(this.client, d));
   };
+  /**
+   * Create new allocation (if user is allowed to manage allocations by themselves)
+   */
   createAllocation = async () => {
     const data = await this.client.allocations.autoAssign();
     return new ServerAllocation(this.client, data);
@@ -2175,6 +2256,9 @@ var Server = class {
   createFolder = async (...opts) => this.client.files.createFolder(...opts);
   uploadFile = async (...opts) => this.client.files.upload(...opts);
   uploadFileGetUrl = async (...opts) => this.client.files.uploadGetUrl(...opts);
+  /**
+   * Make wings agent download file or archive folder from specified URL instead of uploading directly
+   */
   pullFileFromRemote = async (...opts) => this.client.files.pullFromRemote(...opts);
   compressMultipleFiles = async (...opts) => this.client.files.compress(...opts);
   renameMultipleFiles = async (...opts) => this.client.files.rename(...opts);
@@ -2183,10 +2267,18 @@ var Server = class {
     const data = await this.client.users.list();
     return data.map((d) => new ServerUser(this.client, d));
   };
+  /**
+   * Create a subuser
+   * @param email
+   * @param permissions
+   */
   createUser = async (email, permissions) => {
     const data = await this.client.users.create(email, permissions);
     return new ServerUser(this.client, data);
   };
+  /**
+   * Get server egg variables and startup commands
+   */
   getStartupInfo = async () => this.client.startup.list();
   setStartupVariable = async (key, value) => this.client.startup.set(key, value);
 };
@@ -2220,6 +2312,15 @@ var Client3 = class {
    * List servers
    *
    * @param opts Filtering options (all optional)
+   *
+   * @remarks
+   * `type` — Server access type (Default: accessible)
+   *
+   * Variants:
+   * - `accessible` — your servers and servers you have access to as a subuser
+   * - `mine` — only your servers
+   * - `admin` — only servers you have admin access to (excluding yours)
+   * - `admin-all` — all servers you have admin access to
    */
   listServers = async (opts = { type: "accessible", page: 1, per_page: 50 }) => {
     const data = await this.client.listServers(