@nxtl/nxtl-types 0.1.11 → 0.2.0

package/dist/management.d.ts

@@ -0,0 +1,187 @@
+import type { BaseProjectRequest, DataSource, ErrorResponse, EvalIndex, MessageResponse, OptionalUserRequest, ServerErrorResponse, UnauthorizedResponse } from "./index.js";
+export interface AssessmentFilterRequest extends BaseProjectRequest {
+    startDate?: string;
+    endDate?: string;
+    dataSource?: DataSource;
+}
+export interface AssessmentsRequest extends AssessmentFilterRequest {
+    page?: number;
+    pageSize?: number;
+}
+export interface AssessmentRequest extends AssessmentFilterRequest {
+    episodeId: string;
+}
+export interface PatchAssessmentRequest extends BaseProjectRequest {
+    episodeId: string;
+    reconciled: boolean;
+}
+export interface AssessmentFilters {
+    startAt: string | null;
+    endBefore: string | null;
+    dataSource: DataSource | null;
+}
+export interface AssessmentRoute {
+    entryIds: string[];
+    userJourneyId: string | null;
+    matrixId: string | null;
+}
+export interface AssessmentAlignment {
+    entries: boolean;
+    userJourney: boolean;
+    matrix: boolean;
+}
+export type AssessmentStatus = "success" | "outlier";
+export type AssessmentDialogueUserInputMode = "clicked" | "typed";
+export interface AssessmentDialogueMessage {
+    role: "assistant" | "user";
+    content: string;
+    inputMode?: AssessmentDialogueUserInputMode;
+    suggestions?: string[];
+}
+export interface AssessmentEvalScore {
+    score: number;
+    presentComponents: number;
+    totalComponents: number;
+    formula?: string;
+}
+export interface AssessmentEvalReasoning {
+    index: EvalIndex;
+    text: string;
+}
+/** Readiness assessment as returned by the NXTL API. */
+export interface AssessmentItem {
+    episodeId: string;
+    createdAt: string | null;
+    updatedAt: string | null;
+    latestRunAt: string | null;
+    dataSource: DataSource;
+    ready: boolean;
+    reconciled: boolean;
+    status: AssessmentStatus;
+    reason: string;
+    reasoning: string | null;
+    readinessInferenceId: string | null;
+    route: AssessmentRoute | null;
+    alignment: AssessmentAlignment;
+    dialogue: AssessmentDialogueMessage[];
+    evalScores: Partial<Record<EvalIndex, AssessmentEvalScore>>;
+    evalReasoning: AssessmentEvalReasoning[];
+    artifactPath: string | null;
+}
+export interface AssessmentsResponse {
+    organizationId: string;
+    table: "assessment";
+    filters: AssessmentFilters;
+    page: number;
+    pageSize: number;
+    total: number;
+    items: AssessmentItem[];
+}
+export interface AssessmentResponse extends AssessmentItem {
+    organizationId: string;
+    table: "assessment";
+    filters: AssessmentFilters;
+}
+export interface PatchAssessmentResponse {
+    message: "Success";
+    episodeId: string;
+    reconciled: boolean;
+}
+export type CrudAssessmentsResult = {
+    status: 200;
+    body: AssessmentsResponse;
+} | {
+    status: 400;
+    body: ErrorResponse;
+} | {
+    status: 401;
+    body: UnauthorizedResponse;
+} | {
+    status: 500;
+    body: ServerErrorResponse;
+};
+export type CrudAssessmentResult = {
+    status: 200;
+    body: AssessmentResponse;
+} | {
+    status: 400;
+    body: ErrorResponse;
+} | {
+    status: 401;
+    body: UnauthorizedResponse;
+} | {
+    status: 404;
+    body: ErrorResponse;
+} | {
+    status: 500;
+    body: ServerErrorResponse;
+};
+export type CrudAssessmentPatchResult = {
+    status: 200;
+    body: PatchAssessmentResponse;
+} | {
+    status: 400;
+    body: ErrorResponse;
+} | {
+    status: 401;
+    body: UnauthorizedResponse;
+} | {
+    status: 404;
+    body: ErrorResponse;
+} | {
+    status: 500;
+    body: ServerErrorResponse;
+};
+export interface DomainModelRequest extends BaseProjectRequest, OptionalUserRequest {
+    domainModel: string;
+}
+export interface DomainModelResponse {
+    domainModel: string;
+}
+export type CrudDomainModelGetResult = {
+    status: 200;
+    body: DomainModelResponse;
+} | {
+    status: 401;
+    body: UnauthorizedResponse;
+} | {
+    status: 500;
+    body: ServerErrorResponse;
+};
+export type CrudDomainModelResult = {
+    status: 200;
+    body: MessageResponse;
+} | {
+    status: 401;
+    body: UnauthorizedResponse;
+} | {
+    status: 500;
+    body: ServerErrorResponse;
+};
+export interface FallbackResponseRequest extends BaseProjectRequest, OptionalUserRequest {
+    fallbackResponse: string;
+}
+export interface FallbackResponseResponse {
+    fallbackResponse: string;
+}
+export type CrudFallbackResponseGetResult = {
+    status: 200;
+    body: FallbackResponseResponse;
+} | {
+    status: 401;
+    body: UnauthorizedResponse;
+} | {
+    status: 500;
+    body: ServerErrorResponse;
+};
+export type CrudFallbackResponseResult = {
+    status: 200;
+    body: MessageResponse;
+} | {
+    status: 401;
+    body: UnauthorizedResponse;
+} | {
+    status: 500;
+    body: ServerErrorResponse;
+};
+//# sourceMappingURL=management.d.ts.map

