expo-type-information 0.0.2 → 0.0.3

package/build/typeInformation.d.ts

@@ -1,38 +1,82 @@
+/**
+ * Represents the kind of a parsed identifier from a native file.
+ */
 export declare enum IdentifierKind {
     BASIC = 0,
     ENUM = 1,
     RECORD = 2,
     CLASS = 3
 }
+/**
+ * Represents a parametrized type, that is a generic type with specified parameters e.g. Map<string, number>.
+ */
 export type ParametrizedType = {
     name: TypeIdentifier;
     types: Type[];
 };
+/**
+ * Represents an argument passed to a function or constructor.
+ */
 export type Argument = {
     name: string | undefined;
     type: Type;
 };
+/**
+ * Represents a single field within a record or a struct.
+ */
 export type Field = Argument;
+/**
+ * Represents a struct or dictionary-like record consisting of named fields.
+ */
 export type RecordType = {
     name: string;
     fields: Field[];
 };
+/**
+ * Represents a single case inside an enum declaration.
+ */
 export type EnumCase = string;
+/**
+ * Represents an enum type, containing its name and all associated cases.
+ */
 export type EnumType = {
     name: string;
     cases: EnumCase[];
 };
+/**
+ * Represents a union or a sum type where a value can be one of several different types.
+ */
 export type SumType = {
     types: Type[];
 };
+/**
+ * Represents a dictionary type, defining the explicit types for its keys and values.
+ */
 export type DictionaryType = {
     key: Type;
     value: Type;
 };
+/**
+ * Represents an optional type that can also resolve to null or undefined.
+ * > **Note:** The information that this type is optional is implicit and exists only in the type system and on the parent type. There is no field on the `OptionalType` object that explicitly indicates that.
+ */
 export type OptionalType = Type;
+/**
+ * Represents a list or array of a specific type.
+ * > **Note:** The information that this type is array is implicit and exists only in the type system and on the parent type. There is no field on the `ArrayType` object that explicitly indicates that.
+ */
 export type ArrayType = Type;
+/**
+ * Represents a type identifier as a string reference.
+ */
 export type TypeIdentifier = string;
+/**
+ * Represents an anonymous type, a one that is not named instead written directly in the code, such as inline generics, arrays, or optionals.
+ */
 export type AnonymousType = ParametrizedType | SumType | OptionalType | DictionaryType | ArrayType;
