@tanglemedia/svelte-starter-directus-api 2.0.2 → 2.0.4

package/dist/adapter/api-adapter.d.ts

@@ -1,7 +1,11 @@
 import { type AllCollections, type DirectusClient, type RegularCollections, type RestClient } from '@directus/sdk';
-import { ApiAdapterAbstract, type AnyObject, type ApiAdapterRequestConfig, type ApiCreateManyQuery, type ApiDeleteManyQuery, type ApiId, type ApiResponse, type ApiUpdateManyQuery, type BaseApiMethods } from '@tanglemedia/svelte-starter-core';
+import { ApiAdapterAbstract, type AnyObject, type ApiAdapterRequestConfig, type ApiAggregateQuery, type ApiCreateManyQuery, type ApiDeleteManyQuery, type ApiFindQuery, type ApiId, type ApiResponse, type ApiUpdateManyQuery, type BaseApiMethods } from '@tanglemedia/svelte-starter-core';
 import type { DirectusConfig, SchemaShape } from '../types/adapter.types';
 export type AdapterClient<Schema extends SchemaShape = SchemaShape> = DirectusClient<Schema> & RestClient<Schema>;
+/**
+ * TODO: Various types fixes. The current adapter doesn't correctly follow the types defined under the ApiAdapterAbstract.
+ * See the fetch adapter under the core
+ */
 export declare class DirectusApiAdapter<Schema extends SchemaShape = SchemaShape, Path extends RegularCollections<Schema> = RegularCollections<Schema>> extends ApiAdapterAbstract<DirectusConfig, ApiAdapterRequestConfig, Path, AdapterClient> {
     protected config: DirectusConfig;
     private readonly directus;
@@ -14,20 +18,20 @@ export declare class DirectusApiAdapter<Schema extends SchemaShape = SchemaShape
         total: number;
         displayed: number;
     };
-    includeTotals(collection: AllCollections<Schema>, filter?: Record<string, unknown>): Promise<number | null>;
+    includeTotals(collection: AllCollections<Schema>, query?: ApiFindQuery<any>): Promise<number | null>;
     transformResponse<T, M extends object = AnyObject>(res: {
         data: T;
         meta?: AnyObject;
     }, status?: number): Promise<ApiResponse<T, Response, M>>;
     getConfig(configuration?: unknown): DirectusConfig;
     request<T>(method: BaseApiMethods, url: string, query?: Record<string, unknown>): Promise<T>;
-    find<T>(collection: Path, query?: Record<string, unknown>): Promise<ApiResponse<T>>;
+    find<T, Q = T, R = T>(collection: Path, query: ApiFindQuery<Q>): Promise<ApiResponse<R[]>>;
     findOne<T>(collection: Path, key?: ApiId, query?: Record<string, unknown>): Promise<ApiResponse<T>>;
-    aggregate<T>(collection: Path, query?: Record<string, unknown>): Promise<ApiResponse<T>>;
+    aggregate<T, Q = T, R = T>(collection: Path, query: ApiAggregateQuery<Q>): Promise<ApiResponse<R>>;
     patch<T>(collection: Path, key: ApiId, query?: Record<string, unknown>): Promise<ApiResponse<T>>;
     post<T>(collection: Path, data: AnyObject, query?: Record<string, unknown>): Promise<ApiResponse<T>>;
     delete<T>(collection: Path, key?: ApiId): Promise<ApiResponse<T>>;
-    put<T>(collection: Path, key?: ApiId, payload?: AnyObject): Promise<ApiResponse<T>>;
+    put<T extends object, R = T>(collection: Path, key?: ApiId, payload?: AnyObject): Promise<ApiResponse<R>>;
     upload<T>(path: string | undefined, data: FormData): Promise<ApiResponse<T>>;
     createMany<T, R = T>(path: Path, body: ApiCreateManyQuery<T>): Promise<ApiResponse<R[], Response, AnyObject>>;
     updateMany<T, R = T>(path: Path, body: ApiUpdateManyQuery<T>): Promise<ApiResponse<R[], Response, AnyObject>>;

package/dist/adapter/api-adapter.js

@@ -1,5 +1,9 @@
 import { aggregate, createItem, createItems, deleteItem, deleteItems, readItem, readItems, updateItem, updateItems, uploadFiles } from '@directus/sdk';
 import { ApiAdapterAbstract } from '@tanglemedia/svelte-starter-core';
