[add] GitHub repository settings & PR badges (#16)

Author: TechQuery

.github/pr-badge.yml

@@ -0,0 +1,17 @@
+- icon: visualstudio
+  label: 'GitHub.dev'
+  message: 'PR-$prNumber'
+  color: 'blue'
+  url: 'https://github.dev/$owner/$repo/pull/$prNumber'
+
+- icon: github
+  label: 'GitHub codespaces'
+  message: 'PR-$prNumber'
+  color: 'black'
+  url: 'https://codespaces.new/$owner/$repo/pull/$prNumber'
+
+- icon: git
+  label: 'GitPod.io'
+  message: 'PR-$prNumber'
+  color: 'orange'
+  url: 'https://gitpod.io/?autostart=true#https://github.com/$owner/$repo/pull/$prNumber'

.github/settings.yml

@@ -0,0 +1,85 @@
+# These settings are synced to GitHub by https://probot.github.io/apps/settings/
+
+repository:
+    allow_merge_commit: false
+
+    delete_branch_on_merge: true
+
+    enable_vulnerability_alerts: true
+
+labels:
+    - name: bug
+      color: '#d73a4a'
+      description: Something isn't working
+
+    - name: documentation
+      color: '#0075ca'
+      description: Improvements or additions to documentation
+
+    - name: duplicate
+      color: '#cfd3d7'
+      description: This issue or pull request already exists
+
+    - name: enhancement
+      color: '#a2eeef'
+      description: Some improvements
+
+    - name: feature
+      color: '#16b33f'
+      description: New feature or request
+
+    - name: good first issue
+      color: '#7057ff'
+      description: Good for newcomers
+
+    - name: help wanted
+      color: '#008672'
+      description: Extra attention is needed
+
+    - name: invalid
+      color: '#e4e669'
+      description: This doesn't seem right
+
+    - name: question
+      color: '#d876e3'
+      description: Further information is requested
+
+    - name: wontfix
+      color: '#ffffff'
+      description: This will not be worked on
+
+branches:
+    - name: main
+      # https://docs.github.com/en/rest/reference/repos#update-branch-protection
+      protection:
+          # Required. Require at least one approving review on a pull request, before merging. Set to null to disable.
+          required_pull_request_reviews:
+              # The number of approvals required. (1-6)
+              required_approving_review_count: 1
+              # Dismiss approved reviews automatically when a new commit is pushed.
+              dismiss_stale_reviews: true
+              # Blocks merge until code owners have reviewed.
+              require_code_owner_reviews: true
+              # Specify which users and teams can dismiss pull request reviews.
+              # Pass an empty dismissal_restrictions object to disable.
+              # User and team dismissal_restrictions are only available for organization-owned repositories.
+              # Omit this parameter for personal repositories.
+              dismissal_restrictions:
+                  # users: []
+                  # teams: []
+          # Required. Require status checks to pass before merging. Set to null to disable
+          required_status_checks:
+              # Required. Require branches to be up to date before merging.
+              strict: true
+              # Required. The list of status checks to require in order to merge into this branch
+              contexts: []
+          # Required. Enforce all configured restrictions for administrators.
+          # Set to true to enforce required status checks for repository administrators.
+          # Set to null to disable.
+          enforce_admins: true
+          # Prevent merge commits from being pushed to matching branches
+          required_linear_history: true
+          # Required. Restrict who can push to this branch.
+          # Team and user restrictions are only available for organization-owned repositories.
+          # Set to null to disable.
+          restrictions: null

.github/workflows/main.yml

@@ -6,28 +6,40 @@ on:
 jobs:
     Build-and-Publish:
         runs-on: ubuntu-latest
+        permissions:
+            contents: write
+            id-token: write
         steps:
-            - uses: actions/checkout@v3
+            - uses: actions/checkout@v4
 
-            - uses: pnpm/action-setup@v2
+            - uses: pnpm/action-setup@v4
               with:
                   version: 9
-            - uses: actions/setup-node@v3
+            - uses: actions/setup-node@v4
               with:
-                  node-version: 18
+                  node-version: 20
                   registry-url: https://registry.npmjs.org
                   cache: pnpm
             - name: Install Dependencies
               run: pnpm i --frozen-lockfile
 
-            - name: Build & Publish
+            - name: Build & Publish the core package
               run: |
                   echo GITHUB_PAT=${{ secrets.PAT }} > .env
                   npm publish
               env:
                   NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+            - name: Build & Publish the Strapi package
+              run: |
+                  cd wrapper/Strapi
+                  pnpm i --frozen-lockfile
+                  npm publish  ||  true
+              env:
+                  NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
             - name: Update document
-              uses: peaceiris/actions-gh-pages@v3
+              uses: peaceiris/actions-gh-pages@v4
               with:
                   publish_dir: ./docs
                   personal_token: ${{ secrets.GITHUB_TOKEN }}

.npmrc

@@ -1 +1,2 @@
+provenance = true
 auto-install-peers = false

ReadMe.md

@@ -1,14 +1,14 @@
 # MobX RESTful
 
-Common [MobX][1] **abstract base Class & Decorator** utilities for [RESTful API][2].
+Common [MobX][1] **abstract base Class & [Decorator][2]** utilities for [RESTful API][3].
 
 Just define your **Data models** & **Client HTTP methods**, then leave rest of things to MobX!
 
 [![MobX compatibility](https://img.shields.io/badge/Compatible-1?logo=mobx&label=MobX%206%2F7)][1]
-[![NPM Dependency](https://img.shields.io/librariesio/github/idea2app/MobX-RESTful.svg)][3]
-[![CI & CD](https://github.com/idea2app/MobX-RESTful/actions/workflows/main.yml/badge.svg)][4]
+[![NPM Dependency](https://img.shields.io/librariesio/github/idea2app/MobX-RESTful.svg)][4]
+[![CI & CD](https://github.com/idea2app/MobX-RESTful/actions/workflows/main.yml/badge.svg)][5]
 
-[![NPM](https://nodei.co/npm/mobx-restful.png?downloads=true&downloadRank=true&stars=true)][5]
+[![NPM](https://nodei.co/npm/mobx-restful.png?downloads=true&downloadRank=true&stars=true)][6]
 
 ## Versions
 
@@ -19,6 +19,27 @@ Just define your **Data models** & **Client HTTP methods**, then leave rest of t
 
 ## Usage
 
+### `package.json`
+
+```json
+{
+    "dependencies": {
+        "koajax": "^3.0.0",
+        "mobx": "^6.13.1",
+        "mobx-restful": "^1.0.1"
+    },
+    "resolutions": {
+        "native-file-system-adapter": "npm:@tech_query/native-file-system-adapter@^3.0.1"
+    }
+}
+```
+
+> This `resolutions` configuration is used for **Node.js**, such Back-end API or Server-side Rendering.
+>
+> You should install your project with [Yarn][7] or [PNPM][8] to support this feature.
+>
+> It can be removed after [`require('esm')` shipped formally][9].
+
 ### `tsconfig.json`
 
 ```json
@@ -83,7 +104,7 @@ export default new RepositoryModel();
 
 #### `page/Repository.tsx`
 
-Use [WebCell][6] as an Example
+Use [WebCell][10] as an Example
 
 ```tsx
 import { component, observer } from 'web-cell';
@@ -230,12 +251,16 @@ Here is an example:
 
 ## Limitation
 
--   [ ] [`abstract` hint of Mixin is missing][7]
+-   [ ] [`abstract` hint of Mixin is missing][11]
 
 [1]: https://mobx.js.org/
-[2]: https://en.wikipedia.org/wiki/Representational_state_transfer
-[3]: https://libraries.io/npm/mobx-restful
-[4]: https://github.com/idea2app/MobX-RESTful/actions/workflows/main.yml
-[5]: https://nodei.co/npm/mobx-restful/
-[6]: https://github.com/EasyWebApp/WebCell
-[7]: https://github.com/microsoft/TypeScript/issues/39752#issuecomment-1239810720
+[2]: https://github.com/tc39/proposal-decorators
+[3]: https://en.wikipedia.org/wiki/Representational_state_transfer
+[4]: https://libraries.io/npm/mobx-restful
+[5]: https://github.com/idea2app/MobX-RESTful/actions/workflows/main.yml
+[6]: https://nodei.co/npm/mobx-restful/
+[7]: https://yarnpkg.com/
+[8]: https://pnpm.io/
+[9]: https://joyeecheung.github.io/blog/2024/03/18/require-esm-in-node-js/
+[10]: https://github.com/EasyWebApp/WebCell
+[11]: https://github.com/microsoft/TypeScript/issues/39752#issuecomment-1239810720

package.json

@@ -1,6 +1,6 @@
 {
     "name": "mobx-restful",
-    "version": "1.0.0",
+    "version": "1.0.1",
     "license": "LGPL-3.0",
     "author": "[email protected]",
     "description": "MobX SDK for RESTful API",
@@ -27,9 +27,9 @@
     "module": "dist/index.esm.js",
     "main": "dist/index.js",
     "dependencies": {
-        "@swc/helpers": "^0.5.11",
+        "@swc/helpers": "^0.5.13",
         "idb-keyval": "^6.2.1",
-        "koajax": "^1.1.2",
+        "koajax": ">=1 <4",
         "native-file-system-adapter": "^3.0.1",
         "regenerator-runtime": "^0.14.1",
         "web-streams-polyfill": "^4.0.0",
@@ -45,20 +45,20 @@
         "@parcel/transformer-typescript-tsc": "~2.12.0",
         "@parcel/transformer-typescript-types": "~2.12.0",
         "@types/jest": "^29.5.12",
-        "@types/node": "^18.19.34",
+        "@types/node": "^20.16.3",
         "dotenv": "^16.4.5",
-        "husky": "^9.0.11",
+        "husky": "^9.1.5",
         "jest": "^29.7.0",
         "jest-environment-jsdom": "^29.7.0",
-        "lint-staged": "^15.2.5",
-        "mobx": "^6.12.3",
+        "lint-staged": "^15.2.10",
+        "mobx": "^6.13.1",
         "open-cli": "^8.0.0",
         "parcel": "~2.12.0",
-        "prettier": "^3.3.1",
-        "ts-jest": "^29.1.4",
-        "typedoc": "^0.25.13",
-        "typedoc-plugin-mdn-links": "^3.1.28",
-        "typescript": "~5.5.0-beta"
+        "prettier": "^3.3.3",
+        "ts-jest": "^29.2.5",
+        "typedoc": "^0.26.6",
+        "typedoc-plugin-mdn-links": "^3.2.11",
+        "typescript": "~5.5.4"
     },
     "prettier": {
         "singleQuote": true,