@localess/client 3.0.1-dev.20260411012947 → 3.0.1-dev.20260413071348

package/dist/index.mjs

@@ -1,259 +1,154 @@
-// src/utils.ts
-var RESET = "\x1B[0m";
-var FG_BLUE = "\x1B[34m";
-var isBrowser = () => typeof window !== "undefined";
-var isServer = () => typeof window === "undefined";
-var isIframe = () => isBrowser() && window.self !== window.top;
-
-// src/cache.ts
-var NoCache = class {
-  set(key, value) {
-  }
-  get(key) {
-    return void 0;
-  }
-  has(key) {
-    return false;
-  }
-};
-var TTLCache = class {
-  /**
-   * Creates a TTLCache with a specified time-to-live (TTL) for each entry.
-   * default is 5 minutes (300000 ms).
-   * @param ttlMs
-   */
-  constructor(ttlMs = 3e5) {
-    this.ttlMs = ttlMs;
-  }
-  ttlMs;
-  cache = /* @__PURE__ */ new Map();
-  set(key, value) {
-    this.cache.set(key, { value, expiresAt: Date.now() + this.ttlMs });
-  }
-  get(key) {
-    const entry = this.cache.get(key);
-    if (!entry) return void 0;
-    if (Date.now() > entry.expiresAt) {
-      this.cache.delete(key);
-      return void 0;
-    }
-    return entry.value;
-  }
-  has(key) {
-    return this.get(key) !== void 0;
-  }
-};
-
-// src/client.ts
-var LOG_GROUP = `${FG_BLUE}[Localess:Client]${RESET}`;
-function localessClient(options) {
-  if (options.debug) {
-    console.log(LOG_GROUP, "Client Options : ", options);
-  }
-  const normalizedOrigin = options.origin.replace(/\/+$/, "");
-  const fetchOptions = {
-    redirect: "follow",
-    headers: {
-      "Content-Type": "application/json",
-      "Accept": "application/json",
-      "X-Localess-Agent": "Localess-JS-Client",
-      "X-Localess-Agent-Version": "0.9.0"
-    }
-  };
-  const cache = options.cacheTTL === false ? new NoCache() : new TTLCache(options.cacheTTL);
-  return {
-    async getLinks(params) {
-      if (options.debug) {
-        console.log(LOG_GROUP, "getLinks() params : ", JSON.stringify(params));
-      }
-      let kind = "";
-      if (params?.kind) {
-        kind = `&kind=${params.kind}`;
-      }
-      let parentSlug = "";
-      if (params?.parentSlug) {
-        parentSlug = `&parentSlug=${params.parentSlug}`;
-      }
-      let excludeChildren = "";
-      if (params?.excludeChildren) {
-        excludeChildren = `&excludeChildren=${params.excludeChildren}`;
-      }
-      let url = `${normalizedOrigin}/api/v1/spaces/${options.spaceId}/links?token=${options.token}${kind}${parentSlug}${excludeChildren}`;
-      if (options.debug) {
-        console.log(LOG_GROUP, "getLinks fetch url : ", url);
-      }
-      if (cache.has(url)) {
-        if (options.debug) {
-          console.log(LOG_GROUP, "getLinks cache hit");
-        }
-        return cache.get(url);
-      }
-      try {
-        const response = await fetch(url, fetchOptions);
-        if (options.debug) {
-          console.log(LOG_GROUP, "getLinks status : ", response.status);
-        }
-        const data = await response.json();
-        cache.set(url, data);
-        return data;
-      } catch (error) {
-        console.error(LOG_GROUP, "getLinks error : ", error);
-        return {};
-      }
-    },
-    async getContentBySlug(slug, params) {
-      if (options.debug) {
-        console.log(LOG_GROUP, "getContentBySlug() slug : ", slug);
-        console.log(LOG_GROUP, "getContentBySlug() params : ", JSON.stringify(params));
-      }
-      let version = "";
-      if (options?.version && options.version == "draft") {
-        version = `&version=${options.version}`;
-      }
-      if (params?.version && params.version == "draft") {
-        version = `&version=${params.version}`;
-      }
-      const locale = params?.locale ? `&locale=${params.locale}` : "";
-      const resolveReference = params?.resolveReference ? `&resolveReference=${params.resolveReference}` : "";
-      const resolveLink = params?.resolveLink ? `&resolveLink=${params.resolveLink}` : "";
-      let url = `${normalizedOrigin}/api/v1/spaces/${options.spaceId}/contents/slugs/${slug}?token=${options.token}${version}${locale}${resolveReference}${resolveLink}`;
-      if (options.debug) {
-        console.log(LOG_GROUP, "getContentBySlug fetch url : ", url);
-      }
-      if (cache.has(url)) {
-        if (options.debug) {
-          console.log(LOG_GROUP, "getContentBySlug cache hit");
-        }
-        return cache.get(url);
-      }
-      try {
-        const response = await fetch(url, fetchOptions);
-        if (options.debug) {
-          console.log(LOG_GROUP, "getContentBySlug status : ", response.status);
-        }
-        const data = await response.json();
-        cache.set(url, data);
-        return data;
-      } catch (error) {
-        console.error(LOG_GROUP, "getContentBySlug error : ", error);
-        return {};
-      }
-    },
-    async getContentById(id, params) {
-      if (options.debug) {
-        console.log(LOG_GROUP, "getContentById() id : ", id);
-        console.log(LOG_GROUP, "getContentById() params : ", JSON.stringify(params));
-      }
-      let version = "";
-      if (options?.version && options.version == "draft") {
-        version = `&version=${options.version}`;
-      }
-      if (params?.version && params.version == "draft") {
-        version = `&version=${params.version}`;
-      }
-      const locale = params?.locale ? `&locale=${params.locale}` : "";
-      const resolveReference = params?.resolveReference ? `&resolveReference=${params.resolveReference}` : "";
-      const resolveLink = params?.resolveLink ? `&resolveLink=${params.resolveLink}` : "";
-      let url = `${normalizedOrigin}/api/v1/spaces/${options.spaceId}/contents/${id}?token=${options.token}${version}${locale}${resolveReference}${resolveLink}`;
-      if (options.debug) {
-        console.log(LOG_GROUP, "getContentById fetch url : ", url);
-      }
-      if (cache.has(url)) {
-        if (options.debug) {
-          console.log(LOG_GROUP, "getContentById cache hit");
-        }
-        return cache.get(url);
-      }
-      try {
-        const response = await fetch(url, fetchOptions);
-        if (options.debug) {
-          console.log(LOG_GROUP, "getContentById status : ", response.status);
-        }
-        const data = await response.json();
-        cache.set(url, data);
-        return data;
-      } catch (error) {
-        console.error(LOG_GROUP, "getContentById error : ", error);
-        return {};
-      }
-    },
-    async getTranslations(locale) {
-      if (options.debug) {
-        console.log(LOG_GROUP, "getTranslations() locale : ", locale);
-      }
-      let url = `${normalizedOrigin}/api/v1/spaces/${options.spaceId}/translations/${locale}?token=${options.token}`;
-      if (options.debug) {
-        console.log(LOG_GROUP, "getTranslations fetch url : ", url);
-      }
-      if (cache.has(url)) {
-        if (options.debug) {
-          console.log(LOG_GROUP, "getTranslations cache hit");
-        }
-        return cache.get(url);
-      }
-      try {
-        const response = await fetch(url, fetchOptions);
-        if (options.debug) {
-          console.log(LOG_GROUP, "getTranslations status : ", response.status);
-        }
-        const data = await response.json();
-        cache.set(url, data);
-        return data;
-      } catch (error) {
-        console.error(LOG_GROUP, "getTranslations error : ", error);
-        return {};
-      }
-    },
-    syncScriptUrl() {
-      return `${normalizedOrigin}/scripts/sync-v1.js`;
-    },
-    assetLink(asset) {
-      if (typeof asset === "string") {
-        return `${normalizedOrigin}/api/v1/spaces/${options.spaceId}/assets/${asset}`;
-      } else {
-        return `${normalizedOrigin}/api/v1/spaces/${options.spaceId}/assets/${asset.uri}`;
-      }
-    }
-  };
+//#region src/utils.ts
+var e = "\x1B[0m", t = "\x1B[34m", n = () => typeof window < "u", r = () => typeof window > "u", i = () => n() && window.self !== window.top, a = class {
+	set(e, t) {}
+	get(e) {}
+	has(e) {
+		return !1;
+	}
+}, o = class {
+	cache = /* @__PURE__ */ new Map();
+	constructor(e = 3e5) {
+		this.ttlMs = e;
+	}
+	set(e, t) {
+		this.cache.set(e, {
+			value: t,
+			expiresAt: Date.now() + this.ttlMs
+		});
+	}
+	get(e) {
+		let t = this.cache.get(e);
+		if (t) {
+			if (Date.now() > t.expiresAt) {
+				this.cache.delete(e);
+				return;
+			}
+			return t.value;
+		}
+	}
+	has(e) {
+		return this.get(e) !== void 0;
+	}
+}, s = `${t}[Localess:Client]${e}`;
+function c(e) {
+	e.debug && console.log(s, "Client Options : ", e);
+	let t = e.origin.replace(/\/+$/, ""), n = {
+		redirect: "follow",
+		headers: {
+			"Content-Type": "application/json",
+			Accept: "application/json",
+			"X-Localess-Agent": "Localess-JS-Client",
+			"X-Localess-Agent-Version": "0.9.0"
+		}
+	}, r = e.cacheTTL === !1 ? new a() : new o(e.cacheTTL);
+	return {
+		async getLinks(i) {
+			e.debug && console.log(s, "getLinks() params : ", JSON.stringify(i));
+			let a = "";
+			i?.kind && (a = `&kind=${i.kind}`);
+			let o = "";
+			i?.parentSlug && (o = `&parentSlug=${i.parentSlug}`);
+			let c = "";
+			i?.excludeChildren && (c = `&excludeChildren=${i.excludeChildren}`);
+			let l = `${t}/api/v1/spaces/${e.spaceId}/links?token=${e.token}${a}${o}${c}`;
+			if (e.debug && console.log(s, "getLinks fetch url : ", l), r.has(l)) return e.debug && console.log(s, "getLinks cache hit"), r.get(l);
+			try {
+				let t = await fetch(l, n);
+				e.debug && console.log(s, "getLinks status : ", t.status);
+				let i = await t.json();
+				return r.set(l, i), i;
+			} catch (e) {
+				return console.error(s, "getLinks error : ", e), {};
+			}
+		},
+		async getContentBySlug(i, a) {
+			e.debug && (console.log(s, "getContentBySlug() slug : ", i), console.log(s, "getContentBySlug() params : ", JSON.stringify(a)));
+			let o = "";
+			e?.version && e.version == "draft" && (o = `&version=${e.version}`), a?.version && a.version == "draft" && (o = `&version=${a.version}`);
+			let c = a?.locale ? `&locale=${a.locale}` : "", l = a?.resolveReference ? `&resolveReference=${a.resolveReference}` : "", u = a?.resolveLink ? `&resolveLink=${a.resolveLink}` : "", d = `${t}/api/v1/spaces/${e.spaceId}/contents/slugs/${i}?token=${e.token}${o}${c}${l}${u}`;
+			if (e.debug && console.log(s, "getContentBySlug fetch url : ", d), r.has(d)) return e.debug && console.log(s, "getContentBySlug cache hit"), r.get(d);
+			try {
+				let t = await fetch(d, n);
+				e.debug && console.log(s, "getContentBySlug status : ", t.status);
+				let i = await t.json();
+				return r.set(d, i), i;
+			} catch (e) {
+				return console.error(s, "getContentBySlug error : ", e), {};
+			}
+		},
+		async getContentById(i, a) {
+			e.debug && (console.log(s, "getContentById() id : ", i), console.log(s, "getContentById() params : ", JSON.stringify(a)));
+			let o = "";
+			e?.version && e.version == "draft" && (o = `&version=${e.version}`), a?.version && a.version == "draft" && (o = `&version=${a.version}`);
+			let c = a?.locale ? `&locale=${a.locale}` : "", l = a?.resolveReference ? `&resolveReference=${a.resolveReference}` : "", u = a?.resolveLink ? `&resolveLink=${a.resolveLink}` : "", d = `${t}/api/v1/spaces/${e.spaceId}/contents/${i}?token=${e.token}${o}${c}${l}${u}`;
+			if (e.debug && console.log(s, "getContentById fetch url : ", d), r.has(d)) return e.debug && console.log(s, "getContentById cache hit"), r.get(d);
+			try {
+				let t = await fetch(d, n);
+				e.debug && console.log(s, "getContentById status : ", t.status);
+				let i = await t.json();
+				return r.set(d, i), i;
+			} catch (e) {
+				return console.error(s, "getContentById error : ", e), {};
+			}
+		},
+		async getTranslations(i) {
+			e.debug && console.log(s, "getTranslations() locale : ", i);
+			let a = `${t}/api/v1/spaces/${e.spaceId}/translations/${i}?token=${e.token}`;
+			if (e.debug && console.log(s, "getTranslations fetch url : ", a), r.has(a)) return e.debug && console.log(s, "getTranslations cache hit"), r.get(a);
+			try {
+				let t = await fetch(a, n);
+				e.debug && console.log(s, "getTranslations status : ", t.status);
+				let i = await t.json();
+				return r.set(a, i), i;
+			} catch (e) {
+				return console.error(s, "getTranslations error : ", e), {};
+			}
+		},
+		syncScriptUrl() {
+			return `${t}/scripts/sync-v1.js`;
+		},
+		assetLink(n) {
+			return typeof n == "string" ? `${t}/api/v1/spaces/${e.spaceId}/assets/${n}` : `${t}/api/v1/spaces/${e.spaceId}/assets/${n.uri}`;
+		}
+	};
 }
-
-// src/editable.ts
-function localessEditable(content) {
-  return {
-    "data-ll-id": content._id,
-    "data-ll-schema": content._schema
-  };
+//#endregion
+//#region src/editable.ts
+function l(e) {
+	return {
+		"data-ll-id": e._id,
+		"data-ll-schema": e._schema
+	};
 }
-function localessEditableField(fieldName) {
-  return {
-    "data-ll-field": fieldName
-  };
+function u(e) {
+	return { "data-ll-field": e };
 }
-
-// src/sync.ts
-var JS_SYNC_ID = "localess-js-sync";
-function loadLocalessSync(origin, force = false) {
-  if (isServer()) return;
-  if (!isIframe()) return;
-  const isSyncLoaded = typeof window.localess !== "undefined";
-  if (isSyncLoaded) return;
-  const scriptEl = document.getElementById(JS_SYNC_ID);
-  if (scriptEl) return;
-  const script = document.createElement("script");
-  script.id = JS_SYNC_ID;
-  script.type = "text/javascript";
-  script.src = `${origin}/scripts/sync-v1.js`;
-  script.async = true;
-  script.onerror = (error) => console.error(error);
-  script.onload = (event) => console.info("Localess Sync Script loaded");
-  document.head.appendChild(script);
+//#endregion
+//#region src/sync.ts
+var d = "localess-js-sync";
+async function f(e, t = !1) {
+	return new Promise((t, n) => {
+		if (r()) {
+			n(void 0);
+			return;
+		}
+		if (!i()) {
+			console.warn("Localess Sync is loaded only in Visual Editor."), n(void 0);
+			return;
+		}
+		if (window.localess !== void 0) {
+			n(void 0);
+			return;
+		}
+		if (document.getElementById(d)) {
+			n(void 0);
+			return;
+		}
+		let a = document.createElement("script");
+		a.id = d, a.type = "text/javascript", a.src = `${e}/scripts/sync-v1.js`, a.async = !0, a.onerror = (e) => n(e), a.onload = (e) => {
+			console.info("Localess Sync Script loaded"), t();
+		}, document.head.appendChild(a);
+	});
 }
-export {
-  isBrowser,
-  isIframe,
-  isServer,
-  loadLocalessSync,
-  localessClient,
-  localessEditable,
-  localessEditableField
-};
+//#endregion
+export { n as isBrowser, i as isIframe, r as isServer, f as loadLocalessSync, c as localessClient, l as localessEditable, u as localessEditableField };

package/dist/models/content-asset.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Content Asset defines reference to an Asset.
+ */
+export interface ContentAsset {
+    /**
+     * Define the type of Asset
+     */
+    kind: 'ASSET';
+    /**
+     * Unique identifier for the asset.
+     */
+    uri: string;
+}

package/dist/models/content-data.d.ts

@@ -0,0 +1,27 @@
+import { ContentAsset } from './content-asset';
+import { ContentLink } from './content-link';
+import { ContentRichText } from './content-rich-text';
+import { ContentReference } from './content-reference';
+export type ContentDataField = any | string | string[] | number | boolean | ContentLink | ContentRichText | ContentData | ContentData[] | ContentAsset | ContentAsset[] | ContentReference | ContentReference[];
+/**
+ * Content Data Schema related information.
+ */
+export interface ContentDataSchema {
+    /**
+     * Unique identifier of a component in a content.
+     */
+    _id: string;
+    /**
+     * Unique identifier for the Schema object.
+     */
+    _schema: string;
+}
+/**
+ * ContentData defined Object to connect all possible root Schemas.
+ */
+export interface ContentData extends ContentDataSchema {
+    /**
+     * Other Schema-specific fields
+     */
+    [field: string]: ContentDataField | undefined;
+}

package/dist/models/content-link.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Content Link define reference to a Link.
+ */
+export interface ContentLink {
+    /**
+     * Define the type of Link
+     */
+    kind: 'LINK';
+    /**
+     * Define the target of the link. _blank for the new tab and _self for the same tab.
+     */
+    target: '_blank' | '_self';
+    /**
+     * Define the type of Link. URL for external links and Content for internal links.
+     */
+    type: 'url' | 'content';
+    /**
+     * If the type is content, then it will be Content ID. Otherwise, it will be URL.
+     */
+    uri: string;
+}

package/dist/models/content-metadata.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Content Metadata defines short information about a Content for navigation reason.
+ */
+export interface ContentMetadata {
+    /**
+     * Date and Time at which the Content was created.
+     */
+    createdAt: string;
+    /**
+     * Combination of SLUG and Parent SLUG of the Content
+     */
+    fullSlug: string;
+    /**
+     * Unique identifier for the object.
+     */
+    id: string;
+    /**
+     * Define the type of Content, whether it is a FOLDER or DOCUMENT.
+     */
+    kind: 'FOLDER' | 'DOCUMENT';
+    /**
+     * Name of the Content
+     */
+    name: string;
+    /**
+     * Parent SLUG of the Content
+     */
+    parentSlug: string;
+    /**
+     * Date and Time at which the Content was published.
+     */
+    publishedAt?: string;
+    /**
+     * SLUG of the Content
+     */
+    slug: string;
+    /**
+     * Date and Time at which the Content was updated.
+     */
+    updatedAt: string;
+}

package/dist/models/content-reference.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Content Reference defines reference to a Content.
+ */
+export interface ContentReference {
+    /**
+     * Define the type of REFERENCE
+     */
+    kind: 'REFERENCE';
+    /**
+     * Unique identifier for the Content Document.
+     */
+    uri: string;
+}

package/dist/models/content-rich-text.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Content RichText define content as JSON Object.
+ */
+export interface ContentRichText {
+    /**
+     * Define the type of Content Node
+     */
+    type?: string;
+    /**
+     * List of Content Nodes
+     */
+    content?: ContentRichText[];
+}

package/dist/models/content.d.ts

@@ -0,0 +1,21 @@
+import { ContentData } from './content-data';
+import { ContentMetadata } from './content-metadata';
+import { Links } from './links';
+import { References } from './references';
+/**
+ * Content defines a shared object for all possible Content Types.
+ */
+export interface Content<T extends ContentData = ContentData> extends ContentMetadata {
+    /**
+     * Content Data
+     */
+    data?: T;
+    /**
+     * All links used in the content.
+     */
+    links?: Links;
+    /**
+     * All references used in the content.
+     */
+    references?: References;
+}

package/dist/models/index.d.ts

@@ -0,0 +1,11 @@
+export * from './content';
+export * from './content-asset';
+export * from './content-data';
+export * from './content-link';
+export * from './content-metadata';
+export * from './content-reference';
+export * from './content-rich-text';
+export * from './links';
+export * from './locale';
+export * from './references';
+export * from './translations';

package/dist/models/links.d.ts

@@ -0,0 +1,7 @@
+import { ContentMetadata } from './content-metadata';
+/**
+ * Key-Value Object. Where Key is a Unique identifier for the Content object and Value is Content Metadata.
+ */
+export interface Links {
+    [key: string]: ContentMetadata;
+}

package/dist/models/locale.d.ts

@@ -0,0 +1,10 @@
+export interface Locale {
+    /**
+     * Unique identifier for the Locale.
+     */
+    id: string;
+    /**
+     * Name of the Locale.
+     */
+    name: string;
+}

package/dist/models/references.d.ts

@@ -0,0 +1,7 @@
+import { Content } from './content';
+/**
+ * Key-Value Object. Where Key is a Unique identifier for the Content object and Value is Content.
+ */
+export interface References {
+    [key: string]: Content;
+}

package/dist/models/translations.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Key-Value Object. Where Key is Translation ID and Value is Translated Content
+ */
+export interface Translations {
+    [key: string]: string;
+}

package/dist/sync.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Inject Localess Sync Script in Header
+ * @param {string} origin A fully qualified domain name with protocol (http/https) and port.
+ * @param {boolean} force Force Script Injection even if the application is not in Visual Editor.
+ */
+export declare function loadLocalessSync(origin: string, force?: boolean): Promise<void>;