fix: extension items (#9216)

* feat: sample extension & markdown support for description

Signed-off-by: mertmit <mertmit99@gmail.com>

* docs: extension developer guide

Signed-off-by: mertmit <mertmit99@gmail.com>

* docs: improved extension guid

Signed-off-by: mertmit <mertmit99@gmail.com>

* misc: remove docs from current PR

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>

---------

Signed-off-by: mertmit <mertmit99@gmail.com>
Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>
Co-authored-by: Raju Udava <86527202+dstala@users.noreply.github.com>

packages/nc-gui/components/extensions/Details.vue

@@ -1,4 +1,6 @@
 <script lang="ts" setup>
+import { marked } from 'marked'
+
 interface Prop {
   modelValue: boolean
   extensionId: string
@@ -26,6 +28,8 @@ const onAddExtension = (ext: any) => {
 const activeExtension = computed(() => {
   return availableExtensions.value.find((ext) => ext.id === props.extensionId)
 })
+
+const detailsBody = activeExtension.value?.description ? marked.parse(activeExtension.value.description) : '<p></p>'
 </script>
 
 <template>
@@ -59,7 +63,7 @@ const activeExtension = computed(() => {
             </div>
           </div>
 
-          <div class="whitespace-pre-line text-base text-gray-600">{{ activeExtension.description }}</div>
+          <div class="text-base text-gray-600" v-html="detailsBody"></div>
         </div>
         <div class="extension-details-right">
           <NcButton class="w-full" @click="onAddExtension(activeExtension)">

packages/nc-gui/composables/useExtensionHelper.ts

@@ -198,6 +198,7 @@ const [useProvideExtensionHelper, useExtensionHelper] = useInjectionState((exten
   }
 
   return {
+    $api,
     fullscreen,
     collapsed,
     extension,
@@ -205,7 +206,6 @@ const [useProvideExtensionHelper, useExtensionHelper] = useInjectionState((exten
     getViewsForTable,
     getData,
     getTableMeta,
-    $api,
     insertData,
     updateData,
     upsertData,

packages/nc-gui/composables/useExtensions.ts

@@ -21,6 +21,7 @@ interface ExtensionManifest {
   publisherName: string
   publisherEmail: string
   publisherUrl: string
+  disabled?: boolean
 }
 
 abstract class ExtensionType {
@@ -334,11 +335,24 @@ export const useExtensions = createSharedComposable(() => {
 
   onMounted(() => {
     const modules = import.meta.glob('../extensions/*/*.json')
+
+    const extensionCount = modules ? Object.keys(modules).length : 0
+
+    let disabledCount = 0
+
     for (const path in modules) {
       modules[path]().then((mod: any) => {
         const manifest = mod.default as ExtensionManifest
+
+        if (manifest?.disabled !== true) {
           availableExtensions.value.push(manifest)
-        if (Object.keys(modules).length === availableExtensions.value.length) {
+        } else {
+          disabledCount++
+        }
+
+        if (availableExtensions.value.length + disabledCount === extensionCount) {
+          availableExtensions.value.sort((a, b) => a.title.localeCompare(b.title))
+
           extensionsLoaded.value = true
         }
       })

packages/nc-gui/extensions/json-exporter/manifest.json

@@ -0,0 +1,12 @@
+{
+  "id": "nc-json-exporter",
+  "title": "JSON Exporter",
+  "description": "This is a sample NocoDB extension that exports data in JSON format. \nIt is used to demonstrate how to create a NocoDB extension.\n\nThis extension is disabled by default. To access it you need to first change the `disabled` property in the manifest file to `false`.",
+  "entry": "json-exporter",
+  "version": "0.1",
+  "iconUrl": "json-exporter/icon.png",
+  "publisherName": "NocoDB",
+  "publisherEmail": "contact@nocodb.com",
+  "publisherUrl": "https://www.nocodb.com",
+  "disabled": true
+}

packages/nc-gui/package.json

@@ -142,6 +142,7 @@
     "@types/inflection": "^1.13.2",
     "@types/leaflet": "^1.9.12",
     "@types/leaflet.markercluster": "^1.5.4",
+    "@types/marked": "^6.0.0",
     "@types/papaparse": "^5.3.14",
     "@types/parse-github-url": "^1.0.3",
     "@types/qrcode": "^1.5.5",