@equinor/fusion-framework-module-services 7.1.7 → 7.2.0

package/dist/types/people/api-models.d.ts

@@ -32,3 +32,43 @@ export type ApiPersonMap = {
     [ApiVersion.v4]: ApiPerson_v4;
 };
 export type ApiPerson<T extends keyof typeof ApiVersion | ApiVersion> = T extends ApiVersion ? ApiPersonMap[T] : T extends keyof typeof ApiVersion ? ApiPersonMap[(typeof ApiVersion)[T]] : unknown;
+export type ApiSuggestionPerson = {
+    accountType?: 'Unknown' | 'Employee' | 'Consultant' | 'Enterprise' | 'EnterpriseExternal' | 'External' | 'Local' | 'TemporaryEmployee' | 'System' | 'Admin' | 'MeetingRoom';
+    jobTitle?: string;
+    department?: string;
+    fullDepartment?: string;
+    employeeNumber?: string;
+    managerAzureUniqueId?: string;
+    upn?: string;
+    mobilePhone?: string;
+};
+export type ApiSuggestionApplication = {
+    applicationId: string;
+    applicationName?: string;
+    servicePrincipalType: 'Application' | 'ManagedIdentity' | 'ServicePrincipal';
+};
+export type ApiSuggestionValue = {
+    azureUniqueId: string;
+    name?: string;
+    accountType: 'Person' | 'SystemAccount' | 'Unknown';
+    accountLabel: string;
+    person?: ApiSuggestionPerson;
+    application?: ApiSuggestionApplication;
+    avatarColor: string;
+    avatarUrl: string;
+    isExpired: boolean;
+};
+export type ApiSuggestions = {
+    totalCount: number;
+    count: number;
+    '@nextPage': string | null;
+    value: Array<ApiSuggestionValue>;
+};
+export type ApiResolveItem = {
+    success: boolean;
+    statusCode: number;
+    errorMessage: string | null;
+    identifier: string;
+    account: ApiSuggestionValue | null;
+};
+export type ApiResolved = Array<ApiResolveItem>;

package/dist/types/people/client.d.ts

@@ -4,6 +4,8 @@ import { ApiVersion } from './static';
 import { type ApiResponse as PersonDetailApiResponse, type ApiResult as PersonDetailResult, type SupportedApiVersion as PersonDetailSupportedApiVersion, type ApiRequestArgs as PersonDetailApiRequestArgs } from './person-details';
 import { type ApiResponse as PersonQueryApiResponse, type ApiResult as PersonQueryResult, type SupportedApiVersion as PersonQuerySupportedApiVersion, type ApiRequestArgs as PersonQueryApiRequestArgs } from './query';
 import { type ApiResponse as PersonPhotoApiResponse, type ApiResult as PersonPhotoResult, type SupportedApiVersion as PersonPhotoSupportedApiVersion, type ApiRequestArgs as PersonPhotoApiRequestArgs } from './person-photo';
+import { type ApiResponse as PersonSuggestApiResponse, type ApiResult as PersonSuggestResult } from './suggest';
+import { type ApiResponse as PersonResolveApiResponse, type ApiResult as PersonResolveResult } from './resolve';
 export declare class PeopleApiClient<TClient extends IHttpClient = IHttpClient> {
     protected _client: TClient;
     get Version(): typeof ApiVersion;
@@ -20,5 +22,13 @@ export declare class PeopleApiClient<TClient extends IHttpClient = IHttpClient>
      * Photo person service
      */
     photo<TVersion extends PersonPhotoSupportedApiVersion, TArgs extends PersonPhotoApiRequestArgs<TVersion>, TResult extends PersonPhotoApiResponse<TVersion> = PersonPhotoApiResponse<TVersion>, TMethod extends keyof ClientDataMethod = keyof ClientDataMethod>(version: TVersion, method: TMethod, args: TArgs, init?: ClientRequestInit<TClient, TResult>): PersonPhotoResult<TMethod>;
+    /**
+     * Suggest person service
+     */
+    suggest<TResult = PersonSuggestApiResponse, TMethod extends keyof ClientMethod<TResult> = keyof ClientMethod<TResult>>(method: TMethod, init?: ClientRequestInit<TClient, TResult>): PersonSuggestResult<TMethod, TResult>;
+    /**
+     * Resolve person service
+     */
+    resolve<TResult = PersonResolveApiResponse, TMethod extends keyof ClientMethod<TResult> = keyof ClientMethod<TResult>>(method: TMethod, init?: ClientRequestInit<TClient, TResult>): PersonResolveResult<TMethod, TResult>;
 }
 export default PeopleApiClient;

