@awi-protocol/site-sdk 0.1.0

package/.turbo/turbo-build.log

@@ -0,0 +1,14 @@
+$ tsup src/index.ts --format cjs,esm --dts
+CLI Building entry: src/index.ts
+CLI tsup v8.5.1
+CLI Target: node16
+CJS Build start
+ESM Build start
+ESM dist\index.mjs 2.84 KB
+ESM ⚡️ Build success in 42ms
+CJS dist\index.js 3.45 KB
+CJS ⚡️ Build success in 43ms
+DTS Build start
+DTS ⚡️ Build success in 2096ms
+DTS dist\index.d.ts  1.27 KB
+DTS dist\index.d.mts 1.27 KB

package/dist/index.d.mts

@@ -0,0 +1,51 @@
+import { Request, Response, NextFunction } from 'express';
+
+/**
+ * AWI Site SDK for JavaScript/TypeScript
+ *
+ * Build agent-native endpoints for your website.
+ *
+ * @example
+ * ```typescript
+ * import { AWISite } from '@awi-protocol/site-sdk';
+ * import express from 'express';
+ *
+ * const app = new AWISite();
+ *
+ * app.route('/jobs/search', (req, res) => {
+ *   const { query, location } = req.body.params;
+ *   const jobs = db.search(query, location);
+ *   res.json({ success: true, data: jobs });
+ * });
+ *
+ * // Mount on your Express app
+ * express().use('/awi', app.middleware());
+ * ```
+ */
+
+interface RouteHandler {
+    (req: Request, res: Response, next: NextFunction): void;
+}
+interface RouteDefinition {
+    path: string;
+    methods: string[];
+    handler: RouteHandler;
+    parameters: Array<{
+        name: string;
+        type: string;
+        required: boolean;
+    }>;
+    returnType: string;
+    intent: string;
+}
+declare class AWISite {
+    private routes;
+    private axirRegistry;
+    route(path: string, handler: RouteHandler, methods?: string[]): this;
+    middleware(): any;
+    getRecipeBlueprint(domain: string, path: string): any;
+    generateManifest(): any;
+    private _extractParamNames;
+}
+
+export { AWISite, type RouteDefinition, type RouteHandler, AWISite as default };

package/dist/index.d.ts

@@ -0,0 +1,51 @@
+import { Request, Response, NextFunction } from 'express';
+
+/**
+ * AWI Site SDK for JavaScript/TypeScript
+ *
+ * Build agent-native endpoints for your website.
+ *
+ * @example
+ * ```typescript
+ * import { AWISite } from '@awi-protocol/site-sdk';
+ * import express from 'express';
+ *
+ * const app = new AWISite();
+ *
+ * app.route('/jobs/search', (req, res) => {
+ *   const { query, location } = req.body.params;
+ *   const jobs = db.search(query, location);
+ *   res.json({ success: true, data: jobs });
+ * });
+ *
+ * // Mount on your Express app
+ * express().use('/awi', app.middleware());
+ * ```
+ */
+
+interface RouteHandler {
+    (req: Request, res: Response, next: NextFunction): void;
+}
+interface RouteDefinition {
+    path: string;
+    methods: string[];
+    handler: RouteHandler;
+    parameters: Array<{
+        name: string;
+        type: string;
+        required: boolean;
+    }>;
+    returnType: string;
+    intent: string;
+}
+declare class AWISite {
+    private routes;
+    private axirRegistry;
+    route(path: string, handler: RouteHandler, methods?: string[]): this;
+    middleware(): any;
+    getRecipeBlueprint(domain: string, path: string): any;
+    generateManifest(): any;
+    private _extractParamNames;
+}
+
+export { AWISite, type RouteDefinition, type RouteHandler, AWISite as default };

package/dist/index.js

