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

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

@@ -2,6 +2,7 @@ import { IHttpClient } from '@equinor/fusion-framework-module-http';
 import { ClientMethod, ApiVersion } from '@equinor/fusion-framework-module-services/context';
 import { GetContextFn, GetContextResponse, GetContextResult } from './get';
 import { QueryContextFn, QueryContextResponse, QueryContextResult } from './query';
+import { RelatedContextFn, RelatedContextResponse, RelatedContextResult } from './related';
 export declare class ContextApiClient<TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>, TClient extends IHttpClient = IHttpClient> {
     protected _client: TClient;
     protected _method: TMethod;
@@ -9,5 +10,6 @@ export declare class ContextApiClient<TMethod extends keyof ClientMethod<unknown
     constructor(_client: TClient, _method: TMethod);
     get<TVersion extends string = keyof typeof ApiVersion, TResult = GetContextResponse<TVersion>>(version: TVersion, ...args: Parameters<GetContextFn<TVersion, TMethod, TClient, TResult>>): GetContextResult<TVersion, TMethod, TResult>;
     query<TVersion extends string = keyof typeof ApiVersion, TResult = QueryContextResponse<TVersion>>(version: TVersion, ...args: Parameters<QueryContextFn<TVersion, TMethod, TClient, TResult>>): QueryContextResult<TVersion, TMethod, TResult>;
+    related<TVersion extends string = keyof typeof ApiVersion, TResult = RelatedContextResponse<TVersion>>(version: TVersion, ...args: Parameters<RelatedContextFn<TVersion, TMethod, TClient, TResult>>): RelatedContextResult<TVersion, TMethod, TResult>;
 }
 export default ContextApiClient;

package/dist/types/context/related/client.d.ts

@@ -0,0 +1,4 @@
+import { ClientRequestInit, IHttpClient } from '@equinor/fusion-framework-module-http/client';
+import type { RelatedContextArgs, RelatedContextResponse, RelatedContextResult, ClientMethod } from './types';
+export declare const relatedContexts: <TVersion extends string = "v1" | "v2", TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>, TClient extends IHttpClient<import("@equinor/fusion-framework-module-http/client").FetchRequest, Response> = IHttpClient<import("@equinor/fusion-framework-module-http/client").FetchRequest, Response>>(client: TClient, version: TVersion, method?: TMethod) => <T = RelatedContextResponse<TVersion>>(args: RelatedContextArgs<TVersion>, init?: ClientRequestInit<TClient, T> | undefined) => RelatedContextResult<TVersion, TMethod, T>;
+export default relatedContexts;

package/dist/types/context/related/generate-endpoint.d.ts

@@ -0,0 +1,3 @@
+import type { RelatedContextArgs } from './types';
+export declare const generateEndpoint: <TVersion extends string = "v1" | "v2">(version: TVersion, args: RelatedContextArgs<TVersion>) => string;
+export default generateEndpoint;

package/dist/types/context/related/generate-parameters.d.ts

@@ -0,0 +1,4 @@
+import { ClientRequestInit, IHttpClient } from '@equinor/fusion-framework-module-http/client';
+import type { RelatedContextArgs, ApiClientArguments } from './types';
+export declare const generateParameters: <TResult, TVersion extends string = "v1" | "v2", TClient extends IHttpClient<import("@equinor/fusion-framework-module-http/client").FetchRequest, Response> = IHttpClient<import("@equinor/fusion-framework-module-http/client").FetchRequest, Response>>(version: TVersion, args: RelatedContextArgs<TVersion>, init?: ClientRequestInit<TClient, TResult> | undefined) => ApiClientArguments<TClient, TResult>;
+export default generateParameters;

package/dist/types/context/related/index.d.ts

@@ -0,0 +1,5 @@
+export { ApiVersion, ApiContextEntity } from '@equinor/fusion-framework-module-services/context';
+export { generateEndpoint } from './generate-endpoint';
+export { generateParameters } from './generate-parameters';
+export * from './types';
+export { relatedContexts, default } from './client';

