@tslock/dynamodb 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Dan Maas
+
+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/dist/index.cjs

@@ -0,0 +1,170 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+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 = {};
+__export(index_exports, {
+  DynamoDBLockProvider: () => DynamoDBLockProvider
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/dynamodb-lock-provider.ts
+var import_client_dynamodb2 = require("@aws-sdk/client-dynamodb");
+
+// src/dynamodb-accessor.ts
+var import_client_dynamodb = require("@aws-sdk/client-dynamodb");
+var import_core2 = require("@tslock/core");
+
+// src/dynamodb-lock.ts
+var import_core = require("@tslock/core");
+var DynamoDBLock = class extends import_core.AbstractSimpleLock {
+  constructor(config, accessor) {
+    super(config);
+    this.accessor = accessor;
+  }
+  accessor;
+  async doUnlock() {
+    await this.accessor.unlock(this.config);
+  }
+  async doExtend(newConfig) {
+    return await this.accessor.extend(newConfig);
+  }
+};
+
+// src/dynamodb-accessor.ts
+var DynamoDBAccessor = class {
+  constructor(client, tableName, partitionKey, sortKey) {
+    this.client = client;
+    this.tableName = tableName;
+    this.partitionKey = partitionKey;
+    this.sortKey = sortKey;
+  }
+  client;
+  tableName;
+  partitionKey;
+  sortKey;
+  buildKey(name) {
+    const key = { [this.partitionKey]: { S: name } };
+    if (this.sortKey) {
+      key[this.sortKey.name] = { S: this.sortKey.value };
+    }
+    return key;
+  }
+  async lock(config) {
+    const now = import_core2.ClockProvider.now();
+    const isoNow = import_core2.Utils.toIsoString(now);
+    const isoLockAtMostUntil = import_core2.Utils.toIsoString((0, import_core2.lockAtMostUntil)(config));
+    const hostname = import_core2.Utils.getHostname();
+    try {
+      await this.client.send(
+        new import_client_dynamodb.UpdateItemCommand({
+          TableName: this.tableName,
+          Key: this.buildKey(config.name),
+          UpdateExpression: "SET lockUntil = :lockUntil, lockedAt = :lockedAt, lockedBy = :lockedBy",
+          ConditionExpression: "lockUntil <= :lockedAt OR attribute_not_exists(lockUntil)",
+          ExpressionAttributeValues: {
+            ":lockUntil": { S: isoLockAtMostUntil },
+            ":lockedAt": { S: isoNow },
+            ":lockedBy": { S: hostname }
+          }
+        })
+      );
+      return new DynamoDBLock(config, this);
+    } catch (e) {
+      if (e instanceof import_client_dynamodb.ConditionalCheckFailedException) return void 0;
+      throw e;
+    }
+  }
+  async extend(config) {
+    const now = import_core2.ClockProvider.now();
+    const isoNow = import_core2.Utils.toIsoString(now);
+    const isoNewLockAtMostUntil = import_core2.Utils.toIsoString((0, import_core2.lockAtMostUntil)(config));
+    const hostname = import_core2.Utils.getHostname();
+    try {
+      await this.client.send(
+        new import_client_dynamodb.UpdateItemCommand({
+          TableName: this.tableName,
+          Key: this.buildKey(config.name),
+          UpdateExpression: "SET lockUntil = :lockUntil",
+          ConditionExpression: "lockedBy = :lockedBy AND lockUntil > :now",
+          ExpressionAttributeValues: {
+            ":lockUntil": { S: isoNewLockAtMostUntil },
+            ":lockedBy": { S: hostname },
+            ":now": { S: isoNow }
+          }
+        })
+      );
+      return new DynamoDBLock(config, this);
+    } catch (e) {
+      if (e instanceof import_client_dynamodb.ConditionalCheckFailedException) return void 0;
+      throw e;
+    }
+  }
+  async unlock(config) {
+    const isoUnlock = import_core2.Utils.toIsoString((0, import_core2.unlockTime)(config));
+    try {
+      await this.client.send(
+        new import_client_dynamodb.UpdateItemCommand({
+          TableName: this.tableName,
+          Key: this.buildKey(config.name),
+          UpdateExpression: "SET lockUntil = :unlockTime",
+          ConditionExpression: `attribute_exists(${this.partitionKey})`,
+          ExpressionAttributeValues: {
+            ":unlockTime": { S: isoUnlock }
+          }
+        })
+      );
+    } catch (e) {
+      if (e instanceof import_client_dynamodb.ConditionalCheckFailedException) return;
+      throw e;
+    }
+  }
+};
+
+// src/dynamodb-lock-provider-options.ts
+function validateOptions(options) {
+  if (!options.tableName) throw new Error("tableName is required");
+  return {
+    tableName: options.tableName,
+    partitionKey: options.partitionKey ?? "_id",
+    sortKey: options.sortKey
+  };
+}
+
+// src/dynamodb-lock-provider.ts
+var DynamoDBLockProvider = class {
+  accessor;
+  constructor(options) {
+    const opts = validateOptions(options);
+    this.accessor = new DynamoDBAccessor(
+      options.client ?? new import_client_dynamodb2.DynamoDBClient({}),
+      opts.tableName,
+      opts.partitionKey,
+      opts.sortKey
+    );
+  }
+  async lock(config) {
+    return this.accessor.lock(config);
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  DynamoDBLockProvider
+});
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/dynamodb-lock-provider.ts","../src/dynamodb-accessor.ts","../src/dynamodb-lock.ts","../src/dynamodb-lock-provider-options.ts"],"sourcesContent":["export { DynamoDBLockProvider } from './dynamodb-lock-provider.js';\nexport type { DynamoDBLockProviderOptions } from './dynamodb-lock-provider-options.js';\n","import { DynamoDBClient } from '@aws-sdk/client-dynamodb';\nimport type { ExtensibleLockProvider, LockConfiguration, SimpleLock } from '@tslock/core';\nimport { DynamoDBAccessor } from './dynamodb-accessor.js';\nimport { type DynamoDBLockProviderOptions, validateOptions } from './dynamodb-lock-provider-options.js';\n\nexport class DynamoDBLockProvider implements ExtensibleLockProvider {\n  private readonly accessor: DynamoDBAccessor;\n\n  constructor(options: DynamoDBLockProviderOptions) {\n    const opts = validateOptions(options);\n    this.accessor = new DynamoDBAccessor(\n      options.client ?? new DynamoDBClient({}),\n      opts.tableName,\n      opts.partitionKey,\n      opts.sortKey,\n    );\n  }\n\n  async lock(config: LockConfiguration): Promise<SimpleLock | undefined> {\n    return this.accessor.lock(config);\n  }\n}\n","import type { DynamoDBClient } from '@aws-sdk/client-dynamodb';\nimport { ConditionalCheckFailedException, UpdateItemCommand } from '@aws-sdk/client-dynamodb';\nimport { ClockProvider, type LockConfiguration, Utils, lockAtMostUntil, unlockTime } from '@tslock/core';\nimport { DynamoDBLock } from './dynamodb-lock.js';\n\nexport class DynamoDBAccessor {\n  constructor(\n    private readonly client: DynamoDBClient,\n    private readonly tableName: string,\n    private readonly partitionKey: string,\n    private readonly sortKey?: { name: string; value: string },\n  ) {}\n\n  private buildKey(name: string): Record<string, { S: string }> {\n    const key: Record<string, { S: string }> = { [this.partitionKey]: { S: name } };\n    if (this.sortKey) {\n      key[this.sortKey.name] = { S: this.sortKey.value };\n    }\n    return key;\n  }\n\n  async lock(config: LockConfiguration): Promise<DynamoDBLock | undefined> {\n    const now = ClockProvider.now();\n    const isoNow = Utils.toIsoString(now);\n    const isoLockAtMostUntil = Utils.toIsoString(lockAtMostUntil(config));\n    const hostname = Utils.getHostname();\n\n    try {\n      await this.client.send(\n        new UpdateItemCommand({\n          TableName: this.tableName,\n          Key: this.buildKey(config.name),\n          UpdateExpression: 'SET lockUntil = :lockUntil, lockedAt = :lockedAt, lockedBy = :lockedBy',\n          ConditionExpression: 'lockUntil <= :lockedAt OR attribute_not_exists(lockUntil)',\n          ExpressionAttributeValues: {\n            ':lockUntil': { S: isoLockAtMostUntil },\n            ':lockedAt': { S: isoNow },\n            ':lockedBy': { S: hostname },\n          },\n        }),\n      );\n      return new DynamoDBLock(config, this);\n    } catch (e) {\n      if (e instanceof ConditionalCheckFailedException) return undefined;\n      throw e;\n    }\n  }\n\n  async extend(config: LockConfiguration): Promise<DynamoDBLock | undefined> {\n    const now = ClockProvider.now();\n    const isoNow = Utils.toIsoString(now);\n    const isoNewLockAtMostUntil = Utils.toIsoString(lockAtMostUntil(config));\n    const hostname = Utils.getHostname();\n\n    try {\n      await this.client.send(\n        new UpdateItemCommand({\n          TableName: this.tableName,\n          Key: this.buildKey(config.name),\n          UpdateExpression: 'SET lockUntil = :lockUntil',\n          ConditionExpression: 'lockedBy = :lockedBy AND lockUntil > :now',\n          ExpressionAttributeValues: {\n            ':lockUntil': { S: isoNewLockAtMostUntil },\n            ':lockedBy': { S: hostname },\n            ':now': { S: isoNow },\n          },\n        }),\n      );\n      return new DynamoDBLock(config, this);\n    } catch (e) {\n      if (e instanceof ConditionalCheckFailedException) return undefined;\n      throw e;\n    }\n  }\n\n  async unlock(config: LockConfiguration): Promise<void> {\n    const isoUnlock = Utils.toIsoString(unlockTime(config));\n\n    try {\n      await this.client.send(\n        new UpdateItemCommand({\n          TableName: this.tableName,\n          Key: this.buildKey(config.name),\n          UpdateExpression: 'SET lockUntil = :unlockTime',\n          ConditionExpression: `attribute_exists(${this.partitionKey})`,\n          ExpressionAttributeValues: {\n            ':unlockTime': { S: isoUnlock },\n          },\n        }),\n      );\n    } catch (e) {\n      if (e instanceof ConditionalCheckFailedException) return;\n      throw e;\n    }\n  }\n}\n","import { AbstractSimpleLock, type LockConfiguration, type SimpleLock } from '@tslock/core';\nimport type { DynamoDBAccessor } from './dynamodb-accessor.js';\n\nexport class DynamoDBLock extends AbstractSimpleLock {\n  constructor(\n    config: LockConfiguration,\n    private readonly accessor: DynamoDBAccessor,\n  ) {\n    super(config);\n  }\n\n  protected override async doUnlock(): Promise<void> {\n    await this.accessor.unlock(this.config);\n  }\n\n  protected override async doExtend(newConfig: LockConfiguration): Promise<SimpleLock | undefined> {\n    return await this.accessor.extend(newConfig);\n  }\n}\n","import type { DynamoDBClient } from '@aws-sdk/client-dynamodb';\n\nexport interface DynamoDBLockProviderOptions {\n  client?: DynamoDBClient;\n  tableName: string;\n  partitionKey?: string;\n  sortKey?: { name: string; value: string };\n}\n\nexport interface ResolvedOptions {\n  tableName: string;\n  partitionKey: string;\n  sortKey?: { name: string; value: string };\n}\n\nexport function validateOptions(options: DynamoDBLockProviderOptions): ResolvedOptions {\n  if (!options.tableName) throw new Error('tableName is required');\n  return {\n    tableName: options.tableName,\n    partitionKey: options.partitionKey ?? '_id',\n    sortKey: options.sortKey,\n  };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,IAAAA,0BAA+B;;;ACC/B,6BAAmE;AACnE,IAAAC,eAA0F;;;ACF1F,kBAA4E;AAGrE,IAAM,eAAN,cAA2B,+BAAmB;AAAA,EACnD,YACE,QACiB,UACjB;AACA,UAAM,MAAM;AAFK;AAAA,EAGnB;AAAA,EAHmB;AAAA,EAKnB,MAAyB,WAA0B;AACjD,UAAM,KAAK,SAAS,OAAO,KAAK,MAAM;AAAA,EACxC;AAAA,EAEA,MAAyB,SAAS,WAA+D;AAC/F,WAAO,MAAM,KAAK,SAAS,OAAO,SAAS;AAAA,EAC7C;AACF;;;ADbO,IAAM,mBAAN,MAAuB;AAAA,EAC5B,YACmB,QACA,WACA,cACA,SACjB;AAJiB;AACA;AACA;AACA;AAAA,EAChB;AAAA,EAJgB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EAGX,SAAS,MAA6C;AAC5D,UAAM,MAAqC,EAAE,CAAC,KAAK,YAAY,GAAG,EAAE,GAAG,KAAK,EAAE;AAC9E,QAAI,KAAK,SAAS;AAChB,UAAI,KAAK,QAAQ,IAAI,IAAI,EAAE,GAAG,KAAK,QAAQ,MAAM;AAAA,IACnD;AACA,WAAO;AAAA,EACT;AAAA,EAEA,MAAM,KAAK,QAA8D;AACvE,UAAM,MAAM,2BAAc,IAAI;AAC9B,UAAM,SAAS,mBAAM,YAAY,GAAG;AACpC,UAAM,qBAAqB,mBAAM,gBAAY,8BAAgB,MAAM,CAAC;AACpE,UAAM,WAAW,mBAAM,YAAY;AAEnC,QAAI;AACF,YAAM,KAAK,OAAO;AAAA,QAChB,IAAI,yCAAkB;AAAA,UACpB,WAAW,KAAK;AAAA,UAChB,KAAK,KAAK,SAAS,OAAO,IAAI;AAAA,UAC9B,kBAAkB;AAAA,UAClB,qBAAqB;AAAA,UACrB,2BAA2B;AAAA,YACzB,cAAc,EAAE,GAAG,mBAAmB;AAAA,YACtC,aAAa,EAAE,GAAG,OAAO;AAAA,YACzB,aAAa,EAAE,GAAG,SAAS;AAAA,UAC7B;AAAA,QACF,CAAC;AAAA,MACH;AACA,aAAO,IAAI,aAAa,QAAQ,IAAI;AAAA,IACtC,SAAS,GAAG;AACV,UAAI,aAAa,uDAAiC,QAAO;AACzD,YAAM;AAAA,IACR;AAAA,EACF;AAAA,EAEA,MAAM,OAAO,QAA8D;AACzE,UAAM,MAAM,2BAAc,IAAI;AAC9B,UAAM,SAAS,mBAAM,YAAY,GAAG;AACpC,UAAM,wBAAwB,mBAAM,gBAAY,8BAAgB,MAAM,CAAC;AACvE,UAAM,WAAW,mBAAM,YAAY;AAEnC,QAAI;AACF,YAAM,KAAK,OAAO;AAAA,QAChB,IAAI,yCAAkB;AAAA,UACpB,WAAW,KAAK;AAAA,UAChB,KAAK,KAAK,SAAS,OAAO,IAAI;AAAA,UAC9B,kBAAkB;AAAA,UAClB,qBAAqB;AAAA,UACrB,2BAA2B;AAAA,YACzB,cAAc,EAAE,GAAG,sBAAsB;AAAA,YACzC,aAAa,EAAE,GAAG,SAAS;AAAA,YAC3B,QAAQ,EAAE,GAAG,OAAO;AAAA,UACtB;AAAA,QACF,CAAC;AAAA,MACH;AACA,aAAO,IAAI,aAAa,QAAQ,IAAI;AAAA,IACtC,SAAS,GAAG;AACV,UAAI,aAAa,uDAAiC,QAAO;AACzD,YAAM;AAAA,IACR;AAAA,EACF;AAAA,EAEA,MAAM,OAAO,QAA0C;AACrD,UAAM,YAAY,mBAAM,gBAAY,yBAAW,MAAM,CAAC;AAEtD,QAAI;AACF,YAAM,KAAK,OAAO;AAAA,QAChB,IAAI,yCAAkB;AAAA,UACpB,WAAW,KAAK;AAAA,UAChB,KAAK,KAAK,SAAS,OAAO,IAAI;AAAA,UAC9B,kBAAkB;AAAA,UAClB,qBAAqB,oBAAoB,KAAK,YAAY;AAAA,UAC1D,2BAA2B;AAAA,YACzB,eAAe,EAAE,GAAG,UAAU;AAAA,UAChC;AAAA,QACF,CAAC;AAAA,MACH;AAAA,IACF,SAAS,GAAG;AACV,UAAI,aAAa,uDAAiC;AAClD,YAAM;AAAA,IACR;AAAA,EACF;AACF;;;AEhFO,SAAS,gBAAgB,SAAuD;AACrF,MAAI,CAAC,QAAQ,UAAW,OAAM,IAAI,MAAM,uBAAuB;AAC/D,SAAO;AAAA,IACL,WAAW,QAAQ;AAAA,IACnB,cAAc,QAAQ,gBAAgB;AAAA,IACtC,SAAS,QAAQ;AAAA,EACnB;AACF;;;AHjBO,IAAM,uBAAN,MAA6D;AAAA,EACjD;AAAA,EAEjB,YAAY,SAAsC;AAChD,UAAM,OAAO,gBAAgB,OAAO;AACpC,SAAK,WAAW,IAAI;AAAA,MAClB,QAAQ,UAAU,IAAI,uCAAe,CAAC,CAAC;AAAA,MACvC,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK;AAAA,IACP;AAAA,EACF;AAAA,EAEA,MAAM,KAAK,QAA4D;AACrE,WAAO,KAAK,SAAS,KAAK,MAAM;AAAA,EAClC;AACF;","names":["import_client_dynamodb","import_core"]}

package/dist/index.d.cts

@@ -0,0 +1,20 @@
+import { ExtensibleLockProvider, LockConfiguration, SimpleLock } from '@tslock/core';
+import { DynamoDBClient } from '@aws-sdk/client-dynamodb';
+
+interface DynamoDBLockProviderOptions {
+    client?: DynamoDBClient;
+    tableName: string;
+    partitionKey?: string;
+    sortKey?: {
+        name: string;
+        value: string;
+    };
+}
+
+declare class DynamoDBLockProvider implements ExtensibleLockProvider {
+    private readonly accessor;
+    constructor(options: DynamoDBLockProviderOptions);
+    lock(config: LockConfiguration): Promise<SimpleLock | undefined>;
+}
+
+export { DynamoDBLockProvider, type DynamoDBLockProviderOptions };

package/dist/index.d.ts

@@ -0,0 +1,20 @@
+import { ExtensibleLockProvider, LockConfiguration, SimpleLock } from '@tslock/core';
+import { DynamoDBClient } from '@aws-sdk/client-dynamodb';
+
+interface DynamoDBLockProviderOptions {
+    client?: DynamoDBClient;
+    tableName: string;
+    partitionKey?: string;
+    sortKey?: {
+        name: string;
+        value: string;
+    };
+}
+
+declare class DynamoDBLockProvider implements ExtensibleLockProvider {
+    private readonly accessor;
+    constructor(options: DynamoDBLockProviderOptions);
+    lock(config: LockConfiguration): Promise<SimpleLock | undefined>;
+}
+
+export { DynamoDBLockProvider, type DynamoDBLockProviderOptions };

package/dist/index.js

@@ -0,0 +1,143 @@
+// src/dynamodb-lock-provider.ts
+import { DynamoDBClient } from "@aws-sdk/client-dynamodb";
+
+// src/dynamodb-accessor.ts
+import { ConditionalCheckFailedException, UpdateItemCommand } from "@aws-sdk/client-dynamodb";
+import { ClockProvider, Utils, lockAtMostUntil, unlockTime } from "@tslock/core";
+
+// src/dynamodb-lock.ts
+import { AbstractSimpleLock } from "@tslock/core";
+var DynamoDBLock = class extends AbstractSimpleLock {
+  constructor(config, accessor) {
+    super(config);
+    this.accessor = accessor;
+  }
+  accessor;
+  async doUnlock() {
+    await this.accessor.unlock(this.config);
+  }
+  async doExtend(newConfig) {
+    return await this.accessor.extend(newConfig);
+  }
+};
+
+// src/dynamodb-accessor.ts
+var DynamoDBAccessor = class {
+  constructor(client, tableName, partitionKey, sortKey) {
+    this.client = client;
+    this.tableName = tableName;
+    this.partitionKey = partitionKey;
+    this.sortKey = sortKey;
+  }
+  client;
+  tableName;
+  partitionKey;
+  sortKey;
+  buildKey(name) {
+    const key = { [this.partitionKey]: { S: name } };
+    if (this.sortKey) {
+      key[this.sortKey.name] = { S: this.sortKey.value };
+    }
+    return key;
+  }
+  async lock(config) {
+    const now = ClockProvider.now();
+    const isoNow = Utils.toIsoString(now);
+    const isoLockAtMostUntil = Utils.toIsoString(lockAtMostUntil(config));
+    const hostname = Utils.getHostname();
+    try {
+      await this.client.send(
+        new UpdateItemCommand({
+          TableName: this.tableName,
+          Key: this.buildKey(config.name),
+          UpdateExpression: "SET lockUntil = :lockUntil, lockedAt = :lockedAt, lockedBy = :lockedBy",
+          ConditionExpression: "lockUntil <= :lockedAt OR attribute_not_exists(lockUntil)",
+          ExpressionAttributeValues: {
+            ":lockUntil": { S: isoLockAtMostUntil },
+            ":lockedAt": { S: isoNow },
+            ":lockedBy": { S: hostname }
+          }
+        })
+      );
+      return new DynamoDBLock(config, this);
+    } catch (e) {
+      if (e instanceof ConditionalCheckFailedException) return void 0;
+      throw e;
+    }
+  }
+  async extend(config) {
+    const now = ClockProvider.now();
+    const isoNow = Utils.toIsoString(now);
+    const isoNewLockAtMostUntil = Utils.toIsoString(lockAtMostUntil(config));
+    const hostname = Utils.getHostname();
+    try {
+      await this.client.send(
+        new UpdateItemCommand({
+          TableName: this.tableName,
+          Key: this.buildKey(config.name),
+          UpdateExpression: "SET lockUntil = :lockUntil",
+          ConditionExpression: "lockedBy = :lockedBy AND lockUntil > :now",
+          ExpressionAttributeValues: {
+            ":lockUntil": { S: isoNewLockAtMostUntil },
+            ":lockedBy": { S: hostname },
+            ":now": { S: isoNow }
+          }
+        })
+      );
+      return new DynamoDBLock(config, this);
+    } catch (e) {
+      if (e instanceof ConditionalCheckFailedException) return void 0;
+      throw e;
+    }
+  }
+  async unlock(config) {
+    const isoUnlock = Utils.toIsoString(unlockTime(config));
+    try {
+      await this.client.send(
+        new UpdateItemCommand({
+          TableName: this.tableName,
+          Key: this.buildKey(config.name),
+          UpdateExpression: "SET lockUntil = :unlockTime",
+          ConditionExpression: `attribute_exists(${this.partitionKey})`,
+          ExpressionAttributeValues: {
+            ":unlockTime": { S: isoUnlock }
+          }
+        })
+      );
+    } catch (e) {
+      if (e instanceof ConditionalCheckFailedException) return;
+      throw e;
+    }
+  }
+};
+
+// src/dynamodb-lock-provider-options.ts
+function validateOptions(options) {
+  if (!options.tableName) throw new Error("tableName is required");
+  return {
+    tableName: options.tableName,
+    partitionKey: options.partitionKey ?? "_id",
+    sortKey: options.sortKey
+  };
+}
+
+// src/dynamodb-lock-provider.ts
+var DynamoDBLockProvider = class {
+  accessor;
+  constructor(options) {
+    const opts = validateOptions(options);
+    this.accessor = new DynamoDBAccessor(
+      options.client ?? new DynamoDBClient({}),
+      opts.tableName,
+      opts.partitionKey,
+      opts.sortKey
+    );
+  }
+  async lock(config) {
+    return this.accessor.lock(config);
+  }
+};
+export {
+  DynamoDBLockProvider
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/dynamodb-lock-provider.ts","../src/dynamodb-accessor.ts","../src/dynamodb-lock.ts","../src/dynamodb-lock-provider-options.ts"],"sourcesContent":["import { DynamoDBClient } from '@aws-sdk/client-dynamodb';\nimport type { ExtensibleLockProvider, LockConfiguration, SimpleLock } from '@tslock/core';\nimport { DynamoDBAccessor } from './dynamodb-accessor.js';\nimport { type DynamoDBLockProviderOptions, validateOptions } from './dynamodb-lock-provider-options.js';\n\nexport class DynamoDBLockProvider implements ExtensibleLockProvider {\n  private readonly accessor: DynamoDBAccessor;\n\n  constructor(options: DynamoDBLockProviderOptions) {\n    const opts = validateOptions(options);\n    this.accessor = new DynamoDBAccessor(\n      options.client ?? new DynamoDBClient({}),\n      opts.tableName,\n      opts.partitionKey,\n      opts.sortKey,\n    );\n  }\n\n  async lock(config: LockConfiguration): Promise<SimpleLock | undefined> {\n    return this.accessor.lock(config);\n  }\n}\n","import type { DynamoDBClient } from '@aws-sdk/client-dynamodb';\nimport { ConditionalCheckFailedException, UpdateItemCommand } from '@aws-sdk/client-dynamodb';\nimport { ClockProvider, type LockConfiguration, Utils, lockAtMostUntil, unlockTime } from '@tslock/core';\nimport { DynamoDBLock } from './dynamodb-lock.js';\n\nexport class DynamoDBAccessor {\n  constructor(\n    private readonly client: DynamoDBClient,\n    private readonly tableName: string,\n    private readonly partitionKey: string,\n    private readonly sortKey?: { name: string; value: string },\n  ) {}\n\n  private buildKey(name: string): Record<string, { S: string }> {\n    const key: Record<string, { S: string }> = { [this.partitionKey]: { S: name } };\n    if (this.sortKey) {\n      key[this.sortKey.name] = { S: this.sortKey.value };\n    }\n    return key;\n  }\n\n  async lock(config: LockConfiguration): Promise<DynamoDBLock | undefined> {\n    const now = ClockProvider.now();\n    const isoNow = Utils.toIsoString(now);\n    const isoLockAtMostUntil = Utils.toIsoString(lockAtMostUntil(config));\n    const hostname = Utils.getHostname();\n\n    try {\n      await this.client.send(\n        new UpdateItemCommand({\n          TableName: this.tableName,\n          Key: this.buildKey(config.name),\n          UpdateExpression: 'SET lockUntil = :lockUntil, lockedAt = :lockedAt, lockedBy = :lockedBy',\n          ConditionExpression: 'lockUntil <= :lockedAt OR attribute_not_exists(lockUntil)',\n          ExpressionAttributeValues: {\n            ':lockUntil': { S: isoLockAtMostUntil },\n            ':lockedAt': { S: isoNow },\n            ':lockedBy': { S: hostname },\n          },\n        }),\n      );\n      return new DynamoDBLock(config, this);\n    } catch (e) {\n      if (e instanceof ConditionalCheckFailedException) return undefined;\n      throw e;\n    }\n  }\n\n  async extend(config: LockConfiguration): Promise<DynamoDBLock | undefined> {\n    const now = ClockProvider.now();\n    const isoNow = Utils.toIsoString(now);\n    const isoNewLockAtMostUntil = Utils.toIsoString(lockAtMostUntil(config));\n    const hostname = Utils.getHostname();\n\n    try {\n      await this.client.send(\n        new UpdateItemCommand({\n          TableName: this.tableName,\n          Key: this.buildKey(config.name),\n          UpdateExpression: 'SET lockUntil = :lockUntil',\n          ConditionExpression: 'lockedBy = :lockedBy AND lockUntil > :now',\n          ExpressionAttributeValues: {\n            ':lockUntil': { S: isoNewLockAtMostUntil },\n            ':lockedBy': { S: hostname },\n            ':now': { S: isoNow },\n          },\n        }),\n      );\n      return new DynamoDBLock(config, this);\n    } catch (e) {\n      if (e instanceof ConditionalCheckFailedException) return undefined;\n      throw e;\n    }\n  }\n\n  async unlock(config: LockConfiguration): Promise<void> {\n    const isoUnlock = Utils.toIsoString(unlockTime(config));\n\n    try {\n      await this.client.send(\n        new UpdateItemCommand({\n          TableName: this.tableName,\n          Key: this.buildKey(config.name),\n          UpdateExpression: 'SET lockUntil = :unlockTime',\n          ConditionExpression: `attribute_exists(${this.partitionKey})`,\n          ExpressionAttributeValues: {\n            ':unlockTime': { S: isoUnlock },\n          },\n        }),\n      );\n    } catch (e) {\n      if (e instanceof ConditionalCheckFailedException) return;\n      throw e;\n    }\n  }\n}\n","import { AbstractSimpleLock, type LockConfiguration, type SimpleLock } from '@tslock/core';\nimport type { DynamoDBAccessor } from './dynamodb-accessor.js';\n\nexport class DynamoDBLock extends AbstractSimpleLock {\n  constructor(\n    config: LockConfiguration,\n    private readonly accessor: DynamoDBAccessor,\n  ) {\n    super(config);\n  }\n\n  protected override async doUnlock(): Promise<void> {\n    await this.accessor.unlock(this.config);\n  }\n\n  protected override async doExtend(newConfig: LockConfiguration): Promise<SimpleLock | undefined> {\n    return await this.accessor.extend(newConfig);\n  }\n}\n","import type { DynamoDBClient } from '@aws-sdk/client-dynamodb';\n\nexport interface DynamoDBLockProviderOptions {\n  client?: DynamoDBClient;\n  tableName: string;\n  partitionKey?: string;\n  sortKey?: { name: string; value: string };\n}\n\nexport interface ResolvedOptions {\n  tableName: string;\n  partitionKey: string;\n  sortKey?: { name: string; value: string };\n}\n\nexport function validateOptions(options: DynamoDBLockProviderOptions): ResolvedOptions {\n  if (!options.tableName) throw new Error('tableName is required');\n  return {\n    tableName: options.tableName,\n    partitionKey: options.partitionKey ?? '_id',\n    sortKey: options.sortKey,\n  };\n}\n"],"mappings":";AAAA,SAAS,sBAAsB;;;ACC/B,SAAS,iCAAiC,yBAAyB;AACnE,SAAS,eAAuC,OAAO,iBAAiB,kBAAkB;;;ACF1F,SAAS,0BAAmE;AAGrE,IAAM,eAAN,cAA2B,mBAAmB;AAAA,EACnD,YACE,QACiB,UACjB;AACA,UAAM,MAAM;AAFK;AAAA,EAGnB;AAAA,EAHmB;AAAA,EAKnB,MAAyB,WAA0B;AACjD,UAAM,KAAK,SAAS,OAAO,KAAK,MAAM;AAAA,EACxC;AAAA,EAEA,MAAyB,SAAS,WAA+D;AAC/F,WAAO,MAAM,KAAK,SAAS,OAAO,SAAS;AAAA,EAC7C;AACF;;;ADbO,IAAM,mBAAN,MAAuB;AAAA,EAC5B,YACmB,QACA,WACA,cACA,SACjB;AAJiB;AACA;AACA;AACA;AAAA,EAChB;AAAA,EAJgB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EAGX,SAAS,MAA6C;AAC5D,UAAM,MAAqC,EAAE,CAAC,KAAK,YAAY,GAAG,EAAE,GAAG,KAAK,EAAE;AAC9E,QAAI,KAAK,SAAS;AAChB,UAAI,KAAK,QAAQ,IAAI,IAAI,EAAE,GAAG,KAAK,QAAQ,MAAM;AAAA,IACnD;AACA,WAAO;AAAA,EACT;AAAA,EAEA,MAAM,KAAK,QAA8D;AACvE,UAAM,MAAM,cAAc,IAAI;AAC9B,UAAM,SAAS,MAAM,YAAY,GAAG;AACpC,UAAM,qBAAqB,MAAM,YAAY,gBAAgB,MAAM,CAAC;AACpE,UAAM,WAAW,MAAM,YAAY;AAEnC,QAAI;AACF,YAAM,KAAK,OAAO;AAAA,QAChB,IAAI,kBAAkB;AAAA,UACpB,WAAW,KAAK;AAAA,UAChB,KAAK,KAAK,SAAS,OAAO,IAAI;AAAA,UAC9B,kBAAkB;AAAA,UAClB,qBAAqB;AAAA,UACrB,2BAA2B;AAAA,YACzB,cAAc,EAAE,GAAG,mBAAmB;AAAA,YACtC,aAAa,EAAE,GAAG,OAAO;AAAA,YACzB,aAAa,EAAE,GAAG,SAAS;AAAA,UAC7B;AAAA,QACF,CAAC;AAAA,MACH;AACA,aAAO,IAAI,aAAa,QAAQ,IAAI;AAAA,IACtC,SAAS,GAAG;AACV,UAAI,aAAa,gCAAiC,QAAO;AACzD,YAAM;AAAA,IACR;AAAA,EACF;AAAA,EAEA,MAAM,OAAO,QAA8D;AACzE,UAAM,MAAM,cAAc,IAAI;AAC9B,UAAM,SAAS,MAAM,YAAY,GAAG;AACpC,UAAM,wBAAwB,MAAM,YAAY,gBAAgB,MAAM,CAAC;AACvE,UAAM,WAAW,MAAM,YAAY;AAEnC,QAAI;AACF,YAAM,KAAK,OAAO;AAAA,QAChB,IAAI,kBAAkB;AAAA,UACpB,WAAW,KAAK;AAAA,UAChB,KAAK,KAAK,SAAS,OAAO,IAAI;AAAA,UAC9B,kBAAkB;AAAA,UAClB,qBAAqB;AAAA,UACrB,2BAA2B;AAAA,YACzB,cAAc,EAAE,GAAG,sBAAsB;AAAA,YACzC,aAAa,EAAE,GAAG,SAAS;AAAA,YAC3B,QAAQ,EAAE,GAAG,OAAO;AAAA,UACtB;AAAA,QACF,CAAC;AAAA,MACH;AACA,aAAO,IAAI,aAAa,QAAQ,IAAI;AAAA,IACtC,SAAS,GAAG;AACV,UAAI,aAAa,gCAAiC,QAAO;AACzD,YAAM;AAAA,IACR;AAAA,EACF;AAAA,EAEA,MAAM,OAAO,QAA0C;AACrD,UAAM,YAAY,MAAM,YAAY,WAAW,MAAM,CAAC;AAEtD,QAAI;AACF,YAAM,KAAK,OAAO;AAAA,QAChB,IAAI,kBAAkB;AAAA,UACpB,WAAW,KAAK;AAAA,UAChB,KAAK,KAAK,SAAS,OAAO,IAAI;AAAA,UAC9B,kBAAkB;AAAA,UAClB,qBAAqB,oBAAoB,KAAK,YAAY;AAAA,UAC1D,2BAA2B;AAAA,YACzB,eAAe,EAAE,GAAG,UAAU;AAAA,UAChC;AAAA,QACF,CAAC;AAAA,MACH;AAAA,IACF,SAAS,GAAG;AACV,UAAI,aAAa,gCAAiC;AAClD,YAAM;AAAA,IACR;AAAA,EACF;AACF;;;AEhFO,SAAS,gBAAgB,SAAuD;AACrF,MAAI,CAAC,QAAQ,UAAW,OAAM,IAAI,MAAM,uBAAuB;AAC/D,SAAO;AAAA,IACL,WAAW,QAAQ;AAAA,IACnB,cAAc,QAAQ,gBAAgB;AAAA,IACtC,SAAS,QAAQ;AAAA,EACnB;AACF;;;AHjBO,IAAM,uBAAN,MAA6D;AAAA,EACjD;AAAA,EAEjB,YAAY,SAAsC;AAChD,UAAM,OAAO,gBAAgB,OAAO;AACpC,SAAK,WAAW,IAAI;AAAA,MAClB,QAAQ,UAAU,IAAI,eAAe,CAAC,CAAC;AAAA,MACvC,KAAK;AAAA,MACL,KAAK;AAAA,MACL,KAAK;AAAA,IACP;AAAA,EACF;AAAA,EAEA,MAAM,KAAK,QAA4D;AACrE,WAAO,KAAK,SAAS,KAAK,MAAM;AAAA,EAClC;AACF;","names":[]}

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@tslock/dynamodb",
+  "version": "1.0.0",
+  "description": "TSLock provider for Amazon DynamoDB",
+  "license": "Apache-2.0",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "peerDependencies": {
+    "@aws-sdk/client-dynamodb": "^3.0.0",
+    "@tslock/core": "1.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@tslock/core": {
+      "optional": false
+    },
+    "@aws-sdk/client-dynamodb": {
+      "optional": false
+    }
+  },
+  "devDependencies": {
+    "typescript": "^5.5.0",
+    "tsup": "^8.0.0",
+    "vitest": "^2.0.0",
+    "@aws-sdk/client-dynamodb": "^3.0.0",
+    "@tslock/core": "1.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/drmaas/tslock.git",
+    "directory": "packages/dynamodb"
+  },
+  "scripts": {
+    "build": "tsup",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "typecheck": "tsc --noEmit"
+  }
+}