Refactor SDK integration to use ActionSdk and update TypeScript definitions

Author: Knerio

actions/gls-action/package-lock.json

@@ -6,7 +6,8 @@
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "scripts": {
-    "build": "tsc --build",
-    "lint": "eslint ."
+    "build": "vite build",
+    "lint": "eslint .",
+    "test": "vitest run"
   }
 }

actions/gls-action/package.json

@@ -0,0 +1,56 @@
+import {vi} from "vitest";
+import {SdkMockState} from "../index.test";
+import {withSdkMock} from "./withSdkMock";
+import {ActionSdk} from "@code0-tech/hercules";
+
+export const withBaseFunctionMock = async (
+    register: (sdk: ActionSdk) => Promise<void>,
+    tests: (state: SdkMockState) => void
+) => {
+    await withSdkMock(async (state) => {
+        const {createSdk} = await import("@code0-tech/hercules")
+
+        vi.doMock("../helpers.ts", async (importOriginal) => {
+            const actual = await importOriginal() as any;
+
+            return {
+                ...actual,
+                loadAllDefinitions: vi.fn(() => {
+                    return Promise.resolve()
+                })
+            }
+        })
+
+        const mockSdk = createSdk(
+            {
+                actionId: "",
+                version: "",
+                aquilaUrl: "",
+                authToken: ""
+            }
+        )
+
+        vi.doMock("../index.ts", () => ({
+            sdk: mockSdk
+        }));
+
+        vi.doMock("axios", () => {
+            return {
+                post: vi.fn(),
+                get: vi.fn(),
+                put: vi.fn(),
+                delete: vi.fn(),
+            };
+        });
+
+        try {
+            await register(mockSdk)
+
+            tests(state);
+
+        } catch (error) {
+            console.error(error)
+        }
+    })
+}
+

actions/gls-action/src/__tests__/withBaseFunction.ts

@@ -0,0 +1,77 @@
+import {beforeEach, vi} from "vitest";
+import {
+    ActionSdk,
+    HerculesActionConfigurationDefinition,
+    HerculesDataType,
+    HerculesFlowType,
+    HerculesRegisterFunctionParameter
+} from "@code0-tech/hercules";
+import {SdkMockState} from "../index.test";
+
+export const withSdkMock = async (tests: (state: SdkMockState) => void) => {
+    const state = vi.hoisted(() => {
+        const state: SdkMockState = {
+            registeredFunctionDefinitions: [] as HerculesRegisterFunctionParameter[],
+            dataTypes: [] as HerculesDataType[],
+            flowTypes: [] as HerculesFlowType[],
+            configDefinitions: [] as HerculesActionConfigurationDefinition[],
+        };
+        return state
+    })
+
+
+    vi.mock("@code0-tech/hercules", async (importOriginal) => {
+        const actual = await importOriginal() as any
+        return {
+            ...actual,
+            createSdk: (config, configDefinitions) => {
+                state.configDefinitions = configDefinitions || null
+
+                const mockedActionSdk: ActionSdk = {
+                    config: config,
+                    registerFunctionDefinitions: (...defs: HerculesRegisterFunctionParameter[]) => {
+                        state.registeredFunctionDefinitions = defs;
+                        return Promise.resolve();
+                    },
+
+                    registerConfigDefinitions: (...defs: HerculesActionConfigurationDefinition[]) => {
+                        state.configDefinitions = defs;
+                        return Promise.resolve();
+                    },
+
+                    registerDataTypes: (...types: HerculesDataType[]) => {
+                        state.dataTypes = types;
+                        return Promise.resolve();
+                    },
+
+                    registerFlowTypes: (...types: HerculesFlowType[]) => {
+                        state.flowTypes = types;
+                        return Promise.resolve();
+                    },
+                    fullyConnected: () => {
+                        return true
+                    },
+                    connect: vi.fn((options) => {
+                        return Promise.resolve([]);
+                    }),
+                    onError: vi.fn(),
+                    dispatchEvent: vi.fn(),
+                    getProjectActionConfigurations: vi.fn()
+                }
+                return mockedActionSdk
+
+            }
+        }
+
+    })
+
+
+    beforeEach(() => {
+        state.registeredFunctionDefinitions = null;
+        state.dataTypes = null;
+        state.flowTypes = null;
+        state.configDefinitions = null;
+    });
+
+    tests(state);
+}

actions/gls-action/src/__tests__/withSdkMock.ts

@@ -1,6 +1,6 @@
-import {sdk} from "../../index";
+import {ActionSdk} from "@code0-tech/hercules";
 
-export function register() {
+export function register(sdk: ActionSdk) {
     return sdk.registerConfigDefinitions(
         {
             identifier: "auth_url",

actions/gls-action/src/definitions/configDefinition/authUrl.ts

@@ -1,6 +1,6 @@
-import {sdk} from "../../index";
+import {ActionSdk} from "@code0-tech/hercules";
 
-export function register() {
+export function register(sdk: ActionSdk) {
     return sdk.registerConfigDefinitions(
         {
             identifier: "client_id",

actions/gls-action/src/definitions/configDefinition/clientId.ts

@@ -1,6 +1,6 @@
-import {sdk} from "../../index";
+import {ActionSdk} from "@code0-tech/hercules";
 
-export function register() {
+export function register(sdk: ActionSdk) {
     return sdk.registerConfigDefinitions(
         {
             identifier: "client_secret",

actions/gls-action/src/definitions/configDefinition/clientSecret.ts

@@ -1,6 +1,6 @@
-import {sdk} from "../../index";
+import {ActionSdk} from "@code0-tech/hercules";
 
-export function register() {
+export function register(sdk: ActionSdk) {
     return sdk.registerConfigDefinitions(
         {
             identifier: "contact_id",

actions/gls-action/src/definitions/configDefinition/contactId.ts

@@ -1,6 +1,6 @@
-import {sdk} from "../../index";
+import {ActionSdk} from "@code0-tech/hercules";
 
-export function register() {
+export function register(sdk: ActionSdk) {
     return sdk.registerConfigDefinitions(
         {
             identifier: "default_shipper",

actions/gls-action/src/definitions/configDefinition/defaultShipper.ts

@@ -1,6 +1,6 @@
-import {sdk} from "../../index";
+import {ActionSdk} from "@code0-tech/hercules";
 
-export function register() {
+export function register(sdk: ActionSdk) {
     return sdk.registerConfigDefinitions(
         {
             identifier: "ship_it_api_url",