alepha 0.1.0 → 0.3.0

package/LICENSE

@@ -1,7 +1,21 @@
-Copyright 2024 Feunard
+MIT License
 
-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:
+Copyright (c) 2025 Feunard
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+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 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
+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

@@ -1 +1,29 @@
-# Alepha
+# @alepha/core
+
+## Installation
+
+```bash
+npm install @alepha/core
+```
+
+## Usage
+
+```typescript
+import { Alepha, inject, t } from '@alepha/core';
+
+class B {
+  env = inject(
+    t.object({
+      HELLO: t.string(),
+    })
+  );
+}
+
+class A {
+  b = inject(B);
+}
+
+const app = Alepha.create({ HELLO: "WORLD" });
+
+app.log.info(app.get(A).b.env.HELLO); // WORLD
+```

package/dist/index.cjs

@@ -1,9 +1,173 @@
 'use strict';
 
-class Alepha {
+var cache = require('@alepha/cache');
+var core = require('@alepha/core');
+var store = require('@alepha/store');
+var postgres = require('@alepha/postgres');
+var queue = require('@alepha/queue');
+var redis = require('@alepha/redis');
+var scheduler = require('@alepha/scheduler');
+var server = require('@alepha/server');
+var topic = require('@alepha/topic');
+
+const lockDescriptorKey = "LOCK";
+const lock = (options) => core.createDescriptorValue({
+  kind: lockDescriptorKey,
+  options,
+  apply: (...args) => {
+    return options.handler(...args);
+  }
+});
+lock[core.KIND] = lockDescriptorKey;
+
+class LockDescriptorProvider {
+  alepha = core.inject(core.Alepha);
+  dateTimeProvider = core.inject(core.DateTimeProvider);
+  storeProvider = core.inject(store.StoreProvider);
+  log = core.logger();
+  id = this.alepha.id;
+  configure = core.hook({
+    name: "configure",
+    handler: (alepha) => {
+      const descriptors = alepha.getDescriptorValues(lock);
+      for (const { instance, key, value } of descriptors) {
+        const { options } = value;
+        const item = {
+          options,
+          key: (...args) => {
+            if (options.key) {
+              if (typeof options.key === "string") {
+                return options.key;
+              }
+              return options.key(...args);
+            }
+            return key;
+          },
+          maxDuration: options.maxDuration ?? 60
+        };
+        const run = (...args) => this.run(item, ...args);
+        core.updateDescriptorValue(value, instance, {
+          apply: run
+        });
+      }
+    }
+  });
+  /**
+   * Run the lock handler.
+   *
+   * @param value
+   * @param args
+   */
+  async run(value, ...args) {
+    const key = `lock:${value.key(...args)}`;
+    const handler = value.options.handler;
+    const lock2 = await this.lock(key, value);
+    if (lock2.id !== this.id) {
+      return;
+    }
+    if (lock2.endedAt) {
+      return;
+    }
+    try {
+      await handler(...args);
+    } finally {
+      const gracePeriod = value.options.gracePeriod ? typeof value.options.gracePeriod === "function" ? value.options.gracePeriod(...args) : value.options.gracePeriod : void 0;
+      if (gracePeriod) {
+        await this.storeProvider.set(
+          key,
+          `${this.id},${lock2.createdAt.toISO()},${this.dateTimeProvider.nowISOString()}`,
+          {
+            px: this.dateTimeProvider.duration(gracePeriod).as("milliseconds")
+          }
+        );
+      } else {
+        await this.storeProvider.del(key);
+      }
+    }
+  }
+  async lock(key, item) {
+    const value = await this.storeProvider.set(
+      key,
+      `${this.id},${this.dateTimeProvider.nowISOString()}`,
+      {
+        nx: true,
+        px: this.dateTimeProvider.duration(item.maxDuration).as("milliseconds")
+      }
+    );
+    const [id, createdAtStr, endedAtStr] = value.split(",");
+    const createdAt = core.DateTime.fromISO(createdAtStr);
+    const endedAt = endedAtStr ? core.DateTime.fromISO(endedAtStr) : void 0;
+    return {
+      id,
+      createdAt,
+      endedAt
+    };
+  }
+}
+
+class LockModule {
+  alepha = core.inject(core.Alepha);
   constructor() {
-    console.log("App is running");
+    this.alepha.register(store.StoreModule);
+    this.alepha.register(LockDescriptorProvider);
   }
 }
+core.autoInject(lock, LockModule);
 
-exports.Alepha = Alepha;
+exports.LockDescriptorProvider = LockDescriptorProvider;
+exports.lock = lock;
+exports.lockDescriptorKey = lockDescriptorKey;
+Object.keys(cache).forEach(function (k) {
+  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return cache[k]; }
+  });
+});
+Object.keys(core).forEach(function (k) {
+  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return core[k]; }
+  });
+});
+Object.keys(store).forEach(function (k) {
+  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return store[k]; }
+  });
+});
+Object.keys(postgres).forEach(function (k) {
+  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return postgres[k]; }
+  });
+});
+Object.keys(queue).forEach(function (k) {
+  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return queue[k]; }
+  });
+});
+Object.keys(redis).forEach(function (k) {
+  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return redis[k]; }
+  });
+});
+Object.keys(scheduler).forEach(function (k) {
+  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return scheduler[k]; }
+  });
+});
+Object.keys(server).forEach(function (k) {
+  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return server[k]; }
+  });
+});
+Object.keys(topic).forEach(function (k) {
+  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+    enumerable: true,
+    get: function () { return topic[k]; }
+  });
+});

