@intlayer/api 4.0.0 → 4.0.3

package/README.md

@@ -17,224 +17,42 @@
   </a>
 </div>
 
-# Intlayer: Next-Level Content Management in JavaScript
+# @intlayer/api: interact with Intlayer API
 
-**Intlayer** is an internationalization library designed specifically for JavaScript developers. It allow the declaration of your content everywhere in your code. It converts declaration of multilingual content into structured dictionaries to integrate easily in your code. Using TypeScript, **Intlayer** make your development stronger and more efficient.
+**Intlayer** is a suite of packages designed specifically for JavaScript developers. It is compatible with frameworks like React, React, and Express.js.
 
-## Example of usage
+The **`@intlayer/api`** package is a SDK (Software Development Kit) to interact with the Intlayer API. It provides a set of functions to audit content declaration, interact with organizations, projects, and user, etc.
 
-```bash
-.
-├── ClientComponent
-│   ├── index.content.ts
-│   └── index.tsx
-└── ServerComponent
-    ├── index.content.ts
-    └── index.tsx
-```
-
-```tsx
-// ./ClientComponent/index.content.ts
-
-import { type DeclarationContent, t } from "intlayer";
+## Usage
 
-const clientComponentContent = {
-  key: "client-component",
-  content: {
-    myTranslatedContent: t({
-      en: "Hello World",
-      fr: "Bonjour le monde",
-      es: "Hola Mundo",
-    }),
-  },
-} satisfies DeclarationContent;
+```ts
+import { intlayerAPI } from "@intlayer/api";
 
-export default clientComponentContent;
+intlayerAPI.user.getUser({
+  ids: ["user-id-1", "user-id-2"],
+});
 ```
 
-```tsx
-// ./ClientComponent/index.tsx
-"use client";
-
-import { useIntlayer } from "next-intlayer";
-
-export const ClientComponent = () => {
-  const { myTranslatedContent } = useIntlayer("client-component");
-
-  return <span>{myTranslatedContent}</span>;
-};
-```
-
-## Why Choose Intlayer?
-
-- **JavaScript-Powered Content Management**: Harness the flexibility of JavaScript to define and manage your content efficiently.
-- **Type-Safe Environment**: Leverage TypeScript to ensure all your content definitions are precise and error-free.
-- **Integrated Content Files**: Keep your translations close to their respective components, enhancing maintainability and clarity.
+## Installation
 
-## intlayer package
+Install the necessary package using your preferred package manager:
 
-`intlayer` package intend to declare your content in a structured way, using JavaScript.
-
-To build dictionaries from this declaration, you can use [intlayer-cli](https://github.com/aymericzip/intlayer/blob/main/packages/intlayer-cli/readme.md).
-And to interpret intlayer dictionaries you can interpreters, such as [react-intlayer](https://github.com/aymericzip/intlayer/blob/main/packages/react-intlayer/README.md) [next-intlayer](https://github.com/aymericzip/intlayer/blob/main/packages/next-intlayer/README.md)
-
-## Getting Started with Intlayer
-
-[See how to use intlayer with NextJS](https://github.com/aymericzip/intlayer/blob/main/README.md)
-
-### Install Package
-
-Install the necessary packages using npm:
-
-```bash
-npm install intlayer
+```bash packageManager="npm"
+npm install @intlayer/api
 ```
 
-```bash
-yarn add intlayer
+```bash packageManager="pnpm"
+pnpm add @intlayer/api
 ```
 
-```bash
-pnpm add intlayer
+```bash packageManager="yarn"
+yarn add @intlayer/api
 ```
 
