@seeka-labs/cli-apps 3.8.2 → 3.8.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (28) hide show
  1. package/dist/ai-context/internal/examples/_index.md +1 -1
  2. package/dist/ai-context/internal/examples/v1/activecampaign/_ai-summary.md +31 -28
  3. package/dist/ai-context/internal/examples/v1/complianz/_ai-summary.md +23 -21
  4. package/dist/ai-context/internal/examples/v1/ivvy/_ai-summary.md +19 -19
  5. package/dist/ai-context/internal/examples/v1/me-and-u-connect/_ai-summary.md +28 -17
  6. package/dist/ai-context/internal/examples/v1/me-and-u-manage/_ai-summary.md +21 -35
  7. package/dist/ai-context/internal/examples/v1/nowbookit/_ai-summary.md +29 -26
  8. package/dist/ai-context/internal/examples/v1/sevenrooms/_ai-summary.md +25 -24
  9. package/dist/ai-context/internal/examples/v1/tradable-bits/_ai-summary.md +19 -26
  10. package/dist/ai-context/internal/examples/v1/transcend/_ai-summary.md +32 -23
  11. package/dist/ai-context/internal/examples/v2/calendly/_ai-summary.md +25 -17
  12. package/dist/ai-context/internal/examples/v2/clarity/_ai-summary.md +13 -20
  13. package/dist/ai-context/internal/examples/v2/google-bigquery/_ai-summary.md +14 -14
  14. package/dist/ai-context/internal/examples/v2/klaviyo-events/_ai-summary.md +21 -14
  15. package/dist/ai-context/internal/examples/v2/navitas/_ai-summary.md +13 -23
  16. package/dist/ai-context/internal/examples/v2/trustarc/_ai-summary.md +14 -17
  17. package/dist/ai-context/internal/examples/v2/typeform/_ai-summary.md +19 -19
  18. package/dist/ai-context/internal/examples/v2/webhook/_ai-summary.md +18 -14
  19. package/dist/ai-context/internal/examples/v2/yeastar/_ai-summary.md +13 -12
  20. package/dist/ai-context/internal/examples/v3/google-ads/_ai-summary.md +16 -19
  21. package/dist/index.cjs +2464 -280
  22. package/dist/index.cjs.map +4 -4
  23. package/dist/init-template/README.azurefunc.md +1 -1
  24. package/dist/init-template/app/browser/package.json +1 -1
  25. package/dist/init-template/app/lib/package.json +1 -1
  26. package/dist/init-template/app/server-azurefunc/package.json +1 -1
  27. package/dist/init-template/app/ui/package.json +1 -1
  28. package/package.json +5 -2
@@ -1,36 +1,45 @@
1
1
  # AI Summary for Seeka App: Transcend
2
2
 
3
- ## Purpose and Functionality
4
- The Transcend app integrates with the Transcend data privacy platform to manage consent and data rights, ensuring compliance with privacy regulations. It facilitates the handling of webhooks from Seeka, processes data rights requests, and manages installations and settings updates.
3
+ ## Overview
4
+ The **Transcend** app is a Seeka application designed to integrate with the Transcend data privacy platform. It facilitates consent and data rights management, ensuring compliance with privacy regulations. The app is built using Azure Functions and is structured to handle webhooks and manage state with Redis.
5
5
 
6
6
  ## Key Implementation Patterns
7
- - **Azure Functions**: The app is built using Azure Functions, allowing it to handle HTTP requests, manage queues, and perform scheduled tasks.
8
- - **Webhook Handling**: The app processes various webhook events from Seeka, such as app installations, settings updates, and activity acceptance.
9
- - **State Management**: Redis is used for storing app installation states, with the option to swap for another state provider.
10
- - **Centralized Logging**: Utilizes Winston for logging, with optional integration with Seq for structured log management.
7
+
8
+ ### Azure Functions
9
+ - **HTTP Triggers:** The app uses Azure Functions to handle HTTP requests, such as the `seekaAppWebhook` and `healthCheck` endpoints.
10
+ - **Queue Processing:** Utilizes Azure Storage Queues for handling long-running operations asynchronously.
11
+ - **Scheduled Functions:** Implements polling mechanisms to manage scheduled tasks, ensuring operations are broken into manageable parts to respect execution time limits.
12
+
13
+ ### Webhook Handling
14
+ - **Webhook Validation:** Validates incoming webhooks using signatures to ensure authenticity.
15
+ - **Dynamic Processing:** Processes various webhook types, such as app installation, settings updates, and activity acceptance.
16
+
17
+ ### State Management
18
+ - **Redis:** Utilizes Redis for storing app installation states and other necessary data. The app can be configured to use Upstash or another Redis provider.
19
+
20
+ ### Logging
21
+ - **Winston & Seq:** Centralized logging is managed using Winston, with optional integration with Seq for enhanced log management.
11
22
 
12
23
  ## External APIs/Services Integrated
13
- - **Transcend**: Integrates with Transcend for consent and data rights management.
14
- - **Azure Storage**: Uses Azure Storage Queues for managing asynchronous operations.
15
- - **Redis**: Employed for state management, with optional integration with Upstash.
16
- - **Ngrok**: Used for exposing local development environments to the internet for testing.
24
+ - **Transcend:** Integrates with the Transcend platform for managing data privacy and consent.
25
+ - **Azure Services:** Uses Azure Functions, Azure Storage Queues, and optionally Azure Blob and Table storage for various operations.
26
+ - **Ngrok:** Provides a mechanism to expose the app locally for testing purposes.
17
27
 
18
28
  ## Important Data Transformations
19
- - **Webhook Payload Processing**: Parses and validates webhook payloads, ensuring the integrity and authenticity of incoming data.
20
- - **Installation State Management**: Handles the creation, update, and deletion of app installation states based on webhook events.
29
+ - **Webhook Payloads:** Parses and processes JSON payloads from webhooks to perform actions such as installation updates and activity handling.
30
+ - **State Updates:** Transforms and updates installation state data in Redis based on webhook events.
21
31
 
