@lblod/ember-rdfa-editor-lblod-plugins 15.1.0 → 15.2.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @lblod/ember-rdfa-editor-lblod-plugins
 
+## 15.2.1
+
+### Patch Changes
+
+- [`763d762`](https://github.com/lblod/ember-rdfa-editor-lblod-plugins/commit/763d76255bcee0fe9cf7be9472c2120793cad277) Thanks [@dkozickis](https://github.com/dkozickis)! - Bump editor version
+
+## 15.2.0
+
+### Minor Changes
+
+- [#362](https://github.com/lblod/ember-rdfa-editor-lblod-plugins/pull/362) [`47f2337`](https://github.com/lblod/ember-rdfa-editor-lblod-plugins/commit/47f233767cd5f6169e2d4b8a3c71619d0718c035) Thanks [@piemonkey](https://github.com/piemonkey)! - Add incredibly small plugin for highlighting text as redacted
+
 ## 15.1.0
 
 ### Minor Changes

package/README.md

@@ -810,6 +810,36 @@ Template comments have a specific style that can be imported in the stylesheet w
 @import 'template-comments-plugin';
 ```
 
+## confidentiality-plugin
+
+A very small plugin which allows for marking parts of text as redacted and including the styles to make this visible.
+
+To enable the plugin you need to add the `MarkSpec` to the `Schema`:
+
+``` js
+import { redacted } from '@lblod/ember-rdfa-editor-lblod-plugins/plugins/confidentiality-plugin/marks/redacted';
+// ...
+new Schema({
+  // ...
+  marks: {
+    // ...
+    redacted,
+  },
+});
+```
+
+You can then add the button to the toolbar, passing it the `SayController`:
+
+``` hbs
+<ConfidentialityPlugin::Toolbar @controller={{this.controller}} />
+```
+
+To see the redactions you'll need to add styles that target the `[property='ext:redacted']` selector, which can be done easily in Sass by importing the included stylesheet:
+
+``` scss
+@import 'confidentiality-plugin';
+```
+
 ## Embroider
 To use `@lblod/ember-rdfa-editor-lblod-plugins` with Embroider some extra Webpack configuration is needed, which you can import like this:
 

package/addon/components/confidentiality-plugin/redact.hbs

@@ -0,0 +1,6 @@
+<Toolbar::Mark
+  @icon="not-visible"
+  @title={{t 'confidentiality-plugin.redact'}}
+  @mark="redacted"
+  @controller={{@controller}}
+/>

package/addon/components/confidentiality-plugin/toolbar.hbs

@@ -0,0 +1 @@
+<ConfidentialityPlugin::Redact @controller={{@controller}}/>

package/addon/plugins/confidentiality-plugin/index.ts

@@ -0,0 +1 @@
+export { redacted } from './marks/redacted';

package/addon/plugins/confidentiality-plugin/marks/redacted.ts

@@ -0,0 +1,24 @@
+import { MarkSpec } from 'prosemirror-model';
+import { EXT } from '@lblod/ember-rdfa-editor-lblod-plugins/utils/constants';
+import { hasRDFaAttribute } from '@lblod/ember-rdfa-editor-lblod-plugins/utils/namespace';
+
+export const redacted: MarkSpec = {
+  toDOM(_node) {
+    return ['span', { property: EXT('redacted').prefixed }, 0];
+  },
+  parseDOM: [
+    {
+      tag: 'span',
+      getAttrs(value) {
+        if (typeof value === 'string') {
+          return false;
+        }
+        return (
+          hasRDFaAttribute(value, 'property', EXT('redacted')) && {
+            property: value.getAttribute('property'),
+          }
+        );
+      },
+    },
+  ],
+};

package/app/components/confidentiality-plugin/redact.js

@@ -0,0 +1 @@
+export { default } from '@lblod/ember-rdfa-editor-lblod-plugins/components/confidentiality-plugin/redact';

package/app/components/confidentiality-plugin/toolbar.js

@@ -0,0 +1 @@
+export { default } from '@lblod/ember-rdfa-editor-lblod-plugins/components/confidentiality-plugin/toolbar';

package/app/styles/confidentiality-plugin.scss

@@ -0,0 +1,8 @@
+@import 'ember-appuniversum';
+
+.rdfa-annotations {
+  [property='ext:redacted'] {
+    background-color: var(--au-red-400);
+    border: 1px solid var(--au-red-600);
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lblod/ember-rdfa-editor-lblod-plugins",
-  "version": "15.1.0",
+  "version": "15.2.1",
   "description": "Ember addon providing lblod specific plugins for the ember-rdfa-editor",
   "keywords": [
     "ember-addon",
@@ -71,7 +71,7 @@
     "@glimmer/component": "^1.1.2",
     "@glimmer/tracking": "^1.1.2",
     "@glint/template": "^1.1.0",
-    "@lblod/ember-rdfa-editor": "^7.0.1",
+    "@lblod/ember-rdfa-editor": "^8.0.1",
     "@rdfjs/types": "^1.1.0",
     "@release-it/keep-a-changelog": "^3.1.0",
     "@tsconfig/ember": "^3.0.0",
@@ -129,7 +129,7 @@
     "eslint-plugin-ember": "^11.1.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^5.0.0",
-    "eslint-plugin-qunit": "^7.3.1",
+    "eslint-plugin-qunit": "^8.0.1",
     "loader.js": "^4.7.0",
     "npm-run-all": "^4.1.5",
     "prettier": "^3.0.0",
@@ -145,7 +145,7 @@
     "@appuniversum/ember-appuniversum": "^2.4.2",
     "@ember/string": "3.x",
     "@glint/template": "^1.1.0",
-    "@lblod/ember-rdfa-editor": "^6.0.0 || ^7.0.1",
+    "@lblod/ember-rdfa-editor": "^6.0.0 || ^7.0.1 || ^8.0.1",
     "ember-concurrency": "2.x || ^3.1.0",
     "ember-modifier": "^3.2.7",
     "ember-power-select": "6.x || 7.x",

package/plugins/confidentiality-plugin/index.d.ts

@@ -0,0 +1 @@
+export { redacted } from './marks/redacted';

package/plugins/confidentiality-plugin/marks/redacted.d.ts

@@ -0,0 +1,2 @@
+import { MarkSpec } from 'prosemirror-model';
+export declare const redacted: MarkSpec;

package/translations/en-US.yaml

@@ -377,3 +377,6 @@ editor-plugins:
         contact: In case of persisting issues, contact <a href="mailto:{email}">{email}</a>.
     nodeview:
       placeholder: Insert address
+
+confidentiality-plugin:
+  redact: Redact

package/translations/nl-BE.yaml

@@ -381,3 +381,6 @@ editor-plugins:
         contact: Bij blijvende problemen, contacteer <a href="mailto:{email}">{email}</a>.
     nodeview:
       placeholder: Voeg adres in
+
+confidentiality-plugin:
+  redact: Redigeren