Add support for requiredFeatures specification (#84)

* Add requiredFeatures to extension list
* Add linting for required features
* Add required features section to contributing
* Add requiredFeatures to extension-list script
* Add required feature to stock-api-fastapi manifest

Author: dotNomad

.github/actions/lint-extension/action.yml

@@ -36,6 +36,35 @@ runs:
         ' ./extensions/${{ inputs.extension-name }}/manifest.json
       shell: bash
 
+    # Ensures that the manifest.json has only valid requiredFeatures
+    - name: Check required features
+      run: |
+        # Read in valid requiredFeatures from extensions.json
+        VALID_FEATURES=$(jq -c '.requiredFeatures' ./extensions.json)
+        
+        # Read in requiredFeatures from the extension's manifest.json
+        EXTENSION_REQUIRED_FEATURES=$(jq -c '.extension.requiredFeatures // []' ./extensions/${{ inputs.extension-name }}/manifest.json)
+
+        # Check if the extension's requiredFeatures is an array
+        if [ "$(jq -r 'type' <<< "$EXTENSION_REQUIRED_FEATURES")" != "array" ]; then
+          echo "Error: The requiredFeatures in manifest.json must be an array."
+          exit 1
+        fi
+        
+        # Check if any extension requiredFeatures are not in the valid requiredFeatures list
+        INVALID_FEATURES=$(jq -n -c --argjson global "$VALID_FEATURES" --argjson extension "$EXTENSION_REQUIRED_FEATURES" '
+          $extension | map(. as $feature | if ($global | index($feature) | not) then $feature else empty end)
+        ')
+        
+        # Check if there are any invalid requiredFeatures
+        if [ "$INVALID_FEATURES" != "[]" ]; then
+          echo "Error: The following `requiredFeatures` in manifest.json are not defined in extensions.json:"
+          echo "$INVALID_FEATURES"
+          echo "Please add these features to the 'requiredFeatures' array in extensions.json or remove them from the manifest."
+          exit 1
+        fi
+      shell: bash
+
     # Ensures that the manifest.json has only valid tags
     - name: Check tags
       run: |

CONTRIBUTING.md

@@ -93,6 +93,27 @@ is recorded for that specific release.
 A good Connect Version to start with is `"2025.04.0"` since it is the
 release that introduced the Connect Gallery.
 
+#### Required Connect Features
+
+The `requiredFeatures` field in the `extension` section of the `manifest.json`
+is optional, but if your content requires enhanced features of Posit Connect to
+function correctly it should be included.
+
+For example, if your content requires the API Publishing feature your 
+`manifest.json` should include the following:
+
+```json
+// manifest.json
+
+{
+  ...
+  "extension": {
+    "requiredFeatures": ["API Publishing"],
+    ...
+  }
+}
+```
+
 ### README.md
 
 In the above extension section there is a `homepage` link that we provide in the

extensions.json

@@ -1,5 +1,10 @@
 {
   "tags": [],
+  "requiredFeatures": [
+    "API Publishing",
+    "OAuth Integrations",
+    "Current User Execution"
+  ],
   "extensions": [
     {
       "name": "connectwidgets-example",

extensions/stock-api-fastapi/manifest.json

@@ -12,6 +12,9 @@
     "homepage": "https://github.com/posit-dev/connect-extensions/tree/main/extensions/stock-api-fastapi",
     "tags": [],
     "minimumConnectVersion": "2025.04.0",
+    "requiredFeatures": [
+      "API Publishing"
+    ],
     "version": "1.0.0"
   },
   "environment": {

scripts/extension-list.ts

@@ -5,7 +5,12 @@ import semverValid from "semver/functions/valid";
 import semverEq from "semver/functions/eq";
 import semverRcompare from "semver/functions/rcompare";
 
-import { Extension, ExtensionManifest, ExtensionVersion } from "./types";
+import {
+  Extension,
+  ExtensionManifest,
+  ExtensionVersion,
+  RequiredFeature
+} from "./types";
 
 function getExtensionNameFromRelease(release: any): string {
   const tag = release.tag_name as string;
@@ -31,14 +36,19 @@ function sortExtensionVersions(extension: Extension) {
 }
 
 class ExtensionList {
-  constructor(public tags: string[], public extensions: Extension[]) {
+  constructor(
+    public tags: string[],
+    public requiredFeatures: RequiredFeature[],
+    public extensions: Extension[]
+  ) {
     this.tags = tags;
+    this.requiredFeatures = requiredFeatures;
     this.extensions = extensions;
   }
 
   static fromFile(path: string) {
     const file = JSON.parse(fs.readFileSync(path, "utf8"));
-    return new ExtensionList(file.tags, file.extensions);
+    return new ExtensionList(file.tags, file.requiredFeatures, file.extensions);
   }
 
   public addRelease(manifest: ExtensionManifest, githubRelease) {
@@ -50,6 +60,7 @@ class ExtensionList {
       version,
       tags,
       minimumConnectVersion,
+      requiredFeatures,
     } = manifest.extension;
     const { assets, published_at } = githubRelease;
 
@@ -62,6 +73,7 @@ class ExtensionList {
       released: published_at,
       url: browser_download_url,
       minimumConnectVersion: minimumConnectVersion,
+      ...(requiredFeatures ? { requiredFeatures } : {}),
     };
 
     if (this.getExtension(name)) {
@@ -150,6 +162,7 @@ class ExtensionList {
   public stringify() {
     const output = {
       tags: this.tags,
+      requiredFeatures: this.requiredFeatures,
       extensions: this.extensions
     }
     return JSON.stringify(output, null, 2);

scripts/types/index.ts

@@ -6,15 +6,23 @@ export interface ExtensionManifest {
     homepage: string;
     version: string;
     minimumConnectVersion: string;
+    requiredFeatures?: RequiredFeature[];
     tags?: string[];
   };
 }
 
+export enum RequiredFeature {
+  API_PUBLISHING = 'API Publishing',
+  OAUTH_INTEGRATIONS = 'OAuth Integrations',
+  CURRENT_USER_EXECUTION = 'Current User Execution',
+}
+
 export interface ExtensionVersion {
   version: string;
   released: string;
   url: string;
   minimumConnectVersion: string;
+  requiredFeatures?: RequiredFeature[];
 }
 
 export interface Extension {