@civet/core 4.0.0 → 5.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;
 };
@@ -68,7 +68,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;

package/dist/Resource.d.ts

@@ -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,7 +16,7 @@ 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" */