@newfold/huapi-js 1.2.1 → 1.2.4

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

@@ -77,11 +77,11 @@ var useHostingSiteById = function (hostingId, siteId, options) {
     return __assign({ queryKey: queryKey }, query);
 };
 exports.useHostingSiteById = useHostingSiteById;
-var getSiteSsoMock = function () { return ('https://parched-robe.name/wp-login.php?ssotoken=1234567890'); };
+var getSiteSsoMock = function () { return ('https://bobtheblog.com/wp-login.php?ssotoken=1234567890'); };
 exports.getSiteSsoMock = getSiteSsoMock;
-var getHostingSitesMock = function () { return ({ limit: 10, n_pages: 1, n_rows: 3, page: 1, rows: [{ id: 0, name: 'Murazik - Weber', url: 'https://parched-robe.name' }, { id: 1, name: 'Gutmann - Bahringer', url: 'http://kindhearted-boogeyman.com' }, { id: 2, name: 'Volkman - Stiedemann', url: 'https://coarse-vendor.com' }] }); };
+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: 0, name: 'Murazik - Weber', url: 'https://parched-robe.name' }); };
+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) {

package/orval.config.js

@@ -1,6 +1,7 @@
-import { faker } from "@faker-js/faker";
 import { defineConfig } from "orval";
 
+import { sites, site, siteSso } from "./src/mocks/sites";
+
 const input = {
   target: "./openapi.json",
   validation: true,
@@ -8,36 +9,23 @@ const input = {
 
 const output = {
   // mode: "tags-split",
-  target: "./src/huapi.ts",
-  // schemas: "src/model",
+  target: "./dist/huapi.ts",
+  // schemas: "dist/model",
   client: "react-query",
   mock: true,
   clean: true,
 };
 
-const sites = {
-  limit: 10,
-  n_pages: 1,
-  n_rows: 3,
-  page: 1,
-  rows: [...Array(3)].map((site, idx) => ({
-    id: idx,
-    name: faker.company.companyName(),
-    url: faker.internet.url(),
-  })),
-};
-
 export default defineConfig({
   huapi: {
     input,
     output: {
       ...output,
-      target: "./src/huapi.ts",
       override: {
         operations: {
           site_sso: {
             mock: {
-              data: `${sites.rows[0].url}/wp-login.php?ssotoken=1234567890`,
+              data: siteSso,
             },
           },
           hosting_sites: {
@@ -47,7 +35,7 @@ export default defineConfig({
           },
           hosting_site_by_id: {
             mock: {
-              data: sites.rows[0],
+              data: site,
             },
           },
         },

package/package.json

@@ -1,28 +1,26 @@
 {
   "name": "@newfold/huapi-js",
-  "version": "1.2.1",
-  "main": "src/huapi.js",
+  "version": "1.2.4",
+  "main": "dist/huapi.js",
   "license": "MIT",
-  "devDependencies": {
+  "dependencies": {
     "@faker-js/faker": "^6.1.2",
     "axios": "^0.26.1",
     "msw": "^0.39.2",
+    "react-query": "^3.34.19"
+  },
+  "devDependencies": {
     "orval": "^6.7.1",
-    "react": "^18.0.0",
-    "react-query": "^3.34.19",
+    "react": "^17.0.0",
     "typescript": "^4.6.3"
   },
   "peerDependencies": {
-    "@faker-js/faker": "^6.1.2",
-    "axios": "^0.26.1",
-    "msw": "^0.39.2",
-    "orval": "^6.7.1",
-    "react": "^17.0.2",
+    "react": "^17.0.0 || ^18.0.0",
     "react-query": "^3.34.19"
   },
   "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,218 +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'
-/**
- * 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 hostingSites = (
-    hostingId: number, options?: AxiosRequestConfig
- ): Promise<AxiosResponse<SiteList>> => {
-    return axios.get(
-      `/hosting/${hostingId}/sites`,options
-    );
-  }
-
-
-export const getHostingSitesQueryKey = (hostingId: number,) => [`/hosting/${hostingId}/sites`];
-
-    
-export type HostingSitesQueryResult = NonNullable<AsyncReturnType<typeof hostingSites>>
-export type HostingSitesQueryError = AxiosError<unknown>
-
-export const useHostingSites = <TData = AsyncReturnType<typeof hostingSites>, TError = AxiosError<unknown>>(
- hostingId: number, options?: { query?:UseQueryOptions<AsyncReturnType<typeof hostingSites>, TError, TData>, axios?: AxiosRequestConfig}
-
-  ):  UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
-
-  const {query: queryOptions, axios: axiosOptions} = options || {}
-
-  const queryKey = queryOptions?.queryKey ?? getHostingSitesQueryKey(hostingId);
-
-  
-
-  const queryFn: QueryFunction<AsyncReturnType<typeof hostingSites>> = () => hostingSites(hostingId, axiosOptions);
-
-  const query = useQuery<AsyncReturnType<typeof hostingSites>, 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 hostingSiteById = (
-    hostingId: number,
-    siteId: string, options?: AxiosRequestConfig
- ): Promise<AxiosResponse<Site>> => {
-    return axios.get(
-      `/hosting/${hostingId}/sites/${siteId}`,options
-    );
-  }
-
-
-export const getHostingSiteByIdQueryKey = (hostingId: number,
-    siteId: string,) => [`/hosting/${hostingId}/sites/${siteId}`];
-
-    
-export type HostingSiteByIdQueryResult = NonNullable<AsyncReturnType<typeof hostingSiteById>>
-export type HostingSiteByIdQueryError = AxiosError<unknown>
-
-export const useHostingSiteById = <TData = AsyncReturnType<typeof hostingSiteById>, TError = AxiosError<unknown>>(
- hostingId: number,
-    siteId: string, options?: { query?:UseQueryOptions<AsyncReturnType<typeof hostingSiteById>, TError, TData>, axios?: AxiosRequestConfig}
-
-  ):  UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
-
-  const {query: queryOptions, axios: axiosOptions} = options || {}
-
-  const queryKey = queryOptions?.queryKey ?? getHostingSiteByIdQueryKey(hostingId,siteId);
-
-  
-
-  const queryFn: QueryFunction<AsyncReturnType<typeof hostingSiteById>> = () => hostingSiteById(hostingId,siteId, axiosOptions);
-
-  const query = useQuery<AsyncReturnType<typeof hostingSiteById>, TError, TData>(queryKey, queryFn, {enabled: !!(hostingId && siteId), ...queryOptions})
-
-  return {
-    queryKey,
-    ...query
-  }
-}
-
-
-
-
-export const getSiteSsoMock = () => ('https://parched-robe.name/wp-login.php?ssotoken=1234567890')
-
-export const getHostingSitesMock = () => ({ limit: 10, n_pages: 1, n_rows: 3, page: 1, rows: [{ id: 0, name: 'Murazik - Weber', url: 'https://parched-robe.name', }, { id: 1, name: 'Gutmann - Bahringer', url: 'http://kindhearted-boogeyman.com', }, { id: 2, name: 'Volkman - Stiedemann', url: 'https://coarse-vendor.com', }], })
-
-export const getHostingSiteByIdMock = () => ({ id: 0, name: 'Murazik - Weber', url: 'https://parched-robe.name', })
-
-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(getHostingSitesMock()),
-        )
-      }),rest.get('*/hosting/:hostingid/sites/:siteid', (_req, res, ctx) => {
-        return res(
-          ctx.delay(1000),
-          ctx.status(200, 'Mocked status'),
-ctx.json(getHostingSiteByIdMock()),
-        )
-      }),]