package/dist/types/context/related/types.d.ts

@@ -0,0 +1,29 @@
+import { IHttpClient, ClientRequestInit } from '@equinor/fusion-framework-module-http/client';
+import { ApiVersion, ApiContextEntity, ClientMethod } from '@equinor/fusion-framework-module-services/context';
+export { ApiClientArguments, ClientMethod, } from '@equinor/fusion-framework-module-services/context';
+export type RelatedContextOdataFilter = {
+    type?: string[];
+};
+export type RelatedContextOdataParameters = {
+    search?: string;
+    filter?: RelatedContextOdataFilter;
+};
+type RelatedContextArgs_v1 = {
+    id: string;
+    query?: string | RelatedContextOdataParameters;
+};
+type RelatedContextArgs_v2 = RelatedContextArgs_v1;
+type RelatedContextArgTypes = {
+    [ApiVersion.v1]: RelatedContextArgs_v1;
+    [ApiVersion.v2]: RelatedContextArgs_v2;
+};
+export type RelatedContextArgs<T> = T extends keyof typeof ApiVersion ? RelatedContextArgTypes[(typeof ApiVersion)[T]] : {
+    id: string;
+};
+type RelatedContextResponseTypes = {
+    [ApiVersion.v1]: Array<ApiContextEntity<ApiVersion.v1>>;
+    [ApiVersion.v2]: Array<ApiContextEntity<ApiVersion.v2>>;
+};
+export type RelatedContextResponse<T> = T extends keyof typeof ApiVersion ? RelatedContextResponseTypes[(typeof ApiVersion)[T]] : unknown;
+export type RelatedContextFn<TVersion extends string = keyof typeof ApiVersion, TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>, TClient extends IHttpClient = IHttpClient, TResult = RelatedContextResponse<TVersion>> = (args: RelatedContextArgs<TVersion>, init?: ClientRequestInit<TClient, TResult>) => RelatedContextResult<TVersion, TMethod, TResult>;
+export type RelatedContextResult<TVersion extends string = keyof typeof ApiVersion, TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>, TResult = RelatedContextResponse<TVersion>> = ClientMethod<TResult>[TMethod];

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@equinor/fusion-framework-module-services",
-    "version": "2.3.1",
+    "version": "2.5.0",
     "description": "",
     "sideEffects": false,
     "main": "dist/esm/index.js",
@@ -22,6 +22,9 @@
             "context/query": [
                 "dist/types/context/query/index"
             ],
+            "context/related": [
+                "dist/types/context/related/index"
+            ],
             "bookmarks": [
                 "dist/types/bookmarks/index"
             ]
@@ -63,5 +66,5 @@
         "@equinor/fusion-framework-module": ">=1.2.2",
         "odata-query": "^7.0.3"
     },
-    "gitHead": "1dd3688d5ac207281d512fcb88fdb9409ad62748"
+    "gitHead": "dd4ed92c8f1d020f3b537172b4fe7788aeae99e7"
 }

package/src/context/client.ts

@@ -3,8 +3,16 @@ import { IHttpClient } from '@equinor/fusion-framework-module-http';
 import { ClientMethod, ApiVersion } from '@equinor/fusion-framework-module-services/context';
 
 import { getContext, GetContextFn, GetContextResponse, GetContextResult } from './get';
+
 import { queryContext, QueryContextFn, QueryContextResponse, QueryContextResult } from './query';
 
+import {
+    RelatedContextFn,
+    RelatedContextResponse,
+    RelatedContextResult,
+    relatedContexts,
+} from './related';
+
 export class ContextApiClient<
     TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>,
     TClient extends IHttpClient = IHttpClient
@@ -44,6 +52,21 @@ export class ContextApiClient<
         const fn = queryContext<TVersion, TMethod, TClient>(this._client, version, this._method);
         return fn<TResult>(...args);
     }
