@cloudinary/asset-management-mcp 0.6.0

package/src/funcs/usageGetUsage.ts

@@ -0,0 +1,178 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { CloudinaryAssetMgmtCore } from "../core.js";
+import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import { APIError } from "../models/errors/apierror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import {
+  GetUsageRequest,
+  GetUsageRequest$zodSchema,
+  GetUsageResponse,
+  GetUsageResponse$zodSchema,
+} from "../models/getusageop.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Retrieves comprehensive usage metrics and account statistics
+ *
+ * @remarks
+ * A report on the status of product environment usage, including storage, credits, bandwidth, requests, number of resources, and add-on usage. No date parameter needed to get current usage statistics.
+ */
+export function usageGetUsage(
+  client$: CloudinaryAssetMgmtCore,
+  date?: string | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    GetUsageResponse,
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  return new APIPromise($do(
+    client$,
+    date,
+    options,
+  ));
+}
+
+async function $do(
+  client$: CloudinaryAssetMgmtCore,
+  date?: string | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      GetUsageResponse,
+      | APIError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
+> {
+  const input$: GetUsageRequest | undefined = {
+    date: date,
+  };
+
+  const parsed$ = safeParse(
+    input$,
+    (value$) => GetUsageRequest$zodSchema.optional().parse(value$),
+    "Input validation failed",
+  );
+  if (!parsed$.ok) {
+    return [parsed$, { status: "invalid" }];
+  }
+  const payload$ = parsed$.value;
+  const body$ = null;
+
+  const pathParams$ = {
+    cloud_name: encodeSimple("cloud_name", client$._options.cloud_name, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path$ = pathToFunc("/v1_1/{cloud_name}/usage")(
+    pathParams$,
+  );
+  const query$ = encodeFormQuery({
+    "date": payload$?.date,
+  });
+
+  const headers$ = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+  const securityInput = await extractSecurity(client$._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client$._options,
+    baseURL: options?.serverURL ?? client$._baseURL ?? "",
+    operationID: "getUsage",
+    oAuth2Scopes: null,
+    resolvedSecurity: requestSecurity,
+    securitySource: client$._options.security,
+    retryConfig: options?.retries
+      || client$._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || [
+      "429",
+      "500",
+      "502",
+      "503",
+      "504",
+    ],
+  };
+
+  const requestRes = client$._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path$,
+    headers: headers$,
+    query: query$,
+    body: body$,
+    userAgent: client$._options.userAgent,
+    timeoutMs: options?.timeoutMs || client$._options.timeoutMs
+      || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req$ = requestRes.value;
+
+  const doResult = await client$._do(req$, {
+    context,
+    errorCodes: [],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req$ }];
+  }
+  const response = doResult.value;
+  const responseFields$ = {
+    HttpMeta: { Response: response, Request: req$ },
+  };
+
+  const [result$] = await M.match<
+    GetUsageResponse,
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, GetUsageResponse$zodSchema, { key: "usage_response" }),
+    M.json([401, 403], GetUsageResponse$zodSchema, { key: "api_error" }),
+  )(response, req$, { extraFields: responseFields$ });
+
+  return [result$, { status: "complete", request: req$, response }];
+}

package/src/funcs/videoAnalyticsGetVideoViews.ts

