repository-provider 35.2.2 → 35.2.4

package/package.json

@@ -1,17 +1,17 @@
 {
   "name": "repository-provider",
-  "version": "35.2.2",
+  "version": "35.2.4",
   "publishConfig": {
     "access": "public",
     "provenance": true
   },
+  "types": "./types/index.d.mts",
   "exports": {
     ".": {
-      "types": "./types/index.d.mts",
-      "default": "./src/index.mjs"
+      "default": "./src/index.mjs",
+      "types": "./types/index.d.mts"
     }
   },
-  "types": "./types/index.d.mts",
   "description": "abstract interface to git repository providers like github, bitbucket and gitlab",
   "keywords": [
     "git",

package/src/base-object.mjs

@@ -8,7 +8,7 @@ import { description_attribute, id_attribute } from "./attributes.mjs";
  * Creates an instance of BaseObject.
  * @param {Object} options
  * @param {Object} [additionalProperties]
- * 
+ *
  * @property {string?} id
  * @property {string?} description
  */
@@ -72,6 +72,7 @@ export class BaseObject {
   updateAttributes(options, additionalProperties) {
     definePropertiesFromOptions(
       this,
+      // @ts-ignore
       mapAttributes(options, this.constructor.attributeMapping),
       additionalProperties
     );
@@ -94,6 +95,7 @@ export class BaseObject {
    * @return {string}
    */
   get fullName() {
+    // @ts-ignore
     return this.name;
   }
 

package/src/base-provider.mjs

@@ -1,13 +1,12 @@
+import { ContentEntry } from "content-entry";
 import { asArray, stripBaseName } from "./util.mjs";
 import { PullRequest } from "./pull-request.mjs";
 import { RepositoryGroup } from "./repository-group.mjs";
+import { BaseObject } from "./base-object.mjs";
 import { Repository } from "./repository.mjs";
-import { Branch } from "./branch.mjs";
 import { Tag } from "./tag.mjs";
+import { Branch } from "./branch.mjs";
 import { Hook } from "./hook.mjs";
-import { Project } from "./project.mjs";
-import { Milestone } from "./milestone.mjs";
-import { BaseObject } from "./base-object.mjs";
 import {
   url_attribute,
   name_attribute,
@@ -16,6 +15,11 @@ import {
   default_attribute
 } from "./attributes.mjs";
 
+/** 
+* @typedef {import('./project.mjs').Project} Project
+* @typedef {import('./milestone.mjs').Milestone} Milestone
+*/
+
 /**
  * @typedef {Object} MessageDestination
  * Endpoint to deliver log messages to.
@@ -154,7 +158,7 @@ export class BaseProvider extends BaseObject {
   }
 
   /**
-   * @param {*} other 
+   * @param {any} other 
    * @return {boolean} true if other provider is the same as the receiver
    */
   equals(other) {
@@ -297,6 +301,7 @@ export class BaseProvider extends BaseObject {
    */
   async createRepository(name, options) {
     const { group, repository } = this.parseName(name);
+    // @ts-ignore
     const rg = await this.repositoryGroup(group);
     return rg.createRepository(repository, options);
   }
@@ -309,6 +314,7 @@ export class BaseProvider extends BaseObject {
    */
   async *list(type, patterns) {
     if (patterns === undefined) {
+      // @ts-ignore
       for await (const group of this.repositoryGroups()) {
         yield* group[type]();
       }
@@ -319,6 +325,7 @@ export class BaseProvider extends BaseObject {
           this.repositoryBases
         ).split(/\//);
 
+        // @ts-ignore
         for await (const group of this.repositoryGroups(groupPattern)) {
           yield* group[type](repoPattern);
         }
@@ -412,6 +419,7 @@ export class BaseProvider extends BaseObject {
   toJSON() {
     const json = { name: this.name };
 
+    // @ts-ignore
     Object.entries(this.constructor.attributes).forEach(([k, v]) => {
       if (
         !v.private &&
@@ -428,22 +436,27 @@ export class BaseProvider extends BaseObject {
   initializeRepositories() {}
 
   trace(...args) {
+    // @ts-ignore
     return this.messageDestination.trace(...args);
   }
 
   debug(...args) {
+    // @ts-ignore
     return this.messageDestination.debug(...args);
   }
 
   info(...args) {
+    // @ts-ignore
     return this.messageDestination.info(...args);
   }
 
   warn(...args) {
+    // @ts-ignore
     return this.messageDestination.warn(...args);
   }
 
   error(...args) {
+    // @ts-ignore
     return this.messageDestination.error(...args);
   }
 

package/src/branch.mjs

@@ -84,9 +84,11 @@ export class Branch extends Ref {
    * @param {string} message commit message
    * @param {ContentEntry[]} updates content to be commited
    * @param {Object} options
-   * @return {Promise<CommitResult>}
+   * @return {Promise<CommitResult|undefined>}
    */
-  async commit(message, updates, options) {}
+  async commit(message, updates, options) {
+    return undefined;
+  }
 
   /**
    * Add commits into a pull request.
@@ -129,13 +131,16 @@ export class Branch extends Ref {
           if (prBranch === undefined) {
             prBranch = isBranch
               ? options.pullRequestBranch
+              // @ts-ignore
               : await this.createBranch(options.pullRequestBranch);
           }
           await prBranch.commit(commit.message, commit.entries);
           c2m(commit);
         };
 
+        // @ts-ignore
         if (commits.next) {
+          // @ts-ignore
           for await (const commit of commits) {
             await exec(commit);
           }
@@ -148,7 +153,9 @@ export class Branch extends Ref {
         options.body = options.body ? options.body + '\n' + body : body;
       }
 
+      // @ts-ignore
       if (options.body?.length > 0 && !options.skipWithoutCommits) {
+        // @ts-ignore
         return prBranch.createPullRequest(this, options);
       } else {
         return new PullRequest(
@@ -160,6 +167,7 @@ export class Branch extends Ref {
       }
     } catch (e) {
       if (!isBranch && prBranch) {
+        // @ts-ignore
         await prBranch.delete();
       }
       throw e;
@@ -179,6 +187,7 @@ export class Branch extends Ref {
    * @return {Promise<PullRequest>}
    */
   async createPullRequest(toBranch, options) {
+    // @ts-ignore
     return this.pullRequestClass.open(this, toBranch, options);
   }
 

package/src/index.mjs

@@ -1,20 +1,30 @@
 export * from "./base-object.mjs";
 export * from "./named-object.mjs";
+// @ts-ignore
 export * from "./owned-object.mjs";
 export * from "./repository-owner.mjs";
+// @ts-ignore
 export * from "./base-provider.mjs";
 export * from "./single-group-provider.mjs";
 export * from "./multi-group-provider.mjs";
 export * from "./repository-group.mjs";
+// @ts-ignore
 export * from "./repository.mjs";
+// @ts-ignore
 export * from "./ref.mjs";
 export * from "./commit.mjs";
+// @ts-ignore
 export * from "./branch.mjs";
+// @ts-ignore
 export * from "./tag.mjs";
+// @ts-ignore
 export * from "./project.mjs";
 export * from "./issue.mjs";
+// @ts-ignore
 export * from "./pull-request.mjs";
+// @ts-ignore
 export * from "./hook.mjs";
+// @ts-ignore
 export * from "./milestone.mjs";
 export * from "./review.mjs";
 export * from "./application.mjs";

package/src/multi-group-provider.mjs

@@ -104,6 +104,7 @@ export class MultiGroupProvider extends BaseProvider {
    * @return {RepositoryGroup}
    */
   addRepositoryGroup(name, options) {
+    // @ts-ignore
     return this.#repositoryGroups.get(this.normalizeGroupName(name, true)) || new this.repositoryGroupClass(this, name, options);
   }
 

package/src/named-object.mjs

@@ -6,6 +6,12 @@ import {
   id_attribute
 } from "./attributes.mjs";
 
+/** 
+* @typedef {import('./hook.mjs').Hook} Hook
+* @typedef {import('./base-provider.mjs').BaseProvider} BaseProvider
+*/
+
+
 /**
  * Object with a name.
  * @param {string} name
@@ -73,6 +79,7 @@ export class NamedObject extends BaseObject {
     return (
       super.equals(other) &&
       this.fullName === other.fullName &&
+      // @ts-ignore
       this.provider.equals(other.provider)
     );
   }

package/src/owned-object.mjs

@@ -1,6 +1,15 @@
 import { ContentEntry } from "content-entry";
 import { NamedObject } from "./named-object.mjs";
 
+/** 
+* @typedef {import('./base-provider.mjs').BaseProvider} BaseProvider
+* @typedef {import('./repository.mjs').Repository} Repository
+* @typedef {import('./hook.mjs').Hook} Hook
+* @typedef {import('./tag.mjs').Tag} Tag
+* @typedef {import('./branch.mjs').Branch} Branch
+* @typedef {import('./pull-request.mjs').PullRequest} PullRequest
+*/
+
 /**
  * Named Object registering itself in the owner.
  */
@@ -28,6 +37,7 @@ export class OwnedObject extends NamedObject {
   constructor(owner, name, options, additionalProperties) {
     super(name, options, additionalProperties);
     this.owner = owner;
+    // @ts-ignore
     owner[this.constructor.addMethodName](this);
   }
 
@@ -35,6 +45,7 @@ export class OwnedObject extends NamedObject {
    * Removes the receiver from the owner.
    */
   delete() {
+    // @ts-ignore
     this.owner[this.constructor.deleteMethodName](this);
   }
 
@@ -59,7 +70,7 @@ export class OwnedObject extends NamedObject {
   /**
    * Url of issue tracking system.
    * @see {@link Repository#issuesURL}
-   * @return {string} as provided from the repository
+   * @return {string|undefined} as provided from the repository
    */
   get issuesURL() {
     return this.owner.issuesURL;

package/src/pull-request.mjs

@@ -141,6 +141,7 @@ export class PullRequest extends OwnedObject {
       state: {
         set(value) {
           value = value.toUpperCase();
+          // @ts-ignore
           if (this.constructor.attributes.state.values.has(value)) {
             state = value;
           } else throw new Error(`Invalid Pull Request state ${value}`);
@@ -214,7 +215,9 @@ export class PullRequest extends OwnedObject {
    */
   async merge(method = "MERGE") {
     method = method.toUpperCase();
+    // @ts-ignore
     if (this.constructor.validMergeMethods.has(method)) {
+      // @ts-ignore
       await this._merge(method);
       this.merged = true;
     } else {
@@ -234,9 +237,11 @@ export class PullRequest extends OwnedObject {
 
   toString() {
     return [
+      // @ts-ignore
       [this.name, this.title],
       ["source", this.source?.identifier],
       ["destination", this.owner.identifier],
+      // @ts-ignore
       ...Object.entries(this.constructor.attributes)
         .filter(
           ([k, v]) =>

package/src/ref.mjs

@@ -2,6 +2,12 @@ import { ContentEntry } from "content-entry";
 import { OwnedObject } from "./owned-object.mjs";
 import { name_attribute, boolean_attribute } from "./attributes.mjs";
 
+/** 
+* @typedef {import('./repository.mjs').Repository} Repository
+* @typedef {import('./tag.mjs').Tag} Tag
+* @typedef {import('./branch.mjs').Branch} Branch
+*/
+
 /**
  * Base for Branch and Tag
  */

package/src/repository-owner.mjs

@@ -195,6 +195,7 @@ export function RepositoryOwner(base) {
      * @return {Promise<Branch|undefined>}
      */
     async branch(name) {
+      // @ts-ignore
       return this.lookup(
         "branch",
         name,
@@ -209,6 +210,7 @@ export function RepositoryOwner(base) {
      * @return {AsyncIterable<Branch>} all matching branches of the owner
      */
     async *branches(patterns) {
+      // @ts-ignore
       yield* this.list(
         "branches",
         patterns,

package/src/repository.mjs

@@ -98,6 +98,7 @@ export class Repository extends OwnedObject {
   }
 
   get url() {
+    // @ts-ignore
     return `${this.provider.url}${this.slug}`;
   }
 
@@ -270,6 +271,7 @@ export class Repository extends OwnedObject {
       return branch;
     }
 
+    // @ts-ignore
     return new this.branchClass(this, name, options);
   }
 
@@ -316,6 +318,7 @@ export class Repository extends OwnedObject {
    * @return {Tag} newly created tag
    */
   addTag(name, options) {
+    // @ts-ignore
     return this.#tags.get(name) || new this.tagClass(this, name, options);
   }
 
@@ -345,6 +348,7 @@ export class Repository extends OwnedObject {
   addPullRequest(name, source, options) {
     let pr = this.#pullRequests.get(name);
     if (pr === undefined) {
+      // @ts-ignore
       pr = new this.pullRequestClass(name, source, this, options);
       this.#pullRequests.set(pr.name, pr);
     }
@@ -395,6 +399,7 @@ export class Repository extends OwnedObject {
   addHook(name, options) {
     return (
       this.#hooks.find(hook => hook.name == name) ||
+      // @ts-ignore
       new this.hookClass(this, name, options)
     );
   }
@@ -429,6 +434,7 @@ export class Repository extends OwnedObject {
    */
   async hook(id) {
     for await (const hook of this.hooks()) {
+       // @ts-ignore
       if (hook.id == id) {
         // string of number
         return hook;
@@ -488,7 +494,9 @@ export class Repository extends OwnedObject {
    * @param {string} ref
    * @return {Promise<string|undefined>} sha of the ref
    */
-  async refId(ref) {}
+  async refId(ref) { 
+    return undefined;
+  }
 
   initialize() {}
 
@@ -505,7 +513,8 @@ export class Repository extends OwnedObject {
   }
 
   async initializePullRequests() {
-    for await (const pr of this.pullRequestClass.list(this)) {
+      // @ts-ignore
+      for await (const pr of this.pullRequestClass.list(this)) {
       this.#pullRequests.set(pr.name, pr);
     }
   }

package/src/single-group-provider.mjs

@@ -29,6 +29,7 @@ export class SingleGroupProvider extends RepositoryOwner(BaseProvider) {
     const { base } = this.parseName(name);
 
     if (name && this.supportsBase(base)) {
+       // @ts-ignore
       return this;
     }
   }
@@ -46,6 +47,7 @@ export class SingleGroupProvider extends RepositoryOwner(BaseProvider) {
     });
 
     if (found) {
+      // @ts-ignore
       yield this;
     }
   }

package/types/base-provider.d.mts

@@ -1,3 +1,7 @@
+/**
+* @typedef {import('./project.mjs').Project} Project
+* @typedef {import('./milestone.mjs').Milestone} Milestone
+*/
 /**
  * @typedef {Object} MessageDestination
  * Endpoint to deliver log messages to.
@@ -101,7 +105,7 @@ export class BaseProvider extends BaseObject {
     }, env: any): BaseProvider | undefined;
     get priority(): number;
     /**
-     * @param {*} other
+     * @param {any} other
      * @return {boolean} true if other provider is the same as the receiver
      */
     equals(other: any): boolean;
@@ -261,12 +265,14 @@ export class BaseProvider extends BaseObject {
     /**
      * @return {typeof ContentEntry} entry class used by the Provider
      */
-    get entryClass(): any;
+    get entryClass(): typeof ContentEntry;
     /**
      * @return {typeof PullRequest} pull request class used by the Provider
      */
     get pullRequestClass(): typeof PullRequest;
 }
+export type Project = import('./project.mjs').Project;
+export type Milestone = import('./milestone.mjs').Milestone;
 /**
  * Endpoint to deliver log messages to.
  */
@@ -279,10 +285,9 @@ export type MessageDestination = {
 };
 import { BaseObject } from "./base-object.mjs";
 import { Repository } from "./repository.mjs";
-import { Project } from "./project.mjs";
-import { Milestone } from "./milestone.mjs";
 import { Branch } from "./branch.mjs";
 import { Tag } from "./tag.mjs";
 import { Hook } from "./hook.mjs";
 import { PullRequest } from "./pull-request.mjs";
 import { RepositoryGroup } from "./repository-group.mjs";
+import { ContentEntry } from "content-entry";

package/types/branch.d.mts

@@ -23,9 +23,9 @@ export class Branch extends Ref {
      * @param {string} message commit message
      * @param {ContentEntry[]} updates content to be commited
      * @param {Object} options
-     * @return {Promise<CommitResult>}
+     * @return {Promise<CommitResult|undefined>}
      */
-    commit(message: string, updates: ContentEntry[], options: any): Promise<CommitResult>;
+    commit(message: string, updates: ContentEntry[], options: any): Promise<CommitResult | undefined>;
     /**
      * Add commits into a pull request.
      *
@@ -57,7 +57,7 @@ export class Branch extends Ref {
      * @return {Promise<PullRequest>}
      */
     createPullRequest(toBranch: Branch, options?: any): Promise<PullRequest>;
-    _addPullRequest(pullRequest: any): Promise<any>;
+    _addPullRequest(pullRequest: any): Promise<void>;
     deletePullRequest(name: any): Promise<any>;
     /**
      * Create a new {@link Branch} by cloning a given source branch.

package/types/named-object.d.mts

@@ -1,3 +1,7 @@
+/**
+* @typedef {import('./hook.mjs').Hook} Hook
+* @typedef {import('./base-provider.mjs').BaseProvider} BaseProvider
+*/
 /**
  * Object with a name.
  * @param {string} name
@@ -68,4 +72,6 @@ export class NamedObject extends BaseObject {
     toJSON(): any;
     #private;
 }
+export type Hook = import('./hook.mjs').Hook;
+export type BaseProvider = import('./base-provider.mjs').BaseProvider;
 import { BaseObject } from "./base-object.mjs";

package/types/owned-object.d.mts

@@ -1,3 +1,11 @@
+/**
+* @typedef {import('./base-provider.mjs').BaseProvider} BaseProvider
+* @typedef {import('./repository.mjs').Repository} Repository
+* @typedef {import('./hook.mjs').Hook} Hook
+* @typedef {import('./tag.mjs').Tag} Tag
+* @typedef {import('./branch.mjs').Branch} Branch
+* @typedef {import('./pull-request.mjs').PullRequest} PullRequest
+*/
 /**
  * Named Object registering itself in the owner.
  */
@@ -35,7 +43,7 @@ export class OwnedObject extends NamedObject {
     /**
      * Url of issue tracking system.
      * @see {@link Repository#issuesURL}
-     * @return {string} as provided from the repository
+     * @return {string|undefined} as provided from the repository
      */
     get issuesURL(): string;
     /**
@@ -72,7 +80,7 @@ export class OwnedObject extends NamedObject {
      * The provider we live in.
      * @return {BaseProvider}
      */
-    get provider(): BaseProvider;
+    get provider(): import("./base-provider.mjs").BaseProvider;
     /**
      * Forwarded to the owner.
      * @param  {...any} args
@@ -102,22 +110,22 @@ export class OwnedObject extends NamedObject {
      * By default we use the owners implementation.
      * @return {Repository} as defined in the owner
      */
-    get repositoryClass(): Repository;
+    get repositoryClass(): import("./repository.mjs").Repository;
     /**
      * By default we use the owners implementation.
      * @return {PullRequest} as defined in the owner
      */
-    get pullRequestClass(): PullRequest;
+    get pullRequestClass(): import("./pull-request.mjs").PullRequest;
     /**
      * By default we use the owners implementation.
      * @return {Branch} as defined in the owner
      */
-    get branchClass(): Branch;
+    get branchClass(): import("./branch.mjs").Branch;
     /**
      * By default we use the owners implementation.
      * @return {Tag} as defined in the owner
      */
-    get tagClass(): Tag;
+    get tagClass(): import("./tag.mjs").Tag;
     /**
      * By default we use the owners implementation.
      * @return {ContentEntry} as defined in the owner
@@ -127,7 +135,13 @@ export class OwnedObject extends NamedObject {
      * By default we use the owners implementation.
      * @return {Hook} as defined in the owner
      */
-    get hookClass(): Hook;
+    get hookClass(): import("./hook.mjs").Hook;
 }
+export type BaseProvider = import('./base-provider.mjs').BaseProvider;
+export type Repository = import('./repository.mjs').Repository;
+export type Hook = import('./hook.mjs').Hook;
+export type Tag = import('./tag.mjs').Tag;
+export type Branch = import('./branch.mjs').Branch;
+export type PullRequest = import('./pull-request.mjs').PullRequest;
 import { NamedObject } from "./named-object.mjs";
 import { ContentEntry } from "content-entry";

package/types/ref.d.mts

@@ -1,3 +1,8 @@
+/**
+* @typedef {import('./repository.mjs').Repository} Repository
+* @typedef {import('./tag.mjs').Tag} Tag
+* @typedef {import('./branch.mjs').Branch} Branch
+*/
 /**
  * Base for Branch and Tag
  */
@@ -68,7 +73,7 @@ export class Ref extends OwnedObject {
      * @see {@link Repository#owner}
      * @return {Repository}
      */
-    get repository(): Repository;
+    get repository(): import("./repository.mjs").Repository;
     get identifier(): any;
     /**
      *
@@ -86,5 +91,8 @@ export class Ref extends OwnedObject {
      */
     [Symbol.asyncIterator](): AsyncGenerator<ContentEntry>;
 }
+export type Repository = import('./repository.mjs').Repository;
+export type Tag = import('./tag.mjs').Tag;
+export type Branch = import('./branch.mjs').Branch;
 import { OwnedObject } from "./owned-object.mjs";
 import { ContentEntry } from "content-entry";

package/types/repository-group.d.mts

@@ -1,7 +1,7 @@
 declare const RepositoryGroup_base: {
     new (): {
         [x: string]: any;
-        "__#2@#repositories": Map<any, any>;
+        "__#1@#repositories": Map<any, any>;
         normalizeRepositoryName(name: string, forLookup: boolean): string;
         repository(name?: string): Promise<import("./repository.mjs").Repository>;
         repositories(patterns?: string | string[]): AsyncIterable<import("./repository.mjs").Repository>;

package/types/repository-owner.d.mts

@@ -5,7 +5,7 @@
 export function RepositoryOwner(base: any): {
     new (): {
         [x: string]: any;
-        "__#2@#repositories": Map<any, any>;
+        "__#1@#repositories": Map<any, any>;
         /**
          * Normalizes a repository name.
          * Strips branch away.

package/types/single-group-provider.d.mts

@@ -1,7 +1,7 @@
 declare const SingleGroupProvider_base: {
     new (): {
         [x: string]: any;
-        "__#2@#repositories": Map<any, any>;
+        "__#1@#repositories": Map<any, any>;
         normalizeRepositoryName(name: string, forLookup: boolean): string;
         repository(name?: string): Promise<Repository>;
         repositories(patterns?: string | string[]): AsyncIterable<Repository>;