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

package/hooks/useRecordLocking.js

@@ -0,0 +1,18 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useRecordLocking = void 0;
+var _error = require("@webiny/error");
+var _react = require("react");
+var _RecordLockingProvider = require("../components/RecordLockingProvider");
+var useRecordLocking = exports.useRecordLocking = function useRecordLocking() {
+  var context = (0, _react.useContext)(_RecordLockingProvider.RecordLockingContext);
+  if (!context) {
+    throw new _error.WebinyError("useRecordLocking must be used within a RecordLockingProvider.");
+  }
+  return context;
+};
+
+//# sourceMappingURL=useRecordLocking.js.map

package/hooks/useRecordLocking.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_error","require","_react","_RecordLockingProvider","useRecordLocking","exports","context","useContext","RecordLockingContext","WebinyError"],"sources":["useRecordLocking.ts"],"sourcesContent":["import { WebinyError } from \"@webiny/error\";\nimport { useContext } from \"react\";\nimport { RecordLockingContext } from \"~/components/RecordLockingProvider\";\nimport { IRecordLockingContext, IPossiblyRecordLockingRecord } from \"~/types\";\n\nexport const useRecordLocking = <\n    T extends IPossiblyRecordLockingRecord = IPossiblyRecordLockingRecord\n>() => {\n    const context = useContext(RecordLockingContext);\n    if (!context) {\n        throw new WebinyError(\"useRecordLocking must be used within a RecordLockingProvider.\");\n    }\n    return context as IRecordLockingContext<T>;\n};\n"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AACA,IAAAC,MAAA,GAAAD,OAAA;AACA,IAAAE,sBAAA,GAAAF,OAAA;AAGO,IAAMG,gBAAgB,GAAAC,OAAA,CAAAD,gBAAA,GAAG,SAAnBA,gBAAgBA,CAAA,EAEtB;EACH,IAAME,OAAO,GAAG,IAAAC,iBAAU,EAACC,2CAAoB,CAAC;EAChD,IAAI,CAACF,OAAO,EAAE;IACV,MAAM,IAAIG,kBAAW,CAAC,+DAA+D,CAAC;EAC1F;EACA,OAAOH,OAAO;AAClB,CAAC","ignoreList":[]}

package/index.d.ts

@@ -0,0 +1,7 @@
+import React from "react";
+export * from "./components/RecordLockingProvider";
+export * from "./hooks";
+export interface RecordLockingProviderProps {
+    children: React.ReactNode;
+}
+export declare const RecordLocking: () => React.JSX.Element | null;

package/index.js

