refactor(hub-sites): move getSiteById and supporting functions to hub…

…-common

affects: @esri/hub-common, @esri/hub-sites

packages/sites/src/_apply-site-schema.ts → packages/common/src/sites/_apply-site-schema.ts

@@ -1,4 +1,6 @@
-import { IModel, getProp, cloneObject } from "@esri/hub-common";
+import { getProp } from "../objects";
+import { IModel } from "../types";
+import { cloneObject } from "../util";
 
 /**
  * Apply the first schema version to the item
@@ -11,7 +13,7 @@ export function _applySiteSchema(model: IModel) {
 
   const clone = cloneObject(model);
   // proactively purge old properties
-  ["groupId", "title"].forEach(prop => {
+  ["groupId", "title"].forEach((prop) => {
     delete clone.data.values[prop];
   });
   // ensure item.properties

packages/sites/src/_enforce-lowercase-domains.ts → packages/common/src/sites/_enforce-lowercase-domains.ts

@@ -1,4 +1,4 @@
-import { IModel, getProp, cloneObject } from "@esri/hub-common";
+import { IModel, getProp, cloneObject } from "..";
 
 /**
  * Enforce lowercase domains
@@ -16,8 +16,8 @@ export function _enforceLowercaseDomains(model: IModel) {
     "defaultHostname",
     "internalUrl",
     "customHostname",
-    "externalUrl"
-  ].forEach(prop => {
+    "externalUrl",
+  ].forEach((prop) => {
     if (
       clone.data.values[prop] &&
       typeof clone.data.values[prop] === "string"

packages/sites/src/_ensure-catalog.ts → packages/common/src/sites/_ensure-catalog.ts

@@ -1,4 +1,4 @@
-import { IModel, getProp, cloneObject } from "@esri/hub-common";
+import { IModel, getProp, cloneObject } from "..";
 
 /**
  * Move the data.values.groups array into the

packages/sites/src/_ensure-telemetry.ts → packages/common/src/sites/_ensure-telemetry.ts

@@ -1,11 +1,4 @@
-import {
-  IModel,
-  getProp,
-  setProp,
-  deleteProp,
-  cloneObject,
-  IDraft
-} from "@esri/hub-common";
+import { IModel, IDraft, getProp, cloneObject, deleteProp, setProp } from "..";
 
 /**
  * Add telemetry config object
@@ -21,16 +14,16 @@ export function _ensureTelemetry<T extends IModel | IDraft>(model: T): T {
     consentNotice: {
       isTheme: true,
       consentText: "",
-      policyURL: ""
+      policyURL: "",
     },
     customAnalytics: {
       ga: {
         customerTracker: {
           enabled: Boolean(gacode),
-          id: gacode
-        }
-      }
-    }
+          id: gacode,
+        },
+      },
+    },
   };
   deleteProp(clone, "data.values.gacode");
 

packages/sites/src/_purge-non-guids-from-catalog.ts → packages/common/src/sites/_purge-non-guids-from-catalog.ts

@@ -1,4 +1,4 @@
-import { IModel, getProp, cloneObject, isGuid } from "@esri/hub-common";
+import { IModel, getProp, cloneObject, isGuid } from "..";
 
 /**
  * Remove any non-guid entries from the data catalog groups array

packages/sites/src/drafts/build-draft.ts → packages/common/src/sites/drafts/build-draft.ts

@@ -1,4 +1,4 @@
-import { mergeObjects, IModel, IDraft } from "@esri/hub-common";
+import { IModel, IDraft, mergeObjects } from "../..";
 
 /**
  * Builds a draft with a subset of the model properties

packages/common/src/sites/drafts/index.ts

@@ -0,0 +1 @@
+export * from "./build-draft";

packages/sites/src/get-site-by-id.ts → packages/common/src/sites/get-site-by-id.ts

@@ -1,5 +1,5 @@
-import { IHubRequestOptions, getModel } from "@esri/hub-common";
-import { upgradeSiteSchema } from "./upgrade-site-schema";
+import { upgradeSiteSchema } from ".";
+import { IHubRequestOptions, getModel } from "..";
 
 /**
  * Get a Site Model by it's Item Id, and apply schema upgrades

packages/common/src/sites/index.ts

@@ -1 +1,6 @@
 export * from "./domains";
+export * from "./drafts";
+export * from "./_ensure-telemetry";
+export * from "./get-site-by-id";
+export * from "./site-schema-version";
+export * from "./upgrade-site-schema";

packages/common/src/sites/site-schema-version.ts

@@ -0,0 +1 @@
+export const SITE_SCHEMA_VERSION = 1.4;

packages/sites/src/upgrade-site-schema.ts → packages/common/src/sites/upgrade-site-schema.ts

@@ -1,4 +1,5 @@
-import { IModel, getProp } from "@esri/hub-common";
+import { IModel } from "../types";
+import { getProp } from "../objects";
 import { SITE_SCHEMA_VERSION } from "./site-schema-version";
 import { _applySiteSchema } from "./_apply-site-schema";
 import { _enforceLowercaseDomains } from "./_enforce-lowercase-domains";

packages/sites/test/_apply-site-schema.test.ts → packages/common/test/sites/_apply-site-schema.test.ts

@@ -1,21 +1,21 @@
-import { _applySiteSchema } from "../src";
-import { IModel } from "@esri/hub-common";
+import { IModel } from "../../src";
+import { _applySiteSchema } from "../../src/sites/_apply-site-schema";
 
 describe("_applySiteSchema", () => {
-  it("fixes groups array", function() {
-    const model = ({
+  it("fixes groups array", function () {
+    const model = {
       item: {
         id: "3ef",
-        properties: {}
+        properties: {},
       },
       data: {
         values: {
           groupId: "shouldberemoved",
           title: "should also be remnoved",
-          groups: ["4bc", { id: "fromObj" }, "54b", { id: "secondObj" }]
-        }
-      }
-    } as unknown) as IModel;
+          groups: ["4bc", { id: "fromObj" }, "54b", { id: "secondObj" }],
+        },
+      },
+    } as unknown as IModel;
     const chk = _applySiteSchema(model);
     expect(chk.item.properties.schemaVersion).toBe(
       1,
@@ -32,41 +32,41 @@ describe("_applySiteSchema", () => {
     );
   });
 
-  it("doesnt blow up with no groups or properties", function() {
-    const model = ({
+  it("doesnt blow up with no groups or properties", function () {
+    const model = {
       item: {
-        id: "3ef"
+        id: "3ef",
       },
       data: {
         values: {
           groupId: "shouldberemoved",
-          title: "should also be remnoved"
-        }
-      }
-    } as unknown) as IModel;
+          title: "should also be remnoved",
+        },
+      },
+    } as unknown as IModel;
     const chk = _applySiteSchema(model);
     expect(chk.item.properties.schemaVersion).toBe(
       1,
       "should apply a schema version"
     );
   });
 
-  it("does nothing if schema >= 1", function() {
-    const model = ({
+  it("does nothing if schema >= 1", function () {
+    const model = {
       item: {
         id: "3ef",
         properties: {
-          schemaVersion: 1
-        }
+          schemaVersion: 1,
+        },
       },
       data: {
         values: {
           groupId: "shouldberemoved",
           title: "should also be remnoved",
-          groups: ["4bc", { id: "fromObj" }, "54b", { id: "secondObj" }]
-        }
-      }
-    } as unknown) as IModel;
+          groups: ["4bc", { id: "fromObj" }, "54b", { id: "secondObj" }],
+        },
+      },
+    } as unknown as IModel;
     const chk = _applySiteSchema(model);
     expect(chk).toEqual(model);
   });

packages/sites/test/_enforce-lowercase-domains.test.ts → packages/common/test/sites/_enforce-lowercase-domains.test.ts

@@ -1,22 +1,22 @@
-import { _enforceLowercaseDomains } from "../src";
-import { IModel } from "@esri/hub-common";
+import { IModel } from "../../src";
+import { _enforceLowercaseDomains } from "../../src/sites/_enforce-lowercase-domains";
 
 describe("_enforceLowercaseDomains", () => {
   it("enforces lowercase domains", async () => {
-    const model = ({
+    const model = {
       item: {
         properties: {
-          schemaVersion: 1.0
-        }
+          schemaVersion: 1.0,
+        },
       },
       data: {
         values: {
           subdomain: "Capitalized",
           defaultHostname: "CaPitaliZed",
-          internalUrl: {} // not a string
-        }
-      }
-    } as unknown) as IModel;
+          internalUrl: {}, // not a string
+        },
+      },
+    } as unknown as IModel;
 
     const chk = _enforceLowercaseDomains(model);
 
@@ -27,20 +27,20 @@ describe("_enforceLowercaseDomains", () => {
   });
 
   it("does nothing if schema >= 1.1", async () => {
-    const model = ({
+    const model = {
       item: {
         properties: {
-          schemaVersion: 1.1
-        }
+          schemaVersion: 1.1,
+        },
       },
       data: {
         values: {
           subdomain: "Capitalized",
           defaultHostname: "CaPitaliZed",
-          internalUrl: {} // not a string
-        }
-      }
-    } as unknown) as IModel;
+          internalUrl: {}, // not a string
+        },
+      },
+    } as unknown as IModel;
 
     const chk = _enforceLowercaseDomains(model);
 

packages/sites/test/_ensure-catalog.test.ts → packages/common/test/sites/_ensure-catalog.test.ts

@@ -1,19 +1,19 @@
-import { _ensureCatalog } from "../src";
-import { IModel } from "@esri/hub-common";
+import { IModel } from "../../src";
+import { _ensureCatalog } from "../../src/sites/_ensure-catalog";
 
 describe("_ensureCatalog", () => {
-  it("ensureCatalog adds data.catalog", function() {
-    const model = ({
+  it("ensureCatalog adds data.catalog", function () {
+    const model = {
       item: {
         id: "3ef",
-        properties: {}
+        properties: {},
       },
       data: {
         values: {
-          groups: ["4bc", { id: "fromObj" }, "54b", { id: "secondObj" }]
-        }
-      }
-    } as unknown) as IModel;
+          groups: ["4bc", { id: "fromObj" }, "54b", { id: "secondObj" }],
+        },
+      },
+    } as unknown as IModel;
     const chk = _ensureCatalog(model);
     expect(chk.data.catalog).toBeTruthy("catalog should exist");
     expect(Array.isArray(chk.data.catalog.groups)).toBeTruthy(
@@ -26,18 +26,18 @@ describe("_ensureCatalog", () => {
     );
   });
 
-  it("doesnt blow up with non-existant catalog", function() {
-    const model = ({
+  it("doesnt blow up with non-existant catalog", function () {
+    const model = {
       item: {
         id: "3ef",
         properties: {
-          schemaVersion: 1
-        }
+          schemaVersion: 1,
+        },
       },
       data: {
         // no catalog
-      }
-    } as unknown) as IModel;
+      },
+    } as unknown as IModel;
     try {
       const chk = _ensureCatalog(model);
       expect(chk).toBeDefined();
@@ -46,20 +46,20 @@ describe("_ensureCatalog", () => {
     }
   });
 
-  it("skips templates greater than 1.2 schema version", function() {
-    const model = ({
+  it("skips templates greater than 1.2 schema version", function () {
+    const model = {
       item: {
         id: "3ef",
         properties: {
-          schemaVersion: 2
-        }
+          schemaVersion: 2,
+        },
       },
       data: {
         values: {
-          groups: ["4bc", { id: "fromObj" }, "54b", { id: "secondObj" }]
-        }
-      }
-    } as unknown) as IModel;
+          groups: ["4bc", { id: "fromObj" }, "54b", { id: "secondObj" }],
+        },
+      },
+    } as unknown as IModel;
     const chk = _ensureCatalog(model);
     expect(chk).toEqual(model);
   });