@iblai/data-layer 1.17.0 → 1.18.0

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iblai/data-layer",
-  "version": "1.16.0",
+  "version": "1.17.0",
   "description": "ibl.ai data layer",
   "main": "dist/index.esm.js",
   "types": "dist/index.d.ts",

package/dist/src/features/search/__tests__/api-slice.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/features/search/__tests__/url.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/features/search/api-slice.d.ts

@@ -1,3 +1,5 @@
+import type { GlobalSearchArgs, GlobalSearchResponse } from './types';
+export { buildGlobalSearchUrl } from './url';
 export declare const searchApiSlice: import("@reduxjs/toolkit/query").Api<import("@reduxjs/toolkit/query").BaseQueryFn<void, unknown, unknown, {
     attempt?: number;
 } & import("@reduxjs/toolkit/query").RetryOptions, {}>, {
@@ -71,6 +73,9 @@ export declare const searchApiSlice: import("@reduxjs/toolkit/query").Api<import
     }], import("@reduxjs/toolkit/query").BaseQueryFn<void, unknown, unknown, {
         attempt?: number;
     } & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, import("@iblai/iblai-api").GlobalCatalogSearchResponse, "searchApiSlice", any>;
+    getSearchGlobal: import("@reduxjs/toolkit/query").QueryDefinition<[(GlobalSearchArgs | undefined)?], import("@reduxjs/toolkit/query").BaseQueryFn<void, unknown, unknown, {
+        attempt?: number;
+    } & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, GlobalSearchResponse, "searchApiSlice", any>;
 }, "searchApiSlice", never, typeof import("@reduxjs/toolkit/query").coreModuleName | typeof import("@reduxjs/toolkit/dist/query/react").reactHooksModuleName>;
 export declare const useGetPersonnalizedSearchQuery: <R extends Record<string, any> = import("@reduxjs/toolkit/query").TSHelpersId<(Omit<{
     status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;
@@ -2014,4 +2019,303 @@ export declare const useGetPersonnalizedSearchQuery: <R extends Record<string, a
         topics?: Array<string>;
         updateFacet?: string;
     }];
