@qoretechnologies/reqraft 0.10.64 → 0.10.65-pr.137.g62fcecc

package/src/hooks/useQorusTypes.ts

@@ -1,233 +0,0 @@
-import { IReqoreIconName } from '@qoretechnologies/reqore/dist/types/icons';
-import { TQorusType } from '@qoretechnologies/ts-toolkit';
-import { size } from 'lodash';
-import { useCallback, useMemo } from 'react';
-import { useFetch } from './useFetch/useFetch';
-
-export interface IQorusTypeObject {
-  display_name: string;
-  name: TQorusType | string;
-  desc?: string;
-  short_desc?: string;
-  icon?: IReqoreIconName;
-  types_accepted: (TQorusType | string)[];
-  exact_match?: (TQorusType | string)[];
-}
-
-export interface IUseTypes {
-  loading: boolean;
-  error?: Error;
-  retry: () => void;
-  value?: IQorusTypeObject[];
-  compactValue?: IQorusTypeObject[];
-  getAcceptedTypes: (typeName: string) => string[];
-  getExactMatches: (typeName: string) => string[];
-  getTypeDisplayName: (typeName: string) => string;
-}
-
-export const compactTypesList = ['richtext', 'float', 'hash', 'list', 'bool', 'date', 'binary'];
-
-export const defaultQorusTypes: IQorusTypeObject[] = [
-  {
-    name: 'any',
-    display_name: 'Any',
-    short_desc: 'Any data type',
-    desc: 'Any data type',
-    types_accepted: ['any'],
-    exact_match: ['any'],
-  },
-  {
-    name: 'context',
-    display_name: 'Context',
-    short_desc: 'The data type is determined by the context value chosen',
-    desc: 'The data type is determined by the context value chosen',
-    types_accepted: ['any'],
-    exact_match: ['any'],
-  },
-  {
-    name: 'string',
-    display_name: 'String',
-    short_desc: 'String data',
-    desc: 'String data',
-    types_accepted: ['any'],
-    exact_match: ['string', 'richtext'],
-  },
-  {
-    name: 'richtext',
-    display_name: 'Text',
-    short_desc: 'Rich text string data',
-    desc: 'Rich text string data',
-    types_accepted: ['any'],
-    exact_match: ['string', 'richtext'],
-  },
-  {
-    name: 'int',
-    display_name: 'Integer',
-    short_desc: '64-bit integer',
-    desc: '64-bit integer',
-    types_accepted: ['int', 'integer'],
-    exact_match: ['int', 'integer'],
-  },
-  {
-    name: 'float',
-    display_name: 'Number',
-    short_desc: 'Double-precision floating-point number',
-    desc: 'Double-precision floating-point number',
-    types_accepted: ['float', 'int', 'integer'],
-    exact_match: ['float', 'int', 'integer'],
-  },
-  {
-    name: 'number',
-    display_name: 'Scientific Number',
-    short_desc: 'Arbitrary-precision floating-point number',
-    desc: 'Arbitrary-precision floating-point number',
-    types_accepted: ['number', 'float', 'int', 'integer'],
-    exact_match: ['number', 'float', 'int', 'integer'],
-  },
-  {
-    name: 'bool',
-    display_name: 'Boolean',
-    short_desc: 'Boolean value',
-    desc: 'Boolean value',
-    types_accepted: ['bool'],
-    exact_match: ['bool'],
-  },
-  {
-    name: 'date',
-    display_name: 'Date',
-    short_desc: 'Date-time value',
-    desc: 'Date-time value',
-    types_accepted: ['date'],
-    exact_match: ['date'],
-  },
-  {
-    name: 'binary',
-    display_name: 'Binary',
-    short_desc: 'Binary value',
-    desc: 'Binary value',
-    types_accepted: ['binary'],
-    exact_match: ['binary'],
-  },
-  {
-    name: 'data',
-    display_name: 'Data',
-    short_desc: 'Binary or string value',
-    desc: 'Binary or string value',
-    types_accepted: ['string', 'richtext', 'binary'],
-    exact_match: ['string', 'richtext', 'binary'],
-  },
-  {
-    name: 'hash',
-    display_name: 'Hash',
-    short_desc: 'Ordered key-value pair / hash',
-    desc: 'Ordered key-value pair / hash',
-    types_accepted: ['hash'],
-    exact_match: ['hash'],
-  },
-  {
-    name: 'list',
-    display_name: 'List',
-    short_desc: 'List',
-    desc: 'List',
-    types_accepted: ['list'],
-    exact_match: ['list'],
-  },
-  {
-    name: 'rgbcolor',
-    display_name: 'Color',
-    short_desc: 'RGB Color value',
-    desc: 'RGB Color value',
-    types_accepted: ['rgbcolor'],
-    exact_match: ['rgbcolor'],
-  },
-  {
-    name: 'workflow',
-    display_name: 'Workflow',
-    short_desc: 'Qorus workflow',
-    desc: 'Qorus workflow',
-    types_accepted: ['workflow', 'string', 'richtext'],
-    exact_match: ['workflow', 'string', 'richtext'],
-  },
-  {
-    name: 'service',
-    display_name: 'Service',
-    short_desc: 'Qorus service',
-    desc: 'Qorus service',
-    types_accepted: ['service', 'string', 'richtext'],
-    exact_match: ['service', 'string', 'richtext'],
-  },
-  {
-    name: 'job',
-    display_name: 'Job',
-    short_desc: 'Qorus job',
-    desc: 'Qorus job',
-    types_accepted: ['job', 'string', 'richtext'],
-    exact_match: ['job', 'string', 'richtext'],
-  },
-  {
-    name: 'mapper',
-    display_name: 'Mapper',
-    short_desc: 'Qorus mapper',
-    desc: 'Qorus mapper',
-    types_accepted: ['mapper', 'string', 'richtext'],
-    exact_match: ['mapper', 'string', 'richtext'],
-  },
-  {
-    name: 'connection',
-    display_name: 'Connection',
-    short_desc: 'Qorus connection',
-    desc: 'Qorus connection',
-    types_accepted: ['connection', 'string', 'richtext'],
-    exact_match: ['connection', 'string', 'richtext'],
-  },
-];
-
-export const getQorusTypes = (): IQorusTypeObject[] => defaultQorusTypes;
-
-export const useQorusTypes = (): IUseTypes => {
-  const { data, loading, error, load } = useFetch<IQorusTypeObject[]>({
-    url: '/system/qorus-type-info',
-    defaultData: defaultQorusTypes,
-    loadOnMount: true,
-  });
-
-  const value = size(data) ? data : defaultQorusTypes;
-
-  const getAcceptedTypes = useCallback(
-    (typeName: string): string[] => {
-      const type = value?.find((t) => t.name === typeName);
-      return type ? (type.types_accepted as string[]) : [];
-    },
-    [value]
-  );
-
-  const getExactMatches = useCallback(
-    (typeName: string): string[] => {
-      const type = value?.find((t) => t.name === typeName);
-      return type && type.exact_match ? (type.exact_match as string[]) : [];
-    },
-    [value]
-  );
-
-  const getTypeDisplayName = useCallback(
-    (typeName: string): string => {
-      const type = value?.find((t) => t.name === typeName);
-      return type ? type.display_name : typeName;
-    },
-    [value]
-  );
-
-  return useMemo(
-    () => ({
-      loading,
-      error,
-      retry: load,
-      value,
-      compactValue: value?.filter((t) => compactTypesList.includes(t.name as string)),
-      getAcceptedTypes,
-      getExactMatches,
-      getTypeDisplayName,
-    }),
-    [JSON.stringify(value), loading, error, load, getAcceptedTypes, getExactMatches, getTypeDisplayName]
-  );
-};

