@aignostics/sdk 3.4.0 → 3.5.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/dist/index.d.cts CHANGED
@@ -1,5 +1,5 @@
1
- import { R as RunReadResponse, I as ItemResultReadResponse, A as ApplicationReadShortResponse, a as ApplicationReadResponse, b as RunCreationRequest, c as RunCreationResponse, d as ItemState, e as ItemTerminationReason, V as VersionReadResponse } from './api-DXw7V8bK.cjs';
2
- export { f as ApplicationVersion, g as ArtifactOutput, h as ArtifactState, i as ArtifactTerminationReason, a7 as Configuration, a6 as ConfigurationParameters, C as CustomMetadataUpdateRequest, j as CustomMetadataUpdateResponse, H as HTTPValidationError, k as InputArtifact, l as InputArtifactCreationRequest, m as InputArtifactResultReadResponse, n as ItemCreationRequest, o as ItemOutput, M as MeReadResponse, O as OrganizationReadResponse, p as OutputArtifact, q as OutputArtifactResultReadResponse, r as OutputArtifactScope, s as OutputArtifactVisibility, a5 as PublicApi, J as PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest, P as PublicApiAxiosParamCreator, K as PublicApiCancelRunV1RunsRunIdCancelPostRequest, L as PublicApiCreateRunV1RunsPostRequest, N as PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest, F as PublicApiFactory, E as PublicApiFp, Q as PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGetRequest, T as PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest, W as PublicApiGetRunV1RunsRunIdGetRequest, Y as PublicApiGetVersionDocumentContentRequest, Z as PublicApiGetVersionDocumentFileRequest, X as PublicApiGetVersionDocumentRequest, G as PublicApiInterface, _ as PublicApiListApplicationsV1ApplicationsGetRequest, $ as PublicApiListRunItemsV1RunsRunIdItemsGetRequest, a0 as PublicApiListRunsV1RunsGetRequest, a1 as PublicApiListVersionDocumentsRequest, a2 as PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest, a3 as PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest, a4 as PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest, t as RunItemStatistics, u as RunOutput, v as RunState, w as RunTerminationReason, S as SchedulingRequest, x as SchedulingResponse, U as UserReadResponse, y as ValidationError, z as ValidationErrorLocInner, B as VersionDocumentResponse, D as VersionDocumentVisibility } from './api-DXw7V8bK.cjs';
1
+ import { R as RunReadResponse, I as ItemResultReadResponse, A as ApplicationReadShortResponse, a as ApplicationReadResponse, b as RunCreationRequest, c as RunCreationResponse, d as ItemState, e as ItemTerminationReason, V as VersionReadResponse } from './api-B0sQ1mLM.cjs';
2
+ export { f as ApplicationVersion, g as ArtifactOutput, h as ArtifactState, i as ArtifactTerminationReason, an as Configuration, am as ConfigurationParameters, C as CustomMetadataUpdateRequest, j as CustomMetadataUpdateResponse, G as GrantCreateRequest, k as GrantReadResponse, l as GrantRelation, H as HTTPValidationError, m as InputArtifact, n as InputArtifactCreationRequest, o as InputArtifactResultReadResponse, p as ItemCreationRequest, q as ItemOutput, M as MeReadResponse, O as OrganizationReadResponse, r as OutputArtifact, s as OutputArtifactResultReadResponse, t as OutputArtifactScope, u as OutputArtifactVisibility, al as PublicApi, Y as PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest, Q as PublicApiAxiosParamCreator, Z as PublicApiCancelRunV1RunsRunIdCancelPostRequest, _ as PublicApiCreateGrantV1AccessGrantsPostRequest, $ as PublicApiCreateRunV1RunsPostRequest, a0 as PublicApiCreateShareTokenV1AccessShareTokensPostRequest, a1 as PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest, W as PublicApiFactory, T as PublicApiFp, a2 as PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGetRequest, a3 as PublicApiGetGrantV1AccessGrantsGrantIdGetRequest, a4 as PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest, a5 as PublicApiGetRunV1RunsRunIdGetRequest, a6 as PublicApiGetShareTokenV1AccessShareTokensShareTokenIdGetRequest, a8 as PublicApiGetVersionDocumentContentRequest, a9 as PublicApiGetVersionDocumentFileRequest, a7 as PublicApiGetVersionDocumentRequest, X as PublicApiInterface, aa as PublicApiListApplicationsV1ApplicationsGetRequest, ab as PublicApiListGrantsV1AccessGrantsGetRequest, ac as PublicApiListRunItemsV1RunsRunIdItemsGetRequest, ad as PublicApiListRunsV1RunsGetRequest, ae as PublicApiListShareTokensV1AccessShareTokensGetRequest, af as PublicApiListVersionDocumentsRequest, ag as PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest, ah as PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest, ai as PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest, aj as PublicApiRevokeGrantV1AccessGrantsGrantIdDeleteRequest, ak as PublicApiRevokeShareTokenV1AccessShareTokensShareTokenIdDeleteRequest, v as ResourceType, w as RunItemStatistics, x as RunOutput, y as RunState, z as RunTerminationReason, S as SchedulingRequest, B as SchedulingResponse, D as ShareTokenCreateRequest, E as ShareTokenCreateResponse, F as ShareTokenReadResponse, J as SubjectType, U as UserReadResponse, K as ValidationError, L as ValidationErrorLocInner, N as VersionDocumentResponse, P as VersionDocumentVisibility } from './api-B0sQ1mLM.cjs';
3
3
  import 'axios';
