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

package/types/item.d.ts

@@ -1,5 +1,5 @@
-import { RegisterStakeholder } from './stakeholder';
-import { Citation, LocalizedAlternative } from './util';
+import type { RegisterStakeholder } from './stakeholder';
+import type { Citation, LocalizedAlternative } from './util';
 export declare type Payload = Record<string, any>;
 declare const ITEM_STATUSES: readonly ["submitted", "valid", "superseded", "retired", "invalid"];
 export declare type ItemStatus = typeof ITEM_STATUSES[number];
@@ -27,6 +27,7 @@ interface ItemReference {
     itemID: string;
 }
 export declare type InternalItemReference = Omit<ItemReference, 'registerID'>;
+export declare function isInternalItemReference(val: any): val is InternalItemReference;
 interface AbstractItemSource {
     type: string;
 }
@@ -41,9 +42,18 @@ interface ExternalSource extends AbstractItemSource {
 declare type RegisterItemSource = PaneronRegisterItemSource | ExternalSource;
 export interface RegisterItem<P extends Payload> {
     id: string;
-    status: string;
+    status: ItemStatus;
     dateAccepted: Date;
+    /** UUID of change request that defined the current version. */
+    amendedInCR?: string;
+    supersededBy?: InternalItemReference[];
+    supersedes?: InternalItemReference[];
+    /**
+     * Register item data. Domain-specific. May include additional human-readable identifiers.
+     * In ISO 19135-1 was represented by “definition”.
+     */
     data: P;
     source?: RegisterItemSource;
 }
+export declare function isRegisterItem(val: any): val is RegisterItem<any>;
 export {};

package/types/item.js

@@ -3,4 +3,14 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-const ITEM_STATUSES = ['submitted', 'valid', 'superseded', 'retired', 'invalid'];
+exports.isInternalItemReference = isInternalItemReference;
+exports.isRegisterItem = isRegisterItem;
+const ITEM_STATUSES = ['submitted', 'valid', 'superseded', 'retired', 'invalid'];
+
+function isInternalItemReference(val) {
+  return val && val.hasOwnProperty('itemID') && val.hasOwnProperty('classID') && typeof val['itemID'] == 'string' && typeof val['classID'] == 'string';
+}
+
+function isRegisterItem(val) {
+  return val && val.hasOwnProperty('id') && val.hasOwnProperty('data') && val.hasOwnProperty('status') && ITEM_STATUSES.indexOf(val.status) >= 0;
+}

package/types/item.js.map

@@ -1 +1 @@
-{"version":3,"file":"item.js","sourceRoot":"","sources":["../../src/types/item.ts"],"names":[],"mappings":"AAOA,MAAM,aAAa,GAAG;IACpB,WAAW;IACX,OAAO;IACP,YAAY;IACZ,SAAS;IACT,SAAS;CACD,CAAC","sourcesContent":["\nimport { RegisterStakeholder } from './stakeholder';\nimport { Citation, LocalizedAlternative } from './util';\n\n\nexport type Payload = Record<string, any>\n\nconst ITEM_STATUSES = [\n  'submitted',\n  'valid',\n  'superseded',\n  'retired',\n  'invalid',\n] as const;\n\nexport type ItemStatus = typeof ITEM_STATUSES[number];\n\n\nexport interface RegisterItemID {\n  classID: string\n  itemID: string\n}\n\n\nexport interface RegisterItemClass {\n  id: string\n  title: string\n  description?: string\n  alternativeNames?: LocalizedAlternative<string>[]\n}\n\nexport interface RegisterItemRevision<P extends Payload> {\n  timestamp: Date\n  parents: string[] // Revision IDs\n  status: ItemStatus\n  data: P\n  author: RegisterStakeholder\n}\n\ninterface ItemReference {\n  registerID: string\n  subregisterID?: string\n  classID: string\n  itemID: string\n}\n\nexport type InternalItemReference = Omit<ItemReference, 'registerID'>\n\n\ninterface AbstractItemSource {\n  type: string\n}\ninterface PaneronRegisterItemSource extends AbstractItemSource {\n  type: 'paneron_register'\n  itemRef: ItemReference\n}\ninterface ExternalSource extends AbstractItemSource {\n  type: 'external'\n  citation: Citation\n}\ntype RegisterItemSource = PaneronRegisterItemSource | ExternalSource\n\nexport interface RegisterItem<P extends Payload> {\n  id: string // UUID\n  status: string\n  dateAccepted: Date\n  data: P // Register item data, may include additional human identifiers\n  source?: RegisterItemSource\n}\n"]}
+{"version":3,"file":"item.js","sourceRoot":"","sources":["../../src/types/item.ts"],"names":[],"mappings":"AAOA,MAAM,aAAa,GAAG;IACpB,WAAW;IACX,OAAO;IACP,YAAY;IACZ,SAAS;IACT,SAAS;CACD,CAAC;AAmCX,MAAM,UAAU,uBAAuB,CAAC,GAAQ;IAC9C,OAAO,CACL,GAAG;QACH,GAAG,CAAC,cAAc,CAAC,QAAQ,CAAC;QAC5B,GAAG,CAAC,cAAc,CAAC,SAAS,CAAC;QAC7B,OAAO,GAAG,CAAC,QAAQ,CAAC,IAAI,QAAQ;QAChC,OAAO,GAAG,CAAC,SAAS,CAAC,IAAI,QAAQ,CAClC,CAAC;AACJ,CAAC;AA0CD,MAAM,UAAU,cAAc,CAAC,GAAQ;IACrC,OAAO,CACL,GAAG;QACH,GAAG,CAAC,cAAc,CAAC,IAAI,CAAC;QACxB,GAAG,CAAC,cAAc,CAAC,MAAM,CAAC;QAC1B,GAAG,CAAC,cAAc,CAAC,QAAQ,CAAC;QAC5B,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CACvC,CAAC;AACJ,CAAC","sourcesContent":["\nimport type { RegisterStakeholder } from './stakeholder';\nimport type { Citation, LocalizedAlternative } from './util';\n\n\nexport type Payload = Record<string, any>\n\nconst ITEM_STATUSES = [\n  'submitted',\n  'valid',\n  'superseded',\n  'retired',\n  'invalid',\n] as const;\n\nexport type ItemStatus = typeof ITEM_STATUSES[number];\n\n\nexport interface RegisterItemID {\n  classID: string\n  itemID: string\n}\n\n\nexport interface RegisterItemClass {\n  id: string\n  title: string\n  description?: string\n  alternativeNames?: LocalizedAlternative<string>[]\n}\n\nexport interface RegisterItemRevision<P extends Payload> {\n  timestamp: Date\n  parents: string[] // Revision IDs\n  status: ItemStatus\n  data: P\n  author: RegisterStakeholder\n}\n\ninterface ItemReference {\n  registerID: string\n  subregisterID?: string\n  classID: string\n  itemID: string\n}\n\nexport type InternalItemReference = Omit<ItemReference, 'registerID'>\n\nexport function isInternalItemReference(val: any): val is InternalItemReference {\n  return (\n    val &&\n    val.hasOwnProperty('itemID') &&\n    val.hasOwnProperty('classID') &&\n    typeof val['itemID'] == 'string' &&\n    typeof val['classID'] == 'string'\n  );\n}\n\n\ninterface AbstractItemSource {\n  type: string\n}\ninterface PaneronRegisterItemSource extends AbstractItemSource {\n  type: 'paneron_register'\n  itemRef: ItemReference\n}\ninterface ExternalSource extends AbstractItemSource {\n  type: 'external'\n  citation: Citation\n}\ntype RegisterItemSource = PaneronRegisterItemSource | ExternalSource\n\nexport interface RegisterItem<P extends Payload> {\n  id: string // UUID\n\n  status: ItemStatus\n\n  dateAccepted: Date\n  // This is a mandatory property, since until their acceptance items “live” as part of their corresponding change requests\n\n  /** UUID of change request that defined the current version. */\n  amendedInCR?: string\n\n  // TODO: Denormalized, should be validated with consistency checks\n  supersededBy?: InternalItemReference[]\n  supersedes?: InternalItemReference[]\n\n  /**\n   * Register item data. Domain-specific. May include additional human-readable identifiers.\n   * In ISO 19135-1 was represented by “definition”.\n   */\n  data: P\n\n  source?: RegisterItemSource\n  // TODO: Citations were suggested to be moved to proposals, as motivating/substantiating evidence.\n  // TODO: Register item, however, should have a relationship that points to the original proto-item from another register.\n}\n\nexport function isRegisterItem(val: any): val is RegisterItem<any> {\n  return (\n    val &&\n    val.hasOwnProperty('id') &&\n    val.hasOwnProperty('data') &&\n    val.hasOwnProperty('status') &&\n    ITEM_STATUSES.indexOf(val.status) >= 0\n  );\n}\n"]}

package/types/proposal.d.ts

@@ -1,12 +1,21 @@
-import { Payload } from './item';
-import { RegisterStakeholder } from './stakeholder';
+import type { RegisterStakeholder } from './stakeholder';
+import type { Citation } from './util';
 export declare const DECISION_STATUSES: readonly ["pending", "tentative", "final"];
 export declare const DISPOSITION_OPTIONS: readonly ["withdrawn", "accepted", "notAccepted"];
+/**
+ * Item paths in proposal set must start with a slash
+ * and will be treated relative to dataset root.
+ * Object paths should conform to registry item path shape
+ * of `[/subregisterID]/<classID>/<itemID>.yaml`.
+ */
+export declare type ProposalSet = {
+    [objectPath: string]: ChangeProposal;
+};
+/** A change request, per ISO 19135-1 model. */
 export interface ChangeRequest {
+    /** Justification for the change */
     justification: string;
-    proposals: {
-        [itemIDWithClass: string]: ChangeProposal;
-    };
+    proposals: ProposalSet;
     id: string;
     timeStarted: Date;
     timeProposed?: Date;
@@ -18,30 +27,38 @@ export interface ChangeRequest {
     controlBodyNotes?: string;
     registerManagerNotes?: string;
 }
+/**
+ * Change request properties for the purposes of drafting.
+ * (`controlBodyNotes` is in question.)
+ */
+export declare type DraftChangeRequest = Pick<ChangeRequest, 'proposals' | 'justification' | 'controlBodyNotes' | 'sponsor'>;
 export declare const PROPOSAL_TYPES: readonly ["addition", "clarification", "amendment"];
 interface BaseProposal {
+    disposition?: 'accepted' | 'notAccepted';
     type: typeof PROPOSAL_TYPES[number];
+    sources?: Citation[];
 }
-interface Addition extends BaseProposal {
+export interface Addition extends BaseProposal {
     type: 'addition';
-    payload: Payload;
 }
-interface Clarification extends BaseProposal {
+export interface Clarification extends BaseProposal {
     type: 'clarification';
-    payload: Payload;
 }
-export declare const AMENDMENT_TYPES: readonly ["supersession", "retirement"];
+export declare const AMENDMENT_TYPES: readonly ["supersession", "retirement", "invalidation"];
 interface BaseAmendment extends BaseProposal {
     type: 'amendment';
     amendmentType: typeof AMENDMENT_TYPES[number];
 }
-interface Retirement extends BaseAmendment {
+export interface Retirement extends BaseAmendment {
     amendmentType: 'retirement';
 }
-interface Supersession extends BaseAmendment {
+export interface Supersession extends BaseAmendment {
     amendmentType: 'supersession';
-    supersedingItemID: string;
+    supersedingItemIDs: string[];
 }
-declare type Amendment = Supersession | Retirement;
+export interface Invalidation extends BaseAmendment {
+    amendmentType: 'invalidation';
+}
+export declare type Amendment = Supersession | Retirement | Invalidation;
 export declare type ChangeProposal = Amendment | Clarification | Addition;
 export {};

package/types/proposal.js

@@ -10,5 +10,5 @@ const DISPOSITION_OPTIONS = ['withdrawn', 'accepted', 'notAccepted'];
 exports.DISPOSITION_OPTIONS = DISPOSITION_OPTIONS;
 const PROPOSAL_TYPES = ['addition', 'clarification', 'amendment'];
 exports.PROPOSAL_TYPES = PROPOSAL_TYPES;
-const AMENDMENT_TYPES = ['supersession', 'retirement'];
+const AMENDMENT_TYPES = ['supersession', 'retirement', 'invalidation'];
 exports.AMENDMENT_TYPES = AMENDMENT_TYPES;

package/types/proposal.js.map

@@ -1 +1 @@
-{"version":3,"file":"proposal.js","sourceRoot":"","sources":["../../src/types/proposal.ts"],"names":[],"mappings":"AAIA,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,SAAS;IACT,WAAW;IACX,OAAO;CACC,CAAC;AAEX,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,WAAW;IACX,UAAU;IACV,aAAa;CACL,CAAC;AAqBX,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,UAAU;IACV,eAAe;IACf,WAAW;CACH,CAAC;AAiBX,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,cAAc;IACd,YAAY;CACJ,CAAC","sourcesContent":["import { Payload } from './item';\nimport { RegisterStakeholder } from './stakeholder';\n\n\nexport const DECISION_STATUSES = [\n  'pending',\n  'tentative',\n  'final',\n] as const;\n\nexport const DISPOSITION_OPTIONS = [\n  'withdrawn',\n  'accepted',\n  'notAccepted',\n] as const;\n\nexport interface ChangeRequest {\n  // Supplied by sponsor\n  justification: string // Justification for proposal\n  proposals: { [itemIDWithClass: string]: ChangeProposal }\n\n  // Enforced by the system\n  id: string\n  timeStarted: Date\n  timeProposed?: Date\n  timeDisposed?: Date\n  sponsor: RegisterStakeholder\n\n  // Supplied by register manager\n  status: typeof DECISION_STATUSES[number] // Default filled in by the system but changeable\n  disposition?: typeof DISPOSITION_OPTIONS[number]\n  controlBodyDecisionEvent?: string\n  controlBodyNotes?: string\n  registerManagerNotes?: string\n}\nexport const PROPOSAL_TYPES = [\n  'addition',\n  'clarification',\n  'amendment',\n] as const;\n\ninterface BaseProposal {\n  //itemID: RegisterItemID\n  type: typeof PROPOSAL_TYPES[number]\n}\n\ninterface Addition extends BaseProposal {\n  type: 'addition'\n  payload: Payload\n}\n\ninterface Clarification extends BaseProposal {\n  type: 'clarification'\n  payload: Payload\n}\n\nexport const AMENDMENT_TYPES = [\n  'supersession',\n  'retirement',\n] as const;\ninterface BaseAmendment extends BaseProposal {\n  type: 'amendment'\n  amendmentType: typeof AMENDMENT_TYPES[number]\n}\ninterface Retirement extends BaseAmendment {\n  amendmentType: 'retirement'\n}\ninterface Supersession extends BaseAmendment {\n  amendmentType: 'supersession'\n  supersedingItemID: string\n}\ntype Amendment = Supersession | Retirement\n\nexport type ChangeProposal = Amendment | Clarification | Addition\n"]}
+{"version":3,"file":"proposal.js","sourceRoot":"","sources":["../../src/types/proposal.ts"],"names":[],"mappings":"AAIA,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,SAAS;IACT,WAAW;IACX,OAAO;CACC,CAAC;AAEX,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,WAAW;IACX,UAAU;IACV,aAAa;CACL,CAAC;AA2CX,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,UAAU;IACV,eAAe;IACf,WAAW;CACH,CAAC;AAqBX,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,cAAc;IACd,YAAY;IACZ,cAAc;CACN,CAAC","sourcesContent":["import type { RegisterStakeholder } from './stakeholder';\nimport type { Citation } from './util';\n\n\nexport const DECISION_STATUSES = [\n  'pending',\n  'tentative',\n  'final',\n] as const;\n\nexport const DISPOSITION_OPTIONS = [\n  'withdrawn',\n  'accepted',\n  'notAccepted',\n] as const;\n\n/**\n * Item paths in proposal set must start with a slash\n * and will be treated relative to dataset root.\n * Object paths should conform to registry item path shape\n * of `[/subregisterID]/<classID>/<itemID>.yaml`.\n */\nexport type ProposalSet = {\n  [objectPath: string]: ChangeProposal\n}\n\n/** A change request, per ISO 19135-1 model. */\nexport interface ChangeRequest {\n  // Supplied by sponsor\n  /** Justification for the change */\n  justification: string\n\n  proposals: ProposalSet\n\n  // Enforced by the system\n  id: string\n  timeStarted: Date\n  timeProposed?: Date\n  timeDisposed?: Date\n  sponsor: RegisterStakeholder\n\n  // Supplied by register manager\n  status: typeof DECISION_STATUSES[number] // Default filled in by the system but changeable\n  disposition?: typeof DISPOSITION_OPTIONS[number]\n  controlBodyDecisionEvent?: string\n  controlBodyNotes?: string\n  registerManagerNotes?: string\n}\n\n\n/**\n * Change request properties for the purposes of drafting.\n * (`controlBodyNotes` is in question.)\n */\nexport type DraftChangeRequest =\n  Pick<ChangeRequest, 'proposals' | 'justification' | 'controlBodyNotes' | 'sponsor'>;\n\nexport const PROPOSAL_TYPES = [\n  'addition',\n  'clarification',\n  'amendment',\n] as const;\n\ninterface BaseProposal {\n  //itemID: RegisterItemID\n  disposition?: 'accepted' | 'notAccepted'\n  type: typeof PROPOSAL_TYPES[number]\n  sources?: Citation[]\n}\n\nexport interface Addition extends BaseProposal {\n  type: 'addition'\n  ///** New item data. */\n  //payload: Payload\n}\n\nexport interface Clarification extends BaseProposal {\n  type: 'clarification'\n  ///** Updated item data */\n  //payload: Payload\n}\n\nexport const AMENDMENT_TYPES = [\n  'supersession',\n  'retirement',\n  'invalidation',\n] as const;\ninterface BaseAmendment extends BaseProposal {\n  type: 'amendment'\n  amendmentType: typeof AMENDMENT_TYPES[number]\n}\nexport interface Retirement extends BaseAmendment {\n  amendmentType: 'retirement'\n}\nexport interface Supersession extends BaseAmendment {\n  amendmentType: 'supersession'\n  supersedingItemIDs: string[]\n}\nexport interface Invalidation extends BaseAmendment {\n  amendmentType: 'invalidation'\n}\nexport type Amendment = Supersession | Retirement | Invalidation\n\nexport type ChangeProposal = Amendment | Clarification | Addition\n"]}

package/types/register.d.ts

@@ -1,7 +1,7 @@
-import { RegisterStakeholder } from './stakeholder';
-import { Locale } from './util';
+import { type RegisterStakeholder } from './stakeholder';
+import { type Locale } from './util';
 export interface Register {
-    id: string;
+    id?: string;
     name: string;
     contentSummary: string;
     uniformResourceIdentifier: string;
@@ -10,8 +10,9 @@ export interface Register {
     version?: Version;
     stakeholders: RegisterStakeholder[];
 }
-interface Version {
+export declare function isRegisterMetadata(val: any): val is Register;
+export interface Version {
     id: string;
     timestamp: Date;
 }
-export {};
+export declare function isVersion(val: any): val is Version;

package/types/register.js

@@ -2,4 +2,22 @@
 
 Object.defineProperty(exports, "__esModule", {
   value: true
-});
+});
+exports.isRegisterMetadata = isRegisterMetadata;
+exports.isVersion = isVersion;
+
+var _stakeholder = require("./stakeholder");
+
+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(_stakeholder.isRegisterStakeholder) && // Must have at least an owner
+  val.stakeholders.some(s => s.role === 'owner') && (val.version === undefined || isVersion(val.version));
+}
+
+function isVersion(val) {
+  return val && val.hasOwnProperty('id') && val.hasOwnProperty('timestamp') && typeof val.id === 'string';
+}

package/types/register.js.map

@@ -1 +1 @@
-{"version":3,"file":"register.js","sourceRoot":"","sources":["../../src/types/register.ts"],"names":[],"mappings":"","sourcesContent":["import { RegisterStakeholder } from './stakeholder';\nimport { Locale } from './util';\n\n\nexport interface Register {\n  id: string\n  name: string\n  contentSummary: string\n  uniformResourceIdentifier: string\n\n  operatingLanguage: Locale\n  alternativeLanguages: Locale[]\n\n  version?: Version\n  stakeholders: RegisterStakeholder[]\n}\n\ninterface Version {\n  id: string\n  timestamp: Date\n}\n"]}
+{"version":3,"file":"register.js","sourceRoot":"","sources":["../../src/types/register.ts"],"names":[],"mappings":"AAAA,OAAO,EAA4B,qBAAqB,EAAE,MAAM,eAAe,CAAC;AAkBhF,MAAM,UAAU,kBAAkB,CAAC,GAAQ;IACzC,OAAO,CACL,GAAG;QACH,8BAA8B;QAC9B,+BAA+B;QAC/B,GAAG,CAAC,cAAc,CAAC,MAAM,CAAC;QAC1B,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ;QAC5B,yCAAyC;QACzC,2CAA2C;QAC3C,GAAG,CAAC,cAAc,CAAC,cAAc,CAAC;QAClC,GAAG,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC;QAC3B,6BAA6B;QAC7B,GAAG,CAAC,YAAY,CAAC,KAAK,CAAC,qBAAqB,CAAC;QAC7C,8BAA8B;QAC9B,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAsB,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC;QACrE,iDAAiD;QACjD,CAAC,GAAG,CAAC,OAAO,KAAK,SAAS,IAAI,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AAC3D,CAAC;AAOD,MAAM,UAAU,SAAS,CAAC,GAAQ;IAChC,OAAO,CACL,GAAG;QACH,GAAG,CAAC,cAAc,CAAC,IAAI,CAAC;QACxB,GAAG,CAAC,cAAc,CAAC,WAAW,CAAC;QAC/B,OAAO,GAAG,CAAC,EAAE,KAAK,QAAQ,CAAC,CAAC;AAChC,CAAC","sourcesContent":["import { type RegisterStakeholder, isRegisterStakeholder } from './stakeholder';\nimport { type Locale } from './util';\n\n\nexport interface Register {\n  // TODO: what is register ID? Perhaps URI is enough?\n  id?: string\n  name: string\n  contentSummary: string\n  uniformResourceIdentifier: string\n\n  operatingLanguage: Locale\n  alternativeLanguages: Locale[]\n\n  version?: Version\n  stakeholders: RegisterStakeholder[]\n}\n\nexport function isRegisterMetadata(val: any): val is Register {\n  return (\n    val &&\n    // val.hasOwnProperty('id') &&\n    //typeof val.id === 'string' &&\n    val.hasOwnProperty('name') &&\n    typeof val.name === 'string' &&\n    //val.hasOwnProperty('contentSummary') &&\n    //typeof val.contentSummary === 'string' &&\n    val.hasOwnProperty('stakeholders') &&\n    val.stakeholders.length > 0 &&\n    // Stakeholders must be right\n    val.stakeholders.every(isRegisterStakeholder) &&\n    // Must have at least an owner\n    val.stakeholders.some((s: RegisterStakeholder) => s.role === 'owner') &&\n    // Must have a valid version (or no version? hmm)\n    (val.version === undefined || isVersion(val.version)));\n}\n\nexport interface Version {\n  id: string\n  timestamp: Date\n}\n\nexport function isVersion(val: any): val is Version {\n  return (\n    val &&\n    val.hasOwnProperty('id') &&\n    val.hasOwnProperty('timestamp') &&\n    typeof val.id === 'string');\n}\n"]}

package/types/registry.d.ts

@@ -1,10 +1,15 @@
-interface RegistryLocation {
+export interface Registry {
+    /** A registry is referenced by an UUID. */
     id: string;
     name: string;
+    /** HTTPS URL to Git repository holding registry source information. */
     repoURL: string;
+    /** URL under which the registry is made publicly available. */
+    publicURL: string;
+    /** Data directory within the repository. */
     dataRoot?: string;
 }
-declare const KNOWN_AUTHORITATIVE_REGISTRIES: RegistryLocation[];
-interface ConnectedRegistry {
+export declare const KNOWN_AUTHORITATIVE_REGISTRIES: Registry[];
+export interface ConnectedRegistry {
     workingCopyPath: string;
 }

package/types/registry.js

@@ -1,7 +1,14 @@
 "use strict";
 
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.KNOWN_AUTHORITATIVE_REGISTRIES = void 0;
+// TODO: What is below for?
 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'
-}];
+}];
+exports.KNOWN_AUTHORITATIVE_REGISTRIES = KNOWN_AUTHORITATIVE_REGISTRIES;

package/types/registry.js.map

@@ -1 +1 @@
-{"version":3,"file":"registry.js","sourceRoot":"","sources":["../../src/types/registry.ts"],"names":[],"mappings":";AAOA,MAAM,8BAA8B,GAAuB;IACzD;QACE,EAAE,EAAE,sCAAsC;QAC1C,IAAI,EAAE,WAAW;QACjB,OAAO,EAAE,+CAA+C;KACzD;CACF,CAAC","sourcesContent":["interface RegistryLocation {\n  id: string // UUID\n  name: string\n  repoURL: string\n  dataRoot?: string\n}\n\nconst KNOWN_AUTHORITATIVE_REGISTRIES: RegistryLocation[] = [\n  {\n    id: '9D546C5C-8FA4-496D-A721-6DA72E35F4A9',\n    name: 'ICS codes',\n    repoURL: 'https://github.com/paneron/ics-codes-registry',\n  },\n];\n\ninterface ConnectedRegistry {\n  workingCopyPath: string\n}\n"]}
+{"version":3,"file":"registry.js","sourceRoot":"","sources":["../../src/types/registry.ts"],"names":[],"mappings":"AAgBA,2BAA2B;AAE3B,MAAM,CAAC,MAAM,8BAA8B,GAAe;IACxD;QACE,EAAE,EAAE,sCAAsC;QAC1C,IAAI,EAAE,WAAW;QACjB,SAAS,EAAE,+BAA+B;QAC1C,OAAO,EAAE,+CAA+C;KACzD;CACF,CAAC","sourcesContent":["export interface Registry {\n  /** A registry is referenced by an UUID. */\n  id: string\n\n  name: string\n\n  /** HTTPS URL to Git repository holding registry source information. */\n  repoURL: string\n\n  /** URL under which the registry is made publicly available. */\n  publicURL: string\n\n  /** Data directory within the repository. */\n  dataRoot?: string\n}\n\n// TODO: What is below for?\n\nexport const KNOWN_AUTHORITATIVE_REGISTRIES: Registry[] = [\n  {\n    id: '9D546C5C-8FA4-496D-A721-6DA72E35F4A9',\n    name: 'ICS codes',\n    publicURL: 'https://ics.demo.paneron.org/',\n    repoURL: 'https://github.com/paneron/ics-codes-registry',\n  },\n];\n\nexport interface ConnectedRegistry {\n  workingCopyPath: string\n}\n"]}

package/types/stakeholder.d.ts

@@ -1,34 +1,58 @@
-export declare const STAKEHOLDER_ROLES: readonly ["owner", "manager", "submitter"];
+/** Possible roles of a register stakeholder. */
+export declare const StakeholderRole: {
+    readonly Owner: "owner";
+    readonly ControlBody: "control-body";
+    readonly Manager: "manager";
+    readonly Submitter: "submitter";
+};
+declare type StakeholderRoleType = typeof StakeholderRole[keyof typeof StakeholderRole];
+export declare const STAKEHOLDER_ROLES: StakeholderRoleType[];
+export declare function isStakeholderRole(val: string): val is StakeholderRoleType;
+/** “Abstract” register stakeholder type. */
 interface _RegisterStakeholder {
-    role: typeof STAKEHOLDER_ROLES[number];
+    role: StakeholderRoleType;
     name: string;
-    parties: Party[];
     gitServerUsername?: string;
+    parties: Party[];
+}
+interface Owner extends _RegisterStakeholder {
+    role: typeof StakeholderRole.Owner;
+}
+export declare function isOwner(val: RegisterStakeholder): val is Owner;
+interface ControlBody extends _RegisterStakeholder {
+    role: typeof StakeholderRole.ControlBody;
 }
-interface NonEditingStakeholder extends _RegisterStakeholder {
-    role: 'owner';
+export declare function isControlBody(val: RegisterStakeholder): val is ControlBody;
+interface Manager extends _RegisterStakeholder {
+    role: typeof StakeholderRole.Manager;
 }
-export interface EditingStakeholder extends _RegisterStakeholder {
-    role: 'manager' | 'submitter';
+export declare function isManager(val: RegisterStakeholder): val is Manager;
+interface Submitter extends _RegisterStakeholder {
+    role: typeof StakeholderRole.Submitter;
 }
-export declare type Individual = {
+export declare function isSubmitter(val: RegisterStakeholder): val is Submitter;
+interface Role {
     positionName: string;
-    organization?: Organization;
-} | {
+    name?: never;
+    organization: Organization;
+}
+interface Individual {
     name: string;
+    positionName?: never;
     organization?: Organization;
-};
-declare type Organization = {
+}
+declare type Organization<T = {
     logoURL: string[];
-} | {
     name: string;
-};
-declare type Party = (Individual | Organization) & {
+}> = Partial<T> & Pick<T, keyof T>;
+declare type Party = (Individual | Role | Organization) & {
     contacts: {
         label: string;
         value: string;
         notes?: string;
     }[];
 };
-export declare type RegisterStakeholder = EditingStakeholder | NonEditingStakeholder;
+export declare function isIndividualParty(val: any): val is Individual;
+export declare type RegisterStakeholder = Owner | ControlBody | Manager | Submitter;
+export declare function isRegisterStakeholder(val: any): val is RegisterStakeholder;
 export {};

package/types/stakeholder.js

@@ -3,7 +3,51 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.STAKEHOLDER_ROLES = void 0;
+exports.isStakeholderRole = isStakeholderRole;
+exports.isOwner = isOwner;
+exports.isControlBody = isControlBody;
+exports.isManager = isManager;
+exports.isSubmitter = isSubmitter;
+exports.isIndividualParty = isIndividualParty;
+exports.isRegisterStakeholder = isRegisterStakeholder;
+exports.STAKEHOLDER_ROLES = exports.StakeholderRole = void 0;
 // Stakeholders
-const STAKEHOLDER_ROLES = ['owner', 'manager', 'submitter'];
-exports.STAKEHOLDER_ROLES = STAKEHOLDER_ROLES;
+
+/** Possible roles of a register stakeholder. */
+const StakeholderRole = {
+  Owner: 'owner',
+  ControlBody: 'control-body',
+  Manager: 'manager',
+  Submitter: 'submitter'
+};
+exports.StakeholderRole = StakeholderRole;
+const STAKEHOLDER_ROLES = Object.values(StakeholderRole);
+exports.STAKEHOLDER_ROLES = STAKEHOLDER_ROLES;
+
+function isStakeholderRole(val) {
+  return STAKEHOLDER_ROLES.indexOf(val) >= 0;
+}
+
+function isOwner(val) {
+  return val.role === StakeholderRole.Owner;
+}
+
+function isControlBody(val) {
+  return val.role === StakeholderRole.ControlBody;
+}
+
+function isManager(val) {
+  return val.role === StakeholderRole.Manager;
+}
+
+function isSubmitter(val) {
+  return val.role === StakeholderRole.Submitter;
+}
+
+function isIndividualParty(val) {
+  return typeof val.name === 'string' && !val.hasOwnProperty('positionName');
+}
+
+function isRegisterStakeholder(val) {
+  return val && val.hasOwnProperty('role') && isStakeholderRole(val.role) && val.hasOwnProperty('name');
+}

package/types/stakeholder.js.map

@@ -1 +1 @@
-{"version":3,"file":"stakeholder.js","sourceRoot":"","sources":["../../src/types/stakeholder.ts"],"names":[],"mappings":"AAAA,eAAe;AAEf,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,OAAO;IACP,SAAS;IACT,WAAW;CACH,CAAC","sourcesContent":["// Stakeholders\n\nexport const STAKEHOLDER_ROLES = [\n  'owner',\n  'manager',\n  'submitter',\n] as const;\n\ninterface _RegisterStakeholder {\n  role: typeof STAKEHOLDER_ROLES[number]\n  name: string\n  parties: Party[]\n  gitServerUsername?: string\n}\ninterface NonEditingStakeholder extends _RegisterStakeholder {\n  role: 'owner'\n}\nexport interface EditingStakeholder extends _RegisterStakeholder {\n  role: 'manager' | 'submitter'\n}\n\nexport type Individual = {\n  positionName: string\n  organization?: Organization\n} | {\n  name: string\n  organization?: Organization\n}\ntype Organization = {\n  logoURL: string[]\n} | {\n  name: string\n}\ntype Party = (Individual | Organization) & {\n  contacts: { label: string, value: string, notes?: string }[]\n}\n\nexport type RegisterStakeholder = EditingStakeholder | NonEditingStakeholder\n"]}
+{"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/types/views.d.ts

@@ -1,27 +1,57 @@
 import type React from 'react';
-import type { IButtonProps } from '@blueprintjs/core';
-import type { ValueHook } from '@riboseinc/paneron-extension-kit/types';
+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';
-export interface ExtensionContext {
-    getRelatedItemClassConfiguration: (classID: string) => RelatedItemClassConfiguration;
-    useRegisterItemData: RegisterItemDataHook;
-    onJump?: () => void;
-}
+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 RegisterItemDataHook<P extends Payload = Payload> = (opts: {
-    itemPaths: string[];
-}) => ValueHook<Record<string, RegisterItem<P> | null>>;
 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;
@@ -29,6 +59,12 @@ export interface ItemClassConfiguration<P extends Payload> {
     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>;
@@ -36,47 +72,85 @@ export interface ItemClassConfiguration<P extends Payload> {
     };
 }
 export interface RegistryViewProps<Items extends ItemClassConfigurationSet = Record<string, ItemClassConfiguration<any>>> extends RegisterConfiguration<Items> {
-    subregisters?: Subregisters<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) => IButtonProps;
+    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;
-    subregisterID?: string;
-    useRegisterItemData: RegisterItemDataHook;
-    getRelatedItemClassConfiguration: ExtensionContext["getRelatedItemClassConfiguration"];
+    /** 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;
-    useRegisterItemData: RegisterItemDataHook;
-    getRelatedItemClassConfiguration: ExtensionContext["getRelatedItemClassConfiguration"];
     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> = React.FC<RegistryItemViewProps<P> & {
+export declare type ItemEditView<P extends Payload> = React.FC<RegistryItemViewProps<P> & {
     onChange?: (newData: P) => void;
     onCreateRelatedItem?: (classID: string, subregisterID?: string) => Promise<InternalItemReference>;
 }>;
-export declare type ItemDetailView<P> = React.FC<RegistryItemViewProps<P> & {
-    useRegisterItemData: RegisterItemDataHook;
-}>;
-export interface ItemListViewProps<P> extends RegistryItemViewProps<P> {
-    itemID: string;
+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> = React.FC<ItemListViewProps<P>>;
+export declare type ItemListView<P extends Payload> = React.FC<ItemListViewProps<P>>;
 export declare type LazyItemView = React.FC<{
     itemID: string;
 }>;

package/types/views.js.map

@@ -1 +1 @@
-{"version":3,"file":"views.js","sourceRoot":"","sources":["../../src/types/views.ts"],"names":[],"mappings":"","sourcesContent":["\nimport type React from 'react';\nimport type { IButtonProps } from '@blueprintjs/core';\nimport type { ValueHook } from '@riboseinc/paneron-extension-kit/types';\nimport type { InternalItemReference, Payload, RegisterItem, RegisterItemClass } from './item';\n\n\n// Extension configuration\n\nexport interface ExtensionContext {\n  getRelatedItemClassConfiguration: (classID: string) => RelatedItemClassConfiguration\n  useRegisterItemData: RegisterItemDataHook\n  onJump?: () => void\n}\n\nexport interface RegisterConfiguration<Items extends ItemClassConfigurationSet = Record<string, ItemClassConfiguration<any>>> {\n  itemClassConfiguration: Items\n}\n\nexport type Subregisters<Items extends ItemClassConfigurationSet = Record<string, ItemClassConfiguration<any>>> = {\n  [subregisterID: string]: {\n    title: string\n    itemClasses: (keyof Items)[]\n  }\n};\n\nexport type RegisterItemDataHook<P extends Payload = Payload> =\n  (opts: { itemPaths: string[] }) => ValueHook<Record<string, RegisterItem<P> | null>>;\n\nexport type ItemClassConfigurationSet = {\n  [itemClassID: string]: ItemClassConfiguration<any>\n};\n\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  itemSorter?: (a: P, b: P) => number\n\n  views: {\n    listItemView: ItemListView<P>\n    editView: ItemEditView<P>\n    detailView?: ItemDetailView<P>\n  }\n}\n\n\n// Item views\n\nexport interface RegistryViewProps\n<Items extends ItemClassConfigurationSet = Record<string, ItemClassConfiguration<any>>>\nextends RegisterConfiguration<Items> {\n  subregisters?: Subregisters<Items>\n}\n\nexport interface ItemAction {\n  getButtonProps: (item: RegisterItem<any>, itemClass: ItemClassConfiguration<any>, subregisterID?: string) => IButtonProps\n}\n\nexport type RegistryView = React.FC<RegistryViewProps>\n\ntype RegistryItemPayloadDefaults<P extends Payload> =\n  Partial<Omit<P, 'id'>>;\n\nexport type RelatedItemClassConfiguration = {\n  title: string\n  itemView: ItemListView<any>\n}\n\n\nexport interface RegistryItemViewProps<P extends Payload> {\n  itemData: P\n  className?: string\n  subregisterID?: string\n  useRegisterItemData: RegisterItemDataHook\n  getRelatedItemClassConfiguration: ExtensionContext[\"getRelatedItemClassConfiguration\"]\n}\n\nexport interface GenericRelatedItemViewProps {\n  itemRef?: InternalItemReference\n  className?: string\n  useRegisterItemData: RegisterItemDataHook\n  getRelatedItemClassConfiguration: ExtensionContext[\"getRelatedItemClassConfiguration\"]\n  availableClassIDs?: string[]\n  availableSubregisterIDs?: string[]\n  itemSorter?: ItemClassConfiguration<any>[\"itemSorter\"]\n  onCreateNew?: () => Promise<InternalItemReference>\n  onClear?: () => void\n  onChange?: (newRef: InternalItemReference) => void\n}\n\n\nexport type ItemEditView<P> = React.FC<RegistryItemViewProps<P> & {\n  onChange?: (newData: P) => void\n  onCreateRelatedItem?: (classID: string, subregisterID?: string) => Promise<InternalItemReference>\n}>;\nexport type ItemDetailView<P> = React.FC<RegistryItemViewProps<P> & {\n  useRegisterItemData: RegisterItemDataHook\n}>;\n\nexport interface ItemListViewProps<P> extends RegistryItemViewProps<P> {\n  itemID: string\n}\nexport type ItemListView<P> = React.FC<ItemListViewProps<P>>;\nexport type LazyItemView = React.FC<{ itemID: string }>;\n"]}
+{"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"]}