package/src/hooks/useReqraftProperty.ts

@@ -1,16 +0,0 @@
-import { useContextSelector } from 'use-context-selector';
-import { IReqraftContext, ReqraftContext } from '../contexts/ReqraftContext';
-
-export const useReqraftProperty = <T extends keyof IReqraftContext>(
-  property: T
-): IReqraftContext[T] => {
-  const contextProperty = useContextSelector(ReqraftContext, (value) => {
-    if (!(property in value)) {
-      throw new Error(`Reqraft context property ${property} not found`);
-    }
-
-    return value[property];
-  });
-
-  return contextProperty;
-};

package/src/hooks/useStorage/useStorage.stories.tsx

@@ -1,168 +0,0 @@
-import { ReqoreButton, ReqoreControlGroup, ReqoreP } from '@qoretechnologies/reqore';
-import { StoryObj } from '@storybook/react-vite';
-import { useRef } from 'react';
-import { fireEvent, within } from 'storybook/test';
-import { storiesStorageMock } from '../../../__tests__/ mock';
-import { testsWaitForText } from '../../../__tests__/utils';
-import { storyApiUrl } from '../../stories/storyNetwork';
-import { StoryMeta } from '../../types';
-import { useReqraftStorage } from './useStorage';
-
-const meta = {
-  title: 'Hooks/useStorage',
-  render: () => {
-    const [storage, setStorage, removeValue] = useReqraftStorage<string>(
-      'some-path',
-      'This is a default value'
-    );
-
-    return (
-      <ReqoreControlGroup>
-        <ReqoreP>{storage}</ReqoreP>
-        <ReqoreButton onClick={() => setStorage('This is a NEW value')}>
-          Update storage
-        </ReqoreButton>
-        <ReqoreButton onClick={() => removeValue()}>Remove value</ReqoreButton>
-      </ReqoreControlGroup>
-    );
-  },
-  args: { reqraftOptions: { waitForStorage: true } },
-} as StoryMeta<any>;
-
-export default meta;
-export type Story = StoryObj<typeof meta>;
-
-export const DefaultValue: Story = {
-  args: {
-    method: 'GET',
-  },
-  parameters: {
-    docs: {
-      description: {
-        story:
-          'Renders a useReqraftStorage demo where the server returns no stored value — the hook falls back to the default and displays it.',
-      },
-    },
-    mockData: [
-      {
-        url: storyApiUrl('users?action=current'),
-        method: 'GET',
-        status: 200,
-        response: {},
-      },
-    ],
-  },
-  play: async () => {
-    await testsWaitForText('This is a default value');
-  },
-};
-
-export const StorageValue: Story = {
-  parameters: {
-    docs: {
-      description: {
-        story:
-          'Renders a useReqraftStorage demo with a value already persisted on the server — the hook loads it and displays it in place of the default.',
-      },
-    },
-    mockData: [...storiesStorageMock],
-  },
-  play: async () => {
-    await testsWaitForText('This is a storage value');
-  },
-};
-
-export const ValueCanBeUpdated: Story = {
-  ...StorageValue,
-  parameters: {
-    ...StorageValue.parameters,
-    docs: {
-      description: {
-        story:
-          'Renders the useReqraftStorage demo with a stored value. When "Update storage" is clicked, the setter writes a new value and the display refreshes to match.',
-      },
-    },
-  },
-  play: async ({ canvasElement }) => {
-    const canvas = within(canvasElement);
-
-    //await sleep(1000);
-
-    await testsWaitForText('This is a storage value');
-    await testsWaitForText('Update storage');
-    await fireEvent.click(canvas.getByText('Update storage'));
-    await testsWaitForText('This is a NEW value');
-  },
-};
-
-/**
- * Regression for the "stale updater clobbers other keys" bug: the storage
- * updater must persist onto the LATEST storage blob, not the one captured in
- * its closure. Long-lived callers (an imperative store subscription, a ref to
- * the mount-time setter) hold an old updater; writing through it must not wipe
- * keys other hooks wrote in the meantime.
- */
-export const StaleUpdaterDoesNotClobberOtherKeys: Story = {
-  args: { reqraftOptions: { waitForStorage: true } },
-  parameters: {
-    docs: {
-      description: {
-        story:
-          "Renders two useReqraftStorage keys and captures the mount-time setter for the first one (a deliberately STALE updater). After a second key is written, writing through the stale updater must keep the second key intact — proving storage writes merge onto the latest blob rather than a closure copy. This is the regression test for page-visit tracking wiping other stored settings.",
-      },
-    },
-    mockData: [...storiesStorageMock],
-  },
-  render: () => {
-    const [someVal, setSomeVal] = useReqraftStorage<string>('some-path', 'default');
-    const [keyB] = useReqraftStorage<string>('key-b', 'b-default');
-    const [, setKeyB] = useReqraftStorage<string>('key-b', 'b-default');
-    // Capture the mount-time setter — it stays stale once other keys change.
-    const staleSetSomeVal = useRef(setSomeVal);
-
-    return (
-      <ReqoreControlGroup vertical>
-        <ReqoreP>{`some-path: ${someVal}`}</ReqoreP>
-        <ReqoreP>{`key-b: ${keyB}`}</ReqoreP>
-        <ReqoreButton onClick={() => setKeyB('b-written')}>Write B</ReqoreButton>
-        <ReqoreButton onClick={() => staleSetSomeVal.current('a-written')}>
-          Write A (stale)
-        </ReqoreButton>
-      </ReqoreControlGroup>
-    );
-  },
-  play: async ({ canvasElement }) => {
-    const canvas = within(canvasElement);
-
-    await testsWaitForText('some-path: This is a storage value');
-    // Write a second key through its own (fresh) updater.
-    await fireEvent.click(canvas.getByText('Write B'));
-    await testsWaitForText('key-b: b-written');
-    // Write the first key through the STALE mount-time updater.
-    await fireEvent.click(canvas.getByText('Write A (stale)'));
-    await testsWaitForText('some-path: a-written');
-    // The stale write must NOT have wiped the second key.
-    await testsWaitForText('key-b: b-written');
-  },
-};
-
-export const ValueCanBeRemoved: Story = {
-  ...StorageValue,
-  parameters: {
-    ...StorageValue.parameters,
-    docs: {
-      description: {
-        story:
-          'Renders the useReqraftStorage demo with a stored value. When "Remove value" is clicked, the remover clears storage and the hook falls back to the default value.',
-      },
-    },
-  },
-  play: async ({ canvasElement }) => {
-    const canvas = within(canvasElement);
-
-    await testsWaitForText('This is a storage value');
-    await testsWaitForText('Remove value');
-    await fireEvent.click(canvas.getByText('Remove value'));
-    await testsWaitForText('This is a default value');
-  },
-};

