@webiny/db-dynamodb 0.0.0-unstable.e3f4727c56 → 0.0.0-unstable.ecd8734205

package/index.d.ts

@@ -1,2 +1,4 @@
 import { default as DynamoDbDriver } from "./DynamoDbDriver";
+export * from "./utils/createStandardEntity";
+export { DbItem } from "./types";
 export { DynamoDbDriver };

package/index.js

@@ -4,10 +4,33 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+var _exportNames = {
+  DynamoDbDriver: true,
+  DbItem: true
+};
+Object.defineProperty(exports, "DbItem", {
+  enumerable: true,
+  get: function () {
+    return _types.DbItem;
+  }
+});
 Object.defineProperty(exports, "DynamoDbDriver", {
   enumerable: true,
   get: function () {
     return _DynamoDbDriver.default;
   }
 });
-var _DynamoDbDriver = _interopRequireDefault(require("./DynamoDbDriver"));
+var _DynamoDbDriver = _interopRequireDefault(require("./DynamoDbDriver"));
+var _createStandardEntity = require("./utils/createStandardEntity");
+Object.keys(_createStandardEntity).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _createStandardEntity[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _createStandardEntity[key];
+    }
+  });
+});
+var _types = require("./types");

package/index.js.map

@@ -1 +1 @@
-{"version":3,"names":[],"sources":["index.ts"],"sourcesContent":["import { default as DynamoDbDriver } from \"./DynamoDbDriver\";\n\nexport { DynamoDbDriver };\n"],"mappings":";;;;;;;;;;;;AAAA"}
+{"version":3,"names":[],"sources":["index.ts"],"sourcesContent":["import { default as DynamoDbDriver } from \"./DynamoDbDriver\";\nexport * from \"./utils/createStandardEntity\";\nexport { DbItem } from \"./types\";\n\nexport { DynamoDbDriver };\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA;AACA;AAAA;EAAA;EAAA;EAAA;EAAA;IAAA;IAAA;MAAA;IAAA;EAAA;AAAA;AACA"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@webiny/db-dynamodb",
-	"version": "0.0.0-unstable.e3f4727c56",
+	"version": "0.0.0-unstable.ecd8734205",
 	"main": "index.js",
 	"repository": {
 		"type": "git",
@@ -10,11 +10,11 @@
 	"author": "Webiny Ltd",
 	"license": "MIT",
 	"dependencies": {
-		"@webiny/api": "0.0.0-unstable.e3f4727c56",
-		"@webiny/db": "0.0.0-unstable.e3f4727c56",
-		"@webiny/error": "0.0.0-unstable.e3f4727c56",
-		"@webiny/handler-db": "0.0.0-unstable.e3f4727c56",
-		"@webiny/plugins": "0.0.0-unstable.e3f4727c56",
+		"@webiny/api": "0.0.0-unstable.ecd8734205",
+		"@webiny/db": "0.0.0-unstable.ecd8734205",
+		"@webiny/error": "0.0.0-unstable.ecd8734205",
+		"@webiny/handler-db": "0.0.0-unstable.ecd8734205",
+		"@webiny/plugins": "0.0.0-unstable.ecd8734205",
 		"date-fns": "2.29.3",
 		"dot-prop": "6.0.1",
 		"fuse.js": "6.6.2",
@@ -25,8 +25,8 @@
 		"@babel/cli": "^7.19.3",
 		"@babel/core": "^7.19.3",
 		"@types/is-number": "^7.0.2",
-		"@webiny/cli": "^0.0.0-unstable.e3f4727c56",
-		"@webiny/project-utils": "^0.0.0-unstable.e3f4727c56",
+		"@webiny/cli": "^0.0.0-unstable.ecd8734205",
+		"@webiny/project-utils": "^0.0.0-unstable.ecd8734205",
 		"dynamodb-toolbox": "^0.3.5",
 		"jest": "^28.1.0",
 		"jest-dynalite": "^3.2.0",
@@ -42,5 +42,5 @@
 		"build": "yarn webiny run build",
 		"watch": "yarn webiny run watch"
 	},
-	"gitHead": "e3f4727c567484dc53e1efceacfb37dbacd7f4de"
+	"gitHead": "ecd8734205e0e21ae04076c28ff9806dad07a730"
 }

package/types.d.ts

@@ -55,4 +55,12 @@ export interface QueryKey {
 }
 export declare type QueryKeys = QueryKey[];
 export declare type QuerySort = Record<string, -1 | 1>;
+export declare type DbItem<TData extends Record<string, any> = Record<string, any>> = {
+    PK: string;
+    SK: string;
+    GSI1_PK: string;
+    GSI1_SK: string;
+    TYPE: string;
+    data: TData;
+};
 export {};

package/types.js.map

@@ -1 +1 @@
-{"version":3,"names":[],"sources":["types.ts"],"sourcesContent":["export interface OperatorArgs {\n    expression: string;\n    attributeNames: Record<string, any>;\n    attributeValues: Record<string, any>;\n}\n\ninterface CanProcessArgs {\n    key: string;\n    value: any;\n    args: OperatorArgs;\n}\n\ninterface ProcessArgs {\n    key: string;\n    value: any;\n    args: OperatorArgs;\n    processStatement: any;\n}\n\nexport interface Operator {\n    canProcess: ({ key }: CanProcessArgs) => boolean;\n    process: ({ key, value, args }: ProcessArgs) => void;\n}\n\n/**\n * We use this definition to search for a value in any given field that was passed.\n * It works as an \"OR\" condition.\n */\nexport interface DynamoDbContainsFilter {\n    fields: string[];\n    value: string;\n}\n\nexport interface ProcessStatementArgsParam {\n    expression: string;\n    attributeNames: Record<string, any>;\n    attributeValues: Record<string, any>;\n}\nexport interface ProcessStatementQueryParam {\n    [key: string]: any;\n}\nexport interface ProcessStatementParams {\n    args: ProcessStatementArgsParam;\n    query: ProcessStatementQueryParam;\n}\n\nexport interface ProcessStatementCallable {\n    (params: ProcessStatementParams): void;\n}\n\nexport interface Query {\n    [key: string]: string;\n}\nexport interface QueryKeyField {\n    name: string;\n}\nexport interface QueryKey {\n    fields: QueryKeyField[];\n    primary?: boolean;\n    unique?: boolean;\n    name: string;\n}\nexport type QueryKeys = QueryKey[];\n\nexport type QuerySort = Record<string, -1 | 1>;\n"],"mappings":""}
+{"version":3,"names":[],"sources":["types.ts"],"sourcesContent":["export interface OperatorArgs {\n    expression: string;\n    attributeNames: Record<string, any>;\n    attributeValues: Record<string, any>;\n}\n\ninterface CanProcessArgs {\n    key: string;\n    value: any;\n    args: OperatorArgs;\n}\n\ninterface ProcessArgs {\n    key: string;\n    value: any;\n    args: OperatorArgs;\n    processStatement: any;\n}\n\nexport interface Operator {\n    canProcess: ({ key }: CanProcessArgs) => boolean;\n    process: ({ key, value, args }: ProcessArgs) => void;\n}\n\n/**\n * We use this definition to search for a value in any given field that was passed.\n * It works as an \"OR\" condition.\n */\nexport interface DynamoDbContainsFilter {\n    fields: string[];\n    value: string;\n}\n\nexport interface ProcessStatementArgsParam {\n    expression: string;\n    attributeNames: Record<string, any>;\n    attributeValues: Record<string, any>;\n}\nexport interface ProcessStatementQueryParam {\n    [key: string]: any;\n}\nexport interface ProcessStatementParams {\n    args: ProcessStatementArgsParam;\n    query: ProcessStatementQueryParam;\n}\n\nexport interface ProcessStatementCallable {\n    (params: ProcessStatementParams): void;\n}\n\nexport interface Query {\n    [key: string]: string;\n}\nexport interface QueryKeyField {\n    name: string;\n}\nexport interface QueryKey {\n    fields: QueryKeyField[];\n    primary?: boolean;\n    unique?: boolean;\n    name: string;\n}\nexport type QueryKeys = QueryKey[];\n\nexport type QuerySort = Record<string, -1 | 1>;\n\nexport type DbItem<TData extends Record<string, any> = Record<string, any>> = {\n    PK: string;\n    SK: string;\n    GSI1_PK: string;\n    GSI1_SK: string;\n    TYPE: string;\n    data: TData;\n};\n"],"mappings":""}

package/utils/createStandardEntity.d.ts

@@ -0,0 +1,2 @@
+import { Entity, Table } from "dynamodb-toolbox";
+export declare const createStandardEntity: (table: Table, name: string) => Entity<any>;

package/utils/createStandardEntity.js

@@ -0,0 +1,34 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createStandardEntity = void 0;
+var _dynamodbToolbox = require("dynamodb-toolbox");
+const createStandardEntity = (table, name) => {
+  return new _dynamodbToolbox.Entity({
+    name,
+    table,
+    attributes: {
+      PK: {
+        partitionKey: true
+      },
+      SK: {
+        sortKey: true
+      },
+      GSI1_PK: {
+        type: "string"
+      },
+      GSI1_SK: {
+        type: "string"
+      },
+      TYPE: {
+        type: "string"
+      },
+      data: {
+        type: "map"
+      }
+    }
+  });
+};
+exports.createStandardEntity = createStandardEntity;

package/utils/createStandardEntity.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["createStandardEntity","table","name","Entity","attributes","PK","partitionKey","SK","sortKey","GSI1_PK","type","GSI1_SK","TYPE","data"],"sources":["createStandardEntity.ts"],"sourcesContent":["import { Entity, Table } from \"dynamodb-toolbox\";\n\nexport const createStandardEntity = (table: Table, name: string): Entity<any> => {\n    return new Entity({\n        name,\n        table,\n        attributes: {\n            PK: {\n                partitionKey: true\n            },\n            SK: {\n                sortKey: true\n            },\n            GSI1_PK: {\n                type: \"string\"\n            },\n            GSI1_SK: {\n                type: \"string\"\n            },\n            TYPE: {\n                type: \"string\"\n            },\n            data: {\n                type: \"map\"\n            }\n        }\n    });\n};\n"],"mappings":";;;;;;AAAA;AAEO,MAAMA,oBAAoB,GAAG,CAACC,KAAY,EAAEC,IAAY,KAAkB;EAC7E,OAAO,IAAIC,uBAAM,CAAC;IACdD,IAAI;IACJD,KAAK;IACLG,UAAU,EAAE;MACRC,EAAE,EAAE;QACAC,YAAY,EAAE;MAClB,CAAC;MACDC,EAAE,EAAE;QACAC,OAAO,EAAE;MACb,CAAC;MACDC,OAAO,EAAE;QACLC,IAAI,EAAE;MACV,CAAC;MACDC,OAAO,EAAE;QACLD,IAAI,EAAE;MACV,CAAC;MACDE,IAAI,EAAE;QACFF,IAAI,EAAE;MACV,CAAC;MACDG,IAAI,EAAE;QACFH,IAAI,EAAE;MACV;IACJ;EACJ,CAAC,CAAC;AACN,CAAC;AAAC"}