@webiny/api-record-locking 5.40.0-beta.3

package/crud/model.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_apiHeadlessCms","require","RECORD_LOCKING_MODEL_ID","exports","createLockingModel","createCmsModel","createPrivateModel","modelId","name","fields","id","type","fieldId","storageId","label","validation","message","multipleValues","settings"],"sources":["model.ts"],"sourcesContent":["import { createCmsModel, createPrivateModel } from \"@webiny/api-headless-cms\";\n\nexport const RECORD_LOCKING_MODEL_ID = \"wby_recordLocking\";\n\nexport const createLockingModel = () => {\n    return createCmsModel(\n        createPrivateModel({\n            modelId: RECORD_LOCKING_MODEL_ID,\n            name: \"Record Lock Tracking\",\n            fields: [\n                {\n                    id: \"targetId\",\n                    type: \"text\",\n                    fieldId: \"targetId\",\n                    storageId: \"text@targetId\",\n                    label: \"Target ID\",\n                    validation: [\n                        {\n                            name: \"required\",\n                            message: \"Target ID is required.\"\n                        }\n                    ]\n                },\n                /**\n                 * Since we need a generic way to track records, we will use type to determine if it's a cms record or a page or a form, etc...\n                 * Update IHeadlessCmsLockRecordValues in types.ts file with additional fields as required.\n                 *\n                 * @see IHeadlessCmsLockRecordValues\n                 */\n                {\n                    id: \"type\",\n                    type: \"text\",\n                    fieldId: \"type\",\n                    storageId: \"text@type\",\n                    label: \"Record Type\",\n                    validation: [\n                        {\n                            name: \"required\",\n                            message: \"Record type is required.\"\n                        }\n                    ]\n                },\n                {\n                    id: \"actions\",\n                    type: \"object\",\n                    fieldId: \"actions\",\n                    storageId: \"object@actions\",\n                    label: \"Actions\",\n                    multipleValues: true,\n                    settings: {\n                        fields: [\n                            {\n                                id: \"type\",\n                                type: \"text\",\n                                fieldId: \"type\",\n                                storageId: \"text@type\",\n                                label: \"Action Type\",\n                                validation: [\n                                    {\n                                        name: \"required\",\n                                        message: \"Action type is required.\"\n                                    }\n                                ]\n                            },\n                            {\n                                id: \"message\",\n                                type: \"text\",\n                                fieldId: \"message\",\n                                storageId: \"text@message\",\n                                label: \"Message\"\n                            },\n                            {\n                                id: \"createdBy\",\n                                type: \"object\",\n                                fieldId: \"createdBy\",\n                                storageId: \"object@createdBy\",\n                                label: \"Created By\",\n                                validation: [\n                                    {\n                                        name: \"required\",\n                                        message: \"Created by is required.\"\n                                    }\n                                ],\n                                settings: {\n                                    fields: [\n                                        {\n                                            id: \"id\",\n                                            type: \"text\",\n                                            fieldId: \"id\",\n                                            storageId: \"text@id\",\n                                            label: \"ID\",\n                                            validation: [\n                                                {\n                                                    name: \"required\",\n                                                    message: \"ID is required.\"\n                                                }\n                                            ]\n                                        },\n                                        {\n                                            id: \"displayName\",\n                                            type: \"text\",\n                                            fieldId: \"displayName\",\n                                            storageId: \"text@displayName\",\n                                            label: \"Display Name\",\n                                            validation: [\n                                                {\n                                                    name: \"required\",\n                                                    message: \"Display name is required.\"\n                                                }\n                                            ]\n                                        },\n                                        {\n                                            id: \"type\",\n                                            type: \"text\",\n                                            fieldId: \"type\",\n                                            storageId: \"text@type\",\n                                            label: \"Type\",\n                                            validation: [\n                                                {\n                                                    name: \"required\",\n                                                    message: \"Type is required.\"\n                                                }\n                                            ]\n                                        }\n                                    ]\n                                }\n                            },\n                            {\n                                id: \"createdOn\",\n                                type: \"datetime\",\n                                fieldId: \"createdOn\",\n                                storageId: \"datetime@createdOn\",\n                                settings: {\n                                    type: \"dateTimeWithoutTimezone\"\n                                },\n                                label: \"Created On\",\n                                validation: [\n                                    {\n                                        name: \"required\",\n                                        message: \"Created on is required.\"\n                                    }\n                                ]\n                            }\n                        ]\n                    }\n                }\n            ]\n        })\n    );\n};\n"],"mappings":";;;;;;AAAA,IAAAA,eAAA,GAAAC,OAAA;AAEO,MAAMC,uBAAuB,GAAAC,OAAA,CAAAD,uBAAA,GAAG,mBAAmB;AAEnD,MAAME,kBAAkB,GAAGA,CAAA,KAAM;EACpC,OAAO,IAAAC,8BAAc,EACjB,IAAAC,kCAAkB,EAAC;IACfC,OAAO,EAAEL,uBAAuB;IAChCM,IAAI,EAAE,sBAAsB;IAC5BC,MAAM,EAAE,CACJ;MACIC,EAAE,EAAE,UAAU;MACdC,IAAI,EAAE,MAAM;MACZC,OAAO,EAAE,UAAU;MACnBC,SAAS,EAAE,eAAe;MAC1BC,KAAK,EAAE,WAAW;MAClBC,UAAU,EAAE,CACR;QACIP,IAAI,EAAE,UAAU;QAChBQ,OAAO,EAAE;MACb,CAAC;IAET,CAAC;IACD;AAChB;AACA;AACA;AACA;AACA;IACgB;MACIN,EAAE,EAAE,MAAM;MACVC,IAAI,EAAE,MAAM;MACZC,OAAO,EAAE,MAAM;MACfC,SAAS,EAAE,WAAW;MACtBC,KAAK,EAAE,aAAa;MACpBC,UAAU,EAAE,CACR;QACIP,IAAI,EAAE,UAAU;QAChBQ,OAAO,EAAE;MACb,CAAC;IAET,CAAC,EACD;MACIN,EAAE,EAAE,SAAS;MACbC,IAAI,EAAE,QAAQ;MACdC,OAAO,EAAE,SAAS;MAClBC,SAAS,EAAE,gBAAgB;MAC3BC,KAAK,EAAE,SAAS;MAChBG,cAAc,EAAE,IAAI;MACpBC,QAAQ,EAAE;QACNT,MAAM,EAAE,CACJ;UACIC,EAAE,EAAE,MAAM;UACVC,IAAI,EAAE,MAAM;UACZC,OAAO,EAAE,MAAM;UACfC,SAAS,EAAE,WAAW;UACtBC,KAAK,EAAE,aAAa;UACpBC,UAAU,EAAE,CACR;YACIP,IAAI,EAAE,UAAU;YAChBQ,OAAO,EAAE;UACb,CAAC;QAET,CAAC,EACD;UACIN,EAAE,EAAE,SAAS;UACbC,IAAI,EAAE,MAAM;UACZC,OAAO,EAAE,SAAS;UAClBC,SAAS,EAAE,cAAc;UACzBC,KAAK,EAAE;QACX,CAAC,EACD;UACIJ,EAAE,EAAE,WAAW;UACfC,IAAI,EAAE,QAAQ;UACdC,OAAO,EAAE,WAAW;UACpBC,SAAS,EAAE,kBAAkB;UAC7BC,KAAK,EAAE,YAAY;UACnBC,UAAU,EAAE,CACR;YACIP,IAAI,EAAE,UAAU;YAChBQ,OAAO,EAAE;UACb,CAAC,CACJ;UACDE,QAAQ,EAAE;YACNT,MAAM,EAAE,CACJ;cACIC,EAAE,EAAE,IAAI;cACRC,IAAI,EAAE,MAAM;cACZC,OAAO,EAAE,IAAI;cACbC,SAAS,EAAE,SAAS;cACpBC,KAAK,EAAE,IAAI;cACXC,UAAU,EAAE,CACR;gBACIP,IAAI,EAAE,UAAU;gBAChBQ,OAAO,EAAE;cACb,CAAC;YAET,CAAC,EACD;cACIN,EAAE,EAAE,aAAa;cACjBC,IAAI,EAAE,MAAM;cACZC,OAAO,EAAE,aAAa;cACtBC,SAAS,EAAE,kBAAkB;cAC7BC,KAAK,EAAE,cAAc;cACrBC,UAAU,EAAE,CACR;gBACIP,IAAI,EAAE,UAAU;gBAChBQ,OAAO,EAAE;cACb,CAAC;YAET,CAAC,EACD;cACIN,EAAE,EAAE,MAAM;cACVC,IAAI,EAAE,MAAM;cACZC,OAAO,EAAE,MAAM;cACfC,SAAS,EAAE,WAAW;cACtBC,KAAK,EAAE,MAAM;cACbC,UAAU,EAAE,CACR;gBACIP,IAAI,EAAE,UAAU;gBAChBQ,OAAO,EAAE;cACb,CAAC;YAET,CAAC;UAET;QACJ,CAAC,EACD;UACIN,EAAE,EAAE,WAAW;UACfC,IAAI,EAAE,UAAU;UAChBC,OAAO,EAAE,WAAW;UACpBC,SAAS,EAAE,oBAAoB;UAC/BK,QAAQ,EAAE;YACNP,IAAI,EAAE;UACV,CAAC;UACDG,KAAK,EAAE,YAAY;UACnBC,UAAU,EAAE,CACR;YACIP,IAAI,EAAE,UAAU;YAChBQ,OAAO,EAAE;UACb,CAAC;QAET,CAAC;MAET;IACJ,CAAC;EAET,CAAC,CACL,CAAC;AACL,CAAC;AAACb,OAAA,CAAAC,kBAAA,GAAAA,kBAAA","ignoreList":[]}

