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

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

@@ -1,18 +0,0 @@
-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 +0,0 @@
-# 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 +0,0 @@
-v20

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

@@ -1,45 +0,0 @@
-{
-  "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 +0,0 @@
-# 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 +0,0 @@
-/** @type {import('ts-jest').JestConfigWithTsJest} */
-module.exports = {
-    preset: 'ts-jest',
-    testEnvironment: 'node',
-};

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

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

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

@@ -1,39 +0,0 @@
-{
-  "name": "seeka-app-example-name",
-  "version": "0.0.1",
-  "description": "Seeka example app for hosting on Netlify functions",
-  "author": "Seeka <platform@seeka.co>",
-  "license": "MIT",
-  "type": "module",
-  "private": true,
-  "engines": {
-    "node": ">=20"
-  },
-  "scripts": {
-    "dev:invoke:example-scheduled-job": "netlify functions:invoke --name polling-example-job-scheduled --port 8888 --identity",
-    "lint": "eslint",
-    "test": "yarn jest",
-    "dev": "netlify dev --live=localdev --port 8888 --no-open",
-    "build": "netlify functions:build --functions=dist --src=src/api",
-    "deploy": "netlify deploy --build --skip-functions-cache --prod"
-  },
-  "dependencies": {
-    "@datalust/winston-seq": "^2.0.0",
-    "@netlify/functions": "^3.0.0",
-    "@seeka-labs/sdk-apps-server": "^1.1.26",
-    "lodash-es": "^4.17.21",
-    "redis": "^4.7.0"
-  },
-  "devDependencies": {
-    "@jest/globals": "^29.7.0",
-    "@types/lodash-es": "^4.17.12",
-    "@types/node": "^20",
-    "@typescript-eslint/eslint-plugin": "^8.22.0",
-    "@typescript-eslint/parser": "^8.22.0",
-    "eslint": "^9",
-    "jest": "^29.7.0",
-    "ts-jest": "^29.2.5",
-    "netlify-cli": "^18.0.3",
-    "typescript": "^5.7.3"
-  }
-}

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

@@ -1,52 +0,0 @@
-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')
-}

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

@@ -1,46 +0,0 @@
-import winston from 'winston';
-
-import { jobNames, triggerBackgroundJob } from '@/lib/jobs';
-import { backgroundJobLogger } from '@/lib/logging';
-import { startServices, stopServices } from '@/lib/services';
-import { listInstallations } from '@/lib/state/seeka/installations';
-
-import type { Config, Context } from "@netlify/functions"
-export const config: Config = {
-    schedule: "@hourly"
-}
-
-export default async (req: Request, context: Context) => {
-    const { next_run } = (await req.json()) as { next_run: string }
-
-    const logger = backgroundJobLogger(jobNames.examplePollingScheduledJob, undefined, context);
-
-    logger.profile(`job.${jobNames.examplePollingScheduledJob}`)
-    if (process.env.SEEKA_DEBUG_ENABLED === 'true') {
-        logger.debug('Received request to trigger scheduled job', { headers: req.headers, next_run });
-    }
-    else {
-        logger.verbose('Received request to trigger scheduled job', { next_run });
-    }
-
-    await startServices(logger);
-
-    const allInstallations = await listInstallations(logger);
-    logger.verbose(`Triggering background job for ${allInstallations.length} installations`, { allInstallations })
-
-    // Close db connections
-    await stopServices(logger);
-
-    const promises = allInstallations.map(installation => triggerBackgroundJob(jobNames.exampleBackgroundJob, installation, logger))
-
-    try {
-        await Promise.all(promises);
-    }
-    catch (err) {
-        logger.error('Error triggering background jobs', { ex: winston.exceptions.getAllInfo(err) })
-    }
-
-    logger.profile(`job.${jobNames.examplePollingScheduledJob}`)
-
-    return new Response(undefined, { status: 202 })
-}

package/dist/init-templates/netlify-function/src/api/seeka-app-webhook/index.ts

