Skip to content

Commit 1d33db8

Browse files
feat(api): Introduce lxc, lyc, lap parameters in overlays.
1 parent c05145e commit 1d33db8

4 files changed

Lines changed: 277 additions & 30 deletions

File tree

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 48
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-83a7f3659a437113f2a79e1e72794be19eff00ec232fd0206198c80364ccfebf.yml
3-
openapi_spec_hash: b327552548ab641eb4ea3b45e643dfce
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-63aff1629530786015da3c86131afa8a9b60545d488884b77641f1d4b89c6e9d.yml
3+
openapi_spec_hash: 586d357bd7e5217d240a99e0d83c6d1f
44
config_hash: 47cb702ee2cb52c58d803ae39ade9b44

aliases.go

Lines changed: 55 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -370,8 +370,43 @@ type OverlayUnionParam = shared.OverlayUnionParam
370370
// This is an alias to an internal type.
371371
type OverlayPositionParam = shared.OverlayPositionParam
372372

373-
// Specifies the position of the overlay relative to the parent image or video.
374-
// Maps to `lfo` in the URL.
373+
// Sets the anchor point on the base asset from which the overlay offset is
374+
// calculated. The default value is `top_left`. Maps to `lap` in the URL. Can only
375+
// be used with one or more of `x`, `y`, `xCenter`, or `yCenter`.
376+
//
377+
// This is an alias to an internal type.
378+
type OverlayPositionAnchorPoint = shared.OverlayPositionAnchorPoint
379+
380+
// Equals "top"
381+
const OverlayPositionAnchorPointTop = shared.OverlayPositionAnchorPointTop
382+
383+
// Equals "left"
384+
const OverlayPositionAnchorPointLeft = shared.OverlayPositionAnchorPointLeft
385+
386+
// Equals "right"
387+
const OverlayPositionAnchorPointRight = shared.OverlayPositionAnchorPointRight
388+
389+
// Equals "bottom"
390+
const OverlayPositionAnchorPointBottom = shared.OverlayPositionAnchorPointBottom
391+
392+
// Equals "top_left"
393+
const OverlayPositionAnchorPointTopLeft = shared.OverlayPositionAnchorPointTopLeft
394+
395+
// Equals "top_right"
396+
const OverlayPositionAnchorPointTopRight = shared.OverlayPositionAnchorPointTopRight
397+
398+
// Equals "bottom_left"
399+
const OverlayPositionAnchorPointBottomLeft = shared.OverlayPositionAnchorPointBottomLeft
400+
401+
// Equals "bottom_right"
402+
const OverlayPositionAnchorPointBottomRight = shared.OverlayPositionAnchorPointBottomRight
403+
404+
// Equals "center"
405+
const OverlayPositionAnchorPointCenter = shared.OverlayPositionAnchorPointCenter
406+
407+
// Specifies the position of the overlay relative to the parent image or video. If
408+
// one or more of `x`, `y`, `xCenter`, or `yCenter` parameters are specified, this
409+
// parameter is ignored. Maps to `lfo` in the URL.
375410
//
376411
// This is an alias to an internal type.
377412
type OverlayPositionFocus = shared.OverlayPositionFocus
@@ -412,6 +447,15 @@ const OverlayPositionFocusBottomRight = shared.OverlayPositionFocusBottomRight
412447
// This is an alias to an internal type.
413448
type OverlayPositionXUnionParam = shared.OverlayPositionXUnionParam
414449

450+
// Specifies the x-coordinate on the base asset where the overlay's center will be
451+
// positioned. It also accepts arithmetic expressions such as `bw_mul_0.4` or
452+
// `bw_sub_cw`. Maps to `lxc` in the URL. Cannot be used together with `x`, but can
453+
// be used with `y`. Learn about
454+
// [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
455+
//
456+
// This is an alias to an internal type.
457+
type OverlayPositionXCenterUnionParam = shared.OverlayPositionXCenterUnionParam
458+
415459
// Specifies the y-coordinate of the top-left corner of the base asset where the
416460
// overlay's top-left corner will be positioned. It also accepts arithmetic
417461
// expressions such as `bh_mul_0.4` or `bh_sub_ch`. Maps to `ly` in the URL. Learn
@@ -421,6 +465,15 @@ type OverlayPositionXUnionParam = shared.OverlayPositionXUnionParam
421465
// This is an alias to an internal type.
422466
type OverlayPositionYUnionParam = shared.OverlayPositionYUnionParam
423467

