Class WorkspaceSearchClient

Hierarchy

ReactQueryNetworkClient
- WorkspaceSearchClient

Index

Constructors

Properties

clearAllUserHistory clearEntryInUserHistory search searchHistory

Methods

buildStackSpotError createPermissionFunctionFor createRequestFunctionFor fetch infiniteQuery isFreemium mutation query requestPermission resolveURL stream setup

Constructors

constructor

new WorkspaceSearchClient(): WorkspaceSearchClient
Returns WorkspaceSearchClient
Overrides ReactQueryNetworkClient.constructor
- Defined in client/workspace-search.ts:10

Properties

clearAllUserHistory

clearAllUserHistory: MutationObject<void, unknown> = ...

Clears users history

clearEntryInUserHistory

clearEntryInUserHistory: MutationObject<{ itemId: string }, unknown> = ...

Clears a specific entry in users history

search

search: InfiniteQueryObject<
    { category?: string; page?: number; q: string },
    SearchResponse,
    "content",
> = ...

Gets search data

searchHistory

searchHistory: QueryObject<void, SearchHistoryResponse> = ...

Gets search history

Methods

`Protected`buildStackSpotError

buildStackSpotError(error: HttpError): StackspotAPIError
Receives an HttpError and returns a StackspotAPIError.
Parameters
- error: HttpError
  the original HttpError created by oazapfts.
Returns StackspotAPIError
Overrides ReactQueryNetworkClient.buildStackSpotError
- Defined in client/workspace-search.ts:14

`Protected`createPermissionFunctionFor

createPermissionFunctionFor<
    Args extends
        | [variables: Record<string, any>, opts?: RequestOpts]
        | [opts?: RequestOpts],
>(
    fn: (...args: Args) => Promise<any>,
): (
    ...args: Args extends [opts?: RequestOpts]
        ? []
        : [variables?: Partial<Args[0]>],
) => Promise<boolean>
Creates a function that checks the permission for a request generated by an oazapfts function.

This is intended to help creating a manual operation.
Type Parameters
- Args extends [variables: Record<string, any>, opts?: RequestOpts] | [opts?: RequestOpts]
Parameters
- fn: (...args: Args) => Promise<any>
  the function generated by oazapfts.
Returns (
    ...args: Args extends [opts?: RequestOpts]
        ? []
        : [variables?: Partial<Args[0]>],
) => Promise<boolean>
a function that receives the variables of fn (if any) and returns a promise that resolves to true if the request is allowed and false otherwise.
Example
```
myOperation = this.mutation({
  // ...
  permission: this.createPermissionFunctionFor(oazapftsFnForMyOperation)
})
```
Inherited from ReactQueryNetworkClient.createPermissionFunctionFor
- Defined in network/ReactQueryNetworkClient.ts:81

`Protected`createRequestFunctionFor

createRequestFunctionFor<
    Args extends
        | [variables: Record<string, any>, opts?: RequestOpts]
        | [opts?: RequestOpts],
    Result,
>(
    fn: (...args: Args) => Promise<Result>,
): (
    ...args: Args extends [opts?: RequestOpts]
        ? [signal: AbortSignal]
        : [signal: AbortSignal, variables: Args[0]],
) => Promise<Result>
Creates a function that runs a oazapfts function with an abort signal.

This is intended to help creating a manual operation.
Type Parameters
- Args extends [variables: Record<string, any>, opts?: RequestOpts] | [opts?: RequestOpts]
- Result
Parameters
- fn: (...args: Args) => Promise<Result>
  the function generated by oazapfts.
Returns (
    ...args: Args extends [opts?: RequestOpts]
        ? [signal: AbortSignal]
        : [signal: AbortSignal, variables: Args[0]],
) => Promise<Result>
a function that receives a signal and the variables of fn (if any) and returns the same as fn.
Example
```
myOperation = this.mutation({
  // ...
  request: this.createRequestFunctionFor(oazapftsFnForMyOperation)
})
```
Inherited from ReactQueryNetworkClient.createRequestFunctionFor
- Defined in network/ReactQueryNetworkClient.ts:107

`Protected`fetch

fetch(input: string | URL | Request, init?: RequestInit): Promise<Response>
Makes a request (same signature as globalThis.fetch). This request will prepend the base url to the url and, if there's an active session, include authentication headers.
Parameters
- input: string | URL | Request
  the url or request object.
