@vltpkg/cli-sdk 1.0.0-rc.3 → 1.0.0-rc.30

package/dist/esm/start-gui.js

@@ -1,60 +0,0 @@
-import { resolve } from 'node:path';
-import LZString from 'lz-string';
-import { createServer } from '@vltpkg/server';
-import { urlOpen } from '@vltpkg/url-open';
-import { stdout } from "./output.js";
-export const getDefaultStartingRoute = async (options) => {
-    const { queryString = ':root', startingRoute, projectRoot, scurry, } = options;
-    if (startingRoute)
-        return startingRoute;
-    const stat = await scurry.lstat(`${projectRoot}/package.json`);
-    const res = stat?.isFile() && !stat.isSymbolicLink() ?
-        `/explore/${LZString.compressToEncodedURIComponent(queryString)}/overview`
-        : '/dashboard';
-    return res;
-};
-const getAssetsDir = () => {
-    /* c8 ignore start */
-    if (process.env.__VLT_INTERNAL_GUI_ASSETS_DIR) {
-        return resolve(import.meta.dirname, process.env.__VLT_INTERNAL_GUI_ASSETS_DIR);
-    }
-    /* c8 ignore stop */
-};
-export const startGUI = async (conf, startingRoute) => {
-    /* c8 ignore start */
-    const allowScripts = conf.get('allow-scripts') ?
-        String(conf.get('allow-scripts'))
-        : ':not(*)';
-    /* c8 ignore stop */
-    const server = createServer({
-        ...conf.options,
-        assetsDir: getAssetsDir(),
-        loadedConfig: conf,
-        allowScripts,
-    });
-    server.on('needConfigUpdate', async (dir) => {
-        conf.resetOptions(dir);
-        const listeningServer = server;
-        listeningServer.updateOptions({ ...conf.options, allowScripts });
-        await conf
-            .reloadFromDisk()
-            .then(() => {
-            listeningServer.updateOptions({
-                ...conf.options,
-                allowScripts,
-            });
-        })
-            .catch(() => { });
-    });
-    const { projectRoot, scurry } = conf.options;
-    await server.start();
-    stdout(`⚡️ vlt UI running at ${server.address()}`);
-    void urlOpen(server.address(await getDefaultStartingRoute({
-        queryString: conf.values.target,
-        startingRoute,
-        projectRoot,
-        scurry,
-    })));
-    return server;
-};
-//# sourceMappingURL=start-gui.js.map