package/graphql/schema.d.ts

@@ -0,0 +1,7 @@
+import { Context } from "../types";
+import { IGraphQLSchemaPlugin } from "@webiny/handler-graphql";
+interface Params {
+    context: Pick<Context, "plugins" | "recordLocking" | "security" | "cms">;
+}
+export declare const createGraphQLSchema: (params: Params) => Promise<IGraphQLSchemaPlugin<Context>>;
+export {};

package/graphql/schema.js

@@ -0,0 +1,280 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createGraphQLSchema = void 0;
+var _resolve = require("../utils/resolve");
+var _handlerGraphql = require("@webiny/handler-graphql");
+var _renderFields = require("@webiny/api-headless-cms/utils/renderFields");
+var _createFieldTypePluginRecords = require("@webiny/api-headless-cms/graphql/schema/createFieldTypePluginRecords");
+var _renderListFilterFields = require("@webiny/api-headless-cms/utils/renderListFilterFields");
+var _renderSortEnum = require("@webiny/api-headless-cms/utils/renderSortEnum");
+var _checkPermissions = require("../utils/checkPermissions");
+const createGraphQLSchema = async params => {
+  const context = params.context;
+  const model = await context.recordLocking.getModel();
+  const models = await context.security.withoutAuthorization(async () => {
+    return (await context.cms.listModels()).filter(model => {
+      if (model.fields.length === 0) {
+        return false;
+      } else if (model.isPrivate) {
+        return false;
+      }
+      return true;
+    });
+  });
+  const fieldTypePlugins = (0, _createFieldTypePluginRecords.createFieldTypePluginRecords)(context.plugins);
+  const recordLockingFields = (0, _renderFields.renderFields)({
+    models,
+    model,
+    fields: model.fields,
+    type: "manage",
+    fieldTypePlugins
+  });
+  const listFilterFieldsRender = (0, _renderListFilterFields.renderListFilterFields)({
+    model,
+    fields: model.fields,
+    type: "manage",
+    fieldTypePlugins,
+    excludeFields: ["entryId"]
+  });
+  const sortEnumRender = (0, _renderSortEnum.renderSortEnum)({
+    model,
+    fields: model.fields,
+    fieldTypePlugins,
+    sorterPlugins: []
+  });
+  const plugin = (0, _handlerGraphql.createGraphQLSchemaPlugin)({
+    typeDefs: /* GraphQL */`
+            ${recordLockingFields.map(f => f.typeDefs).join("\n")}
+
+            type RecordLockingError {
+                message: String
+                code: String
+                data: JSON
+                stack: String
+            }
+
+            enum RecordLockingRecordActionType {
+                requested
+                approved
+                denied
+            }
+
+            type RecordLockingIdentity {
+                id: String!
+                displayName: String
+                type: String
+            }
+
+            type RecordLockingRecordAction {
+                id: ID!
+                type: RecordLockingRecordActionType!
+                message: String
+                createdBy: RecordLockingIdentity!
+                createdOn: DateTime!
+            }
+
+            type RecordLockingRecord {
+                id: ID!
+                lockedBy: RecordLockingIdentity!
+                lockedOn: DateTime!
+                updatedOn: DateTime!
+                expiresOn: DateTime!
+                ${recordLockingFields.map(f => f.fields).join("\n")}
+            }
+
+            type RecordLockingIsEntryLockedResponse {
+                data: Boolean
+                error: RecordLockingError
+            }
+
+            type RecordLockingGetLockRecordResponse {
+                data: RecordLockingRecord
+                error: RecordLockingError
+            }
+
+            type RecordLockingGetLockedEntryLockRecordResponse {
+                data: RecordLockingRecord
+                error: RecordLockingError
+            }
+
+            type RecordLockingListLockRecordsResponse {
+                data: [RecordLockingRecord!]
+                error: RecordLockingError
+            }
+
+            type RecordLockingLockEntryResponse {
+                data: RecordLockingRecord
+                error: RecordLockingError
+            }
+            
+            type RecordLockingUpdateLockResponse {
+                data: RecordLockingRecord
+                error: RecordLockingError
+            }
+
+            type RecordLockingUnlockEntryResponse {
+                data: RecordLockingRecord
+                error: RecordLockingError
+            }
+
+            type RecordLockingUnlockEntryRequestResponse {
+                data: RecordLockingRecord
+                error: RecordLockingError
+            }
+
+            input RecordLockingListWhereInput {
+                ${listFilterFieldsRender}
+            }
+
+            enum RecordLockingListSorter {
+                ${sortEnumRender}
+            }
+
+            type RecordLockingQuery {
+                _empty: String
+            }
+
+            type RecordLockingMutation {
+                _empty: String
+            }
+
+            extend type RecordLockingQuery {
+                isEntryLocked(id: ID!, type: String!): RecordLockingIsEntryLockedResponse!
+                getLockRecord(id: ID!, type: String!): RecordLockingGetLockRecordResponse!
+                # Returns lock record or null - if entry is locked in context of the current user, does not throw an error like getLockRecord if no record in the DB
+                getLockedEntryLockRecord(id: ID!, type: String!): RecordLockingGetLockedEntryLockRecordResponse!
+                listAllLockRecords(
+                    where: RecordLockingListWhereInput
+                    sort: [RecordLockingListSorter!]
+                    limit: Int
+                    after: String
+                ): RecordLockingListLockRecordsResponse!
+                # Basically same as listAllLockRecords except this one will filter out records with expired lock.
+                listLockRecords(
+                    where: RecordLockingListWhereInput
+                    sort: [RecordLockingListSorter!]
+                    limit: Int
+                    after: String
+                ): RecordLockingListLockRecordsResponse!
+            }
+
+            extend type RecordLockingMutation {
+                lockEntry(id: ID!, type: String!): RecordLockingLockEntryResponse!
+                updateEntryLock(id: ID!, type: String!): RecordLockingUpdateLockResponse!
+                unlockEntry(id: ID!, type: String!, force: Boolean): RecordLockingUnlockEntryResponse!
+                unlockEntryRequest(
+                    id: ID!
+                    type: String!
+                ): RecordLockingUnlockEntryRequestResponse!
+            }
+
+            extend type Query {
+                recordLocking: RecordLockingQuery
+            }
+
+            extend type Mutation {
+                recordLocking: RecordLockingMutation
+            }
+        `,
+    resolvers: {
+      Query: {
+        recordLocking: async () => ({})
+      },
+      Mutation: {
+        recordLocking: async () => ({})
+      },
+      RecordLockingQuery: {
+        async isEntryLocked(_, args, context) {
+          return (0, _resolve.resolve)(async () => {
+            await (0, _checkPermissions.checkPermissions)(context);
+            return context.recordLocking.isEntryLocked({
+              id: args.id,
+              type: args.type
+            });
+          });
+        },
+        async getLockRecord(_, args, context) {
+          return (0, _resolve.resolve)(async () => {
+            await (0, _checkPermissions.checkPermissions)(context);
+            const result = await context.recordLocking.getLockRecord({
+              id: args.id,
+              type: args.type
+            });
+            if (result) {
+              return result;
+            }
+            throw new _handlerGraphql.NotFoundError("Lock record not found.");
+          });
+        },
+        async getLockedEntryLockRecord(_, args, context) {
+          return (0, _resolve.resolve)(async () => {
+            await (0, _checkPermissions.checkPermissions)(context);
+            return await context.recordLocking.getLockedEntryLockRecord({
+              id: args.id,
+              type: args.type
+            });
+          });
+        },
+        async listLockRecords(_, args, context) {
+          return (0, _resolve.resolveList)(async () => {
+            await (0, _checkPermissions.checkPermissions)(context);
+            return await context.recordLocking.listLockRecords(args);
+          });
+        },
+        listAllLockRecords(_, args, context) {
+          return (0, _resolve.resolveList)(async () => {
+            await (0, _checkPermissions.checkPermissions)(context);
+            return await context.recordLocking.listAllLockRecords(args);
+          });
+        }
+      },
+      RecordLockingMutation: {
+        async lockEntry(_, args, context) {
+          return (0, _resolve.resolve)(async () => {
+            await (0, _checkPermissions.checkPermissions)(context);
+            return context.recordLocking.lockEntry({
+              id: args.id,
+              type: args.type
+            });
+          });
+        },
+        async updateEntryLock(_, args, context) {
+          return (0, _resolve.resolve)(async () => {
+            await (0, _checkPermissions.checkPermissions)(context);
+            return context.recordLocking.updateEntryLock({
+              id: args.id,
+              type: args.type
+            });
+          });
+        },
+        async unlockEntry(_, args, context) {
+          return (0, _resolve.resolve)(async () => {
+            await (0, _checkPermissions.checkPermissions)(context);
+            return await context.recordLocking.unlockEntry({
+              id: args.id,
+              type: args.type,
+              force: args.force
+            });
+          });
+        },
+        async unlockEntryRequest(_, args, context) {
+          return (0, _resolve.resolve)(async () => {
+            await (0, _checkPermissions.checkPermissions)(context);
+            return await context.recordLocking.unlockEntryRequest({
+              id: args.id,
+              type: args.type
+            });
+          });
+        }
+      }
+    }
+  });
+  plugin.name = "recordLocking.graphql.schema.locking";
+  return plugin;
+};
+exports.createGraphQLSchema = createGraphQLSchema;
+
+//# sourceMappingURL=schema.js.map

