@amtp/protocol 1.0.1

package/dist/types/amtp.types.js

@@ -0,0 +1,224 @@
+"use strict";
+/**
+ * AMTP Protocol - TypeScript Type Definitions
+ * Core types, schemas, and interfaces for the Agent Markdown Transfer Protocol
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AMTPError = exports.ErrorCode = exports.NotificationEventType = exports.StreamUpdateType = exports.AuthMethod = exports.LinkType = exports.FormFieldType = exports.ParameterType = exports.MarkdownNodeType = exports.AgentCapability = exports.StatusCode = exports.HTTPMethod = exports.MIMEType = void 0;
+/** Supported MIME types */
+var MIMEType;
+(function (MIMEType) {
+    MIMEType["AMTP_MARKDOWN"] = "text/amtp+markdown";
+    MIMEType["APP_AMTP_MARKDOWN"] = "application/amtp+markdown";
+    MIMEType["MARKDOWN"] = "text/markdown";
+    MIMEType["HTML"] = "text/html";
+    MIMEType["JSON"] = "application/json";
+    MIMEType["EVENT_STREAM"] = "text/event-stream";
+    MIMEType["FORM_URLENCODED"] = "application/x-www-form-urlencoded";
+})(MIMEType || (exports.MIMEType = MIMEType = {}));
+/** HTTP methods */
+var HTTPMethod;
+(function (HTTPMethod) {
+    HTTPMethod["GET"] = "GET";
+    HTTPMethod["POST"] = "POST";
+    HTTPMethod["PUT"] = "PUT";
+    HTTPMethod["PATCH"] = "PATCH";
+    HTTPMethod["DELETE"] = "DELETE";
+    HTTPMethod["HEAD"] = "HEAD";
+    HTTPMethod["OPTIONS"] = "OPTIONS";
+})(HTTPMethod || (exports.HTTPMethod = HTTPMethod = {}));
+/** AMTP Status codes (extend HTTP) */
+var StatusCode;
+(function (StatusCode) {
+    // 2xx Success
+    StatusCode[StatusCode["OK"] = 200] = "OK";
+    StatusCode[StatusCode["CREATED"] = 201] = "CREATED";
+    StatusCode[StatusCode["ACCEPTED"] = 202] = "ACCEPTED";
+    StatusCode[StatusCode["NO_CONTENT"] = 204] = "NO_CONTENT";
+    // 3xx Redirection
+    StatusCode[StatusCode["MOVED_PERMANENTLY"] = 301] = "MOVED_PERMANENTLY";
+    StatusCode[StatusCode["FOUND"] = 302] = "FOUND";
+    StatusCode[StatusCode["NOT_MODIFIED"] = 304] = "NOT_MODIFIED";
+    // 4xx Client Error
+    StatusCode[StatusCode["BAD_REQUEST"] = 400] = "BAD_REQUEST";
+    StatusCode[StatusCode["UNAUTHORIZED"] = 401] = "UNAUTHORIZED";
+    StatusCode[StatusCode["FORBIDDEN"] = 403] = "FORBIDDEN";
+    StatusCode[StatusCode["NOT_FOUND"] = 404] = "NOT_FOUND";
+    StatusCode[StatusCode["CONFLICT"] = 409] = "CONFLICT";
+    StatusCode[StatusCode["UNPROCESSABLE_ENTITY"] = 422] = "UNPROCESSABLE_ENTITY";
+    StatusCode[StatusCode["TOO_MANY_REQUESTS"] = 429] = "TOO_MANY_REQUESTS";
+    // 5xx Server Error
+    StatusCode[StatusCode["INTERNAL_ERROR"] = 500] = "INTERNAL_ERROR";
+    StatusCode[StatusCode["SERVICE_UNAVAILABLE"] = 503] = "SERVICE_UNAVAILABLE";
+})(StatusCode || (exports.StatusCode = StatusCode = {}));
+/** Supported AMTP capabilities */
+var AgentCapability;
+(function (AgentCapability) {
+    AgentCapability["ACTIONS"] = "actions";
+    AgentCapability["STREAMING"] = "streaming";
+    AgentCapability["FORMS"] = "forms";
+    AgentCapability["TOOLS"] = "tools";
+    AgentCapability["MULTIMODAL"] = "multimodal";
+    AgentCapability["PAGINATION"] = "pagination";
+    AgentCapability["SESSIONS"] = "sessions";
+    AgentCapability["FILE_UPLOAD"] = "file_upload";
+})(AgentCapability || (exports.AgentCapability = AgentCapability = {}));
+/* ============================================================================
+   MARKDOWN DOCUMENT TYPES
+   ========================================================================== */
+/** Markdown AST node types */
+var MarkdownNodeType;
+(function (MarkdownNodeType) {
+    MarkdownNodeType["DOCUMENT"] = "document";
+    MarkdownNodeType["HEADING"] = "heading";
+    MarkdownNodeType["PARAGRAPH"] = "paragraph";
+    MarkdownNodeType["BLOCKQUOTE"] = "blockquote";
+    MarkdownNodeType["LIST"] = "list";
+    MarkdownNodeType["LIST_ITEM"] = "list_item";
+    MarkdownNodeType["CODE_BLOCK"] = "code_block";
+    MarkdownNodeType["INLINE_CODE"] = "inline_code";
+    MarkdownNodeType["BOLD"] = "bold";
+    MarkdownNodeType["ITALIC"] = "italic";
+    MarkdownNodeType["LINK"] = "link";
+    MarkdownNodeType["IMAGE"] = "image";
+    MarkdownNodeType["VIDEO"] = "video";
+    MarkdownNodeType["AUDIO"] = "audio";
+    MarkdownNodeType["TABLE"] = "table";
+    MarkdownNodeType["THEMATIC_BREAK"] = "thematic_break";
+    MarkdownNodeType["ACTION"] = "action";
+    MarkdownNodeType["FORM"] = "form";
+    MarkdownNodeType["METADATA"] = "metadata";
+    MarkdownNodeType["STRUCTURED_DATA"] = "structured_data";
+})(MarkdownNodeType || (exports.MarkdownNodeType = MarkdownNodeType = {}));
+/* ============================================================================
+   ACTION TYPES
+   ========================================================================== */
+/** Parameter types for actions */
+var ParameterType;
+(function (ParameterType) {
+    ParameterType["STRING"] = "string";
+    ParameterType["NUMBER"] = "number";
+    ParameterType["INTEGER"] = "integer";
+    ParameterType["BOOLEAN"] = "boolean";
+    ParameterType["EMAIL"] = "email";
+    ParameterType["URL"] = "url";
+    ParameterType["DATE"] = "date";
+    ParameterType["DATETIME"] = "datetime";
+    ParameterType["PHONE"] = "phone";
+    ParameterType["ENUM"] = "enum";
+    ParameterType["OBJECT"] = "object";
+    ParameterType["ARRAY"] = "array";
+    ParameterType["FILE"] = "file";
+})(ParameterType || (exports.ParameterType = ParameterType = {}));
+/* ============================================================================
+   FORM TYPES
+   ========================================================================== */
+/** Form field types */
+var FormFieldType;
+(function (FormFieldType) {
+    FormFieldType["TEXT"] = "text";
+    FormFieldType["EMAIL"] = "email";
+    FormFieldType["PASSWORD"] = "password";
+    FormFieldType["NUMBER"] = "number";
+    FormFieldType["CHECKBOX"] = "checkbox";
+    FormFieldType["RADIO"] = "radio";
+    FormFieldType["SELECT"] = "select";
+    FormFieldType["TEXTAREA"] = "textarea";
+    FormFieldType["FILE"] = "file";
+    FormFieldType["DATE"] = "date";
+    FormFieldType["TIME"] = "time";
+    FormFieldType["DATETIME"] = "datetime";
+    FormFieldType["HIDDEN"] = "hidden";
+})(FormFieldType || (exports.FormFieldType = FormFieldType = {}));
+/* ============================================================================
+   NAVIGATION & LINKS
+   ========================================================================== */
+/** Link types */
+var LinkType;
+(function (LinkType) {
+    LinkType["INTERNAL"] = "internal";
+    LinkType["EXTERNAL"] = "external";
+    LinkType["ACTION"] = "action";
+    LinkType["NAVIGATION"] = "navigation";
+})(LinkType || (exports.LinkType = LinkType = {}));
+/* ============================================================================
+   SESSION & AUTHENTICATION
+   ========================================================================== */
+/** Authentication method */
+var AuthMethod;
+(function (AuthMethod) {
+    AuthMethod["SESSION_TOKEN"] = "session_token";
+    AuthMethod["BEARER_TOKEN"] = "bearer_token";
+    AuthMethod["JWT"] = "jwt";
+    AuthMethod["API_KEY"] = "api_key";
+    AuthMethod["BASIC"] = "basic";
+})(AuthMethod || (exports.AuthMethod = AuthMethod = {}));
+/** Streaming update types */
+var StreamUpdateType;
+(function (StreamUpdateType) {
+    StreamUpdateType["PAGE_UPDATE"] = "page_update";
+    StreamUpdateType["ITEM_ADDED"] = "item_added";
+    StreamUpdateType["ITEM_REMOVED"] = "item_removed";
+    StreamUpdateType["ITEM_UPDATED"] = "item_updated";
+    StreamUpdateType["PRICE_CHANGED"] = "price_changed";
+    StreamUpdateType["STOCK_CHANGED"] = "stock_changed";
+    StreamUpdateType["STATUS_CHANGED"] = "status_changed";
+    StreamUpdateType["ERROR"] = "error";
+    StreamUpdateType["COMPLETED"] = "completed";
+})(StreamUpdateType || (exports.StreamUpdateType = StreamUpdateType = {}));
+/* ============================================================================
+   PUSH NOTIFICATIONS (v2.0) - Webhooks + SSE
+   ========================================================================== */
+/** Types of events that can trigger notifications */
+var NotificationEventType;
+(function (NotificationEventType) {
+    NotificationEventType["ORDER_UPDATED"] = "order.updated";
+    NotificationEventType["ORDER_SHIPPED"] = "order.shipped";
+    NotificationEventType["NEW_MESSAGE"] = "message.new";
+    NotificationEventType["WORKSPACE_UPDATED"] = "workspace.updated";
+    NotificationEventType["ITEM_PRICE_CHANGED"] = "item.price_changed";
+    NotificationEventType["SESSION_EXPIRED"] = "session.expired";
+    NotificationEventType["ACTION_REQUIRED"] = "action.required";
+})(NotificationEventType || (exports.NotificationEventType = NotificationEventType = {}));
+/* ============================================================================
+   ERROR TYPES
+   ========================================================================== */
+/** Error codes */
+var ErrorCode;
+(function (ErrorCode) {
+    ErrorCode["VALIDATION_ERROR"] = "VALIDATION_ERROR";
+    ErrorCode["AUTH_REQUIRED"] = "AUTH_REQUIRED";
+    ErrorCode["PERMISSION_DENIED"] = "PERMISSION_DENIED";
+    ErrorCode["RESOURCE_NOT_FOUND"] = "RESOURCE_NOT_FOUND";
+    ErrorCode["INVALID_REQUEST"] = "INVALID_REQUEST";
+    ErrorCode["RATE_LIMITED"] = "RATE_LIMITED";
+    ErrorCode["SERVER_ERROR"] = "SERVER_ERROR";
+    ErrorCode["SERVICE_UNAVAILABLE"] = "SERVICE_UNAVAILABLE";
+    ErrorCode["CONFLICT"] = "CONFLICT";
+    ErrorCode["INVALID_STATE"] = "INVALID_STATE";
+})(ErrorCode || (exports.ErrorCode = ErrorCode = {}));
+/** AMTP Error */
+class AMTPError extends Error {
+    constructor(code, message, statusCode = StatusCode.BAD_REQUEST, details) {
+        super(message);
+        this.code = code;
+        this.statusCode = statusCode;
+        this.details = details;
+        this.name = "AMTPError";
+    }
+}
+exports.AMTPError = AMTPError;
+exports.default = {
+    MIMEType,
+    HTTPMethod,
+    StatusCode,
+    AgentCapability,
+    MarkdownNodeType,
+    ParameterType,
+    FormFieldType,
+    LinkType,
+    AuthMethod,
+    StreamUpdateType,
+    ErrorCode,
+};
+//# sourceMappingURL=amtp.types.js.map

