@datalayer/core 0.0.20 → 0.0.21

package/lib/hooks/useBackdrop.d.ts

@@ -1,6 +1,6 @@
 import { ReactNode } from 'react';
 import PropTypes from 'prop-types';
-type BackdropContextType = {
+export type BackdropContextType = {
     closeBackdrop: () => void;
     displayBackdrop: (nextBackdrop: any) => void;
 };
@@ -10,7 +10,7 @@ export declare function useBackdrop(): BackdropContextType;
  * The type for the Backdrop context provider.
  */
 export declare const BackdropContextProvider: import("react").Provider<BackdropContextType>;
-type IBackdropProviderProps = {
+export type IBackdropProviderProps = {
     children?: ReactNode;
     zIndex?: number;
     disableDarken?: boolean;
@@ -25,4 +25,3 @@ export declare namespace BackdropProvider {
         backdropSurface: PropTypes.Requireable<(...args: any[]) => any>;
     };
 }
-export {};

package/lib/hooks/useBackdropJupyterLab.d.ts

@@ -4,9 +4,9 @@ type JupyterLabBackdropType = {
 };
 declare function JupyterLabBackdrop({ open, element }: JupyterLabBackdropType): import("react/jsx-runtime").JSX.Element;
 export default JupyterLabBackdrop;
-interface JupyterLabBackdropProps {
+export interface JupyterLabBackdropProps {
 }
-type UseJupyterLabBackdropProps = {
+export type UseJupyterLabBackdropProps = {
     openBackdrop: (element: JSX.Element) => void;
     closeBackdrop: () => void;
 };

package/lib/hooks/useCache.d.ts

@@ -36,10 +36,10 @@
  */
 import { UseQueryOptions, UseMutationOptions } from '@tanstack/react-query';
 import { IAnyOrganization, IAnySpace, IAssignment, ICell, IContact, ICourse, IDataset, IDatasource, IDocument, IEnvironment, IExercise, IIAMToken, ILesson, INotebook, IOrganization, IPage, ISchool, ISecret, ITeam, IUser, IUserOnboarding, IUserSettings } from '../models';
-type CacheProps = {
+export type CacheProps = {
     loginRoute?: string;
 };
-type ISearchOpts = {
+export type ISearchOpts = {
     q: string;
     types: string[];
     max: number;
@@ -665,7 +665,7 @@ export declare const useCache: ({ loginRoute }?: CacheProps) => {
     useTokens: () => import("@tanstack/react-query").UseQueryResult<any, Error>;
     useCreateToken: () => import("@tanstack/react-query").UseMutationResult<any, Error, Omit<IIAMToken, "id" | "value">, unknown>;
     useUpdateToken: () => import("@tanstack/react-query").UseMutationResult<any, Error, IIAMToken, unknown>;
-    useInvite: (token: string) => import("@tanstack/react-query").UseQueryResult<import("../models").IInvite | undefined, Error>;
+    useInvite: (token: string) => import("@tanstack/react-query").UseQueryResult<import("..").IInvite | undefined, Error>;
     useInvitesByUser: (accountId: string) => import("@tanstack/react-query").UseQueryResult<any, Error>;
     usePutInvite: () => import("@tanstack/react-query").UseMutationResult<any, Error, string, unknown>;
     useRequestInvite: (options?: UseMutationOptions<unknown, Error, {

package/lib/hooks/useScreenshot.d.ts

@@ -1,5 +1,5 @@
 import { ReactNode } from 'react';
-type ScreenshotContextType = {
+export type ScreenshotContextType = {
     closeScreenshot: () => void;
     displayScreenshot: (nextScreenshot: any) => void;
 };
@@ -9,11 +9,10 @@ export declare function useScreenshot(): ScreenshotContextType;
  * The type for the Screenshot context provider.
  */
 export declare const ScreenshotContextProvider: import("react").Provider<ScreenshotContextType>;
-type IScreenshotProviderProps = {
+export type IScreenshotProviderProps = {
     children?: ReactNode;
     zIndex?: number;
     disableDarken?: boolean;
     screenshotSurface?: (qfds: any) => JSX.Element;
 };
 export declare function ScreenshotProvider({ children, zIndex, disableDarken, screenshotSurface, }: IScreenshotProviderProps): import("react/jsx-runtime").JSX.Element;
-export {};

package/lib/hooks/useWindowSize.d.ts

@@ -6,7 +6,7 @@ export declare enum BreakpointSize {
     XLARGE = "xlarge",
     XXLARGE = "xxlarge"
 }
-type WindowSize = {
+export type WindowSize = {
     width?: number;
     height?: number;
     isXSmall?: boolean;
@@ -18,4 +18,3 @@ type WindowSize = {
     currentBreakpointSize?: BreakpointSize;
 };
 export declare function useWindowSize(): WindowSize;
-export {};

package/lib/index.d.ts

@@ -12,5 +12,5 @@ export { API_BASE_PATHS } from './api/constants';
 export * as runtimesApi from './api/runtimes';
 export * as iamApi from './api/iam';
 export * as spacerApi from './api/spacer';
-export { DatalayerClient, type DatalayerClientConfig, type SDKHandlers, User, Runtime, Environment, Snapshot, Space, Notebook, LexicalDTO, Credits, Item, type RuntimeJSON, type EnvironmentJSON, type UserJSON, } from './client';
+export { DatalayerClient, type DatalayerClientConfig, type SDKHandlers, User, Runtime, Environment, Snapshot, Space, Notebook, LexicalDTO, Secret, Credits, Item, type RuntimeJSON, type EnvironmentJSON, type UserJSON, type RuntimeData, type EnvironmentData, type UserData, type SpaceData, type SpaceItem, type NotebookData, type LexicalData, type RuntimeSnapshotData, type CreditsInfo, type CreditReservation, type CreateRuntimeRequest, type CreateRuntimeResponse, type ListRuntimesResponse, type ListEnvironmentsResponse, type CreateRuntimeSnapshotRequest, type CreateRuntimeSnapshotResponse, type GetRuntimeSnapshotResponse, type ListRuntimeSnapshotsResponse, type CreateSpaceRequest, type CreateSpaceResponse, type SpacesForUserResponse, type CollaborationSessionResponse, type DeleteSpaceItemResponse, type GetSpaceItemResponse, type GetSpaceItemsResponse, type CreateNotebookRequest, type CreateNotebookResponse, type GetNotebookResponse, type UpdateNotebookRequest, type UpdateNotebookResponse, type CreateLexicalRequest, type CreateLexicalResponse, type GetLexicalResponse, type UpdateLexicalRequest, type UpdateLexicalResponse, type CreditsResponse, type CreateDatasourceResponse, type GetDatasourceResponse, type ListDatasourcesResponse, type UpdateDatasourceResponse, type CreateSecretRequest, type CreateSecretResponse, type GetSecretResponse, type ListSecretsResponse, type UpdateSecretRequest, type UpdateSecretResponse, type SpaceJSON, type NotebookJSON, type LexicalJSON, type RuntimeSnapshotJSON, HealthCheck, type HealthCheckJSON, type LoginRequest, type LoginResponse, type UserMeResponse, type MembershipsResponse, type WhoAmIResponse, type HealthzPingResponse, AuthenticationManager, type IUser, type IBaseUser, type ICell, type IDatasource, type IDatasourceVariant, type ICredits, type ICreditsReservation, type ISpaceItem, type ISurvey, type ISpace, type IBaseSpace, type IAnySpace, type ISpaceVariant, type IBaseTeam, type IAnyTeam, type IOrganization, type IAnyOrganization, type IBaseOrganization, type IRuntimeModel, type IRuntimePod, type IRuntimeType, type IRuntimeLocation, type IRuntimeCapabilities, type IRuntimeSnapshot, type IDatalayerEnvironment, type IResources, type ISnippet, type IRole, type IAssignment, type IContact, type ICourse, type IOrganizationMember, type IPage, type PageTagName, type PageTheme, type PageVariant, type ISecret, type ISecretVariant, type SecretData, type SecretJSON, type DatasourceData, type DatasourceJSON, type DatasourceType, type CreateDatasourceRequest, type UpdateDatasourceRequest, Datasource, type IIAMToken, type IIAMTokenVariant, type IDocument, type IBaseDocument, type IEnvironment, type IExercise, type ICode, type IHelp, type IInvite, type ILesson, type INotebook, type IBaseNotebook, type ISchool, type ITeam, type TeamMember, type IUserOnboarding, type IClient, type IOnboardingPosition, type IOnboardingTours, type ITour, type ITourStatus, type IUserSettings, type IDataset, type IUsage, type IItem, type IItemType, type Member, type Profile, type SpaceMember, type IContactEvent, type IContactIAMProvider, type IStudentItem, type Instructor, type IStudent, type IDean, type IUserEvent, type IIAMProviderLinked, type IContent, type AuthResult, type TokenValidationResult, type AuthOptions, type TokenStorage, type IRuntimeOptions, type IMultiServiceManager, type IRemoteServicesManager, type IEnvironmentsManager, type IRemoteRuntimesManager, type NavigationLinkProps, type IDatalayerCoreConfig, type IRuntimesConfiguration, type IIAMProviderName, } from './client';
 export { getEnvironments, createRuntime, getRuntimes, deleteRuntime, snapshotRuntime, getRuntimeSnapshots, loadRuntimeSnapshot, } from './stateful/runtimes/actions';

package/lib/index.js

@@ -23,6 +23,8 @@ export {
 // Export client and config types
 DatalayerClient, 
 // Export domain models
-User, Runtime, Environment, Snapshot, Space, Notebook, LexicalDTO, Credits, Item, } from './client';
+User, Runtime, Environment, Snapshot, Space, Notebook, LexicalDTO, Secret, Credits, Item, HealthCheck, 
+// Export auth
+AuthenticationManager, Datasource, } from './client';
 // Export commonly used functions directly for convenience
 export { getEnvironments, createRuntime, getRuntimes, deleteRuntime, snapshotRuntime, getRuntimeSnapshots, loadRuntimeSnapshot, } from './stateful/runtimes/actions';

package/lib/models/Datasource.d.ts

@@ -9,3 +9,173 @@ export type IDatasource = {
     outputBucket: string;
 };
 export default IDatasource;
+import type { DatalayerClient } from '../client';
+/**
+ * Datasource type matching UI and API.
+ */
+export type DatasourceType = 'Amazon Athena' | 'Google BigQuery' | 'Microsoft Sentinel' | 'Splunk';
+/**
+ * Raw datasource data from API (snake_case with suffixes).
+ */
+export interface DatasourceData {
+    /** Unique identifier (ULID) */
+    uid: string;
+    /** Datasource type */
+    type_s: DatasourceType;
+    /** Datasource name */
+    name_s: string;
+    /** Datasource description */
+    description_t: string;
+    /** Datasource variant (athena, bigquery, mssentinel, splunk) */
+    variant_s?: string;
+    /** Optional: Database name (required for Amazon Athena) */
+    database_s?: string;
+    /** Optional: S3 output bucket (required for Amazon Athena) */
+    output_bucket_s?: string;
+    /** Creation timestamp */
+    created_at?: string;
+    /** Last update timestamp */
+    updated_at?: string;
+}
+/**
+ * Public JSON interface for Datasource (camelCase).
+ */
+export interface DatasourceJSON {
+    /** Unique identifier */
+    uid: string;
+    /** Datasource type */
+    type: DatasourceType;
+    /** Datasource name */
+    name: string;
+    /** Datasource description */
+    description: string;
+    /** Optional: Database name */
+    database?: string;
+    /** Optional: S3 output bucket */
+    outputBucket?: string;
+    /** Creation timestamp */
+    createdAt?: Date;
+    /** Last update timestamp */
+    updatedAt?: Date;
+}
+/**
+ * Request data for creating a new datasource.
+ */
+export interface CreateDatasourceRequest {
+    /** Datasource type */
+    type: DatasourceType;
+    /** Datasource name (unique identifier) */
+    name: string;
+    /** Human-readable description */
+    description?: string;
+    /** Optional: Database name (required for Amazon Athena) */
+    database?: string;
+    /** Optional: S3 output bucket (required for Amazon Athena) */
+    output_bucket?: string;
+}
+/**
+ * Request data for updating a datasource.
+ */
+export interface UpdateDatasourceRequest {
+    /** Optional: update type */
+    type?: DatasourceType;
+    /** Optional: update name */
+    name?: string;
+    /** Optional: update description */
+    description?: string;
+    /** Optional: update database */
+    database?: string;
+    /** Optional: update output bucket */
+    output_bucket?: string;
+}
+/**
+ * Response from creating a datasource.
+ */
+export interface CreateDatasourceResponse {
+    success: boolean;
+    message: string;
+    datasource: DatasourceData;
+}
+/**
+ * Response from getting a datasource.
+ */
+export interface GetDatasourceResponse {
+    success: boolean;
+    message: string;
+    datasource: DatasourceData;
+}
+/**
+ * Response from listing datasources.
+ */
+export interface ListDatasourcesResponse {
+    success: boolean;
+    message: string;
+    datasources: DatasourceData[];
+}
+/**
+ * Response from updating a datasource.
+ */
+export interface UpdateDatasourceResponse {
+    success: boolean;
+    message: string;
+    datasource: DatasourceData;
+}
+/**
+ * Datasource domain model for the Datalayer SDK.
+ * Provides state management and operations for datasources.
+ *
+ * @example
+ * ```typescript
+ * const datasource = await sdk.createDatasource({
+ *   type: 'Amazon Athena',
+ *   name: 'my-athena-datasource',
+ *   description: 'Production Athena datasource',
+ *   database: 'my_database',
+ *   output_bucket: 's3://my-bucket/output/'
+ * });
+ *
+ * await datasource.update({ description: 'Updated description' });
+ * await datasource.delete();
+ * ```
+ */
+export declare class DatasourceDTO {
+    /** @internal */
+    _data: DatasourceData;
+    private _sdk;
+    private _deleted;
+    /**
+     * Create a Datasource instance.
+     * @param data - Datasource data from API
+     * @param sdk - SDK instance
+     */
+    constructor(data: DatasourceData, sdk: DatalayerClient);
+    private _checkDeleted;
+    get uid(): string;
+    get type(): DatasourceType;
+    get variant(): string | undefined;
+    get name(): string;
+    get description(): string;
+    get database(): string | undefined;
+    get outputBucket(): string | undefined;
+    get createdAt(): Date | undefined;
+    get updatedAt(): Date | undefined;
+    /**
+     * Update this datasource.
+     * @param updates - Fields to update
+     * @returns Updated Datasource instance
+     */
+    update(updates: UpdateDatasourceRequest): Promise<DatasourceDTO>;
+    /**
+     * Delete this datasource permanently.
+     */
+    delete(): Promise<void>;
+    /**
+     * Get datasource data in camelCase format.
+     */
+    toJSON(): DatasourceJSON;
+    /**
+     * Get raw datasource data exactly as received from API.
+     */
+    rawData(): DatasourceData;
+    toString(): string;
+}

package/lib/models/Datasource.js

@@ -2,6 +2,9 @@
  * Copyright (c) 2023-2025 Datalayer, Inc.
  * Distributed under the terms of the Modified BSD License.
  */
+// ============================================================================
+// OLD API - Kept for backward compatibility
+// ============================================================================
 export const asDatasource = (s) => {
     return {
         id: s.uid,
@@ -12,3 +15,140 @@ export const asDatasource = (s) => {
         outputBucket: s.output_bucket_s,
     };
 };
+// ============================================================================
+// New API Types and DTO
+// ============================================================================
+import { validateJSON } from '../api/utils/validation';
+/**
+ * Datasource domain model for the Datalayer SDK.
+ * Provides state management and operations for datasources.
+ *
+ * @example
+ * ```typescript
+ * const datasource = await sdk.createDatasource({
+ *   type: 'Amazon Athena',
+ *   name: 'my-athena-datasource',
+ *   description: 'Production Athena datasource',
+ *   database: 'my_database',
+ *   output_bucket: 's3://my-bucket/output/'
+ * });
+ *
+ * await datasource.update({ description: 'Updated description' });
+ * await datasource.delete();
+ * ```
+ */
+export class DatasourceDTO {
+    /** @internal */
+    _data;
+    _sdk;
+    _deleted = false;
+    /**
+     * Create a Datasource instance.
+     * @param data - Datasource data from API
+     * @param sdk - SDK instance
+     */
+    constructor(data, sdk) {
+        this._data = data;
+        this._sdk = sdk;
+    }
+    // ========================================================================
+    // Helper Methods
+    // ========================================================================
+    _checkDeleted() {
+        if (this._deleted) {
+            throw new Error(`Datasource ${this._data.name_s} has been deleted and no longer exists`);
+        }
+    }
+    // ========================================================================
+    // Properties
+    // ========================================================================
+    get uid() {
+        this._checkDeleted();
+        return this._data.uid;
+    }
+    get type() {
+        this._checkDeleted();
+        return this._data.type_s;
+    }
+    get variant() {
+        this._checkDeleted();
+        return this._data.variant_s;
+    }
+    get name() {
+        this._checkDeleted();
+        return this._data.name_s;
+    }
+    get description() {
+        this._checkDeleted();
+        return this._data.description_t;
+    }
+    get database() {
+        this._checkDeleted();
+        return this._data.database_s;
+    }
+    get outputBucket() {
+        this._checkDeleted();
+        return this._data.output_bucket_s;
+    }
+    get createdAt() {
+        this._checkDeleted();
+        return this._data.created_at ? new Date(this._data.created_at) : undefined;
+    }
+    get updatedAt() {
+        this._checkDeleted();
+        return this._data.updated_at ? new Date(this._data.updated_at) : undefined;
+    }
+    // ========================================================================
+    // Action Methods
+    // ========================================================================
+    /**
+     * Update this datasource.
+     * @param updates - Fields to update
+     * @returns Updated Datasource instance
+     */
+    async update(updates) {
+        this._checkDeleted();
+        const updated = await this._sdk.updateDatasource(this.uid, updates);
+        return updated;
+    }
+    /**
+     * Delete this datasource permanently.
+     */
+    async delete() {
+        this._checkDeleted();
+        await this._sdk.deleteDatasource(this.uid);
+        this._deleted = true;
+    }
+    // ========================================================================
+    // Utility Methods
+    // ========================================================================
+    /**
+     * Get datasource data in camelCase format.
+     */
+    toJSON() {
+        this._checkDeleted();
+        const obj = {
+            uid: this.uid,
+            type: this.type,
+            name: this.name,
+            description: this.description,
+            database: this.database,
+            outputBucket: this.outputBucket,
+            createdAt: this.createdAt,
+            updatedAt: this.updatedAt,
+        };
+        validateJSON(obj, 'Datasource');
+        return obj;
+    }
+    /**
+     * Get raw datasource data exactly as received from API.
+     */
+    rawData() {
+        this._checkDeleted();
+        return this._data;
+    }
+    toString() {
+        this._checkDeleted();
+        return `Datasource(${this.name}, ${this.type})`;
+    }
+}

package/lib/models/Runtime.d.ts

@@ -114,7 +114,7 @@ export interface IRuntimeDesc {
 /**
  * Runtime type.
  *
- * TODO refactor with type { RuntimeLocation }
+ * TODO refactor with type `IRuntimeLocation`
  */
 export type IRuntimeType = 'notebook' | 'cell';
 /**

package/lib/models/RuntimeSnapshotDTO.d.ts

@@ -148,7 +148,7 @@ export declare class RuntimeSnapshotDTO {
     /**
      * Create a runtime from this snapshot (restore functionality).
      *
-     * @param config - Optional runtime configuration to override defaults
+     * @param minutesLimit - Time limit in minutes for the restored runtime
      * @returns Created Runtime instance
      */
     restore(minutesLimit: number): Promise<RuntimeDTO>;

package/lib/models/RuntimeSnapshotDTO.js

@@ -85,7 +85,7 @@ export class RuntimeSnapshotDTO {
     /**
      * Create a runtime from this snapshot (restore functionality).
      *
-     * @param config - Optional runtime configuration to override defaults
+     * @param minutesLimit - Time limit in minutes for the restored runtime
      * @returns Created Runtime instance
      */
     async restore(minutesLimit) {

package/lib/models/Secret.d.ts

@@ -8,3 +8,162 @@ export type ISecret = {
     value: string;
 };
 export default ISecret;
+import type { DatalayerClient } from '../client';
+/**
+ * Raw secret data from API (snake_case with suffixes).
+ */
+export interface SecretData {
+    /** Unique identifier (ULID) */
+    uid: string;
+    /** Secret variant/type */
+    variant_s: ISecretVariant;
+    /** Secret name */
+    name_s: string;
+    /** Secret description */
+    description_t: string;
+    /** Base64-encoded secret value */
+    value_s: string;
+}
+/**
+ * Public JSON interface for Secret (camelCase).
+ */
+export interface SecretJSON {
+    /** Unique identifier */
+    uid: string;
+    /** Secret type */
+    variant: ISecretVariant;
+    /** Secret name */
+    name: string;
+    /** Secret description */
+    description: string;
+    /** Decoded secret value (plain text) */
+    value: string;
+}
+/**
+ * Request data for creating a new secret.
+ * @public
+ */
+export interface CreateSecretRequest {
+    /** Secret type/variant (defaults to 'generic' if not provided) */
+    variant?: ISecretVariant;
+    /** Secret name (unique identifier) */
+    name: string;
+    /** Human-readable description */
+    description?: string;
+    /** Plain text value (will be Base64 encoded by SDK) */
+    value: string;
+}
+/**
+ * Request data for updating a secret.
+ * @public
+ */
+export interface UpdateSecretRequest {
+    /** Optional: update variant */
+    variant?: ISecretVariant;
+    /** Optional: update name */
+    name?: string;
+    /** Optional: update description */
+    description?: string;
+    /** Optional: update value (plain text, will be Base64 encoded) */
+    value?: string;
+}
+/**
+ * Response from creating a secret.
+ * @public
+ */
+export interface CreateSecretResponse {
+    success: boolean;
+    message: string;
+    secret: SecretData;
+}
+/**
+ * Response from getting a secret.
+ * @public
+ */
+export interface GetSecretResponse {
+    success: boolean;
+    message: string;
+    secret: SecretData;
+}
+/**
+ * Response from listing secrets.
+ * @public
+ */
+export interface ListSecretsResponse {
+    success: boolean;
+    message: string;
+    secrets: SecretData[];
+}
+/**
+ * Response from updating a secret.
+ * @public
+ */
+export interface UpdateSecretResponse {
+    success: boolean;
+    message: string;
+    secret: SecretData;
+}
+/**
+ * Response from deleting a secret.
+ */
+export interface DeleteSecretResponse {
+    success: boolean;
+    message: string;
+}
+/**
+ * Secret domain model for the Datalayer SDK.
+ * Provides state management and operations for user secrets.
+ *
+ * @example
+ * ```typescript
+ * const secret = await sdk.createSecret({
+ *   variant: 'password',
+ *   name: 'db_password',
+ *   description: 'Production DB password',
+ *   value: 'my-secure-password'
+ * });
+ *
+ * await secret.update({ description: 'Updated description' });
+ * await secret.delete();
+ * ```
+ * @public
+ */
+export declare class SecretDTO {
+    /** @internal */
+    _data: SecretData;
+    private _sdk;
+    private _deleted;
+    /**
+     * Create a Secret instance.
+     * @param data - Secret data from API
+     * @param sdk - SDK instance
+     */
+    constructor(data: SecretData, sdk: DatalayerClient);
+    private _checkDeleted;
+    private _decodeValue;
+    get uid(): string;
+    get variant(): ISecretVariant;
+    get name(): string;
+    get description(): string;
+    /** Returns decoded (plain text) secret value */
+    get value(): string;
+    /**
+     * Update this secret.
+     * @param updates - Fields to update
+     * @returns Updated Secret instance
+     */
+    update(updates: UpdateSecretRequest): Promise<SecretDTO>;
+    /**
+     * Delete this secret permanently.
+     */
+    delete(): Promise<void>;
+    /**
+     * Get secret data in camelCase format.
+     */
+    toJSON(): SecretJSON;
+    /**
+     * Get raw secret data exactly as received from API.
+     */
+    rawData(): SecretData;
+    toString(): string;
+}