@seeka-labs/cli-apps 3.5.2 → 3.5.4

package/dist/init-template/.gitlab-ci.yml

@@ -0,0 +1,67 @@
+stages:
+  - deploy
+
+variables:
+  AZURE_FUNC_RESOURCE_NAME: example-app-name
+  CI_DEBUG_TRACE: "true"
+  NODE_OPTIONS: --max-old-space-size=8192
+  VITE_RELEASE_TAG: "$CI_COMMIT_SHORT_SHA"
+  VITE_BASE_URL: "/example-app-name-app/"
+  VITE_URLS_SEEKA_API_CORE: "https://api.seeka.services"
+  VITE_URLS_SEEKA_APP_CORE_ORIGIN: "https://seeka.app"
+
+workflow:
+  rules:
+    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
+      when: never
+    - if: '$CI_COMMIT_BRANCH == "main" && ($CI_PIPELINE_SOURCE == "push" || $CI_PIPELINE_SOURCE == "web")'
+      variables:
+        HOSTING_REGION_NAME: auea
+        HOSTING_ENV_NAME: prod
+      when: always
+    - if: '$CI_COMMIT_BRANCH == "staging" && ($CI_PIPELINE_SOURCE == "push" || $CI_PIPELINE_SOURCE == "web")'
+      variables:
+        HOSTING_REGION_NAME: auea
+        HOSTING_ENV_NAME: stag
+      when: always
+
+azure_func:
+  cache:
+    policy: pull-push
+    key: npmCache_app_example-app-name_$CI_COMMIT_BRANCH
+    untracked: false
+    paths:
+    - node_modules/
+    - app/server/node_modules/
+    - .yarn/install-state.gz
+  stage: deploy
+  image: node:22
+  artifacts:
+    when: on_success
+    exclude:
+    - .git/**/*
+    - .git/
+    paths:
+    - app/*/build/**
+    - app/*/dist/**
+  environment:
+    name: $HOSTING_REGION_NAME/$HOSTING_ENV_NAME/apps
+  before_script:
+    - echo "installing azure cli"
+    - curl -sL https://aka.ms/InstallAzureCLIDeb | bash
+    - az --version
+    - echo "installing Azure Functions Core Tools"
+    - npm install -g azure-functions-core-tools@4 --unsafe-perm true
+    - echo "logging in to azure"
+    - az login --service-principal --username "$AZURE_SERVICEPRINCIPAL_CLIENTID" --password "$AZURE_SERVICEPRINCIPAL_SECRET" --tenant "$AZURE_TENANT_ID"
+    - az account set --subscription "$AZURE_SUBSCRIPTION_ID"
+    - corepack enable
+  script:
+    - echo "deploying azure func $AZURE_FUNC_RESOURCE_NAME to slot $AZURE_FUNC_SLOT from branch $CI_COMMIT_BRANCH"
+    - yarn install --immutable
+    - yarn clean && yarn build
+    - cd app/server
+    - func azure functionapp publish $AZURE_FUNC_RESOURCE_NAME --no-build --javascript
+  only:
+    - main
+    - staging

package/dist/init-template/.nvmrc

@@ -0,0 +1 @@
+22

package/dist/init-template/README.md

@@ -0,0 +1,27 @@
+# @example-org-name/example-app-name
+
+## Local dev
+
+### First run
+`yarn dev:init`
+
+1. `yarn clean`
+2. Run
+  - server + browser plugin + ui
+    - `clear && yarn start:all`
+  - server + browser plugin
+    - `clear && yarn start:server`
+
+### Updating packages
+
+#### Seeka SDK packages
+```
+cd repo root
+yarn up "@seeka-labs/*" --mode=update-lockfile
+```
+
+#### All packages
+```
+cd repo root
+npx npm-check-updates@latest -i --workspaces --target minor && npx npm-check-updates@latest -i --workspaces --target minor --dep peer && npx npm-check-updates@latest -i --workspaces --target latest && npx npm-check-updates@latest -i --workspaces --target latest --dep peer
+```

package/dist/init-template/app/.eslintrc.cjs

@@ -0,0 +1,13 @@
+/* eslint-env node */
+module.exports = {
+    extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended'],
+    parser: '@typescript-eslint/parser',
+    plugins: ['@typescript-eslint'],
+    root: true,
+    rules: {
+        "@typescript-eslint/no-unused-vars": "warn",
+        "@typescript-eslint/no-empty-function": "warn",
+        "@typescript-eslint/no-empty-object-type": "warn",
+        "@typescript-eslint/no-explicit-any": "warn"
+    }
+};