4
4
 
5
5
  /**
@@ -18,7 +18,7 @@ interface ApplicationRun extends RunReadResponse {
18
18
  can_download: boolean;
19
19
  }
20
20
  /** Derived run status that simplifies the raw `state` + `termination_reason` combination. */
21
- type RunStatus = 'PENDING' | 'PROCESSING' | 'COMPLETED' | 'COMPLETED_WITH_ERRORS' | 'CANCELED' | 'FAILED';
21
+ type RunStatus = 'PENDING' | 'PROCESSING' | 'COMPLETED' | 'COMPLETED_WITH_ERRORS' | 'CANCELED' | 'FAILED' | 'UNKNOWN';
22
22
 
23
23
  /**
24
24
  * Enriched run-item entity that extends the raw API response
@@ -34,7 +34,7 @@ interface ApplicationRunItem extends ItemResultReadResponse {
34
34
  status: string;
35
35
  }
36
36
  /** Derived item status that simplifies the raw `state` + `termination_reason` combination. */
37
- type ItemStatus = 'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'SKIPPED';
37
+ type ItemStatus = 'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'SKIPPED' | 'UNKNOWN';
38
38
 
39
39
  /**
40
40
  * Token provider function that returns a valid access token
@@ -564,14 +564,18 @@ declare const processApplicationRun: (run: RunReadResponse) => ApplicationRun;
564
564
  */
565
565
  declare function getRunProgress(run: RunReadResponse): number;
566
566
  /**
567
- * Derive a human-readable {@link RunStatus} from the raw API `state` and `termination_reason`.
567
+ * Derive a human-readable {@link RunStatus} from the raw API `state`,
568
+ * `termination_reason`, and `output`.
568
569
  *
569
570
  * Mapping rules:
570
571
  * - PENDING / PROCESSING → passed through as-is
571
572
  * - TERMINATED + CANCELED_BY_USER → CANCELED
572
- * - TERMINATED + CANCELED_BY_SYSTEM → FAILED
573
- * - TERMINATED + not all items succeeded → COMPLETED_WITH_ERRORS
574
- * - TERMINATED + all items succeeded → COMPLETED
573
+ * - TERMINATED + CANCELED_BY_SYSTEM or ALL_ITEMS_PROCESSED → derived from `output`:
574
+ * - NONE → FAILED (no items succeeded)
575
+ * - PARTIAL → COMPLETED_WITH_ERRORS (some items succeeded)
576
+ * - FULL → COMPLETED (all items succeeded)
577
+ * - otherwise → UNKNOWN
578
+ * - any other termination reason, or non-terminal state, → UNKNOWN
575
579
  *
576
580
  * @param run - Raw run response from the API
577
581
  */
@@ -610,9 +614,11 @@ declare const canDownloadItem: (item: ItemResultReadResponse) => boolean;
610
614
  *
611
615
  * Mapping rules:
612
616
  * - PENDING / PROCESSING → passed through as-is
613
- * - TERMINATED + SYSTEM_ERROR or USER_ERROR → FAILED
617
+ * - TERMINATED + no termination_reason → UNKNOWN
618
+ * - TERMINATED + an error reason (SYSTEM_ERROR, USER_ERROR, CANCELED_BY_SYSTEM, CANCELED_BY_USER) → FAILED
614
619
  * - TERMINATED + SKIPPED → SKIPPED
615
- * - TERMINATED (otherwise) → COMPLETED
620
+ * - TERMINATED + SUCCEEDED → COMPLETED
621
+ * - TERMINATED + any unrecognized reason → UNKNOWN
616
622
  *
617
623
  * @param item - Raw item response from the API
618
624
  */
