arcxp-sdk-ts

KO | EN

gitlite — search

#hacktoberfest #go #android #machine-learning #rust #deep-learning #linux #docker #macos #java #windows #awesome-list #mcp #open-source

(★ 12)

TypeScript SDK for ArcXP

arcxp-sdk-ts Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# arcxp-sdk-ts

A strongly typed set of ArcXP API's and utilities reduce the amount of work required to develop with ArcXP, starting with reducing the boilerplate code you have to write.

## Installation

Install the package with:

```
npm i @code.store/arcxp-sdk-ts
```

## Features

#### API

- Author
- Draft
- Identity
- IFX
- Redirect
- Migration Center
- Sales
- Site
- Websked
- Retail Events (WebSockets)
- Content
- Signing Service
- PhotoCenter
- Global Settings
- Tags

##### Usage example

```ts
import { ArcAPI } from '@code.store/arcxp-sdk-ts';

const api = ArcAPI({
  credentials: { organizationName: 'YOUR_ORG_NAME', accessToken: 'YOUR_ACCESS_TOKEN' },
  maxRPS: 10,
});
const id = await api.Draft.generateId(Date.now().toString());
```

#### Content Elements

- text
- header
- image
- quote
- interstitial_link
- raw_html
- gallery
- list
- link_list
- jwPlayer

##### Usage example

```ts
import { ContentElement } from '@code.store/arcxp-sdk-ts';

const header = ContentElement.header('Header', 4);
const text = ContentElement.text('text');
```

## Image migration example

```ts
import { ArcTypes, ArcAPI } from '@code.store/arcxp-sdk-ts';

await api.MigrationCenter.postAns(
  {
    website: 'YOUR_WEBSITE',
    groupId: 'images',
    priority: 'historical',
  },
  {
    sourceId: sourceImageId,
    sourceType: 'image',
    ANS: ans,
  }
);
```

## Changeset

`npx changeset && npx changeset version`

## License

[MIT](https://choosealicense.com/licenses/mit/)

arcxp-sdk-ts

arcxp-sdk-ts Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

arcxp-sdk-ts

arcxp-sdk-ts Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README