@snyk/error-catalog-nodejs-public 3.16.0

package/src/catalogs/error-codes.d.ts

@@ -0,0 +1,138 @@
+declare const _default: {
+    Snyk: {
+        TooManyRequests: string;
+        NotImplemented: string;
+        BadRequest: string;
+        Timeout: string;
+        Unauthorised: string;
+        Server: string;
+    };
+    OpenSourceEcosystems: {
+        UnsupportedEcosystem: string;
+        UnparseableManifest: string;
+        LockFileOutOfSync: string;
+        UnparseableLockFile: string;
+        UnknownDependencyVersion: string;
+        MissingPayload: string;
+        UnprocessableFile: string;
+        SourceNotSupported: string;
+        CannotGetFileFromSource: string;
+        NoReleasedVersionForVersionsRange: string;
+        TimeoutWhenProcessingTheDepTree: string;
+        TooManyManifestFiles: string;
+        FailedToApplyDependencyUpdates: string;
+        UnknownBlobEncodingOnGithub: string;
+        NoResultsFromForkerProcesses: string;
+        ChildProcessExecution: string;
+        NoValidPackageUpgrades: string;
+        NoDependencyUpdates: string;
+        MissingRequiredRequestHeader: string;
+        CouldNotParseJSONFile: string;
+        Base64Encode: string;
+        Base64Decode: string;
+        MissingSupportedFile: string;
+        MissingEnvironmentVariable: string;
+        NoOutputFromIsolatedBuilds: string;
+        FailedToRelock: string;
+        InvalidConfiguration: string;
+        UnsupportedManifestFile: string;
+        UnsupportedTargetFramework: string;
+        PrivateModule: string;
+        GoModFileMissing: string;
+        SsoReAuthRequired: string;
+        IncompleteProject: string;
+        MissingRequirementFromPom: string;
+        UnableToResolveValueForProperty: string;
+        UnableToResolveVersionForProperty: string;
+        CyclicPropertyDetectedInPomFile: string;
+        UnableToParseXML: string;
+        InvalidCoordinates: string;
+        SkippedGroup: string;
+        PomFileNotFound: string;
+        MissingProjectFromPom: string;
+        CannotResolveTargetPomFromXml: string;
+        CannotResolveTargetPomFromRepo: string;
+        CannotGetBuildFileFromRepo: string;
+        CannotCreateGitHost: string;
+        NoRepoFoundForTheNPMPackage: string;
+        CouldNotParseNPMRegistryURL: string;
+        CouldNotFindBrokerURL: string;
+        UnableToReplaceBrokerURL: string;
+        BadNPMVersion: string;
+        UnsupportedRequirementsFile: string;
+    };
+    PurlVulnerabilityFetching: {
+        OrganizationNotWhitelisted: string;
+        AuthorizationRequestFailure: string;
+        InvalidPurl: string;
+        NamespaceNotProvided: string;
+        UnsupportedEcosystem: string;
+        MissingComponent: string;
+        ComponentNotSupported: string;
+        UnsupportedGoVersionFormat: string;
+        PackageNotFound: string;
+        VulnerabilityServiceUnavailable: string;
+        VulnDBInvalidResponse: string;
+        VulndbNext: string;
+        InternalServer: string;
+        InvalidPaginationParameters: string;
+        TooManyPurls: string;
+        TooManyIssues: string;
+        UndefinedContainerDistro: string;
+        UnsupportedDebianDistro: string;
+        UndefinedContainerVendor: string;
+        UnsupportedContainerVendor: string;
+    };
+    IsolatedBuilds: {
+        InvalidRequest: string;
+        BuildEnvironmentNotFound: string;
+    };
+    OpenSourceProjectSnapshots: {
+        InvalidRequest: string;
+        InvalidResponse: string;
+        DataTransformation: string;
+        StorageFailure: string;
+        InternalServer: string;
+    };
+    OpenSourceProjectIssues: {
+        InvalidRequest: string;
+        InvalidResponse: string;
+        DataTransformation: string;
+        StorageFailure: string;
+        InternalServer: string;
+    };
+    OpenAPI: {
+        BadRequest: string;
+        Forbidden: string;
+        NotAcceptable: string;
+        NotFound: string;
+        MethodNotAllowed: string;
+        RequestEntityTooLarge: string;
+        Unauthorized: string;
+        UnsupportedMediaType: string;
+    };
+    OpenSourceUnmanaged: {
+        MavenSearchServiceUnavailable: string;
+        Sha1NotFound: string;
+    };
+    SbomExport: {
+        InternalServer: string;
+        UnexpectedDepGraphResponse: string;
+        UnexpectedParseDepGraph: string;
+        IaCOrSASTProject: string;
+        UnsupportedProject: string;
+        DepGraphResponse: string;
+        MissingAuthToken: string;
+        EmptyRequestBody: string;
+        InvalidDepGraph: string;
+    };
+    Fix: {
+        FailedToGetPullRequestAttributes: string;
+        PullRequestTemplateNotFound: string;
+        FailedToCompilePrTemplate: string;
+        FailedToParsePullRequestAttributes: string;
+        FailedToLoadCompiledYaml: string;
+        FailedToGenerateHash: string;
+    };
+};
+export default _default;

package/src/catalogs/error-codes.js

