@equinor/fusion-framework-module-services 2.2.0 → 2.3.1

package/src/bookmarks/favorites/post/generate-endpoint.ts

@@ -0,0 +1,18 @@
+import { ApiVersions, PostBookmarkFavoriteArgs } from './types';
+
+/**
+ * Method for generating endpoint for getting bookmark by id
+ */
+export const generateEndpoint = <TVersion extends ApiVersions>(
+    version: TVersion,
+    _args: PostBookmarkFavoriteArgs<TVersion>
+) => {
+    switch (version) {
+        case 'v1':
+        default: {
+            const params = new URLSearchParams();
+            params.append('api-version', version);
+            return `/persons/me/bookmarks/favorites?${String(params)}`;
+        }
+    }
+};

package/src/bookmarks/favorites/post/generate-parameters.ts

@@ -0,0 +1,28 @@
+import { ClientRequestInit, IHttpClient } from '@equinor/fusion-framework-module-http/client';
+import { ApiClientArguments } from '../..';
+import { generateEndpoint } from './generate-endpoint';
+import { ApiVersions, PostBookmarkFavoriteArgs } from './types';
+
+/** function for creating http client arguments  */
+export const generateParameters = <
+    TResult,
+    TVersion extends ApiVersions,
+    TClient extends IHttpClient = IHttpClient
+>(
+    version: TVersion,
+    args: PostBookmarkFavoriteArgs<TVersion>,
+    init?: ClientRequestInit<TClient, TResult>
+): ApiClientArguments<TClient, TResult> => {
+    const path = generateEndpoint(version, args);
+
+    const headers = new Headers();
+    headers.append('content-type', 'application/json');
+
+    const requestParams: ClientRequestInit<TClient, TResult> = Object.assign(
+        {},
+        { method: 'post', body: JSON.stringify(args), headers: headers },
+        init
+    );
+
+    return [path, requestParams];
+};

package/src/bookmarks/favorites/post/index.ts

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

package/src/bookmarks/favorites/post/types.ts

@@ -0,0 +1,35 @@
+import { IHttpClient } from '@equinor/fusion-framework-module-http';
+import { ClientRequestInit } from '@equinor/fusion-framework-module-http/client';
+import { ClientMethod } from '../..';
+
+export type PostBookmarkFavoriteResult<TVersion extends ApiVersions> =
+    PostBookmarksFavoriteVersions[TVersion]['result'];
+
+export type PostBookmarkFavoriteArgs<TVersion extends ApiVersions> =
+    PostBookmarksFavoriteVersions[TVersion]['args'];
+
+export type PostBookmarksFavoriteResult<
+    TVersion extends ApiVersions,
+    TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>,
+    TResult = PostBookmarkFavoriteResult<TVersion>
+> = ClientMethod<TResult>[TMethod];
+
+export type PostBookmarkFavoriteFn<
+    TVersion extends ApiVersions,
+    TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>,
+    TClient extends IHttpClient = IHttpClient,
+    TResult = PostBookmarkFavoriteResult<TVersion>
+> = (
+    args: PostBookmarkFavoriteArgs<TVersion>,
+    init?: ClientRequestInit<TClient, TResult>
+) => PostBookmarksFavoriteResult<TVersion, TMethod, TResult>;
+
+export interface PostBookmarksFavoriteArgsV1 {
+    bookmarkId: string;
+}
+
+export type PostBookmarksFavoriteVersions = {
+    ['v1']: { args: PostBookmarksFavoriteArgsV1; result: Response };
+};
+
+export type ApiVersions = keyof PostBookmarksFavoriteVersions;

package/src/bookmarks/patch/client.ts

@@ -1,7 +1,7 @@
 import { ClientRequestInit, IHttpClient } from '@equinor/fusion-framework-module-http/client';
 import { ClientMethod } from '../..';
 import { generateParameters } from './generate-parameters';
-import { ApiVersions, PutBookmarkArgs, PutBookmarkResult, PutBookmarksResult } from './types';
+import { ApiVersions, PatchBookmarkArgs, PatchBookmarkResult, PatchBookmarksResult } from './types';
 
 /**
  * Method for updating bookmark
@@ -9,7 +9,7 @@ import { ApiVersions, PutBookmarkArgs, PutBookmarkResult, PutBookmarksResult } f
  * @param version - version of API to call
  * @param method - client method to call
  */
-export const putBookmark =
+export const patchBookmark =
     <
         TClient extends IHttpClient = IHttpClient,
         TVersion extends ApiVersions = ApiVersions,
@@ -19,12 +19,12 @@ export const putBookmark =
         version: TVersion,
         method: TMethod = 'json' as TMethod
     ) =>
-    <TResult = PutBookmarkResult<TVersion, unknown>>(
-        args: PutBookmarkArgs<TVersion>,
+    <TResult = PatchBookmarkResult<TVersion, unknown>>(
+        args: PatchBookmarkArgs<TVersion>,
         init?: ClientRequestInit<TClient, TResult>
-    ): PutBookmarksResult<TVersion, TMethod, unknown, TResult> =>
+    ): PatchBookmarksResult<TVersion, TMethod, unknown, TResult> =>
         client[method](
             ...generateParameters<TResult, TVersion, TClient>(version, args, init)
-        ) as PutBookmarksResult<TVersion, TMethod, unknown, TResult>;
+        ) as PatchBookmarksResult<TVersion, TMethod, unknown, TResult>;
 
