@newfold/huapi-js 1.0.0

package/openapi.json

@@ -0,0 +1,92 @@
+{
+  "openapi": "3.0.0",
+  "info": { "title": "Hosting UAPI", "version": "0.1.0" },
+  "components": {
+    "securitySchemes": {
+      "bearerAuth": {
+        "type": "http",
+        "scheme": "bearer",
+        "bearerFormat": "JWT"
+      }
+    }
+  },
+  "paths": {
+    "/sites/{site_id}/sso": {
+      "post": {
+        "security": [{ "bearerAuth": [] }],
+        "summary": "site_sso",
+        "description": "Return an SSO token or login URL for this site (if supported).",
+        "parameters": [
+          {
+            "name": "site_id",
+            "in": "path",
+            "required": true,
+            "schema": { "type": "integer" }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "sso": { "type": "string", "example": "$randomUrl" }
+                  },
+                  "required": ["sso"]
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/hosting/{hosting_id}/sites": {
+      "get": {
+        "security": [{ "bearerAuth": [] }],
+        "summary": "site_list",
+        "description": "Obtain a list of sites.",
+        "parameters": [
+          {
+            "name": "hosting_id",
+            "in": "path",
+            "required": true,
+            "schema": { "type": "integer" }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "limit": { "type": "string" },
+                    "n_pages": { "type": "string" },
+                    "n_rows": { "type": "string" },
+                    "page": { "type": "string" },
+                    "rows": {
+                      "type": "array",
+                      "items": {
+                        "type": "object",
+                        "properties": {
+                          "id": { "type": "string" },
+                          "name": { "type": "string" },
+                          "url": { "type": "string" }
+                        },
+                        "required": ["id", "name", "url"]
+                      }
+                    }
+                  },
+                  "required": ["limit", "n_pages", "n_rows", "page", "rows"]
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/orval.config.js

@@ -0,0 +1,14 @@
+module.exports = {
+  huapi: {
+    input: {
+      target: "./openapi.json",
+      validation: true,
+    },
+    output: {
+      // mode: "tags-split",
+      target: "./src/huapi.ts",
+      // schemas: "src/model",
+      client: "react-query",
+    },
+  },
+};

package/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "@newfold/huapi-js",
+  "version": "1.0.0",
+  "main": "src/huapi.ts",
+  "license": "MIT",
+  "dependencies": {
+    "axios": "^0.26.1",
+    "react-query": "^3.34.19"
+  },
+  "peerDependencies": {
+    "react-query": "^3.0.0"
+  }
+}

package/src/huapi.ts

@@ -0,0 +1,124 @@
+/**
+ * Generated by orval v6.7.1 🍺
+ * Do not edit manually.
+ * Hosting UAPI
+ * OpenAPI spec version: 0.1.0
+ */
+import axios,{
+  AxiosRequestConfig,
+  AxiosResponse,
+  AxiosError
+} from 'axios'
+import {
+  useQuery,
+  useMutation,
+  UseQueryOptions,
+  UseMutationOptions,
+  QueryFunction,
+  MutationFunction,
+  UseQueryResult,
+  QueryKey
+} from 'react-query'
+export type GetHostingHostingIdSites200RowsItem = {
+  id: string;
+  name: string;
+  url: string;
+};
+
+export type GetHostingHostingIdSites200 = {
+  limit: string;
+  n_pages: string;
+  n_rows: string;
+  page: string;
+  rows: GetHostingHostingIdSites200RowsItem[];
+};
+
+export type PostSitesSiteIdSso200 = {
+  sso: string;
+};
+
+
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type AsyncReturnType<
+T extends (...args: any) => Promise<any>
+> = T extends (...args: any) => Promise<infer R> ? R : any;
+
+
+/**
+ * Return an SSO token or login URL for this site (if supported).
+ * @summary site_sso
+ */
+export const postSitesSiteIdSso = (
+    siteId: number, options?: AxiosRequestConfig
+ ): Promise<AxiosResponse<PostSitesSiteIdSso200>> => {
+    return axios.post(
+      `/sites/${siteId}/sso`,undefined,options
+    );
+  }
+
+
+
+    export type PostSitesSiteIdSsoMutationResult = NonNullable<AsyncReturnType<typeof postSitesSiteIdSso>>
+    
+    export type PostSitesSiteIdSsoMutationError = AxiosError<unknown>
+
+    export const usePostSitesSiteIdSso = <TError = AxiosError<unknown>,
+    
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<AsyncReturnType<typeof postSitesSiteIdSso>, TError,{siteId: number}, TContext>, axios?: AxiosRequestConfig}
+) => {
+      const {mutation: mutationOptions, axios: axiosOptions} = options || {}
+
+      
+
+
+      const mutationFn: MutationFunction<AsyncReturnType<typeof postSitesSiteIdSso>, {siteId: number}> = (props) => {
+          const {siteId} = props || {};
+
+          return  postSitesSiteIdSso(siteId,axiosOptions)
+        }
+
+      return useMutation<AsyncReturnType<typeof postSitesSiteIdSso>, TError, {siteId: number}, TContext>(mutationFn, mutationOptions)
+    }
+    
+/**
+ * Obtain a list of sites.
+ * @summary site_list
+ */
+export const getHostingHostingIdSites = (
+    hostingId: number, options?: AxiosRequestConfig
+ ): Promise<AxiosResponse<GetHostingHostingIdSites200>> => {
+    return axios.get(
+      `/hosting/${hostingId}/sites`,options
+    );
+  }
+
+
+export const getGetHostingHostingIdSitesQueryKey = (hostingId: number,) => [`/hosting/${hostingId}/sites`];
+
+    
+export type GetHostingHostingIdSitesQueryResult = NonNullable<AsyncReturnType<typeof getHostingHostingIdSites>>
+export type GetHostingHostingIdSitesQueryError = AxiosError<unknown>
+
+export const useGetHostingHostingIdSites = <TData = AsyncReturnType<typeof getHostingHostingIdSites>, TError = AxiosError<unknown>>(
+ hostingId: number, options?: { query?:UseQueryOptions<AsyncReturnType<typeof getHostingHostingIdSites>, TError, TData>, axios?: AxiosRequestConfig}
+
+  ):  UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+
+  const {query: queryOptions, axios: axiosOptions} = options || {}
+
+  const queryKey = queryOptions?.queryKey ?? getGetHostingHostingIdSitesQueryKey(hostingId);
+
+  
+
+  const queryFn: QueryFunction<AsyncReturnType<typeof getHostingHostingIdSites>> = () => getHostingHostingIdSites(hostingId, axiosOptions);
+
+  const query = useQuery<AsyncReturnType<typeof getHostingHostingIdSites>, TError, TData>(queryKey, queryFn, {enabled: !!(hostingId), ...queryOptions})
+
+  return {
+    queryKey,
+    ...query
+  }
+}
+
+