@@ -0,0 +1,195 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { CloudinaryAssetMgmtCore } from "../core.js";
+import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import { APIError } from "../models/errors/apierror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import {
+  GetVideoViewsRequest,
+  GetVideoViewsRequest$zodSchema,
+  GetVideoViewsResponse,
+  GetVideoViewsResponse$zodSchema,
+  SortBy,
+} from "../models/getvideoviewsop.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Get video views
+ *
+ * @remarks
+ * Retrieves analytics data for video views. Results can be filtered using expressions based on various criteria
+ * such as video public ID, view duration, viewer information, and more.
+ */
+export function videoAnalyticsGetVideoViews(
+  client$: CloudinaryAssetMgmtCore,
+  expression?: string | undefined,
+  max_results?: number | undefined,
+  sort_by?: SortBy | undefined,
+  next_cursor?: string | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    GetVideoViewsResponse,
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  return new APIPromise($do(
+    client$,
+    expression,
+    max_results,
+    sort_by,
+    next_cursor,
+    options,
+  ));
+}
+
+async function $do(
+  client$: CloudinaryAssetMgmtCore,
+  expression?: string | undefined,
+  max_results?: number | undefined,
+  sort_by?: SortBy | undefined,
+  next_cursor?: string | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      GetVideoViewsResponse,
+      | APIError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
+> {
+  const input$: GetVideoViewsRequest | undefined = {
+    expression: expression,
+    max_results: max_results,
+    sort_by: sort_by,
+    next_cursor: next_cursor,
+  };
+
+  const parsed$ = safeParse(
+    input$,
+    (value$) => GetVideoViewsRequest$zodSchema.optional().parse(value$),
+    "Input validation failed",
+  );
+  if (!parsed$.ok) {
+    return [parsed$, { status: "invalid" }];
+  }
+  const payload$ = parsed$.value;
+  const body$ = null;
+
+  const pathParams$ = {
+    cloud_name: encodeSimple("cloud_name", client$._options.cloud_name, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path$ = pathToFunc("/v1_1/{cloud_name}/video/analytics/views")(
+    pathParams$,
+  );
+  const query$ = encodeFormQuery({
+    "expression": payload$?.expression,
+    "max_results": payload$?.max_results,
+    "next_cursor": payload$?.next_cursor,
+    "sort_by": payload$?.sort_by,
+  });
+
+  const headers$ = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+  const securityInput = await extractSecurity(client$._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client$._options,
+    baseURL: options?.serverURL ?? client$._baseURL ?? "",
+    operationID: "getVideoViews",
+    oAuth2Scopes: null,
+    resolvedSecurity: requestSecurity,
+    securitySource: client$._options.security,
+    retryConfig: options?.retries
+      || client$._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || [
+      "429",
+      "500",
+      "502",
+      "503",
+      "504",
+    ],
+  };
+
+  const requestRes = client$._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path$,
+    headers: headers$,
+    query: query$,
+    body: body$,
+    userAgent: client$._options.userAgent,
+    timeoutMs: options?.timeoutMs || client$._options.timeoutMs
+      || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req$ = requestRes.value;
+
+  const doResult = await client$._do(req$, {
+    context,
+    errorCodes: [],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req$ }];
+  }
+  const response = doResult.value;
+  const responseFields$ = {
+    HttpMeta: { Response: response, Request: req$ },
+  };
+
+  const [result$] = await M.match<
+    GetVideoViewsResponse,
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, GetVideoViewsResponse$zodSchema, { key: "object" }),
+    M.json([400, 401], GetVideoViewsResponse$zodSchema, { key: "api_error" }),
+  )(response, req$, { extraFields: responseFields$ });
+
+  return [result$, { status: "complete", request: req$, response }];
+}

package/src/hooks/cloudConfig.ts

@@ -0,0 +1,51 @@
+export class CloudConfig {
+    cloudName: string;
+    apiKey: string;
+    apiSecret: string;
+
+    constructor() {
+        this.cloudName = "";
+        this.apiKey = "";
+        this.apiSecret = "";
+
+        // Access process through globalThis
+        const process = (globalThis as any)?.process;
+
+        // First, try to parse CLOUDINARY_URL if it exists
+        let envVar: string | undefined = undefined;
+
+        if (process?.env?.CLOUDINARY_URL) {
+            envVar = process.env.CLOUDINARY_URL;
+        }
+
+        if (envVar) {
+            try {
+                const url = new URL(envVar);
+                this.cloudName = url.host;
+                this.apiKey = url.username || "";
+                this.apiSecret = url.password || "";
+            } catch (error) {
+                throw new Error(`Invalid CLOUDINARY_URL: '${envVar}'`);
+            }
+        }
+
+        // Then, check for individual environment variables (these take precedence)
+        if (process?.env) {
+            if (process.env.CLOUDINARY_CLOUD_NAME) {
+                this.cloudName = process.env.CLOUDINARY_CLOUD_NAME;
+            }
+            if (process.env.CLOUDINARY_API_KEY) {
+                this.apiKey = process.env.CLOUDINARY_API_KEY;
+            }
+            if (process.env.CLOUDINARY_API_SECRET) {
+                this.apiSecret = process.env.CLOUDINARY_API_SECRET;
+            }
+        }
+
+        // Automatically set CLOUDINARY_CLOUD_NAME if not already set
+        // This ensures the SDK can find cloudName during initialization
+        if (this.cloudName && process?.env && !process.env.CLOUDINARY_CLOUD_NAME) {
+            process.env.CLOUDINARY_CLOUD_NAME = this.cloudName;
+        }
+    }
+}

package/src/hooks/cloudinaryAuthHook.ts

