repository-provider 35.6.2 → 35.7.0

package/package.json

@@ -1,15 +1,13 @@
 {
   "name": "repository-provider",
-  "version": "35.6.2",
+  "version": "35.7.0",
   "publishConfig": {
     "access": "public",
     "provenance": true
   },
   "packageManager": "npm@11.6.0+sha512.77f3fb0dbbd881835d7bd1217deabdf7ed77fc4ec4f363df64fc3cb986404abf6c437661041080f5c5d225103508e7c9ea30cb2742b7e942675d05a10af2d7b9",
-  "types": "./types/index.d.mts",
   "exports": {
     ".": {
-      "types": "./types/index.d.mts",
       "default": "./src/index.mjs"
     }
   },
@@ -26,33 +24,29 @@
   ],
   "license": "0BSD",
   "scripts": {
-    "prepare": "node --run prepare:typescript",
-    "prepare:typescript": "tsc --allowJs --declaration --emitDeclarationOnly --declarationDir types --resolveJsonModule --target esnext -m esnext --module nodenext --moduleResolution nodenext --rootDir src ./src**/*.mjs",
     "test": "node --run test:browser-ava && node --run test:ava",
     "test:ava": "ava --timeout 4m tests/*-ava.mjs tests/*-ava-node.mjs",
     "test:browser-ava": "browser-ava --headless --no-keep-open tests/*-ava.mjs tests/*-ava-browser.mjs",
     "cover": "c8 -x 'tests/**/*' --temp-directory build/tmp ava --timeout 4m tests/*-ava.mjs tests/*-ava-node.mjs && c8 report -r lcov -o build/coverage --temp-directory build/tmp",
     "docs": "documentation readme --section=API ./src**/*.mjs",
-    "lint": "node --run lint:docs && node --run lint:typescript",
-    "lint:docs": "documentation lint ./src**/*.mjs",
-    "lint:typescript": "tsc --allowJs --checkJs --noEmit --resolveJsonModule --target esnext -m esnext --module nodenext --moduleResolution nodenext ./src**/*.mjs"
+    "lint": "node --run lint:docs",
+    "lint:docs": "documentation lint ./src**/*.mjs"
   },
   "dependencies": {
     "content-entry": "^14.2.5",
     "matching-iterator": "^2.1.4",
-    "pacc": "^4.39.1"
+    "pacc": "^4.39.2"
   },
   "devDependencies": {
     "ava": "^6.4.1",
-    "browser-ava": "^2.3.34",
+    "browser-ava": "^2.3.35",
     "c8": "^10.1.3",
     "documentation": "^14.0.3",
     "repository-provider-test-support": "^4.0.0",
-    "semantic-release": "^24.2.9",
-    "typescript": "^5.9.2"
+    "semantic-release": "^24.2.9"
   },
   "engines": {
-    "node": ">=22.19.5"
+    "node": ">=22.20.0"
   },
   "repository": {
     "type": "git",
@@ -66,8 +60,7 @@
     "inheritFrom": [
       "arlac77/template-arlac77-github",
       "arlac77/template-browser-ava",
-      "arlac77/template-javascript-component",
-      "arlac77/template-typescript"
+      "arlac77/template-javascript-component"
     ]
   }
 }

package/src/repository-group.mjs

@@ -1,4 +1,9 @@
-import { url_attribute, url_attribute_writable, boolean_attribute, type_attribute } from "pacc";
+import {
+  url_attribute,
+  url_attribute_writable,
+  boolean_attribute,
+  type_attribute
+} from "pacc";
 import { RepositoryOwner } from "./repository-owner.mjs";
 import { OwnedObject } from "./owned-object.mjs";
 import { BaseProvider } from "./base-provider.mjs";
