@riboseinc/paneron-registry-kit 2.2.58 → 2.2.60

package/dist/proposals/types.d.ts

@@ -0,0 +1,332 @@
+/**
+ * Proposals, group proposals,
+ * group proposal states and state transitions.
+ */
+import type React from 'react';
+import type { DatasetContext } from '@riboseinc/paneron-extension-kit/types/renderer';
+import type { InternalItemReference, Payload, RegisterItem } from '../types';
+import type { RegisterStakeholder } from '../types/stakeholder';
+import type { Citation } from '../types/util';
+/**
+ * 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 `/<classID>/<itemID>.yaml`.
+ * (the `[/subregisterID]/<classID>/<itemID>.yaml` is acceptable
+ * but deprecated, as subregisters are deprecated).
+ */
+export declare type ProposalSet = {
+    [objectPath: string]: ChangeProposal;
+};
+export declare const ChangeProposalType: {
+    readonly ADDITION: "addition";
+    readonly CLARIFICATION: "clarification";
+    readonly AMENDMENT: "amendment";
+};
+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: typeof ChangeProposalType.ADDITION;
+}
+export interface Clarification extends BaseProposal {
+    type: typeof ChangeProposalType.CLARIFICATION;
+}
+export declare const AmendmentType: {
+    readonly SUPERSESSION: "supersession";
+    readonly RETIREMENT: "retirement";
+    readonly INVALIDATION: "invalidation";
+};
+export declare type AmendmentTypeType = typeof AmendmentType[keyof typeof AmendmentType];
+export declare const AMENDMENT_TYPES: readonly ["supersession", "retirement", "invalidation"];
+interface BaseAmendment extends BaseProposal {
+    type: typeof ChangeProposalType.AMENDMENT;
+    amendmentType: AmendmentTypeType;
+}
+export interface Retirement extends BaseAmendment {
+    amendmentType: typeof AmendmentType.RETIREMENT;
+}
+export interface Supersession extends BaseAmendment {
+    amendmentType: typeof AmendmentType.SUPERSESSION;
+    supersedingItemIDs: string[];
+}
+export interface Invalidation extends BaseAmendment {
+    amendmentType: typeof AmendmentType.INVALIDATION;
+}
+export declare type Amendment = Supersession | Retirement | Invalidation;
+export declare type ChangeProposal = Amendment | Clarification | Addition;
+export declare function isBaseProposal(val: any): val is BaseProposal;
+export declare function isProposal(val: any): val is ChangeProposal;
+export declare function isAddition(val: BaseProposal): val is Addition;
+export declare function isClarification(val: BaseProposal): val is Clarification;
+export declare function isBaseAmendment(val: BaseProposal): val is BaseAmendment;
+export declare function isAmendment(val: any): val is Amendment;
+export declare function isRetirement(val: BaseAmendment): val is Retirement;
+export declare function isSupersession(val: BaseAmendment): val is Supersession;
+export declare function isInvalidation(val: BaseAmendment): val is Invalidation;
+export declare function isSubmittedBy(stakeholder: RegisterStakeholder, cr: Base): boolean;
+declare type ItemDataset = Record<string, RegisterItem<any> | null>;
+/** Used in place of enum for convenience. */
+export declare const State: {
+    readonly DRAFT: "draft";
+    readonly PROPOSED: "proposed";
+    readonly SUBMITTED_FOR_CONTROL_BODY_REVIEW: "pending-control-body-review";
+    readonly RETURNED_FOR_CLARIFICATION: "returned-for-clarification";
+    readonly WITHDRAWN: "withdrawn";
+    readonly ACCEPTED: "accepted";
+    readonly REJECTED: "rejected";
+    readonly APPEALED: "rejection-appealed-to-owner";
+    readonly ACCEPTED_ON_APPEAL: "accepted-on-appeal";
+    readonly REJECTION_UPHELD_ON_APPEAL: "rejection-upheld-on-appeal";
+    readonly APPEAL_WITHDRAWN: "appeal-withdrawn";
+};
+export declare type StateType = typeof State[keyof typeof State];
+export declare function isState(val: string): val is StateType;
+/** A subset of `State` that represents editable states. */
+export declare const EditableState: readonly ["draft", "returned-for-clarification"];
+export declare type EditableStateType = StateType & typeof EditableState[number];
+export declare function isEditableState(state: StateType): state is EditableStateType;
+/**
+ * Base change request type.
+ *
+ * Note that e.g. type Base<typeof State.DRAFT> does not equal to Drafted
+ * because Drafted includes additional information (namely, SubmitterInput).
+ *
+ * If the state of a CR matters, this type should not be used directly
+ * and concrete types should be used instead.
+ */
+export interface Base<S extends StateType = StateType> {
+    id: string;
+    state: S;
+    /**
+     * Used to match against stakeholders declared in register metadata.
+     */
+    submittingStakeholderGitServerUsername: string;
+    items: ProposalSet;
+    /**
+     * Against which register version changes were proposed.
+     */
+    registerVersion: string;
+    /**
+     * A link to external discussion.
+     */
+    externalDiscussionURI?: string;
+    pastTransitions?: TransitionEntry[];
+}
+export interface TransitionEntry {
+    /** Verb in past tense. */
+    label: string;
+    timestamp: Date;
+    fromState: StateType;
+    toState: StateType;
+    stakeholder: RegisterStakeholder;
+    input: StateInput;
+}
+export declare function isCreatedBy(stakeholder: RegisterStakeholder, cr: Base): boolean;
+/** Whether given `cr` can be edited (as in, items changed) by specified stakeholder. */
+export declare function canBeEditedBy(stakeholder: RegisterStakeholder, cr: Base): boolean;
+/**
+ * Whether given `cr` can be deleted by given stakeholder.
+ * Unlike editing, deletion is possible only if there are no items
+ * and CR was never proposed.
+ */
+export declare function canBeDeletedBy(stakeholder: RegisterStakeholder, cr: Base): boolean;
+/** Proposal structure for single-file proposal import format. */
+export interface ImportableCR {
+    /** Proposal data. */
+    proposalDraft: Drafted;
+    /** Register item data for additions & clarifications. */
+    itemPayloads: ItemDataset;
+}
+export declare function isImportableCR(val: any): val is ImportableCR;
+/**
+ * A change request in any state.
+ * Contains a superset of all possible properties, but all optional.
+ * XXX: ^^^ This is a lie. Should be changed from | to & with Partial<>?
+ */
+export declare type SomeCR = Drafted | Proposed | Withdrawn | ReturnedForClarificationByManager | SubmittedForControlBodyReview | ReturnedForClarificationByControlBody | Accepted | Rejected | RejectionUpheld | AcceptedOnAppeal | RejectedWithAppealWithdrawn;
+export declare type Withdrawable = Proposed | SubmittedForControlBodyReview | ReturnedForClarificationByManager | ReturnedForClarificationByControlBody;
+export declare type Proposable = Drafted | ReturnedForClarificationByManager | ReturnedForClarificationByControlBody;
+export declare type SomeEditable = Drafted | ReturnedForClarificationByManager | ReturnedForClarificationByControlBody;
+export declare type Disposed = Withdrawn | Accepted | Rejected | AcceptedOnAppeal | RejectionUpheld;
+export interface Drafted extends SubmitterInput, Base<typeof State.DRAFT> {
+    timeStarted: Date;
+    timeEdited: Date;
+}
+export declare function isDrafted(cr: Base): cr is Drafted;
+export interface Proposed extends Omit<Drafted, 'state'>, Base<typeof State.PROPOSED> {
+    timeProposed: Date;
+}
+export declare function isProposed(cr: Base): cr is Proposed;
+export interface Withdrawn extends Omit<Withdrawable, 'state'>, Base<typeof State.WITHDRAWN> {
+    timeDisposed: Date;
+}
+export declare function isWithdrawn(cr: Base): cr is Withdrawn;
+/** CR was proposed at least once. */
+export declare function hadBeenProposed(cr: Base): cr is Base & {
+    timeProposed: Date;
+};
+export declare function hadBeenAccepted(cr: Base): cr is Accepted | AcceptedOnAppeal;
+/** A proposal that had been disposed is not pending, not actionable. */
+export declare function isDisposed(cr: Base): cr is Base & {
+    timeDisposed: Date;
+};
+export interface SubmittedForControlBodyReview extends Omit<Proposed, 'state'>, RegisterManagerInput, Base<typeof State.SUBMITTED_FOR_CONTROL_BODY_REVIEW> {
+}
+export declare function isSubmittedForControlBodyReview(cr: Base): cr is SubmittedForControlBodyReview;
+export interface ReturnedForClarificationByManager extends Omit<Proposed, 'state'>, RegisterManagerInput, Base<typeof State.RETURNED_FOR_CLARIFICATION> {
+}
+export interface ReturnedForClarificationByControlBody extends Omit<SubmittedForControlBodyReview, 'state'>, ControlBodyInput, Base<typeof State.RETURNED_FOR_CLARIFICATION> {
+}
+export declare function isReturnedForClarification(cr: Base): cr is (ReturnedForClarificationByManager | ReturnedForClarificationByControlBody);
+export interface Accepted extends Omit<SubmittedForControlBodyReview, 'state'>, ControlBodyInput, Base<typeof State.ACCEPTED> {
+    timeDisposed: Date;
+}
+export declare function isAccepted(cr: Base): cr is Accepted;
+export interface Rejected extends Omit<SubmittedForControlBodyReview, 'state'>, ControlBodyInput, Base<typeof State.REJECTED> {
+    timeDisposed: Date;
+}
+export declare function isRejected(cr: Base): cr is Rejected;
+export interface Appealed extends Omit<Rejected, 'state' | 'timeDisposed'>, AppealRequest, Base<typeof State.APPEALED> {
+    timeDisposed: undefined;
+}
+export declare function isAppealed(cr: Base): cr is Appealed;
+export interface RejectionUpheld extends Omit<Appealed, 'state' | 'timeDisposed'>, RegisterOwnerInput, Base<typeof State.REJECTION_UPHELD_ON_APPEAL> {
+    timeDisposed: Date;
+}
+export declare function isRejectedOnAppeal(cr: Base): cr is RejectionUpheld;
+export interface AcceptedOnAppeal extends Omit<Appealed, 'state' | 'timeDisposed'>, RegisterOwnerInput, Base<typeof State.ACCEPTED_ON_APPEAL> {
+    timeDisposed: Date;
+}
+export declare function isAcceptedOnAppeal(cr: Base): cr is AcceptedOnAppeal;
+export interface RejectedWithAppealWithdrawn extends Omit<Appealed, 'state' | 'timeDisposed'>, Base<typeof State.APPEAL_WITHDRAWN> {
+    timeDisposed: Date;
+}
+export declare function isRejectedWithAppealWithdrawn(cr: Base): cr is RejectedWithAppealWithdrawn;
+export interface SubmitterInput {
+    justification: string;
+}
+export declare function hasSubmitterInput(val: any): val is SubmitterInput;
+export interface RegisterManagerInput {
+    registerManagerNotes: string;
+}
+export declare function hasRegisterManagerInput(val: any): val is RegisterManagerInput;
+export interface ControlBodyInput {
+    controlBodyDecisionEvent: string;
+}
+export declare function hasControlBodyInput(val: any): val is ControlBodyInput;
+export interface AppealRequest {
+    appealReason: string;
+}
+export declare function hasAppealRequest(val: any): val is AppealRequest;
+export interface RegisterOwnerInput {
+    registerOwnerNotes: string;
+}
+export declare function hasRegisterOwnerInput(val: any): val is RegisterOwnerInput;
+export declare type StateInput = SubmitterInput | RegisterManagerInput | ControlBodyInput | AppealRequest | RegisterOwnerInput;
+/**
+ * A function that transitions CR1 to CR2.
+ *
+ * The function is declared to return the object
+ * without the `state` field, it is set
+ * by common wrapper function to reduce duplication.
+ */
+export declare type Transition<
+/** From CR of this subtype */
+CR1 extends Base, 
+/** To CR of this subtype */
+CR2 extends Base, 
+/** Using this extra information */
+P extends Record<string, any> | null = null> = (cr: CR1, payload: P) => Omit<CR2, 'state'>;
+export declare type AlterApprovedCR = (crID: string, proposals: ProposalSet, origItemData: ItemDataset, newItemData: ItemDataset, opts: Pick<DatasetContext, 'getMapReducedData'>) => Promise<{
+    proposals: ProposalSet;
+    origItemData: ItemDataset;
+    newItemData: ItemDataset;
+}>;
+/**
+ * Describes a transition.
+ *
+ * @typeParam CR1: Change request source state type
+ * @typeParam CR2: Change request target state type
+ * @typeParam P: Extra input needed to transition, if any
+ */
+export interface TransitionConfig<CR1 extends Base, CR2 extends Base, P extends Record<string, any> | null = null> {
+    /**
+     * Function that implements the transition.
+     * Takes a CR in the original state and returns CR in the new state.
+     * Additionally, takes appropriate payload, if any, for the transition
+     * (e.g., register manager or control body notes).
+     *
+     * For function implementor:
+     *
+     * - Function MUST NOT modify CR in place.
+     * - Function should throw if submitted payload does not conform to requirements.
+     */
+    func: Transition<CR1, CR2, P>;
+    targetState: CR2["state"];
+    /** Title. Use verb. */
+    title: string;
+    hint?: string | JSX.Element;
+    /** Widget that can be used to view or enter extra input. */
+    Widget: P extends null ? null : React.FC<{
+        value: P;
+        onChange?: (userInput: P) => void;
+    }>;
+    /**
+     * Function that returns true
+     * if given stakeholder can perform this transition on given CR.
+     */
+    canBeTransitionedBy: (stakeholder: RegisterStakeholder, cr: CR1) => boolean;
+}
+/**
+ * Source of truth for available transitions.
+ * When updating change request business logic,
+ * this is the type that should be modified.
+ *
+ * It will cause compile errors until transition implementation
+ * is updated correspondingly.
+ */
+export declare type Transitions = {
+    [State.DRAFT]: {
+        [State.WITHDRAWN]: TransitionConfig<Proposed, Withdrawn>;
+        [State.PROPOSED]: TransitionConfig<Drafted, Proposed, SubmitterInput>;
+    };
+    [State.PROPOSED]: {
+        [State.WITHDRAWN]: TransitionConfig<Proposed, Withdrawn>;
+        [State.SUBMITTED_FOR_CONTROL_BODY_REVIEW]: TransitionConfig<Proposed, SubmittedForControlBodyReview, RegisterManagerInput>;
+        [State.RETURNED_FOR_CLARIFICATION]: TransitionConfig<Proposed, ReturnedForClarificationByManager, RegisterManagerInput>;
+    };
+    [State.SUBMITTED_FOR_CONTROL_BODY_REVIEW]: {
+        [State.WITHDRAWN]: TransitionConfig<SubmittedForControlBodyReview, Withdrawn>;
+        [State.RETURNED_FOR_CLARIFICATION]: TransitionConfig<SubmittedForControlBodyReview, ReturnedForClarificationByControlBody, ControlBodyInput>;
+        [State.REJECTED]: TransitionConfig<SubmittedForControlBodyReview, Rejected, ControlBodyInput>;
+        [State.ACCEPTED]: TransitionConfig<SubmittedForControlBodyReview, Accepted, ControlBodyInput>;
+    };
+    [State.RETURNED_FOR_CLARIFICATION]: {
+        [State.PROPOSED]: TransitionConfig<ReturnedForClarificationByManager | ReturnedForClarificationByControlBody, Proposed, SubmitterInput>;
+        [State.WITHDRAWN]: TransitionConfig<ReturnedForClarificationByManager | ReturnedForClarificationByControlBody, Withdrawn>;
+    };
+    [State.REJECTED]: {
+        [State.APPEALED]: TransitionConfig<Rejected, Appealed, AppealRequest>;
+    };
+    [State.APPEALED]: {
+        [State.APPEAL_WITHDRAWN]: TransitionConfig<Appealed, RejectedWithAppealWithdrawn>;
+        [State.ACCEPTED_ON_APPEAL]: TransitionConfig<Appealed, AcceptedOnAppeal, RegisterOwnerInput>;
+        [State.REJECTION_UPHELD_ON_APPEAL]: TransitionConfig<Appealed, RejectionUpheld, RegisterOwnerInput>;
+    };
+};
+export interface ProposalProps<P extends ChangeProposal> {
+    proposal: P;
+    /** Highlight changes. */
+    showDiff?: boolean;
+    /** In diff mode, only show changed data. (Provisional.) */
+    showOnlyChanged?: boolean;
+    itemRef: InternalItemReference;
+    item: RegisterItem<Payload>;
+    itemBefore: P extends Clarification ? RegisterItem<Payload> : undefined;
+    onChange?: (newProposal: P) => void;
+}
+export {};

