feat(cli): add config for directus rest client

tractr · Jul 10, 2024 · 669eb93 · 669eb93
1 parent 46ab280
commit 669eb93
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -210,6 +210,7 @@ module.exports = {
   directusPassword: 'my-directus-password', // ignored if directusToken is provided
   directusConfig: {
     clientOptions: {},  // see https://docs.directus.io/guides/sdk/getting-started.html#polyfilling
+    restConfig: {}, // see https://docs.directus.io/packages/@directus/sdk/rest/interfaces/RestConfig.html
   }
   dumpPath: './directus-config',
   collectionsPath: 'collections',

diff --git a/packages/cli/src/lib/services/config/config.ts b/packages/cli/src/lib/services/config/config.ts
@@ -79,15 +79,17 @@ export class ConfigService {
   @Cacheable()
   getDirectusConfig(): DirectusConfigWithToken | DirectusConfigWithCredentials {
     const url = this.requireOptions('directusUrl');
-    const clientConfig = this.getOptions('directusConfig')?.clientOptions;
+    const directusConfig = this.getOptions('directusConfig');
+    const clientConfig = directusConfig?.clientOptions;
+    const restConfig = directusConfig?.restConfig;
     const token = this.getOptions('directusToken');
     if (token) {
-      return { url, token, clientConfig };
+      return { url, token, clientConfig, restConfig };
     }
 
     const email = this.requireOptions('directusEmail');
     const password = this.requireOptions('directusPassword');
-    return { url, email, password, clientConfig };
+    return { url, email, password, clientConfig, restConfig };
   }
 
   @Cacheable()

diff --git a/packages/cli/src/lib/services/config/interfaces.ts b/packages/cli/src/lib/services/config/interfaces.ts
@@ -1,11 +1,12 @@
 import type { z } from 'zod';
-import type {
+import {
   ConfigFileOptionsSchema,
   OptionsFields,
   OptionsSchema,
   CollectionEnum,
   CollectionPreservableIdEnum,
   ClientConfigSchema,
+  RestConfigSchema,
 } from './schema';
 import type { MigrationClient } from '../migration-client';
 import type { DirectusBaseType, Query } from '../collections';
@@ -57,6 +58,7 @@ export interface SnapshotHooks {
 interface DirectusConfigBase {
   url: string;
   clientConfig: z.infer<typeof ClientConfigSchema> | undefined;
+  restConfig: z.infer<typeof RestConfigSchema> | undefined;
 }
 export interface DirectusConfigWithToken extends DirectusConfigBase {
   token: string;

diff --git a/packages/cli/src/lib/services/config/schema.ts b/packages/cli/src/lib/services/config/schema.ts
@@ -73,6 +73,12 @@ export const ClientConfigSchema = z.object({
     .optional(),
 });
 
+export const RestConfigSchema = z.object({
+  credentials: z.string().optional(),
+  onRequest: z.function().optional(),
+  onResponse: z.function().optional(),
+});
+
 export const OptionsFields = {
   // Global
   configPath: z.string().optional(),
@@ -84,6 +90,7 @@ export const OptionsFields = {
   directusConfig: z
     .object({
       clientOptions: ClientConfigSchema.optional(),
+      restConfig: RestConfigSchema.optional(),
     })
     .optional(),
   // Pull, diff, push
@@ -127,6 +134,7 @@ export const ConfigFileOptionsSchema = z.object({
   directusConfig: z
     .object({
       clientOptions: ClientConfigSchema.optional(),
+      restConfig: RestConfigSchema.optional(),
     })
     .optional(),
   // Dump config

diff --git a/packages/cli/src/lib/services/migration-client.ts b/packages/cli/src/lib/services/migration-client.ts
@@ -8,6 +8,7 @@ import {
   readMe,
   rest,
   RestClient,
+  RestConfig,
 } from '@directus/sdk';
 import { Inject, Service } from 'typedi';
 import pino from 'pino';
@@ -72,7 +73,7 @@ export class MigrationClient {
       config.url,
       config.clientConfig as ClientOptions | undefined,
     )
-      .with(rest())
+      .with(rest(config.restConfig as RestConfig | undefined))
       .with(authentication());
 
     // If the token is already set, return it