python-alfresco-api 1.1.4__tar.gz → 1.1.5__tar.gz

{python_alfresco_api-1.1.4 → python_alfresco_api-1.1.5}/CHANGELOG.md

@@ -4,6 +4,24 @@ All notable changes to python-alfresco-api will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.1.5] - 2025-12-14
+
+### Fixed
+- **Custom Content Type Support**: Fixed `NodeType` validation to support custom Alfresco content models (e.g., `fin:stock`, `my:invoice`)
+  - Changed `NodeType` from strict `Enum` to namespace class accepting any string type
+  - Standard types still available as constants (`NodeType.CONTENT`, `NodeType.FOLDER`)
+  - Eliminates `ValidationError` when retrieving nodes with custom types
+- **Create Folder Methods**: Fixed missing `versioning_enabled` and `major_version` parameters in convenience methods
+  - Updated `create_folder()` and `create_folder_async()` to pass required parameters to `CreateNodeRequest`
+  - Prevents linter errors about missing required parameters
+
+### Added
+- **`relative_path` Parameter**: Added explicit `relative_path` parameter to all `get_node` methods
+  - `get_node()`, `get_node_async()`, `get_node_detailed()`, `get_node_detailed_async()`
+  - Automatically converts to REST API's `relativePath` query parameter (snake_case → camelCase)
+  - Enables path-based navigation: `client.nodes.get("-root-", relative_path="Sites/mysite/documentLibrary/file.pdf")`
+- **`**kwargs` Support**: Added `**kwargs` to all `get_node` methods for forward compatibility with future API parameters
+
 ## [1.1.4] - 2025-10-01
 
 ### Added