@@ -0,0 +1,57 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _exportNames = {
+  RecordLocking: true
+};
+exports.RecordLocking = void 0;
+var _react = _interopRequireDefault(require("react"));
+var _app = require("@webiny/app");
+var _RecordLockingProvider = require("./components/RecordLockingProvider");
+Object.keys(_RecordLockingProvider).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _RecordLockingProvider[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _RecordLockingProvider[key];
+    }
+  });
+});
+var _HeadlessCmsActionsAcoCell = require("./components/HeadlessCmsActionsAcoCell");
+var _HeadlessCmsContentEntry = require("./components/HeadlessCmsContentEntry");
+var _appWcp = require("@webiny/app-wcp");
+var _hooks = require("./hooks");
+Object.keys(_hooks).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _hooks[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _hooks[key];
+    }
+  });
+});
+var RecordLockingHoc = function RecordLockingHoc(Component) {
+  return function RecordLockingProvider(_ref) {
+    var children = _ref.children;
+    return /*#__PURE__*/_react.default.createElement(Component, null, /*#__PURE__*/_react.default.createElement(_RecordLockingProvider.RecordLockingProvider, null, children));
+  };
+};
+var RecordLocking = exports.RecordLocking = function RecordLocking() {
+  var _useWcp = (0, _appWcp.useWcp)(),
+    canUseRecordLocking = _useWcp.canUseRecordLocking;
+  if (!canUseRecordLocking()) {
+    return null;
+  }
+  return /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, /*#__PURE__*/_react.default.createElement(_app.Provider, {
+    hoc: RecordLockingHoc
+  }), /*#__PURE__*/_react.default.createElement(_HeadlessCmsActionsAcoCell.HeadlessCmsActionsAcoCell, null), /*#__PURE__*/_react.default.createElement(_HeadlessCmsContentEntry.HeadlessCmsContentEntry, null));
+};
+
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_react","_interopRequireDefault","require","_app","_RecordLockingProvider","Object","keys","forEach","key","prototype","hasOwnProperty","call","_exportNames","exports","defineProperty","enumerable","get","_HeadlessCmsActionsAcoCell","_HeadlessCmsContentEntry","_appWcp","_hooks","RecordLockingHoc","Component","RecordLockingProvider","_ref","children","default","createElement","RecordLocking","_useWcp","useWcp","canUseRecordLocking","Fragment","Provider","hoc","HeadlessCmsActionsAcoCell","HeadlessCmsContentEntry"],"sources":["index.tsx"],"sourcesContent":["import React from \"react\";\nimport { Provider } from \"@webiny/app\";\nimport { RecordLockingProvider as RecordLockingProviderComponent } from \"~/components/RecordLockingProvider\";\nimport { HeadlessCmsActionsAcoCell } from \"~/components/HeadlessCmsActionsAcoCell\";\nimport { HeadlessCmsContentEntry } from \"~/components/HeadlessCmsContentEntry\";\nimport { useWcp } from \"@webiny/app-wcp\";\n\nexport * from \"~/components/RecordLockingProvider\";\nexport * from \"~/hooks\";\n\nexport interface RecordLockingProviderProps {\n    children: React.ReactNode;\n}\n\nconst RecordLockingHoc = (Component: React.ComponentType<RecordLockingProviderProps>) => {\n    return function RecordLockingProvider({ children }: RecordLockingProviderProps) {\n        return (\n            <Component>\n                <RecordLockingProviderComponent>{children}</RecordLockingProviderComponent>\n            </Component>\n        );\n    };\n};\n\nexport const RecordLocking = () => {\n    const { canUseRecordLocking } = useWcp();\n\n    if (!canUseRecordLocking()) {\n        return null;\n    }\n\n    return (\n        <>\n            <Provider hoc={RecordLockingHoc} />\n            <HeadlessCmsActionsAcoCell />\n            <HeadlessCmsContentEntry />\n        </>\n    );\n};\n"],"mappings":";;;;;;;;;;AAAA,IAAAA,MAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,IAAA,GAAAD,OAAA;AACA,IAAAE,sBAAA,GAAAF,OAAA;AAKAG,MAAA,CAAAC,IAAA,CAAAF,sBAAA,EAAAG,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAH,MAAA,CAAAI,SAAA,CAAAC,cAAA,CAAAC,IAAA,CAAAC,YAAA,EAAAJ,GAAA;EAAA,IAAAA,GAAA,IAAAK,OAAA,IAAAA,OAAA,CAAAL,GAAA,MAAAJ,sBAAA,CAAAI,GAAA;EAAAH,MAAA,CAAAS,cAAA,CAAAD,OAAA,EAAAL,GAAA;IAAAO,UAAA;IAAAC,GAAA,WAAAA,IAAA;MAAA,OAAAZ,sBAAA,CAAAI,GAAA;IAAA;EAAA;AAAA;AAJA,IAAAS,0BAAA,GAAAf,OAAA;AACA,IAAAgB,wBAAA,GAAAhB,OAAA;AACA,IAAAiB,OAAA,GAAAjB,OAAA;AAGA,IAAAkB,MAAA,GAAAlB,OAAA;AAAAG,MAAA,CAAAC,IAAA,CAAAc,MAAA,EAAAb,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAH,MAAA,CAAAI,SAAA,CAAAC,cAAA,CAAAC,IAAA,CAAAC,YAAA,EAAAJ,GAAA;EAAA,IAAAA,GAAA,IAAAK,OAAA,IAAAA,OAAA,CAAAL,GAAA,MAAAY,MAAA,CAAAZ,GAAA;EAAAH,MAAA,CAAAS,cAAA,CAAAD,OAAA,EAAAL,GAAA;IAAAO,UAAA;IAAAC,GAAA,WAAAA,IAAA;MAAA,OAAAI,MAAA,CAAAZ,GAAA;IAAA;EAAA;AAAA;AAMA,IAAMa,gBAAgB,GAAG,SAAnBA,gBAAgBA,CAAIC,SAA0D,EAAK;EACrF,OAAO,SAASC,qBAAqBA,CAAAC,IAAA,EAA2C;IAAA,IAAxCC,QAAQ,GAAAD,IAAA,CAARC,QAAQ;IAC5C,oBACIzB,MAAA,CAAA0B,OAAA,CAAAC,aAAA,CAACL,SAAS,qBACNtB,MAAA,CAAA0B,OAAA,CAAAC,aAAA,CAACvB,sBAAA,CAAAmB,qBAA8B,QAAEE,QAAyC,CACnE,CAAC;EAEpB,CAAC;AACL,CAAC;AAEM,IAAMG,aAAa,GAAAf,OAAA,CAAAe,aAAA,GAAG,SAAhBA,aAAaA,CAAA,EAAS;EAC/B,IAAAC,OAAA,GAAgC,IAAAC,cAAM,EAAC,CAAC;IAAhCC,mBAAmB,GAAAF,OAAA,CAAnBE,mBAAmB;EAE3B,IAAI,CAACA,mBAAmB,CAAC,CAAC,EAAE;IACxB,OAAO,IAAI;EACf;EAEA,oBACI/B,MAAA,CAAA0B,OAAA,CAAAC,aAAA,CAAA3B,MAAA,CAAA0B,OAAA,CAAAM,QAAA,qBACIhC,MAAA,CAAA0B,OAAA,CAAAC,aAAA,CAACxB,IAAA,CAAA8B,QAAQ;IAACC,GAAG,EAAEb;EAAiB,CAAE,CAAC,eACnCrB,MAAA,CAAA0B,OAAA,CAAAC,aAAA,CAACV,0BAAA,CAAAkB,yBAAyB,MAAE,CAAC,eAC7BnC,MAAA,CAAA0B,OAAA,CAAAC,aAAA,CAACT,wBAAA,CAAAkB,uBAAuB,MAAE,CAC5B,CAAC;AAEX,CAAC","ignoreList":[]}

