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

package/dist/init-templates/aws-lambda/.example.gitignore

@@ -1,49 +0,0 @@
-bin
-obj
-csx
-.vs
-edge
-Publish
-deploy.zip
-
-*.user
-*.suo
-*.cscfg
-*.Cache
-project.lock.json
-
-/packages
-/TestResults
-
-/tools/NuGet.exe
-/App_Data
-/secrets
-/data
-.secrets
-appsettings.json
-local.settings.json
-
-node_modules
-dist
-
-# Local python packages
-.python_packages/
-
-# Python Environments
-.env
-.venv
-env/
-venv/
-ENV/
-env.bak/
-venv.bak/
-
-# Byte-compiled / optimized / DLL files
-__pycache__/
-*.py[cod]
-*$py.class
-
-# Azurite artifacts
-__blobstorage__
-__queuestorage__
-__azurite_db*__.json

package/dist/init-templates/aws-lambda/.gitlab-ci.yml

@@ -1,39 +0,0 @@
-stages:
-- deploy
-
-variables:
-  LAMBDA_FUNC_RESOURCE_NAME: seeka-app-example-name
-  CI_DEBUG_TRACE: "true"
-
-workflow:
-  rules:
-  - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
-    when: never
-  - if: '$CI_COMMIT_BRANCH == "main" && ($CI_PIPELINE_SOURCE == "push" || $CI_PIPELINE_SOURCE == "web")'
-    when: always
-  - if: '$CI_COMMIT_BRANCH == "staging" && ($CI_PIPELINE_SOURCE == "push" || $CI_PIPELINE_SOURCE == "web")'
-    when: always
-
-deploy:
-  stage: deploy
-  image: node:20
-  environment:
-    name: $HOSTING_REGION_NAME/$HOSTING_ENV_NAME/apps
-  before_script:
-  - echo "installing aws cli"
-  - curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip"
-  - unzip awscliv2.zip
-  - ./aws/install --bin-dir /usr/local/bin --install-dir /usr/local/aws-cli --update
-  - ls -l /usr/local/bin/aws
-  - aws --version
-  - echo "using environment variables AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and AWS_DEFAULT_REGION for accessing the AWS CLI"
-  - echo "installing zip"
-  - apt-get update
-  - apt-get install zip
-  script:
-  - echo "deploying AWS lambda func $LAMBDA_FUNC_RESOURCE_NAME from branch $CI_COMMIT_BRANCH"
-  - yarn install --production=false
-  - yarn deploy
-  only:
-  - main
-  - staging

package/dist/init-templates/aws-lambda/.nvmrc

@@ -1 +0,0 @@
-v20

package/dist/init-templates/aws-lambda/.vscode/extensions.json

@@ -1,5 +0,0 @@
-{
-    "recommendations": [
-        "dbaeumer.vscode-eslint"
-    ]
-}

package/dist/init-templates/aws-lambda/.vscode/launch.json

@@ -1,20 +0,0 @@
-{
-  "version": "0.2.0",
-  "configurations": [
-    {
-      "name": "Debug Seeka app",
-      "type": "node",
-      "request": "attach",
-      "restart": true,
-      "port": 5858,
-      "outFiles": [],
-      "sourceMaps": true,
-      "resolveSourceMapLocations": [
-        "${workspaceFolder}/**",
-        "!**/node_modules/**",
-        "node_modules/@seeka-labs/**/*.js",
-      ],
-      "preLaunchTask": "yarn watch and debug",
-    },
-  ]
-}

package/dist/init-templates/aws-lambda/.vscode/settings.json

@@ -1,3 +0,0 @@
-{
-    "debug.internalConsoleOptions": "neverOpen"
-}

package/dist/init-templates/aws-lambda/.vscode/tasks.json

@@ -1,12 +0,0 @@
-{
-  "version": "2.0.0",
-  "tasks": [
-    {
-      "type": "shell",
-      "label": "yarn watch and debug",
-      "command": "yarn run watch:debug",
-      "problemMatcher": "$tsc",
-      "isBackground": true
-    }
-  ]
-}

package/dist/init-templates/aws-lambda/README.md

