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

package/dist/types/stakeholder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stakeholder.js","sourceRoot":"","sources":["../../src/types/stakeholder.ts"],"names":[],"mappings":"AAAA,eAAe;AAEf,gDAAgD;AAChD,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,KAAK,EAAE,OAAO;IACd,WAAW,EAAE,cAAc;IAC3B,OAAO,EAAE,SAAS;IAClB,SAAS,EAAE,WAAW;CACd,CAAC;AAIX,MAAM,CAAC,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,CAAC,eAAe,CAA0B,CAAC;AAEzF,MAAM,UAAU,iBAAiB,CAAC,GAAW;IAC3C,OAAO,iBAAiB,CAAC,OAAO,CAAC,GAA0B,CAAC,IAAI,CAAC,CAAC;AACpE,CAAC;AAgBD,MAAM,UAAU,OAAO,CAAC,GAAwB;IAC9C,OAAO,GAAG,CAAC,IAAI,KAAK,eAAe,CAAC,KAAK,CAAC;AAC5C,CAAC;AAKD,MAAM,UAAU,aAAa,CAAC,GAAwB;IACpD,OAAO,GAAG,CAAC,IAAI,KAAK,eAAe,CAAC,WAAW,CAAC;AAClD,CAAC;AAKD,MAAM,UAAU,SAAS,CAAC,GAAwB;IAChD,OAAO,GAAG,CAAC,IAAI,KAAK,eAAe,CAAC,OAAO,CAAC;AAC9C,CAAC;AAKD,MAAM,UAAU,WAAW,CAAC,GAAwB;IAClD,OAAO,GAAG,CAAC,IAAI,KAAK,eAAe,CAAC,SAAS,CAAC;AAChD,CAAC;AA+BD,MAAM,UAAU,iBAAiB,CAAC,GAAQ;IACxC,OAAO,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC;AAC7E,CAAC;AAID,MAAM,UAAU,qBAAqB,CAAC,GAAQ;IAC5C,OAAO,CACL,GAAG;QACH,GAAG,CAAC,cAAc,CAAC,MAAM,CAAC;QAC1B,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC;QAC3B,GAAG,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC;AAChC,CAAC","sourcesContent":["// Stakeholders\n\n/** Possible roles of a register stakeholder. */\nexport const StakeholderRole = {\n  Owner: 'owner',\n  ControlBody: 'control-body',\n  Manager: 'manager',\n  Submitter: 'submitter',\n} as const;\n\ntype StakeholderRoleType = typeof StakeholderRole[keyof typeof StakeholderRole];\n\nexport const STAKEHOLDER_ROLES = Object.values(StakeholderRole) as StakeholderRoleType[];\n\nexport function isStakeholderRole(val: string): val is StakeholderRoleType {\n  return STAKEHOLDER_ROLES.indexOf(val as StakeholderRoleType) >= 0;\n}\n\n/** “Abstract” register stakeholder type. */\ninterface _RegisterStakeholder {\n  role: StakeholderRoleType\n  name: string\n\n  // TODO: Make git server username per-party, instead of stakeholder-global?\n  gitServerUsername?: string\n\n  parties: Party[]\n}\n\ninterface Owner extends _RegisterStakeholder {\n  role: typeof StakeholderRole.Owner\n}\nexport function isOwner(val: RegisterStakeholder): val is Owner {\n  return val.role === StakeholderRole.Owner;\n}\n\ninterface ControlBody extends _RegisterStakeholder {\n  role: typeof StakeholderRole.ControlBody\n}\nexport function isControlBody(val: RegisterStakeholder): val is ControlBody {\n  return val.role === StakeholderRole.ControlBody;\n}\n\ninterface Manager extends _RegisterStakeholder {\n  role: typeof StakeholderRole.Manager\n}\nexport function isManager(val: RegisterStakeholder): val is Manager {\n  return val.role === StakeholderRole.Manager;\n}\n\ninterface Submitter extends _RegisterStakeholder {\n  role: typeof StakeholderRole.Submitter\n}\nexport function isSubmitter(val: RegisterStakeholder): val is Submitter {\n  return val.role === StakeholderRole.Submitter;\n}\n\n//interface NonEditingStakeholder extends _RegisterStakeholder {\n//  role: 'owner'\n//}\n//export interface EditingStakeholder extends _RegisterStakeholder {\n//  role: 'manager' | 'submitter'\n//}\n\ninterface Role {\n  positionName: string\n  name?: never\n  organization: Organization\n}\n\ninterface Individual {\n  name: string\n  positionName?: never\n  organization?: Organization\n}\n\n// Either logoURL or name or both must be present on an org here\ntype Organization<T = {\n  logoURL: string[];\n  name: string;\n}> = Partial<T> & Pick<T, keyof T>\n\ntype Party = (Individual | Role | Organization) & {\n  contacts: { label: string, value: string, notes?: string }[]\n}\n\nexport function isIndividualParty(val: any): val is Individual {\n  return typeof val.name === 'string' && !val.hasOwnProperty('positionName');\n}\n\nexport type RegisterStakeholder = Owner | ControlBody | Manager | Submitter\n\nexport function isRegisterStakeholder(val: any): val is RegisterStakeholder {\n  return (\n    val &&\n    val.hasOwnProperty('role') &&\n    isStakeholderRole(val.role) &&\n    val.hasOwnProperty('name'));\n}\n"]}

