@riboseinc/paneron-registry-kit 2.0.1 → 2.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riboseinc/paneron-registry-kit",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "main": "index.js",
   "author": "Ribose Inc. <open.source@ribose.com>",
   "scripts": {

package/LICENSE

@@ -1,21 +0,0 @@
-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

@@ -1,35 +0,0 @@
-= 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.js

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

package/compiled/index.js

@@ -1,21 +0,0 @@
-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/migrations/initial.js

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

package/compiled/types/cr.js

@@ -1,131 +0,0 @@
-/** 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/index.js

@@ -1,8 +0,0 @@
-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/item.js

@@ -1,22 +0,0 @@
-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/proposal.js

@@ -1,21 +0,0 @@
-export const DECISION_STATUSES = [
-    'pending',
-    'tentative',
-    'final',
-];
-export const DISPOSITION_OPTIONS = [
-    'withdrawn',
-    'accepted',
-    'notAccepted',
-];
-export const PROPOSAL_TYPES = [
-    'addition',
-    'clarification',
-    'amendment',
-];
-export const AMENDMENT_TYPES = [
-    'supersession',
-    'retirement',
-    'invalidation',
-];
-//# sourceMappingURL=proposal.js.map

package/compiled/types/register.js

@@ -1,25 +0,0 @@
-import { isRegisterStakeholder } from './stakeholder';
-export function isRegisterMetadata(val) {
-    return (val &&
-        // val.hasOwnProperty('id') &&
-        //typeof val.id === 'string' &&
-        val.hasOwnProperty('name') &&
-        typeof val.name === 'string' &&
-        //val.hasOwnProperty('contentSummary') &&
-        //typeof val.contentSummary === 'string' &&
-        val.hasOwnProperty('stakeholders') &&
-        val.stakeholders.length > 0 &&
-        // Stakeholders must be right
-        val.stakeholders.every(isRegisterStakeholder) &&
-        // Must have at least an owner
-        val.stakeholders.some((s) => s.role === 'owner') &&
-        // Must have a valid version (or no version? hmm)
-        (val.version === undefined || isVersion(val.version)));
-}
-export function isVersion(val) {
-    return (val &&
-        val.hasOwnProperty('id') &&
-        val.hasOwnProperty('timestamp') &&
-        typeof val.id === 'string');
-}
-//# sourceMappingURL=register.js.map

package/compiled/types/registry.js

@@ -1,10 +0,0 @@
-// TODO: What is below for?
-export const KNOWN_AUTHORITATIVE_REGISTRIES = [
-    {
-        id: '9D546C5C-8FA4-496D-A721-6DA72E35F4A9',
-        name: 'ICS codes',
-        publicURL: 'https://ics.demo.paneron.org/',
-        repoURL: 'https://github.com/paneron/ics-codes-registry',
-    },
-];
-//# sourceMappingURL=registry.js.map

package/compiled/types/stakeholder.js

@@ -1,34 +0,0 @@
-// Stakeholders
-/** Possible roles of a register stakeholder. */
-export const StakeholderRole = {
-    Owner: 'owner',
-    ControlBody: 'control-body',
-    Manager: 'manager',
-    Submitter: 'submitter',
-};
-export const STAKEHOLDER_ROLES = Object.values(StakeholderRole);
-export function isStakeholderRole(val) {
-    return STAKEHOLDER_ROLES.indexOf(val) >= 0;
-}
-export function isOwner(val) {
-    return val.role === StakeholderRole.Owner;
-}
-export function isControlBody(val) {
-    return val.role === StakeholderRole.ControlBody;
-}
-export function isManager(val) {
-    return val.role === StakeholderRole.Manager;
-}
-export function isSubmitter(val) {
-    return val.role === StakeholderRole.Submitter;
-}
-export function isIndividualParty(val) {
-    return typeof val.name === 'string' && !val.hasOwnProperty('positionName');
-}
-export function isRegisterStakeholder(val) {
-    return (val &&
-        val.hasOwnProperty('role') &&
-        isStakeholderRole(val.role) &&
-        val.hasOwnProperty('name'));
-}
-//# sourceMappingURL=stakeholder.js.map

package/compiled/types/util.js

@@ -1,3 +0,0 @@
-// Utilities
-export {};
-//# sourceMappingURL=util.js.map

package/compiled/types/views.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=views.js.map

package/compiled/views/AnnotatedChange.js

@@ -1,57 +0,0 @@
-/** @jsx jsx */
-/** @jsxFrag React.Fragment */
-import { jsx } from '@emotion/react';
-import React, { useRef, useEffect } from 'react';
-import { Colors } from '@blueprintjs/core';
-import { annotate } from 'rough-notation';
-function annotateChange(type, wrappingEl, childIsBoxy) {
-    const highlightConfig = {
-        type: 'highlight',
-        animate: false,
-        color: Colors.GOLD5,
-        iterations: 3,
-    };
-    let changeConfig;
-    if (type === 'added') {
-        changeConfig = {
-            type: childIsBoxy ? 'bracket' : 'underline',
-            iterations: 1,
-            color: Colors.BLUE4,
-        };
-    }
-    else {
-        changeConfig = {
-            type: 'crossed-off',
-            iterations: 1,
-            color: Colors.RED3,
-        };
-    }
-    const highlightAnnotation = annotate(wrappingEl, highlightConfig);
-    const changeAnnotation = annotate(wrappingEl, changeConfig);
-    return [highlightAnnotation, changeAnnotation];
-}
-const AnnotatedChange = ({ type, children }) => {
-    const elRef = useRef(null);
-    const firstChild = React.Children.toArray(children)[0];
-    const childType = React.isValidElement(firstChild) ? firstChild.type : undefined;
-    const childIsBoxy = childType === 'div';
-    // Could it bring more accuracy to block/inline detection?
-    //const childCount = React.isValidElement(firstChild) ? React.Children.count(firstChild.props.children) : undefined;
-    useEffect(() => {
-        if (elRef.current) {
-            const annotations = annotateChange(type, elRef.current, childIsBoxy);
-            for (const a of annotations) {
-                a.show();
-            }
-            return function cleanup() {
-                for (const a of annotations) {
-                    a.remove();
-                }
-            };
-        }
-        return;
-    }, [elRef.current]);
-    return (jsx("mark", { style: { display: childIsBoxy ? 'block' : 'inline', background: 'none' }, ref: elRef, title: `(${type} in this proposal)` }, children));
-};
-export default AnnotatedChange;
-//# sourceMappingURL=AnnotatedChange.js.map

package/compiled/views/BrowserCtx.js

@@ -1,19 +0,0 @@
-/** @jsx jsx */
-import { jsx } from '@emotion/react';
-import { createContext } from 'react';
-export const BrowserCtx = createContext({
-    itemClasses: {},
-    customViews: [],
-    // getRegisterItemData: async () => ({}),
-    selectedRegisterItem: null,
-    registerMetadata: undefined,
-    useRegisterItemData: () => ({
-        value: {},
-        _reqCounter: -1,
-        errors: [],
-        isUpdating: true,
-        refresh: () => void 0,
-    }),
-    getRelatedItemClassConfiguration: () => ({ title: 'N/A', itemView: () => jsx("span", null, "Loading\u2026") }),
-});
-//# sourceMappingURL=BrowserCtx.js.map

package/compiled/views/FilterCriteria/CRITERIA_CONFIGURATION.js

@@ -1,110 +0,0 @@
-/** @jsx jsx */
-/** @jsxFrag React.Fragment */
-import { jsx } from '@emotion/react';
-import { Select, TextInput } from '@riboseinc/paneron-extension-kit/widgets/Sidebar/PropertyView';
-import { SUBREGISTER_PATH_PREFIX } from './index';
-export const ITEM_CLASS = {
-    label: "item class is",
-    icon: 'cube',
-    toQuery: ({ classID }, { subregisters }) => `objPath.indexOf("/${classID}/") >= ${subregisters ? SUBREGISTER_PATH_PREFIX.length - 1 : 0}`,
-    fromQuery: (query) => ({
-        classID: query.split('/')[1],
-    }),
-    toSummary: ({ classID }, { itemClasses }) => {
-        if (classID) {
-            return itemClasses[classID]?.meta.title ?? classID;
-        }
-        else {
-            return "(N/A)";
-        }
-    },
-    widget: ({ data, onChange, itemClasses, availableClassIDs, className, style }) => {
-        const itemClassChoices = [
-            ...Object.entries(itemClasses).
-                filter(([clsID,]) => availableClassIDs.indexOf(clsID) >= 0).
-                map(([classID, classData]) => {
-                return { value: classID, label: classData?.meta?.title ?? "Unknown class" };
-            }),
-            { value: '', label: "(not selected)" },
-        ];
-        return (jsx(Select, { className: className, style: style, fill: true, options: itemClassChoices, value: data.classID ?? '', disabled: !onChange, onChange: onChange
-                ? (evt) => onChange({ classID: evt.currentTarget.value })
-                : undefined }));
-    },
-};
-export const SUBREGISTER = {
-    label: "is in subregister",
-    icon: 'folder-open',
-    isEnabled: ({ subregisters }) => subregisters !== undefined,
-    toQuery: ({ subregisterID }, { subregisters }) => subregisters !== undefined && subregisterID?.trim()
-        ? `objPath.indexOf("/subregisters/${subregisterID}/") === 0`
-        : 'true',
-    fromQuery: (query) => ({
-        subregisterID: query.split('/')[2],
-    }),
-    toSummary: ({ subregisterID }, { subregisters }) => {
-        if (subregisters && subregisterID) {
-            return subregisters[subregisterID].title;
-        }
-        else {
-            return "(N/A)";
-        }
-    },
-    widget: ({ data, onChange, subregisters, className, style }) => {
-        const subregisterChoices = [
-            ...Object.entries(subregisters ?? {}).
-                map(([subregisterID, subregisterInfo]) => {
-                return { value: subregisterID, label: subregisterInfo.title };
-            }),
-            { value: '', label: "(not selected)" },
-        ];
-        return (jsx(Select, { className: className, style: style, fill: true, options: subregisterChoices, value: data.subregisterID ?? '', disabled: !onChange, onChange: onChange
-                ? (evt) => onChange({ subregisterID: evt.currentTarget.value })
-                : undefined }));
-    },
-};
-export const RAW_SUBSTRING = {
-    label: "raw data contains",
-    icon: 'search-text',
-    toQuery: ({ substring }) => substring?.trim()
-        ? `JSON.stringify(obj.data ?? {}).toLowerCase().indexOf("${substring.toLowerCase().replace(/"/g, "\\\"")}") >= 0`
-        : `true`,
-    fromQuery: (query) => ({
-        substring: (query.
-            split('JSON.stringify(obj.data ?? {}).toLowerCase().indexOf("')[1]?.
-            split('") >= 0')[0] ?? '').replace(/\\"/g, '"'),
-    }),
-    toSummary: ({ substring }) => {
-        if (substring) {
-            return substring.length > 20 ? `${substring.slice(0, 20)}…` : substring;
-        }
-        else {
-            return 'N/A';
-        }
-    },
-    widget: ({ data, onChange, className, style }) => {
-        return jsx(TextInput, { className: className, style: style, value: data.substring ?? '', onChange: onChange ? substring => onChange({ substring }) : undefined });
-    },
-};
-export const CUSTOM_CONDITION = {
-    label: "condition is met",
-    icon: 'code',
-    toQuery: ({ customExpression }) => customExpression ?? 'true',
-    fromQuery: (query) => ({
-        customExpression: query,
-    }),
-    toSummary: () => "(custom test expr.)",
-    widget: ({ data, onChange, className }) => {
-        return (jsx(TextInput, { className: className, value: data.customExpression ?? 'true', placeholder: "Enter a valid query expression\u2026", onChange: onChange
-                ? (customExpression) => onChange({ customExpression })
-                : undefined }));
-    },
-};
-export const CRITERIA_CONFIGURATION = {
-    'item-class': ITEM_CLASS,
-    'subregister': SUBREGISTER,
-    'raw-substring': RAW_SUBSTRING,
-    'custom': CUSTOM_CONDITION,
-};
-export default CRITERIA_CONFIGURATION;
-//# sourceMappingURL=CRITERIA_CONFIGURATION.js.map

package/compiled/views/FilterCriteria/criteriaGroupToQueryExpression.js

@@ -1,40 +0,0 @@
-import { isCriteriaGroup } from './models';
-/**
- * Given a CriteriaGroup,
- * returns a query expression suitable for use with filtered object indexes..
- */
-export default function criteriaGroupToQueryExpression(cg) {
-    const exps = [];
-    for (const c of cg.criteria) {
-        if (isCriteriaGroup(c)) {
-            if (c.criteria.length > 1) {
-                exps.push(`(${criteriaGroupToQueryExpression(c)})`);
-            }
-            else if (c.criteria.length > 0) {
-                exps.push(`${criteriaGroupToQueryExpression(c)}`);
-            }
-        }
-        else {
-            exps.push(c.query);
-        }
-    }
-    let result;
-    if (exps.length < 1) {
-        result = 'true';
-    }
-    else {
-        switch (cg.require) {
-            case 'all':
-                result = exps.join(' && ');
-                break;
-            case 'any':
-                result = exps.join(' || ');
-                break;
-            case 'none':
-                result = exps.map(exp => `${exp} === false`).join(' && ');
-                break;
-        }
-    }
-    return result;
-}
-//# sourceMappingURL=criteriaGroupToQueryExpression.js.map

package/compiled/views/FilterCriteria/criteriaGroupToSummary.js

@@ -1,47 +0,0 @@
-/** @jsx jsx */
-/** @jsxFrag React.Fragment */
-import { jsx } from '@emotion/react';
-import React from 'react';
-import { isCriteriaGroup } from './models';
-import { CRITERIA_CONFIGURATION } from "./CRITERIA_CONFIGURATION";
-/* Building query summary */
-export default function criteriaGroupToSummary(cg, opts) {
-    const exps = [];
-    for (const c of cg.criteria) {
-        if (isCriteriaGroup(c)) {
-            exps.push(criteriaGroupToSummary(c, opts));
-        }
-        else {
-            const cfg = CRITERIA_CONFIGURATION[c.key];
-            if (!cfg) {
-                console.error("Missing criterion configuration for key", c.key);
-                throw new Error("Missing criterion configuration");
-            }
-            exps.push(jsx(React.Fragment, null,
-                cfg.label,
-                " ",
-                jsx("em", null, cfg.toSummary(cfg.fromQuery(c.query, opts), opts))));
-        }
-    }
-    let result;
-    if (exps.length < 1) {
-        result = jsx(React.Fragment, null, "(no criteria)");
-    }
-    else {
-        switch (cg.require) {
-            case 'all':
-                result = jsx(React.Fragment, null, exps.reduce((acc, current, index) => [...acc, index ? ', ' : '', current], []));
-                break;
-            case 'any':
-                result = jsx(React.Fragment, null, exps.reduce((acc, current, index) => [...acc, index ? ' or ' : '', current], []));
-                break;
-            case 'none':
-                result = jsx(React.Fragment, null,
-                    "neither ",
-                    exps.reduce((acc, current, index) => [...acc, index ? ' nor ' : '', current], []));
-                break;
-        }
-    }
-    return result;
-}
-//# sourceMappingURL=criteriaGroupToSummary.js.map