22
32
  ## Notable Code Patterns
23
- - **Webhook Signature Validation**: Ensures security by validating webhook signatures before processing.
24
- - **Queue Management**: Demonstrates how to offload long-running operations to Azure Storage Queues to respect Azure Function execution limits.
25
- - **Modular Service Initialization**: Uses a `startServices` function to initialize necessary services, promoting modularity and separation of concerns.
26
- - **Browser SDK Plugin Handling**: Integrates browser-specific plugins conditionally, showcasing a pattern for component-based architecture.
27
33
 
28
- ## Development and Deployment
29
- - **Local Development**: Supports local development with Docker for Azure Storage emulation and Ngrok for exposing local servers.
30
- - **Deployment**: Provides scripts for deploying the app to Azure, ensuring a streamlined deployment process.
34
+ ### Modularity and Reusability
35
+ - **Component-Based Design:** The app uses a modular approach, with components like `getSeekaBrowserPlugin` for browser-specific functionality.
36
+ - **Service Initialization:** Uses `startServices` to initialize necessary services, promoting a clean separation of concerns.
37
+
38
+ ### Error Handling
39
+ - **Robust Error Management:** Implements try-catch blocks to handle errors gracefully and log them for debugging purposes.
31
40
 
32
- ## Debugging and Testing
33
- - **VSCode Debugging**: Configured for debugging with VSCode, supporting breakpoints and step-through debugging.
34
- - **Testing**: Uses Jest for testing, ensuring code reliability and robustness.
41
+ ### Development and Deployment
42
+ - **Environment Configuration:** Provides detailed setup instructions for local development, including Docker for emulating Azure services.
43
+ - **Continuous Deployment:** Scripts for building, testing, and deploying the app to Azure are included, ensuring a streamlined deployment process.
35
44
 
36
- This summary provides an overview of the Transcend app's architecture, integration points, and implementation patterns, offering a comprehensive understanding for AI assistants and developers.
45
+ This summary provides a comprehensive understanding of the Transcend app's architecture and functionality, highlighting key patterns and integrations that can be referenced for similar applications.
@@ -1,35 +1,43 @@
1
- # AI Summary for Calendly Integration App
1
+ # AI Summary for Seeka Calendly Integration App
2
2
 
3
3
  ## Overview
4
4
 
5
- The Calendly integration app is designed to facilitate the tracking of meeting bookings and scheduling events from Calendly. It integrates with Calendly to manage scheduling and is built using Azure Functions as its serverless backend. The app is structured with components for the browser, UI, and server, and it leverages webhooks to interact with the Calendly API and other services.
5
+ The Seeka Calendly Integration App is designed to facilitate the tracking of meeting bookings and scheduling events through Calendly. It integrates with Calendly to manage and respond to various webhook events, thereby enhancing scheduling and CRM functionalities.
6
+
7
+ ## Purpose and Functionality
8
+
9
+ - **Meeting Tracking**: The app tracks meeting bookings and scheduling events from Calendly.
10
+ - **Webhook Handling**: It processes various webhook events such as app installation, settings updates, and uninstallation.
11
+ - **CRM Integration**: The app enriches Seeka profiles with data from Calendly events.
6
12
 
7
13
  ## Key Implementation Patterns
8
14
 
9
- - **Monorepo Structure**: The app uses a monorepo setup managed by Yarn workspaces, allowing for organized development and deployment of multiple components (`lib`, `browser`, `ui`, `server`).
10
- - **Azure Functions**: The server-side logic is implemented using Azure Functions, providing a scalable and efficient way to handle HTTP requests and webhooks.
11
- - **Webhook Handling**: The app processes various webhook events from Seeka and Calendly, including installation, uninstallation, and settings updates.
12
- - **Logging**: Utilizes the `winston` library for structured logging, which is crucial for debugging and monitoring webhook interactions.
15
+ - **Modular Workspace Structure**: The app is organized into multiple workspaces (`lib`, `browser`, `ui`, `server`) for modular development and deployment.
16
+ - **Azure Functions**: Utilizes Azure Functions to handle HTTP requests and webhook events.
17
+ - **Logging**: Implements detailed logging using `winston` for monitoring and debugging purposes.
18
+ - **Version Management**: Uses Yarn workspaces for version control and dependency management, with scripts for patch, minor, and major version bumps.
13
19
 
14
20
  ## External APIs/Services Integrated
15
21
 
16
- - **Calendly API**: The app integrates with Calendly to manage scheduling and event tracking.
17
- - **Seeka SDK**: Utilizes the Seeka SDK for handling webhook payloads and managing app installations.
22
+ - **Calendly API**: For tracking and managing meeting bookings and events.
23
+ - **Azure Functions**: Provides serverless computing to handle webhook requests.
24
+ - **Seeka SDK**: Utilized for managing webhook payloads and signature validation.
18
25
 
19
26
  ## Important Data Transformations
20
27
 
21
- - **Webhook Payload Parsing**: The app parses JSON payloads from incoming webhooks to extract necessary information for processing events.
22
- - **Installation State Management**: Transforms webhook payloads into installation states, updating or deleting installations as necessary.
28
+ - **Webhook Payload Processing**: Parses and processes JSON payloads from webhook events to extract relevant data.
29
+ - **Installation State Management**: Manages the state of app installations, including permissions and context information.
23
30
 
24
31
  ## Notable Code Patterns
25
32
 
26
- - **Webhook Signature Validation**: Implements a security pattern to validate webhook signatures, ensuring that requests are authentic.
27
- - **Conditional Logic for Webhook Types**: Uses a switch-case structure to handle different types of webhook events, providing a clear and maintainable approach to event processing.
28
- - **Error Handling**: Comprehensive error handling is implemented to catch and log exceptions during webhook processing, enhancing reliability.
33
+ - **Webhook Signature Validation**: Ensures secure processing of webhook events by validating signatures.
34
+ - **Service Initialization**: Uses a `startServices` function to initialize necessary services before processing requests.
35
+ - **Error Handling**: Implements try-catch blocks to handle errors gracefully and log detailed error information.
29
36
 
