@civet/core 3.0.1 → 5.0.0

package/dist/DataProvider.d.ts

@@ -6,23 +6,23 @@ import { Constructor } from './utilityTypes';
 export type RequestDetails<Query, Options> = {
     name: string;
     query: Query;
-    empty: boolean;
+    disabled: boolean;
     options: Options | undefined;
 };
-export type ResourceBaseContext<GetResult, Query, Options, MetaType extends Meta> = {
+export type ResourceBaseContext<Response, Query, Options, MetaType extends Meta> = {
     name: string;
     query: Query;
     options: Options | undefined;
     request: string;
     revision: string;
-    data: GetResult;
+    data: Response;
     meta: InferSchema<MetaType>;
     error: Error | undefined;
-    isEmpty: boolean;
+    isDisabled: boolean;
     isIncomplete: boolean;
     isInitial: boolean;
 };
-export type ResourceContextValue<DataProviderI extends GenericDataProvider, GetResultI extends InferGetResult<DataProviderI> = InferGetResult<DataProviderI>, QueryI extends InferQuery<DataProviderI> = InferQuery<DataProviderI>, OptionsI extends InferOptions<DataProviderI> = InferOptions<DataProviderI>, MetaTypeI extends InferMetaType<DataProviderI> = InferMetaType<DataProviderI>> = ResourceBaseContext<GetResultI, QueryI, OptionsI, MetaTypeI> & {
+export type ResourceContextValue<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>> = ResourceBaseContext<ResponseI, QueryI, OptionsI, MetaTypeI> & {
     dataProvider: DataProviderI;
     isLoading: boolean;
     isStale: boolean;
@@ -41,26 +41,17 @@ export type UIPlugin<PluginProps = unknown, PluginTypes = unknown> = React.Compo
     children: (context: ResourceContextValue<GenericDataProvider> & PluginTypes) => ReactNode;
 }>;
 export type Persistence = boolean | 'very';
-export interface GetCallback<GetResult> {
-    (error: undefined, done: boolean, result: GetResult): void;
+export interface GetCallback<Response> {
+    (error: undefined, done: boolean, result: Response): void;
     (error: Error, done: boolean, result: undefined): void;
 }
-export type ContinuousGet<GetResult> = (callback: GetCallback<GetResult>, 
-/** @deprecated Use the `abortSignal` that is provided by `handleGet` instead. */
-abortSignal: AbortSignalProxy) => void;
-export default abstract class DataProvider<Item, Query, Options, MetaType extends Meta = Meta, GetResult extends Item | Item[] = Item | Item[], CreateData = Item, CreateResult = void, UpdateData = Item, UpdateResult = void, PatchData = Partial<Item>, PatchResult = void, RemoveResult = 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[]> {
     readonly _inferItem: Item;
     readonly _inferQuery: Query;
     readonly _inferOptions: Options;
     readonly _inferMetaType: MetaType;
-    readonly _inferGetResult: GetResult;
-    readonly _inferCreateData: CreateData;
-    readonly _inferCreateResult: CreateResult;
-    readonly _inferUpdateData: UpdateData;
-    readonly _inferUpdateResult: UpdateResult;
-    readonly _inferPatchData: PatchData;
-    readonly _inferPatchResult: PatchResult;
-    readonly _inferRemoveResult: RemoveResult;
+    readonly _inferResponse: Response;
     notifier: ChannelNotifier<never[]>;
     readonly contextPlugins: ContextPlugin<unknown, unknown>[];
     readonly uiPlugins: UIPlugin<unknown, unknown>[];
@@ -73,44 +64,25 @@ export default abstract class DataProvider<Item, Query, Options, MetaType extend
     releaseInstance(_: InferInstance<MetaType>): void;
     subscribe(resource: string, callback: () => void): () => void;
     notify(resource: string): void;
-    get<GetResultI extends GetResult = GetResult, QueryI extends Query = Query, OptionsI extends Options = Options, MetaTypeI extends MetaType = MetaType>(resource: string, query: QueryI, options?: OptionsI, meta?: MetaLike<MetaTypeI>, abortSignal?: AbortSignal): Promise<GetResultI>;
-    continuousGet<GetResultI extends GetResult = GetResult, 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<GetResultI>, abortSignal?: AbortSignal): void;
-    abstract handleGet(resource: string, query: Query, options: Options | undefined, meta: MetaType, abortSignal: AbortSignalProxy): Promise<GetResult | ContinuousGet<GetResult>> | GetResult | ContinuousGet<GetResult>;
-    create<CreateResultI extends CreateResult = CreateResult, CreateDataI extends CreateData = CreateData, OptionsI extends Options = Options, MetaTypeI extends MetaType = MetaType>(resource: string, data: CreateDataI, options?: OptionsI, meta?: MetaLike<MetaTypeI>): Promise<CreateResultI>;
-    abstract handleCreate(resource: string, data: CreateData, options: Options | undefined, meta: MetaType): Promise<CreateResult> | CreateResult;
-    update<UpdateResultI extends UpdateResult = UpdateResult, QueryI extends Query = Query, UpdateDataI extends UpdateData = UpdateData, OptionsI extends Options = Options, MetaTypeI extends MetaType = MetaType>(resource: string, query: QueryI, data: UpdateDataI, options?: OptionsI, meta?: MetaLike<MetaTypeI>): Promise<UpdateResultI>;
-    abstract handleUpdate(resource: string, query: Query, data: UpdateData, options: Options | undefined, meta: MetaType): Promise<UpdateResult> | UpdateResult;
-    patch<PatchResultI extends PatchResult = PatchResult, QueryI extends Query = Query, PatchDataI extends PatchData = PatchData, OptionsI extends Options = Options, MetaTypeI extends MetaType = MetaType>(resource: string, query: QueryI, data: PatchDataI, options?: OptionsI, meta?: MetaLike<MetaTypeI>): Promise<PatchResultI>;
-    abstract handlePatch(resource: string, query: Query, data: PatchData, options: Options | undefined, meta: MetaType): Promise<PatchResult> | PatchResult;
-    remove<RemoveResultI extends RemoveResult = RemoveResult, QueryI extends Query = Query, OptionsI extends Options = Options, MetaTypeI extends MetaType = MetaType>(resource: string, query: QueryI, options?: OptionsI, meta?: MetaLike<MetaTypeI>): Promise<RemoveResultI>;
-    abstract handleRemove(resource: string, query: Query, options: Options | undefined, meta: MetaType): Promise<RemoveResult> | RemoveResult;
+    get<ResponseI extends Response = Response, QueryI extends Query = Query, OptionsI extends Options = Options, MetaTypeI extends MetaType = MetaType>(resource: string, query: QueryI, options?: OptionsI, meta?: MetaLike<MetaTypeI>, abortSignal?: AbortSignal): Promise<ResponseI>;
+    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>): GetResult;
-    shouldPersist(nextRequestDetails: RequestDetails<Query, Options>, prevRequestDetails: RequestDetails<Query, Options>, persistent: Persistence, _context: ResourceBaseContext<GetResult, Query, Options, MetaType>): boolean;
+    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;
-    transition(nextContext: ResourceBaseContext<GetResult, Query, Options, MetaType>, _prevContext: ResourceBaseContext<GetResult, Query, Options, MetaType>): GetResult;
-    recycleItems(nextContext: ResourceBaseContext<GetResult, Query, Options, MetaType>, prevContext: ResourceBaseContext<GetResult, Query, Options, MetaType>): GetResult;
+    transition(nextContext: ResourceBaseContext<Response, Query, Options, MetaType>, _prevContext: ResourceBaseContext<Response, Query, Options, MetaType>): Response;
+    recycleItems(nextContext: ResourceBaseContext<Response, Query, Options, MetaType>, prevContext: ResourceBaseContext<Response, Query, Options, MetaType>): Response;
 }
 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<InferGetResult<DataProviderI> | ContinuousGet<InferGetResult<DataProviderI>>> | InferGetResult<DataProviderI> | ContinuousGet<InferGetResult<DataProviderI>>;
-    handleCreate(resource: string, data: InferCreateData<DataProviderI>, options: InferOptions<DataProviderI> | undefined, meta: InferMetaType<DataProviderI>): Promise<InferCreateResult<DataProviderI>> | InferCreateResult<DataProviderI>;
-    handleUpdate(resource: string, query: InferQuery<DataProviderI>, data: InferUpdateData<DataProviderI>, options: InferOptions<DataProviderI> | undefined, meta: InferMetaType<DataProviderI>): Promise<InferUpdateResult<DataProviderI>> | InferUpdateResult<DataProviderI>;
-    handlePatch(resource: string, query: InferQuery<DataProviderI>, data: InferPatchData<DataProviderI>, options: InferOptions<DataProviderI> | undefined, meta: InferMetaType<DataProviderI>): Promise<InferPatchResult<DataProviderI>> | InferPatchResult<DataProviderI>;
-    handleRemove(resource: string, query: InferQuery<DataProviderI>, options: InferOptions<DataProviderI> | undefined, meta: InferMetaType<DataProviderI>): Promise<InferRemoveResult<DataProviderI>> | InferRemoveResult<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, unknown, unknown, unknown, unknown, unknown, unknown, unknown>;
+export type GenericDataProvider = DataProvider<unknown, unknown, unknown, Meta, 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 InferGetResult<DataProviderI extends GenericDataProvider> = DataProviderI['_inferGetResult'];
-export type InferCreateData<DataProviderI extends GenericDataProvider> = DataProviderI['_inferCreateData'];
-export type InferCreateResult<DataProviderI extends GenericDataProvider> = DataProviderI['_inferCreateResult'];
-export type InferUpdateData<DataProviderI extends GenericDataProvider> = DataProviderI['_inferUpdateData'];
-export type InferUpdateResult<DataProviderI extends GenericDataProvider> = DataProviderI['_inferUpdateResult'];
-export type InferPatchData<DataProviderI extends GenericDataProvider> = DataProviderI['_inferPatchData'];
-export type InferPatchResult<DataProviderI extends GenericDataProvider> = DataProviderI['_inferPatchResult'];
-export type InferRemoveResult<DataProviderI extends GenericDataProvider> = DataProviderI['_inferRemoveResult'];
+export type InferResponse<DataProviderI extends GenericDataProvider> = DataProviderI['_inferResponse'];

package/dist/Resource.d.ts

@@ -1,5 +1,5 @@
 import { ReactNode } from 'react';
-import { GenericDataProvider, InferGetResult, InferMetaType, InferOptions, InferQuery, Persistence } from './DataProvider';
+import { GenericDataProvider, InferResponse, InferMetaType, InferOptions, InferQuery, Persistence } from './DataProvider';
 /**
  * Provides data based on the given request details and DataProvider.
  * Context provider for the ResourceContext.
@@ -8,7 +8,7 @@ import { GenericDataProvider, InferGetResult, InferMetaType, InferOptions, Infer
  *
  * The provided DataProvider must not be changed.
  */
-export default function Resource<DataProviderI extends GenericDataProvider, GetResultI extends InferGetResult<DataProviderI> = InferGetResult<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,7 +16,7 @@ export default function Resource<DataProviderI extends GenericDataProvider, GetR
     /** 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" */

package/dist/ResourceProvider.d.ts

@@ -1,5 +1,5 @@
 import { PropsWithChildren, ReactNode } from 'react';
-import { GenericDataProvider, InferGetResult, InferMetaType, InferOptions, InferQuery, ResourceContextValue } from './DataProvider';
-export default function ResourceProvider<DataProviderI extends GenericDataProvider, GetResultI extends InferGetResult<DataProviderI> = InferGetResult<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, GetResultI, QueryI, OptionsI, MetaTypeI>;
+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;

package/dist/context.d.ts

@@ -1,5 +1,5 @@
 import { ConsumerProps, ExoticComponent, ReactNode } from 'react';
-import { GenericDataProvider, InferGetResult, InferMetaType, InferOptions, InferQuery, ResourceContextValue } from './DataProvider';
+import { GenericDataProvider, InferResponse, InferMetaType, InferOptions, InferQuery, ResourceContextValue } from './DataProvider';
 export type ConfigContextValue<DataProviderI extends GenericDataProvider> = {
     dataProvider?: DataProviderI;
 };
@@ -10,6 +10,6 @@ export declare const ConfigConsumer: ExoticComponent<GenericDataProvider> & {
 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, GetResultI extends InferGetResult<DataProviderI> = InferGetResult<DataProviderI>, QueryI extends InferQuery<DataProviderI> = InferQuery<DataProviderI>, OptionsI extends InferOptions<DataProviderI> = InferOptions<DataProviderI>, MetaTypeI extends InferMetaType<DataProviderI> = InferMetaType<DataProviderI>>(props: ConsumerProps<ResourceContextValue<DataProviderI, GetResultI, QueryI, OptionsI, MetaTypeI>>): ReactNode;
+    <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 useResourceContext: <DataProviderI extends GenericDataProvider, GetResultI extends InferGetResult<DataProviderI> = InferGetResult<DataProviderI>, QueryI extends InferQuery<DataProviderI> = InferQuery<DataProviderI>, OptionsI extends InferOptions<DataProviderI> = InferOptions<DataProviderI>, MetaTypeI extends InferMetaType<DataProviderI> = InferMetaType<DataProviderI>>() => ResourceContextValue<DataProviderI, GetResultI, QueryI, OptionsI, MetaTypeI>;
+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>;

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, InferCreateData, InferCreateResult, InferGetResult, InferItem, InferMetaType, InferOptions, InferPatchData, InferPatchResult, InferQuery, InferRemoveResult, InferUpdateData, InferUpdateResult, Persistence, RequestDetails, ResourceBaseContext, ResourceContextValue, UIPlugin, } from './DataProvider';
+export type { ContextPlugin, ContinuousGet, DataProviderImplementation, GenericDataProvider, GenericDataProviderImplementation, GetCallback, InferItem, InferMetaType, InferOptions, InferResponse, InferQuery, 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';