generaltranslation 8.1.6 → 8.1.7

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # generaltranslation
 
+## 8.1.7
+
+### Patch Changes
+
+- [#960](https://github.com/generaltranslation/gt/pull/960) [`eb07e8c`](https://github.com/generaltranslation/gt/commit/eb07e8ce1b610551437b40f96c72ac76d0af7b67) Thanks [@ErnestM1234](https://github.com/ErnestM1234)! - chore: upload shared id for static content
+
 ## 8.1.6
 
 ### Patch Changes

package/README.md

@@ -1,116 +1,25 @@
 <p align="center">
-  <a href="https://generaltranslation.com" target="_blank">
-    <img src="https://generaltranslation.com/gt-logo-light.svg" alt="General Translation" width="100" height="100">
+  <a href="https://generaltranslation.com/docs">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://generaltranslation.com/gt-logo-dark.svg">
+      <source media="(prefers-color-scheme: light)" srcset="https://generaltranslation.com/gt-logo-light.svg">
+      <img alt="General Translation" src="https://generaltranslation.com/gt-logo-light.svg" width="100" height="100">
+    </picture>
   </a>
 </p>
 
-# General Translation
-
-This is the core library for General Translation. It is used in `gt-react` and `gt-next`.
-
-See our [docs](https://generaltranslation.com/docs) for more information including guides, examples, and API references.
-
-## Development
-
-### Prerequisites
-
-- Node.js (>= 16.0.0)
-- npm or yarn
-
-### Installation
-
-```bash
-npm install
-```
-
-## Testing
-
-This project uses [Vitest](https://vitest.dev/) for testing with two types of tests:
-
-### Test Types
-
-- **Unit Tests** (`__tests__/`): Fast, isolated tests with mocking
-
-### Running Tests
-
-```bash
-# Run all tests (unit + e2e)
-npm test
-
-# Run only unit tests
-npm test -- __tests__
-
-# Run tests in watch mode
-npm run test:watch
-
-# Run specific test file
-npm test -- __tests__/logging/logger.test.ts
-
-# Run tests matching a pattern
-npm test -- -t "should handle translation"
-```
-
-### Environment Variables
-
-#### Required for E2E Tests
-
-Create a `.env` file in the project root with:
-
-```bash
-# GT API Configuration
-VITE_GT_API_KEY="your-dev-api-key"
-VITE_GT_PROJECT_ID="your-project-id"
-VITE_GT_RUNTIME_URL="http://localhost:10000"
-```
-
-> **Note**: E2E tests require a running GT runtime server at the specified URL. Without proper configuration, e2e tests will skip gracefully.
-
-#### Optional: Logger Configuration
-
-```bash
-# Set logging level for development/debugging
-_GT_LOG_LEVEL=debug  # Options: debug, info, warn, error (default: warn)
-```
+<p align="center">
+  <a href="https://generaltranslation.com/docs"><strong>Documentation</strong></a> · <a href="https://github.com/generaltranslation/gt/issues">Report Bug</a>
+</p>
 
-### Test Configuration
+# generaltranslation
 
-- **Parallel Execution**: Tests run in parallel using 2-4 threads for optimal performance
-- **Timeout**: 15 seconds per test (suitable for network-dependent e2e tests)
-- **Environment**: Node.js environment for testing
+Core library for General Translation. Used internally by `gt-react` and `gt-next`.
 
-### Example Test Commands
+## Installation
 
 ```bash
-# Development workflow
-_GT_LOG_LEVEL=debug npm test --reporter=verbose
-
-# Quick unit test validation
-npm test -- __tests__
-
-# Test specific functionality
-npm test -- -t "logger" --reporter=verbose
-
-# Watch mode for development
-npm run test:watch -- __tests__/
+npm install generaltranslation
 ```
 
-### Test Structure
-
-```
-__tests__/           # Unit tests with mocking
-├── logging/         # Logger functionality tests
-└── translate/       # Translation logic tests
-```
-
-## Contributing
-
-We welcome any contributions to our libraries. Please submit a pull request!
-
-### Development Workflow
-
-1. Install dependencies: `npm install`
-2. Set up environment variables (see Testing section)
-3. Run tests: `npm test`
-4. Make your changes
-5. Run tests again to ensure everything works
-6. Submit a pull request
+See the [full documentation](https://generaltranslation.com/docs) for guides and API reference.

package/dist/index.d.ts

@@ -159,6 +159,23 @@ type FileQueryResult = {
     }[];
 };
 
+type EnqueueFilesResult = {
+    jobData: {
+        [jobId: string]: {
+            sourceFileId: string;
+            fileId: string;
+            versionId: string;
+            branchId: string;
+            targetLocale: string;
+            projectId: string;
+            force: boolean;
+            modelProvider?: string;
+        };
+    };
+    locales: string[];
+    message: string;
+};
+
 type FileFormat = 'GTJSON' | 'JSON' | 'YAML' | 'MDX' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT';
 /**
  * File object structure for referencing files
@@ -201,23 +218,6 @@ type DownloadFileBatchResult = {
     count: number;
 };
 
-type EnqueueFilesResult = {
-    jobData: {
-        [jobId: string]: {
-            sourceFileId: string;
-            fileId: string;
-            versionId: string;
-            branchId: string;
-            targetLocale: string;
-            projectId: string;
-            force: boolean;
-            modelProvider?: string;
-        };
-    };
-    locales: string[];
-    message: string;
-};
-
 /**
  * Metadata stored alongside GTJSON file entries.
  * Keys correspond to the entry id/hash in the GTJSON body.

package/dist/types-dir/api/enqueueFiles.d.ts

@@ -1,6 +1,8 @@
 import { JsxChildren } from '../jsx/content';
 export type Updates = ({
-    metadata: Record<string, any>;
+    metadata: Record<string, any> & {
+        staticId?: string;
+    };
 } & ({
     dataFormat: 'JSX';
     source: JsxChildren;

package/dist/types-dir/api/file.d.ts

@@ -1,4 +1,5 @@
 import { DataFormat } from '../jsx/content';
+import { Updates } from './enqueueFiles';
 import { Entry } from './entry';
 export type FileFormat = 'GTJSON' | 'JSON' | 'YAML' | 'MDX' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT';
 export type FileMetadata = {
@@ -23,7 +24,7 @@ export type File = {
  */
 export type FileToUpload = {
     content: string;
-    formatMetadata?: Record<string, any>;
+    formatMetadata?: Record<string, any> | Updates[number]['metadata'];
     incomingBranchId?: string;
     checkedOutBranchId?: string;
     locale: string;

package/dist/types.d.ts

@@ -152,6 +152,63 @@ type CheckFileTranslationsOptions = {
     timeout?: number;
 };
 
+type Updates = ({
+    metadata: Record<string, any> & {
+        staticId?: string;
+    };
+} & ({
+    dataFormat: 'JSX';
+    source: JsxChildren;
+} | {
+    dataFormat: 'ICU';
+    source: string;
+} | {
+    dataFormat: 'I18NEXT';
+    source: string;
+} | {
+    dataFormat: 'DATE_FNS';
+    source: string;
+}))[];
+/**
+ * Options for enqueueing files
+ * @param publish - Whether to publish the files
+ * @param requireApproval - Whether to require approval for the files
+ * @param description - Optional description for the project
+ * @param sourceLocale - The project's source locale
+ * @param targetLocales - The locales to translate the files to
+ * @param version - Optional custom version ID to specify
+ * @param timeout - Optional timeout for the request
+ * @param modelProvider - Optional model provider to use
+ */
+type EnqueueFilesOptions = {
+    publish?: boolean;
+    requireApproval?: boolean;
+    description?: string;
+    sourceLocale?: string;
+    targetLocales: string[];
+    version?: string;
+    _versionId?: string;
+    timeout?: number;
+    modelProvider?: string;
+    force?: boolean;
+};
+type EnqueueFilesResult = {
+    jobData: {
+        [jobId: string]: {
+            sourceFileId: string;
+            fileId: string;
+            versionId: string;
+            branchId: string;
+            targetLocale: string;
+            projectId: string;
+            force: boolean;
+            modelProvider?: string;
+        };
+    };
+    locales: string[];
+    message: string;
+};
+
 type FileFormat = 'GTJSON' | 'JSON' | 'YAML' | 'MDX' | 'MD' | 'TS' | 'JS' | 'HTML' | 'TXT';
 /**
  * File object structure for uploading files
@@ -163,7 +220,7 @@ type FileFormat = 'GTJSON' | 'JSON' | 'YAML' | 'MDX' | 'MD' | 'TS' | 'JS' | 'HTM
  */
 type FileToUpload = {
     content: string;
-    formatMetadata?: Record<string, any>;
+    formatMetadata?: Record<string, any> | Updates[number]['metadata'];
     incomingBranchId?: string;
     checkedOutBranchId?: string;
     locale: string;
@@ -217,61 +274,6 @@ type FetchTranslationsResult = {
     translations: RetrievedTranslations;
 };
 
-type Updates = ({
-    metadata: Record<string, any>;
-} & ({
-    dataFormat: 'JSX';
-    source: JsxChildren;
-} | {
-    dataFormat: 'ICU';
-    source: string;
-} | {
-    dataFormat: 'I18NEXT';
-    source: string;
-} | {
-    dataFormat: 'DATE_FNS';
-    source: string;
-}))[];
-/**
- * Options for enqueueing files
- * @param publish - Whether to publish the files
- * @param requireApproval - Whether to require approval for the files
- * @param description - Optional description for the project
- * @param sourceLocale - The project's source locale
- * @param targetLocales - The locales to translate the files to
- * @param version - Optional custom version ID to specify
- * @param timeout - Optional timeout for the request
- * @param modelProvider - Optional model provider to use
- */
-type EnqueueFilesOptions = {
-    publish?: boolean;
-    requireApproval?: boolean;
-    description?: string;
-    sourceLocale?: string;
-    targetLocales: string[];
-    version?: string;
-    _versionId?: string;
-    timeout?: number;
-    modelProvider?: string;
-    force?: boolean;
-};
-type EnqueueFilesResult = {
-    jobData: {
-        [jobId: string]: {
-            sourceFileId: string;
-            fileId: string;
-            versionId: string;
-            branchId: string;
-            targetLocale: string;
-            projectId: string;
-            force: boolean;
-            modelProvider?: string;
-        };
-    };
-    locales: string[];
-    message: string;
-};
-
 /**
  * Metadata stored alongside GTJSON file entries.
  * Keys correspond to the entry id/hash in the GTJSON body.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "generaltranslation",
-  "version": "8.1.6",
+  "version": "8.1.7",
   "description": "A language toolkit for AI developers",
   "main": "dist/index.cjs.min.cjs",
   "module": "dist/index.esm.min.mjs",