@norbix.ai/react-redux 1.5.0 → 1.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/README.md +32 -0
  2. package/dist/index.d.cts +2 -1
  3. package/dist/index.d.ts +2 -1
  4. package/package.json +3 -3
package/README.md CHANGED
@@ -366,6 +366,38 @@ it is a mutation only so a render is never served from the cache. The
366
366
  integration hooks can also be produced by `buildIntegrationsEndpoints` (next
367
367
  section) — the shipped ones above are the typed variants.
368
368
 
369
+ ## Scheduler
370
+
371
+ Every scheduler Hub endpoint (8) has a hook, 1:1 with `norbix.hub.scheduler`.
372
+ A task runs on a 5-field cron in UTC; only `EmailCampaign` tasks exist today.
373
+
374
+ | Area | Hooks | Cache tag |
375
+ | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ |
376
+ | Module switch | `useEnableSchedulerModuleMutation`, `useDisableSchedulerModuleMutation` (`PUT` on the wire from `@norbix.ai/ts` 4.6.0) | invalidates `Account`, `Projects`, `Scheduler` |
377
+ | Tasks | `useGetSchedulerTasksQuery`, `useGetSchedulerTaskQuery`, `useSaveSchedulerTaskMutation`, `useEnableSchedulerTaskMutation`, `useDisableSchedulerTaskMutation`, `useDeleteSchedulerTaskMutation` | provides / invalidates `Scheduler/LIST` and `Scheduler/<id>` |
378
+
379
+ ```tsx
380
+ const [save, { isLoading }] = useSaveSchedulerTaskMutation();
381
+
382
+ // Every Monday 09:00 UTC, send template tpl_123 to all users.
383
+ // initiatorUserId is the user the task runs as: you, or a project service user.
384
+ await save({
385
+ name: 'Weekly digest',
386
+ cron: '0 9 * * 1',
387
+ initiatorUserId: 'usr_123',
388
+ isEnabled: true,
389
+ stopOnError: false,
390
+ task: {
391
+ type: 'EmailCampaign',
392
+ campaign: { source: 'AllUsers', templateId: 'tpl_123' },
393
+ },
394
+ });
395
+ ```
396
+
397
+ The typed `task` body (plain `'EmailCampaign'` / `'AllUsers'` strings, no
398
+ cast) comes from `@norbix.ai/ts` 4.6.0. Full method reference: the core SDK's
399
+ `docs/hub/scheduler.md`.
400
+
369
401
  ## Working with terms
370
402
 
371
403
  A **taxonomy** is a named tree of **terms** (labels). A term can have one parent (a clean hierarchy) or several parents (the same item under many categories). There is one read hook per scenario — pick the one that matches what you want:
package/dist/index.d.cts CHANGED
@@ -2,6 +2,7 @@ import * as _reduxjs_toolkit_query_react from '@reduxjs/toolkit/query/react';
2
2
  import * as _norbix_ai_ts from '@norbix.ai/ts';
3
3
  import { Norbix } from '@norbix.ai/ts';
4
4
  import * as _norbix_ai_ts_types_api from '@norbix.ai/ts/types/api';
5
+ import * as _norbix_ai_ts_hub from '@norbix.ai/ts/hub';
5
6
  import * as _norbix_ai_ts_types_hub from '@norbix.ai/ts/types/hub';
6
7
  import * as _reduxjs_toolkit_query from '@reduxjs/toolkit/query';
7
8
  import { BaseQueryFn, EndpointBuilder } from '@reduxjs/toolkit/query';
