@nocobase/shared 3.0.0-alpha.3 → 3.0.0-alpha.5

package/lib/index.d.ts

@@ -7,4 +7,5 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 export * from './getValuesByPath';
+export * from './ui-operation';
 export * from './variable-usage';

package/lib/index.js

@@ -24,9 +24,11 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var src_exports = {};
 module.exports = __toCommonJS(src_exports);
 __reExport(src_exports, require("./getValuesByPath"), module.exports);
+__reExport(src_exports, require("./ui-operation"), module.exports);
 __reExport(src_exports, require("./variable-usage"), module.exports);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ...require("./getValuesByPath"),
+  ...require("./ui-operation"),
   ...require("./variable-usage")
 });

package/lib/ui-operation.d.ts

@@ -0,0 +1,25 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+export declare const UI_OPERATION_QUERY_KEY = "_operation_";
+export declare const UI_OPERATION_VERSION = 1;
+export declare const MAX_UI_OPERATION_ENCODED_LENGTH: number;
+export interface UIOperation<TOperationId extends string = string, TParams extends Record<string, unknown> = Record<string, unknown>> {
+    v: typeof UI_OPERATION_VERSION;
+    operationId: TOperationId;
+    params?: TParams;
+}
+export interface UIOperationCodec {
+    encode(value: string): string;
+    decode(value: string): string | undefined;
+}
+export declare function isUIOperation(value: unknown): value is UIOperation;
+export declare function encodeUIOperation(operation: UIOperation, codec: UIOperationCodec): string;
+export declare function decodeUIOperation(encoded: string, codec: UIOperationCodec): UIOperation | undefined;
+export declare function parseUIOperation(search: string, codec: UIOperationCodec): UIOperation | undefined;
+export declare function removeUIOperation(search: string): string;

package/lib/ui-operation.js

@@ -0,0 +1,114 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var ui_operation_exports = {};
+__export(ui_operation_exports, {
+  MAX_UI_OPERATION_ENCODED_LENGTH: () => MAX_UI_OPERATION_ENCODED_LENGTH,
+  UI_OPERATION_QUERY_KEY: () => UI_OPERATION_QUERY_KEY,
+  UI_OPERATION_VERSION: () => UI_OPERATION_VERSION,
+  decodeUIOperation: () => decodeUIOperation,
+  encodeUIOperation: () => encodeUIOperation,
+  isUIOperation: () => isUIOperation,
+  parseUIOperation: () => parseUIOperation,
+  removeUIOperation: () => removeUIOperation
+});
+module.exports = __toCommonJS(ui_operation_exports);
+const UI_OPERATION_QUERY_KEY = "_operation_";
+const UI_OPERATION_VERSION = 1;
+const MAX_UI_OPERATION_ENCODED_LENGTH = 8 * 1024;
+function isPlainObject(value) {
+  if (!value || typeof value !== "object" || Array.isArray(value)) {
+    return false;
+  }
+  const prototype = Object.getPrototypeOf(value);
+  return prototype === Object.prototype || prototype === null;
+}
+__name(isPlainObject, "isPlainObject");
+function isUIOperation(value) {
+  if (!isPlainObject(value) || value.v !== UI_OPERATION_VERSION || typeof value.operationId !== "string" || !value.operationId) {
+    return false;
+  }
+  return value.params === void 0 || isPlainObject(value.params);
+}
+__name(isUIOperation, "isUIOperation");
+function encodeUIOperation(operation, codec) {
+  if (!isUIOperation(operation)) {
+    throw new TypeError("Invalid UI operation.");
+  }
+  const encoded = codec.encode(JSON.stringify(operation));
+  if (encoded.length > MAX_UI_OPERATION_ENCODED_LENGTH) {
+    throw new RangeError(`UI operation exceeds the ${MAX_UI_OPERATION_ENCODED_LENGTH}-byte encoded length limit.`);
+  }
+  return encoded;
+}
+__name(encodeUIOperation, "encodeUIOperation");
+function decodeUIOperation(encoded, codec) {
+  if (encoded.length > MAX_UI_OPERATION_ENCODED_LENGTH) {
+    return void 0;
+  }
+  try {
+    const decoded = codec.decode(encoded);
+    if (decoded === void 0) {
+      return void 0;
+    }
+    const parsed = JSON.parse(decoded);
+    return isUIOperation(parsed) ? parsed : void 0;
+  } catch {
+    return void 0;
+  }
+}
+__name(decodeUIOperation, "decodeUIOperation");
+function parseUIOperation(search, codec) {
+  try {
+    const values = new URLSearchParams(search).getAll(UI_OPERATION_QUERY_KEY);
+    if (values.length !== 1) {
+      return void 0;
+    }
+    return decodeUIOperation(values[0], codec);
+  } catch {
+    return void 0;
+  }
+}
+__name(parseUIOperation, "parseUIOperation");
+function removeUIOperation(search) {
+  const params = new URLSearchParams(search);
+  params.delete(UI_OPERATION_QUERY_KEY);
+  const remaining = params.toString();
+  return remaining ? `?${remaining}` : "";
+}
+__name(removeUIOperation, "removeUIOperation");
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  MAX_UI_OPERATION_ENCODED_LENGTH,
+  UI_OPERATION_QUERY_KEY,
+  UI_OPERATION_VERSION,
+  decodeUIOperation,
+  encodeUIOperation,
+  isUIOperation,
+  parseUIOperation,
+  removeUIOperation
+});

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@nocobase/shared",
-  "version": "3.0.0-alpha.3",
+  "version": "3.0.0-alpha.5",
   "main": "lib/index.js",
   "types": "./lib/index.d.ts",
   "license": "Apache-2.0",