package/dist/init-template/app/browser/README.md

@@ -0,0 +1 @@
+# `@example-org-name/example-app-name-browser`

package/dist/init-template/app/browser/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@example-org-name/example-app-name-browser",
+  "version": "3.5.4",
+  "description": "Seeka app browser plugin example-app-name",
+  "author": "Seeka company <support@seeka.co>",
+  "private": true,
+  "license": "MIT",
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "lint": "eslint --fix src/ --ext .ts",
+    "typecheck": "tsc --noEmit",
+    "clean": "rimraf dist build package",
+    "build": "node ./scripts/esbuild/build-browser-plugin.mjs seeka-browser-plugin ExampleAppAppConvergeSdkPlugin",
+    "build:dev": "node ./scripts/esbuild/build-browser-plugin.mjs seeka-browser-plugin ExampleAppAppConvergeSdkPlugin dev",
+    "watch": "node ./scripts/esbuild/build-browser-plugin.mjs seeka-browser-plugin ExampleAppAppConvergeSdkPlugin dev watch"
+  },
+  "dependencies": {
+    "@example-org-name/example-app-name-lib": "workspace:*",
+    "@seeka-labs/converge": "^1"
+  },
+  "devDependencies": {
+    "@jgoz/esbuild-plugin-typecheck": "^4",
+    "@types/lodash-es": "^4",
+    "@types/node": "^22",
+    "@typescript-eslint/eslint-plugin": "^8",
+    "@typescript-eslint/parser": "^8",
+    "esbuild": "^0",
+    "eslint": "^9",
+    "eslint-plugin-unused-imports": "^4",
+    "rimraf": "^6",
+    "typescript": "^5",
+    "watch": "^1"
+  },
+  "gitHead": "7bdfa73d8fd888cf89d5469f161dd4109172f39a"
+}

package/dist/init-template/app/browser/scripts/esbuild/build-browser-plugin.mjs