package/dist/index.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { R as RunReadResponse, I as ItemResultReadResponse, A as ApplicationReadShortResponse, a as ApplicationReadResponse, b as RunCreationRequest, c as RunCreationResponse, d as ItemState, e as ItemTerminationReason, V as VersionReadResponse } from './api-DXw7V8bK.js';
2
- export { f as ApplicationVersion, g as ArtifactOutput, h as ArtifactState, i as ArtifactTerminationReason, a7 as Configuration, a6 as ConfigurationParameters, C as CustomMetadataUpdateRequest, j as CustomMetadataUpdateResponse, H as HTTPValidationError, k as InputArtifact, l as InputArtifactCreationRequest, m as InputArtifactResultReadResponse, n as ItemCreationRequest, o as ItemOutput, M as MeReadResponse, O as OrganizationReadResponse, p as OutputArtifact, q as OutputArtifactResultReadResponse, r as OutputArtifactScope, s as OutputArtifactVisibility, a5 as PublicApi, J as PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest, P as PublicApiAxiosParamCreator, K as PublicApiCancelRunV1RunsRunIdCancelPostRequest, L as PublicApiCreateRunV1RunsPostRequest, N as PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest, F as PublicApiFactory, E as PublicApiFp, Q as PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGetRequest, T as PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest, W as PublicApiGetRunV1RunsRunIdGetRequest, Y as PublicApiGetVersionDocumentContentRequest, Z as PublicApiGetVersionDocumentFileRequest, X as PublicApiGetVersionDocumentRequest, G as PublicApiInterface, _ as PublicApiListApplicationsV1ApplicationsGetRequest, $ as PublicApiListRunItemsV1RunsRunIdItemsGetRequest, a0 as PublicApiListRunsV1RunsGetRequest, a1 as PublicApiListVersionDocumentsRequest, a2 as PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest, a3 as PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest, a4 as PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest, t as RunItemStatistics, u as RunOutput, v as RunState, w as RunTerminationReason, S as SchedulingRequest, x as SchedulingResponse, U as UserReadResponse, y as ValidationError, z as ValidationErrorLocInner, B as VersionDocumentResponse, D as VersionDocumentVisibility } from './api-DXw7V8bK.js';
1
+ import { R as RunReadResponse, I as ItemResultReadResponse, A as ApplicationReadShortResponse, a as ApplicationReadResponse, b as RunCreationRequest, c as RunCreationResponse, d as ItemState, e as ItemTerminationReason, V as VersionReadResponse } from './api-B0sQ1mLM.js';
2
+ export { f as ApplicationVersion, g as ArtifactOutput, h as ArtifactState, i as ArtifactTerminationReason, an as Configuration, am as ConfigurationParameters, C as CustomMetadataUpdateRequest, j as CustomMetadataUpdateResponse, G as GrantCreateRequest, k as GrantReadResponse, l as GrantRelation, H as HTTPValidationError, m as InputArtifact, n as InputArtifactCreationRequest, o as InputArtifactResultReadResponse, p as ItemCreationRequest, q as ItemOutput, M as MeReadResponse, O as OrganizationReadResponse, r as OutputArtifact, s as OutputArtifactResultReadResponse, t as OutputArtifactScope, u as OutputArtifactVisibility, al as PublicApi, Y as PublicApiApplicationVersionDetailsV1ApplicationsApplicationIdVersionsVersionGetRequest, Q as PublicApiAxiosParamCreator, Z as PublicApiCancelRunV1RunsRunIdCancelPostRequest, _ as PublicApiCreateGrantV1AccessGrantsPostRequest, $ as PublicApiCreateRunV1RunsPostRequest, a0 as PublicApiCreateShareTokenV1AccessShareTokensPostRequest, a1 as PublicApiDeleteRunItemsV1RunsRunIdArtifactsDeleteRequest, W as PublicApiFactory, T as PublicApiFp, a2 as PublicApiGetArtifactUrlV1RunsRunIdArtifactsArtifactIdFileGetRequest, a3 as PublicApiGetGrantV1AccessGrantsGrantIdGetRequest, a4 as PublicApiGetItemByRunV1RunsRunIdItemsExternalIdGetRequest, a5 as PublicApiGetRunV1RunsRunIdGetRequest, a6 as PublicApiGetShareTokenV1AccessShareTokensShareTokenIdGetRequest, a8 as PublicApiGetVersionDocumentContentRequest, a9 as PublicApiGetVersionDocumentFileRequest, a7 as PublicApiGetVersionDocumentRequest, X as PublicApiInterface, aa as PublicApiListApplicationsV1ApplicationsGetRequest, ab as PublicApiListGrantsV1AccessGrantsGetRequest, ac as PublicApiListRunItemsV1RunsRunIdItemsGetRequest, ad as PublicApiListRunsV1RunsGetRequest, ae as PublicApiListShareTokensV1AccessShareTokensGetRequest, af as PublicApiListVersionDocumentsRequest, ag as PublicApiPutItemCustomMetadataByRunV1RunsRunIdItemsExternalIdCustomMetadataPutRequest, ah as PublicApiPutRunCustomMetadataV1RunsRunIdCustomMetadataPutRequest, ai as PublicApiReadApplicationByIdV1ApplicationsApplicationIdGetRequest, aj as PublicApiRevokeGrantV1AccessGrantsGrantIdDeleteRequest, ak as PublicApiRevokeShareTokenV1AccessShareTokensShareTokenIdDeleteRequest, v as ResourceType, w as RunItemStatistics, x as RunOutput, y as RunState, z as RunTerminationReason, S as SchedulingRequest, B as SchedulingResponse, D as ShareTokenCreateRequest, E as ShareTokenCreateResponse, F as ShareTokenReadResponse, J as SubjectType, U as UserReadResponse, K as ValidationError, L as ValidationErrorLocInner, N as VersionDocumentResponse, P as VersionDocumentVisibility } from './api-B0sQ1mLM.js';
3
3
  import 'axios';