-  "gitHead": "9899cd799c070c7bd85140148ea5b100b046bdc7"
+  "gitHead": "82c7ed1cdb2f247c190582e34ee37f154cac0968"
 }

package/src/index.ts

@@ -8,4 +8,5 @@
  */
 
 export * from './getValuesByPath';
+export * from './ui-operation';
 export * from './variable-usage';

package/src/ui-operation.ts

@@ -0,0 +1,99 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+export const UI_OPERATION_QUERY_KEY = '_operation_';
+export const UI_OPERATION_VERSION = 1;
+export const MAX_UI_OPERATION_ENCODED_LENGTH = 8 * 1024;
+
+export interface UIOperation<
+  TOperationId extends string = string,
+  TParams extends Record<string, unknown> = Record<string, unknown>,
+> {
+  v: typeof UI_OPERATION_VERSION;
+  operationId: TOperationId;
+  params?: TParams;
+}
+
+export interface UIOperationCodec {
+  encode(value: string): string;
+  decode(value: string): string | undefined;
+}
+
+function isPlainObject(value: unknown): value is Record<string, unknown> {
+  if (!value || typeof value !== 'object' || Array.isArray(value)) {
+    return false;
+  }
+
+  const prototype = Object.getPrototypeOf(value);
+  return prototype === Object.prototype || prototype === null;
+}
+
+export function isUIOperation(value: unknown): value is UIOperation {
+  if (
+    !isPlainObject(value) ||
+    value.v !== UI_OPERATION_VERSION ||
+    typeof value.operationId !== 'string' ||
+    !value.operationId
+  ) {
+    return false;
+  }
+
+  return value.params === undefined || isPlainObject(value.params);
+}
+
+export function encodeUIOperation(operation: UIOperation, codec: UIOperationCodec): string {
+  if (!isUIOperation(operation)) {
+    throw new TypeError('Invalid UI operation.');
+  }
+
+  const encoded = codec.encode(JSON.stringify(operation));
+  if (encoded.length > MAX_UI_OPERATION_ENCODED_LENGTH) {
+    throw new RangeError(`UI operation exceeds the ${MAX_UI_OPERATION_ENCODED_LENGTH}-byte encoded length limit.`);
+  }
+
+  return encoded;
+}
+
+export function decodeUIOperation(encoded: string, codec: UIOperationCodec): UIOperation | undefined {
+  if (encoded.length > MAX_UI_OPERATION_ENCODED_LENGTH) {
+    return undefined;
+  }
+
+  try {
+    const decoded = codec.decode(encoded);
+    if (decoded === undefined) {
+      return undefined;
+    }
+
+    const parsed: unknown = JSON.parse(decoded);
+    return isUIOperation(parsed) ? parsed : undefined;
+  } catch {
+    return undefined;
+  }
+}
+
+export function parseUIOperation(search: string, codec: UIOperationCodec): UIOperation | undefined {
+  try {
+    const values = new URLSearchParams(search).getAll(UI_OPERATION_QUERY_KEY);
+    if (values.length !== 1) {
+      return undefined;
+    }
+
+    return decodeUIOperation(values[0], codec);
+  } catch {
+    return undefined;
+  }
+}
+
+export function removeUIOperation(search: string): string {
+  const params = new URLSearchParams(search);
+  params.delete(UI_OPERATION_QUERY_KEY);
+  const remaining = params.toString();
+  return remaining ? `?${remaining}` : '';
+}