30
- ## Development and Deployment
37
+ ## Reusable Code Patterns
31
38
 
32
- - **Scripts for Development**: The `package.json` includes scripts for building, cleaning, linting, and deploying the app, as well as for version management using semantic versioning.
33
- - **Local Development Setup**: Instructions for setting up a local development environment are provided, including commands for running the server, UI, and tunneling services.
39
+ - **Webhook Handling Logic**: The pattern for processing different types of webhook events can be reused in other applications requiring similar functionality.
40
+ - **Logging with Winston**: The structured logging approach using `winston` can be applied to other applications for enhanced logging capabilities.
41
+ - **Azure Function HTTP Trigger**: The setup for handling HTTP requests with Azure Functions can be adapted for other serverless applications.
34
42
 
35
- This summary provides an overview of the app's architecture, key features, and implementation details, which can be useful for AI systems to understand and reference the app's functionality and design patterns.
43
+ This summary provides a comprehensive understanding of the Seeka Calendly Integration App's architecture, implementation, and functionality, which can assist AI systems in referencing and interacting with the app effectively.
@@ -1,32 +1,25 @@
1
1
  # AI Summary: Clarity App
2
2
 
3
- ## Overview
4
- The Clarity app is designed to integrate Microsoft Clarity for session recording and heatmap analytics. It serves as a browser plugin and server component within the Seeka app ecosystem, facilitating analytics through session recording and heatmaps.
5
-
6
3
  ## Purpose and Functionality
7
- - **Session Recording**: Captures user interactions within the browser for analysis.
8
- - **Heatmap Analytics**: Provides visual representations of user engagement on web pages.
9
- - **Webhook Handling**: Manages installation, update, and uninstallation events via webhooks.
4
+ The Clarity app is designed to integrate Microsoft Clarity for session recording and heatmap analytics. It functions as a browser plugin and server component to capture user interactions and provide insights through analytics.
10
5
 
11
6
  ## Key Implementation Patterns
12
- - **Monorepo Structure**: Utilizes Yarn workspaces to manage both browser and server components.
13
- - **Azure Functions**: Implements serverless functions for handling HTTP requests and webhooks.
14
- - **Webhook Validation**: Ensures secure communication by validating webhook signatures.
15
- - **Logging**: Uses Winston for structured logging and profiling of webhook events.
7
+ - **Monorepo Structure**: Utilizes Yarn workspaces to manage multiple packages (`browser` and `server`) within a single repository.
8
+ - **Azure Functions**: The server component is implemented using Azure Functions, allowing for scalable and event-driven serverless architecture.
9
+ - **Webhook Handling**: The app processes various webhook events related to app installation, settings updates, and uninstallation, ensuring dynamic interaction with the Seeka platform.
16
10
 
17
11
  ## External APIs/Services Integrated
18
- - **Microsoft Clarity**: For session recording and heatmap analytics.
19
- - **Azure Functions**: Provides the serverless environment for executing webhook handlers.
20
- - **Seeka SDK**: Utilizes Seeka's server SDK for handling app-specific webhook payloads.
12
+ - **Microsoft Clarity**: Integrated for capturing session data and generating heatmaps.
13
+ - **Azure Functions**: Used for deploying serverless functions that handle HTTP requests and webhook events.
14
+ - **Seeka Labs SDK**: Utilized for handling Seeka-specific webhook payloads and managing app state.
21
15
 
22
16
  ## Important Data Transformations
23
- - **Webhook Payload Processing**: Parses and processes JSON payloads from incoming webhooks to trigger appropriate actions.
24
- - **Installation State Management**: Manages installation states through create, update, and delete operations.
17
+ - **Webhook Payload Parsing**: JSON payloads from webhooks are parsed and validated to ensure integrity and authenticity using `throwOnInvalidWebhookSignature`.
18
+ - **Installation State Management**: The app manages installation states, updating or deleting records based on webhook events like installation, settings updates, and uninstallation.
25
19
 
26
20
  ## Notable Code Patterns
27
- - **Webhook Handler**: A reusable pattern for handling different types of webhook events (`AppInstalled`, `AppInstallSettingsUpdated`, `AppUninstalled`, `BrowserSdkPlugin`).
28
- - **Signature Validation**: A robust mechanism for ensuring the authenticity of incoming webhook requests.
29
- - **Service Initialization**: A pattern for starting necessary services before processing webhook events.
21
+ - **Logging with Winston**: Comprehensive logging is implemented using Winston, providing detailed insights into webhook processing and error handling.
22
+ - **Service Initialization**: The `startServices` function is invoked to initialize necessary services before processing webhook events.
23
+ - **Conditional Logic for Webhook Types**: The app uses a switch-case structure to handle different types of webhook events, ensuring modular and maintainable code.
30
24
 
31
- ## Conclusion
32
- The Clarity app effectively integrates Microsoft Clarity's session recording and heatmap analytics into the Seeka ecosystem, leveraging Azure Functions for serverless execution and employing secure, structured webhook handling. Its implementation patterns, such as monorepo management and robust logging, offer reusable solutions for similar analytics integrations.
25
+ This summary provides a high-level overview of the Clarity app's architecture and implementation, highlighting its integration with external services and key patterns that can be referenced for similar projects.
@@ -1,24 +1,24 @@
1
- # AI Summary for Seeka App: Google BigQuery Integration
1
+ # AI Summary for Google BigQuery Integration App
2
2
 
3
- ## Overview
4
- The `google-bigquery` app is designed to integrate Seeka activity data with Google BigQuery, enabling advanced analytics and reporting capabilities. It facilitates the export of Seeka activity data to BigQuery, allowing users to leverage BigQuery's powerful data processing and querying features.
3
+ ## Purpose and Functionality
4
+ The `google-bigquery` app is designed to integrate Seeka activity data with Google BigQuery, enabling advanced analytics and reporting capabilities. It handles the export of activity data from Seeka to BigQuery, allowing users to leverage BigQuery's data warehousing and analytical tools.
5
5
 
