@noatgnu/cupcake-core 1.2.9 → 1.2.11

package/index.d.ts

@@ -352,6 +352,25 @@ interface LabGroupPermissionQueryResponse {
     results: LabGroupPermission[];
 }
 
+declare enum AnnotationType {
+    Text = "text",
+    File = "file",
+    Image = "image",
+    Video = "video",
+    Audio = "audio",
+    Sketch = "sketch",
+    Other = "other",
+    Checklist = "checklist",
+    Counter = "counter",
+    Table = "table",
+    Alignment = "alignment",
+    Calculator = "calculator",
+    MolarityCalculator = "mcalculator",
+    Randomization = "randomization",
+    Instrument = "instrument",
+    Metadata = "metadata",
+    Booking = "booking"
+}
 interface AnnotationFolder extends BaseResource {
     folderName: string;
     parentFolder?: number;
@@ -364,7 +383,7 @@ interface AnnotationFolder extends BaseResource {
 interface Annotation extends BaseResource {
     annotation: string;
     annotationType: string;
-    file?: number;
+    file?: string;
     fileUrl?: string;
     fileSize?: number;
     folder?: number;
@@ -375,6 +394,9 @@ interface Annotation extends BaseResource {
     translation?: string;
     scratched: boolean;
     ownerName?: string;
+    canEdit?: boolean;
+    canView?: boolean;
+    canDelete?: boolean;
 }
 interface AnnotationFolderCreateRequest {
     folderName: string;
@@ -394,9 +416,13 @@ interface AnnotationCreateRequest {
     annotationType?: string;
     file?: File;
     folder?: number;
+    transcribed?: boolean;
+    transcription?: string;
     language?: string;
+    translation?: string;
     labGroup?: number;
     visibility?: string;
+    autoTranscribe?: boolean;
 }
 interface AnnotationUpdateRequest {
     annotation?: string;
@@ -462,6 +488,62 @@ interface RemoteHostUpdateRequest {
     hostToken?: string;
 }
 
+interface BaseNotification {
+    type: string;
+    message: string;
+    timestamp: string;
+    user_id?: number;
+}
+interface TranscriptionStartedNotification extends BaseNotification {
+    type: 'transcription.started';
+    annotation_id: number;
+}
+interface TranscriptionCompletedNotification extends BaseNotification {
+    type: 'transcription.completed';
+    annotation_id: number;
+    language?: string;
+    has_translation?: boolean;
+}
+interface TranscriptionFailedNotification extends BaseNotification {
+    type: 'transcription.failed';
+    annotation_id: number;
+    error: string;
+}
+interface SystemNotification extends BaseNotification {
+    type: 'system.notification';
+    level: 'info' | 'warning' | 'error' | 'success';
+    title: string;
+}
+interface AsyncTaskUpdateNotification extends BaseNotification {
+    type: 'async_task.update';
+    task_id: string;
+    status: string;
+    progress_percentage?: number;
+    progress_description?: string;
+    error_message?: string;
+    result?: any;
+    download_url?: string;
+}
+interface MetadataTableUpdateNotification extends BaseNotification {
+    type: 'metadata_table.update';
+    table_id: number;
+    action: string;
+    user?: number;
+}
+interface LabGroupUpdateNotification extends BaseNotification {
+    type: 'lab_group.update';
+    lab_group_id: number;
+    action: string;
+}
+interface ConnectionEstablishedNotification {
+    type: 'connection.established';
+    message: string;
+    user_id: number;
+    username: string;
+    lab_groups: number[];
+}
+type WebSocketNotification = TranscriptionStartedNotification | TranscriptionCompletedNotification | TranscriptionFailedNotification | SystemNotification | AsyncTaskUpdateNotification | MetadataTableUpdateNotification | LabGroupUpdateNotification | ConnectionEstablishedNotification;
+
 interface CupcakeCoreConfig {
     apiUrl: string;
 }
@@ -611,6 +693,17 @@ declare class ApiService {
     createAnnotationFolder(folderData: AnnotationFolderCreateRequest): Observable<AnnotationFolder>;
     updateAnnotationFolder(id: number, folderData: AnnotationFolderUpdateRequest): Observable<AnnotationFolder>;
     deleteAnnotationFolder(id: number): Observable<void>;
+    /**
+     * WARNING: This method accesses the base annotation endpoint and should only be used
+     * for standalone annotations that are NOT attached to parent resources.
+     *
+     * For annotations attached to parent resources, use the specialized services instead:
+     * - Instrument annotations: Use InstrumentService from @noatgnu/cupcake-macaron
+     * - StoredReagent annotations: Use ReagentService from @noatgnu/cupcake-macaron
+     * - Session annotations: Use SessionService from @noatgnu/cupcake-red-velvet
+     *
+     * These specialized services ensure proper permission checking through parent resources.
+     */
     getAnnotations(params?: {
         search?: string;
         annotationType?: string;
@@ -624,9 +717,52 @@ declare class ApiService {
         count: number;
         results: Annotation[];
     }>;
+    /**
+     * WARNING: This method accesses the base annotation endpoint and should only be used
+     * for standalone annotations that are NOT attached to parent resources.
+     *
+     * For annotations attached to parent resources, use the specialized services instead:
+     * - Instrument annotations: Use InstrumentService.getInstrumentAnnotation()
+     * - StoredReagent annotations: Use ReagentService.getStoredReagentAnnotation()
+     * - Session annotations: Use SessionService (session folder annotations)
+     *
+     * The backend enforces parent resource permissions, but using specialized services
+     * provides cleaner access control and better context.
+     */
     getAnnotation(id: number): Observable<Annotation>;
+    /**
+     * WARNING: This method accesses the base annotation endpoint and should only be used
+     * for standalone annotations that are NOT attached to parent resources.
+     *
+     * For creating annotations attached to parent resources, use specialized upload methods:
+     * - Instrument annotations: Use InstrumentService.uploadAnnotation()
+     * - StoredReagent annotations: Use ReagentService.uploadAnnotation()
+     * - Session/Step annotations: Use the appropriate chunked upload service
+     *
+     * These specialized methods provide chunked upload support, progress tracking,
+     * and automatic binding to parent resources with proper permission enforcement.
+     */
     createAnnotation(annotationData: AnnotationCreateRequest): Observable<Annotation>;
+    /**
+     * WARNING: This method accesses the base annotation endpoint and should only be used
+     * for standalone annotations that are NOT attached to parent resources.
+     *
+     * For annotations attached to parent resources, the backend enforces parent resource
+     * permissions. However, using specialized services provides better context and access control.
+     */
     updateAnnotation(id: number, annotationData: AnnotationUpdateRequest): Observable<Annotation>;
+    /**
+     * WARNING: This method accesses the base annotation endpoint and should only be used
+     * for standalone annotations that are NOT attached to parent resources.
+     *
+     * For deleting annotations attached to parent resources, use specialized services:
+     * - Instrument annotations: Use InstrumentService.deleteInstrumentAnnotation()
+     * - StoredReagent annotations: Use ReagentService.deleteStoredReagentAnnotation()
+     * - Session annotations: Use appropriate session/step annotation delete methods
+     *
+     * The backend enforces parent resource permissions, but using specialized services
+     * provides clearer intent and better access control context.
+     */
     deleteAnnotation(id: number): Observable<void>;
     getResourcePermissions(params?: {
         user?: number;
@@ -1038,6 +1174,7 @@ declare const authGuard: CanActivateFn;
 
 declare const adminGuard: CanActivateFn;
 
+declare function resetRefreshState(): void;
 declare const authInterceptor: HttpInterceptorFn;
 
 declare class LoginComponent implements OnInit {
@@ -1388,5 +1525,5 @@ declare class CupcakeCoreModule {
     static ɵinj: _angular_core.ɵɵInjectorDeclaration<CupcakeCoreModule>;
 }
 
-export { ApiService, AuthService, BaseApiService, CUPCAKE_CORE_CONFIG, CupcakeCoreModule, InvitationStatus, InvitationStatusLabels, LabGroupService, LabGroupsComponent, LoginComponent, NotificationService, PoweredByFooterComponent, RegisterComponent, ResourceRole, ResourceRoleLabels, ResourceService, ResourceType, ResourceTypeLabels, ResourceVisibility, ResourceVisibilityLabels, SiteConfigComponent, SiteConfigService, ThemeService, ToastContainerComponent, ToastService, UserManagementComponent, UserManagementService, UserProfileComponent, WEBSOCKET_ENDPOINT, WEBSOCKET_ENDPOINTS, WebSocketConfigService, WebSocketEndpoints, WebSocketService, adminGuard, authGuard, authInterceptor };
-export type { AccountMergeRequest, AdminPasswordResetRequest, Annotation, AnnotationCreateRequest, AnnotationFolder, AnnotationFolderCreateRequest, AnnotationFolderUpdateRequest, AnnotationUpdateRequest, ApiResponse, AuthConfig, AuthResponse, AuthStatus, BaseResource, BaseTimestampedModel, BulkPermissionRequest, CupcakeCoreConfig, EmailChangeConfirmRequest, EmailChangeConfirmResponse, EmailChangeRequest, InvitationResponseRequest, LabGroup, LabGroupCreateRequest, LabGroupInvitation, LabGroupInvitationCreateRequest, LabGroupInvitationQueryParams, LabGroupInvitationQueryResponse, LabGroupInviteRequest, LabGroupMember, LabGroupPathItem, LabGroupPermission, LabGroupPermissionCreateRequest, LabGroupPermissionQueryParams, LabGroupPermissionQueryResponse, LabGroupPermissionUpdateRequest, LabGroupQueryParams, LabGroupQueryResponse, LabGroupUpdateRequest, NotificationAction, NotificationItem, PaginatedResponse, PasswordChangeRequest, PasswordChangeResponse, PasswordResetConfirmRequest, PasswordResetRequest, RegistrationStatus, RemoteHost, RemoteHostCreateRequest, RemoteHostUpdateRequest, ResourcePermission, ResourcePermissionCreateRequest, ResourcePermissionUpdateRequest, ResourceQueryParams, SiteConfig, SiteConfigUpdateRequest, Theme, ToastMessage, User, UserCreateRequest, UserListResponse, UserOrcidProfile, UserProfileUpdateRequest, UserRegistrationRequest, UserResponse, WebSocketConfig, WebSocketEndpointConfig, WebSocketMessage };
+export { AnnotationType, ApiService, AuthService, BaseApiService, CUPCAKE_CORE_CONFIG, CupcakeCoreModule, InvitationStatus, InvitationStatusLabels, LabGroupService, LabGroupsComponent, LoginComponent, NotificationService, PoweredByFooterComponent, RegisterComponent, ResourceRole, ResourceRoleLabels, ResourceService, ResourceType, ResourceTypeLabels, ResourceVisibility, ResourceVisibilityLabels, SiteConfigComponent, SiteConfigService, ThemeService, ToastContainerComponent, ToastService, UserManagementComponent, UserManagementService, UserProfileComponent, WEBSOCKET_ENDPOINT, WEBSOCKET_ENDPOINTS, WebSocketConfigService, WebSocketEndpoints, WebSocketService, adminGuard, authGuard, authInterceptor, resetRefreshState };
+export type { AccountMergeRequest, AdminPasswordResetRequest, Annotation, AnnotationCreateRequest, AnnotationFolder, AnnotationFolderCreateRequest, AnnotationFolderUpdateRequest, AnnotationUpdateRequest, ApiResponse, AsyncTaskUpdateNotification, AuthConfig, AuthResponse, AuthStatus, BaseNotification, BaseResource, BaseTimestampedModel, BulkPermissionRequest, ConnectionEstablishedNotification, CupcakeCoreConfig, EmailChangeConfirmRequest, EmailChangeConfirmResponse, EmailChangeRequest, InvitationResponseRequest, LabGroup, LabGroupCreateRequest, LabGroupInvitation, LabGroupInvitationCreateRequest, LabGroupInvitationQueryParams, LabGroupInvitationQueryResponse, LabGroupInviteRequest, LabGroupMember, LabGroupPathItem, LabGroupPermission, LabGroupPermissionCreateRequest, LabGroupPermissionQueryParams, LabGroupPermissionQueryResponse, LabGroupPermissionUpdateRequest, LabGroupQueryParams, LabGroupQueryResponse, LabGroupUpdateNotification, LabGroupUpdateRequest, MetadataTableUpdateNotification, NotificationAction, NotificationItem, PaginatedResponse, PasswordChangeRequest, PasswordChangeResponse, PasswordResetConfirmRequest, PasswordResetRequest, RegistrationStatus, RemoteHost, RemoteHostCreateRequest, RemoteHostUpdateRequest, ResourcePermission, ResourcePermissionCreateRequest, ResourcePermissionUpdateRequest, ResourceQueryParams, SiteConfig, SiteConfigUpdateRequest, SystemNotification, Theme, ToastMessage, TranscriptionCompletedNotification, TranscriptionFailedNotification, TranscriptionStartedNotification, User, UserCreateRequest, UserListResponse, UserOrcidProfile, UserProfileUpdateRequest, UserRegistrationRequest, UserResponse, WebSocketConfig, WebSocketEndpointConfig, WebSocketMessage, WebSocketNotification };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@noatgnu/cupcake-core",
-  "version": "1.2.9",
+  "version": "1.2.11",
   "description": "A reusable Angular library that provides user management, authentication, and site configuration functionality for cupcake applications.",
   "keywords": [
     "angular",