@yaakapp/api 0.0.5 → 0.0.6

package/lib/helpers.d.ts

@@ -1,2 +1,2 @@
 export type AtLeast<T, K extends keyof T> = Partial<T> & Pick<T, K>;
-export type SingleOrArray<T> = T[] | T;
+export type OneOrMany<T> = T[] | T;

package/lib/plugins/filter.d.ts

@@ -0,0 +1,13 @@
+import { YaakContext } from './context';
+export type FilterPluginResponse = string[];
+export interface DataFilterPlugin {
+    name: string;
+    description?: string;
+    canFilter(ctx: YaakContext, args: {
+        mimeType: string;
+    }): Promise<boolean>;
+    onFilter(ctx: YaakContext, args: {
+        payload: string;
+        mimeType: string;
+    }): Promise<FilterPluginResponse>;
+}

package/lib/plugins/filter.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/plugins/httpRequestAction.d.ts

@@ -0,0 +1,9 @@
+import { HttpRequest } from '../models';
+import { YaakContext } from './context';
+export interface HttpRequestActionPlugin {
+    key: string;
+    label: string;
+    onSelect(ctx: YaakContext, args: {
+        httpRequest: HttpRequest;
+    }): void;
+}

package/lib/plugins/httpRequestAction.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/plugins/import.d.ts

@@ -1,14 +1,16 @@
 import { AtLeast } from '../helpers';
 import { Environment, Folder, HttpRequest, Workspace } from '../models';
 import { YaakContext } from './context';
-export type ImportPluginResponse = {
-    resources: Partial<{
-        workspaces: AtLeast<Workspace, 'name' | 'id' | 'model'>[];
-        environments: AtLeast<Environment, 'name' | 'id' | 'model' | 'workspaceId'>[];
-        httpRequests: AtLeast<HttpRequest, 'name' | 'id' | 'model' | 'workspaceId'>[];
-        folders: AtLeast<Folder, 'name' | 'id' | 'model' | 'workspaceId'>[];
-    }>;
-};
-export type ImporterPlugin = {
-    onImport(ctx: YaakContext, fileContents: string): Promise<ImportPluginResponse>;
-};
+export interface FileImportPluginResponse {
+    workspaces: AtLeast<Workspace, 'name' | 'id' | 'model'>[];
+    environments: AtLeast<Environment, 'name' | 'id' | 'model' | 'workspaceId'>[];
+    httpRequests: AtLeast<HttpRequest, 'name' | 'id' | 'model' | 'workspaceId'>[];
+    folders: AtLeast<Folder, 'name' | 'id' | 'model' | 'workspaceId'>[];
+}
+export interface FileImportPlugin {
+    name: string;
+    description: string;
+    onImport: (ctx: YaakContext, args: {
+        text: string;
+    }) => Promise<null | FileImportPluginResponse>;
+}

package/lib/plugins/index.d.ts

@@ -1,12 +1,14 @@
-import { SingleOrArray } from '../helpers';
-import { ImporterPlugin } from './import';
-import { ThemePlugin } from './theme';
+export * from './filter';
+export * from './httpRequestAction';
+export * from './import';
+import { DataFilterPlugin } from './filter';
+import { HttpRequestActionPlugin } from './httpRequestAction';
+import { FileImportPlugin } from './import';
 /**
  * The global structure of a Yaak plugin
  */
-export type YaakPlugin = {
-    /** One or many plugins to import data into Yaak */
-    importers: SingleOrArray<ImporterPlugin>;
-    /** One or many themes to customize the Yaak UI */
-    themes: SingleOrArray<ThemePlugin>;
-};
+export interface YaakPlugin {
+    fileImport?: FileImportPlugin;
+    dataFilter?: DataFilterPlugin;
+    httpRequestAction?: HttpRequestActionPlugin;
+}

package/lib/plugins/index.js

@@ -1,2 +1,19 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./filter"), exports);
+__exportStar(require("./httpRequestAction"), exports);
+__exportStar(require("./import"), exports);

package/lib/plugins/theme.d.ts

@@ -1,4 +1,7 @@
 import { Theme } from '../themes';
-export type ThemePlugin = {
-    theme: Theme;
-};
+import { YaakContext } from './context';
+export interface ThemePlugin {
+    name: string;
+    description?: string;
+    getTheme(ctx: YaakContext, fileContents: string): Promise<Theme>;
+}

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@yaakapp/api",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "main": "lib/index.js",
   "typings": "./lib/index.d.ts",
   "files": [
     "lib"
   ],
   "scripts": {
-    "prepublish": "tsc"
+    "build": "tsc",
+    "prepublish": "npm run build"
   },
   "dependencies": {
     "@types/node": "^22.0.0"