package/dist/proposals/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/proposals/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AA8BH,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,QAAQ,EAAE,UAAU;IACpB,aAAa,EAAE,eAAe;IAC9B,SAAS,EAAE,WAAW;CACd,CAAC;AACX,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,kBAAkB,CAAC,QAAQ;IAC3B,kBAAkB,CAAC,aAAa;IAChC,kBAAkB,CAAC,SAAS;CACpB,CAAC;AAqBX,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,YAAY,EAAE,cAAc;IAC5B,UAAU,EAAE,YAAY;IACxB,YAAY,EAAE,cAAc;CACpB,CAAC;AAEX,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,aAAa,CAAC,YAAY;IAC1B,aAAa,CAAC,UAAU;IACxB,aAAa,CAAC,YAAY;CAClB,CAAC;AAoBX,MAAM,UAAU,cAAc,CAAC,GAAQ;IACrC,OAAO,cAAc,CAAC,OAAO,CAAC,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,IAAI,CAAC,IAAI,CAAC,CAAC;AAChD,CAAC;AACD,MAAM,UAAU,UAAU,CAAC,GAAQ;IACjC,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAC7B,UAAU,CAAC,GAAG,CAAC;WACZ,eAAe,CAAC,GAAG,CAAC;WACpB,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AAC1B,CAAC;AACD,MAAM,UAAU,UAAU,CAAC,GAAiB;IAC1C,OAAO,CAAC,GAAG,CAAC,IAAI,KAAK,kBAAkB,CAAC,QAAQ,CAAC,CAAC;AACpD,CAAC;AACD,MAAM,UAAU,eAAe,CAAC,GAAiB;IAC/C,OAAO,CAAC,GAAG,CAAC,IAAI,KAAK,kBAAkB,CAAC,aAAa,CAAC,CAAC;AACzD,CAAC;AACD,MAAM,UAAU,eAAe,CAAC,GAAiB;IAC/C,OAAO,CACL,GAAG,CAAC,IAAI,KAAK,kBAAkB,CAAC,SAAS;WACtC,eAAe,CAAC,OAAO,CAAE,GAAiB,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC;AACvE,CAAC;AACD,MAAM,UAAU,WAAW,CAAC,GAAQ;IAClC,OAAO,CAAC,eAAe,CAAC,GAAG,CAAC,IAAI,CAC9B,YAAY,CAAC,GAAG,CAAC;WACd,cAAc,CAAC,GAAG,CAAC;WACnB,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AAC7B,CAAC;AACD,MAAM,UAAU,YAAY,CAAC,GAAkB;IAC7C,OAAO,GAAG,CAAC,aAAa,KAAK,aAAa,CAAC,UAAU,CAAC;AACxD,CAAC;AACD,MAAM,UAAU,cAAc,CAAC,GAAkB;IAC/C,OAAO,GAAG,CAAC,aAAa,KAAK,aAAa,CAAC,YAAY,CAAC;AAC1D,CAAC;AACD,MAAM,UAAU,cAAc,CAAC,GAAkB;IAC/C,OAAO,GAAG,CAAC,aAAa,KAAK,aAAa,CAAC,YAAY,CAAC;AAC1D,CAAC;AAGD,sDAAsD;AAEtD,MAAM,UAAU,aAAa,CAAC,WAAgC,EAAE,EAAQ;IACtE,OAAO;IACL,6BAA6B;IAC7B,WAAW,CAAC,iBAAiB,KAAK,EAAE,CAAC,sCAAsC,CAAC,CAAC;AACjF,CAAC;AAMD,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;AAyDD,MAAM,UAAU,WAAW,CAAC,WAAgC,EAAE,EAAQ;;IACpE,OAAO,CAAA,MAAA,WAAW,CAAC,iBAAiB,0CAAE,IAAI,EAAE,MAAK,EAAE,IAAI,WAAW,CAAC,iBAAiB,KAAK,EAAE,CAAC,sCAAsC,CAAC;AACrI,CAAC;AAED,wFAAwF;AACxF,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;AAED;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAC,WAAgC,EAAE,EAAQ;IACvE,OAAO,CACL,WAAW,CAAC,WAAW,EAAE,EAAE,CAAC;WACzB,SAAS,CAAC,EAAE,CAAC;QAChB,sEAAsE;WACnE,CAAC,eAAe,CAAC,EAAE,CAAC,CAAE,2DAA2D;KACrF,CAAC;AACJ,CAAC;AAWD,MAAM,UAAU,cAAc,CAAC,GAAQ;IACrC,4BAA4B;IAC5B,OAAO,CACL,GAAG,CAAC,aAAa,CAAC,EAAE;WACjB,SAAS,CAAC,GAAG,CAAC,aAAqB,CAAC;WACpC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;AACjD,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,qCAAqC;AACrC,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,eAAe,CAAC,EAAQ;IACtC,OAAO,UAAU,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,IAAI,kBAAkB,CAAC,EAAE,CAAC,CAAC,CAAC;AACtE,CAAC;AACD,wEAAwE;AACxE,MAAM,UAAU,UAAU,CAAC,EAAQ;IACjC,OAAO,EAAE,IAAI,EAAE,CAAC,cAAc,CAAC,cAAc,CAAC,IAAI,CAAC,CAAE,EAAe,CAAC,YAAY,CAAC;IAClF,oCAAoC;IACpC,UAAU;IACV,oBAAoB;IACpB,mBAAmB;IACnB,mBAAmB;IACnB,qCAAqC;IACrC,6BAA6B;IAC7B,8BAA8B;AAChC,CAAC;AAOD,MAAM,UAAU,+BAA+B,CAAC,EAAQ;IACtD,OAAO,SAAS,CAAC,EAAE,EAAE,KAAK,CAAC,iCAAiC,CAAC,CAAA;AAC/D,CAAC;AAYD,MAAM,UAAU,0BAA0B,CAAC,EAAQ;IACjD,OAAO,SAAS,CAAC,EAAE,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAA;AACxD,CAAC;AAMD,MAAM,UAAU,UAAU,CAAC,EAAQ;IACjC,OAAO,SAAS,CAAC,EAAE,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;AACvC,CAAC;AAMD,MAAM,UAAU,UAAU,CAAC,EAAQ;IACjC,OAAO,SAAS,CAAC,EAAE,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;AACvC,CAAC;AAMD,MAAM,UAAU,UAAU,CAAC,EAAQ;IACjC,OAAO,SAAS,CAAC,EAAE,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;AACvC,CAAC;AAMD,MAAM,UAAU,kBAAkB,CAAC,EAAQ;IACzC,OAAO,SAAS,CAAC,EAAE,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAC;AACzD,CAAC;AAMD,MAAM,UAAU,kBAAkB,CAAC,EAAQ;IACzC,OAAO,SAAS,CAAC,EAAE,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;AACjD,CAAC;AAKD,MAAM,UAAU,6BAA6B,CAAC,EAAQ;IACpD,OAAO,SAAS,CAAC,EAAE,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC;AAC/C,CAAC;AASD,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;IACL,uFAAuF;IACvF,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":["/**\n * Proposals, group proposals,\n * group proposal states and state transitions.\n */\n\nimport type React from 'react';\nimport type { DatasetContext } from '@riboseinc/paneron-extension-kit/types/renderer';\n\nimport type {\n  InternalItemReference,\n  Payload,\n  RegisterItem,\n} from '../types';\n\nimport type { RegisterStakeholder } from '../types/stakeholder';\nimport type { Citation } from '../types/util';\n\n\n// Proposal items\n// ==============\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 `/<classID>/<itemID>.yaml`.\n * (the `[/subregisterID]/<classID>/<itemID>.yaml` is acceptable\n * but deprecated, as subregisters are deprecated).\n */\nexport type ProposalSet = {\n  [objectPath: string]: ChangeProposal\n}\n\nexport const ChangeProposalType = {\n  ADDITION: 'addition',\n  CLARIFICATION: 'clarification',\n  AMENDMENT: 'amendment',\n} as const;\nexport const PROPOSAL_TYPES = [\n  ChangeProposalType.ADDITION,\n  ChangeProposalType.CLARIFICATION,\n  ChangeProposalType.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: typeof ChangeProposalType.ADDITION\n  ///** New item data. */\n  //payload: Payload\n}\n\nexport interface Clarification extends BaseProposal {\n  type: typeof ChangeProposalType.CLARIFICATION\n  ///** Updated item data */\n  //payload: Payload\n}\n\nexport const AmendmentType = {\n  SUPERSESSION: 'supersession',\n  RETIREMENT: 'retirement',\n  INVALIDATION: 'invalidation',\n} as const;\nexport type AmendmentTypeType = typeof AmendmentType[keyof typeof AmendmentType];\nexport const AMENDMENT_TYPES = [\n  AmendmentType.SUPERSESSION,\n  AmendmentType.RETIREMENT,\n  AmendmentType.INVALIDATION,\n] as const;\n\ninterface BaseAmendment extends BaseProposal {\n  type: typeof ChangeProposalType.AMENDMENT\n  amendmentType: AmendmentTypeType\n}\nexport interface Retirement extends BaseAmendment {\n  amendmentType: typeof AmendmentType.RETIREMENT\n}\nexport interface Supersession extends BaseAmendment {\n  amendmentType: typeof AmendmentType.SUPERSESSION\n  supersedingItemIDs: string[]\n}\nexport interface Invalidation extends BaseAmendment {\n  amendmentType: typeof AmendmentType.INVALIDATION\n}\nexport type Amendment = Supersession | Retirement | Invalidation\n\nexport type ChangeProposal = Amendment | Clarification | Addition\n\nexport function isBaseProposal(val: any): val is BaseProposal {\n  return PROPOSAL_TYPES.indexOf(val?.type) >= 0;\n}\nexport function isProposal(val: any): val is ChangeProposal {\n  return (isBaseProposal(val) && (\n    isAddition(val)\n    || isClarification(val)\n    || isAmendment(val)));\n}\nexport function isAddition(val: BaseProposal): val is Addition {\n  return (val.type === ChangeProposalType.ADDITION);\n}\nexport function isClarification(val: BaseProposal): val is Clarification {\n  return (val.type === ChangeProposalType.CLARIFICATION);\n}\nexport function isBaseAmendment(val: BaseProposal): val is BaseAmendment {\n  return (\n    val.type === ChangeProposalType.AMENDMENT\n    && AMENDMENT_TYPES.indexOf((val as Amendment).amendmentType) >= 0);\n}\nexport function isAmendment(val: any): val is Amendment {\n  return (isBaseAmendment(val) && (\n    isRetirement(val)\n    || isSupersession(val)\n    || isInvalidation(val)));\n}\nexport function isRetirement(val: BaseAmendment): val is Retirement {\n  return val.amendmentType === AmendmentType.RETIREMENT;\n}\nexport function isSupersession(val: BaseAmendment): val is Supersession {\n  return val.amendmentType === AmendmentType.SUPERSESSION;\n}\nexport function isInvalidation(val: BaseAmendment): val is Invalidation {\n  return val.amendmentType === AmendmentType.INVALIDATION;\n}\n\n\n// Change request types, states and state transitions.\n\nexport function isSubmittedBy(stakeholder: RegisterStakeholder, cr: Base): boolean {\n  return (\n    //isSubmitter(stakeholder) &&\n    stakeholder.gitServerUsername === cr.submittingStakeholderGitServerUsername);\n}\n\n\ntype ItemDataset = Record<string, RegisterItem<any> | null>;\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 which register version changes were proposed.\n   */\n  registerVersion: string;\n\n  /**\n   * A link to external discussion.\n   */\n  externalDiscussionURI?: string;\n\n  pastTransitions?: TransitionEntry[];\n}\n\n\nexport interface TransitionEntry {\n  /** Verb in past tense. */\n  label: string;\n\n  timestamp: Date;\n  fromState: StateType;\n  toState: StateType;\n  stakeholder: RegisterStakeholder;\n  input: StateInput;\n}\n\n\nexport function isCreatedBy(stakeholder: RegisterStakeholder, cr: Base): boolean {\n  return stakeholder.gitServerUsername?.trim() !== '' && stakeholder.gitServerUsername === cr.submittingStakeholderGitServerUsername;\n}\n\n/** Whether given `cr` can be edited (as in, items changed) by specified stakeholder. */\nexport function canBeEditedBy(stakeholder: RegisterStakeholder, cr: Base): boolean {\n  return isCreatedBy(stakeholder, cr) && isEditableState(cr.state);\n}\n\n/**\n * Whether given `cr` can be deleted by given stakeholder.\n * Unlike editing, deletion is possible only if there are no items\n * and CR was never proposed.\n */\nexport function canBeDeletedBy(stakeholder: RegisterStakeholder, cr: Base): boolean {\n  return (\n    isCreatedBy(stakeholder, cr)\n    && isDrafted(cr)\n    //&& Object.keys(cr.items).length < 1 // Only allow deleting empty CRs\n    && !hadBeenProposed(cr)  // If it had been proposed, it should be withdrawn instead.\n  );\n}\n\n\n/** Proposal structure for single-file proposal import format. */\nexport interface ImportableCR {\n  /** Proposal data. */\n  proposalDraft: Drafted,\n  /** Register item data for additions & clarifications. */\n  itemPayloads: ItemDataset,\n  // TODO: Rename ImportableCR.itemPayloads to newItemData\n}\nexport function isImportableCR(val: any): val is ImportableCR {\n  // TODO: More complete check\n  return (\n    val.proposalDraft.id\n    && isDrafted(val.proposalDraft as Base)\n    && Object.keys(val.itemPayloads).length > 0);\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\n/** CR was proposed at least once. */\nexport function hadBeenProposed(cr: Base): cr is Base & { timeProposed: Date } {\n  return cr && cr.hasOwnProperty('timeProposed') && !!(cr as Proposed).timeProposed;\n}\nexport function hadBeenAccepted(cr: Base): cr is Accepted | AcceptedOnAppeal {\n  return isDisposed(cr) && (isAccepted(cr) || isAcceptedOnAppeal(cr));\n}\n/** A proposal that had been disposed is not pending, not actionable. */\nexport function isDisposed(cr: Base): cr is Base & { timeDisposed: Date } {\n  return cr && cr.hasOwnProperty('timeDisposed') && !!(cr as Disposed).timeDisposed;\n  // TODO: include status checks, too?\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 function isSubmittedForControlBodyReview(cr: Base): cr is SubmittedForControlBodyReview {\n  return isInState(cr, State.SUBMITTED_FOR_CONTROL_BODY_REVIEW)\n}\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 function isReturnedForClarification(cr: Base): cr is (ReturnedForClarificationByManager | ReturnedForClarificationByControlBody) {\n  return isInState(cr, State.RETURNED_FOR_CLARIFICATION)\n}\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 }\nexport function isRejected(cr: Base): cr is Rejected {\n  return isInState(cr, State.REJECTED);\n}\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 }\nexport function isRejectedOnAppeal(cr: Base): cr is RejectionUpheld {\n  return isInState(cr, State.REJECTION_UPHELD_ON_APPEAL);\n}\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 }\nexport function isRejectedWithAppealWithdrawn(cr: Base): cr is RejectedWithAppealWithdrawn {\n  return isInState(cr, State.APPEAL_WITHDRAWN);\n}\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\nexport type AlterApprovedCR = (\n  crID: string,\n  proposals: ProposalSet,\n  origItemData: ItemDataset,\n  newItemData: ItemDataset,\n  opts: Pick<DatasetContext, 'getMapReducedData'>,\n) => Promise<{\n  proposals: ProposalSet,\n  origItemData: ItemDataset,\n  newItemData: ItemDataset,\n}>\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.WITHDRAWN]:\n      TransitionConfig<Proposed, Withdrawn>;\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\n\n// Utility\n// =======\n\nexport interface ProposalProps<P extends ChangeProposal> {\n  proposal: P\n\n  /** Highlight changes. */\n  showDiff?: boolean\n\n  /** In diff mode, only show changed data. (Provisional.) */\n  showOnlyChanged?: boolean\n\n  itemRef: InternalItemReference\n  item: RegisterItem<Payload>\n  itemBefore: P extends Clarification ? RegisterItem<Payload> : undefined\n  onChange?: (newProposal: P) => void\n}\n"]}

