Add JSDoc tags

steunix · Sep 29, 2024 · 3b5f3d9 · 3b5f3d9
1 parent 82a9f38
commit 3b5f3d9
Show file tree

Hide file tree

Showing 39 changed files with 81 additions and 4 deletions.
diff --git a/api/v1/controllers/events.mjs b/api/v1/controllers/events.mjs
@@ -2,7 +2,9 @@
  * Events controller module
  * @module controllers/events
  * @author Stefano Rivoir <[email protected]>
- */
+ * @licence MIT
+ * @copyright (c) 2023-2024 - Stefano Rivoir <[email protected]>
+*/
 
 import * as R from '../../../lib/response.mjs'
 import * as Events from '../../../lib/event.mjs'

diff --git a/api/v1/controllers/folders.mjs b/api/v1/controllers/folders.mjs
@@ -2,6 +2,8 @@
  * Folders controller module
  * @module controllers/folders
  * @author Stefano Rivoir <[email protected]>
+ * @licence MIT
+ * @copyright (c) 2023-2024 - Stefano Rivoir <[email protected]>
  */
 
 import { newId } from '../../../lib/id.mjs'

diff --git a/api/v1/controllers/groups.mjs b/api/v1/controllers/groups.mjs
@@ -2,6 +2,8 @@
  * Groups controller module
  * @module controllers/groups
  * @author Stefano Rivoir <[email protected]>
+ * @licence MIT
+ * @copyright (c) 2023-2024 - Stefano Rivoir <[email protected]>
  */
 
 import { newId } from '../../../lib/id.mjs'

diff --git a/api/v1/controllers/items.mjs b/api/v1/controllers/items.mjs
@@ -2,6 +2,8 @@
  * Items controller module
  * @module controllers/items
  * @author Stefano Rivoir <[email protected]>
+ * @licence MIT
+ * @copyright (c) 2023-2024 - Stefano Rivoir <[email protected]>
  */
 
 import { Prisma } from '@prisma/client'

diff --git a/api/v1/controllers/itemtypes.mjs b/api/v1/controllers/itemtypes.mjs
@@ -2,6 +2,8 @@
  * Item types controller module
  * @module controllers/itemtypes
  * @author Stefano Rivoir <[email protected]>
+ * @licence MIT
+ * @copyright (c) 2023-2024 - Stefano Rivoir <[email protected]>
  */
 
 import * as R from '../../../lib/response.mjs'

diff --git a/api/v1/controllers/login.mjs b/api/v1/controllers/login.mjs
@@ -2,6 +2,8 @@
  * Login controller module
  * @module controllers/login
  * @author Stefano Rivoir <[email protected]>
+ * @licence MIT
+ * @copyright (c) 2023-2024 - Stefano Rivoir <[email protected]>
  */
 
 import * as LDAP from 'ldap-authentication'

diff --git a/api/v1/controllers/onetimetokens.mjs b/api/v1/controllers/onetimetokens.mjs
@@ -2,6 +2,8 @@
  * One type tokens module
  * @module controllers/onetimetokens
  * @author Stefano Rivoir <[email protected]>
+ * @licence MIT
+ * @copyright (c) 2023-2024 - Stefano Rivoir <[email protected]>
  */
 
 import * as R from '../../../lib/response.mjs'

diff --git a/api/v1/controllers/personal.mjs b/api/v1/controllers/personal.mjs
@@ -2,6 +2,8 @@
  * Personal folder controller module
  * @module controllers/personal
  * @author Stefano Rivoir <[email protected]>
+ * @licence MIT
+ * @copyright (c) 2023-2024 - Stefano Rivoir <[email protected]>
  */
 
 import * as R from '../../../lib/response.mjs'

diff --git a/api/v1/controllers/users.mjs b/api/v1/controllers/users.mjs
@@ -2,6 +2,8 @@
  * User controller module
  * @module controllers/users
  * @author Stefano Rivoir <[email protected]>
