@webiny/app-record-locking 5.43.3 → 6.0.0-alpha.1

package/types.d.ts

@@ -1,7 +1,7 @@
-import { EntryTableItem } from "@webiny/app-headless-cms/types";
-import { GenericRecord } from "@webiny/app/types";
-import { IRecordLockingUnlockEntryResult } from "./domain/abstractions/IRecordLockingUnlockEntry";
-import { SecurityPermission } from "@webiny/app-security/types";
+import type { CmsContentEntry } from "@webiny/app-headless-cms/types";
+import type { GenericRecord } from "@webiny/app/types";
+import type { IRecordLockingUnlockEntryResult } from "./domain/abstractions/IRecordLockingUnlockEntry";
+import type { SecurityPermission } from "@webiny/app-security/types";
 import type { IRecordLockingUpdateEntryLockResult } from "./domain/abstractions/IRecordLocking.js";
 export interface IRecordLockingIdentity {
     id: string;
@@ -14,13 +14,11 @@ export interface IRecordLockingRecordLocked {
     expiresOn: string;
     actions: IRecordLockingLockRecordAction[];
 }
-export interface IPossiblyRecordLockingRecord extends EntryTableItem {
+export interface IPossiblyRecordLockingRecord extends CmsContentEntry {
     $lockingType?: string;
-    entryId: string;
     $locked?: IRecordLockingRecordLocked | null;
 }
 export interface IRecordLockingRecord extends IPossiblyRecordLockingRecord {
-    entryId: string;
     $lockingType: string;
 }
 export type IIsRecordLockedParams = Pick<IRecordLockingRecord, "id" | "$lockingType">;

package/types.js

@@ -1,7 +1,3 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
+export {};
 
 //# sourceMappingURL=types.js.map

package/types.js.map

@@ -1 +1 @@
-{"version":3,"names":[],"sources":["types.ts"],"sourcesContent":["import { EntryTableItem } from \"@webiny/app-headless-cms/types\";\nimport { GenericRecord } from \"@webiny/app/types\";\nimport { IRecordLockingUnlockEntryResult } from \"~/domain/abstractions/IRecordLockingUnlockEntry\";\nimport { SecurityPermission } from \"@webiny/app-security/types\";\nimport type { IRecordLockingUpdateEntryLockResult } from \"~/domain/abstractions/IRecordLocking.js\";\n\nexport interface IRecordLockingIdentity {\n    id: string;\n    displayName: string;\n    type: string;\n}\n\nexport interface IRecordLockingRecordLocked {\n    lockedBy: IRecordLockingIdentity;\n    lockedOn: string;\n    expiresOn: string;\n    actions: IRecordLockingLockRecordAction[];\n}\n\nexport interface IPossiblyRecordLockingRecord extends EntryTableItem {\n    $lockingType?: string;\n    entryId: string;\n    $locked?: IRecordLockingRecordLocked | null;\n}\n\nexport interface IRecordLockingRecord extends IPossiblyRecordLockingRecord {\n    entryId: string;\n    $lockingType: string;\n}\n\nexport type IIsRecordLockedParams = Pick<IRecordLockingRecord, \"id\" | \"$lockingType\">;\n\nexport type IUpdateEntryLockParams = Pick<IRecordLockingRecord, \"id\" | \"$lockingType\">;\n\nexport type IUnlockEntryParams = Pick<IRecordLockingRecord, \"id\" | \"$lockingType\">;\n\nexport type IFetchLockRecordParams = Pick<IRecordLockingRecord, \"id\" | \"$lockingType\">;\n\nexport type IFetchLockedEntryLockRecordParams = Pick<IRecordLockingRecord, \"id\" | \"$lockingType\">;\n\nexport interface IFetchLockRecordResult {\n    data: IRecordLockingLockRecord | null;\n    error: IRecordLockingError | null;\n}\n\nexport interface IRecordLockingContext<\n    T extends IPossiblyRecordLockingRecord = IPossiblyRecordLockingRecord\n> {\n    readonly loading: boolean;\n    readonly records: IPossiblyRecordLockingRecord[];\n    readonly error?: IRecordLockingError | null;\n    setRecords(folderId: string, type: string, records: T[]): Promise<void>;\n    updateEntryLock(params: IUpdateEntryLockParams): Promise<IRecordLockingUpdateEntryLockResult>;\n    isRecordLocked(params?: IIsRecordLockedParams): boolean;\n    getLockRecordEntry(id: string): IRecordLockingRecord | undefined;\n    fetchLockRecord(params: IFetchLockRecordParams): Promise<IFetchLockRecordResult>;\n    fetchLockedEntryLockRecord(\n        params: IFetchLockedEntryLockRecordParams\n    ): Promise<IRecordLockingLockRecord | null>;\n    unlockEntry(params: IUnlockEntryParams): Promise<IRecordLockingUnlockEntryResult>;\n    removeEntryLock(params: IUnlockEntryParams): void;\n    unlockEntryForce(params: IUnlockEntryParams): Promise<IRecordLockingUnlockEntryResult>;\n    isLockExpired(input: Date | string): boolean;\n}\n\nexport interface IRecordLockingLockRecordAction {\n    type: string;\n    message: string;\n    createdBy: IRecordLockingIdentity;\n    createdOn: string;\n}\n\nexport interface IRecordLockingLockRecord {\n    id: string;\n    lockedOn: string;\n    expiresOn: string;\n    lockedBy: IRecordLockingIdentity;\n    targetId: string;\n    type: string;\n    actions: IRecordLockingLockRecordAction[];\n}\n\nexport interface IRecordLockingMeta {\n    totalCount: number;\n    cursor: string | null;\n    hasMoreItems: boolean;\n}\n\nexport interface IRecordLockingError<T = GenericRecord> {\n    message: string;\n    code: string;\n    data?: T;\n}\n\nexport interface RecordLockingSecurityPermission extends SecurityPermission {\n    canForceUnlock?: string;\n}\n"],"mappings":"","ignoreList":[]}
+{"version":3,"names":[],"sources":["types.ts"],"sourcesContent":["import type { CmsContentEntry } from \"@webiny/app-headless-cms/types\";\nimport type { GenericRecord } from \"@webiny/app/types\";\nimport type { IRecordLockingUnlockEntryResult } from \"~/domain/abstractions/IRecordLockingUnlockEntry\";\nimport type { SecurityPermission } from \"@webiny/app-security/types\";\nimport type { IRecordLockingUpdateEntryLockResult } from \"~/domain/abstractions/IRecordLocking.js\";\n\nexport interface IRecordLockingIdentity {\n    id: string;\n    displayName: string;\n    type: string;\n}\n\nexport interface IRecordLockingRecordLocked {\n    lockedBy: IRecordLockingIdentity;\n    lockedOn: string;\n    expiresOn: string;\n    actions: IRecordLockingLockRecordAction[];\n}\n\nexport interface IPossiblyRecordLockingRecord extends CmsContentEntry {\n    $lockingType?: string;\n    $locked?: IRecordLockingRecordLocked | null;\n}\n\nexport interface IRecordLockingRecord extends IPossiblyRecordLockingRecord {\n    $lockingType: string;\n}\n\nexport type IIsRecordLockedParams = Pick<IRecordLockingRecord, \"id\" | \"$lockingType\">;\n\nexport type IUpdateEntryLockParams = Pick<IRecordLockingRecord, \"id\" | \"$lockingType\">;\n\nexport type IUnlockEntryParams = Pick<IRecordLockingRecord, \"id\" | \"$lockingType\">;\n\nexport type IFetchLockRecordParams = Pick<IRecordLockingRecord, \"id\" | \"$lockingType\">;\n\nexport type IFetchLockedEntryLockRecordParams = Pick<IRecordLockingRecord, \"id\" | \"$lockingType\">;\n\nexport interface IFetchLockRecordResult {\n    data: IRecordLockingLockRecord | null;\n    error: IRecordLockingError | null;\n}\n\nexport interface IRecordLockingContext<\n    T extends IPossiblyRecordLockingRecord = IPossiblyRecordLockingRecord\n> {\n    readonly loading: boolean;\n    readonly records: IPossiblyRecordLockingRecord[];\n    readonly error?: IRecordLockingError | null;\n    setRecords(folderId: string, type: string, records: T[]): Promise<void>;\n    updateEntryLock(params: IUpdateEntryLockParams): Promise<IRecordLockingUpdateEntryLockResult>;\n    isRecordLocked(params?: IIsRecordLockedParams): boolean;\n    getLockRecordEntry(id: string): IRecordLockingRecord | undefined;\n    fetchLockRecord(params: IFetchLockRecordParams): Promise<IFetchLockRecordResult>;\n    fetchLockedEntryLockRecord(\n        params: IFetchLockedEntryLockRecordParams\n    ): Promise<IRecordLockingLockRecord | null>;\n    unlockEntry(params: IUnlockEntryParams): Promise<IRecordLockingUnlockEntryResult>;\n    removeEntryLock(params: IUnlockEntryParams): void;\n    unlockEntryForce(params: IUnlockEntryParams): Promise<IRecordLockingUnlockEntryResult>;\n    isLockExpired(input: Date | string): boolean;\n}\n\nexport interface IRecordLockingLockRecordAction {\n    type: string;\n    message: string;\n    createdBy: IRecordLockingIdentity;\n    createdOn: string;\n}\n\nexport interface IRecordLockingLockRecord {\n    id: string;\n    lockedOn: string;\n    expiresOn: string;\n    lockedBy: IRecordLockingIdentity;\n    targetId: string;\n    type: string;\n    actions: IRecordLockingLockRecordAction[];\n}\n\nexport interface IRecordLockingMeta {\n    totalCount: number;\n    cursor: string | null;\n    hasMoreItems: boolean;\n}\n\nexport interface IRecordLockingError<T = GenericRecord> {\n    message: string;\n    code: string;\n    data?: T;\n}\n\nexport interface RecordLockingSecurityPermission extends SecurityPermission {\n    canForceUnlock?: string;\n}\n"],"mappings":"","ignoreList":[]}

package/utils/createCacheKey.d.ts

@@ -1,3 +1,3 @@
-import { GenericRecord } from "@webiny/app/types";
+import type { GenericRecord } from "@webiny/app/types";
 export type ICreateCacheKeyInput = string | GenericRecord | ICreateCacheKeyInput[];
 export declare const createCacheKey: (input: ICreateCacheKeyInput) => Promise<string>;

package/utils/createCacheKey.js

@@ -1,19 +1,13 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createCacheKey = void 0;
-var _cryptoHash = require("crypto-hash");
-var createKey = function createKey(input) {
+import { sha1 } from "crypto-hash";
+const createKey = input => {
   if (typeof input === "string") {
     return input;
   }
   return JSON.stringify(input);
 };
-var createCacheKey = exports.createCacheKey = function createCacheKey(input) {
-  var key = createKey(input);
-  return (0, _cryptoHash.sha1)(key, {
+export const createCacheKey = input => {
+  const key = createKey(input);
+  return sha1(key, {
     outputFormat: "hex"
   });
 };

package/utils/createCacheKey.js.map

@@ -1 +1 @@
-{"version":3,"names":["_cryptoHash","require","createKey","input","JSON","stringify","createCacheKey","exports","key","sha1","outputFormat"],"sources":["createCacheKey.ts"],"sourcesContent":["import { GenericRecord } from \"@webiny/app/types\";\nimport { sha1 } from \"crypto-hash\";\n\nexport type ICreateCacheKeyInput = string | GenericRecord | ICreateCacheKeyInput[];\n\nconst createKey = (input: ICreateCacheKeyInput): string => {\n    if (typeof input === \"string\") {\n        return input;\n    }\n    return JSON.stringify(input);\n};\n\nexport const createCacheKey = (input: ICreateCacheKeyInput): Promise<string> => {\n    const key = createKey(input);\n\n    return sha1(key, {\n        outputFormat: \"hex\"\n    });\n};\n"],"mappings":";;;;;;AACA,IAAAA,WAAA,GAAAC,OAAA;AAIA,IAAMC,SAAS,GAAG,SAAZA,SAASA,CAAIC,KAA2B,EAAa;EACvD,IAAI,OAAOA,KAAK,KAAK,QAAQ,EAAE;IAC3B,OAAOA,KAAK;EAChB;EACA,OAAOC,IAAI,CAACC,SAAS,CAACF,KAAK,CAAC;AAChC,CAAC;AAEM,IAAMG,cAAc,GAAAC,OAAA,CAAAD,cAAA,GAAG,SAAjBA,cAAcA,CAAIH,KAA2B,EAAsB;EAC5E,IAAMK,GAAG,GAAGN,SAAS,CAACC,KAAK,CAAC;EAE5B,OAAO,IAAAM,gBAAI,EAACD,GAAG,EAAE;IACbE,YAAY,EAAE;EAClB,CAAC,CAAC;AACN,CAAC","ignoreList":[]}
+{"version":3,"names":["sha1","createKey","input","JSON","stringify","createCacheKey","key","outputFormat"],"sources":["createCacheKey.ts"],"sourcesContent":["import type { GenericRecord } from \"@webiny/app/types\";\nimport { sha1 } from \"crypto-hash\";\n\nexport type ICreateCacheKeyInput = string | GenericRecord | ICreateCacheKeyInput[];\n\nconst createKey = (input: ICreateCacheKeyInput): string => {\n    if (typeof input === \"string\") {\n        return input;\n    }\n    return JSON.stringify(input);\n};\n\nexport const createCacheKey = (input: ICreateCacheKeyInput): Promise<string> => {\n    const key = createKey(input);\n\n    return sha1(key, {\n        outputFormat: \"hex\"\n    });\n};\n"],"mappings":"AACA,SAASA,IAAI,QAAQ,aAAa;AAIlC,MAAMC,SAAS,GAAIC,KAA2B,IAAa;EACvD,IAAI,OAAOA,KAAK,KAAK,QAAQ,EAAE;IAC3B,OAAOA,KAAK;EAChB;EACA,OAAOC,IAAI,CAACC,SAAS,CAACF,KAAK,CAAC;AAChC,CAAC;AAED,OAAO,MAAMG,cAAc,GAAIH,KAA2B,IAAsB;EAC5E,MAAMI,GAAG,GAAGL,SAAS,CAACC,KAAK,CAAC;EAE5B,OAAOF,IAAI,CAACM,GAAG,EAAE;IACbC,YAAY,EAAE;EAClB,CAAC,CAAC;AACN,CAAC","ignoreList":[]}

package/components/assets/lock.svg

@@ -1,13 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<svg width="24px" height="24px" version="1.1" xmlns="http://www.w3.org/2000/svg">
-    <g stroke-width="1" fill="none" fill-rule="evenodd">
-        <g>
-            <g>
-                <polygon points="0 0 24 0 24 24 0 24"/>
-                <polygon opacity="0.87" points="0 0 24 0 24 24 0 24"/>
-            </g>
-            <path d="M18,8 L17,8 L17,6 C17,3.24 14.76,1 12,1 C9.24,1 7,3.24 7,6 L7,8 L6,8 C4.9,8 4,8.9 4,10 L4,20 C4,21.1 4.9,22 6,22 L18,22 C19.1,22 20,21.1 20,20 L20,10 C20,8.9 19.1,8 18,8 Z M12,17 C10.9,17 10,16.1 10,15 C10,13.9 10.9,13 12,13 C13.1,13 14,13.9 14,15 C14,16.1 13.1,17 12,17 Z M9,8 L9,6 C9,4.34 10.34,3 12,3 C13.66,3 15,4.34 15,6 L15,8 L9,8 Z"
-                  fill="rgba(0, 0, 0, 0.54)" fill-rule="nonzero"/>
-        </g>
-    </g>
-</svg>