package/dist/types/people/resolve/client.d.ts

@@ -0,0 +1,15 @@
+import type { ClientRequestInit, IHttpClient } from '@equinor/fusion-framework-module-http/client';
+import type { ClientMethod } from '../../types';
+import type { ApiResponse, ApiResult } from './types';
+/**
+ * Factory for creating a typed client function for the people resolve endpoint.
+ *
+ * The returned function will use the provided HTTP client and method to call the
+ * resolve API for people identifiers, using parameters generated by
+ * {@link generateParameters}.
+ *
+ * @param client - HTTP client used to execute the request
+ * @param method - HTTP client method to invoke (for example, {@code 'json'})
+ */
+export declare const client: <TMethod extends keyof ClientMethod = keyof ClientMethod, TClient extends IHttpClient = IHttpClient>(client: TClient, method?: TMethod) => <T = ApiResponse>(init?: ClientRequestInit<TClient, T>) => ApiResult<TMethod, T>;
+export default client;

package/dist/types/people/resolve/generate-endpoint.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Method for generating endpoint for resolving people identifiers
+ */
+export declare const generateEndpoint: () => string;

package/dist/types/people/resolve/generate-parameters.d.ts

@@ -0,0 +1,5 @@
+import type { ClientRequestInit, IHttpClient } from '@equinor/fusion-framework-module-http/client';
+import type { ApiClientArguments } from '../../types';
+/** function for creating http client arguments  */
+export declare const generateParameters: <TResult, TClient extends IHttpClient = IHttpClient>(init?: ClientRequestInit<TClient, TResult>) => ApiClientArguments<TClient, TResult>;
+export default generateParameters;

package/dist/types/people/resolve/index.d.ts

@@ -0,0 +1,4 @@
+export { client, default } from './client';
+export { generateEndpoint } from './generate-endpoint';
+export { generateParameters } from './generate-parameters';
+export * from './types';

package/dist/types/people/resolve/types.d.ts

@@ -0,0 +1,4 @@
+import type { ApiResolved } from '../api-models';
+import type { ClientMethod } from '../../types';
+export type ApiResponse = ApiResolved;
+export type ApiResult<TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>, TResult = ApiResponse> = ClientMethod<TResult>[TMethod];

package/dist/types/people/suggest/client.d.ts

@@ -0,0 +1,10 @@
+import type { ClientRequestInit, IHttpClient } from '@equinor/fusion-framework-module-http/client';
+import type { ClientMethod } from '../../types';
+import type { ApiResponse, ApiResult } from './types';
+/**
+ * Client factory for calling the people suggest endpoint.
+ * @param client - HTTP client used to perform the request
+ * @param method - HTTP client method to call (for example, 'json')
+ */
+export declare const client: <TMethod extends keyof ClientMethod = keyof ClientMethod, TClient extends IHttpClient = IHttpClient>(client: TClient, method?: TMethod) => <T = ApiResponse>(init?: ClientRequestInit<TClient, T>) => ApiResult<TMethod, T>;
+export default client;

package/dist/types/people/suggest/generate-endpoint.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Method for generating endpoint for getting people suggestions
+ */
+export declare const generateEndpoint: () => string;

package/dist/types/people/suggest/generate-parameters.d.ts

@@ -0,0 +1,5 @@
+import type { ClientRequestInit, IHttpClient } from '@equinor/fusion-framework-module-http/client';
+import type { ApiClientArguments } from '../../types';
+/** function for creating http client arguments  */
+export declare const generateParameters: <TResult, TClient extends IHttpClient = IHttpClient>(init?: ClientRequestInit<TClient, TResult>) => ApiClientArguments<TClient, TResult>;
+export default generateParameters;