+ * @licence MIT
+ * @copyright (c) 2023-2024 - Stefano Rivoir <[email protected]>
  */
 
 import { newId } from '../../../lib/id.mjs'

diff --git a/api/v1/controllers/usersettings.mjs b/api/v1/controllers/usersettings.mjs
@@ -2,6 +2,8 @@
  * User settings controller module
  * @module controllers/usersettings
  * @author Stefano Rivoir <[email protected]>
+ * @licence MIT
+ * @copyright (c) 2023-2024 - Stefano Rivoir <[email protected]>
  */
 
 import * as R from '../../../lib/response.mjs'

diff --git a/api/v1/controllers/util.mjs b/api/v1/controllers/util.mjs
@@ -2,6 +2,8 @@
  * Util controller module
  * @module controllers/util
  * @author Stefano Rivoir <[email protected]>
+ * @licence MIT
+ * @copyright (c) 2023-2024 - Stefano Rivoir <[email protected]>
  */
 
 import generator from 'generate-password'

diff --git a/api/v1/routes/events.mjs b/api/v1/routes/events.mjs
@@ -2,6 +2,8 @@
  * Events route module
  * @module routes/events
  * @author Stefano Rivoir <[email protected]>
+ * @licence MIT
+ * @copyright (c) 2023-2024 - Stefano Rivoir <[email protected]>
  */
 
 import { Router } from 'express'

diff --git a/api/v1/routes/folders.mjs b/api/v1/routes/folders.mjs
@@ -2,6 +2,8 @@
  * Folders route module
  * @module routes/folders
  * @author Stefano Rivoir <[email protected]>
+ * @licence MIT
+ * @copyright (c) 2023-2024 - Stefano Rivoir <[email protected]>
  */
 
 import { Router } from 'express'

diff --git a/api/v1/routes/groups.mjs b/api/v1/routes/groups.mjs
@@ -2,6 +2,8 @@
  * Groups route module
  * @module routes/groups
  * @author Stefano Rivoir <[email protected]>
+ * @licence MIT
+ * @copyright (c) 2023-2024 - Stefano Rivoir <[email protected]>
  */
 
 import { Router } from 'express'

diff --git a/api/v1/routes/items.mjs b/api/v1/routes/items.mjs
@@ -2,6 +2,8 @@
  * Items route module
  * @module routes/items
  * @author Stefano Rivoir <[email protected]>
+ * @licence MIT
+ * @copyright (c) 2023-2024 - Stefano Rivoir <[email protected]>
  */
 
 import { Router } from 'express'

diff --git a/api/v1/routes/itemtypes.mjs b/api/v1/routes/itemtypes.mjs
@@ -2,6 +2,8 @@
  * Item types route module
  * @module routes/itemtypes
  * @author Stefano Rivoir <[email protected]>
+ * @licence MIT
+ * @copyright (c) 2023-2024 - Stefano Rivoir <[email protected]>
  */
 
 import { Router } from 'express'

diff --git a/api/v1/routes/login.mjs b/api/v1/routes/login.mjs
@@ -2,6 +2,8 @@
  * Login route module
  * @module routes/login
  * @author Stefano Rivoir <[email protected]>
+ * @licence MIT
+ * @copyright (c) 2023-2024 - Stefano Rivoir <[email protected]>
  */
 
 import { Router } from 'express'

diff --git a/api/v1/routes/onetimetokens.mjs b/api/v1/routes/onetimetokens.mjs
@@ -2,6 +2,8 @@
  * One time tokens module
  * @module routes/onetimetokens
  * @author Stefano Rivoir <[email protected]>
+ * @licence MIT
+ * @copyright (c) 2023-2024 - Stefano Rivoir <[email protected]>
  */
 
 import { Router } from 'express'

diff --git a/api/v1/routes/personal.mjs b/api/v1/routes/personal.mjs
@@ -2,6 +2,8 @@
  * Personal folders route module
  * @module routes/personal
  * @author Stefano Rivoir <[email protected]>
