Add Camera API type definitions #3597
Open
+66
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: Han T. <[email protected]>
fatbattk
force-pushed
the
20644-pos-camera-api
branch
from
4798f27 to
808eb9f
Compare
Contributor
Author
|
/snapit |
Contributor
|
Test the snapshot by updating your "@shopify/ui-extensions": "0.0.0-snapshot-20251126141902" |
vctrchu
reviewed
Nov 28, 2025
| import {StandardApi} from '../standard/standard-api'; | ||
| import {CameraApi} from '../camera-api/camera-api'; | ||
|
|
||
| export type ActionTargetApi<T> = {[key: string]: any} & { |
Contributor
There was a problem hiding this comment.
Maybe I missed it but we only want to allow the camera to be triggered from action targets? Is there a reason why we don't want the api accessible from tiles or blocks?
| */ | ||
| facingMode?: 'user' | 'environment'; | ||
| /** | ||
| * The maximum width (0 to 1080) of the image in pixels. Resizes the image to this width if it is larger. |
Contributor
There was a problem hiding this comment.
Should it be (1 to 1080)
What happens when users put a value of 0?
| */ | ||
| maxWidth?: number; | ||
| /** | ||
| * The maximum height (0 to 1080) of the image in pixels. Resizes the image to this height if it is larger. |
| */ | ||
| maxHeight?: number; | ||
| /** | ||
| * The quality of the image returned. Percentile value between 0 and 1. |
Contributor
There was a problem hiding this comment.
Same here, whats 0 quality do?
| * | ||
| * @param options the options for the camera media. | ||
| * @returns Promise<CameraMediaResponse> that resolves when the POS has necessary permissions to access the camera and the media is captured. | ||
| */ |
Contributor
There was a problem hiding this comment.
Should we be clear on the promise reject reasons? Maybe something like:
* @throws {Error} when camera permission is denied by the user
* @throws {Error} when the user cancels the photo capture
* @throws {Error} when the device has no available camera
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #21032
Background
Add type definitions for Camera API
Checklist