stringist 0.1.0-alpha.0

package/dist/generated/core/serverSentEvents.gen.js

@@ -0,0 +1,132 @@
+// This file is auto-generated by @hey-api/openapi-ts
+export function createSseClient({ onRequest, onSseError, onSseEvent, responseTransformer, responseValidator, sseDefaultRetryDelay, sseMaxRetryAttempts, sseMaxRetryDelay, sseSleepFn, url, ...options }) {
+    let lastEventId;
+    const sleep = sseSleepFn ?? ((ms) => new Promise((resolve) => setTimeout(resolve, ms)));
+    const createStream = async function* () {
+        let retryDelay = sseDefaultRetryDelay ?? 3000;
+        let attempt = 0;
+        const signal = options.signal ?? new AbortController().signal;
+        while (true) {
+            if (signal.aborted)
+                break;
+            attempt++;
+            const headers = options.headers instanceof Headers
+                ? options.headers
+                : new Headers(options.headers);
+            if (lastEventId !== undefined) {
+                headers.set('Last-Event-ID', lastEventId);
+            }
+            try {
+                const requestInit = {
+                    redirect: 'follow',
+                    ...options,
+                    body: options.serializedBody,
+                    headers,
+                    signal,
+                };
+                let request = new Request(url, requestInit);
+                if (onRequest) {
+                    request = await onRequest(url, requestInit);
+                }
+                // fetch must be assigned here, otherwise it would throw the error:
+                // TypeError: Failed to execute 'fetch' on 'Window': Illegal invocation
+                const _fetch = options.fetch ?? globalThis.fetch;
+                const response = await _fetch(request);
+                if (!response.ok)
+                    throw new Error(`SSE failed: ${response.status} ${response.statusText}`);
+                if (!response.body)
+                    throw new Error('No body in SSE response');
+                const reader = response.body.pipeThrough(new TextDecoderStream()).getReader();
+                let buffer = '';
+                const abortHandler = () => {
+                    try {
+                        reader.cancel();
+                    }
+                    catch {
+                        // noop
+                    }
+                };
+                signal.addEventListener('abort', abortHandler);
+                try {
+                    while (true) {
+                        const { done, value } = await reader.read();
+                        if (done)
+                            break;
+                        buffer += value;
+                        buffer = buffer.replace(/\r\n?/g, '\n'); // normalize line endings
+                        const chunks = buffer.split('\n\n');
+                        buffer = chunks.pop() ?? '';
+                        for (const chunk of chunks) {
+                            const lines = chunk.split('\n');
+                            const dataLines = [];
+                            let eventName;
+                            for (const line of lines) {
+                                if (line.startsWith('data:')) {
+                                    dataLines.push(line.replace(/^data:\s*/, ''));
+                                }
+                                else if (line.startsWith('event:')) {
+                                    eventName = line.replace(/^event:\s*/, '');
+                                }
+                                else if (line.startsWith('id:')) {
+                                    lastEventId = line.replace(/^id:\s*/, '');
+                                }
+                                else if (line.startsWith('retry:')) {
+                                    const parsed = Number.parseInt(line.replace(/^retry:\s*/, ''), 10);
+                                    if (!Number.isNaN(parsed)) {
+                                        retryDelay = parsed;
+                                    }
+                                }
+                            }
+                            let data;
+                            let parsedJson = false;
+                            if (dataLines.length) {
+                                const rawData = dataLines.join('\n');
+                                try {
+                                    data = JSON.parse(rawData);
+                                    parsedJson = true;
+                                }
+                                catch {
+                                    data = rawData;
+                                }
+                            }
+                            if (parsedJson) {
+                                if (responseValidator) {
+                                    await responseValidator(data);
+                                }
+                                if (responseTransformer) {
+                                    data = await responseTransformer(data);
+                                }
+                            }
+                            onSseEvent?.({
+                                data,
+                                event: eventName,
+                                id: lastEventId,
+                                retry: retryDelay,
+                            });
+                            if (dataLines.length) {
+                                yield data;
+                            }
+                        }
+                    }
+                }
+                finally {
+                    signal.removeEventListener('abort', abortHandler);
+                    reader.releaseLock();
+                }
+                break; // exit loop on normal completion
+            }
+            catch (error) {
+                // connection failed or aborted; retry after delay
+                onSseError?.(error);
+                if (sseMaxRetryAttempts !== undefined && attempt >= sseMaxRetryAttempts) {
+                    break; // stop after firing error
+                }
+                // exponential backoff: double retry each attempt, cap at 30s
+                const backoff = Math.min(retryDelay * 2 ** (attempt - 1), sseMaxRetryDelay ?? 30000);
+                await sleep(backoff);
+            }
+        }
+    };
+    const stream = createStream();
+    return { stream };
+}

