@ocelescope/api-base 0.9.1 → 0.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +7 -16
- package/dist/index.js +8 -9
- package/package.json +3 -3
package/dist/index.d.ts
CHANGED
|
@@ -1178,17 +1178,12 @@ export interface DateDistributionItem {
|
|
|
1178
1178
|
end_timestamp: string;
|
|
1179
1179
|
entity_count: DateDistributionItemEntityCount;
|
|
1180
1180
|
}
|
|
1181
|
-
/**
|
|
1182
|
-
* Definition of a default OCEL on the server, for quick access. Supports pre-loading the OCEL on backend init.
|
|
1183
|
-
*/
|
|
1184
1181
|
export interface DefaultOCEL {
|
|
1185
1182
|
key: string;
|
|
1186
1183
|
name: string;
|
|
1187
1184
|
version: string;
|
|
1188
1185
|
file: string;
|
|
1189
1186
|
url?: string | null;
|
|
1190
|
-
preload?: boolean;
|
|
1191
|
-
hide?: boolean;
|
|
1192
1187
|
}
|
|
1193
1188
|
export interface EntityTimeInfo {
|
|
1194
1189
|
start_time: string;
|
|
@@ -1349,10 +1344,6 @@ export interface TypedAttribute {
|
|
|
1349
1344
|
type: ValueType;
|
|
1350
1345
|
entity_type: string;
|
|
1351
1346
|
}
|
|
1352
|
-
export type GetDefaultOcelParams = {
|
|
1353
|
-
only_latest_versions?: boolean;
|
|
1354
|
-
only_preloaded?: boolean;
|
|
1355
|
-
};
|
|
1356
1347
|
export type ImportDefaultOcelParams = {
|
|
1357
1348
|
/**
|
|
1358
1349
|
* Default OCEL key
|
|
@@ -1678,29 +1669,29 @@ export declare function useGetOcels<TData = Awaited<ReturnType<typeof getOcels>>
|
|
|
1678
1669
|
/**
|
|
1679
1670
|
* @summary Get default OCEL metadata
|
|
1680
1671
|
*/
|
|
1681
|
-
export declare const getDefaultOcel: (
|
|
1682
|
-
export declare const getGetDefaultOcelQueryKey: (
|
|
1683
|
-
export declare const getGetDefaultOcelQueryOptions: <TData = Awaited<ReturnType<typeof getDefaultOcel>>, TError =
|
|
1672
|
+
export declare const getDefaultOcel: (options?: SecondParameter<typeof customFetch>, signal?: AbortSignal) => Promise<DefaultOCEL[]>;
|
|
1673
|
+
export declare const getGetDefaultOcelQueryKey: () => readonly ["/api/external/modules/ocel/v1/default"];
|
|
1674
|
+
export declare const getGetDefaultOcelQueryOptions: <TData = Awaited<ReturnType<typeof getDefaultOcel>>, TError = unknown>(options?: {
|
|
1684
1675
|
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getDefaultOcel>>, TError, TData>>;
|
|
1685
1676
|
request?: SecondParameter<typeof customFetch>;
|
|
1686
1677
|
}) => UseQueryOptions<Awaited<ReturnType<typeof getDefaultOcel>>, TError, TData> & {
|
|
1687
1678
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1688
1679
|
};
|
|
1689
1680
|
export type GetDefaultOcelQueryResult = NonNullable<Awaited<ReturnType<typeof getDefaultOcel>>>;
|
|
1690
|
-
export type GetDefaultOcelQueryError =
|
|
1691
|
-
export declare function useGetDefaultOcel<TData = Awaited<ReturnType<typeof getDefaultOcel>>, TError =
|
|
1681
|
+
export type GetDefaultOcelQueryError = unknown;
|
|
1682
|
+
export declare function useGetDefaultOcel<TData = Awaited<ReturnType<typeof getDefaultOcel>>, TError = unknown>(options: {
|
|
1692
1683
|
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getDefaultOcel>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getDefaultOcel>>, TError, Awaited<ReturnType<typeof getDefaultOcel>>>, 'initialData'>;
|
|
1693
1684
|
request?: SecondParameter<typeof customFetch>;
|
|
1694
1685
|
}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
|
|
1695
1686
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1696
1687
|
};
|
|
1697
|
-
export declare function useGetDefaultOcel<TData = Awaited<ReturnType<typeof getDefaultOcel>>, TError =
|
|
1688
|
+
export declare function useGetDefaultOcel<TData = Awaited<ReturnType<typeof getDefaultOcel>>, TError = unknown>(options?: {
|
|
1698
1689
|
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getDefaultOcel>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getDefaultOcel>>, TError, Awaited<ReturnType<typeof getDefaultOcel>>>, 'initialData'>;
|
|
1699
1690
|
request?: SecondParameter<typeof customFetch>;
|
|
1700
1691
|
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
1701
1692
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1702
1693
|
};
|
|
1703
|
-
export declare function useGetDefaultOcel<TData = Awaited<ReturnType<typeof getDefaultOcel>>, TError =
|
|
1694
|
+
export declare function useGetDefaultOcel<TData = Awaited<ReturnType<typeof getDefaultOcel>>, TError = unknown>(options?: {
|
|
1704
1695
|
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getDefaultOcel>>, TError, TData>>;
|
|
1705
1696
|
request?: SecondParameter<typeof customFetch>;
|
|
1706
1697
|
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
package/dist/index.js
CHANGED
|
@@ -1007,21 +1007,20 @@ function useGetOcels(options, queryClient) {
|
|
|
1007
1007
|
/**
|
|
1008
1008
|
* @summary Get default OCEL metadata
|
|
1009
1009
|
*/
|
|
1010
|
-
const getDefaultOcel = (
|
|
1010
|
+
const getDefaultOcel = (options, signal) => {
|
|
1011
1011
|
return customFetch$1({
|
|
1012
1012
|
url: `/api/external/modules/ocel/v1/default`,
|
|
1013
1013
|
method: "GET",
|
|
1014
|
-
params,
|
|
1015
1014
|
...signal ? { signal } : {}
|
|
1016
1015
|
}, options);
|
|
1017
1016
|
};
|
|
1018
|
-
const getGetDefaultOcelQueryKey = (
|
|
1019
|
-
return [`/api/external/modules/ocel/v1/default
|
|
1017
|
+
const getGetDefaultOcelQueryKey = () => {
|
|
1018
|
+
return [`/api/external/modules/ocel/v1/default`];
|
|
1020
1019
|
};
|
|
1021
|
-
const getGetDefaultOcelQueryOptions = (
|
|
1020
|
+
const getGetDefaultOcelQueryOptions = (options) => {
|
|
1022
1021
|
const { query: queryOptions, request: requestOptions } = options ?? {};
|
|
1023
|
-
const queryKey = queryOptions?.queryKey ?? getGetDefaultOcelQueryKey(
|
|
1024
|
-
const queryFn = ({ signal }) => getDefaultOcel(
|
|
1022
|
+
const queryKey = queryOptions?.queryKey ?? getGetDefaultOcelQueryKey();
|
|
1023
|
+
const queryFn = ({ signal }) => getDefaultOcel(requestOptions, signal);
|
|
1025
1024
|
return {
|
|
1026
1025
|
queryKey,
|
|
1027
1026
|
queryFn,
|
|
@@ -1032,8 +1031,8 @@ const getGetDefaultOcelQueryOptions = (params, options) => {
|
|
|
1032
1031
|
/**
|
|
1033
1032
|
* @summary Get default OCEL metadata
|
|
1034
1033
|
*/
|
|
1035
|
-
function useGetDefaultOcel(
|
|
1036
|
-
const queryOptions = getGetDefaultOcelQueryOptions(
|
|
1034
|
+
function useGetDefaultOcel(options, queryClient) {
|
|
1035
|
+
const queryOptions = getGetDefaultOcelQueryOptions(options);
|
|
1037
1036
|
const query = useQuery(queryOptions, queryClient);
|
|
1038
1037
|
return withQueryKey(query, queryOptions.queryKey);
|
|
1039
1038
|
}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ocelescope/api-base",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "0.
|
|
4
|
+
"version": "0.10.0",
|
|
5
5
|
"description": "Generated, type-safe client + hooks for the Ocelescope Base backend.",
|
|
6
6
|
"author": "Görkem-Emre Öztürk <goerkem.oeztuerk@rwth-aachen.de>",
|
|
7
7
|
"license": "MIT",
|
|
@@ -27,14 +27,14 @@
|
|
|
27
27
|
"access": "public"
|
|
28
28
|
},
|
|
29
29
|
"peerDependencies": {
|
|
30
|
-
"@ocelescope/api-client": "^0.
|
|
30
|
+
"@ocelescope/api-client": "^0.10.0",
|
|
31
31
|
"@tanstack/react-query": "^5.90.21",
|
|
32
32
|
"axios": "^1.20.0",
|
|
33
33
|
"react": "^19.3.0",
|
|
34
34
|
"react-dom": "^19.3.0"
|
|
35
35
|
},
|
|
36
36
|
"devDependencies": {
|
|
37
|
-
"@ocelescope/api-config": "^0.
|
|
37
|
+
"@ocelescope/api-config": "^0.10.0",
|
|
38
38
|
"@types/node": "^26.6.1",
|
|
39
39
|
"@types/react": "^19.3.0",
|
|
40
40
|
"@types/react-dom": "^19.3.0",
|