package/dist/index.d.cts

@@ -1,5 +1,76 @@
-declare class Alepha {
-    constructor();
+export * from '@alepha/cache';
+import * as _alepha_core from '@alepha/core';
+import { AsyncFn, DurationLike, KIND, Alepha, DateTimeProvider, DateTime } from '@alepha/core';
+export * from '@alepha/core';
+import { StoreProvider } from '@alepha/store';
+export * from '@alepha/store';
+export * from '@alepha/postgres';
+export * from '@alepha/queue';
+export * from '@alepha/redis';
+export * from '@alepha/scheduler';
+export * from '@alepha/server';
+export * from '@alepha/topic';
+
+interface LockDescriptorOptions<TFunc extends AsyncFn> {
+    /**
+     * Function executed when the lock is acquired.
+     */
+    handler: TFunc;
+    key?: string | ((...args: Parameters<TFunc>) => string);
+    maxDuration?: DurationLike;
+    gracePeriod?: DurationLike | ((...args: Parameters<TFunc>) => DurationLike | undefined);
+}
+declare const lockDescriptorKey = "LOCK";
+/**
+ * Lock descriptor
+ *
+ * Make sure that only one instance of the handler is running at a time.
+ *
+ * When connected to a remote store, the lock is shared across all processes.
+ *
+ * @param options
+ */
+declare const lock: {
+    <TFunc extends AsyncFn>(options: LockDescriptorOptions<TFunc>): _alepha_core.DescriptorInstance<{
+        kind: string;
+        options: LockDescriptorOptions<TFunc>;
+        apply: (...args: Parameters<TFunc>) => Promise<void>;
+    }>;
+    [KIND]: string;
+};
+
+declare class LockDescriptorProvider {
+    protected readonly alepha: Alepha;
+    protected readonly dateTimeProvider: DateTimeProvider;
+    protected readonly storeProvider: StoreProvider;
+    protected readonly log: _alepha_core.Logger;
+    protected readonly id: string;
+    protected readonly configure: _alepha_core.DescriptorInstance<{
+        kind: string;
+        options: {
+            name: "configure";
+            handler: (app: Alepha) => _alepha_core.Async<void>;
+        };
+        apply: (arg: Alepha) => _alepha_core.Async<void>;
+    }>;
+    /**
+     * Run the lock handler.
+     *
+     * @param value
+     * @param args
+     */
+    protected run(value: LockDescriptorValue, ...args: any[]): Promise<void>;
+    protected lock(key: string, item: LockDescriptorValue): Promise<LockObject>;
+}
+interface LockDescriptorValue {
+    options: LockDescriptorOptions<AsyncFn>;
+    key: (...args: any[]) => string;
+    maxDuration: DurationLike;
+}
+interface LockObject {
+    id: string;
+    createdAt: DateTime;
+    endedAt?: DateTime;
 }
 
-export { Alepha };
+export { type LockDescriptorOptions, LockDescriptorProvider, type LockDescriptorValue, type LockObject, lock, lockDescriptorKey };

package/dist/index.d.mts

@@ -1,5 +1,76 @@
-declare class Alepha {
-    constructor();
+export * from '@alepha/cache';
+import * as _alepha_core from '@alepha/core';
+import { AsyncFn, DurationLike, KIND, Alepha, DateTimeProvider, DateTime } from '@alepha/core';
+export * from '@alepha/core';
+import { StoreProvider } from '@alepha/store';
+export * from '@alepha/store';
+export * from '@alepha/postgres';
+export * from '@alepha/queue';
+export * from '@alepha/redis';
+export * from '@alepha/scheduler';
+export * from '@alepha/server';
+export * from '@alepha/topic';
+
+interface LockDescriptorOptions<TFunc extends AsyncFn> {
+    /**
+     * Function executed when the lock is acquired.
+     */
+    handler: TFunc;
+    key?: string | ((...args: Parameters<TFunc>) => string);
+    maxDuration?: DurationLike;
+    gracePeriod?: DurationLike | ((...args: Parameters<TFunc>) => DurationLike | undefined);
+}
+declare const lockDescriptorKey = "LOCK";
+/**
+ * Lock descriptor
+ *
+ * Make sure that only one instance of the handler is running at a time.
+ *
+ * When connected to a remote store, the lock is shared across all processes.
+ *
+ * @param options
+ */
+declare const lock: {
+    <TFunc extends AsyncFn>(options: LockDescriptorOptions<TFunc>): _alepha_core.DescriptorInstance<{
+        kind: string;
+        options: LockDescriptorOptions<TFunc>;
+        apply: (...args: Parameters<TFunc>) => Promise<void>;
+    }>;
+    [KIND]: string;
+};
+
+declare class LockDescriptorProvider {
+    protected readonly alepha: Alepha;
+    protected readonly dateTimeProvider: DateTimeProvider;
+    protected readonly storeProvider: StoreProvider;
+    protected readonly log: _alepha_core.Logger;
+    protected readonly id: string;
+    protected readonly configure: _alepha_core.DescriptorInstance<{
+        kind: string;
+        options: {
+            name: "configure";
+            handler: (app: Alepha) => _alepha_core.Async<void>;
+        };
+        apply: (arg: Alepha) => _alepha_core.Async<void>;
+    }>;
+    /**
+     * Run the lock handler.
+     *
+     * @param value
+     * @param args
+     */
+    protected run(value: LockDescriptorValue, ...args: any[]): Promise<void>;
+    protected lock(key: string, item: LockDescriptorValue): Promise<LockObject>;
+}
+interface LockDescriptorValue {
+    options: LockDescriptorOptions<AsyncFn>;
+    key: (...args: any[]) => string;
+    maxDuration: DurationLike;
+}
+interface LockObject {
+    id: string;
+    createdAt: DateTime;
+    endedAt?: DateTime;
 }
 
-export { Alepha };
+export { type LockDescriptorOptions, LockDescriptorProvider, type LockDescriptorValue, type LockObject, lock, lockDescriptorKey };

package/dist/index.mjs

@@ -1,7 +1,117 @@
-class Alepha {
+export * from '@alepha/cache';
+import { KIND, autoInject, createDescriptorValue, inject, Alepha, DateTimeProvider, logger, hook, updateDescriptorValue, DateTime } from '@alepha/core';
+export * from '@alepha/core';
+import { StoreProvider, StoreModule } from '@alepha/store';
+export * from '@alepha/store';
+export * from '@alepha/postgres';
+export * from '@alepha/queue';
+export * from '@alepha/redis';
+export * from '@alepha/scheduler';
+export * from '@alepha/server';
+export * from '@alepha/topic';
+
+const lockDescriptorKey = "LOCK";
+const lock = (options) => createDescriptorValue({
+  kind: lockDescriptorKey,
+  options,
+  apply: (...args) => {
+    return options.handler(...args);
+  }
+});
+lock[KIND] = lockDescriptorKey;
+
+class LockDescriptorProvider {
+  alepha = inject(Alepha);
+  dateTimeProvider = inject(DateTimeProvider);
+  storeProvider = inject(StoreProvider);
+  log = logger();
+  id = this.alepha.id;
+  configure = hook({
+    name: "configure",
+    handler: (alepha) => {
+      const descriptors = alepha.getDescriptorValues(lock);
+      for (const { instance, key, value } of descriptors) {
+        const { options } = value;
+        const item = {
+          options,
+          key: (...args) => {
+            if (options.key) {
+              if (typeof options.key === "string") {
+                return options.key;
+              }
+              return options.key(...args);
+            }
+            return key;
+          },
+          maxDuration: options.maxDuration ?? 60
+        };
+        const run = (...args) => this.run(item, ...args);
+        updateDescriptorValue(value, instance, {
+          apply: run
+        });
+      }
+    }
+  });
+  /**
+   * Run the lock handler.
+   *
+   * @param value
+   * @param args
+   */
+  async run(value, ...args) {
+    const key = `lock:${value.key(...args)}`;
+    const handler = value.options.handler;
+    const lock2 = await this.lock(key, value);
+    if (lock2.id !== this.id) {
+      return;
+    }
+    if (lock2.endedAt) {
+      return;
+    }
+    try {
+      await handler(...args);
+    } finally {
+      const gracePeriod = value.options.gracePeriod ? typeof value.options.gracePeriod === "function" ? value.options.gracePeriod(...args) : value.options.gracePeriod : void 0;
+      if (gracePeriod) {
+        await this.storeProvider.set(
+          key,
+          `${this.id},${lock2.createdAt.toISO()},${this.dateTimeProvider.nowISOString()}`,
+          {
+            px: this.dateTimeProvider.duration(gracePeriod).as("milliseconds")
+          }
+        );
+      } else {
+        await this.storeProvider.del(key);
+      }
+    }
+  }
+  async lock(key, item) {
+    const value = await this.storeProvider.set(
+      key,
+      `${this.id},${this.dateTimeProvider.nowISOString()}`,
+      {
+        nx: true,
+        px: this.dateTimeProvider.duration(item.maxDuration).as("milliseconds")
+      }
+    );
+    const [id, createdAtStr, endedAtStr] = value.split(",");
+    const createdAt = DateTime.fromISO(createdAtStr);
+    const endedAt = endedAtStr ? DateTime.fromISO(endedAtStr) : void 0;
+    return {
+      id,
+      createdAt,
+      endedAt
+    };
+  }
+}
+
+class LockModule {
+  alepha = inject(Alepha);
   constructor() {
-    console.log("App is running");
+    this.alepha.register(StoreModule);
+    this.alepha.register(LockDescriptorProvider);
   }
 }
+autoInject(lock, LockModule);
 
-export { Alepha };
+export { LockDescriptorProvider, lock, lockDescriptorKey };

package/package.json

@@ -1,25 +1,38 @@
 {
-	"name": "alepha",
-	"version": "0.1.0",
-	"type": "module",
-	"license": "MIT",
-	"main": "./dist/index.cjs",
-	"module": "./dist/index.mjs",
-	"types": "./dist/index.d.cts",
-	"exports": {
-		"require": {
-			"types": "./dist/index.d.cts",
-			"default": "./dist/index.cjs"
-		},
-		"import": {
-			"types": "./dist/index.d.mts",
-			"default": "./dist/index.mjs"
-		}
-	},
-	"devDependencies": {
-		"pkgroll": "^2.6.0"
-	},
-	"scripts": {
-		"build": "pkgroll"
-	}
-}
+  "name": "alepha",
+  "version": "0.3.0",
+  "type": "module",
+  "license": "MIT",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.cts",
+  "dependencies": {
+    "@alepha/cache": "0.3.0",
+    "@alepha/core": "0.3.0",
+    "@alepha/postgres": "0.3.0",
+    "@alepha/queue": "0.3.0",
+    "@alepha/redis": "0.3.0",
+    "@alepha/scheduler": "0.3.0",
+    "@alepha/server": "0.3.0",
+    "@alepha/store": "0.3.0",
+    "@alepha/topic": "0.3.0"
+  },
+  "devDependencies": {
+    "pkgroll": "^2.6.0",
+    "typescript": "^5.7.2",
+    "vitest": "^2.1.8"
+  },
+  "scripts": {
+    "build": "pkgroll --clean-dist"
+  },
+  "exports": {
+    "require": {
+      "types": "./dist/index.d.cts",
+      "default": "./dist/index.cjs"
+    },
+    "import": {
+      "types": "./dist/index.d.mts",
+      "default": "./dist/index.mjs"
+    }
+  }
+}

package/src/index.ts

@@ -0,0 +1,10 @@
+export * from "@alepha/cache";
+export * from "@alepha/core";
+export * from "@alepha/lock";
+export * from "@alepha/postgres";
+export * from "@alepha/queue";
+export * from "@alepha/redis";
+export * from "@alepha/scheduler";
+export * from "@alepha/server";
+export * from "@alepha/store";
+export * from "@alepha/topic";