Add Integration with Locales

alexcibotari · alexcibotari · commit f36187eb8984 · 2025-04-17T17:22:31.000+02:00
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/react/package.json b/packages/react/package.json
@@ -44,7 +44,7 @@
     "react-dom": "^17 || ^18 || ^19"
   },
   "dependencies": {
-    "@localess/js-client": "0.6.1-next.20250409-075652.0"
+    "@localess/js-client": "0.6.1-next.20250411-201255.0"
   },
   "devDependencies": {
     "@types/react": "18.3.12",
diff --git a/packages/react/src/index.ts b/packages/react/src/index.ts
@@ -1,7 +1,7 @@
 import type React from 'react';
-import {loadLocalessSync, LocalessClient, localessClient} from "@localess/js-client";
+import {loadLocalessSync, type LocalessClient, localessClient} from "@localess/js-client";
 import {FONT_BOLD, FONT_NORMAL} from "./console";
-import {LocalessOptions} from "./models";
+import {type LocalessOptions} from "./models";
 
 let _client: LocalessClient | undefined = undefined
 let _components: Record<string, React.ElementType> = {};
@@ -47,9 +47,10 @@ export function isSyncEnabled(): boolean {
 }
 
 // Client + Edit
-export {llEditable, LocalessClient} from '@localess/js-client'
+export {llEditable} from '@localess/js-client'
+export type {LocalessClient} from '@localess/js-client'
 // Sync
-export {LocalessSync, EventToApp, EventCallback, EventToAppType} from '@localess/js-client'
+export type {LocalessSync, EventToApp, EventCallback, EventToAppType} from '@localess/js-client'
 // Models
 export type * from './models';
 // Component
diff --git a/playgrounds/next15/openapitools.json b/playgrounds/next15/openapitools.json
@@ -0,0 +1,21 @@
+{
+  "$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json",
+  "spaces": 2,
+  "generator-cli": {
+    "version": "7.8.0",
+    "generators": {
+      "v3.0": {
+        "generatorName": "typescript-axios",
+        "output": "./src/shared/generated/localess",
+        "glob": "./open-api/localess.json",
+        "skipValidateSpec": true,
+        "apiPackage": "api",
+        "modelPackage": "model",
+        "additionalProperties": {
+          "useSingleRequestParameter": true,
+          "withSeparateModelsAndApi": true
+        }
+      }
+    }
+  }
+}
diff --git a/playgrounds/next15/package.json b/playgrounds/next15/package.json
@@ -2,11 +2,13 @@
   "name": "next15",
   "version": "0.1.0",
   "private": true,
+  "type": "module",
   "scripts": {
     "dev": "next dev --turbopack",
     "build": "next build",
     "start": "next start",
-    "lint": "next lint"
+    "lint": "next lint",
+    "generate:localess": "openapi-generator-cli generate"
   },
   "dependencies": {
     "@localess/react": "0.0.0",
@@ -23,6 +25,7 @@
     "tailwindcss": "^4",
     "eslint": "^9",
     "eslint-config-next": "15.3.0",
-    "@eslint/eslintrc": "^3"
+    "@eslint/eslintrc": "^3",
+    "@openapitools/openapi-generator-cli": "^2.19.1"
   }
 }
