feat: generate endpoints api

Author: xepozz

CONTRIBUTING.md

@@ -12,6 +12,9 @@ The project is structured around a **Base Package**: `com.github.xepozz.temporal
 ### 1. `common` Package
 Contains language-agnostic logic, base classes, and Extension Points (EPs).
 - **Location**: `src/main/kotlin/com/github/xepozz/temporal/common`
+- **Sub-packages**:
+    - `extensionPoints`: Contains all Extension Point interfaces.
+    - `model`: Contains common data classes representing Temporal entities (Workflows, Activities).
 - **Purpose**: Define how features should work across all languages.
 - **Components**:
     - **Extension Points (EP)**: Interfaces or abstract classes that define the contract for language-specific support.
@@ -28,44 +31,51 @@ Contains language-specific implementations (adapters).
 
 When implementing a feature that should work across multiple languages (e.g., Activity Name completion), follow this pattern:
 
-1.  **Define the EP Interface** in `common`:
+1.  **Define the EP Interface** in `common.extensionPoints`:
     ```kotlin
-    // common/completion/ActivityCompletionEP.kt
-    interface ActivityCompletionEP {
-        fun getActivityNames(project: Project): List<String>
+    // common/extensionPoints/Activity.kt
+    interface Activity {
+        fun getActivities(project: Project): List<ActivityModel>
+
+        companion object {
+            val ACTIVITY_EP = ExtensionPointName.create<Activity>("com.github.xepozz.temporal.activity")
+
+            fun getActivities(project: Project): List<ActivityModel> {
+                return ACTIVITY_EP.extensionList.flatMap { it.getActivities(project) }
+            }
+        }
     }
     ```
 2.  **Register the EP** in `plugin.xml`:
     ```xml
     <extensionPoints>
-        <extensionPoint name="activityCompletion" interface="com.github.xepozz.temporal.common.completion.ActivityCompletionEP"/>
+        <extensionPoint name="activity" interface="com.github.xepozz.temporal.common.extensionPoints.Activity"/>
     </extensionPoints>
     ```
 3.  **Implement the Shared Provider** in `common`:
     ```kotlin
     // common/completion/ActivityCompletionProvider.kt
     class ActivityCompletionProvider : CompletionProvider<CompletionParameters>() {
         override fun addCompletions(parameters: CompletionParameters, context: ProcessingContext, result: CompletionResultSet) {
-            val ep = ExtensionPointName.create<ActivityCompletionEP>("com.github.xepozz.temporal.activityCompletion")
-            ep.extensionList.forEach { adapter ->
-                adapter.getActivityNames(parameters.editor.project!!).forEach { result.addElement(LookupElementBuilder.create(it)) }
+            ActivityCompletion.getActivityNames(parameters.editor.project!!).forEach {
+                result.addElement(LookupElementBuilder.create(it))
             }
         }
     }
     ```
 4.  **Implement the Language Adapter**:
     ```kotlin
-    // languages/php/completion/PhpActivityCompletionProvider.kt
-    class PhpActivityCompletionProvider : ActivityCompletionEP {
-        override fun getActivityNames(project: Project): List<String> {
-            // PHP-specific logic to find Activity names
+    // languages/php/endpoints/PhpActivity.kt
+    class PhpActivity : Activity {
+        override fun getActivities(project: Project): List<ActivityModel> {
+            // PHP-specific logic to find Activities
         }
     }
     ```
 5.  **Register the Adapter** in the language-specific XML (e.g., `language-php.xml`):
     ```xml
     <extensions defaultExtensionNs="com.github.xepozz.temporal">
-        <activityCompletion implementation="com.github.xepozz.temporal.languages.php.completion.PhpActivityCompletionProvider"/>
+        <activity implementation="com.github.xepozz.temporal.languages.php.endpoints.PhpActivity"/>
     </extensions>
     ```
 
@@ -75,7 +85,7 @@ When implementing a feature that should work across multiple languages (e.g., Ac
 - **Performance**: Use `CachedValue` and `DumbService.isDumb()` checks where appropriate.
 - **Consistency**: Follow the existing package structure. For example, if a feature is implemented for PHP in `languages.php.navigation`, any future language implementations should follow the same sub-package structure (e.g., `languages.go.navigation`).
 - **Naming**:
-    - Extension Points should end with `EP`.
+    - Extension Points should **not** end with `EP`. They should represent the entity or feature (e.g., `ActivityCompletion`, `Workflow`).
     - Language-specific implementations should be prefixed with the language name (e.g., `Php...`).
 - **Namespaces**:
     - All Extension Point names and IDs **must** start with `com.github.xepozz.temporal`.

src/main/kotlin/com/github/xepozz/temporal/TemporalIcons.kt

@@ -0,0 +1,8 @@
+package com.github.xepozz.temporal
+
+import com.intellij.openapi.util.IconLoader
+
+object TemporalIcons {
+    @JvmStatic
+    val TEMPORAL = IconLoader.getIcon("/icons/temporal/icon.svg", javaClass)
+}

src/main/kotlin/com/github/xepozz/temporal/common/endpoints/TemporalActivityEndpointsProvider.kt

@@ -0,0 +1,44 @@
+package com.github.xepozz.temporal.common.endpoints
+
+import com.github.xepozz.temporal.TemporalIcons
+import com.github.xepozz.temporal.common.extensionPoints.Activity
+import com.intellij.microservices.endpoints.EndpointType
+import com.intellij.microservices.endpoints.EndpointsFilter
+import com.intellij.microservices.endpoints.EndpointsProvider
+import com.intellij.microservices.endpoints.FrameworkPresentation
+import com.intellij.navigation.ItemPresentation
+import com.intellij.openapi.project.Project
+import com.intellij.openapi.util.ModificationTracker
+import java.util.function.Supplier
+import javax.swing.Icon
+import com.github.xepozz.temporal.common.model.Activity as ActivityModel
+
+class TemporalActivityEndpointsProvider : EndpointsProvider<ActivityEndpointGroup, ActivityEndpoint> {
+    override val endpointType: EndpointType = EndpointType("Temporal Activity", null, Supplier { "Temporal Activity" })
+    override val presentation: FrameworkPresentation = FrameworkPresentation("Temporal Activity", "Temporal Activity", TemporalIcons.TEMPORAL)
+
+    override fun getEndpointGroups(project: Project, filter: EndpointsFilter): Iterable<ActivityEndpointGroup> {
+        return Activity.getActivities(project).map { ActivityEndpointGroup(it) }
+    }
+
+    override fun getEndpoints(group: ActivityEndpointGroup): Iterable<ActivityEndpoint> {
+        return listOf(ActivityEndpoint(group.activity))
+    }
+
+    override fun getModificationTracker(project: Project): ModificationTracker = ModificationTracker.NEVER_CHANGED
+
+    override fun getStatus(project: Project): EndpointsProvider.Status = EndpointsProvider.Status.AVAILABLE
+
+    override fun isValidEndpoint(group: ActivityEndpointGroup, endpoint: ActivityEndpoint): Boolean = true
+
+    override fun getEndpointPresentation(group: ActivityEndpointGroup, endpoint: ActivityEndpoint): ItemPresentation {
+        return object : ItemPresentation {
+            override fun getPresentableText(): String = endpoint.activity.id
+            override fun getLocationString(): String? = endpoint.activity.psiAnchor?.element?.containingFile?.name
+            override fun getIcon(unused: Boolean): Icon = TemporalIcons.TEMPORAL
+        }
+    }
+}
+
+data class ActivityEndpointGroup(val activity: ActivityModel)
+data class ActivityEndpoint(val activity: ActivityModel)

src/main/kotlin/com/github/xepozz/temporal/common/endpoints/TemporalWorkflowEndpointsProvider.kt

@@ -0,0 +1,44 @@
+package com.github.xepozz.temporal.common.endpoints
+
+import com.github.xepozz.temporal.TemporalIcons
+import com.github.xepozz.temporal.common.extensionPoints.Workflow
+import com.intellij.microservices.endpoints.EndpointType
+import com.intellij.microservices.endpoints.EndpointsFilter
+import com.intellij.microservices.endpoints.EndpointsProvider
+import com.intellij.microservices.endpoints.FrameworkPresentation
+import com.intellij.navigation.ItemPresentation
+import com.intellij.openapi.project.Project
+import com.intellij.openapi.util.ModificationTracker
+import java.util.function.Supplier
+import javax.swing.Icon
+import com.github.xepozz.temporal.common.model.Workflow as WorkflowModel
+
+class TemporalWorkflowEndpointsProvider : EndpointsProvider<WorkflowEndpointGroup, WorkflowEndpoint> {
+    override val endpointType: EndpointType = EndpointType("Temporal Workflow", null, Supplier { "Temporal Workflow" })
+    override val presentation: FrameworkPresentation = FrameworkPresentation("Temporal Workflow", "Temporal Workflow", TemporalIcons.TEMPORAL)
+
+    override fun getEndpointGroups(project: Project, filter: EndpointsFilter): Iterable<WorkflowEndpointGroup> {
+        return Workflow.getWorkflows(project).map { WorkflowEndpointGroup(it) }
+    }
+
+    override fun getEndpoints(group: WorkflowEndpointGroup): Iterable<WorkflowEndpoint> {
+        return listOf(WorkflowEndpoint(group.workflow))
+    }
+
+    override fun getModificationTracker(project: Project): ModificationTracker = ModificationTracker.NEVER_CHANGED
+
+    override fun getStatus(project: Project): EndpointsProvider.Status = EndpointsProvider.Status.AVAILABLE
+
+    override fun isValidEndpoint(group: WorkflowEndpointGroup, endpoint: WorkflowEndpoint): Boolean = true
+
+    override fun getEndpointPresentation(group: WorkflowEndpointGroup, endpoint: WorkflowEndpoint): ItemPresentation {
+        return object : ItemPresentation {
+            override fun getPresentableText(): String = endpoint.workflow.id
+            override fun getLocationString(): String? = endpoint.workflow.psiAnchor.element?.containingFile?.name
+            override fun getIcon(unused: Boolean): Icon = TemporalIcons.TEMPORAL
+        }
+    }
+}
+
+data class WorkflowEndpointGroup(val workflow: WorkflowModel)
+data class WorkflowEndpoint(val workflow: WorkflowModel)

src/main/kotlin/com/github/xepozz/temporal/common/extensionPoints/Activity.kt

@@ -0,0 +1,17 @@
+package com.github.xepozz.temporal.common.extensionPoints
+
+import com.intellij.openapi.extensions.ExtensionPointName
+import com.intellij.openapi.project.Project
+import com.github.xepozz.temporal.common.model.Activity as ActivityModel
+
+interface Activity {
+    fun getActivities(project: Project): List<ActivityModel>
+
+    companion object {
+        val ACTIVITY_EP = ExtensionPointName.create<Activity>("com.github.xepozz.temporal.activity")
+
+        fun getActivities(project: Project): List<ActivityModel> {
+            return ACTIVITY_EP.extensionList.flatMap { it.getActivities(project) }
+        }
+    }
+}

src/main/kotlin/com/github/xepozz/temporal/common/extensionPoints/Workflow.kt

@@ -0,0 +1,17 @@
+package com.github.xepozz.temporal.common.extensionPoints
+
+import com.intellij.openapi.extensions.ExtensionPointName
+import com.intellij.openapi.project.Project
+import com.github.xepozz.temporal.common.model.Workflow as WorkflowModel
+
+interface Workflow {
+    fun getWorkflows(project: Project): List<WorkflowModel>
+
+    companion object {
+        val WORKFLOW_EP = ExtensionPointName.create<Workflow>("com.github.xepozz.temporal.workflow")
+
+        fun getWorkflows(project: Project): List<WorkflowModel> {
+            return WORKFLOW_EP.extensionList.flatMap { it.getWorkflows(project) }
+        }
+    }
+}

src/main/kotlin/com/github/xepozz/temporal/common/model/Activity.kt

@@ -0,0 +1,11 @@
+package com.github.xepozz.temporal.common.model
+
+import com.intellij.psi.PsiElement
+import com.intellij.psi.SmartPsiElementPointer
+
+data class Activity(
+    val id: String,
+    val language: String,
+    val psiAnchor: SmartPsiElementPointer<out PsiElement>?,
+    val parameters: Collection<String>
+)

src/main/kotlin/com/github/xepozz/temporal/common/model/Workflow.kt

@@ -0,0 +1,11 @@
+package com.github.xepozz.temporal.common.model
+
+import com.intellij.psi.PsiElement
+import com.intellij.psi.SmartPsiElementPointer
+
+data class Workflow(
+    val id: String,
+    val language: String,
+    val psiAnchor: SmartPsiElementPointer<out PsiElement>,
+    val parameters: Collection<String>
+)

src/main/kotlin/com/github/xepozz/temporal/languages/php/endpoints/PhpActivity.kt

@@ -0,0 +1,29 @@
+package com.github.xepozz.temporal.languages.php.endpoints
+
+import com.github.xepozz.temporal.common.extensionPoints.Activity
+import com.github.xepozz.temporal.languages.php.TemporalClasses
+import com.github.xepozz.temporal.languages.php.hasAttribute
+import com.intellij.openapi.project.Project
+import com.intellij.psi.SmartPointerManager
+import com.jetbrains.php.PhpIndex
+import com.github.xepozz.temporal.common.model.Activity as ActivityModel
+
+class PhpActivity : Activity {
+    override fun getActivities(project: Project): List<ActivityModel> {
+        val phpIndex = PhpIndex.getInstance(project)
+        val smartPointerManager = SmartPointerManager.getInstance(project)
+
+        return phpIndex.getAllClassNames(null).flatMap { name ->
+            phpIndex.getClassesByName(name)
+                .filter { it.hasAttribute(TemporalClasses.ACTIVITY) }
+                .map {
+                    ActivityModel(
+                        id = it.name,
+                        language = "PHP",
+                        psiAnchor = smartPointerManager.createSmartPsiElementPointer(it),
+                        parameters = emptyList()
+                    )
+                }
+        }
+    }
+}

src/main/kotlin/com/github/xepozz/temporal/languages/php/endpoints/PhpWorkflow.kt

@@ -0,0 +1,28 @@
+package com.github.xepozz.temporal.languages.php.endpoints
+
+import com.github.xepozz.temporal.common.extensionPoints.Workflow
+import com.github.xepozz.temporal.languages.php.TemporalClasses
+import com.github.xepozz.temporal.languages.php.hasAttribute
+import com.intellij.openapi.project.Project
+import com.intellij.psi.SmartPointerManager
+import com.jetbrains.php.PhpIndex
+import com.github.xepozz.temporal.common.model.Workflow as WorkflowModel
+
+class PhpWorkflow : Workflow {
+    override fun getWorkflows(project: Project): List<WorkflowModel> {
+        val phpIndex = PhpIndex.getInstance(project)
+        val smartPointerManager = SmartPointerManager.getInstance(project)
+        return phpIndex.getAllClassNames(null).flatMap { name ->
+            phpIndex.getClassesByName(name)
+                .filter { it.hasAttribute(TemporalClasses.WORKFLOW) }
+                .map {
+                    WorkflowModel(
+                        id = it.name,
+                        language = "PHP",
+                        psiAnchor = smartPointerManager.createSmartPsiElementPointer(it),
+                        parameters = emptyList()
+                    )
+                }
+        }
+    }
+}