+ * @licence MIT
+ * @copyright (c) 2023-2024 - Stefano Rivoir <[email protected]>
  */
 
 import { Router } from 'express'

diff --git a/api/v1/routes/users.mjs b/api/v1/routes/users.mjs
@@ -2,6 +2,8 @@
  * Users route module
  * @module routes/users
  * @author Stefano Rivoir <[email protected]>
+ * @licence MIT
+ * @copyright (c) 2023-2024 - Stefano Rivoir <[email protected]>
  */
 
 import { Router } from 'express'

diff --git a/api/v1/routes/util.mjs b/api/v1/routes/util.mjs
@@ -2,6 +2,8 @@
  * Util route module
  * @module routes/util
  * @author Stefano Rivoir <[email protected]>
+ * @licence MIT
+ * @copyright (c) 2023-2024 - Stefano Rivoir <[email protected]>
  */
 
 import { Router } from 'express'

diff --git a/lib/auth.mjs b/lib/auth.mjs
@@ -2,6 +2,8 @@
  * Authorization module
  * @module lib/auth
  * @author Stefano Rivoir <[email protected]>
+ * @licence MIT
+ * @copyright (c) 2023-2024 - Stefano Rivoir <[email protected]>
  */
 
 import jsonwebtoken from 'jsonwebtoken'

diff --git a/lib/cache.mjs b/lib/cache.mjs
@@ -2,6 +2,8 @@
  * Cache module
  * @module lib/cache
  * @author Stefano Rivoir <[email protected]>
+ * @licence MIT
+ * @copyright (c) 2023-2024 - Stefano Rivoir <[email protected]>
  */
 
 import * as Config from './config.mjs'

diff --git a/lib/cache/cache-node.mjs b/lib/cache/cache-node.mjs
@@ -2,6 +2,8 @@
  * Cache with node-cache
  * @module lib/cache-node
  * @author Stefano Rivoir <[email protected]>
+ * @licence MIT
+ * @copyright (c) 2023-2024 - Stefano Rivoir <[email protected]>
  */
 
 import NodeCache from 'node-cache'

diff --git a/lib/cache/cache-redis.mjs b/lib/cache/cache-redis.mjs
@@ -2,7 +2,9 @@
  * Cache with Redis
  * @module lib/cache-redis
  * @author Stefano Rivoir <[email protected]>
- */
+ * @licence MIT
+ * @copyright (c) 2023-2024 - Stefano Rivoir <[email protected]>
+*/
 
 import { createClient } from 'redis'
 

diff --git a/lib/config.mjs b/lib/config.mjs
@@ -2,6 +2,8 @@
  * Config module
  * @module lib/config
  * @author Stefano Rivoir <[email protected]>
+ * @licence MIT
+ * @copyright (c) 2023-2024 - Stefano Rivoir <[email protected]>
  */
 
 import { readFile } from 'fs/promises'

diff --git a/lib/const.mjs b/lib/const.mjs
@@ -2,6 +2,8 @@
  * Const module
  * @module lib/const
  * @author Stefano Rivoir <[email protected]>
+ * @licence MIT
+ * @copyright (c) 2023-2024 - Stefano Rivoir <[email protected]>
  */
 
 export const PW_USER_ADMINID = '0'

diff --git a/lib/crypt.mjs b/lib/crypt.mjs
@@ -2,7 +2,10 @@
  * Crypto module
  * @module lib/crypt
  * @author Stefano Rivoir <[email protected]>
+ * @licence MIT
+ * @copyright (c) 2023-2024 - Stefano Rivoir <[email protected]>
  */
+
 import * as Config from '../lib/config.mjs'
 import * as crypto from 'crypto'
 import bcrypt from 'bcrypt'

diff --git a/lib/db.mjs b/lib/db.mjs
@@ -2,6 +2,8 @@
  * DB module
  * @module lib/db
  * @author Stefano Rivoir <[email protected]>
