@seeka-labs/cli-apps 3.8.5 → 3.8.7
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.
- package/dist/ai-context/internal/examples/v1/activecampaign/_ai-summary.md +17 -34
- package/dist/ai-context/internal/examples/v1/complianz/_ai-summary.md +28 -22
- package/dist/ai-context/internal/examples/v1/ivvy/_ai-summary.md +20 -20
- package/dist/ai-context/internal/examples/v1/me-and-u-connect/_ai-summary.md +18 -28
- package/dist/ai-context/internal/examples/v1/me-and-u-manage/_ai-summary.md +14 -20
- package/dist/ai-context/internal/examples/v1/nowbookit/_ai-summary.md +28 -30
- package/dist/ai-context/internal/examples/v1/sevenrooms/_ai-summary.md +23 -23
- package/dist/ai-context/internal/examples/v1/tradable-bits/_ai-summary.md +31 -24
- package/dist/ai-context/internal/examples/v1/transcend/_ai-summary.md +17 -34
- package/dist/ai-context/internal/examples/v2/calendly/_ai-summary.md +19 -23
- package/dist/ai-context/internal/examples/v2/clarity/_ai-summary.md +24 -13
- package/dist/ai-context/internal/examples/v2/google-bigquery/_ai-summary.md +26 -13
- package/dist/ai-context/internal/examples/v2/klaviyo-events/_ai-summary.md +17 -22
- package/dist/ai-context/internal/examples/v2/navitas/_ai-summary.md +24 -12
- package/dist/ai-context/internal/examples/v2/trustarc/_ai-summary.md +19 -14
- package/dist/ai-context/internal/examples/v2/typeform/_ai-summary.md +45 -20
- package/dist/ai-context/internal/examples/v2/webhook/_ai-summary.md +30 -17
- package/dist/ai-context/internal/examples/v2/yeastar/_ai-summary.md +14 -16
- package/dist/ai-context/internal/examples/v3/google-ads/_ai-summary.md +19 -14
- package/dist/index.cjs +10 -9
- package/dist/index.cjs.map +2 -2
- package/dist/init-template/app/browser/package.json +1 -1
- package/dist/init-template/app/lib/package.json +1 -1
- package/dist/init-template/app/server-azurefunc/package.json +1 -1
- package/dist/init-template/app/ui/package.json +1 -1
- package/package.json +2 -2
- package/dist/ai-context/internal/architecture/v1-structure.md +0 -192
- package/dist/ai-context/internal/architecture/v2-structure.md +0 -261
- package/dist/ai-context/internal/architecture/v3-structure.md +0 -386
- package/dist/ai-context/internal/examples/v1/_index.md +0 -53
- package/dist/ai-context/internal/examples/v2/_index.md +0 -66
- package/dist/ai-context/internal/examples/v3/_index.md +0 -105
|
@@ -1,46 +1,29 @@
|
|
|
1
|
-
# AI Summary for Seeka App: ActiveCampaign
|
|
1
|
+
# AI Summary for Seeka App: ActiveCampaign
|
|
2
2
|
|
|
3
3
|
## Purpose and Functionality
|
|
4
|
-
|
|
5
|
-
The Seeka app `activecampaign` is designed to integrate with ActiveCampaign CRM to sync contacts and activity data. It facilitates the management of CRM data by handling webhooks from Seeka and performing operations such as installing, updating, and uninstalling apps, as well as processing activity data.
|
|
4
|
+
The Seeka app for ActiveCampaign is designed to integrate with the ActiveCampaign CRM to sync contacts and activity data. It facilitates the management of CRM data by handling webhooks related to app installation, updates, uninstallation, and activity acceptance. This integration supports marketing automation by ensuring that contact and activity data are consistently updated between Seeka and ActiveCampaign.
|
|
6
5
|
|
|
7
6
|
## Key Implementation Patterns
|
|
8
|
-
|
|
9
|
-
- **
|
|
10
|
-
- **
|
|
11
|
-
- **State Management**: Redis is used for storing installation states, which can be managed using the `@seeka-labs/sdk-apps-server`.
|
|
7
|
+
- **Azure Functions**: The app is built using Azure Functions, which allows it to handle HTTP requests and process webhooks efficiently. The functions are defined in TypeScript and are managed using the Azure Functions Core Tools.
|
|
8
|
+
- **Webhook Handling**: The app processes various webhook events from Seeka, such as app installation, settings updates, and activity acceptance. It validates webhook signatures to ensure secure communication.
|
|
9
|
+
- **State Management**: The app uses Redis, hosted by Upstash, to manage the state of installations. This allows for efficient data retrieval and storage.
|
|
12
10
|
|
|
13
11
|
## External APIs/Services Integrated
|
|
14
|
-
|
|
15
|
-
- **
|
|
16
|
-
- **
|
|
17
|
-
- **Upstash Redis**: Optionally used for state management, providing a scalable Redis instance.
|
|
12
|
+
- **ActiveCampaign API**: The app interacts with the ActiveCampaign API to manage contacts and pipelines. It includes functions to create or update contacts and handle pipeline deals.
|
|
13
|
+
- **Azure Storage**: Utilizes Azure Storage for queue management, enabling asynchronous processing of tasks.
|
|
14
|
+
- **Ngrok**: Used for exposing the app locally to the internet for testing purposes.
|
|
18
15
|
|
|
19
16
|
## Important Data Transformations
|
|
20
|
-
|
|
21
|
-
- **
|
|
22
|
-
- **Pipeline Management**: Maps and maintains pipelines in ActiveCampaign, ensuring deals are created and updated appropriately.
|
|
17
|
+
- **Contact Synchronization**: Transforms Seeka identity data into ActiveCampaign contact data to ensure seamless synchronization.
|
|
18
|
+
- **Pipeline Management**: Maps Seeka activities to ActiveCampaign pipeline deals, updating or creating deals as necessary based on webhook events.
|
|
23
19
|
|
|
24
20
|
## Notable Code Patterns
|
|
21
|
+
- **Webhook Validation**: Implements a robust pattern for validating webhook signatures using environment variables to ensure secure processing of incoming requests.
|
|
22
|
+
- **Logging with Winston**: Utilizes the Winston logging library for structured logging, with integration for Seq for enhanced log management.
|
|
23
|
+
- **Environment Configuration**: Uses environment variables extensively for configuration, allowing for flexible deployment across different environments.
|
|
25
24
|
|
|
26
|
-
|
|
27
|
-
- **
|
|
28
|
-
- **
|
|
29
|
-
|
|
30
|
-
## Development and Deployment
|
|
31
|
-
|
|
32
|
-
- **Local Development**: Supports local development with Azure Storage emulation using Azurite and local debugging via VSCode.
|
|
33
|
-
- **Deployment**: Ready for deployment to Azure Functions, with instructions for setting up environment variables and using GitLab for CI/CD.
|
|
34
|
-
- **Ngrok Integration**: Allows local testing by exposing the app to the internet using Ngrok.
|
|
35
|
-
|
|
36
|
-
## Logging and Monitoring
|
|
37
|
-
|
|
38
|
-
- **Winston and Seq**: Integrated for logging, providing structured and centralized logging capabilities.
|
|
39
|
-
|
|
40
|
-
## References
|
|
41
|
-
|
|
42
|
-
- [Azure Functions Documentation](https://learn.microsoft.com/en-us/azure/azure-functions/)
|
|
43
|
-
- [Azure Storage Quickstart](https://learn.microsoft.com/en-us/azure/storage/queues/storage-quickstart-queues-nodejs)
|
|
44
|
-
- [Ngrok Setup](https://ngrok.com/docs)
|
|
25
|
+
## Deployment and Development
|
|
26
|
+
- **Azure Deployment**: The app is designed to be deployed on Azure Functions, with instructions provided for setting up the necessary Azure resources.
|
|
27
|
+
- **Local Development**: Supports local development with Docker for emulating Azure Storage and Ngrok for testing webhooks.
|
|
45
28
|
|
|
46
|
-
This summary provides
|
|
29
|
+
This summary provides a comprehensive overview of the Seeka app's architecture and integration patterns, highlighting its use of Azure Functions, ActiveCampaign API, and Redis for state management.
|
|
@@ -1,36 +1,42 @@
|
|
|
1
|
-
# AI Summary for
|
|
1
|
+
# AI Summary for the Complianz App
|
|
2
2
|
|
|
3
3
|
## Overview
|
|
4
|
-
The Complianz app is a Seeka application designed to integrate consent management for GDPR and privacy compliance. It utilizes Azure Functions to handle webhooks and manage state, ensuring that user consent is properly managed and logged. The app is structured to facilitate easy deployment and development, leveraging several external services and libraries.
|
|
5
4
|
|
|
6
|
-
|
|
7
|
-
- **GDPR Compliance**: Manages user consent in compliance with GDPR regulations.
|
|
8
|
-
- **Webhook Handling**: Processes inbound webhooks from Seeka to manage app installations and updates.
|
|
9
|
-
- **State Management**: Utilizes Redis for storing app installation states and other necessary data.
|
|
10
|
-
- **Logging**: Implements centralized logging using Winston and Seq for monitoring and debugging.
|
|
5
|
+
The Complianz app is designed to integrate consent management for GDPR and privacy compliance within the Seeka platform. It leverages Azure Functions to handle various webhook events related to app installations, updates, and uninstalls, ensuring that user consent and privacy settings are managed efficiently.
|
|
11
6
|
|
|
12
7
|
## Key Implementation Patterns
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
8
|
+
|
|
9
|
+
1. **Azure Functions**: The app is structured around Azure Functions, providing a serverless architecture that handles HTTP requests for webhooks and health checks.
|
|
10
|
+
2. **Webhook Handling**: The app processes incoming webhooks from Seeka, validating signatures and managing app installation states.
|
|
11
|
+
3. **State Management**: Uses Redis for storing installation states, allowing for efficient retrieval and updates of app installation data.
|
|
12
|
+
4. **Logging**: Utilizes Winston for centralized logging, with optional integration with Seq for enhanced log management.
|
|
16
13
|
|
|
17
14
|
## External APIs/Services Integrated
|
|
18
|
-
|
|
19
|
-
- **
|
|
20
|
-
- **
|
|
21
|
-
- **
|
|
15
|
+
|
|
16
|
+
- **Azure Functions**: For serverless execution of app logic.
|
|
17
|
+
- **Redis**: For state management, storing app installation data.
|
|
18
|
+
- **Seq (optional)**: For enhanced logging capabilities.
|
|
19
|
+
- **Ngrok**: For exposing local development environments to the internet for testing.
|
|
22
20
|
|
|
23
21
|
## Important Data Transformations
|
|
24
|
-
|
|
25
|
-
- **
|
|
22
|
+
|
|
23
|
+
- **Webhook Payload Processing**: The app parses and validates JSON payloads from incoming webhooks, ensuring data integrity and security.
|
|
24
|
+
- **State Management**: Transforms installation data into a format suitable for storage and retrieval from Redis.
|
|
26
25
|
|
|
27
26
|
## Notable Code Patterns
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
27
|
+
|
|
28
|
+
1. **Webhook Signature Validation**: Ensures security by verifying the authenticity of incoming webhook requests using a secret key.
|
|
29
|
+
2. **Error Handling**: Implements robust error handling and logging to manage exceptions and provide detailed logs for debugging.
|
|
30
|
+
3. **Modular Function Design**: Functions are designed to handle specific tasks, such as `seekaAppWebhook` for webhooks and `healthCheck` for system health checks, promoting code reuse and maintainability.
|
|
31
31
|
|
|
32
32
|
## Development and Deployment
|
|
33
|
-
- **Local Development**: Supports local development with Docker and Ngrok for testing Azure storage and exposing local servers.
|
|
34
|
-
- **Continuous Deployment**: Scripts for building, testing, and deploying the app to Azure, ensuring a streamlined CI/CD process.
|
|
35
33
|
|
|
36
|
-
|
|
34
|
+
- **Local Development**: Supports local development with Docker for Azure storage emulation and Ngrok for testing.
|
|
35
|
+
- **Deployment**: Uses Azure Functions Core Tools for deploying to Azure, with scripts for building and cleaning the project.
|
|
36
|
+
|
|
37
|
+
## Debugging and Testing
|
|
38
|
+
|
|
39
|
+
- **VSCode Debugging**: Supports debugging with breakpoints in VSCode, primarily tested on Linux with WSL support for Windows.
|
|
40
|
+
- **Jest for Testing**: Utilizes Jest for running tests, ensuring code reliability and correctness.
|
|
41
|
+
|
|
42
|
+
This summary provides a comprehensive understanding of the Complianz app's architecture, external integrations, and key implementation patterns, aiding AI in referencing and understanding the app's functionality and design.
|
|
@@ -1,32 +1,32 @@
|
|
|
1
1
|
# AI Summary for Seeka App - iVvy
|
|
2
2
|
|
|
3
|
-
##
|
|
4
|
-
The Seeka app "iVvy" is designed to integrate with the iVvy venue management
|
|
3
|
+
## Purpose and Functionality
|
|
4
|
+
The Seeka app "iVvy" is designed to integrate with the iVvy venue management system, focusing on tracking event bookings and inquiries. It serves the hospitality sector by providing a seamless connection between event management and venue operations.
|
|
5
5
|
|
|
6
6
|
## Key Implementation Patterns
|
|
7
|
-
- **
|
|
8
|
-
- **
|
|
9
|
-
- **
|
|
7
|
+
- **Azure Functions**: The app is structured to deploy on Azure Functions, leveraging serverless architecture for scalability and cost-effectiveness.
|
|
8
|
+
- **AWS Lambda**: The app can also be deployed as an AWS Lambda function, providing flexibility in cloud service providers.
|
|
9
|
+
- **Redis for State Management**: Utilizes Redis, optionally hosted by Upstash, for managing installations and other state data.
|
|
10
|
+
- **Express Framework**: Uses Express.js to handle HTTP requests, providing a robust and efficient server-side framework.
|
|
10
11
|
|
|
11
12
|
## External APIs/Services Integrated
|
|
12
|
-
- **iVvy API**:
|
|
13
|
-
- **
|
|
14
|
-
- **
|
|
15
|
-
- **
|
|
13
|
+
- **iVvy API**: Integrates with iVvy's venue management API for accessing event booking and inquiry data.
|
|
14
|
+
- **Ngrok**: Used for exposing the app locally to the internet for testing purposes.
|
|
15
|
+
- **AWS Lambda and Azure Functions**: Supports deployment on these platforms for executing serverless functions.
|
|
16
|
+
- **Upstash**: Optionally used for hosting Redis instances.
|
|
16
17
|
|
|
17
18
|
## Important Data Transformations
|
|
18
|
-
- **State Management**:
|
|
19
|
-
- **
|
|
19
|
+
- **State Management**: The app manages state using Redis, specifically handling installations and other persistent data.
|
|
20
|
+
- **Environment Configuration**: Utilizes environment variables for configuration, ensuring secure and flexible deployments.
|
|
20
21
|
|
|
21
22
|
## Notable Code Patterns
|
|
22
|
-
- **
|
|
23
|
-
- **
|
|
24
|
-
- **
|
|
25
|
-
- **Build and Deployment Scripts**: Comprehensive scripts for building, cleaning, and deploying the app, including AWS CLI integration for Lambda deployment.
|
|
23
|
+
- **Build and Deployment Scripts**: Includes comprehensive scripts for building, cleaning, and deploying the app, supporting both AWS and Azure deployments.
|
|
24
|
+
- **Debugging Support**: Provides robust debugging capabilities using VSCode, with support for breakpoints and live URL exposure via Ngrok.
|
|
25
|
+
- **Logging**: Integrates Winston for logging, with planned support for Seq, enabling detailed application monitoring and troubleshooting.
|
|
26
26
|
|
|
27
|
-
##
|
|
28
|
-
- **
|
|
29
|
-
- **
|
|
27
|
+
## Development and Deployment
|
|
28
|
+
- **Development Tools**: Utilizes TypeScript for type-safe development, with ESLint for code quality assurance.
|
|
29
|
+
- **Continuous Deployment**: Supports automated deployment processes using AWS CLI and Azure Functions, streamlining updates and maintenance.
|
|
30
|
+
- **Environment Management**: Employs dotenv for managing environment variables, ensuring secure and consistent configuration across environments.
|
|
30
31
|
|
|
31
|
-
|
|
32
|
-
The Seeka app "iVvy" is a robust solution for venue management, leveraging modern cloud technologies and development practices. Its integration with iVvy and use of serverless architecture make it a scalable and efficient tool for managing event bookings and inquiries. The app's design patterns and deployment strategies offer valuable insights for similar applications in the events and hospitality domain.
|
|
32
|
+
This summary provides a comprehensive overview of the iVvy app's architecture, integrations, and development patterns, offering insights into its implementation for AI assistants.
|
|
@@ -1,40 +1,30 @@
|
|
|
1
|
-
# AI Summary for Me&u Connect
|
|
2
|
-
|
|
3
|
-
## Overview
|
|
4
|
-
|
|
5
|
-
The **Me&u Connect** Seeka app integrates mobile ordering and payment tracking functionalities specifically for the hospitality industry, such as restaurants. It leverages Azure Functions to handle webhooks and background jobs, providing a seamless connection between mobile ordering systems and CRM capabilities.
|
|
1
|
+
# AI Summary for Me&u Connect App
|
|
6
2
|
|
|
7
3
|
## Purpose and Functionality
|
|
8
|
-
|
|
9
|
-
- **Mobile Ordering Integration**: Facilitates mobile ordering for hospitality businesses.
|
|
10
|
-
- **Payment Tracking**: Tracks payments made through the app.
|
|
11
|
-
- **CRM Integration**: Connects with Me&u CRM to manage customer data and interactions.
|
|
12
|
-
- **Webhook Handling**: Processes various webhook events related to app installation, updates, and identity changes.
|
|
4
|
+
The "Me&u Connect" app is designed for integration in the hospitality industry, focusing on mobile ordering and payment tracking for restaurants. It serves as a bridge between the Me&u platform and Seeka's ecosystem, handling various CRM-related tasks such as contact synchronization and webhook processing.
|
|
13
5
|
|
|
14
6
|
## Key Implementation Patterns
|
|
15
|
-
|
|
16
|
-
- **
|
|
17
|
-
- **Background Jobs**:
|
|
18
|
-
- **State Management**:
|
|
19
|
-
- **Logging**: Employs Winston for logging, with plans to integrate Seq for structured logging.
|
|
7
|
+
- **Azure Functions**: The app is built using Azure Functions, leveraging serverless architecture for handling HTTP requests, timers, and storage queues.
|
|
8
|
+
- **Webhook Processing**: The app processes webhooks from Seeka, handling events like app installation, uninstallation, and identity changes.
|
|
9
|
+
- **Background Jobs**: Uses Azure Storage Queues to manage background tasks, such as contact synchronization, ensuring scalability and reliability.
|
|
10
|
+
- **State Management**: Redis is used for managing application state, particularly for storing installation data.
|
|
20
11
|
|
|
21
12
|
## External APIs/Services Integrated
|
|
22
|
-
|
|
23
|
-
- **
|
|
24
|
-
- **
|
|
25
|
-
- **Ngrok**: Provides local development support by exposing the app to the internet for testing purposes.
|
|
26
|
-
- **Seeka SDK**: Integrates with the Seeka SDK for handling webhook payloads and managing app installations.
|
|
13
|
+
- **Azure Services**: Utilizes Azure Functions, Azure Storage Queues, and optionally Azure Blob Storage for various operations.
|
|
14
|
+
- **Redis via Upstash**: Provides state management capabilities, with an option to use Upstash for Redis hosting.
|
|
15
|
+
- **Ngrok**: Used for exposing local development environments to the internet for testing purposes.
|
|
27
16
|
|
|
28
17
|
## Important Data Transformations
|
|
29
|
-
|
|
30
|
-
- **
|
|
31
|
-
- **Queue Payloads**: Deserializes queue messages for processing background jobs, grouping them by application installation ID for efficient handling.
|
|
18
|
+
- **Webhook Payloads**: Incoming webhook payloads are validated and parsed to trigger appropriate actions based on the event type.
|
|
19
|
+
- **Queue Payloads**: Data from Azure Storage Queues is deserialized and grouped by application installation ID for batch processing.
|
|
32
20
|
|
|
33
21
|
## Notable Code Patterns
|
|
22
|
+
- **Logging with Winston**: Extensive logging is implemented using Winston, providing detailed insights into app operations and error handling.
|
|
23
|
+
- **Function Handlers**: Each Azure Function is defined with specific handlers, such as HTTP requests and timer triggers, ensuring modular and maintainable code.
|
|
24
|
+
- **Error Handling**: Robust error handling mechanisms are in place, including retries and poison queue management for failed background jobs.
|
|
34
25
|
|
|
35
|
-
|
|
36
|
-
- **
|
|
37
|
-
- **
|
|
38
|
-
- **Queue Message Processing**: Efficient processing of queue messages with retry logic and poison queue handling for robust background job execution.
|
|
26
|
+
## Deployment and Development
|
|
27
|
+
- **Deployment**: The app is designed to be deployed on Azure Functions, with scripts provided for building, cleaning, and deploying the application.
|
|
28
|
+
- **Development Environment**: Instructions are provided for setting up a local development environment using Docker for Azure storage emulation and Ngrok for local testing.
|
|
39
29
|
|
|
40
|
-
This summary provides a
|
|
30
|
+
This summary provides a comprehensive overview of the "Me&u Connect" app's architecture and implementation, highlighting its integration with external services and key patterns that can be leveraged for similar applications.
|
|
@@ -1,33 +1,27 @@
|
|
|
1
|
-
```markdown
|
|
2
1
|
# AI Summary for Seeka App: Me&u Manage
|
|
3
2
|
|
|
4
3
|
## Purpose and Functionality
|
|
5
|
-
The "Me&u Manage" app is designed
|
|
6
|
-
|
|
7
|
-
- **Automatic Order Sync**: Regularly imports new and updated orders from Me&u, making them available for CRM workflows and reporting.
|
|
8
|
-
- **Marketing Consent Sync**: Updates customer preferences based on Me&u marketing opt-ins to maintain compliance and current audience lists.
|
|
9
|
-
- **Simple Installation**: Users can easily install and configure the app by providing a Me&u Access Token and Venue Slug.
|
|
4
|
+
The "Me&u Manage" app is designed for integration with the Me&u platform to facilitate venue management and order tracking. It connects Me&u venues to Seeka, ensuring that customer data and activities are automatically synchronized. The app provides features such as automatic order synchronization and marketing consent updates, running on a scheduled background process to keep CRM systems up-to-date without manual intervention.
|
|
10
5
|
|
|
11
6
|
## Key Implementation Patterns
|
|
12
|
-
- **Azure Functions**: The app is
|
|
13
|
-
- **
|
|
14
|
-
- **
|
|
15
|
-
- **
|
|
7
|
+
- **Azure Functions**: The app is implemented using Azure Functions, which handle HTTP requests, storage queues, and scheduled tasks.
|
|
8
|
+
- **Background Processing**: Utilizes Azure Storage Queues to manage background jobs for processing orders and marketing opt-ins.
|
|
9
|
+
- **Webhook Handling**: Processes webhooks from Seeka to manage app installation, updates, and uninstallation events.
|
|
10
|
+
- **Scheduled Polling**: A timer-triggered function polls for new data from Me&u at regular intervals (every 15 minutes).
|
|
16
11
|
|
|
17
12
|
## External APIs/Services Integrated
|
|
18
|
-
- **Me&u API**: The app
|
|
13
|
+
- **Me&u API**: The app integrates with the Me&u platform using a Stable GraphQL API to read menus, orders, and marketing opt-ins.
|
|
19
14
|
- **Azure Storage**: Utilizes Azure Storage Queues for managing background job processing.
|
|
20
|
-
- **Ngrok**: Used for exposing
|
|
15
|
+
- **Ngrok**: Used for exposing the app locally to the internet for testing purposes.
|
|
21
16
|
|
|
22
17
|
## Important Data Transformations
|
|
23
|
-
- **Order and Marketing Opt-
|
|
24
|
-
- **
|
|
18
|
+
- **Order and Marketing Opt-in Processing**: The app retrieves and processes new and updated orders and marketing opt-ins from Me&u, grouping them by application installation ID for efficient processing.
|
|
19
|
+
- **Data Syncing**: Transforms Me&u data into a format suitable for CRM workflows and reporting within Seeka.
|
|
25
20
|
|
|
26
21
|
## Notable Code Patterns
|
|
27
|
-
- **Webhook
|
|
28
|
-
- **Error Handling and
|
|
29
|
-
- **
|
|
30
|
-
- **
|
|
22
|
+
- **Webhook Validation**: Implements signature validation for incoming webhooks to ensure authenticity.
|
|
23
|
+
- **Error Handling and Logging**: Uses Winston for structured logging and error handling, including retry mechanisms and poison queue handling for failed jobs.
|
|
24
|
+
- **Service Initialization**: Centralized service startup pattern (`startServices`) to ensure all necessary services are initialized before processing requests.
|
|
25
|
+
- **Queue Payload Deserialization**: Custom deserialization of queue payloads to handle both single and batch items efficiently.
|
|
31
26
|
|
|
32
|
-
This summary provides an overview of the app's architecture
|
|
33
|
-
```
|
|
27
|
+
This summary provides an overview of the "Me&u Manage" app's architecture and functionality, highlighting its integration with external services, data processing capabilities, and reusable code patterns.
|
|
@@ -1,44 +1,42 @@
|
|
|
1
|
+
```markdown
|
|
1
2
|
# AI Summary for Seeka App: Now Book It
|
|
2
3
|
|
|
3
4
|
## Overview
|
|
5
|
+
The **Now Book It** Seeka app is designed to integrate with restaurant reservation systems to track bookings. It leverages Azure Functions to handle various webhook events related to app installations, updates, and reservation activities. The app is structured to facilitate seamless communication with external services and manage state efficiently.
|
|
4
6
|
|
|
5
|
-
|
|
7
|
+
## Purpose and Functionality
|
|
8
|
+
- **Integration with Restaurant Reservation Systems**: The app processes webhooks to track and manage restaurant bookings.
|
|
9
|
+
- **Webhook Handling**: It handles various webhook events such as app installation, updates, and uninstallation.
|
|
10
|
+
- **Background Job Processing**: Utilizes Azure Storage Queues to manage background tasks related to reservation processing.
|
|
11
|
+
- **Scheduled Tasks**: Implements scheduled polling to trigger background jobs for maintenance and updates.
|
|
6
12
|
|
|
7
13
|
## Key Implementation Patterns
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
3. **State Management**: Redis is used for managing the state of app installations. The app can be configured to use Upstash for Redis hosting, providing a scalable and managed solution.
|
|
14
|
-
|
|
15
|
-
4. **Background Jobs**: Background tasks are triggered using Azure Storage Queues. The app includes examples of queue processing and scheduled polling to handle periodic tasks.
|
|
16
|
-
|
|
17
|
-
5. **Logging**: The app uses Winston for logging, with integration to Seq for structured log management and analysis.
|
|
14
|
+
- **Azure Functions**: The app is built using Azure Functions, allowing for scalable and event-driven execution of tasks.
|
|
15
|
+
- **Webhook Validation**: Implements signature validation to ensure secure processing of incoming webhooks.
|
|
16
|
+
- **State Management**: Uses Redis for managing installation states and other persistent data.
|
|
17
|
+
- **Background Jobs**: Processes background tasks using Azure Storage Queues, ensuring tasks are handled asynchronously and efficiently.
|
|
18
18
|
|
|
19
19
|
## External APIs/Services Integrated
|
|
20
|
-
|
|
21
20
|
- **Azure Functions**: For serverless function execution.
|
|
22
|
-
- **Azure Storage
|
|
21
|
+
- **Azure Storage Queue**: For managing background job queues.
|
|
23
22
|
- **Redis (Upstash)**: For state management and caching.
|
|
24
|
-
- **Ngrok**: For exposing local development environments to the internet.
|
|
25
|
-
- **Seeka SDK**: For handling Seeka-specific webhook payloads and operations.
|
|
23
|
+
- **Ngrok**: For exposing local development environments to the internet for testing purposes.
|
|
26
24
|
|
|
27
25
|
## Important Data Transformations
|
|
28
|
-
|
|
29
|
-
- **
|
|
30
|
-
- **Queue Messages**: Queue messages are serialized and deserialized for processing background jobs, ensuring data integrity and consistency.
|
|
26
|
+
- **Webhook Payload Parsing**: Parses JSON payloads from incoming webhooks to extract necessary information for processing.
|
|
27
|
+
- **Queue Payload Serialization/Deserialization**: Converts data to and from queue messages for background job processing.
|
|
31
28
|
|
|
32
29
|
## Notable Code Patterns
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
30
|
+
- **Webhook Handling**: The `seekaAppWebhook` function demonstrates a robust pattern for handling and validating webhooks, which can be reused in other webhook-driven applications.
|
|
31
|
+
- **Background Job Processing**: The `queueExample` function provides a template for processing tasks asynchronously using Azure Storage Queues.
|
|
32
|
+
- **Scheduled Polling**: The `pollingExample` function showcases how to set up and execute scheduled tasks using Azure Timer bindings.
|
|
33
|
+
|
|
34
|
+
## Deployment and Development
|
|
35
|
+
- **Deployment**: The app is configured for deployment on Azure Functions, with Redis and Azure Storage as supporting services.
|
|
36
|
+
- **Local Development**: Utilizes Docker and Azurite for local emulation of Azure Storage services, and supports debugging in VSCode with WSL.
|
|
37
|
+
|
|
38
|
+
## References
|
|
39
|
+
- Azure Functions Documentation: [Azure Functions](https://learn.microsoft.com/en-us/azure/azure-functions/)
|
|
40
|
+
- Azure Storage Queue Documentation: [Azure Storage Queues](https://learn.microsoft.com/en-us/azure/storage/queues/)
|
|
41
|
+
- Redis by Upstash: [Upstash](https://upstash.com/)
|
|
42
|
+
```
|
|
@@ -1,42 +1,42 @@
|
|
|
1
|
-
# AI Summary for Seeka App
|
|
1
|
+
# AI Summary for Seeka App: SevenRooms
|
|
2
2
|
|
|
3
3
|
## Overview
|
|
4
4
|
|
|
5
|
-
The
|
|
5
|
+
The **SevenRooms** app is a Seeka application designed to integrate with the SevenRooms hospitality CRM. It facilitates restaurant reservations and guest management by leveraging Azure Functions and various external services. The app processes webhooks from SevenRooms and manages state and operations through Azure Storage Queues and Redis.
|
|
6
6
|
|
|
7
7
|
## Purpose and Functionality
|
|
8
8
|
|
|
9
|
-
- **Integration with SevenRooms CRM**: The app
|
|
10
|
-
- **
|
|
11
|
-
- **
|
|
9
|
+
- **Integration with SevenRooms CRM**: The app handles webhooks from SevenRooms to manage restaurant reservations and guest data.
|
|
10
|
+
- **State Management**: Utilizes Redis for storing app installation states and other necessary data.
|
|
11
|
+
- **Queue Processing**: Uses Azure Storage Queues to manage and process long-running operations asynchronously.
|
|
12
|
+
- **Logging and Monitoring**: Implements centralized logging using Winston and Seq for monitoring and debugging.
|
|
12
13
|
|
|
13
14
|
## Key Implementation Patterns
|
|
14
15
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
16
|
+
1. **Azure Functions**: The app is structured around Azure Functions, providing an event-driven serverless architecture for handling HTTP requests and queue messages.
|
|
17
|
+
2. **Webhook Handling**: Webhooks from SevenRooms are processed to update reservations and client data.
|
|
18
|
+
3. **State Management with Redis**: Redis is used to manage the state of app installations, allowing for efficient data retrieval and updates.
|
|
19
|
+
4. **Queue-Based Asynchronous Processing**: Azure Storage Queues are used to offload long-running tasks, ensuring that function execution time limits are respected.
|
|
20
|
+
5. **Centralized Logging**: Winston and Seq are used for logging, providing a robust solution for tracking and debugging operations.
|
|
18
21
|
|
|
19
22
|
## External APIs/Services Integrated
|
|
20
23
|
|
|
21
|
-
- **SevenRooms API**: For receiving and processing webhooks related to reservations and
|
|
22
|
-
- **Azure
|
|
23
|
-
- **
|
|
24
|
+
- **SevenRooms API**: For receiving and processing webhooks related to reservations and guest management.
|
|
25
|
+
- **Azure Functions**: For serverless function execution.
|
|
26
|
+
- **Azure Storage Queues**: For handling asynchronous tasks and managing long-running operations.
|
|
27
|
+
- **Redis**: For state management and caching.
|
|
28
|
+
- **Ngrok**: For exposing local development environments to the internet for testing.
|
|
24
29
|
|
|
25
30
|
## Important Data Transformations
|
|
26
31
|
|
|
27
|
-
- **Webhook Payload
|
|
28
|
-
- **Queue Message Serialization**:
|
|
32
|
+
- **Webhook Payload Processing**: The app processes JSON payloads from SevenRooms webhooks, extracting and transforming data as needed for reservation and client management.
|
|
33
|
+
- **Queue Message Serialization/Deserialization**: Data is serialized into queue messages for processing and deserialized when consumed by functions.
|
|
29
34
|
|
|
30
35
|
## Notable Code Patterns
|
|
31
36
|
|
|
32
|
-
- **
|
|
33
|
-
- **
|
|
34
|
-
- **
|
|
37
|
+
- **Function Handlers**: Each function is defined with a specific route and handler, allowing for modular and organized code.
|
|
38
|
+
- **Logging with Context**: The use of child loggers and context-based logging provides detailed insights into function execution and errors.
|
|
39
|
+
- **Service Initialization**: The `startServices` function initializes necessary services, ensuring that dependencies are ready before processing requests.
|
|
40
|
+
- **Error Handling and Poison Queue**: Errors in processing are caught and handled by sending problematic messages to a poison queue for further inspection.
|
|
35
41
|
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
- **Webhook Signature Validation**: Ensures secure processing of webhooks by validating signatures using `throwOnInvalidWebhookSignature`.
|
|
39
|
-
- **Background Job Handling**: Processes background tasks using `triggerBackgroundJob` and `handleSevenRoomsWebhookQueueItem`, which can be adapted for other queue-based processing needs.
|
|
40
|
-
- **Health Check Endpoint**: Implements a simple health check function to monitor the app's availability.
|
|
41
|
-
|
|
42
|
-
This summary provides a high-level understanding of the Seeka app's architecture, integrations, and key functionalities, aiding AI assistants in referencing and utilizing the app's implementation patterns effectively.
|
|
42
|
+
This summary provides a comprehensive understanding of the SevenRooms app's architecture and implementation, highlighting its integration with external services and its use of Azure serverless technologies.
|
|
@@ -1,38 +1,45 @@
|
|
|
1
|
-
# AI Summary for Tradable Bits
|
|
1
|
+
# AI Summary for Seeka App: Tradable Bits
|
|
2
2
|
|
|
3
|
-
##
|
|
3
|
+
## Overview
|
|
4
4
|
|
|
5
|
-
The **Tradable Bits Seeka
|
|
5
|
+
The **Tradable Bits** app is a Seeka application designed to integrate with the Tradable Bits fan engagement platform, primarily targeting the entertainment and sports sectors. It facilitates fan engagement and marketing activities by leveraging Azure Functions for serverless operations.
|
|
6
6
|
|
|
7
|
-
## Key
|
|
7
|
+
## Key Features and Functionality
|
|
8
8
|
|
|
9
|
-
- **
|
|
10
|
-
- **
|
|
11
|
-
- **
|
|
12
|
-
- **
|
|
9
|
+
- **Webhook Handling**: The app processes inbound webhooks from Seeka, enabling real-time interactions and updates.
|
|
10
|
+
- **Queue Management**: Utilizes Azure Storage Queues for managing asynchronous tasks, ensuring efficient handling of long-running operations.
|
|
11
|
+
- **Polling and Scheduling**: Implements scheduled functions to manage periodic tasks, optimizing resource usage and execution time.
|
|
12
|
+
- **Health Monitoring**: Provides a health check endpoint to monitor the app's status.
|
|
13
13
|
|
|
14
|
-
##
|
|
14
|
+
## Implementation Patterns
|
|
15
15
|
|
|
16
|
-
- **Azure
|
|
17
|
-
- **
|
|
18
|
-
- **
|
|
19
|
-
- **
|
|
16
|
+
- **Azure Functions**: The app is built using Azure Functions, allowing for scalable and event-driven execution.
|
|
17
|
+
- **TypeScript**: The codebase is written in TypeScript, providing type safety and modern JavaScript features.
|
|
18
|
+
- **Logging**: Centralized logging is implemented using Winston, with optional Seq integration for structured log management.
|
|
19
|
+
- **State Management**: Redis is used for managing application state, with support for alternative state providers.
|
|
20
20
|
|
|
21
|
-
##
|
|
21
|
+
## External APIs and Services
|
|
22
22
|
|
|
23
|
-
- **
|
|
24
|
-
- **
|
|
23
|
+
- **Azure Storage**: Integration with Azure Storage Queues for message handling and task offloading.
|
|
24
|
+
- **Ngrok**: Used for exposing the app locally to the internet for testing purposes.
|
|
25
|
+
- **Redis**: Utilized for state management, with optional support for Upstash as a Redis provider.
|
|
26
|
+
|
|
27
|
+
## Data Transformations
|
|
28
|
+
|
|
29
|
+
- **Webhook Payload Processing**: The app processes various webhook payloads, transforming them into actionable tasks or state updates.
|
|
30
|
+
- **Queue Message Handling**: Converts incoming data into queue messages for deferred processing.
|
|
25
31
|
|
|
26
32
|
## Notable Code Patterns
|
|
27
33
|
|
|
28
|
-
- **
|
|
29
|
-
- **
|
|
30
|
-
- **Error Handling
|
|
31
|
-
- **
|
|
34
|
+
- **Webhook Validation**: Implements a robust mechanism for validating webhook signatures to ensure secure communication.
|
|
35
|
+
- **Service Initialization**: Uses a `startServices` function to initialize necessary services before processing requests.
|
|
36
|
+
- **Error Handling**: Comprehensive error handling strategies are employed, with detailed logging for troubleshooting.
|
|
37
|
+
- **Environment Configuration**: Provides clear guidelines for setting up development and production environments, including Docker configurations for local emulation of Azure services.
|
|
32
38
|
|
|
33
|
-
##
|
|
39
|
+
## Reusable Components
|
|
34
40
|
|
|
35
|
-
- **
|
|
36
|
-
- **
|
|
41
|
+
- **Webhook Handler**: The `seekaAppWebhook` function can be adapted for other applications requiring webhook processing.
|
|
42
|
+
- **Queue and Polling Examples**: Serve as templates for implementing asynchronous task management in other serverless applications.
|
|
43
|
+
- **Logging Setup**: The Winston and Seq integration can be reused for centralized logging in different projects.
|
|
37
44
|
|
|
38
|
-
This summary
|
|
45
|
+
This summary provides a high-level understanding of the Tradable Bits app's architecture and functionality, highlighting its integration with Azure services and its focus on fan engagement in the entertainment and sports industries.
|