package/graphql/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_resolve","require","_handlerGraphql","_renderFields","_createFieldTypePluginRecords","_renderListFilterFields","_renderSortEnum","_checkPermissions","createGraphQLSchema","params","context","model","recordLocking","getModel","models","security","withoutAuthorization","cms","listModels","filter","fields","length","isPrivate","fieldTypePlugins","createFieldTypePluginRecords","plugins","recordLockingFields","renderFields","type","listFilterFieldsRender","renderListFilterFields","excludeFields","sortEnumRender","renderSortEnum","sorterPlugins","plugin","createGraphQLSchemaPlugin","typeDefs","map","f","join","resolvers","Query","Mutation","RecordLockingQuery","isEntryLocked","_","args","resolve","checkPermissions","id","getLockRecord","result","NotFoundError","getLockedEntryLockRecord","listLockRecords","resolveList","listAllLockRecords","RecordLockingMutation","lockEntry","updateEntryLock","unlockEntry","force","unlockEntryRequest","name","exports"],"sources":["schema.ts"],"sourcesContent":["import { resolve, resolveList } from \"~/utils/resolve\";\nimport { Context } from \"~/types\";\nimport {\n    createGraphQLSchemaPlugin,\n    IGraphQLSchemaPlugin,\n    NotFoundError\n} from \"@webiny/handler-graphql\";\nimport { renderFields } from \"@webiny/api-headless-cms/utils/renderFields\";\nimport { createFieldTypePluginRecords } from \"@webiny/api-headless-cms/graphql/schema/createFieldTypePluginRecords\";\nimport { renderListFilterFields } from \"@webiny/api-headless-cms/utils/renderListFilterFields\";\nimport { renderSortEnum } from \"@webiny/api-headless-cms/utils/renderSortEnum\";\nimport { checkPermissions } from \"~/utils/checkPermissions\";\n\ninterface Params {\n    context: Pick<Context, \"plugins\" | \"recordLocking\" | \"security\" | \"cms\">;\n}\nexport const createGraphQLSchema = async (\n    params: Params\n): Promise<IGraphQLSchemaPlugin<Context>> => {\n    const context = params.context;\n\n    const model = await context.recordLocking.getModel();\n\n    const models = await context.security.withoutAuthorization(async () => {\n        return (await context.cms.listModels()).filter(model => {\n            if (model.fields.length === 0) {\n                return false;\n            } else if (model.isPrivate) {\n                return false;\n            }\n            return true;\n        });\n    });\n\n    const fieldTypePlugins = createFieldTypePluginRecords(context.plugins);\n\n    const recordLockingFields = renderFields({\n        models,\n        model,\n        fields: model.fields,\n        type: \"manage\",\n        fieldTypePlugins\n    });\n\n    const listFilterFieldsRender = renderListFilterFields({\n        model,\n        fields: model.fields,\n        type: \"manage\",\n        fieldTypePlugins,\n        excludeFields: [\"entryId\"]\n    });\n\n    const sortEnumRender = renderSortEnum({\n        model,\n        fields: model.fields,\n        fieldTypePlugins,\n        sorterPlugins: []\n    });\n\n    const plugin = createGraphQLSchemaPlugin<Context>({\n        typeDefs: /* GraphQL */ `\n            ${recordLockingFields.map(f => f.typeDefs).join(\"\\n\")}\n\n            type RecordLockingError {\n                message: String\n                code: String\n                data: JSON\n                stack: String\n            }\n\n            enum RecordLockingRecordActionType {\n                requested\n                approved\n                denied\n            }\n\n            type RecordLockingIdentity {\n                id: String!\n                displayName: String\n                type: String\n            }\n\n            type RecordLockingRecordAction {\n                id: ID!\n                type: RecordLockingRecordActionType!\n                message: String\n                createdBy: RecordLockingIdentity!\n                createdOn: DateTime!\n            }\n\n            type RecordLockingRecord {\n                id: ID!\n                lockedBy: RecordLockingIdentity!\n                lockedOn: DateTime!\n                updatedOn: DateTime!\n                expiresOn: DateTime!\n                ${recordLockingFields.map(f => f.fields).join(\"\\n\")}\n            }\n\n            type RecordLockingIsEntryLockedResponse {\n                data: Boolean\n                error: RecordLockingError\n            }\n\n            type RecordLockingGetLockRecordResponse {\n                data: RecordLockingRecord\n                error: RecordLockingError\n            }\n\n            type RecordLockingGetLockedEntryLockRecordResponse {\n                data: RecordLockingRecord\n                error: RecordLockingError\n            }\n\n            type RecordLockingListLockRecordsResponse {\n                data: [RecordLockingRecord!]\n                error: RecordLockingError\n            }\n\n            type RecordLockingLockEntryResponse {\n                data: RecordLockingRecord\n                error: RecordLockingError\n            }\n            \n            type RecordLockingUpdateLockResponse {\n                data: RecordLockingRecord\n                error: RecordLockingError\n            }\n\n            type RecordLockingUnlockEntryResponse {\n                data: RecordLockingRecord\n                error: RecordLockingError\n            }\n\n            type RecordLockingUnlockEntryRequestResponse {\n                data: RecordLockingRecord\n                error: RecordLockingError\n            }\n\n            input RecordLockingListWhereInput {\n                ${listFilterFieldsRender}\n            }\n\n            enum RecordLockingListSorter {\n                ${sortEnumRender}\n            }\n\n            type RecordLockingQuery {\n                _empty: String\n            }\n\n            type RecordLockingMutation {\n                _empty: String\n            }\n\n            extend type RecordLockingQuery {\n                isEntryLocked(id: ID!, type: String!): RecordLockingIsEntryLockedResponse!\n                getLockRecord(id: ID!, type: String!): RecordLockingGetLockRecordResponse!\n                # Returns lock record or null - if entry is locked in context of the current user, does not throw an error like getLockRecord if no record in the DB\n                getLockedEntryLockRecord(id: ID!, type: String!): RecordLockingGetLockedEntryLockRecordResponse!\n                listAllLockRecords(\n                    where: RecordLockingListWhereInput\n                    sort: [RecordLockingListSorter!]\n                    limit: Int\n                    after: String\n                ): RecordLockingListLockRecordsResponse!\n                # Basically same as listAllLockRecords except this one will filter out records with expired lock.\n                listLockRecords(\n                    where: RecordLockingListWhereInput\n                    sort: [RecordLockingListSorter!]\n                    limit: Int\n                    after: String\n                ): RecordLockingListLockRecordsResponse!\n            }\n\n            extend type RecordLockingMutation {\n                lockEntry(id: ID!, type: String!): RecordLockingLockEntryResponse!\n                updateEntryLock(id: ID!, type: String!): RecordLockingUpdateLockResponse!\n                unlockEntry(id: ID!, type: String!, force: Boolean): RecordLockingUnlockEntryResponse!\n                unlockEntryRequest(\n                    id: ID!\n                    type: String!\n                ): RecordLockingUnlockEntryRequestResponse!\n            }\n\n            extend type Query {\n                recordLocking: RecordLockingQuery\n            }\n\n            extend type Mutation {\n                recordLocking: RecordLockingMutation\n            }\n        `,\n        resolvers: {\n            Query: {\n                recordLocking: async () => ({})\n            },\n            Mutation: {\n                recordLocking: async () => ({})\n            },\n            RecordLockingQuery: {\n                async isEntryLocked(_, args, context) {\n                    return resolve(async () => {\n                        await checkPermissions(context);\n                        return context.recordLocking.isEntryLocked({\n                            id: args.id,\n                            type: args.type\n                        });\n                    });\n                },\n                async getLockRecord(_, args, context) {\n                    return resolve(async () => {\n                        await checkPermissions(context);\n                        const result = await context.recordLocking.getLockRecord({\n                            id: args.id,\n                            type: args.type\n                        });\n                        if (result) {\n                            return result;\n                        }\n                        throw new NotFoundError(\"Lock record not found.\");\n                    });\n                },\n                async getLockedEntryLockRecord(_, args, context) {\n                    return resolve(async () => {\n                        await checkPermissions(context);\n                        return await context.recordLocking.getLockedEntryLockRecord({\n                            id: args.id,\n                            type: args.type\n                        });\n                    });\n                },\n\n                async listLockRecords(_, args, context) {\n                    return resolveList(async () => {\n                        await checkPermissions(context);\n                        return await context.recordLocking.listLockRecords(args);\n                    });\n                },\n                listAllLockRecords(_, args, context) {\n                    return resolveList(async () => {\n                        await checkPermissions(context);\n                        return await context.recordLocking.listAllLockRecords(args);\n                    });\n                }\n            },\n            RecordLockingMutation: {\n                async lockEntry(_, args, context) {\n                    return resolve(async () => {\n                        await checkPermissions(context);\n                        return context.recordLocking.lockEntry({\n                            id: args.id,\n                            type: args.type\n                        });\n                    });\n                },\n                async updateEntryLock(_, args, context) {\n                    return resolve(async () => {\n                        await checkPermissions(context);\n                        return context.recordLocking.updateEntryLock({\n                            id: args.id,\n                            type: args.type\n                        });\n                    });\n                },\n                async unlockEntry(_, args, context) {\n                    return resolve(async () => {\n                        await checkPermissions(context);\n                        return await context.recordLocking.unlockEntry({\n                            id: args.id,\n                            type: args.type,\n                            force: args.force\n                        });\n                    });\n                },\n                async unlockEntryRequest(_, args, context) {\n                    return resolve(async () => {\n                        await checkPermissions(context);\n                        return await context.recordLocking.unlockEntryRequest({\n                            id: args.id,\n                            type: args.type\n                        });\n                    });\n                }\n            }\n        }\n    });\n\n    plugin.name = \"recordLocking.graphql.schema.locking\";\n\n    return plugin;\n};\n"],"mappings":";;;;;;AAAA,IAAAA,QAAA,GAAAC,OAAA;AAEA,IAAAC,eAAA,GAAAD,OAAA;AAKA,IAAAE,aAAA,GAAAF,OAAA;AACA,IAAAG,6BAAA,GAAAH,OAAA;AACA,IAAAI,uBAAA,GAAAJ,OAAA;AACA,IAAAK,eAAA,GAAAL,OAAA;AACA,IAAAM,iBAAA,GAAAN,OAAA;AAKO,MAAMO,mBAAmB,GAAG,MAC/BC,MAAc,IAC2B;EACzC,MAAMC,OAAO,GAAGD,MAAM,CAACC,OAAO;EAE9B,MAAMC,KAAK,GAAG,MAAMD,OAAO,CAACE,aAAa,CAACC,QAAQ,CAAC,CAAC;EAEpD,MAAMC,MAAM,GAAG,MAAMJ,OAAO,CAACK,QAAQ,CAACC,oBAAoB,CAAC,YAAY;IACnE,OAAO,CAAC,MAAMN,OAAO,CAACO,GAAG,CAACC,UAAU,CAAC,CAAC,EAAEC,MAAM,CAACR,KAAK,IAAI;MACpD,IAAIA,KAAK,CAACS,MAAM,CAACC,MAAM,KAAK,CAAC,EAAE;QAC3B,OAAO,KAAK;MAChB,CAAC,MAAM,IAAIV,KAAK,CAACW,SAAS,EAAE;QACxB,OAAO,KAAK;MAChB;MACA,OAAO,IAAI;IACf,CAAC,CAAC;EACN,CAAC,CAAC;EAEF,MAAMC,gBAAgB,GAAG,IAAAC,0DAA4B,EAACd,OAAO,CAACe,OAAO,CAAC;EAEtE,MAAMC,mBAAmB,GAAG,IAAAC,0BAAY,EAAC;IACrCb,MAAM;IACNH,KAAK;IACLS,MAAM,EAAET,KAAK,CAACS,MAAM;IACpBQ,IAAI,EAAE,QAAQ;IACdL;EACJ,CAAC,CAAC;EAEF,MAAMM,sBAAsB,GAAG,IAAAC,8CAAsB,EAAC;IAClDnB,KAAK;IACLS,MAAM,EAAET,KAAK,CAACS,MAAM;IACpBQ,IAAI,EAAE,QAAQ;IACdL,gBAAgB;IAChBQ,aAAa,EAAE,CAAC,SAAS;EAC7B,CAAC,CAAC;EAEF,MAAMC,cAAc,GAAG,IAAAC,8BAAc,EAAC;IAClCtB,KAAK;IACLS,MAAM,EAAET,KAAK,CAACS,MAAM;IACpBG,gBAAgB;IAChBW,aAAa,EAAE;EACnB,CAAC,CAAC;EAEF,MAAMC,MAAM,GAAG,IAAAC,yCAAyB,EAAU;IAC9CC,QAAQ,EAAE,aAAe;AACjC,cAAcX,mBAAmB,CAACY,GAAG,CAACC,CAAC,IAAIA,CAAC,CAACF,QAAQ,CAAC,CAACG,IAAI,CAAC,IAAI,CAAE;AAClE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,kBAAkBd,mBAAmB,CAACY,GAAG,CAACC,CAAC,IAAIA,CAAC,CAACnB,MAAM,CAAC,CAACoB,IAAI,CAAC,IAAI,CAAE;AACpE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,kBAAkBX,sBAAuB;AACzC;AACA;AACA;AACA,kBAAkBG,cAAe;AACjC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAAS;IACDS,SAAS,EAAE;MACPC,KAAK,EAAE;QACH9B,aAAa,EAAE,MAAAA,CAAA,MAAa,CAAC,CAAC;MAClC,CAAC;MACD+B,QAAQ,EAAE;QACN/B,aAAa,EAAE,MAAAA,CAAA,MAAa,CAAC,CAAC;MAClC,CAAC;MACDgC,kBAAkB,EAAE;QAChB,MAAMC,aAAaA,CAACC,CAAC,EAAEC,IAAI,EAAErC,OAAO,EAAE;UAClC,OAAO,IAAAsC,gBAAO,EAAC,YAAY;YACvB,MAAM,IAAAC,kCAAgB,EAACvC,OAAO,CAAC;YAC/B,OAAOA,OAAO,CAACE,aAAa,CAACiC,aAAa,CAAC;cACvCK,EAAE,EAAEH,IAAI,CAACG,EAAE;cACXtB,IAAI,EAAEmB,IAAI,CAACnB;YACf,CAAC,CAAC;UACN,CAAC,CAAC;QACN,CAAC;QACD,MAAMuB,aAAaA,CAACL,CAAC,EAAEC,IAAI,EAAErC,OAAO,EAAE;UAClC,OAAO,IAAAsC,gBAAO,EAAC,YAAY;YACvB,MAAM,IAAAC,kCAAgB,EAACvC,OAAO,CAAC;YAC/B,MAAM0C,MAAM,GAAG,MAAM1C,OAAO,CAACE,aAAa,CAACuC,aAAa,CAAC;cACrDD,EAAE,EAAEH,IAAI,CAACG,EAAE;cACXtB,IAAI,EAAEmB,IAAI,CAACnB;YACf,CAAC,CAAC;YACF,IAAIwB,MAAM,EAAE;cACR,OAAOA,MAAM;YACjB;YACA,MAAM,IAAIC,6BAAa,CAAC,wBAAwB,CAAC;UACrD,CAAC,CAAC;QACN,CAAC;QACD,MAAMC,wBAAwBA,CAACR,CAAC,EAAEC,IAAI,EAAErC,OAAO,EAAE;UAC7C,OAAO,IAAAsC,gBAAO,EAAC,YAAY;YACvB,MAAM,IAAAC,kCAAgB,EAACvC,OAAO,CAAC;YAC/B,OAAO,MAAMA,OAAO,CAACE,aAAa,CAAC0C,wBAAwB,CAAC;cACxDJ,EAAE,EAAEH,IAAI,CAACG,EAAE;cACXtB,IAAI,EAAEmB,IAAI,CAACnB;YACf,CAAC,CAAC;UACN,CAAC,CAAC;QACN,CAAC;QAED,MAAM2B,eAAeA,CAACT,CAAC,EAAEC,IAAI,EAAErC,OAAO,EAAE;UACpC,OAAO,IAAA8C,oBAAW,EAAC,YAAY;YAC3B,MAAM,IAAAP,kCAAgB,EAACvC,OAAO,CAAC;YAC/B,OAAO,MAAMA,OAAO,CAACE,aAAa,CAAC2C,eAAe,CAACR,IAAI,CAAC;UAC5D,CAAC,CAAC;QACN,CAAC;QACDU,kBAAkBA,CAACX,CAAC,EAAEC,IAAI,EAAErC,OAAO,EAAE;UACjC,OAAO,IAAA8C,oBAAW,EAAC,YAAY;YAC3B,MAAM,IAAAP,kCAAgB,EAACvC,OAAO,CAAC;YAC/B,OAAO,MAAMA,OAAO,CAACE,aAAa,CAAC6C,kBAAkB,CAACV,IAAI,CAAC;UAC/D,CAAC,CAAC;QACN;MACJ,CAAC;MACDW,qBAAqB,EAAE;QACnB,MAAMC,SAASA,CAACb,CAAC,EAAEC,IAAI,EAAErC,OAAO,EAAE;UAC9B,OAAO,IAAAsC,gBAAO,EAAC,YAAY;YACvB,MAAM,IAAAC,kCAAgB,EAACvC,OAAO,CAAC;YAC/B,OAAOA,OAAO,CAACE,aAAa,CAAC+C,SAAS,CAAC;cACnCT,EAAE,EAAEH,IAAI,CAACG,EAAE;cACXtB,IAAI,EAAEmB,IAAI,CAACnB;YACf,CAAC,CAAC;UACN,CAAC,CAAC;QACN,CAAC;QACD,MAAMgC,eAAeA,CAACd,CAAC,EAAEC,IAAI,EAAErC,OAAO,EAAE;UACpC,OAAO,IAAAsC,gBAAO,EAAC,YAAY;YACvB,MAAM,IAAAC,kCAAgB,EAACvC,OAAO,CAAC;YAC/B,OAAOA,OAAO,CAACE,aAAa,CAACgD,eAAe,CAAC;cACzCV,EAAE,EAAEH,IAAI,CAACG,EAAE;cACXtB,IAAI,EAAEmB,IAAI,CAACnB;YACf,CAAC,CAAC;UACN,CAAC,CAAC;QACN,CAAC;QACD,MAAMiC,WAAWA,CAACf,CAAC,EAAEC,IAAI,EAAErC,OAAO,EAAE;UAChC,OAAO,IAAAsC,gBAAO,EAAC,YAAY;YACvB,MAAM,IAAAC,kCAAgB,EAACvC,OAAO,CAAC;YAC/B,OAAO,MAAMA,OAAO,CAACE,aAAa,CAACiD,WAAW,CAAC;cAC3CX,EAAE,EAAEH,IAAI,CAACG,EAAE;cACXtB,IAAI,EAAEmB,IAAI,CAACnB,IAAI;cACfkC,KAAK,EAAEf,IAAI,CAACe;YAChB,CAAC,CAAC;UACN,CAAC,CAAC;QACN,CAAC;QACD,MAAMC,kBAAkBA,CAACjB,CAAC,EAAEC,IAAI,EAAErC,OAAO,EAAE;UACvC,OAAO,IAAAsC,gBAAO,EAAC,YAAY;YACvB,MAAM,IAAAC,kCAAgB,EAACvC,OAAO,CAAC;YAC/B,OAAO,MAAMA,OAAO,CAACE,aAAa,CAACmD,kBAAkB,CAAC;cAClDb,EAAE,EAAEH,IAAI,CAACG,EAAE;cACXtB,IAAI,EAAEmB,IAAI,CAACnB;YACf,CAAC,CAAC;UACN,CAAC,CAAC;QACN;MACJ;IACJ;EACJ,CAAC,CAAC;EAEFO,MAAM,CAAC6B,IAAI,GAAG,sCAAsC;EAEpD,OAAO7B,MAAM;AACjB,CAAC;AAAC8B,OAAA,CAAAzD,mBAAA,GAAAA,mBAAA","ignoreList":[]}

package/index.d.ts

@@ -0,0 +1,3 @@
+import { ContextPlugin } from "@webiny/api";
+import { Context } from "./types";
+export declare const createRecordLocking: () => ContextPlugin<Context>[];

package/index.js

@@ -0,0 +1,38 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createRecordLocking = void 0;
+var _schema = require("./graphql/schema");
+var _api = require("@webiny/api");
+var _crud = require("./crud/crud");
+var _model = require("./crud/model");
+var _apiHeadlessCms = require("@webiny/api-headless-cms");
+const createContextPlugin = () => {
+  const plugin = new _api.ContextPlugin(async context => {
+    if (!context.wcp.canUseRecordLocking()) {
+      return;
+    }
+    const ready = await (0, _apiHeadlessCms.isHeadlessCmsReady)(context);
+    if (!ready) {
+      return;
+    }
+    context.plugins.register((0, _model.createLockingModel)());
+    context.recordLocking = await (0, _crud.createRecordLockingCrud)({
+      context
+    });
+    const graphQlPlugin = await (0, _schema.createGraphQLSchema)({
+      context
+    });
+    context.plugins.register(graphQlPlugin);
+  });
+  plugin.name = "context.recordLocking";
+  return plugin;
+};
+const createRecordLocking = () => {
+  return [createContextPlugin()];
+};
+exports.createRecordLocking = createRecordLocking;
+
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_schema","require","_api","_crud","_model","_apiHeadlessCms","createContextPlugin","plugin","ContextPlugin","context","wcp","canUseRecordLocking","ready","isHeadlessCmsReady","plugins","register","createLockingModel","recordLocking","createRecordLockingCrud","graphQlPlugin","createGraphQLSchema","name","createRecordLocking","exports"],"sources":["index.ts"],"sourcesContent":["import { createGraphQLSchema } from \"~/graphql/schema\";\nimport { ContextPlugin } from \"@webiny/api\";\nimport { Context } from \"~/types\";\nimport { createRecordLockingCrud } from \"~/crud/crud\";\nimport { createLockingModel } from \"~/crud/model\";\nimport { isHeadlessCmsReady } from \"@webiny/api-headless-cms\";\n\nconst createContextPlugin = () => {\n    const plugin = new ContextPlugin<Context>(async context => {\n        if (!context.wcp.canUseRecordLocking()) {\n            return;\n        }\n\n        const ready = await isHeadlessCmsReady(context);\n        if (!ready) {\n            return;\n        }\n        context.plugins.register(createLockingModel());\n\n        context.recordLocking = await createRecordLockingCrud({\n            context\n        });\n\n        const graphQlPlugin = await createGraphQLSchema({ context });\n        context.plugins.register(graphQlPlugin);\n    });\n    plugin.name = \"context.recordLocking\";\n\n    return plugin;\n};\n\nexport const createRecordLocking = () => {\n    return [createContextPlugin()];\n};\n"],"mappings":";;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AACA,IAAAC,IAAA,GAAAD,OAAA;AAEA,IAAAE,KAAA,GAAAF,OAAA;AACA,IAAAG,MAAA,GAAAH,OAAA;AACA,IAAAI,eAAA,GAAAJ,OAAA;AAEA,MAAMK,mBAAmB,GAAGA,CAAA,KAAM;EAC9B,MAAMC,MAAM,GAAG,IAAIC,kBAAa,CAAU,MAAMC,OAAO,IAAI;IACvD,IAAI,CAACA,OAAO,CAACC,GAAG,CAACC,mBAAmB,CAAC,CAAC,EAAE;MACpC;IACJ;IAEA,MAAMC,KAAK,GAAG,MAAM,IAAAC,kCAAkB,EAACJ,OAAO,CAAC;IAC/C,IAAI,CAACG,KAAK,EAAE;MACR;IACJ;IACAH,OAAO,CAACK,OAAO,CAACC,QAAQ,CAAC,IAAAC,yBAAkB,EAAC,CAAC,CAAC;IAE9CP,OAAO,CAACQ,aAAa,GAAG,MAAM,IAAAC,6BAAuB,EAAC;MAClDT;IACJ,CAAC,CAAC;IAEF,MAAMU,aAAa,GAAG,MAAM,IAAAC,2BAAmB,EAAC;MAAEX;IAAQ,CAAC,CAAC;IAC5DA,OAAO,CAACK,OAAO,CAACC,QAAQ,CAACI,aAAa,CAAC;EAC3C,CAAC,CAAC;EACFZ,MAAM,CAACc,IAAI,GAAG,uBAAuB;EAErC,OAAOd,MAAM;AACjB,CAAC;AAEM,MAAMe,mBAAmB,GAAGA,CAAA,KAAM;EACrC,OAAO,CAAChB,mBAAmB,CAAC,CAAC,CAAC;AAClC,CAAC;AAACiB,OAAA,CAAAD,mBAAA,GAAAA,mBAAA","ignoreList":[]}

