Merge branch 'main' into connector/affinityCRM

.dockerignore

@@ -6,8 +6,8 @@ node_modules/
 apps/magic-link/node_modules
 apps/magic-link/dist
 
-apps/client-ts/node_modules
-apps/client-ts/.next
+apps/webapp/node_modules
+apps/webapp/.next
 
 packages/api/node_modules
 packages/api/dist

.env.example

@@ -2,14 +2,18 @@
 # API Backend
 # ================================================
 ENV=dev
-DISTRIBUTION=selfhosted # selfhosted or managed
+DISTRIBUTION=selfhost # selfhost or managed
 PANORA_BASE_API_URL=http://localhost:3000
 JWT_SECRET=secret_jwt
 ENCRYPT_CRYPTO_SECRET_KEY="0123456789abcdef0123456789abcdef"
-#Managed only
+
+# Only used when DISTRIBUTION=managed
 SENTRY_DSN=
 SENTRY_ENABLED=FALSE
 
+POSTHOG_HOST=<ph_instance_address>
+POSTHOG_KEY=<ph_instance_key>
+PH_TELEMETRY= #FALSE or TRUE
 
 # ================================================
 # REDIS
@@ -20,22 +24,38 @@ REDIS_PASS=A3vniod98Zbuvn9u5
 
 #REDIS_TLS=
 
-
 # ================================================
+# Tip: use mailtrap.io for local development
+EMAIL_SENDING_ADDRESS=[email protected]
 
+SMTP_HOST=
+SMTP_PORT=
+SMTP_USER=
+SMTP_PASSWORD=
 # ================================================
 # Database
 # ================================================
 POSTGRES_USER=my_user
 POSTGRES_DB=panora_db
 POSTGRES_HOST=postgres
 POSTGRES_PASSWORD=my_password
+
 # Endpoint on which realtime webhooks are sent to 
-WEBHOOK_INGRESS=http://localhost:3000
+WEBHOOK_INGRESS=YOUR_ENDPOINT_URL_TO_RECEIVE_PANORA_WEBHOOKS
+
+# Mandatory only when DISTRIBUTION=selfhost
+# 1. Execute cp ngrok.yml.example ngrok.yml
+# 2. Uncomment ngrok service in docker-compose{.dev, .source}.yml
+# Endpoint (an Ngrok tunnel domain) when you have to test your OAuth App and needs a redirectUri that redirects to your localhost
+# (useful for contributors that might need to test their oAuth flow)
+REDIRECT_TUNNEL_INGRESS=NGROK_DOMAIN
+
 
 # Each Provider is of form PROVIDER_VERTICAL_SOFTWAREMODE_ATTRIBUTE
+# check (https://docs.panora.dev/open-source/contributors)
+# OAuth : ATTRIBUTE c [CLIENT_ID, CLIENT_SECRET] & {SUBDOMAIN} (some providers might need a subdomain)
 # ================================================
-# Integration Providers
+# Credentials of Integration Providers
 # ================================================
 # CRM
 # Hubspot
@@ -50,16 +70,15 @@ PIPEDRIVE_CRM_CLOUD_CLIENT_SECRET=
 # Zendesk
 ZENDESK_CRM_CLOUD_CLIENT_ID=
 ZENDESK_CRM_CLOUD_CLIENT_SECRET=
-# Freshsales
-FRESHSALES_CRM_CLOUD_CLIENT_ID= 
-FRESHSALES_CRM_CLOUD_CLIENT_SECRET=
 # Attio
 ATTIO_CRM_CLOUD_CLIENT_ID=
 ATTIO_CRM_CLOUD_CLIENT_SECRET=
-
 # Close
 CLOSE_CRM_CLOUD_CLIENT_ID=
 CLOSE_CRM_CLOUD_CLIENT_SECRET=
+# Microsft Dynamics Sales
+MICROSOFTDYNAMICSSALES_CRM_CLOUD_CLIENT_ID=
+MICROSOFTDYNAMICSSALES_CRM_CLOUD_CLIENT_SECRET=
 
 # ================================================
 # Ticketing
