@seeka-labs/cli-apps 1.1.23 → 1.1.25

package/dist/init-templates/azure-function/src/lib/state/seeka/installations.ts

@@ -1,67 +1,67 @@
-import type { Logger } from 'winston';
-
-import { getList, remove, set, tryGet } from '../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 });
+import type { Logger } from 'winston';
+
+import { getList, remove, set, tryGet } from '../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 });
 }

package/dist/init-templates/browser/.editorconfig

@@ -1,14 +1,14 @@
-# http://editorconfig.org
-root = true
-
-[*]
-charset = utf-8
-end_of_line = lf
-indent_size = 2
-indent_style = space
-insert_final_newline = true
-trim_trailing_whitespace = true
-
-[*.md]
-max_line_length = 0
-trim_trailing_whitespace = true
+# http://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+max_line_length = 0
+trim_trailing_whitespace = true

package/dist/init-templates/browser/.eslintrc.cjs

@@ -1 +1 @@
-module.exports = require('../../scripts/eslint/shared.eslint.cjs');
+module.exports = require('../../scripts/eslint/shared.eslint.cjs');

package/dist/init-templates/browser/.yarnrc

@@ -1 +1 @@
-"@seeka-labs:registry" "https://npm.packages.seeka.services/"
+"@seeka-labs:registry" "https://npm.packages.seeka.services/"

package/dist/init-templates/browser/jest.config.js

@@ -1,11 +1,11 @@
-export default {
-  roots: ['<rootDir>/src'],
-  testMatch: [
-    "**/*.test.ts"
-  ],
-  transform: {
-    "^.+\\.(ts|tsx)$": "ts-jest"
-  },
-  collectCoverageFrom: ["src/**/*.ts", "!**/node_modules/**"],
-  coverageReporters: ["html", "text", "text-summary", "cobertura"],
-}
+export default {
+  roots: ['<rootDir>/src'],
+  testMatch: [
+    "**/*.test.ts"
+  ],
+  transform: {
+    "^.+\\.(ts|tsx)$": "ts-jest"
+  },
+  collectCoverageFrom: ["src/**/*.ts", "!**/node_modules/**"],
+  coverageReporters: ["html", "text", "text-summary", "cobertura"],
+}

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

@@ -22,10 +22,10 @@
   "devDependencies": {
     "@jgoz/esbuild-plugin-typecheck": "^4.0.2",
     "@types/jest": "^29.5.14",
-    "@typescript-eslint/eslint-plugin": "^8.16.0",
-    "@typescript-eslint/parser": "^8.16.0",
+    "@typescript-eslint/eslint-plugin": "^8.17.0",
+    "@typescript-eslint/parser": "^8.17.0",
     "esbuild": "^0.24.0",
-    "eslint": "^9.15.0",
+    "eslint": "^9.16.0",
     "eslint-plugin-unused-imports": "^4.1.4",
     "jest": "^29.7.0",
     "jest-junit": "^16.0.0",

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

@@ -1,111 +1,111 @@
-import { importAsGlobals } from './plugins/importAsGlobals.mjs'
-import { build, version, context } from 'esbuild'
-import { typecheckPlugin } from '@jgoz/esbuild-plugin-typecheck';
-import { copyFileSync, mkdirSync, existsSync } from 'fs'
-import { resolve } from 'path'
-import * as watch from 'watch'
-
-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
-  if (!existsSync(resolve('../../dist/src/browser'))) {
-    mkdirSync(resolve('../../dist/src/browser'), {
-      recursive: true,
-    });
-  }
-  copyFileSync(resolve(opts.outfile), resolve('../../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
-  var stdin = process.stdin;
-  stdin.setRawMode(true);
-  stdin.resume();
-  stdin.setEncoding('utf8');
-  stdin.on('data', function (key) {
-    console.log('Stopping watch...');
-    monitorInstance.stop();
-    process.exit();
-  });
-}
-else {
-  await build(opts);
-  postBuild();
+import { importAsGlobals } from './plugins/importAsGlobals.mjs'
+import { build, version, context } from 'esbuild'
+import { typecheckPlugin } from '@jgoz/esbuild-plugin-typecheck';
+import { copyFileSync, mkdirSync, existsSync } from 'fs'
+import { resolve } from 'path'
+import * as watch from 'watch'
+
+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
+  if (!existsSync(resolve('../../dist/src/browser'))) {
+    mkdirSync(resolve('../../dist/src/browser'), {
+      recursive: true,
+    });
+  }
+  copyFileSync(resolve(opts.outfile), resolve('../../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
+  var stdin = process.stdin;
+  stdin.setRawMode(true);
+  stdin.resume();
+  stdin.setEncoding('utf8');
+  stdin.on('data', function (key) {
+    console.log('Stopping watch...');
+    monitorInstance.stop();
+    process.exit();
+  });
+}
+else {
+  await build(opts);
+  postBuild();
 }

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

@@ -1,39 +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",
-                    };
-                },
-            );
-        },
-    };
+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-templates/browser/src/browser.ts