@@ -0,0 +1,140 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = {
+    Snyk: {
+        TooManyRequests: 'SNYK-0001',
+        NotImplemented: 'SNYK-0002',
+        BadRequest: 'SNYK-0003',
+        Timeout: 'SNYK-0004',
+        Unauthorised: 'SNYK-0005',
+        Server: 'SNYK-9999',
+    },
+    OpenSourceEcosystems: {
+        UnsupportedEcosystem: 'SNYK-OS-0001',
+        UnparseableManifest: 'SNYK-OS-0002',
+        LockFileOutOfSync: 'SNYK-OS-0003',
+        UnparseableLockFile: 'SNYK-OS-0004',
+        UnknownDependencyVersion: 'SNYK-OS-0005',
+        MissingPayload: 'SNYK-OS-0006',
+        UnprocessableFile: 'SNYK-OS-0007',
+        SourceNotSupported: 'SNYK-OS-0008',
+        CannotGetFileFromSource: 'SNYK-OS-0009',
+        NoReleasedVersionForVersionsRange: 'SNYK-OS-0010',
+        TimeoutWhenProcessingTheDepTree: 'SNYK-OS-0011',
+        TooManyManifestFiles: 'SNYK-OS-0012',
+        FailedToApplyDependencyUpdates: 'SNYK-OS-0013',
+        UnknownBlobEncodingOnGithub: 'SNYK-OS-0014',
+        NoResultsFromForkerProcesses: 'SNYK-OS-0015',
+        ChildProcessExecution: 'SNYK-OS-0016',
+        NoValidPackageUpgrades: 'SNYK-OS-0017',
+        NoDependencyUpdates: 'SNYK-OS-0018',
+        MissingRequiredRequestHeader: 'SNYK-OS-0019',
+        CouldNotParseJSONFile: 'SNYK-OS-0020',
+        Base64Encode: 'SNYK-OS-0021',
+        Base64Decode: 'SNYK-OS-0022',
+        MissingSupportedFile: 'SNYK-OS-0023',
+        MissingEnvironmentVariable: 'SNYK-OS-0024',
+        NoOutputFromIsolatedBuilds: 'SNYK-OS-0025',
+        FailedToRelock: 'SNYK-OS-0026',
+        InvalidConfiguration: 'SNYK-OS-0027',
+        UnsupportedManifestFile: 'SNYK-OS-DOTNET-0001',
+        UnsupportedTargetFramework: 'SNYK-OS-DOTNET-0002',
+        PrivateModule: 'SNYK-OS-GO-0001',
+        GoModFileMissing: 'SNYK-OS-GO-0002',
+        SsoReAuthRequired: 'SNYK-OS-GO-0003',
+        IncompleteProject: 'SNYK-OS-GO-0004',
+        MissingRequirementFromPom: 'SNYK-OS-MAVEN-0001',
+        UnableToResolveValueForProperty: 'SNYK-OS-MAVEN-0002',
+        UnableToResolveVersionForProperty: 'SNYK-OS-MAVEN-0003',
+        CyclicPropertyDetectedInPomFile: 'SNYK-OS-MAVEN-0004',
+        UnableToParseXML: 'SNYK-OS-MAVEN-0005',
+        InvalidCoordinates: 'SNYK-OS-MAVEN-0006',
+        SkippedGroup: 'SNYK-OS-MAVEN-0007',
+        PomFileNotFound: 'SNYK-OS-MAVEN-0008',
+        MissingProjectFromPom: 'SNYK-OS-MAVEN-0009',
+        CannotResolveTargetPomFromXml: 'SNYK-OS-MAVEN-0010',
+        CannotResolveTargetPomFromRepo: 'SNYK-OS-MAVEN-0011',
+        CannotGetBuildFileFromRepo: 'SNYK-OS-MAVEN-0012',
+        CannotCreateGitHost: 'SNYK-OS-MAVEN-0013',
+        NoRepoFoundForTheNPMPackage: 'SNYK-OS-NODEJS-0001',
+        CouldNotParseNPMRegistryURL: 'SNYK-OS-NODEJS-0002',
+        CouldNotFindBrokerURL: 'SNYK-OS-NODEJS-0003',
+        UnableToReplaceBrokerURL: 'SNYK-OS-NODEJS-0004',
+        BadNPMVersion: 'SNYK-OS-NODEJS-0005',
+        UnsupportedRequirementsFile: 'SNYK-OS-PIP-0001',
+    },
+    PurlVulnerabilityFetching: {
+        OrganizationNotWhitelisted: 'SNYK-OSSI-1040',
+        AuthorizationRequestFailure: 'SNYK-OSSI-1050',
+        InvalidPurl: 'SNYK-OSSI-2010',
+        NamespaceNotProvided: 'SNYK-OSSI-2011',
+        UnsupportedEcosystem: 'SNYK-OSSI-2020',
+        MissingComponent: 'SNYK-OSSI-2021',
+        ComponentNotSupported: 'SNYK-OSSI-2022',
+        UnsupportedGoVersionFormat: 'SNYK-OSSI-2023',
+        PackageNotFound: 'SNYK-OSSI-2030',
+        VulnerabilityServiceUnavailable: 'SNYK-OSSI-2031',
+        VulnDBInvalidResponse: 'SNYK-OSSI-2032',
+        VulndbNext: 'SNYK-OSSI-2033',
+        InternalServer: 'SNYK-OSSI-2040',
+        InvalidPaginationParameters: 'SNYK-OSSI-2041',
+        TooManyPurls: 'SNYK-OSSI-2042',
+        TooManyIssues: 'SNYK-OSSI-2043',
+        UndefinedContainerDistro: 'SNYK-OSSI-2044',
+        UnsupportedDebianDistro: 'SNYK-OSSI-2045',
+        UndefinedContainerVendor: 'SNYK-OSSI-2046',
+        UnsupportedContainerVendor: 'SNYK-OSSI-2047',
+    },
+    IsolatedBuilds: {
+        InvalidRequest: 'SNYK-OS-8001',
+        BuildEnvironmentNotFound: 'SNYK-OS-8002',
+    },
+    OpenSourceProjectSnapshots: {
+        InvalidRequest: 'SNYK-OSSI-OSPSS-1001',
+        InvalidResponse: 'SNYK-OSSI-OSPSS-1002',
+        DataTransformation: 'SNYK-OSSI-OSPSS-2001',
+        StorageFailure: 'SNYK-OSSI-OSPSS-3001',
+        InternalServer: 'SNYK-OSSI-OSPSS-4001',
+    },
+    OpenSourceProjectIssues: {
+        InvalidRequest: 'SNYK-OSSI-OSPI-1001',
+        InvalidResponse: 'SNYK-OSSI-OSPI-1002',
+        DataTransformation: 'SNYK-OSSI-OSPI-2001',
+        StorageFailure: 'SNYK-OSSI-OSPI-3001',
+        InternalServer: 'SNYK-OSSI-OSPI-4001',
+    },
+    OpenAPI: {
+        BadRequest: 'SNYK-OPENAPI-0001',
+        Forbidden: 'SNYK-OPENAPI-0002',
+        NotAcceptable: 'SNYK-OPENAPI-0003',
+        NotFound: 'SNYK-OPENAPI-0004',
+        MethodNotAllowed: 'SNYK-OPENAPI-0005',
+        RequestEntityTooLarge: 'SNYK-OPENAPI-0006',
+        Unauthorized: 'SNYK-OPENAPI-0007',
+        UnsupportedMediaType: 'SNYK-OPENAPI-0008',
+    },
+    OpenSourceUnmanaged: {
+        MavenSearchServiceUnavailable: 'SNYK-OSJVM-001',
+        Sha1NotFound: 'SNYK-OSJVM-002',
+    },
+    SbomExport: {
+        InternalServer: 'SNYK-OS-9000',
+        UnexpectedDepGraphResponse: 'SNYK-OS-9001',
+        UnexpectedParseDepGraph: 'SNYK-OS-9002',
+        IaCOrSASTProject: 'SNYK-OS-9003',
+        UnsupportedProject: 'SNYK-OS-9004',
+        DepGraphResponse: 'SNYK-OS-9005',
+        MissingAuthToken: 'SNYK-OS-9006',
+        EmptyRequestBody: 'SNYK-OS-9007',
+        InvalidDepGraph: 'SNYK-OS-9008',
+    },
+    Fix: {
+        FailedToGetPullRequestAttributes: 'SNYK-PR-TEMPLATE-0001',
+        PullRequestTemplateNotFound: 'SNYK-PR-TEMPLATE-0002',
+        FailedToCompilePrTemplate: 'SNYK-PR-TEMPLATE-0003',
+        FailedToParsePullRequestAttributes: 'SNYK-PR-TEMPLATE-0004',
+        FailedToLoadCompiledYaml: 'SNYK-PR-TEMPLATE-0005',
+        FailedToGenerateHash: 'SNYK-PR-TEMPLATE-0006',
+    },
+};
+//# sourceMappingURL=error-codes.js.map

