@seeka-labs/cli-apps 1.1.38 → 2.0.7-rc.1

package/dist/{init-templates/azure-function → init-template/app/server-azure-function}/.funcignore

@@ -1,17 +1,22 @@
-*.js.map
 *.ts
-.git*
-.vscode
 local.settings.json
 test
 scripts/
 src/
-getting_started.md
+README.md
+tsconfig.json
+.eslintrc.cjs
+
+node_modules/@jest/globals/
 node_modules/@types/
-node_modules/azure-functions-core-tools/
-node_modules/typescript/
 node_modules/@typescript-eslint/eslint-plugin/
 node_modules/@typescript-eslint/parser/
+node_modules/azure-functions-core-tools/
 node_modules/eslint/
+node_modules/jest/
 node_modules/ngrok/
-node_modules/rimraf/
+node_modules/rimraf/
+node_modules/ts-jest/
+node_modules/typescript/
+
+.gitignore

package/dist/init-template/app/server-azure-function/.nvmrc

@@ -0,0 +1 @@
+20

package/dist/{init-templates/azure-function → init-template/app/server-azure-function}/README.md

@@ -1,108 +1,105 @@
-# Seeka app - Azure functions
-
-## Development
-
-- See [Configure your environment](https://learn.microsoft.com/en-us/azure/azure-functions/create-first-function-vs-code-typescript?pivots=nodejs-model-v4#configure-your-environment) for dependencies
-- For emulating Azure storage queues, blobs and tables: `docker run --name azurite -p 10000:10000 -p 10001:10001 -p 10002:10002 --detach mcr.microsoft.com/azure-storage/azurite`
-- Set `AzureWebJobsStorage` setting in local.settings.json to `UseDevelopmentStorage=true`
-    - If not using WSL: 
-    `UseDevelopmentStorage=true`
-    - If using WSL, the following may be required to allow your app to reach Azure storage emulator: 
-
-        Replace `MY-MACHINE-NAME` with your hostname. Below connection string allows running Azurite on your host machine and lets WSL connect to it
-        `DefaultEndpointsProtocol=http;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;BlobEndpoint=http://MY-MACHINE-NAME.local:10000/devstoreaccount1;QueueEndpoint=http://MY-MACHINE-NAME.local:10001/devstoreaccount1;TableEndpoint=http://MY-MACHINE-NAME.local:10002/devstoreaccount1;`
-- Install Azure Storage explorer and create your queues (see `./src/lib/jobs/index.ts` for `queueNames`). Azure Storage explorer can be used to view your queue items.
-- `yarn install`
-- `yarn dev`
-
-### Debugging
-Supports VSCode debugging via the debugger and utilisation of breakpoints. 
-This is only tested on Linux but may work on Windows. 
-If using Windows then use WSL with an Ubuntu distro for support of attaching the VS code debugger
-
-### Live urls
-You can expose your app locally to the internet via Ngrok to test your app before deploying.
-
-#### Setup
-1. Sign up for a Ngrok account
-2. Get your auth token
-3. `yarn ngrok config add-authtoken [auth token here]` replacing `[auth token]` with the auth token retrieved from your Ngrok dashboard
-
-#### Running
-1. `yarn start` OR start debugging in VSCode
-2. In separate terminal window run `yarn tunnel` and observe the log entry that starts with `Live url exposed`.
-3. Input the URL into your Seeka app configuration as the "Webook URL" via the Seeka UI.
-
-## Included sample functions
-### Seeka app webhook 
-`src/functions/seekaAppWebhook.ts`
-
-Handles inbound webhooks sent from Seeka to your app.
-
-### Queue example 
-`src/functions/queueExample.ts`
-
-Handles taking a message and placing it on an Azure storage queue for later processing. This concept can be used to offload long running operations based on data sent to your app from Seeka and can help to ensure Azure Function time execution limits are respected.
-
-### Polling example 
-`src/functions/pollingExample.ts`
-
-Handles scheduled invoking of a function. This concept can be used to "fan out" long running operations based on data sent to your app from Seeka and can help to ensure Azure Function time execution limits are respected by splitting long running operations into smaller, less time consuming parts.
-
-## Invoking functions
-### Development environment
-Scheduled / timer function: `curl -i -d '{"input": null}' -H "Content-Type: application/json" -X POST http://localhost:7072/admin/functions/pollingExample`
-
-### Azure cloud
-Scheduled / timer function: `curl -i -d '{"input": null}' -H "Content-Type: application/json" -H "x-functions-key: <key from azure portal>" -X POST https://seeka-app-example-name.azurewebsites.net/admin/functions/pollingExample`
-
-See [this doc](https://learn.microsoft.com/en-us/azure/azure-functions/functions-manually-run-non-http?tabs=azure-portal#get-the-master-key) on how to get the functions (master) key
-
-## Logging
-Centralised logging handled by [Winston](https://www.npmjs.com/package/winston). Winston is installed in this template and is also used in the Seeka SDK NPM packages.
-
-[Seq](https://datalust.co/seq) Winston transport is installed in this template (optional).
-
-To configure Seq options, see `_SEQ_` environment variables.
-
-To install Seq on your development machine
-1. Run `docker run --name seq -d --restart=always -e ACCEPT_EULA=Y -p 5341:80 datalust/seq:2024.2`
-2. Update your `LOGGING_SEQ_SERVERURL` environment variable to `http://localhost:5341` or `http://[YOUR MACHINE NAME].local:5341` if using WSL.
-
-If creating an API key for Seq, only permission that is required is `Ingest`.
-
-## State management
-Installations of your app and other state required for your app to function is stored in Redis. Another state provider can be swapped out for Redis, see `src/lib/state/seeka/installations.ts` for the file that manages the state of the installations.
-
-### Upstash (optional)
-If you dont want to use Upstash for Redis then the connection strings in `.env` can be swapped with your Redis instance. 
-
-> If using Upstash then create a database before following the below guide to deploying your AWS lambda function.
-
-> When choosing region - use a region that is closest to the Azure region that your function app is hosted in to reduce latency between the function and the Redis database. 
-
-## Deployment
-This project comes ready to deploy for free to Azure functions with database backed by Redis hosted by Upstash and queues, blobs and tables backed by Azure Storage.
-
-1. Create Azure function app via the portal with below settings
-    - Function app name: seeka-app-example-name
-    - Code or container image: Code
-    - Runtime stack: Node.js
-    - Version: 20
-    - Region: Closest region to where your upstash "master / write" database is located
-    - Operating system: linux
-    - Hosting: Consumption
-    - Enable public access: On
-2. Set environment variables of the Azure web app - reference local.settings.json "Values" 
-3. If your app receives calls directly from the browser (eg. your browser app plugin) then CORS needs to be enabled for all origins from within the settings of the Function app in Azure portal.
-3. `yarn deploy`
-
-### Continuous delivery
-This template includes a GitLab CD pipeline that can be used to trigger deployments of your app when changes are pushed to your Git repository.
-
-### Configuring queues
-See [this article](https://learn.microsoft.com/en-us/azure/azure-functions/functions-bindings-storage-queue?tabs=isolated-process%2Cextensionv5%2Cextensionv3&pivots=programming-language-typescript#host-json) on settings that are settable in the `host.json` file.
-
-## References
-- https://learn.microsoft.com/en-us/azure/storage/common/storage-use-azurite
+# Seeka app - Azure functions
+
+## Development
+
+- See [Configure your environment](https://learn.microsoft.com/en-us/azure/azure-functions/create-first-function-vs-code-typescript?pivots=nodejs-model-v4#configure-your-environment) for dependencies
+- For emulating Azure storage queues, blobs and tables: `docker run --name azurite -p 10000:10000 -p 10001:10001 -p 10002:10002 --detach mcr.microsoft.com/azure-storage/azurite`
+- Set `AzureWebJobsStorage` setting in local.settings.json to `UseDevelopmentStorage=true`
+    - If not using WSL: 
+    `UseDevelopmentStorage=true`
+    - If using WSL, the following may be required to allow your app to reach Azure storage emulator: 
+
+        Replace `MY-MACHINE-NAME` with your hostname. Below connection string allows running Azurite on your host machine and lets WSL connect to it
+        `DefaultEndpointsProtocol=http;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;BlobEndpoint=http://MY-MACHINE-NAME.local:10000/devstoreaccount1;QueueEndpoint=http://MY-MACHINE-NAME.local:10001/devstoreaccount1;TableEndpoint=http://MY-MACHINE-NAME.local:10002/devstoreaccount1;`
+- Install Azure Storage explorer and create your queues (see `./src/lib/jobs/index.ts` for `queueNames`). Azure Storage explorer can be used to view your queue items.
+- `yarn install`
+- `yarn dev`
+
+### Debugging
+Supports VSCode debugging via the debugger and utilisation of breakpoints. 
+This is only tested on Linux but may work on Windows. 
+If using Windows then use WSL with an Ubuntu distro for support of attaching the VS code debugger
+
+### Live urls
+You can expose your app locally to the internet via Ngrok to test your app before deploying.
+
+#### Setup
+1. Sign up for a Ngrok account
+2. Get your auth token
+3. `yarn ngrok config add-authtoken [auth token here]` replacing `[auth token]` with the auth token retrieved from your Ngrok dashboard
+
+#### Running
+1. `yarn start` OR start debugging in VSCode
+2. In separate terminal window run `yarn tunnel` and observe the log entry that starts with `Live url exposed`.
+3. Input the URL into your Seeka app configuration as the "Webook URL" via the Seeka UI.
+
+## Included sample functions
+### Seeka app webhook 
+`src/functions/seekaAppWebhook.ts`
+
+Handles inbound webhooks sent from Seeka to your app.
+
+### Queue example 
+`src/functions/queueExample.ts`
+
+Handles taking a message and placing it on an Azure storage queue for later processing. This concept can be used to offload long running operations based on data sent to your app from Seeka and can help to ensure Azure Function time execution limits are respected.
+
+### Polling example 
+`src/functions/pollingExample.ts`
+
+Handles scheduled invoking of a function. This concept can be used to "fan out" long running operations based on data sent to your app from Seeka and can help to ensure Azure Function time execution limits are respected by splitting long running operations into smaller, less time consuming parts.
+
+## Invoking functions
+### Development environment
+Scheduled / timer function: `curl -i -d '{"input": null}' -H "Content-Type: application/json" -X POST http://localhost:7072/admin/functions/pollingExample`
+
+### Azure cloud
+Scheduled / timer function: `curl -i -d '{"input": null}' -H "Content-Type: application/json" -H "x-functions-key: <key from azure portal>" -X POST https://seeka-app-example-name.azurewebsites.net/admin/functions/pollingExample`
+
+See [this doc](https://learn.microsoft.com/en-us/azure/azure-functions/functions-manually-run-non-http?tabs=azure-portal#get-the-master-key) on how to get the functions (master) key
+
+## Logging
+Centralised logging handled by [Winston](https://www.npmjs.com/package/winston). Winston is installed in this template and is also used in the Seeka SDK NPM packages.
+
+[Seq](https://datalust.co/seq) Winston transport is installed in this template (optional).
+
+To configure Seq options, see `_SEQ_` environment variables.
+
+To install Seq on your development machine
+1. Run `docker run --name seq -d --restart=always -e ACCEPT_EULA=Y -p 5341:80 datalust/seq:2024.2`
+2. Update your `LOGGING_SEQ_SERVERURL` environment variable to `http://localhost:5341` or `http://[YOUR MACHINE NAME].local:5341` if using WSL.
+
+If creating an API key for Seq, only permission that is required is `Ingest`.
+
+## State management
+Installations of your app and other state required for your app to function is stored in Redis. Another state provider can be swapped out for Redis, see `src/lib/state/seeka/installations.ts` for the file that manages the state of the installations.
+
+### Upstash (optional)
+If you dont want to use Upstash for Redis then the connection strings in `.env` can be swapped with your Redis instance. 
+
+> If using Upstash then create a database before following the below guide to deploying your AWS lambda function.
+
+> When choosing region - use a region that is closest to the Azure region that your function app is hosted in to reduce latency between the function and the Redis database. 
+
+## Deployment
+This project comes ready to deploy for free to Azure functions with database backed by Redis hosted by Upstash and queues, blobs and tables backed by Azure Storage.
+
+1. Create Azure function app via the portal with below settings
+    - Function app name: seeka-app-example-name
+    - Code or container image: Code
+    - Runtime stack: Node.js
+    - Version: 18 LTS
+    - Region: Closest region to where your upstash "master / write" database is located
+    - Operating system: linux
+    - Hosting: Consumption
+    - Enable public access: On
+2. Set environment variables of the Azure web app - reference local.settings.json "Values" 
+3. If your app receives calls directly from the browser (eg. your browser app plugin) then CORS needs to be enabled for all origins from within the settings of the Function app in Azure portal.
+3. `yarn deploy`
+
+### Continuous delivery
+This template includes a GitLab CD pipeline that can be used to trigger deployments of your app when changes are pushed to your Git repository.
+
+## References
+- https://learn.microsoft.com/en-us/azure/storage/common/storage-use-azurite
 - https://learn.microsoft.com/en-us/azure/storage/queues/storage-quickstart-queues-nodejs?tabs=connection-string%2Croles-azure-portal%2Cenvironment-variable-windows%2Csign-in-azure-cli

package/dist/{init-templates/azure-function → init-template/app/server-azure-function}/host.json

@@ -14,16 +14,7 @@
     "version": "[4.*, 5.0.0)"
   },
   "concurrency": {
-    "dynamicConcurrencyEnabled": false,
+    "dynamicConcurrencyEnabled": true,
     "snapshotPersistenceEnabled": true
-  },
-  "extensions": {
-    "queues": {
-      "maxPollingInterval": "00:00:15",
-      "visibilityTimeout": "00:01:00",
-      "batchSize": 32,
-      "maxDequeueCount": 2,
-      "messageEncoding": "base64"
-    }
   }
 }

package/dist/init-template/app/server-azure-function/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@seeka-app-example-name/server-azure-function",
+  "version": "2.0.7-rc.1",
+  "description": "Seeka example app with hosting on Azure serverless functions",
+  "author": "Seeka <platform@seeka.co>",
+  "license": "MIT",
+  "main": "dist/src/functions/*.js",
+  "private": true,
+  "engines": {
+    "node": ">=20"
+  },
+  "scripts": {
+    "lint": "eslint",
+    "build": "tsc",
+    "watch": "tsc -w",
+    "clean": "rimraf dist",
+    "prestart": "<packageManagerRunPrefix> clean && yarn build",
+    "dev": "func start --port 7072",
+    "tunnel": "node scripts/ngrok.js seeka-app-example-name-localdev",
+    "deploy": "yarn func azure functionapp publish seeka-app-example-name --no-build --javascript",
+    "dev:queue:create": "node scripts/dev-queue-setup.js sample-queue-name"
+  },
+  "dependencies": {
+    "@azure/functions": "^4.7.2",
+    "@azure/storage-queue": "^12.26.0",
+    "@datalust/winston-seq": "^2.0.0",
+    "@redis/client": "^5.1.0",
+    "@redis/json": "^5.1.0",
+    "@seeka-labs/sdk-apps-server": "2.0.7-rc.1",
+    "axios": "^1.9.0",
+    "lodash": "^4.17.21",
+    "redis": "^5.1.0",
+    "winston": "^3.17.0"
+  },
+  "devDependencies": {
+    "@jest/globals": "^29.7.0",
+    "@types/jest": "^29.5.14",
+    "@types/lodash": "^4.17.17",
+    "@types/lodash-es": "^4.17.12",
+    "@types/node": "^20",
+    "@typescript-eslint/eslint-plugin": "^8.32.1",
+    "@typescript-eslint/parser": "^8.32.1",
+    "azure-functions-core-tools": "*",
+    "eslint": "^9",
+    "jest": "^29.7.0",
+    "ngrok": "^5.0.0-beta.2",
+    "rimraf": "^6.0.1",
+    "ts-jest": "^29.3.4",
+    "typescript": "^5.8.3"
+  },
+  "stableVersion": "2.0.6"
+}