Merge pull request #288 from umbraco/feature/v17/algolia

Feature/v17/algolia

Author: acoumb

examples/Umbraco.Cms.Integrations.Testsite.V17/Umbraco.Cms.Integrations.Testsite.V17.csproj

@@ -8,6 +8,7 @@
 
   <ItemGroup>
     <PackageReference Include="Umbraco.Cms" Version="17.0.0" />
+    <ProjectReference Include="..\..\src\Umbraco.Cms.Integrations.Search.Algolia\Umbraco.Cms.Integrations.Search.Algolia.csproj" />
     <ProjectReference Include="..\..\src\Umbraco.Cms.Integrations.Crm.Hubspot\Umbraco.Cms.Integrations.Crm.Hubspot.csproj" />
     <ProjectReference Include="..\..\src\Umbraco.Cms.Integrations.SEO.Semrush\Umbraco.Cms.Integrations.SEO.Semrush.csproj" />
     <ProjectReference Include="..\..\src\Umbraco.Cms.Integrations.Automation.Zapier\Umbraco.Cms.Integrations.Automation.Zapier.csproj" />

examples/Umbraco.Cms.Integrations.Testsite.V17/appsettings.json

@@ -41,4 +41,4 @@
       }
     }
   }
-}
+}

src/Umbraco.Cms.Integrations.Search.Algolia/AlgoliaComposer.cs

@@ -1,6 +1,6 @@
 using Algolia.Search.Models.Search;
 using Microsoft.Extensions.DependencyInjection;
-using Microsoft.OpenApi.Models;
+using Microsoft.OpenApi;
 using Swashbuckle.AspNetCore.SwaggerGen;
 using Umbraco.Cms.Api.Common.OpenApi;
 using Umbraco.Cms.Core.Composing;

src/Umbraco.Cms.Integrations.Search.Algolia/Client/.npmrc

@@ -0,0 +1 @@
+@umbraco-cms:registry=https://www.myget.org/F/umbracoprereleases/npm/

src/Umbraco.Cms.Integrations.Search.Algolia/Client/generated/client.gen.ts

@@ -1,7 +1,8 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
-import type { ClientOptions } from './types.gen';
-import { type Config, type ClientOptions as DefaultClientOptions, createClient, createConfig } from '@hey-api/client-fetch';
+import { type ClientOptions, type Config, createClient, createConfig } from '@hey-api/client-fetch';
+
+import type { ClientOptions as ClientOptions2 } from './types.gen';
 
 /**
  * The `createClientConfig()` function will be called on client initialization
@@ -11,9 +12,9 @@ import { type Config, type ClientOptions as DefaultClientOptions, createClient,
  * `setConfig()`. This is useful for example if you're using Next.js
  * to ensure your client always has the correct values.
  */
-export type CreateClientConfig<T extends DefaultClientOptions = ClientOptions> = (override?: Config<DefaultClientOptions & T>) => Config<Required<DefaultClientOptions> & T>;
+export type CreateClientConfig<T extends ClientOptions = ClientOptions2> = (override?: Config<ClientOptions & T>) => Config<Required<ClientOptions> & T>;
 
-export const client = createClient(createConfig<ClientOptions>({
-    baseUrl: 'http://localhost:58030',
+export const client = createClient(createConfig<ClientOptions2>({
+    baseUrl: 'http://localhost:28157',
     throwOnError: true
-}));
+}));

src/Umbraco.Cms.Integrations.Search.Algolia/Client/generated/index.ts

@@ -1,4 +1,5 @@
 // This file is auto-generated by @hey-api/openapi-ts
+
 export * from './types.gen';
 export * from './client.gen';
-export * from './sdk.gen';
+export * from './sdk.gen';

src/Umbraco.Cms.Integrations.Search.Algolia/Client/generated/sdk.gen.ts

@@ -1,10 +1,11 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
-import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';
-import type { GetContentTypesData, GetContentTypesResponse, GetSearchContentTypeIndexByIdData, GetSearchContentTypeIndexByIdResponse, GetIndicesData, GetIndicesResponse, PostSaveIndexData, PostSaveIndexResponse, DeleteSearchIndexData, DeleteSearchIndexResponse, GetSearchIndexByIdData, GetSearchIndexByIdResponse, GetSearchIndexData, GetSearchIndexResponse, PostBuildSearchIndexData, PostBuildSearchIndexResponse } from './types.gen';
-import { client as _heyApiClient } from './client.gen';
+import type { Client, Options as Options2, TDataShape } from '@hey-api/client-fetch';
 
