{ "schemaVersion": "1.0.0", "readme": "", "modules": [ { "kind": "javascript-module", "path": "src/components/cc-addon-admin/cc-addon-admin.events.js", "declarations": [ { "kind": "class", "description": "Dispatched when an addon deletion is requested.\n\nšŸ§ [component's source code on GitHub](https://github.com/CleverCloud/clever-components/blob/master/src/components/cc-addon-admin/cc-addon-admin.events.js)\n\n\n\n### Dependants\n```\nā”œā”€ cc-addon-admin.events\nā”‚ ā”œā”€ cc-addon-admin\n\n```", "name": "CcAddonDeleteEvent", "members": [ { "kind": "field", "name": "TYPE", "type": { "text": "string" }, "static": true, "default": "'cc-addon-delete'" } ], "superclass": { "name": "CcEvent", "module": "/src/lib/events.js" } }, { "kind": "class", "description": "Dispatched when an add-on name change is requested.\n\nšŸ§ [component's source code on GitHub](https://github.com/CleverCloud/clever-components/blob/master/src/components/cc-addon-admin/cc-addon-admin.events.js)\n\n\n\n### Dependants\n```\nā”œā”€ cc-addon-admin.events\nā”‚ ā”œā”€ cc-addon-admin\n\n```", "name": "CcAddonNameChangeEvent", "members": [ { "kind": "field", "name": "TYPE", "type": { "text": "string" }, "static": true, "default": "'cc-addon-name-change'" } ], "superclass": { "name": "CcEvent", "module": "/src/lib/events.js" } }, { "kind": "class", "description": "Dispatched when an addon tags change is requested.\n\nšŸ§ [component's source code on GitHub](https://github.com/CleverCloud/clever-components/blob/master/src/components/cc-addon-admin/cc-addon-admin.events.js)\n\n\n\n### Dependants\n```\nā”œā”€ cc-addon-admin.events\nā”‚ ā”œā”€ cc-addon-admin\n\n```", "name": "CcAddonTagsChangeEvent", "members": [ { "kind": "field", "name": "TYPE", "type": { "text": "string" }, "static": true, "default": "'cc-addon-tags-change'" } ], "superclass": { "name": "CcEvent", "module": "/src/lib/events.js" } }, { "kind": "class", "description": "Dispatched when an add-on has been deleted successfully.\n\nšŸ§ [component's source code on GitHub](https://github.com/CleverCloud/clever-components/blob/master/src/components/cc-addon-admin/cc-addon-admin.events.js)\n\n\n\n### Dependants\n```\nā”œā”€ cc-addon-admin.events\nā”‚ ā”œā”€ cc-addon-admin\n\n```", "name": "CcAddonWasDeletedEvent", "members": [ { "kind": "field", "name": "TYPE", "type": { "text": "string" }, "static": true, "default": "'cc-addon-was-deleted'" } ], "superclass": { "name": "CcEvent", "module": "/src/lib/events.js" } }, { "kind": "class", "description": "Dispatched when an add-on name has been changed successfully.\n\nšŸ§ [component's source code on GitHub](https://github.com/CleverCloud/clever-components/blob/master/src/components/cc-addon-admin/cc-addon-admin.events.js)\n\n\n\n### Dependants\n```\nā”œā”€ cc-addon-admin.events\nā”‚ ā”œā”€ cc-addon-admin\n\n```", "name": "CcAddonNameWasChangedEvent", "members": [ { "kind": "field", "name": "TYPE", "type": { "text": "string" }, "static": true, "default": "'cc-addon-name-was-changed'" } ], "superclass": { "name": "CcEvent", "module": "/src/lib/events.js" } } ], "exports": [ { "kind": "js", "name": "CcAddonDeleteEvent", "declaration": { "name": "CcAddonDeleteEvent", "module": "src/components/cc-addon-admin/cc-addon-admin.events.js" } }, { "kind": "js", "name": "CcAddonNameChangeEvent", "declaration": { "name": "CcAddonNameChangeEvent", "module": "src/components/cc-addon-admin/cc-addon-admin.events.js" } }, { "kind": "js", "name": "CcAddonTagsChangeEvent", "declaration": { "name": "CcAddonTagsChangeEvent", "module": "src/components/cc-addon-admin/cc-addon-admin.events.js" } }, { "kind": "js", "name": "CcAddonWasDeletedEvent", "declaration": { "name": "CcAddonWasDeletedEvent", "module": "src/components/cc-addon-admin/cc-addon-admin.events.js" } }, { "kind": "js", "name": "CcAddonNameWasChangedEvent", "declaration": { "name": "CcAddonNameWasChangedEvent", "module": "src/components/cc-addon-admin/cc-addon-admin.events.js" } } ] }, { "kind": "javascript-module", "path": "src/components/cc-addon-admin/cc-addon-admin.js", "declarations": [ { "kind": "class", "description": "A component displaying the admin interface of an add-on to edit its name or delete the add-on.\n\nšŸ§ [component's source code on GitHub](https://github.com/CleverCloud/clever-components/blob/master/src/components/cc-addon-admin/cc-addon-admin.js)\n\nšŸŽØ default CSS display: `block`\n\n### Type Definitions\n\n```ts\n\ntype AddonAdminState =\n | AddonAdminStateLoaded\n | AddonAdminStateLoading\n | AddonAdminStateError\n | AddonAdminStateSaving;\n\n```\n```ts\n\ninterface AddonAdminStateLoaded extends AddonAdminStateBase {\n type: 'loaded';\n}\n\n```\n```ts\n\ninterface AddonAdminStateLoading {\n type: 'loading';\n}\n\n```\n```ts\n\ninterface AddonAdminStateError {\n type: 'error';\n}\n\n```\n```ts\n\ntype AddonAdminStateSaving = AddonAdminStateDeleting | AddonAdminStateUpdatingName | AddonAdminStateUpdatingTags;\n\n```\n```ts\n\ninterface AddonAdminStateDeleting extends AddonAdminStateBase {\n type: 'deleting';\n}\n\n```\n```ts\n\ninterface AddonAdminStateUpdatingName extends AddonAdminStateBase {\n type: 'updating-name';\n}\n\n```\n```ts\n\ninterface AddonAdminStateUpdatingTags extends AddonAdminStateBase {\n type: 'updating-tags';\n}\n\n```\n```ts\n\ninterface AddonAdminStateBase {\n id: string;\n name: string;\n tags: string[];\n}\n\n```\n\n### Dependencies\n```\nā”œā”€ cc-addon-admin\nā”‚ ā”œā”€ cc-block-section\nā”‚ ā”œā”€ cc-block\nā”‚ ā”‚ ā”œā”€ cc-button\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”œā”€ cc-expand\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ cc-img\nā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”œā”€ cc-dialog-confirm-form\nā”‚ ā”‚ ā”œā”€ cc-dialog-confirm-actions\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-button\nā”‚ ā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”œā”€ cc-dialog\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-button\nā”‚ ā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-input-text\nā”‚ ā”‚ ā”‚ ā”‚ ā”œā”€ cc-clipboard\nā”‚ ā”‚ ā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”‚ ā”‚ ā”œā”€ cc-input-text.events\nā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”œā”€ cc-input-text\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-clipboard\nā”‚ ā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-input-text.events\nā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”œā”€ cc-dialog\nā”‚ ā”‚ ā”œā”€ cc-button\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ cc-input-text\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-clipboard\nā”‚ ā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-input-text.events\nā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”œā”€ cc-input-text\nā”‚ ā”‚ ā”œā”€ cc-clipboard\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”œā”€ cc-input-text.events\nā”‚ ā”œā”€ cc-loader\nā”‚ ā”œā”€ cc-notice\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ cc-notice.events\nā”‚ ā”œā”€ cc-addon-admin.events\n\n```", "name": "CcAddonAdmin", "members": [ { "kind": "field", "name": "noDangerZoneBackupText", "privacy": "public", "type": { "text": "boolean" }, "description": "Hides the text about backups within the danger zone when set to `true`", "default": "false", "attribute": "no-danger-zone-backup-text" }, { "kind": "field", "name": "noDangerZoneVmText", "privacy": "public", "type": { "text": "boolean" }, "description": "Hides the text about VM delay within the danger zone when set to `true`", "default": "false", "attribute": "no-danger-zone-vm-text" }, { "kind": "field", "name": "state", "privacy": "public", "type": { "text": "AddonAdminState" }, "description": "Sets the state of the component", "default": "{ type: 'loading' }", "attribute": "state" } ], "events": [ { "name": "cc-addon-delete", "type": { "text": "CcAddonDeleteEvent" }, "description": "Dispatched when an addon deletion is requested." }, { "name": "cc-addon-name-change", "type": { "text": "CcAddonNameChangeEvent" }, "description": "Dispatched when an add-on name change is requested." }, { "name": "cc-addon-tags-change", "type": { "text": "CcAddonTagsChangeEvent" }, "description": "Dispatched when an addon tags change is requested." } ], "attributes": [ { "name": "no-danger-zone-backup-text", "type": { "text": "boolean" }, "description": "Hides the text about backups within the danger zone when set to `true`", "default": "false", "fieldName": "noDangerZoneBackupText" }, { "name": "no-danger-zone-vm-text", "type": { "text": "boolean" }, "description": "Hides the text about VM delay within the danger zone when set to `true`", "default": "false", "fieldName": "noDangerZoneVmText" }, { "name": "state", "type": { "text": "AddonAdminState" }, "description": "Sets the state of the component", "default": "{ type: 'loading' }", "fieldName": "state" } ], "superclass": { "name": "LitElement", "package": "lit" }, "cssDisplay": "block", "tagName": "cc-addon-admin", "customElement": true } ], "exports": [ { "kind": "js", "name": "CcAddonAdmin", "declaration": { "name": "CcAddonAdmin", "module": "src/components/cc-addon-admin/cc-addon-admin.js" } }, { "kind": "custom-element-definition", "name": "cc-addon-admin", "declaration": { "name": "CcAddonAdmin", "module": "src/components/cc-addon-admin/cc-addon-admin.js" } } ] }, { "kind": "javascript-module", "path": "src/components/cc-addon-admin/cc-addon-admin.smart.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/cc-addon-backups/cc-addon-backups.js", "declarations": [ { "kind": "class", "description": "A components to display backups available for an add-on.\n\nšŸ§ [component's source code on GitHub](https://github.com/CleverCloud/clever-components/blob/master/src/components/cc-addon-backups/cc-addon-backups.js)\n\nšŸŽØ default CSS display: `block`\n\n## Details\n\n* If the retention is not standard (customized by the user), the `expiresAt` backup property should be nullish\n\n### Type Definitions\n\n```ts\n\ntype AddonBackupsState = AddonBackupsStateLoaded | AddonBackupsStateLoading | AddonBackupsStateError;\n\n```\n```ts\n\ninterface AddonBackupsStateLoaded {\n type: 'loaded';\n backups: Backup[];\n providerId: ProviderId;\n passwordForCommand: string;\n}\n\n```\n```ts\n\ninterface Backup {\n createdAt: string | number; // date as a string or timestamp\n expiresAt?: string | number; // date as a string or timestamp\n url: string;\n restoreCommand?: string;\n deleteCommand?: string;\n}\n\n```\n```ts\n\ntype ProviderId =\n | 'es-addon'\n | 'es-addon-old'\n | 'postgresql-addon'\n | 'mysql-addon'\n | 'mongodb-addon'\n | 'redis-addon'\n | 'jenkins';\n\n```\n```ts\n\ninterface AddonBackupsStateLoading {\n type: 'loading';\n}\n\n```\n```ts\n\ninterface AddonBackupsStateError {\n type: 'error';\n}\n\n```\n\n### Dependencies\n```\nā”œā”€ cc-addon-backups\nā”‚ ā”œā”€ cc-block-details\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”œā”€ cc-block-section\nā”‚ ā”œā”€ cc-block\nā”‚ ā”‚ ā”œā”€ cc-button\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”œā”€ cc-expand\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ cc-img\nā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”œā”€ cc-button\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”œā”€ cc-code\nā”‚ ā”‚ ā”œā”€ cc-clipboard\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”œā”€ cc-dialog\nā”‚ ā”‚ ā”œā”€ cc-button\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ cc-input-text\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-clipboard\nā”‚ ā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-input-text.events\nā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”œā”€ cc-icon\nā”‚ ā”œā”€ cc-input-text\nā”‚ ā”‚ ā”œā”€ cc-clipboard\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”œā”€ cc-input-text.events\nā”‚ ā”œā”€ cc-link\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ cc-img\nā”‚ ā”œā”€ cc-notice\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ cc-notice.events\n\n```", "name": "CcAddonBackups", "members": [ { "kind": "field", "name": "addonId", "privacy": "public", "type": { "text": "string" }, "description": "Sets the addon id for documentation", "default": "''", "attribute": "addon-id" }, { "kind": "field", "name": "state", "privacy": "public", "type": { "text": "AddonBackupsState" }, "description": "Sets the state of the component.", "default": "{\n type: 'loading',\n }", "attribute": "state" } ], "attributes": [ { "name": "addon-id", "type": { "text": "string" }, "description": "Sets the addon id for documentation", "default": "''", "fieldName": "addonId" }, { "name": "state", "type": { "text": "AddonBackupsState" }, "description": "Sets the state of the component.", "default": "{\n type: 'loading',\n }", "fieldName": "state" } ], "superclass": { "name": "LitElement", "package": "lit" }, "cssDisplay": "block", "tagName": "cc-addon-backups", "customElement": true } ], "exports": [ { "kind": "js", "name": "CcAddonBackups", "declaration": { "name": "CcAddonBackups", "module": "src/components/cc-addon-backups/cc-addon-backups.js" } }, { "kind": "custom-element-definition", "name": "cc-addon-backups", "declaration": { "name": "CcAddonBackups", "module": "src/components/cc-addon-backups/cc-addon-backups.js" } } ] }, { "kind": "javascript-module", "path": "src/components/cc-addon-backups/cc-addon-backups.smart.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/cc-addon-credentials-content/cc-addon-credentials-content.events.js", "declarations": [ { "kind": "class", "description": "Dispatched when a network group creation is requested.\n\nšŸ§ [component's source code on GitHub](https://github.com/CleverCloud/clever-components/blob/master/src/components/cc-addon-credentials-content/cc-addon-credentials-content.events.js)\n\n\n\n### Dependants\n```\nā”œā”€ cc-addon-credentials-content.events\nā”‚ ā”œā”€ cc-addon-credentials-content\n\n```", "name": "CcNgEnable", "members": [ { "kind": "field", "name": "TYPE", "type": { "text": "string" }, "static": true, "default": "'cc-ng-enable'" } ], "superclass": { "name": "CcEvent", "module": "/src/lib/events.js" } }, { "kind": "class", "description": "Dispatched when a network group deletion is requested.\n\nšŸ§ [component's source code on GitHub](https://github.com/CleverCloud/clever-components/blob/master/src/components/cc-addon-credentials-content/cc-addon-credentials-content.events.js)\n\n\n\n### Dependants\n```\nā”œā”€ cc-addon-credentials-content.events\nā”‚ ā”œā”€ cc-addon-credentials-content\n\n```", "name": "CcNgDisable", "members": [ { "kind": "field", "name": "TYPE", "type": { "text": "string" }, "static": true, "default": "'cc-ng-disable'" } ], "superclass": { "name": "CcEvent", "module": "/src/lib/events.js" } }, { "kind": "class", "description": "Dispatched when a secret renewal is requested.\n\nšŸ§ [component's source code on GitHub](https://github.com/CleverCloud/clever-components/blob/master/src/components/cc-addon-credentials-content/cc-addon-credentials-content.events.js)\n\n\n\n### Dependants\n```\nā”œā”€ cc-addon-credentials-content.events\nā”‚ ā”œā”€ cc-addon-credentials-content\n\n```", "name": "CcAddonCredentialsRenewSecret", "members": [ { "kind": "field", "name": "TYPE", "type": { "text": "string" }, "static": true, "default": "'cc-addon-credentials-renew-secret'" } ], "superclass": { "name": "CcEvent", "module": "/src/lib/events.js" } } ], "exports": [ { "kind": "js", "name": "CcNgEnable", "declaration": { "name": "CcNgEnable", "module": "src/components/cc-addon-credentials-content/cc-addon-credentials-content.events.js" } }, { "kind": "js", "name": "CcNgDisable", "declaration": { "name": "CcNgDisable", "module": "src/components/cc-addon-credentials-content/cc-addon-credentials-content.events.js" } }, { "kind": "js", "name": "CcAddonCredentialsRenewSecret", "declaration": { "name": "CcAddonCredentialsRenewSecret", "module": "src/components/cc-addon-credentials-content/cc-addon-credentials-content.events.js" } } ] }, { "kind": "javascript-module", "path": "src/components/cc-addon-credentials-content/cc-addon-credentials-content.js", "declarations": [ { "kind": "class", "description": "Displays a list of addon credentials (such as usernames, passwords, URLs, etc.).\n\nšŸ§ [component's source code on GitHub](https://github.com/CleverCloud/clever-components/blob/master/src/components/cc-addon-credentials-content/cc-addon-credentials-content.js)\n\nšŸŽØ default CSS display: `block`\n\n## Details\n\n* Renders each credential with a label and value, using appropriate controls (clipboard, input, etc.) depending on the credential type.\n* Handles skeleton state for loading.\n* Supports enabling/disabling network group access.\n\n### Type Definitions\n\n```ts\n\ntype AddonCredential =\n | {\n code: AddonCredentialCode;\n value: string;\n }\n | AddonCredentialNg;\n\n```\n```ts\n\ninterface AddonCredentialNg {\n code: 'ng';\n kind: 'standard' | 'multi-instances';\n value: AddonCredentialNgDisabled | AddonCredentialNgDisabling | AddonCredentialNgEnabled | AddonCredentialNgEnabling;\n}\n\n```\n```ts\n\ninterface AddonCredentialNgDisabled {\n status: 'disabled';\n}\n\n```\n```ts\n\ninterface AddonCredentialNgDisabling {\n status: 'disabling';\n id: string;\n}\n\n```\n```ts\n\ninterface AddonCredentialNgEnabled {\n status: 'enabled';\n id: string;\n}\n\n```\n```ts\n\ninterface AddonCredentialNgEnabling {\n status: 'enabling';\n}\n\n```\n\n### Dependencies\n```\nā”œā”€ cc-addon-credentials-content\nā”‚ ā”œā”€ cc-button\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”œā”€ cc-clipboard\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”œā”€ cc-input-text\nā”‚ ā”‚ ā”œā”€ cc-clipboard\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”œā”€ cc-input-text.events\nā”‚ ā”œā”€ cc-link\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ cc-img\nā”‚ ā”œā”€ cc-addon-credentials-content.events\n\n```\n\n### Dependants\n```\nā”œā”€ cc-addon-credentials-content\nā”‚ ā”œā”€ cc-addon-credentials\n\n```", "name": "CcAddonCredentialsContent", "members": [ { "kind": "field", "name": "credentials", "privacy": "public", "type": { "text": "Array" }, "description": "Sets the list of credentials displayed. The array order dictates the order in which credentials are rendered.", "default": "[]", "attribute": "credentials" }, { "kind": "field", "name": "disabled", "privacy": "public", "type": { "text": "boolean" }, "description": "Whether to display the component in disable state.", "default": "false", "attribute": "disabled" }, { "kind": "field", "name": "skeleton", "privacy": "public", "type": { "text": "boolean" }, "description": "Whether to display the component in skeleton (loading) state.", "default": "false", "attribute": "skeleton" } ], "events": [ { "name": "cc-addon-credentials-renew-secret", "type": { "text": "CcAddonCredentialsRenewSecret" }, "description": "Dispatched when a secret renewal is requested." }, { "name": "cc-ng-disable", "type": { "text": "CcNgDisable" }, "description": "Dispatched when a network group deletion is requested." }, { "name": "cc-ng-enable", "type": { "text": "CcNgEnable" }, "description": "Dispatched when a network group creation is requested." } ], "attributes": [ { "name": "credentials", "type": { "text": "Array" }, "description": "Sets the list of credentials displayed. The array order dictates the order in which credentials are rendered.", "default": "[]", "fieldName": "credentials" }, { "name": "disabled", "type": { "text": "boolean" }, "description": "Whether to display the component in disable state.", "default": "false", "fieldName": "disabled" }, { "name": "skeleton", "type": { "text": "boolean" }, "description": "Whether to display the component in skeleton (loading) state.", "default": "false", "fieldName": "skeleton" } ], "superclass": { "name": "LitElement", "package": "lit" }, "cssDisplay": "block", "tagName": "cc-addon-credentials-content", "customElement": true } ], "exports": [ { "kind": "js", "name": "CcAddonCredentialsContent", "declaration": { "name": "CcAddonCredentialsContent", "module": "src/components/cc-addon-credentials-content/cc-addon-credentials-content.js" } }, { "kind": "custom-element-definition", "name": "cc-addon-credentials-content", "declaration": { "name": "CcAddonCredentialsContent", "module": "src/components/cc-addon-credentials-content/cc-addon-credentials-content.js" } } ] }, { "kind": "javascript-module", "path": "src/components/cc-addon-credentials/cc-addon-credentials.client.js", "declarations": [ { "kind": "class", "description": "\nšŸ§ [component's source code on GitHub](https://github.com/CleverCloud/clever-components/blob/master/src/components/cc-addon-credentials/cc-addon-credentials.client.js)\n\n\n", "name": "CcAddonCredentialsClient", "members": [ { "kind": "method", "name": "createNg" }, { "kind": "method", "name": "deleteNg" }, { "kind": "method", "name": "getAddonWithOperator", "return": { "type": { "text": "Promise" } } } ] } ], "exports": [ { "kind": "js", "name": "CcAddonCredentialsClient", "declaration": { "name": "CcAddonCredentialsClient", "module": "src/components/cc-addon-credentials/cc-addon-credentials.client.js" } } ] }, { "kind": "javascript-module", "path": "src/components/cc-addon-credentials/cc-addon-credentials.js", "declarations": [ { "kind": "class", "description": "A component to display credentials for an add-on.\n\nšŸ§ [component's source code on GitHub](https://github.com/CleverCloud/clever-components/blob/master/src/components/cc-addon-credentials/cc-addon-credentials.js)\n\nšŸŽØ default CSS display: `block`\n\n## Details\n\nThis component displays various credentials for an add-on, such as username, password, direct access information, or other relevant connection details.\nIt supports different views through tabs, allowing users to switch between various access methods or categories.\n\nThe content displayed within each tab is managed by the `cc-addon-credentials-content` component. It also provides a link to the official documentation for more information.\n\n### Type Definitions\n\n```ts\n\ntype AddonCredentialsState =\n | AddonCredentialsStateLoading\n | AddonCredentialsStateError\n | AddonCredentialsStateLoaded\n | AddonCredentialsStateWaiting;\n\n```\n```ts\n\ninterface AddonCredentialsStateLoading {\n type: 'loading';\n tabs: Tabs;\n}\n\n```\n```ts\n\ntype Tabs = {\n [key in TabName & string]?: {\n content: Array;\n docLink?: {\n text: string;\n href: string;\n };\n };\n};\n\n```\n```ts\n\ninterface AddonCredentialsStateError {\n type: 'error';\n}\n\n```\n```ts\n\ninterface AddonCredentialsStateLoaded {\n type: 'loaded';\n tabs: Tabs;\n}\n\n```\n```ts\n\ninterface AddonCredentialsStateWaiting {\n type: 'waiting';\n tabs: Tabs;\n}\n\n```\n\n### Dependencies\n```\nā”œā”€ cc-addon-credentials\nā”‚ ā”œā”€ cc-addon-credentials-content\nā”‚ ā”‚ ā”œā”€ cc-button\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”œā”€ cc-clipboard\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ cc-input-text\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-clipboard\nā”‚ ā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-input-text.events\nā”‚ ā”‚ ā”œā”€ cc-link\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-img\nā”‚ ā”‚ ā”œā”€ cc-addon-credentials-content.events\nā”‚ ā”œā”€ cc-block-details\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”œā”€ cc-block\nā”‚ ā”‚ ā”œā”€ cc-button\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”œā”€ cc-expand\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ cc-img\nā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”œā”€ cc-code\nā”‚ ā”‚ ā”œā”€ cc-clipboard\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”œā”€ cc-input-text\nā”‚ ā”‚ ā”œā”€ cc-clipboard\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”œā”€ cc-input-text.events\nā”‚ ā”œā”€ cc-link\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ cc-img\nā”‚ ā”œā”€ cc-loader\nā”‚ ā”œā”€ cc-notice\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ cc-notice.events\nā”‚ ā”œā”€ cc-toggle\nā”‚ ā”‚ ā”œā”€ common.events\n\n```", "name": "CcAddonCredentials", "members": [ { "kind": "field", "name": "state", "privacy": "public", "type": { "text": "AddonCredentialsState" }, "default": "{\n type: 'loading',\n tabs: {\n default: {\n content: [],\n docLink: { text: fakeString(10), href: undefined },\n },\n },\n }", "attribute": "state" } ], "attributes": [ { "name": "state", "type": { "text": "AddonCredentialsState" }, "default": "{\n type: 'loading',\n tabs: {\n default: {\n content: [],\n docLink: { text: fakeString(10), href: undefined },\n },\n },\n }", "fieldName": "state" } ], "superclass": { "name": "LitElement", "package": "lit" }, "cssDisplay": "block", "tagName": "cc-addon-credentials", "customElement": true } ], "exports": [ { "kind": "js", "name": "CcAddonCredentials", "declaration": { "name": "CcAddonCredentials", "module": "src/components/cc-addon-credentials/cc-addon-credentials.js" } }, { "kind": "custom-element-definition", "name": "cc-addon-credentials", "declaration": { "name": "CcAddonCredentials", "module": "src/components/cc-addon-credentials/cc-addon-credentials.js" } } ] }, { "kind": "javascript-module", "path": "src/components/cc-addon-credentials/cc-addon-credentials.smart-cellar.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/cc-addon-credentials/cc-addon-credentials.smart-elastic.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/cc-addon-credentials/cc-addon-credentials.smart-keycloak.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/cc-addon-credentials/cc-addon-credentials.smart-materia-kv.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/cc-addon-credentials/cc-addon-credentials.smart-otoroshi.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/cc-addon-credentials/cc-addon-credentials.smart-pulsar.js", "declarations": [ { "kind": "function", "name": "getAddonProvider", "parameters": [ { "name": "params", "type": { "text": "@param {String} params.providerId\n * @param {String} params.addonId\n " } } ] }, { "kind": "function", "name": "getCluster", "parameters": [ { "name": "params", "type": { "text": "@param {String} params.providerId\n * @param {String} params.clusterId\n " } } ] } ], "exports": [ { "kind": "js", "name": "getAddonProvider", "declaration": { "name": "getAddonProvider", "module": "src/components/cc-addon-credentials/cc-addon-credentials.smart-pulsar.js" } }, { "kind": "js", "name": "getCluster", "declaration": { "name": "getCluster", "module": "src/components/cc-addon-credentials/cc-addon-credentials.smart-pulsar.js" } } ] }, { "kind": "javascript-module", "path": "src/components/cc-addon-elasticsearch-options/cc-addon-elasticsearch-options.js", "declarations": [ { "kind": "class", "description": "A component that displays the available options of an elasticsearch add-on.\n\nšŸ§ [component's source code on GitHub](https://github.com/CleverCloud/clever-components/blob/master/src/components/cc-addon-elasticsearch-options/cc-addon-elasticsearch-options.js)\n\nšŸŽØ default CSS display: `block`\n\n### Type Definitions\n\n```ts\n\ntype AddonOption = EncryptionAddonOption | ElasticAddonOption;\n\n```\n```ts\n\ninterface EncryptionAddonOption {\n name: 'encryption';\n enabled: boolean;\n}\n\n```\n\n### Dependencies\n```\nā”œā”€ cc-addon-elasticsearch-options\nā”‚ ā”œā”€ cc-addon-option-form\nā”‚ ā”‚ ā”œā”€ cc-addon-option\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-img\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-toggle\nā”‚ ā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-addon-option.events\nā”‚ ā”‚ ā”œā”€ cc-block\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-button\nā”‚ ā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-expand\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-img\nā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”œā”€ cc-button\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”œā”€ cc-link\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-img\nā”‚ ā”‚ ā”œā”€ cc-addon-option-form.events\n\n```", "name": "CcAddonElasticsearchOptions", "members": [ { "kind": "field", "name": "options", "privacy": "public", "type": { "text": "Array" }, "description": "List of options for this add-on.", "default": "[]", "attribute": "options" } ], "attributes": [ { "name": "options", "type": { "text": "Array" }, "description": "List of options for this add-on.", "default": "[]", "fieldName": "options" } ], "superclass": { "name": "LitElement", "package": "lit" }, "cssDisplay": "block", "tagName": "cc-addon-elasticsearch-options", "customElement": true } ], "exports": [ { "kind": "js", "name": "CcAddonElasticsearchOptions", "declaration": { "name": "CcAddonElasticsearchOptions", "module": "src/components/cc-addon-elasticsearch-options/cc-addon-elasticsearch-options.js" } }, { "kind": "custom-element-definition", "name": "cc-addon-elasticsearch-options", "declaration": { "name": "CcAddonElasticsearchOptions", "module": "src/components/cc-addon-elasticsearch-options/cc-addon-elasticsearch-options.js" } } ] }, { "kind": "javascript-module", "path": "src/components/cc-addon-header/cc-addon-header.client.js", "declarations": [ { "kind": "class", "description": "\nšŸ§ [component's source code on GitHub](https://github.com/CleverCloud/clever-components/blob/master/src/components/cc-addon-header/cc-addon-header.client.js)\n\n\n", "name": "CcAddonHeaderClient", "members": [ { "kind": "method", "name": "getAddon", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "getAddonWithOperatorAndZone", "return": { "type": { "text": "Promise<{ rawAddon: RawAddon, operator: RawOperator, zone: Zone }>" } } }, { "kind": "method", "name": "getAddonWithZone", "return": { "type": { "text": "Promise<{ rawAddon: RawAddon, zone: Zone }>" } } }, { "kind": "method", "name": "getOperator", "parameters": [ { "name": "realId", "type": { "text": "string" } } ], "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "getZone", "parameters": [ { "name": "zoneName", "type": { "text": "string" } } ], "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "rebuildAndRestartAddon", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "restartAddon", "return": { "type": { "text": "Promise" } } } ] } ], "exports": [ { "kind": "js", "name": "CcAddonHeaderClient", "declaration": { "name": "CcAddonHeaderClient", "module": "src/components/cc-addon-header/cc-addon-header.client.js" } } ] }, { "kind": "javascript-module", "path": "src/components/cc-addon-header/cc-addon-header.events.js", "declarations": [ { "kind": "class", "description": "Dispatch when an addon restart is requested.\n\nšŸ§ [component's source code on GitHub](https://github.com/CleverCloud/clever-components/blob/master/src/components/cc-addon-header/cc-addon-header.events.js)\n\n\n\n### Dependants\n```\nā”œā”€ cc-addon-header.events\nā”‚ ā”œā”€ cc-addon-header\n\n```", "name": "CcAddonRestartEvent", "members": [ { "kind": "field", "name": "TYPE", "type": { "text": "string" }, "static": true, "default": "'cc-addon-restart'" } ], "superclass": { "name": "CcEvent", "module": "/src/lib/events.js" } }, { "kind": "class", "description": "Dispatch when an addon rebuild is requested.\n\nšŸ§ [component's source code on GitHub](https://github.com/CleverCloud/clever-components/blob/master/src/components/cc-addon-header/cc-addon-header.events.js)\n\n\n\n### Dependants\n```\nā”œā”€ cc-addon-header.events\nā”‚ ā”œā”€ cc-addon-header\n\n```", "name": "CcAddonRebuildEvent", "members": [ { "kind": "field", "name": "TYPE", "type": { "text": "string" }, "static": true, "default": "'cc-addon-rebuild'" } ], "superclass": { "name": "CcEvent", "module": "/src/lib/events.js" } } ], "exports": [ { "kind": "js", "name": "CcAddonRestartEvent", "declaration": { "name": "CcAddonRestartEvent", "module": "src/components/cc-addon-header/cc-addon-header.events.js" } }, { "kind": "js", "name": "CcAddonRebuildEvent", "declaration": { "name": "CcAddonRebuildEvent", "module": "src/components/cc-addon-header/cc-addon-header.events.js" } } ] }, { "kind": "javascript-module", "path": "src/components/cc-addon-header/cc-addon-header.js", "declarations": [ { "kind": "class", "description": "A component to display various info about an add-on (name, plan, version...).\n\nšŸ§ [component's source code on GitHub](https://github.com/CleverCloud/clever-components/blob/master/src/components/cc-addon-header/cc-addon-header.js)\n\nšŸŽØ default CSS display: `block`\n\n### Type Definitions\n\n```ts\n\ntype CcAddonHeaderState =\n | CcAddonHeaderStateLoading\n | CcAddonHeaderStateLoaded\n | CcAddonHeaderStateError\n | CcAddonHeaderStateRestarting\n | CcAddonHeaderStateRebuilding;\n\n```\n```ts\n\ninterface CcAddonHeaderStateLoading extends OptionalProperties {\n type: 'loading';\n}\n\n```\n```ts\n\ninterface CcAddonHeaderStateLoaded extends AddonHeaderBaseProperties, OptionalProperties {\n type: 'loaded';\n}\n\n```\n```ts\n\ninterface CcAddonHeaderStateError {\n type: 'error';\n}\n\n```\n```ts\n\ninterface CcAddonHeaderStateRestarting extends AddonHeaderBaseProperties, OptionalProperties {\n type: 'restarting';\n}\n\n```\n```ts\n\ninterface CcAddonHeaderStateRebuilding extends AddonHeaderBaseProperties, OptionalProperties {\n type: 'rebuilding';\n}\n\n```\n```ts\n\ninterface OptionalProperties {\n logsUrl?: string;\n openLinks?: Array;\n actions?: {\n restart: boolean;\n rebuildAndRestart: boolean;\n };\n productStatus?: string;\n deploymentStatus?: DeploymentStatus;\n configLink?: {\n href: string;\n fileName: string;\n };\n zone?: Zone;\n}\n\n```\n```ts\n\ninterface AddonHeaderBaseProperties {\n providerId: string;\n providerLogoUrl: string;\n name: string;\n id: string;\n}\n\n```\n```ts\n\ninterface OpenLink {\n url: string;\n name: string;\n}\n\n```\n```ts\n\ntype DeploymentStatus = 'deploying' | 'active' | 'failed' | 'deleted';\n\n```\n```ts\n\ninterface Zone {\n name: string;\n countryCode: string; // ISO 3166-1 alpha-2 code of the country (2 letters): \"FR\", \"CA\", \"US\"...\n city: string; // Name of the city in english: \"Paris\", \"Montreal\", \"New York City\"...\n country: string; // Name of the country in english: \"France\", \"Canada\", \"United States\"...\n displayName?: string; // Optional display name for private zones (instead of displaying city + country): \"ACME (dedicated)\"...\n tags: string[]; // Array of strings for semantic tags: [\"region:eu\", \"infra:clever-cloud\"], [\"scope:private\"]...\n lat: number; // Latitude\n lon: number; // Longitude\n}\n\n```\n\n### Dependencies\n```\nā”œā”€ cc-addon-header\nā”‚ ā”œā”€ cc-badge\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”œā”€ cc-block\nā”‚ ā”‚ ā”œā”€ cc-button\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”œā”€ cc-expand\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ cc-img\nā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”œā”€ cc-button\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”œā”€ cc-clipboard\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”œā”€ cc-img\nā”‚ ā”œā”€ cc-link\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ cc-img\nā”‚ ā”œā”€ cc-notice\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ cc-notice.events\nā”‚ ā”œā”€ cc-zone\nā”‚ ā”‚ ā”œā”€ cc-img\nā”‚ ā”œā”€ cc-addon-header.events\n\n```\n\n### Dependants\n```\nā”œā”€ cc-addon-header\nā”‚ ā”œā”€ cc-network-group-dashboard\n\n```", "name": "CcAddonHeader", "members": [ { "kind": "field", "name": "state", "privacy": "public", "type": { "text": "CcAddonHeaderState" }, "description": "Sets the state of the component.", "default": "{\n type: 'loading',\n logsUrl: '',\n openLinks: [],\n actions: {\n restart: false,\n rebuildAndRestart: false,\n },\n }", "attribute": "state" } ], "events": [ { "name": "cc-addon-rebuild", "type": { "text": "CcAddonRebuildEvent" }, "description": "Dispatch when an addon rebuild is requested." }, { "name": "cc-addon-restart", "type": { "text": "CcAddonRestartEvent" }, "description": "Dispatch when an addon restart is requested." } ], "attributes": [ { "name": "state", "type": { "text": "CcAddonHeaderState" }, "description": "Sets the state of the component.", "default": "{\n type: 'loading',\n logsUrl: '',\n openLinks: [],\n actions: {\n restart: false,\n rebuildAndRestart: false,\n },\n }", "fieldName": "state" } ], "superclass": { "name": "LitElement", "package": "lit" }, "cssDisplay": "block", "tagName": "cc-addon-header", "customElement": true } ], "exports": [ { "kind": "js", "name": "CcAddonHeader", "declaration": { "name": "CcAddonHeader", "module": "src/components/cc-addon-header/cc-addon-header.js" } }, { "kind": "custom-element-definition", "name": "cc-addon-header", "declaration": { "name": "CcAddonHeader", "module": "src/components/cc-addon-header/cc-addon-header.js" } } ] }, { "kind": "javascript-module", "path": "src/components/cc-addon-header/cc-addon-header.smart-cellar.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/cc-addon-header/cc-addon-header.smart-config-provider.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/cc-addon-header/cc-addon-header.smart-elastic.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/cc-addon-header/cc-addon-header.smart-jenkins.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/cc-addon-header/cc-addon-header.smart-keycloak.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/cc-addon-header/cc-addon-header.smart-kubernetes.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/cc-addon-header/cc-addon-header.smart-materia-kv.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/cc-addon-header/cc-addon-header.smart-matomo.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/cc-addon-header/cc-addon-header.smart-metabase.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/cc-addon-header/cc-addon-header.smart-otoroshi.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/cc-addon-header/cc-addon-header.smart-pulsar.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/cc-addon-info/cc-addon-info.client.js", "declarations": [ { "kind": "class", "description": "\nšŸ§ [component's source code on GitHub](https://github.com/CleverCloud/clever-components/blob/master/src/components/cc-addon-info/cc-addon-info.client.js)\n\n\n", "name": "CcAddonInfoClient", "members": [ { "kind": "method", "name": "getAddonInfo", "return": { "type": { "text": "Promise<{addonInfo: RawAddon, operator: RawOperator, operatorVersionInfo: OperatorVersionInfo, grafanaAppLink: string}>" } } }, { "kind": "method", "name": "getOperatorVersionInfo", "return": { "type": { "text": "Promise" } } }, { "kind": "field", "name": "providerId", "default": "providerId" }, { "kind": "method", "name": "updateOperatorVersion", "parameters": [ { "name": "targetVersion", "type": { "text": "string" } } ], "return": { "type": { "text": "Promise" } } } ] }, { "kind": "function", "name": "updateOperatorVersion", "parameters": [ { "name": "params", "type": { "text": "@param {string} params.providerId\n * @param {string} params.realId\n * " } }, { "name": "body", "type": { "text": "object" } } ] }, { "kind": "function", "name": "formatVersionState", "parameters": [ { "name": "operatorVersionInfo", "type": { "text": "OperatorVersionInfo" } } ], "return": { "type": { "text": "AddonInfoStateLoaded['version']" } } } ], "exports": [ { "kind": "js", "name": "CcAddonInfoClient", "declaration": { "name": "CcAddonInfoClient", "module": "src/components/cc-addon-info/cc-addon-info.client.js" } }, { "kind": "js", "name": "updateOperatorVersion", "declaration": { "name": "updateOperatorVersion", "module": "src/components/cc-addon-info/cc-addon-info.client.js" } }, { "kind": "js", "name": "formatVersionState", "declaration": { "name": "formatVersionState", "module": "src/components/cc-addon-info/cc-addon-info.client.js" } } ] }, { "kind": "javascript-module", "path": "src/components/cc-addon-info/cc-addon-info.events.js", "declarations": [ { "kind": "class", "description": "Dispatched when an add-on version update was requested.\n\nšŸ§ [component's source code on GitHub](https://github.com/CleverCloud/clever-components/blob/master/src/components/cc-addon-info/cc-addon-info.events.js)\n\n\n\n### Dependants\n```\nā”œā”€ cc-addon-info.events\nā”‚ ā”œā”€ cc-addon-info\n\n```", "name": "CcAddonVersionChangeEvent", "members": [ { "kind": "field", "name": "TYPE", "type": { "text": "string" }, "static": true, "default": "'cc-addon-version-change'" } ], "superclass": { "name": "CcEvent", "module": "/src/lib/events.js" } } ], "exports": [ { "kind": "js", "name": "CcAddonVersionChangeEvent", "declaration": { "name": "CcAddonVersionChangeEvent", "module": "src/components/cc-addon-info/cc-addon-info.events.js" } } ] }, { "kind": "javascript-module", "path": "src/components/cc-addon-info/cc-addon-info.js", "declarations": [ { "kind": "class", "description": "A component to display detailed info about an add-on.\n\nšŸ§ [component's source code on GitHub](https://github.com/CleverCloud/clever-components/blob/master/src/components/cc-addon-info/cc-addon-info.js)\n\nšŸŽØ default CSS display: `block`\n\n### Type Definitions\n\n```ts\n\ntype AddonInfoState = AddonInfoStateLoaded | AddonInfoStateLoading | AddonInfoStateError;\n\n```\n```ts\n\ninterface AddonInfoStateLoaded extends AddonInfoStateBaseProperties {\n type: 'loaded';\n}\n\n```\n```ts\n\ninterface AddonInfoStateLoading extends AddonInfoStateBaseProperties {\n type: 'loading';\n}\n\n```\n```ts\n\ninterface AddonInfoStateError {\n type: 'error';\n}\n\n```\n```ts\n\ninterface AddonInfoStateBaseProperties {\n description?: string;\n version?: AddonVersionState;\n plan?: string;\n subnet?: string;\n lastIp?: string;\n numberOfMembers?: number;\n numberOfPeers?: number;\n specifications?: Array;\n encryption?: boolean;\n creationDate?: string | number;\n role?: string;\n openGrafanaLink?: string;\n openScalabilityLink?: string;\n linkedServices?: Array;\n totalContent?: {\n buckets: number;\n objects: number;\n };\n traffic?: {\n inbound: number;\n outbound: number;\n };\n usedSpaces?: {\n size: number;\n };\n}\n\n```\n```ts\n\ntype AddonVersionState =\n | AddonVersionStateUpToDate\n | AddonVersionStateRequestingUpdate\n | AddonVersionStateUpdateAvailable;\n\n```\n```ts\n\ninterface AddonVersionStateUpToDate extends AddonVersion {\n stateType: 'up-to-date';\n}\n\n```\n```ts\n\ninterface AddonVersionStateRequestingUpdate extends AddonVersion {\n stateType: 'requesting-update';\n available: Array;\n changelogLink: string;\n}\n\n```\n```ts\n\ninterface AddonVersionStateUpdateAvailable extends AddonVersion {\n stateType: 'update-available';\n available: Array;\n changelogLink: string;\n}\n\n```\n```ts\n\ninterface FormattedFeature {\n // `string & {}` means any string other than the ones listed before. Without this, you get no autocomplete because string and 'toto' overlap.\n code:\n | 'connection-limit'\n | 'cpu'\n | 'gpu'\n | 'is-migratable'\n | 'databases'\n | 'dedicated'\n | 'disk-size'\n | 'has-logs'\n | 'has-metrics'\n | 'max-db-size'\n | 'memory'\n | 'version'\n | (string & {});\n // `string & {}` means any string other than the ones listed before. Without this, you get no autocomplete because string and 'toto' overlap.\n type: 'boolean' | 'shared' | 'boolean-shared' | 'bytes' | 'number' | 'runtime' | 'number-cpu-runtime' | 'string';\n value?: number | string | { cpu: number; shared: boolean; nice: number };\n name?: string;\n}\n\n```\n```ts\n\ninterface LinkedService {\n type: 'addon' | 'app';\n name: string;\n logoUrl: string;\n link: string;\n}\n\n```\n\n### Dependencies\n```\nā”œā”€ cc-addon-info\nā”‚ ā”œā”€ cc-block\nā”‚ ā”‚ ā”œā”€ cc-button\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”œā”€ cc-expand\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ cc-img\nā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”œā”€ cc-clipboard\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”œā”€ cc-dialog-confirm-actions\nā”‚ ā”‚ ā”œā”€ cc-button\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”œā”€ cc-dialog\nā”‚ ā”‚ ā”œā”€ cc-button\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ cc-input-text\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-clipboard\nā”‚ ā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-input-text.events\nā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”œā”€ cc-link\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ cc-img\nā”‚ ā”œā”€ cc-notice\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ cc-notice.events\nā”‚ ā”œā”€ cc-select\nā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”œā”€ cc-addon-info.events\n\n```\n\n### Dependants\n```\nā”œā”€ cc-addon-info\nā”‚ ā”œā”€ cc-network-group-dashboard\n\n```", "name": "CcAddonInfo", "slots": [ { "description": "A customised text regarding the billing.", "name": "billing" }, { "description": "A customised text regarding the linked services.", "name": "linked-services" } ], "members": [ { "kind": "field", "name": "docLink", "privacy": "public", "type": { "text": "{ text: string; href: string; }" }, "default": "null", "attribute": "doc-link" }, { "kind": "field", "name": "state", "privacy": "public", "type": { "text": "AddonInfoState" }, "description": "Sets the state of the component", "default": "{ type: 'loading' }", "attribute": "state" } ], "events": [ { "name": "cc-addon-version-change", "type": { "text": "CcAddonVersionChangeEvent" }, "description": "Dispatched when an add-on version update was requested." } ], "attributes": [ { "name": "doc-link", "type": { "text": "{ text: string; href: string; }" }, "default": "null", "fieldName": "docLink" }, { "name": "state", "type": { "text": "AddonInfoState" }, "description": "Sets the state of the component", "default": "{ type: 'loading' }", "fieldName": "state" } ], "superclass": { "name": "LitElement", "package": "lit" }, "cssDisplay": "block", "tagName": "cc-addon-info", "customElement": true } ], "exports": [ { "kind": "js", "name": "CcAddonInfo", "declaration": { "name": "CcAddonInfo", "module": "src/components/cc-addon-info/cc-addon-info.js" } }, { "kind": "custom-element-definition", "name": "cc-addon-info", "declaration": { "name": "CcAddonInfo", "module": "src/components/cc-addon-info/cc-addon-info.js" } } ] }, { "kind": "javascript-module", "path": "src/components/cc-addon-info/cc-addon-info.smart-cellar.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/cc-addon-info/cc-addon-info.smart-elastic.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/cc-addon-info/cc-addon-info.smart-jenkins.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/cc-addon-info/cc-addon-info.smart-keycloak.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/cc-addon-info/cc-addon-info.smart-kubernetes.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/cc-addon-info/cc-addon-info.smart-materia-kv.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/cc-addon-info/cc-addon-info.smart-matomo.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/cc-addon-info/cc-addon-info.smart-metabase.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/cc-addon-info/cc-addon-info.smart-otoroshi.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/cc-addon-info/cc-addon-info.smart-pulsar.js", "declarations": [ { "kind": "function", "name": "getAddonProvider", "parameters": [ { "name": "params", "type": { "text": "@param {String} params.providerId\n * @param {String} params.addonId\n " } } ] }, { "kind": "function", "name": "getCluster", "parameters": [ { "name": "params", "type": { "text": "@param {String} params.providerId\n * @param {String} params.clusterId\n " } } ] } ], "exports": [ { "kind": "js", "name": "getAddonProvider", "declaration": { "name": "getAddonProvider", "module": "src/components/cc-addon-info/cc-addon-info.smart-pulsar.js" } }, { "kind": "js", "name": "getCluster", "declaration": { "name": "getCluster", "module": "src/components/cc-addon-info/cc-addon-info.smart-pulsar.js" } } ] }, { "kind": "javascript-module", "path": "src/components/cc-addon-jenkins-options/cc-addon-jenkins-options.js", "declarations": [ { "kind": "class", "description": "A component that displays the available options of a Jenkins add-on.\n\nšŸ§ [component's source code on GitHub](https://github.com/CleverCloud/clever-components/blob/master/src/components/cc-addon-jenkins-options/cc-addon-jenkins-options.js)\n\nšŸŽØ default CSS display: `block`\n\n### Type Definitions\n\n```ts\n\ninterface EncryptionAddonOption {\n name: 'encryption';\n enabled: boolean;\n}\n\n```\n\n### Dependencies\n```\nā”œā”€ cc-addon-jenkins-options\nā”‚ ā”œā”€ cc-addon-option-form\nā”‚ ā”‚ ā”œā”€ cc-addon-option\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-img\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-toggle\nā”‚ ā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-addon-option.events\nā”‚ ā”‚ ā”œā”€ cc-block\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-button\nā”‚ ā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-expand\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-img\nā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”œā”€ cc-button\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”œā”€ cc-link\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-img\nā”‚ ā”‚ ā”œā”€ cc-addon-option-form.events\n\n```", "name": "CcAddonJenkinsOptions", "members": [ { "kind": "field", "name": "options", "privacy": "public", "type": { "text": "Array" }, "description": "List of options for this add-on.", "default": "[]", "attribute": "options" } ], "attributes": [ { "name": "options", "type": { "text": "Array" }, "description": "List of options for this add-on.", "default": "[]", "fieldName": "options" } ], "superclass": { "name": "LitElement", "package": "lit" }, "cssDisplay": "block", "tagName": "cc-addon-jenkins-options", "customElement": true } ], "exports": [ { "kind": "js", "name": "CcAddonJenkinsOptions", "declaration": { "name": "CcAddonJenkinsOptions", "module": "src/components/cc-addon-jenkins-options/cc-addon-jenkins-options.js" } }, { "kind": "custom-element-definition", "name": "cc-addon-jenkins-options", "declaration": { "name": "CcAddonJenkinsOptions", "module": "src/components/cc-addon-jenkins-options/cc-addon-jenkins-options.js" } } ] }, { "kind": "javascript-module", "path": "src/components/cc-addon-linked-apps/cc-addon-linked-apps.js", "declarations": [ { "kind": "class", "description": "A component to display applications linked to an add-on.\n\nšŸ§ [component's source code on GitHub](https://github.com/CleverCloud/clever-components/blob/master/src/components/cc-addon-linked-apps/cc-addon-linked-apps.js)\n\nšŸŽØ default CSS display: `block`\n\n### Type Definitions\n\n```ts\n\ntype AddonLinkedAppsState = AddonLinkedAppsStateLoading | AddonLinkedAppsStateLoaded | AddonLinkedAppsStateError;\n\n```\n```ts\n\ninterface AddonLinkedAppsStateLoading {\n type: 'loading';\n}\n\n```\n```ts\n\ninterface AddonLinkedAppsStateLoaded {\n type: 'loaded';\n linkedApplications: Array;\n}\n\n```\n```ts\n\ninterface LinkedApplication {\n name: string;\n link: string;\n variantName: string;\n variantLogoUrl: string;\n zone: Zone;\n}\n\n```\n```ts\n\ninterface Zone {\n name: string;\n countryCode: string; // ISO 3166-1 alpha-2 code of the country (2 letters): \"FR\", \"CA\", \"US\"...\n city: string; // Name of the city in english: \"Paris\", \"Montreal\", \"New York City\"...\n country: string; // Name of the country in english: \"France\", \"Canada\", \"United States\"...\n displayName?: string; // Optional display name for private zones (instead of displaying city + country): \"ACME (dedicated)\"...\n tags: string[]; // Array of strings for semantic tags: [\"region:eu\", \"infra:clever-cloud\"], [\"scope:private\"]...\n lat: number; // Latitude\n lon: number; // Longitude\n}\n\n```\n```ts\n\ninterface AddonLinkedAppsStateError {\n type: 'error';\n}\n\n```\n\n### Dependencies\n```\nā”œā”€ cc-addon-linked-apps\nā”‚ ā”œā”€ cc-block\nā”‚ ā”‚ ā”œā”€ cc-button\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”œā”€ cc-expand\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ cc-img\nā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”œā”€ cc-img\nā”‚ ā”œā”€ cc-link\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ cc-img\nā”‚ ā”œā”€ cc-notice\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ cc-notice.events\nā”‚ ā”œā”€ cc-zone\nā”‚ ā”‚ ā”œā”€ cc-img\n\n```", "name": "CcAddonLinkedApps", "members": [ { "kind": "field", "name": "state", "privacy": "public", "type": { "text": "AddonLinkedAppsState" }, "description": "Sets the linked applications state.", "default": "{ type: 'loading' }", "attribute": "state" } ], "attributes": [ { "name": "state", "type": { "text": "AddonLinkedAppsState" }, "description": "Sets the linked applications state.", "default": "{ type: 'loading' }", "fieldName": "state" } ], "superclass": { "name": "LitElement", "package": "lit" }, "cssDisplay": "block", "tagName": "cc-addon-linked-apps", "customElement": true } ], "exports": [ { "kind": "js", "name": "CcAddonLinkedApps", "declaration": { "name": "CcAddonLinkedApps", "module": "src/components/cc-addon-linked-apps/cc-addon-linked-apps.js" } }, { "kind": "custom-element-definition", "name": "cc-addon-linked-apps", "declaration": { "name": "CcAddonLinkedApps", "module": "src/components/cc-addon-linked-apps/cc-addon-linked-apps.js" } } ] }, { "kind": "javascript-module", "path": "src/components/cc-addon-linked-apps/cc-addon-linked-apps.smart.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/cc-addon-mongodb-options/cc-addon-mongodb-options.js", "declarations": [ { "kind": "class", "description": "A component that displays the available options of a MongoDB add-on.\n\nšŸ§ [component's source code on GitHub](https://github.com/CleverCloud/clever-components/blob/master/src/components/cc-addon-mongodb-options/cc-addon-mongodb-options.js)\n\nšŸŽØ default CSS display: `block`\n\n### Type Definitions\n\n```ts\n\ninterface EncryptionAddonOption {\n name: 'encryption';\n enabled: boolean;\n}\n\n```\n\n### Dependencies\n```\nā”œā”€ cc-addon-mongodb-options\nā”‚ ā”œā”€ cc-addon-option-form\nā”‚ ā”‚ ā”œā”€ cc-addon-option\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-img\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-toggle\nā”‚ ā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-addon-option.events\nā”‚ ā”‚ ā”œā”€ cc-block\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-button\nā”‚ ā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-expand\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-img\nā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”œā”€ cc-button\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”œā”€ cc-link\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-img\nā”‚ ā”‚ ā”œā”€ cc-addon-option-form.events\n\n```", "name": "CcAddonMongodbOptions", "members": [ { "kind": "field", "name": "options", "privacy": "public", "type": { "text": "Array" }, "description": "List of options for this add-on.", "default": "[]", "attribute": "options" } ], "attributes": [ { "name": "options", "type": { "text": "Array" }, "description": "List of options for this add-on.", "default": "[]", "fieldName": "options" } ], "superclass": { "name": "LitElement", "package": "lit" }, "cssDisplay": "block", "tagName": "cc-addon-mongodb-options", "customElement": true } ], "exports": [ { "kind": "js", "name": "CcAddonMongodbOptions", "declaration": { "name": "CcAddonMongodbOptions", "module": "src/components/cc-addon-mongodb-options/cc-addon-mongodb-options.js" } }, { "kind": "custom-element-definition", "name": "cc-addon-mongodb-options", "declaration": { "name": "CcAddonMongodbOptions", "module": "src/components/cc-addon-mongodb-options/cc-addon-mongodb-options.js" } } ] }, { "kind": "javascript-module", "path": "src/components/cc-addon-mysql-options/cc-addon-mysql-options.js", "declarations": [ { "kind": "class", "description": "A component that displays the available options of a MySQL add-on.\n\nšŸ§ [component's source code on GitHub](https://github.com/CleverCloud/clever-components/blob/master/src/components/cc-addon-mysql-options/cc-addon-mysql-options.js)\n\nšŸŽØ default CSS display: `block`\n\n### Type Definitions\n\n```ts\n\ninterface EncryptionAddonOption {\n name: 'encryption';\n enabled: boolean;\n}\n\n```\n\n### Dependencies\n```\nā”œā”€ cc-addon-mysql-options\nā”‚ ā”œā”€ cc-addon-option-form\nā”‚ ā”‚ ā”œā”€ cc-addon-option\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-img\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-toggle\nā”‚ ā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-addon-option.events\nā”‚ ā”‚ ā”œā”€ cc-block\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-button\nā”‚ ā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-expand\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-img\nā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”œā”€ cc-button\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”œā”€ cc-link\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-img\nā”‚ ā”‚ ā”œā”€ cc-addon-option-form.events\n\n```", "name": "CcAddonMysqlOptions", "members": [ { "kind": "field", "name": "options", "privacy": "public", "type": { "text": "Array" }, "description": "List of options for this add-on.", "default": "[]", "attribute": "options" } ], "attributes": [ { "name": "options", "type": { "text": "Array" }, "description": "List of options for this add-on.", "default": "[]", "fieldName": "options" } ], "superclass": { "name": "LitElement", "package": "lit" }, "cssDisplay": "block", "tagName": "cc-addon-mysql-options", "customElement": true } ], "exports": [ { "kind": "js", "name": "CcAddonMysqlOptions", "declaration": { "name": "CcAddonMysqlOptions", "module": "src/components/cc-addon-mysql-options/cc-addon-mysql-options.js" } }, { "kind": "custom-element-definition", "name": "cc-addon-mysql-options", "declaration": { "name": "CcAddonMysqlOptions", "module": "src/components/cc-addon-mysql-options/cc-addon-mysql-options.js" } } ] }, { "kind": "javascript-module", "path": "src/components/cc-addon-option-form/cc-addon-option-form.events.js", "declarations": [ { "kind": "class", "description": "Dispatched when the add-on options form is submitted.\n\nšŸ§ [component's source code on GitHub](https://github.com/CleverCloud/clever-components/blob/master/src/components/cc-addon-option-form/cc-addon-option-form.events.js)\n\n\n\n### Dependants\n```\nā”œā”€ cc-addon-option-form.events\nā”‚ ā”œā”€ cc-addon-option-form\n\n```", "name": "CcAddonOptionFormSubmitEvent", "members": [ { "kind": "field", "name": "TYPE", "type": { "text": "string" }, "static": true, "default": "'cc-addon-option-form-submit'" } ], "superclass": { "name": "CcEvent", "module": "/src/lib/events.js" } } ], "exports": [ { "kind": "js", "name": "CcAddonOptionFormSubmitEvent", "declaration": { "name": "CcAddonOptionFormSubmitEvent", "module": "src/components/cc-addon-option-form/cc-addon-option-form.events.js" } } ] }, { "kind": "javascript-module", "path": "src/components/cc-addon-option-form/cc-addon-option-form.js", "declarations": [ { "kind": "class", "description": "A component that displays a form of ``.\n\nšŸ§ [component's source code on GitHub](https://github.com/CleverCloud/clever-components/blob/master/src/components/cc-addon-option-form/cc-addon-option-form.js)\n\nšŸŽØ default CSS display: `block`\n\n### Type Definitions\n\n```ts\n\ntype AddonOptionWithMetadata = {\n icon?: IconModel;\n title?: string | Node;\n logo?: string;\n description: string | Node | TemplateResult<1>;\n} & Pick;\n\n```\n\n### Dependencies\n```\nā”œā”€ cc-addon-option-form\nā”‚ ā”œā”€ cc-addon-option\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ cc-img\nā”‚ ā”‚ ā”œā”€ cc-toggle\nā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”œā”€ cc-addon-option.events\nā”‚ ā”œā”€ cc-block\nā”‚ ā”‚ ā”œā”€ cc-button\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”œā”€ cc-expand\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ cc-img\nā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”œā”€ cc-button\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”œā”€ cc-link\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ cc-img\nā”‚ ā”œā”€ cc-addon-option-form.events\n\n```\n\n### Dependants\n```\nā”œā”€ cc-addon-option-form\nā”‚ ā”œā”€ cc-addon-elasticsearch-options\nā”‚ ā”œā”€ cc-addon-jenkins-options\nā”‚ ā”œā”€ cc-addon-mongodb-options\nā”‚ ā”œā”€ cc-addon-mysql-options\nā”‚ ā”œā”€ cc-addon-postgresql-options\nā”‚ ā”œā”€ cc-addon-redis-options\n\n```", "name": "CcAddonOptionForm", "slots": [ { "description": "The description of the add-on and available options.", "name": "description" } ], "members": [ { "kind": "field", "name": "heading", "privacy": "public", "type": { "text": "string" }, "description": "Heading of the whole options form.", "default": "null", "attribute": "heading" }, { "kind": "field", "name": "options", "privacy": "public", "type": { "text": "AddonOptionWithMetadata[]" }, "description": "List of Option object to render.", "default": "null", "attribute": "options" } ], "events": [ { "name": "cc-addon-option-form-submit", "type": { "text": "CcAddonOptionFormSubmitEvent" }, "description": "Dispatched when the add-on options form is submitted." } ], "attributes": [ { "name": "heading", "type": { "text": "string" }, "description": "Heading of the whole options form.", "default": "null", "fieldName": "heading" }, { "name": "options", "type": { "text": "AddonOptionWithMetadata[]" }, "description": "List of Option object to render.", "default": "null", "fieldName": "options" } ], "superclass": { "name": "LitElement", "package": "lit" }, "cssDisplay": "block", "tagName": "cc-addon-option-form", "customElement": true } ], "exports": [ { "kind": "js", "name": "CcAddonOptionForm", "declaration": { "name": "CcAddonOptionForm", "module": "src/components/cc-addon-option-form/cc-addon-option-form.js" } }, { "kind": "custom-element-definition", "name": "cc-addon-option-form", "declaration": { "name": "CcAddonOptionForm", "module": "src/components/cc-addon-option-form/cc-addon-option-form.js" } } ] }, { "kind": "javascript-module", "path": "src/components/cc-addon-option/cc-addon-option.events.js", "declarations": [ { "kind": "class", "description": "Dispatched when an add-on option is toggled.\n\nšŸ§ [component's source code on GitHub](https://github.com/CleverCloud/clever-components/blob/master/src/components/cc-addon-option/cc-addon-option.events.js)\n\n\n\n### Dependants\n```\nā”œā”€ cc-addon-option.events\nā”‚ ā”œā”€ cc-addon-option\n\n```", "name": "CcAddonOptionChangeEvent", "members": [ { "kind": "field", "name": "TYPE", "type": { "text": "string" }, "static": true, "default": "'cc-addon-option-change'" } ], "superclass": { "name": "CcEvent", "module": "/src/lib/events.js" } } ], "exports": [ { "kind": "js", "name": "CcAddonOptionChangeEvent", "declaration": { "name": "CcAddonOptionChangeEvent", "module": "src/components/cc-addon-option/cc-addon-option.events.js" } } ] }, { "kind": "javascript-module", "path": "src/components/cc-addon-option/cc-addon-option.js", "declarations": [ { "kind": "class", "description": "A component that allows to enable or disable an add-on option.\n\nšŸ§ [component's source code on GitHub](https://github.com/CleverCloud/clever-components/blob/master/src/components/cc-addon-option/cc-addon-option.js)\n\nšŸŽØ default CSS display: `grid`\n\n## Technical details\n\n* If you want to display a warning in the option, add the `option-warning` class to an HTML element. It will be displayed with a custom color and in italic.\n\n### Type Definitions\n\n```ts\n\ninterface IconModel {\n content: string;\n}\n\n```\n\n### Dependencies\n```\nā”œā”€ cc-addon-option\nā”‚ ā”œā”€ cc-icon\nā”‚ ā”œā”€ cc-img\nā”‚ ā”œā”€ cc-toggle\nā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”œā”€ cc-addon-option.events\n\n```\n\n### Dependants\n```\nā”œā”€ cc-addon-option\nā”‚ ā”œā”€ cc-addon-option-form\n\n```", "name": "CcAddonOption", "slots": [ { "description": "The content of the option's description (text or HTML).", "name": "" } ], "members": [ { "kind": "field", "name": "enabled", "privacy": "public", "type": { "text": "boolean" }, "description": "Enable the option by default.", "default": "false", "attribute": "enabled", "reflects": true }, { "kind": "field", "name": "heading", "privacy": "public", "type": { "text": "string|null" }, "description": "Heading of the option.", "default": "null", "attribute": "heading" }, { "kind": "field", "name": "icon", "privacy": "public", "type": { "text": "IconModel|null" }, "description": "The logo icon of the option. Has priority over the logo property.", "default": "null", "attribute": "icon" }, { "kind": "field", "name": "logo", "privacy": "public", "type": { "text": "string|null" }, "description": "The logo URL of the option.", "default": "null", "attribute": "logo" } ], "events": [ { "name": "cc-addon-option-change", "type": { "text": "CcAddonOptionChangeEvent" }, "description": "Dispatched when an add-on option is toggled." } ], "attributes": [ { "name": "enabled", "type": { "text": "boolean" }, "description": "Enable the option by default.", "default": "false", "fieldName": "enabled" }, { "name": "heading", "type": { "text": "string|null" }, "description": "Heading of the option.", "default": "null", "fieldName": "heading" }, { "name": "icon", "type": { "text": "IconModel|null" }, "description": "The logo icon of the option. Has priority over the logo property.", "default": "null", "fieldName": "icon" }, { "name": "logo", "type": { "text": "string|null" }, "description": "The logo URL of the option.", "default": "null", "fieldName": "logo" } ], "superclass": { "name": "LitElement", "package": "lit" }, "cssDisplay": "grid", "tagName": "cc-addon-option", "customElement": true } ], "exports": [ { "kind": "js", "name": "CcAddonOption", "declaration": { "name": "CcAddonOption", "module": "src/components/cc-addon-option/cc-addon-option.js" } }, { "kind": "custom-element-definition", "name": "cc-addon-option", "declaration": { "name": "CcAddonOption", "module": "src/components/cc-addon-option/cc-addon-option.js" } } ] }, { "kind": "javascript-module", "path": "src/components/cc-addon-postgresql-options/cc-addon-postgresql-options.js", "declarations": [ { "kind": "class", "description": "A component that displays the available options of a PostgreSQL add-on.\n\nšŸ§ [component's source code on GitHub](https://github.com/CleverCloud/clever-components/blob/master/src/components/cc-addon-postgresql-options/cc-addon-postgresql-options.js)\n\nšŸŽØ default CSS display: `block`\n\n### Type Definitions\n\n```ts\n\ninterface EncryptionAddonOption {\n name: 'encryption';\n enabled: boolean;\n}\n\n```\n\n### Dependencies\n```\nā”œā”€ cc-addon-postgresql-options\nā”‚ ā”œā”€ cc-addon-option-form\nā”‚ ā”‚ ā”œā”€ cc-addon-option\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-img\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-toggle\nā”‚ ā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-addon-option.events\nā”‚ ā”‚ ā”œā”€ cc-block\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-button\nā”‚ ā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-expand\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-img\nā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”œā”€ cc-button\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”œā”€ cc-link\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-img\nā”‚ ā”‚ ā”œā”€ cc-addon-option-form.events\n\n```", "name": "CcAddonPostgresqlOptions", "members": [ { "kind": "field", "name": "options", "privacy": "public", "type": { "text": "Array" }, "description": "List of options for this add-on.", "default": "[]", "attribute": "options" } ], "attributes": [ { "name": "options", "type": { "text": "Array" }, "description": "List of options for this add-on.", "default": "[]", "fieldName": "options" } ], "superclass": { "name": "LitElement", "package": "lit" }, "cssDisplay": "block", "tagName": "cc-addon-postgresql-options", "customElement": true } ], "exports": [ { "kind": "js", "name": "CcAddonPostgresqlOptions", "declaration": { "name": "CcAddonPostgresqlOptions", "module": "src/components/cc-addon-postgresql-options/cc-addon-postgresql-options.js" } }, { "kind": "custom-element-definition", "name": "cc-addon-postgresql-options", "declaration": { "name": "CcAddonPostgresqlOptions", "module": "src/components/cc-addon-postgresql-options/cc-addon-postgresql-options.js" } } ] }, { "kind": "javascript-module", "path": "src/components/cc-addon-redis-options/cc-addon-redis-options.js", "declarations": [ { "kind": "class", "description": "A component that displays the available options of a Redis add-on.\n\nšŸ§ [component's source code on GitHub](https://github.com/CleverCloud/clever-components/blob/master/src/components/cc-addon-redis-options/cc-addon-redis-options.js)\n\nšŸŽØ default CSS display: `block`\n\n### Type Definitions\n\n```ts\n\ninterface EncryptionAddonOption {\n name: 'encryption';\n enabled: boolean;\n}\n\n```\n\n### Dependencies\n```\nā”œā”€ cc-addon-redis-options\nā”‚ ā”œā”€ cc-addon-option-form\nā”‚ ā”‚ ā”œā”€ cc-addon-option\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-img\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-toggle\nā”‚ ā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-addon-option.events\nā”‚ ā”‚ ā”œā”€ cc-block\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-button\nā”‚ ā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-expand\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-img\nā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”œā”€ cc-button\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”œā”€ cc-link\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-img\nā”‚ ā”‚ ā”œā”€ cc-addon-option-form.events\n\n```", "name": "CcAddonRedisOptions", "members": [ { "kind": "field", "name": "options", "privacy": "public", "type": { "text": "Array" }, "description": "List of options for this add-on.", "default": "[]", "attribute": "options" } ], "attributes": [ { "name": "options", "type": { "text": "Array" }, "description": "List of options for this add-on.", "default": "[]", "fieldName": "options" } ], "superclass": { "name": "LitElement", "package": "lit" }, "cssDisplay": "block", "tagName": "cc-addon-redis-options", "customElement": true } ], "exports": [ { "kind": "js", "name": "CcAddonRedisOptions", "declaration": { "name": "CcAddonRedisOptions", "module": "src/components/cc-addon-redis-options/cc-addon-redis-options.js" } }, { "kind": "custom-element-definition", "name": "cc-addon-redis-options", "declaration": { "name": "CcAddonRedisOptions", "module": "src/components/cc-addon-redis-options/cc-addon-redis-options.js" } } ] }, { "kind": "javascript-module", "path": "src/components/cc-ansi-palette/cc-ansi-palette.js", "declarations": [ { "kind": "class", "description": "A component displaying an ANSI palette.\n\nšŸ§ [component's source code on GitHub](https://github.com/CleverCloud/clever-components/blob/master/src/components/cc-ansi-palette/cc-ansi-palette.js)\n\nšŸŽØ default CSS display: `block`\n\n### Type Definitions\n\n```ts\n\ninterface AnsiPalette {\n foreground: string;\n background: string;\n 'background-hover': string;\n 'background-selected': string;\n black: string;\n red: string;\n green: string;\n yellow: string;\n blue: string;\n magenta: string;\n cyan: string;\n white: string;\n 'bright-black': string;\n 'bright-red': string;\n 'bright-green': string;\n 'bright-yellow': string;\n 'bright-blue': string;\n 'bright-magenta': string;\n 'bright-cyan': string;\n 'bright-white': string;\n}\n\n```\n\n### Dependencies\n```\nā”œā”€ cc-ansi-palette\nā”‚ ā”œā”€ cc-icon\nā”‚ ā”œā”€ cc-input-text\nā”‚ ā”‚ ā”œā”€ cc-clipboard\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”‚ ā”œā”€ cc-input-text.events\n\n```", "name": "CcAnsiPalette", "members": [ { "kind": "field", "name": "name", "privacy": "public", "type": { "text": "string" }, "description": "The palette name.", "default": "''", "attribute": "name" }, { "kind": "field", "name": "palette", "privacy": "public", "type": { "text": "AnsiPalette|null" }, "description": "The palette ANSI palette.", "default": "null", "attribute": "palette" }, { "kind": "method", "name": "renderColor", "parameters": [ { "name": "colorName", "type": { "text": "ColorName" } } ] }, { "kind": "method", "name": "renderColorGridLine", "parameters": [ { "name": "colorName", "type": { "text": "typeof COLORS[number]" } } ] }, { "kind": "method", "name": "renderSquare", "parameters": [ { "name": "colorName", "type": { "text": "ColorName" } } ] } ], "attributes": [ { "name": "name", "type": { "text": "string" }, "description": "The palette name.", "default": "''", "fieldName": "name" }, { "name": "palette", "type": { "text": "AnsiPalette|null" }, "description": "The palette ANSI palette.", "default": "null", "fieldName": "palette" } ], "superclass": { "name": "LitElement", "package": "lit" }, "cssDisplay": "block", "tagName": "cc-ansi-palette", "customElement": true } ], "exports": [ { "kind": "js", "name": "CcAnsiPalette", "declaration": { "name": "CcAnsiPalette", "module": "src/components/cc-ansi-palette/cc-ansi-palette.js" } }, { "kind": "custom-element-definition", "name": "cc-ansi-palette", "declaration": { "name": "CcAnsiPalette", "module": "src/components/cc-ansi-palette/cc-ansi-palette.js" } } ] }, { "kind": "javascript-module", "path": "src/components/cc-article-card/cc-article-card.js", "declarations": [ { "kind": "class", "description": "A component displaying information of an external article in a card.\n\nšŸ§ [component's source code on GitHub](https://github.com/CleverCloud/clever-components/blob/master/src/components/cc-article-card/cc-article-card.js)\n\nšŸŽØ default CSS display: `grid`\n\n### Type Definitions\n\n```ts\n\ntype ArticleCardState = ArticleCardStateLoaded | ArticleCardStateLoading;\n\n```\n```ts\n\ninterface ArticleCardStateLoaded extends ArticleCard {\n type: 'loaded';\n}\n\n```\n```ts\n\ninterface ArticleCardStateLoading {\n type: 'loading';\n}\n\n```\n```ts\n\ninterface ArticleCard {\n banner: string;\n date: string;\n description: string;\n link: string;\n title: string;\n}\n\n```\n\n### Dependencies\n```\nā”œā”€ cc-article-card\nā”‚ ā”œā”€ cc-img\nā”‚ ā”œā”€ cc-link\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ cc-img\n\n```\n\n### Dependants\n```\nā”œā”€ cc-article-card\nā”‚ ā”œā”€ cc-article-list\n\n```", "name": "CcArticleCard", "members": [ { "kind": "field", "name": "state", "privacy": "public", "type": { "text": "ArticleCardState" }, "description": "Sets the state of the component", "default": "{ type: 'loading' }", "attribute": "state" } ], "attributes": [ { "name": "state", "type": { "text": "ArticleCardState" }, "description": "Sets the state of the component", "default": "{ type: 'loading' }", "fieldName": "state" } ], "superclass": { "name": "LitElement", "package": "lit" }, "cssDisplay": "grid", "tagName": "cc-article-card", "customElement": true } ], "exports": [ { "kind": "js", "name": "CcArticleCard", "declaration": { "name": "CcArticleCard", "module": "src/components/cc-article-card/cc-article-card.js" } }, { "kind": "custom-element-definition", "name": "cc-article-card", "declaration": { "name": "CcArticleCard", "module": "src/components/cc-article-card/cc-article-card.js" } } ] }, { "kind": "javascript-module", "path": "src/components/cc-article-list/cc-article-list.js", "declarations": [ { "kind": "class", "description": "A component displaying a list of article cards.\n\nšŸ§ [component's source code on GitHub](https://github.com/CleverCloud/clever-components/blob/master/src/components/cc-article-list/cc-article-list.js)\n\nšŸŽØ default CSS display: `block`\n\n### Type Definitions\n\n```ts\n\ntype ArticleListState = ArticleListStateLoaded | ArticleListStateLoading | ArticleListStateError;\n\n```\n```ts\n\ninterface ArticleListStateLoaded {\n type: 'loaded';\n articles: ArticleCard[];\n}\n\n```\n```ts\n\ninterface ArticleCard {\n banner: string;\n date: string;\n description: string;\n link: string;\n title: string;\n}\n\n```\n```ts\n\ninterface ArticleListStateLoading {\n type: 'loading';\n}\n\n```\n```ts\n\ninterface ArticleListStateError {\n type: 'error';\n}\n\n```\n\n### Dependencies\n```\nā”œā”€ cc-article-list\nā”‚ ā”œā”€ cc-article-card\nā”‚ ā”‚ ā”œā”€ cc-img\nā”‚ ā”‚ ā”œā”€ cc-link\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”‚ ā”œā”€ cc-img\nā”‚ ā”œā”€ cc-notice\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ cc-notice.events\n\n```", "name": "CcArticleList", "members": [ { "kind": "field", "name": "state", "privacy": "public", "type": { "text": "ArticleListState" }, "description": "Sets the state of the component", "default": "{ type: 'loading' }", "attribute": "state" } ], "attributes": [ { "name": "state", "type": { "text": "ArticleListState" }, "description": "Sets the state of the component", "default": "{ type: 'loading' }", "fieldName": "state" } ], "superclass": { "name": "LitElement", "package": "lit" }, "cssDisplay": "block", "tagName": "cc-article-list", "customElement": true } ], "exports": [ { "kind": "js", "name": "CcArticleList", "declaration": { "name": "CcArticleList", "module": "src/components/cc-article-list/cc-article-list.js" } }, { "kind": "custom-element-definition", "name": "cc-article-list", "declaration": { "name": "CcArticleList", "module": "src/components/cc-article-list/cc-article-list.js" } } ] }, { "kind": "javascript-module", "path": "src/components/cc-article-list/cc-article-list.smart.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/components/cc-badge/cc-badge.js", "declarations": [ { "kind": "class", "description": "A component to highlight a small chunk of text.\n\nšŸ§ [component's source code on GitHub](https://github.com/CleverCloud/clever-components/blob/master/src/components/cc-badge/cc-badge.js)\n\nšŸŽØ default CSS display: `inline-block`\n\n### Type Definitions\n\n```ts\n\ntype BadgeIntent = 'neutral' | 'info' | 'success' | 'warning' | 'danger';\n\n```\n```ts\n\ntype BadgeWeight = 'strong' | 'dimmed' | 'outlined';\n\n```\n```ts\n\ninterface IconModel {\n content: string;\n}\n\n```\n\n### Dependencies\n```\nā”œā”€ cc-badge\nā”‚ ā”œā”€ cc-icon\n\n```\n\n### Dependants\n```\nā”œā”€ cc-badge\nā”‚ ā”œā”€ cc-addon-header\nā”‚ ā”œā”€ cc-cellar-bucket-list\nā”‚ ā”œā”€ cc-domain-management\nā”‚ ā”œā”€ cc-email-list\nā”‚ ā”œā”€ cc-feature-list\nā”‚ ā”œā”€ cc-grid\nā”‚ ā”œā”€ cc-header-orga\nā”‚ ā”œā”€ cc-kv-explorer\nā”‚ ā”œā”€ cc-logs\nā”‚ ā”œā”€ cc-network-group-member-card\nā”‚ ā”œā”€ cc-oauth-consumer-info\nā”‚ ā”œā”€ cc-order-summary\nā”‚ ā”œā”€ cc-orga-member-card\nā”‚ ā”œā”€ cc-orga-member-list\nā”‚ ā”œā”€ cc-plan-picker\nā”‚ ā”œā”€ cc-pricing-estimation\nā”‚ ā”œā”€ cc-product-card\nā”‚ ā”œā”€ cc-product-list\nā”‚ ā”œā”€ cc-ssh-key-list\nā”‚ ā”œā”€ cc-tcp-redirection-form\nā”‚ ā”œā”€ cc-token-api-list\nā”‚ ā”œā”€ cc-token-oauth-list\nā”‚ ā”œā”€ cc-token-session-list\n\n```", "name": "CcBadge", "cssProperties": [ { "type": { "text": "JustifyContent" }, "description": "Specify how the content should be distributed / positioned horizontally within the grid (Default: `center`. Possible values: https://developer.mozilla.org/en-US/docs/Web/CSS/justify-items).", "name": "--cc-badge-justify-content" } ], "members": [ { "kind": "field", "name": "circle", "privacy": "public", "type": { "text": "boolean" }, "description": "Sets the badge to a bubble style. Should only be used to display 1 or 2 digits figures.", "default": "false", "attribute": "circle" }, { "kind": "field", "name": "icon", "privacy": "public", "type": { "text": "IconModel|null" }, "description": "If set, enables icon mode and displays the required icon in the component.", "default": "null", "attribute": "icon" }, { "kind": "field", "name": "iconA11yName", "privacy": "public", "type": { "text": "string|null" }, "description": "Sets the `a11y-name` attribute value on the `` tag. Only use if the icon conveys additional info compared to surrounding text. Check the `` documentation for more details.", "default": "null", "attribute": "icon-a11y-name" }, { "kind": "field", "name": "intent", "privacy": "public", "type": { "text": "BadgeIntent" }, "description": "Sets the accent color used for the badge.", "default": "'neutral'", "attribute": "intent" }, { "kind": "field", "name": "skeleton", "privacy": "public", "type": { "text": "boolean" }, "description": "Whether the component should be displayed as skeleton.", "default": "false", "attribute": "skeleton" }, { "kind": "field", "name": "weight", "privacy": "public", "type": { "text": "BadgeWeight" }, "description": "Sets the style of the badge depending on how much one wants it to stand out.", "default": "'dimmed'", "attribute": "weight" } ], "attributes": [ { "name": "circle", "type": { "text": "boolean" }, "description": "Sets the badge to a bubble style. Should only be used to display 1 or 2 digits figures.", "default": "false", "fieldName": "circle" }, { "name": "icon", "type": { "text": "IconModel|null" }, "description": "If set, enables icon mode and displays the required icon in the component.", "default": "null", "fieldName": "icon" }, { "name": "icon-a11y-name", "type": { "text": "string|null" }, "description": "Sets the `a11y-name` attribute value on the `` tag. Only use if the icon conveys additional info compared to surrounding text. Check the `` documentation for more details.", "default": "null", "fieldName": "iconA11yName" }, { "name": "intent", "type": { "text": "BadgeIntent" }, "description": "Sets the accent color used for the badge.", "default": "'neutral'", "fieldName": "intent" }, { "name": "skeleton", "type": { "text": "boolean" }, "description": "Whether the component should be displayed as skeleton.", "default": "false", "fieldName": "skeleton" }, { "name": "weight", "type": { "text": "BadgeWeight" }, "description": "Sets the style of the badge depending on how much one wants it to stand out.", "default": "'dimmed'", "fieldName": "weight" } ], "superclass": { "name": "LitElement", "package": "lit" }, "cssDisplay": "inline-block", "tagName": "cc-badge", "customElement": true } ], "exports": [ { "kind": "js", "name": "CcBadge", "declaration": { "name": "CcBadge", "module": "src/components/cc-badge/cc-badge.js" } }, { "kind": "custom-element-definition", "name": "cc-badge", "declaration": { "name": "CcBadge", "module": "src/components/cc-badge/cc-badge.js" } } ] }, { "kind": "javascript-module", "path": "src/components/cc-beta/cc-beta.js", "declarations": [ { "kind": "class", "description": "A layout component to position a simple beta ribbon around any content.\n\nšŸ§ [component's source code on GitHub](https://github.com/CleverCloud/clever-components/blob/master/src/components/cc-beta/cc-beta.js)\n\nšŸŽØ default CSS display: `grid`\n\n### Type Definitions\n\n```ts\n\ntype PositionType = 'top-left' | 'bottom-left' | 'top-right' | 'bottom-right';\n\n```\n\n", "name": "CcBeta", "slots": [ { "description": "The content around which the beta label will be positionned. You ONLY one element.", "name": "" } ], "members": [ { "kind": "field", "name": "fill", "privacy": "public", "type": { "text": "boolean" }, "description": "Forces the slotted element to fill the beta container size (same heigh and width). By default, the beta container adapts to the slotted element size.", "default": "false", "attribute": "fill", "reflects": true }, { "kind": "field", "name": "position", "privacy": "public", "type": { "text": "PositionType" }, "description": "Where to position the beta label.", "default": "'top-left'", "attribute": "position", "reflects": true } ], "attributes": [ { "name": "fill", "type": { "text": "boolean" }, "description": "Forces the slotted element to fill the beta container size (same heigh and width). By default, the beta container adapts to the slotted element size.", "default": "false", "fieldName": "fill" }, { "name": "position", "type": { "text": "PositionType" }, "description": "Where to position the beta label.", "default": "'top-left'", "fieldName": "position" } ], "superclass": { "name": "LitElement", "package": "lit" }, "cssDisplay": "grid", "tagName": "cc-beta", "customElement": true } ], "exports": [ { "kind": "js", "name": "CcBeta", "declaration": { "name": "CcBeta", "module": "src/components/cc-beta/cc-beta.js" } }, { "kind": "custom-element-definition", "name": "cc-beta", "declaration": { "name": "CcBeta", "module": "src/components/cc-beta/cc-beta.js" } } ] }, { "kind": "javascript-module", "path": "src/components/cc-block-details/cc-block-details.js", "declarations": [ { "kind": "class", "description": "A display component with mostly HTML+CSS and an open/close toggle feature organized with slots to display information such as CLI commands.\nThe main purpose is to be used with a cc-block.\n\nšŸ§ [component's source code on GitHub](https://github.com/CleverCloud/clever-components/blob/master/src/components/cc-block-details/cc-block-details.js)\n\nšŸŽØ default CSS display: `block`\n\n### Dependencies\n```\nā”œā”€ cc-block-details\nā”‚ ā”œā”€ cc-icon\nā”‚ ā”œā”€ common.events\n\n```\n\n### Dependants\n```\nā”œā”€ cc-block-details\nā”‚ ā”œā”€ cc-addon-backups\nā”‚ ā”œā”€ cc-addon-credentials\nā”‚ ā”œā”€ cc-domain-management\nā”‚ ā”œā”€ cc-env-var-form\nā”‚ ā”œā”€ cc-network-group-list\nā”‚ ā”œā”€ cc-network-group-member-list\nā”‚ ā”œā”€ cc-tcp-redirection-form\nā”‚ ā”œā”€ cc-token-api-creation-form\nā”‚ ā”œā”€ cc-token-api-list\nā”‚ ā”œā”€ cc-token-api-update-form\n\n```", "name": "CcBlockDetails", "slots": [ { "description": "The title of the tab. Try to only use text.", "name": "button-text" }, { "description": "A zone dedicated to main content.", "name": "content" }, { "description": "A zone dedicated to link, for example to documentation.", "name": "link" } ], "members": [ { "kind": "field", "name": "isOpen", "privacy": "public", "type": { "text": "boolean" }, "description": "Sets the state of the toggle.", "default": "false", "attribute": "is-open", "reflects": true } ], "events": [ { "name": "cc-toggle", "type": { "text": "CcToggleEvent" }, "description": "Dispatched when an element is toggled." } ], "attributes": [ { "name": "is-open", "type": { "text": "boolean" }, "description": "Sets the state of the toggle.", "default": "false", "fieldName": "isOpen" } ], "superclass": { "name": "LitElement", "package": "lit" }, "cssDisplay": "block", "tagName": "cc-block-details", "customElement": true } ], "exports": [ { "kind": "js", "name": "CcBlockDetails", "declaration": { "name": "CcBlockDetails", "module": "src/components/cc-block-details/cc-block-details.js" } }, { "kind": "custom-element-definition", "name": "cc-block-details", "declaration": { "name": "CcBlockDetails", "module": "src/components/cc-block-details/cc-block-details.js" } } ] }, { "kind": "javascript-module", "path": "src/components/cc-block-section/cc-block-section.js", "declarations": [ { "kind": "class", "description": "A display component with mostly HTML+CSS to separate a `` into different sections.\n\nšŸ§ [component's source code on GitHub](https://github.com/CleverCloud/clever-components/blob/master/src/components/cc-block-section/cc-block-section.js)\n\nšŸŽØ default CSS display: `grid`\n\n## Details\n\n* This component is designed to only be use as a direct child of ``.\n\n\n\n### Dependants\n```\nā”œā”€ cc-block-section\nā”‚ ā”œā”€ cc-addon-admin\nā”‚ ā”œā”€ cc-addon-backups\nā”‚ ā”œā”€ cc-domain-management\nā”‚ ā”œā”€ cc-email-list\nā”‚ ā”œā”€ cc-grafana-info\nā”‚ ā”œā”€ cc-invoice-list\nā”‚ ā”œā”€ cc-oauth-consumer-form\nā”‚ ā”œā”€ cc-oauth-consumer-info\nā”‚ ā”œā”€ cc-orga-member-list\nā”‚ ā”œā”€ cc-ssh-key-list\nā”‚ ā”œā”€ cc-visual-tests-report\n\n```", "name": "CcBlockSection", "slots": [ { "description": "The main content (right part) of the section. If info is not defined, this will take all the width.", "name": "" }, { "description": "The info (left part) of the section.", "name": "info" }, { "description": "The title of the section. You can use a `.danger` CSS class on your `
` if it's a danger zone.", "name": "title" } ], "members": [], "superclass": { "name": "LitElement", "package": "lit" }, "cssDisplay": "grid", "tagName": "cc-block-section", "customElement": true } ], "exports": [ { "kind": "js", "name": "CcBlockSection", "declaration": { "name": "CcBlockSection", "module": "src/components/cc-block-section/cc-block-section.js" } }, { "kind": "custom-element-definition", "name": "cc-block-section", "declaration": { "name": "CcBlockSection", "module": "src/components/cc-block-section/cc-block-section.js" } } ] }, { "kind": "javascript-module", "path": "src/components/cc-block/cc-block.js", "declarations": [ { "kind": "class", "description": "A display component with mostly HTML+CSS and an open/close toggle feature organized with slots.\n\nšŸ§ [component's source code on GitHub](https://github.com/CleverCloud/clever-components/blob/master/src/components/cc-block/cc-block.js)\n\nšŸŽØ default CSS display: `block`\n\n## Details\n\n* The content-body section is wrapped in a `` so variation of this section height will be animated.\n\n### Type Definitions\n\n```ts\n\ninterface IconModel {\n content: string;\n}\n\n```\n```ts\n\ntype BlockToggleState = 'off' | 'open' | 'close';\n\n```\n\n### Dependencies\n```\nā”œā”€ cc-block\nā”‚ ā”œā”€ cc-button\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ common.events\nā”‚ ā”œā”€ cc-expand\nā”‚ ā”œā”€ cc-icon\nā”‚ ā”œā”€ cc-img\nā”‚ ā”œā”€ common.events\n\n```\n\n### Dependants\n```\nā”œā”€ cc-block\nā”‚ ā”œā”€ cc-addon-admin\nā”‚ ā”œā”€ cc-addon-backups\nā”‚ ā”œā”€ cc-addon-credentials\nā”‚ ā”œā”€ cc-addon-header\nā”‚ ā”œā”€ cc-addon-info\nā”‚ ā”œā”€ cc-addon-linked-apps\nā”‚ ā”œā”€ cc-addon-option-form\nā”‚ ā”œā”€ cc-domain-management\nā”‚ ā”œā”€ cc-elasticsearch-info\nā”‚ ā”œā”€ cc-email-list\nā”‚ ā”œā”€ cc-env-var-form\nā”‚ ā”œā”€ cc-feature-list\nā”‚ ā”œā”€ cc-grafana-info\nā”‚ ā”œā”€ cc-header-app\nā”‚ ā”œā”€ cc-header-orga\nā”‚ ā”œā”€ cc-heptapod-info\nā”‚ ā”œā”€ cc-homepage-video\nā”‚ ā”œā”€ cc-invoice-list\nā”‚ ā”œā”€ cc-invoice\nā”‚ ā”œā”€ cc-network-group-dashboard\nā”‚ ā”œā”€ cc-network-group-list\nā”‚ ā”œā”€ cc-network-group-member-list\nā”‚ ā”œā”€ cc-oauth-consumer-form\nā”‚ ā”œā”€ cc-oauth-consumer-info\nā”‚ ā”œā”€ cc-orga-member-list\nā”‚ ā”œā”€ cc-ssh-key-list\nā”‚ ā”œā”€ cc-tcp-redirection-form\nā”‚ ā”œā”€ cc-token-api-creation-form\nā”‚ ā”œā”€ cc-token-api-list\nā”‚ ā”œā”€ cc-token-api-update-form\nā”‚ ā”œā”€ cc-token-oauth-list\nā”‚ ā”œā”€ cc-token-session-list\nā”‚ ā”œā”€ cc-visual-tests-report\n\n```", "name": "CcBlock", "slots": [ { "description": "A zone dedicated to main content.", "name": "content" }, { "description": "A zone dedicated to content body content.", "name": "content-body" }, { "description": "A zone dedicated to content footer content.", "name": "content-footer" }, { "description": "A zone dedicated to content header content.", "name": "content-header" }, { "description": "A zone dedicated to footer content.", "name": "footer" }, { "description": "A zone dedicated to footer left side content.", "name": "footer-left" }, { "description": "A zone dedicated to footer right side content.", "name": "footer-right" }, { "description": "A zone dedicated to header content.", "name": "header" }, { "description": "The icon in the header.", "name": "header-icon" }, { "description": "A zone dedicated to header content on the top right side.", "name": "header-right" }, { "description": "The title of the header. Try to only use text. Use the `icon` property/attribute.", "name": "header-title" }, { "description": "The ribbon in the top left corner.", "name": "ribbon" } ], "members": [ { "kind": "field", "name": "icon", "privacy": "public", "type": { "text": "IconModel|null" }, "description": "Sets the icon before the title using a ``. Icon is hidden if nullish.", "default": "null", "attribute": "icon" }, { "kind": "field", "name": "image", "privacy": "public", "type": { "text": "string|null" }, "description": "Sets the icon before the title using a ``. Icon is hidden if nullish. Property will be ignored if `icon` property is already set.", "default": "null", "attribute": "image" }, { "kind": "field", "name": "ribbon", "privacy": "public", "type": { "text": "string|null" }, "description": "Adds a ribbon in the top left corner if it is not empty.", "default": "null", "attribute": "ribbon", "reflects": true }, { "kind": "field", "name": "toggle", "privacy": "public", "type": { "text": "BlockToggleState" }, "description": "Sets the state of the toggle behaviour.", "default": "'off'", "attribute": "toggle", "reflects": true } ], "events": [ { "name": "cc-toggle", "type": { "text": "CcToggleEvent" }, "description": "Dispatched when an element is toggled." } ], "attributes": [ { "name": "icon", "type": { "text": "IconModel|null" }, "description": "Sets the icon before the title using a ``. Icon is hidden if nullish.", "default": "null", "fieldName": "icon" }, { "name": "image", "type": { "text": "string|null" }, "description": "Sets the icon before the title using a ``. Icon is hidden if nullish. Property will be ignored if `icon` property is already set.", "default": "null", "fieldName": "image" }, { "name": "ribbon", "type": { "text": "string|null" }, "description": "Adds a ribbon in the top left corner if it is not empty.", "default": "null", "fieldName": "ribbon" }, { "name": "toggle", "type": { "text": "BlockToggleState" }, "description": "Sets the state of the toggle behaviour.", "default": "'off'", "fieldName": "toggle" } ], "superclass": { "name": "LitElement", "package": "lit" }, "cssDisplay": "block", "tagName": "cc-block", "customElement": true } ], "exports": [ { "kind": "js", "name": "CcBlock", "declaration": { "name": "CcBlock", "module": "src/components/cc-block/cc-block.js" } }, { "kind": "custom-element-definition", "name": "cc-block", "declaration": { "name": "CcBlock", "module": "src/components/cc-block/cc-block.js" } } ] }, { "kind": "javascript-module", "path": "src/components/cc-breadcrumbs/cc-breadcrumbs.events.js", "declarations": [ { "kind": "class", "description": "Dispatched when a breadcrumb item is clicked.\n\nšŸ§ [component's source code on GitHub](https://github.com/CleverCloud/clever-components/blob/master/src/components/cc-breadcrumbs/cc-breadcrumbs.events.js)\n\n\n\n### Dependants\n```\nā”œā”€ cc-breadcrumbs.events\nā”‚ ā”œā”€ cc-breadcrumbs\n\n```", "name": "CcBreadcrumbClickEvent", "members": [ { "kind": "field", "name": "TYPE", "type": { "text": "string" }, "static": true, "default": "'cc-breadcrumb-click'" } ], "superclass": { "name": "CcEvent", "module": "/src/lib/events.js" } } ], "exports": [ { "kind": "js", "name": "CcBreadcrumbClickEvent", "declaration": { "name": "CcBreadcrumbClickEvent", "module": "src/components/cc-breadcrumbs/cc-breadcrumbs.events.js" } } ] }, { "kind": "javascript-module", "path": "src/components/cc-breadcrumbs/cc-breadcrumbs.js", "declarations": [ { "kind": "class", "description": "A breadcrumb navigation component that displays a hierarchical path of items.\n\nšŸ§ [component's source code on GitHub](https://github.com/CleverCloud/clever-components/blob/master/src/components/cc-breadcrumbs/cc-breadcrumbs.js)\n\nšŸŽØ default CSS display: `block`\n\nEach breadcrumb item is clickable except the last item.\nClicking a breadcrumb item dispatches a `CcBreadcrumbClickEvent` with the path to that item.\n\nWARNING: When a breadcrumb item's `label` is an empty string, you MUST set the `iconA11yName` value to provide accessible text for the icon.\nOtherwise, the link will have no discernible text, which is a serious accessibility issue (WCAG: Links must have discernible text).\n\n### Type Definitions\n\n```ts\n\ninterface CcBreadcrumbsItem {\n value: string;\n label?: string;\n icon?: IconModel;\n /**\n * WARNING: When `label` is an empty string, you MUST set this value to provide accessible text for the icon.\n * Otherwise, the link will have no discernible text, which is a serious accessibility issue (WCAG: Links must have discernible text).\n */\n iconA11yName?: string;\n}\n\n```\n```ts\n\ninterface IconModel {\n content: string;\n}\n\n```\n\n### Dependencies\n```\nā”œā”€ cc-breadcrumbs\nā”‚ ā”œā”€ cc-link\nā”‚ ā”‚ ā”œā”€ cc-icon\nā”‚ ā”‚ ā”œā”€ cc-img\nā”‚ ā”œā”€ cc-breadcrumbs.events\n\n```\n\n### Dependants\n```\nā”œā”€ cc-breadcrumbs\nā”‚ ā”œā”€ cc-cellar-object-list\n\n```", "name": "CcBreadcrumbs", "members": [ { "kind": "field", "name": "items", "privacy": "public", "type": { "text": "Array" }, "description": "Set the items.", "default": "[]", "attribute": "items" }, { "kind": "field", "name": "label", "privacy": "public", "type": { "text": "string" }, "description": "The aria-label to set on the `