@riboseinc/paneron-registry-kit 2.0.0-dev8 → 2.0.0

package/views/itemPathUtils.d.ts

@@ -1,9 +1,52 @@
-import { InternalItemReference } from '../types';
-export declare function itemRefToItemPath({ subregisterID, classID, itemID }: InternalItemReference): string;
+import type { InternalItemReference } from '../types';
+/**
+ * Returns dataset-relative path to a register item,
+ * given structured item reference.
+ *
+ * Optionally makes path include given change request contents.
+ */
+export declare function itemRefToItemPath({ subregisterID, classID, itemID }: InternalItemReference, inCRWithID?: string): string;
+/**
+ * Returns dataset-relative prefix to a register item,
+ * given structured item reference without `itemID`.
+ *
+ * Optionally makes path include given change request contents.
+ */
+export declare function incompleteItemRefToItemPathPrefix({ subregisterID, classID }: Omit<InternalItemReference, 'itemID'>, inCRWithID?: string): string;
+/**
+ * Attempts to return a structured register item reference
+ * given a dataset-relative item path.
+ * If some components are missing, returns an incomplete reference.
+ */
 export declare function itemPathToItemRefLike(hasSubregisters: boolean, itemPath: string): {
     itemID?: string;
     classID?: string;
     subregisterID?: string;
 };
+/** Returns just register item ID, given dataset-relative path. */
 export declare function itemPathToItemID(objPath: string): string | undefined;
+/**
+ * Attempts to return a structured register item reference
+ * given a dataset-relative item path.
+ * If some components are missing, throws an Error.
+ */
 export declare function itemPathToItemRef(hasSubregisters: boolean, itemPath: string): InternalItemReference;
+/**
+ * If given item path indicates that it is within any CR, returns respective CR ID.
+ * Otherwise, returns `null`.
+ */
+export declare function getCRIDFromProposedItemPath(givenItemPath: string): string | null;
+/**
+ * Given an item path, returns path relative to specified CR ID
+ * (even if the path is already relative to another CR ID).
+ */
+export declare function itemPathInCR(givenItemPath: string, crID: string): string;
+/**
+ * Returns given item path in register-relative form,
+ * even if the path is given within proposal contents.
+ */
+export declare function itemPathNotInCR(givenItemPath: string): string;
+/** Converts a change request ID to dataset-relative path to respective main.yaml. */
+export declare function crIDToCRPath(crID: string): string;
+/** Extracts change request ID from dataset-relative path to its main.yaml. */
+export declare function crPathToCRID(crPath: string): string;

package/views/itemPathUtils.js

@@ -4,42 +4,82 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.itemRefToItemPath = itemRefToItemPath;
+exports.incompleteItemRefToItemPathPrefix = incompleteItemRefToItemPathPrefix;
 exports.itemPathToItemRefLike = itemPathToItemRefLike;
 exports.itemPathToItemID = itemPathToItemID;
 exports.itemPathToItemRef = itemPathToItemRef;
+exports.getCRIDFromProposedItemPath = getCRIDFromProposedItemPath;
+exports.itemPathInCR = itemPathInCR;
+exports.itemPathNotInCR = itemPathNotInCR;
+exports.crIDToCRPath = crIDToCRPath;
+exports.crPathToCRID = crPathToCRID;
 
+/**
+ * Returns dataset-relative path to a register item,
+ * given structured item reference.
+ *
+ * Optionally makes path include given change request contents.
+ */
 function itemRefToItemPath({
   subregisterID,
   classID,
   itemID
-}) {
-  if (subregisterID) {
-    return `/${subregisterID}/${classID}/${itemID}.yaml`;
-  } else {
-    return `/${classID}/${itemID}.yaml`;
-  }
+}, inCRWithID) {
+  return `${incompleteItemRefToItemPathPrefix({
+    subregisterID,
+    classID
+  }, inCRWithID)}/${itemID}.yaml`;
 }
+/**
+ * Returns dataset-relative prefix to a register item,
+ * given structured item reference without `itemID`.
+ *
+ * Optionally makes path include given change request contents.
+ */
 
