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

package/dist/cache.d.ts

@@ -0,0 +1,29 @@
+export interface ICache<V> {
+    set(key: string, value: V): void;
+    get(key: string): V | undefined;
+    has(key: string): boolean;
+}
+export declare class Cache<V> implements ICache<V> {
+    private cache;
+    set(key: string, value: V): void;
+    get(key: string): V | undefined;
+    has(key: string): boolean;
+}
+export declare class NoCache<V> implements ICache<V> {
+    set(key: string, value: V): void;
+    get(key: string): V | undefined;
+    has(key: string): boolean;
+}
+export declare class TTLCache<V> {
+    private ttlMs;
+    private cache;
+    /**
+     * Creates a TTLCache with a specified time-to-live (TTL) for each entry.
+     * default is 5 minutes (300000 ms).
+     * @param ttlMs
+     */
+    constructor(ttlMs?: number);
+    set(key: string, value: V): void;
+    get(key: string): V | undefined;
+    has(key: string): boolean;
+}

package/dist/client.d.ts

@@ -0,0 +1,102 @@
+import { Content, ContentAsset, ContentData, 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 can 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;
+    /**
+     * Cache TTL (time to live) for API responses. Default is 5 minutes (300000 ms).
+     * Set to false to disable caching.
+     */
+    cacheTTL?: number | false;
+};
+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';
+    /**
+     * Locale identifier (ISO 639-1) to fetch content in, leave empty for default locale.
+     *
+     * Example: en
+     */
+    locale?: string;
+    /**
+     * Resolve references in the content data. Default is false.
+     */
+    resolveReference?: boolean;
+    /**
+     * Resolve links in the content data. Default is false.
+     */
+    resolveLink?: boolean;
+};
+export interface LocalessClient {
+    /**
+     * 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<T extends ContentData = ContentData>(slug: string, params?: ContentFetchParams): Promise<Content<T>>;
+    /**
+     * Get content by ID
+     * @param id{string} - Content ID
+     * @param params{ContentFetchParams} - Fetch parameters
+     * @returns {Promise<Content>}
+     */
+    getContentById<T extends ContentData = ContentData>(id: string, params?: ContentFetchParams): Promise<Content<T>>;
+    /**
+     * 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;
+}
+/**
+ * Create a Localess API Client
+ * @param {LocalessClientOptions} options connection details
+ */
+export declare function localessClient(options: LocalessClientOptions): LocalessClient;

package/dist/editable.d.ts

@@ -0,0 +1,19 @@
+import { ContentData, ContentDataSchema } from './models';
+/**
+ * Adds Localess editable attributes to a content item.
+ * @param content
+ * @returns An object containing data-ll-id and data-ll-schema attributes.
+ */
+export declare function localessEditable(content: ContentDataSchema): {
+    'data-ll-id': string;
+    'data-ll-schema': string;
+};
+/**
+ * Adds Localess editable field attribute to a specific field.
+ * Added type safety to ensure fieldName is a valid key of the content data excluding base schema fields.
+ * @param fieldName
+ * @returns An object containing data-ll-field attribute.
+ */
+export declare function localessEditableField<T extends ContentData = ContentData>(fieldName: Exclude<keyof T, keyof ContentDataSchema>): {
+    'data-ll-field': Exclude<keyof T, keyof ContentDataSchema>;
+};

package/dist/index.d.ts

@@ -1,318 +1,11 @@
-/**
- * Content Asset defines reference to an Asset.
- */
-interface ContentAsset {
-    /**
-     * Define the type of Asset
-     */
-    kind: 'ASSET';
-    /**
-     * Unique identifier for the asset.
-     */
-    uri: string;
-}
-
-/**
- * Content Link define reference to a Link.
- */
-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;
-}
-
-/**
- * Content RichText define content as JSON Object.
- */
-interface ContentRichText {
-    /**
-     * Define the type of Content Node
-     */
-    type?: string;
-    /**
-     * List of Content Nodes
-     */
-    content?: ContentRichText[];
-}
-
-/**
- * Content Reference defines reference to a Content.
- */
-interface ContentReference {
-    /**
-     * Define the type of REFERENCE
-     */
-    kind: 'REFERENCE';
-    /**
-     * Unique identifier for the Content Document.
-     */
-    uri: string;
-}
-
-type ContentDataField = any | string | string[] | number | boolean | ContentLink | ContentRichText | ContentData | ContentData[] | ContentAsset | ContentAsset[] | ContentReference | ContentReference[];
-/**
- * Content Data Schema related information.
- */
-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.
- */
-interface ContentData extends ContentDataSchema {
-    /**
-     * Other Schema-specific fields
-     */
-    [field: string]: ContentDataField | undefined;
-}
-
-/**
- * Content Metadata defines short information about a Content for navigation reason.
- */
-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;
-}
-
-/**
- * Key-Value Object. Where Key is a Unique identifier for the Content object and Value is Content Metadata.
- */
-interface Links {
-    [key: string]: ContentMetadata;
-}
-
-/**
- * Key-Value Object. Where Key is a Unique identifier for the Content object and Value is Content.
- */
-interface References {
-    [key: string]: Content;
-}
-
-/**
- * Content defines a shared object for all possible Content Types.
- */
-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;
-}
-
-interface Locale {
-    /**
-     * Unique identifier for the Locale.
-     */
-    id: string;
-    /**
-     * Name of the Locale.
-     */
-    name: string;
-}
-
-/**
- * Key-Value Object. Where Key is Translation ID and Value is Translated Content
- */
-interface Translations {
-    [key: string]: string;
-}
-
-type LocalessClientOptions = {
-    /**
-     * A fully qualified domain name with protocol (http/https) and port.
-     *
-     * Example: https://my-localess.web.app
-     */
-    origin: string;
-    /**
-     * Localess space ID can 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;
-    /**
-     * Cache TTL (time to live) for API responses. Default is 5 minutes (300000 ms).
-     * Set to false to disable caching.
-     */
-    cacheTTL?: number | false;
-};
-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;
-};
-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';
-    /**
-     * Locale identifier (ISO 639-1) to fetch content in, leave empty for default locale.
-     *
-     * Example: en
-     */
-    locale?: string;
-    /**
-     * Resolve references in the content data. Default is false.
-     */
-    resolveReference?: boolean;
-    /**
-     * Resolve links in the content data. Default is false.
-     */
-    resolveLink?: boolean;
-};
-interface LocalessClient {
-    /**
-     * 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<T extends ContentData = ContentData>(slug: string, params?: ContentFetchParams): Promise<Content<T>>;
-    /**
-     * Get content by ID
-     * @param id{string} - Content ID
-     * @param params{ContentFetchParams} - Fetch parameters
-     * @returns {Promise<Content>}
-     */
-    getContentById<T extends ContentData = ContentData>(id: string, params?: ContentFetchParams): Promise<Content<T>>;
-    /**
-     * 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;
-}
-/**
- * Create a Localess API Client
- * @param {LocalessClientOptions} options connection details
- */
-declare function localessClient(options: LocalessClientOptions): LocalessClient;
-
-/**
- * Adds Localess editable attributes to a content item.
- * @param content
- * @returns An object containing data-ll-id and data-ll-schema attributes.
- */
-declare function localessEditable(content: ContentDataSchema): {
-    'data-ll-id': string;
-    'data-ll-schema': string;
-};
-/**
- * Adds Localess editable field attribute to a specific field.
- * Added type safety to ensure fieldName is a valid key of the content data excluding base schema fields.
- * @param fieldName
- * @returns An object containing data-ll-field attribute.
- */
-declare function localessEditableField<T extends ContentData = ContentData>(fieldName: Exclude<keyof T, keyof ContentDataSchema>): {
-    'data-ll-field': Exclude<keyof T, keyof ContentDataSchema>;
-};
-
-/**
- * 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.
- */
-declare function loadLocalessSync(origin: string, force?: boolean): void;
-
-declare const isBrowser: () => boolean;
-declare const isServer: () => boolean;
-declare const isIframe: () => boolean;
-
-type EventToAppType = 'save' | 'publish' | 'pong' | 'input' | 'change' | 'enterSchema' | 'hoverSchema';
-type EventCallback = (event: EventToApp) => void;
-type EventToApp = {
+export * from './models';
+export * from './client';
+export * from './editable';
+export * from './sync';
+export { isBrowser, isServer, isIframe } from './utils';
+export type EventToAppType = 'save' | 'publish' | 'pong' | 'input' | 'change' | 'enterSchema' | 'hoverSchema';
+export type EventCallback = (event: EventToApp) => void;
+export type EventToApp = {
     type: 'save' | 'publish' | 'pong';
 } | {
     type: 'input' | 'change';
@@ -323,7 +16,7 @@ type EventToApp = {
     schema: string;
     field?: string;
 };
-interface LocalessSync {
+export interface LocalessSync {
     onChange: (callback: EventCallback) => void;
     on: (event: EventToAppType | EventToAppType[], callback: EventCallback) => void;
 }
@@ -332,5 +25,3 @@ declare global {
         localess?: LocalessSync;
     }
 }
-
-export { type Content, type ContentAsset, type ContentData, type ContentDataField, type ContentDataSchema, type ContentFetchParams, type ContentLink, type ContentMetadata, type ContentReference, type ContentRichText, type EventCallback, type EventToApp, type EventToAppType, type Links, type LinksFetchParams, type Locale, type LocalessClient, type LocalessClientOptions, type LocalessSync, type References, type Translations, isBrowser, isIframe, isServer, loadLocalessSync, localessClient, localessEditable, localessEditableField };