@datalayer/core 1.0.25 → 1.1.43
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 +11 -134
- package/lib/api/index.d.ts +0 -9
- package/lib/api/index.js +0 -9
- package/lib/cli-login.js +167 -0
- package/lib/client/auth/AuthenticationManager.d.ts +3 -3
- package/lib/client/auth/AuthenticationManager.js +13 -13
- package/lib/client/auth/strategies.d.ts +2 -2
- package/lib/client/auth/strategies.js +6 -6
- package/lib/client/base.d.ts +9 -12
- package/lib/client/base.js +17 -19
- package/lib/client/index.d.ts +10 -98
- package/lib/client/index.js +12 -21
- package/lib/client/mixins/IAMMixin.js +26 -26
- package/lib/components/auth/Login.js +2 -2
- package/lib/components/avatars/UserAvatar.d.ts +16 -0
- package/lib/components/avatars/UserAvatar.js +47 -0
- package/lib/components/avatars/index.d.ts +1 -0
- package/lib/components/avatars/index.js +1 -0
- package/lib/components/billing/BillableAccountSelect.js +4 -0
- package/lib/components/billing/index.js +4 -0
- package/lib/components/context/index.d.ts +0 -1
- package/lib/components/context/index.js +0 -1
- package/lib/components/display/DisplayHandle.d.ts +12 -0
- package/lib/components/display/DisplayHandle.js +11 -0
- package/lib/components/display/LiveRelativeTime.js +4 -0
- package/lib/components/display/index.d.ts +1 -0
- package/lib/components/display/index.js +1 -0
- package/lib/components/flashes/index.d.ts +0 -1
- package/lib/components/flashes/index.js +0 -1
- package/lib/components/index.d.ts +0 -1
- package/lib/components/index.js +0 -1
- package/lib/components/principal/Principal.d.ts +7 -0
- package/lib/components/principal/Principal.js +153 -16
- package/lib/components/principal/PrincipalAvatar.d.ts +1 -1
- package/lib/components/principal/PrincipalAvatar.js +4 -28
- package/lib/components/principal/PrincipalBadge.js +4 -4
- package/lib/components/principal/PrincipalDetailsOverlay.d.ts +4 -2
- package/lib/components/principal/PrincipalDetailsOverlay.js +27 -7
- package/lib/components/principal/PrincipalSwitcherMenu.js +79 -42
- package/lib/components/progress/index.d.ts +0 -1
- package/lib/components/progress/index.js +0 -1
- package/lib/components/sharing/ShareAccessComponent.d.ts +3 -2
- package/lib/components/sharing/ShareAccessComponent.js +194 -147
- package/lib/components/sharing/SharingEditor.js +4 -0
- package/lib/components/snippets/index.d.ts +1 -1
- package/lib/components/snippets/index.js +1 -1
- package/lib/components/students/StudentResultCircle.d.ts +21 -0
- package/lib/components/students/StudentResultCircle.js +59 -0
- package/lib/components/students/index.d.ts +1 -1
- package/lib/components/students/index.js +1 -1
- package/lib/components/time/LiveRelativeTime.js +4 -0
- package/lib/components/time/index.js +4 -0
- package/lib/components/timeline/index.js +4 -0
- package/lib/components/tokens/index.d.ts +1 -1
- package/lib/components/tokens/index.js +1 -1
- package/lib/components/toolbars/index.d.ts +1 -3
- package/lib/components/toolbars/index.js +1 -3
- package/lib/config/Configuration.d.ts +13 -13
- package/lib/config/Configuration.js +5 -5
- package/lib/hooks/cacheConverters.d.ts +21 -0
- package/lib/hooks/cacheConverters.js +110 -0
- package/lib/hooks/index.d.ts +0 -2
- package/lib/hooks/index.js +0 -2
- package/lib/hooks/useCache.d.ts +64 -35
- package/lib/hooks/useCache.js +661 -306
- package/lib/hooks/useDatalayer.js +3 -1
- package/lib/hooks/useIAM.js +2 -4
- package/lib/hooks/useLocationHandles.d.ts +3 -1
- package/lib/hooks/useLocationHandles.js +2 -1
- package/lib/hooks/usePrincipalStore.d.ts +2 -2
- package/lib/hooks/usePrincipalStore.js +97 -14
- package/lib/hooks/useSelectedPrincipal.js +1 -1
- package/lib/hooks/useUser.js +19 -2
- package/lib/index.d.ts +1 -6
- package/lib/index.js +1 -13
- package/lib/main.js +3 -3
- package/lib/mocks/index.js +1 -1
- package/lib/mocks/models/index.d.ts +0 -1
- package/lib/mocks/models/index.js +0 -1
- package/lib/models/Datasource.d.ts +2 -2
- package/lib/models/IAM.d.ts +1 -1
- package/lib/models/School.d.ts +12 -3
- package/lib/models/Secret.d.ts +2 -2
- package/lib/models/Student.d.ts +13 -3
- package/lib/models/Usage.d.ts +11 -1
- package/lib/models/UserDTO.d.ts +2 -2
- package/lib/models/UserSettings.d.ts +1 -1
- package/lib/models/UserSettings.js +1 -1
- package/lib/models/index.d.ts +0 -30
- package/lib/models/index.js +0 -30
- package/lib/otel/client/OtelClient.d.ts +2 -2
- package/lib/otel/client/OtelClient.js +2 -2
- package/lib/otel/hooks/index.js +5 -5
- package/lib/otel/types.d.ts +1 -1
- package/lib/otel/views/OtelLive.js +1 -1
- package/lib/routes/index.d.ts +1 -0
- package/lib/routes/index.js +1 -0
- package/lib/routes/publicPaths.d.ts +23 -0
- package/lib/routes/publicPaths.js +74 -0
- package/lib/state/State.d.ts +0 -12
- package/lib/state/State.js +0 -12
- package/lib/state/substates/CoreState.js +13 -13
- package/lib/state/substates/IAMState.d.ts +1 -1
- package/lib/state/substates/IAMState.js +14 -14
- package/lib/state/substates/LayoutState.d.ts +12 -1
- package/lib/state/substates/SurveysState.d.ts +1 -1
- package/lib/state/substates/SurveysState.js +10 -10
- package/lib/state/substates/index.d.ts +0 -7
- package/lib/state/substates/index.js +0 -7
- package/lib/utils/Handles.js +3 -1
- package/lib/utils/index.d.ts +0 -1
- package/lib/utils/index.js +0 -1
- package/lib/views/api-keys/APIKeys.js +12 -3
- package/lib/views/datasources/DatasourceDetail.d.ts +1 -1
- package/lib/views/datasources/DatasourceNew.d.ts +1 -1
- package/lib/views/datasources/Datasources.d.ts +1 -1
- package/lib/views/datasources/Datasources.js +12 -3
- package/lib/views/iam/SignInSimple.d.ts +37 -1
- package/lib/views/iam/SignInSimple.js +111 -13
- package/package.json +5 -3
- package/lib/App.css +0 -47
- package/lib/App.d.ts +0 -3
- package/lib/App.js +0 -21
- package/lib/api/runtimes/checkpoints.d.ts +0 -122
- package/lib/api/runtimes/checkpoints.js +0 -118
- package/lib/api/runtimes/environments.d.ts +0 -9
- package/lib/api/runtimes/environments.js +0 -29
- package/lib/api/runtimes/healthz.d.ts +0 -15
- package/lib/api/runtimes/healthz.js +0 -44
- package/lib/api/runtimes/index.d.ts +0 -12
- package/lib/api/runtimes/index.js +0 -16
- package/lib/api/runtimes/runtimes.d.ts +0 -138
- package/lib/api/runtimes/runtimes.js +0 -230
- package/lib/api/runtimes/snapshots.d.ts +0 -38
- package/lib/api/runtimes/snapshots.js +0 -82
- package/lib/api/scheduler/index.d.ts +0 -6
- package/lib/api/scheduler/index.js +0 -10
- package/lib/api/scheduler/schedules.d.ts +0 -85
- package/lib/api/scheduler/schedules.js +0 -78
- package/lib/api/spacer/documents.d.ts +0 -12
- package/lib/api/spacer/documents.js +0 -43
- package/lib/api/spacer/healthz.d.ts +0 -15
- package/lib/api/spacer/healthz.js +0 -44
- package/lib/api/spacer/index.d.ts +0 -15
- package/lib/api/spacer/index.js +0 -19
- package/lib/api/spacer/items.d.ts +0 -25
- package/lib/api/spacer/items.js +0 -55
- package/lib/api/spacer/lexicals.d.ts +0 -34
- package/lib/api/spacer/lexicals.js +0 -89
- package/lib/api/spacer/notebooks.d.ts +0 -34
- package/lib/api/spacer/notebooks.js +0 -89
- package/lib/api/spacer/spaces.d.ts +0 -84
- package/lib/api/spacer/spaces.js +0 -170
- package/lib/api/spacer/users.d.ts +0 -9
- package/lib/api/spacer/users.js +0 -29
- package/lib/client/mixins/RuntimesMixin.d.ts +0 -93
- package/lib/client/mixins/RuntimesMixin.js +0 -229
- package/lib/client/mixins/SpacerMixin.d.ts +0 -210
- package/lib/client/mixins/SpacerMixin.js +0 -615
- package/lib/client/utils/spacerUtils.d.ts +0 -18
- package/lib/client/utils/spacerUtils.js +0 -32
- package/lib/collaboration/DatalayerCollaboration.d.ts +0 -13
- package/lib/collaboration/DatalayerCollaboration.js +0 -28
- package/lib/collaboration/DatalayerCollaborationProvider.d.ts +0 -60
- package/lib/collaboration/DatalayerCollaborationProvider.js +0 -163
- package/lib/collaboration/index.d.ts +0 -2
- package/lib/collaboration/index.js +0 -6
- package/lib/components/context/SpaceSelect.d.ts +0 -2
- package/lib/components/context/SpaceSelect.js +0 -42
- package/lib/components/flashes/FlashDisclaimer.d.ts +0 -2
- package/lib/components/flashes/FlashDisclaimer.js +0 -17
- package/lib/components/icons/ArtifactIcon.d.ts +0 -10
- package/lib/components/icons/ArtifactIcon.js +0 -58
- package/lib/components/icons/index.d.ts +0 -1
- package/lib/components/icons/index.js +0 -5
- package/lib/components/nbgrader/NbGradesDetails.d.ts +0 -5
- package/lib/components/nbgrader/NbGradesDetails.js +0 -14
- package/lib/components/nbgrader/index.d.ts +0 -1
- package/lib/components/nbgrader/index.js +0 -5
- package/lib/components/progress/CreditsIndicator.d.ts +0 -33
- package/lib/components/progress/CreditsIndicator.js +0 -23
- package/lib/components/runtimes/RuntimeCellVariables.d.ts +0 -39
- package/lib/components/runtimes/RuntimeCellVariables.js +0 -172
- package/lib/components/runtimes/RuntimeCellVariablesDialog.d.ts +0 -37
- package/lib/components/runtimes/RuntimeCellVariablesDialog.js +0 -101
- package/lib/components/runtimes/RuntimeLauncherDialog.d.ts +0 -57
- package/lib/components/runtimes/RuntimeLauncherDialog.js +0 -275
- package/lib/components/runtimes/RuntimePickerBase.d.ts +0 -69
- package/lib/components/runtimes/RuntimePickerBase.js +0 -122
- package/lib/components/runtimes/RuntimePickerCell.d.ts +0 -34
- package/lib/components/runtimes/RuntimePickerCell.js +0 -104
- package/lib/components/runtimes/RuntimePickerNotebook.d.ts +0 -42
- package/lib/components/runtimes/RuntimePickerNotebook.js +0 -232
- package/lib/components/runtimes/RuntimeReservationControl.d.ts +0 -47
- package/lib/components/runtimes/RuntimeReservationControl.js +0 -42
- package/lib/components/runtimes/RuntimeSimplePicker.d.ts +0 -38
- package/lib/components/runtimes/RuntimeSimplePicker.js +0 -155
- package/lib/components/runtimes/RuntimeTransfer.d.ts +0 -16
- package/lib/components/runtimes/RuntimeTransfer.js +0 -5
- package/lib/components/runtimes/RuntimeUtils.d.ts +0 -17
- package/lib/components/runtimes/RuntimeUtils.js +0 -178
- package/lib/components/runtimes/RuntimeVariables.d.ts +0 -38
- package/lib/components/runtimes/RuntimeVariables.js +0 -75
- package/lib/components/runtimes/index.d.ts +0 -11
- package/lib/components/runtimes/index.js +0 -15
- package/lib/components/scheduler/ScheduleMenu.d.ts +0 -54
- package/lib/components/scheduler/ScheduleMenu.js +0 -154
- package/lib/components/scheduler/index.d.ts +0 -1
- package/lib/components/scheduler/index.js +0 -5
- package/lib/components/snapshots/SandboxSnapshotMenu.d.ts +0 -33
- package/lib/components/snapshots/SandboxSnapshotMenu.js +0 -169
- package/lib/components/snapshots/index.d.ts +0 -1
- package/lib/components/snapshots/index.js +0 -5
- package/lib/components/snippets/SnippetDialog.d.ts +0 -42
- package/lib/components/snippets/SnippetDialog.js +0 -42
- package/lib/components/students/StudentItemStatus.d.ts +0 -7
- package/lib/components/students/StudentItemStatus.js +0 -66
- package/lib/components/tokens/SpaceVariantToken.d.ts +0 -5
- package/lib/components/tokens/SpaceVariantToken.js +0 -23
- package/lib/components/toolbars/AssignmentEditorToolbar.d.ts +0 -4
- package/lib/components/toolbars/AssignmentEditorToolbar.js +0 -18
- package/lib/components/toolbars/DocumentEditorToolbar.d.ts +0 -2
- package/lib/components/toolbars/DocumentEditorToolbar.js +0 -12
- package/lib/components/toolbars/NotebookEditorToolbar.d.ts +0 -29
- package/lib/components/toolbars/NotebookEditorToolbar.js +0 -30
- package/lib/examples/CellExample.d.ts +0 -6
- package/lib/examples/CellExample.js +0 -20
- package/lib/examples/NotebookExample.d.ts +0 -6
- package/lib/examples/NotebookExample.js +0 -19
- package/lib/examples/lexical-theme.css +0 -436
- package/lib/examples/notebooks/IPyWidgetsExample.ipynb.json +0 -101
- package/lib/examples/notebooks/IPyWidgetsExampleWithState.ipynb.json +0 -112
- package/lib/examples/notebooks/Lite.ipynb.json +0 -128
- package/lib/examples/notebooks/Matplotlib.ipynb.json +0 -137
- package/lib/examples/notebooks/NotebookExample1.ipynb.json +0 -126
- package/lib/examples/notebooks/NotebookExample2.ipynb.json +0 -48
- package/lib/examples/notebooks/NotebookOutputs.ipynb.json +0 -49
- package/lib/examples/notebooks/NotebookToCExample.ipynb.json +0 -102
- package/lib/examples/notebooks/PyGWalker.ipynb.json +0 -55
- package/lib/hooks/useCellOutputshot.d.ts +0 -4
- package/lib/hooks/useCellOutputshot.js +0 -25
- package/lib/hooks/useProjects.d.ts +0 -628
- package/lib/hooks/useProjects.js +0 -190
- package/lib/hooks/useRuntimes.d.ts +0 -5
- package/lib/hooks/useRuntimes.js +0 -34
- package/lib/mocks/jupyter/index.js +0 -5
- package/lib/mocks/models/CourseMock.d.ts +0 -6
- package/lib/mocks/models/CourseMock.js +0 -29
- package/lib/mocks/models/SpaceMock.d.ts +0 -6
- package/lib/mocks/models/SpaceMock.js +0 -25
- package/lib/models/Assignment.d.ts +0 -7
- package/lib/models/Assignment.js +0 -5
- package/lib/models/Cell.d.ts +0 -8
- package/lib/models/Cell.js +0 -5
- package/lib/models/CodeBlock.d.ts +0 -10
- package/lib/models/CodeBlock.js +0 -5
- package/lib/models/CodeSandboxSnapshot.d.ts +0 -92
- package/lib/models/CodeSandboxSnapshot.js +0 -13
- package/lib/models/CodeSandboxSnapshotDTO.d.ts +0 -173
- package/lib/models/CodeSandboxSnapshotDTO.js +0 -139
- package/lib/models/CodefeedBlocks.d.ts +0 -7
- package/lib/models/CodefeedBlocks.js +0 -5
- package/lib/models/Content.d.ts +0 -5
- package/lib/models/Content.js +0 -5
- package/lib/models/Course.d.ts +0 -17
- package/lib/models/Course.js +0 -5
- package/lib/models/Dataset.d.ts +0 -16
- package/lib/models/Dataset.js +0 -5
- package/lib/models/Document.d.ts +0 -8
- package/lib/models/Document.js +0 -5
- package/lib/models/Environment.d.ts +0 -86
- package/lib/models/Environment.js +0 -5
- package/lib/models/EnvironmentDTO.d.ts +0 -125
- package/lib/models/EnvironmentDTO.js +0 -88
- package/lib/models/Exercise.d.ts +0 -16
- package/lib/models/Exercise.js +0 -5
- package/lib/models/Item.d.ts +0 -20
- package/lib/models/Item.js +0 -5
- package/lib/models/ItemDTO.d.ts +0 -74
- package/lib/models/ItemDTO.js +0 -186
- package/lib/models/ItemType.d.ts +0 -2
- package/lib/models/ItemType.js +0 -5
- package/lib/models/Lesson.d.ts +0 -5
- package/lib/models/Lesson.js +0 -5
- package/lib/models/LexicalDTO.d.ts +0 -155
- package/lib/models/LexicalDTO.js +0 -157
- package/lib/models/Library.d.ts +0 -10
- package/lib/models/Library.js +0 -5
- package/lib/models/Notebook.d.ts +0 -11
- package/lib/models/Notebook.js +0 -5
- package/lib/models/NotebookDTO.d.ts +0 -96
- package/lib/models/NotebookDTO.js +0 -153
- package/lib/models/Page.d.ts +0 -41
- package/lib/models/Page.js +0 -25
- package/lib/models/PageTag.d.ts +0 -19
- package/lib/models/PageTag.js +0 -94
- package/lib/models/ProjectDTO.d.ts +0 -89
- package/lib/models/ProjectDTO.js +0 -131
- package/lib/models/Runtime.d.ts +0 -123
- package/lib/models/Runtime.js +0 -18
- package/lib/models/RuntimeDTO.d.ts +0 -191
- package/lib/models/RuntimeDTO.js +0 -204
- package/lib/models/Space.d.ts +0 -35
- package/lib/models/Space.js +0 -66
- package/lib/models/SpaceDTO.d.ts +0 -334
- package/lib/models/SpaceDTO.js +0 -244
- package/lib/models/SpaceItem.d.ts +0 -10
- package/lib/models/SpaceItem.js +0 -5
- package/lib/models/SpaceMember.d.ts +0 -6
- package/lib/models/SpaceMember.js +0 -5
- package/lib/models/StudentItem.d.ts +0 -21
- package/lib/models/StudentItem.js +0 -5
- package/lib/services/DatalayerServiceManager.d.ts +0 -22
- package/lib/services/DatalayerServiceManager.js +0 -69
- package/lib/services/index.d.ts +0 -4
- package/lib/services/index.js +0 -7
- package/lib/services/reconnectToRuntime.d.ts +0 -32
- package/lib/services/reconnectToRuntime.js +0 -59
- package/lib/state/substates/CellState.d.ts +0 -12
- package/lib/state/substates/CellState.js +0 -22
- package/lib/state/substates/DocumentState.d.ts +0 -10
- package/lib/state/substates/DocumentState.js +0 -14
- package/lib/state/substates/GradeState.d.ts +0 -10
- package/lib/state/substates/GradeState.js +0 -14
- package/lib/state/substates/JupyterLabState.d.ts +0 -16
- package/lib/state/substates/JupyterLabState.js +0 -17
- package/lib/state/substates/NbformatState.d.ts +0 -13
- package/lib/state/substates/NbformatState.js +0 -16
- package/lib/state/substates/RuntimesState.d.ts +0 -79
- package/lib/state/substates/RuntimesState.js +0 -180
- package/lib/state/substates/SpaceState.d.ts +0 -11
- package/lib/state/substates/SpaceState.js +0 -16
- package/lib/stateful/index.d.ts +0 -2
- package/lib/stateful/index.js +0 -6
- package/lib/stateful/jupyter/exec/Python.d.ts +0 -5
- package/lib/stateful/jupyter/exec/Python.js +0 -100
- package/lib/stateful/jupyter/exec/Snippets.d.ts +0 -105
- package/lib/stateful/jupyter/exec/Snippets.js +0 -101
- package/lib/stateful/jupyter/exec/index.d.ts +0 -2
- package/lib/stateful/jupyter/exec/index.js +0 -6
- package/lib/stateful/jupyter/index.d.ts +0 -2
- package/lib/stateful/jupyter/index.js +0 -6
- package/lib/stateful/jupyter/kernelsHandler.d.ts +0 -8
- package/lib/stateful/jupyter/kernelsHandler.js +0 -39
- package/lib/stateful/runtimes/actions.d.ts +0 -102
- package/lib/stateful/runtimes/actions.js +0 -249
- package/lib/stateful/runtimes/apis.d.ts +0 -273
- package/lib/stateful/runtimes/apis.js +0 -5
- package/lib/stateful/runtimes/index.d.ts +0 -5
- package/lib/stateful/runtimes/index.js +0 -9
- package/lib/stateful/runtimes/settings.d.ts +0 -15
- package/lib/stateful/runtimes/settings.js +0 -31
- package/lib/stateful/runtimes/snapshots.d.ts +0 -25
- package/lib/stateful/runtimes/snapshots.js +0 -150
- package/lib/stateful/runtimes/utils.d.ts +0 -7
- package/lib/stateful/runtimes/utils.js +0 -14
- package/lib/utils/Cells.d.ts +0 -2
- package/lib/utils/Cells.js +0 -28
- /package/lib/{mocks/jupyter/index.d.ts → cli-login.d.ts} +0 -0
|
@@ -1,118 +0,0 @@
|
|
|
1
|
-
/*
|
|
2
|
-
* Copyright (c) 2023-2025 Datalayer, Inc.
|
|
3
|
-
* Distributed under the terms of the Modified BSD License.
|
|
4
|
-
*/
|
|
5
|
-
/**
|
|
6
|
-
* Runtime checkpoints API functions for the Datalayer platform.
|
|
7
|
-
*
|
|
8
|
-
* Provides functions for managing CRIU full-pod checkpoints.
|
|
9
|
-
* These are distinct from code sandbox snapshots (Jupyter sandbox snapshots).
|
|
10
|
-
*
|
|
11
|
-
* @module api/runtimes/checkpoints
|
|
12
|
-
*/
|
|
13
|
-
import { requestDatalayerAPI } from '../DatalayerApi.js';
|
|
14
|
-
import { API_BASE_PATHS, DEFAULT_SERVICE_URLS } from '../constants.js';
|
|
15
|
-
import { validateToken, validateRequiredString } from '../utils/validation.js';
|
|
16
|
-
// ─── API Functions ─────────────────────────────────────────────────────────
|
|
17
|
-
/**
|
|
18
|
-
* List runtime checkpoints for a specific runtime.
|
|
19
|
-
* @param token - Authentication token
|
|
20
|
-
* @param baseUrl - Base URL for the runtimes API
|
|
21
|
-
* @param runtimeUid - Runtime UID to list checkpoints for
|
|
22
|
-
* @returns Promise resolving to list of checkpoints
|
|
23
|
-
*/
|
|
24
|
-
export const listCheckpoints = async (token, baseUrl = DEFAULT_SERVICE_URLS.RUNTIMES, runtimeUid) => {
|
|
25
|
-
validateToken(token);
|
|
26
|
-
if (!runtimeUid) {
|
|
27
|
-
throw new Error('runtimeUid is required to list checkpoints');
|
|
28
|
-
}
|
|
29
|
-
return requestDatalayerAPI({
|
|
30
|
-
url: `${baseUrl}${API_BASE_PATHS.RUNTIMES}/runtime-checkpoints/${encodeURIComponent(runtimeUid)}`,
|
|
31
|
-
method: 'GET',
|
|
32
|
-
token,
|
|
33
|
-
});
|
|
34
|
-
};
|
|
35
|
-
/**
|
|
36
|
-
* Get a single runtime checkpoint by ID.
|
|
37
|
-
* @param token - Authentication token
|
|
38
|
-
* @param runtimeUid - The runtime UID
|
|
39
|
-
* @param checkpointId - The checkpoint ID (ULID)
|
|
40
|
-
* @param baseUrl - Base URL for the runtimes API
|
|
41
|
-
* @returns Promise resolving to checkpoint details
|
|
42
|
-
*/
|
|
43
|
-
export const getCheckpoint = async (token, runtimeUid, checkpointId, baseUrl = DEFAULT_SERVICE_URLS.RUNTIMES) => {
|
|
44
|
-
validateToken(token);
|
|
45
|
-
validateRequiredString(runtimeUid, 'Runtime UID');
|
|
46
|
-
validateRequiredString(checkpointId, 'Checkpoint ID');
|
|
47
|
-
return requestDatalayerAPI({
|
|
48
|
-
url: `${baseUrl}${API_BASE_PATHS.RUNTIMES}/runtime-checkpoints/${encodeURIComponent(runtimeUid)}/${checkpointId}`,
|
|
49
|
-
method: 'GET',
|
|
50
|
-
token,
|
|
51
|
-
});
|
|
52
|
-
};
|
|
53
|
-
/**
|
|
54
|
-
* Create a checkpoint record (after a CRIU checkpoint has been taken).
|
|
55
|
-
* @param token - Authentication token
|
|
56
|
-
* @param data - Checkpoint creation payload (runtime_uid, agentspec, etc.)
|
|
57
|
-
* @param baseUrl - Base URL for the runtimes API
|
|
58
|
-
* @returns Promise resolving to the created checkpoint
|
|
59
|
-
*/
|
|
60
|
-
export const createCheckpoint = async (token, data, baseUrl = DEFAULT_SERVICE_URLS.RUNTIMES) => {
|
|
61
|
-
validateToken(token);
|
|
62
|
-
return requestDatalayerAPI({
|
|
63
|
-
url: `${baseUrl}${API_BASE_PATHS.RUNTIMES}/runtime-checkpoints`,
|
|
64
|
-
method: 'POST',
|
|
65
|
-
token,
|
|
66
|
-
body: data,
|
|
67
|
-
});
|
|
68
|
-
};
|
|
69
|
-
/**
|
|
70
|
-
* Poll a checkpoint until it reaches one of the target statuses.
|
|
71
|
-
*
|
|
72
|
-
* Useful for waiting until an async pause (status "paused")
|
|
73
|
-
* completes before proceeding. Checkpoint status stays "paused"
|
|
74
|
-
* during resume — only the agent runtime status transitions.
|
|
75
|
-
*
|
|
76
|
-
* @param token - Authentication token
|
|
77
|
-
* @param runtimeUid - The runtime UID that owns the checkpoint
|
|
78
|
-
* @param checkpointId - The checkpoint ID (ULID) to poll
|
|
79
|
-
* @param targetStatuses - Set of statuses that signal completion (e.g. ["paused", "failed"])
|
|
80
|
-
* @param baseUrl - Base URL for the runtimes API
|
|
81
|
-
* @param intervalMs - Polling interval in milliseconds (default: 2000)
|
|
82
|
-
* @param timeoutMs - Maximum wait time in milliseconds (default: 600000 = 10 min)
|
|
83
|
-
* @returns Promise resolving to the checkpoint data once a target status is reached
|
|
84
|
-
* @throws {Error} If polling times out or the request fails
|
|
85
|
-
*/
|
|
86
|
-
export const waitForCheckpointStatus = async (token, runtimeUid, checkpointId, targetStatuses, baseUrl = DEFAULT_SERVICE_URLS.RUNTIMES, intervalMs = 2000, timeoutMs = 600_000) => {
|
|
87
|
-
validateToken(token);
|
|
88
|
-
validateRequiredString(runtimeUid, 'Runtime UID');
|
|
89
|
-
validateRequiredString(checkpointId, 'Checkpoint ID');
|
|
90
|
-
const deadline = Date.now() + timeoutMs;
|
|
91
|
-
while (Date.now() < deadline) {
|
|
92
|
-
const resp = await getCheckpoint(token, runtimeUid, checkpointId, baseUrl);
|
|
93
|
-
if (targetStatuses.includes(resp.checkpoint.status)) {
|
|
94
|
-
return resp.checkpoint;
|
|
95
|
-
}
|
|
96
|
-
// Wait before next poll
|
|
97
|
-
await new Promise(resolve => setTimeout(resolve, intervalMs));
|
|
98
|
-
}
|
|
99
|
-
throw new Error(`Checkpoint ${checkpointId} did not reach status [${targetStatuses.join(', ')}] within ${timeoutMs / 1000}s`);
|
|
100
|
-
};
|
|
101
|
-
/**
|
|
102
|
-
* Delete a runtime checkpoint.
|
|
103
|
-
* @param token - Authentication token
|
|
104
|
-
* @param runtimeUid - The runtime UID that owns the checkpoint
|
|
105
|
-
* @param checkpointId - The checkpoint ID (ULID) to delete
|
|
106
|
-
* @param baseUrl - Base URL for the runtimes API
|
|
107
|
-
* @returns Promise resolving when deletion is complete
|
|
108
|
-
*/
|
|
109
|
-
export const deleteCheckpoint = async (token, runtimeUid, checkpointId, baseUrl = DEFAULT_SERVICE_URLS.RUNTIMES) => {
|
|
110
|
-
validateToken(token);
|
|
111
|
-
validateRequiredString(runtimeUid, 'Runtime UID');
|
|
112
|
-
validateRequiredString(checkpointId, 'Checkpoint ID');
|
|
113
|
-
return requestDatalayerAPI({
|
|
114
|
-
url: `${baseUrl}${API_BASE_PATHS.RUNTIMES}/runtime-checkpoints/${encodeURIComponent(runtimeUid)}/${checkpointId}`,
|
|
115
|
-
method: 'DELETE',
|
|
116
|
-
token,
|
|
117
|
-
});
|
|
118
|
-
};
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
import { ListEnvironmentsResponse } from '../../models/EnvironmentDTO';
|
|
2
|
-
/**
|
|
3
|
-
* List all available computing environments.
|
|
4
|
-
* @param token - Authentication token
|
|
5
|
-
* @param baseUrl - Base URL for the API (defaults to production Runtimes URL)
|
|
6
|
-
* @returns Promise resolving to list of available environments
|
|
7
|
-
* @throws {Error} If authentication token is missing or invalid
|
|
8
|
-
*/
|
|
9
|
-
export declare const listEnvironments: (token: string, baseUrl?: string) => Promise<ListEnvironmentsResponse>;
|
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
/*
|
|
2
|
-
* Copyright (c) 2023-2025 Datalayer, Inc.
|
|
3
|
-
* Distributed under the terms of the Modified BSD License.
|
|
4
|
-
*/
|
|
5
|
-
/**
|
|
6
|
-
* Computing environments API functions for the Datalayer platform.
|
|
7
|
-
*
|
|
8
|
-
* Provides functions for managing computing environment configurations.
|
|
9
|
-
*
|
|
10
|
-
* @module api/runtimes/environments
|
|
11
|
-
*/
|
|
12
|
-
import { requestDatalayerAPI } from '../DatalayerApi.js';
|
|
13
|
-
import { API_BASE_PATHS, DEFAULT_SERVICE_URLS } from '../constants.js';
|
|
14
|
-
import { validateToken } from '../utils/validation.js';
|
|
15
|
-
/**
|
|
16
|
-
* List all available computing environments.
|
|
17
|
-
* @param token - Authentication token
|
|
18
|
-
* @param baseUrl - Base URL for the API (defaults to production Runtimes URL)
|
|
19
|
-
* @returns Promise resolving to list of available environments
|
|
20
|
-
* @throws {Error} If authentication token is missing or invalid
|
|
21
|
-
*/
|
|
22
|
-
export const listEnvironments = async (token, baseUrl = DEFAULT_SERVICE_URLS.RUNTIMES) => {
|
|
23
|
-
validateToken(token);
|
|
24
|
-
return requestDatalayerAPI({
|
|
25
|
-
url: `${baseUrl}${API_BASE_PATHS.RUNTIMES}/environments`,
|
|
26
|
-
method: 'GET',
|
|
27
|
-
token,
|
|
28
|
-
});
|
|
29
|
-
};
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
import type { HealthzPingResponse } from '../../models/Common';
|
|
2
|
-
/**
|
|
3
|
-
* Health check ping endpoint for Runtimes service
|
|
4
|
-
* @param baseUrl - Base URL for the API (defaults to production Runtimes URL)
|
|
5
|
-
* @returns Health check response
|
|
6
|
-
* @throws {Error} If the health check fails
|
|
7
|
-
*
|
|
8
|
-
* @remarks
|
|
9
|
-
* This endpoint provides a basic health check for the Runtimes service.
|
|
10
|
-
* It returns the current status of the service.
|
|
11
|
-
*
|
|
12
|
-
* Expected status codes:
|
|
13
|
-
* - 200: Service is healthy
|
|
14
|
-
*/
|
|
15
|
-
export declare const ping: (baseUrl?: string) => Promise<HealthzPingResponse>;
|
|
@@ -1,44 +0,0 @@
|
|
|
1
|
-
/*
|
|
2
|
-
* Copyright (c) 2023-2025 Datalayer, Inc.
|
|
3
|
-
* Distributed under the terms of the Modified BSD License.
|
|
4
|
-
*/
|
|
5
|
-
/**
|
|
6
|
-
* Health check API functions for the Datalayer Runtimes service.
|
|
7
|
-
*
|
|
8
|
-
* Provides functions for checking the health status of the Runtimes service.
|
|
9
|
-
*
|
|
10
|
-
* @module api/runtimes/healthz
|
|
11
|
-
*/
|
|
12
|
-
import { requestDatalayerAPI } from '../DatalayerApi.js';
|
|
13
|
-
import { API_BASE_PATHS, DEFAULT_SERVICE_URLS } from '../constants.js';
|
|
14
|
-
/**
|
|
15
|
-
* Health check ping endpoint for Runtimes service
|
|
16
|
-
* @param baseUrl - Base URL for the API (defaults to production Runtimes URL)
|
|
17
|
-
* @returns Health check response
|
|
18
|
-
* @throws {Error} If the health check fails
|
|
19
|
-
*
|
|
20
|
-
* @remarks
|
|
21
|
-
* This endpoint provides a basic health check for the Runtimes service.
|
|
22
|
-
* It returns the current status of the service.
|
|
23
|
-
*
|
|
24
|
-
* Expected status codes:
|
|
25
|
-
* - 200: Service is healthy
|
|
26
|
-
*/
|
|
27
|
-
export const ping = async (baseUrl = DEFAULT_SERVICE_URLS.RUNTIMES) => {
|
|
28
|
-
try {
|
|
29
|
-
const response = await requestDatalayerAPI({
|
|
30
|
-
url: `${baseUrl}${API_BASE_PATHS.RUNTIMES}/ping`,
|
|
31
|
-
method: 'GET',
|
|
32
|
-
});
|
|
33
|
-
return response;
|
|
34
|
-
}
|
|
35
|
-
catch (error) {
|
|
36
|
-
// Check if it's a response error with status code information
|
|
37
|
-
if (error.response) {
|
|
38
|
-
const status = error.response.status;
|
|
39
|
-
throw new Error(`Health check failed: Service unhealthy (status ${status}) - ${error.message}`);
|
|
40
|
-
}
|
|
41
|
-
// Re-throw other errors (network errors, etc.)
|
|
42
|
-
throw new Error(`Health check failed: ${error.message}`);
|
|
43
|
-
}
|
|
44
|
-
};
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Runtimes API exports.
|
|
3
|
-
*
|
|
4
|
-
* Provides organized access to runtime management functionality.
|
|
5
|
-
*
|
|
6
|
-
* @module api/runtimes
|
|
7
|
-
*/
|
|
8
|
-
export * as environments from './environments';
|
|
9
|
-
export * as healthz from './healthz';
|
|
10
|
-
export * as runtimes from './runtimes';
|
|
11
|
-
export * as snapshots from './snapshots';
|
|
12
|
-
export * as checkpoints from './checkpoints';
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
/*
|
|
2
|
-
* Copyright (c) 2023-2025 Datalayer, Inc.
|
|
3
|
-
* Distributed under the terms of the Modified BSD License.
|
|
4
|
-
*/
|
|
5
|
-
/**
|
|
6
|
-
* Runtimes API exports.
|
|
7
|
-
*
|
|
8
|
-
* Provides organized access to runtime management functionality.
|
|
9
|
-
*
|
|
10
|
-
* @module api/runtimes
|
|
11
|
-
*/
|
|
12
|
-
export * as environments from './environments.js';
|
|
13
|
-
export * as healthz from './healthz.js';
|
|
14
|
-
export * as runtimes from './runtimes.js';
|
|
15
|
-
export * as snapshots from './snapshots.js';
|
|
16
|
-
export * as checkpoints from './checkpoints.js';
|
|
@@ -1,138 +0,0 @@
|
|
|
1
|
-
import { RuntimeData, CreateRuntimeRequest, CreateRuntimeResponse, ListRuntimesResponse } from '../../models/RuntimeDTO';
|
|
2
|
-
/**
|
|
3
|
-
* Create a new runtime instance.
|
|
4
|
-
* @param token - Authentication token
|
|
5
|
-
* @param data - Runtime creation configuration
|
|
6
|
-
* @param baseUrl - Base URL for the API (defaults to production Runtimes URL)
|
|
7
|
-
* @returns Promise resolving to the created runtime details
|
|
8
|
-
* @throws {Error} If authentication token is missing or invalid
|
|
9
|
-
* @throws {Error} With status 404 if the environment is not found
|
|
10
|
-
* @throws {Error} With status 503 if no runtime is available
|
|
11
|
-
*/
|
|
12
|
-
export declare const createRuntime: (token: string, data: CreateRuntimeRequest, baseUrl?: string) => Promise<CreateRuntimeResponse>;
|
|
13
|
-
/**
|
|
14
|
-
* List all runtime instances.
|
|
15
|
-
* @param token - Authentication token
|
|
16
|
-
* @param baseUrl - Base URL for the API (defaults to production Runtimes URL)
|
|
17
|
-
* @returns Promise resolving to list of runtime instances
|
|
18
|
-
* @throws {Error} If authentication token is missing or invalid
|
|
19
|
-
*/
|
|
20
|
-
export declare const listRuntimes: (token: string, baseUrl?: string) => Promise<ListRuntimesResponse>;
|
|
21
|
-
/**
|
|
22
|
-
* Get details for a specific runtime instance.
|
|
23
|
-
* @param token - Authentication token
|
|
24
|
-
* @param podName - The unique pod name of the runtime
|
|
25
|
-
* @param baseUrl - Base URL for the API (defaults to production Runtimes URL)
|
|
26
|
-
* @returns Promise resolving to runtime details
|
|
27
|
-
* @throws {Error} If authentication token is missing or invalid
|
|
28
|
-
* @throws {Error} If pod name is missing or invalid
|
|
29
|
-
* @throws {Error} With status 404 if the runtime is not found
|
|
30
|
-
*/
|
|
31
|
-
export declare const getRuntime: (token: string, podName: string, baseUrl?: string) => Promise<RuntimeData>;
|
|
32
|
-
/**
|
|
33
|
-
* Delete a runtime instance.
|
|
34
|
-
* @param token - Authentication token
|
|
35
|
-
* @param podName - The unique pod name of the runtime to delete
|
|
36
|
-
* @param baseUrl - Base URL for the API (defaults to production Runtimes URL)
|
|
37
|
-
* @returns Promise resolving when deletion is complete
|
|
38
|
-
* @throws {Error} If authentication token is missing or invalid
|
|
39
|
-
* @throws {Error} If pod name is missing or invalid
|
|
40
|
-
* @throws {Error} With status 404 if the runtime is not found
|
|
41
|
-
*/
|
|
42
|
-
export declare const deleteRuntime: (token: string, podName: string, baseUrl?: string) => Promise<void>;
|
|
43
|
-
/**
|
|
44
|
-
* Update a runtime instance.
|
|
45
|
-
* @param token - Authentication token
|
|
46
|
-
* @param podName - The unique pod name of the runtime
|
|
47
|
-
* @param from - The source to update from
|
|
48
|
-
* @param baseUrl - Base URL for the API (defaults to production Runtimes URL)
|
|
49
|
-
* @returns Promise resolving to updated runtime details
|
|
50
|
-
* @throws {Error} If authentication token is missing or invalid
|
|
51
|
-
* @throws {Error} If pod name is missing or invalid
|
|
52
|
-
* @throws {Error} With status 404 if the runtime is not found
|
|
53
|
-
*/
|
|
54
|
-
export declare const updateRuntime: (token: string, podName: string, from: string, baseUrl?: string) => Promise<RuntimeData>;
|
|
55
|
-
/**
|
|
56
|
-
* Response from the pause/resume runtime endpoints.
|
|
57
|
-
* The server returns 202 Accepted and provides a checkpoint UID
|
|
58
|
-
* that can be polled for status updates.
|
|
59
|
-
*/
|
|
60
|
-
export interface PauseResumeResponse {
|
|
61
|
-
success: boolean;
|
|
62
|
-
message: string;
|
|
63
|
-
checkpoint_id: string | null;
|
|
64
|
-
}
|
|
65
|
-
/**
|
|
66
|
-
* Optional body for the pause endpoint.
|
|
67
|
-
* Metadata is stored in the checkpoint Solr record created by the backend.
|
|
68
|
-
*/
|
|
69
|
-
export interface PauseRuntimeBody {
|
|
70
|
-
/** Checkpoint mode: 'criu' (full) or 'light' (history-only) */
|
|
71
|
-
checkpoint_mode?: 'criu' | 'light';
|
|
72
|
-
/** Human-readable checkpoint name */
|
|
73
|
-
name?: string;
|
|
74
|
-
/** Checkpoint description */
|
|
75
|
-
description?: string;
|
|
76
|
-
/** Agentspec identifier */
|
|
77
|
-
agent_spec_id?: string;
|
|
78
|
-
/** Full agentspec payload to persist with the checkpoint */
|
|
79
|
-
agentspec?: Record<string, any>;
|
|
80
|
-
/** Additional metadata */
|
|
81
|
-
metadata?: Record<string, any>;
|
|
82
|
-
/** Lightweight checkpoint message history */
|
|
83
|
-
messages?: string[];
|
|
84
|
-
}
|
|
85
|
-
/**
|
|
86
|
-
* Pause a runtime by creating a checkpoint (async, light mode by default).
|
|
87
|
-
*
|
|
88
|
-
* Returns immediately with a 202 Accepted response. The actual checkpoint
|
|
89
|
-
* process runs in the background. Use the returned `checkpoint_id` to
|
|
90
|
-
* poll for status via the runtime-checkpoints API.
|
|
91
|
-
*
|
|
92
|
-
* @param token - Authentication token
|
|
93
|
-
* @param podName - The unique pod name of the runtime to pause
|
|
94
|
-
* @param baseUrl - Base URL for the API (defaults to production Runtimes URL)
|
|
95
|
-
* @param body - Optional metadata to store in the checkpoint record
|
|
96
|
-
* @returns Promise resolving with the checkpoint ID for status tracking
|
|
97
|
-
* @throws {Error} If authentication token is missing or invalid
|
|
98
|
-
* @throws {Error} If pod name is missing or invalid
|
|
99
|
-
*/
|
|
100
|
-
export declare const pauseRuntime: (token: string, podName: string, baseUrl?: string, body?: PauseRuntimeBody) => Promise<PauseResumeResponse>;
|
|
101
|
-
/**
|
|
102
|
-
* Optional body for the resume endpoint.
|
|
103
|
-
* Contains information needed by the operator to restore from a checkpoint.
|
|
104
|
-
*/
|
|
105
|
-
export interface ResumeRuntimeBody {
|
|
106
|
-
/** Checkpoint mode to resume from: 'criu' or 'light' */
|
|
107
|
-
checkpoint_mode?: 'criu' | 'light';
|
|
108
|
-
/** Explicit checkpoint identifier */
|
|
109
|
-
checkpoint_id?: string;
|
|
110
|
-
/** Agentspec identifier (required by the operator for restore) */
|
|
111
|
-
agent_spec_id?: string;
|
|
112
|
-
/** Specific checkpoint timestamp to restore from */
|
|
113
|
-
checkpoint_timestamp?: string;
|
|
114
|
-
/** Environment name override */
|
|
115
|
-
environment_name?: string;
|
|
116
|
-
/** Container image override */
|
|
117
|
-
container_image?: string;
|
|
118
|
-
/** Target node name */
|
|
119
|
-
node_name?: string;
|
|
120
|
-
/** Additional metadata */
|
|
121
|
-
metadata?: Record<string, any>;
|
|
122
|
-
}
|
|
123
|
-
/**
|
|
124
|
-
* Resume a paused runtime by restoring from a checkpoint (async).
|
|
125
|
-
*
|
|
126
|
-
* Returns immediately with a 202 Accepted response. The actual restore
|
|
127
|
-
* process runs in the background. Use the returned `checkpoint_id` to
|
|
128
|
-
* poll for status.
|
|
129
|
-
*
|
|
130
|
-
* @param token - Authentication token
|
|
131
|
-
* @param podName - The unique pod name of the runtime to resume
|
|
132
|
-
* @param baseUrl - Base URL for the API (defaults to production Runtimes URL)
|
|
133
|
-
* @param body - Optional body with agent_spec_id and restore options
|
|
134
|
-
* @returns Promise resolving with the checkpoint ID for status tracking
|
|
135
|
-
* @throws {Error} If authentication token is missing or invalid
|
|
136
|
-
* @throws {Error} If pod name is missing or invalid
|
|
137
|
-
*/
|
|
138
|
-
export declare const resumeRuntime: (token: string, podName: string, baseUrl?: string, body?: ResumeRuntimeBody) => Promise<PauseResumeResponse>;
|
|
@@ -1,230 +0,0 @@
|
|
|
1
|
-
/*
|
|
2
|
-
* Copyright (c) 2023-2025 Datalayer, Inc.
|
|
3
|
-
* Distributed under the terms of the Modified BSD License.
|
|
4
|
-
*/
|
|
5
|
-
/**
|
|
6
|
-
* Runtime instances API functions for the Datalayer platform.
|
|
7
|
-
*
|
|
8
|
-
* Provides functions for managing runtime instances (active compute containers).
|
|
9
|
-
*
|
|
10
|
-
* @module api/runtimes/runtimes
|
|
11
|
-
*/
|
|
12
|
-
import { requestDatalayerAPI } from '../DatalayerApi.js';
|
|
13
|
-
import { API_BASE_PATHS, DEFAULT_SERVICE_URLS } from '../constants.js';
|
|
14
|
-
import { validateToken, validateRequiredString } from '../utils/validation.js';
|
|
15
|
-
/**
|
|
16
|
-
* Create a new runtime instance.
|
|
17
|
-
* @param token - Authentication token
|
|
18
|
-
* @param data - Runtime creation configuration
|
|
19
|
-
* @param baseUrl - Base URL for the API (defaults to production Runtimes URL)
|
|
20
|
-
* @returns Promise resolving to the created runtime details
|
|
21
|
-
* @throws {Error} If authentication token is missing or invalid
|
|
22
|
-
* @throws {Error} With status 404 if the environment is not found
|
|
23
|
-
* @throws {Error} With status 503 if no runtime is available
|
|
24
|
-
*/
|
|
25
|
-
export const createRuntime = async (token, data, baseUrl = DEFAULT_SERVICE_URLS.RUNTIMES) => {
|
|
26
|
-
validateToken(token);
|
|
27
|
-
try {
|
|
28
|
-
return await requestDatalayerAPI({
|
|
29
|
-
url: `${baseUrl}${API_BASE_PATHS.RUNTIMES}/runtimes`,
|
|
30
|
-
method: 'POST',
|
|
31
|
-
body: data,
|
|
32
|
-
token,
|
|
33
|
-
});
|
|
34
|
-
}
|
|
35
|
-
catch (error) {
|
|
36
|
-
// Handle specific error cases
|
|
37
|
-
if (error.response) {
|
|
38
|
-
const status = error.response.status;
|
|
39
|
-
const responseData = error.response.data || {};
|
|
40
|
-
if (status === 404) {
|
|
41
|
-
// Environment not found
|
|
42
|
-
throw new Error(`Environment '${data.environment_name}' not found. ${responseData.message || 'Please check the environment name and try again.'}`);
|
|
43
|
-
}
|
|
44
|
-
else if (status === 503) {
|
|
45
|
-
// No runtime available
|
|
46
|
-
throw new Error(`No runtime available. ${responseData.message || 'The service is temporarily unavailable or at capacity. Please try again later.'}`);
|
|
47
|
-
}
|
|
48
|
-
}
|
|
49
|
-
// Re-throw the original error for other cases
|
|
50
|
-
throw error;
|
|
51
|
-
}
|
|
52
|
-
};
|
|
53
|
-
/**
|
|
54
|
-
* List all runtime instances.
|
|
55
|
-
* @param token - Authentication token
|
|
56
|
-
* @param baseUrl - Base URL for the API (defaults to production Runtimes URL)
|
|
57
|
-
* @returns Promise resolving to list of runtime instances
|
|
58
|
-
* @throws {Error} If authentication token is missing or invalid
|
|
59
|
-
*/
|
|
60
|
-
export const listRuntimes = async (token, baseUrl = DEFAULT_SERVICE_URLS.RUNTIMES) => {
|
|
61
|
-
validateToken(token);
|
|
62
|
-
const response = await requestDatalayerAPI({
|
|
63
|
-
url: `${baseUrl}${API_BASE_PATHS.RUNTIMES}/runtimes`,
|
|
64
|
-
method: 'GET',
|
|
65
|
-
token,
|
|
66
|
-
});
|
|
67
|
-
// The API returns { success: true, message: string, runtimes: Runtime[] }
|
|
68
|
-
// The response already has the correct structure, just return it
|
|
69
|
-
return response;
|
|
70
|
-
};
|
|
71
|
-
/**
|
|
72
|
-
* Get details for a specific runtime instance.
|
|
73
|
-
* @param token - Authentication token
|
|
74
|
-
* @param podName - The unique pod name of the runtime
|
|
75
|
-
* @param baseUrl - Base URL for the API (defaults to production Runtimes URL)
|
|
76
|
-
* @returns Promise resolving to runtime details
|
|
77
|
-
* @throws {Error} If authentication token is missing or invalid
|
|
78
|
-
* @throws {Error} If pod name is missing or invalid
|
|
79
|
-
* @throws {Error} With status 404 if the runtime is not found
|
|
80
|
-
*/
|
|
81
|
-
export const getRuntime = async (token, podName, baseUrl = DEFAULT_SERVICE_URLS.RUNTIMES) => {
|
|
82
|
-
validateToken(token);
|
|
83
|
-
validateRequiredString(podName, 'Pod name');
|
|
84
|
-
try {
|
|
85
|
-
const response = await requestDatalayerAPI({
|
|
86
|
-
url: `${baseUrl}${API_BASE_PATHS.RUNTIMES}/runtimes/${podName}`,
|
|
87
|
-
method: 'GET',
|
|
88
|
-
token,
|
|
89
|
-
});
|
|
90
|
-
// The API returns { success: true, message: string, runtime: Runtime }
|
|
91
|
-
// (Previously used 'kernel' field, now uses 'runtime')
|
|
92
|
-
// Try 'runtime' field first (current API)
|
|
93
|
-
if (response.runtime) {
|
|
94
|
-
return {
|
|
95
|
-
...response.runtime,
|
|
96
|
-
pod_name: response.runtime.pod_name || podName,
|
|
97
|
-
};
|
|
98
|
-
}
|
|
99
|
-
// Fallback to 'kernel' field (old API)
|
|
100
|
-
if (response.kernel) {
|
|
101
|
-
return {
|
|
102
|
-
...response.kernel,
|
|
103
|
-
pod_name: response.kernel.pod_name || podName,
|
|
104
|
-
};
|
|
105
|
-
}
|
|
106
|
-
// Fallback if response structure is different
|
|
107
|
-
return response;
|
|
108
|
-
}
|
|
109
|
-
catch (error) {
|
|
110
|
-
// Handle specific error cases
|
|
111
|
-
if (error.response && error.response.status === 404) {
|
|
112
|
-
// Runtime not found
|
|
113
|
-
throw new Error(`Runtime with pod name '${podName}' not found. Please check the pod name and try again.`);
|
|
114
|
-
}
|
|
115
|
-
// Re-throw the original error for other cases
|
|
116
|
-
throw error;
|
|
117
|
-
}
|
|
118
|
-
};
|
|
119
|
-
/**
|
|
120
|
-
* Delete a runtime instance.
|
|
121
|
-
* @param token - Authentication token
|
|
122
|
-
* @param podName - The unique pod name of the runtime to delete
|
|
123
|
-
* @param baseUrl - Base URL for the API (defaults to production Runtimes URL)
|
|
124
|
-
* @returns Promise resolving when deletion is complete
|
|
125
|
-
* @throws {Error} If authentication token is missing or invalid
|
|
126
|
-
* @throws {Error} If pod name is missing or invalid
|
|
127
|
-
* @throws {Error} With status 404 if the runtime is not found
|
|
128
|
-
*/
|
|
129
|
-
export const deleteRuntime = async (token, podName, baseUrl = DEFAULT_SERVICE_URLS.RUNTIMES) => {
|
|
130
|
-
validateToken(token);
|
|
131
|
-
validateRequiredString(podName, 'Pod name');
|
|
132
|
-
try {
|
|
133
|
-
return await requestDatalayerAPI({
|
|
134
|
-
url: `${baseUrl}${API_BASE_PATHS.RUNTIMES}/runtimes/${podName}`,
|
|
135
|
-
method: 'DELETE',
|
|
136
|
-
token,
|
|
137
|
-
});
|
|
138
|
-
}
|
|
139
|
-
catch (error) {
|
|
140
|
-
// Handle specific error cases
|
|
141
|
-
if (error.response && error.response.status === 404) {
|
|
142
|
-
// Runtime not found
|
|
143
|
-
throw new Error(`Runtime with pod name '${podName}' not found. Cannot delete a non-existent runtime.`);
|
|
144
|
-
}
|
|
145
|
-
// Re-throw the original error for other cases
|
|
146
|
-
throw error;
|
|
147
|
-
}
|
|
148
|
-
};
|
|
149
|
-
/**
|
|
150
|
-
* Update a runtime instance.
|
|
151
|
-
* @param token - Authentication token
|
|
152
|
-
* @param podName - The unique pod name of the runtime
|
|
153
|
-
* @param from - The source to update from
|
|
154
|
-
* @param baseUrl - Base URL for the API (defaults to production Runtimes URL)
|
|
155
|
-
* @returns Promise resolving to updated runtime details
|
|
156
|
-
* @throws {Error} If authentication token is missing or invalid
|
|
157
|
-
* @throws {Error} If pod name is missing or invalid
|
|
158
|
-
* @throws {Error} With status 404 if the runtime is not found
|
|
159
|
-
*/
|
|
160
|
-
export const updateRuntime = async (token, podName, from, baseUrl = DEFAULT_SERVICE_URLS.RUNTIMES) => {
|
|
161
|
-
validateToken(token);
|
|
162
|
-
validateRequiredString(podName, 'Pod name');
|
|
163
|
-
try {
|
|
164
|
-
return await requestDatalayerAPI({
|
|
165
|
-
url: `${baseUrl}${API_BASE_PATHS.RUNTIMES}/runtimes/${podName}`,
|
|
166
|
-
method: 'PUT',
|
|
167
|
-
token,
|
|
168
|
-
body: { from },
|
|
169
|
-
});
|
|
170
|
-
}
|
|
171
|
-
catch (error) {
|
|
172
|
-
// Handle specific error cases
|
|
173
|
-
if (error.response && error.response.status === 404) {
|
|
174
|
-
// Runtime not found
|
|
175
|
-
throw new Error(`Runtime with pod name '${podName}' not found. Cannot update a non-existent runtime.`);
|
|
176
|
-
}
|
|
177
|
-
// Re-throw the original error for other cases
|
|
178
|
-
throw error;
|
|
179
|
-
}
|
|
180
|
-
};
|
|
181
|
-
/**
|
|
182
|
-
* Pause a runtime by creating a checkpoint (async, light mode by default).
|
|
183
|
-
*
|
|
184
|
-
* Returns immediately with a 202 Accepted response. The actual checkpoint
|
|
185
|
-
* process runs in the background. Use the returned `checkpoint_id` to
|
|
186
|
-
* poll for status via the runtime-checkpoints API.
|
|
187
|
-
*
|
|
188
|
-
* @param token - Authentication token
|
|
189
|
-
* @param podName - The unique pod name of the runtime to pause
|
|
190
|
-
* @param baseUrl - Base URL for the API (defaults to production Runtimes URL)
|
|
191
|
-
* @param body - Optional metadata to store in the checkpoint record
|
|
192
|
-
* @returns Promise resolving with the checkpoint ID for status tracking
|
|
193
|
-
* @throws {Error} If authentication token is missing or invalid
|
|
194
|
-
* @throws {Error} If pod name is missing or invalid
|
|
195
|
-
*/
|
|
196
|
-
export const pauseRuntime = async (token, podName, baseUrl = DEFAULT_SERVICE_URLS.RUNTIMES, body) => {
|
|
197
|
-
validateToken(token);
|
|
198
|
-
validateRequiredString(podName, 'Pod name');
|
|
199
|
-
return await requestDatalayerAPI({
|
|
200
|
-
url: `${baseUrl}${API_BASE_PATHS.RUNTIMES}/runtimes/${encodeURIComponent(podName)}/pause`,
|
|
201
|
-
method: 'POST',
|
|
202
|
-
token,
|
|
203
|
-
...(body ? { body } : {}),
|
|
204
|
-
});
|
|
205
|
-
};
|
|
206
|
-
/**
|
|
207
|
-
* Resume a paused runtime by restoring from a checkpoint (async).
|
|
208
|
-
*
|
|
209
|
-
* Returns immediately with a 202 Accepted response. The actual restore
|
|
210
|
-
* process runs in the background. Use the returned `checkpoint_id` to
|
|
211
|
-
* poll for status.
|
|
212
|
-
*
|
|
213
|
-
* @param token - Authentication token
|
|
214
|
-
* @param podName - The unique pod name of the runtime to resume
|
|
215
|
-
* @param baseUrl - Base URL for the API (defaults to production Runtimes URL)
|
|
216
|
-
* @param body - Optional body with agent_spec_id and restore options
|
|
217
|
-
* @returns Promise resolving with the checkpoint ID for status tracking
|
|
218
|
-
* @throws {Error} If authentication token is missing or invalid
|
|
219
|
-
* @throws {Error} If pod name is missing or invalid
|
|
220
|
-
*/
|
|
221
|
-
export const resumeRuntime = async (token, podName, baseUrl = DEFAULT_SERVICE_URLS.RUNTIMES, body) => {
|
|
222
|
-
validateToken(token);
|
|
223
|
-
validateRequiredString(podName, 'Pod name');
|
|
224
|
-
return await requestDatalayerAPI({
|
|
225
|
-
url: `${baseUrl}${API_BASE_PATHS.RUNTIMES}/runtimes/${encodeURIComponent(podName)}/resume`,
|
|
226
|
-
method: 'POST',
|
|
227
|
-
token,
|
|
228
|
-
...(body ? { body } : {}),
|
|
229
|
-
});
|
|
230
|
-
};
|
|
@@ -1,38 +0,0 @@
|
|
|
1
|
-
import { CreateCodeSandboxSnapshotRequest, ListCodeSandboxSnapshotsResponse, GetCodeSandboxSnapshotResponse, CreateCodeSandboxSnapshotResponse } from '../../models/CodeSandboxSnapshotDTO';
|
|
2
|
-
/**
|
|
3
|
-
* Create a snapshot of a runtime instance.
|
|
4
|
-
* @param token - Authentication token
|
|
5
|
-
* @param data - Snapshot creation configuration
|
|
6
|
-
* @param baseUrl - Base URL for the API (defaults to production Runtimes URL)
|
|
7
|
-
* @returns Promise resolving to the created snapshot response
|
|
8
|
-
* @throws {Error} If authentication token is missing or invalid
|
|
9
|
-
*/
|
|
10
|
-
export declare const createSnapshot: (token: string, data: CreateCodeSandboxSnapshotRequest, baseUrl?: string) => Promise<CreateCodeSandboxSnapshotResponse>;
|
|
11
|
-
/**
|
|
12
|
-
* List all code sandbox snapshots.
|
|
13
|
-
* @param token - Authentication token
|
|
14
|
-
* @param baseUrl - Base URL for the API (defaults to production Runtimes URL)
|
|
15
|
-
* @returns Promise resolving to list of snapshots
|
|
16
|
-
* @throws {Error} If authentication token is missing or invalid
|
|
17
|
-
*/
|
|
18
|
-
export declare const listSnapshots: (token: string, baseUrl?: string) => Promise<ListCodeSandboxSnapshotsResponse>;
|
|
19
|
-
/**
|
|
20
|
-
* Get details for a specific code sandbox snapshot.
|
|
21
|
-
* @param token - Authentication token
|
|
22
|
-
* @param snapshotId - The unique identifier of the snapshot
|
|
23
|
-
* @param baseUrl - Base URL for the API (defaults to production Runtimes URL)
|
|
24
|
-
* @returns Promise resolving to snapshot details wrapped in response
|
|
25
|
-
* @throws {Error} If authentication token is missing or invalid
|
|
26
|
-
* @throws {Error} If snapshot ID is missing or invalid
|
|
27
|
-
*/
|
|
28
|
-
export declare const getSnapshot: (token: string, snapshotId: string, baseUrl?: string) => Promise<GetCodeSandboxSnapshotResponse>;
|
|
29
|
-
/**
|
|
30
|
-
* Delete a code sandbox snapshot.
|
|
31
|
-
* @param token - Authentication token
|
|
32
|
-
* @param snapshotId - The unique identifier of the snapshot to delete
|
|
33
|
-
* @param baseUrl - Base URL for the API (defaults to production Runtimes URL)
|
|
34
|
-
* @returns Promise resolving when deletion is complete
|
|
35
|
-
* @throws {Error} If authentication token is missing or invalid
|
|
36
|
-
* @throws {Error} If snapshot ID is missing or invalid
|
|
37
|
-
*/
|
|
38
|
-
export declare const deleteSnapshot: (token: string, snapshotId: string, baseUrl?: string) => Promise<void>;
|