[major] migrate to typescript, add default and max expiration (SharzyL#58)

Author: SharzyL

.github/workflows/deploy.yml

@@ -1,8 +1,9 @@
-name: Deploy
+name: Test and Deploy
 on:
   push:
     branches:
       - goshujin
+      - dev
 
 jobs:
   deploy:
@@ -13,16 +14,19 @@ jobs:
       - name: "Install Node"
         uses: actions/setup-node@v4
         with:
-          node-version: "20"
+          node-version: "22"
           cache: "yarn"
 
       - name: "Setup"
         run: yarn install
 
       - name: "Test"
-        run: yarn test
+        run: |
+          yarn tsc --noEmit
+          yarn test
 
       - name: "Deploy"
+        if: github.ref == 'refs/heads/main'
         env:
           CLOUDFLARE_API_TOKEN: ${{ secrets.CF_API_TOKEN }}
           CLOUDFLARE_ACCOUNT_ID: ${{ secrets.CF_ACCOUNT_ID }}

.github/workflows/pr.yml

@@ -1,4 +1,4 @@
-name: PR tests
+name: PR Tests
 on:
   pull_request:
 
@@ -32,6 +32,11 @@ jobs:
         run: yarn install
 
       - name: "Test"
+        run: |
+          yarn tsc --noEmit
+          yarn test
+
+      - name: "Run Coverage"
         run: yarn coverage
 
       - name: "Upload Coverage"

README.md

@@ -104,6 +104,11 @@ Run tests:
 $ yarn test
 ```
 
+Run typing check:
+```console
+$ yarn tsc --noEmit
+```
+
 Run tests with coverage report:
 ```console
 $ yarn coverage

doc/api.md

@@ -124,7 +124,7 @@ Upload your paste. It accept parameters in form-data:
 
 - `c`: mandatory. The **content** of your paste, text of binary. It should be no larger than 10 MB. The `filename` in its `Content-Disposition` will be present when fetching the paste.
 
-- `e`: optional. The **expiration** time of the paste. After this period of time, the paste is permanently deleted. It should be an integer or a float point number suffixed with an optional unit (seconds by default). Supported units: `s` (seconds), `m` (minutes), `h` (hours), `d` (days), `M` (months). For example, `360.24` means 360.25 seconds; `25d` is interpreted as 25 days. It should be no smaller than 60 seconds due to the limitation of Cloudflare KV storage.
+- `e`: optional. The **expiration** time of the paste. After this period of time, the paste is permanently deleted. It should be an integer or a float point number suffixed with an optional unit (seconds by default). Supported units: `s` (seconds), `m` (minutes), `h` (hours), `d` (days), `M` (months). For example, `360.24` means 360.25 seconds; `25d` is interpreted as 25 days. The actual expiration might be shorter than specified expiration due to limitations imposed by the administrator. If unspecified, a default expiration time setting is used.
 
 - `s`: optional. The **password** which allows you to modify and delete the paste. If not specified, the worker will generate a random string as password.
 
@@ -137,19 +137,19 @@ Upload your paste. It accept parameters in form-data:
 ```json
 {
     "url": "https://shz.al/abcd",
-    "admin": "https://shz.al/abcd:w2eHqyZGc@CQzWLN=BiJiQxZ",
-    "expire": 100,
-    "isPrivate": false
+    "manageUrl": "https://shz.al/abcd:w2eHqyZGc@CQzWLN=BiJiQxZ",
+    "expirationSeconds": 1209600,
+    "expireAt": "2025-05-05T10:33:06.114Z"
 }
 ```
 
 Explanation of the fields:
 
 - `url`: String. The URL to fetch the paste. When using a customized name, it looks like `https//shz.al/~myname`.
-- `suggestUrl`: String or null. The URL that may carry filename or URL redirection.
-- `admin`: String. The URL to update and delete the paste, which is `url` suffixed by `~` and the password.
-- `expire`: String or null. The expiration seconds.
-- `isPrivate`: Bool. Whether the paste is in private mode.
+- `suggestedUrl`: String or null. The URL that may carry filename or URL redirection.
+- `manageUrl`: String. The URL to update and delete the paste, which is `url` suffixed by `~` and the password.
+- `expirationSeconds`: String. The expiration seconds.
+- `expireAt`: String. An ISO String representing when the paste will expire.
 
 If error occurs, the worker returns status code different from `200`:
 
@@ -164,25 +164,27 @@ Usage example:
 $ curl -Fc="kawaii" -Fe=300 -Fn=hitagi https://shz.al  # uploading some text
 {
   "url": "https://shz.al/~hitagi",
-  "admin": "https://shz.al/~hitagi:22@-OJWcTOH2jprTJWYadmDv",
-  "isPrivate": false,
-  "expire": 300
+  "manageUrl": "https://shz.al/~hitagi:22@-OJWcTOH2jprTJWYadmDv",
+  "expirationSeconds": 300,
+  "expireAt": "2025-05-05T10:33:06.114Z"
 }
 
 $ curl [email protected] -Fn=panty -Fs=12345678 https://shz.al   # uploading a file
 {
   "url": "https://shz.al/~panty",
-  "admin": "https://shz.al/~panty:12345678",
-  "isPrivate": false
+  "manageUrl": "https://shz.al/~panty:12345678",
+  "expirationSeconds": 1209600,
+  "expireAt": "2025-05-05T10:33:06.114Z"
 }
 
 # because `curl` takes some characters as filed separator, the fields should be
 # quoted by double-quotes if the field contains semicolon or comma
 $ curl [email protected] -Fn='"hi/hello;g,ood"' -Fs=12345678 https://shz.al
 {
   "url": "https://shz.al/~hi/hello;g,ood",
-  "admin": "https://shz.al/~hi/hello;g,ood:QJhMKh5WR6z36QRAAn5Q5GZh",
-  "isPrivate": false
+  "manageUrl": "https://shz.al/~hi/hello;g,ood:QJhMKh5WR6z36QRAAn5Q5GZh",
+  "expirationSeconds": 1209600,
+  "expireAt": "2025-05-05T10:33:06.114Z"
 }
 ```
 
@@ -210,16 +212,17 @@ Usage example:
 $ curl -X PUT -Fc="kawaii~" -Fe=500 https://shz.al/~hitagi:22@-OJWcTOH2jprTJWYadmDv
 {
   "url": "https://shz.al/~hitagi",
-  "admin": "https://shz.al/~hitagi:22@-OJWcTOH2jprTJWYadmDv",
-  "isPrivate": false,
-  "expire": 500
+  "manageUrl": "https://shz.al/~hitagi:22@-OJWcTOH2jprTJWYadmDv",
+  "expirationSeconds": 500,
+  "expireAt": "2025-05-05T10:33:06.114Z"
 }
 
 $ curl -X PUT -Fc="kawaii~" https://shz.al/~hitagi:22@-OJWcTOH2jprTJWYadmDv
 {
   "url": "https://shz.al/~hitagi",
-  "admin": "https://shz.al/~hitagi:22@-OJWcTOH2jprTJWYadmDv",
-  "isPrivate": false
+  "manageUrl": "https://shz.al/~hitagi:22@-OJWcTOH2jprTJWYadmDv",
+  "expirationSeconds": 500,
+  "expireAt": "2025-05-05T10:33:06.114Z"
 }
 ```
 

frontend/index.html

@@ -14,7 +14,7 @@
     <h1>Yet Another Pastebin</h1>
     <p>This is an open source pastebin deployed on Cloudflare Workers. </p>
     <p><b>Usage</b>: paste any text here, submit, then share it with URL. </p>
-    <p><b>Warning</b>: only for temporary share, files will be deleted without notice!</p>
+    <p><b>Warning</b>: only for temporary share (<b>max 30 days</b>). Files will be deleted without notice!</p>
     <p>Refer to <a href='{{REPO}}'>GitHub</a> for more details.</p>
 
     <div id='paste-input-panel'>
@@ -70,10 +70,10 @@ <h2>Settings</h2>
             <span class='small-label'>Example: {{BASE_URL}}/~stocking</span>
         </div>
         <div class='label-line'>
-            <input type='radio' name='url-type' value='admin' id='paste-url-admin-radio'>
-            <label for='paste-url-admin-radio' class='radio-label'>Update or delete an existing paste</label>
-            <input type='url' spellcheck='false' id='paste-admin-url-input'
-                   name='admin-url' value='{{BASE_URL}}'>
+            <input type='radio' name='url-type' value='manage' id='paste-url-manage-radio'>
+            <label for='paste-url-manage-radio' class='radio-label'>Update or delete an existing paste</label>
+            <input type='url' spellcheck='false' id='paste-manage-url-input'
+                   name='manage-url' value='{{BASE_URL}}'>
         </div>
     </div>
     <div id='paste-uploaded-panel' class='hidden'>
@@ -84,19 +84,16 @@ <h2>Uploaded paste</h2>
         </div>
         <label for='uploaded-url' class='small-label'>URL</label>
         <div class='uploaded-entry'>
-            <input id='uploaded-admin-url' type='text' class='uploaded-table-text' readonly>
+            <input id='uploaded-manage-url' type='text' class='uploaded-table-text' readonly>
             <button class='copy-button'>Copy</button>
         </div>
-        <label for='suggest-url' class='small-label'>Admin URL</label>
+        <label for='suggested-url' class='small-label'>Manage URL</label>
         <div class='uploaded-entry'>
-            <input id='uploaded-suggest-url' type='text' class='uploaded-table-text' readonly>
+            <input id='uploaded-suggested-url' type='text' class='uploaded-table-text' readonly>
             <button class='copy-button'>Copy</button>
         </div>
-        <label for='uploaded-admin-url' class='small-label'>Suggest URL</label>
-        <div class='uploaded-entry'>
-            <input type='text' id='uploaded-expiration' class='uploaded-table-text' readonly>
-        </div>
-        <label for='uploaded-expiration' class='small-label'>Expiration (secs)</label>
+        <label for='uploaded-manage-url' class='small-label'>Suggest URL</label>
+        <p id='expiration-message'></p>
     </div>
     <div>
         <button id='submit-button' class='long-button px-3 py-2 my-1'>Upload</button>

frontend/index.client.js frontend/index.js.infrontend/index.client.js renamed to frontend/index.js.in

@@ -34,7 +34,7 @@ window.addEventListener('DOMContentLoaded', () => {
 
   $('#deploy-date').text(getDateString(deploy_date))
 
-  function isAdminUrlLegal(url) {
+  function isManageUrlLegal(url) {
     try {
       url = new URL(url)
       return url.origin === base_url && url.pathname.indexOf(':') >= 0
@@ -65,7 +65,7 @@ window.addEventListener('DOMContentLoaded', () => {
   let inputType = 'edit'
   let expiration = $('#paste-expiration-input').val()
   let passwd = ''
-  let customName = '', adminUrl = '', file = null
+  let customName = '', manageUrl = '', file = null
 
   const NAME_REGEX = /^[a-zA-Z0-9+_\-\[\]*$@,;]{3,}$/
   const EXPIRE_REGEX = /^\d+\s*[smhdwMY]?$/
@@ -88,35 +88,35 @@ window.addEventListener('DOMContentLoaded', () => {
       expirationValid = true
     }
     const nameValid = urlType !== 'custom' || NAME_REGEX.test(customName)
-    const adminUrlValid = urlType !== 'admin' || isAdminUrlLegal(adminUrl)
+    const manageurlValid = urlType !== 'manage' || isManageUrlLegal(manageUrl)
 
     if (!pasteNotEmpty) {
       disableSubmitButton('Paste is empty')
     } else if (!expirationValid) {
       disableSubmitButton(`Expiration “${expiration}” not valid`)
     } else if (!nameValid) {
       disableSubmitButton(`The customized URL should satisfy regex ${NAME_REGEX}`)
-    } else if (!adminUrlValid) {
-      disableSubmitButton(`Admin URL “${adminUrl}” not valid`)
+    } else if (!manageurlValid) {
+      disableSubmitButton(`Maange URL “${manageUrl}” not valid`)
     } else {
       submitButton.addClass('enabled')
       submitErrMsg.text('')
     }
 
-    if (urlType === 'admin') {
+    if (urlType === 'manage') {
       submitButton.text('Update')
       deleteButton.removeClass('hidden')
     } else {
       submitButton.text('Submit')
       deleteButton.addClass('hidden')
     }
 
-    if (adminUrlValid) {
+    if (manageurlValid) {
       deleteButton.addClass('enabled')
       submitButton.prop('title', '')
     } else {
       deleteButton.removeClass('enabled')
-      submitErrMsg.text(`The admin URL should start with “${base_url}” and contain a colon`)
+      submitErrMsg.text(`The manage URL should start with “${base_url}” and contain a colon`)
     }
   }
 
@@ -175,15 +175,15 @@ window.addEventListener('DOMContentLoaded', () => {
     updateButtons()
   })
 
-  $('#paste-admin-url-input').on('input', event => {
-    adminUrl = event.target.value
+  $('#paste-manage-url-input').on('input', event => {
+    manageUrl = event.target.value
     updateButtons()
   })
 
   // submit the form
   submitButton.on('click', () => {
     if (submitButton.hasClass('enabled')) {
-      if (urlType === 'admin') {
+      if (urlType === 'manage') {
         putPaste()
       } else {
         postPaste()
@@ -211,7 +211,7 @@ window.addEventListener('DOMContentLoaded', () => {
 
     $.ajax({
       method: 'PUT',
-      url: adminUrl,
+      url: manageUrl,
       data: fd,
       processData: false,
       contentType: false,
@@ -254,7 +254,7 @@ window.addEventListener('DOMContentLoaded', () => {
     let fd = new FormData()
     $.ajax({
       method: 'DELETE',
-      url: adminUrl,
+      url: manageUrl,
       data: fd,
       processData: false,
       success: () => {
@@ -273,12 +273,13 @@ window.addEventListener('DOMContentLoaded', () => {
   function renderUploaded(uploaded) {
     $('#paste-uploaded-panel').removeClass('hidden')
     $('#uploaded-url').prop('value', uploaded.url)
-    $('#uploaded-admin-url').prop('value', uploaded.admin)
-    if (uploaded.suggestUrl) {
-      $('#uploaded-suggest-url').prop('value', uploaded.suggestUrl)
+    $('#uploaded-manage-url').prop('value', uploaded.manageUrl)
+    if (uploaded.suggestedUrl) {
+      $('#uploaded-suggested-url').prop('value', uploaded.suggestedUrl)
     }
-    if (uploaded.expire) {
-      $('#uploaded-expiration').prop('value', uploaded.expire)
+    if (uploaded.expiredAt) {
+      const expiredAt = new Date(uploaded.expiredAt).toLocaleString()
+      $('#expiration-message').text(`Will expire at ${expiredAt} (${uploaded.expirationSeconds} secs)`)
     }
     updateButtons()
   }
@@ -309,13 +310,13 @@ window.addEventListener('DOMContentLoaded', () => {
     $('#submit-button').addClass('enabled')
   }
 
-  function initAdmin() {
+  function initManage() {
     const { role, short, passwd, ext } = parsePath(location.pathname)
     if (passwd.length > 0) {
-      $('#paste-url-admin-radio').click()
-      $('#paste-admin-url-input').val(location.href)
-      urlType = 'admin'
-      adminUrl = location.href
+      $('#paste-url-manage-radio').trigger("click")
+      $('#paste-manage-url-input').val(location.href)
+      urlType = 'manage'
+      manageUrl = location.href
       updateButtons()
       $.ajax({
         url: "/" + short,
@@ -328,5 +329,5 @@ window.addEventListener('DOMContentLoaded', () => {
     }
   }
 
-  initAdmin()
+  initManage()
 })

frontend/style.css

@@ -0,0 +1,6 @@
+{
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "types": ["dom", "@tyeps/jquery"]
+  }
+}