package/package.json

@@ -0,0 +1,64 @@
+{
+	"name": "@webiny/api-record-locking",
+	"version": "5.40.0-beta.3",
+	"main": "index.js",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/webiny/webiny-js.git"
+	},
+	"description": "Record Locking built on top of the Headless CMS.",
+	"contributors": [
+		"Bruno Zorić <bruno@webiny.com>"
+	],
+	"license": "MIT",
+	"dependencies": {
+		"@babel/runtime": "7.24.1",
+		"@types/aws-lambda": "8.10.136",
+		"@webiny/api": "5.40.0-beta.3",
+		"@webiny/api-headless-cms": "5.40.0-beta.3",
+		"@webiny/api-websockets": "5.40.0-beta.3",
+		"@webiny/error": "5.40.0-beta.3",
+		"@webiny/handler": "5.40.0-beta.3",
+		"@webiny/handler-aws": "5.40.0-beta.3",
+		"@webiny/handler-graphql": "5.40.0-beta.3",
+		"@webiny/plugins": "5.40.0-beta.3",
+		"@webiny/pubsub": "5.40.0-beta.3",
+		"@webiny/utils": "5.40.0-beta.3"
+	},
+	"devDependencies": {
+		"@babel/cli": "7.24.1",
+		"@babel/core": "7.24.3",
+		"@babel/preset-env": "7.24.3",
+		"@babel/preset-typescript": "7.24.1",
+		"@webiny/api-i18n": "5.40.0-beta.3",
+		"@webiny/api-security": "5.40.0-beta.3",
+		"@webiny/api-tenancy": "5.40.0-beta.3",
+		"@webiny/api-wcp": "5.40.0-beta.3",
+		"@webiny/cli": "5.40.0-beta.3",
+		"@webiny/project-utils": "5.40.0-beta.3",
+		"graphql": "15.8.0",
+		"rimraf": "5.0.5",
+		"ttypescript": "1.5.15",
+		"type-fest": "2.19.0",
+		"typescript": "4.7.4"
+	},
+	"publishConfig": {
+		"access": "public",
+		"directory": "dist"
+	},
+	"scripts": {
+		"build": "yarn webiny run build",
+		"watch": "yarn webiny run watch"
+	},
+	"gitHead": "638d8b84063906cd1aa979ed6e0487ad26fbcf2f",
+	"adio": {
+		"ignore": {
+			"src": [
+				"aws-lambda"
+			],
+			"dependencies": [
+				"@types/aws-lambda"
+			]
+		}
+	}
+}