+/**
+ * Categorizes the type node within the abstract syntax tree.
+ */
 export declare enum TypeKind {
     BASIC = 0,
     IDENTIFIER = 1,
@@ -42,6 +86,9 @@ export declare enum TypeKind {
     ARRAY = 5,
     DICTIONARY = 6
 }
+/**
+ * Represents a basic type that is not user defined.
+ */
 export declare enum BasicType {
     ANY = 0,
     STRING = 1,
@@ -49,40 +96,70 @@ export declare enum BasicType {
     BOOLEAN = 3,
     VOID = 4,
     UNDEFINED = 5,
+    /** Represents a type that couldn't be resolved */
     UNRESOLVED = 6
 }
+/**
+ * Represents an abstract type node.
+ */
 export type Type = {
     kind: TypeKind;
     type: BasicType | TypeIdentifier | AnonymousType;
 };
+/**
+ * Represents a DSL property declaration.
+ */
 export type PropertyDeclaration = ConstantDeclaration;
+/**
+ * Represents a DSL view declaration.
+ */
 export type ViewDeclaration = ModuleClassDeclaration;
+/**
+ * Represents a DSL event declaration.
+ */
 export type EventDeclaration = string;
 /**
- * Retain information of where the thing was defined in the file.
+ * Retains information of where the thing was defined in the file.
  * As collecting type information is written in asynchronous way it is non-deterministic.
- * To make it deterministic we just sort the declaration by the definitionOffset, maintianing the same ordering as in original file.
+ * To make it deterministic we just sort the declaration by the definitionOffset, maintaining the same ordering as in original file.
+ * @header TypeInfoTypes
  */
 export type DefinitionOffset = {
     definitionOffset: number;
 };
+/**
+ * Represents a DSL constant declaration.
+ */
 export type ConstantDeclaration = {
     name: string;
     type: Type;
 } & DefinitionOffset;
+/**
+ * Represents a DSL function declaration.
+ * @hideType
+ */
 export type FunctionDeclaration = {
     name: string;
     returnType: Type;
     arguments: Argument[];
     parameters: Type[];
 } & DefinitionOffset;
+/**
+ * Represents a DSL prop declaration.
+ */
 export type PropDeclaration = {
     name: string;
     arguments: Argument[];
 } & DefinitionOffset;
+/**
+ * Represents a DSL class constructor declaration.
+ */
 export type ConstructorDeclaration = {
     arguments: Argument[];
 } & DefinitionOffset;
+/**
+ * Represents a DSL native class declaration.
+ */
 export type ClassDeclaration = {
     name: string;
     constructor: ConstructorDeclaration | null;
@@ -90,6 +167,9 @@ export type ClassDeclaration = {
     asyncMethods: FunctionDeclaration[];
     properties: PropertyDeclaration[];
 } & DefinitionOffset;
+/**
+ * Represents a DSL module declaration.
+ */
 export type ModuleClassDeclaration = {
     name: string;
     constructor: ConstructorDeclaration | null;
@@ -102,12 +182,24 @@ export type ModuleClassDeclaration = {
     views: ViewDeclaration[];
     events: EventDeclaration[];
 } & DefinitionOffset;
+/**
+ * Represents a definition of an identifier.
+ */
 export type IdentifierDefinition = {
     kind: IdentifierKind;
     definition: string | RecordType | EnumType | ClassDeclaration;
 };
+/**
+ * Maps type identifier strings to their definition objects.
+ */
 export type TypeIdentifierDefinitionMap = Map<string, IdentifierDefinition>;
+/**
+ * Serialized version of the `TypeIdentifierDefinitionMap`.
+ */
 export type TypeIdentifierDefinitionList = [string, IdentifierDefinition][];
+/**
+ * Serialized version of the `FileTypeInformation`, suitable for JSON storage or testing environments.
+ */
 export type FileTypeInformationSerialized = {
     usedTypeIdentifiersList: string[];
     declaredTypeIdentifiersList: string[];
@@ -118,9 +210,10 @@ export type FileTypeInformationSerialized = {
     enums: EnumType[];
 };
 /**
- * FileTypeInformation object abstracts over type related information in a file.
+ * `FileTypeInformation` object abstracts over type related information in a file.
  * The abstraction is closely related to Typescript and expo NativeModules (both to be independent of the actual native side
  * and to give accurate information about what and how we can use the given module).
+ * @header TypeInfoTypes
  */
 export type FileTypeInformation = {
     /**
@@ -158,20 +251,22 @@ export type FileTypeInformation = {
     enums: EnumType[];
 };
 /**
- * Used for testing purposes, maps Sets and Maps to Arrays and returns FileTypeInformationSerialized object which can be written to a JSON.
- * @param param0 FileTypeInformation object to serialize.
- * @returns FileTypeInformationSerialized object.
+ * Used for testing purposes, maps Sets and Maps to Arrays and returns `FileTypeInformationSerialized` object which can be written to a JSON.
+ * @param fileTypeinformation `FileTypeInformation` object to serialize.
+ * @returns a `FileTypeInformationSerialized` object.
+ * @header TypeInformationAbstraction
  */
 export declare function serializeTypeInformation({ usedTypeIdentifiers, declaredTypeIdentifiers, inferredTypeParametersCount, typeIdentifierDefinitionMap, moduleClasses, records, enums, }: FileTypeInformation): FileTypeInformationSerialized;
 /**
- * Used for testing purposes, maps Arrays to Sets and Maps depending on the field and returns FileTypeInformation object.
- * @param param0 FileTypeInformationSerialized object to deserialize.
- * @returns FileTypeInformation object.
+ *  Used for testing purposes, maps Arrays to Sets and Maps depending on the field and returns `FileTypeInformation` object.
+ * @param fileTypeinformationSerialized `FileTypeInformationSerialized` object to deserialize.
+ * @returns `FileTypeInformation` object.
+ * @header TypeInformationAbstraction
  */
 export declare function deserializeTypeInformation({ usedTypeIdentifiersList, declaredTypeIdentifiersList, inferredTypeParametersCountList, typeIdentifierDefinitionList, moduleClasses, records, enums, }: FileTypeInformationSerialized): FileTypeInformation;
 /**
  * Defines the level of type inference to apply when extracting type information.
- * Note: In case where type inference is on, it may take more then twice the time to compute the type information.
+ * > **Note:** In case where type inference is on, it may take more then twice the time to compute the type information.
  */
 export declare enum TypeInferenceOption {
     /** No type inference will be performed. */
@@ -181,11 +276,17 @@ export declare enum TypeInferenceOption {
     /** Preprocesses the file by injecting returns to extract more type info from sourcekitten. */
     PREPROCESS_AND_INFERENCE = 2
 }
+/**
+ * Defines an input option for extracting type information directly from a raw string of source code.
+ */
 export type StringInputOption = {
     type: 'string';
     fileContent: string;
     language: 'Swift';
 };
+/**
+ * Defines an input option for extracting type information from a set of physical files.
+ */
 export type FileInputOption = {
     type: 'file';
     inputFileAbsolutePaths: string[];
@@ -204,6 +305,7 @@ export type GetFileTypeInformationOptions = {
  * If a raw string is provided, or if the `PREPROCESS_AND_INFERENCE` inference option is selected,
  * the function will create a temporary file with the (optionally preprocessed) content to facilitate parsing.
  * @param options - Configuration object containing the input source (file or string) and the desired level of type inference.
- * @returns A promise that resolves to a `FileTypeInformation` object if the input was parsed successfully. Otherwise, it returns `null`.
+ * @returns A promise that resolves to a `FileTypeInformation` object if the input was parsed successfully. Otherwise, it resolves to `null`.
+ * @header TypeInformationAbstraction
  */
 export declare function getFileTypeInformation({ input, typeInference, }: GetFileTypeInformationOptions): Promise<FileTypeInformation | null>;

package/build/typeInformation.js

@@ -42,6 +42,9 @@ const os = __importStar(require("os"));
 const path = __importStar(require("path"));
 const sourcekittenTypeInformation_1 = require("./swift/sourcekittenTypeInformation");
 const utils_1 = require("./utils");
+/**
+ * Represents the kind of a parsed identifier from a native file.
+ */
 var IdentifierKind;
 (function (IdentifierKind) {
     IdentifierKind[IdentifierKind["BASIC"] = 0] = "BASIC";
@@ -49,6 +52,9 @@ var IdentifierKind;
     IdentifierKind[IdentifierKind["RECORD"] = 2] = "RECORD";
     IdentifierKind[IdentifierKind["CLASS"] = 3] = "CLASS";
 })(IdentifierKind || (exports.IdentifierKind = IdentifierKind = {}));
+/**
+ * Categorizes the type node within the abstract syntax tree.
+ */
 var TypeKind;
 (function (TypeKind) {
     TypeKind[TypeKind["BASIC"] = 0] = "BASIC";
@@ -59,6 +65,9 @@ var TypeKind;
     TypeKind[TypeKind["ARRAY"] = 5] = "ARRAY";
     TypeKind[TypeKind["DICTIONARY"] = 6] = "DICTIONARY";
 })(TypeKind || (exports.TypeKind = TypeKind = {}));
+/**
+ * Represents a basic type that is not user defined.
+ */
 var BasicType;
 (function (BasicType) {
     BasicType[BasicType["ANY"] = 0] = "ANY";
@@ -67,12 +76,14 @@ var BasicType;
     BasicType[BasicType["BOOLEAN"] = 3] = "BOOLEAN";
     BasicType[BasicType["VOID"] = 4] = "VOID";
     BasicType[BasicType["UNDEFINED"] = 5] = "UNDEFINED";
+    /** Represents a type that couldn't be resolved */
     BasicType[BasicType["UNRESOLVED"] = 6] = "UNRESOLVED";
 })(BasicType || (exports.BasicType = BasicType = {}));
 /**
- * Used for testing purposes, maps Sets and Maps to Arrays and returns FileTypeInformationSerialized object which can be written to a JSON.
- * @param param0 FileTypeInformation object to serialize.
- * @returns FileTypeInformationSerialized object.
+ * Used for testing purposes, maps Sets and Maps to Arrays and returns `FileTypeInformationSerialized` object which can be written to a JSON.
+ * @param fileTypeinformation `FileTypeInformation` object to serialize.
+ * @returns a `FileTypeInformationSerialized` object.
+ * @header TypeInformationAbstraction
  */
 function serializeTypeInformation({ usedTypeIdentifiers, declaredTypeIdentifiers, inferredTypeParametersCount, typeIdentifierDefinitionMap, moduleClasses, records, enums, }) {
     return {
@@ -86,9 +97,10 @@ function serializeTypeInformation({ usedTypeIdentifiers, declaredTypeIdentifiers
     };
 }
 /**
- * Used for testing purposes, maps Arrays to Sets and Maps depending on the field and returns FileTypeInformation object.
- * @param param0 FileTypeInformationSerialized object to deserialize.
- * @returns FileTypeInformation object.
+ *  Used for testing purposes, maps Arrays to Sets and Maps depending on the field and returns `FileTypeInformation` object.
+ * @param fileTypeinformationSerialized `FileTypeInformationSerialized` object to deserialize.
+ * @returns `FileTypeInformation` object.
+ * @header TypeInformationAbstraction
  */
 function deserializeTypeInformation({ usedTypeIdentifiersList, declaredTypeIdentifiersList, inferredTypeParametersCountList, typeIdentifierDefinitionList, moduleClasses, records, enums, }) {
     return {
@@ -103,7 +115,7 @@ function deserializeTypeInformation({ usedTypeIdentifiersList, declaredTypeIdent
 }
 /**
  * Defines the level of type inference to apply when extracting type information.
- * Note: In case where type inference is on, it may take more then twice the time to compute the type information.
+ * > **Note:** In case where type inference is on, it may take more then twice the time to compute the type information.
  */
 var TypeInferenceOption;
 (function (TypeInferenceOption) {
@@ -134,7 +146,8 @@ async function withTempFile(content, fn) {
  * If a raw string is provided, or if the `PREPROCESS_AND_INFERENCE` inference option is selected,
  * the function will create a temporary file with the (optionally preprocessed) content to facilitate parsing.
  * @param options - Configuration object containing the input source (file or string) and the desired level of type inference.
- * @returns A promise that resolves to a `FileTypeInformation` object if the input was parsed successfully. Otherwise, it returns `null`.
+ * @returns A promise that resolves to a `FileTypeInformation` object if the input was parsed successfully. Otherwise, it resolves to `null`.
+ * @header TypeInformationAbstraction
  */
 async function getFileTypeInformation({ input, typeInference, }) {
     const shouldPreprocessFile = typeInference === TypeInferenceOption.PREPROCESS_AND_INFERENCE;

package/build/typeInformation.js.map

@@ -1 +1 @@
-{"version":3,"file":"typeInformation.js","sourceRoot":"","sources":["../src/typeInformation.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoMA,4DAkBC;AAOD,gEAkBC;AA8DD,wDAwBC;AArUD,uCAAyB;AACzB,uCAAyB;AACzB,2CAA6B;AAE7B,qFAG6C;AAC7C,mCAAkC;AAElC,IAAY,cAKX;AALD,WAAY,cAAc;IACxB,qDAAK,CAAA;IACL,mDAAI,CAAA;IACJ,uDAAM,CAAA;IACN,qDAAK,CAAA;AACP,CAAC,EALW,cAAc,8BAAd,cAAc,QAKzB;AAoCD,IAAY,QAQX;AARD,WAAY,QAAQ;IAClB,yCAAK,CAAA;IACL,mDAAU,CAAA;IACV,qCAAG,CAAA;IACH,uDAAY,CAAA;IACZ,+CAAQ,CAAA;IACR,yCAAK,CAAA;IACL,mDAAU,CAAA;AACZ,CAAC,EARW,QAAQ,wBAAR,QAAQ,QAQnB;AAED,IAAY,SAQX;AARD,WAAY,SAAS;IACnB,uCAAG,CAAA;IACH,6CAAM,CAAA;IACN,6CAAM,CAAA;IACN,+CAAO,CAAA;IACP,yCAAI,CAAA;IACJ,mDAAS,CAAA;IACT,qDAAU,CAAA;AACZ,CAAC,EARW,SAAS,yBAAT,SAAS,QAQpB;AA0HD;;;;GAIG;AACH,SAAgB,wBAAwB,CAAC,EACvC,mBAAmB,EACnB,uBAAuB,EACvB,2BAA2B,EAC3B,2BAA2B,EAC3B,aAAa,EACb,OAAO,EACP,KAAK,GACe;IACpB,OAAO;QACL,uBAAuB,EAAE,CAAC,GAAG,mBAAmB,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE;QAC/D,2BAA2B,EAAE,CAAC,GAAG,uBAAuB,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE;QACvE,+BAA+B,EAAE,CAAC,GAAG,2BAA2B,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,EAAE;QAClF,4BAA4B,EAAE,CAAC,GAAG,2BAA2B,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,EAAE;QAC/E,aAAa;QACb,OAAO;QACP,KAAK;KACN,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,SAAgB,0BAA0B,CAAC,EACzC,uBAAuB,EACvB,2BAA2B,EAC3B,+BAA+B,EAC/B,4BAA4B,EAC5B,aAAa,EACb,OAAO,EACP,KAAK,GACyB;IAC9B,OAAO;QACL,mBAAmB,EAAE,IAAI,GAAG,CAAS,uBAAuB,CAAC;QAC7D,uBAAuB,EAAE,IAAI,GAAG,CAAS,2BAA2B,CAAC;QACrE,2BAA2B,EAAE,IAAI,GAAG,CAAiB,+BAA+B,CAAC;QACrF,2BAA2B,EAAE,IAAI,GAAG,CAAC,4BAA4B,CAAC;QAClE,aAAa;QACb,OAAO;QACP,KAAK;KACN,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,IAAY,mBAOX;AAPD,WAAY,mBAAmB;IAC7B,2CAA2C;IAC3C,6EAAY,CAAA;IACZ,4CAA4C;IAC5C,qFAAgB,CAAA;IAChB,8FAA8F;IAC9F,qGAAwB,CAAA;AAC1B,CAAC,EAPW,mBAAmB,mCAAnB,mBAAmB,QAO9B;AAuBD,KAAK,UAAU,iBAAiB,CAAC,iBAA2B;IAC1D,MAAM,aAAa,GAAG,MAAM,IAAA,eAAO,EAAC,iBAAiB,EAAE,CAAC,QAAQ,EAAE,EAAE,CAClE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CACxC,CAAC;IACF,OAAO,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AAChC,CAAC;AAED,KAAK,UAAU,YAAY,CAAI,OAAe,EAAE,EAAoC;IAClF,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,WAAW,CAAC,CAAC,CAAC;IAC/E,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,oCAAoC,CAAC,CAAC;IAE1E,IAAI,CAAC;QACH,MAAM,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QACvD,OAAO,MAAM,EAAE,CAAC,QAAQ,CAAC,CAAC;IAC5B,CAAC;YAAS,CAAC;QACT,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IAClE,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,sBAAsB,CAAC,EAC3C,KAAK,EACL,aAAa,GACiB;IAC9B,MAAM,oBAAoB,GAAG,aAAa,KAAK,mBAAmB,CAAC,wBAAwB,CAAC;IAC5F,MAAM,eAAe,GAAG,aAAa,KAAK,mBAAmB,CAAC,YAAY,CAAC;IAC3E,IAAI,CAAC,oBAAoB,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAChG,OAAO,IAAA,yDAA2B,EAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC,CAAW,EAAE;YAC5E,aAAa,EAAE,eAAe;SAC/B,CAAC,CAAC;IACL,CAAC;IAED,MAAM,WAAW,GACf,KAAK,CAAC,IAAI,KAAK,MAAM;QACnB,CAAC,CAAC,MAAM,iBAAiB,CAAC,KAAK,CAAC,sBAAsB,CAAC;QACvD,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC;IAExB,MAAM,mBAAmB,GAAG,oBAAoB,CAAC,CAAC,CAAC,IAAA,iDAAmB,EAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC;IAElG,OAAO,YAAY,CAAC,mBAAmB,EAAE,KAAK,EAAE,YAAY,EAAE,EAAE;QAC9D,OAAO,IAAA,yDAA2B,EAAC,YAAY,EAAE;YAC/C,aAAa,EAAE,eAAe;SAC/B,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC"}
+{"version":3,"file":"typeInformation.js","sourceRoot":"","sources":["../src/typeInformation.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwSA,4DAkBC;AAQD,gEAkBC;AAqED,wDAwBC;AAjbD,uCAAyB;AACzB,uCAAyB;AACzB,2CAA6B;AAE7B,qFAG6C;AAC7C,mCAAkC;AAElC;;GAEG;AACH,IAAY,cAKX;AALD,WAAY,cAAc;IACxB,qDAAK,CAAA;IACL,mDAAI,CAAA;IACJ,uDAAM,CAAA;IACN,qDAAK,CAAA;AACP,CAAC,EALW,cAAc,8BAAd,cAAc,QAKzB;AA8ED;;GAEG;AACH,IAAY,QAQX;AARD,WAAY,QAAQ;IAClB,yCAAK,CAAA;IACL,mDAAU,CAAA;IACV,qCAAG,CAAA;IACH,uDAAY,CAAA;IACZ,+CAAQ,CAAA;IACR,yCAAK,CAAA;IACL,mDAAU,CAAA;AACZ,CAAC,EARW,QAAQ,wBAAR,QAAQ,QAQnB;AAED;;GAEG;AACH,IAAY,SASX;AATD,WAAY,SAAS;IACnB,uCAAG,CAAA;IACH,6CAAM,CAAA;IACN,6CAAM,CAAA;IACN,+CAAO,CAAA;IACP,yCAAI,CAAA;IACJ,mDAAS,CAAA;IACT,kDAAkD;IAClD,qDAAU,CAAA;AACZ,CAAC,EATW,SAAS,yBAAT,SAAS,QASpB;AAyKD;;;;;GAKG;AACH,SAAgB,wBAAwB,CAAC,EACvC,mBAAmB,EACnB,uBAAuB,EACvB,2BAA2B,EAC3B,2BAA2B,EAC3B,aAAa,EACb,OAAO,EACP,KAAK,GACe;IACpB,OAAO;QACL,uBAAuB,EAAE,CAAC,GAAG,mBAAmB,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE;QAC/D,2BAA2B,EAAE,CAAC,GAAG,uBAAuB,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE;QACvE,+BAA+B,EAAE,CAAC,GAAG,2BAA2B,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,EAAE;QAClF,4BAA4B,EAAE,CAAC,GAAG,2BAA2B,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,EAAE;QAC/E,aAAa;QACb,OAAO;QACP,KAAK;KACN,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAgB,0BAA0B,CAAC,EACzC,uBAAuB,EACvB,2BAA2B,EAC3B,+BAA+B,EAC/B,4BAA4B,EAC5B,aAAa,EACb,OAAO,EACP,KAAK,GACyB;IAC9B,OAAO;QACL,mBAAmB,EAAE,IAAI,GAAG,CAAS,uBAAuB,CAAC;QAC7D,uBAAuB,EAAE,IAAI,GAAG,CAAS,2BAA2B,CAAC;QACrE,2BAA2B,EAAE,IAAI,GAAG,CAAiB,+BAA+B,CAAC;QACrF,2BAA2B,EAAE,IAAI,GAAG,CAAC,4BAA4B,CAAC;QAClE,aAAa;QACb,OAAO;QACP,KAAK;KACN,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,IAAY,mBAOX;AAPD,WAAY,mBAAmB;IAC7B,2CAA2C;IAC3C,6EAAY,CAAA;IACZ,4CAA4C;IAC5C,qFAAgB,CAAA;IAChB,8FAA8F;IAC9F,qGAAwB,CAAA;AAC1B,CAAC,EAPW,mBAAmB,mCAAnB,mBAAmB,QAO9B;AA6BD,KAAK,UAAU,iBAAiB,CAAC,iBAA2B;IAC1D,MAAM,aAAa,GAAG,MAAM,IAAA,eAAO,EAAC,iBAAiB,EAAE,CAAC,QAAQ,EAAE,EAAE,CAClE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CACxC,CAAC;IACF,OAAO,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AAChC,CAAC;AAED,KAAK,UAAU,YAAY,CAAI,OAAe,EAAE,EAAoC;IAClF,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,WAAW,CAAC,CAAC,CAAC;IAC/E,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,oCAAoC,CAAC,CAAC;IAE1E,IAAI,CAAC;QACH,MAAM,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QACvD,OAAO,MAAM,EAAE,CAAC,QAAQ,CAAC,CAAC;IAC5B,CAAC;YAAS,CAAC;QACT,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IAClE,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,sBAAsB,CAAC,EAC3C,KAAK,EACL,aAAa,GACiB;IAC9B,MAAM,oBAAoB,GAAG,aAAa,KAAK,mBAAmB,CAAC,wBAAwB,CAAC;IAC5F,MAAM,eAAe,GAAG,aAAa,KAAK,mBAAmB,CAAC,YAAY,CAAC;IAC3E,IAAI,CAAC,oBAAoB,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAChG,OAAO,IAAA,yDAA2B,EAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC,CAAW,EAAE;YAC5E,aAAa,EAAE,eAAe;SAC/B,CAAC,CAAC;IACL,CAAC;IAED,MAAM,WAAW,GACf,KAAK,CAAC,IAAI,KAAK,MAAM;QACnB,CAAC,CAAC,MAAM,iBAAiB,CAAC,KAAK,CAAC,sBAAsB,CAAC;QACvD,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC;IAExB,MAAM,mBAAmB,GAAG,oBAAoB,CAAC,CAAC,CAAC,IAAA,iDAAmB,EAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC;IAElG,OAAO,YAAY,CAAC,mBAAmB,EAAE,KAAK,EAAE,YAAY,EAAE,EAAE;QAC9D,OAAO,IAAA,yDAA2B,EAAC,YAAY,EAAE;YAC/C,aAAa,EAAE,eAAe;SAC/B,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC"}

package/build/typescriptGeneration.d.ts

@@ -1,7 +1,16 @@
 import ts from 'typescript';
 import { ClassDeclaration, ConstructorDeclaration, EnumType, FileTypeInformation, FunctionDeclaration, ModuleClassDeclaration, RecordType, Type, ViewDeclaration } from './typeInformation';
+/**
+ * A helper type which contains the generated file content and name.
+ */
 export type OutputFile = {
+    /**
+     * @field Generated file content.
+     */
     content: string;
+    /**
+     * @field Generated file base name (e.g. `ExpoSettings.types.ts`).
+     */
     name: string;
 };
 export interface GenerationContext {
@@ -44,14 +53,55 @@ export declare function buildExposedTypesDeclarations(ctx: GenerationContext, op
     declare?: boolean;
 }): ts.Node[];
 export declare function getViewPropsTypeName(view: ViewDeclaration): string;
+/**
+ * Helper function that takes a file content string and formats it using `prettier` formatter.
+ * @param text Content of a JavaScript/TypeScript file to format.
+ * @param parser An option of which parser to use to format the file.
+ * @default "babel"
+ * @returns A promise which resolves to the `text` string after formatting using `prettier` with the given `parser`.
+ * @header TypescriptGeneration
+ */
 export declare function prettifyCode(text: string, parser?: 'babel' | 'typescript'): Promise<string>;
+/**
+ * Generates the TypeScript string content for a native View's type declaration file.
+ * @param fileTypeInformation The abstracted type information of an Expo module.
+ * @returns A promise that resolves to a string containing the TypeScript declaration file content or `null` if the generation has failed.
+ * @header TypescriptGeneration
+ */
 export declare function generateViewTypesFileContent(fileTypeInformation: FileTypeInformation): Promise<string | null>;
+/**
+ * Generates the TypeScript string content for a native View's type declaration file which mounts the View props on the global `JSXIntrinsics`.
+ * @param fileTypeInformation The abstracted type information of an Expo module.
+ * @returns A promise that resolves to a string containing the TypeScript declaration file content or `null` if the generation has failed.
+ * @header TypescriptGeneration
+ */
 export declare function generateJSXIntrinsicsFileContent(fileTypeInformation: FileTypeInformation): Promise<string | null>;
+/**
+ * Generates the TypeScript string content for a native module type declaration file.
+ * @param fileTypeInformation The abstracted type information of an Expo module.
+ * @returns A promise that resolves to a string containing the TypeScript module declaration file content or `null` if the generation has failed.
+ * @header TypescriptGeneration
+ */
 export declare function generateModuleTypesFileContent(fileTypeInformation: FileTypeInformation): Promise<string | null>;
+/**
+ * Generates a short TypeScript interface for an Expo module. This creates the content for two files: a volatile generated file containing raw type definitions,
+ * and a stable user-facing file that wraps and exports the native module methods in new functions.
+ * @param fileTypeInformation The abstracted type information of an Expo module.
+ * @returns A promise that resolves to an object containing the string contents for both the volatile generated file and the stable TypeScript interface file.
+ * @header TypescriptGeneration
+ */
 export declare function generateConciseTsInterface(fileTypeInformation: FileTypeInformation): Promise<{
     volatileGeneratedFileContent: string;
     moduleTypescriptInterfaceFileContent: string;
 }>;
+/**
+ * Generates a full, multi-file TypeScript interface for an Expo module.
+ * The generated interface is separated into a file with type definitions, a file which wraps the native module, a file for each view defined in a module and an index file which reexports all definitions from the other files.
+ *
+ * @param fileTypeInformation The abstracted type information of an Expo module.
+ * @returns A promise that resolves to an object containing the string contents for all of the generated files or `null` if the generation has failed.
+ * @header TypescriptGeneration
+ */
 export declare function generateFullTsInterface(fileTypeInformation: FileTypeInformation): Promise<{
     moduleTypesFile: OutputFile;
     moduleViewsFiles: OutputFile[];

package/build/typescriptGeneration.js

@@ -557,6 +557,14 @@ async function tsNodesToString(elements) {
     const printedTs = printer.printList(typescript_1.default.ListFormat.MultiLine | typescript_1.default.ListFormat.PreserveLines, viewTypes, resultFile);
     return await prettifyCode(printedTs, 'typescript');
 }
+/**
+ * Helper function that takes a file content string and formats it using `prettier` formatter.
+ * @param text Content of a JavaScript/TypeScript file to format.
+ * @param parser An option of which parser to use to format the file.
+ * @default "babel"
+ * @returns A promise which resolves to the `text` string after formatting using `prettier` with the given `parser`.
+ * @header TypescriptGeneration
+ */
 async function prettifyCode(text, parser = 'babel') {
     return await prettier_1.default.format(text, {
         parser,
@@ -566,6 +574,12 @@ async function prettifyCode(text, parser = 'babel') {
         singleQuote: true,
     });
 }
+/**
+ * Generates the TypeScript string content for a native View's type declaration file.
+ * @param fileTypeInformation The abstracted type information of an Expo module.
+ * @returns A promise that resolves to a string containing the TypeScript declaration file content or `null` if the generation has failed.
+ * @header TypescriptGeneration
+ */
 async function generateViewTypesFileContent(fileTypeInformation) {
     const ctx = createDefaultGenerationContext(fileTypeInformation);
     if (!ctx) {
@@ -573,6 +587,12 @@ async function generateViewTypesFileContent(fileTypeInformation) {
     }
     return tsNodesToString(buildViewDeclarationNodes(ctx));
 }
+/**
+ * Generates the TypeScript string content for a native View's type declaration file which mounts the View props on the global `JSXIntrinsics`.
+ * @param fileTypeInformation The abstracted type information of an Expo module.
+ * @returns A promise that resolves to a string containing the TypeScript declaration file content or `null` if the generation has failed.
+ * @header TypescriptGeneration
+ */
 async function generateJSXIntrinsicsFileContent(fileTypeInformation) {
     const ctx = createDefaultGenerationContext(fileTypeInformation);
     if (!ctx) {
@@ -580,6 +600,12 @@ async function generateJSXIntrinsicsFileContent(fileTypeInformation) {
     }
     return tsNodesToString(buildJSXIntrinsicsViewNodes(ctx));
 }
+/**
+ * Generates the TypeScript string content for a native module type declaration file.
+ * @param fileTypeInformation The abstracted type information of an Expo module.
+ * @returns A promise that resolves to a string containing the TypeScript module declaration file content or `null` if the generation has failed.
+ * @header TypescriptGeneration
+ */
 async function generateModuleTypesFileContent(fileTypeInformation) {
     const ctx = createDefaultGenerationContext(fileTypeInformation);
     if (!ctx) {
@@ -587,6 +613,13 @@ async function generateModuleTypesFileContent(fileTypeInformation) {
     }
     return tsNodesToString(buildModuleDeclarationNodes(ctx));
 }
+/**
+ * Generates a short TypeScript interface for an Expo module. This creates the content for two files: a volatile generated file containing raw type definitions,
+ * and a stable user-facing file that wraps and exports the native module methods in new functions.
+ * @param fileTypeInformation The abstracted type information of an Expo module.
+ * @returns A promise that resolves to an object containing the string contents for both the volatile generated file and the stable TypeScript interface file.
+ * @header TypescriptGeneration
+ */
 async function generateConciseTsInterface(fileTypeInformation) {
     const ctx = createDefaultGenerationContext(fileTypeInformation);
     if (!ctx) {
@@ -599,6 +632,14 @@ async function generateConciseTsInterface(fileTypeInformation) {
         moduleTypescriptInterfaceFileContent,
     };
 }
+/**
+ * Generates a full, multi-file TypeScript interface for an Expo module.
+ * The generated interface is separated into a file with type definitions, a file which wraps the native module, a file for each view defined in a module and an index file which reexports all definitions from the other files.
+ *
+ * @param fileTypeInformation The abstracted type information of an Expo module.
+ * @returns A promise that resolves to an object containing the string contents for all of the generated files or `null` if the generation has failed.
+ * @header TypescriptGeneration
+ */
 async function generateFullTsInterface(fileTypeInformation) {
     const ctx = createDefaultGenerationContext(fileTypeInformation);
     if (!ctx) {