@newfold/huapi-js 1.401.0 → 1.413.0-alpha.0

package/package.json

@@ -10,7 +10,8 @@
     "tslib": "2.4.0"
   },
   "module": "dist/index.ts",
-  "version": "1.401.0",
+  "version": "1.413.0-alpha.0",
+  "sideEffects": false,
   "main": "./src/index.js",
   "types": "./src/index.d.ts",
   "dependencies": {}

package/src/index.d.ts

@@ -3,7 +3,7 @@
  * Do not edit manually.
  * Hosting UAPI
  * Hosting UAPI is an API to expose Hosting, Addons, and Site functionality to a customer-facing Front End such as (Account Manager).
- * OpenAPI spec version: 1.401.0
+ * OpenAPI spec version: 1.413.0
  */
 import axios from 'axios';
 import type { AxiosRequestConfig, AxiosResponse, AxiosError } from 'axios';
@@ -342,7 +342,8 @@ export declare type SitesInfo200 = {
     url: string;
     version: string;
     versionLatest?: string;
-    php_version?: string;
+    /** The Php Version. If unable to determine, it will be NULL */
+    php_version?: string | null;
     updatable?: boolean;
     pending_url?: string;
     meta?: SitesInfo200Meta;
@@ -488,9 +489,6 @@ export declare type HostingSiteAddBody = {
     /** title of the site to be added */
     title: string;
 };
-export declare type HostingSites200RowsItemMeta = {
-    pending_url?: string;
-} | null;
 export declare type HostingSites200RowsItem = {
     id?: string;
     name?: string;
@@ -512,6 +510,9 @@ export declare type HostingSites200 = {
     available_sites?: number;
     rows?: HostingSites200RowsItem[];
 };
+export declare type HostingSites200RowsItemMeta = {
+    pending_url?: string;
+} | null;
 export declare type HostingShellInfo200 = {
     enabled?: boolean;
 };
@@ -650,11 +651,15 @@ export declare type HostingFtpList200SpecialFtpAccountsItem = {
     user?: string;
     homedir?: string;
     type?: string;
+    account?: string;
+    domain?: string;
 };
 export declare type HostingFtpList200FtpAccountsItem = {
     user?: string;
     homedir?: string;
     type?: string;
+    account?: string;
+    domain?: string;
 };
 export declare type HostingFtpList200 = {
     ftp_accounts?: HostingFtpList200FtpAccountsItem[];
@@ -680,6 +685,59 @@ export declare const DomainsType: {
 export declare type DomainsParams = {
     type?: DomainsType;
 };
+export declare type DbList200DatabasesItemUserlistItem = {
+    db?: string;
+    user?: string;
+};
+export declare type DbList200DatabasesItem = {
+    db?: string;
+    size?: string;
+    sizemeg?: string;
+    usercount?: number;
+    userlist?: DbList200DatabasesItemUserlistItem[];
+};
+export declare type DbList200 = {
+    status?: boolean;
+    databases?: DbList200DatabasesItem[];
+};
+export declare type Db200 = {
+    dbname?: string;
+    status?: number;
+    type?: string;
+};
+/**
+ * Type of database
+ */
+export declare type DbBodyType = typeof DbBodyType[keyof typeof DbBodyType];
+export declare const DbBodyType: {
+    readonly mysql: "mysql";
+    readonly postgres: "postgres";
+};
+export declare type DbBody = {
+    /** The name of the database to delete.First 8 characters of account username will be prepended.ex: {username}_{dbname} */
+    dbname: string;
+    /** Type of database */
+    type?: DbBodyType;
+};
+export declare type DbAdd200 = {
+    dbname?: string;
+    status?: number;
+    type?: string;
+};
+/**
+ * Type of database to add
+ */
+export declare type DbAddBodyType = typeof DbAddBodyType[keyof typeof DbAddBodyType];
+export declare const DbAddBodyType: {
+    readonly mysql: "mysql";
+    readonly postgres: "postgres";
+};
+export declare type DbAddBody = {
+    /** The database name. Account username_ will be prepended. Max length is 54 characters */
+    dbname: string;
+    /** Type of database to add */
+    type?: DbAddBodyType;
+};
 export declare type AddonCloudflare200 = {
     status?: string;
     addon_id?: number;
@@ -1360,6 +1418,56 @@ export declare const useAddonCloudflare: <TError = AxiosError<unknown, any>, TCo
     hostingId: number;
     data: AddonCloudflareBody;
 }, TContext>;
+/**
+ * Add a new db to an account
+ * @summary Create a database for an account
+ */
+export declare const dbAdd: (hostingId: number, dbAddBody: DbAddBody, options?: AxiosRequestConfig) => Promise<AxiosResponse<DbAdd200>>;
+export declare type DbAddMutationResult = NonNullable<Awaited<ReturnType<typeof dbAdd>>>;
+export declare type DbAddMutationBody = DbAddBody;
+export declare type DbAddMutationError = AxiosError<unknown>;
+export declare const useDbAdd: <TError = AxiosError<unknown, any>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<AxiosResponse<DbAdd200, any>, TError, {
+        hostingId: number;
+        data: DbAddBody;
+    }, TContext> | undefined;
+    axios?: AxiosRequestConfig<any> | undefined;
+} | undefined) => import("@tanstack/react-query").UseMutationResult<AxiosResponse<DbAdd200, any>, TError, {
+    hostingId: number;
+    data: DbAddBody;
+}, TContext>;
+/**
+ * Delete db account
+ * @summary Delete db account
+ */
+export declare const db: (hostingId: number, dbBody: DbBody, options?: AxiosRequestConfig) => Promise<AxiosResponse<Db200>>;
+export declare type DbMutationResult = NonNullable<Awaited<ReturnType<typeof db>>>;
+export declare type DbMutationBody = DbBody;
+export declare type DbMutationError = AxiosError<unknown>;
+export declare const useDb: <TError = AxiosError<unknown, any>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<AxiosResponse<Db200, any>, TError, {
+        hostingId: number;
+        data: DbBody;
+    }, TContext> | undefined;
+    axios?: AxiosRequestConfig<any> | undefined;
+} | undefined) => import("@tanstack/react-query").UseMutationResult<AxiosResponse<Db200, any>, TError, {
+    hostingId: number;
+    data: DbBody;
+}, TContext>;
+/**
+ * List all DB name
+ * @summary Get list of database name
+ */
+export declare const dbList: (hostingId: number, options?: AxiosRequestConfig) => Promise<AxiosResponse<DbList200>>;
+export declare const getDbListQueryKey: (hostingId: number) => string[];
+export declare type DbListQueryResult = NonNullable<Awaited<ReturnType<typeof dbList>>>;
+export declare type DbListQueryError = AxiosError<unknown>;
+export declare const useDbList: <TData = AxiosResponse<DbList200, any>, TError = AxiosError<unknown, any>>(hostingId: number, options?: {
+    query?: UseQueryOptions<AxiosResponse<DbList200, any>, TError, TData, QueryKey> | undefined;
+    axios?: AxiosRequestConfig<any> | undefined;
+} | undefined) => UseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
 /**
  * Returns a list of domains
  * @summary domain list
@@ -2580,6 +2688,29 @@ export declare const getAddonCloudflareMock: () => {
     status: string | undefined;
     addon_id: number | undefined;
 };
+export declare const getDbAddMock: () => {
+    dbname: string | undefined;
+    status: number | undefined;
+    type: string | undefined;
+};
+export declare const getDbMock: () => {
+    dbname: string | undefined;
+    status: number | undefined;
+    type: string | undefined;
+};
+export declare const getDbListMock: () => {
+    status: boolean | undefined;
+    databases: {
+        db: string | undefined;
+        size: string | undefined;
+        sizemeg: string | undefined;
+        usercount: number | undefined;
+        userlist: {
+            db: string | undefined;
+            user: string | undefined;
+        }[] | undefined;
+    }[] | undefined;
+};
 export declare const getDomainsMock: () => {
     domains: {
         docroot: string;
@@ -2593,11 +2724,15 @@ export declare const getHostingFtpListMock: () => {
         user: string | undefined;
         homedir: string | undefined;
         type: string | undefined;
+        account: string | undefined;
+        domain: string | undefined;
     }[] | undefined;
     special_ftp_accounts: {
         user: string | undefined;
         homedir: string | undefined;
         type: string | undefined;
+        account: string | undefined;
+        domain: string | undefined;
     }[] | undefined;
 };
 export declare const getHostingFtpAddMock: () => {
@@ -2733,7 +2868,7 @@ export declare const getSitesInfoMock: () => {
     url: string;
     version: string;
     versionLatest: string | undefined;
-    php_version: string | undefined;
+    php_version: string | null | undefined;
     updatable: boolean | undefined;
     pending_url: string | undefined;
     meta: {

package/src/index.js

@@ -3,7 +3,7 @@
  * Do not edit manually.
  * Hosting UAPI
  * Hosting UAPI is an API to expose Hosting, Addons, and Site functionality to a customer-facing Front End such as (Account Manager).
- * OpenAPI spec version: 1.401.0
+ * OpenAPI spec version: 1.413.0
  */
 import axios from 'axios';
 import { useQuery, useMutation } from '@tanstack/react-query';
