@northflank/js-client 0.4.1 → 0.5.0-beta.0

package/dist/endpoints/create/job/manual.d.ts

@@ -1,147 +0,0 @@
-/** WARNING: Autogenerated Code - do not modify! */
-import { ApiCallResponse, PostApiEndpoint } from '../../../api-endpoint';
-export declare type CreateJobManualResult = {
-    /** Identifier for the job Example: "example-job" */
-    'id': string;
-    /** Full identifier used for job deployment Example: "/example-user/default-project/example-job" */
-    'appId': string;
-    /** Job name Example: "Example Job" */
-    'name': string;
-    /** A short description of the job Example: "This is the job description" */
-    'description'?: string;
-    /** ID of the project that the service belongs to Example: "default-project" */
-    'projectId': string;
-    /** The time the job was created. Example: "2021-01-20T11:19:53.175Z" */
-    'createdAt': string;
-    'vcsData'?: {
-        /** URL of the repository being built Example: "https://github.com/northflank/gatsby-with-northflank" */
-        'projectUrl': string;
-        /** VCS provider for the repo being built Example: "github" */
-        'projectType': 'bitbucket' | 'gitlab' | 'github' | 'self-hosted';
-        /** ID of the self-hosted VCS, if applicable. Example: "example-team/self-hosted-vcs" */
-        'vcsId'?: string;
-        /** Branch of the repo being built Example: "master" */
-        'projectBranch'?: string;
-        /** Whether the repo is being accessed without authentication. */
-        'publicRepo'?: boolean;
-        /** Working directory used by the dockerfile Example: "/" */
-        'dockerWorkDir': string;
-        /** File path of the Dockerfile Example: "/Dockerfile" */
-        'dockerFilePath': string;
-    };
-    'buildEngineConfiguration'?: {
-        /** The build engine used. Example: "buildpack" */
-        'builder'?: 'buildpack' | 'kaniko' | 'buildkit';
-        'buildpack'?: {
-            /** The Buildpack stack used. Example: "HEROKU_20" */
-            'builder'?: 'HEROKU_20' | 'HEROKU_18' | 'GOOGLE_V1' | 'CNB_ALPINE' | 'CNB_BIONIC' | 'PAKETO_TINY';
-            /** Array of custom Buildpacks used. */
-            'buildpackLocators'?: string[];
-        };
-    };
-    /** Whether Continuous Integration is disabled */
-    'disabledCI': boolean;
-    /** Whether Continuous Deployment is disabled */
-    'disabledCD': boolean;
-    'deployment'?: {
-        /** Region where this job is deployed and built Example: "europe-west" */
-        'region'?: string;
-    };
-    'billing': {
-        /** ID of the billing plan used by this job Example: "nf-compute-20" */
-        'deploymentPlan': string;
-    };
-    /** Type of the job (manual or cron) Example: "manual" */
-    'jobType': 'cron' | 'manual';
-    /** Job settings */
-    'settings': {
-        /** The number of attempts to rerun a job before it is marked as failed. */
-        'backoffLimit': number;
-        /** The maximum amount of time, in seconds, for a job to run before it is marked as failed. Example: 600 */
-        'activeDeadlineSeconds': number;
-        'cron'?: any;
-    };
-    /** Whether the job will be built immediately Example: true */
-    'buildInitiated': boolean;
-};
-export declare type CreateJobManualCall = (opts: CreateJobManualRequest) => Promise<ApiCallResponse<CreateJobManualResult>>;
-export declare type CreateJobManualRequest = {
-    parameters: CreateJobManualParameters;
-    data: CreateJobManualData;
-};
-export declare type CreateJobManualParameters = {
-    /** ID of the project */ 'projectId': string;
-};
-export declare type CreateJobManualData = {
-    /** The name of the job. Example: "Example Job" */
-    'name': string;
-    /** A description of the job. Example: "A job description" */
-    'description'?: string;
-    'billing': {
-        /** The ID of the deployment plan to use. Example: "nf-compute-20" */
-        'deploymentPlan': string;
-    };
-    /** The number of attempts to rerun a job before it is marked as failed. */
-    'backoffLimit': number;
-    /** The maximum amount of time, in seconds, for a job to run before it is marked as failed. Example: 600 */
-    'activeDeadlineSeconds'?: number;
-    /** Where to deploy the job from. */
-    'deployment'?: {
-        'vcs': {
-            /** URL of the Git repo to build. Example: "https://github.com/northflank/gatsby-with-northflank" */
-            'projectUrl': string;
-            /** The VCS provider to use. Example: "github" */
-            'projectType': 'bitbucket' | 'gitlab' | 'github' | 'self-hosted';
-            /** If projectType is self-hosted, the ID of the self-hosted vcs to use. */
-            'vcsId'?: string;
-            /** The name of the branch to use. Example: "master" */
-            'projectBranch': string;
-        };
-    } | {
-        'external': {
-            /** Path of the external image excluding the hostname Example: "nginx:latest" */
-            'imagePath': string;
-            /** ID of the saved credentials to use to access this external image. Example: "example-credentials" */
-            'credentials'?: string;
-        };
-    } | {
-        'internal': {
-            /** ID of the build service to deploy Example: "example-build-service" */
-            'id'?: string;
-            /** Branch to deploy Example: "master" */
-            'branch'?: string;
-            /** Commit SHA to deploy, or 'latest' to deploy the most recent commit Example: "latest" */
-            'buildSHA'?: any;
-        };
-    };
-    'buildSettings'?: {
-        'dockerfile': {
-            /** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
-            'buildEngine'?: 'kaniko' | 'buildkit';
-            /** The file path of the Dockerfile. Example: "/Dockerfile" */
-            'dockerFilePath': string;
-            /** The working directory of the Dockerfile. Example: "/" */
-            'dockerWorkDir': string;
-        };
-    } | {
-        'buildpack': {
-            /** Buildpack stack to use. Defaults to recommended stack `HEROKU_20`. Example: "HEROKU_20" */
-            'builder'?: 'HEROKU_20' | 'HEROKU_18' | 'GOOGLE_V1' | 'CNB_ALPINE' | 'CNB_BIONIC' | 'PAKETO_TINY';
-            /** Array of custom Buildpacks to use. */
-            'buildpackLocators'?: string[];
-            /** The working directory to build in. Example: "/" */
-            'buildContext'?: string;
-        };
-    };
-    /** An object containing the environment variables to set for the job. Example: {"variable1":"abcdef","variable2":"12345"} */
-    'environment'?: any;
-    /** An object containing the build arguments to set for the job. Example: {"variable1":"abcdef","variable2":"12345"} */
-    'buildArguments'?: any;
-};
-/** Creates a new manual job that only runs when initiated via the UI, CLI, API or JS client. */
-export declare class CreateJobManualEndpoint extends PostApiEndpoint<CreateJobManualRequest, CreateJobManualResult> {
-    description: string;
-    withAuth: boolean;
-    endpointUrl: (opts: CreateJobManualRequest) => string;
-    body: (payload: CreateJobManualRequest) => string;
-}