package/dist/types/amtp.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"amtp.types.js","sourceRoot":"","sources":["../../src/types/amtp.types.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AASH,2BAA2B;AAC3B,IAAY,QAQX;AARD,WAAY,QAAQ;IAClB,gDAAoC,CAAA;IACpC,2DAA+C,CAAA;IAC/C,sCAA0B,CAAA;IAC1B,8BAAkB,CAAA;IAClB,qCAAyB,CAAA;IACzB,8CAAkC,CAAA;IAClC,iEAAqD,CAAA;AACvD,CAAC,EARW,QAAQ,wBAAR,QAAQ,QAQnB;AAED,mBAAmB;AACnB,IAAY,UAQX;AARD,WAAY,UAAU;IACpB,yBAAW,CAAA;IACX,2BAAa,CAAA;IACb,yBAAW,CAAA;IACX,6BAAe,CAAA;IACf,+BAAiB,CAAA;IACjB,2BAAa,CAAA;IACb,iCAAmB,CAAA;AACrB,CAAC,EARW,UAAU,0BAAV,UAAU,QAQrB;AAED,sCAAsC;AACtC,IAAY,UAwBX;AAxBD,WAAY,UAAU;IACpB,cAAc;IACd,yCAAQ,CAAA;IACR,mDAAa,CAAA;IACb,qDAAc,CAAA;IACd,yDAAgB,CAAA;IAEhB,kBAAkB;IAClB,uEAAuB,CAAA;IACvB,+CAAW,CAAA;IACX,6DAAkB,CAAA;IAElB,mBAAmB;IACnB,2DAAiB,CAAA;IACjB,6DAAkB,CAAA;IAClB,uDAAe,CAAA;IACf,uDAAe,CAAA;IACf,qDAAc,CAAA;IACd,6EAA0B,CAAA;IAC1B,uEAAuB,CAAA;IAEvB,mBAAmB;IACnB,iEAAoB,CAAA;IACpB,2EAAyB,CAAA;AAC3B,CAAC,EAxBW,UAAU,0BAAV,UAAU,QAwBrB;AAkBD,kCAAkC;AAClC,IAAY,eASX;AATD,WAAY,eAAe;IACzB,sCAAmB,CAAA;IACnB,0CAAuB,CAAA;IACvB,kCAAe,CAAA;IACf,kCAAe,CAAA;IACf,4CAAyB,CAAA;IACzB,4CAAyB,CAAA;IACzB,wCAAqB,CAAA;IACrB,8CAA2B,CAAA;AAC7B,CAAC,EATW,eAAe,+BAAf,eAAe,QAS1B;AA4DD;;gFAEgF;AAEhF,8BAA8B;AAC9B,IAAY,gBAqBX;AArBD,WAAY,gBAAgB;IAC1B,yCAAqB,CAAA;IACrB,uCAAmB,CAAA;IACnB,2CAAuB,CAAA;IACvB,6CAAyB,CAAA;IACzB,iCAAa,CAAA;IACb,2CAAuB,CAAA;IACvB,6CAAyB,CAAA;IACzB,+CAA2B,CAAA;IAC3B,iCAAa,CAAA;IACb,qCAAiB,CAAA;IACjB,iCAAa,CAAA;IACb,mCAAe,CAAA;IACf,mCAAe,CAAA;IACf,mCAAe,CAAA;IACf,mCAAe,CAAA;IACf,qDAAiC,CAAA;IACjC,qCAAiB,CAAA;IACjB,iCAAa,CAAA;IACb,yCAAqB,CAAA;IACrB,uDAAmC,CAAA;AACrC,CAAC,EArBW,gBAAgB,gCAAhB,gBAAgB,QAqB3B;AAkDD;;gFAEgF;AAEhF,kCAAkC;AAClC,IAAY,aAcX;AAdD,WAAY,aAAa;IACvB,kCAAiB,CAAA;IACjB,kCAAiB,CAAA;IACjB,oCAAmB,CAAA;IACnB,oCAAmB,CAAA;IACnB,gCAAe,CAAA;IACf,4BAAW,CAAA;IACX,8BAAa,CAAA;IACb,sCAAqB,CAAA;IACrB,gCAAe,CAAA;IACf,8BAAa,CAAA;IACb,kCAAiB,CAAA;IACjB,gCAAe,CAAA;IACf,8BAAa,CAAA;AACf,CAAC,EAdW,aAAa,6BAAb,aAAa,QAcxB;AAsLD;;gFAEgF;AAEhF,uBAAuB;AACvB,IAAY,aAcX;AAdD,WAAY,aAAa;IACvB,8BAAa,CAAA;IACb,gCAAe,CAAA;IACf,sCAAqB,CAAA;IACrB,kCAAiB,CAAA;IACjB,sCAAqB,CAAA;IACrB,gCAAe,CAAA;IACf,kCAAiB,CAAA;IACjB,sCAAqB,CAAA;IACrB,8BAAa,CAAA;IACb,8BAAa,CAAA;IACb,8BAAa,CAAA;IACb,sCAAqB,CAAA;IACrB,kCAAiB,CAAA;AACnB,CAAC,EAdW,aAAa,6BAAb,aAAa,QAcxB;AA0DD;;gFAEgF;AAEhF,iBAAiB;AACjB,IAAY,QAKX;AALD,WAAY,QAAQ;IAClB,iCAAqB,CAAA;IACrB,iCAAqB,CAAA;IACrB,6BAAiB,CAAA;IACjB,qCAAyB,CAAA;AAC3B,CAAC,EALW,QAAQ,wBAAR,QAAQ,QAKnB;AAiDD;;gFAEgF;AAEhF,4BAA4B;AAC5B,IAAY,UAMX;AAND,WAAY,UAAU;IACpB,6CAA+B,CAAA;IAC/B,2CAA6B,CAAA;IAC7B,yBAAW,CAAA;IACX,iCAAmB,CAAA;IACnB,6BAAe,CAAA;AACjB,CAAC,EANW,UAAU,0BAAV,UAAU,QAMrB;AA8CD,6BAA6B;AAC7B,IAAY,gBAUX;AAVD,WAAY,gBAAgB;IAC1B,+CAA2B,CAAA;IAC3B,6CAAyB,CAAA;IACzB,iDAA6B,CAAA;IAC7B,iDAA6B,CAAA;IAC7B,mDAA+B,CAAA;IAC/B,mDAA+B,CAAA;IAC/B,qDAAiC,CAAA;IACjC,mCAAe,CAAA;IACf,2CAAuB,CAAA;AACzB,CAAC,EAVW,gBAAgB,gCAAhB,gBAAgB,QAU3B;AASD;;gFAEgF;AAEhF,qDAAqD;AACrD,IAAY,qBAQX;AARD,WAAY,qBAAqB;IAC/B,wDAA+B,CAAA;IAC/B,wDAA+B,CAAA;IAC/B,oDAA2B,CAAA;IAC3B,gEAAuC,CAAA;IACvC,kEAAyC,CAAA;IACzC,4DAAmC,CAAA;IACnC,4DAAmC,CAAA;AACrC,CAAC,EARW,qBAAqB,qCAArB,qBAAqB,QAQhC;AA0ED;;gFAEgF;AAEhF,kBAAkB;AAClB,IAAY,SAWX;AAXD,WAAY,SAAS;IACnB,kDAAqC,CAAA;IACrC,4CAA+B,CAAA;IAC/B,oDAAuC,CAAA;IACvC,sDAAyC,CAAA;IACzC,gDAAmC,CAAA;IACnC,0CAA6B,CAAA;IAC7B,0CAA6B,CAAA;IAC7B,wDAA2C,CAAA;IAC3C,kCAAqB,CAAA;IACrB,4CAA+B,CAAA;AACjC,CAAC,EAXW,SAAS,yBAAT,SAAS,QAWpB;AAUD,iBAAiB;AACjB,MAAa,SAAU,SAAQ,KAAK;IAClC,YACS,IAAe,EACtB,OAAe,EACR,aAAyB,UAAU,CAAC,WAAW,EAC/C,OAAuB;QAE9B,KAAK,CAAC,OAAO,CAAC,CAAC;QALR,SAAI,GAAJ,IAAI,CAAW;QAEf,eAAU,GAAV,UAAU,CAAqC;QAC/C,YAAO,GAAP,OAAO,CAAgB;QAG9B,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;IAC1B,CAAC;CACF;AAVD,8BAUC;AA8GD,kBAAe;IACb,QAAQ;IACR,UAAU;IACV,UAAU;IACV,eAAe;IACf,gBAAgB;IAChB,aAAa;IACb,aAAa;IACb,QAAQ;IACR,UAAU;IACV,gBAAgB;IAChB,SAAS;CACV,CAAC"}