package/dist/types/people/suggest/index.d.ts

@@ -0,0 +1,4 @@
+export { client, default } from './client';
+export { generateEndpoint } from './generate-endpoint';
+export { generateParameters } from './generate-parameters';
+export * from './types';

package/dist/types/people/suggest/types.d.ts

@@ -0,0 +1,4 @@
+import type { ApiSuggestions } from '../api-models';
+import type { ClientMethod } from '../../types';
+export type ApiResponse = ApiSuggestions;
+export type ApiResult<TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>, TResult = ApiResponse> = ClientMethod<TResult>[TMethod];

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "7.1.7";
+export declare const version = "7.2.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/fusion-framework-module-services",
-  "version": "7.1.7",
+  "version": "7.2.0",
   "description": "",
   "sideEffects": false,
   "main": "dist/esm/index.js",
@@ -54,6 +54,14 @@
       "import": "./dist/esm/people/query/index.js",
       "types": "./dist/types/people/query/index.d.ts"
     },
+    "./people/suggest": {
+      "import": "./dist/esm/people/suggest/index.js",
+      "types": "./dist/types/people/suggest/index.d.ts"
+    },
+    "./people/resolve": {
+      "import": "./dist/esm/people/resolve/index.js",
+      "types": "./dist/types/people/resolve/index.d.ts"
+    },
     "./people/photo": {
       "import": "./dist/esm/people/person-photo/index.js",
       "types": "./dist/types/people/person-photo/index.d.ts"
@@ -99,6 +107,12 @@
       "people/get": [
         "./dist/types/people/person-details/index.d.ts"
       ],
+      "people/suggest": [
+        "./dist/types/people/suggest/index.d.ts"
+      ],
+      "people/resolve": [
+        "./dist/types/people/resolve/index.d.ts"
+      ],
       "people/query": [
         "./dist/types/people/query/index.d.ts"
       ],
@@ -130,9 +144,9 @@
     "msw": "^2.7.3",
     "typescript": "^5.8.2",
     "vitest": "^3.2.4",
-    "@equinor/fusion-framework-module-http": "^7.0.6",
-    "@equinor/fusion-framework-module-service-discovery": "^9.0.5",
-    "@equinor/fusion-framework-module": "^5.0.5"
+    "@equinor/fusion-framework-module": "^5.0.5",
+    "@equinor/fusion-framework-module-http": "^7.0.7",
+    "@equinor/fusion-framework-module-service-discovery": "^9.1.0"
   },
   "peerDependencies": {
     "odata-query": "^8.0.4",

package/src/people/api-models.ts

@@ -50,3 +50,60 @@ export type ApiPerson<T extends keyof typeof ApiVersion | ApiVersion> = T extend
   : T extends keyof typeof ApiVersion
     ? ApiPersonMap[(typeof ApiVersion)[T]]
     : unknown;
+
+export type ApiSuggestionPerson = {
+  accountType?:
+    | 'Unknown'
+    | 'Employee'
+    | 'Consultant'
+    | 'Enterprise'
+    | 'EnterpriseExternal'
+    | 'External'
+    | 'Local'
+    | 'TemporaryEmployee'
+    | 'System'
+    | 'Admin'
+    | 'MeetingRoom';
+  jobTitle?: string;
+  department?: string;
+  fullDepartment?: string;
+  employeeNumber?: string;
+  managerAzureUniqueId?: string;
+  upn?: string;
+  mobilePhone?: string;
+};
+
+export type ApiSuggestionApplication = {
+  applicationId: string;
+  applicationName?: string;
+  servicePrincipalType: 'Application' | 'ManagedIdentity' | 'ServicePrincipal';
+};
+
+export type ApiSuggestionValue = {
+  azureUniqueId: string;
+  name?: string;
+  accountType: 'Person' | 'SystemAccount' | 'Unknown';
+  accountLabel: string;
+  person?: ApiSuggestionPerson;
+  application?: ApiSuggestionApplication;
+  avatarColor: string;
+  avatarUrl: string;
+  isExpired: boolean;
+};
+
+export type ApiSuggestions = {
+  totalCount: number;
+  count: number;
+  '@nextPage': string | null;
+  value: Array<ApiSuggestionValue>;
+};
+
+export type ApiResolveItem = {
+  success: boolean;
+  statusCode: number;
+  errorMessage: string | null;
+  identifier: string;
+  account: ApiSuggestionValue | null;
+};
+
+export type ApiResolved = Array<ApiResolveItem>;

package/src/people/client.ts

@@ -27,6 +27,18 @@ import {
   type ApiRequestArgs as PersonPhotoApiRequestArgs,
 } from './person-photo';
 
+import {
+  client as personSuggestClient,
+  type ApiResponse as PersonSuggestApiResponse,
+  type ApiResult as PersonSuggestResult,
+} from './suggest';
+
+import {
+  client as personResolveClient,
+  type ApiResponse as PersonResolveApiResponse,
+  type ApiResult as PersonResolveResult,
+} from './resolve';
+
 export class PeopleApiClient<
   // TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>,
   TClient extends IHttpClient = IHttpClient,
@@ -90,16 +102,34 @@ export class PeopleApiClient<
     const fn = personPhotoClient<TVersion, TMethod, TClient>(this._client, version, method);
     return fn<TResult>(args, init);
   }
