@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,82 +0,0 @@
|
|
|
1
|
-
/*
|
|
2
|
-
* Copyright (c) 2023-2025 Datalayer, Inc.
|
|
3
|
-
* Distributed under the terms of the Modified BSD License.
|
|
4
|
-
*/
|
|
5
|
-
/**
|
|
6
|
-
* Code Sandbox snapshots API functions for the Datalayer platform.
|
|
7
|
-
*
|
|
8
|
-
* Provides functions for managing code sandbox snapshots (saved runtime states).
|
|
9
|
-
*
|
|
10
|
-
* @module api/runtimes/snapshots
|
|
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 snapshot of a runtime instance.
|
|
17
|
-
* @param token - Authentication token
|
|
18
|
-
* @param data - Snapshot creation configuration
|
|
19
|
-
* @param baseUrl - Base URL for the API (defaults to production Runtimes URL)
|
|
20
|
-
* @returns Promise resolving to the created snapshot response
|
|
21
|
-
* @throws {Error} If authentication token is missing or invalid
|
|
22
|
-
*/
|
|
23
|
-
export const createSnapshot = async (token, data, baseUrl = DEFAULT_SERVICE_URLS.RUNTIMES) => {
|
|
24
|
-
validateToken(token);
|
|
25
|
-
return requestDatalayerAPI({
|
|
26
|
-
url: `${baseUrl}${API_BASE_PATHS.RUNTIMES}/sandbox-snapshots`,
|
|
27
|
-
method: 'POST',
|
|
28
|
-
token,
|
|
29
|
-
body: data,
|
|
30
|
-
});
|
|
31
|
-
};
|
|
32
|
-
/**
|
|
33
|
-
* List all code sandbox snapshots.
|
|
34
|
-
* @param token - Authentication token
|
|
35
|
-
* @param baseUrl - Base URL for the API (defaults to production Runtimes URL)
|
|
36
|
-
* @returns Promise resolving to list of snapshots
|
|
37
|
-
* @throws {Error} If authentication token is missing or invalid
|
|
38
|
-
*/
|
|
39
|
-
export const listSnapshots = async (token, baseUrl = DEFAULT_SERVICE_URLS.RUNTIMES) => {
|
|
40
|
-
validateToken(token);
|
|
41
|
-
return requestDatalayerAPI({
|
|
42
|
-
url: `${baseUrl}${API_BASE_PATHS.RUNTIMES}/sandbox-snapshots`,
|
|
43
|
-
method: 'GET',
|
|
44
|
-
token,
|
|
45
|
-
});
|
|
46
|
-
};
|
|
47
|
-
/**
|
|
48
|
-
* Get details for a specific code sandbox snapshot.
|
|
49
|
-
* @param token - Authentication token
|
|
50
|
-
* @param snapshotId - The unique identifier of the snapshot
|
|
51
|
-
* @param baseUrl - Base URL for the API (defaults to production Runtimes URL)
|
|
52
|
-
* @returns Promise resolving to snapshot details wrapped in response
|
|
53
|
-
* @throws {Error} If authentication token is missing or invalid
|
|
54
|
-
* @throws {Error} If snapshot ID is missing or invalid
|
|
55
|
-
*/
|
|
56
|
-
export const getSnapshot = async (token, snapshotId, baseUrl = DEFAULT_SERVICE_URLS.RUNTIMES) => {
|
|
57
|
-
validateToken(token);
|
|
58
|
-
validateRequiredString(snapshotId, 'Snapshot ID');
|
|
59
|
-
return requestDatalayerAPI({
|
|
60
|
-
url: `${baseUrl}${API_BASE_PATHS.RUNTIMES}/sandbox-snapshots/${snapshotId}`,
|
|
61
|
-
method: 'GET',
|
|
62
|
-
token,
|
|
63
|
-
});
|
|
64
|
-
};
|
|
65
|
-
/**
|
|
66
|
-
* Delete a code sandbox snapshot.
|
|
67
|
-
* @param token - Authentication token
|
|
68
|
-
* @param snapshotId - The unique identifier of the snapshot to delete
|
|
69
|
-
* @param baseUrl - Base URL for the API (defaults to production Runtimes URL)
|
|
70
|
-
* @returns Promise resolving when deletion is complete
|
|
71
|
-
* @throws {Error} If authentication token is missing or invalid
|
|
72
|
-
* @throws {Error} If snapshot ID is missing or invalid
|
|
73
|
-
*/
|
|
74
|
-
export const deleteSnapshot = async (token, snapshotId, baseUrl = DEFAULT_SERVICE_URLS.RUNTIMES) => {
|
|
75
|
-
validateToken(token);
|
|
76
|
-
validateRequiredString(snapshotId, 'Snapshot ID');
|
|
77
|
-
return requestDatalayerAPI({
|
|
78
|
-
url: `${baseUrl}${API_BASE_PATHS.RUNTIMES}/sandbox-snapshots/${snapshotId}`,
|
|
79
|
-
method: 'DELETE',
|
|
80
|
-
token,
|
|
81
|
-
});
|
|
82
|
-
};
|
|
@@ -1,85 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Raw schedule document as returned by the scheduler service.
|
|
3
|
-
*
|
|
4
|
-
* Fields follow the Solr suffix convention (`_s`, `_b`, `_dt`, `_i`).
|
|
5
|
-
*/
|
|
6
|
-
export interface ScheduleDoc {
|
|
7
|
-
uid?: string;
|
|
8
|
-
type_s?: string;
|
|
9
|
-
notebook_uid_s?: string;
|
|
10
|
-
owner_uid_s?: string;
|
|
11
|
-
cron_expression_s?: string;
|
|
12
|
-
preset_s?: string;
|
|
13
|
-
enabled_b?: boolean;
|
|
14
|
-
[key: string]: unknown;
|
|
15
|
-
}
|
|
16
|
-
/**
|
|
17
|
-
* Request payload to create or update a notebook schedule.
|
|
18
|
-
*/
|
|
19
|
-
export interface UpsertScheduleRequest {
|
|
20
|
-
/** Target notebook uid. */
|
|
21
|
-
notebookUid: string;
|
|
22
|
-
/** Cron expression (e.g. `* * * * *`). */
|
|
23
|
-
cronExpression: string;
|
|
24
|
-
/** Optional preset identifier (e.g. `every-minute`, `hourly`, `daily`, `custom`). */
|
|
25
|
-
preset?: string;
|
|
26
|
-
/** Whether the schedule is enabled. Defaults to `true`. */
|
|
27
|
-
enabled?: boolean;
|
|
28
|
-
}
|
|
29
|
-
/**
|
|
30
|
-
* Request payload to update an existing schedule by uid.
|
|
31
|
-
*/
|
|
32
|
-
export interface UpdateScheduleRequest {
|
|
33
|
-
cronExpression?: string;
|
|
34
|
-
preset?: string;
|
|
35
|
-
enabled?: boolean;
|
|
36
|
-
}
|
|
37
|
-
/**
|
|
38
|
-
* Response shape for listing schedules.
|
|
39
|
-
*/
|
|
40
|
-
export interface ListSchedulesResponse {
|
|
41
|
-
success: boolean;
|
|
42
|
-
message: string;
|
|
43
|
-
schedules: ScheduleDoc[];
|
|
44
|
-
}
|
|
45
|
-
/**
|
|
46
|
-
* Response shape for a single schedule mutation.
|
|
47
|
-
*/
|
|
48
|
-
export interface ScheduleResponse {
|
|
49
|
-
success: boolean;
|
|
50
|
-
message: string;
|
|
51
|
-
schedule: ScheduleDoc;
|
|
52
|
-
}
|
|
53
|
-
/**
|
|
54
|
-
* List the schedules owned by the authenticated user.
|
|
55
|
-
* @param token - Authentication token
|
|
56
|
-
* @param baseUrl - Base URL for the scheduler service (defaults to production)
|
|
57
|
-
* @param includeDisabled - Include disabled schedules in the result
|
|
58
|
-
* @returns Promise resolving to the list of schedules
|
|
59
|
-
*/
|
|
60
|
-
export declare const listSchedules: (token: string, baseUrl?: string, includeDisabled?: boolean) => Promise<ListSchedulesResponse>;
|
|
61
|
-
/**
|
|
62
|
-
* Create or update the schedule for a notebook.
|
|
63
|
-
* @param token - Authentication token
|
|
64
|
-
* @param data - Schedule configuration
|
|
65
|
-
* @param baseUrl - Base URL for the scheduler service (defaults to production)
|
|
66
|
-
* @returns Promise resolving to the upserted schedule
|
|
67
|
-
*/
|
|
68
|
-
export declare const upsertSchedule: (token: string, data: UpsertScheduleRequest, baseUrl?: string) => Promise<ScheduleResponse>;
|
|
69
|
-
/**
|
|
70
|
-
* Update an existing schedule by uid.
|
|
71
|
-
* @param token - Authentication token
|
|
72
|
-
* @param scheduleUid - The schedule uid
|
|
73
|
-
* @param data - Fields to update
|
|
74
|
-
* @param baseUrl - Base URL for the scheduler service (defaults to production)
|
|
75
|
-
* @returns Promise resolving to the updated schedule
|
|
76
|
-
*/
|
|
77
|
-
export declare const updateSchedule: (token: string, scheduleUid: string, data: UpdateScheduleRequest, baseUrl?: string) => Promise<ScheduleResponse>;
|
|
78
|
-
/**
|
|
79
|
-
* Disable a schedule by uid.
|
|
80
|
-
* @param token - Authentication token
|
|
81
|
-
* @param scheduleUid - The schedule uid
|
|
82
|
-
* @param baseUrl - Base URL for the scheduler service (defaults to production)
|
|
83
|
-
* @returns Promise resolving to the disabled schedule
|
|
84
|
-
*/
|
|
85
|
-
export declare const disableSchedule: (token: string, scheduleUid: string, baseUrl?: string) => Promise<ScheduleResponse>;
|
|
@@ -1,78 +0,0 @@
|
|
|
1
|
-
/*
|
|
2
|
-
* Copyright (c) 2023-2025 Datalayer, Inc.
|
|
3
|
-
* Distributed under the terms of the Modified BSD License.
|
|
4
|
-
*/
|
|
5
|
-
/**
|
|
6
|
-
* Scheduler schedules API functions for the Datalayer platform.
|
|
7
|
-
*
|
|
8
|
-
* Provides functions for listing, creating, and updating cron schedules that
|
|
9
|
-
* trigger automated notebook executions.
|
|
10
|
-
*
|
|
11
|
-
* @module api/scheduler/schedules
|
|
12
|
-
*/
|
|
13
|
-
import { requestDatalayerAPI } from '../DatalayerApi.js';
|
|
14
|
-
import { API_BASE_PATHS, DEFAULT_SERVICE_URLS } from '../constants.js';
|
|
15
|
-
/**
|
|
16
|
-
* List the schedules owned by the authenticated user.
|
|
17
|
-
* @param token - Authentication token
|
|
18
|
-
* @param baseUrl - Base URL for the scheduler service (defaults to production)
|
|
19
|
-
* @param includeDisabled - Include disabled schedules in the result
|
|
20
|
-
* @returns Promise resolving to the list of schedules
|
|
21
|
-
*/
|
|
22
|
-
export const listSchedules = async (token, baseUrl = DEFAULT_SERVICE_URLS.SCHEDULER, includeDisabled = false) => {
|
|
23
|
-
const query = includeDisabled ? '?includeDisabled=true' : '';
|
|
24
|
-
return requestDatalayerAPI({
|
|
25
|
-
url: `${baseUrl}${API_BASE_PATHS.SCHEDULER}/schedules${query}`,
|
|
26
|
-
method: 'GET',
|
|
27
|
-
token,
|
|
28
|
-
});
|
|
29
|
-
};
|
|
30
|
-
/**
|
|
31
|
-
* Create or update the schedule for a notebook.
|
|
32
|
-
* @param token - Authentication token
|
|
33
|
-
* @param data - Schedule configuration
|
|
34
|
-
* @param baseUrl - Base URL for the scheduler service (defaults to production)
|
|
35
|
-
* @returns Promise resolving to the upserted schedule
|
|
36
|
-
*/
|
|
37
|
-
export const upsertSchedule = async (token, data, baseUrl = DEFAULT_SERVICE_URLS.SCHEDULER) => {
|
|
38
|
-
return requestDatalayerAPI({
|
|
39
|
-
url: `${baseUrl}${API_BASE_PATHS.SCHEDULER}/schedules`,
|
|
40
|
-
method: 'POST',
|
|
41
|
-
token,
|
|
42
|
-
body: {
|
|
43
|
-
enabled: true,
|
|
44
|
-
preset: 'custom',
|
|
45
|
-
...data,
|
|
46
|
-
},
|
|
47
|
-
});
|
|
48
|
-
};
|
|
49
|
-
/**
|
|
50
|
-
* Update an existing schedule by uid.
|
|
51
|
-
* @param token - Authentication token
|
|
52
|
-
* @param scheduleUid - The schedule uid
|
|
53
|
-
* @param data - Fields to update
|
|
54
|
-
* @param baseUrl - Base URL for the scheduler service (defaults to production)
|
|
55
|
-
* @returns Promise resolving to the updated schedule
|
|
56
|
-
*/
|
|
57
|
-
export const updateSchedule = async (token, scheduleUid, data, baseUrl = DEFAULT_SERVICE_URLS.SCHEDULER) => {
|
|
58
|
-
return requestDatalayerAPI({
|
|
59
|
-
url: `${baseUrl}${API_BASE_PATHS.SCHEDULER}/schedules/${scheduleUid}`,
|
|
60
|
-
method: 'PUT',
|
|
61
|
-
token,
|
|
62
|
-
body: data,
|
|
63
|
-
});
|
|
64
|
-
};
|
|
65
|
-
/**
|
|
66
|
-
* Disable a schedule by uid.
|
|
67
|
-
* @param token - Authentication token
|
|
68
|
-
* @param scheduleUid - The schedule uid
|
|
69
|
-
* @param baseUrl - Base URL for the scheduler service (defaults to production)
|
|
70
|
-
* @returns Promise resolving to the disabled schedule
|
|
71
|
-
*/
|
|
72
|
-
export const disableSchedule = async (token, scheduleUid, baseUrl = DEFAULT_SERVICE_URLS.SCHEDULER) => {
|
|
73
|
-
return requestDatalayerAPI({
|
|
74
|
-
url: `${baseUrl}${API_BASE_PATHS.SCHEDULER}/schedules/${scheduleUid}/disable`,
|
|
75
|
-
method: 'POST',
|
|
76
|
-
token,
|
|
77
|
-
});
|
|
78
|
-
};
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
import { CollaborationSessionResponse } from '../../models/SpaceDTO';
|
|
2
|
-
/**
|
|
3
|
-
* Get collaboration session ID for a document.
|
|
4
|
-
*
|
|
5
|
-
* This function attempts to retrieve the collaboration session ID from the document API.
|
|
6
|
-
*
|
|
7
|
-
* @param token - Authentication token
|
|
8
|
-
* @param documentId - Document UID
|
|
9
|
-
* @param baseUrl - Base URL for the API (defaults to production)
|
|
10
|
-
* @returns Promise resolving to collaboration session response
|
|
11
|
-
*/
|
|
12
|
-
export declare const getCollaborationSessionId: (token: string, documentId: string, baseUrl?: string) => Promise<CollaborationSessionResponse>;
|
|
@@ -1,43 +0,0 @@
|
|
|
1
|
-
/*
|
|
2
|
-
* Copyright (c) 2023-2025 Datalayer, Inc.
|
|
3
|
-
* Distributed under the terms of the Modified BSD License.
|
|
4
|
-
*/
|
|
5
|
-
/**
|
|
6
|
-
* Documents API functions for the Datalayer platform.
|
|
7
|
-
*
|
|
8
|
-
* Provides functions for document operations including collaboration session management.
|
|
9
|
-
*
|
|
10
|
-
* @module api/spacer/documents
|
|
11
|
-
*/
|
|
12
|
-
import { requestDatalayerAPI } from '../DatalayerApi.js';
|
|
13
|
-
import { API_BASE_PATHS, DEFAULT_SERVICE_URLS } from '../constants.js';
|
|
14
|
-
/**
|
|
15
|
-
* Get collaboration session ID for a document.
|
|
16
|
-
*
|
|
17
|
-
* This function attempts to retrieve the collaboration session ID from the document API.
|
|
18
|
-
*
|
|
19
|
-
* @param token - Authentication token
|
|
20
|
-
* @param documentId - Document UID
|
|
21
|
-
* @param baseUrl - Base URL for the API (defaults to production)
|
|
22
|
-
* @returns Promise resolving to collaboration session response
|
|
23
|
-
*/
|
|
24
|
-
export const getCollaborationSessionId = async (token, documentId, baseUrl = DEFAULT_SERVICE_URLS.SPACER) => {
|
|
25
|
-
try {
|
|
26
|
-
const response = await requestDatalayerAPI({
|
|
27
|
-
url: `${baseUrl}${API_BASE_PATHS.SPACER}/documents/${documentId}`,
|
|
28
|
-
method: 'GET',
|
|
29
|
-
token,
|
|
30
|
-
});
|
|
31
|
-
return {
|
|
32
|
-
success: true,
|
|
33
|
-
sessionId: response.sessionId || documentId, // FIXME: is this ok?
|
|
34
|
-
};
|
|
35
|
-
}
|
|
36
|
-
catch (error) {
|
|
37
|
-
// FIXME: is this ok?
|
|
38
|
-
return {
|
|
39
|
-
success: true,
|
|
40
|
-
sessionId: documentId,
|
|
41
|
-
};
|
|
42
|
-
}
|
|
43
|
-
};
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
import type { HealthzPingResponse } from '../../models/Common';
|
|
2
|
-
/**
|
|
3
|
-
* Health check ping endpoint for Spacer service
|
|
4
|
-
* @param baseUrl - Base URL for the API (defaults to production Spacer 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 Spacer 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 Spacer service.
|
|
7
|
-
*
|
|
8
|
-
* Provides functions for checking the health status of the Spacer service.
|
|
9
|
-
*
|
|
10
|
-
* @module api/spacer/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 Spacer service
|
|
16
|
-
* @param baseUrl - Base URL for the API (defaults to production Spacer 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 Spacer 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.SPACER) => {
|
|
28
|
-
try {
|
|
29
|
-
const response = await requestDatalayerAPI({
|
|
30
|
-
url: `${baseUrl}${API_BASE_PATHS.SPACER}/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,15 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Spacer API exports.
|
|
3
|
-
*
|
|
4
|
-
* Provides organized access to spacer functionality including
|
|
5
|
-
* spaces, notebooks, cells, lexical documents, and agent runtimes.
|
|
6
|
-
*
|
|
7
|
-
* @module api/spacer
|
|
8
|
-
*/
|
|
9
|
-
export * as documents from './documents';
|
|
10
|
-
export * as healthz from './healthz';
|
|
11
|
-
export * as items from './items';
|
|
12
|
-
export * as lexicals from './lexicals';
|
|
13
|
-
export * as notebooks from './notebooks';
|
|
14
|
-
export * as spaces from './spaces';
|
|
15
|
-
export * as users from './users';
|
package/lib/api/spacer/index.js
DELETED
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
/*
|
|
2
|
-
* Copyright (c) 2023-2025 Datalayer, Inc.
|
|
3
|
-
* Distributed under the terms of the Modified BSD License.
|
|
4
|
-
*/
|
|
5
|
-
/**
|
|
6
|
-
* Spacer API exports.
|
|
7
|
-
*
|
|
8
|
-
* Provides organized access to spacer functionality including
|
|
9
|
-
* spaces, notebooks, cells, lexical documents, and agent runtimes.
|
|
10
|
-
*
|
|
11
|
-
* @module api/spacer
|
|
12
|
-
*/
|
|
13
|
-
export * as documents from './documents.js';
|
|
14
|
-
export * as healthz from './healthz.js';
|
|
15
|
-
export * as items from './items.js';
|
|
16
|
-
export * as lexicals from './lexicals.js';
|
|
17
|
-
export * as notebooks from './notebooks.js';
|
|
18
|
-
export * as spaces from './spaces.js';
|
|
19
|
-
export * as users from './users.js';
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
import { DeleteSpaceItemResponse, GetSpaceItemResponse, GetSpaceItemsResponse } from '../../models/SpaceDTO';
|
|
2
|
-
/**
|
|
3
|
-
* Get the items of a space.
|
|
4
|
-
* @param token - Authentication token
|
|
5
|
-
* @param spaceId - The space ID
|
|
6
|
-
* @param baseUrl - Base URL for the API (defaults to production)
|
|
7
|
-
* @returns Promise resolving to the items response
|
|
8
|
-
*/
|
|
9
|
-
export declare const getSpaceItems: (token: string, spaceId: string, baseUrl?: string) => Promise<GetSpaceItemsResponse>;
|
|
10
|
-
/**
|
|
11
|
-
* Get a single item from a space.
|
|
12
|
-
* @param token - Authentication token
|
|
13
|
-
* @param id - The item ID to retrieve
|
|
14
|
-
* @param baseUrl - Base URL for the API (defaults to production)
|
|
15
|
-
* @returns Promise resolving to the item response
|
|
16
|
-
*/
|
|
17
|
-
export declare const getItem: (token: string, id: string, baseUrl?: string) => Promise<GetSpaceItemResponse>;
|
|
18
|
-
/**
|
|
19
|
-
* Delete an item from a space.
|
|
20
|
-
* @param token - Authentication token
|
|
21
|
-
* @param id - The item ID to delete
|
|
22
|
-
* @param baseUrl - Base URL for the API (defaults to production)
|
|
23
|
-
* @returns Promise resolving when deletion is complete
|
|
24
|
-
*/
|
|
25
|
-
export declare const deleteItem: (token: string, id: string, baseUrl?: string) => Promise<DeleteSpaceItemResponse>;
|
package/lib/api/spacer/items.js
DELETED
|
@@ -1,55 +0,0 @@
|
|
|
1
|
-
/*
|
|
2
|
-
* Copyright (c) 2023-2025 Datalayer, Inc.
|
|
3
|
-
* Distributed under the terms of the Modified BSD License.
|
|
4
|
-
*/
|
|
5
|
-
/**
|
|
6
|
-
* Items API functions for the Datalayer platform.
|
|
7
|
-
*
|
|
8
|
-
* Provides functions for managing items in spaces.
|
|
9
|
-
*
|
|
10
|
-
* @module api/spacer/items
|
|
11
|
-
*/
|
|
12
|
-
import { requestDatalayerAPI } from '../DatalayerApi.js';
|
|
13
|
-
import { API_BASE_PATHS, DEFAULT_SERVICE_URLS } from '../constants.js';
|
|
14
|
-
/**
|
|
15
|
-
* Get the items of a space.
|
|
16
|
-
* @param token - Authentication token
|
|
17
|
-
* @param spaceId - The space ID
|
|
18
|
-
* @param baseUrl - Base URL for the API (defaults to production)
|
|
19
|
-
* @returns Promise resolving to the items response
|
|
20
|
-
*/
|
|
21
|
-
export const getSpaceItems = async (token, spaceId, baseUrl = DEFAULT_SERVICE_URLS.SPACER) => {
|
|
22
|
-
return requestDatalayerAPI({
|
|
23
|
-
url: `${baseUrl}${API_BASE_PATHS.SPACER}/spaces/${spaceId}/items`,
|
|
24
|
-
method: 'GET',
|
|
25
|
-
token,
|
|
26
|
-
});
|
|
27
|
-
};
|
|
28
|
-
/**
|
|
29
|
-
* Get a single item from a space.
|
|
30
|
-
* @param token - Authentication token
|
|
31
|
-
* @param id - The item ID to retrieve
|
|
32
|
-
* @param baseUrl - Base URL for the API (defaults to production)
|
|
33
|
-
* @returns Promise resolving to the item response
|
|
34
|
-
*/
|
|
35
|
-
export const getItem = async (token, id, baseUrl = DEFAULT_SERVICE_URLS.SPACER) => {
|
|
36
|
-
return requestDatalayerAPI({
|
|
37
|
-
url: `${baseUrl}${API_BASE_PATHS.SPACER}/spaces/items/${id}`,
|
|
38
|
-
method: 'GET',
|
|
39
|
-
token,
|
|
40
|
-
});
|
|
41
|
-
};
|
|
42
|
-
/**
|
|
43
|
-
* Delete an item from a space.
|
|
44
|
-
* @param token - Authentication token
|
|
45
|
-
* @param id - The item ID to delete
|
|
46
|
-
* @param baseUrl - Base URL for the API (defaults to production)
|
|
47
|
-
* @returns Promise resolving when deletion is complete
|
|
48
|
-
*/
|
|
49
|
-
export const deleteItem = async (token, id, baseUrl = DEFAULT_SERVICE_URLS.SPACER) => {
|
|
50
|
-
return requestDatalayerAPI({
|
|
51
|
-
url: `${baseUrl}${API_BASE_PATHS.SPACER}/spaces/items/${id}`,
|
|
52
|
-
method: 'DELETE',
|
|
53
|
-
token,
|
|
54
|
-
});
|
|
55
|
-
};
|
|
@@ -1,34 +0,0 @@
|
|
|
1
|
-
import { CreateLexicalRequest, CreateLexicalResponse, GetLexicalResponse, UpdateLexicalRequest, UpdateLexicalResponse } from '../../models/LexicalDTO';
|
|
2
|
-
/**
|
|
3
|
-
* Create a new lexical document.
|
|
4
|
-
* @param token - Authentication token
|
|
5
|
-
* @param data - Document creation configuration
|
|
6
|
-
* @param baseUrl - Base URL for the API (defaults to production)
|
|
7
|
-
* @returns Promise resolving to the created document response
|
|
8
|
-
*/
|
|
9
|
-
export declare const createLexical: (token: string, data: CreateLexicalRequest, baseUrl?: string) => Promise<CreateLexicalResponse>;
|
|
10
|
-
/**
|
|
11
|
-
* Get a lexical document by ID.
|
|
12
|
-
* @param token - Authentication token
|
|
13
|
-
* @param id - The document ID
|
|
14
|
-
* @param baseUrl - Base URL for the API (defaults to production)
|
|
15
|
-
* @returns Promise resolving to the document response
|
|
16
|
-
*/
|
|
17
|
-
export declare const getLexical: (token: string, id: string, baseUrl?: string) => Promise<GetLexicalResponse>;
|
|
18
|
-
/**
|
|
19
|
-
* Update a lexical document.
|
|
20
|
-
* @param token - Authentication token
|
|
21
|
-
* @param id - The document ID
|
|
22
|
-
* @param data - Update data containing name and/or description
|
|
23
|
-
* @param baseUrl - Base URL for the API (defaults to production)
|
|
24
|
-
* @returns Promise resolving to the updated document response
|
|
25
|
-
*/
|
|
26
|
-
export declare const updateLexical: (token: string, id: string, data: UpdateLexicalRequest, baseUrl?: string) => Promise<UpdateLexicalResponse>;
|
|
27
|
-
/**
|
|
28
|
-
* Clone a lexical document.
|
|
29
|
-
* @param token - Authentication token
|
|
30
|
-
* @param id - The document ID to clone
|
|
31
|
-
* @param baseUrl - Base URL for the API (defaults to production)
|
|
32
|
-
* @returns Promise resolving to the cloned document response
|
|
33
|
-
*/
|
|
34
|
-
export declare const cloneLexical: (token: string, id: string, baseUrl?: string) => Promise<CreateLexicalResponse>;
|
|
@@ -1,89 +0,0 @@
|
|
|
1
|
-
/*
|
|
2
|
-
* Copyright (c) 2023-2025 Datalayer, Inc.
|
|
3
|
-
* Distributed under the terms of the Modified BSD License.
|
|
4
|
-
*/
|
|
5
|
-
/**
|
|
6
|
-
* Lexical documents API functions for the Datalayer platform.
|
|
7
|
-
*
|
|
8
|
-
* Provides functions for creating, retrieving, and updating lexical (rich text) documents.
|
|
9
|
-
*
|
|
10
|
-
* @module api/spacer/lexicals
|
|
11
|
-
*/
|
|
12
|
-
import { requestDatalayerAPI } from '../DatalayerApi.js';
|
|
13
|
-
import { API_BASE_PATHS, DEFAULT_SERVICE_URLS } from '../constants.js';
|
|
14
|
-
/**
|
|
15
|
-
* Create a new lexical document.
|
|
16
|
-
* @param token - Authentication token
|
|
17
|
-
* @param data - Document creation configuration
|
|
18
|
-
* @param baseUrl - Base URL for the API (defaults to production)
|
|
19
|
-
* @returns Promise resolving to the created document response
|
|
20
|
-
*/
|
|
21
|
-
export const createLexical = async (token, data, baseUrl = DEFAULT_SERVICE_URLS.SPACER) => {
|
|
22
|
-
// Create FormData for multipart/form-data request (like the working example)
|
|
23
|
-
const formData = new FormData();
|
|
24
|
-
formData.append('spaceId', data.spaceId);
|
|
25
|
-
formData.append('name', data.name);
|
|
26
|
-
formData.append('documentType', data.documentType || 'lexical'); // Required field
|
|
27
|
-
formData.append('description', data.description || ''); // Required field - can be empty
|
|
28
|
-
// Add file if provided
|
|
29
|
-
if (data.file) {
|
|
30
|
-
if (data.file instanceof File) {
|
|
31
|
-
formData.append('file', data.file, data.file.name);
|
|
32
|
-
}
|
|
33
|
-
else {
|
|
34
|
-
// Handle Blob case
|
|
35
|
-
formData.append('file', data.file, `${data.name}.json`);
|
|
36
|
-
}
|
|
37
|
-
}
|
|
38
|
-
const url = `${baseUrl}${API_BASE_PATHS.SPACER}/lexicals`;
|
|
39
|
-
return requestDatalayerAPI({
|
|
40
|
-
url,
|
|
41
|
-
method: 'POST',
|
|
42
|
-
token,
|
|
43
|
-
body: formData,
|
|
44
|
-
});
|
|
45
|
-
};
|
|
46
|
-
/**
|
|
47
|
-
* Get a lexical document by ID.
|
|
48
|
-
* @param token - Authentication token
|
|
49
|
-
* @param id - The document ID
|
|
50
|
-
* @param baseUrl - Base URL for the API (defaults to production)
|
|
51
|
-
* @returns Promise resolving to the document response
|
|
52
|
-
*/
|
|
53
|
-
export const getLexical = async (token, id, baseUrl = DEFAULT_SERVICE_URLS.SPACER) => {
|
|
54
|
-
return requestDatalayerAPI({
|
|
55
|
-
url: `${baseUrl}${API_BASE_PATHS.SPACER}/lexicals/${id}`,
|
|
56
|
-
method: 'GET',
|
|
57
|
-
token,
|
|
58
|
-
});
|
|
59
|
-
};
|
|
60
|
-
/**
|
|
61
|
-
* Update a lexical document.
|
|
62
|
-
* @param token - Authentication token
|
|
63
|
-
* @param id - The document ID
|
|
64
|
-
* @param data - Update data containing name and/or description
|
|
65
|
-
* @param baseUrl - Base URL for the API (defaults to production)
|
|
66
|
-
* @returns Promise resolving to the updated document response
|
|
67
|
-
*/
|
|
68
|
-
export const updateLexical = async (token, id, data, baseUrl = DEFAULT_SERVICE_URLS.SPACER) => {
|
|
69
|
-
return requestDatalayerAPI({
|
|
70
|
-
url: `${baseUrl}${API_BASE_PATHS.SPACER}/lexicals/${id}`,
|
|
71
|
-
method: 'PUT',
|
|
72
|
-
token,
|
|
73
|
-
body: data,
|
|
74
|
-
});
|
|
75
|
-
};
|
|
76
|
-
/**
|
|
77
|
-
* Clone a lexical document.
|
|
78
|
-
* @param token - Authentication token
|
|
79
|
-
* @param id - The document ID to clone
|
|
80
|
-
* @param baseUrl - Base URL for the API (defaults to production)
|
|
81
|
-
* @returns Promise resolving to the cloned document response
|
|
82
|
-
*/
|
|
83
|
-
export const cloneLexical = async (token, id, baseUrl = DEFAULT_SERVICE_URLS.SPACER) => {
|
|
84
|
-
return requestDatalayerAPI({
|
|
85
|
-
url: `${baseUrl}${API_BASE_PATHS.SPACER}/lexicals/${id}/clone`,
|
|
86
|
-
method: 'POST',
|
|
87
|
-
token,
|
|
88
|
-
});
|
|
89
|
-
};
|
|
@@ -1,34 +0,0 @@
|
|
|
1
|
-
import { CreateNotebookRequest, CreateNotebookResponse, GetNotebookResponse, UpdateNotebookRequest, UpdateNotebookResponse } from '../../models/SpaceDTO';
|
|
2
|
-
/**
|
|
3
|
-
* Create a new Jupyter notebook.
|
|
4
|
-
* @param token - Authentication token
|
|
5
|
-
* @param data - Notebook creation configuration
|
|
6
|
-
* @param baseUrl - Base URL for the API (defaults to production)
|
|
7
|
-
* @returns Promise resolving to the created notebook response
|
|
8
|
-
*/
|
|
9
|
-
export declare const createNotebook: (token: string, data: CreateNotebookRequest, baseUrl?: string) => Promise<CreateNotebookResponse>;
|
|
10
|
-
/**
|
|
11
|
-
* Get a notebook by ID.
|
|
12
|
-
* @param token - Authentication token
|
|
13
|
-
* @param id - The notebook ID
|
|
14
|
-
* @param baseUrl - Base URL for the API (defaults to production)
|
|
15
|
-
* @returns Promise resolving to the notebook response
|
|
16
|
-
*/
|
|
17
|
-
export declare const getNotebook: (token: string, id: string, baseUrl?: string) => Promise<GetNotebookResponse>;
|
|
18
|
-
/**
|
|
19
|
-
* Update a notebook.
|
|
20
|
-
* @param token - Authentication token
|
|
21
|
-
* @param id - The notebook ID
|
|
22
|
-
* @param data - Update data containing name and/or description
|
|
23
|
-
* @param baseUrl - Base URL for the API (defaults to production)
|
|
24
|
-
* @returns Promise resolving to the updated notebook response
|
|
25
|
-
*/
|
|
26
|
-
export declare const updateNotebook: (token: string, id: string, data: UpdateNotebookRequest, baseUrl?: string) => Promise<UpdateNotebookResponse>;
|
|
27
|
-
/**
|
|
28
|
-
* Clone a notebook.
|
|
29
|
-
* @param token - Authentication token
|
|
30
|
-
* @param id - The notebook ID to clone
|
|
31
|
-
* @param baseUrl - Base URL for the API (defaults to production)
|
|
32
|
-
* @returns Promise resolving to the cloned notebook response
|
|
33
|
-
*/
|
|
34
|
-
export declare const cloneNotebook: (token: string, id: string, baseUrl?: string) => Promise<CreateNotebookResponse>;
|