@ms-cloudpack/cli 0.72.55 → 0.72.57

package/lib/utilities/selectItemFromPaginatedResults.js

@@ -0,0 +1,60 @@
+import prompts from 'prompts';
+const loadMoreValue = 'load_more';
+const moveUpCursor = '\x1b[1A';
+/**
+ * Presents an interactive prompt that lists accumulated items plus a "Load More" option.
+ * When "Load More" is selected, it fetches the next page and updates the list.
+ *
+ * @returns The entity selected by the user or null if nothing is chosen.
+ */
+export async function selectItemFromPaginatedResults(params) {
+    const { message, getPage, getTitle, defaultPageSize = 10 } = params;
+    let continuationToken = undefined;
+    let accumulatedItems = [];
+    let response;
+    // Do-while loop to continue fetching pages until user selects an item or no more pages are available
+    do {
+        const previousLength = accumulatedItems.length;
+        // If no items have been loaded yet or if more pages exist, load the next page
+        if (accumulatedItems.length === 0 || continuationToken) {
+            const page = await getPage({ continuationToken, maxPageSize: defaultPageSize });
+            accumulatedItems = accumulatedItems.concat(page.items);
+            continuationToken = page.continuationToken;
+        }
+        const choices = accumulatedItems.map((item, index) => ({
+            title: getTitle(item),
+            value: index.toString(),
+        }));
+        // If more pages exist, add a "Load More" option at the end
+        if (continuationToken) {
+            choices.push({
+                title: 'Load More',
+                value: loadMoreValue,
+            });
+        }
+        // Display the selectable list
+        response = await prompts({
+            type: 'select',
+            name: 'selected',
+            message: continuationToken ? `${message} (or choose "Load More" to fetch more results)` : message,
+            choices,
+            initial: previousLength,
+        });
+        // Check if the user selected "Load More" or a valid item
+        if (response.selected === loadMoreValue) {
+            // Move the cursor up to overwrite the prompt with the new list
+            process.stdout.write(moveUpCursor);
+        }
+        else if (response.selected) {
+            // Return the chosen entity
+            return accumulatedItems[parseInt(response.selected)];
+        }
+        else {
+            // In case of no selection, return null
+            return null;
+        }
+    } while (continuationToken && response.selected === loadMoreValue);
+    // Return null if no valid selection was made
+    return null;
+}
+//# sourceMappingURL=selectItemFromPaginatedResults.js.map