@@ -1,217 +0,0 @@
-
-import type { Logger } from 'winston';
-
-import winston from 'winston';
-
-import { jobNames, triggerBackgroundJob } from '@/lib/jobs';
-import { webhookLogger } from '@/lib/logging';
-import { startServices, stopServices } from '@/lib/services';
-import {
-    createOrUpdateInstallation, deleteInstallation, SampleAppInstallSettings, SeekaAppInstallState, tryGetInstallation
-} from '@/lib/state/seeka/installations';
-import {
-    PersonIdentifiers, SeekaActivityAcceptedWebhookPayload, SeekaAppInstalledWebhookPayload,
-    SeekaAppInstallSettingsUpdatedWebhookPayload, SeekaAppUninstalledWebhookPayload,
-    SeekaIdentityChangedWebhookPayload, SeekaWebhookCallType, SeekaWebhookPayload,
-    throwOnInvalidWebhookSignature
-} from '@seeka-labs/sdk-apps-server';
-
-import type { Config, Context } from "@netlify/functions"
-export const config: Config = {
-    path: "/api/webhook/seeka/app",
-    method: "POST"
-};
-
-export default async (req: Request, context: Context) => {
-    const bodyStr = (await req.text()) as string;
-    const body = JSON.parse(bodyStr) as SeekaWebhookPayload;
-
-    const logger = webhookLogger(body, context);
-    logger.profile('http.seeka.webhook.app')
-    logger.verbose('Received webhook from Seeka', { body });
-
-    // Handle probe
-    if (body.type === SeekaWebhookCallType.Probe) {
-        return new Response(undefined, { status: 204 })
-    }
-
-    // Validate webhook
-    try {
-        throwOnInvalidWebhookSignature(process.env.SEEKA_APP_SECRET as string, req.headers, bodyStr);
-        logger.debug('Webhook signature validated', { body });
-    }
-    catch {
-        logger.warn('Webhook signature invalid', { body });
-        return new Response(JSON.stringify({ error: "Webhook call invalid" }), { status: 401 })
-    }
-
-    if (body.isTest) {
-        // This is a test webhook call
-        return new Response(undefined, { status: 204 })
-    }
-
-    await startServices(logger);
-
-    // Check if the webhook is for an app we have installed
-    let installation: SeekaAppInstallState | null = null;
-    if (body.type != SeekaWebhookCallType.AppInstalled) {
-        installation = await tryGetInstallation((body as SeekaAppInstalledWebhookPayload).context?.applicationInstallId as string, false, logger);
-        if (installation == null) {
-            logger.warn('Webhook call cannot be processed as the installation ID is not known by this app', { body });
-
-            // Close db connections
-            await stopServices(logger);
-
-            return new Response(JSON.stringify({ error: "App not installed" }), { status: 422 })
-        }
-    }
-
-    // Do something
-    let errorMessage: string | null = null;
-    try {
-        switch (body.type) {
-            case SeekaWebhookCallType.AppInstalled:
-                {
-                    errorMessage = await onInstallation(body as SeekaAppInstalledWebhookPayload, logger);
-                    break;
-                }
-            case SeekaWebhookCallType.AppInstallSettingsUpdated:
-                {
-                    errorMessage = await onInstallationSettingsUpdate(body as SeekaAppInstallSettingsUpdatedWebhookPayload, logger);
-                    break;
-                }
-            case SeekaWebhookCallType.AppUninstalled:
-                {
-                    if (!body.isTest) {
-                        const payload = body as SeekaAppUninstalledWebhookPayload;
-                        await deleteInstallation(payload.context?.applicationInstallId as string, logger) // TODO: remove cast
-                    }
-                    break;
-                }
-            case SeekaWebhookCallType.ActivityAccepted:
-                {
-                    const payload = body as SeekaActivityAcceptedWebhookPayload;
-                    await handleSeekaActivity(payload, logger);
-
-                    break;
-                }
-            case SeekaWebhookCallType.IdentityChanged:
-                {
-                    const payload = body as SeekaIdentityChangedWebhookPayload;
-                    logger.debug('Identity changed', { payload });
-
-                    break;
-                }
-        }
-    }
-    catch (err) {
-        logger.error('Failed to handle webhook', { ex: winston.exceptions.getAllInfo(err) });
-        return new Response(JSON.stringify({ error: "Request failed" }), { status: 500 })
-    }
-    finally {
-        // Close db connections
-        await stopServices(logger);
-        logger.profile('http.seeka.webhook.app')
-        logger.verbose('Seeka webhook handled');
-    }
-
-    if (errorMessage) {
-        logger.warn('Webhook call failed', { errorMessage });
-        return Response.json({ error: { message: errorMessage } }, { status: 400 });
-    }
-
-    return new Response(undefined, { status: 204 })
-}
-
-const validateInstallationSettings = async (installSettings: SampleAppInstallSettings, logger: Logger): Promise<string | null> => {
-    // Returning an error message string here will block the installation request or settings update request by the user installing the app
-
-
-    return null;
-}
-
-const onInstallation = async (payload: SeekaAppInstalledWebhookPayload, logger: Logger): Promise<string | null> => {
-    if (payload.isTest) return null;
-
-    const errorMessage = await validateInstallationSettings(payload.content?.installationSettings || {}, logger);
-    if (errorMessage) return errorMessage;
-
-    const installation = await createOrUpdateInstallation({
-        ...payload.context,
-        installationState: {
-            grantedPermissions: payload.content?.grantedPermissions || []
-        },
-        applicationInstallId: payload.context?.applicationInstallId as string,
-        organisationBrandId: payload.context?.organisationBrandId as string,
-        organisationId: payload.context?.organisationId as string,
-        installedAt: new Date().toISOString(),
-        installationSettings: payload.content?.installationSettings || {}
-    }, logger)
-
-    // Trigger a sync for the installation
-    try {
-        await triggerBackgroundJob(jobNames.exampleBackgroundJob, {
-            ...payload.context
-        }, logger)
-    }
-    catch (err) {
-        await deleteInstallation(installation.applicationInstallId, logger)
-        return 'Failed to complete install';
-    }
-
-    return null;
-}
-
-const onInstallationSettingsUpdate = async (payload: SeekaAppInstallSettingsUpdatedWebhookPayload, logger: Logger): Promise<string | null> => {
-    if (payload.isTest) return null;
-
-    const errorMessage = await validateInstallationSettings(payload.content?.installationSettings || {}, logger);
-    if (errorMessage) return errorMessage;
-
-    const existingInstallation = await tryGetInstallation(payload.context?.applicationInstallId as string, true, logger) as SeekaAppInstallState;
-
-    // Update settings
-    const installation = await createOrUpdateInstallation({
-        ...payload.context,
-        ...existingInstallation,
-        installationState: {
-            ...existingInstallation.installationState,
-            grantedPermissions: payload.content?.grantedPermissions || []
-        },
-        installationSettings: payload.content?.installationSettings || {}
-    } as any, logger) // TODO: remove any
-
-    logger.info('Settings updated')
-
-    return null;
-}
-
-const handleSeekaActivity = async (activity: SeekaActivityAcceptedWebhookPayload, logger: Logger) => {
-    // const context = activity.context as SeekaAppWebhookContext;
-    // const helper = SeekaAppHelper.create(process.env['SEEKA_APP_SECRET'] as string, {
-    //     organisationId: context.organisationId as string,
-    //     applicationInstallId: context.applicationInstallId as string,
-    //     applicationId: process.env['SEEKA_APP_ID'] as string,
-    // }, { name, version }, logger);
-
-    // // Append a first name to the identity
-    // await helper.api.mergeIdentity({
-    //     seekaPId: activity.content?.personId,
-    //     firstName: [
-    //         'firstname_' + new Date().getTime()
-    //     ]
-    // }, {
-    //     method: 'toremove',
-    //     origin: TrackingEventSourceOriginType.Server
-    // })
-
-    // // Fire off a tracking event
-    // await helper.api.trackActivity({
-    //     activityName: TrackingActivityNames.Custom,
-    //     activityNameCustom: 'seeka-app-activity-accepted',
-    //     activityId: 'act' + new Date().getTime(),
-    // }, activity.content?.personId as string, {
-    //     method: 'toremove',
-    //     origin: TrackingEventSourceOriginType.Server
-    // })
-}