package/dist/endpoints/create/job/manual.js

@@ -1,36 +0,0 @@
-"use strict";
-/** WARNING: Autogenerated Code - do not modify! */
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CreateJobManualEndpoint = void 0;
-var api_endpoint_1 = require("../../../api-endpoint");
-/** Creates a new manual job that only runs when initiated via the UI, CLI, API or JS client. */
-var CreateJobManualEndpoint = /** @class */ (function (_super) {
-    __extends(CreateJobManualEndpoint, _super);
-    function CreateJobManualEndpoint() {
-        var _this = _super !== null && _super.apply(this, arguments) || this;
-        _this.description = 'Creates a new manual job that only runs when initiated via the UI, CLI, API or JS client.';
-        _this.withAuth = true;
-        _this.endpointUrl = function (opts) {
-            return "/v1/projects/" + opts.parameters.projectId + "/jobs/manual";
-        };
-        _this.body = function (payload) { return JSON.stringify(payload.data); };
-        return _this;
-    }
-    return CreateJobManualEndpoint;
-}(api_endpoint_1.PostApiEndpoint));
-exports.CreateJobManualEndpoint = CreateJobManualEndpoint;

package/dist/endpoints/create/project.d.ts

@@ -1,29 +0,0 @@
-/** WARNING: Autogenerated Code - do not modify! */
-import { ApiCallResponse, PostApiEndpoint } from '../../api-endpoint';
-export declare type CreateProjectResult = {
-    /** Boolean flag that the operation was successful. Example: true */
-    'success': boolean;
-    /** ID for the created project. Example: "default-project" */
-    'id': string;
-};
-export declare type CreateProjectCall = (opts: CreateProjectRequest) => Promise<ApiCallResponse<CreateProjectResult>>;
-export declare type CreateProjectRequest = {
-    data: CreateProjectData;
-};
-export declare type CreateProjectData = {
-    /** The name of the project. Example: "New Project" */
-    'name': string;
-    /** The description of the project. Example: "This is a new project." */
-    'description'?: string;
-    /** The region the project will be hosted in. Example: "europe-west" */
-    'region': string;
-    /** The color of the project in the Northflank App. Example: "#EF233C" */
-    'color'?: string;
-};
-/** Creates a new project. */
-export declare class CreateProjectEndpoint extends PostApiEndpoint<CreateProjectRequest, CreateProjectResult> {
-    description: string;
-    withAuth: boolean;
-    endpointUrl: (opts: CreateProjectRequest) => string;
-    body: (payload: CreateProjectRequest) => string;
-}

