Merge pull request #6 from HumanSignal/fb-leap-1972/ensure-initial-state

feat: LEAP-1972: Ensure initial plugins are ready for release

Author: nass600

custom-scripts/bulk_labeling/data.json renamed to custom-scripts/bulk-labeling/data.json

@@ -1,11 +1,20 @@
+/**
+ * Automatically creates all the text regions containing all instances of the selected text.
+ */
+
+// It will be triggered when a text selection happens
 LSI.on('entityCreate', region => {
   if (window.BULK_REGIONS) return;
+
   window.BULK_REGIONS = true;
   setTimeout(() => window.BULK_REGIONS = false, 1000);
-  console.log('matches', region.object._value.matchAll(region.text));
+
   setTimeout(() => {
+    // Find all the text regions matching the selection
     region.object._value.matchAll(new RegExp(region.text, "gi")).forEach(m => {
       if (m.index === region.startOffset) return;
+
+      // Include them in the results as new selections
       Htx.annotationStore.selected.createResult(
         { text: region.text, start: "/span[1]/text()[1]", startOffset: m.index, end: "/span[1]/text()[1]", endOffset: m.index + region.text.length },
         { labels: [...region.labeling.value.labels] },

custom-scripts/bulk_labeling/script.js renamed to custom-scripts/bulk-labeling/script.js

@@ -0,0 +1,23 @@
+<View>
+  <Labels name="label" toName="text">
+    <Label value="PER" background="red"/>
+    <Label value="ORG" background="darkorange"/>
+    <Label value="LOC" background="orange"/>
+    <Label value="MISC" background="green"/>
+  </Labels>
+
+  <Text name="text" value="$text"/>
+</View>
+
+<!--
+{
+  "data": {
+    "text": [
+      "Opossums, commonly known as possums in North America, are marsupials found primarily in the Americas. The most well-known species is the Virginia opossum (Didelphis virginiana), which ranges from Central America and the eastern United States to southern Canada. These adaptable creatures are known for their ability to thrive in a variety of environments, including both rural and urban areas. Opossums are also found in South America, where different species inhabit a range of ecosystems, from tropical rainforests to temperate forests.",
+      "Opossums are highly adaptable in terms of habitat, often residing in woodlands, farmland, and even suburban backyards. They typically seek shelter in hollow trees, abandoned burrows, or any dark, enclosed space they can find. Opossums are nocturnal and omnivorous, with a diet that includes fruits, insects, small animals, and even carrion. Their opportunistic feeding habits contribute to their resilience and ability to live in close proximity to human settlements.",
+      "In terms of behavior, opossums are solitary and nomadic, often moving to different locations in search of food. They are known for their unique defense mechanism of 'playing dead' or 'playing possum' when threatened, which involves mimicking the appearance and smell of a sick or dead animal to deter predators. Opossums have relatively short lifespans, typically living only 2 to 4 years in the wild. Despite their short lives, they reproduce quickly, with females giving birth to large litters of up to 20 young, although not all offspring typically survive to maturity.",
+      "In popular culture, opossums often appear as symbols of resilience and survival due to their hardy nature and ability to adapt to various environments. They are sometimes depicted in a comical or misunderstood light, given their nocturnal habits and somewhat disheveled appearance. Despite this, they play a crucial role in the ecosystem by controlling insect and rodent populations and cleaning up carrion. Opossums have been featured in various forms of media, from cartoons and children's books to movies, often emphasizing their unique behaviors and survival strategies."
+    ]
+  }
+}
+-->

custom-scripts/bulk-labeling/view.xml

@@ -0,0 +1,5 @@
+{
+  "data": {
+	  "text": "The quick brown fox jumps over the lazy dog."
+  }
+}

custom-scripts/bulk_labeling/view.xml

@@ -1,15 +1,22 @@
+/**
+ * Validates the word count of the entered text to prevent submission if it exceeds a specified threshold
+ */
+
 let dismissed = false;
 
 LSI.on("beforeSaveAnnotation", (store, annotation) => {
   const textAreaResult = annotation.results.find(r => r.type === 'textarea' && r.from_name.name === 'textarea');
+
   if (textAreaResult) {
     words = textAreaResult.value.text[0]
     word_count = words.split(" ").length;
+
     if (word_count > 10) {
       Htx.showModal("Word count is " + word_count + ". Please reduce to 10 or less.");
       dismissed = true;
-      return false;
+      return false; // Block submission
     }
   }
-  return true;
-});
+
+  return true; // Allow submission
+});

custom-scripts/count-words-in-textarea/data.json

@@ -0,0 +1,13 @@
+<View>
+  <Header value="Classify the text in less than 10 words"/>
+  <Text name="text" value="$text"/>
+  <TextArea name="textarea" toName="text" />
+</View>
+
+<!--
+{
+  "data": {
+	  "text": "The quick brown fox jumps over the lazy dog.",
+  }
+}
+-->

custom-scripts/count_words_in_textarea/demo.gif renamed to custom-scripts/count-words-in-textarea/demo.gif

@@ -0,0 +1,5 @@
+{
+  "data": {
+    "image": "/static/custom-scripts/custom-scripts/show_different_images_based_on_label_selected/img/demo-sample.png"
+  }
+}