package/dist/generated/core/types.gen.js

@@ -0,0 +1,2 @@
+// This file is auto-generated by @hey-api/openapi-ts
+export {};

package/dist/generated/core/utils.gen.js

@@ -0,0 +1,87 @@
+// This file is auto-generated by @hey-api/openapi-ts
+import { serializeArrayParam, serializeObjectParam, serializePrimitiveParam, } from './pathSerializer.gen.js';
+export const PATH_PARAM_RE = /\{[^{}]+\}/g;
+export const defaultPathSerializer = ({ path, url: _url }) => {
+    let url = _url;
+    const matches = _url.match(PATH_PARAM_RE);
+    if (matches) {
+        for (const match of matches) {
+            let explode = false;
+            let name = match.substring(1, match.length - 1);
+            let style = 'simple';
+            if (name.endsWith('*')) {
+                explode = true;
+                name = name.substring(0, name.length - 1);
+            }
+            if (name.startsWith('.')) {
+                name = name.substring(1);
+                style = 'label';
+            }
+            else if (name.startsWith(';')) {
+                name = name.substring(1);
+                style = 'matrix';
+            }
+            const value = path[name];
+            if (value === undefined || value === null) {
+                continue;
+            }
+            if (Array.isArray(value)) {
+                url = url.replace(match, serializeArrayParam({ explode, name, style, value }));
+                continue;
+            }
+            if (typeof value === 'object') {
+                url = url.replace(match, serializeObjectParam({
+                    explode,
+                    name,
+                    style,
+                    value: value,
+                    valueOnly: true,
+                }));
+                continue;
+            }
+            if (style === 'matrix') {
+                url = url.replace(match, `;${serializePrimitiveParam({
+                    name,
+                    value: value,
+                })}`);
+                continue;
+            }
+            const replaceValue = encodeURIComponent(style === 'label' ? `.${value}` : value);
+            url = url.replace(match, replaceValue);
+        }
+    }
+    return url;
+};
+export const getUrl = ({ baseUrl, path, query, querySerializer, url: _url, }) => {
+    const pathUrl = _url.startsWith('/') ? _url : `/${_url}`;
+    let url = (baseUrl ?? '') + pathUrl;
+    if (path) {
+        url = defaultPathSerializer({ path, url });
+    }
+    let search = query ? querySerializer(query) : '';
+    if (search.startsWith('?')) {
+        search = search.substring(1);
+    }
+    if (search) {
+        url += `?${search}`;
+    }
+    return url;
+};
+export function getValidRequestBody(options) {
+    const hasBody = options.body !== undefined;
+    const isSerializedBody = hasBody && options.bodySerializer;
+    if (isSerializedBody) {
+        if ('serializedBody' in options) {
+            const hasSerializedBody = options.serializedBody !== undefined && options.serializedBody !== '';
+            return hasSerializedBody ? options.serializedBody : null;
+        }
+        // not all clients implement a serializedBody property (i.e., client-axios)
+        return options.body !== '' ? options.body : null;
+    }
+    // plain/text body
+    if (hasBody) {
+        return options.body;
+    }
+    // no body was provided
+    return undefined;
+}

package/dist/generated/index.js

@@ -0,0 +1,2 @@
+// This file is auto-generated by @hey-api/openapi-ts
+export { postV1ProjectsByProjectIdAppsByAppIdImportsXcstrings } from './sdk.gen.js';

package/dist/generated/sdk.gen.js

@@ -0,0 +1,13 @@
+// This file is auto-generated by @hey-api/openapi-ts
+import { client } from './client.gen.js';
+/**
+ * Import string catalogs as a complete app version
+ */
+export const postV1ProjectsByProjectIdAppsByAppIdImportsXcstrings = (options) => (options.client ?? client).post({
+    url: '/v1/projects/{projectId}/apps/{appId}/imports/xcstrings',
+    ...options,
+    headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+    }
+});

package/dist/generated/types.gen.js

@@ -0,0 +1,2 @@
+// This file is auto-generated by @hey-api/openapi-ts
+export {};

package/dist/settings.js

