@capgo/cli 4.0.12 → 4.0.14

package/src/bundle/zip.ts

@@ -1,133 +1,137 @@
-import { randomUUID } from 'node:crypto';
-import { writeFileSync } from 'node:fs';
-import AdmZip from 'adm-zip';
-import { program } from 'commander';
-import * as p from '@clack/prompts';
-import { checksum as getChecksum } from '@tomasklaen/checksum';
-import { checkLatest } from '../api/update';
+import { randomUUID } from 'node:crypto'
+import { writeFileSync } from 'node:fs'
+import process from 'node:process'
+import AdmZip from 'adm-zip'
+import { program } from 'commander'
+import * as p from '@clack/prompts'
+import { checksum as getChecksum } from '@tomasklaen/checksum'
+import { checkLatest } from '../api/update'
+import type {
+  OptionsBase,
+} from '../utils'
 import {
-    OptionsBase,
-    getConfig,
-    useLogSnag,
-    regexSemver,
-} from '../utils';
-import { checkIndexPosition, searchInDirectory } from './check';
+  formatError,
+  getConfig,
+  regexSemver,
+  useLogSnag,
+} from '../utils'
+import { checkIndexPosition, searchInDirectory } from './check'
 
-const alertMb = 20;
+const alertMb = 20
 
 interface Options extends OptionsBase {
-    bundle?: string
-    path?: string
-    codeCheck?: boolean
-    name?: string
-    json?: boolean
+  bundle?: string
+  path?: string
+  codeCheck?: boolean
+  name?: string
+  json?: boolean
 }
 
