@exabugs/dynamodb-client 1.5.1 → 1.5.3

package/dist/server/media/sign.js

@@ -0,0 +1,49 @@
+/**
+ * メディア配信用の署名付きURL生成（CloudFront Canned Policy）
+ *
+ * 「誰に署名URLを発行するか」の判断はこの関数の責務外（呼び出し側アプリが担う）。
+ * この関数は「有効なリクエストになら署名する」機構のみを提供する（詳細: docs/media-design.md）。
+ */
+import { getSignedUrl } from '@aws-sdk/cloudfront-signer';
+/**
+ * Expires（epoch seconds）を計算する。
+ *
+ * 生の「現在時刻+TTL」をそのまま使うと、署名APIを呼ぶたびに毎回異なる署名URLになり
+ * クライアント側のブラウザキャッシュが効かない。TTL単位の境界に切り上げることで、
+ * 同じ時間帯内は同一URLになりブラウザキャッシュも活用できる。
+ *
+ * 必ず「現在時刻+TTLを切り上げる」のであって、「現在時刻を切り上げる」のではない
+ * ことに注意する。後者だと、TTL境界の直前に発行した場合に有効期間がTTLよりずっと
+ * 短くなってしまう（例: TTL=3600秒で境界の1秒前に発行すると有効期間は1秒になる）。
+ * この実装は常に [TTL, 2*TTL) の範囲の有効期間を保証する。
+ */
+function computeExpiry(nowSeconds, ttlSeconds) {
+    const target = nowSeconds + ttlSeconds;
+    return Math.ceil(target / ttlSeconds) * ttlSeconds;
+}
+/**
+ * メディア配信用の署名付きURLを生成する。
+ *
+ * width指定時は /resize/{fileId}?width=N、省略時は /master/{fileId} に署名する
+ * （呼び出し元が具体的な幅を決めてから呼ぶこと。ワイルドカード署名はしない）。
+ *
+ * 秘密鍵の取得はこの関数の責務外（引数で受け取るだけ）。
+ */
+export function signMediaUrl(params) {
+    const { fileId, width, keyPairId, privateKey, baseUrl, expiresInSeconds } = params;
+    if (width !== undefined && width < 1) {
+        throw new Error(`Invalid width: ${width}`);
+    }
+    const path = width !== undefined ? `/resize/${fileId}?width=${width}` : `/master/${fileId}`;
+    const targetUrl = `${baseUrl.replace(/\/$/, '')}${path}`;
+    const nowSeconds = Math.floor(Date.now() / 1000);
+    const expiresAt = computeExpiry(nowSeconds, expiresInSeconds);
+    const url = getSignedUrl({
+        url: targetUrl,
+        dateLessThan: new Date(expiresAt * 1000).toISOString(),
+        keyPairId,
+        privateKey,
+    });
+    return { fileId, width, url, expiresAt };
+}
+//# sourceMappingURL=sign.js.map

package/dist/server/media/sign.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sign.js","sourceRoot":"","sources":["../../../src/server/media/sign.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAI1D;;;;;;;;;;;GAWG;AACH,SAAS,aAAa,CAAC,UAAkB,EAAE,UAAkB;IAC3D,MAAM,MAAM,GAAG,UAAU,GAAG,UAAU,CAAC;IACvC,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,GAAG,UAAU,CAAC;AACrD,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,YAAY,CAAC,MAA0B;IACrD,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,gBAAgB,EAAE,GAAG,MAAM,CAAC;IAEnF,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;QACrC,MAAM,IAAI,KAAK,CAAC,kBAAkB,KAAK,EAAE,CAAC,CAAC;IAC7C,CAAC;IAED,MAAM,IAAI,GAAG,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,WAAW,MAAM,UAAU,KAAK,EAAE,CAAC,CAAC,CAAC,WAAW,MAAM,EAAE,CAAC;IAC5F,MAAM,SAAS,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC;IAEzD,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;IACjD,MAAM,SAAS,GAAG,aAAa,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC;IAE9D,MAAM,GAAG,GAAG,YAAY,CAAC;QACvB,GAAG,EAAE,SAAS;QACd,YAAY,EAAE,IAAI,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC,WAAW,EAAE;QACtD,SAAS;QACT,UAAU;KACX,CAAC,CAAC;IAEH,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC;AAC3C,CAAC"}