package/dist/esm/start-gui.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"start-gui.js","sourceRoot":"","sources":["../../src/start-gui.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACnC,OAAO,QAAQ,MAAM,WAAW,CAAA;AAChC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAA;AAC1C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAKpC,MAAM,CAAC,MAAM,uBAAuB,GAAG,KAAK,EAAE,OAK7C,EAAE,EAAE;IACH,MAAM,EACJ,WAAW,GAAG,OAAO,EACrB,aAAa,EACb,WAAW,EACX,MAAM,GACP,GAAG,OAAO,CAAA;IACX,IAAI,aAAa;QAAE,OAAO,aAAa,CAAA;IACvC,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,GAAG,WAAW,eAAe,CAAC,CAAA;IAC9D,MAAM,GAAG,GACP,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC;QACxC,YAAY,QAAQ,CAAC,6BAA6B,CAAC,WAAW,CAAC,WAAW;QAC5E,CAAC,CAAC,YAAY,CAAA;IAChB,OAAO,GAAG,CAAA;AACZ,CAAC,CAAA;AAED,MAAM,YAAY,GAAG,GAAG,EAAE;IACxB,qBAAqB;IACrB,IAAI,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE,CAAC;QAC9C,OAAO,OAAO,CACZ,MAAM,CAAC,IAAI,CAAC,OAAO,EACnB,OAAO,CAAC,GAAG,CAAC,6BAA6B,CAC1C,CAAA;IACH,CAAC;IACD,oBAAoB;AACtB,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,QAAQ,GAAG,KAAK,EAC3B,IAAkB,EAClB,aAAsB,EACtB,EAAE;IACF,qBAAqB;IACrB,MAAM,YAAY,GAChB,IAAI,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC;QACzB,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;QACnC,CAAC,CAAC,SAAS,CAAA;IACb,oBAAoB;IACpB,MAAM,MAAM,GAAG,YAAY,CAAC;QAC1B,GAAG,IAAI,CAAC,OAAO;QACf,SAAS,EAAE,YAAY,EAAE;QACzB,YAAY,EAAE,IAAI;QAClB,YAAY;KACb,CAAC,CAAA;IACF,MAAM,CAAC,EAAE,CAAC,kBAAkB,EAAE,KAAK,EAAC,GAAG,EAAC,EAAE;QACxC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAA;QACtB,MAAM,eAAe,GAAG,MAA4B,CAAA;QACpD,eAAe,CAAC,aAAa,CAAC,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,YAAY,EAAE,CAAC,CAAA;QAChE,MAAM,IAAI;aACP,cAAc,EAAE;aAChB,IAAI,CAAC,GAAG,EAAE;YACT,eAAe,CAAC,aAAa,CAAC;gBAC5B,GAAG,IAAI,CAAC,OAAO;gBACf,YAAY;aACb,CAAC,CAAA;QACJ,CAAC,CAAC;aACD,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAA;IACpB,CAAC,CAAC,CAAA;IACF,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAA;IAC5C,MAAM,MAAM,CAAC,KAAK,EAAE,CAAA;IACpB,MAAM,CAAC,wBAAwB,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;IAClD,KAAK,OAAO,CACV,MAAM,CAAC,OAAO,CACZ,MAAM,uBAAuB,CAAC;QAC5B,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM;QAC/B,aAAa;QACb,WAAW;QACX,MAAM;KACP,CAAC,CACH,CACF,CAAA;IACD,OAAO,MAAM,CAAA;AACf,CAAC,CAAA","sourcesContent":["import { resolve } from 'node:path'\nimport LZString from 'lz-string'\nimport { createServer } from '@vltpkg/server'\nimport { urlOpen } from '@vltpkg/url-open'\nimport { stdout } from './output.ts'\nimport type { PathScurry } from 'path-scurry'\nimport type { LoadedConfig } from './config/index.ts'\nimport type { VltServerListening } from '@vltpkg/server'\n\nexport const getDefaultStartingRoute = async (options: {\n  queryString?: string\n  startingRoute?: string\n  projectRoot: string\n  scurry: PathScurry\n}) => {\n  const {\n    queryString = ':root',\n    startingRoute,\n    projectRoot,\n    scurry,\n  } = options\n  if (startingRoute) return startingRoute\n  const stat = await scurry.lstat(`${projectRoot}/package.json`)\n  const res =\n    stat?.isFile() && !stat.isSymbolicLink() ?\n      `/explore/${LZString.compressToEncodedURIComponent(queryString)}/overview`\n    : '/dashboard'\n  return res\n}\n\nconst getAssetsDir = () => {\n  /* c8 ignore start */\n  if (process.env.__VLT_INTERNAL_GUI_ASSETS_DIR) {\n    return resolve(\n      import.meta.dirname,\n      process.env.__VLT_INTERNAL_GUI_ASSETS_DIR,\n    )\n  }\n  /* c8 ignore stop */\n}\n\nexport const startGUI = async (\n  conf: LoadedConfig,\n  startingRoute?: string,\n) => {\n  /* c8 ignore start */\n  const allowScripts =\n    conf.get('allow-scripts') ?\n      String(conf.get('allow-scripts'))\n    : ':not(*)'\n  /* c8 ignore stop */\n  const server = createServer({\n    ...conf.options,\n    assetsDir: getAssetsDir(),\n    loadedConfig: conf,\n    allowScripts,\n  })\n  server.on('needConfigUpdate', async dir => {\n    conf.resetOptions(dir)\n    const listeningServer = server as VltServerListening\n    listeningServer.updateOptions({ ...conf.options, allowScripts })\n    await conf\n      .reloadFromDisk()\n      .then(() => {\n        listeningServer.updateOptions({\n          ...conf.options,\n          allowScripts,\n        })\n      })\n      .catch(() => {})\n  })\n  const { projectRoot, scurry } = conf.options\n  await server.start()\n  stdout(`⚡️ vlt UI running at ${server.address()}`)\n  void urlOpen(\n    server.address(\n      await getDefaultStartingRoute({\n        queryString: conf.values.target,\n        startingRoute,\n        projectRoot,\n        scurry,\n      }),\n    ),\n  )\n  return server\n}\n"]}

