@arpproject/recrate 0.1.2

package/.eslintrc.json

@@ -0,0 +1,37 @@
+{
+  "env": {
+    "browser": true,
+    "es2021": true
+  },
+  "extends": [
+    "eslint:recommended",
+    "plugin:react/recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:react-hooks/recommended",
+    "plugin:storybook/recommended"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaFeatures": {
+      "jsx": true
+    },
+    "ecmaVersion": 12,
+    "sourceType": "module"
+  },
+  "plugins": [
+    "react",
+    "@typescript-eslint",
+    "react-hooks"
+  ],
+  "rules": {
+    "react/react-in-jsx-scope": "off",
+    "react/prop-types": "off",
+    "@typescript-eslint/explicit-module-boundary-types": "off",
+    "@typescript-eslint/no-explicit-any": "warn"
+  },
+  "settings": {
+    "react": {
+      "version": "detect"
+    }
+  }
+}

package/.storybook/main.ts

@@ -0,0 +1,40 @@
+import type { StorybookConfig } from '@storybook/react-vite';
+import { mergeConfig } from 'vite';
+import postcss from 'postcss';
+
+const config: StorybookConfig = {
+  stories: [
+    '../src/**/*.stories.mdx',
+    '../src/**/*.stories.@(js|jsx|ts|tsx)'
+  ],
+  addons: [
+    {
+      name: '@storybook/addon-postcss',
+      options: {
+        postcssLoaderOptions: {
+          implementation: postcss,
+        },
+      },
+    },
+    '@storybook/addon-links',
+    '@storybook/addon-essentials',
+    '@storybook/addon-interactions',
+  ],
+  framework: {
+    name: '@storybook/react-vite',
+    options: {},
+  },
+  docs: {
+    autodocs: true,
+  },
+  typescript: {
+    reactDocgen: 'react-docgen-typescript',
+  },
+  async viteFinal(config) {
+    return mergeConfig(config, {
+      define: { 'process.env': { ...process.env } },
+    });
+  },
+};
+
+export default config;

package/.storybook/preview.tsx

@@ -0,0 +1,46 @@
+import '../src/crate-builder/tailwind.css';
+import '@fortawesome/fontawesome-free/js/all';
+import { config as faConfig } from '@fortawesome/fontawesome-svg-core';
+import i18next from 'i18next';
+import { initReactI18next, I18nextProvider } from 'react-i18next';
+import React from 'react';
+
+// FontAwesome config
+faConfig.autoReplaceSvg = 'nest';
+
+// i18n setup (minimal, expand as needed)
+i18next
+  .use(initReactI18next)
+  .init({
+    lng: process.env.STORYBOOK_LANG ?? 'en',
+    resources: {
+      en: {
+        translation: {
+          // Add your translations here
+        }
+      }
+    },
+    interpolation: { escapeValue: false }
+  });
+
+export const decorators = [
+  (Story) => (
+    <I18nextProvider i18n={i18next}>
+      <Story />
+    </I18nextProvider>
+  ),
+];
+
+const preview = {
+  parameters: {
+    actions: { argTypesRegex: '^on[A-Z].*' },
+    controls: {
+      matchers: {
+        color: /(background|color)$/i,
+        date: /Date$/,
+      },
+    },
+  },
+};
+
+export default preview;

package/LICENCE

@@ -0,0 +1,18 @@
+MIT License
+
+Copyright (c) 2023 - present, Marco La Rosa.
+
+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.md

@@ -0,0 +1,83 @@
+# Note
+
+For the main Describo project visit: https://www.npmjs.com/package/@describo/crate-builder-component
+
+This is a fork of the Crate Builder Component for use in the [ARP project](https://researchdata.hu/en). Contains additions and modifications necessary for the ARP project that are not present/required/supported by the original component. We, however, try to keep compatibilioty with the original project as much as possible and update to its new version. 
+
+The package version matches the latest version  of the original Crate Builder project (eg. 0.80.0) and an additional `-arp.X` marks the patch version for ARP. For example, `0.80.0-arp.12` is based on the `0.80.0` version of the Crate Builder Component and is the `12th` patched version of it for use in ARP.
+
+# Crate Builder Component
+
+-   [Crate Builder Component](#crate-builder-component)
+-   [Documentation](#documentation)
+-   [API Documentation](#api-documentation)
+-   [Developing the plugin](#developing-the-plugin)
+    -   [Storybook](#storybook)
+    -   [Development application](#development-application)
+-   [Building and publishing a release](#building-and-publishing-a-release)
+-   [Building and publishing API docs - has to be separate stage](#building-and-publishing-api-docs---has-to-be-separate-stage)
+-   [Repository structure](#repository-structure)
+
+This is the core UI component for assembling an RO-Crate inside Describo. It is a self contained
+VueJS component that can be used inside your app. If you use this component, your app is responsible
+for loading the crate file from the storage layer (or minting a new one if none exists) and saving
+the updated crate back. Your app can also provide a profile to the component and a class to handle
+template lookups.
+
+# Documentation
+
+Comprehensive documentation is available @
+[https://describo.github.io/docs/component/introduction.html](https://describo.github.io/docs/component/introduction.html)
+
+# API Documentation
+
+-   [CrateManager](https://describo.github.io/crate-builder-component/CrateManager.html)
+-   [ProfileManager](https://describo.github.io/crate-builder-component/ProfileManager.html)
+-   [EditorState](https://describo.github.io/crate-builder-component/EditorState.html)
+
+# Developing the plugin
+
+## Storybook
+
+[Storybook](storybook.js.org/) is used in this application. When you are just developing the
+components, storybook is what you want as you can focus just on the component in isolation. To start
+it run:
+
+```
+npm run storybook
+```
+
+## Development application
+
+When you want to see the component in action as a whole, there is a small VueJS app in this
+codebase. To start up the dev environment:
+
+```
+> docker compose up (starts up an elastic search container for datapack lookups)
+> npm run develop
+
+--> browse to localhost:9000
+```
+
+# Building and publishing a release
+
+-   `npm run build`: This builds the plugin and styles that the react component uses
+-   `npm version {minor|patch}`
+-   `git push origin master --tags`
+-   Go to the repo and create a release from the tag, documenting what is in it.
+-   Publish to npm: `npm publish`
+-   Create an issue in the
+    [React component issue tracker](https://github.com/describo/crate-builder-component-react/issues)
+    to inform that a new release of that component needs to be built and published to npm.
+
+# Building and publishing API docs - has to be separate stage
+
+-   `npm run docs`: Update the jsdoc documentation
+-   `git add . && git commit -a`
+-   `git push origin master --tags`
+
+# Repository structure
+
+-   The development app is at `./src/app`. In there you will find the file main.js where we import
+    the plugin and wire it into Vue as well as an App.vue file where we load the component.
+-   The component is at `./src/crate-builder`.

package/babel.config.json

@@ -0,0 +1,5 @@
+{
+    "presets": ["@babel/preset-env"],
+    "ignore": ["node_modules"],
+    "only": ["src"]
+}

package/dist/app/App.d.ts

@@ -0,0 +1,2 @@
+declare function App(): import("react/jsx-runtime").JSX.Element;
+export default App;

package/dist/app/EmbeddedComponent.d.ts

@@ -0,0 +1,3 @@
+import { default as React } from 'react';
+declare const EmbeddedComponent: React.FC;
+export default EmbeddedComponent;

package/dist/app/lookup.d.ts

@@ -0,0 +1,82 @@
+export declare class Lookup {
+    constructor();
+    /**
+     * This method is used to lookup entities created by users and saved for their
+     *  own personal use. How you implement that, if you do at all, is up to you.
+     *  In desktop for example, when the user saves a template, that entity gets stored
+     *  in their local database.
+     *
+     * @param {Object} params
+     * @param {Array | String} params.type: the type array or type string of the entity being looked up
+     * @param {String} params.queryString: the query string typed in by the user
+     * @param {Number} params.limit=5: the number of matches to return - default = 5
+     *
+     * @returns {Object} { documents: [...]} - Object with documents array
+     */
+    entityTemplates({ type, queryString, limit }: {
+        type?: undefined;
+        queryString?: undefined;
+        limit?: number | undefined;
+    }): Promise<{
+        documents: never[];
+    }>;
+    /**
+     *
+     * This method is used to lookup data packs. Data packs are JSON-LD snippets that
+     *  have been created by an expert/s and can be trusted as being valid and correct.
+     *
+     * @param {Object} params
+     * @param {Object} params.elasticQuery: a query object to be used against an elastic search server
+     * @param {Array | String} params.type: the type array or type string of the entity being looked up
+     * @param {String} params.queryString: the query string typed in by the user
+     * @param {Array | String} params.fields: the fields to search against in the data pack json objects
+     * @param {Array | String} params.datapack: the datapack or packs with the data to be used for this entity type
+     * @param {Number} params.limit=10: the number of matches to return - default = 10
+     *
+     * @returns {Object} { documents: [...]} - Object with documents array
+     */
+    dataPacks({ elasticQuery, type, queryString, fields, datapacks, limit, }: {
+        elasticQuery?: undefined;
+        type?: undefined;
+        queryString?: undefined;
+        fields?: undefined;
+        datapacks?: undefined;
+        limit?: number | undefined;
+    }): Promise<{
+        documents: any;
+    }>;
+    /**
+     * This method is used to lookup user created entities in, for example, a repository. Imagine
+     *  a user creates an entity of type Country that overlaps with a Country in the data pack (same @id for both).
+     *  The user created Country may not be correct but if it has the same @id and is stored
+     *  in the same index, it will overrwrite the datapack version which is valid and correct.
+     *
+     * So, by separating out general entity lookups from data packs, you can store data in a way
+     *  where user created stuff doesn't trample known good content.
+     *
+     * @param {Object} params
+     * @param {Object} params.elasticQuery: a query object to be used against an elastic search server
+     * @param {Array | String} params.type: the type array or type string of the entity being looked up
+     * @param {String} params.queryString: the query string typed in by the user
+     * @param {Array | String} params.fields: the fields to search against in the data pack json objects
+     * @param {Array | String} params.datapack: the datapack or packs with the data to be used for this entity type
+     * @param {Number} params.limit=10: the number of matches to return - default = 10
+     * @returns {Object} { documents: [...]} - Object with documents array
+     *
+     * @returns
+     */
+    entities({ elasticQuery, type, queryString, fields, limit, }: {
+        elasticQuery?: undefined;
+        type?: undefined;
+        queryString?: undefined;
+        fields?: undefined;
+        limit?: number | undefined;
+    }): Promise<{
+        documents: any;
+    }>;
+    /** private method */
+    _execute({ query, indexPath }: {
+        query: Record<string, any>;
+        indexPath: string;
+    }): Promise<any>;
+}

package/dist/crate-builder/CrateManager/contexts.d.ts

@@ -0,0 +1,6 @@
+export declare function getContextDefinition(id: string): {
+    href: string;
+    definitions: {
+        [key: string]: boolean;
+    };
+};

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

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

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

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