Add options for share json support

.gitignore

@@ -10,3 +10,5 @@ compiled
 .awcache
 .rpt2_cache
 docs
+
+bin

package.json

@@ -1,6 +1,6 @@
 {
   "name": "catalog-converter",
-  "version": "0.0.2",
+  "version": "0.0.2-alpha.2",
   "description": "",
   "keywords": [],
   "main": "dist/catalog-converter.umd.js",
@@ -32,7 +32,8 @@
     "commit": "git-cz",
     "semantic-release": "semantic-release",
     "semantic-release-prepare": "ts-node tools/semantic-release-prepare",
-    "travis-deploy-once": "travis-deploy-once"
+    "travis-deploy-once": "travis-deploy-once",
+    "prepare": "npm run prebuild && npm run build"
   },
   "config": {
     "commitizen": {
@@ -101,9 +102,8 @@
     "replace-in-file": "^3.4.2",
     "rimraf": "^2.6.2",
     "rollup": "^2.7.3",
-    "rollup-plugin-dts": "^1.4.10",
+    "rollup-plugin-dts": "1.4.10",
     "rollup-plugin-sourcemaps": "^0.5.0",
-    "rollup-plugin-typescript-2": "0.8.1",
     "semantic-release": "^15.9.16",
     "shelljs": "^0.8.3",
     "travis-deploy-once": "^5.0.9",

src/Message.ts

@@ -7,6 +7,7 @@ export enum Severity {
 }
 
 export enum ModelType {
+  Share = "Share",
   Member = "CatalogMember",
   Group = "CatalogGroup",
   WmsItem = "WebMapServiceCatalogItem",

src/convert.ts

@@ -7,6 +7,7 @@
 // Unfortunately types in `is` require @types/node to be pinned to v12
 // See https://github.com/sindresorhus/is/issues/108
 import is from "@sindresorhus/is";
+import { merge } from "lodash";
 import { csvCatalogItem } from "./converters/CsvItem";
 import {
   convertMembersArrayWithConvertMember,
@@ -21,8 +22,8 @@ import {
   geoJsonCatalogItem,
   groupFromConvertMembersArray,
   sosCatalogItem,
-  wmsCatalogItem,
 } from "./converters/other";
+import { wmsCatalogItem } from "./converters/WmsCatalogItem";
 import {
   inputNotPlainObject,
   Message,
@@ -53,6 +54,7 @@ function defaultOptions(options: ConversionOptions | undefined) {
   return Object.assign(
     {
       copyUnknownProperties: false,
+      partial: false,
     },
     options || {}
   );
@@ -63,7 +65,7 @@ export function convertMember(
   options?: ConversionOptions
 ): MemberResult {
   options = defaultOptions(options);
-  if (isCatalogMember(member)) {
+  if (isCatalogMember(member, options.partial)) {
     const converterForType = converters.get(member.type);
     if (!converterForType) {
       return {
@@ -134,3 +136,212 @@ export function convertCatalog(
   }
   return result;
 }
+
+export type Share = { version: string; initSources: any[] };
+export type ShareResult = {
+  result: Share | null;
+  messages?: Message[];
+  converted?: boolean;
+};
+export type Story = {
+  title: string;
+  text: string;
+  id: string;
+  shareData: Share;
+};
+export function convertShare(json: unknown): ShareResult {
+  if (!is.plainObject(json)) {
+    return {
+      result: null,
+      messages: [inputNotPlainObject()],
+    };
+  }
+
+  // If version 8 return
+  if (
+    "version" in json &&
+    typeof json.version === "string" &&
+    json.version.startsWith("8")
+  ) {
+    return { result: json as Share, converted: false };
+  }
+
+  if (!Array.isArray(json.initSources)) {
+    return {
+      result: null,
+      messages: [
+        missingRequiredProp(
+          ModelType.Share,
+          "initSources",
+          undefined,
+          "Init sources"
+        ),
+      ],
+    };
+  }
+
+  const messages: Message[] = [];
+
+  const initializationUrls: string[] = [];
+
+  // Crunch v7 initSources together + extract initializationUrls
+  const v7InitSource = json.initSources.reduce<any>((sources, current) => {
+    if (typeof current === "string") {
+      initializationUrls.push(current);
+      return sources;
+    }
+
+    return merge(sources, current);
+  }, {});
+
+  const v8InitSource: any = { stratum: "user" };
+
+  const workbenchIds: string[] = [];
+
+  const convertMembers = (members: any, convertUserAdded = false) =>
+    Object.entries(members).reduce<any>((convertedMembers, [id, v7Member]) => {
+      if (is.plainObject(v7Member)) {
+        // Get `knownContainerUniqueIds` from v7 `parents` property
+        let knownContainerUniqueIds = ["/"];
+        if (Array.isArray(v7Member.parents) && v7Member.parents.length > 0) {
+          knownContainerUniqueIds = v7Member.parents
+            .map((parent: string) => {
+              // Convert v7 user added data group id
+              if (parent === "Root Group/User-Added Data") {
+                return "__User-Added_Data__";
+              }
+              // Convert v7 root group id
+              if (parent === "Root Group") {
+                return "/";
+              }
+
+              // Replace v7 Root Group with slash (v8 auto-ids start with //$catalogName)
+              return parent.replace("Root Group", "/");
+            })
+            .filter((parent) => typeof parent !== "undefined") as string[];
+        }
+
+        // Firstly, if model has explicit `id`
+        // Otherwise, try to guess id based on this:
+        // v7 Id has format /Root Group/$someContainerId/$someLowerContainerId/$catalogName
+        // v8 Id has format //$someContainerId/$someLowerContainerId/$catalogName
+        // So replace "Root Group" with "/"
+        let newId =
+          typeof v7Member.id === "string" && v7Member.id !== ""
+            ? v7Member.id
+            : id.replace("Root Group", "/");
+
+        // Replace User Added Data group id
+        if (id === "Root Group/User-Added Data") {
+          newId = "__User-Added_Data__";
+        }
+
+        // For some reason user added data doesn't have the __User-Added_Data__ group in ids (in v8)
+        newId = newId.replace("//User-Added Data", "");
+
+        // Only add to workbenchIds if NOT converting User Added Data
+        if (v7Member.isEnabled && !convertUserAdded) {
+          workbenchIds.push(newId);
+        }
+
+        // Only convert user added data if convertUserAdded
+        if (
+          convertUserAdded ||
+          (id !== "Root Group/User-Added Data" &&
+            !knownContainerUniqueIds.includes("__User-Added_Data__"))
+        ) {
+          const result = convertMember(v7Member, { partial: true });
+          messages.push(...result.messages);
+          convertedMembers[newId] = {
+            ...result.member,
+            knownContainerUniqueIds,
+          };
+        }
+        return convertedMembers;
+      }
+    }, {});
+
+  // Shared catalog members
+  if ("sharedCatalogMembers" in v7InitSource) {
+    v8InitSource.models = convertMembers(v7InitSource.sharedCatalogMembers);
+  } else {
+    v8InitSource.models = {};
+  }
+
+  // User added data
+  if ("catalog" in v7InitSource && Array.isArray(v7InitSource.catalog)) {
+    // Only add "Root Group/User-Added Data" Catalog Group
+    const userAddedData = v7InitSource.catalog.find(
+      (item: any) => item.id === "Root Group/User-Added Data"
+    );
+
+    if (
+      typeof userAddedData !== "undefined" &&
+      Array.isArray(userAddedData.items) &&
+      userAddedData.items.length > 0
+    ) {
+      // Delete all ids
+      delete userAddedData.id;
+      const deleteIds = (items: any[]) =>
+        items.forEach((item) => {
+          if (typeof item.id === "string") delete item.id;
+          if (Array.isArray(item.items)) deleteIds(item.items);
+        });
+
+      deleteIds(userAddedData.items);
+
+      const userAddedDataV8 = convertMembers(
+        {
+          "Root Group/User-Added Data": userAddedData,
+        },
+        true
+      );
+
+      // Add IDs to user added models - so they show up in the workbenck (from sharedCatalogMembers)
+      userAddedDataV8?.["__User-Added_Data__"]?.members.forEach(
+        (member: any) =>
+          member !== null && (member.id = member.id ?? `/${member.name}`)
+      );
+      v8InitSource.models = { ...userAddedDataV8, ...v8InitSource.models };
+    }
+  }
+
+  if ("stories" in v7InitSource && Array.isArray(v7InitSource.stories)) {
+    v8InitSource.stories = v7InitSource.stories.map((story: Story) => {
+      const result = convertShare(story.shareData);
+      // Add story details to message paths
+      messages.push(
+        ...(result.messages?.map((message) => {
+          return { ...message, path: ["Story", story.title, ...message.path] };
+        }) || [])
+      );
+      return { ...story, shareData: result.result };
+    });
+  }
+
+  v8InitSource.workbench = workbenchIds.reverse();
+
+  // Copy over common properties
+  [
+    "initialCamera",
+    "homeCamera",
+    "baseMapName",
+    "viewerMode",
+    "currentTime",
+    "showSplitter",
+    "splitPosition",
+    "previewedItemId",
+    // Not currently used:
+    //"timeline" - v7 timeline is different from v8
+    //"locationMarker" - not in v8
+    //"sharedFromExplorerPanel" - not in v8
+    //"pickedFeatures" - not in v8 share links
+  ].forEach((prop) => (v8InitSource[prop] = v7InitSource[prop]));
+
+  const v8json: { version: string; initSources: any[] } = {
+    version: "8.0.0",
+    initSources: [...initializationUrls, v8InitSource],
+  };
+
+  return { result: v8json, messages, converted: true };
+}

src/converters/CsvItem.ts

@@ -12,6 +12,7 @@ import {
   getUnknownProps,
   nullResult,
   propsToWarnings,
+  catalogMemberPropsIgnore,
 } from "./helpers";
 
 function tableStyle(tableStyle: PlainObject) {
@@ -39,7 +40,7 @@ export function csvCatalogItem(
   item: CatalogMember,
   options: ConversionOptions
 ): MemberResult {
-  if (!is.string(item.url) && !is.string(item.data)) {
+  if (!options.partial && !is.string(item.url) && !is.string(item.data)) {
     return nullResult(
       missingRequiredProp(
         ModelType.CsvItem,
@@ -50,9 +51,8 @@ export function csvCatalogItem(
     );
   }
   const unknownProps = getUnknownProps(item, [
-    "name",
-    "type",
     ...catalogMemberProps,
+    ...catalogMemberPropsIgnore,
     "url",
     "data",
     "opacity",