package/src/hooks/useStorage/useStorage.ts

@@ -1,35 +0,0 @@
-import { useCallback, useContext, useMemo } from 'react';
-import { ReqraftStorageContext } from '../../contexts/StorageContext';
-
-export type TReqraftStorageValue = string | number | boolean | Record<string | number, any> | any[];
-export type TReqraftUseStorage<T extends TReqraftStorageValue> = [
-  T,
-  (newStorage: T) => void,
-  () => void
-];
-
-export function useReqraftStorage<T extends TReqraftStorageValue>(
-  path: string,
-  defaultValue?: T,
-  includeAppPrefix?: boolean
-): TReqraftUseStorage<T> {
-  const { getStorage, updateStorage, removeStorageValue } = useContext(ReqraftStorageContext);
-
-  const value = useMemo(
-    () => getStorage(path, defaultValue, includeAppPrefix),
-    [path, defaultValue, includeAppPrefix, getStorage]
-  );
-
-  const updater = useCallback(
-    (newStorage: T) => {
-      updateStorage(path, newStorage, includeAppPrefix);
-    },
-    [path, includeAppPrefix, updateStorage]
-  );
-
-  const remover = useCallback(() => {
-    removeStorageValue(path, includeAppPrefix);
-  }, [path, includeAppPrefix, removeStorageValue]);
-
-  return useMemo(() => [value, updater, remover], [value, updater, remover]);
-}

