@equinor/fusion-framework-module-services 0.3.2 → 0.5.0

package/dist/types/bookmarks/post/types.d.ts

@@ -0,0 +1,29 @@
+import { IHttpClient } from '@equinor/fusion-framework-module-http';
+import { ClientRequestInit } from '@equinor/fusion-framework-module-services/../../module-http/src/lib/client';
+import { ClientMethod } from '../..';
+import { ApiBookmarkEntityV1 } from '../api-models';
+export declare type PostBookmarkResult<TVersion extends ApiVersions, TPayload> = PostBookmarksVersions<TPayload>[TVersion]['result'];
+export declare type PostBookmarkArgs<TVersion extends ApiVersions, TPayload = unknown> = PostBookmarksVersions<TPayload>[TVersion]['args'];
+export declare type PostBookmarksResult<TVersion extends ApiVersions, TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>, TPayload = unknown, TResult = PostBookmarkResult<TVersion, TPayload>> = ClientMethod<TResult>[TMethod];
+export declare type PostBookmarkFn<TVersion extends ApiVersions, TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>, TClient extends IHttpClient = IHttpClient, TPayload = unknown, TResult = PostBookmarkResult<TVersion, TPayload>> = (args: PostBookmarkArgs<TVersion>, init?: ClientRequestInit<TClient, TResult>) => PostBookmarksResult<TVersion, TMethod, TPayload, TResult>;
+declare type PostBookmarksArgsV1<T = unknown> = {
+    name: string;
+    description?: string;
+    isShared: boolean;
+    appKey: string;
+    contextId?: string;
+    payload: T;
+    sourceSystem?: {
+        identifier?: string;
+        name?: string;
+        subSystem?: string;
+    };
+};
+export declare type PostBookmarksVersions<TPayload = unknown> = {
+    ['v1']: {
+        args: PostBookmarksArgsV1<TPayload>;
+        result: ApiBookmarkEntityV1<TPayload>;
+    };
+};
+export declare type ApiVersions = keyof PostBookmarksVersions<unknown>;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@equinor/fusion-framework-module-services",
-    "version": "0.3.2",
+    "version": "0.5.0",
     "description": "",
     "sideEffects": false,
     "main": "dist/esm/index.js",
@@ -49,12 +49,12 @@
     },
     "devDependencies": {
         "@equinor/fusion-framework-module": "^1.2.6",
-        "@equinor/fusion-framework-module-http": "^2.0.14",
-        "@equinor/fusion-framework-module-service-discovery": "^3.0.6"
+        "@equinor/fusion-framework-module-http": "^2.1.0",
+        "@equinor/fusion-framework-module-service-discovery": "^3.0.7"
     },
     "peerDependencies": {
         "@equinor/fusion-framework-module": "^1.2.2",
         "odata-query": "^7.0.3"
     },
-    "gitHead": "2ad4d827ff390bbc3e45c2962598df918457f6e6"
+    "gitHead": "b0bada58a93067d4f6adfa7f3e47c864c22c5bc9"
 }

package/src/bookmarks/client.ts

@@ -1,8 +1,12 @@
 import { IHttpClient } from '@equinor/fusion-framework-module-http';
 
 import { ClientMethod } from '@equinor/fusion-framework-module-services/context';
+import deleteBookmark from './delete/client';
+import { DeleteBookmarkResult, DeleteBookmarksFn, DeleteBookmarksResult } from './delete/types';
 import getBookmark from './get/client';
 import { ApiVersions, GetBookmarkResult, GetBookmarksFn, GetBookmarksResult } from './get/types';
+import { PostBookmarkResult, PostBookmarkFn, PostBookmarksResult } from './post/types';
+import postBookmark from './post/client';
 
 export class BookmarksApiClient<
     TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>,
@@ -22,6 +26,26 @@ export class BookmarksApiClient<
         const fn = getBookmark<TVersion, TMethod, TClient>(this._client, version, this._method);
         return fn<TResult>(...args);
     }
+
+    /**
+     * Create a new bookmark
+     * @see {@link get/client}
+     */
+    public post<TVersion extends ApiVersions, TResult = PostBookmarkResult<TVersion, TPayload>>(
+        version: TVersion,
+        ...args: Parameters<PostBookmarkFn<TVersion, TMethod, TClient, TPayload, TResult>>
+    ): PostBookmarksResult<TVersion, TMethod, TPayload, TResult> {
+        const fn = postBookmark<TVersion, TMethod, TClient>(this._client, version, this._method);
+        return fn<TResult>(...args);
+    }
+
+    public delete<TVersion extends ApiVersions, TResult = DeleteBookmarkResult<TVersion>>(
+        version: TVersion,
+        ...args: Parameters<DeleteBookmarksFn<TVersion, TMethod, TClient, TResult>>
+    ): DeleteBookmarksResult<TVersion, TMethod, TResult> {
+        const fn = deleteBookmark(this._client, version, this._method);
+        return fn<TResult>(...args);
+    }
 }
 
 export default BookmarksApiClient;

