Sync related

You can also sync your BelongsToMany field. Say you have to sync permissions to a role. You can do it like this:

POST: api/restify/roles/1/sync/permissions

Payload:

{
  "permissions": [1, 2]
}

Under the hood this will call the sync method on the BelongsToMany relationship:

// $role of the id 1

$role->permissions()->sync($request->input('permissions'));

Authorize sync

You can define a policy method syncPermissions. The name should start with sync and suffix with the plural CamelCase name of the model's relationship name:

// RolePolicy.php

public function syncPermissions(User $authenticatedUser, Company $company, Collection $keys): bool
{ 
    // $keys are the primary keys of the related model (permissions in our case) Restify is trying to `sync`
}

Fixed

• The rest method will consider the meta information for the rest helper: rest($user)->indexMeta(['token' => $token])

Fixed

• Belongs search with custom foreign key https://github.com/BinarCode/laravel-restify/pull/512

Inherited https://github.com/BinarCode/laravel-restify/releases/tag/6.12.2

Added

• Serializer - Serialize One model or nothing using the show response format #510

Fixed

• Listing routes in console #514

Added

• The policyMeta method is now protected at the repository level (it could be used to override the policy information for the show and index methods.
• Do not make RelatedDto as a singleton in a test environment (this causes issues when trying to make few relationship requests to the same repository in the same test)

Fixed

• Always public index method if no policy
• Unit test that shows routes list command.
• Fix Gate::check - show - not working

Support

• Added unit tests for the testing helpers (action, route and getters).

Fixed

• Belongs search with custom foreign key #512

Fixed

• The unauthorized code should be 401.

Refactored

• The testing Repository::route( method has a new signature, it accepts the action as well now.

Fixed

• Cache enable option is considered during the policy methods check.

Fixed

• Action logs should be enabled now.

Added

This will enable policies to be cached by adding the configuration:

  'cache' => [
      /*
      | Specify the cache configuration for the resources policies.
      | When enabled, methods from the policy will be cached for the active user.
      */
      'policies' => [
          'enabled' => true,

          /*
          | ttl in seconds
          */
          'ttl' => 5 * 60,
      ],
  ],

Added

• Added support for nested relationships when you want to get the parent and children in the same query. Imagine a tweet thread, where you want to list all tweets with its parent tweet along with its immediate children tweets. This is now possible and will do not run into infinite loop issue.

Fixed

• Support to mock repositories using YourRepository::partialMock() for the index request, previously it ran into the mock state and didn't update the second resources in tests.

Breaking

• The $eagerState repository property is now private, and it is of type null|string because it holds the parent repository that renders it.

Fixed

• Publish provider before routes so restifyAuth macro works.

Added

• Singleton could be loaded from the RestifyServiceProvider in the local repository so the dev will have control over that.

Fixed

• Nova routes conflict.

Added

• Loading routes from the LaraveRestifyApplicationProvider so developers could override or comment that out.

Added

• [6.x] Bulk update and deletion callbacks.

[7.0.0] 2022-07-24

• Adding support for custom ActionLogs (ie ActionLog::register("project marked active by user Auth::id()", $project->id))
• Ensure $with loads relationship in show requests
• Make sure any action isn't permitted unless the Model Policy exists
• Having a helper method that allow to return data using the repository from a custom controller PostRepository::withModels(Post::query()->take(5)->get())->include('user')->serializeForShow() - see seralizer()
• Ability to make an endpoint public using a policy method
• Load specific fields for nested relationships (ie: api/restify/company/include=users.posts[id, name].comments[title])
• Load nested for relationships with a nested level higher than 2 (so now you can load any nested level you need a.b.c.d)
• Shorter definition of Related fields HasMany::make('posts')
• Performance improvements

see Change Log and Upgrading guideline

Fixed

• Bulk deletion issue

Added

• Bulk side effect actions fixed.

Performance

• Do not check relationships if no query with relationships.

Added

• setTitle for filters so the FE could display them

public static function matches(): array
{
    return [
        'invoice_id' => MatchFilter::make()
            ->setType('array')
            ->setTitle('Job Number')
            ->setRelatedRepositoryKey(InvoiceRepository::uriKey()),
    ];
}

Added

Bulk delete flow

The payload for a bulk delete should contain an array of primary keys for the models you want to delete:

[
  1, 10, 15
]

These models will be resolved from the database and check for the deleteBulk policy permission, in case any of the models isn't allowed to be deleted, no entry will be deleted.

Fixed

• Change return value of handle method in getter #455

Fixed

• Boolean match filter

Fixed

• Fixing scout search.

Added

• Support to choose custom columns for BelongsTo and BelongsToMany and MorphMany relationships

Fixed

• Getter requests dump

Fixed

• Fixed image has filesystem on null.

Fixed

• related fix

Added

Load specific columns

Sometimes you might want to load specific columns from the database into the response. For example, if you have a Post model with an id, title and a description column, you might want to load only the title and the description column in the response.

In order to do this, you can use in the request:

GET /users/1?include=posts[title|description]