- Optionalinit: RequestInit
  the fetch options.
Returns Promise<Response>
a promise with the Response.
Inherited from ReactQueryNetworkClient.fetch
- Defined in network/NetworkClient.ts:90

`Protected`infiniteQuery

infiniteQuery<
    Variables extends Record<string, any>,
    Result,
    PageParamName extends string | number | symbol,
    Accumulator extends string | number | symbol,
>(
    config: InfiniteQueryConfig<
        Variables,
        Result,
        PageParamName,
        Accumulator,
    >,
): InfiniteQueryObject<Variables, Result, Accumulator>
Builds a query manually by using a configuration object.
Type Parameters
- Variables extends Record<string, any>
- Result
- PageParamName extends string | number | symbol
- Accumulator extends string | number | symbol
Parameters
- config: InfiniteQueryConfig<Variables, Result, PageParamName, Accumulator>
  the configuration object containing the name, a request function and a permission function.
Returns InfiniteQueryObject<Variables, Result, Accumulator>
Inherited from ReactQueryNetworkClient.infiniteQuery
- Defined in network/ReactQueryNetworkClient.ts:174
infiniteQuery<
    Variables extends Record<string, any>,
    Result,
    PageParamName extends string | number | symbol,
    Accumulator extends string | number | symbol,
>(
    config: Omit<
        InfiniteQueryConfig<Variables, Result, PageParamName, Accumulator>,
        "permission",
    >,
): Omit<
    InfiniteQueryObject<Variables, Result, Accumulator>,
    "isAllowed" | "useAllowed" | "getPermissionKey",
>
Builds a query manually by using a configuration object.
Type Parameters
- Variables extends Record<string, any>
- Result
- PageParamName extends string | number | symbol
- Accumulator extends string | number | symbol
Parameters
- config: Omit<
  InfiniteQueryConfig<Variables, Result, PageParamName, Accumulator>,
  "permission",
  >
  the configuration object containing the name and a request function.
Returns Omit<
InfiniteQueryObject<Variables, Result, Accumulator>,
"isAllowed" | "useAllowed" | "getPermissionKey",
>
Inherited from ReactQueryNetworkClient.infiniteQuery
- Defined in network/ReactQueryNetworkClient.ts:184
infiniteQuery<
    Variables extends Record<string, any>,
    Result,
    PageParamName extends string | number | symbol,
    Accumulator extends string | number | symbol,
>(
    fn: (variables: Variables, opts?: RequestOpts) => Promise<Result>,
    options: Partial<
        InfiniteQueryOptions<Variables, Result, PageParamName, Accumulator>,
    >,
): InfiniteQueryObject<Variables, Result, Accumulator>
Builds a query automatically by using a function generated by oazapfts.
Type Parameters
- Variables extends Record<string, any>
- Result
- PageParamName extends string | number | symbol
- Accumulator extends string | number | symbol
Parameters
- fn: (variables: Variables, opts?: RequestOpts) => Promise<Result>
  the oazapfts function.
- options: Partial<InfiniteQueryOptions<Variables, Result, PageParamName, Accumulator>>
  the configuration for the infinite query.
Returns InfiniteQueryObject<Variables, Result, Accumulator>
Inherited from ReactQueryNetworkClient.infiniteQuery
- Defined in network/ReactQueryNetworkClient.ts:197
infiniteQuery<
    Variables extends { page?: string
    | number; size?: string | number },
    Result extends any[],
    PageParamName extends string | number | symbol = "page",
    Accumulator extends string | number | symbol = "",
>(
    fn: (variables: Variables, opts?: RequestOpts) => Promise<Result>,
    options?: Partial<
        InfiniteQueryOptions<Variables, Result, PageParamName, Accumulator>,
    >,
): InfiniteQueryObject<Variables, Result, Accumulator>
Builds a query automatically by using a function generated by oazapfts with the variables page and size.
Type Parameters
- Variables extends { page?: string | number; size?: string | number }
- Result extends any[]
- PageParamName extends string | number | symbol = "page"
- Accumulator extends string | number | symbol = ""
Parameters
- fn: (variables: Variables, opts?: RequestOpts) => Promise<Result>
  the oazapfts function that returns an array.
