Interface: iPluginDoc<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1768

Extends#

• Doc

Type Parameters#

T#

T extends NumberType

Properties#

_docId#

_docId: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/base.ts:13

A unique stringified document ID

Inherited from#

Doc._docId

---

_id?#

optional _id?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/base.ts:16

A unique document ID (Mongo DB ObjectID)

Inherited from#

Doc._id

---

createdAt#

createdAt: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1811

---

createdBy#

createdBy: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1770

The BitBadges address who created the plugin doc

---

deletedAt?#

optional deletedAt?: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1812

---

lastUpdated#

lastUpdated: T

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1809

---

locale?#

optional locale?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1807

Locale that is supported by the plugin. By default, we assume 'en' is supported if not specified.

---

managedBy#

managedBy: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1773

The BitBadges address of the user who is currently managing this

---

metadata#

metadata: object

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1787

createdBy#

createdBy: string

Creator of the plugin

description#

description: string

Description of the plugin

documentation?#

optional documentation?: string

Documentation for the plugin

image#

image: string

The image of the plugin

name#

name: string

The name of the plugin

parentApp?#

optional parentApp?: string

Parent app of the plugin. If blank, treated as its own app / entity.

sourceCode?#

optional sourceCode?: string

Source code for the plugin

supportLink?#

optional supportLink?: string

Support link for the plugin

---

pluginId#

pluginId: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1776

The unique plugin ID

---

pluginSecret?#

optional pluginSecret?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1779

The secret of the plugin. Used to verify BitBadges as origin of request.

---

reviewCompleted#

reviewCompleted: boolean

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1785

Review process completed

---

toPublish#

toPublish: boolean

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1782

To publish to directory?

---

versions#

versions: iPluginVersionConfig<T>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1815

Array of version-controlled plugin configurations