-export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
+import { client } from './client.gen';
+import type { DeleteSearchIndexData, DeleteSearchIndexErrors, DeleteSearchIndexResponses, GetContentTypesData, GetContentTypesErrors, GetContentTypesResponses, GetIndicesData, GetIndicesErrors, GetIndicesResponses, GetSearchContentTypeIndexByIdData, GetSearchContentTypeIndexByIdErrors, GetSearchContentTypeIndexByIdResponses, GetSearchIndexByIdData, GetSearchIndexByIdErrors, GetSearchIndexByIdResponses, GetSearchIndexData, GetSearchIndexErrors, GetSearchIndexResponses, PostBuildSearchIndexData, PostBuildSearchIndexErrors, PostBuildSearchIndexResponses, PostSaveIndexData, PostSaveIndexErrors, PostSaveIndexResponses } from './types.gen';
+
+export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
     /**
      * You can provide a client instance returned by `createClient()` instead of
      * individual options. This might be also useful if you want to implement a
@@ -18,9 +19,9 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
     meta?: Record<string, unknown>;
 };
 
-export class AlgoliaSearchService {
+export class AlgoliaSearch {
     public static getContentTypes<ThrowOnError extends boolean = true>(options?: Options<GetContentTypesData, ThrowOnError>) {
-        return (options?.client ?? _heyApiClient).get<GetContentTypesResponse, unknown, ThrowOnError>({
+        return (options?.client ?? client).get<GetContentTypesResponses, GetContentTypesErrors, ThrowOnError>({
             security: [
                 {
                     scheme: 'bearer',
@@ -33,7 +34,7 @@ export class AlgoliaSearchService {
     }
 
     public static getSearchContentTypeIndexById<ThrowOnError extends boolean = true>(options: Options<GetSearchContentTypeIndexByIdData, ThrowOnError>) {
-        return (options.client ?? _heyApiClient).get<GetSearchContentTypeIndexByIdResponse, unknown, ThrowOnError>({
+        return (options.client ?? client).get<GetSearchContentTypeIndexByIdResponses, GetSearchContentTypeIndexByIdErrors, ThrowOnError>({
             security: [
                 {
                     scheme: 'bearer',
@@ -46,7 +47,7 @@ export class AlgoliaSearchService {
     }
 
     public static getIndices<ThrowOnError extends boolean = true>(options?: Options<GetIndicesData, ThrowOnError>) {
-        return (options?.client ?? _heyApiClient).get<GetIndicesResponse, unknown, ThrowOnError>({
+        return (options?.client ?? client).get<GetIndicesResponses, GetIndicesErrors, ThrowOnError>({
             security: [
                 {
                     scheme: 'bearer',
@@ -59,7 +60,7 @@ export class AlgoliaSearchService {
     }
 
     public static postSaveIndex<ThrowOnError extends boolean = true>(options?: Options<PostSaveIndexData, ThrowOnError>) {
-        return (options?.client ?? _heyApiClient).post<PostSaveIndexResponse, unknown, ThrowOnError>({
+        return (options?.client ?? client).post<PostSaveIndexResponses, PostSaveIndexErrors, ThrowOnError>({
             security: [
                 {
                     scheme: 'bearer',
@@ -76,7 +77,7 @@ export class AlgoliaSearchService {
     }
 
     public static deleteSearchIndex<ThrowOnError extends boolean = true>(options: Options<DeleteSearchIndexData, ThrowOnError>) {
-        return (options.client ?? _heyApiClient).delete<DeleteSearchIndexResponse, unknown, ThrowOnError>({
+        return (options.client ?? client).delete<DeleteSearchIndexResponses, DeleteSearchIndexErrors, ThrowOnError>({
             security: [
                 {
                     scheme: 'bearer',
@@ -89,7 +90,7 @@ export class AlgoliaSearchService {
     }
 
     public static getSearchIndexById<ThrowOnError extends boolean = true>(options: Options<GetSearchIndexByIdData, ThrowOnError>) {
-        return (options.client ?? _heyApiClient).get<GetSearchIndexByIdResponse, unknown, ThrowOnError>({
+        return (options.client ?? client).get<GetSearchIndexByIdResponses, GetSearchIndexByIdErrors, ThrowOnError>({
             security: [
                 {
                     scheme: 'bearer',
@@ -102,7 +103,7 @@ export class AlgoliaSearchService {
     }
 
     public static getSearchIndex<ThrowOnError extends boolean = true>(options: Options<GetSearchIndexData, ThrowOnError>) {
-        return (options.client ?? _heyApiClient).get<GetSearchIndexResponse, unknown, ThrowOnError>({
+        return (options.client ?? client).get<GetSearchIndexResponses, GetSearchIndexErrors, ThrowOnError>({
             security: [
                 {
                     scheme: 'bearer',
@@ -115,7 +116,7 @@ export class AlgoliaSearchService {
     }
 
     public static postBuildSearchIndex<ThrowOnError extends boolean = true>(options?: Options<PostBuildSearchIndexData, ThrowOnError>) {
-        return (options?.client ?? _heyApiClient).post<PostBuildSearchIndexResponse, unknown, ThrowOnError>({
+        return (options?.client ?? client).post<PostBuildSearchIndexResponses, PostBuildSearchIndexErrors, ThrowOnError>({
             security: [
                 {
                     scheme: 'bearer',
@@ -130,5 +131,4 @@ export class AlgoliaSearchService {
             }
         });
     }
-    
-}
+}

src/Umbraco.Cms.Integrations.Search.Algolia/Client/generated/types.gen.ts

@@ -1,5 +1,9 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
+export type ClientOptions = {
+    baseUrl: 'http://localhost:28157' | (string & {});
+};
+
 export type ContentTypeDtoModel = {
     id: number;
     icon: string;
@@ -39,6 +43,15 @@ export type NotificationHeaderModel = {
     type: EventMessageTypeModel;
 };
 
+export type ProblemDetails = {
+    type?: string | null;
+    title?: string | null;
+    status?: number | null;
+    detail?: string | null;
+    instance?: string | null;
+    [key: string]: unknown | string | null | string | null | number | null | string | null | string | null | undefined;
+};
+
 export type ResponseModel = {
     itemsCount: number;
     pagesCount: number;
@@ -48,7 +61,7 @@ export type ResponseModel = {
     }>;
 };
 
-export type ResultModelReadable = {
+export type ResultModel = {
     success: boolean;
     error: string;
     readonly failure: boolean;
@@ -119,8 +132,14 @@ export type GetIndicesErrors = {
      * The resource is protected and requires an authentication token
      */
     401: unknown;
