@seeka-labs/cli-apps 1.1.24 → 1.1.26

package/dist/init-templates/browser/tsconfig.json

@@ -1,35 +1,35 @@
-{
-  "compilerOptions": {
-    "allowJs": false,
-    "target": "ESNext",
-    "module": "ESNext",
-    "resolveJsonModule": true,
-    "moduleResolution": "node",
-    "noEmit": true,
-    "strict": true,
-    "noImplicitAny": false,
-    "strictNullChecks": true,
-    "strictFunctionTypes": true,
-    "noUnusedLocals": false,
-    "noUnusedParameters": false,
-    "noImplicitReturns": true,
-    "noFallthroughCasesInSwitch": true,
-    "importHelpers": true,
-    "skipLibCheck": true,
-    "esModuleInterop": true,
-    "allowSyntheticDefaultImports": true,
-    "experimentalDecorators": true,
-    "sourceMap": true,
-    "types": [
-      "node",
-      "jest"
-    ],
-    "lib": [
-      "ES6",
-      "DOM"
-    ]
-  },
-  "include": [
-    "src/browser.ts",
-  ]
+{
+  "compilerOptions": {
+    "allowJs": false,
+    "target": "ESNext",
+    "module": "ESNext",
+    "resolveJsonModule": true,
+    "moduleResolution": "node",
+    "noEmit": true,
+    "strict": true,
+    "noImplicitAny": false,
+    "strictNullChecks": true,
+    "strictFunctionTypes": true,
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "importHelpers": true,
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "experimentalDecorators": true,
+    "sourceMap": true,
+    "types": [
+      "node",
+      "jest"
+    ],
+    "lib": [
+      "ES6",
+      "DOM"
+    ]
+  },
+  "include": [
+    "src/browser.ts",
+  ]
 }

package/dist/init-templates/netlify-function/.env.example

@@ -1,18 +1,18 @@
-SEEKA_APP_ID=
-SEEKA_APP_SECRET=
-SEEKA_DEBUG_ENABLED=true
-SEEKA_INGEST_URL=
-SEEKA_ISSUER_URL=
-NODE_TLS_REJECT_UNAUTHORIZED=1
-NETLIFY_ENABLED=false
-NETLIFY_SITE_NAME=
-REDIS_CONNECTION_USER=default
-REDIS_CONNECTION_PASSWORD=
-REDIS_CONNECTION_TLS=true
-REDIS_CONNECTION_HOST=
-REDIS_CONNECTION_PORT=
-LOGGING_SEQ_SERVERURL=
-LOGGING_SEQ_APIKEY=
-LOGGING_LEVEL=silly
-ENCRYPTION_SECRET=
+SEEKA_APP_ID=
+SEEKA_APP_SECRET=
+SEEKA_DEBUG_ENABLED=true
+SEEKA_INGEST_URL=
+SEEKA_ISSUER_URL=
+NODE_TLS_REJECT_UNAUTHORIZED=1
+NETLIFY_ENABLED=false
+NETLIFY_SITE_NAME=
+REDIS_CONNECTION_USER=default
+REDIS_CONNECTION_PASSWORD=
+REDIS_CONNECTION_TLS=true
+REDIS_CONNECTION_HOST=
+REDIS_CONNECTION_PORT=
+LOGGING_SEQ_SERVERURL=
+LOGGING_SEQ_APIKEY=
+LOGGING_LEVEL=silly
+ENCRYPTION_SECRET=
 INBOUND_HTTP_CALL_API_KEY=

package/dist/init-templates/netlify-function/.example.gitignore

@@ -1,36 +1,36 @@
-# Local Netlify folder
-.netlify
-.env
-
-# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
-
-# dependencies
-/node_modules
-/.pnp
-.pnp.js
-.yarn/install-state.gz
-
-# testing
-/coverage
-
-# production
-/build
-/dist
-
-# misc
-.DS_Store
-*.pem
-
-# debug
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-
-# local env files
-.env*.local
-
-# vercel
-.vercel
-
-# typescript
-*.tsbuildinfo
+# Local Netlify folder
+.netlify
+.env
+
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+.yarn/install-state.gz
+
+# testing
+/coverage
+
+# production
+/build
+/dist
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env*.local
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo

package/dist/init-templates/netlify-function/.nvmrc

@@ -1 +1 @@
-v18
+v20

package/dist/init-templates/netlify-function/.vscode/launch.json

@@ -1,45 +1,45 @@
-{
-  "version": "0.2.0",
-  "configurations": [
-    {
-      "name": "netlify dev",
-      "type": "node",
-      "request": "launch",
-      "skipFiles": [
-        "<node_internals>/**"
-      ],
-      "outFiles": [
-        "${workspaceFolder}/.netlify/functions-serve/**/*.js"
-      ],
-      "program": "${workspaceFolder}/node_modules/.bin/netlify",
-      "args": [
-        "dev"
-      ],
-      "console": "integratedTerminal",
-      "env": {
-        "BROWSER": "none"
-      },
-      "serverReadyAction": {
-        "pattern": "Server now ready on (https?://[\\w:.-]+)",
-        "uriFormat": "%s",
-        "action": "debugWithChrome"
-      }
-    },
-    {
-      "name": "netlify functions:serve",
-      "type": "node",
-      "request": "launch",
-      "skipFiles": [
-        "<node_internals>/**"
-      ],
-      "outFiles": [
-        "${workspaceFolder}/.netlify/functions-serve/**/*.js"
-      ],
-      "program": "${workspaceFolder}/node_modules/.bin/netlify",
-      "args": [
-        "functions:serve"
-      ],
-      "console": "integratedTerminal"
-    }
-  ]
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "netlify dev",
+      "type": "node",
+      "request": "launch",
+      "skipFiles": [
+        "<node_internals>/**"
+      ],
+      "outFiles": [
+        "${workspaceFolder}/.netlify/functions-serve/**/*.js"
+      ],
+      "program": "${workspaceFolder}/node_modules/.bin/netlify",
+      "args": [
+        "dev"
+      ],
+      "console": "integratedTerminal",
+      "env": {
+        "BROWSER": "none"
+      },
+      "serverReadyAction": {
+        "pattern": "Server now ready on (https?://[\\w:.-]+)",
+        "uriFormat": "%s",
+        "action": "debugWithChrome"
+      }
+    },
+    {
+      "name": "netlify functions:serve",
+      "type": "node",
+      "request": "launch",
+      "skipFiles": [
+        "<node_internals>/**"
+      ],
+      "outFiles": [
+        "${workspaceFolder}/.netlify/functions-serve/**/*.js"
+      ],
+      "program": "${workspaceFolder}/node_modules/.bin/netlify",
+      "args": [
+        "functions:serve"
+      ],
+      "console": "integratedTerminal"
+    }
+  ]
 }