package/src/catalogs/error-codes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error-codes.js","sourceRoot":"","sources":["../../../../../packages/error-catalog-nodejs-public/src/catalogs/error-codes.ts"],"names":[],"mappings":";;AAAA,kBAAe;IACX,IAAI,EAAE;QACJ,eAAe,EAAE,WAAW;QAC5B,cAAc,EAAE,WAAW;QAC3B,UAAU,EAAE,WAAW;QACvB,OAAO,EAAE,WAAW;QACpB,YAAY,EAAE,WAAW;QACzB,MAAM,EAAE,WAAW;KACpB;IACD,oBAAoB,EAAE;QACpB,oBAAoB,EAAE,cAAc;QACpC,mBAAmB,EAAE,cAAc;QACnC,iBAAiB,EAAE,cAAc;QACjC,mBAAmB,EAAE,cAAc;QACnC,wBAAwB,EAAE,cAAc;QACxC,cAAc,EAAE,cAAc;QAC9B,iBAAiB,EAAE,cAAc;QACjC,kBAAkB,EAAE,cAAc;QAClC,uBAAuB,EAAE,cAAc;QACvC,iCAAiC,EAAE,cAAc;QACjD,+BAA+B,EAAE,cAAc;QAC/C,oBAAoB,EAAE,cAAc;QACpC,8BAA8B,EAAE,cAAc;QAC9C,2BAA2B,EAAE,cAAc;QAC3C,4BAA4B,EAAE,cAAc;QAC5C,qBAAqB,EAAE,cAAc;QACrC,sBAAsB,EAAE,cAAc;QACtC,mBAAmB,EAAE,cAAc;QACnC,4BAA4B,EAAE,cAAc;QAC5C,qBAAqB,EAAE,cAAc;QACrC,YAAY,EAAE,cAAc;QAC5B,YAAY,EAAE,cAAc;QAC5B,oBAAoB,EAAE,cAAc;QACpC,0BAA0B,EAAE,cAAc;QAC1C,0BAA0B,EAAE,cAAc;QAC1C,cAAc,EAAE,cAAc;QAC9B,oBAAoB,EAAE,cAAc;QACpC,uBAAuB,EAAE,qBAAqB;QAC9C,0BAA0B,EAAE,qBAAqB;QACjD,aAAa,EAAE,iBAAiB;QAChC,gBAAgB,EAAE,iBAAiB;QACnC,iBAAiB,EAAE,iBAAiB;QACpC,iBAAiB,EAAE,iBAAiB;QACpC,yBAAyB,EAAE,oBAAoB;QAC/C,+BAA+B,EAAE,oBAAoB;QACrD,iCAAiC,EAAE,oBAAoB;QACvD,+BAA+B,EAAE,oBAAoB;QACrD,gBAAgB,EAAE,oBAAoB;QACtC,kBAAkB,EAAE,oBAAoB;QACxC,YAAY,EAAE,oBAAoB;QAClC,eAAe,EAAE,oBAAoB;QACrC,qBAAqB,EAAE,oBAAoB;QAC3C,6BAA6B,EAAE,oBAAoB;QACnD,8BAA8B,EAAE,oBAAoB;QACpD,0BAA0B,EAAE,oBAAoB;QAChD,mBAAmB,EAAE,oBAAoB;QACzC,2BAA2B,EAAE,qBAAqB;QAClD,2BAA2B,EAAE,qBAAqB;QAClD,qBAAqB,EAAE,qBAAqB;QAC5C,wBAAwB,EAAE,qBAAqB;QAC/C,aAAa,EAAE,qBAAqB;QACpC,2BAA2B,EAAE,kBAAkB;KAChD;IACD,yBAAyB,EAAE;QACzB,0BAA0B,EAAE,gBAAgB;QAC5C,2BAA2B,EAAE,gBAAgB;QAC7C,WAAW,EAAE,gBAAgB;QAC7B,oBAAoB,EAAE,gBAAgB;QACtC,oBAAoB,EAAE,gBAAgB;QACtC,gBAAgB,EAAE,gBAAgB;QAClC,qBAAqB,EAAE,gBAAgB;QACvC,0BAA0B,EAAE,gBAAgB;QAC5C,eAAe,EAAE,gBAAgB;QACjC,+BAA+B,EAAE,gBAAgB;QACjD,qBAAqB,EAAE,gBAAgB;QACvC,UAAU,EAAE,gBAAgB;QAC5B,cAAc,EAAE,gBAAgB;QAChC,2BAA2B,EAAE,gBAAgB;QAC7C,YAAY,EAAE,gBAAgB;QAC9B,aAAa,EAAE,gBAAgB;QAC/B,wBAAwB,EAAE,gBAAgB;QAC1C,uBAAuB,EAAE,gBAAgB;QACzC,wBAAwB,EAAE,gBAAgB;QAC1C,0BAA0B,EAAE,gBAAgB;KAC7C;IACD,cAAc,EAAE;QACd,cAAc,EAAE,cAAc;QAC9B,wBAAwB,EAAE,cAAc;KACzC;IACD,0BAA0B,EAAE;QAC1B,cAAc,EAAE,sBAAsB;QACtC,eAAe,EAAE,sBAAsB;QACvC,kBAAkB,EAAE,sBAAsB;QAC1C,cAAc,EAAE,sBAAsB;QACtC,cAAc,EAAE,sBAAsB;KACvC;IACD,uBAAuB,EAAE;QACvB,cAAc,EAAE,qBAAqB;QACrC,eAAe,EAAE,qBAAqB;QACtC,kBAAkB,EAAE,qBAAqB;QACzC,cAAc,EAAE,qBAAqB;QACrC,cAAc,EAAE,qBAAqB;KACtC;IACD,OAAO,EAAE;QACP,UAAU,EAAE,mBAAmB;QAC/B,SAAS,EAAE,mBAAmB;QAC9B,aAAa,EAAE,mBAAmB;QAClC,QAAQ,EAAE,mBAAmB;QAC7B,gBAAgB,EAAE,mBAAmB;QACrC,qBAAqB,EAAE,mBAAmB;QAC1C,YAAY,EAAE,mBAAmB;QACjC,oBAAoB,EAAE,mBAAmB;KAC1C;IACD,mBAAmB,EAAE;QACnB,6BAA6B,EAAE,gBAAgB;QAC/C,YAAY,EAAE,gBAAgB;KAC/B;IACD,UAAU,EAAE;QACV,cAAc,EAAE,cAAc;QAC9B,0BAA0B,EAAE,cAAc;QAC1C,uBAAuB,EAAE,cAAc;QACvC,gBAAgB,EAAE,cAAc;QAChC,kBAAkB,EAAE,cAAc;QAClC,gBAAgB,EAAE,cAAc;QAChC,gBAAgB,EAAE,cAAc;QAChC,gBAAgB,EAAE,cAAc;QAChC,eAAe,EAAE,cAAc;KAChC;IACD,GAAG,EAAE;QACH,gCAAgC,EAAE,uBAAuB;QACzD,2BAA2B,EAAE,uBAAuB;QACpD,yBAAyB,EAAE,uBAAuB;QAClD,kCAAkC,EAAE,uBAAuB;QAC3D,wBAAwB,EAAE,uBAAuB;QACjD,oBAAoB,EAAE,uBAAuB;KAC9C;CACJ,CAAA"}

