@smartive/graphql-magic 16.3.6 → 16.3.8

package/src/models/models.ts

@@ -71,7 +71,7 @@ export class Models {
         kind: 'raw-enum',
         name: 'Order',
         values: ['ASC', 'DESC'],
-      }
+      },
     );
     const entities = this.definitions.filter(isEntityModelDefinition);
 
@@ -204,7 +204,7 @@ export class Models {
     }
 
     this.models = this.definitions.map(
-      (definition) => new (MODEL_KIND_TO_CLASS_MAPPING[definition.kind] as any)(this, definition)
+      (definition) => new (MODEL_KIND_TO_CLASS_MAPPING[definition.kind] as any)(this, definition),
     );
     for (const model of this.models) {
       this.modelsByName[model.name] = model;
@@ -228,6 +228,7 @@ export class Models {
     if (!(model instanceof expectedType)) {
       throw new Error(`Model ${name} is not of kind ${kind}.`);
     }
+
     return model as ModelKindToClassMapping[K];
   }
 }
@@ -237,7 +238,10 @@ export abstract class Model {
   plural: string;
   description: string;
 
-  constructor(public models: Models, definition: ModelDefinition) {
+  constructor(
+    public models: Models,
+    definition: ModelDefinition,
+  ) {
     Object.assign(this, definition);
     this.plural = definition.plural || pluralize(definition.name);
   }
@@ -358,6 +362,7 @@ export class EntityModel extends Model {
         .filter(isRelation)
         .map((relationField) => new NormalRelation(this, relationField, this.models.getModel(relationField.type, 'entity')));
     }
+
     return this._relations;
   }
 
@@ -368,6 +373,7 @@ export class EntityModel extends Model {
         this._relationsByName[relation.name] = relation;
       }
     }
+
     return this._relationsByName;
   }
 
@@ -380,9 +386,10 @@ export class EntityModel extends Model {
       this._reverseRelations = this.models.entities.flatMap((model) =>
         model.relations
           .filter((relation) => relation.targetModel.name === this.name || relation.targetModel.name === this.rootModel.name)
-          .map((relation) => relation.reverse)
+          .map((relation) => relation.reverse),
       );
     }
+
     return this._reverseRelations;
   }
 
@@ -393,6 +400,7 @@ export class EntityModel extends Model {
         this._reverseRelationsByName[reverseRelation.name] = reverseRelation;
       }
     }
+
     return this._reverseRelationsByName;
   }
 
@@ -405,7 +413,7 @@ export class EntityModel extends Model {
       this._manyToManyRelations = [];
       for (const relationFromSource of this.reverseRelations) {
         const relationToTarget = relationFromSource.targetModel.relations.find(
-          (relation) => !relation.field.generated && relation.field.name !== relationFromSource.field.name
+          (relation) => !relation.field.generated && relation.field.name !== relationFromSource.field.name,
         );
         if (!relationToTarget) {
           continue;
@@ -413,7 +421,7 @@ export class EntityModel extends Model {
 
         const inapplicableFields = relationFromSource.targetModel.fields.filter(
           (otherField) =>
-            !otherField.generated && ![relationFromSource.field.name, relationToTarget.field.name].includes(otherField.name)
+            !otherField.generated && ![relationFromSource.field.name, relationToTarget.field.name].includes(otherField.name),
         );
         if (inapplicableFields.length) {
           continue;
@@ -422,6 +430,7 @@ export class EntityModel extends Model {
         this._manyToManyRelations.push(new ManyToManyRelation(relationFromSource, relationToTarget));
       }
     }
+
     return this._manyToManyRelations;
   }
 
@@ -432,6 +441,7 @@ export class EntityModel extends Model {
         this._manyToManyRelationsByName[manyToManyRelation.name] = manyToManyRelation;
       }
     }
+
     return this._manyToManyRelationsByName;
   }
 
@@ -444,6 +454,7 @@ export class EntityModel extends Model {
       if (!this._parentModel) {
         this._parentModel = this.models.getModel(this.parent, 'entity');
       }
+
       return this._parentModel;
     }
   }