6
6
  ## Key Implementation Patterns
7
- - **Azure Functions**: The app is structured as an Azure Function, providing a serverless environment to handle HTTP requests and process webhooks.
8
- - **Webhook Handling**: The app processes various types of Seeka webhooks, such as installation, uninstallation, and activity updates, to manage the integration with BigQuery.
9
- - **Service Initialization**: The app initializes necessary services upon receiving webhooks to ensure the environment is correctly set up for data processing.
7
+ - **Azure Functions**: The app is structured as an Azure Function, specifically using an HTTP-triggered function to handle incoming webhooks from Seeka.
8
+ - **Webhook Handling**: The app processes various types of webhooks from Seeka, including installation, uninstallation, and activity updates. It validates webhook signatures to ensure security.
9
+ - **Service Initialization**: The app initializes necessary services upon receiving a webhook to ensure all dependencies are ready for processing.
10
10
 
11
11
  ## External APIs/Services Integrated
12
- - **Google BigQuery**: The app directly interacts with Google BigQuery to check dataset and table existence and to push data for analytics.
13
- - **Azure Functions**: Utilized for hosting the serverless function that handles incoming HTTP requests and processes them accordingly.
12
+ - **Google BigQuery**: The app interacts with Google BigQuery to check for dataset and table existence and to push data for analytics.
13
+ - **Azure Functions**: Utilized for serverless execution of the webhook handler.
14
14
 
15
15
  ## Important Data Transformations
16
- - **Webhook Payload Processing**: The app parses and validates incoming webhook payloads, ensuring data integrity and security through signature validation.
17
- - **Data Sanitization**: Before pushing data to BigQuery, the app sanitizes records to match the expected schema, ensuring compatibility and preventing errors.
16
+ - **Data Sanitization**: Before exporting data to BigQuery, the app sanitizes records to ensure they conform to the expected schema.
17
+ - **Payload Processing**: The app processes and transforms incoming webhook payloads to extract relevant data fields for BigQuery.
18
18
 
19
19
  ## Notable Code Patterns
20
- - **Modular Service Design**: The app uses a modular design, separating concerns into different modules for logging, state management, and BigQuery interactions.
21
- - **Error Handling and Logging**: Utilizes the `winston` library for structured logging, providing detailed insights into the app's operations and facilitating debugging.
22
- - **Version Management**: The app leverages Yarn workspaces and scripts for version management, ensuring consistent updates across all components.
20
+ - **Webhook Signature Validation**: Implements a robust mechanism to validate webhook signatures, enhancing security.
21
+ - **Conditional Logic for Webhook Types**: Uses a switch-case pattern to handle different webhook types, making the code modular and easier to maintain.
22
+ - **Error Handling and Logging**: Incorporates comprehensive logging and error handling using the `winston` library, which aids in debugging and monitoring.
23
23
 
24
- This summary provides a high-level understanding of the Seeka app's purpose, structure, and integration points, aiding AI systems in referencing and interacting with the app effectively.
24
+ This app serves as a template for integrating other data sources with Google BigQuery, showcasing best practices in webhook handling, data transformation, and serverless architecture.
@@ -1,26 +1,33 @@
1
1
  # AI Summary for Klaviyo Events App
2
2
 
3
- ## Purpose and Functionality
4
- The **Klaviyo Events App** is designed to integrate with Klaviyo for pushing activity events to facilitate email marketing automation. It acts as a bridge between Seeka apps and Klaviyo, enabling the automation of marketing tasks based on user activities captured by Seeka.
3
+ ## Overview
4
+
5
+ The **Klaviyo Events App** is designed to integrate with Klaviyo, a popular email marketing automation platform. The app's primary function is to push activity events to Klaviyo, facilitating enhanced email marketing automation and customer relationship management (CRM). It is built using Azure Functions, which allows for serverless execution of code in response to events.
5
6
 
6
7
  ## Key Implementation Patterns
7
- - **Azure Functions**: The app is structured as an Azure Function, which provides a serverless environment to handle HTTP requests, specifically webhooks from Seeka.
8
- - **Webhook Handling**: The app listens for various types of webhook events from Seeka, such as app installations, updates, and activity acceptance, and processes them accordingly.
9
- - **Logging**: Uses the `winston` library for logging, providing detailed logs for each webhook event processed.
10
- - **Background Jobs**: Implements a queuing system to handle certain tasks asynchronously, such as processing accepted activities.
8
+
9
+ 1. **Serverless Architecture**: Utilizes Azure Functions to handle HTTP requests, specifically webhooks from Seeka.
10
+ 2. **Webhook Handling**: The app listens for various types of webhooks related to app installations, activity acceptance, and more. It processes these webhooks to update installation states or trigger background jobs.
11
+ 3. **Logging**: Implements structured logging using the `winston` library to record detailed information about webhook processing.
12
+ 4. **Background Jobs**: Uses a job queue to process certain activities asynchronously, improving responsiveness and scalability.
11
13
 
12
14
  ## External APIs/Services Integrated
13
- - **Klaviyo**: The app integrates with Klaviyo to push events for email marketing automation.
14
- - **Azure Functions**: Utilizes Azure's serverless computing to handle HTTP requests and execute code in response to webhook events.
15
+
16
+ - **Klaviyo**: The app integrates with Klaviyo to push activity events for marketing automation.
17
+ - **Azure Functions**: Provides the serverless environment for executing the app's code.
18
+ - **Seeka SDK**: Utilizes the Seeka SDK for handling webhook payloads and validating signatures.
15
19
 
16
20
  ## Important Data Transformations
17
- - **Webhook Payload Processing**: The app parses and validates incoming webhook payloads, ensuring they are correctly formatted and signed before processing.
21
+
22
+ - **Webhook Payload Parsing**: The app parses incoming webhook payloads to extract necessary information for processing.
18
23
  - **Installation State Management**: Manages the state of app installations, updating or deleting records based on webhook events.