package/dist/types/index.d.ts

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

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,QAAQ,CAAC","sourcesContent":["export * from './views';\nexport * from './register';\nexport * from './registry';\nexport * from './item';\nexport * from './stakeholder';\nexport * from './util';\n"]}

package/dist/types/item.d.ts

@@ -0,0 +1,55 @@
+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?: Readonly<LocalizedAlternative<string>[]>;
+}
+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;
+export declare const DUMMY_REF: 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 = Payload> {
+    id: string;
+    status: ItemStatus;
+    dateAccepted: Date;
+    /**
+     * UUID of change request that defined the current version.
+     * (Provisional.)
+     */
+    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.map

@@ -0,0 +1 @@
+{"version":3,"file":"item.js","sourceRoot":"","sources":["../../src/types/item.ts"],"names":[],"mappings":"AAKA,MAAM,aAAa,GAAG;IACpB,WAAW;IACX,OAAO;IACP,YAAY;IACZ,SAAS;IACT,SAAS;CACD,CAAC;AA2BX,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;AAED,MAAM,CAAC,MAAM,SAAS,GAA0B;IAC9C,MAAM,EAAE,qBAAqB;IAC7B,OAAO,EAAE,sBAAsB;IAC/B,aAAa,EAAE,SAAS;CAChB,CAAC;AA6CX,MAAM,UAAU,cAAc,CAAC,GAAQ;IACrC,OAAO,CACL,GAAG;QACH,GAAG,CAAC,cAAc,CAAC,IAAI,CAAC;QACxB,GAAG,CAAC,cAAc,CAAC,MAAM,CAAC;QAC1B,OAAO,GAAG,CAAC,IAAI,KAAK,WAAW;QAC/B,GAAG,CAAC,cAAc,CAAC,QAAQ,CAAC;QAC5B,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CACvC,CAAC;AACJ,CAAC","sourcesContent":["import 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?: Readonly<LocalizedAlternative<string>[]>\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\nexport const DUMMY_REF: InternalItemReference = {\n  itemID: 'NONEXISTENT_ITEM_ID',\n  classID: 'NONEXISTENT_CLASS_ID',\n  subregisterID: undefined,\n} as const;\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 = 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  /**\n   * UUID of change request that defined the current version.\n   * (Provisional.)\n   */\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    typeof val.data !== 'undefined' &&\n    val.hasOwnProperty('status') &&\n    ITEM_STATUSES.indexOf(val.status) >= 0\n  );\n}\n"]}

package/dist/types/register.d.ts

@@ -0,0 +1,21 @@
+import { type RegisterStakeholder, type Organization } 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[];
+    organizations: {
+        [orgID: string]: Organization;
+    };
+}
+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.map

