@iwas/mcp 0.0.0-stage → 1.0.0

package/dist/registrar-CNvQygSE.d.ts

@@ -0,0 +1,192 @@
+import { z } from 'zod';
+
+declare const CATALOG_DEFINITIONS: {
+    readonly organization: {
+        readonly tier: "T";
+        readonly actions: readonly ["update", "delete"];
+        readonly description: "Organization tenant profile and settings";
+        readonly models: readonly ["Organization", "OrganizationSetting", "OrganizationSubscription"];
+        readonly mcpEligible: true;
+    };
+    readonly member: {
+        readonly tier: "T";
+        readonly actions: readonly ["create", "update", "delete"];
+        readonly description: "Organization member management";
+        readonly models: readonly ["Member"];
+        readonly mcpEligible: true;
+    };
+    readonly invitation: {
+        readonly tier: "T";
+        readonly actions: readonly ["create", "cancel"];
+        readonly description: "Organization membership invitations";
+        readonly models: readonly ["Invitation"];
+        readonly mcpEligible: true;
+    };
+    readonly location: {
+        readonly tier: "T";
+        readonly actions: readonly ["read", "write", "delete"];
+        readonly description: "Physical hotspot location management";
+        readonly models: readonly ["Location"];
+        readonly mcpEligible: true;
+    };
+    readonly router: {
+        readonly tier: "T";
+        readonly actions: readonly ["read", "write", "delete", "control"];
+        readonly description: "Gateway router inventory, provisioning and control";
+        readonly models: readonly ["Router", "ZtpToken", "CoaQueue", "IpamAllocationCursor"];
+        readonly mcpEligible: true;
+    };
+    readonly package: {
+        readonly tier: "S";
+        readonly actions: readonly ["read", "write", "delete", "publish"];
+        readonly description: "WiFi access package catalog (tenant + shared)";
+        readonly models: readonly ["Package", "VoucherPackage"];
+        readonly mcpEligible: true;
+    };
+    readonly voucher: {
+        readonly tier: "S";
+        readonly actions: readonly ["read", "write", "publish", "issue", "revoke"];
+        readonly description: "Prepaid voucher codes and issuance (tenant + shared)";
+        readonly models: readonly ["Voucher", "VoucherIssuance", "VoucherUser"];
+        readonly mcpEligible: true;
+    };
+    readonly session: {
+        readonly tier: "T";
+        readonly actions: readonly ["read", "control"];
+        readonly description: "Active and historical WiFi guest sessions";
+        readonly models: readonly ["WifiSession", "RadiusAccounting", "DeviceToken"];
+        readonly mcpEligible: true;
+    };
+    readonly wallet: {
+        readonly tier: "T";
+        readonly actions: readonly ["read", "topup", "charge", "refund", "freeze"];
+        readonly description: "Prepaid wallet balances, topups and ledger transactions (SENSITIVE - MCP EXCLUDED)";
+        readonly models: readonly ["Wallet", "WalletTransaction", "TopupRequest"];
+        readonly hasOwnQualifier: true;
+        readonly mcpEligible: false;
+    };
+    readonly payment: {
+        readonly tier: "T";
+        readonly actions: readonly ["read", "approve", "refund"];
+        readonly description: "Inbound payment transactions and gateway integrations (SENSITIVE - MCP EXCLUDED)";
+        readonly models: readonly ["PaymentTransaction", "PaymentGatewayIntegration"];
+        readonly hasOwnQualifier: true;
+        readonly mcpEligible: false;
+    };
+    readonly subscription: {
+        readonly tier: "T";
+        readonly actions: readonly ["read", "manage"];
+        readonly description: "SaaS organization plan subscription and entitlements";
+        readonly models: readonly ["OrganizationSubscription"];
+        readonly mcpEligible: true;
+    };
+    readonly partner: {
+        readonly tier: "T";
+        readonly actions: readonly ["read", "manage", "payout:approve"];
+        readonly description: "Affiliate/partner programs and payout requests";
+        readonly models: readonly ["Partner", "PartnerPayoutRequest"];
+        readonly mcpEligible: true;
+    };
+    readonly campaign: {
+        readonly tier: "T";
+        readonly actions: readonly ["read", "write"];
+        readonly description: "Captive portal ad campaigns and lead capture";
+        readonly models: readonly ["AdCampaign", "LeadCapture"];
+        readonly mcpEligible: true;
+    };
+    readonly notification: {
+        readonly tier: "T";
+        readonly actions: readonly ["read", "send", "template:write"];
+        readonly description: "Multi-channel notifications, templates and logs";
+        readonly models: readonly ["NotificationItem", "NotificationTemplate", "DeliveryLog"];
+        readonly hasOwnQualifier: true;
+        readonly mcpEligible: true;
+    };
+    readonly store: {
+        readonly tier: "P";
+        readonly actions: readonly ["read", "write"];
+        readonly description: "Public hardware/affiliate store catalog";
+        readonly models: readonly ["StoreProduct", "AffiliateClick"];
+        readonly mcpEligible: true;
+    };
+    readonly blog: {
+        readonly tier: "P";
+        readonly actions: readonly ["read", "write", "publish"];
+        readonly description: "Company-wide editorial articles and CDN media";
+        readonly models: readonly ["BlogPost", "Media"];
+        readonly hasOwnQualifier: true;
+        readonly mcpEligible: true;
+    };
+    readonly analytics: {
+        readonly tier: "D";
+        readonly actions: readonly ["read"];
+        readonly description: "Aggregated usage, session and revenue metrics";
+        readonly models: readonly ["WifiSession", "Package", "PaymentTransaction"];
+        readonly mcpEligible: true;
+    };
+    readonly diagnostics: {
+        readonly tier: "P";
+        readonly actions: readonly ["read", "write"];
+        readonly description: "System error events, MCP tool execution spans, flow events, issue triage and audit logs";
+        readonly models: readonly ["ErrorEvent", "McpToolSpan", "AuditLog", "SystemSetting", "FlowEvent", "IssueState"];
+        readonly mcpEligible: true;
+    };
+};
+type Resource = keyof typeof CATALOG_DEFINITIONS;
+type ActionFor<R extends Resource> = (typeof CATALOG_DEFINITIONS)[R]['actions'][number];
+type PermMap = {
+    [R in Resource]: `${R}:${ActionFor<R>}`;
+};
+type PermissionString = PermMap[Resource];
+/**
+ * Type guard validating that a candidate string is a valid catalog permission.
+ */
+declare function isPermissionString(value: unknown): value is PermissionString;
+
+type McpCapabilityType = 'tool' | 'prompt';
+interface McpToolAnnotations {
+    readOnlyHint?: boolean;
+}
+type McpDomain = 'health' | 'analytics' | 'sessions' | 'insights' | 'diagnostics' | 'blog' | 'prompts';
+type McpToolParamsShape = z.ZodRawShape | Record<string, never>;
+interface McpToolDefinition<TShape extends McpToolParamsShape = z.ZodRawShape> {
+    type: 'tool';
+    name: string;
+    methodName: string;
+    domain: McpDomain;
+    description: string;
+    paramsSchema: TShape;
+    annotations?: McpToolAnnotations;
+    permissions: PermissionString[] | 'public';
+    platformScopeOnly?: boolean;
+}
+interface McpPromptDefinition<TShape extends McpToolParamsShape = z.ZodRawShape> {
+    type: 'prompt';
+    name: string;
+    methodName: string;
+    domain: 'prompts';
+    description: string;
+    argsSchema: TShape;
+    permissions: PermissionString[];
+}
+type McpCapabilityDefinition = McpToolDefinition | McpPromptDefinition;
+
+/**
+ * Abstract registrar interface for registering tools and prompts with an MCP server implementation.
+ */
+interface ToolRegistrar<TContext = unknown> {
+    registerTool(definition: McpToolDefinition, handler: (args: Record<string, unknown>, extra: TContext) => Promise<unknown>): void;
+    registerPrompt(definition: McpPromptDefinition, handler: (args: Record<string, unknown>, extra: TContext) => Promise<unknown>): void;
+}
+/**
+ * Interface for invoking tools and retrieving prompts programmatically.
+ */
+interface ToolClient {
+    callTool(name: string, args?: Record<string, unknown>): Promise<unknown>;
+    getPrompt(name: string, args?: Record<string, unknown>): Promise<unknown>;
+    listTools(): Promise<McpToolDefinition[]>;
+    listPrompts(): Promise<McpPromptDefinition[]>;
+}
+
+export { CATALOG_DEFINITIONS as C, isPermissionString as i };
+export type { McpCapabilityDefinition as M, PermissionString as P, Resource as R, ToolClient as T, McpCapabilityType as a, McpDomain as b, McpPromptDefinition as c, McpToolAnnotations as d, McpToolDefinition as e, McpToolParamsShape as f, ToolRegistrar as g };

