github-repository-provider 9.2.31 → 9.3.1

package/README.md

@@ -51,7 +51,6 @@ for async (const entry of repository.entries('\*_/_.md')) {
         *   [Parameters](#parameters-6)
     *   [deleteRepository](#deleterepository)
         *   [Parameters](#parameters-7)
-    *   [attributeMapping](#attributemapping)
 *   [GithubProvider](#githubprovider)
     *   [Examples](#examples)
     *   [initializeRepositories](#initializerepositories)
@@ -68,7 +67,6 @@ for async (const entry of repository.entries('\*_/_.md')) {
     *   [open](#open)
         *   [Parameters](#parameters-10)
 *   [GithubRepository](#githubrepository)
-    *   [defaultBranchName](#defaultbranchname)
     *   [commits](#commits)
         *   [Parameters](#parameters-11)
     *   [commitForSha](#commitforsha)
@@ -181,10 +179,6 @@ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
 
 *   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
 
-### attributeMapping
-
-Map attributes between external and internal representation.
-
 ## GithubProvider
 
 **Extends MultiGroupProvider**
@@ -286,10 +280,6 @@ Returns **[Set](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Glob
 
 Repository on GitHub.
 
-### defaultBranchName
-
-Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** "main"
-
 ### commits
 
 <https://docs.github.com/en/rest/reference/commits#list-commits>

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "github-repository-provider",
-  "version": "9.2.31",
+  "version": "9.3.1",
   "publishConfig": {
     "access": "public",
     "provenance": true
   },
+  "packageManager": "npm@11.6.0+sha512.77f3fb0dbbd881835d7bd1217deabdf7ed77fc4ec4f363df64fc3cb986404abf6c437661041080f5c5d225103508e7c9ea30cb2742b7e942675d05a10af2d7b9",
   "exports": {
     ".": {
       "default": "./src/github-provider.mjs"
@@ -32,26 +33,26 @@
     "lint:docs": "documentation lint ./src**/*.mjs"
   },
   "dependencies": {
-    "content-entry": "^14.2.4",
+    "content-entry": "^14.2.5",
     "fetch-link-util": "^1.1.3",
     "fetch-rate-limit-util": "^4.5.4",
     "matching-iterator": "^2.1.4",
     "one-time-execution-method": "^3.1.3",
-    "repository-provider": "^35.5.14"
+    "repository-provider": "^35.6.0"
   },
   "devDependencies": {
-    "@types/node": "^24.3.0",
+    "@types/node": "^24.5.2",
     "ava": "^6.4.1",
     "c8": "^10.1.3",
     "documentation": "^14.0.3",
-    "etag-cache-leveldb": "^2.1.15",
+    "etag-cache-leveldb": "^2.1.16",
     "leveldown": "^6.1.1",
     "levelup": "^5.1.1",
-    "repository-provider-test-support": "^3.1.52",
-    "semantic-release": "^24.2.7"
+    "repository-provider-test-support": "^4.0.0",
+    "semantic-release": "^24.2.9"
   },
   "engines": {
-    "node": ">=22.18.0"
+    "node": ">=22.19.0"
   },
   "repository": {
     "type": "git",

package/src/github-owner.mjs

@@ -6,20 +6,16 @@ import { RepositoryGroup, Repository } from "repository-provider";
  * - organization
  */
 export class GithubOwner extends RepositoryGroup {
-  /**
-   * Map attributes between external and internal representation.
-   */
-  static get attributeMapping() {
-    return {
-      ...super.attributeMapping,
-      site_admin: "isAdmin"
-    };
-  }
+  static attributes = {
+    ...RepositoryGroup.attributes,
+    isAdmin: {
+      ...RepositoryGroup.attributes.isAdmin,
+      externalName: "site_admin"
+    }
+  };
 
   get api() {
-    return this.type === "Organization"
-      ? `orgs/${this.name}`
-      : "user";
+    return this.type === "Organization" ? `orgs/${this.name}` : "user";
   }
 
   /**
@@ -40,7 +36,7 @@ export class GithubOwner extends RepositoryGroup {
 
     if (response.ok) {
       this.info(`Repository ${name} created`);
-      options.defaultBranchName = "main";
+      options.default_branch = "main";
       return this.addRepository(name, options);
     }
 

package/src/github-provider.mjs

@@ -4,7 +4,8 @@ import {
   url_attribute,
   priority_attribute,
   hostname_attribute,
-  token_attribute
+  token_attribute,
+  object_attribute
 } from "pacc";
 import { MultiGroupProvider } from "repository-provider";
 import { GithubRepository } from "./github-repository.mjs";
@@ -56,51 +57,72 @@ export class GithubProvider extends MultiGroupProvider {
       env: ["{{instanceIdentifier}}HOST", "GH_HOST"],
       default: host
     },
-    ssh: {
-      ...url_attribute,
-      default: `git@${host}:`
-    },
+    ssh: url_attribute,
     url: {
       ...url_attribute,
-      env: "{{instanceIdentifier}}SERVER_URL",
-      set: value => (value.endsWith("/") ? value : value + "/"),
-      default: `https://${host}/`,
-      depends: "host"
-      /*get: (attribute, object, properties) =>
-          `https://${object.host || properties?.host.value}`*/
+      env: "{{instanceIdentifier}}SERVER_URL"
     },
     api: {
       ...url_attribute,
-      env: "{{instanceIdentifier}}API_URL",
-      set: value => value.replace(/\/$/, ""),
-      depends: "host",
-      default: `https://api.${host}`
-      /*        get: (attribute, object, properties) =>
-          `https://api.${object.host || properties.host.value}`*/
+      env: "{{instanceIdentifier}}API_URL"
     },
-    "authentication.token": {
-      ...token_attribute,
-      // @see https://cli.github.com/manual/gh_help_environment
-      env: [
-        "{{instanceIdentifier}}TOKEN",
-        "GH_TOKEN" // declare GH_ as identifier
-      ],
-      additionalAttributes: { "authentication.type": "token" },
-      mandatory: true
+    authentication: {
+      ...object_attribute,
+      attributes: {
+        token: {
+          ...token_attribute,
+          // @see https://cli.github.com/manual/gh_help_environment
+          env: [
+            "{{instanceIdentifier}}TOKEN",
+            "GH_TOKEN" // declare GH_ as identifier
+          ],
+          additionalValues: { "authentication.type": "token" },
+          mandatory: true
+        }
+      }
     },
     priority: { ...priority_attribute, default: 1000.0 }
   };
 
+  set ssh(value) {
+    this._ssh = value;
+  }
+
+  get ssh() {
+    return this._ssh ?? `git@${this.host}:`;
+  }
+
+  set url(value) {
+    this._url = value.endsWith("/") ? value : value + "/";
+  }
+
+  get url() {
+    return this._url ?? `https://${this.host}/`;
+  }
+
+  set api(value) {
+    this._api = value.replace(/\/$/, "");
+  }
+
+  get api() {
+    return this._api ?? `https://api.${this.host}`;
+  }
+
   fetch(url, options = {}) {
     options.reporter = (url, ...args) => this.trace(url.toString(), ...args);
     options.cache = this.cache;
     options.agent = this.agent;
 
+    const authorization = {};
+    if(this.authentication?.token) {
+      authorization.authorization = `token ${this.authentication.token}`
+    }
+
     return stateActionHandler(new URL(url, this.api), {
       ...options,
       headers: {
         accept: "application/vnd.github+json",
-        authorization: `token ${this.authentication.token}`,
+        ...authorization,
         ...options.headers
       }
     });
@@ -123,7 +145,7 @@ export class GithubProvider extends MultiGroupProvider {
         const url = `user/repos?page=${page}&per_page=100`;
         const { json } = await this.fetchJSON(url);
 
-        if (json.length === 0 || !Array.isArray(json)) {
+        if (json?.length === 0 || !Array.isArray(json)) {
           break;
         }
 
@@ -135,7 +157,9 @@ export class GithubProvider extends MultiGroupProvider {
           );
         });
       }
-    } catch {}
+    } catch (e) {
+      throw e;
+    }
   }
 
   /**
@@ -149,9 +173,10 @@ export class GithubProvider extends MultiGroupProvider {
    * @return {string[]} common base urls of all repositories
    */
   get repositoryBases() {
+    const url = this.url;
     return super.repositoryBases.concat([
-      this.url,
-      "git+" + this.url,
+      url,
+      "git+" + url,
       `git+ssh://${this.host}`,
       `git://${this.host}/`,
       `git@${this.host}:`

package/src/github-pull-request.mjs

@@ -12,16 +12,13 @@ export class GithubPullRequest extends PullRequest {
    */
   static validMergeMethods = new Set(["MERGE", "SQUASH", "REBASE"]);
 
-  static get attributeMapping() {
-    return {
-      ...super.attributeMapping,
-      url: "api" // TODO undefined ?
-    };
-  }
-
   static attributes = {
     ...super.attributes,
-    maintainer_can_modify: boolean_attribute
+    maintainer_can_modify: boolean_attribute,
+    url: {
+      ...PullRequest.attributes.url,
+      externalName: "api"
+    }
   };
 
   /**
@@ -114,7 +111,7 @@ export class GithubPullRequest extends PullRequest {
    *
    */
   async update() {
-    const res = await this.provider.fetch(this.api, {
+    return await this.provider.fetch(this.api, {
       method: "PATCH",
       body: JSON.stringify({
         title: this.title,
@@ -122,6 +119,5 @@ export class GithubPullRequest extends PullRequest {
         state: this.state
       })
     });
-    console.log(res);
   }
 }

package/src/github-repository.mjs

@@ -1,17 +1,14 @@
 import { replaceWithOneTimeExecutionMethod } from "one-time-execution-method";
 import {
-  boolean_attribute,
+  filterWritable,
+  boolean_attribute_writable,
+  boolean_attribute_writable_false,
   url_attribute,
   size_attribute,
   language_attribute,
   string_attribute_writable
 } from "pacc";
-import {
-  Repository,
-  mapAttributesInverse,
-  optionJSON,
-  Commit
-} from "repository-provider";
+import { Repository, Commit } from "repository-provider";
 import { getHeaderLink } from "fetch-link-util";
 import { defaultStateActions, errorHandler } from "fetch-rate-limit-util";
 
@@ -28,45 +25,31 @@ export class GithubRepository extends Repository {
   #trees = new Map();
   #commits = new Map();
 
-  static get attributeMapping() {
-    return {
-      ...super.attributeMapping,
-      disabled: "isDisabled",
-      archived: "isArchived",
-      is_template: "isTemplate",
-      private: "isPrivate",
-      fork: "isFork",
-      default_branch: "defaultBranchName",
-      url: "api"
-    };
-  }
-
   static attributes = {
     ...super.attributes,
-    auto_init: boolean_attribute,
-    size: size_attribute,
-    language: language_attribute,
     gitignore_template: string_attribute_writable,
     license_template: string_attribute_writable,
-    allow_squash_merge: boolean_attribute,
-    allow_merge_commit: boolean_attribute,
-    allow_rebase_merge: boolean_attribute,
-    allow_auto_merge: boolean_attribute,
-    delete_branch_on_merge: boolean_attribute,
-    issuesURL: url_attribute,
+    allow_squash_merge: boolean_attribute_writable_false,
+    allow_merge_commit: boolean_attribute_writable_false,
+    allow_rebase_merge: boolean_attribute_writable_false,
+    allow_auto_merge: boolean_attribute_writable_false,
+    delete_branch_on_merge: boolean_attribute_writable_false,
     squash_merge_commit_title: string_attribute_writable,
     squash_merge_commit_message: string_attribute_writable,
     merge_commit_title: string_attribute_writable,
-    merge_commit_message: string_attribute_writable
-    //custom_properties: default_attribute
+    merge_commit_message: string_attribute_writable,
+    size: size_attribute,
+    language: language_attribute,
+    issuesURL: url_attribute,
+    auto_init: boolean_attribute_writable_false,
+    url: {
+      ...super.attributes.url,
+      externalName: "api"
+    },
+    isTemplate: { ...super.attributes.isTemplate, externalName: "is_template" }
   };
 
-  /**
-   * @return {string} "main"
-   */
-  get defaultBranchName() {
-    return "main";
-  }
+  static defaultBranchName = "main";
 
   /**
    * {@link https://docs.github.com/en/rest/reference/commits#list-commits}
@@ -236,12 +219,7 @@ export class GithubRepository extends Repository {
   async update() {
     return this.provider.fetch(this.api, {
       method: "PATCH",
-      body: JSON.stringify(
-        mapAttributesInverse(
-          optionJSON(this, undefined, this.constructor.writableAttributes),
-          this.constructor.attributeMapping
-        )
-      )
+      body: JSON.stringify(this.toJSON(filterWritable))
     });
   }