package/dist/management.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"management.d.ts","sourceRoot":"","sources":["../src/management.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACR,kBAAkB,EAClB,UAAU,EACV,aAAa,EACb,SAAS,EACT,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,oBAAoB,EACvB,MAAM,YAAY,CAAC;AAEpB,MAAM,WAAW,uBAAwB,SAAQ,kBAAkB;IAC/D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,UAAU,CAAC;CAC3B;AAED,MAAM,WAAW,kBAAmB,SAAQ,uBAAuB;IAC/D,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,iBAAkB,SAAQ,uBAAuB;IAC9D,SAAS,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,sBAAuB,SAAQ,kBAAkB;IAC9D,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,OAAO,CAAC;CACvB;AAED,MAAM,WAAW,iBAAiB;IAC9B,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,UAAU,EAAE,UAAU,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,eAAe;IAC5B,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,mBAAmB;IAChC,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,EAAE,OAAO,CAAC;IACrB,MAAM,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,MAAM,gBAAgB,GAAG,SAAS,GAAG,SAAS,CAAC;AACrD,MAAM,MAAM,+BAA+B,GAAG,SAAS,GAAG,OAAO,CAAC;AAElE,MAAM,WAAW,yBAAyB;IACtC,IAAI,EAAE,WAAW,GAAG,MAAM,CAAC;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,+BAA+B,CAAC;IAC5C,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;CAC1B;AAED,MAAM,WAAW,mBAAmB;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,iBAAiB,EAAE,MAAM,CAAC;IAC1B,eAAe,EAAE,MAAM,CAAC;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,uBAAuB;IACpC,KAAK,EAAE,SAAS,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,wDAAwD;AACxD,MAAM,WAAW,cAAc;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,UAAU,EAAE,UAAU,CAAC;IACvB,KAAK,EAAE,OAAO,CAAC;IACf,UAAU,EAAE,OAAO,CAAC;IACpB,MAAM,EAAE,gBAAgB,CAAC;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,KAAK,EAAE,eAAe,GAAG,IAAI,CAAC;IAC9B,SAAS,EAAE,mBAAmB,CAAC;IAC/B,QAAQ,EAAE,yBAAyB,EAAE,CAAC;IACtC,UAAU,EAAE,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAC,CAAC;IAC5D,aAAa,EAAE,uBAAuB,EAAE,CAAC;IACzC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED,MAAM,WAAW,mBAAmB;IAChC,cAAc,EAAE,MAAM,CAAC;IACvB,KAAK,EAAE,YAAY,CAAC;IACpB,OAAO,EAAE,iBAAiB,CAAC;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,cAAc,EAAE,CAAC;CAC3B;AAED,MAAM,WAAW,kBAAmB,SAAQ,cAAc;IACtD,cAAc,EAAE,MAAM,CAAC;IACvB,KAAK,EAAE,YAAY,CAAC;IACpB,OAAO,EAAE,iBAAiB,CAAC;CAC9B;AAED,MAAM,WAAW,uBAAuB;IACpC,OAAO,EAAE,SAAS,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,OAAO,CAAC;CACvB;AAED,MAAM,MAAM,qBAAqB,GAC3B;IAAE,MAAM,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,mBAAmB,CAAA;CAAE,GAC1C;IAAE,MAAM,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,aAAa,CAAA;CAAE,GACpC;IAAE,MAAM,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,oBAAoB,CAAA;CAAE,GAC3C;IAAE,MAAM,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,mBAAmB,CAAA;CAAE,CAAC;AAEjD,MAAM,MAAM,oBAAoB,GAC1B;IAAE,MAAM,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,kBAAkB,CAAA;CAAE,GACzC;IAAE,MAAM,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,aAAa,CAAA;CAAE,GACpC;IAAE,MAAM,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,oBAAoB,CAAA;CAAE,GAC3C;IAAE,MAAM,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,aAAa,CAAA;CAAE,GACpC;IAAE,MAAM,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,mBAAmB,CAAA;CAAE,CAAC;AAEjD,MAAM,MAAM,yBAAyB,GAC/B;IAAE,MAAM,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,uBAAuB,CAAA;CAAE,GAC9C;IAAE,MAAM,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,aAAa,CAAA;CAAE,GACpC;IAAE,MAAM,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,oBAAoB,CAAA;CAAE,GAC3C;IAAE,MAAM,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,aAAa,CAAA;CAAE,GACpC;IAAE,MAAM,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,mBAAmB,CAAA;CAAE,CAAC;AAEjD,MAAM,WAAW,kBACb,SAAQ,kBAAkB,EACtB,mBAAmB;IACvB,WAAW,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,mBAAmB;IAChC,WAAW,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,MAAM,wBAAwB,GAC9B;IAAE,MAAM,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,mBAAmB,CAAA;CAAE,GAC1C;IAAE,MAAM,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,oBAAoB,CAAA;CAAE,GAC3C;IAAE,MAAM,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,mBAAmB,CAAA;CAAE,CAAC;AAEjD,MAAM,MAAM,qBAAqB,GAC3B;IAAE,MAAM,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,eAAe,CAAA;CAAE,GACtC;IAAE,MAAM,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,oBAAoB,CAAA;CAAE,GAC3C;IAAE,MAAM,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,mBAAmB,CAAA;CAAE,CAAC;AAEjD,MAAM,WAAW,uBACb,SAAQ,kBAAkB,EACtB,mBAAmB;IACvB,gBAAgB,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,wBAAwB;IACrC,gBAAgB,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,MAAM,6BAA6B,GACnC;IAAE,MAAM,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,wBAAwB,CAAA;CAAE,GAC/C;IAAE,MAAM,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,oBAAoB,CAAA;CAAE,GAC3C;IAAE,MAAM,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,mBAAmB,CAAA;CAAE,CAAC;AAEjD,MAAM,MAAM,0BAA0B,GAChC;IAAE,MAAM,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,eAAe,CAAA;CAAE,GACtC;IAAE,MAAM,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,oBAAoB,CAAA;CAAE,GAC3C;IAAE,MAAM,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,mBAAmB,CAAA;CAAE,CAAC"}

package/dist/management.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=management.js.map

package/dist/management.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"management.js","sourceRoot":"","sources":["../src/management.ts"],"names":[],"mappings":""}