@@ -68,23 +87,71 @@ CLOSE_CRM_CLOUD_CLIENT_SECRET=
 ZENDESK_TICKETING_CLOUD_CLIENT_ID=
 ZENDESK_TICKETING_CLOUD_CLIENT_SECRET= 
 ZENDESK_TICKETING_CLOUD_SUBDOMAIN=
+# Jira
 JIRA_TICKETING_CLOUD_CLIENT_ID=
 JIRA_TICKETING_CLOUD_CLIENT_SECRET=
-GORGIAS_TICKETING_CLOUD_CLIENT_ID=
-GORGIAS_TICKETING_CLOUD_CLIENT_SECRET=
-GORGIAS_TICKETING_CLOUD_SUBDOMAIN=
+# Front
 FRONT_TICKETING_CLOUD_CLIENT_ID=
 FRONT_TICKETING_CLOUD_CLIENT_SECRET=
+# Gitlab
 GITLAB_TICKETING_CLOUD_CLIENT_ID=
 GITLAB_TICKETING_CLOUD_CLIENT_SECRET=
+# Github
+GITHUB_TICKETING_CLOUD_CLIENT_ID=
+GITHUB_TICKETING_CLOUD_CLIENT_SECRET=
+# Linear
+LINEAR_TICKETING_CLOUD_CLIENT_ID=
+LINEAR_TICKETING_CLOUD_CLIENT_SECRET=
+
+# ================================================
+# File Storage
+# ================================================
+# Box
+BOX_FILESTORAGE_CLOUD_CLIENT_ID=
+BOX_FILESTORAGE_CLOUD_CLIENT_SECRET=
+
+
+# ================================================
+# HRIS
+# ================================================
+# Deel
+DEEL_HRIS_CLOUD_CLIENT_ID=
+DEEL_HRIS_CLOUD_CLIENT_SECRET=
+# Sage
+SAGE_HRIS_CLOUD_CLIENT_ID=
+SAGE_HRIS_CLOUD_CLIENT_SECRET=
+# Gusto
+GUSTO_HRIS_CLOUD_CLIENT_ID=
+GUSTO_HRIS_CLOUD_CLIENT_SECRET=
+
+
+# ================================================
+# ECOMMERCE
+# ================================================
+# Shopify
+SHOPIFY_ECOMMERCE_CLOUD_CLIENT_ID=
+SHOPIFY_ECOMMERCE_CLOUD_CLIENT_SECRET=
+# Webflow
+WEBFLOW_ECOMMERCE_CLOUD_CLIENT_ID=
+WEBFLOW_ECOMMERCE_CLOUD_CLIENT_SECRET=
+# Amazon
+AMAZON_ECOMMERCE_CLOUD_CLIENT_ID=
+AMAZON_ECOMMERCE_CLOUD_CLIENT_SECRET=
+# Woo Commerce
+WOOCOMMERCE_ECOMMERCE_CLOUD_CLIENT_ID=
+WOOCOMMERCE_ECOMMERCE_CLOUD_CLIENT_SECRET=
+# Squarespace
+SQUARESPACE_ECOMMERCE_CLOUD_CLIENT_ID=
+SQUARESPACE_ECOMMERCE_CLOUD_CLIENT_SECRET=
+
+
+
 # ================================================
 # Webapp settings
 # Must be set in the perspective of the end user browser
 
 NEXT_PUBLIC_BACKEND_DOMAIN=http://localhost:3000 # https://api.panora.dev/
 NEXT_PUBLIC_MAGIC_LINK_DOMAIN=http://localhost:81
-NEXT_PUBLIC_POSTHOG_KEY=<ph_project_api_key>
-NEXT_PUBLIC_POSTHOG_HOST=<ph_instance_address>
 NEXT_PUBLIC_WEBAPP_DOMAIN="http://localhost"