@@ -0,0 +1,130 @@
+import { typecheckPlugin } from '@jgoz/esbuild-plugin-typecheck';
+import { build, context, version } from 'esbuild';
+import { copyFileSync, existsSync, mkdirSync } from 'fs';
+import { resolve } from 'path';
+import * as watch from 'watch';
+import { importAsGlobals } from './plugins/importAsGlobals.mjs';
+
+console.log('esbuild version:', version);
+
+if (process.argv.length < 3) {
+  throw new Error('Missing arg');
+}
+
+const pluginName = process.argv[2];
+
+const mode = process.argv.length > 4 ? process.argv[4] : 'prod';
+const watchBuild = process.argv.length > 5 ? process.argv[5] == 'watch' : false;
+
+console.log('mode:', mode);
+console.log('watchBuild:', process.argv[4]);
+
+const opts = {
+  entryPoints: ['src/browser.ts'],
+  bundle: true,
+  metafile: true,
+  minify: mode === 'dev' ? false : true,
+  format: 'iife',
+  platform: 'browser',
+  //sourcemap: 'external',
+  sourcemap: mode === 'dev' ? true : false,
+  external: ['@seeka-labs/converge'],
+  outfile: `dist/${pluginName}.min.js`,
+  plugins: [
+    importAsGlobals({
+      "@seeka-labs/converge": "SeekaConvergeCore"
+    }),
+    typecheckPlugin()
+  ]
+}
+
+const postBuild = () => {
+  // Copy outfile to ../dist/src/browser
+    const serverDirNames = ['server-azurefunc']
+
+    serverDirNames.forEach(dirName => {
+        if (existsSync(resolve(`../${dirName}`))) {
+
+            if (!existsSync(resolve(`../${dirName}/dist/src/browser`))) {
+                mkdirSync(resolve(`../${dirName}/dist/src/browser`), {
+                    recursive: true,
+                });
+            }
+
+            copyFileSync(resolve(opts.outfile), resolve(`../${dirName}/dist/src/browser`, `${pluginName}.min.js`))
+        }
+    })
+}
+
+if (watchBuild) {
+  const ctx = await context(opts);
+
+  async function buildWatch() {
+    await ctx.rebuild();
+    postBuild();
+    console.log('build succeeded');
+  }
+
+  await buildWatch();
+
+  // Start watch
+  let monitorInstance;
+  watch.createMonitor(resolve('./src'), function (monitor) {
+    console.log('watching ./src, press any key to exit');
+    monitorInstance = monitor;
+
+    monitor.on("created", async function (f, stat) {
+      console.log('rebuilding due to file created', f)
+      try {
+        await buildWatch();
+      }
+      catch (e) {
+        console.error(e);
+      }
+    })
+    monitor.on("changed", async function (f, curr, prev) {
+      console.log('rebuilding due to file changed', f)
+      try {
+        await buildWatch();
+      }
+      catch (e) {
+        console.error(e);
+      }
+    })
+    monitor.on("removed", async function (f, stat) {
+      console.log('rebuilding due to file deleted', f)
+      try {
+        await buildWatch();
+      }
+      catch (e) {
+        console.error(e);
+      }
+    })
+  })
+
+  // Support stopping
+  const stopWatch = () => {
+    console.log('Stopping watch...');
+    try {
+      monitorInstance?.stop();
+    }
+    finally {
+      process.exit();
+    }
+  };
+
+  process.on('SIGINT', stopWatch);
+  process.on('SIGTERM', stopWatch);
+
+  const stdin = process.stdin;
+  if (stdin?.isTTY && typeof stdin.setRawMode === 'function') {
+    stdin.setRawMode(true);
+    stdin.resume();
+    stdin.setEncoding('utf8');
+    stdin.on('data', stopWatch);
+  }
+}
+else {
+  await build(opts);
+  postBuild();
+}

package/dist/init-template/app/browser/scripts/esbuild/plugins/importAsGlobals.mjs

@@ -0,0 +1,39 @@
+export function importAsGlobals(mapping) {
+    // https://github.com/evanw/esbuild/issues/337
+    // https://stackoverflow.com/a/3561711/153718
+    const escRe = (s) => s.replace(/[-\/\\^$*+?.()|[\]{}]/g, "\\$&");
+    const filter = new RegExp(
+        Object.keys(mapping)
+            .map((mod) => `^${escRe(mod)}$`)
+            .join("|"),
+    );
+
+    return {
+        name: "global-imports",
+        setup(build) {
+            build.onResolve({ filter }, (args) => {
+                if (!mapping[args.path]) {
+                    throw new Error("Unknown global: " + args.path);
+                }
+                return {
+                    path: args.path,
+                    namespace: "external-global",
+                };
+            });
+
+            build.onLoad(
+                {
+                    filter,
+                    namespace: "external-global",
+                },
+                async (args) => {
+                    const global = mapping[args.path];
+                    return {
+                        contents: `module.exports = ${global};`,
+                        loader: "js",
+                    };
+                },
+            );
+        },
+    };
+}

package/dist/init-template/app/browser/src/browser.ts