24
+ - **Activity Filtering**: Filters activities to determine which should be processed further, such as excluding page view activities from being pushed to the processing queue.
19
25
 
20
26
  ## Notable Code Patterns
21
- - **Webhook Signature Validation**: Implements a security measure to validate the signature of incoming webhooks, ensuring that only legitimate requests are processed.
22
- - **Error Handling**: Utilizes try-catch blocks to handle errors gracefully, logging detailed error information and returning appropriate HTTP status codes.
23
- - **Modular Services**: Uses a modular approach to start services and manage installations, allowing for easy maintenance and scalability.
24
- - **Conditional Processing**: Differentiates between test and production webhook calls, ensuring that test data does not affect live operations.
25
27
 
26
- This summary provides an overview of the app's purpose, key patterns, integrations, and notable code practices, offering a comprehensive understanding for AI systems analyzing or interacting with the app.
28
+ 1. **Webhook Signature Validation**: Ensures security by validating the signature of incoming webhooks using a secret key.
29
+ 2. **Conditional Processing**: Uses a switch-case structure to handle different types of webhook events, allowing for modular and maintainable code.
30
+ 3. **Error Handling**: Implements try-catch blocks to gracefully handle errors during webhook processing, logging detailed error information for troubleshooting.
31
+ 4. **Child Logger Creation**: Creates child loggers for specific installations to maintain context and improve log traceability.
32
+
33
+ This summary provides a high-level understanding of the Klaviyo Events App's architecture, integrations, and code patterns, which can be referenced for developing similar serverless applications with webhook handling and background job processing capabilities.
@@ -1,39 +1,29 @@
1
1
  # AI Summary for Navitas App
2
2
 
3
- ## Overview
3
+ ## Purpose and Functionality
4
4
 
5
- The Navitas app is designed to integrate with the Navitas education group, focusing on tracking student inquiries and conversions. It serves as a bridge between educational lead tracking and CRM systems, providing a seamless way to manage student data and interactions. The app includes both browser and server components, leveraging Azure Functions for server-side operations.
5
+ The Navitas app is designed to integrate with the Navitas education group to track student inquiries and conversions. It functions as a CRM tool and browser plugin, facilitating lead tracking and management within educational contexts.
6
6
 
7
7
  ## Key Implementation Patterns
8
8
 
9
- 1. **Monorepo Structure**: The app uses a monorepo setup with Yarn workspaces, organizing code into separate packages for the browser and server components, as well as a shared library for Google BigQuery interactions.
10
-
11
- 2. **Webhook Handling**: The app extensively uses webhooks to manage events such as app installation, settings updates, and uninstallation. The webhook handler validates incoming requests, processes them based on their type, and logs the operations for auditing and debugging.
12
-
13
- 3. **Continuous Delivery**: The app employs continuous delivery pipelines to automatically maintain certain BigQuery functions, views, and tables, ensuring that the data infrastructure remains consistent and up-to-date.
9
+ - **Monorepo Structure**: The app uses a monorepo setup with Yarn workspaces, organizing code into separate `app` and `lib` directories.
10
+ - **Azure Functions**: The server-side logic is implemented using Azure Functions, providing a scalable and event-driven architecture.
11
+ - **Webhook Handling**: The app processes various webhook events such as app installation, settings updates, and uninstallation. These events are managed through a centralized handler function (`seekaAppWebhook`).
14
12
 
15
13
  ## External APIs/Services Integrated
16
14
 
17
- 1. **Azure Functions**: The server component is built using Azure Functions, providing a scalable and efficient way to handle HTTP requests and background tasks.
18
-
19
- 2. **Salesforce**: The app integrates with Salesforce via outbound messages, requiring specific headers and XML content types for communication.
20
-
21
- 3. **Google BigQuery**: The app interacts with BigQuery for data storage and analysis, with specific instructions to avoid modifying certain auto-managed resources.
15
+ - **Salesforce**: The app integrates with Salesforce via outbound messages, using POST requests with XML content type to specific URLs for different environments (ACAP and SAE).
16
+ - **Google BigQuery**: The app interacts with Google BigQuery, although specific functions and tables are maintained automatically by Seeka's continuous delivery pipelines.
22
17
 
23
18
  ## Important Data Transformations
24
19
 
25
- - **Webhook Payload Processing**: Incoming webhook payloads are parsed and validated to ensure authenticity and integrity. The app processes different types of webhook calls, transforming them into actions such as creating or updating installations, or handling browser SDK plugin requests.
26
-
27
- - **Installation State Management**: The app manages installation states by creating or updating records with details such as granted permissions, installation IDs, and organizational information.
20
+ - **Webhook Payload Processing**: Incoming webhook payloads are parsed and validated. The app ensures the integrity of webhook calls by checking signatures and processing only valid requests.
21
+ - **Installation State Management**: The app manages installation states, creating or updating records based on webhook events. This involves handling permissions, installation IDs, and organizational contexts.
28
22
 
29
23
  ## Notable Code Patterns
30
24
 
31
- 1. **Logger Utilization**: The app uses the `winston` library for logging, providing detailed insights into webhook handling and error management. This pattern can be reused for robust logging in other applications.
32
-
33
- 2. **Environment Variable Usage**: Secure handling of sensitive information, such as webhook secrets, is achieved through environment variables, ensuring that these details are not hardcoded into the source code.
34
-
35
- 3. **Error Handling and Profiling**: The app includes comprehensive error handling and profiling for webhook requests, allowing for efficient debugging and performance monitoring.
36
-
37
- 4. **Version Management**: The app includes scripts for managing version bumps (patch, minor, major) across all workspaces, ensuring consistent versioning and deployment practices.
25
+ - **Logging with Winston**: The app utilizes the Winston logging library to provide detailed logging for webhook events, including profiling and error handling.
26
+ - **Error Handling and Validation**: The app employs robust error handling, particularly in validating webhook signatures and managing unknown installation IDs.
27
+ - **Service Initialization**: The `startServices` function is called to initialize necessary services before processing webhook events, ensuring the app is ready to handle requests efficiently.
38
28
 
