@localess/js-client 0.0.4-next.20240527-214345.0 → 0.0.4

package/dist/cjs/index.d.ts

@@ -0,0 +1,78 @@
+import { Content, ContentAsset, Links, Translations } from "./models";
+export * 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;
+    /**
+     * Enable debug mode
+     */
+    debug?: boolean;
+};
+export type ContentFetchParams = {
+    /**
+     * Content version to fetch, leave empty for 'published' or 'draft' for the latest draft
+     */
+    version?: 'draft' | string;
+    /**
+     * Locale identifier (ISO 639-1) to fetch content in, leave empty for default locale.
+     *
+     * Example: en
+     */
+    locale?: string;
+};
+export declare function localessClient(options: LocalessClientOptions): {
+    /**
+     * Get all links
+     * @returns {Promise<Links>}
+     */
+    getLinks(): 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;
+};
+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/cjs/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/cjs/models/content-data.d.ts

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

package/dist/cjs/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/cjs/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/cjs/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/cjs/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/cjs/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/cjs/utils.d.ts

@@ -0,0 +1,40 @@
+export declare function proxyURIFromEnv(): string | undefined;
+export declare const RESET = "\u001B[0m";
+export declare const BRIGHT = "\u001B[1m";
+export declare const DIM = "\u001B[2m";
+export declare const UNDERSCORE = "\u001B[4m";
+export declare const BLINK = "\u001B[5m";
+export declare const REVERSE = "\u001B[7m";
+export declare const HIDDEN = "\u001B[8m";
+export declare const FG_BLACK = "\u001B[30m";
+export declare const FG_RED = "\u001B[31m";
+export declare const FG_GREEN = "\u001B[32m";
+export declare const FG_YELLOW = "\u001B[33m";
+export declare const FG_BLUE = "\u001B[34m";
+export declare const FG_MAGENTA = "\u001B[35m";
+export declare const FG_CYAN = "\u001B[36m";
+export declare const FG_WHITE = "\u001B[37m";
+export declare const FG_GRAY = "\u001B[90m";
+export declare const FG_BRIGHT_RED = "\u001B[91m";
+export declare const FG_BRIGHT_GREEN = "\u001B[92m";
+export declare const FG_BRIGHT_YELLOW = "\u001B[93m";
+export declare const FG_BRIGHT_BLUE = "\u001B[94m";
+export declare const FG_BRIGHT_MAGENTA = "\u001B[95m";
+export declare const FG_BRIGHT_CYAN = "\u001B[96m";
+export declare const FG_BRIGHT_WHITE = "\u001B[97m";
+export declare const BG_BLACK = "\u001B[40m";
+export declare const BG_RED = "\u001B[41m";
+export declare const BG_GREEN = "\u001B[42m";
+export declare const BG_YELLOW = "\u001B[43m";
+export declare const BG_BLUE = "\u001B[44m";
+export declare const BG_MAGENTA = "\u001B[45m";
+export declare const BG_CYAN = "\u001B[46m";
+export declare const BG_WHITE = "\u001B[47m";
+export declare const BG_GRAY = "\u001B[100m";
+export declare const BG_BRIGHT_RED = "\u001B[101m";
+export declare const BG_BRIGHT_GREEN = "\u001B[102m";
+export declare const BG_BRIGHT_YELLOW = "\u001B[103m";
+export declare const BG_BRIGHT_BLUE = "\u001B[104m";
+export declare const BG_BRIGHT_MAGENTA = "\u001B[105m";
+export declare const BG_BRIGHT_CYAN = "\u001B[106m";
+export declare const BG_BRIGHT_WHITE = "\u001B[107m";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@localess/js-client",
-  "version": "0.0.4-next.20240527-214345.0",
+  "version": "0.0.4",
   "description": "Universal JavaScript/TypeScript SDK for Localess's API.",
   "keywords": [
     "localess",
@@ -16,6 +16,9 @@
   "files": [
     "dist"
   ],
+  "main": "dist/cjs/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
   "exports": {
     ".": {
       "import": "./dist/index.js",