package/dist/endpoints/create/project.js

@@ -1,36 +0,0 @@
-"use strict";
-/** WARNING: Autogenerated Code - do not modify! */
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CreateProjectEndpoint = void 0;
-var api_endpoint_1 = require("../../api-endpoint");
-/** Creates a new project. */
-var CreateProjectEndpoint = /** @class */ (function (_super) {
-    __extends(CreateProjectEndpoint, _super);
-    function CreateProjectEndpoint() {
-        var _this = _super !== null && _super.apply(this, arguments) || this;
-        _this.description = 'Creates a new project.';
-        _this.withAuth = true;
-        _this.endpointUrl = function (opts) {
-            return "/v1/projects";
-        };
-        _this.body = function (payload) { return JSON.stringify(payload.data); };
-        return _this;
-    }
-    return CreateProjectEndpoint;
-}(api_endpoint_1.PostApiEndpoint));
-exports.CreateProjectEndpoint = CreateProjectEndpoint;

package/dist/endpoints/create/secret.d.ts

@@ -1,79 +0,0 @@
-/** WARNING: Autogenerated Code - do not modify! */
-import { ApiCallResponse, PostApiEndpoint } from '../../api-endpoint';
-export declare type CreateSecretResult = {
-    /** Identifier for the secret group Example: "example-secret-group" */
-    'id': string;
-    /** Secret group name Example: "Example secret group" */
-    'name': string;
-    /** A short description of the secret group Example: "This is the secret group description" */
-    'description'?: string;
-    /** The type of the created secret group Example: "environment" */
-    'secretType': 'environment' | 'arguments';
-    /** ID of the project that the secret group belongs to Example: "default-project" */
-    'projectId': string;
-    /** The priority with which different secret groups will be merged Example: 10 */
-    'priority': number;
-    /** Restriction settings of the secret */
-    'restrictions': {
-        /** Is the secret restricted Example: true */
-        'restricted'?: boolean;
-        /** List of Northflank services & jobs the secret is restricted to */
-        'nfObjects'?: {
-            /** ID of the entity the secret is restricted to. Example: "example-service" */
-            'id': string;
-            /** Type of the entity the secret is restricted to. Example: "service" */
-            'type': 'service' | 'job';
-        }[];
-    };
-} | any;
-export declare type CreateSecretCall = (opts: CreateSecretRequest) => Promise<ApiCallResponse<CreateSecretResult>>;
-export declare type CreateSecretRequest = {
-    parameters: CreateSecretParameters;
-    data: CreateSecretData;
-};
-export declare type CreateSecretParameters = {
-    /** ID of the project */ 'projectId': string;
-};
-export declare type CreateSecretData = {
-    /** The name of the secret. Example: "Example Secret" */
-    'name': string;
-    /** A description of the secret. Example: "A description" */
-    'description'?: string;
-    /** The type of the created secret Example: "environment" */
-    'secretType': 'environment' | 'arguments';
-    /** The priority with which different secrets will be merged. Example: 10 */
-    'priority': number;
-    /** Restriction settings of the secret */
-    'restrictions'?: {
-        /** Is the secret restricted Example: true */
-        'restricted'?: boolean;
-        /** List of Northflank services & jobs the secret is restricted to */
-        'nfObjects'?: {
-            /** ID of the entity the secret is restricted to. Example: "example-service" */
-            'id': string;
-            /** Type of the entity the secret is restricted to. Example: "service" */
-            'type': 'service' | 'job';
-        }[];
-    };
-    /** An array of addons to link to this secret group. */
-    'addonDependencies'?: {
-        /** The internal id of the addon to link. Example: "example-addon" */
-        'addonId': string;
-        /** An array of objects containing details about the keys to link to this secret group. */
-        'keys': {
-            /** The name of the key to link. Example: "username" */
-            'keyName': string;
-            /** An array of aliases for the key. */
-            'aliases'?: string[];
-        }[];
-    }[];
-    /** Secret contents as JSON object, encrypted at rest Example: {"NODE_ENV":"production","MONGO_DB":"some_connection_string"} */
-    'data'?: any;
-};
-/** Creates a secret with the specified payload */
-export declare class CreateSecretEndpoint extends PostApiEndpoint<CreateSecretRequest, CreateSecretResult> {
-    description: string;
-    withAuth: boolean;
-    endpointUrl: (opts: CreateSecretRequest) => string;
-    body: (payload: CreateSecretRequest) => string;
-}