package/dist/types/util.d.ts

@@ -0,0 +1,21 @@
+export interface Locale {
+    name: string;
+    country: string;
+    languageCode: string;
+    characterEncoding: 'utf-8';
+}
+export interface Citation {
+    title: string;
+    seriesIssueID: string | null;
+    seriesName: string | null;
+    seriesPage: string | null;
+    edition: string | null;
+    editionDate: Date | null;
+    otherDetails: string;
+    isbn: string | null;
+    issn: string | null;
+}
+export interface LocalizedAlternative<T> {
+    alternative: T;
+    locale: Locale;
+}

package/dist/types/util.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/dist/types/util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../../src/types/util.ts"],"names":[],"mappings":"AAAA,YAAY","sourcesContent":["// Utilities\n\nexport interface Locale {\n  name: string\n  country: string\n  languageCode: string // ISO 639-2\n  characterEncoding: 'utf-8' // TODO: Support more encodings\n  // TODO: citation?: CI_Citation\n}\n\n\nexport interface Citation {\n  title: string\n\n  seriesIssueID: string | null\n  seriesName: string | null\n  seriesPage: string | null\n\n  edition: string | null\n  editionDate: Date | null\n\n  otherDetails: string\n\n  isbn: string | null\n  issn: string | null\n\n  //alternateTitles: string[]\n  //publicationDate: Date\n}\n\n\nexport interface LocalizedAlternative<T> {\n  alternative: T\n  locale: Locale\n}\n"]}

package/dist/types/views.d.ts