package/package.json

@@ -0,0 +1,89 @@
+{
+  "name": "@amtp/protocol",
+  "version": "1.0.1",
+  "description": "AMTP: Agent Markdown Transfer Protocol - HTTP for the Agentic Web",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "bin",
+    "README.md",
+    "USAGE_GUIDE.md",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --coverage",
+    "lint": "eslint src/**/*.ts",
+    "type-check": "tsc --noEmit",
+    "validate": "npm run type-check && npm run build && npm test",
+    "security-audit": "npm audit",
+    "server": "ts-node src/server/examples/basic-server.ts",
+    "server:saas": "ts-node src/server/examples/saas-dashboard-server.ts",
+    "client": "ts-node src/client/examples/basic-client.ts",
+    "crawler": "ts-node src/crawler/examples/basic-crawler.ts",
+    "docs": "typedoc --out docs src/",
+    "bench": "ts-node bench/bench.ts",
+    "amtp": "ts-node bin/amtp.ts"
+  },
+  "keywords": [
+    "amtp",
+    "protocol",
+    "agents",
+    "markdown",
+    "http",
+    "web",
+    "api",
+    "semantic",
+    "rfc"
+  ],
+  "author": "AMTP Contributors",
+  "license": "MIT",
+  "dependencies": {
+    "compression": "^1.7.4",
+    "cors": "^2.8.5",
+    "express": "^4.18.2",
+    "sqlite3": "^6.0.1"
+  },
+  "devDependencies": {
+    "@types/bcrypt": "^6.0.0",
+    "@types/compression": "^1.8.1",
+    "@types/express": "^4.17.17",
+    "@types/jest": "^29.5.0",
+    "@types/jsonwebtoken": "^9.0.10",
+    "@types/node": "^20.0.0",
+    "@types/supertest": "^7.2.0",
+    "@typescript-eslint/eslint-plugin": "^5.59.0",
+    "@typescript-eslint/parser": "^5.59.0",
+    "bcryptjs": "^2.4.3",
+    "chalk": "^5.6.2",
+    "commander": "^14.0.3",
+    "eslint": "^8.40.0",
+    "fastify": "^5.8.5",
+    "jest": "^29.5.0",
+    "jsonwebtoken": "^9.0.0",
+    "supertest": "^7.2.2",
+    "ts-jest": "^29.1.0",
+    "ts-node": "^10.9.1",
+    "typedoc": "^0.24.0",
+    "typescript": "^5.0.0"
+  },
+  "engines": {
+    "node": ">=18.0.0",
+    "npm": ">=9.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/amtp/protocol"
+  },
+  "bugs": {
+    "url": "https://github.com/amtp/protocol/issues"
+  },
+  "homepage": "https://github.com/amtp/protocol#readme"
+}