package/dist/endpoints/create/secret.js

@@ -1,36 +0,0 @@
-"use strict";
-/** WARNING: Autogenerated Code - do not modify! */
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CreateSecretEndpoint = void 0;
-var api_endpoint_1 = require("../../api-endpoint");
-/** Creates a secret with the specified payload */
-var CreateSecretEndpoint = /** @class */ (function (_super) {
-    __extends(CreateSecretEndpoint, _super);
-    function CreateSecretEndpoint() {
-        var _this = _super !== null && _super.apply(this, arguments) || this;
-        _this.description = 'Creates a secret with the specified payload';
-        _this.withAuth = true;
-        _this.endpointUrl = function (opts) {
-            return "/v1/projects/" + opts.parameters.projectId + "/secrets";
-        };
-        _this.body = function (payload) { return JSON.stringify(payload.data); };
-        return _this;
-    }
-    return CreateSecretEndpoint;
-}(api_endpoint_1.PostApiEndpoint));
-exports.CreateSecretEndpoint = CreateSecretEndpoint;

package/dist/endpoints/create/service/build.d.ts

@@ -1,116 +0,0 @@
-/** WARNING: Autogenerated Code - do not modify! */
-import { ApiCallResponse, PostApiEndpoint } from '../../../api-endpoint';
-export declare type CreateServiceBuildResult = {
-    /** Identifier for the service Example: "example-service" */
-    'id': string;
-    /** Full identifier used for service deployment Example: "/example-user/default-project/example-service" */
-    'appId': string;
-    /** Service name Example: "Example Service" */
-    'name': string;
-    /** A short description of the service Example: "This is the service description" */
-    'description'?: string;
-    /** ID of the project that the service belongs to Example: "default-project" */
-    'projectId': string;
-    /** The time the service was created. Example: "2021-01-20T11:19:53.175Z" */
-    'createdAt': string;
-    /** Whether Continuous Integration is disabled */
-    'disabledCI': boolean;
-    /** Whether Continuous Deployment is disabled */
-    'disabledCD': boolean;
-    'billing': {
-        /** ID of the billing plan used by this service Example: "nf-compute-20" */
-        'deploymentPlan': string;
-    };
-    /** Type of the service (combined, build or deployment) Example: "build" */
-    'serviceType': 'combined' | 'build' | 'deployment';
-    'vcsData'?: {
-        /** URL of the repository being built Example: "https://github.com/northflank/gatsby-with-northflank" */
-        'projectUrl': string;
-        /** VCS provider for the repo being built Example: "github" */
-        'projectType': 'bitbucket' | 'gitlab' | 'github' | 'self-hosted';
-        /** ID of the self-hosted VCS, if applicable. Example: "example-team/self-hosted-vcs" */
-        'vcsId'?: string;
-        /** Branch of the repo being built Example: "master" */
-        'projectBranch'?: string;
-        /** Whether the repo is being accessed without authentication. */
-        'publicRepo'?: boolean;
-        /** Working directory used by the dockerfile Example: "/" */
-        'dockerWorkDir': string;
-        /** File path of the Dockerfile Example: "/Dockerfile" */
-        'dockerFilePath': string;
-    };
-    'buildConfiguration'?: {
-        'branchRestrictions': string[];
-        'prRestrictions': string[];
-    };
-    'buildEngineConfiguration': {
-        /** The build engine used. Example: "buildpack" */
-        'builder'?: 'buildpack' | 'kaniko' | 'buildkit';
-        'buildpack'?: {
-            /** The Buildpack stack used. Example: "HEROKU_20" */
-            'builder'?: 'HEROKU_20' | 'HEROKU_18' | 'GOOGLE_V1' | 'CNB_ALPINE' | 'CNB_BIONIC' | 'PAKETO_TINY';
-            /** Array of custom Buildpacks used. */
-            'buildpackLocators'?: string[];
-        };
-    };
-} | any;
-export declare type CreateServiceBuildCall = (opts: CreateServiceBuildRequest) => Promise<ApiCallResponse<CreateServiceBuildResult>>;
-export declare type CreateServiceBuildRequest = {
-    parameters: CreateServiceBuildParameters;
-    data: CreateServiceBuildData;
-};
-export declare type CreateServiceBuildParameters = {
-    /** ID of the project */ 'projectId': string;
-};
-export declare type CreateServiceBuildData = {
-    /** The name of the service. Example: "Example Service" */
-    'name': string;
-    /** A description of the service. Example: "A service description" */
-    'description'?: string;
-    'billing': {
-        /** The ID of the deployment plan to use. Example: "nf-compute-20" */
-        'deploymentPlan': string;
-    };
-    'vcsData': {
-        /** URL of the Git repo to build. Example: "https://github.com/northflank/gatsby-with-northflank" */
-        'projectUrl': string;
-        /** The VCS provider to use. Example: "github" */
-        'projectType': 'bitbucket' | 'gitlab' | 'github' | 'self-hosted';
-        /** If projectType is self-hosted, the ID of the self-hosted vcs to use. */
-        'vcsId'?: string;
-    };
-    'buildSettings': {
-        'dockerfile': {
-            /** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
-            'buildEngine'?: 'kaniko' | 'buildkit';
-            /** The file path of the Dockerfile. Example: "/Dockerfile" */
-            'dockerFilePath': string;
-            /** The working directory of the Dockerfile. Example: "/" */
-            'dockerWorkDir': string;
-        };
-    } | {
-        'buildpack': {
-            /** Buildpack stack to use. Defaults to recommended stack `HEROKU_20`. Example: "HEROKU_20" */
-            'builder'?: 'HEROKU_20' | 'HEROKU_18' | 'GOOGLE_V1' | 'CNB_ALPINE' | 'CNB_BIONIC' | 'PAKETO_TINY';
-            /** Array of custom Buildpacks to use. */
-            'buildpackLocators'?: string[];
-            /** The working directory to build in. Example: "/" */
-            'buildContext'?: string;
-        };
-    };
-    'buildConfiguration'?: {
-        /** An array of pull request build rules. Each commit belonging to a pull request on a branch that matches one of the provided build rules will be built automatically. */
-        'prRestrictions'?: string[];
-        /** An array of branch build rules. Each commit belonging to a branch that matches one of the provided build rules will be built automatically. */
-        'branchRestrictions'?: string[];
-    };
-    /** An object containing the build arguments to set for the service Example: {"ARGUMENT_1":"abcdef","ARGUMENT_2":"12345"} */
-    'buildArguments'?: any;
-};
-/** Creates a new build service. */
-export declare class CreateServiceBuildEndpoint extends PostApiEndpoint<CreateServiceBuildRequest, CreateServiceBuildResult> {
-    description: string;
-    withAuth: boolean;
-    endpointUrl: (opts: CreateServiceBuildRequest) => string;
-    body: (payload: CreateServiceBuildRequest) => string;
-}

package/dist/endpoints/create/service/build.js

@@ -1,36 +0,0 @@
-"use strict";
-/** WARNING: Autogenerated Code - do not modify! */
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CreateServiceBuildEndpoint = void 0;
-var api_endpoint_1 = require("../../../api-endpoint");
-/** Creates a new build service. */
-var CreateServiceBuildEndpoint = /** @class */ (function (_super) {
-    __extends(CreateServiceBuildEndpoint, _super);
-    function CreateServiceBuildEndpoint() {
-        var _this = _super !== null && _super.apply(this, arguments) || this;
-        _this.description = 'Creates a new build service.';
-        _this.withAuth = true;
-        _this.endpointUrl = function (opts) {
-            return "/v1/projects/" + opts.parameters.projectId + "/services/build";
-        };
-        _this.body = function (payload) { return JSON.stringify(payload.data); };
-        return _this;
-    }
-    return CreateServiceBuildEndpoint;
-}(api_endpoint_1.PostApiEndpoint));
-exports.CreateServiceBuildEndpoint = CreateServiceBuildEndpoint;