@yaakapp/api 0.5.0 → 0.5.3

package/lib/bindings/gen_events.d.ts

@@ -466,7 +466,7 @@ export type InternalEvent = {
     pluginRefId: string;
     pluginName: string;
     replyId: string | null;
-    windowContext: WindowContext;
+    windowContext: PluginWindowContext;
     payload: InternalEventPayload;
 };
 export type InternalEventPayload = {
@@ -591,6 +591,13 @@ export type OpenWindowRequest = {
     size?: WindowSize;
     dataDirKey?: string;
 };
+export type PluginWindowContext = {
+    "type": "none";
+} | {
+    "type": "label";
+    label: string;
+    workspace_id: string | null;
+};
 export type PromptTextRequest = {
     id: string;
     title: string;
@@ -646,8 +653,12 @@ export type TemplateFunction = {
      * tags when changing the `name` property
      */
     aliases?: Array<string>;
-    args: Array<FormInput>;
+    args: Array<TemplateFunctionArg>;
 };
+/**
+ * Similar to FormInput, but contains
+ */
+export type TemplateFunctionArg = FormInput;
 export type TemplateRenderRequest = {
     data: JsonValue;
     purpose: RenderPurpose;
@@ -655,12 +666,6 @@ export type TemplateRenderRequest = {
 export type TemplateRenderResponse = {
     data: JsonValue;
 };
-export type WindowContext = {
-    "type": "none";
-} | {
-    "type": "label";
-    label: string;
-};
 export type WindowNavigateEvent = {
     url: string;
 };

package/lib/bindings/gen_models.d.ts

@@ -2,10 +2,11 @@ export type Environment = {
     model: "environment";
     id: string;
     workspaceId: string;
-    environmentId: string | null;
     createdAt: string;
     updatedAt: string;
     name: string;
+    public: boolean;
+    base: boolean;
     variables: Array<EnvironmentVariable>;
 };
 export type EnvironmentVariable = {
@@ -129,6 +130,7 @@ export type Workspace = {
     updatedAt: string;
     name: string;
     description: string;
+    encryptionKeyChallenge: string | null;
     settingValidateCertificates: boolean;
     settingFollowRedirects: boolean;
     settingRequestTimeout: number;

package/lib/bindings/serde_json/JsonValue.d.ts

@@ -1,3 +1,3 @@
-export type JsonValue = number | string | Array<JsonValue> | {
+export type JsonValue = number | string | boolean | Array<JsonValue> | {
     [key in string]?: JsonValue;
-};
+} | null;

package/lib/index.d.ts

@@ -2,3 +2,4 @@ export type * from './plugins';
 export type * from './themes';
 export * from './bindings/gen_models';
 export * from './bindings/gen_events';
+export type { PartialImportResources } from './plugins/ImporterPlugin';

package/lib/plugins/Context.d.ts

@@ -19,7 +19,7 @@ export interface Context {
             onNavigate?: (args: {
                 url: string;
             }) => void;
-            onClose: () => void;
+            onClose?: () => void;
         }): Promise<{
             close: () => void;
         }>;

package/lib/plugins/FilterPlugin.d.ts

@@ -1,5 +1,5 @@
 import type { Context } from './Context';
-export type FilterPluginResponse = {
+type FilterPluginResponse = {
     filtered: string;
 };
 export type FilterPlugin = {
@@ -11,3 +11,4 @@ export type FilterPlugin = {
         mimeType: string;
     }): Promise<FilterPluginResponse> | FilterPluginResponse;
 };
+export {};

package/lib/plugins/ImporterPlugin.d.ts

@@ -1,14 +1,18 @@
-import { Environment, Folder, GrpcRequest, HttpRequest, Workspace } from '../bindings/gen_models';
-import type { AtLeast } from '../helpers';
+import { ImportResources } from '../bindings/gen_events';
+import { AtLeast } from '../helpers';
 import type { Context } from './Context';
-type ImportPluginResponse = null | {
-    resources: {
-        workspaces: AtLeast<Workspace, 'name' | 'id' | 'model'>[];
-        environments: AtLeast<Environment, 'name' | 'id' | 'model' | 'workspaceId'>[];
-        folders: AtLeast<Folder, 'name' | 'id' | 'model' | 'workspaceId'>[];
-        httpRequests: AtLeast<HttpRequest, 'name' | 'id' | 'model' | 'workspaceId'>[];
-        grpcRequests: AtLeast<GrpcRequest, 'name' | 'id' | 'model' | 'workspaceId'>[];
-    };
+type RootFields = 'name' | 'id' | 'model';
+type CommonFields = RootFields | 'workspaceId';
+export type PartialImportResources = {
+    workspaces: Array<AtLeast<ImportResources['workspaces'][0], RootFields>>;
+    environments: Array<AtLeast<ImportResources['environments'][0], CommonFields>>;
+    folders: Array<AtLeast<ImportResources['folders'][0], CommonFields>>;
+    httpRequests: Array<AtLeast<ImportResources['httpRequests'][0], CommonFields>>;
+    grpcRequests: Array<AtLeast<ImportResources['grpcRequests'][0], CommonFields>>;
+    websocketRequests: Array<AtLeast<ImportResources['websocketRequests'][0], CommonFields>>;
+};
+export type ImportPluginResponse = null | {
+    resources: PartialImportResources;
 };
 export type ImporterPlugin = {
     name: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yaakapp/api",
-  "version": "0.5.0",
+  "version": "0.5.3",
   "main": "lib/index.js",
   "typings": "./lib/index.d.ts",
   "files": [
@@ -20,8 +20,6 @@
     "@types/node": "^22.5.4"
   },
   "devDependencies": {
-    "cpy-cli": "^5.0.0",
-    "npm-run-all": "^4.1.5",
-    "typescript": "^5.6.2"
+    "cpy-cli": "^5.0.0"
   }
 }