@@ -472,14 +483,18 @@ export abstract class Relation {
     public name: string,
     public sourceModel: EntityModel,
     public field: RelationField,
-    public targetModel: EntityModel
+    public targetModel: EntityModel,
   ) {}
 }
 
 export class NormalRelation extends Relation {
   public reverse: ReverseRelation;
 
-  constructor(sourceModel: EntityModel, public field: RelationField, targetModel: EntityModel) {
+  constructor(
+    sourceModel: EntityModel,
+    public field: RelationField,
+    targetModel: EntityModel,
+  ) {
     super(field.name, sourceModel, field, targetModel);
     this.reverse = new ReverseRelation(this);
   }
@@ -492,7 +507,7 @@ export class ReverseRelation extends Relation {
         (reverse.field.toOne ? typeToField(reverse.sourceModel.name) : reverse.sourceModel.pluralField),
       reverse.targetModel,
       reverse.field,
-      reverse.sourceModel
+      reverse.sourceModel,
     );
   }
 }

package/src/models/mutation-hook.ts

@@ -10,5 +10,5 @@ export type MutationHook<DateType extends AnyDateType = AnyDateType> = (
   action: Action,
   when: 'before' | 'after',
   data: { prev: Entity; input: Entity; normalizedInput: Entity; next: Entity },
-  ctx: Context<DateType>
+  ctx: Context<DateType>,
 ) => Promise<void>;

package/src/models/utils.ts

@@ -19,7 +19,7 @@ import {
 
 const isNotFalsy = <T>(v: T | null | undefined | false): v is T => typeof v !== 'undefined' && v !== null && v !== false;
 
-export const merge = <T>(objects: ({ [name: string]: T } | undefined | false)[] | undefined): { [name: string]: T } =>
+export const merge = <T>(objects: (Record<string, T> | undefined | false)[] | undefined): Record<string, T> =>
   (objects || []).filter(isNotFalsy).reduce((i, acc) => ({ ...acc, ...i }), {});
 
 // Target -> target
@@ -42,7 +42,7 @@ export const not =
   (field: T) =>
     !predicate(field);
 
-export const isRootModel = (model: EntityModel) => model.root;
+export const isRootModel = (model: EntityModel) => !!model.root;
 
 export const isEntityModel = (model: Model): model is EntityModel => model instanceof EntityModel;
 
@@ -77,7 +77,7 @@ export const isEnum = (field: EntityField): field is EnumField => field.kind ===
 
 export const isRelation = (field: EntityField): field is RelationField => field.kind === 'relation';
 
-export const isInherited = (field: EntityField) => field.inherited;
+export const isInherited = (field: EntityField) => !!field.inherited;
 
 export const isInTable = (field: EntityField) => field.name === 'id' || !field.inherited;
 
@@ -114,7 +114,7 @@ export const getActionableRelations = (model: EntityModel, action: 'create' | 'u
       (relation) =>
         relation.field[
           `${action === 'filter' ? action : action.slice(0, -1)}able` as 'filterable' | 'creatable' | 'updatable'
-        ]
+        ],
     )
     .map(({ name }) => name);
 
@@ -133,6 +133,7 @@ export const summon = <T>(array: readonly T[] | undefined, cb: Parameters<T[]['f
     console.trace();
     throw new Error(errorMessage || 'Element not found.');
   }
+
   return result;
 };
 
@@ -154,11 +155,13 @@ export const get = <T, U extends keyof ForSure<T>>(object: T | null | undefined,
     console.warn(error);
     throw error;
   }
+
   return value as ForSure<ForSure<T>[U]>;
 };
 
 export const getString = (v: unknown) => {
   assert(typeof v === 'string');
+
   return v;
 };
 
@@ -168,9 +171,8 @@ export const retry = async <T>(cb: () => Promise<T>, condition: (e: any) => bool
   } catch (e) {
     if (condition(e)) {
       return await cb();
-    } else {
-      throw e;
     }
+    throw e;
   }
 };
 
