Merge pull request #283 from kit-data-manager/indexedDB-integration

Integration of Indexed DB

.github/workflows/deploy-storybook.yml

@@ -6,29 +6,28 @@ on:
 
 jobs:
   build-component:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/[email protected]
-
-      - name: Build
-        run: npm ci
-
-  deploy-storybook:
     runs-on: ubuntu-latest
     permissions:
       contents: read
       pages: write
       id-token: write
-
     steps:
-      - name: Checkout
-        uses: actions/[email protected]
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - name: npm ci
+        run: npm ci
+      - name: Build component
+        run: npm run build
+      - name: Build Storybook
+        run: npm run build-storybook
+      - name: Upload Storybook to GitHub Pages
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: "storybook-static"
 
-      - name: Deploy Storybook to GitHub Pages
-        uses: bitovi/github-actions-storybook-to-github-pages@v1.0.3
+      - name: Deploy to GitHub Pages
+        uses: actions/deploy-pages@v4
         with:
-          path: storybook-static
-          build_command: |
-            npm run build
-            npm run build-storybook
+          token: ${{ github.token }}

.github/workflows/github-npm-publish.yml

@@ -11,10 +11,10 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4.1.7
+      - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version: 16
+          node-version: 20
       - run: npm ci
 
   publish-gpr:
@@ -24,10 +24,10 @@ jobs:
       contents: read
       packages: write
     steps:
-      - uses: actions/checkout@v4.1.7
+      - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version: 16
+          node-version: 20
           registry-url: https://npm.pkg.github.com/
       - run: npm ci
       - run: npm publish

.github/workflows/real-npm-publish.yml

@@ -8,10 +8,10 @@ jobs:
   publish-npm:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4.1.7
+      - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version: 19
+          node-version: 20
           registry-url: https://registry.npmjs.org/
       - run: npm clean-install
       - run: npm run build

.prettierignore

@@ -1,7 +1,9 @@
 # Ignore artifacts:
-.stencil
-.storybook
-dist
-loader
-node_modules
-www
+/src/index.html
+/www/
+/node_modules/
+/dist/
+/loader/
+/.storybook/
+/.stencil/
+/storybook-static/

.storybook/main.ts

@@ -1,14 +1,17 @@
-const config = {
+export default {
   stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],
-  addons: ['@storybook/addon-links', '@storybook/addon-essentials'],
-  staticDirs: [{from: '../dist', to: '/assets'}, {from: '../loader', to: '/assets'}],
-  framework: {
-    name: '@storybook/web-components-vite',
-    options: {},
+  addons: [
+    '@storybook/addon-links',
+    '@storybook/addon-essentials'
+  ],
+  staticDirs: [{ from: '../dist', to: '/assets' }, { from: '../loader', to: '/assets' }],
+  framework: '@storybook/web-components-vite',
+  docs: {
+    source: {
+      type: 'code',
+    }
   },
-  docs: {},
   core: {
     disableTelemetry: true,
-  }
+  },
 };
-export default config;

.storybook/preview.ts

@@ -3,7 +3,7 @@ import { defineCustomElements } from '../loader';
 
 defineCustomElements();
 
-const preview = {
+export default {
   parameters: {
     controls: {
       matchers: {
@@ -12,6 +12,6 @@ const preview = {
       },
     },
   },
-};
 
-export default preview;
+  tags: ['autodocs']
+};

CODE_OF_CONDUCT.md

@@ -3,7 +3,7 @@
 ## Our Pledge
 
 In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
+contributors and maintainers pledge to make participation in our project and
 our community a harassment-free experience for everyone, regardless of age, body
 size, disability, ethnicity, gender identity and expression, level of experience,
 education, socio-economic status, nationality, personal appearance, race,
@@ -14,21 +14,21 @@ religion, or sexual identity and orientation.
 Examples of behavior that contributes to creating a positive environment
 include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
+- The use of sexualized language or imagery and unwelcome sexual attention or
   advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
   address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+- Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 ## Our Responsibilities
@@ -56,8 +56,8 @@ further defined and clarified by project maintainers.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported by contacting the project team at {{ email }}. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
+complaints will be reviewed and investigated and will result in a response deemed necessary and appropriate to the
+circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.
 Further details of specific enforcement policies may be posted separately.
 

CONTRIBUTING.md

@@ -8,7 +8,8 @@ Please note we have a code of conduct, please follow it in all your interactions
 ## Pull Request Process
 
 1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
-2. State in the Pull Request details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
+2. State in the Pull Request details of changes to the interface, this includes new environment variables, exposed
+   ports, useful file locations and container parameters.
 3. Pull Requests are merged after successful review of at least one of the project owners.
 
 ## Code of Conduct
@@ -81,4 +82,5 @@ This Code of Conduct is adapted from the [Contributor Covenant][homepage], versi
 available at [http://contributor-covenant.org/version/1/4][version]
 
 [homepage]: http://contributor-covenant.org
+
 [version]: http://contributor-covenant.org/version/1/4/

README.md

@@ -14,12 +14,12 @@ By default, it is set to 1, which means that it will only render the first level
 You can prohibit unfolding of the component by setting the `current-level-of-subcomponents` to the same value as
 the `level-of-subcomponents` property.
 
-To use the component, import the [npm-package](https://www.npmjs.com/package/@kit-data-manager/pid-component) via [unpkg](https://unpkg.com/):
+To use the component, import the [npm-package](https://www.npmjs.com/package/@kit-data-manager/pid-component)
+via [unpkg](https://unpkg.com/):
 
 ```html
-
 <head>
-  <script type='module' src='https://unpkg.com/@kit-data-manager/pid-component'></script>
+  <script type="module" src="https://unpkg.com/@kit-data-manager/pid-component"></script>
 </head>
 ```
 
@@ -33,7 +33,7 @@ Then, you can use this component like this:
 
 ```html
 
-<pid-component value='21.T11981/be908bd1-e049-4d35-975e-8e27d40117e6'></pid-component>
+<pid-component value="21.T11981/be908bd1-e049-4d35-975e-8e27d40117e6"></pid-component>
 ```
 
 You can try this web component in the [demo](https://kit-data-manager.github.io/pid-component).

codemeta.json

@@ -71,4 +71,4 @@
   "codeRepository": "https://github.com/kit-data-manager/pid-component",
   "buildInstructions": "https://kit-data-manager.github.io/pid-component",
   "url": "https://kit-data-manager.github.io/pid-component"
-}
+}

eslint.config.js

@@ -0,0 +1,16 @@
+import globals from 'globals';
+import pluginJs from '@eslint/js';
+import tseslint from 'typescript-eslint';
+import eslintConfigPrettier from 'eslint-config-prettier';
+import storybook from 'eslint-plugin-storybook';
+
+export default [
+  { files: ['**/*.{js,mjs,cjs,ts,jsx,tsx}'] },
+  { files: ['**/*.js'], languageOptions: { sourceType: 'commonjs' } },
+  { languageOptions: { globals: globals.browser } },
+  { ignores: ['node_modules/', 'dist/', 'www/', 'loader/', '.stencil/', '.storybook/', 'storybook-static'] },
+  ...storybook.configs['flat/recommended'],
+  eslintConfigPrettier,
+  pluginJs.configs.recommended,
+  ...tseslint.configs.recommended,
+];