@layered-loader/sqs 1.0.0

package/dist/lib/triggers/dispatch.js

@@ -0,0 +1,69 @@
+function toArray(output) {
+    if (output == null)
+        return [];
+    // T is a discriminated-union object type, never an array, so narrowing via
+    // Array.isArray is safe — but TS can't prove that for an arbitrary T.
+    return Array.isArray(output) ? output : [output];
+}
+function assertNever(value, label) {
+    throw new Error(`Unhandled ${label} kind: ${JSON.stringify(value)}`);
+}
+/**
+ * Apply a resolved {@link InvalidationAction} to a flat
+ * {@link NotificationPublisher}.
+ */
+export async function applyFlatAction(action, publisher) {
+    switch (action.kind) {
+        case 'delete':
+            await publisher.delete(action.key);
+            return;
+        case 'deleteMany':
+            await publisher.deleteMany([...action.keys]);
+            return;
+        case 'set':
+            await publisher.set(action.key, action.value);
+            return;
+        case 'clear':
+            await publisher.clear();
+            return;
+        default:
+            assertNever(action, 'InvalidationAction');
+    }
+}
+/**
+ * Apply a resolved {@link GroupInvalidationAction} to a
+ * {@link GroupNotificationPublisher}.
+ */
+export async function applyGroupAction(action, publisher) {
+    switch (action.kind) {
+        case 'deleteFromGroup':
+            await publisher.deleteFromGroup(action.key, action.group);
+            return;
+        case 'deleteGroup':
+            await publisher.deleteGroup(action.group);
+            return;
+        case 'clear':
+            await publisher.clear();
+            return;
+        default:
+            assertNever(action, 'GroupInvalidationAction');
+    }
+}
+/**
+ * Run the resolver and apply each emitted action sequentially. Errors
+ * propagate to the caller, allowing the transport adapter to decide whether
+ * to retry the source message.
+ */
+export async function runFlatPipeline(message, resolver, publisher) {
+    const result = await resolver(message);
+    for (const action of toArray(result)) {
+        await applyFlatAction(action, publisher);
+    }
+}
+export async function runGroupPipeline(message, resolver, publisher) {
+    const result = await resolver(message);
+    for (const action of toArray(result)) {
+        await applyGroupAction(action, publisher);
+    }
+}
+//# sourceMappingURL=dispatch.js.map

package/dist/lib/triggers/dispatch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dispatch.js","sourceRoot":"","sources":["../../../lib/triggers/dispatch.ts"],"names":[],"mappings":"AAQA,SAAS,OAAO,CAAI,MAAyB;IAC3C,IAAI,MAAM,IAAI,IAAI;QAAE,OAAO,EAAE,CAAA;IAC7B,2EAA2E;IAC3E,sEAAsE;IACtE,OAAO,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAE,CAAC,MAAM,CAAkB,CAAA;AACpE,CAAC;AAED,SAAS,WAAW,CAAC,KAAY,EAAE,KAAa;IAC9C,MAAM,IAAI,KAAK,CAAC,aAAa,KAAK,UAAU,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;AACtE,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,MAA0B,EAC1B,SAAyC;IAEzC,QAAQ,MAAM,CAAC,IAAI,EAAE,CAAC;QACpB,KAAK,QAAQ;YACX,MAAM,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;YAClC,OAAM;QACR,KAAK,YAAY;YACf,MAAM,SAAS,CAAC,UAAU,CAAC,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAA;YAC5C,OAAM;QACR,KAAK,KAAK;YACR,MAAM,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAA;YAC7C,OAAM;QACR,KAAK,OAAO;YACV,MAAM,SAAS,CAAC,KAAK,EAAE,CAAA;YACvB,OAAM;QACR;YACE,WAAW,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAA;IAC7C,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,MAA+B,EAC/B,SAA8C;IAE9C,QAAQ,MAAM,CAAC,IAAI,EAAE,CAAC;QACpB,KAAK,iBAAiB;YACpB,MAAM,SAAS,CAAC,eAAe,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAA;YACzD,OAAM;QACR,KAAK,aAAa;YAChB,MAAM,SAAS,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;YACzC,OAAM;QACR,KAAK,OAAO;YACV,MAAM,SAAS,CAAC,KAAK,EAAE,CAAA;YACvB,OAAM;QACR;YACE,WAAW,CAAC,MAAM,EAAE,yBAAyB,CAAC,CAAA;IAClD,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,OAAiB,EACjB,QAA4D,EAC5D,SAAyC;IAEzC,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,CAAA;IACtC,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACrC,MAAM,eAAe,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;IAC1C,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,OAAiB,EACjB,QAAiE,EACjE,SAA8C;IAE9C,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,CAAA;IACtC,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACrC,MAAM,gBAAgB,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;IAC3C,CAAC;AACH,CAAC"}

package/dist/lib/triggers/types.d.ts

