datocms-plugin-sdk 2.0.0 → 2.0.1

package/src/manifestTypes.ts

@@ -1,56 +1,153 @@
+/**
+ * Type representing a manifest.
+ */
 export type Manifest = {
+  /**
+   * Hooks and their respective information.
+   */
   hooks: Record<string, HookInfo>;
+  /**
+   * Base properties and methods available on every context argument.
+   */
   baseCtx: {
-    properties: AdditionalPropertiesOrMethods;
-    methods: AdditionalPropertiesOrMethods;
+    /**
+     * Properties in the base context.
+     */
+    properties: AdditionalPropertiesOrMethodsGroup[];
+    /**
+     * Methods in the base context.
+     */
+    methods: AdditionalPropertiesOrMethodsGroup[];
   };
-  selfResizingPluginFrameCtxSizingUtilities: AdditionalPropertiesOrMethods;
+  /**
+   * Extra properties and methods available on every SelfResizingPluginFrameCtx context argument
+   */
+  selfResizingPluginFrameCtxSizingUtilities: AdditionalPropertiesOrMethodsGroup;
+};
+
+/**
+ * Type representing hook information.
+ */
+export type HookInfo = {
+  /**
+   * Name of the hook.
+   */
+  name: string;
+  /**
+   * JSDoc comment and tag for the hook.
+   */
+  comment?: Comment;
+  /**
+   * Non-context arguments for the hook.
+   */
+  nonCtxArguments: NonCtxArgument[];
+  /**
+   * Context argument for the hook, if any.
+   */
+  ctxArgument?: CtxArgument;
+  /**
+   * Return type of the hook function.
+   */
+  returnType: string;
+  /**
+   * Code location where the hook is defined.
+   */
+  location: CodeLocation;
+};
+
+/**
+ * Type representing a code location.
+ */
+export type CodeLocation = {
+  /**
+   * File path where the code is defined.
+   */
+  filePath: string;
+  /**
+   * Line number in the file where the hook is defined.
+   */
+  lineNumber: number;
 };
 
 /**
  * Type alias for additional parameters or methods in context.
  */
 export type AdditionalPropertyOrMethod = {
-  comment: Comment | null; // Description of the parameter or method
-  location: {
-    filePath: string; // File path where the parameter or method is defined
-    lineNumber: number; // Line number in the file
-  };
-  type: string; // Type of the parameter or method
+  /**
+   * Description of the parameter or method.
+   */
+  comment?: Comment;
+  /**
+   * Code location where the parameter or method is defined.
+   */
+  location: CodeLocation;
+  /**
+   * Type of the parameter or method.
+   */
+  type: string;
 };
 
-export type AdditionalPropertiesOrMethods = Record<
-  string,
-  AdditionalPropertyOrMethod
->;
+export type AdditionalPropertiesOrMethodsGroup = {
+  /**
+   * Name of the group
+   */
+  name?: string;
+  /**
+   * Description of the group
+   */
+  comment?: Comment;
+  /**
+   * Type of the parameter or method.
+   */
+  items: Record<string, AdditionalPropertyOrMethod>;
+};
 
 /**
  * Type alias for the context argument extracted from hook type.
  */
 export type CtxArgument = {
+  /**
+   * Type of the context argument.
+   */
   type: string;
-  additionalProperties: AdditionalPropertiesOrMethods | null;
-  additionalMethods: AdditionalPropertiesOrMethods | null;
+  /**
+   * Additional properties in the context argument, if any.
+   */
+  additionalProperties?: AdditionalPropertiesOrMethodsGroup[];
+  /**
+   * Additional methods in the context argument, if any.
+   */
+  additionalMethods?: AdditionalPropertiesOrMethodsGroup[];
 };
 
 /**
  * Type alias for non-context arguments.
  */
 export type NonCtxArgument = {
+  /**
+   * Name of the non-context argument.
+   */
   name: string;
+  /**
+   * Type name of the non-context argument.
+   */
   typeName: string;
 };
 
-export interface HookInfo {
-  name: string;
-  comment: Comment | null; // JSDoc comment and tag
-  nonCtxArguments: NonCtxArgument[]; // Non-context arguments
-  ctxArgument: CtxArgument | null; // Context argument
-  returnType: string; // Return type of the function
-  location: {
-    filePath: string; // File path where the hook is defined
-    lineNumber: number; // Line number in the file
-  };
-}
-
-export type Comment = { comment: string; tag?: string; example?: string };
+/**
+ * Type representing a comment.
+ */
+export type Comment = {
+  /**
+   * The comment itself.
+   */
+  comment: string;
+  /**
+   * JSDoc tag for the comment, if any.
+   */
+  tag?: string;
+  /**
+   * Example or example code for the comment, if any.
+   */
+  example?: string;
+};