# dat-social-sdk-test

> social-app-sdk

Latest version **1.0.1133338** (published 2023-12-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install dat-social-sdk-test
pnpm add dat-social-sdk-test
yarn add dat-social-sdk-test
bun add dat-social-sdk-test
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1133338 |
| Published | 2023-12-07 |
| First published | 2021-06-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 197.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Haravan Inc. |
| Maintainers | phamdat8791 |

## Links

- npm: https://www.npmjs.com/package/dat-social-sdk-test
- npm.io page: https://npm.io/package/dat-social-sdk-test

## Recent versions

- 1.0.1133338 (latest) — 2023-12-07
- 1.0.555496 — 2021-06-30
- 1.0.555495 — 2021-06-30
- 1.0.555491 — 2021-06-30
- 1.0.555468 — 2021-06-30
- 1.0.555414 — 2021-06-30
- 1.0.554494 — 2021-06-28

## README

## Installation

You can install Social App SDK by using [Nmp](https://www.npmjs.com) or [Yarn](https://yarnpkg.com):

``` sh
npm install --save @haravan/social-app-sdk
```

or

``` sh
yarn add @haravan/social-app-sdk
```

Social App SDK can also be included directly on a page with a script tag pointing to a CDN-hosted copy of the library.  [Unpkg](https://unpkg.com/) is an example of a CDN that hosts npm modules.

``` html
<script src="https://unpkg.com/@haravan/social-app-sdk"></script>
<script>
  var AppBridge = window['social-app-sdk'];
  var actions = window['social-app-sdk'].actions;
</script>
```


## Usage

### Initializing Social App SDK

Import the library from the `@haravan/social-app-sdk` package and provide a configuration:

``` ts
import {createApp} from '@haravan/social-app-sdk';

const app = createApp({
  apiKey: 'API key from Haravan Partner Dashboard',
  targetOrigin: targetOrigin,   // "app.harasocial.com"
});
```

Using ES5 and the CDN-hosted version:
``` js
var AppBridge = window['social-app-sdk'];
var createApp = AppBridge.createApp;
var app = createApp({
  apiKey: 'API key from Haravan Partner Dashboard',
  targetOrigin: targetOrigin,   // "app.harasocial.com"
});
```

## Actions

Social App SDK introduces the concept of actions. An action provides a way for applications and hosts to trigger events with a statically-typed payload.

### Redirect

``` ts
import {createApp, actions} from '@haravan/social-app-sdk'

const app = createApp({
  apiKey: "03bf984d180772b9329f8188094960f6",
  targetOrigin: "app.harasocial.com"
});

let redirect = actions.Redirect.create(app);

//Redirect to accounts.haravan.com 
redirect.dispatch(actions.Redirect.Action.REMOTE, "https://accounts.haravan.com");

//Redirect to accounts.haravan.com with newContext
redirect.dispatch(actions.Redirect.Action.REMOTE, {
   url: "https://accounts.haravan.com",
   newContext: true
});
```

### Toast

``` ts
import {createApp, actions} from '@haravan/social-app-sdk'

const app = createApp({
  apiKey: "03bf984d180772b9329f8188094960f6",
  targetOrigin: "app.harasocial.com"
});

//Create a toast notice
const toastOptions = {
    message: 'Action saved',
    duration: 4, //second
};
const toastNotice = actions.Toast.create(app, toastOptions);
toastNotice.dispatch(actions.Toast.Action.SHOW);

//Create a toast error message
const toastOptions = {
    message: 'Error saving',
    duration: 4, //second
    isError: true,
};
const toastError = actions.Toast.create(app, toastOptions);
toastError.dispatch(actions.Toast.Action.SHOW);
```

### Loading

``` ts
import {createApp, actions} from '@haravan/social-app-sdk'

const app = createApp({
  apiKey: "03bf984d180772b9329f8188094960f6",
  targetOrigin: "app.harasocial.com"
});

const loading = actions.Loading.create(app)

//Start loading
loading.dispatch(actions.Loading.Action.START)

//Stop loading
loading.dispatch(actions.Loading.Action.STOP)
```

### Message Composer

``` ts
import {createApp, actions} from '@haravan/social-app-sdk'

const app = createApp({
  apiKey: "03bf984d180772b9329f8188094960f6",
  targetOrigin: "app.harasocial.com"
});

const messageComposer = actions.MessageComposer.create(app)
const action = actions.MessageComposer.Action;

//Text type
messageComposer.dispatch(action.TEXT, "Hi, I'm a text message")

//Image type
messageComposer.dispatch(action.IMAGE, {
   imageUrl: "https://product.hara.vn/200000003584/product/12_65048f4ab02845b985a70558d5645b49.jpg"
})

//Product type
 messageComposer.dispatch(action.PRODUCT, {
   title: "Product Title",
   subtitle: "Product subtitle",
   imageUrl: "https://product.hara.vn/200000003584/product/12_65048f4ab02845b985a70558d5645b49.jpg",
   buttonUrl: "https://app.harasocial.com"
})
```

### Session Token

``` ts
import {createApp, actions} from '@haravan/social-app-sdk'

const app = createApp({
  apiKey: "03bf984d180772b9329f8188094960f6",
  targetOrigin: "app.harasocial.com"
});

const sessionToken = await actions.SessionToken.getSessionToken(app);
```

---
_Source: https://npm.io/package/dat-social-sdk-test · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
