Wondering what’s next for npm?Check out our public roadmap! »

    @kwaeri/service
    TypeScript icon, indicating that this package has built-in type declarations

    0.2.1 • Public • Published

    kwaeri-node-kit-service

    pipeline status coverage report CII Best Practices

    The @kwaeri/service component for the @kwaeri/node-kit application platform

    TOC

    The Implementation

    The service component provides the interface(s) that kwaeri services implement for fulfilling the requests of end users of @kwaeri/cli [nkm].

    Getting Started

    NOTE

    @kwaeri/service is not ready for production. We've published this module for testing and development purposes. You're free to try out anything that may already be available, but please be aware that there is likely to be many aspects of the platform which are not working and/or are completely broken. As we near completion of the new platform, we'll update documentation and provide complete examples and tutorials for getting started.

    Installation

    @kwaeri/node-kit wraps the various components under the kwaeri scope, and provides a single entry point to the node-kit platform for easing the process of building a kwaeri application.

    However, if you wish to install @kwaeri/service and utilize it specifically - perform the following steps to get started:

    Install @kwaeri/service:

    npm install @kwaeri/service

    Usage

    The service component is leveraged for deriving services - and their providers - which are then used by the CLI, through the Steward, explicitly in its handling of commands passed to it by the end user making automation requests - which is pretty much the core purpose of the CLI.

    To leverage the service component, you'll first need to include it:

    // INCLUDES
    import {
        ServiceProvider,
        ServiceProviderSubscriptionsPromise,
        ServiceProviderHelpTextPromise
    } from '@kwaeri/service';
    
    // example of a basic service provider:
    export class ExampleServiceProvider extends ServiceProvider
    {
        async getServiceProviderSubscriptions<T extends ServiceProviderSubscriptionsPromise>( options?: any ): Promise<T>
        {
            return Promise.resolve( <T>{ commands: {}, required: {}, optional: {}, subcommands: {} } );
        }
        async getServiceProviderSubscriptionHelpText<T extends ServiceProviderHelpTextPromise>( options?: any ): Promise<T>
        {
            return Promise.resolve( <T>{ helpText: { "command": `To use this service, read this HelpText.` } } );
        }
        async run<T extends any>( options?: any ): Promise<T>
        {
            return Promise.resolve( <T>( () => console.log( 'Service should run at this point.' ) ) );
        }
    }
    
    // ...

    To be continued...but in the meantime, check out the node-kit wizard to see a real example of a service [derivation] implementation.

    NOTE

    As mentioned earlier, the plan is to continue development of the myriad components of the node-kit platform - the service component included - and ultimately ease the process of development, maintainence, and usage of each individual component as they are decoupled from one another.

    How to Contribute Code

    Our Open Source projects are always open to contribution. If you'd like to cocntribute, all we ask is that you follow the guidelines for contributions, which can be found at the Massively Modified Wiki

    There you'll find topics such as the guidelines for contributions; step-by-step walk-throughs for getting set up, Coding Standards, CSS Naming Conventions, and more.

    Other Ways to Contribute

    There are other ways to contribute to the project other than with code. Consider testing the software, or in case you've found an Bug - please report it. You can also support the project monetarly through donations via PayPal.

    Regardless of how you'd like to contribute, you can also find in-depth information for how to do so at the Massively Modified Wiki

    Bug Reports

    To submit bug reports, request enhancements, and/or new features - please make use of the issues system baked-in to our source control project space at Gitlab

    You may optionally start an issue, track, and manage it via email by sending an email to our project's Service Desk.

    For more in-depth documentation on the process of submitting bug reports, please visit the Massively Modified Wiki on Bug Reports

    Vulnerability Reports

    Our Vulnerability Reporting process is very similar to Gitlab's. In fact, you could say its a fork.

    To submit vulnerability reports, please email our Security Group. We will try to acknowledge receipt of said vulnerability by the next business day, and to also provide regular updates about our progress. If you are curious about the status of your report feel free to email us again. If you wish to encrypt your disclosure email, like with gitlab - please email us to ask for our GPG Key.

    Please refrain from requesting compensation for reporting vulnerabilities. We will publicly acknowledge your responsible disclosure, if you request us to do so. We will also try to make the confidential issue public after the vulnerability is announced.

    You are not allowed, and will not be able, to search for vulnerabilities on Gitlab.com. As our software is open source, you may download a copy of the source and test against that.

    Confidential Issues

    When a vulnerability is discovered, we create a [confidential issue] to track it internally. Security patches will be pushed to private branches and eventually merged into a security branch. Security issues that are not vulnerabilites can be seen on our public issue tracker.

    For more in-depth information regarding vulnerability reports, confidentiality, and our practices; Please visit the Massively Modified Wiki on Vulnerability

    Donations

    If you cannot contribute time or energy to neither the code base, documentation, nor community support; please consider making a monetary contribution which is extremely useful for maintaining the Massively Modified network and all the goodies offered free to the public.

    Donate via PayPal.com

    Install

    npm i @kwaeri/service

    DownloadsWeekly Downloads

    13

    Version

    0.2.1

    License

    Apache-2.0

    Unpacked Size

    35.4 kB

    Total Files

    12

    Last publish

    Collaborators

    • avatar