+/**
+ * TODO: Various types fixes. The current adapter doesn't correctly follow the types defined under the ApiAdapterAbstract.
+ * See the fetch adapter under the core
+ */
 export class DirectusApiAdapter extends ApiAdapterAbstract {
     config;
     directus;
@@ -25,13 +29,17 @@ export class DirectusApiAdapter extends ApiAdapterAbstract {
         // consider pulling count based on existing filters in order to determine pagination
         return { total, displayed };
     }
-    async includeTotals(collection, filter) {
+    async includeTotals(collection, query) {
         if (true !== this.config.configuration.includeTotals) {
             return null;
         }
+        const { filter, search } = query || {};
         const data = await this.directus.request(aggregate(collection, {
             aggregate: { count: '*' },
-            query: { filter }
+            query: {
+                ...(filter ? { filter } : {}),
+                ...(search ? { search } : {}),
+            }
         }));
         if (data && data.length === 1) {
             return Number(data[0].count);
@@ -74,7 +82,7 @@ export class DirectusApiAdapter extends ApiAdapterAbstract {
     }
     async find(collection, query) {
         const response = await this.directus.request(readItems(collection, query));
-        const total = await this.includeTotals(collection, query.filter);
+        const total = await this.includeTotals(collection, query);
         if (null === total) {
             return this.transformResponse({ data: response });
         }
@@ -86,11 +94,12 @@ export class DirectusApiAdapter extends ApiAdapterAbstract {
         return this.transformResponse({ data });
     }
     async aggregate(collection, query) {
+        const { aggregate: aggregate_, ...rest } = (query || {});
         const data = await this.directus.request(aggregate(collection, {
-            aggregate: {
+            aggregate: aggregate_ ? aggregate_ : {
                 count: 'id'
             },
-            query
+            query: rest
         }));
         return this.transformResponse({ data });
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanglemedia/svelte-starter-directus-api",
-  "version": "2.0.2",
+  "version": "2.0.4",
   "main": "src/index.ts",
   "types": "src/index.ts",
   "description": "directus API wrapper for all the directus sdk functionality",

package/src/adapter/api-adapter.ts

@@ -18,8 +18,10 @@ import {
   ApiAdapterAbstract,
   type AnyObject,
   type ApiAdapterRequestConfig,
+  type ApiAggregateQuery,
   type ApiCreateManyQuery,
   type ApiDeleteManyQuery,
+  type ApiFindQuery,
   type ApiId,
   type ApiResponse,
   type ApiUpdateManyQuery,
@@ -30,6 +32,10 @@ import type { DirectusConfig, SchemaShape } from '../types/adapter.types';
 export type AdapterClient<Schema extends SchemaShape = SchemaShape> = DirectusClient<Schema> &
   RestClient<Schema>;
 
+/**
+ * TODO: Various types fixes. The current adapter doesn't correctly follow the types defined under the ApiAdapterAbstract. 
+ * See the fetch adapter under the core
+ */
 export class DirectusApiAdapter<
   Schema extends SchemaShape = SchemaShape,
   Path extends RegularCollections<Schema> = RegularCollections<Schema>
@@ -65,14 +71,19 @@ export class DirectusApiAdapter<
     return { total, displayed };
   }
 
-  async includeTotals(collection: AllCollections<Schema>, filter?: Record<string, unknown>) {
+  async includeTotals(collection: AllCollections<Schema>, query?: ApiFindQuery<any>) {
     if (true !== this.config.configuration.includeTotals) {
       return null;
     }
 
+    const { filter, search } = query || {};
+
     const data = await this.directus.request(aggregate(collection, {
       aggregate: { count: '*' },
-      query: { filter }
+      query: {
+        ...(filter ? { filter } : {}),
+        ...(search ? { search } : {}),
+      }
     }));
 
     if (data && data.length === 1) {
@@ -130,9 +141,9 @@ export class DirectusApiAdapter<
     }
   }
 
-  public async find<T>(collection: Path, query?: Record<string, unknown>): Promise<ApiResponse<T>> {
-    const response = await this.directus.request<T>(readItems(collection, query));
-    const total = await this.includeTotals(collection, query.filter);
+  public async find<T, Q = T, R = T>(collection: Path, query: ApiFindQuery<Q>): Promise<ApiResponse<R[]>> {
+    const response = await this.directus.request<T>(readItems(collection, query)) as R[];
+    const total = await this.includeTotals(collection, query);
     if (null === total) {
       return this.transformResponse({ data: response });
     }
@@ -150,18 +161,21 @@ export class DirectusApiAdapter<
     return this.transformResponse({ data });
   }
 
-  public async aggregate<T>(
+  public async aggregate<T, Q = T, R = T>(
     collection: Path,
-    query?: Record<string, unknown>
-  ): Promise<ApiResponse<T>> {
+    query: ApiAggregateQuery<Q>
+  ): Promise<ApiResponse<R>> {
+    const { aggregate: aggregate_, ...rest } = (query || {});
+
     const data = await this.directus.request<T>(
       aggregate(collection, {
-        aggregate: {
+        aggregate: aggregate_ ? aggregate_ : {
           count: 'id'
         },
-        query
+        query: rest
       })
     );
+
     return this.transformResponse({ data });
   }
 
@@ -188,9 +202,9 @@ export class DirectusApiAdapter<
     return this.transformResponse({ data }, 202);
   }
 
-  public async put<T>(collection: Path, key?: ApiId, payload?: AnyObject): Promise<ApiResponse<T>> {
+  public async put<T extends object, R = T>(collection: Path, key?: ApiId, payload?: AnyObject): Promise<ApiResponse<R>> {
     if (key) {
-      const data = await this.directus.request<T>(updateItem(collection, key, payload));
+      const data = await this.directus.request<T>(updateItem(collection, key, payload)) as R;
       return this.transformResponse({ data }, 201);
     } else {
       console.error(`Error updating all ${collection}: no key specified`);