repository-provider/src/repository-group.mjs

abstract interface to git repository providers like github, bitbucket and gitlab

import {
  url_attribute,
  url_attribute_writable,
  boolean_attribute,
  type_attribute,
  active_attribute
} from "pacc";
import { RepositoryOwner } from "./repository-owner.mjs";
import { OwnedObject } from "./owned-object.mjs";
import { BaseProvider } from "./base-provider.mjs";

/**
 * Abstract repository collection.
 * @param {BaseProvider} provider
 * @param {string} name of the group
 * @param {Object} [options]
 * @param {string} [options.description] human readable description
 * @param {string} [options.id] internal id
 * @param {string} [options.url] home
 *
 * @property {BaseProvider} provider
 * @property {string} name
 */
export class RepositoryGroup extends RepositoryOwner(OwnedObject) {
  static get addMethodName() {
    return "_addRepositoryGroup";
  }

  static get deleteMethodName() {
    return "_deleteRepositoryGroup";
  }

  static get type() {
    return "repository-group";
  }

  static get collectionName() {
    return "repositoryGroups";
  }

  static attributes = {
    ...super.attributes,

    /**
     * Type of the repository group either User or Organization.
     */
    type: type_attribute,
    url: url_attribute,
    active: active_attribute,
    avatarURL: { ...url_attribute, externalName: "avatar_url" },
    isAdmin: { ...boolean_attribute, externalName: "is_admin" },
    /**
     * The url of home page.
     * @return {string}
     */
    homePageURL: { ...url_attribute_writable, externalName: "homepage" }
  };

  get isAdmin() {
    return false;
  }

  get areRepositoryNamesCaseSensitive() {
    return this.owner.areRepositoryNamesCaseSensitive;
  }

  get areRepositoryGroupNamesCaseSensitive() {
    return this.owner.areRepositoryGroupNamesCaseSensitive;
  }
}