@targetprocess/webhooks-client 1.0.0

package/bin/src/client.d.ts

@@ -0,0 +1,88 @@
+/*********************************************************************
+ * © Copyright IBM Corp. 2024
+ *********************************************************************/
+export interface IClient {
+    /**
+     * Notify about new deployments for specified cluster
+     * @param clusterName Cluster name
+     * @return OK
+     */
+    notifyDeployments(clusterName: string, deployments: IReleaseDeployment[]): Promise<void>;
+}
+export declare class Client implements IClient {
+    private http;
+    private baseUrl;
+    protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
+    constructor(baseUrl?: string, http?: {
+        fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
+    });
+    /**
+     * Notify about new deployments for specified cluster
+     * @param clusterName Cluster name
+     * @return OK
+     */
+    notifyDeployments(clusterName: string, deployments: IReleaseDeployment[]): Promise<void>;
+    protected processNotifyDeployments(response: Response): Promise<void>;
+}
+/** Helm release identifier */
+export interface IReleaseRef {
+    /** Release name */
+    name: string;
+}
+export interface IReleaseDeployment extends IReleaseRef {
+    chart: IChartRef;
+    namespace: INamespaceRef;
+    cluster: IClusterRef;
+    status: ReleaseStatus;
+    timestamp: Date;
+}
+/** Describe release status */
+export declare enum ReleaseStatus {
+    Unknown = "Unknown",
+    Deployed = "Deployed",
+    Deleted = "Deleted",
+    Supersede = "Supersede",
+    Failed = "Failed",
+    Deleting = "Deleting",
+    PendingInstall = "PendingInstall",
+    PendingUpgrade = "PendingUpgrade",
+    PendingRollback = "PendingRollback"
+}
+/** Cluster identifier */
+export interface IClusterRef {
+    /** Cluster name */
+    name: string;
+    /** Cluster tags array */
+    tags?: string[] | undefined;
+}
+/** Namespace identifier */
+export interface INamespaceRef {
+    /** Namespace name */
+    name: string;
+}
+/** Helm chart identifier */
+export interface IChartRef {
+    /** The name of the chart */
+    name: string;
+    /** A SemVer 2 compatible version string of the chart */
+    version: string;
+}
+export interface IErrorDto {
+    /** Error message */
+    message: string;
+}
+export declare class ApiException extends Error {
+    message: string;
+    status: number;
+    response: string;
+    headers: {
+        [key: string]: any;
+    };
+    result: any;
+    constructor(message: string, status: number, response: string, headers: {
+        [key: string]: any;
+    }, result: any);
+    protected isApiException: boolean;
+    static isApiException(obj: any): obj is ApiException;
+}
+//# sourceMappingURL=client.d.ts.map

package/bin/src/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":"AAAA;;uEAEuE;AAWvE,MAAM,WAAW,OAAO;IACtB;;;;OAIG;IACH,iBAAiB,CAAC,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,kBAAkB,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACzF;AAED,qBAAa,MAAO,YAAW,OAAO;IACpC,OAAO,CAAC,IAAI,CAAoE;IAChF,OAAO,CAAC,OAAO,CAAQ;IACvB,SAAS,CAAC,gBAAgB,EAAE,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,GAAG,CAAC,GAAG,SAAS,CAAY;gBAGpF,OAAO,CAAC,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE;QAAE,KAAK,CAAC,GAAG,EAAE,WAAW,EAAE,IAAI,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;KAAE;IAM3E;;;;OAIG;IACH,iBAAiB,CAAC,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,kBAAkB,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAsBxF,SAAS,CAAC,wBAAwB,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;CAqDtE;AAED,8BAA8B;AAC9B,MAAM,WAAW,WAAW;IAC1B,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,kBAAmB,SAAQ,WAAW;IACrD,KAAK,EAAE,SAAS,CAAA;IAChB,SAAS,EAAE,aAAa,CAAA;IACxB,OAAO,EAAE,WAAW,CAAA;IACpB,MAAM,EAAE,aAAa,CAAA;IACrB,SAAS,EAAE,IAAI,CAAA;CAChB;AAED,8BAA8B;AAC9B,oBAAY,aAAa;IACvB,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,SAAS,cAAc;IACvB,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,cAAc,mBAAmB;IACjC,cAAc,mBAAmB;IACjC,eAAe,oBAAoB;CACpC;AAED,yBAAyB;AACzB,MAAM,WAAW,WAAW;IAC1B,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,yBAAyB;IACzB,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;CAC5B;AAED,2BAA2B;AAC3B,MAAM,WAAW,aAAa;IAC5B,qBAAqB;IACrB,IAAI,EAAE,MAAM,CAAA;CACb;AAED,4BAA4B;AAC5B,MAAM,WAAW,SAAS;IACxB,4BAA4B;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,wDAAwD;IACxD,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,SAAS;IACxB,oBAAoB;IACpB,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,qBAAa,YAAa,SAAQ,KAAK;IACrC,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAA;IAC/B,MAAM,EAAE,GAAG,CAAA;gBAGT,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,EAC/B,MAAM,EAAE,GAAG;IAWb,SAAS,CAAC,cAAc,UAAO;IAE/B,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,YAAY;CAGrD"}

