@wildo-ai/external-connectors-models 1.0.1

package/dist/esm/protocols/oauth2.external-connectors-models.schemas.js

@@ -0,0 +1,401 @@
+/**
+ * OAuth2 Protocol Schemas for External Connectors
+ *
+ * This module integrates the comprehensive OAuth2 definitions with the
+ * external connectors protocol engine. It provides:
+ *
+ * 1. SSO_OAuth2 Protocol - For user authentication (OpenID Connect)
+ * 2. OAuth2 API Auth Profile - For linking OAuth2 to REST API authentication
+ */
+import { z } from 'zod';
+import { ExternalProvider_ExchangeProtocol_Configuration_BaseSchema, ExternalProvider_ExchangeProtocol_Kind, ExternalProvider_ExchangeProtocol_Profile_BaseSchema, ExternalProvider_ExchangeProtocol_Status_BaseSchema } from '../core/commons.external-connectors-models.schemas.js';
+// Re-export OAuth2 enums from the shared enums file (avoids circular dependency)
+export { OAuth2_GrantType, OAuth2_ResponseType, OAuth2_PKCE_Method, OAuth2_TokenEndpoint_AuthMethod, OAuth2_Prompt, OAuth2_AccessType, OAuth2_Purpose, OAuth2_TokenFormat, OAuth2_TokenLocation, } from '../core/oauth2.enums.js';
+import { OAuth2_GrantType, OAuth2_ResponseType, OAuth2_PKCE_Method, OAuth2_TokenEndpoint_AuthMethod, OAuth2_Prompt, OAuth2_AccessType, OAuth2_Purpose, OAuth2_TokenFormat, OAuth2_TokenLocation, } from '../core/oauth2.enums.js';
+/**
+ * OAuth2 and OpenID Connect Protocol Definitions
+ *
+ * Based on:
+ * - RFC 6749: The OAuth 2.0 Authorization Framework
+ * - RFC 7636: Proof Key for Code Exchange (PKCE)
+ * - OpenID Connect Core 1.0
+ * - RFC 7662: OAuth 2.0 Token Introspection
+ * - RFC 7009: OAuth 2.0 Token Revocation
+ *
+ * This module provides standardized OAuth2 definitions that unify:
+ * 1. API Authentication (for REST/GraphQL/Webhook calls)
+ * 2. User SSO Authentication (OpenID Connect overlay)
+ * 3. Service-to-Service (S2S) authentication
+ */
+// =============================================================================
+// CAPABILITY FLAGS - Provider Features and Limitations
+// =============================================================================
+/**
+ * OAuth2 Provider Capabilities - what the provider supports
+ * These flags help determine what flows and features are available
+ */
+export const OAuth2_ProviderCapabilitiesSchema = z.object({
+    // ─── Grant Type Support ───
+    /** Supports authorization_code grant (user-interactive flow) */
+    supportsAuthorizationCode: z.boolean().optional(),
+    /** Supports client_credentials grant (S2S/machine-to-machine) */
+    supportsClientCredentials: z.boolean().optional(),
+    /** Supports device_code grant (input-constrained devices) */
+    supportsDeviceCode: z.boolean().optional(),
+    /** Supports JWT bearer assertions */
+    supportsJwtBearer: z.boolean().optional(),
+    // ─── Token Features ───
+    /** Supports refresh tokens */
+    supportsRefreshToken: z.boolean().optional(),
+    /** Provider rotates refresh tokens on each use */
+    rotatesRefreshToken: z.boolean().optional(),
+    /** Supports token revocation (RFC 7009) */
+    supportsTokenRevocation: z.boolean().optional(),
+    /** Supports token introspection (RFC 7662) */
+    supportsTokenIntrospection: z.boolean().optional(),
+    // ─── Security Features ───
+    /** Supports PKCE (RFC 7636) - required for public clients */
+    supportsPKCE: z.boolean().optional(),
+    /** PKCE is required (not optional) */
+    requiresPKCE: z.boolean().optional(),
+    /** Preferred PKCE method */
+    preferredPKCEMethod: z.enum(OAuth2_PKCE_Method).optional(),
+    // ─── OpenID Connect Features ───
+    /** Supports OpenID Connect */
+    supportsOIDC: z.boolean().optional(),
+    /** Supports OIDC Discovery (.well-known/openid-configuration) */
+    supportsOIDCDiscovery: z.boolean().optional(),
+    /** Supports userinfo endpoint */
+    supportsUserInfo: z.boolean().optional(),
+    /** Supports ID tokens */
+    supportsIdToken: z.boolean().optional(),
+    // ─── Advanced Features ───
+    /** Supports incremental authorization (adding scopes) */
+    supportsIncrementalAuth: z.boolean().optional(),
+    /** Supports scope reduction on token refresh */
+    supportsScopeReduction: z.boolean().optional(),
+    /** Supports custom domains/environments */
+    supportsCustomDomains: z.boolean().optional(),
+    /** Supports multi-tenancy */
+    supportsMultiTenancy: z.boolean().optional(),
+});
+// =============================================================================
+// ENDPOINTS - OAuth2 Server Endpoints
+// =============================================================================
+/**
+ * OAuth2 Endpoints Configuration
+ * Standard endpoints as defined in RFC 6749 and OIDC Discovery
+ */
+export const OAuth2_EndpointsSchema = z.object({
+    // ─── Core OAuth2 Endpoints (RFC 6749) ───
+    /** Authorization endpoint - where user grants access */
+    authorizationUrl: z.url(),
+    /** Token endpoint - where tokens are exchanged */
+    tokenUrl: z.url(),
+    // ─── Optional Endpoints ───
+    /** Refresh URL - often same as tokenUrl, but some providers differ */
+    refreshUrl: z.url().optional(),
+    /** Revocation endpoint (RFC 7009) */
+    revocationUrl: z.url().optional(),
+    /** Introspection endpoint (RFC 7662) */
+    introspectionUrl: z.url().optional(),
+    /** Device authorization endpoint (RFC 8628) */
+    deviceAuthorizationUrl: z.url().optional(),
+    // ─── OpenID Connect Endpoints ───
+    /** UserInfo endpoint - for fetching user profile */
+    userInfoUrl: z.url().optional(),
+    /** JWKS endpoint - for verifying tokens */
+    jwksUrl: z.url().optional(),
+    /** OIDC Discovery endpoint */
+    discoveryUrl: z.url().optional(),
+    /** End session / logout endpoint */
+    endSessionUrl: z.url().optional(),
+    // ─── Provider-Specific ───
+    /** Custom API base URL (for making authenticated API calls) */
+    apiBaseUrl: z.url().optional(),
+});
+// =============================================================================
+// SCOPE DEFINITIONS - Granular Permissions
+// =============================================================================
+/**
+ * OAuth2 Scope Definition - describes what a scope grants
+ */
+export const OAuth2_ScopeDefinitionSchema = z.object({
+    /** The scope string as used in OAuth2 requests */
+    scope: z.string(),
+    /** Human-readable description */
+    description: z.string().optional(),
+    /** Is this scope required or optional? */
+    required: z.boolean().optional(),
+    /** Category for grouping scopes (e.g., 'read', 'write', 'admin') */
+    category: z.string().optional(),
+    /** Is this an OIDC standard scope? */
+    isOIDC: z.boolean().optional(),
+    /** Does this scope grant offline access (refresh tokens)? */
+    grantsOfflineAccess: z.boolean().optional(),
+    /** Related resources or APIs this scope provides access to */
+    resources: z.array(z.string()).optional(),
+});
+/**
+ * Scope Collection - organized scopes for a provider
+ */
+export const OAuth2_ScopeCollectionSchema = z.object({
+    /** All available scopes */
+    available: z.array(OAuth2_ScopeDefinitionSchema).optional(),
+    /** Default scopes for user SSO authentication */
+    defaultForSSO: z.array(z.string()).optional(),
+    /** Default scopes for API access */
+    defaultForAPI: z.array(z.string()).optional(),
+    /** Minimum required scopes */
+    minimum: z.array(z.string()).optional(),
+    /** Scope that grants offline/refresh access (e.g., 'offline_access') */
+    offlineAccessScope: z.string().optional(),
+});
+// =============================================================================
+// TOKEN CONFIGURATION - Token handling specifics
+// =============================================================================
+/**
+ * Token Configuration - how tokens behave
+ */
+export const OAuth2_TokenConfigSchema = z.object({
+    /** Token type (usually 'Bearer') */
+    tokenType: z.string().optional(),
+    /** Default access token lifetime in seconds */
+    accessTokenLifetime: z.number().positive().optional(),
+    /** Default refresh token lifetime in seconds */
+    refreshTokenLifetime: z.number().positive().optional(),
+    /** ID token lifetime in seconds (OIDC) */
+    idTokenLifetime: z.number().positive().optional(),
+    /** How to authenticate at the token endpoint */
+    tokenEndpointAuthMethod: z.enum(OAuth2_TokenEndpoint_AuthMethod).optional(),
+    /** Additional headers required for token requests */
+    tokenRequestHeaders: z.record(z.string(), z.string()).optional(),
+    /** How early (in seconds) to refresh tokens before expiry */
+    refreshBufferSeconds: z.number().nonnegative().optional(),
+});
+// =============================================================================
+// MAIN OAUTH2 PROVIDER DEFINITION
+// =============================================================================
+/**
+ * Complete OAuth2 Provider Definition
+ * This is the main schema that captures all OAuth2 configuration for a provider
+ */
+export const OAuth2_ProviderDefinitionSchema = z.object({
+    // ─── Identity ───
+    /** Unique provider identifier */
+    providerId: z.string().min(1),
+    /** Display name for UI */
+    displayName: z.string().min(1),
+    /** Provider icon URL */
+    iconUrl: z.url().optional(),
+    /** Primary brand color (hex) */
+    brandColor: z.string().optional(),
+    // ─── Purpose ───
+    /** What this OAuth2 config is used for */
+    purpose: z.enum(OAuth2_Purpose).default(OAuth2_Purpose.API_ACCESS),
+    /** Is this provider enabled? */
+    enabled: z.boolean().default(true),
+    // ─── Endpoints ───
+    /** OAuth2 endpoints configuration */
+    endpoints: OAuth2_EndpointsSchema,
+    // ─── Capabilities ───
+    /** What the provider supports (all fields have defaults) */
+    capabilities: OAuth2_ProviderCapabilitiesSchema.optional(),
+    // ─── Scopes ───
+    /** Scope definitions and defaults (all fields have defaults) */
+    scopes: OAuth2_ScopeCollectionSchema.optional(),
+    // ─── Token Configuration ───
+    /** Token handling configuration (all fields have defaults) */
+    tokenConfig: OAuth2_TokenConfigSchema.optional(),
+    // ─── Authorization Configuration ───
+    /** Preferred grant type */
+    preferredGrantType: z.enum(OAuth2_GrantType).default(OAuth2_GrantType.AUTHORIZATION_CODE),
+    /** Response type for authorization requests */
+    responseType: z.enum(OAuth2_ResponseType).default(OAuth2_ResponseType.CODE),
+    /** Prompt behavior */
+    prompt: z.enum(OAuth2_Prompt).optional(),
+    /** Access type (online/offline) */
+    accessType: z.enum(OAuth2_AccessType).default(OAuth2_AccessType.OFFLINE),
+    // ─── Dynamic Configuration ───
+    /**
+     * Template variables that can be substituted in URLs
+     * e.g., { location: 'us' } for 'https://accounts.{location}.zoho.com'
+     */
+    templateVariables: z.record(z.string(), z.object({
+        displayName: z.string(),
+        description: z.string().optional(),
+        required: z.boolean().optional(),
+        defaultValue: z.string().optional(),
+        options: z.array(z.object({
+            value: z.string(),
+            label: z.string(),
+        })).optional(),
+    })).optional(),
+    /** Extra parameters to include in authorization requests */
+    extraAuthParams: z.record(z.string(), z.string()).optional(),
+    /** Extra parameters to include in token requests */
+    extraTokenParams: z.record(z.string(), z.string()).optional(),
+    // ─── User Profile Mapping (OIDC/SSO) ───
+    /** Mapping for extracting user info from profile response */
+    userProfileMapping: z.object({
+        id: z.string().default('sub'),
+        email: z.string().default('email'),
+        name: z.string().default('name'),
+        image: z.string().default('picture'),
+        emailVerified: z.string().default('email_verified'),
+    }).optional(),
+    // ─── Provider-Specific Extensions ───
+    /** Provider-specific configuration extensions */
+    extensions: z.record(z.string(), z.unknown()).optional(),
+});
+// =============================================================================
+// NOTE: OAuth2 configurations are defined per-provider in external-connectors
+// =============================================================================
+// 
+// Each provider folder (e.g., google/, microsoft/) contains its own OAuth2
+// protocol definition. Use provider string identifiers to reference providers.
+//
+// =============================================================================
+// SSO OAUTH2 PROTOCOL - For User Authentication
+// =============================================================================
+/**
+ * OAuth2 Provider Profile - UI and identification information
+ * Used when OAuth2 is exposed as an SSO protocol
+ *
+ * Note: Uses OAuth2_ProviderDefinitionSchema.pick() to avoid duplication
+ * of common fields (displayName, iconUrl, enabled, purpose)
+ */
+export const OAuth2Provider_ProfileSchema = ExternalProvider_ExchangeProtocol_Profile_BaseSchema.extend({
+    /** Provider name (unique identifier) - string reference (e.g., "google", "openai") */
+    providerName: z.string().min(1, { message: 'Provider name is required' }),
+    /** Display name for UI - picked from OAuth2_ProviderDefinitionSchema */
+    displayName: OAuth2_ProviderDefinitionSchema.shape.displayName,
+    /** Icon URL for the provider - picked from OAuth2_ProviderDefinitionSchema */
+    iconUrl: OAuth2_ProviderDefinitionSchema.shape.iconUrl,
+    /** Button color for OAuth login buttons (SSO-specific) */
+    buttonColor: z.string().optional(),
+    /** Is this provider enabled? - picked from OAuth2_ProviderDefinitionSchema */
+    enabled: OAuth2_ProviderDefinitionSchema.shape.enabled,
+    /** Provider purpose (SSO, API, or both) - with SSO default for this context */
+    purpose: z.enum(OAuth2_Purpose).default(OAuth2_Purpose.USER_SSO),
+});
+// =============================================================================
+// RUNTIME CREDENTIAL - Active OAuth2 credentials
+// =============================================================================
+/**
+ * OAuth2 Credential - Active tokens for a provider connection
+ * This is what gets stored after successful OAuth2 authentication
+ */
+export const OAuth2_CredentialSchema = z.object({
+    /** Provider this credential is for */
+    providerId: z.string(),
+    /** Access token */
+    accessToken: z.string(),
+    /** Token type (usually 'Bearer') */
+    tokenType: z.string().default('Bearer'),
+    /** When the access token expires (Unix timestamp) */
+    expiresAt: z.number().optional(),
+    /** Refresh token (if available) */
+    refreshToken: z.string().optional(),
+    /** When the refresh token expires (Unix timestamp) */
+    refreshTokenExpiresAt: z.number().optional(),
+    /** ID token (OIDC) */
+    idToken: z.string().optional(),
+    /** Granted scopes (may differ from requested) */
+    scope: z.string().optional(),
+    /** When this credential was obtained */
+    claimedAt: z.number(),
+    /** Additional data from the token response */
+    data: z.record(z.string(), z.unknown()).optional(),
+    /** Provider-specific properties used during auth */
+    props: z.record(z.string(), z.unknown()).optional(),
+});
+/**
+ * OAuth2 Provider Configuration - Runtime configuration
+ * Contains the OAuth2 endpoints and configuration
+ */
+export const OAuth2Provider_ConfigurationSchema = ExternalProvider_ExchangeProtocol_Configuration_BaseSchema.extend({
+    // ─── OAuth2 Core Configuration ───
+    /** Complete OAuth2 provider definition (new comprehensive approach) */
+    oauth2Definition: OAuth2_ProviderDefinitionSchema.optional(),
+    // ─── Legacy fields for backward compatibility ───
+    /** Authorization endpoint URL */
+    authorizationEndpoint: z.url().optional(),
+    /** Requested scopes */
+    scopes: z.array(z.string()).default([]),
+    /** Native SDK client IDs for Capacitor token exchange (F2). Apple uses bundle ID, Google uses per-platform OAuth client IDs. */
+    nativeClientIds: z.array(z.string()).optional(),
+    // ─── Integration Access (for providers that offer multiple APIs) ───
+    integrationAccess: z.object({
+        /** Enable third-party integrations through this OAuth2 connection */
+        enableIntegrations: z.boolean().default(false),
+        /** Available integrations (e.g., ['drive', 'calendar', 'contacts']) */
+        availableIntegrations: z.array(z.string()).default([]),
+        /** Default integrations to enable */
+        defaultIntegrations: z.array(z.string()).default([]),
+        /** User must grant permission for each integration */
+        requiresPermission: z.boolean().default(true),
+    }).default({
+        enableIntegrations: false,
+        availableIntegrations: [],
+        defaultIntegrations: [],
+        requiresPermission: true,
+    }),
+});
+/**
+ * OAuth2 Provider Operation - Operations that require OAuth2
+ * Currently empty, reserved for future use
+ */
+export const OAuth2Provider_OperationSchema = z.object({});
+/**
+ * OAuth2 Provider Status - Connection status
+ */
+export const OAuth2Provider_StatusSchema = ExternalProvider_ExchangeProtocol_Status_BaseSchema.extend({
+    protocolKind: z.literal(ExternalProvider_ExchangeProtocol_Kind.SSO_OAUTH2),
+    /** Current credential (if connected) */
+    credential: OAuth2_CredentialSchema.optional(),
+    /** Is the token valid/not expired? */
+    isTokenValid: z.boolean().optional(),
+    /** Does the token need refresh? */
+    needsRefresh: z.boolean().optional(),
+    /** Last token refresh time */
+    lastRefreshAt: z.number().optional(),
+    /** Granted scopes (may differ from requested) */
+    grantedScopes: z.array(z.string()).optional(),
+    /** Missing required scopes */
+    missingScopes: z.array(z.string()).optional(),
+});
+// =============================================================================
+// OAUTH2 API AUTHENTICATION LINK (Consolidated)
+// =============================================================================
+/**
+ * OAuth2 API Auth Link
+ *
+ * Unified schema for linking OAuth2 credentials to REST API / Hook authentication.
+ * This prevents duplication between auth profile and OAuth2 config.
+ *
+ * When a REST API uses OAuth2 for authentication:
+ * 1. Define the OAuth2 provider once (endpoints, scopes, capabilities)
+ * 2. Link it to the API auth profile using this schema
+ * 3. The system will automatically:
+ *    - Manage token refresh
+ *    - Format Authorization headers
+ *    - Track required scopes per operation
+ */
+export const OAuth2_APIAuthLinkSchema = z.object({
+    /** Reference to the OAuth2 provider definition */
+    oauth2ProviderRef: z.string().min(1),
+    /** Which scopes are needed for this API access */
+    requiredScopes: z.array(z.string()).default([]),
+    /** How to format the token for API calls */
+    tokenFormat: z.enum(OAuth2_TokenFormat).default(OAuth2_TokenFormat.BEARER),
+    /** Where to send the access token */
+    tokenLocation: z.enum(OAuth2_TokenLocation).default(OAuth2_TokenLocation.HEADER),
+    /** Custom header name (when tokenFormat is 'custom_header') */
+    customHeaderName: z.string().optional(),
+    /** Query parameter name (when tokenLocation is 'query') */
+    queryParamName: z.string().optional(),
+    /** Prefix for the token value (optional override) */
+    tokenPrefix: z.string().optional(),
+});
+//# sourceMappingURL=oauth2.external-connectors-models.schemas.js.map

