@equinor/fusion-framework-module-services 5.0.0-next-663bed8344cc2ca0111705b05045173328b3104d → 5.0.0

package/src/bookmarks/get/client.ts

@@ -1,30 +0,0 @@
-import { ClientRequestInit, IHttpClient } from '@equinor/fusion-framework-module-http/client';
-import { ClientMethod } from '../..';
-import { generateParameters } from './generate-parameters';
-import { ApiVersions, GetBookmarkArgs, GetBookmarkResult, GetBookmarksResult } 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 getBookmark =
-    <
-        TVersion extends ApiVersions = ApiVersions,
-        TMethod extends keyof ClientMethod = keyof ClientMethod,
-        TClient extends IHttpClient = IHttpClient,
-    >(
-        client: TClient,
-        version: TVersion,
-        method: TMethod = 'json' as TMethod,
-    ) =>
-    <TResult = GetBookmarkResult<TVersion, unknown>>(
-        args: GetBookmarkArgs<TVersion>,
-        init?: ClientRequestInit<TClient, TResult>,
-    ): GetBookmarksResult<TVersion, TMethod, unknown, TResult> =>
-        client[method](
-            ...generateParameters<TResult, TVersion, TClient>(version, args, init),
-        ) as GetBookmarksResult<TVersion, TMethod, unknown, TResult>;
-
-export default getBookmark;

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

@@ -1,24 +0,0 @@
-import { ApiVersions, GetBookmarkArgs } from './types';
-
-/**
- * Method for generating endpoint for getting bookmark by id
- */
-export const generateEndpoint = <TVersion extends ApiVersions>(
-    version: TVersion,
-    args: GetBookmarkArgs<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/get/generate-parameters.ts

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

package/src/bookmarks/get/index.ts

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

package/src/bookmarks/get/types.ts

@@ -1,39 +0,0 @@
-import { IHttpClient } from '@equinor/fusion-framework-module-http';
-import { ClientRequestInit } from '@equinor/fusion-framework-module-http/client';
-import { ClientMethod } from '../..';
-import { ApiBookmarkEntityV1 } from '../api-models';
-
-export type GetBookmarkResult<
-    TVersion extends ApiVersions,
-    TPayload,
-> = GetBookmarksVersions<TPayload>[TVersion]['result'];
-
-/** Returns args for GetBookmark based on version*/
-export type GetBookmarkArgs<TVersion extends ApiVersions> = GetBookmarksVersions[TVersion]['args'];
-
-/**Gets result type for GetBookmark call based on version and method */
-export type GetBookmarksResult<
-    TVersion extends ApiVersions,
-    TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>,
-    TPayload = unknown,
-    TResult = GetBookmarkResult<TVersion, TPayload>,
-> = ClientMethod<TResult>[TMethod];
-
-export type GetBookmarksFn<
-    TVersion extends ApiVersions,
-    TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>,
-    TClient extends IHttpClient = IHttpClient,
-    TPayload = unknown,
-    TResult = GetBookmarkResult<TVersion, TPayload>,
-> = (
-    args: GetBookmarkArgs<TVersion>,
-    init?: ClientRequestInit<TClient, TResult>,
-) => GetBookmarksResult<TVersion, TMethod, TPayload, TResult>;
-
-type GetBookmarksArgsV1 = { id: string };
-
-export type GetBookmarksVersions<TPayload = unknown> = {
-    ['v1']: { args: GetBookmarksArgsV1; result: ApiBookmarkEntityV1<TPayload> };
-};
-
-export type ApiVersions = keyof GetBookmarksVersions<unknown>;

package/src/bookmarks/getAll/client.ts

@@ -1,30 +0,0 @@
-import { ClientRequestInit, IHttpClient } from '@equinor/fusion-framework-module-http/client';
-import { ClientMethod } from '../..';
-
-import { generateParameters } from './generate-parameters';
-import { ApiVersions, GetAllBookmarkResult, GetAllBookmarksResult } from './types';
-
-/**
- * Method for fetching all bookmarks for the current user 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 getAllBookmarks =
-    <
-        TVersion extends ApiVersions = ApiVersions,
-        TMethod extends keyof ClientMethod = keyof ClientMethod,
-        TClient extends IHttpClient = IHttpClient,
-    >(
-        client: TClient,
-        version: TVersion,
-        method: TMethod = 'json' as TMethod,
-    ) =>
-    <TResult = GetAllBookmarkResult<TVersion, unknown>>(
-        init?: ClientRequestInit<TClient, TResult>,
-    ): GetAllBookmarksResult<TVersion, TMethod, unknown, TResult> =>
-        client[method](
-            ...generateParameters<TResult, TVersion, TClient>(version, init),
-        ) as GetAllBookmarksResult<TVersion, TMethod, unknown, TResult>;
-
-export default getAllBookmarks;

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

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

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

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

package/src/bookmarks/getAll/index.ts

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

package/src/bookmarks/getAll/types.ts

@@ -1,21 +0,0 @@
-import { ApiBookmarkEntityV1 } from '../api-models';
-import { ClientMethod } from '../types';
-
-/**Gets result type for GetAllBookmark call based on version and method */
-export type GetAllBookmarksResult<
-    TVersion extends ApiVersions,
-    TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>,
-    TPayload = unknown,
-    TResult = GetAllBookmarkResult<TVersion, TPayload>,
-> = ClientMethod<TResult>[TMethod];
-
-export type GetAllBookmarkResult<
-    TVersion extends ApiVersions,
-    TPayload,
-> = GetAllBookmarksVersions<TPayload>[TVersion]['result'];
-
-export type GetAllBookmarksVersions<TPayload = unknown> = {
-    ['v1']: { result: Array<ApiBookmarkEntityV1<TPayload>> };
-};
-
-export type ApiVersions = keyof GetAllBookmarksVersions<unknown>;

package/src/bookmarks/patch/client.ts

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

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

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

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

@@ -1,28 +0,0 @@
-import { ClientRequestInit, IHttpClient } from '@equinor/fusion-framework-module-http/client';
-import { ApiClientArguments } from '../..';
-import { generateEndpoint } from './generate-endpoint';
-import { ApiVersions, PatchBookmarkArgs } from './types';
-
-/** function for creating http client arguments  */
-export const generateParameters = <
-    TResult,
-    TVersion extends ApiVersions,
-    TClient extends IHttpClient = IHttpClient,
->(
-    version: TVersion,
-    args: PatchBookmarkArgs<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: 'patch', body: JSON.stringify(args), headers: headers },
-        init,
-    );
-
-    return [path, requestParams];
-};