@@ -0,0 +1,157 @@
+import type React from 'react';
+import type { ButtonProps, MenuItemProps } from '@blueprintjs/core';
+import type { ObjectDatasetRequest, ObjectDatasetResponse, ValueHook } from '@riboseinc/paneron-extension-kit/types';
+import type { InternalItemReference, Payload, RegisterItem, RegisterItemClass } from './item';
+import type { CriteriaGroup } from '../views/FilterCriteria/models';
+/**
+ * Mostly a wrapper around useObjectData, but coerces value type
+ * (TODO: validate!) and takes into account change request from any
+ * wrapping change request context. If a change request is present,
+ * will substitute proposed item data unless `ignoreActiveCR` is set.
+ *
+ * NOTE: Despite the name, returns the entire RegisterItem,
+ * not just the `.data` property with item payload.
+ */
+export declare type RegisterItemDataHook<P extends Payload = Payload> = (opts: {
+    itemPaths: string[];
+    ignoreActiveCR?: true;
+}) => ValueHook<Record<string, RegisterItem<P> | null>>;
+export interface RegisterConfiguration<Items extends ItemClassConfigurationSet = Record<string, ItemClassConfiguration<any>>> {
+    /**
+     * Configuration for all items in this register.
+     * This includes items in subregisters.
+     */
+    itemClassConfiguration: Items;
+    /**
+     * Default expression used to sort an item.
+     * Passed to useFilteredIndex().
+     */
+    keyExpression?: string;
+    /** Subregister information. */
+    subregisters?: Subregisters<Items>;
+}
+export declare type Subregisters<Items extends ItemClassConfigurationSet = Record<string, ItemClassConfiguration<any>>> = {
+    [subregisterID: string]: {
+        title: string;
+        /** Names of item classes that go in this subregister. */
+        itemClasses: (keyof Items)[];
+    };
+};
+export declare type ItemClassConfigurationSet = {
+    [itemClassID: string]: ItemClassConfiguration<any>;
+};
+export interface ExportFormatConfiguration<P extends Payload> {
+    /** The name of the export format. */
+    label: string;
+    /**
+     * The function that takes register item data and some helper functions
+     * and is expected to return a blob.
+     */
+    exportItem: (itemData: RegisterItem<P>, opts: {
+        getObjectData: (opts: ObjectDatasetRequest) => Promise<ObjectDatasetResponse>;
+        getBlob: (val: string) => Promise<Uint8Array>;
+    }) => Promise<Uint8Array>;
+}
+export interface ItemClassConfiguration<P extends Payload> {
+    meta: RegisterItemClass;
+    itemCanBeSuperseded?: boolean;
+    defaults?: RegistryItemPayloadDefaults<P>;
+    validatePayload?: (item: P) => Promise<boolean>;
+    sanitizePayload?: (item: P) => Promise<P>;
+    itemSorter?: (a: P, b: P) => number;
+    /**
+     * Expression used to sort an item of this class.
+     * Passed to useFilteredIndex().
+     */
+    keyExpression?: string;
+    exportFormats?: ExportFormatConfiguration<P>[];
+    views: {
+        listItemView: ItemListView<P>;
+        editView: ItemEditView<P>;
+        detailView?: ItemDetailView<P>;
+    };
+}
+export interface RegistryViewProps<Items extends ItemClassConfigurationSet = Record<string, ItemClassConfiguration<any>>> extends RegisterConfiguration<Items> {
+    /**
+     * When search is initially opened, have this query pre-defined.
+     * Not very useful since there are also preset searches in the browser now.
+     */
+    defaultSearchCriteria?: CriteriaGroup;
+    customViews?: CustomViewConfiguration[];
+}
+export interface CustomViewConfiguration {
+    id: string;
+    label: string;
+    description: string;
+    view: React.FC<{
+        /** View can support optional path for custom state/inner navigation (provisional). */
+        path: string;
+    }>;
+    icon?: JSX.Element;
+}
+export interface ItemAction {
+    getButtonProps: (item: RegisterItem<any>, itemClass: ItemClassConfiguration<any>, subregisterID?: string) => ButtonProps | MenuItemProps;
+}
+export declare type RegistryView = React.FC<RegistryViewProps>;
+declare type RegistryItemPayloadDefaults<P extends Payload> = Partial<Omit<P, 'id'>>;
+/**
+ * A small part of item class configuration,
+ * useful e.g. for formatting related items.
+ */
+export declare type RelatedItemClassConfiguration = {
+    title: string;
+    itemView: ItemListView<any>;
+};
+export interface RegistryItemViewProps<P extends Payload> {
+    /**
+     * Item reference.
+     * Glossarist, for example, uses it to determine language subregister and set appropriate writing direction.
+     */
+    itemRef: Omit<InternalItemReference, 'itemID'> & {
+        itemID?: InternalItemReference['itemID'];
+    };
+    /** Item data (payload). */
+    itemData: P;
+    className?: string;
+    /** Deprecated */
+    useRegisterItemData?: any;
+    /** Deprecated */
+    getRelatedItemClassConfiguration?: any;
+}
+export interface GenericRelatedItemViewProps {
+    /** Currently selected item’s ref. */
+    itemRef?: InternalItemReference;
+    /**
+     * By default, clicking the item will spawn a tab via TabbedWorkspace context.
+     * This prop can customize that behavior.
+     */
+    onJump?: () => void;
+    className?: string;
+    availableClassIDs?: string[];
+    availableSubregisterIDs?: string[];
+    itemSorter?: ItemClassConfiguration<any>["itemSorter"];
+    /** Called to auto-create an item (can’t auto-create if not provided) */
+    onCreateNew?: () => Promise<InternalItemReference>;
+    /** Called when current item is cleared (can’t clear if not provided) */
+    onClear?: () => void;
+    /** Called when a new item is selected (can’t change if not provided) */
+    onChange?: (newRef: InternalItemReference) => void;
+    /** Deprecated */
+    useRegisterItemData?: any;
+    /** Deprecated */
+    getRelatedItemClassConfiguration?: any;
+}
+export declare type ItemEditView<P extends Payload> = React.FC<RegistryItemViewProps<P> & {
+    onChange?: (newData: P) => void;
+    onCreateRelatedItem?: (classID: string, subregisterID?: string) => Promise<InternalItemReference>;
+}>;
+export interface ItemDetailViewProps<P extends Payload> extends RegistryItemViewProps<P> {
+}
+export declare type ItemDetailView<P extends Payload> = React.FC<ItemDetailViewProps<P>>;
+export interface ItemListViewProps<P extends Payload> extends RegistryItemViewProps<P> {
+}
+export declare type ItemListView<P extends Payload> = React.FC<ItemListViewProps<P>>;
+export declare type LazyItemView = React.FC<{
+    itemID: string;
+}>;
+export {};

