Migrate from upload-js to @bytescale/sdk

Author: ljwagerfield

lib/.browserslistrc renamed to .browserslistrc

@@ -11,118 +11,55 @@ defaults:
     shell: bash
 
 jobs:
-  build:
-    runs-on: ubuntu-22.04
-
+  ci:
+    name: "Continuous Integration"
+    runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-
+      - name: "Checkout code"
+        uses: actions/checkout@v3
       - name: "Install node & npm"
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
-          node-version: 18.x
-
-      - name: "Install repository dependencies"
+          node-version: 16
+      - name: "Install dependencies"
         run: npm ci
-
-      - name: "Upload.js (npm install)"
-        run: npm ci
-        working-directory: ./lib
-
-      - name: "Upload.js (npm pack)"
-        run: npm pack
-        working-directory: ./lib
-        env:
-          NODE_OPTIONS: --openssl-legacy-provider
-
-      - name: "Acceptance tests (npm install)"
-        run:
-          # We use 'install' rather than 'ci' due to lack of 'packages-lock.json' in this specific
-          # project: we don't use 'packages-lock.json' because this project has a local dependency on
-          # 'upload-js' via tarball, which is rarely rebuilt on the developers machine, making the
-          # 'package-lock.json' often stale, causing 'npm ci' to fail. We don't mind using 'npm install'
-          # and missing out on the hash-checks, as we don't actually publish this package, so security
-          # isn't as much of a concern.
-          npm install
-        working-directory: ./examples
-
       - name: "Type checks"
         run: npm run typecheck
-
       - name: "Linting"
         run: npm run lint
-
-      - name: "Acceptance tests (start web server)"
-        run:
-          # Run in 'dist' mode to ensure the packaged 'uploadjs' NPM module is used,
-          # rather than loading 'upload-js' from source (for a better end-to-end test).
-          npm run start:dist &
-        working-directory: ./examples
-        env:
-          NODE_OPTIONS: --openssl-legacy-provider
-
-      - name: "Documentation (npm install)"
-        run: npm ci
-        working-directory: ./docs
-
-      - name: "Verify POLYFILLS.md up-to-date"
-        run: |
-          npm run generate-polyfills-md
-          changes=$(git --no-pager diff -- ../POLYFILLS.md)
-          if [[ ! -z "$changes" ]]; then
-            echo "Changes to POLYFILLS.md:"
-            echo ""
-            echo $changes
-            echo ""
-            echo "POLYFILLS.md needs updating!"
-            echo ""
-            echo "Please run the following command:"
-            echo ""
-            echo "  (cd docs && npm run generate-polyfills-md)"
-            echo ""
-            exit 1
-          fi
-        working-directory: ./docs
-        env:
-          NODE_OPTIONS: --openssl-legacy-provider
-
-      # Note: we put other steps between the 'npm start' and the test runs, just to make time for the server to spin-up.
-      - name: "Acceptance tests"
+      - name: "Tests"
         run: npm test
-        working-directory: ./lib
-
+        env:
+          BYTESCALE_ACCOUNT_ID: ${{ secrets.BYTESCALE_ACCOUNT_ID }}
+          BYTESCALE_SECRET_API_KEY: ${{ secrets.BYTESCALE_SECRET_API_KEY }}
       - name: "Publish"
         if: github.ref == 'refs/heads/main'
         env:
           AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
           AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
           AWS_EC2_METADATA_DISABLED: true
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Automatically generated by GitHub / is not in our secrets.
-          NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
-          NODE_OPTIONS: --openssl-legacy-provider
-        working-directory: ./lib
+          NPM_AUTH_TOKEN: ${{ secrets.BYTESCALE_NPM_AUTH_TOKEN }}
         run: |
           npm set //registry.npmjs.org/:_authToken=${NPM_AUTH_TOKEN}
           npm run publish:executeIfReleaseCommit
-
       - name: "Notification on success"
         if: github.ref == 'refs/heads/main'
         uses: rtCamp/action-slack-notify@v2
         env:
           SLACK_CHANNEL: deployments
           SLACK_COLOR: "#17BB5E"
-          SLACK_TITLE: "Built: upload-js :rocket:"
+          SLACK_TITLE: "Built: bytescale-javascript-sdk :rocket:"
           SLACK_FOOTER: "This package was successfully built."
           MSG_MINIMAL: true
           SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
-
       - name: "Notification on failure"
         if: github.ref == 'refs/heads/main' && failure()
         uses: rtCamp/action-slack-notify@v2
         env:
           SLACK_CHANNEL: deployments
           SLACK_COLOR: "#BB1717"
