@newfold/huapi-js 1.1.1 → 1.1.3

package/README.md

@@ -0,0 +1,32 @@
+# @newfold/huapi-js
+
+> A JavaScript Client Library for HUAPI
+
+## Installation
+
+TODO
+
+## Usage
+
+### React Hooks
+
+```js
+import React from "react";
+
+import { useGetHostingSites } from "@newfold/huapi-js";
+
+const MyComponent = () => {
+  const hostingId = "2";
+  const { isLoading, data } = useGetHostingSites(hostingId);
+
+  if (isLoading) return <h1>Loading...</h1>;
+
+  return (
+    <div>
+      {data?.data?.rows?.map((site) => {
+        <div key={site.id}>{site.name}</div>;
+      })}
+    </div>
+  );
+};
+```

package/openapi.json

@@ -11,9 +11,26 @@
         "type": "object",
         "description": "A site",
         "properties": {
-          "id": { "type": "string", "description": "TODO" },
-          "name": { "type": "string", "description": "TODO" },
-          "url": { "type": "string", "description": "TODO" }
+          "id": {
+            "type": "integer",
+            "description": "TODO",
+            "example": 1
+          },
+          "name": {
+            "type": "string",
+            "description": "TODO",
+            "example": "Example Site 1"
+          },
+          "url": {
+            "type": "string",
+            "description": "TODO",
+            "example": "https://example.com"
+          }
+        },
+        "example": {
+          "id": 1,
+          "name": "Example Site 1",
+          "url": "https://example.com"
         },
         "required": ["id", "name", "url"]
       },
@@ -21,19 +38,68 @@
         "description": "List of sites",
         "type": "object",
         "properties": {
-          "limit": { "type": "string", "description": "TODO" },
-          "n_pages": { "type": "string", "description": "TODO" },
-          "n_rows": { "type": "string", "description": "TODO" },
-          "page": { "type": "string", "description": "TODO" },
+          "limit": {
+            "type": "integer",
+            "description": "Max number of sites included in response",
+            "example": 10
+          },
+          "n_pages": {
+            "type": "integer",
+            "description": "TODO",
+            "example": 1
+          },
+          "n_rows": {
+            "type": "integer",
+            "description": "TODO",
+            "example": 1
+          },
+          "page": {
+            "type": "integer",
+            "description": "TODO",
+            "example": 1
+          },
           "rows": {
             "type": "array",
             "description": "TODO",
             "items": {
               "type": "array",
               "$ref": "#/components/schemas/Site"
-            }
+            },
+            "example": [
+              {
+                "id": 1,
+                "name": "Example Site 1",
+                "url": "https://example.com"
+              },
+              {
+                "id": 2,
+                "name": "Example Site 2",
+                "url": "https://example2.com"
+              }
+            ]
           }
-        }
+        },
+        "example": {
+          "limit": 10,
+          "n_pages": 1,
+          "n_rows": 1,
+          "page": 1,
+          "rows": [
+            [
+              {
+                "id": 1,
+                "name": "Example Site 1",
+                "url": "https://example.com"
+              },
+              {
+                "id": 2,
+                "name": "Example Site 2",
+                "url": "https://example2.com"
+              }
+            ]
+          ]
+        },
+        "required": ["limit", "n_pages", "n_rows", "page", "rows"]
       },
       "SiteSso": {
         "description": "SSO token or login URL",
@@ -45,6 +111,9 @@
             "description": "TODO"
           }
         },
+        "example": {
+          "sso": "$randomUrl"
+        },
         "required": ["sso"]
       }
     },
@@ -63,7 +132,11 @@
         "operationId": "site_sso",
         "description": "TODO",
         "tags": ["sites"],