package/lib/utilities/selectItemFromPaginatedResults.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"selectItemFromPaginatedResults.js","sourceRoot":"","sources":["../../src/utilities/selectItemFromPaginatedResults.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,SAAS,CAAC;AAE9B,MAAM,aAAa,GAAG,WAAW,CAAC;AAClC,MAAM,YAAY,GAAG,SAAS,CAAC;AAgB/B;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,8BAA8B,CAClD,MAAgD;IAEhD,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,eAAe,GAAG,EAAE,EAAE,GAAG,MAAM,CAAC;IACpE,IAAI,iBAAiB,GAAuB,SAAS,CAAC;IACtD,IAAI,gBAAgB,GAAQ,EAAE,CAAC;IAC/B,IAAI,QAA8B,CAAC;IAEnC,qGAAqG;IACrG,GAAG,CAAC;QACF,MAAM,cAAc,GAAG,gBAAgB,CAAC,MAAM,CAAC;QAE/C,8EAA8E;QAC9E,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,IAAI,iBAAiB,EAAE,CAAC;YACvD,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,EAAE,iBAAiB,EAAE,WAAW,EAAE,eAAe,EAAE,CAAC,CAAC;YAChF,gBAAgB,GAAG,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACvD,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAC;QAC7C,CAAC;QAED,MAAM,OAAO,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;YACrD,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC;YACrB,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE;SACxB,CAAC,CAAC,CAAC;QAEJ,2DAA2D;QAC3D,IAAI,iBAAiB,EAAE,CAAC;YACtB,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,WAAW;gBAClB,KAAK,EAAE,aAAa;aACrB,CAAC,CAAC;QACL,CAAC;QAED,8BAA8B;QAC9B,QAAQ,GAAG,MAAM,OAAO,CAAC;YACvB,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,UAAU;YAChB,OAAO,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAAG,OAAO,gDAAgD,CAAC,CAAC,CAAC,OAAO;YACjG,OAAO;YACP,OAAO,EAAE,cAAc;SACxB,CAAC,CAAC;QAEH,yDAAyD;QACzD,IAAI,QAAQ,CAAC,QAAQ,KAAK,aAAa,EAAE,CAAC;YACxC,+DAA+D;YAC/D,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QACrC,CAAC;aAAM,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC;YAC7B,2BAA2B;YAC3B,OAAO,gBAAgB,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;QACvD,CAAC;aAAM,CAAC;YACN,uCAAuC;YACvC,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC,QAAQ,iBAAiB,IAAI,QAAQ,CAAC,QAAQ,KAAK,aAAa,EAAE;IAEnE,6CAA6C;IAC7C,OAAO,IAAI,CAAC;AACd,CAAC","sourcesContent":["import type { PageSettings, PagedResult } from '@ms-cloudpack/remote-cache';\nimport prompts from 'prompts';\n\nconst loadMoreValue = 'load_more';\nconst moveUpCursor = '\\x1b[1A';\n\ninterface SelectItemsFromPaginatedResultsParams<T> {\n  /** The message to display to the user when selecting an item. */\n  message: string;\n\n  /** A function that fetches a page of items. */\n  getPage: (pageSettings: PageSettings) => Promise<PagedResult<T>>;\n\n  /** A function that returns a string to display for each item in the list. */\n  getTitle: (item: T) => string;\n\n  /** The default page size to use when fetching items. @default 10. */\n  defaultPageSize?: number;\n}\n\n/**\n * Presents an interactive prompt that lists accumulated items plus a \"Load More\" option.\n * When \"Load More\" is selected, it fetches the next page and updates the list.\n *\n * @returns The entity selected by the user or null if nothing is chosen.\n */\nexport async function selectItemFromPaginatedResults<T>(\n  params: SelectItemsFromPaginatedResultsParams<T>,\n): Promise<T | null> {\n  const { message, getPage, getTitle, defaultPageSize = 10 } = params;\n  let continuationToken: string | undefined = undefined;\n  let accumulatedItems: T[] = [];\n  let response: { selected: string };\n\n  // Do-while loop to continue fetching pages until user selects an item or no more pages are available\n  do {\n    const previousLength = accumulatedItems.length;\n\n    // If no items have been loaded yet or if more pages exist, load the next page\n    if (accumulatedItems.length === 0 || continuationToken) {\n      const page = await getPage({ continuationToken, maxPageSize: defaultPageSize });\n      accumulatedItems = accumulatedItems.concat(page.items);\n      continuationToken = page.continuationToken;\n    }\n\n    const choices = accumulatedItems.map((item, index) => ({\n      title: getTitle(item),\n      value: index.toString(),\n    }));\n\n    // If more pages exist, add a \"Load More\" option at the end\n    if (continuationToken) {\n      choices.push({\n        title: 'Load More',\n        value: loadMoreValue,\n      });\n    }\n\n    // Display the selectable list\n    response = await prompts({\n      type: 'select',\n      name: 'selected',\n      message: continuationToken ? `${message} (or choose \"Load More\" to fetch more results)` : message,\n      choices,\n      initial: previousLength,\n    });\n\n    // Check if the user selected \"Load More\" or a valid item\n    if (response.selected === loadMoreValue) {\n      // Move the cursor up to overwrite the prompt with the new list\n      process.stdout.write(moveUpCursor);\n    } else if (response.selected) {\n      // Return the chosen entity\n      return accumulatedItems[parseInt(response.selected)];\n    } else {\n      // In case of no selection, return null\n      return null;\n    }\n  } while (continuationToken && response.selected === loadMoreValue);\n\n  // Return null if no valid selection was made\n  return null;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ms-cloudpack/cli",
-  "version": "0.72.55",
+  "version": "0.72.57",
   "description": "The Cloudpack command line interface - a tool for managing fast inner and outer looping in web apps.",
   "license": "MIT",
   "type": "module",
@@ -10,18 +10,18 @@
     "cloudpack": "./bin/cloudpack.js"
   },
   "dependencies": {
-    "@ms-cloudpack/api-server": "^0.60.1",
-    "@ms-cloudpack/app-server": "^0.17.50",
+    "@ms-cloudpack/api-server": "^0.61.0",
+    "@ms-cloudpack/app-server": "^0.17.52",
     "@ms-cloudpack/bundler": "^0.24.0",
     "@ms-cloudpack/common-types": "^0.24.7",
     "@ms-cloudpack/config": "^0.33.16",
     "@ms-cloudpack/environment": "^0.1.1",
     "@ms-cloudpack/json-utilities": "^0.1.10",
-    "@ms-cloudpack/overlay": "^0.17.131",
+    "@ms-cloudpack/overlay": "^0.17.133",
     "@ms-cloudpack/package-utilities": "^11.3.4",
     "@ms-cloudpack/path-string-parsing": "^1.2.6",
     "@ms-cloudpack/path-utilities": "^3.0.4",
-    "@ms-cloudpack/remote-cache": "^0.10.10",
+    "@ms-cloudpack/remote-cache": "^0.10.11",
     "@ms-cloudpack/setup-utilities": "^0.5.14",
     "@ms-cloudpack/task-reporter": "^0.15.1",
     "@ms-cloudpack/telemetry": "^0.10.14",

package/lib/utilities/discoverAppPaths.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"discoverAppPaths.d.ts","sourceRoot":"","sources":["../../src/utilities/discoverAppPaths.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAEnE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AAE7E,MAAM,MAAM,sBAAsB,GAAG,KAAK,CAAC;AAE3C;;;;;;;GAOG;AACH,wBAAsB,gBAAgB,CAAC,MAAM,EAAE;IAC7C,uCAAuC;IACvC,GAAG,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,QAAQ,CAAC,EAAE,oBAAoB,CAAC;IAEhC;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,GAAG,OAAO,CAAC,MAAM,EAAE,GAAG,iBAAiB,CAAC,CAiFxC"}

package/lib/utilities/discoverAppPaths.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"discoverAppPaths.js","sourceRoot":"","sources":["../../src/utilities/discoverAppPaths.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,OAAwB,MAAM,SAAS,CAAC;AAE/C,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAKzD;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,MAiBtC;IACC,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;IAC7C,MAAM,QAAQ,GAAG,QAAQ,KAAK,OAAO,CAAC;IAEtC,IAAI,CAAC,UAAU,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,iBAAiB,CAAC,CAAC,EAAE,CAAC;QACpE,mFAAmF;QACnF,OAAO,CAAC,GAAG,CAAC,CAAC;IACf,CAAC;IAED,6EAA6E;IAC7E,MAAM,iBAAiB,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,iBAAiB,EAAE,CAAC,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,oBAAoB,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CACnH,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAC7C,CAAC;IAEF,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,CAAC;QAC9B,0FAA0F;QAC1F,oBAAoB;QACpB,iBAAiB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC9B,CAAC;IAED,IAAI,CAAC,UAAU,IAAI,CAAC,QAAQ,IAAI,iBAAiB,CAAC,MAAM,KAAK,CAAC,CAAC,EAAE,CAAC;QAChE,6EAA6E;QAC7E,uCAAuC;QACvC,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED,8EAA8E;IAC9E,oEAAoE;IACpE,MAAM,QAAQ,GAAG,IAAI,kBAAkB,EAAE,CAAC;IAC1C,MAAM,UAAU,GAAG,CACjB,MAAM,OAAO,CAAC,GAAG,CACf,iBAAiB,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;QAClC,MAAM,GAAG,GAAG,MAAM,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACpC,OAAO;YACL,KAAK,EAAE,GAAG,CAAC,IAAI;YACf,WAAW,EAAE,GAAG,EAAE,WAAW,IAAI,0EAA0E;YAC3G,KAAK,EAAE,GAAG;SACX,CAAC;IACJ,CAAC,CAAC,CACH,CACF;SACE,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,UAAU,IAAI,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;SACpE,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;IAEtD,uDAAuD;IACvD,IAAI,UAAU,EAAE,CAAC;QACf,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;YACvB,OAAO;gBACL,OAAO,EAAE,8CAA8C,UAAU,IAAI;gBACrE,SAAS,EAAE,IAAI;aAChB,CAAC;QACJ,CAAC;QAED,wBAAwB;QACxB,MAAM,UAAU,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,KAAK,UAAU,CAAC,CAAC;QAC5E,IAAI,UAAU,EAAE,CAAC;YACf,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAC5B,CAAC;QAED,6EAA6E;QAC7E,IAAI,QAAQ,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACxC,yEAAyE;YACzE,OAAO,UAAU,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAClD,CAAC;IACH,CAAC;IAED,kEAAkE;IAClE,0DAA0D;IAC1D,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAyB;QACrD,IAAI,EAAE,QAAQ;QACd,IAAI,EAAE,KAAK;QACX,OAAO,EAAE,kCAAkC;QAC3C,OAAO,EAAE,UAAU;KACpB,CAAC,CAAC;IAEH,wDAAwD;IACxD,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;QAClB,OAAO,EAAE,aAAa,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;IAC9C,CAAC;IAED,OAAO,CAAC,QAAQ,CAAC,GAAa,CAAC,CAAC;AAClC,CAAC","sourcesContent":["import { PackageDefinitions } from '@ms-cloudpack/package-utilities';\nimport glob from 'fast-glob';\nimport fs from 'fs';\nimport path from 'path';\nimport prompts, { type Choice } from 'prompts';\nimport type { CommandExitParams } from '../types/CommandAction.js';\nimport { appConfigFileName } from '@ms-cloudpack/config';\nimport type { AppPathDiscoveryMode } from '../types/AppPathDiscoveryMode.js';\n\nexport type _AppPromptQuestionName = 'app';\n\n/**\n * Gets the appPath from which Cloudpack will run. If the CWD is a Cloudpack-enabled app,\n * we'll use that; otherwise, we'll scan for Cloudpack-enabled app and present the user\n * with a menu. If no apps are found, Cloudpack will just try to run in the CWD anyway.\n *\n * @returns App path(s) (just one unless `discover: 'multi'`), or an exit options object if\n * there was an error.\n */\nexport async function discoverAppPaths(params: {\n  /** Working directory to start from. */\n  cwd: string;\n\n  /**\n   * How to determine the app path(s). (`--app` in the docs refers to `desiredApp` here.)\n   * @default 'single'\n   */\n  discover?: AppPathDiscoveryMode;\n\n  /**\n   * Desired app name or substring, from the `--app` option.\n   * - If there's an exact match, only that app will be returned.\n   * - If multiple apps match a substring, see `discover` for behavior.\n   * - If no match, it's an error.\n   */\n  desiredApp?: string;\n}): Promise<string[] | CommandExitParams> {\n  const { cwd, desiredApp, discover } = params;\n  const multiApp = discover === 'multi';\n\n  if (!desiredApp && fs.existsSync(path.join(cwd, appConfigFileName))) {\n    // If no specific app was requested, and the cwd is a cloudpack app, just use that.\n    return [cwd];\n  }\n\n  // Get all cloudpack app paths based on the presence of cloudpack.config.json\n  const cloudpackAppPaths = (glob.sync([`**/${appConfigFileName}`], { cwd, ignore: ['**/node_modules/**'] }) ?? []).map(\n    (file) => path.join(cwd, path.dirname(file)),\n  );\n\n  if (!cloudpackAppPaths.length) {\n    // Include the cwd if there are no configs found, since it's possible to run start or init\n    // without a config.\n    cloudpackAppPaths.push(cwd);\n  }\n\n  if (!desiredApp && (multiApp || cloudpackAppPaths.length === 1)) {\n    // Return all apps found if we're in multi-app mode or only one app was found\n    // (and no specific app was requested).\n    return cloudpackAppPaths;\n  }\n\n  // Get each app's name and description, filtered by `desiredApp` if specified.\n  // (These use Choice format in case they're later used in a prompt.)\n  const packages = new PackageDefinitions();\n  const appChoices = (\n    await Promise.all<Omit<Choice, 'value'> & { value: string }>(\n      cloudpackAppPaths.map(async (dir) => {\n        const pkg = await packages.get(dir);\n        return {\n          title: pkg.name,\n          description: pkg?.description ?? 'An awesome app that would be even more awesome with a proper description',\n          value: dir,\n        };\n      }),\n    )\n  )\n    .filter((choice) => !desiredApp || choice.title.includes(desiredApp))\n    .sort((c1, c2) => c1.title.localeCompare(c2.title));\n\n  // Figure out if there are any matches for `desiredApp`\n  if (desiredApp) {\n    if (!appChoices.length) {\n      return {\n        message: `No Cloudpack apps found matching the name \"${desiredApp}\".`,\n        hasErrors: true,\n      };\n    }\n\n    // Prefer an exact match\n    const exactMatch = appChoices.find((choice) => choice.title === desiredApp);\n    if (exactMatch) {\n      return [exactMatch.value];\n    }\n\n    // If there's no exact match, it means at least one substring match was found\n    if (multiApp || appChoices.length === 1) {\n      // Return them all if we're in multi-app mode or only one match was found\n      return appChoices.map((choice) => choice.value);\n    }\n  }\n\n  // There are multiple candidates, so prompt the user to choose one\n  // (implicitly, we're in single-app mode if we reach here)\n  const response = await prompts<_AppPromptQuestionName>({\n    type: 'select',\n    name: 'app',\n    message: 'Select the app you want to start',\n    choices: appChoices,\n  });\n\n  // This will be undefined if the user cancels the prompt\n  if (!response.app) {\n    return { isInterrupted: true, message: '' };\n  }\n\n  return [response.app as string];\n}\n"]}