package/src/composite-error.d.ts

@@ -0,0 +1,13 @@
+import { JsonApi } from './types';
+import { ProblemError } from './problem-error';
+export declare class CompositeError extends Error {
+    readonly errors: Array<ProblemError>;
+    constructor(errors: Array<ProblemError>);
+    /**
+     * Convert this CompositeError to JsonApi.
+     * If the error was created with 'instance' metadata then that will be used by default for all errors.
+     * @param instance string the instance to use for the errors in this CompositeError. Overrides 'instance' metadata
+     * @returns JsonApi a JsonApi object representing this CompositeError
+     */
+    toJsonApi(instance?: string): JsonApi;
+}

package/src/composite-error.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CompositeError = void 0;
+const types_1 = require("./types");
+class CompositeError extends Error {
+    constructor(errors) {
+        super('CompositeError');
+        this.errors = errors;
+    }
+    /**
+     * Convert this CompositeError to JsonApi.
+     * If the error was created with 'instance' metadata then that will be used by default for all errors.
+     * @param instance string the instance to use for the errors in this CompositeError. Overrides 'instance' metadata
+     * @returns JsonApi a JsonApi object representing this CompositeError
+     */
+    toJsonApi(instance) {
+        const payload = {
+            jsonapi: {
+                version: '1.0',
+            },
+            errors: this.errors.map((error) => error.toJsonApiErrorObject(instance)),
+        };
+        return new types_1.JsonApi(payload);
+    }
+}
+exports.CompositeError = CompositeError;
+//# sourceMappingURL=composite-error.js.map