+}], useGetSearchGlobalQuery: <R extends Record<string, any> = import("@reduxjs/toolkit/query").TSHelpersId<(Omit<{
+    status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;
+    originalArgs?: undefined | undefined;
+    data?: undefined | undefined;
+    error?: undefined | undefined;
+    requestId?: undefined | undefined;
+    endpointName?: string | undefined;
+    startedTimeStamp?: undefined | undefined;
+    fulfilledTimeStamp?: undefined | undefined;
+} & {
+    currentData?: GlobalSearchResponse | undefined;
+    isUninitialized: false;
+    isLoading: false;
+    isFetching: false;
+    isSuccess: false;
+    isError: false;
+}, "isUninitialized"> & {
+    isUninitialized: true;
+}) | import("@reduxjs/toolkit/query").TSHelpersOverride<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<[(GlobalSearchArgs | undefined)?], import("@reduxjs/toolkit/query").BaseQueryFn<void, unknown, unknown, {
+    attempt?: number;
+} & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, GlobalSearchResponse, "searchApiSlice", any>> & {
+    currentData?: GlobalSearchResponse | undefined;
+    isUninitialized: false;
+    isLoading: false;
+    isFetching: false;
+    isSuccess: false;
+    isError: false;
+}, {
+    isLoading: true;
+    isFetching: boolean;
+    data: undefined;
+} | ({
+    isSuccess: true;
+    isFetching: true;
+    error: undefined;
+} & Required<Pick<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<[(GlobalSearchArgs | undefined)?], import("@reduxjs/toolkit/query").BaseQueryFn<void, unknown, unknown, {
+    attempt?: number;
+} & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, GlobalSearchResponse, "searchApiSlice", any>> & {
+    currentData?: GlobalSearchResponse | undefined;
+    isUninitialized: false;
+    isLoading: false;
+    isFetching: false;
+    isSuccess: false;
+    isError: false;
+}, "data" | "fulfilledTimeStamp">>) | ({
+    isSuccess: true;
+    isFetching: false;
+    error: undefined;
+} & Required<Pick<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<[(GlobalSearchArgs | undefined)?], import("@reduxjs/toolkit/query").BaseQueryFn<void, unknown, unknown, {
+    attempt?: number;
+} & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, GlobalSearchResponse, "searchApiSlice", any>> & {
+    currentData?: GlobalSearchResponse | undefined;
+    isUninitialized: false;
+    isLoading: false;
+    isFetching: false;
+    isSuccess: false;
+    isError: false;
+}, "data" | "fulfilledTimeStamp" | "currentData">>) | ({
+    isError: true;
+} & Required<Pick<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<[(GlobalSearchArgs | undefined)?], import("@reduxjs/toolkit/query").BaseQueryFn<void, unknown, unknown, {
+    attempt?: number;
+} & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, GlobalSearchResponse, "searchApiSlice", any>> & {
+    currentData?: GlobalSearchResponse | undefined;
+    isUninitialized: false;
+    isLoading: false;
+    isFetching: false;
+    isSuccess: false;
+    isError: false;
+}, "error">>)>> & {
+    status: import("@reduxjs/toolkit/query").QueryStatus;
+}>(arg: [(GlobalSearchArgs | undefined)?] | typeof import("@reduxjs/toolkit/query").skipToken, options?: (import("@reduxjs/toolkit/query").SubscriptionOptions & {
+    skip?: boolean;
+    refetchOnMountOrArgChange?: boolean | number;
+} & {
+    skip?: boolean;
+    selectFromResult?: ((state: import("@reduxjs/toolkit/query").TSHelpersId<(Omit<{
+        status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;
+        originalArgs?: undefined | undefined;
+        data?: undefined | undefined;
+        error?: undefined | undefined;
+        requestId?: undefined | undefined;
+        endpointName?: string | undefined;
+        startedTimeStamp?: undefined | undefined;
+        fulfilledTimeStamp?: undefined | undefined;
+    } & {
+        currentData?: GlobalSearchResponse | undefined;
+        isUninitialized: false;
+        isLoading: false;
+        isFetching: false;
+        isSuccess: false;
+        isError: false;
+    }, "isUninitialized"> & {
+        isUninitialized: true;
+    }) | import("@reduxjs/toolkit/query").TSHelpersOverride<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<[(GlobalSearchArgs | undefined)?], import("@reduxjs/toolkit/query").BaseQueryFn<void, unknown, unknown, {
+        attempt?: number;
+    } & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, GlobalSearchResponse, "searchApiSlice", any>> & {
+        currentData?: GlobalSearchResponse | undefined;
+        isUninitialized: false;
+        isLoading: false;
+        isFetching: false;
+        isSuccess: false;
+        isError: false;
+    }, {
+        isLoading: true;
+        isFetching: boolean;
+        data: undefined;
+    } | ({
+        isSuccess: true;
+        isFetching: true;
+        error: undefined;
+    } & Required<Pick<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<[(GlobalSearchArgs | undefined)?], import("@reduxjs/toolkit/query").BaseQueryFn<void, unknown, unknown, {
+        attempt?: number;
+    } & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, GlobalSearchResponse, "searchApiSlice", any>> & {
+        currentData?: GlobalSearchResponse | undefined;
+        isUninitialized: false;
+        isLoading: false;
+        isFetching: false;
+        isSuccess: false;
+        isError: false;
+    }, "data" | "fulfilledTimeStamp">>) | ({
+        isSuccess: true;
+        isFetching: false;
+        error: undefined;
+    } & Required<Pick<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<[(GlobalSearchArgs | undefined)?], import("@reduxjs/toolkit/query").BaseQueryFn<void, unknown, unknown, {
+        attempt?: number;
+    } & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, GlobalSearchResponse, "searchApiSlice", any>> & {
+        currentData?: GlobalSearchResponse | undefined;
+        isUninitialized: false;
+        isLoading: false;
+        isFetching: false;
+        isSuccess: false;
+        isError: false;
+    }, "data" | "fulfilledTimeStamp" | "currentData">>) | ({
+        isError: true;
+    } & Required<Pick<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<[(GlobalSearchArgs | undefined)?], import("@reduxjs/toolkit/query").BaseQueryFn<void, unknown, unknown, {
+        attempt?: number;
+    } & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, GlobalSearchResponse, "searchApiSlice", any>> & {
+        currentData?: GlobalSearchResponse | undefined;
+        isUninitialized: false;
+        isLoading: false;
+        isFetching: false;
+        isSuccess: false;
+        isError: false;
+    }, "error">>)>> & {
+        status: import("@reduxjs/toolkit/query").QueryStatus;
+    }) => R) | undefined;
+}) | undefined) => [R][R extends any ? 0 : never] & {
+    refetch: () => import("@reduxjs/toolkit/query").QueryActionCreatorResult<import("@reduxjs/toolkit/query").QueryDefinition<[(GlobalSearchArgs | undefined)?], import("@reduxjs/toolkit/query").BaseQueryFn<void, unknown, unknown, {
+        attempt?: number;
+    } & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, GlobalSearchResponse, "searchApiSlice", any>>;
+}, useLazyGetSearchGlobalQuery: <R extends Record<string, any> = import("@reduxjs/toolkit/query").TSHelpersId<(Omit<{
+    status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;
+    originalArgs?: undefined | undefined;
+    data?: undefined | undefined;
+    error?: undefined | undefined;
+    requestId?: undefined | undefined;
+    endpointName?: string | undefined;
+    startedTimeStamp?: undefined | undefined;
+    fulfilledTimeStamp?: undefined | undefined;
+} & {
+    currentData?: GlobalSearchResponse | undefined;
+    isUninitialized: false;
+    isLoading: false;
+    isFetching: false;
+    isSuccess: false;
+    isError: false;
+}, "isUninitialized"> & {
+    isUninitialized: true;
+}) | import("@reduxjs/toolkit/query").TSHelpersOverride<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<[(GlobalSearchArgs | undefined)?], import("@reduxjs/toolkit/query").BaseQueryFn<void, unknown, unknown, {
+    attempt?: number;
+} & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, GlobalSearchResponse, "searchApiSlice", any>> & {
+    currentData?: GlobalSearchResponse | undefined;
+    isUninitialized: false;
+    isLoading: false;
+    isFetching: false;
+    isSuccess: false;
+    isError: false;
+}, {
+    isLoading: true;
+    isFetching: boolean;
+    data: undefined;
+} | ({
+    isSuccess: true;
+    isFetching: true;
+    error: undefined;
+} & Required<Pick<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<[(GlobalSearchArgs | undefined)?], import("@reduxjs/toolkit/query").BaseQueryFn<void, unknown, unknown, {
+    attempt?: number;
+} & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, GlobalSearchResponse, "searchApiSlice", any>> & {
+    currentData?: GlobalSearchResponse | undefined;
+    isUninitialized: false;
+    isLoading: false;
+    isFetching: false;
+    isSuccess: false;
+    isError: false;
+}, "data" | "fulfilledTimeStamp">>) | ({
+    isSuccess: true;
+    isFetching: false;
+    error: undefined;
+} & Required<Pick<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<[(GlobalSearchArgs | undefined)?], import("@reduxjs/toolkit/query").BaseQueryFn<void, unknown, unknown, {
+    attempt?: number;
+} & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, GlobalSearchResponse, "searchApiSlice", any>> & {
+    currentData?: GlobalSearchResponse | undefined;
+    isUninitialized: false;
+    isLoading: false;
+    isFetching: false;
+    isSuccess: false;
+    isError: false;
+}, "data" | "fulfilledTimeStamp" | "currentData">>) | ({
+    isError: true;
+} & Required<Pick<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<[(GlobalSearchArgs | undefined)?], import("@reduxjs/toolkit/query").BaseQueryFn<void, unknown, unknown, {
+    attempt?: number;
+} & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, GlobalSearchResponse, "searchApiSlice", any>> & {
+    currentData?: GlobalSearchResponse | undefined;
+    isUninitialized: false;
+    isLoading: false;
+    isFetching: false;
+    isSuccess: false;
+    isError: false;
+}, "error">>)>> & {
+    status: import("@reduxjs/toolkit/query").QueryStatus;
+}>(options?: (import("@reduxjs/toolkit/query").SubscriptionOptions & Omit<{
+    skip?: boolean;
+    selectFromResult?: ((state: import("@reduxjs/toolkit/query").TSHelpersId<(Omit<{
+        status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;
+        originalArgs?: undefined | undefined;
+        data?: undefined | undefined;
+        error?: undefined | undefined;
+        requestId?: undefined | undefined;
+        endpointName?: string | undefined;
+        startedTimeStamp?: undefined | undefined;
+        fulfilledTimeStamp?: undefined | undefined;
+    } & {
+        currentData?: GlobalSearchResponse | undefined;
+        isUninitialized: false;
+        isLoading: false;
+        isFetching: false;
+        isSuccess: false;
+        isError: false;
+    }, "isUninitialized"> & {
+        isUninitialized: true;
+    }) | import("@reduxjs/toolkit/query").TSHelpersOverride<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<[(GlobalSearchArgs | undefined)?], import("@reduxjs/toolkit/query").BaseQueryFn<void, unknown, unknown, {
+        attempt?: number;
+    } & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, GlobalSearchResponse, "searchApiSlice", any>> & {
+        currentData?: GlobalSearchResponse | undefined;
+        isUninitialized: false;
+        isLoading: false;
+        isFetching: false;
+        isSuccess: false;
+        isError: false;
+    }, {
+        isLoading: true;
+        isFetching: boolean;
+        data: undefined;
+    } | ({
+        isSuccess: true;
+        isFetching: true;
+        error: undefined;
+    } & Required<Pick<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<[(GlobalSearchArgs | undefined)?], import("@reduxjs/toolkit/query").BaseQueryFn<void, unknown, unknown, {
+        attempt?: number;
+    } & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, GlobalSearchResponse, "searchApiSlice", any>> & {
+        currentData?: GlobalSearchResponse | undefined;
+        isUninitialized: false;
+        isLoading: false;
+        isFetching: false;
+        isSuccess: false;
+        isError: false;
+    }, "data" | "fulfilledTimeStamp">>) | ({
+        isSuccess: true;
+        isFetching: false;
+        error: undefined;
+    } & Required<Pick<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<[(GlobalSearchArgs | undefined)?], import("@reduxjs/toolkit/query").BaseQueryFn<void, unknown, unknown, {
+        attempt?: number;
+    } & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, GlobalSearchResponse, "searchApiSlice", any>> & {
+        currentData?: GlobalSearchResponse | undefined;
+        isUninitialized: false;
+        isLoading: false;
+        isFetching: false;
+        isSuccess: false;
+        isError: false;
+    }, "data" | "fulfilledTimeStamp" | "currentData">>) | ({
+        isError: true;
+    } & Required<Pick<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<[(GlobalSearchArgs | undefined)?], import("@reduxjs/toolkit/query").BaseQueryFn<void, unknown, unknown, {
+        attempt?: number;
+    } & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, GlobalSearchResponse, "searchApiSlice", any>> & {
+        currentData?: GlobalSearchResponse | undefined;
+        isUninitialized: false;
+        isLoading: false;
+        isFetching: false;
+        isSuccess: false;
+        isError: false;
+    }, "error">>)>> & {
+        status: import("@reduxjs/toolkit/query").QueryStatus;
+    }) => R) | undefined;
+}, "skip">) | undefined) => [(arg: [(GlobalSearchArgs | undefined)?], preferCacheValue?: boolean) => import("@reduxjs/toolkit/query").QueryActionCreatorResult<import("@reduxjs/toolkit/query").QueryDefinition<[(GlobalSearchArgs | undefined)?], import("@reduxjs/toolkit/query").BaseQueryFn<void, unknown, unknown, {
+    attempt?: number;
+} & import("@reduxjs/toolkit/query").RetryOptions, {}>, never, GlobalSearchResponse, "searchApiSlice", any>>, [R][R extends any ? 0 : never] & {
+    reset: () => void;
+}, {
+    lastArg: [(GlobalSearchArgs | undefined)?];
 }];