-export default putBookmark;
+export default patchBookmark;

package/src/bookmarks/patch/generate-endpoint.ts

@@ -1,11 +1,11 @@
-import { ApiVersions, PutBookmarkArgs } from './types';
+import { ApiVersions, PatchBookmarkArgs } from './types';
 
 /**
  * Method for generating endpoint for getting bookmark by id
  */
 export const generateEndpoint = <TVersion extends ApiVersions>(
     version: TVersion,
-    _args: PutBookmarkArgs<TVersion>
+    _args: PatchBookmarkArgs<TVersion>
 ) => {
     switch (version) {
         case 'v1':

package/src/bookmarks/patch/generate-parameters.ts

@@ -1,7 +1,7 @@
 import { ClientRequestInit, IHttpClient } from '@equinor/fusion-framework-module-http/client';
 import { ApiClientArguments } from '../..';
 import { generateEndpoint } from './generate-endpoint';
-import { ApiVersions, PutBookmarkArgs } from './types';
+import { ApiVersions, PatchBookmarkArgs } from './types';
 
 /** function for creating http client arguments  */
 export const generateParameters = <
@@ -10,7 +10,7 @@ export const generateParameters = <
     TClient extends IHttpClient = IHttpClient
 >(
     version: TVersion,
-    args: PutBookmarkArgs<TVersion>,
+    args: PatchBookmarkArgs<TVersion>,
     init?: ClientRequestInit<TClient, TResult>
 ): ApiClientArguments<TClient, TResult> => {
     const path = generateEndpoint(version, args);

package/src/bookmarks/patch/index.ts

@@ -1,6 +1,6 @@
 export * from './types';
 
-export { putBookmark, default } from './client';
+export { patchBookmark, default } from './client';
 
-export { generateEndpoint as generatePutEndpoint } from './generate-endpoint';
-export { generateParameters as generatePutParameters } from './generate-parameters';
+export { generateEndpoint as generatePatchEndpoint } from './generate-endpoint';
+export { generateParameters as generatePatchParameters } from './generate-parameters';

package/src/bookmarks/patch/types.ts

@@ -4,42 +4,42 @@ import { ClientMethod } from '../..';
 import { ApiBookmarkEntityV1 } from '../api-models';
 import { PostBookmarksArgsV1 } from '../post';
 
-export type PutBookmarkResult<
+export type PatchBookmarkResult<
     TVersion extends ApiVersions,
     TPayload
-> = PutBookmarksVersions<TPayload>[TVersion]['result'];
+> = PatchBookmarksVersions<TPayload>[TVersion]['result'];
 
 /** Returns args for PutBookmark based on version*/
-export type PutBookmarkArgs<
+export type PatchBookmarkArgs<
     TVersion extends ApiVersions,
     TPayload = unknown
-> = PutBookmarksVersions<TPayload>[TVersion]['args'];
+> = PatchBookmarksVersions<TPayload>[TVersion]['args'];
 
 /**Gets result type for PutBookmark call based on version and method */
-export type PutBookmarksResult<
+export type PatchBookmarksResult<
     TVersion extends ApiVersions,
     TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>,
     TPayload = unknown,
-    TResult = PutBookmarkResult<TVersion, TPayload>
+    TResult = PatchBookmarkResult<TVersion, TPayload>
 > = ClientMethod<TResult>[TMethod];
 
-export type PutBookmarkFn<
+export type PatchBookmarkFn<
     TVersion extends ApiVersions,
     TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>,
     TClient extends IHttpClient = IHttpClient,
     TPayload = unknown,
-    TResult = PutBookmarkResult<TVersion, TPayload>
+    TResult = PatchBookmarkResult<TVersion, TPayload>
 > = (
-    args: PutBookmarkArgs<TVersion>,
+    args: PatchBookmarkArgs<TVersion>,
     init?: ClientRequestInit<TClient, TResult>
-) => PutBookmarksResult<TVersion, TMethod, TPayload, TResult>;
+) => PatchBookmarksResult<TVersion, TMethod, TPayload, TResult>;
 
-export interface PutBookmarksArgsV1<T = unknown> extends PostBookmarksArgsV1<T> {
+export interface PatchBookmarksArgsV1<T = unknown> extends Partial<PostBookmarksArgsV1<T>> {
     id: string;
 }
 
-export type PutBookmarksVersions<TPayload = unknown> = {
-    ['v1']: { args: PutBookmarksArgsV1<TPayload>; result: ApiBookmarkEntityV1<TPayload> };
+export type PatchBookmarksVersions<TPayload = unknown> = {
+    ['v1']: { args: PatchBookmarksArgsV1<TPayload>; result: ApiBookmarkEntityV1<TPayload> };
 };
 
-export type ApiVersions = keyof PutBookmarksVersions<unknown>;
+export type ApiVersions = keyof PatchBookmarksVersions<unknown>;