buro26-strapi-graphql 0.0.23 → 0.0.25

package/README.md

@@ -6,6 +6,8 @@ as co-location of GraphQL schema and resolvers, field overriding, and field auth
 This let's you define your GraphQL schema and resolvers in the content-type directory, making it easier to manage and
 maintain your GraphQL API.
 
+This plugin is compatible with both Strapi v4 and Strapi v5.
+
 ## Getting started
 
 ```bash
@@ -21,7 +23,7 @@ the [Strapi GraphQL plugin](https://docs.strapi.io/dev-docs/plugins/graphql).
 
 ### Enable plugin
 
-Add plugin in `./config/plugins.js/ts` in your Strapi project.
+Add plugin in `./config/plugins.[js/ts]` in your Strapi project.
 
 ```typescript
 export default () => ({
@@ -487,6 +489,27 @@ args into args that can be passed to the entityManager.
 
 This function is re-exported from the Strapi GraphQL plugin.
 
+#### shadowCRUD
+
+This function is a typesafe utility function to create shadow CRUD operations for a content type. It will create the CRUD operations for the content type and return the shadow CRUD object.
+
+```typescript
+import { createGraphQLExtension, shadowCRUD } from 'buro26-strapi-graphql';
+
+export default createGraphQLExtension((strapi) => ({
+
+  init() {
+    shadowCRUD('api::article.article')
+      .disableActions(['create', 'update', 'delete']);
+
+    shadowCRUD('api::category.category')
+      .field('title')
+      .disable();
+  }
+
+}));
+```
+
 ## Test and Deploy
 
 ### Running tests

package/dist/server/bootstrap.d.ts

@@ -1,4 +1,4 @@
-import { type Strapi } from '@strapi/strapi';
+import { type Strapi } from './types';
 declare const _default: ({ strapi }: {
     strapi: Strapi;
 }) => void;

package/dist/server/controllers/index.d.ts

@@ -1,6 +1,6 @@
 declare const _default: {
     myController: ({ strapi }: {
-        strapi: import("@strapi/types").Strapi;
+        strapi: Required<import("@strapi/types").Strapi>;
     }) => {};
 };
 export default _default;

package/dist/server/controllers/my-controller.d.ts

@@ -1,4 +1,4 @@
-import { Strapi } from '@strapi/strapi';
+import type { Strapi } from '../types';
 declare const _default: ({ strapi }: {
     strapi: Strapi;
 }) => {};

package/dist/server/destroy.d.ts

@@ -1,4 +1,4 @@
-import { type Strapi } from '@strapi/strapi';
+import { type Strapi } from './types';
 declare const _default: ({ strapi }: {
     strapi: Strapi;
 }) => void;

package/dist/server/index.d.ts

@@ -1,17 +1,16 @@
-import type { Strapi } from '@strapi/strapi';
-import type { GraphQLExtension } from './types';
+import type { GraphQLExtension, Strapi } from './types';
 import type { Middleware, ResolveContext } from './utils';
 import type { GraphQLResolveInfo } from 'graphql';
 import type { GraphQLFieldConfig } from 'graphql/type';
 declare const _default: {
     register: ({ strapi }: {
-        strapi: Strapi;
+        strapi: import("@strapi/types").Strapi;
     }) => Promise<void>;
     bootstrap: ({ strapi }: {
-        strapi: Strapi;
+        strapi: Required<import("@strapi/types").Strapi>;
     }) => void;
     destroy: ({ strapi }: {
-        strapi: Strapi;
+        strapi: Required<import("@strapi/types").Strapi>;
     }) => void;
     config: {
         default: {};
@@ -19,18 +18,18 @@ declare const _default: {
     };
     controllers: {
         myController: ({ strapi }: {
-            strapi: Strapi;
+            strapi: Required<import("@strapi/types").Strapi>;
         }) => {};
     };
     routes: any[];
     services: {
         fileService: ({ strapi }: {
-            strapi: Strapi;
+            strapi: Required<import("@strapi/types").Strapi>;
         }) => {
             getAllFilesInGraphQlDirectory(directoryPath: string, collectedExtensions?: GraphQLExtension[]): Promise<GraphQLExtension[]>;
         };
         graphQlService: ({ strapi }: {
-            strapi: Strapi;
+            strapi: Required<import("@strapi/types").Strapi>;
         }) => {};
     };
     contentTypes: {};
@@ -46,6 +45,11 @@ declare module '@strapi/strapi' {
         createGraphQLExtension: (factory: (strapi: Strapi) => GraphQLExtension) => GraphQLExtension;
     }
 }
+declare module '@strapi/types' {
+    interface Strapi {
+        createGraphQLExtension: (factory: (strapi: Strapi) => GraphQLExtension) => GraphQLExtension;
+    }
+}
 /**
  * Extend Nexus's field definition to include a middleware array.
  */

package/dist/server/services/file-service.d.ts

@@ -1,5 +1,4 @@
-import type { Strapi } from '@strapi/strapi';
-import type { GraphQLExtension } from '../types';
+import type { GraphQLExtension, Strapi } from '../types';
 declare const _default: ({ strapi }: {
     strapi: Strapi;
 }) => {

package/dist/server/services/graphql-service.d.ts

@@ -1,4 +1,4 @@
-import { type Strapi } from '@strapi/strapi';
+import { type Strapi } from '../types';
 declare const _default: ({ strapi }: {
     strapi: Strapi;
 }) => {};

package/dist/server/services/index.d.ts

@@ -1,11 +1,11 @@
 declare const _default: {
     fileService: ({ strapi }: {
-        strapi: import("@strapi/types").Strapi;
+        strapi: Required<import("@strapi/types").Strapi>;
     }) => {
         getAllFilesInGraphQlDirectory(directoryPath: string, collectedExtensions?: import("..").GraphQLExtension[]): Promise<import("..").GraphQLExtension[]>;
     };
     graphQlService: ({ strapi }: {
-        strapi: import("@strapi/types").Strapi;
+        strapi: Required<import("@strapi/types").Strapi>;
     }) => {};
 };
 export default _default;

package/dist/server/types.d.ts

@@ -1,6 +1,6 @@
 import type { ResolveContext } from './utils';
 import type { GraphQLResolveInfo } from 'graphql';
-import type { Strapi } from '@strapi/strapi';
+export type Strapi = typeof strapi;
 export interface GraphQLExtension {
     /**
      * Called when the extension is initialized, use this to perform any initialization logic
@@ -55,7 +55,7 @@ export interface GraphQLExtension {
 }
 type ResolverConfigOption = {
     auth?: boolean | undefined;
-    policies?: string[] | PolicyFunction[];
+    policies?: (string | PolicyFunction)[];
     middlewares?: MiddlewareFunction[];
 };
 type PolicyFunctionContext = {

package/dist/server/utils/collection-type.d.ts

@@ -26,8 +26,8 @@ type EntityResponseCollection<T extends Object> = {
     };
 };
 type ExtractRelation<Parent, K extends keyof Parent> = Parent[K] extends Array<infer U> ? U extends object ? U : never : Parent[K] extends object ? Parent[K] : never;
-export default function toEntityResponseCollection<T extends Object>(items: T[], { args, resourceUID }: {
+export declare function toEntityResponseCollection<T extends Object>(items: T[], { args, resourceUID }: {
     args: Record<string, any>;
     resourceUID: string;
-}): EntityResponseCollection<T>;
+}): Promise<EntityResponseCollection<T>>;
 export {};

package/dist/server/utils/collection-type.js

@@ -5,7 +5,7 @@
  * Based on node_modules/@strapi/plugin-graphql/server/services/builders/resolvers/association.js
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createEntityRelationCollectionResolver = exports.createEntityCollectionResolver = void 0;
+exports.toEntityResponseCollection = exports.createEntityRelationCollectionResolver = exports.createEntityCollectionResolver = void 0;
 /**
  * Create a resolver for a collection of entities
  * Returns a resolver that resolves the entities based on the content type UID
@@ -52,11 +52,11 @@ function createEntityRelationCollectionResolver(contentType) {
     };
 }
 exports.createEntityRelationCollectionResolver = createEntityRelationCollectionResolver;
-function toEntityResponseCollection(items, { args, resourceUID }) {
+async function toEntityResponseCollection(items, { args, resourceUID }) {
     const { toEntityResponseCollection } = strapi.plugin('graphql').service('format').returnTypes;
     return toEntityResponseCollection(items, {
         args,
         resourceUID
     });
 }
-exports.default = toEntityResponseCollection;
+exports.toEntityResponseCollection = toEntityResponseCollection;

package/dist/server/utils/index.d.ts

@@ -4,3 +4,4 @@ export * from './collection-type';
 export * from './middleware';
 export * from './misc';
 export * from './override';
+export * from './shadow-crud';

package/dist/server/utils/index.js

@@ -20,3 +20,4 @@ __exportStar(require("./collection-type"), exports);
 __exportStar(require("./middleware"), exports);
 __exportStar(require("./misc"), exports);
 __exportStar(require("./override"), exports);
+__exportStar(require("./shadow-crud"), exports);

package/dist/server/utils/shadow-crud.d.ts

@@ -0,0 +1,30 @@
+type Action = 'create' | 'update' | 'delete' | 'findOne' | 'find';
+interface FieldOperations<T> {
+    disable(): this;
+    disableInput(): this;
+    disableOutput(): this;
+    disableFilters(): this;
+    isEnabled(): boolean;
+    isDisabled(): boolean;
+    hasInputEnabled(): boolean;
+    hasOutputEnabled(): boolean;
+    hasFiltersEnabled(): boolean;
+}
+interface ShadowCRUD<T> {
+    disable(): this;
+    disableActions(actions: Action[]): this;
+    disableAction(action: Action): this;
+    disableQueries(): this;
+    disableMutations(): this;
+    field<K extends keyof T>(name: K): FieldOperations<T[K]>;
+    isEnabled(): boolean;
+    isDisabled(): boolean;
+    areQueriesEnabled(): boolean;
+    areQueriesDisabled(): boolean;
+    areMutationsEnabled(): boolean;
+    areMutationsDisabled(): boolean;
+    isActionEnabled(action: Action): boolean;
+    isActionDisabled(action: Action): boolean;
+}
+export declare const shadowCRUD: <Type extends unknown = null>(contentTypeUID: string) => ShadowCRUD<Type>;
+export {};

package/dist/server/utils/shadow-crud.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.shadowCRUD = void 0;
+const shadowCRUD = (contentTypeUID) => {
+    const extensionService = strapi.plugin('graphql').service('extension');
+    return extensionService.shadowCRUD(contentTypeUID);
+};
+exports.shadowCRUD = shadowCRUD;

package/dist/server/utils/types.d.ts

@@ -1,5 +1,5 @@
 import type { GraphQLResolveInfo } from "graphql";
-type User = {
+export type BaseUser = {
     id: number;
     username: string;
     email: string;
@@ -20,7 +20,7 @@ type User = {
         updatedAt: string;
     };
 };
-export type ResolveContext<UserType = User> = {
+export type ResolveContext<UserType = BaseUser> = {
     state: {
         route: {
             info: {
@@ -50,4 +50,3 @@ export type Entity<T extends Object> = {
     id: string;
     attributes: Omit<T, 'id'>;
 };
-export {};