diff --git a/playgrounds/next15/src/app/layout.tsx b/playgrounds/next15/src/app/layout.tsx
@@ -8,7 +8,7 @@ localessInit({
   spaceId: "MmaT4DL0kJ6nXIILUcQF",
   version: "draft",
   token: "Y4rvboPnyzVeC7LddEK5",
-  debug: true
+  debug: false
 })
 
 const geistSans = Geist({
diff --git a/playgrounds/next15/src/app/not-found.tsx b/playgrounds/next15/src/app/not-found.tsx
@@ -0,0 +1,11 @@
+import Link from 'next/link'
+
+export default function NotFound() {
+  return (
+    <div>
+      <h2>Not Found</h2>
+      <p>Could not find requested resource</p>
+      <Link href="/">Return Home</Link>
+    </div>
+  )
+}
diff --git a/playgrounds/next15/src/app/page.tsx b/playgrounds/next15/src/app/page.tsx
@@ -1,5 +1,6 @@
-import {getLocalessClient} from "@localess/react";
+import {getLocalessClient, Content} from "@localess/react";
 import {LOCALES} from "@/utils/locales";
+import {Page} from "@/shared/generated/localess";
 
 export default async function Home({searchParams}: {
   searchParams: Promise<{ [key: string]: string | string[] | undefined }>
@@ -33,7 +34,7 @@ export default async function Home({searchParams}: {
   );
 }
 
-export async function fetchData(locale?: string) {
+async function fetchData(locale?: string): Promise<Content<Page>> {
   const client = getLocalessClient();
-  return client.getContentBySlug('home', {locale: locale ? locale : undefined});
+  return client.getContentBySlug<Page>('home', {locale: locale ? locale : undefined});
 }
diff --git a/playgrounds/next15/src/shared/generated/localess/.gitignore b/playgrounds/next15/src/shared/generated/localess/.gitignore
@@ -0,0 +1,4 @@
+wwwroot/*.js
+node_modules
+typings
+dist
diff --git a/playgrounds/next15/src/shared/generated/localess/.npmignore b/playgrounds/next15/src/shared/generated/localess/.npmignore
@@ -0,0 +1 @@
+# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm
diff --git a/playgrounds/next15/src/shared/generated/localess/.openapi-generator-ignore b/playgrounds/next15/src/shared/generated/localess/.openapi-generator-ignore
@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md
diff --git a/playgrounds/next15/src/shared/generated/localess/.openapi-generator/FILES b/playgrounds/next15/src/shared/generated/localess/.openapi-generator/FILES
@@ -0,0 +1,21 @@
+.gitignore
+.npmignore
+.openapi-generator-ignore
+api.ts
+api/assets-api.ts
+api/contents-api.ts
+api/translations-api.ts
+base.ts
+common.ts
+configuration.ts
+git_push.sh
+index.ts
+model/content-asset.ts
+model/content-data.ts
+model/content-link.ts
+model/content-metadata.ts
+model/content-reference.ts
+model/content-rich-text.ts
+model/content.ts
+model/index.ts
+model/page.ts
diff --git a/playgrounds/next15/src/shared/generated/localess/.openapi-generator/VERSION b/playgrounds/next15/src/shared/generated/localess/.openapi-generator/VERSION
@@ -0,0 +1 @@
+7.8.0
diff --git a/playgrounds/next15/src/shared/generated/localess/git_push.sh b/playgrounds/next15/src/shared/generated/localess/git_push.sh
@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=$(git remote)
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
diff --git a/playgrounds/next15/src/shared/generated/localess/index.ts b/playgrounds/next15/src/shared/generated/localess/index.ts
@@ -0,0 +1,16 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Localess Open API Specification
+ * Fetch data from Localess via REST API
+ *
+ * The version of the OpenAPI document: 2.4.1
+ * Contact: info@lessify.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+export * from "./model";
diff --git a/playgrounds/next15/src/shared/generated/localess/model/content-asset.ts b/playgrounds/next15/src/shared/generated/localess/model/content-asset.ts
@@ -0,0 +1,43 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Localess Open API Specification
+ * Fetch data from Localess via REST API
+ *
+ * The version of the OpenAPI document: 2.4.1
+ * Contact: info@lessify.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * Content Asset define reference to a Asset.
+ * @export
+ * @interface ContentAsset
+ */
+export interface ContentAsset {
+    /**
+     * Define the type of Asset
+     * @type {string}
+     * @memberof ContentAsset
+     */
+    'kind': ContentAssetKindEnum;
+    /**
+     * Unique identifier for the asset.
+     * @type {string}
+     * @memberof ContentAsset
+     */
+    'uri': string;
+}
+
+export const ContentAssetKindEnum = {
+    Asset: 'ASSET'
+} as const;
+
+export type ContentAssetKindEnum = typeof ContentAssetKindEnum[keyof typeof ContentAssetKindEnum];
+
+
diff --git a/playgrounds/next15/src/shared/generated/localess/model/content-data.ts b/playgrounds/next15/src/shared/generated/localess/model/content-data.ts
@@ -0,0 +1,27 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Localess Open API Specification
+ * Fetch data from Localess via REST API
+ *
+ * The version of the OpenAPI document: 2.4.1
+ * Contact: info@lessify.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { Page } from './page';
+
+/**
+ * @type ContentData
+ * ContentData defined Object to connect all possible root Schemas.
+ * @export
+ */
+export type ContentData = Page;
+
+
diff --git a/playgrounds/next15/src/shared/generated/localess/model/content-link.ts b/playgrounds/next15/src/shared/generated/localess/model/content-link.ts
@@ -0,0 +1,67 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Localess Open API Specification
+ * Fetch data from Localess via REST API
+ *
+ * The version of the OpenAPI document: 2.4.1
+ * Contact: info@lessify.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * Content Link define reference to a Link.
+ * @export
+ * @interface ContentLink
+ */
+export interface ContentLink {
+    /**
+     * Define the type of Link
+     * @type {string}
+     * @memberof ContentLink
+     */
+    'kind': ContentLinkKindEnum;
+    /**
+     * Define the type of Link. URL for external links and Content for internal links.
+     * @type {string}
+     * @memberof ContentLink
+     */
+    'type': ContentLinkTypeEnum;
+    /**
+     * Define the target of the link. _blank for new tab and _self for same tab.
+     * @type {string}
+     * @memberof ContentLink
+     */
+    'target': ContentLinkTargetEnum;
+    /**
+     * If type is content, then it will be Content ID. Otherwise it will be URL.
+     * @type {string}
+     * @memberof ContentLink
+     */
+    'uri': string;
+}
+
+export const ContentLinkKindEnum = {
+    Link: 'LINK'
+} as const;
+
+export type ContentLinkKindEnum = typeof ContentLinkKindEnum[keyof typeof ContentLinkKindEnum];
+export const ContentLinkTypeEnum = {
+    Url: 'url',
+    Content: 'content'
+} as const;
+
+export type ContentLinkTypeEnum = typeof ContentLinkTypeEnum[keyof typeof ContentLinkTypeEnum];
+export const ContentLinkTargetEnum = {
+    Blank: '_blank',
+    Self: '_self'
+} as const;
+
+export type ContentLinkTargetEnum = typeof ContentLinkTargetEnum[keyof typeof ContentLinkTargetEnum];
+
+
diff --git a/playgrounds/next15/src/shared/generated/localess/model/content-metadata.ts b/playgrounds/next15/src/shared/generated/localess/model/content-metadata.ts
diff --git a/playgrounds/next15/src/shared/generated/localess/model/content-reference.ts b/playgrounds/next15/src/shared/generated/localess/model/content-reference.ts
diff --git a/playgrounds/next15/src/shared/generated/localess/model/content-rich-text.ts b/playgrounds/next15/src/shared/generated/localess/model/content-rich-text.ts
diff --git a/playgrounds/next15/src/shared/generated/localess/model/content.ts b/playgrounds/next15/src/shared/generated/localess/model/content.ts
diff --git a/playgrounds/next15/src/shared/generated/localess/model/index.ts b/playgrounds/next15/src/shared/generated/localess/model/index.ts
diff --git a/playgrounds/next15/src/shared/generated/localess/model/page.ts b/playgrounds/next15/src/shared/generated/localess/model/page.ts

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +wwwroot/*.js
 +node_modules
 +typings
 +dist
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm`