@arpproject/recrate 0.1.2

package/src/crate-builder/profile-schema.json

@@ -0,0 +1,145 @@
+{
+    "title": "Validate Profile",
+    "description": "Validate a describo profile",
+    "type": "object",
+    "properties": {
+        "metadata": {
+            "description": "Metadata about this profile",
+            "type": "object",
+            "properties": {
+                "name": { "type": "string" },
+                "description": { "type": "string" },
+                "version": { "type": "number" },
+                "keywords": { "type": "array", "items": { "type": "string" } },
+                "warnMissingProperty": { "type": "boolean" },
+                "enableEntityTimestamps": { "type": "boolean" }
+            },
+            "required": ["name", "description", "version"],
+            "additionalProperties": false
+        },
+        "context": {
+            "anyOf": [{ "type": "array" }, { "type": "string" }, { "type": "object" }]
+        },
+        "propertyAssociations": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "properties": {
+                    "property": { "type": "string" },
+                    "propertyId": { "type": "string" },
+                    "inverse": {
+                        "type": "object",
+                        "properties": {
+                            "property": { "type": "string" },
+                            "propertyId": { "type": "string" }
+                        }
+                    }
+                }
+            }
+        },
+        "layouts": {
+            "description": "Layout definitions for property groups",
+            "type": "array",
+            "items": {
+                "type": "object",
+                "properties": {
+                    "appliesTo": { "type": "array", "items": { "type": "string" } },
+                    "^[A-Z,a-z]*": {
+                        "type": "object",
+                        "properties": {
+                            "label": { "type": "string" },
+                            "description": { "type": "string" },
+                            "order": { "type": "string" }
+                        },
+                        "required": ["label", "description", "order"]
+                    }
+                }
+            }
+        },
+        "resolve": {
+            "description": "Configuration to resolve property associations",
+            "type": "array",
+            "items": {
+                "type": "object",
+                "properties": {
+                    "types": { "type": "array", "items": { "type": "string" } },
+                    "properties": { "type": "array", "items": { "type": "string" } }
+                },
+                "required": ["types", "properties"],
+                "additionalProperties": false
+            }
+        },
+        "localisation": {
+            "description": "Configuration to localise class names",
+            "type": "object",
+            "patternProperties": {
+                "^[A-Z,a-z]*": {
+                    "type": "string"
+                }
+            }
+        },
+        "classes": {
+            "description": "Class definitions",
+            "type": "object",
+            "patternProperties": {
+                "^[A-Z,a-z]*": {
+                    "type": "object",
+                    "properties": {
+                        "definition": {
+                            "type": "string",
+                            "enum": ["inherit", "override"]
+                        },
+                        "subClassOf": { "type": "array", "items": { "type": "string" } },
+                        "inputs": {
+                            "type": "array",
+                            "items": {
+                                "type": "object",
+                                "properties": {
+                                    "id": { "type": "string" },
+                                    "name": { "type": "string" },
+                                    "label": { "type": "string" },
+                                    "multiple": { "type": "boolean" },
+                                    "required": { "type": "boolean" },
+                                    "hide": { "type": "boolean" },
+                                    "readonly": { "type": "boolean" },
+                                    "group": { "type": "string" },
+                                    "type": {
+                                        "anyOf": [
+                                            { "type": "array", "items": { "type": "string" } },
+                                            {
+                                                "type": "string",
+                                                "enum": ["Select", "MultiSelect", "Value"]
+                                            }
+                                        ]
+                                    }
+                                },
+                                "required": ["id", "name", "type"],
+                                "additionalProperties": true
+                            }
+                        },
+                        "label": { "type": "string" }
+                    },
+                    "required": ["definition", "subClassOf", "inputs"],
+                    "additionalProperties": false
+                }
+            }
+        },
+        "lookup": {
+            "description": "Lookup definitions",
+            "type": "object",
+            "patternProperties": {
+                "^[A-Z,a-z]*": {
+                    "type": "object",
+                    "properties": {
+                        "fields": { "type": "array" },
+                        "datapacks": { "type": "array", "items": { "type": "string" } }
+                    },
+                    "required": ["fields", "datapacks"],
+                    "additionalProperties": false
+                }
+            }
+        }
+    },
+    "required": ["metadata", "classes"],
+    "additionalProperties": false
+}