package/dist/esm/view.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"view.d.ts","sourceRoot":"","sources":["../../src/view.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAErD,MAAM,MAAM,WAAW,GAAG;IAAE,MAAM,CAAC,EAAE,OAAO,CAAA;CAAE,CAAA;AAE9C;;;;;;;;;;GAUG;AACH,qBAAa,SAAS,CAAC,CAAC,GAAG,OAAO;IAChC,OAAO,EAAE,WAAW,CAAA;IACpB,MAAM,EAAE,YAAY,CAAA;gBAER,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,YAAY;IAQtD,KAAK;IACC,IAAI,CAAC,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAGjE,KAAK,CAAC,IAAI,EAAE,OAAO;CACpB;AAED,MAAM,MAAM,MAAM,CAAC,CAAC,GAAG,OAAO,IAAI,CAChC,MAAM,EAAE,CAAC,EACT,OAAO,EAAE,WAAW,EACpB,IAAI,EAAE,YAAY,KACf,OAAO,CAAA;AAEZ,MAAM,MAAM,IAAI,CAAC,CAAC,GAAG,OAAO,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,OAAO,SAAS,CAAC,CAAC,CAAC,CAAA;AAE/D,eAAO,MAAM,WAAW,GAAI,CAAC,kBACrB,IAAI,CAAC,CAAC,CAAC,KACZ,IAAI,IAAI,OAAO,SAAS,CAAC,CAAC,CAGQ,CAAA;AAErC,MAAM,MAAM,KAAK,CAAC,CAAC,GAAG,OAAO,IAAI,IAAI,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA"}

package/dist/esm/view.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"view.js","sourceRoot":"","sources":["../../src/view.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;GAUG;AACH,MAAM,OAAO,SAAS;IACpB,OAAO,CAAa;IACpB,MAAM,CAAc;IAEpB,YAAY,OAAoB,EAAE,MAAoB;QACpD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED,oEAAoE;IACpE,wEAAwE;IACxE,wEAAwE;IACxE,KAAK,KAAI,CAAC;IACV,KAAK,CAAC,IAAI,CAAC,OAAU,EAAE,KAAuB;QAC5C,OAAM;IACR,CAAC;IACD,KAAK,CAAC,IAAa,IAAG,CAAC;CACxB;AAUD,MAAM,CAAC,MAAM,WAAW,GAAG,CACzB,IAAa,EACgB,EAAE,CAC/B,OAAO,IAAI,KAAK,UAAU;IAC1B,WAAW,IAAI,IAAI;IACnB,IAAI,CAAC,SAAS,YAAY,SAAS,CAAA","sourcesContent":["import type { LoadedConfig } from './config/index.ts'\n\nexport type ViewOptions = { colors?: boolean }\n\n/**\n * The base class for all View classes\n *\n * Do not override the constructor, just provide start/done/error methods.\n *\n * These classes should be used as one or more of the exported views for\n * commands that need to know when the processing starts, handle errors in\n * various ways, etc. Fancy stuff.\n *\n * For simple use cases, usually better to create a {@link ViewFn} instead.\n */\nexport class ViewClass<T = unknown> {\n  options: ViewOptions\n  config: LoadedConfig\n\n  constructor(options: ViewOptions, config: LoadedConfig) {\n    this.options = options\n    this.config = config\n  }\n\n  // TODO: maybe have start() return a flag to say \"i got this, do not\n  // run the command\", for example to have the gui just open a web browser\n  // to the page relevant to a given thing, rather than computing it twice\n  start() {}\n  async done(_result: T, _opts: { time: number }): Promise<unknown> {\n    return\n  }\n  error(_err: unknown) {}\n}\n\nexport type ViewFn<T = unknown> = (\n  result: T,\n  options: ViewOptions,\n  conf: LoadedConfig,\n) => unknown\n\nexport type View<T = unknown> = ViewFn<T> | typeof ViewClass<T>\n\nexport const isViewClass = <T = unknown>(\n  view: View<T>,\n): view is typeof ViewClass<T> =>\n  typeof view === 'function' &&\n  'prototype' in view &&\n  view.prototype instanceof ViewClass\n\nexport type Views<T = unknown> = View<T> | Record<string, View<T>>\n"]}