package/dist/types/views.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/dist/types/views.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"views.js","sourceRoot":"","sources":["../../src/types/views.ts"],"names":[],"mappings":"","sourcesContent":["import type React from 'react';\nimport type { ButtonProps, MenuItemProps } from '@blueprintjs/core';\nimport type { ObjectDatasetRequest, ObjectDatasetResponse, ValueHook } from '@riboseinc/paneron-extension-kit/types';\nimport type { InternalItemReference, Payload, RegisterItem, RegisterItemClass } from './item';\nimport type { CriteriaGroup } from '../views/FilterCriteria/models';\n\n\n// Hooks\n\n/**\n * Mostly a wrapper around useObjectData, but coerces value type\n * (TODO: validate!) and takes into account change request from any\n * wrapping change request context. If a change request is present,\n * will substitute proposed item data unless `ignoreActiveCR` is set.\n *\n * NOTE: Despite the name, returns the entire RegisterItem,\n * not just the `.data` property with item payload.\n */\nexport type RegisterItemDataHook<P extends Payload = Payload> =\n  (opts: { itemPaths: string[], ignoreActiveCR?: true }) => ValueHook<Record<string, RegisterItem<P> | null>>;\n\n\n// Extension configuration\n\n// TODO: Obsolete?\n// export interface ExtensionContext {\n//   getRelatedItemClassConfiguration: (classID: string) => RelatedItemClassConfiguration\n//   useRegisterItemData: RegisterItemDataHook\n//   onJump?: () => void\n// }\n\nexport interface RegisterConfiguration\n<Items extends ItemClassConfigurationSet = Record<string, ItemClassConfiguration<any>>> {\n  /**\n   * Configuration for all items in this register.\n   * This includes items in subregisters.\n   */\n  itemClassConfiguration: Items\n\n  /**\n   * Default expression used to sort an item.\n   * Passed to useFilteredIndex().\n   */\n  keyExpression?: string\n\n  /** Subregister information. */\n  subregisters?: Subregisters<Items>\n}\n\nexport type Subregisters\n<Items extends ItemClassConfigurationSet = Record<string, ItemClassConfiguration<any>>> = {\n  [subregisterID: string]: {\n    title: string\n\n    /** Names of item classes that go in this subregister. */\n    itemClasses: (keyof Items)[]\n  }\n};\n\nexport type ItemClassConfigurationSet = {\n  [itemClassID: string]: ItemClassConfiguration<any>\n};\n\n\n\nexport interface ExportFormatConfiguration<P extends Payload> {\n  /** The name of the export format. */\n  label: string\n\n  /**\n   * The function that takes register item data and some helper functions\n   * and is expected to return a blob.\n   */\n  exportItem: (\n    itemData: RegisterItem<P>,\n    opts: {\n      getObjectData: (opts: ObjectDatasetRequest) => Promise<ObjectDatasetResponse>,\n      getBlob: (val: string) => Promise<Uint8Array>,\n    },\n  ) => Promise<Uint8Array>\n}\n\n\nexport interface ItemClassConfiguration<P extends Payload/*, F extends Field*/> {\n  meta: RegisterItemClass\n\n  itemCanBeSuperseded?: boolean\n  // If false, items of this class cannot be superseded, only retired.\n  // Default is true.\n\n  defaults?: RegistryItemPayloadDefaults<P>\n  // Used to pre-populate item data e.g. when a new item is created.\n\n  validatePayload?: (item: P) => Promise<boolean>\n  sanitizePayload?: (item: P) => Promise<P>\n\n  // XXX: Confirm if obsolete and remove\n  itemSorter?: (a: P, b: P) => number\n\n  /**\n   * Expression used to sort an item of this class.\n   * Passed to useFilteredIndex().\n   */\n  keyExpression?: string\n\n  exportFormats?: ExportFormatConfiguration<P>[]\n\n  views: {\n    listItemView: ItemListView<P>\n    editView: ItemEditView<P>\n    detailView?: ItemDetailView<P>\n  }\n}\n\n\nexport interface RegistryViewProps\n<Items extends ItemClassConfigurationSet = Record<string, ItemClassConfiguration<any>>>\nextends RegisterConfiguration<Items> {\n  /**\n   * When search is initially opened, have this query pre-defined.\n   * Not very useful since there are also preset searches in the browser now.\n   */\n  // TODO: Obsoluete?\n  defaultSearchCriteria?: CriteriaGroup\n\n  customViews?: CustomViewConfiguration[]\n}\n\nexport interface CustomViewConfiguration {\n  id: string\n  label: string\n  description: string\n  view: React.FC<{\n    /** View can support optional path for custom state/inner navigation (provisional). */\n    path: string\n  }>\n  icon?: JSX.Element\n}\n\n\n// Item views\n\nexport interface ItemAction {\n  getButtonProps:\n    (item: RegisterItem<any>, itemClass: ItemClassConfiguration<any>, subregisterID?: string) =>\n      ButtonProps | MenuItemProps\n}\n\nexport type RegistryView = React.FC<RegistryViewProps>\n\ntype RegistryItemPayloadDefaults<P extends Payload> =\n  Partial<Omit<P, 'id'>>;\n\n/**\n * A small part of item class configuration,\n * useful e.g. for formatting related items.\n */\nexport type RelatedItemClassConfiguration = {\n  title: string\n  itemView: ItemListView<any>\n}\n\n\nexport interface RegistryItemViewProps<P extends Payload> {\n  /**\n   * Item reference.\n   * Glossarist, for example, uses it to determine language subregister and set appropriate writing direction.\n   */\n  itemRef: Omit<InternalItemReference, 'itemID'> & { itemID?: InternalItemReference['itemID'] }\n\n  /** Item data (payload). */\n  itemData: P\n\n  className?: string\n  //subregisterID?: string\n\n  /** Deprecated */\n  useRegisterItemData?: any\n  /** Deprecated */\n  getRelatedItemClassConfiguration?: any\n}\n\nexport interface GenericRelatedItemViewProps {\n  /** Currently selected item’s ref. */\n  itemRef?: InternalItemReference\n\n  /**\n   * By default, clicking the item will spawn a tab via TabbedWorkspace context.\n   * This prop can customize that behavior.\n   */\n  onJump?: () => void\n\n  className?: string\n  //useRegisterItemData: RegisterItemDataHook\n  //getRelatedItemClassConfiguration: ExtensionContext[\"getRelatedItemClassConfiguration\"]\n  availableClassIDs?: string[]\n  availableSubregisterIDs?: string[]\n\n  // XXX: Check if obsolete, remove if unused\n  itemSorter?: ItemClassConfiguration<any>[\"itemSorter\"]\n\n  /** Called to auto-create an item (can’t auto-create if not provided) */\n  onCreateNew?: () => Promise<InternalItemReference>\n\n  /** Called when current item is cleared (can’t clear if not provided) */\n  onClear?: () => void\n\n  /** Called when a new item is selected (can’t change if not provided) */\n  onChange?: (newRef: InternalItemReference) => void\n\n  /** Deprecated */\n  useRegisterItemData?: any\n  /** Deprecated */\n  getRelatedItemClassConfiguration?: any\n}\n\n\nexport type ItemEditView<P extends Payload> = React.FC<RegistryItemViewProps<P> & {\n  onChange?: (newData: P) => void\n  onCreateRelatedItem?:\n    (classID: string, subregisterID?: string) => Promise<InternalItemReference>\n}>;\n\nexport interface ItemDetailViewProps<P extends Payload> extends RegistryItemViewProps<P> {\n  //useRegisterItemData: RegisterItemDataHook\n}\n\nexport type ItemDetailView<P extends Payload> = React.FC<ItemDetailViewProps<P>>;\n\nexport interface ItemListViewProps<P extends Payload> extends RegistryItemViewProps<P> {\n}\n\nexport type ItemListView<P extends Payload> = React.FC<ItemListViewProps<P>>;\n\nexport type LazyItemView = React.FC<{ itemID: string }>;\n"]}