@@ -0,0 +1,112 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  AWISite: () => AWISite,
+  default: () => index_default
+});
+module.exports = __toCommonJS(index_exports);
+var AWISite = class {
+  routes = /* @__PURE__ */ new Map();
+  axirRegistry = /* @__PURE__ */ new Map();
+  route(path, handler, methods = ["POST"]) {
+    const paramNames = this._extractParamNames(handler);
+    this.routes.set(path, {
+      path,
+      methods,
+      handler,
+      parameters: paramNames.map((name) => ({
+        name,
+        type: "string",
+        required: true
+      })),
+      returnType: "unknown",
+      intent: handler.name || "unnamed"
+    });
+    this.axirRegistry.set(path, {
+      intent: handler.name || "unnamed",
+      action: path.replace(/\//g, "_").replace(/^_/, ""),
+      parameters: paramNames,
+      semantic_context: {
+        native: true,
+        return_schema: "unknown"
+      }
+    });
+    return this;
+  }
+  middleware() {
+    const express = require("express");
+    const router = express.Router();
+    for (const [path, def] of this.routes) {
+      for (const method of def.methods) {
+        router[method.toLowerCase()](path, def.handler);
+      }
+    }
+    router.get("/manifest", (_req, res) => {
+      res.json(this.generateManifest());
+    });
+    router.post("/blueprint", (req, res) => {
+      const { path: routePath } = req.body;
+      const blueprint = this.getRecipeBlueprint(req.hostname, routePath);
+      res.json(blueprint);
+    });
+    return router;
+  }
+  getRecipeBlueprint(domain, path) {
+    const route = this.routes.get(path);
+    if (!route) {
+      throw new Error(`Route not found: ${path}`);
+    }
+    return {
+      recipe_id: `${domain.replace(/\./g, "_")}${path.replace(/\//g, "_")}_v1`,
+      target: `awi://${domain}${path}/v1`,
+      native: true,
+      endpoint: `https://${domain}/awi${path}`,
+      method: route.methods[0],
+      parameters: route.parameters,
+      return_schema: route.returnType,
+      axir: this.axirRegistry.get(path),
+      estimated_latency_ms: 50
+    };
+  }
+  generateManifest() {
+    return {
+      version: "1.0.0",
+      native: true,
+      routes: Array.from(this.routes.values()).map((route) => ({
+        path: route.path,
+        intent: route.intent,
+        parameters: route.parameters,
+        methods: route.methods
+      }))
+    };
+  }
+  _extractParamNames(handler) {
+    const fnStr = handler.toString();
+    const match = fnStr.match(/\(([^)]*)\)/);
+    if (!match) return [];
+    return match[1].split(",").map((p) => p.trim().split(/[=:\s]/)[0]).filter((p) => p && p !== "req" && p !== "res" && p !== "next");
+  }
+};
+var index_default = AWISite;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  AWISite
+});

package/dist/index.mjs

@@ -0,0 +1,95 @@
+var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
+  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
+}) : x)(function(x) {
+  if (typeof require !== "undefined") return require.apply(this, arguments);
+  throw Error('Dynamic require of "' + x + '" is not supported');
+});
+
+// src/index.ts
+var AWISite = class {
+  routes = /* @__PURE__ */ new Map();
+  axirRegistry = /* @__PURE__ */ new Map();
+  route(path, handler, methods = ["POST"]) {
+    const paramNames = this._extractParamNames(handler);
+    this.routes.set(path, {
+      path,
+      methods,
+      handler,
+      parameters: paramNames.map((name) => ({
+        name,
+        type: "string",
+        required: true
+      })),
+      returnType: "unknown",
+      intent: handler.name || "unnamed"
+    });
+    this.axirRegistry.set(path, {
+      intent: handler.name || "unnamed",
+      action: path.replace(/\//g, "_").replace(/^_/, ""),
+      parameters: paramNames,
+      semantic_context: {
+        native: true,
+        return_schema: "unknown"
+      }
+    });
+    return this;
+  }
+  middleware() {
+    const express = __require("express");
+    const router = express.Router();
+    for (const [path, def] of this.routes) {
+      for (const method of def.methods) {
+        router[method.toLowerCase()](path, def.handler);
+      }
+    }
+    router.get("/manifest", (_req, res) => {
+      res.json(this.generateManifest());
+    });
+    router.post("/blueprint", (req, res) => {
+      const { path: routePath } = req.body;
+      const blueprint = this.getRecipeBlueprint(req.hostname, routePath);
+      res.json(blueprint);
+    });
+    return router;
+  }
+  getRecipeBlueprint(domain, path) {
+    const route = this.routes.get(path);
+    if (!route) {
+      throw new Error(`Route not found: ${path}`);
+    }
+    return {
+      recipe_id: `${domain.replace(/\./g, "_")}${path.replace(/\//g, "_")}_v1`,
+      target: `awi://${domain}${path}/v1`,
+      native: true,
+      endpoint: `https://${domain}/awi${path}`,
+      method: route.methods[0],
+      parameters: route.parameters,
+      return_schema: route.returnType,
+      axir: this.axirRegistry.get(path),
+      estimated_latency_ms: 50
+    };
+  }
+  generateManifest() {
+    return {
+      version: "1.0.0",
+      native: true,
+      routes: Array.from(this.routes.values()).map((route) => ({
+        path: route.path,
+        intent: route.intent,
+        parameters: route.parameters,
+        methods: route.methods
+      }))
+    };
+  }
+  _extractParamNames(handler) {
+    const fnStr = handler.toString();
+    const match = fnStr.match(/\(([^)]*)\)/);
+    if (!match) return [];
+    return match[1].split(",").map((p) => p.trim().split(/[=:\s]/)[0]).filter((p) => p && p !== "req" && p !== "res" && p !== "next");
+  }
+};
+var index_default = AWISite;
+export {
+  AWISite,
+  index_default as default
+};

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@awi-protocol/site-sdk",
+  "version": "0.1.0",
+  "description": "Build agent-native endpoints for your website",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "test": "vitest run"
+  },
+  "keywords": [
+    "awi",
+    "agent-web-interface",
+    "site-sdk",
+    "ai-agent",
+    "browser-automation"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "express": "^4.18.0"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.0",
+    "express": "^4.18.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.3.0"
+  }
+}