package/package.json

@@ -0,0 +1,58 @@
+{
+	"name": "@webiny/app-record-locking",
+	"version": "5.40.0-beta.3",
+	"main": "index.js",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/webiny/webiny-js.git"
+	},
+	"contributors": [
+		"Pavel Denisjuk <pavel@webiny.com>",
+		"Sven Al Hamad <sven@webiny.com>",
+		"Adrian Smijulj <adrian@webiny.com>"
+	],
+	"license": "MIT",
+	"dependencies": {
+		"@apollo/react-hooks": "3.1.5",
+		"@emotion/styled": "11.10.6",
+		"@material-design-icons/svg": "0.14.13",
+		"@webiny/app": "5.40.0-beta.3",
+		"@webiny/app-admin": "5.40.0-beta.3",
+		"@webiny/app-headless-cms": "5.40.0-beta.3",
+		"@webiny/app-security": "5.40.0-beta.3",
+		"@webiny/app-wcp": "5.40.0-beta.3",
+		"@webiny/app-websockets": "5.40.0-beta.3",
+		"@webiny/error": "5.40.0-beta.3",
+		"@webiny/react-router": "5.40.0-beta.3",
+		"@webiny/ui": "5.40.0-beta.3",
+		"@webiny/utils": "5.40.0-beta.3",
+		"apollo-client": "2.6.10",
+		"apollo-link": "1.2.14",
+		"crypto-hash": "3.0.0",
+		"emotion": "10.0.27",
+		"graphql-tag": "2.12.6",
+		"react": "18.2.0",
+		"react-dom": "18.2.0"
+	},
+	"devDependencies": {
+		"@babel/cli": "7.24.1",
+		"@babel/core": "7.24.3",
+		"@babel/preset-env": "7.24.3",
+		"@babel/preset-react": "7.24.1",
+		"@babel/preset-typescript": "7.24.1",
+		"@webiny/cli": "5.40.0-beta.3",
+		"@webiny/project-utils": "5.40.0-beta.3",
+		"rimraf": "5.0.5",
+		"ttypescript": "1.5.15",
+		"typescript": "4.7.4"
+	},
+	"publishConfig": {
+		"access": "public",
+		"directory": "dist"
+	},
+	"scripts": {
+		"build": "yarn webiny run build",
+		"watch": "yarn webiny run watch"
+	},
+	"gitHead": "638d8b84063906cd1aa979ed6e0487ad26fbcf2f"
+}

