@arpproject/recrate 0.1.7-test5 → 0.1.7-test7

package/dist/crate-builder/CrateManager/profile-manager.d.ts

@@ -0,0 +1,143 @@
+import { NormalisedProfile, NormalisedEntityDefinition, ProfileLayout, ProfileInput, EntityReference } from '../types';
+/**
+ * @class
+ *
+ * ProfileManager
+ *
+ * A class to work with Describo Profiles
+ *
+ * @param {profile} - profile to handle
+ */
+export declare class ProfileManager {
+    profile?: NormalisedProfile;
+    $key?: number;
+    context?: any;
+    constructor({ profile }: {
+        profile?: NormalisedProfile;
+    });
+    /**
+     * Process input definitions for certain types.
+     *
+     * For now it takes care of setting 'handlesMultipleValues' for input types, which can have multiple values
+     * but handle all values themselves and not require a new render property added for each new value. This is the
+     * case for checbox style selects. It provides the same functionality as a normal select but all values are
+     * visible and selectable at once and not one by one.
+     *
+     * It also makes sure that for radio style selects "multiple" is always set to "false", as radio input only
+     * provides a single value selected form many.
+     *
+     * @private
+     */
+    private __processInputs;
+    /**
+     *
+     * Get the layout for an entity from the profile
+     *
+     * Returns the first matching layout from the profile
+     *
+     * @param { Object } options
+     * @param { Object } options.entity - the entity whose layout is required
+     *
+     */
+    getLayout({ entity, }: {
+        entity: NormalisedEntityDefinition | EntityReference;
+    }): ProfileLayout | null;
+    /**
+     * Get inverse associations from the profile if any are defined
+     */
+    getPropertyAssociations(): {
+        [key: string]: {
+            property: string;
+            propertyId: string;
+        };
+    };
+    /**
+     *
+     * Get the available classes
+     *   if a profile is defined, get those
+     *
+     * Returns the classes defined in the profile if one is applied
+     *   or all of the classes built into the base, schema.org profile
+     *
+     */
+    getClasses(): string[];
+    /**
+     *
+     * Return the type hierarchy for the given entity
+     *
+     * @param { Object } options
+     * @param { Object } options.entity - the entity whose hierarchy is required
+     *
+     *
+     */
+    getEntityTypeHierarchy({ entity }: {
+        entity: NormalisedEntityDefinition;
+    }): string[];
+    /**
+     *
+     * Given an entity, try to find a definition for the property in the profile or
+     *  right across the hierarchy
+     *
+     * @param { Object } options
+     * @param { Object } options.property - the property to define
+     * @param { Object } options.entity - the entity this property is a part of
+     *
+     */
+    getPropertyDefinition({ property, entity, }: {
+        property: string;
+        entity: NormalisedEntityDefinition;
+    }): {
+        propertyDefinition: ProfileInput;
+    };
+    /**
+     *
+     * Given a set of types, figure out the type hierarchy taking into account
+     *  the parent types that this is a subClassOf
+     */
+    mapTypeHierarchies({ types }: {
+        types: string[];
+    }): string[];
+    /**
+     *
+     * Given an entity, get the inputs defined in the profile
+     *
+     * @param { Object } options
+     * @param { Object } options.entity - the entity
+     *
+     */
+    getInputsFromProfile({ entity }: {
+        entity: NormalisedEntityDefinition;
+    }): ProfileInput[];
+    /**
+     *
+     * Given an entity, get all available inputs by joining the profile with schema.org
+     *
+     * @param { Object } options
+     * @param { Object } options.entity - the entity
+     */
+    getAllInputs({ entity }: {
+        entity: NormalisedEntityDefinition;
+    }): {
+        inputs: ProfileInput[];
+    };
+    /**
+     *
+     * Try to get a definition from the profile and see if it's override or inherit
+     *
+     * If there's an override then return override - otherwise inherit. Exclusive rather than inclusive.
+     *
+     * @param { Object } options
+     * @param { Object } options.entity - the entity
+     * if there's an override then set to override - otherwise inherit
+     * be exclusive rather than inclusive
+     */
+    getTypeDefinition({ entity }: {
+        entity: NormalisedEntityDefinition;
+    }): "inherit" | "override";
+    /**
+     * Get an entity label if defined
+     *
+     * @property the type name to localise
+     */
+    getTypeLabel(type: string): string;
+}

