@jay-framework/wix-utils 0.15.0

package/dist/index.d.ts

@@ -0,0 +1,71 @@
+/**
+ * Wix Media URL Utilities
+ *
+ * Helpers for working with Wix media URLs and the wix:// protocol formats.
+ *
+ * Supported formats:
+ * - wix:image://v1/<id>/<name>#originWidth=<w>&originHeight=<h>
+ * - wix:video://v1/<id>/<name>#posterUri=<uri>&posterWidth=<w>&posterHeight=<h>
+ * - wix:document://v1/<id>/<name>
+ * - wix:audio://v1/<id>/<name>
+ */
+type WixMediaType = 'image' | 'video' | 'document' | 'audio' | 'unknown';
+/**
+ * Parsed Wix media URL with extracted metadata
+ */
+interface ParsedWixMediaUrl {
+    type: WixMediaType;
+    mediaId: string;
+    fileName: string;
+    /** Original image dimensions (for images) */
+    originWidth?: number;
+    originHeight?: number;
+    /** Poster image info (for videos) */
+    posterUri?: string;
+    posterWidth?: number;
+    posterHeight?: number;
+}
+/**
+ * Parse any wix:// protocol URL and extract metadata
+ */
+declare function parseWixMediaUrl(url: string): ParsedWixMediaUrl | null;
+/**
+ * Parse wix:image:// protocol URLs and extract the media ID
+ * @deprecated Use parseWixMediaUrl for full metadata extraction
+ */
+declare function parseWixImageUrl(url: string): string | null;
+/**
+ * Parse wix:video:// protocol URLs and extract the media ID
+ * @deprecated Use parseWixMediaUrl for full metadata extraction
+ */
+declare function parseWixVideoUrl(url: string): string | null;
+/**
+ * Format Wix media URL to a usable static URL.
+ * Handles all wix:// protocol URLs (image, video, document, audio).
+ *
+ * @param _id - The media ID (used as fallback if url is not usable)
+ * @param url - The original URL (may be http(s):// or wix://)
+ * @param resize - Optional resize parameters (for images/video thumbnails)
+ * @returns A usable https:// URL
+ */
+declare function formatWixMediaUrl(_id: string, url: string, resize?: {
+    w: number;
+    h: number;
+}): string;
+/**
+ * Get the video poster URL from a wix:video:// URL
+ */
+declare function getVideoPosterUrl(url: string, resize?: {
+    w: number;
+    h: number;
+}): string;
+/**
+ * Get document download URL from a wix:document:// URL
+ */
+declare function getDocumentUrl(url: string): string;
+/**
+ * Get audio URL from a wix:audio:// URL
+ */
+declare function getAudioUrl(url: string): string;
+
+export { type ParsedWixMediaUrl, type WixMediaType, formatWixMediaUrl, getAudioUrl, getDocumentUrl, getVideoPosterUrl, parseWixImageUrl, parseWixMediaUrl, parseWixVideoUrl };

package/dist/index.js

@@ -0,0 +1,79 @@
+function parseWixMediaUrl(url) {
+  if (!url) return null;
+  const match = url.match(
+    /^wix:(image|video|document|audio):\/\/v1\/([^/]+)\/([^#]+)(?:#(.*))?$/
+  );
+  if (!match) return null;
+  const [, type, mediaId, fileName, hashParams] = match;
+  const result = {
+    type,
+    mediaId,
+    fileName: decodeURIComponent(fileName)
+  };
+  if (hashParams) {
+    const params = new URLSearchParams(hashParams);
+    const originWidth = params.get("originWidth");
+    const originHeight = params.get("originHeight");
+    if (originWidth) result.originWidth = parseInt(originWidth, 10);
+    if (originHeight) result.originHeight = parseInt(originHeight, 10);
+    const posterUri = params.get("posterUri");
+    const posterWidth = params.get("posterWidth");
+    const posterHeight = params.get("posterHeight");
+    if (posterUri) result.posterUri = decodeURIComponent(posterUri);
+    if (posterWidth) result.posterWidth = parseInt(posterWidth, 10);
+    if (posterHeight) result.posterHeight = parseInt(posterHeight, 10);
+  }
+  return result;
+}
+function parseWixImageUrl(url) {
+  const parsed = parseWixMediaUrl(url);
+  return (parsed == null ? void 0 : parsed.type) === "image" ? parsed.mediaId : null;
+}
+function parseWixVideoUrl(url) {
+  const parsed = parseWixMediaUrl(url);
+  return (parsed == null ? void 0 : parsed.type) === "video" ? parsed.mediaId : null;
+}
+function formatWixMediaUrl(_id, url, resize) {
+  const resizeFragment = resize ? `/v1/fit/w_${resize.w},h_${resize.h},q_90/file.jpg` : "";
+  if (url == null ? void 0 : url.startsWith("wix:")) {
+    const parsed = parseWixMediaUrl(url);
+    if (parsed) {
+      return `https://static.wixstatic.com/media/${parsed.mediaId}${resizeFragment}`;
+    }
+  }
+  if ((url == null ? void 0 : url.startsWith("http://")) || (url == null ? void 0 : url.startsWith("https://"))) {
+    return url;
+  }
+  if (_id) {
+    return `https://static.wixstatic.com/media/${_id}${resizeFragment}`;
+  }
+  return "";
+}
+function getVideoPosterUrl(url, resize) {
+  const parsed = parseWixMediaUrl(url);
+  if (!parsed || parsed.type !== "video") return "";
+  if (parsed.posterUri) {
+    return formatWixMediaUrl("", parsed.posterUri, resize);
+  }
+  const resizeFragment = resize ? `/v1/fit/w_${resize.w},h_${resize.h},q_90/file.jpg` : "";
+  return `https://static.wixstatic.com/media/${parsed.mediaId}${resizeFragment}`;
+}
+function getDocumentUrl(url) {
+  const parsed = parseWixMediaUrl(url);
+  if (!parsed || parsed.type !== "document") return "";
+  return `https://static.wixstatic.com/ugd/${parsed.mediaId}`;
+}
+function getAudioUrl(url) {
+  const parsed = parseWixMediaUrl(url);
+  if (!parsed || parsed.type !== "audio") return "";
+  return `https://static.wixstatic.com/mp3/${parsed.mediaId}`;
+}
+export {
+  formatWixMediaUrl,
+  getAudioUrl,
+  getDocumentUrl,
+  getVideoPosterUrl,
+  parseWixImageUrl,
+  parseWixMediaUrl,
+  parseWixVideoUrl
+};

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@jay-framework/wix-utils",
+  "version": "0.15.0",
+  "type": "module",
+  "description": "Shared utilities for Wix integrations in Jay Framework",
+  "license": "Apache-2.0",
+  "main": "dist/index.js",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "scripts": {
+    "build": "npm run clean && npm run build:lib && npm run build:types",
+    "build:lib": "vite build",
+    "build:types": "tsup lib/index.ts --dts-only --format esm",
+    "build:check-types": "tsc",
+    "clean": "rimraf dist",
+    "test": ":"
+  },
+  "devDependencies": {
+    "rimraf": "^5.0.5",
+    "tsup": "^8.5.1",
+    "typescript": "^5.3.3",
+    "vite": "^5.0.11"
+  }
+}