@sprucelabs/spruce-cli/src/features/store/StoreFeature.ts

Command line interface for building Spruce skills.

import { diskUtil } from '@sprucelabs/spruce-skill-utils'
import uiUtil from '../../utilities/ui.utility'
import AbstractFeature, {
    FeatureDependency,
    FeatureOptions,
} from '../AbstractFeature'
import { FeatureCode } from '../features.types'

export default class StoreFeature extends AbstractFeature {
    public nameReadable = 'Data Stores'
    public description = 'For working with remote places of storage.'
    public code: FeatureCode = 'store'
    public dependencies: FeatureDependency[] = [
        {
            code: 'skill',
            isRequired: true,
        },
    ]
    public packageDependencies = [
        { name: '@sprucelabs/spruce-store-plugin@latest', isDev: false },
        { name: '@sprucelabs/data-stores@latest', isDev: false },
    ]

    public actionsDir = diskUtil.resolvePath(__dirname, 'actions')

    public constructor(options: FeatureOptions) {
        super(options)

        void this.emitter.on(
            'test.register-abstract-test-classes',
            this.registerAbstractTestClassHandler.bind(this)
        )
        void this.emitter.on(
            'feature.did-execute',
            this.handleDidExecute.bind(this)
        )
    }

    private async registerAbstractTestClassHandler() {
        return {
            abstractClasses: [
                {
                    name: 'AbstractStoreTest',
                    label: 'AbstractStoreTest',
                    import: '@sprucelabs/spruce-store-plugin',
                    featureCode: 'store',
                },
            ],
        }
    }

    private async handleDidExecute(payload: {
        featureCode: string
        actionCode: string
    }) {
        const isInstalled = await this.features.isInstalled('store')

        const isUpgrade =
            isInstalled &&
            payload.featureCode === 'node' &&
            payload.actionCode === 'upgrade'

        if (isUpgrade) {
            uiUtil.renderMasthead({
                ui: this.ui,
                headline: 'Re-syncing data stores...',
            })

            const results = await this.Action('store', 'sync').execute({})

            return results
        }

        return {}
    }

    public async afterPackageInstall() {
        const files = await this.Writer('store').writePlugin(this.cwd)
        return {
            files,
        }
    }
}

declare module '../../features/features.types' {
    interface FeatureMap {
        store: StoreFeature
    }

    interface FeatureOptionsMap {
        store: undefined
    }
}