scrivito/src/scrivito_sdk/client/suggest_retrieval.ts

Scrivito is a professional, yet easy to use SaaS Enterprise Content Management Service, built for digital agencies and medium to large businesses. It is completely maintenance-free, cost-effective, and has unprecedented performance and security.

// @rewire
import {
  MissingWorkspaceError,
  cmsRestApi,
} from 'scrivito_sdk/client/cms_rest_api';
import { QueryParams } from 'scrivito_sdk/data';

export interface BackendSuggestParams {
  prefix: string;
  options: { site_aware: true };

  fields?: string[];
  limit?: number;
  from_search?: Partial<QueryParams>;
}

export interface BackendSuggestResponse {
  results: string[];
}

export function retrieveSuggest(
  workspaceId: string,
  params: BackendSuggestParams
): Promise<BackendSuggestResponse> {
  return cmsRestApi
    .put(`workspaces/${workspaceId}/objs/search/suggest`, params)
    .then((response) => response as BackendSuggestResponse)
    .catch((error) => {
      if (error instanceof MissingWorkspaceError) return { results: [] };
      throw error;
    });
}