Merge pull request #43 from imagekit-developer/sdk-v2-upgrade

Sdk v2 upgrade

Author: imagekitio

.github/workflows/nodejs.yml

@@ -1,6 +1,6 @@
 name: Node CI
 
-on: [push]
+on: [push, pull_request]
 
 jobs:
   build:
@@ -9,7 +9,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [8.x, 10.x, 12.x]
+        node-version: [14.x]
 
     steps:
     - uses: actions/checkout@v1
@@ -22,9 +22,63 @@ jobs:
         npm install -g @angular/[email protected]
         cd sdk
         npm install
-        npm run test
+        npm run test:ci
       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 AUTHENTICATION_ENDPOINT:\"http://localhost:3000/auth\" >> 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
+        AUTHENTICATION_ENDPOINT: 'http://localhost:3000/auth'

.github/workflows/npmpublish.yml

@@ -12,7 +12,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [8.x, 10.x, 12.x]
+        node-version: [14.x]
 
     steps:
     - uses: actions/checkout@v1
@@ -40,7 +40,7 @@ jobs:
     - uses: actions/checkout@v1
     - uses: actions/setup-node@v1
       with:
-        node-version: 12
+        node-version: 14
         registry-url: https://registry.npmjs.org/
     - name: npm publish
       run: |

samples/imagekitio-angular4-sample/.gitignore renamed to .gitignore

@@ -1,6 +1,6 @@
 ## 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.*` before building the package.
+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
 
@@ -12,30 +12,23 @@ npm run build
 
 ## Running test cases
 
-The designated directory for tests is `sdk/src/sdk-tests` folder. All tests will be executed once on the Chrome Headless browser.
+The designated directory for 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
 ```
 
-## Running sample angular app
+## Building custom SDK for sample angular app
+
+Repository to get sample app: https://github.com/imagekit-samples/quickstart
 
-Every sample app requires a different version of Angular CLI. Please refer to the individual sample app `Readme.md` for details.
 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 `samples/imagekitio-angular<x>-sample` 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-0.0.1.tgz`
+4. Go to the Angular sample app's root folder and use `npm install` to install dependencies.
+5. Use `npm install <path to this SDK>/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 <path to this SDK>/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 `samples/imagekitio-angular<x>-sample` folder to run the app for a particular angular version.
-
-## Running sample backend server
-
-Sample server for upload implementation is available at `samples/sample-server`. To run the server, follow these steps
-
-1. Create a `.env` file based on `sample.env` and enter your private key.
-2. Use `npm install` to install dependencies. 
-3. Use `npm run server` to start the server. It will expose the [authentication endpoint](https://docs.imagekit.io/api-reference/upload-file-api/client-side-file-upload#how-to-implement-authenticationendpoint-endpoint) on `http://localhost:3000/auth`
+7. Use npm start from the Angular sample app's root folder to run the app