-# Disable Next.js spyware
-NEXT_TELEMETRY_DISABLED=1
+NEXT_PUBLIC_DISTRIBUTION="selfhost" # selfhost or managed
+

.github/workflows/docker.check-build.dashboard.selfhosted.yml

@@ -23,14 +23,12 @@ jobs:
         with:
           platforms: linux/amd64,linux/arm64
           context: .
-          file: ./apps/client-ts/Dockerfile
+          file: ./apps/webapp/Dockerfile
           push: false
           tags: panoradotdev/frontend-webapp:selfhosted
           build-args: |
             NEXT_PUBLIC_BACKEND_DOMAIN=${{ secrets.NEXT_PUBLIC_BACKEND_DOMAIN }}
             NEXT_PUBLIC_MAGIC_LINK_DOMAIN=${{ secrets.NEXT_PUBLIC_MAGIC_LINK_DOMAIN }}
-            NEXT_PUBLIC_STYTCH_PROJECT_ID=${{ secrets.NEXT_PUBLIC_STYTCH_PROJECT_ID }}
-            NEXT_PUBLIC_STYTCH_SECRET=${{ secrets.NEXT_PUBLIC_STYTCH_SECRET }}
-            NEXT_PUBLIC_STYTCH_PROJECT_ENV=${{ secrets.NEXT_PUBLIC_STYTCH_PROJECT_ENV }}
-            NEXT_PUBLIC_STYTCH_PUBLIC_TOKEN=${{ secrets.NEXT_PUBLIC_STYTCH_PUBLIC_TOKEN }}
-            NEXT_PUBLIC_DISTRIBUTION=${{ env.DISTRIBUTION }}
+            NEXT_PUBLIC_DISTRIBUTION=${{ env.DISTRIBUTION }}
+            NEXT_PUBLIC_REDIRECT_WEBHOOK_INGRESS=${{ secrets.NEXT_PUBLIC_REDIRECT_WEBHOOK_INGRESS }}
+            NEXT_PUBLIC_WEBAPP_DOMAIN= ${{env.NEXT_PUBLIC_WEBAPP_DOMAIN}}

.github/workflows/docker.export.backend.selfhosted.yml

@@ -35,7 +35,7 @@ jobs:
           build-args: |
             PANORA_BASE_API_URL=${{ env.PANORA_BASE_API_URL }}
             DISTRIBUTION=${{ env.DISTRIBUTION }}
-            ENV=${{ ENV }}
+            ENV=${{ env.ENV }}
             DATABASE_URL=postgresql://${{env.POSTGRES_USER}}:${{secrets.POSTGRES_PASSWORD}}@${{env.POSTGRES_HOST}}:5432/${{env.POSTGRES_DB}}?ssl=false
             JWT_SECRET=${{ secrets.JWT_SECRET }}
             REDIS_HOST=redis
@@ -50,3 +50,4 @@ jobs:
             ZENDESK_CLIENT_SECRET=${{ secrets.ZENDESK_CLIENT_SECRET }}
             ZENDESK_TICKETING_CLIENT_ID=${{ secrets.ZENDESK_TICKETING_CLIENT_ID }}
             ZENDESK_TICKETING_CLIENT_SECRET=${{ secrets.ZENDESK_TICKETING_CLIENT_SECRET }}
+            REDIRECT_TUNNEL_INGRESS=${{ env.REDIRECT_TUNNEL_INGRESS}}

.github/workflows/docker.export.frontend-dashboard.selfhosted.yml

@@ -29,14 +29,12 @@ jobs:
         with:
           platforms: linux/amd64,linux/arm64
           context: .
-          file: ./apps/client-ts/Dockerfile
+          file: ./apps/webapp/Dockerfile
           push: true
           tags: panoradotdev/frontend-webapp:selfhosted
           build-args: |
             NEXT_PUBLIC_BACKEND_DOMAIN=${{ secrets.NEXT_PUBLIC_BACKEND_DOMAIN }}
             NEXT_PUBLIC_MAGIC_LINK_DOMAIN=${{ secrets.NEXT_PUBLIC_MAGIC_LINK_DOMAIN }}