package/src/bookmarks/patch/index.ts

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

package/src/bookmarks/patch/types.ts

@@ -1,45 +0,0 @@
-import { IHttpClient } from '@equinor/fusion-framework-module-http';
-import { ClientRequestInit } from '@equinor/fusion-framework-module-http/client';
-import { ClientMethod } from '../..';
-import { ApiBookmarkEntityV1 } from '../api-models';
-import { PostBookmarksArgsV1 } from '../post';
-
-export type PatchBookmarkResult<
-    TVersion extends ApiVersions,
-    TPayload,
-> = PatchBookmarksVersions<TPayload>[TVersion]['result'];
-
-/** Returns args for PutBookmark based on version*/
-export type PatchBookmarkArgs<
-    TVersion extends ApiVersions,
-    TPayload = unknown,
-> = PatchBookmarksVersions<TPayload>[TVersion]['args'];
-
-/**Gets result type for PutBookmark call based on version and method */
-export type PatchBookmarksResult<
-    TVersion extends ApiVersions,
-    TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>,
-    TPayload = unknown,
-    TResult = PatchBookmarkResult<TVersion, TPayload>,
-> = ClientMethod<TResult>[TMethod];
-
-export type PatchBookmarkFn<
-    TVersion extends ApiVersions,
-    TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>,
-    TClient extends IHttpClient = IHttpClient,
-    TPayload = unknown,
-    TResult = PatchBookmarkResult<TVersion, TPayload>,
-> = (
-    args: PatchBookmarkArgs<TVersion>,
-    init?: ClientRequestInit<TClient, TResult>,
-) => PatchBookmarksResult<TVersion, TMethod, TPayload, TResult>;
-
-export interface PatchBookmarksArgsV1<T = unknown> extends Partial<PostBookmarksArgsV1<T>> {
-    id: string;
-}
-
-export type PatchBookmarksVersions<TPayload = unknown> = {
-    ['v1']: { args: PatchBookmarksArgsV1<TPayload>; result: ApiBookmarkEntityV1<TPayload> };
-};
-
-export type ApiVersions = keyof PatchBookmarksVersions<unknown>;

package/src/bookmarks/post/client.ts

@@ -1,30 +0,0 @@
-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

@@ -1,18 +0,0 @@
-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':
-        default: {
-            const params = new URLSearchParams();
-            params.append('api-version', version);
-            return `/bookmarks?${String(params)}`;
-        }
-    }
-};

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

@@ -1,28 +0,0 @@
-import { ClientRequestInit, IHttpClient } from '@equinor/fusion-framework-module-http/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);
-
-    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

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

package/src/bookmarks/post/types.ts

@@ -1,58 +0,0 @@
-import { IHttpClient } from '@equinor/fusion-framework-module-http';
-import { ClientRequestInit } from '@equinor/fusion-framework-module-http/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>;
-
-export interface 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>;