@@ -148,7 +149,7 @@ declare function createNorbixApi(getClient: GetNorbixClient, options?: {
148
149
  disableSchedulerModule: _reduxjs_toolkit_query.MutationDefinition<Partial<_norbix_ai_ts_types_hub.CodeMashHub2.DisableScheduler> | undefined, _reduxjs_toolkit_query.BaseQueryFn<NorbixCall<unknown>, unknown, SerializedNorbixError>, AllTags, _norbix_ai_ts_types_hub.CodeMashHub2.EmptyResponse, string, unknown>;
149
150
  getSchedulerTasks: _reduxjs_toolkit_query.QueryDefinition<Partial<_norbix_ai_ts_types_hub.CodeMashHub2.GetSchedulerTasks> | undefined, _reduxjs_toolkit_query.BaseQueryFn<NorbixCall<unknown>, unknown, SerializedNorbixError>, AllTags, _norbix_ai_ts_types_hub.CodeMashHub2.GetSchedulerTasksResponse, string, unknown>;
150
151
  getSchedulerTask: _reduxjs_toolkit_query.QueryDefinition<Partial<_norbix_ai_ts_types_hub.CodeMashHub2.GetSchedulerTask> | undefined, _reduxjs_toolkit_query.BaseQueryFn<NorbixCall<unknown>, unknown, SerializedNorbixError>, AllTags, _norbix_ai_ts_types_hub.CodeMashHub2.GetSchedulerTaskResponse, string, unknown>;
151
- saveSchedulerTask: _reduxjs_toolkit_query.MutationDefinition<Partial<_norbix_ai_ts_types_hub.CodeMashHub2.SaveSchedulerTaskRequest> | undefined, _reduxjs_toolkit_query.BaseQueryFn<NorbixCall<unknown>, unknown, SerializedNorbixError>, AllTags, _norbix_ai_ts_types_hub.CodeMashHub2.IdResponse, string, unknown>;
152
+ saveSchedulerTask: _reduxjs_toolkit_query.MutationDefinition<_norbix_ai_ts_hub.SaveSchedulerTaskInput | undefined, _reduxjs_toolkit_query.BaseQueryFn<NorbixCall<unknown>, unknown, SerializedNorbixError>, AllTags, _norbix_ai_ts_types_hub.CodeMashHub2.IdResponse, string, unknown>;
152
153
  enableSchedulerTask: _reduxjs_toolkit_query.MutationDefinition<Partial<_norbix_ai_ts_types_hub.CodeMashHub2.EnableSchedulerTask> | undefined, _reduxjs_toolkit_query.BaseQueryFn<NorbixCall<unknown>, unknown, SerializedNorbixError>, AllTags, _norbix_ai_ts_types_hub.CodeMashHub2.EmptyResponse, string, unknown>;
153
154
  disableSchedulerTask: _reduxjs_toolkit_query.MutationDefinition<Partial<_norbix_ai_ts_types_hub.CodeMashHub2.DisableSchedulerTask> | undefined, _reduxjs_toolkit_query.BaseQueryFn<NorbixCall<unknown>, unknown, SerializedNorbixError>, AllTags, _norbix_ai_ts_types_hub.CodeMashHub2.EmptyResponse, string, unknown>;
154
155
  deleteSchedulerTask: _reduxjs_toolkit_query.MutationDefinition<Partial<_norbix_ai_ts_types_hub.CodeMashHub2.DeleteSchedulerTask> | undefined, _reduxjs_toolkit_query.BaseQueryFn<NorbixCall<unknown>, unknown, SerializedNorbixError>, AllTags, _norbix_ai_ts_types_hub.CodeMashHub2.EmptyResponse, string, unknown>;
package/dist/index.d.ts CHANGED
@@ -2,6 +2,7 @@ import * as _reduxjs_toolkit_query_react from '@reduxjs/toolkit/query/react';
2
2
  import * as _norbix_ai_ts from '@norbix.ai/ts';
3
3
  import { Norbix } from '@norbix.ai/ts';
4
4
  import * as _norbix_ai_ts_types_api from '@norbix.ai/ts/types/api';
5
+ import * as _norbix_ai_ts_hub from '@norbix.ai/ts/hub';
5
6
  import * as _norbix_ai_ts_types_hub from '@norbix.ai/ts/types/hub';
6
7
  import * as _reduxjs_toolkit_query from '@reduxjs/toolkit/query';
7
8
  import { BaseQueryFn, EndpointBuilder } from '@reduxjs/toolkit/query';
@@ -148,7 +149,7 @@ declare function createNorbixApi(getClient: GetNorbixClient, options?: {
148
149
  disableSchedulerModule: _reduxjs_toolkit_query.MutationDefinition<Partial<_norbix_ai_ts_types_hub.CodeMashHub2.DisableScheduler> | undefined, _reduxjs_toolkit_query.BaseQueryFn<NorbixCall<unknown>, unknown, SerializedNorbixError>, AllTags, _norbix_ai_ts_types_hub.CodeMashHub2.EmptyResponse, string, unknown>;
149
150
  getSchedulerTasks: _reduxjs_toolkit_query.QueryDefinition<Partial<_norbix_ai_ts_types_hub.CodeMashHub2.GetSchedulerTasks> | undefined, _reduxjs_toolkit_query.BaseQueryFn<NorbixCall<unknown>, unknown, SerializedNorbixError>, AllTags, _norbix_ai_ts_types_hub.CodeMashHub2.GetSchedulerTasksResponse, string, unknown>;
150
151
  getSchedulerTask: _reduxjs_toolkit_query.QueryDefinition<Partial<_norbix_ai_ts_types_hub.CodeMashHub2.GetSchedulerTask> | undefined, _reduxjs_toolkit_query.BaseQueryFn<NorbixCall<unknown>, unknown, SerializedNorbixError>, AllTags, _norbix_ai_ts_types_hub.CodeMashHub2.GetSchedulerTaskResponse, string, unknown>;
151
- saveSchedulerTask: _reduxjs_toolkit_query.MutationDefinition<Partial<_norbix_ai_ts_types_hub.CodeMashHub2.SaveSchedulerTaskRequest> | undefined, _reduxjs_toolkit_query.BaseQueryFn<NorbixCall<unknown>, unknown, SerializedNorbixError>, AllTags, _norbix_ai_ts_types_hub.CodeMashHub2.IdResponse, string, unknown>;
152
+ saveSchedulerTask: _reduxjs_toolkit_query.MutationDefinition<_norbix_ai_ts_hub.SaveSchedulerTaskInput | undefined, _reduxjs_toolkit_query.BaseQueryFn<NorbixCall<unknown>, unknown, SerializedNorbixError>, AllTags, _norbix_ai_ts_types_hub.CodeMashHub2.IdResponse, string, unknown>;
152
153
  enableSchedulerTask: _reduxjs_toolkit_query.MutationDefinition<Partial<_norbix_ai_ts_types_hub.CodeMashHub2.EnableSchedulerTask> | undefined, _reduxjs_toolkit_query.BaseQueryFn<NorbixCall<unknown>, unknown, SerializedNorbixError>, AllTags, _norbix_ai_ts_types_hub.CodeMashHub2.EmptyResponse, string, unknown>;
153
154
  disableSchedulerTask: _reduxjs_toolkit_query.MutationDefinition<Partial<_norbix_ai_ts_types_hub.CodeMashHub2.DisableSchedulerTask> | undefined, _reduxjs_toolkit_query.BaseQueryFn<NorbixCall<unknown>, unknown, SerializedNorbixError>, AllTags, _norbix_ai_ts_types_hub.CodeMashHub2.EmptyResponse, string, unknown>;
154
155
  deleteSchedulerTask: _reduxjs_toolkit_query.MutationDefinition<Partial<_norbix_ai_ts_types_hub.CodeMashHub2.DeleteSchedulerTask> | undefined, _reduxjs_toolkit_query.BaseQueryFn<NorbixCall<unknown>, unknown, SerializedNorbixError>, AllTags, _norbix_ai_ts_types_hub.CodeMashHub2.EmptyResponse, string, unknown>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@norbix.ai/react-redux",
3
- "version": "1.5.0",
3
+ "version": "1.6.0",
4
4
  "description": "Official Norbix bindings for React + Redux Toolkit. RTK Query helpers (cache, dedup, refetch, invalidation) over the typed Norbix SDK.",
5
5
  "author": "UAB Isidos",
6
6
  "license": "MIT",
@@ -59,7 +59,7 @@
59
59
  "prepublishOnly": "npm run build"
60
60
  },
61
61
  "peerDependencies": {
62
- "@norbix.ai/ts": ">=4.3.0",
62
+ "@norbix.ai/ts": ">=4.6.0",
63
63
  "@reduxjs/toolkit": ">=2.0.0",
64
64
  "react": ">=18.0.0",
65
65
  "react-redux": ">=9.0.0"
@@ -68,7 +68,7 @@
68
68
  "@commitlint/cli": "^21.2.2",
69
69
  "@commitlint/config-conventional": "^21.2.2",
70
70
  "@eslint/js": "^10.0.1",
71
- "@norbix.ai/ts": "^4.4.0",
71
+ "@norbix.ai/ts": "^4.6.0",
72
72
  "@reduxjs/toolkit": "^2.12.0",
73
73
  "@semantic-release/commit-analyzer": "^13.0.1",
74
74
  "@semantic-release/github": "^12.0.9",