chore(types): add some type annotations

Author: troiganto

lua/orgmode/org/links/types/id.lua

@@ -56,7 +56,7 @@ end
 
 ---@private
 ---@param link string
----@return string
+---@return string?
 function OrgLinkId:_parse(link)
   return link:match('^id:(.+)$')
 end

lua/orgmode/ui/menu.lua

@@ -23,6 +23,7 @@ local config = require('orgmode.config')
 local Menu = {}
 
 ---@param data OrgMenuOpts
+---@return OrgMenu
 function Menu:new(data)
   self:_validate_data(data)
 

lua/orgmode/utils/init.lua

@@ -53,6 +53,9 @@ function utils.readfile(file, opts)
   end)
 end
 
+---@param file string
+---@param data string|string[]
+---@return OrgPromise<integer> bytes
 function utils.writefile(file, data)
   return Promise.new(function(resolve, reject)
     uv.fs_open(file, 'w', 438, function(err1, fd)
@@ -502,6 +505,7 @@ function utils.is_list(value)
   if vim.islist then
     return vim.islist(value)
   end
+  ---@diagnostic disable-next-line: deprecated
   return vim.tbl_islist(value)
 end