@sentry-internal/global-search - npm Package Compare versions

Comparing version 0.5.10 to 1.0.0

dist/cjs/sentry-global-search/lib/config.js

@@ -45,2 +45,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
     config({
+        site: 'zendesk_sentry_articles',
+        name: 'Help Center',
+        indexes: [
+            {
+                indexName: 'zendesk_sentry_articles',
+                transformer: Transformers.transformZendeskArticlesHit,
+            },
+        ],
+    }),
+    config({
         site: 'blog',
@@ -47,0 +57,0 @@ name: 'Blog Posts',

dist/cjs/sentry-global-search/lib/transformers.d.ts

@@ -5,2 +5,3 @@ import { Transformer } from './types';
 export declare const transformHelpCenterHit: Transformer;
+export declare const transformZendeskArticlesHit: Transformer;
 export declare const transformBlogHit: Transformer;

dist/cjs/sentry-global-search/lib/transformers.js

 Object.defineProperty(exports, "__esModule", { value: true });
-exports.transformBlogHit = exports.transformHelpCenterHit = exports.transformDevelopHit = exports.transformDocsGatsbyHit = void 0;
+exports.transformBlogHit = exports.transformZendeskArticlesHit = exports.transformHelpCenterHit = exports.transformDevelopHit = exports.transformDocsGatsbyHit = void 0;
 var tslib_1 = require("tslib");
@@ -49,3 +49,3 @@ var pretty_path_1 = tslib_1.__importDefault(require("./pretty-path"));
         id: hit.objectID,
-        site: 'blog',
+        site: 'help-center',
         context: tslib_1.__assign({}, hit.context),
@@ -64,2 +64,22 @@ url: "https://help.sentry.io".concat(hit.url).concat(hit.anchor ? "#".concat(hit.anchor) : ''),
 exports.transformHelpCenterHit = transformHelpCenterHit;
+var transformZendeskArticlesHit = function (hit, results) {
+    var _a, _b;
+    var obj = {
+        id: hit.objectID,
+        site: 'zendesk_sentry_articles',
+        context: {
+            context1: ((_a = hit.category) === null || _a === void 0 ? void 0 : _a.title) || "Help Center"
+        },
+        url: "https://sentry.zendesk.com/hc/en-us/articles/".concat(hit.id).concat(hit.anchor ? "#".concat(hit.anchor) : ''),
+        index: (_b = results.index) !== null && _b !== void 0 ? _b : "",
+    };
+    if (hit._highlightResult)
+        obj.title = hit._highlightResult.title.value;
+    if (hit._snippetResult)
+        obj.text = hit._snippetResult.body_safe.value;
+    if (results.queryID)
+        obj.queryID = results.queryID;
+    return obj;
+};
+exports.transformZendeskArticlesHit = transformZendeskArticlesHit;
 var transformBlogHit = function (hit, results) {
@@ -66,0 +86,0 @@ var _a;

dist/cjs/sentry-global-search/lib/types.d.ts

 import { ObjectWithObjectID, SearchResponse } from '@algolia/client-search';
-export type Site = 'docs' | 'develop' | 'help-center' | 'blog';
+export type Site = 'docs' | 'develop' | 'help-center' | 'blog' | 'zendesk_sentry_articles';
 export type SearchHit = ObjectWithObjectID & {
@@ -55,2 +55,11 @@ /**
     };
+    /**
+     * Object representing the category title and ID of a ZendeskArticleHit
+     * - category.id is used to form the url for the content: https://sentry.zendesk.com/hc/en-us/articles/${hit.id}
+     * - category.title is used as the primary context for the result ex. Account and Billing, Product Features etc.
+     */
+    category?: {
+        id?: string;
+        title?: string;
+    };
 };
@@ -57,0 +66,0 @@ export type Result = {

dist/esm/sentry-global-search/lib/config.js

@@ -42,2 +42,12 @@ import * as Transformers from './transformers';
     config({
+        site: 'zendesk_sentry_articles',
+        name: 'Help Center',
+        indexes: [
+            {
+                indexName: 'zendesk_sentry_articles',
+                transformer: Transformers.transformZendeskArticlesHit,
+            },
+        ],
+    }),
+    config({
         site: 'blog',
@@ -44,0 +54,0 @@ name: 'Blog Posts',

dist/esm/sentry-global-search/lib/transformers.js

@@ -44,3 +44,3 @@ import prettyPath from './pretty-path';
         id: hit.objectID,
-        site: 'blog',
+        site: 'help-center',
         context: Object.assign({}, hit.context),
@@ -58,2 +58,21 @@ url: `https://help.sentry.io${hit.url}${hit.anchor ? `#${hit.anchor}` : ''}`,
 };
+export const transformZendeskArticlesHit = (hit, results) => {
+    var _a, _b;
+    const obj = {
+        id: hit.objectID,
+        site: 'zendesk_sentry_articles',
+        context: {
+            context1: ((_a = hit.category) === null || _a === void 0 ? void 0 : _a.title) || "Help Center"
+        },
+        url: `https://sentry.zendesk.com/hc/en-us/articles/${hit.id}${hit.anchor ? `#${hit.anchor}` : ''}`,
+        index: (_b = results.index) !== null && _b !== void 0 ? _b : "",
+    };
+    if (hit._highlightResult)
+        obj.title = hit._highlightResult.title.value;
+    if (hit._snippetResult)
+        obj.text = hit._snippetResult.body_safe.value;
+    if (results.queryID)
+        obj.queryID = results.queryID;
+    return obj;
+};
 export const transformBlogHit = (hit, results) => {
@@ -60,0 +79,0 @@ var _a;

package.json

 {
   "name": "@sentry-internal/global-search",
   "description": "JavaScript library and helper utilities for searching Sentry sites via Algolia.",
-  "version": "0.5.10",
+  "version": "1.0.0",
   "author": "Sentry",
@@ -6,0 +6,0 @@ "dependencies": {

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

161172

increased by2.78%

Lines of code

1938

increased by3.69%

Number of low quality alerts

1

decreased by-50%

No dependency changes