@kensio/yulin 0.0.2 → 0.1.0

package/dist/util/sleep.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Async sleep for an approximate number of milliseconds.
+ */
+export declare function sleep(ms?: number): Promise<void>;
+/**
+ * Sleep for a random but short length of time, e.g. to simulate asynchronous
+ * operations completing in a non-deterministic order.
+ */
+export declare function jitter(): Promise<void>;
+//# sourceMappingURL=sleep.d.ts.map

package/dist/util/sleep.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sleep.d.ts","sourceRoot":"","sources":["../../src/util/sleep.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,wBAAsB,KAAK,CAAC,EAAE,SAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAIjD;AAED;;;GAGG;AACH,wBAAsB,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAE5C"}

package/dist/util/sleep.js

@@ -0,0 +1,16 @@
+/**
+ * Async sleep for an approximate number of milliseconds.
+ */
+export async function sleep(ms = 0) {
+    await new Promise((resolve) => {
+        setTimeout(resolve, ms);
+    });
+}
+/**
+ * Sleep for a random but short length of time, e.g. to simulate asynchronous
+ * operations completing in a non-deterministic order.
+ */
+export async function jitter() {
+    await sleep(Math.random());
+}
+//# sourceMappingURL=sleep.js.map

package/dist/util/sleep.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sleep.js","sourceRoot":"","sources":["../../src/util/sleep.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,KAAK,CAAC,EAAE,GAAG,CAAC;IAChC,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC5B,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IAC1B,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM;IAC1B,MAAM,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;AAC7B,CAAC"}

package/eslint.config.ts

@@ -14,6 +14,10 @@ import tseslint from "typescript-eslint";
 
 const __dirname = dirname(fileURLToPath(import.meta.url));
 
