@malevich-studio/strapi-sdk-typescript 1.0.0 → 1.0.1

package/dist/generate-strapi-types.js

@@ -32,20 +32,17 @@ var __importStar = (this && this.__importStar) || (function () {
         return result;
     };
 })();
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateStrapiTypes = generateStrapiTypes;
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 require("dotenv/config");
-const main_1 = __importDefault(require("./main"));
-var ConfigTypeKind;
-(function (ConfigTypeKind) {
-    ConfigTypeKind["CollectionType"] = "collectionType";
-    ConfigTypeKind["SingleType"] = "singleType";
-})(ConfigTypeKind || (ConfigTypeKind = {}));
+const main_1 = require("./main");
+var ContentTypeKind;
+(function (ContentTypeKind) {
+    ContentTypeKind["CollectionType"] = "collectionType";
+    ContentTypeKind["SingleType"] = "singleType";
+})(ContentTypeKind || (ContentTypeKind = {}));
 var AttributeType;
 (function (AttributeType) {
     AttributeType["BigInteger"] = "biginteger";
@@ -63,6 +60,7 @@ var AttributeType;
     AttributeType["Relation"] = "relation";
     AttributeType["String"] = "string";
     AttributeType["Text"] = "text";
+    AttributeType["Float"] = "float";
     // RichText = 'richtext',
 })(AttributeType || (AttributeType = {}));
 var AttributeRelation;
