@postmcp/types 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 PostMCP Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.mts

@@ -0,0 +1,326 @@
+import { AxiosResponse, AxiosRequestConfig } from 'axios';
+
+type HttpMethod = 'get' | 'post' | 'put' | 'patch' | 'delete' | 'head' | 'options';
+type RiskTier = 'READ_ONLY' | 'MUTATION' | 'CRITICAL';
+interface JSONSchemaObject {
+    type?: string | string[];
+    description?: string;
+    properties?: Record<string, JSONSchemaObject>;
+    required?: string[];
+    items?: JSONSchemaObject;
+    enum?: any[];
+    default?: any;
+    oneOf?: JSONSchemaObject[];
+    anyOf?: JSONSchemaObject[];
+    allOf?: JSONSchemaObject[];
+    $ref?: string;
+    additionalProperties?: boolean | JSONSchemaObject;
+    format?: string;
+    [key: string]: any;
+}
+interface NormalizedParameter {
+    name: string;
+    in: 'path' | 'query' | 'header' | 'cookie' | 'body';
+    description?: string;
+    required: boolean;
+    schema: JSONSchemaObject;
+    style?: string;
+    explode?: boolean;
+}
+interface NormalizedOperation {
+    id: string;
+    method: HttpMethod;
+    path: string;
+    summary: string;
+    description: string;
+    tags: string[];
+    parameters: NormalizedParameter[];
+    inputSchema: JSONSchemaObject;
+    responseSchema?: JSONSchemaObject;
+    riskTier: RiskTier;
+    security?: Array<Record<string, string[]>>;
+    isDeprecated?: boolean;
+    contentType?: string;
+}
+interface SecurityScheme {
+    type: 'apiKey' | 'http' | 'oauth2' | 'openIdConnect';
+    description?: string;
+    name?: string;
+    in?: 'header' | 'query' | 'cookie';
+    scheme?: string;
+    bearerFormat?: string;
+}
+interface MacroStep {
+    id: string;
+    action: string;
+    body?: Record<string, any>;
+    export?: Record<string, string>;
+}
+interface MacroDefinition {
+    name: string;
+    description: string;
+    parameters: JSONSchemaObject;
+    steps: MacroStep[];
+}
+interface TokenDietConfig {
+    enabled: boolean;
+    maxTokens?: number;
+    pruneNulls?: boolean;
+    markdownTables?: boolean;
+    fieldMasks?: Record<string, string[]>;
+}
+interface NormalizedSpec {
+    title: string;
+    version: string;
+    description?: string;
+    servers: Array<{
+        url: string;
+        description?: string;
+    }>;
+    operations: NormalizedOperation[];
+    securitySchemes: Record<string, SecurityScheme>;
+    macros?: MacroDefinition[];
+    tokenDiet?: TokenDietConfig;
+}
+
+interface TokenDietOptions {
+    enabled?: boolean;
+    fieldMasks?: string[];
+    pathFieldMasks?: Record<string, string[]>;
+    maxTokens?: number;
+    convertToMarkdownTable?: boolean;
+    maxProseLength?: number;
+}
+interface TokenDietResult {
+    text: string;
+    structured: any;
+    rawEstimatedTokens: number;
+    dietEstimatedTokens: number;
+    savingsPercentage: number;
+    isTruncated: boolean;
+}
+
+interface ToolAnnotations {
+    readOnlyHint?: boolean;
+    destructiveHint?: boolean;
+    idempotentHint?: boolean;
+}
+interface DryRunResult {
+    isDryRun: true;
+    operationId: string;
+    method: string;
+    targetUrl: string;
+    queryParams?: Record<string, any>;
+    headers: Record<string, string>;
+    body?: any;
+    message: string;
+}
+
+interface MacroExecutionResult {
+    macroName: string;
+    success: boolean;
+    isDryRun?: boolean;
+    stepResults: Array<{
+        stepId: string;
+        action: string;
+        status: number;
+        data: any;
+    }>;
+    finalData: any;
+    errorMessage?: string;
+}
+
+interface McpImageContent {
+    type: 'image';
+    data: string;
+    mimeType: string;
+}
+
+interface AuthConfig {
+    headers?: Record<string, string>;
+    bearerToken?: string;
+    apiKey?: {
+        name: string;
+        value: string;
+        in: 'header' | 'query' | 'cookie';
+    };
+    basicAuth?: {
+        username?: string;
+        password?: string;
+    } | string;
+    securitySchemes?: Record<string, any>;
+    allowedExternalHosts?: string[];
+    allowCrossOriginAuth?: boolean;
+}
+interface AsyncPollResult {
+    response: AxiosResponse;
+    timedOut: boolean;
+}
+interface ResilientHttpClientOptions {
+    baseUrl: string;
+    auth?: AuthConfig;
+    timeout?: number;
+    maxRetries?: number;
+    autoPoll202?: boolean;
+    specSecuritySchemes?: Record<string, SecurityScheme>;
+}
+interface HttpRequestConfig extends AxiosRequestConfig {
+    securityRequirement?: Array<Record<string, string[]>>;
+    specSecuritySchemes?: Record<string, SecurityScheme>;
+}
+interface HttpResponseResult {
+    status: number;
+    statusText: string;
+    headers: Record<string, any>;
+    data: any;
+    contentType?: string;
+    isError: boolean;
+    errorMessage?: string;
+    isPollingTimeout?: boolean;
+}
+interface SerializedRequestParameters {
+    path: string;
+    queryParams: Record<string, any>;
+    headerParams: Record<string, string>;
+    cookieParams: Record<string, string>;
+}
+
+interface ToolRegistryOptions {
+    forceJIT?: boolean;
+    maxMountedTools?: number;
+}
+interface PostMcpServerOptions {
+    spec: NormalizedSpec;
+    baseUrl?: string;
+    auth?: AuthConfig;
+    tokenDiet?: TokenDietOptions;
+    jit?: boolean;
+    dryRun?: boolean;
+    serverName?: string;
+    serverVersion?: string;
+}
+interface HttpServerOptions extends PostMcpServerOptions {
+    port?: number;
+    host?: string;
+    endpointPath?: string;
+}
+
+type PresetCategory = 'Developer Tools' | 'Database & Cloud' | 'Payments & Commerce' | 'Communication & AI' | 'Productivity & Support' | 'Social & Media' | 'Demo & Testing';
+interface PresetFieldMask {
+    path: string;
+    fields: string[];
+}
+interface PresetMacro {
+    name: string;
+    description: string;
+    parameters: {
+        type: 'object';
+        properties: Record<string, any>;
+        required?: string[];
+    };
+    steps: Array<{
+        id: string;
+        action: string;
+        body?: any;
+        export?: Record<string, string>;
+    }>;
+}
+interface Preset {
+    id: string;
+    name: string;
+    description: string;
+    category: PresetCategory;
+    authType: string;
+    authEnvVar?: string;
+    defaultBaseUrl?: string;
+    specUrl?: string;
+    bundledSpec?: object;
+    tags?: string[];
+    fieldMasks?: PresetFieldMask[];
+    macros?: PresetMacro[];
+}
+interface EndpointDef {
+    path: string;
+    method: 'get' | 'post' | 'put' | 'delete' | 'patch';
+    operationId: string;
+    summary: string;
+    description?: string;
+    parameters?: Array<{
+        name: string;
+        in: 'query' | 'path' | 'header';
+        required?: boolean;
+        schema: {
+            type: string;
+            format?: string;
+            default?: any;
+        };
+        description?: string;
+    }>;
+    requestBody?: {
+        required?: boolean;
+        properties: Record<string, {
+            type: string;
+            description?: string;
+            required?: boolean;
+        }>;
+    };
+    responseSchema?: Record<string, any>;
+}
+
+interface PostMcpCliConfig {
+    spec?: string;
+    baseUrl?: string;
+    auth?: AuthConfig;
+    jit?: boolean;
+    dryRun?: boolean;
+    transport?: 'stdio' | 'http';
+    port?: number;
+    tokenDiet?: {
+        enabled?: boolean;
+        maxTokens?: number;
+        convertToMarkdownTable?: boolean;
+    };
+    fieldMasks?: Record<string, string[]>;
+    macros?: MacroDefinition[];
+    enabledOperations?: Record<string, boolean>;
+}
+interface GeneratedProject {
+    files: Record<string, string>;
+}
+interface RunCommandOptions {
+    baseUrl?: string;
+    transport?: 'stdio' | 'http';
+    port?: string;
+    host?: string;
+    header?: string[];
+    bearer?: string;
+    apiKey?: string;
+    jit?: boolean;
+    dryRun?: boolean;
+    tokenDiet?: boolean;
+    maxTokens?: string;
+    envFile?: string;
+    config?: string;
+}
+interface InspectCommandOptions {
+    json?: boolean;
+}
+interface GenerateCommandOptions {
+    lang?: string;
+    target?: string;
+    out?: string;
+}
+interface ExportCommandOptions {
+    target?: 'cursor' | 'claude' | 'windsurf' | 'all';
+    client?: 'cursor' | 'claude' | 'windsurf' | 'all';
+    write?: boolean;
+    env?: string[];
+    bearer?: string;
+    baseUrl?: string;
+}
+interface StudioCommandOptions {
+    port?: string;
+    noOpen?: boolean;
+}
+
+export type { AsyncPollResult, AuthConfig, DryRunResult, EndpointDef, ExportCommandOptions, GenerateCommandOptions, GeneratedProject, HttpMethod, HttpRequestConfig, HttpResponseResult, HttpServerOptions, InspectCommandOptions, JSONSchemaObject, MacroDefinition, MacroExecutionResult, MacroStep, McpImageContent, NormalizedOperation, NormalizedParameter, NormalizedSpec, PostMcpCliConfig, PostMcpServerOptions, Preset, PresetCategory, PresetFieldMask, PresetMacro, ResilientHttpClientOptions, RiskTier, RunCommandOptions, SecurityScheme, SerializedRequestParameters, StudioCommandOptions, TokenDietConfig, TokenDietOptions, TokenDietResult, ToolAnnotations, ToolRegistryOptions };

package/dist/index.d.ts

@@ -0,0 +1,326 @@
+import { AxiosResponse, AxiosRequestConfig } from 'axios';
+
+type HttpMethod = 'get' | 'post' | 'put' | 'patch' | 'delete' | 'head' | 'options';
+type RiskTier = 'READ_ONLY' | 'MUTATION' | 'CRITICAL';
+interface JSONSchemaObject {
+    type?: string | string[];
+    description?: string;
+    properties?: Record<string, JSONSchemaObject>;
+    required?: string[];
+    items?: JSONSchemaObject;
+    enum?: any[];
+    default?: any;
+    oneOf?: JSONSchemaObject[];
+    anyOf?: JSONSchemaObject[];
+    allOf?: JSONSchemaObject[];
+    $ref?: string;
+    additionalProperties?: boolean | JSONSchemaObject;
+    format?: string;
+    [key: string]: any;
+}
+interface NormalizedParameter {
+    name: string;
+    in: 'path' | 'query' | 'header' | 'cookie' | 'body';
+    description?: string;
+    required: boolean;
+    schema: JSONSchemaObject;
+    style?: string;
+    explode?: boolean;
+}
+interface NormalizedOperation {
+    id: string;
+    method: HttpMethod;
+    path: string;
+    summary: string;
+    description: string;
+    tags: string[];
+    parameters: NormalizedParameter[];
+    inputSchema: JSONSchemaObject;
+    responseSchema?: JSONSchemaObject;
+    riskTier: RiskTier;
+    security?: Array<Record<string, string[]>>;
+    isDeprecated?: boolean;
+    contentType?: string;
+}
+interface SecurityScheme {
+    type: 'apiKey' | 'http' | 'oauth2' | 'openIdConnect';
+    description?: string;
+    name?: string;
+    in?: 'header' | 'query' | 'cookie';
+    scheme?: string;
+    bearerFormat?: string;
+}
+interface MacroStep {
+    id: string;
+    action: string;
+    body?: Record<string, any>;
+    export?: Record<string, string>;
+}
+interface MacroDefinition {
+    name: string;
+    description: string;
+    parameters: JSONSchemaObject;
+    steps: MacroStep[];
+}
+interface TokenDietConfig {
+    enabled: boolean;
+    maxTokens?: number;
+    pruneNulls?: boolean;
+    markdownTables?: boolean;
+    fieldMasks?: Record<string, string[]>;
+}
+interface NormalizedSpec {
+    title: string;
+    version: string;
+    description?: string;
+    servers: Array<{
+        url: string;
+        description?: string;
+    }>;
+    operations: NormalizedOperation[];
+    securitySchemes: Record<string, SecurityScheme>;
+    macros?: MacroDefinition[];
+    tokenDiet?: TokenDietConfig;
+}
+
+interface TokenDietOptions {
+    enabled?: boolean;
+    fieldMasks?: string[];
+    pathFieldMasks?: Record<string, string[]>;
+    maxTokens?: number;
+    convertToMarkdownTable?: boolean;
+    maxProseLength?: number;
+}
+interface TokenDietResult {
+    text: string;
+    structured: any;
+    rawEstimatedTokens: number;
+    dietEstimatedTokens: number;
+    savingsPercentage: number;
+    isTruncated: boolean;
+}
+
+interface ToolAnnotations {
+    readOnlyHint?: boolean;
+    destructiveHint?: boolean;
+    idempotentHint?: boolean;
+}
+interface DryRunResult {
+    isDryRun: true;
+    operationId: string;
+    method: string;
+    targetUrl: string;
+    queryParams?: Record<string, any>;
+    headers: Record<string, string>;
+    body?: any;
+    message: string;
+}
+
+interface MacroExecutionResult {
+    macroName: string;
+    success: boolean;
+    isDryRun?: boolean;
+    stepResults: Array<{
+        stepId: string;
+        action: string;
+        status: number;
+        data: any;
+    }>;
+    finalData: any;
+    errorMessage?: string;
+}
+
+interface McpImageContent {
+    type: 'image';
+    data: string;
+    mimeType: string;
+}
+
+interface AuthConfig {
+    headers?: Record<string, string>;
+    bearerToken?: string;
+    apiKey?: {
+        name: string;
+        value: string;
+        in: 'header' | 'query' | 'cookie';
+    };
+    basicAuth?: {
+        username?: string;
+        password?: string;
+    } | string;
+    securitySchemes?: Record<string, any>;
+    allowedExternalHosts?: string[];
+    allowCrossOriginAuth?: boolean;
+}
+interface AsyncPollResult {
+    response: AxiosResponse;
+    timedOut: boolean;
+}
+interface ResilientHttpClientOptions {
+    baseUrl: string;
+    auth?: AuthConfig;
+    timeout?: number;
+    maxRetries?: number;
+    autoPoll202?: boolean;
+    specSecuritySchemes?: Record<string, SecurityScheme>;
+}
+interface HttpRequestConfig extends AxiosRequestConfig {
+    securityRequirement?: Array<Record<string, string[]>>;
+    specSecuritySchemes?: Record<string, SecurityScheme>;
+}
+interface HttpResponseResult {
+    status: number;
+    statusText: string;
+    headers: Record<string, any>;
+    data: any;
+    contentType?: string;
+    isError: boolean;
+    errorMessage?: string;
+    isPollingTimeout?: boolean;
+}
+interface SerializedRequestParameters {
+    path: string;
+    queryParams: Record<string, any>;
+    headerParams: Record<string, string>;
+    cookieParams: Record<string, string>;
+}
+
+interface ToolRegistryOptions {
+    forceJIT?: boolean;
+    maxMountedTools?: number;
+}
+interface PostMcpServerOptions {
+    spec: NormalizedSpec;
+    baseUrl?: string;
+    auth?: AuthConfig;
+    tokenDiet?: TokenDietOptions;
+    jit?: boolean;
+    dryRun?: boolean;
+    serverName?: string;
+    serverVersion?: string;
+}
+interface HttpServerOptions extends PostMcpServerOptions {
+    port?: number;
+    host?: string;
+    endpointPath?: string;
+}
+
+type PresetCategory = 'Developer Tools' | 'Database & Cloud' | 'Payments & Commerce' | 'Communication & AI' | 'Productivity & Support' | 'Social & Media' | 'Demo & Testing';
+interface PresetFieldMask {
+    path: string;
+    fields: string[];
+}
+interface PresetMacro {
+    name: string;
+    description: string;
+    parameters: {
+        type: 'object';
+        properties: Record<string, any>;
+        required?: string[];
+    };
+    steps: Array<{
+        id: string;
+        action: string;
+        body?: any;
+        export?: Record<string, string>;
+    }>;
+}
+interface Preset {
+    id: string;
+    name: string;
+    description: string;
+    category: PresetCategory;
+    authType: string;
+    authEnvVar?: string;
+    defaultBaseUrl?: string;
+    specUrl?: string;
+    bundledSpec?: object;
+    tags?: string[];
+    fieldMasks?: PresetFieldMask[];
+    macros?: PresetMacro[];
+}
+interface EndpointDef {
+    path: string;
+    method: 'get' | 'post' | 'put' | 'delete' | 'patch';
+    operationId: string;
+    summary: string;
+    description?: string;
+    parameters?: Array<{
+        name: string;
+        in: 'query' | 'path' | 'header';
+        required?: boolean;
+        schema: {
+            type: string;
+            format?: string;
+            default?: any;
+        };
+        description?: string;
+    }>;
+    requestBody?: {
+        required?: boolean;
+        properties: Record<string, {
+            type: string;
+            description?: string;
+            required?: boolean;
+        }>;
+    };
+    responseSchema?: Record<string, any>;
+}
+
+interface PostMcpCliConfig {
+    spec?: string;
+    baseUrl?: string;
+    auth?: AuthConfig;
+    jit?: boolean;
+    dryRun?: boolean;
+    transport?: 'stdio' | 'http';
+    port?: number;
+    tokenDiet?: {
+        enabled?: boolean;
+        maxTokens?: number;
+        convertToMarkdownTable?: boolean;
+    };
+    fieldMasks?: Record<string, string[]>;
+    macros?: MacroDefinition[];
+    enabledOperations?: Record<string, boolean>;
+}
+interface GeneratedProject {
+    files: Record<string, string>;
+}
+interface RunCommandOptions {
+    baseUrl?: string;
+    transport?: 'stdio' | 'http';
+    port?: string;
+    host?: string;
+    header?: string[];
+    bearer?: string;
+    apiKey?: string;
+    jit?: boolean;
+    dryRun?: boolean;
+    tokenDiet?: boolean;
+    maxTokens?: string;
+    envFile?: string;
+    config?: string;
+}
+interface InspectCommandOptions {
+    json?: boolean;
+}
+interface GenerateCommandOptions {
+    lang?: string;
+    target?: string;
+    out?: string;
+}
+interface ExportCommandOptions {
+    target?: 'cursor' | 'claude' | 'windsurf' | 'all';
+    client?: 'cursor' | 'claude' | 'windsurf' | 'all';
+    write?: boolean;
+    env?: string[];
+    bearer?: string;
+    baseUrl?: string;
+}
+interface StudioCommandOptions {
+    port?: string;
+    noOpen?: boolean;
+}
+
+export type { AsyncPollResult, AuthConfig, DryRunResult, EndpointDef, ExportCommandOptions, GenerateCommandOptions, GeneratedProject, HttpMethod, HttpRequestConfig, HttpResponseResult, HttpServerOptions, InspectCommandOptions, JSONSchemaObject, MacroDefinition, MacroExecutionResult, MacroStep, McpImageContent, NormalizedOperation, NormalizedParameter, NormalizedSpec, PostMcpCliConfig, PostMcpServerOptions, Preset, PresetCategory, PresetFieldMask, PresetMacro, ResilientHttpClientOptions, RiskTier, RunCommandOptions, SecurityScheme, SerializedRequestParameters, StudioCommandOptions, TokenDietConfig, TokenDietOptions, TokenDietResult, ToolAnnotations, ToolRegistryOptions };

package/dist/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+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 = {};
+module.exports = __toCommonJS(index_exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export * from './parser.js';\nexport * from './tokendiet.js';\nexport * from './safety.js';\nexport * from './macro.js';\nexport * from './media.js';\nexport * from './http.js';\nexport * from './server.js';\nexport * from './presets.js';\nexport * from './cli.js';\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/index.mjs

@@ -0,0 +1 @@
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@postmcp/types",
+  "version": "0.1.0",
+  "description": "Unified TypeScript types and interfaces for the PostMCP ecosystem",
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "devDependencies": {
+    "@types/node": "^22.13.5",
+    "axios": "^1.8.1",
+    "tsup": "^8.4.0",
+    "typescript": "^5.7.3"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit"
+  }
+}