39
- This summary provides a high-level understanding of the Navitas app's architecture, integrations, and key implementation details, which can be referenced for developing similar applications or enhancing existing ones.
29
+ This summary provides an overview of the Navitas app's architecture and implementation, highlighting its integration with external services and its use of Azure Functions for handling webhook events.
@@ -1,36 +1,33 @@
1
- # AI-Focused Summary for Seeka App: TrustArc
1
+ # AI Summary for Seeka App: TrustArc
2
2
 
3
3
  ## Overview
4
4
 
5
- **App Name:** TrustArc
6
- **Template Version:** V2
7
- **Template:** azurefunc
8
- **Components:** browser, server
9
- **Description:** The TrustArc app is designed for integrating consent management functionalities to ensure privacy compliance and consent tracking. It is particularly relevant for organizations needing to adhere to privacy regulations such as GDPR. The app functions as a browser plugin and includes server-side components to manage and track user consent.
5
+ The **TrustArc** Seeka app is designed to integrate TrustArc's consent management system into applications for enhanced privacy compliance and consent tracking. It is particularly focused on adhering to regulations such as GDPR. The app functions as a browser plugin and a server component, leveraging Azure Functions for server-side operations.
10
6
 
11
7
  ## Purpose and Functionality
12
8
 
13
- The TrustArc app provides a comprehensive solution for managing user consent in compliance with privacy regulations. It integrates with TrustArc's consent management platform to track and manage user consent efficiently. The app is structured to operate both in the browser and on the server, ensuring a seamless experience across different platforms.
9
+ - **Privacy Compliance**: The app facilitates the integration of TrustArc's consent management tools, ensuring that applications comply with privacy regulations like GDPR.
10
+ - **Consent Tracking**: It provides mechanisms to track user consent efficiently, crucial for legal compliance and user trust.
14
11
 
15
12
  ## Key Implementation Patterns
16
13
 
17
- - **Monorepo Structure:** The app uses a monorepo structure managed by Yarn workspaces, allowing for organized development and deployment of both browser and server components.
18
- - **Azure Functions:** The server component is implemented as an Azure Function, leveraging serverless architecture for scalability and efficient resource management.
19
- - **Development Workflow:** The app includes scripts for cleaning, linting, building, and deploying, ensuring a streamlined development process. The use of `yarn workspaces` commands facilitates operations across all components.
14
+ - **Monorepo Structure**: Utilizes Yarn workspaces to manage multiple packages (`browser` and `server`) within a single repository, promoting modular development.
15
+ - **Azure Functions**: Implements server-side logic using Azure Functions, which allows for scalable and event-driven serverless computing.
16
+ - **Development and Deployment Scripts**: Provides a set of Yarn scripts for cleaning, building, developing, and deploying the app, ensuring streamlined development workflows.
20
17
 
21
18
  ## External APIs/Services Integrated
22
19
 
23
- - **TrustArc API:** The app integrates with TrustArc's consent management platform to handle privacy compliance and consent tracking.
24
- - **Azure Functions Core Tools:** Utilized for local development and testing of Azure Functions, enabling developers to simulate the Azure environment on their local machines.
20
+ - **TrustArc API**: Integrates with TrustArc's API for consent management functionalities.
21
+ - **Azure Functions**: Utilizes Azure's serverless platform to handle backend operations, allowing for efficient and scalable processing.
25
22
 
26
23
  ## Important Data Transformations
27
24
 
28
- The app likely includes data transformations related to user consent data, ensuring that it is formatted and stored in compliance with privacy regulations. These transformations would typically involve normalizing consent data and securely transmitting it between the browser and server components.
25
+ - **Consent Data Handling**: Transforms and processes consent data from the browser plugin to the server component, ensuring that data is correctly formatted and compliant with privacy standards before storage or further processing.
29
26
 
30
27
  ## Notable Code Patterns
31
28
 
32
- - **Workspace Commands:** The use of `yarn workspaces foreach` allows for executing commands across multiple packages, promoting efficient management of the monorepo.
33
- - **Environment-Specific Builds:** Separate build scripts for development and production environments ensure that the app is optimized for different stages of deployment.
34
- - **Serverless Deployment:** The deployment script for Azure Functions highlights a pattern for deploying serverless applications, which can be reused for similar projects requiring scalable backend solutions.
29
+ - **Workspace Management**: The use of Yarn workspaces to manage dependencies and scripts across multiple packages is a reusable pattern for maintaining a clean and organized monorepo.
30
+ - **Serverless Deployment**: The deployment script leverages Azure Functions, which can be adapted for other serverless platforms, providing a template for deploying serverless applications.
31
+ - **Automated Dependency Updates**: The README includes a script for updating dependencies across all workspaces, ensuring that the app remains up-to-date with minimal manual intervention.
35
32
 
