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

package/dist/index.d.mts

@@ -0,0 +1,272 @@
+/**
+ * Content Asset define reference to a 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 new tab and _self for same tab.
+     */
+    target: '_blank' | '_self';
+    /**
+     * Define the type of Link. URL for external links and Content for internal links.
+     */
+    type: 'url' | 'content';
+    /**
+     * If 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 define 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 define 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;
+}
+
+/**
+ * Content define shared object for all possible Content Types.
+ */
+interface Content extends ContentMetadata {
+    /**
+     * Content Data
+     */
+    data?: ContentData;
+}
+
+/**
+ * Key-Value Object. Where Key is Unique identifier for the Content object and Value is Content Metadata.
+ */
+interface Links {
+    [key: string]: ContentMetadata;
+}
+
+/**
+ * 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, 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;
+};
+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' | 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
+ */
+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;
+};
+
+declare function llEditable(content: ContentDataSchema): {
+    'data-ll-id': string;
+    'data-ll-schema': string;
+};
+
+/**
+ * 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;
+
+type EventType = 'input' | 'save' | 'publish' | 'change';
+type EventCallback = (event: EventToApp) => void;
+type EventToApp = {
+    type: 'save' | 'publish';
+} | {
+    type: 'input' | 'change';
+    data: ContentData;
+};
+interface LocalessSync {
+    on: (event: EventType | EventType[], callback: EventCallback) => void;
+}
+declare global {
+    interface Window {
+        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 EventType, type Links, type LinksFetchParams, type LocalessClientOptions, type LocalessSync, type Translations, llEditable, loadLocalessSync, localessClient };

package/dist/index.d.ts

@@ -1,17 +1,266 @@
-import { ContentData } from "./models";
-export * from './models';
-export * from './client';
-export * from './editable';
-export * from './sync';
-export type EventType = 'input' | 'save' | 'publish' | 'change';
-export type EventCallback = (event: EventToApp) => void;
-export type EventToApp = {
+/**
+ * Content Asset define reference to a 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 new tab and _self for same tab.
+     */
+    target: '_blank' | '_self';
+    /**
+     * Define the type of Link. URL for external links and Content for internal links.
+     */
+    type: 'url' | 'content';
+    /**
+     * If 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 define 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 define 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;
+}
+
+/**
+ * Content define shared object for all possible Content Types.
+ */
+interface Content extends ContentMetadata {
+    /**
+     * Content Data
+     */
+    data?: ContentData;
+}
+
+/**
+ * Key-Value Object. Where Key is Unique identifier for the Content object and Value is Content Metadata.
+ */
+interface Links {
+    [key: string]: ContentMetadata;
+}
+
+/**
+ * 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, 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;
+};
+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' | 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
+ */
+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;
+};
+
+declare function llEditable(content: ContentDataSchema): {
+    'data-ll-id': string;
+    'data-ll-schema': string;
+};
+
+/**
+ * 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;
+
+type EventType = 'input' | 'save' | 'publish' | 'change';
+type EventCallback = (event: EventToApp) => void;
+type EventToApp = {
     type: 'save' | 'publish';
 } | {
     type: 'input' | 'change';
     data: ContentData;
 };
-export interface LocalessSync {
+interface LocalessSync {
     on: (event: EventType | EventType[], callback: EventCallback) => void;
 }
 declare global {
@@ -19,3 +268,5 @@ 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 EventType, type Links, type LinksFetchParams, type LocalessClientOptions, type LocalessSync, type Translations, llEditable, loadLocalessSync, localessClient };