open-index/open-npm huggingface dataset:
npm package: @liquid-state/directory-client
Description: Client library for Organisation Directory.
Author: Liquid State
Latest version: 4.3.1

# `directory-client`

A TypeScript client library by [Liquid State](https://liquid-state.com/) for the PEP Health Organisation Directory API.

- **Repository**: https://github.com/liquid-state/directory-client.git
- **Issues**: https://github.com/liquid-state/directory-client/issues

## Usage

### Install

```sh
npm install @liquid-state/directory-client
```

### Import

```typescript
import OrganisationDirectoryClient from '@liquid-state/directory-client';

const client = new OrganisationDirectoryClient();
```

### Search

```typescript
await client.getOrganisations('Failed to get the organisations', {
  page: number | string,
  search: string,
});
```

### Create Claim

```typescript
await client.createClaim('Failed to create claim', {
  organisation: string | null;
  claimed_name: string;
  full_name: string;
  position: string;
  message: string;
  org_exists: boolean;
});
```

### Create Contact Request

```typescript
await client.createContactRequest('Failed to create contact request', {
  full_name: string;
  email: string;
  message: string;
});
```
npm package: @liquid-state/docviewer
Description: Plugin to launch and run the Liquid State Document Viewer
Author: Paul Cash
Latest version: 1.5.0

# @liquid-state/docviewer

Liquid State Docviewer Plugin

## Install

```bash
npm install @liquid-state/docviewer
npx cap sync
```

## API

<docgen-index>

* [`echo(...)`](#echo)
* [`launchNamedDocument(...)`](#launchnameddocument)
* [`launchDocument(...)`](#launchdocument)
* [`closeViewerIfAny()`](#closeviewerifany)

</docgen-index>

<docgen-api>
<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->

### echo(...)

```typescript
echo(options: { value: string; }) => Promise<{ value: string; }>
```

Useless api that can be used to test the plugin

| Param         | Type                            | Description                |
| ------------- | ------------------------------- | -------------------------- |
| **`options`** | <code>{ value: string; }</code> | value to echo back (no ui) |

**Returns:** <code>Promise&lt;{ value: string; }&gt;</code>

--------------------


### launchNamedDocument(...)

```typescript
launchNamedDocument(options: { name: string; page_slug?: string; config?: {}; }) => Promise<{ viewer_id: string; }>
```

Launch a built-in document using it's base file name (note: this is just the file name, not path)

| Param         | Type                                                            | Description                |
| ------------- | --------------------------------------------------------------- | -------------------------- |
| **`options`** | <code>{ name: string; page_slug?: string; config?: {}; }</code> | name, page_slug and config |

**Returns:** <code>Promise&lt;{ viewer_id: string; }&gt;</code>

--------------------


### launchDocument(...)

```typescript
launchDocument(options: { url: string; page_slug?: string; config?: {}; }) => Promise<{ viewer_id: string; }>
```

Launch a document using a local (on ios: file, on android: content) url

| Param         | Type                                                           | Description               |
| ------------- | -------------------------------------------------------------- | ------------------------- |
| **`options`** | <code>{ url: string; page_slug?: string; config?: {}; }</code> | url, page_slug and config |

**Returns:** <code>Promise&lt;{ viewer_id: string; }&gt;</code>

--------------------


### closeViewerIfAny()

```typescript
closeViewerIfAny() => Promise<void>
```

Close any currently open document viewer

--------------------

</docgen-api>
npm package: @liquid-state/iwa-core
Description: Core library for creating Liquid State Integrated Web Apps (IWAs)
Author: Liquid State
Latest version: 1.8.3

# IWA Core

Core library for creating Liquid State Integrated Web Apps (IWAs).

Contains:
* A communication framework for communicating with native mobile apps.
* An Alternative Location Service (ALS) for determining remote endpoints at runtime. 
* A parser for the webapp.json configuration file.
npm package: @liquid-state/iwa-desktop
Description: A set of functions and utilities to make it easy to run IWAs in a desktop environment.
Author: Liquid State
Latest version: 0.2.7

# IWA Desktop Environment

A set of functions and utilities to make it easy to run IWAs in a desktop environment. This can be used to run a full desktop version of an application in production or to make developing IWAs simpler by modelling native behaviours in a browser.

## Basics

To get a simple working environment quickly you'll need to follow a few quick steps.

1. Replace the communicator with the noopCommunicator from this package

```
import Desktop from '@liquid-state/iwa-desktop'

const app = createApp(definition, Desktop.createNoopCommunicator());
```

2. Wrap the resulting communicator in the default middleware

```
Desktop.injectDefaultMiddleware(app.communicator);
```

3. Add any additional middleware you need (eg config)

```
import { middleware } from '@liquid-state/iwa-desktop';
app.communicator.addOnSendMiddleware(middleware.config({
    AWS_REGION: 'us-east-2',
    AWS_USERPOOL_ID: 'abc123'
}));
```

## Available middleware

### OnSend

* navigation (included in default)
* config

### OnRecieve

None
npm package: @liquid-state/ubiquity-client
Description: Client library for Liquid State Ubiquity
Author: Liquid State
Latest version: 0.2.6

# Ubiquity Client

A client library for Liquid State Ubiquity

This library is written from the perspective of an app user (typically used from an IWA). If you are looking for an api client for the administration api you should see our [documentation](https://liquidstate.atlassian.net/wiki/spaces/LSKB/overview)
npm package: @liquid-state/ui-theme-grey
Description: A grey theme for the [Liquid State UI Kit](https://github.com/liquid-state/ls-ui-kit/) which can be used to help prototype UIs without colour.
Author: Liquid State
Latest version: 0.1.1

# Liquid State UI Kit Grey Theme

A grey theme for the [Liquid State UI Kit](https://github.com/liquid-state/ls-ui-kit/) which can be used to help prototype UIs without colour.
npm package: @liquid-state/ui-theme-liquid-state
Description: This is a theme for the [Liquid State UI Kit](https://github.com/liquid-state/ls-ui-kit/) which uses Liquid State corporate colours.
Author: Liquid State
Latest version: 0.1.1

# Liquid State UI Kit Theme

This is a theme for the [Liquid State UI Kit](https://github.com/liquid-state/ls-ui-kit/) which uses Liquid State corporate colours.
npm package: @liquid101/form
Description: Intuitive forms for react
Latest version: 1.0.3

Intuitive forms for react

Quick Start
npm install @liquid101/form

```tsx
import {
    Form,
    FieldGroup,
    DateEntryField,
    TimeEntryField,
    EntryField,
    SelectField,
    TextArea,
    CoverSelect,
    Button,
    Buttons,
    CheckBox,
    Slider,
    TagsField,
    Validator,
} from "@/liquid-forms/index";
```

```tsx
<Form ref={form} model={post}>
    <Validator valid={validateForm} message="Invalid form"></Validator>
    <FieldGroup label="Identify">
        <EntryField name="name" label="Title" type="text">
            <Validator valid={validateName} message="Invalid name"></Validator>
        </EntryField>
        <TextArea name="description" label="Title" type="text">
            <Validator
                valid={validateDesc}
                message="Invalid description"
            ></Validator>
        </TextArea>
    </FieldGroup>

    <FieldGroup label="Copy Right" select="copyright">
        <Validator valid={validateFG} message="Invalid FG"></Validator>
        <CheckBox name="super1" label="Super1"></CheckBox>
        <CheckBox name="super2" label="Super2"></CheckBox>
        <CheckBox name="super3" label="Super3"></CheckBox>
    </FieldGroup>
</Form>
```