@newfold/huapi-js 1.3.0 → 1.3.1

package/dist/index.d.ts

@@ -7,7 +7,7 @@
  */
 import { AxiosRequestConfig, AxiosResponse, AxiosError } from 'axios';
 import { UseQueryOptions, UseMutationOptions, UseQueryResult, QueryKey } from 'react-query';
-import type { AddonsCodeguardWebsiteList200, AddonsCodeguardBackups200, AddonsCodeguardBackupsParams, AddonsCodeguardLoginLinkGenerate200, AddonsCodeguardDatabaseBackupCreate200, AddonsCodeguardDatabaseBackupCreateBody, AddonsCodeguardWebsiteBackupCreate200, AddonsCodeguardWebsiteBackupCreateBody, AddonsCodeguardDatabaseList200, AddonsCodeguardWebsiteBackupList200, AddonsCodeguardWebsiteBackupListParams, AddonsCodeguardDatabaseBackupList200, AddonsCodeguardDatabaseBackupListParams, AddonsCodeguardBackupRestore200, AddonsCodeguardBackupRestoreBody, AddonsCodeguardWebsiteBackupRestore200, AddonsCodeguardWebsiteBackupRestore400, AddonsCodeguardWebsiteBackupRestoreBody, AddonsCodeguardDatabaseBackupRestore200, AddonsCodeguardDatabaseBackupRestoreBody, HostingInfo200, HostingAddons200, HostingAddonsParams, HostingFtpList200, SitesSso200, SitesInfo200, HostingSites200 } from './models';
+import type { AddonsCodeguardWebsiteList200, AddonsCodeguardBackups200, AddonsCodeguardBackupsParams, AddonsCodeguardLoginLinkGenerate200, AddonsCodeguardDatabaseBackupCreate200, AddonsCodeguardDatabaseBackupCreateBody, AddonsCodeguardWebsiteBackupCreate200, AddonsCodeguardWebsiteBackupCreateBody, AddonsCodeguardDatabaseList200, AddonsCodeguardWebsiteBackupList200, AddonsCodeguardWebsiteBackupListParams, AddonsCodeguardDatabaseBackupList200, AddonsCodeguardDatabaseBackupListParams, AddonsCodeguardBackupRestore200, AddonsCodeguardBackupRestoreBody, AddonsCodeguardWebsiteBackupRestore200, AddonsCodeguardWebsiteBackupRestore400, AddonsCodeguardWebsiteBackupRestoreBody, AddonsCodeguardDatabaseBackupRestore200, AddonsCodeguardDatabaseBackupRestoreBody, HostingInfo200, HostingAddons200, HostingAddonsParams, HostingFtpList200, Sso200, SitesSso200, SitesInfo200, HostingSites200 } from './models';
 declare type AsyncReturnType<T extends (...args: any) => Promise<any>> = T extends (...args: any) => Promise<infer R> ? R : any;
 /**
  * Return all website records CodeGuard maintains for this user's account.
@@ -225,6 +225,20 @@ export declare const useHostingFtpList: <TData = AxiosResponse<HostingFtpList200
 } | undefined) => UseQueryResult<TData, TError> & {
     queryKey: QueryKey;
 };
+/**
+ * Return a SSO login token for a hosting account
+ * @summary sso
+ */
+export declare const sso: (hostingId: number, options?: AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<Sso200>>;
+export declare const getSsoQueryKey: (hostingId: number) => string[];
+export declare type SsoQueryResult = NonNullable<AsyncReturnType<typeof sso>>;
+export declare type SsoQueryError = AxiosError<unknown>;
+export declare const useSso: <TData = AxiosResponse<Sso200, any>, TError = AxiosError<unknown, any>>(hostingId: number, options?: {
+    query?: UseQueryOptions<AxiosResponse<Sso200, any>, TError, TData, QueryKey> | undefined;
+    axios?: AxiosRequestConfig<any> | undefined;
+} | undefined) => UseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
 /**
  * Return an SSO token or login URL for this site (if supported).
  * @summary sites sso

package/dist/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.useHostingSites = exports.getHostingSitesQueryKey = exports.hostingSites = exports.useSitesInfo = exports.getSitesInfoQueryKey = exports.sitesInfo = exports.useSitesSso = exports.getSitesSsoQueryKey = exports.sitesSso = exports.useHostingFtpList = exports.getHostingFtpListQueryKey = exports.hostingFtpList = exports.useHostingAddons = exports.getHostingAddonsQueryKey = exports.hostingAddons = exports.useHostingInfo = exports.getHostingInfoQueryKey = exports.hostingInfo = exports.useAddonsCodeguardDatabaseBackupRestore = exports.addonsCodeguardDatabaseBackupRestore = exports.useAddonsCodeguardWebsiteBackupRestore = exports.addonsCodeguardWebsiteBackupRestore = exports.useAddonsCodeguardBackupRestore = exports.addonsCodeguardBackupRestore = exports.useAddonsCodeguardDatabaseBackupList = exports.getAddonsCodeguardDatabaseBackupListQueryKey = exports.addonsCodeguardDatabaseBackupList = exports.useAddonsCodeguardWebsiteBackupList = exports.getAddonsCodeguardWebsiteBackupListQueryKey = exports.addonsCodeguardWebsiteBackupList = exports.useAddonsCodeguardDatabaseList = exports.getAddonsCodeguardDatabaseListQueryKey = exports.addonsCodeguardDatabaseList = exports.useAddonsCodeguardWebsiteBackupCreate = exports.addonsCodeguardWebsiteBackupCreate = exports.useAddonsCodeguardDatabaseBackupCreate = exports.addonsCodeguardDatabaseBackupCreate = exports.useAddonsCodeguardLoginLinkGenerate = exports.getAddonsCodeguardLoginLinkGenerateQueryKey = exports.addonsCodeguardLoginLinkGenerate = exports.useAddonsCodeguardBackups = exports.getAddonsCodeguardBackupsQueryKey = exports.addonsCodeguardBackups = exports.useAddonsCodeguardWebsiteList = exports.getAddonsCodeguardWebsiteListQueryKey = exports.addonsCodeguardWebsiteList = void 0;
+exports.useHostingSites = exports.getHostingSitesQueryKey = exports.hostingSites = exports.useSitesInfo = exports.getSitesInfoQueryKey = exports.sitesInfo = exports.useSitesSso = exports.getSitesSsoQueryKey = exports.sitesSso = exports.useSso = exports.getSsoQueryKey = exports.sso = exports.useHostingFtpList = exports.getHostingFtpListQueryKey = exports.hostingFtpList = exports.useHostingAddons = exports.getHostingAddonsQueryKey = exports.hostingAddons = exports.useHostingInfo = exports.getHostingInfoQueryKey = exports.hostingInfo = exports.useAddonsCodeguardDatabaseBackupRestore = exports.addonsCodeguardDatabaseBackupRestore = exports.useAddonsCodeguardWebsiteBackupRestore = exports.addonsCodeguardWebsiteBackupRestore = exports.useAddonsCodeguardBackupRestore = exports.addonsCodeguardBackupRestore = exports.useAddonsCodeguardDatabaseBackupList = exports.getAddonsCodeguardDatabaseBackupListQueryKey = exports.addonsCodeguardDatabaseBackupList = exports.useAddonsCodeguardWebsiteBackupList = exports.getAddonsCodeguardWebsiteBackupListQueryKey = exports.addonsCodeguardWebsiteBackupList = exports.useAddonsCodeguardDatabaseList = exports.getAddonsCodeguardDatabaseListQueryKey = exports.addonsCodeguardDatabaseList = exports.useAddonsCodeguardWebsiteBackupCreate = exports.addonsCodeguardWebsiteBackupCreate = exports.useAddonsCodeguardDatabaseBackupCreate = exports.addonsCodeguardDatabaseBackupCreate = exports.useAddonsCodeguardLoginLinkGenerate = exports.getAddonsCodeguardLoginLinkGenerateQueryKey = exports.addonsCodeguardLoginLinkGenerate = exports.useAddonsCodeguardBackups = exports.getAddonsCodeguardBackupsQueryKey = exports.addonsCodeguardBackups = exports.useAddonsCodeguardWebsiteList = exports.getAddonsCodeguardWebsiteListQueryKey = exports.addonsCodeguardWebsiteList = void 0;
 /**
  * Generated by orval v6.7.1 🍺
  * Do not edit manually.
@@ -269,6 +269,25 @@ const useHostingFtpList = (hostingId, options) => {
     return Object.assign({ queryKey }, query);
 };
 exports.useHostingFtpList = useHostingFtpList;
+/**
+ * Return a SSO login token for a hosting account
+ * @summary sso
+ */
+const sso = (hostingId, options) => {
+    return axios_1.default.get(`/v1/hosting/${hostingId}/sso`, options);
+};
+exports.sso = sso;
+const getSsoQueryKey = (hostingId) => [`/v1/hosting/${hostingId}/sso`];
+exports.getSsoQueryKey = getSsoQueryKey;
+const useSso = (hostingId, options) => {
+    var _a;
+    const { query: queryOptions, axios: axiosOptions } = options || {};
+    const queryKey = (_a = queryOptions === null || queryOptions === void 0 ? void 0 : queryOptions.queryKey) !== null && _a !== void 0 ? _a : (0, exports.getSsoQueryKey)(hostingId);
+    const queryFn = () => (0, exports.sso)(hostingId, axiosOptions);
+    const query = (0, react_query_1.useQuery)(queryKey, queryFn, Object.assign({ enabled: !!(hostingId) }, queryOptions));
+    return Object.assign({ queryKey }, query);
+};
+exports.useSso = useSso;
 /**
  * Return an SSO token or login URL for this site (if supported).
  * @summary sites sso

package/dist/index.msw.d.ts

@@ -79,6 +79,9 @@ export declare const getHostingFtpListMock: () => {
         homedir: string | undefined;
     }[] | undefined;
 };
+export declare const getSsoMock: () => {
+    url: string | undefined;
+};
 export declare const getSitesSsoMock: () => {
     sso: string | undefined;
 };

package/dist/index.msw.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getHostingUAPIMSW = exports.getHostingSitesMock = exports.getSitesInfoMock = exports.getSitesSsoMock = exports.getHostingFtpListMock = exports.getHostingAddonsMock = exports.getHostingInfoMock = exports.getAddonsCodeguardDatabaseBackupRestoreMock = exports.getAddonsCodeguardWebsiteBackupRestoreMock = exports.getAddonsCodeguardBackupRestoreMock = exports.getAddonsCodeguardDatabaseBackupListMock = exports.getAddonsCodeguardWebsiteBackupListMock = exports.getAddonsCodeguardDatabaseListMock = exports.getAddonsCodeguardWebsiteBackupCreateMock = exports.getAddonsCodeguardDatabaseBackupCreateMock = exports.getAddonsCodeguardLoginLinkGenerateMock = exports.getAddonsCodeguardBackupsMock = exports.getAddonsCodeguardWebsiteListMock = void 0;
+exports.getHostingUAPIMSW = exports.getHostingSitesMock = exports.getSitesInfoMock = exports.getSitesSsoMock = exports.getSsoMock = exports.getHostingFtpListMock = exports.getHostingAddonsMock = exports.getHostingInfoMock = exports.getAddonsCodeguardDatabaseBackupRestoreMock = exports.getAddonsCodeguardWebsiteBackupRestoreMock = exports.getAddonsCodeguardBackupRestoreMock = exports.getAddonsCodeguardDatabaseBackupListMock = exports.getAddonsCodeguardWebsiteBackupListMock = exports.getAddonsCodeguardDatabaseListMock = exports.getAddonsCodeguardWebsiteBackupCreateMock = exports.getAddonsCodeguardDatabaseBackupCreateMock = exports.getAddonsCodeguardLoginLinkGenerateMock = exports.getAddonsCodeguardBackupsMock = exports.getAddonsCodeguardWebsiteListMock = void 0;
 /**
  * Generated by orval v6.7.1 🍺
  * Do not edit manually.
@@ -38,6 +38,8 @@ const getHostingAddonsMock = () => ({ rows: faker_1.faker.helpers.randomize([[..
 exports.getHostingAddonsMock = getHostingAddonsMock;
 const getHostingFtpListMock = () => ({ ftp_account: faker_1.faker.helpers.randomize([[...Array(faker_1.faker.datatype.number({ min: 1, max: 10 }))].map(() => ({ user: faker_1.faker.helpers.randomize([faker_1.faker.random.word(), undefined]), homedir: faker_1.faker.helpers.randomize([faker_1.faker.random.word(), undefined]) })), undefined]) });
 exports.getHostingFtpListMock = getHostingFtpListMock;
+const getSsoMock = () => ({ url: faker_1.faker.helpers.randomize([faker_1.faker.random.word(), undefined]) });
+exports.getSsoMock = getSsoMock;
 const getSitesSsoMock = () => ({ sso: faker_1.faker.helpers.randomize([faker_1.faker.random.word(), undefined]) });
 exports.getSitesSsoMock = getSitesSsoMock;
 const getSitesInfoMock = () => ({ id: faker_1.faker.random.word(), docroot: faker_1.faker.random.word(), uuid: faker_1.faker.random.word(), date_added: faker_1.faker.random.word(), date_modified: faker_1.faker.random.word(), name: faker_1.faker.random.word(), type: faker_1.faker.random.word(), subtype: faker_1.faker.random.word(), status: faker_1.faker.random.word(), url: faker_1.faker.random.word(), version: faker_1.faker.random.word() });
@@ -73,6 +75,8 @@ const getHostingUAPIMSW = () => [
         return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json((0, exports.getHostingAddonsMock)()));
     }), msw_1.rest.get('*/v1/hosting/:hostingid/ftp/list', (_req, res, ctx) => {
         return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json((0, exports.getHostingFtpListMock)()));
