PHPackages                             invoiceshelf/modules - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. invoiceshelf/modules

ActiveLibrary[Utility & Helpers](/categories/utility)

invoiceshelf/modules
====================

InvoiceShelf-specific extensions for nwidart/laravel-modules — registry for module-contributed sidebar items and settings schemas.

3.0.2(4mo ago)023.6k↓38.7%MITPHPPHP ^8.3

Since Dec 21Pushed 1w agoCompare

[ Source](https://github.com/InvoiceShelf/modules)[ Packagist](https://packagist.org/packages/invoiceshelf/modules)[ RSS](/packages/invoiceshelf-modules/feed)WikiDiscussions master Synced 2w ago

READMEChangelogDependencies (11)Versions (5)Used By (0)

InvoiceShelf Modules SDK
========================

[](#invoiceshelf-modules-sdk)

The MIT-licensed SDK for official [InvoiceShelf](https://invoiceshelf.com) v3 modules. It extends [`nwidart/laravel-modules`](https://github.com/nWidart/laravel-modules) with the contracts used by InvoiceShelf's module host and signed marketplace packages.

SDK **3.3** supports Module API **1.2**. First-party module packages live in their own repositories and are licensed `AGPL-3.0-only`; this SDK remains MIT.

What a module can add
---------------------

[](#what-a-module-can-add)

- Sidebar entries and schema-driven, per-company settings.
- Local, compiled JavaScript and CSS registered with the host.
- Typed frontend contributions through [`frontend/index.d.ts`](frontend/index.d.ts): routes, menus, HTTP access, translations, notifications, and lifecycle events. The host supplies the Vue, router, Axios, and i18n instances—modules do not bundle another framework runtime.
- Narrow host contracts under [`src/Contracts/Host`](src/Contracts/Host) for settings, authorization, and the AI assistant's read-only company-data queries. Module code must not depend on InvoiceShelf Eloquent models.
- AI drivers through [`src/Ai`](src/Ai): extend `AiDriver`, return `AiChatResponse`, and throw `AiException` for safe, localizable provider failures.

The host controls discovery, installation, activation, migrations, and provider registration. Official packages are not a general-purpose runtime Composer installer for arbitrary third-party code.

Compatibility
-------------

[](#compatibility)

Declare compatibility in `module.json`, then test it against the host versions you support.

ConcernCurrent contractSDK`invoiceshelf/modules` `^3.3`Module API`^1.2.0`Host applicationYour explicit InvoiceShelf 3.x rangePHPThe range your module actually supportsComposer caret constraints do **not** include prereleases. For example, `^3.0.0` starts at the final `3.0.0`, so it excludes `3.0.0-alpha.*`. A module intended for the current v3 preview must explicitly opt in, for example:

```
"invoiceshelf": ">=3.0.0-alpha.2 =3.0.0-alpha.2