package/src/crate-builder/property-definitions.ts

@@ -0,0 +1,78 @@
+export const propertyDefinitions = {
+    crate: {
+        type: [Object, undefined],
+    },
+    profile: {
+        type: [Object, undefined],
+    },
+    entityId: {
+        type: [String, undefined],
+    },
+    lookup: {
+        type: [Object, undefined],
+    },
+    enableContextEditor: {
+        type: Boolean,
+        default: true,
+        validator: (val: boolean) => [true, false].includes(val),
+    },
+    enableCratePreview: {
+        type: Boolean,
+        default: true,
+        validator: (val: boolean) => [true, false].includes(val),
+    },
+    enableBrowseEntities: {
+        type: Boolean,
+        default: true,
+        validator: (val: boolean) => [true, false].includes(val),
+    },
+    enableTemplateSave: {
+        type: Boolean,
+        default: false,
+        validator: (val: boolean) => [true, false].includes(val),
+    },
+    enableReverseLinkBrowser: {
+        type: Boolean,
+        default: false,
+        validator: (val: boolean) => [true, false].includes(val),
+    },
+    enableUrlMarkup: {
+        type: Boolean,
+        default: true,
+        validator: (val: boolean) => [true, false].includes(val),
+    },
+    enableEntityTimestamps: {
+        type: Boolean,
+        default: false,
+        validator: (val: boolean) => [true, false].includes(val),
+    },
+    purgeUnlinkedEntities: {
+        type: Boolean,
+        default: true,
+        validator: (val: boolean) => [true, false].includes(val),
+    },
+    readonly: {
+        type: Boolean,
+        default: false,
+        validator: (val: boolean) => [true, false].includes(val),
+    },
+    webComponent: {
+        type: Boolean,
+        default: false,
+        validator: (val: boolean) => [true, false].includes(val),
+    },
+    tabLocation: {
+        type: String,
+        default: "left",
+        validator: (val: string) => ["top", "bottom", "left", "right"].includes(val),
+    },
+    showControls: {
+        type: Boolean,
+        default: true,
+        validator: (val: boolean) => [true, false].includes(val),
+    },
+    language: {
+        type: String,
+        default: "en",
+    },
+};

package/src/crate-builder/store.ts

@@ -0,0 +1,14 @@
+import { create } from 'zustand';
+import { EditorState } from "./editor-state";
+
+interface Store {
+  configuration: Record<string, any>;
+  editorState: EditorState;
+  setConfiguration: (config: Record<string, any>) => void;
+}
+
+export const useStateStore = create<Store>((set) => ({
+  configuration: {},
+  editorState: new EditorState(),
+  setConfiguration: (config) => set({ configuration: config }),
+}));

package/src/crate-builder/tailwind.css

@@ -0,0 +1,7 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;
+
+/* a {
+    @apply text-blue-600 text-lg tracking-wide;
+} */

package/src/crate-builder/types.d.ts

