# Open Southeners Packages

## Home

- [Open Southeners Documentation](https://docs.opensoutheners.com/oss/readme.md): Documentation for Open Southeners open source libraries. Find installation guides, usage examples and a community to build with.

## Laravel SCIM

- [Introduction](https://docs.opensoutheners.com/oss/laravel-scim/readme.md)
- [Installation](https://docs.opensoutheners.com/oss/laravel-scim/installation.md)
- [Configuration](https://docs.opensoutheners.com/oss/laravel-scim/configuration.md)
- [Defining Schemas](https://docs.opensoutheners.com/oss/laravel-scim/defining-schemas.md)
- [Registering Resources](https://docs.opensoutheners.com/oss/laravel-scim/registering-resources.md)
- [Authorization](https://docs.opensoutheners.com/oss/laravel-scim/authorization.md)
- [PATCH Operations](https://docs.opensoutheners.com/oss/laravel-scim/patch-operations.md)
- [Filtering](https://docs.opensoutheners.com/oss/laravel-scim/filtering.md)
- [Enterprise Extensions](https://docs.opensoutheners.com/oss/laravel-scim/enterprise-extensions.md)
- [Events](https://docs.opensoutheners.com/oss/laravel-scim/events.md)
- [Error Handling](https://docs.opensoutheners.com/oss/laravel-scim/error-handling.md)
- [Discovery Endpoints](https://docs.opensoutheners.com/oss/laravel-scim/discovery-endpoints.md)
- [Testing](https://docs.opensoutheners.com/oss/laravel-scim/testing.md)
- [Upgrade Guide](https://docs.opensoutheners.com/oss/laravel-scim/upgrade-guide.md)

## Extended Laravel

- [Getting started](https://docs.opensoutheners.com/oss/extended-laravel/readme.md)
- [Helpers](https://docs.opensoutheners.com/oss/extended-laravel/function-helpers.md): List of functions that works for Laravel Eloquent models.
- [Commands](https://docs.opensoutheners.com/oss/extended-laravel/commands.md): Added commands on top of the replacements did on top of the functionality of the Laravel ones.
- [Middleware](https://docs.opensoutheners.com/oss/extended-laravel/middleware.md): Some useful middleware for your HTTP routes of your Laravel app or API.
- [Facades](https://docs.opensoutheners.com/oss/extended-laravel/facades.md): This package extends Laravel's framework facades with new useful methods.

## Laravel Apiable

- [Introduction](https://docs.opensoutheners.com/oss/laravel-apiable/readme.md): A Laravel package that integrates JSON:API resources into your API projects with filtering, sorting, includes, pagination, and more.
- [Installation](https://docs.opensoutheners.com/oss/laravel-apiable/getting-started/installation.md): Install and configure laravel-apiable in your Laravel application.
- [Model Setup](https://docs.opensoutheners.com/oss/laravel-apiable/getting-started/model-setup.md): Prepare your Eloquent models for JSON:API serialization.
- [Configuration Reference](https://docs.opensoutheners.com/oss/laravel-apiable/getting-started/configuration.md): Full annotated reference for every option in config/apiable.php.
- [Serialization](https://docs.opensoutheners.com/oss/laravel-apiable/responses/serialization.md): Transform your Eloquent models and collections into JSON:API format using multiple serialization approaches.
- [JsonApiResponse](https://docs.opensoutheners.com/oss/laravel-apiable/responses/json-api-response.md): The main entry point for building JSON:API responses with filtering, sorting, pagination and more.
- [Pagination](https://docs.opensoutheners.com/oss/laravel-apiable/responses/pagination.md): Configure pagination strategies for your JSON:API responses including length-aware, simple, and cursor-based pagination.
- [Content Negotiation](https://docs.opensoutheners.com/oss/laravel-apiable/responses/content-negotiation.md): Control response formatting based on Accept headers or force a specific format for your API.
- [Viewable Queries](https://docs.opensoutheners.com/oss/laravel-apiable/responses/viewable-queries.md): Scope API queries by user access using viewable query scopes on your models.
- [Overview](https://docs.opensoutheners.com/oss/laravel-apiable/request-features/overview.md): Allow API consumers to filter, sort, include relationships, select fields, append accessors, and search your resources.
- [Filters](https://docs.opensoutheners.com/oss/laravel-apiable/request-features/filters.md): Filter API resources by attributes, relationships, or query scopes with configurable operators.
- [Sorts](https://docs.opensoutheners.com/oss/laravel-apiable/request-features/sorts.md): Sort API resources by attributes or relationships with configurable direction constraints.
- [Includes](https://docs.opensoutheners.com/oss/laravel-apiable/request-features/includes.md): Eager-load relationships and include them as compound documents in your JSON:API responses.
- [Sparse Fieldsets](https://docs.opensoutheners.com/oss/laravel-apiable/request-features/fields.md): Select specific attributes per resource type using JSON:API sparse fieldsets.
- [Appends](https://docs.opensoutheners.com/oss/laravel-apiable/request-features/appends.md): Append computed model accessors to your JSON:API resource attributes.
- [Search](https://docs.opensoutheners.com/oss/laravel-apiable/request-features/search.md): Perform full-text search on your resources using Laravel Scout integration.
- [Query Param Validation](https://docs.opensoutheners.com/oss/laravel-apiable/request-features/validation.md): Validate incoming query parameters against your allowed definitions.
- [Error Handling](https://docs.opensoutheners.com/oss/laravel-apiable/error-handling/error-handling.md): Render application errors and exceptions in JSON:API format.
- [Generating Documentation](https://docs.opensoutheners.com/oss/laravel-apiable/documentation-generator/overview.md): Generate API documentation from your annotated controllers with a single Artisan command.
- [Annotating Controllers](https://docs.opensoutheners.com/oss/laravel-apiable/documentation-generator/annotating-controllers.md): Annotate your controllers with PHP attributes to generate rich API documentation.
- [Output Formats](https://docs.opensoutheners.com/oss/laravel-apiable/documentation-generator/output-formats.md): Detailed reference for each documentation output format: Postman, Markdown, and OpenAPI.
- [Customising Stubs](https://docs.opensoutheners.com/oss/laravel-apiable/documentation-generator/customising-stubs.md): Customise the Markdown templates used for documentation generation.
- [TypeScript Schema Export](https://docs.opensoutheners.com/oss/laravel-apiable/documentation-generator/typescript-schema.md): Generate a typed TypeScript module describing every endpoint's allowed filters, sorts, includes, fields and appends.
- [Testing](https://docs.opensoutheners.com/oss/laravel-apiable/testing/testing.md): Assert JSON:API responses in PHPUnit with a fluent, chainable API.
- [Frontend Integration](https://docs.opensoutheners.com/oss/laravel-apiable/advanced/frontend-integration.md): Integrate your frontend application with a JSON:API backend.
- [Builder Macros & Helpers](https://docs.opensoutheners.com/oss/laravel-apiable/advanced/macros-and-helpers.md): Reference for all builder macros, collection macros, and Apiable helper methods.

## Laravel User Interactions

- [Getting started](https://docs.opensoutheners.com/oss/laravel-user-interactions/getting-started.md): Integrate user interactions to your Laravel application like: followers, subscribers, likes, participants, etc
- [Usage](https://docs.opensoutheners.com/oss/laravel-user-interactions/usage.md): All methods available on this package to be used

## Laravel Companion Apps

- [Getting started](https://docs.opensoutheners.com/oss/laravel-companion-apps/getting-started.md): Installing package into your Laravel application.
- [Usage](https://docs.opensoutheners.com/oss/laravel-companion-apps/usage.md): Usage of companion applications within your application

## Laravel Data Mapper

- [Welcome](https://docs.opensoutheners.com/oss/laravel-data-mapper/readme.md): Installing Laravel data mapper in your application.
- [Usage](https://docs.opensoutheners.com/oss/laravel-data-mapper/getting-started/usage.md): Data transfer objects are useful to pass data, they can be used everywhere but has some special uses in multiple places like controllers (including their route bindings) and queued jobs.
- [Data objects](https://docs.opensoutheners.com/oss/laravel-data-mapper/data-objects.md): Mapping arrays or JSON strings into structured classes.
- [Upgrading](https://docs.opensoutheners.com/oss/laravel-data-mapper/upgrading.md): In your application was using the previous version 3 of this package.
- [Extending mapper](https://docs.opensoutheners.com/oss/laravel-data-mapper/advanced/extending-mapper.md): Data mapper can be extended to understand other classes or by using first-hand crafted classes.
- [Generating TypeScript code](https://docs.opensoutheners.com/oss/laravel-data-mapper/advanced/typescript.md)
- [Generating validation rules](https://docs.opensoutheners.com/oss/laravel-data-mapper/advanced/generating-validation-rules.md): Generate validation rules from PHP object classes

* [Getting started](https://docs.opensoutheners.com/oss/laravel-data-mapper/3.x/readme.md): Installing Laravel DTO in your application.
* [Creating DTOs](https://docs.opensoutheners.com/oss/laravel-data-mapper/3.x/creating-dtos.md): Creating data transfer object classes and adding properties to them in a proper way so they can be mapped.
* [Usage](https://docs.opensoutheners.com/oss/laravel-data-mapper/3.x/usage.md): Data transfer objects are useful to pass data, they can be used everywhere but has some special uses in multiple places like controllers (including their route bindings) and queued jobs.
* [TypeScript generator](https://docs.opensoutheners.com/oss/laravel-data-mapper/3.x/typescript.md): Data transfer objects that converts to TypeScript types for your own convenience.

## Laravel Scout Advanced Meilisearch

- [Getting started](https://docs.opensoutheners.com/oss/laravel-scout-advanced-meilisearch/getting-started.md): Advanced Meilisearch integration with Laravel Scout.
- [Commands](https://docs.opensoutheners.com/oss/laravel-scout-advanced-meilisearch/commands.md): This package adds more commands to Laravel to manage Meilisearch search engine stuff
- [MultiSearch](https://docs.opensoutheners.com/oss/laravel-scout-advanced-meilisearch/multisearch.md): Meilisearch's multi-index search support for Laravel.
- [Index settings](https://docs.opensoutheners.com/oss/laravel-scout-advanced-meilisearch/index-settings.md): Model attribute or methods used to setup other index settings for Meilisearch

## Byte Unit Converter

- [Getting started](https://docs.opensoutheners.com/oss/byte-unit-converter/getting-started.md): Installation and usage of the Byte unit converter library.
- [Usage](https://docs.opensoutheners.com/oss/byte-unit-converter/usage.md): Full documentation on how to use the ByteUnitConverter library on your PHP project.
- [Use as a Laravel cast](https://docs.opensoutheners.com/oss/byte-unit-converter/use-as-a-laravel-cast.md): Example of a usage for this library as a Laravel cast on an Eloquent model.

* [Getting started](https://docs.opensoutheners.com/oss/byte-unit-converter/2.x/getting-started.md): Installation and usage of the Byte unit converter library.
* [Usage](https://docs.opensoutheners.com/oss/byte-unit-converter/2.x/usage.md): Full documentation on how to use the ByteUnitConverter library on your PHP project.
* [Use as a Laravel cast](https://docs.opensoutheners.com/oss/byte-unit-converter/2.x/use-as-a-laravel-cast.md): Example of a usage for this library as a Laravel cast on an Eloquent model.

## Extended PHP

- [Getting started](https://docs.opensoutheners.com/oss/extended-php/readme.md)
- [Strings helpers](https://docs.opensoutheners.com/oss/extended-php/strings-helpers.md): List of functions that works for PHP strings.
- [Enums helpers](https://docs.opensoutheners.com/oss/extended-php/enums-helpers.md): List of functions that works for PHP enums.
- [Classes helpers](https://docs.opensoutheners.com/oss/extended-php/classes-helpers.md): List of functions that works for PHP classes.

## Vue 3 Emitter

- [Getting started](https://docs.opensoutheners.com/oss/vue-3-emitter/getting-started.md): Install and get started with the library on your Vue 3 app
- [Usage](https://docs.opensoutheners.com/oss/vue-3-emitter/usage.md): There are multiple ways to use vue3-emitter on your project, you can choose the one you prefer at any time.
- [Components](https://docs.opensoutheners.com/oss/vue-3-emitter/components.md): Add event listeners and emitters directly into the DOM (HTML) acting as any other Vue component.
- [TypeScript](https://docs.opensoutheners.com/oss/vue-3-emitter/typescript.md): Typing globally available events using TypeScript.
- [Upgrade guide](https://docs.opensoutheners.com/oss/vue-3-emitter/upgrade-guide.md): This guide will help you upgrade from older versions (if there are any problems with previous code).

## Flex URL

- [Introduction](https://docs.opensoutheners.com/oss/flex-url/readme.md): An immutable, fluent URL builder/parser for the apiable request-query grammar, available as a TypeScript package and a mirrored PHP package.
- [Installation](https://docs.opensoutheners.com/oss/flex-url/getting-started/installation.md): Install the TypeScript or PHP flex-url package.
- [Quick Start](https://docs.opensoutheners.com/oss/flex-url/getting-started/quick-start.md): A tour of the flex-url builder and reader API.
- [Filters](https://docs.opensoutheners.com/oss/flex-url/building-urls/filters.md): Build filter\[] query parameters, including operators, scoped filters, and multi-value lists.
- [Sorting](https://docs.opensoutheners.com/oss/flex-url/building-urls/sorting.md): Build sort= query parameters, ascending and descending.
- [Includes, Fields & Appends](https://docs.opensoutheners.com/oss/flex-url/building-urls/includes-fields-appends.md): Build include=, fields\[type]=, and appends\[type]= query parameters for compound documents and sparse fieldsets.
- [Pagination](https://docs.opensoutheners.com/oss/flex-url/building-urls/pagination.md): Build page\[number], page\[size], and page\[cursor] query parameters.
- [Search](https://docs.opensoutheners.com/oss/flex-url/building-urls/search.md): Build q= full-text search and q\[filter]\[]= search-scoped filter query parameters.
- [Raw Params & Clearing](https://docs.opensoutheners.com/oss/flex-url/building-urls/raw-params-and-clearing.md): Set arbitrary query params outside the typed grammar, and remove or clear buckets and params.
- [Reading State Back](https://docs.opensoutheners.com/oss/flex-url/reading-urls/reading-state.md): Read filters, sorts, includes, fields, appends, pagination, search, and raw params back off a parsed URL.
- [toParams() & toQuery()](https://docs.opensoutheners.com/oss/flex-url/reading-urls/params-and-query-arrays.md): Read the whole builder state as a nested object/array with toParams(), or as a parse\_str()-shaped array with PHP's toQuery().
- [Output Forms](https://docs.opensoutheners.com/oss/flex-url/reading-urls/output-forms.md): Render a builder to a full URL, a request URI, or a relative navigation URL — and when to use each.
- [Encoding Contract](https://docs.opensoutheners.com/oss/flex-url/advanced/encoding-contract.md): How flex-url percent-encodes values, treats commas, and parses malformed or non-UTF-8 input — identically in both languages.
- [Typed Schemas (TypeScript)](https://docs.opensoutheners.com/oss/flex-url/advanced/typed-schemas.md): Narrow the TypeScript builder to a specific endpoint's allowed filters, sorts, includes, fields, and appends at compile time.
- [JSON:API Links Helper (TypeScript)](https://docs.opensoutheners.com/oss/flex-url/advanced/json-api-links.md): Read links/meta off a JSON:API document and jump straight to the next/previous page as a FlexUrl instance.
- [PSR-7 & Requests (PHP)](https://docs.opensoutheners.com/oss/flex-url/advanced/psr7-and-requests.md): Construct a FlexUrl from a PSR-7 UriInterface or a Laravel Request without adding a framework dependency.
- [Test Parity Between Mirrors](https://docs.opensoutheners.com/oss/flex-url/testing/testing-and-parity.md): How the TypeScript and PHP mirrors are tested against the same JSON fixtures so they can't silently drift apart.
- [Upgrading from 1.x](https://docs.opensoutheners.com/oss/flex-url/migration/upgrading-from-v1.md): Migrate from the 1.x FlexibleUrl class (TypeScript-only) to the 2.x/3.x FlexUrl builder.

## Lambdary

- [Introduction](https://docs.opensoutheners.com/oss/lambdary/readme.md): A local development server for AWS Lambda functions that runs each function on the same runtimes AWS uses.
- [Installation](https://docs.opensoutheners.com/oss/lambdary/getting-started/installation.md): Install Lambdary with Homebrew, Go, a prebuilt binary or the Docker image.
- [Quick Start](https://docs.opensoutheners.com/oss/lambdary/getting-started/quick-start.md): Scaffold a function, run the dev server and call it over HTTP and the AWS CLI.
- [How It Works](https://docs.opensoutheners.com/oss/lambdary/getting-started/how-it-works.md): How Lambdary discovers functions, turns HTTP requests into Lambda events and runs your code.
- [Function Configuration](https://docs.opensoutheners.com/oss/lambdary/configuration/function-config.md): Every key of a function's .lambda.yml, with defaults.
- [Project Configuration](https://docs.opensoutheners.com/oss/lambdary/configuration/project-config.md): Every key of the project-wide lambdary.yml, with defaults.
- [Environment Variables](https://docs.opensoutheners.com/oss/lambdary/configuration/environment-variables.md): Environment variables Lambdary reads, and the ones it sets for your functions.
- [Go Functions](https://docs.opensoutheners.com/oss/lambdary/guides/go-functions.md): Run Go Lambda functions without building a bootstrap by hand.
- [Layers](https://docs.opensoutheners.com/oss/lambdary/guides/layers.md): Use Lambda layers from layer version ARNs or local directories.
- [Versions and Aliases](https://docs.opensoutheners.com/oss/lambdary/guides/versions-and-aliases.md): Publish function versions, create aliases and run weighted canaries locally.
- [Queues and Schedules](https://docs.opensoutheners.com/oss/lambdary/guides/queues-and-schedules.md): Run SQS event source mappings and EventBridge schedules locally.
- [Sample Events](https://docs.opensoutheners.com/oss/lambdary/guides/sample-events.md): Build SQS, S3, schedule and API Gateway sample events for lambdary invoke.
- [Asynchronous Invokes](https://docs.opensoutheners.com/oss/lambdary/guides/async-invokes.md): Asynchronous Event invokes, their retries, and DryRun.
- [Logs, Metrics and Health](https://docs.opensoutheners.com/oss/lambdary/guides/logs-metrics-and-health.md): Read function output, invocation metrics and server health from a running dev server.
- [Docker Compose](https://docs.opensoutheners.com/oss/lambdary/guides/docker-compose.md): Run lambdary dev as a Docker Compose service next to the rest of your stack.
- [Using AWS SDKs and the CLI](https://docs.opensoutheners.com/oss/lambdary/guides/using-aws-sdks.md): Point the AWS CLI and AWS SDKs at the dev server for Lambda, SQS and CloudWatch calls.
- [Commands](https://docs.opensoutheners.com/oss/lambdary/reference/commands.md): Every lambdary command and flag.
- [AWS API](https://docs.opensoutheners.com/oss/lambdary/reference/aws-api.md): Every AWS Lambda, SQS and CloudWatch call the dev server answers, and Lambdary's own endpoints.
- [Limitations](https://docs.opensoutheners.com/oss/lambdary/reference/limitations.md): Where Lambdary differs from AWS Lambda, and known gaps.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
This site has an agentic ask interface you may use to query the documentation dynamically by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.opensoutheners.com/oss/index.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