package/src/composite-error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"composite-error.js","sourceRoot":"","sources":["../../../../packages/error-catalog-nodejs-public/src/composite-error.ts"],"names":[],"mappings":";;;AAAA,mCAAqE;AAGrE,MAAa,cAAe,SAAQ,KAAK;IAEvC,YAAY,MAA2B;QACrC,KAAK,CAAC,gBAAgB,CAAC,CAAC;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,QAAiB;QACzB,MAAM,OAAO,GAAkB;YAC7B,OAAO,EAAE;gBACP,OAAO,EAAE,KAAK;aACf;YACD,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAChC,KAAK,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CACb;SAC1B,CAAC;QAEF,OAAO,IAAI,eAAO,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;CACF;AAzBD,wCAyBC"}

package/src/index.d.ts

@@ -0,0 +1,3 @@
+export * from './problem-error';
+export * from './catalogs/error-catalog';
+export * from './composite-error';

package/src/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./problem-error"), exports);
+tslib_1.__exportStar(require("./catalogs/error-catalog"), exports);
+tslib_1.__exportStar(require("./composite-error"), exports);
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/error-catalog-nodejs-public/src/index.ts"],"names":[],"mappings":";;;AAAA,0DAAgC;AAChC,mEAAyC;AACzC,4DAAkC"}

package/src/problem-error.d.ts

@@ -0,0 +1,20 @@
+import { ErrorFormats, ErrorMetadata, JsonApi, JsonApiErrorObject, ProblemJson } from './types';
+export declare class ProblemError extends Error {
+    readonly metadata: ErrorMetadata;
+    readonly detail: string;
+    readonly additionalData?: Record<string, any> | undefined;
+    readonly cause?: Error | undefined;
+    private id;
+    readonly isErrorCatalogError = true;
+    constructor(metadata: ErrorMetadata, detail: string, additionalData?: Record<string, any> | undefined, cause?: Error | undefined);
+    format(instance: string, formatType: ErrorFormats): ProblemJson | JsonApi;
+    toProblemJson(instance: string): ProblemJson;
+    /**
+     * Convert this ProblemError to a JsonApiErrorObject.
+     * If the error was created with 'instance' metadata then that will be used by default.
+     * @param instance string the instance to use for this error. Overrides 'instance' metadata
+     * @returns JsonApiErrorObject a JsonApiErrorObject representing this ProblemError
+     */
+    toJsonApiErrorObject(instance?: string): JsonApiErrorObject;
+    toJsonApi(instance?: string): JsonApi;
+}