@@ -0,0 +1 @@
+{"version":3,"file":"register.js","sourceRoot":"","sources":["../../src/types/register.ts"],"names":[],"mappings":"AAAA,OAAO,EAA+C,qBAAqB,EAAE,MAAM,eAAe,CAAC;AAsBnG,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,kCAAkC;QAClC,2EAA2E;QAC3E,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, type Organization, 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  organizations: {\n    [orgID: string]: Organization\n  }\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? No\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.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,43 @@
+/** Possible roles of a register stakeholder. */
+export declare const StakeholderRole: {
+    readonly Owner: "owner";
+    readonly ControlBody: "control-body";
+    readonly ControlBodyReview: "control-body-reviewer";
+    readonly Manager: "manager";
+    readonly Submitter: "submitter";
+};
+export declare const StakeholderRoleLabels: Record<StakeholderRoleType, string>;
+export declare type StakeholderRoleType = typeof StakeholderRole[keyof typeof StakeholderRole];
+export declare const STAKEHOLDER_ROLES: StakeholderRoleType[];
+export declare function isStakeholderRole(val: string): val is StakeholderRoleType;
+export declare function canCreateCR(stakeholder: RegisterStakeholder): boolean;
+export declare function canImportCR(stakeholder: RegisterStakeholder): boolean;
+export interface Contact {
+    label: string;
+    value: string;
+    notes?: string;
+}
+/** Register stakeholder represents an individual. */
+export interface RegisterStakeholder {
+    /** Stakeholder’s role wrt. the current register. */
+    roles: readonly StakeholderRoleType[];
+    name: string;
+    gitServerUsername?: string;
+    contacts: Contact[];
+    affiliations: {
+        [orgID: string]: StakeholderOrgAffiliation;
+    };
+}
+export interface StakeholderOrgAffiliation {
+    role: 'pointOfContact' | 'member';
+}
+export declare function isOwner(val: RegisterStakeholder): boolean;
+export declare function isControlBody(val: RegisterStakeholder): boolean;
+export declare function isControlBodyReviewer(val: RegisterStakeholder): boolean;
+export declare function isManager(val: RegisterStakeholder): boolean;
+export declare function isSubmitter(val: RegisterStakeholder): boolean;
+export interface Organization {
+    logoURL: string;
+    name: string;
+}
+export declare function isRegisterStakeholder(val: any): val is RegisterStakeholder;

package/dist/types/stakeholder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stakeholder.js","sourceRoot":"","sources":["../../src/types/stakeholder.ts"],"names":[],"mappings":"AAAA,eAAe;AAEf,gDAAgD;AAChD,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,KAAK,EAAE,OAAO;IACd,WAAW,EAAE,cAAc;IAC3B,iBAAiB,EAAE,uBAAuB;IAC1C,OAAO,EAAE,SAAS;IAClB,SAAS,EAAE,WAAW;CACd,CAAC;AAEX,MAAM,CAAC,MAAM,qBAAqB,GAAwC;IACxE,KAAK,EAAE,OAAO;IACd,cAAc,EAAE,uBAAuB;IACvC,uBAAuB,EAAE,uBAAuB;IAChD,OAAO,EAAE,SAAS;IAClB,SAAS,EAAE,oBAAoB;CAChC,CAAC;AAIF,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;AAED,kCAAkC;AAClC,oDAAoD;AACpD,8BAA8B;AAC9B,qCAAqC;AACrC,qCAAqC;AACrC,+BAA+B;AAC/B,YAAY;AACZ,iEAAiE;AACjE,uDAAuD;AACvD,uFAAuF;AACvF,QAAQ;AACR,KAAK;AACL,GAAG;AAEH,MAAM,UAAU,WAAW,CAAC,WAAgC;;IAC1D,OAAO,CACL,OAAO,CAAC,WAAW,CAAC,IAAI,WAAW,CAAC,WAAW,CAAC,IAAI,SAAS,CAAC,WAAW,CAAC;QAC1E,uDAAuD;QACvD,mDAAmD;QACnD,CAAA,MAAA,WAAW,CAAC,iBAAiB,0CAAE,IAAI,EAAE,MAAK,EAAE,CAAC,CAAC;AAClD,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,WAAgC;;IAC1D,OAAO,CACL,SAAS,CAAC,WAAW,CAAC,IAAI,OAAO,CAAC,WAAW,CAAC;QAC9C,uDAAuD;QACvD,mDAAmD;QACnD,CAAA,MAAA,WAAW,CAAC,iBAAiB,0CAAE,IAAI,EAAE,MAAK,EAAE,CAAC,CAAC;AAClD,CAAC;AA6BD,MAAM,UAAU,OAAO,CAAC,GAAwB;;IAC9C,OAAO,CAAA,MAAA,GAAG,CAAC,KAAK,0CAAE,QAAQ,CAAC,eAAe,CAAC,KAAK,CAAC;WAC3C,GAAW,CAAC,IAAI,KAAK,eAAe,CAAC,KAAK,CAAC;AACnD,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,GAAwB;;IACpD,OAAO,CAAA,MAAA,GAAG,CAAC,KAAK,0CAAE,QAAQ,CAAC,eAAe,CAAC,WAAW,CAAC;WACjD,GAAW,CAAC,IAAI,KAAK,eAAe,CAAC,WAAW,CAAC;AACzD,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,GAAwB;;IAC5D,OAAO,CAAA,MAAA,GAAG,CAAC,KAAK,0CAAE,QAAQ,CAAC,eAAe,CAAC,iBAAiB,CAAC;WACvD,GAAW,CAAC,IAAI,KAAK,eAAe,CAAC,iBAAiB,CAAC;AAC/D,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,GAAwB;;IAChD,OAAO,CAAA,MAAA,GAAG,CAAC,KAAK,0CAAE,QAAQ,CAAC,eAAe,CAAC,OAAO,CAAC;WAC7C,GAAW,CAAC,IAAI,KAAK,eAAe,CAAC,OAAO,CAAC;AACrD,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,GAAwB;;IAClD,OAAO,CAAA,MAAA,GAAG,CAAC,KAAK,0CAAE,QAAQ,CAAC,eAAe,CAAC,SAAS,CAAC;WAC/C,GAAW,CAAC,IAAI,KAAK,eAAe,CAAC,SAAS,CAAC;AACvD,CAAC;AAQD,6EAA6E;AAE7E,MAAM,UAAU,qBAAqB,CAAC,GAAQ;IAC5C,OAAO,CACL,GAAG;WACA,GAAG,CAAC,cAAc,CAAC,MAAM,CAAC;WAC1B,CACD,CAAC,GAAG,CAAC,cAAc,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;eAChE,CAAC,GAAG,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,iBAAiB;SACjF,CACF,CAAC;AACJ,CAAC","sourcesContent":["// Stakeholders\n\n/** Possible roles of a register stakeholder. */\nexport const StakeholderRole = {\n  Owner: 'owner',\n  ControlBody: 'control-body',\n  ControlBodyReview: 'control-body-reviewer',\n  Manager: 'manager',\n  Submitter: 'submitter',\n} as const;\n\nexport const StakeholderRoleLabels: Record<StakeholderRoleType, string> = {\n  owner: \"Owner\",\n  'control-body': \"Control body approver\",\n  'control-body-reviewer': \"Control body reviewer\",\n  manager: \"Manager\",\n  submitter: \"Proposal submitter\",\n};\n\nexport type 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//export function getStakeholders(\n//  allStakeholders: readonly RegisterStakeholder[],\n//  gitServerUsername: string,\n//): readonly RegisterStakeholder[] {\n//  if (allStakeholders.length < 1) {\n//    return Object.freeze([]);\n//  } else {\n//    const normalizedUsername = gitServerUsername.toLowerCase();\n//    return Object.freeze(allStakeholders.filter(sh =>\n//      sh.parties.find(p => p.gitServerUsername?.toLowerCase() === normalizedUsername)\n//    ))\n//  }\n//}\n\nexport function canCreateCR(stakeholder: RegisterStakeholder): boolean {\n  return (\n    isOwner(stakeholder) || isSubmitter(stakeholder) || isManager(stakeholder) && \n    // Must have a Git server username (current limitation)\n    // in order to be able to edit this proposal later.\n    stakeholder.gitServerUsername?.trim() !== '');\n}\n\nexport function canImportCR(stakeholder: RegisterStakeholder): boolean {\n  return (\n    isManager(stakeholder) || isOwner(stakeholder) &&\n    // Must have a Git server username (current limitation)\n    // in order to be able to edit this proposal later.\n    stakeholder.gitServerUsername?.trim() !== '');\n}\n\nexport interface Contact {\n  label: string\n  value: string\n  notes?: string\n}\n\n/** Register stakeholder represents an individual. */\nexport interface RegisterStakeholder {\n  /** Stakeholder’s role wrt. the current register. */\n  //role: StakeholderRoleType\n  roles: readonly StakeholderRoleType[]\n\n  name: string\n\n  gitServerUsername?: string\n\n  contacts: Contact[]\n\n  affiliations: {\n    [orgID: string]: StakeholderOrgAffiliation\n  }\n}\n\nexport interface StakeholderOrgAffiliation {\n  role: 'pointOfContact' | 'member'\n}\n\nexport function isOwner(val: RegisterStakeholder): boolean {\n  return val.roles?.includes(StakeholderRole.Owner)\n    || (val as any).role === StakeholderRole.Owner;\n}\n\nexport function isControlBody(val: RegisterStakeholder): boolean {\n  return val.roles?.includes(StakeholderRole.ControlBody)\n    || (val as any).role === StakeholderRole.ControlBody;\n}\n\nexport function isControlBodyReviewer(val: RegisterStakeholder): boolean {\n  return val.roles?.includes(StakeholderRole.ControlBodyReview)\n    || (val as any).role === StakeholderRole.ControlBodyReview;\n}\n\nexport function isManager(val: RegisterStakeholder): boolean {\n  return val.roles?.includes(StakeholderRole.Manager)\n    || (val as any).role === StakeholderRole.Manager;\n}\n\nexport function isSubmitter(val: RegisterStakeholder): boolean {\n  return val.roles?.includes(StakeholderRole.Submitter)\n    || (val as any).role === StakeholderRole.Submitter;\n}\n\n// Either logoURL or name or both must be present on an org here\nexport interface Organization {\n  logoURL: string\n  name: string\n}\n\n//export type RegisterStakeholder = Owner | ControlBody | Manager | Submitter\n\nexport function isRegisterStakeholder(val: any): val is RegisterStakeholder {\n  return (\n    val\n    && val.hasOwnProperty('name')\n    && (\n      (val.hasOwnProperty('roles') && val.roles.every(isStakeholderRole))\n      || (val.hasOwnProperty('role') && isStakeholderRole(val.role)) // TODO: obsolete\n    )\n  );\n}\n"]}

package/dist/types/util.d.ts

@@ -0,0 +1,28 @@
+export interface Locale {
+    name: string;
+    country: string;
+    languageCode: string;
+    characterEncoding: 'utf-8';
+}
+export interface Citation {
+    title: string;
+    author?: string | null;
+    publisher?: string | null;
+    publicationDate?: string | null;
+    revisionDate?: string | null;
+    seriesIssueID: string | null;
+    seriesName: string | null;
+    seriesPage: string | null;
+    edition: string | null;
+    editionDate: string | null;
+    otherDetails: string;
+    isbn: string | null;
+    issn: string | null;
+    alternateTitles?: string[];
+    doi?: string;
+    uri?: string;
+}
+export interface LocalizedAlternative<T> {
+    alternative: T;
+    locale: Locale;
+}

package/dist/types/util.js

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

package/dist/types/util.js.map

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