IK-2197 Astro Integration for Imagekit by SwarnimDoegar · Pull Request #1 · imagekit-developer/imagekit-astro

SwarnimDoegar · 2026-04-09T09:21:03Z

No description provided.

Copilot

Pull request overview

Adds an Astro-based monorepo setup for @imagekit/astro, including core components/helpers and a Playwright-driven test app to validate generated ImageKit URLs and rendered markup.

Changes:

Introduces @imagekit/astro package with IKImage, IKVideo, IKAstroImage, IKOgImage, shared config resolution, and a getImagekitUrl helper.
Adds a test-app Astro project with component demo pages and Playwright E2E tests + snapshots.
Adds CI workflows for building, packing, running E2E tests, and publishing on release.

Reviewed changes

Copilot reviewed 38 out of 43 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
pnpm-workspace.yaml	Defines monorepo packages (`imagekit-astro`, `test-app`).
package.json	Adds monorepo scripts for build and E2E.
.npmrc	pnpm hoisting configuration.
.gitignore	Ignores build/test/env artifacts at repo root.
.github/workflows/nodejs.yml	CI build + pack + E2E execution.
.github/workflows/npmpublish.yml	Release publish workflow with pack + E2E gate.
README.md	New top-level SDK documentation and usage examples.
LICENSE	Adds MIT license.
imagekit-astro/package.json	Defines package exports/scripts/deps for `@imagekit/astro`.
imagekit-astro/index.ts	Public package entrypoint exporting components, helper re-exports, and types.
imagekit-astro/tsup.config.ts	tsup build config (helpers bundle + dts).
imagekit-astro/tsconfig.json	TS config for package typing/emit settings.
imagekit-astro/src/env.d.ts	Astro client type references.
imagekit-astro/src/lib/imagekit.ts	Env/prop-based config resolution.
imagekit-astro/src/helpers/getImagekitUrl.ts	Programmatic ImageKit URL builder helper.
imagekit-astro/src/helpers/index.ts	Helper barrel export.
imagekit-astro/src/types/index.ts	Component prop types.
imagekit-astro/src/constants/sizes.ts	OG image default dimensions.
imagekit-astro/src/components/IKImage.astro	Responsive/non-responsive `<img>` wrapper around ImageKit URL generation.
imagekit-astro/src/components/IKVideo.astro	`<video>` wrapper around ImageKit URL generation.
imagekit-astro/src/components/IKAstroImage.astro	Uses `astro:assets` `<Image>` with ImageKit URL/transformation integration.
imagekit-astro/src/components/IKOgImage.astro	Generates OG/Twitter meta tags with ImageKit URLs.
imagekit-astro/helpers/package.json	Helpers subpath package metadata.
imagekit-astro/imagekit-astro-1.0.0.tgz	Packed artifact added to repo.
test-app/package.json	Test app scripts/deps for Astro + Playwright.
test-app/tsconfig.json	Astro strict TS config for test app.
test-app/src/env.d.ts	Astro client type references for test app.
test-app/astro.config.mjs	Astro config (remote image domains).
test-app/src/pages/index.astro	Test app landing page navigation.
test-app/src/pages/images.astro	IKImage demo/test cases.
test-app/src/pages/videos.astro	IKVideo demo/test cases.
test-app/src/pages/astro-images.astro	IKAstroImage demo/test cases.
test-app/playwright.config.ts	Playwright config with web server + snapshot template.
test-app/e2e/images.spec.ts	E2E snapshot test for `/images`.
test-app/e2e/videos.spec.ts	E2E snapshot test for `/videos`.
test-app/e2e/astro-images.spec.ts	E2E assertions for `/astro-images` (attributes + URL behavior).
test-app/e2e/snapshot/*	Stored Playwright snapshots for the E2E tests.
test-app/README.md	Test app usage + covered test cases.
test-app/.gitignore	Ignores test-app build/test artifacts.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

2. Move types to common place 3. Build fixes

Co-authored-by: Copilot <copilot@github.com>

Copilot

Pull request overview

Copilot reviewed 48 out of 54 changed files in this pull request and generated 6 comments.

Files not reviewed (1)

imagekit-astro/package-lock.json: Language not supported

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot <copilot@github.com>

aman-imagekit · 2026-04-28T12:16:03Z

+  height?: number;
+
+  /** Image format override */
+  format?: 'auto' | 'webp' | 'jpg' | 'jpeg' | 'png' | 'gif' | 'svg' | 'mp4' | 'webm' | 'avif' | 'orig';


Either Transformation['format'] (consistency) or a narrower OG-image-only union (correctness for use case not video formats), what do you think?

aman-imagekit · 2026-04-28T12:29:01Z

+type Props = RemoteImageProps & ImageProps;
+
+const {
+  class: className,
+  ...props
+} = Astro.props;


[MINOR] type Props defined above is not used while destructuring.

That is the structure that needs to be followed in .astro files. Astro automatically applies the Props type to Astro.props. Even I felt that it is weird 😅, but that's the standard.

