@localess/js-client 0.0.3-20240526-114112.0

package/README.md

@@ -0,0 +1,31 @@
+<br/>
+<br/>
+<img src="https://github.com/Lessify/localess/wiki/img/logo-adaptive.svg" alt="logo">
+<br/>
+<br/>
+
+----
+
+# Localess JavaScript / TypeScript Client SDK
+
+This client SDK is designed to work with the Localess API. It provides a simple way to interact with the Localess API from your JavaScript or TypeScript application.
+
+## Installation
+
+### NPM
+````bash
+npm install @localess/js-client@latest
+````
+
+### Yarn
+````bash
+yarn add @localess/js-client@latest
+````
+
+## Usage
+
+
+
+[comment]: <> (`npm init --scope=localess`)
+[comment]: <> (`npm run build`)
+[comment]: <> (`npm publish --access public dist`)

package/dist/index.d.ts

@@ -0,0 +1,34 @@
+import { Content, ContentAsset, Links, Translations } from "./models";
+export * from './models';
+export type LocalessClientOptions = {
+    domain: string;
+    version?: 'draft';
+    location?: string;
+    spaceId: string;
+    token: string;
+    secure?: boolean;
+};
+export declare function localessClient(options: LocalessClientOptions): {
+    getLinks(): Promise<Links>;
+    getContentBySlug(slug: string): Promise<Content>;
+    getContentById(id: string): Promise<Content>;
+    getTranslations(): Promise<Translations>;
+    syncScriptUrl(): string;
+    assetLink(asset: ContentAsset | string): string;
+};
+declare global {
+    type EventType = 'input' | 'save' | 'publish' | 'change';
+    type EventCallback = (event: EventToApp) => void;
+    type EventToApp = {
+        type: 'save' | 'publish';
+    } | {
+        type: 'input' | 'change';
+        data: any;
+    };
+    interface LocalessSync {
+        on: (event: EventType | EventType[], callback: EventCallback) => void;
+    }
+    interface Window {
+        localess?: LocalessSync;
+    }
+}

package/dist/index.js