package/src/problem-error.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProblemError = void 0;
+const types_1 = require("./types");
+const uuid_1 = require("uuid");
+const util_1 = require("./util");
+class ProblemError extends Error {
+    constructor(metadata, detail, additionalData, cause) {
+        super(metadata.title);
+        this.metadata = metadata;
+        this.detail = detail;
+        this.additionalData = additionalData;
+        this.cause = cause;
+        // Since `instanceof` cannot be relied upon for class checks in situations where the `ProblemError` was thrown from a dependency of the executing app, we need a more viable solution.
+        // See: https://stackoverflow.com/questions/41587865/using-instanceof-on-objects-created-with-constructors-from-deep-npm-dependenci/41592087#41592087
+        this.isErrorCatalogError = true;
+        if (additionalData && additionalData['overrideErrorId']) {
+            this.id = additionalData['overrideErrorId'];
+        }
+        else {
+            this.id = (0, uuid_1.v4)();
+        }
+    }
+    format(instance, formatType) {
+        switch (formatType) {
+            case types_1.ErrorFormats.JsonApi:
+                return this.toJsonApi(instance);
+            case types_1.ErrorFormats.ProblemJson:
+                return this.toProblemJson(instance);
+            default:
+                throw new Error('invalid format type');
+        }
+    }
+    toProblemJson(instance) {
+        const payload = Object.assign({ type: this.metadata.type, title: this.metadata.title, status: this.metadata.status, errorCode: this.metadata.errorCode, detail: this.detail, instance }, this.additionalData);
+        return new types_1.ProblemJson(payload);
+    }
+    /**
+     * Convert this ProblemError to a JsonApiErrorObject.
+     * If the error was created with 'instance' metadata then that will be used by default.
+     * @param instance string the instance to use for this error. Overrides 'instance' metadata
+     * @returns JsonApiErrorObject a JsonApiErrorObject representing this ProblemError
+     */
+    toJsonApiErrorObject(instance) {
+        let source;
+        // Get the instance from either the member or the parameter
+        const theinstance = instance || this.metadata.instance;
+        if (typeof theinstance === 'string') {
+            source = (0, util_1.instanceToJsonApiSource)(theinstance);
+        }
+        const jsonApiErrorObject = {
+            id: this.id,
+            links: {
+                about: this.metadata.type,
+            },
+            status: String(this.metadata.status),
+            code: this.metadata.errorCode,
+            title: this.metadata.title,
+            detail: this.detail,
+            meta: Object.assign({}, this.additionalData),
+        };
+        if (source) {
+            jsonApiErrorObject.source = source;
+        }
+        return jsonApiErrorObject;
+    }
+    toJsonApi(instance) {
+        const payload = {
+            jsonapi: {
+                version: '1.0',
+            },
+            errors: [this.toJsonApiErrorObject(instance)],
+        };
+        return new types_1.JsonApi(payload);
+    }
+}
+exports.ProblemError = ProblemError;
+//# sourceMappingURL=problem-error.js.map

package/src/problem-error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"problem-error.js","sourceRoot":"","sources":["../../../../packages/error-catalog-nodejs-public/src/problem-error.ts"],"names":[],"mappings":";;;AAAA,mCAQiB;AACjB,+BAA0B;AAC1B,iCAAiD;AAEjD,MAAa,YAAa,SAAQ,KAAK;IAOrC,YACkB,QAAuB,EACvB,MAAc,EACd,cAAoC,EACpC,KAAa;QAE7B,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QALN,aAAQ,GAAR,QAAQ,CAAe;QACvB,WAAM,GAAN,MAAM,CAAQ;QACd,mBAAc,GAAd,cAAc,CAAsB;QACpC,UAAK,GAAL,KAAK,CAAQ;QAR/B,sLAAsL;QACtL,qJAAqJ;QACrI,wBAAmB,GAAG,IAAI,CAAC;QASzC,IAAI,cAAc,IAAI,cAAc,CAAC,iBAAiB,CAAC,EAAE;YACvD,IAAI,CAAC,EAAE,GAAG,cAAc,CAAC,iBAAiB,CAAC,CAAC;SAC7C;aAAM;YACL,IAAI,CAAC,EAAE,GAAG,IAAA,SAAE,GAAE,CAAC;SAChB;IACH,CAAC;IAED,MAAM,CAAC,QAAgB,EAAE,UAAwB;QAC/C,QAAQ,UAAU,EAAE;YAClB,KAAK,oBAAY,CAAC,OAAO;gBACvB,OAAO,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;YAClC,KAAK,oBAAY,CAAC,WAAW;gBAC3B,OAAO,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;YACtC;gBACE,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;SAC1C;IACH,CAAC;IAED,aAAa,CAAC,QAAgB;QAC5B,MAAM,OAAO,mBACX,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,EACxB,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,EAC1B,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,EAC5B,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,SAAS,EAClC,MAAM,EAAE,IAAI,CAAC,MAAM,EACnB,QAAQ,IACL,IAAI,CAAC,cAAc,CACvB,CAAC;QACF,OAAO,IAAI,mBAAW,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;IAED;;;;;OAKG;IACH,oBAAoB,CAAC,QAAiB;QACpC,IAAI,MAAsC,CAAC;QAE3C,2DAA2D;QAC3D,MAAM,WAAW,GAAG,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;QAEvD,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE;YACnC,MAAM,GAAG,IAAA,8BAAuB,EAAC,WAAW,CAAC,CAAC;SAC/C;QAED,MAAM,kBAAkB,GAAuB;YAC7C,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,KAAK,EAAE;gBACL,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI;aAC1B;YACD,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;YACpC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,SAAS;YAC7B,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK;YAC1B,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,IAAI,oBACC,IAAI,CAAC,cAAc,CACvB;SACF,CAAC;QACF,IAAI,MAAM,EAAE;YACV,kBAAkB,CAAC,MAAM,GAAG,MAAM,CAAC;SACpC;QACD,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IAED,SAAS,CAAC,QAAiB;QACzB,MAAM,OAAO,GAAkB;YAC7B,OAAO,EAAE;gBACP,OAAO,EAAE,KAAK;aACf;YACD,MAAM,EAAE,CAAC,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;SAC9C,CAAC;QAEF,OAAO,IAAI,eAAO,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;CACF;AA1FD,oCA0FC"}