package/types.d.ts

@@ -0,0 +1,72 @@
+import { EntryTableItem } from "@webiny/app-headless-cms/types";
+import { GenericRecord } from "@webiny/app/types";
+import { IRecordLockingUnlockEntryResult } from "./domain/abstractions/IRecordLockingUnlockEntry";
+export interface IRecordLockingIdentity {
+    id: string;
+    displayName: string;
+    type: string;
+}
+export interface IRecordLockingRecordLocked {
+    lockedBy: IRecordLockingIdentity;
+    lockedOn: string;
+    expiresOn: string;
+    actions: IRecordLockingLockRecordAction[];
+}
+export interface IPossiblyRecordLockingRecord extends EntryTableItem {
+    $lockingType?: string;
+    entryId: string;
+    $locked?: IRecordLockingRecordLocked | null;
+}
+export interface IRecordLockingRecord extends IPossiblyRecordLockingRecord {
+    entryId: string;
+    $lockingType: string;
+}
+export declare type IIsRecordLockedParams = Pick<IRecordLockingRecord, "id" | "$lockingType">;
+export declare type IUpdateEntryLockParams = Pick<IRecordLockingRecord, "id" | "$lockingType">;
+export declare type IUnlockEntryParams = Pick<IRecordLockingRecord, "id" | "$lockingType">;
+export declare type IFetchLockRecordParams = Pick<IRecordLockingRecord, "id" | "$lockingType">;
+export declare type IFetchLockedEntryLockRecordParams = Pick<IRecordLockingRecord, "id" | "$lockingType">;
+export interface IFetchLockRecordResult {
+    data: IRecordLockingLockRecord | null;
+    error: IRecordLockingError | null;
+}
+export interface IRecordLockingContext<T extends IPossiblyRecordLockingRecord = IPossiblyRecordLockingRecord> {
+    readonly loading: boolean;
+    readonly records: IPossiblyRecordLockingRecord[];
+    readonly error?: IRecordLockingError | null;
+    setRecords(folderId: string, type: string, records: T[]): Promise<void>;
+    updateEntryLock(params: IUpdateEntryLockParams): Promise<void>;
+    isRecordLocked(params?: IIsRecordLockedParams): boolean;
+    getLockRecordEntry(id: string): IRecordLockingRecord | undefined;
+    fetchLockRecord(params: IFetchLockRecordParams): Promise<IFetchLockRecordResult>;
+    fetchLockedEntryLockRecord(params: IFetchLockedEntryLockRecordParams): Promise<IRecordLockingLockRecord | null>;
+    unlockEntry(params: IUnlockEntryParams): Promise<IRecordLockingUnlockEntryResult>;
+    removeEntryLock(params: IUnlockEntryParams): void;
+    unlockEntryForce(params: IUnlockEntryParams): Promise<IRecordLockingUnlockEntryResult>;
+    isLockExpired(input: Date | string): boolean;
+}
+export interface IRecordLockingLockRecordAction {
+    type: string;
+    message: string;
+    createdBy: IRecordLockingIdentity;
+    createdOn: string;
+}
+export interface IRecordLockingLockRecord {
+    id: string;
+    lockedOn: string;
+    expiresOn: string;
+    lockedBy: IRecordLockingIdentity;
+    targetId: string;
+    type: string;
+    actions: IRecordLockingLockRecordAction[];
+}
+export interface IRecordLockingMeta {
+    totalCount: number;
+    cursor: string | null;
+    hasMoreItems: boolean;
+}
+export interface IRecordLockingError<T = GenericRecord> {
+    message: string;
+    code: string;
+    data?: T;
+}

package/types.js

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

package/types.js.map

@@ -0,0 +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\";\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<void>;\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"],"mappings":"","ignoreList":[]}

package/utils/createCacheKey.d.ts

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

package/utils/createCacheKey.js

@@ -0,0 +1,21 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createCacheKey = void 0;
+var _cryptoHash = require("crypto-hash");
+var createKey = function 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, {
+    outputFormat: "hex"
+  });
+};
+
+//# sourceMappingURL=createCacheKey.js.map

package/utils/createCacheKey.js.map

@@ -0,0 +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":[]}