@@ -0,0 +1,318 @@
+// CRATE RELATED DEFINITIONS
+// Entity Type Definition
+export type PrimitiveType = string | number | boolean;
+
+export type EntityReference = {
+    "@id": string;
+};
+
+export interface UnverifiedEntityDefinition {
+    "@id"?: string;
+    "@type"?: (string | number | boolean)[] | string | number | boolean;
+    name?: string;
+    [key: string]:
+        | (PrimitiveType | EntityReference | undefined | null)[]
+        | PrimitiveType
+        | EntityReference;
+}
+
+export interface NormalisedEntityDefinition {
+    "@id": string;
+    "@type": string[];
+    name: string;
+    [key: string]: (PrimitiveType | EntityReference)[];
+}
+
+// Context Type Definition
+export type UnverifiedContext = any;
+
+type NormalisedContext = [
+    ...string[],
+    {
+        [key: string]: string;
+    },
+];
+
+// Crate Type Definition
+export interface UnverifiedCrate {
+    "@context": UnverifiedContext;
+    "@graph": UnverifiedEntityDefinition[];
+}
+
+export interface NormalisedCrate {
+    "@context": NormalisedContext;
+    "@graph": NormalisedEntityDefinition[];
+}
+
+export class CrateManagerType {
+    crate: {
+        "@context": NormalisedContext;
+        "@graph": Array<NormalisedEntityDefinition | undefined>;
+    };
+    pm: ProfileManagerType;
+    reverse: {
+        [key: string]: any;
+    };
+    graphLength: number;
+    rootDescriptor?: number;
+    rootDataset?: number;
+    entityIdIndex: {
+        [key: string]: number;
+    };
+    providedContext: UnverifiedContext;
+    contextDefinitions: { [key: string]: boolean };
+    localContext: { [key: string]: string };
+    entityTypes: { [key: string]: number };
+    entityTimestamps: Boolean;
+    blankNodes: string[];
+    coreProperties: string[];
+    errors: {
+        hasError: Boolean;
+        init: { description: string; messages: string[] };
+        missingIdentifier: { description: string; entity: UnverifiedEntityDefinition[] };
+        missingTypeDefinition: { description: string; entity: UnverifiedEntityDefinition[] };
+        invalidIdentifier: { description: string; entity: UnverifiedEntityDefinition[] };
+    };
+    warnings: {
+        hasWarning: Boolean;
+        init: { description: string; messages: string[] };
+        invalidIdentifier: { description: string; entity: UnverifiedEntityDefinition[] };
+    };
+    constructor({
+        crate,
+        pm,
+        context = undefined,
+        entityTimestamps = false,
+    }: {
+        crate: UnverifiedCrate;
+        pm: ProfileManagerType;
+        context: UnverifiedContext;
+        entityTimestamps: Boolean;
+    });
+    getContext(): NormalisedContext;
+    setContext(context: NormalisedContext);
+    setProfileManager(pm: ProfileManagerType);
+    getRootDataset(): NormalisedEntityDefinition;
+    getEntity({
+        id,
+        stub = false,
+        link = true,
+        materialise = true,
+    }: {
+        id: string;
+        stub?: boolean;
+        link?: boolean;
+        materialise?: boolean;
+    }): NormalisedEntityDefinition | undefined;
+    getEntityTypes(): string[];
+    *getEntities(
+        params: { limit?: number; query?: string; type?: string } = {
+            limit: undefined,
+            query: undefined,
+            type: undefined,
+        }
+    ): Generator<NormalisedEntityDefinition>;
+    locateEntity({
+        entityIds,
+        strict = true,
+    }: {
+        entityIds: string[];
+        strict?: boolean;
+    }): NormalisedEntityDefinition[] | undefined;
+    resolveLinkedEntityAssociations({
+        entity,
+        profile,
+    }: {
+        entity: NormalisedEntityDefinition;
+        profile: NormalisedProfile;
+    }):
+        | {
+              property: string;
+              "@id": string;
+              "@type": string[];
+              name: string;
+          }[]
+        | [];
+    addEntity(entity: UnverifiedEntityDefinition): NormalisedEntityDefinition;
+    addBlankNode(type: string): NormalisedEntityDefinition;
+    addFileOrFolder({
+        path,
+        type = "File",
+    }: {
+        path: string;
+        type: string;
+    }): NormalisedEntityDefinition;
+    addFile(path: string): NormalisedEntityDefinition;
+    addFolder(path: string): NormalisedEntityDefinition;
+    deleteEntity({ id }: { id: string });
+    setProperty({
+        id,
+        property,
+        propertyId,
+        value,
+    }: {
+        id: string;
+        property: string;
+        propertyId?: string;
+        value: PrimitiveType | EntityReference;
+    }): boolean | undefined;
+    updateProperty({
+        id,
+        property,
+        idx,
+        value,
+    }: {
+        id: string;
+        property: string;
+        idx?: number;
+        value: PrimitiveType | PrimitiveType[] | EntityReference;
+    }): NormalisedEntityDefinition | undefined | string;
+    deleteProperty({ id, property, idx }: { id: string; property: string; idx?: number });
+    ingestAndLink({
+        id = undefined,
+        property = undefined,
+        propertyId = undefined,
+        json = {},
+    }: {
+        id: string | undefined;
+        property: string | undefined;
+        propertyId: string | undefined;
+        json: UnverifiedEntityDefinition;
+    });
+    flatten(json: UnverifiedEntityDefinition): NormalisedEntityDefinition[];
+    linkEntity({
+        id,
+        property,
+        propertyId = undefined,
+        value,
+    }: {
+        id: string;
+        property: string;
+        propertyId?: string;
+        value: { "@id": string };
+    }): void;
+    unlinkEntity({
+        id = undefined,
+        property = undefined,
+        value = undefined,
+        stop = false,
+    }: {
+        id: string | undefined;
+        property: string | undefined;
+        value: { "@id": string } | undefined;
+        stop?: boolean;
+    });
+    purgeUnlinkedEntities(): void;
+    exportCrate(): NormalisedCrate;
+    exportEntityTemplate({
+        id,
+        resolveDepth = 0,
+    }: {
+        id: string;
+        resolveDepth: number;
+    }): NormalisedEntityDefinition;
+    getErrors(): errorsInterface;
+    getWarnings(): warningsInterface;
+    __updateContext({ name, id }: { name: string; id?: string }): void;
+    __normaliseContext(context: UnverifiedContext): NormalisedContext;
+    __storeEntityType(entity: NormalisedEntityDefinition): void;
+    __removeEntityType(entity: NormalisedEntityDefinition);
+    __collectAllDefinitions(context: NormalisedContext): { [key: string]: boolean };
+    __setError(error: keyof typeof this.errors, entity: string | UnverifiedEntityDefinition);
+    __setWarning(warning: keyof typeof this.warnings, entity: string | UnverifiedEntityDefinition);
+    __materialiseEntity({ id }: { id: string }): NormalisedEntityDefinition;
+    __confirmNoClash({
+        entity,
+        mintNewId = true,
+    }: {
+        entity: NormalisedEntityDefinition;
+        mintNewId?: boolean;
+    }): NormalisedEntityDefinition | boolean;
+    __updateEntityId({ oldId, newId }: { oldId: string; newId: string });
+    __addReverse({ id, property, value }: { id: string; property: string; value: EntityReference });
+    __removeAssociations(entity: NormalisedEntityDefinition): NormalisedEntityDefinition;
+}
+
+// PROFILE RELATED DEFINITIONS
+export interface ProfileLayoutGroup {
+    name: string;
+    label: string;
+    description?: string;
+    order?: number;
+    inputs: ProfileInput[];
+    properties?: string[];
+    hasData?: boolean;
+    missingRequiredData?: boolean;
+}
+export interface ProfileLayout {
+    appliesTo: string[];
+    [key: string]: ProfileLayoutGroup;
+}
+
+export type ProfileAssociation = {
+    property: string;
+    propertyId: string;
+    inverse: { property: string; propertyId: string };
+};
+
+export type ProfileInput = {
+    id: string;
+    name: string;
+    label?: string;
+    help?: string;
+    required?: boolean;
+    multiple?: boolean;
+    hide?: boolean;
+    group?: string;
+    type: string[];
+    style?: "checkbox" | "radio" | "dropdown";
+    handledMultipleValues?: boolean;
+    values?: string[] | { "@id": string; "@type": string; name: string }[];
+};
+export interface NormalisedProfile {
+    metadata: {
+        name: string;
+        id: string;
+        description: string;
+        version: number | string;
+        keywords: string | string[];
+        warnMissingProperty: boolean;
+    };
+    context?: string | (string | { [key: string]: string })[] | { [key: string]: string };
+    layouts?: ProfileLayout[];
+    resolve?: {
+        types: string[];
+        properties: string[];
+    }[];
+    propertyAssociations?: ProfileAssociation[];
+    localisation?: { [key: string]: string };
+    lookup?: {
+        [key: string]: { fields: stringp[]; datapacks: string[] };
+    };
+    classes: {
+        [className: string]: {
+            definition: "override" | "inherit";
+            subClassOf: string[];
+            inputs: ProfileInput[];
+        };
+    };
+}
+
+export class ProfileManagerType {
+    profile: Profile;
+    context?: any;
+    $key?: number;
+    constructor({ profile }: { profile: Profile });
+    getLayout({ entity }: { entity: Entity }): Layout | null;
+    getPropertyAssociations(): { [key: string]: { property: string; propertyId?: string } };
+    getClasses(): string[];
+    getEntityTypeHierarchy({ entity }: { entity: Entity }): string[];
+    getPropertyDefinition({ property, entity }: { property: string; entity: Entity }): {
+        propertyDefinition: any;
+    };
+    mapTypeHierarchies({ types }: { types: string[] }): string[];
+    getInputsFromProfile({ entity }: { entity: Entity }): any[];
+    getAllInputs({ entity }: { entity: Entity }): { inputs: any[] };
+    getTypeDefinition({ entity }: { entity: Entity }): "inherit" | "override";
+    getTypeLabel(type: string): string;
+}

