@newfold/huapi-js 1.2.0 → 1.2.3

package/README.md

@@ -4,7 +4,10 @@
 
 ## Installation
 
-TODO
+```sh
+$ yarn add @newfold/huapi-js
+# yarn package installed
+```
 
 ## Usage
 
@@ -13,11 +16,11 @@ TODO
 ```js
 import React from "react";
 
-import { useGetHostingSites } from "@newfold/huapi-js";
+import { useHostingSites } from "@newfold/huapi-js";
 
 const MyComponent = () => {
   const hostingId = "2";
-  const { isLoading, data } = useGetHostingSites(hostingId);
+  const { isLoading, data } = useHostingSites(hostingId);
 
   if (isLoading) return <h1>Loading...</h1>;
 

package/{src → dist}/huapi.js

@@ -10,17 +10,8 @@ var __assign = (this && this.__assign) || function () {
     };
     return __assign.apply(this, arguments);
 };
-var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
-    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
-        if (ar || !(i in from)) {
-            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
-            ar[i] = from[i];
-        }
-    }
-    return to.concat(ar || Array.prototype.slice.call(from));
-};
 exports.__esModule = true;
-exports.getHostingUAPIMSW = exports.getGetHostingSiteByIdMock = exports.getGetHostingSitesMock = exports.getSiteSsoMock = exports.useGetHostingSiteById = exports.getGetHostingSiteByIdQueryKey = exports.getHostingSiteById = exports.useGetHostingSites = exports.getGetHostingSitesQueryKey = exports.getHostingSites = exports.useSiteSso = exports.siteSso = void 0;
+exports.getHostingUAPIMSW = exports.getHostingSiteByIdMock = exports.getHostingSitesMock = exports.getSiteSsoMock = exports.useHostingSiteById = exports.getHostingSiteByIdQueryKey = exports.hostingSiteById = exports.useHostingSites = exports.getHostingSitesQueryKey = exports.hostingSites = exports.useSiteSso = exports.siteSso = void 0;
 /**
  * Generated by orval v6.7.1 🍺
  * Do not edit manually.
@@ -31,7 +22,6 @@ exports.getHostingUAPIMSW = exports.getGetHostingSiteByIdMock = exports.getGetHo
 var axios_1 = require("axios");
 var react_query_1 = require("react-query");
 var msw_1 = require("msw");
-var faker_1 = require("@faker-js/faker");
 /**
  * TODO
  * @summary Get SSO token
@@ -53,53 +43,53 @@ exports.useSiteSso = useSiteSso;
  * Obtain a list of sites.
  * @summary Get sites for a hosting id
  */
-var getHostingSites = function (hostingId, options) {
+var hostingSites = function (hostingId, options) {
     return axios_1["default"].get("/hosting/".concat(hostingId, "/sites"), options);
 };
-exports.getHostingSites = getHostingSites;
-var getGetHostingSitesQueryKey = function (hostingId) { return ["/hosting/".concat(hostingId, "/sites")]; };
-exports.getGetHostingSitesQueryKey = getGetHostingSitesQueryKey;
-var useGetHostingSites = function (hostingId, options) {
+exports.hostingSites = hostingSites;
+var getHostingSitesQueryKey = function (hostingId) { return ["/hosting/".concat(hostingId, "/sites")]; };
+exports.getHostingSitesQueryKey = getHostingSitesQueryKey;
+var useHostingSites = 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.getGetHostingSitesQueryKey)(hostingId);
-    var queryFn = function () { return (0, exports.getHostingSites)(hostingId, axiosOptions); };
+    var queryKey = (_a = queryOptions === null || queryOptions === void 0 ? void 0 : queryOptions.queryKey) !== null && _a !== void 0 ? _a : (0, exports.getHostingSitesQueryKey)(hostingId);
+    var queryFn = function () { return (0, exports.hostingSites)(hostingId, axiosOptions); };
     var query = (0, react_query_1.useQuery)(queryKey, queryFn, __assign({ enabled: !!(hostingId) }, queryOptions));
     return __assign({ queryKey: queryKey }, query);
 };
-exports.useGetHostingSites = useGetHostingSites;
+exports.useHostingSites = useHostingSites;
 /**
  * Obtain a specific site.
  * @summary For a hosting id, get a specific site by site id
  */
-var getHostingSiteById = function (hostingId, siteId, options) {
+var hostingSiteById = function (hostingId, siteId, options) {
     return axios_1["default"].get("/hosting/".concat(hostingId, "/sites/").concat(siteId), options);
 };
-exports.getHostingSiteById = getHostingSiteById;
-var getGetHostingSiteByIdQueryKey = function (hostingId, siteId) { return ["/hosting/".concat(hostingId, "/sites/").concat(siteId)]; };
-exports.getGetHostingSiteByIdQueryKey = getGetHostingSiteByIdQueryKey;
-var useGetHostingSiteById = function (hostingId, siteId, options) {
+exports.hostingSiteById = hostingSiteById;
+var getHostingSiteByIdQueryKey = function (hostingId, siteId) { return ["/hosting/".concat(hostingId, "/sites/").concat(siteId)]; };
+exports.getHostingSiteByIdQueryKey = getHostingSiteByIdQueryKey;
+var useHostingSiteById = function (hostingId, siteId, 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.getGetHostingSiteByIdQueryKey)(hostingId, siteId);
-    var queryFn = function () { return (0, exports.getHostingSiteById)(hostingId, siteId, axiosOptions); };
+    var queryKey = (_a = queryOptions === null || queryOptions === void 0 ? void 0 : queryOptions.queryKey) !== null && _a !== void 0 ? _a : (0, exports.getHostingSiteByIdQueryKey)(hostingId, siteId);
+    var queryFn = function () { return (0, exports.hostingSiteById)(hostingId, siteId, axiosOptions); };
     var query = (0, react_query_1.useQuery)(queryKey, queryFn, __assign({ enabled: !!(hostingId && siteId) }, queryOptions));
     return __assign({ queryKey: queryKey }, query);
 };
-exports.useGetHostingSiteById = useGetHostingSiteById;
-var getSiteSsoMock = function () { return ({ sso: faker_1.faker.random.word() }); };
+exports.useHostingSiteById = useHostingSiteById;
+var getSiteSsoMock = function () { return ('https://bobtheblog.com/wp-login.php?ssotoken=1234567890'); };
 exports.getSiteSsoMock = getSiteSsoMock;
-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.random.word(), name: faker_1.faker.random.word(), url: faker_1.faker.random.word() }); }) }); };
-exports.getGetHostingSitesMock = getGetHostingSitesMock;
-var getGetHostingSiteByIdMock = function () { return ({ id: faker_1.faker.random.word(), name: faker_1.faker.random.word(), url: faker_1.faker.random.word() }); };
-exports.getGetHostingSiteByIdMock = getGetHostingSiteByIdMock;
+var getHostingSitesMock = function () { return ({ limit: 10, n_pages: 1, n_rows: 3, page: 1, rows: [{ id: '1', name: 'Bob the Blog', url: 'https://bobtheblog.com' }, { id: '2', name: 'Wendy the Website', url: 'https://wendythewebsite.com' }, { id: '3', name: 'Cathy the Coding Camp', url: 'https://cathythecodingcamp.com' }] }); };
+exports.getHostingSitesMock = getHostingSitesMock;
+var getHostingSiteByIdMock = function () { return ({ id: '1', name: 'Bob the Blog', url: 'https://bobtheblog.com' }); };
+exports.getHostingSiteByIdMock = getHostingSiteByIdMock;
 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.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.getGetHostingSitesMock)()));
+        return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json((0, exports.getHostingSitesMock)()));
     }), msw_1.rest.get('*/hosting/:hostingid/sites/:siteid', function (_req, res, ctx) {
-        return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json((0, exports.getGetHostingSiteByIdMock)()));
+        return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json((0, exports.getHostingSiteByIdMock)()));
     }),
 ]; };
 exports.getHostingUAPIMSW = getHostingUAPIMSW;

package/openapi.json

@@ -165,7 +165,7 @@
     },
     "/hosting/{hosting_id}/sites": {
       "get": {
-        "operationId": "get_hosting_sites",
+        "operationId": "hosting_sites",
         "tags": ["sites"],
         "security": [{ "bearerAuth": [] }],
         "summary": "Get sites for a hosting id",
@@ -197,7 +197,7 @@
     },
     "/hosting/{hosting_id}/sites/{site_id}": {
       "get": {
-        "operationId": "get_hosting_site_by_id",
+        "operationId": "hosting_site_by_id",
         "tags": ["sites"],
         "security": [{ "bearerAuth": [] }],
         "summary": "For a hosting id, get a specific site by site id",

package/orval.config.js

@@ -1,16 +1,45 @@
-module.exports = {
+import { defineConfig } from "orval";
+
+import { sites, site, siteSso } from "./src/mocks/sites";
+
+const input = {
+  target: "./openapi.json",
+  validation: true,
+};
+
+const output = {
+  // mode: "tags-split",
+  target: "./dist/huapi.ts",
+  // schemas: "dist/model",
+  client: "react-query",
+  mock: true,
+  clean: true,
+};
+
+export default defineConfig({
   huapi: {
-    input: {
-      target: "./openapi.json",
-      validation: true,
-    },
+    input,
     output: {
-      // mode: "tags-split",
-      target: "./src/huapi.ts",
-      // schemas: "src/model",
-      client: "react-query",
-      mock: true,
-      clean: true,
+      ...output,
+      override: {
+        operations: {
+          site_sso: {
+            mock: {
+              data: siteSso,
+            },
+          },
+          hosting_sites: {
+            mock: {
+              data: sites,
+            },
+          },
+          hosting_site_by_id: {
+            mock: {
+              data: site,
+            },
+          },
+        },
+      },
     },
   },
-};
+});

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@newfold/huapi-js",
-  "version": "1.2.0",
-  "main": "src/huapi.js",
+  "version": "1.2.3",
+  "main": "dist/huapi.js",
   "license": "MIT",
   "devDependencies": {
     "@faker-js/faker": "^6.1.2",
@@ -22,7 +22,7 @@
   },
   "scripts": {
     "orval": "orval",
-    "tsToJs": "npx tsc ./src/*",
+    "tsToJs": "npx tsc ./dist/*",
     "build": "yarn orval && yarn tsToJs"
   }
 }

package/src/mocks/sites.js

@@ -0,0 +1,29 @@
+export const sites = {
+  limit: 10,
+  n_pages: 1,
+  n_rows: 3,
+  page: 1,
+  rows: [
+    {
+      id: "1",
+      name: "Bob the Blog",
+      url: "https://bobtheblog.com",
+    },
+    {
+      id: "2",
+      name: "Wendy the Website",
+      url: "https://wendythewebsite.com",
+    },
+    {
+      id: "3",
+      name: "Cathy the Coding Camp",
+      url: "https://cathythecodingcamp.com",
+    },
+  ],
+};
+
+// TODO: would be nice if we could take in the param (siteId) and return the proper site,
+// but currently we are just dumbly returning the same site regardless of siteId
+export const site = sites.rows[0];
+
+export const siteSso = `${sites.rows[0].url}/wp-login.php?ssotoken=1234567890`;

package/src/huapi.ts

@@ -1,221 +0,0 @@
-/**
- * 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: string;
-  /** 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
-  }
-}
-
-
-/**
- * Obtain a specific site.
- * @summary For a hosting id, get a specific site by site id
- */
-export const getHostingSiteById = (
-    hostingId: number,
-    siteId: string, options?: AxiosRequestConfig
- ): Promise<AxiosResponse<Site>> => {
-    return axios.get(
-      `/hosting/${hostingId}/sites/${siteId}`,options
-    );
-  }
-
-
-export const getGetHostingSiteByIdQueryKey = (hostingId: number,
-    siteId: string,) => [`/hosting/${hostingId}/sites/${siteId}`];
-
-    
-export type GetHostingSiteByIdQueryResult = NonNullable<AsyncReturnType<typeof getHostingSiteById>>
-export type GetHostingSiteByIdQueryError = AxiosError<unknown>
-
-export const useGetHostingSiteById = <TData = AsyncReturnType<typeof getHostingSiteById>, TError = AxiosError<unknown>>(
- hostingId: number,
-    siteId: string, options?: { query?:UseQueryOptions<AsyncReturnType<typeof getHostingSiteById>, TError, TData>, axios?: AxiosRequestConfig}
-
-  ):  UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
-
-  const {query: queryOptions, axios: axiosOptions} = options || {}
-
-  const queryKey = queryOptions?.queryKey ?? getGetHostingSiteByIdQueryKey(hostingId,siteId);
-
-  
-
-  const queryFn: QueryFunction<AsyncReturnType<typeof getHostingSiteById>> = () => getHostingSiteById(hostingId,siteId, axiosOptions);
-
-  const query = useQuery<AsyncReturnType<typeof getHostingSiteById>, TError, TData>(queryKey, queryFn, {enabled: !!(hostingId && siteId), ...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.random.word(), name: faker.random.word(), url: faker.random.word()}))})
-
-export const getGetHostingSiteByIdMock = () => ({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(getSiteSsoMock()),
-        )
-      }),rest.get('*/hosting/:hostingid/sites', (_req, res, ctx) => {
-        return res(
-          ctx.delay(1000),
-          ctx.status(200, 'Mocked status'),
-ctx.json(getGetHostingSitesMock()),
-        )
-      }),rest.get('*/hosting/:hostingid/sites/:siteid', (_req, res, ctx) => {
-        return res(
-          ctx.delay(1000),
-          ctx.status(200, 'Mocked status'),
-ctx.json(getGetHostingSiteByIdMock()),
-        )
-      }),]