@pelican.ts/sdk 0.2.3 → 0.2.4

package/src/api/application/users.ts

@@ -4,6 +4,7 @@ import {GenericListResponse, GenericResponse} from "@/api/base/types";
 import {User} from "@/api/application/types/user";
 import {ArrayQueryParams, SortParam} from "@/utils/transform";
 import {ExactlyOneKey} from "@/utils/types";
+import {languagesSchema, timezonesSchema} from "@/api/common/types/enums";
 
 
 export class Users {
@@ -14,7 +15,7 @@ export class Users {
     }
 
     list = async (
-        {...opts}: ListType,
+        opts: ListType,
         page: number = 1
     ): Promise<User[]> => {
         z.number().positive().parse(page)
@@ -50,23 +51,26 @@ export class Users {
     infoByExternal = async (
         external_id: string,
         {include}: { include?: ("servers")[] }
-        ): Promise<User> => {
+    ): Promise<User> => {
         const {data} = await this.r.get<
             GenericResponse<User, "user">
-        >(`/users/external/${external_id}`)
+        >(`/users/external/${external_id}`, {
+            params: {include: include?.join(",")}
+        })
         return data.attributes
     }
 
-    create = async (user: CreateType): Promise<User> => {
+    create = async (user: z.infer<typeof CreateSchema>): Promise<User> => {
+        user = CreateSchema.parse(user)
         const {data} = await this.r.post<
             GenericResponse<User, "user">
         >("/users", user)
         return data.attributes
     }
 
-    update = async (id: number, user: UpdateType): Promise<User> => {
-        z.number().positive().parse(id)
-        const {data} = await this.r.put<
+    update = async (id: number, user: z.infer<typeof CreateSchema>): Promise<User> => {
+        user = CreateSchema.parse(user)
+        const {data} = await this.r.patch<
             GenericResponse<User, "user">
         >(`/users/${id}`, user)
         return data.attributes
@@ -77,6 +81,15 @@ export class Users {
         await this.r.delete(`/users/${id}`)
     }
 
+    addRoles = async (id: number, roles: number[]): Promise<void> => {
+        z.number().positive().parse(id)
+        await this.r.patch(`/users/${id}/roles/assign`, {roles})
+    }
+
+    removeRoles = async (id: number, roles: number[]): Promise<void> => {
+        z.number().positive().parse(id)
+        await this.r.patch(`/users/${id}/roles/remove`, {roles})
+    }
 }
 
 type ListType = {
@@ -90,14 +103,11 @@ type ListFilters = {
 
 type ListSort = ExactlyOneKey<"id" | "uuid", "asc" | "desc">
 
-type CreateType = {
-    email: string,
-    username: string,
-    first_name: string,
-    last_name: string
-}
-
-type UpdateType = CreateType & {
-    language: string
-    password: string
-}
+const CreateSchema = z.object({
+    email: z.email(),
+    external_id: z.string().max(255).optional(),
+    username: z.string().min(1).max(255),
+    password: z.string().optional(),
+    language: languagesSchema,
+    timezone: timezonesSchema
+})

package/src/api/base/request.ts

@@ -7,12 +7,12 @@ export class Agent {
     private readonly token: string
     readonly requester: AxiosInstance
 
-    constructor(url: string, token: string, type: "client" | "application") {
-        this.base_url = z.url("Invalid URL Schema").parse(url)
+    constructor(url: string, token: string, type: "client" | "application", suffix: string = "/api") {
+        this.base_url = z.url("Invalid URL Schema").transform(url => new URL(url).href).parse(url)
         this.token = z.string().regex(/^(ptl[ac]|pacc|papp)_.+$/, "Invalid token type").parse(token)
 
         this.requester = axios.create({
-            baseURL: this.base_url.replace(/\/+$/, "")+`/api/${type}`,
+            baseURL: this.base_url.replace(/\/+$/, "")+`${suffix}/${type}`,
             timeout: 3000,
             headers: {
                 Authorization: `Bearer ${this.token}`

package/src/api/client/server_allocations.ts

@@ -1,6 +1,6 @@
 import {AxiosInstance} from "axios";
 import {GenericListResponse, GenericResponse} from "@/api/base/types";
-import {Allocation} from "@/api/common/types/server_allocations";
+import {Allocation} from "@/api/client/types/server_allocation";
 
 export class ServerAllocations {
     private readonly r: AxiosInstance

package/src/api/client/server_databases.ts

@@ -1,7 +1,7 @@
 import {AxiosInstance} from "axios";
 import z from "zod";
 import {GenericListResponse, GenericResponse} from "@/api/base/types";
-import {Database} from "@/api/common/types/server_database";
+import {ServerDatabase} from "@/api/common/types/server_database";
 // TODO: Check for validity
 
 export class ServerDatabases {
@@ -15,26 +15,26 @@ export class ServerDatabases {
 
     list = async (
         include?: ("password")[], page: number = 1
-    ): Promise<Database[]> => {
+    ): Promise<ServerDatabase[]> => {
         z.number().positive().parse(page)
         const {data} = await this.r.get<
-            GenericListResponse<GenericResponse<Database, "server_database">>
+            GenericListResponse<GenericResponse<ServerDatabase, "server_database">>
         >(`/servers/${this.id}/databases`, {
             params: {include: include?.join(","), page}
         })
         return data.data.map(d => d.attributes)
     }
 
-    create = async (database: string, remote: string): Promise<Database> => {
+    create = async (database: string, remote: string): Promise<ServerDatabase> => {
         const {data} = await this.r.post<
-            GenericResponse<Database, "server_database">
+            GenericResponse<ServerDatabase, "server_database">
         >(`/servers/${this.id}/databases`, {database, remote})
         return data.attributes
     }
 
-    rotatePassword = async (database_id: string): Promise<Database> => {
+    rotatePassword = async (database_id: string): Promise<ServerDatabase> => {
         const {data} = await this.r.post<
-            GenericResponse<Database, "server_database">
+            GenericResponse<ServerDatabase, "server_database">
         >(`/servers/${this.id}/databases/${database_id}/rotate-password`)
         return data.attributes
     }

package/src/api/client/types/server.ts

@@ -2,7 +2,7 @@ import {GenericListResponse, GenericResponse} from "@/api/base/types";
 import {EggVariable} from "@/api/common/types/egg";
 import {ServerSubuser} from "@/api/client/types/server_subuser";
 import {FeatureLimits, ServerLimits} from "@/api/common/types/server_limits";
-import {Allocation} from "@/api/common/types/server_allocations";
+import {Allocation} from "@/api/client/types/server_allocation";
 import {Nullable} from "@/utils/types";
 
 export type Server = {

package/src/api/client/types/server_allocation.ts

@@ -0,0 +1,11 @@
+import {Nullable} from "@/utils/types";
+
+
+export type Allocation = {
+    id: number,
+    ip: string,
+    alias: Nullable<string>,
+    port: number,
+    notes: Nullable<string>,
+    is_default: boolean
+}

package/src/api/common/types/enums.ts

@@ -0,0 +1,21 @@
+import z from "zod";
+
+export const languagesSchema = z.enum([
+    "af", "ak", "am", "ar", "as", "az", "be", "bg", "bm", "bn", "bo", "br", "bs", "ca", "ce", "cs", "cv", "cy",
+    "da", "de", "dz", "ee", "el", "en", "eo", "es", "et", "eu", "fa", "ff", "fi", "fo", "fr", "fy", "ga", "gd",
+    "gl", "gu", "gv", "ha", "he", "hi", "hr", "hu", "hy", "ia", "id", "ig", "ii", "is", "it", "ja", "jv", "ka",
+    "ki", "kk", "kl", "km", "kn", "ko", "ks", "ku", "kw", "ky", "lb", "lg", "ln", "lo", "lt", "lu", "lv", "mg",
+    "mi", "mk", "ml", "mn", "mr", "ms", "mt", "my", "nb", "nd", "ne", "nl", "nn", "no", "om", "or", "os", "pa",
+    "pl", "ps", "pt", "qu", "rm", "rn", "ro", "ru", "rw", "sa", "sc", "sd", "se", "sg", "si", "sk", "sl", "sn",
+    "so", "sq", "sr", "su", "sv", "sw", "ta", "te", "tg", "th", "ti", "tk", "to", "tr", "tt", "ug", "uk", "ur",
+    "uz", "vi", "wo", "xh", "yi", "yo", "zh", "zu"
+])
+
+export type LanguagesType = z.infer<typeof languagesSchema>
+
+// Questionable choices at their finest
+export const timezonesSchema = z.enum([
+    "Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmara", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/Buenos_Aires", "America/Argentina/Catamarca", "America/Argentina/Cordoba", "America/Argentina/Jujuy", "America/Argentina/La_Rioja", "America/Argentina/Mendoza", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Atikokan", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Ciudad_Juarez", "America/Costa_Rica", "America/Coyhaique", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Fort_Nelson", "America/Fortaleza", "America/Glace_Bay", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Indianapolis", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Juneau", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Nuuk", "America/Ojinaga", "America/Panama", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Velho", "America/Puerto_Rico", "America/Punta_Arenas", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/Syowa", "Antarctica/Troll", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Atyrau", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Barnaul", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Chita", "Asia/Colombo", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Famagusta", "Asia/Gaza", "Asia/Hebron", "Asia/Ho_Chi_Minh", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Kathmandu", "Asia/Khandyga", "Asia/Kolkata", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Asia/Qyzylorda", "Asia/Riyadh", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Srednekolymsk", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Thimphu", "Asia/Tokyo", "Asia/Tomsk", "Asia/Ulaanbaatar", "Asia/Urumqi", "Asia/Ust-Nera", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yangon", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faroe", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/Perth", "Australia/Sydney", "Europe/Amsterdam", "Europe/Andorra", "Europe/Astrakhan", "Europe/Athens", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Busingen", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kirov", "Europe/Kyiv", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Saratov", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Ulyanovsk", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zurich", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "Pacific/Apia", "Pacific/Auckland", "Pacific/Bougainville", "Pacific/Chatham", "Pacific/Chuuk", "Pacific/Easter", "Pacific/Efate", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Kanton", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Pohnpei", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Wake", "Pacific/Wallis", "UTC"
+])
+
+export type TimezonesType = z.infer<typeof timezonesSchema>

package/src/api/common/types/server_database.ts

@@ -1,6 +1,6 @@
 import {GenericResponse} from "@/api/base/types";
 
-export type Database = {
+export type ServerDatabase = {
     id: string,
     host: {
         address: string,

package/src/index.ts

@@ -3,15 +3,15 @@ import {Client as AppClient} from "@/api/application/client";
 import {Agent} from "@/api/base/request";
 
 export class PelicanClient extends UserClient{
-    constructor(url: string, token: string) {
-        const ax = new Agent(url, token, "client")
+    constructor(url: string, token: string, suffix: string = "/api") {
+        const ax = new Agent(url, token, "client", suffix)
         super(ax.requester)
     }
 }
 
 export class PelicanApplication extends AppClient{
-    constructor(url: string, token: string) {
-        const ax = new Agent(url, token, "application")
+    constructor(url: string, token: string, suffix: string = "/api") {
+        const ax = new Agent(url, token, "application", suffix)
         super(ax.requester)
     }
 }