feat: Add configuration and CI/CD setup

Author: SerVitasik

.woodpecker/buildRelease.sh

@@ -0,0 +1,13 @@
+
+#!/bin/bash
+
+# write npm run output both to console and to build.log
+npm run build 2>&1 | tee build.log
+build_status=${PIPESTATUS[0]}
+
+# if exist status from the npm run build is not 0
+# then exit with the status code from the npm run build
+if [ $build_status -ne 0 ]; then
+  echo "Build failed. Exiting with status code $build_status"
+  exit $build_status
+fi

.woodpecker/buildSlackNotify.sh

@@ -0,0 +1,44 @@
+#!/bin/sh
+
+set -x
+
+COMMIT_SHORT_SHA=$(echo $CI_COMMIT_SHA | cut -c1-8)
+
+
+if [ "$CI_STEP_STATUS" = "success" ]; then
+  MESSAGE="Did a build without issues on \`$CI_REPO_NAME/$CI_COMMIT_BRANCH\`. Commit: _${CI_COMMIT_MESSAGE}_ (<$CI_COMMIT_URL|$COMMIT_SHORT_SHA>)"
+
+  curl  -s -X POST -H "Content-Type: application/json" -d '{
+    "username": "'"$CI_COMMIT_AUTHOR"'",
+    "icon_url": "'"$CI_COMMIT_AUTHOR_AVATAR"'",
+    "attachments": [
+      {
+          "mrkdwn_in": ["text", "pretext"],
+          "color": "#36a64f",
+          "text": "'"$MESSAGE"'"
+      }
+    ]
+  }' "$DEVELOPERS_SLACK_WEBHOOK"
+  exit 0
+fi
+export BUILD_LOG=$(cat ./build.log)
+
+BUILD_LOG=$(echo $BUILD_LOG | sed 's/"/\\"/g')
+
+MESSAGE="Broke \`$CI_REPO_NAME/$CI_COMMIT_BRANCH\` with commit _${CI_COMMIT_MESSAGE}_ (<$CI_COMMIT_URL|$COMMIT_SHORT_SHA>)"
+CODE_BLOCK="\`\`\`$BUILD_LOG\n\`\`\`"
+
+echo "Sending slack message to developers $MESSAGE"
+# Send the message
+curl -sS -X POST -H "Content-Type: application/json" -d '{
+  "username": "'"$CI_COMMIT_AUTHOR"'",
+  "icon_url": "'"$CI_COMMIT_AUTHOR_AVATAR"'",
+  "attachments": [
+    {
+        "mrkdwn_in": ["text", "pretext"],
+        "color": "#8A1C12",
+        "text": "'"$CODE_BLOCK"'",
+        "pretext": "'"$MESSAGE"'"
+    }
+  ]
+}' "$DEVELOPERS_SLACK_WEBHOOK" 2>&1

.woodpecker/release.yml

@@ -0,0 +1,42 @@
+clone:
+  git:
+    image: woodpeckerci/plugin-git
+    settings:
+      partial: false
+      depth: 5
+
+steps:
+  init-secrets:
+    when:
+      - event: push
+    image: infisical/cli
+    environment:
+      INFISICAL_TOKEN:
+        from_secret: VAULT_TOKEN
+    commands:
+      - infisical export --domain https://vault.devforth.io/api --format=dotenv-export --env="prod" > /woodpecker/deploy.vault.env
+    secrets:
+      - VAULT_TOKEN
+
+  release:
+    image: node:20
+    when:
+      - event: push
+    commands:
+      - apt update && apt install -y rsync
+      - export $(cat /woodpecker/deploy.vault.env | xargs)
+      - npm clean-install
+      - /bin/bash ./.woodpecker/buildRelease.sh
+      - npm audit signatures
+      - npx semantic-release
+
+  slack-on-failure:
+    when:
+      - event: push
+        status: [failure, success]
+      - event: push
+    image: curlimages/curl
+    commands:
+      - export $(cat /woodpecker/deploy.vault.env | xargs)
+      - /bin/sh ./.woodpecker/buildSlackNotify.sh
+

CHANGELOG.md