+    /**
+     * Internal Server Error
+     */
+    500: ProblemDetails;
 };
 
+export type GetIndicesError = GetIndicesErrors[keyof GetIndicesErrors];
+
 export type GetIndicesResponses = {
     /**
      * OK
@@ -142,13 +161,19 @@ export type PostSaveIndexErrors = {
      * The resource is protected and requires an authentication token
      */
     401: unknown;
+    /**
+     * Internal Server Error
+     */
+    500: ProblemDetails;
 };
 
+export type PostSaveIndexError = PostSaveIndexErrors[keyof PostSaveIndexErrors];
+
 export type PostSaveIndexResponses = {
     /**
      * OK
      */
-    200: ResultModelReadable;
+    200: ResultModel;
 };
 
 export type PostSaveIndexResponse = PostSaveIndexResponses[keyof PostSaveIndexResponses];
@@ -173,7 +198,7 @@ export type DeleteSearchIndexResponses = {
     /**
      * OK
      */
-    200: ResultModelReadable;
+    200: ResultModel;
 };
 
 export type DeleteSearchIndexResponse = DeleteSearchIndexResponses[keyof DeleteSearchIndexResponses];
@@ -248,11 +273,7 @@ export type PostBuildSearchIndexResponses = {
     /**
      * OK
      */
-    200: ResultModelReadable;
+    200: ResultModel;
 };
 
 export type PostBuildSearchIndexResponse = PostBuildSearchIndexResponses[keyof PostBuildSearchIndexResponses];
-
-export type ClientOptions = {
-    baseUrl: 'http://localhost:58030' | (string & {});
-};

src/Umbraco.Cms.Integrations.Search.Algolia/Client/openapi-ts.config.js

@@ -4,7 +4,7 @@ export default defineConfig({
     logs: {
         level: 'debug',
     },
-    input: 'http://localhost:58030/umbraco/swagger/algolia-search-management/swagger.json',
+    input: 'http://localhost:28157/umbraco/swagger/algolia-search-management/swagger.json',
     output: {
         path: 'generated',
     },