@webiny/api-audit-logs-ddb 0.0.0-unstable.0d717d18dd

package/entity.js

@@ -0,0 +1,120 @@
+import { createEntity, createTable } from "@webiny/db-dynamodb";
+const createTableGSIIndexes = (count)=>{
+    const result = {};
+    for(let i = 1; i <= count; i++)result[`GSI${i}`] = {
+        partitionKey: `GSI${i}_PK`,
+        sortKey: `GSI${i}_SK`
+    };
+    return result;
+};
+const entity_createEntity = (params)=>{
+    const { gsiAmount, client, tableName } = params;
+    const name = tableName || process.env.DB_TABLE_AUDIT_LOGS;
+    if (!name) throw new Error("Missing env.DB_TABLE_AUDIT_LOGS environment variable.");
+    const table = createTable({
+        documentClient: client,
+        name,
+        indexes: {
+            ...createTableGSIIndexes(gsiAmount)
+        }
+    });
+    const entity = createEntity({
+        name: "AuditLogs",
+        table: table.table,
+        attributes: {
+            PK: {
+                partitionKey: true
+            },
+            SK: {
+                sortKey: true
+            },
+            GSI_TENANT: {
+                type: "string",
+                required: true
+            },
+            GSI1_PK: {
+                type: "string",
+                required: true
+            },
+            GSI1_SK: {
+                type: "number",
+                required: true
+            },
+            GSI2_PK: {
+                type: "string",
+                required: true
+            },
+            GSI2_SK: {
+                type: "number",
+                required: true
+            },
+            GSI3_PK: {
+                type: "string",
+                required: true
+            },
+            GSI3_SK: {
+                type: "number",
+                required: true
+            },
+            GSI4_PK: {
+                type: "string",
+                required: true
+            },
+            GSI4_SK: {
+                type: "number",
+                required: true
+            },
+            GSI5_PK: {
+                type: "string",
+                required: true
+            },
+            GSI5_SK: {
+                type: "number",
+                required: true
+            },
+            GSI6_PK: {
+                type: "string",
+                required: true
+            },
+            GSI6_SK: {
+                type: "number",
+                required: true
+            },
+            GSI7_PK: {
+                type: "string",
+                required: true
+            },
+            GSI7_SK: {
+                type: "number",
+                required: true
+            },
+            GSI8_PK: {
+                type: "string",
+                required: true
+            },
+            GSI8_SK: {
+                type: "number",
+                required: true
+            },
+            GSI9_PK: {
+                type: "string",
+                required: true
+            },
+            GSI9_SK: {
+                type: "number",
+                required: true
+            },
+            data: {
+                type: "map",
+                required: true
+            }
+        }
+    });
+    return {
+        entity,
+        table
+    };
+};
+export { entity_createEntity as createEntity };
+
+//# sourceMappingURL=entity.js.map

