Merge pull request #250 from platformsh/feature/enviroment-domains

added creation, deletion and get custom or environment domains

Author: shakaman

src/index.ts

@@ -316,6 +316,18 @@ export default class Client {
     return entities.EnvironmentBackup.query({ projectId, environmentId });
   }
 
+  /**
+   * Get domains of environment {environmentId} of project {projectId}
+   *
+   * @param projectId
+   * @param environmentId
+   *
+   * @return Promise EnvironmentDomains[]
+   */
+  async getEnvironmentDomains(projectId: string, environmentId: string) {
+    return entities.EnvironmentDomain.query({ projectId, environmentId });
+  }
+
   /**
    * Get the integrations of project projectId
    *

src/model/EnvironmentDomain.ts

@@ -0,0 +1,74 @@
+import { getConfig } from "../config";
+
+import type { APIObject } from "./Ressource";
+import Ressource from "./Ressource";
+
+const paramDefaults = {};
+const modifiableField = ["is_default"];
+const _url = "/projects/:projectId/environments/:environmentId/domains";
+
+export type EnvironmentDomainGetParams = {
+  [index: string]: any;
+  name: string;
+  projectId?: string;
+  environmentId?: string;
+};
+
+export type EnvironmentDomainQueryParams = {
+  [index: string]: any;
+  projectId: string;
+  environmentId: string;
+};
+
+export default class EnvironmentDomain extends Ressource {
+  id = "";
+  name = "";
+  is_default = false;
+  created_at = "";
+  ssl = [];
+  updated_at = "";
+  replacement_for = "";
+  type = "";
+
+  constructor(environmentDomain: APIObject, url: string) {
+    super(
+      url,
+      paramDefaults,
+      {},
+      environmentDomain,
+      ["name", "ssl", "is_default", "type", "replacement_for"],
+      modifiableField
+    );
+    this._required = ["name"];
+  }
+
+  static async get(
+    params: EnvironmentDomainGetParams,
+    customUrl?: string
+  ): Promise<EnvironmentDomain> {
+    const { name, projectId, environmentId, ...queryParams } = params;
+    const { api_url } = getConfig();
+
+    return super._get<EnvironmentDomain>(
+      customUrl ? `${customUrl}/:name` : `${api_url}${_url}`,
+      { name, projectId, environmentId },
+      paramDefaults,
+      queryParams
+    );
+  }
+
+  static async query(
+    params: EnvironmentDomainQueryParams,
+    customUrl?: string
+  ): Promise<EnvironmentDomain[]> {
+    const { projectId, environmentId, ...queryParams } = params;
+    const { api_url } = getConfig();
+
+    return super._query(
+      customUrl ?? `${api_url}${_url}`,
+      { projectId, environmentId },
+      paramDefaults,
+      queryParams
+    );
+  }
+}

src/model/Project.ts

@@ -1,14 +1,16 @@
 import "cross-fetch/polyfill"; // fetch api polyfill
-import parse_url from "parse_url";
 import path from "path";
 
+import parse_url from "parse_url";
+
 import request, { createEventSource } from "../api";
 import { getConfig } from "../config";
 
 import Activity from "./Activity";
 import Certificate from "./Certificate";
 import Domain from "./Domain";
 import Environment from "./Environment";
+import EnvironmentDomain from "./EnvironmentDomain";
 import Integration from "./Integration";
 import ProjectAccess from "./ProjectAccess";
 import ProjectLevelVariable from "./ProjectLevelVariable";
@@ -50,6 +52,7 @@ export default class Project extends Ressource {
   plan_uri = "";
   subscription: Subscription = new Subscription({});
   subscription_id = "";
+  environment_id = "";
   status = "";
   endpoint = "";
   repository: Repository = {
@@ -211,6 +214,63 @@ export default class Project extends Ressource {
     return Domain.query({ projectId: this.id, limit }, this.getLink("domains"));
   }
 
+  /**
+   * Get a list of environment domains for the project.
+   *
+   * @param int limit
+   *
+   * @return EnvironmentDomain[]
+   */
+  async getEnvironmentDomains(environmentId: string) {
+    return EnvironmentDomain.query(
+      { projectId: this.id, environmentId },
+      this.getLink(`environments/${environmentId}/domains`)
+    );
+  }
+
+  /**
+   * Add a environmentDomain to the environment project.
+   *
+   * @param string name
+   * @param string environmentId
+   * @param string type
+   * @param string replacement_for
+   * @param array  ssl
+   *
+   * @return Result
+   */
+  async addEnvironmentDomain(
+    name: string,
+    environmentId: string,
+    type = "replacement",
+    replacement_for?: string,
+    ssl?: never[]
+  ) {
+    const body: Partial<EnvironmentDomain> = { name, type, replacement_for };
+
+    if (ssl) {
+      body.ssl = ssl;
+    }
+
+    if (replacement_for) {
+      body.replacement_for = replacement_for;
+    } else {
+      body.is_default = true;
+    }
+
+    if (!replacement_for) {
+      body.is_default = true;
+    }
+    body.type = type;
+
+    const environmentDomain = new EnvironmentDomain(
+      body,
+      this.getLink(`environments/${environmentId}/domains`)
+    );
+
+    return environmentDomain.save();
+  }
+
   /**
    * Get a single domain of the project.
    *
@@ -307,8 +367,8 @@ export default class Project extends Ressource {
    *
    * @return Activity[]
    */
-  getActivities(types: Array<string>, starts_at?: Date) {
-    const startsAt = starts_at?.toISOString()
+  async getActivities(types: string[], starts_at?: Date) {
+    const startsAt = starts_at?.toISOString();
     const params = { type: types, starts_at: startsAt };
 
     return Activity.query(params, `${this.getUri()}/activities`);

src/model/index.ts

@@ -12,6 +12,7 @@ import Domain from "./Domain";
 import Environment from "./Environment";
 import EnvironmentAccess from "./EnvironmentAccess";
 import EnvironmentBackup from "./EnvironmentBackup";
+import EnvironmentDomain from "./EnvironmentDomain";
 import EnvironmentType from "./EnvironmentType";
 import Blob from "./git/Blob";
 import Commit from "./git/Commit";
@@ -64,6 +65,7 @@ export default {
   Domain,
   EnvironmentAccess,
   EnvironmentBackup,
+  EnvironmentDomain,
   Metrics,
   ProjectAccess,
   ProjectLevelVariable,