@riboseinc/paneron-registry-kit 2.0.0-dev9 → 2.0.1

package/dist/views/change-request/objectChangeset.d.ts

@@ -0,0 +1,31 @@
+import type { ObjectChangeset } from '@riboseinc/paneron-extension-kit/types/objects';
+import type { RegisterItem, ChangeRequest, ChangeProposal } from '../../types';
+import type { Version as RegisterVersion } from '../../types/register';
+import { type Drafted, type ReturnedForClarificationByManager, type ReturnedForClarificationByControlBody } from '../../types/cr';
+/** Takes a justification and ID, returns an object changeset. */
+export declare function newCRObjectChangeset(id: string, justification: string, registerVersion: RegisterVersion, stakeholderGitServerUsername: string): ObjectChangeset;
+/**
+ * Returns an object changeset to update CR with new given proposal items.
+ * Only applicable to CR at draft edit stage.
+ */
+export declare function updateCRObjectChangeset(
+/**
+ * Change request data.
+ */
+cr: Drafted | ReturnedForClarificationByManager | ReturnedForClarificationByControlBody, 
+/**
+ * Proposals by item path.
+ * Will be merged with those already existing in `cr`.
+ * If a proposal is undefined, it will be removed.
+ */
+proposalItems: Record<string, ChangeProposal | null>, 
+/**
+ * New item data must be provided for additions and clarifications,
+ * keyed by item path.
+ */
+itemData?: Record<string, RegisterItem<any>>): ObjectChangeset;
+/**
+ * Given change proposals, returns applicable changes
+ * to objects in the dataset.
+ */
+export declare function proposalsToObjectChangeset(crID: string, hasSubregisters: boolean, proposals: ChangeRequest["proposals"], itemData: Record<string, RegisterItem<any> | null>, newItemData: Record<string, RegisterItem<any> | null>): Promise<ObjectChangeset>;

package/dist/views/change-request/objectChangeset.js