package/dist/init-templates/netlify-function/src/index.test.ts

@@ -1,7 +0,0 @@
-import { describe, expect, test } from '@jest/globals';
-
-describe('test example module', () => {
-    test('should be false', () => {
-        expect(false).toBeFalsy();
-    });
-});

package/dist/init-templates/netlify-function/src/lib/jobs/index.ts

@@ -1,68 +0,0 @@
-import * as crypto from 'crypto';
-import { trimEnd } from 'lodash-es';
-
-import type { Logger } from 'winston';
-export interface BackgroundJobRequestContext {
-    organisationId?: string;
-    organisationBrandId?: string;
-    applicationInstallId?: string;
-}
-
-export const signatureHeaderName = 'x-signature-hmac';
-export const apiKeyHeaderName = 'x-api-key';
-
-export const jobNames = {
-    exampleBackgroundJob: 'example-job-background',
-    examplePollingScheduledJob: 'polling-example-job-scheduled',
-}
-
-export const validateApiKey = (apiKey: string, logger: Logger) => {
-    if (!apiKey || apiKey != process.env.INBOUND_HTTP_CALL_API_KEY) {
-        logger.error('Failed to validate API key');
-        throw new Error('Invalid API key');
-    }
-
-    logger.verbose('Validated API key')
-}
-
-export const validateSignature = (signature: string, payload: string, logger: Logger) => {
-    const digest = createSignature(payload)
-
-    if (!signature || signature != digest) {
-        logger.error('Invalid webhook signature');
-        throw new Error('Invalid signature');
-    }
-
-    logger.verbose('Validated signature');
-}
-
-export const triggerBackgroundJob = async (jobName: string, context: BackgroundJobRequestContext, logger: Logger): Promise<void> => {
-    const body = {
-        ...context
-    }
-    const bodyStr = JSON.stringify(body);
-
-    const response = await fetch(`${trimEnd(process.env.URL, '/')}/.netlify/functions/${jobName}`, {
-        method: 'POST',
-        body: bodyStr,
-        headers: {
-            [apiKeyHeaderName]: process.env.INBOUND_HTTP_CALL_API_KEY as string,
-            [signatureHeaderName]: createSignature(bodyStr),
-            'Content-Type': 'application/json',
-        },
-    })
-
-    if (!response.ok) {
-        const { status, statusText, url, type, headers } = response;
-        logger.error("Failed to trigger background job", { status, statusText, body: await response.text(), url, type, headers })
-        throw new Error(`Failed to trigger background job: ${response.statusText}`);
-    }
-}
-
-export const createSignature = (payload: string) => {
-    const hmac = crypto.createHmac('sha256', process.env.ENCRYPTION_SECRET as string);
-    hmac.update(payload);
-    const digest = hmac.digest('hex');
-
-    return digest;
-}