@newfold/huapi-js 1.0.3 → 1.1.1

package/openapi.json

@@ -1,7 +1,53 @@
 {
   "openapi": "3.0.0",
-  "info": { "title": "Hosting UAPI", "version": "0.1.0" },
+  "info": {
+    "version": "0.1.0",
+    "title": "Hosting UAPI",
+    "description": "Hosting UAPI"
+  },
   "components": {
+    "schemas": {
+      "Site": {
+        "type": "object",
+        "description": "A site",
+        "properties": {
+          "id": { "type": "string", "description": "TODO" },
+          "name": { "type": "string", "description": "TODO" },
+          "url": { "type": "string", "description": "TODO" }
+        },
+        "required": ["id", "name", "url"]
+      },
+      "SiteList": {
+        "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" },
+          "rows": {
+            "type": "array",
+            "description": "TODO",
+            "items": {
+              "type": "array",
+              "$ref": "#/components/schemas/Site"
+            }
+          }
+        }
+      },
+      "SiteSso": {
+        "description": "SSO token or login URL",
+        "type": "object",
+        "properties": {
+          "sso": {
+            "type": "string",
+            "example": "$randomUrl",
+            "description": "TODO"
+          }
+        },
+        "required": ["sso"]
+      }
+    },
     "securitySchemes": {
       "bearerAuth": {
         "type": "http",
@@ -13,15 +59,21 @@
   "paths": {
     "/sites/{site_id}/sso": {
       "post": {
+        "summary": "Get SSO token",
+        "operationId": "site_sso",
+        "description": "TODO",
+        "tags": ["sites"],
         "security": [{ "bearerAuth": [] }],
-        "summary": "site_sso",
-        "description": "Return an SSO token or login URL for this site (if supported).",
         "parameters": [
           {
             "name": "site_id",
+            "description": "Specify the site id to get the SSO token for.",
             "in": "path",
             "required": true,
-            "schema": { "type": "integer" }
+            "schema": {
+              "type": "integer",
+              "description": "Specify the site id to get the SSO token for."
+            }
           }
         ],
         "responses": {
@@ -30,11 +82,10 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "type": "object",
-                  "properties": {
-                    "sso": { "type": "string", "example": "$randomUrl" }
-                  },
-                  "required": ["sso"]
+                  "$ref": "#/components/schemas/SiteSso"
+                },
+                "example": {
+                  "sso": "$randomUrl"
                 }
               }
             }
@@ -44,15 +95,20 @@
     },
     "/hosting/{hosting_id}/sites": {
       "get": {
+        "operationId": "get_hosting_sites",
+        "tags": ["sites"],
         "security": [{ "bearerAuth": [] }],
-        "summary": "site_list",
+        "summary": "Get sites for a hosting id",
         "description": "Obtain a list of sites.",
         "parameters": [
           {
             "name": "hosting_id",
             "in": "path",
             "required": true,
-            "schema": { "type": "integer" }
+            "schema": {
+              "type": "integer",
+              "description": "Specify the hosting id to get sites for."
+            }
           }
         ],
         "responses": {
@@ -61,26 +117,20 @@
             "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"]
-                      }
+                  "$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"
                     }
-                  },
-                  "required": ["limit", "n_pages", "n_rows", "page", "rows"]
+                  ]
                 }
               }
             }
@@ -88,5 +138,15 @@
         }
       }
     }
-  }
+  },
+  "servers": [
+    {
+      "url": "https://api.example.com/v1",
+      "description": "Production server (uses live data)"
+    },
+    {
+      "url": "https://sandbox-api.example.com:8443/v1",
+      "description": "Sandbox server (uses test data)"
+    }
+  ]
 }

package/orval.config.js

@@ -10,6 +10,7 @@ module.exports = {
       // schemas: "src/model",
       client: "react-query",
       mock: true,
+      clean: true,
     },
   },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@newfold/huapi-js",
-  "version": "1.0.3",
+  "version": "1.1.1",
   "main": "src/huapi.js",
   "license": "MIT",
   "devDependencies": {
@@ -13,13 +13,16 @@
     "typescript": "^4.6.3"
   },
   "peerDependencies": {
+    "@faker-js/faker": "^6.1.2",
+    "axios": "^0.26.1",
+    "msw": "^0.39.2",
+    "orval": "^6.7.1",
     "react": "^18.0.0",
-    "react-query": "^3.0.0"
+    "react-query": "^3.34.19"
   },
   "scripts": {
-    "clean": "rm -rf ./src",
     "orval": "orval",
     "tsToJs": "npx tsc ./src/*",
-    "build": "yarn clean && yarn orval && yarn tsToJs"
+    "build": "yarn orval && yarn tsToJs"
   }
 }

package/src/huapi.js

@@ -20,11 +20,12 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
     return to.concat(ar || Array.prototype.slice.call(from));
 };
 exports.__esModule = true;
-exports.getHostingUAPIMSW = exports.getGetHostingHostingIdSitesMock = exports.getPostSitesSiteIdSsoMock = exports.useGetHostingHostingIdSites = exports.getGetHostingHostingIdSitesQueryKey = exports.getHostingHostingIdSites = exports.usePostSitesSiteIdSso = exports.postSitesSiteIdSso = void 0;
+exports.getHostingUAPIMSW = exports.getGetHostingSitesMock = exports.getSiteSsoMock = exports.useGetHostingSites = exports.getGetHostingSitesQueryKey = exports.getHostingSites = exports.useSiteSso = exports.siteSso = void 0;
 /**
  * Generated by orval v6.7.1 🍺
  * Do not edit manually.
  * Hosting UAPI
+ * Hosting UAPI
  * OpenAPI spec version: 0.1.0
  */
 var axios_1 = require("axios");