package/src/hooks/useTemplates.ts

@@ -1,123 +0,0 @@
-import { IReqoreFormTemplates } from '@qoretechnologies/reqore/dist/components/Textarea';
-import { useMemo } from 'react';
-import { useAsyncRetry } from 'react-use';
-import { buildTemplates, ITemplatesPayload } from '../helpers/templates';
-import { queryUnlessCancelled } from '../utils/queryUnlessCancelled';
-
-export interface IUseTemplates {
-  loading: boolean;
-  error?: Error;
-  retry: () => void;
-  value?: IReqoreFormTemplates;
-}
-
-export const TemplatesCache = new Map<string, IReqoreFormTemplates>();
-
-/**
- * Hand this hook a `getContextData` payload the host has already fetched.
- *
- * The host and this library keep SEPARATE caches over one API, so a page that
- * has already paid for the context data pays again here — and, worse, waits for
- * it: `FormEngine` will not render a field before its templates exist, because
- * an any-typed field with no templates falls back to the type picker and asks
- * the author to choose `string`/`int`/`hash` for a value they already captured.
- *
- * Measured on the live alert rule: three form sections were placeholders from
- * 1459ms to 2039ms and, when they cleared, 193 elements that had been on screen
- * for ~590ms dropped 67px, because the placeholder is not the height of the
- * form it stands in for. Seeded, the form has its templates on its FIRST render
- * and there is no placeholder to swap out at all.
- *
- * Same shape as `seedQueryCache` for the type catalogue, and deliberately
- * first-write-wins: a real fetch that has already answered is not overwritten.
- */
-export const seedTemplatesCache = (
-  interfaceContext: string,
-  payload: ITemplatesPayload
-): void => {
-  if (!interfaceContext || TemplatesCache.has(interfaceContext)) {
-    return;
-  }
-
-  const templates = buildTemplates(payload);
-
-  if (templates) {
-    TemplatesCache.set(interfaceContext, templates);
-  }
-};
-
-/**
- * Templates for form fields. Ported from qorus-ide `useTemplates` with one
- * deliberate difference: fetching `system/getContextData` is **opt-in** via
- * `interfaceContext` (the IDE defaults to `'generic'` and always fetches).
- * Without a context, consumers keep passing templates in (`localTemplates`)
- * and no request is made — the original reqraft behavior.
- */
-export const useTemplates = (
-  allow?: boolean,
-  localTemplates: IReqoreFormTemplates = {},
-  interfaceContext?: string
-): IUseTemplates => {
-  const shouldFetch = !!allow && !!interfaceContext;
-
-  const globalTemplates = useAsyncRetry(async () => {
-    if (shouldFetch) {
-      /* Already answered — by a previous mount or by the host seeding it. The
-         cache was consulted for `loading` and for the value but not here, so a
-         seeded page still issued the request it had been handed the answer to. */
-      const cached = TemplatesCache.get(interfaceContext!);
-      if (cached) {
-        return cached;
-      }
-
-      const serverTemplates = await queryUnlessCancelled<ITemplatesPayload>({
-        url: `system/getContextData?interface_context=${interfaceContext}`,
-        method: 'PUT',
-      });
-
-      // An abandoned request (no response) is not an `error` for the caller to
-      // show; nothing is cached, so the next mount asks again.
-      if (serverTemplates?.ok) {
-        const templates = buildTemplates(serverTemplates.data) ?? {};
-
-        TemplatesCache.set(interfaceContext!, templates);
-
-        return templates;
-      }
-
-      return null;
-    }
-
-    return null;
-  }, [shouldFetch, interfaceContext]);
-
-  const templates: IReqoreFormTemplates | undefined = useMemo(() => {
-    if (!shouldFetch) {
-      return allow ? localTemplates || {} : undefined;
-    }
-
-    // If the local templates already include the global ones, use them as-is.
-    if (localTemplates?.items?.some(({ label }) => label === 'Context Data')) {
-      return localTemplates;
-    }
-
-    if (globalTemplates.loading && !TemplatesCache.has(interfaceContext!)) {
-      return undefined;
-    }
-
-    const globalTemplatesValue =
-      TemplatesCache.get(interfaceContext!) || globalTemplates.value || {};
-
-    return {
-      ...globalTemplatesValue,
-      items: [...(globalTemplatesValue?.items || []), ...(localTemplates?.items || [])],
-    };
-  }, [allow, shouldFetch, interfaceContext, globalTemplates, localTemplates]);
-
-  return {
-    loading: shouldFetch && globalTemplates.loading && !TemplatesCache.has(interfaceContext!),
-    error: globalTemplates.error,
-    retry: globalTemplates.retry,
-    value: templates,
-  };
-};

package/src/hooks/useValidation.ts

@@ -1,9 +0,0 @@
-import { TFormFieldType } from '../types/Form';
-
-// @ts-expect-error "need to implement this"
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-export const useValidation = (value: any, type?: TFormFieldType) => {
-  // Build validation...
-
-  return true;
-};