@@ -84,6 +84,16 @@ export const DomainsType = {
     sub: 'sub',
     unassigned: 'unassigned',
 };
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const DbBodyType = {
+    mysql: 'mysql',
+    postgres: 'postgres',
+};
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const DbAddBodyType = {
+    mysql: 'mysql',
+    postgres: 'postgres',
+};
 /**
  * Returns a combined backup list with website commit ids and corresponding database commits
  * @summary backup list
@@ -521,6 +531,53 @@ export const useAddonCloudflare = (options) => {
     };
     return useMutation(mutationFn, mutationOptions);
 };
+/**
+ * Add a new db to an account
+ * @summary Create a database for an account
+ */
+export const dbAdd = (hostingId, dbAddBody, options) => {
+    return axios.post(`/v1/hosting/${hostingId}/db`, dbAddBody, options);
+};
+export const useDbAdd = (options) => {
+    const { mutation: mutationOptions, axios: axiosOptions } = options !== null && options !== void 0 ? options : {};
+    const mutationFn = (props) => {
+        const { hostingId, data } = props !== null && props !== void 0 ? props : {};
+        return dbAdd(hostingId, data, axiosOptions);
+    };
+    return useMutation(mutationFn, mutationOptions);
+};
+/**
+ * Delete db account
+ * @summary Delete db account
+ */
+export const db = (hostingId, dbBody, options) => {
+    return axios.delete(`/v1/hosting/${hostingId}/db`, Object.assign({ data: dbBody }, options));
+};
+export const useDb = (options) => {
+    const { mutation: mutationOptions, axios: axiosOptions } = options !== null && options !== void 0 ? options : {};
+    const mutationFn = (props) => {
+        const { hostingId, data } = props !== null && props !== void 0 ? props : {};
+        return db(hostingId, data, axiosOptions);
+    };
+    return useMutation(mutationFn, mutationOptions);
+};
+/**
+ * List all DB name
+ * @summary Get list of database name
+ */
+export const dbList = (hostingId, options) => {
+    return axios.get(`/v1/hosting/${hostingId}/db`, options);
+};
+export const getDbListQueryKey = (hostingId) => [`/v1/hosting/${hostingId}/db`];
+export const useDbList = (hostingId, options) => {
+    var _a;
+    const { query: queryOptions, axios: axiosOptions } = options !== null && options !== void 0 ? options : {};
+    const queryKey = (_a = queryOptions === null || queryOptions === void 0 ? void 0 : queryOptions.queryKey) !== null && _a !== void 0 ? _a : getDbListQueryKey(hostingId);
+    const queryFn = ({ signal }) => dbList(hostingId, Object.assign({ signal }, axiosOptions));
+    const query = useQuery(Object.assign({ queryKey, queryFn, enabled: !!(hostingId) }, queryOptions));
+    query.queryKey = queryKey;
+    return query;
+};
 /**
  * Returns a list of domains
  * @summary domain list
@@ -1653,8 +1710,11 @@ export const getHostingAdvancedSsoWhmMock = () => ({ url: faker.helpers.arrayEle
 export const getHostingAdvancedSystemConsoleMock = () => ({ url: faker.helpers.arrayElement([faker.random.word(), undefined]) });
 export const getHostingCapabilitiesMock = () => ({ server_controls: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), sites: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), cpanel: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), whm: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), advanced_hosting: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]) });
 export const getAddonCloudflareMock = () => ({ status: faker.helpers.arrayElement([faker.random.word(), undefined]), addon_id: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]) });
+export const getDbAddMock = () => ({ dbname: faker.helpers.arrayElement([faker.random.word(), undefined]), status: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), type: faker.helpers.arrayElement([faker.random.word(), undefined]) });
+export const getDbMock = () => ({ dbname: faker.helpers.arrayElement([faker.random.word(), undefined]), status: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), type: faker.helpers.arrayElement([faker.random.word(), undefined]) });
+export const getDbListMock = () => ({ status: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), databases: faker.helpers.arrayElement([Array.from({ length: faker.datatype.number({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ db: faker.helpers.arrayElement([faker.random.word(), undefined]), size: faker.helpers.arrayElement([faker.random.word(), undefined]), sizemeg: faker.helpers.arrayElement([faker.random.word(), undefined]), usercount: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), userlist: faker.helpers.arrayElement([Array.from({ length: faker.datatype.number({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ db: faker.helpers.arrayElement([faker.random.word(), undefined]), user: faker.helpers.arrayElement([faker.random.word(), undefined]) })), undefined]) })), undefined]) });
 export const getDomainsMock = () => ({ domains: Array.from({ length: faker.datatype.number({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ docroot: faker.random.word(), domain: faker.random.word(), type: faker.random.word(), id: faker.datatype.number({ min: undefined, max: undefined }) })) });
-export const getHostingFtpListMock = () => ({ ftp_accounts: faker.helpers.arrayElement([Array.from({ length: faker.datatype.number({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ user: faker.helpers.arrayElement([faker.random.word(), undefined]), homedir: faker.helpers.arrayElement([faker.random.word(), undefined]), type: faker.helpers.arrayElement([faker.random.word(), undefined]) })), undefined]), special_ftp_accounts: faker.helpers.arrayElement([Array.from({ length: faker.datatype.number({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ user: faker.helpers.arrayElement([faker.random.word(), undefined]), homedir: faker.helpers.arrayElement([faker.random.word(), undefined]), type: faker.helpers.arrayElement([faker.random.word(), undefined]) })), undefined]) });
+export const getHostingFtpListMock = () => ({ ftp_accounts: faker.helpers.arrayElement([Array.from({ length: faker.datatype.number({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ user: faker.helpers.arrayElement([faker.random.word(), undefined]), homedir: faker.helpers.arrayElement([faker.random.word(), undefined]), type: faker.helpers.arrayElement([faker.random.word(), undefined]), account: faker.helpers.arrayElement([faker.random.word(), undefined]), domain: faker.helpers.arrayElement([faker.random.word(), undefined]) })), undefined]), special_ftp_accounts: faker.helpers.arrayElement([Array.from({ length: faker.datatype.number({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ user: faker.helpers.arrayElement([faker.random.word(), undefined]), homedir: faker.helpers.arrayElement([faker.random.word(), undefined]), type: faker.helpers.arrayElement([faker.random.word(), undefined]), account: faker.helpers.arrayElement([faker.random.word(), undefined]), domain: faker.helpers.arrayElement([faker.random.word(), undefined]) })), undefined]) });
 export const getHostingFtpAddMock = () => ({ user: faker.helpers.arrayElement([faker.random.word(), undefined]), pass: faker.helpers.arrayElement([faker.random.word(), undefined]) });
 export const getHostingFtpUpdateMock = () => ({ status: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]) });
 export const getHostingFtpMock = () => ({ status: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), user: faker.helpers.arrayElement([faker.random.word(), undefined]) });
@@ -1678,7 +1738,7 @@ export const getSshKeyMock = () => ({ deleted: faker.helpers.arrayElement([faker
 export const getSshKeyGenerateMock = () => ({ key_name: faker.helpers.arrayElement([faker.random.word(), undefined]), private_key_path: faker.helpers.arrayElement([faker.random.word(), undefined]), public_key_path: faker.helpers.arrayElement([faker.random.word(), undefined]) });
 export const getSsoMock = () => ({ url: faker.random.word() });
 export const getSitesListMock = () => ({ items: faker.helpers.arrayElement([Array.from({ length: faker.datatype.number({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ id: faker.helpers.arrayElement([faker.random.word(), undefined]), name: faker.helpers.arrayElement([faker.random.word(), undefined]), url: faker.helpers.arrayElement([faker.random.word(), undefined]), docroot: faker.helpers.arrayElement([faker.random.word(), undefined]), status: faker.helpers.arrayElement([faker.random.word(), undefined]) })), undefined]) });
-export const getSitesInfoMock = () => ({ id: faker.random.word(), docroot: faker.random.word(), uuid: faker.random.word(), date_added: faker.random.word(), date_modified: faker.random.word(), name: faker.random.word(), type: faker.random.word(), subtype: faker.random.word(), status: faker.random.word(), url: faker.random.word(), version: faker.random.word(), versionLatest: faker.helpers.arrayElement([faker.random.word(), undefined]), php_version: faker.helpers.arrayElement([faker.random.word(), undefined]), updatable: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), pending_url: faker.helpers.arrayElement([faker.random.word(), undefined]), meta: faker.helpers.arrayElement([{ pending_url: faker.helpers.arrayElement([faker.random.word(), undefined]) }, undefined]) });
+export const getSitesInfoMock = () => ({ id: faker.random.word(), docroot: faker.random.word(), uuid: faker.random.word(), date_added: faker.random.word(), date_modified: faker.random.word(), name: faker.random.word(), type: faker.random.word(), subtype: faker.random.word(), status: faker.random.word(), url: faker.random.word(), version: faker.random.word(), versionLatest: faker.helpers.arrayElement([faker.random.word(), undefined]), php_version: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.random.word(), null]), undefined]), updatable: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), pending_url: faker.helpers.arrayElement([faker.random.word(), undefined]), meta: faker.helpers.arrayElement([{ pending_url: faker.helpers.arrayElement([faker.random.word(), undefined]) }, undefined]) });
 export const getSiteUpdateMock = () => ({ success: faker.datatype.boolean() });
 export const getSiteMock = () => ({ success: faker.datatype.boolean() });
 export const getSitesAutoupdatesInfoMock = () => ({ plugins: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), core: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), themes: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]) });
@@ -1776,6 +1836,12 @@ export const getHostingUAPIMSW = () => [
         return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json(getHostingCapabilitiesMock()));
     }), rest.post('*/v1/hosting/:hostingId/cloudflare', (_req, res, ctx) => {
         return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json(getAddonCloudflareMock()));
+    }), rest.post('*/v1/hosting/:hostingId/db', (_req, res, ctx) => {
+        return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json(getDbAddMock()));
+    }), rest.delete('*/v1/hosting/:hostingId/db', (_req, res, ctx) => {
+        return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json(getDbMock()));
+    }), rest.get('*/v1/hosting/:hostingId/db', (_req, res, ctx) => {
+        return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json(getDbListMock()));
     }), rest.get('*/v1/hosting/:hostingId/domains', (_req, res, ctx) => {
         return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json(getDomainsMock()));
     }), rest.get('*/v1/hosting/:hostingId/ftp', (_req, res, ctx) => {