package/src/types.d.ts

@@ -0,0 +1,66 @@
+export type Problem = {
+    /** A URI reference that identifies the problem type.  This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type. */
+    type: string;
+    /** A short, human-readable summary of the problem type. This should not chance from occurrence to occurrence of the problem.*/
+    title: string;
+    /** A human-readable explanation specific to this occurrence of the problem. */
+    detail: string;
+    /** The HTTP status code generated by the origin server for this occurrence of the problem. */
+    status: number;
+    /** An internal code for the error that occurred. */
+    errorCode: string;
+    /** A URI that identifies the specific occurrence of the problem. */
+    instance?: string;
+    /** The level of this error */
+    level?: string;
+    /** Additional properties. */
+    [x: string]: any;
+};
+export type ErrorMetadata = Pick<Problem, 'type' | 'title' | 'status' | 'errorCode' | 'level' | 'instance'>;
+export declare enum ErrorFormats {
+    JsonApi = 0,
+    ProblemJson = 1
+}
+export interface ErrorFormat {
+    headers(): Record<string, string>;
+    body(): Problem | JsonApiErrors;
+}
+export declare class ProblemJson implements ErrorFormat {
+    private readonly payload;
+    constructor(payload: Problem);
+    headers(): Record<string, string>;
+    body(): Problem | JsonApiErrors;
+}
+export type JsonApiErrorSource = {
+    pointer: string;
+} | {
+    parameter: string;
+} | {
+    header: string;
+};
+export type JsonApiErrorObject = {
+    id?: string;
+    links?: {
+        about?: string;
+    };
+    status: string;
+    code: string;
+    title: string;
+    detail: string;
+    source?: JsonApiErrorSource;
+    meta?: {
+        [x: string]: any;
+    };
+};
+export type JsonApiErrors = {
+    jsonapi: {
+        version: string;
+    };
+    errors: [JsonApiErrorObject];
+};
+export declare class JsonApi implements ErrorFormat {
+    private readonly payload;
+    constructor(payload: JsonApiErrors);
+    headers(): Record<string, string>;
+    body(): Problem | JsonApiErrors;
+}

package/src/types.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JsonApi = exports.ProblemJson = exports.ErrorFormats = void 0;
+var ErrorFormats;
+(function (ErrorFormats) {
+    ErrorFormats[ErrorFormats["JsonApi"] = 0] = "JsonApi";
+    ErrorFormats[ErrorFormats["ProblemJson"] = 1] = "ProblemJson";
+})(ErrorFormats || (exports.ErrorFormats = ErrorFormats = {}));
+class ProblemJson {
+    constructor(payload) {
+        this.payload = payload;
+    }
+    headers() {
+        return {
+            'Content-Type': 'application/problem+json;',
+        };
+    }
+    body() {
+        return this.payload;
+    }
+}
+exports.ProblemJson = ProblemJson;
+class JsonApi {
+    constructor(payload) {
+        this.payload = payload;
+    }
+    headers() {
+        return {};
+    }
+    body() {
+        return this.payload;
+    }
+}
+exports.JsonApi = JsonApi;
+//# sourceMappingURL=types.js.map

package/src/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../packages/error-catalog-nodejs-public/src/types.ts"],"names":[],"mappings":";;;AAwBA,IAAY,YAGX;AAHD,WAAY,YAAY;IACtB,qDAAO,CAAA;IACP,6DAAW,CAAA;AACb,CAAC,EAHW,YAAY,4BAAZ,YAAY,QAGvB;AAQD,MAAa,WAAW;IACtB,YAA6B,OAAgB;QAAhB,YAAO,GAAP,OAAO,CAAS;IAAG,CAAC;IAEjD,OAAO;QACL,OAAO;YACL,cAAc,EAAE,2BAA2B;SAC5C,CAAC;IACJ,CAAC;IAED,IAAI;QACF,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;CACF;AAZD,kCAYC;AA6BD,MAAa,OAAO;IAClB,YAA6B,OAAsB;QAAtB,YAAO,GAAP,OAAO,CAAe;IAAG,CAAC;IAEvD,OAAO;QACL,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,IAAI;QACF,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;CACF;AATD,0BASC"}

package/src/util/index.d.ts

@@ -0,0 +1 @@
+export * from './json-api';

package/src/util/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./json-api"), exports);
+//# sourceMappingURL=index.js.map

package/src/util/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/error-catalog-nodejs-public/src/util/index.ts"],"names":[],"mappings":";;;AAAA,qDAA2B"}

package/src/util/json-api.d.ts

@@ -0,0 +1,7 @@
+import { JsonApiErrorSource } from '../types';
+/**
+ * Converts the instance string from an error into a JsonApiErrorSource
+ * @param instance the instance string to convert
+ * @returns A JsonApiErrorSource if appropriate, or undefined if not
+ */
+export declare const instanceToJsonApiSource: (instance: string) => JsonApiErrorSource | undefined;