@@ -0,0 +1,229 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.newCRObjectChangeset = newCRObjectChangeset;
+exports.updateCRObjectChangeset = updateCRObjectChangeset;
+exports.proposalsToObjectChangeset = proposalsToObjectChangeset;
+
+var _types = require("../../types");
+
+var _cr = require("../../types/cr");
+
+var _itemPathUtils = require("../itemPathUtils");
+
+/** Takes a justification and ID, returns an object changeset. */
+function newCRObjectChangeset(id, justification, registerVersion, stakeholderGitServerUsername) {
+  const timeStarted = new Date();
+  const cr = {
+    id,
+    timeStarted,
+    timeEdited: timeStarted,
+    justification,
+    submittingStakeholderGitServerUsername: stakeholderGitServerUsername,
+    items: {},
+    state: _cr.State.DRAFT,
+    registerVersion: registerVersion.id
+  };
+  const crObjectPath = (0, _itemPathUtils.crIDToCRPath)(id);
+  return {
+    [crObjectPath]: {
+      oldValue: null,
+      newValue: cr
+    }
+  };
+}
+/**
+ * Returns an object changeset to update CR with new given proposal items.
+ * Only applicable to CR at draft edit stage.
+ */
+
+
+function updateCRObjectChangeset(
+/**
+ * Change request data.
+ */
+cr,
+/**
+ * Proposals by item path.
+ * Will be merged with those already existing in `cr`.
+ * If a proposal is undefined, it will be removed.
+ */
+proposalItems,
+/**
+ * New item data must be provided for additions and clarifications,
+ * keyed by item path.
+ */
+itemData = {}) {
+  const changeset = {};
+  const newItems = { ...cr.items
+  };
+
+  for (const [itemPath, proposal] of Object.entries(proposalItems)) {
+    // Update proposals on CR
+    if (proposal !== null) {
+      newItems[itemPath] = proposal;
+    } else if (newItems[itemPath]) {
+      delete newItems[itemPath];
+    } // Add/remove item data
+
+
+    if ((proposal === null || proposal === void 0 ? void 0 : proposal.type) === 'addition' || (proposal === null || proposal === void 0 ? void 0 : proposal.type) === 'clarification') {
+      const proposedItemData = itemData[itemPath];
+
+      if (proposedItemData === null || !(0, _types.isRegisterItem)(proposedItemData)) {
+        console.error("Unable to convert proposals to object changeset: original item data is missing", itemPath);
+        throw new Error("Unable to convert proposals to object changeset: original item data is missing");
+      }
+
+      changeset[(0, _itemPathUtils.itemPathInCR)(itemPath, cr.id)] = {
+        // When editing a draft, we don’t care
+        // about overwriting proposed item data so we omit oldValue.
+        newValue: proposedItemData
+      };
+    } else {
+      changeset[(0, _itemPathUtils.itemPathInCR)(itemPath, cr.id)] = {
+        // When editing a draft, we don’t care
+        // about overwriting proposed item data so we omit oldValue.
+        newValue: null
+      };
+    }
+  } // Update main CR data
+
+
+  const crPath = (0, _itemPathUtils.crIDToCRPath)(cr.id);
+  changeset[crPath] = {
+    oldValue: cr,
+    newValue: { ...cr,
+      items: newItems,
+      timeEdited: new Date()
+    }
+  };
+  return changeset;
+}
+/**
+ * Given change proposals, returns applicable changes
+ * to objects in the dataset.
+ */
+
+
+async function proposalsToObjectChangeset(crID, hasSubregisters, proposals, itemData, newItemData) {
+  const cs = {};
+
+  for (const [itemPath, proposal] of Object.entries(proposals)) {
+    //const originalItem: RegisterItem<any> | undefined = (itemData[itemPath] ?? undefined);
+    const itemRef = (0, _itemPathUtils.itemPathToItemRef)(hasSubregisters, itemPath);
+
+    if (proposal.type !== 'addition') {
+      if (itemData[itemPath] === undefined) {
+        console.error("Unable to convert proposals to object changeset: original item data is missing", itemPath);
+        throw new Error("Unable to convert proposals to object changeset: original item data is missing");
+      }
+
+      if (proposal.type === 'amendment' && proposal.amendmentType === 'supersession') {
+        Object.assign(cs, await proposalToObjectChangeset(crID, proposal, itemRef, itemPath, itemData, newItemData));
+      } else {
+        Object.assign(cs, await proposalToObjectChangeset(crID, proposal, itemRef, itemPath, itemData, newItemData));
+      }
+    } else {
+      Object.assign(cs, await proposalToObjectChangeset(crID, proposal, itemRef, itemPath, itemData, newItemData));
+    }
+  }
+
+  return cs;
+} // TODO: Refactor out the business logic of proposal approval.
+
+/**
+ * Given a change proposal, returns applicable changes
+ * to objects in the dataset.
+ * Core logic of approving a proposal.
+ * Takes a proposal and extra options (depending on proposal type).
+ * Returns a Changeset containing register items at appropriate paths.
+ */
+
+
+async function proposalToObjectChangeset(crID, proposal, itemRef, itemPath, itemData, newItemData) {
+  let updatedItem;
+  const changeset = {};
+  const origItem = itemData[itemPath] ?? null;
+  const newItem = newItemData[(0, _itemPathUtils.itemPathInCR)(itemPath, crID)] ?? null;
+
+  if (proposal.type !== 'addition') {
+    if (origItem === null) {
+      throw new Error("proposalToObjectChangeset() requires original item data for non-additions");
+    }
+
+    updatedItem = { ...origItem
+    };
+
+    switch (proposal.type) {
+      case 'clarification':
+        if (newItem === null) {
+          throw new Error("proposalToObjectChangeset() requires new item data for clarifications");
+        } //const clarification = proposal as Clarification;
+
+
+        updatedItem.data = newItem.data; //clarification.payload;
+
+        break;
+
+      case 'amendment':
+        const amendment = proposal;
+        updatedItem.amendedInCR = crID;
+
+        switch (amendment.amendmentType) {
+          case 'retirement':
+            updatedItem.status = 'retired';
+            break;
+
+          case 'invalidation':
+            updatedItem.status = 'invalid';
+            break;
+
+          case 'supersession':
+            const supersession = proposal;
+            updatedItem.status = 'superseded';
+            updatedItem.supersededBy = supersession.supersedingItemIDs.map(itemID => ({
+              itemID,
+              classID: itemRef.classID,
+              subregisterID: itemRef.subregisterID
+            }));
+
+            for (const supersedingItemPath of updatedItem.supersededBy.map(ip => (0, _itemPathUtils.itemRefToItemPath)(ip))) {
+              const supersedingItemData = itemData[supersedingItemPath];
+
+              if (supersedingItemData) {
+                changeset[supersedingItemPath] = {
+                  oldValue: supersedingItemData,
+                  newValue: { ...supersedingItemData,
+                    supersedes: [...(supersedingItemData.supersedes ?? []), itemRef]
+                  }
+                };
+              }
+            }
+
+            break;
+        }
+
+        break;
+    }
+  } else {
+    if (newItem === null) {
+      throw new Error("proposalToObjectChangeset() requires new item data for additions");
+    }
+
+    updatedItem = {
+      id: itemRef.itemID,
+      data: newItem.data,
+      status: 'valid',
+      dateAccepted: new Date()
+    };
+  }
+
+  changeset[itemPath] = {
+    oldValue: origItem,
+    newValue: updatedItem
+  };
+  return changeset;
+}

