@rxap/ngx-sentry
Version:
This package provides utilities for initializing Sentry in Angular applications. It includes functions to determine the Sentry environment and release based on the application's environment, and a function to initialize Sentry with these configurations. I
434 lines (433 loc) • 12.2 kB
JSON
{
"id": 0,
"name": "@rxap/ngx-sentry",
"variant": "project",
"kind": 1,
"flags": {},
"children": [
{
"id": 1,
"name": "DetermineSentryEnvironment",
"variant": "declaration",
"kind": 64,
"flags": {},
"sources": [
{
"fileName": "determine-sentry-environment.ts",
"line": 14,
"character": 16,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/sentry/src/lib/determine-sentry-environment.ts#L14"
}
],
"signatures": [
{
"id": 2,
"name": "DetermineSentryEnvironment",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Determines the sentry environment based on the build info object.\n\nIf the tier is local return undefined.\nIf the tier is production determine the environment based on the tag and branch name."
}
]
},
"sources": [
{
"fileName": "determine-sentry-environment.ts",
"line": 14,
"character": 16,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/sentry/src/lib/determine-sentry-environment.ts#L14"
}
],
"parameters": [
{
"id": 3,
"name": "environment",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": {
"sourceFileName": "packages/angular/environment/src/lib/environment.ts",
"qualifiedName": "Environment"
},
"name": "Environment",
"package": "@rxap/environment"
}
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
]
},
{
"id": 4,
"name": "DetermineSentryRelease",
"variant": "declaration",
"kind": 64,
"flags": {},
"sources": [
{
"fileName": "determine-sentry-release.ts",
"line": 11,
"character": 16,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/sentry/src/lib/determine-sentry-release.ts#L11"
}
],
"signatures": [
{
"id": 5,
"name": "DetermineSentryRelease",
"variant": "signature",
"kind": 4096,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "Determines the sentry release based on the build info object.\n\nIf the tier is local return undefined.\nIf the tier is production return the tag value as release or undefined."
}
]
},
"sources": [
{
"fileName": "determine-sentry-release.ts",
"line": 11,
"character": 16,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/sentry/src/lib/determine-sentry-release.ts#L11"
}
],
"parameters": [
{
"id": 6,
"name": "environment",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": {
"sourceFileName": "packages/angular/environment/src/lib/environment.ts",
"qualifiedName": "Environment"
},
"name": "Environment",
"package": "@rxap/environment"
}
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
]
},
{
"id": 13,
"name": "SentryInit",
"variant": "declaration",
"kind": 64,
"flags": {},
"sources": [
{
"fileName": "sentry-init.ts",
"line": 7,
"character": 16,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/sentry/src/lib/sentry-init.ts#L7"
}
],
"signatures": [
{
"id": 14,
"name": "SentryInit",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "sentry-init.ts",
"line": 7,
"character": 16,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/sentry/src/lib/sentry-init.ts#L7"
}
],
"parameters": [
{
"id": 15,
"name": "environment",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": {
"sourceFileName": "packages/angular/environment/src/lib/environment.ts",
"qualifiedName": "Environment"
},
"name": "Environment",
"package": "@rxap/environment"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
},
{
"id": 7,
"name": "sentryInitBootstrapHook",
"variant": "declaration",
"kind": 64,
"flags": {},
"sources": [
{
"fileName": "sentry-init-bootstrap-hook.ts",
"line": 7,
"character": 16,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/sentry/src/lib/sentry-init-bootstrap-hook.ts#L7"
}
],
"signatures": [
{
"id": 8,
"name": "sentryInitBootstrapHook",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "sentry-init-bootstrap-hook.ts",
"line": 7,
"character": 16,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/sentry/src/lib/sentry-init-bootstrap-hook.ts#L7"
}
],
"parameters": [
{
"id": 9,
"name": "environment",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": {
"sourceFileName": "packages/angular/environment/src/lib/environment.ts",
"qualifiedName": "Environment"
},
"name": "Environment",
"package": "@rxap/environment"
}
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 10,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "sentry-init-bootstrap-hook.ts",
"line": 8,
"character": 9,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/sentry/src/lib/sentry-init-bootstrap-hook.ts#L8"
}
],
"signatures": [
{
"id": 11,
"name": "__type",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "sentry-init-bootstrap-hook.ts",
"line": 8,
"character": 9,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/sentry/src/lib/sentry-init-bootstrap-hook.ts#L8"
}
],
"parameters": [
{
"id": 12,
"name": "config",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": {
"sourceFileName": "packages/angular/config/src/lib/config.service.ts",
"qualifiedName": "ConfigService"
},
"name": "ConfigService",
"package": "@rxap/config"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
}
}
}
]
}
],
"groups": [
{
"title": "Functions",
"children": [
1,
4,
13,
7
]
}
],
"packageName": "@rxap/ngx-sentry",
"packageVersion": "19.1.0",
"readme": [
{
"kind": "text",
"text": "This package provides utilities for initializing Sentry in Angular applications. It includes functions to determine the Sentry environment and release based on the application's environment, and a function to initialize Sentry with these configurations. It also includes a generator to add peer dependencies to the package.json.\n\n[](https://www.npmjs.com/package/@rxap/ngx-sentry)\n[](https://commitizen.github.io/cz-cli/)\n[](https://github.com/prettier/prettier)\n\n\n\n\n- [Installation](#installation)\n- [Generators](#generators)\n - [init](#init)\n\n# Installation\n\n**Add the package to your workspace:**\n"
},
{
"kind": "code",
"text": "```bash\nyarn add @rxap/ngx-sentry\n```"
},
{
"kind": "text",
"text": "\n**Install peer dependencies:**\n"
},
{
"kind": "code",
"text": "```bash\nyarn add @rxap/config @rxap/environment @sentry/angular \n```"
},
{
"kind": "text",
"text": "\n**Execute the init generator:**\n"
},
{
"kind": "code",
"text": "```bash\nyarn nx g @rxap/ngx-sentry:init\n```"
},
{
"kind": "text",
"text": "\n# Generators\n\n## init\n> Initialize the package in the workspace\n\n"
},
{
"kind": "code",
"text": "```bash\nnx g @rxap/ngx-sentry:init\n```"
}
],
"symbolIdMap": {
"0": {
"sourceFileName": "packages/angular/sentry/src/index.ts",
"qualifiedName": ""
},
"1": {
"sourceFileName": "packages/angular/sentry/src/lib/determine-sentry-environment.ts",
"qualifiedName": "DetermineSentryEnvironment"
},
"2": {
"sourceFileName": "packages/angular/sentry/src/lib/determine-sentry-environment.ts",
"qualifiedName": "DetermineSentryEnvironment"
},
"3": {
"sourceFileName": "packages/angular/sentry/src/lib/determine-sentry-environment.ts",
"qualifiedName": "environment"
},
"4": {
"sourceFileName": "packages/angular/sentry/src/lib/determine-sentry-release.ts",
"qualifiedName": "DetermineSentryRelease"
},
"5": {
"sourceFileName": "packages/angular/sentry/src/lib/determine-sentry-release.ts",
"qualifiedName": "DetermineSentryRelease"
},
"6": {
"sourceFileName": "packages/angular/sentry/src/lib/determine-sentry-release.ts",
"qualifiedName": "environment"
},
"7": {
"sourceFileName": "packages/angular/sentry/src/lib/sentry-init-bootstrap-hook.ts",
"qualifiedName": "sentryInitBootstrapHook"
},
"8": {
"sourceFileName": "packages/angular/sentry/src/lib/sentry-init-bootstrap-hook.ts",
"qualifiedName": "sentryInitBootstrapHook"
},
"9": {
"sourceFileName": "packages/angular/sentry/src/lib/sentry-init-bootstrap-hook.ts",
"qualifiedName": "environment"
},
"10": {
"sourceFileName": "packages/angular/sentry/src/lib/sentry-init-bootstrap-hook.ts",
"qualifiedName": "__function"
},
"11": {
"sourceFileName": "packages/angular/sentry/src/lib/sentry-init-bootstrap-hook.ts",
"qualifiedName": "__function"
},
"12": {
"sourceFileName": "packages/angular/sentry/src/lib/sentry-init-bootstrap-hook.ts",
"qualifiedName": "config"
},
"13": {
"sourceFileName": "packages/angular/sentry/src/lib/sentry-init.ts",
"qualifiedName": "SentryInit"
},
"14": {
"sourceFileName": "packages/angular/sentry/src/lib/sentry-init.ts",
"qualifiedName": "SentryInit"
},
"15": {
"sourceFileName": "packages/angular/sentry/src/lib/sentry-init.ts",
"qualifiedName": "environment"
}
},
"files": {
"entries": {
"1": "packages/angular/sentry/src/index.ts"
},
"reflections": {
"1": 0
}
}
}