[Feature Request]: Complete `ATImageProcessable` Implementation

Open
#14 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
swift
Domain
mobile

Research direction

Start by locating the ATImageProcessable protocol and its image handling entry points; the issue names UIImage and NSImage as the intended extensions. Read the existing image query and metadata handling, then determine how the project represents JPEG, PNG, and WEBP images. Done means both platform image types have the requested initializers, the two methods have default implementations, and all three formats are supported.

Written by the indexing model from the issue text.

Description

good first issue new feature
Summary

No response

Pain points

ATImageProcessable is a helper protocol framework that tries to get images down to below the maximum size that the AT Protocol requires. Since The AT Protocol is more than just Bluesky, a framework is needed to make it more generic. This should act as an extension to any image frameworks (examples: UIImage for iOS; NSImage for macOS).

Considered Alternatives

No response

Is this a breaking change?

No

Library Examples

No response

Additional Context

Current goals:

  • Extend UIImage with convenience initializers that clone the applicable base initializers
  • Extend NSImage with convenience initializers that clone the applicable base initializers
  • Ensure the following methods have a default implementation:
    • convertToImageQuery(imagePath: String, altText: String?, targetFileSize: Int) -> ImageQuery?
    • stripMetadata(from image: ATImage) -> ATImage?
  • Support for JPEG images
  • Support for PNG images
  • Support for WEBP images
Dominant language
Swift
Stars
226
Forks
40
Avg merge
2h 56m
Merged PRs (30d)
3

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from MasterJ93/ATProtoKit

All issues in MasterJ93/ATProtoKit

Similar issues

More Swift issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.