open-index/open-npm huggingface dataset:
npm package: @k-int/address-plugin-british-isles
Description: Plugin to render a British Isles address form
Author: knowledgeintegration
Latest version: 1.1.0
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.






# address-plugin-british-isles

This is a plugin designed for use with `address-plugin-utils` as part of a general set of plugins. This plugin in particular refers to the Great Britain specific address form.
## Generic information
For the generic information about how these plugins operate, please see [here](https://gitlab.com/knowledge-integration/folio/addressplugins/-/blob/main/README.md). (I'd HIGHLY recommend starting there rather than trying to jump in blind here).

## plugin-specific details
There aren't any magic properties to these fields, but there is a set way to fill them in.

The user is expected to fill out an address such as
```
Paradise House,
35 Paradise St,
Sheffield City Centre,
Sheffield
S3 8PZ
```
as:
 `Paradise House -> Building name`.
`35 Paradise St -> Street Address` (Street address number would **not** be expected to be separated into building name).
`Sheffield City Centre -(?)> Town`. This is an optional field, and I'd expect the address to work fine without this proviso, but this would be the place for a location within a city but larger than a street.
`Sheffield -> City`.
`S3 8PZ -> Post Code`.

## Supported countries
This plugin currently supports address forms for England, Scotland, Wales and Northern Ireland
npm package: @k-int/address-plugin-generic
Description: Plugin to render a generic address form
Author: knowledgeintegration
Latest version: 1.1.0
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.


# address-plugin-generic

This is a plugin designed for use with `address-plugin-utils` as part of a general set of plugins. This plugin in particular acts as a fallback, with fields available for all address fields in the model. 
## Generic information
For the generic information about how these plugins operate, please see [here](https://gitlab.com/knowledge-integration/folio/addressplugins/-/blob/main/README.md). (I'd HIGHLY recommend starting there rather than trying to jump in blind here).
npm package: @k-int/address-plugin-north-america
Description: Plugin to render a North American address form
Author: knowledgeintegration
Latest version: 1.1.0
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.


# address-plugin-north-america

This is a plugin designed for use with `address-plugin-utils` as part of a general set of plugins. This plugin in particular refers to the US specific address form.
## Generic information
For the generic information about how these plugins operate, please see [here](https://gitlab.com/knowledge-integration/folio/addressplugins/-/blob/main/README.md). (I'd HIGHLY recommend starting there rather than trying to jump in blind here).

## plugin-specific details
The US form has some magic when it comes to the displayed `Address Line 1` and `AddressLine 2`. As per normal, it accepts data from the backend with `Premise` and `Thoroughfare`, and if both exists it will display those in `Address Line 1` and `AddressLine 2` respectively. However if just `Thoroughfare` exists, that will be displayed in `Address Line 1`, with `Address Line 2` left blank. This works in both directions, so you'd expect a user input of 

```
Address Line 1: "ABC Library",
Address Line 2: "123 Street"
```
to wind up as
```
Premise: "ABC Library",
Thoroughfare: "123 Street"
```
but an input without an Address Line 2:
```
Address Line 1: "123 Street"
```
to end up as 
```
Thoroughfare: "123 Street"
```

This means that `Address Line 1` is listed as required.
`backendToFields` and `fieldsToBackend` should be able to do most of the lifting here.

## Supported countries
This plugin currently supports address forms for USA and Canada
npm package: @k-int/address-utils
Description: Utility files for building location-specific address forms
Author: knowledgeintegration
Latest version: 1.1.0
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.


# address-utils

This is a set of functions and components designed to work across many `address-plugins`. For the most part you shouldn't need to actually access any of these, but they're listed here for posterity.

## Generic information
For the generic information about how these plugins operate, please see [here](https://gitlab.com/knowledge-integration/folio/addressplugins/-/blob/main/README.md). (I'd HIGHLY recommend starting there rather than trying to jump in blind here).

## Functions
This set `address-utils` currently comprises of 2 functions and a component:
- getExistingLineField
- deleteFieldIfExists
- AddressTextField

We'll go over these one by one.

### getExistingLineField
This function  accepts an array of `lines` (see the general documentation for more information about what those are) and a string containing the lowercase name of the field you're working on. Those follow the names set out by the general documentation, e.g. `"premise"`.

This function simply parses the array of lines, and returns the one whose `line.type?.value` matches the field `string`, or null if none exist.

(This is **NOT** set up to allow multiple lines of the same type. This function will just return the first one it finds. See the general docs for more information.)

### deleteFieldIfExists
This function accepts the same props as `getExistingLineField` above. It calls `getExistingLineField` in order to find the id of the saved line, and then returns an object `{id: "some_id", _delete:true}` In our backend setup this will delete the line saved with that id, but this may not be universal, and so you may need to write code to mimic this functionality for _your_ backend model wherever it is used.

### AddressTextField
This is a simple component which just returns a final-form `Field` with the props passed to it and `parse={v => v}`, which is simply there to allow "empty" inputs such as " " to be submitted. This component accepts props handed to it directly from `AddressFields` from each plugin. See the general documentation for the props expected by that component, as they are simply passed through to here.

## Release Procedure

* Check CHANGELOG.md
* Check correct version in package.json
* Check everything
* Re-Check everything
* Make preparatory commit
* Tag - git tag -a vn.n.n -m "Tagged version n.n.n"
* git push origin vn.n.n (Or your preferred variant) 
* Jenkins does it's magic causing release artefacts to appear in nexus
* Update the version in package.json and open the new version in CHANGELOG.md
npm package: @k-int/ill-request
Description: Request resources for ILL
Latest version: 1.4.2
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

# ui-request

Copyright (C) 2018 The Open Library Foundation

This software is distributed under the terms of the Apache License, Version 2.0.

This is an "alias" app, which merely invokes `ui-ill`. That app inspects the route by which it has been invoked to determine how it should function. That means it consists only of a single [three-line source-file](index.js) together with a [minimal package file](package.json), an [app icon](icons/app.svg) and [translation files](translations) containing [nothing but the name of the app](translations/ui-request/en_US.json).
npm package: @k-int/ill-supply
Description: Supply resources for ILL
Latest version: 1.4.2
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

# ui-supply

Copyright (C) 2018 The Open Library Foundation

This software is distributed under the terms of the Apache License, Version 2.0.

This is an "alias" app, which merely invokes `ui-ill`. That app inspects the route by which it has been invoked to determine how it should function. That means it consists only of a single [three-line source-file](index.js) together with a [minimal package file](package.json), an [app icon](icons/app.svg) and [translation files](translations) containing [nothing but the name of the app](translations/ui-supply/en_US.json).
npm package: @k-int/ill-ui
Description: Inter Library Loans
Latest version: 2.1.3

# ui-ill

Copyright (C) 2018 The Open Library Foundation

This software is distributed under the terms of the Apache License, Version 2.0. See the file "[LICENSE](LICENSE)" for more information.

## Introduction

Congratulations on creating a new Stripes UI app module! Follow the instructions below to run ui-ill-ui and start your development.

## Prerequisites

In order to view and log into the platform being served up, a suitable Okapi backend will need to be running. The [Folio testing-backend](https://app.vagrantup.com/folio/boxes/testing-backend) Vagrant box should work if your app does not yet have its own backend module.

## Run your new app

Run the following from the ui-ill-ui directory to serve your new app using a development server:
```
stripes serve
```

Note: When serving up a newly created app that does not have its own backend permissions established, pass the `--hasAllPerms` option to display the app in the UI navigation. For example:
```
stripes serve --hasAllPerms
```

To specify your own tenant ID or to use an Okapi instance other than http://localhost:9130, pass the `--okapi` and `--tenant` options.
```
stripes serve --okapi http://my-okapi.example.com:9130 --tenant my-tenant-id
```

## Run the tests

Run the included UI test `demo` with the following command:
```
stripes test --run demo --show
```

## What to do next?

Now that your new app is running, search the code for "`stripes-new-app`" to find comments and subbed placeholders that may need your attention.

Read the [Stripes Module Developer's Guide](https://github.com/folio-org/stripes/blob/master/doc/dev-guide.md).

Update this README with information about your app.
npm package: @k-int/ill-update
Description: Quickly change the status of items. Part of the Ill project.
Latest version: 1.7.2
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

# ui-scan

Copyright (C) 2019 The Open Library Foundation

This software is distributed under the terms of the Apache License, Version 2.0. See the file "[LICENSE](LICENSE)" for more information.

## Introduction

Congratulations on creating a new Stripes UI app module!  Follow the instructions below to run ui-scan and start your development.

TODO: Modify this README to replace these sections about getting started.

## Prerequisites

In order to view and log into the platform being served up, a suitable Okapi backend will need to be running. The [testing-backend](https://app.vagrantup.com/folio/boxes/testing-backend) Vagrant box should work if your app does not yet have its own backend module.

## Run your new app

Run the following from the ui-scan directory to serve your new app using a development server:
```
stripes serve
```

Note: When serving up a newly created app that does not have its own backend permissions established, pass the `--hasAllPerms` option to display the app in the UI navigation. For example:
```
stripes serve --hasAllPerms
```

To specify your own tenant ID or to use an Okapi instance other than `http://localhost:9130` pass the `--okapi` and `--tenant` options.
```
stripes serve --okapi http://my-okapi.example.com:9130 --tenant my-tenant-id
```

## Run the tests

Run the included UI tests with the following command:
```
stripes test karma
```

## What to do next?

Now that your new app is running, search the code for "`new-app`" to find comments and subbed placeholders that may need your attention.

Please remove or customize the sample strings in `en.json` (lines 3-10) before merging this file to master; the translators do not need to be providing translations for these sample strings.

Read the [Stripes Module Developer's Guide](https://github.com/folio-org/stripes/blob/master/doc/dev-guide.md).

When your new UI app is ready and being built by CI, then adjust its Jenkinsfile to remove the `npmDeploy = 'no'` parameter (which is then superfluous).

TODO: Modify this README to replace these sections about getting started, link to your issue tracker, etc.
npm package: @k-int/stripes-ill
Description: Common elements used by Ill's Stripes modules
Latest version: 2.1.2

# stripes-ill


This is a library of common elements used by Stripes apps for the ILL system.

This library is managed by https://www.npmjs.com/package/semantic-release - please don't manually adjust the project version. Instead merge 
onto the release branch and use "feature", "fix" and "chore" semantic commits to infer version increments.

See https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit-header for info on accepted commit types