package/dist/src/features/search/constants.d.ts

@@ -39,3 +39,18 @@ export declare const CUSTOM_AI_SEARCH_QUERY_KEYS: {
     GET_MENTORS: () => string[];
     GET_PERSONNALIZED_MENTORS: () => string[];
 };
+/** Path of the global (non-personalized) catalog search endpoint. */
+export declare const GLOBAL_SEARCH_PATH = "/api/search/global/";
+/**
+ * Defaults the generated `SearchService.searchGlobalRetrieve` applies to its
+ * own parameters. Kept here so the hand-built URL sends the same query the
+ * generated client would, and so swapping to it later is a no-op for callers.
+ */
+export declare const GLOBAL_SEARCH_DEFAULTS: {
+    allowSkillSearch: boolean;
+    alphabetical: boolean;
+    limit: number;
+    orderAscending: boolean;
+    returnFacet: boolean;
+    returnItems: boolean;
+};

package/dist/src/features/search/types.d.ts

@@ -159,3 +159,84 @@ export interface GetAiSearchMentorsArgs {
     starred?: boolean;
     featured?: boolean;
 }
+/**
+ * Query parameters accepted by `GET /api/search/global/`.
+ *
+ * Camel-cased to match the generated `SearchService` signature; the URL
+ * builder converts each key to its snake_case query param.
+ */
+export interface GlobalSearchArgs {
+    /** Enable skill-based search. */
+    allowSkillSearch?: boolean;
+    /** Sort alphabetically by name. */
+    alphabetical?: boolean;
+    /** Filter by certificate type. */
+    certificate?: string[];
+    /** Content types to include, e.g. `['courses', 'programs', 'resources']`. */
+    content?: string[];
+    /** Filter by a specific course ID. */
+    courseId?: string;
+    /** Filter by course duration range. */
+    duration?: string[];
+    /** Filter by content language. */
+    language?: string[];
+    /** Filter by difficulty level. */
+    level?: string[];
+    /** Number of results per page. */
+    limit?: number;
+    /** Starting position for pagination. */
+    offset?: number;
+    /** Sort direction. */
+    orderAscending?: boolean;
+    /** Field to sort results by. */
+    orderBy?: string;
+    /** Filter by a specific pathway ID. */
+    pathwayId?: string;
+    /** Filter by price/audit status. */
+    price?: string;
+    /** Filter by a specific program ID. */
+    programId?: string;
+    /** Filter by program type. */
+    programType?: string[];
+    /** Filter by promotion status. */
+    promotion?: string[];
+    /** Search term matched against name and description. */
+    query?: string;
+    /** Filter by resource type. */
+    resourceType?: string[];
+    /** Include facet data in the response. */
+    returnFacet?: boolean;
+    /** Include the items nested in programs/pathways. */
+    returnItems?: boolean;
+    /** Filter by course format. */
+    selfPaced?: string[];
+    /** Filter by a specific skill ID. */
+    skillId?: string;
+    /** Filter by skills. */
+    skills?: string[];
+    /** Filter by subject areas. */
+    subject?: string[];
+    /** Filter by tags. */
+    tags?: string[];
+    /** Filter by tenant/organization. */
+    tenant?: string;
+    /** Filter by topic areas. */
+    topics?: string[];
+    /** Force a facet update. */
+    updateFacet?: string;
+}
+/** Response shape of `GET /api/search/global/`. */
+export interface GlobalSearchResponse {
+    /** Content items matching the search criteria. */
+    results: Record<string, unknown>[];
+    /** Total number of items matching the search criteria. */
+    count: number;
+    /** URL for the next page of results. */
+    next: string | null;
+    /** URL for the previous page of results. */
+    previous: string | null;
+    current_page: number;
+    total_pages: number;
+    /** Facet information for filtering, omitted when `returnFacet` is false. */
+    facets?: Record<string, unknown>;
+}

