@devbookhq/extension - npm Package Compare versions

Comparing version 0.0.13 to 0.0.15

lib/Devbook.d.ts

@@ -0,9 +1,5 @@
+import { Result } from './event';
 declare enum APIVersion {
     v1 = "v1"
 }
-interface Entry {
-    id?: string;
-    title: string;
-    body: string;
-}
 interface ExtensionInfo {
@@ -20,5 +16,5 @@ extensionID: string;
     private request;
-    search<T = Entry>(indexes: string[] | string, query: string, page?: number, pageSize?: number): Promise<T[]>;
-    entry<T = Entry>(index: string, id: string): Promise<T>;
-    entries<T = Entry>(index: string, page: number, pageSize: number): Promise<T[]>;
+    search(indexes: string[] | string, query: string, page?: number, pageSize?: number): Promise<Result[]>;
+    entry(index: string, id: string): Promise<Result>;
+    entries(index: string, page: number, pageSize: number): Promise<Result[]>;
     info(): Promise<ExtensionInfo>;
@@ -25,0 +21,0 @@ }

lib/event.d.ts

@@ -19,6 +19,4 @@ import { Source } from './source';
     id: string;
-    data: {
-        title: string;
-        body: string;
-    };
+    title: string;
+    body: string;
 }
@@ -25,0 +23,0 @@ export interface EventOutput {

lib/ExtensionModuleHandler.d.ts

 import { Event, EventInput, EventOutput } from './event';
+export declare enum ExtensionMode {
+    Production = "prod",
+    Development = "dev"
+}
 export declare type ExtensionEventHandlers = {
-    [Event.onDidQueryChange]: (data: EventInput[Event.onDidQueryChange]) => (Promise<EventOutput[Event.onDidQueryChange]> | EventOutput[Event.onDidQueryChange]);
-    [Event.getSources]?: (data: EventInput[Event.getSources]) => (Promise<EventOutput[Event.getSources]> | EventOutput[Event.getSources]);
+    [Event.onDidQueryChange]: (data: EventInput[Event.onDidQueryChange], extensionMode: ExtensionMode, accessToken?: string) => (Promise<EventOutput[Event.onDidQueryChange]> | EventOutput[Event.onDidQueryChange]);
+    [Event.getSources]?: (data: EventInput[Event.getSources], extensionMode: ExtensionMode, accessToken?: string) => (Promise<EventOutput[Event.getSources]> | EventOutput[Event.getSources]);
 };
@@ -12,3 +16,3 @@ declare class ExtensionModuleHandler {
         sources?: import("./source").Source[] | undefined;
-    }) => {
+    }, extensionMode: ExtensionMode, accessToken?: string | undefined) => {
         results: import("./event").Result[];
@@ -15,0 +19,0 @@ } | {

lib/ExtensionModuleHandler.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExtensionMode = void 0;
 var event_1 = require("./event");
+var ExtensionMode;
+(function (ExtensionMode) {
+    ExtensionMode["Production"] = "prod";
+    ExtensionMode["Development"] = "dev";
+})(ExtensionMode = exports.ExtensionMode || (exports.ExtensionMode = {}));
 var ExtensionModuleHandler = /** @class */ (function () {
@@ -10,3 +16,5 @@ function ExtensionModuleHandler(extensionModulePath) {
         var _this = this;
-        return function (data) { return _this.exports[eventType](data); };
+        return function (data, extensionMode, accessToken) {
+            return _this.exports[eventType](data, extensionMode, accessToken);
+        };
     };
@@ -13,0 +21,0 @@ return ExtensionModuleHandler;

lib/ExtensionProcess.js

 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
@@ -48,3 +67,3 @@ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
 var EventReturnHandler_1 = __importDefault(require("./EventReturnHandler"));
-var ExtensionModuleHandler_1 = __importDefault(require("./ExtensionModuleHandler"));
+var ExtensionModuleHandler_1 = __importStar(require("./ExtensionModuleHandler"));
 var ExtensionProcess = /** @class */ (function () {
@@ -80,3 +99,3 @@ function ExtensionProcess() {
                         _a.trys.push([1, 3, , 4]);
-                        return [4 /*yield*/, eventHandler(message.data)];
+                        return [4 /*yield*/, eventHandler(message.data, process.env.NODE_ENV === 'dev' ? ExtensionModuleHandler_1.ExtensionMode.Development : ExtensionModuleHandler_1.ExtensionMode.Production, process.env.ACCESS_TOKEN)];
                     case 2:
@@ -83,0 +102,0 @@ eventReturnData = _a.sent();

package-lock.json

 {
   "name": "@devbookhq/extension",
-  "version": "0.0.13",
+  "version": "0.0.15",
   "lockfileVersion": 1,
@@ -5,0 +5,0 @@ "requires": true,

package.json

 {
   "name": "@devbookhq/extension",
-  "version": "0.0.13",
+  "version": "0.0.15",
   "description": "Add search functionality to Devbook with custom extensions",
@@ -11,3 +11,3 @@ "main": "lib/index.js",
   "author": {
-    "name": "Devbook",
+    "name": "FoundryLabs, Inc.",
     "email": "[e-mail]",
@@ -32,5 +32,4 @@ "url": "https://usedevbook.com/"
     "package-lock.json",
-    ".gitignore",
     "README.md"
   ]
 }

README.md

@@ -19,5 +19,8 @@ # Devbook Extension
 ```js
-import Devbook from '@devbookhq/extension';
+import Devbook, { ExtensionEventHandlers } from '@devbookhq/extension';
 
-const extensionEventHandlers: Devbook.ExtensionEventHandlers = {
+// If you want to use our predefined function to fetch extension data, you have to initialize the Devbook object.
+const devbook = new Devbook();
+
+const extensionEventHandlers: ExtensionEventHandlers = {
   // Called every time user changes the search query in the Devbook search input.
@@ -37,8 +40,6 @@ onDidQueryChange: async (data, extensionMode, token) => {
 
-    // You can fetch your extension data from https://api.usedevbook.com/v1/extension/:yourExtensionID/entry/query.
+    // Fetch your extension data from the https://api.usedevbook.com/:version/extension/:extensionID endpoint.
     // You can use our exported predefined functions for that:
 
-    // const results = await Devbook.search(data.query, {
-    //   indexes: ['testIndex'],
-    // });
+    // const results = await Devbook.search(['testIndex'], data.query);
     // return { results };
@@ -58,2 +59,1 @@ },
 Check out the [extension examples](https://github.com/DevbookHQ/devbook-extension-examples).
-

New alerts

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

61110

increased by3.26%

Lines of code

905

increased by2.84%

Worsened metrics

Number of package files

59

decreased by-1.67%

Number of low supply chain risk alerts

11

increased by22.22%

No dependency changes