@arizeai/phoenix-client 6.4.0 → 6.5.0

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.
Files changed (136) hide show
  1. package/dist/esm/__generated__/api/v1.d.ts +149 -0
  2. package/dist/esm/__generated__/api/v1.d.ts.map +1 -1
  3. package/dist/esm/client.d.ts +16 -0
  4. package/dist/esm/client.d.ts.map +1 -1
  5. package/dist/esm/client.js +55 -0
  6. package/dist/esm/client.js.map +1 -1
  7. package/dist/esm/constants/serverRequirements.d.ts +28 -0
  8. package/dist/esm/constants/serverRequirements.d.ts.map +1 -0
  9. package/dist/esm/constants/serverRequirements.js +65 -0
  10. package/dist/esm/constants/serverRequirements.js.map +1 -0
  11. package/dist/esm/sessions/addSessionAnnotation.d.ts +2 -0
  12. package/dist/esm/sessions/addSessionAnnotation.d.ts.map +1 -1
  13. package/dist/esm/sessions/addSessionAnnotation.js +5 -0
  14. package/dist/esm/sessions/addSessionAnnotation.js.map +1 -1
  15. package/dist/esm/sessions/deleteSession.d.ts +2 -0
  16. package/dist/esm/sessions/deleteSession.d.ts.map +1 -1
  17. package/dist/esm/sessions/deleteSession.js +5 -0
  18. package/dist/esm/sessions/deleteSession.js.map +1 -1
  19. package/dist/esm/sessions/deleteSessions.d.ts +2 -0
  20. package/dist/esm/sessions/deleteSessions.d.ts.map +1 -1
  21. package/dist/esm/sessions/deleteSessions.js +5 -0
  22. package/dist/esm/sessions/deleteSessions.js.map +1 -1
  23. package/dist/esm/sessions/getSession.d.ts +2 -0
  24. package/dist/esm/sessions/getSession.d.ts.map +1 -1
  25. package/dist/esm/sessions/getSession.js +5 -0
  26. package/dist/esm/sessions/getSession.js.map +1 -1
  27. package/dist/esm/sessions/getSessionTurns.d.ts.map +1 -1
  28. package/dist/esm/sessions/getSessionTurns.js +1 -0
  29. package/dist/esm/sessions/getSessionTurns.js.map +1 -1
  30. package/dist/esm/sessions/listSessions.d.ts +2 -0
  31. package/dist/esm/sessions/listSessions.d.ts.map +1 -1
  32. package/dist/esm/sessions/listSessions.js +5 -0
  33. package/dist/esm/sessions/listSessions.js.map +1 -1
  34. package/dist/esm/sessions/logSessionAnnotations.d.ts +2 -0
  35. package/dist/esm/sessions/logSessionAnnotations.d.ts.map +1 -1
  36. package/dist/esm/sessions/logSessionAnnotations.js +5 -0
  37. package/dist/esm/sessions/logSessionAnnotations.js.map +1 -1
  38. package/dist/esm/spans/getSpans.d.ts +2 -0
  39. package/dist/esm/spans/getSpans.d.ts.map +1 -1
  40. package/dist/esm/spans/getSpans.js +7 -0
  41. package/dist/esm/spans/getSpans.js.map +1 -1
  42. package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
  43. package/dist/esm/types/semver.d.ts +3 -0
  44. package/dist/esm/types/semver.d.ts.map +1 -0
  45. package/dist/esm/types/semver.js +2 -0
  46. package/dist/esm/types/semver.js.map +1 -0
  47. package/dist/esm/types/serverRequirements.d.ts +39 -0
  48. package/dist/esm/types/serverRequirements.d.ts.map +1 -0
  49. package/dist/esm/types/serverRequirements.js +14 -0
  50. package/dist/esm/types/serverRequirements.js.map +1 -0
  51. package/dist/esm/utils/formatPromptMessages.d.ts.map +1 -1
  52. package/dist/esm/utils/getPromptBySelector.d.ts.map +1 -1
  53. package/dist/esm/utils/semverUtils.d.ts +21 -0
  54. package/dist/esm/utils/semverUtils.d.ts.map +1 -0
  55. package/dist/esm/utils/semverUtils.js +52 -0
  56. package/dist/esm/utils/semverUtils.js.map +1 -0
  57. package/dist/esm/utils/serverVersionUtils.d.ts +47 -0
  58. package/dist/esm/utils/serverVersionUtils.d.ts.map +1 -0
  59. package/dist/esm/utils/serverVersionUtils.js +64 -0
  60. package/dist/esm/utils/serverVersionUtils.js.map +1 -0
  61. package/dist/src/__generated__/api/v1.d.ts +149 -0
  62. package/dist/src/__generated__/api/v1.d.ts.map +1 -1
  63. package/dist/src/client.d.ts +16 -0
  64. package/dist/src/client.d.ts.map +1 -1
  65. package/dist/src/client.js +57 -2
  66. package/dist/src/client.js.map +1 -1
  67. package/dist/src/constants/serverRequirements.d.ts +28 -0
  68. package/dist/src/constants/serverRequirements.d.ts.map +1 -0
  69. package/dist/src/constants/serverRequirements.js +68 -0
  70. package/dist/src/constants/serverRequirements.js.map +1 -0
  71. package/dist/src/sessions/addSessionAnnotation.d.ts +2 -0
  72. package/dist/src/sessions/addSessionAnnotation.d.ts.map +1 -1
  73. package/dist/src/sessions/addSessionAnnotation.js +5 -0
  74. package/dist/src/sessions/addSessionAnnotation.js.map +1 -1
  75. package/dist/src/sessions/deleteSession.d.ts +2 -0
  76. package/dist/src/sessions/deleteSession.d.ts.map +1 -1
  77. package/dist/src/sessions/deleteSession.js +5 -0
  78. package/dist/src/sessions/deleteSession.js.map +1 -1
  79. package/dist/src/sessions/deleteSessions.d.ts +2 -0
  80. package/dist/src/sessions/deleteSessions.d.ts.map +1 -1
  81. package/dist/src/sessions/deleteSessions.js +5 -0
  82. package/dist/src/sessions/deleteSessions.js.map +1 -1
  83. package/dist/src/sessions/getSession.d.ts +2 -0
  84. package/dist/src/sessions/getSession.d.ts.map +1 -1
  85. package/dist/src/sessions/getSession.js +5 -0
  86. package/dist/src/sessions/getSession.js.map +1 -1
  87. package/dist/src/sessions/getSessionTurns.d.ts.map +1 -1
  88. package/dist/src/sessions/getSessionTurns.js +1 -0
  89. package/dist/src/sessions/getSessionTurns.js.map +1 -1
  90. package/dist/src/sessions/listSessions.d.ts +2 -0
  91. package/dist/src/sessions/listSessions.d.ts.map +1 -1
  92. package/dist/src/sessions/listSessions.js +5 -0
  93. package/dist/src/sessions/listSessions.js.map +1 -1
  94. package/dist/src/sessions/logSessionAnnotations.d.ts +2 -0
  95. package/dist/src/sessions/logSessionAnnotations.d.ts.map +1 -1
  96. package/dist/src/sessions/logSessionAnnotations.js +5 -0
  97. package/dist/src/sessions/logSessionAnnotations.js.map +1 -1
  98. package/dist/src/spans/getSpans.d.ts +2 -0
  99. package/dist/src/spans/getSpans.d.ts.map +1 -1
  100. package/dist/src/spans/getSpans.js +7 -0
  101. package/dist/src/spans/getSpans.js.map +1 -1
  102. package/dist/src/types/semver.d.ts +3 -0
  103. package/dist/src/types/semver.d.ts.map +1 -0
  104. package/dist/src/types/semver.js +3 -0
  105. package/dist/src/types/semver.js.map +1 -0
  106. package/dist/src/types/serverRequirements.d.ts +39 -0
  107. package/dist/src/types/serverRequirements.d.ts.map +1 -0
  108. package/dist/src/types/serverRequirements.js +15 -0
  109. package/dist/src/types/serverRequirements.js.map +1 -0
  110. package/dist/src/utils/formatPromptMessages.d.ts.map +1 -1
  111. package/dist/src/utils/getPromptBySelector.d.ts.map +1 -1
  112. package/dist/src/utils/semverUtils.d.ts +21 -0
  113. package/dist/src/utils/semverUtils.d.ts.map +1 -0
  114. package/dist/src/utils/semverUtils.js +57 -0
  115. package/dist/src/utils/semverUtils.js.map +1 -0
  116. package/dist/src/utils/serverVersionUtils.d.ts +47 -0
  117. package/dist/src/utils/serverVersionUtils.d.ts.map +1 -0
  118. package/dist/src/utils/serverVersionUtils.js +68 -0
  119. package/dist/src/utils/serverVersionUtils.js.map +1 -0
  120. package/dist/tsconfig.tsbuildinfo +1 -1
  121. package/package.json +1 -1
  122. package/src/__generated__/api/v1.ts +149 -0
  123. package/src/client.ts +61 -0
  124. package/src/constants/serverRequirements.ts +77 -0
  125. package/src/sessions/addSessionAnnotation.ts +5 -0
  126. package/src/sessions/deleteSession.ts +5 -0
  127. package/src/sessions/deleteSessions.ts +5 -0
  128. package/src/sessions/getSession.ts +5 -0
  129. package/src/sessions/getSessionTurns.ts +1 -0
  130. package/src/sessions/listSessions.ts +5 -0
  131. package/src/sessions/logSessionAnnotations.ts +5 -0
  132. package/src/spans/getSpans.ts +7 -0
  133. package/src/types/semver.ts +2 -0
  134. package/src/types/serverRequirements.ts +42 -0
  135. package/src/utils/semverUtils.ts +66 -0
  136. package/src/utils/serverVersionUtils.ts +79 -0
