@benup/bensdk 1.8.2 → 1.9.1

package/bin/lib/types/benefit-definition.types.d.ts

@@ -1,6 +1,19 @@
 import z from 'zod';
+import { AxiosInstance } from 'axios';
 import { BenefitDefinitionSchema } from '../schemas/benefit-definition.schema';
+import { TokenHelper } from './lib/token-helper.lib.type';
 type Base = z.infer<typeof BenefitDefinitionSchema>;
+export type AuthHandlerCtx = {
+    tokenHelper: TokenHelper;
+};
+export type AuthHandlerResult = {
+    outcome: 'FAILED';
+    reason?: string;
+    retry?: boolean;
+} | {
+    outcome: 'SUCCEEDED';
+    instance?: AxiosInstance;
+};
 export type BenefitDefinition = Omit<Base, 'stateMachine'> & {
     stateMachine: Base['stateMachine'] & {
         DEDUCTION_FILE_INGESTION?: {
@@ -14,5 +27,8 @@ export type BenefitDefinition = Omit<Base, 'stateMachine'> & {
             };
         } & any;
     };
+    auth?: {
+        handler: (credentials: any, ctx: AuthHandlerCtx) => Promise<AuthHandlerResult>;
+    };
 };
 export {};

package/bin/lib/types/lib/token-helper.lib.type.d.ts

@@ -0,0 +1,17 @@
+type GetTokenParameters = {
+    accountID: string;
+    companyID: string;
+    benefitID: string;
+};
+type SetTokenParameters = {
+    accountID: string;
+    companyID: string;
+    benefitID: string;
+    valueToBeStored: string;
+    storeForSeconds: number;
+};
+export interface TokenHelper {
+    get: (params: GetTokenParameters) => Promise<string | null>;
+    set: (params: SetTokenParameters) => Promise<boolean>;
+}
+export {};

package/bin/lib/types/state-handler.types.d.ts

@@ -52,6 +52,10 @@ export interface StateHandlerCtx {
      * executionAPI Axios instance
      */
     executionAPI: AxiosInstance;
+    /**
+     * benefitPartnerAPI Axios instance
+     */
+    benefitPartnerAPI: AxiosInstance;
     /**
      * deductionFileIngestionHelper
      */

package/bin/src/cli/templates/bensdk-base/.github/workflows/lint.yml.template

@@ -0,0 +1,29 @@
+name: Run lint - static checker
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Use Node.js 20.x
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20.x
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Run tests
+        run: npm run lint

package/bin/src/cli/templates/bensdk-base/eslint.config.mjs.template

@@ -1,3 +1,4 @@
+/* eslint-disable n/no-unpublished-import */
 /* eslint-disable n/no-extraneous-import */
 
 import js from "@eslint/js";
@@ -37,6 +38,6 @@ export default [
     },
   },
   {
-    ignores: [".docs/", "build/"],
+    ignores: [".docs/", "build/", "bin/"],
   },
 ];

package/bin/src/cli/templates/package.template.json

@@ -25,6 +25,10 @@
   },
   "devDependencies": {
     "concurrently": "^9.1.2",
+    "eslint": "^9.36.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-jsdoc": "^60.7.1",
+    "eslint-plugin-n": "^17.23.1",
     "prettier": "^3.5.1",
     "prettier-plugin-organize-imports": "^4.1.0",
     "tsx": "^4.19.2",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@benup/bensdk",
-  "version": "1.8.2",
+  "version": "1.9.1",
   "main": "index.js",
   "type": "module",
   "scripts": {