@nxtl/nxtl-types 0.1.10 → 0.1.12

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/README.md CHANGED
@@ -1,6 +1,7 @@
1
1
  # nxtl-types
2
2
 
3
- TypeScript request/response contracts for every NXTL API endpoint.
3
+ The shared TypeScript source for NXTL API request/response contracts and domain
4
+ models used by the admin applications and plugins.
4
5
 
5
6
  ## Install
6
7
 
@@ -22,7 +23,7 @@ import type {
22
23
  ConversationResult,
23
24
  RequestOf,
24
25
  ResultOf,
25
- } from "@the-next-level-as/nxtl-types";
26
+ } from "@nxtl/nxtl-types";
26
27
 
27
28
  const request: ConversationRequest = {
28
29
  projectId: "abc12345",
@@ -35,3 +36,30 @@ const request: ConversationRequest = {
35
36
  type TransformRequest = RequestOf<"transformation">;
36
37
  type TransformResult = ResultOf<"transformation">;
37
38
  ```
39
+
40
+ ## Contract ownership
41
+
42
+ Define NXTL wire contracts and shared domain models here, then import them with
43
+ `import type` in consuming repositories. Existing public plugin modules may
44
+ re-export these types for compatibility. Keep component props, framework
45
+ adapters, inferred validation types, and application state in their own packages.
46
+
47
+ The Python backend remains the authority for endpoint behavior. When it changes,
48
+ update the corresponding request, response, result union, and `NXTL_ENDPOINTS`
49
+ entry together. Consumer-specific normalized models must be named separately
50
+ from raw API responses.
51
+
52
+ ## Verify and release
53
+
54
+ ```bash
55
+ npm ci
56
+ npm run typecheck
57
+ npm test
58
+ npm pack
59
+ ```
60
+
61
+ Packing rebuilds declarations and JavaScript so the artifact includes every
62
+ exported module. Publish the shared package before installing consumer changes
63
+ that require the new version. Validate consumers against the same packed artifact
64
+ before release; keep repository manifests on the published package name instead
65
+ of machine-specific paths.
@@ -0,0 +1,241 @@
1
+ import type { AssessmentFilters, AssessmentRoute, AssessmentAlignment, AssessmentStatus, AssessmentEvalReasoning, AssessmentEvalScore, AssessmentDialogueMessage, AssessmentDialogueUserInputMode, AssessmentItem } from "./management.js";
2
+ /** Shared NXTL Admin API and organization domain contracts. */
3
+ import type { ActivatedPluginRecord, Artifact, ArtifactStatisticsResponse, CitationsResponse, DataSource, Entry, EvalIndex, EvalsResponse, EvalsSeriesPoint, Matrix, RevisionResponse, SetMatrixSecondPassRequest, UserJourneyRecord } from "./index.js";
4
+ export type NxtlAssessmentDataSource = DataSource;
5
+ export type IntentResolutionEvalIndex = EvalIndex;
6
+ export interface IntentResolutionAssessmentFeedRequest {
7
+ dataSource?: NxtlAssessmentDataSource;
8
+ endDate?: string;
9
+ id?: string;
10
+ organizationId?: string;
11
+ page?: number;
12
+ pageSize?: number;
13
+ startDate?: string;
14
+ }
15
+ export interface IntentResolutionAssessmentReconciliationRequest {
16
+ episodeId: string;
17
+ reconciled: boolean;
18
+ }
19
+ export type IntentResolutionAssessmentFilters = AssessmentFilters;
20
+ export type IntentResolutionDialogueUserInputMode = AssessmentDialogueUserInputMode;
21
+ export interface IntentResolutionDialogueMessage extends AssessmentDialogueMessage {
22
+ artifact?: IntentResolutionArtifact;
23
+ }
24
+ export interface IntentResolutionArtifact {
25
+ path: string;
26
+ route?: IntentResolutionReadinessRoute | null;
27
+ }
28
+ export type IntentResolutionReadinessAlignment = AssessmentAlignment;
29
+ export type IntentResolutionReadinessRoute = AssessmentRoute;
30
+ export type IntentResolutionStatus = AssessmentStatus;
31
+ export interface IntentResolutionEvalScore extends Omit<AssessmentEvalScore, "formula"> {
32
+ formula: string | null;
33
+ }
34
+ export type IntentResolutionEvalReasoning = AssessmentEvalReasoning;
35
+ /** Assessment after Admin resolves artifact paths and normalizes score formulas. */
36
+ export interface IntentResolutionAssessmentFeedItem extends Omit<AssessmentItem, "artifactPath" | "dialogue" | "evalScores"> {
37
+ artifact: IntentResolutionArtifact | null;
38
+ dialogue: IntentResolutionDialogueMessage[];
39
+ evalScores: Partial<Record<IntentResolutionEvalIndex, IntentResolutionEvalScore>>;
40
+ }
41
+ export interface IntentResolutionAssessmentFeedResponse {
42
+ filters: IntentResolutionAssessmentFilters;
43
+ items: IntentResolutionAssessmentFeedItem[];
44
+ organizationId: string;
45
+ page: number;
46
+ pageSize: number;
47
+ total: number;
48
+ }
49
+ export interface NxtlCredentialFields {
50
+ nxtlOrganizationId: string;
51
+ }
52
+ export interface NxtlCredentialsApiResponse extends NxtlCredentialFields {
53
+ apiKey: string;
54
+ }
55
+ export interface NxtlCredentialsStatus {
56
+ hasCredentials: boolean;
57
+ credentials: NxtlCredentialFields | null;
58
+ }
59
+ export interface RotateNxtlCredentialsResult {
60
+ regenerated: boolean;
61
+ credentials: NxtlCredentialsApiResponse;
62
+ }
63
+ export interface ArtifactTooltipMaps {
64
+ entries: Record<string, string>;
65
+ matrices: Record<string, string>;
66
+ userJourneys: Record<string, string>;
67
+ }
68
+ export interface ArtifactsPageDataResponse {
69
+ artifacts: Artifact[];
70
+ tooltips: ArtifactTooltipMaps;
71
+ }
72
+ export interface ArtifactCampaignDistributionRequest {
73
+ endDate: string;
74
+ organizationId?: string;
75
+ startDate?: string;
76
+ }
77
+ export interface ArtifactCampaignDistributionPoint {
78
+ campaign: string;
79
+ hits: number;
80
+ }
81
+ export interface ArtifactCampaignDistributionRange {
82
+ endDate: string;
83
+ formulaCount: number;
84
+ pointCount: number;
85
+ startDate?: string;
86
+ }
87
+ export interface ArtifactCampaignDistributionResponse {
88
+ range: ArtifactCampaignDistributionRange;
89
+ series: ArtifactCampaignDistributionPoint[];
90
+ }
91
+ export interface ArtifactEntriesDistributionRequest {
92
+ endDate: string;
93
+ organizationId?: string;
94
+ startDate?: string;
95
+ }
96
+ export interface ArtifactEntriesDistributionPoint {
97
+ entry: string;
98
+ hits: number;
99
+ }
100
+ export interface ArtifactEntriesDistributionRange {
101
+ endDate: string;
102
+ formulaCount: number;
103
+ pointCount: number;
104
+ startDate?: string;
105
+ }
106
+ export interface ArtifactEntriesDistributionResponse {
107
+ range: ArtifactEntriesDistributionRange;
108
+ series: ArtifactEntriesDistributionPoint[];
109
+ }
110
+ export type NxtlEvalDataSource = DataSource;
111
+ export type NxtlEvalsSeriesPoint = EvalsSeriesPoint;
112
+ /** Admin normalizes absent simulated evaluation series to an empty array. */
113
+ export interface NxtlEvalsResponse extends EvalsResponse {
114
+ simulatedSeries: EvalsSeriesPoint[];
115
+ }
116
+ export type OrganizationType = "partner" | "standard";
117
+ export type OrganizationAccessSource = "explicit" | "inherited" | "superAdmin";
118
+ export type OrganizationMemberRole = "admin" | "member" | "owner";
119
+ export interface OrganizationAccess {
120
+ effectiveRole: OrganizationMemberRole | null;
121
+ source: OrganizationAccessSource;
122
+ }
123
+ export interface OrganizationParentSummary {
124
+ id: string;
125
+ name: string;
126
+ organizationType: OrganizationType;
127
+ slug: string;
128
+ }
129
+ export interface OrganizationUserSummary {
130
+ email: string;
131
+ id: string;
132
+ image?: string | null;
133
+ name: string;
134
+ role?: string | null;
135
+ }
136
+ export interface OrganizationMemberSummary {
137
+ createdAt: Date | string;
138
+ id: string;
139
+ organizationId: string;
140
+ role: OrganizationMemberRole;
141
+ user: OrganizationUserSummary | null;
142
+ userId: string;
143
+ }
144
+ export interface OrganizationInvitationSummary {
145
+ createdAt: Date | string;
146
+ email: string;
147
+ expiresAt: Date | string;
148
+ id: string;
149
+ inviterId: string;
150
+ organizationId: string;
151
+ role: string | null;
152
+ status: string;
153
+ }
154
+ export interface OrganizationSummary {
155
+ access: OrganizationAccess;
156
+ id: string;
157
+ logo?: string | null;
158
+ name: string;
159
+ organizationType: OrganizationType;
160
+ parentOrganization: OrganizationParentSummary | null;
161
+ parentOrganizationId: string | null;
162
+ slug: string;
163
+ }
164
+ export interface ActiveOrganization extends OrganizationSummary {
165
+ createdAt: Date | string;
166
+ invitations: OrganizationInvitationSummary[];
167
+ metadata?: Record<string, unknown>;
168
+ members: OrganizationMemberSummary[];
169
+ }
170
+ export type OrganizationSetupStepId = "settings" | "billing" | "apiCredentials" | "content" | "insights" | "configuration" | "globalToneOfVoice" | "userJourney";
171
+ export type OrganizationSetupCompletionSource = "derived" | "route";
172
+ export interface OrganizationSetupStatusStep {
173
+ id: OrganizationSetupStepId;
174
+ completed: boolean;
175
+ completedAt: string | null;
176
+ }
177
+ export interface OrganizationSetupStatus {
178
+ organizationId: string;
179
+ isOrganizationAdmin: boolean;
180
+ hasNxtlCredentials: boolean;
181
+ hideGuide: boolean;
182
+ shouldAutoOpenGuide: boolean;
183
+ steps: OrganizationSetupStatusStep[];
184
+ }
185
+ export interface OrganizationSetupStatusInput {
186
+ organizationId?: string;
187
+ }
188
+ export interface OrganizationSetupDismissGuideInput extends OrganizationSetupStatusInput {
189
+ hideGuide: boolean;
190
+ }
191
+ export interface OrganizationSetupMarkStepVisitedInput extends OrganizationSetupStatusInput {
192
+ stepId: OrganizationSetupStepId;
193
+ }
194
+ export interface OrganizationExportCitation extends CitationsResponse {
195
+ entryId: string;
196
+ }
197
+ export interface OrganizationExportArtifactStatistics extends ArtifactStatisticsResponse {
198
+ formula: string;
199
+ }
200
+ export interface NxtlOrganizationDataExport {
201
+ settings: {
202
+ activatedPlugins: ActivatedPluginRecord[];
203
+ domainModel: string;
204
+ fallbackResponse: string;
205
+ globalToneOfVoice: string;
206
+ };
207
+ content: {
208
+ artifacts: Artifact[];
209
+ entries: Entry[];
210
+ matrices: Matrix[];
211
+ userJourneys: UserJourneyRecord[];
212
+ };
213
+ history: {
214
+ revisions: RevisionResponse[];
215
+ };
216
+ analytics: {
217
+ artifactStatistics: OrganizationExportArtifactStatistics[];
218
+ citations: OrganizationExportCitation[];
219
+ evaluations: Record<IntentResolutionEvalIndex, NxtlEvalsResponse>;
220
+ intentResolutionAssessments: IntentResolutionAssessmentFeedResponse;
221
+ usage: number;
222
+ };
223
+ }
224
+ export interface UsageReportResult {
225
+ organizationId: string;
226
+ organizationName: string;
227
+ planId?: string;
228
+ projectId?: string;
229
+ currentUsage?: number;
230
+ usageDelta?: number;
231
+ success: boolean;
232
+ skipped?: boolean;
233
+ reason?: string;
234
+ stripeEventId?: string;
235
+ error?: string;
236
+ }
237
+ /** Required fields and normalized slot-array representation used when saving a matrix. */
238
+ export type MatrixUpdatePayload = Required<Pick<SetMatrixSecondPassRequest, "path" | "summary" | "locked">> & {
239
+ response: Extract<NonNullable<SetMatrixSecondPassRequest["response"]>, unknown[]>;
240
+ };
241
+ //# sourceMappingURL=admin.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"admin.d.ts","sourceRoot":"","sources":["../src/admin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACR,iBAAiB,EACjB,eAAe,EACf,mBAAmB,EACnB,gBAAgB,EAChB,uBAAuB,EACvB,mBAAmB,EACnB,yBAAyB,EACzB,+BAA+B,EAC/B,cAAc,EACjB,MAAM,iBAAiB,CAAC;AACzB,+DAA+D;AAC/D,OAAO,KAAK,EACR,qBAAqB,EACrB,QAAQ,EACR,0BAA0B,EAC1B,iBAAiB,EACjB,UAAU,EACV,KAAK,EACL,SAAS,EACT,aAAa,EACb,gBAAgB,EAChB,MAAM,EACN,gBAAgB,EAChB,0BAA0B,EAC1B,iBAAiB,EACpB,MAAM,YAAY,CAAC;AAEpB,MAAM,MAAM,wBAAwB,GAAG,UAAU,CAAC;AAClD,MAAM,MAAM,yBAAyB,GAAG,SAAS,CAAC;AAElD,MAAM,WAAW,qCAAqC;IAClD,UAAU,CAAC,EAAE,wBAAwB,CAAC;IACtC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,+CAA+C;IAC5D,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,OAAO,CAAC;CACvB;AAED,MAAM,MAAM,iCAAiC,GAAG,iBAAiB,CAAC;AAElE,MAAM,MAAM,qCAAqC,GAC7C,+BAA+B,CAAC;AAEpC,MAAM,WAAW,+BACb,SAAQ,yBAAyB;IACjC,QAAQ,CAAC,EAAE,wBAAwB,CAAC;CACvC;AAED,MAAM,WAAW,wBAAwB;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,8BAA8B,GAAG,IAAI,CAAC;CACjD;AAED,MAAM,MAAM,kCAAkC,GAAG,mBAAmB,CAAC;AAErE,MAAM,MAAM,8BAA8B,GAAG,eAAe,CAAC;AAE7D,MAAM,MAAM,sBAAsB,GAAG,gBAAgB,CAAC;AAEtD,MAAM,WAAW,yBACb,SAAQ,IAAI,CAAC,mBAAmB,EAAE,SAAS,CAAC;IAC5C,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,MAAM,6BAA6B,GAAG,uBAAuB,CAAC;AAEpE,oFAAoF;AACpF,MAAM,WAAW,kCACb,SAAQ,IAAI,CAAC,cAAc,EAAE,cAAc,GAAG,UAAU,GAAG,YAAY,CAAC;IACxE,QAAQ,EAAE,wBAAwB,GAAG,IAAI,CAAC;IAC1C,QAAQ,EAAE,+BAA+B,EAAE,CAAC;IAC5C,UAAU,EAAE,OAAO,CACf,MAAM,CAAC,yBAAyB,EAAE,yBAAyB,CAAC,CAC/D,CAAC;CACL;AAED,MAAM,WAAW,sCAAsC;IACnD,OAAO,EAAE,iCAAiC,CAAC;IAC3C,KAAK,EAAE,kCAAkC,EAAE,CAAC;IAC5C,cAAc,EAAE,MAAM,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,oBAAoB;IACjC,kBAAkB,EAAE,MAAM,CAAC;CAC9B;AAED,MAAM,WAAW,0BAA2B,SAAQ,oBAAoB;IACpE,MAAM,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,qBAAqB;IAClC,cAAc,EAAE,OAAO,CAAC;IACxB,WAAW,EAAE,oBAAoB,GAAG,IAAI,CAAC;CAC5C;AAED,MAAM,WAAW,2BAA2B;IACxC,WAAW,EAAE,OAAO,CAAC;IACrB,WAAW,EAAE,0BAA0B,CAAC;CAC3C;AAED,MAAM,WAAW,mBAAmB;IAChC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACxC;AAED,MAAM,WAAW,yBAAyB;IACtC,SAAS,EAAE,QAAQ,EAAE,CAAC;IACtB,QAAQ,EAAE,mBAAmB,CAAC;CACjC;AAED,MAAM,WAAW,mCAAmC;IAChD,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,iCAAiC;IAC9C,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,iCAAiC;IAC9C,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,oCAAoC;IACjD,KAAK,EAAE,iCAAiC,CAAC;IACzC,MAAM,EAAE,iCAAiC,EAAE,CAAC;CAC/C;AAED,MAAM,WAAW,kCAAkC;IAC/C,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,gCAAgC;IAC7C,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,gCAAgC;IAC7C,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,mCAAmC;IAChD,KAAK,EAAE,gCAAgC,CAAC;IACxC,MAAM,EAAE,gCAAgC,EAAE,CAAC;CAC9C;AAED,MAAM,MAAM,kBAAkB,GAAG,UAAU,CAAC;AAC5C,MAAM,MAAM,oBAAoB,GAAG,gBAAgB,CAAC;AAEpD,6EAA6E;AAC7E,MAAM,WAAW,iBAAkB,SAAQ,aAAa;IACpD,eAAe,EAAE,gBAAgB,EAAE,CAAC;CACvC;AAED,MAAM,MAAM,gBAAgB,GAAG,SAAS,GAAG,UAAU,CAAC;AACtD,MAAM,MAAM,wBAAwB,GAAG,UAAU,GAAG,WAAW,GAAG,YAAY,CAAC;AAC/E,MAAM,MAAM,sBAAsB,GAAG,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAC;AAElE,MAAM,WAAW,kBAAkB;IAC/B,aAAa,EAAE,sBAAsB,GAAG,IAAI,CAAC;IAC7C,MAAM,EAAE,wBAAwB,CAAC;CACpC;AAED,MAAM,WAAW,yBAAyB;IACtC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,uBAAuB;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,WAAW,yBAAyB;IACtC,SAAS,EAAE,IAAI,GAAG,MAAM,CAAC;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,cAAc,EAAE,MAAM,CAAC;IACvB,IAAI,EAAE,sBAAsB,CAAC;IAC7B,IAAI,EAAE,uBAAuB,GAAG,IAAI,CAAC;IACrC,MAAM,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,6BAA6B;IAC1C,SAAS,EAAE,IAAI,GAAG,MAAM,CAAC;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,IAAI,GAAG,MAAM,CAAC;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,mBAAmB;IAChC,MAAM,EAAE,kBAAkB,CAAC;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,kBAAkB,EAAE,yBAAyB,GAAG,IAAI,CAAC;IACrD,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;IAC3D,SAAS,EAAE,IAAI,GAAG,MAAM,CAAC;IACzB,WAAW,EAAE,6BAA6B,EAAE,CAAC;IAC7C,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,OAAO,EAAE,yBAAyB,EAAE,CAAC;CACxC;AAED,MAAM,MAAM,uBAAuB,GAC7B,UAAU,GACV,SAAS,GACT,gBAAgB,GAChB,SAAS,GACT,UAAU,GACV,eAAe,GACf,mBAAmB,GACnB,aAAa,CAAC;AACpB,MAAM,MAAM,iCAAiC,GAAG,SAAS,GAAG,OAAO,CAAC;AAEpE,MAAM,WAAW,2BAA2B;IACxC,EAAE,EAAE,uBAAuB,CAAC;IAC5B,SAAS,EAAE,OAAO,CAAC;IACnB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,MAAM,WAAW,uBAAuB;IACpC,cAAc,EAAE,MAAM,CAAC;IACvB,mBAAmB,EAAE,OAAO,CAAC;IAC7B,kBAAkB,EAAE,OAAO,CAAC;IAC5B,SAAS,EAAE,OAAO,CAAC;IACnB,mBAAmB,EAAE,OAAO,CAAC;IAC7B,KAAK,EAAE,2BAA2B,EAAE,CAAC;CACxC;AAED,MAAM,WAAW,4BAA4B;IACzC,cAAc,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,kCACb,SAAQ,4BAA4B;IACpC,SAAS,EAAE,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,qCACb,SAAQ,4BAA4B;IACpC,MAAM,EAAE,uBAAuB,CAAC;CACnC;AAED,MAAM,WAAW,0BAA2B,SAAQ,iBAAiB;IACjE,OAAO,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,oCACb,SAAQ,0BAA0B;IAClC,OAAO,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,0BAA0B;IACvC,QAAQ,EAAE;QACN,gBAAgB,EAAE,qBAAqB,EAAE,CAAC;QAC1C,WAAW,EAAE,MAAM,CAAC;QACpB,gBAAgB,EAAE,MAAM,CAAC;QACzB,iBAAiB,EAAE,MAAM,CAAC;KAC7B,CAAC;IACF,OAAO,EAAE;QACL,SAAS,EAAE,QAAQ,EAAE,CAAC;QACtB,OAAO,EAAE,KAAK,EAAE,CAAC;QACjB,QAAQ,EAAE,MAAM,EAAE,CAAC;QACnB,YAAY,EAAE,iBAAiB,EAAE,CAAC;KACrC,CAAC;IACF,OAAO,EAAE;QACL,SAAS,EAAE,gBAAgB,EAAE,CAAC;KACjC,CAAC;IACF,SAAS,EAAE;QACP,kBAAkB,EAAE,oCAAoC,EAAE,CAAC;QAC3D,SAAS,EAAE,0BAA0B,EAAE,CAAC;QACxC,WAAW,EAAE,MAAM,CAAC,yBAAyB,EAAE,iBAAiB,CAAC,CAAC;QAClE,2BAA2B,EAAE,sCAAsC,CAAC;QACpE,KAAK,EAAE,MAAM,CAAC;KACjB,CAAC;CACL;AAED,MAAM,WAAW,iBAAiB;IAC9B,cAAc,EAAE,MAAM,CAAC;IACvB,gBAAgB,EAAE,MAAM,CAAC;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,0FAA0F;AAC1F,MAAM,MAAM,mBAAmB,GAAG,QAAQ,CACtC,IAAI,CAAC,0BAA0B,EAAE,MAAM,GAAG,SAAS,GAAG,QAAQ,CAAC,CAClE,GAAG;IACA,QAAQ,EAAE,OAAO,CACb,WAAW,CAAC,0BAA0B,CAAC,UAAU,CAAC,CAAC,EACnD,OAAO,EAAE,CACZ,CAAC;CACL,CAAC"}
package/dist/admin.js ADDED
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=admin.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"admin.js","sourceRoot":"","sources":["../src/admin.ts"],"names":[],"mappings":""}
package/dist/index.d.ts CHANGED
@@ -1,4 +1,8 @@
1
1
  export type HttpMethod = "GET" | "POST" | "PATCH" | "DELETE";
2
+ export type * from "./plugins.js";
3
+ export type * from "./admin.js";
4
+ export type * from "./management.js";
5
+ import type { AssessmentRequest, AssessmentsRequest, CrudAssessmentPatchResult, CrudAssessmentResult, CrudAssessmentsResult, CrudDomainModelGetResult, CrudDomainModelResult, CrudFallbackResponseGetResult, CrudFallbackResponseResult, DomainModelRequest, FallbackResponseRequest, PatchAssessmentRequest } from "./management.js";
2
6
  export type AuthScheme = "apiKey" | "bearer" | "none";
3
7
  export type ServerErrorResponse = string;
4
8
  export interface UnauthorizedResponse {
@@ -21,6 +25,7 @@ export interface BaseProjectRequest {
21
25
  organizationId?: string;
22
26
  projectId?: string;
23
27
  }
28
+ export type DataSource = "real" | "simulated";
24
29
  export interface OptionalUserRequest {
25
30
  userId?: string;
26
31
  }
@@ -30,6 +35,7 @@ export interface Artifact {
30
35
  hash: string;
31
36
  createdAt: string;
32
37
  lifetimeHits: number;
38
+ dataSource?: DataSource;
33
39
  }
34
40
  export interface Entry {
35
41
  id: string;
@@ -39,8 +45,15 @@ export interface Entry {
39
45
  export interface CrudEntry extends Entry {
40
46
  lifetimeCitations: number;
41
47
  }
42
- export interface RetrievedEntry extends Entry {
48
+ export interface RetrievedEntry {
49
+ id: string;
50
+ full: string;
43
51
  vec_sim: number;
52
+ keyword_score?: number;
53
+ lexical_score?: number;
54
+ lexical_matches?: number;
55
+ direct_support?: boolean;
56
+ retrieval_score?: number;
44
57
  }
45
58
  export interface Matrix {
46
59
  path: string;
@@ -66,10 +79,12 @@ export interface ConversationRequest extends BaseProjectRequest {
66
79
  episode: string;
67
80
  message: string;
68
81
  entryIds: string[];
82
+ language?: string;
83
+ dataSource?: DataSource;
69
84
  suggestions?: string[];
70
85
  startTimestamp?: number;
71
86
  tokenUsage?: number;
72
- forceUserJourney?: string;
87
+ pattern?: string;
73
88
  }
74
89
  export type ConversationStream = string;
75
90
  export interface ConversationSuccessHeaders {
@@ -104,11 +119,33 @@ export type ConversationResult = {
104
119
  status: 500;
105
120
  body: ServerErrorResponse;
106
121
  };
122
+ export interface SuggestionsRequest extends BaseProjectRequest {
123
+ episode?: string;
124
+ language?: string;
125
+ dataSource?: DataSource;
126
+ startTimestamp?: number;
127
+ tokenUsage?: number;
128
+ pattern?: string;
129
+ }
130
+ export interface SuggestionsResponse {
131
+ suggestions: string[];
132
+ inference_id: string | null;
133
+ token_usage: number;
134
+ }
135
+ export type SuggestionsResult = {
136
+ status: 200;
137
+ body: SuggestionsResponse;
138
+ } | {
139
+ status: 401;
140
+ body: UnauthorizedResponse;
141
+ } | {
142
+ status: 500;
143
+ body: ServerErrorResponse;
144
+ };
107
145
  export interface RerankingEntryInput {
108
146
  id: string;
109
- summary: string | null;
110
147
  full: string;
111
- vec_sim: number;
148
+ vec_sim?: number;
112
149
  }
113
150
  export interface RerankingRequest extends BaseProjectRequest {
114
151
  entries: RerankingEntryInput[];
@@ -140,6 +177,7 @@ export interface TransformationRequest extends BaseProjectRequest {
140
177
  entryIds?: string[];
141
178
  episode?: string;
142
179
  history?: string;
180
+ dataSource?: DataSource;
143
181
  }
144
182
  export interface RewrittenContentItem {
145
183
  key: string;
@@ -158,7 +196,8 @@ export interface TransformationResponse {
158
196
  rewritten_content: RewrittenContentItem[];
159
197
  episode?: string;
160
198
  entry_ids: string[];
161
- dead_end: boolean;
199
+ cache_hit: boolean;
200
+ data_source: DataSource;
162
201
  start_timestamp: number;
163
202
  token_usage: number;
164
203
  personalization_context: PersonalizationContext;
@@ -190,12 +229,16 @@ export interface ArtifactListRequest extends BaseProjectRequest {
190
229
  search?: string;
191
230
  startDate?: string;
192
231
  endDate?: string;
232
+ includeOutliers?: boolean;
193
233
  }
194
234
  export interface GetProjectRequest extends BaseProjectRequest {
195
235
  }
196
236
  export type CrudArtifactsResult = {
197
237
  status: 200;
198
238
  body: Artifact[];
239
+ } | {
240
+ status: 400;
241
+ body: ErrorResponse;
199
242
  } | {
200
243
  status: 401;
201
244
  body: UnauthorizedResponse;
@@ -262,6 +305,19 @@ export interface EntryListRequest extends BaseProjectRequest {
262
305
  pageSize?: number;
263
306
  search?: string;
264
307
  }
308
+ export interface EntryRequest extends BaseProjectRequest {
309
+ id: string;
310
+ }
311
+ export type CrudEntryResult = {
312
+ status: 200;
313
+ body: Entry | null;
314
+ } | {
315
+ status: 401;
316
+ body: UnauthorizedResponse;
317
+ } | {
318
+ status: 500;
319
+ body: ServerErrorResponse;
320
+ };
265
321
  export type CrudEntriesResult = {
266
322
  status: 200;
267
323
  body: CrudEntry[];
@@ -287,10 +343,12 @@ export interface EvalsRange {
287
343
  export interface EvalsSeriesPoint {
288
344
  date?: string;
289
345
  score?: number | null;
346
+ dataSource?: DataSource;
290
347
  }
291
348
  export interface EvalsResponse {
292
349
  range: EvalsRange;
293
350
  series: EvalsSeriesPoint[];
351
+ simulatedSeries?: EvalsSeriesPoint[];
294
352
  }
295
353
  export type CrudEvalsResult = {
296
354
  status: 200;
@@ -389,9 +447,10 @@ export type CrudMatrixResult = {
389
447
  body: ServerErrorResponse;
390
448
  };
391
449
  export interface RetrieveEntriesRequest extends BaseProjectRequest {
392
- dataSource: string;
393
450
  query: string[];
394
451
  results?: number;
452
+ episode?: string;
453
+ category?: string;
395
454
  }
396
455
  export type CrudRetrieveEntriesResult = {
397
456
  status: 200;
@@ -477,6 +536,9 @@ export interface SyncEntriesRequest extends BaseProjectRequest {
477
536
  export type CrudSyncEntriesResult = {
478
537
  status: 200;
479
538
  body: MessageResponse;
539
+ } | {
540
+ status: 400;
541
+ body: ErrorResponse;
480
542
  } | {
481
543
  status: 401;
482
544
  body: UnauthorizedResponse;
@@ -492,6 +554,9 @@ export interface SyncEntryRequest extends BaseProjectRequest {
492
554
  export type CrudSyncEntryResult = {
493
555
  status: 200;
494
556
  body: MessageResponse;
557
+ } | {
558
+ status: 400;
559
+ body: ErrorResponse;
495
560
  } | {
496
561
  status: 401;
497
562
  body: UnauthorizedResponse;
@@ -772,6 +837,12 @@ export declare const NXTL_ENDPOINTS: {
772
837
  readonly path: "/conversation";
773
838
  readonly auth: "apiKey";
774
839
  };
840
+ readonly suggestions: {
841
+ readonly method: "POST";
842
+ readonly path: "/suggestions";
843
+ readonly auth: "apiKey";
844
+ };
845
+ /** @deprecated Legacy plugin endpoint; absent from the current backend. */
775
846
  readonly reranking: {
776
847
  readonly method: "POST";
777
848
  readonly path: "/reranking";
@@ -807,6 +878,11 @@ export declare const NXTL_ENDPOINTS: {
807
878
  readonly path: "/crud/deleteUserJourney";
808
879
  readonly auth: "apiKey";
809
880
  };
881
+ readonly crudEntry: {
882
+ readonly method: "GET";
883
+ readonly path: "/crud/entry";
884
+ readonly auth: "apiKey";
885
+ };
810
886
  readonly crudEntries: {
811
887
  readonly method: "GET";
812
888
  readonly path: "/crud/entries";
@@ -817,6 +893,21 @@ export declare const NXTL_ENDPOINTS: {
817
893
  readonly path: "/crud/evals";
818
894
  readonly auth: "apiKey";
819
895
  };
896
+ readonly crudAssessments: {
897
+ readonly method: "GET";
898
+ readonly path: "/crud/assessments";
899
+ readonly auth: "apiKey";
900
+ };
901
+ readonly crudAssessment: {
902
+ readonly method: "GET";
903
+ readonly path: "/crud/assessment";
904
+ readonly auth: "apiKey";
905
+ };
906
+ readonly crudAssessmentPatch: {
907
+ readonly method: "PATCH";
908
+ readonly path: "/crud/assessment";
909
+ readonly auth: "apiKey";
910
+ };
820
911
  readonly crudCitations: {
821
912
  readonly method: "GET";
822
913
  readonly path: "/crud/citations";
@@ -877,6 +968,26 @@ export declare const NXTL_ENDPOINTS: {
877
968
  readonly path: "/crud/globalToneOfVoice";
878
969
  readonly auth: "apiKey";
879
970
  };
971
+ readonly crudDomainModelGet: {
972
+ readonly method: "GET";
973
+ readonly path: "/crud/domainModel";
974
+ readonly auth: "apiKey";
975
+ };
976
+ readonly crudDomainModel: {
977
+ readonly method: "POST";
978
+ readonly path: "/crud/domainModel";
979
+ readonly auth: "apiKey";
980
+ };
981
+ readonly crudFallbackResponseGet: {
982
+ readonly method: "GET";
983
+ readonly path: "/crud/fallbackResponse";
984
+ readonly auth: "apiKey";
985
+ };
986
+ readonly crudFallbackResponse: {
987
+ readonly method: "POST";
988
+ readonly path: "/crud/fallbackResponse";
989
+ readonly auth: "apiKey";
990
+ };
880
991
  readonly crudUserJourneysGet: {
881
992
  readonly method: "GET";
882
993
  readonly path: "/crud/userJourneys";
@@ -939,6 +1050,8 @@ export interface EndpointContract<Request, Result> {
939
1050
  }
940
1051
  export interface NxtlApiContracts {
941
1052
  conversation: EndpointContract<ConversationRequest, ConversationResult>;
1053
+ suggestions: EndpointContract<SuggestionsRequest, SuggestionsResult>;
1054
+ /** @deprecated Legacy plugin endpoint; absent from the current backend. */
942
1055
  reranking: EndpointContract<RerankingRequest, RerankingResult>;
943
1056
  transformation: EndpointContract<TransformationRequest, TransformationResult>;
944
1057
  crudActivatedPlugins: EndpointContract<BaseProjectRequest, CrudActivatedPluginsResult>;
@@ -946,8 +1059,12 @@ export interface NxtlApiContracts {
946
1059
  crudDeleteEntry: EndpointContract<DeleteEntryRequest, CrudDeleteEntryResult>;
947
1060
  crudDeleteMatrix: EndpointContract<DeleteMatrixRequest, CrudDeleteMatrixResult>;
948
1061
  crudDeleteUserJourney: EndpointContract<DeleteUserJourneyRequest, CrudDeleteUserJourneyResult>;
1062
+ crudEntry: EndpointContract<EntryRequest, CrudEntryResult>;
949
1063
  crudEntries: EndpointContract<EntryListRequest, CrudEntriesResult>;
950
1064
  crudEvals: EndpointContract<EvalsRequest, CrudEvalsResult>;
1065
+ crudAssessments: EndpointContract<AssessmentsRequest, CrudAssessmentsResult>;
1066
+ crudAssessment: EndpointContract<AssessmentRequest, CrudAssessmentResult>;
1067
+ crudAssessmentPatch: EndpointContract<PatchAssessmentRequest, CrudAssessmentPatchResult>;
951
1068
  crudCitations: EndpointContract<CitationsRequest, CrudCitationsResult>;
952
1069
  crudArtifactStatistics: EndpointContract<ArtifactStatisticsRequest, CrudArtifactStatisticsResult>;
953
1070
  crudMatrices: EndpointContract<BaseProjectRequest, CrudMatricesResult>;
@@ -960,6 +1077,10 @@ export interface NxtlApiContracts {
960
1077
  crudSyncEntry: EndpointContract<SyncEntryRequest, CrudSyncEntryResult>;
961
1078
  crudGlobalToneOfVoiceGet: EndpointContract<BaseProjectRequest, CrudGlobalToneOfVoiceGetResult>;
962
1079
  crudGlobalToneOfVoice: EndpointContract<GlobalToneOfVoiceRequest, CrudGlobalToneOfVoiceResult>;
1080
+ crudDomainModelGet: EndpointContract<BaseProjectRequest, CrudDomainModelGetResult>;
1081
+ crudDomainModel: EndpointContract<DomainModelRequest, CrudDomainModelResult>;
1082
+ crudFallbackResponseGet: EndpointContract<BaseProjectRequest, CrudFallbackResponseGetResult>;
1083
+ crudFallbackResponse: EndpointContract<FallbackResponseRequest, CrudFallbackResponseResult>;
963
1084
  crudUserJourneysGet: EndpointContract<UserJourneysGetRequest, CrudUserJourneysGetResult>;
964
1085
  crudUserJourneyGet: EndpointContract<UserJourneyRequest, CrudUserJourneyGetResult>;
965
1086
  crudUserJourneyPatch: EndpointContract<PatchUserJourneyRequest, CrudUserJourneyPatchResult>;