+ * @licence MIT
+ * @copyright (c) 2023-2024 - Stefano Rivoir <[email protected]>
  */
 
 import { PrismaClient } from '@prisma/client'

diff --git a/lib/event.mjs b/lib/event.mjs
@@ -2,6 +2,8 @@
  * Action log
  * @module lib/action
  * @author Stefano Rivoir <[email protected]>
+ * @licence MIT
+ * @copyright (c) 2023-2024 - Stefano Rivoir <[email protected]>
  */
 
 import DB from './db.mjs'

diff --git a/lib/id.mjs b/lib/id.mjs
@@ -2,6 +2,8 @@
  * IDs module
  * @module lib/id
  * @author Stefano Rivoir <[email protected]>
+ * @licence MIT
+ * @copyright (c) 2023-2024 - Stefano Rivoir <[email protected]>
  */
 
 import { uuidv7obj } from 'uuidv7'

diff --git a/lib/jsonvalidator.mjs b/lib/jsonvalidator.mjs
@@ -2,6 +2,8 @@
  * JSON schema validator module
  * @module lib/jsonvalidator
  * @author Stefano Rivoir <[email protected]>
+ * @licence MIT
+ * @copyright (c) 2023-2024 - Stefano Rivoir <[email protected]>
  */
 
 import Ajv from 'ajv'

diff --git a/lib/ratelimiter.mjs b/lib/ratelimiter.mjs
@@ -2,6 +2,8 @@
  * Rate limiter module
  * @module lib/random
  * @author Stefano Rivoir <[email protected]>
+ * @licence MIT
+ * @copyright (c) 2023-2024 - Stefano Rivoir <[email protected]>
  */
 
 import { rateLimit } from 'express-rate-limit'

diff --git a/lib/response.mjs b/lib/response.mjs
@@ -2,6 +2,8 @@
  * Response module
  * @module lib/response
  * @author Stefano Rivoir <[email protected]>
+ * @licence MIT
+ * @copyright (c) 2023-2024 - Stefano Rivoir <[email protected]>
  */
 
 export const CREATED = 201

diff --git a/model/folder.mjs b/model/folder.mjs
@@ -2,6 +2,8 @@
  * Folder object module
  * @module model/folder
  * @author Stefano Rivoir <[email protected]>
+ * @licence MIT
+ * @copyright (c) 2023-2024 - Stefano Rivoir <[email protected]>
  */
 
 import * as Cache from '../lib/cache.mjs'

diff --git a/model/group.mjs b/model/group.mjs
@@ -2,6 +2,8 @@
  * Group object module
  * @module model/group
  * @author Stefano Rivoir <[email protected]>
+ * @licence MIT
+ * @copyright (c) 2023-2024 - Stefano Rivoir <[email protected]>
  */
 
 import * as Cache from '../lib/cache.mjs'

diff --git a/model/item.mjs b/model/item.mjs
@@ -2,6 +2,8 @@
  * Item object module
  * @module model/item
  * @author Stefano Rivoir <[email protected]>
+ * @licence MIT
+ * @copyright (c) 2023-2024 - Stefano Rivoir <[email protected]>
  */
 
 import * as Folder from './folder.mjs'

diff --git a/model/user.mjs b/model/user.mjs
@@ -2,6 +2,8 @@
  * User object module
  * @module model/user
  * @author Stefano Rivoir <[email protected]>
+ * @licence MIT
+ * @copyright (c) 2023-2024 - Stefano Rivoir <[email protected]>
  */
 
 import DB from '../lib/db.mjs'

diff --git a/passweaver-api.mjs b/passweaver-api.mjs
@@ -1,10 +1,10 @@
 /**
  * PassWeaver, a collaborative password manager
  *
- * (c) 2023 - Stefano Rivoir <[email protected]>
- *
  * @module main
  * @author Stefano Rivoir <[email protected]>
+ * @licence MIT
+ * @copyright (c) 2023-2024 - Stefano Rivoir <[email protected]>
  */
 
 import Express from 'express'