ods-types-py 0.1.7__py3-none-any.whl

ods_types/__init__.py

@@ -0,0 +1,109 @@
+"""
+ODS Types - Python Implementation
+Core types and enums for the ODS (Optikka Design System).
+Python equivalent of @optikka/ods-types npm package.
+"""
+
+__version__ = "0.1.1"
+
+# Re-export all enums
+from ods_types.enums import (
+    # Renderer enums
+    Kind,
+    TargetKind,
+    FadeKind,
+    Easing,
+    Dimension,
+    AlignX,
+    AlignY,
+    LayerKind,
+    TextKind,
+    FillKind,
+    DropZoneMode,
+    SlideKind,
+    StackDir,
+    StackAlign,
+    ClampAxes,
+    AspectMode,
+    ScaleMode,
+    # Data layer enums
+    HTTPMethod,
+    ImageMimeType,
+    FontMimeType,
+    ReviewStatusEnum,
+    ImageTypeEnum,
+    BatchTypeEnum,
+    BatchStatusEnum,
+    ExecutionStatusEnum,
+    DesignDataInputTypes,
+    TextType,
+    RequiredFieldType,
+    CanvasGuideKind,
+    CanvasGridKind,
+    BentoAxis,
+    RenderRunStatus,
+    RenderRunQueueEventType,
+    TemplateInputJobStatus,
+    ColorType,
+    BrandRuleType,
+    BrandRuleTarget,
+    DataType,
+    ODSObjectType,
+    WhenToUseLogoEnum,
+)
+
+# Re-export all common types
+from ods_types.common import (
+    Target,
+    Box,
+    DrawImageParams,
+)
+
+__all__ = [
+    # Renderer enums
+    "Kind",
+    "TargetKind",
+    "FadeKind",
+    "Easing",
+    "Dimension",
+    "AlignX",
+    "AlignY",
+    "LayerKind",
+    "TextKind",
+    "FillKind",
+    "DropZoneMode",
+    "SlideKind",
+    "StackDir",
+    "StackAlign",
+    "ClampAxes",
+    "AspectMode",
+    "ScaleMode",
+    # Data layer enums
+    "HTTPMethod",
+    "ImageMimeType",
+    "FontMimeType",
+    "ReviewStatusEnum",
+    "ImageTypeEnum",
+    "BatchTypeEnum",
+    "BatchStatusEnum",
+    "ExecutionStatusEnum",
+    "DesignDataInputTypes",
+    "TextType",
+    "RequiredFieldType",
+    "CanvasGuideKind",
+    "CanvasGridKind",
+    "BentoAxis",
+    "RenderRunStatus",
+    "RenderRunQueueEventType",
+    "TemplateInputJobStatus",
+    "ColorType",
+    "BrandRuleType",
+    "BrandRuleTarget",
+    "DataType",
+    "ODSObjectType",
+    # Common types
+    "Target",
+    "Box",
+    "DrawImageParams",
+    "WhenToUseLogoEnum",
+]

ods_types/common.py

@@ -0,0 +1,44 @@
+"""
+ODS Types - Common Types
+Common type definitions for the ODS (Optikka Design System) renderer.
+Python equivalent of @optikka/ods-types/common
+"""
+
+from typing import TypedDict, Optional
+from ods_types.enums import TargetKind
+
+
+class Target(TypedDict, total=False):
+    """
+    Target reference for design elements.
+    Specifies what element a verb or action should target.
+    """
+    kind: TargetKind
+    id: Optional[str]
+    layerId: Optional[str]
+
+
+class Box(TypedDict):
+    """
+    Box represents a rectangular region with position and dimensions.
+    Used throughout the rendering system for positioning and sizing.
+    """
+    x: float
+    y: float
+    w: float
+    h: float
+
+
+class DrawImageParams(TypedDict):
+    """
+    Parameters for ctx.drawImage() - used for rendering images with different objectFit modes.
+    Maps to HTML Canvas API drawImage() method parameters.
+    """
+    sx: float       # Source X (crop start)
+    sy: float       # Source Y (crop start)
+    sWidth: float   # Source width (crop width)
+    sHeight: float  # Source height (crop height)
+    dx: float       # Destination X
+    dy: float       # Destination Y
+    dWidth: float   # Destination width
+    dHeight: float  # Destination height

ods_types/enums.py