-}
 
-// const oo = new PeopleApiClient(null).get('v4', 'fetch', { azureId: '123' });
-// const o2 = await new PeopleApiClient(null).get('v4', 'fetch', {
-//     azureId: '123',
-//     expand: ['roles'],
-// });
-// const o3 = await new PeopleApiClient(null).get('v4', 'fetch', {
-//     azureId: '123',
-//     expand: ['companies', 'roles'],
-// });
+  /**
+   * Suggest person service
+   */
+  public suggest<
+    TResult = PersonSuggestApiResponse,
+    TMethod extends keyof ClientMethod<TResult> = keyof ClientMethod<TResult>,
+  >(
+    method: TMethod,
+    init?: ClientRequestInit<TClient, TResult>,
+  ): PersonSuggestResult<TMethod, TResult> {
+    const fn = personSuggestClient<TMethod, TClient>(this._client, method);
+    return fn<TResult>(init);
+  }
+
+  /**
+   * Resolve person service
+   */
+  public resolve<
+    TResult = PersonResolveApiResponse,
+    TMethod extends keyof ClientMethod<TResult> = keyof ClientMethod<TResult>,
+  >(
+    method: TMethod,
+    init?: ClientRequestInit<TClient, TResult>,
+  ): PersonResolveResult<TMethod, TResult> {
+    const fn = personResolveClient<TMethod, TClient>(this._client, method);
+    return fn<TResult>(init);
+  }
+}
 
 export default PeopleApiClient;

package/src/people/resolve/client.ts

@@ -0,0 +1,29 @@
+import type { ClientRequestInit, IHttpClient } from '@equinor/fusion-framework-module-http/client';
+
+import { generateParameters } from './generate-parameters';
+
+import type { ClientMethod } from '../../types';
+import type { ApiResponse, ApiResult } from './types';
+
+/**
+ * Factory for creating a typed client function for the people resolve endpoint.
+ *
+ * The returned function will use the provided HTTP client and method to call the
+ * resolve API for people identifiers, using parameters generated by
+ * {@link generateParameters}.
+ *
+ * @param client - HTTP client used to execute the request
+ * @param method - HTTP client method to invoke (for example, {@code 'json'})
+ */
+export const client =
+  <
+    TMethod extends keyof ClientMethod = keyof ClientMethod,
+    TClient extends IHttpClient = IHttpClient,
+  >(
+    client: TClient,
+    method: TMethod = 'json' as TMethod,
+  ) =>
+  <T = ApiResponse>(init?: ClientRequestInit<TClient, T>): ApiResult<TMethod, T> =>
+    client[method](...generateParameters<T, TClient>(init)) as ApiResult<TMethod, T>;
+
+export default client;

package/src/people/resolve/generate-endpoint.ts