36
- This summary provides an AI assistant with a comprehensive understanding of the TrustArc app's architecture, implementation patterns, and integration points, facilitating better support and enhancements.
33
+ This summary provides a comprehensive understanding of the TrustArc Seeka app's architecture and implementation, highlighting its focus on privacy compliance and efficient consent management.
@@ -1,31 +1,31 @@
1
- ```markdown
2
1
  # AI Summary for Seeka Typeform App
3
2
 
3
+ ## Overview
4
+ The Seeka Typeform app integrates with Typeform to track form submissions and survey responses. It leverages webhooks to capture and process data, making it suitable for lead capture and survey analysis.
5
+
4
6
  ## Purpose and Functionality
5
- The Seeka Typeform app is designed to integrate with Typeform for tracking form submissions and survey responses. It leverages webhooks to capture lead data and survey responses, facilitating real-time data processing and integration with other systems.
7
+ - **Form and Survey Tracking**: The app is designed to integrate with Typeform to track form submissions and survey responses.
8
+ - **Webhook Integration**: Utilizes webhooks to receive real-time updates from Typeform, allowing for immediate processing of form data.
9
+ - **Lead Capture**: Facilitates capturing leads by processing form submissions and storing relevant data.
6
10
 
7
11
  ## Key Implementation Patterns
8
- - **Monorepo Structure**: The app uses a monorepo setup managed by Yarn workspaces, allowing for organized development across multiple components (`browser`, `ui`, `server`).
9
- - **Azure Functions**: The server-side logic is implemented using Azure Functions, providing a scalable and efficient way to handle HTTP requests and webhook events.
10
- - **Webhook Handling**: The app processes various webhook events such as `AppInstalled`, `AppUninstalled`, and `ActivityAccepted`, ensuring that the app's state is updated accordingly.
12
+ - **Monorepo Structure**: The app is organized using Yarn workspaces, allowing for modular development across different components (`browser`, `ui`, `server`).
13
+ - **Azure Functions**: The server-side logic is implemented using Azure Functions, providing a scalable and serverless architecture.
14
+ - **Webhook Handling**: Implements a robust webhook handling mechanism to process different types of webhook events from Seeka and Typeform.
11
15
 
12
16
  ## External APIs/Services Integrated
13
- - **Typeform**: The app integrates with Typeform to receive form submissions and survey responses.
14
- - **Seeka SDK**: Utilizes the `@seeka-labs/sdk-apps-server` for handling Seeka-specific webhook payloads and validation.
17
+ - **Typeform API**: Integrated to receive form submissions and survey responses.
18
+ - **Azure Functions**: Used for serverless execution of backend logic.
19
+ - **Seeka SDK**: Utilized for handling Seeka-specific webhook events and app installation states.
15
20
 
16
21
  ## Important Data Transformations
17
- - **Webhook Payload Parsing**: Incoming webhook payloads are parsed and validated to ensure they are from trusted sources, using signature validation.
18
- - **Installation State Management**: The app maintains the state of installations, updating or deleting records based on webhook events.
22
+ - **Webhook Payload Processing**: Parses and processes JSON payloads received from webhooks to extract relevant information.
23
+ - **Installation State Management**: Manages app installation states and settings, ensuring that webhooks are processed only for known installations.
19
24
 
20
25
  ## Notable Code Patterns
21
- - **Logging**: Uses Winston for structured logging, providing detailed insights into webhook processing and app state changes.
22
- - **Service Initialization**: The `startServices` function is invoked to initialize necessary services before processing webhook events.
23
- - **Error Handling**: Implements robust error handling and logging to manage invalid webhook signatures and unknown installation IDs.
24
-
25
- ## Reusable Code Patterns
26
- - **Webhook Signature Validation**: The `throwOnInvalidWebhookSignature` function provides a reusable pattern for validating webhook signatures across different applications.
27
- - **State Management**: Functions like `createOrUpdateInstallation` and `deleteInstallation` offer a template for managing application state in response to external events.
28
- - **Logging**: The use of `childLogger` and `webhookLogger` demonstrates a reusable pattern for context-specific logging.
26
+ - **Webhook Signature Validation**: Implements a security mechanism to validate webhook signatures, ensuring that only legitimate requests are processed.
27
+ - **Logger Utilization**: Uses `winston` for structured logging, which aids in debugging and monitoring webhook events.
28
+ - **Service Initialization**: The `startServices` function initializes necessary services before processing webhook events, ensuring that dependencies are ready.
29
+ - **Modular Development**: The use of separate workspaces for different components (`lib`, `browser`, `ui`, `server`) promotes clean separation of concerns and easier maintenance.
29
30
 
30
- This summary provides an overview of the Seeka Typeform app's architecture and implementation, highlighting its integration with Typeform and the use of Azure Functions for server-side processing. The app's design patterns and external integrations make it a robust solution for managing form submissions and survey responses.
31
- ```
31
+ This summary provides a comprehensive understanding of the Seeka Typeform app's architecture and implementation, highlighting its integration with Typeform and the use of webhooks for real-time data processing.
@@ -1,26 +1,30 @@
1
+ ```markdown
1
2
  # AI Summary for Seeka Webhook App
2
3
 
3
4
  ## Purpose and Functionality
4
- The Seeka Webhook app is designed to send Seeka activity data to custom webhook endpoints. It facilitates the integration of Seeka's platform with external systems by exporting data through webhooks. The app supports various webhook call types, including app installation, settings updates, and uninstallation.
5
+ The Seeka Webhook app is designed to send activity data from Seeka to custom webhook endpoints. It facilitates integration with external systems by exporting data through webhooks, allowing for seamless data exchange and automation.
5
6
 
6
7
  ## Key Implementation Patterns
7
- - **Azure Functions**: The app is implemented using Azure Functions, which handle HTTP requests for webhook events.
8
- - **Modular Architecture**: The app is divided into `ui` and `server` components, managed using Yarn workspaces for efficient dependency management and build processes.
9
- - **Logging**: Utilizes Winston for structured logging, providing detailed logs for debugging and monitoring webhook processing.
10
- - **Error Handling**: Implements robust error handling with try-catch blocks to manage exceptions during webhook processing.
8
+ - **Azure Functions**: The app leverages Azure Functions for handling HTTP requests, specifically for processing webhook events.
9
+ - **Modular Structure**: The app is divided into `ui` and `server` components, each managed as separate workspaces within a monorepo setup.
10
+ - **Logging**: Utilizes the `winston` library for structured logging, enhancing traceability and debugging capabilities.
11
11
 
12
12
  ## External APIs/Services Integrated
13
- - **Azure Functions**: The app is hosted on Azure Functions, leveraging its serverless capabilities for scalability and ease of deployment.
14
- - **Seeka SDK**: Integrates with the `@seeka-labs/sdk-apps-server` to handle Seeka-specific webhook payloads and validate webhook signatures.
13
+ - **Seeka SDK**: The app uses `@seeka-labs/sdk-apps-server` for handling webhook payloads and validating webhook signatures.
14
+ - **Azure Functions**: Provides the serverless environment for executing the webhook handler.
15
15
 
16
16
  ## Important Data Transformations
17
- - **Webhook Payload Parsing**: The app parses incoming webhook payloads from JSON strings into structured objects for processing.
18
- - **Installation Management**: Transforms installation-related data into a consistent format for storage and retrieval, including handling installation state and settings updates.
17
+ - **Webhook Payload Processing**: The app processes various types of webhook payloads, such as `AppInstalled`, `AppInstallSettingsUpdated`, and `AppUninstalled`. It validates the webhook signature and handles each type accordingly.
18
+ - **Installation Management**: The app creates, updates, or deletes installation records based on the webhook event type, ensuring that the state of installations is accurately maintained.
19
19
 
20
20
  ## Notable Code Patterns
21
- - **Webhook Signature Validation**: Ensures security by validating webhook signatures using a secret key, preventing unauthorized requests.
22
- - **Service Initialization**: Uses a `startServices` function to initialize necessary services before processing webhooks, ensuring all dependencies are ready.
23
- - **Conditional Processing**: Handles different webhook call types using a switch-case pattern, allowing for specific logic execution based on the event type.
24
- - **Profile Logging**: Utilizes logger profiling to measure execution time for specific operations, aiding in performance monitoring and optimization.
21
+ - **Webhook Signature Validation**: Implements a security measure to verify the authenticity of incoming webhook requests using a secret key.
22
+ - **Error Handling**: Employs try-catch blocks to manage exceptions during webhook processing, logging errors and returning appropriate HTTP status codes.
23
+ - **Profile Logging**: Uses `logger.profile` to measure and log the execution time of specific code blocks, aiding in performance monitoring.
25
24
 
26
- This summary provides an overview of the Seeka Webhook app's architecture, key functionalities, and implementation details, facilitating AI understanding and reference for further development or integration tasks.
25
+ ## Development and Deployment
26
+ - **Scripts**: The `package.json` includes a variety of scripts for building, testing, deploying, and managing versions of the app, indicating a robust CI/CD process.
27
+ - **Local Development**: Instructions for setting up a local development environment are provided, including commands for running the server and UI components.
28
+
29
+ This summary provides a comprehensive overview of the Seeka Webhook app's architecture and functionality, highlighting its integration capabilities and efficient handling of webhook events.
30
+ ```
@@ -2,25 +2,26 @@
2
2
  # AI Summary: Yeastar App
