@webiny/api-record-locking 6.0.0-beta.0 → 6.0.0-rc.0

package/graphql/schema.js.map

@@ -1 +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":[]}
+{"version":3,"names":["resolve","resolveList","createGraphQLSchemaPlugin","renderFields","renderListFilterFields","renderSortEnum","checkPermissions","IsEntryLockedUseCase","GetLockRecordUseCase","GetLockedEntryLockRecordUseCase","ListLockRecordsUseCase","ListAllLockRecordsUseCase","LockEntryUseCase","UpdateEntryLockUseCase","UnlockEntryUseCase","UnlockEntryRequestUseCase","createGraphQLSchema","params","model","models","filter","fields","length","fieldTypePlugins","recordLockingFields","type","listFilterFieldsRender","excludeFields","sortEnumRender","sorterPlugins","plugin","typeDefs","map","f","join","allFiltersAsString","resolvers","Query","recordLocking","Mutation","RecordLockingQuery","isEntryLocked","_","args","context","useCase","container","result","execute","id","isFail","error","value","getLockRecord","getLockedEntryLockRecord","listLockRecords","listAllLockRecords","RecordLockingMutation","lockEntry","updateEntryLock","unlockEntry","force","unlockEntryRequest","name"],"sources":["schema.ts"],"sourcesContent":["import { resolve, resolveList } from \"./resolve.js\";\nimport type { IGraphQLSchemaPlugin } from \"@webiny/handler-graphql\";\nimport { createGraphQLSchemaPlugin } from \"@webiny/handler-graphql\";\nimport { renderFields } from \"@webiny/api-headless-cms/utils/renderFields.js\";\nimport { renderListFilterFields } from \"@webiny/api-headless-cms/utils/renderListFilterFields.js\";\nimport { renderSortEnum } from \"@webiny/api-headless-cms/utils/renderSortEnum.js\";\nimport { checkPermissions } from \"./checkPermissions.js\";\nimport { IsEntryLockedUseCase } from \"~/features/IsEntryLocked/abstractions.js\";\nimport { GetLockRecordUseCase } from \"~/features/GetLockRecord/abstractions.js\";\nimport { GetLockedEntryLockRecordUseCase } from \"~/features/GetLockedEntryLockRecord/abstractions.js\";\nimport { ListLockRecordsUseCase } from \"~/features/ListLockRecords/abstractions.js\";\nimport { ListAllLockRecordsUseCase } from \"~/features/ListAllLockRecords/abstractions.js\";\nimport { LockEntryUseCase } from \"~/features/LockEntry/abstractions.js\";\nimport { UpdateEntryLockUseCase } from \"~/features/UpdateEntryLock/abstractions.js\";\nimport { UnlockEntryUseCase } from \"~/features/UnlockEntry/abstractions.js\";\nimport { UnlockEntryRequestUseCase } from \"~/features/UnlockEntryRequest/abstractions.js\";\nimport type { ApiCoreContext } from \"@webiny/api-core/types/core.js\";\nimport { CmsModel } from \"@webiny/api-headless-cms/types/model.js\";\nimport type { CmsFieldTypePlugins } from \"@webiny/api-headless-cms/types/index.js\";\n\ninterface Params {\n    // Record locking model\n    model: CmsModel;\n    // All public models\n    models: CmsModel[];\n    fieldTypePlugins: CmsFieldTypePlugins;\n}\nexport const createGraphQLSchema = async (\n    params: Params\n): Promise<IGraphQLSchemaPlugin<ApiCoreContext>> => {\n    // Record locking model\n    const model = params.model;\n\n    // Other public models that have at least one field\n    const models = params.models.filter(model => {\n        return model.fields.length > 0;\n    });\n\n    const fieldTypePlugins = params.fieldTypePlugins;\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<ApiCoreContext>({\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.allFiltersAsString()}\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                        const useCase = context.container.resolve(IsEntryLockedUseCase);\n                        const result = await useCase.execute({\n                            id: args.id,\n                            type: args.type\n                        });\n                        if (result.isFail()) {\n                            throw result.error;\n                        }\n                        return result.value;\n                    });\n                },\n                async getLockRecord(_, args, context) {\n                    return resolve(async () => {\n                        await checkPermissions(context);\n                        const useCase = context.container.resolve(GetLockRecordUseCase);\n                        const result = await useCase.execute({\n                            id: args.id,\n                            type: args.type\n                        });\n                        if (result.isFail()) {\n                            throw result.error;\n                        }\n                        return result.value;\n                    });\n                },\n                async getLockedEntryLockRecord(_, args, context) {\n                    return resolve(async () => {\n                        await checkPermissions(context);\n                        const useCase = context.container.resolve(GetLockedEntryLockRecordUseCase);\n                        const result = await useCase.execute({\n                            id: args.id,\n                            type: args.type\n                        });\n                        // Returns null if not found/expired/locked by current user\n                        if (result.isFail()) {\n                            return null;\n                        }\n                        return result.value;\n                    });\n                },\n\n                async listLockRecords(_, args, context) {\n                    return resolveList(async () => {\n                        await checkPermissions(context);\n                        const useCase = context.container.resolve(ListLockRecordsUseCase);\n                        const result = await useCase.execute(args);\n                        if (result.isFail()) {\n                            throw result.error;\n                        }\n                        return result.value;\n                    });\n                },\n                listAllLockRecords(_, args, context) {\n                    return resolveList(async () => {\n                        await checkPermissions(context);\n                        const useCase = context.container.resolve(ListAllLockRecordsUseCase);\n                        const result = await useCase.execute(args);\n                        if (result.isFail()) {\n                            throw result.error;\n                        }\n                        return result.value;\n                    });\n                }\n            },\n            RecordLockingMutation: {\n                async lockEntry(_, args, context) {\n                    return resolve(async () => {\n                        await checkPermissions(context);\n                        const useCase = context.container.resolve(LockEntryUseCase);\n                        const result = await useCase.execute({\n                            id: args.id,\n                            type: args.type\n                        });\n                        if (result.isFail()) {\n                            throw result.error;\n                        }\n                        return result.value;\n                    });\n                },\n                async updateEntryLock(_, args, context) {\n                    return resolve(async () => {\n                        await checkPermissions(context);\n                        const useCase = context.container.resolve(UpdateEntryLockUseCase);\n                        const result = await useCase.execute({\n                            id: args.id,\n                            type: args.type\n                        });\n                        if (result.isFail()) {\n                            throw result.error;\n                        }\n                        return result.value;\n                    });\n                },\n                async unlockEntry(_, args, context) {\n                    return resolve(async () => {\n                        await checkPermissions(context);\n                        const useCase = context.container.resolve(UnlockEntryUseCase);\n                        const result = await useCase.execute({\n                            id: args.id,\n                            type: args.type,\n                            force: args.force\n                        });\n                        if (result.isFail()) {\n                            throw result.error;\n                        }\n                        return result.value;\n                    });\n                },\n                async unlockEntryRequest(_, args, context) {\n                    return resolve(async () => {\n                        await checkPermissions(context);\n                        const useCase = context.container.resolve(UnlockEntryRequestUseCase);\n                        const result = await useCase.execute({\n                            id: args.id,\n                            type: args.type\n                        });\n                        if (result.isFail()) {\n                            throw result.error;\n                        }\n                        return result.value;\n                    });\n                }\n            }\n        }\n    });\n\n    plugin.name = \"recordLocking.graphql.schema.locking\";\n\n    return plugin;\n};\n"],"mappings":"AAAA,SAASA,OAAO,EAAEC,WAAW;AAE7B,SAASC,yBAAyB,QAAQ,yBAAyB;AACnE,SAASC,YAAY,QAAQ,gDAAgD;AAC7E,SAASC,sBAAsB,QAAQ,0DAA0D;AACjG,SAASC,cAAc,QAAQ,kDAAkD;AACjF,SAASC,gBAAgB;AACzB,SAASC,oBAAoB;AAC7B,SAASC,oBAAoB;AAC7B,SAASC,+BAA+B;AACxC,SAASC,sBAAsB;AAC/B,SAASC,yBAAyB;AAClC,SAASC,gBAAgB;AACzB,SAASC,sBAAsB;AAC/B,SAASC,kBAAkB;AAC3B,SAASC,yBAAyB;AAYlC,OAAO,MAAMC,mBAAmB,GAAG,MAC/BC,MAAc,IACkC;EAChD;EACA,MAAMC,KAAK,GAAGD,MAAM,CAACC,KAAK;;EAE1B;EACA,MAAMC,MAAM,GAAGF,MAAM,CAACE,MAAM,CAACC,MAAM,CAACF,KAAK,IAAI;IACzC,OAAOA,KAAK,CAACG,MAAM,CAACC,MAAM,GAAG,CAAC;EAClC,CAAC,CAAC;EAEF,MAAMC,gBAAgB,GAAGN,MAAM,CAACM,gBAAgB;EAEhD,MAAMC,mBAAmB,GAAGrB,YAAY,CAAC;IACrCgB,MAAM;IACND,KAAK;IACLG,MAAM,EAAEH,KAAK,CAACG,MAAM;IACpBI,IAAI,EAAE,QAAQ;IACdF;EACJ,CAAC,CAAC;EAEF,MAAMG,sBAAsB,GAAGtB,sBAAsB,CAAC;IAClDc,KAAK;IACLG,MAAM,EAAEH,KAAK,CAACG,MAAM;IACpBI,IAAI,EAAE,QAAQ;IACdF,gBAAgB;IAChBI,aAAa,EAAE,CAAC,SAAS;EAC7B,CAAC,CAAC;EAEF,MAAMC,cAAc,GAAGvB,cAAc,CAAC;IAClCa,KAAK;IACLG,MAAM,EAAEH,KAAK,CAACG,MAAM;IACpBE,gBAAgB;IAChBM,aAAa,EAAE;EACnB,CAAC,CAAC;EAEF,MAAMC,MAAM,GAAG5B,yBAAyB,CAAiB;IACrD6B,QAAQ,EAAE,aAAc;AAChC,cAAcP,mBAAmB,CAACQ,GAAG,CAACC,CAAC,IAAIA,CAAC,CAACF,QAAQ,CAAC,CAACG,IAAI,CAAC,IAAI,CAAC;AACjE;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,kBAAkBV,mBAAmB,CAACQ,GAAG,CAACC,CAAC,IAAIA,CAAC,CAACZ,MAAM,CAAC,CAACa,IAAI,CAAC,IAAI,CAAC;AACnE;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,kBAAkBR,sBAAsB,CAACS,kBAAkB,CAAC,CAAC;AAC7D;AACA;AACA;AACA,kBAAkBP,cAAc;AAChC;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;IACDQ,SAAS,EAAE;MACPC,KAAK,EAAE;QACHC,aAAa,EAAE,MAAAA,CAAA,MAAa,CAAC,CAAC;MAClC,CAAC;MACDC,QAAQ,EAAE;QACND,aAAa,EAAE,MAAAA,CAAA,MAAa,CAAC,CAAC;MAClC,CAAC;MACDE,kBAAkB,EAAE;QAChB,MAAMC,aAAaA,CAACC,CAAC,EAAEC,IAAI,EAAEC,OAAO,EAAE;UAClC,OAAO5C,OAAO,CAAC,YAAY;YACvB,MAAMM,gBAAgB,CAACsC,OAAO,CAAC;YAC/B,MAAMC,OAAO,GAAGD,OAAO,CAACE,SAAS,CAAC9C,OAAO,CAACO,oBAAoB,CAAC;YAC/D,MAAMwC,MAAM,GAAG,MAAMF,OAAO,CAACG,OAAO,CAAC;cACjCC,EAAE,EAAEN,IAAI,CAACM,EAAE;cACXxB,IAAI,EAAEkB,IAAI,CAAClB;YACf,CAAC,CAAC;YACF,IAAIsB,MAAM,CAACG,MAAM,CAAC,CAAC,EAAE;cACjB,MAAMH,MAAM,CAACI,KAAK;YACtB;YACA,OAAOJ,MAAM,CAACK,KAAK;UACvB,CAAC,CAAC;QACN,CAAC;QACD,MAAMC,aAAaA,CAACX,CAAC,EAAEC,IAAI,EAAEC,OAAO,EAAE;UAClC,OAAO5C,OAAO,CAAC,YAAY;YACvB,MAAMM,gBAAgB,CAACsC,OAAO,CAAC;YAC/B,MAAMC,OAAO,GAAGD,OAAO,CAACE,SAAS,CAAC9C,OAAO,CAACQ,oBAAoB,CAAC;YAC/D,MAAMuC,MAAM,GAAG,MAAMF,OAAO,CAACG,OAAO,CAAC;cACjCC,EAAE,EAAEN,IAAI,CAACM,EAAE;cACXxB,IAAI,EAAEkB,IAAI,CAAClB;YACf,CAAC,CAAC;YACF,IAAIsB,MAAM,CAACG,MAAM,CAAC,CAAC,EAAE;cACjB,MAAMH,MAAM,CAACI,KAAK;YACtB;YACA,OAAOJ,MAAM,CAACK,KAAK;UACvB,CAAC,CAAC;QACN,CAAC;QACD,MAAME,wBAAwBA,CAACZ,CAAC,EAAEC,IAAI,EAAEC,OAAO,EAAE;UAC7C,OAAO5C,OAAO,CAAC,YAAY;YACvB,MAAMM,gBAAgB,CAACsC,OAAO,CAAC;YAC/B,MAAMC,OAAO,GAAGD,OAAO,CAACE,SAAS,CAAC9C,OAAO,CAACS,+BAA+B,CAAC;YAC1E,MAAMsC,MAAM,GAAG,MAAMF,OAAO,CAACG,OAAO,CAAC;cACjCC,EAAE,EAAEN,IAAI,CAACM,EAAE;cACXxB,IAAI,EAAEkB,IAAI,CAAClB;YACf,CAAC,CAAC;YACF;YACA,IAAIsB,MAAM,CAACG,MAAM,CAAC,CAAC,EAAE;cACjB,OAAO,IAAI;YACf;YACA,OAAOH,MAAM,CAACK,KAAK;UACvB,CAAC,CAAC;QACN,CAAC;QAED,MAAMG,eAAeA,CAACb,CAAC,EAAEC,IAAI,EAAEC,OAAO,EAAE;UACpC,OAAO3C,WAAW,CAAC,YAAY;YAC3B,MAAMK,gBAAgB,CAACsC,OAAO,CAAC;YAC/B,MAAMC,OAAO,GAAGD,OAAO,CAACE,SAAS,CAAC9C,OAAO,CAACU,sBAAsB,CAAC;YACjE,MAAMqC,MAAM,GAAG,MAAMF,OAAO,CAACG,OAAO,CAACL,IAAI,CAAC;YAC1C,IAAII,MAAM,CAACG,MAAM,CAAC,CAAC,EAAE;cACjB,MAAMH,MAAM,CAACI,KAAK;YACtB;YACA,OAAOJ,MAAM,CAACK,KAAK;UACvB,CAAC,CAAC;QACN,CAAC;QACDI,kBAAkBA,CAACd,CAAC,EAAEC,IAAI,EAAEC,OAAO,EAAE;UACjC,OAAO3C,WAAW,CAAC,YAAY;YAC3B,MAAMK,gBAAgB,CAACsC,OAAO,CAAC;YAC/B,MAAMC,OAAO,GAAGD,OAAO,CAACE,SAAS,CAAC9C,OAAO,CAACW,yBAAyB,CAAC;YACpE,MAAMoC,MAAM,GAAG,MAAMF,OAAO,CAACG,OAAO,CAACL,IAAI,CAAC;YAC1C,IAAII,MAAM,CAACG,MAAM,CAAC,CAAC,EAAE;cACjB,MAAMH,MAAM,CAACI,KAAK;YACtB;YACA,OAAOJ,MAAM,CAACK,KAAK;UACvB,CAAC,CAAC;QACN;MACJ,CAAC;MACDK,qBAAqB,EAAE;QACnB,MAAMC,SAASA,CAAChB,CAAC,EAAEC,IAAI,EAAEC,OAAO,EAAE;UAC9B,OAAO5C,OAAO,CAAC,YAAY;YACvB,MAAMM,gBAAgB,CAACsC,OAAO,CAAC;YAC/B,MAAMC,OAAO,GAAGD,OAAO,CAACE,SAAS,CAAC9C,OAAO,CAACY,gBAAgB,CAAC;YAC3D,MAAMmC,MAAM,GAAG,MAAMF,OAAO,CAACG,OAAO,CAAC;cACjCC,EAAE,EAAEN,IAAI,CAACM,EAAE;cACXxB,IAAI,EAAEkB,IAAI,CAAClB;YACf,CAAC,CAAC;YACF,IAAIsB,MAAM,CAACG,MAAM,CAAC,CAAC,EAAE;cACjB,MAAMH,MAAM,CAACI,KAAK;YACtB;YACA,OAAOJ,MAAM,CAACK,KAAK;UACvB,CAAC,CAAC;QACN,CAAC;QACD,MAAMO,eAAeA,CAACjB,CAAC,EAAEC,IAAI,EAAEC,OAAO,EAAE;UACpC,OAAO5C,OAAO,CAAC,YAAY;YACvB,MAAMM,gBAAgB,CAACsC,OAAO,CAAC;YAC/B,MAAMC,OAAO,GAAGD,OAAO,CAACE,SAAS,CAAC9C,OAAO,CAACa,sBAAsB,CAAC;YACjE,MAAMkC,MAAM,GAAG,MAAMF,OAAO,CAACG,OAAO,CAAC;cACjCC,EAAE,EAAEN,IAAI,CAACM,EAAE;cACXxB,IAAI,EAAEkB,IAAI,CAAClB;YACf,CAAC,CAAC;YACF,IAAIsB,MAAM,CAACG,MAAM,CAAC,CAAC,EAAE;cACjB,MAAMH,MAAM,CAACI,KAAK;YACtB;YACA,OAAOJ,MAAM,CAACK,KAAK;UACvB,CAAC,CAAC;QACN,CAAC;QACD,MAAMQ,WAAWA,CAAClB,CAAC,EAAEC,IAAI,EAAEC,OAAO,EAAE;UAChC,OAAO5C,OAAO,CAAC,YAAY;YACvB,MAAMM,gBAAgB,CAACsC,OAAO,CAAC;YAC/B,MAAMC,OAAO,GAAGD,OAAO,CAACE,SAAS,CAAC9C,OAAO,CAACc,kBAAkB,CAAC;YAC7D,MAAMiC,MAAM,GAAG,MAAMF,OAAO,CAACG,OAAO,CAAC;cACjCC,EAAE,EAAEN,IAAI,CAACM,EAAE;cACXxB,IAAI,EAAEkB,IAAI,CAAClB,IAAI;cACfoC,KAAK,EAAElB,IAAI,CAACkB;YAChB,CAAC,CAAC;YACF,IAAId,MAAM,CAACG,MAAM,CAAC,CAAC,EAAE;cACjB,MAAMH,MAAM,CAACI,KAAK;YACtB;YACA,OAAOJ,MAAM,CAACK,KAAK;UACvB,CAAC,CAAC;QACN,CAAC;QACD,MAAMU,kBAAkBA,CAACpB,CAAC,EAAEC,IAAI,EAAEC,OAAO,EAAE;UACvC,OAAO5C,OAAO,CAAC,YAAY;YACvB,MAAMM,gBAAgB,CAACsC,OAAO,CAAC;YAC/B,MAAMC,OAAO,GAAGD,OAAO,CAACE,SAAS,CAAC9C,OAAO,CAACe,yBAAyB,CAAC;YACpE,MAAMgC,MAAM,GAAG,MAAMF,OAAO,CAACG,OAAO,CAAC;cACjCC,EAAE,EAAEN,IAAI,CAACM,EAAE;cACXxB,IAAI,EAAEkB,IAAI,CAAClB;YACf,CAAC,CAAC;YACF,IAAIsB,MAAM,CAACG,MAAM,CAAC,CAAC,EAAE;cACjB,MAAMH,MAAM,CAACI,KAAK;YACtB;YACA,OAAOJ,MAAM,CAACK,KAAK;UACvB,CAAC,CAAC;QACN;MACJ;IACJ;EACJ,CAAC,CAAC;EAEFtB,MAAM,CAACiC,IAAI,GAAG,sCAAsC;EAEpD,OAAOjC,MAAM;AACjB,CAAC","ignoreList":[]}