package/dist/src/features/search/url.d.ts

@@ -0,0 +1,10 @@
+import type { GlobalSearchArgs } from './types';
+/**
+ * Build the URL for `GET /api/search/global/`.
+ *
+ * Hand-assembled rather than delegating to `SearchService.searchGlobalRetrieve`
+ * because the workspace pins `@iblai/iblai-api` to a release that predates that
+ * method (see `overrides` in pnpm-workspace.yaml). Params and defaults mirror
+ * the generated signature so the two stay interchangeable.
+ */
+export declare const buildGlobalSearchUrl: (args?: GlobalSearchArgs) => string;

package/dist/src/features/utils.d.ts

@@ -62,6 +62,15 @@ export declare const buildEndpointFromAxdService: <Args extends Record<string, u
 export declare const buildEndpointFromDmUrl: <Args extends Record<string, unknown>, Result>(buildUrl: (args: Args) => string, service?: SERVICES) => {
     queryFn: BaseQueryFn<Args, Result, FetchBaseQueryError | CustomError>;
 };
+/**
+ * Build an endpoint from a hand-assembled URL, taking its arguments in the
+ * spread-array form the `*Legacy` builders use. Lets a URL-backed endpoint sit
+ * in the same slice as generated-service ones without callers having to switch
+ * between `hook(args)` and `hook([args])`.
+ */
+export declare const buildEndpointFromDmUrlLegacy: <Args extends any[], Result>(buildUrl: (...args: Args) => string, service?: SERVICES) => {
+    queryFn: BaseQueryFn<Args, Result, FetchBaseQueryError | CustomError>;
+};
 export interface CustomQueryArgs extends Omit<FetchArgs, 'url'> {
     url: string;
     service: SERVICES;