memorio 4.5.3 โ 4.6.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +157 -94
- package/SUMMARY.md +1 -0
- package/index.cjs +999 -893
- package/index.d.ts +18 -8
- package/index.js +970 -887
- package/markdown/CHANGELOG.md +71 -0
- package/markdown/IMPORT.md +139 -0
- package/markdown/PLATFORM.md +7 -3
- package/markdown/STATE.md +3 -0
- package/markdown/STORE.md +3 -0
- package/package.json +1 -1
- package/types/exports.d.ts +58 -0
- package/CODE_OF_CONDUCT.md +0 -108
- package/CONTRIBUTING.md +0 -105
- package/COPYRIGHT.md +0 -6
- package/LICENSE.md +0 -21
- package/SECURITY.md +0 -48
- package/llms.txt +0 -405
package/markdown/CHANGELOG.md
CHANGED
|
@@ -4,6 +4,77 @@ All notable changes to this project will be documented in this file.
|
|
|
4
4
|
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
+
## v4.6.1 (Security Patch) - 2026-08-14 โ CRITICAL Security Fix
|
|
8
|
+
|
|
9
|
+
### ๐ Security NOTICE (v4.6.0)
|
|
10
|
+
|
|
11
|
+
**CRITICAL**: A Gitea Personal Access Token was accidentally committed to `.npmrc` in v4.6.0
|
|
12
|
+
|
|
13
|
+
**Affected**: `v4.6.0` tag and all builds from that version
|
|
14
|
+
|
|
15
|
+
**Action Required**:
|
|
16
|
+
- **IMMEDIATE**: Revoke ALL tokens on Gitea Packages by admin access
|
|
17
|
+
- **GENERATE**: Create new PAT with scope `write:package` only
|
|
18
|
+
- **CONFIGURE**: Add as secret `PAT` in GitHub Actions or Gitea Actions
|
|
19
|
+
- **UPGRADE**: Use v4.6.1 where the token is replaced with `${PAT}` environment variable
|
|
20
|
+
|
|
21
|
+
The hardcoded token `2f398d5d7a734781e96108fdd0dbbabad41ef77a` has been removed in v4.6.1.
|
|
22
|
+
|
|
23
|
+
### ๐ Bug Fixes
|
|
24
|
+
|
|
25
|
+
- **SECURITY**: Removed hardcoded Gitea PAT from `.npmrc` (exposed token remediated)
|
|
26
|
+
- Replaced with environment variable `${PAT}` for secure authentication
|
|
27
|
+
|
|
28
|
+
### ๐ Documentation Updates
|
|
29
|
+
|
|
30
|
+
- `.npmrc`: Token replaced with environment variable reference
|
|
31
|
+
- `.gitea/workflows/npm.yml`: Configured to use secrets `GITEA_USER` and `PAT`
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
## v4.6.0 (Previous - SECURITY ISSUE) - 2026-08-13 โ Refactoring & Documentation
|
|
36
|
+
|
|
37
|
+
**โ ๏ธ WARNING**: This version had a hardcoded PAT token that was later remediated in v4.6.1**
|
|
38
|
+
|
|
39
|
+
### ๐ Bug Fixes
|
|
40
|
+
|
|
41
|
+
- Fixed circular import in `idb/index.ts` โ `core/global`
|
|
42
|
+
- Fixed dead `globalThis._propertyAccessLog` reference in `observer`
|
|
43
|
+
- Fixed `dispatch.remove(f)` tuple bug in `functions/dispatch.ts`
|
|
44
|
+
- Fixed `logger.isDebugEnabled` using wrong module reference
|
|
45
|
+
- Removed dead `propertyAccessLog` / `pushPropertyAccess` from `core/internal.ts`
|
|
46
|
+
- Removed duplicate path-tracking block in `state` get handler
|
|
47
|
+
- Removed redundant `?? key` fallback in `state` set handler
|
|
48
|
+
|
|
49
|
+
### ๐ง Code Refactoring
|
|
50
|
+
|
|
51
|
+
- **Self-contained modules**: All modules now work independently without internal `globalThis.memorio.*` reads/writes
|
|
52
|
+
- **Module-local state**: Created `core/internal.ts` for module-local singletons
|
|
53
|
+
- **Bootstrap-only global**: `core/global.ts` now only publishes to `globalThis.memorio` at initialization
|
|
54
|
+
- **Removed dead code**: `core/constructor.ts` deleted (unused)
|
|
55
|
+
- **Extracted helpers**: `_read`/`_write`/`_remove` in `store` and `session` to eliminate duplication
|
|
56
|
+
- **Fixed circular imports**: `dispatch` โ `observer` via `globalThis.events`
|
|
57
|
+
|
|
58
|
+
### ๐ Documentation Updates
|
|
59
|
+
|
|
60
|
+
- `docs/README.md`: Added Classic `import { state } from 'memorio'` section, improved badges layout, enhanced "Why memorio?" comparison table
|
|
61
|
+
- `docs/markdown/STORE.md`: Added classic import note
|
|
62
|
+
- `docs/markdown/IMPORT.md`: New file for named export guide
|
|
63
|
+
- `docs/SUMMARY.md`: Updated to include `IMPORT.md`
|
|
64
|
+
- `README.md`: Badge corrections, header cleanup, removed unverified bundle size claims
|
|
65
|
+
|
|
66
|
+
### ๐ GitHub Actions / Gitea Workflows
|
|
67
|
+
|
|
68
|
+
- Added `.gitea/workflows/npm.yml` for automatic npm package publishing to Gitea Packages on `v*` tags
|
|
69
|
+
- Requires `GITEA_USER` and `PAT` secrets
|
|
70
|
+
|
|
71
|
+
### ๐งช Tests
|
|
72
|
+
|
|
73
|
+
- **Result: 9 suites ยท 101 passed ยท 4 skipped ยท 1 todo**
|
|
74
|
+
- All lint and typecheck clean
|
|
75
|
+
|
|
76
|
+
---
|
|
77
|
+
|
|
7
78
|
## v3.0.2 (Current) - 2026-05-19 โ Bug Fix, Security & API Expansion
|
|
8
79
|
|
|
9
80
|
### ๐ Bug Fixes
|
|
@@ -0,0 +1,139 @@
|
|
|
1
|
+
# Classic `import` support
|
|
2
|
+
|
|
3
|
+
Memorio supports two equivalent styles: the original global side-effect import,
|
|
4
|
+
and the new named exports. Both share the same instances (one source of truth).
|
|
5
|
+
|
|
6
|
+
```typescript
|
|
7
|
+
// Global style (original)
|
|
8
|
+
import 'memorio'
|
|
9
|
+
state.user = { name: 'Sara' }
|
|
10
|
+
|
|
11
|
+
// Classic import style (new)
|
|
12
|
+
import { state } from 'memorio'
|
|
13
|
+
state.user = { name: 'Sara' }
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
`state` in both examples is the exact same Proxy object.
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
## Why two styles?
|
|
21
|
+
|
|
22
|
+
| Style | When to use |
|
|
23
|
+
|-------|-------------|
|
|
24
|
+
| `import 'memorio'` | Zero-config, global access everywhere, legacy scripts |
|
|
25
|
+
| `import { state } from 'memorio'` | Explicit dependencies, tree-shakeable bundles, TypeScript IntelliSense |
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
## ESM named imports
|
|
30
|
+
|
|
31
|
+
All modules are available as named exports:
|
|
32
|
+
|
|
33
|
+
```typescript
|
|
34
|
+
import {
|
|
35
|
+
state,
|
|
36
|
+
store,
|
|
37
|
+
session,
|
|
38
|
+
cache,
|
|
39
|
+
idb,
|
|
40
|
+
observer,
|
|
41
|
+
useObserver,
|
|
42
|
+
dispatch,
|
|
43
|
+
message,
|
|
44
|
+
devtools,
|
|
45
|
+
logger
|
|
46
|
+
} from 'memorio'
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Platform helpers:
|
|
50
|
+
|
|
51
|
+
```typescript
|
|
52
|
+
import {
|
|
53
|
+
isBrowser,
|
|
54
|
+
isNode,
|
|
55
|
+
isDeno,
|
|
56
|
+
isEdge,
|
|
57
|
+
getCapabilities,
|
|
58
|
+
createContext,
|
|
59
|
+
listContexts,
|
|
60
|
+
deleteContext
|
|
61
|
+
} from 'memorio'
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
Internal utilities (for tests/debug):
|
|
65
|
+
|
|
66
|
+
```typescript
|
|
67
|
+
import internal, { propertyName } from 'memorio'
|
|
68
|
+
import { setContext, getContext } from 'memorio'
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
Default export (the public `memorio` namespace):
|
|
72
|
+
|
|
73
|
+
```typescript
|
|
74
|
+
import memorio from 'memorio'
|
|
75
|
+
memorio.help()
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
---
|
|
79
|
+
|
|
80
|
+
## CJS usage
|
|
81
|
+
|
|
82
|
+
```javascript
|
|
83
|
+
const { state, store, memorio } = require('memorio')
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
---
|
|
87
|
+
|
|
88
|
+
## React / useObserver
|
|
89
|
+
|
|
90
|
+
`useObserver` works the same way via named import:
|
|
91
|
+
|
|
92
|
+
```tsx
|
|
93
|
+
import { useObserver, state } from 'memorio'
|
|
94
|
+
|
|
95
|
+
function Counter() {
|
|
96
|
+
const [, forceUpdate] = useReducer(x => x + 1, 0)
|
|
97
|
+
|
|
98
|
+
useObserver(forceUpdate, [state.counter])
|
|
99
|
+
|
|
100
|
+
return <div>Count: {state.counter}</div>
|
|
101
|
+
}
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
---
|
|
105
|
+
|
|
106
|
+
## Context isolation
|
|
107
|
+
|
|
108
|
+
```typescript
|
|
109
|
+
import { createContext, listContexts, deleteContext, isolate } from 'memorio'
|
|
110
|
+
|
|
111
|
+
const ctx = createContext('tenant-123')
|
|
112
|
+
ctx.state.user = { name: 'Isolated' }
|
|
113
|
+
ctx.store.set('settings', { theme: 'dark' })
|
|
114
|
+
|
|
115
|
+
listContexts() // ['tenant-123']
|
|
116
|
+
deleteContext('tenant-123')
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
---
|
|
120
|
+
|
|
121
|
+
## Same-instance guarantee
|
|
122
|
+
|
|
123
|
+
Named exports point to the same instances published on `globalThis` by
|
|
124
|
+
`core/global` at bootstrap. Mutating via named export mutates the global,
|
|
125
|
+
and vice versa.
|
|
126
|
+
|
|
127
|
+
```typescript
|
|
128
|
+
import { state } from 'memorio'
|
|
129
|
+
|
|
130
|
+
state.importedFlag = true
|
|
131
|
+
console.debug(globalThis.state.importedFlag) // true
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
---
|
|
135
|
+
|
|
136
|
+
## Migration from global-only
|
|
137
|
+
|
|
138
|
+
No code changes required. Existing `import 'memorio'` + `state.foo = 1`
|
|
139
|
+
continues to work unchanged. Named exports are additive.
|
package/markdown/PLATFORM.md
CHANGED
|
@@ -41,8 +41,8 @@ Memorio automatically detects the environment on import:
|
|
|
41
41
|
import 'memorio';
|
|
42
42
|
|
|
43
43
|
// Check current platform
|
|
44
|
-
console.debug(memorio.platform);
|
|
45
|
-
console.debug(
|
|
44
|
+
console.debug(memorio.getCapabilities().platform); // 'browser' | 'node' | 'deno' | 'edge'
|
|
45
|
+
console.debug(store.isPersistent); // true if using real localStorage
|
|
46
46
|
```
|
|
47
47
|
|
|
48
48
|
### Available Platform APIs
|
|
@@ -257,5 +257,9 @@ Same as browser - localStorage and sessionStorage are available.
|
|
|
257
257
|
| Property | Type | Description |
|
|
258
258
|
|----------|------|-------------|
|
|
259
259
|
| `memorio.version` | `string` | Memorio version |
|
|
260
|
-
| `memorio.platform` | `string` | Current platform |
|
|
260
|
+
| `memorio.getCapabilities().platform` | `string` | Current platform |
|
|
261
|
+
| `memorio.isBrowser()` / `isNode()` / `isDeno()` / `isEdge()` | `boolean` | Platform checks |
|
|
261
262
|
| `memorio._sessionId` | `string` | Unique session identifier |
|
|
263
|
+
|
|
264
|
+
> **Classic `import`**: context APIs are also named exports.
|
|
265
|
+
> `import { createContext, listContexts, deleteContext, isolate } from 'memorio'`.
|
package/markdown/STATE.md
CHANGED
package/markdown/STORE.md
CHANGED
package/package.json
CHANGED
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Named exports for classic `import` usage.
|
|
3
|
+
*
|
|
4
|
+
* Every export below points to the exact same instance
|
|
5
|
+
* already defined on globalThis by the core modules.
|
|
6
|
+
* `import { state } from 'memorio'` === `globalThis.state`.
|
|
7
|
+
*
|
|
8
|
+
* @see index.ts (runtime re-export)
|
|
9
|
+
*/
|
|
10
|
+
|
|
11
|
+
/// <reference path="./memorio.d.ts" />
|
|
12
|
+
/// <reference path="./state.d.ts" />
|
|
13
|
+
/// <reference path="./store.d.ts" />
|
|
14
|
+
/// <reference path="./session.d.ts" />
|
|
15
|
+
/// <reference path="./cache.d.ts" />
|
|
16
|
+
/// <reference path="./idb.d.ts" />
|
|
17
|
+
/// <reference path="./observer.d.ts" />
|
|
18
|
+
/// <reference path="./useObserver.d.ts" />
|
|
19
|
+
|
|
20
|
+
export const memorio: _memorio
|
|
21
|
+
export const state: _state
|
|
22
|
+
export const store: _store
|
|
23
|
+
export const session: _session
|
|
24
|
+
export const cache: _cache
|
|
25
|
+
export const idb: _idb
|
|
26
|
+
export const observer: _observer
|
|
27
|
+
export const useObserver: _useObserver
|
|
28
|
+
export const dispatch: _dispatch
|
|
29
|
+
export const events: Record<string, any>
|
|
30
|
+
|
|
31
|
+
export const isBrowser: () => boolean
|
|
32
|
+
export const isNode: () => boolean
|
|
33
|
+
export const isDeno: () => boolean
|
|
34
|
+
export const isEdge: () => boolean
|
|
35
|
+
export const getCapabilities: (...args: unknown[]) => any
|
|
36
|
+
export const createContext: _memorio['createContext']
|
|
37
|
+
export const listContexts: _memorio['listContexts']
|
|
38
|
+
export const deleteContext: _memorio['deleteContext']
|
|
39
|
+
export const isolate: _memorio['isolate']
|
|
40
|
+
export const message: (...args: unknown[]) => void
|
|
41
|
+
export const help: () => void
|
|
42
|
+
|
|
43
|
+
export const propertyName: (container: any, object: any) => string | null
|
|
44
|
+
export const internal: {
|
|
45
|
+
debug: boolean
|
|
46
|
+
tracking: boolean
|
|
47
|
+
trackedPaths: Set<string>
|
|
48
|
+
locked: boolean
|
|
49
|
+
lastAccessedPath: string
|
|
50
|
+
stateVersion: number
|
|
51
|
+
currentContext: string | null
|
|
52
|
+
clearTrackedPaths(): void
|
|
53
|
+
bumpStateVersion(): number
|
|
54
|
+
}
|
|
55
|
+
export const setContext: (id: string) => void
|
|
56
|
+
export const getContext: () => string | null
|
|
57
|
+
|
|
58
|
+
export default memorio
|
package/CODE_OF_CONDUCT.md
DELETED
|
@@ -1,108 +0,0 @@
|
|
|
1
|
-
# Code of Conduct โ memorio
|
|
2
|
-
|
|
3
|
-
## Our Pledge
|
|
4
|
-
|
|
5
|
-
In the interest of fostering an open and welcoming environment, we as
|
|
6
|
-
contributors and maintainers pledge to make participation in our project and
|
|
7
|
-
our community a harassment-free experience for everyone, regardless of age, body
|
|
8
|
-
size, disability, ethnicity, sex characteristics, gender identity and expression,
|
|
9
|
-
level of experience, education, socio-economic status, nationality, personal
|
|
10
|
-
appearance, race, religion, or sexual identity and orientation.
|
|
11
|
-
|
|
12
|
-
## Our Standards
|
|
13
|
-
|
|
14
|
-
Examples of behavior that contributes to a positive environment for our
|
|
15
|
-
community include:
|
|
16
|
-
|
|
17
|
-
* Demonstrating empathy and kindness toward other people
|
|
18
|
-
* Being respectful of differing opinions, viewpoints, and experiences
|
|
19
|
-
* Giving and gracefully accepting constructive feedback
|
|
20
|
-
* Accepting responsibility and apologizing to those affected by our mistakes,
|
|
21
|
-
and learning from the experience
|
|
22
|
-
* Focusing on what is best not just for us as individuals, but for the
|
|
23
|
-
overall community
|
|
24
|
-
|
|
25
|
-
Examples of unacceptable behavior include:
|
|
26
|
-
|
|
27
|
-
* The use of sexualized language or imagery, and sexual attention or advances
|
|
28
|
-
* Trolling, insulting or derogatory comments, and personal or political attacks
|
|
29
|
-
* Public or private harassment
|
|
30
|
-
* Publishing others' private information, such as a physical or email
|
|
31
|
-
address, without their explicit permission
|
|
32
|
-
* Other conduct which could reasonably be considered inappropriate in a
|
|
33
|
-
professional setting
|
|
34
|
-
|
|
35
|
-
## Our Responsibilities
|
|
36
|
-
|
|
37
|
-
Project maintainers are responsible for clarifying and enforcing our standards of
|
|
38
|
-
acceptable behavior and will take appropriate and fair corrective action in
|
|
39
|
-
response to any behavior that they deem inappropriate,
|
|
40
|
-
threatening, offensive, or harmful.
|
|
41
|
-
|
|
42
|
-
Project maintainers have the right and responsibility to remove, edit, or reject
|
|
43
|
-
comments, commits, code, wiki edits, issues, and other contributions that are
|
|
44
|
-
not aligned to this Code of Conduct, and will
|
|
45
|
-
communicate reasons for moderation decisions when appropriate.
|
|
46
|
-
|
|
47
|
-
## Scope
|
|
48
|
-
|
|
49
|
-
This Code of Conduct applies within all community spaces, and also applies when
|
|
50
|
-
an individual is officially representing the community in public spaces.
|
|
51
|
-
Examples of representing our community include using an official e-mail address,
|
|
52
|
-
posting via an official social media account, or acting as an appointed
|
|
53
|
-
representative at an online or offline event.
|
|
54
|
-
|
|
55
|
-
## Enforcement
|
|
56
|
-
|
|
57
|
-
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
58
|
-
reported to the community leaders responsible for enforcement at <dariopassariello@gmail.com>.
|
|
59
|
-
All complaints will be reviewed and investigated promptly and fairly.
|
|
60
|
-
|
|
61
|
-
All community leaders are obligated to respect the privacy and security of the
|
|
62
|
-
reporter of any incident.
|
|
63
|
-
|
|
64
|
-
## Enforcement Guidelines
|
|
65
|
-
|
|
66
|
-
Community leaders will follow these Community Impact Guidelines in determining
|
|
67
|
-
the consequences for any action they deem in violation of this Code of Conduct:
|
|
68
|
-
|
|
69
|
-
### 1. Correction
|
|
70
|
-
|
|
71
|
-
**Community Impact**: Use of inappropriate language or other behavior deemed
|
|
72
|
-
unprofessional or unwelcome in the community.
|
|
73
|
-
|
|
74
|
-
**Consequence**: A private, written warning from community leaders, providing
|
|
75
|
-
clarity around the nature of the violation and an explanation of why the
|
|
76
|
-
behavior was inappropriate. A public apology may be requested.
|
|
77
|
-
|
|
78
|
-
### 2. Warning
|
|
79
|
-
|
|
80
|
-
**Community Impact**: A violation through a single incident or series
|
|
81
|
-
of actions.
|
|
82
|
-
|
|
83
|
-
**Consequence**: A warning with consequences for continued behavior. No
|
|
84
|
-
interaction with the people involved, including unsolicited interaction with
|
|
85
|
-
those enforcing the Code of Conduct, for a specified period of time. This
|
|
86
|
-
includes avoiding interactions in community spaces as well as external channels
|
|
87
|
-
like social media. Violating these terms may lead to a temporary or
|
|
88
|
-
permanent ban.
|
|
89
|
-
|
|
90
|
-
### 3. Temporary Ban
|
|
91
|
-
|
|
92
|
-
**Community Impact**: A serious violation of community standards, including
|
|
93
|
-
sustained inappropriate behavior.
|
|
94
|
-
|
|
95
|
-
**Consequence**: A temporary ban from any sort of interaction or public
|
|
96
|
-
communication with the community for a specified period of time. No public or
|
|
97
|
-
private interaction with the people involved, including unsolicited interaction
|
|
98
|
-
with those enforcing the Code of Conduct, is allowed during this period.
|
|
99
|
-
Violating these terms may lead to a permanent ban.
|
|
100
|
-
|
|
101
|
-
### 4. Permanent Ban
|
|
102
|
-
|
|
103
|
-
**Community Impact**: Demonstrating a pattern of violation of community
|
|
104
|
-
standards, including sustained inappropriate behavior, harassment of an
|
|
105
|
-
individual, or aggression toward or disparagement of classes of individuals.
|
|
106
|
-
|
|
107
|
-
**Consequence**: A permanent ban from any sort of public interaction within
|
|
108
|
-
the community.
|
package/CONTRIBUTING.md
DELETED
|
@@ -1,105 +0,0 @@
|
|
|
1
|
-
# Contributing
|
|
2
|
-
|
|
3
|
-
First off, thanks for taking the time to contribute!
|
|
4
|
-
|
|
5
|
-
All types of contributions are encouraged and valued. See the [Table of Contents](contributing.md#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions.
|
|
6
|
-
|
|
7
|
-
> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
|
|
8
|
-
>
|
|
9
|
-
> * Star the project
|
|
10
|
-
> * Tweet about it
|
|
11
|
-
> * Refer this project in your project's readme
|
|
12
|
-
> * Mention the project at local meetups and tell your friends/colleagues
|
|
13
|
-
|
|
14
|
-
## Table of Contents
|
|
15
|
-
|
|
16
|
-
* [Code of Conduct](contributing.md#code-of-conduct)
|
|
17
|
-
* [I Have a Question](contributing.md#i-have-a-question)
|
|
18
|
-
* [I Want To Contribute](contributing.md#i-want-to-contribute)
|
|
19
|
-
* [Reporting Bugs](contributing.md#reporting-bugs)
|
|
20
|
-
* [Suggesting Enhancements](contributing.md#suggesting-enhancements)
|
|
21
|
-
* [Your First Code Contribution](contributing.md#your-first-code-contribution)
|
|
22
|
-
* [Improving The Documentation](contributing.md#improving-the-documentation)
|
|
23
|
-
* [Style guides](contributing.md#styleguides)
|
|
24
|
-
* [Commit Messages](contributing.md#commit-messages)
|
|
25
|
-
* [Join The Project Team](contributing.md#join-the-project-team)
|
|
26
|
-
|
|
27
|
-
## Code of Conduct
|
|
28
|
-
|
|
29
|
-
This project and everyone participating in it is governed by the [memorio Code of Conduct](https://github.com/picla-net/picla.npm.memorio/blob/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [dariopassariello@gmail.com](mailto:dariopassariello@gmail.com).
|
|
30
|
-
|
|
31
|
-
## I Have a Question
|
|
32
|
-
|
|
33
|
-
Before you ask a question, it is best to search for existing [Issues](https://github.com/picla-net/picla.npm.memorio/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
|
|
34
|
-
|
|
35
|
-
If you then still feel the need to ask a question and need clarification, we recommend the following:
|
|
36
|
-
|
|
37
|
-
* Open an [Issue](https://github.com/picla-net/picla.npm.memorio/issues/new).
|
|
38
|
-
* Provide as much context as you can about what you're running into.
|
|
39
|
-
* Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.
|
|
40
|
-
|
|
41
|
-
We will then take care of the issue as soon as possible.
|
|
42
|
-
|
|
43
|
-
## I Want To Contribute
|
|
44
|
-
|
|
45
|
-
> ### Legal Notice
|
|
46
|
-
>
|
|
47
|
-
> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
|
|
48
|
-
|
|
49
|
-
### Reporting Bugs
|
|
50
|
-
|
|
51
|
-
#### Before Submitting a Bug Report
|
|
52
|
-
|
|
53
|
-
A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
|
|
54
|
-
|
|
55
|
-
* Make sure that you are using the latest version.
|
|
56
|
-
* Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment
|
|
57
|
-
* To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/picla-net/picla.npm.memorio/issues?q=label%3Abug).
|
|
58
|
-
* Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
|
|
59
|
-
* Collect information about the bug:
|
|
60
|
-
* Stack trace (Traceback)
|
|
61
|
-
* OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
|
|
62
|
-
* Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
|
|
63
|
-
* Possibly your input and the output
|
|
64
|
-
* Can you reliably reproduce the issue? And can you also reproduce it with older versions?
|
|
65
|
-
|
|
66
|
-
#### How Do I Submit a Good Bug Report?
|
|
67
|
-
|
|
68
|
-
> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to [dariopassariello@gmail.com](mailto:dariopassariello@gmail.com).
|
|
69
|
-
|
|
70
|
-
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
|
|
71
|
-
|
|
72
|
-
* Open an [Issue](https://github.com/picla-net/picla.npm.memorio/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
|
|
73
|
-
* Explain the behavior you would expect and the actual behavior.
|
|
74
|
-
* Please provide as much context as possible and describe the _reproduction steps_ that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
|
|
75
|
-
* Provide the information you collected in the previous section.
|
|
76
|
-
|
|
77
|
-
Once it's filed:
|
|
78
|
-
|
|
79
|
-
* The project team will label the issue accordingly.
|
|
80
|
-
* A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced.
|
|
81
|
-
* If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](contributing.md#your-first-code-contribution).
|
|
82
|
-
|
|
83
|
-
### Suggesting Enhancements
|
|
84
|
-
|
|
85
|
-
This section guides you through submitting an enhancement suggestion for memorio, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
|
|
86
|
-
|
|
87
|
-
#### Before Submitting an Enhancement
|
|
88
|
-
|
|
89
|
-
* Make sure that you are using the latest version.
|
|
90
|
-
* Perform a [search](https://github.com/picla-net/picla.npm.memorio/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
|
|
91
|
-
* Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
|
|
92
|
-
|
|
93
|
-
#### How Do I Submit a Good Enhancement Suggestion?
|
|
94
|
-
|
|
95
|
-
Enhancement suggestions are tracked as [GitHub issues](https://github.com/picla-net/picla.npm.memorio/issues).
|
|
96
|
-
|
|
97
|
-
* Use a **clear and descriptive title** for the issue to identify the suggestion.
|
|
98
|
-
* Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
|
|
99
|
-
* **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
|
|
100
|
-
* You may want to **include screenshots or screen recordings** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [screentogif](https://www.screentogif.com/) to record GIFs on macOS and Windows, and the built-in [screen recorder in GNOME](https://help.gnome.org/users/gnome-help/stable/screen-shot-record.html.en) or [SimpleScreenRecorder](https://github.com/MaartenBaert/ssr) on Linux.
|
|
101
|
-
* **Explain why this enhancement would be useful** to most boilerplate users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
|
|
102
|
-
|
|
103
|
-
## Join The Project Team
|
|
104
|
-
|
|
105
|
-
Please send email to <dariopassariello@gmail.com>
|
package/COPYRIGHT.md
DELETED
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
# Copyright
|
|
2
|
-
|
|
3
|
-
Copyright (c) 2025, Dario Passariello. All rights reserved.
|
|
4
|
-
<https://dario.passariello.ca>
|
|
5
|
-
|
|
6
|
-
This software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.
|
package/LICENSE.md
DELETED
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
# MIT License
|
|
2
|
-
|
|
3
|
-
Copyright (c) 2025 Dario Passariello
|
|
4
|
-
|
|
5
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
-
in the Software without restriction, including without limitation the rights
|
|
8
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
-
furnished to do so, subject to the following conditions:
|
|
11
|
-
|
|
12
|
-
The above copyright notice and this permission notice shall be included in all
|
|
13
|
-
copies or substantial portions of the Software.
|
|
14
|
-
|
|
15
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
-
SOFTWARE.
|
package/SECURITY.md
DELETED
|
@@ -1,48 +0,0 @@
|
|
|
1
|
-
# Security
|
|
2
|
-
|
|
3
|
-
Memorio follows NIST and NSA security standards at the enterprise level.
|
|
4
|
-
|
|
5
|
-
## Security Standards
|
|
6
|
-
|
|
7
|
-
- **NIST Guidelines**: Follows NIST SP 800-53 security controls and NIST Cybersecurity Framework
|
|
8
|
-
- **NSA Standards**: Defense-grade security practices; considers nation-state level threats in risk assessment
|
|
9
|
-
|
|
10
|
-
## Supply Chain Security
|
|
11
|
-
|
|
12
|
-
- **Socket.dev**: Minimum target score 90%; all alarms must be resolved before release
|
|
13
|
-
- **Dependency Management**: Zero production dependencies (fully dependency-free); dev dependencies audited regularly
|
|
14
|
-
- **Prohibited**: No `eval()` usage, no encrypted/obfuscated code in builds, no hardcoded secrets
|
|
15
|
-
|
|
16
|
-
## Code Security
|
|
17
|
-
|
|
18
|
-
- No hardcoded credentials or API keys
|
|
19
|
-
- Secure random session ID generation (`crypto.randomUUID` โ `crypto.getRandomValues` โ fallback)
|
|
20
|
-
- Input validation on all public APIs
|
|
21
|
-
- XSS prevention on DevTools data export
|
|
22
|
-
- Property-based access control on global objects (`Object.defineProperty` with `enumerable: false`)
|
|
23
|
-
|
|
24
|
-
## OWASP Compliance
|
|
25
|
-
|
|
26
|
-
Addresses OWASP Top 10 (2021):
|
|
27
|
-
- A01:2021 โ Broken Access Control (global object protection, property locks)
|
|
28
|
-
- A02:2021 โ Cryptographic Failures (crypto.randomUUID for session IDs)
|
|
29
|
-
- A03:2021 โ Injection (CSS sanitization in devtools)
|
|
30
|
-
- A05:2021 โ Security Misconfiguration (minimal surface area, no bundled secrets)
|
|
31
|
-
- A06:2021 โ Vulnerable and Outdated Components (regular npm audit, Socket.dev)
|
|
32
|
-
- A07:2021 โ Identification and Authentication Failures (N/A โ library, no auth)
|
|
33
|
-
- A08:2021 โ Software and Data Integrity Failures (strict tsconfig, lock files)
|
|
34
|
-
- A09:2021 โ Security Logging and Monitoring Failures (DevTools inspect, Logger module)
|
|
35
|
-
- A10:2021 โ Server-Side Request Forgery (N/A โ no network requests)
|
|
36
|
-
|
|
37
|
-
## Reporting Security Issues
|
|
38
|
-
|
|
39
|
-
If you find a security vulnerability:
|
|
40
|
-
|
|
41
|
-
1. Email [Dario Passariello](mailto:dariopassarielloa@gmail.com)
|
|
42
|
-
2. Or visit https://dario.passariello.ca/contact/
|
|
43
|
-
|
|
44
|
-
Do not open public issues for security vulnerabilities.
|
|
45
|
-
|
|
46
|
-
---
|
|
47
|
-
*Document version: 2.0 โ Last updated: 2026-05-19*
|
|
48
|
-
*Owner: BigLogic Security Team*
|