@stack-spot/portal-network 0.184.0 → 0.185.0-beta.1

package/src/api/workspaceSearchEngine.ts

@@ -1,153 +1,153 @@
-/**
- * Search Engine API
- * v1.0.0
- * DO NOT MODIFY - This file has been generated using oazapfts.
- * See https://www.npmjs.com/package/oazapfts
- */
-import * as Oazapfts from "@oazapfts/runtime";
-import * as QS from "@oazapfts/runtime/query";
-export const defaults: Oazapfts.Defaults<Oazapfts.CustomHeaders> = {
-    headers: {},
-    baseUrl: "https://workspace-search-engine-api.dev.stackspot.com",
-};
-const oazapfts = Oazapfts.runtime(defaults);
-export const servers = {
-    generatedServerUrl: "https://workspace-search-engine-api.dev.stackspot.com"
-};
-export type ExtraDataResponse = {
-    key: string;
-    value: string;
-};
-export type SearchDataItemResponse = {
-    /** The resource identifier. */
-    identifier?: string;
-    /** The resource slug. */
-    identifierSlug?: string;
-    /** The resource description. */
-    description?: string;
-    /** The resource display name. */
-    name?: string;
-    /** The resource extra data correlated to itself (ie: the workspace ID of an application) */
-    extraData?: ExtraDataResponse[];
-};
-export type SearchDataResponse = {
-    /** The resource type category of the items */
-    category?: string;
-    /** The total result count for the searched text */
-    totalCount?: number;
-    /** List of the resources found */
-    items?: SearchDataItemResponse[];
-};
-export type Pagination = {
-    /** Total pages */
-    totalPages?: number;
-    /** Total pageable elements */
-    totalElements?: number;
-    /** Current page number starting from 0 */
-    pageNumber?: number;
-    /** Current page size. Fixed 50 items. */
-    pageSize?: number;
-    /** Has more results to return. */
-    hasNext?: boolean;
-};
-export type SearchResponse = {
-    content: SearchDataResponse[];
-    pagination?: Pagination;
-};
-export type ValidationDetails = {
-    code: string;
-    field?: string;
-    details?: string;
-    values?: string[];
-};
-export type ErrorResponse = {
-    code: string;
-    status: number;
-    details: string;
-    validationDetails?: ValidationDetails[];
-};
-export type HistoryItemResponse = {
-    id: string;
-    searchText: string;
-};
-export type SearchHistoryResponse = {
-    items: HistoryItemResponse[];
-};
-/**
- * Search all Stackspot resources using semantic search.
- */
-export function search({ q, category, page }: {
-    q: string;
-    category?: string;
-    page?: number;
-}, opts?: Oazapfts.RequestOpts) {
-    return oazapfts.ok(oazapfts.fetchJson<{
-        status: 200;
-        data: SearchResponse;
-    } | {
-        status: 400;
-        data: ErrorResponse;
-    } | {
-        status: 500;
-        data: ErrorResponse;
-    }>(`/v1/search${QS.query(QS.explode({
-        q,
-        category,
-        page
-    }))}`, {
-        ...opts
-    }));
-}
-/**
- * Get the logged-in user search history list.
- */
-export function getUserHistory(opts?: Oazapfts.RequestOpts) {
-    return oazapfts.ok(oazapfts.fetchJson<{
-        status: 200;
-        data: SearchHistoryResponse;
-    } | {
-        status: 403;
-        data: ErrorResponse;
-    } | {
-        status: 500;
-        data: ErrorResponse;
-    }>("/v1/search/history", {
-        ...opts
-    }));
-}
-/**
- * Clear the logged-in user search history.
- */
-export function clearUserHistory(opts?: Oazapfts.RequestOpts) {
-    return oazapfts.ok(oazapfts.fetchJson<{
-        status: 204;
-    } | {
-        status: 403;
-        data: ErrorResponse;
-    } | {
-        status: 500;
-        data: ErrorResponse;
-    }>("/v1/search/history", {
-        ...opts,
-        method: "DELETE"
-    }));
-}
-/**
- * Delete the logged-in user specific search history item.
- */
-export function deleteUserHistoryItem({ itemId }: {
-    itemId: string;
-}, opts?: Oazapfts.RequestOpts) {
-    return oazapfts.ok(oazapfts.fetchJson<{
-        status: 204;
-    } | {
-        status: 403;
-        data: ErrorResponse;
-    } | {
-        status: 500;
-        data: ErrorResponse;
-    }>(`/v1/search/history/${encodeURIComponent(itemId)}`, {
-        ...opts,
-        method: "DELETE"
-    }));
-}
+/**
+ * Search Engine API
+ * v1.0.0
+ * DO NOT MODIFY - This file has been generated using oazapfts.
+ * See https://www.npmjs.com/package/oazapfts
+ */
+import * as Oazapfts from "@oazapfts/runtime";
+import * as QS from "@oazapfts/runtime/query";
+export const defaults: Oazapfts.Defaults<Oazapfts.CustomHeaders> = {
+    headers: {},
+    baseUrl: "https://workspace-search-engine-api.dev.stackspot.com",
+};
+const oazapfts = Oazapfts.runtime(defaults);
+export const servers = {
+    generatedServerUrl: "https://workspace-search-engine-api.dev.stackspot.com"
+};
+export type ExtraDataResponse = {
+    key: string;
+    value: string;
+};
+export type SearchDataItemResponse = {
+    /** The resource identifier. */
+    identifier?: string;
+    /** The resource slug. */
+    identifierSlug?: string;
+    /** The resource description. */
+    description?: string;
+    /** The resource display name. */
+    name?: string;
+    /** The resource extra data correlated to itself (ie: the workspace ID of an application) */
+    extraData?: ExtraDataResponse[];
+};
+export type SearchDataResponse = {
+    /** The resource type category of the items */
+    category?: string;
+    /** The total result count for the searched text */
+    totalCount?: number;
+    /** List of the resources found */
+    items?: SearchDataItemResponse[];
+};
+export type Pagination = {
+    /** Total pages */
+    totalPages?: number;
+    /** Total pageable elements */
+    totalElements?: number;
+    /** Current page number starting from 0 */
+    pageNumber?: number;
+    /** Current page size. Fixed 50 items. */
+    pageSize?: number;
+    /** Has more results to return. */
+    hasNext?: boolean;
+};
+export type SearchResponse = {
+    content: SearchDataResponse[];
+    pagination?: Pagination;
+};
+export type ValidationDetails = {
+    code: string;
+    field?: string;
+    details?: string;
+    values?: string[];
+};
+export type ErrorResponse = {
+    code: string;
+    status: number;
+    details: string;
+    validationDetails?: ValidationDetails[];
+};
+export type HistoryItemResponse = {
+    id: string;
+    searchText: string;
+};
+export type SearchHistoryResponse = {
+    items: HistoryItemResponse[];
+};
+/**
+ * Search all Stackspot resources using semantic search.
+ */
+export function search({ q, category, page }: {
+    q: string;
+    category?: string;
+    page?: number;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: SearchResponse;
+    } | {
+        status: 400;
+        data: ErrorResponse;
+    } | {
+        status: 500;
+        data: ErrorResponse;
+    }>(`/v1/search${QS.query(QS.explode({
+        q,
+        category,
+        page
+    }))}`, {
+        ...opts
+    }));
+}
+/**
+ * Get the logged-in user search history list.
+ */
+export function getUserHistory(opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: SearchHistoryResponse;
+    } | {
+        status: 403;
+        data: ErrorResponse;
+    } | {
+        status: 500;
+        data: ErrorResponse;
+    }>("/v1/search/history", {
+        ...opts
+    }));
+}
+/**
+ * Clear the logged-in user search history.
+ */
+export function clearUserHistory(opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 204;
+    } | {
+        status: 403;
+        data: ErrorResponse;
+    } | {
+        status: 500;
+        data: ErrorResponse;
+    }>("/v1/search/history", {
+        ...opts,
+        method: "DELETE"
+    }));
+}
+/**
+ * Delete the logged-in user specific search history item.
+ */
+export function deleteUserHistoryItem({ itemId }: {
+    itemId: string;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 204;
+    } | {
+        status: 403;
+        data: ErrorResponse;
+    } | {
+        status: 500;
+        data: ErrorResponse;
+    }>(`/v1/search/history/${encodeURIComponent(itemId)}`, {
+        ...opts,
+        method: "DELETE"
+    }));
+}

