@universal-lock/types 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Lucas Rainett
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE 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/README.md

@@ -0,0 +1,80 @@
+# @universal-lock/types
+
+Shared TypeScript type definitions for the [`universal-lock`](https://github.com/lucasrainett/universal-lock) ecosystem.
+
+## Installation
+
+```bash
+npm install @universal-lock/types
+```
+
+> **Note:** You typically don't need to install this package directly. It is included as a dependency of `universal-lock` and all backend packages.
+
+## Types
+
+### Backend
+
+```typescript
+type BackendSetupFunction = () => Promise<void>;
+type BackendAcquireFunction = (lockName: string, stale: number, lockId: string) => Promise<void>;
+type BackendRenewFunction = (lockName: string, lockId: string) => Promise<void>;
+type BackendReleaseFunction = (lockName: string, lockId: string) => Promise<void>;
+
+type Backend = {
+	setup: BackendSetupFunction;
+	acquire: BackendAcquireFunction;
+	renew: BackendRenewFunction;
+	release: BackendReleaseFunction;
+};
+
+type BackendFactory = (...args: any[]) => Backend;
+```
+
+### Utility
+
+```typescript
+type AsyncFunction<R = unknown, P extends unknown[] = unknown[]> = (...args: P) => Promise<R>;
+```
+
+### Lock
+
+```typescript
+type Lock = { acquire: LockAcquireFunction };
+
+type LockAcquireFunction = (lockName: string) => Promise<LockReleaseFunction>;
+
+type LockReleaseFunction = (() => Promise<void>) & { signal: AbortSignal };
+```
+
+### Configuration
+
+```typescript
+type LockConfiguration = {
+	acquireInterval: number;
+	acquireFailTimeout: number;
+	stale: number;
+	renewInterval: number;
+	maxHoldTime: number;
+	onLockLost: (lockName: string, reason: "renewFailed" | "timeout") => void;
+	onEvent: (event: LockEvent) => void;
+};
+```
+
+### Events
+
+```typescript
+type LockEvent = { type: "acquired"; lockName: string } | { type: "released"; lockName: string } | { type: "renewed"; lockName: string } | { type: "renewFailed"; lockName: string; error: unknown } | { type: "lockLost"; lockName: string; reason: "renewFailed" | "timeout" } | { type: "acquireTimeout"; lockName: string };
+```
+
+### Lock Entry Types
+
+Used by backend implementations:
+
+```typescript
+type TimestampLockEntry = { lockId: string; timestamp: number };
+type CallbackLockEntry = { lockId: string; release: () => void };
+```
+
+## License
+
+[MIT](https://github.com/lucasrainett/universal-lock/blob/master/LICENSE)

package/dist/index.d.mts

@@ -0,0 +1,59 @@
+type AsyncFunction<R = unknown, P extends unknown[] = unknown[]> = (...args: P) => Promise<R>;
+type BackendSetupFunction = () => Promise<void>;
+type BackendAcquireFunction = (lockName: string, stale: number, lockId: string) => Promise<void>;
+type BackendRenewFunction = (lockName: string, lockId: string) => Promise<void>;
+type BackendReleaseFunction = (lockName: string, lockId: string) => Promise<void>;
+type Backend = {
+    setup: BackendSetupFunction;
+    acquire: BackendAcquireFunction;
+    renew: BackendRenewFunction;
+    release: BackendReleaseFunction;
+};
+type BackendFactory = (...args: any[]) => Backend;
+type LockEvent = {
+    type: "acquired";
+    lockName: string;
+} | {
+    type: "released";
+    lockName: string;
+} | {
+    type: "renewed";
+    lockName: string;
+} | {
+    type: "renewFailed";
+    lockName: string;
+    error: unknown;
+} | {
+    type: "lockLost";
+    lockName: string;
+    reason: "renewFailed" | "timeout";
+} | {
+    type: "acquireTimeout";
+    lockName: string;
+};
+type LockConfiguration = {
+    acquireInterval: number;
+    acquireFailTimeout: number;
+    stale: number;
+    renewInterval: number;
+    maxHoldTime: number;
+    onLockLost: (lockName: string, reason: "renewFailed" | "timeout") => void;
+    onEvent: (event: LockEvent) => void;
+};
+type LockReleaseFunction = (() => Promise<void>) & {
+    signal: AbortSignal;
+};
+type LockAcquireFunction = (lockName: string) => Promise<LockReleaseFunction>;
+type Lock = {
+    acquire: LockAcquireFunction;
+};
+type TimestampLockEntry = {
+    lockId: string;
+    timestamp: number;
+};
+type CallbackLockEntry = {
+    lockId: string;
+    release: () => void;
+};
+
+export type { AsyncFunction, Backend, BackendAcquireFunction, BackendFactory, BackendReleaseFunction, BackendRenewFunction, BackendSetupFunction, CallbackLockEntry, Lock, LockAcquireFunction, LockConfiguration, LockEvent, LockReleaseFunction, TimestampLockEntry };

package/dist/index.d.ts

@@ -0,0 +1,59 @@
+type AsyncFunction<R = unknown, P extends unknown[] = unknown[]> = (...args: P) => Promise<R>;
+type BackendSetupFunction = () => Promise<void>;
+type BackendAcquireFunction = (lockName: string, stale: number, lockId: string) => Promise<void>;
+type BackendRenewFunction = (lockName: string, lockId: string) => Promise<void>;
+type BackendReleaseFunction = (lockName: string, lockId: string) => Promise<void>;
+type Backend = {
+    setup: BackendSetupFunction;
+    acquire: BackendAcquireFunction;
+    renew: BackendRenewFunction;
+    release: BackendReleaseFunction;
+};
+type BackendFactory = (...args: any[]) => Backend;
+type LockEvent = {
+    type: "acquired";
+    lockName: string;
+} | {
+    type: "released";
+    lockName: string;
+} | {
+    type: "renewed";
+    lockName: string;
+} | {
+    type: "renewFailed";
+    lockName: string;
+    error: unknown;
+} | {
+    type: "lockLost";
+    lockName: string;
+    reason: "renewFailed" | "timeout";
+} | {
+    type: "acquireTimeout";
+    lockName: string;
+};
+type LockConfiguration = {
+    acquireInterval: number;
+    acquireFailTimeout: number;
+    stale: number;
+    renewInterval: number;
+    maxHoldTime: number;
+    onLockLost: (lockName: string, reason: "renewFailed" | "timeout") => void;
+    onEvent: (event: LockEvent) => void;
+};
+type LockReleaseFunction = (() => Promise<void>) & {
+    signal: AbortSignal;
+};
+type LockAcquireFunction = (lockName: string) => Promise<LockReleaseFunction>;
+type Lock = {
+    acquire: LockAcquireFunction;
+};
+type TimestampLockEntry = {
+    lockId: string;
+    timestamp: number;
+};
+type CallbackLockEntry = {
+    lockId: string;
+    release: () => void;
+};
+
+export type { AsyncFunction, Backend, BackendAcquireFunction, BackendFactory, BackendReleaseFunction, BackendRenewFunction, BackendSetupFunction, CallbackLockEntry, Lock, LockAcquireFunction, LockConfiguration, LockEvent, LockReleaseFunction, TimestampLockEntry };

package/dist/index.global.js

@@ -0,0 +1,21 @@
+"use strict";
+var UniversalLockTypes = (() => {
+  var __defProp = Object.defineProperty;
+  var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+  var __getOwnPropNames = Object.getOwnPropertyNames;
+  var __hasOwnProp = Object.prototype.hasOwnProperty;
+  var __copyProps = (to, from, except, desc) => {
+    if (from && typeof from === "object" || typeof from === "function") {
+      for (let key of __getOwnPropNames(from))
+        if (!__hasOwnProp.call(to, key) && key !== except)
+          __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+    }
+    return to;
+  };
+  var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+  // src/index.ts
+  var index_exports = {};
+  return __toCommonJS(index_exports);
+})();
+//# sourceMappingURL=index.global.js.map

package/dist/index.global.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export type AsyncFunction<R = unknown, P extends unknown[] = unknown[]> = (\n\t...args: P\n) => Promise<R>;\n\nexport type BackendSetupFunction = () => Promise<void>;\nexport type BackendAcquireFunction = (\n\tlockName: string,\n\tstale: number,\n\tlockId: string,\n) => Promise<void>;\nexport type BackendRenewFunction = (\n\tlockName: string,\n\tlockId: string,\n) => Promise<void>;\nexport type BackendReleaseFunction = (\n\tlockName: string,\n\tlockId: string,\n) => Promise<void>;\n\nexport type Backend = {\n\tsetup: BackendSetupFunction;\n\tacquire: BackendAcquireFunction;\n\trenew: BackendRenewFunction;\n\trelease: BackendReleaseFunction;\n};\n\nexport type BackendFactory = (...args: any[]) => Backend;\n\nexport type LockEvent =\n\t| { type: \"acquired\"; lockName: string }\n\t| { type: \"released\"; lockName: string }\n\t| { type: \"renewed\"; lockName: string }\n\t| { type: \"renewFailed\"; lockName: string; error: unknown }\n\t| { type: \"lockLost\"; lockName: string; reason: \"renewFailed\" | \"timeout\" }\n\t| { type: \"acquireTimeout\"; lockName: string };\n\nexport type LockConfiguration = {\n\tacquireInterval: number;\n\tacquireFailTimeout: number;\n\tstale: number;\n\trenewInterval: number;\n\tmaxHoldTime: number;\n\tonLockLost: (lockName: string, reason: \"renewFailed\" | \"timeout\") => void;\n\tonEvent: (event: LockEvent) => void;\n};\n\nexport type LockReleaseFunction = (() => Promise<void>) & {\n\tsignal: AbortSignal;\n};\nexport type LockAcquireFunction = (\n\tlockName: string,\n) => Promise<LockReleaseFunction>;\n\nexport type Lock = { acquire: LockAcquireFunction };\n\nexport type TimestampLockEntry = { lockId: string; timestamp: number };\nexport type CallbackLockEntry = { lockId: string; release: () => void };\n"],"mappings":";;;;;;;;;;;;;;;;;AAAA;","names":[]}

package/dist/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+module.exports = __toCommonJS(index_exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export type AsyncFunction<R = unknown, P extends unknown[] = unknown[]> = (\n\t...args: P\n) => Promise<R>;\n\nexport type BackendSetupFunction = () => Promise<void>;\nexport type BackendAcquireFunction = (\n\tlockName: string,\n\tstale: number,\n\tlockId: string,\n) => Promise<void>;\nexport type BackendRenewFunction = (\n\tlockName: string,\n\tlockId: string,\n) => Promise<void>;\nexport type BackendReleaseFunction = (\n\tlockName: string,\n\tlockId: string,\n) => Promise<void>;\n\nexport type Backend = {\n\tsetup: BackendSetupFunction;\n\tacquire: BackendAcquireFunction;\n\trenew: BackendRenewFunction;\n\trelease: BackendReleaseFunction;\n};\n\nexport type BackendFactory = (...args: any[]) => Backend;\n\nexport type LockEvent =\n\t| { type: \"acquired\"; lockName: string }\n\t| { type: \"released\"; lockName: string }\n\t| { type: \"renewed\"; lockName: string }\n\t| { type: \"renewFailed\"; lockName: string; error: unknown }\n\t| { type: \"lockLost\"; lockName: string; reason: \"renewFailed\" | \"timeout\" }\n\t| { type: \"acquireTimeout\"; lockName: string };\n\nexport type LockConfiguration = {\n\tacquireInterval: number;\n\tacquireFailTimeout: number;\n\tstale: number;\n\trenewInterval: number;\n\tmaxHoldTime: number;\n\tonLockLost: (lockName: string, reason: \"renewFailed\" | \"timeout\") => void;\n\tonEvent: (event: LockEvent) => void;\n};\n\nexport type LockReleaseFunction = (() => Promise<void>) & {\n\tsignal: AbortSignal;\n};\nexport type LockAcquireFunction = (\n\tlockName: string,\n) => Promise<LockReleaseFunction>;\n\nexport type Lock = { acquire: LockAcquireFunction };\n\nexport type TimestampLockEntry = { lockId: string; timestamp: number };\nexport type CallbackLockEntry = { lockId: string; release: () => void };\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/index.mjs

@@ -0,0 +1 @@
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@universal-lock/types",
+  "version": "1.0.0",
+  "description": "Type definitions for universal-lock",
+  "sideEffects": false,
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "browser": "dist/index.global.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    }
+  },
+  "files": [
+    "/dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/lucasrainett/universal-lock",
+    "directory": "packages/types"
+  },
+  "keywords": [
+    "universal-lock",
+    "types",
+    "typescript"
+  ],
+  "author": {
+    "name": "Lucas Rainett",
+    "email": "lucas@rainett.dev",
+    "url": "https://github.com/lucasrainett"
+  },
+  "license": "MIT",
+  "scripts": {
+    "build": "tsup",
+    "clean": "rm -rf dist"
+  }
+}