@localess/cli 3.0.5-dev.20260428203008 → 3.0.5-dev.20260501214755

package/SKILL.md

@@ -48,6 +48,7 @@ localess login \
 2. Prompts interactively for any missing options
 3. Validates credentials by calling the API
 4. Saves credentials to `.localess/credentials.json` (mode `0o600`)
+5. Automatically adds `.localess` to `.gitignore` (creates the file if absent; skips if the entry already exists)
 
 ### Logout
 
@@ -88,7 +89,7 @@ Recommended for **CI/CD pipelines** — no `localess login` step needed.
 }
 ```
 
-> **Add `.localess/credentials.json` to your `.gitignore`** to avoid committing secrets.
+> `.localess` is automatically added to `.gitignore` by `localess login` to prevent credentials from being committed.
 
 ---
 
@@ -324,14 +325,18 @@ localess types generate
 
 ---
 
-## .gitignore Recommendations
+## .gitignore
+
+`localess login` automatically appends `.localess` to `.gitignore` in the current working directory (creating the file if it doesn't exist). No manual step is required.
+
+If you want to commit generated types while still ignoring credentials, you can refine the entry manually after login:
 
 ```gitignore
-# Localess credentials (contains API token)
+# Localess credentials (contains API token) — added automatically by `localess login`
 .localess/credentials.json
 
-# Generated types are typically committed to the repo
-# but can be excluded if auto-generated in CI:
+# Commit generated types so the whole team benefits from type safety;
+# only exclude if types are regenerated in CI:
 # .localess/localess.d.ts
 ```
 
@@ -358,6 +363,6 @@ localess types generate
 
 5. **Use `add-missing` strategy (default)** for initial import of translations; switch to `update-existing` when syncing copy changes.
 
-6. **Never commit `.localess/credentials.json`** — add it to `.gitignore` immediately after `localess login`.
+6. **Never commit `.localess/credentials.json`** — `localess login` automatically adds `.localess` to `.gitignore`, so credentials are protected out of the box.
 
 7. **Give the token minimum required permissions** — the `types generate` command needs "Development Tools" permission; other commands only need standard API access.

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,142 @@
+import { OpenAPIObject } from 'openapi3-ts/oas30';
+import { Content, ContentAsset, ContentData, Links, Schemas, Space, Translations, TranslationUpdateResponse, TranslationUpdateType } 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;
+    /**
+     * Number of times to retry failed fetch requests (network errors or 5xx). Default: 3
+     */
+    retryCount?: number;
+    /**
+     * Delay in ms between retries. Default: 500ms
+     */
+    retryDelay?: number;
+};
+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;
+    /**
+     * Resolve references in the content data. Default is false.
+     */
+    resolveReference?: boolean;
+    /**
+     * Resolve links in the content data. Default is false.
+     */
+    resolveLink?: boolean;
+};
+export type TranslationFetchParams = {
+    /**
+     * Translation version to fetch, leave empty for 'published' or 'draft' for the latest draft.
+     * Overrides the version set in the client options.
+     */
+    version?: 'draft' | string;
+};
+export interface LocalessClient {
+    /**
+     * Get space information
+     * @returns {Promise<Space>}
+     */
+    getSpace(): Promise<Space>;
+    /**
+     * 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)
+     * @param params{ContentFetchParams} - Fetch parameters
+     * @returns {Promise<Translations>}
+     */
+    getTranslations(locale: string, params?: TranslationFetchParams): Promise<Translations>;
+    /**
+     * Update translations for the given locale
+     * @param locale - Locale identifier (ISO 639-1)
+     * @param type{TranslationUpdateType} - Type of update to perform (add-missing or update-existing)
+     * @param values - Key-Value Object. Where Key is Translation ID and Value is Translated Content
+     * @param dryRun - If true, the API will return the changes that would be made without actually applying them
+     * @returns {Promise<void>}
+     */
+    updateTranslations(locale: string, type: TranslationUpdateType, values: Translations, dryRun?: boolean): Promise<TranslationUpdateResponse | undefined>;
+    /**
+     * Get OpenAPI specification
+     * Requires Token with Development Tools permission
+     */
+    getOpenApi(): Promise<OpenAPIObject>;
+    /**
+     * Get Schemas Definition
+     */
+    getSchemas(): Promise<Schemas>;
+    assetLink(asset: ContentAsset | string): string;
+}
+/**
+ * Create a Localess API Client
+ * @param {LocalessClientOptions} options connection details
+ */
+export declare function localessClient(options: LocalessClientOptions): LocalessClient;

package/dist/commands/login/index.d.ts

@@ -0,0 +1,2 @@
+import { Command } from 'commander';
+export declare const loginCommand: Command;

package/dist/commands/login/login.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/commands/logout/index.d.ts

@@ -0,0 +1,2 @@
+import { Command } from 'commander';
+export declare const logoutCommand: Command;

package/dist/commands/translations/index.d.ts

@@ -0,0 +1,2 @@
+import { Command } from 'commander';
+export declare const translationsCommand: Command;

package/dist/commands/translations/pull/index.d.ts

@@ -0,0 +1,7 @@
+import { Command } from 'commander';
+import { TranslationFileFormat } from '../../../models';
+export type TranslationsPullOptions = {
+    path: string;
+    format: TranslationFileFormat;
+};
+export declare const translationsPullCommand: Command;

package/dist/commands/translations/push/index.d.ts

@@ -0,0 +1,9 @@
+import { Command } from 'commander';
+import { TranslationFileFormat, TranslationUpdateType } from '../../../models';
+export type TranslationsPushOptions = {
+    path: string;
+    format: TranslationFileFormat;
+    type: TranslationUpdateType;
+    dryRun?: boolean;
+};
+export declare const translationsPushCommand: Command;

package/dist/commands/types/generate/generator.d.ts

@@ -0,0 +1,3 @@
+import { Schemas } from '../../../models';
+export declare function toPascalCase(str: string): string;
+export declare function generateTypes(schemas: Schemas, prefix?: string): string;

package/dist/commands/types/generate/generator.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/commands/types/generate/index.d.ts

@@ -0,0 +1,2 @@
+import { Command } from 'commander';
+export declare const typesGenerateCommand: Command;

package/dist/commands/types/index.d.ts

@@ -0,0 +1,2 @@
+import { Command } from 'commander';
+export declare const typesCommand: Command;

package/dist/commands/types/types.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/file.d.ts

@@ -0,0 +1,7 @@
+export declare const DEFAULT_CONFIG_DIR = ".localess";
+export declare function fileExists(path: string): Promise<boolean>;
+export declare function writeFile(filePath: string, data: string, option?: {
+    mode?: number;
+}): Promise<void>;
+export declare function readFile(filePath: string): Promise<string>;
+export declare function ensureGitignore(cwd: string, entry: string): Promise<void>;

package/dist/index.d.ts

@@ -1 +1,2 @@
-export { }
+#!/usr/bin/env node
+export {};