@@ -182,7 +184,6 @@ type Typeof = {
   symbol: symbol;
   undefined: undefined;
   object: object;
-  // eslint-disable-next-line @typescript-eslint/ban-types
   function: Function;
 };
 

package/src/permissions/check.ts

@@ -11,7 +11,7 @@ export const getRole = (ctx: Pick<FullContext, 'user'>) => ctx.user?.role ?? 'UN
 export const getPermissionStack = (
   ctx: Pick<FullContext, 'permissions' | 'user'>,
   type: string,
-  action: PermissionAction
+  action: PermissionAction,
 ): boolean | PermissionStack => {
   const rolePermissions = ctx.permissions[getRole(ctx)];
   if (typeof rolePermissions === 'boolean' || rolePermissions === undefined) {
@@ -37,7 +37,7 @@ export const applyPermissions = (
   tableAlias: string,
   query: Knex.QueryBuilder,
   action: PermissionAction,
-  verifiedPermissionStack?: PermissionStack
+  verifiedPermissionStack?: PermissionStack,
 ): boolean | PermissionStack => {
   const permissionStack = getPermissionStack(ctx, type, action);
 
@@ -47,8 +47,9 @@ export const applyPermissions = (
 
   if (permissionStack === false) {
     console.error(`No applicable permissions exist for ${getRole(ctx)} ${type} ${action}.`);
-    // eslint-disable-next-line @typescript-eslint/no-floating-promises -- we do not need to await knex here
+
     query.where(false);
+
     return permissionStack;
   }
 
@@ -59,8 +60,8 @@ export const applyPermissions = (
           hash(prefixChain) === hash(chain.slice(0, -1)) &&
           // TODO: this is stricter than it could be if we add these checks to the query
           !('where' in get(chain, chain.length - 1)) &&
-          !('me' in get(chain, chain.length - 1))
-      )
+          !('me' in get(chain, chain.length - 1)),
+      ),
     )
   ) {
     // The user has access to a parent entity with one or more from a set of rules, all of which are inherited by this entity
@@ -68,15 +69,14 @@ export const applyPermissions = (
     return permissionStack;
   }
 
-  // eslint-disable-next-line @typescript-eslint/no-floating-promises -- we do not need to await knex here
   ors(
     query,
     permissionStack.map(
       (links) => (query) =>
         query
           .whereNull(`${tableAlias}.id`)
-          .orWhereExists((subQuery) => permissionLinkQuery(ctx, subQuery, links, ctx.knex.raw(`"${tableAlias}".id`)))
-    )
+          .orWhereExists((subQuery) => permissionLinkQuery(ctx, subQuery, links, ctx.knex.raw(`"${tableAlias}".id`))),
+    ),
   );
 
   return permissionStack;
@@ -89,7 +89,7 @@ export const getEntityToMutate = async (
   ctx: Pick<FullContext, 'models' | 'permissions' | 'user' | 'knex'>,
   model: EntityModel,
   where: Record<string, unknown>,
-  action: 'UPDATE' | 'DELETE' | 'RESTORE'
+  action: 'UPDATE' | 'DELETE' | 'RESTORE',
 ) => {
   const query = ctx
     .knex(model.parent || model.name)
@@ -101,7 +101,7 @@ export const getEntityToMutate = async (
     console.error(
       `Not found: ${Object.entries(where)
         .map(([key, value]) => `${key}: ${value}`)
-        .join(', ')}`
+        .join(', ')}`,
     );
     throw new NotFoundError(`Entity to ${action.toLowerCase()}`);
   }
@@ -112,7 +112,7 @@ export const getEntityToMutate = async (
     console.error(
       `Permission error: ${Object.entries(where)
         .map(([key, value]) => `${key}: ${value}`)
-        .join(', ')}`
+        .join(', ')}`,
     );
     throw new PermissionError(getRole(ctx), action, `this ${model.name}`, 'no available permissions applied');
   }
@@ -132,7 +132,7 @@ export const checkCanWrite = async (
   ctx: Pick<FullContext, 'models' | 'permissions' | 'user' | 'knex'>,
   model: EntityModel,
   data: Record<string, unknown>,
-  action: 'CREATE' | 'UPDATE'
+  action: 'CREATE' | 'UPDATE',
 ) => {
   const permissionStack = getPermissionStack(ctx, model.name, action);
 
@@ -143,7 +143,6 @@ export const checkCanWrite = async (
     throw new PermissionError(getRole(ctx), action, model.plural, 'no applicable permissions');
   }
 
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any -- using `select(1 as any)` to instantiate an "empty" query builder
   const query = ctx.knex.select(1 as any).first();
   let linked = false;
 
@@ -168,7 +167,7 @@ export const checkCanWrite = async (
 
     if (fieldPermissionStack === true) {
       // User can link any entity from this type, just check whether it exists
-      // eslint-disable-next-line @typescript-eslint/no-floating-promises -- we do not need to await knex here
+
       query.whereExists((subQuery) => subQuery.from(`${field.type} as a`).whereRaw(`a.id = ?`, foreignId));
       continue;
     }
@@ -178,16 +177,15 @@ export const checkCanWrite = async (
         role,
         action,
         `this ${model.name}'s ${field.name}`,
-        'no applicable permissions on data to link'
+        'no applicable permissions on data to link',
       );
     }
 
-    // eslint-disable-next-line @typescript-eslint/no-floating-promises -- we do not need to await knex here
     ors(
       query,
       fieldPermissionStack.map(
-        (links) => (query) => query.whereExists((subQuery) => permissionLinkQuery(ctx, subQuery, links, foreignId))
-      )
+        (links) => (query) => query.whereExists((subQuery) => permissionLinkQuery(ctx, subQuery, links, foreignId)),
+      ),
     );
   }
 