@@ -0,0 +1,6 @@
+/**
+ * Method for generating endpoint for resolving people identifiers
+ */
+export const generateEndpoint = () => {
+  return '/people-picker/resolve';
+};

package/src/people/resolve/generate-parameters.ts

@@ -0,0 +1,15 @@
+import type { ClientRequestInit, IHttpClient } from '@equinor/fusion-framework-module-http/client';
+
+import { generateEndpoint } from './generate-endpoint';
+
+import type { ApiClientArguments } from '../../types';
+
+/** function for creating http client arguments  */
+export const generateParameters = <TResult, TClient extends IHttpClient = IHttpClient>(
+  init?: ClientRequestInit<TClient, TResult>,
+): ApiClientArguments<TClient, TResult> => {
+  const path = generateEndpoint();
+  return [path, init];
+};
+
+export default generateParameters;

package/src/people/resolve/index.ts

@@ -0,0 +1,6 @@
+export { client, default } from './client';
+
+export { generateEndpoint } from './generate-endpoint';
+export { generateParameters } from './generate-parameters';
+
+export * from './types';

package/src/people/resolve/types.ts

@@ -0,0 +1,9 @@
+import type { ApiResolved } from '../api-models';
+import type { ClientMethod } from '../../types';
+
+export type ApiResponse = ApiResolved;
+
+export type ApiResult<
+  TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>,
+  TResult = ApiResponse,
+> = ClientMethod<TResult>[TMethod];

package/src/people/suggest/client.ts

@@ -0,0 +1,24 @@
+import type { ClientRequestInit, IHttpClient } from '@equinor/fusion-framework-module-http/client';
+
+import { generateParameters } from './generate-parameters';
+
+import type { ClientMethod } from '../../types';
+import type { ApiResponse, ApiResult } from './types';
+
+/**
+ * Client factory for calling the people suggest endpoint.
+ * @param client - HTTP client used to perform the request
+ * @param method - HTTP client method to call (for example, 'json')
+ */
+export const client =
+  <
+    TMethod extends keyof ClientMethod = keyof ClientMethod,
+    TClient extends IHttpClient = IHttpClient,
+  >(
+    client: TClient,
+    method: TMethod = 'json' as TMethod,
+  ) =>
+  <T = ApiResponse>(init?: ClientRequestInit<TClient, T>): ApiResult<TMethod, T> =>
+    client[method](...generateParameters<T, TClient>(init)) as ApiResult<TMethod, T>;
+
+export default client;

package/src/people/suggest/generate-endpoint.ts

@@ -0,0 +1,6 @@
+/**
+ * Method for generating endpoint for getting people suggestions
+ */
+export const generateEndpoint = () => {
+  return '/people-picker/suggestions';
+};

package/src/people/suggest/generate-parameters.ts

@@ -0,0 +1,15 @@
+import type { ClientRequestInit, IHttpClient } from '@equinor/fusion-framework-module-http/client';
+
+import { generateEndpoint } from './generate-endpoint';
+
+import type { ApiClientArguments } from '../../types';
+
+/** function for creating http client arguments  */
+export const generateParameters = <TResult, TClient extends IHttpClient = IHttpClient>(
+  init?: ClientRequestInit<TClient, TResult>,
+): ApiClientArguments<TClient, TResult> => {
+  const path = generateEndpoint();
+  return [path, init];
+};
+
+export default generateParameters;

package/src/people/suggest/index.ts

@@ -0,0 +1,6 @@
+export { client, default } from './client';
+
+export { generateEndpoint } from './generate-endpoint';
+export { generateParameters } from './generate-parameters';
+
+export * from './types';

package/src/people/suggest/types.ts

@@ -0,0 +1,9 @@
+import type { ApiSuggestions } from '../api-models';
+import type { ClientMethod } from '../../types';
+
+export type ApiResponse = ApiSuggestions;
+
+export type ApiResult<
+  TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>,
+  TResult = ApiResponse,
+> = ClientMethod<TResult>[TMethod];

package/src/version.ts

@@ -1,2 +1,2 @@
 // Generated by genversion.
-export const version = '7.1.7';
+export const version = '7.2.0';