@civet/core 4.0.0 → 6.0.0

package/dist/DataProvider.d.ts

@@ -6,7 +6,7 @@ import { Constructor } from './utilityTypes';
 export type RequestDetails<Query, Options> = {
     name: string;
     query: Query;
-    empty: boolean;
+    disabled: boolean;
     options: Options | undefined;
 };
 export type ResourceBaseContext<Response, Query, Options, MetaType extends Meta> = {
@@ -18,7 +18,7 @@ export type ResourceBaseContext<Response, Query, Options, MetaType extends Meta>
     data: Response;
     meta: InferSchema<MetaType>;
     error: Error | undefined;
-    isEmpty: boolean;
+    isDisabled: boolean;
     isIncomplete: boolean;
     isInitial: boolean;
 };
@@ -46,20 +46,25 @@ export interface GetCallback<Response> {
     (error: Error, done: boolean, result: undefined): void;
 }
 export type ContinuousGet<Response> = (callback: GetCallback<Response>) => void;
-export default abstract class DataProvider<Item, Query, Options, MetaType extends Meta = Meta, Response extends Item | Item[] = Item | Item[]> {
+export type DataProviderExtend = {
+    context: <PluginProps, PluginTypes>(plugin: ContextPlugin<PluginProps, PluginTypes>) => void;
+    ui: <PluginProps, PluginTypes>(plugin: UIPlugin<PluginProps, PluginTypes>) => void;
+};
+export default abstract class DataProvider<Item, Query, Options, MetaType extends Meta = Meta, Response extends Item | Item[] = Item | Item[], ContextPluginProps = unknown, ContextPluginTypes = unknown, UIPluginProps = unknown, UIPluginTypes = unknown> {
     readonly _inferItem: Item;
     readonly _inferQuery: Query;
     readonly _inferOptions: Options;
     readonly _inferMetaType: MetaType;
     readonly _inferResponse: Response;
+    readonly _inferContextPluginProps: ContextPluginProps;
+    readonly _inferContextPluginTypes: ContextPluginTypes;
+    readonly _inferUIPluginProps: UIPluginProps;
+    readonly _inferUIPluginTypes: UIPluginTypes;
     notifier: ChannelNotifier<never[]>;
-    readonly contextPlugins: ContextPlugin<unknown, unknown>[];
-    readonly uiPlugins: UIPlugin<unknown, unknown>[];
+    readonly contextPlugins: ContextPlugin[];
+    readonly uiPlugins: UIPlugin[];
     constructor();
-    extend(_extend: {
-        context: (plugin: ContextPlugin<unknown, unknown>) => void;
-        ui: (plugin: UIPlugin<unknown, unknown>) => void;
-    }): void;
+    extend(_extend: DataProviderExtend): void;
     createInstance(): InferInstance<MetaType> | undefined;
     releaseInstance(_: InferInstance<MetaType>): void;
     subscribe(resource: string, callback: () => void): () => void;
@@ -68,7 +73,7 @@ export default abstract class DataProvider<Item, Query, Options, MetaType extend
     continuousGet<ResponseI extends Response = Response, QueryI extends Query = Query, OptionsI extends Options = Options, MetaTypeI extends MetaType = MetaType>(resource: string, query: QueryI, options: OptionsI | undefined, meta: MetaLike<MetaTypeI> | undefined, callback: GetCallback<ResponseI>, abortSignal?: AbortSignal): void;
     abstract handleGet(resource: string, query: Query, options: Options | undefined, meta: MetaType, abortSignal: AbortSignalProxy): Promise<Response | ContinuousGet<Response>> | Response | ContinuousGet<Response>;
     compareRequests(nextRequestDetails: RequestDetails<Query, Options>, prevRequestDetails: RequestDetails<Query, Options>): boolean;
-    getEmptyResponse(_requestDetails: RequestDetails<Query, Options>): Response;
+    createEmptyResponse(_requestDetails: RequestDetails<Query, Options>): Response;
     shouldPersist(nextRequestDetails: RequestDetails<Query, Options>, prevRequestDetails: RequestDetails<Query, Options>, persistent: Persistence, _context: ResourceBaseContext<Response, Query, Options, MetaType>): boolean;
     compareItemVersions(_item1: Item, _item2: Item): boolean;
     getItemIdentifier(item: Item): string | undefined;
@@ -79,10 +84,14 @@ export declare const isDataProvider: (dataProvider: unknown) => boolean;
 export type DataProviderImplementation<DataProviderI extends GenericDataProvider, ConstructorArgs extends any[]> = Constructor<ConstructorArgs, DataProviderI & {
     handleGet(resource: string, query: InferQuery<DataProviderI>, options: InferOptions<DataProviderI> | undefined, meta: InferMetaType<DataProviderI>, abortSignal: AbortSignalProxy): Promise<InferResponse<DataProviderI> | ContinuousGet<InferResponse<DataProviderI>>> | InferResponse<DataProviderI> | ContinuousGet<InferResponse<DataProviderI>>;
 }>;
-export type GenericDataProvider = DataProvider<unknown, unknown, unknown, Meta, unknown>;
+export type GenericDataProvider = DataProvider<unknown, unknown, unknown, Meta, unknown, unknown, unknown, unknown, unknown>;
 export type GenericDataProviderImplementation = DataProviderImplementation<GenericDataProvider, any[]>;
 export type InferItem<DataProviderI extends GenericDataProvider> = DataProviderI['_inferItem'];
 export type InferQuery<DataProviderI extends GenericDataProvider> = DataProviderI['_inferQuery'];
 export type InferOptions<DataProviderI extends GenericDataProvider> = DataProviderI['_inferOptions'];
 export type InferMetaType<DataProviderI extends GenericDataProvider> = DataProviderI['_inferMetaType'];
 export type InferResponse<DataProviderI extends GenericDataProvider> = DataProviderI['_inferResponse'];
+export type InferContextPluginProps<DataProviderI extends GenericDataProvider> = DataProviderI['_inferContextPluginProps'];
+export type InferContextPluginTypes<DataProviderI extends GenericDataProvider> = DataProviderI['_inferContextPluginTypes'];
+export type InferUIPluginProps<DataProviderI extends GenericDataProvider> = DataProviderI['_inferUIPluginProps'];
+export type InferUIPluginTypes<DataProviderI extends GenericDataProvider> = DataProviderI['_inferUIPluginTypes'];

package/dist/Resource.d.ts

@@ -1,5 +1,5 @@
 import { ReactNode } from 'react';
-import { GenericDataProvider, InferResponse, InferMetaType, InferOptions, InferQuery, Persistence } from './DataProvider';
+import { GenericDataProvider, InferResponse, InferMetaType, InferOptions, InferQuery, Persistence, InferUIPluginProps, InferContextPluginProps } from './DataProvider';
 /**
  * Provides data based on the given request details and DataProvider.
  * Context provider for the ResourceContext.
@@ -8,7 +8,7 @@ import { GenericDataProvider, InferResponse, InferMetaType, InferOptions, InferQ
  *
  * The provided DataProvider must not be changed.
  */
-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, empty, options, persistent, children, ...rest }: {
+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 }: {
     /** DataProvider to be used for requests - must not be changed */
     dataProvider?: DataProviderI;
     /** Resource name */
@@ -16,11 +16,10 @@ export default function Resource<DataProviderI extends GenericDataProvider, Resp
     /** Query instructions */
     query: QueryI;
     /** Disables fetching data, resulting in an empty data array */
-    empty?: boolean;
+    disabled?: boolean;
     /** Query options for requests */
     options?: OptionsI;
     /** Whether stale data should be retained during the next request - this only applies if name did not change, unless set to "very" */
     persistent?: Persistence;
     children?: ReactNode;
-    [rest: string]: unknown;
-}): import("react/jsx-runtime").JSX.Element;
+} & InferContextPluginProps<DataProviderI> & InferUIPluginProps<DataProviderI>): import("react/jsx-runtime").JSX.Element;