@@ -74,7 +72,7 @@ var AttributeRelation;
     AttributeRelation["OneToOne"] = "oneToOne";
 })(AttributeRelation || (AttributeRelation = {}));
 function getComponentType(attribute) {
-    const componentTypeName = getContentTypeName(attribute.component);
+    const componentTypeName = getComponentName(attribute.component);
     return attribute.repeatable ? `${componentTypeName}[]` : componentTypeName;
 }
 function getRelationType(attribute) {
@@ -150,16 +148,16 @@ function getContentTypeName(uid) {
         .map((s) => s.charAt(0).toUpperCase() + s.slice(1))
         .join('');
 }
+function getContentTypeMethodName(uid) {
+    const typeName = getContentTypeName(uid);
+    return typeName.charAt(0).toLowerCase() + typeName.slice(1);
+}
 /**
  * Generates a TS interface from a content type or component definition
  */
 function generateTypeCode(name, attributes) {
     const lines = [];
     lines.push(`export type ${name} = {`);
-    // Strapi's default fields:
-    lines.push(`  id?: number;`);
-    lines.push(`  createdAt?: string;`);
-    lines.push(`  updatedAt?: string;`);
     for (const attributeName in attributes) {
         const attribute = attributes[attributeName];
         const typeName = getAttributeType(attribute);
@@ -173,7 +171,7 @@ function generateQueryTypeCode(name, attributes) {
     const fields = [];
     const sort = [];
     const filters = [];
-    filters.push(`export type ${name}Filters = Filters<{`);
+    const populate = [];
     for (const attributeName in attributes) {
         const attribute = attributes[attributeName];
         fields.push(`'${attributeName}'`);
@@ -185,6 +183,7 @@ function generateQueryTypeCode(name, attributes) {
             AttributeType.Integer,
             AttributeType.BigInteger,
             AttributeType.Decimal,
+            AttributeType.Float,
             AttributeType.Boolean,
             AttributeType.DateTime,
             AttributeType.Enumeration,
@@ -197,8 +196,11 @@ function generateQueryTypeCode(name, attributes) {
         switch (attribute.type) {
             case AttributeType.Relation:
                 filters.push(`  ${attributeName}?: ${getContentTypeName(attribute.target)}Filters;`);
+                populate.push(`  ${attributeName}?: ${getContentTypeName(attribute.target)}Query;`);
                 break;
             case AttributeType.Component:
+                populate.push(`  ${attributeName}?: ${getComponentName(attribute.component)}Query;`);
+                break;
             case AttributeType.Media:
             case AttributeType.Json:
                 break;
@@ -206,40 +208,95 @@ function generateQueryTypeCode(name, attributes) {
                 filters.push(`  ${attributeName}?: FilterValue<${type}>;`);
         }
     }
-    filters.push(`}>`);
-    filters.push('');
     const lines = [];
+    lines.push(`export type ${name}Filters = Filters<{`);
     lines.push(...filters);
+    lines.push(`}>`);
+    lines.push('');
+    lines.push(`export type ${name}Populate = {`);
+    lines.push(...populate);
+    lines.push(`}`);
+    lines.push('');
     lines.push(`export type ${name}Query  = Query<`);
     lines.push(`  ${fields.join(' | ')},`);
     lines.push(`  ${sort.join(' | ')},`);
-    lines.push(`  ${name}Filters`);
+    lines.push(`  ${name}Filters,`);
+    lines.push(`  ${name}Populate`);
     lines.push(`>`);
     return lines.join('\n');
 }
+function generateMethodsCode(contentType) {
+    const methods = [];
+    const modelName = getContentTypeName(contentType.uid);
+    if (contentType.schema.kind === ContentTypeKind.CollectionType) {
+        methods.push([
+            `  public async ${getContentTypeMethodName(contentType.schema.pluralName)}(query?: ${modelName}Query, params?: RequestInit) {`,
+            `    return await this.getDocuments<${modelName}, ${modelName}Query>('${contentType.schema.pluralName}', query, params);`,
+            '  }',
+        ].join('\n'));
+    }
+    methods.push([
+        `  public async ${getContentTypeMethodName(contentType.schema.singularName)}(query?: ${modelName}Query, params?: RequestInit) {`,
+        `    return await this.getDocument<${modelName}, ${modelName}Query>('${contentType.schema.singularName}', query, params);`,
+        '  }',
+    ].join('\n'));
+    return methods;
+}
 /**
  * Main function to fetch Strapi (v5) data and generate the d.ts file
  */
 async function generateStrapiTypes() {
-    const strapi = new main_1.default(process.env.STRAPI_URL, process.env.STRAPI_TOKEN);
+    const strapi = new main_1.Strapi(process.env.STRAPI_URL, process.env.STRAPI_TOKEN);
     const contentTypes = (await strapi.request('content-type-builder/content-types')).data;
     const components = (await strapi.request('content-type-builder/components')).data;
     const allInterfaces = [];
+    const methods = [];
     for (const component of components) {
+        console.log(component.schema.attributes);
         const componentName = getComponentName(component.uid);
-        const code = generateTypeCode(componentName, component.schema.attributes);
+        const attributes = {
+            id: {
+                type: AttributeType.Integer,
+            },
+            ...component.schema.attributes,
+        };
+        const code = generateTypeCode(componentName, attributes);
+        allInterfaces.push(generateQueryTypeCode(componentName, attributes));
         allInterfaces.push(code);
     }
     for (const contentType of contentTypes) {
-        if (!contentType.uid.startsWith('api::')) {
+        // console.log(contentTypes);
+        if (!(contentType.uid.startsWith('api::') || contentType.uid.startsWith('plugin::users-permissions'))) {
             continue;
         }
+        methods.push(...generateMethodsCode(contentType));
         const modelName = getContentTypeName(contentType.uid);
-        allInterfaces.push(generateTypeCode(modelName, contentType.schema.attributes));
-        allInterfaces.push(generateQueryTypeCode(modelName, contentType.schema.attributes));
+        const attributes = {
+            id: {
+                type: AttributeType.Integer,
+            },
+            documentId: {
+                type: AttributeType.String,
+            },
+            createdAt: {
+                type: AttributeType.DateTime,
+            },
+            updatedAt: {
+                type: AttributeType.DateTime,
+            },
+            ...contentType.schema.attributes,
+        };
+        allInterfaces.push(generateTypeCode(modelName, attributes));
+        allInterfaces.push(generateQueryTypeCode(modelName, attributes));
     }
-    const output = allInterfaces.join('\n\n');
-    const outPath = path.join(process.cwd(), 'strapi-types.d.ts');
+    const output = [
+        'import {Strapi as StrapiBase, Query, Filters, FilterValue} from "@malevich-studio/strapi-sdk-typescript";\n',
+        'export default class Strapi extends StrapiBase {',
+        ...methods,
+        '}',
+        ...allInterfaces,
+    ].join('\n\n');
+    const outPath = path.join(process.cwd(), 'strapi.ts');
     fs.writeFileSync(outPath, output, 'utf-8');
-    console.log(`✅ "strapi-types.d.ts" has been successfully generated!`);
+    console.log(`✅ "strapi.ts" has been successfully generated!`);
 }

package/dist/main.d.ts

@@ -1,5 +1,5 @@
 type Response<T> = {
-    data: T[];
+    data: T;
     meta: {
         pagination: {
             total?: number;
@@ -56,12 +56,12 @@ export type Query<Fields, Sort, Filters, Populate> = {
         limit?: number;
     });
 };
-export default class Strapi {
+export declare class Strapi {
     private readonly url;
     private readonly token;
     constructor(url: string, token: string);
     request<T>(endpoint: string, data?: object, params?: RequestInit): Promise<Response<T>>;
-    getDocuments<T, Q extends object>(endpoint: string, data?: Q, params?: RequestInit): Promise<Response<T>>;
+    getDocuments<T, Q extends object>(endpoint: string, data?: Q, params?: RequestInit): Promise<Response<T[]>>;
     getDocument<T, Q extends object>(endpoint: string, data?: Q, params?: RequestInit): Promise<Response<T>>;
     create<T>(endpoint: string, data?: object, params?: RequestInit): Promise<Response<T>>;
 }

package/dist/main.js

@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.Strapi = void 0;
 const qs_1 = __importDefault(require("qs"));
 class Strapi {
     constructor(url, token) {
@@ -13,19 +14,6 @@ class Strapi {
         const baseUrl = `${this.url}/api/`;
         const queryString = params.method === 'GET' ? qs_1.default.stringify(data) : '';
         const url = queryString ? `${baseUrl}${endpoint}?${queryString}` : `${baseUrl}${endpoint}`;
-        console.log({
-            headers: {
-                Authorization: `Bearer ${this.token}`,
-                'Content-Type': 'application/json',
-            },
-            cache: 'no-store',
-            ...(params.method && params.method !== 'GET' ? {
-                body: JSON.stringify({
-                    data,
-                })
-            } : {}),
-            ...params
-        });
         const response = await fetch(url, {
             headers: {
                 Authorization: `Bearer ${this.token}`,
@@ -64,4 +52,4 @@ class Strapi {
         });
     }
 }
-exports.default = Strapi;
+exports.Strapi = Strapi;

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@malevich-studio/strapi-sdk-typescript",
-  "version": "1.0.0",
-  "main": "dist/index.js",
+  "version": "1.0.1",
+  "main": "dist/main.js",
+  "types": "dist/main.d.ts",
   "bin": {
     "generate-strapi-types": "dist/cli.js"
   },