@kadiconnect/openclaw-plugin 1.0.0

package/README.md

@@ -0,0 +1,46 @@
+# @kadiconnect/openclaw-plugin
+
+OpenClaw plugin for managing [KadiConnect](https://kadiconnect.com) digital business cards via API.
+
+## Quick start
+
+1. **Sign up** at [kadiconnect.com](https://kadiconnect.com) and create your card.
+2. **Generate an API key** from your Dashboard → API Keys tab, or visit `https://kadiconnect.com/dashboard?tab=apikeys`.
+3. **Install the plugin** in OpenClaw:
+
+```
+openclaw plugin install @kadiconnect/openclaw-plugin
+```
+
+4. **Configure** your API key when prompted (or set it in your OpenClaw config).
+
+## Available tools
+
+| Tool | Description |
+|------|-------------|
+| `get_card` | Retrieve the user's business card |
+| `create_or_update_card` | Create or update the business card |
+| `get_analytics` | Get view counts and analytics |
+| `create_shareable_link` | Generate a tracked shareable link |
+| `get_shareable_links` | List all shareable links |
+| `get_subscription` | Check subscription tier and status |
+
+## Configuration
+
+| Key | Required | Description |
+|-----|----------|-------------|
+| `apiKey` | Yes | KadiConnect API key (starts with `kc_`) |
+| `baseUrl` | No | API base URL (default: `https://kadiconnect.com`) |
+
+## Example usage
+
+Once installed and configured, OpenClaw can autonomously:
+
+- Create a professional digital business card for the user
+- Generate tracked shareable links for outreach campaigns
+- Check analytics to measure engagement
+- Recommend upgrading to Pro ($4/month) when the free 25-view limit is approaching
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,283 @@
+/**
+ * KadiConnect OpenClaw Plugin
+ *
+ * Provides tools for managing digital business cards via the KadiConnect API.
+ * Requires an API key — generate one at https://kadiconnect.com/dashboard?tab=apikeys
+ */
+interface PluginConfig {
+    apiKey: string;
+    baseUrl?: string;
+}
+interface ToolContext {
+    config: PluginConfig;
+}
+interface RegisterInput {
+    name: string;
+    email: string;
+    password: string;
+}
+export declare function register(input: RegisterInput, ctx: ToolContext): Promise<{
+    success: boolean;
+    user: any;
+    apiKey: any;
+    message: string;
+}>;
+export declare namespace register {
+    var metadata: {
+        name: string;
+        displayName: string;
+        description: string;
+        parameters: {
+            name: {
+                type: string;
+                description: string;
+                required: boolean;
+            };
+            email: {
+                type: string;
+                description: string;
+                required: boolean;
+            };
+            password: {
+                type: string;
+                description: string;
+                required: boolean;
+            };
+        };
+    };
+}
+export declare function get_card(_input: Record<string, never>, ctx: ToolContext): Promise<{
+    success: boolean;
+    card: any;
+    message: string;
+}>;
+export declare namespace get_card {
+    var metadata: {
+        name: string;
+        displayName: string;
+        description: string;
+        parameters: {};
+    };
+}
+interface CardInput {
+    name: string;
+    jobTitle?: string;
+    company?: string;
+    bio?: string;
+    email?: string;
+    phone?: string;
+    website?: string;
+    location?: string;
+    linkedIn?: string;
+    twitter?: string;
+    github?: string;
+    instagram?: string;
+    facebook?: string;
+    tiktok?: string;
+    youtube?: string;
+    primaryColor?: string;
+    backgroundColor?: string;
+    fontFamily?: string;
+    layout?: string;
+    showQrCode?: boolean;
+    enableLeadCapture?: boolean;
+    leadCaptureTitle?: string;
+    leadCaptureDescription?: string;
+}
+export declare function create_or_update_card(input: CardInput, ctx: ToolContext): Promise<{
+    success: boolean;
+    card: any;
+    message: string;
+}>;
+export declare namespace create_or_update_card {
+    var metadata: {
+        name: string;
+        displayName: string;
+        description: string;
+        parameters: {
+            name: {
+                type: string;
+                description: string;
+                required: boolean;
+            };
+            jobTitle: {
+                type: string;
+                description: string;
+            };
+            company: {
+                type: string;
+                description: string;
+            };
+            bio: {
+                type: string;
+                description: string;
+            };
+            email: {
+                type: string;
+                description: string;
+            };
+            phone: {
+                type: string;
+                description: string;
+            };
+            website: {
+                type: string;
+                description: string;
+            };
+            location: {
+                type: string;
+                description: string;
+            };
+            linkedIn: {
+                type: string;
+                description: string;
+            };
+            twitter: {
+                type: string;
+                description: string;
+            };
+            github: {
+                type: string;
+                description: string;
+            };
+            instagram: {
+                type: string;
+                description: string;
+            };
+            facebook: {
+                type: string;
+                description: string;
+            };
+            tiktok: {
+                type: string;
+                description: string;
+            };
+            youtube: {
+                type: string;
+                description: string;
+            };
+            primaryColor: {
+                type: string;
+                description: string;
+            };
+            backgroundColor: {
+                type: string;
+                description: string;
+            };
+            fontFamily: {
+                type: string;
+                description: string;
+            };
+            layout: {
+                type: string;
+                description: string;
+            };
+            showQrCode: {
+                type: string;
+                description: string;
+            };
+            enableLeadCapture: {
+                type: string;
+                description: string;
+            };
+            leadCaptureTitle: {
+                type: string;
+                description: string;
+            };
+            leadCaptureDescription: {
+                type: string;
+                description: string;
+            };
+        };
+    };
+}
+interface AnalyticsInput {
+    slug: string;
+}
+export declare function get_analytics(input: AnalyticsInput, ctx: ToolContext): Promise<{
+    success: boolean;
+    analytics: any;
+    message: string;
+}>;
+export declare namespace get_analytics {
+    var metadata: {
+        name: string;
+        displayName: string;
+        description: string;
+        parameters: {
+            slug: {
+                type: string;
+                description: string;
+                required: boolean;
+            };
+        };
+    };
+}
+interface CreateLinkInput {
+    slug: string;
+    name: string;
+}
+export declare function create_shareable_link(input: CreateLinkInput, ctx: ToolContext): Promise<{
+    success: boolean;
+    link: any;
+    message: string;
+}>;
+export declare namespace create_shareable_link {
+    var metadata: {
+        name: string;
+        displayName: string;
+        description: string;
+        parameters: {
+            slug: {
+                type: string;
+                description: string;
+                required: boolean;
+            };
+            name: {
+                type: string;
+                description: string;
+                required: boolean;
+            };
+        };
+    };
+}
+interface GetLinksInput {
+    slug: string;
+}
+export declare function get_shareable_links(input: GetLinksInput, ctx: ToolContext): Promise<{
+    success: boolean;
+    links: any;
+    message: string;
+}>;
+export declare namespace get_shareable_links {
+    var metadata: {
+        name: string;
+        displayName: string;
+        description: string;
+        parameters: {
+            slug: {
+                type: string;
+                description: string;
+                required: boolean;
+            };
+        };
+    };
+}
+export declare function get_subscription(_input: Record<string, never>, ctx: ToolContext): Promise<{
+    success: boolean;
+    subscription: any;
+    message: string;
+}>;
+export declare namespace get_subscription {
+    var metadata: {
+        name: string;
+        displayName: string;
+        description: string;
+        parameters: {};
+    };
+}
+export declare function definePluginEntry(): {
+    name: string;
+    tools: (typeof register | typeof get_card | typeof create_or_update_card | typeof get_analytics | typeof create_shareable_link | typeof get_shareable_links | typeof get_subscription)[];
+};
+export {};

package/dist/index.js

@@ -0,0 +1,209 @@
+"use strict";
+/**
+ * KadiConnect OpenClaw Plugin
+ *
+ * Provides tools for managing digital business cards via the KadiConnect API.
+ * Requires an API key — generate one at https://kadiconnect.com/dashboard?tab=apikeys
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.register = register;
+exports.get_card = get_card;
+exports.create_or_update_card = create_or_update_card;
+exports.get_analytics = get_analytics;
+exports.create_shareable_link = create_shareable_link;
+exports.get_shareable_links = get_shareable_links;
+exports.get_subscription = get_subscription;
+exports.definePluginEntry = definePluginEntry;
+function getHeaders(config) {
+    return {
+        Authorization: `Bearer ${config.apiKey}`,
+        'Content-Type': 'application/json',
+    };
+}
+function baseUrl(config) {
+    return (config.baseUrl || 'https://kadiconnect.com').replace(/\/$/, '');
+}
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+async function apiRequest(config, path, options = {}) {
+    const url = `${baseUrl(config)}/api${path}`;
+    const res = await fetch(url, {
+        ...options,
+        headers: { ...getHeaders(config), ...(options.headers || {}) },
+    });
+    const body = await res.json();
+    if (!res.ok) {
+        throw new Error(body.error || `API request failed with status ${res.status}`);
+    }
+    return body;
+}
+async function register(input, ctx) {
+    const url = `${baseUrl(ctx.config)}/api/register`;
+    const res = await fetch(url, {
+        method: 'POST',
+        headers: { 'Content-Type': 'application/json' },
+        body: JSON.stringify(input),
+    });
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const body = await res.json();
+    if (!res.ok) {
+        throw new Error(body.error || `Registration failed with status ${res.status}`);
+    }
+    return {
+        success: true,
+        user: body.user,
+        apiKey: body.apiKey,
+        message: `Account created for ${body.user.email}. API key: ${body.apiKey} — store this securely and use it for all subsequent requests.`,
+    };
+}
+register.metadata = {
+    name: 'register',
+    displayName: 'Register New Account',
+    description: 'Create a new KadiConnect account and receive an API key. No browser navigation needed. Use the returned API key for all other tools.',
+    parameters: {
+        name: { type: 'string', description: 'Full name for the account', required: true },
+        email: { type: 'string', description: 'Email address', required: true },
+        password: { type: 'string', description: 'Password (minimum 8 characters)', required: true },
+    },
+};
+// ─── Tool: get_card ──────────────────────────────────────────────────────────
+async function get_card(_input, ctx) {
+    const data = await apiRequest(ctx.config, '/cards');
+    return {
+        success: true,
+        card: data.card || null,
+        message: data.card
+            ? `Found card "${data.card.name}" (slug: ${data.card.slug})`
+            : 'No business card exists yet. Use create_or_update_card to create one.',
+    };
+}
+get_card.metadata = {
+    name: 'get_card',
+    displayName: 'Get Business Card',
+    description: 'Retrieve the current user\'s KadiConnect digital business card, including all contact info, social links, and customisation.',
+    parameters: {},
+};
+async function create_or_update_card(input, ctx) {
+    const data = await apiRequest(ctx.config, '/cards', {
+        method: 'POST',
+        body: JSON.stringify(input),
+    });
+    return {
+        success: true,
+        card: data.card,
+        message: `Card "${data.card.name}" saved. View it at ${baseUrl(ctx.config)}/card/${data.card.slug}`,
+    };
+}
+create_or_update_card.metadata = {
+    name: 'create_or_update_card',
+    displayName: 'Create or Update Business Card',
+    description: 'Create a new KadiConnect digital business card or update the existing one. Pass any combination of fields to set or change.',
+    parameters: {
+        name: { type: 'string', description: 'Full name displayed on the card', required: true },
+        jobTitle: { type: 'string', description: 'Job title / role' },
+        company: { type: 'string', description: 'Company or organisation name' },
+        bio: { type: 'string', description: 'Short bio or tagline' },
+        email: { type: 'string', description: 'Contact email address' },
+        phone: { type: 'string', description: 'Phone number' },
+        website: { type: 'string', description: 'Personal or company website URL' },
+        location: { type: 'string', description: 'City, country, or address' },
+        linkedIn: { type: 'string', description: 'LinkedIn profile URL' },
+        twitter: { type: 'string', description: 'Twitter / X handle or URL' },
+        github: { type: 'string', description: 'GitHub profile URL' },
+        instagram: { type: 'string', description: 'Instagram handle or URL' },
+        facebook: { type: 'string', description: 'Facebook profile URL' },
+        tiktok: { type: 'string', description: 'TikTok handle or URL' },
+        youtube: { type: 'string', description: 'YouTube channel URL' },
+        primaryColor: { type: 'string', description: 'Primary brand colour (hex, e.g. #2563eb)' },
+        backgroundColor: { type: 'string', description: 'Background colour (hex)' },
+        fontFamily: { type: 'string', description: 'Font family name' },
+        layout: { type: 'string', description: 'Card layout: modern, classic, minimal, or bold' },
+        showQrCode: { type: 'boolean', description: 'Show QR code on the card' },
+        enableLeadCapture: { type: 'boolean', description: 'Enable the lead capture form' },
+        leadCaptureTitle: { type: 'string', description: 'Title for the lead capture form' },
+        leadCaptureDescription: { type: 'string', description: 'Description for the lead capture form' },
+    },
+};
+async function get_analytics(input, ctx) {
+    const data = await apiRequest(ctx.config, `/cards/${input.slug}/analytics`);
+    return {
+        success: true,
+        analytics: data,
+        message: `Analytics for card "${input.slug}": ${data.totalViews ?? 0} total views.`,
+    };
+}
+get_analytics.metadata = {
+    name: 'get_analytics',
+    displayName: 'Get Card Analytics',
+    description: 'Fetch view counts and analytics data for a business card.',
+    parameters: {
+        slug: { type: 'string', description: 'The card slug (from get_card)', required: true },
+    },
+};
+async function create_shareable_link(input, ctx) {
+    const data = await apiRequest(ctx.config, `/cards/${input.slug}/shareable-links`, {
+        method: 'POST',
+        body: JSON.stringify({ name: input.name }),
+    });
+    return {
+        success: true,
+        link: data.shareableLink,
+        message: `Shareable link created: ${baseUrl(ctx.config)}/s/${data.shareableLink.identifier}`,
+    };
+}
+create_shareable_link.metadata = {
+    name: 'create_shareable_link',
+    displayName: 'Create Shareable Link',
+    description: 'Generate a tracked shareable link for the business card. Each link has its own view counter for campaign tracking.',
+    parameters: {
+        slug: { type: 'string', description: 'The card slug', required: true },
+        name: { type: 'string', description: 'Name/label for the link (e.g. "LinkedIn outreach")', required: true },
+    },
+};
+async function get_shareable_links(input, ctx) {
+    const data = await apiRequest(ctx.config, `/cards/${input.slug}/shareable-links`);
+    return {
+        success: true,
+        links: data.shareableLinks,
+        message: `Found ${data.shareableLinks.length} shareable link(s).`,
+    };
+}
+get_shareable_links.metadata = {
+    name: 'get_shareable_links',
+    displayName: 'Get Shareable Links',
+    description: 'List all tracked shareable links for a business card.',
+    parameters: {
+        slug: { type: 'string', description: 'The card slug', required: true },
+    },
+};
+// ─── Tool: get_subscription ──────────────────────────────────────────────────
+async function get_subscription(_input, ctx) {
+    const data = await apiRequest(ctx.config, '/user/subscription');
+    return {
+        success: true,
+        subscription: data,
+        message: data.tier === 'free'
+            ? 'User is on the Free tier (25 card views). Upgrade to Pro ($4/month) for unlimited views at https://kadiconnect.com/upgrade'
+            : `User is on the ${data.tier} plan (status: ${data.status}).`,
+    };
+}
+get_subscription.metadata = {
+    name: 'get_subscription',
+    displayName: 'Get Subscription Info',
+    description: 'Check the user\'s current KadiConnect subscription tier and status. The Free tier allows 25 card views; Pro ($4/month) unlocks unlimited views.',
+    parameters: {},
+};
+// ─── Plugin entry point ──────────────────────────────────────────────────────
+function definePluginEntry() {
+    return {
+        name: '@kadiconnect/openclaw-plugin',
+        tools: [
+            register,
+            get_card,
+            create_or_update_card,
+            get_analytics,
+            create_shareable_link,
+            get_shareable_links,
+            get_subscription,
+        ],
+    };
+}

package/openclaw.plugin.json

@@ -0,0 +1,36 @@
+{
+  "name": "@kadiconnect/openclaw-plugin",
+  "displayName": "KadiConnect — Digital Business Cards",
+  "version": "1.0.0",
+  "description": "Create, update, and manage professional digital business cards on KadiConnect. Ideal for client outreach, job hunting, networking events, and more.",
+  "author": "KadiConnect",
+  "homepage": "https://kadiconnect.com",
+  "repository": "https://github.com/kadiconnect/openclaw-plugin",
+  "icon": "https://kadiconnect.com/icon.png",
+  "entry": "./dist/index.js",
+  "config": {
+    "apiKey": {
+      "type": "string",
+      "label": "KadiConnect API Key",
+      "description": "Your KadiConnect API key (starts with kc_). Generate one at https://kadiconnect.com/dashboard?tab=apikeys or navigate to the dashboard and open the API Keys tab.",
+      "required": true,
+      "secret": true
+    },
+    "baseUrl": {
+      "type": "string",
+      "label": "API Base URL",
+      "description": "KadiConnect API base URL (default: https://kadiconnect.com)",
+      "required": false,
+      "default": "https://kadiconnect.com"
+    }
+  },
+  "tools": [
+    "register",
+    "get_card",
+    "create_or_update_card",
+    "get_analytics",
+    "create_shareable_link",
+    "get_shareable_links",
+    "get_subscription"
+  ]
+}

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "@kadiconnect/openclaw-plugin",
+  "version": "1.0.0",
+  "description": "OpenClaw plugin for managing KadiConnect digital business cards via API",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "openclaw",
+    "openclaw-plugin",
+    "kadiconnect",
+    "business-card",
+    "digital-card"
+  ],
+  "license": "MIT",
+  "devDependencies": {
+    "typescript": "^5.0.0"
+  }
+}