@@ -0,0 +1,12 @@
+import { ExampleAppAppBrowserSdkPluginConfig } from "@example-org-name/example-app-name-lib";
+import { ExampleAppAppConvergeSdkPlugin } from "./plugin";
+
+declare global {
+  interface Window {
+    ExampleAppAppConvergeSdkPlugin: (pluginConfig: ExampleAppAppBrowserSdkPluginConfig) => ExampleAppAppConvergeSdkPlugin;
+  }
+}
+
+(window as Window).ExampleAppAppConvergeSdkPlugin = (pluginConfig: ExampleAppAppBrowserSdkPluginConfig) => {
+  return new ExampleAppAppConvergeSdkPlugin(pluginConfig);
+}; 

package/dist/init-template/app/browser/src/plugin/index.ts

@@ -0,0 +1,61 @@
+import {
+    ConvergeSdk,
+    type IActivityCommonProps,
+    type IActivityMetadataProps,
+    type IConvergePlugin,
+    type PersonIdentifiers,
+    TrackingActivityNames
+} from '@seeka-labs/converge';
+
+import type {ExampleAppAppBrowserSdkPluginConfig} from '@example-org-name/example-app-name-lib';
+
+import {version} from '../../package.json';
+
+export class ExampleAppAppConvergeSdkPlugin implements IConvergePlugin<ExampleAppAppBrowserSdkPluginConfig> {
+    constructor(pluginConfig: ExampleAppAppBrowserSdkPluginConfig) {
+        this.type = "seeka-app-example-app-name";
+        this.name = this.type + "-" + pluginConfig.appInstallId;
+        this.version = version;
+        this.sdk = {} as ConvergeSdk;
+        this.config = pluginConfig || {};
+    }
+
+    sdk: ConvergeSdk;
+
+    privacyConfig = {
+        // TODO
+        requiresIabPurposes: []
+    }
+
+    name: string;
+    type: string;
+    version: string;
+    config: ExampleAppAppBrowserSdkPluginConfig;
+
+    async beforeInit(): Promise<void> {
+        
+    }
+
+    async activity(name: TrackingActivityNames, props?: IActivityCommonProps, metadata?: IActivityMetadataProps): Promise<void> {
+        this.sdk.debug.log(`ExampleApp - Listened to activity ${name} that was fired by Seeka with props`, {props, metadata});
+    }
+
+    async collectIdentifiers(): Promise<PersonIdentifiers | undefined> {
+        const data = {
+            google: {
+                gclid: [] as string[]
+            }
+        };
+
+        this.sdk.debug.verbose('ExampleApp - collected identifiers', data);
+
+        return data;
+    }
+
+    async init(_params: any): Promise<void> {
+    }
+
+    isLoaded(): boolean {
+        return true;
+    }
+}

package/dist/init-template/app/browser/tsconfig.json

@@ -0,0 +1,34 @@
+{
+  "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"
+    ],
+    "lib": [
+      "ES6",
+      "DOM"
+    ]
+  },
+  "include": [
+    "src/browser.ts",
+  ]
+}

package/dist/init-template/app/lib/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@example-org-name/example-app-name-lib",
+  "version": "3.5.4",
+  "description": "Seeka app library for example-app-name",
+  "author": "Seeka <administrator@seeka.co>",
+  "license": "MIT",
+  "private": true,
+  "files": [
+    "dist/"
+  ],
+  "types": "./dist/lib/types/index.d.ts",
+  "source": "src/index.ts",
+  "main": "./dist/lib/example-app-name-lib.module.js",
+  "module": "./dist/lib/example-app-name-lib.module.js",
+  "devDependencies": {
+    "@seeka-labs/sdk-apps-core": "../../../workspace:* || ^3",
+    "@seeka-labs/sdk-apps-server": "../../../workspace:* || ^3",
+    "@types/lodash-es": "^4",
+    "@types/node": "^22",
+    "esbuild": "^0",
+    "lodash-es": "^4",
+    "memory-cache": "^0",
+    "openid-client": "^6",
+    "rimraf": "^6",
+    "typescript": "^5",
+    "undici": "^7",
+    "winston": "^3",
+    "zod": "^4"
+  },
+  "dependencies": {
+    "axios": "^1"
+  },
+  "peerDependencies": {
+    "@seeka-labs/sdk-apps-core": "^3",
+    "@seeka-labs/sdk-apps-server": "^3",
+    "lodash-es": "^4",
+    "undici": "^7",
+    "zod": "^4"
+  },
+  "scripts": {
+    "clean": "rimraf build package dist",
+    "typecheck": "tsc --noEmit",
+    "build": "yarn esbuild src/index.ts --outfile=dist/lib/example-app-name-lib.module.js --bundle --analyze --platform=node --format=esm --packages=external --minify && yarn tsc --emitDeclarationOnly",
+    "dev": "yarn esbuild src/index.ts --outfile=dist/lib/example-app-name-lib.module.js --bundle --analyze --platform=node --format=esm --packages=external --sourcemap && yarn tsc --emitDeclarationOnly"
+  }
+}