package/dist/views/AnnotatedChange.d.ts

@@ -0,0 +1,7 @@
+/** @jsx jsx */
+/** @jsxFrag React.Fragment */
+import React from 'react';
+declare const AnnotatedChange: React.FC<{
+    type: 'added' | 'removed';
+}>;
+export default AnnotatedChange;

package/dist/views/AnnotatedChange.js

@@ -0,0 +1,91 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _react = require("@emotion/react");
+
+var _react2 = _interopRequireWildcard(require("react"));
+
+var _core = require("@blueprintjs/core");
+
+var _roughNotation = require("rough-notation");
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
+/** @jsx jsx */
+
+/** @jsxFrag React.Fragment */
+function annotateChange(type, wrappingEl, childIsBoxy) {
+  const highlightConfig = {
+    type: 'highlight',
+    animate: false,
+    color: _core.Colors.GOLD5,
+    iterations: 3
+  };
+  let changeConfig;
+
+  if (type === 'added') {
+    changeConfig = {
+      type: childIsBoxy ? 'bracket' : 'underline',
+      iterations: 1,
+      color: _core.Colors.BLUE4
+    };
+  } else {
+    changeConfig = {
+      type: 'crossed-off',
+      iterations: 1,
+      color: _core.Colors.RED3
+    };
+  }
+
+  const highlightAnnotation = (0, _roughNotation.annotate)(wrappingEl, highlightConfig);
+  const changeAnnotation = (0, _roughNotation.annotate)(wrappingEl, changeConfig);
+  return [highlightAnnotation, changeAnnotation];
+}
+
+const AnnotatedChange = ({
+  type,
+  children
+}) => {
+  const elRef = (0, _react2.useRef)(null);
+
+  const firstChild = _react2.default.Children.toArray(children)[0];
+
+  const childType = _react2.default.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;
+
+  (0, _react2.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 (0, _react.jsx)("mark", {
+    style: {
+      display: childIsBoxy ? 'block' : 'inline',
+      background: 'none'
+    },
+    ref: elRef,
+    title: `(${type} in this proposal)`
+  }, children);
+};
+
+var _default = AnnotatedChange;
+exports.default = _default;

package/dist/views/AnnotatedChange.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AnnotatedChange.js","sourceRoot":"","sources":["../../src/views/AnnotatedChange.tsx"],"names":[],"mappings":"AAAA,eAAe;AACf,8BAA8B;AAE9B,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AACrC,OAAO,KAAK,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AACjD,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAI1C,SAAS,cAAc,CACrB,IAAyB,EACzB,UAA2B,EAC3B,WAAgC;IAEhC,MAAM,eAAe,GAA0B;QAC7C,IAAI,EAAE,WAAW;QACjB,OAAO,EAAE,KAAK;QACd,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,UAAU,EAAE,CAAC;KACd,CAAC;IACF,IAAI,YAAmC,CAAC;IACxC,IAAI,IAAI,KAAK,OAAO,EAAE;QACpB,YAAY,GAAG;YACb,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW;YAC3C,UAAU,EAAE,CAAC;YACb,KAAK,EAAE,MAAM,CAAC,KAAK;SACpB,CAAC;KACH;SAAM;QACL,YAAY,GAAG;YACb,IAAI,EAAE,aAAa;YACnB,UAAU,EAAE,CAAC;YACb,KAAK,EAAE,MAAM,CAAC,IAAI;SACnB,CAAC;KACH;IACD,MAAM,mBAAmB,GAAG,QAAQ,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;IAClE,MAAM,gBAAgB,GAAG,QAAQ,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;IAE5D,OAAO,CAAC,mBAAmB,EAAE,gBAAgB,CAAC,CAAC;AACjD,CAAC;AAGD,MAAM,eAAe,GAA4C,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE;IACtF,MAAM,KAAK,GAAG,MAAM,CAAyB,IAAI,CAAC,CAAC;IAEnD,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAEvD,MAAM,SAAS,GAAG,KAAK,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;IACjF,MAAM,WAAW,GAAG,SAAS,KAAK,KAAK,CAAC;IAExC,0DAA0D;IAC1D,oHAAoH;IAEpH,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,KAAK,CAAC,OAAO,EAAE;YACjB,MAAM,WAAW,GAAG,cAAc,CAAC,IAAI,EAAE,KAAK,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;YACrE,KAAK,MAAM,CAAC,IAAI,WAAW,EAAE;gBAC3B,CAAC,CAAC,IAAI,EAAE,CAAC;aACV;YACD,OAAO,SAAS,OAAO;gBACrB,KAAK,MAAM,CAAC,IAAI,WAAW,EAAE;oBAC3B,CAAC,CAAC,MAAM,EAAE,CAAC;iBACZ;YACH,CAAC,CAAA;SACF;QACD,OAAO;IACT,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;IAEpB,OAAO,CACL,cACI,KAAK,EAAE,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,EAAE,UAAU,EAAE,MAAM,EAAE,EACxE,GAAG,EAAE,KAAK,EACV,KAAK,EAAE,IAAI,IAAI,oBAAoB,IACpC,QAAQ,CACJ,CACR,CAAC;AACJ,CAAC,CAAC;AAGF,eAAe,eAAe,CAAC","sourcesContent":["/** @jsx jsx */\n/** @jsxFrag React.Fragment */\n\nimport { jsx } from '@emotion/react';\nimport React, { useRef, useEffect } from 'react';\nimport { Colors } from '@blueprintjs/core'\nimport { annotate } from 'rough-notation';\nimport { RoughAnnotation, RoughAnnotationConfig } from 'rough-notation/lib/model';\n\n\nfunction annotateChange(\n  type: 'added' | 'removed',\n  wrappingEl: HTMLSpanElement,\n  childIsBoxy: boolean | undefined):\nRoughAnnotation[] {\n  const highlightConfig: RoughAnnotationConfig = {\n    type: 'highlight',\n    animate: false,\n    color: Colors.GOLD5,\n    iterations: 3,\n  };\n  let changeConfig: RoughAnnotationConfig;\n  if (type === 'added') {\n    changeConfig = {\n      type: childIsBoxy ? 'bracket' : 'underline',\n      iterations: 1,\n      color: Colors.BLUE4,\n    };\n  } else {\n    changeConfig = {\n      type: 'crossed-off',\n      iterations: 1,\n      color: Colors.RED3,\n    };\n  }\n  const highlightAnnotation = annotate(wrappingEl, highlightConfig);\n  const changeAnnotation = annotate(wrappingEl, changeConfig);\n\n  return [highlightAnnotation, changeAnnotation];\n}\n\n\nconst AnnotatedChange: React.FC<{ type: 'added' | 'removed' }> = ({ type, children }) => {\n  const elRef = useRef<HTMLSpanElement | null>(null);\n\n  const firstChild = React.Children.toArray(children)[0];\n\n  const childType = React.isValidElement(firstChild) ? firstChild.type : undefined;\n  const childIsBoxy = childType === 'div';\n\n  // Could it bring more accuracy to block/inline detection?\n  //const childCount = React.isValidElement(firstChild) ? React.Children.count(firstChild.props.children) : undefined;\n\n  useEffect(() => {\n    if (elRef.current) {\n      const annotations = annotateChange(type, elRef.current, childIsBoxy);\n      for (const a of annotations) {\n        a.show();\n      }\n      return function cleanup() {\n        for (const a of annotations) {\n          a.remove();\n        }\n      }\n    }\n    return;\n  }, [elRef.current]);\n\n  return (\n    <mark\n        style={{ display: childIsBoxy ? 'block' : 'inline', background: 'none' }}\n        ref={elRef}\n        title={`(${type} in this proposal)`}>\n      {children}\n    </mark>\n  );\n};\n\n\nexport default AnnotatedChange;\n"]}

package/dist/views/BrowserCtx.d.ts

@@ -0,0 +1,73 @@
+/** @jsx jsx */
+/// <reference types="react" />
+import type { CustomViewConfiguration, ItemClassConfigurationSet, ItemClassConfiguration, RegisterItem, RegisterItemDataHook, Register, RegisterStakeholder, RelatedItemClassConfiguration, Subregisters, InternalItemReference } from '../types';
+import { type CriteriaGroup } from './FilterCriteria/models';
+import { type Protocol } from './protocolRegistry';
+export declare type BrowserCtx = {
+    itemClasses: ItemClassConfigurationSet;
+    subregisters?: Subregisters;
+    /**
+     * Stakeholder corresponding to the current user.
+     * If current user is not a stakeholder, undefined.
+     */
+    stakeholder?: RegisterStakeholder;
+    /**
+     * Common “key expression” (used for sorting) across the register.
+     * Should contain the expression itself, no “return” statement.
+     */
+    keyExpression?: string;
+    /** Default search criteria to be used by the Search sidebar */
+    defaultSearchCriteria?: CriteriaGroup;
+    /**
+     * Allows to access register metadata
+     * (e.g., version, stakeholders).
+     *
+     * `undefined` if loading, `null` if unspecified.
+     */
+    registerMetadata?: Register | null;
+    /** Hook for getting register item data. */
+    useRegisterItemData: RegisterItemDataHook;
+    /**
+     * Invoked to navigate to an item.
+     * In SPA tabbed context, could translate to `spawnTab()`;
+     * in static web context, could translate to navigating browser location.
+     */
+    jumpTo?: (uri: `${Protocol}:${string}`) => void;
+    /**
+     * If a register item is selected, provide its data here.
+     *
+     * If item data is still loading or invalid, `undefined`.
+     * If item is not selected, `null`.
+     */
+    selectedRegisterItem?: {
+        item: RegisterItem<any>;
+        ref: InternalItemReference;
+        itemClass: ItemClassConfiguration<any>;
+    } | null;
+    /**
+     * Change request being drafted or reviewed.
+     * `undefined` if loading, `null` if there is no active change request.
+     */
+    activeChangeRequestID?: string | null;
+    /**
+     * Setter for `activeChangeRequest()`. Set to `null` to unset.
+     */
+    setActiveChangeRequestID?: (id: string | null) => void;
+    /**
+     * An async function for retrieving data of register items
+     * at given paths. For cases where the hook doesn’t work.
+     *
+     * If a path contains nothing or contains not a register item,
+     * the result will be null.
+     */
+    /**
+     * Extension-provided additional views that don’t correspond
+     * to entities like register item, change request, etc. handled by RegistryKit.
+     */
+    customViews: CustomViewConfiguration[];
+    /**
+     * Given item class ID, returns a small subset of relevant class configuration data.
+     */
+    getRelatedItemClassConfiguration: (clsID: string) => RelatedItemClassConfiguration;
+};
+export declare const BrowserCtx: import("react").Context<BrowserCtx>;

package/dist/views/BrowserCtx.js

@@ -0,0 +1,31 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.BrowserCtx = void 0;
+
+var _react = require("@emotion/react");
+
+var _react2 = require("react");
+
+/** @jsx jsx */
+const BrowserCtx = (0, _react2.createContext)({
+  itemClasses: {},
+  customViews: [],
+  // getRegisterItemData: async () => ({}),
+  selectedRegisterItem: null,
+  registerMetadata: undefined,
+  useRegisterItemData: () => ({
+    value: {},
+    _reqCounter: -1,
+    errors: [],
+    isUpdating: true,
+    refresh: () => void 0
+  }),
+  getRelatedItemClassConfiguration: () => ({
+    title: 'N/A',
+    itemView: () => (0, _react.jsx)("span", null, "Loading\u2026")
+  })
+});
+exports.BrowserCtx = BrowserCtx;

package/dist/views/BrowserCtx.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BrowserCtx.js","sourceRoot":"","sources":["../../src/views/BrowserCtx.tsx"],"names":[],"mappings":"AAAA,eAAe;AAEf,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AACrC,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAyGtC,MAAM,CAAC,MAAM,UAAU,GAAG,aAAa,CAAa;IAClD,WAAW,EAAE,EAAE;IACf,WAAW,EAAE,EAAE;IACf,yCAAyC;IACzC,oBAAoB,EAAE,IAAI;IAC1B,gBAAgB,EAAE,SAAS;IAC3B,mBAAmB,EAAE,GAAG,EAAE,CAAC,CAAC;QAC1B,KAAK,EAAE,EAAE;QACT,WAAW,EAAE,CAAC,CAAC;QACf,MAAM,EAAE,EAAE;QACV,UAAU,EAAE,IAAI;QAChB,OAAO,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC;KACtB,CAAC;IACF,gCAAgC,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC,kCAAqB,EAAE,CAAC;CAClG,CAAC,CAAC","sourcesContent":["/** @jsx jsx */\n\nimport { jsx } from '@emotion/react';\nimport { createContext } from 'react';\nimport type {\n  CustomViewConfiguration,\n  ItemClassConfigurationSet,\n  ItemClassConfiguration,\n  RegisterItem,\n  RegisterItemDataHook,\n  Register,\n  RegisterStakeholder,\n  RelatedItemClassConfiguration,\n  // SaveProposalHandler,\n  Subregisters,\n  InternalItemReference,\n} from '../types';\nimport { type CriteriaGroup } from './FilterCriteria/models';\nimport { type Protocol } from './protocolRegistry';\n\n\n// TODO(perf): split into smaller contexts\nexport type BrowserCtx = {\n  itemClasses: ItemClassConfigurationSet\n  subregisters?: Subregisters\n\n  /**\n   * Stakeholder corresponding to the current user.\n   * If current user is not a stakeholder, undefined.\n   */\n  stakeholder?: RegisterStakeholder\n\n  /**\n   * Common “key expression” (used for sorting) across the register.\n   * Should contain the expression itself, no “return” statement.\n   */\n  keyExpression?: string\n\n  /** Default search criteria to be used by the Search sidebar */\n  defaultSearchCriteria?: CriteriaGroup\n\n  /**\n   * Allows to access register metadata\n   * (e.g., version, stakeholders).\n   *\n   * `undefined` if loading, `null` if unspecified.\n   */\n  registerMetadata?: Register | null\n\n  /** Hook for getting register item data. */\n  useRegisterItemData: RegisterItemDataHook\n\n  /**\n   * Invoked to navigate to an item.\n   * In SPA tabbed context, could translate to `spawnTab()`;\n   * in static web context, could translate to navigating browser location.\n   */\n  jumpTo?: (uri: `${Protocol}:${string}`) => void\n\n  /**\n   * If a register item is selected, provide its data here.\n   *\n   * If item data is still loading or invalid, `undefined`.\n   * If item is not selected, `null`.\n   */\n  selectedRegisterItem?: {\n    item: RegisterItem<any>\n    ref: InternalItemReference\n    itemClass: ItemClassConfiguration<any>\n  } | null\n\n  /**\n   * Change request being drafted or reviewed.\n   * `undefined` if loading, `null` if there is no active change request.\n   */\n  activeChangeRequestID?: string | null\n\n  /**\n   * Setter for `activeChangeRequest()`. Set to `null` to unset.\n   */\n  setActiveChangeRequestID?: (id: string | null) => void\n\n  /**\n   * An async function for retrieving data of register items\n   * at given paths. For cases where the hook doesn’t work.\n   *\n   * If a path contains nothing or contains not a register item,\n   * the result will be null.\n   */\n  // getRegisterItemData: (opts: { itemPaths: string[] }) => Promise<Record<string, RegisterItem<any> | null>>\n\n  /**\n   * Extension-provided additional views that don’t correspond\n   * to entities like register item, change request, etc. handled by RegistryKit.\n   */\n  customViews: CustomViewConfiguration[]\n\n  // onPropose?: SaveProposalHandler\n\n  //selectedItemPath?: string\n\n  /**\n   * Given item class ID, returns a small subset of relevant class configuration data.\n   */\n  getRelatedItemClassConfiguration: (clsID: string) => RelatedItemClassConfiguration\n  // TODO: Rename to just “get class config”\n};\n\nexport const BrowserCtx = createContext<BrowserCtx>({\n  itemClasses: {},\n  customViews: [],\n  // getRegisterItemData: async () => ({}),\n  selectedRegisterItem: null,\n  registerMetadata: undefined,\n  useRegisterItemData: () => ({\n    value: {},\n    _reqCounter: -1,\n    errors: [],\n    isUpdating: true,\n    refresh: () => void 0,\n  }),\n  getRelatedItemClassConfiguration: () => ({ title: 'N/A', itemView: () => <span>Loading…</span> }),\n});\n"]}

package/dist/views/FilterCriteria/CRITERIA_CONFIGURATION.d.ts

@@ -0,0 +1,17 @@
+/** @jsx jsx */
+/** @jsxFrag React.Fragment */
+import { CriteriaConfiguration, CriterionConfiguration } from './models';
+export declare const ITEM_CLASS: CriterionConfiguration<{
+    classID?: string;
+}>;
+export declare const SUBREGISTER: CriterionConfiguration<{
+    subregisterID?: string;
+}>;
+export declare const RAW_SUBSTRING: CriterionConfiguration<{
+    substring?: string;
+}>;
+export declare const CUSTOM_CONDITION: CriterionConfiguration<{
+    customExpression?: string;
+}>;
+export declare const CRITERIA_CONFIGURATION: CriteriaConfiguration;
+export default CRITERIA_CONFIGURATION;