package/dist/ResourceProvider.d.ts

@@ -1,5 +1,5 @@
 import { PropsWithChildren, ReactNode } from 'react';
-import { GenericDataProvider, InferResponse, InferMetaType, InferOptions, InferQuery, ResourceContextValue } from './DataProvider';
-export default function ResourceProvider<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>>({ resource, children, }: PropsWithChildren<{
-    resource: ResourceContextValue<DataProviderI, ResponseI, QueryI, OptionsI, MetaTypeI>;
-}>): ReactNode;
+import { GenericDataProvider, InferResponse, InferMetaType, InferOptions, InferQuery, ResourceContextValue, InferContextPluginTypes, InferUIPluginProps } from './DataProvider';
+export default function ResourceProvider<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>>({ resource, children, ...rest }: PropsWithChildren<{
+    resource: ResourceContextValue<DataProviderI, ResponseI, QueryI, OptionsI, MetaTypeI> & InferContextPluginTypes<DataProviderI>;
+} & InferUIPluginProps<DataProviderI>>): ReactNode;

package/dist/context.d.ts

@@ -1,5 +1,5 @@
-import { ConsumerProps, ExoticComponent, ReactNode } from 'react';
-import { GenericDataProvider, InferResponse, InferMetaType, InferOptions, InferQuery, ResourceContextValue } from './DataProvider';
+import { Consumer, ConsumerProps, ExoticComponent, Provider, ProviderProps, ReactNode } from 'react';
+import { GenericDataProvider, InferResponse, InferMetaType, InferOptions, InferQuery, ResourceContextValue, InferContextPluginTypes, InferUIPluginTypes } from './DataProvider';
 export type ConfigContextValue<DataProviderI extends GenericDataProvider> = {
     dataProvider?: DataProviderI;
 };
