@noatgnu/cupcake-core 1.2.9 → 1.2.10

package/index.d.ts

@@ -364,7 +364,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 +375,9 @@ interface Annotation extends BaseResource {
     translation?: string;
     scratched: boolean;
     ownerName?: string;
+    canEdit?: boolean;
+    canView?: boolean;
+    canDelete?: boolean;
 }
 interface AnnotationFolderCreateRequest {
     folderName: string;
@@ -611,6 +614,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 +638,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 +1095,7 @@ declare const authGuard: CanActivateFn;
 
 declare const adminGuard: CanActivateFn;
 
+declare function resetRefreshState(): void;
 declare const authInterceptor: HttpInterceptorFn;
 
 declare class LoginComponent implements OnInit {
@@ -1388,5 +1446,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 { 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, 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 };

package/package.json

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