astro-cloudinary/src/lib/resources.ts

<a href="https://github.com/cloudinary-community/astro-cloudinary/actions/workflows/test_and_release.yml"><img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/cloudinary-community/astro-cloudinary/test_and_release.y

import type { CloudinaryResource, CloudinaryResourceResourceType } from '@cloudinary-util/types';
import { ASTRO_CLOUDINARY_VERSION } from '../constants/analytics';

/**
 * cldRequest
 * @description Wrapper for fetch requests with Cloudinary API and credentials 
 */

export async function cldRequest(path: string) {
  return fetch(`https://api.cloudinary.com/v1_1/${import.meta.env.PUBLIC_CLOUDINARY_CLOUD_NAME}${path}`, {
    headers: {
      'Authorization': 'Basic ' + btoa(`${import.meta.env.PUBLIC_CLOUDINARY_API_KEY}:${import.meta.env.CLOUDINARY_API_SECRET}`),
      'User-Agent'   : `CloudinaryAstro/${ASTRO_CLOUDINARY_VERSION}`
    }
  });
}

/**
 * getEnvironmentConfig
 * @description Get's a Cloudinary product environment's configuration
 */

export async function getEnvironmentConfig() {
  const params = new URLSearchParams();

  params.append('settings', 'true');

  const response = await cldRequest(`/config?${params}`);

  if ( !response.ok ) {
    throw new Error('Failed to get product environment.');
  }

  const data = await response.json();

  return data;
}

/**
 * listResources
 * @description 
 */

export interface ListResourcesOptions {
  deliveryType: 'upload' | 'fetch' | 'private' | 'authenticated' | 'sprite' | 'facebook' | 'twitter' | 'youtube' | 'vimeo';
  fields?: Array<string>;
  folder?: CloudinaryResource["folder"];
  folderMode?: string;
  limit?: number;
  nextCursor?: string;
  resourceType: Omit<CloudinaryResourceResourceType, "auto">;

  // Additional data
  context?: boolean;
  metadata?: boolean;
  moderation?: boolean;
  tags?: boolean;
}

export interface ListResourcesResponse {
  resources: Array<CloudinaryResource>;
  next_cursor: string;
}

export async function listResources(options: ListResourcesOptions): Promise<ListResourcesResponse> {
  const params = new URLSearchParams();

  if ( options.nextCursor ) {
    params.append('next_cursor', options.nextCursor);
  }

  if ( options.limit ) {
    params.append('max_results', `${options.limit}`);
  }

  params.append('type', options.deliveryType);

  // There are a few options that are simple booleans that help
  // include specific datapoints that aren't included by default

  const contentOptions = ['context', 'metadata', 'moderation', 'tags'];

  for ( let contentOption of contentOptions ) {
    const value = options[contentOption as keyof ListResourcesOptions];
    if ( typeof value === 'boolean' ) {
      params.append(contentOption, `${value}`);
    }
  }

  if ( Array.isArray(options.fields) ) {
    const fields = options.fields.join(',');
    params.append('fields', fields);
  }

  let response;

  if ( options.folder ) {
    if ( options.folderMode === 'dynamic' ) {

      params.append('asset_folder', options.folder);

      response = await cldRequest(`/resources/by_asset_folder?${params}`);

    } else if ( options.folderMode === 'fixed' ) {

      params.append('prefix', options.folder);

      response = await cldRequest(`/resources/${options.resourceType}?${params}`);

    } else {
      throw new Error(`Unhandled folder mode: ${options.folderMode}`);
    }
  } else {
    response = await cldRequest(`/resources/${options.resourceType}?${params}`);
  }

  if ( !response.ok ) {
    throw new Error(`Failed to list resources - ${response.statusText}`);
  }

  const data = await response.json();

  return data;
}