package/dist/server/media/ssmParams.d.ts

@@ -0,0 +1,29 @@
+/**
+ * image policy・署名鍵をParameter Storeから取得する共通ロジック
+ *
+ * モジュールスコープにキャッシュし、コールドスタートごとに再取得する
+ * （詳細: docs/media-design.md「image policyの管理」）。
+ *
+ * 取得失敗時（未登録・不正なJSON）はfail-closedとする（例外を投げる）。
+ * 「取得できない＝無制限を許可」になる実装ミスを避けるため、呼び出し側は
+ * この例外をそのままリクエスト拒否として扱うこと。
+ */
+import { type SSMClient } from '@aws-sdk/client-ssm';
+import type { ImagePolicy } from './types.js';
+/**
+ * image policyをParameter Storeから取得する（モジュールスコープにキャッシュ）。
+ *
+ * @throws パラメータが未登録、または値が不正なJSON/スキーマの場合
+ */
+export declare function getImagePolicy(ssmClient: SSMClient, paramName: string): Promise<ImagePolicy>;
+/**
+ * 署名用秘密鍵をParameter Storeから取得する（モジュールスコープにキャッシュ）。
+ *
+ * @throws パラメータが未登録の場合
+ */
+export declare function getSigningPrivateKey(ssmClient: SSMClient, paramName: string): Promise<string>;
+/**
+ * キャッシュをクリアする（テスト専用）。
+ */
+export declare function clearSsmParamsCache(): void;
+//# sourceMappingURL=ssmParams.d.ts.map

package/dist/server/media/ssmParams.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ssmParams.d.ts","sourceRoot":"","sources":["../../../src/server/media/ssmParams.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,OAAO,EAAuB,KAAK,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAE1E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAkB9C;;;;GAIG;AACH,wBAAsB,cAAc,CAClC,SAAS,EAAE,SAAS,EACpB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,WAAW,CAAC,CAsBtB;AAED;;;;GAIG;AACH,wBAAsB,oBAAoB,CACxC,SAAS,EAAE,SAAS,EACpB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,MAAM,CAAC,CAajB;AAED;;GAEG;AACH,wBAAgB,mBAAmB,IAAI,IAAI,CAG1C"}

package/dist/server/media/ssmParams.js

@@ -0,0 +1,74 @@
+/**
+ * image policy・署名鍵をParameter Storeから取得する共通ロジック
+ *
+ * モジュールスコープにキャッシュし、コールドスタートごとに再取得する
+ * （詳細: docs/media-design.md「image policyの管理」）。
+ *
+ * 取得失敗時（未登録・不正なJSON）はfail-closedとする（例外を投げる）。
+ * 「取得できない＝無制限を許可」になる実装ミスを避けるため、呼び出し側は
+ * この例外をそのままリクエスト拒否として扱うこと。
+ */
+import { GetParameterCommand } from '@aws-sdk/client-ssm';
+let cachedImagePolicy;
+let cachedSigningPrivateKey;
+function isValidImagePolicy(value) {
+    if (typeof value !== 'object' || value === null)
+        return false;
+    const v = value;
+    return (typeof v.masterMaxDimension === 'number' &&
+        v.masterMaxDimension > 0 &&
+        Array.isArray(v.allowedContentTypes) &&
+        v.allowedContentTypes.every((t) => typeof t === 'string') &&
+        typeof v.maxUploadSize === 'number' &&
+        v.maxUploadSize > 0);
+}
+/**
+ * image policyをParameter Storeから取得する（モジュールスコープにキャッシュ）。
+ *
+ * @throws パラメータが未登録、または値が不正なJSON/スキーマの場合
+ */
+export async function getImagePolicy(ssmClient, paramName) {
+    if (cachedImagePolicy)
+        return cachedImagePolicy;
+    const result = await ssmClient.send(new GetParameterCommand({ Name: paramName }));
+    const rawValue = result.Parameter?.Value;
+    if (!rawValue) {
+        throw new Error(`Image policy parameter not found: ${paramName}`);
+    }
+    let parsed;
+    try {
+        parsed = JSON.parse(rawValue);
+    }
+    catch {
+        throw new Error(`Image policy parameter is not valid JSON: ${paramName}`);
+    }
+    if (!isValidImagePolicy(parsed)) {
+        throw new Error(`Image policy parameter has invalid shape: ${paramName}`);
+    }
+    cachedImagePolicy = parsed;
+    return parsed;
+}
+/**
+ * 署名用秘密鍵をParameter Storeから取得する（モジュールスコープにキャッシュ）。
+ *
+ * @throws パラメータが未登録の場合
+ */
+export async function getSigningPrivateKey(ssmClient, paramName) {
+    if (cachedSigningPrivateKey)
+        return cachedSigningPrivateKey;
+    const result = await ssmClient.send(new GetParameterCommand({ Name: paramName, WithDecryption: true }));
+    const value = result.Parameter?.Value;
+    if (!value) {
+        throw new Error(`Signing private key parameter not found: ${paramName}`);
+    }
+    cachedSigningPrivateKey = value;
+    return value;
+}
+/**
+ * キャッシュをクリアする（テスト専用）。
+ */
+export function clearSsmParamsCache() {
+    cachedImagePolicy = undefined;
+    cachedSigningPrivateKey = undefined;
+}
+//# sourceMappingURL=ssmParams.js.map