package/types.d.ts

@@ -0,0 +1,172 @@
+import { CmsContext, CmsEntry, CmsEntryListParams, CmsEntryMeta, CmsError, CmsIdentity, CmsModel, CmsModelManager } from "@webiny/api-headless-cms/types";
+import { Topic } from "@webiny/pubsub/types";
+import { Context as IWebsocketsContext, IWebsocketsContextObject } from "@webiny/api-websockets/types";
+export { CmsError, CmsEntry };
+export declare type IRecordLockingIdentity = CmsIdentity;
+export declare type IRecordLockingModelManager = CmsModelManager<IRecordLockingLockRecordValues>;
+export declare type IRecordLockingMeta = CmsEntryMeta;
+export interface IHasFullAccessCallable {
+    (): Promise<boolean>;
+}
+export interface IGetWebsocketsContextCallable {
+    (): IWebsocketsContextObject;
+}
+export interface IGetIdentity {
+    (): IRecordLockingIdentity;
+}
+export interface IRecordLockingLockRecordValues {
+    targetId: string;
+    type: IRecordLockingLockRecordEntryType;
+    actions?: IRecordLockingLockRecordAction[];
+}
+export declare enum IRecordLockingLockRecordActionType {
+    requested = "requested",
+    approved = "approved",
+    denied = "denied"
+}
+export interface IRecordLockingLockRecordRequestedAction {
+    type: IRecordLockingLockRecordActionType.requested;
+    message?: string;
+    createdOn: Date;
+    createdBy: IRecordLockingIdentity;
+}
+export interface IRecordLockingLockRecordApprovedAction {
+    type: IRecordLockingLockRecordActionType.approved;
+    message?: string;
+    createdOn: Date;
+    createdBy: IRecordLockingIdentity;
+}
+export interface IRecordLockingLockRecordDeniedAction {
+    type: IRecordLockingLockRecordActionType.denied;
+    message?: string;
+    createdOn: Date;
+    createdBy: IRecordLockingIdentity;
+}
+export declare type IRecordLockingLockRecordAction = IRecordLockingLockRecordRequestedAction | IRecordLockingLockRecordApprovedAction | IRecordLockingLockRecordDeniedAction;
+export interface IRecordLockingLockRecordObject {
+    id: string;
+    targetId: string;
+    type: IRecordLockingLockRecordEntryType;
+    lockedBy: IRecordLockingIdentity;
+    lockedOn: Date;
+    updatedOn: Date;
+    expiresOn: Date;
+    actions?: IRecordLockingLockRecordAction[];
+}
+export interface IRecordLockingLockRecord extends IRecordLockingLockRecordObject {
+    toObject(): IRecordLockingLockRecordObject;
+    addAction(action: IRecordLockingLockRecordAction): void;
+    getUnlockRequested(): IRecordLockingLockRecordRequestedAction | undefined;
+    getUnlockApproved(): IRecordLockingLockRecordApprovedAction | undefined;
+    getUnlockDenied(): IRecordLockingLockRecordDeniedAction | undefined;
+}
+/**
+ * Do not use any special chars other than #, as we use this to create lock record IDs.
+ */
+export declare type IRecordLockingLockRecordEntryType = string;
+export declare type IRecordLockingListAllLockRecordsParams = Pick<CmsEntryListParams, "where" | "limit" | "sort" | "after">;
+export declare type IRecordLockingListLockRecordsParams = IRecordLockingListAllLockRecordsParams;
+export interface IRecordLockingListAllLockRecordsResponse {
+    items: IRecordLockingLockRecord[];
+    meta: IRecordLockingMeta;
+}
+export declare type IRecordLockingListLockRecordsResponse = IRecordLockingListAllLockRecordsResponse;
+export interface IRecordLockingGetLockRecordParams {
+    id: string;
+    type: IRecordLockingLockRecordEntryType;
+}
+export interface IRecordLockingIsLockedParams {
+    id: string;
+    type: IRecordLockingLockRecordEntryType;
+}
+export interface IRecordLockingGetLockedEntryLockRecordParams {
+    id: string;
+    type: IRecordLockingLockRecordEntryType;
+}
+export interface IRecordLockingLockEntryParams {
+    id: string;
+    type: IRecordLockingLockRecordEntryType;
+}
+export interface IRecordLockingUpdateEntryLockParams {
+    id: string;
+    type: IRecordLockingLockRecordEntryType;
+}
+export interface IRecordLockingUnlockEntryParams {
+    id: string;
+    type: IRecordLockingLockRecordEntryType;
+    force?: boolean;
+}
+export interface IRecordLockingUnlockEntryRequestParams {
+    id: string;
+    type: IRecordLockingLockRecordEntryType;
+}
+export interface OnEntryBeforeLockTopicParams {
+    id: string;
+    type: IRecordLockingLockRecordEntryType;
+}
+export interface OnEntryAfterLockTopicParams {
+    id: string;
+    type: IRecordLockingLockRecordEntryType;
+    record: IRecordLockingLockRecord;
+}
+export interface OnEntryLockErrorTopicParams {
+    id: string;
+    type: IRecordLockingLockRecordEntryType;
+    error: CmsError;
+}
+export interface OnEntryBeforeUnlockTopicParams {
+    id: string;
+    type: IRecordLockingLockRecordEntryType;
+    getIdentity: IGetIdentity;
+}
+export interface OnEntryAfterUnlockTopicParams {
+    id: string;
+    type: IRecordLockingLockRecordEntryType;
+    record: IRecordLockingLockRecord;
+}
+export interface OnEntryUnlockErrorTopicParams {
+    id: string;
+    type: IRecordLockingLockRecordEntryType;
+    error: CmsError;
+}
+export interface OnEntryBeforeUnlockRequestTopicParams {
+    id: string;
+    type: IRecordLockingLockRecordEntryType;
+}
+export interface OnEntryAfterUnlockRequestTopicParams {
+    id: string;
+    type: IRecordLockingLockRecordEntryType;
+    record: IRecordLockingLockRecord;
+}
+export interface OnEntryUnlockRequestErrorTopicParams {
+    id: string;
+    type: IRecordLockingLockRecordEntryType;
+    error: CmsError;
+}
+export interface IRecordLocking {
+    onEntryBeforeLock: Topic<OnEntryBeforeLockTopicParams>;
+    onEntryAfterLock: Topic<OnEntryAfterLockTopicParams>;
+    onEntryLockError: Topic<OnEntryLockErrorTopicParams>;
+    onEntryBeforeUnlock: Topic<OnEntryBeforeUnlockTopicParams>;
+    onEntryAfterUnlock: Topic<OnEntryAfterUnlockTopicParams>;
+    onEntryUnlockError: Topic<OnEntryUnlockErrorTopicParams>;
+    onEntryBeforeUnlockRequest: Topic<OnEntryBeforeUnlockRequestTopicParams>;
+    onEntryAfterUnlockRequest: Topic<OnEntryAfterUnlockRequestTopicParams>;
+    onEntryUnlockRequestError: Topic<OnEntryUnlockRequestErrorTopicParams>;
+    getModel(): Promise<CmsModel>;
+    listAllLockRecords(params?: IRecordLockingListAllLockRecordsParams): Promise<IRecordLockingListAllLockRecordsResponse>;
+    /**
+     * Same call as listAllLockRecords, except this one will filter out records with expired lock.
+     */
+    listLockRecords(params?: IRecordLockingListLockRecordsParams): Promise<IRecordLockingListLockRecordsResponse>;
+    getLockRecord(params: IRecordLockingGetLockRecordParams): Promise<IRecordLockingLockRecord | null>;
+    isEntryLocked(params: IRecordLockingIsLockedParams): Promise<boolean>;
+    getLockedEntryLockRecord(params: IRecordLockingGetLockedEntryLockRecordParams): Promise<IRecordLockingLockRecord | null>;
+    lockEntry(params: IRecordLockingLockEntryParams): Promise<IRecordLockingLockRecord>;
+    updateEntryLock(params: IRecordLockingUpdateEntryLockParams): Promise<IRecordLockingLockRecord>;
+    unlockEntry(params: IRecordLockingUnlockEntryParams): Promise<IRecordLockingLockRecord>;
+    unlockEntryRequest(params: IRecordLockingUnlockEntryRequestParams): Promise<IRecordLockingLockRecord>;
+}
+export interface Context extends CmsContext, IWebsocketsContext {
+    recordLocking: IRecordLocking;
+}

package/types.js

@@ -0,0 +1,30 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "CmsEntry", {
+  enumerable: true,
+  get: function () {
+    return _types.CmsEntry;
+  }
+});
+Object.defineProperty(exports, "CmsError", {
+  enumerable: true,
+  get: function () {
+    return _types.CmsError;
+  }
+});
+exports.IRecordLockingLockRecordActionType = void 0;
+var _types = require("@webiny/api-headless-cms/types");
+let IRecordLockingLockRecordActionType = exports.IRecordLockingLockRecordActionType = /*#__PURE__*/function (IRecordLockingLockRecordActionType) {
+  IRecordLockingLockRecordActionType["requested"] = "requested";
+  IRecordLockingLockRecordActionType["approved"] = "approved";
+  IRecordLockingLockRecordActionType["denied"] = "denied";
+  return IRecordLockingLockRecordActionType;
+}({});
+/**
+ * Do not use any special chars other than #, as we use this to create lock record IDs.
+ */
+
+//# sourceMappingURL=types.js.map