package/dist/init-template/app/lib/src/index.ts

@@ -0,0 +1,4 @@
+
+export * from './models';
+export * from './validation';
+

package/dist/init-template/app/lib/src/models/index.ts

@@ -0,0 +1,29 @@
+import { SeekaAppUiClientInitConfig} from '@seeka-labs/sdk-apps-core'
+import {SeekaAppInstallContext} from "@seeka-labs/sdk-apps-core";
+
+export interface ExampleAppAppBrowserSdkPluginConfig {
+    appId: string
+    appInstallId: string
+    appUrl: string
+    installationSettings: {
+        browserPluginAppSetting1?: string | null
+    }
+}
+
+export type ExampleAppAppInstallSettings = {
+    exampleInstallSetting1?: string | null
+    exampleInstallSetting2?: number | null
+    browserPluginAppSetting1?: string | null
+}
+
+export type ExampleAppAppUiClientInitState = {
+    exampleInstallSetting1?: string | null
+}
+
+export interface ExampleAppAppInstallState {
+    installationSettings?: ExampleAppAppInstallSettings
+}
+
+export type ExampleAppAppInstallContext = SeekaAppInstallContext<ExampleAppAppInstallState>
+
+export type ExampleAppAppUiClientInitConfig = SeekaAppUiClientInitConfig<ExampleAppAppUiClientInitState>

package/dist/init-template/app/lib/src/validation/index.ts

@@ -0,0 +1,14 @@
+import type {Logger} from "winston";
+import {ExampleAppAppInstallSettings} from "../models";
+
+// TODO: Use Zod
+export const validateInstallationSettings = async (installSettings: ExampleAppAppInstallSettings, 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
+
+    if(!installSettings) return null;
+
+    if(installSettings.exampleInstallSetting2 && installSettings.exampleInstallSetting2 < 2) return 'Example install setting 2 must be greater than 2';
+
+
+    return null;
+}

package/dist/init-template/app/lib/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "module": "ESNext",
+    "lib": ["ESNext"],
+    "declarationDir": "./dist/lib/types",
+    "declarationMap": true,
+    "allowJs": true,
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "noFallthroughCasesInSwitch": true,
+    "removeComments": true,
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "declaration": true
+  },
+  "include": ["src"]
+}

package/dist/init-template/app/server-azurefunc/.eslintrc.cjs

@@ -0,0 +1,4 @@
+/* eslint-env node */
+module.exports = {
+    extends: ['../.eslintrc.cjs']
+};

package/dist/init-template/app/server-azurefunc/.funcignore

@@ -0,0 +1,19 @@
+*.ts
+local.settings.json
+test
+scripts/
+src/
+README.md
+tsconfig.json
+.eslintrc.cjs
+
+node_modules/@types/
+node_modules/@typescript-eslint/eslint-plugin/
+node_modules/@typescript-eslint/parser/
+node_modules/azure-functions-core-tools/
+node_modules/eslint/
+node_modules/ngrok/
+node_modules/rimraf/
+node_modules/typescript/
+
+.gitignore