package/index.d.ts

@@ -1,3 +1,9 @@
+import type { ApiCoreContext } from "@webiny/api-core/types/core.js";
 import { ContextPlugin } from "@webiny/api";
-import { Context } from "./types";
-export declare const createRecordLocking: () => ContextPlugin<Context>[];
+export interface ICreateContextPluginParams {
+    /**
+     * A number of seconds after the last activity to wait before the record is automatically unlocked.
+     */
+    timeout?: number;
+}
+export declare const createRecordLocking: (params?: ICreateContextPluginParams) => ContextPlugin<ApiCoreContext>[];

package/index.js

@@ -1,38 +1,62 @@
-"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) {
+import { ContextPlugin } from "@webiny/api";
+import { WcpContext } from "@webiny/api-core/features/wcp/WcpContext/index.js";
+import { ListModelsUseCase } from "@webiny/api-headless-cms/features/contentModel/ListModels";
+import { GetModelUseCase } from "@webiny/api-headless-cms/features/contentModel/GetModel";
+import { RecordLockingModel, RECORD_LOCKING_MODEL_ID } from "./domain/RecordLockingModel.js";
+import { getTimeout } from "./utils/getTimeout.js";
+import { RecordLockingFeature } from "./features/RecordLockingFeature.js";
+import { createGraphQLSchema } from "./graphql/schema.js";
+import { createFieldTypePluginRecords } from "@webiny/api-headless-cms/graphql/schema/createFieldTypePluginRecords.js";
+import { IdentityContext } from "@webiny/api-core/features/security/IdentityContext/index.js";
+import { TenantContext } from "@webiny/api-core/features/tenancy/TenantContext/index.js";
+const createContextPlugin = params => {
+  const plugin = new ContextPlugin(async context => {
+    const tenantContext = context.container.resolve(TenantContext);
+    const identityContext = context.container.resolve(IdentityContext);
+    const wcp = context.container.resolve(WcpContext);
+    const getModel = context.container.resolve(GetModelUseCase);
+    const listModels = context.container.resolve(ListModelsUseCase);
+    if (!wcp.canUseRecordLocking() || !tenantContext.getTenant()) {
       return;
     }
-    context.plugins.register((0, _model.createLockingModel)());
-    context.recordLocking = await (0, _crud.createRecordLockingCrud)({
-      context
+
+    // Register the private model
+    context.container.register(RecordLockingModel);
+
+    // Determine timeout value
+    const timeout = getTimeout(params?.timeout);
+
+    // Fetch CMS model to use for storing record locking data
+    const [model, publicModels] = await identityContext.withoutAuthorization(async () => {
+      const [model, publicModels] = await Promise.all([
+      // Get a record locking model
+      getModel.execute(RECORD_LOCKING_MODEL_ID),
+      // Get all models
+      listModels.execute({
+        includePrivate: false
+      })]);
+      return [model.value, publicModels.value];
     });
-    const graphQlPlugin = await (0, _schema.createGraphQLSchema)({
-      context
+
+    // Register GraphQL schema plugin
+    const graphQlPlugin = await createGraphQLSchema({
+      model,
+      models: publicModels,
+      fieldTypePlugins: createFieldTypePluginRecords(context.plugins)
     });
     context.plugins.register(graphQlPlugin);
+
+    // Register features
+    RecordLockingFeature.register(context.container, {
+      timeout,
+      model
+    });
   });
   plugin.name = "context.recordLocking";
   return plugin;
 };
-const createRecordLocking = () => {
-  return [createContextPlugin()];
+export const createRecordLocking = params => {
+  return [createContextPlugin(params)];
 };
-exports.createRecordLocking = createRecordLocking;
 
 //# sourceMappingURL=index.js.map

package/index.js.map

@@ -1 +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":[]}
+{"version":3,"names":["ContextPlugin","WcpContext","ListModelsUseCase","GetModelUseCase","RecordLockingModel","RECORD_LOCKING_MODEL_ID","getTimeout","RecordLockingFeature","createGraphQLSchema","createFieldTypePluginRecords","IdentityContext","TenantContext","createContextPlugin","params","plugin","context","tenantContext","container","resolve","identityContext","wcp","getModel","listModels","canUseRecordLocking","getTenant","register","timeout","model","publicModels","withoutAuthorization","Promise","all","execute","includePrivate","value","graphQlPlugin","models","fieldTypePlugins","plugins","name","createRecordLocking"],"sources":["index.ts"],"sourcesContent":["import type { ApiCoreContext } from \"@webiny/api-core/types/core.js\";\nimport { ContextPlugin } from \"@webiny/api\";\nimport { WcpContext } from \"@webiny/api-core/features/wcp/WcpContext/index.js\";\nimport { ListModelsUseCase } from \"@webiny/api-headless-cms/features/contentModel/ListModels\";\nimport { GetModelUseCase } from \"@webiny/api-headless-cms/features/contentModel/GetModel\";\nimport { RecordLockingModel, RECORD_LOCKING_MODEL_ID } from \"~/domain/RecordLockingModel.js\";\nimport { getTimeout } from \"~/utils/getTimeout.js\";\nimport { RecordLockingFeature } from \"~/features/RecordLockingFeature.js\";\nimport { createGraphQLSchema } from \"~/graphql/schema.js\";\nimport { createFieldTypePluginRecords } from \"@webiny/api-headless-cms/graphql/schema/createFieldTypePluginRecords.js\";\nimport { IdentityContext } from \"@webiny/api-core/features/security/IdentityContext/index.js\";\nimport { TenantContext } from \"@webiny/api-core/features/tenancy/TenantContext/index.js\";\n\nexport interface ICreateContextPluginParams {\n    /**\n     * A number of seconds after the last activity to wait before the record is automatically unlocked.\n     */\n    timeout?: number;\n}\n\nconst createContextPlugin = (params?: ICreateContextPluginParams) => {\n    const plugin = new ContextPlugin<ApiCoreContext>(async context => {\n        const tenantContext = context.container.resolve(TenantContext);\n        const identityContext = context.container.resolve(IdentityContext);\n        const wcp = context.container.resolve(WcpContext);\n        const getModel = context.container.resolve(GetModelUseCase);\n        const listModels = context.container.resolve(ListModelsUseCase);\n\n        if (!wcp.canUseRecordLocking() || !tenantContext.getTenant()) {\n            return;\n        }\n\n        // Register the private model\n        context.container.register(RecordLockingModel);\n\n        // Determine timeout value\n        const timeout = getTimeout(params?.timeout);\n\n        // Fetch CMS model to use for storing record locking data\n        const [model, publicModels] = await identityContext.withoutAuthorization(async () => {\n            const [model, publicModels] = await Promise.all([\n                // Get a record locking model\n                getModel.execute(RECORD_LOCKING_MODEL_ID),\n                // Get all models\n                listModels.execute({ includePrivate: false })\n            ]);\n\n            return [model.value, publicModels.value];\n        });\n\n        // Register GraphQL schema plugin\n        const graphQlPlugin = await createGraphQLSchema({\n            model,\n            models: publicModels,\n            fieldTypePlugins: createFieldTypePluginRecords(context.plugins)\n        });\n\n        context.plugins.register(graphQlPlugin);\n\n        // Register features\n        RecordLockingFeature.register(context.container, {\n            timeout,\n            model\n        });\n    });\n    plugin.name = \"context.recordLocking\";\n\n    return plugin;\n};\n\nexport const createRecordLocking = (params?: ICreateContextPluginParams) => {\n    return [createContextPlugin(params)];\n};\n"],"mappings":"AACA,SAASA,aAAa,QAAQ,aAAa;AAC3C,SAASC,UAAU,QAAQ,mDAAmD;AAC9E,SAASC,iBAAiB,QAAQ,2DAA2D;AAC7F,SAASC,eAAe,QAAQ,yDAAyD;AACzF,SAASC,kBAAkB,EAAEC,uBAAuB;AACpD,SAASC,UAAU;AACnB,SAASC,oBAAoB;AAC7B,SAASC,mBAAmB;AAC5B,SAASC,4BAA4B,QAAQ,yEAAyE;AACtH,SAASC,eAAe,QAAQ,6DAA6D;AAC7F,SAASC,aAAa,QAAQ,0DAA0D;AASxF,MAAMC,mBAAmB,GAAIC,MAAmC,IAAK;EACjE,MAAMC,MAAM,GAAG,IAAId,aAAa,CAAiB,MAAMe,OAAO,IAAI;IAC9D,MAAMC,aAAa,GAAGD,OAAO,CAACE,SAAS,CAACC,OAAO,CAACP,aAAa,CAAC;IAC9D,MAAMQ,eAAe,GAAGJ,OAAO,CAACE,SAAS,CAACC,OAAO,CAACR,eAAe,CAAC;IAClE,MAAMU,GAAG,GAAGL,OAAO,CAACE,SAAS,CAACC,OAAO,CAACjB,UAAU,CAAC;IACjD,MAAMoB,QAAQ,GAAGN,OAAO,CAACE,SAAS,CAACC,OAAO,CAACf,eAAe,CAAC;IAC3D,MAAMmB,UAAU,GAAGP,OAAO,CAACE,SAAS,CAACC,OAAO,CAAChB,iBAAiB,CAAC;IAE/D,IAAI,CAACkB,GAAG,CAACG,mBAAmB,CAAC,CAAC,IAAI,CAACP,aAAa,CAACQ,SAAS,CAAC,CAAC,EAAE;MAC1D;IACJ;;IAEA;IACAT,OAAO,CAACE,SAAS,CAACQ,QAAQ,CAACrB,kBAAkB,CAAC;;IAE9C;IACA,MAAMsB,OAAO,GAAGpB,UAAU,CAACO,MAAM,EAAEa,OAAO,CAAC;;IAE3C;IACA,MAAM,CAACC,KAAK,EAAEC,YAAY,CAAC,GAAG,MAAMT,eAAe,CAACU,oBAAoB,CAAC,YAAY;MACjF,MAAM,CAACF,KAAK,EAAEC,YAAY,CAAC,GAAG,MAAME,OAAO,CAACC,GAAG,CAAC;MAC5C;MACAV,QAAQ,CAACW,OAAO,CAAC3B,uBAAuB,CAAC;MACzC;MACAiB,UAAU,CAACU,OAAO,CAAC;QAAEC,cAAc,EAAE;MAAM,CAAC,CAAC,CAChD,CAAC;MAEF,OAAO,CAACN,KAAK,CAACO,KAAK,EAAEN,YAAY,CAACM,KAAK,CAAC;IAC5C,CAAC,CAAC;;IAEF;IACA,MAAMC,aAAa,GAAG,MAAM3B,mBAAmB,CAAC;MAC5CmB,KAAK;MACLS,MAAM,EAAER,YAAY;MACpBS,gBAAgB,EAAE5B,4BAA4B,CAACM,OAAO,CAACuB,OAAO;IAClE,CAAC,CAAC;IAEFvB,OAAO,CAACuB,OAAO,CAACb,QAAQ,CAACU,aAAa,CAAC;;IAEvC;IACA5B,oBAAoB,CAACkB,QAAQ,CAACV,OAAO,CAACE,SAAS,EAAE;MAC7CS,OAAO;MACPC;IACJ,CAAC,CAAC;EACN,CAAC,CAAC;EACFb,MAAM,CAACyB,IAAI,GAAG,uBAAuB;EAErC,OAAOzB,MAAM;AACjB,CAAC;AAED,OAAO,MAAM0B,mBAAmB,GAAI3B,MAAmC,IAAK;EACxE,OAAO,CAACD,mBAAmB,CAACC,MAAM,CAAC,CAAC;AACxC,CAAC","ignoreList":[]}

package/package.json

@@ -1,6 +1,7 @@
 {
 	"name": "@webiny/api-record-locking",
-	"version": "6.0.0-beta.0",
+	"version": "6.0.0-rc.0",
+	"type": "module",
 	"main": "index.js",
 	"repository": {
 		"type": "git",
@@ -12,53 +13,30 @@
 	],
 	"license": "MIT",
 	"dependencies": {
-		"@babel/runtime": "7.24.1",
-		"@types/aws-lambda": "8.10.136",
-		"@webiny/api": "6.0.0-beta.0",
-		"@webiny/api-headless-cms": "6.0.0-beta.0",
-		"@webiny/api-websockets": "6.0.0-beta.0",
-		"@webiny/error": "6.0.0-beta.0",
-		"@webiny/handler": "6.0.0-beta.0",
-		"@webiny/handler-aws": "6.0.0-beta.0",
-		"@webiny/handler-graphql": "6.0.0-beta.0",
-		"@webiny/plugins": "6.0.0-beta.0",
-		"@webiny/pubsub": "6.0.0-beta.0",
-		"@webiny/utils": "6.0.0-beta.0"
+		"@webiny/api": "6.0.0-rc.0",
+		"@webiny/api-headless-cms": "6.0.0-rc.0",
+		"@webiny/api-websockets": "6.0.0-rc.0",
+		"@webiny/feature": "6.0.0-rc.0",
+		"@webiny/handler": "6.0.0-rc.0",
+		"@webiny/handler-aws": "6.0.0-rc.0",
+		"@webiny/handler-graphql": "6.0.0-rc.0",
+		"@webiny/plugins": "6.0.0-rc.0",
+		"@webiny/utils": "6.0.0-rc.0"
 	},
 	"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": "6.0.0-beta.0",
-		"@webiny/api-security": "6.0.0-beta.0",
-		"@webiny/api-tenancy": "6.0.0-beta.0",
-		"@webiny/api-wcp": "6.0.0-beta.0",
-		"@webiny/cli": "6.0.0-beta.0",
-		"@webiny/project-utils": "6.0.0-beta.0",
-		"graphql": "15.8.0",
-		"rimraf": "5.0.5",
-		"ttypescript": "1.5.15",
-		"type-fest": "2.19.0",
-		"typescript": "4.7.4"
+		"@webiny/api-core": "6.0.0-rc.0",
+		"@webiny/build-tools": "6.0.0-rc.0",
+		"@webiny/project-utils": "6.0.0-rc.0",
+		"@webiny/wcp": "6.0.0-rc.0",
+		"graphql": "16.12.0",
+		"rimraf": "6.1.3",
+		"type-fest": "5.4.4",
+		"typescript": "5.9.3",
+		"vitest": "4.0.18"
 	},
 	"publishConfig": {
 		"access": "public",
 		"directory": "dist"
 	},
-	"scripts": {
-		"build": "yarn webiny run build",
-		"watch": "yarn webiny run watch"
-	},
-	"gitHead": "aa8dbfbbd5ad13ec271adba6f2431e02991a300f",
-	"adio": {
-		"ignore": {
-			"src": [
-				"aws-lambda"
-			],
-			"dependencies": [
-				"@types/aws-lambda"
-			]
-		}
-	}
+	"gitHead": "0f2aa699f4642e550ab62c96fcd050e8d02345c9"
 }

package/types.d.ts

@@ -1,48 +1,32 @@
-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 {
+import type { CmsEntryListParams, CmsEntryMeta, CmsIdentity } from "@webiny/api-headless-cms/types/index.js";
+import { CmsEntry, CmsError } from "@webiny/api-headless-cms/types/index.js";
+export type { CmsError, CmsEntry };
+export type IRecordLockingIdentity = CmsIdentity;
+export type IRecordLockingMeta = CmsEntryMeta;
+export declare enum RecordLockingLockRecordActionType {
     requested = "requested",
     approved = "approved",
     denied = "denied"
 }
 export interface IRecordLockingLockRecordRequestedAction {
-    type: IRecordLockingLockRecordActionType.requested;
+    type: RecordLockingLockRecordActionType.requested;
     message?: string;
     createdOn: Date;
     createdBy: IRecordLockingIdentity;
 }
 export interface IRecordLockingLockRecordApprovedAction {
-    type: IRecordLockingLockRecordActionType.approved;
+    type: RecordLockingLockRecordActionType.approved;
     message?: string;
     createdOn: Date;
     createdBy: IRecordLockingIdentity;
 }
 export interface IRecordLockingLockRecordDeniedAction {
-    type: IRecordLockingLockRecordActionType.denied;
+    type: RecordLockingLockRecordActionType.denied;
     message?: string;
     createdOn: Date;
     createdBy: IRecordLockingIdentity;
 }
-export declare type IRecordLockingLockRecordAction = IRecordLockingLockRecordRequestedAction | IRecordLockingLockRecordApprovedAction | IRecordLockingLockRecordDeniedAction;
+export type IRecordLockingLockRecordAction = IRecordLockingLockRecordRequestedAction | IRecordLockingLockRecordApprovedAction | IRecordLockingLockRecordDeniedAction;
 export interface IRecordLockingLockRecordObject {
     id: string;
     targetId: string;
@@ -59,114 +43,11 @@ export interface IRecordLockingLockRecord extends IRecordLockingLockRecordObject
     getUnlockRequested(): IRecordLockingLockRecordRequestedAction | undefined;
     getUnlockApproved(): IRecordLockingLockRecordApprovedAction | undefined;
     getUnlockDenied(): IRecordLockingLockRecordDeniedAction | undefined;
+    isExpired(): boolean;
 }
 /**
  * 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;
-}
+export type IRecordLockingLockRecordEntryType = string;
+export type IRecordLockingListAllLockRecordsParams = Pick<CmsEntryListParams, "where" | "limit" | "sort" | "after">;
+export type IRecordLockingListLockRecordsParams = IRecordLockingListAllLockRecordsParams;

package/types.js

@@ -1,28 +1,10 @@
-"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;
+export let RecordLockingLockRecordActionType = /*#__PURE__*/function (RecordLockingLockRecordActionType) {
+  RecordLockingLockRecordActionType["requested"] = "requested";
+  RecordLockingLockRecordActionType["approved"] = "approved";
+  RecordLockingLockRecordActionType["denied"] = "denied";
+  return RecordLockingLockRecordActionType;
 }({});
+
 /**
  * Do not use any special chars other than #, as we use this to create lock record IDs.
  */

package/types.js.map

@@ -1 +1 @@
-{"version":3,"names":["_types","require","IRecordLockingLockRecordActionType","exports"],"sources":["types.ts"],"sourcesContent":["import {\n    CmsContext,\n    CmsEntry,\n    CmsEntryListParams,\n    CmsEntryMeta,\n    CmsError,\n    CmsIdentity,\n    CmsModel,\n    CmsModelManager\n} from \"@webiny/api-headless-cms/types\";\nimport { Topic } from \"@webiny/pubsub/types\";\nimport {\n    Context as IWebsocketsContext,\n    IWebsocketsContextObject\n} from \"@webiny/api-websockets/types\";\n\nexport { CmsError, CmsEntry };\n\nexport type IRecordLockingIdentity = CmsIdentity;\n\nexport type IRecordLockingModelManager = CmsModelManager<IRecordLockingLockRecordValues>;\n\nexport type IRecordLockingMeta = CmsEntryMeta;\n\nexport interface IHasFullAccessCallable {\n    (): Promise<boolean>;\n}\n\nexport interface IGetWebsocketsContextCallable {\n    (): IWebsocketsContextObject;\n}\n\nexport interface IGetIdentity {\n    (): IRecordLockingIdentity;\n}\n\nexport interface IRecordLockingLockRecordValues {\n    targetId: string;\n    type: IRecordLockingLockRecordEntryType;\n    actions?: IRecordLockingLockRecordAction[];\n}\nexport enum IRecordLockingLockRecordActionType {\n    requested = \"requested\",\n    approved = \"approved\",\n    denied = \"denied\"\n}\n\nexport interface IRecordLockingLockRecordRequestedAction {\n    type: IRecordLockingLockRecordActionType.requested;\n    message?: string;\n    createdOn: Date;\n    createdBy: IRecordLockingIdentity;\n}\n\nexport interface IRecordLockingLockRecordApprovedAction {\n    type: IRecordLockingLockRecordActionType.approved;\n    message?: string;\n    createdOn: Date;\n    createdBy: IRecordLockingIdentity;\n}\n\nexport interface IRecordLockingLockRecordDeniedAction {\n    type: IRecordLockingLockRecordActionType.denied;\n    message?: string;\n    createdOn: Date;\n    createdBy: IRecordLockingIdentity;\n}\n\nexport type IRecordLockingLockRecordAction =\n    | IRecordLockingLockRecordRequestedAction\n    | IRecordLockingLockRecordApprovedAction\n    | IRecordLockingLockRecordDeniedAction;\n\nexport interface IRecordLockingLockRecordObject {\n    id: string;\n    targetId: string;\n    type: IRecordLockingLockRecordEntryType;\n    lockedBy: IRecordLockingIdentity;\n    lockedOn: Date;\n    updatedOn: Date;\n    expiresOn: Date;\n    actions?: IRecordLockingLockRecordAction[];\n}\n\nexport interface IRecordLockingLockRecord extends IRecordLockingLockRecordObject {\n    toObject(): IRecordLockingLockRecordObject;\n    addAction(action: IRecordLockingLockRecordAction): void;\n    getUnlockRequested(): IRecordLockingLockRecordRequestedAction | undefined;\n    getUnlockApproved(): IRecordLockingLockRecordApprovedAction | undefined;\n    getUnlockDenied(): IRecordLockingLockRecordDeniedAction | undefined;\n}\n\n/**\n * Do not use any special chars other than #, as we use this to create lock record IDs.\n */\nexport type IRecordLockingLockRecordEntryType = string;\n\nexport type IRecordLockingListAllLockRecordsParams = Pick<\n    CmsEntryListParams,\n    \"where\" | \"limit\" | \"sort\" | \"after\"\n>;\n\nexport type IRecordLockingListLockRecordsParams = IRecordLockingListAllLockRecordsParams;\n\nexport interface IRecordLockingListAllLockRecordsResponse {\n    items: IRecordLockingLockRecord[];\n    meta: IRecordLockingMeta;\n}\n\nexport type IRecordLockingListLockRecordsResponse = IRecordLockingListAllLockRecordsResponse;\n\nexport interface IRecordLockingGetLockRecordParams {\n    id: string;\n    type: IRecordLockingLockRecordEntryType;\n}\n\nexport interface IRecordLockingIsLockedParams {\n    id: string;\n    type: IRecordLockingLockRecordEntryType;\n}\n\nexport interface IRecordLockingGetLockedEntryLockRecordParams {\n    id: string;\n    type: IRecordLockingLockRecordEntryType;\n}\n\nexport interface IRecordLockingLockEntryParams {\n    id: string;\n    type: IRecordLockingLockRecordEntryType;\n}\n\nexport interface IRecordLockingUpdateEntryLockParams {\n    id: string;\n    type: IRecordLockingLockRecordEntryType;\n}\n\nexport interface IRecordLockingUnlockEntryParams {\n    id: string;\n    type: IRecordLockingLockRecordEntryType;\n    force?: boolean;\n}\n\nexport interface IRecordLockingUnlockEntryRequestParams {\n    id: string;\n    type: IRecordLockingLockRecordEntryType;\n}\n\nexport interface OnEntryBeforeLockTopicParams {\n    id: string;\n    type: IRecordLockingLockRecordEntryType;\n}\n\nexport interface OnEntryAfterLockTopicParams {\n    id: string;\n    type: IRecordLockingLockRecordEntryType;\n    record: IRecordLockingLockRecord;\n}\n\nexport interface OnEntryLockErrorTopicParams {\n    id: string;\n    type: IRecordLockingLockRecordEntryType;\n    error: CmsError;\n}\n\nexport interface OnEntryBeforeUnlockTopicParams {\n    id: string;\n    type: IRecordLockingLockRecordEntryType;\n    getIdentity: IGetIdentity;\n}\n\nexport interface OnEntryAfterUnlockTopicParams {\n    id: string;\n    type: IRecordLockingLockRecordEntryType;\n    record: IRecordLockingLockRecord;\n}\n\nexport interface OnEntryUnlockErrorTopicParams {\n    id: string;\n    type: IRecordLockingLockRecordEntryType;\n    error: CmsError;\n}\n\nexport interface OnEntryBeforeUnlockRequestTopicParams {\n    id: string;\n    type: IRecordLockingLockRecordEntryType;\n}\n\nexport interface OnEntryAfterUnlockRequestTopicParams {\n    id: string;\n    type: IRecordLockingLockRecordEntryType;\n    record: IRecordLockingLockRecord;\n}\n\nexport interface OnEntryUnlockRequestErrorTopicParams {\n    id: string;\n    type: IRecordLockingLockRecordEntryType;\n    error: CmsError;\n}\n\nexport interface IRecordLocking {\n    onEntryBeforeLock: Topic<OnEntryBeforeLockTopicParams>;\n    onEntryAfterLock: Topic<OnEntryAfterLockTopicParams>;\n    onEntryLockError: Topic<OnEntryLockErrorTopicParams>;\n    onEntryBeforeUnlock: Topic<OnEntryBeforeUnlockTopicParams>;\n    onEntryAfterUnlock: Topic<OnEntryAfterUnlockTopicParams>;\n    onEntryUnlockError: Topic<OnEntryUnlockErrorTopicParams>;\n    onEntryBeforeUnlockRequest: Topic<OnEntryBeforeUnlockRequestTopicParams>;\n    onEntryAfterUnlockRequest: Topic<OnEntryAfterUnlockRequestTopicParams>;\n    onEntryUnlockRequestError: Topic<OnEntryUnlockRequestErrorTopicParams>;\n    getModel(): Promise<CmsModel>;\n    listAllLockRecords(\n        params?: IRecordLockingListAllLockRecordsParams\n    ): Promise<IRecordLockingListAllLockRecordsResponse>;\n    /**\n     * Same call as listAllLockRecords, except this one will filter out records with expired lock.\n     */\n    listLockRecords(\n        params?: IRecordLockingListLockRecordsParams\n    ): Promise<IRecordLockingListLockRecordsResponse>;\n    getLockRecord(\n        params: IRecordLockingGetLockRecordParams\n    ): Promise<IRecordLockingLockRecord | null>;\n    isEntryLocked(params: IRecordLockingIsLockedParams): Promise<boolean>;\n    getLockedEntryLockRecord(\n        params: IRecordLockingGetLockedEntryLockRecordParams\n    ): Promise<IRecordLockingLockRecord | null>;\n    lockEntry(params: IRecordLockingLockEntryParams): Promise<IRecordLockingLockRecord>;\n    updateEntryLock(params: IRecordLockingUpdateEntryLockParams): Promise<IRecordLockingLockRecord>;\n    unlockEntry(params: IRecordLockingUnlockEntryParams): Promise<IRecordLockingLockRecord>;\n    unlockEntryRequest(\n        params: IRecordLockingUnlockEntryRequestParams\n    ): Promise<IRecordLockingLockRecord>;\n}\n\nexport interface Context extends CmsContext, IWebsocketsContext {\n    recordLocking: IRecordLocking;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AASwC,IAgC5BC,kCAAkC,GAAAC,OAAA,CAAAD,kCAAA,0BAAlCA,kCAAkC;EAAlCA,kCAAkC;EAAlCA,kCAAkC;EAAlCA,kCAAkC;EAAA,OAAlCA,kCAAkC;AAAA;AAmD9C;AACA;AACA","ignoreList":[]}
+{"version":3,"names":["RecordLockingLockRecordActionType"],"sources":["types.ts"],"sourcesContent":["import type {\n    CmsEntryListParams,\n    CmsEntryMeta,\n    CmsIdentity\n} from \"@webiny/api-headless-cms/types/index.js\";\nimport { CmsEntry, CmsError } from \"@webiny/api-headless-cms/types/index.js\";\n\nexport type { CmsError, CmsEntry };\n\nexport type IRecordLockingIdentity = CmsIdentity;\n\nexport type IRecordLockingMeta = CmsEntryMeta;\n\nexport enum RecordLockingLockRecordActionType {\n    requested = \"requested\",\n    approved = \"approved\",\n    denied = \"denied\"\n}\n\nexport interface IRecordLockingLockRecordRequestedAction {\n    type: RecordLockingLockRecordActionType.requested;\n    message?: string;\n    createdOn: Date;\n    createdBy: IRecordLockingIdentity;\n}\n\nexport interface IRecordLockingLockRecordApprovedAction {\n    type: RecordLockingLockRecordActionType.approved;\n    message?: string;\n    createdOn: Date;\n    createdBy: IRecordLockingIdentity;\n}\n\nexport interface IRecordLockingLockRecordDeniedAction {\n    type: RecordLockingLockRecordActionType.denied;\n    message?: string;\n    createdOn: Date;\n    createdBy: IRecordLockingIdentity;\n}\n\nexport type IRecordLockingLockRecordAction =\n    | IRecordLockingLockRecordRequestedAction\n    | IRecordLockingLockRecordApprovedAction\n    | IRecordLockingLockRecordDeniedAction;\n\nexport interface IRecordLockingLockRecordObject {\n    id: string;\n    targetId: string;\n    type: IRecordLockingLockRecordEntryType;\n    lockedBy: IRecordLockingIdentity;\n    lockedOn: Date;\n    updatedOn: Date;\n    expiresOn: Date;\n    actions?: IRecordLockingLockRecordAction[];\n}\n\nexport interface IRecordLockingLockRecord extends IRecordLockingLockRecordObject {\n    toObject(): IRecordLockingLockRecordObject;\n    addAction(action: IRecordLockingLockRecordAction): void;\n    getUnlockRequested(): IRecordLockingLockRecordRequestedAction | undefined;\n    getUnlockApproved(): IRecordLockingLockRecordApprovedAction | undefined;\n    getUnlockDenied(): IRecordLockingLockRecordDeniedAction | undefined;\n    isExpired(): boolean;\n}\n\n/**\n * Do not use any special chars other than #, as we use this to create lock record IDs.\n */\nexport type IRecordLockingLockRecordEntryType = string;\n\nexport type IRecordLockingListAllLockRecordsParams = Pick<\n    CmsEntryListParams,\n    \"where\" | \"limit\" | \"sort\" | \"after\"\n>;\n\nexport type IRecordLockingListLockRecordsParams = IRecordLockingListAllLockRecordsParams;\n"],"mappings":"AAaA,WAAYA,iCAAiC,0BAAjCA,iCAAiC;EAAjCA,iCAAiC;EAAjCA,iCAAiC;EAAjCA,iCAAiC;EAAA,OAAjCA,iCAAiC;AAAA;;AAoD7C;AACA;AACA","ignoreList":[]}

package/utils/convertWhereCondition.d.ts

@@ -1,4 +1,4 @@
-import { IRecordLockingListLockRecordsParams } from "../types";
-declare type IWhere = IRecordLockingListLockRecordsParams["where"] | undefined;
+import type { IRecordLockingListLockRecordsParams } from "../types.js";
+type IWhere = IRecordLockingListLockRecordsParams["where"] | undefined;
 export declare const convertWhereCondition: (where: IWhere) => IWhere;
 export {};

package/utils/convertWhereCondition.js

@@ -1,19 +1,11 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.convertWhereCondition = void 0;
-var _lockRecordDatabaseId = require("./lockRecordDatabaseId");
+import { createLockRecordDatabaseId } from "./lockRecordDatabaseId.js";
 const attachPrefix = value => {
-  if (!value) {
-    return value;
-  } else if (Array.isArray(value)) {
-    return value.map(_lockRecordDatabaseId.createLockRecordDatabaseId);
+  if (Array.isArray(value)) {
+    return value.map(createLockRecordDatabaseId);
   }
-  return (0, _lockRecordDatabaseId.createLockRecordDatabaseId)(value);
+  return createLockRecordDatabaseId(value);
 };
-const convertWhereCondition = where => {
+export const convertWhereCondition = where => {
   if (!where) {
     return where;
   }
@@ -30,12 +22,17 @@ const convertWhereCondition = where => {
     } else if (key.startsWith("id") === false) {
       continue;
     }
+    const value = where[key];
+    if (!value) {
+      continue;
+    }
     const newKey = key.replace("id", "entryId");
+    // @ts-expect-error
     where[newKey] = attachPrefix(where[key]);
+    // @ts-expect-error
     delete where[key];
   }
   return where;
 };
-exports.convertWhereCondition = convertWhereCondition;
 
 //# sourceMappingURL=convertWhereCondition.js.map

package/utils/convertWhereCondition.js.map

@@ -1 +1 @@
-{"version":3,"names":["_lockRecordDatabaseId","require","attachPrefix","value","Array","isArray","map","createLockRecordDatabaseId","convertWhereCondition","where","key","startsWith","subKey","newKey","replace","exports"],"sources":["convertWhereCondition.ts"],"sourcesContent":["import { IRecordLockingListLockRecordsParams } from \"~/types\";\nimport { createLockRecordDatabaseId } from \"~/utils/lockRecordDatabaseId\";\n\ntype IWhere = IRecordLockingListLockRecordsParams[\"where\"] | undefined;\n\nconst attachPrefix = (value: string | string[] | undefined) => {\n    if (!value) {\n        return value;\n    } else if (Array.isArray(value)) {\n        return value.map(createLockRecordDatabaseId);\n    }\n    return createLockRecordDatabaseId(value);\n};\n\nexport const convertWhereCondition = (where: IWhere): IWhere => {\n    if (!where) {\n        return where;\n    }\n    for (const key in where) {\n        if (key.startsWith(\"AND\") || key.startsWith(\"OR\")) {\n            const value = where[key] as IWhere[] | undefined;\n            if (!value) {\n                continue;\n            }\n            for (const subKey in value) {\n                value[subKey] = convertWhereCondition(value[subKey]);\n            }\n            continue;\n        } else if (key.startsWith(\"id\") === false) {\n            continue;\n        }\n        const newKey = key.replace(\"id\", \"entryId\");\n        where[newKey] = attachPrefix(where[key] as string | string[] | undefined);\n        delete where[key];\n    }\n    return where;\n};\n"],"mappings":";;;;;;AACA,IAAAA,qBAAA,GAAAC,OAAA;AAIA,MAAMC,YAAY,GAAIC,KAAoC,IAAK;EAC3D,IAAI,CAACA,KAAK,EAAE;IACR,OAAOA,KAAK;EAChB,CAAC,MAAM,IAAIC,KAAK,CAACC,OAAO,CAACF,KAAK,CAAC,EAAE;IAC7B,OAAOA,KAAK,CAACG,GAAG,CAACC,gDAA0B,CAAC;EAChD;EACA,OAAO,IAAAA,gDAA0B,EAACJ,KAAK,CAAC;AAC5C,CAAC;AAEM,MAAMK,qBAAqB,GAAIC,KAAa,IAAa;EAC5D,IAAI,CAACA,KAAK,EAAE;IACR,OAAOA,KAAK;EAChB;EACA,KAAK,MAAMC,GAAG,IAAID,KAAK,EAAE;IACrB,IAAIC,GAAG,CAACC,UAAU,CAAC,KAAK,CAAC,IAAID,GAAG,CAACC,UAAU,CAAC,IAAI,CAAC,EAAE;MAC/C,MAAMR,KAAK,GAAGM,KAAK,CAACC,GAAG,CAAyB;MAChD,IAAI,CAACP,KAAK,EAAE;QACR;MACJ;MACA,KAAK,MAAMS,MAAM,IAAIT,KAAK,EAAE;QACxBA,KAAK,CAACS,MAAM,CAAC,GAAGJ,qBAAqB,CAACL,KAAK,CAACS,MAAM,CAAC,CAAC;MACxD;MACA;IACJ,CAAC,MAAM,IAAIF,GAAG,CAACC,UAAU,CAAC,IAAI,CAAC,KAAK,KAAK,EAAE;MACvC;IACJ;IACA,MAAME,MAAM,GAAGH,GAAG,CAACI,OAAO,CAAC,IAAI,EAAE,SAAS,CAAC;IAC3CL,KAAK,CAACI,MAAM,CAAC,GAAGX,YAAY,CAACO,KAAK,CAACC,GAAG,CAAkC,CAAC;IACzE,OAAOD,KAAK,CAACC,GAAG,CAAC;EACrB;EACA,OAAOD,KAAK;AAChB,CAAC;AAACM,OAAA,CAAAP,qBAAA,GAAAA,qBAAA","ignoreList":[]}
+{"version":3,"names":["createLockRecordDatabaseId","attachPrefix","value","Array","isArray","map","convertWhereCondition","where","key","startsWith","subKey","newKey","replace"],"sources":["convertWhereCondition.ts"],"sourcesContent":["import type { IRecordLockingListLockRecordsParams } from \"~/types.js\";\nimport { createLockRecordDatabaseId } from \"~/utils/lockRecordDatabaseId.js\";\n\ntype IWhere = IRecordLockingListLockRecordsParams[\"where\"] | undefined;\n\nconst attachPrefix = (value: string | string[]) => {\n    if (Array.isArray(value)) {\n        return value.map(createLockRecordDatabaseId);\n    }\n    return createLockRecordDatabaseId(value);\n};\n\nexport const convertWhereCondition = (where: IWhere): IWhere => {\n    if (!where) {\n        return where;\n    }\n    for (const key in where) {\n        if (key.startsWith(\"AND\") || key.startsWith(\"OR\")) {\n            const value = where[key as keyof typeof where] as IWhere[] | undefined;\n            if (!value) {\n                continue;\n            }\n            for (const subKey in value) {\n                value[subKey] = convertWhereCondition(value[subKey]);\n            }\n            continue;\n        } else if (key.startsWith(\"id\") === false) {\n            continue;\n        }\n        const value = where[key as keyof typeof where];\n        if (!value) {\n            continue;\n        }\n\n        const newKey = key.replace(\"id\", \"entryId\") as keyof typeof where;\n        // @ts-expect-error\n        where[newKey] = attachPrefix(where[key]);\n        // @ts-expect-error\n        delete where[key];\n    }\n    return where;\n};\n"],"mappings":"AACA,SAASA,0BAA0B;AAInC,MAAMC,YAAY,GAAIC,KAAwB,IAAK;EAC/C,IAAIC,KAAK,CAACC,OAAO,CAACF,KAAK,CAAC,EAAE;IACtB,OAAOA,KAAK,CAACG,GAAG,CAACL,0BAA0B,CAAC;EAChD;EACA,OAAOA,0BAA0B,CAACE,KAAK,CAAC;AAC5C,CAAC;AAED,OAAO,MAAMI,qBAAqB,GAAIC,KAAa,IAAa;EAC5D,IAAI,CAACA,KAAK,EAAE;IACR,OAAOA,KAAK;EAChB;EACA,KAAK,MAAMC,GAAG,IAAID,KAAK,EAAE;IACrB,IAAIC,GAAG,CAACC,UAAU,CAAC,KAAK,CAAC,IAAID,GAAG,CAACC,UAAU,CAAC,IAAI,CAAC,EAAE;MAC/C,MAAMP,KAAK,GAAGK,KAAK,CAACC,GAAG,CAA+C;MACtE,IAAI,CAACN,KAAK,EAAE;QACR;MACJ;MACA,KAAK,MAAMQ,MAAM,IAAIR,KAAK,EAAE;QACxBA,KAAK,CAACQ,MAAM,CAAC,GAAGJ,qBAAqB,CAACJ,KAAK,CAACQ,MAAM,CAAC,CAAC;MACxD;MACA;IACJ,CAAC,MAAM,IAAIF,GAAG,CAACC,UAAU,CAAC,IAAI,CAAC,KAAK,KAAK,EAAE;MACvC;IACJ;IACA,MAAMP,KAAK,GAAGK,KAAK,CAACC,GAAG,CAAuB;IAC9C,IAAI,CAACN,KAAK,EAAE;MACR;IACJ;IAEA,MAAMS,MAAM,GAAGH,GAAG,CAACI,OAAO,CAAC,IAAI,EAAE,SAAS,CAAuB;IACjE;IACAL,KAAK,CAACI,MAAM,CAAC,GAAGV,YAAY,CAACM,KAAK,CAACC,GAAG,CAAC,CAAC;IACxC;IACA,OAAOD,KAAK,CAACC,GAAG,CAAC;EACrB;EACA,OAAOD,KAAK;AAChB,CAAC","ignoreList":[]}

package/utils/getTimeout.d.ts

@@ -1,4 +1,5 @@
 /**
- * In milliseconds.
+ * Input is in seconds.
+ * Output is milliseconds.
  */
-export declare const getTimeout: () => number;
+export declare const getTimeout: (input: number | undefined) => number;