+const securityRecommended = security.configs.recommended as Parameters<
+  typeof defineConfig
+>[0];
+
 export default defineConfig(
   // ── Global ignores ──────────────────────────────────────
   {
@@ -75,6 +79,11 @@ export default defineConfig(
           format: ["camelCase", "PascalCase"],
           leadingUnderscore: "allow",
         },
+        {
+          selector: ["property", "objectLiteralProperty", "typeProperty"],
+          modifiers: ["requiresQuotes"],
+          format: null,
+        },
         {
           selector: "default",
           format: ["camelCase"],
@@ -103,10 +112,8 @@ export default defineConfig(
     },
   },
 
-  // ── Security (low cost security checks) ────────────────
-  // TODO: Remove cast when eslint-plugin-security fixes defineConfig() types
-  // https://github.com/eslint-community/eslint-plugin-security/issues/175
-  security.configs.recommended as any,
+  // ── Security (low-cost security checks) ────────────────
+  securityRecommended,
 
   // ── Unicorn (modern JS best practices) ──────────────────
   // https://github.com/sindresorhus/eslint-plugin-unicorn?tab=readme-ov-file#recommended-config
@@ -115,6 +122,13 @@ export default defineConfig(
     rules: {
       "unicorn/better-regex": "warn",
       "unicorn/prevent-abbreviations": "off",
+      "unicorn/no-null": "off",
+    },
+  },
+  {
+    files: ["**/index.ts"],
+    rules: {
+      "unicorn/no-empty-file": "off",
     },
   },
 

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@kensio/yulin",
-  "version": "0.0.2",
+  "version": "0.1.0",
   "description": "AWS system behaviour simulation for isolated unit testing",
   "repository": "https://github.com/KensioSoftware/yulin",
   "type": "module",
-  "main": "index.js",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "keywords": [
     "aws",
     "test",
@@ -13,32 +14,43 @@
     "simulator",
     "isolated"
   ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./cloudfront": {
+      "types": "./dist/service/cloudfront/index.d.ts",
+      "import": "./dist/service/cloudfront/index.js"
+    },
+    "./package.json": "./package.json"
+  },
   "author": "Kensio Software",
   "license": "AGPL-3.0",
   "devDependencies": {
-    "@aws-sdk/client-dynamodb": "^3.1001.0",
-    "@aws-sdk/client-s3": "^3.1001.0",
+    "@aws-sdk/client-dynamodb": "^3.1056.0",
+    "@aws-sdk/client-s3": "^3.1056.0",
     "@eslint/js": "^10.0.1",
-    "@kensio/smartass": "^0.1.4",
-    "@smithy/smithy-client": "^4.12.1",
-    "@smithy/types": "^4.13.0",
+    "@kensio/smartass": "^1.0.0",
+    "@smithy/smithy-client": "^4.13.5",
+    "@smithy/types": "^4.14.2",
     "@types/eslint-plugin-security": "^3.0.1",
     "@types/lodash-es": "^4.17.12",
-    "@types/node": "^25.3.0",
-    "@vitest/coverage-v8": "4.0.18",
-    "@vitest/eslint-plugin": "^1.6.9",
+    "@types/node": "^25.9.1",
+    "@vitest/coverage-v8": "^4.1.7",
+    "@vitest/eslint-plugin": "^1.6.18",
     "aws-sdk-client-mock": "^4.1.0",
-    "eslint": "^10.0.1",
+    "eslint": "^10.4.0",
     "eslint-config-prettier": "^10.1.8",
-    "eslint-plugin-jsdoc": "^62.7.1",
-    "eslint-plugin-no-secrets": "^2.2.2",
+    "eslint-plugin-jsdoc": "^62.9.0",
+    "eslint-plugin-no-secrets": "^2.3.3",
     "eslint-plugin-security": "^4.0.0",
     "eslint-plugin-unicorn": "^63.0.0",
-    "globals": "^17.3.0",
-    "jiti": "^2.6.1",
-    "prettier": "^3.8.1",
-    "typescript-eslint": "^8.56.0",
-    "vitest": "^4.0.18"
+    "globals": "^17.6.0",
+    "jiti": "^2.7.0",
+    "prettier": "^3.8.3",
+    "typescript-eslint": "^8.60.0",
+    "vitest": "^4.1.7"
   },
   "peerDependencies": {
     "@aws-sdk/client-dynamodb": "^3.1001.0",
@@ -57,7 +69,8 @@
     }
   },
   "dependencies": {
-    "lodash-es": "^4.17.23"
+    "@kensio/part-factory": "^0.1.1",
+    "lodash-es": "^4.18.1"
   },
   "scripts": {
     "build": "tsc -p tsconfig.build.json",

package/pnpm-workspace.yaml

@@ -1 +1,23 @@
-useNodeVersion: 24.13.1
+minimumReleaseAgeExclude:
+  - '@aws-sdk/client-dynamodb@3.1056.0'
+  - '@aws-sdk/client-s3@3.1056.0'
+  - '@aws-sdk/core@3.974.15'
+  - '@aws-sdk/credential-provider-env@3.972.41'
+  - '@aws-sdk/credential-provider-http@3.972.43'
+  - '@aws-sdk/credential-provider-ini@3.972.45'
+  - '@aws-sdk/credential-provider-login@3.972.45'
+  - '@aws-sdk/credential-provider-node@3.972.46'
+  - '@aws-sdk/credential-provider-process@3.972.41'
+  - '@aws-sdk/credential-provider-sso@3.972.45'
+  - '@aws-sdk/credential-provider-web-identity@3.972.45'
+  - '@aws-sdk/dynamodb-codec@3.973.15'
+  - '@aws-sdk/middleware-bucket-endpoint@3.972.17'
+  - '@aws-sdk/middleware-endpoint-discovery@3.972.15'
+  - '@aws-sdk/middleware-expect-continue@3.972.14'
+  - '@aws-sdk/middleware-flexible-checksums@3.974.23'
+  - '@aws-sdk/middleware-sdk-s3@3.972.44'
+  - '@aws-sdk/nested-clients@3.997.13'
+  - '@aws-sdk/signature-v4-multi-region@3.996.30'
+  - '@aws-sdk/token-providers@3.1056.0'
+  - '@kensio/smartass@1.0.0'
+useNodeVersion: 24.16.0

package/scripts/publish.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+set -Eeuo pipefail
+
+pnpm install
+pnpm lint
+pnpm test:coverage
+pnpm build
+pnpm pack --dry-run
+pnpm version patch
+pnpm login
+pnpm publish --access public
+git push
+git push --tags

package/src/service/cloudfront/factory/cloudfront-functions.factory.iso.test.ts

@@ -0,0 +1,10 @@
+import { describe, it } from "vitest";
+import { cloudFrontRequestFactory } from "./cloudfront-functions.factory.js";
+import { assertObjectMatches } from "@kensio/smartass";
+
+describe("CloudFront Functions object factories", () => {
+  it("makes a valid CloudFront Functions request object", () => {
+    const cffReq = cloudFrontRequestFactory.make();
+    assertObjectMatches(cffReq, { headers: { host: { value: "yulin.test" } } });
+  });
+});

package/src/service/cloudfront/factory/cloudfront-functions.factory.ts

@@ -0,0 +1,34 @@
+import type { CloudFrontRequest } from "../typings/cloudfront-functions.js";
+import { StaticFactory } from "@kensio/part-factory";
+
+/**
+ * Makes instances of the CloudFrontRequest object structure.
+ */
+export const cloudFrontRequestFactory = new StaticFactory<CloudFrontRequest>({
+  cookies: {
+    sessionId: {
+      value: "test-session-id",
+    },
+  },
+  headers: {
+    accept: {
+      value: "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8",
+    },
+    "accept-language": {
+      value: "en-GB,en;q=0.9",
+    },
+    host: {
+      value: "yulin.test",
+    },
+    "user-agent": {
+      value: "Mozilla/5.0",
+    },
+  },
+  method: "GET",
+  querystring: {
+    page: {
+      value: "1",
+    },
+  },
+  uri: "/cloudfront/",
+});

package/src/service/cloudfront/index.ts

@@ -0,0 +1,13 @@
+export { cloudFrontRequestFactory } from "./factory/cloudfront-functions.factory.js";
+export type {
+  CloudFrontCookies,
+  CloudFrontEvent,
+  CloudFrontEventContext,
+  CloudFrontHeaders,
+  CloudFrontMultiValue,
+  CloudFrontQueryString,
+  CloudFrontRequest,
+  CloudFrontResponse,
+  CloudFrontValue,
+  CloudFrontViewer,
+} from "./typings/cloudfront-functions.js";

package/src/service/cloudfront/typings/cloudfront-functions.ts

@@ -0,0 +1,48 @@
+export interface CloudFrontValue {
+  value: string;
+}
+
+export interface CloudFrontMultiValue {
+  multiValue: CloudFrontValue[];
+}
+
+export type CloudFrontHeaders = Record<string, CloudFrontValue>;
+
+export type CloudFrontQueryString = Record<
+  string,
+  CloudFrontValue | CloudFrontMultiValue
+>;
+
+export type CloudFrontCookies = Record<string, CloudFrontValue>;
+
+export interface CloudFrontRequest {
+  method: string;
+  uri: string;
+  headers: CloudFrontHeaders;
+  querystring: CloudFrontQueryString;
+  cookies: CloudFrontCookies;
+}
+
+export interface CloudFrontResponse {
+  statusCode: number;
+  statusDescription?: string;
+  headers?: CloudFrontHeaders;
+}
+
+export interface CloudFrontEventContext {
+  distributionDomainName?: string;
+  endpoint?: string;
+  distributionId?: string;
+  eventType: "viewer-request" | "viewer-response";
+  requestId: string;
+}
+
+export interface CloudFrontViewer {
+  ip: string;
+}
+
+export interface CloudFrontEvent {
+  context: CloudFrontEventContext;
+  viewer: CloudFrontViewer;
+  request: CloudFrontRequest;
+}

package/src/service/dynamodb/command/create-table/create-table.handler.ts

@@ -1,5 +1,5 @@
-import type { DynamoDbTableName } from "../../dynamodb-table.js";
-import { SimDynamoDbTable } from "../../dynamodb-table.js";
+import type { DynamoDbTableName } from "../../table/dynamodb-table.js";
+import { SimDynamoDbTable } from "../../table/dynamodb-table.js";
 import {
   type CreateTableCommand,
   type CreateTableCommandOutput,
@@ -11,6 +11,8 @@ import { jitter } from "../../../../util/sleep.js";
 
 /**
  * DynamoDB CreateTableCommand handler.
+ *
+ * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/dynamodb/command/CreateTableCommand/
  */
 export class CreateTableCommandHandler implements CommandHandler<
   CreateTableCommand,
@@ -39,7 +41,7 @@ export class CreateTableCommandHandler implements CommandHandler<
 
     await jitter();
 
-    const table = new SimDynamoDbTable(cmd);
+    const table = new SimDynamoDbTable(cmd, this.background);
     this.tables.set(tableName, table);
 
     this.background.schedule(() => table.activate());

package/src/service/dynamodb/command/create-table/create-table.iso.test.ts

@@ -10,6 +10,7 @@ import {
   assertIdentical,
   assertInstanceOf,
   assertNonNullable,
+  assertStringIncludes,
   assertThrowsErrorAsync,
 } from "@kensio/smartass";
 
@@ -19,7 +20,10 @@ describe("DynamoDB CreateTableCommand", () => {
     const simDynamoDb = simAccount.getDynamoDb();
 
     const createTableOutput = await simDynamoDb.createTable(
-      new CreateTableCommand({ TableName: "FoobarTable" }),
+      new CreateTableCommand({
+        TableName: "FoobarTable",
+        KeySchema: [{ AttributeName: "id", KeyType: "HASH" }],
+      }),
     );
 
     assertNonNullable(createTableOutput.TableDescription);
@@ -43,9 +47,34 @@ describe("DynamoDB CreateTableCommand", () => {
     const simAccount = new SimAwsAccount();
     const simDynamoDb = simAccount.getDynamoDb();
 
-    await assertThrowsErrorAsync(async () =>
-      simDynamoDb.createTable(new CreateTableCommand({ TableName: undefined })),
+    const error = await assertThrowsErrorAsync(async () =>
+      simDynamoDb.createTable(
+        new CreateTableCommand({
+          TableName: undefined,
+          KeySchema: [{ AttributeName: "id", KeyType: "HASH" }],
+        }),
+      ),
+    );
+
+    assertInstanceOf(error, Error);
+    assertStringIncludes(
+      error.message,
+      "CreateTableCommand.input.TableName is required",
+    );
+  });
+
+  it("throws on missing key schema", async () => {
+    const simAccount = new SimAwsAccount();
+    const simDynamoDb = simAccount.getDynamoDb();
+
+    const error = await assertThrowsErrorAsync(async () =>
+      simDynamoDb.createTable(
+        new CreateTableCommand({ TableName: "FoobarTable" }),
+      ),
     );
+
+    assertInstanceOf(error, Error);
+    assertStringIncludes(error.message, "Table KeySchema is not defined");
   });
 
   it("throws on duplicate Table name", async () => {
@@ -53,7 +82,10 @@ describe("DynamoDB CreateTableCommand", () => {
     const simDynamoDb = simAccount.getDynamoDb();
 
     await simDynamoDb.createTable(
-      new CreateTableCommand({ TableName: "FoobarTable" }),
+      new CreateTableCommand({
+        TableName: "FoobarTable",
+        KeySchema: [{ AttributeName: "id", KeyType: "HASH" }],
+      }),
     );
 
     const error = await assertThrowsErrorAsync(async () =>

package/src/service/dynamodb/command/describe-table/describe-table.handler.ts

@@ -7,11 +7,13 @@ import type { CommandHandler } from "../../../../command/command-handler.js";
 import type {
   DynamoDbTableName,
   SimDynamoDbTable,
-} from "../../dynamodb-table.js";
+} from "../../table/dynamodb-table.js";
 import { jitter } from "../../../../util/sleep.js";
 
 /**
  * DynamoDB DescribeTableCommand handler.
+ *
+ * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/dynamodb/command/DescribeTableCommand/
  */
 export class DescribeTableCommandHandler implements CommandHandler<
   DescribeTableCommand,

package/src/service/dynamodb/command/describe-table/describe-table.iso.test.ts

@@ -19,9 +19,24 @@ describe("DynamoDB DescribeTableCommand", () => {
     const simDynamoDb = simAccount.getDynamoDb();
 
     await Promise.all([
-      simDynamoDb.createTable(new CreateTableCommand({ TableName: "TableA" })),
-      simDynamoDb.createTable(new CreateTableCommand({ TableName: "TableB" })),
-      simDynamoDb.createTable(new CreateTableCommand({ TableName: "TableC" })),
+      simDynamoDb.createTable(
+        new CreateTableCommand({
+          TableName: "TableA",
+          KeySchema: [{ AttributeName: "id", KeyType: "HASH" }],
+        }),
+      ),
+      simDynamoDb.createTable(
+        new CreateTableCommand({
+          TableName: "TableB",
+          KeySchema: [{ AttributeName: "id", KeyType: "HASH" }],
+        }),
+      ),
+      simDynamoDb.createTable(
+        new CreateTableCommand({
+          TableName: "TableC",
+          KeySchema: [{ AttributeName: "id", KeyType: "HASH" }],
+        }),
+      ),
     ]);
 
     const describeTableOutput = await simDynamoDb.describeTable(

package/src/service/dynamodb/command/list-tables/list-tables.handler.ts

@@ -6,11 +6,13 @@ import type {
 import type {
   DynamoDbTableName,
   SimDynamoDbTable,
-} from "../../dynamodb-table.js";
+} from "../../table/dynamodb-table.js";
 import { jitter } from "../../../../util/sleep.js";
 
 /**
  * Simulated DynamoDB ListTablesCommand handler.
+ *
+ * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/dynamodb/command/ListTablesCommand/
  */
 export class ListTablesCommandHandler implements CommandHandler<
   ListTablesCommand,

package/src/service/dynamodb/command/list-tables/list-tables.iso.test.ts

@@ -12,9 +12,24 @@ describe("DynamoDB ListTablesCommand", () => {
     const simDynamoDb = simAccount.getDynamoDb();
 
     await Promise.all([
-      simDynamoDb.createTable(new CreateTableCommand({ TableName: "TableA" })),
-      simDynamoDb.createTable(new CreateTableCommand({ TableName: "TableB" })),
-      simDynamoDb.createTable(new CreateTableCommand({ TableName: "TableC" })),
+      simDynamoDb.createTable(
+        new CreateTableCommand({
+          TableName: "TableA",
+          KeySchema: [{ AttributeName: "id", KeyType: "HASH" }],
+        }),
+      ),
+      simDynamoDb.createTable(
+        new CreateTableCommand({
+          TableName: "TableB",
+          KeySchema: [{ AttributeName: "id", KeyType: "HASH" }],
+        }),
+      ),
+      simDynamoDb.createTable(
+        new CreateTableCommand({
+          TableName: "TableC",
+          KeySchema: [{ AttributeName: "id", KeyType: "HASH" }],
+        }),
+      ),
     ]);
 
     const listTablesOutput = await simDynamoDb.listTables(
@@ -35,9 +50,24 @@ describe("DynamoDB ListTablesCommand", () => {
     const simDynamoDb = simAccount.getDynamoDb();
 
     await Promise.all([
-      simDynamoDb.createTable(new CreateTableCommand({ TableName: "TableA" })),
-      simDynamoDb.createTable(new CreateTableCommand({ TableName: "TableB" })),
-      simDynamoDb.createTable(new CreateTableCommand({ TableName: "TableC" })),
+      simDynamoDb.createTable(
+        new CreateTableCommand({
+          TableName: "TableA",
+          KeySchema: [{ AttributeName: "id", KeyType: "HASH" }],
+        }),
+      ),
+      simDynamoDb.createTable(
+        new CreateTableCommand({
+          TableName: "TableB",
+          KeySchema: [{ AttributeName: "id", KeyType: "HASH" }],
+        }),
+      ),
+      simDynamoDb.createTable(
+        new CreateTableCommand({
+          TableName: "TableC",
+          KeySchema: [{ AttributeName: "id", KeyType: "HASH" }],
+        }),
+      ),
     ]);
 
     const listTablesOutput = await simDynamoDb.listTables(
@@ -57,9 +87,24 @@ describe("DynamoDB ListTablesCommand", () => {
     const simDynamoDb = simAccount.getDynamoDb();
 
     await Promise.all([
-      simDynamoDb.createTable(new CreateTableCommand({ TableName: "TableA" })),
-      simDynamoDb.createTable(new CreateTableCommand({ TableName: "TableB" })),
-      simDynamoDb.createTable(new CreateTableCommand({ TableName: "TableC" })),
+      simDynamoDb.createTable(
+        new CreateTableCommand({
+          TableName: "TableA",
+          KeySchema: [{ AttributeName: "id", KeyType: "HASH" }],
+        }),
+      ),
+      simDynamoDb.createTable(
+        new CreateTableCommand({
+          TableName: "TableB",
+          KeySchema: [{ AttributeName: "id", KeyType: "HASH" }],
+        }),
+      ),
+      simDynamoDb.createTable(
+        new CreateTableCommand({
+          TableName: "TableC",
+          KeySchema: [{ AttributeName: "id", KeyType: "HASH" }],
+        }),
+      ),
     ]);
 
     const listTablesOutput = await simDynamoDb.listTables(

package/src/service/dynamodb/command/put-item/put-item.handler.ts

@@ -0,0 +1,56 @@
+import type { CommandHandler } from "../../../../command/command-handler.js";
+import {
+  type PutItemCommand,
+  type PutItemCommandOutput,
+  ResourceNotFoundException,
+} from "@aws-sdk/client-dynamodb";
+import type {
+  DynamoDbTableName,
+  SimDynamoDbTable,
+} from "../../table/dynamodb-table.js";
+import { DynamoDbItem } from "../../item/dynamodb-item.js";
+
+/**
+ * DynamoDB PutItemCommand handler.
+ *
+ * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/dynamodb/command/PutItemCommand/
+ */
+export class PutItemCommandHandler implements CommandHandler<
+  PutItemCommand,
+  PutItemCommandOutput
+> {
+  constructor(
+    private readonly tables: Map<DynamoDbTableName, SimDynamoDbTable>,
+  ) {}
+
+  /**
+   * Put an Item into a DynamoDB Table.
+   */
+  async handle(cmd: PutItemCommand): Promise<PutItemCommandOutput> {
+    const tableName = cmd.input.TableName as DynamoDbTableName | undefined;
+    if (tableName === undefined) {
+      throw new Error("PutItemCommand.input.TableName is required");
+    }
+
+    const table = this.tables.get(tableName);
+    if (table === undefined) {
+      throw new ResourceNotFoundException({
+        message: `No DynamoDB Table named ${tableName}`,
+        $metadata: {},
+      });
+    }
+
+    if (cmd.input.Item === undefined) {
+      throw new Error("PutItemCommand.input.Item is required");
+    }
+
+    const item = DynamoDbItem.fromAttributeValues(cmd.input.Item);
+
+    await table.putItem(item);
+
+    return {
+      Attributes: item.toAttributeValues(),
+      $metadata: {},
+    };
+  }
+}