open-index/open-npm huggingface dataset:
npm package: @grnsft/if-core
Description: If core utilities.
Author: Green Software Foundation
Latest version: 0.0.31

# if-core

Here you can find all the necessary utilities for plugin development.

 - Plugin Factory
 - Utils for advanced plugin development
 - Types

## Installing

Run the command below in your project root:

```bash
npm install @grnsft/if-core
```

## Usage

> Note: For proper error handling, you have to use error classes from `@grnsft/if-core/utils`.

Here you can see usage example for plugin development:

```ts
import {PluginFactory} from '@grnsft/if-core/interfaces';
import {ERRORS} from '@grnsft/if-core/utils';
import {PluginParams, CustomConfig} from '@grnsft/if-core/types';

const {ConfigError, MissingInputDataError} = ERRORS;

const CustomPlugin = PluginFactory<CustomConfig>({
  configValidation: (config: CustomConfig) => {
    if (!config) {
      throw new ConfigError('My message here');
    }

    return config
  },
  implementation: async (inputs: PluginParams[], config: ConfigParams) => {
    // plugin related stuff here
  }
})
```
npm package: @grnsft/if-models
Description: Impact Framework Standard Models
Author: Green Software Foundation
Latest version: 0.1.6-beta
Deprecated: Dear community, 'if-models' package is no longer supported. Currently the actual version is 'if-plugins'.

# Impact Framework - Models

`if-models` are set of models maintained as a part of Impact Framework.

## Implementations

- [Cloud Instance Metadata](./src/lib/cloud-instance-metadata/README.md)
- [CSV Export](./src/lib/csv-export/README.md)
- [E-Mem](./src/lib/e-mem/README.md)
- [SCI](./src/lib/sci/README.md)
- [SCI-E](./src/lib/sci-e/README.md)
- [SCI-M](./src/lib/sci-m/README.md)
- [SCI-O](./src/lib/sci-o/README.md)
- [Shell](./src/lib/shell/README.md)
- [TDP Finder](./src/lib/tdp-finder/README.md)

## Contributing

See contributing rules [here](./CONTRIBUTING.md).
npm package: @grnsft/if-plugins
Description: Impact Framework Standard Plugins
Author: Green Software Foundation
Latest version: 0.3.2

> [!IMPORTANT]
> If you are participating in Carbon Hack 24, please **don't submit your plugin to the if-plugins repository**. This is the standard library of plugins for Impact Framework which are being maintained by the IF team. Please commit your plugin to your **own repository** and submit a link to your repo in your final submission for the hackaton. More info about building and publishing plugins [here](https://if.greensoftware.foundation/developers/how-to-build-plugins#step-5-publishing-your-plugin).


# Impact Framework - Plugins

`if-plugins` are set of plugins maintained as a part of Impact Framework.

## Implementations

- [Cloud Metadata](./src/lib/cloud-metadata/README.md)
- [Coefficient](./src/lib/coefficient/README.md)
- [CSV Export](./src/lib/csv-export/README.md)
- [E-Mem](./src/lib/e-mem/README.md)
- [E-Net](./src/lib/e-net/README.md)
- [Mock Observations](./src/lib/mock-observations/README.md)
- [Multiply](./src/lib/multiply/README.md)
- [SCI](./src/lib/sci/README.md)
- [SCI-E](./src/lib/sci-e/README.md)
- [SCI-M](./src/lib/sci-m/README.md)
- [SCI-O](./src/lib/sci-o/README.md)
- [Shell](./src/lib/shell/README.md)
- [Sum](./src/lib/sum/README.md)
- [TDP Finder](./src/lib/tdp-finder/README.md)

## Contributing

See contributing rules [here](./CONTRIBUTING.md).
npm package: @grnsft/if-unofficial-models
Description: Impact Framework Unofficial Models.
Author: Green Software Foundation
Latest version: 0.1.3
Deprecated: Dear community, 'if-unofficial-models' package is no longer supported. Currently the actual version is 'if-unofficial-plugins'.

# Impact Framework - Unofficial Models


## Implementations

- [Azure Importer](./src/lib/azure-importer/README.md)
- [Boavizta](./src/lib/boavizta/README.md)
- [CCF](./src/lib/ccf/README.md)
- [CO2.JS](./src/lib/co2js/README.md)
- [Teads AWS](./src/lib/teads-aws/README.md)
- [Teads TDP Curve](./src/lib/teads-curve/README.md)
- [Watt Time](./src/lib/watt-time/README.md)

## Contributing

See contributing rules [here](./CONTRIBUTING.md).
npm package: @grnsft/if-unofficial-plugins
Description: Impact Framework Unofficial Plugins.
Author: Green Software Foundation
Latest version: 0.3.1

> [!IMPORTANT]
> If you are participating in Carbon Hack 24, please **don't submit your plugin to the if-unofficial-plugins repository**. This is a library of plugins for Impact Framework which are being migrated to new owners and will eventually be decomissioned. Please commit your plugin to your **own repository** and submit a link to your repo in your final submission for the hackaton. More info about building and publishing plugins [here](https://if.greensoftware.foundation/developers/how-to-build-plugins#step-5-publishing-your-plugin).



# Impact Framework - Unofficial Plugins

## Implementations

- [Azure Importer](./src/lib/azure-importer/README.md)
- [Boavizta](./src/lib/boavizta/README.md)
- [CCF](./src/lib/ccf/README.md)
- [CO2.JS](./src/lib/co2js/README.md)
- [Teads AWS](./src/lib/teads-aws/README.md)
- [Teads TDP Curve](./src/lib/teads-curve/README.md)
- [Watt Time](./src/lib/watt-time/README.md)

## Contributing

See contributing rules [here](./CONTRIBUTING.md).