@@ -1,77 +0,0 @@
-# Seeka app - AWS lambda
-
-## Development
-- `yarn install`
-- `yarn watch:debug` or use VsCode debugging for "Debug Seeka App" configuration
-
-### Debugging
-Supports VSCode debugging via the debugger and utilisation of breakpoints. 
-Use "Debug Seeka App" configuration to compile, watch and start app.
-This is only tested on Linux but may work on Windows. 
-If using Windows, WSL coupled with an Ubuntu distro will provide support for 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.
-
-## 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 you can swap out the connection strings with your Redis instance. 
-
-> If using Upstash then create a database before following the below guide to deploying your AWS lambda function.
-
-> When choosing a region, consider the AWS region that the lambda function is running from to reduce latency between the function and the Redis database. 
-
-## Deployment
-1. [Install the aws lambda CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html#getting-started-install-instructions)
-1. Create a function via the AWS console with following settings
-    - Mode: Author from scratch
-    - function name: `seeka-app-example-name`
-    - runtime: `Node.js 18.x`
-    - architecture: `arm64`
-    - Advanced settings:
-        - Enable code signing: unchecked
-        - Enable function URL: checked
-        - Auth type: `NONE` - Calls to your function from Seeka will be verified by SHA256 signatures
-        - Invoke mode: Buffered
-        - Configure cross-origin resource sharing: unchecked
-        - Enable VPC: unchecked
-    - All other settings leave as defaults
-3. Add environment variables to the function in AWS by clicking 'Configuration' and then 'Environment varables'. Use the `.env` file in this project as a reference to what variables are required by to be set in the AWS Lambda.
-4. [Authenticate the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-authentication-short-term.html)
-2. `yarn deploy`
-
-    > At this point you may wish to [configure concurrency](https://docs.aws.amazon.com/lambda/latest/dg/scaling-behavior.html) of the AWS lambda function depending on the amount of concurrent requests you forecast your function handling.
-
-6. Update your `Webhook URL` in you Seeka app configuration to point to the AWS Lambda function URL. This URL can be found in your viewing your Lambda via the AWS console and copying the "Function URL". It should look something like `https://prragnghaaupodlqte6hkvo446acc.lambda-url.ap-southeast-2.on.aws/`. Ensure to append `api/webhook/seeka/app` onto this URL so the complete example to update your Seeka app configuration with will look like `https://prragnghaaupodlqte6hkvo446acc.lambda-url.ap-southeast-2.on.aws/api/webhook/seeka/app`
-
-### 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://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/index.html#available-commands

package/dist/init-templates/aws-lambda/jest.config.js

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

package/dist/init-templates/aws-lambda/package.json

@@ -1,53 +0,0 @@
-{
-  "name": "seeka-app-example-name",
-  "version": "0.0.1",
-  "description": "Seeka example app for hosting on AWS lambda functions",
-  "author": "Seeka <platform@seeka.co>",
-  "license": "MIT",
-  "main": "./index.js",
-  "private": true,
-  "engines": {
-    "node": ">=20"
-  },
-  "scripts": {
-    "lint": "eslint",
-    "build": "esbuild src/index.ts --bundle --minify --sourcemap --platform=node --target=node18 --outfile=dist/index.js",
-    "watch": "tsc -w",
-    "test": "yarn jest",
-    "clean": "<packageManagerRunPrefix> rimraf dist && <packageManagerRunPrefix> rimraf deploy.zip",
-    "start": "node --require dotenv/config dist/index.js",
-    "dev": "<packageManagerRunPrefix> clean && <packageManagerRunPrefix> build && node --require dotenv/config dist/index.js",
-    "tunnel": "node scripts/ngrok.js seeka-app-example-name-localdev",
-    "build:aws": "<packageManagerRunPrefix> clean && <packageManagerRunPrefix> build && cd dist && zip -r ../deploy.zip . && cd ..",
-    "deploy": "<packageManagerRunPrefix> build:aws && aws lambda update-function-code --function-name seeka-app-example-name --zip-file fileb://deploy.zip && rm deploy.zip",
-    "watch:debug": "nodemon --inspect=5858 -e ts --exec node -r ts-node/register --require dotenv/config ./src/index.ts"
-  },
-  "dependencies": {
-    "@datalust/winston-seq": "^2.0.0",
-    "@seeka-labs/sdk-apps-server": "^1.1.26",
-    "express": "^4.21.2",
-    "lodash-es": "^4.17.21",
-    "redis": "^4.7.0",
-    "serverless-http": "^3.2.0",
-    "winston": "^3.17.0"
-  },
-  "devDependencies": {
-    "@jest/globals": "^29.7.0",
-    "@types/aws-lambda": "^8.10.147",
-    "@types/express": "^5.0.0",
-    "@types/lodash-es": "^4.17.12",
-    "@types/node": "^20",
-    "@typescript-eslint/eslint-plugin": "^8.22.0",
-    "@typescript-eslint/parser": "^8.22.0",
-    "dotenv": "^16.4.7",
-    "esbuild": "^0.24.2",
-    "eslint": "^9",
-    "jest": "^29.7.0",
-    "ngrok": "^5.0.0-beta.2",
-    "nodemon": "^3.1.9",
-    "rimraf": "^6.0.1",
-    "ts-jest": "^29.2.5",
-    "ts-node": "^10.9.2",
-    "typescript": "^5.7.3"
-  }
-}

package/dist/init-templates/aws-lambda/scripts/ngrok.js

@@ -1,28 +0,0 @@
-/* eslint-disable no-undef */
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const ngrok = require('ngrok');
-(async function () {
-    const url = await ngrok.connect({
-        proto: 'http',
-        web_addr: 'localhost:4041',
-        addr: 4041,
-        subdomain: process.argv[2],
-        onLogEvent: (event) => {
-            console.log('Ngrok - ', event);
-        }
-    });
-
-    console.log('')
-    console.log('')
-    console.log('------------------------------------------')
-    console.log('')
-    console.info(`Public URL for Seeka app is exposed by Ngrok`)
-    console.log('')
-    console.info(`${url}/api/webhook/seeka/app`)
-    console.log('')
-    console.info(`Use this URL in your Seeka app configuration for testing`)
-    console.log('')
-    console.log('------------------------------------------')
-    console.log('')
-    console.log('')
-})();

package/dist/init-templates/aws-lambda/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/aws-lambda/src/index.ts

@@ -1,33 +0,0 @@
-import { Context, Handler } from 'aws-lambda';
-import bodyParser from 'body-parser';
-import express from 'express';
-import serverless from 'serverless-http';
-
-import { seekaAppWebhook } from './routes/seekaAppWebhook';
-
-const app = express();
-
-app.post('/api/webhook/seeka/app', bodyParser.text({ type: '*/*' }), async (req, res) => {
-    await seekaAppWebhook(req, res, {} as Context);
-})
-
-app.get('/api/webhook/seeka/app', async (req, res) => {
-    res.status(404).json({ error: "Must use POST" }).send();
-})
-
-const serverlessHandler = serverless(app, {
-    provider: 'aws'
-});
-
-const startServer = async () => {
-    app.listen(4041, () => {
-        console.log("listening on port 4041!");
-    });
-}
-
-startServer();
-
-export const handler: Handler = async (event, context) => {
-    const response = serverlessHandler(event, context);
-    return response;
-};

package/dist/init-templates/aws-lambda/src/lib/logging/index.ts

@@ -1,88 +0,0 @@
-import { Context } from 'aws-lambda';
-import * as winston from 'winston';
-
-import { SeqTransport } from '@datalust/winston-seq';
-
-import * as packageJson from '../../../package.json';
-
-import type {
-    SeekaWebhookPayload, SeekaWebhookPayloadOfSeekaAppWebhookContext
-} from '@seeka-labs/sdk-apps-server';
-
-const loggerTransports: winston.transport[] = [
-    new winston.transports.Console({
-        level: process.env.LOGGING_LEVEL,
-        format: winston.format.combine(
-            winston.format.errors({ stack: true }),
-            winston.format.cli(),
-            winston.format.splat(),
-        ),
-        handleExceptions: true,
-        handleRejections: true,
-    }),
-]
-if (process.env.LOGGING_SEQ_SERVERURL) {
-    loggerTransports.push(
-        new SeqTransport({
-            level: process.env.LOGGING_LEVEL,
-            serverUrl: process.env.LOGGING_SEQ_SERVERURL,
-            apiKey: process.env.LOGGING_SEQ_APIKEY,
-            onError: ((e: any) => { console.error('Failed to configure Seq logging transport', e) }),
-            format: winston.format.combine(
-                winston.format.errors({ stack: true }),
-                winston.format.json(),
-            ),
-            handleExceptions: true,
-            handleRejections: true,
-        })
-    )
-}
-
-let logger: winston.Logger | null = null;
-
-const createLogger = () => winston.createLogger({
-    level: process.env.LOGGING_LEVEL,
-    defaultMeta: {
-        seekaAppId: process.env.SEEKA_APP_ID,
-        Hosting_Provider: 'aws',
-        Release_Version: `v${packageJson.version}`,
-        Hosting_Region: process.env.AWS_REGION,
-        Aws_Xray_TraceId: process.env._X_AMZN_TRACE_ID,
-        Aws_Lambda_FunctionName: process.env.AWS_LAMBDA_FUNCTION_NAME,
-        Service: `app/${packageJson.name}`,
-    },
-    transports: loggerTransports,
-    exitOnError: false,
-});
-
-export const getLogger = () => {
-    if (!logger || logger.closed) {
-        // If the AWS lambda host is reused then the logger will be closed and we need to recreate it
-        logger = createLogger();
-    }
-
-    return logger;
-};
-
-export const childLogger = (meta: object) => getLogger().child(meta);
-
-export const webhookLogger = (payload: SeekaWebhookPayload, functionContext: Context) => {
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    const meta: any = {
-        seekaWebhookType: payload.type,
-        seekaWebhookIsTest: payload.isTest,
-        RequestId: payload.requestId,
-        AwsLambda_RequestId: functionContext.awsRequestId,
-        CausationId: payload.causationId,
-        CorrelationId: payload.causationId,
-    }
-
-    const context = (payload as SeekaWebhookPayloadOfSeekaAppWebhookContext).context;
-    if (context) {
-        meta.seekaAppInstallId = context.applicationInstallId;
-        meta.seekaAppInstallOrganisationBrandId = context.organisationBrandId;
-        meta.seekaAppInstallOrganisationId = context.organisationId;
-    }
-
-    return childLogger(meta)
-}

package/dist/init-templates/aws-lambda/src/lib/services/index.ts

@@ -1,41 +0,0 @@
-import winston, { Logger } from 'winston';
-
-import { connect, disconnect, isConnected } from '../state/redis';
-
-export const startServices = async (logger: Logger) => {
-    logger.debug(`Trying to connect to Redis - ${process.env.REDIS_CONNECTION_HOST}`)
-    try {
-        if (isConnected()) {
-            logger.verbose(`Redis already connected - ${process.env.REDIS_CONNECTION_HOST}`)
-        }
-        else {
-            logger.profile('service.redis.connect')
-            await connect();
-            logger.profile('service.redis.connect')
-            logger.debug(`Redis connected - ${process.env.REDIS_CONNECTION_HOST}`)
-        }
-    }
-    catch (err) {
-        logger.error(`Failed to connect to Redis - ${process.env.REDIS_CONNECTION_HOST}`, { ex: winston.exceptions.getAllInfo(err as any) })
-        throw err;
-    }
-}
-
-export const stopServices = async (logger: Logger) => {
-    logger.debug(`Trying to disconnect from Redis - ${process.env.REDIS_CONNECTION_HOST}`)
-    try {
-        if (isConnected() === false) {
-            logger.verbose(`Redis already disconnected - ${process.env.REDIS_CONNECTION_HOST}`)
-        }
-        else {
-            logger.profile('service.redis.disconnect')
-            await disconnect();
-            logger.profile('service.redis.disconnect')
-            logger.debug(`Redis disconnected - ${process.env.REDIS_CONNECTION_HOST}`)
-        }
-    }
-    catch (err) {
-        logger.error(`Failed to disconnect from Redis - ${process.env.REDIS_CONNECTION_HOST}`, { ex: winston.exceptions.getAllInfo(err as any) })
-        throw err;
-    }
-}

package/dist/init-templates/aws-lambda/src/lib/state/redis/index.ts

@@ -1,65 +0,0 @@
-import { createClient } from 'redis';
-
-import { getLogger } from '../../logging';
-import winston from 'winston';
-
-const redisProtocol = process.env.REDIS_CONNECTION_TLS === 'true' ? 'rediss://' : 'redis://';
-const redisConn = `${redisProtocol}${process.env.REDIS_CONNECTION_USER}:${process.env.REDIS_CONNECTION_PASSWORD}@${process.env.REDIS_CONNECTION_HOST}:${process.env.REDIS_CONNECTION_PORT}`;
-
-const redisClient = createClient({
-    url: redisConn
-})
-    .on('error', (err: any) => getLogger().error('Redis Client ', { ex: winston.exceptions.getAllInfo(err) }));
-
-export const connect = async () => {
-    await redisClient.connect();
-}
-
-export const isConnected = () => {
-    return redisClient.isOpen;
-}
-
-export const disconnect = async () => {
-    await redisClient.disconnect();
-}
-
-const getKeyPrefix = (stateType: string) => `seeka:app:${process.env.SEEKA_APP_ID}:${stateType}`
-const getKey = (stateType: string, key: string) => `${getKeyPrefix(stateType)}:${key}`
-
-export async function getOrCreate<TState>(stateType: string, key: string, toCreate: TState): Promise<TState> {
-    const fullKey = getKey(stateType, key);
-    const existingStr = await redisClient.get(fullKey);
-    if (existingStr) return JSON.parse(existingStr);
-
-    await redisClient.set(fullKey, JSON.stringify(toCreate));
-
-    return toCreate;
-}
-
-export async function tryGet<TState>(stateType: string, key: string): Promise<TState | null> {
-    const fullKey = getKey(stateType, key);
-    const existingStr = await redisClient.get(fullKey);
-    if (existingStr) return JSON.parse(existingStr);
-
-    return null;
-}
-
-export async function getList<TState>(stateType: string): Promise<TState[]> {
-    const prefix = getKeyPrefix(stateType);
-    const allKeys = await redisClient.keys(`${prefix}:*`);
-    const listStr = await redisClient.mGet(allKeys);
-
-    if (listStr) return listStr.filter(e => Boolean(e)).map(e => JSON.parse(e as string));
-
-    return [];
-}
-
-export async function set<TState>(stateType: string, key: string, toCreate: TState): Promise<void> {
-    const fullKey = getKey(stateType, key);
-    await redisClient.set(fullKey, JSON.stringify(toCreate));
-}
-
-export async function remove(stateType: string, key: string): Promise<void> {
-    const fullKey = getKey(stateType, key);
-    await redisClient.del(fullKey);
-}

package/dist/init-templates/aws-lambda/src/lib/state/seeka/installations.ts

@@ -1,67 +0,0 @@
-import type { Logger } from 'winston';
-
-import { getList, remove, set, tryGet } from '../../state/redis';
-
-export interface SeekaAppInstallState {
-    /** ID of the organisation that installed the app */
-    organisationId: string;
-    /** ID of the brand that installed the app */
-    organisationBrandId: string;
-    /** ID of the installation of the app */
-    applicationInstallId: string;
-    // Installation settings provided by the user installing the app
-    installationSettings: SampleAppInstallSettings;
-    // State relating to the app and installation of the app
-    installationState: SampleAppInstallState;
-
-    // When the app was installed
-    installedAt: string; // new Date().toISOString()
-}
-
-export interface SampleAppInstallState {
-    stateItem1?: string
-    stateItem2?: string
-    grantedPermissions?: string[]
-}
-
-export type SampleAppInstallSettings = { [key: string]: any; } | {
-    myAppInstallSetting1: string | number | undefined;
-    myAppInstallSetting2: string | number | undefined;
-}
-
-const stateType = 'install'
-
-export const tryGetInstallation = async (applicationInstallId: string, throwWhenNotFound: boolean, logger: Logger): Promise<SeekaAppInstallState | null> => {
-    const installation = await tryGet<SeekaAppInstallState>(stateType, applicationInstallId);
-    if (installation == null && throwWhenNotFound) {
-        throw new Error(`Seeka installation ${applicationInstallId} not found`);
-    }
-
-    return installation;
-}
-
-export const listInstallations = async (logger: Logger): Promise<SeekaAppInstallState[]> => {
-    const installations = await getList<SeekaAppInstallState>(stateType);
-
-    return installations;
-}
-
-
-export const createOrUpdateInstallation = async (state: SeekaAppInstallState, logger: Logger): Promise<SeekaAppInstallState> => {
-    if (!state.installationState) state.installationState = {};
-    if (!state.installedAt) state.installedAt = new Date().toISOString();
-
-    const creating = (await tryGetInstallation(state.applicationInstallId, false, logger)) === null;
-
-    await set(stateType, state.applicationInstallId, state);
-
-    logger.info(creating ? 'Created installation state' : 'Updated installation state', { applicationInstallId: state.applicationInstallId, organisationId: state.organisationId, organisationBrandId: state.organisationBrandId });
-
-    return state;
-}
-
-export const deleteInstallation = async (applicationInstallId: string, logger: Logger): Promise<void> => {
-    await remove(stateType, applicationInstallId);
-
-    logger.info('Deleted installation state', { applicationInstallId });
-}