rest-client-vue 1.1.1-b9 → 1.2.0-b2

package/dist/index.d.ts

@@ -31,7 +31,7 @@ export declare interface ConcreteRestCollectionStoreOptionsInput {
         pageSize?: number | null;
     };
     order?: [any, string][];
-    propertyBlacklist?: string[];
+    propertiesToExclude?: string[];
     referencePathsToExpand?: string[];
     restCollectionUrl?: string | null;
 }
@@ -66,6 +66,8 @@ export declare type Resource = object;
  */
 export declare type ResourceId<T = string | number> = T;
 
+export declare type ResourcePropertyUpdate = object;
+
 /** A subcollection belonging to each resource of a certain type. */
 export declare interface ResourceSubcollection {
     /** The subcollection name, which is used in constructing its path. */
@@ -128,16 +130,17 @@ export declare interface RestCollection<T extends Resource = Resource> {
      */
     resourceType: Ref<ResourceType | undefined>;
     /**
-     * The REST collection URL, either as specified in {@link RestCollectionOptions.options} or calculated from the entity
-     * type and draft batch ID.
-     *
-     * Two special cases arise:
-     * - restCollectionUrl is undefined when the REST collection is configured to use an existing store. (This may be
-     *   addressed in future work.)
-     * - restCollectionUrl is null when the URL could not be calculated because the entity type was missing or lacked a
-     *   REST collection name. In this case the collection will not be functional.
+     * The REST collection URL.
+     *
+     * This is reported by the actual Pinia store. It may be arrived at in three ways:
+     * - It may have been specified in {@link RestCollectionOptions.options}.
+     * - It may have been calculated from the entity type and draft batch ID. This is the most common scenario.
+     * - Or this RestCollection may reference an existing store, in which case the URL was determined by the collection
+     *   that originally created the store.
+     *
+     * It defaults to null when no store is present.
      */
-    restCollectionUrl: Ref<string | null | undefined>;
+    restCollectionUrl: Ref<string | null>;
     /** A status indicating whether resources have been loaded yet from the REST API. */
     status: Ref<RestCollectionStatus>;
     batchSaveAttempted: Ref<boolean>;
@@ -283,6 +286,15 @@ export declare interface RestCollection<T extends Resource = Resource> {
      * @param params TODO
      */
     saveResources: (resources: T[]) => Promise<T[] | undefined>;
+    /**
+     * Partial update of one or more resources.
+     *
+     * If you call this with await, it will return once the API call has completed, and if the APi call succeeded, it will
+     * return the updated items.
+     *
+     * @param resourcePropertyUpdates A list of resource IDs, property paths, values, and update methods to apply.
+     */
+    updateResources: (resourcePropertyUpdates: T[]) => Promise<T[] | undefined>;
     /**
      * Record which resources have failed validation.
      *
@@ -378,7 +390,7 @@ export declare interface RestCollectionStoreOptionsInput {
         pageSize?: number | null;
     };
     order?: [any, string][];
-    propertyBlacklist?: string[] | ((resourceType: ResourceType) => string[]);
+    propertiesToExclude?: string[] | ((resourceType: ResourceType) => string[]);
     referencePathsToExpand?: string[] | ((resourceType: ResourceType) => string[]);
     restCollectionUrl?: string | null;
 }
@@ -470,6 +482,7 @@ export declare interface RestResourceClient<T extends Resource = Resource> {
     refreshResource: () => Promise<T | null | undefined>;
     deleteResource: () => Promise<void>;
     saveResource: (resource: T) => Promise<T | null | undefined>;
+    updateResource: (resourcePropertyUpdates: T[]) => Promise<T | null | undefined>;
     makeCustomApiRequest: (params: MakeCustomApiRequestParams) => Promise<any>;
 }