468+
// Specifies the y-coordinate on the base asset where the overlay's center will be
469+
// positioned. It also accepts arithmetic expressions such as `bh_mul_0.4` or
470+
// `bh_sub_ch`. Maps to `lyc` in the URL. Cannot be used together with `y`, but can
471+
// be used with `x`. Learn about
472+
// [Arithmetic expressions](https://imagekit.io/docs/arithmetic-expressions-in-transformations).
473+
//
474+
// This is an alias to an internal type.
475+
type OverlayPositionYCenterUnionParam = shared.OverlayPositionYCenterUnionParam
476+
424477
// This is an alias to an internal type.
425478
type OverlayTimingParam = shared.OverlayTimingParam
426479

dummy_test.go

Lines changed: 104 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,20 @@ func TestDummyNewWithOptionalParams(t *testing.T) {
3333
BaseOverlay: shared.BaseOverlayParam{
3434
LayerMode: shared.BaseOverlayLayerModeMultiply,
3535
Position: shared.OverlayPositionParam{
36-
Focus: shared.OverlayPositionFocusCenter,
36+
AnchorPoint: shared.OverlayPositionAnchorPointTop,
37+
Focus: shared.OverlayPositionFocusCenter,
3738
X: shared.OverlayPositionXUnionParam{
3839
OfFloat: imagekit.Float(0),
3940
},
41+
XCenter: shared.OverlayPositionXCenterUnionParam{
42+
OfFloat: imagekit.Float(0),
43+
},
4044
Y: shared.OverlayPositionYUnionParam{
4145
OfFloat: imagekit.Float(0),
4246
},
47+
YCenter: shared.OverlayPositionYCenterUnionParam{
48+
OfFloat: imagekit.Float(0),
49+
},
4350
},
4451
Timing: shared.OverlayTimingParam{
4552
Duration: shared.OverlayTimingDurationUnionParam{
@@ -200,13 +207,20 @@ func TestDummyNewWithOptionalParams(t *testing.T) {
200207
BaseOverlayParam: shared.BaseOverlayParam{
201208
LayerMode: shared.BaseOverlayLayerModeMultiply,
202209
Position: shared.OverlayPositionParam{
203-
Focus: shared.OverlayPositionFocusCenter,
210+
AnchorPoint: shared.OverlayPositionAnchorPointTop,
211+
Focus: shared.OverlayPositionFocusCenter,
204212
X: shared.OverlayPositionXUnionParam{
205213
OfFloat: imagekit.Float(0),
206214
},
215+
XCenter: shared.OverlayPositionXCenterUnionParam{
216+
OfFloat: imagekit.Float(0),
217+
},
207218
Y: shared.OverlayPositionYUnionParam{
208219
OfFloat: imagekit.Float(0),
209220
},
221+
YCenter: shared.OverlayPositionYCenterUnionParam{
222+
OfFloat: imagekit.Float(0),
223+
},
210224
},
211225
Timing: shared.OverlayTimingParam{
212226
Duration: shared.OverlayTimingDurationUnionParam{
@@ -308,13 +322,20 @@ func TestDummyNewWithOptionalParams(t *testing.T) {
308322
BaseOverlayParam: shared.BaseOverlayParam{
309323
LayerMode: shared.BaseOverlayLayerModeMultiply,
310324
Position: shared.OverlayPositionParam{
311-
Focus: shared.OverlayPositionFocusCenter,
325+
AnchorPoint: shared.OverlayPositionAnchorPointTop,
326+
Focus: shared.OverlayPositionFocusCenter,
312327
X: shared.OverlayPositionXUnionParam{
313328
OfFloat: imagekit.Float(0),
314329
},
330+
XCenter: shared.OverlayPositionXCenterUnionParam{
331+
OfFloat: imagekit.Float(0),
332+
},
315333
Y: shared.OverlayPositionYUnionParam{
316334
OfFloat: imagekit.Float(0),
317335
},
336+
YCenter: shared.OverlayPositionYCenterUnionParam{
337+
OfFloat: imagekit.Float(0),
338+
},
318339
},
319340
Timing: shared.OverlayTimingParam{
320341
Duration: shared.OverlayTimingDurationUnionParam{
@@ -382,13 +403,20 @@ func TestDummyNewWithOptionalParams(t *testing.T) {
382403
BaseOverlayParam: shared.BaseOverlayParam{
383404
LayerMode: shared.BaseOverlayLayerModeMultiply,
384405
Position: shared.OverlayPositionParam{
385-
Focus: shared.OverlayPositionFocusCenter,
406+
AnchorPoint: shared.OverlayPositionAnchorPointTop,
407+
Focus: shared.OverlayPositionFocusCenter,
386408
X: shared.OverlayPositionXUnionParam{
387409
OfFloat: imagekit.Float(0),
388410
},
411+
XCenter: shared.OverlayPositionXCenterUnionParam{
412+
OfFloat: imagekit.Float(0),
413+
},
389414
Y: shared.OverlayPositionYUnionParam{
390415
OfFloat: imagekit.Float(0),
391416
},
417+
YCenter: shared.OverlayPositionYCenterUnionParam{
418+
OfFloat: imagekit.Float(0),
419+
},
392420
},
393421
Timing: shared.OverlayTimingParam{
394422
Duration: shared.OverlayTimingDurationUnionParam{
@@ -485,13 +513,20 @@ func TestDummyNewWithOptionalParams(t *testing.T) {
485513
BaseOverlayParam: shared.BaseOverlayParam{
486514
LayerMode: shared.BaseOverlayLayerModeMultiply,
487515
Position: shared.OverlayPositionParam{
488-
Focus: shared.OverlayPositionFocusCenter,
516+
AnchorPoint: shared.OverlayPositionAnchorPointTop,
517+
Focus: shared.OverlayPositionFocusCenter,
489518
X: shared.OverlayPositionXUnionParam{
490519
OfFloat: imagekit.Float(0),
491520
},
521+
XCenter: shared.OverlayPositionXCenterUnionParam{
522+
OfFloat: imagekit.Float(0),
523+
},
492524
Y: shared.OverlayPositionYUnionParam{
493525
OfFloat: imagekit.Float(0),
494526
},
527+
YCenter: shared.OverlayPositionYCenterUnionParam{
528+
OfFloat: imagekit.Float(0),
529+
},
495530
},
496531
Timing: shared.OverlayTimingParam{
497532
Duration: shared.OverlayTimingDurationUnionParam{
@@ -537,13 +572,20 @@ func TestDummyNewWithOptionalParams(t *testing.T) {
537572
},
538573
},
539574
OverlayPosition: shared.OverlayPositionParam{
540-
Focus: shared.OverlayPositionFocusCenter,
575+
AnchorPoint: shared.OverlayPositionAnchorPointTop,
576+
Focus: shared.OverlayPositionFocusCenter,
541577
X: shared.OverlayPositionXUnionParam{
542578
OfFloat: imagekit.Float(0),
543579
},
580+
XCenter: shared.OverlayPositionXCenterUnionParam{
581+
OfFloat: imagekit.Float(0),
582+
},
544583
Y: shared.OverlayPositionYUnionParam{
545584
OfFloat: imagekit.Float(0),
546585
},
586+
YCenter: shared.OverlayPositionYCenterUnionParam{
587+
OfFloat: imagekit.Float(0),
588+
},
547589
},
548590
OverlayTiming: shared.OverlayTimingParam{
549591
Duration: shared.OverlayTimingDurationUnionParam{
@@ -583,13 +625,20 @@ func TestDummyNewWithOptionalParams(t *testing.T) {
583625
BaseOverlayParam: shared.BaseOverlayParam{
584626
LayerMode: shared.BaseOverlayLayerModeMultiply,
585627
Position: shared.OverlayPositionParam{
586-
Focus: shared.OverlayPositionFocusCenter,
628+
AnchorPoint: shared.OverlayPositionAnchorPointTop,
629+
Focus: shared.OverlayPositionFocusCenter,
587630
X: shared.OverlayPositionXUnionParam{
588631
OfFloat: imagekit.Float(0),
589632
},
633+
XCenter: shared.OverlayPositionXCenterUnionParam{
634+
OfFloat: imagekit.Float(0),
635+
},
590636
Y: shared.OverlayPositionYUnionParam{
591637
OfFloat: imagekit.Float(0),
592638
},
639+
YCenter: shared.OverlayPositionYCenterUnionParam{
640+
OfFloat: imagekit.Float(0),
641+
},
593642
},
594643
Timing: shared.OverlayTimingParam{
595644
Duration: shared.OverlayTimingDurationUnionParam{
@@ -697,13 +746,20 @@ func TestDummyNewWithOptionalParams(t *testing.T) {
697746
BaseOverlayParam: shared.BaseOverlayParam{
698747
LayerMode: shared.BaseOverlayLayerModeMultiply,
699748
Position: shared.OverlayPositionParam{
700-
Focus: shared.OverlayPositionFocusCenter,
749+
AnchorPoint: shared.OverlayPositionAnchorPointTop,
750+
Focus: shared.OverlayPositionFocusCenter,
701751
X: shared.OverlayPositionXUnionParam{
702752
OfFloat: imagekit.Float(0),
703753
},
754+
XCenter: shared.OverlayPositionXCenterUnionParam{
755+
OfFloat: imagekit.Float(0),
756+
},
704757
Y: shared.OverlayPositionYUnionParam{
705758
OfFloat: imagekit.Float(0),
706759
},
760+
YCenter: shared.OverlayPositionYCenterUnionParam{
761+
OfFloat: imagekit.Float(0),
762+
},
707763
},
708764
Timing: shared.OverlayTimingParam{
709765
Duration: shared.OverlayTimingDurationUnionParam{
@@ -801,13 +857,20 @@ func TestDummyNewWithOptionalParams(t *testing.T) {
801857
BaseOverlayParam: shared.BaseOverlayParam{
802858
LayerMode: shared.BaseOverlayLayerModeMultiply,
803859
Position: shared.OverlayPositionParam{
804-
Focus: shared.OverlayPositionFocusCenter,
860+
AnchorPoint: shared.OverlayPositionAnchorPointTop,
861+
Focus: shared.OverlayPositionFocusCenter,
805862
X: shared.OverlayPositionXUnionParam{
806863
OfFloat: imagekit.Float(0),
807864
},
865+
XCenter: shared.OverlayPositionXCenterUnionParam{
866+
OfFloat: imagekit.Float(0),
867+
},
808868
Y: shared.OverlayPositionYUnionParam{
809869
OfFloat: imagekit.Float(0),
810870
},
871+
YCenter: shared.OverlayPositionYCenterUnionParam{
872+
OfFloat: imagekit.Float(0),
873+
},
811874
},
812875
Timing: shared.OverlayTimingParam{
813876
Duration: shared.OverlayTimingDurationUnionParam{
@@ -846,13 +909,20 @@ func TestDummyNewWithOptionalParams(t *testing.T) {
846909
BaseOverlayParam: shared.BaseOverlayParam{
847910
LayerMode: shared.BaseOverlayLayerModeMultiply,
848911
Position: shared.OverlayPositionParam{
849-
Focus: shared.OverlayPositionFocusCenter,
912+
AnchorPoint: shared.OverlayPositionAnchorPointTop,
913+
Focus: shared.OverlayPositionFocusCenter,
850914
X: shared.OverlayPositionXUnionParam{
851915
OfFloat: imagekit.Float(0),
852916
},
917+
XCenter: shared.OverlayPositionXCenterUnionParam{
918+
OfFloat: imagekit.Float(0),
919+
},
853920
Y: shared.OverlayPositionYUnionParam{
854921
OfFloat: imagekit.Float(0),
855922
},
923+
YCenter: shared.OverlayPositionYCenterUnionParam{
924+
OfFloat: imagekit.Float(0),
925+
},
856926
},
857927
Timing: shared.OverlayTimingParam{
858928
Duration: shared.OverlayTimingDurationUnionParam{
@@ -975,13 +1045,20 @@ func TestDummyNewWithOptionalParams(t *testing.T) {
9751045
BaseOverlayParam: shared.BaseOverlayParam{
9761046
LayerMode: shared.BaseOverlayLayerModeMultiply,
9771047
Position: shared.OverlayPositionParam{
978-
Focus: shared.OverlayPositionFocusCenter,
1048+
AnchorPoint: shared.OverlayPositionAnchorPointTop,
1049+
Focus: shared.OverlayPositionFocusCenter,
9791050
X: shared.OverlayPositionXUnionParam{
9801051
OfFloat: imagekit.Float(0),
9811052
},
1053+
XCenter: shared.OverlayPositionXCenterUnionParam{
1054+
OfFloat: imagekit.Float(0),
1055+
},
9821056
Y: shared.OverlayPositionYUnionParam{
9831057
OfFloat: imagekit.Float(0),
9841058
},
1059+
YCenter: shared.OverlayPositionYCenterUnionParam{
1060+
OfFloat: imagekit.Float(0),
1061+
},
9851062
},
9861063
Timing: shared.OverlayTimingParam{
9871064
Duration: shared.OverlayTimingDurationUnionParam{
@@ -1077,13 +1154,20 @@ func TestDummyNewWithOptionalParams(t *testing.T) {
10771154
BaseOverlayParam: shared.BaseOverlayParam{
10781155
LayerMode: shared.BaseOverlayLayerModeMultiply,
10791156
Position: shared.OverlayPositionParam{
1080-
Focus: shared.OverlayPositionFocusCenter,
1157+
AnchorPoint: shared.OverlayPositionAnchorPointTop,
1158+
Focus: shared.OverlayPositionFocusCenter,
10811159
X: shared.OverlayPositionXUnionParam{
10821160
OfFloat: imagekit.Float(0),
10831161
},
1162+
XCenter: shared.OverlayPositionXCenterUnionParam{
1163+
OfFloat: imagekit.Float(0),
1164+
},
10841165
Y: shared.OverlayPositionYUnionParam{
10851166
OfFloat: imagekit.Float(0),
10861167
},
1168+
YCenter: shared.OverlayPositionYCenterUnionParam{
1169+
OfFloat: imagekit.Float(0),
1170+
},
10871171
},
10881172
Timing: shared.OverlayTimingParam{
10891173
Duration: shared.OverlayTimingDurationUnionParam{
@@ -1151,13 +1235,20 @@ func TestDummyNewWithOptionalParams(t *testing.T) {
11511235
BaseOverlayParam: shared.BaseOverlayParam{
11521236
LayerMode: shared.BaseOverlayLayerModeMultiply,
11531237
Position: shared.OverlayPositionParam{
1154-
Focus: shared.OverlayPositionFocusCenter,
1238+
AnchorPoint: shared.OverlayPositionAnchorPointTop,
1239+
Focus: shared.OverlayPositionFocusCenter,
11551240
X: shared.OverlayPositionXUnionParam{
11561241
OfFloat: imagekit.Float(0),
11571242
},
1243+
XCenter: shared.OverlayPositionXCenterUnionParam{
1244+
OfFloat: imagekit.Float(0),
1245+
},
11581246
Y: shared.OverlayPositionYUnionParam{
11591247
OfFloat: imagekit.Float(0),
11601248
},
1249+
YCenter: shared.OverlayPositionYCenterUnionParam{
1250+
OfFloat: imagekit.Float(0),
1251+
},
11611252
},
11621253
Timing: shared.OverlayTimingParam{
11631254
Duration: shared.OverlayTimingDurationUnionParam{

0 commit comments

Comments
 (0)