@malevich-studio/strapi-sdk-typescript 1.0.7 → 1.0.9

package/README.md

@@ -0,0 +1,125 @@
+# Strapi SDK for TypeScript
+
+A TypeScript SDK for interacting with Strapi APIs.
+
+## 🚀 Installation
+
+To install the SDK, run:
+
+```sh
+npm install @malevich-studio/strapi-sdk-typescript
+```
+
+## 🛠 Configuration
+
+Create a `.env` file with your Strapi base URL and API token:
+
+```sh
+STRAPI_URL=http://localhost:1337
+STRAPI_TOKEN=<your_strapi_token>
+```
+
+### Generating API Token
+
+To interact with the Strapi API, you need to create an API token with at least `Content-Type Builder` permissions.
+Navigate to:
+
+```
+<your_strapi_base_url>/admin/settings/api-tokens/create
+```
+
+### Generating API Class
+
+Run the following command to generate TypeScript types based on your Strapi schema:
+
+```sh
+npx generate-strapi-types
+```
+
+## 📌 Usage
+
+### Basic Example
+
+Create `strapi.ts` to initialize the API class:
+
+```ts
+import Strapi from "./strapi"; // strapi.ts file
+
+const api = new Strapi(process.env.STRAPI_URL || '', process.env.STRAPI_TOKEN || '');
+
+const articles = api.articles({
+  fields: ["documentId", "title", "text"],
+  populate: {
+    seo: {
+      fields: ["slug", "metaTitle", "metaDescription"],
+      populate: {
+        openGraph: {
+          fields: ["title", "description", "url", "type"],
+          populate: {
+            image: {
+              fields: ["url", "width", "height"]
+            }
+          }
+        }
+      }
+    }
+  }
+});
+```
+
+### Using in Next.js with Caching
+
+If using Next.js, you can integrate caching for better performance:
+
+```ts
+import Strapi from "@/strapi"; // strapi.ts file
+
+const api = new Strapi(process.env.STRAPI_URL || '', process.env.STRAPI_TOKEN || '');
+
+const articles = api.articles(
+  {
+    fields: ["documentId", "title", "text"],
+    populate: {
+      seo: {
+        fields: ["slug", "metaTitle", "metaDescription"],
+        populate: {
+          openGraph: {
+            fields: ["title", "description", "url", "type"],
+            populate: {
+              image: {
+                fields: ["url", "width", "height"]
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  // Cache Options
+  {
+    cache: "force-cache",
+    next: {
+      revalidate: 24 * 3600, // Revalidate every 24 hours
+      tags: ["contact", "regions"]
+    }
+  }
+);
+```
+
+## 📌 TODO List
+
+- [ ] Add authentication features:
+    - [ ] Log In functionality
+    - [ ] User Registration
+    - [ ] User privileges check
+- [ ] Refactor `src/generator/index.ts` for better maintainability
+- [ ] Enable passing Strapi credentials via CLI parameters
+- [ ] Allow customization of API class path
+- [ ] Resolve naming conflicts between Components and Content Types
+- [ ] Support custom attributes in `src/generator/attributes/index.ts:15`:
+    - [ ] Define attributes by project code
+    - [ ] Auto-load attributes from other npm packages by scanning `node_modules`
+
+---
+
+📌 **Contributions are welcome!** If you encounter issues or have feature requests, feel free to open a pull request or an issue. 🚀

package/dist/cli.cjs

@@ -21307,7 +21307,7 @@ class Strapi {
         return (await this.baseRequest('upload', {
             method: 'POST',
             body: form,
-        })).data;
+        }));
     }
     async baseRequest(endpoint, params = {}) {
         const response = await fetch(`${this.url}/api/${endpoint}`, _.merge({
@@ -21317,13 +21317,10 @@ class Strapi {
         }, params));
         if (!response.ok) {
             console.log(`${this.url}/api/${endpoint}`);
-            console.log(_.merge({
-                headers: {
-                    Authorization: `Bearer ${this.token}`,
-                },
-            }, params));
             console.log(response);
-            console.log(await response.json());
+            const data = await response.json();
+            console.log(data);
+            console.log(data?.error?.details?.errors);
             throw new Error(`Помилка запиту до Strapi: ${response.status} ${response.statusText}`);
         }
         return (await response.json());
@@ -21632,6 +21629,17 @@ let Boolean$1 = class Boolean extends Base {
     }
 };
 
+let Date$1 = class Date extends Base {
+    constructor(name, attribute) {
+        super(name, attribute);
+        this.name = name;
+        this.attribute = attribute;
+    }
+    getType() {
+        return 'string';
+    }
+};
+
 const types = {
     'string': String$1,
     'text': String$1,
@@ -21645,6 +21653,7 @@ const types = {
     'media': Media,
     'relation': Relation,
     'enumeration': Enumeration,
+    'date': Date$1,
     'datetime': DateTime,
     'component': Component,
     'blocks': Blocks,