@@ -0,0 +1,344 @@
+"""
+ODS Types - Enums
+Core enumerations for the ODS (Optikka Design System).
+Contains both renderer enums and data layer enums used across microservices.
+"""
+
+from enum import Enum
+
+
+# =============================================================================
+# RENDERER ENUMS - Used by the frontend/renderer
+# =============================================================================
+
+class Kind(str, Enum):
+    """Kind of design element"""
+    CANVAS = "canvas"
+    LAYER = "layer"
+
+
+class TargetKind(str, Enum):
+    """Target reference types"""
+    CANVAS = "canvas"
+    LAYER = "layer"
+    GUIDE = "guide"
+    SELF = "self"
+
+
+class FadeKind(str, Enum):
+    """Fade animation types"""
+    PHASE = "phase"
+
+
+class Easing(str, Enum):
+    """Animation easing functions"""
+    EASE_IN = "easeIn"
+    EASE_OUT = "easeOut"
+    EASE_IN_OUT = "easeInOut"
+    LINEAR = "linear"
+
+
+class Dimension(str, Enum):
+    """Dimension types"""
+    WIDTH = "width"
+    HEIGHT = "height"
+
+
+class AlignX(str, Enum):
+    """Horizontal alignment options"""
+    LEFT = "left"
+    CENTER = "center"
+    RIGHT = "right"
+    MIDDLE = "middle"
+
+
+class AlignY(str, Enum):
+    """Vertical alignment options"""
+    TOP = "top"
+    CENTER = "center"
+    MIDDLE = "middle"
+    BOTTOM = "bottom"
+
+
+class LayerKind(str, Enum):
+    """Layer reference types"""
+    SELF = "self"
+    OTHER = "other"  # other layer by id
+
+
+class TextKind(str, Enum):
+    """Text visibility types"""
+    PUBLIC = "public"
+    PRIVATE = "private"
+
+
+class FillKind(str, Enum):
+    """Fill visibility types"""
+    PUBLIC = "public"
+    PRIVATE = "private"
+
+
+class DropZoneMode(str, Enum):
+    """Drop zone fit modes"""
+    CONTAIN = "contain"
+    COVER = "cover"
+    FIT_WIDTH = "fitWidth"
+    FIT_HEIGHT = "fitHeight"
+
+
+class SlideKind(str, Enum):
+    """Slide animation types"""
+    CANVAS = "canvas"
+    LAYER = "layer"
+    PHASE = "phase"
+
+
+class StackDir(str, Enum):
+    """Stack direction"""
+    RIGHT = "right"
+    LEFT = "left"
+    UP = "up"
+    DOWN = "down"
+
+
+class StackAlign(str, Enum):
+    """Stack alignment"""
+    START = "start"
+    CENTER = "center"
+    END = "end"
+
+
+class ClampAxes(str, Enum):
+    """Clamp axes options"""
+    X = "x"
+    Y = "y"
+    BOTH = "both"
+
+
+class AspectMode(str, Enum):
+    """Aspect ratio modes"""
+    CONTAIN = "contain"
+    COVER = "cover"
+    FIT_WIDTH = "fitWidth"
+    FIT_HEIGHT = "fitHeight"
+
+
+class ScaleMode(str, Enum):
+    """Scaling modes for images and layers"""
+    WIDTH = "width"
+    HEIGHT = "height"
+    MIN_SIDE = "minSide"
+    MAX_SIDE = "maxSide"
+    HEIGHT_FROM_WIDTH = "heightFromWidth"
+    WIDTH_FROM_HEIGHT = "widthFromHeight"
+    WIDTH_FROM_MIN_SIDE = "widthFromMinSide"
+    WIDTH_FROM_MAX_SIDE = "widthFromMaxSide"
+    HEIGHT_FROM_MIN_SIDE = "heightFromMinSide"
+    HEIGHT_FROM_MAX_SIDE = "heightFromMaxSide"
+
+
+# =============================================================================
+# DATA LAYER ENUMS - Used by backend microservices
+# =============================================================================
+
+class HTTPMethod(str, Enum):
+    """HTTP method"""
+    GET = "GET"
+    POST = "POST"
+    PUT = "PUT"
+    PATCH = "PATCH"
+    DELETE = "DELETE"
+    OPTIONS = "OPTIONS"
+    HEAD = "HEAD"
+
+
+class ImageMimeType(str, Enum):
+    """Image MIME types supported by ODS"""
+    JPEG = "image/jpeg"
+    PNG = "image/png"
+    GIF = "image/gif"
+    WEBP = "image/webp"
+    SVG = "image/svg+xml"
+
+
+class ReviewStatusEnum(str, Enum):
+    """Review status for workflow execution results"""
+    APPROVED = "APPROVED"
+    PENDING = "PENDING"
+    REJECTED = "REJECTED"
+
+
+class ImageTypeEnum(str, Enum):
+    """Image type classification"""
+    ORIGINAL = "ORIGINAL"
+    WORK_IN_PROGRESS = "WORK_IN_PROGRESS"
+    LEAF = "LEAF"
+    DEBUG = "DEBUG"
+
+
+class BatchTypeEnum(str, Enum):
+    """Workflow batch type"""
+    UPLOAD = "UPLOAD"
+    DOWNLOAD = "DOWNLOAD"
+    SHARED = "SHARED"
+    WORKFLOW_RUN = "WORKFLOW_RUN"
+
+
+class BatchStatusEnum(str, Enum):
+    """Workflow batch status"""
+    QUEUED = "QUEUED"
+    RUNNING = "RUNNING"
+    COMPLETED = "COMPLETED"
+    FAILED = "FAILED"
+
+
+class ExecutionStatusEnum(str, Enum):
+    """Kore execution status"""
+    QUEUED = "QUEUED"
+    RUNNING = "RUNNING"
+    COMPLETED = "COMPLETED"
+    FAILED = "FAILED"
+
+
+class DesignDataInputTypes(str, Enum):
+    """Design data input types"""
+    ASSETS = "assets"
+    LOGOS = "logos"
+    TEXTS = "texts"
+    EXTRA_DATA = "extra_data"
+
+
+class TextType(str, Enum):
+    """Text input type for template specs"""
+    SELECT = "select"
+    NUMBER = "number"
+    STRING = "string"
+
+
+class RequiredFieldType(str, Enum):
+    """Required field types for group specifications"""
+    TEXTS = "texts"
+    ASSETS = "assets"
+    LOGOS = "logos"
+
+class FontMimeType(str, Enum):
+    """Font MIME types supported by ODS"""
+    TTF = "font/ttf"
+    OTF = "font/otf"
+    WOFF = "font/woff"
+    WOFF2 = "font/woff2"
+    EOT = "font/eot"
+    SVG = "font/svg"
+
+
+class CanvasGuideKind(str, Enum):
+    """Canvas guide kind"""
+    BOX = "box"
+    POINT = "point"
+
+
+class CanvasGridKind(str, Enum):
+    """Canvas grid type"""
+    SIMPLE = "simple"
+    BENTO = "bento"
+
+
+class BentoAxis(str, Enum):
+    """Bento grid axis"""
+    ROW = "row"
+    COL = "col"
+
+
+class RenderRunStatus(str, Enum):
+    """Render run status"""
+    PENDING = "pending"
+    QUEUED = "queued"
+    PROCESSING = "processing"
+    COMPLETED = "completed"
+    FAILED = "failed"
+
+
+class RenderRunQueueEventType(str, Enum):
+    """Render run event type"""
+    RENDER = "render"
+    FINISH_RENDER_RUN = "finish_render_run"
+
+
+class TemplateInputJobStatus(str, Enum):
+    """Target input job status"""
+    PENDING = "PENDING"
+    COMPLETED = "COMPLETED"
+    FAILED = "FAILED"
+    IN_PROGRESS = "IN_PROGRESS"
+    SUBMITTED = "SUBMITTED"
+
+
+class ColorType(str, Enum):
+    """Color type classification"""
+    PRIMARY = "primary"
+    SECONDARY = "secondary"
+    TERTIARY = "tertiary"
+    ACCENT = "accent"
+    NEUTRAL = "neutral"
+    BACKGROUND = "background"
+
+
+class BrandRuleType(str, Enum):
+    """Brand rule type"""
+    COLOR = "color"
+    LOGO = "logo"
+    FONT = "font"
+    TYPOGRAPHY = "typography"
+    VISUAL_IDENTITY = "visual_identity"
+
+
+class BrandRuleTarget(str, Enum):
+    """Brand rule target"""
+    LOGO = "logo"
+    COLOR = "color"
+    FONT = "font"
+    TYPOGRAPHY = "typography"
+    VISUAL_IDENTITY = "visual_identity"
+
+
+class DataType(str, Enum):
+    """Data type for entity attributes"""
+    STRING = "string"
+    NUMBER = "number"
+    BOOLEAN = "boolean"
+    DATE = "date"
+    TIME = "time"
+    DATETIME = "datetime"
+    ENUM = "enum"
+
+
+class ODSObjectType(str, Enum):
+    """ODS object type"""
+    #Brand objects
+    BRAND = "brand"
+    BRAND_REGISTRY = "brand_registry"
+
+    #Template objects
+    TEMPLATE_REGISTRY = "template_registry"
+    TEMPLATE_INPUT = "template_input"
+
+    #Pre render objects and render run objects
+    TEMPLATE_INPUT_JOB = "template_input_job"
+    RENDER_RUN = "render_run"
+
+    #OPTIKRON OBJECTS
+    IMAGE = "image"
+    WORKFLOW_EXECUTION_RESULT = "workflow_execution_result"
+    WORKFLOW_BATCH = "workflow_batch"
+    KORE_EXECUTION = "kore_execution"
+    WORKFLOW_BATCH_IMAGE = "workflow_batch"
+    WORKFLOW_REVIEW = "workflow_review"
+
+class WhenToUseLogoEnum(str, Enum):
+    """Logo when to use enum"""
+    ON_WHITE="on_white_full_color"
+    ON_BLACK="on_black_full_color"
+    ON_PRIMARY="on_primary_full_color"
+    ON_SECONDARY="on_secondary_full_color"
+    ON_WHITE_ONE_COLOR="on_white_one_color"
+    ON_BLACK_ONE_COLOR="on_black_one_color"

ods_types_py-0.1.7.dist-info/METADATA

@@ -0,0 +1,95 @@
+Metadata-Version: 2.4
+Name: ods-types-py
+Version: 0.1.7
+Summary: Core types and enums for ODS (Optikka Design System) - Python implementation
+Author-email: Optikka <dev@optikka.com>
+License: PROPRIETARY
+Project-URL: Homepage, https://github.com/optikka/ods
+Project-URL: Repository, https://github.com/optikka/ods
+Keywords: ods,types,enums,renderer,optikka
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Provides-Extra: dev
+Requires-Dist: pytest>=7.4.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.1.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Requires-Dist: mypy>=1.5.0; extra == "dev"
+
+# ods-types-py
+
+Core types and enums for the ODS (Optikka Design System) renderer - Python implementation.
+
+This is the Python equivalent of the `@optikka/ods-types` npm package, providing shared type definitions and enumerations used across ODS rendering services.
+
+## Installation
+
+```bash
+pip install ods-types-py
+```
+
+## Usage
+
+```python
+from ods_types import (
+    Kind,
+    TargetKind,
+    AspectMode,
+    ScaleMode,
+    Box,
+    Target,
+)
+
+# Use enums
+kind = Kind.CANVAS
+aspect = AspectMode.CONTAIN
+
+# Use type definitions
+box: Box = {"x": 0, "y": 0, "w": 100, "h": 100}
+target: Target = {"kind": TargetKind.LAYER, "id": "layer-1"}
+```
+
+## Package Contents
+
+### Enums
+- `Kind` - Canvas or layer types
+- `TargetKind` - Target reference types (canvas, layer, guide, self)
+- `AspectMode` - Aspect ratio modes (contain, cover, fitWidth, fitHeight)
+- `ScaleMode` - Scaling modes for images and layers
+- `AlignX`, `AlignY` - Alignment options
+- `DropZoneMode` - Drop zone fit modes
+- `StackDir`, `StackAlign` - Stack layout options
+- `FadeKind`, `SlideKind` - Animation types
+- `Easing` - Animation easing functions
+- And more...
+
+### Common Types
+- `Box` - Rectangular region with x, y, w, h
+- `Target` - Target reference with kind, id, and layerId
+- `DrawImageParams` - Canvas drawImage parameters
+
+## Development
+
+```bash
+# Install dev dependencies
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Format code
+black src/ tests/
+
+# Lint
+ruff check src/ tests/
+```
+
+## License
+
+PROPRIETARY - Optikka

ods_types_py-0.1.7.dist-info/RECORD

@@ -0,0 +1,7 @@
+ods_types/__init__.py,sha256=ZkUoxgRQeLD-GJFztjJ2pT1LRgppLkMQ2PBE1J-0mTk,2006
+ods_types/common.py,sha256=MvjX3vZU_uR1g0mnQE6JmQRQkjvGlcubC5NRhNjYMiA,1232
+ods_types/enums.py,sha256=fRjF9jj0LrnLLBlVNYXRLXG1Yv6QGrE9Mgj3UdK8OsA,7527
+ods_types_py-0.1.7.dist-info/METADATA,sha256=imRXkgiQGQguKWlHy4lamFay_w1WU1Knz_4V5JbOSwE,2454
+ods_types_py-0.1.7.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+ods_types_py-0.1.7.dist-info/top_level.txt,sha256=wVLpbIj7pGhcfjoOwuBbEOF9eC528qMbG-XnooSerY4,10
+ods_types_py-0.1.7.dist-info/RECORD,,

ods_types_py-0.1.7.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

ods_types_py-0.1.7.dist-info/top_level.txt

@@ -0,0 +1 @@
+ods_types