@redocly/replay 0.8.12 → 0.9.0

package/dist/replay.d.ts

@@ -3,30 +3,6 @@ import { ImmutableObject } from '@hookstate/core';
 import { JSX as JSX_2 } from 'react/jsx-runtime';
 import { NamedExoticComponent } from 'react';
 import { ReactElement } from 'react';
-import { State } from '@hookstate/core';
-
-declare enum ApiKeyLocation {
-    Query = "Query",
-    Header = "Header",
-    Cookie = "Cookie"
-}
-
-declare type App = {
-    title: string;
-    id: string;
-    credentials?: AppCredential[];
-};
-
-declare type AppCredential = {
-    id: string;
-    clientId?: string;
-    clientSecret?: string;
-    stage?: string;
-    issuedAt: string;
-    expiresAt: string;
-    status: string;
-    valueToUseInHeader: 'clientId' | 'clientSecret';
-};
 
 declare type AuthorizationCodeOAuthFlowsObject = {
     authorizationUrl: string;
@@ -41,292 +17,59 @@ declare type Certificate = {
     keyFilePath: string;
 };
 
+declare type ChangedOperation = {
+    sourcePath: SourcePath;
+    requestValues: {
+        cookie?: {
+            [key: string]: string;
+        };
+        header?: {
+            [key: string]: string;
+        };
+        query?: {
+            [key: string]: string;
+        };
+        body?: any;
+    };
+    activeExampleName?: string;
+    activeSecuritySchemeIds?: string[];
+    activeOneOf?: {
+        [key: string]: number;
+    };
+};
+
 declare type ClientCredentialsOAuthFlowsObject = {
     'x-assertionType'?: 'urn:ietf:params:oauth:client-assertion-type:jwt-bearer';
     tokenUrl: string;
     scopes: Record<string, string>;
 };
 
-declare type CollectionsFolder = {
-    id: string;
-    name: string;
-    items: CollectionsItem[];
-    state: CollectionsItemState;
-};
-
-declare type CollectionsItem = {
-    type: CollectionsItemType;
-    value: CollectionsFolder | CollectionsRequest;
-};
-
-declare enum CollectionsItemState {
-    Normal = "Normal",
-    Edit = "Edit",
-    Draft = "Draft"
-}
-
-declare enum CollectionsItemType {
-    Folder = "folder",
-    Request = "request"
-}
-
-declare type CollectionsRequest = {
-    id: string;
-    state: CollectionsItemState;
-    name: string;
-    request: Request_2;
-    response: Response_2 | null;
-};
+declare type ConvertOperationFunction = (path: string, method: string, openAPI: any) => OpenAPIOperation | undefined;
 
 export declare function EmbeddedReplay(props: ReplayAppProps): JSX_2.Element;
 
-declare type Environment = {
-    id: string;
-    url?: string;
-    name: string;
-    variables: EnvironmentVariable[];
-    state: EnvironmentState;
-    canBeRemoved: boolean;
-    canBeEdited: boolean;
-};
-
-declare enum EnvironmentState {
-    Normal = "Normal",
-    Edit = "Edit",
-    Draft = "Draft"
-}
-
-declare type EnvironmentVariable = {
-    id: string;
-    name: string;
-    value: string;
-    type: EnvironmentVariableType;
-    canBeRemoved: boolean;
-    canBeEdited: boolean;
-    isSecret?: boolean;
-    readonlyName?: boolean;
-};
-
-declare enum EnvironmentVariableType {
-    Server = "Server",
-    ServerUrl = "ServerUrl",
-    Path = "Path",
-    UserCreated = "UserCreated",
-    Security = "Security"
-}
-
-declare type FormDataParameter = Parameter & {
-    type: InputType;
-    files: FileList | null;
-};
-
-declare const globalState: State<    {
-requestController: AbortController | undefined;
-request: {
-method: string;
-url: string;
-security: {
-securitySchemeVariants: SecuritySchemeVariantType[];
-selectedSecuritySchemeId: string;
-securities: {
-securityType: SecurityTypes;
-securitySchemeId: string;
-"Basic Auth": {
-username: string;
-password: string;
-};
-JWT: {
-token: string;
-};
-"Digest Auth": {
-username: string;
-password: string;
-nc: string;
-realm: string | undefined;
-nonce: string | undefined;
-opaque: string | undefined;
-qop: string | undefined;
-algorithm: string | undefined;
-cnonce: string | undefined;
-};
-"API key": {
-location: ApiKeyLocation;
-name: string;
-key: string;
-};
-"OAuth 2.0": {
-documentedOAuth2Types: SecurityFlows[];
-grantType: SecurityFlows;
-authRequestExtraParams: Parameter[];
-tokenRequestExtraParams: SecurityDataParameter[];
-"Client Credentials": {
-clientId: string;
-clientSecret: string;
-clientAssertion: string;
-tokenUrl: string;
-scopes: Parameter[];
-accessToken: string;
-};
-"Client Credentials with JWT Assertion": {
-clientId: string;
-clientSecret: string;
-clientAssertion: string;
-tokenUrl: string;
-scopes: Parameter[];
-accessToken: string;
-};
-"Authorization Code": {
-clientId: string;
-clientSecret: string;
-tokenUrl: string;
-authorizationUrl: string;
-callbackUrl: string;
-availableScopes: string[];
-scopes: Parameter[];
-codeVerifier: string;
-codeChallenge: string;
-accessToken: string;
-};
-Implicit: {
-clientId: string;
-authorizationUrl: string;
-callbackUrl: string;
-availableScopes: string[];
-scopes: Parameter[];
-accessToken: string;
-};
-Password: {
-username: string;
-password: string;
-clientId: string;
-clientSecret: string;
-tokenUrl: string;
-accessToken: string;
-};
-};
-"OpenID Connect": {
-openIdConnectUrl: string;
-userInfoUrl: string;
-documentedOAuth2Types: SecurityFlows[];
-grantType: SecurityFlows;
-authRequestExtraParams: Parameter[];
-tokenRequestExtraParams: SecurityDataParameter[];
-"Client Credentials": {
-clientId: string;
-clientSecret: string;
-clientAssertion: string;
-tokenUrl: string;
-scopes: Parameter[];
-accessToken: string;
-};
-"Client Credentials with JWT Assertion": {
-clientId: string;
-clientSecret: string;
-clientAssertion: string;
-tokenUrl: string;
-scopes: Parameter[];
-accessToken: string;
-};
-"Authorization Code": {
-clientId: string;
-clientSecret: string;
-tokenUrl: string;
-authorizationUrl: string;
-callbackUrl: string;
-availableScopes: string[];
-scopes: Parameter[];
-codeVerifier: string;
-codeChallenge: string;
-accessToken: string;
-};
-Implicit: {
-clientId: string;
-authorizationUrl: string;
-callbackUrl: string;
-availableScopes: string[];
-scopes: Parameter[];
-accessToken: string;
-};
-Password: {
-username: string;
-password: string;
-clientId: string;
-clientSecret: string;
-tokenUrl: string;
-accessToken: string;
-};
-};
-}[];
-};
-body: {
-type: string;
-content: string;
-activeExampleName: string;
-formData: {
-[x: string]: FormDataParameter[];
-};
-binary: File | null;
-};
-queryParameters: Parameter[];
-headers: Parameter[];
-cookies: Parameter[];
-};
-isProcessingRequest: boolean;
-response: ImmutableObject<    {
-headers: [string, string][];
-cookies: [string, string][];
-body: string;
-duration: number;
-size: number;
-status: number;
-bodyUsed: boolean;
-arrayBuffer: ArrayBuffer;
-}> | null;
-requestError: string | null;
-history: HistoryItem[];
-collections: CollectionsItem[];
-operation: Operation | null;
-operationUrl: string | undefined;
-isLinked: boolean;
-environments: Environment[];
-selectedEnvironmentId: string | null;
-corsProxyUrl: string | undefined;
-mockServer: MockServer | undefined;
-appsLoadingState: LoadingState;
-apps: App[];
-apiId: string | undefined;
-requestActiveTabIdx: number;
-oAuth2RedirectURI: string | null | undefined;
-isRequestEditable: boolean;
-tokenRequestError: string | null;
-definitionUrl: string | undefined;
-transactionSource: TransactionSource | null;
-showUnsavedChangesModal: boolean;
-pendingTransaction: Transaction | null;
-pendingTransactionSource: TransactionSource | null;
-disableCollectionsTab: boolean | undefined;
-certificates: Certificate[];
-}, {}>;
-
-declare type HistoryItem = {
-    date: number;
-    request: Request_2;
-    response: Response_2 | null;
-};
+declare type GetOperationURLFunction = (operationId?: string, source?: Source) => string | undefined;
 
 declare type ImplicitOAuthFlowsObject = {
     authorizationUrl?: string;
     scopes: Record<string, string>;
 };
 
-declare type InputType = 'text' | 'file';
-
-declare enum LoadingState {
-    Idle = "idle",
-    Loading = "loading",
-    Success = "success",
-    Error = "error"
-}
+declare type InputSettings = {
+    corsProxyUrl?: string;
+    mockServer?: MockServer;
+    disableCollectionsTab?: boolean;
+    disableDraft?: boolean;
+    oAuth2RedirectURI?: string | null;
+    inline?: boolean;
+    environment?: string;
+    apiId?: string;
+    predefinedEnvValues?: Record<string, Record<string, string>>;
+    certificates?: Certificate[];
+    storageKey?: string;
+    convertOperationToReplayValue?: ConvertOperationFunction;
+    getOperationUrl?: GetOperationURLFunction;
+};
 
 declare type MediaType = {
     name: string;
@@ -366,12 +109,6 @@ declare type ModalProps = {
     className?: string;
 };
 
-declare enum OAuth2ExtraParamsLocation {
-    Body = "Body",
-    Header = "Header",
-    URL = "URL"
-}
-
 declare type OAuthFlowsObject = {
     implicit?: ImplicitOAuthFlowsObject;
     password?: PasswordOAuthFlowsObject;
@@ -379,16 +116,14 @@ declare type OAuthFlowsObject = {
     authorizationCode?: AuthorizationCodeOAuthFlowsObject;
 };
 
-declare function openFile({ name, extensions, multiple, }: {
-    name: string;
-    extensions: string[];
-    multiple: boolean;
-}): Promise<FileResponse | string | null>;
-
-declare type Operation = {
+declare type OpenAPIOperation = {
+    id: string;
+    sourceId?: string;
     name: string;
     method: string;
     path: string;
+    href: string;
+    operationId?: string;
     parameters: OperationParameter[];
     body?: {
         mediaTypes: MediaTypes;
@@ -397,8 +132,15 @@ declare type Operation = {
     };
     servers: Server[];
     security?: OperationSecurity[][];
+    response?: Response_2 | null;
 };
 
+declare function openFile({ name, extensions, multiple, }: {
+    name: string;
+    extensions: string[];
+    multiple: boolean;
+}): Promise<FileResponse | string | null>;
+
 declare type OperationIn = 'query' | 'header' | 'path' | 'cookie';
 
 declare type OperationParameter = {
@@ -433,13 +175,6 @@ export declare type OperationSecurity = {
     flows?: OAuthFlowsObject;
 };
 
-declare type Parameter = {
-    id: string;
-    active: boolean;
-    key: string;
-    value: string;
-};
-
 declare type PasswordOAuthFlowsObject = {
     tokenUrl: string;
     scopes: Record<string, string>;
@@ -448,42 +183,18 @@ declare type PasswordOAuthFlowsObject = {
 export declare function Replay(props: ReplayAppProps): JSX_2.Element;
 
 declare type ReplayAppProps = {
-    value?: Operation;
-    inline?: boolean;
-    operationUrl?: string;
-    corsProxyUrl?: string;
-    mockServer?: MockServer;
-    disableDraft?: boolean;
-    environment?: string;
-    predefinedEnvValues?: Record<string, Record<string, string>>;
-    apiId?: string;
-    oAuth2RedirectURI?: string | null;
-    definitionUrl?: string;
-    disableCollectionsTab?: boolean;
-    certificates?: Certificate[];
+    activeOperationId?: string;
+    source?: Omit<Source, 'id'>;
+    settings: InputSettings;
 };
 
-declare type ReplayOnChangeParams = {
-    requestValues: {
-        cookie?: {
-            [key: string]: string;
-        };
-        header?: {
-            [key: string]: string;
-        };
-        query?: {
-            [key: string]: string;
-        };
-        body?: any;
-    } | object;
-    activeExampleName?: string;
+export declare type ReplayOnChangeParams = {
+    operations: ChangedOperation[];
     activeMimeName?: string;
-    activeServer?: Server;
     environment?: string;
     environments?: Record<string, {
         [key: string]: string;
     }>;
-    activeSecuritySchemeIds?: string[];
 };
 
 export declare function ReplayOverlay({ onClose, onLoad, onRequestChange, ...props }: ReplayOverlayProps): JSX_2.Element;
@@ -494,10 +205,6 @@ declare type ReplayOverlayProps = {
     onRequestChange?: (props: ReplayOnChangeParams) => void;
 } & ReplayAppProps;
 
-export declare type ReplayState = typeof globalState.value;
-
-declare type Request_2 = typeof globalState.value.request;
-
 declare type Response_2 = ImmutableObject<{
     headers: [string, string][];
     cookies: [string, string][];
@@ -509,33 +216,6 @@ declare type Response_2 = ImmutableObject<{
     arrayBuffer: ArrayBuffer;
 }>;
 
-declare type SecurityDataParameter = Parameter & {
-    sendIn: OAuth2ExtraParamsLocation;
-};
-
-declare enum SecurityFlows {
-    ClientCredentials = "Client Credentials",
-    ClientCredentialsWithJwtAssertion = "Client Credentials with JWT Assertion",
-    AuthorizationCode = "Authorization Code",
-    Implicit = "Implicit",
-    Password = "Password"
-}
-
-declare type SecuritySchemeVariantType = {
-    id: string;
-    schemes: string[];
-};
-
-declare enum SecurityTypes {
-    NoAuth = "No Auth",
-    BasicAuth = "Basic Auth",
-    DigestAuth = "Digest Auth",
-    JWT = "JWT",
-    APIKey = "API key",
-    OAuth2 = "OAuth 2.0",
-    OpenIDConnect = "OpenID Connect"
-}
-
 declare type Server = {
     url: string;
     description?: string;
@@ -550,15 +230,16 @@ declare type ServerVariable = {
     description?: string;
 };
 
-declare type Transaction = {
-    request: Request_2;
-    response: Response_2 | null;
+declare type Source = {
+    id: string;
+    type: 'openapi' | 'arazzo';
+    path?: string;
+    data: Record<string, any>;
 };
 
-declare type TransactionSource = {
-    id: string;
-    type: 'collection';
-    name: string;
+declare type SourcePath = {
+    path: string;
+    method: string;
 };
 
 export declare const utils: {