Add options for new directives

hayes · Dec 26, 2023 · 916cef7 · 916cef7
1 parent 0979efd
commit 916cef7
Show file tree

Hide file tree

Showing 4 changed files with 55 additions and 1 deletion.
diff --git a/packages/plugin-federation/src/global-types.ts b/packages/plugin-federation/src/global-types.ts
@@ -107,9 +107,44 @@ declare global {
       ) => void;
     }
 
+    export interface UserSchemaTypes {
+      FederationScopes: unknown;
+      FederationPolicies: unknown;
+    }
+
+    export interface ExtendDefaultTypes<PartialTypes extends Partial<UserSchemaTypes>> {
+      FederationScopes: string extends PartialTypes['FederationScopes']
+        ? string
+        : PartialTypes['FederationScopes'];
+      FederationPolicies: string extends PartialTypes['FederationPolicies']
+        ? string
+        : PartialTypes['FederationPolicies'];
+    }
+
     export interface ObjectTypeOptions<Types extends SchemaTypes, Shape> {
       shareable?: boolean;
       tag?: string[] | string;
+      authenticated?: boolean;
+      requiresScopes?: Types['FederationScopes'][][];
+      policy?: Types['FederationPolicies'][][];
+    }
+
+    export interface InterfaceTypeOptions<Types extends SchemaTypes, Shape> {
+      authenticated?: boolean;
+      requiresScopes?: Types['FederationScopes'][][];
+      policy?: Types['FederationPolicies'][][];
+    }
+
+    export interface ScalarTypeOptions<Types extends SchemaTypes> {
+      authenticated?: boolean;
+      requiresScopes?: Types['FederationScopes'][][];
+      policy?: Types['FederationPolicies'][][];
+    }
+
+    export interface EnumTypeOptions<Types extends SchemaTypes> {
+      authenticated?: boolean;
+      requiresScopes?: Types['FederationScopes'][][];
+      policy?: Types['FederationPolicies'][][];
     }
 
     export interface BaseTypeOptions<Types extends SchemaTypes = SchemaTypes> {
@@ -133,6 +168,9 @@ declare global {
       inaccessible?: boolean;
       override?: { from: string };
       tag?: string[] | string;
+      authenticated?: boolean;
+      requiresScopes?: Types['FederationScopes'][][];
+      policy?: Types['FederationPolicies'][][];
     }
 
     export interface InputFieldOptions<

diff --git a/packages/plugin-federation/src/index.ts b/packages/plugin-federation/src/index.ts
@@ -109,6 +109,9 @@ function getCommonDirectives<
       tag?: string[] | string;
       inaccessible?: boolean;
       shareable?: boolean;
+      authenticated?: boolean;
+      requiresScopes?: unknown[][];
+      policy?: unknown[][];
     };
   },
 >(config: T) {
@@ -117,10 +120,19 @@ function getCommonDirectives<
       ? [config.pothosOptions.tag]
       : config.pothosOptions.tag ?? [];
   const tagDirectives = tags.map((tag) => ({ name: 'tag', args: { name: tag } }));
+  const requiresScopes = config.pothosOptions.requiresScopes
+    ? { name: 'requiresScopes', args: { scopes: config.pothosOptions.requiresScopes } }
+    : null;
+  const policy = config.pothosOptions.policy
+    ? { name: 'policy', args: { policies: config.pothosOptions.policy } }
+    : null;
 
   return [
     config.pothosOptions.inaccessible ? { name: 'inaccessible' } : null,
     config.pothosOptions.shareable ? { name: 'shareable' } : null,
+    config.pothosOptions.authenticated ? { name: 'authenticated' } : null,
+    requiresScopes,
+    policy,
     ...tagDirectives,
   ].filter(Boolean) as { name: string }[];
 }

diff --git a/packages/plugin-federation/tests/example/accounts/schema.ts b/packages/plugin-federation/tests/example/accounts/schema.ts
@@ -4,6 +4,7 @@ import FederationPlugin from '../../../src';
 
 const builder = new SchemaBuilder<{
   DefaultFieldNullability: true;
+  FederationPolicies: 'user:policy';
 }>({
   plugins: [DirectivesPlugin, FederationPlugin],
   useGraphQLToolsUnorderedDirectives: true,

diff --git a/website/pages/docs/plugins/federation.mdx b/website/pages/docs/plugins/federation.mdx
@@ -218,6 +218,9 @@ t.field({
   tag: ['someTag'],
   inaccessible: true,
   override: { from: 'users' },
+  authenticated: true,
+  scopes: ['read:field'],
+  policy: [['read:field']],
 });
 ```
 
@@ -262,7 +265,7 @@ builder.asEntity(Media, {
 
 See federation documentation for more details on `interfaceObject`s
 
-### composeDirective =
+### composeDirective
 
 You can apply the `composeDirective` directive when building the subgraph schema: