@arizeai/phoenix-cli 0.11.0 → 0.11.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/build/banner.d.ts CHANGED
@@ -1,5 +1,26 @@
1
1
  /**
2
- * Print the Phoenix CLI banner with connection info aligned to the right of the logo.
2
+ * Text shown below the Phoenix logo.
3
3
  */
4
- export declare function printBanner(): void;
4
+ export interface BannerInfoLinesOptions {
5
+ serverUrl: string;
6
+ project: string;
7
+ hasApiKey: boolean;
8
+ currentVersion: string;
9
+ latestVersion?: string;
10
+ hasUpdate?: boolean;
11
+ }
12
+ /**
13
+ * Build the informational text displayed below the Phoenix logo.
14
+ */
15
+ export declare function getBannerInfoLines({ serverUrl, project, hasApiKey, currentVersion, latestVersion, hasUpdate, }: BannerInfoLinesOptions): string[];
16
+ /**
17
+ * Render the full banner with the logo first and metadata below it.
18
+ */
19
+ export declare function renderBanner({ infoLines }: {
20
+ infoLines: string[];
21
+ }): string;
22
+ /**
23
+ * Print the Phoenix CLI banner with connection and update info aligned to the right of the logo.
24
+ */
25
+ export declare function printBanner(): Promise<void>;
5
26
  //# sourceMappingURL=banner.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"banner.d.ts","sourceRoot":"","sources":["../src/banner.ts"],"names":[],"mappings":"AASA;;GAEG;AACH,wBAAgB,WAAW,IAAI,IAAI,CAiBlC"}
1
+ {"version":3,"file":"banner.d.ts","sourceRoot":"","sources":["../src/banner.ts"],"names":[],"mappings":"AAWA;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,OAAO,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,EACjC,SAAS,EACT,OAAO,EACP,SAAS,EACT,cAAc,EACd,aAAa,EACb,SAAS,GACV,EAAE,sBAAsB,GAAG,MAAM,EAAE,CAYnC;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,EAAE,SAAS,EAAE,EAAE;IAAE,SAAS,EAAE,MAAM,EAAE,CAAA;CAAE,GAAG,MAAM,CAE3E;AAED;;GAEG;AACH,wBAAsB,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC,CAcjD"}
package/build/banner.js CHANGED
@@ -1,27 +1,49 @@
1
1
  import { loadConfigFromEnvironment } from "./config.js";
2
2
  import { writeOutput } from "./io.js";
3
+ import { getCliVersionStatus } from "./version.js";
3
4
  const LOGO_LINES = [
4
5
  "░█▀█░█░█░█▀█░█▀▀░█▀█░▀█▀░█░█",
5
6
  "░█▀▀░█▀█░█░█░█▀▀░█░█░░█░░▄▀▄",
6
7
  "░▀░░░▀░▀░▀▀▀░▀▀▀░▀░▀░▀▀▀░▀░▀",
7
8
  ];
9
+ const TAGLINE = "CLI for interacting with your phoenix server";
8
10
  /**
9
- * Print the Phoenix CLI banner with connection info aligned to the right of the logo.
11
+ * Build the informational text displayed below the Phoenix logo.
10
12
  */