-          SLACK_TITLE: "Failed: upload-js :boom:"
+          SLACK_TITLE: "Failed: bytescale-javascript-sdk :boom:"
           SLACK_FOOTER: "No packages published."
           MSG_MINIMAL: true
           SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}

lib/.eslintrc.yaml renamed to .eslintrc.yaml

@@ -23,12 +23,20 @@ $RECYCLE.BIN/
 
 # Node.js
 node_modules/
+peer_modules/
 npm-debug.log*
 
 # NPM Packages
 *.tgz
 dist/
 
+# Serverless directories
+.serverless
+
+# Webpack directories
+.webpack
+
 # Standard
 tmp/
+.tmp/
 *.log

.github/assets/bytescale-javascript-sdk.png

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Bytescale Ltd
+Copyright (c) 2020 Upload Ltd
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

.github/assets/bytescale-javascript-sdk.svg

@@ -0,0 +1,102 @@
+# Migration Guide
+
+## From Upload.js (`upload-js`)
+
+Steps:
+
+1. Install `@bytescale/sdk`
+2. Uninstall `upload-js`
+3. Replace `"upload-js"` with `"@bytescale/sdk"` in your `import` statements
+4. Replace `Upload({ apiKey })` with `new UploadManager({ apiKey })`
+5. Replace `.uploadFile(file, options)` with `.upload({ data: file, ...options })`
+
+### Before
+
+```javascript
+import { Upload } from "upload-js";
+
+const upload = Upload({ apiKey: "free" });
+
+//
+// Uploading files...
+//
+const { fileUrl } = await upload.uploadFile(file, {
+  onBegin: ({ cancel }) => {
+    /* Optional. To cancel, you would call 'cancel()' */
+  },
+  ...additionalParams
+});
+
+//
+// Making URLs....
+//
+upload.url("/my-uploaded-image.jpg", "thumbnail");
+
+//
+// JWT authorization...
+//
+await upload.beginAuthSession("https://my-auth-url", async () => ({ Authorization: "Bearer AuthTokenForMyApi" }));
+```
+
+### After
+
+```javascript
+import { AuthManager, UrlBuilder, UploadManager } from "@bytescale/sdk";
+
+//
+// Uploading files...
+//
+const uploadManager = new UploadManager({
+  fetchApi: nodeFetch, // import nodeFetch from "node-fetch"; // Only required for Node.js. TypeScript: 'nodeFetch as any' may be necessary.
+  apiKey: "free" // Get API keys from: www.bytescale.com
+});
+const cancellationToken = {
+  isCancelled: false // Set to 'true' at any point to cancel the upload.
+};
+const { fileUrl } = await uploadManager.upload({
+  data: file,
+  cancellationToken, // optional
+  ...additionalParams
+});
+
+//
+// Making URLs...
+//
+UrlBuilder.url({
+  accountId,
+  filePath: "/my-uploaded-image.jpg",
+  options: {
+    transformation: "preset",
+    transformationPreset: "thumbnail"
+  }
+});
+
+//
+// JWT authorization...
+//
+await AuthManager.beginAuthSession({
+  accountId,
+  authUrl: "https://my-auth-url",
+  authHeaders: async () => ({ Authorization: "Bearer AuthTokenForMyApi" })
+});
+```
+
+## From Upload JavaScript SDK (`upload-js-full`)
+
+Steps:
+
+1. Install `@bytescale/sdk`
+2. Uninstall `upload-js-full`
+3. Replace `"upload-js-full"` with `"@bytescale/sdk"` in your `import` statements
+4. Remove `accountId` from `uploadManager.upload({...options...})` (it's no-longer required).
+
+## See also
+
+Bytescale migration guides listed below:
+
+- [Migrating from `upload-js` to `@bytescale/sdk`](https://github.com/bytescale/bytescale-javascript-sdk/blob/main/MIGRATE.md)
+- [Migrating from `uploader` to `@bytescale/upload-widget`](https://github.com/bytescale/bytescale-upload-widget/blob/main/MIGRATE.md)
+- [Migrating from `react-uploader` to `@bytescale/upload-widget-react`](https://github.com/bytescale/bytescale-upload-widget-react/blob/main/MIGRATE.md)
+- [Migrating from `angular-uploader` to `@bytescale/upload-widget-angular`](https://github.com/bytescale/bytescale-upload-widget-angular/blob/main/MIGRATE.md)
+- [Migrating from `@upload-io/vue-uploader` to `@bytescale/upload-widget-vue`](https://github.com/bytescale/bytescale-upload-widget-vue/blob/main/MIGRATE.md)
+- [Migrating from `@upload-io/jquery-uploader` to `@bytescale/upload-widget-jquery`](https://github.com/bytescale/bytescale-upload-widget-jquery/blob/main/MIGRATE.md)