@seeka-labs/cli-apps 1.1.6 → 1.1.8

package/dist/init-templates/aws-lambda/.eslintrc.cjs

@@ -5,6 +5,7 @@ module.exports = {
     plugins: ['@typescript-eslint'],
     root: true,
     rules: {
-        "@typescript-eslint/no-unused-vars": "warn"
+        "@typescript-eslint/no-unused-vars": "warn",
+        "@typescript-eslint/no-explicit-any": "off"
     }
 };

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

@@ -23,7 +23,7 @@
   },
   "dependencies": {
     "@datalust/winston-seq": "^2.0.0",
-    "@seeka-labs/sdk-apps-server": "^1.0.4",
+    "@seeka-labs/sdk-apps-server": "^1.1.7",
     "axios": "^1.6.7",
     "express": "^4.18.2",
     "lodash-es": "^4.17.21",

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

@@ -1,6 +1,7 @@
 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}`;
@@ -8,7 +9,7 @@ const redisConn = `${redisProtocol}${process.env.REDIS_CONNECTION_USER}:${proces
 const redisClient = createClient({
     url: redisConn
 })
-    .on('error', err => getLogger().error('Redis Client ', { error: err }));
+    .on('error', (err: any) => getLogger().error('Redis Client ', { ex: winston.exceptions.getAllInfo(err) }));
 
 export const connect = async () => {
     await redisClient.connect();

package/dist/init-templates/aws-lambda/src/routes/seekaAppWebhook.ts

@@ -14,7 +14,7 @@ import {
 import { webhookLogger } from '../lib/logging';
 import { startServices } from '../lib/services';
 import {
-    createOrUpdateInstallation, deleteInstallation, SeekaAppInstallState, tryGetInstallation
+    createOrUpdateInstallation, deleteInstallation, SampleAppInstallSettings, SeekaAppInstallState, tryGetInstallation
 } from '../lib/state/seeka/installations';
 
 export async function seekaAppWebhook(req: Request, res: Response, context: Context): Promise<void> {
@@ -64,15 +64,16 @@ export async function seekaAppWebhook(req: Request, res: Response, context: Cont
 
     // Do something
     try {
+        let errorMessage: string | null = null;
         switch (body.type) {
             case SeekaWebhookCallType.AppInstalled:
                 {
-                    await onInstallation(body as SeekaAppInstalledWebhookPayload, logger);
+                    errorMessage = await onInstallation(body as SeekaAppInstalledWebhookPayload, logger);
                     break;
                 }
             case SeekaWebhookCallType.AppInstallSettingsUpdated:
                 {
-                    await onInstallationSettingsUpdate(body as SeekaAppInstallSettingsUpdatedWebhookPayload, logger);
+                    errorMessage = await onInstallationSettingsUpdate(body as SeekaAppInstallSettingsUpdatedWebhookPayload, logger);
                     break;
                 }
             case SeekaWebhookCallType.AppUninstalled:
@@ -97,7 +98,13 @@ export async function seekaAppWebhook(req: Request, res: Response, context: Cont
                 }
         }
 
-        res.status(204).send();
+        if (errorMessage) {
+            logger.warn('Webhook call failed', { errorMessage });
+            res.status(400).json({ error: { message: errorMessage } }).send();
+        }
+        else {
+            res.status(204).send();
+        }
     }
     catch (err) {
         logger.error('Failed to handle webhook', { ex: winston.exceptions.getAllInfo(err) });
@@ -109,8 +116,18 @@ export async function seekaAppWebhook(req: Request, res: Response, context: Cont
     }
 }
 
-const onInstallation = async (payload: SeekaAppInstalledWebhookPayload, logger: Logger) => {
-    if (payload.isTest) return;
+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,
@@ -123,10 +140,15 @@ const onInstallation = async (payload: SeekaAppInstalledWebhookPayload, logger:
         installedAt: new Date().toISOString(),
         installationSettings: payload.content?.installationSettings || {}
     }, logger)
+
+    return null;
 }
 
-const onInstallationSettingsUpdate = async (payload: SeekaAppInstallSettingsUpdatedWebhookPayload, logger: Logger) => {
-    if (payload.isTest) return;
+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;
     const installation = await createOrUpdateInstallation({
@@ -137,6 +159,8 @@ const onInstallationSettingsUpdate = async (payload: SeekaAppInstallSettingsUpda
         },
         installationSettings: payload.content?.installationSettings || {},
     }, logger)
+
+    return null;
 }
 
 const handleSeekaActivity = async (activity: SeekaActivityAcceptedWebhookPayload, logger: Logger) => {

package/dist/init-templates/azure-function/.eslintrc.cjs

@@ -5,6 +5,7 @@ module.exports = {
     plugins: ['@typescript-eslint'],
     root: true,
     rules: {
-        "@typescript-eslint/no-unused-vars": "warn"
+        "@typescript-eslint/no-unused-vars": "warn",
+        "@typescript-eslint/no-explicit-any": "off"
     }
 };

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

@@ -17,13 +17,14 @@
     "prestart": "<packageManagerRunPrefix> clean && <packageManagerRunPrefix> build",
     "dev": "func start --port 7072",
     "tunnel": "node scripts/ngrok.js seeka-app-example-name-localdev",
-    "deploy": "<packageManagerRunPrefix> clean && <packageManagerRunPrefix> build && func azure functionapp publish seeka-app-example-name --no-build --javascript"
+    "deploy": "<packageManagerRunPrefix> clean && <packageManagerRunPrefix> build && 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.1.0",
     "@azure/storage-queue": "^12.16.0",
     "@datalust/winston-seq": "^2.0.0",
-    "@seeka-labs/sdk-apps-server": "^1.0.4",
+    "@seeka-labs/sdk-apps-server": "^1.1.7",
     "axios": "^1.6.7",
     "lodash-es": "^4.17.21",
     "openid-client": "^5.6.4",

package/dist/init-templates/azure-function/scripts/dev-queue-setup.js

@@ -0,0 +1,18 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
+/* eslint-disable no-undef */
+const { QueueClient } = require("@azure/storage-queue");
+
+(async function () {
+    // https://learn.microsoft.com/en-us/azure/storage/common/storage-use-azurite?tabs=visual-studio%2Cqueue-storage#azure-sdks
+    // Dev / emulator / azurite
+    var client = new QueueClient(
+        `UseDevelopmentStorage=true`, process.argv[2]
+    );
+    const res = await client.createIfNotExists();
+    if (res.succeeded) {
+        console.log("Queue created");
+    }
+    else {
+        console.log("Queue already exists");
+    }
+})();

package/dist/init-templates/azure-function/src/functions/queueExample.ts

@@ -13,7 +13,8 @@ app.storageQueue('queueExample', {
 });
 
 export async function queueExample(queueItem: string, context: InvocationContext): Promise<void> {
-    const body = deserialiseQueuePayload<BackgroundJobRequestContext>(queueItem);
+    const body = typeof queueItem === 'string' ? deserialiseQueuePayload<BackgroundJobRequestContext>(queueItem) : queueItem as BackgroundJobRequestContext;
+
     const logger = backgroundJobLogger(queueNames.queueItemExampleQueueName, body, context);
     logger.profile(`queue.${queueNames.queueItemExampleQueueName}`)
 

package/dist/init-templates/azure-function/src/functions/seekaAppWebhook.ts

@@ -16,7 +16,7 @@ import { getSeekaBrowserPlugin } from '../lib/browser'
 import { webhookLogger } from '../lib/logging';
 import { startServices } from '../lib/services';
 import {
-    createOrUpdateInstallation, deleteInstallation, SeekaAppInstallState, tryGetInstallation
+    createOrUpdateInstallation, deleteInstallation, SampleAppInstallSettings, SeekaAppInstallState, tryGetInstallation
 } from '../lib/state/seeka/installations';
 
 import type { Logger } from 'winston';
@@ -85,16 +85,17 @@ export async function seekaAppWebhook(req: HttpRequest, context: InvocationConte
     }
 
     // Do something
+    let errorMessage: string | null = null;
     try {
         switch (body.type) {
             case SeekaWebhookCallType.AppInstalled:
                 {
-                    await onInstallation(body as SeekaAppInstalledWebhookPayload, logger);
+                    errorMessage = await onInstallation(body as SeekaAppInstalledWebhookPayload, logger);
                     break;
                 }
             case SeekaWebhookCallType.AppInstallSettingsUpdated:
                 {
-                    await onInstallationSettingsUpdate(body as SeekaAppInstallSettingsUpdatedWebhookPayload, logger);
+                    errorMessage = await onInstallationSettingsUpdate(body as SeekaAppInstallSettingsUpdatedWebhookPayload, logger);
                     break;
                 }
             case SeekaWebhookCallType.AppUninstalled:
@@ -146,13 +147,31 @@ export async function seekaAppWebhook(req: HttpRequest, context: InvocationConte
         logger.verbose('Seeka webhook handled');
     }
 
+    if (errorMessage) {
+        logger.warn('Webhook call failed', { errorMessage });
+        return {
+            status: 400,
+            jsonBody: { error: { message: errorMessage } }
+        }
+    }
+
     return {
         status: 204
     }
 }
 
-const onInstallation = async (payload: SeekaAppInstalledWebhookPayload, logger: Logger) => {
-    if (payload.isTest) return;
+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,
@@ -171,10 +190,15 @@ const onInstallation = async (payload: SeekaAppInstalledWebhookPayload, logger:
         causationId: payload.causationId,
         correlationId: payload.requestId
     }, logger)
+
+    return null;
 }
 
-const onInstallationSettingsUpdate = async (payload: SeekaAppInstallSettingsUpdatedWebhookPayload, logger: Logger) => {
-    if (payload.isTest) return;
+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;
     const installation = await createOrUpdateInstallation({
@@ -191,6 +215,8 @@ const onInstallationSettingsUpdate = async (payload: SeekaAppInstallSettingsUpda
         causationId: payload.causationId,
         correlationId: payload.requestId
     }, logger)
+
+    return null;
 }
 
 const handleSeekaActivity = async (activity: SeekaActivityAcceptedWebhookPayload, logger: Logger) => {

package/dist/init-templates/azure-function/src/lib/state/redis/index.ts

@@ -1,6 +1,7 @@
 import { createClient } from 'redis';
 
 import { logger } 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}`;
@@ -8,7 +9,7 @@ const redisConn = `${redisProtocol}${process.env.REDIS_CONNECTION_USER}:${proces
 const redisClient = createClient({
     url: redisConn
 })
-    .on('error', err => logger.error('Redis Client ', { error: err }));
+    .on('error', (err: any) => logger.error('Redis Client ', { ex: winston.exceptions.getAllInfo(err) }));
 
 export const connect = async () => {
     await redisClient.connect();

package/dist/init-templates/netlify-function/.eslintrc.cjs

@@ -4,4 +4,8 @@ module.exports = {
     parser: '@typescript-eslint/parser',
     plugins: ['@typescript-eslint'],
     root: true,
+    rules: {
+        "@typescript-eslint/no-unused-vars": "warn",
+        "@typescript-eslint/no-explicit-any": "off"
+    }
 };

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

@@ -19,7 +19,7 @@
   "dependencies": {
     "@datalust/winston-seq": "^2.0.0",
     "@netlify/functions": "^2.5.1",
-    "@seeka-labs/sdk-apps-server": "^1.0.4",
+    "@seeka-labs/sdk-apps-server": "^1.1.7",
     "axios": "^1.6.7",
     "lodash-es": "^4.17.21",
     "openid-client": "^5.6.4",

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

@@ -7,7 +7,7 @@ import { jobNames, triggerBackgroundJob } from '@/lib/jobs';
 import { webhookLogger } from '@/lib/logging';
 import { startServices, stopServices } from '@/lib/services';
 import {
-    createOrUpdateInstallation, deleteInstallation, SeekaAppInstallState, tryGetInstallation
+    createOrUpdateInstallation, deleteInstallation, SampleAppInstallSettings, SeekaAppInstallState, tryGetInstallation
 } from '@/lib/state/seeka/installations';
 import {
     PersonIdentifiers, SeekaActivityAcceptedWebhookPayload, SeekaAppInstalledWebhookPayload,
@@ -67,16 +67,17 @@ export default async (req: Request, context: Context) => {
     }
 
     // Do something
+    let errorMessage: string | null = null;
     try {
         switch (body.type) {
             case SeekaWebhookCallType.AppInstalled:
                 {
-                    await onInstallation(body as SeekaAppInstalledWebhookPayload, logger);
+                    errorMessage = await onInstallation(body as SeekaAppInstalledWebhookPayload, logger);
                     break;
                 }
             case SeekaWebhookCallType.AppInstallSettingsUpdated:
                 {
-                    await onInstallationSettingsUpdate(body as SeekaAppInstallSettingsUpdatedWebhookPayload, logger);
+                    errorMessage = await onInstallationSettingsUpdate(body as SeekaAppInstallSettingsUpdatedWebhookPayload, logger);
                     break;
                 }
             case SeekaWebhookCallType.AppUninstalled:
@@ -114,29 +115,52 @@ export default async (req: Request, context: Context) => {
         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 onInstallation = async (payload: SeekaAppInstalledWebhookPayload, logger: Logger) => {
-    if (payload.isTest) return;
+    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 || {}
-    } as any, logger) // TODO: remove any
+    }, logger)
 
     // Trigger a sync for the installation
     await triggerBackgroundJob(jobNames.exampleBackgroundJob, {
         ...payload.context
     }, logger)
+
+    return null;
 }
 
-const onInstallationSettingsUpdate = async (payload: SeekaAppInstallSettingsUpdatedWebhookPayload, logger: Logger) => {
-    if (payload.isTest) return;
+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;
 
@@ -152,6 +176,8 @@ const onInstallationSettingsUpdate = async (payload: SeekaAppInstallSettingsUpda
     } as any, logger) // TODO: remove any
 
     logger.info('Settings updated')
+
+    return null;
 }
 
 const handleSeekaActivity = async (activity: SeekaActivityAcceptedWebhookPayload, logger: Logger) => {

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

@@ -1,6 +1,7 @@
 import { createClient } from 'redis';
 
 import { logger } from '@/lib/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}`;
@@ -8,7 +9,7 @@ const redisConn = `${redisProtocol}${process.env.REDIS_CONNECTION_USER}:${proces
 const redisClient = createClient({
     url: redisConn
 })
-    .on('error', err => logger.error('Redis Client ', { error: err }));
+    .on('error', (err: any) => logger.error('Redis Client ', { ex: winston.exceptions.getAllInfo(err) }));
 
 export const connect = async () => {
     await redisClient.connect();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seeka-labs/cli-apps",
-  "version": "1.1.6",
+  "version": "1.1.8",
   "description": "Seeka - Apps CLI",
   "author": "SEEKA <platform@seeka.co>",
   "license": "MIT",