@tanglemedia/svelte-starter-directus-api 2.1.0 → 4.0.0

package/README.md

@@ -1,4 +1,4 @@
-# Directus-api
+# [@tanglemedia/svelte-starter-directus-api](https://tanglemedia-svelte-docs.netlify.app/docs/directus-api-package/functionality)
 
 <p align="center" style="align: center;">
   <a href="https://npm.im/@tanglemedia/svelte-starter-directus-api">
@@ -260,3 +260,4 @@ export const formsServiceClient = configureService<FormInterface>(Forms, {
   adapterKey: 'directus-client'
 });
 ```
+### For mode demos and to check out all the components, please visit our [documentation website](https://tanglemedia-svelte-docs.netlify.app/docs/directus-api-package/functionality)

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

@@ -1,15 +1,16 @@
 import { type AllCollections, type DirectusClient, type RegularCollections, type RestClient } from '@directus/sdk';
-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 { ApiAdapterAbstract, type AnyObject, type ApiAdapterHandle, type ApiAdapterRequestConfig, type ApiAggregateQuery, type ApiCreateManyQuery, type ApiDeleteManyQuery, type ApiFindQuery, type ApiId, type ApiResponse, type ApiUpdateManyQuery, type BaseApiMethods, type HandleEvent } 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> {
+export declare class DirectusApiAdapter<Schema extends SchemaShape = SchemaShape, Path extends RegularCollections<Schema> = RegularCollections<Schema>> extends ApiAdapterAbstract<DirectusConfig, ApiAdapterRequestConfig, Path, AdapterClient> implements ApiAdapterHandle {
     protected config: DirectusConfig;
     private readonly directus;
     constructor(config: DirectusConfig, directus: AdapterClient<Schema>);
+    handle(event: HandleEvent): Promise<void>;
     getAdapterClient(): AdapterClient<Schema> | null;
     normalizeMeta(response: AnyObject): {
         total?: undefined;

package/dist/adapter/api-adapter.js

@@ -12,6 +12,10 @@ export class DirectusApiAdapter extends ApiAdapterAbstract {
         this.config = config;
         this.directus = directus;
     }
+    async handle(event) {
+        const f = event.fetch;
+        this.directus.globals.fetch = f;
+    }
     getAdapterClient() {
         return this.directus;
     }
@@ -34,11 +38,14 @@ export class DirectusApiAdapter extends ApiAdapterAbstract {
             return null;
         }
         const { filter, search } = query || {};
+        // default to countDistinct. Note that there is a bug in directus where
+        // the wrong counts are being returned if there are nested filters.
+        const k = this.config.configuration.totalAggregate || 'countDistinct';
         const data = await this.directus.request(aggregate(collection, {
-            aggregate: { count: '*' },
+            aggregate: { [k]: '*' },
             query: {
                 ...(filter ? { filter } : {}),
-                ...(search ? { search } : {}),
+                ...(search ? { search } : {})
             }
         }));
         if (data && data.length === 1) {
@@ -81,7 +88,7 @@ export class DirectusApiAdapter extends ApiAdapterAbstract {
         }
     }
     async find(collection, query) {
-        const response = await this.directus.request(readItems(collection, query));
+        const response = (await this.directus.request(readItems(collection, query)));
         const total = await this.includeTotals(collection, query);
         if (null === total) {
             return this.transformResponse({ data: response });
@@ -94,11 +101,13 @@ export class DirectusApiAdapter extends ApiAdapterAbstract {
         return this.transformResponse({ data });
     }
     async aggregate(collection, query) {
-        const { aggregate: aggregate_, ...rest } = (query || {});
+        const { aggregate: aggregate_, ...rest } = query || {};
         const data = await this.directus.request(aggregate(collection, {
-            aggregate: aggregate_ ? aggregate_ : {
-                count: 'id'
-            },
+            aggregate: aggregate_
+                ? aggregate_
+                : {
+                    count: 'id'
+                },
             query: rest
         }));
         return this.transformResponse({ data });
@@ -117,7 +126,7 @@ export class DirectusApiAdapter extends ApiAdapterAbstract {
     }
     async put(collection, key, payload) {
         if (key) {
-            const data = await this.directus.request(updateItem(collection, key, payload));
+            const data = (await this.directus.request(updateItem(collection, key, payload)));
             return this.transformResponse({ data }, 201);
         }
         else {

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

@@ -19,6 +19,7 @@ export type DirectusApiAdapterOptions = {
         credentials?: RequestCredentials;
     };
     includeTotals?: boolean;
+    totalAggregate?: 'count' | 'countDistinct';
 };
 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.1.0",
+  "version": "4.0.0",
   "main": "src/index.ts",
   "types": "src/index.ts",
   "description": "directus API wrapper for all the directus sdk functionality",
@@ -22,31 +22,31 @@
     }
   },
   "devDependencies": {
-    "@directus/types": "^12.0.0",
-    "@sveltejs/adapter-auto": "^3.2.4",
-    "@sveltejs/package": "^2.3.4",
+    "@directus/types": "^12.1.0",
+    "@sveltejs/adapter-auto": "^3.2.5",
+    "@sveltejs/package": "^2.3.5",
     "@sveltejs/vite-plugin-svelte": "^3.1.2",
     "@testing-library/jest-dom": "^6.5.0",
-    "@testing-library/svelte": "^5.2.1",
-    "@vitest/coverage-v8": "^2.0.5",
-    "jsdom": "^25.0.0",
-    "msw": "^2.4.1",
+    "@testing-library/svelte": "^5.2.3",
+    "@vitest/coverage-v8": "^2.1.2",
+    "jsdom": "^25.0.1",
+    "msw": "^2.4.9",
     "svelte": "^4.2.19",
-    "svelte-check": "^3.8.6",
-    "vite": "^5.4.2",
-    "vitest": "^2.0.5",
+    "svelte-check": "^4.0.4",
+    "vite": "^5.4.8",
+    "vitest": "^2.1.2",
     "@internal/eslint-config": "0.0.0",
-    "@tanglemedia/svelte-starter-core": "0.2.2"
+    "@tanglemedia/svelte-starter-core": "0.5.0"
   },
   "dependencies": {
-    "@directus/sdk": "^17.0.1",
+    "@directus/sdk": "^17.0.2",
     "@types/js-cookie": "^3.0.6",
     "esm-env": "^1.0.0",
     "js-cookie": "^3.0.5"
   },
   "peerDependencies": {
     "@sveltejs/kit": ">=2 <3",
-    "@tanglemedia/svelte-starter-core": ">=0.2.2",
+    "@tanglemedia/svelte-starter-core": ">=0.5.0",
     "svelte": ">=4 <5"
   },
   "scripts": {

package/src/adapter/api-adapter.ts

@@ -17,6 +17,7 @@ import {
 import {
   ApiAdapterAbstract,
   type AnyObject,
+  type ApiAdapterHandle,
   type ApiAdapterRequestConfig,
   type ApiAggregateQuery,
   type ApiCreateManyQuery,
@@ -25,7 +26,8 @@ import {
   type ApiId,
   type ApiResponse,
   type ApiUpdateManyQuery,
-  type BaseApiMethods
+  type BaseApiMethods,
+  type HandleEvent
 } from '@tanglemedia/svelte-starter-core';
 import type { DirectusConfig, SchemaShape } from '../types/adapter.types';
 
@@ -39,7 +41,7 @@ export type AdapterClient<Schema extends SchemaShape = SchemaShape> = DirectusCl
 export class DirectusApiAdapter<
   Schema extends SchemaShape = SchemaShape,
   Path extends RegularCollections<Schema> = RegularCollections<Schema>
-> extends ApiAdapterAbstract<DirectusConfig, ApiAdapterRequestConfig, Path, AdapterClient> {
+> extends ApiAdapterAbstract<DirectusConfig, ApiAdapterRequestConfig, Path, AdapterClient> implements ApiAdapterHandle {
   constructor(
     protected config: DirectusConfig,
     private readonly directus: AdapterClient<Schema>
@@ -47,6 +49,11 @@ export class DirectusApiAdapter<
     super(config);
   }
 
+  async handle(event: HandleEvent) {
+    const f = event.fetch;
+    this.directus.globals.fetch = f;
+  }
+
   getAdapterClient(): AdapterClient<Schema> | null {
     return this.directus;
   }
@@ -78,8 +85,12 @@ export class DirectusApiAdapter<
 
     const { filter, search } = query || {};
 
+    // default to countDistinct. Note that there is a bug in directus where
+    // the wrong counts are being returned if there are nested filters.
+    const k = this.config.configuration.totalAggregate || 'countDistinct';
+
     const data = await this.directus.request(aggregate(collection, {
-      aggregate: { count: '*' },
+      aggregate: { [k]: '*' },
       query: {
         ...(filter ? { filter } : {}),
         ...(search ? { search } : {}),

package/src/types/adapter.types.ts

@@ -25,6 +25,7 @@ export type DirectusApiAdapterOptions = {
   };
 
   includeTotals?: boolean;
+  totalAggregate?: 'count' | 'countDistinct';
 };
 
 export type DirectusConfig = BaseApiAdapterConfig<DirectusApiAdapterOptions>;