gt-i18n 0.0.0 → 0.1.0

package/dist/logs/logger.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    warn(message: string): void;
+    error(message: string): void;
+    info(message: string): void;
+    debug(message: string): void;
+};
+export default _default;

package/dist/logs/warnings.d.ts

@@ -0,0 +1 @@
+export declare const interpolationFailureWarning = "gt-i18n warning: String interpolation failed.";

package/dist/msg/decodeMsg.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Extracts the original interpolated message string.
+ * If the message cannot be decoded (i.e., it does not contain a colon separator),
+ * the input is returned as-is.
+ * @param encodedMsg The message to decode.
+ * @returns The decoded message, or the input if it cannot be decoded.
+ */
+export declare function decodeMsg(encodedMsg: string): string;
+export declare function decodeMsg<T extends null | undefined>(encodedMsg: T): T;
+export declare function decodeMsg<T extends string | null | undefined>(encodedMsg: T): T extends string ? string : T;

package/dist/msg/decodeOptions.d.ts

@@ -0,0 +1,7 @@
+import { InlineTranslationOptions } from '../types';
+/**
+ * Decodes the options from an encoded message.
+ * @param encodedMsg The message to decode.
+ * @returns The decoded options.
+ */
+export declare function decodeOptions(encodedMsg: string): InlineTranslationOptions | null;

package/dist/msg/index.d.ts

@@ -0,0 +1,3 @@
+export * from './msg';
+export * from './decodeMsg';
+export * from './decodeOptions';

package/dist/msg/msg.d.ts

@@ -0,0 +1,29 @@
+import { InlineTranslationOptions } from '../types';
+/**
+ * Registers a message to be translated. Returns the message unchanged if no options are provided.
+ * @param message The message to encode.
+ * @param options The options to encode.
+ * @returns The encoded message.
+ *
+ * @note - This function registers the message before the build process. The actual translation does not
+ * occur until the m() function is invoked.
+ *
+ * @note - Message format
+ * A message is broken into two parts separated by colons:
+ * - interpolated content - the content with interpolated variables
+ * - hash + options - a unique identifier for the source content and options for the translation
+ *
+ * @example - Basic usage
+ *
+ * ```jsx
+ * import { msg } from 'gt-i18n';
+ * const message1 = msg('Hello, World!');
+ * console.log(message1); // "Hello, World!"
+ * const message2 = msg('Hello, {name}!', { name: 'Brian' });
+ * console.log(message2); // "Hello, Brian:eyIkX2hhc2giOiAiMHgxMjMiLCAiJF9zb3VyY2UiOiAiSGVsbG8sIHtuYW1lfSEiLCAibmFtZSI6ICJCcmlhbiJ9"
+ * ```
+ * eyIkX2hhc2giOiAiMHgxMjMiLCAiJF9zb3VyY2UiOiAiSGVsbG8sIHtuYW1lfSEiLCAibmFtZSI6ICJCcmlhbiJ9
+ * encodes to {"$_hash": "0x123", "$_source": "Hello, {name}!", "name": "Brian"}
+ */
+export declare function msg<T extends string>(message: T): T;
+export declare function msg<T extends string>(message: T, options: InlineTranslationOptions): string;

package/dist/msg/utils/icuMessageContainsVariables.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Checks if a message contains variables.
+ * @param message - The message to check.
+ * @returns True if the message contains variables, false otherwise.
+ *
+ * @example
+ * ```jsx
+ * import { icuMessageContainsVariables } from 'gt-i18n/messages/utils';
+ * const message = 'Hello {name}';
+ * console.log(icuMessageContainsVariables(message)); // true
+ * ```
+ */
+export declare function icuMessageContainsVariables(message: string): boolean;

package/dist/types.cjs.min.cjs

@@ -0,0 +1,2 @@
+"use strict";
+//# sourceMappingURL=types.cjs.min.cjs.map

package/dist/types.cjs.min.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.cjs.min.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/dist/types.d.ts

@@ -0,0 +1,17 @@
+type BaseTranslationOptions = Record<string, any>;
+type DictionaryTranslationOptions = BaseTranslationOptions;
+type InlineTranslationOptions = BaseTranslationOptions & {
+    $context?: string;
+    $id?: string;
+    $_hash?: string;
+    /** @deprecated use {@link EncodedTranslationOptions} instead */
+    $_source?: string;
+};
+type InlineResolveOptions = BaseTranslationOptions;
+type RuntimeTranslationOptions = {
+    locale?: string;
+} & Omit<InlineTranslationOptions, 'id'>;
+type MFunctionType = <T extends string | null | undefined>(encodedMsg: T, options?: Record<string, any>) => T extends string ? string : T;
+type GTFunctionType = (message: string, options?: InlineTranslationOptions) => string;
+
+export type { BaseTranslationOptions, DictionaryTranslationOptions, GTFunctionType, InlineResolveOptions, InlineTranslationOptions, MFunctionType, RuntimeTranslationOptions };