11
- export function printBanner() {
12
- const config = loadConfigFromEnvironment();
13
- const serverUrl = config.endpoint ?? "not set";
14
- const project = config.project ?? "not set";
15
- const infoLines = [
16
- ` Server: ${serverUrl}`,
17
- ` Project: ${project}`,
18
- ...(config.apiKey ? [` API Key: set`] : []),
13
+ export function getBannerInfoLines({ serverUrl, project, hasApiKey, currentVersion, latestVersion, hasUpdate, }) {
14
+ return [
15
+ `Server: ${serverUrl}`,
16
+ `Project: ${project}`,
17
+ ...(hasApiKey ? [`API Key: set`] : []),
18
+ `Version: v${currentVersion}`,
19
+ ...(hasUpdate && latestVersion
20
+ ? [
21
+ `Update: v${latestVersion} available. Run npm install -g @arizeai/phoenix-cli`,
22
+ ]
23
+ : []),
19
24
  ];
20
- const output = LOGO_LINES.map((logo, index) => {
21
- const info = infoLines[index];
22
- return info ? `${logo}${info}` : logo;
25
+ }
26
+ /**
27
+ * Render the full banner with the logo first and metadata below it.
28
+ */
29
+ export function renderBanner({ infoLines }) {
30
+ return [...LOGO_LINES, "", TAGLINE, "", ...infoLines].join("\n");
31
+ }
32
+ /**
33
+ * Print the Phoenix CLI banner with connection and update info aligned to the right of the logo.
34
+ */
35
+ export async function printBanner() {
36
+ const config = loadConfigFromEnvironment();
37
+ const versionStatus = await getCliVersionStatus();
38
+ const infoLines = getBannerInfoLines({
39
+ serverUrl: config.endpoint ?? "not set",
40
+ project: config.project ?? "not set",
41
+ hasApiKey: Boolean(config.apiKey),
42
+ currentVersion: versionStatus.currentVersion,
43
+ latestVersion: versionStatus.latestVersion,
44
+ hasUpdate: versionStatus.hasUpdate,
23
45
  });
24
- writeOutput({ message: output.join("\n") });
46
+ writeOutput({ message: renderBanner({ infoLines }) });
25
47
  writeOutput({ message: "" });
26
48
  }
27
49
  //# sourceMappingURL=banner.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"banner.js","sourceRoot":"","sources":["../src/banner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,MAAM,UAAU,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,MAAM,CAAC;AAEnC,MAAM,UAAU,GAAG;IACjB,8BAA8B;IAC9B,8BAA8B;IAC9B,8BAA8B;CAC/B,CAAC;AAEF;;GAEG;AACH,MAAM,UAAU,WAAW;IACzB,MAAM,MAAM,GAAG,yBAAyB,EAAE,CAAC;IAC3C,MAAM,SAAS,GAAG,MAAM,CAAC,QAAQ,IAAI,SAAS,CAAC;IAC/C,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,IAAI,SAAS,CAAC;IAC5C,MAAM,SAAS,GAAG;QAChB,cAAc,SAAS,EAAE;QACzB,cAAc,OAAO,EAAE;QACvB,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;KAC7C,CAAC;IAEF,MAAM,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;QAC5C,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;QAC9B,OAAO,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,WAAW,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC5C,WAAW,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;AAC/B,CAAC"}
1
+ {"version":3,"file":"banner.js","sourceRoot":"","sources":["../src/banner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,MAAM,UAAU,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,MAAM,CAAC;AACnC,OAAO,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAC;AAEhD,MAAM,UAAU,GAAG;IACjB,8BAA8B;IAC9B,8BAA8B;IAC9B,8BAA8B;CAC/B,CAAC;AACF,MAAM,OAAO,GAAG,8CAA8C,CAAC;AAc/D;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAAC,EACjC,SAAS,EACT,OAAO,EACP,SAAS,EACT,cAAc,EACd,aAAa,EACb,SAAS,GACc;IACvB,OAAO;QACL,YAAY,SAAS,EAAE;QACvB,YAAY,OAAO,EAAE;QACrB,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACtC,aAAa,cAAc,EAAE;QAC7B,GAAG,CAAC,SAAS,IAAI,aAAa;YAC5B,CAAC,CAAC;gBACE,aAAa,aAAa,qDAAqD;aAChF;YACH,CAAC,CAAC,EAAE,CAAC;KACR,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,YAAY,CAAC,EAAE,SAAS,EAA2B;IACjE,OAAO,CAAC,GAAG,UAAU,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,GAAG,SAAS,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACnE,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW;IAC/B,MAAM,MAAM,GAAG,yBAAyB,EAAE,CAAC;IAC3C,MAAM,aAAa,GAAG,MAAM,mBAAmB,EAAE,CAAC;IAClD,MAAM,SAAS,GAAG,kBAAkB,CAAC;QACnC,SAAS,EAAE,MAAM,CAAC,QAAQ,IAAI,SAAS;QACvC,OAAO,EAAE,MAAM,CAAC,OAAO,IAAI,SAAS;QACpC,SAAS,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC;QACjC,cAAc,EAAE,aAAa,CAAC,cAAc;QAC5C,aAAa,EAAE,aAAa,CAAC,aAAa;QAC1C,SAAS,EAAE,aAAa,CAAC,SAAS;KACnC,CAAC,CAAC;IAEH,WAAW,CAAC,EAAE,OAAO,EAAE,YAAY,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC,CAAC;IACtD,WAAW,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;AAC/B,CAAC"}
package/build/cli.d.ts CHANGED
@@ -1,3 +1,7 @@
1
1
  #!/usr/bin/env node
2
- export declare function main(): void;
2
+ import { Command } from "commander";
3
+ export declare function createProgram(): Command;
4
+ export declare function main({ argv, }?: {
5
+ argv?: string[];
6
+ }): Promise<void>;
3
7
  //# sourceMappingURL=cli.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AAyBA,wBAAgB,IAAI,SA+BnB"}
1
+ {"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAuBpC,wBAAgB,aAAa,IAAI,OAAO,CA0BvC;AAGD,wBAAsB,IAAI,CAAC,EACzB,IAAmB,GACpB,GAAE;IACD,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACZ,GAAG,OAAO,CAAC,IAAI,CAAC,CAWrB"}
package/build/cli.js CHANGED
@@ -2,11 +2,12 @@
2
2
  import { Command } from "commander";
3
3
  import { printBanner } from "./banner.js";
4
4
  import { createAnnotationConfigCommand, createApiCommand, createAuthCommand, createDatasetCommand, createDatasetsCommand, createDocsCommand, createExperimentCommand, createExperimentsCommand, createProjectsCommand, createPromptCommand, createPromptsCommand, createSessionCommand, createSessionsCommand, createSpansCommand, createTraceCommand, createTracesCommand, } from "./commands/index.js";
5
- // Phoenix CLI Main Logic
6
- export function main() {
5
+ import { CLI_VERSION } from "./version.js";
6
+ export function createProgram() {
7
7
  const program = new Command();
8
8
  program.name("px");
9
9
  program.enablePositionalOptions();
10
+ program.version(CLI_VERSION);
10
11
  // Register commands
11
12
  program.addCommand(createAnnotationConfigCommand());
12
13
  program.addCommand(createAuthCommand());
@@ -24,11 +25,17 @@ export function main() {
24
25
  program.addCommand(createPromptCommand());
25
26
  program.addCommand(createApiCommand());
26
27
  program.addCommand(createDocsCommand());
28
+ return program;
29
+ }
30
+ // Phoenix CLI Main Logic
31
+ export async function main({ argv = process.argv, } = {}) {
32
+ const program = createProgram();
27
33
  // Show banner and help if no command provided
28
- if (process.argv.length === 2) {
29
- printBanner();
34
+ if (argv.length === 2) {
35
+ await printBanner();
30
36
  program.help();
37
+ return;
31
38
  }
32
- program.parse();
39
+ await program.parseAsync(argv);
33
40
  }
34
41
  //# sourceMappingURL=cli.js.map
package/build/cli.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,EACL,6BAA6B,EAC7B,gBAAgB,EAChB,iBAAiB,EACjB,oBAAoB,EACpB,qBAAqB,EACrB,iBAAiB,EACjB,uBAAuB,EACvB,wBAAwB,EACxB,qBAAqB,EACrB,mBAAmB,EACnB,oBAAoB,EACpB,oBAAoB,EACpB,qBAAqB,EACrB,kBAAkB,EAClB,kBAAkB,EAClB,mBAAmB,GACpB,MAAM,YAAY,CAAC;AAEpB,yBAAyB;AACzB,MAAM,UAAU,IAAI;IAClB,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;IAE9B,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACnB,OAAO,CAAC,uBAAuB,EAAE,CAAC;IAElC,oBAAoB;IACpB,OAAO,CAAC,UAAU,CAAC,6BAA6B,EAAE,CAAC,CAAC;IACpD,OAAO,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAC,CAAC;IACxC,OAAO,CAAC,UAAU,CAAC,qBAAqB,EAAE,CAAC,CAAC;IAC5C,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,CAAC,CAAC;IAC1C,OAAO,CAAC,UAAU,CAAC,kBAAkB,EAAE,CAAC,CAAC;IACzC,OAAO,CAAC,UAAU,CAAC,kBAAkB,EAAE,CAAC,CAAC;IACzC,OAAO,CAAC,UAAU,CAAC,qBAAqB,EAAE,CAAC,CAAC;IAC5C,OAAO,CAAC,UAAU,CAAC,oBAAoB,EAAE,CAAC,CAAC;IAC3C,OAAO,CAAC,UAAU,CAAC,qBAAqB,EAAE,CAAC,CAAC;IAC5C,OAAO,CAAC,UAAU,CAAC,oBAAoB,EAAE,CAAC,CAAC;IAC3C,OAAO,CAAC,UAAU,CAAC,wBAAwB,EAAE,CAAC,CAAC;IAC/C,OAAO,CAAC,UAAU,CAAC,uBAAuB,EAAE,CAAC,CAAC;IAC9C,OAAO,CAAC,UAAU,CAAC,oBAAoB,EAAE,CAAC,CAAC;IAC3C,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,CAAC,CAAC;IAC1C,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAC,CAAC;IACvC,OAAO,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAC,CAAC;IAExC,8CAA8C;IAC9C,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC9B,WAAW,EAAE,CAAC;QACd,OAAO,CAAC,IAAI,EAAE,CAAC;IACjB,CAAC;IAED,OAAO,CAAC,KAAK,EAAE,CAAC;AAClB,CAAC"}
1
+ {"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,EACL,6BAA6B,EAC7B,gBAAgB,EAChB,iBAAiB,EACjB,oBAAoB,EACpB,qBAAqB,EACrB,iBAAiB,EACjB,uBAAuB,EACvB,wBAAwB,EACxB,qBAAqB,EACrB,mBAAmB,EACnB,oBAAoB,EACpB,oBAAoB,EACpB,qBAAqB,EACrB,kBAAkB,EAClB,kBAAkB,EAClB,mBAAmB,GACpB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAExC,MAAM,UAAU,aAAa;IAC3B,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;IAE9B,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACnB,OAAO,CAAC,uBAAuB,EAAE,CAAC;IAClC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IAE7B,oBAAoB;IACpB,OAAO,CAAC,UAAU,CAAC,6BAA6B,EAAE,CAAC,CAAC;IACpD,OAAO,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAC,CAAC;IACxC,OAAO,CAAC,UAAU,CAAC,qBAAqB,EAAE,CAAC,CAAC;IAC5C,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,CAAC,CAAC;IAC1C,OAAO,CAAC,UAAU,CAAC,kBAAkB,EAAE,CAAC,CAAC;IACzC,OAAO,CAAC,UAAU,CAAC,kBAAkB,EAAE,CAAC,CAAC;IACzC,OAAO,CAAC,UAAU,CAAC,qBAAqB,EAAE,CAAC,CAAC;IAC5C,OAAO,CAAC,UAAU,CAAC,oBAAoB,EAAE,CAAC,CAAC;IAC3C,OAAO,CAAC,UAAU,CAAC,qBAAqB,EAAE,CAAC,CAAC;IAC5C,OAAO,CAAC,UAAU,CAAC,oBAAoB,EAAE,CAAC,CAAC;IAC3C,OAAO,CAAC,UAAU,CAAC,wBAAwB,EAAE,CAAC,CAAC;IAC/C,OAAO,CAAC,UAAU,CAAC,uBAAuB,EAAE,CAAC,CAAC;IAC9C,OAAO,CAAC,UAAU,CAAC,oBAAoB,EAAE,CAAC,CAAC;IAC3C,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,CAAC,CAAC;IAC1C,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAC,CAAC;IACvC,OAAO,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAC,CAAC;IAExC,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,yBAAyB;AACzB,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,EACzB,IAAI,GAAG,OAAO,CAAC,IAAI,MAGjB,EAAE;IACJ,MAAM,OAAO,GAAG,aAAa,EAAE,CAAC;IAEhC,8CAA8C;IAC9C,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtB,MAAM,WAAW,EAAE,CAAC;QACpB,OAAO,CAAC,IAAI,EAAE,CAAC;QACf,OAAO;IACT,CAAC;IAED,MAAM,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;AACjC,CAAC"}
@@ -97,7 +97,7 @@ export function createPromptCommand() {
97
97
  const command = new Command("prompt");
98
98
  command
99
99
  .description("Show a Phoenix prompt")
100
- .argument("<prompt_identifier>", "Prompt name or ID")
100
+ .argument("<prompt-identifier>", "Prompt name or ID")
101
101
  .option("--endpoint <url>", "Phoenix API endpoint")
102
102
  .option("--api-key <key>", "Phoenix API key for authentication")
103
103
  .option("--format <format>", "Output format: pretty, json, raw, or text", "pretty")
package/build/index.js CHANGED
@@ -1,6 +1,12 @@
1
1
  #!/usr/bin/env node
2
2
  // Phoenix CLI Entry Point
3
3
  import { main } from "./cli.js";
4
+ import { writeError } from "./io.js";
4
5
  // Run CLI when executed directly
5
- main();
6
+ void main().catch((error) => {
7
+ writeError({
8
+ message: `Error: ${error instanceof Error ? error.message : String(error)}`,
9
+ });
10
+ process.exit(1);
11
+ });
6
12
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAEA,0BAA0B;AAC1B,OAAO,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC;AAE7B,iCAAiC;AACjC,IAAI,EAAE,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAEA,0BAA0B;AAC1B,OAAO,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC;AAC7B,OAAO,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAElC,iCAAiC;AACjC,KAAK,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;IAC1B,UAAU,CAAC;QACT,OAAO,EAAE,UAAU,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE;KAC5E,CAAC,CAAC;IACH,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}
@@ -0,0 +1,44 @@
1
+ type SemanticVersion = {
2
+ major: number;
3
+ minor: number;
4
+ patch: number;
5
+ prerelease?: string;
6
+ };
7
+ export interface CliVersionStatus {
8
+ currentVersion: string;
9
+ latestVersion?: string;
10
+ hasUpdate?: boolean;
11
+ }
12
+ export interface FetchLatestPublishedCliVersionOptions {
13
+ fetchFn?: typeof fetch;
14
+ timeoutMs?: number;
15
+ }
16
+ export declare const CLI_VERSION: string;
17
+ /**
18
+ * Returns the CLI version from package metadata.
19
+ */
20
+ export declare function getCliVersion(): string;
21
+ /**
22
+ * Parse a semver string so the CLI can compare local and published versions.
23
+ */
24
+ export declare function parseSemanticVersion({ rawVersion, }: {
25
+ rawVersion: string;
26
+ }): SemanticVersion | null;
27
+ /**
28
+ * Compare two semantic versions.
29
+ * Returns `1` when left is newer, `-1` when right is newer, and `0` when equal.
30
+ */
31
+ export declare function compareSemanticVersions({ leftVersion, rightVersion, }: {
32
+ leftVersion: string;
33
+ rightVersion: string;
34
+ }): number | null;
35
+ /**
36
+ * Fetch the latest published CLI version from the npm registry.
37
+ */
38
+ export declare function fetchLatestPublishedCliVersion({ fetchFn, timeoutMs, }?: FetchLatestPublishedCliVersionOptions): Promise<string | undefined>;
39
+ /**
40
+ * Resolve the current CLI version and, when possible, the latest published version.
41
+ */
42
+ export declare function getCliVersionStatus({ fetchFn, timeoutMs, }?: FetchLatestPublishedCliVersionOptions): Promise<CliVersionStatus>;
43
+ export {};
44
+ //# sourceMappingURL=version.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AASA,KAAK,eAAe,GAAG;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAUF,MAAM,WAAW,gBAAgB;IAC/B,cAAc,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,qCAAqC;IACpD,OAAO,CAAC,EAAE,OAAO,KAAK,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAoCD,eAAO,MAAM,WAAW,QAGH,CAAC;AAEtB;;GAEG;AACH,wBAAgB,aAAa,IAAI,MAAM,CAEtC;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,EACnC,UAAU,GACX,EAAE;IACD,UAAU,EAAE,MAAM,CAAC;CACpB,GAAG,eAAe,GAAG,IAAI,CAYzB;AA0DD;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,EACtC,WAAW,EACX,YAAY,GACb,EAAE;IACD,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;CACtB,GAAG,MAAM,GAAG,IAAI,CAsBhB;AAED;;GAEG;AACH,wBAAsB,8BAA8B,CAAC,EACnD,OAAe,EACf,SAA4C,GAC7C,GAAE,qCAA0C,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAuB1E;AAED;;GAEG;AACH,wBAAsB,mBAAmB,CAAC,EACxC,OAAO,EACP,SAAS,GACV,GAAE,qCAA0C,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAyBxE"}
@@ -0,0 +1,171 @@
1
+ import { readFileSync } from "node:fs";
2
+ const CLI_PACKAGE_NAME = "@arizeai/phoenix-cli";
3
+ const CLI_LATEST_VERSION_URL = `https://registry.npmjs.org/${encodeURIComponent(CLI_PACKAGE_NAME)}/latest`;
4
+ const DEFAULT_VERSION_CHECK_TIMEOUT_MS = 1500;
5
+ const DEFAULT_CLI_VERSION = "unknown";
6
+ const SEMANTIC_VERSION_PATTERN = /^(\d+)\.(\d+)\.(\d+)(?:-([0-9A-Za-z.-]+))?(?:\+[0-9A-Za-z.-]+)?$/;
7
+ function getPackageJsonVersion({ packageJson, }) {
8
+ if (typeof packageJson.version !== "string") {
9
+ return undefined;
10
+ }
11
+ const version = packageJson.version.trim();
12
+ return version.length > 0 ? version : undefined;
13
+ }
14
+ function readCliVersionFromPackageJson() {
15
+ try {
16
+ const packageJson = JSON.parse(readFileSync(new URL("../package.json", import.meta.url), "utf-8"));
17
+ return getPackageJsonVersion({ packageJson });
18
+ }
19
+ catch {
20
+ return undefined;
21
+ }
22
+ }
23
+ function readCliVersionFromEnvironment() {
24
+ if (typeof process.env.npm_package_version !== "string") {
25
+ return undefined;
26
+ }
27
+ const version = process.env.npm_package_version.trim();
28
+ return version.length > 0 ? version : undefined;
29
+ }
30
+ export const CLI_VERSION = readCliVersionFromPackageJson() ??
31
+ readCliVersionFromEnvironment() ??
32
+ DEFAULT_CLI_VERSION;
33
+ /**
34
+ * Returns the CLI version from package metadata.
35
+ */
36
+ export function getCliVersion() {
37
+ return CLI_VERSION;
38
+ }
39
+ /**
40
+ * Parse a semver string so the CLI can compare local and published versions.
41
+ */
42
+ export function parseSemanticVersion({ rawVersion, }) {
43
+ const match = rawVersion.trim().match(SEMANTIC_VERSION_PATTERN);
44
+ if (!match) {
45
+ return null;
46
+ }
47
+ return {
48
+ major: Number.parseInt(match[1], 10),
49
+ minor: Number.parseInt(match[2], 10),
50
+ patch: Number.parseInt(match[3], 10),
51
+ prerelease: match[4] || undefined,
52
+ };
53
+ }
54
+ function comparePrereleaseSegments({ leftPrerelease, rightPrerelease, }) {
55
+ if (leftPrerelease === rightPrerelease) {
56
+ return 0;
57
+ }
58
+ if (!leftPrerelease) {
59
+ return 1;
60
+ }
61
+ if (!rightPrerelease) {
62
+ return -1;
63
+ }
64
+ const leftSegments = leftPrerelease.split(".");
65
+ const rightSegments = rightPrerelease.split(".");
66
+ const segmentCount = Math.max(leftSegments.length, rightSegments.length);
67
+ for (let index = 0; index < segmentCount; index += 1) {
68
+ const leftSegment = leftSegments[index];
69
+ const rightSegment = rightSegments[index];
70
+ if (leftSegment === rightSegment) {
71
+ continue;
72
+ }
73
+ if (leftSegment === undefined) {
74
+ return -1;
75
+ }
76
+ if (rightSegment === undefined) {
77
+ return 1;
78
+ }
79
+ const leftNumber = Number.parseInt(leftSegment, 10);
80
+ const rightNumber = Number.parseInt(rightSegment, 10);
81
+ const isLeftNumeric = String(leftNumber) === leftSegment;
82
+ const isRightNumeric = String(rightNumber) === rightSegment;
83
+ if (isLeftNumeric && isRightNumeric) {
84
+ return leftNumber === rightNumber ? 0 : leftNumber > rightNumber ? 1 : -1;
85
+ }
86
+ if (isLeftNumeric) {
87
+ return -1;
88
+ }
89
+ if (isRightNumeric) {
90
+ return 1;
91
+ }
92
+ return leftSegment.localeCompare(rightSegment);
93
+ }
94
+ return 0;
95
+ }
96
+ /**
97
+ * Compare two semantic versions.
98
+ * Returns `1` when left is newer, `-1` when right is newer, and `0` when equal.
99
+ */
100
+ export function compareSemanticVersions({ leftVersion, rightVersion, }) {
101
+ const leftParsedVersion = parseSemanticVersion({ rawVersion: leftVersion });
102
+ const rightParsedVersion = parseSemanticVersion({ rawVersion: rightVersion });
103
+ if (!leftParsedVersion || !rightParsedVersion) {
104
+ return null;
105
+ }
106
+ if (leftParsedVersion.major !== rightParsedVersion.major) {
107
+ return leftParsedVersion.major > rightParsedVersion.major ? 1 : -1;
108
+ }
109
+ if (leftParsedVersion.minor !== rightParsedVersion.minor) {
110
+ return leftParsedVersion.minor > rightParsedVersion.minor ? 1 : -1;
111
+ }
112
+ if (leftParsedVersion.patch !== rightParsedVersion.patch) {
113
+ return leftParsedVersion.patch > rightParsedVersion.patch ? 1 : -1;
114
+ }
115
+ return comparePrereleaseSegments({
116
+ leftPrerelease: leftParsedVersion.prerelease,
117
+ rightPrerelease: rightParsedVersion.prerelease,
118
+ });
119
+ }
120
+ /**
121
+ * Fetch the latest published CLI version from the npm registry.
122
+ */
123
+ export async function fetchLatestPublishedCliVersion({ fetchFn = fetch, timeoutMs = DEFAULT_VERSION_CHECK_TIMEOUT_MS, } = {}) {
124
+ const controller = new AbortController();
125
+ const timeoutId = setTimeout(() => controller.abort(), timeoutMs);
126
+ try {
127
+ const response = await fetchFn(CLI_LATEST_VERSION_URL, {
128
+ headers: {
129
+ Accept: "application/json",
130
+ },
131
+ signal: controller.signal,
132
+ });
133
+ if (!response.ok) {
134
+ return undefined;
135
+ }
136
+ const payload = (await response.json());
137
+ return typeof payload.version === "string" ? payload.version : undefined;
138
+ }
139
+ catch {
140
+ return undefined;
141
+ }
142
+ finally {
143
+ clearTimeout(timeoutId);
144
+ }
145
+ }
146
+ /**
147
+ * Resolve the current CLI version and, when possible, the latest published version.
148
+ */
149
+ export async function getCliVersionStatus({ fetchFn, timeoutMs, } = {}) {
150
+ const currentVersion = getCliVersion();
151
+ const latestVersion = await fetchLatestPublishedCliVersion({
152
+ fetchFn,
153
+ timeoutMs,
154
+ });
155
+ if (!latestVersion) {
156
+ return { currentVersion };
157
+ }
158
+ const comparison = compareSemanticVersions({
159
+ leftVersion: latestVersion,
160
+ rightVersion: currentVersion,
161
+ });
162
+ if (comparison === null) {
163
+ return { currentVersion };
164
+ }
165
+ return {
166
+ currentVersion,
167
+ latestVersion,
168
+ hasUpdate: comparison > 0,
169
+ };
170
+ }
171
+ //# sourceMappingURL=version.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"version.js","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAEvC,MAAM,gBAAgB,GAAG,sBAAsB,CAAC;AAChD,MAAM,sBAAsB,GAAG,8BAA8B,kBAAkB,CAAC,gBAAgB,CAAC,SAAS,CAAC;AAC3G,MAAM,gCAAgC,GAAG,IAAI,CAAC;AAC9C,MAAM,mBAAmB,GAAG,SAAS,CAAC;AACtC,MAAM,wBAAwB,GAC5B,kEAAkE,CAAC;AA4BrE,SAAS,qBAAqB,CAAC,EAC7B,WAAW,GAGZ;IACC,IAAI,OAAO,WAAW,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;QAC5C,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;IAC3C,OAAO,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;AAClD,CAAC;AAED,SAAS,6BAA6B;IACpC,IAAI,CAAC;QACH,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAC5B,YAAY,CAAC,IAAI,GAAG,CAAC,iBAAiB,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CACjD,CAAC;QAEpB,OAAO,qBAAqB,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC;IAChD,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,SAAS,6BAA6B;IACpC,IAAI,OAAO,OAAO,CAAC,GAAG,CAAC,mBAAmB,KAAK,QAAQ,EAAE,CAAC;QACxD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,IAAI,EAAE,CAAC;IACvD,OAAO,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;AAClD,CAAC;AAED,MAAM,CAAC,MAAM,WAAW,GACtB,6BAA6B,EAAE;IAC/B,6BAA6B,EAAE;IAC/B,mBAAmB,CAAC;AAEtB;;GAEG;AACH,MAAM,UAAU,aAAa;IAC3B,OAAO,WAAW,CAAC;AACrB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAAC,EACnC,UAAU,GAGX;IACC,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAChE,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO;QACL,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAE,EAAE,EAAE,CAAC;QACrC,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAE,EAAE,EAAE,CAAC;QACrC,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAE,EAAE,EAAE,CAAC;QACrC,UAAU,EAAE,KAAK,CAAC,CAAC,CAAC,IAAI,SAAS;KAClC,CAAC;AACJ,CAAC;AAED,SAAS,yBAAyB,CAAC,EACjC,cAAc,EACd,eAAe,GAIhB;IACC,IAAI,cAAc,KAAK,eAAe,EAAE,CAAC;QACvC,OAAO,CAAC,CAAC;IACX,CAAC;IACD,IAAI,CAAC,cAAc,EAAE,CAAC;QACpB,OAAO,CAAC,CAAC;IACX,CAAC;IACD,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,OAAO,CAAC,CAAC,CAAC;IACZ,CAAC;IAED,MAAM,YAAY,GAAG,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC/C,MAAM,aAAa,GAAG,eAAe,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACjD,MAAM,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IAEzE,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,YAAY,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QACrD,MAAM,WAAW,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;QACxC,MAAM,YAAY,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;QAE1C,IAAI,WAAW,KAAK,YAAY,EAAE,CAAC;YACjC,SAAS;QACX,CAAC;QACD,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YAC9B,OAAO,CAAC,CAAC,CAAC;QACZ,CAAC;QACD,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;YAC/B,OAAO,CAAC,CAAC;QACX,CAAC;QAED,MAAM,UAAU,GAAG,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;QACpD,MAAM,WAAW,GAAG,MAAM,CAAC,QAAQ,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;QACtD,MAAM,aAAa,GAAG,MAAM,CAAC,UAAU,CAAC,KAAK,WAAW,CAAC;QACzD,MAAM,cAAc,GAAG,MAAM,CAAC,WAAW,CAAC,KAAK,YAAY,CAAC;QAE5D,IAAI,aAAa,IAAI,cAAc,EAAE,CAAC;YACpC,OAAO,UAAU,KAAK,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5E,CAAC;QACD,IAAI,aAAa,EAAE,CAAC;YAClB,OAAO,CAAC,CAAC,CAAC;QACZ,CAAC;QACD,IAAI,cAAc,EAAE,CAAC;YACnB,OAAO,CAAC,CAAC;QACX,CAAC;QAED,OAAO,WAAW,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;IACjD,CAAC;IAED,OAAO,CAAC,CAAC;AACX,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,uBAAuB,CAAC,EACtC,WAAW,EACX,YAAY,GAIb;IACC,MAAM,iBAAiB,GAAG,oBAAoB,CAAC,EAAE,UAAU,EAAE,WAAW,EAAE,CAAC,CAAC;IAC5E,MAAM,kBAAkB,GAAG,oBAAoB,CAAC,EAAE,UAAU,EAAE,YAAY,EAAE,CAAC,CAAC;IAE9E,IAAI,CAAC,iBAAiB,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC9C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,iBAAiB,CAAC,KAAK,KAAK,kBAAkB,CAAC,KAAK,EAAE,CAAC;QACzD,OAAO,iBAAiB,CAAC,KAAK,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACrE,CAAC;IACD,IAAI,iBAAiB,CAAC,KAAK,KAAK,kBAAkB,CAAC,KAAK,EAAE,CAAC;QACzD,OAAO,iBAAiB,CAAC,KAAK,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACrE,CAAC;IACD,IAAI,iBAAiB,CAAC,KAAK,KAAK,kBAAkB,CAAC,KAAK,EAAE,CAAC;QACzD,OAAO,iBAAiB,CAAC,KAAK,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACrE,CAAC;IAED,OAAO,yBAAyB,CAAC;QAC/B,cAAc,EAAE,iBAAiB,CAAC,UAAU;QAC5C,eAAe,EAAE,kBAAkB,CAAC,UAAU;KAC/C,CAAC,CAAC;AACL,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,8BAA8B,CAAC,EACnD,OAAO,GAAG,KAAK,EACf,SAAS,GAAG,gCAAgC,MACH,EAAE;IAC3C,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;IACzC,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,EAAE,SAAS,CAAC,CAAC;IAElE,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,sBAAsB,EAAE;YACrD,OAAO,EAAE;gBACP,MAAM,EAAE,kBAAkB;aAC3B;YACD,MAAM,EAAE,UAAU,CAAC,MAAM;SAC1B,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,MAAM,OAAO,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAA0B,CAAC;QACjE,OAAO,OAAO,OAAO,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;IAC3E,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;YAAS,CAAC;QACT,YAAY,CAAC,SAAS,CAAC,CAAC;IAC1B,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAC,EACxC,OAAO,EACP,SAAS,MACgC,EAAE;IAC3C,MAAM,cAAc,GAAG,aAAa,EAAE,CAAC;IACvC,MAAM,aAAa,GAAG,MAAM,8BAA8B,CAAC;QACzD,OAAO;QACP,SAAS;KACV,CAAC,CAAC;IAEH,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,OAAO,EAAE,cAAc,EAAE,CAAC;IAC5B,CAAC;IAED,MAAM,UAAU,GAAG,uBAAuB,CAAC;QACzC,WAAW,EAAE,aAAa;QAC1B,YAAY,EAAE,cAAc;KAC7B,CAAC,CAAC;IAEH,IAAI,UAAU,KAAK,IAAI,EAAE,CAAC;QACxB,OAAO,EAAE,cAAc,EAAE,CAAC;IAC5B,CAAC;IAED,OAAO;QACL,cAAc;QACd,aAAa;QACb,SAAS,EAAE,UAAU,GAAG,CAAC;KAC1B,CAAC;AACJ,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@arizeai/phoenix-cli",
3
- "version": "0.11.0",
3
+ "version": "0.11.1",
4
4
  "description": "A command-line interface for Phoenix",
5
5
  "keywords": [
6
6
  "arize",