package/src/bookmarks/delete/client.ts

@@ -0,0 +1,35 @@
+import { ClientRequestInit, IHttpClient } from '@equinor/fusion-framework-module-http/client';
+import { ClientMethod } from '../..';
+import { generateParameters } from './generate-parameters';
+import {
+    ApiVersions,
+    DeleteBookmarkArgs,
+    DeleteBookmarkResult,
+    DeleteBookmarksResult,
+} from './types';
+
+/**
+ * Method for fetching bookmark by it`s id from bookmark service
+ * @param client - client for execution of request
+ * @param version - version of API to call
+ * @param method - client method to call
+ */
+export const deleteBookmark =
+    <
+        TVersion extends ApiVersions = ApiVersions,
+        TMethod extends keyof ClientMethod = keyof ClientMethod,
+        TClient extends IHttpClient = IHttpClient
+    >(
+        client: TClient,
+        version: TVersion,
+        method: TMethod = 'json' as TMethod
+    ) =>
+    <TResult = DeleteBookmarkResult<TVersion>>(
+        args: DeleteBookmarkArgs<TVersion>,
+        init?: ClientRequestInit<TClient, TResult>
+    ): DeleteBookmarksResult<TVersion, TMethod, TResult> =>
+        client[method](
+            ...generateParameters<TResult, TVersion, TClient>(version, args, init)
+        ) as DeleteBookmarksResult<TVersion, TMethod, TResult>;
+
+export default deleteBookmark;

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

@@ -0,0 +1,24 @@
+import { ApiVersions, DeleteBookmarkArgs } from './types';
+
+/**
+ * Method for generating endpoint for deleting a bookmark.
+ */
+export const generateEndpoint = <TVersion extends ApiVersions>(
+    version: TVersion,
+    args: DeleteBookmarkArgs<TVersion>
+) => {
+    switch (version) {
+        case 'v1': {
+            const { id } = args as { id: string };
+            const params = new URLSearchParams();
+            params.append('api-version', '1.0');
+            return `/bookmarks/${id}/?${String(params)}`;
+        }
+        default: {
+            const { id } = args as { id: string };
+            const params = new URLSearchParams();
+            params.append('api-version', version);
+            return `/bookmarks/${id}/?${String(params)}`;
+        }
+    }
+};

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

@@ -0,0 +1,28 @@
+import {
+    ClientRequestInit,
+    IHttpClient,
+} from '@equinor/fusion-framework-module-services/../../module-http/src/lib/client';
+import { ApiClientArguments } from '../..';
+import { generateEndpoint } from './generate-endpoint';
+import { ApiVersions, DeleteBookmarkArgs } from './types';
+
+/** function for creating http client arguments  */
+export const generateParameters = <
+    TResult,
+    TVersion extends ApiVersions,
+    TClient extends IHttpClient = IHttpClient
+>(
+    version: TVersion,
+    args: DeleteBookmarkArgs<TVersion>,
+    init?: ClientRequestInit<TClient, TResult>
+): ApiClientArguments<TClient, TResult> => {
+    const path = generateEndpoint(version, args);
+
+    const requestParams: ClientRequestInit<TClient, TResult> = Object.assign(
+        {},
+        { method: 'Delete' },
+        init
+    );
+
+    return [path, requestParams];
+};

package/src/bookmarks/delete/index.ts

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

package/src/bookmarks/delete/types-v1.ts

@@ -0,0 +1,2 @@
+/** arguments for v1 delete bookmarks */
+export type DeleteBookmarksArgsV1 = { id: string };

package/src/bookmarks/delete/types.ts

@@ -0,0 +1,35 @@
+import { IHttpClient } from '@equinor/fusion-framework-module-http';
+import { ClientRequestInit } from '@equinor/fusion-framework-module-services/../../module-http/src/lib/client';
+import { ClientMethod } from '../..';
+import { DeleteBookmarksArgsV1 } from './types-v1';
+
+export type DeleteBookmarkResult<TVersion extends ApiVersions> =
+    DeleteBookmarksVersions[TVersion]['result'];
+
+/** Returns args for GetBookmark based on version*/
+export type DeleteBookmarkArgs<TVersion extends ApiVersions> =
+    DeleteBookmarksVersions[TVersion]['args'];
+
+/**Gets result type for GetBookmark call based on version and method */
+export type DeleteBookmarksResult<
+    TVersion extends ApiVersions,
+    TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>,
+    TResult = DeleteBookmarkResult<TVersion>
+> = ClientMethod<TResult>[TMethod];
+
+export type DeleteBookmarksFn<
+    TVersion extends ApiVersions,
+    TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>,
+    TClient extends IHttpClient = IHttpClient,
+    TResult = DeleteBookmarkResult<TVersion>
+> = (
+    args: DeleteBookmarkArgs<TVersion>,
+    init?: ClientRequestInit<TClient, TResult>
+) => DeleteBookmarksResult<TVersion, TMethod, TResult>;
+
+export type DeleteBookmarksVersions = {
+    ['v1']: { args: DeleteBookmarksArgsV1; result: undefined };
+};
+
+/**Api versions for bookmarks service */
+export type ApiVersions = keyof DeleteBookmarksVersions;

