packages
packages
Section titled “packages”| Field | Value |
|---|---|
| Prefix | packages |
| Namespace constant | PackageManagementNamespace |
| Subjects constant | PackageSubjects |
| Kind | bus |
| Schema record | PackageManagementSchemas |
| Tier | framework |
| Package | @makaio/services-package-manager |
| Defined in | packages/services/package-manager/src/namespace.ts |
Subjects
Section titled “Subjects”| Key | Wire | Type | Schema |
|---|---|---|---|
checkUpdates | packages.checkUpdates | rpc | schemas.ts |
getLatestVersion | packages.getLatestVersion | rpc | schemas.ts |
getRegistry | packages.getRegistry | rpc | schemas.ts |
install | packages.install | rpc | schemas.ts |
installed | packages.installed | event | schemas.ts |
list | packages.list | rpc | schemas.ts |
uninstall | packages.uninstall | rpc | schemas.ts |
uninstalled | packages.uninstalled | event | schemas.ts |
Subject Details
Section titled “Subject Details”packages.checkUpdates (rpc)
Section titled “packages.checkUpdates (rpc)”Check for package updates.
Compares installed packages against npm registry to find available updates.
Subject: packages.checkUpdates
Type: Request (RPC)
Request:
Empty object.
Response:
| Field | Type | Required |
|---|---|---|
updates | { name: string; currentVersion: string; latestVersion: string; description?: string | undefined; }[] | yes |
packages.getLatestVersion (rpc)
Section titled “packages.getLatestVersion (rpc)”Get latest version from registry.
Checks npm registry for the latest available version.
Subject: packages.getLatestVersion
Type: Request (RPC)
Request:
| Field | Type | Required |
|---|---|---|
packageName | string | yes |
Response:
| Field | Type | Required |
|---|---|---|
error | string | undefined | no |
latestVersion | string | yes |
packageName | string | yes |
success | boolean | yes |
packages.getRegistry (rpc)
Section titled “packages.getRegistry (rpc)”Get package registry.
Fetches the GitHub-hosted packages.json registry.
Subject: packages.getRegistry
Type: Request (RPC)
Request:
Empty object.
Response:
| Field | Type | Required |
|---|---|---|
$schema | string | yes |
adapters | { name: string; displayName: string; description: string; icon?: string | undefined; tags?: string[] | undefined; }[] | yes |
extensions | { name: string; displayName: string; description: string; icon?: string | undefined; tags?: string[] | undefined; }[] | yes |
updatedAt | string | yes |
packages.install (rpc)
Section titled “packages.install (rpc)”Install a package.
Install an extension package from the configured source.
Subject: packages.install
Type: Request (RPC)
Request:
| Field | Type | Required |
|---|---|---|
packageName | string | yes |
source | "local" | "npm" | undefined | no |
Response:
| Field | Type | Required |
|---|---|---|
error | string | undefined | no |
packageName | string | yes |
restartRequired | boolean | yes |
success | boolean | yes |
version | string | undefined | no |
packages.installed (event)
Section titled “packages.installed (event)”Emitted after a package is successfully installed.
Fire-and-forget event — no response expected. Subscribers can use this for UI refresh, hot-reload triggers, or logging.
Subject: packages.installed
Type: Event
| Field | Type | Required |
|---|---|---|
packageName | string | yes |
version | string | yes |
packages.list (rpc)
Section titled “packages.list (rpc)”List installed packages.
Returns all installed extension packages.
Subject: packages.list
Type: Request (RPC)
Request:
Empty object.
Response:
| Field | Type | Required |
|---|---|---|
packages | { name: string; version: string; hasDescriptor: boolean; description?: string | undefined; }[] | yes |
packages.uninstall (rpc)
Section titled “packages.uninstall (rpc)”Uninstall a package.
Removes a package from ~/.makaio/.
Subject: packages.uninstall
Type: Request (RPC)
Request:
| Field | Type | Required |
|---|---|---|
packageName | string | yes |
Response:
| Field | Type | Required |
|---|---|---|
error | string | undefined | no |
packageName | string | yes |
restartRequired | boolean | yes |
success | boolean | yes |
packages.uninstalled (event)
Section titled “packages.uninstalled (event)”Emitted after a package is successfully uninstalled.
Fire-and-forget event — no response expected.
Subject: packages.uninstalled
Type: Event
| Field | Type | Required |
|---|---|---|
packageName | string | yes |
Auto-generated by yarn docs:bus. Do not edit manually.