generaltranslation 8.1.4 → 8.1.6

package/dist/types.d.ts

@@ -65,11 +65,11 @@ type JsxChild = string | JsxElement | Variable;
 /**
  * The format of the content
  */
-type DataFormat = 'JSX' | 'ICU' | 'I18NEXT';
+type DataFormat = 'JSX' | 'ICU' | 'I18NEXT' | 'DATE_FNS';
 /**
  * A content type representing JSX, ICU, and I18next messages
  */
-type Content = JsxChildren | IcuMessage | I18nextMessage;
+type Content = JsxChildren | IcuMessage | I18nextMessage | DateFnsMessage;
 /**
  * A content type representing JSX elements
  */
@@ -82,6 +82,10 @@ type IcuMessage = string;
  * A content type representing I18next messages
  */
 type I18nextMessage = string;
+/**
+ * A content type representing DateFns messages
+ */
+type DateFnsMessage = string;
 
 /**
  * ActionType is the type of action to perform on the request.
@@ -112,7 +116,7 @@ type EntryMetadata = {
     scriptCode?: string;
 };
 /**
- * GTRequest is a translation request object for {@link JsxChildren} | {@link IcuMessage} | {@link I18nextMessage}
+ * GTRequest is a translation request object for {@link JsxChildren} | {@link IcuMessage} | {@link I18nextMessage} | {@link DateFnsMessage}
  *
  * @param source - The source content to translate.
  * @param targetLocale - The target locale to translate to.
@@ -162,6 +166,7 @@ type FileToUpload = {
     formatMetadata?: Record<string, any>;
     incomingBranchId?: string;
     checkedOutBranchId?: string;
+    locale: string;
 } & Omit<FileReference, 'branchId'> & {
     branchId?: string;
 };
@@ -223,6 +228,9 @@ type Updates = ({
 } | {
     dataFormat: 'I18NEXT';
     source: string;
+} | {
+    dataFormat: 'DATE_FNS';
+    source: string;
 }))[];
 /**
  * Options for enqueueing files
@@ -264,6 +272,36 @@ type EnqueueFilesResult = {
     message: string;
 };
 
+/**
+ * Metadata stored alongside GTJSON file entries.
+ * Keys correspond to the entry id/hash in the GTJSON body.
+ */
+type GTJsonFormatMetadata = Record<string, {
+    context?: string;
+    id?: string;
+    domain?: string;
+    maxChars?: number;
+    dataFormat?: 'JSX' | 'ICU' | 'I18NEXT' | 'DATE_FNS';
+    requestVersion?: number;
+    approved_at?: string | null;
+    approved_by?: string | null;
+    hash?: string;
+    filePaths?: string[];
+}>;
+type FileUpload = {
+    branchId?: string;
+    incomingBranchId?: string;
+    checkedOutBranchId?: string;
+    content: string;
+    fileName: string;
+    fileFormat: FileFormat;
+    dataFormat?: DataFormat;
+    locale: string;
+    formatMetadata?: GTJsonFormatMetadata;
+    versionId?: string;
+    fileId?: string;
+};
+
 type EnqueueEntriesOptions = {
     timeout?: number;
     sourceLocale?: string;
@@ -302,8 +340,8 @@ type TypedResult = {
     translation: JsxChildren;
     dataFormat: 'JSX';
 } | {
-    translation: I18nextMessage | IcuMessage;
-    dataFormat: 'ICU' | 'I18NEXT';
+    translation: I18nextMessage | IcuMessage | DateFnsMessage;
+    dataFormat: 'ICU' | 'I18NEXT' | 'DATE_FNS';
 };
 /**
  * RequestError is a type that represents an error that occurred during a translation request.
@@ -511,4 +549,4 @@ type TranslationRequestConfig = {
 };
 
 export { HTML_CONTENT_PROPS };
-export type { BranchDataResult, BranchQuery, CheckFileTranslationsOptions, CheckJobStatusResult, Content, ContentTranslationResult, CustomMapping, DataFormat, DownloadFileBatchOptions, DownloadFileBatchResult, DownloadFileOptions, DownloadedFile, EnqueueEntriesOptions, EnqueueEntriesResult, EnqueueFilesOptions, EnqueueFilesResult, Entry, ActionType as EntryActionType, EntryMetadata, FetchTranslationsOptions, FetchTranslationsResult, FileDataQuery, FileDataResult, FileFormat, FileReference, FileToUpload, FileTranslationQuery, FormatVariables, GTProp, HashMetadata, HtmlContentPropKeysRecord, HtmlContentPropValuesRecord, I18nextMessage, IcuMessage, IcuTranslationResult, JobStatus, JsxChild, JsxChildren, JsxElement, JsxTranslationResult, LocaleProperties, Metadata, Request, RetrievedTranslations, SubmitUserEditDiff, SubmitUserEditDiffsPayload, Transformation, TransformationPrefix, TranslateManyResult, TranslationError, TranslationRequestConfig, TranslationResult, TranslationResultReference, TranslationStatusResult, Update, Updates, Variable, VariableTransformationSuffix, VariableType, _Content };
+export type { BranchDataResult, BranchQuery, CheckFileTranslationsOptions, CheckJobStatusResult, Content, ContentTranslationResult, CustomMapping, DataFormat, DateFnsMessage, DownloadFileBatchOptions, DownloadFileBatchResult, DownloadFileOptions, DownloadedFile, EnqueueEntriesOptions, EnqueueEntriesResult, EnqueueFilesOptions, EnqueueFilesResult, Entry, ActionType as EntryActionType, EntryMetadata, FetchTranslationsOptions, FetchTranslationsResult, FileDataQuery, FileDataResult, FileFormat, FileReference, FileToUpload, FileTranslationQuery, FileUpload, FormatVariables, GTProp, HashMetadata, HtmlContentPropKeysRecord, HtmlContentPropValuesRecord, I18nextMessage, IcuMessage, IcuTranslationResult, JobStatus, JsxChild, JsxChildren, JsxElement, JsxTranslationResult, LocaleProperties, Metadata, Request, RetrievedTranslations, SubmitUserEditDiff, SubmitUserEditDiffsPayload, Transformation, TransformationPrefix, TranslateManyResult, TranslationError, TranslationRequestConfig, TranslationResult, TranslationResultReference, TranslationStatusResult, Update, Updates, Variable, VariableTransformationSuffix, VariableType, _Content };

package/dist/types.esm.min.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"types.esm.min.mjs","sources":["../src/types-dir/jsx/content.ts"],"sourcesContent":["import { Variable } from './variables';\n\n/**\n * Map of data-_gt properties to their corresponding React props\n */\nexport const HTML_CONTENT_PROPS = {\n  pl: 'placeholder',\n  ti: 'title',\n  alt: 'alt',\n  arl: 'aria-label',\n  arb: 'aria-labelledby',\n  ard: 'aria-describedby',\n} as const;\n\nexport type HtmlContentPropKeysRecord = Partial<\n  Record<keyof typeof HTML_CONTENT_PROPS, string>\n>;\nexport type HtmlContentPropValuesRecord = Partial<\n  Record<(typeof HTML_CONTENT_PROPS)[keyof typeof HTML_CONTENT_PROPS], string>\n>;\n\n/**\n * GTProp is an internal property used to contain data for translating and rendering elements.\n * note, transformations are only read on the server side if they are 'plural' or 'branch'\n */\nexport type GTProp = {\n  b?: Record<string, JsxChildren>; // Branches\n  t?: 'p' | 'b'; // Branch Transformation\n} & HtmlContentPropKeysRecord;\n\nexport type JsxElement = {\n  t?: string; // tag name\n  i?: number; // id\n  d?: GTProp; // GT data\n  c?: JsxChildren; // children\n};\n\nexport type JsxChild = string | JsxElement | Variable;\n\n/**\n * The format of the content\n */\nexport type DataFormat = 'JSX' | 'ICU' | 'I18NEXT';\n\n/**\n * A content type representing JSX, ICU, and I18next messages\n */\nexport type Content = JsxChildren | IcuMessage | I18nextMessage;\n\n/**\n * A content type representing JSX elements\n */\nexport type JsxChildren = JsxChild | JsxChild[];\n\n/**\n * A content type representing ICU messages\n */\nexport type IcuMessage = string;\n\n/**\n * A content type representing I18next messages\n */\nexport type I18nextMessage = string;\n"],"names":["HTML_CONTENT_PROPS","pl","ti","alt","arl","arb","ard"],"mappings":"AAKO,IAAMA,EAAqB,CAChCC,GAAI,cACJC,GAAI,QACJC,IAAK,MACLC,IAAK,aACLC,IAAK,kBACLC,IAAK"}
+{"version":3,"file":"types.esm.min.mjs","sources":["../src/types-dir/jsx/content.ts"],"sourcesContent":["import { Variable } from './variables';\n\n/**\n * Map of data-_gt properties to their corresponding React props\n */\nexport const HTML_CONTENT_PROPS = {\n  pl: 'placeholder',\n  ti: 'title',\n  alt: 'alt',\n  arl: 'aria-label',\n  arb: 'aria-labelledby',\n  ard: 'aria-describedby',\n} as const;\n\nexport type HtmlContentPropKeysRecord = Partial<\n  Record<keyof typeof HTML_CONTENT_PROPS, string>\n>;\nexport type HtmlContentPropValuesRecord = Partial<\n  Record<(typeof HTML_CONTENT_PROPS)[keyof typeof HTML_CONTENT_PROPS], string>\n>;\n\n/**\n * GTProp is an internal property used to contain data for translating and rendering elements.\n * note, transformations are only read on the server side if they are 'plural' or 'branch'\n */\nexport type GTProp = {\n  b?: Record<string, JsxChildren>; // Branches\n  t?: 'p' | 'b'; // Branch Transformation\n} & HtmlContentPropKeysRecord;\n\nexport type JsxElement = {\n  t?: string; // tag name\n  i?: number; // id\n  d?: GTProp; // GT data\n  c?: JsxChildren; // children\n};\n\nexport type JsxChild = string | JsxElement | Variable;\n\n/**\n * The format of the content\n */\nexport type DataFormat = 'JSX' | 'ICU' | 'I18NEXT' | 'DATE_FNS';\n\n/**\n * A content type representing JSX, ICU, and I18next messages\n */\nexport type Content =\n  | JsxChildren\n  | IcuMessage\n  | I18nextMessage\n  | DateFnsMessage;\n\n/**\n * A content type representing JSX elements\n */\nexport type JsxChildren = JsxChild | JsxChild[];\n\n/**\n * A content type representing ICU messages\n */\nexport type IcuMessage = string;\n\n/**\n * A content type representing I18next messages\n */\nexport type I18nextMessage = string;\n\n/**\n * A content type representing DateFns messages\n */\nexport type DateFnsMessage = string;\n"],"names":["HTML_CONTENT_PROPS","pl","ti","alt","arl","arb","ard"],"mappings":"AAKO,IAAMA,EAAqB,CAChCC,GAAI,cACJC,GAAI,QACJC,IAAK,MACLC,IAAK,aACLC,IAAK,kBACLC,IAAK"}

package/package.json

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