memorio 4.9.35 → 5.1.0

package/types/security.d.ts

@@ -0,0 +1,67 @@
+/*!
+  memorio
+  Copyright (c) 2025 Dario Passariello <dariopassariello@gmail.com>
+  Licensed under MIT License, see
+  dario.passariello.ca
+*/
+
+type Permission = 'read' | 'write' | 'delete' | 'admin'
+
+interface AccessRule {
+  pattern: string | ((key: string, userId?: string) => boolean)
+  permissions: Permission[]
+}
+
+type AccessRulesMap = Map<string | ((key: string, userId?: string) => boolean), Permission[]>
+
+interface AuditEntry {
+  timestamp: number
+  action: 'set' | 'get' | 'delete' | 'hydrate' | 'remove' | 'clearAll'
+  key: string
+  userId?: string
+  success: boolean
+  error?: string
+}
+
+interface ConsentRecord {
+  id: string
+  purpose: string
+  granted: boolean
+  timestamp: number
+}
+
+type ConsentsMap = Map<string, ConsentRecord[]>
+
+interface _security {
+  safeRandomUUID: () => string
+  safeRegexTest: (pattern: string, key: string) => boolean
+
+  addAccessRule: (rules: AccessRulesMap, pattern: string | ((key: string, userId?: string) => boolean), perms: Permission[]) => AccessRulesMap
+  hasPermission: (rules: AccessRulesMap, key: string, action: Permission, userId?: string) => boolean
+
+  isAuditActive: () => boolean
+  setAuditLogger: (logger: (entry: AuditEntry) => void) => void
+  logAudit: (entry: Partial<AuditEntry>) => void
+
+  sanitizeValue: (value: unknown) => unknown
+  validateKey: (key: string) => boolean
+
+  recordConsent: (consents: ConsentsMap, userId: string, purpose: string, granted: boolean) => ConsentRecord
+  hasConsent: (consents: ConsentsMap, userId: string, purpose: string) => boolean
+  revokeConsent: (consents: ConsentsMap, userId: string, purpose: string) => ConsentRecord | null
+  getConsents: (consents: ConsentsMap, userId: string) => ConsentRecord[]
+  exportUserData: (consents: ConsentsMap, userId: string) => { userId: string; exportedAt: number; consents: ConsentRecord[] }
+  deleteUserData: (consents: ConsentsMap, userId: string) => { success: boolean; deletedConsents: number }
+}
+
+declare var security: _security
+type security = _security
+
+export {
+  Permission,
+  AccessRule,
+  AccessRulesMap,
+  AuditEntry,
+  ConsentRecord,
+  ConsentsMap
+}

package/types/session.d.ts

@@ -10,24 +10,42 @@ interface _session {
     *
     * @example
     * session.set("test","example") // or Array, Object, Number, Functions...
+    * session.set("test", value, { encrypt: key })  // encrypt at rest
     *
     * @since memorio 0.0.1
     * @param name The String as name to define the session.
     * @param param The information taht you want to session (Any).
-    * @return boolean
-  */
-  set: (name: string, value: any) => void
+    * @param opts Optional { encrypt: key } to encrypt before storage.
+    * @return boolean | Promise<boolean>
+    */
+  set: (name: string, value: any, opts?: { encrypt?: any }) => boolean | Promise<boolean>
+
+  /**
+     * Configure session-wide behavior.
+     *
+     * @example
+     * session.config({ encryptionKey: derivedKey })
+     * session.config({ onError: (err, ctx) => console.error(err, ctx) })
+     * session.config({ maxObjectSize: 5 * 1024 * 1024 })
+     * session.config({ maxTotalSize: 50 * 1024 * 1024 })
+     *
+     * @since memorio 5.0
+     * @param opts { encryptionKey, onError, maxObjectSize, maxTotalSize }
+     */
+   config: (opts: { encryptionKey?: any; onError?: (err: unknown, ctx: { operation: string }) => void; maxObjectSize?: number; maxTotalSize?: number }) => void
 
   /**
     * Have back the data from a session.
     *
     * @example
     * session.get("test")
+    * session.get("test", { decrypt: key })  // decrypt an encrypted envelope
     *
     * @since memorio 0.0.1
     * @param name The String as name to define the session.
-  */
-  get: (name: string) => any
+    * @param opts Optional { decrypt: key } to decrypt an encrypted envelope.
+    */
+  get: (name: string, opts?: { decrypt?: any }) => any
 
   /**
     * Delete an existing session:

package/types/store.d.ts

@@ -14,18 +14,34 @@ interface _store {
      * @param value The information you want to store. Functions are blocked for security.
      * @return void
      */
-  set: (name: string, value: any) => void
+   set: (name: string, value: any, opts?: { encrypt?: any }) => boolean | Promise<boolean>
+  
+  /**
+    * Configure store-wide behavior.
+    *
+    * @example
+    * store.config({ encryptionKey: derivedKey })
+    * store.config({ onError: (err, ctx) => console.error(err, ctx) })
+    * store.config({ maxObjectSize: 5 * 1024 * 1024 })
+    * store.config({ maxTotalSize: 50 * 1024 * 1024 })
+    *
+    * @since memorio 5.0
+    * @param opts { encryptionKey, onError, maxObjectSize, maxTotalSize }
+   */
+  config: (opts: { encryptionKey?: any; onError?: (err: unknown, ctx: { operation: string }) => void; maxObjectSize?: number; maxTotalSize?: number }) => void
 
   /**
-    * Have back the data from a store.
+    * Gets a value from storage.
     *
     * @example
     * store.get("test")
+    * store.get("test", { decrypt: key })  // decrypt an encrypted envelope
     *
     * @since memorio 0.0.1
     * @param name The String as name to define the store.
+    * @param opts Optional { decrypt: key } to decrypt an encrypted envelope.
   */
-  get: (name: string) => any
+  get: (name: string, opts?: { decrypt?: any }) => any
 
   /**
     * Delete an existing store: