WIP templates structure

Author: matthew-bernardo

templates/connector/README.md

@@ -0,0 +1,55 @@
+# {$APP_NAME} Stacksync Connector
+
+## Overview
+
+This application was auto-generated using the Stacksync CDK. It provides a custom Stacksync Connector which provide custom functionality inside Stacksync Workflows.
+
+## Setup
+
+This application should be managed via the Stacksync CLI. Please refer to the documentation on how to configure this tool.
+
+Once the CLI is configured, run ${APP_NAME} locally using:
+
+```bash
+stacksync dev
+```
+
+To deploy:
+
+```bash
+stacksync deploy
+```
+
+Add additional modules to your project using:
+
+```bash
+stacksync create module --name "[Module name]" --url "[url with API documentation]" --prompt "[Description of your module's functionality]"
+```
+
+## Architecture
+
+There are a number of key files and structures in this repository:
+
+* The `stacksync.yml` file. This file defines most of your application's metadata and serves and a single point of reference for application configuration.
+* The `modules/` folder. This is where the definitions for your individual modules go.
+  * Each module is expected to provide:
+    * `schema.py`: Defines your app schema. See below for details.
+    * `content.py`: Used to fetch dynamic field content if your module requires it.
+    * `execute.py`: Your business logic that receives events from Stacksync Workflows.
+    * `content.md`: A file used by Stacksync's AI agents. Should provide additional information about best practices for integrating your module into a workflow.
+
+## `schema.py`
+
+_This section is under construction._
+
+## `content.py`
+
+_This section is under construction._
+
+## `execute.py`
+
+_This section is under construction._
+
+## `content.md`
+
+_This section is under construction._

templates/connector/api_client.py

@@ -0,0 +1,21 @@
+import requests
+from stacksync_cdk.api_client import ApiClient
+from stacksync_cdk.schema_utils import to_schema
+
+
+class DummyCrmApiClient(ApiClient):
+    def __init__(self, credentials: dict):
+        super().__init__(credentials)
+
+    # The @ApiClient.returns_schema() decorator validates that the return
+    # data is a valid Stacksync schema dict and logs instructive errors if it's not.
+    @ApiClient.as_schema()
+    def get_additional_fields(self, record_type: str):
+        if not self.credentials:
+            raise ValueError("No credentials provided")
+        # Let's pretend there's an API endpoint for fetching fields from the CRM
+        url = f"https://dummycrm.com/api/v1/fields/{record_type}"
+        response = requests.get(url, headers=self.headers)
+        # The to_schema() function converts a dict into a Stacksync schema dict.
+        # It's takes a very generic/naive approach, so pre or post processing may be needed.
+        return to_schema(response.json())

templates/connector/modules/dummy_crm_create_record/base_schema.yml

@@ -0,0 +1,42 @@
+# Base input schema for the dummy CRM "create record" module.
+# See https://docs.stacksync.com/two-way-sync/developers/module-schema-reference
+metadata:
+  workflows_module_schema_version: "1.0.0"
+
+ui_options:
+  ui_order:
+    - name
+    - description
+    - type
+
+fields:
+  - id: name
+    type: string
+    label: Name
+    description: Display name for the new record.
+    validation:
+      required: true
+    ui_options:
+      ui_widget: input
+
+  - id: description
+    type: string
+    label: Description
+    description: Optional details shown on the record.
+    ui_options:
+      ui_widget: textarea
+
+  - id: type
+    type: string
+    label: Record type
+    description: >-
+      The type of record to create.
+    choices:
+      values: []
+    content:
+      type:
+        - managed
+      content_objects:
+        - id: record_types
+    ui_options:
+      ui_widget: SelectWidget

templates/connector/modules/dummy_crm_create_record/content.py

@@ -0,0 +1,13 @@
+from cdk.templates.connector import api_client
+from stacksync_cdk.schema_utils import load_schema
+
+
+def schema_handler(form_data: dict, credentials: str):
+    schema = load_schema("base_schema.yml")
+
+    # If these fields are present, we can fetch additional fields from the API
+    # and add them to the schema so the user can see them in the UI.
+    if credentials and form_data.get("select_object"):
+        additional_fields = api_client.get_additional_fields(form_data.get("select_object"))
+        schema.add(additional_fields)
+    return schema