@api.global/typedsocket 5.1.2 → 6.0.0

package/dist_ts/typedsocket.plugins.d.ts

@@ -2,10 +2,11 @@ import * as typedrequest from '@api.global/typedrequest';
 import * as typedrequestInterfaces from '@api.global/typedrequest-interfaces';
 export { typedrequest, typedrequestInterfaces };
 import * as smartdelay from '@push.rocks/smartdelay';
+import * as smarthash from '@push.rocks/smarthash/web';
 import * as smartjson from '@push.rocks/smartjson';
 import * as smartpromise from '@push.rocks/smartpromise';
 import * as smartrx from '@push.rocks/smartrx';
 import * as smartstring from '@push.rocks/smartstring';
 import * as smarturl from '@push.rocks/smarturl';
-export { smartdelay, smartjson, smartpromise, smartrx, smartstring, smarturl };
-export type { SmartServe, IWebSocketPeer } from '@push.rocks/smartserve';
+export { smartdelay, smarthash, smartjson, smartpromise, smartrx, smartstring, smarturl };
+export type { SmartServe, IWebSocketPeer, IWebSocketTransportOwner, TWebSocketOutboundRawFrame, IWebSocketRawFrameSettlement, } from '@push.rocks/smartserve';

package/dist_ts/typedsocket.plugins.js

@@ -4,10 +4,11 @@ import * as typedrequestInterfaces from '@api.global/typedrequest-interfaces';
 export { typedrequest, typedrequestInterfaces };
 // @pushrocks scope
 import * as smartdelay from '@push.rocks/smartdelay';
+import * as smarthash from '@push.rocks/smarthash/web';
 import * as smartjson from '@push.rocks/smartjson';
 import * as smartpromise from '@push.rocks/smartpromise';
 import * as smartrx from '@push.rocks/smartrx';
 import * as smartstring from '@push.rocks/smartstring';
 import * as smarturl from '@push.rocks/smarturl';
-export { smartdelay, smartjson, smartpromise, smartrx, smartstring, smarturl };
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZWRzb2NrZXQucGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3R5cGVkc29ja2V0LnBsdWdpbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsbUJBQW1CO0FBQ25CLE9BQU8sS0FBSyxZQUFZLE1BQU0sMEJBQTBCLENBQUM7QUFDekQsT0FBTyxLQUFLLHNCQUFzQixNQUFNLHFDQUFxQyxDQUFDO0FBRTlFLE9BQU8sRUFBRSxZQUFZLEVBQUUsc0JBQXNCLEVBQUUsQ0FBQztBQUVoRCxtQkFBbUI7QUFDbkIsT0FBTyxLQUFLLFVBQVUsTUFBTSx3QkFBd0IsQ0FBQztBQUNyRCxPQUFPLEtBQUssU0FBUyxNQUFNLHVCQUF1QixDQUFDO0FBQ25ELE9BQU8sS0FBSyxZQUFZLE1BQU0sMEJBQTBCLENBQUM7QUFDekQsT0FBTyxLQUFLLE9BQU8sTUFBTSxxQkFBcUIsQ0FBQztBQUMvQyxPQUFPLEtBQUssV0FBVyxNQUFNLHlCQUF5QixDQUFDO0FBQ3ZELE9BQU8sS0FBSyxRQUFRLE1BQU0sc0JBQXNCLENBQUM7QUFFakQsT0FBTyxFQUFFLFVBQVUsRUFBRSxTQUFTLEVBQUUsWUFBWSxFQUFFLE9BQU8sRUFBRSxXQUFXLEVBQUUsUUFBUSxFQUFFLENBQUMifQ==
+export { smartdelay, smarthash, smartjson, smartpromise, smartrx, smartstring, smarturl };
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZWRzb2NrZXQucGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3R5cGVkc29ja2V0LnBsdWdpbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsbUJBQW1CO0FBQ25CLE9BQU8sS0FBSyxZQUFZLE1BQU0sMEJBQTBCLENBQUM7QUFDekQsT0FBTyxLQUFLLHNCQUFzQixNQUFNLHFDQUFxQyxDQUFDO0FBRTlFLE9BQU8sRUFBRSxZQUFZLEVBQUUsc0JBQXNCLEVBQUUsQ0FBQztBQUVoRCxtQkFBbUI7QUFDbkIsT0FBTyxLQUFLLFVBQVUsTUFBTSx3QkFBd0IsQ0FBQztBQUNyRCxPQUFPLEtBQUssU0FBUyxNQUFNLDJCQUEyQixDQUFDO0FBQ3ZELE9BQU8sS0FBSyxTQUFTLE1BQU0sdUJBQXVCLENBQUM7QUFDbkQsT0FBTyxLQUFLLFlBQVksTUFBTSwwQkFBMEIsQ0FBQztBQUN6RCxPQUFPLEtBQUssT0FBTyxNQUFNLHFCQUFxQixDQUFDO0FBQy9DLE9BQU8sS0FBSyxXQUFXLE1BQU0seUJBQXlCLENBQUM7QUFDdkQsT0FBTyxLQUFLLFFBQVEsTUFBTSxzQkFBc0IsQ0FBQztBQUVqRCxPQUFPLEVBQUUsVUFBVSxFQUFFLFNBQVMsRUFBRSxTQUFTLEVBQUUsWUFBWSxFQUFFLE9BQU8sRUFBRSxXQUFXLEVBQUUsUUFBUSxFQUFFLENBQUMifQ==