package/src/api-addresses.ts

@@ -1,120 +1,120 @@
-import apisItauJson from './apis-itau.json' assert { type: 'json' }
-import apisJson from './apis.json' assert { type: 'json' }
-import { NetworkClient } from './network/NetworkClient'
-import { Env, Tenant } from './network/types'
-
-type ApisKeys = keyof typeof apisJson;
-
-type ApiConfig = {
-  url: Record<Env, string>,
-  docs?: string,
-}
-
-type PartialApiConfig = {
-  url: Partial<Record<Env, string>>,
-  docs?: string
-}
-
-type Apis = Record<ApisKeys, ApiConfig>;
-
-type PartialApis = Partial<Record<ApisKeys, PartialApiConfig>>;
-
-type ApiAddress = {
-  [api: string]: string,
-}
-
-let defaultApis: Apis = apisJson;
-let overrideApis: PartialApis = {};
-
-const apis: Record<Tenant, Apis> = {
-  'stackspot': apisJson,
-  'itau': apisItauJson,
-}
-
-/**
- * Returns the API catalog for the given tenant.
- *
- * @param tenant The current tenant (e.g., 'stackspot', 'itau').
- * @returns API catalog containing the URLs per environment.
- */
-export function getApisByTenant(tenant: Tenant) {
-  return apis[tenant]
-}
-
-function transformApisToApiAddress(apis: Apis, env: Env): ApiAddress {
-  const apiAddress: ApiAddress = {}
-
-  for (const api in apis) {
-    const key = api as ApisKeys
-    apiAddress[key] = apis[key].url[env]
-  }
-
-  return apiAddress
-}
-
-/**
- * Searchs the default APIs configuration for the API object that matches the given baseURL.
- * @param baseUrl the base URL to search.
- * @param candidate the URL of the desired API to find.
- * @returns {boolean} true if the URL is found, otherwise false.
- */
-function matchesBaseUrl(baseUrl: Record<Env, string>, candidate: Record<Env, string>): boolean {
-  const envs: Env[] = ['dev', 'stg', 'prd'];
-
-  return envs.every(e => {
-    if (candidate[e]) {
-      return baseUrl[e] === candidate[e];
-    }
-    return true;
-  });
-}
-
-/**
- * Returns the base URL for the given environment and tenant, applying any overrides if available
- * 
- * @param baseURL the default API base URL.
- * @param targetEnv the target environment
- * @param tenant the current tenant.
- * @returns {string} the base URL for the given environment and tenant, applying any overrides if available.
- */
-export const getBaseUrlByTenantWithOverride = (baseUrl: Record<Env, string>, targetEnv: Env = 'prd', tenant: Tenant = 'stackspot'): string => {
-  let matchesApiName: ApisKeys | null = null;
-
-  for (const [apiName, config] of Object.entries(defaultApis) as [ApisKeys, ApiConfig][]) {
-    if (matchesBaseUrl(baseUrl, config.url)) {
-      matchesApiName = apiName;
-      break;
-    }
-  }
-
-  if (!matchesApiName) return ''
-
-  const overrideUrl = overrideApis[matchesApiName]?.url?.[targetEnv]
-  if (overrideUrl) {
-    return overrideUrl;
-  }
-
-  const apis = getApisByTenant(tenant)
-  return apis[matchesApiName]?.url?.[targetEnv];
-}
-
-/**
- * Sets the APIs addresses for override.
- * @param customApis a JSON object containing APIs address to override.
- */
-export const setApisOverride = (customApis: PartialApis) => {
-  overrideApis = customApis;
-}
-
-/**
- * Sets the default APIs addresses for each environments.
- * @returns {Apis} an object containing APIs URLs grouped by api name and enviroments.
- */
-export const getApiAddresses = (): Apis => {
-  return defaultApis;
-}
-
-export const apiAddresses = () => {
-  const env = NetworkClient.getEnv()
-  return transformApisToApiAddress(defaultApis, env)
-}
+import apisItauJson from './apis-itau.json' assert { type: 'json' }
+import apisJson from './apis.json' assert { type: 'json' }
+import { NetworkClient } from './network/NetworkClient'
+import { Env, Tenant } from './network/types'
+
+type ApisKeys = keyof typeof apisJson;
+
+type ApiConfig = {
+  url: Record<Env, string>,
+  docs?: string,
+}
+
+type PartialApiConfig = {
+  url: Partial<Record<Env, string>>,
+  docs?: string
+}
+
+type Apis = Record<ApisKeys, ApiConfig>;
+
+type PartialApis = Partial<Record<ApisKeys, PartialApiConfig>>;
+
+type ApiAddress = {
+  [api: string]: string,
+}
+
+let defaultApis: Apis = apisJson;
+let overrideApis: PartialApis = {};
+
+const apis: Record<Tenant, Apis> = {
+  'stackspot': apisJson,
+  'itau': apisItauJson,
+}
+
+/**
+ * Returns the API catalog for the given tenant.
+ *
+ * @param tenant The current tenant (e.g., 'stackspot', 'itau').
+ * @returns API catalog containing the URLs per environment.
+ */
+export function getApisByTenant(tenant: Tenant) {
+  return apis[tenant]
+}
+
+function transformApisToApiAddress(apis: Apis, env: Env): ApiAddress {
+  const apiAddress: ApiAddress = {}
+
+  for (const api in apis) {
+    const key = api as ApisKeys
+    apiAddress[key] = apis[key].url[env]
+  }
+
+  return apiAddress
+}
+
+/**
+ * Searchs the default APIs configuration for the API object that matches the given baseURL.
+ * @param baseUrl the base URL to search.
+ * @param candidate the URL of the desired API to find.
+ * @returns {boolean} true if the URL is found, otherwise false.
+ */
+function matchesBaseUrl(baseUrl: Record<Env, string>, candidate: Record<Env, string>): boolean {
+  const envs: Env[] = ['dev', 'stg', 'prd'];
+
+  return envs.every(e => {
+    if (candidate[e]) {
+      return baseUrl[e] === candidate[e];
+    }
+    return true;
+  });
+}
+
+/**
+ * Returns the base URL for the given environment and tenant, applying any overrides if available
+ * 
+ * @param baseURL the default API base URL.
+ * @param targetEnv the target environment
+ * @param tenant the current tenant.
+ * @returns {string} the base URL for the given environment and tenant, applying any overrides if available.
+ */
+export const getBaseUrlByTenantWithOverride = (baseUrl: Record<Env, string>, targetEnv: Env = 'prd', tenant: Tenant = 'stackspot'): string => {
+  let matchesApiName: ApisKeys | null = null;
+
+  for (const [apiName, config] of Object.entries(defaultApis) as [ApisKeys, ApiConfig][]) {
+    if (matchesBaseUrl(baseUrl, config.url)) {
+      matchesApiName = apiName;
+      break;
+    }
+  }
+
+  if (!matchesApiName) return ''
+
+  const overrideUrl = overrideApis[matchesApiName]?.url?.[targetEnv]
+  if (overrideUrl) {
+    return overrideUrl;
+  }
+
+  const apis = getApisByTenant(tenant)
+  return apis[matchesApiName]?.url?.[targetEnv];
+}
+
+/**
+ * Sets the APIs addresses for override.
+ * @param customApis a JSON object containing APIs address to override.
+ */
+export const setApisOverride = (customApis: PartialApis) => {
+  overrideApis = customApis;
+}
+
+/**
+ * Sets the default APIs addresses for each environments.
+ * @returns {Apis} an object containing APIs URLs grouped by api name and enviroments.
+ */
+export const getApiAddresses = (): Apis => {
+  return defaultApis;
+}
+
+export const apiAddresses = () => {
+  const env = NetworkClient.getEnv()
+  return transformApisToApiAddress(defaultApis, env)
+}