@lotics/app-sdk 0.105.0 → 0.106.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.
- package/dist/index.d.ts +1 -1
- package/dist/index.js +14 -6
- package/dist/queries.d.ts +17 -0
- package/docs/data_fetching.md +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -6,7 +6,7 @@ export type { AppErrorKind } from "./error_report.js";
|
|
|
6
6
|
export { useWorkflow, useWorkflows, writesSettled, useFileUpload, useAttachments, useAttachmentPiles, useMembers, useAgentRun, useAgentRuns, useAiContext, buildChoiceOutput, } from "./hooks.js";
|
|
7
7
|
export type { UploadedFile, WorkflowResult, MembersOptions, AgentRunOptions, UseAgentRun, AgentRunLanding, AgentRunRecord, AgentRunState, AgentUIPart, PendingChoice, ChoiceQuestion, ChoiceOption, AskUserChoiceOutput, } from "./hooks.js";
|
|
8
8
|
export { useQuery, useQueries, queryAll, exportQuery, useFieldOptions } from "./queries.js";
|
|
9
|
-
export type { QueryRow, QueryCall, QueryState, RowOf, QueryOptions, ColumnKeyOf, QuerySortKey, QueryFilter, QueryFilterCondition, QueryFilterFieldCondition, QueryFilterRecordIdCondition, QueryFilterGroup, FieldOptions, FieldOptionsState, FieldOptionsOptions, FigureUnits, ExportCall, ExportFile, ExportReport, } from "./queries.js";
|
|
9
|
+
export type { QueryRow, QueryCall, QueryState, RowOf, QueryOptions, ColumnKeyOf, QuerySortKey, QueryFilter, QueryFilterCondition, QueryFilterFieldCondition, QueryFilterRecordIdCondition, QueryFilterGroup, FieldOptions, FieldOptionsState, FieldOptionsOptions, FigureUnits, ExportCall, ExportFile, ExportReport, ExportTab, } from "./queries.js";
|
|
10
10
|
export type { AttachedFile, AttachmentPiles, AttachmentPilesOptions, AttachmentsOptions, AttachmentsState } from "./attachments.js";
|
|
11
11
|
export { useComments, useCommentCounts } from "./comments.js";
|
|
12
12
|
export type { AppComment, AppCommentAuthor, AppCommentFile, CommentsState, UseCommentsArgs, CommentCountsState, UseCommentCountsArgs, } from "./comments.js";
|
package/dist/index.js
CHANGED
|
@@ -23712,8 +23712,8 @@ var templatePartSchema = zod_default.lazy(
|
|
|
23712
23712
|
var MODEL_TIERS = ["haiku", "sonnet", "opus"];
|
|
23713
23713
|
var TIER_MODELS = {
|
|
23714
23714
|
haiku: "claude-haiku-4-5",
|
|
23715
|
-
sonnet: "claude-sonnet-5",
|
|
23716
|
-
opus: "claude-opus-5"
|
|
23715
|
+
sonnet: "claude-sonnet-5-5",
|
|
23716
|
+
opus: "claude-opus-5-5"
|
|
23717
23717
|
};
|
|
23718
23718
|
var RESOLVED_MODEL_IDS = MODEL_TIERS.map(
|
|
23719
23719
|
(tier) => TIER_MODELS[tier]
|
|
@@ -24214,13 +24214,20 @@ var appWorkflowContractSchema = zod_default.object({
|
|
|
24214
24214
|
inputs: zod_default.record(zod_default.string(), appWorkflowInputSchema).optional(),
|
|
24215
24215
|
outputs: zod_default.record(zod_default.string(), appWorkflowOutputSchema).optional()
|
|
24216
24216
|
});
|
|
24217
|
-
var APP_EXPORT_REPORT_KEYS = ["title", "lines", "readings", "at", "dates"];
|
|
24217
|
+
var APP_EXPORT_REPORT_KEYS = ["title", "lines", "readings", "at", "dates", "period", "per"];
|
|
24218
24218
|
var appExportTemplateSchema = zod_default.object({
|
|
24219
24219
|
template_id: zod_default.string().min(1).describe("The document template (`dtl_\u2026`) filled: an Excel workbook, or an HTML page made a PDF."),
|
|
24220
24220
|
rows: zod_default.string().regex(APP_ALIAS_REGEX).refine((key) => !APP_EXPORT_REPORT_KEYS.some((taken) => taken === key), {
|
|
24221
24221
|
message: `The rows are listed under a key of their own, never ${APP_EXPORT_REPORT_KEYS.join(", ")}.`
|
|
24222
|
-
}).describe(`The key the template lists the rows under, beside ${APP_EXPORT_REPORT_KEYS.join(", ")}.`)
|
|
24223
|
-
|
|
24222
|
+
}).describe(`The key the template lists the rows under, beside ${APP_EXPORT_REPORT_KEYS.join(", ")}.`),
|
|
24223
|
+
tabs: zod_default.array(
|
|
24224
|
+
zod_default.string().regex(APP_ALIAS_REGEX).refine((key) => !APP_EXPORT_REPORT_KEYS.some((taken) => taken === key), {
|
|
24225
|
+
message: `A tab's rows are listed under a key of their own, never ${APP_EXPORT_REPORT_KEYS.join(", ")}.`
|
|
24226
|
+
})
|
|
24227
|
+
).min(1).optional().describe("The keys each of a register's tabs lists its rows under, beside the rows; every export filling the template sends exactly these.")
|
|
24228
|
+
}).strict().refine((declared) => declared.tabs === void 0 || new Set(declared.tabs).size === declared.tabs.length && !declared.tabs.includes(declared.rows), {
|
|
24229
|
+
message: "Each tab is listed under a key of its own, apart from the rows."
|
|
24230
|
+
});
|
|
24224
24231
|
var appQueryDeclarationSchema = zod_default.object({
|
|
24225
24232
|
ast: zod_default.unknown().describe(
|
|
24226
24233
|
"Query AST template (a QueryNode). Validated server-side via parseQueryNode at deploy. May embed {{params.<name>}} tokens in filter value positions."
|
|
@@ -30975,7 +30982,8 @@ async function queryAll(alias, params = {}, opts = {}) {
|
|
|
30975
30982
|
}
|
|
30976
30983
|
async function exportQuery(alias, call) {
|
|
30977
30984
|
const sort = call.sort === void 0 || call.sort.length === 0 ? void 0 : [...call.sort];
|
|
30978
|
-
const
|
|
30985
|
+
const tabs = call.tabs?.map((tab) => ({ ...tab, sort: tab.sort === void 0 || tab.sort.length === 0 ? void 0 : [...tab.sort] }));
|
|
30986
|
+
const body = { alias, params: call.params ?? {}, filter: call.filter, sort, ...tabs === void 0 ? {} : { tabs }, report: call.report, file: call.file };
|
|
30979
30987
|
const mocked = getMockExport(alias);
|
|
30980
30988
|
if (mocked !== null) return mocked(body);
|
|
30981
30989
|
return (await rpc("export", body)).file;
|
package/dist/queries.d.ts
CHANGED
|
@@ -191,6 +191,20 @@ export interface ExportReport {
|
|
|
191
191
|
}>;
|
|
192
192
|
/** The file's name, in the template grammar over the report; absent, the template's name, or `title`. */
|
|
193
193
|
filename?: string;
|
|
194
|
+
/** The period a register's tabs read their rows over: its bounds, a day or a minute of one, with no zone. */
|
|
195
|
+
period?: {
|
|
196
|
+
from: string;
|
|
197
|
+
to: string;
|
|
198
|
+
};
|
|
199
|
+
/** The value the report was picked for (its `per`), as the reader names it. */
|
|
200
|
+
per?: string;
|
|
201
|
+
}
|
|
202
|
+
/** One tab of the register: its rows read as the export's own are — same query and params — under its own filter and order. */
|
|
203
|
+
export interface ExportTab {
|
|
204
|
+
tab: string;
|
|
205
|
+
label: string;
|
|
206
|
+
filter?: QueryFilter;
|
|
207
|
+
sort?: readonly QuerySortKey[];
|
|
194
208
|
}
|
|
195
209
|
/** The file an export makes: the default report workbook — its words in `language`, the rows under `columns` on the
|
|
196
210
|
* tab `sheet` — or a template the query declares under `templates`, by its name there. */
|
|
@@ -207,6 +221,9 @@ export interface ExportCall {
|
|
|
207
221
|
params?: Record<string, unknown>;
|
|
208
222
|
filter?: QueryFilter;
|
|
209
223
|
sort?: readonly QuerySortKey[];
|
|
224
|
+
/** A register's tabs, each one's rows beside the call's own (the open tab's): a template reads them under each
|
|
225
|
+
* tab's name, the workbook holds one sheet per tab. */
|
|
226
|
+
tabs?: readonly ExportTab[];
|
|
210
227
|
report: ExportReport;
|
|
211
228
|
file: ExportFile;
|
|
212
229
|
}
|
package/docs/data_fetching.md
CHANGED
|
@@ -24,7 +24,7 @@ untyped. It is written from the app's live bindings by `lotics app create --cust
|
|
|
24
24
|
| `useQuery(alias, params?, { rows: false, total: true })` | `total` only, no rows (`total: { by: column }` adds `counts`) | a facet chip, a queue badge, an "N awaiting approval" tile — the size of a set you are not listing |
|
|
25
25
|
| `useQueries(calls, opts?)` | one state per `{ alias, params?, filter?, sort?, aggregate?, total?, rows? }`, in order — a `sort` orders that call's rows before the cap cuts them | reads that are DATA — a list known only at render, one read per item, or one count per stage (`rows: false, total: true`, each state's `.total`); the deploy's alias scan reads a list as dynamic, so every alias in it is still declared. With `aggregate` a call answers the groups of its filtered rows instead of the rows ([queries](./queries.md)) |
|
|
26
26
|
| `queryAll(alias, params?, { filter, sort })` | a promise of every row | outside React, for a job that must hold the whole narrowed set in the browser (the ids an act runs on): it asks page after page until the server says the set ended, never stopping at the 10,000-row cap. The server's rows as stored — no write of this app is drawn over them |
|
|
27
|
-
| `exportQuery(alias, { params, filter, sort, report, file })` | a promise of the file | every row the narrowed set holds, made into one file by the server — no row reaches the browser. `report` is `{ title, lines, readings, dates?, filename? }` — `dates` each date filter's `{ from?, to? }` by field alias, each bound a day (`yyyy-MM-dd`) or a minute of one (`yyyy-MM-ddTHH:mm`) with no zone; `filename` the file's name in the template grammar over one value each — `title`, `at` (the moment the server made the file), `dates.<field>.from` or `.to`, `lines | lookup:<n>` — at most 200 bytes once filled (absent, the template's name, or `title`); `file` is `{ kind: "workbook", language, sheet, columns }` (the default report workbook, its head closing with the moment the server made it, each column `{ key, header, type }` an output column of the query — a `number` one on a number column, a `date` one on a date or datetime) or `{ kind: "template", template }`, one the query declares under `templates` by name ([queries](./queries.md)). Past 20,000 rows it rejects, never cuts; each caller makes at most 60 exports a minute. The file's `url` is signed for the caller: open it with `openExternal` |
|
|
27
|
+
| `exportQuery(alias, { params, filter, sort, tabs?, report, file })` | a promise of the file | every row the narrowed set holds, made into one file by the server — no row reaches the browser. `tabs` (2 to 5, each `{ tab, label, filter?, sort? }`) are each read as the export's own rows are — same query and params, under the tab's own filter and sort (absent, the declared order) — and a template reads each one's rows under its `tab`, a name none of the report's keys nor the template's `rows` key holds. `report` is `{ title, lines, readings, dates?, period?, per?, filename? }` — `dates` each date filter's `{ from?, to? }` by field alias, each bound a day (`yyyy-MM-dd`) or a minute of one (`yyyy-MM-ddTHH:mm`) with no zone; `period` the tabs' `{ from, to }`, bounds of the same form; `per` the value the report was picked for, in the reader's words; `filename` the file's name in the template grammar over one value each — `title`, `at` (the moment the server made the file), `dates.<field>.from` or `.to`, `period.from` or `.to`, `per`, `lines | lookup:<n>` — at most 200 bytes once filled (absent, the template's name, or `title`); `file` is `{ kind: "workbook", language, sheet, columns }` (the default report workbook, its head closing with the moment the server made it, each column `{ key, header, type }` an output column of the query — a `number` one on a number column, a `date` one on a date or datetime; with `tabs`, one sheet per tab named by its `label` in place of `sheet`) or `{ kind: "template", template }`, one the query declares under `templates` by name ([queries](./queries.md)). Past 20,000 rows, in any tab, it rejects, never cuts; each caller makes at most 60 exports a minute. The file's `url` is signed for the caller: open it with `openExternal` |
|
|
28
28
|
|
|
29
29
|
Every hook answers the same `QueryState`: `rows`, `truncated`, `total`, `counts`, `loading`,
|
|
30
30
|
`isValidating`, `error`, `pending`, `refetch`, `page`, `setPage`, `pageCount`, `hasMore`,
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@lotics/app-sdk",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.106.0",
|
|
4
4
|
"description": "The SDK a Lotics custom-code app reads and writes through \u2014 typed hooks over the host bridge, cell readers, mount() and AppRouter",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"exports": {
|