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

package/LICENSE

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

package/README.adoc

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

package/compiled/common.d.ts

@@ -0,0 +1 @@
+export declare const REGISTER_METADATA_FILENAME = "/register.yaml";

package/compiled/common.js

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

package/{common.js.map → compiled/common.js.map}

@@ -1 +1 @@
-{"version":3,"file":"common.js","sourceRoot":"","sources":["../src/common.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,0BAA0B,GAAG,eAAe,CAAC","sourcesContent":["export const REGISTER_METADATA_FILENAME = 'register.yaml';\n"]}
+{"version":3,"file":"common.js","sourceRoot":"","sources":["../src/common.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,0BAA0B,GAAG,gBAAgB,CAAC","sourcesContent":["export const REGISTER_METADATA_FILENAME = '/register.yaml';\n"]}

package/{index.d.ts → compiled/index.d.ts}

@@ -1,6 +1,6 @@
-import { Extension } from '@riboseinc/paneron-extension-kit/types';
-import { ExtensionMakerProps } from '@riboseinc/paneron-extension-kit/types/extension-maker';
-import { RegistryViewProps } from './types';
+import type { Extension } from '@riboseinc/paneron-extension-kit/types';
+import type { ExtensionMakerProps } from '@riboseinc/paneron-extension-kit/types/extension-maker';
+import type { RegistryViewProps } from './types';
 export declare type RegistryExtensionMakerProps = Pick<ExtensionMakerProps, 'name'> & RegistryViewProps;
 export declare type RegistryExtensionMaker = (opts: RegistryExtensionMakerProps) => Promise<Extension>;
 export declare const makeRegistryExtension: RegistryExtensionMaker;

package/compiled/index.js

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

package/compiled/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AAIjE,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAQvC,MAAM,CAAC,MAAM,qBAAqB,GAA2B,UAAU,IAAI;IACzE,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;IAEtB,MAAM,QAAQ,GAAoC,KAAK;QACrD,OAAO;YACL,OAAO,EAAE,GAAG,EAAE;gBACZ,OAAO,CACL,oBAAC,YAAY,IACX,sBAAsB,EAAE,IAAI,CAAC,sBAAsB,EACnD,YAAY,EAAE,IAAI,CAAC,YAAY,GAC/B,CACH,CAAC;YACJ,CAAC;SACF,CAAC;IACJ,CAAC,CAAC;IAEF,OAAO,aAAa,CAAC;QACnB,QAAQ;QACR,IAAI;QACJ,sBAAsB,EAAE,OAAO;QAC/B,iBAAiB,EAAE,EAAE;QACrB,kBAAkB,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,sBAAsB,CAAC;KACzD,CAAC,CAAC;AACL,CAAC,CAAC","sourcesContent":["import React from 'react';\nimport { makeExtension } from '@riboseinc/paneron-extension-kit';\nimport type { Extension } from '@riboseinc/paneron-extension-kit/types';\nimport type { ExtensionMakerProps } from '@riboseinc/paneron-extension-kit/types/extension-maker';\nimport type { RegistryViewProps } from './types';\nimport { RegistryView } from './views';\n\nexport type RegistryExtensionMakerProps =\n  Pick<ExtensionMakerProps, 'name'> & RegistryViewProps\n\nexport type RegistryExtensionMaker =\n  (opts: RegistryExtensionMakerProps) => Promise<Extension>;\n\nexport const makeRegistryExtension: RegistryExtensionMaker = function (opts) {\n  const { name } = opts;\n\n  const mainView: ExtensionMakerProps[\"mainView\"] = async function () {\n    return {\n      default: () => {\n        return (\n          <RegistryView\n            itemClassConfiguration={opts.itemClassConfiguration}\n            subregisters={opts.subregisters}\n          />\n        );\n      },\n    };\n  };\n\n  return makeExtension({\n    mainView,\n    name,\n    requiredHostAppVersion: '2.0.0',\n    datasetMigrations: {},\n    datasetInitializer: () => import('./migrations/initial'),\n  });\n};\n"]}

package/compiled/migrations/initial.js

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

package/compiled/types/cr.d.ts

@@ -0,0 +1,216 @@
+/** Change request types, states and state transitions. */
+import type React from 'react';
+import type { ProposalSet } from './proposal';
+import { type RegisterStakeholder } from './stakeholder';
+export declare function isSubmittedBy(stakeholder: RegisterStakeholder, cr: Base): boolean;
+/** 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 to which register version changes were proposed.
+     */
+    registerVersion: string;
+    /**
+     * A link to external discussion.
+     */
+    externalDiscussionURI?: string;
+}
+export declare function isCreatedBy(stakeholder: RegisterStakeholder, cr: Base): boolean;
+export declare function canBeEditedBy(stakeholder: RegisterStakeholder, cr: Base): boolean;
+/**
+ * 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;
+export declare function hadBeenProposed(cr: Base): cr is Base & {
+    timeProposed: Date;
+};
+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 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 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 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 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 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 {
+    controlBodyNotes: string;
+    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'>;
+/**
+ * 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.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>;
+    };
+};

package/compiled/types/cr.js

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

package/compiled/types/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/{types → compiled/types}/index.d.ts

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

package/compiled/types/index.js

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

package/compiled/types/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/{types → compiled/types}/item.d.ts

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

package/compiled/types/item.js

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

package/compiled/types/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"]}