Merge plugins repo into mono

plugins/importer-yaak/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "@yaakapp/importer-yaak",
+  "private": true,
+  "version": "0.0.1",
+  "scripts": {
+    "build": "yaakcli build ./src/index.js",
+    "dev": "yaakcli dev ./src/index.js"
+  }
+}

plugins/importer-yaak/src/index.ts

@@ -0,0 +1,74 @@
+import { Environment, PluginDefinition } from '@yaakapp/api';
+
+export const plugin: PluginDefinition = {
+  importer: {
+    name: 'Yaak',
+    description: 'Yaak official format',
+    onImport(_ctx, args) {
+      return migrateImport(args.text) as any;
+    },
+  },
+};
+
+export function migrateImport(contents: string) {
+  let parsed;
+  try {
+    parsed = JSON.parse(contents);
+  } catch (err) {
+    return undefined;
+  }
+
+  if (!isJSObject(parsed)) {
+    return undefined;
+  }
+
+  const isYaakExport = 'yaakSchema' in parsed;
+  if (!isYaakExport) {
+    return;
+  }
+
+  // Migrate v1 to v2 -- changes requests to httpRequests
+  if ('requests' in parsed.resources) {
+    parsed.resources.httpRequests = parsed.resources.requests;
+    delete parsed.resources['requests'];
+  }
+
+  // Migrate v2 to v3
+  for (const workspace of parsed.resources.workspaces ?? []) {
+    if ('variables' in workspace) {
+      // Create the base environment
+      const baseEnvironment: Partial<Environment> = {
+        id: `GENERATE_ID::base_env_${workspace['id']}`,
+        name: 'Global Variables',
+        variables: workspace.variables,
+        workspaceId: workspace.id,
+      };
+      parsed.resources.environments = parsed.resources.environments ?? [];
+      parsed.resources.environments.push(baseEnvironment);
+
+      // Delete variables key from the workspace
+      delete workspace.variables;
+
+      // Add environmentId to relevant environments
+      for (const environment of parsed.resources.environments) {
+        if (environment.workspaceId === workspace.id && environment.id !== baseEnvironment.id) {
+          environment.environmentId = baseEnvironment.id;
+        }
+      }
+    }
+  }
+
+  // Migrate v3 to v4
+  for (const environment of parsed.resources.environments ?? []) {
+    if ('environmentId' in environment) {
+      environment.base = environment.environmentId == null;
+      delete environment.environmentId;
+    }
+  }
+
+  return { resources: parsed.resources }; // Should already be in the correct format
+}
+
+function isJSObject(obj: any) {
+  return Object.prototype.toString.call(obj) === '[object Object]';
+}

plugins/importer-yaak/tests/index.test.ts

@@ -0,0 +1,70 @@
+import { describe, expect, test } from 'vitest';
+import { migrateImport } from '../src';
+
+describe('importer-yaak', () => {
+  test('Skips invalid imports', () => {
+    expect(migrateImport('not JSON')).toBeUndefined();
+    expect(migrateImport('[]')).toBeUndefined();
+    expect(migrateImport(JSON.stringify({ resources: {} }))).toBeUndefined();
+  });
+
+  test('converts schema 1 to 2', () => {
+    const imported = migrateImport(
+      JSON.stringify({
+        yaakSchema: 1,
+        resources: {
+          requests: [],
+        },
+      }),
+    );
+
+    expect(imported).toEqual(
+      expect.objectContaining({
+        resources: {
+          httpRequests: [],
+        },
+      }),
+    );
+  });
+  test('converts schema 2 to 3', () => {
+    const imported = migrateImport(
+      JSON.stringify({
+        yaakSchema: 2,
+        resources: {
+          environments: [{
+            id: 'e_1',
+            workspaceId: 'w_1',
+            name: 'Production',
+            variables: [{ name: 'E1', value: 'E1!' }],
+          }],
+          workspaces: [{
+            id: 'w_1',
+            variables: [{ name: 'W1', value: 'W1!' }],
+          }],
+        },
+      }),
+    );
+
+    expect(imported).toEqual(
+      expect.objectContaining({
+        resources: {
+          workspaces: [{
+            id: 'w_1',
+          }],
+          environments: [{
+            id: 'e_1',
+            base: false,
+            workspaceId: 'w_1',
+            name: 'Production',
+            variables: [{ name: 'E1', value: 'E1!' }],
+          }, {
+            id: 'GENERATE_ID::base_env_w_1',
+            workspaceId: 'w_1',
+            name: 'Global Variables',
+            variables: [{ name: 'W1', value: 'W1!' }],
+          }],
+        },
+      }),
+    );
+  });
+});