package/src/examples/collection/collections-entity-example.json

@@ -0,0 +1,131 @@
+{
+    "describoId": "zk9xqkuvq4s4ij0mrp45s1p0liy4b2wf",
+    "@id": "#E000245",
+    "@type": "Entity",
+    "name": "School Bell Games",
+    "properties": {
+        "entityType": [
+            {
+                "propertyId": "iip3t9ggb7vuv95h062sgcerrzalz7ld",
+                "srcEntityId": "zk9xqkuvq4s4ij0mrp45s1p0liy4b2wf",
+                "property": "entityType",
+                "tgtEntityId": "hykc9sqehehwrh900ll0pvs9resjbmx4",
+                "tgtEntity": {
+                    "@id": "#Playground%20Game%20-%20Miscellaneous%20Activities",
+                    "@type": "EntityType",
+                    "name": "Playground Game - Miscellaneous Activities"
+                }
+            }
+        ],
+        "identifier": [
+            {
+                "propertyId": "lcg05iv9eprttsp705tfogh1apm7tii0",
+                "srcEntityId": "zk9xqkuvq4s4ij0mrp45s1p0liy4b2wf",
+                "property": "identifier",
+                "value": "E000245"
+            }
+        ],
+        "efunction": [
+            {
+                "propertyId": "j1zboiqcf56bs3jszkf5tdtg8y0xbs44",
+                "srcEntityId": "zk9xqkuvq4s4ij0mrp45s1p0liy4b2wf",
+                "property": "efunction",
+                "value": "Language Play, Playground Game, Quiet Play"
+            }
+        ],
+        "esumnote": [
+            {
+                "propertyId": "jqphzadq9pwb4gfurr3roba1lpvhs28i",
+                "srcEntityId": "zk9xqkuvq4s4ij0mrp45s1p0liy4b2wf",
+                "property": "esumnote",
+                "value": "At some schools the bell provokes certain play activities."
+            }
+        ],
+        "efullnote": [
+            {
+                "propertyId": "qmn9qu0ltk0ta7ldphgzwgegvuzw0m0l",
+                "srcEntityId": "zk9xqkuvq4s4ij0mrp45s1p0liy4b2wf",
+                "property": "efullnote",
+                "value": "<H4>At Erskineville</H4>\r\n\r\nWaiting for the Bell\r\n\r\nTha Whole School is involved\r\n\r\n<em>Please see the attached sheet for full details of how the game worked.</em>\r\n\r\n<H4>At BBC</H4>\r\n\r\nSaved by the bell\r\n\r\nPlayers: Any number\r\nBoys\r\nAge: 8\r\n\r\nWhen the bell goes, someone can say, “Saved by the bell!” and that saves the game until the next play time when it can be continued.   In cricket, the person batting stays in, in other games players who are tagged by ‘It’ after they’ve said “Saved by the bell!” are not ‘It’, etc.\r\n\r\n(JMcK note:  There is a similar function in electronic video games, where players can save the game at a certain point and resume playing when they want to.)"
+            }
+        ],
+        "eappenddate": [
+            {
+                "propertyId": "c9oph2tz0k2j6a784gnytdnhx4y0w22m",
+                "srcEntityId": "zk9xqkuvq4s4ij0mrp45s1p0liy4b2wf",
+                "property": "eappenddate",
+                "value": "2009-03-20 15:34:43"
+            }
+        ],
+        "relationshipObject": [
+            {
+                "propertyId": "tu62i83pl38ifqq2qtv7o01iqqpk7476",
+                "srcEntityId": "zk9xqkuvq4s4ij0mrp45s1p0liy4b2wf",
+                "property": "relationshipObject",
+                "tgtEntityId": "a3m9hunrx7ira5mwea8pfe8ksmb70305",
+                "tgtEntity": {
+                    "@id": "#E000011",
+                    "@type": "Entity",
+                    "name": "McKinty, Judith"
+                }
+            },
+            {
+                "propertyId": "vj7vz80ip88f7jsy43gk4vwfpcztly0o",
+                "srcEntityId": "zk9xqkuvq4s4ij0mrp45s1p0liy4b2wf",
+                "property": "relationshipObject",
+                "tgtEntityId": "v43mdyp7i1z9jphhlf0f2c38n4pv1laz",
+                "tgtEntity": {
+                    "@id": "#E000233",
+                    "@type": "Entity",
+                    "name": "Erskineville Public School"
+                }
+            },
+            {
+                "propertyId": "d1mdul4lf10lanflfh1k1cm7pxaxwphd",
+                "srcEntityId": "zk9xqkuvq4s4ij0mrp45s1p0liy4b2wf",
+                "property": "relationshipObject",
+                "tgtEntityId": "u8qciqnf77gycqfu114atwcrfq3ow1kp",
+                "tgtEntity": {
+                    "@id": "#E000352",
+                    "@type": "Entity",
+                    "name": "Brisbane Boys College"
+                }
+            }
+        ],
+        "relationshipSubject": [
+            {
+                "propertyId": "tsl8pakdltn56gla8rxl2wdkgi932cu0",
+                "srcEntityId": "zk9xqkuvq4s4ij0mrp45s1p0liy4b2wf",
+                "property": "relationshipSubject",
+                "tgtEntityId": "v43mdyp7i1z9jphhlf0f2c38n4pv1laz",
+                "tgtEntity": {
+                    "@id": "#E000233",
+                    "@type": "Entity",
+                    "name": "Erskineville Public School"
+                }
+            },
+            {
+                "propertyId": "oqir5ek9px3jm4s45k1ti76s9xu4pnl6",
+                "srcEntityId": "zk9xqkuvq4s4ij0mrp45s1p0liy4b2wf",
+                "property": "relationshipSubject",
+                "tgtEntityId": "a3m9hunrx7ira5mwea8pfe8ksmb70305",
+                "tgtEntity": {
+                    "@id": "#E000011",
+                    "@type": "Entity",
+                    "name": "McKinty, Judith"
+                }
+            },
+            {
+                "propertyId": "n1qy3uk9bz78bf4qnz11kv5sxacn84k4",
+                "srcEntityId": "zk9xqkuvq4s4ij0mrp45s1p0liy4b2wf",
+                "property": "relationshipSubject",
+                "tgtEntityId": "u8qciqnf77gycqfu114atwcrfq3ow1kp",
+                "tgtEntity": {
+                    "@id": "#E000352",
+                    "@type": "Entity",
+                    "name": "Brisbane Boys College"
+                }
+            }
+        ]
+    }
+}