@@ -1,12 +1,12 @@
-import { SampleAppConvergeSdkPlugin } from "./plugin";
-import type { ISampleAppBrowserSdkPluginConfig } from "../../lib/browser/models";
-
-declare global {
-  interface Window {
-    SampleAppConvergeSdkPlugin: (pluginConfig: ISampleAppBrowserSdkPluginConfig) => SampleAppConvergeSdkPlugin;
-  }
-}
-
-(window as Window).SampleAppConvergeSdkPlugin = (pluginConfig: ISampleAppBrowserSdkPluginConfig) => {
-  return new SampleAppConvergeSdkPlugin(pluginConfig);
-};
+import { SampleAppConvergeSdkPlugin } from "./plugin";
+import type { ISampleAppBrowserSdkPluginConfig } from "../../lib/browser/models";
+
+declare global {
+  interface Window {
+    SampleAppConvergeSdkPlugin: (pluginConfig: ISampleAppBrowserSdkPluginConfig) => SampleAppConvergeSdkPlugin;
+  }
+}
+
+(window as Window).SampleAppConvergeSdkPlugin = (pluginConfig: ISampleAppBrowserSdkPluginConfig) => {
+  return new SampleAppConvergeSdkPlugin(pluginConfig);
+};

package/dist/init-templates/browser/src/plugin/index.test.ts

@@ -1,6 +1,6 @@
-
-describe("SampleTest", () => {
-  test("Sample", () => {
-    expect(1).toStrictEqual(1);
-  });
-});
+
+describe("SampleTest", () => {
+  test("Sample", () => {
+    expect(1).toStrictEqual(1);
+  });
+});

package/dist/init-templates/browser/src/plugin/index.ts

@@ -1,50 +1,50 @@
-
-import {
-  ConvergeSdk,
-  IConvergePlugin,
-  TrackingActivityNames, getActivityName
-} from '@seeka-labs/converge';
-
-import type { ISampleAppBrowserSdkPluginConfig } from '../../../lib/browser/models'
-
-import { version, dependencies } from '../../package.json';
-
-const checkSdkAndPluginVersion = (expectedVersion: string, sdk: ConvergeSdk, pluginName: string): void => {
-  let runtimeVersion = sdk.config.runtime.ver as string;
-  runtimeVersion = runtimeVersion.replace('^', '');
-  expectedVersion = expectedVersion.replace('^', '');
-
-  if (expectedVersion !== runtimeVersion) {
-    sdk.debug.warn(`The expected SDK version of ${expectedVersion} for the ${pluginName} plugin does not match the current installlation runtime of ${runtimeVersion}`);
-  }
-}
-
-export class SampleAppConvergeSdkPlugin implements IConvergePlugin<ISampleAppBrowserSdkPluginConfig> {
-  constructor(pluginConfig: ISampleAppBrowserSdkPluginConfig) {
-    this.type = "seeka-app-example-name";
-    // this.name = this.type + "-" + pluginConfig.siteId;
-    this.name = this.type;
-    this.version = version;
-    this.sdk = {} as ConvergeSdk;
-    this.config = pluginConfig || {};
-  }
-  sdk: ConvergeSdk;
-
-  privacyConfig = {
-    // TODO
-    requiresIabPurposes: []
-  }
-
-  name: string;
-  type: string;
-  version: string;
-  config: ISampleAppBrowserSdkPluginConfig;
-
-  async init(_params: any): Promise<void> {
-    checkSdkAndPluginVersion(dependencies['@seeka-labs/converge'], this.sdk, this.name)
-  }
-
-  isLoaded(): boolean {
-    return true;
-  }
+
+import {
+  ConvergeSdk,
+  IConvergePlugin,
+  TrackingActivityNames, getActivityName
+} from '@seeka-labs/converge';
+
+import type { ISampleAppBrowserSdkPluginConfig } from '../../../lib/browser/models'
+
+import { version, dependencies } from '../../package.json';
+
+const checkSdkAndPluginVersion = (expectedVersion: string, sdk: ConvergeSdk, pluginName: string): void => {
+  let runtimeVersion = sdk.config.runtime.ver as string;
+  runtimeVersion = runtimeVersion.replace('^', '');
+  expectedVersion = expectedVersion.replace('^', '');
+
+  if (expectedVersion !== runtimeVersion) {
+    sdk.debug.warn(`The expected SDK version of ${expectedVersion} for the ${pluginName} plugin does not match the current installlation runtime of ${runtimeVersion}`);
+  }
+}
+
+export class SampleAppConvergeSdkPlugin implements IConvergePlugin<ISampleAppBrowserSdkPluginConfig> {
+  constructor(pluginConfig: ISampleAppBrowserSdkPluginConfig) {
+    this.type = "seeka-app-example-name";
+    // this.name = this.type + "-" + pluginConfig.siteId;
+    this.name = this.type;
+    this.version = version;
+    this.sdk = {} as ConvergeSdk;
+    this.config = pluginConfig || {};
+  }
+  sdk: ConvergeSdk;
+
+  privacyConfig = {
+    // TODO
+    requiresIabPurposes: []
+  }
+
+  name: string;
+  type: string;
+  version: string;
+  config: ISampleAppBrowserSdkPluginConfig;
+
+  async init(_params: any): Promise<void> {
+    checkSdkAndPluginVersion(dependencies['@seeka-labs/converge'], this.sdk, this.name)
+  }
+
+  isLoaded(): boolean {
+    return true;
+  }
 }