craft-hub / MarketplacePluginPackResult

Interface: MarketplacePluginPackResult

Defined in: packages/craft-hub/src/plugin-authoring.ts:49

Immutable package artifacts and Catalog Entry draft produced from a validated plugin.

Extends

• MarketplacePluginValidation

Properties

catalogEntry

catalogEntry: object

Defined in: packages/craft-hub/src/plugin-authoring.ts:53

categories

categories: string[]

description?

optional description?: string

displayName

displayName: string

icon?

optional icon?: string

includesPlugins

includesPlugins: object[]

integrity

integrity: string

links?

optional links?: object

links.documentation?

optional documentation?: string

links.feedback?

optional feedback?: string

links.homepage?

optional homepage?: string

links.repository?

optional repository?: string

localizations?

optional localizations?: Record<string, { description?: string; displayName?: string; permissionReasons?: Record<string, string>; }>

maintainers?

optional maintainers?: object[]

package

package: string

permissionReasons?

optional permissionReasons?: Record<string, string>

permissions

permissions: ("local-read" | "local-write" | "remote-read" | "remote-write" | "commands" | "command-presets" | "read-project-files" | "read-user-settings")[]

publisher

publisher: string

replacement?

optional replacement?: string

requires?

optional requires?: string

requiresPlugins

requiresPlugins: object[]

slug?

optional slug?: string

status

status: "active" | "deprecated" | "blocked"

statusReason?

optional statusReason?: string

version

version: string

---

catalogEntryPath

catalogEntryPath: string

Defined in: packages/craft-hub/src/plugin-authoring.ts:51

---

integrity

integrity: string

Defined in: packages/craft-hub/src/plugin-authoring.ts:52

---

license

license: string

Defined in: packages/craft-hub/src/plugin-authoring.ts:43

Inherited from

MarketplacePluginValidation.license

---

manifest

manifest: object

Defined in: packages/craft-hub/src/plugin-authoring.ts:44

contributes

contributes: object

contributes.commandPresets

commandPresets: object[]

contributes.commands

commands: object[]

contributes.commandTemplates

commandTemplates: object[]

contributes.integrations

integrations: object[]

contributes.navigationPanels

navigationPanels: object[]

contributes.packageLinks

packageLinks: object[]

contributes.packageQuickActions

packageQuickActions: object[]

contributes.packageToolGroups

packageToolGroups: object[]

contributes.projectTemplates

projectTemplates: object[]

contributes.skills

skills: object[]

contributes.workbenches

workbenches: object[]

craftHub

craftHub: object

craftHub.minVersion?

optional minVersion?: string

description?

optional description?: string

displayName

displayName: string

icon?

optional icon?: string

id

id: string

includesPlugins

includesPlugins: object[]

links?

optional links?: object

links.documentation?

optional documentation?: string

links.feedback?

optional feedback?: string

links.homepage?

optional homepage?: string

links.repository?

optional repository?: string

localizations?

optional localizations?: Record<string, { description?: string; displayName?: string; permissionReasons?: Record<string, string>; }>

maintainers?

optional maintainers?: object[]

permissionReasons?

optional permissionReasons?: Record<string, string>

permissions

permissions: ("local-read" | "local-write" | "remote-read" | "remote-write" | "commands" | "command-presets" | "read-project-files" | "read-user-settings")[]

projectFiles

projectFiles: string[]

requiresPlugins

requiresPlugins: object[]

schemaVersion

schemaVersion: 1

slug?

optional slug?: string

Inherited from

MarketplacePluginValidation.manifest

---

packageName

packageName: string

Defined in: packages/craft-hub/src/plugin-authoring.ts:41

Inherited from

MarketplacePluginValidation.packageName

---

packedFiles

packedFiles: string[]

Defined in: packages/craft-hub/src/plugin-authoring.ts:45

Inherited from

MarketplacePluginValidation.packedFiles

---

rootPath

rootPath: string

Defined in: packages/craft-hub/src/plugin-authoring.ts:40

Inherited from

MarketplacePluginValidation.rootPath

---

tarballPath

tarballPath: string

Defined in: packages/craft-hub/src/plugin-authoring.ts:50

---

version

version: string

Defined in: packages/craft-hub/src/plugin-authoring.ts:42

Inherited from

MarketplacePluginValidation.version