package/dist/server/media/ssmParams.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ssmParams.js","sourceRoot":"","sources":["../../../src/server/media/ssmParams.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,OAAO,EAAE,mBAAmB,EAAkB,MAAM,qBAAqB,CAAC;AAI1E,IAAI,iBAA0C,CAAC;AAC/C,IAAI,uBAA2C,CAAC;AAEhD,SAAS,kBAAkB,CAAC,KAAc;IACxC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,KAAK,CAAC;IAC9D,MAAM,CAAC,GAAG,KAAgC,CAAC;IAC3C,OAAO,CACL,OAAO,CAAC,CAAC,kBAAkB,KAAK,QAAQ;QACxC,CAAC,CAAC,kBAAkB,GAAG,CAAC;QACxB,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,mBAAmB,CAAC;QACpC,CAAC,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC;QACzD,OAAO,CAAC,CAAC,aAAa,KAAK,QAAQ;QACnC,CAAC,CAAC,aAAa,GAAG,CAAC,CACpB,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,SAAoB,EACpB,SAAiB;IAEjB,IAAI,iBAAiB;QAAE,OAAO,iBAAiB,CAAC;IAEhD,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,IAAI,CAAC,IAAI,mBAAmB,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;IAClF,MAAM,QAAQ,GAAG,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC;IACzC,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CAAC,qCAAqC,SAAS,EAAE,CAAC,CAAC;IACpE,CAAC;IAED,IAAI,MAAe,CAAC;IACpB,IAAI,CAAC;QACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAChC,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,KAAK,CAAC,6CAA6C,SAAS,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,EAAE,CAAC;QAChC,MAAM,IAAI,KAAK,CAAC,6CAA6C,SAAS,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED,iBAAiB,GAAG,MAAM,CAAC;IAC3B,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,SAAoB,EACpB,SAAiB;IAEjB,IAAI,uBAAuB;QAAE,OAAO,uBAAuB,CAAC;IAE5D,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,IAAI,CACjC,IAAI,mBAAmB,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,CACnE,CAAC;IACF,MAAM,KAAK,GAAG,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC;IACtC,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,4CAA4C,SAAS,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED,uBAAuB,GAAG,KAAK,CAAC;IAChC,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,mBAAmB;IACjC,iBAAiB,GAAG,SAAS,CAAC;IAC9B,uBAAuB,GAAG,SAAS,CAAC;AACtC,CAAC"}

package/dist/server/media/types.d.ts