package/dist/init-templates/netlify-function/README.md

@@ -1,62 +1,62 @@
-# Seeka app - Netlify functions
-
-## Development
-
-- `yarn install`
-- `yarn dev`
-
-### Dependencies
-- Python >=3.6.0 - https://www.python.org/downloads/ or `choco install python`
-
-### Invoking functions
-Run `yarn dev:netlify:invoke:polling-example-job-scheduled` to trigger scheduled job which triggers multiple background jobs, 1 for each installation of the app
-
-### Debugging / local development before deployment
-- This template uses [Netlify's live url debugging](https://answers.netlify.com/t/netlify-dev-with-support-for-custom-live-urls/101261)
-- Supports VSCode debugging - See `.vscode/launch.json`. This is only supported on Linux. If using Windows then use WSL with an Ubuntu distro for support of attaching the VS code debugger
-
-## 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 Netlify function.
-
-> When choosing region - use US East (Ohio) - us-east-* as this is the same AWS region that the free Netlify functions run from. If not on the Netlify free plan, select the closest Upstash region that your Netlify function is hosted in to reduce latency between the function and the Redis database. 
-
-> Considerations - max connection limit (1000) of Upstash connections in relation to concurrent execution count of the Netlify functions
-
-## Deployment
-This project comes ready to deploy for free to Netlify with a database and queues backed by Redis hosted by Upstash. 
-
-At the point of writing, Netlify and Upstash can be used to deploy your app for free.
-- https://upstash.com/pricing
-- https://www.netlify.com/pricing/
-
-### Deployment to Netlify
-#### From your local machine
-- `yarn deploy`
-
-#### Using Netlify continuous delivery
-See the [Netlify docs](https://docs.netlify.com/functions/deploy/?fn-language=ts)
-
-## Considerations when using this template
-Each call to the netlify function will create a new connection to the database/Redis as calls to the Netlify function in quick succession will not share a single "warm" function host which is supported by Azure Functions and AWS Lambda.
-
-## References
-- https://docs.netlify.com/cli/get-started/
+# Seeka app - Netlify functions
+
+## Development
+
+- `yarn install`
+- `yarn dev`
+
+### Dependencies
+- Python >=3.6.0 - https://www.python.org/downloads/ or `choco install python`
+
+### Invoking functions
+Run `yarn dev:netlify:invoke:polling-example-job-scheduled` to trigger scheduled job which triggers multiple background jobs, 1 for each installation of the app
+
+### Debugging / local development before deployment
+- This template uses [Netlify's live url debugging](https://answers.netlify.com/t/netlify-dev-with-support-for-custom-live-urls/101261)
+- Supports VSCode debugging - See `.vscode/launch.json`. This is only supported on Linux. If using Windows then use WSL with an Ubuntu distro for support of attaching the VS code debugger
+
+## 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 Netlify function.
+
+> When choosing region - use US East (Ohio) - us-east-* as this is the same AWS region that the free Netlify functions run from. If not on the Netlify free plan, select the closest Upstash region that your Netlify function is hosted in to reduce latency between the function and the Redis database. 
+
+> Considerations - max connection limit (1000) of Upstash connections in relation to concurrent execution count of the Netlify functions
+
+## Deployment
+This project comes ready to deploy for free to Netlify with a database and queues backed by Redis hosted by Upstash. 
+
+At the point of writing, Netlify and Upstash can be used to deploy your app for free.
+- https://upstash.com/pricing
+- https://www.netlify.com/pricing/
+
+### Deployment to Netlify
+#### From your local machine
+- `yarn deploy`
+
+#### Using Netlify continuous delivery
+See the [Netlify docs](https://docs.netlify.com/functions/deploy/?fn-language=ts)
+
+## Considerations when using this template
+Each call to the netlify function will create a new connection to the database/Redis as calls to the Netlify function in quick succession will not share a single "warm" function host which is supported by Azure Functions and AWS Lambda.
+
+## References
+- https://docs.netlify.com/cli/get-started/
 - https://docs.netlify.com/functions/get-started/?fn-language=ts

package/dist/init-templates/netlify-function/jest.config.js

@@ -1,5 +1,5 @@
-/** @type {import('ts-jest').JestConfigWithTsJest} */
-module.exports = {
-    preset: 'ts-jest',
-    testEnvironment: 'node',
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+    preset: 'ts-jest',
+    testEnvironment: 'node',
 };

package/dist/init-templates/netlify-function/netlify.toml

@@ -1,7 +1,7 @@
-[functions]
-  directory = "src/api"
-  node_bundler = "esbuild"
-
-[dev]
-  command = "yarn dev"
+[functions]
+  directory = "src/api"
+  node_bundler = "esbuild"
+
+[dev]
+  command = "yarn dev"
   port = 8888

package/dist/init-templates/netlify-function/package.json

@@ -7,7 +7,7 @@
   "type": "module",
   "private": true,
   "engines": {
-    "node": ">=18.14.0"
+    "node": ">=20"
   },
   "scripts": {
     "dev:invoke:example-scheduled-job": "netlify functions:invoke --name polling-example-job-scheduled --port 8888 --identity",
@@ -19,24 +19,21 @@
   },
   "dependencies": {
     "@datalust/winston-seq": "^2.0.0",
-    "@netlify/functions": "^2.5.1",
-    "@seeka-labs/sdk-apps-server": "^1.1.7",
-    "axios": "^1.6.7",
+    "@netlify/functions": "^2.8.2",
+    "@seeka-labs/sdk-apps-server": "^1.1.24",
     "lodash-es": "^4.17.21",
-    "openid-client": "^5.6.4",
-    "redis": "^4.6.12",
-    "winston": "^3.11.0"
+    "redis": "^4.7.0"
   },
   "devDependencies": {
     "@jest/globals": "^29.7.0",
     "@types/lodash-es": "^4.17.12",
-    "@types/node": "^18",
-    "@typescript-eslint/eslint-plugin": "^6.19.1",
-    "@typescript-eslint/parser": "^6.19.1",
-    "eslint": "^8",
+    "@types/node": "^20",
+    "@typescript-eslint/eslint-plugin": "^8.17.0",
+    "@typescript-eslint/parser": "^8.17.0",
+    "eslint": "^9",
     "jest": "^29.7.0",
-    "ts-jest": "^29.1.5",
-    "netlify-cli": "^17.15.3",
-    "typescript": "^5.4.2"
+    "ts-jest": "^29.2.5",
+    "netlify-cli": "^17.38.0",
+    "typescript": "^5.7.2"
   }
 }

package/dist/init-templates/netlify-function/src/api/example-job-background/index.ts

@@ -1,52 +1,52 @@
-import winston, { Logger } from 'winston';
-
-import {
-    apiKeyHeaderName, BackgroundJobRequestContext, jobNames, signatureHeaderName, validateApiKey,
-    validateSignature
-} from '@/lib/jobs';
-import { backgroundJobLogger } from '@/lib/logging';
-import { startServices, stopServices } from '@/lib/services';
-
-import type { Config, Context } from "@netlify/functions"
-export default async (req: Request, context: Context) => {
-    if (req.method != "POST") {
-        return new Response("Method not allowed", { status: 405 });
-    }
-
-    const bodyStr = await req.text();
-    const body = JSON.parse(bodyStr) as BackgroundJobRequestContext;
-    const logger = backgroundJobLogger(jobNames.exampleBackgroundJob, body, context);
-    logger.profile(`job.${jobNames.exampleBackgroundJob}`)
-
-    await startServices(logger);
-
-    if (process.env.SEEKA_DEBUG_ENABLED === 'true') {
-        logger.debug('Received request to trigger background job', { body, headers: req.headers });
-    }
-    else {
-        logger.verbose('Received request to trigger background job', { body });
-    }
-
-    try {
-        // Verify request
-        validateApiKey(req.headers.get(apiKeyHeaderName) as string, logger);
-        validateSignature(req.headers.get(signatureHeaderName) as string, bodyStr, logger);
-
-        // Execute
-        await doWork(body, logger);
-
-        // Close db connections
-        await stopServices(logger);
-    }
-    catch (err) {
-        logger.error('Error executing background job', { ex: winston.exceptions.getAllInfo(err) })
-    }
-
-    logger.profile(`job.${jobNames.exampleBackgroundJob}`)
-
-    return new Response(undefined, { status: 202 })
-}
-
-const doWork = async (context: BackgroundJobRequestContext, logger: Logger) => {
-    logger.debug('Ran background job')
+import winston, { Logger } from 'winston';
+
+import {
+    apiKeyHeaderName, BackgroundJobRequestContext, jobNames, signatureHeaderName, validateApiKey,
+    validateSignature
+} from '@/lib/jobs';
+import { backgroundJobLogger } from '@/lib/logging';
+import { startServices, stopServices } from '@/lib/services';
+
+import type { Config, Context } from "@netlify/functions"
+export default async (req: Request, context: Context) => {
+    if (req.method != "POST") {
+        return new Response("Method not allowed", { status: 405 });
+    }
+
+    const bodyStr = await req.text();
+    const body = JSON.parse(bodyStr) as BackgroundJobRequestContext;
+    const logger = backgroundJobLogger(jobNames.exampleBackgroundJob, body, context);
+    logger.profile(`job.${jobNames.exampleBackgroundJob}`)
+
+    await startServices(logger);
+
+    if (process.env.SEEKA_DEBUG_ENABLED === 'true') {
+        logger.debug('Received request to trigger background job', { body, headers: req.headers });
+    }
+    else {
+        logger.verbose('Received request to trigger background job', { body });
+    }
+
+    try {
+        // Verify request
+        validateApiKey(req.headers.get(apiKeyHeaderName) as string, logger);
+        validateSignature(req.headers.get(signatureHeaderName) as string, bodyStr, logger);
+
+        // Execute
+        await doWork(body, logger);
+
+        // Close db connections
+        await stopServices(logger);
+    }
+    catch (err) {
+        logger.error('Error executing background job', { ex: winston.exceptions.getAllInfo(err) })
+    }
+
+    logger.profile(`job.${jobNames.exampleBackgroundJob}`)
+
+    return new Response(undefined, { status: 202 })
+}
+
+const doWork = async (context: BackgroundJobRequestContext, logger: Logger) => {
+    logger.debug('Ran background job')
 }