Merge pull request #1117 from appwrite/fix-document-typing

fix: update document type handling and improve generics in TS

Author: abnegate

src/SDK/Language/Node.php

@@ -57,10 +57,10 @@ public function getTypeName(array $parameter, array $method = []): string
                         return "Partial<Preferences>";
                     case 'document':
                         if ($method['method'] === 'post') {
-                            return "Omit<Document, keyof Models.Document>";
+                            return "Document extends Models.DefaultDocument ? Models.DataWithoutDocumentKeys : Omit<Document, keyof Models.Document>";
                         }
                         if ($method['method'] === 'patch') {
-                            return "Partial<Omit<Document, keyof Models.Document>>";
+                            return "Partial<Document extends Models.DefaultDocument ? Models.DataWithoutDocumentKeys : Omit<Document, keyof Models.Document>>";
                         }
                 }
                 break;

src/SDK/Language/Web.php

@@ -222,10 +222,10 @@ public function getTypeName(array $parameter, array $method = []): string
                         return "Partial<Preferences>";
                     case 'document':
                         if ($method['method'] === 'post') {
-                            return "Omit<Document, keyof Models.Document>";
+                            return "Document extends Models.DefaultDocument ? Models.DataWithoutDocumentKeys : Omit<Document, keyof Models.Document>";
                         }
                         if ($method['method'] === 'patch') {
-                            return "Partial<Omit<Document, keyof Models.Document>>";
+                            return "Partial<Document extends Models.DefaultDocument ? Models.DataWithoutDocumentKeys : Omit<Document, keyof Models.Document>>";
                         }
                 }
                 break;
@@ -261,7 +261,7 @@ public function getGenerics(string $model, array $spec, bool $skipFirst = false)
         }
 
         $generics = array_unique($generics);
-        $generics = array_map(fn ($type) => "{$type} extends Models.{$type}", $generics);
+        $generics = array_map(fn ($type) => "{$type} extends Models.{$type} = Models.Default{$type}", $generics);
 
         return '<' . implode(', ', $generics) . '>';
     }

templates/node/src/services/template.ts.twig

@@ -94,5 +94,8 @@ export class {{ service.name | caseUcfirst }} {
         );
         {%~ endif %}
     }
+{%~ if not loop.last %}
+
+{%~ endif %}
     {%~ endfor %}
 }

templates/web/src/models.ts.twig

@@ -2,7 +2,10 @@
  * {{spec.title | caseUcfirst}} Models
  */
 export namespace Models {
+
+    declare const __default: unique symbol;
 {% for definition in spec.definitions %}
+
     /**
      * {{ definition.description }}
      */
@@ -13,8 +16,19 @@ export namespace Models {
          */
         {{ property.name }}{% if not property.required %}?{% endif %}: {{ property | getSubSchema(spec) | raw }};
 {% endfor %}
-{% if definition.additionalProperties %}        [key: string]: any;
-{% endif %}
     }
+{% if definition.additionalProperties %}
+
+    export type Default{{ definition.name | caseUcfirst }}{{ definition.name | getGenerics(spec, true) | raw }} = {{ definition.name | caseUcfirst }}{{ definition.name | getGenerics(spec, true) | raw }} & {
+        [key: string]: any;
+        [__default]: true;
+    };
+
+    export type DataWithout{{ definition.name | caseUcfirst }}Keys{{ definition.name | getGenerics(spec, true) | raw }} = {
+        [K in string]: any;
+    } & {
+        [K in keyof {{ definition.name | caseUcfirst }}{{ definition.name | getGenerics(spec, true) | raw }}]?: never;
+    };
+{% endif %}
 {% endfor %}
 }

templates/web/src/services/template.ts.twig

@@ -108,5 +108,8 @@ export class {{ service.name | caseUcfirst }} {
         );
         {%~ endif %}
     }
+{%~ if not loop.last %}
+
+{%~ endif %}
     {%~ endfor %}
 }