@pallasoft/ps-utilities 2.9.0 → 2.10.1

package/dist/common/constants/index.d.ts

@@ -6,3 +6,4 @@ export * from './signed-token-config';
 export * from './user-token-config';
 export * from './validation-config';
 export * from './file-size-config';
+export * from './socket-token-config';

package/dist/common/constants/index.js

@@ -22,3 +22,4 @@ __exportStar(require("./signed-token-config"), exports);
 __exportStar(require("./user-token-config"), exports);
 __exportStar(require("./validation-config"), exports);
 __exportStar(require("./file-size-config"), exports);
+__exportStar(require("./socket-token-config"), exports);

package/dist/common/constants/socket-token-config.d.ts

@@ -0,0 +1,4 @@
+export declare const SocketTokenConfig: {
+    readonly defaultSeconds: 43200;
+    readonly millisecondsPerSecond: 1000;
+};

package/dist/common/constants/socket-token-config.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SocketTokenConfig = void 0;
+exports.SocketTokenConfig = {
+    defaultSeconds: 43200,
+    millisecondsPerSecond: 1000,
+};

package/dist/common/index.d.ts

@@ -12,6 +12,7 @@ export * from './phone-service';
 export * from './postal-code-service';
 export * from './recaptcha-service';
 export * from './signed-token-service';
+export * from './socket-token-service';
 export * from './string-service';
 export * from './transform-service';
 export * from './url-service';

package/dist/common/index.js

@@ -28,6 +28,7 @@ __exportStar(require("./phone-service"), exports);
 __exportStar(require("./postal-code-service"), exports);
 __exportStar(require("./recaptcha-service"), exports);
 __exportStar(require("./signed-token-service"), exports);
+__exportStar(require("./socket-token-service"), exports);
 __exportStar(require("./string-service"), exports);
 __exportStar(require("./transform-service"), exports);
 __exportStar(require("./url-service"), exports);

package/dist/common/socket-token-service.d.ts

@@ -0,0 +1,4 @@
+export declare class SocketTokenService {
+    static issue(scope: string, privateKey: string, seconds?: number): Promise<string>;
+    static verify(token: string, publicKeys: string[]): Promise<string | null>;
+}

package/dist/common/socket-token-service.js

@@ -0,0 +1,79 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SocketTokenService = void 0;
+var socket_token_config_1 = require("./constants/socket-token-config");
+var signed_token_service_1 = require("./signed-token-service");
+var SocketTokenService = /** @class */ (function () {
+    function SocketTokenService() {
+    }
+    SocketTokenService.issue = function (scope_1, privateKey_1) {
+        return __awaiter(this, arguments, void 0, function (scope, privateKey, seconds) {
+            var claims;
+            if (seconds === void 0) { seconds = socket_token_config_1.SocketTokenConfig.defaultSeconds; }
+            return __generator(this, function (_a) {
+                claims = {
+                    scope: scope,
+                    exp: Math.floor(Date.now() / socket_token_config_1.SocketTokenConfig.millisecondsPerSecond) + seconds,
+                };
+                return [2 /*return*/, signed_token_service_1.SignedTokenService.sign(claims, privateKey)];
+            });
+        });
+    };
+    SocketTokenService.verify = function (token, publicKeys) {
+        return __awaiter(this, void 0, void 0, function () {
+            var claims;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, signed_token_service_1.SignedTokenService.verify(token, publicKeys).catch(function () { return null; })];
+                    case 1:
+                        claims = _a.sent();
+                        if (claims === null ||
+                            typeof claims.scope !== 'string' ||
+                            claims.scope === '' ||
+                            typeof claims.exp !== 'number' ||
+                            claims.exp * socket_token_config_1.SocketTokenConfig.millisecondsPerSecond < Date.now())
+                            return [2 /*return*/, null];
+                        return [2 /*return*/, claims.scope];
+                }
+            });
+        });
+    };
+    return SocketTokenService;
+}());
+exports.SocketTokenService = SocketTokenService;

