[add] LGPL 3.0 license, NPM provenance, GitHub repository settings & …

…PR badges

[optimize] upgrade to Node.js 20, MobX RESTful 1, KoAJAX 3 & other latest Upstream packages/actions

.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: master
+      # 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,15 +6,18 @@ 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
@@ -26,8 +29,9 @@ jobs:
                   npm publish
               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

LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

ReadMe.md

@@ -22,9 +22,12 @@
 ### Installation
 
 ```shell
-npm i mobx-restful mobx-github
+npm i mobx-github
 ```
 
+> Some **Node.js** tips about the upstream `mobx-restful` you should know:
+> https://github.com/idea2app/MobX-RESTful?tab=readme-ov-file#usage
+
 ### `tsconfig.json`
 
 ```json

package.json

@@ -1,6 +1,6 @@
 {
     "name": "mobx-github",
-    "version": "0.3.2",
+    "version": "0.3.3",
     "license": "LGPL-3.0-or-later",
     "author": "[email protected]",
     "description": "MobX SDK for GitHub RESTful API, which is based on MobX-RESTful.",
@@ -26,26 +26,26 @@
     },
     "dependencies": {
         "@octokit/openapi-types": "^22.2.0",
-        "@swc/helpers": "^0.5.11",
-        "@types/lodash": "^4.17.5",
-        "koajax": "^1.1.2",
+        "@swc/helpers": "^0.5.13",
+        "@types/lodash": "^4.17.7",
+        "koajax": ">=0.9 <4",
         "lodash": "^4.17.21",
         "mobx": ">=6.11",
-        "mobx-restful": ">=0.7.0-rc.0",
+        "mobx-restful": ">=0.7.0-rc.0 <2",
         "web-utility": "^4.4.0"
     },
     "devDependencies": {
         "@parcel/config-default": "~2.12.0",
         "@parcel/packager-ts": "~2.12.0",
         "@parcel/transformer-typescript-tsc": "~2.12.0",
         "@parcel/transformer-typescript-types": "~2.12.0",
-        "husky": "^9.0.11",
-        "lint-staged": "^15.2.5",
+        "husky": "^9.1.5",
+        "lint-staged": "^15.2.10",
         "parcel": "~2.12.0",
-        "prettier": "^3.3.1",
-        "typedoc": "^0.25.13",
-        "typedoc-plugin-mdn-links": "^3.1.28",
-        "typescript": "~5.4.5"
+        "prettier": "^3.3.3",
+        "typedoc": "^0.26.6",
+        "typedoc-plugin-mdn-links": "^3.2.11",
+        "typescript": "~5.5.4"
     },
     "prettier": {
         "singleQuote": true,