package/dist/esm/protocols/oauth2.external-connectors-models.schemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"oauth2.external-connectors-models.schemas.js","sourceRoot":"","sources":["../../../src/protocols/oauth2.external-connectors-models.schemas.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EACL,0DAA0D,EAC1D,sCAAsC,EACtC,oDAAoD,EACpD,mDAAmD,EACpD,MAAM,0EAA0E,CAAC;AAElF,iFAAiF;AACjF,OAAO,EACL,gBAAgB,EAChB,mBAAmB,EACnB,kBAAkB,EAClB,+BAA+B,EAC/B,aAAa,EACb,iBAAiB,EACjB,cAAc,EACd,kBAAkB,EAClB,oBAAoB,GACrB,MAAM,4CAA4C,CAAC;AAEpD,OAAO,EACL,gBAAgB,EAChB,mBAAmB,EACnB,kBAAkB,EAClB,+BAA+B,EAC/B,aAAa,EACb,iBAAiB,EACjB,cAAc,EACd,kBAAkB,EAClB,oBAAoB,GACrB,MAAM,4CAA4C,CAAC;AAGpD;;;;;;;;;;;;;;GAcG;AAEH,gFAAgF;AAChF,uDAAuD;AACvD,gFAAgF;AAEhF;;;GAGG;AACH,MAAM,CAAC,MAAM,iCAAiC,GAAG,CAAC,CAAC,MAAM,CAAC;IACxD,6BAA6B;IAC7B,gEAAgE;IAChE,yBAAyB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAEjD,iEAAiE;IACjE,yBAAyB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAEjD,6DAA6D;IAC7D,kBAAkB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAE1C,qCAAqC;IACrC,iBAAiB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAEzC,yBAAyB;IACzB,8BAA8B;IAC9B,oBAAoB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAE5C,kDAAkD;IAClD,mBAAmB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAE3C,2CAA2C;IAC3C,uBAAuB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAE/C,8CAA8C;IAC9C,0BAA0B,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAElD,4BAA4B;IAC5B,6DAA6D;IAC7D,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAEpC,sCAAsC;IACtC,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAEpC,4BAA4B;IAC5B,mBAAmB,EAAE,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,QAAQ,EAAE;IAE1D,kCAAkC;IAClC,8BAA8B;IAC9B,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAEpC,iEAAiE;IACjE,qBAAqB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAE7C,iCAAiC;IACjC,gBAAgB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAExC,yBAAyB;IACzB,eAAe,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAEvC,4BAA4B;IAC5B,yDAAyD;IACzD,uBAAuB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAE/C,gDAAgD;IAChD,sBAAsB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAE9C,2CAA2C;IAC3C,qBAAqB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAE7C,6BAA6B;IAC7B,oBAAoB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CAC7C,CAAC,CAAC;AAGH,gFAAgF;AAChF,sCAAsC;AACtC,gFAAgF;AAEhF;;;GAGG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC7C,2CAA2C;IAC3C,wDAAwD;IACxD,gBAAgB,EAAE,CAAC,CAAC,GAAG,EAAE;IAEzB,kDAAkD;IAClD,QAAQ,EAAE,CAAC,CAAC,GAAG,EAAE;IAEjB,6BAA6B;IAC7B,sEAAsE;IACtE,UAAU,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAE9B,qCAAqC;IACrC,aAAa,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAEjC,wCAAwC;IACxC,gBAAgB,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAEpC,+CAA+C;IAC/C,sBAAsB,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAE1C,mCAAmC;IACnC,oDAAoD;IACpD,WAAW,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAE/B,2CAA2C;IAC3C,OAAO,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAE3B,8BAA8B;IAC9B,YAAY,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAEhC,oCAAoC;IACpC,aAAa,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAEjC,4BAA4B;IAC5B,+DAA+D;IAC/D,UAAU,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;CAC/B,CAAC,CAAC;AAGH,gFAAgF;AAChF,2CAA2C;AAC3C,gFAAgF;AAEhF;;GAEG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC,MAAM,CAAC;IACnD,kDAAkD;IAClD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IAEjB,iCAAiC;IACjC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAElC,0CAA0C;IAC1C,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAEhC,oEAAoE;IACpE,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAE/B,sCAAsC;IACtC,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAE9B,6DAA6D;IAC7D,mBAAmB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAE3C,8DAA8D;IAC9D,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;CAC1C,CAAC,CAAC;AAGH;;GAEG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC,MAAM,CAAC;IACnD,2BAA2B;IAC3B,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAC,QAAQ,EAAE;IAE3D,iDAAiD;IACjD,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAE7C,oCAAoC;IACpC,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAE7C,8BAA8B;IAC9B,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAEvC,wEAAwE;IACxE,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC1C,CAAC,CAAC;AAGH,gFAAgF;AAChF,iDAAiD;AACjD,gFAAgF;AAEhF;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/C,oCAAoC;IACpC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAEhC,+CAA+C;IAC/C,mBAAmB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAErD,gDAAgD;IAChD,oBAAoB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAEtD,0CAA0C;IAC1C,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAEjD,gDAAgD;IAChD,uBAAuB,EAAE,CAAC,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC,QAAQ,EAAE;IAE3E,qDAAqD;IACrD,mBAAmB,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAEhE,6DAA6D;IAC7D,oBAAoB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE;CAC1D,CAAC,CAAC;AAGH,gFAAgF;AAChF,kCAAkC;AAClC,gFAAgF;AAEhF;;;GAGG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC,CAAC,MAAM,CAAC;IACtD,mBAAmB;IACnB,iCAAiC;IACjC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAE7B,0BAA0B;IAC1B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAE9B,wBAAwB;IACxB,OAAO,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAE3B,gCAAgC;IAChC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAEjC,kBAAkB;IAClB,0CAA0C;IAC1C,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC;IAElE,gCAAgC;IAChC,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;IAElC,oBAAoB;IACpB,qCAAqC;IACrC,SAAS,EAAE,sBAAsB;IAEjC,uBAAuB;IACvB,4DAA4D;IAC5D,YAAY,EAAE,iCAAiC,CAAC,QAAQ,EAAE;IAE1D,iBAAiB;IACjB,gEAAgE;IAChE,MAAM,EAAE,4BAA4B,CAAC,QAAQ,EAAE;IAE/C,8BAA8B;IAC9B,8DAA8D;IAC9D,WAAW,EAAE,wBAAwB,CAAC,QAAQ,EAAE;IAEhD,sCAAsC;IACtC,2BAA2B;IAC3B,kBAAkB,EAAE,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,kBAAkB,CAAC;IAEzF,+CAA+C;IAC/C,YAAY,EAAE,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC;IAE3E,sBAAsB;IACtB,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,QAAQ,EAAE;IAExC,mCAAmC;IACnC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC,OAAO,CAAC;IAExE,gCAAgC;IAChC;;;OAGG;IACH,iBAAiB,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC;QAC/C,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;QACvB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAClC,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;QAChC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QACnC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC;YACxB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;YACjB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;SAClB,CAAC,CAAC,CAAC,QAAQ,EAAE;KACf,CAAC,CAAC,CAAC,QAAQ,EAAE;IAEd,4DAA4D;IAC5D,eAAe,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAE5D,oDAAoD;IACpD,gBAAgB,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAE7D,0CAA0C;IAC1C,6DAA6D;IAC7D,kBAAkB,EAAE,CAAC,CAAC,MAAM,CAAC;QAC3B,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;QAC7B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC;QAClC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC;QAChC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC;QACpC,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,gBAAgB,CAAC;KACpD,CAAC,CAAC,QAAQ,EAAE;IAEb,uCAAuC;IACvC,iDAAiD;IACjD,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE;CACzD,CAAC,CAAC;AAGH,gFAAgF;AAChF,8EAA8E;AAC9E,gFAAgF;AAChF,GAAG;AACH,2EAA2E;AAC3E,+EAA+E;AAC/E,EAAE;AAEF,gFAAgF;AAChF,gDAAgD;AAChD,gFAAgF;AAEhF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,oDAAoD,CAAC,MAAM,CAAC;IACtG,sFAAsF;IACtF,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,2BAA2B,EAAE,CAAC;IAEzE,wEAAwE;IACxE,WAAW,EAAE,+BAA+B,CAAC,KAAK,CAAC,WAAW;IAE9D,8EAA8E;IAC9E,OAAO,EAAE,+BAA+B,CAAC,KAAK,CAAC,OAAO;IAEtD,0DAA0D;IAC1D,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAElC,8EAA8E;IAC9E,OAAO,EAAE,+BAA+B,CAAC,KAAK,CAAC,OAAO;IAEtD,+EAA+E;IAC/E,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,QAAQ,CAAC;CACjE,CAAC,CAAC;AAGH,gFAAgF;AAChF,iDAAiD;AACjD,gFAAgF;AAEhF;;;GAGG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,sCAAsC;IACtC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IAEtB,mBAAmB;IACnB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IAEvB,oCAAoC;IACpC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC;IAEvC,qDAAqD;IACrD,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAEhC,mCAAmC;IACnC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAEnC,sDAAsD;IACtD,qBAAqB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAE5C,sBAAsB;IACtB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAE9B,iDAAiD;IACjD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAE5B,wCAAwC;IACxC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IAErB,8CAA8C;IAC9C,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE;IAElD,oDAAoD;IACpD,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE;CACpD,CAAC,CAAC;AAKH;;;GAGG;AACH,MAAM,CAAC,MAAM,kCAAkC,GAAG,0DAA0D,CAAC,MAAM,CAAC;IAClH,oCAAoC;IACpC,uEAAuE;IACvE,gBAAgB,EAAE,+BAA+B,CAAC,QAAQ,EAAE;IAE5D,mDAAmD;IACnD,iCAAiC;IACjC,qBAAqB,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAEzC,uBAAuB;IACvB,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;IAEvC,gIAAgI;IAChI,eAAe,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAE/C,sEAAsE;IACtE,iBAAiB,EAAE,CAAC,CAAC,MAAM,CAAC;QAC1B,qEAAqE;QACrE,kBAAkB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;QAE9C,uEAAuE;QACvE,qBAAqB,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;QAEtD,qCAAqC;QACrC,mBAAmB,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;QAEpD,sDAAsD;QACtD,kBAAkB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;KAC9C,CAAC,CAAC,OAAO,CAAC;QACT,kBAAkB,EAAE,KAAK;QACzB,qBAAqB,EAAE,EAAE;QACzB,mBAAmB,EAAE,EAAE;QACvB,kBAAkB,EAAE,IAAI;KACzB,CAAC;CACH,CAAC,CAAC;AAEH;;;GAGG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;AAE3D;;GAEG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,mDAAmD,CAAC,MAAM,CAAC;IACpG,YAAY,EAAE,CAAC,CAAC,OAAO,CAAC,sCAAsC,CAAC,UAAU,CAAC;IAE1E,wCAAwC;IACxC,UAAU,EAAE,uBAAuB,CAAC,QAAQ,EAAE;IAE9C,sCAAsC;IACtC,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAEpC,mCAAmC;IACnC,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAEpC,8BAA8B;IAC9B,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAEpC,iDAAiD;IACjD,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAE7C,8BAA8B;IAC9B,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;CAC9C,CAAC,CAAC;AAcH,gFAAgF;AAChF,gDAAgD;AAChD,gFAAgF;AAEhF;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/C,kDAAkD;IAClD,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAEpC,kDAAkD;IAClD,cAAc,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;IAE/C,4CAA4C;IAC5C,WAAW,EAAE,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,MAAM,CAAC;IAE1E,qCAAqC;IACrC,aAAa,EAAE,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,MAAM,CAAC;IAEhF,+DAA+D;IAC/D,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAEvC,2DAA2D;IAC3D,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAErC,qDAAqD;IACrD,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACnC,CAAC,CAAC"}