package/dist/views/change-request/objectChangeset.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"objectChangeset.js","sourceRoot":"","sources":["../../../src/views/change-request/objectChangeset.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE7C,OAAO,EACL,KAAK,GAIN,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAGpG,iEAAiE;AACjE,MAAM,UAAU,oBAAoB,CAClC,EAAU,EACV,aAAqB,EACrB,eAAgC,EAChC,4BAAoC;IAGpC,MAAM,WAAW,GAAG,IAAI,IAAI,EAAE,CAAC;IAC/B,MAAM,EAAE,GAAY;QAClB,EAAE;QACF,WAAW;QACX,UAAU,EAAE,WAAW;QACvB,aAAa;QACb,sCAAsC,EAAE,4BAA4B;QACpE,KAAK,EAAE,EAAE;QACT,KAAK,EAAE,KAAK,CAAC,KAAK;QAClB,eAAe,EAAE,eAAgB,CAAC,EAAE;KACrC,CAAC;IACF,MAAM,YAAY,GAAG,YAAY,CAAC,EAAE,CAAC,CAAC;IACtC,OAAO;QACL,CAAC,YAAY,CAAC,EAAE;YACd,QAAQ,EAAE,IAAI;YACd,QAAQ,EAAE,EAAE;SACb;KACF,CAAA;AACH,CAAC;AAGD;;;GAGG;AACH,MAAM,UAAU,uBAAuB;AACrC;;GAEG;AACH,EAAuF;AAEvF;;;;GAIG;AACH,aAAoD;AAEpD;;;GAGG;AACH,WAA8C,EAAE;IAEhD,MAAM,SAAS,GAAoB,EAAE,CAAC;IACtC,MAAM,QAAQ,GAAG,EAAE,GAAG,EAAE,CAAC,KAAK,EAAE,CAAC;IACjC,KAAK,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE;QAChE,yBAAyB;QACzB,IAAI,QAAQ,KAAK,IAAI,EAAE;YACrB,QAAQ,CAAC,QAAQ,CAAC,GAAG,QAAQ,CAAC;SAC/B;aAAM,IAAI,QAAQ,CAAC,QAAQ,CAAC,EAAE;YAC7B,OAAO,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC3B;QACD,uBAAuB;QACvB,IAAI,QAAQ,EAAE,IAAI,KAAK,UAAU,IAAI,QAAQ,EAAE,IAAI,KAAK,eAAe,EAAE;YACvE,MAAM,gBAAgB,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC;YAC5C,IAAI,gBAAgB,KAAK,IAAI,IAAI,CAAC,cAAc,CAAC,gBAAgB,CAAC,EAAE;gBAClE,OAAO,CAAC,KAAK,CAAC,gFAAgF,EAAE,QAAQ,CAAC,CAAC;gBAC1G,MAAM,IAAI,KAAK,CAAC,gFAAgF,CAAC,CAAC;aACnG;YACD,SAAS,CAAC,YAAY,CAAC,QAAQ,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG;gBACzC,sCAAsC;gBACtC,4DAA4D;gBAC5D,QAAQ,EAAE,gBAAgB;aAC3B,CAAC;SACH;aAAM;YACL,SAAS,CAAC,YAAY,CAAC,QAAQ,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG;gBACzC,sCAAsC;gBACtC,4DAA4D;gBAC5D,QAAQ,EAAE,IAAI;aACf,CAAC;SACH;KACF;IACD,sBAAsB;IACtB,MAAM,MAAM,GAAG,YAAY,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IACnC,SAAS,CAAC,MAAM,CAAC,GAAG;QAClB,QAAQ,EAAE,EAAE;QACZ,QAAQ,EAAE,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,IAAI,IAAI,EAAE,EAAE;KAC7D,CAAC;IACF,OAAO,SAAS,CAAC;AACnB,CAAC;AAGD;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,0BAA0B,CAC9C,IAAY,EACZ,eAAwB,EACxB,SAAqC,EACrC,QAAkD,EAClD,WAAqD;IAErD,MAAM,EAAE,GAAoB,EAAE,CAAC;IAE/B,KAAK,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;QAC5D,wFAAwF;QACxF,MAAM,OAAO,GAAG,iBAAiB,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC;QAE7D,IAAI,QAAQ,CAAC,IAAI,KAAK,UAAU,EAAE;YAChC,IAAI,QAAQ,CAAC,QAAQ,CAAC,KAAK,SAAS,EAAE;gBACpC,OAAO,CAAC,KAAK,CAAC,gFAAgF,EAAE,QAAQ,CAAC,CAAC;gBAC1G,MAAM,IAAI,KAAK,CAAC,gFAAgF,CAAC,CAAC;aACnG;YACD,IAAI,QAAQ,CAAC,IAAI,KAAK,WAAW,IAAI,QAAQ,CAAC,aAAa,KAAK,cAAc,EAAE;gBAC9E,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,yBAAyB,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC;aAC9G;iBAAM;gBACL,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,yBAAyB,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC;aAC9G;SACF;aAAM;YACL,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,yBAAyB,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC;SAC9G;KACF;IAED,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,8DAA8D;AAC9D;;;;;;GAMG;AACH,KAAK,UAAU,yBAAyB,CACtC,IAAY,EACZ,QAAwB,EACxB,OAA8B,EAC9B,QAAgB,EAChB,QAAkD,EAClD,WAAqD;IAErD,IAAI,WAA8B,CAAC;IACnC,MAAM,SAAS,GAAyC,EAAE,CAAC;IAE3D,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC;IAC5C,MAAM,OAAO,GAAG,WAAW,CAAC,YAAY,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC;IAElE,IAAI,QAAQ,CAAC,IAAI,KAAK,UAAU,EAAE;QAChC,IAAI,QAAQ,KAAK,IAAI,EAAE;YACrB,MAAM,IAAI,KAAK,CAAC,2EAA2E,CAAC,CAAC;SAC9F;QAED,WAAW,GAAG,EAAE,GAAG,QAAQ,EAAE,CAAC;QAE9B,QAAQ,QAAQ,CAAC,IAAI,EAAE;YACrB,KAAK,eAAe;gBAClB,IAAI,OAAO,KAAK,IAAI,EAAE;oBACpB,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAC;iBAC1F;gBACD,kDAAkD;gBAClD,WAAW,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAA,CAAC,wBAAwB;gBACxD,MAAM;YACR,KAAK,WAAW;gBACd,MAAM,SAAS,GAAG,QAAqB,CAAC;gBACxC,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;gBAE/B,QAAQ,SAAS,CAAC,aAAa,EAAE;oBAC/B,KAAK,YAAY;wBACf,WAAW,CAAC,MAAM,GAAG,SAAS,CAAC;wBAC/B,MAAM;oBACR,KAAK,cAAc;wBACjB,WAAW,CAAC,MAAM,GAAG,SAAS,CAAC;wBAC/B,MAAM;oBACR,KAAK,cAAc;wBACjB,MAAM,YAAY,GAAG,QAAwB,CAAC;wBAC9C,WAAW,CAAC,MAAM,GAAG,YAAY,CAAC;wBAClC,WAAW,CAAC,YAAY,GAAG,YAAY,CAAC,kBAAkB,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;4BACxE,MAAM;4BACN,OAAO,EAAE,OAAO,CAAC,OAAO;4BACxB,aAAa,EAAE,OAAO,CAAC,aAAa;yBACrC,CAAC,CAAC,CAAC;wBACJ,KAAK,MAAM,mBAAmB,IAAI,WAAW,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,EAAE;4BAC3F,MAAM,mBAAmB,GAAG,QAAQ,CAAC,mBAAmB,CAAC,CAAC;4BAC1D,IAAI,mBAAmB,EAAE;gCACvB,SAAS,CAAC,mBAAmB,CAAC,GAAG;oCAC/B,QAAQ,EAAE,mBAAmB;oCAC7B,QAAQ,EAAE;wCACR,GAAG,mBAAmB;wCACtB,UAAU,EAAE,CAAE,GAAG,CAAC,mBAAmB,CAAC,UAAU,IAAI,EAAE,CAAC,EAAE,OAAO,CAAE;qCACnE;iCACF,CAAC;6BACH;yBACF;wBACD,MAAM;iBACT;gBACD,MAAM;SACT;KACF;SAAM;QACL,IAAI,OAAO,KAAK,IAAI,EAAE;YACpB,MAAM,IAAI,KAAK,CAAC,kEAAkE,CAAC,CAAC;SACrF;QACD,WAAW,GAAG;YACZ,EAAE,EAAE,OAAO,CAAC,MAAM;YAClB,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,MAAM,EAAE,OAAO;YACf,YAAY,EAAE,IAAI,IAAI,EAAE;SACzB,CAAC;KACH;IAED,SAAS,CAAC,QAAQ,CAAC,GAAG;QACpB,QAAQ,EAAE,QAAQ;QAClB,QAAQ,EAAE,WAAW;KACtB,CAAC;IAEF,OAAO,SAAS,CAAC;AACnB,CAAC","sourcesContent":["import type { Change, Changeset } from '@riboseinc/paneron-extension-kit/types/changes';\nimport type { ObjectChangeset } from '@riboseinc/paneron-extension-kit/types/objects';\nimport type {\n  InternalItemReference,\n  RegisterItem,\n  ChangeRequest,\n  ChangeProposal,\n  Amendment,\n  Supersession,\n} from '../../types';\nimport { isRegisterItem } from '../../types';\nimport type { Version as RegisterVersion } from '../../types/register';\nimport {\n  State,\n  type Drafted,\n  type ReturnedForClarificationByManager,\n  type ReturnedForClarificationByControlBody,\n} from '../../types/cr';\nimport { crIDToCRPath, itemPathInCR, itemPathToItemRef, itemRefToItemPath } from '../itemPathUtils';\n\n\n/** Takes a justification and ID, returns an object changeset. */\nexport function newCRObjectChangeset(\n  id: string,\n  justification: string,\n  registerVersion: RegisterVersion,\n  stakeholderGitServerUsername: string,\n): ObjectChangeset {\n\n  const timeStarted = new Date();\n  const cr: Drafted = {\n    id,\n    timeStarted,\n    timeEdited: timeStarted,\n    justification,\n    submittingStakeholderGitServerUsername: stakeholderGitServerUsername,\n    items: {},\n    state: State.DRAFT,\n    registerVersion: registerVersion!.id,\n  };\n  const crObjectPath = crIDToCRPath(id);\n  return {\n    [crObjectPath]: {\n      oldValue: null,\n      newValue: cr,\n    },\n  }\n}\n\n\n/**\n * Returns an object changeset to update CR with new given proposal items.\n * Only applicable to CR at draft edit stage.\n */\nexport function updateCRObjectChangeset(\n  /**\n   * Change request data.\n   */\n  cr: Drafted | ReturnedForClarificationByManager | ReturnedForClarificationByControlBody,\n\n  /**\n   * Proposals by item path.\n   * Will be merged with those already existing in `cr`.\n   * If a proposal is undefined, it will be removed.\n   */\n  proposalItems: Record<string, ChangeProposal | null>,\n\n  /**\n   * New item data must be provided for additions and clarifications,\n   * keyed by item path.\n   */\n  itemData: Record<string, RegisterItem<any>> = {},\n): ObjectChangeset {\n  const changeset: ObjectChangeset = {};\n  const newItems = { ...cr.items };\n  for (const [itemPath, proposal] of Object.entries(proposalItems)) {\n    // Update proposals on CR\n    if (proposal !== null) {\n      newItems[itemPath] = proposal;\n    } else if (newItems[itemPath]) {\n      delete newItems[itemPath];\n    }\n    // Add/remove item data\n    if (proposal?.type === 'addition' || proposal?.type === 'clarification') {\n      const proposedItemData = itemData[itemPath];\n      if (proposedItemData === null || !isRegisterItem(proposedItemData)) {\n        console.error(\"Unable to convert proposals to object changeset: original item data is missing\", itemPath);\n        throw new Error(\"Unable to convert proposals to object changeset: original item data is missing\");\n      }\n      changeset[itemPathInCR(itemPath, cr.id)] = {\n        // When editing a draft, we don’t care\n        // about overwriting proposed item data so we omit oldValue.\n        newValue: proposedItemData,\n      };\n    } else {\n      changeset[itemPathInCR(itemPath, cr.id)] = {\n        // When editing a draft, we don’t care\n        // about overwriting proposed item data so we omit oldValue.\n        newValue: null,\n      };\n    }\n  }\n  // Update main CR data\n  const crPath = crIDToCRPath(cr.id);\n  changeset[crPath] = {\n    oldValue: cr,\n    newValue: { ...cr, items: newItems, timeEdited: new Date() },\n  };\n  return changeset;\n}\n\n\n/**\n * Given change proposals, returns applicable changes\n * to objects in the dataset.\n */\nexport async function proposalsToObjectChangeset(\n  crID: string,\n  hasSubregisters: boolean,\n  proposals: ChangeRequest[\"proposals\"],\n  itemData: Record<string, RegisterItem<any> | null>,\n  newItemData: Record<string, RegisterItem<any> | null>,\n): Promise<ObjectChangeset> {\n  const cs: ObjectChangeset = {};\n\n  for (const [itemPath, proposal] of Object.entries(proposals)) {\n    //const originalItem: RegisterItem<any> | undefined = (itemData[itemPath] ?? undefined);\n    const itemRef = itemPathToItemRef(hasSubregisters, itemPath);\n\n    if (proposal.type !== 'addition') {\n      if (itemData[itemPath] === undefined) {\n        console.error(\"Unable to convert proposals to object changeset: original item data is missing\", itemPath);\n        throw new Error(\"Unable to convert proposals to object changeset: original item data is missing\");\n      }\n      if (proposal.type === 'amendment' && proposal.amendmentType === 'supersession') {\n        Object.assign(cs, await proposalToObjectChangeset(crID, proposal, itemRef, itemPath, itemData, newItemData));\n      } else {\n        Object.assign(cs, await proposalToObjectChangeset(crID, proposal, itemRef, itemPath, itemData, newItemData));\n      }\n    } else {\n      Object.assign(cs, await proposalToObjectChangeset(crID, proposal, itemRef, itemPath, itemData, newItemData));\n    }\n  }\n\n  return cs;\n}\n\n// TODO: Refactor out the business logic of proposal approval.\n/**\n * Given a change proposal, returns applicable changes\n * to objects in the dataset.\n * Core logic of approving a proposal.\n * Takes a proposal and extra options (depending on proposal type).\n * Returns a Changeset containing register items at appropriate paths.\n */\nasync function proposalToObjectChangeset(\n  crID: string,\n  proposal: ChangeProposal,\n  itemRef: InternalItemReference,\n  itemPath: string,\n  itemData: Record<string, RegisterItem<any> | null>,\n  newItemData: Record<string, RegisterItem<any> | null>,\n): Promise<Changeset<Change<RegisterItem<any>>>> {\n  let updatedItem: RegisterItem<any>;\n  const changeset: Changeset<Change<RegisterItem<any>>> = {};\n\n  const origItem = itemData[itemPath] ?? null;\n  const newItem = newItemData[itemPathInCR(itemPath, crID)] ?? null;\n\n  if (proposal.type !== 'addition') {\n    if (origItem === null) {\n      throw new Error(\"proposalToObjectChangeset() requires original item data for non-additions\");\n    }\n\n    updatedItem = { ...origItem };\n\n    switch (proposal.type) {\n      case 'clarification':\n        if (newItem === null) {\n          throw new Error(\"proposalToObjectChangeset() requires new item data for clarifications\");\n        }\n        //const clarification = proposal as Clarification;\n        updatedItem.data = newItem.data //clarification.payload;\n        break;\n      case 'amendment':\n        const amendment = proposal as Amendment;\n        updatedItem.amendedInCR = crID;\n\n        switch (amendment.amendmentType) {\n          case 'retirement':\n            updatedItem.status = 'retired';\n            break;\n          case 'invalidation':\n            updatedItem.status = 'invalid';\n            break;\n          case 'supersession':\n            const supersession = proposal as Supersession;\n            updatedItem.status = 'superseded';\n            updatedItem.supersededBy = supersession.supersedingItemIDs.map(itemID => ({\n              itemID,\n              classID: itemRef.classID,\n              subregisterID: itemRef.subregisterID,\n            }));\n            for (const supersedingItemPath of updatedItem.supersededBy.map(ip => itemRefToItemPath(ip))) {\n              const supersedingItemData = itemData[supersedingItemPath];\n              if (supersedingItemData) {\n                changeset[supersedingItemPath] = {\n                  oldValue: supersedingItemData,\n                  newValue: {\n                    ...supersedingItemData,\n                    supersedes: [ ...(supersedingItemData.supersedes ?? []), itemRef ],\n                  },\n                };\n              }\n            }\n            break;\n        }\n        break;\n    }\n  } else {\n    if (newItem === null) {\n      throw new Error(\"proposalToObjectChangeset() requires new item data for additions\");\n    }\n    updatedItem = {\n      id: itemRef.itemID,\n      data: newItem.data,\n      status: 'valid',\n      dateAccepted: new Date(),\n    };\n  }\n\n  changeset[itemPath] = {\n    oldValue: origItem,\n    newValue: updatedItem,\n  };\n\n  return changeset;\n}\n"]}