package/entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entity.js","sources":["../src/entity.ts"],"sourcesContent":["import type { DynamoDBDocument } from \"@webiny/aws-sdk/client-dynamodb/index.js\";\nimport type { IEntity, IStandardEntityAttributes } from \"@webiny/db-dynamodb\";\nimport { createEntity as baseCreateEntity, createTable } from \"@webiny/db-dynamodb\";\nimport type { GenericRecord } from \"@webiny/api/types.js\";\nimport type { IStorageAuditLog } from \"~/types.js\";\n\nexport interface IAuditLogsEntityAttributes extends Omit<\n    IStandardEntityAttributes<IStorageAuditLog>,\n    \"GSI1_SK\" | \"GSI2_SK\" | \"expiresAt\"\n> {\n    GSI1_PK: string;\n    GSI1_SK: number;\n    GSI2_PK: string;\n    GSI2_SK: number;\n    GSI3_PK: string;\n    GSI3_SK: number;\n    GSI4_PK: string;\n    GSI4_SK: number;\n    GSI5_PK: string;\n    GSI5_SK: number;\n    GSI6_PK: string;\n    GSI6_SK: number;\n    GSI7_PK: string;\n    GSI7_SK: number;\n    GSI8_PK: string;\n    GSI8_SK: number;\n    GSI9_PK: string;\n    GSI9_SK: number;\n    expiresAt: number;\n}\n\nexport type AuditLogsEntity = IEntity<IAuditLogsEntityAttributes>;\n\nexport interface ICreateEntityParams {\n    client: DynamoDBDocument;\n    gsiAmount: number;\n    tableName: string | undefined;\n}\n\nexport interface ICreateEntityResult {\n    entity: AuditLogsEntity;\n    table: ReturnType<typeof createTable>;\n}\n\nconst createTableGSIIndexes = (count: number) => {\n    const result: GenericRecord = {};\n    for (let i = 1; i <= count; i++) {\n        result[`GSI${i}`] = {\n            partitionKey: `GSI${i}_PK`,\n            sortKey: `GSI${i}_SK`\n        };\n    }\n    return result;\n};\n\nexport const createEntity = (params: ICreateEntityParams): ICreateEntityResult => {\n    const { gsiAmount, client, tableName } = params;\n    const name = tableName || process.env.DB_TABLE_AUDIT_LOGS;\n    if (!name) {\n        throw new Error(\"Missing env.DB_TABLE_AUDIT_LOGS environment variable.\");\n    }\n    const table = createTable({\n        documentClient: client,\n        name,\n        indexes: {\n            ...createTableGSIIndexes(gsiAmount)\n        }\n    });\n\n    const entity = baseCreateEntity<IAuditLogsEntityAttributes>({\n        name: \"AuditLogs\",\n        table: table.table,\n        attributes: {\n            PK: {\n                partitionKey: true\n            },\n            SK: {\n                sortKey: true\n            },\n            GSI_TENANT: {\n                type: \"string\",\n                required: true\n            },\n            GSI1_PK: {\n                type: \"string\",\n                required: true\n            },\n            GSI1_SK: {\n                type: \"number\",\n                required: true\n            },\n            GSI2_PK: {\n                type: \"string\",\n                required: true\n            },\n            GSI2_SK: {\n                type: \"number\",\n                required: true\n            },\n            GSI3_PK: {\n                type: \"string\",\n                required: true\n            },\n            GSI3_SK: {\n                type: \"number\",\n                required: true\n            },\n            GSI4_PK: {\n                type: \"string\",\n                required: true\n            },\n            GSI4_SK: {\n                type: \"number\",\n                required: true\n            },\n            GSI5_PK: {\n                type: \"string\",\n                required: true\n            },\n            GSI5_SK: {\n                type: \"number\",\n                required: true\n            },\n            GSI6_PK: {\n                type: \"string\",\n                required: true\n            },\n            GSI6_SK: {\n                type: \"number\",\n                required: true\n            },\n            GSI7_PK: {\n                type: \"string\",\n                required: true\n            },\n            GSI7_SK: {\n                type: \"number\",\n                required: true\n            },\n            GSI8_PK: {\n                type: \"string\",\n                required: true\n            },\n            GSI8_SK: {\n                type: \"number\",\n                required: true\n            },\n            GSI9_PK: {\n                type: \"string\",\n                required: true\n            },\n            GSI9_SK: {\n                type: \"number\",\n                required: true\n            },\n            data: {\n                type: \"map\",\n                required: true\n            }\n        }\n    });\n\n    return {\n        entity,\n        table\n    };\n};\n"],"names":["createTableGSIIndexes","count","result","i","createEntity","params","gsiAmount","client","tableName","name","process","Error","table","createTable","entity","baseCreateEntity"],"mappings":";AA4CA,MAAMA,wBAAwB,CAACC;IAC3B,MAAMC,SAAwB,CAAC;IAC/B,IAAK,IAAIC,IAAI,GAAGA,KAAKF,OAAOE,IACxBD,MAAM,CAAC,CAAC,GAAG,EAAEC,GAAG,CAAC,GAAG;QAChB,cAAc,CAAC,GAAG,EAAEA,EAAE,GAAG,CAAC;QAC1B,SAAS,CAAC,GAAG,EAAEA,EAAE,GAAG,CAAC;IACzB;IAEJ,OAAOD;AACX;AAEO,MAAME,sBAAe,CAACC;IACzB,MAAM,EAAEC,SAAS,EAAEC,MAAM,EAAEC,SAAS,EAAE,GAAGH;IACzC,MAAMI,OAAOD,aAAaE,QAAQ,GAAG,CAAC,mBAAmB;IACzD,IAAI,CAACD,MACD,MAAM,IAAIE,MAAM;IAEpB,MAAMC,QAAQC,YAAY;QACtB,gBAAgBN;QAChBE;QACA,SAAS;YACL,GAAGT,sBAAsBM,UAAU;QACvC;IACJ;IAEA,MAAMQ,SAASC,aAA6C;QACxD,MAAM;QACN,OAAOH,MAAM,KAAK;QAClB,YAAY;YACR,IAAI;gBACA,cAAc;YAClB;YACA,IAAI;gBACA,SAAS;YACb;YACA,YAAY;gBACR,MAAM;gBACN,UAAU;YACd;YACA,SAAS;gBACL,MAAM;gBACN,UAAU;YACd;YACA,SAAS;gBACL,MAAM;gBACN,UAAU;YACd;YACA,SAAS;gBACL,MAAM;gBACN,UAAU;YACd;YACA,SAAS;gBACL,MAAM;gBACN,UAAU;YACd;YACA,SAAS;gBACL,MAAM;gBACN,UAAU;YACd;YACA,SAAS;gBACL,MAAM;gBACN,UAAU;YACd;YACA,SAAS;gBACL,MAAM;gBACN,UAAU;YACd;YACA,SAAS;gBACL,MAAM;gBACN,UAAU;YACd;YACA,SAAS;gBACL,MAAM;gBACN,UAAU;YACd;YACA,SAAS;gBACL,MAAM;gBACN,UAAU;YACd;YACA,SAAS;gBACL,MAAM;gBACN,UAAU;YACd;YACA,SAAS;gBACL,MAAM;gBACN,UAAU;YACd;YACA,SAAS;gBACL,MAAM;gBACN,UAAU;YACd;YACA,SAAS;gBACL,MAAM;gBACN,UAAU;YACd;YACA,SAAS;gBACL,MAAM;gBACN,UAAU;YACd;YACA,SAAS;gBACL,MAAM;gBACN,UAAU;YACd;YACA,SAAS;gBACL,MAAM;gBACN,UAAU;YACd;YACA,SAAS;gBACL,MAAM;gBACN,UAAU;YACd;YACA,MAAM;gBACF,MAAM;gBACN,UAAU;YACd;QACJ;IACJ;IAEA,OAAO;QACHE;QACAF;IACJ;AACJ"}