@@ -206,7 +204,7 @@ const permissionLinkQuery = (
   ctx: Pick<FullContext, 'models' | 'user'>,
   subQuery: Knex.QueryBuilder,
   links: PermissionLink[],
-  id: Knex.RawBinding | Knex.ValueDict
+  id: Knex.RawBinding | Knex.ValueDict,
 ) => {
   const aliases = new AliasGenerator();
   let alias = aliases.getShort();
@@ -214,16 +212,14 @@ const permissionLinkQuery = (
 
   if (me) {
     if (!ctx.user) {
-      // eslint-disable-next-line @typescript-eslint/no-floating-promises -- we do not need to await knex here
       subQuery.where(false);
+
       return;
     }
 
-    // eslint-disable-next-line @typescript-eslint/no-floating-promises -- we do not need to await knex here
     subQuery.where({ [`${alias}.id`]: ctx.user.id });
   }
 
-  // eslint-disable-next-line @typescript-eslint/no-floating-promises -- we do not need to await knex here
   subQuery.from(`${type} as ${alias}`);
 
   if (where) {
@@ -234,20 +230,18 @@ const permissionLinkQuery = (
     const model = ctx.models.getModel(type, 'entity');
     const subAlias = aliases.getShort();
     if (reverse) {
-      // eslint-disable-next-line @typescript-eslint/no-floating-promises -- we do not need to await knex here
       subQuery.leftJoin(`${type} as ${subAlias}`, `${alias}.${foreignKey || 'id'}`, `${subAlias}.id`);
     } else {
-      // eslint-disable-next-line @typescript-eslint/no-floating-promises -- we do not need to await knex here
       subQuery.rightJoin(`${type} as ${subAlias}`, `${alias}.id`, `${subAlias}.${foreignKey || 'id'}`);
     }
-    // eslint-disable-next-line @typescript-eslint/no-floating-promises -- we do not need to await knex here
+
     subQuery.where({ [`${subAlias}.deleted`]: false });
     if (where) {
       applyWhere(model, subQuery, subAlias, where, aliases);
     }
     alias = subAlias;
   }
-  // eslint-disable-next-line @typescript-eslint/no-floating-promises -- we do not need to await knex here
+
   subQuery.whereRaw(`"${alias}".id = ?`, id);
 };
 
@@ -257,18 +251,16 @@ const applyWhere = (model: EntityModel, query: Knex.QueryBuilder, alias: string,
 
     if (relation) {
       const subAlias = aliases.getShort();
-      // eslint-disable-next-line @typescript-eslint/no-floating-promises -- we do not need to await knex here
+
       query.leftJoin(
         `${relation.targetModel.name} as ${subAlias}`,
         `${alias}.${relation.field.foreignKey || `${relation.field.name}Id`}`,
-        `${subAlias}.id`
+        `${subAlias}.id`,
       );
       applyWhere(relation.targetModel, query, subAlias, value, aliases);
     } else if (Array.isArray(value)) {
-      // eslint-disable-next-line @typescript-eslint/no-floating-promises -- we do not need to await knex here
       query.whereIn(`${alias}.${key}`, value);
     } else {
-      // eslint-disable-next-line @typescript-eslint/no-floating-promises -- we do not need to await knex here
       query.where({ [`${alias}.${key}`]: value });
     }
   }

package/src/permissions/generate.ts

@@ -8,36 +8,19 @@ const ACTIONS: PermissionAction[] = ['READ', 'CREATE', 'UPDATE', 'DELETE', 'REST
 /**
  * Initial representation (tree structure, as defined by user).
  */
-export type PermissionsConfig = {
-  [role: string]:
-    | true
-    | {
-        [type: string]: PermissionsBlock;
-      };
-};
+export type PermissionsConfig = Record<string, true | Record<string, PermissionsBlock>>;
 
-export type PermissionsBlock = {
-  [action in PermissionAction]?: true;
-} & {
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+export type PermissionsBlock = Partial<Record<PermissionAction, true>> & {
   WHERE?: Record<string, any>;
-  RELATIONS?: {
-    [relation: string]: PermissionsBlock;
-  };
+  RELATIONS?: Record<string, PermissionsBlock>;
 };
 
 /**
  * Final representation (lookup table (role, model, action) -> permission stack).
  */
-export type Permissions = {
-  [role: string]: true | RolePermissions;
-};
+export type Permissions = Record<string, true | RolePermissions>;
 
-type RolePermissions = {
-  [type: string]: {
-    [action in PermissionAction]?: true | PermissionStack;
-  };
-};
+type RolePermissions = Record<string, Partial<Record<PermissionAction, true | PermissionStack>>>;
 
 /**
  * For a given role, model and action,
@@ -53,7 +36,7 @@ export type PermissionLink = {
   foreignKey?: string;
   reverse?: boolean;
   me?: boolean;
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+
   where?: any;
 };
 
@@ -85,7 +68,7 @@ export const generatePermissions = (models: Models, config: PermissionsConfig) =
             ...('WHERE' in block && { where: block.WHERE }),
           },
         ],
-        block
+        block,
       );
     }
     permissions[role] = rolePermissions;
@@ -107,7 +90,7 @@ const addPermissions = (models: Models, permissions: RolePermissions, links: Per
         permissions[type][action] = [];
       }
       if (permissions[type][action] !== true) {
-        (permissions[type][action] as PermissionStack).push(links);
+        permissions[type][action].push(links);
       }
     }
   }

package/src/resolvers/arguments.ts

@@ -35,6 +35,7 @@ function getRawValue(value: ValueNode, values?: VariableValues): Value {
       if (!values) {
         return;
       }
+
       return value.values.map((value) => getRawValue(value, values));
     case Kind.VARIABLE:
       return values?.[value.name.value];
@@ -56,6 +57,7 @@ function getRawValue(value: ValueNode, values?: VariableValues): Value {
       for (const field of value.fields) {
         res[field.name.value] = getRawValue(field.value, values);
       }
+
       return res;
     }
   }
@@ -69,7 +71,7 @@ export const normalizeArguments = (node: FieldResolverNode) => {
       const normalizedValue = normalizeValue(
         rawValue,
         summonByKey(node.fieldDefinition.arguments || [], 'name.value', argument.name.value).type,
-        node.ctx.info.schema
+        node.ctx.info.schema,
       );
       if (normalizedValue === undefined) {
         continue;
@@ -77,6 +79,7 @@ export const normalizeArguments = (node: FieldResolverNode) => {
       normalizedArguments[argument.name.value] = normalizedValue as any;
     }
   }
+
   return normalizedArguments;
 };
 
@@ -88,6 +91,7 @@ export function normalizeValue(value: Value, type: TypeNode, schema: GraphQLSche
         for (const v of value) {
           res.push(normalizeValue(v, type.type, schema));
         }
+
         return res;
       }
 
@@ -104,7 +108,7 @@ export function normalizeValue(value: Value, type: TypeNode, schema: GraphQLSche
       return normalizeValueByTypeDefinition(
         value,
         (schema.getType(type.name.value) as Maybe<GraphQLObjectType>)?.astNode,
-        schema
+        schema,
       );
   }
 }
@@ -125,5 +129,6 @@ export const normalizeValueByTypeDefinition = (value: Value, type: Maybe<TypeDef
     }
     res[key] = normalizedValue;
   }
+
   return res;
 };

package/src/resolvers/filters.ts

@@ -33,12 +33,10 @@ export const applyFilters = (node: FieldResolverNode, query: Knex.QueryBuilder,
   const { limit, offset, orderBy, where, search } = normalizedArguments;
 
   if (limit) {
-    // eslint-disable-next-line @typescript-eslint/no-floating-promises -- we do not need to await knex here
     query.limit(limit);
   }
 
   if (offset) {
-    // eslint-disable-next-line @typescript-eslint/no-floating-promises -- we do not need to await knex here
     query.offset(offset);
   }
 
@@ -108,8 +106,8 @@ const applyWhere = (node: WhereNode, where: Where | undefined, ops: QueryBuilder
       ops.push((query) =>
         ors(
           query,
-          allSubOps.map((subOps) => (subQuery) => apply(subQuery, subOps))
-        )
+          allSubOps.map((subOps) => (subQuery) => apply(subQuery, subOps)),
+        ),
       );
       continue;
     }
@@ -145,7 +143,7 @@ const applyWhere = (node: WhereNode, where: Where | undefined, ops: QueryBuilder
               ]);
             void apply(subQuery, subOps);
             applyJoins(aliases, subQuery, subJoins);
-          })
+          }),
         );
         continue;
       }
@@ -183,8 +181,8 @@ const applyWhere = (node: WhereNode, where: Where | undefined, ops: QueryBuilder
         ops.push((query) =>
           ors(
             query,
-            value.map((v) => (subQuery) => subQuery.whereRaw('? = ANY(??)', [v, column] as string[]))
-          )
+            value.map((v) => (subQuery) => subQuery.whereRaw('? = ANY(??)', [v, column] as string[])),
+          ),
         );
         continue;
       }
@@ -195,7 +193,7 @@ const applyWhere = (node: WhereNode, where: Where | undefined, ops: QueryBuilder
             ors(query, [
               (subQuery) => subQuery.whereIn(column, value.filter((v) => v !== null) as string[]),
               (subQuery) => subQuery.whereNull(column),
-            ])
+            ]),
           );
           continue;
         }
@@ -220,8 +218,8 @@ const applySearch = (node: FieldResolverNode, search: string, query: Knex.QueryB
       .map(
         ({ name }) =>
           (query) =>
-            query.whereILike(getColumn(node, name), `%${search}%`)
-      )
+            query.whereILike(getColumn(node, name), `%${search}%`),
+      ),
   );
 
 const applyOrderBy = (node: FieldResolverNode, orderBy: OrderBy, query: Knex.QueryBuilder) => {