- Optionaloptions: Partial<InfiniteQueryOptions<Variables, Result, PageParamName, Accumulator>>
  optional configuration for the infinite query. By default, it will use the variables page and size of the function passed in the first parameter.
Returns InfiniteQueryObject<Variables, Result, Accumulator>
Inherited from ReactQueryNetworkClient.infiniteQuery
- Defined in network/ReactQueryNetworkClient.ts:212
infiniteQuery<
    Variables extends Record<string, any>,
    Result,
    PageParamName extends string,
    Accumulator extends string | number | symbol,
>(
    fn: (variables: Variables, opts?: RequestOpts) => Promise<Result>,
    options: Partial<
        InfiniteQueryOptions<Variables, Result, PageParamName, Accumulator>,
    >,
): InfiniteQueryObject<Variables, Result, Accumulator>
Builds a query automatically by using a function generated by oazapfts in which the variables pageParamName is a string which can be used for dynamic indexing.
Type Parameters
- Variables extends Record<string, any>
- Result
- PageParamName extends string
- Accumulator extends string | number | symbol
Parameters
- fn: (variables: Variables, opts?: RequestOpts) => Promise<Result>
  the oazapfts function that returns an array.
- options: Partial<InfiniteQueryOptions<Variables, Result, PageParamName, Accumulator>>
  optional configuration for the infinite query. By default, it will use the variables page and size of the function passed in the first parameter.
Returns InfiniteQueryObject<Variables, Result, Accumulator>
Inherited from ReactQueryNetworkClient.infiniteQuery
- Defined in network/ReactQueryNetworkClient.ts:228

`Protected`isFreemium

isFreemium(): boolean
Checks whether or not the current account is freemium.

Returns boolean
true if it's a freemium account, false otherwise.
Inherited from ReactQueryNetworkClient.isFreemium
- Defined in network/NetworkClient.ts:137

`Protected`mutation

mutation<
    Args extends [AbortSignal, Record<string, any>]
    | [AbortSignal],
    Result,
>(
    config: OperationConfig<Args, Result>,
): MutationObject<Args extends [AbortSignal] ? void : Args[1], Result>
Builds a mutation manually by using a configuration object.
Type Parameters
- Args extends [AbortSignal, Record<string, any>] | [AbortSignal]
- Result
Parameters
- config: OperationConfig<Args, Result>
  the configuration object containing the name, a request function and a permission function.
Returns MutationObject<Args extends [AbortSignal] ? void : Args[1], Result>
Inherited from ReactQueryNetworkClient.mutation
- Defined in network/ReactQueryNetworkClient.ts:276
mutation<
    Args extends [AbortSignal, Record<string, any>]
    | [AbortSignal],
    Result,
>(
    config: Omit<OperationConfig<Args, Result>, "permission">,
): Omit<
    MutationObject<Args extends [AbortSignal] ? void : Args[1], Result>,
    keyof OperationObject<any>,
>
Builds a mutation manually by using a configuration object.
Type Parameters
- Args extends [AbortSignal, Record<string, any>] | [AbortSignal]
- Result
Parameters
- config: Omit<OperationConfig<Args, Result>, "permission">
  the configuration object containing the name and a request function.
Returns Omit<
MutationObject<Args extends [AbortSignal] ? void : Args[1], Result>,
keyof OperationObject<any>,
>
Inherited from ReactQueryNetworkClient.mutation
- Defined in network/ReactQueryNetworkClient.ts:283
mutation<
    Args extends
        | [opts?: RequestOpts]
        | [variables: Record<string, any>, opts?: RequestOpts],
    Result,
>(
    fn: (...args: Args) => Promise<Result>,
): Args extends [variables: Variables, opts?: RequestOpts]
    ? MutationObject<Variables, Result>
    : MutationObject<void, Result>
Builds a mutation automatically by using a function generated by oazapfts.
Type Parameters
- Args extends [opts?: RequestOpts] | [variables: Record<string, any>, opts?: RequestOpts]
- Result
Parameters
- fn: (...args: Args) => Promise<Result>
  the oazapfts function.
Returns Args extends [variables: Variables, opts?: RequestOpts]
? MutationObject<Variables, Result>
: MutationObject<void, Result>
Inherited from ReactQueryNetworkClient.mutation
- Defined in network/ReactQueryNetworkClient.ts:290

`Protected`query

query<Args extends [AbortSignal, Record<string, any>] | [AbortSignal], Result>(
config: OperationConfig<Args, Result>,
): QueryObject<Args extends [AbortSignal] ? void : Args[1], Result>
Builds a query manually by using a configuration object.
Type Parameters
- Args extends [AbortSignal, Record<string, any>] | [AbortSignal]
- Result
Parameters
- config: OperationConfig<Args, Result>
  the configuration object containing the name, a request function and a permission function.
Returns QueryObject<Args extends [AbortSignal] ? void : Args[1], Result>
Inherited from ReactQueryNetworkClient.query
- Defined in network/ReactQueryNetworkClient.ts:134
query<Args extends [AbortSignal, Record<string, any>] | [AbortSignal], Result>(
    config: Omit<OperationConfig<Args, Result>, "permission">,
): Omit<
    QueryObject<Args extends [AbortSignal] ? void : Args[1], Result>,
    "isAllowed" | "useAllowed" | "getPermissionKey",
>
Builds a query manually by using a configuration object.
Type Parameters
- Args extends [AbortSignal, Record<string, any>] | [AbortSignal]
- Result
Parameters
- config: Omit<OperationConfig<Args, Result>, "permission">
  the configuration object containing the name and a request function.
Returns Omit<
QueryObject<Args extends [AbortSignal] ? void : Args[1], Result>,
"isAllowed" | "useAllowed" | "getPermissionKey",
>
Inherited from ReactQueryNetworkClient.query
- Defined in network/ReactQueryNetworkClient.ts:141
query<
    Args extends
        | [opts?: RequestOpts]
        | [variables: Record<string, any>, opts?: RequestOpts],
    Result,
>(
    fn: (...args: Args) => Promise<Result>,
): Args extends [variables: Variables, opts?: RequestOpts]
    ? QueryObject<Variables, Result>
    : QueryObject<void, Result>
Builds a query automatically by using a function generated by oazapfts.
Type Parameters
- Args extends [opts?: RequestOpts] | [variables: Record<string, any>, opts?: RequestOpts]
- Result
Parameters
- fn: (...args: Args) => Promise<Result>
  the oazapfts function.
Returns Args extends [variables: Variables, opts?: RequestOpts]
? QueryObject<Variables, Result>
: QueryObject<void, Result>
Inherited from ReactQueryNetworkClient.query
- Defined in network/ReactQueryNetworkClient.ts:148

`Protected`requestPermission

requestPermission(
    method: HTTPMethod,
    path: string,
    body?: string | object,
): Promise<boolean>
Verifies if the current user is allowed to send the given request.
Parameters
- method: HTTPMethod
  the request's method.
- path: string
  the path to the resource.
- Optionalbody: string | object
  the request's body.
Returns Promise<boolean>
a promise that resolves to true if it's allowed or false otherwise.
Inherited from ReactQueryNetworkClient.requestPermission
- Defined in network/NetworkClient.ts:66

`Protected`resolveURL

resolveURL(path: string): URL
Builds a URL with the baseUrl of this network client and the path passed as parameter.
Parameters
- path: string
  the path to the resource.
Returns URL
a full URL.
Inherited from ReactQueryNetworkClient.resolveURL
- Defined in network/NetworkClient.ts:50

`Protected`stream

stream(
input: string | URL | Request,
init?: RequestInit,
): Promise<FetchEventStream>
Reads an EventSource from the endpoint. Differently than the original specification, this allows common HTTP requests with method and body to be made.
Parameters
- input: string | URL | Request
  the url or request object.
- Optionalinit: RequestInit
  the fetch options.
Returns Promise<FetchEventStream>
a promise with a FetchEventStream, which is an AsyncGenerator.
Example
```
let events = this.stream('url', options)
for await (let event of events) {
  console.log('<<', event.data)
}
```
Inherited from ReactQueryNetworkClient.stream
- Defined in network/NetworkClient.ts:121

`Static`setup

setup(sessionManager: SessionManager, env: Env): void
Sets up all network clients. Must be called before attempting to make any request.
Parameters
- sessionManager: SessionManager
  An object with functions capable of checking, retrieving and ending the current session.