@@ -0,0 +1,239 @@
+import {CloudConfig} from "./cloudConfig.js";
+import {BeforeRequestContext, BeforeRequestHook} from "./types.js";
+
+export class CloudinaryAuthHook
+    implements BeforeRequestHook {
+
+    private readonly cloudConfig: CloudConfig;
+
+    constructor() {
+        this.cloudConfig = new CloudConfig();
+    }
+
+    async beforeRequest(hookCtx: BeforeRequestContext, request: Request): Promise<Request> {
+        let security = hookCtx.securitySource;
+        // Resolve the security source if it's a function (for dynamic token refresh)
+        if (typeof security === 'function') {
+            security = await security();
+        }
+
+        // Prioritize OAuth2 bearer token if it's provided.
+        if (security && typeof security === 'object' && 'oauth2' in security && typeof security.oauth2 === 'string') {
+            const token = security.oauth2;
+            if (token) {
+                request.headers.set("Authorization", `Bearer ${token}`);
+                return request;
+            }
+        }
+
+        // Fallback to API key/secret signing if no OAuth token is present.
+        let { apiKey, apiSecret } = this.cloudConfig;
+
+        // Optionally merge user-supplied security overrides
+        if (security) {
+            // Handle custom cloudinaryAuth format
+            if ('cloudinaryAuth' in security && security.cloudinaryAuth) {
+                // Support both camelCase and snake_case for compatibility
+                if (security.cloudinaryAuth.apiKey || security.cloudinaryAuth.api_key) {
+                    apiKey = security.cloudinaryAuth.apiKey || security.cloudinaryAuth.api_key;
+                }
+                if (security.cloudinaryAuth.apiSecret || security.cloudinaryAuth.api_secret) {
+                    apiSecret = security.cloudinaryAuth.apiSecret || security.cloudinaryAuth.api_secret;
+                }
+            }
+            // Handle standard SDK security format (used by MCP server)
+            else if ('apiKey' in security || 'apiSecret' in security) {
+                if ('apiKey' in security && security.apiKey) {
+                    apiKey = security.apiKey;
+                }
+                if ('apiSecret' in security && security.apiSecret) {
+                    apiSecret = security.apiSecret;
+                }
+            }
+        }
+
+        if (!apiKey || !apiSecret) {
+            return request;
+        }
+
+        if (this.SIGNED_PATHS.every(path => request.url.indexOf(path) === -1)) {
+            // generate  Authorization header using basic auth where apiKey:apiSecret is encoded in base64
+            const authHeader = `Basic ${Buffer.from(`${apiKey}:${apiSecret}`).toString("base64")}`;
+            request.headers.set("Authorization", authHeader);
+            return request;
+        }
+
+        // Extract query parameters regardless of body existence
+        const url = new URL(request.url);
+        const queryParams = this.paramsFromQuery(url.searchParams);
+
+        // Handle case with only query parameters (no body)
+        if (!request.body) {
+            return this.signQueryOnlyRequest(request, apiKey, apiSecret, queryParams);
+        }
+
+        // if content-type is application/json, parse the body as json and add the signature, timestamp and apiKey to the body
+        if (request.headers.get("Content-Type") === "application/json") {
+            const preprocessedBody = await this.preprocessJsonRequest(request);
+            return this.signJsonRequest(request, apiKey, apiSecret, queryParams, preprocessedBody);
+        }
+
+        // if content-type is multipart/form-data, parse the body as form data and add the signature, timestamp and apiKey to the body
+        if (request.headers.get("Content-Type")?.startsWith("multipart/form-data")) {
+            return this.signFormDataRequest(request, apiKey, apiSecret, queryParams);
+        }
+
+        // Default case - just sign query parameters if any exist
+        if (queryParams.length > 0) {
+            return this.signQueryOnlyRequest(request, apiKey, apiSecret, queryParams);
+        }
+
+        return request;
+    }
+
+    paramsFromQuery(searchParams: URLSearchParams): string[] {
+        const params = [];
+        for (const [key, value] of searchParams.entries()) {
+            if (key !== "file" && key !== "cloud_name" && key !== "resource_type" && key !== "api_key" && key !== "signature" && key !== "timestamp") {
+                params.push(`${key}=${value}`);
+            }
+        }
+        return params;
+    }
+
+    async signQueryOnlyRequest(request: Request, apiKey: string, apiSecret: string, queryParams: string[]): Promise<Request> {
+        const url = new URL(request.url);
+        // Check if already signed
+        if (url.searchParams.has("signature")) {
+            return request;
+        }
+
+        const { signature, timestamp } = await this.computeSignature(queryParams, apiSecret);
+        url.searchParams.set("signature", signature);
+        url.searchParams.set("timestamp", timestamp.toString());
+        url.searchParams.set("api_key", apiKey);
+
+        return new Request(url.toString(), request);
+    }
+
+    async computeSignature(params: string[], apiSecret: string) {
+        const crypto = await import('node:crypto');
+        // Create a string with the parameters used in the POST request to Cloudinary:
+        //     All parameters added to the method call should be included except: file, cloud_name, resource_type and your api_key.
+        //     Sort all the parameters in alphabetical order.
+        //     Separate the parameter names from their values with an = and join the parameter/value pairs together with an &.
+        // Append your API secret to the end of the string.
+        // Create a hexadecimal message digest (hash value) of the string using an SHA cryptographic function.
+        const timestamp = Math.floor(Date.now() / 1000);
+        params.push(`timestamp=${timestamp}`);
+        params.sort();
+        const paramsString = params.join("&");
+        const signature = crypto.createHash('sha256').update(`${paramsString}${apiSecret}`).digest('hex');
+
+        return { signature, timestamp };
+    }
+
+    paramsToSignFormData(form: FormData) {
+        const params = [];
+        for (const [key, value] of form.entries()) {
+            if (key !== "file" && key !== "cloud_name" && key !== "resource_type" && key !== "api_key" && key !== "signature") {
+                params.push(`${key}=${value}`);
+            }
+        }
+        return params;
+    }
+
+    paramsToSignJson(json: Record<string, string>) {
+        const params = [];
+        for (const [key, value] of Object.entries(json)) {
+            if (key !== "file" && key !== "cloud_name" && key !== "resource_type" && key !== "api_key" && key !== "signature") {
+                params.push(`${key}=${value}`);
+            }
+        }
+        return params;
+    }
+
+    async preprocessJsonRequest(request: Request): Promise<any> {
+        const body = await request.json();
+
+        // Handle file:// URLs by converting to base64 data URIs
+        if (body.file && typeof body.file === 'string' && body.file.startsWith('file://')) {
+            body.file = await this.convertFileToDataUri(body.file);
+        }
+
+        return body;
+    }
+
+    async signJsonRequest(request: Request, apiKey: string, apiSecret: string, queryParams: string[] = [], preprocessedBody?: any) {
+        const body = preprocessedBody || await request.json();
+        if (body.signature) {
+            return request;
+        }
+
+        const bodyParams = this.paramsToSignJson(body);
+        const allParams = [...bodyParams, ...queryParams];
+        const { signature, timestamp } = await this.computeSignature(allParams, apiSecret);
+        body.signature = signature;
+        body.timestamp = timestamp;
+        body.api_key = apiKey;
+        return new Request(request, { body: JSON.stringify(body) });
+    }
+
+    private async convertFileToDataUri(fileUrl: string): Promise<string> {
+        // Remove 'file://' prefix to get the actual file path
+        const filePath = fileUrl.replace(/^file:\/\//, '');
+
+        try {
+            // Import required Node.js modules
+            const { readFile } = await import('node:fs/promises');
+
+            // Read the file as a buffer
+            const fileBuffer = await readFile(filePath);
+
+            // Convert to base64
+            const base64Data = fileBuffer.toString('base64');
+
+            // Use generic MIME type for all files
+            const mimeType = 'application/octet-stream';
+
+            // Return as data URI
+            return `data:${mimeType};base64,${base64Data}`;
+
+        } catch (error) {
+            // If file reading fails, log error and return original URL
+            console.error(`Failed to read file: ${filePath}`, error);
+            throw new Error(`Failed to read file: ${filePath}. ${error instanceof Error ? error.message : String(error)}`);
+        }
+    }
+
+    async signFormDataRequest(request: Request, apiKey: string, apiSecret: string, queryParams: string[] = []) {
+        const form = await request.clone().formData();
+        if (form.get("signature")) {
+            return request;
+        }
+
+        const bodyParams = this.paramsToSignFormData(form);
+        const allParams = [...bodyParams, ...queryParams];
+        const { signature, timestamp } = await this.computeSignature(allParams, apiSecret);
+
+        // add the signature, timestamp and apiKey to the URL as query parameters
+        const url = new URL(request.url);
+        url.searchParams.set("signature", signature);
+        url.searchParams.set("timestamp", timestamp.toString());
+        url.searchParams.set("api_key", apiKey);
+
+        // construct a new request with the same URL and the same form data and the same method
+        // remove the basic authentication header
+        const newHeaders = new Headers(request.headers);
+        newHeaders.delete("Authorization");
+        return new Request(url.toString(), request);
+    }
+
+    SIGNED_ACTIONS = [
+        'explicit', 'upload', 'download', 'destroy', 'sprite', 'tags', 'context', 'metadata_update', 'text', 'multi', 'explode',
+        'rename', 'create_slideshow', 'create_video', 'create_collage', 'generate_archive'];
+
+    SIGNED_PATHS = ["image", "video", "raw", "auto", "asset"].flatMap(resourceType => this.SIGNED_ACTIONS.map(action => `${resourceType}/${action}`));
+
+
+}