@brostark/solutions-client 1.0.0

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@brostark/solutions-client",
+  "version": "1.0.0",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "watch": "tsc --watch",
+    "prepublishOnly": "npm run build",
+    "publish": "npm publish",
+    "publish:patch": "npm version patch && npm publish",
+    "publish:minor": "npm version minor && npm publish",
+    "publish:major": "npm version major && npm publish"
+  },
+  "author": "Brostark Solutions",
+  "license": "ISC",
+  "description": "Brostark Solutions Client",
+  "keywords": ["brostark", "solutions", "client", "api"],
+  "devDependencies": {
+    "eslint": "^8.57.1",
+    "eslint-config-incredibilis": "^1.1.30",
+    "typescript": "~5.8.3"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "dependencies": {
+    "jwt-decode": "^4.0.0"
+  }
+}

package/src/api/v1/video.ts

@@ -0,0 +1,65 @@
+import { jwtDecode } from "jwt-decode";
+import { ListOptions } from "../../lib/types"
+import { httpListRequest, httpGetRequest, httpDeleteRequest, httpUploadRequest } from "../../lib/httpRequest"
+
+/**
+ * Generates an API to manage videos
+ * @param apiUrl - The base URL of the API
+ * @param apiKey - The API key for authentication
+ * @returns An object containing methods to interact with the video API
+ */
+export const generateVideoAPI = (apiUrl: string, apiKey: string) => {
+  const { accountId } = jwtDecode(apiKey) as { accountId: string };
+
+  return {
+    /**
+     * Lists videos with pagination
+     * @param options - Pagination options (limit and startAfter)
+     * @returns A promise with the list of videos
+     */
+    list: async (options: ListOptions = {}) => {
+      const response = await httpListRequest(`${apiUrl}/videos`, apiKey, options);
+      return response.data;
+    },
+
+    /**
+     * Uploads a new video
+     * @param file - The video file to upload
+     * @returns A promise with information about the uploaded video (URL and path)
+     */
+    upload: async (file: File) => {
+      const response = await httpUploadRequest(`${apiUrl}/upload/video`, apiKey, file);
+      return response.data;
+    },
+
+    /**
+     * Retrieves information about a specific video
+     * @param id - The video identifier
+     * @returns A promise with the video information
+     */
+    get: async (id: string) => {
+      const response = await httpGetRequest(`${apiUrl}/videos/${id}`, apiKey);
+      return response.data;
+    },
+
+    /**
+     * Retrieves the video URL
+     * @param id - The video identifier
+     * @returns A promise with the video URL
+     */
+    stream: async (filename: string): Promise<string> => {
+      const response = await httpGetRequest(`${apiUrl}/stream/${accountId}/${filename.split("/").pop()?.split(".")[0]}`, apiKey);
+      return response.data;
+    },
+
+    /**
+     * Deletes a video
+     * @param id - The identifier of the video to delete
+     * @returns A promise with deletion confirmation
+     */
+    remove: async (id: string) => {
+      const response = await httpDeleteRequest(`${apiUrl}/videos/${id}`, apiKey);
+      return response.data;
+    }
+  }
+}

package/src/client.ts

@@ -0,0 +1,31 @@
+import { generateVideoAPI } from "./api/v1/video";
+import { ApiVersion, DEFAULT_API_HOST, DEFAULT_API_VERSION } from "./constant";
+
+/**
+ * Options for creating the client
+ */
+export interface CreateClientOptions {
+  /** The API host (default: DEFAULT_API_HOST) */
+  host?: string;
+  /** The API version (default: DEFAULT_API_VERSION) */
+  version?: ApiVersion;
+}
+
+/**
+ * Creates an instance of the API client
+ * @param apiKey - The API key for authentication
+ * @param options - The configuration options for the client
+ * @returns An object containing the different APIs available
+ */
+export function createClient(apiKey: string, options: CreateClientOptions = {}) {
+  const {
+    host = DEFAULT_API_HOST,
+    version = DEFAULT_API_VERSION,
+  } = options;
+
+  const apiUrl = `${host}/${version}`;
+
+  return {
+    video: generateVideoAPI(apiUrl, apiKey),
+  }
+}

package/src/constant.ts

@@ -0,0 +1,21 @@
+/**
+ * Available API versions
+ */
+export enum ApiVersion {
+  V1 = "v1",
+}
+
+/**
+ * Default API host
+ */
+export const DEFAULT_API_HOST = "https://api-solutions.brostark.com";
+
+/**
+ * Default API version
+ */
+export const DEFAULT_API_VERSION = ApiVersion.V1;
+
+/**
+ * Maximum limit for list requests
+ */
+export const MAX_LIMIT = 100;

package/src/helper.ts

