@oak-digital/types-4-strapi-2 0.2.0 → 0.2.1

package/README.md

@@ -0,0 +1,67 @@
+# types-4-strapi-2
+
+types-4-strapi-2 is a typescript program that will generate typescript types for your strapi projects.
+This can be useful if you have a frontend written with typescript to make sure you are using the correct types and can help report errors at compile time.
+
+types-4-strapi-2 is a rewrite of (francescolorenzetti/types-4-strapi)[https://github.com/francescolorenzetti/types-4-strapi] written in typescript, with the goal of being much easier to extend and maintain.
+
+## Getting started
+
+Install the script for your project:
+
+```bash
+npm install --save-dev @oak-digital/types-4-strapi-2
+```
+
+Then set up a script in your `package.json`
+
+```jsonc
+// package.json
+{
+    "scripts": {
+        "types": "t4s"
+    }
+}
+```
+
+In some cases it is desirable to change the output directory which is `./types` by default.
+This can be done with the `--out` flag like in the following example.
+
+```jsonc
+// package.json
+{
+    "scripts": {
+        "types": "t4s --out ../frontend/src/lib/types"
+    }
+}
+```
+
+## Features
+
+* Generate typescript interfaces for all your api content-types and components
+* Generate typescript interfaces for builtin types such as `Media` and `MediaFormat`
+* Select input and output directory
+
+### Planned features
+
+* Support if you are using other plugins, such as `url-alias`, which should add extra fields for some interfaces.
+* Nicer formatted interfaces
+
+## Help
+
+use `t4s --help` to display which options are available for you
+
+## Building
+
+To build this project, use the following command
+
+```bash
+npm run build
+```
+
+## Publihsing
+
+```bash
+npm run build
+npm publish
+```

package/lib/index.js

@@ -9,11 +9,14 @@ commander_1.program
     .name("t4s");
 commander_1.program
     .option('-i, --in <dir>', 'The src directory for strapi', './src')
-    .option('-o, --out <dir>', 'The output directory to output the types to', './types');
+    .option('-o, --out <dir>', 'The output directory to output the types to', './types')
+    .option('--component-prefix <prefix>', 'A prefix for components', "");
 commander_1.program.parse();
 var options = commander_1.program.opts();
-var input = options.in, out = options.out;
-var manager = new InterfaceManager_1.default(out, input);
+var input = options.in, out = options.out, componentPrefix = options.componentPrefix;
+var manager = new InterfaceManager_1.default(out, input, {
+    componentPrefix: componentPrefix,
+});
 manager.run().catch(function (err) {
     console.error(err);
 });

package/lib/interface/Attributes.js

@@ -9,6 +9,8 @@ var Attributes = /** @class */ (function () {
     Attributes.prototype.isAttributeOptional = function (attr) {
         // If it is a component / relation / dynamiczone it is always optional due to population
         switch (attr.type) {
+            case "nested":
+                return attr.nullable === true;
             case "component":
             case "dynamiczone":
             case "relation":
@@ -80,7 +82,8 @@ var Attributes = /** @class */ (function () {
                 str += dependencyComponentName;
                 break;
             case "media":
-                str += this.RelationNames["builtins::Media"].name;
+                var mediaOptional = attr.required !== true ? "?" : "";
+                str += "{ data".concat(mediaOptional, ": ").concat(this.RelationNames["builtins::Media"].name, "; }");
                 isArray = (_b = attr.multiple) !== null && _b !== void 0 ? _b : false;
                 break;
             case "password":

package/lib/interface/builtinInterfaces.js

@@ -41,6 +41,13 @@ function createMediaInterface(directory, prefix) {
     };
     stringFields.forEach(function (s) { return mediaAttrs[s] = { type: "string" }; });
     numberFields.forEach(function (s) { return mediaAttrs[s] = { type: "integer" }; });
+    // const dataAttrs = {
+    //     data: {
+    //         type: "nested",
+    //         fields: mediaAttrs,
+    //         nullable: true,
+    //     },
+    // };
     return new BuiltinInterface_1.default("Media", mediaAttrs, directory, prefix);
 }
 exports.createMediaInterface = createMediaInterface;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oak-digital/types-4-strapi-2",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Typescript interface generator for Strapi 4 models",
   "bin": {
     "t4s": "./bin/index.js"