-export const zipBundle = async (appId: string, options: Options) => {
-    let { bundle, path } = options;
-    const { json } = options
-    const snag = useLogSnag()
-    if (!json)
-        await checkLatest();
+export async function zipBundle(appId: string, options: Options) {
+  let { bundle, path } = options
+  const { json } = options
+  const snag = useLogSnag()
+  if (!json)
+    await checkLatest()
 
-    const config = await getConfig();
-    appId = appId || config?.app?.appId
-    // create bundle name format : 1.0.0-beta.x where x is a uuid
-    const uuid = randomUUID().split('-')[0];
-    bundle = bundle || config?.app?.package?.version || `0.0.1-beta.${uuid}`
-    if (!json)
-        p.intro(`Zipping ${appId}@${bundle}`);
-    // check if bundle is valid 
-    if (!regexSemver.test(bundle)) {
-        if (!json)
-            p.log.error(`Your bundle name ${bundle}, is not valid it should follow semver convention : https://semver.org/`);
-        else
-            console.error(JSON.stringify({ error: 'invalid_semver' }))
-        program.error('');
-    }
-    path = path || config?.app?.webDir
-    if (!appId || !bundle || !path) {
-        if (!json)
-            p.log.error("Missing argument, you need to provide a appId and a bundle and a path, or be in a capacitor project");
-        else
-            console.error(JSON.stringify({ error: 'missing_argument' }))
-        program.error('');
-    }
-    if (!json)
-        p.log.info(`Started from path "${path}"`);
-    const checkNotifyAppReady = options.codeCheck 
-    if (typeof checkNotifyAppReady === 'undefined' || checkNotifyAppReady) {
-        const isPluginConfigured = searchInDirectory(path, 'notifyAppReady')
-        if (!isPluginConfigured) {
-            if (!json)
-                p.log.error(`notifyAppReady() is missing in the source code. see: https://capgo.app/docs/plugin/api/#notifyappready`);
-            else
-                console.error(JSON.stringify({ error: 'notifyAppReady_not_in_source_code' }))
-            program.error('');
-        }
-        const foundIndex = checkIndexPosition(path);
-        if (!foundIndex) {
-            if (!json)
-                p.log.error(`index.html is missing in the root folder or in the only folder in the root folder`);
-            else
-                console.error(JSON.stringify({ error: 'index_html_not_found' }))
-            program.error('');
-        }
-    }
-    const zip = new AdmZip();
-    zip.addLocalFolder(path);
-    const zipped = zip.toBuffer();
-    if (!json)
-        p.log.info(`Zipped ${zipped.byteLength} bytes`);
-    const s = p.spinner()
+  const config = await getConfig()
+  appId = appId || config?.app?.appId
+  // create bundle name format : 1.0.0-beta.x where x is a uuid
+  const uuid = randomUUID().split('-')[0]
+  bundle = bundle || config?.app?.package?.version || `0.0.1-beta.${uuid}`
+  if (!json)
+    p.intro(`Zipping ${appId}@${bundle}`)
+    // check if bundle is valid
+  if (!regexSemver.test(bundle)) {
     if (!json)
-        s.start(`Calculating checksum`);
-    const checksum = await getChecksum(zipped, 'crc32');
+      p.log.error(`Your bundle name ${bundle}, is not valid it should follow semver convention : https://semver.org/`)
+    else
+      console.error(formatError({ error: 'invalid_semver' }))
+    program.error('')
+  }
+  path = path || config?.app?.webDir
+  if (!appId || !bundle || !path) {
     if (!json)
-        s.stop(`Checksum: ${checksum}`);
-    const mbSize = Math.floor(zipped.byteLength / 1024 / 1024);
-    // We do not issue this warning for json
-    if (mbSize > alertMb && !json) {
-        p.log.warn(`WARNING !!\nThe app size is ${mbSize} Mb, this may take a while to download for users\n`);
-        p.log.warn(`Learn how to optimize your assets https://capgo.app/blog/optimise-your-images-for-updates/\n`);
-        await snag.track({
-            channel: 'app-error',
-            event: 'App Too Large',
-            icon: '🚛',
-            tags: {
-                'app-id': appId,
-            },
-            notify: false,
-        }).catch()
+      p.log.error('Missing argument, you need to provide a appId and a bundle and a path, or be in a capacitor project')
+    else
+      console.error(formatError({ error: 'missing_argument' }))
+    program.error('')
+  }
+  if (!json)
+    p.log.info(`Started from path "${path}"`)
+  const checkNotifyAppReady = options.codeCheck
+  if (typeof checkNotifyAppReady === 'undefined' || checkNotifyAppReady) {
+    const isPluginConfigured = searchInDirectory(path, 'notifyAppReady')
+    if (!isPluginConfigured) {
+      if (!json)
+        p.log.error(`notifyAppReady() is missing in the source code. see: https://capgo.app/docs/plugin/api/#notifyappready`)
+      else
+        console.error(formatError({ error: 'notifyAppReady_not_in_source_code' }))
+      program.error('')
     }
-    const s2 = p.spinner()
-    const name = options.name || `${appId}_${bundle}.zip`
-    if (!json)
-        s2.start(`Saving to ${name}`);
-    writeFileSync(name, zipped);
-    if (!json)
-        s2.stop(`Saved to ${name}`);
-
-    if (options.json) {
-      const output = {
-        bundle,
-        filename: name,
-        checksum,
-      };
-      console.log(JSON.stringify(output));
+    const foundIndex = checkIndexPosition(path)
+    if (!foundIndex) {
+      if (!json)
+        p.log.error(`index.html is missing in the root folder or in the only folder in the root folder`)
+      else
+        console.error(formatError({ error: 'index_html_not_found' }))
+      program.error('')
     }
-    
+  }
+  const zip = new AdmZip()
+  zip.addLocalFolder(path)
+  const zipped = zip.toBuffer()
+  if (!json)
+    p.log.info(`Zipped ${zipped.byteLength} bytes`)
+  const s = p.spinner()
+  if (!json)
+    s.start(`Calculating checksum`)
+  const checksum = await getChecksum(zipped, 'crc32')
+  if (!json)
+    s.stop(`Checksum: ${checksum}`)
+  const mbSize = Math.floor(zipped.byteLength / 1024 / 1024)
+  // We do not issue this warning for json
+  if (mbSize > alertMb && !json) {
+    p.log.warn(`WARNING !!\nThe app size is ${mbSize} Mb, this may take a while to download for users\n`)
+    p.log.warn(`Learn how to optimize your assets https://capgo.app/blog/optimise-your-images-for-updates/\n`)
     await snag.track({
-        channel: 'app',
-        event: 'App zip',
-        icon: '⏫',
-        tags: {
-            'app-id': appId,
-        },
-        notify: false,
+      channel: 'app-error',
+      event: 'App Too Large',
+      icon: '🚛',
+      tags: {
+        'app-id': appId,
+      },
+      notify: false,
     }).catch()
+  }
+  const s2 = p.spinner()
+  const name = options.name || `${appId}_${bundle}.zip`
+  if (!json)
+    s2.start(`Saving to ${name}`)
+  writeFileSync(name, zipped)
+  if (!json)
+    s2.stop(`Saved to ${name}`)
 
-    if (!json)
-        p.outro(`Done ✅`);
-    process.exit()
+  if (options.json) {
+    const output = {
+      bundle,
+      filename: name,
+      checksum,
+    }
+    p.log.info(formatError(output))
+  }
+
+  await snag.track({
+    channel: 'app',
+    event: 'App zip',
+    icon: '⏫',
+    tags: {
+      'app-id': appId,
+    },
+    notify: false,
+  }).catch()
+
+  if (!json)
+    p.outro(`Done ✅`)
+  process.exit()
 }

package/src/channel/add.ts

@@ -1,71 +1,73 @@
-import { program } from "commander";
-import * as p from '@clack/prompts';
-import { checkAppExistsAndHasPermissionErr } from "../api/app";
-import { createChannel, findUnknownVersion } from "../api/channels";
-import { OptionsBase, findSavedKey, getConfig, useLogSnag, createSupabaseClient, verifyUser } from "../utils";
+import process from 'node:process'
+import { program } from 'commander'
+import * as p from '@clack/prompts'
+import { checkAppExistsAndHasPermissionErr } from '../api/app'
+import { createChannel, findUnknownVersion } from '../api/channels'
+import type { OptionsBase } from '../utils'
+import { createSupabaseClient, findSavedKey, getConfig, useLogSnag, verifyUser } from '../utils'
 
 interface Options extends OptionsBase {
-    default?: boolean;
+  default?: boolean
 }
 
-export const addChannel = async (channelId: string, appId: string, options: Options, shouldExit = true) => {
-    p.intro(`Create channel`);
-    options.apikey = options.apikey || findSavedKey()
-    const config = await getConfig();
-    appId = appId || config?.app?.appId
-    const snag = useLogSnag()
+export async function addChannel(channelId: string, appId: string, options: Options, shouldExit = true) {
+  p.intro(`Create channel`)
+  options.apikey = options.apikey || findSavedKey()
+  const config = await getConfig()
+  appId = appId || config?.app?.appId
+  const snag = useLogSnag()
 
-    if (!options.apikey) {
-        p.log.error("Missing API key, you need to provide a API key to upload your bundle");
-        program.error('');
-    }
-    if (!appId) {
-        p.log.error("Missing argument, you need to provide a appId, or be in a capacitor project");
-        program.error('');
-    }
-    const supabase = await createSupabaseClient(options.apikey)
+  if (!options.apikey) {
+    p.log.error('Missing API key, you need to provide a API key to upload your bundle')
+    program.error('')
+  }
+  if (!appId) {
+    p.log.error('Missing argument, you need to provide a appId, or be in a capacitor project')
+    program.error('')
+  }
+  const supabase = await createSupabaseClient(options.apikey)
 
-    const userId = await verifyUser(supabase, options.apikey, ['write', 'all']);
-    // Check we have app access to this appId
-    await checkAppExistsAndHasPermissionErr(supabase, options.apikey, appId);
+  const userId = await verifyUser(supabase, options.apikey, ['write', 'all'])
+  // Check we have app access to this appId
+  await checkAppExistsAndHasPermissionErr(supabase, options.apikey, appId)
 
-    p.log.info(`Creating channel ${appId}#${channelId} to Capgo`);
-    try {
-        const data = await findUnknownVersion(supabase, appId)
-        if (!data) {
-            p.log.error(`Cannot find default version for channel creation, please contact Capgo support 🤨`);
-            program.error('');
-        }
-        await createChannel(supabase, {
-            name: channelId,
-            app_id: appId,
-            version: data.id,
-            created_by: userId
-        });
-        p.log.success(`Channel created ✅`);
-        await snag.track({
-            channel: 'channel',
-            event: 'Create channel',
-            icon: '✅',
-            user_id: userId,
-            tags: {
-                'app-id': appId,
-                'channel': channelId,
-            },
-            notify: false,
-        }).catch()
-    } catch (error) {
-        p.log.error(`Cannot create Channel 🙀`);
-        return false
+  p.log.info(`Creating channel ${appId}#${channelId} to Capgo`)
+  try {
+    const data = await findUnknownVersion(supabase, appId)
+    if (!data) {
+      p.log.error(`Cannot find default version for channel creation, please contact Capgo support 🤨`)
+      program.error('')
     }
-    if (shouldExit) {
-        p.outro(`Done ✅`);
-        process.exit()
-    }
-    return true
+    await createChannel(supabase, {
+      name: channelId,
+      app_id: appId,
+      version: data.id,
+      created_by: userId,
+    })
+    p.log.success(`Channel created ✅`)
+    await snag.track({
+      channel: 'channel',
+      event: 'Create channel',
+      icon: '✅',
+      user_id: userId,
+      tags: {
+        'app-id': appId,
+        'channel': channelId,
+      },
+      notify: false,
+    }).catch()
+  }
+  catch (error) {
+    p.log.error(`Cannot create Channel 🙀`)
+    return false
+  }
+  if (shouldExit) {
+    p.outro(`Done ✅`)
+    process.exit()
+  }
+  return true
 }
 
-
-export const addChannelCommand = async (apikey: string, appId: string, options: Options) => {
-    addChannel(apikey, appId, options, true)
+export async function addChannelCommand(apikey: string, appId: string, options: Options) {
+  addChannel(apikey, appId, options, true)
 }

package/src/channel/currentBundle.ts

@@ -1,73 +1,73 @@
-import { program } from "commander";
-import * as p from '@clack/prompts';
-import { checkAppExistsAndHasPermissionErr } from "../api/app";
-import { OptionsBase, createSupabaseClient, findSavedKey, getConfig, verifyUser } from "../utils";
-
+import process from 'node:process'
+import { program } from 'commander'
+import * as p from '@clack/prompts'
+import { checkAppExistsAndHasPermissionErr } from '../api/app'
+import type { OptionsBase } from '../utils'
+import { createSupabaseClient, findSavedKey, getConfig, verifyUser } from '../utils'
 
 interface Options extends OptionsBase {
-    channel?: string,
-    quiet?: boolean
+  channel?: string
+  quiet?: boolean
 }
 
 interface Channel {
-    version: {
-        name: string;
-    }
+  version: {
+    name: string
+  }
 }
 
-export const currentBundle = async (channel: string, appId: string, options: Options) => {
-    const { quiet } = options
+export async function currentBundle(channel: string, appId: string, options: Options) {
+  const { quiet } = options
+
+  if (!quiet)
+    p.intro(`List current bundle`)
 
-    if (!quiet)
-        p.intro(`List current bundle`);
+  options.apikey = options.apikey || findSavedKey(quiet)
+  const config = await getConfig()
+  appId = appId || config?.app?.appId
 
+  if (!options.apikey) {
+    p.log.error('Missing API key, you need to provide a API key to upload your bundle')
+    program.error('')
+  }
+  if (!appId) {
+    p.log.error('Missing argument, you need to provide a appId, or be in a capacitor project')
+    program.error('')
+  }
+  const supabase = await createSupabaseClient(options.apikey)
 
-    options.apikey = options.apikey || findSavedKey(quiet)
-    const config = await getConfig();
-    appId = appId || config?.app?.appId
-  
-    if (!options.apikey) {
-      p.log.error("Missing API key, you need to provide a API key to upload your bundle");
-      program.error('');
-    }
-    if (!appId) {
-      p.log.error("Missing argument, you need to provide a appId, or be in a capacitor project");
-      program.error('');
-    }
-    const supabase = await createSupabaseClient(options.apikey)
-  
-    const userId = await verifyUser(supabase, options.apikey, ['write', 'all', 'read']);
-    // Check we have app access to this appId
-    await checkAppExistsAndHasPermissionErr(supabase, options.apikey, appId);
+  const userId = await verifyUser(supabase, options.apikey, ['write', 'all', 'read'])
+  // Check we have app access to this appId
+  await checkAppExistsAndHasPermissionErr(supabase, options.apikey, appId)
 
-    if (!channel) {
-        p.log.error(`Please provide a channel to get the bundle from.`);
-        program.error('');
-    }
+  if (!channel) {
+    p.log.error(`Please provide a channel to get the bundle from.`)
+    program.error('')
+  }
 
-    const { data: supabaseChannel, error } = await supabase
-        .from('channels')
-        .select('version ( name )') 
-        .eq('name', channel)
-        .eq('app_id', appId)
-        .eq('created_by', userId)
-        .limit(1)
+  const { data: supabaseChannel, error } = await supabase
+    .from('channels')
+    .select('version ( name )')
+    .eq('name', channel)
+    .eq('app_id', appId)
+    .eq('created_by', userId)
+    .limit(1)
 
-    if (error || supabaseChannel.length === 0) {
-        p.log.error(`Error retrieving channel ${channel} for app ${appId}. Perhaps the channel does not exists?`);
-        program.error('');
-    }
+  if (error || supabaseChannel.length === 0) {
+    p.log.error(`Error retrieving channel ${channel} for app ${appId}. Perhaps the channel does not exists?`)
+    program.error('')
+  }
 
-    const { version } = supabaseChannel[0] as any as Channel
-    if (!version) {
-        p.log.error(`Error retrieving channel ${channel} for app ${appId}. Perhaps the channel does not exists?`);
-        program.error('');
-    }
+  const { version } = supabaseChannel[0] as any as Channel
+  if (!version) {
+    p.log.error(`Error retrieving channel ${channel} for app ${appId}. Perhaps the channel does not exists?`)
+    program.error('')
+  }
 
-    if (!quiet)
-        p.log.info(`Current bundle for channel ${channel} is ${version.name}`)
-    else
-        console.log(version.name)
+  if (!quiet)
+    p.log.info(`Current bundle for channel ${channel} is ${version.name}`)
+  else
+    p.log.info(version.name)
 
-    process.exit()
+  process.exit()
 }

package/src/channel/delete.ts

@@ -1,48 +1,51 @@
-import { program } from "commander";
-import * as p from '@clack/prompts';
-import { checkAppExistsAndHasPermissionErr } from "../api/app";
-import { delChannel } from "../api/channels";
-import { OptionsBase, findSavedKey, getConfig, useLogSnag, createSupabaseClient, verifyUser } from "../utils";
+import process from 'node:process'
+import { program } from 'commander'
+import * as p from '@clack/prompts'
+import { checkAppExistsAndHasPermissionErr } from '../api/app'
+import { delChannel } from '../api/channels'
+import type { OptionsBase } from '../utils'
+import { createSupabaseClient, findSavedKey, getConfig, useLogSnag, verifyUser } from '../utils'
 
-export const deleteChannel = async (channelId: string, appId: string, options: OptionsBase) => {
-    p.intro(`Delete channel`);
-    options.apikey = options.apikey || findSavedKey()
-    const config = await getConfig();
-    appId = appId || config?.app?.appId
-    const snag = useLogSnag()
+export async function deleteChannel(channelId: string, appId: string, options: OptionsBase) {
+  p.intro(`Delete channel`)
+  options.apikey = options.apikey || findSavedKey()
+  const config = await getConfig()
+  appId = appId || config?.app?.appId
+  const snag = useLogSnag()
 
-    if (!options.apikey) {
-        p.log.error("Missing API key, you need to provide a API key to upload your bundle");
-        program.error('');
-    }
-    if (!appId) {
-        p.log.error("Missing argument, you need to provide a appId, or be in a capacitor project");
-        program.error('');
-    }
-    const supabase = await createSupabaseClient(options.apikey)
+  if (!options.apikey) {
+    p.log.error('Missing API key, you need to provide a API key to upload your bundle')
+    program.error('')
+  }
+  if (!appId) {
+    p.log.error('Missing argument, you need to provide a appId, or be in a capacitor project')
+    program.error('')
+  }
+  const supabase = await createSupabaseClient(options.apikey)
 
-    const userId = await verifyUser(supabase, options.apikey, ['write', 'all']);
-    // Check we have app access to this appId
-    await checkAppExistsAndHasPermissionErr(supabase, options.apikey, appId);
+  const userId = await verifyUser(supabase, options.apikey, ['write', 'all'])
+  // Check we have app access to this appId
+  await checkAppExistsAndHasPermissionErr(supabase, options.apikey, appId)
 
-    p.log.info(`Deleting channel ${appId}#${channelId} from Capgo`);
-    try {
-        await delChannel(supabase, channelId, appId, userId);
-        p.log.success(`Channel deleted`);
-        await snag.track({
-            channel: 'channel',
-            event: 'Delete channel',
-            icon: '✅',
-            tags: {
-                'user-id': userId,
-                'app-id': appId,
-                'channel': channelId,
-            },
-            notify: false,
-        }).catch()
-    } catch (error) {
-        p.log.error(`Cannot delete Channel 🙀`);
-    }
-    p.outro(`Done ✅`);
-    process.exit()
+  p.log.info(`Deleting channel ${appId}#${channelId} from Capgo`)
+  try {
+    await delChannel(supabase, channelId, appId, userId)
+    p.log.success(`Channel deleted`)
+    await snag.track({
+      channel: 'channel',
+      event: 'Delete channel',
+      icon: '✅',
+      tags: {
+        'user-id': userId,
+        'app-id': appId,
+        'channel': channelId,
+      },
+      notify: false,
+    }).catch()
+  }
+  catch (error) {
+    p.log.error(`Cannot delete Channel 🙀`)
+  }
+  p.outro(`Done ✅`)
+  process.exit()
 }