package/src/util/json-api.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceToJsonApiSource = void 0;
+const SOURCE_REGEXP = /^\/(query|params|body|headers)\/.*/;
+/**
+ * Converts the instance string from an error into a JsonApiErrorSource
+ * @param instance the instance string to convert
+ * @returns A JsonApiErrorSource if appropriate, or undefined if not
+ */
+const instanceToJsonApiSource = (instance) => {
+    let source;
+    // See if the instance conforms to one of the source formats
+    const matchErrorPath = instance.match(SOURCE_REGEXP);
+    // If the match captures the path type and parameter,
+    if (matchErrorPath !== null && matchErrorPath.length > 0) {
+        // Convert the instance into a source
+        switch (matchErrorPath[1]) {
+            case 'query':
+            case 'params':
+                source = paramsInstanceToJsonApiSource(instance);
+                break;
+            case 'body':
+                source = bodyInstanceToJsonApiSource(instance);
+                break;
+            case 'headers':
+                source = headerInstanceToJsonApiSource(instance);
+                break;
+        }
+    }
+    return source;
+};
+exports.instanceToJsonApiSource = instanceToJsonApiSource;
+// For a parameter, do not include the leading slash
+const PARAMETER_REGEXP = /^\/(?:params|query)\/(.*)/;
+const paramsInstanceToJsonApiSource = (instance) => {
+    let parameter = '';
+    // The source is the name of the parameter, and is not a json path
+    const matches = instance.match(PARAMETER_REGEXP);
+    if (matches !== null && matches.length > 0) {
+        parameter = matches[1];
+    }
+    return {
+        parameter,
+    };
+};
+// For a pointer, capture the JSON path, including the leading slash
+const POINTER_REGEXP = /^\/body(\/.*)/;
+const bodyInstanceToJsonApiSource = (instance) => {
+    let pointer = '';
+    const matches = instance.match(POINTER_REGEXP);
+    if (matches !== null && matches.length > 0) {
+        pointer = matches[1];
+    }
+    return {
+        pointer,
+    };
+};
+// The source is the name of the header, and is not a json path
+const HEADER_REGEXP = /^\/headers\/(.*)/;
+const headerInstanceToJsonApiSource = (instance) => {
+    let header = '';
+    const matches = instance.match(HEADER_REGEXP);
+    if (matches !== null && matches.length > 0) {
+        header = matches[1];
+    }
+    return {
+        header,
+    };
+};
+//# sourceMappingURL=json-api.js.map

package/src/util/json-api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"json-api.js","sourceRoot":"","sources":["../../../../../packages/error-catalog-nodejs-public/src/util/json-api.ts"],"names":[],"mappings":";;;AAEA,MAAM,aAAa,GAAG,oCAAoC,CAAC;AAE3D;;;;GAIG;AACI,MAAM,uBAAuB,GAAG,CACrC,QAAgB,EACgB,EAAE;IAClC,IAAI,MAAM,CAAC;IAEX,4DAA4D;IAC5D,MAAM,cAAc,GAAG,QAAQ,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;IACrD,qDAAqD;IACrD,IAAI,cAAc,KAAK,IAAI,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE;QACxD,qCAAqC;QACrC,QAAQ,cAAc,CAAC,CAAC,CAAC,EAAE;YACzB,KAAK,OAAO,CAAC;YACb,KAAK,QAAQ;gBACX,MAAM,GAAG,6BAA6B,CAAC,QAAQ,CAAC,CAAC;gBACjD,MAAM;YACR,KAAK,MAAM;gBACT,MAAM,GAAG,2BAA2B,CAAC,QAAQ,CAAC,CAAC;gBAC/C,MAAM;YACR,KAAK,SAAS;gBACZ,MAAM,GAAG,6BAA6B,CAAC,QAAQ,CAAC,CAAC;gBACjD,MAAM;SACT;KACF;IAED,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAzBW,QAAA,uBAAuB,2BAyBlC;AAEF,oDAAoD;AACpD,MAAM,gBAAgB,GAAG,2BAA2B,CAAC;AAErD,MAAM,6BAA6B,GAAG,CACpC,QAAgB,EACI,EAAE;IACtB,IAAI,SAAS,GAAG,EAAE,CAAC;IAEnB,kEAAkE;IAClE,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAEjD,IAAI,OAAO,KAAK,IAAI,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;QAC1C,SAAS,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;KACxB;IAED,OAAO;QACL,SAAS;KACV,CAAC;AACJ,CAAC,CAAC;AAEF,oEAAoE;AACpE,MAAM,cAAc,GAAG,eAAe,CAAC;AAEvC,MAAM,2BAA2B,GAAG,CAAC,QAAgB,EAAsB,EAAE;IAC3E,IAAI,OAAO,GAAG,EAAE,CAAC;IAEjB,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;IAE/C,IAAI,OAAO,KAAK,IAAI,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;QAC1C,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;KACtB;IAED,OAAO;QACL,OAAO;KACR,CAAC;AACJ,CAAC,CAAC;AAEF,+DAA+D;AAC/D,MAAM,aAAa,GAAG,kBAAkB,CAAC;AAEzC,MAAM,6BAA6B,GAAG,CACpC,QAAgB,EACI,EAAE;IACtB,IAAI,MAAM,GAAG,EAAE,CAAC;IAEhB,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;IAE9C,IAAI,OAAO,KAAK,IAAI,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;QAC1C,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;KACrB;IAED,OAAO;QACL,MAAM;KACP,CAAC;AACJ,CAAC,CAAC"}