@@ -0,0 +1,5 @@
+
+# Changelog
+
+The complete changelog is available on the [GitHub Releases page](https://github.com/devforth/adminforth-sso-auth/releases).
+

custom/tsconfig.json

@@ -0,0 +1,19 @@
+{
+    "compilerOptions": {
+      "baseUrl": ".", // This should point to your project root
+      "paths": {
+        "@/*": [
+          // "node_modules/adminforth/dist/spa/src/*"
+          "../../../spa/src/*"
+        ],
+        "*": [
+          // "node_modules/adminforth/dist/spa/node_modules/*"
+          "../../../spa/node_modules/*"
+        ],
+        "@@/*": [
+          // "node_modules/adminforth/dist/spa/src/*"
+          "."
+        ]
+      }
+    }
+  }

package.json

@@ -1,11 +1,48 @@
 {
-  "name": "adminforth-sso-auth",
+  "name": "@adminforth/sso-auth",
   "version": "1.0.0",
-  "main": "index.ts",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "scripts": {
-     "prepare": "npm link adminforth"
+    "rollout": "tsc && rsync -av --exclude 'node_modules' custom dist/",
+    "prepare": "npm link adminforth"
   },
-  "author": "",
-  "license": "ISC",
-  "description": ""
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/devforth/adminforth-sso-auth"
+  },
+  "keywords": ["adminforth", "sso", "auth", "oauth", "google auth", "github auth"],
+  "author": "devforth",
+  "license": "MIT",
+  "description": "AdminForth SSO Auth Plugin",
+  "devDependencies": {
+    "@types/node": "^22.10.7",
+    "semantic-release": "^24.2.1",
+    "semantic-release-slack-bot": "^4.0.2",
+    "typescript": "^5.7.3"
+  },
+  "release": {
+    "plugins": [
+      "@semantic-release/commit-analyzer",
+      "@semantic-release/release-notes-generator",
+      "@semantic-release/npm",
+      "@semantic-release/github",
+      [
+        "semantic-release-slack-bot",
+        {
+          "notifyOnSuccess": true,
+          "notifyOnFail": true,
+          "slackIcon": ":package:",
+          "markdownReleaseNotes": true
+        }
+      ]
+    ],
+    "branches": [
+      "main",
+      {
+        "name": "next",
+        "prerelease": true
+      }
+    ]
+  }
 }

tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include*/ 
+    "module": "node16",                                /* Specify what module code is generated. */
+    "outDir": "./dist",                                   /* Specify an output folder for all emitted files. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules.  */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+    "strict": false,                                     /* Enable all strict type-checking options. */
+    "skipLibCheck": true,                                 /* Skip type checking all .d.ts files. */
+  },
+  "exclude": ["node_modules", "dist", "custom"],           /* Exclude files from compilation. */
+}

types.ts

@@ -0,0 +1,76 @@
+import type { AdminForthResource, IAdminForth, IHttpServer } from 'adminforth';
+
+/**
+ * Configuration for an OAuth2 provider adapter
+ */
+export interface OAuth2ProviderAdapter {
+  /**
+   * Unique identifier for this OAuth provider
+   */
+  providerId: string;
+
+  /**
+   * Display name of the provider shown in the UI
+   */
+  providerName: string;
+
+  /**
+   * URL to provider's logo image to show in login button
+   */
+  providerLogo?: string;
+
+  /**
+   * Validate adapter configuration
+   * Throws error if configuration is invalid
+   */
+  validate(): void;
+
+  /**
+   * Get OAuth2 authorization URL that user will be redirected to
+   */
+  getAuthorizationUrl(): string;
+
+  /**
+   * Exchange authorization code for access token and user info
+   */
+  exchangeCodeForToken(code: string): Promise<{
+    error?: string;
+    userInfo?: {
+      email: string;
+      name?: string;
+      picture?: string;
+      [key: string]: any;
+    };
+  }>;
+}
+
+/**
+ * Plugin options for SSO authentication
+ */
+export interface PluginOptions {
+  /**
+   * OAuth2 provider adapter implementation
+   */
+  provider: OAuth2ProviderAdapter;
+
+  /**
+   * Optional callback URL override
+   * If not provided, will use default AdminForth callback URL
+   */
+  callbackUrl?: string;
+
+  /**
+   * Optional function to transform user info from provider
+   * into AdminForth user record before saving
+   */
+  transformUserInfo?: (userInfo: any) => Promise<Record<string, any>>;
+
+  /**
+   * Optional function to validate if user is allowed to login
+   * For example to check if email domain is allowed
+   */
+  validateUser?: (userInfo: any) => Promise<{
+    allowed: boolean;
+    error?: string;
+  }>;
+}