@shareyou/core 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 IzayoiKyomu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,96 @@
-# Temporary Holding Version
+# Shareyou
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Shareyou provides one entry point for all implemented Shareyou utility packages.
+Import the default `shareyou` object to access utilities through `shareyou.xxx`,
+or use named imports for individual functions and types.
+
+Requires Node.js 22 or newer. This package uses ES modules and includes TypeScript
+declarations. TypeScript 5.4 or newer is required for template type inference.
+
+## Installation
+
+```sh
+pnpm add @shareyou/core
+```
+
+## Usage
+
+```ts
+import shareyou from '@shareyou/core';
+
+const text = shareyou.templater('Hello, {{name:string}}! {{count:number!}} messages.', {
+  name: 'Shareyou',
+  count: 3,
+});
+// Hello, Shareyou! 3 messages.
+```
+
+The default and named `shareyou` exports reference the same aggregate object.
+You can choose a shorter local name when importing it:
+
+```ts
+import _ from '@shareyou/core';
+
+_.templater('Hello, {{name}}!', { name: 'Shareyou' });
+```
+
+Functions and types are also available as named exports:
+
+```ts
+import { templater, type TemplateParameters } from '@shareyou/core';
+
+const parameters: TemplateParameters<'{{count:number!}}'> = { count: 3 };
+const text: string = templater('{{count:number!}} messages.', parameters);
+```
+
+Re-exports preserve each function's original implementation and type inference.
+Templater still returns a primitive string synchronously, warns on non-strict
+type mismatches, and throws on missing parameters or strict type mismatches.
+
+## Included packages
+
+| Package | Object API | Named exports |
+| --- | --- | --- |
+| `@shareyou/templater` | `shareyou.templater` | `templater`, `TemplateParameters`, `TemplateParameterNames` |
+| `@shareyou/i18n` | `shareyou.i18n` (factory) | `createI18n`, `I18nError`, i18n interfaces and types |
+
+Create an isolated translator through the object API or named factory:
+
+```ts
+import shareyou, { createI18n } from '@shareyou/core';
+
+console.log(shareyou.i18n === createI18n); // true
+const i18n = shareyou.i18n({
+  locale: 'en',
+  messages: { en: { cart: '{{#plural count}}{{:one}}{{#}} item{{:other}}{{#}} items{{/plural}}' } },
+});
+i18n.t('cart', { count: 3 }); // 3 items
+```
+
+See [the i18n package documentation](https://shareyou.overl0ad1ng.com/docs/i18n) for templater syntax, generated
+argument contracts, fallback and formatting. Install the standalone i18n package
+directly when using its type-generation CLI.
+
+Independent packages remain usable on their own. Importing this aggregate does
+not register methods globally or modify the objects exported by those packages.
+
+## Local development
+
+From the repository root:
+
+```sh
+pnpm install
+pnpm build
+pnpm test
+pnpm typecheck
+pnpm --filter @shareyou/core demo
+pnpm --filter @shareyou/core pack
+```
+
+Workspace dependencies resolve to local packages during development. Packing
+converts `workspace:^` into a regular version range, so the published aggregate
+depends on the standalone packages. Publish dependency versions before publishing
+the aggregate that requires them.
+
+To include another implemented package, add it to `dependencies`, re-export its
+public API in `src/index.ts`, and add its utilities to the aggregate object.

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+import { createI18n } from '@shareyou/i18n';
+export * from '@shareyou/templater';
+export * from '@shareyou/i18n';
+export declare const shareyou: {
+    templater: typeof import("@shareyou/templater").templater;
+    i18n: typeof createI18n;
+};
+export default shareyou;

package/dist/index.js

@@ -0,0 +1,6 @@
+import { shareyou as templaterUtilities } from '@shareyou/templater';
+import { createI18n } from '@shareyou/i18n';
+export * from '@shareyou/templater';
+export * from '@shareyou/i18n';
+export const shareyou = { ...templaterUtilities, i18n: createI18n };
+export default shareyou;

package/package.json

@@ -1,6 +1,52 @@
 {
   "name": "@shareyou/core",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.0",
+  "description": "A unified entry point for Shareyou utilities",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "sideEffects": false,
+  "engines": {
+    "node": ">=22"
+  },
+  "keywords": [
+    "shareyou",
+    "utilities",
+    "typescript"
+  ],
+  "author": {
+    "name": "IzayoiKyomu",
+    "email": "kyomu@overl0ad1ng.com"
+  },
+  "license": "MIT",
+  "homepage": "https://shareyou.overl0ad1ng.com/docs",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@shareyou/i18n": "^0.1.0",
+    "@shareyou/templater": "^0.1.0"
+  },
+  "devDependencies": {
+    "typescript": "7.0.2"
+  },
+  "scripts": {
+    "clean": "node -e \"require('node:fs').rmSync('dist',{recursive:true,force:true})\"",
+    "build": "pnpm run clean && tsc -p tsconfig.json",
+    "test": "pnpm run build && node --test",
+    "typecheck": "pnpm run build && tsc -p tsconfig.typecheck.json",
+    "demo": "pnpm run build && node examples/node.mjs"
+  }
 }