@civet/core 6.2.4 → 6.2.5

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.
@@ -1,5 +1,6 @@
1
- import { ReactNode } from 'react';
2
- import { GenericDataProvider, InferResponse, InferMetaType, InferOptions, InferQuery, Persistence, InferUIPluginProps, InferContextPluginProps } from './DataProvider';
1
+ import { PropsWithChildren } from 'react';
2
+ import { GenericDataProvider, InferResponse, InferMetaType, InferOptions, InferQuery, InferUIPluginProps, InferContextPluginProps } from './DataProvider';
3
+ import { ResourceProps } from './useResource';
3
4
  /**
4
5
  * Provides data based on the given request details and DataProvider.
5
6
  * Context provider for the ResourceContext.
@@ -8,18 +9,4 @@ import { GenericDataProvider, InferResponse, InferMetaType, InferOptions, InferQ
8
9
  *
9
10
  * The provided DataProvider must not be changed.
10
11
  */
11
- export default function Resource<DataProviderI extends GenericDataProvider, ResponseI extends InferResponse<DataProviderI> = InferResponse<DataProviderI>, QueryI extends InferQuery<DataProviderI> = InferQuery<DataProviderI>, OptionsI extends InferOptions<DataProviderI> = InferOptions<DataProviderI>, MetaTypeI extends InferMetaType<DataProviderI> = InferMetaType<DataProviderI>>({ dataProvider, name, query, disabled, options, persistent, children, ...rest }: {
12
- /** DataProvider to be used for requests - must not be changed */
13
- dataProvider?: DataProviderI;
14
- /** Resource name */
15
- name: string;
16
- /** Query instructions */
17
- query: QueryI;
18
- /** Disables fetching data, resulting in an empty data array */
19
- disabled?: boolean;
20
- /** Query options for requests */
21
- options?: OptionsI;
22
- /** Whether stale data should be retained during the next request - this only applies if name did not change, unless set to "very" */
23
- persistent?: Persistence;
24
- children?: ReactNode;
25
- } & InferContextPluginProps<DataProviderI> & InferUIPluginProps<DataProviderI>): import("react/jsx-runtime").JSX.Element;
12
+ export default function Resource<DataProviderI extends GenericDataProvider, ResponseI extends InferResponse<DataProviderI> = InferResponse<DataProviderI>, QueryI extends InferQuery<DataProviderI> = InferQuery<DataProviderI>, OptionsI extends InferOptions<DataProviderI> = InferOptions<DataProviderI>, MetaTypeI extends InferMetaType<DataProviderI> = InferMetaType<DataProviderI>>({ dataProvider, name, query, disabled, options, persistent, children, ...rest }: PropsWithChildren<ResourceProps<DataProviderI, QueryI, OptionsI> & InferContextPluginProps<DataProviderI> & InferUIPluginProps<DataProviderI>>): import("react/jsx-runtime").JSX.Element;
@@ -1,12 +1,5 @@
1
1
  import { GenericDataProvider, InferResponse, InferMetaType, InferOptions, InferQuery, Persistence, ResourceContextValue, InferContextPluginProps, InferContextPluginTypes } from './DataProvider';
2
- /**
3
- * Provides data based on the given request details and DataProvider.
4
- *
5
- * Necessary configuration that is not directly specified is taken from the ConfigContext.
6
- *
7
- * The provided DataProvider must not be changed.
8
- */
9
- export default function useResource<DataProviderI extends GenericDataProvider, ResponseI extends InferResponse<DataProviderI> = InferResponse<DataProviderI>, QueryI extends InferQuery<DataProviderI> = InferQuery<DataProviderI>, OptionsI extends InferOptions<DataProviderI> = InferOptions<DataProviderI>, MetaTypeI extends InferMetaType<DataProviderI> = InferMetaType<DataProviderI>>({ dataProvider: dataProviderProp, name: nameProp, query: nextQuery, disabled: nextDisabled, options: nextOptions, persistent: nextPersistent, ...rest }: {
2
+ export type ResourceProps<DataProviderI extends GenericDataProvider, QueryI extends InferQuery<DataProviderI> = InferQuery<DataProviderI>, OptionsI extends InferOptions<DataProviderI> = InferOptions<DataProviderI>> = {
10
3
  /** DataProvider to be used for requests - must not be changed */
11
4
  dataProvider?: DataProviderI;
12
5
  /** Resource name */
@@ -19,4 +12,12 @@ export default function useResource<DataProviderI extends GenericDataProvider, R
19
12
  options?: OptionsI;
20
13
  /** Whether stale data should be retained during the next request - this only applies if name did not change, unless set to "very" */
21
14
  persistent?: Persistence;
22
- } & InferContextPluginProps<DataProviderI>): ResourceContextValue<DataProviderI, ResponseI, QueryI, OptionsI, MetaTypeI> & InferContextPluginTypes<DataProviderI>;
15
+ };
16
+ /**
17
+ * Provides data based on the given request details and DataProvider.
18
+ *
19
+ * Necessary configuration that is not directly specified is taken from the ConfigContext.
20
+ *
21
+ * The provided DataProvider must not be changed.
22
+ */
23
+ export default function useResource<DataProviderI extends GenericDataProvider, ResponseI extends InferResponse<DataProviderI> = InferResponse<DataProviderI>, QueryI extends InferQuery<DataProviderI> = InferQuery<DataProviderI>, OptionsI extends InferOptions<DataProviderI> = InferOptions<DataProviderI>, MetaTypeI extends InferMetaType<DataProviderI> = InferMetaType<DataProviderI>>({ dataProvider: dataProviderProp, name: nameProp, query: nextQuery, disabled: nextDisabled, options: nextOptions, persistent: nextPersistent, ...rest }: ResourceProps<DataProviderI, QueryI, OptionsI> & InferContextPluginProps<DataProviderI>): ResourceContextValue<DataProviderI, ResponseI, QueryI, OptionsI, MetaTypeI> & InferContextPluginTypes<DataProviderI>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@civet/core",
3
- "version": "6.2.4",
3
+ "version": "6.2.5",
4
4
  "description": "Civet",
5
5
  "author": {
6
6
  "name": "Aaron Burmeister"