@@ -0,0 +1,54 @@
+/**
+ * Transport-agnostic primitives for building invalidation triggers.
+ *
+ * A trigger consumes domain events from an arbitrary upstream messaging system
+ * (SNS topic, SQS queue, RabbitMQ exchange, Kafka topic, ...) that has no
+ * knowledge of the caching layer. A {@link InvalidationResolver} maps each
+ * incoming message to one or more {@link InvalidationAction}s, which the
+ * trigger then dispatches via a configured layered-loader notification
+ * publisher to fan out across the cache cluster.
+ */
+/** Invalidation operations supported by `NotificationPublisher`. */
+export type InvalidationAction = {
+    kind: 'delete';
+    key: string;
+} | {
+    kind: 'deleteMany';
+    keys: readonly string[];
+} | {
+    kind: 'set';
+    key: string;
+    value: unknown;
+} | {
+    kind: 'clear';
+};
+/** Invalidation operations supported by `GroupNotificationPublisher`. */
+export type GroupInvalidationAction = {
+    kind: 'deleteFromGroup';
+    key: string;
+    group: string;
+} | {
+    kind: 'deleteGroup';
+    group: string;
+} | {
+    kind: 'clear';
+};
+export type ResolverOutput<TAction> = TAction | readonly TAction[] | null | undefined;
+/**
+ * Pure function turning a parsed upstream message into invalidation
+ * action(s). Return `undefined`/`null` to skip the message.
+ */
+export type InvalidationResolver<TMessage, TAction> = (message: TMessage) => ResolverOutput<TAction> | Promise<ResolverOutput<TAction>>;
+/** Lifecycle contract every trigger implementation honours. */
+export interface InvalidationTrigger {
+    /** Begin consuming messages from the upstream source. Idempotent. */
+    start(): Promise<void>;
+    /** Stop consuming and release resources. Idempotent. */
+    stop(): Promise<void>;
+}
+/**
+ * Invoked when the trigger pipeline (resolver + publish) fails for a single
+ * message. The transport may re-deliver the message regardless; this hook is
+ * for observability only.
+ */
+export type TriggerErrorHandler = (err: Error, channel: string) => void;

package/dist/lib/triggers/types.js

@@ -0,0 +1,12 @@
+/**
+ * Transport-agnostic primitives for building invalidation triggers.
+ *
+ * A trigger consumes domain events from an arbitrary upstream messaging system
+ * (SNS topic, SQS queue, RabbitMQ exchange, Kafka topic, ...) that has no
+ * knowledge of the caching layer. A {@link InvalidationResolver} maps each
+ * incoming message to one or more {@link InvalidationAction}s, which the
+ * trigger then dispatches via a configured layered-loader notification
+ * publisher to fan out across the cache cluster.
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/dist/lib/triggers/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../lib/triggers/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG"}

package/package.json

@@ -0,0 +1,75 @@
+{
+  "name": "@layered-loader/sqs",
+  "version": "1.0.0",
+  "description": "SNS/SQS remote invalidation adapter for layered-loader",
+  "license": "MIT",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/kibertoad/layered-loader.git",
+    "directory": "packages/sqs"
+  },
+  "files": [
+    "dist/*",
+    "README.md",
+    "LICENSE"
+  ],
+  "keywords": [
+    "layered-loader",
+    "sqs",
+    "sns",
+    "aws",
+    "cache",
+    "invalidation",
+    "notification",
+    "pub-sub"
+  ],
+  "peerDependencies": {
+    "@aws-sdk/client-sns": "^3.632.0",
+    "@aws-sdk/client-sqs": "^3.632.0",
+    "@aws-sdk/client-sts": "^3.632.0",
+    "@lokalise/node-core": "^14.0.0",
+    "@message-queue-toolkit/core": ">=24.0.0",
+    "@message-queue-toolkit/sns": ">=24.0.0",
+    "@message-queue-toolkit/sqs": ">=23.0.0",
+    "zod": "^4.0.0",
+    "layered-loader": "^14.3.1"
+  },
+  "devDependencies": {
+    "@aws-sdk/client-sns": "^3.926.0",
+    "@aws-sdk/client-sqs": "^3.926.0",
+    "@aws-sdk/client-sts": "^3.926.0",
+    "@lokalise/node-core": "^14.8.1",
+    "@message-queue-toolkit/core": "^25.4.0",
+    "@message-queue-toolkit/sns": "^24.6.1",
+    "@message-queue-toolkit/sqs": "^24.2.1",
+    "@types/node": "^22.19.15",
+    "@vitest/coverage-v8": "^4.1.0",
+    "fauxqs": "^2.5.0",
+    "typescript": "^5.9.3",
+    "vitest": "^4.1.0",
+    "zod": "^4.4.3",
+    "layered-loader": "^14.3.1"
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage",
+    "lint": "tsc --noEmit"
+  }
+}