@@ -0,0 +1,109 @@
+/**
+ * メディア機能の型定義
+ *
+ * 詳細設計: docs/media-design.md
+ */
+import type { S3Client } from '@aws-sdk/client-s3';
+/**
+ * メディアレコードの処理状態
+ *
+ * `pending`は存在しない。レコードが無ければ処理中を意味する
+ * （presign発行時点ではDynamoDBに触れない設計のため）。
+ */
+export type MediaStatus = 'completed' | 'failed';
+/**
+ * メディアレコード（共通フィールドのみ）
+ *
+ * アプリ固有の追加フィールドは、process-handlerがS3オブジェクトメタデータから
+ * 読み取った値をそのまま書き込む（本型はフィールド名を規定しない）。
+ */
+export interface MediaRecord {
+    /** fileId（ULID） */
+    id: string;
+    status: MediaStatus;
+    /** アップロード時に申告され、実バイトと照合済みのMIMEタイプ */
+    contentType: string;
+    /**
+     * masterとして実際に保存される形式（画像なら'image/jpeg'、それ以外はcontentTypeと同じ）。
+     * contentTypeとの不一致を明示的に区別する
+     */
+    outputContentType: string;
+    originalFilename?: string;
+    /** master（画像の場合のみ）の寸法 */
+    dimensions?: {
+        width: number;
+        height: number;
+    };
+    /** masterのファイルサイズ（バイト） */
+    size?: number;
+    error?: string;
+    createdAt: string;
+    updatedAt: string;
+    [key: string]: unknown;
+}
+/**
+ * image policy（Parameter Store経由で実行時取得するJSON）
+ *
+ * 呼び出し側のpresign発行処理（allowedContentTypes/maxUploadSize）、
+ * process-handler（masterMaxDimension）、
+ * media-handler（widthの健全性チェック上限として masterMaxDimension を流用）が参照する。
+ *
+ * 下限は固定 `1`（独立フィールドは持たない。署名付きURL必須のため、
+ * 健全性チェック以外の制約は不要という設計判断。詳細: docs/media-design.md）。
+ */
+export interface ImagePolicy {
+    /** process-handlerがmaster生成時に使う長辺上限。media-handlerのwidth上限チェックにも流用する */
+    masterMaxDimension: number;
+    /** presign発行時に使う許可MIMEタイプ */
+    allowedContentTypes: string[];
+    /** presign発行時に使う最大アップロードサイズ（バイト） */
+    maxUploadSize: number;
+}
+/**
+ * generatePresignedUpload の引数
+ */
+export interface PresignedUploadParams {
+    s3Client: S3Client;
+    bucket: string;
+    contentType: string;
+    originalFilename?: string;
+    fileSize: number;
+    allowedContentTypes: string[];
+    maxUploadSize: number;
+    /** x-amz-meta-{key} としてpolicyのeq条件に固定するアプリ固有メタデータ */
+    metadata: Record<string, string>;
+    /** presigned POSTの有効期限（秒）。省略時は300秒 */
+    expiresInSeconds?: number;
+}
+/**
+ * generatePresignedUpload の戻り値
+ */
+export interface PresignedUploadResult {
+    fileId: string;
+    uploadUrl: string;
+    fields: Record<string, string>;
+}
+/**
+ * signMediaUrl の引数
+ */
+export interface SignMediaUrlParams {
+    fileId: string;
+    /** 指定時は /resize/{fileId}?width=N、省略時は /master/{fileId} に署名する */
+    width?: number;
+    keyPairId: string;
+    privateKey: string;
+    baseUrl: string;
+    /** 有効期限（秒）。Expiresはこの粒度に切り上げてから署名する */
+    expiresInSeconds: number;
+}
+/**
+ * signMediaUrl の戻り値
+ */
+export interface SignMediaUrlResult {
+    fileId: string;
+    width?: number;
+    url: string;
+    /** 署名に使ったExpires（epoch seconds、丸め込み後） */
+    expiresAt: number;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/server/media/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/server/media/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAEnD;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GAAG,WAAW,GAAG,QAAQ,CAAC;AAEjD;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B,mBAAmB;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,WAAW,CAAC;IACpB,qCAAqC;IACrC,WAAW,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,yBAAyB;IACzB,UAAU,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAC/C,0BAA0B;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,WAAW;IAC1B,uEAAuE;IACvE,kBAAkB,EAAE,MAAM,CAAC;IAC3B,6BAA6B;IAC7B,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAC9B,oCAAoC;IACpC,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,QAAQ,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAC9B,aAAa,EAAE,MAAM,CAAC;IACtB,qDAAqD;IACrD,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,sCAAsC;IACtC,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,gEAAgE;IAChE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,uCAAuC;IACvC,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,yCAAyC;IACzC,SAAS,EAAE,MAAM,CAAC;CACnB"}

package/dist/server/media/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/server/media/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/server/media/types.ts"],"names":[],"mappings":""}