refactor(hub-sites): remove _shareItemsToSiteGroups()

affects: @esri/hub-sites BREAKING CHANGE: remove _shareItemsToSiteGroups()
Esri · Jul 27, 2022 · b806773 · b806773
1 parent 1132c43
commit b806773
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 29 deletions.
diff --git a/packages/sites/src/index.ts b/packages/sites/src/index.ts
@@ -36,7 +36,7 @@ export * from "./create-site-model-from-template";
 export * from "./convert-site-to-template";
 export * from "./_get-site-data-by-id";
 export * from "./_get-second-pass-sharing-options";
-export * from "./_share-items-to-site-groups";
+export * from "./share-items-to-site-groups";
 export * from "./_second-pass-adlib-pages";
 export * from "./_update-pages";
 export * from "./site-second-pass";

diff --git a/.../sites/src/_share-items-to-site-groups.ts → ...s/sites/src/share-items-to-site-groups.ts b/.../sites/src/_share-items-to-site-groups.ts → ...s/sites/src/share-items-to-site-groups.ts
@@ -3,26 +3,6 @@ import { shareItemWithGroup, ISharingResponse } from "@esri/arcgis-rest-portal";
 import { _getSecondPassSharingOptions } from "./_get-second-pass-sharing-options";
 import { _getSharingEligibleModels } from "./_get-sharing-eligible-models";
 
-/**
- * Share all the other models to the Site's content and collaboration groups, if
- * those groups were created for the site (depends on user's privs)
- * **DEPRECATED: Use shareItemsToSiteGroups() instead**
- * @param {object} siteModel Site Model
- * @param {Array} solutionModels Array of all models created by the Solution
- * @param {IHubRequestOptions} hubRequestOptions
- * @private
- */
-export function _shareItemsToSiteGroups(
-  siteModel: IModel,
-  solutionModels: IModel[],
-  hubRequestOptions: IHubRequestOptions
-) {
-  /* tslint:disable no-console */
-  console.info(
-    `DEPRECATED: _shareItemsToSiteGroups will be removed at v10.0.0. Use shareItemsToSiteGroups instead.`
-  );
-  return shareItemsToSiteGroups(siteModel, solutionModels, hubRequestOptions);
-}
 /**
  * Share all the other models to the Site's content and collaboration groups, if
  * those groups were created for the site (depends on user's privs)

diff --git a/packages/sites/src/site-second-pass.ts b/packages/sites/src/site-second-pass.ts
@@ -1,5 +1,5 @@
 import { IModelTemplate, IHubRequestOptions, IModel } from "@esri/hub-common";
-import { _shareItemsToSiteGroups } from "./_share-items-to-site-groups";
+import { shareItemsToSiteGroups } from "./share-items-to-site-groups";
 import { _updatePages } from "./_update-pages";
 
 /**
@@ -16,9 +16,9 @@ export function siteSecondPass(
   let secondPassPromises: Array<Promise<any>> = [];
   // get all the items that are not the site
   secondPassPromises = secondPassPromises.concat(
-    _shareItemsToSiteGroups(
+    shareItemsToSiteGroups(
       siteModel,
-      (solutionModels as unknown) as IModel[],
+      solutionModels as unknown as IModel[],
       hubRequestOptions
     )
   );

diff --git a/packages/sites/test/_share-items-to-site-groups.test.ts b/packages/sites/test/_share-items-to-site-groups.test.ts
@@ -1,9 +1,9 @@
-import { _shareItemsToSiteGroups } from "../src";
+import { shareItemsToSiteGroups } from "../src";
 import * as portalModule from "@esri/arcgis-rest-portal";
 import { IModel, IHubRequestOptions } from "@esri/hub-common";
 import * as sharingEligibleModelsModule from "../src/_get-sharing-eligible-models";
 
-describe("_shareItemsToSiteGroups", () => {
+describe("shareItemsToSiteGroups", () => {
   it("shares items to groups using shareItemsToSiteGroups", async () => {
     const shareSpy = spyOn(portalModule, "shareItemWithGroup").and.returnValue(
       Promise.resolve({})
@@ -34,7 +34,7 @@ describe("_shareItemsToSiteGroups", () => {
       "_getSharingEligibleModels"
     ).and.returnValue(Promise.resolve(toShare.slice(1, 3)));
 
-    await _shareItemsToSiteGroups(siteModel, toShare, hubRequestOptions);
+    await shareItemsToSiteGroups(siteModel, toShare, hubRequestOptions);
 
     expect(_getSharingEligibleModelsSpy.calls.count()).toBe(
       1,

diff --git a/packages/sites/test/site-second-pass.test.ts b/packages/sites/test/site-second-pass.test.ts
@@ -1,5 +1,5 @@
 import { siteSecondPass } from "../src";
-import * as shareItemsModule from "../src/_share-items-to-site-groups";
+import * as shareItemsModule from "../src/share-items-to-site-groups";
 import * as updatePagesModule from "../src/_update-pages";
 import { IModel, IHubRequestOptions, IModelTemplate } from "@esri/hub-common";
 import { expectAllCalled } from "./test-helpers.test";
@@ -8,7 +8,7 @@ describe("siteSecondPass", () => {
   it("calls the correct functions", async () => {
     const shareSpy = spyOn(
       shareItemsModule,
-      "_shareItemsToSiteGroups"
+      "shareItemsToSiteGroups"
     ).and.returnValue(Promise.resolve({}));
     const updateSpy = spyOn(updatePagesModule, "_updatePages").and.returnValue(
       Promise.resolve({})