-### Manage Your Content
-
-Create and manage your content dictionaries:
-
-#### Using typescript
-
-```typescript
-// src/app/[locale]/page.content.ts
-import { t, enu, type DeclarationContent } from "intlayer";
+## Read about Intlayer
 
-const pageContent = {
-  key: "page",
-  content: {
-    getStarted: {
-      main: t({
-        en: "Get started by editing",
-        fr: "Commencez par éditer",
-        es: "Comience por editar",
-      }),
-      pageLink: "src/app/page.tsx",
-    },
-    nestedContent: {
-      id: "enumeration",
-      numberOfCar: enu({
-        "<-1": "Less than minus one car",
-        "-1": "Minus one car",
-        "0": "No cars",
-        "1": "One car",
-        ">5": "Some cars",
-        ">19": "Many cars",
-      }),
-    },
-  },
-} satisfies DeclarationContent;
-
-// Content should be exported as default
-export default pageContent;
-```
-
-#### Using ECMAScript modules
-
-```javascript
-// src/app/[locale]/page.content.mjs
-
-import { t } from "intlayer";
-
-/** @type {import('intlayer').DeclarationContent} */
-const pageContent = {
-  "key": "page",
-  getStarted: {
-    main: t({
-      en: "Get started by editing",
-      fr: "Commencez par éditer",
-      es: "Comience por editar",
-    }),
-    pageLink: "src/app/page.tsx",
-  },
-  nestedContent: {
-    id: "enumeration",
-    numberOfCar: enu({
-      "<-1": "Less than minus one car",
-      "-1": "Minus one car",
-      0: "No cars",
-      1: "One car",
-      ">5": "Some cars",
-      ">19": "Many cars",
-    }),
-  },
-};
-
-// Content should be exported as default
-export default pageContent;
-```
-
-#### Using CommonJS modules
-
-```javascript
-// src/app/[locale]/page.content.cjs
-
-const { t } = require("intlayer");
-
-/** @type {import('intlayer').DeclarationContent} */
-const pageContent = {
-  "key": "page",
-  getStarted: {
-    main: t({
-      en: "Get started by editing",
-      fr: "Commencez par éditer",
-      es: "Comience por editar",
-    }),
-    pageLink: "src/app/page.tsx",
-  },
-  nestedContent: {
-    id: "enumeration",
-    numberOfCar: enu({
-      "<-1": "Less than minus one car",
-      "-1": "Minus one car",
-      0: "No cars",
-      1: "One car",
-      ">5": "Some cars",
-      ">19": "Many cars",
-    }),
-  },
-};
-
-// Content should be exported as default
-module.exports = pageContent;
-```
-
-#### Using JSON
-
-```json5
-// src/app/[locale]/page.content.json
-{
-  "key": "page",
-  getStarted: {
-    main: {
-      nodeType: "translation",
-      en: "Get started by editing",
-      fr: "Commencez par éditer",
-      es: "Comience por editar",
-    },
-    pageLink: "src/app/page.tsx",
-  },
-  nestedContent: {
-    id: "enumeration",
-    nodeType: "enumeration",
-    numberOfCar: {
-      "<-1": "Less than minus one car",
-      "-1": "Minus one car",
-      "0": "No cars",
-      "1": "One car",
-      ">5": "Some cars",
-      ">19": "Many cars",
-    },
-  },
-}
-```
+- [Intlayer Website](https://intlayer.org)
+- [Intlayer Documentation](https://intlayer.org/docs)
+- [Intlayer GitHub](https://github.com/aymericzip/intlayer)
 
-This version emphasizes ease of use, practical steps, and the professional application of Intlayer in a Next.js environment.
+- [Ask your questions to our smart documentation](https://intlayer.org/docs/chat)

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@intlayer/api",
-  "version": "4.0.0",
+  "version": "4.0.3",
   "private": false,
-  "description": "API",
+  "description": "SDK for interacting with the Intlayer API, enabling content auditing, and managing organizations, projects, and users.",
   "keywords": [
     "intlayer",
     "application",
@@ -57,7 +57,7 @@
     "./package.json"
   ],
   "dependencies": {
-    "@intlayer/config": "4.0.0"
+    "@intlayer/config": "4.0.3"
   },
   "devDependencies": {
     "@changesets/changelog-github": "0.5.0",
@@ -71,14 +71,14 @@
     "tsc-alias": "^1.8.10",
     "tsup": "^8.3.5",
     "typescript": "^5.7.3",
-    "@utils/ts-config-types": "1.0.4",
-    "@utils/tsup-config": "1.0.4",
+    "@intlayer/backend": "4.0.3",
     "@utils/eslint-config": "1.0.4",
-    "@intlayer/backend": "4.0.0",
+    "@utils/tsup-config": "1.0.4",
+    "@utils/ts-config-types": "1.0.4",
     "@utils/ts-config": "1.0.4"
   },
   "peerDependencies": {
-    "@intlayer/config": "4.0.0"
+    "@intlayer/config": "4.0.3"
   },
   "engines": {
     "node": ">=14.18"