package/index.d.ts

@@ -0,0 +1,8 @@
+import type { DynamoDBDocument } from "@webiny/aws-sdk/client-dynamodb/index.js";
+interface RegisterAuditLogsDdbStorageOperationsParams {
+    documentClient: DynamoDBDocument;
+    tableName?: string;
+}
+export declare const registerAuditLogsDdbStorageOperations: (params: RegisterAuditLogsDdbStorageOperationsParams) => import("@webiny/handler").RegisterExtensionPlugin<import("@webiny/handler/types.js").Context>;
+export { AuditLogsDdbFeature } from "./AuditLogsDdbFeature.js";
+export type { AuditLogsDdbFeatureConfig } from "./AuditLogsDdbFeature.js";

package/index.js

@@ -0,0 +1,17 @@
+import { createRegisterExtensionPlugin } from "@webiny/handler";
+import { createStorage } from "./Storage.js";
+import { AuditLogsStorage } from "@webiny/api-audit-logs/abstractions.js";
+import { CompressionHandler } from "@webiny/utils/exports/api.js";
+const registerAuditLogsDdbStorageOperations = (params)=>createRegisterExtensionPlugin((context)=>{
+        const compressionHandler = context.container.resolve(CompressionHandler);
+        const storage = createStorage({
+            client: params.documentClient,
+            tableName: params.tableName,
+            compressionHandler
+        });
+        context.container.registerInstance(AuditLogsStorage, storage);
+    });
+export { AuditLogsDdbFeature } from "./AuditLogsDdbFeature.js";
+export { registerAuditLogsDdbStorageOperations };
+
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/index.ts"],"sourcesContent":["import type { DynamoDBDocument } from \"@webiny/aws-sdk/client-dynamodb/index.js\";\nimport { createRegisterExtensionPlugin } from \"@webiny/handler\";\nimport { createStorage } from \"~/Storage.js\";\nimport { AuditLogsStorage } from \"@webiny/api-audit-logs/abstractions.js\";\nimport { CompressionHandler } from \"@webiny/utils/exports/api.js\";\n\ninterface RegisterAuditLogsDdbStorageOperationsParams {\n    documentClient: DynamoDBDocument;\n    tableName?: string;\n}\n\nexport const registerAuditLogsDdbStorageOperations = (\n    params: RegisterAuditLogsDdbStorageOperationsParams\n) => {\n    return createRegisterExtensionPlugin(context => {\n        const compressionHandler = context.container.resolve(CompressionHandler);\n        const storage = createStorage({\n            client: params.documentClient,\n            tableName: params.tableName,\n            compressionHandler\n        });\n        context.container.registerInstance(AuditLogsStorage, storage);\n    });\n};\nexport { AuditLogsDdbFeature } from \"./AuditLogsDdbFeature.js\";\nexport type { AuditLogsDdbFeatureConfig } from \"./AuditLogsDdbFeature.js\";\n"],"names":["registerAuditLogsDdbStorageOperations","params","createRegisterExtensionPlugin","context","compressionHandler","CompressionHandler","storage","createStorage","AuditLogsStorage"],"mappings":";;;;AAWO,MAAMA,wCAAwC,CACjDC,SAEOC,8BAA8BC,CAAAA;QACjC,MAAMC,qBAAqBD,QAAQ,SAAS,CAAC,OAAO,CAACE;QACrD,MAAMC,UAAUC,cAAc;YAC1B,QAAQN,OAAO,cAAc;YAC7B,WAAWA,OAAO,SAAS;YAC3BG;QACJ;QACAD,QAAQ,SAAS,CAAC,gBAAgB,CAACK,kBAAkBF;IACzD"}