+
+    /**
+     * Query context service
+     * @see {@link query/client}
+     */
+    public related<
+        TVersion extends string = keyof typeof ApiVersion,
+        TResult = RelatedContextResponse<TVersion>
+    >(
+        version: TVersion,
+        ...args: Parameters<RelatedContextFn<TVersion, TMethod, TClient, TResult>>
+    ): RelatedContextResult<TVersion, TMethod, TResult> {
+        const fn = relatedContexts<TVersion, TMethod, TClient>(this._client, version, this._method);
+        return fn<TResult>(...args);
+    }
 }
 
 export default ContextApiClient;

package/src/context/related/client.ts

@@ -0,0 +1,35 @@
+import { ClientRequestInit, IHttpClient } from '@equinor/fusion-framework-module-http/client';
+
+import { ApiVersion } from '@equinor/fusion-framework-module-services/context';
+
+import { generateParameters } from './generate-parameters';
+
+import type {
+    RelatedContextArgs,
+    RelatedContextResponse,
+    RelatedContextResult,
+    ClientMethod,
+} from './types';
+
+/**
+ * Function for querying the context service
+ */
+export const relatedContexts =
+    <
+        TVersion extends string = keyof typeof ApiVersion,
+        TMethod extends keyof ClientMethod = keyof ClientMethod,
+        TClient extends IHttpClient = IHttpClient
+    >(
+        client: TClient,
+        version: TVersion,
+        method: TMethod = 'json' as TMethod
+    ) =>
+    <T = RelatedContextResponse<TVersion>>(
+        args: RelatedContextArgs<TVersion>,
+        init?: ClientRequestInit<TClient, T>
+    ): RelatedContextResult<TVersion, TMethod, T> =>
+        client[method](
+            ...generateParameters<T, TVersion, TClient>(version, args, init)
+        ) as RelatedContextResult<TVersion, TMethod, T>;
+
+export default relatedContexts;

package/src/context/related/generate-endpoint.ts

@@ -0,0 +1,62 @@
+import buildOdataQuery from 'odata-query';
+
+import { UnsupportedApiVersion } from '@equinor/fusion-framework-module-services/errors';
+
+import { ApiVersion } from '@equinor/fusion-framework-module-services/context';
+
+import type {
+    RelatedContextArgs,
+    RelatedContextOdataFilter,
+    RelatedContextOdataParameters,
+} from './types';
+
+const buildOdataFilter = (filterObj: RelatedContextOdataFilter) => {
+    return Object.keys(filterObj).reduce((acc, key) => {
+        switch (key) {
+            case 'type':
+                return filterObj[key]?.length ? { ...acc, [key]: { in: filterObj[key] } } : acc;
+            default:
+                return { ...acc, [key]: filterObj[key as keyof typeof filterObj] };
+        }
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    }, {} as any);
+};
+
+const buildOdataObject = (parameters: RelatedContextOdataParameters) => {
+    return Object.keys(parameters).reduce((acc, key) => {
+        switch (key) {
+            case 'filter':
+                return {
+                    ...acc,
+                    [key]: buildOdataFilter(parameters['filter'] as RelatedContextOdataFilter),
+                };
+            default:
+                return { ...acc, [key]: parameters[key as keyof typeof parameters] };
+        }
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    }, {} as any);
+};
+
+const createSearchParameters = (args: string | RelatedContextOdataParameters) => {
+    return typeof args === 'string' ? args : buildOdataQuery(buildOdataObject(args));
+};
+
+export const generateEndpoint = <TVersion extends string = keyof typeof ApiVersion>(
+    version: TVersion,
+    args: RelatedContextArgs<TVersion>
+) => {
+    const apiVersion = ApiVersion[version as keyof typeof ApiVersion] ?? version;
+    switch (apiVersion) {
+        case ApiVersion.v2:
+            throw new UnsupportedApiVersion(version);
+        case ApiVersion.v1:
+        default: {
+            const { id, query } = args as RelatedContextArgs<'v1'>;
+            const params = new URLSearchParams(createSearchParameters(query || ''));
+            params.append('api-version', apiVersion);
+            return `/contexts/${id}/relations?${String(params)}`;
+        }
+    }
+};
+
+export default generateEndpoint;