3
3
 
4
4
  ## Purpose and Functionality
5
- The Yeastar app is designed to integrate with Yeastar PBX systems to track phone calls and call events. It serves as a bridge between telephony systems and CRM platforms, enabling seamless call tracking and management.
5
+ The Yeastar app is designed to integrate with Yeastar PBX systems for tracking phone calls and call events. It facilitates the management of telephony data and integrates with CRM systems to enhance call tracking capabilities. The app processes various webhook events related to app installation, updates, and call activities.
6
6
 
7
7
  ## Key Implementation Patterns
8
- - **Monorepo Structure**: The app is organized using a monorepo structure with Yarn workspaces, separating concerns into `lib`, `server`, and `ui` components.
9
- - **Azure Functions**: The server-side logic is implemented using Azure Functions, specifically handling HTTP requests for webhook events.
10
- - **Webhook Handling**: The app processes various webhook events such as app installation, settings updates, and call activities using a centralized handler function.
8
+ - **Monorepo Structure**: The app uses a monorepo setup managed by Yarn workspaces, organizing code into separate components (`lib`, `server`, `ui`).
9
+ - **Azure Functions**: The server-side logic is implemented using Azure Functions, providing a scalable and serverless architecture for handling HTTP requests.
10
+ - **Webhook Handling**: The app processes incoming webhooks to manage app installations, updates, and call activities. It validates webhook signatures to ensure secure communication.
11
+ - **Logging**: Utilizes the `winston` library for structured logging, aiding in monitoring and debugging.
11
12
 
12
13
  ## External APIs/Services Integrated
13
- - **Azure Functions**: Utilized for serverless execution of webhook handlers.
14
- - **Seeka SDK**: The app integrates with the Seeka SDK to manage webhook payloads and validate webhook signatures.
14
+ - **Yeastar PBX**: The app integrates with Yeastar PBX systems to track and manage telephony events.
15
+ - **Azure Functions**: The server component is deployed as an Azure Function, leveraging Microsoft's cloud platform for execution.
15
16
 
16
17
  ## Important Data Transformations
17
- - **Webhook Payload Parsing**: Incoming HTTP requests are parsed to extract JSON payloads, which are then transformed into specific types defined by the Seeka SDK.
18
- - **Installation State Management**: The app manages installation states, updating or deleting records based on webhook events.
18
+ - **Webhook Payload Processing**: The app parses and processes JSON payloads from webhooks, transforming them into actionable data for installation management and activity tracking.
19
+ - **User Mapping**: Defines interfaces for mapping Yeastar user data, which can be used to associate telephony events with CRM records.
19
20
 
20
21
  ## Notable Code Patterns
21
- - **Logger Integration**: The app uses the `winston` library for logging, providing detailed logs for debugging and monitoring.
22
- - **Error Handling**: Comprehensive error handling is implemented to manage invalid webhook signatures and unknown installation IDs.
23
- - **Version Management**: The app includes scripts for automated version bumping and Git tagging, ensuring consistent version control.
22
+ - **Webhook Signature Validation**: A reusable pattern for validating the authenticity of incoming webhook requests using a secret key.
23
+ - **Service Initialization**: The `startServices` function pattern is used to initialize necessary services before processing webhook events.
24
+ - **Error Handling**: Structured error handling with logging ensures that failures are captured and logged for troubleshooting.
24
25
 
25
- This summary provides a high-level overview of the Yeastar app's architecture and implementation, highlighting key patterns and integrations that can be referenced for similar telephony and CRM integration projects.
26
+ This summary provides an overview of the Yeastar app's architecture and key features, highlighting its integration with telephony systems and use of Azure cloud services.
26
27
  ```