@@ -8,8 +8,10 @@ export declare const ConfigConsumer: ExoticComponent<GenericDataProvider> & {
     <DataProviderI extends GenericDataProvider>(props: ConsumerProps<ConfigContextValue<DataProviderI>>): ReactNode;
 };
 export declare const useConfigContext: <DataProviderI extends GenericDataProvider>() => ConfigContextValue<DataProviderI>;
-export declare const ResourceContext: import('react').Context<ResourceContextValue<GenericDataProvider>>;
-export declare const ResourceConsumer: ExoticComponent<GenericDataProvider> & {
-    <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>>(props: ConsumerProps<ResourceContextValue<DataProviderI, ResponseI, QueryI, OptionsI, MetaTypeI>>): ReactNode;
+export declare const ResourceContextProvider: Provider<GenericDataProvider> & {
+    <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>>(props: ProviderProps<ResourceContextValue<DataProviderI, ResponseI, QueryI, OptionsI, MetaTypeI> & InferContextPluginTypes<DataProviderI> & InferUIPluginTypes<DataProviderI>>): ReactNode;
 };
-export declare const useResourceContext: <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>>() => ResourceContextValue<DataProviderI, ResponseI, QueryI, OptionsI, MetaTypeI>;
+export declare const ResourceConsumer: Consumer<GenericDataProvider> & {
+    <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>>(props: ConsumerProps<ResourceContextValue<DataProviderI, ResponseI, QueryI, OptionsI, MetaTypeI> & InferContextPluginTypes<DataProviderI> & InferUIPluginTypes<DataProviderI>>): ReactNode;
+};
+export declare const useResourceContext: <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>>() => ResourceContextValue<DataProviderI, ResponseI, QueryI, OptionsI, MetaTypeI> & InferContextPluginTypes<DataProviderI> & InferUIPluginTypes<DataProviderI>;

package/dist/createPlugin.d.ts

@@ -1,5 +1,14 @@
 import { GenericDataProviderImplementation } from './DataProvider';
 import { Constructor } from './utilityTypes';
-export type DataProviderImplementationWithPlugin<BaseDataProvider extends GenericDataProviderImplementation, PluginTypes> = Pick<BaseDataProvider, keyof BaseDataProvider> & Constructor<ConstructorParameters<BaseDataProvider>, InstanceType<BaseDataProvider> & PluginTypes>;
-export type DataProviderPlugin<BaseDataProvider extends GenericDataProviderImplementation, PluginTypes> = <BaseDataProviderT extends BaseDataProvider>(baseDataProviderClass: BaseDataProviderT) => DataProviderImplementationWithPlugin<BaseDataProviderT, PluginTypes>;
-export default function createPlugin<BaseDataProvider extends GenericDataProviderImplementation, PluginTypes>(plugin: (baseDataProviderClass: Pick<BaseDataProvider, keyof BaseDataProvider> & Constructor<any[], InstanceType<BaseDataProvider>>) => DataProviderImplementationWithPlugin<Pick<BaseDataProvider, keyof BaseDataProvider> & Constructor<any[], InstanceType<BaseDataProvider>>, PluginTypes>): DataProviderPlugin<BaseDataProvider, PluginTypes>;
+type InstanceTypeExtension<BaseClass extends new (...args: any) => any, InstanceTypeExtension> = Pick<BaseClass, keyof BaseClass> & Constructor<ConstructorParameters<BaseClass>, InstanceType<BaseClass> & InstanceTypeExtension>;
+type PluginBaseDataProvider<BaseDataProvider extends GenericDataProviderImplementation> = Pick<BaseDataProvider, keyof BaseDataProvider> & Constructor<any[], InstanceType<BaseDataProvider>>;
+type PluginExtendedDataProvider<BaseDataProvider extends GenericDataProviderImplementation, PluginTypes> = InstanceTypeExtension<PluginBaseDataProvider<BaseDataProvider>, PluginTypes>;
+export type DataProviderImplementationWithPlugin<BaseDataProvider extends GenericDataProviderImplementation, DataProviderPluginTypes, ContextPluginProps, ContextPluginTypes, UIPluginProps, UIPluginTypes> = InstanceTypeExtension<BaseDataProvider, {
+    _inferContextPluginProps: ContextPluginProps;
+    _inferContextPluginTypes: ContextPluginTypes;
+    _inferUIPluginProps: UIPluginProps;
+    _inferUIPluginTypes: UIPluginTypes;
+} & DataProviderPluginTypes>;
+export type DataProviderPlugin<BaseDataProvider extends GenericDataProviderImplementation, DataProviderPluginTypes, ContextPluginProps, ContextPluginTypes, UIPluginProps, UIPluginTypes> = <BaseDataProviderT extends BaseDataProvider>(baseDataProviderClass: BaseDataProviderT) => DataProviderImplementationWithPlugin<BaseDataProviderT, DataProviderPluginTypes, ContextPluginProps, ContextPluginTypes, UIPluginProps, UIPluginTypes>;
+export default function createPlugin<BaseDataProvider extends GenericDataProviderImplementation, DataProviderPluginTypes = unknown, ContextPluginProps = unknown, ContextPluginTypes = unknown, UIPluginProps = unknown, UIPluginTypes = unknown>(plugin: (baseDataProviderClass: PluginBaseDataProvider<BaseDataProvider>) => PluginExtendedDataProvider<BaseDataProvider, DataProviderPluginTypes>): DataProviderPlugin<BaseDataProvider, DataProviderPluginTypes, ContextPluginProps, ContextPluginTypes, UIPluginProps, UIPluginTypes>;
+export {};

package/dist/main.d.ts

@@ -8,7 +8,7 @@ export type { ConfigContextValue } from './context';
 export { default as createPlugin } from './createPlugin';
 export type { DataProviderImplementationWithPlugin, DataProviderPlugin, } from './createPlugin';
 export { default as DataProvider, isDataProvider } from './DataProvider';
-export type { ContextPlugin, ContinuousGet, DataProviderImplementation, GenericDataProvider, GenericDataProviderImplementation, GetCallback, InferItem, InferMetaType, InferOptions, InferResponse, InferQuery, Persistence, RequestDetails, ResourceBaseContext, ResourceContextValue, UIPlugin, } from './DataProvider';
+export type { ContextPlugin, ContinuousGet, DataProviderImplementation, GenericDataProvider, GenericDataProviderImplementation, GetCallback, InferContextPluginProps, InferContextPluginTypes, InferItem, InferMetaType, InferOptions, InferQuery, InferResponse, InferUIPluginProps, InferUIPluginTypes, Persistence, RequestDetails, ResourceBaseContext, ResourceContextValue, UIPlugin, } from './DataProvider';
 export { default as Meta } from './Meta';
 export type { InferInstance, InferSchema, MetaLike } from './Meta';
 export { default as Notifier } from './Notifier';