package/dist/views/detail/ChangeRequest/Proposal.js

@@ -0,0 +1,142 @@
+"use strict"; // /** @jsx jsx */
+// /** @jsxFrag React.Fragment */
+// 
+// 
+// import React from 'react';
+// 
+// import { jsx, css } from '@emotion/react';
+// 
+// import {
+//   FormGroup,
+//   InputGroup,
+//   NonIdealState,
+//   HTMLSelect,
+//   H4,
+// } from '@blueprintjs/core';
+// 
+// import useItemClassConfig from '../../hooks/useItemClassConfig';
+// 
+// import type {
+//   ChangeProposal,
+//   Payload,
+//   InternalItemReference,
+// } from '../../../types';
+// 
+// import { PROPOSAL_TYPES } from '../../../types';
+// 
+// 
+// const ProposalDetails: React.FC<{
+//   itemRef: InternalItemReference
+//   proposal: ChangeProposal
+// 
+//   existingItemData?: Payload
+// 
+//   onAccept?: (itemID: string, clsID: string) => void
+//   onChange?: (val: ChangeProposal) => void
+//   onDelete?: () => void
+// }> = function ({
+//   itemRef,
+//   proposal,
+//   onChange,
+//   existingItemData,
+// }) {
+//   const { value: classConfig } = useItemClassConfig(itemRef.classID ?? 'NONEXISTENT_CLASS_ID');
+//   const itemClass = classConfig;
+// 
+//   let itemView: JSX.Element;
+//   let proposalProperties: JSX.Element | null;
+// 
+//   if (proposal.type === 'amendment') {
+//     proposalProperties = (
+//       <FormGroup inline label="Supersede with:">
+//         <InputGroup
+//           value={proposal.amendmentType === 'supersession' ? proposal.supersedingItemID : ''}
+//           disabled={!onChange}
+//           placeholder="Item ID"
+//           onChange={onChange
+//             ? (evt: React.FormEvent<HTMLInputElement>) => {
+//                 if (!onChange) { return; }
+//                 const itemID = evt.currentTarget.value;
+//                 if (itemID.trim() === '') {
+//                   const newVal = update(proposal, { $unset: ['supersedingItemID'] });
+//                   onChange({ ...newVal, amendmentType: 'retirement' });
+//                 } else {
+//                   onChange({ ...proposal, amendmentType: 'supersession', supersedingItemID: itemID });
+//                 }
+//               }
+//             : undefined}/>
+//       </FormGroup>
+//     );
+//   } else {
+//     proposalProperties = null;
+//   }
+// 
+//   const itemData: Payload | undefined = proposal.type === 'addition'
+//     ? proposal.payload
+//     : existingItemData;
+// 
+//   if (itemData === undefined || !itemClass) {
+//     itemView = <NonIdealState icon="heart-broken" title="Unable to display this item" />;
+//   } else if (onChange && proposal.type !== 'amendment') {
+//     const EditView = itemClass.views.editView;// as ItemEditView<any>;
+//     itemView = <EditView
+//       itemRef={itemRef}
+//       itemData={itemData}
+//       onChange={onChange
+//         ? (payload) => onChange ? onChange({ ...proposal, payload }) : void 0
+//         : undefined} />;
+//   } else {
+//     const DetailView = itemClass.views.detailView ?? itemClass!.views.editView;// as ItemDetailView<any>;
+//     itemView = <DetailView
+//       itemRef={itemRef}
+//       itemData={itemData} />;
+//   }
+// 
+//   const canChangeProposalType = proposal.type !== 'addition';
+// 
+//   function handleTypeChange(type: string) {
+//     const pt = type as typeof PROPOSAL_TYPES[number];
+// 
+//     if (PROPOSAL_TYPES.indexOf(pt) < 0) { return; }
+//     if (!onChange || !canChangeProposalType || pt === 'addition' || existingItemData === undefined) { return; }
+// 
+//     if (pt === 'amendment') {
+//       onChange(update(proposal, {
+//         type: { $set: pt },
+//         amendmentType: { $set: 'retirement' },
+//         $unset: ['payload'],
+//       }));
+//     } else {
+//       onChange(update(proposal, {
+//         type: { $set: pt },
+//         payload: existingItemData,
+//       }));
+//     }
+//   }
+// 
+//   return (
+//     <div css={css`flex: 1; display: flex; flex-flow: column nowrap;`}>
+//       <div css={css`flex-shrink: 0; display: flex; flex-flow: row nowrap; align-items: center; margin-bottom: 1rem;`}>
+//         <HTMLSelect
+//           options={PROPOSAL_TYPES.map(pt => ({ value: pt, label: pt }))}
+//           //iconProps={{ icon: PROPOSAL_ICON[proposal.type] }}
+//           value={proposal.type}
+//           disabled={!onChange || !canChangeProposalType || existingItemData === undefined}
+//           onChange={(onChange && canChangeProposalType && existingItemData !== undefined)
+//             ? (evt) => handleTypeChange(evt.currentTarget.value)
+//             : undefined} />
+//         &ensp;
+//         of a
+//         &ensp;
+//         <H4 css={css`margin: 0;`}>{classConfig?.meta.title ?? 'unknown class'}</H4>
+//         {proposalProperties}
+//       </div>
+// 
+//       <div css={css`flex: 1; overflow-y: auto;`}>
+//         {itemView}
+//       </div>
+//     </div>
+//   );
+// };
+// 
+// export default ProposalDetails;