package/dist/crate-builder/CrateManager/profile-manager.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/{src/crate-builder/CrateManager/schema-type-definitions.json → dist/crate-builder/CrateManager/schema-type-definitions.json.d.ts}

@@ -1,4 +1,4 @@
-{
+declare const _default: {
     "DeliveryChargeSpecification": {
         "id": "http://schema.org/DeliveryChargeSpecification",
         "name": "DeliveryChargeSpecification",
@@ -35120,3 +35120,6 @@
         "hierarchy": ["RepositoryObject", "Thing"]
     }
 }
+;
+
+export default _default;

package/dist/crate-builder/CrateManager/validate-identifier.d.ts

@@ -0,0 +1,10 @@
+type ValidateIdParams = {
+    id: string | undefined;
+    type: string | string[];
+};
+type ValidateIdResponse = {
+    isValid: boolean;
+    message?: string;
+};
+export declare function validateId({ id, type }: ValidateIdParams): ValidateIdResponse;
+export {};

package/dist/crate-builder/CrateManager/validate-identifier.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/crate-builder/RenderEntity/Add.d.ts

@@ -0,0 +1,26 @@
+import { default as React } from 'react';
+interface AddProps {
+    property: string;
+    definition: {
+        id: string;
+        type?: string;
+        minLength?: number;
+        maxLength?: number;
+        regex?: string;
+        dateFormat?: string[];
+        minValue?: number;
+        maxValue?: number;
+        numberType?: string[];
+        values?: string[];
+        style?: 'dropdown' | 'radio' | 'checkbox';
+        [key: string]: any;
+    };
+    embedded?: boolean;
+    placeholder?: string;
+    crateManager: any;
+    onCreateProperty: (data: any) => void;
+    onCreateEntity: (data: any) => void;
+    onLinkEntity: (data: any) => void;
+}
+declare const Add: React.FC<AddProps>;
+export default Add;

package/dist/crate-builder/RenderEntity/AddControl.d.ts

@@ -0,0 +1,14 @@
+import { default as React } from 'react';
+interface AddControlProps {
+    crateManager: any;
+    types: string | string[];
+    selectedType: string;
+    primitives: string[];
+    onAdd: (data: {
+        type: string;
+    }) => void;
+    onBulkAdd: () => void;
+    onClose: () => void;
+}
+declare const AddControl: React.FC<AddControlProps>;
+export default AddControl;

package/dist/crate-builder/RenderEntity/AddControl.stories.d.ts

@@ -0,0 +1,29 @@
+import { Meta } from '@storybook/react';
+declare const _default: Meta;
+export default _default;
+interface AddControlProps {
+    crateManager: any;
+    types: string | string[];
+    selectedType: string;
+    primitives: string[];
+    onAdd: (data: {
+        type: string;
+    }) => void;
+    onBulkAdd: () => void;
+    onClose: () => void;
+    help?: string;
+    multiple?: boolean;
+    embedded?: boolean;
+    values?: Array<string | {
+        '@id': string;
+        '@type': string;
+        name: string;
+    }>;
+}
+export declare const TextPrimitives: import('@storybook/core/csf').AnnotatedStoryFn<import('@storybook/react').ReactRenderer, AddControlProps>;
+export declare const DateTimePrimitives: import('@storybook/core/csf').AnnotatedStoryFn<import('@storybook/react').ReactRenderer, AddControlProps>;
+export declare const NumberPrimitives: import('@storybook/core/csf').AnnotatedStoryFn<import('@storybook/react').ReactRenderer, AddControlProps>;
+export declare const SelectPrimitive: import('@storybook/core/csf').AnnotatedStoryFn<import('@storybook/react').ReactRenderer, AddControlProps>;
+export declare const SelectUrlPrimitive: import('@storybook/core/csf').AnnotatedStoryFn<import('@storybook/react').ReactRenderer, AddControlProps>;
+export declare const SelectObjectPrimitive: import('@storybook/core/csf').AnnotatedStoryFn<import('@storybook/react').ReactRenderer, AddControlProps>;
+export declare const GeoPrimitives: import('@storybook/core/csf').AnnotatedStoryFn<import('@storybook/react').ReactRenderer, AddControlProps>;

package/dist/crate-builder/RenderEntity/AutoComplete.d.ts

@@ -0,0 +1,12 @@
+import { default as React } from 'react';
+interface AutoCompleteProps {
+    type: string;
+    onLinkEntity: (data: {
+        json: any;
+    }) => void;
+    onCreateEntity: (data: {
+        json: any;
+    }) => void;
+}
+declare const AutoComplete: React.FC<AutoCompleteProps>;
+export default AutoComplete;

package/dist/crate-builder/RenderEntity/BulkAdd.d.ts

@@ -0,0 +1,10 @@
+import { default as React } from 'react';
+interface BulkAddProps {
+    types: string | string[];
+    primitives: string[];
+    onCreateEntity: (data: {
+        json: any;
+    }) => void;
+}
+declare const BulkAdd: React.FC<BulkAddProps>;
+export default BulkAdd;

package/dist/crate-builder/RenderEntity/DeleteProperty.d.ts

@@ -0,0 +1,8 @@
+import { default as React } from 'react';
+interface DeletePropertyProps {
+    type?: 'delete' | 'unlink';
+    property: string;
+    onDeleteProperty: () => void;
+}
+declare const DeleteProperty: React.FC<DeletePropertyProps>;
+export default DeleteProperty;

package/dist/crate-builder/RenderEntity/DialogAddProperty.d.ts

@@ -0,0 +1,9 @@
+import { default as React } from 'react';
+interface DialogAddPropertyProps {
+    entity: any;
+    onClose: () => void;
+    open: boolean;
+    onAddPropertyPlaceholder: (property: string) => void;
+}
+declare const DialogAddProperty: React.FC<DialogAddPropertyProps>;
+export default DialogAddProperty;

package/dist/crate-builder/RenderEntity/DialogBrowseEntities.d.ts

@@ -0,0 +1,8 @@
+import { default as React } from 'react';
+interface DialogBrowseEntitiesProps {
+    onClose: () => void;
+    open: boolean;
+    onLoadEntity: (entity: any) => void;
+}
+declare const DialogBrowseEntities: React.FC<DialogBrowseEntitiesProps>;
+export default DialogBrowseEntities;

package/dist/crate-builder/RenderEntity/DialogEditContext.d.ts

@@ -0,0 +1,8 @@
+import { default as React } from 'react';
+interface DialogEditContextProps {
+    onClose: () => void;
+    onUpdateContext: (context: any) => void;
+    open: boolean;
+}
+declare const DialogEditContext: React.FC<DialogEditContextProps>;
+export default DialogEditContext;

package/dist/crate-builder/RenderEntity/DialogPreviewCrate.d.ts

@@ -0,0 +1,7 @@
+import { default as React } from 'react';
+interface DialogPreviewCrateProps {
+    onClose: () => void;
+    open: boolean;
+}
+declare const DialogPreviewCrate: React.FC<DialogPreviewCrateProps>;
+export default DialogPreviewCrate;

package/dist/crate-builder/RenderEntity/DialogSaveCrateAsTemplate.d.ts

@@ -0,0 +1,13 @@
+import { default as React } from 'react';
+interface DialogSaveCrateAsTemplateProps {
+    entity: {
+        [key: string]: any;
+    };
+    onClose: () => void;
+    open: boolean;
+    onSaveCrateTemplate: (data: {
+        name: string;
+    }) => void;
+}
+declare const DialogSaveCrateAsTemplate: React.FC<DialogSaveCrateAsTemplateProps>;
+export default DialogSaveCrateAsTemplate;

package/dist/crate-builder/RenderEntity/DialogSaveEntityTemplate.d.ts

@@ -0,0 +1,14 @@
+import { default as React } from 'react';
+interface DialogSaveEntityTemplateProps {
+    entity: {
+        '@id': string;
+        [key: string]: any;
+    };
+    onClose: () => void;
+    open: boolean;
+    onSaveEntityTemplate: (data: {
+        resolveDepth: number;
+    }) => void;
+}
+declare const DialogSaveEntityTemplate: React.FC<DialogSaveEntityTemplateProps>;
+export default DialogSaveEntityTemplate;

package/dist/crate-builder/RenderEntity/DisplayPropertyName.d.ts

@@ -0,0 +1,8 @@
+import { default as React } from 'react';
+interface DisplayPropertyNameProps {
+    property: string;
+    label?: string;
+    className?: string;
+}
+declare const DisplayPropertyName: React.FC<DisplayPropertyNameProps>;
+export default DisplayPropertyName;

package/dist/crate-builder/RenderEntity/DisplayPropertyName.stories.d.ts

@@ -0,0 +1,6 @@
+import { Meta, StoryObj } from '@storybook/react';
+import { default as DisplayPropertyName } from './DisplayPropertyName';
+declare const meta: Meta<typeof DisplayPropertyName>;
+export default meta;
+type Story = StoryObj<typeof DisplayPropertyName>;
+export declare const Default: Story;

package/dist/crate-builder/RenderEntity/EntityId.d.ts

@@ -0,0 +1,13 @@
+import { default as React } from 'react';
+interface EntityIdProps {
+    entity: {
+        '@id': string;
+        '@type': string | string[];
+    };
+    onUpdate: (data: {
+        property: string;
+        value: string;
+    }) => void;
+}
+export declare const EntityId: React.FC<EntityIdProps>;
+export default EntityId;

package/dist/crate-builder/RenderEntity/EntityName.d.ts

@@ -0,0 +1,13 @@
+import { default as React } from 'react';
+interface EntityNameProps {
+    entity: {
+        name: string;
+        value?: string;
+    };
+    onUpdate: (data: {
+        property: string;
+        value: string;
+    }) => void;
+}
+export declare const EntityName: React.FC<EntityNameProps>;
+export default EntityName;

package/dist/crate-builder/RenderEntity/EntityProperty.d.ts

@@ -0,0 +1,19 @@
+import { default as React } from 'react';
+interface EntityPropertyProps {
+    entity: any;
+    property: string;
+    values: any[];
+    highlightRequired?: boolean;
+    savedProperty?: boolean;
+    onLoadEntity: (data: {
+        id: string;
+    }) => void;
+    onCreateProperty: (data: any) => void;
+    onCreateEntity: (data: any) => void;
+    onLinkEntity: (data: any) => void;
+    onSaveProperty: (data: any) => void;
+    onDeleteProperty: (data: any) => void;
+    onUnlinkEntity: (data: any) => void;
+}
+export declare const EntityProperty: React.FC<EntityPropertyProps>;
+export default EntityProperty;

package/dist/crate-builder/RenderEntity/EntityPropertyInstance.d.ts

@@ -0,0 +1,25 @@
+import { default as React } from 'react';
+interface EntityPropertyInstanceProps {
+    property: string;
+    value: string | number | boolean | Date | any[];
+    idx: number;
+    definition: {
+        type: string;
+        value?: any;
+        values?: string[];
+        minValue?: number;
+        maxValue?: number;
+        numberType?: string[];
+        style?: 'dropdown' | 'radio' | 'checkbox';
+        minLength?: number;
+        maxLength?: number;
+        regex?: string;
+        dateFormat?: string[];
+    };
+    className?: string;
+    placeholder?: string;
+    onSaveProperty: (data: any) => void;
+    onCreateEntity: (data: any) => void;
+}
+export declare const EntityPropertyInstance: React.FC<EntityPropertyInstanceProps>;
+export default EntityPropertyInstance;

package/dist/crate-builder/RenderEntity/EntityType.d.ts

@@ -0,0 +1,12 @@
+import { default as React } from 'react';
+interface EntityTypeProps {
+    entity: {
+        '@type': string[];
+    };
+    onUpdateEntity: (data: {
+        property: string;
+        value: string[];
+    }) => void;
+}
+export declare const EntityType: React.FC<EntityTypeProps>;
+export default EntityType;

package/dist/crate-builder/RenderEntity/ItemLink.d.ts

@@ -0,0 +1,14 @@
+import { default as React } from 'react';
+interface ItemLinkProps {
+    entity: {
+        '@id': string;
+        '@type': string[];
+        name: string;
+    };
+    onLoadEntity: (data: {
+        id: string;
+    }) => void;
+    className?: string;
+}
+export declare const ItemLink: React.FC<ItemLinkProps>;
+export default ItemLink;

package/dist/crate-builder/RenderEntity/PaginateLinkedEntities.d.ts

@@ -0,0 +1,23 @@
+import { default as React } from 'react';
+interface PaginateLinkedEntitiesProps {
+    entities: Array<{
+        idx: number;
+        value: {
+            '@id': string;
+            '@type': string[];
+            name: string;
+        };
+    }>;
+    property: string;
+    readonly?: boolean;
+    className?: string;
+    onLoadEntity: (data: {
+        id: string;
+    }) => void;
+    onUnlinkEntity: (data: {
+        property: string;
+        tgtEntityId: string;
+    }) => void;
+}
+declare const PaginateLinkedEntities: React.FC<PaginateLinkedEntitiesProps>;
+export default PaginateLinkedEntities;

package/dist/crate-builder/RenderEntity/PaginateLinkedEntities.stories.d.ts

@@ -0,0 +1,7 @@
+import { Meta, StoryObj } from '@storybook/react';
+import { default as PaginateLinkedEntities } from './PaginateLinkedEntities';
+declare const meta: Meta<typeof PaginateLinkedEntities>;
+export default meta;
+type Story = StoryObj<typeof PaginateLinkedEntities>;
+export declare const ValidEntityInputWithOneEntity: Story;
+export declare const ValidEntityInputWithOneHundredEntities: Story;

package/dist/crate-builder/RenderEntity/PropertyHelp.d.ts

@@ -0,0 +1,6 @@
+import { default as React } from 'react';
+interface PropertyHelpProps {
+    help?: string;
+}
+export declare const PropertyHelp: React.FC<PropertyHelpProps>;
+export default PropertyHelp;

package/dist/crate-builder/RenderEntity/RenderControls.d.ts

@@ -0,0 +1,22 @@
+import { default as React } from 'react';
+interface RenderControlsProps {
+    entity: {
+        '@id': string;
+        '@type': string[];
+        etype?: string;
+        [key: string]: any;
+    };
+    onLoadEntity: (data: {
+        id: string;
+    }) => void;
+    onBack: () => void;
+    onForward: () => void;
+    onAddPropertyPlaceholder: (property: any) => void;
+    onDeleteEntity: (data: {
+        id: string;
+    }) => void;
+    onSaveEntityTemplate: (data: any) => void;
+    onUpdateContext: (data: any) => void;
+}
+declare const RenderControls: React.FC<RenderControlsProps>;
+export default RenderControls;

package/dist/crate-builder/RenderEntity/RenderLinkedItem.d.ts

@@ -0,0 +1,20 @@
+import { default as React } from 'react';
+interface RenderLinkedItemProps {
+    entity: {
+        '@id': string;
+        '@type': string[];
+        name?: string;
+        [key: string]: any;
+    };
+    property: string;
+    readonly: boolean;
+    onLoadEntity: (entity: {
+        id: string;
+    }) => void;
+    onUnlinkEntity: (data: {
+        property: string;
+        tgtEntityId: string;
+    }) => void;
+}
+declare const RenderLinkedItem: React.FC<RenderLinkedItemProps>;
+export default RenderLinkedItem;

package/dist/crate-builder/RenderEntity/RenderPropertyHelp.d.ts

@@ -0,0 +1,6 @@
+import { default as React } from 'react';
+interface RenderPropertyHelpProps {
+    help?: string;
+}
+declare const RenderPropertyHelp: React.FC<RenderPropertyHelpProps>;
+export default RenderPropertyHelp;

package/dist/crate-builder/RenderEntity/RenderReverseConnections.d.ts

@@ -0,0 +1,16 @@
+import { default as React } from 'react';
+interface RenderReverseConnectionsProps {
+    entity: {
+        '@id': string;
+        '@type': string[];
+        '@reverse'?: {
+            [key: string]: any[];
+        };
+        [key: string]: any;
+    };
+    onLoadEntity: (data: {
+        id: string;
+    }) => void;
+}
+declare const RenderReverseConnections: React.FC<RenderReverseConnectionsProps>;
+export default RenderReverseConnections;

package/dist/crate-builder/RenderEntity/RenderTypes.d.ts

@@ -0,0 +1,6 @@
+import { default as React } from 'react';
+interface RenderTypesProps {
+    types: string[];
+}
+declare const RenderTypes: React.FC<RenderTypesProps>;
+export default RenderTypes;

package/dist/crate-builder/RenderEntity/Shell2.d.ts

@@ -0,0 +1,14 @@
+import { default as React } from 'react';
+interface RenderEntityProps {
+    entity: any;
+    onLoadEntity: (params: {
+        id: string;
+        updateState?: boolean;
+    }) => void;
+    onSaveCrate: () => void;
+    onSaveEntityTemplate: () => void;
+    onWarning: () => void;
+    onError: () => void;
+}
+declare const RenderEntity: React.ForwardRefExoticComponent<RenderEntityProps & React.RefAttributes<any>>;
+export default RenderEntity;

package/dist/crate-builder/RenderEntity/UnlinkEntity.d.ts

@@ -0,0 +1,14 @@
+import { default as React } from 'react';
+interface UnlinkEntityProps {
+    entity: {
+        '@id': string;
+        [key: string]: any;
+    };
+    onUnlinkEntity: (data: {
+        entity: {
+            '@id': string;
+        };
+    }) => void;
+}
+declare const UnlinkEntity: React.FC<UnlinkEntityProps>;
+export default UnlinkEntity;

package/dist/crate-builder/RenderEntity/auto-complete.lib.d.ts

@@ -0,0 +1,25 @@
+interface LookupConfig {
+    config: any;
+    lookup: any;
+    crateManager: any;
+}
+interface LookupResult {
+    endpoint: string;
+    documents: any[];
+}
+export declare class Lookup {
+    private config;
+    private lookup;
+    private crateManager;
+    constructor({ config, lookup, crateManager }: LookupConfig);
+    getEntities(type: string, queryString: string): Promise<LookupResult>;
+    dataPacks(type: string, queryString: string): Promise<LookupResult>;
+    entities(type: string, queryString: string): Promise<LookupResult>;
+    entityTemplates(type: string, queryString: string): Promise<LookupResult>;
+    ror(queryString: string): Promise<LookupResult>;
+}
+export declare function awaitTimeout(delay: number, reason?: any): Promise<any>;
+export declare function wrapPromise<T>(promise: Promise<T>, delay: number, reason?: {
+    reason: string;
+}): Promise<T>;
+export {};

package/dist/crate-builder/RenderEntity/keys.d.ts

@@ -0,0 +1,4 @@
+export declare const crateManagerKey: unique symbol;
+export declare const profileManagerKey: unique symbol;
+export declare const lookupsKey: unique symbol;
+export declare const configurationKey: unique symbol;