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

package/dist/types/cr.js

@@ -0,0 +1,175 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isSubmittedBy = isSubmittedBy;
+exports.isState = isState;
+exports.isEditableState = isEditableState;
+exports.isCreatedBy = isCreatedBy;
+exports.canBeEditedBy = canBeEditedBy;
+exports.isDrafted = isDrafted;
+exports.isProposed = isProposed;
+exports.isWithdrawn = isWithdrawn;
+exports.hadBeenProposed = hadBeenProposed;
+exports.isDisposed = isDisposed;
+exports.isAccepted = isAccepted;
+exports.isAppealed = isAppealed;
+exports.isAcceptedOnAppeal = isAcceptedOnAppeal;
+exports.hasSubmitterInput = hasSubmitterInput;
+exports.hasRegisterManagerInput = hasRegisterManagerInput;
+exports.hasControlBodyInput = hasControlBodyInput;
+exports.hasAppealRequest = hasAppealRequest;
+exports.hasRegisterOwnerInput = hasRegisterOwnerInput;
+exports.EditableState = exports.State = void 0;
+
+/** Change request types, states and state transitions. */
+function isSubmittedBy(stakeholder, cr) {
+  return (//isSubmitter(stakeholder) &&
+    stakeholder.gitServerUsername === cr.submittingStakeholderGitServerUsername
+  );
+} // =====================
+// Change request states
+// =====================
+
+/** Used in place of enum for convenience. */
+
+
+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'
+};
+exports.State = State;
+
+function isState(val) {
+  return Object.values(State).indexOf(val) >= 0;
+}
+/** A subset of `State` that represents editable states. */
+
+
+const EditableState = [State.DRAFT, State.RETURNED_FOR_CLARIFICATION];
+exports.EditableState = EditableState;
+
+function isEditableState(state) {
+  return EditableState.indexOf(state) >= 0;
+}
+
+function isCreatedBy(stakeholder, cr) {
+  return stakeholder.gitServerUsername === cr.submittingStakeholderGitServerUsername;
+}
+
+function canBeEditedBy(stakeholder, cr) {
+  return isCreatedBy(stakeholder, cr) && isEditableState(cr.state);
+}
+
+function isDrafted(cr) {
+  return isInState(cr, State.DRAFT);
+}
+
+function isProposed(cr) {
+  return isInState(cr, State.PROPOSED);
+}
+
+function isWithdrawn(cr) {
+  return isInState(cr, State.WITHDRAWN);
+}
+
+function hadBeenProposed(cr) {
+  return cr && cr.hasOwnProperty('timeProposed') && !!cr.timeProposed;
+}
+
+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);
+}
+
+function isAccepted(cr) {
+  return isInState(cr, State.ACCEPTED);
+}
+
+function isAppealed(cr) {
+  return isInState(cr, State.APPEALED);
+}
+
+function isAcceptedOnAppeal(cr) {
+  return isInState(cr, State.ACCEPTED_ON_APPEAL);
+}
+
+function hasSubmitterInput(val) {
+  return val.hasOwnProperty('justification') && typeof val.justification === 'string';
+}
+
+function hasRegisterManagerInput(val) {
+  return val.hasOwnProperty('registerManagerNotes') && typeof val.registerManagerNotes === 'string';
+}
+
+function hasControlBodyInput(val) {
+  return val.hasOwnProperty('controlBodyNotes') && typeof val.controlBodyNotes === 'string' && val.hasOwnProperty('controlBodyDecisionEvent') && typeof val.controlBodyDecisionEvent === 'string';
+}
+
+function hasAppealRequest(val) {
+  return val.hasOwnProperty('appealReason') && typeof val.appealReason === 'string';
+}
+
+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;
+}

