rest-client-vue 1.0.0 → 1.1.0

package/dist/src/rest-collection.d.ts

@@ -111,7 +111,7 @@ export type RestCollectionStoreReadyCallback = (() => void) | (() => Promise<voi
  * resources from one collection endpoint of the REST API; but filters can be added when using a REST API that supports
  * them.
  */
-export interface RestCollection {
+export interface RestCollection<T extends Resource = Resource> {
     /**
      * The REST collection's unique ID, which is used as the ID of its Pinia store.
      *
@@ -139,17 +139,17 @@ export interface RestCollection {
      * An array of resources that have failed validation. The client must manage this list by calling
      * {@link setInvalidResourceIds}
      **/
-    invalidResources: Ref<Resource[]>;
+    invalidResources: Ref<T[]>;
     /** The array of resources that have been loaded from the REST API into the local collection. */
-    resources: Ref<Resource[]>;
+    resources: Ref<T[]>;
     /** Transient data that a client has associated with the resources via {@link setTransientDataForResources}. */
     transientData: Ref<any[]>;
     /** Resources in the current detail view, a sublist of {@link resources}. */
-    detailSelection: Ref<Resource[]>;
+    detailSelection: Ref<T[]>;
     /** A flag indicating whether the detail selection is currently being edited or only displayed. */
     editingDetailSelection: Ref<boolean>;
     /** The current selection, a sublist of {@link resources}. */
-    selection: Ref<Resource[]>;
+    selection: Ref<T[]>;
     /**
      * Apply new configuration options.
      *
@@ -226,14 +226,14 @@ export interface RestCollection {
      *
      * @param resourceDefaults An object containing initial property values for the new resource.
      */
-    addResource: (resourceDefaults?: Resource) => void;
+    addResource: (resourceDefaults?: T) => void;
     checkForDeletedResource: (resourceId: ResourceId) => Promise<boolean>;
     recordDeletion: (resourceId: ResourceId) => void;
-    recordInsertion: (resource: Resource, { insertAtBeginning, transientData }?: {
+    recordInsertion: (resource: T, { insertAtBeginning, transientData }?: {
         insertAtBeginning?: boolean;
         transientData?: any;
     }) => void;
-    recordUpdate: (resource: Resource) => void;
+    recordUpdate: (resource: T) => void;
     /**
      * Refresh one resource by fetching it again from the REST API.
      *
@@ -241,7 +241,7 @@ export interface RestCollection {
      *
      * @param resourceId The ID of the resource to refresh.
      */
-    refreshResource: (resourceId: ResourceId) => Promise<Resource | null | undefined>;
+    refreshResource: (resourceId: ResourceId) => Promise<T | null | undefined>;
     /**
      * Delete one resource.
      *
@@ -260,7 +260,7 @@ export interface RestCollection {
      *
      * @param resource The resource to create or update.
      */
-    saveResource: (resource: Resource) => Promise<Resource | null | undefined>;
+    saveResource: (resource: T) => Promise<T | null | undefined>;
     /**
      * Save multiple resources (new or updated).
      *
@@ -271,7 +271,7 @@ export interface RestCollection {
      *
      * @param params TODO
      */
-    saveResources: (resources: Resource[]) => Promise<Resource[] | undefined>;
+    saveResources: (resources: T[]) => Promise<T[] | undefined>;
     /**
      * Record which resources have failed validation.
      *
@@ -306,6 +306,6 @@ export interface RestCollection {
     }) => void;
     onItemsStoreReady: (callback: RestCollectionStoreReadyCallback) => void;
 }
-declare const _default: (params?: RestCollectionOptions) => RestCollection;
+declare const _default: <T extends object = object>(params?: RestCollectionOptions) => RestCollection<T>;
 export default _default;
 export declare const clearAllRestCollections: () => void;

package/dist/src/rest-resource.d.ts

@@ -56,7 +56,7 @@ export interface MakeCustomApiRequestParams {
  * {@link RestResourceClient} is sometimes useful for consuming individual responses from APIs that are not really
  * RESTful.
  */
-export interface RestResourceClient {
+export interface RestResourceClient<T extends Resource = Resource> {
     /**
      * The REST resource client's unique identifier, which is the ID of its Pinia store.
      *
@@ -77,7 +77,7 @@ export interface RestResourceClient {
     /** A status indicating whether resources have been loaded yet from the REST API. */
     status: Ref<RestResourceStatus>;
     /** The local version of the resource loaded from the REST API. */
-    resource: Ref<Resource>;
+    resource: Ref<T>;
     /** The ID of the REST resource. */
     resourceId: Ref<ResourceId | null>;
     /** The URL of the REST resource. */
@@ -129,12 +129,12 @@ export interface RestResourceClient {
      */
     checkForDeletedResource: () => Promise<boolean>;
     recordDeletion: () => void;
-    recordInsertion: (resource: Resource) => void;
-    recordUpdate: (resource: Resource) => void;
-    refreshResource: () => Promise<Resource | null | undefined>;
+    recordInsertion: (resource: T) => void;
+    recordUpdate: (resource: T) => void;
+    refreshResource: () => Promise<T | null | undefined>;
     deleteResource: () => Promise<void>;
-    saveResource: (resource: Resource) => Promise<Resource | null | undefined>;
+    saveResource: (resource: T) => Promise<T | null | undefined>;
     makeCustomApiRequest: (params: MakeCustomApiRequestParams) => Promise<any>;
 }
-declare const _default: (params?: RestResourceOptions) => RestResourceClient;
+declare const _default: <T extends object = object>(params?: RestResourceOptions) => RestResourceClient<T>;
 export default _default;

package/dist/src/stores/rest-collection-store.d.ts

@@ -321,7 +321,7 @@ declare const makeStore: (storeId: string, options: RestCollectionStoreOptions)
      *   has an ID, an update will be attempted, while otherwise it will be added.
      * @returns An array of refreshed local resources, one for each remote resource whose save operation succeeded.
      */
-    saveResources(resources: Resource[]): Promise<any[]>;
+    saveResources(resources: Resource[]): Promise<Resource[]>;
     /** Clear all transient data. */
     clearTransientData(): void;
     /**
@@ -670,7 +670,7 @@ export declare const storeRegistry: StoreRegistry<import("pinia").Store<string,
      *   has an ID, an update will be attempted, while otherwise it will be added.
      * @returns An array of refreshed local resources, one for each remote resource whose save operation succeeded.
      */
-    saveResources(resources: Resource[]): Promise<any[]>;
+    saveResources(resources: Resource[]): Promise<Resource[]>;
     /** Clear all transient data. */
     clearTransientData(): void;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rest-client-vue",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "author": {
     "name": "Jeremy Stone",
     "email": "stoneje@msn.com"