@forge/cli-shared 3.2.3 → 3.3.0-next.0

package/out/graphql/graphql-types.js

@@ -1869,6 +1869,7 @@ var ShepherdAlertTemplateType;
     ShepherdAlertTemplateType["ConfluencePageExports"] = "CONFLUENCE_PAGE_EXPORTS";
     ShepherdAlertTemplateType["ConfluenceSpaceExports"] = "CONFLUENCE_SPACE_EXPORTS";
     ShepherdAlertTemplateType["CreatedAuthPolicy"] = "CREATED_AUTH_POLICY";
+    ShepherdAlertTemplateType["CreatedInstallation"] = "CREATED_INSTALLATION";
     ShepherdAlertTemplateType["CreatedPolicy"] = "CREATED_POLICY";
     ShepherdAlertTemplateType["CreatedSamlConfig"] = "CREATED_SAML_CONFIG";
     ShepherdAlertTemplateType["CreatedTunnel"] = "CREATED_TUNNEL";

package/out/graphql/minimal-graphql-runner.d.ts

@@ -2,14 +2,17 @@ import { GraphQLClient } from 'graphql-request';
 import { GraphQLError } from 'graphql-request/dist/types';
 import { Authenticator, AuthorizationHeader } from '../auth';
 import { CLIDetails } from '../index';
+import { BaseError, UserError } from '../shared';
 import { GraphQLRunner } from './graphql-client';