@@ -0,0 +1,49 @@
+import { ProxyAgent } from 'proxy-agent';
+import fetch from 'node-fetch';
+import { proxyURIFromEnv } from "./utils";
+export * from './models';
+export function localessClient(options) {
+    const fetchOptions = {
+        redirect: 'follow',
+    };
+    if (proxyURIFromEnv()) {
+        fetchOptions.agent = new ProxyAgent();
+    }
+    const host = `${options.secure ? 'https' : 'http'}://${options.domain}`;
+    const version = options.version ? `&version=${options.version}` : '';
+    const locale = options.location ? `&location=${options.location}` : '';
+    return {
+        async getLinks() {
+            const response = await fetch(`${host}/api/v1/spaces/${options.spaceId}/links?token=${options.token}`, fetchOptions);
+            const data = await response.json();
+            return data;
+        },
+        async getContentBySlug(slug) {
+            const response = await fetch(`${host}/api/v1/spaces/${options.spaceId}/contents/slugs/${slug}?token=${options.token}${version}${locale}`, fetchOptions);
+            const data = await response.json();
+            return data;
+        },
+        async getContentById(id) {
+            const response = await fetch(`${host}/api/v1/spaces/${options.spaceId}/contents/${id}?token=${options.token}${version}${locale}`, fetchOptions);
+            const data = await response.json();
+            return data;
+        },
+        async getTranslations() {
+            const response = await fetch(`${host}/api/v1/spaces/${options.spaceId}/translations/${locale || 'en'}`, fetchOptions);
+            const data = await response.json();
+            return data;
+        },
+        syncScriptUrl() {
+            return `${host}/scripts/sync-v1.js`;
+        },
+        assetLink(asset) {
+            if (typeof asset === 'string') {
+                return `${host}/api/v1/spaces/${options.spaceId}/assets/${asset}`;
+            }
+            else {
+                return `${host}/api/v1/spaces/${options.spaceId}/assets/${asset.uri}`;
+            }
+        }
+    };
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAC,MAAM,aAAa,CAAC;AACvC,OAAO,KAAoB,MAAM,YAAY,CAAC;AAC9C,OAAO,EAAC,eAAe,EAAC,MAAM,SAAS,CAAC;AAGxC,cAAc,UAAU,CAAC;AAWzB,MAAM,UAAU,cAAc,CAAC,OAA8B;IAC3D,MAAM,YAAY,GAAgB;QAChC,QAAQ,EAAE,QAAQ;KACnB,CAAC;IACF,IAAI,eAAe,EAAE,EAAE,CAAC;QACtB,YAAY,CAAC,KAAK,GAAG,IAAI,UAAU,EAAE,CAAC;IACxC,CAAC;IACD,MAAM,IAAI,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,MAAM,OAAO,CAAC,MAAM,EAAE,CAAC;IACxE,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACrE,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,aAAa,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACvE,OAAO;QAEL,KAAK,CAAC,QAAQ;YACZ,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,IAAI,kBAAkB,OAAO,CAAC,OAAO,gBAAgB,OAAO,CAAC,KAAK,EAAE,EAAE,YAAY,CAAC,CAAA;YACnH,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YACnC,OAAO,IAAa,CAAC;QACvB,CAAC;QAED,KAAK,CAAC,gBAAgB,CAAC,IAAY;YACjC,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,IAAI,kBAAkB,OAAO,CAAC,OAAO,mBAAmB,IAAI,UAAU,OAAO,CAAC,KAAK,GAAG,OAAO,GAAG,MAAM,EAAE,EAAE,YAAY,CAAC,CAAA;YACvJ,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YACnC,OAAO,IAAe,CAAC;QACzB,CAAC;QAED,KAAK,CAAC,cAAc,CAAC,EAAU;YAC7B,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,IAAI,kBAAkB,OAAO,CAAC,OAAO,aAAa,EAAE,UAAU,OAAO,CAAC,KAAK,GAAG,OAAO,GAAG,MAAM,EAAE,EAAE,YAAY,CAAC,CAAA;YAC/I,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YACnC,OAAO,IAAe,CAAC;QACzB,CAAC;QAED,KAAK,CAAC,eAAe;YACnB,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,IAAI,kBAAkB,OAAO,CAAC,OAAO,iBAAiB,MAAM,IAAI,IAAI,EAAE,EAAE,YAAY,CAAC,CAAA;YACrH,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YACnC,OAAO,IAAoB,CAAC;QAC9B,CAAC;QAED,aAAa;YACX,OAAO,GAAG,IAAI,qBAAqB,CAAA;QACrC,CAAC;QAED,SAAS,CAAC,KAA4B;YACpC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gBAC9B,OAAO,GAAG,IAAI,kBAAkB,OAAO,CAAC,OAAO,WAAW,KAAK,EAAE,CAAC;YACpE,CAAC;iBAAM,CAAC;gBACN,OAAO,GAAG,IAAI,kBAAkB,OAAO,CAAC,OAAO,WAAW,KAAK,CAAC,GAAG,EAAE,CAAC;YACxE,CAAC;QACH,CAAC;KACF,CAAA;AACH,CAAC"}

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

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

package/dist/models/content-asset.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=content-asset.js.map

package/dist/models/content-asset.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"content-asset.js","sourceRoot":"","sources":["../../src/models/content-asset.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,4 @@
+/**
+ * ContentData defined Object to connect all possible root Schemas.
+ */
+export type ContentData = unknown;

package/dist/models/content-data.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=content-data.js.map

package/dist/models/content-data.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"content-data.js","sourceRoot":"","sources":["../../src/models/content-data.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,41 @@
+/**
+ * Content Metadata define 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-metadata.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=content-metadata.js.map

package/dist/models/content-metadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"content-metadata.js","sourceRoot":"","sources":["../../src/models/content-metadata.ts"],"names":[],"mappings":""}

package/dist/models/content.d.ts

@@ -0,0 +1,47 @@
+import { ContentData } from './content-data';
+/**
+ * Content define shared object for all possible Content Types.
+ */
+export interface Content {
+    /**
+     * Date and Time at which the Content was created.
+     */
+    createdAt: string;
+    data?: ContentData;
+    /**
+     * 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';
+    /**
+     * Locale unique identifier (ISO 639-1).
+     */
+    locale?: string;
+    /**
+     * 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.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=content.js.map

package/dist/models/content.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"content.js","sourceRoot":"","sources":["../../src/models/content.ts"],"names":[],"mappings":""}

package/dist/models/index.d.ts

@@ -0,0 +1,6 @@
+export * from './content';
+export * from './content-asset';
+export * from './content-data';
+export * from './content-metadata';
+export * from './links';
+export * from './translations';

package/dist/models/index.js

@@ -0,0 +1,7 @@
+export * from './content';
+export * from './content-asset';
+export * from './content-data';
+export * from './content-metadata';
+export * from './links';
+export * from './translations';
+//# sourceMappingURL=index.js.map

package/dist/models/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/models/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,SAAS,CAAC;AACxB,cAAc,gBAAgB,CAAC"}

package/dist/models/links.d.ts

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

package/dist/models/links.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=links.js.map

package/dist/models/links.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"links.js","sourceRoot":"","sources":["../../src/models/links.ts"],"names":[],"mappings":""}

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/models/translations.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=translations.js.map

package/dist/models/translations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"translations.js","sourceRoot":"","sources":["../../src/models/translations.ts"],"names":[],"mappings":""}

package/dist/utils.d.ts

@@ -0,0 +1 @@
+export declare function proxyURIFromEnv(): string | undefined;

package/dist/utils.js

@@ -0,0 +1,8 @@
+export function proxyURIFromEnv() {
+    return (process.env.HTTPS_PROXY ||
+        process.env.https_proxy ||
+        process.env.HTTP_PROXY ||
+        process.env.http_proxy ||
+        undefined);
+}
+//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,eAAe;IAC7B,OAAO,CACL,OAAO,CAAC,GAAG,CAAC,WAAW;QACvB,OAAO,CAAC,GAAG,CAAC,WAAW;QACvB,OAAO,CAAC,GAAG,CAAC,UAAU;QACtB,OAAO,CAAC,GAAG,CAAC,UAAU;QACtB,SAAS,CACV,CAAC;AACJ,CAAC"}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@localess/js-client",
+  "version": "0.0.3-20240526-114112.0",
+  "type": "module",
+  "description": "Universal JavaScript/TypeScript SDK for Localess's API.",
+  "keywords": [
+    "localess",
+    "sdk",
+    "api",
+    "client",
+    "javascript",
+    "typescript"
+  ],
+  "author": "Alex Cibotari <alexandru.cibotari@gmail.com>",
+  "homepage": "https://localess.org",
+  "main": "./dist/index.ts",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Lessify/localess-js-client.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Lessify/localess-js-client/issues"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "node-fetch": "^3.0.0",
+    "proxy-agent": "^6.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.12.12",
+    "typescript": "^5.0.0"
+  },
+  "engines": {
+    "node": ">= 18.0.0"
+  }
+}