-        "security": [{ "bearerAuth": [] }],
+        "security": [
+          {
+            "bearerAuth": []
+          }
+        ],
         "parameters": [
           {
             "name": "site_id",
@@ -83,9 +156,6 @@
               "application/json": {
                 "schema": {
                   "$ref": "#/components/schemas/SiteSso"
-                },
-                "example": {
-                  "sso": "$randomUrl"
                 }
               }
             }
@@ -118,19 +188,6 @@
               "application/json": {
                 "schema": {
                   "$ref": "#/components/schemas/SiteList"
-                },
-                "example": {
-                  "limit": "10",
-                  "n_pages": "1",
-                  "n_rows": "1",
-                  "page": "1",
-                  "rows": [
-                    {
-                      "id": "1",
-                      "name": "Example Site",
-                      "url": "https://example.com"
-                    }
-                  ]
                 }
               }
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@newfold/huapi-js",
-  "version": "1.1.1",
+  "version": "1.1.3",
   "main": "src/huapi.js",
   "license": "MIT",
   "devDependencies": {
@@ -17,7 +17,7 @@
     "axios": "^0.26.1",
     "msw": "^0.39.2",
     "orval": "^6.7.1",
-    "react": "^18.0.0",
+    "react": "^17.0.2",
     "react-query": "^3.34.19"
   },
   "scripts": {

package/src/huapi.js

@@ -70,7 +70,7 @@ var useGetHostingSites = function (hostingId, options) {
 exports.useGetHostingSites = useGetHostingSites;
 var getSiteSsoMock = function () { return ({ sso: faker_1.faker.random.word() }); };
 exports.getSiteSsoMock = getSiteSsoMock;
-var getGetHostingSitesMock = function () { return ({ limit: faker_1.faker.helpers.randomize([faker_1.faker.random.word(), undefined]), n_pages: faker_1.faker.helpers.randomize([faker_1.faker.random.word(), undefined]), n_rows: faker_1.faker.helpers.randomize([faker_1.faker.random.word(), undefined]), page: faker_1.faker.helpers.randomize([faker_1.faker.random.word(), undefined]), rows: faker_1.faker.helpers.randomize([__spreadArray([], Array(faker_1.faker.datatype.number({ min: 1, max: 10 })), true).map(function () { return ({ id: faker_1.faker.random.word(), name: faker_1.faker.random.word(), url: faker_1.faker.random.word() }); }), undefined]) }); };
+var getGetHostingSitesMock = function () { return ({ limit: faker_1.faker.datatype.number(), n_pages: faker_1.faker.datatype.number(), n_rows: faker_1.faker.datatype.number(), page: faker_1.faker.datatype.number(), rows: __spreadArray([], Array(faker_1.faker.datatype.number({ min: 1, max: 10 })), true).map(function () { return ({ id: faker_1.faker.datatype.number(), name: faker_1.faker.random.word(), url: faker_1.faker.random.word() }); }) }); };
 exports.getGetHostingSitesMock = getGetHostingSitesMock;
 var getHostingUAPIMSW = function () { return [
     msw_1.rest.post('*/sites/:siteid/sso', function (_req, res, ctx) {

package/src/huapi.ts

@@ -0,0 +1,169 @@
+/**
+ * Generated by orval v6.7.1 🍺
+ * Do not edit manually.
+ * Hosting UAPI
+ * 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'
+import {
+  rest
+} from 'msw'
+import {
+  faker
+} from '@faker-js/faker'
+/**
+ * SSO token or login URL
+ */
+export interface SiteSso {
+  /** TODO */
+  sso: string;
+}
+
+/**
+ * A site
+ */
+export interface Site {
+  /** TODO */
+  id: number;
+  /** TODO */
+  name: string;
+  /** TODO */
+  url: string;
+}
+
+/**
+ * List of sites
+ */
+export interface SiteList {
+  /** Max number of sites included in response */
+  limit: number;
+  /** TODO */
+  n_pages: number;
+  /** TODO */
+  n_rows: number;
+  /** TODO */
+  page: number;
+  /** TODO */
+  rows: Site[];
+}
+
+
+
+// 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;
+
+
+/**
+ * TODO
+ * @summary Get SSO token
+ */
+export const siteSso = (
+    siteId: number, options?: AxiosRequestConfig
+ ): Promise<AxiosResponse<SiteSso>> => {
+    return axios.post(
+      `/sites/${siteId}/sso`,undefined,options
+    );
+  }
+
+
+
+    export type SiteSsoMutationResult = NonNullable<AsyncReturnType<typeof siteSso>>
+    
+    export type SiteSsoMutationError = AxiosError<unknown>
+
+    export const useSiteSso = <TError = AxiosError<unknown>,
+    
+    TContext = unknown>(options?: { mutation?:UseMutationOptions<AsyncReturnType<typeof siteSso>, TError,{siteId: number}, TContext>, axios?: AxiosRequestConfig}
+) => {
+      const {mutation: mutationOptions, axios: axiosOptions} = options || {}
+
+      
+
+
+      const mutationFn: MutationFunction<AsyncReturnType<typeof siteSso>, {siteId: number}> = (props) => {
+          const {siteId} = props || {};
+
+          return  siteSso(siteId,axiosOptions)
+        }
+
+      return useMutation<AsyncReturnType<typeof siteSso>, TError, {siteId: number}, TContext>(mutationFn, mutationOptions)
+    }
+    
+/**
+ * Obtain a list of sites.
+ * @summary Get sites for a hosting id
+ */
+export const getHostingSites = (
+    hostingId: number, options?: AxiosRequestConfig
+ ): Promise<AxiosResponse<SiteList>> => {
+    return axios.get(
+      `/hosting/${hostingId}/sites`,options
+    );
+  }
+
+
+export const getGetHostingSitesQueryKey = (hostingId: number,) => [`/hosting/${hostingId}/sites`];
+
+    
+export type GetHostingSitesQueryResult = NonNullable<AsyncReturnType<typeof getHostingSites>>
+export type GetHostingSitesQueryError = AxiosError<unknown>
+
+export const useGetHostingSites = <TData = AsyncReturnType<typeof getHostingSites>, TError = AxiosError<unknown>>(
+ hostingId: number, options?: { query?:UseQueryOptions<AsyncReturnType<typeof getHostingSites>, TError, TData>, axios?: AxiosRequestConfig}
+
+  ):  UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+
+  const {query: queryOptions, axios: axiosOptions} = options || {}
+
+  const queryKey = queryOptions?.queryKey ?? getGetHostingSitesQueryKey(hostingId);
+
+  
+
+  const queryFn: QueryFunction<AsyncReturnType<typeof getHostingSites>> = () => getHostingSites(hostingId, axiosOptions);
+
+  const query = useQuery<AsyncReturnType<typeof getHostingSites>, TError, TData>(queryKey, queryFn, {enabled: !!(hostingId), ...queryOptions})
+
+  return {
+    queryKey,
+    ...query
+  }
+}
+
+
+
+
+export const getSiteSsoMock = () => ({sso: faker.random.word()})
+
+export const getGetHostingSitesMock = () => ({limit: faker.datatype.number(), n_pages: faker.datatype.number(), n_rows: faker.datatype.number(), page: faker.datatype.number(), rows: [...Array(faker.datatype.number({min: 1, max: 10}))].map(() => ({id: faker.datatype.number(), name: faker.random.word(), url: faker.random.word()}))})
+
+export const getHostingUAPIMSW = () => [
+rest.post('*/sites/:siteid/sso', (_req, res, ctx) => {
+        return res(
+          ctx.delay(1000),
+          ctx.status(200, 'Mocked status'),
+ctx.json(getSiteSsoMock()),
+        )
+      }),rest.get('*/hosting/:hostingid/sites', (_req, res, ctx) => {
+        return res(
+          ctx.delay(1000),
+          ctx.status(200, 'Mocked status'),
+ctx.json(getGetHostingSitesMock()),
+        )
+      }),]