Skip to content

Commit e0b13ea

Browse files
committed
Merge branch 'chore/scrub-internal-refs'
2 parents 2e17631 + e7cdb96 commit e0b13ea

13 files changed

Lines changed: 45 additions & 45 deletions

File tree

components/pryv-cmc/test/cmc.test.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -787,12 +787,12 @@ describe('[CMCL1] @pryv/cmc Level-1 protocol functions', function () {
787787
});
788788

789789
// ------------------------------------------------------------
790-
// Phase 5.2 (Plan 68) — J3–J10 wire-shape contract tests.
790+
// J3–J10 wire-shape contract tests.
791791
//
792792
// J1 + J2 covered by [CMCL1OA] (readOffer) + [CMCXE] (errorIds catalogue).
793793
// J3-J10 fill the remaining contract slots so a release-blocking
794794
// regression in any of these wire shapes surfaces as a unit-test
795-
// failure rather than a Phase-6 deploy-validation surprise.
795+
// failure rather than a deploy-validation surprise.
796796
// ------------------------------------------------------------
797797

798798
describe('[CMCL1OB] J3 listInvites wire-shape', function () {

components/pryv-monitor/src/Monitor.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -164,9 +164,9 @@ class Monitor extends EventEmitter {
164164
}
165165

166166
/**
167-
* Plan 66: register a handler for the server's fine-grained
168-
* `accessUpdated` event. Fires whenever a Pryv.io ≥ 2.0.0-pre.X server
169-
* emits the event after a successful `accesses.update` — payload is
167+
* Register a handler for the server's fine-grained `accessUpdated`
168+
* event. Fires whenever a Pryv.io ≥ 2.0.0-pre.X server emits the
169+
* event after a successful `accesses.update` — payload is
170170
* `{ type: 'access-updated', accessId: '<base>:<serial>', serial }`.
171171
*
172172
* Requires `Monitor.UpdateMethod.Socket` to be active (the event

components/pryv-monitor/src/UpdateMethod/Socket.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ class Socket extends UpdateMethod {
2323
this.socket = await this.monitor.connection.socket.open();
2424
this.socket.on('eventsChanged', () => { this.monitor.updateEvents(); });
2525
this.socket.on('streamsChanged', () => { this.monitor.updateStreams(); });
26-
// Plan 66: re-emit the server's fine-grained `accessUpdated` event
27-
// on the Monitor itself so consumers can subscribe via
26+
// Re-emit the server's fine-grained `accessUpdated` event on the
27+
// Monitor itself so consumers can subscribe via
2828
// `monitor.onAccessUpdated(handler)`. The underlying SocketIO has
2929
// already busted the connection's accessInfo cache; the payload
3030
// carries the new composite accessId + serial for fine-grained

components/pryv-monitor/src/index.d.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -97,10 +97,10 @@ declare module 'pryv' {
9797
stop(): Monitor;
9898

9999
/**
100-
* Plan 66: register a handler for the server's fine-grained
101-
* `accessUpdated` event. Requires `Monitor.UpdateMethod.Socket`.
102-
* The underlying `connection.socket` busts the
103-
* `connection.accessInfo` cache before this fires.
100+
* Register a handler for the server's fine-grained `accessUpdated`
101+
* event. Requires `Monitor.UpdateMethod.Socket`. The underlying
102+
* `connection.socket` busts the `connection.accessInfo` cache
103+
* before this fires.
104104
*/
105105
onAccessUpdated(handler: (payload: { type: 'access-updated', accessId: string, serial: number }) => void): Monitor;
106106

components/pryv-socket.io/src/SocketIO.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -84,10 +84,10 @@ class SocketIO extends EventEmitter {
8484
this._io.on('connect', () => {
8585
this.connecting = false;
8686
registerListeners(this);
87-
// Plan 66: when the server emits `accessUpdated` (fine-grained
88-
// event fired after every successful `accesses.update`), bust
89-
// the connection's `accessInfo` cache so the next read picks
90-
// up the new permissions / serial. Best-effort: a failed
87+
// When the server emits `accessUpdated` (fine-grained event
88+
// fired after every successful `accesses.update`), bust the
89+
// connection's `accessInfo` cache so the next read picks up
90+
// the new permissions / serial. Best-effort: a failed
9191
// refresh leaves the previous cached value intact.
9292
this._io.on('accessUpdated', () => {
9393
this.connection.accessInfo(true).catch(() => { /* swallow */ });

components/pryv/src/Connection.js

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,8 @@ class Connection {
7777
* caches the result; subsequent calls return the cached copy in O(1).
7878
* Pass `forceRefresh: true` to invalidate the cache and fetch a fresh
7979
* copy from the server — used internally by `connection.socket` to
80-
* react to Plan 66 `accessUpdated` server-push events. A failed
81-
* server fetch leaves any prior cached value intact.
80+
* react to `accessUpdated` server-push events. A failed server
81+
* fetch leaves any prior cached value intact.
8282
*
8383
* @param {boolean} [forceRefresh=false] - bypass + refresh the cache
8484
* @returns {Promise<AccessInfo>} Promise resolving to the access info
@@ -429,10 +429,10 @@ class Connection {
429429
}
430430

431431
/**
432-
* Plan 66 (open-pryv.io ≥ 2.0.0-pre.X): update an access by composite id.
433-
* Wraps `accesses.update` and translates the 409 `stale-resource` response
434-
* into a typed `StaleAccessIdError` so callers can `instanceof`-test and
435-
* refetch + retry without re-parsing the inner error.
432+
* Update an access by composite id (Pryv.io ≥ 2.0.0-pre.X). Wraps
433+
* `accesses.update` and translates the 409 `stale-resource` response
434+
* into a typed `StaleAccessIdError` so callers can `instanceof`-test
435+
* and refetch + retry without re-parsing the inner error.
436436
*
437437
* Pass `id` as the wire-format reference returned by the server — bare
438438
* cuid on a never-updated access, composite `<base>:<serial>` otherwise.
@@ -456,8 +456,8 @@ class Connection {
456456
}
457457

458458
/**
459-
* Plan 66: fetch an access by composite id including its full version
460-
* history (oldest first). Server: `accesses.getOne ?includeHistory=true`.
459+
* Fetch an access by composite id including its full version history
460+
* (oldest first). Server: `accesses.getOne ?includeHistory=true`.
461461
*
462462
* Useful for audit views. Pass the composite `<base>:<serial>` to
463463
* inspect a specific past version (the result's `current` field then

components/pryv/src/index.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -725,9 +725,9 @@ declare module 'pryv' {
725725
): Promise<HFSeriesAddResult>;
726726
/** Memoized; pass `forceRefresh: true` to bypass + refresh the cache. */
727727
accessInfo(forceRefresh?: boolean): Promise<AccessInfo>;
728-
/** Plan 66: update an access by composite id. */
728+
/** Update an access by composite id. */
729729
updateAccess(id: string, changes: object): Promise<object>;
730-
/** Plan 66: fetch an access including its full version history. */
730+
/** Fetch an access including its full version history. */
731731
getAccessWithHistory(id: string): Promise<{ access: object, current?: string, history?: object[] }>;
732732
revoke(throwOnFail?: boolean, usingConnection?: Connection): Promise<any>;
733733
readonly deltaTime: number;

components/pryv/src/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
* @property {pryv.utils} utils - Exposes some utils for HTTP calls and tools to manipulate Pryv's API endpoints
1212
* @property {pryv.PryvError} PryvError - Custom error class with innerObject + structured API-error fields
1313
* @property {pryv.MfaRequiredError} MfaRequiredError - Thrown by Service.login when the platform returns an mfaToken instead of a token. Carries `.mfaToken`.
14-
* @property {pryv.StaleAccessIdError} StaleAccessIdError - Plan 66: thrown when a Pryv.io server rejects an `accesses.update` / `accesses.delete` with a 409 stale-resource. Refetch + retry.
14+
* @property {pryv.StaleAccessIdError} StaleAccessIdError - Thrown when a Pryv.io server rejects an `accesses.update` / `accesses.delete` with a 409 stale-resource. Refetch + retry.
1515
* @property {Object} ERRORS - Catalogue of Pryv API error ids (mirrors open-pryv.io/components/errors)
1616
*/
1717
module.exports = {

components/pryv/src/lib/StaleAccessIdError.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
const PryvError = require('./PryvError');
77

88
/**
9-
* Plan 66: typed error surfaced when a Pryv.io server (≥ 2.0.0-pre.X)
10-
* rejects an `accesses.update` or `accesses.delete` call with a
11-
* 409 `stale-resource` response.
9+
* Typed error surfaced when a Pryv.io server (≥ 2.0.0-pre.X) rejects
10+
* an `accesses.update` or `accesses.delete` call with a 409
11+
* `stale-resource` response.
1212
*
1313
* The composite access id `<base>:<serial>` carries the version the
1414
* caller last observed. If the access has since been updated, the

components/pryv/src/utils.js

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -226,11 +226,11 @@ const utils = module.exports = {
226226
},
227227

228228
/**
229-
* Plan 66 (open-pryv.io ≥ 2.0.0-pre.X): parse a wire-format access
230-
* reference into `{ base, serial }`. Accepts both bare cuid
231-
* (`"abc123"` → `{ base: 'abc123', serial: null }`) and composite
232-
* (`"abc123:3"` → `{ base: 'abc123', serial: 3 }`). Throws on
233-
* malformed input. Apply this to `access.id`, `access.createdBy`,
229+
* Parse a wire-format access reference into `{ base, serial }`
230+
* (Pryv.io ≥ 2.0.0-pre.X). Accepts both bare cuid (`"abc123"` →
231+
* `{ base: 'abc123', serial: null }`) and composite (`"abc123:3"` →
232+
* `{ base: 'abc123', serial: 3 }`). Throws on malformed input.
233+
* Apply this to `access.id`, `access.createdBy`,
234234
* `access.modifiedBy`, and `streamIds` entries of the form
235235
* `access-<base>:<serial>` from audit events.
236236
* @memberof pryv.utils
@@ -256,9 +256,9 @@ const utils = module.exports = {
256256
},
257257

258258
/**
259-
* Plan 66: render an `{ base, serial }` pair back to the wire
260-
* format. Bare cuid when serial is null/undefined; `<base>:<serial>`
261-
* otherwise. Mostly used to construct the composite id when calling
259+
* Render an `{ base, serial }` pair back to the wire format. Bare
260+
* cuid when serial is null/undefined; `<base>:<serial>` otherwise.
261+
* Mostly used to construct the composite id when calling
262262
* `connection.api()` for `accesses.update` / `accesses.delete`.
263263
* @memberof pryv.utils
264264
* @param {{ base: string, serial?: number | null }} ref

0 commit comments

Comments
 (0)