npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@tridion-sites/open-api-client

v4.0.0

Published

Tridion Sites Open API Client

Downloads

121

Readme

Tridion Sites Open API Client for Extensions

This package allows extensions developers to easily interact with Tridion Sites API. It provides a convenient interface for making HTTP requests and working with the API.

Note

Due to reliance on various functionality provided at runtime by Tridion Sites, this package is not suitable for standalone usage and can only be utilized as a part of an extension.

Features

  • Ready-to-use typescript client for Tridion Sites Open API
  • Automatic escaping of TCM URIs
  • Compatible with @tridion-sites/models

Installation

To install @tridion-sites/open-api-client, you can use npm or yarn:

$ npm install @tridion-sites/open-api-client
# or
$ yarn add @tridion-sites/open-api-client

Usage

import type { ActivityInstance } from '@tridion-sites/open-api-client';
import { ApiError, WorkflowService } from '@tridion-sites/open-api-client';

export const restartActivity = async (itemUri: string): Promise<ActivityInstance | undefined> => {
    try {
        const activity = await WorkflowService.restartActivity(itemUri);
        return activity;
    } catch (error) {
        if (error instanceof ApiError) {
            console.error(error.message, error);
        } else {
            console.log('Unknown error', error);
        }
    }

    return undefined;
};

// Note that we don't need to escape TCM URIs because the client handles this for us
const activity = await restartActivity('tcm:5-35-131104');

API Documentation

Documentation for all available services, their methods and interfaces can be found at http://developers.rws.com/tridion-sites-extensions-api-docs/open-api-client.html