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

@grace-studio/umbraco-client

v0.2.1

Published

Middle layer to connect with Umbraco Delivery API.

Downloads

219

Readme

@grace-studio/umbraco-client

npm version

A middle layer that connects your application to the Umbraco CMS using a simple and flexible API client.

Features

  • Easy Integration: Seamlessly integrate Umbraco CMS with your app.
  • TypeScript Support: Automatically generate types from your Umbraco Swagger schema.
  • Flexible API: Provides methods to fetch, format, and filter content efficiently.

Installation

Install the package using npm or yarn:

# Using npm
npm install @grace-studio/umbraco-client

# Using yarn
yarn add @grace-studio/umbraco-client

Generate TypeScript Types

Before using the client, generate TypeScript types based on your Umbraco Swagger schema. This ensures type safety when interacting with the Umbraco API.

npx openapi-typescript https://your-umbraco-url/swagger/v1/swagger.json --output ./src/api/types.ts

This command will generate TypeScript definitions for your Umbraco API and save them in ./src/api/types.ts.

If running into issues with self-signed SSL certificate locally

Add the environment variable NODE_TLS_REJECT_UNAUTHORIZED=0 to tell Node.js to ignore SSL certificate validation. This is useful for local development when working with a self-signed certificate or localhost.

NODE_TLS_REJECT_UNAUTHORIZED=0 npx openapi-typescript https://your-umbraco-url/swagger/v1/swagger.json --output ./src/api/types.ts

Usage

Below is an example of how to use the UmbracoClient in your Next.js application.

Setup the API Client

import type { components, paths } from '#api/types';
import { UmbracoClient } from '@grace-studio/umbraco-client';

// Create an instance of UmbracoClient
const apiClient = UmbracoClient.create<paths>({
  apiToken: 'your-api-token', // Replace with your actual API token
  apiUrl: 'https://your-umbraco-url', // Your Umbraco API URL
});

Example API Methods

Here are some common use cases for fetching content from the Umbraco CMS using the UmbracoClient.

Fetch All Content

const getContent = () =>
  apiClient
    .get('/umbraco/delivery/api/v2/content')
    .then(UmbracoClient.format.content); // Format the content

Fetch a Specific Content Item by Path

const getContentItem = (path: string) =>
  apiClient
    .get('/umbraco/delivery/api/v2/content/item/{path}', {
      params: {
        path: { path }, // Pass the path as a parameter
      },
    })
    .then(UmbracoClient.format.contentItem); // Format the specific content item

Fetch Content Paths

const getPaths = (
  basePath: string, // Base path, eg. your locale '/en'
) =>
  apiClient.getPaths({
    basePath,
    excludeHidden: true, // Exclude hidden content
    mappingFunctions: {
      // Add custom mapping functions for hidden content based on properties
      hidden: ({ umbracoNaviHide }) => Boolean(umbracoNaviHide),
    },
    extraQueryParams: {
      sort: 'sortOrder:desc', // Possible to add extra query params to pass to Umbraco
    },
  });

Fetch Content Menu

const getMenu = (
  basePath: string, // Base path, eg. your locale '/en'
) =>
  apiClient.getMenu({
    basePath,
    excludeHidden: true, // Exclude hidden content
    mappingFunctions: {
      // Add custom mapping functions for hidden content based on properties
      hidden: ({ umbracoNaviHide }) => Boolean(umbracoNaviHide),
      type: (
        { isSecondaryLink }, // Custom mapping function for menu item type
      ) => (isSecondaryLink === true ? 'secondary' : 'primary'),
    },
  });