4
4
 
5
5
  /**
@@ -18,7 +18,7 @@ interface ApplicationRun extends RunReadResponse {
18
18
  can_download: boolean;
19
19
  }
20
20
  /** Derived run status that simplifies the raw `state` + `termination_reason` combination. */
21
- type RunStatus = 'PENDING' | 'PROCESSING' | 'COMPLETED' | 'COMPLETED_WITH_ERRORS' | 'CANCELED' | 'FAILED';
21
+ type RunStatus = 'PENDING' | 'PROCESSING' | 'COMPLETED' | 'COMPLETED_WITH_ERRORS' | 'CANCELED' | 'FAILED' | 'UNKNOWN';
22
22
 
23
23
  /**
24
24
  * Enriched run-item entity that extends the raw API response
@@ -34,7 +34,7 @@ interface ApplicationRunItem extends ItemResultReadResponse {
34
34
  status: string;
35
35
  }
36
36
  /** Derived item status that simplifies the raw `state` + `termination_reason` combination. */
37
- type ItemStatus = 'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'SKIPPED';
37
+ type ItemStatus = 'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'SKIPPED' | 'UNKNOWN';
38
38
 
39
39
  /**
40
40
  * Token provider function that returns a valid access token
@@ -564,14 +564,18 @@ declare const processApplicationRun: (run: RunReadResponse) => ApplicationRun;
564
564
  */
565
565
  declare function getRunProgress(run: RunReadResponse): number;
566
566
  /**
567
- * Derive a human-readable {@link RunStatus} from the raw API `state` and `termination_reason`.
567
+ * Derive a human-readable {@link RunStatus} from the raw API `state`,
568
+ * `termination_reason`, and `output`.
568
569
  *
569
570
  * Mapping rules:
570
571
  * - PENDING / PROCESSING → passed through as-is
571
572
  * - TERMINATED + CANCELED_BY_USER → CANCELED
572
- * - TERMINATED + CANCELED_BY_SYSTEM → FAILED
573
- * - TERMINATED + not all items succeeded → COMPLETED_WITH_ERRORS
574
- * - TERMINATED + all items succeeded → COMPLETED
573
+ * - TERMINATED + CANCELED_BY_SYSTEM or ALL_ITEMS_PROCESSED → derived from `output`:
574
+ * - NONE → FAILED (no items succeeded)
575
+ * - PARTIAL → COMPLETED_WITH_ERRORS (some items succeeded)
576
+ * - FULL → COMPLETED (all items succeeded)
577
+ * - otherwise → UNKNOWN
578
+ * - any other termination reason, or non-terminal state, → UNKNOWN
575
579
  *
576
580
  * @param run - Raw run response from the API
577
581
  */
@@ -610,9 +614,11 @@ declare const canDownloadItem: (item: ItemResultReadResponse) => boolean;
610
614
  *
611
615
  * Mapping rules:
612
616
  * - PENDING / PROCESSING → passed through as-is
613
- * - TERMINATED + SYSTEM_ERROR or USER_ERROR → FAILED
617
+ * - TERMINATED + no termination_reason → UNKNOWN
618
+ * - TERMINATED + an error reason (SYSTEM_ERROR, USER_ERROR, CANCELED_BY_SYSTEM, CANCELED_BY_USER) → FAILED
614
619
  * - TERMINATED + SKIPPED → SKIPPED
615
- * - TERMINATED (otherwise) → COMPLETED
620
+ * - TERMINATED + SUCCEEDED → COMPLETED
621
+ * - TERMINATED + any unrecognized reason → UNKNOWN
616
622
  *
617
623
  * @param item - Raw item response from the API
618
624
  */