package/dist/esm/protocols/rest-api.external-connectors-models.schemas.d.ts

@@ -0,0 +1,125 @@
+import { z } from "zod";
+import { API_HttpMethod, ExternalProvider_ExchangeProtocol_Kind, ExternalProvider_ExchangeProtocol_Profile_Base, ExternalProvider_ExchangeProtocol_Configuration_Base } from "../core/commons.external-connectors-models.schemas.js";
+import { ExternalProvider_OperationDefinition_Base } from "../core/operations.external-connectors-models.schemas.js";
+export declare enum API_ParameterIn {
+    QUERY = "query",
+    HEADER = "header",
+    PATH = "path",
+    COOKIE = "cookie"
+}
+export declare enum API_ContentType {
+    JSON = "application/json",
+    XML = "application/xml",
+    FORM_URLENCODED = "application/x-www-form-urlencoded",
+    MULTIPART_FORM = "multipart/form-data",
+    TEXT_PLAIN = "text/plain",
+    OCTET_STREAM = "application/octet-stream"
+}
+export declare const API_ParameterSchema: z.ZodObject<{
+    name: z.ZodString;
+    in: z.ZodEnum<typeof API_ParameterIn>;
+    description: z.ZodOptional<z.ZodString>;
+    required: z.ZodDefault<z.ZodBoolean>;
+    deprecated: z.ZodOptional<z.ZodBoolean>;
+    schemaRef: z.ZodOptional<z.ZodString>;
+    type: z.ZodOptional<z.ZodEnum<{
+        string: "string";
+        number: "number";
+        boolean: "boolean";
+        array: "array";
+        integer: "integer";
+    }>>;
+    format: z.ZodOptional<z.ZodString>;
+    enumValues: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    defaultValue: z.ZodOptional<z.ZodUnknown>;
+}, z.core.$strip>;
+export type API_Parameter = z.infer<typeof API_ParameterSchema>;
+export declare const REST_API_OperationSpecSchema: z.ZodObject<{
+    method: z.ZodEnum<typeof API_HttpMethod>;
+    path: z.ZodString;
+    parameters: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        in: z.ZodEnum<typeof API_ParameterIn>;
+        description: z.ZodOptional<z.ZodString>;
+        required: z.ZodDefault<z.ZodBoolean>;
+        deprecated: z.ZodOptional<z.ZodBoolean>;
+        schemaRef: z.ZodOptional<z.ZodString>;
+        type: z.ZodOptional<z.ZodEnum<{
+            string: "string";
+            number: "number";
+            boolean: "boolean";
+            array: "array";
+            integer: "integer";
+        }>>;
+        format: z.ZodOptional<z.ZodString>;
+        enumValues: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        defaultValue: z.ZodOptional<z.ZodUnknown>;
+    }, z.core.$strip>>>;
+    requestContentType: z.ZodOptional<z.ZodEnum<typeof API_ContentType>>;
+    responseContentType: z.ZodOptional<z.ZodEnum<typeof API_ContentType>>;
+    rateLimit: z.ZodOptional<z.ZodObject<{
+        requests: z.ZodNumber;
+        period: z.ZodEnum<{
+            second: "second";
+            minute: "minute";
+            hour: "hour";
+            day: "day";
+        }>;
+    }, z.core.$strip>>;
+    tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    deprecated: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+export type REST_API_OperationSpec = z.infer<typeof REST_API_OperationSpecSchema>;
+export type REST_API_Provider_Profile = ExternalProvider_ExchangeProtocol_Profile_Base & {
+    baseURL: string;
+    version?: string;
+    defaultHeaders?: Record<string, string>;
+    serverVariables?: Record<string, {
+        default: string;
+        enum?: string[];
+        description?: string;
+    }>;
+    /**
+     * Common error schema for this API
+     * Used for standardized error handling across all operations
+     * Individual operations can override with their own error schema if needed
+     */
+    errorSchema?: z.ZodSchema<any>;
+};
+export type REST_API_Provider_Configuration = ExternalProvider_ExchangeProtocol_Configuration_Base & {
+    defaultTimeout?: number;
+    defaultRetries?: number;
+    pagination?: {
+        style: "offset" | "cursor" | "page" | "link";
+        pageParam?: string;
+        limitParam?: string;
+        defaultLimit?: number;
+    };
+};
+export declare const REST_API_OperationContextSchema: z.ZodObject<{
+    callTimestamp: z.ZodISODateTime;
+    callDuration: z.ZodOptional<z.ZodNumber>;
+    errorReason: z.ZodOptional<z.ZodString>;
+    requestMethod: z.ZodEnum<typeof API_HttpMethod>;
+    requestPath: z.ZodString;
+    requestUrl: z.ZodString;
+    responseStatus: z.ZodNumber;
+    responseStatusText: z.ZodOptional<z.ZodString>;
+    rateLimitRemaining: z.ZodOptional<z.ZodNumber>;
+    rateLimitReset: z.ZodOptional<z.ZodString>;
+    retryCount: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+export type REST_API_OperationContext = z.infer<typeof REST_API_OperationContextSchema>;
+export type REST_API_OperationDefinition = ExternalProvider_OperationDefinition_Base & {
+    spec: REST_API_OperationSpec;
+    operationContextSchema: typeof REST_API_OperationContextSchema;
+};
+export declare const REST_APIProvider_StatusSchema: z.ZodObject<{
+    status: z.ZodEnum<typeof import("../index.js").ExternalProvider_Status>;
+    lastCheckedAt: z.ZodString;
+    errorReason: z.ZodOptional<z.ZodString>;
+    protocolKind: z.ZodLiteral<ExternalProvider_ExchangeProtocol_Kind.REST_API>;
+    apiVersion: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type REST_APIProvider_Status = z.infer<typeof REST_APIProvider_StatusSchema>;
+//# sourceMappingURL=rest-api.external-connectors-models.schemas.d.ts.map

package/dist/esm/protocols/rest-api.external-connectors-models.schemas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rest-api.external-connectors-models.schemas.d.ts","sourceRoot":"","sources":["../../../src/protocols/rest-api.external-connectors-models.schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EACL,cAAc,EACd,sCAAsC,EAEtC,8CAA8C,EAC9C,oDAAoD,EACrD,MAAM,oDAAoD,CAAC;AAC5D,OAAO,EAA2C,yCAAyC,EAAE,MAAM,uDAAuD,CAAC;AAa3J,oBAAY,eAAe;IACzB,KAAK,UAAU;IACf,MAAM,WAAW;IACjB,IAAI,SAAS;IACb,MAAM,WAAW;CAClB;AAED,oBAAY,eAAe;IACzB,IAAI,qBAAqB;IACzB,GAAG,oBAAoB;IACvB,eAAe,sCAAsC;IACrD,cAAc,wBAAwB;IACtC,UAAU,eAAe;IACzB,YAAY,6BAA6B;CAC1C;AAMD,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;iBAe9B,CAAC;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAMhE,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAuBvC,CAAC;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC;AAMlF,MAAM,MAAM,yBAAyB,GAAG,8CAA8C,GAAG;IACvF,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IAGjB,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAGxC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;QAC/B,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;QAChB,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC,CAAC;IAEH;;;;OAIG;IACH,WAAW,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;CAChC,CAAC;AAMF,MAAM,MAAM,+BAA+B,GAAG,oDAAoD,GAAG;IACnG,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,cAAc,CAAC,EAAE,MAAM,CAAC;IAGxB,UAAU,CAAC,EAAE;QACX,KAAK,EAAE,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,MAAM,CAAC;QAC7C,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB,CAAC;CACH,CAAC;AAMF,eAAO,MAAM,+BAA+B;;;;;;;;;;;;iBAgB1C,CAAC;AACH,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAC;AAMxF,MAAM,MAAM,4BAA4B,GAAG,yCAAyC,GAAG;IACrF,IAAI,EAAE,sBAAsB,CAAC;IAC7B,sBAAsB,EAAE,OAAO,+BAA+B,CAAC;CAIhE,CAAC;AAMF,eAAO,MAAM,6BAA6B;;;;;;iBAGxC,CAAC;AACH,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAC"}

package/dist/esm/protocols/rest-api.external-connectors-models.schemas.js

@@ -0,0 +1,92 @@
+import { z } from "zod";
+import { API_HttpMethod, ExternalProvider_ExchangeProtocol_Kind, ExternalProvider_ExchangeProtocol_Status_BaseSchema } from "../core/commons.external-connectors-models.schemas.js";
+import { ExternalProvider_OperationContextSchema } from "../core/operations.external-connectors-models.schemas.js";
+//===============================================================
+// REST API Provider
+// --------
+// Integration with REST APIs. Uses Zod schemas for request/response
+// definitions. OpenAPI-compatible concepts mapped to Zod types.
+//===============================================================
+// ===============================================================
+// Parameter Location & Content Types
+// ===============================================================
+export var API_ParameterIn;
+(function (API_ParameterIn) {
+    API_ParameterIn["QUERY"] = "query";
+    API_ParameterIn["HEADER"] = "header";
+    API_ParameterIn["PATH"] = "path";
+    API_ParameterIn["COOKIE"] = "cookie";
+})(API_ParameterIn || (API_ParameterIn = {}));
+export var API_ContentType;
+(function (API_ContentType) {
+    API_ContentType["JSON"] = "application/json";
+    API_ContentType["XML"] = "application/xml";
+    API_ContentType["FORM_URLENCODED"] = "application/x-www-form-urlencoded";
+    API_ContentType["MULTIPART_FORM"] = "multipart/form-data";
+    API_ContentType["TEXT_PLAIN"] = "text/plain";
+    API_ContentType["OCTET_STREAM"] = "application/octet-stream";
+})(API_ContentType || (API_ContentType = {}));
+// ===============================================================
+// API Parameter (for path, query, header params)
+// ===============================================================
+export const API_ParameterSchema = z.object({
+    name: z.string(),
+    in: z.enum(API_ParameterIn),
+    description: z.string().optional(),
+    required: z.boolean().default(false),
+    deprecated: z.boolean().optional(),
+    // Schema is a Zod schema reference (stored as string for serialization)
+    schemaRef: z.string().optional(), // Reference to a named schema
+    // Or inline type info
+    type: z.enum(["string", "number", "integer", "boolean", "array"]).optional(),
+    format: z.string().optional(), // e.g., "date-time", "email", "uuid"
+    enumValues: z.array(z.string()).optional(),
+    defaultValue: z.unknown().optional(),
+});
+// ===============================================================
+// REST API Operation Spec
+// ===============================================================
+export const REST_API_OperationSpecSchema = z.object({
+    // HTTP specifics
+    method: z.enum(API_HttpMethod),
+    path: z.string(), // e.g., "/users/{userId}/posts"
+    // Parameters
+    parameters: z.array(API_ParameterSchema).optional(),
+    // Request/Response content types
+    requestContentType: z.enum(API_ContentType).optional(),
+    responseContentType: z.enum(API_ContentType).optional(),
+    // Rate limiting hints
+    rateLimit: z.object({
+        requests: z.number(),
+        period: z.enum(["second", "minute", "hour", "day"]),
+    }).optional(),
+    // Tags for grouping
+    tags: z.array(z.string()).optional(),
+    // Deprecation
+    deprecated: z.boolean().optional(),
+});
+// ===============================================================
+// REST API Operation Context (for tracking)
+// ===============================================================
+export const REST_API_OperationContextSchema = ExternalProvider_OperationContextSchema.extend({
+    // Request details
+    requestMethod: z.enum(API_HttpMethod),
+    requestPath: z.string(),
+    requestUrl: z.string(),
+    // Response details
+    responseStatus: z.number(),
+    responseStatusText: z.string().optional(),
+    // Rate limit info
+    rateLimitRemaining: z.number().optional(),
+    rateLimitReset: z.string().optional(),
+    // Retry info
+    retryCount: z.number().optional(),
+});
+// ===============================================================
+// STATUS
+// ===============================================================
+export const REST_APIProvider_StatusSchema = ExternalProvider_ExchangeProtocol_Status_BaseSchema.extend({
+    protocolKind: z.literal(ExternalProvider_ExchangeProtocol_Kind.REST_API),
+    apiVersion: z.string().optional(),
+});
+//# sourceMappingURL=rest-api.external-connectors-models.schemas.js.map

package/dist/esm/protocols/rest-api.external-connectors-models.schemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rest-api.external-connectors-models.schemas.js","sourceRoot":"","sources":["../../../src/protocols/rest-api.external-connectors-models.schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EACL,cAAc,EACd,sCAAsC,EACtC,mDAAmD,EAGpD,MAAM,oDAAoD,CAAC;AAC5D,OAAO,EAAE,uCAAuC,EAA6C,MAAM,uDAAuD,CAAC;AAE3J,iEAAiE;AACjE,oBAAoB;AACpB,WAAW;AACX,oEAAoE;AACpE,gEAAgE;AAChE,iEAAiE;AAEjE,kEAAkE;AAClE,qCAAqC;AACrC,kEAAkE;AAElE,MAAM,CAAN,IAAY,eAKX;AALD,WAAY,eAAe;IACzB,kCAAe,CAAA;IACf,oCAAiB,CAAA;IACjB,gCAAa,CAAA;IACb,oCAAiB,CAAA;AACnB,CAAC,EALW,eAAe,KAAf,eAAe,QAK1B;AAED,MAAM,CAAN,IAAY,eAOX;AAPD,WAAY,eAAe;IACzB,4CAAyB,CAAA;IACzB,0CAAuB,CAAA;IACvB,wEAAqD,CAAA;IACrD,yDAAsC,CAAA;IACtC,4CAAyB,CAAA;IACzB,4DAAyC,CAAA;AAC3C,CAAC,EAPW,eAAe,KAAf,eAAe,QAO1B;AAED,kEAAkE;AAClE,iDAAiD;AACjD,kEAAkE;AAElE,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC;IAC3B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;IACpC,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAElC,wEAAwE;IACxE,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAG,8BAA8B;IAEjE,sBAAsB;IACtB,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC5E,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAAG,qCAAqC;IACrE,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC1C,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CACrC,CAAC,CAAC;AAGH,kEAAkE;AAClE,0BAA0B;AAC1B,kEAAkE;AAElE,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC,MAAM,CAAC;IACnD,iBAAiB;IACjB,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC;IAC9B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,EAAG,gCAAgC;IAEnD,aAAa;IACb,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC,QAAQ,EAAE;IAEnD,iCAAiC;IACjC,kBAAkB,EAAE,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,QAAQ,EAAE;IACtD,mBAAmB,EAAE,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,QAAQ,EAAE;IAEvD,sBAAsB;IACtB,SAAS,EAAE,CAAC,CAAC,MAAM,CAAC;QAClB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;QACpB,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;KACpD,CAAC,CAAC,QAAQ,EAAE;IAEb,oBAAoB;IACpB,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAEpC,cAAc;IACd,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CACnC,CAAC,CAAC;AA8CH,kEAAkE;AAClE,4CAA4C;AAC5C,kEAAkE;AAElE,MAAM,CAAC,MAAM,+BAA+B,GAAG,uCAAuC,CAAC,MAAM,CAAC;IAC5F,kBAAkB;IAClB,aAAa,EAAE,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC;IACrC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IAEtB,mBAAmB;IACnB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;IAC1B,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAEzC,kBAAkB;IAClB,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzC,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAErC,aAAa;IACb,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAClC,CAAC,CAAC;AAeH,kEAAkE;AAClE,SAAS;AACT,kEAAkE;AAElE,MAAM,CAAC,MAAM,6BAA6B,GAAG,mDAAmD,CAAC,MAAM,CAAC;IACtG,YAAY,EAAE,CAAC,CAAC,OAAO,CAAC,sCAAsC,CAAC,QAAQ,CAAC;IACxE,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAClC,CAAC,CAAC"}