package/src/index.ts

@@ -0,0 +1,147 @@
+/**
+ * AWI Site SDK for JavaScript/TypeScript
+ * 
+ * Build agent-native endpoints for your website.
+ * 
+ * @example
+ * ```typescript
+ * import { AWISite } from '@awi-protocol/site-sdk';
+ * import express from 'express';
+ * 
+ * const app = new AWISite();
+ * 
+ * app.route('/jobs/search', (req, res) => {
+ *   const { query, location } = req.body.params;
+ *   const jobs = db.search(query, location);
+ *   res.json({ success: true, data: jobs });
+ * });
+ * 
+ * // Mount on your Express app
+ * express().use('/awi', app.middleware());
+ * ```
+ */
+
+import type { Request, Response, NextFunction } from 'express';
+
+export interface RouteHandler {
+  (req: Request, res: Response, next: NextFunction): void;
+}
+
+export interface RouteDefinition {
+  path: string;
+  methods: string[];
+  handler: RouteHandler;
+  parameters: Array<{
+    name: string;
+    type: string;
+    required: boolean;
+  }>;
+  returnType: string;
+  intent: string;
+}
+
+export class AWISite {
+  private routes: Map<string, RouteDefinition> = new Map();
+  private axirRegistry: Map<string, any> = new Map();
+
+  route(path: string, handler: RouteHandler, methods: string[] = ['POST']): this {
+    // Extract parameter info from handler
+    const paramNames = this._extractParamNames(handler);
+
+    this.routes.set(path, {
+      path,
+      methods,
+      handler,
+      parameters: paramNames.map(name => ({
+        name,
+        type: 'string',
+        required: true,
+      })),
+      returnType: 'unknown',
+      intent: handler.name || 'unnamed',
+    });
+
+    this.axirRegistry.set(path, {
+      intent: handler.name || 'unnamed',
+      action: path.replace(/\//g, '_').replace(/^_/,''),
+      parameters: paramNames,
+      semantic_context: {
+        native: true,
+        return_schema: 'unknown',
+      },
+    });
+
+    return this;
+  }
+
+  middleware(): any {
+    const express = require('express');
+    const router = express.Router();
+
+    // Register all routes
+    for (const [path, def] of this.routes) {
+      for (const method of def.methods) {
+        router[method.toLowerCase()](path, def.handler);
+      }
+    }
+
+    // Add manifest endpoint
+    router.get('/manifest', (_req: Request, res: Response) => {
+      res.json(this.generateManifest());
+    });
+
+    // Add blueprint endpoint
+    router.post('/blueprint', (req: Request, res: Response) => {
+      const { path: routePath } = req.body;
+      const blueprint = this.getRecipeBlueprint(req.hostname, routePath);
+      res.json(blueprint);
+    });
+
+    return router;
+  }
+
+  getRecipeBlueprint(domain: string, path: string): any {
+    const route = this.routes.get(path);
+    if (!route) {
+      throw new Error(`Route not found: ${path}`);
+    }
+
+    return {
+      recipe_id: `${domain.replace(/\./g, '_')}${path.replace(/\//g, '_')}_v1`,
+      target: `awi://${domain}${path}/v1`,
+      native: true,
+      endpoint: `https://${domain}/awi${path}`,
+      method: route.methods[0],
+      parameters: route.parameters,
+      return_schema: route.returnType,
+      axir: this.axirRegistry.get(path),
+      estimated_latency_ms: 50,
+    };
+  }
+
+  generateManifest(): any {
+    return {
+      version: '1.0.0',
+      native: true,
+      routes: Array.from(this.routes.values()).map(route => ({
+        path: route.path,
+        intent: route.intent,
+        parameters: route.parameters,
+        methods: route.methods,
+      })),
+    };
+  }
+
+  private _extractParamNames(handler: Function): string[] {
+    const fnStr = handler.toString();
+    const match = fnStr.match(/\(([^)]*)\)/);
+    if (!match) return [];
+
+    return match[1]
+      .split(',')
+      .map(p => p.trim().split(/[=:\s]/)[0])
+      .filter(p => p && p !== 'req' && p !== 'res' && p !== 'next');
+  }
+}
+
+export default AWISite;