@riboseinc/paneron-registry-kit 2.0.1 → 2.0.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riboseinc/paneron-registry-kit",
-  "version": "2.0.1",
+  "version": "2.0.3",
   "main": "index.js",
   "author": "Ribose Inc. <open.source@ribose.com>",
   "scripts": {
@@ -29,7 +29,7 @@
     "@emotion/react": "^11.10.6",
     "@emotion/styled": "^11.10.6",
     "@riboseinc/isogit-lfs": "0.1.6",
-    "@riboseinc/paneron-extension-kit": "2.0.0",
+    "@riboseinc/paneron-extension-kit": "2.0.1",
     "@types/js-yaml": "^3.12.5",
     "@types/node": "^16.11.7",
     "@types/object-hash": "~3.0.2",

package/{dist/views → views}/index.js

@@ -60,6 +60,7 @@ const RegistryView = function (props) {
 };
 
 exports.RegistryView = RegistryView;
+const SIDEBAR_WIDTH_SETTING_NAME = 'registryMainSidebarWidthPixels';
 
 const RegistryWorkspace = function () {
   const {
@@ -68,17 +69,35 @@ const RegistryWorkspace = function () {
   const {
     spawnTab
   } = (0, _react.useContext)(_context2.TabbedWorkspaceContext);
+  const {
+    useSettings,
+    updateSetting
+  } = (0, _react.useContext)(_context.DatasetContext);
   const globalMode = (0, _react.useMemo)(() => activeChangeRequest ? {
     content: (0, _react2.jsx)(_react.default.Fragment, null, "Viewing register as proposed\u2009\u2014\u2009contents shown may differ from version in effect"),
     intent: 'danger',
     onClick: () => spawnTab(`${_protocolRegistry.Protocols.CHANGE_REQUEST}:/proposals/${activeChangeRequest.id}/main.yaml`)
   } : undefined, [activeChangeRequest === null || activeChangeRequest === void 0 ? void 0 : activeChangeRequest.id]);
+  const {
+    value: {
+      settings
+    }
+  } = useSettings();
+  const stored = settings[SIDEBAR_WIDTH_SETTING_NAME];
+  const sidebarWidth = stored && typeof stored === 'number' ? stored : undefined;
   return (0, _react2.jsx)(_TabbedWorkspace.default, {
     css: (0, _react2.css)`flex: 1 1 auto;`,
     sidebarConfig: _sidebar.sidebarConfig,
     sidebarIDs: _sidebar.sidebarIDs,
     newTabPrompt: (0, _react2.jsx)(_RegisterHome.default, null),
-    globalMode: globalMode
+    globalMode: globalMode,
+    sidebarWidth: sidebarWidth,
+    onSidebarResize: width => {
+      updateSetting({
+        key: SIDEBAR_WIDTH_SETTING_NAME,
+        value: width
+      });
+    }
   });
 };
 

package/views/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/views/index.tsx"],"names":[],"mappings":"AAAA,eAAe;AACf,8BAA8B;AAE9B,OAAO,KAAK,EAAE,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAC7D,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAG1C,OAAO,EAAE,cAAc,EAAE,MAAM,0CAA0C,CAAC;AAC1E,OAAO,eAAyC,MAAM,0DAA0D,CAAC;AACjH,OAAO,EACL,mBAAmB,IAAI,kCAAkC,EACzD,sBAAsB,GACvB,MAAM,kEAAkE,CAAC;AAE1E,OAAO,EAKL,cAAc,EACd,kBAAkB,EAClB,uBAAuB,GACxB,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,0BAA0B,EAAE,MAAM,WAAW,CAAC;AAEvD,OAAO,sBAAsB,MAAM,0BAA0B,CAAC;AAC9D,OAAO,EAAE,aAAa,EAAa,UAAU,EAAE,MAAM,WAAW,CAAC;AACjE,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAC1C,OAAO,YAAY,MAAM,uBAAuB,CAAC;AACjD,OAAO,gBAAgB,EAAE,EAAE,SAAS,EAAiB,MAAM,oBAAoB,CAAC;AAChF,OAAO,EACL,oBAAoB,EACpB,4BAA4B,GAC7B,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AACtE,OAAO,EAAE,sBAAsB,EAAE,CAAC;AAGlC,MAAM,8BAA8B,GAAG,kCAAkC,CACvE,QAAQ,EACR,UAAU,EACV,gBAAgB,CAAC,CAAC;AAGpB,MAAM,CAAC,MAAM,YAAY,GAAgC,UAAU,KAAK;IACtE,OAAO,CACL,IAAC,8BAA8B,IAAC,QAAQ,EAAC,oBAAoB;QAC3D,IAAC,kBAAkB,OAAK,KAAK;YAC3B,IAAC,iBAAiB,OAAG,CACF,CACU,CAClC,CAAC;AACJ,CAAC,CAAC;AAGF,MAAM,0BAA0B,GAAG,gCAAgC,CAAA;AAGnE,MAAM,iBAAiB,GAAmC;IACxD,MAAM,EAAE,aAAa,EAAE,mBAAmB,EAAE,GAAG,UAAU,CAAC,oBAAoB,CAAC,CAAC;IAChF,MAAM,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC,sBAAsB,CAAC,CAAC;IACxD,MAAM,EAAE,WAAW,EAAE,aAAa,EAAE,GAAG,UAAU,CAAC,cAAc,CAAC,CAAC;IAElE,MAAM,UAAU,GAA4C,OAAO,CACjE,CAAC,GAAG,EAAE,CAAC,mBAAmB;QACxB,CAAC,CAAC;YACE,OAAO,EAAE,2HAEN;YACH,MAAM,EAAE,QAAQ;YAChB,OAAO,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC,cAAc,eAAe,mBAAmB,CAAC,EAAE,YAAY,CAAC;SACtG;QACH,CAAC,CAAC,SAAS,CAAC,EACd,CAAC,mBAAmB,EAAE,EAAE,CAAC,CAC1B,CAAC;IAEF,MAAM,EAAE,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,GAAG,WAAW,EAAE,CAAC;IAE9C,MAAM,MAAM,GAAG,QAAQ,CAAC,0BAA0B,CAAC,CAAA;IACnD,MAAM,YAAY,GAAuB,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ;QAC3E,CAAC,CAAC,MAAgB;QAClB,CAAC,CAAC,SAAS,CAAC;IAEd,OAAO,IAAC,eAAe,IACrB,GAAG,EAAE,GAAG,CAAA,iBAAiB,EACzB,aAAa,EAAE,aAAa,EAC5B,UAAU,EAAE,UAAU,EACtB,YAAY,EAAE,IAAC,YAAY,OAAG,EAC9B,UAAU,EAAE,UAAU,EACtB,YAAY,EAAE,YAAY,EAC1B,eAAe,EAAE,CAAC,KAAK,EAAE,EAAE;YACzB,aAAa,CAAC,EAAE,GAAG,EAAE,0BAA0B,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAA;QAClE,CAAC,GACD,CAAA;AACJ,CAAC,CAAC;AAGF,MAAM,kBAAkB,GAAgC,UAAU,EAChE,sBAAsB,EACtB,YAAY,EACZ,aAAa,EACb,qBAAqB,EACrB,WAAW,EACX,QAAQ,GACT;IAEC,MAAM,EAAE,aAAa,EAAE,iBAAiB,EAAE,GAAG,UAAU,CAAC,cAAc,CAAC,CAAC;IACxE,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC,sBAAsB,CAAC,CAAC;IAEvE,MAAM,gBAAgB,GACpB,aAAa,IAAI,aAAa,CAAC,UAAU,CAAC,GAAG,SAAS,CAAC,YAAY,GAAG,CAAC;QACrE,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC7B,CAAC,CAAC,IAAI,CAAC;IAEX,MAAM,eAAe,GACnB,gBAAgB;QACd,CAAC,CAAC,qBAAqB,CAAC,YAAY,KAAK,SAAS,EAAE,gBAAgB,CAAC;QACrE,CAAC,CAAC,IAAI,CAAC;IAEX,MAAM,6BAA6B,GAA+B,aAAa,CAAC;QAC9E,WAAW,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,EAAE;KACxD,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,gBAAgB,IAAI,EAAE,CAAC,CAAC;IAEtC,MAAM,oBAAoB,GACxB,uBAAuB,CAAC,eAAe,CAAC;QACtC,CAAC,CAAC,6BAA6B;YAC7B,cAAc,CAAC,6BAA6B,CAAC;YAC3C,CAAC,CAAC;gBACE,IAAI,EAAE,6BAA6B;gBACnC,GAAG,EAAE,eAAe;gBACpB,SAAS,EAAE,sBAAsB,CAAC,eAAe,CAAC,OAAO,CAAC;aAC3D;YACL,CAAC,CAAC,SAAS;QACb,CAAC,CAAC,IAAI,CAAC;IAEX,8EAA8E;IAC9E,uEAAuE;IACvE,sEAAsE;IACtE,qFAAqF;IACrF,6BAA6B;IAC7B,MAAM,mBAAmB,GAAyB,CAAC,IAAI,EAAE,EAAE;QACzD,6EAA6E;QAC7E,2CAA2C;QAC3C,uGAAuG;QACvG,MAAM,cAAc,GAA2B,EAAE,CAAC;QAElD,MAAM,EAAE,aAAa,EAAE,mBAAmB,EAAE,GAAG,UAAU,CAAC,oBAAoB,CAAC,CAAC;QAGhF,KAAK,MAAM,aAAa,IAAI,IAAI,CAAC,SAAS,EAAE;YAC1C,cAAc,CAAC,aAAa,CAAC,GAAG,aAAa,CAAC;YAE9C,+EAA+E;YAC/E,6EAA6E;YAC7E,IAAI,CAAC,IAAI,CAAC,cAAc,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,YAAY,CAAC,IAAI,mBAAmB,EAAE,EAAE,EAAE;gBAC9F,cAAc,CAAC,YAAY,CAAC,aAAa,EAAE,mBAAmB,CAAC,EAAE,CAAC,CAAC,GAAG,aAAa,CAAC;aACrF;SACF;QAED,MAAM,MAAM,GAAG,aAAa,CAAC;YAC3B,WAAW,EAAE,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC;SACzC,CAAoE,CAAC;QAEtE,MAAM,QAAQ,GAA6C,EAAE,CAAC;QAC9D,KAAK,MAAM,CAAC,eAAe,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE;YACxE,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC;mBAC1C,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC;mBAC3B,IAAI,CAAC;YACV,IAAI,cAAc,CAAC,IAAI,CAAC,IAAI,IAAI,KAAK,IAAI,EAAE;gBACzC,QAAQ,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;aAC3B;SACF;QAED,gBAAgB;QAChB,kGAAkG;QAClG,4BAA4B;QAC5B,aAAa;QACb,4BAA4B;QAC5B,YAAY;QACZ,qBAAqB;QACrB,6EAA6E;QAC7E,YAAY;QACZ,gBAAgB;QAChB,OAAO;QACP,MAAM;QACN,0CAA0C;QAE1C,OAAO;YACL,GAAG,MAAM;YACT,KAAK,EAAE,QAAQ;SAChB,CAAC;IACJ,CAAC,CAAC;IAGF,gBAAgB;IAEhB,MAAM,mBAAmB,GAAG,aAAa,CAAC;QACxC,WAAW,EAAE,CAAC,0BAA0B,CAAC;KAC1C,CAAoE,CAAC;IACtE,MAAM,qBAAqB,GACzB,mBAAmB,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,0BAA0B,CAAC;QAC5D,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACtD,MAAM,gBAAgB,GAAG,CAAC,qBAAqB,IAAI,kBAAkB,CAAC,qBAAqB,CAAC;QAC1F,CAAC,CAAC,qBAAqB;QACvB,CAAC,CAAC,IAAI,CAAC;IAET,MAAM,cAAc,GAAuB,iBAAiB,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC;IAE9E,MAAM,WAAW,GAAoC,cAAc;QACjE,CAAC,CAAC,CAAC,gBAAgB,EAAE,YAAY,IAAI,EAAE,CAAC;YACtC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,iBAAiB,KAAK,cAAc,CAAC;QACnD,CAAC,CAAC,SAAS,CAAC;IAGd,YAAY;IAEZ,MAAM,CAAE,qBAAqB,EAAE,wBAAwB,CAAE,GAAG,QAAQ,CAAgB,IAAI,CAAC,CAAC;IAE1F,MAAM,eAAe,GAAG,gBAAgB,CAAC,sBAAsB,CAAC,CAAC;IAEjE,OAAO,CACL,IAAC,UAAU,CAAC,QAAQ,IAChB,KAAK,EAAE;YACL,WAAW;YACX,gBAAgB;YAEhB,YAAY;YACZ,WAAW,EAAE,sBAAsB;YAEnC,MAAM,EAAE,QAAQ;YAEhB,oBAAoB;YAEpB,qBAAqB;YACrB,wBAAwB;YAExB,mBAAmB;YACnB,gCAAgC,EAAE,eAAe;YACjD,WAAW,EAAE,WAAW,IAAI,EAAE;YAE9B,aAAa;YACb,qBAAqB;SACtB;QACH,IAAC,4BAA4B,IAAC,eAAe,EAAE,qBAAqB,IACjE,QAAQ,CACoB,CACX,CACvB,CAAC;AACJ,CAAC,CAAA","sourcesContent":["/** @jsx jsx */\n/** @jsxFrag React.Fragment */\n\nimport React, { useContext, useState, useMemo } from 'react';\nimport { jsx, css } from '@emotion/react';\n\nimport { ValueHook } from '@riboseinc/paneron-extension-kit/types';\nimport { DatasetContext } from '@riboseinc/paneron-extension-kit/context';\nimport TabbedWorkspace, { TabbedWorkspaceProps } from '@riboseinc/paneron-extension-kit/widgets/TabbedWorkspace';\nimport {\n  makeContextProvider as makeTabbedWorkspaceContextProvider,\n  TabbedWorkspaceContext,\n} from '@riboseinc/paneron-extension-kit/widgets/TabbedWorkspace/context';\n\nimport {\n  type RegisterItem,\n  type RegisterItemDataHook,\n  type RegisterStakeholder,\n  type RegistryViewProps,\n  isRegisterItem,\n  isRegisterMetadata,\n  isInternalItemReference,\n} from '../types';\n\nimport { REGISTER_METADATA_FILENAME } from '../common';\n\nimport GenericRelatedItemView from './GenericRelatedItemView';\nimport { sidebarConfig, SidebarID, sidebarIDs } from './sidebar';\nimport { BrowserCtx } from './BrowserCtx';\nimport { _getRelatedClass } from './util';\nimport RegisterHome from './detail/RegisterHome';\nimport protocolRegistry, { Protocols, type Protocol } from './protocolRegistry';\nimport {\n  ChangeRequestContext,\n  ChangeRequestContextProvider,\n} from './change-request/ChangeRequestContext';\nimport { itemPathInCR, itemPathToItemRefLike } from './itemPathUtils';\nexport { GenericRelatedItemView };\n\n\nconst TabbedWorkspaceContextProvider = makeTabbedWorkspaceContextProvider<Protocol, SidebarID>(\n  'Browse',\n  sidebarIDs,\n  protocolRegistry);\n\n\nexport const RegistryView: React.FC<RegistryViewProps> = function (props) {\n  return (\n    <TabbedWorkspaceContextProvider stateKey=\"main-registry-view\">\n      <BrowserCtxProvider {...props}>\n        <RegistryWorkspace />\n      </BrowserCtxProvider>\n    </TabbedWorkspaceContextProvider>\n  );\n};\n\n\nconst SIDEBAR_WIDTH_SETTING_NAME = 'registryMainSidebarWidthPixels'\n\n\nconst RegistryWorkspace: React.FC<Record<never, never>> = function () {\n  const { changeRequest: activeChangeRequest } = useContext(ChangeRequestContext);\n  const { spawnTab } = useContext(TabbedWorkspaceContext);\n  const { useSettings, updateSetting } = useContext(DatasetContext);\n\n  const globalMode: TabbedWorkspaceProps<any>['globalMode'] = useMemo(\n    (() => activeChangeRequest\n      ? {\n          content: <>\n            Viewing register as proposed — contents shown may differ from version in effect\n          </>,\n          intent: 'danger',\n          onClick: () => spawnTab(`${Protocols.CHANGE_REQUEST}:/proposals/${activeChangeRequest.id}/main.yaml`),\n        }\n      : undefined),\n    [activeChangeRequest?.id],\n  );\n\n  const { value: { settings } } = useSettings();\n\n  const stored = settings[SIDEBAR_WIDTH_SETTING_NAME]\n  const sidebarWidth: number | undefined = stored && typeof stored === 'number'\n    ? stored as number\n    : undefined;\n\n  return <TabbedWorkspace\n    css={css`flex: 1 1 auto;`}\n    sidebarConfig={sidebarConfig}\n    sidebarIDs={sidebarIDs}\n    newTabPrompt={<RegisterHome />}\n    globalMode={globalMode}\n    sidebarWidth={sidebarWidth}\n    onSidebarResize={(width) => {\n      updateSetting({ key: SIDEBAR_WIDTH_SETTING_NAME, value: width })\n    }}\n  />\n};\n\n\nconst BrowserCtxProvider: React.FC<RegistryViewProps> = function ({\n  itemClassConfiguration,\n  subregisters,\n  keyExpression,\n  defaultSearchCriteria,\n  customViews,\n  children,\n}) {\n\n  const { useObjectData, useRemoteUsername } = useContext(DatasetContext);\n  const { focusedTabURI, spawnTab } = useContext(TabbedWorkspaceContext);\n\n  const selectedItemPath: string | null =\n    focusedTabURI && focusedTabURI.startsWith(`${Protocols.ITEM_DETAILS}:`)\n      ? focusedTabURI.split(':')[1]\n      : null;\n\n  const selectedItemRef: Record<string, string> | null =\n    selectedItemPath\n      ? itemPathToItemRefLike(subregisters !== undefined, selectedItemPath)\n      : null;\n\n  const maybeSelectedRegisterItemData: Record<string, any> | null = useObjectData({\n    objectPaths: selectedItemPath ? [selectedItemPath] : [],\n  }).value.data[selectedItemPath ?? ''];\n\n  const selectedRegisterItem: BrowserCtx['selectedRegisterItem'] =\n    isInternalItemReference(selectedItemRef)\n      ? maybeSelectedRegisterItemData &&\n        isRegisterItem(maybeSelectedRegisterItemData)\n          ? {\n              item: maybeSelectedRegisterItemData,\n              ref: selectedItemRef,\n              itemClass: itemClassConfiguration[selectedItemRef.classID],\n            }\n        : undefined\n      : null;\n\n  // TODO: Confirm that end extensions using RegistryKit can’t just import hooks\n  // from RegistryKit and we really have to pass this to them via context\n  // TODO: Why not use useObjectData directly? Since register item paths\n  // are just object paths. The casting here is optimistic, since an item at given path\n  // may not be a RegisterItem.\n  const useRegisterItemData: RegisterItemDataHook = (opts) => {\n    // Original item path mapped to its potential alternative path in current CR,\n    // if the item is clarified or added in it.\n    // TODO(perf): Access CR data and check whether the item is affected instead of blindly trying CR paths\n    const pathsToRequest: Record<string, string> = {};\n\n    const { changeRequest: activeChangeRequest } = useContext(ChangeRequestContext);\n\n\n    for (const givenItemPath of opts.itemPaths) {\n      pathsToRequest[givenItemPath] = givenItemPath;\n\n      // Don’t use CR alternative path for any path that is already explicitly in-CR.\n      // TODO(perf): move out of the loop what’s possible, use map-reduce maybe too\n      if (!opts.ignoreActiveCR && !givenItemPath.startsWith('/proposals') && activeChangeRequest?.id) {\n        pathsToRequest[itemPathInCR(givenItemPath, activeChangeRequest.id)] = givenItemPath;\n      }\n    }\n\n    const result = useObjectData({\n      objectPaths: Object.keys(pathsToRequest),\n    }) as ValueHook<{ data: Record<string, Record<string, any> | null> }>;\n\n    const itemData: Record<string, RegisterItem<any> | null> = {};\n    for (const [alternativePath, itemPath] of Object.entries(pathsToRequest)) {\n      const data = result.value.data[alternativePath]\n        ?? result.value.data[itemPath]\n        ?? null;\n      if (isRegisterItem(data) || data === null) {\n        itemData[itemPath] = data;\n      }\n    }\n\n    // Convert dates\n    // const parsedData: Record<string, RegisterItem<any> | null> = Object.entries(result.value.data).\n    // map(([ path, data ]) => {\n    //   return {\n    //     [path]: data !== null\n    //       ? {\n    //           ...data,\n    //           dateAccepted: parseISO(data!.dateAccepted as unknown as string),\n    //         }\n    //       : null,\n    //   };\n    // }).\n    // reduce((p, c) => ({ ...p, ...c }), {});\n\n    return {\n      ...result,\n      value: itemData,\n    };\n  };\n\n\n  // Register data\n\n  const registerMetadataReq = useObjectData({\n    objectPaths: [REGISTER_METADATA_FILENAME],\n  }) as ValueHook<{ data: Record<string, Record<string, any> | null> }>;\n  const maybeRegisterMetadata =\n    registerMetadataReq.value.data?.[REGISTER_METADATA_FILENAME] ??\n    (registerMetadataReq.isUpdating ? undefined : null);\n  const registerMetadata = !maybeRegisterMetadata || isRegisterMetadata(maybeRegisterMetadata)\n    ? maybeRegisterMetadata\n    : null;\n\n  const remoteUsername: string | undefined = useRemoteUsername().value.username;\n\n  const stakeholder: RegisterStakeholder | undefined = remoteUsername\n    ? (registerMetadata?.stakeholders ?? []).\n      find(s => s.gitServerUsername === remoteUsername)\n    : undefined;\n\n\n  // Active CR\n\n  const [ activeChangeRequestID, setActiveChangeRequestID ] = useState<string | null>(null);\n\n  const getRelatedClass = _getRelatedClass(itemClassConfiguration);\n\n  return (\n    <BrowserCtx.Provider\n        value={{\n          stakeholder,\n          registerMetadata,\n\n          subregisters,\n          itemClasses: itemClassConfiguration,\n\n          jumpTo: spawnTab,\n\n          selectedRegisterItem,\n\n          activeChangeRequestID,\n          setActiveChangeRequestID,\n\n          useRegisterItemData,\n          getRelatedItemClassConfiguration: getRelatedClass,\n          customViews: customViews ?? [],\n\n          keyExpression,\n          defaultSearchCriteria,\n        }}>\n      <ChangeRequestContextProvider changeRequestID={activeChangeRequestID}>\n        {children}\n      </ChangeRequestContextProvider>\n    </BrowserCtx.Provider>\n  );\n}\n"]}

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2020 Ribose
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/README.adoc

@@ -1,35 +0,0 @@
-= Paneron registry kit
-
-A common case of structured data is _registers_, as defined by ISO 19135-1 standard.
-
-Registry kit defines a model for expressing ISO 19135-1 register data as a collection of YAML files,
-and simplifies creating Paneron extensions that work with that data.
-
-== Extension development
-
-See ExtensionKit’s documentation for general extension development notes.
-
-== Extensions for editing registry data
-
-An extension is essentially a React component that is given as props
-some functions that simplify interaction with underlying data repository.
-
-In case of registry type extensions, instead of writing your own repository view component from scratch,
-with the registry kit you can import its registry view component
-and pass it a configuration of register item classes that your register supports
-alongside props passed by Paneron to your extension.
-
-The configuration of register item classes includes the following:
-
-- General item metadata
--- Machine-readable class identifier, which will also serve as the name of the directory item contents reside in
--- Human-readable item class title, as well as alternative names (if any)
--- Item class description, as plain string
-- Default values for register item data
-- React components that serve as views of a given register item
--- Displaying item data
--- Editing item data
--- Displaying item in list
-
-For an example of a Paneron extension built with registry kit, see the
-link:https://github.com/paneron/extension-geodetic-registry/[ISO/TC 211 Geodetic registry extension].

package/compiled/common.js

@@ -1,2 +0,0 @@
-export const REGISTER_METADATA_FILENAME = '/register.yaml';
-//# sourceMappingURL=common.js.map

package/compiled/index.js

@@ -1,21 +0,0 @@
-import React from 'react';
-import { makeExtension } from '@riboseinc/paneron-extension-kit';
-import { RegistryView } from './views';
-export const makeRegistryExtension = function (opts) {
-    const { name } = opts;
-    const mainView = async function () {
-        return {
-            default: () => {
-                return (React.createElement(RegistryView, { itemClassConfiguration: opts.itemClassConfiguration, subregisters: opts.subregisters }));
-            },
-        };
-    };
-    return makeExtension({
-        mainView,
-        name,
-        requiredHostAppVersion: '2.0.0',
-        datasetMigrations: {},
-        datasetInitializer: () => import('./migrations/initial'),
-    });
-};
-//# sourceMappingURL=index.js.map

package/compiled/migrations/initial.js

@@ -1,8 +0,0 @@
-const initializeDataset = async (opts) => {
-    return {
-        versionAfter: '1.0.0-alpha18',
-        bufferChangeset: {},
-    };
-};
-export default initializeDataset;
-//# sourceMappingURL=initial.js.map

package/compiled/types/cr.js

@@ -1,131 +0,0 @@
-/** Change request types, states and state transitions. */
-export function isSubmittedBy(stakeholder, cr) {
-    return (
-    //isSubmitter(stakeholder) &&
-    stakeholder.gitServerUsername === cr.submittingStakeholderGitServerUsername);
-}
-// =====================
-// Change request states
-// =====================
-/** Used in place of enum for convenience. */
-export const State = {
-    DRAFT: 'draft',
-    PROPOSED: 'proposed',
-    SUBMITTED_FOR_CONTROL_BODY_REVIEW: 'pending-control-body-review',
-    RETURNED_FOR_CLARIFICATION: 'returned-for-clarification',
-    WITHDRAWN: 'withdrawn',
-    ACCEPTED: 'accepted',
-    REJECTED: 'rejected',
-    APPEALED: 'rejection-appealed-to-owner',
-    ACCEPTED_ON_APPEAL: 'accepted-on-appeal',
-    REJECTION_UPHELD_ON_APPEAL: 'rejection-upheld-on-appeal',
-    APPEAL_WITHDRAWN: 'appeal-withdrawn',
-};
-export function isState(val) {
-    return Object.values(State).indexOf(val) >= 0;
-}
-/** A subset of `State` that represents editable states. */
-export const EditableState = [
-    State.DRAFT,
-    State.RETURNED_FOR_CLARIFICATION,
-];
-export function isEditableState(state) {
-    return EditableState.indexOf(state) >= 0;
-}
-export function isCreatedBy(stakeholder, cr) {
-    return stakeholder.gitServerUsername === cr.submittingStakeholderGitServerUsername;
-}
-export function canBeEditedBy(stakeholder, cr) {
-    return isCreatedBy(stakeholder, cr) && isEditableState(cr.state);
-}
-export function isDrafted(cr) {
-    return isInState(cr, State.DRAFT);
-}
-export function isProposed(cr) {
-    return isInState(cr, State.PROPOSED);
-}
-export function isWithdrawn(cr) {
-    return isInState(cr, State.WITHDRAWN);
-}
-export function hadBeenProposed(cr) {
-    return cr && cr.hasOwnProperty('timeProposed') && !!cr.timeProposed;
-}
-export function isDisposed(cr) {
-    return cr && cr.hasOwnProperty('timeDisposed') && !!cr.timeDisposed;
-    //return [
-    //  State.WITHDRAWN,
-    //  State.ACCEPTED,
-    //  State.REJECTED,
-    //  State.REJECTION_UPHELD_ON_APPEAL,
-    //  State.ACCEPTED_ON_APPEAL,
-    //].some(s => cr.state === s);
-}
-export function isAccepted(cr) {
-    return isInState(cr, State.ACCEPTED);
-}
-export function isAppealed(cr) {
-    return isInState(cr, State.APPEALED);
-}
-export function isAcceptedOnAppeal(cr) {
-    return isInState(cr, State.ACCEPTED_ON_APPEAL);
-}
-export function hasSubmitterInput(val) {
-    return val.hasOwnProperty('justification') && typeof val.justification === 'string';
-}
-export function hasRegisterManagerInput(val) {
-    return val.hasOwnProperty('registerManagerNotes') && typeof val.registerManagerNotes === 'string';
-}
-export function hasControlBodyInput(val) {
-    return (val.hasOwnProperty('controlBodyNotes') && typeof val.controlBodyNotes === 'string' &&
-        val.hasOwnProperty('controlBodyDecisionEvent') && typeof val.controlBodyDecisionEvent === 'string');
-}
-export function hasAppealRequest(val) {
-    return val.hasOwnProperty('appealReason') && typeof val.appealReason === 'string';
-}
-export function hasRegisterOwnerInput(val) {
-    return val.hasOwnProperty('registerOwnerNotes') && typeof val.registerOwnerNotes === 'string';
-}
-/**
- * CR type guard helper.
- * Normally you would not use it directly and instead use
- * more specific is[Type]() helper from this module.
- *
- * Checks CR type using the `state` property.
- * Does not validate other properties.
- *
- * Usage:
- *
- * @example
- * ```ts
- * let someCR;
- * if (isInState<Drafted>(someCR, State.DRAFT)) {
- *   // Can assume someCR is Drafted
- * }
- * ```
- *
- * It’ll try to tell you if you mismatch those.
- *
- * @example
- * Will not compile:
- * ```ts
- * let someCR;
- * if (isInState<Drafted>(someCR, State.PROPOSED)) {
- *   // Compile error
- *   // because State.PROPOSED is not a possible value of Drafted["state"]
- * }
- * ```
- *
- * @example
- * Incorrect usage (do not do this):
- * ```ts
- * let someCR;
- * if (isInState(someCR, State.DRAFT)) {
- *   // Can NOT assume someCR is Drafted
- *   // The compiler must know the expected concrete CR type
- * }
- * ```
- */
-function isInState(cr, s) {
-    return cr.state === s;
-}
-//# sourceMappingURL=cr.js.map

package/compiled/types/index.js

@@ -1,8 +0,0 @@
-export * from './views';
-export * from './register';
-export * from './registry';
-export * from './item';
-export * from './stakeholder';
-export * from './proposal';
-export * from './util';
-//# sourceMappingURL=index.js.map

package/compiled/types/item.js

@@ -1,22 +0,0 @@
-const ITEM_STATUSES = [
-    'submitted',
-    'valid',
-    'superseded',
-    'retired',
-    'invalid',
-];
-export function isInternalItemReference(val) {
-    return (val &&
-        val.hasOwnProperty('itemID') &&
-        val.hasOwnProperty('classID') &&
-        typeof val['itemID'] == 'string' &&
-        typeof val['classID'] == 'string');
-}
-export function isRegisterItem(val) {
-    return (val &&
-        val.hasOwnProperty('id') &&
-        val.hasOwnProperty('data') &&
-        val.hasOwnProperty('status') &&
-        ITEM_STATUSES.indexOf(val.status) >= 0);
-}
-//# sourceMappingURL=item.js.map

package/compiled/types/proposal.js

@@ -1,21 +0,0 @@
-export const DECISION_STATUSES = [
-    'pending',
-    'tentative',
-    'final',
-];
-export const DISPOSITION_OPTIONS = [
-    'withdrawn',
-    'accepted',
-    'notAccepted',
-];
-export const PROPOSAL_TYPES = [
-    'addition',
-    'clarification',
-    'amendment',
-];
-export const AMENDMENT_TYPES = [
-    'supersession',
-    'retirement',
-    'invalidation',
-];
-//# sourceMappingURL=proposal.js.map

package/compiled/types/register.js

@@ -1,25 +0,0 @@
-import { isRegisterStakeholder } from './stakeholder';
-export function isRegisterMetadata(val) {
-    return (val &&
-        // val.hasOwnProperty('id') &&
-        //typeof val.id === 'string' &&
-        val.hasOwnProperty('name') &&
-        typeof val.name === 'string' &&
-        //val.hasOwnProperty('contentSummary') &&
-        //typeof val.contentSummary === 'string' &&
-        val.hasOwnProperty('stakeholders') &&
-        val.stakeholders.length > 0 &&
-        // Stakeholders must be right
-        val.stakeholders.every(isRegisterStakeholder) &&
-        // Must have at least an owner
-        val.stakeholders.some((s) => s.role === 'owner') &&
-        // Must have a valid version (or no version? hmm)
-        (val.version === undefined || isVersion(val.version)));
-}
-export function isVersion(val) {
-    return (val &&
-        val.hasOwnProperty('id') &&
-        val.hasOwnProperty('timestamp') &&
-        typeof val.id === 'string');
-}
-//# sourceMappingURL=register.js.map

package/compiled/types/registry.js

@@ -1,10 +0,0 @@
-// TODO: What is below for?
-export const KNOWN_AUTHORITATIVE_REGISTRIES = [
-    {
-        id: '9D546C5C-8FA4-496D-A721-6DA72E35F4A9',
-        name: 'ICS codes',
-        publicURL: 'https://ics.demo.paneron.org/',
-        repoURL: 'https://github.com/paneron/ics-codes-registry',
-    },
-];
-//# sourceMappingURL=registry.js.map

package/compiled/types/stakeholder.js

@@ -1,34 +0,0 @@
-// Stakeholders
-/** Possible roles of a register stakeholder. */
-export const StakeholderRole = {
-    Owner: 'owner',
-    ControlBody: 'control-body',
-    Manager: 'manager',
-    Submitter: 'submitter',
-};
-export const STAKEHOLDER_ROLES = Object.values(StakeholderRole);
-export function isStakeholderRole(val) {
-    return STAKEHOLDER_ROLES.indexOf(val) >= 0;
-}
-export function isOwner(val) {
-    return val.role === StakeholderRole.Owner;
-}
-export function isControlBody(val) {
-    return val.role === StakeholderRole.ControlBody;
-}
-export function isManager(val) {
-    return val.role === StakeholderRole.Manager;
-}
-export function isSubmitter(val) {
-    return val.role === StakeholderRole.Submitter;
-}
-export function isIndividualParty(val) {
-    return typeof val.name === 'string' && !val.hasOwnProperty('positionName');
-}
-export function isRegisterStakeholder(val) {
-    return (val &&
-        val.hasOwnProperty('role') &&
-        isStakeholderRole(val.role) &&
-        val.hasOwnProperty('name'));
-}
-//# sourceMappingURL=stakeholder.js.map

package/compiled/types/util.js

@@ -1,3 +0,0 @@
-// Utilities
-export {};
-//# sourceMappingURL=util.js.map

package/compiled/types/views.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=views.js.map

package/compiled/views/AnnotatedChange.js

@@ -1,57 +0,0 @@
-/** @jsx jsx */
-/** @jsxFrag React.Fragment */
-import { jsx } from '@emotion/react';
-import React, { useRef, useEffect } from 'react';
-import { Colors } from '@blueprintjs/core';
-import { annotate } from 'rough-notation';
-function annotateChange(type, wrappingEl, childIsBoxy) {
-    const highlightConfig = {
-        type: 'highlight',
-        animate: false,
-        color: Colors.GOLD5,
-        iterations: 3,
-    };
-    let changeConfig;
-    if (type === 'added') {
-        changeConfig = {
-            type: childIsBoxy ? 'bracket' : 'underline',
-            iterations: 1,
-            color: Colors.BLUE4,
-        };
-    }
-    else {
-        changeConfig = {
-            type: 'crossed-off',
-            iterations: 1,
-            color: Colors.RED3,
-        };
-    }
-    const highlightAnnotation = annotate(wrappingEl, highlightConfig);
-    const changeAnnotation = annotate(wrappingEl, changeConfig);
-    return [highlightAnnotation, changeAnnotation];
-}
-const AnnotatedChange = ({ type, children }) => {
-    const elRef = useRef(null);
-    const firstChild = React.Children.toArray(children)[0];
-    const childType = React.isValidElement(firstChild) ? firstChild.type : undefined;
-    const childIsBoxy = childType === 'div';
-    // Could it bring more accuracy to block/inline detection?
-    //const childCount = React.isValidElement(firstChild) ? React.Children.count(firstChild.props.children) : undefined;
-    useEffect(() => {
-        if (elRef.current) {
-            const annotations = annotateChange(type, elRef.current, childIsBoxy);
-            for (const a of annotations) {
-                a.show();
-            }
-            return function cleanup() {
-                for (const a of annotations) {
-                    a.remove();
-                }
-            };
-        }
-        return;
-    }, [elRef.current]);
-    return (jsx("mark", { style: { display: childIsBoxy ? 'block' : 'inline', background: 'none' }, ref: elRef, title: `(${type} in this proposal)` }, children));
-};
-export default AnnotatedChange;
-//# sourceMappingURL=AnnotatedChange.js.map

package/compiled/views/BrowserCtx.js

@@ -1,19 +0,0 @@
-/** @jsx jsx */
-import { jsx } from '@emotion/react';
-import { createContext } from 'react';
-export const BrowserCtx = createContext({
-    itemClasses: {},
-    customViews: [],
-    // getRegisterItemData: async () => ({}),
-    selectedRegisterItem: null,
-    registerMetadata: undefined,
-    useRegisterItemData: () => ({
-        value: {},
-        _reqCounter: -1,
-        errors: [],
-        isUpdating: true,
-        refresh: () => void 0,
-    }),
-    getRelatedItemClassConfiguration: () => ({ title: 'N/A', itemView: () => jsx("span", null, "Loading\u2026") }),
-});
-//# sourceMappingURL=BrowserCtx.js.map

package/compiled/views/FilterCriteria/CRITERIA_CONFIGURATION.js

@@ -1,110 +0,0 @@
-/** @jsx jsx */
-/** @jsxFrag React.Fragment */
-import { jsx } from '@emotion/react';
-import { Select, TextInput } from '@riboseinc/paneron-extension-kit/widgets/Sidebar/PropertyView';
-import { SUBREGISTER_PATH_PREFIX } from './index';
-export const ITEM_CLASS = {
-    label: "item class is",
-    icon: 'cube',
-    toQuery: ({ classID }, { subregisters }) => `objPath.indexOf("/${classID}/") >= ${subregisters ? SUBREGISTER_PATH_PREFIX.length - 1 : 0}`,
-    fromQuery: (query) => ({
-        classID: query.split('/')[1],
-    }),
-    toSummary: ({ classID }, { itemClasses }) => {
-        if (classID) {
-            return itemClasses[classID]?.meta.title ?? classID;
-        }
-        else {
-            return "(N/A)";
-        }
-    },
-    widget: ({ data, onChange, itemClasses, availableClassIDs, className, style }) => {
-        const itemClassChoices = [
-            ...Object.entries(itemClasses).
-                filter(([clsID,]) => availableClassIDs.indexOf(clsID) >= 0).
-                map(([classID, classData]) => {
-                return { value: classID, label: classData?.meta?.title ?? "Unknown class" };
-            }),
-            { value: '', label: "(not selected)" },
-        ];
-        return (jsx(Select, { className: className, style: style, fill: true, options: itemClassChoices, value: data.classID ?? '', disabled: !onChange, onChange: onChange
-                ? (evt) => onChange({ classID: evt.currentTarget.value })
-                : undefined }));
-    },
-};
-export const SUBREGISTER = {
-    label: "is in subregister",
-    icon: 'folder-open',
-    isEnabled: ({ subregisters }) => subregisters !== undefined,
-    toQuery: ({ subregisterID }, { subregisters }) => subregisters !== undefined && subregisterID?.trim()
-        ? `objPath.indexOf("/subregisters/${subregisterID}/") === 0`
-        : 'true',
-    fromQuery: (query) => ({
-        subregisterID: query.split('/')[2],
-    }),
-    toSummary: ({ subregisterID }, { subregisters }) => {
-        if (subregisters && subregisterID) {
-            return subregisters[subregisterID].title;
-        }
-        else {
-            return "(N/A)";
-        }
-    },
-    widget: ({ data, onChange, subregisters, className, style }) => {
-        const subregisterChoices = [
-            ...Object.entries(subregisters ?? {}).
-                map(([subregisterID, subregisterInfo]) => {
-                return { value: subregisterID, label: subregisterInfo.title };
-            }),
-            { value: '', label: "(not selected)" },
-        ];
-        return (jsx(Select, { className: className, style: style, fill: true, options: subregisterChoices, value: data.subregisterID ?? '', disabled: !onChange, onChange: onChange
-                ? (evt) => onChange({ subregisterID: evt.currentTarget.value })
-                : undefined }));
-    },
-};
-export const RAW_SUBSTRING = {
-    label: "raw data contains",
-    icon: 'search-text',
-    toQuery: ({ substring }) => substring?.trim()
-        ? `JSON.stringify(obj.data ?? {}).toLowerCase().indexOf("${substring.toLowerCase().replace(/"/g, "\\\"")}") >= 0`
-        : `true`,
-    fromQuery: (query) => ({
-        substring: (query.
-            split('JSON.stringify(obj.data ?? {}).toLowerCase().indexOf("')[1]?.
-            split('") >= 0')[0] ?? '').replace(/\\"/g, '"'),
-    }),
-    toSummary: ({ substring }) => {
-        if (substring) {
-            return substring.length > 20 ? `${substring.slice(0, 20)}…` : substring;
-        }
-        else {
-            return 'N/A';
-        }
-    },
-    widget: ({ data, onChange, className, style }) => {
-        return jsx(TextInput, { className: className, style: style, value: data.substring ?? '', onChange: onChange ? substring => onChange({ substring }) : undefined });
-    },
-};
-export const CUSTOM_CONDITION = {
-    label: "condition is met",
-    icon: 'code',
-    toQuery: ({ customExpression }) => customExpression ?? 'true',
-    fromQuery: (query) => ({
-        customExpression: query,
-    }),
-    toSummary: () => "(custom test expr.)",
-    widget: ({ data, onChange, className }) => {
-        return (jsx(TextInput, { className: className, value: data.customExpression ?? 'true', placeholder: "Enter a valid query expression\u2026", onChange: onChange
-                ? (customExpression) => onChange({ customExpression })
-                : undefined }));
-    },
-};
-export const CRITERIA_CONFIGURATION = {
-    'item-class': ITEM_CLASS,
-    'subregister': SUBREGISTER,
-    'raw-substring': RAW_SUBSTRING,
-    'custom': CUSTOM_CONDITION,
-};
-export default CRITERIA_CONFIGURATION;
-//# sourceMappingURL=CRITERIA_CONFIGURATION.js.map