unitysvc-services 0.1.24__py3-none-any.whl

unitysvc_services/models/listing_data.py

@@ -0,0 +1,118 @@
+"""Base data models for service listings.
+
+This module defines `ServiceListingData`, a base model containing the core fields
+for service listing data that is shared between:
+- unitysvc-services (CLI): Used for file-based listing definitions
+- unitysvc (backend): Used for API payloads and database operations
+
+The `ListingV1` model extends this with file-specific fields like `schema_version`
+and `time_created` for data file validation.
+"""
+
+from typing import Any
+
+from pydantic import BaseModel, Field
+
+from .base import CurrencyEnum, ListingStatusEnum
+
+
+class ServiceListingData(BaseModel):
+    """
+    Base data structure for service listing information.
+
+    This model contains the core fields needed to describe a service listing,
+    without file-specific validation fields. It serves as:
+
+    1. The base class for `ListingV1` in unitysvc-services (with additional
+       schema_version and time_created fields for file validation)
+
+    2. The data structure imported by unitysvc backend for:
+       - API payload validation
+       - Database comparison logic in find_and_compare_service_listing()
+       - Publish operations from CLI
+
+    Key characteristics:
+    - Uses string identifiers (service_name, provider_name, seller_name)
+      that get resolved to database IDs by the backend
+    - Contains all user-provided data without system-generated IDs
+    - Does not include permission/audit fields (handled by backend CRUD layer)
+    - Uses dict types for nested structures to maintain flexibility between
+      file definitions and database operations
+    """
+
+    # Reference to service offering - required for backend resolution
+    service_name: str | None = Field(
+        default=None,
+        description=(
+            "Name of the service (ServiceV1.name), optional if only one service is defined under the same directory."
+        ),
+    )
+    service_version: str | None = Field(
+        default=None,
+        description="Version of the service offering",
+    )
+    provider_name: str | None = Field(
+        default=None,
+        description="Provider name (resolved from directory structure if not specified)",
+    )
+
+    # Seller info
+    seller_name: str | None = Field(
+        default=None,
+        description="Name of the seller offering this service listing",
+    )
+
+    # Listing identification
+    name: str | None = Field(
+        default=None,
+        max_length=255,
+        description="Name identifier for the service listing (defaults to 'default' if not provided)",
+    )
+
+    # Display name for UI
+    display_name: str | None = Field(
+        default=None,
+        max_length=200,
+        description="Human-readable listing name (e.g., 'Premium GPT-4 Access', 'Enterprise AI Services')",
+    )
+
+    # Status - seller-accessible statuses
+    listing_status: ListingStatusEnum = Field(
+        default=ListingStatusEnum.draft,
+        description="Listing status: draft (skip publish), ready (ready for admin review), or deprecated (retired)",
+    )
+
+    # Customer pricing
+    customer_price: dict[str, Any] | None = Field(
+        default=None,
+        description="Customer pricing: What the customer pays for each unit of service usage",
+    )
+
+    # Currency for customer_price
+    currency: CurrencyEnum = Field(
+        default=CurrencyEnum.USD,
+        description="Currency for customer_price (indexed for filtering)",
+    )
+
+    # Access interfaces
+    user_access_interfaces: list[dict[str, Any]] | None = Field(
+        default=None,
+        description="List of user access interfaces for the listing",
+    )
+
+    # Documents
+    documents: list[dict[str, Any]] | None = Field(
+        default=None,
+        description="List of documents associated with the listing (e.g., service level agreements)",
+    )
+
+    # User parameters
+    user_parameters_schema: dict[str, Any] | None = Field(
+        default=None,
+        description="JSON Schema for user parameters",
+    )
+
+    user_parameters_ui_schema: dict[str, Any] | None = Field(
+        default=None,
+        description="UI schema for user parameters form rendering",
+    )

unitysvc_services/models/listing_v1.py

@@ -0,0 +1,56 @@
+from datetime import datetime
+
+from pydantic import ConfigDict, Field, field_validator
+
+from .base import (
+    AccessInterface,
+    Document,
+    Pricing,
+    validate_name,
+)
+from .listing_data import ServiceListingData
+
+
+class ListingV1(ServiceListingData):
+    """
+    Service listing model for file-based definitions (listing_v1 schema).
+
+    Extends ServiceListingData with:
+    - schema_version: Schema identifier for file validation
+    - time_created: Timestamp for file creation
+    - Typed models (AccessInterface, Document, Pricing) instead of dicts
+    - Field validators for name format
+
+    This model is used for validating listing.json/listing.toml files
+    created by the CLI tool.
+    """
+
+    model_config = ConfigDict(extra="forbid")
+
+    # File-specific fields for validation
+    schema_version: str = Field(default="listing_v1", description="Schema identifier", alias="schema")
+    time_created: datetime
+
+    # Override with typed models instead of dicts for file validation
+    # (listing_status, user_parameters_schema, user_parameters_ui_schema are inherited from ServiceListingData)
+    user_access_interfaces: list[AccessInterface] = Field(  # type: ignore[assignment]
+        description="List of user access interfaces for the listing"
+    )
+
+    customer_price: Pricing | None = Field(  # type: ignore[assignment]
+        default=None,
+        description="Customer pricing information",
+    )
+
+    documents: list[Document] | None = Field(  # type: ignore[assignment]
+        default=None,
+        description="List of documents associated with the listing (e.g. service level agreements)",
+    )
+
+    @field_validator("name")
+    @classmethod
+    def validate_name_format(cls, v: str | None) -> str | None:
+        """Validate that listing name uses valid identifiers (allows slashes for hierarchical names)."""
+        if v is None:
+            return v
+        return validate_name(v, "listing", allow_slash=True)

unitysvc_services/models/provider_data.py

@@ -0,0 +1,79 @@
+"""Base data model for providers.
+
+This module defines `ProviderData`, a base model containing the core fields
+for provider data that is shared between:
+- unitysvc-services (CLI): Used for file-based provider definitions
+- unitysvc (backend): Used for API payloads and database operations
+
+The `ProviderV1` model extends this with file-specific fields like `schema_version`
+and `time_created` for data file validation.
+"""
+
+from typing import Any
+
+from pydantic import BaseModel, EmailStr, Field, HttpUrl
+
+from .base import ProviderStatusEnum
+
+
+class ProviderData(BaseModel):
+    """
+    Base data structure for provider information.
+
+    This model contains the core fields needed to describe a provider,
+    without file-specific validation fields. It serves as:
+
+    1. The base class for `ProviderV1` in unitysvc-services (with additional
+       schema_version, time_created, and services_populator fields for file validation)
+
+    2. The data structure imported by unitysvc backend for:
+       - API payload validation
+       - Database comparison logic in find_and_compare_provider()
+       - Publish operations from CLI
+
+    Key characteristics:
+    - Uses string identifiers that match database requirements
+    - Contains all user-provided data without system-generated IDs
+    - Does not include permission/audit fields (handled by backend CRUD layer)
+    """
+
+    # Provider identification
+    name: str = Field(
+        description="Unique provider identifier (URL-friendly, e.g., 'fireworks', 'anthropic')",
+        min_length=2,
+        max_length=100,
+    )
+
+    display_name: str | None = Field(
+        default=None,
+        max_length=200,
+        description="Human-readable provider name (e.g., 'Fireworks AI', 'Anthropic')",
+    )
+
+    # Contact information
+    contact_email: EmailStr = Field(description="Primary contact email for the provider")
+
+    secondary_contact_email: EmailStr | None = Field(
+        default=None,
+        description="Secondary contact email",
+    )
+
+    homepage: HttpUrl = Field(description="Provider's homepage URL")
+
+    # Provider information
+    description: str | None = Field(
+        default=None,
+        description="Brief description of the provider",
+    )
+
+    # Status
+    status: ProviderStatusEnum = Field(
+        default=ProviderStatusEnum.active,
+        description="Provider status: active, disabled, or draft (skip publish)",
+    )
+
+    # Documents (as dicts for flexibility)
+    documents: list[dict[str, Any]] | None = Field(
+        default=None,
+        description="List of documents associated with the provider",
+    )

unitysvc_services/models/provider_v1.py

@@ -0,0 +1,54 @@
+from datetime import datetime
+from typing import Any
+
+from pydantic import ConfigDict, Field, HttpUrl, field_validator
+
+from .base import AccessInterface, Document, validate_name
+from .provider_data import ProviderData
+
+
+class ProviderV1(ProviderData):
+    """
+    Provider information for service providers (provider_v1 schema).
+
+    Extends ProviderData with:
+    - schema_version: Schema identifier for file validation
+    - time_created: Timestamp for file creation
+    - services_populator: How to automatically populate service data
+    - provider_access_info: Parameters for accessing service provider
+    - logo, terms_of_service: Convenience fields (converted to documents during import)
+    - Typed Document model instead of dict for file validation
+    - Field validators for name format
+    """
+
+    model_config = ConfigDict(extra="forbid")
+
+    # File-specific fields for validation
+    schema_version: str = Field(default="provider_v1", description="Schema identifier", alias="schema")
+    time_created: datetime
+
+    # How to automatically populate service data, if available
+    services_populator: dict[str, Any] | None = None
+
+    # Parameters for accessing service provider (base_url, api_key)
+    provider_access_info: AccessInterface = Field(description="Dictionary of upstream access interface")
+
+    # Convenience fields for logo and terms of service (converted to documents during import)
+    logo: str | HttpUrl | None = None
+
+    terms_of_service: None | str | HttpUrl = Field(
+        default=None,
+        description="Either a path to a .md file or a URL to terms of service",
+    )
+
+    # Override with typed Document model for file validation
+    documents: list[Document] | None = Field(  # type: ignore[assignment]
+        default=None,
+        description="List of documents associated with the provider (e.g. logo)",
+    )
+
+    @field_validator("name")
+    @classmethod
+    def validate_name_format(cls, v: str) -> str:
+        """Validate that provider name uses URL-safe identifiers."""
+        return validate_name(v, "provider", allow_slash=False)

unitysvc_services/models/seller_data.py

@@ -0,0 +1,120 @@
+"""Base data model for sellers.
+
+This module defines `SellerData`, a base model containing the core fields
+for seller data that is shared between:
+- unitysvc-services (CLI): Used for file-based seller definitions
+- unitysvc (backend): Used for API payloads and database operations
+
+The `SellerV1` model extends this with file-specific fields like `schema_version`
+and `time_created` for data file validation.
+"""
+
+from typing import Any
+
+from pydantic import BaseModel, EmailStr, Field, HttpUrl
+
+from .base import SellerStatusEnum, SellerTypeEnum
+
+
+class SellerData(BaseModel):
+    """
+    Base data structure for seller information.
+
+    This model contains the core fields needed to describe a seller,
+    without file-specific validation fields. It serves as:
+
+    1. The base class for `SellerV1` in unitysvc-services (with additional
+       schema_version and time_created fields for file validation)
+
+    2. The data structure imported by unitysvc backend for:
+       - API payload validation
+       - Database comparison logic in find_and_compare_seller()
+       - Publish operations from CLI
+
+    Key characteristics:
+    - Uses string identifiers that match database requirements
+    - account_manager is a string (username/email) that gets resolved to account_manager_id
+    - Contains all user-provided data without system-generated IDs
+    - Does not include permission/audit fields (handled by backend CRUD layer)
+    """
+
+    # Seller identification
+    name: str = Field(
+        description="Unique seller identifier (URL-friendly, e.g., 'acme-corp', 'john-doe')",
+        min_length=2,
+        max_length=100,
+    )
+
+    display_name: str | None = Field(
+        default=None,
+        max_length=200,
+        description="Human-readable seller name (e.g., 'ACME Corporation', 'John Doe')",
+    )
+
+    # Seller type
+    seller_type: SellerTypeEnum = Field(
+        default=SellerTypeEnum.individual,
+        description="Type of seller entity",
+    )
+
+    # Contact information
+    contact_email: EmailStr = Field(description="Primary contact email for the seller")
+
+    secondary_contact_email: EmailStr | None = Field(
+        default=None,
+        description="Secondary contact email",
+    )
+
+    account_manager: str | None = Field(
+        default=None,
+        max_length=100,
+        description="Email or username of the user managing this seller account",
+    )
+
+    homepage: HttpUrl | None = Field(
+        default=None,
+        description="Seller's homepage URL",
+    )
+
+    # Business information
+    description: str | None = Field(
+        default=None,
+        max_length=1000,
+        description="Brief description of the seller",
+    )
+
+    business_registration: str | None = Field(
+        default=None,
+        max_length=100,
+        description="Business registration number (if organization)",
+    )
+
+    tax_id: str | None = Field(
+        default=None,
+        max_length=100,
+        description="Tax identification number (EIN, VAT, etc.)",
+    )
+
+    # Stripe Connect integration
+    stripe_connect_id: str | None = Field(
+        default=None,
+        max_length=255,
+        description="Stripe Connect account ID for payment processing",
+    )
+
+    # Status
+    status: SellerStatusEnum = Field(
+        default=SellerStatusEnum.active,
+        description="Seller status: active, disabled, or draft (skip publish)",
+    )
+
+    is_verified: bool = Field(
+        default=False,
+        description="Whether the seller has been verified (KYC/business verification)",
+    )
+
+    # Documents (as dicts for flexibility)
+    documents: list[dict[str, Any]] | None = Field(
+        default=None,
+        description="List of documents associated with the seller",
+    )

unitysvc_services/models/seller_v1.py

@@ -0,0 +1,42 @@
+from datetime import datetime
+
+from pydantic import ConfigDict, Field, HttpUrl, field_validator
+
+from .base import Document, validate_name
+from .seller_data import SellerData
+
+
+class SellerV1(SellerData):
+    """
+    Seller information for marketplace sellers (seller_v1 schema).
+
+    Extends SellerData with:
+    - schema_version: Schema identifier for file validation
+    - time_created: Timestamp for file creation
+    - logo: Convenience field (converted to documents during import)
+    - Typed Document model instead of dict for file validation
+    - Field validators for name format
+
+    Each repository can only have one seller.json file at the root of the data directory.
+    """
+
+    model_config = ConfigDict(extra="forbid")
+
+    # File-specific fields for validation
+    schema_version: str = Field(default="seller_v1", description="Schema identifier", alias="schema")
+    time_created: datetime
+
+    # Convenience field for logo (converted to documents during import)
+    logo: str | HttpUrl | None = None
+
+    # Override with typed Document model for file validation
+    documents: list[Document] | None = Field(  # type: ignore[assignment]
+        default=None,
+        description="List of documents associated with the seller (e.g. business registration, tax documents)",
+    )
+
+    @field_validator("name")
+    @classmethod
+    def validate_name_format(cls, v: str) -> str:
+        """Validate that seller name uses URL-safe identifiers."""
+        return validate_name(v, "seller", allow_slash=False)

unitysvc_services/models/service_data.py

@@ -0,0 +1,114 @@
+"""Base data model for service offerings.
+
+This module defines `ServiceOfferingData`, a base model containing the core fields
+for service offering data that is shared between:
+- unitysvc-services (CLI): Used for file-based service definitions
+- unitysvc (backend): Used for API payloads and database operations
+
+The `ServiceV1` model extends this with file-specific fields like `schema_version`
+and `time_created` for data file validation.
+"""
+
+from typing import Any
+
+from pydantic import BaseModel, Field
+
+from .base import CurrencyEnum, ServiceTypeEnum, UpstreamStatusEnum
+
+
+class ServiceOfferingData(BaseModel):
+    """
+    Base data structure for service offering information.
+
+    This model contains the core fields needed to describe a service offering,
+    without file-specific validation fields. It serves as:
+
+    1. The base class for `ServiceV1` in unitysvc-services (with additional
+       schema_version and time_created fields for file validation)
+
+    2. The data structure imported by unitysvc backend for:
+       - API payload validation
+       - Database comparison logic in find_and_compare_service_offering()
+       - Publish operations from CLI
+
+    Key characteristics:
+    - Uses string identifiers (provider_name) that get resolved to database IDs
+    - upstream_status maps to database 'status' field
+    - Contains all user-provided data without system-generated IDs
+    - Does not include permission/audit fields (handled by backend CRUD layer)
+    """
+
+    # Service identification
+    name: str = Field(
+        description="Technical service name (e.g., 'gpt-4')",
+        max_length=100,
+    )
+
+    display_name: str | None = Field(
+        default=None,
+        max_length=150,
+        description="Human-friendly common name (e.g., 'GPT-4 Turbo')",
+    )
+
+    version: str | None = Field(
+        default=None,
+        max_length=50,
+        description="Service version if applicable",
+    )
+
+    service_type: ServiceTypeEnum = Field(
+        default=ServiceTypeEnum.llm,
+        description="Category for grouping/comparison",
+    )
+
+    description: str | None = Field(
+        default=None,
+        description="Service description",
+    )
+
+    tagline: str | None = Field(
+        default=None,
+        description="Short elevator pitch or description for the service",
+    )
+
+    # Provider info (resolved by publish layer)
+    provider_name: str | None = Field(
+        default=None,
+        description="Provider name (resolved from directory structure if not specified)",
+    )
+
+    # Status
+    upstream_status: UpstreamStatusEnum = Field(
+        default=UpstreamStatusEnum.ready,
+        description="Status of the service from upstream service provider",
+    )
+
+    # Technical details
+    details: dict[str, Any] | None = Field(
+        default=None,
+        description="Static technical specifications and features",
+    )
+
+    # Pricing
+    seller_price: dict[str, Any] | None = Field(
+        default=None,
+        description="Seller pricing: The agreed rate between seller and UnitySVC",
+    )
+
+    # Access interface
+    upstream_access_interface: dict[str, Any] | None = Field(
+        default=None,
+        description="How to access the service from upstream",
+    )
+
+    # Documents
+    documents: list[dict[str, Any]] | None = Field(
+        default=None,
+        description="List of documents associated with the service",
+    )
+
+    # Currency for seller_price
+    currency: CurrencyEnum = Field(
+        default=CurrencyEnum.USD,
+        description="Currency for seller_price",
+    )

