diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml index 9e7f38e3..725e922a 100644 --- a/.github/workflows/codeql.yml +++ b/.github/workflows/codeql.yml @@ -38,4 +38,4 @@ jobs: - name: Perform CodeQL Analysis uses: github/codeql-action/analyze@v2 with: - category: "/language:${{ matrix.language }}" + category: "/language:${{ matrix.language }}" \ No newline at end of file diff --git a/.github/workflows/e2e.yml b/.github/workflows/e2e.yml new file mode 100644 index 00000000..8acf2c76 --- /dev/null +++ b/.github/workflows/e2e.yml @@ -0,0 +1,81 @@ +# This is a test workflow for testing the tests +name: E2E Tests + +on: + push: + branches: ['*'] + pull_request: + branches: ['*'] + +jobs: + playwright-run: + runs-on: ubuntu-latest + strategy: + fail-fast: false + matrix: + project: ['Desktop Chrome'] + + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: Setup Node.js + uses: actions/setup-node@v4 + with: + node-version: '20' + cache: 'npm' + + - name: Install dependencies + run: npm ci + + - name: Build SDK and pack + run: npm run pack + + - name: Verify SDK build + run: | + if [ ! -d "dist/imagekit-angular" ]; then + echo "Error: SDK build directory not found" + exit 1 + fi + echo "✓ SDK built successfully" + + - name: Install test app dependencies + working-directory: ./test-app + run: npm ci + - name: Install SDK + working-directory: ./test-app + run: npm install ../dist/imagekit-angular/imagekit-angular-*.tgz --no-save + # Note: Playwright browsers are installed via postinstall script + + - name: Install browsers for Playwright + working-directory: ./test-app + run: npx playwright install --with-deps + + - name: Run Playwright tests + working-directory: ./test-app + run: npm run test:e2e + + - name: Upload test results on failure + if: failure() + uses: actions/upload-artifact@v4 + with: + name: playwright-results-${{ matrix.project }} + path: test-app/test-results/ + if-no-files-found: ignore + + - name: Upload Playwright report + if: always() + uses: actions/upload-artifact@v4 + with: + name: playwright-report-${{ matrix.project }} + path: test-app/playwright-report/ + retention-days: 30 + if-no-files-found: ignore + + - name: Generate test report + if: always() + run: | + echo "## Test Results - ${{ matrix.project }}" >> $GITHUB_STEP_SUMMARY + echo "Project: ${{ matrix.project }}" >> $GITHUB_STEP_SUMMARY + + diff --git a/.github/workflows/nodejs.yml b/.github/workflows/nodejs.yml deleted file mode 100644 index 80dec65c..00000000 --- a/.github/workflows/nodejs.yml +++ /dev/null @@ -1,88 +0,0 @@ -name: Node CI - -on: [push, pull_request] - -jobs: - build: - - runs-on: ubuntu-latest - - strategy: - matrix: - node-version: [14.x] - - steps: - - uses: actions/checkout@v1 - - name: Use Node.js ${{ matrix.node-version }} - uses: actions/setup-node@v1 - with: - node-version: ${{ matrix.node-version }} - - name: npm install, build, and test - run: | - npm install -g @angular/cli@12.2.18 - cd sdk - npm install - cd tests/test-apps/sample-server - echo PRIVATE_KEY=${{ secrets.ik_private_key }} >> .env; - npm install - npm run server & - cd ../../../ - npm run test:ci - npm run build - env: - CI: true - PUBLIC_KEY: ${{ secrets.ik_public_key }} - PRIVATE_KEY: ${{ secrets.ik_private_key }} - URL_ENDPOINT: ${{ secrets.ik_url_endopint }} - e2e: - runs-on: ubuntu-latest - - strategy: - matrix: - node-version: [14.x] - steps: - - uses: actions/checkout@v3 - - - name: Use Node.js ${{ matrix.node-version }} - uses: actions/setup-node@v1 - with: - node-version: ${{ matrix.node-version }} - - - name: Create e2e environment variables - run: | - cd sdk/src/environments - echo export const environment = { > environment.ts; - echo production: false, >> environment.ts; - echo URL_ENDPOINT:\"https://ik.imagekit.io/sdktestingik\", >> environment.ts; - echo PUBLIC_KEY:\"${{ secrets.ik_public_key }}\", >> environment.ts; - echo '};' >> environment.ts; - less environment.ts - - - name: Start client server - run: | - cd sdk - npm install - npm start & - - name: Start auth server - run: | - cd sdk/tests/test-apps/sample-server - echo PRIVATE_KEY=${{ secrets.ik_private_key }} >> .env; - npm install - npm run server & - env: - CI: true - PUBLIC_KEY: ${{ secrets.ik_public_key }} - PRIVATE_KEY: ${{ secrets.ik_private_key }} - URL_ENDPOINT: https://ik.imagekit.io/sdktestingik - - name: Run E2E tests - uses: cypress-io/github-action@v5 - with: - install: false - wait-on: 'http://localhost:4200' - working-directory: sdk - env: - DEBUG: 'cypress:server:browsers:electron' - CI: true - PUBLIC_KEY: ${{ secrets.ik_public_key }} - PRIVATE_KEY: ${{ secrets.ik_private_key }} - URL_ENDPOINT: https://ik.imagekit.io/sdktestingik \ No newline at end of file diff --git a/.github/workflows/npmpublish.yml b/.github/workflows/npmpublish.yml deleted file mode 100644 index 60ac782c..00000000 --- a/.github/workflows/npmpublish.yml +++ /dev/null @@ -1,61 +0,0 @@ -name: Publish - -on: - release: - types: [published] - - -jobs: - build: - - runs-on: ubuntu-latest - - strategy: - matrix: - node-version: [14.x] - - steps: - - uses: actions/checkout@v1 - - name: Use Node.js ${{ matrix.node-version }} - uses: actions/setup-node@v1 - with: - node-version: ${{ matrix.node-version }} - - name: npm install, build, and test - run: | - npm install -g @angular/cli@12.2.18 - cd sdk - npm install - cd tests/test-apps/sample-server - echo PRIVATE_KEY=${{ secrets.ik_private_key }} >> .env; - npm install - npm run server & - cd ../../../ - npm run test:ci - npm run build - env: - CI: true - PUBLIC_KEY: ${{ secrets.ik_public_key }} - PRIVATE_KEY: ${{ secrets.ik_private_key }} - URL_ENDPOINT: ${{ secrets.ik_url_endopint }} - - publish: - needs: build - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v1 - - uses: actions/setup-node@v1 - with: - node-version: 14 - registry-url: https://registry.npmjs.org/ - - name: npm publish - run: | - npm install -g @angular/cli@12.2.18 - cd sdk - npm install - npm run build - cd dist/imagekitio-angular - npm config set //registry.npmjs.org/:_authToken=$NODE_AUTH_TOKEN - npm publish - env: - NODE_AUTH_TOKEN: ${{secrets.npm_token}} - CI: true diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml new file mode 100644 index 00000000..8d2bf44e --- /dev/null +++ b/.github/workflows/publish.yml @@ -0,0 +1,62 @@ +name: Publish + +on: + release: + types: [published] + +jobs: + build: + runs-on: ubuntu-latest + + strategy: + matrix: + node-version: [20.x] + + steps: + - uses: actions/checkout@v1 + - name: Use Node.js ${{ matrix.node-version }} + uses: actions/setup-node@v1 + with: + node-version: ${{ matrix.node-version }} + - name: Build and Test + run: | + npm install + npm run build + npm pack + cd test-app + npm install + npm install ../dist/imagekit-angular/imagekit-angular-*.tgz --no-save + npx playwright install --with-deps + npm run test:e2e + env: + CI: true + + + publish: + needs: build + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v1 + - uses: actions/setup-node@v1 + with: + node-version: 20 + registry-url: https://registry.npmjs.org/ + - name: NPM Publish + run: | + npm install + npm run build + npm config set //registry.npmjs.org/:_authToken=$NODE_AUTH_TOKEN + # print the NPM user name for validation + npm whoami + VERSION=$(node -p "require('./projects/imagekit-angular/package.json').version" ) + # Only publish stable versions to the latest tag + if [[ "$VERSION" =~ ^[^-]+$ ]]; then + NPM_TAG="latest" + else + NPM_TAG="beta" + fi + echo "Publishing $VERSION with $NPM_TAG tag." + npm publish --tag $NPM_TAG --access public + env: + NODE_AUTH_TOKEN: ${{secrets.npm_token}} + CI: true diff --git a/.gitignore b/.gitignore index 50b88674..d3dc340d 100644 --- a/.gitignore +++ b/.gitignore @@ -1,15 +1,20 @@ # See http://help.github.com/ignore-files/ for more about ignoring files. -# compiled output +# Compiled output /dist /tmp /out-tsc +/bazel-out -# dependencies -node_modules +# Node +/node_modules +/test-app/node_modules + +npm-debug.log +yarn-error.log # IDEs and editors -/.idea +.idea/ .project .classpath .c9/ @@ -17,26 +22,46 @@ node_modules .settings/ *.sublime-workspace -# IDE - VSCode +# Visual Studio Code .vscode/* !.vscode/settings.json !.vscode/tasks.json !.vscode/launch.json !.vscode/extensions.json +.history/* -# misc -/.sass-cache +# Miscellaneous +/.angular/cache +/test-app/.angular/cache +.sass-cache/ /connect.lock /coverage /libpeerconnection.log -npm-debug.log testem.log /typings -# e2e -/e2e/*.js -/e2e/*.map - -# System Files +# System files .DS_Store Thumbs.db + +# Playwright +/test-app/test-results/ +/test-app/playwright-report/ +/test-app/playwright/.cache/ + +# Logs +*.log +logs/ + +# Build artifacts +*.tsbuildinfo +*.map + +# Test coverage +coverage/ +.nyc_output/ + +# Environment files +.env +.env.local +.env.*.local \ No newline at end of file diff --git a/.npmignore b/.npmignore new file mode 100644 index 00000000..e960f461 --- /dev/null +++ b/.npmignore @@ -0,0 +1,34 @@ +# Build source (only distribute built files) +/projects/ +/node_modules/ +/src/ +/test-app/ + +# Config files +angular.json +tsconfig.json +*.md +!README.md +!LICENSE + +# Development files +.git/ +.github/ +*.spec.ts +*.test.ts +/test-app/ + +# IDE +.vscode/ +.idea/ +*.swp +*.swo + +# OS +.DS_Store +Thumbs.db + +# Misc +*.log +npm-debug.log* + diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..cc478cc0 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,3 @@ +## 6.0.0 + +This is a major release that includes breaking changes. Please refer to the [official documentation](https://imagekit.io/docs/integration/angular) for up-to-date usage instructions. diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md deleted file mode 100644 index efc1367b..00000000 --- a/DEVELOPMENT.md +++ /dev/null @@ -1,34 +0,0 @@ -## SDK development - -SDK is build in angular 4 for forward compatibilty and `ng-packagr` is used to create final package. Make sure `@angular/cli` is at `v1.4.*` and node ver `14.x` before building the package. - -## Building package - -Execute following command from the `sdk` folder to build the library. This creates a package in `dist/imagekitio-angular` folder. -```sh -# run `npm install` for first time -npm run build -``` - -## Running test cases - -The designated directory for the tests is `sdk/tests/sdk-tests` folder. All tests will be executed once on the Chrome Headless browser. - -Execute following command from the `sdk` folder to start testing. -```sh -npm run test -``` - -## Building custom SDK for sample angular app - -Repository to get sample app: https://github.com/imagekit-samples/quickstart - -Before sample apps can be used, `imagekitio-angular` library needs to be packed and installed using the file system within the sample apps. Use the following steps to run any sample app. - -1. In the `sdk` folder, install dependencies with `npm install` -2. Build library with `npm run build` -3. In the `sdk/dist/imagekitio-angular` folder, use `npm pack` to create a tarball with version mentioned in the current package.json for sdk. -4. Go to the Angular sample app's root folder and use `npm install` to install dependencies. -5. Use `npm install /sdk/dist/imagekitio-angular/imagekitio-angular-x.x.x.tgz` where x.x.x needs to be replaced with the current version. For example, SDK version is `0.0.1`, then above command becomes `npm install /sdk/dist/imagekitio-angular/imagekitio-angular-2.0.0.tgz` -6. Configure sample app with required keys. Use each app's `Readme.md` for exact details. -7. Use npm start from the Angular sample app's root folder to run the app diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..9567a2a0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2025 Image Kit + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/README.md b/README.md index e7e573a8..a4347387 100644 --- a/README.md +++ b/README.md @@ -2,729 +2,30 @@ # ImageKit.io Angular SDK -[![Node CI](https://github.com/imagekit-developer/imagekit-angular/workflows/Node%20CI/badge.svg)](https://github.com/imagekit-developer/imagekit-angular/) -[![npm version](https://img.shields.io/npm/v/imagekitio-angular)](https://www.npmjs.com/package/imagekitio-angular) -[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) +![Node CI](https://github.com/imagekit-developer/imagekit-angular/workflows/E2E%20Tests/badge.svg) +[![npm version](https://img.shields.io/npm/v/@imagekit/angular)](https://www.npmjs.com/package/@imagekit/angular) +[![License: Apache 2.0](https://img.shields.io/badge/license-Apache%20License%202.0-blue)](https://opensource.org/license/apache-2-0) [![Twitter Follow](https://img.shields.io/twitter/follow/imagekitio?label=Follow&style=social)](https://twitter.com/ImagekitIo) -ImageKit Angular SDK allows you to resize, optimize, deliver, and upload images and videos in your angular application. - -ImageKit is complete media storage, optimization, and transformation solution that comes with an image and video CDN. It can be integrated with your existing infrastructure - storage like AWS S3, web servers, your CDN, and custom domain names, allowing you to deliver optimized images in minutes with minimal code changes. - -## Breaking changes - -### Upgrading from 3.x to 4.x version - -1. Overlay syntax update - -* In version 4.0.0, we've removed the old overlay syntax parameters for transformations, such as `oi`, `ot`, `obg`, and [more](https://docs.imagekit.io/features/image-transformations/overlay). These parameters are deprecated and will start returning errors when used in URLs. Please migrate to the new layers syntax that supports overlay nesting, provides better positional control, and allows more transformations at the layer level. You can start with [examples](https://docs.imagekit.io/features/image-transformations/overlay-using-layers#examples) to learn quickly. -* You can migrate to the new layers syntax using the `raw` transformation parameter. - -### Upgrading from 2.x to 3.x version - -3.x version has breaking changes as listed below. -* In version 3.0.0, we have deprecated the use of the `authenticationEndpoint` parameter. Instead, the SDK now introduces a new parameter named `authenticator`. This parameter expects an asynchronous function that resolves with an object containing the necessary security parameters i.e `signature`, `token`, and `expire`. - -Example implementation for `authenticator` using `Fetch API`. - -``` javascript - -authenticator = async () => { - try { - - // You can pass headers as well and later validate the request source in the backend, or you can use headers for any other use case. - const headers = { - 'Authorization': 'Bearer your-access-token', - 'CustomHeader': 'CustomValue' - }; - - const response = await fetch('server_endpoint', { - headers - }); - - if (!response.ok) { - const errorText = await response.text(); - throw new Error(`Request failed with status ${response.status}: ${errorText}`); - } - - const data = await response.json(); - const { signature, expire, token } = data; - return { signature, expire, token }; - } catch (error) { - throw new Error(`Authentication request failed: ${error.message}`); - } -}; -``` - -*Note*: Avoid generating security parameters on the client side. Always send a request to your backend to retrieve security parameters, as the generation of these parameters necessitates the use of your Imagekit `privateKey`, which must not be included in client-side code. - -## Version Support -| SDK Version | Angular 11.x | Angular 12.2.x | Angular 13.x | Angular 14.x | Angular 15.x | Angular 16.x | Angular 17.x | -|-------------|---------|---------|---------|---------|---------|---------|---------| -| 5.x | ❌ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |✔️ | -| 4.x | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ❌ | ❌ | +## Introduction +ImageKit Angular SDK provides a simple way to integrate ImageKit.io with your Angular applications. It allows you to easily: +- Render images and video with automatic optimization and responsive sizes. +- Apply transformations to images and videos using URL parameters. +- Apply powerful AI-powered image transformations e.g. background removal, generative fill, object cropping, and more. ## Installation -```shell -npm install --save imagekitio-angular -``` - -or - -```shell -yarn add imagekitio-angular -``` - -## Support - -For any feedback or to report any issues or general implementation support, please reach out to [support@imagekit.io](mailto:support@imagekit.io) - -Please note that this SDK version supports `Angular version 9 and onwards`. For older Angular versions, use v1.x.x. -## Usage - -### Initialization - -To use the SDK, you need to provide it with a few configuration parameters. The configuration parameters must be passed to the `ImagekitioAngularModule` module in your `app.module.ts` file. example: - -```js -@NgModule({ - declarations: [ - AppComponent - ], - imports: [ - BrowserModule, - AppRoutingModule, - ImagekitioAngularModule.forRoot({ - publicKey: environment.publicKey, - urlEndpoint: environment.urlEndpoint, - }) - ], - providers: [], - bootstrap: [AppComponent] -}) -``` - -* `urlEndpoint` is required to use the SDK. You can get URL-endpoint from your ImageKit dashboard - https://imagekit.io/dashboard/url-endpoints. -* `publicKey` and `authenticator` parameters are required if you want to use the SDK for client-side file upload. You can get `publicKey` from the developer section in your ImageKit dashboard - https://imagekit.io/dashboard/developer/api-keys. -* `transformationPosition` is optional. The default value for the parameter is `path`. Acceptable values are `path` & `query` - -> Note: Do not include your [private key](https://docs.imagekit.io/api-reference/api-introduction/api-keys#private-key) in any client-side code. - -### Quick examples - -```js -// Render an image using a relative path - https://ik.imagekit.io/your_imagekit_id/default-image.jpg - - -// Overriding URL endpoint - https://www.custom-domain.com/default-image.jpg - - -// Render an image using an absolute URL and basic transformations- https://www1.custom-domain.com/default-image.jpg?tr=w-100,h-300 - - -// Height and width manipulation - https://ik.imagekit.io/your_imagekit_id/tr:h-200,w-200/default-image.jpg - - -// Chained transformation - https://ik.imagekit.io/your_imagekit_id/tr:h-200,w-200:rt-90/default-image.jpg - - -// Lazy loading - - -/* - Low-quality image placeholder - Will first load https://ik.imagekit.io/your_imagekit_id/tr:h-200,w-200:q-20,bl-6/default-image.jpg, while the original image, i.e., https://ik.imagekit.io/your_imagekit_id/tr:h-200,w-200/default-image.jpg is being loaded in the background. -*/ - - -// Low-quality image placeholder and lazy loading of original image in the background - - -// Video element with basic transformation, reduced quality by 50% using q:50 - - -// File upload with optional custom event handling -// See section "ik-upload" in README for more info - -``` - -## Demo application - -* The official step-by-step Angular quick start guide - https://docs.imagekit.io/getting-started/quickstart-guides/angular - -## Components - -The library includes three components: - -* [ik-image](#ik-image) for image resizing. This renders a `` tag. -* [ik-video](#ik-video) for video resizing. This renders a `