@@ -0,0 +1,55 @@
+import { mkdir, readFile, writeFile } from 'node:fs/promises';
+import { join } from 'node:path';
+export function slug(value, label) {
+    if (typeof value !== 'string' || value.length > 80 || !/^[a-z0-9]+(?:-[a-z0-9]+)*$/.test(value)) {
+        throw new Error(`${label} must be a lowercase slug (letters, numbers, and single hyphens, at most 80 characters).`);
+    }
+    return value;
+}
+export function project(value) {
+    if (typeof value !== 'string' || value.split('/').length !== 2) {
+        throw new Error('Project must have the format org/proj, for example acme/mobile.');
+    }
+    const [org, name] = value.split('/');
+    slug(org, 'Organization');
+    slug(name, 'Project');
+    return value;
+}
+export function sourceFormat(value) {
+    if (value !== 'xcstrings')
+        throw new Error('sourceFormat must be xcstrings.');
+    return value;
+}
+export function parseSettings(value) {
+    if (!value || typeof value !== 'object' || Array.isArray(value)) {
+        throw new Error('Settings must be a JSON object.');
+    }
+    const data = value;
+    return { project: project(data.project), app: slug(data.app, 'App'), sourceFormat: sourceFormat(data.sourceFormat) };
+}
+export const settingsPath = (cwd) => join(cwd, '.stringist', 'settings.json');
+export async function readSettings(cwd) {
+    const path = settingsPath(cwd);
+    try {
+        return parseSettings(JSON.parse((await readFile(path, 'utf8')).replace(/^\uFEFF/, '')));
+    }
+    catch (error) {
+        if (error.code === 'ENOENT') {
+            throw new Error(`No ${path}. Run stringist init from this directory first.`);
+        }
+        throw new Error(`Cannot read ${path}: ${error.message}`);
+    }
+}
+export async function writeSettings(cwd, settings) {
+    const path = settingsPath(cwd);
+    await mkdir(join(cwd, '.stringist'), { recursive: true });
+    try {
+        await writeFile(path, `${JSON.stringify(parseSettings(settings), null, 2)}\n`, { flag: 'wx' });
+    }
+    catch (error) {
+        if (error.code === 'EEXIST') {
+            throw new Error(`${path} already exists. Edit it to change the destination.`);
+        }
+        throw error;
+    }
+}

package/dist/upload.js

@@ -0,0 +1,33 @@
+import { execFile } from 'node:child_process';
+import { promisify } from 'node:util';
+import { collectCatalogs, MAX_BYTES } from './catalogs.js';
+import { readSettings } from './settings.js';
+export async function gitRef(cwd) {
+    try {
+        const { stdout } = await promisify(execFile)('git', ['rev-parse', '--verify', 'HEAD'], { cwd, timeout: 5_000, maxBuffer: 4096 });
+        return stdout.trim() || undefined;
+    }
+    catch {
+        return undefined;
+    } // Git is optional, including repositories without commits.
+}
+export async function upload(cwd, options, api, log) {
+    const settings = await readSettings(cwd);
+    const files = await collectCatalogs(cwd, options.languages);
+    const vcsRef = options.vcsRef ?? await gitRef(cwd);
+    const body = {
+        files,
+        languages: options.languages,
+        ...(options.version === undefined ? {} : { name: options.version }),
+        ...(vcsRef === undefined ? {} : { vcsRef }),
+    };
+    if (Buffer.byteLength(JSON.stringify(body)) > MAX_BYTES)
+        throw new Error('Request exceeds the API’s 20 MiB upload limit.');
+    log(`Uploading ${files.length} catalog(s) to ${settings.project}/${settings.app} (${options.languages.length ? `translations: ${options.languages.join(', ')}` : 'keys only'}).`);
+    const result = await api.importCatalogs(settings, body);
+    if (!result?.version || !Number.isSafeInteger(result.version.id))
+        throw new Error('Upload returned an invalid result. Check the app’s versions before uploading again.');
+    log(`Uploaded version ${result.version.id}${options.version ? ` (${options.version})` : ''}.`);
+    const counts = ['added', 'updated', 'removed', 'translations'];
+    log(counts.filter((key) => typeof result[key] === 'number').map((key) => `${result[key]} ${key}`).join(', '));
+}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "stringist",
+  "version": "0.1.0-alpha.0",
+  "description": "The Stringist CLI for uploading localization catalogs",
+  "type": "module",
+  "bin": {
+    "stringist": "dist/cli.js"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=22.0.0"
+  },
+  "license": "UNLICENSED",
+  "keywords": [
+    "stringist",
+    "localization",
+    "i18n",
+    "xcstrings",
+    "cli"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "generate:api": "openapi-ts",
+    "update:api": "node scripts/update-openapi.mjs && pnpm run generate:api",
+    "prepare:release": "node scripts/prepare-release.mjs",
+    "build": "tsc && node scripts/executable.mjs",
+    "check": "tsc --noEmit",
+    "test": "pnpm run build && node --test test/*.test.mjs",
+    "test:package": "pnpm run build && node scripts/test-package.mjs",
+    "prepack": "pnpm run build",
+    "prepublishOnly": "pnpm run check && pnpm test"
+  },
+  "devDependencies": {
+    "@hey-api/openapi-ts": "0.99.0",
+    "@types/node": "22.20.1",
+    "typescript": "5.9.3"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/UInt8Co/stringist-sdk.git",
+    "directory": "packages/cli"
+  }
+}