package/src/context/related/generate-parameters.ts

@@ -0,0 +1,23 @@
+import { ClientRequestInit, IHttpClient } from '@equinor/fusion-framework-module-http/client';
+
+import { ApiVersion } from '@equinor/fusion-framework-module-services/context';
+
+import { generateEndpoint } from './generate-endpoint';
+
+import type { RelatedContextArgs, ApiClientArguments } from './types';
+
+/** Function for generating parameter for querying context service  */
+export const generateParameters = <
+    TResult,
+    TVersion extends string = keyof typeof ApiVersion,
+    TClient extends IHttpClient = IHttpClient
+>(
+    version: TVersion,
+    args: RelatedContextArgs<TVersion>,
+    init?: ClientRequestInit<TClient, TResult>
+): ApiClientArguments<TClient, TResult> => {
+    const path = generateEndpoint(version, args);
+    return [path, init];
+};
+
+export default generateParameters;

package/src/context/related/index.ts

@@ -0,0 +1,8 @@
+export { ApiVersion, ApiContextEntity } from '@equinor/fusion-framework-module-services/context';
+
+export { generateEndpoint } from './generate-endpoint';
+export { generateParameters } from './generate-parameters';
+
+export * from './types';
+
+export { relatedContexts, default } from './client';

package/src/context/related/types.ts

@@ -0,0 +1,63 @@
+import { IHttpClient, ClientRequestInit } from '@equinor/fusion-framework-module-http/client';
+
+import {
+    ApiVersion,
+    ApiContextEntity,
+    ClientMethod,
+} from '@equinor/fusion-framework-module-services/context';
+
+export {
+    ApiClientArguments,
+    ClientMethod,
+} from '@equinor/fusion-framework-module-services/context';
+
+export type RelatedContextOdataFilter = {
+    type?: string[];
+};
+
+export type RelatedContextOdataParameters = {
+    search?: string;
+    filter?: RelatedContextOdataFilter;
+};
+
+type RelatedContextArgs_v1 = {
+    /** context id */
+    id: string;
+    query?: string | RelatedContextOdataParameters;
+};
+
+type RelatedContextArgs_v2 = RelatedContextArgs_v1;
+
+type RelatedContextArgTypes = {
+    [ApiVersion.v1]: RelatedContextArgs_v1;
+    [ApiVersion.v2]: RelatedContextArgs_v2;
+};
+
+export type RelatedContextArgs<T> = T extends keyof typeof ApiVersion
+    ? RelatedContextArgTypes[(typeof ApiVersion)[T]]
+    : { id: string };
+
+type RelatedContextResponseTypes = {
+    [ApiVersion.v1]: Array<ApiContextEntity<ApiVersion.v1>>;
+    [ApiVersion.v2]: Array<ApiContextEntity<ApiVersion.v2>>;
+};
+
+export type RelatedContextResponse<T> = T extends keyof typeof ApiVersion
+    ? RelatedContextResponseTypes[(typeof ApiVersion)[T]]
+    : unknown;
+
+export type RelatedContextFn<
+    TVersion extends string = keyof typeof ApiVersion,
+    TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>,
+    TClient extends IHttpClient = IHttpClient,
+    TResult = RelatedContextResponse<TVersion>
+> = (
+    args: RelatedContextArgs<TVersion>,
+    init?: ClientRequestInit<TClient, TResult>
+) => RelatedContextResult<TVersion, TMethod, TResult>;
+
+export type RelatedContextResult<
+    TVersion extends string = keyof typeof ApiVersion,
+    TMethod extends keyof ClientMethod<unknown> = keyof ClientMethod<unknown>,
+    TResult = RelatedContextResponse<TVersion>
+> = ClientMethod<TResult>[TMethod];