package/package.json

@@ -0,0 +1,46 @@
+{
+	"name": "@webiny/api-audit-logs-ddb",
+	"version": "0.0.0-unstable.0d717d18dd",
+	"type": "module",
+	"keywords": [
+		"@webiny/api-audit-logs",
+		"storage-operations",
+		"dynamodb",
+		"ddb",
+		"sau:ddb"
+	],
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/webiny/webiny-js.git"
+	},
+	"description": "DynamoDB storage operations for @webiny/api-audit-logs.",
+	"author": "Webiny Ltd.",
+	"license": "MIT",
+	"exports": {
+		".": "./index.js",
+		"./*": "./*"
+	},
+	"dependencies": {
+		"@webiny/api": "0.0.0-unstable.0d717d18dd",
+		"@webiny/api-audit-logs": "0.0.0-unstable.0d717d18dd",
+		"@webiny/aws-sdk": "0.0.0-unstable.0d717d18dd",
+		"@webiny/db-dynamodb": "0.0.0-unstable.0d717d18dd",
+		"@webiny/error": "0.0.0-unstable.0d717d18dd",
+		"@webiny/feature": "0.0.0-unstable.0d717d18dd",
+		"@webiny/handler": "0.0.0-unstable.0d717d18dd",
+		"@webiny/utils": "0.0.0-unstable.0d717d18dd",
+		"zod": "4.4.3"
+	},
+	"devDependencies": {
+		"@webiny/build-tools": "0.0.0-unstable.0d717d18dd",
+		"@webiny/project-utils": "0.0.0-unstable.0d717d18dd",
+		"rimraf": "6.1.3",
+		"typescript": "7.0.2"
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"webiny": {
+		"publishFrom": "dist"
+	}
+}

package/results/ListErrorResult.d.ts