@@ -32,50 +33,50 @@ var react_query_1 = require("react-query");
 var msw_1 = require("msw");
 var faker_1 = require("@faker-js/faker");
 /**
- * Return an SSO token or login URL for this site (if supported).
- * @summary site_sso
+ * TODO
+ * @summary Get SSO token
  */
-var postSitesSiteIdSso = function (siteId, options) {
+var siteSso = function (siteId, options) {
     return axios_1["default"].post("/sites/".concat(siteId, "/sso"), undefined, options);
 };
-exports.postSitesSiteIdSso = postSitesSiteIdSso;
-var usePostSitesSiteIdSso = function (options) {
+exports.siteSso = siteSso;
+var useSiteSso = function (options) {
     var _a = options || {}, mutationOptions = _a.mutation, axiosOptions = _a.axios;
     var mutationFn = function (props) {
         var siteId = (props || {}).siteId;
-        return (0, exports.postSitesSiteIdSso)(siteId, axiosOptions);
+        return (0, exports.siteSso)(siteId, axiosOptions);
     };
     return (0, react_query_1.useMutation)(mutationFn, mutationOptions);
 };
-exports.usePostSitesSiteIdSso = usePostSitesSiteIdSso;
+exports.useSiteSso = useSiteSso;
 /**
  * Obtain a list of sites.
- * @summary site_list
+ * @summary Get sites for a hosting id
  */
-var getHostingHostingIdSites = function (hostingId, options) {
+var getHostingSites = function (hostingId, options) {
     return axios_1["default"].get("/hosting/".concat(hostingId, "/sites"), options);
 };
-exports.getHostingHostingIdSites = getHostingHostingIdSites;
-var getGetHostingHostingIdSitesQueryKey = function (hostingId) { return ["/hosting/".concat(hostingId, "/sites")]; };
-exports.getGetHostingHostingIdSitesQueryKey = getGetHostingHostingIdSitesQueryKey;
-var useGetHostingHostingIdSites = function (hostingId, options) {
+exports.getHostingSites = getHostingSites;
+var getGetHostingSitesQueryKey = function (hostingId) { return ["/hosting/".concat(hostingId, "/sites")]; };
+exports.getGetHostingSitesQueryKey = getGetHostingSitesQueryKey;
+var useGetHostingSites = function (hostingId, options) {
     var _a;
     var _b = options || {}, queryOptions = _b.query, axiosOptions = _b.axios;
-    var queryKey = (_a = queryOptions === null || queryOptions === void 0 ? void 0 : queryOptions.queryKey) !== null && _a !== void 0 ? _a : (0, exports.getGetHostingHostingIdSitesQueryKey)(hostingId);
-    var queryFn = function () { return (0, exports.getHostingHostingIdSites)(hostingId, axiosOptions); };
+    var queryKey = (_a = queryOptions === null || queryOptions === void 0 ? void 0 : queryOptions.queryKey) !== null && _a !== void 0 ? _a : (0, exports.getGetHostingSitesQueryKey)(hostingId);
+    var queryFn = function () { return (0, exports.getHostingSites)(hostingId, axiosOptions); };
     var query = (0, react_query_1.useQuery)(queryKey, queryFn, __assign({ enabled: !!(hostingId) }, queryOptions));
     return __assign({ queryKey: queryKey }, query);
 };
-exports.useGetHostingHostingIdSites = useGetHostingHostingIdSites;
-var getPostSitesSiteIdSsoMock = function () { return ({ sso: faker_1.faker.random.word() }); };
-exports.getPostSitesSiteIdSsoMock = getPostSitesSiteIdSsoMock;
-var getGetHostingHostingIdSitesMock = function () { return ({ limit: faker_1.faker.random.word(), n_pages: faker_1.faker.random.word(), n_rows: faker_1.faker.random.word(), page: faker_1.faker.random.word(), rows: __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() }); }) }); };
-exports.getGetHostingHostingIdSitesMock = getGetHostingHostingIdSitesMock;
+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]) }); };
+exports.getGetHostingSitesMock = getGetHostingSitesMock;
 var getHostingUAPIMSW = function () { return [
     msw_1.rest.post('*/sites/:siteid/sso', function (_req, res, ctx) {
-        return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json((0, exports.getPostSitesSiteIdSsoMock)()));
+        return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json((0, exports.getSiteSsoMock)()));
     }), msw_1.rest.get('*/hosting/:hostingid/sites', function (_req, res, ctx) {
-        return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json((0, exports.getGetHostingHostingIdSitesMock)()));
+        return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json((0, exports.getGetHostingSitesMock)()));
     }),
 ]; };
 exports.getHostingUAPIMSW = getHostingUAPIMSW;

package/src/huapi.ts

@@ -1,150 +0,0 @@
-/**
- * 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'
-import {
-  rest
-} from 'msw'
-import {
-  faker
-} from '@faker-js/faker'
-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
-  }
-}
-
-
-
-
-export const getPostSitesSiteIdSsoMock = () => ({sso: faker.random.word()})
-
-export const getGetHostingHostingIdSitesMock = () => ({limit: faker.random.word(), n_pages: faker.random.word(), n_rows: faker.random.word(), page: faker.random.word(), rows: [...Array(faker.datatype.number({min: 1, max: 10}))].map(() => ({id: faker.random.word(), 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(getPostSitesSiteIdSsoMock()),
-        )
-      }),rest.get('*/hosting/:hostingid/sites', (_req, res, ctx) => {
-        return res(
-          ctx.delay(1000),
-          ctx.status(200, 'Mocked status'),
-ctx.json(getGetHostingHostingIdSitesMock()),
-        )
-      }),]