{python_alfresco_api-1.1.4 → python_alfresco_api-1.1.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-alfresco-api
-Version: 1.1.4
+Version: 1.1.5
 Summary: Python Client for all Alfresco Content Services REST APIs, with Pydantic v2 Models, and Event Support
 Project-URL: Homepage, https://github.com/stevereiner/python-alfresco-api
 Project-URL: Repository, https://github.com/stevereiner/python-alfresco-api

{python_alfresco_api-1.1.4 → python_alfresco_api-1.1.5}/pyproject.toml

@@ -38,7 +38,7 @@ include = [
 
 [project]
 name = "python-alfresco-api"
-version = "1.1.4"
+version = "1.1.5"
 description = "Python Client for all Alfresco Content Services REST APIs, with Pydantic v2 Models, and Event Support"
 authors = [
     {name = "Steve Reiner", email = "example@example.com"}

{python_alfresco_api-1.1.4 → python_alfresco_api-1.1.5}/python_alfresco_api/clients/core/models.py

@@ -1,133 +1,148 @@
-"""
-Level 2: Core API Models - Shared within Core API
-
-This module contains models and structures that are specific to the
-Alfresco Core API but shared across multiple Core operations.
-
-Three-Tier Architecture:
-- Level 1: Global models shared across ALL APIs
-- Level 2 (This file): Core API models shared within Core API
-- Level 3: Operation-specific models for specific operations
-
-Benefits:
-- Perfect locality (Core-specific models in Core namespace)
-- Clean imports (from .models import CoreResponse)
-- Logical organization (API-level grouping)
-- Maintainability (focused scope)
-"""
-
-from typing import Optional, List, Dict, Any, Union
-from datetime import datetime
-from pydantic import BaseModel, Field, ConfigDict
-from enum import Enum
-
-# Import global models
-from ..models import BaseEntry, PagingInfo, ContentInfo, UserInfo
-
-
-class CoreResponse(BaseModel):
-    """Base response wrapper for Core API operations."""
-    model_config = ConfigDict(extra='forbid')
-    
-    entry: Optional[BaseEntry] = Field(None, description="Single entry response")
-    
-    
-class CoreEntryList(BaseModel):
-    """List response wrapper for Core API operations."""
-    model_config = ConfigDict(extra='forbid')
-    
-    entries: List[BaseEntry] = Field(default_factory=list, description="List of entries")
-    pagination: Optional[PagingInfo] = Field(None, description="Pagination information")
-
-
-class Permission(str, Enum):
-    """Alfresco permission levels for Core API."""
-    READ = "Read"
-    WRITE = "Write" 
-    DELETE = "Delete"
-    CHANGE_PERMISSIONS = "ChangePermissions"
-    FULL_CONTROL = "FullControl"
-    COORDINATOR = "SiteCoordinator"
-    COLLABORATOR = "SiteCollaborator"
-    CONTRIBUTOR = "SiteContributor"
-    CONSUMER = "SiteConsumer"
-
-
-class NodeType(str, Enum):
-    """Alfresco content model node types."""
-    CONTENT = "cm:content"
-    FOLDER = "cm:folder"
-    PERSON = "cm:person"
-    GROUP = "cm:authorityContainer"
-    SITE = "st:site"
-    
-
-class VersionType(str, Enum):
-    """Version types for Core API operations."""
-    MAJOR = "MAJOR"
-    MINOR = "MINOR"
-
-
-class SortOrder(str, Enum):
-    """Sort order options."""
-    ASC = "ASC"
-    DESC = "DESC"
-
-
-class IncludeOption(str, Enum):
-    """Include options for Core API requests."""
-    PROPERTIES = "properties"
-    PERMISSIONS = "permissions"
-    PATH = "path"
-    CHILDREN = "children"
-    ASSOCIATION = "association"
-    ASPECTS = "aspects"
-    IS_LINK = "isLink"
-    IS_LOCKED = "isLocked"
-    ALLOW_ABLE_OPERATIONS = "allowableOperations"
-
-
-class CorePermissionInfo(BaseModel):
-    """Permission information for Core API objects."""
-    model_config = ConfigDict(extra='forbid')
-    
-    authority_id: str = Field(..., description="Authority (user/group) identifier")
-    authority_type: str = Field(..., description="Type of authority (USER, GROUP)")
-    permission: Permission = Field(..., description="Permission level")
-    access_status: str = Field(..., description="Access status (ALLOWED, DENIED)")
-
-
-class CoreAspectInfo(BaseModel):
-    """Aspect information for Core API objects."""
-    model_config = ConfigDict(extra='forbid')
-    
-    aspect_name: str = Field(..., description="Aspect name (e.g., cm:titled)")
-    title: Optional[str] = Field(None, description="Aspect title") 
-    description: Optional[str] = Field(None, description="Aspect description")
-
-
-class CorePathElement(BaseModel):
-    """Path element for Core API path structures."""
-    model_config = ConfigDict(extra='allow')  # Allow extra fields from Alfresco
-    
-    id: str = Field(..., description="Node ID")
-    name: str = Field(..., description="Node name")
-    node_type: Optional[str] = Field(None, alias="nodeType", description="Node type")
-    aspect_names: Optional[List[str]] = Field(None, alias="aspectNames", description="Aspect names")
-
-
-class CorePathInfo(BaseModel):
-    """Path information for Core API objects."""
-    model_config = ConfigDict(extra='allow')  # Allow extra fields from Alfresco
-    
-    elements: List[CorePathElement] = Field(default_factory=list, description="Path elements")
-    name: Optional[str] = Field(None, description="Display name")
-    is_complete: Optional[bool] = Field(None, alias="isComplete", description="Whether path is complete")
-
-
-# Export all models
-__all__ = [
-    'CoreResponse', 'CoreEntryList', 'Permission', 'NodeType', 'VersionType',
-    'SortOrder', 'IncludeOption', 'CorePermissionInfo', 'CoreAspectInfo', 
-    'CorePathElement', 'CorePathInfo'
+"""
+Level 2: Core API Models - Shared within Core API
+
+This module contains models and structures that are specific to the
+Alfresco Core API but shared across multiple Core operations.
+
+Three-Tier Architecture:
+- Level 1: Global models shared across ALL APIs
+- Level 2 (This file): Core API models shared within Core API
+- Level 3: Operation-specific models for specific operations
+
+Benefits:
+- Perfect locality (Core-specific models in Core namespace)
+- Clean imports (from .models import CoreResponse)
+- Logical organization (API-level grouping)
+- Maintainability (focused scope)
+"""
+
+from typing import Optional, List, Dict, Any, Union
+from datetime import datetime
+from pydantic import BaseModel, Field, ConfigDict
+from enum import Enum
+
+# Import global models
+from ..models import BaseEntry, PagingInfo, ContentInfo, UserInfo
+
+
+class CoreResponse(BaseModel):
+    """Base response wrapper for Core API operations."""
+    model_config = ConfigDict(extra='forbid')
+    
+    entry: Optional[BaseEntry] = Field(None, description="Single entry response")
+    
+    
+class CoreEntryList(BaseModel):
+    """List response wrapper for Core API operations."""
+    model_config = ConfigDict(extra='forbid')
+    
+    entries: List[BaseEntry] = Field(default_factory=list, description="List of entries")
+    pagination: Optional[PagingInfo] = Field(None, description="Pagination information")
+
+
+class Permission(str, Enum):
+    """Alfresco permission levels for Core API."""
+    READ = "Read"
+    WRITE = "Write" 
+    DELETE = "Delete"
+    CHANGE_PERMISSIONS = "ChangePermissions"
+    FULL_CONTROL = "FullControl"
+    COORDINATOR = "SiteCoordinator"
+    COLLABORATOR = "SiteCollaborator"
+    CONTRIBUTOR = "SiteContributor"
+    CONSUMER = "SiteConsumer"
+
+
+class NodeType:
+    """
+    Alfresco content model node types.
+    
+    This class provides constants for common node types while allowing
+    custom types (e.g., 'my:customDocument', 'acme:invoice').
+    
+    Use as a namespace for common types:
+        NodeType.CONTENT  # "cm:content"
+        NodeType.FOLDER   # "cm:folder"
+    
+    Or use any custom string directly:
+        node_type = "my:customDocument"  # Works with custom content models
+    """
+    CONTENT = "cm:content"
+    FOLDER = "cm:folder"
+    PERSON = "cm:person"
+    GROUP = "cm:authorityContainer"
+    SITE = "st:site"
+    
+    # Common custom types (for reference)
+    # Users can use any string value for their custom types
+    
+
+class VersionType(str, Enum):
+    """Version types for Core API operations."""
+    MAJOR = "MAJOR"
+    MINOR = "MINOR"
+
+
+class SortOrder(str, Enum):
+    """Sort order options."""
+    ASC = "ASC"
+    DESC = "DESC"
+
+
+class IncludeOption(str, Enum):
+    """Include options for Core API requests."""
+    PROPERTIES = "properties"
+    PERMISSIONS = "permissions"
+    PATH = "path"
+    CHILDREN = "children"
+    ASSOCIATION = "association"
+    ASPECTS = "aspects"
+    IS_LINK = "isLink"
+    IS_LOCKED = "isLocked"
+    ALLOW_ABLE_OPERATIONS = "allowableOperations"
+
+
+class CorePermissionInfo(BaseModel):
+    """Permission information for Core API objects."""
+    model_config = ConfigDict(extra='forbid')
+    
+    authority_id: str = Field(..., description="Authority (user/group) identifier")
+    authority_type: str = Field(..., description="Type of authority (USER, GROUP)")
+    permission: Permission = Field(..., description="Permission level")
+    access_status: str = Field(..., description="Access status (ALLOWED, DENIED)")
+
+
+class CoreAspectInfo(BaseModel):
+    """Aspect information for Core API objects."""
+    model_config = ConfigDict(extra='forbid')
+    
+    aspect_name: str = Field(..., description="Aspect name (e.g., cm:titled)")
+    title: Optional[str] = Field(None, description="Aspect title") 
+    description: Optional[str] = Field(None, description="Aspect description")
+
+
+class CorePathElement(BaseModel):
+    """Path element for Core API path structures."""
+    model_config = ConfigDict(extra='allow')  # Allow extra fields from Alfresco
+    
+    id: str = Field(..., description="Node ID")
+    name: str = Field(..., description="Node name")
+    node_type: Optional[str] = Field(None, alias="nodeType", description="Node type")
+    aspect_names: Optional[List[str]] = Field(None, alias="aspectNames", description="Aspect names")
+
+
+class CorePathInfo(BaseModel):
+    """Path information for Core API objects."""
+    model_config = ConfigDict(extra='allow')  # Allow extra fields from Alfresco
+    
+    elements: List[CorePathElement] = Field(default_factory=list, description="Path elements")
+    name: Optional[str] = Field(None, description="Display name")
+    is_complete: Optional[bool] = Field(None, alias="isComplete", description="Whether path is complete")
+
+
+# Export all models
+__all__ = [
+    'CoreResponse', 'CoreEntryList', 'Permission', 'NodeType', 'VersionType',
+    'SortOrder', 'IncludeOption', 'CorePermissionInfo', 'CoreAspectInfo', 
+    'CorePathElement', 'CorePathInfo'
 ]