+    }), msw_1.rest.get('*/v1/hosting/:hostingid/sso', (_req, res, ctx) => {
+        return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json((0, exports.getSsoMock)()));
     }), msw_1.rest.get('*/v1/sites/:siteid/sso', (_req, res, ctx) => {
         return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json((0, exports.getSitesSsoMock)()));
     }), msw_1.rest.get('*/v1/sites/:siteid/info', (_req, res, ctx) => {

package/dist/models/index.d.ts

@@ -55,3 +55,4 @@ export * from './addonsCodeguardWebsiteBackupRestore400';
 export * from './hostingFtpList200';
 export * from './sitesInfo200';
 export * from './addonsCodeguardWebsiteBackupList200';
+export * from './sso200';

package/dist/models/index.js

@@ -71,3 +71,4 @@ __exportStar(require("./addonsCodeguardWebsiteBackupRestore400"), exports);
 __exportStar(require("./hostingFtpList200"), exports);
 __exportStar(require("./sitesInfo200"), exports);
 __exportStar(require("./addonsCodeguardWebsiteBackupList200"), exports);
+__exportStar(require("./sso200"), exports);

package/dist/models/sso200.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Generated by orval v6.7.1 🍺
+ * 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: 0.1.0
+ */
+export declare type Sso200 = {
+    url?: string;
+};

package/dist/models/sso200.js

@@ -0,0 +1,9 @@
+"use strict";
+/**
+ * Generated by orval v6.7.1 🍺
+ * 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: 0.1.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@newfold/huapi-js",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",