package/dist/types/cr.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cr.js","sourceRoot":"","sources":["../../src/types/cr.ts"],"names":[],"mappings":"AAAA,0DAA0D;AAQ1D,MAAM,UAAU,aAAa,CAAC,WAAgC,EAAE,EAAQ;IACtE,OAAO;IACL,6BAA6B;IAC7B,WAAW,CAAC,iBAAiB,KAAK,EAAE,CAAC,sCAAsC,CAAC,CAAC;AACjF,CAAC;AAID,wBAAwB;AACxB,wBAAwB;AACxB,wBAAwB;AAExB,6CAA6C;AAC7C,MAAM,CAAC,MAAM,KAAK,GAAG;IACnB,KAAK,EAAE,OAAO;IACd,QAAQ,EAAE,UAAU;IACpB,iCAAiC,EAAE,6BAA6B;IAChE,0BAA0B,EAAE,4BAA4B;IACxD,SAAS,EAAE,WAAW;IACtB,QAAQ,EAAE,UAAU;IACpB,QAAQ,EAAE,UAAU;IACpB,QAAQ,EAAE,6BAA6B;IACvC,kBAAkB,EAAE,oBAAoB;IACxC,0BAA0B,EAAE,4BAA4B;IACxD,gBAAgB,EAAE,kBAAkB;CAC5B,CAAC;AAIX,MAAM,UAAU,OAAO,CAAC,GAAW;IACjC,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,GAAgB,CAAC,IAAI,CAAC,CAAC;AAC7D,CAAC;AAED,2DAA2D;AAC3D,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,KAAK,CAAC,KAAK;IACX,KAAK,CAAC,0BAA0B;CACxB,CAAC;AAIX,MAAM,UAAU,eAAe,CAAC,KAAgB;IAC9C,OAAO,aAAa,CAAC,OAAO,CAAC,KAA0B,CAAC,IAAI,CAAC,CAAC;AAChE,CAAC;AA2CD,MAAM,UAAU,WAAW,CAAC,WAAgC,EAAE,EAAQ;IACpE,OAAO,WAAW,CAAC,iBAAiB,KAAK,EAAE,CAAC,sCAAsC,CAAC;AACrF,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,WAAgC,EAAE,EAAQ;IACtE,OAAO,WAAW,CAAC,WAAW,EAAE,EAAE,CAAC,IAAI,eAAe,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;AACnE,CAAC;AAoDD,MAAM,UAAU,SAAS,CAAC,EAAQ;IAChC,OAAO,SAAS,CAAC,EAAE,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;AACpC,CAAC;AAKD,MAAM,UAAU,UAAU,CAAC,EAAQ;IACjC,OAAO,SAAS,CAAC,EAAE,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;AACvC,CAAC;AAKD,MAAM,UAAU,WAAW,CAAC,EAAQ;IAClC,OAAO,SAAS,CAAC,EAAE,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;AACxC,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,EAAQ;IACtC,OAAO,EAAE,IAAI,EAAE,CAAC,cAAc,CAAC,cAAc,CAAC,IAAI,CAAC,CAAE,EAAe,CAAC,YAAY,CAAC;AACpF,CAAC;AACD,MAAM,UAAU,UAAU,CAAC,EAAQ;IACjC,OAAO,EAAE,IAAI,EAAE,CAAC,cAAc,CAAC,cAAc,CAAC,IAAI,CAAC,CAAE,EAAe,CAAC,YAAY,CAAC;IAClF,UAAU;IACV,oBAAoB;IACpB,mBAAmB;IACnB,mBAAmB;IACnB,qCAAqC;IACrC,6BAA6B;IAC7B,8BAA8B;AAChC,CAAC;AAqBD,MAAM,UAAU,UAAU,CAAC,EAAQ;IACjC,OAAO,SAAS,CAAC,EAAE,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;AACvC,CAAC;AAWD,MAAM,UAAU,UAAU,CAAC,EAAQ;IACjC,OAAO,SAAS,CAAC,EAAE,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;AACvC,CAAC;AAWD,MAAM,UAAU,kBAAkB,CAAC,EAAQ;IACzC,OAAO,SAAS,CAAC,EAAE,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;AACjD,CAAC;AAaD,MAAM,UAAU,iBAAiB,CAAC,GAAQ;IACxC,OAAO,GAAG,CAAC,cAAc,CAAC,eAAe,CAAC,IAAI,OAAO,GAAG,CAAC,aAAa,KAAK,QAAQ,CAAC;AACtF,CAAC;AAID,MAAM,UAAU,uBAAuB,CAAC,GAAQ;IAC9C,OAAO,GAAG,CAAC,cAAc,CAAC,sBAAsB,CAAC,IAAI,OAAO,GAAG,CAAC,oBAAoB,KAAK,QAAQ,CAAC;AACpG,CAAC;AAKD,MAAM,UAAU,mBAAmB,CAAC,GAAQ;IAC1C,OAAO,CACL,GAAG,CAAC,cAAc,CAAC,kBAAkB,CAAC,IAAI,OAAO,GAAG,CAAC,gBAAgB,KAAK,QAAQ;QAClF,GAAG,CAAC,cAAc,CAAC,0BAA0B,CAAC,IAAI,OAAO,GAAG,CAAC,wBAAwB,KAAK,QAAQ,CAAC,CAAC;AACxG,CAAC;AAID,MAAM,UAAU,gBAAgB,CAAC,GAAQ;IACvC,OAAO,GAAG,CAAC,cAAc,CAAC,cAAc,CAAC,IAAI,OAAO,GAAG,CAAC,YAAY,KAAK,QAAQ,CAAC;AACpF,CAAC;AAID,MAAM,UAAU,qBAAqB,CAAC,GAAQ;IAC5C,OAAO,GAAG,CAAC,cAAc,CAAC,oBAAoB,CAAC,IAAI,OAAO,GAAG,CAAC,kBAAkB,KAAK,QAAQ,CAAC;AAChG,CAAC;AAUD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,SAAS,SAAS,CAAkB,EAAQ,EAAE,CAAc;IAC1D,OAAO,EAAE,CAAC,KAAK,KAAK,CAAC,CAAC;AACxB,CAAC","sourcesContent":["/** Change request types, states and state transitions. */\n\nimport type React from 'react';\nimport type { ProposalSet } from './proposal';\nimport { type RegisterStakeholder } from './stakeholder';\n\n\n\nexport function isSubmittedBy(stakeholder: RegisterStakeholder, cr: Base): boolean {\n  return (\n    //isSubmitter(stakeholder) &&\n    stakeholder.gitServerUsername === cr.submittingStakeholderGitServerUsername);\n}\n\n\n\n// =====================\n// Change request states\n// =====================\n\n/** Used in place of enum for convenience. */\nexport const State = {\n  DRAFT: 'draft',\n  PROPOSED: 'proposed',\n  SUBMITTED_FOR_CONTROL_BODY_REVIEW: 'pending-control-body-review',\n  RETURNED_FOR_CLARIFICATION: 'returned-for-clarification',\n  WITHDRAWN: 'withdrawn',\n  ACCEPTED: 'accepted',\n  REJECTED: 'rejected',\n  APPEALED: 'rejection-appealed-to-owner',\n  ACCEPTED_ON_APPEAL: 'accepted-on-appeal',\n  REJECTION_UPHELD_ON_APPEAL: 'rejection-upheld-on-appeal',\n  APPEAL_WITHDRAWN: 'appeal-withdrawn',\n} as const;\n\nexport type StateType = typeof State[keyof typeof State];\n\nexport function isState(val: string): val is StateType {\n  return Object.values(State).indexOf(val as StateType) >= 0;\n}\n\n/** A subset of `State` that represents editable states. */\nexport const EditableState = [\n  State.DRAFT,\n  State.RETURNED_FOR_CLARIFICATION,\n] as const;\n\nexport type EditableStateType = StateType & typeof EditableState[number];\n\nexport function isEditableState(state: StateType): state is EditableStateType {\n  return EditableState.indexOf(state as EditableStateType) >= 0;\n}\n\n\n\n// ======================\n// Change request classes\n// ======================\n\n/**\n * Base change request type.\n *\n * Note that e.g. type Base<typeof State.DRAFT> does not equal to Drafted\n * because Drafted includes additional information (namely, SubmitterInput).\n *\n * If the state of a CR matters, this type should not be used directly\n * and concrete types should be used instead.\n */\nexport interface Base<S extends StateType = StateType>\n{\n  id: string;\n  // decision: typeof Decision[keyof typeof Decision]\n  // disposition?: typeof Disposition[keyof typeof Disposition]\n  state: S;\n\n  /**\n   * Used to match against stakeholders declared in register metadata.\n   */\n  submittingStakeholderGitServerUsername: string;\n\n  items: ProposalSet;\n\n  /**\n   * Against to which register version changes were proposed.\n   */\n  registerVersion: string;\n\n  /**\n   * A link to external discussion.\n   */\n  externalDiscussionURI?: string;\n}\n\n\nexport function isCreatedBy(stakeholder: RegisterStakeholder, cr: Base): boolean {\n  return stakeholder.gitServerUsername === cr.submittingStakeholderGitServerUsername;\n}\n\nexport function canBeEditedBy(stakeholder: RegisterStakeholder, cr: Base): boolean {\n  return isCreatedBy(stakeholder, cr) && isEditableState(cr.state);\n}\n\n\n/**\n * A change request in any state.\n * Contains a superset of all possible properties, but all optional.\n * XXX: ^^^ This is a lie. Should be changed from | to & with Partial<>?\n */\nexport type SomeCR = \n  | Drafted\n  | Proposed\n  | Withdrawn\n  | ReturnedForClarificationByManager\n  | SubmittedForControlBodyReview\n  | ReturnedForClarificationByControlBody\n  | Accepted\n  | Rejected\n  | RejectionUpheld\n  | AcceptedOnAppeal\n  | RejectedWithAppealWithdrawn;\n\nexport type Withdrawable =\n  | Proposed\n  | SubmittedForControlBodyReview\n  | ReturnedForClarificationByManager\n  | ReturnedForClarificationByControlBody;\n\nexport type Proposable =\n  | Drafted\n  | ReturnedForClarificationByManager\n  | ReturnedForClarificationByControlBody;\n\nexport type SomeEditable =\n  | Drafted\n  | ReturnedForClarificationByManager\n  | ReturnedForClarificationByControlBody;\n\nexport type Disposed =\n  | Withdrawn\n  | Accepted\n  | Rejected\n  | AcceptedOnAppeal\n  | RejectionUpheld;\n\n\n// More specific change request types.\n// TODO: Refactor to avoid confusiong between current state e.g. Proposed)\n// and type (Proposed, to which all inheriting classes also conform)\n\nexport interface Drafted extends\n  SubmitterInput,\n  Base<typeof State.DRAFT> { timeStarted: Date, timeEdited: Date }\nexport function isDrafted(cr: Base): cr is Drafted {\n  return isInState(cr, State.DRAFT);\n}\n\nexport interface Proposed extends\n  Omit<Drafted, 'state'>,\n  Base<typeof State.PROPOSED> { timeProposed: Date }\nexport function isProposed(cr: Base): cr is Proposed {\n  return isInState(cr, State.PROPOSED);\n}\n\nexport interface Withdrawn extends\n  Omit<Withdrawable, 'state'>,\n  Base<typeof State.WITHDRAWN> { timeDisposed: Date }\nexport function isWithdrawn(cr: Base): cr is Withdrawn {\n  return isInState(cr, State.WITHDRAWN);\n}\n\nexport function hadBeenProposed(cr: Base): cr is Base & { timeProposed: Date } {\n  return cr && cr.hasOwnProperty('timeProposed') && !!(cr as Proposed).timeProposed;\n}\nexport function isDisposed(cr: Base): cr is Base & { timeDisposed: Date } {\n  return cr && cr.hasOwnProperty('timeDisposed') && !!(cr as Disposed).timeDisposed;\n  //return [\n  //  State.WITHDRAWN,\n  //  State.ACCEPTED,\n  //  State.REJECTED,\n  //  State.REJECTION_UPHELD_ON_APPEAL,\n  //  State.ACCEPTED_ON_APPEAL,\n  //].some(s => cr.state === s);\n}\n\nexport interface SubmittedForControlBodyReview extends\n  Omit<Proposed, 'state'>,\n  RegisterManagerInput,\n  Base<typeof State.SUBMITTED_FOR_CONTROL_BODY_REVIEW> {}\n\nexport interface ReturnedForClarificationByManager extends\n  Omit<Proposed, 'state'>,\n  RegisterManagerInput,\n  Base<typeof State.RETURNED_FOR_CLARIFICATION> {}\n\nexport interface ReturnedForClarificationByControlBody extends\n  Omit<SubmittedForControlBodyReview, 'state'>,\n  ControlBodyInput,\n  Base<typeof State.RETURNED_FOR_CLARIFICATION> {}\n\nexport interface Accepted extends\n  Omit<SubmittedForControlBodyReview, 'state'>,\n  ControlBodyInput,\n  Base<typeof State.ACCEPTED> { timeDisposed: Date }\nexport function isAccepted(cr: Base): cr is Accepted {\n  return isInState(cr, State.ACCEPTED);\n}\n\nexport interface Rejected extends\n  Omit<SubmittedForControlBodyReview, 'state'>,\n  ControlBodyInput,\n  Base<typeof State.REJECTED> { timeDisposed: Date }\n\nexport interface Appealed extends\n  Omit<Rejected, 'state' | 'timeDisposed'>,\n  AppealRequest,\n  Base<typeof State.APPEALED> { timeDisposed: undefined }\nexport function isAppealed(cr: Base): cr is Appealed {\n  return isInState(cr, State.APPEALED);\n}\n\nexport interface RejectionUpheld extends\n  Omit<Appealed, 'state' | 'timeDisposed'>,\n  RegisterOwnerInput,\n  Base<typeof State.REJECTION_UPHELD_ON_APPEAL> { timeDisposed: Date }\n\nexport interface AcceptedOnAppeal extends\n  Omit<Appealed, 'state' | 'timeDisposed'>,\n  RegisterOwnerInput,\n  Base<typeof State.ACCEPTED_ON_APPEAL> { timeDisposed: Date }\nexport function isAcceptedOnAppeal(cr: Base): cr is AcceptedOnAppeal {\n  return isInState(cr, State.ACCEPTED_ON_APPEAL);\n}\n\nexport interface RejectedWithAppealWithdrawn extends\n  Omit<Appealed, 'state' | 'timeDisposed'>,\n  Base<typeof State.APPEAL_WITHDRAWN> { timeDisposed: Date }\n\n\n\n// Input required when transitioning to different states\n\nexport interface SubmitterInput {\n  justification: string;\n}\nexport function hasSubmitterInput(val: any): val is SubmitterInput {\n  return val.hasOwnProperty('justification') && typeof val.justification === 'string';\n}\nexport interface RegisterManagerInput {\n  registerManagerNotes: string;\n}\nexport function hasRegisterManagerInput(val: any): val is RegisterManagerInput {\n  return val.hasOwnProperty('registerManagerNotes') && typeof val.registerManagerNotes === 'string';\n}\nexport interface ControlBodyInput {\n  controlBodyNotes: string;\n  controlBodyDecisionEvent: string;\n}\nexport function hasControlBodyInput(val: any): val is ControlBodyInput {\n  return (\n    val.hasOwnProperty('controlBodyNotes') && typeof val.controlBodyNotes === 'string' &&\n    val.hasOwnProperty('controlBodyDecisionEvent') && typeof val.controlBodyDecisionEvent === 'string');\n}\nexport interface AppealRequest {\n  appealReason: string;\n}\nexport function hasAppealRequest(val: any): val is AppealRequest {\n  return val.hasOwnProperty('appealReason') && typeof val.appealReason === 'string';\n}\nexport interface RegisterOwnerInput {\n  registerOwnerNotes: string;\n}\nexport function hasRegisterOwnerInput(val: any): val is RegisterOwnerInput {\n  return val.hasOwnProperty('registerOwnerNotes') && typeof val.registerOwnerNotes === 'string';\n}\n\nexport type StateInput =\n  | SubmitterInput\n  | RegisterManagerInput\n  | ControlBodyInput\n  | AppealRequest\n  | RegisterOwnerInput;\n\n\n/** \n * CR type guard helper.\n * Normally you would not use it directly and instead use\n * more specific is[Type]() helper from this module.\n *\n * Checks CR type using the `state` property.\n * Does not validate other properties.\n *\n * Usage:\n *\n * @example\n * ```ts\n * let someCR;\n * if (isInState<Drafted>(someCR, State.DRAFT)) {\n *   // Can assume someCR is Drafted\n * }\n * ```\n *\n * It’ll try to tell you if you mismatch those.\n *\n * @example\n * Will not compile:\n * ```ts\n * let someCR;\n * if (isInState<Drafted>(someCR, State.PROPOSED)) {\n *   // Compile error\n *   // because State.PROPOSED is not a possible value of Drafted[\"state\"]\n * }\n * ```\n *\n * @example\n * Incorrect usage (do not do this):\n * ```ts\n * let someCR;\n * if (isInState(someCR, State.DRAFT)) {\n *   // Can NOT assume someCR is Drafted\n *   // The compiler must know the expected concrete CR type\n * }\n * ```\n */\nfunction isInState<CR extends Base>(cr: Base, s: CR[\"state\"]): cr is CR {\n  return cr.state === s;\n}\n\n\n\n\n// ===========\n// Transitions\n// ===========\n\n/**\n * A function that transitions CR1 to CR2.\n *\n * The function is declared to return the object\n * without the `state` field, it is set\n * by common wrapper function to reduce duplication.\n */\nexport type Transition<\n  /** From CR of this subtype */\n  CR1 extends Base,\n  /** To CR of this subtype */\n  CR2 extends Base,\n  /** Using this extra information */\n  P extends Record<string, any> | null = null,\n> = (cr: CR1, payload: P) => Omit<CR2, 'state'>;\n\n\n/**\n * Describes a transition.\n *\n * @typeParam CR1: Change request source state type\n * @typeParam CR2: Change request target state type\n * @typeParam P: Extra input needed to transition, if any\n */\nexport interface TransitionConfig<CR1 extends Base, CR2 extends Base, P extends Record<string, any> | null = null> {\n  /**\n   * Function that implements the transition.\n   * Takes a CR in the original state and returns CR in the new state.\n   * Additionally, takes appropriate payload, if any, for the transition\n   * (e.g., register manager or control body notes).\n   *\n   * For function implementor:\n   *\n   * - Function MUST NOT modify CR in place.\n   * - Function should throw if submitted payload does not conform to requirements.\n   */\n  func: Transition<CR1, CR2, P>;\n\n  targetState: CR2[\"state\"];\n\n  /** Title. Use verb. */\n  title: string;\n\n  hint?: string | JSX.Element;\n\n  /** Widget that can be used to view or enter extra input. */\n  Widget: P extends null ? null : React.FC<{ value: P, onChange?: (userInput: P) => void }>;\n\n  /**\n   * Function that returns true\n   * if given stakeholder can perform this transition on given CR.\n   */\n  canBeTransitionedBy: (stakeholder: RegisterStakeholder, cr: CR1) => boolean;\n}\n\n\n// type TransitionSpec = {\n//   [S1 in StateType]?: {\n//     [S2 in StateType]?: Transition<Base<S1>, Base<S2>, Record<string, any>>\n//   }\n// }\n\n\n/**\n * Source of truth for available transitions.\n * When updating change request business logic,\n * this is the type that should be modified.\n *\n * It will cause compile errors until transition implementation\n * is updated correspondingly.\n */\nexport type Transitions = {\n  [State.DRAFT]: {\n    // [State.DRAFT]:\n    //   TransitionConfig<Drafted, Drafted, SubmitterInput>;\n    [State.PROPOSED]:\n      TransitionConfig<Drafted, Proposed, SubmitterInput>;\n  };\n  [State.PROPOSED]: {\n    [State.WITHDRAWN]:\n      TransitionConfig<Proposed, Withdrawn>;\n    [State.SUBMITTED_FOR_CONTROL_BODY_REVIEW]:\n      TransitionConfig<Proposed, SubmittedForControlBodyReview, RegisterManagerInput>;\n    [State.RETURNED_FOR_CLARIFICATION]:\n      TransitionConfig<Proposed, ReturnedForClarificationByManager, RegisterManagerInput>;\n  };\n  [State.SUBMITTED_FOR_CONTROL_BODY_REVIEW]: {\n    [State.WITHDRAWN]:\n      TransitionConfig<SubmittedForControlBodyReview, Withdrawn>;\n    [State.RETURNED_FOR_CLARIFICATION]:\n      TransitionConfig<SubmittedForControlBodyReview, ReturnedForClarificationByControlBody, ControlBodyInput>;\n    [State.REJECTED]:\n      TransitionConfig<SubmittedForControlBodyReview, Rejected, ControlBodyInput>;\n    [State.ACCEPTED]:\n      TransitionConfig<SubmittedForControlBodyReview, Accepted, ControlBodyInput>;\n  };\n  [State.RETURNED_FOR_CLARIFICATION]: {\n    [State.PROPOSED]:\n      TransitionConfig<ReturnedForClarificationByManager | ReturnedForClarificationByControlBody, Proposed, SubmitterInput>;\n    [State.WITHDRAWN]:\n      TransitionConfig<ReturnedForClarificationByManager | ReturnedForClarificationByControlBody, Withdrawn>;\n  };\n  [State.REJECTED]: {\n    [State.APPEALED]:\n      TransitionConfig<Rejected, Appealed, AppealRequest>;\n  };\n  [State.APPEALED]: {\n    [State.APPEAL_WITHDRAWN]:\n      TransitionConfig<Appealed, RejectedWithAppealWithdrawn>;\n    [State.ACCEPTED_ON_APPEAL]:\n      TransitionConfig<Appealed, AcceptedOnAppeal, RegisterOwnerInput>;\n    [State.REJECTION_UPHELD_ON_APPEAL]:\n      TransitionConfig<Appealed, RejectionUpheld, RegisterOwnerInput>;\n  };\n}\n"]}

package/dist/types/index.d.ts

@@ -0,0 +1,7 @@
+export * from './views';
+export * from './register';
+export * from './registry';
+export * from './item';
+export * from './stakeholder';
+export * from './proposal';
+export * from './util';

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

@@ -8,6 +8,7 @@ var _views = require("./views");
 
 Object.keys(_views).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _views[key]) return;
   Object.defineProperty(exports, key, {
     enumerable: true,
     get: function () {
@@ -20,6 +21,7 @@ var _register = require("./register");
 
 Object.keys(_register).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _register[key]) return;
   Object.defineProperty(exports, key, {
     enumerable: true,
     get: function () {
@@ -28,10 +30,24 @@ Object.keys(_register).forEach(function (key) {
   });
 });
 
+var _registry = require("./registry");
+
+Object.keys(_registry).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _registry[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _registry[key];
+    }
+  });
+});
+
 var _item = require("./item");
 
 Object.keys(_item).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _item[key]) return;
   Object.defineProperty(exports, key, {
     enumerable: true,
     get: function () {
@@ -44,6 +60,7 @@ var _stakeholder = require("./stakeholder");
 
 Object.keys(_stakeholder).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _stakeholder[key]) return;
   Object.defineProperty(exports, key, {
     enumerable: true,
     get: function () {
@@ -56,6 +73,7 @@ var _proposal = require("./proposal");
 
 Object.keys(_proposal).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _proposal[key]) return;
   Object.defineProperty(exports, key, {
     enumerable: true,
     get: function () {
@@ -68,6 +86,7 @@ var _util = require("./util");
 
 Object.keys(_util).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _util[key]) return;
   Object.defineProperty(exports, key, {
     enumerable: true,
     get: function () {

package/dist/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,QAAQ,CAAC;AACvB,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,QAAQ,CAAC","sourcesContent":["export * from './views';\nexport * from './register';\nexport * from './registry';\nexport * from './item';\nexport * from './stakeholder';\nexport * from './proposal';\nexport * from './util';\n"]}

package/dist/types/item.d.ts

@@ -0,0 +1,59 @@
+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];
+export interface RegisterItemID {
+    classID: string;
+    itemID: string;
+}
+export interface RegisterItemClass {
+    id: string;
+    title: string;
+    description?: string;
+    alternativeNames?: LocalizedAlternative<string>[];
+}
+export interface RegisterItemRevision<P extends Payload> {
+    timestamp: Date;
+    parents: string[];
+    status: ItemStatus;
+    data: P;
+    author: RegisterStakeholder;
+}
+interface ItemReference {
+    registerID: string;
+    subregisterID?: string;
+    classID: string;
+    itemID: string;
+}
+export declare type InternalItemReference = Omit<ItemReference, 'registerID'>;
+export declare function isInternalItemReference(val: any): val is InternalItemReference;
+interface AbstractItemSource {
+    type: string;
+}
+interface PaneronRegisterItemSource extends AbstractItemSource {
+    type: 'paneron_register';
+    itemRef: ItemReference;
+}
+interface ExternalSource extends AbstractItemSource {
+    type: 'external';
+    citation: Citation;
+}
+declare type RegisterItemSource = PaneronRegisterItemSource | ExternalSource;
+export interface RegisterItem<P extends Payload> {
+    id: 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/dist/types/item.js

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+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/dist/types/item.js.map

@@ -0,0 +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;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/dist/types/proposal.d.ts

@@ -0,0 +1,64 @@
+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: ProposalSet;
+    id: string;
+    timeStarted: Date;
+    timeProposed?: Date;
+    timeDisposed?: Date;
+    sponsor: RegisterStakeholder;
+    status: typeof DECISION_STATUSES[number];
+    disposition?: typeof DISPOSITION_OPTIONS[number];
+    controlBodyDecisionEvent?: string;
+    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[];
+}
+export interface Addition extends BaseProposal {
+    type: 'addition';
+}
+export interface Clarification extends BaseProposal {
+    type: 'clarification';
+}
+export declare const AMENDMENT_TYPES: readonly ["supersession", "retirement", "invalidation"];
+interface BaseAmendment extends BaseProposal {
+    type: 'amendment';
+    amendmentType: typeof AMENDMENT_TYPES[number];
+}
+export interface Retirement extends BaseAmendment {
+    amendmentType: 'retirement';
+}
+export interface Supersession extends BaseAmendment {
+    amendmentType: 'supersession';
+    supersedingItemIDs: string[];
+}
+export interface Invalidation extends BaseAmendment {
+    amendmentType: 'invalidation';
+}
+export declare type Amendment = Supersession | Retirement | Invalidation;
+export declare type ChangeProposal = Amendment | Clarification | Addition;
+export {};

package/{types → dist/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/dist/types/proposal.js.map

@@ -0,0 +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;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/dist/types/register.d.ts

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

package/dist/types/register.js

@@ -0,0 +1,23 @@
+"use strict";
+
+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/dist/types/register.js.map

@@ -0,0 +1 @@
+{"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/dist/types/registry.d.ts

@@ -0,0 +1,15 @@
+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;
+}
+export declare const KNOWN_AUTHORITATIVE_REGISTRIES: Registry[];
+export interface ConnectedRegistry {
+    workingCopyPath: string;
+}

package/dist/types/registry.js

@@ -0,0 +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/dist/types/registry.js.map

@@ -0,0 +1 @@
+{"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/dist/types/stakeholder.d.ts

@@ -0,0 +1,58 @@
+/** 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: StakeholderRoleType;
+    name: string;
+    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;
+}
+export declare function isControlBody(val: RegisterStakeholder): val is ControlBody;
+interface Manager extends _RegisterStakeholder {
+    role: typeof StakeholderRole.Manager;
+}
+export declare function isManager(val: RegisterStakeholder): val is Manager;
+interface Submitter extends _RegisterStakeholder {
+    role: typeof StakeholderRole.Submitter;
+}
+export declare function isSubmitter(val: RegisterStakeholder): val is Submitter;
+interface Role {
+    positionName: string;
+    name?: never;
+    organization: Organization;
+}
+interface Individual {
+    name: string;
+    positionName?: never;
+    organization?: Organization;
+}
+declare type Organization<T = {
+    logoURL: string[];
+    name: string;
+}> = Partial<T> & Pick<T, keyof T>;
+declare type Party = (Individual | Role | Organization) & {
+    contacts: {
+        label: string;
+        value: string;
+        notes?: string;
+    }[];
+};
+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/dist/types/stakeholder.js

@@ -0,0 +1,53 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+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
+
+/** 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');
+}