-            NEXT_PUBLIC_STYTCH_PROJECT_ID=${{ secrets.NEXT_PUBLIC_STYTCH_PROJECT_ID }}
-            NEXT_PUBLIC_STYTCH_SECRET=${{ secrets.NEXT_PUBLIC_STYTCH_SECRET }}
-            NEXT_PUBLIC_STYTCH_PROJECT_ENV=${{ secrets.NEXT_PUBLIC_STYTCH_PROJECT_ENV }}
-            NEXT_PUBLIC_STYTCH_PUBLIC_TOKEN=${{ secrets.NEXT_PUBLIC_STYTCH_PUBLIC_TOKEN }}
-            NEXT_PUBLIC_DISTRIBUTION=${{ env.DISTRIBUTION }}
+            NEXT_PUBLIC_DISTRIBUTION=${{ env.DISTRIBUTION }}
+            NEXT_PUBLIC_REDIRECT_WEBHOOK_INGRESS=${{ env.NEXT_PUBLIC_REDIRECT_WEBHOOK_INGRESS }}
+            NEXT_PUBLIC_WEBAPP_DOMAIN= ${{env.NEXT_PUBLIC_WEBAPP_DOMAIN}}

.github/workflows/merge_code_samples.yaml

@@ -0,0 +1,25 @@
+name: Merge Code Samples Into OpenAPI Spec
+permissions:
+    checks: write
+    contents: write
+    pull-requests: write
+    statuses: write
+"on":
+    workflow_dispatch:
+        inputs:
+            force:
+                description: Force generation of SDKs
+                type: boolean
+                default: false
+    schedule:
+        - cron: 0 0 * * *
+jobs:
+    generate:
+        uses: speakeasy-api/sdk-generation-action/.github/workflows/workflow-executor.yaml@v15
+        with:
+            force: ${{ github.event.inputs.force }}
+            mode: pr
+            speakeasy_version: latest
+        secrets:
+            github_access_token: ${{ secrets.GITHUB_TOKEN }}
+            speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}

.gitignore

@@ -1,3 +1,4 @@
+ngrok.yml
 **/node_modules/
 **/dist/
 node_modules
@@ -12,4 +13,5 @@ redis_data
 .pnpm-store/
 .npmrc
 .vscode
-ngrok.yml
+docs/objects
+.magicodeignore

.speakeasy/workflow.lock

@@ -0,0 +1,26 @@
+speakeasyVersion: 1.374.2
+sources:
+    merge-code-samples-into-spec:
+        sourceNamespace: merge-code-samples-into-spec
+        sourceRevisionDigest: sha256:1bcf3a8cca852c571571fad60c90aad27624f86e4f2fb58e3777f0c3a6ec712a
+        sourceBlobDigest: sha256:ebdf0ba69a79a32d558c774cfe0f0c32d742319ed3c3d3d887bf14ac67f417d8
+        tags:
+            - latest
+            - main
+targets: {}
+workflow:
+    workflowVersion: 1.0.0
+    speakeasyVersion: latest
+    sources:
+        merge-code-samples-into-spec:
+            inputs:
+                - location: registry.speakeasyapi.dev/panora/panora/panora-open-api-swagger
+            overlays:
+                - location: registry.speakeasyapi.dev/panora/panora/code-samples-typescript-my-first-target:main
+                - location: registry.speakeasyapi.dev/panora/panora/code-samples-python:main
+                - location: registry.speakeasyapi.dev/panora/panora/go-sdk:main
+                - location: registry.speakeasyapi.dev/panora/panora/code-samples-ruby:main
+            output: packages/api/swagger/openapi-with-code-samples.yaml
+            registry:
+                location: registry.speakeasyapi.dev/panora/panora/merge-code-samples-into-spec
+    targets: {}