@@ -0,0 +1,39 @@
1
+ /**
2
+ * Server capability requirements.
3
+ *
4
+ * A "capability" represents a specific server-side feature — such as an HTTP
5
+ * route or query parameter — that is gated behind a minimum Phoenix server
6
+ * version. Each {@link CapabilityRequirement} declares *what* the capability
7
+ * is and *which* server version first introduced it.
8
+ *
9
+ * The client checks these requirements at call time via
10
+ * {@link ensureServerCapability} so that callers get a clear, actionable error
11
+ * instead of an opaque 404 or 400 from an older server.
12
+ */
13
+ import type { SemanticVersion } from "./semver";
14
+ export interface RouteRequirement {
15
+ kind: "route";
16
+ /** HTTP method (e.g. "GET", "POST", "DELETE"). */
17
+ method: string;
18
+ /** URL path template (e.g. "/v1/sessions/{session_id}"). */
19
+ path: string;
20
+ /** Minimum Phoenix server version as [major, minor, patch]. */
21
+ minServerVersion: SemanticVersion;
22
+ /** Optional human-readable description override. */
23
+ description?: string;
24
+ }
25
+ export interface ParameterRequirement {
26
+ kind: "parameter";
27
+ /** Name of the query/path/header parameter. */
28
+ parameterName: string;
29
+ /** Location of the parameter (e.g. "query", "path", "header"). */
30
+ parameterLocation: string;
31
+ /** The route this parameter belongs to (e.g. "GET /v1/projects/{id}/spans"). */
32
+ route: string;
33
+ /** Minimum Phoenix server version as [major, minor, patch]. */
34
+ minServerVersion: SemanticVersion;
35
+ /** Optional human-readable description override. */
36
+ description?: string;
37
+ }
38
+ export type CapabilityRequirement = RouteRequirement | ParameterRequirement;
39
+ //# sourceMappingURL=serverRequirements.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"serverRequirements.d.ts","sourceRoot":"","sources":["../../../src/types/serverRequirements.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAEhD,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,OAAO,CAAC;IACd,kDAAkD;IAClD,MAAM,EAAE,MAAM,CAAC;IACf,4DAA4D;IAC5D,IAAI,EAAE,MAAM,CAAC;IACb,+DAA+D;IAC/D,gBAAgB,EAAE,eAAe,CAAC;IAClC,oDAAoD;IACpD,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,WAAW,CAAC;IAClB,+CAA+C;IAC/C,aAAa,EAAE,MAAM,CAAC;IACtB,kEAAkE;IAClE,iBAAiB,EAAE,MAAM,CAAC;IAC1B,gFAAgF;IAChF,KAAK,EAAE,MAAM,CAAC;IACd,+DAA+D;IAC/D,gBAAgB,EAAE,eAAe,CAAC;IAClC,oDAAoD;IACpD,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,MAAM,qBAAqB,GAAG,gBAAgB,GAAG,oBAAoB,CAAC"}
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /**
3
+ * Server capability requirements.
4
+ *
5
+ * A "capability" represents a specific server-side feature — such as an HTTP
6
+ * route or query parameter — that is gated behind a minimum Phoenix server
7
+ * version. Each {@link CapabilityRequirement} declares *what* the capability
8
+ * is and *which* server version first introduced it.
9
+ *
10
+ * The client checks these requirements at call time via
11
+ * {@link ensureServerCapability} so that callers get a clear, actionable error
12
+ * instead of an opaque 404 or 400 from an older server.
13
+ */
14
+ Object.defineProperty(exports, "__esModule", { value: true });
15
+ //# sourceMappingURL=serverRequirements.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"serverRequirements.js","sourceRoot":"","sources":["../../../src/types/serverRequirements.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;GAWG"}
@@ -1 +1 @@
1
- {"version":3,"file":"formatPromptMessages.d.ts","sourceRoot":"","sources":["../../../src/utils/formatPromptMessages.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAGvD,OAAO,KAAK,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAGhF;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,oBAAoB,EAC5B,cAAc,EAAE,iBAAiB,EAAE,EACnC,SAAS,GAAE,SAAc;;;;;;;mBA4D6huG,uDAAsB;;;;;;;;;IAlB7kuG"}
1
+ {"version":3,"file":"formatPromptMessages.d.ts","sourceRoot":"","sources":["../../../src/utils/formatPromptMessages.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAGvD,OAAO,KAAK,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAGhF;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,oBAAoB,EAC5B,cAAc,EAAE,iBAAiB,EAAE,EACnC,SAAS,GAAE,SAAc;;;;;;;mBA4DmsvG,uDAAsB;;;;;;;;;IAlBnvvG"}
@@ -1 +1 @@
1
- {"version":3,"file":"getPromptBySelector.d.ts","sourceRoot":"","sources":["../../../src/utils/getPromptBySelector.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvD;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,QAAQ,GAAG;IACjD;;OAEG;IACH,MAAM,EAAE,cAAc,CAAC;CACxB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,wBAAsB,mBAAmB,CAAC,EACxC,MAAM,EAAE,OAAO,EACf,MAAM,GACP,EAAE,yBAAyB;;oBAkD+qsF,uDAAsB;;cAAkI,uDAAsB,yBAAwB,uDAAsB;mBAAoD,uDAAsB;qBAAoD,uDAAsB;2BAAqG,uDAAsB,uCAAsC,uDAAsB,4CAA2C,uDAAsB,0CAAyC,uDAAsB,uCAAsC,uDAAsB,yCAAwC,uDAAsB,oCAAmC,uDAAsB,uCAAsC,uDAAsB,oCAAmC,uDAAsB,yCAAwC,uDAAsB,0CAAyC,uDAAsB,qCAAoC,uDAAsB,yCAAwC,uDAAsB,2CAA0C,uDAAsB;YAA2D,uDAAsB;sBAAwF,uDAAsB;;UAD7ovF"}
1
+ {"version":3,"file":"getPromptBySelector.d.ts","sourceRoot":"","sources":["../../../src/utils/getPromptBySelector.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvD;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,QAAQ,GAAG;IACjD;;OAEG;IACH,MAAM,EAAE,cAAc,CAAC;CACxB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,wBAAsB,mBAAmB,CAAC,EACxC,MAAM,EAAE,OAAO,EACf,MAAM,GACP,EAAE,yBAAyB;;oBAkDq1tF,uDAAsB;;cAAkI,uDAAsB,yBAAwB,uDAAsB;mBAAoD,uDAAsB;qBAAoD,uDAAsB;2BAAqG,uDAAsB,uCAAsC,uDAAsB,4CAA2C,uDAAsB,0CAAyC,uDAAsB,uCAAsC,uDAAsB,yCAAwC,uDAAsB,oCAAmC,uDAAsB,uCAAsC,uDAAsB,oCAAmC,uDAAsB,yCAAwC,uDAAsB,0CAAyC,uDAAsB,qCAAoC,uDAAsB,yCAAwC,uDAAsB,2CAA0C,uDAAsB;YAA2D,uDAAsB;sBAAwF,uDAAsB;;UADnzwF"}
@@ -0,0 +1,21 @@
1
+ /**
2
+ * Lightweight semantic version utilities.
3
+ */
4
+ import type { SemanticVersion } from "../types/semver";
5
+ /**
6
+ * Parse a semver-like version string (e.g. "13.14.0") into a triple.
7
+ * Returns `null` if the string is not a valid version.
8
+ */
9
+ export declare function parseSemanticVersion(raw: string): SemanticVersion | null;
10
+ /**
11
+ * Format a `SemanticVersion` as a `"major.minor.patch"` string.
12
+ */
13
+ export declare function formatVersion(version: SemanticVersion): string;
14
+ /**
15
+ * Returns `true` if `version` is greater than or equal to `minVersion`.
16
+ */
17
+ export declare function satisfiesMinVersion({ version, minVersion, }: {
18
+ version: SemanticVersion;
19
+ minVersion: SemanticVersion;
20
+ }): boolean;
21
+ //# sourceMappingURL=semverUtils.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"semverUtils.d.ts","sourceRoot":"","sources":["../../../src/utils/semverUtils.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAMvD;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,GAAG,IAAI,CAiBxE;AAMD;;GAEG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,eAAe,GAAG,MAAM,CAE9D;AAMD;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,EAClC,OAAO,EACP,UAAU,GACX,EAAE;IACD,OAAO,EAAE,eAAe,CAAC;IACzB,UAAU,EAAE,eAAe,CAAC;CAC7B,GAAG,OAAO,CAQV"}
@@ -0,0 +1,57 @@
1
+ "use strict";
2
+ /**
3
+ * Lightweight semantic version utilities.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.parseSemanticVersion = parseSemanticVersion;
7
+ exports.formatVersion = formatVersion;
8
+ exports.satisfiesMinVersion = satisfiesMinVersion;
9
+ // ---------------------------------------------------------------------------
10
+ // Parsing
11
+ // ---------------------------------------------------------------------------
12
+ /**
13
+ * Parse a semver-like version string (e.g. "13.14.0") into a triple.
14
+ * Returns `null` if the string is not a valid version.
15
+ */
16
+ function parseSemanticVersion(raw) {
17
+ const parts = raw.trim().split(".");
18
+ if (parts.length < 3)
19
+ return null;
20
+ const major = parseInt(parts[0], 10);
21
+ const minor = parseInt(parts[1], 10);
22
+ const patch = parseInt(parts[2], 10);
23
+ if (Number.isNaN(major) ||
24
+ Number.isNaN(minor) ||
25
+ Number.isNaN(patch) ||
26
+ major < 0 ||
27
+ minor < 0 ||
28
+ patch < 0) {
29
+ return null;
30
+ }
31
+ return [major, minor, patch];
32
+ }
33
+ // ---------------------------------------------------------------------------
34
+ // Formatting
35
+ // ---------------------------------------------------------------------------
36
+ /**
37
+ * Format a `SemanticVersion` as a `"major.minor.patch"` string.
38
+ */
39
+ function formatVersion(version) {
40
+ return `${version[0]}.${version[1]}.${version[2]}`;
41
+ }
42
+ // ---------------------------------------------------------------------------
43
+ // Comparison
44
+ // ---------------------------------------------------------------------------
45
+ /**
46
+ * Returns `true` if `version` is greater than or equal to `minVersion`.
47
+ */
48
+ function satisfiesMinVersion({ version, minVersion, }) {
49
+ const [serverVersionMajor, serverVersionMinor, serverVersionPatch] = version;
50
+ const [minVersionMajor, minVersionMinor, minVersionPatch] = minVersion;
51
+ if (serverVersionMajor !== minVersionMajor)
52
+ return serverVersionMajor > minVersionMajor;
53
+ if (serverVersionMinor !== minVersionMinor)
54
+ return serverVersionMinor > minVersionMinor;
55
+ return serverVersionPatch >= minVersionPatch;
56
+ }
57
+ //# sourceMappingURL=semverUtils.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"semverUtils.js","sourceRoot":"","sources":["../../../src/utils/semverUtils.ts"],"names":[],"mappings":";AAAA;;GAEG;;AAYH,oDAiBC;AASD,sCAEC;AASD,kDAcC;AA3DD,8EAA8E;AAC9E,UAAU;AACV,8EAA8E;AAE9E;;;GAGG;AACH,SAAgB,oBAAoB,CAAC,GAAW;IAC9C,MAAM,KAAK,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACpC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,IAAI,CAAC;IAClC,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAE,EAAE,EAAE,CAAC,CAAC;IACtC,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAE,EAAE,EAAE,CAAC,CAAC;IACtC,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAE,EAAE,EAAE,CAAC,CAAC;IACtC,IACE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;QACnB,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;QACnB,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;QACnB,KAAK,GAAG,CAAC;QACT,KAAK,GAAG,CAAC;QACT,KAAK,GAAG,CAAC,EACT,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;AAC/B,CAAC;AAED,8EAA8E;AAC9E,aAAa;AACb,8EAA8E;AAE9E;;GAEG;AACH,SAAgB,aAAa,CAAC,OAAwB;IACpD,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;AACrD,CAAC;AAED,8EAA8E;AAC9E,aAAa;AACb,8EAA8E;AAE9E;;GAEG;AACH,SAAgB,mBAAmB,CAAC,EAClC,OAAO,EACP,UAAU,GAIX;IACC,MAAM,CAAC,kBAAkB,EAAE,kBAAkB,EAAE,kBAAkB,CAAC,GAAG,OAAO,CAAC;IAC7E,MAAM,CAAC,eAAe,EAAE,eAAe,EAAE,eAAe,CAAC,GAAG,UAAU,CAAC;IACvE,IAAI,kBAAkB,KAAK,eAAe;QACxC,OAAO,kBAAkB,GAAG,eAAe,CAAC;IAC9C,IAAI,kBAAkB,KAAK,eAAe;QACxC,OAAO,kBAAkB,GAAG,eAAe,CAAC;IAC9C,OAAO,kBAAkB,IAAI,eAAe,CAAC;AAC/C,CAAC"}
@@ -0,0 +1,47 @@
1
+ /**
2
+ * Phoenix server version utilities.
3
+ *
4
+ * Provides guards for capabilities that require a minimum Phoenix **server**
5
+ * version. The server version is detected from the
6
+ * `x-phoenix-server-version` response header or by calling
7
+ * `GET /arize_phoenix_version`.
8
+ *
9
+ * ## Capability guard pattern
10
+ *
11
+ * Each server-side feature that was introduced after the initial release is
12
+ * represented by a {@link CapabilityRequirement} constant (defined in
13
+ * `constants/serverRequirements`). Before calling such a feature, the client
14
+ * passes the requirement to {@link ensureServerCapability}, which compares the
15
+ * connected server's version against the requirement's minimum version and
16
+ * throws a descriptive error when the server is too old. This lets callers
17
+ * see *exactly* which feature is unavailable and which version they need,
18
+ * rather than receiving an opaque HTTP 404 or 400 response.
19
+ */
20
+ import type { PhoenixClient } from "../client";
21
+ import type { CapabilityRequirement } from "../types/serverRequirements";
22
+ /**
23
+ * Derive a human-readable label from a structured capability requirement.
24
+ * Uses `description` if provided, otherwise auto-derives from metadata.
25
+ */
26
+ export declare function capabilityLabel(req: CapabilityRequirement): string;
27
+ /**
28
+ * Check the **Phoenix server version** before allowing a capability to proceed.
29
+ *
30
+ * Throws if the connected Phoenix server is older than the minimum version
31
+ * required by the given capability. Also throws if the server version cannot
32
+ * be determined — this typically means the server is too old to report its
33
+ * version at all and is therefore incompatible with this client.
34
+ *
35
+ * @example
36
+ * ```ts
37
+ * import { ensureServerCapability } from "../utils/serverVersionUtils";
38
+ * import { GET_SESSION } from "../constants/serverRequirements";
39
+ *
40
+ * await ensureServerCapability({ client, requirement: GET_SESSION });
41
+ * ```
42
+ */
43
+ export declare function ensureServerCapability({ client, requirement, }: {
44
+ client: PhoenixClient;
45
+ requirement: CapabilityRequirement;
46
+ }): Promise<void>;
47
+ //# sourceMappingURL=serverVersionUtils.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"serverVersionUtils.d.ts","sourceRoot":"","sources":["../../../src/utils/serverVersionUtils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAOzE;;;GAGG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,qBAAqB,GAAG,MAAM,CAQlE;AAMD;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,sBAAsB,CAAC,EAC3C,MAAM,EACN,WAAW,GACZ,EAAE;IACD,MAAM,EAAE,aAAa,CAAC;IACtB,WAAW,EAAE,qBAAqB,CAAC;CACpC,GAAG,OAAO,CAAC,IAAI,CAAC,CAUhB"}
@@ -0,0 +1,68 @@
1
+ "use strict";
2
+ /**
3
+ * Phoenix server version utilities.
4
+ *
5
+ * Provides guards for capabilities that require a minimum Phoenix **server**
6
+ * version. The server version is detected from the
7
+ * `x-phoenix-server-version` response header or by calling
8
+ * `GET /arize_phoenix_version`.
9
+ *
10
+ * ## Capability guard pattern
11
+ *
12
+ * Each server-side feature that was introduced after the initial release is
13
+ * represented by a {@link CapabilityRequirement} constant (defined in
14
+ * `constants/serverRequirements`). Before calling such a feature, the client
15
+ * passes the requirement to {@link ensureServerCapability}, which compares the
16
+ * connected server's version against the requirement's minimum version and
17
+ * throws a descriptive error when the server is too old. This lets callers
18
+ * see *exactly* which feature is unavailable and which version they need,
19
+ * rather than receiving an opaque HTTP 404 or 400 response.
20
+ */
21
+ Object.defineProperty(exports, "__esModule", { value: true });
22
+ exports.capabilityLabel = capabilityLabel;
23
+ exports.ensureServerCapability = ensureServerCapability;
24
+ const semverUtils_1 = require("./semverUtils");
25
+ // ---------------------------------------------------------------------------
26
+ // Capability label
27
+ // ---------------------------------------------------------------------------
28
+ /**
29
+ * Derive a human-readable label from a structured capability requirement.
30
+ * Uses `description` if provided, otherwise auto-derives from metadata.
31
+ */
32
+ function capabilityLabel(req) {
33
+ if (req.description)
34
+ return req.description;
35
+ switch (req.kind) {
36
+ case "route":
37
+ return `The ${req.method} ${req.path} route`;
38
+ case "parameter":
39
+ return `The '${req.parameterName}' ${req.parameterLocation} parameter on ${req.route}`;
40
+ }
41
+ }
42
+ // ---------------------------------------------------------------------------
43
+ // Guards
44
+ // ---------------------------------------------------------------------------
45
+ /**
46
+ * Check the **Phoenix server version** before allowing a capability to proceed.
47
+ *
48
+ * Throws if the connected Phoenix server is older than the minimum version
49
+ * required by the given capability. Also throws if the server version cannot
50
+ * be determined — this typically means the server is too old to report its
51
+ * version at all and is therefore incompatible with this client.
52
+ *
53
+ * @example
54
+ * ```ts
55
+ * import { ensureServerCapability } from "../utils/serverVersionUtils";
56
+ * import { GET_SESSION } from "../constants/serverRequirements";
57
+ *
58
+ * await ensureServerCapability({ client, requirement: GET_SESSION });
59
+ * ```
60
+ */
61
+ async function ensureServerCapability({ client, requirement, }) {
62
+ const version = await client.getServerVersion();
63
+ if (!(0, semverUtils_1.satisfiesMinVersion)({ version, minVersion: requirement.minServerVersion })) {
64
+ throw new Error(`${capabilityLabel(requirement)} requires Phoenix server >= ${(0, semverUtils_1.formatVersion)(requirement.minServerVersion)}, ` +
65
+ `but connected to server ${(0, semverUtils_1.formatVersion)(version)}. Please upgrade your Phoenix server.`);
66
+ }
67
+ }
68
+ //# sourceMappingURL=serverVersionUtils.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"serverVersionUtils.js","sourceRoot":"","sources":["../../../src/utils/serverVersionUtils.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;GAkBG;;AAcH,0CAQC;AAsBD,wDAgBC;AAxDD,+CAAmE;AAEnE,8EAA8E;AAC9E,mBAAmB;AACnB,8EAA8E;AAE9E;;;GAGG;AACH,SAAgB,eAAe,CAAC,GAA0B;IACxD,IAAI,GAAG,CAAC,WAAW;QAAE,OAAO,GAAG,CAAC,WAAW,CAAC;IAC5C,QAAQ,GAAG,CAAC,IAAI,EAAE,CAAC;QACjB,KAAK,OAAO;YACV,OAAO,OAAO,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,IAAI,QAAQ,CAAC;QAC/C,KAAK,WAAW;YACd,OAAO,QAAQ,GAAG,CAAC,aAAa,KAAK,GAAG,CAAC,iBAAiB,iBAAiB,GAAG,CAAC,KAAK,EAAE,CAAC;IAC3F,CAAC;AACH,CAAC;AAED,8EAA8E;AAC9E,SAAS;AACT,8EAA8E;AAE9E;;;;;;;;;;;;;;;GAeG;AACI,KAAK,UAAU,sBAAsB,CAAC,EAC3C,MAAM,EACN,WAAW,GAIZ;IACC,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,gBAAgB,EAAE,CAAC;IAChD,IACE,CAAC,IAAA,iCAAmB,EAAC,EAAE,OAAO,EAAE,UAAU,EAAE,WAAW,CAAC,gBAAgB,EAAE,CAAC,EAC3E,CAAC;QACD,MAAM,IAAI,KAAK,CACb,GAAG,eAAe,CAAC,WAAW,CAAC,+BAA+B,IAAA,2BAAa,EAAC,WAAW,CAAC,gBAAgB,CAAC,IAAI;YAC3G,2BAA2B,IAAA,2BAAa,EAAC,OAAO,CAAC,uCAAuC,CAC3F,CAAC;IACJ,CAAC;AACH,CAAC"}