@tanglemedia/svelte-starter-directus-api 2.0.0 → 2.0.1

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

@@ -1,14 +1,24 @@
-import { type DirectusClient, type RestClient } from '@directus/sdk';
+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 type { DirectusConfig, SchemaShape } from '../types/adapter.types';
 export type AdapterClient<Schema extends SchemaShape = SchemaShape> = DirectusClient<Schema> & RestClient<Schema>;
-export declare class DirectusApiAdapter<Schema extends SchemaShape = SchemaShape, Path extends string = keyof SchemaShape> extends ApiAdapterAbstract<DirectusConfig, ApiAdapterRequestConfig, Path, AdapterClient> {
+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;
     constructor(config: DirectusConfig, directus: AdapterClient<Schema>);
     getAdapterClient(): AdapterClient<Schema> | null;
-    normalizeMeta(payload: AnyObject): AnyObject;
-    transformResponse<T, M extends object = AnyObject>(res: T, status?: number): Promise<ApiResponse<T, Response, M>>;
+    normalizeMeta(response: AnyObject): {
+        total?: undefined;
+        displayed?: undefined;
+    } | {
+        total: number;
+        displayed: number;
+    };
+    includeTotals(collection: AllCollections<Schema>, filters?: Record<string, unknown>): 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>>;

package/dist/adapter/api-adapter.js

@@ -11,17 +11,36 @@ export class DirectusApiAdapter extends ApiAdapterAbstract {
     getAdapterClient() {
         return this.directus;
     }
-    normalizeMeta(payload) {
+    normalizeMeta(response) {
+        const payload = response.data, meta = response.meta;
+        if (!meta) {
+            return {};
+        }
+        if (typeof meta.total === 'undefined') {
+            return {};
+        }
+        const displayed = Array.isArray(payload) ? payload.length : 0;
+        const total = Number(meta.total);
         // todo: Transform or attempt to get meta information
         // consider pulling count based on existing filters in order to determine pagination
-        return payload;
+        return { total, displayed };
+    }
+    async includeTotals(collection, filters) {
+        if (true !== this.config.configuration.includeTotals) {
+            return null;
+        }
+        const data = await this.directus.request(aggregate(collection, {
+            aggregate: { count: '*' },
+            filters: filters || {}
+        }));
+        if (data && data.length === 1) {
+            return Number(data[0].count);
+        }
+        return 0;
     }
     async transformResponse(res, status = 200) {
-        // const payload = (await res.json()) as T;
         return {
-            body: await this.envelopeResponse(res.data || res
-            // this.normalizeMeta(payload as AnyObject) as M
-            ),
+            body: await this.envelopeResponse(res.data, (res.meta ? this.normalizeMeta(res) : {})),
             status: status,
             statusText: 'OK',
             headers: {},
@@ -33,7 +52,7 @@ export class DirectusApiAdapter extends ApiAdapterAbstract {
         // Add the 'configuration' property to the returned object
         const config = {
             ...this.config,
-            configuration: configuration ?? {} // Use the provided configuration or an empty object if not provided
+            configuration: configuration ?? this.config.configuration ?? {} // Use the provided configuration or an empty object if not provided
         };
         return Object.assign(client, config);
     }
@@ -55,37 +74,42 @@ export class DirectusApiAdapter extends ApiAdapterAbstract {
     }
     async find(collection, query) {
         const response = await this.directus.request(readItems(collection, query));
-        return this.transformResponse(response);
+        const total = await this.includeTotals(collection, query.filter);
+        if (null === total) {
+            return this.transformResponse({ data: response });
+        }
+        // console.log('find meta', response, total)
+        return this.transformResponse({ data: response, meta: { total } });
     }
     async findOne(collection, key, query) {
-        const response = await this.directus.request(readItem(collection, key, query));
-        return this.transformResponse(response);
+        const data = await this.directus.request(readItem(collection, key, query));
+        return this.transformResponse({ data });
     }
     async aggregate(collection, query) {
-        const response = await this.directus.request(aggregate(collection, {
+        const data = await this.directus.request(aggregate(collection, {
             aggregate: {
                 count: 'id'
             },
             query
         }));
-        return this.transformResponse(response);
+        return this.transformResponse({ data });
     }
     async patch(collection, key, query) {
-        const response = await this.directus.request(updateItem(collection, key, query));
-        return this.transformResponse(response);
+        const data = await this.directus.request(updateItem(collection, key, query));
+        return this.transformResponse({ data });
     }
     async post(collection, data, query) {
         const response = await this.directus.request(createItem(collection, data, query));
-        return this.transformResponse(response, 201);
+        return this.transformResponse({ data: response }, 201);
     }
     async delete(collection, key) {
-        const response = await this.directus.request(deleteItem(collection, key));
-        return this.transformResponse(response, 202);
+        const data = await this.directus.request(deleteItem(collection, key));
+        return this.transformResponse({ data }, 202);
     }
     async put(collection, key, payload) {
         if (key) {
-            const response = await this.directus.request(updateItem(collection, key, payload));
-            return this.transformResponse(response, 201);
+            const data = await this.directus.request(updateItem(collection, key, payload));
+            return this.transformResponse({ data }, 201);
         }
         else {
             console.error(`Error updating all ${collection}: no key specified`);
@@ -95,21 +119,21 @@ export class DirectusApiAdapter extends ApiAdapterAbstract {
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     async upload(path = '', data) {
         const response = await this.directus.request(uploadFiles(data));
-        return this.transformResponse(response, 201);
+        return this.transformResponse({ data: response }, 201);
     }
     async createMany(path, body) {
-        const response = await this.directus.request(createItems(path, body.data));
-        return this.transformResponse(response, 200);
+        const data = await this.directus.request(createItems(path, body.data));
+        return this.transformResponse({ data }, 200);
     }
     async updateMany(path, body) {
         if (!body.ids) {
             throw Error('You must provide an array of keys to update');
         }
-        const response = await this.directus.request(updateItems(path, body.ids || [], body.data));
-        return this.transformResponse(response, 200);
+        const data = await this.directus.request(updateItems(path, body.ids || [], body.data));
+        return this.transformResponse({ data }, 200);
     }
     async deleteMany(path, body) {
-        const response = await this.directus.request(deleteItems(path, body.ids));
-        return this.transformResponse(response, 201);
+        const data = await this.directus.request(deleteItems(path, body.ids));
+        return this.transformResponse({ data }, 201);
     }
 }

package/dist/types/adapter.types.d.ts

@@ -18,6 +18,7 @@ export type DirectusApiAdapterOptions = {
     rest?: {
         credentials?: RequestCredentials;
     };
+    includeTotals?: boolean;
 };
 export type DirectusConfig = BaseApiAdapterConfig<DirectusApiAdapterOptions>;
 export type SchemaShape = Record<string, object>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanglemedia/svelte-starter-directus-api",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "main": "src/index.ts",
   "types": "src/index.ts",
   "description": "directus API wrapper for all the directus sdk functionality",
@@ -22,6 +22,7 @@
     }
   },
   "devDependencies": {
+    "@directus/types": "^12.0.0",
     "@sveltejs/adapter-auto": "^3.2.4",
     "@sveltejs/package": "^2.3.4",
     "@sveltejs/vite-plugin-svelte": "^3.1.2",
@@ -35,7 +36,7 @@
     "vite": "^5.4.2",
     "vitest": "^2.0.5",
     "@internal/eslint-config": "0.0.0",
-    "@tanglemedia/svelte-starter-core": "0.2.0"
+    "@tanglemedia/svelte-starter-core": "0.2.1"
   },
   "dependencies": {
     "@directus/sdk": "^17.0.0",
@@ -45,7 +46,7 @@
   },
   "peerDependencies": {
     "@sveltejs/kit": ">=2 <3",
-    "@tanglemedia/svelte-starter-core": ">=0.2.0",
+    "@tanglemedia/svelte-starter-core": ">=0.2.1",
     "svelte": ">=4 <5"
   },
   "scripts": {

package/src/adapter/api-adapter.ts

@@ -9,7 +9,9 @@ import {
   updateItem,
   updateItems,
   uploadFiles,
+  type AllCollections,
   type DirectusClient,
+  type RegularCollections,
   type RestClient
 } from '@directus/sdk';
 import {
@@ -30,7 +32,7 @@ export type AdapterClient<Schema extends SchemaShape = SchemaShape> = DirectusCl
 
 export class DirectusApiAdapter<
   Schema extends SchemaShape = SchemaShape,
-  Path extends string = keyof SchemaShape
+  Path extends RegularCollections<Schema> = RegularCollections<Schema>
 > extends ApiAdapterAbstract<DirectusConfig, ApiAdapterRequestConfig, Path, AdapterClient> {
   constructor(
     protected config: DirectusConfig,
@@ -43,22 +45,51 @@ export class DirectusApiAdapter<
     return this.directus;
   }
 
-  normalizeMeta(payload: AnyObject) {
+  normalizeMeta(response: AnyObject) {
+    const payload = response.data, meta = response.meta as Record<string, unknown>;
+
+    if (!meta) {
+      return {};
+    }
+
+    if (typeof meta.total === 'undefined') {
+      return {};
+    }
+
+    const displayed = Array.isArray(payload) ? payload.length : 0;
+
+    const total = Number(meta.total);
+
     // todo: Transform or attempt to get meta information
     // consider pulling count based on existing filters in order to determine pagination
-    return payload;
+    return { total, displayed };
+  }
+
+  async includeTotals(collection: AllCollections<Schema>, filters?: Record<string, unknown>) {
+    if (true !== this.config.configuration.includeTotals) {
+      return null;
+    }
+
+    const data = await this.directus.request(aggregate(collection, {
+      aggregate: { count: '*' },
+      filters: filters || {}
+    }));
+
+    if (data && data.length === 1) {
+      return Number(data[0].count);
+    }
+
+    return 0;
   }
 
   async transformResponse<T, M extends object = AnyObject>(
-    res: T,
+    res: {data: T, meta?: AnyObject},
     status: number = 200
   ): Promise<ApiResponse<T, Response, M>> {
-    // const payload = (await res.json()) as T;
-
     return {
       body: await this.envelopeResponse<T, M>(
-        res.data || res
-        // this.normalizeMeta(payload as AnyObject) as M
+        res.data,
+        (res.meta ? this.normalizeMeta(res as AnyObject) : {}) as M
       ),
       status: status,
       statusText: 'OK',
@@ -73,7 +104,7 @@ export class DirectusApiAdapter<
     // Add the 'configuration' property to the returned object
     const config: DirectusConfig = {
       ...this.config,
-      configuration: configuration ?? {} // Use the provided configuration or an empty object if not provided
+      configuration: configuration ?? this.config.configuration ?? {} // Use the provided configuration or an empty object if not provided
     };
 
     return Object.assign(client, config);
@@ -101,7 +132,13 @@ 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));
-    return this.transformResponse(response);
+    const total = await this.includeTotals(collection, query.filter);
+    if (null === total) {
+      return this.transformResponse({ data: response });
+    }
+    // console.log('find meta', response, total)
+
+    return this.transformResponse({ data: response, meta: { total } });
   }
 
   public async findOne<T>(
@@ -109,15 +146,15 @@ export class DirectusApiAdapter<
     key?: ApiId,
     query?: Record<string, unknown>
   ): Promise<ApiResponse<T>> {
-    const response = await this.directus.request<T>(readItem(collection, key, query));
-    return this.transformResponse(response);
+    const data = await this.directus.request<T>(readItem(collection, key, query));
+    return this.transformResponse({ data });
   }
 
   public async aggregate<T>(
     collection: Path,
     query?: Record<string, unknown>
   ): Promise<ApiResponse<T>> {
-    const response = await this.directus.request<T>(
+    const data = await this.directus.request<T>(
       aggregate(collection, {
         aggregate: {
           count: 'id'
@@ -125,7 +162,7 @@ export class DirectusApiAdapter<
         query
       })
     );
-    return this.transformResponse(response);
+    return this.transformResponse({ data });
   }
 
   public async patch<T>(
@@ -133,8 +170,8 @@ export class DirectusApiAdapter<
     key: ApiId,
     query?: Record<string, unknown>
   ): Promise<ApiResponse<T>> {
-    const response = await this.directus.request<T>(updateItem(collection, key, query));
-    return this.transformResponse(response);
+    const data = await this.directus.request<T>(updateItem(collection, key, query));
+    return this.transformResponse({ data });
   }
 
   public async post<T>(
@@ -143,18 +180,18 @@ export class DirectusApiAdapter<
     query?: Record<string, unknown>
   ): Promise<ApiResponse<T>> {
     const response = await this.directus.request<T>(createItem(collection, data, query));
-    return this.transformResponse(response, 201);
+    return this.transformResponse({ data: response }, 201);
   }
 
   public async delete<T>(collection: Path, key?: ApiId): Promise<ApiResponse<T>> {
-    const response = await this.directus.request<T>(deleteItem(collection, key));
-    return this.transformResponse(response, 202);
+    const data = await this.directus.request<T>(deleteItem(collection, key));
+    return this.transformResponse({ data }, 202);
   }
 
   public async put<T>(collection: Path, key?: ApiId, payload?: AnyObject): Promise<ApiResponse<T>> {
     if (key) {
-      const response = await this.directus.request<T>(updateItem(collection, key, payload));
-      return this.transformResponse(response, 201);
+      const data = await this.directus.request<T>(updateItem(collection, key, payload));
+      return this.transformResponse({ data }, 201);
     } else {
       console.error(`Error updating all ${collection}: no key specified`);
       throw new Error('No key specified');
@@ -164,24 +201,24 @@ export class DirectusApiAdapter<
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   public async upload<T>(path: string = '', data: FormData): Promise<ApiResponse<T>> {
     const response = await this.directus.request<T>(uploadFiles(data));
-    return this.transformResponse(response, 201);
+    return this.transformResponse({ data: response }, 201);
   }
 
   async createMany<T, R = T>(path: Path, body: ApiCreateManyQuery<T>) {
-    const response = await this.directus.request<T>(createItems(path, body.data));
-    return this.transformResponse<R[]>(response, 200);
+    const data = await this.directus.request<T>(createItems(path, body.data));
+    return this.transformResponse<R[]>({ data }, 200);
   }
 
   async updateMany<T, R = T>(path: Path, body: ApiUpdateManyQuery<T>) {
     if (!body.ids) {
       throw Error('You must provide an array of keys to update');
     }
-    const response = await this.directus.request<T>(updateItems(path, body.ids || [], body.data));
-    return this.transformResponse<R[]>(response, 200);
+    const data = await this.directus.request<T>(updateItems(path, body.ids || [], body.data));
+    return this.transformResponse<R[]>({ data }, 200);
   }
 
   async deleteMany<R = null>(path: Path, body: ApiDeleteManyQuery<ApiId>) {
-    const response = await this.directus.request(deleteItems(path, body.ids));
-    return this.transformResponse<R>(response as R, 201);
+    const data = await this.directus.request(deleteItems(path, body.ids));
+    return this.transformResponse<R>({ data } as R, 201);
   }
 }

package/src/types/adapter.types.ts

@@ -23,6 +23,8 @@ export type DirectusApiAdapterOptions = {
   rest?: {
     credentials?: RequestCredentials;
   };
+
+  includeTotals?: boolean;
 };
 
 export type DirectusConfig = BaseApiAdapterConfig<DirectusApiAdapterOptions>;