@@ -0,0 +1,10 @@
+import type { IStorageListErrorResult } from "@webiny/api-audit-logs/storage/abstractions/Storage.js";
+export interface IListErrorResultParams {
+    error: Error;
+}
+export declare class ListErrorResult implements IStorageListErrorResult {
+    readonly error: Error;
+    readonly success = false;
+    private constructor();
+    static create(params: IListErrorResultParams): IStorageListErrorResult;
+}

package/results/ListErrorResult.js

@@ -0,0 +1,12 @@
+class ListErrorResult {
+    constructor(params){
+        this.success = false;
+        this.error = params.error;
+    }
+    static create(params) {
+        return new ListErrorResult(params);
+    }
+}
+export { ListErrorResult };
+
+//# sourceMappingURL=ListErrorResult.js.map

package/results/ListErrorResult.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"results/ListErrorResult.js","sources":["../../src/results/ListErrorResult.ts"],"sourcesContent":["import type { IStorageListErrorResult } from \"@webiny/api-audit-logs/storage/abstractions/Storage.js\";\n\nexport interface IListErrorResultParams {\n    error: Error;\n}\n\nexport class ListErrorResult implements IStorageListErrorResult {\n    public readonly error: Error;\n    public readonly success = false;\n\n    private constructor(params: IListErrorResultParams) {\n        this.error = params.error;\n    }\n\n    public static create(params: IListErrorResultParams): IStorageListErrorResult {\n        return new ListErrorResult(params);\n    }\n}\n"],"names":["ListErrorResult","params"],"mappings":"AAMO,MAAMA;IAIT,YAAoBC,MAA8B,CAAE;aAFpC,OAAO,GAAG;QAGtB,IAAI,CAAC,KAAK,GAAGA,OAAO,KAAK;IAC7B;IAEA,OAAc,OAAOA,MAA8B,EAA2B;QAC1E,OAAO,IAAID,gBAAgBC;IAC/B;AACJ"}

package/results/ListSuccessResult.d.ts

@@ -0,0 +1,14 @@
+import type { IStorageListSuccessResult, IStorageListSuccessResultMeta } from "@webiny/api-audit-logs/storage/abstractions/Storage.js";
+import type { GenericRecord } from "@webiny/api/types.js";
+import type { IAuditLog } from "@webiny/api-audit-logs/storage/types.js";
+export interface IListSuccessResultParams {
+    data: IAuditLog[];
+    lastEvaluatedKey?: GenericRecord;
+}
+export declare class ListSuccessResult implements IStorageListSuccessResult {
+    readonly data: IAuditLog[];
+    readonly meta: IStorageListSuccessResultMeta;
+    readonly success = true;
+    protected constructor(params: IListSuccessResultParams);
+    static create(params: IListSuccessResultParams): IStorageListSuccessResult;
+}

package/results/ListSuccessResult.js

@@ -0,0 +1,17 @@
+import { encodeCursor } from "@webiny/db-dynamodb";
+class ListSuccessResult {
+    constructor(params){
+        this.success = true;
+        this.data = params.data;
+        this.meta = {
+            after: encodeCursor(params.lastEvaluatedKey) || void 0,
+            hasMoreItems: !!params.lastEvaluatedKey
+        };
+    }
+    static create(params) {
+        return new ListSuccessResult(params);
+    }
+}
+export { ListSuccessResult };
+
+//# sourceMappingURL=ListSuccessResult.js.map