-export declare class GraphQLAuthenticationError extends Error {
+export declare class GraphQLAuthenticationError extends UserError {
 }
-export declare class OutdatedClientVersionError extends Error {
+export declare class OutdatedClientVersionError extends UserError {
     constructor();
 }
-export declare class GraphQLProviderServiceError extends Error {
-    constructor(errors: GraphQLError[], requestId?: string);
+export declare class GraphQLProviderServiceError extends BaseError {
+    private readonly userError;
+    constructor(userError: boolean, errors: GraphQLError[], requestId?: string);
+    isUserError(): boolean;
 }
 export declare class GraphqlError extends Error {
     constructor(data: any, requestId?: string);

package/out/graphql/minimal-graphql-runner.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"minimal-graphql-runner.d.ts","sourceRoot":"","sources":["../../src/graphql/minimal-graphql-runner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAC7D,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAG1D,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAC7D,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAItC,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAQjD,qBAAa,0BAA2B,SAAQ,KAAK;CAAG;AAIxD,qBAAa,0BAA2B,SAAQ,KAAK;;CAIpD;AAED,qBAAa,2BAA4B,SAAQ,KAAK;gBACxC,MAAM,EAAE,YAAY,EAAE,EAAE,SAAS,CAAC,EAAE,MAAM;CAGvD;AAED,qBAAa,YAAa,SAAQ,KAAK;gBACzB,IAAI,EAAE,GAAG,EAAE,SAAS,CAAC,EAAE,MAAM;CAG1C;AAED,qBAAa,oBAAqB,YAAW,aAAa;IAEtD,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,UAAU;gBAFV,aAAa,EAAE,aAAa,EAC5B,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,UAAU,GAAG,SAAS;IAGxC,GAAG,CAAC,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,UAAU;;;;IA+BjE,SAAS,CAAC,sBAAsB,CAAC,QAAQ,EAAE,MAAM,EAAE,mBAAmB,EAAE,mBAAmB;IAMpF,UAAU,CAAC,mBAAmB,EAAE,mBAAmB,GAAG;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE;IAWtF,OAAO,CAAC,aAAa;IAIrB,OAAO,CAAC,gBAAgB;YAIV,4BAA4B;IAgB1C,OAAO,CAAC,YAAY;CAUrB"}
+{"version":3,"file":"minimal-graphql-runner.d.ts","sourceRoot":"","sources":["../../src/graphql/minimal-graphql-runner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAC7D,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAG1D,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAC7D,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACtC,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAIjD,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAQjD,qBAAa,0BAA2B,SAAQ,SAAS;CAAG;AAI5D,qBAAa,0BAA2B,SAAQ,SAAS;;CAIxD;AAED,qBAAa,2BAA4B,SAAQ,SAAS;IAC5C,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAAT,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,EAAE,SAAS,CAAC,EAAE,MAAM;IAGpF,WAAW,IAAI,OAAO;CAG9B;AAED,qBAAa,YAAa,SAAQ,KAAK;gBACzB,IAAI,EAAE,GAAG,EAAE,SAAS,CAAC,EAAE,MAAM;CAG1C;AAED,qBAAa,oBAAqB,YAAW,aAAa;IAEtD,OAAO,CAAC,QAAQ,CAAC,aAAa;IAC9B,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,QAAQ,CAAC,UAAU;gBAFV,aAAa,EAAE,aAAa,EAC5B,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,UAAU,GAAG,SAAS;IAGxC,GAAG,CAAC,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,UAAU;;;;IAiCjE,SAAS,CAAC,sBAAsB,CAAC,QAAQ,EAAE,MAAM,EAAE,mBAAmB,EAAE,mBAAmB;IAMpF,UAAU,CAAC,mBAAmB,EAAE,mBAAmB,GAAG;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE;IAWtF,OAAO,CAAC,aAAa;IAIrB,OAAO,CAAC,gBAAgB;YAIV,4BAA4B;IAgB1C,OAAO,CAAC,YAAY;CAUrB"}

package/out/graphql/minimal-graphql-runner.js

@@ -2,20 +2,25 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MinimalGraphQLRunner = exports.GraphqlError = exports.GraphQLProviderServiceError = exports.OutdatedClientVersionError = exports.GraphQLAuthenticationError = void 0;
 const graphql_request_1 = require("graphql-request");
+const shared_1 = require("../shared");
 const ui_1 = require("../ui");
-class GraphQLAuthenticationError extends Error {
+class GraphQLAuthenticationError extends shared_1.UserError {
 }
 exports.GraphQLAuthenticationError = GraphQLAuthenticationError;
 const isOutdatedClientVersionError = (error) => { var _a; return (_a = error.message) === null || _a === void 0 ? void 0 : _a.includes('client version is outdated'); };
-class OutdatedClientVersionError extends Error {
+class OutdatedClientVersionError extends shared_1.UserError {
     constructor() {
         super(ui_1.Text.graphQL.outdatedClientVersion);
     }
 }
 exports.OutdatedClientVersionError = OutdatedClientVersionError;
-class GraphQLProviderServiceError extends Error {
-    constructor(errors, requestId) {
+class GraphQLProviderServiceError extends shared_1.BaseError {
+    constructor(userError, errors, requestId) {
         super(`${ui_1.Text.graphQL.error}: ${JSON.stringify(errors)}, requestId=${requestId || 'unknown'}`);
+        this.userError = userError;
+    }
+    isUserError() {
+        return this.userError;
     }
 }
 exports.GraphQLProviderServiceError = GraphQLProviderServiceError;
@@ -42,7 +47,8 @@ class MinimalGraphQLRunner {
             if (errors.find((e) => isOutdatedClientVersionError(e))) {
                 throw new OutdatedClientVersionError();
             }
-            throw new GraphQLProviderServiceError(errors, requestId);
+            const isUserError = status >= 400 && status < 500;
+            throw new GraphQLProviderServiceError(isUserError, errors, requestId);
         }
         if (status !== 200) {
             throw new GraphqlError(data, requestId);

package/out/graphql/mutation-aware-graphql-client.d.ts

@@ -1,11 +1,15 @@
 import { GraphQLClient } from './index';
 import { AvailableMutations, GraphQLRunner, MutationResult } from './graphql-client';
-export declare class UnexpectedGraphQlResponseError extends Error {
+import { BaseError } from '../shared';
+export declare class UnexpectedGraphQlResponseError extends BaseError {
 }
 export declare class GraphQlMutationError extends UnexpectedGraphQlResponseError {
     private readonly code;
-    constructor(message: string, code?: string);
+    private readonly statusCode;
+    constructor(message: string, code?: string, statusCode?: number);
     getCode: () => string;
+    getStatusCode: () => number | undefined;
+    isUserError(): boolean;
 }
 export declare class MutationAwareGraphQLClient implements GraphQLClient {
     private readonly runner;

package/out/graphql/mutation-aware-graphql-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mutation-aware-graphql-client.d.ts","sourceRoot":"","sources":["../../src/graphql/mutation-aware-graphql-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACxC,OAAO,EAAE,kBAAkB,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAErF,qBAAa,8BAA+B,SAAQ,KAAK;CAAG;AAC5D,qBAAa,oBAAqB,SAAQ,8BAA8B;IACtE,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAS;gBAElB,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM;IAK1C,OAAO,QAAO,MAAM,CAElB;CACH;AAED,qBAAa,0BAA2B,YAAW,aAAa;IAClD,OAAO,CAAC,QAAQ,CAAC,MAAM;gBAAN,MAAM,EAAE,aAAa;IAErC,MAAM,CAAC,MAAM,SAAS,MAAM,kBAAkB,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,UAAU;;;;IAuBhG,KAAK,CAAC,UAAU,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,UAAU;CAI/E"}
+{"version":3,"file":"mutation-aware-graphql-client.d.ts","sourceRoot":"","sources":["../../src/graphql/mutation-aware-graphql-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACxC,OAAO,EAAE,kBAAkB,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACrF,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAEtC,qBAAa,8BAA+B,SAAQ,SAAS;CAAG;AAChE,qBAAa,oBAAqB,SAAQ,8BAA8B;IACtE,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAS;IAC9B,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAqB;gBAEpC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM;IAM/D,OAAO,QAAO,MAAM,CAElB;IAEF,aAAa,QAAO,MAAM,GAAG,SAAS,CAEpC;IAEK,WAAW,IAAI,OAAO;CAG9B;AAED,qBAAa,0BAA2B,YAAW,aAAa;IAClD,OAAO,CAAC,QAAQ,CAAC,MAAM;gBAAN,MAAM,EAAE,aAAa;IAErC,MAAM,CAAC,MAAM,SAAS,MAAM,kBAAkB,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,UAAU;;;;IAuBhG,KAAK,CAAC,UAAU,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,UAAU;CAI/E"}

package/out/graphql/mutation-aware-graphql-client.js

@@ -1,16 +1,24 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MutationAwareGraphQLClient = exports.GraphQlMutationError = exports.UnexpectedGraphQlResponseError = void 0;
-class UnexpectedGraphQlResponseError extends Error {
+const shared_1 = require("../shared");
+class UnexpectedGraphQlResponseError extends shared_1.BaseError {
 }
 exports.UnexpectedGraphQlResponseError = UnexpectedGraphQlResponseError;
 class GraphQlMutationError extends UnexpectedGraphQlResponseError {
-    constructor(message, code) {
+    constructor(message, code, statusCode) {
         super(message);
         this.getCode = () => {
             return this.code;
         };
+        this.getStatusCode = () => {
+            return this.statusCode;
+        };
         this.code = code || 'GENERIC_GRAPHQL_MUTATION_ERROR';
+        this.statusCode = statusCode;
+    }
+    isUserError() {
+        return Boolean(this.statusCode && this.statusCode >= 400 && this.statusCode < 500);
     }
 }
 exports.GraphQlMutationError = GraphQlMutationError;

package/out/shared/error-handling.d.ts

@@ -1,7 +1,19 @@
 import { Logger } from '../ui';
-export declare class HiddenError extends Error {
+export declare class BaseError extends Error implements ErrorWithAnalytics {
+    getAttributes(): Record<string, any>;
+    isUserError(): boolean;
+}
+export declare class UserError extends BaseError {
+    isUserError(): boolean;
+}
+export declare class HiddenError extends BaseError {
 }
 export declare const exitOnError: (logger: Logger, error?: Error, hint?: string | null) => never;
 export declare const wrapError: (error: unknown) => Error;
 export declare const assertIsError: (error: unknown) => asserts error is Error;
+export interface ErrorWithAnalytics {
+    getAttributes: () => Record<string, string | string[] | boolean>;
+}
+export declare class ValidationError extends UserError {
+}
 //# sourceMappingURL=error-handling.d.ts.map

package/out/shared/error-handling.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"error-handling.d.ts","sourceRoot":"","sources":["../../src/shared/error-handling.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAG/B,qBAAa,WAAY,SAAQ,KAAK;CAAG;AAgBzC,eAAO,MAAM,WAAW,WAAY,MAAM,UAAU,KAAK,SAAS,MAAM,GAAG,IAAI,KAAG,KAgBjF,CAAC;AAOF,eAAO,MAAM,SAAS,UAAW,OAAO,KAAG,KAK1C,CAAC;AAMF,eAAO,MAAM,aAAa,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,OAAO,CAAC,KAAK,IAAI,KAIhE,CAAC"}
+{"version":3,"file":"error-handling.d.ts","sourceRoot":"","sources":["../../src/shared/error-handling.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAG/B,qBAAa,SAAU,SAAQ,KAAM,YAAW,kBAAkB;IACzD,aAAa,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAKpC,WAAW,IAAI,OAAO;CAG9B;AAED,qBAAa,SAAU,SAAQ,SAAS;IAC/B,WAAW,IAAI,OAAO;CAG9B;AAED,qBAAa,WAAY,SAAQ,SAAS;CAAG;AAgB7C,eAAO,MAAM,WAAW,WAAY,MAAM,UAAU,KAAK,SAAS,MAAM,GAAG,IAAI,KAAG,KAgBjF,CAAC;AAOF,eAAO,MAAM,SAAS,UAAW,OAAO,KAAG,KAK1C,CAAC;AAMF,eAAO,MAAM,aAAa,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,OAAO,CAAC,KAAK,IAAI,KAIhE,CAAC;AAKF,MAAM,WAAW,kBAAkB;IACjC,aAAa,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,OAAO,CAAC,CAAC;CAClE;AAED,qBAAa,eAAgB,SAAQ,SAAS;CAAG"}

package/out/shared/error-handling.js

@@ -1,8 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.assertIsError = exports.wrapError = exports.exitOnError = exports.HiddenError = void 0;
+exports.ValidationError = exports.assertIsError = exports.wrapError = exports.exitOnError = exports.HiddenError = exports.UserError = exports.BaseError = void 0;
 const ui_1 = require("../ui");
-class HiddenError extends Error {
+class BaseError extends Error {
+    getAttributes() {
+        return {
+            isUserError: this.isUserError()
+        };
+    }
+    isUserError() {
+        return false;
+    }
+}
+exports.BaseError = BaseError;
+class UserError extends BaseError {
+    isUserError() {
+        return true;
+    }
+}
+exports.UserError = UserError;
+class HiddenError extends BaseError {
 }
 exports.HiddenError = HiddenError;
 function removePrefixFromErrorMessage(message) {
@@ -40,3 +57,6 @@ const assertIsError = (error) => {
     }
 };
 exports.assertIsError = assertIsError;
+class ValidationError extends UserError {
+}
+exports.ValidationError = ValidationError;

package/out/shared/installationId.js

@@ -2,11 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getInstallationId = void 0;
 const ui_1 = require("../ui");
-const ui_2 = require("../ui");
+const error_handling_1 = require("./error-handling");
 function trimInstallationId(installationId, throwError) {
     const trimmedId = installationId.trim();
     if (throwError && trimmedId.length === 0) {
-        throw new ui_2.ValidationError(ui_1.Text.installationId.errors.invalid);
+        throw new error_handling_1.ValidationError(ui_1.Text.installationId.errors.invalid);
     }
     return trimmedId;
 }

package/out/shared/validate.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateSite = void 0;
 const url_1 = require("url");
 const ui_1 = require("../ui");
-const ui_2 = require("../ui");
+const error_handling_1 = require("./error-handling");
 const product_1 = require("./product");
 const validateSite = (site, product) => {
     const trySites = [site, `https://${site}`];
@@ -19,6 +19,6 @@ const validateSite = (site, product) => {
         catch (_a) {
         }
     }
-    throw new ui_2.ValidationError(ui_1.Text.error.invalidSite);
+    throw new error_handling_1.ValidationError(ui_1.Text.error.invalidSite);
 };
 exports.validateSite = validateSite;

package/out/ui/index.d.ts

@@ -5,5 +5,4 @@ export * from './logger';
 export * from './runtime-log';
 export * from './text';
 export * from './ui';
-export * from './validation-error';
 //# sourceMappingURL=index.d.ts.map

package/out/ui/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/ui/index.ts"],"names":[],"mappings":"AAEA,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,UAAU,CAAC;AACzB,cAAc,eAAe,CAAC;AAC9B,cAAc,QAAQ,CAAC;AACvB,cAAc,MAAM,CAAC;AACrB,cAAc,oBAAoB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/ui/index.ts"],"names":[],"mappings":"AAEA,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,UAAU,CAAC;AACzB,cAAc,eAAe,CAAC;AAC9B,cAAc,QAAQ,CAAC;AACvB,cAAc,MAAM,CAAC"}

package/out/ui/index.js

@@ -8,4 +8,3 @@ tslib_1.__exportStar(require("./logger"), exports);
 tslib_1.__exportStar(require("./runtime-log"), exports);
 tslib_1.__exportStar(require("./text"), exports);
 tslib_1.__exportStar(require("./ui"), exports);
-tslib_1.__exportStar(require("./validation-error"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/cli-shared",
-  "version": "3.2.3",
+  "version": "3.3.0-next.0",
   "description": "Common functionality for Forge CLI",
   "author": "Atlassian",
   "license": "UNLICENSED",

package/out/ui/validation-error.d.ts

@@ -1,3 +0,0 @@
-export declare class ValidationError extends Error {
-}
-//# sourceMappingURL=validation-error.d.ts.map

package/out/ui/validation-error.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"validation-error.d.ts","sourceRoot":"","sources":["../../src/ui/validation-error.ts"],"names":[],"mappings":"AAAA,qBAAa,eAAgB,SAAQ,KAAK;CAAG"}

package/out/ui/validation-error.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ValidationError = void 0;
-class ValidationError extends Error {
-}
-exports.ValidationError = ValidationError;