package/dist_ts/typedsocket.tags.d.ts

@@ -0,0 +1,105 @@
+import * as plugins from './typedsocket.plugins.js';
+export declare const TYPEDSOCKET_MAX_TAG_NAME_BYTES = 128;
+export declare const TYPEDSOCKET_MAX_TAG_PAYLOAD_BYTES: number;
+export declare const TYPEDSOCKET_MAX_CLIENT_TAGS_PER_PEER = 16;
+export declare const TYPEDSOCKET_MAX_CLIENT_TAG_RETAINED_BYTES_PER_PEER: number;
+export declare const TYPEDSOCKET_MAX_RETAINED_TAG_MUTATIONS_PER_PEER = 8;
+export declare const TYPEDSOCKET_MAX_RETAINED_TAG_MUTATIONS_PER_RULE = 32;
+export declare const TYPEDSOCKET_MAX_RETAINED_TAG_MUTATIONS_PER_SERVER = 256;
+export declare const TYPEDSOCKET_MAX_TAG_AUTHORIZATION_TIMEOUT_MS = 5000;
+export declare const TYPEDSOCKET_MAX_SERVER_TAG_NAMES_PER_PEER = 64;
+export declare const TYPEDSOCKET_MAX_SERVER_TAG_RETAINED_BYTES_PER_PEER: number;
+export type TTypedSocketTagOwner = 'server' | 'client';
+export type TTypedSocketTagMutationOperation = 'set' | 'remove';
+export type TTypedSocketTagDenialCode = 'CLIENT_TAGS_DISABLED' | 'INVALID_TAG_NAME' | 'TAG_NAME_TOO_LARGE' | 'TAG_NOT_ALLOWED' | 'INVALID_TAG_PAYLOAD' | 'TAG_PAYLOAD_TOO_LARGE' | 'TAG_AUTHORIZATION_DENIED' | 'TAG_AUTHORIZATION_TIMEOUT' | 'TAG_MUTATION_CAPACITY_EXCEEDED' | 'TAG_COUNT_LIMIT_EXCEEDED' | 'TAG_RETAINED_BYTES_EXCEEDED' | 'TAG_SERVER_OWNED' | 'TAG_CONNECTION_CLOSED' | 'MALFORMED_TAG_RESPONSE';
+export interface ITypedSocketTagConnectionAuthority {
+    /** Opaque identity for the exact physical peer object. */
+    readonly connectionId: string;
+    /** Opaque identity for the exact TypedRouter object selected at upgrade. */
+    readonly routingSurfaceId: string;
+}
+export interface ITypedSocketClientTagExistingState {
+    readonly owner: 'client';
+    readonly payload: unknown;
+}
+export interface ITypedSocketClientTagValidationContext {
+    readonly operation: TTypedSocketTagMutationOperation;
+    readonly name: string;
+    readonly payload: unknown;
+    readonly existing?: ITypedSocketClientTagExistingState;
+    readonly authority: ITypedSocketTagConnectionAuthority;
+    readonly abortSignal: AbortSignal;
+}
+export interface ITypedSocketClientTagRule {
+    readonly name: string;
+    readonly owner: TTypedSocketTagOwner;
+    readonly validateAndAuthorize: (contextArg: ITypedSocketClientTagValidationContext) => boolean | Promise<boolean>;
+}
+export interface ITypedSocketClientTagPolicy {
+    readonly rules: readonly ITypedSocketClientTagRule[];
+    /** May lower, but never raise, the package authorization deadline. */
+    readonly authorizationTimeoutMs?: number;
+}
+export interface ITypedSocketTagMutationSuccess {
+    readonly success: true;
+    readonly connectionId: string;
+    readonly tagRevision: number;
+    readonly code?: never;
+    readonly message?: never;
+}
+export interface ITypedSocketTagMutationDenial {
+    readonly success: false;
+    readonly code: TTypedSocketTagDenialCode;
+    readonly message: string;
+    readonly connectionId?: never;
+    readonly tagRevision?: never;
+}
+export type TTypedSocketTagMutationResponse = ITypedSocketTagMutationSuccess | ITypedSocketTagMutationDenial;
+export declare class TypedSocketClientTagDeniedError extends Error {
+    readonly code: TTypedSocketTagDenialCode;
+    constructor(codeArg: TTypedSocketTagDenialCode, messageArg: string);
+}
+interface ITagPayloadSnapshot {
+    readonly payload: unknown;
+    readonly encoded: string;
+    readonly byteLength: number;
+}
+export declare function createTypedSocketTagPayloadSnapshot(payloadArg: unknown): ITagPayloadSnapshot;
+export declare class TypedSocketTagPolicyManager {
+    private readonly rules;
+    private readonly authorizationTimeoutMs;
+    private readonly peerStates;
+    private readonly ruleStates;
+    private readonly connectionAuthorityIds;
+    private readonly routingSurfaceAuthorityIds;
+    private readonly closedPeers;
+    private attachedPeersProvider;
+    private retainedMutationWork;
+    private stopping;
+    constructor(policyArg?: ITypedSocketClientTagPolicy);
+    setClientTag(peerArg: plugins.IWebSocketPeer | undefined, nameArg: unknown, payloadArg: unknown): Promise<TTypedSocketTagMutationResponse>;
+    removeClientTag(peerArg: plugins.IWebSocketPeer | undefined, nameArg: unknown): Promise<TTypedSocketTagMutationResponse>;
+    setServerTag(peerArg: plugins.IWebSocketPeer, nameArg: string, payloadArg?: unknown): void;
+    removeServerTag(peerArg: plugins.IWebSocketPeer, nameArg: string): void;
+    handlePeerClose(peerArg: plugins.IWebSocketPeer): void;
+    setAttachedPeersProvider(providerArg: (() => readonly plugins.IWebSocketPeer[]) | undefined): void;
+    stop(peersArg: readonly plugins.IWebSocketPeer[]): void;
+    getRetainedMutationWork(): number;
+    getRetainedMutationWorkForRule(nameArg: string): number;
+    private validateClientMutation;
+    private enqueueMutation;
+    private executeSet;
+    private executeRemove;
+    private authorize;
+    private reconcileName;
+    private releaseAdmission;
+    private createFingerprint;
+    private createSuccess;
+    private getPeerState;
+    private isPeerLive;
+    private getConnectionAuthorityId;
+    private getRoutingSurfaceAuthorityId;
+    private assertServerMutationName;
+    private retainServerTag;
+}
+export {};