@localess/js-client 0.3.2-next.20250108-112722.0 → 0.3.2-next.20250109-154209.0

package/dist/index.js

@@ -1,5 +1,215 @@
-export * from './models';
-export * from './client';
-export * from './editable';
-export * from './sync';
-//# sourceMappingURL=index.js.map
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  llEditable: () => llEditable,
+  loadLocalessSync: () => loadLocalessSync,
+  localessClient: () => localessClient
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/utils.ts
+var RESET = "\x1B[0m";
+var FG_BLUE = "\x1B[34m";
+
+// 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 fetchOptions = {
+    redirect: "follow",
+    headers: {
+      "Content-Type": "application/json",
+      "Accept": "application/json",
+      "X-Localess-Agent": "Localess-JS-Client",
+      "X-Localess-Agent-Version": "0.3.0"
+    }
+  };
+  return {
+    /**
+     * Get all links
+     * @param params{LinksFetchParams} - Fetch parameters
+     * @returns {Promise<Links>}
+     */
+    async getLinks(params) {
+      if (options.debug) {
+        console.log(LOG_GROUP, "getLinks() params : " + 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 = `${options.origin}/api/v1/spaces/${options.spaceId}/links?token=${options.token}${kind}${parentSlug}${excludeChildren}`;
+      if (options.debug) {
+        console.log(LOG_GROUP, "getLinks fetch url : ", url);
+      }
+      try {
+        const response = await fetch(url, fetchOptions);
+        if (options.debug) {
+          console.log(LOG_GROUP, "getLinks status : ", response.status);
+        }
+        const data = await response.json();
+        return data;
+      } catch (error) {
+        console.error(LOG_GROUP, "getLinks error : ", error);
+        return {};
+      }
+    },
+    /**
+     * Get content by SLUG
+     * @param slug{string} - Content SLUG
+     * @param params{ContentFetchParams} - Fetch parameters
+     * @returns {Promise<Content>}
+     */
+    async getContentBySlug(slug, params) {
+      if (options.debug) {
+        console.log(LOG_GROUP, "getContentBySlug() slug : ", slug);
+        console.log(LOG_GROUP, "getContentBySlug() params : ", 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}` : "";
+      let url = `${options.origin}/api/v1/spaces/${options.spaceId}/contents/slugs/${slug}?token=${options.token}${version}${locale}`;
+      if (options.debug) {
+        console.log(LOG_GROUP, "getContentBySlug fetch url : ", url);
+      }
+      try {
+        const response = await fetch(url, fetchOptions);
+        if (options.debug) {
+          console.log(LOG_GROUP, "getContentBySlug status : ", response.status);
+        }
+        const data = await response.json();
+        return data;
+      } catch (error) {
+        console.error(LOG_GROUP, "getContentBySlug error : ", error);
+        return {};
+      }
+    },
+    /**
+     * Get content by ID
+     * @param id{string} - Content ID
+     * @param params{ContentFetchParams} - Fetch parameters
+     * @returns {Promise<Content>}
+     */
+    async getContentById(id, params) {
+      if (options.debug) {
+        console.log(LOG_GROUP, "getContentById() id : ", id);
+        console.log(LOG_GROUP, "getContentById() params : ", 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}` : "";
+      let url = `${options.origin}/api/v1/spaces/${options.spaceId}/contents/${id}?token=${options.token}${version}${locale}`;
+      if (options.debug) {
+        console.log(LOG_GROUP, "getContentById fetch url : ", url);
+      }
+      const response = await fetch(url, fetchOptions);
+      if (options.debug) {
+        console.log(LOG_GROUP, "getContentById status : ", response.status);
+      }
+      const data = await response.json();
+      return data;
+    },
+    /**
+     * Get translations for the given locale
+     * @param locale{string} - Locale identifier (ISO 639-1)
+     */
+    async getTranslations(locale) {
+      if (options.debug) {
+        console.log(LOG_GROUP, "getTranslations() locale : ", locale);
+      }
+      let url = `${options.origin}/api/v1/spaces/${options.spaceId}/translations/${locale}`;
+      if (options.debug) {
+        console.log(LOG_GROUP, "getTranslations fetch url : ", url);
+      }
+      const response = await fetch(url, fetchOptions);
+      if (options.debug) {
+        console.log(LOG_GROUP, "getTranslations status : ", response.status);
+      }
+      const data = await response.json();
+      return data;
+    },
+    syncScriptUrl() {
+      return `${options.origin}/scripts/sync-v1.js`;
+    },
+    assetLink(asset) {
+      if (typeof asset === "string") {
+        return `${options.origin}/api/v1/spaces/${options.spaceId}/assets/${asset}`;
+      } else {
+        return `${options.origin}/api/v1/spaces/${options.spaceId}/assets/${asset.uri}`;
+      }
+    }
+  };
+}
+
+// src/editable.ts
+function llEditable(content) {
+  return {
+    "data-ll-id": content._id,
+    "data-ll-schema": content.schema
+  };
+}
+
+// src/sync.ts
+var JS_SYNC_ID = "localess-js-sync";
+function loadLocalessSync(origin, force = false) {
+  const isServer = typeof window === "undefined";
+  if (isServer) return;
+  if (window.top === window.self) 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);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  llEditable,
+  loadLocalessSync,
+  localessClient
+});