package/dist/types.esm.min.mjs

@@ -0,0 +1,2 @@
+
+//# sourceMappingURL=types.esm.min.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.esm.min.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/dist/utils/extractVariables.d.ts

@@ -0,0 +1,8 @@
+import { BaseTranslationOptions } from '../types';
+/**
+ * Given an object of options, returns an object with no gt-related options
+ *
+ * TODO: next major version, this should extract any sugar syntax options
+ * TODO: next major version, options should be Record<string, string>
+ */
+export declare function extractVariables<T extends BaseTranslationOptions>(options: T): BaseTranslationOptions;

package/package.json

@@ -1,12 +1,102 @@
 {
   "name": "gt-i18n",
-  "version": "0.0.0",
-  "description": "",
-  "license": "UNLICENSED",
-  "author": "",
-  "type": "commonjs",
-  "main": "index.js",
+  "version": "0.1.0",
+  "description": "Pure JS i18n library for General Translation",
+  "main": "dist/index.cjs.min.cjs",
+  "module": "dist/index.esm.min.mjs",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "CHANGELOG.md"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/generaltranslation/gt.git"
+  },
+  "keywords": [
+    "language",
+    "translation",
+    "internationalization",
+    "localization",
+    "translate",
+    "locale",
+    "i18n",
+    "toolkit",
+    "core"
+  ],
+  "author": "General Translation, Inc.",
+  "license": "FSL-1.1-ALv2",
+  "bugs": {
+    "url": "https://github.com/generaltranslation/gt/issues"
+  },
+  "homepage": "https://generaltranslation.com/",
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^28.0.1",
+    "@rollup/plugin-node-resolve": "^16.0.1",
+    "@rollup/plugin-terser": "^0.4.4",
+    "@rollup/plugin-typescript": "^12.1.1",
+    "@types/node": "^20.14.9",
+    "rollup": "^4.24.0",
+    "rollup-plugin-dts": "^6.1.1",
+    "tslib": "^2.8.0",
+    "typescript": "^5.6.2"
+  },
+  "typescript": {
+    "definition": "dist/index.d.ts"
+  },
+  "dependencies": {
+    "generaltranslation": "8.0.4",
+    "@generaltranslation/supported-locales": "2.0.27"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.cjs.min.cjs",
+      "import": "./dist/index.esm.min.mjs"
+    },
+    "./types": {
+      "types": "./dist/types.d.ts",
+      "require": "./dist/types.cjs.min.cjs",
+      "import": "./dist/types.esm.min.mjs"
+    },
+    "./fallbacks": {
+      "types": "./dist/fallbacks.d.ts",
+      "require": "./dist/fallbacks.cjs.min.cjs",
+      "import": "./dist/fallbacks.esm.min.mjs"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      "types": [
+        "./dist/types.d.ts"
+      ],
+      "fallbacks": [
+        "./dist/fallbacks.d.ts"
+      ]
+    }
+  },
+  "compilerOptions": {
+    "baseUrl": ".",
+    "paths": {
+      "gt-i18n/types": [
+        "/dist/types"
+      ],
+      "gt-i18n/fallbacks": [
+        "/dist/fallbacks"
+      ]
+    }
+  },
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "build:release": "pnpm run build:clean",
+    "build:clean": "sh ../../scripts/clean.sh && pnpm run build",
+    "build": "rollup -c",
+    "lint": "eslint \"src/**/*.{js,ts}\"",
+    "lint:fix": "eslint \"src/**/*.{js,ts}\" --fix",
+    "test": "vitest run --config=./vitest.config.ts",
+    "test:watch": "vitest --config=./vitest.config.ts",
+    "release": "pnpm run build:clean && pnpm publish",
+    "release:alpha": "pnpm run build:clean && pnpm publish --tag alpha",
+    "release:beta": "pnpm run build:clean && pnpm publish --tag beta",
+    "release:latest": "pnpm run build:clean && pnpm publish --tag latest"
   }
-}
+}

package/README.md

@@ -1,3 +0,0 @@
-# gt-i18n
-
-Placeholder while we work on this! :)