package/results/ListSuccessResult.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"results/ListSuccessResult.js","sources":["../../src/results/ListSuccessResult.ts"],"sourcesContent":["import type {\n    IStorageListSuccessResult,\n    IStorageListSuccessResultMeta\n} from \"@webiny/api-audit-logs/storage/abstractions/Storage.js\";\nimport type { GenericRecord } from \"@webiny/api/types.js\";\nimport { encodeCursor } from \"@webiny/db-dynamodb\";\nimport type { IAuditLog } from \"@webiny/api-audit-logs/storage/types.js\";\n\nexport interface IListSuccessResultParams {\n    data: IAuditLog[];\n    lastEvaluatedKey?: GenericRecord;\n}\n\nexport class ListSuccessResult implements IStorageListSuccessResult {\n    public readonly data: IAuditLog[];\n    public readonly meta: IStorageListSuccessResultMeta;\n    public readonly success = true;\n\n    protected constructor(params: IListSuccessResultParams) {\n        this.data = params.data;\n        this.meta = {\n            after: encodeCursor(params.lastEvaluatedKey) || undefined,\n            hasMoreItems: !!params.lastEvaluatedKey\n        };\n    }\n\n    public static create(params: IListSuccessResultParams): IStorageListSuccessResult {\n        return new ListSuccessResult(params);\n    }\n}\n"],"names":["ListSuccessResult","params","encodeCursor","undefined"],"mappings":";AAaO,MAAMA;IAKT,YAAsBC,MAAgC,CAAE;aAFxC,OAAO,GAAG;QAGtB,IAAI,CAAC,IAAI,GAAGA,OAAO,IAAI;QACvB,IAAI,CAAC,IAAI,GAAG;YACR,OAAOC,aAAaD,OAAO,gBAAgB,KAAKE;YAChD,cAAc,CAAC,CAACF,OAAO,gBAAgB;QAC3C;IACJ;IAEA,OAAc,OAAOA,MAAgC,EAA6B;QAC9E,OAAO,IAAID,kBAAkBC;IACjC;AACJ"}

package/results/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./ListErrorResult.js";
+export * from "./ListSuccessResult.js";

package/results/index.js

@@ -0,0 +1,2 @@
+export * from "./ListErrorResult.js";
+export * from "./ListSuccessResult.js";

package/startKey.d.ts

@@ -0,0 +1,2 @@
+import type { IStorageListParams } from "@webiny/api-audit-logs/storage/abstractions/Storage.js";
+export declare const createStartKey: (params: Pick<IStorageListParams, "after">) => Record<string, unknown> | undefined;

package/startKey.js

@@ -0,0 +1,8 @@
+import { fetchCursor } from "./cursorSchema.js";
+const createStartKey = (params)=>{
+    if (!params.after) return;
+    return fetchCursor(params.after);
+};
+export { createStartKey };
+
+//# sourceMappingURL=startKey.js.map

package/startKey.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"startKey.js","sources":["../src/startKey.ts"],"sourcesContent":["import type { IStorageListParams } from \"@webiny/api-audit-logs/storage/abstractions/Storage.js\";\nimport { fetchCursor } from \"~/cursorSchema.js\";\n\nexport const createStartKey = (\n    params: Pick<IStorageListParams, \"after\">\n): Record<string, unknown> | undefined => {\n    if (!params.after) {\n        return undefined;\n    }\n    return fetchCursor(params.after);\n};\n"],"names":["createStartKey","params","fetchCursor"],"mappings":";AAGO,MAAMA,iBAAiB,CAC1BC;IAEA,IAAI,CAACA,OAAO,KAAK,EACb;IAEJ,OAAOC,YAAYD,OAAO,KAAK;AACnC"}

package/types.d.ts

@@ -0,0 +1,36 @@
+import type { IAuditLog } from "@webiny/api-audit-logs/storage/types.js";
+export interface IStorageAuditLog extends Omit<IAuditLog, "createdOn" | "content" | "expiresAt"> {
+    expiresAt: string;
+    createdOn: string;
+    content: string;
+}
+export interface IStorageItem {
+    PK: string;
+    SK: string;
+    TYPE: string;
+    GSI_TENANT: string;
+    GSI1_PK: string;
+    GSI1_SK: number;
+    GSI2_PK: string;
+    GSI2_SK: number;
+    GSI3_PK: string;
+    GSI3_SK: number;
+    GSI4_PK: string;
+    GSI4_SK: number;
+    GSI5_PK: string;
+    GSI5_SK: number;
+    GSI6_PK: string;
+    GSI6_SK: number;
+    GSI7_PK: string;
+    GSI7_SK: number;
+    GSI8_PK: string;
+    GSI8_SK: number;
+    GSI9_PK: string;
+    GSI9_SK: number;
+    data: IStorageAuditLog;
+    expiresAt: number;
+}
+export interface IIndexStorageItem {
+    PK: string;
+    SK: string;
+}