package/dist/index.d.ts

@@ -5,6 +5,7 @@ export declare const Client: typeof ClientNamespace;
 export type { EmailPreviewInput } from './models/email-preview-input';
 export type { SignedTokenHeader } from './models/signed-token-header';
 export type { SignedTokenKeyPair } from './models/signed-token-key-pair';
+export type { SocketTokenClaims } from './models/socket-token-claims';
 export type { UserTokenClaims } from './models/user-token-claims';
 export type { UserTokenIssueOptions } from './models/user-token-issue-options';
 export type { UserTokenRequest } from './models/user-token-request';

package/dist/models/socket-client-options.d.ts

@@ -0,0 +1,5 @@
+export interface SocketClientOptions {
+    path: string;
+    token: () => string | null;
+    transports?: string[];
+}

package/dist/models/socket-client-options.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/socket-token-claims.d.ts

@@ -0,0 +1,4 @@
+export interface SocketTokenClaims {
+    scope: string;
+    exp: number;
+}

package/dist/models/socket-token-claims.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/sockets/index.d.ts

@@ -0,0 +1,2 @@
+export * from './socket-client-service';
+export type { SocketClientOptions } from '../models/socket-client-options';

package/dist/sockets/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./socket-client-service"), exports);

package/dist/sockets/socket-client-service.d.ts

@@ -0,0 +1,5 @@
+import { type Socket } from 'socket.io-client';
+import type { SocketClientOptions } from '../models/socket-client-options';
+export declare class SocketClientService {
+    static connect(options: SocketClientOptions): Socket;
+}

package/dist/sockets/socket-client-service.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SocketClientService = void 0;
+var socket_io_client_1 = require("socket.io-client");
+var SocketClientService = /** @class */ (function () {
+    function SocketClientService() {
+    }
+    SocketClientService.connect = function (options) {
+        return (0, socket_io_client_1.io)({
+            path: options.path,
+            transports: options.transports === undefined ? ['websocket'] : options.transports,
+            auth: function (send) { return send({ token: options.token() }); },
+        });
+    };
+    return SocketClientService;
+}());
+exports.SocketClientService = SocketClientService;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@pallasoft/ps-utilities",
-	"version": "2.9.0",
+	"version": "2.10.1",
 	"private": false,
 	"main": "./dist/index.js",
 	"types": "./dist/index.d.ts",
@@ -14,6 +14,11 @@
 			"types": "./dist/server/index.d.ts",
 			"require": "./dist/server/index.js",
 			"default": "./dist/server/index.js"
+		},
+		"./sockets": {
+			"types": "./dist/sockets/index.d.ts",
+			"require": "./dist/sockets/index.js",
+			"default": "./dist/sockets/index.js"
 		}
 	},
 	"repository": {
@@ -61,10 +66,12 @@
 		"prettier": "^3.6.2",
 		"semantic-release": "^24.2.0",
 		"ts-node": "^10.9.2",
-		"typescript": "^5.9.3"
+		"typescript": "^5.9.3",
+		"socket.io-client": "^4.8.3"
 	},
 	"peerDependencies": {
-		"hono": "^4.0.0"
+		"hono": "^4.0.0",
+		"socket.io-client": "^4.8.0"
 	},
 	"dependencies": {
 		"@esbuild-plugins/tsconfig-paths": "^0.1.2",
@@ -75,5 +82,20 @@
 	"publishConfig": {
 		"access": "public",
 		"registry": "https://registry.npmjs.org/"
+	},
+	"peerDependenciesMeta": {
+		"socket.io-client": {
+			"optional": true
+		}
+	},
+	"typesVersions": {
+		"*": {
+			"server": [
+				"dist/server/index.d.ts"
+			],
+			"sockets": [
+				"dist/sockets/index.d.ts"
+			]
+		}
 	}
 }