- env: Env
  The environment to send the requests to.
Returns void
Inherited from ReactQueryNetworkClient.setup
- Defined in network/NetworkClient.ts:36

Class WorkspaceSearchClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns WorkspaceSearchClient

Properties

clearAllUserHistory

clearEntryInUserHistory

search

searchHistory

Methods

ProtectedbuildStackSpotError

Parameters

Returns StackspotAPIError

ProtectedcreatePermissionFunctionFor

Type Parameters

Parameters

Returns ( ...args: Args extends [opts?: RequestOpts] ? [] : [variables?: Partial<Args[0]>],) => Promise<boolean>

Example

ProtectedcreateRequestFunctionFor

Type Parameters

Parameters

Returns ( ...args: Args extends [opts?: RequestOpts] ? [signal: AbortSignal] : [signal: AbortSignal, variables: Args[0]],) => Promise<Result>

Example

Protectedfetch

Parameters

Returns Promise<Response>

ProtectedinfiniteQuery

Type Parameters

Parameters

Returns InfiniteQueryObject<Variables, Result, Accumulator>

Type Parameters

Parameters

Returns Omit< InfiniteQueryObject<Variables, Result, Accumulator>, "isAllowed" | "useAllowed" | "getPermissionKey",>

Type Parameters

Parameters

Returns InfiniteQueryObject<Variables, Result, Accumulator>

Type Parameters

Parameters

Returns InfiniteQueryObject<Variables, Result, Accumulator>

Type Parameters

Parameters

Returns InfiniteQueryObject<Variables, Result, Accumulator>

ProtectedisFreemium

Returns boolean

Protectedmutation

Type Parameters

Parameters

Returns MutationObject<Args extends [AbortSignal] ? void : Args[1], Result>

Type Parameters

Parameters

Returns Omit< MutationObject<Args extends [AbortSignal] ? void : Args[1], Result>, keyof OperationObject<any>,>

Type Parameters

Parameters

Returns Args extends [variables: Variables, opts?: RequestOpts] ? MutationObject<Variables, Result> : MutationObject<void, Result>

Protectedquery

Type Parameters

Parameters

Returns QueryObject<Args extends [AbortSignal] ? void : Args[1], Result>

Type Parameters

Parameters

Returns Omit< QueryObject<Args extends [AbortSignal] ? void : Args[1], Result>, "isAllowed" | "useAllowed" | "getPermissionKey",>

Type Parameters

Parameters

Returns Args extends [variables: Variables, opts?: RequestOpts] ? QueryObject<Variables, Result> : QueryObject<void, Result>

ProtectedrequestPermission

Parameters

Returns Promise<boolean>

ProtectedresolveURL

Parameters

Returns URL

Protectedstream

Parameters

Returns Promise<FetchEventStream>

Example

Staticsetup

`Protected`buildStackSpotError

`Protected`createPermissionFunctionFor

Returns (
...args: Args extends [opts?: RequestOpts]
? []
: [variables?: Partial<Args[0]>],
) => Promise<boolean>

`Protected`createRequestFunctionFor

Returns (
...args: Args extends [opts?: RequestOpts]
? [signal: AbortSignal]
: [signal: AbortSignal, variables: Args[0]],
) => Promise<Result>

`Protected`fetch

`Protected`infiniteQuery

Returns Omit<
InfiniteQueryObject<Variables, Result, Accumulator>,
"isAllowed" | "useAllowed" | "getPermissionKey",
>

`Protected`isFreemium

`Protected`mutation

Returns Omit<
MutationObject<Args extends [AbortSignal] ? void : Args[1], Result>,
keyof OperationObject<any>,
>

Returns Args extends [variables: Variables, opts?: RequestOpts]
? MutationObject<Variables, Result>
: MutationObject<void, Result>

`Protected`query

Returns Omit<
QueryObject<Args extends [AbortSignal] ? void : Args[1], Result>,
"isAllowed" | "useAllowed" | "getPermissionKey",
>

Returns Args extends [variables: Variables, opts?: RequestOpts]
? QueryObject<Variables, Result>
: QueryObject<void, Result>

`Protected`requestPermission

`Protected`resolveURL

`Protected`stream

`Static`setup