@newfold/huapi-js 1.2.3 → 1.2.6

package/openapi.json

@@ -194,47 +194,6 @@
           }
         }
       }
-    },
-    "/hosting/{hosting_id}/sites/{site_id}": {
-      "get": {
-        "operationId": "hosting_site_by_id",
-        "tags": ["sites"],
-        "security": [{ "bearerAuth": [] }],
-        "summary": "For a hosting id, get a specific site by site id",
-        "description": "Obtain a specific site.",
-        "parameters": [
-          {
-            "name": "hosting_id",
-            "in": "path",
-            "required": true,
-            "schema": {
-              "type": "integer",
-              "description": "Specify the hosting id to get sites for."
-            }
-          },
-          {
-            "name": "site_id",
-            "in": "path",
-            "required": true,
-            "schema": {
-              "type": "string",
-              "description": "Specify the site id to get the site for."
-            }
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "OK",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/Site"
-                }
-              }
-            }
-          }
-        }
-      }
     }
   },
   "servers": [

package/orval.config.js

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

package/package.json

@@ -1,23 +1,21 @@
 {
   "name": "@newfold/huapi-js",
-  "version": "1.2.3",
+  "version": "1.2.6",
   "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": {

package/prettier.config.js

@@ -0,0 +1,4 @@
+module.exports = {
+  singleQuote: true,
+  trailingComma: "all",
+};

package/src/msw/handlers/index.js

@@ -0,0 +1,5 @@
+/**
+ * NOTE: this will move to @newfold/huapi-js in the future
+ * Usage: `import { getHostingSitesHandler } from '@newfold/huapi-js';`
+ */
+export * from './sites/getHostingSitesHandler';

package/src/msw/handlers/sites/data/sites.js

@@ -0,0 +1,172 @@
+const rows = [
+  {
+    id: '1',
+    name: 'Site 1',
+    url: 'https://www.bluehost.com',
+  },
+  {
+    id: '2',
+    name: 'Site 2',
+    url: 'https://www.web.com',
+  },
+  {
+    id: '3',
+    name: 'Site 3',
+    url: 'https://www.bluehost.com',
+  },
+  {
+    id: '4',
+    name: 'Site 4',
+    url: 'https://www.web.com',
+  },
+  {
+    id: '5',
+    name: 'Site 5',
+    url: 'https://www.bluehost.com',
+  },
+  {
+    id: '6',
+    name: 'Site 6',
+    url: 'https://www.web.com',
+  },
+  {
+    id: '7',
+    name: 'Site 7',
+    url: 'https://www.bluehost.com',
+  },
+  {
+    id: '8',
+    name: 'Site 8',
+    url: 'https://www.web.com',
+  },
+  {
+    id: '9',
+    name: 'Site 9',
+    url: 'https://www.bluehost.com',
+  },
+  {
+    id: '10',
+    name: 'Site 10',
+    url: 'https://www.web.com',
+  },
+];
+
+export const sitesResponses = {
+  200: {
+    0: {
+      limit: 10,
+      n_pages: 0,
+      n_rows: 0,
+      page: 1,
+      rows: [],
+    },
+
+    1: {
+      limit: 10,
+      n_pages: 1,
+      n_rows: 1,
+      page: 1,
+      rows: [rows[0]],
+    },
+
+    some: {
+      limit: 10,
+      n_pages: 1,
+      n_rows: 3,
+      page: 1,
+      rows,
+    },
+
+    many: {
+      limit: 10,
+      n_pages: 50,
+      n_rows: 3,
+      page: 1,
+      rows: [
+        ...rows,
+        {
+          id: '11',
+          name: 'Site 11',
+          url: 'https://www.bluehost.com',
+        },
+        {
+          id: '12',
+          name: 'Site 12',
+          url: 'https://www.web.com',
+        },
+        {
+          id: '13',
+          name: 'Site 13',
+          url: 'https://www.bluehost.com',
+        },
+        {
+          id: '14',
+          name: 'Site 14',
+          url: 'https://www.web.com',
+        },
+        {
+          id: '15',
+          name: 'Site 15',
+          url: 'https://www.bluehost.com',
+        },
+        {
+          id: '16',
+          name: 'Site 16',
+          url: 'https://www.web.com',
+        },
+        {
+          id: '17',
+          name: 'Site 17',
+          url: 'https://www.bluehost.com',
+        },
+        {
+          id: '18',
+          name: 'Site 18',
+          url: 'https://www.web.com',
+        },
+        {
+          id: '19',
+          name: 'Site 19',
+          url: 'https://www.bluehost.com',
+        },
+        {
+          id: '20',
+          name: 'Site 20',
+          url: 'https://www.web.com',
+        },
+        {
+          id: '21',
+          name: 'Site 21',
+          url: 'https://www.bluehost.com',
+        },
+        {
+          id: '22',
+          name: 'Site 22',
+          url: 'https://www.web.com',
+        },
+        {
+          id: '23',
+          name: 'Site 23',
+          url: 'https://www.bluehost.com',
+        },
+        {
+          id: '24',
+          name: 'Site 24',
+          url: 'https://www.web.com',
+        },
+        {
+          id: '25',
+          name: 'Site 25',
+          url: 'https://www.bluehost.com',
+        },
+      ],
+    },
+  },
+  500: {
+    0: {
+      message: 'Something went wrong',
+    },
+  },
+};
+
+export default sitesResponses;

package/src/msw/handlers/sites/getHostingSitesHandler.js

@@ -0,0 +1,24 @@
+import { rest } from 'msw';
+
+import responses from './data/sites';
+
+/**
+ * getHostingSitesHandler
+ * @param {string} responseKey - the key of the response to return from the responses object
+ * @param {int} status - the status code to mock
+ * @param {int} delay - the delay in ms to wait before returning the response
+ * @returns - a msw handler
+ */
+export function getHostingSitesHandler(
+  responseKey = 1, // int or string
+  status = 200,
+  delay = 1000,
+) {
+  return rest.get('*/hosting/:hostingId/sites', (req, res, ctx) =>
+    res(
+      ctx.delay(delay),
+      ctx.status(status, 'Mocked status'),
+      ctx.json(responses[status][responseKey ?? 0]),
+    ),
+  );
+}

package/src/msw/sites.js

@@ -0,0 +1,153 @@
+const sitesCollection = [
+  {
+    id: '1',
+    name: 'Coffee Beans',
+    url: 'https://coffeebeans.com',
+  },
+  {
+    id: '2',
+    name: 'Chilli Beans',
+    url: 'https://chillibeans.com',
+  },
+  {
+    id: '3',
+    name: 'Cannellini Beans',
+    url: 'https://cannellinibeans.com',
+  },
+  {
+    id: '4',
+    name: 'Soy Beans',
+    url: 'https://soybeans.com',
+  },
+  {
+    id: '5',
+    name: 'Cool Beans',
+    url: 'https://coolbeans.com',
+  },
+  {
+    id: '6',
+    name: 'Hot Beans',
+    url: 'https://hotbeans.com',
+  },
+  {
+    id: '7',
+    name: 'Black Beans',
+    url: 'https://blackbeans.com',
+  },
+  {
+    id: '8',
+    name: 'Pinto Beans',
+    url: 'https://pintobeans.com',
+  },
+  {
+    id: '9',
+    name: 'Refried Beans',
+    url: 'https://refriedbeans.com',
+  },
+  {
+    id: '10',
+    name: 'Baked Beans',
+    url: 'https://bakedbeans.com',
+  },
+  {
+    id: '11',
+    name: 'Lima Beans',
+    url: 'https://limabeans.com',
+  },
+  {
+    id: '12',
+    name: 'Kidney Beans',
+    url: 'https://kidneybeans.com',
+  },
+];
+
+export const sites = ({ responseType, page }) => {
+  const pageOne = {
+    limit: 10,
+    n_pages: 2,
+    n_rows: 3,
+    page: 1,
+    rows: sitesCollection,
+  };
+
+  const pageTwo = {
+    limit: 10,
+    n_pages: 2,
+    n_rows: 3,
+    page: 2,
+    rows: [
+      {
+        id: '11',
+        name: 'Bob the Blog',
+        url: 'https://bobtheblog.com',
+      },
+      {
+        id: '12',
+        name: 'Wendy the Website',
+        url: 'https://wendythewebsite.com',
+      },
+      {
+        id: '13',
+        name: 'Cathy the Coding Camp',
+        url: 'https://cathythecodingcamp.com',
+      },
+      {
+        id: '14',
+        name: 'Harry Potter',
+        url: 'https://hogwarts.com',
+      },
+      {
+        id: '15',
+        name: 'Cool Beans',
+        url: 'https://coolbeans.com',
+      },
+      {
+        id: '16',
+        name: 'Hot Beans',
+        url: 'https://hotbeans.com',
+      },
+      {
+        id: '17',
+        name: 'Black Beans',
+        url: 'https://blackbeans.com',
+      },
+      {
+        id: '18',
+        name: 'Pinto Beans',
+        url: 'https://pintobeans.com',
+      },
+      {
+        id: '19',
+        name: 'Refried Beans',
+        url: 'https://refriedbeans.com',
+      },
+      {
+        id: '20',
+        name: 'Baked Beans',
+        url: 'https://bakedbeans.com',
+      },
+    ],
+  };
+
+  const resp = page === 1 ? pageOne : pageTwo;
+  switch (responseType) {
+    case 'empty':
+      resp.rows = [];
+      break;
+    case 'one':
+      resp.rows = resp.rows[0];
+      break;
+    case 'some':
+      resp.rows = resp.rows.slice(0, 5);
+      break;
+    default:
+      break;
+  }
+  return resp;
+};
+
+// 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 = sitesCollection[0];
+
+export const siteSso = `${sitesCollection[0].url}/wp-login.php?ssotoken=1234567890`;

package/dist/huapi.js

@@ -1,95 +0,0 @@
-"use strict";
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
-exports.__esModule = true;
-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.
- * Hosting UAPI
- * Hosting UAPI
- * OpenAPI spec version: 0.1.0
- */
-var axios_1 = require("axios");
-var react_query_1 = require("react-query");
-var msw_1 = require("msw");
-/**
- * TODO
- * @summary Get SSO token
- */
-var siteSso = function (siteId, options) {
-    return axios_1["default"].post("/sites/".concat(siteId, "/sso"), undefined, 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.siteSso)(siteId, axiosOptions);
-    };
-    return (0, react_query_1.useMutation)(mutationFn, mutationOptions);
-};
-exports.useSiteSso = useSiteSso;
-/**
- * Obtain a list of sites.
- * @summary Get sites for a hosting id
- */
-var hostingSites = function (hostingId, options) {
-    return axios_1["default"].get("/hosting/".concat(hostingId, "/sites"), 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.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.useHostingSites = useHostingSites;
-/**
- * Obtain a specific site.
- * @summary For a hosting id, get a specific site by site id
- */
-var hostingSiteById = function (hostingId, siteId, options) {
-    return axios_1["default"].get("/hosting/".concat(hostingId, "/sites/").concat(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.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.useHostingSiteById = useHostingSiteById;
-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: '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.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.getHostingSiteByIdMock)()));
-    }),
-]; };
-exports.getHostingUAPIMSW = getHostingUAPIMSW;

package/src/mocks/sites.js

@@ -1,29 +0,0 @@
-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`;