package/package.json

@@ -1,6 +1,72 @@
 {
   "name": "@iwas/mcp",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "1.0.0",
+  "description": "Intelligent WiFi Access & Presence Service (IWAS) Model Context Protocol (MCP) CLI & SDK",
+  "license": "MIT",
+  "author": "9xlayer <support@getiwas.com>",
+  "homepage": "https://getiwas.com",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/9xlayer/iwas.git",
+    "directory": "packages/mcp"
+  },
+  "keywords": [
+    "iwas",
+    "mcp",
+    "model-context-protocol",
+    "wifi",
+    "hotspot",
+    "billing",
+    "cli",
+    "oauth2",
+    "device-flow"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "bin": {
+    "iwas": "./dist/bin.js",
+    "iwas-mcp": "./dist/bin.js"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./catalog": {
+      "types": "./dist/catalog/index.d.ts",
+      "default": "./dist/catalog/index.js"
+    },
+    "./client": {
+      "types": "./dist/client/index.d.ts",
+      "default": "./dist/client/index.js"
+    },
+    "./auth": {
+      "types": "./dist/auth/index.d.ts",
+      "default": "./dist/auth/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.29.0",
+    "jose": "^6.0.8",
+    "zod": "^4.4.3"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.2",
+    "tsup": "^9.0.0",
+    "typescript": "^6.0.3",
+    "@iwas/auth": "1.0.0"
+  },
+  "scripts": {
+    "build": "tsup",
+    "build:types": "tsc -p tsconfig.types.json",
+    "test": "tsup && node --test tests/index.spec.mjs tests/catalog.spec.mjs tests/credentials-vault.spec.mjs tests/device-flow.spec.mjs tests/token-refresh.spec.mjs tests/logout.spec.mjs"
+  }
 }