-function itemPathToItemRefLike(hasSubregisters, itemPath) {
-  var _a;
 
-  const pathNormalized = itemPath ? stripLeadingSlash(itemPath) : undefined;
-  const pathParts = (_a = pathNormalized === null || pathNormalized === void 0 ? void 0 : pathNormalized.split('/')) !== null && _a !== void 0 ? _a : [];
-  const subregisterID = hasSubregisters && pathParts.length >= 1 ? pathParts[0] : undefined;
-  const classID = hasSubregisters ? pathParts.length >= 2 ? pathParts[1] : undefined : pathParts.length >= 1 ? pathParts[0] : undefined;
-  const itemID = hasSubregisters && pathParts.length === 3 || !hasSubregisters && pathParts.length === 2 ? pathParts[pathParts.length - 1].split('.')[0] : undefined;
+function incompleteItemRefToItemPathPrefix({
+  subregisterID,
+  classID
+}, inCRWithID) {
+  const itemWithClass = `${classID}`;
+  const fullPath = subregisterID ? `subregisters/${subregisterID}/${itemWithClass}` : itemWithClass;
+  const maybeInCR = inCRWithID !== undefined ? `/proposals/${inCRWithID}/items/${fullPath}` : `/${fullPath}`;
+  return maybeInCR;
+}
+/**
+ * Attempts to return a structured register item reference
+ * given a dataset-relative item path.
+ * If some components are missing, returns an incomplete reference.
+ */
+
+
+function itemPathToItemRefLike(hasSubregisters, itemPath) {
+  const pathNormalized = itemPath.trim() ? stripLeadingSlash(itemPathNotInCR(itemPath)) : undefined;
+  const pathParts = (pathNormalized === null || pathNormalized === void 0 ? void 0 : pathNormalized.split('/')) ?? [];
+  const subregisterID = hasSubregisters && pathParts.length >= 1 ? pathParts[1] : undefined;
+  const classID = hasSubregisters ? pathParts.length >= 3 ? pathParts[2] : undefined : pathParts.length >= 1 ? pathParts[0] : undefined;
+  const itemID = hasSubregisters && pathParts.length === 4 || !hasSubregisters && pathParts.length === 2 ? pathParts[pathParts.length - 1].split('.')[0] : undefined;
   return {
     subregisterID,
     classID,
     itemID
   };
 }
+/** Returns just register item ID, given dataset-relative path. */
+
 
 function itemPathToItemID(objPath) {
   const objPathComponents = objPath === null || objPath === void 0 ? void 0 : objPath.split('/');
   const selectedItemID = objPathComponents !== undefined ? objPathComponents[objPathComponents.length - 1].split('.')[0] : undefined;
   return selectedItemID;
 }
+/**
+ * Attempts to return a structured register item reference
+ * given a dataset-relative item path.
+ * If some components are missing, throws an Error.
+ */
+
 
 function itemPathToItemRef(hasSubregisters, itemPath) {
   const maybeRef = itemPathToItemRefLike(hasSubregisters, itemPath);
@@ -47,11 +87,58 @@ function itemPathToItemRef(hasSubregisters, itemPath) {
   if (maybeRef.classID && maybeRef.itemID) {
     return maybeRef;
   } else {
-    console.error("Internal item reference cannot be constructed from given item path", itemPath, hasSubregisters);
+    console.error("Internal item reference cannot be constructed from given item path, got", maybeRef, itemPath, hasSubregisters, "from", itemPath);
     throw new Error("Internal item reference cannot be constructed from given item path");
   }
 }
 
+const CR_ITEM_PREFIX_REGEX = /^proposals\/(?<crID>\p{Hex_Digit}{8}(?:-\p{Hex_Digit}{4}){3}-\p{Hex_Digit}{12})\/items\//u;
+/**
+ * If given item path indicates that it is within any CR, returns respective CR ID.
+ * Otherwise, returns `null`.
+ */
+
+function getCRIDFromProposedItemPath(givenItemPath) {
+  var _stripLeadingSlash$ma, _stripLeadingSlash$ma2;
+
+  return ((_stripLeadingSlash$ma = stripLeadingSlash(givenItemPath).match(CR_ITEM_PREFIX_REGEX)) === null || _stripLeadingSlash$ma === void 0 ? void 0 : (_stripLeadingSlash$ma2 = _stripLeadingSlash$ma.groups) === null || _stripLeadingSlash$ma2 === void 0 ? void 0 : _stripLeadingSlash$ma2.crID) ?? null;
+}
+/**
+ * Given an item path, returns path relative to specified CR ID
+ * (even if the path is already relative to another CR ID).
+ */
+
+
+function itemPathInCR(givenItemPath, crID) {
+  // Remove any CR prefix from given path
+  // TODO(perf): Don’t do if prefix matches CR ID already specified?
+  // TODO: Validate given path actually looks like a register item path and throw?
+  const normalized = stripLeadingSlash(givenItemPath).replace(CR_ITEM_PREFIX_REGEX, '');
+  return `/proposals/${crID}/items/${normalized}`;
+}
+/**
+ * Returns given item path in register-relative form,
+ * even if the path is given within proposal contents.
+ */
+
+
+function itemPathNotInCR(givenItemPath) {
+  const normalized = stripLeadingSlash(givenItemPath).replace(CR_ITEM_PREFIX_REGEX, '');
+  return `/${normalized}`;
+}
+
 function stripLeadingSlash(aPath) {
   return aPath.replace(/^\//, '');
+}
+/** Converts a change request ID to dataset-relative path to respective main.yaml. */
+
+
+function crIDToCRPath(crID) {
+  return `/proposals/${crID}/main.yaml`;
+}
+/** Extracts change request ID from dataset-relative path to its main.yaml. */
+
+
+function crPathToCRID(crPath) {
+  return stripLeadingSlash(crPath).replace('proposals/', '').split('/')[0];
 }

package/views/itemPathUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"itemPathUtils.js","sourceRoot":"","sources":["../../src/views/itemPathUtils.tsx"],"names":[],"mappings":"AAGA,MAAM,UAAU,iBAAiB,CAAC,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,EAAyB;IACzF,IAAI,aAAa,EAAE;QACjB,OAAO,IAAI,aAAa,IAAI,OAAO,IAAI,MAAM,OAAO,CAAC;KACtD;SAAM;QACL,OAAO,IAAI,OAAO,IAAI,MAAM,OAAO,CAAC;KACrC;AACH,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,eAAwB,EAAE,QAAgB;;IAE9E,MAAM,cAAc,GAAG,QAAQ;QAC7B,CAAC,CAAC,iBAAiB,CAAC,QAAQ,CAAC;QAC7B,CAAC,CAAC,SAAS,CAAC;IACd,MAAM,SAAS,GAAG,MAAA,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,KAAK,CAAC,GAAG,CAAC,mCAAI,EAAE,CAAC;IAEnD,MAAM,aAAa,GAAuB,eAAe,IAAI,SAAS,CAAC,MAAM,IAAI,CAAC;QAChF,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;QACd,CAAC,CAAC,SAAS,CAAC;IAEd,MAAM,OAAO,GAAuB,eAAe;QACjD,CAAC,CAAC,SAAS,CAAC,MAAM,IAAI,CAAC;YACrB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;YACd,CAAC,CAAC,SAAS;QACb,CAAC,CAAC,SAAS,CAAC,MAAM,IAAI,CAAC;YACrB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;YACd,CAAC,CAAC,SAAS,CAAC;IAEhB,MAAM,MAAM,GACV,CAAC,eAAe,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,CAAC;QAC3C,CAAC,CAAC,eAAe,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,CAAC;QAC1C,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC/C,CAAC,CAAC,SAAS,CAAC;IAEhB,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;AAC5C,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,OAAe;IAC9C,MAAM,iBAAiB,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,CAAC,GAAG,CAAC,CAAC;IAC9C,MAAM,cAAc,GAAG,iBAAiB,KAAK,SAAS;QACpD,CAAC,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC/D,CAAC,CAAC,SAAS,CAAC;IACd,OAAO,cAAc,CAAC;AACxB,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,eAAwB,EAAE,QAAgB;IAC1E,MAAM,QAAQ,GAAG,qBAAqB,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC;IAClE,IAAI,QAAQ,CAAC,OAAO,IAAI,QAAQ,CAAC,MAAM,EAAE;QACvC,OAAO,QAAiC,CAAC;KAC1C;SAAM;QACL,OAAO,CAAC,KAAK,CAAC,oEAAoE,EAAE,QAAQ,EAAE,eAAe,CAAC,CAAC;QAC/G,MAAM,IAAI,KAAK,CAAC,oEAAoE,CAAC,CAAC;KACvF;AACH,CAAC;AAED,SAAS,iBAAiB,CAAC,KAAa;IACtC,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;AAClC,CAAC","sourcesContent":["import { InternalItemReference } from '../types';\n\n\nexport function itemRefToItemPath({ subregisterID, classID, itemID }: InternalItemReference): string {\n  if (subregisterID) {\n    return `/${subregisterID}/${classID}/${itemID}.yaml`;\n  } else {\n    return `/${classID}/${itemID}.yaml`;\n  }\n}\n\nexport function itemPathToItemRefLike(hasSubregisters: boolean, itemPath: string):\n{ itemID?: string; classID?: string; subregisterID?: string; } {\n  const pathNormalized = itemPath\n    ? stripLeadingSlash(itemPath)\n    : undefined;\n  const pathParts = pathNormalized?.split('/') ?? [];\n\n  const subregisterID: string | undefined = hasSubregisters && pathParts.length >= 1\n    ? pathParts[0]\n    : undefined;\n\n  const classID: string | undefined = hasSubregisters\n    ? pathParts.length >= 2\n      ? pathParts[1]\n      : undefined\n    : pathParts.length >= 1\n      ? pathParts[0]\n      : undefined;\n\n  const itemID: string | undefined =\n    (hasSubregisters && pathParts.length === 3) ||\n    (!hasSubregisters && pathParts.length === 2)\n      ? pathParts[pathParts.length - 1].split('.')[0]\n      : undefined;\n\n  return { subregisterID, classID, itemID };\n}\n\nexport function itemPathToItemID(objPath: string): string | undefined {\n  const objPathComponents = objPath?.split('/');\n  const selectedItemID = objPathComponents !== undefined\n    ? objPathComponents[objPathComponents.length - 1].split('.')[0]\n    : undefined;\n  return selectedItemID;\n}\n\nexport function itemPathToItemRef(hasSubregisters: boolean, itemPath: string): InternalItemReference {\n  const maybeRef = itemPathToItemRefLike(hasSubregisters, itemPath);\n  if (maybeRef.classID && maybeRef.itemID) {\n    return maybeRef as InternalItemReference;\n  } else {\n    console.error(\"Internal item reference cannot be constructed from given item path\", itemPath, hasSubregisters);\n    throw new Error(\"Internal item reference cannot be constructed from given item path\");\n  }\n}\n\nfunction stripLeadingSlash(aPath: string): string {\n  return aPath.replace(/^\\//, '');\n}\n"]}
+{"version":3,"file":"itemPathUtils.js","sourceRoot":"","sources":["../../src/views/itemPathUtils.tsx"],"names":[],"mappings":"AAGA;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAC/B,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,EAAyB,EACzD,UAAmB;IAEnB,OAAO,GAAG,iCAAiC,CAAC,EAAE,aAAa,EAAE,OAAO,EAAE,EAAE,UAAU,CAAC,IAAI,MAAM,OAAO,CAAC;AACvG,CAAC;AAGD;;;;;GAKG;AACH,MAAM,UAAU,iCAAiC,CAC/C,EAAE,aAAa,EAAE,OAAO,EAAyC,EACjE,UAAmB;IAEnB,MAAM,aAAa,GAAG,GAAG,OAAO,EAAE,CAAC;IACnC,MAAM,QAAQ,GAAG,aAAa;QAC5B,CAAC,CAAC,gBAAgB,aAAa,IAAI,aAAa,EAAE;QAClD,CAAC,CAAC,aAAa,CAAC;IAClB,MAAM,SAAS,GAAG,UAAU,KAAK,SAAS;QACxC,CAAC,CAAC,cAAc,UAAU,UAAU,QAAQ,EAAE;QAC9C,CAAC,CAAC,IAAI,QAAQ,EAAE,CAAC;IACnB,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,qBAAqB,CAAC,eAAwB,EAAE,QAAgB;IAE9E,MAAM,cAAc,GAAG,QAAQ,CAAC,IAAI,EAAE;QACpC,CAAC,CAAC,iBAAiB,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;QAC9C,CAAC,CAAC,SAAS,CAAC;IACd,MAAM,SAAS,GAAG,cAAc,EAAE,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;IAEnD,MAAM,aAAa,GAAuB,eAAe,IAAI,SAAS,CAAC,MAAM,IAAI,CAAC;QAChF,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;QACd,CAAC,CAAC,SAAS,CAAC;IAEd,MAAM,OAAO,GAAuB,eAAe;QACjD,CAAC,CAAC,SAAS,CAAC,MAAM,IAAI,CAAC;YACrB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;YACd,CAAC,CAAC,SAAS;QACb,CAAC,CAAC,SAAS,CAAC,MAAM,IAAI,CAAC;YACrB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;YACd,CAAC,CAAC,SAAS,CAAC;IAEhB,MAAM,MAAM,GACV,CAAC,eAAe,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,CAAC;QAC3C,CAAC,CAAC,eAAe,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,CAAC;QAC1C,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC/C,CAAC,CAAC,SAAS,CAAC;IAEhB,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;AAC5C,CAAC;AAED,kEAAkE;AAClE,MAAM,UAAU,gBAAgB,CAAC,OAAe;IAC9C,MAAM,iBAAiB,GAAG,OAAO,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;IAC9C,MAAM,cAAc,GAAG,iBAAiB,KAAK,SAAS;QACpD,CAAC,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC/D,CAAC,CAAC,SAAS,CAAC;IACd,OAAO,cAAc,CAAC;AACxB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAAC,eAAwB,EAAE,QAAgB;IAC1E,MAAM,QAAQ,GAAG,qBAAqB,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC;IAClE,IAAI,QAAQ,CAAC,OAAO,IAAI,QAAQ,CAAC,MAAM,EAAE;QACvC,OAAO,QAAiC,CAAC;KAC1C;SAAM;QACL,OAAO,CAAC,KAAK,CAAC,yEAAyE,EAAE,QAAQ,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;QAChJ,MAAM,IAAI,KAAK,CAAC,oEAAoE,CAAC,CAAC;KACvF;AACH,CAAC;AAGD,MAAM,oBAAoB,GAAG,2FAA2F,CAAC;AAGzH;;;GAGG;AACH,MAAM,UAAU,2BAA2B,CAAC,aAAqB;IAC/D,OAAO,iBAAiB,CAAC,aAAa,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,EAAE,MAAM,EAAE,IAAI,IAAI,IAAI,CAAC;AAC5F,CAAC;AAGD;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAC,aAAqB,EAAE,IAAY;IAC9D,uCAAuC;IACvC,kEAAkE;IAClE,gFAAgF;IAChF,MAAM,UAAU,GAAG,iBAAiB,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,oBAAoB,EAAE,EAAE,CAAC,CAAC;IACtF,OAAO,cAAc,IAAI,UAAU,UAAU,EAAE,CAAC;AAClD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,eAAe,CAAC,aAAqB;IACnD,MAAM,UAAU,GAAG,iBAAiB,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,oBAAoB,EAAE,EAAE,CAAC,CAAC;IACtF,OAAO,IAAI,UAAU,EAAE,CAAC;AAC1B,CAAC;AAED,SAAS,iBAAiB,CAAC,KAAa;IACtC,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;AAClC,CAAC;AAGD,qFAAqF;AACrF,MAAM,UAAU,YAAY,CAAC,IAAY;IACvC,OAAO,cAAc,IAAI,YAAY,CAAC;AACxC,CAAC;AAED,8EAA8E;AAC9E,MAAM,UAAU,YAAY,CAAC,MAAc;IACzC,OAAO,CACL,iBAAiB,CAAC,MAAM,CAAC;QACzB,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC;QACzB,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CACd,CAAC;AACJ,CAAC","sourcesContent":["import type { InternalItemReference } from '../types';\n\n\n/**\n * Returns dataset-relative path to a register item,\n * given structured item reference.\n *\n * Optionally makes path include given change request contents.\n */\nexport function itemRefToItemPath(\n  { subregisterID, classID, itemID }: InternalItemReference,\n  inCRWithID?: string,\n): string {\n  return `${incompleteItemRefToItemPathPrefix({ subregisterID, classID }, inCRWithID)}/${itemID}.yaml`;\n}\n\n\n/**\n * Returns dataset-relative prefix to a register item,\n * given structured item reference without `itemID`.\n *\n * Optionally makes path include given change request contents.\n */\nexport function incompleteItemRefToItemPathPrefix(\n  { subregisterID, classID }: Omit<InternalItemReference, 'itemID'>,\n  inCRWithID?: string,\n): string {\n  const itemWithClass = `${classID}`;\n  const fullPath = subregisterID\n    ? `subregisters/${subregisterID}/${itemWithClass}`\n    : itemWithClass;\n  const maybeInCR = inCRWithID !== undefined\n    ? `/proposals/${inCRWithID}/items/${fullPath}`\n    : `/${fullPath}`;\n  return maybeInCR;\n}\n\n/**\n * Attempts to return a structured register item reference\n * given a dataset-relative item path.\n * If some components are missing, returns an incomplete reference.\n */\nexport function itemPathToItemRefLike(hasSubregisters: boolean, itemPath: string):\n{ itemID?: string; classID?: string; subregisterID?: string; } {\n  const pathNormalized = itemPath.trim()\n    ? stripLeadingSlash(itemPathNotInCR(itemPath))\n    : undefined;\n  const pathParts = pathNormalized?.split('/') ?? [];\n\n  const subregisterID: string | undefined = hasSubregisters && pathParts.length >= 1\n    ? pathParts[1]\n    : undefined;\n\n  const classID: string | undefined = hasSubregisters\n    ? pathParts.length >= 3\n      ? pathParts[2]\n      : undefined\n    : pathParts.length >= 1\n      ? pathParts[0]\n      : undefined;\n\n  const itemID: string | undefined =\n    (hasSubregisters && pathParts.length === 4) ||\n    (!hasSubregisters && pathParts.length === 2)\n      ? pathParts[pathParts.length - 1].split('.')[0]\n      : undefined;\n\n  return { subregisterID, classID, itemID };\n}\n\n/** Returns just register item ID, given dataset-relative path. */\nexport function itemPathToItemID(objPath: string): string | undefined {\n  const objPathComponents = objPath?.split('/');\n  const selectedItemID = objPathComponents !== undefined\n    ? objPathComponents[objPathComponents.length - 1].split('.')[0]\n    : undefined;\n  return selectedItemID;\n}\n\n/**\n * Attempts to return a structured register item reference\n * given a dataset-relative item path.\n * If some components are missing, throws an Error.\n */\nexport function itemPathToItemRef(hasSubregisters: boolean, itemPath: string): InternalItemReference {\n  const maybeRef = itemPathToItemRefLike(hasSubregisters, itemPath);\n  if (maybeRef.classID && maybeRef.itemID) {\n    return maybeRef as InternalItemReference;\n  } else {\n    console.error(\"Internal item reference cannot be constructed from given item path, got\", maybeRef, itemPath, hasSubregisters, \"from\", itemPath);\n    throw new Error(\"Internal item reference cannot be constructed from given item path\");\n  }\n}\n\n\nconst CR_ITEM_PREFIX_REGEX = /^proposals\\/(?<crID>\\p{Hex_Digit}{8}(?:-\\p{Hex_Digit}{4}){3}-\\p{Hex_Digit}{12})\\/items\\//u;\n\n\n/**\n * If given item path indicates that it is within any CR, returns respective CR ID.\n * Otherwise, returns `null`.\n */\nexport function getCRIDFromProposedItemPath(givenItemPath: string): string | null {\n  return stripLeadingSlash(givenItemPath).match(CR_ITEM_PREFIX_REGEX)?.groups?.crID ?? null;\n}\n\n\n/**\n * Given an item path, returns path relative to specified CR ID\n * (even if the path is already relative to another CR ID).\n */\nexport function itemPathInCR(givenItemPath: string, crID: string): string {\n  // Remove any CR prefix from given path\n  // TODO(perf): Don’t do if prefix matches CR ID already specified?\n  // TODO: Validate given path actually looks like a register item path and throw?\n  const normalized = stripLeadingSlash(givenItemPath).replace(CR_ITEM_PREFIX_REGEX, '');\n  return `/proposals/${crID}/items/${normalized}`;\n}\n\n/**\n * Returns given item path in register-relative form,\n * even if the path is given within proposal contents.\n */\nexport function itemPathNotInCR(givenItemPath: string): string {\n  const normalized = stripLeadingSlash(givenItemPath).replace(CR_ITEM_PREFIX_REGEX, '');\n  return `/${normalized}`;\n}\n\nfunction stripLeadingSlash(aPath: string): string {\n  return aPath.replace(/^\\//, '');\n}\n\n\n/** Converts a change request ID to dataset-relative path to respective main.yaml. */\nexport function crIDToCRPath(crID: string): string {\n  return `/proposals/${crID}/main.yaml`;\n}\n\n/** Extracts change request ID from dataset-relative path to its main.yaml. */\nexport function crPathToCRID(crPath: string): string {\n  return (\n    stripLeadingSlash(crPath).\n    replace('proposals/', '').\n    split('/')[0]\n  );\n}\n"]}

package/views/itemQueryUtils.d.ts

@@ -0,0 +1,11 @@
+import { Base as BaseCR } from '../types/cr';
+/**
+ * Returns a query criteria for use with filtered indexes
+ * by combining given `queryExpression` with base query that matches only
+ * objects corresponding to register items.
+ *
+ * `withCR` should be set to active CR, and would make the query
+ * additionally match clarified/added register items that did not yet make it
+ * into the register proper.
+ */
+export declare function getRegisterItemQuery(queryExpression: string, withCR?: BaseCR): string;

package/views/itemQueryUtils.js

@@ -0,0 +1,48 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getRegisterItemQuery = getRegisterItemQuery;
+
+var _itemPathUtils = require("./itemPathUtils");
+
+// TODO: Should it be three path components? Probably four
+const REGISTER_ITEM_QUERY = `
+  objPath.startsWith("/subregisters/") || (
+    objPath.split("/").length === 3 &&
+    !objPath.startsWith("/proposals/")
+  )
+`;
+/**
+ * Returns a query that matches given register item object path
+ * depending on how it appears in given change request.
+ *
+ * For additions, object path would be full in-proposal path
+ * (the item doesn’t exist in the register “normally”), so we want to match that.
+ * For clarifications, object path we want to match is normal
+ */
+
+function getItemInCRQuery(cr) {
+  //const affectedItemPathsQuoted: string[] = Object.entries(withCR.items).
+  //  filter(([, proposal]) => proposal.type === 'clarification' || proposal.type === 'addition').
+  //  map(([itemPath, proposal]) => proposal.type === 'clarification' ? `"${itemPath}"` : `/proposals/${withCR.id}/items/${itemPath}`);
+  const affectedItemPathsQuoted = Object.entries(cr.items).filter(([, proposal]) => proposal.type !== 'amendment').map(([itemPath]) => `"${(0, _itemPathUtils.itemPathInCR)(itemPath, cr.id)}"`);
+  return `[${affectedItemPathsQuoted.join(',')}].indexOf(objPath) >= 0`;
+}
+/**
+ * Returns a query criteria for use with filtered indexes
+ * by combining given `queryExpression` with base query that matches only
+ * objects corresponding to register items.
+ *
+ * `withCR` should be set to active CR, and would make the query
+ * additionally match clarified/added register items that did not yet make it
+ * into the register proper.
+ */
+
+
+function getRegisterItemQuery(queryExpression, withCR) {
+  const baseQuery = withCR ? `(${getItemInCRQuery(withCR)}) || (${REGISTER_ITEM_QUERY})` : REGISTER_ITEM_QUERY; // console.debug("CR QUERY", baseQuery);
+
+  return `return (${baseQuery}) && (${queryExpression.trim()})`;
+}

package/views/itemQueryUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"itemQueryUtils.js","sourceRoot":"","sources":["../../src/views/itemQueryUtils.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAG/C,0DAA0D;AAC1D,MAAM,mBAAmB,GAAG;;;;;CAK3B,CAAC;AAGF;;;;;;;GAOG;AACH,SAAS,gBAAgB,CAAC,EAAU;IAClC,yEAAyE;IACzE,gGAAgG;IAChG,qIAAqI;IACrI,MAAM,uBAAuB,GAAa,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC;QAChE,MAAM,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,KAAK,WAAW,CAAC;QACvD,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAG,EAAE,EAAE,CAAC,IAAI,YAAY,CAAC,QAAQ,EAAE,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;IAC9D,OAAO,IAAI,uBAAuB,CAAC,IAAI,CAAC,GAAG,CAAC,yBAAyB,CAAC;AACxE,CAAC;AAGD;;;;;;;;GAQG;AACH,MAAM,UAAU,oBAAoB,CAAC,eAAuB,EAAE,MAAe;IAC3E,MAAM,SAAS,GAAG,MAAM;QACtB,CAAC,CAAC,IAAI,gBAAgB,CAAC,MAAM,CAAC,SAAS,mBAAmB,GAAG;QAC7D,CAAC,CAAC,mBAAmB,CAAC;IACxB,wCAAwC;IAExC,OAAO,WAAW,SAAS,SAAS,eAAe,CAAC,IAAI,EAAE,GAAG,CAAC;AAChE,CAAC","sourcesContent":["import { Base as BaseCR } from '../types/cr';\nimport { itemPathInCR } from './itemPathUtils';\n\n\n// TODO: Should it be three path components? Probably four\nconst REGISTER_ITEM_QUERY = `\n  objPath.startsWith(\"/subregisters/\") || (\n    objPath.split(\"/\").length === 3 &&\n    !objPath.startsWith(\"/proposals/\")\n  )\n`;\n\n\n/**\n * Returns a query that matches given register item object path\n * depending on how it appears in given change request.\n *\n * For additions, object path would be full in-proposal path\n * (the item doesn’t exist in the register “normally”), so we want to match that.\n * For clarifications, object path we want to match is normal\n */\nfunction getItemInCRQuery(cr: BaseCR): string {\n  //const affectedItemPathsQuoted: string[] = Object.entries(withCR.items).\n  //  filter(([, proposal]) => proposal.type === 'clarification' || proposal.type === 'addition').\n  //  map(([itemPath, proposal]) => proposal.type === 'clarification' ? `\"${itemPath}\"` : `/proposals/${withCR.id}/items/${itemPath}`);\n  const affectedItemPathsQuoted: string[] = Object.entries(cr.items).\n    filter(([, proposal]) => proposal.type !== 'amendment').\n    map(([itemPath, ]) => `\"${itemPathInCR(itemPath, cr.id)}\"`);\n  return `[${affectedItemPathsQuoted.join(',')}].indexOf(objPath) >= 0`;\n}\n\n\n/**\n * Returns a query criteria for use with filtered indexes\n * by combining given `queryExpression` with base query that matches only\n * objects corresponding to register items.\n *\n * `withCR` should be set to active CR, and would make the query\n * additionally match clarified/added register items that did not yet make it\n * into the register proper.\n */\nexport function getRegisterItemQuery(queryExpression: string, withCR?: BaseCR): string {\n  const baseQuery = withCR\n    ? `(${getItemInCRQuery(withCR)}) || (${REGISTER_ITEM_QUERY})`\n    : REGISTER_ITEM_QUERY;\n  // console.debug(\"CR QUERY\", baseQuery);\n\n  return `return (${baseQuery}) && (${queryExpression.trim()})`;\n}\n"]}

package/views/protocolRegistry.d.ts

@@ -0,0 +1,12 @@
+import { ProtocolRegistry } from '@riboseinc/paneron-extension-kit/widgets/TabbedWorkspace/types';
+export declare const Protocols: {
+    readonly ITEM_DETAILS: "itemdetails";
+    readonly REGISTER_META: "registermeta";
+    readonly CHANGE_REQUEST: "changerequest";
+    readonly CUSTOM_VIEW: "customview";
+};
+export declare type Protocol = typeof Protocols[keyof typeof Protocols];
+export declare const protocols: Protocol[];
+export declare function isValidProtocol(val: string): val is Protocol;
+declare const protocolRegistry: ProtocolRegistry<Protocol>;
+export default protocolRegistry;

package/views/protocolRegistry.js

@@ -0,0 +1,42 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isValidProtocol = isValidProtocol;
+exports.default = exports.protocols = exports.Protocols = void 0;
+
+var _RegisterItem = _interopRequireDefault(require("./detail/RegisterItem"));
+
+var _RegisterMeta = _interopRequireDefault(require("./detail/RegisterMeta"));
+
+var _ChangeRequest = _interopRequireDefault(require("./detail/ChangeRequest"));
+
+var _CustomView = _interopRequireDefault(require("./detail/CustomView"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const Protocols = {
+  ITEM_DETAILS: 'itemdetails',
+  REGISTER_META: 'registermeta',
+  CHANGE_REQUEST: 'changerequest',
+  CUSTOM_VIEW: 'customview'
+};
+exports.Protocols = Protocols;
+const protocols = Object.values(Protocols);
+exports.protocols = protocols;
+
+function isValidProtocol(val) {
+  return protocols.indexOf(val) >= 0;
+} // TODO: Implement proper registration pattern rather than registering
+// these in a centralized manner.
+
+
+const protocolRegistry = {
+  [Protocols.ITEM_DETAILS]: _RegisterItem.default,
+  [Protocols.REGISTER_META]: _RegisterMeta.default,
+  [Protocols.CHANGE_REQUEST]: _ChangeRequest.default,
+  [Protocols.CUSTOM_VIEW]: _CustomView.default
+};
+var _default = protocolRegistry;
+exports.default = _default;

package/views/protocolRegistry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"protocolRegistry.js","sourceRoot":"","sources":["../../src/views/protocolRegistry.ts"],"names":[],"mappings":"AACA,OAAO,YAAY,MAAM,uBAAuB,CAAC;AACjD,OAAO,YAAY,MAAM,uBAAuB,CAAC;AACjD,OAAO,aAAa,MAAM,wBAAwB,CAAC;AACnD,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAE7C,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB,YAAY,EAAE,aAAa;IAC3B,aAAa,EAAE,cAAc;IAC7B,cAAc,EAAE,eAAe;IAC/B,WAAW,EAAE,YAAY;CACjB,CAAC;AAIX,MAAM,CAAC,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,CAAe,CAAC;AAEhE,MAAM,UAAU,eAAe,CAAC,GAAW;IACzC,OAAO,SAAS,CAAC,OAAO,CAAC,GAAe,CAAC,IAAI,CAAC,CAAC;AACjD,CAAC;AAED,sEAAsE;AACtE,iCAAiC;AACjC,MAAM,gBAAgB,GAA+B;IACnD,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,YAAY;IACtC,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,YAAY;IACvC,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,aAAa;IACzC,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE,UAAU;CACpC,CAAC;AAEF,eAAe,gBAAgB,CAAC","sourcesContent":["import { ProtocolRegistry } from '@riboseinc/paneron-extension-kit/widgets/TabbedWorkspace/types';\nimport RegisterItem from './detail/RegisterItem';\nimport RegisterMeta from './detail/RegisterMeta';\nimport ChangeRequest from './detail/ChangeRequest';\nimport CustomView from './detail/CustomView';\n\nexport const Protocols = {\n  ITEM_DETAILS: 'itemdetails',\n  REGISTER_META: 'registermeta',\n  CHANGE_REQUEST: 'changerequest',\n  CUSTOM_VIEW: 'customview',\n} as const;\n\nexport type Protocol = typeof Protocols[keyof typeof Protocols];\n\nexport const protocols = Object.values(Protocols) as Protocol[];\n\nexport function isValidProtocol(val: string): val is Protocol {\n  return protocols.indexOf(val as Protocol) >= 0;\n}\n\n// TODO: Implement proper registration pattern rather than registering\n// these in a centralized manner.\nconst protocolRegistry: ProtocolRegistry<Protocol> = {\n  [Protocols.ITEM_DETAILS]: RegisterItem,\n  [Protocols.REGISTER_META]: RegisterMeta,\n  [Protocols.CHANGE_REQUEST]: ChangeRequest,\n  [Protocols.CUSTOM_VIEW]: CustomView,\n};\n\nexport default protocolRegistry;\n"]}

package/views/sidebar/Browse/index.d.ts

@@ -0,0 +1,11 @@
+/** @jsx jsx */
+/** @jsxFrag React.Fragment */
+import React from 'react';
+declare const Browse: React.FC<{
+    availableClassIDs?: string[];
+    onOpenItem?: (itemPath: string) => void;
+    stateName?: string;
+    className?: string;
+    style?: React.CSSProperties;
+}>;
+export default Browse;