aman-imagekit · 2026-04-28T13:02:02Z

+    width: Math.round(width * scaleFactor),
+    height: Math.round(height * scaleFactor),
+  };
+}


Hardcoding a 25MP clamp in the SDK feels too opinionated, since ImageKit supports >25MP depending on plan.
Can we remove this cap (or make it configurable) if Astro functionality remains unaffected?

Co-authored-by: Copilot <copilot@github.com>

imagekitio · 2026-05-03T07:27:21Z

Few doubts:

Astro.CustomImageProps type declarations missing for transformations (or other Imagekit specific prop)
Why did we implement our responsive strategy given Astro has its own? We can map position, fit, quality to our transformations when generating url. We can ignore format and background. We just have to implement getURL and Astro will call it per width in widths/densities.
Why do we need IKImage, when our service already modifies Astro’s Image component?
In our docs of video player we have integration with React, Vue and that will need Astro too.

imagekitio · 2026-05-03T07:28:43Z

+ * Dynamically imports `inferRemoteSize` from `astro:assets`.
+ * Available since Astro 4.12. Returns `undefined` on older versions.
+ */
+async function tryInferRemoteSize(url: string): Promise<{ width: number; height: number } | undefined> {


This will be called at build time if width is not passed. Correct?

Wouldn't it be better to make width and height mandatory like Astro and ignore inferSize property?

Yes, this is called at build time.
I kept it to keep the interface as close to the astro Image component as possible, to make it more seamless to use as a drop-in replacement for the astro image component.

SwarnimDoegar added 4 commits April 9, 2026 14:48

Astro SDK for Imagekit.io

8b95cad

Merge branch 'main' of https://github.com/imagekit-developer/imagekit…

52ce71e

…-astro into IK-2197

Fix CI issues

9e04959

Update README

443d20c

SwarnimDoegar marked this pull request as draft April 9, 2026 10:51

SwarnimDoegar requested a review from Copilot April 9, 2026 10:51

Copilot started reviewing on behalf of SwarnimDoegar April 9, 2026 10:52 View session

Copilot AI reviewed Apr 9, 2026

View reviewed changes

SwarnimDoegar and others added 20 commits April 13, 2026 00:50

Resolve Copilot review comments

e2be15f

1. Get rid IKImage Component

b79764d

2. Move types to common place 3. Build fixes

Rename components

8b19755

Add external image service for astro imagekit url building

df9df62

Update READMEs

9dce131

Add upload support

331077f

Add upload example in test-app

6a0001b

Add function to scale dimensions for images over 25MP

e359cef

Remove tgz

e0722ab

Minor improvements

8644fd9

Adds more tests

ebd15c7

Get rid of getInt from codebase

cdd07d4

Fix claude comments

866a986

Add test mastix for astro 3 4 5 6

e63ad2f

Co-authored-by: Copilot <copilot@github.com>

Add output type to test-app astro config

e38fd9b

Co-authored-by: Copilot <copilot@github.com>

Do not fail because of upload missing keys in CI

80132cc

Co-authored-by: Copilot <copilot@github.com>

Split dependency installation command into 2

5331616

use output: 'static' as 'hybrid' output is deprecated

10ae05b

Use node 22 for CI

7640946

Remove debug log

0a1bac4

SwarnimDoegar marked this pull request as ready for review April 22, 2026 21:36

SwarnimDoegar requested a review from Copilot April 23, 2026 05:47

Copilot started reviewing on behalf of SwarnimDoegar April 23, 2026 05:47 View session

Copilot AI reviewed Apr 23, 2026

View reviewed changes

SwarnimDoegar and others added 3 commits April 23, 2026 14:48

Resolve copilot comments

1d29fd4

Co-authored-by: Copilot <copilot@github.com>

Fix snapshots

aaf5367

Fix bug with reading env vars

c9c3d18

aman-imagekit reviewed Apr 28, 2026

View reviewed changes

SwarnimDoegar and others added 3 commits April 29, 2026 14:28

Resolve comments

099a8fa

Allow user specific srcset override

01c4c0e

Co-authored-by: Copilot <copilot@github.com>

Fix types

9c11fee

imagekitio requested changes May 3, 2026

View reviewed changes

Add assets loader

9bed163

imagekitio closed this May 5, 2026

Conversation

SwarnimDoegar commented Apr 9, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aman-imagekit Apr 28, 2026

Choose a reason for hiding this comment

Uh oh!

aman-imagekit Apr 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SwarnimDoegar Apr 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aman-imagekit Apr 28, 2026

Choose a reason for hiding this comment

Uh oh!

imagekitio commented May 3, 2026

Uh oh!

imagekitio May 3, 2026

Choose a reason for hiding this comment

Uh oh!

SwarnimDoegar May 4, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

aman-imagekit Apr 28, 2026 •

edited

Loading

SwarnimDoegar Apr 29, 2026 •

edited

Loading