package/bin/src/client.js

@@ -0,0 +1,137 @@
+"use strict";
+/*********************************************************************
+ * © Copyright IBM Corp. 2024
+ *********************************************************************/
+// ----------------------
+// <auto-generated>
+//     Generated using the NSwag toolchain v13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0)) (http://NSwag.org)
+// </auto-generated>
+// ----------------------
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiException = exports.ReleaseStatus = exports.Client = void 0;
+class Client {
+    http;
+    baseUrl;
+    jsonParseReviver = undefined;
+    constructor(baseUrl, http) {
+        this.http = http ? http : window;
+        this.baseUrl = baseUrl !== undefined && baseUrl !== null ? baseUrl : '';
+    }
+    /**
+     * Notify about new deployments for specified cluster
+     * @param clusterName Cluster name
+     * @return OK
+     */
+    notifyDeployments(clusterName, deployments) {
+        let url_ = this.baseUrl + '/clusters/{clusterName}/deployments';
+        if (clusterName === undefined || clusterName === null)
+            throw new Error("The parameter 'clusterName' must be defined.");
+        url_ = url_.replace('{clusterName}', encodeURIComponent('' + clusterName));
+        url_ = url_.replace(/[?&]$/, '');
+        const content_ = JSON.stringify(deployments);
+        let options_ = {
+            body: content_,
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json'
+            }
+        };
+        return this.http.fetch(url_, options_).then((_response) => {
+            return this.processNotifyDeployments(_response);
+        });
+    }
+    processNotifyDeployments(response) {
+        const status = response.status;
+        let _headers = {};
+        if (response.headers && response.headers.forEach) {
+            response.headers.forEach((v, k) => (_headers[k] = v));
+        }
+        if (status === 200) {
+            return response.text().then(_responseText => {
+                return;
+            });
+        }
+        else if (status === 401) {
+            return response.text().then(_responseText => {
+                let result401 = null;
+                result401 =
+                    _responseText === ''
+                        ? null
+                        : JSON.parse(_responseText, this.jsonParseReviver);
+                return throwException('Unauthorized', status, _responseText, _headers, result401);
+            });
+        }
+        else if (status === 403) {
+            return response.text().then(_responseText => {
+                let result403 = null;
+                result403 =
+                    _responseText === ''
+                        ? null
+                        : JSON.parse(_responseText, this.jsonParseReviver);
+                return throwException('Forbidden', status, _responseText, _headers, result403);
+            });
+        }
+        else if (status === 404) {
+            return response.text().then(_responseText => {
+                return throwException('Not found', status, _responseText, _headers);
+            });
+        }
+        else if (status === 500) {
+            return response.text().then(_responseText => {
+                let result500 = null;
+                result500 =
+                    _responseText === ''
+                        ? null
+                        : JSON.parse(_responseText, this.jsonParseReviver);
+                return throwException('General error', status, _responseText, _headers, result500);
+            });
+        }
+        else if (status !== 200 && status !== 204) {
+            return response.text().then(_responseText => {
+                return throwException('An unexpected server error occurred.', status, _responseText, _headers);
+            });
+        }
+        return Promise.resolve(null);
+    }
+}
+exports.Client = Client;
+/** Describe release status */
+var ReleaseStatus;
+(function (ReleaseStatus) {
+    ReleaseStatus["Unknown"] = "Unknown";
+    ReleaseStatus["Deployed"] = "Deployed";
+    ReleaseStatus["Deleted"] = "Deleted";
+    ReleaseStatus["Supersede"] = "Supersede";
+    ReleaseStatus["Failed"] = "Failed";
+    ReleaseStatus["Deleting"] = "Deleting";
+    ReleaseStatus["PendingInstall"] = "PendingInstall";
+    ReleaseStatus["PendingUpgrade"] = "PendingUpgrade";
+    ReleaseStatus["PendingRollback"] = "PendingRollback";
+})(ReleaseStatus || (exports.ReleaseStatus = ReleaseStatus = {}));
+class ApiException extends Error {
+    message;
+    status;
+    response;
+    headers;
+    result;
+    constructor(message, status, response, headers, result) {
+        super();
+        this.message = message;
+        this.status = status;
+        this.response = response;
+        this.headers = headers;
+        this.result = result;
+    }
+    isApiException = true;
+    static isApiException(obj) {
+        return obj.isApiException === true;
+    }
+}
+exports.ApiException = ApiException;
+function throwException(message, status, response, headers, result) {
+    if (result !== null && result !== undefined)
+        throw result;
+    else
+        throw new ApiException(message, status, response, headers, null);
+}
+//# sourceMappingURL=client.js.map