unitysvc_services/models/service_v1.py

@@ -0,0 +1,81 @@
+from datetime import datetime
+from typing import Any
+
+from pydantic import ConfigDict, Field, HttpUrl, field_validator
+
+from .base import (
+    AccessInterface,
+    Document,
+    Pricing,
+    TagEnum,
+    validate_name,
+)
+from .service_data import ServiceOfferingData
+
+
+class ServiceV1(ServiceOfferingData):
+    """
+    Service offering model for file-based definitions (service_v1 schema).
+
+    Extends ServiceOfferingData with:
+    - schema_version: Schema identifier for file validation
+    - time_created: Timestamp for file creation
+    - logo: Convenience field (converted to documents during import)
+    - tags: Tags for the service (e.g., bring your own API key)
+    - Typed models (AccessInterface, Document, Pricing) instead of dicts
+    - Field validators for name format
+
+    This model is used for validating service.json/service.toml files
+    created by the CLI tool.
+    """
+
+    model_config = ConfigDict(extra="forbid")
+
+    # File-specific fields for validation
+    schema_version: str = Field(default="service_v1", description="Schema identifier", alias="schema")
+    time_created: datetime
+
+    # Override to make required in file validation (base has Optional for API flexibility)
+    display_name: str = Field(  # type: ignore[assignment]
+        max_length=150,
+        description="Human-friendly common name (e.g., 'GPT-4 Turbo')",
+    )
+
+    description: str = Field(  # type: ignore[assignment]
+        description="Service description",
+    )
+
+    # Required in file for static information
+    details: dict[str, Any] = Field(  # type: ignore[assignment]
+        description="Dictionary of static features and information",
+    )
+
+    # Convenience field for logo (converted to documents during import)
+    logo: str | HttpUrl | None = None
+
+    # Tags for the service
+    tags: list[TagEnum] | None = Field(
+        default=None,
+        description="List of tags for the service, e.g., bring your own API key",
+    )
+
+    # Override with typed models for file validation
+    upstream_access_interface: AccessInterface = Field(  # type: ignore[assignment]
+        description="Dictionary of upstream access interface",
+    )
+
+    documents: list[Document] | None = Field(  # type: ignore[assignment]
+        default=None,
+        description="List of documents associated with the service (e.g. tech spec.)",
+    )
+
+    seller_price: Pricing | None = Field(  # type: ignore[assignment]
+        default=None,
+        description="Seller pricing information",
+    )
+
+    @field_validator("name")
+    @classmethod
+    def validate_name_format(cls, v: str) -> str:
+        """Validate that service name uses valid identifiers (allows slashes for hierarchical names)."""
+        return validate_name(v, "service", allow_slash=True)