@@ -0,0 +1,10 @@
+/**
+ * Sets a limit between a minimum and maximum value
+ * @param limit - The desired limit
+ * @param min - The minimum allowed value
+ * @param max - The maximum allowed value
+ * @returns The adjusted limit
+ */
+export const setLimit = (limit: number, min: number, max: number) => {
+  return Math.min(Math.max(limit, min), max);
+}

package/src/index.ts

@@ -0,0 +1,6 @@
+import { createClient, CreateClientOptions } from "./client";
+
+export {
+  createClient,
+  type CreateClientOptions
+};

package/src/lib/httpRequest.ts

@@ -0,0 +1,124 @@
+import { ListOptions } from "./types";
+import { setLimit } from "../helper";
+import { MAX_LIMIT } from "../constant";
+
+type RequestOptions = Omit<RequestInit, "body"> & {
+  params?: Record<string, unknown>;
+  data?: unknown;
+};
+
+/**
+ * Base function to make an HTTP request
+ * @param apiUrl - The API URL
+ * @param apiKey - The API key for authentication
+ * @param options - The request configuration options
+ * @returns A promise with the request response
+ */
+export const httpRequest = async (apiUrl: string, apiKey: string, options: RequestOptions) => {
+  const { headers, params, data, ...rest } = options;
+
+  const url = new URL(apiUrl);
+  if (params) {
+    for (const [key, value] of Object.entries(params)) {
+      if (value !== undefined && value !== null) {
+        url.searchParams.set(key, String(value));
+      }
+    }
+  }
+
+  const config: RequestInit = {
+    mode: "no-cors",
+    method: "GET",
+    ...rest,
+  };
+
+  const finalHeaders: Record<string, string> = {
+    "x-api-key": apiKey,
+    ...(headers as Record<string, string>),
+  };
+
+  if (data) {
+    if (data instanceof File) {
+      config.body = data;
+      if (!headers || !(headers as Record<string, string>)["Content-Type"]) {
+        finalHeaders["Content-Type"] = data.type;
+      }
+    } else {
+      config.body = JSON.stringify(data);
+      finalHeaders["Content-Type"] = "application/json";
+    }
+  }
+
+  config.headers = finalHeaders;
+
+  const response = await fetch(url.toString(), config);
+
+  if (!response.ok) {
+    const errorData = await response.json().catch(() => ({ message: response.statusText }));
+    throw new Error(errorData.message || "HTTP request failed");
+  }
+
+  const responseText = await response.text();
+  try {
+    return JSON.parse(responseText);
+  } catch (e) {
+    return responseText;
+  }
+}
+
+/**
+ * Makes an HTTP request to list resources with pagination
+ * @param apiUrl - The API URL
+ * @param apiKey - The API key for authentication
+ * @param options - The pagination options (limit and startAfter)
+ * @returns A promise with the list of resources
+ */
+export const httpListRequest = (apiUrl: string, apiKey: string, options: ListOptions) => {
+  return httpRequest(apiUrl, apiKey, {
+    params: {
+      limit: setLimit(options.limit ?? 10, 1, MAX_LIMIT),
+      startAfter: options.startAfter,
+    },
+  });
+}
+
+/**
+ * Makes an HTTP GET request
+ * @param apiUrl - The API URL
+ * @param apiKey - The API key for authentication
+ * @returns A promise with the resource data
+ */
+export const httpGetRequest = (apiUrl: string, apiKey: string) => {
+  return httpRequest(apiUrl, apiKey, {
+    method: "GET",
+  });
+}
+
+/**
+ * Makes an HTTP DELETE request
+ * @param apiUrl - The API URL
+ * @param apiKey - The API key for authentication
+ * @returns A promise with the deletion confirmation
+ */
+export const httpDeleteRequest = (apiUrl: string, apiKey: string) => {
+  return httpRequest(apiUrl, apiKey, {
+    method: "DELETE",
+  });
+}
+
+/**
+ * Makes an HTTP request to upload a file
+ * @param apiUrl - The API URL
+ * @param apiKey - The API key for authentication
+ * @param file - The file to upload
+ * @returns A promise with information about the uploaded file
+ */
+export const httpUploadRequest = (apiUrl: string, apiKey: string, file: File) => {
+  return httpRequest(apiUrl, apiKey, {
+    method: "POST",
+    data: file,
+    headers: {
+      "Content-Type": file.type,
+    },
+  });
+}

package/src/lib/types.ts

@@ -0,0 +1,4 @@
+export interface ListOptions {
+  limit?: number;
+  startAfter?: string;
+}

package/tsconfig.json

@@ -0,0 +1,23 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "module": "CommonJS",
+    "allowJs": true,
+    "skipLibCheck": true,
+    "outDir": "dist",
+    "declaration": true,
+    "declarationMap": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "strict": true,
+    "strictPropertyInitialization": false,
+    "downlevelIteration": true,
+    "forceConsistentCasingInFileNames": true,
+    "noFallthroughCasesInSwitch": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true
+  },
+  "include": [
+    "src"
+  ]
+}