package/dist/views/detail/ChangeRequest/Proposal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Proposal.js","sourceRoot":"","sources":["../../../../src/views/detail/ChangeRequest/Proposal.tsx"],"names":[],"mappings":";AAAA,kBAAkB;AAClB,iCAAiC;AACjC,GAAG;AACH,GAAG;AACH,6BAA6B;AAC7B,GAAG;AACH,6CAA6C;AAC7C,GAAG;AACH,WAAW;AACX,eAAe;AACf,gBAAgB;AAChB,mBAAmB;AACnB,gBAAgB;AAChB,QAAQ;AACR,8BAA8B;AAC9B,GAAG;AACH,mEAAmE;AACnE,GAAG;AACH,gBAAgB;AAChB,oBAAoB;AACpB,aAAa;AACb,2BAA2B;AAC3B,2BAA2B;AAC3B,GAAG;AACH,mDAAmD;AACnD,GAAG;AACH,GAAG;AACH,oCAAoC;AACpC,mCAAmC;AACnC,6BAA6B;AAC7B,GAAG;AACH,+BAA+B;AAC/B,GAAG;AACH,uDAAuD;AACvD,6CAA6C;AAC7C,0BAA0B;AAC1B,mBAAmB;AACnB,aAAa;AACb,cAAc;AACd,cAAc;AACd,sBAAsB;AACtB,OAAO;AACP,kGAAkG;AAClG,mCAAmC;AACnC,GAAG;AACH,+BAA+B;AAC/B,gDAAgD;AAChD,GAAG;AACH,yCAAyC;AACzC,6BAA6B;AAC7B,mDAAmD;AACnD,sBAAsB;AACtB,gGAAgG;AAChG,iCAAiC;AACjC,kCAAkC;AAClC,+BAA+B;AAC/B,8DAA8D;AAC9D,6CAA6C;AAC7C,0DAA0D;AAC1D,8CAA8C;AAC9C,wFAAwF;AACxF,0EAA0E;AAC1E,2BAA2B;AAC3B,yGAAyG;AACzG,oBAAoB;AACpB,kBAAkB;AAClB,6BAA6B;AAC7B,qBAAqB;AACrB,SAAS;AACT,aAAa;AACb,iCAAiC;AACjC,MAAM;AACN,GAAG;AACH,uEAAuE;AACvE,yBAAyB;AACzB,0BAA0B;AAC1B,GAAG;AACH,gDAAgD;AAChD,4FAA4F;AAC5F,4DAA4D;AAC5D,yEAAyE;AACzE,2BAA2B;AAC3B,0BAA0B;AAC1B,4BAA4B;AAC5B,2BAA2B;AAC3B,gFAAgF;AAChF,2BAA2B;AAC3B,aAAa;AACb,4GAA4G;AAC5G,6BAA6B;AAC7B,0BAA0B;AAC1B,gCAAgC;AAChC,MAAM;AACN,GAAG;AACH,gEAAgE;AAChE,GAAG;AACH,8CAA8C;AAC9C,wDAAwD;AACxD,GAAG;AACH,sDAAsD;AACtD,kHAAkH;AAClH,GAAG;AACH,gCAAgC;AAChC,oCAAoC;AACpC,8BAA8B;AAC9B,iDAAiD;AACjD,+BAA+B;AAC/B,aAAa;AACb,eAAe;AACf,oCAAoC;AACpC,8BAA8B;AAC9B,qCAAqC;AACrC,aAAa;AACb,QAAQ;AACR,MAAM;AACN,GAAG;AACH,aAAa;AACb,yEAAyE;AACzE,yHAAyH;AACzH,sBAAsB;AACtB,2EAA2E;AAC3E,iEAAiE;AACjE,kCAAkC;AAClC,6FAA6F;AAC7F,4FAA4F;AAC5F,mEAAmE;AACnE,8BAA8B;AAC9B,iBAAiB;AACjB,eAAe;AACf,iBAAiB;AACjB,sFAAsF;AACtF,+BAA+B;AAC/B,eAAe;AACf,GAAG;AACH,oDAAoD;AACpD,qBAAqB;AACrB,eAAe;AACf,aAAa;AACb,OAAO;AACP,KAAK;AACL,GAAG;AACH,kCAAkC","sourcesContent":["// /** @jsx jsx */\n// /** @jsxFrag React.Fragment */\n// \n// \n// import React from 'react';\n// \n// import { jsx, css } from '@emotion/react';\n// \n// import {\n//   FormGroup,\n//   InputGroup,\n//   NonIdealState,\n//   HTMLSelect,\n//   H4,\n// } from '@blueprintjs/core';\n// \n// import useItemClassConfig from '../../hooks/useItemClassConfig';\n// \n// import type {\n//   ChangeProposal,\n//   Payload,\n//   InternalItemReference,\n// } from '../../../types';\n// \n// import { PROPOSAL_TYPES } from '../../../types';\n// \n// \n// const ProposalDetails: React.FC<{\n//   itemRef: InternalItemReference\n//   proposal: ChangeProposal\n// \n//   existingItemData?: Payload\n// \n//   onAccept?: (itemID: string, clsID: string) => void\n//   onChange?: (val: ChangeProposal) => void\n//   onDelete?: () => void\n// }> = function ({\n//   itemRef,\n//   proposal,\n//   onChange,\n//   existingItemData,\n// }) {\n//   const { value: classConfig } = useItemClassConfig(itemRef.classID ?? 'NONEXISTENT_CLASS_ID');\n//   const itemClass = classConfig;\n// \n//   let itemView: JSX.Element;\n//   let proposalProperties: JSX.Element | null;\n// \n//   if (proposal.type === 'amendment') {\n//     proposalProperties = (\n//       <FormGroup inline label=\"Supersede with:\">\n//         <InputGroup\n//           value={proposal.amendmentType === 'supersession' ? proposal.supersedingItemID : ''}\n//           disabled={!onChange}\n//           placeholder=\"Item ID\"\n//           onChange={onChange\n//             ? (evt: React.FormEvent<HTMLInputElement>) => {\n//                 if (!onChange) { return; }\n//                 const itemID = evt.currentTarget.value;\n//                 if (itemID.trim() === '') {\n//                   const newVal = update(proposal, { $unset: ['supersedingItemID'] });\n//                   onChange({ ...newVal, amendmentType: 'retirement' });\n//                 } else {\n//                   onChange({ ...proposal, amendmentType: 'supersession', supersedingItemID: itemID });\n//                 }\n//               }\n//             : undefined}/>\n//       </FormGroup>\n//     );\n//   } else {\n//     proposalProperties = null;\n//   }\n// \n//   const itemData: Payload | undefined = proposal.type === 'addition'\n//     ? proposal.payload\n//     : existingItemData;\n// \n//   if (itemData === undefined || !itemClass) {\n//     itemView = <NonIdealState icon=\"heart-broken\" title=\"Unable to display this item\" />;\n//   } else if (onChange && proposal.type !== 'amendment') {\n//     const EditView = itemClass.views.editView;// as ItemEditView<any>;\n//     itemView = <EditView\n//       itemRef={itemRef}\n//       itemData={itemData}\n//       onChange={onChange\n//         ? (payload) => onChange ? onChange({ ...proposal, payload }) : void 0\n//         : undefined} />;\n//   } else {\n//     const DetailView = itemClass.views.detailView ?? itemClass!.views.editView;// as ItemDetailView<any>;\n//     itemView = <DetailView\n//       itemRef={itemRef}\n//       itemData={itemData} />;\n//   }\n// \n//   const canChangeProposalType = proposal.type !== 'addition';\n// \n//   function handleTypeChange(type: string) {\n//     const pt = type as typeof PROPOSAL_TYPES[number];\n// \n//     if (PROPOSAL_TYPES.indexOf(pt) < 0) { return; }\n//     if (!onChange || !canChangeProposalType || pt === 'addition' || existingItemData === undefined) { return; }\n// \n//     if (pt === 'amendment') {\n//       onChange(update(proposal, {\n//         type: { $set: pt },\n//         amendmentType: { $set: 'retirement' },\n//         $unset: ['payload'],\n//       }));\n//     } else {\n//       onChange(update(proposal, {\n//         type: { $set: pt },\n//         payload: existingItemData,\n//       }));\n//     }\n//   }\n// \n//   return (\n//     <div css={css`flex: 1; display: flex; flex-flow: column nowrap;`}>\n//       <div css={css`flex-shrink: 0; display: flex; flex-flow: row nowrap; align-items: center; margin-bottom: 1rem;`}>\n//         <HTMLSelect\n//           options={PROPOSAL_TYPES.map(pt => ({ value: pt, label: pt }))}\n//           //iconProps={{ icon: PROPOSAL_ICON[proposal.type] }}\n//           value={proposal.type}\n//           disabled={!onChange || !canChangeProposalType || existingItemData === undefined}\n//           onChange={(onChange && canChangeProposalType && existingItemData !== undefined)\n//             ? (evt) => handleTypeChange(evt.currentTarget.value)\n//             : undefined} />\n//         &ensp;\n//         of a\n//         &ensp;\n//         <H4 css={css`margin: 0;`}>{classConfig?.meta.title ?? 'unknown class'}</H4>\n//         {proposalProperties}\n//       </div>\n// \n//       <div css={css`flex: 1; overflow-y: auto;`}>\n//         {itemView}\n//       </div>\n//     </div>\n//   );\n// };\n// \n// export default ProposalDetails;\n"]}

package/dist/views/detail/ChangeRequest/index.d.ts

@@ -0,0 +1,13 @@
+/** @jsx jsx */
+/** @jsxFrag React.Fragment */
+import React from 'react';
+declare const _default: {
+    main: React.FC<{
+        uri: string;
+    }>;
+    title: React.FC<{
+        uri: string;
+    }>;
+    plainTitle: (uri: string) => Promise<string>;
+};
+export default _default;