@@ -40,8 +45,8 @@ export class RepositoryGroup extends RepositoryOwner(OwnedObject) {
      */
     type: type_attribute,
     url: url_attribute,
-    avatarURL: url_attribute,
-    isAdmin: boolean_attribute,
+    avatarURL: { ...url_attribute, externalName: "avatar_url" },
+    isAdmin: { ...boolean_attribute, externalName: "is_admin" },
     /**
      * The url of home page.
      * @return {string}

package/types/application.d.mts

@@ -1,6 +0,0 @@
-/**
- *
- */
-export class Application extends OwnedObject {
-}
-import { OwnedObject } from "./owned-object.mjs";

package/types/base-object.d.mts

@@ -1,80 +0,0 @@
-/**
- * Creates an instance of BaseObject.
- * @param {Object} [options]
- * @param {string} [options.id]
- * @param {string} [options.description]
- * @param {Object} [additionalProperties]
- *
- * @property {string?} id
- * @property {string?} description
- */
-export class BaseObject {
-    /**
-     * @return {string} type we represent
-     */
-    static get type(): string;
-    /**
-     * ```
-     * Tag -> tags
-     * Repository -> repositories
-     * ```
-     * @return {string} name of the collection holding us in the owner
-     */
-    static get collectionName(): string;
-    /**
-     * Attributes definitions.
-     * @return {Object}
-     */
-    static attributes: {
-        id: import("pacc").AttributeDefinition;
-        description: import("pacc").AttributeDefinition;
-    };
-    /**
-     * User modifyable attributes.
-     * @return {Object} writable attributes
-     */
-    static get writableAttributes(): any;
-    /**
-     * Creates an instance of BaseObject.
-     * @param {Object} [options]
-     * @param {string} [options.id]
-     * @param {string} [options.description]
-     */
-    constructor(options?: {
-        id?: string;
-        description?: string;
-    });
-    /** @type {string} */ id: string;
-    /** @type {string} */ description: string;
-    /**
-     * Takes values from options.
-     * @param {Object} [options]
-     * @param {Object} [additionalProperties]
-     */
-    updateAttributes(options?: any): void;
-    /**
-     * Save object attributes in the backing store.
-     */
-    update(): Promise<void>;
-    /**
-     * @return {string} fullName
-     */
-    toString(): string;
-    /**
-     * Complete name in the hierachy.
-     * @return {string}
-     */
-    get fullName(): string;
-    get identifier(): string;
-    /**
-     * By default cannot be written to.
-     * @return {boolean} false
-     */
-    get isWritable(): boolean;
-    /**
-     * Check for equality
-     * @param {BaseObject|undefined} other
-     * @return {boolean} true if other is present
-     */
-    equals(other: BaseObject | undefined): boolean;
-}

package/types/base-provider.d.mts

@@ -1,271 +0,0 @@
-/**
- * @typedef {import('./project.mjs').Project} Project
- * @typedef {import('./milestone.mjs').Milestone} Milestone
- */
-/**
- * @typedef {Object} DecodedRepositoryName
- * @property {string} [base]
- * @property {string} [group]
- * @property {string} [repository]
- * @property {string} [branch]
- */
-/**
- * @typedef {Object} MessageDestination
- * Endpoint to deliver log messages to.
- * @property {function(string):void} info
- * @property {function(string):void} debug
- * @property {function(string):void} warn
- * @property {function(string):void} error
- * @property {function(string):void} trace
- */
-/**
- * @param {Object} [options]
- * @param {string} [options.url]
- * @param {MessageDestination} [options.messageDestination]
- * @property {MessageDestination} messageDestination
- * @property {string} url
- * @property {string} api
- */
-export class BaseProvider extends BaseObject {
-    /**
-     * Prefix used to form environment variables.
-     * 'GITHUB_' -> 'GITHUB_TOKEN'
-     * @return {string} identifier for environment options
-     */
-    static get instanceIdentifier(): string;
-    static attributes: {
-        /**
-         * Name of the provider.
-         */
-        name: {
-            env: string;
-            type: object;
-            isKey: boolean;
-            writable: boolean;
-            mandatory: boolean;
-            collection: boolean;
-            private?: boolean;
-            depends?: string;
-            description?: string;
-            default?: any;
-            set?: Function;
-            get?: Function;
-            prepareValue?: Function;
-            values?: Set<any>;
-            externalName?: string;
-            additionalValues?: object;
-        };
-        url: import("pacc").AttributeDefinition;
-        priority: import("pacc").AttributeDefinition;
-        /**
-         * To forward info/warn and error messages to
-         */
-        messageDestination: {
-            default: Console;
-            writable: boolean;
-            private: boolean;
-            type: object;
-            isKey: boolean;
-            mandatory: boolean;
-            collection: boolean;
-            depends?: string;
-            description?: string;
-            set?: Function;
-            get?: Function;
-            prepareValue?: Function;
-            values?: Set<any>;
-            externalName?: string;
-            env?: string[] | string;
-            additionalValues?: object;
-        };
-        id: import("pacc").AttributeDefinition;
-        description: import("pacc").AttributeDefinition;
-    };
-    /**
-     * @typedef {Object} parsedName
-     *
-     */
-    /**
-     * Creates a new provider for a given set of options.
-     * @param {Object} options additional options
-     * @param {string} [options.instanceIdentifier] name of the provider instance
-     * @param {string} [options.description]
-     * @param {Object} env taken from process.env
-     * @return {BaseProvider|undefined} newly created provider or undefined if options are not sufficient to construct a provider
-     */
-    static initialize(options: {
-        instanceIdentifier?: string;
-        description?: string;
-    }, env: any): BaseProvider | undefined;
-    get priority(): number;
-    /**
-     * @param {any} other
-     * @return {boolean} true if other provider is the same as the receiver
-     */
-    equals(other: any): boolean;
-    /**
-     * All supported base urls.
-     * For github something like:
-     * - git@github.com
-     * - git://github.com
-     * - git+ssh://github.com
-     * - https://github.com
-     * - git+https://github.com
-     * By default we provide provider name with ':'.
-     * @return {string[]} common base urls of all repositories
-     */
-    get repositoryBases(): string[];
-    /**
-     * Does the provider support the base name.
-     * @param {string} [base] to be checked
-     * @return {boolean} true if base is supported or base is undefined
-     */
-    supportsBase(base?: string): boolean;
-    /**
-     * Bring a repository name into its normal form by removing any clutter.
-     * Like .git suffix or #branch names.
-     * @param {string} name
-     * @param {boolean} forLookup
-     * @return {string|undefined} normalized name
-     */
-    normalizeRepositoryName(name: string, forLookup: boolean): string | undefined;
-    /**
-     * Bring a group name into its normal form by removing any clutter.
-     * Like .git suffix or #branch names.
-     * @param {string} name
-     * @param {boolean} forLookup
-     * @return {string|undefined} normalized name
-     */
-    normalizeGroupName(name: string, forLookup: boolean): string | undefined;
-    /**
-     * Are repository names case sensitive.
-     * Overwrite and return false if you want to have case insensitive repository lookup.
-     * @return {boolean} true
-     */
-    get areRepositoryNamesCaseSensitive(): boolean;
-    /**
-     * Are repositroy group names case sensitive.
-     * Overwrite and return false if you want to have case insensitive group lookup.
-     * @return {boolean} true
-     */
-    get areGroupNamesCaseSensitive(): boolean;
-    /**
-     * Parses repository name and tries to split it into
-     * base, group, repository and branch.
-     * @param {string} [name]
-     * @param {string} focus where lies the focus if only one path component is given
-     * @returns {DecodedRepositoryName} result
-     */
-    parseName(name?: string, focus?: string): DecodedRepositoryName;
-    /**
-     * Create a repository.
-     * @param {string} name of group and repository
-     * @param {Object} [options]
-     * @returns {Promise<Repository>}
-     */
-    createRepository(name: string, options?: any): Promise<Repository>;
-    /**
-     * List provider objects of a given type.
-     *
-     * @param {string} type name of the method to deliver typed iterator projects,milestones,hooks,repositories,branches,tags
-     * @param {string[]} patterns group / repository filter
-     * @return {AsyncIterable<Repository|PullRequest|Branch|Tag|Project|Milestone|Hook>} all matching repositories of the providers
-     */
-    list(type: string, patterns: string[]): AsyncIterable<Repository | PullRequest | Branch | Tag | Project | Milestone | Hook>;
-    /**
-     * List projects.
-     * @param {string[]|string} [patterns]
-     * @return {AsyncIterable<Project>} all matching projects of the provider
-     */
-    projects(patterns?: string[] | string): AsyncIterable<Project>;
-    /**
-     * List milestones.
-     * @param {string[]|string} [patterns]
-     * @return {AsyncIterable<Milestone>} all matching milestones of the provider
-     */
-    milestones(patterns?: string[] | string): AsyncIterable<Milestone>;
-    /**
-     * List repositories.
-     * @param {string[]|string} [patterns]
-     * @return {AsyncIterable<Repository>} all matching repos of the provider
-     */
-    repositories(patterns?: string[] | string): AsyncIterable<Repository>;
-    /**
-     * List branches.
-     * @param {string[]|string} [patterns]
-     * @return {AsyncIterable<Branch>} all matching branches of the provider
-     */
-    branches(patterns?: string[] | string): AsyncIterable<Branch>;
-    /**
-     * List tags.
-     * @param {string[]|string} [patterns]
-     * @return {AsyncIterable<Tag>} all matching tags of the provider
-     */
-    tags(patterns?: string[] | string): AsyncIterable<Tag>;
-    /**
-     * List hooks.
-     * @param {string[]|string} [patterns]
-     * @return {AsyncIterable<Hook>} all matching hooks of the provider
-     */
-    hooks(patterns?: string[] | string): AsyncIterable<Hook>;
-    /**
-     * List pull requests.
-     * @param {string[]|string} [patterns]
-     * @return {AsyncIterable<PullRequest>} all matching pullRequests of the provider
-     */
-    pullRequests(patterns?: string[] | string): AsyncIterable<PullRequest>;
-    /**
-     * Deliver the provider name.
-     * @return {string} class name by default
-     */
-    get name(): string;
-    /**
-     * We are our own provider.
-     * @return {BaseProvider} this
-     */
-    get provider(): BaseProvider;
-    /**
-     * List all defined entries from attributes.
-     * @return {{name: string}}
-     */
-    toJSON(): {
-        name: string;
-    };
-    initializeRepositories(): void;
-    trace(...args: any[]): any;
-    debug(...args: any[]): any;
-    info(...args: any[]): any;
-    warn(...args: any[]): any;
-    error(...args: any[]): any;
-    get repositoryGroupClass(): typeof RepositoryGroup;
-    get hookClass(): typeof Hook;
-    get repositoryClass(): typeof Repository;
-    get branchClass(): typeof Branch;
-    get tagClass(): typeof Tag;
-    get pullRequestClass(): typeof PullRequest;
-}
-export type Project = import("./project.mjs").Project;
-export type Milestone = import("./milestone.mjs").Milestone;
-export type DecodedRepositoryName = {
-    base?: string;
-    group?: string;
-    repository?: string;
-    branch?: string;
-};
-/**
- * Endpoint to deliver log messages to.
- */
-export type MessageDestination = {
-    info: (arg0: string) => void;
-    debug: (arg0: string) => void;
-    warn: (arg0: string) => void;
-    error: (arg0: string) => void;
-    trace: (arg0: string) => void;
-};
-import { BaseObject } from "./base-object.mjs";
-import { Repository } from "./repository.mjs";
-import { PullRequest } from "./pull-request.mjs";
-import { Branch } from "./branch.mjs";
-import { Tag } from "./tag.mjs";
-import { Hook } from "./hook.mjs";
-import { RepositoryGroup } from "./repository-group.mjs";

package/types/branch.d.mts

@@ -1,74 +0,0 @@
-/**
- * Abstract branch.
- * @class Branch
- * @see {@link Repository#_addBranch}
- * @param {RepositoryOwner} owner
- * @param {string} name
- * @param {Object} options
- *
- * @property {Repository} repository
- * @property {Provider} provider
- * @property {string} name
- */
-export class Branch extends Ref {
-    /**
-     * Delete the branch from the {@link Repository}.
-     * @see {@link Repository#deleteBranch}
-     * @return {Promise<any>}
-     */
-    delete(): Promise<any>;
-    /**
-     * Commit entries.
-     * @param {string} message commit message
-     * @param {ContentEntry[]} updates content to be commited
-     * @param {Object} options
-     * @return {Promise<CommitResult|undefined>}
-     */
-    commit(message: string, updates: ContentEntry[], options: any): Promise<CommitResult | undefined>;
-    /**
-     * Add commits into a pull request.
-     *
-     * @param {Commit|AsyncGenerator<Commit>} commits to be commited
-     * @param {Object} options
-     * @param {Branch|string} options.pullRequestBranch to commit into
-     * @param {boolean} [options.dry=false] do not create a branch and do not commit only create dummy PR
-     * @param {boolean} options.skipWithoutCommits do not create a PR if no commits are given
-     * @param {boolean} options.bodyFromCommitMessages generate body from commit messages
-     * @param {string} [options.body] body of the PR
-     * @return {Promise<PullRequest>}
-     */
-    commitIntoPullRequest(commits: Commit | AsyncGenerator<Commit>, options: {
-        pullRequestBranch: Branch | string;
-        dry?: boolean;
-        skipWithoutCommits: boolean;
-        bodyFromCommitMessages: boolean;
-        body?: string;
-    }): Promise<PullRequest>;
-    /**
-     * Remove entries form the branch.
-     * @param {AsyncIterable<ContentEntry>} entries
-     */
-    removeEntries(entries: AsyncIterable<ContentEntry>): Promise<void>;
-    /**
-     * Create a pull request.
-     * @param {Branch} toBranch
-     * @param {Object} [options]
-     * @return {Promise<PullRequest>}
-     */
-    createPullRequest(toBranch: Branch, options?: any): Promise<PullRequest>;
-    _addPullRequest(pullRequest: any): Promise<void>;
-    deletePullRequest(name: any): Promise<any>;
-    /**
-     * Create a new {@link Branch} by cloning a given source branch.
-     * Simply calls Repository.createBranch() with the receiver as source branch
-     * @param {string} name the new branch
-     * @param {Object} [options] passed through
-     * @return {Promise<Branch>} newly created branch (or already present old one with the same name)
-     */
-    createBranch(name: string, options?: any): Promise<Branch>;
-}
-import { Ref } from "./ref.mjs";
-import { ContentEntry } from "content-entry";
-import { CommitResult } from "./commit.mjs";
-import { Commit } from "./commit.mjs";
-import { PullRequest } from "./pull-request.mjs";

package/types/commit.d.mts

@@ -1,35 +0,0 @@
-/**
- * @property {string} ref
- */
-export class CommitResult {
-    constructor(ref: any);
-    ref: any;
-}
-export class User {
-}
-/**
- * @property {Repository} repository
- * @property {string} message
- * @property {string} sha
- * @property {User} author
- * @property {User} committer
- */
-export class Commit {
-    /**
-     *
-     * @param {Repository} repository
-     * @param {Object} options
-     * @param {string} options.sha
-     * @param {string} options.message
-     * @param {string} options.author
-     * @param {string} options.committer
-     */
-    constructor(repository: Repository, options: {
-        sha: string;
-        message: string;
-        author: string;
-        committer: string;
-    });
-    repository: Repository;
-}
-import { Repository } from "./repository.mjs";

package/types/hook.d.mts

@@ -1,73 +0,0 @@
-/**
- * Repository hook.
- */
-export class Hook extends OwnedObject {
-    static defaultEvents: Set<string>;
-    static attributes: {
-        active: import("pacc").AttributeDefinition;
-        secret: import("pacc").AttributeDefinition;
-        url: {
-            description: string;
-            type: object;
-            isKey: boolean;
-            writable: boolean;
-            mandatory: boolean;
-            collection: boolean;
-            private?: boolean;
-            depends?: string;
-            default?: any;
-            set?: Function;
-            get?: Function;
-            prepareValue?: Function;
-            values?: Set<any>;
-            externalName?: string;
-            env?: string[] | string;
-            additionalValues?: object;
-        };
-        content_type: {
-            default: string;
-            type: object;
-            isKey: boolean;
-            writable: boolean;
-            mandatory: boolean;
-            collection: boolean;
-            private?: boolean;
-            depends?: string;
-            description?: string;
-            set?: Function;
-            get?: Function;
-            prepareValue?: Function;
-            values?: Set<any>;
-            externalName?: string;
-            env?: string[] | string;
-            additionalValues?: object;
-        };
-        insecure_ssl: import("pacc").AttributeDefinition;
-        events: {
-            default: Set<string>;
-            type: object;
-            isKey: boolean;
-            writable: boolean;
-            mandatory: boolean;
-            collection: boolean;
-            private?: boolean;
-            depends?: string;
-            description?: string;
-            set?: Function;
-            get?: Function;
-            prepareValue?: Function;
-            values?: Set<any>;
-            externalName?: string;
-            env?: string[] | string;
-            additionalValues?: object;
-        };
-        name: import("pacc").AttributeDefinition;
-        id: import("pacc").AttributeDefinition;
-        description: import("pacc").AttributeDefinition;
-    };
-    static get delteteMethodName(): string;
-    set events(value: Set<any>);
-    get events(): Set<any>;
-    _events: any;
-}
-import { OwnedObject } from "./owned-object.mjs";

package/types/index.d.mts

@@ -1,21 +0,0 @@
-export * from "./base-object.mjs";
-export * from "./named-object.mjs";
-export * from "./repository-owner.mjs";
-export * from "./single-group-provider.mjs";
-export * from "./multi-group-provider.mjs";
-export * from "./repository-group.mjs";
-export * from "./repository.mjs";
-export * from "./commit.mjs";
-export * from "./branch.mjs";
-export * from "./tag.mjs";
-export * from "./project.mjs";
-export * from "./issue.mjs";
-export * from "./pull-request.mjs";
-export * from "./hook.mjs";
-export * from "./milestone.mjs";
-export * from "./review.mjs";
-export * from "./application.mjs";
-export * from "./util.mjs";
-export { OwnedObject } from "./owned-object.mjs";
-export { BaseProvider } from "./base-provider.mjs";
-export { Ref } from "./ref.mjs";

package/types/issue.d.mts

@@ -1,10 +0,0 @@
-/**
- *
- */
-export class Issue extends OwnedObject {
-    labels(): AsyncGenerator<never, void, unknown>;
-    assignees(): AsyncGenerator<never, void, unknown>;
-    assignee(): Promise<void>;
-    milestone(): Promise<void>;
-}
-import { OwnedObject } from "./owned-object.mjs";

package/types/milestone.d.mts

@@ -1,12 +0,0 @@
-/**
- */
-export class Milestone extends OwnedObject {
-    static attributes: {
-        state: import("pacc").AttributeDefinition;
-        name: import("pacc").AttributeDefinition;
-        id: import("pacc").AttributeDefinition;
-        description: import("pacc").AttributeDefinition;
-    };
-    issues(): AsyncGenerator<never, void, unknown>;
-}
-import { OwnedObject } from "./owned-object.mjs";