package/src/bookmarks/post/client.ts

@@ -0,0 +1,30 @@
+import { ClientRequestInit, IHttpClient } from '@equinor/fusion-framework-module-http/client';
+import { ClientMethod } from '../..';
+import { generateParameters } from './generate-parameters';
+import { ApiVersions, PostBookmarkArgs, PostBookmarkResult, PostBookmarksResult } from './types';
+
+/**
+ * Method for fetching bookmark by it`s id from bookmark service
+ * @param client - client for execution of request
+ * @param version - version of API to call
+ * @param method - client method to call
+ */
+export const postBookmark =
+    <
+        TVersion extends ApiVersions = ApiVersions,
+        TMethod extends keyof ClientMethod = keyof ClientMethod,
+        TClient extends IHttpClient = IHttpClient
+    >(
+        client: TClient,
+        version: TVersion,
+        method: TMethod = 'json' as TMethod
+    ) =>
+    <TResult = PostBookmarkResult<TVersion, unknown>>(
+        args: PostBookmarkArgs<TVersion>,
+        init?: ClientRequestInit<TClient, TResult>
+    ): PostBookmarksResult<TVersion, TMethod, unknown, TResult> =>
+        client[method](
+            ...generateParameters<TResult, TVersion, TClient>(version, args, init)
+        ) as PostBookmarksResult<TVersion, TMethod, unknown, TResult>;
+
+export default postBookmark;

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

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

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

@@ -0,0 +1,33 @@
+import {
+    ClientRequestInit,
+    IHttpClient,
+} from '@equinor/fusion-framework-module-services/../../module-http/src/lib/client';
+import { ApiClientArguments } from '../..';
+import { generateEndpoint } from './generate-endpoint';
+import { ApiVersions, PostBookmarkArgs } from './types';
+
+/** function for creating http client arguments  */
+export const generateParameters = <
+    TResult,
+    TVersion extends ApiVersions,
+    TClient extends IHttpClient = IHttpClient
+>(
+    version: TVersion,
+    args: PostBookmarkArgs<TVersion>,
+    init?: ClientRequestInit<TClient, TResult>
+): ApiClientArguments<TClient, TResult> => {
+    const path = generateEndpoint(version, args);
+    //add versions switch case later
+
+    //Not sure why this is needed, defaults to application/problem+json failing the request
+    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/post/index.ts

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

package/src/bookmarks/post/types.ts

@@ -0,0 +1,58 @@
+import { IHttpClient } from '@equinor/fusion-framework-module-http';
+import { ClientRequestInit } from '@equinor/fusion-framework-module-services/../../module-http/src/lib/client';
+import { ClientMethod } from '../..';
+import { ApiBookmarkEntityV1 } from '../api-models';
+
+export type PostBookmarkResult<
+    TVersion extends ApiVersions,
+    TPayload
+> = PostBookmarksVersions<TPayload>[TVersion]['result'];
+
+/** Returns args for GetBookmark based on version*/
+export type PostBookmarkArgs<
+    TVersion extends ApiVersions,
+    TPayload = unknown
+> = PostBookmarksVersions<TPayload>[TVersion]['args'];
+
+/**Gets result type for GetBookmark call based on version and method */
+export type PostBookmarksResult<
+    TVersion extends ApiVersions,
+    TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>,
+    TPayload = unknown,
+    TResult = PostBookmarkResult<TVersion, TPayload>
+> = ClientMethod<TResult>[TMethod];
+
+export type PostBookmarkFn<
+    TVersion extends ApiVersions,
+    TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>,
+    TClient extends IHttpClient = IHttpClient,
+    TPayload = unknown,
+    TResult = PostBookmarkResult<TVersion, TPayload>
+> = (
+    args: PostBookmarkArgs<TVersion>,
+    init?: ClientRequestInit<TClient, TResult>
+) => PostBookmarksResult<TVersion, TMethod, TPayload, TResult>;
+
+type PostBookmarksArgsV1<T = unknown> = {
+    /** Display name of the bookmark */
+    name: string;
+    description?: string;
+    /** Is the bookmark shared with others */
+    isShared: boolean;
+    /** Name of the app it belongs too, should correspond to a fusion appkey */
+    appKey: string;
+    contextId?: string;
+    /** Any JSON object to store as the bookmark payload */
+    payload: T;
+    sourceSystem?: {
+        identifier?: string;
+        name?: string;
+        subSystem?: string;
+    };
+};
+
+export type PostBookmarksVersions<TPayload = unknown> = {
+    ['v1']: { args: PostBookmarksArgsV1<TPayload>; result: ApiBookmarkEntityV1<TPayload> };
+};
+
+export type ApiVersions = keyof PostBookmarksVersions<unknown>;