package/bin/src/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":";AAAA;;uEAEuE;AACvE,yBAAyB;AACzB,mBAAmB;AACnB,4HAA4H;AAC5H,oBAAoB;AACpB,yBAAyB;;;AAezB,MAAa,MAAM;IACT,IAAI,CAAoE;IACxE,OAAO,CAAQ;IACb,gBAAgB,GAAmD,SAAS,CAAA;IAEtF,YACE,OAAgB,EAChB,IAAyE;QAEzE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAE,MAAc,CAAA;QACzC,IAAI,CAAC,OAAO,GAAG,OAAO,KAAK,SAAS,IAAI,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAA;IACzE,CAAC;IAED;;;;OAIG;IACH,iBAAiB,CAAC,WAAmB,EAAE,WAAiC;QACtE,IAAI,IAAI,GAAG,IAAI,CAAC,OAAO,GAAG,qCAAqC,CAAA;QAC/D,IAAI,WAAW,KAAK,SAAS,IAAI,WAAW,KAAK,IAAI;YACnD,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAA;QACjE,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,kBAAkB,CAAC,EAAE,GAAG,WAAW,CAAC,CAAC,CAAA;QAC1E,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;QAEhC,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAA;QAE5C,IAAI,QAAQ,GAAgB;YAC1B,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;aACnC;SACF,CAAA;QAED,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,SAAmB,EAAE,EAAE;YAClE,OAAO,IAAI,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAA;QACjD,CAAC,CAAC,CAAA;IACJ,CAAC;IAES,wBAAwB,CAAC,QAAkB;QACnD,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAA;QAC9B,IAAI,QAAQ,GAAQ,EAAE,CAAA;QACtB,IAAI,QAAQ,CAAC,OAAO,IAAI,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YACjD,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAM,EAAE,CAAM,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;QACjE,CAAC;QACD,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;YACnB,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE;gBAC1C,OAAM;YACR,CAAC,CAAC,CAAA;QACJ,CAAC;aAAM,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;YAC1B,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE;gBAC1C,IAAI,SAAS,GAAQ,IAAI,CAAA;gBACzB,SAAS;oBACP,aAAa,KAAK,EAAE;wBAClB,CAAC,CAAC,IAAI;wBACN,CAAC,CAAE,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,IAAI,CAAC,gBAAgB,CAAe,CAAA;gBACrE,OAAO,cAAc,CAAC,cAAc,EAAE,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAA;YACnF,CAAC,CAAC,CAAA;QACJ,CAAC;aAAM,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;YAC1B,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE;gBAC1C,IAAI,SAAS,GAAQ,IAAI,CAAA;gBACzB,SAAS;oBACP,aAAa,KAAK,EAAE;wBAClB,CAAC,CAAC,IAAI;wBACN,CAAC,CAAE,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,IAAI,CAAC,gBAAgB,CAAe,CAAA;gBACrE,OAAO,cAAc,CAAC,WAAW,EAAE,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAA;YAChF,CAAC,CAAC,CAAA;QACJ,CAAC;aAAM,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;YAC1B,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE;gBAC1C,OAAO,cAAc,CAAC,WAAW,EAAE,MAAM,EAAE,aAAa,EAAE,QAAQ,CAAC,CAAA;YACrE,CAAC,CAAC,CAAA;QACJ,CAAC;aAAM,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;YAC1B,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE;gBAC1C,IAAI,SAAS,GAAQ,IAAI,CAAA;gBACzB,SAAS;oBACP,aAAa,KAAK,EAAE;wBAClB,CAAC,CAAC,IAAI;wBACN,CAAC,CAAE,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,IAAI,CAAC,gBAAgB,CAAe,CAAA;gBACrE,OAAO,cAAc,CAAC,eAAe,EAAE,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAA;YACpF,CAAC,CAAC,CAAA;QACJ,CAAC;aAAM,IAAI,MAAM,KAAK,GAAG,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;YAC5C,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE;gBAC1C,OAAO,cAAc,CACnB,sCAAsC,EACtC,MAAM,EACN,aAAa,EACb,QAAQ,CACT,CAAA;YACH,CAAC,CAAC,CAAA;QACJ,CAAC;QACD,OAAO,OAAO,CAAC,OAAO,CAAO,IAAW,CAAC,CAAA;IAC3C,CAAC;CACF;AA7FD,wBA6FC;AAgBD,8BAA8B;AAC9B,IAAY,aAUX;AAVD,WAAY,aAAa;IACvB,oCAAmB,CAAA;IACnB,sCAAqB,CAAA;IACrB,oCAAmB,CAAA;IACnB,wCAAuB,CAAA;IACvB,kCAAiB,CAAA;IACjB,sCAAqB,CAAA;IACrB,kDAAiC,CAAA;IACjC,kDAAiC,CAAA;IACjC,oDAAmC,CAAA;AACrC,CAAC,EAVW,aAAa,6BAAb,aAAa,QAUxB;AA6BD,MAAa,YAAa,SAAQ,KAAK;IACrC,OAAO,CAAQ;IACf,MAAM,CAAQ;IACd,QAAQ,CAAQ;IAChB,OAAO,CAAwB;IAC/B,MAAM,CAAK;IAEX,YACE,OAAe,EACf,MAAc,EACd,QAAgB,EAChB,OAA+B,EAC/B,MAAW;QAEX,KAAK,EAAE,CAAA;QAEP,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;QACxB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAES,cAAc,GAAG,IAAI,CAAA;IAE/B,MAAM,CAAC,cAAc,CAAC,GAAQ;QAC5B,OAAO,GAAG,CAAC,cAAc,KAAK,IAAI,CAAA;IACpC,CAAC;CACF;AA5BD,oCA4BC;AAED,SAAS,cAAc,CACrB,OAAe,EACf,MAAc,EACd,QAAgB,EAChB,OAA+B,EAC/B,MAAY;IAEZ,IAAI,MAAM,KAAK,IAAI,IAAI,MAAM,KAAK,SAAS;QAAE,MAAM,MAAM,CAAA;;QACpD,MAAM,IAAI,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,CAAC,CAAA;AACvE,CAAC"}

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@targetprocess/webhooks-client",
+  "version": "1.0.0",
+  "description": "Client for the Octopus webhooks service",
+  "files": [
+    "bin/src"
+  ],
+  "main": "bin/src/client.js",
+  "typings": "bin/src/client.d.ts",
+  "scripts": {
+    "generate": "npm run _clean && npm run build",
+    "rebuild": "npm run _clean && npm run build",
+    "build": "tsc -b --pretty",
+    "_clean": "rimraf bin",
+    "prepublishOnly": "npm run rebuild"
+  },
+  "keywords": [
+    "sdk"
+  ],
+  "author": "Uladzimir Abramchuk <abramchuk@targetprocess.com>",
+  "license": "ISC",
+  "devDependencies": {
+    "@types/node": "^22.13.1"
+  },
+  "peerDependencies": {
+    "cross-fetch": "3.x"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/TargetProcess/ci-cd_octopus"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}