package/dist/index.mjs

@@ -0,0 +1,186 @@
+// src/utils.ts
+var RESET = "\x1B[0m";
+var FG_BLUE = "\x1B[34m";
+
+// 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 fetchOptions = {
+    redirect: "follow",
+    headers: {
+      "Content-Type": "application/json",
+      "Accept": "application/json",
+      "X-Localess-Agent": "Localess-JS-Client",
+      "X-Localess-Agent-Version": "0.3.0"
+    }
+  };
+  return {
+    /**
+     * Get all links
+     * @param params{LinksFetchParams} - Fetch parameters
+     * @returns {Promise<Links>}
+     */
+    async getLinks(params) {
+      if (options.debug) {
+        console.log(LOG_GROUP, "getLinks() params : " + 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 = `${options.origin}/api/v1/spaces/${options.spaceId}/links?token=${options.token}${kind}${parentSlug}${excludeChildren}`;
+      if (options.debug) {
+        console.log(LOG_GROUP, "getLinks fetch url : ", url);
+      }
+      try {
+        const response = await fetch(url, fetchOptions);
+        if (options.debug) {
+          console.log(LOG_GROUP, "getLinks status : ", response.status);
+        }
+        const data = await response.json();
+        return data;
+      } catch (error) {
+        console.error(LOG_GROUP, "getLinks error : ", error);
+        return {};
+      }
+    },
+    /**
+     * Get content by SLUG
+     * @param slug{string} - Content SLUG
+     * @param params{ContentFetchParams} - Fetch parameters
+     * @returns {Promise<Content>}
+     */
+    async getContentBySlug(slug, params) {
+      if (options.debug) {
+        console.log(LOG_GROUP, "getContentBySlug() slug : ", slug);
+        console.log(LOG_GROUP, "getContentBySlug() params : ", 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}` : "";
+      let url = `${options.origin}/api/v1/spaces/${options.spaceId}/contents/slugs/${slug}?token=${options.token}${version}${locale}`;
+      if (options.debug) {
+        console.log(LOG_GROUP, "getContentBySlug fetch url : ", url);
+      }
+      try {
+        const response = await fetch(url, fetchOptions);
+        if (options.debug) {
+          console.log(LOG_GROUP, "getContentBySlug status : ", response.status);
+        }
+        const data = await response.json();
+        return data;
+      } catch (error) {
+        console.error(LOG_GROUP, "getContentBySlug error : ", error);
+        return {};
+      }
+    },
+    /**
+     * Get content by ID
+     * @param id{string} - Content ID
+     * @param params{ContentFetchParams} - Fetch parameters
+     * @returns {Promise<Content>}
+     */
+    async getContentById(id, params) {
+      if (options.debug) {
+        console.log(LOG_GROUP, "getContentById() id : ", id);
+        console.log(LOG_GROUP, "getContentById() params : ", 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}` : "";
+      let url = `${options.origin}/api/v1/spaces/${options.spaceId}/contents/${id}?token=${options.token}${version}${locale}`;
+      if (options.debug) {
+        console.log(LOG_GROUP, "getContentById fetch url : ", url);
+      }
+      const response = await fetch(url, fetchOptions);
+      if (options.debug) {
+        console.log(LOG_GROUP, "getContentById status : ", response.status);
+      }
+      const data = await response.json();
+      return data;
+    },
+    /**
+     * Get translations for the given locale
+     * @param locale{string} - Locale identifier (ISO 639-1)
+     */
+    async getTranslations(locale) {
+      if (options.debug) {
+        console.log(LOG_GROUP, "getTranslations() locale : ", locale);
+      }
+      let url = `${options.origin}/api/v1/spaces/${options.spaceId}/translations/${locale}`;
+      if (options.debug) {
+        console.log(LOG_GROUP, "getTranslations fetch url : ", url);
+      }
+      const response = await fetch(url, fetchOptions);
+      if (options.debug) {
+        console.log(LOG_GROUP, "getTranslations status : ", response.status);
+      }
+      const data = await response.json();
+      return data;
+    },
+    syncScriptUrl() {
+      return `${options.origin}/scripts/sync-v1.js`;
+    },
+    assetLink(asset) {
+      if (typeof asset === "string") {
+        return `${options.origin}/api/v1/spaces/${options.spaceId}/assets/${asset}`;
+      } else {
+        return `${options.origin}/api/v1/spaces/${options.spaceId}/assets/${asset.uri}`;
+      }
+    }
+  };
+}
+
+// src/editable.ts
+function llEditable(content) {
+  return {
+    "data-ll-id": content._id,
+    "data-ll-schema": content.schema
+  };
+}
+
+// src/sync.ts
+var JS_SYNC_ID = "localess-js-sync";
+function loadLocalessSync(origin, force = false) {
+  const isServer = typeof window === "undefined";
+  if (isServer) return;
+  if (window.top === window.self) 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);
+}
+export {
+  llEditable,
+  loadLocalessSync,
+  localessClient
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@localess/js-client",
-  "version": "0.3.2-next.20250108-112722.0",
+  "version": "0.3.2-next.20250109-154209.0",
   "description": "Universal JavaScript/TypeScript SDK for Localess's API.",
   "keywords": [
     "localess",
@@ -16,18 +16,15 @@
   "files": [
     "dist"
   ],
-  "main": "dist/cjs/index.js",
-  "module": "dist/index.js",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
   "exports": {
     ".": {
-      "import": "./dist/index.js",
-      "require": "./dist/cjs/index.js",
       "types": "./dist/index.d.ts",
-      "default": "./dist/index.js",
-      "node": "./dist/cjs/index.js"
-    },
-    "./models": "./dist/models/index.d.ts"
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
   },
   "repository": {
     "type": "git",
@@ -40,12 +37,12 @@
     "build": "npm run build:tsc && npm run build:cjs",
     "build:tsc": "tsc -p tsconfig.json",
     "build:cjs": "tsc -p tsconfig.cjs.json",
-    "build:tsup": "tsup-node --env.NODE_ENV production"
+    "build:tsup": "tsup src/index.ts --format cjs,esm --dts"
   },
   "license": "MIT",
-  "dependencies": {},
   "devDependencies": {
     "@types/node": "^20.12.12",
+    "tsup": "^8.3.5",
     "typescript": "^5.0.0"
   },
   "engines": {

package/dist/cjs/client.d.ts

@@ -1,88 +0,0 @@
-import { Content, ContentAsset, Links, Translations } from "./models";
-export type LocalessClientOptions = {
-    /**
-     * A fully qualified domain name with protocol (http/https) and port.
-     *
-     * Example: https://my-localess.web.app
-     */
-    origin: string;
-    /**
-     * Localess space ID, cna be found in the Localess Space settings
-     */
-    spaceId: string;
-    /**
-     * Localess API token, can be found in the Localess Space settings
-     */
-    token: string;
-    /**
-     * Content version to fetch, leave empty for 'published' or 'draft' for the latest draft
-     */
-    version?: 'draft' | string;
-    /**
-     * Enable debug mode
-     */
-    debug?: boolean;
-};
-export type LinksFetchParams = {
-    /**
-     * Content Kind. FOLDER or DOCUMENT. If not provided, it will return all.
-     * @example 'DOCUMENT'
-     */
-    kind?: 'DOCUMENT' | 'FOLDER';
-    /**
-     * Content parent slug.
-     * @example 'legal/policy'
-     */
-    parentSlug?: string;
-    /**
-     * If **true**, exclude all sub slugs, otherwise include all content under current selected **parent slug**.
-     * @example false
-     */
-    excludeChildren?: boolean;
-};
-export type ContentFetchParams = {
-    /**
-     * Content version to fetch, leave empty for 'published' or 'draft' for the latest draft.
-     * Overrides the version set in the client options.
-     */
-    version?: 'draft' | string;
-    /**
-     * Locale identifier (ISO 639-1) to fetch content in, leave empty for default locale.
-     *
-     * Example: en
-     */
-    locale?: string;
-};
-/**
- * Create a Localess API Client
- * @param {LocalessClientOptions} options connection details
- */
-export declare function localessClient(options: LocalessClientOptions): {
-    /**
-     * Get all links
-     * @param params{LinksFetchParams} - Fetch parameters
-     * @returns {Promise<Links>}
-     */
-    getLinks(params?: LinksFetchParams): Promise<Links>;
-    /**
-     * Get content by SLUG
-     * @param slug{string} - Content SLUG
-     * @param params{ContentFetchParams} - Fetch parameters
-     * @returns {Promise<Content>}
-     */
-    getContentBySlug(slug: string, params?: ContentFetchParams): Promise<Content>;
-    /**
-     * Get content by ID
-     * @param id{string} - Content ID
-     * @param params{ContentFetchParams} - Fetch parameters
-     * @returns {Promise<Content>}
-     */
-    getContentById(id: string, params?: ContentFetchParams): Promise<Content>;
-    /**
-     * Get translations for the given locale
-     * @param locale{string} - Locale identifier (ISO 639-1)
-     */
-    getTranslations(locale: string): Promise<Translations>;
-    syncScriptUrl(): string;
-    assetLink(asset: ContentAsset | string): string;
-};