@hitch42/applet 0.1.1-beta.7 → 0.1.1-beta.9

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 (177) hide show
  1. package/dist/_internal/client.js +120 -11
  2. package/dist/_internal/log-context.d.ts +34 -0
  3. package/dist/_internal/log-context.js +2 -0
  4. package/dist/_internal/server.d.ts +14 -1
  5. package/dist/_internal/server.js +122 -118
  6. package/dist/applet.js +22 -11
  7. package/dist/build-Bh_S5BUv.js +2 -0
  8. package/dist/{build-DauirTcY.js → build-CEfFoIZZ.js} +1 -1
  9. package/dist/{ci-gPrwo6C0.js → ci-BKw14X2h.js} +14 -13
  10. package/dist/client.d.ts +3 -3
  11. package/dist/{contract-DB9QQhD9.d.ts → contract-CsUpTBe0.d.ts} +1 -1
  12. package/dist/{deploy-CqrtNJ1x.js → deploy-wGYjwXrx.js} +139 -88
  13. package/dist/email-DBTVhNB_.js +62 -0
  14. package/dist/{generate-BIifT6PK.js → generate-BEIYs17x.js} +70 -32
  15. package/dist/generate-Dox-OYt6.js +2 -0
  16. package/dist/headers-DkNr9MLJ.js +17 -0
  17. package/dist/index.d.ts +122 -10
  18. package/dist/index.js +142 -26
  19. package/dist/{init-Wu6XmyVc.js → init-6oGPM46R.js} +15 -17
  20. package/dist/{load-config-BknBkdRs.js → load-config-xEdTXs0y.js} +2 -2
  21. package/dist/log-context-zu8U9Sjm.js +73 -0
  22. package/dist/{login-iT9MRuaw.js → login-CUx3TmFQ.js} +1 -1
  23. package/dist/{logs-B-qZGXSK.js → logs-DSjuEN0Q.js} +20 -22
  24. package/dist/{manifest-C489nYUy.d.ts → manifest-C6_F4bL8.d.ts} +7 -0
  25. package/dist/{manifest-Bd04cWhu.js → manifest-CJSL9GuC.js} +22 -3
  26. package/dist/me-BW7Paary.js +32 -0
  27. package/dist/{project-C_rtpjp8.js → project-BRZGd6xq.js} +202 -20
  28. package/dist/prompt-ChS-grYO.js +29 -0
  29. package/dist/query-cache-CXmAyLv3.js +82 -0
  30. package/dist/react.d.ts +3 -2
  31. package/dist/react.js +98 -80
  32. package/dist/schedules-C8_Svr4h.js +42 -0
  33. package/dist/server.d.ts +9 -4
  34. package/dist/server.js +29 -8
  35. package/dist/telephony-protocol-D-nf3Gca.d.ts +76 -0
  36. package/dist/telephony.d.ts +97 -0
  37. package/dist/telephony.js +726 -0
  38. package/dist/{upload-YbRKEqR6.d.ts → upload-DKZzz5kW.d.ts} +6 -6
  39. package/dist/{variables-DcwMeIau.js → variables-DT5RyHdH.js} +14 -39
  40. package/dist/vite.d.ts +3 -60
  41. package/dist/vite.js +497 -27
  42. package/dist/workflow-engine-BOTzURKM.js +111 -0
  43. package/dist/{workspace-B6lenAS5.js → workspace-D0dnnlxL.js} +37 -39
  44. package/package.json +18 -5
  45. package/scaffold/.agents/skills/hitch-applets/SKILL.md +50 -18
  46. package/scaffold/.agents/skills/hitch-applets/references/email-tracking.md +49 -0
  47. package/scaffold/.agents/skills/hitch-applets/references/files.md +3 -3
  48. package/scaffold/.agents/skills/hitch-applets/references/manifest.md +12 -2
  49. package/scaffold/.agents/skills/hitch-applets/references/markdown.md +2 -0
  50. package/scaffold/.agents/skills/hitch-applets/references/performance.md +1 -1
  51. package/scaffold/.agents/skills/hitch-applets/references/records.md +27 -4
  52. package/scaffold/.agents/skills/hitch-applets/references/schedules.md +7 -2
  53. package/scaffold/.agents/skills/hitch-applets/references/server.md +0 -3
  54. package/scaffold/.agents/skills/hitch-applets/references/workflows.md +11 -3
  55. package/scaffold/.agents/skills/hitch-cli/SKILL.md +20 -20
  56. package/scaffold/.agents/skills/hitch-data/SKILL.md +3 -2
  57. package/scaffold/.agents/skills/hitch-data/references/attributes.md +7 -1
  58. package/scaffold/.agents/skills/hitch-data/references/limits.md +23 -23
  59. package/scaffold/.agents/skills/hitch-theory/SKILL.md +151 -0
  60. package/scaffold/.agents/skills/react-best-practices/SKILL.md +127 -0
  61. package/scaffold/.agents/skills/react-best-practices/rules/advanced-effect-event-deps.md +50 -0
  62. package/scaffold/.agents/skills/react-best-practices/rules/advanced-event-handler-refs.md +55 -0
  63. package/scaffold/.agents/skills/react-best-practices/rules/advanced-init-once.md +42 -0
  64. package/scaffold/.agents/skills/react-best-practices/rules/advanced-use-latest.md +39 -0
  65. package/scaffold/.agents/skills/react-best-practices/rules/async-cheap-condition-before-await.md +37 -0
  66. package/scaffold/.agents/skills/react-best-practices/rules/async-defer-await.md +82 -0
  67. package/scaffold/.agents/skills/react-best-practices/rules/async-dependencies.md +48 -0
  68. package/scaffold/.agents/skills/react-best-practices/rules/async-parallel.md +24 -0
  69. package/scaffold/.agents/skills/react-best-practices/rules/bundle-analyzable-paths.md +42 -0
  70. package/scaffold/.agents/skills/react-best-practices/rules/bundle-barrel-imports.md +39 -0
  71. package/scaffold/.agents/skills/react-best-practices/rules/bundle-conditional.md +35 -0
  72. package/scaffold/.agents/skills/react-best-practices/rules/bundle-defer-third-party.md +46 -0
  73. package/scaffold/.agents/skills/react-best-practices/rules/bundle-dynamic-imports.md +38 -0
  74. package/scaffold/.agents/skills/react-best-practices/rules/bundle-preload.md +40 -0
  75. package/scaffold/.agents/skills/react-best-practices/rules/client-event-listeners.md +78 -0
  76. package/scaffold/.agents/skills/react-best-practices/rules/client-localstorage-schema.md +74 -0
  77. package/scaffold/.agents/skills/react-best-practices/rules/client-passive-event-listeners.md +48 -0
  78. package/scaffold/.agents/skills/react-best-practices/rules/js-batch-dom-css.md +110 -0
  79. package/scaffold/.agents/skills/react-best-practices/rules/js-cache-function-results.md +58 -0
  80. package/scaffold/.agents/skills/react-best-practices/rules/js-cache-property-access.md +28 -0
  81. package/scaffold/.agents/skills/react-best-practices/rules/js-cache-storage.md +56 -0
  82. package/scaffold/.agents/skills/react-best-practices/rules/js-combine-iterations.md +32 -0
  83. package/scaffold/.agents/skills/react-best-practices/rules/js-early-exit.md +50 -0
  84. package/scaffold/.agents/skills/react-best-practices/rules/js-flatmap-filter.md +51 -0
  85. package/scaffold/.agents/skills/react-best-practices/rules/js-hoist-regexp.md +45 -0
  86. package/scaffold/.agents/skills/react-best-practices/rules/js-index-maps.md +37 -0
  87. package/scaffold/.agents/skills/react-best-practices/rules/js-length-check-first.md +50 -0
  88. package/scaffold/.agents/skills/react-best-practices/rules/js-min-max-loop.md +82 -0
  89. package/scaffold/.agents/skills/react-best-practices/rules/js-request-idle-callback.md +104 -0
  90. package/scaffold/.agents/skills/react-best-practices/rules/js-set-map-lookups.md +24 -0
  91. package/scaffold/.agents/skills/react-best-practices/rules/js-tosorted-immutable.md +57 -0
  92. package/scaffold/.agents/skills/react-best-practices/rules/rendering-activity.md +26 -0
  93. package/scaffold/.agents/skills/react-best-practices/rules/rendering-animate-svg-wrapper.md +38 -0
  94. package/scaffold/.agents/skills/react-best-practices/rules/rendering-conditional-render.md +32 -0
  95. package/scaffold/.agents/skills/react-best-practices/rules/rendering-content-visibility.md +38 -0
  96. package/scaffold/.agents/skills/react-best-practices/rules/rendering-hoist-jsx.md +36 -0
  97. package/scaffold/.agents/skills/react-best-practices/rules/rendering-resource-hints.md +81 -0
  98. package/scaffold/.agents/skills/react-best-practices/rules/rendering-script-defer-async.md +36 -0
  99. package/scaffold/.agents/skills/react-best-practices/rules/rendering-svg-precision.md +28 -0
  100. package/scaffold/.agents/skills/react-best-practices/rules/rendering-usetransition-loading.md +43 -0
  101. package/scaffold/.agents/skills/react-best-practices/rules/rerender-defer-reads.md +39 -0
  102. package/scaffold/.agents/skills/react-best-practices/rules/rerender-dependencies.md +45 -0
  103. package/scaffold/.agents/skills/react-best-practices/rules/rerender-derived-state-no-effect.md +40 -0
  104. package/scaffold/.agents/skills/react-best-practices/rules/rerender-derived-state.md +29 -0
  105. package/scaffold/.agents/skills/react-best-practices/rules/rerender-functional-setstate.md +77 -0
  106. package/scaffold/.agents/skills/react-best-practices/rules/rerender-lazy-state-init.md +56 -0
  107. package/scaffold/.agents/skills/react-best-practices/rules/rerender-memo-with-default-value.md +36 -0
  108. package/scaffold/.agents/skills/react-best-practices/rules/rerender-memo.md +44 -0
  109. package/scaffold/.agents/skills/react-best-practices/rules/rerender-move-effect-to-event.md +45 -0
  110. package/scaffold/.agents/skills/react-best-practices/rules/rerender-no-inline-components.md +75 -0
  111. package/scaffold/.agents/skills/react-best-practices/rules/rerender-simple-expression-in-memo.md +35 -0
  112. package/scaffold/.agents/skills/react-best-practices/rules/rerender-split-combined-hooks.md +64 -0
  113. package/scaffold/.agents/skills/react-best-practices/rules/rerender-transitions.md +40 -0
  114. package/scaffold/.agents/skills/react-best-practices/rules/rerender-use-deferred-value.md +59 -0
  115. package/scaffold/.agents/skills/react-best-practices/rules/rerender-use-ref-transient-values.md +73 -0
  116. package/scaffold/.agents/skills/tanstack-query/SKILL.md +136 -0
  117. package/scaffold/.agents/skills/tanstack-query/references/compositions/automatic-invalidation-after-mutations.md +124 -0
  118. package/scaffold/.agents/skills/tanstack-query/references/compositions/broadcast-realtime-and-multi-tab-synchronization.md +150 -0
  119. package/scaffold/.agents/skills/tanstack-query/references/compositions/compose-query-with-tanstack-router-and-start.md +248 -0
  120. package/scaffold/.agents/skills/tanstack-query/references/compositions/enforce-query-best-practices-with-eslint.md +167 -0
  121. package/scaffold/.agents/skills/tanstack-query/references/compositions/persist-offline-and-restore-caches.md +181 -0
  122. package/scaffold/.agents/skills/tanstack-query/references/compositions/query-data-and-forms.md +156 -0
  123. package/scaffold/.agents/skills/tanstack-query/references/core/build-query-abstractions.md +130 -0
  124. package/scaffold/.agents/skills/tanstack-query/references/core/cancel-queries-and-consume-abort-signals.md +176 -0
  125. package/scaffold/.agents/skills/tanstack-query/references/core/concurrent-optimistic-updates.md +135 -0
  126. package/scaffold/.agents/skills/tanstack-query/references/core/coordinate-query-execution.md +188 -0
  127. package/scaffold/.agents/skills/tanstack-query/references/core/design-query-keys-and-options.md +182 -0
  128. package/scaffold/.agents/skills/tanstack-query/references/core/fetch-and-observe-queries.md +193 -0
  129. package/scaffold/.agents/skills/tanstack-query/references/core/implement-optimistic-updates-and-cache-writes.md +168 -0
  130. package/scaffold/.agents/skills/tanstack-query/references/core/paginate-and-build-infinite-queries.md +188 -0
  131. package/scaffold/.agents/skills/tanstack-query/references/core/seed-placeholder-select-and-transform-data.md +188 -0
  132. package/scaffold/.agents/skills/tanstack-query/references/core/selectors-and-derived-state.md +145 -0
  133. package/scaffold/.agents/skills/tanstack-query/references/core/tune-defaults-freshness-retries-and-refetching.md +172 -0
  134. package/scaffold/.agents/skills/tanstack-query/references/core/understand-query-internals-and-observers.md +104 -0
  135. package/scaffold/.agents/skills/tanstack-query/references/core/write-mutations-and-invalidate-related-queries.md +183 -0
  136. package/scaffold/.agents/skills/tanstack-query/references/framework/debug-with-devtools.md +169 -0
  137. package/scaffold/.agents/skills/tanstack-query/references/framework/handle-status-and-errors.md +119 -0
  138. package/scaffold/.agents/skills/tanstack-query/references/framework/shape-data-and-render-efficiently.md +184 -0
  139. package/scaffold/.agents/skills/tanstack-query/references/framework/use-framework-adapter-reactivity.md +185 -0
  140. package/scaffold/.agents/skills/tanstack-query/references/framework/use-suspense-and-error-boundaries.md +208 -0
  141. package/scaffold/.agents/skills/tanstack-query/references/lifecycle/migrate-major-versions-and-codemods.md +169 -0
  142. package/scaffold/.agents/skills/tanstack-query/references/lifecycle/prefetch-and-remove-request-waterfalls.md +228 -0
  143. package/scaffold/.agents/skills/tanstack-query/references/lifecycle/setup-query-client-and-providers.md +161 -0
  144. package/scaffold/.agents/skills/tanstack-query/references/lifecycle/ssr-hydration-and-streaming.md +209 -0
  145. package/scaffold/.agents/skills/tanstack-query/references/lifecycle/test-query-code.md +160 -0
  146. package/scaffold/.agents/skills/tanstack-router/SKILL.md +134 -0
  147. package/scaffold/.agents/skills/tanstack-router/references/compositions/router-query.md +412 -0
  148. package/scaffold/.agents/skills/tanstack-router/references/react-router.md +495 -0
  149. package/scaffold/.agents/skills/tanstack-router/references/router-core/auth-and-guards.md +495 -0
  150. package/scaffold/.agents/skills/tanstack-router/references/router-core/code-splitting.md +318 -0
  151. package/scaffold/.agents/skills/tanstack-router/references/router-core/data-loading.md +490 -0
  152. package/scaffold/.agents/skills/tanstack-router/references/router-core/index.md +158 -0
  153. package/scaffold/.agents/skills/tanstack-router/references/router-core/navigation.md +433 -0
  154. package/scaffold/.agents/skills/tanstack-router/references/router-core/not-found-and-errors.md +436 -0
  155. package/scaffold/.agents/skills/tanstack-router/references/router-core/path-params.md +383 -0
  156. package/scaffold/.agents/skills/tanstack-router/references/router-core/search-params.md +343 -0
  157. package/scaffold/.agents/skills/tanstack-router/references/router-core/ssr.md +462 -0
  158. package/scaffold/.agents/skills/tanstack-router/references/router-core/type-safety.md +493 -0
  159. package/scaffold/.agents/skills/tanstack-router/references/router-plugin.md +250 -0
  160. package/scaffold/.agents/skills/tanstack-router/references/virtual-file-routes.md +215 -0
  161. package/scaffold/.agents/skills/web-design-guidelines/SKILL.md +184 -0
  162. package/scaffold/.github/workflows/hitch.yml +1 -1
  163. package/scaffold/AGENTS.md +2 -2
  164. package/scaffold/applet/src/client/components/ui/alert.tsx +1 -1
  165. package/scaffold/applet/src/client/components/ui/button.tsx +1 -1
  166. package/scaffold/applet/src/client/components/ui/checkbox.tsx +1 -1
  167. package/scaffold/applet/src/client/components/ui/dialog.tsx +2 -2
  168. package/scaffold/applet/src/client/components/ui/dropdown-menu.tsx +2 -2
  169. package/scaffold/applet/src/client/components/ui/input-group.tsx +2 -2
  170. package/scaffold/applet/src/client/components/ui/select.tsx +2 -2
  171. package/scaffold/applet/src/client/components/ui/sheet.tsx +2 -2
  172. package/scaffold/applet/src/client/components/ui/spinner.tsx +2 -1
  173. package/scaffold/applet/src/client/components/ui/tabs.tsx +1 -1
  174. package/scaffold/applet/src/client/lib/utils.ts +1 -6
  175. package/scaffold/applet/src/client/styles/globals.css +2 -0
  176. package/dist/build-DhNDp7ji.js +0 -2
  177. package/dist/generate-DSk8ihsC.js +0 -2
@@ -0,0 +1,111 @@
1
+ import { z } from "zod";
2
+ //#region src/server/workflow-protocol.ts
3
+ const journalEntrySchema = z.discriminatedUnion("kind", [
4
+ z.object({
5
+ kind: z.literal("step"),
6
+ id: z.string(),
7
+ name: z.string(),
8
+ result: z.unknown()
9
+ }),
10
+ z.object({
11
+ kind: z.literal("sleep"),
12
+ id: z.string(),
13
+ name: z.string(),
14
+ until: z.number()
15
+ }),
16
+ z.object({
17
+ kind: z.literal("attempt"),
18
+ id: z.string(),
19
+ name: z.string(),
20
+ error: z.string()
21
+ }),
22
+ z.object({
23
+ kind: z.literal("failed"),
24
+ id: z.string(),
25
+ name: z.string(),
26
+ error: z.string()
27
+ })
28
+ ]);
29
+ const workflowInvocationRequestSchema = z.object({
30
+ payload: z.unknown(),
31
+ journal: z.array(journalEntrySchema)
32
+ });
33
+ const workflowOutcomeSchema = z.discriminatedUnion("kind", [
34
+ z.object({
35
+ kind: z.literal("step"),
36
+ id: z.string(),
37
+ name: z.string(),
38
+ result: z.unknown()
39
+ }),
40
+ z.object({
41
+ kind: z.literal("sleep"),
42
+ id: z.string(),
43
+ name: z.string(),
44
+ until: z.number()
45
+ }),
46
+ z.object({
47
+ kind: z.literal("step_error"),
48
+ id: z.string(),
49
+ name: z.string(),
50
+ message: z.string(),
51
+ retries: z.object({
52
+ limit: z.number(),
53
+ delayMs: z.number(),
54
+ backoff: z.enum([
55
+ "constant",
56
+ "linear",
57
+ "exponential"
58
+ ])
59
+ })
60
+ }),
61
+ z.object({
62
+ kind: z.literal("done"),
63
+ result: z.unknown()
64
+ }),
65
+ z.object({
66
+ kind: z.literal("error"),
67
+ message: z.string()
68
+ })
69
+ ]);
70
+ //#endregion
71
+ //#region src/server/workflow-engine.ts
72
+ var WorkflowFailedError = class extends Error {};
73
+ async function runWorkflowJournal(engine, invoke) {
74
+ const journal = [];
75
+ for (let index = 1;; index += 1) {
76
+ const outcome = await engine.invoke(`invoke ${index}`, () => invoke(journal));
77
+ switch (outcome.kind) {
78
+ case "step":
79
+ journal.push(outcome);
80
+ break;
81
+ case "sleep":
82
+ journal.push(outcome);
83
+ await engine.sleepUntil(`sleep ${index}`, new Date(outcome.until));
84
+ break;
85
+ case "step_error": {
86
+ const attempts = 1 + journal.filter((entry) => entry.kind === "attempt" && entry.id === outcome.id).length;
87
+ journal.push({
88
+ kind: "attempt",
89
+ id: outcome.id,
90
+ name: outcome.name,
91
+ error: outcome.message
92
+ });
93
+ if (attempts > outcome.retries.limit) {
94
+ journal.push({
95
+ kind: "failed",
96
+ id: outcome.id,
97
+ name: outcome.name,
98
+ error: outcome.message
99
+ });
100
+ break;
101
+ }
102
+ await engine.sleep(`retry ${index}`, outcome.retries.delayMs * (outcome.retries.backoff === "exponential" ? 2 ** (attempts - 1) : outcome.retries.backoff === "linear" ? attempts : 1));
103
+ break;
104
+ }
105
+ case "done": return outcome.result;
106
+ case "error": throw new WorkflowFailedError(outcome.message);
107
+ }
108
+ }
109
+ }
110
+ //#endregion
111
+ export { workflowOutcomeSchema as a, workflowInvocationRequestSchema as i, runWorkflowJournal as n, journalEntrySchema as r, WorkflowFailedError as t };
@@ -45,8 +45,8 @@ async function healCredentialStore(credentialsPath, source, store, unrecognizedC
45
45
  console.error(unrecognizedCount === void 0 ? `hitch: reset unreadable credentials file (backup: ${backupPath}).` : unrecognizedCount === 0 ? `hitch: migrated credentials to per-organization storage (backup: ${backupPath}).` : `hitch: removed ${unrecognizedCount} unrecognized credential ${unrecognizedCount === 1 ? "entry" : "entries"} (backup: ${backupPath}).`);
46
46
  return store;
47
47
  }
48
- async function readRawCredentialStore(options = {}) {
49
- const { credentialsPath } = storePaths(options);
48
+ async function readRawCredentialStore() {
49
+ const { credentialsPath } = storePaths();
50
50
  let source;
51
51
  try {
52
52
  source = await readFile(credentialsPath, "utf8");
@@ -113,9 +113,9 @@ function organizationInstanceUrl(instanceUrl, orgCode) {
113
113
  url.hostname = [orgCode, ...labels.slice(1)].join(".");
114
114
  return url.toString().replace(/\/$/, "");
115
115
  }
116
- function storePaths(options = {}) {
117
- const env = options.env ?? process.env;
118
- const home = options.homeDir ?? homedir();
116
+ function storePaths() {
117
+ const env = process.env;
118
+ const home = homedir();
119
119
  const configDir = join(env.XDG_CONFIG_HOME || join(home, ".config"), "hitch");
120
120
  return {
121
121
  configDir,
@@ -124,28 +124,28 @@ function storePaths(options = {}) {
124
124
  credentialsPath: join(configDir, "credentials.json")
125
125
  };
126
126
  }
127
- async function resolveInstanceUrl(override, options = {}) {
127
+ async function resolveInstanceUrl(override) {
128
128
  if (override !== void 0) return normalizeInstanceUrl(override);
129
- const envInstanceUrl = (options.env ?? process.env).HITCH_API_URL;
129
+ const envInstanceUrl = process.env.HITCH_API_URL;
130
130
  if (envInstanceUrl !== void 0 && envInstanceUrl.length > 0) return normalizeInstanceUrl(envInstanceUrl);
131
- const { configPath } = storePaths(options);
131
+ const { configPath } = storePaths();
132
132
  const config = await readJson(configPath);
133
133
  if (config === void 0) return DEFAULT_INSTANCE_URL;
134
134
  if (!isObject(config) || config.instanceUrl !== void 0 && typeof config.instanceUrl !== "string") throw new Error(`${configPath}: expected { instanceUrl?: string }.`);
135
135
  return normalizeInstanceUrl(config.instanceUrl ?? "https://app.hitch42.com");
136
136
  }
137
- async function readCredentialStore(options = {}) {
138
- const store = await readRawCredentialStore(options);
137
+ async function readCredentialStore() {
138
+ const store = await readRawCredentialStore();
139
139
  return { instances: Object.fromEntries(Object.entries(store.instances).map(([instanceUrl, credentialsByOrg]) => [instanceUrl, Object.fromEntries(Object.entries(credentialsByOrg).flatMap(([orgCode, value]) => {
140
140
  const credentials = parseCredentials(value);
141
141
  return credentials === void 0 ? [] : [[orgCode, credentials]];
142
142
  }))])) };
143
143
  }
144
- async function getCredentialsForOrg(instanceUrl, orgCode, options = {}) {
145
- return (await readCredentialStore(options)).instances[normalizeInstanceUrl(instanceUrl)]?.[orgCode];
144
+ async function getCredentialsForOrg(instanceUrl, orgCode) {
145
+ return (await readCredentialStore()).instances[normalizeInstanceUrl(instanceUrl)]?.[orgCode];
146
146
  }
147
- function environmentAuth(options) {
148
- const apiKey = (options.env ?? process.env).HITCH_API_KEY;
147
+ function environmentAuth() {
148
+ const apiKey = process.env.HITCH_API_KEY;
149
149
  return apiKey !== void 0 && apiKey.length > 0 ? {
150
150
  accessToken: apiKey,
151
151
  source: "environment"
@@ -169,11 +169,11 @@ function resolveStoredAuthForOrg(credentialsByOrg, orgCode) {
169
169
  const apiKeyOrgs = Object.values(credentialsByOrg).filter((credentials) => credentials.type === "apiKey").map(({ orgCode: storedOrg }) => storedOrg).sort();
170
170
  if (apiKeyOrgs.length > 0) throw new AuthenticationError(`Stored API ${apiKeyOrgs.length === 1 ? "key is" : "keys are"} scoped to ${apiKeyOrgs.map((storedOrg) => `"${storedOrg}"`).join(", ")}, not "${orgCode}".`);
171
171
  }
172
- async function resolveAuthForOrg(instanceUrl, orgCode, options = {}) {
173
- const auth = environmentAuth(options);
172
+ async function resolveAuthForOrg(instanceUrl, orgCode) {
173
+ const auth = environmentAuth();
174
174
  if (auth !== void 0) return auth;
175
175
  const normalizedUrl = normalizeInstanceUrl(instanceUrl);
176
- const credentialsByOrg = Object.entries((await readCredentialStore(options)).instances).find(([instance]) => instance === normalizedUrl)?.[1];
176
+ const credentialsByOrg = Object.entries((await readCredentialStore()).instances).find(([instance]) => instance === normalizedUrl)?.[1];
177
177
  return resolveStoredAuthForOrg(credentialsByOrg ?? {}, orgCode);
178
178
  }
179
179
  function rejectEnvironmentKey(response, auth) {
@@ -182,9 +182,9 @@ function rejectEnvironmentKey(response, auth) {
182
182
  function bearerToken(credentials) {
183
183
  return "apiKey" in credentials ? credentials.apiKey : credentials.accessToken;
184
184
  }
185
- async function setCredentials(instanceUrl, credentials, options = {}) {
186
- const paths = storePaths(options);
187
- const store = await readRawCredentialStore(options);
185
+ async function setCredentials(instanceUrl, credentials) {
186
+ const paths = storePaths();
187
+ const store = await readRawCredentialStore();
188
188
  const normalizedUrl = normalizeInstanceUrl(instanceUrl);
189
189
  const credentialsByOrg = store.instances[normalizedUrl];
190
190
  store.instances[normalizedUrl] = {
@@ -291,17 +291,17 @@ async function pollForToken(fetcher, instanceUrl, device, now, sleep) {
291
291
  throw new AuthenticationError("The sign-in request expired. Run hitch login again.");
292
292
  }
293
293
  async function loginWithDevice(instanceUrl, options = {}) {
294
- const fetcher = options.fetch ?? globalThis.fetch;
295
- const now = options.now ?? Date.now;
294
+ const fetcher = globalThis.fetch;
295
+ const now = Date.now;
296
296
  const { body, response } = await postJson(fetcher, `${instanceUrl}/api/auth/device/code`, { client_id: CLIENT_ID });
297
297
  if (!response.ok) throw new AuthenticationError(typeof body.error_description === "string" ? body.error_description : `Could not start sign-in (${response.status}).`);
298
298
  const device = parseDeviceCode(body);
299
299
  const verificationUrl = options.expectedOrg === void 0 ? device.verification_uri_complete : `${device.verification_uri_complete}&org=${encodeURIComponent(options.expectedOrg)}`;
300
- (options.print ?? console.log)(`Open ${verificationUrl} and confirm code ${device.user_code}.`);
300
+ console.log(`Open ${verificationUrl} and confirm code ${device.user_code}.`);
301
301
  if (!options.noBrowser) try {
302
- await (options.openUrl ?? defaultOpenUrl)(verificationUrl);
302
+ defaultOpenUrl(verificationUrl);
303
303
  } catch {}
304
- const token = await pollForToken(fetcher, instanceUrl, device, now, options.sleep ?? ((milliseconds) => new Promise((resolve) => setTimeout(resolve, milliseconds))));
304
+ const token = await pollForToken(fetcher, instanceUrl, device, now, (milliseconds) => new Promise((resolve) => setTimeout(resolve, milliseconds)));
305
305
  const { body: organizationBody, response: organizationResponse } = await postJson(fetcher, `${instanceUrl}/api/auth/device/organization`, { device_code: device.device_code });
306
306
  if (!organizationResponse.ok) throw new AuthenticationError("The sign-in did not resolve an organization.");
307
307
  const organization = parseDeviceOrganization(organizationBody);
@@ -319,7 +319,7 @@ async function loginWithDevice(instanceUrl, options = {}) {
319
319
  organizationId: organization.organizationId,
320
320
  orgCode: organization.orgCode
321
321
  };
322
- await setCredentials(instanceUrl, credentials, options.store);
322
+ await setCredentials(instanceUrl, credentials);
323
323
  if (options.expectedOrg !== void 0 && organization.orgCode !== options.expectedOrg) throw new AuthenticationError(`logged in to "${organization.orgCode}" but this applet targets "${options.expectedOrg}" — confirm the right organization on the device page`);
324
324
  return {
325
325
  credentials,
@@ -342,9 +342,12 @@ function readWorkspaceConfig(dir) {
342
342
  }
343
343
  const config = module !== null && typeof module === "object" && "default" in module ? module.default : module;
344
344
  if (config === null || typeof config !== "object" || !("sdk" in config) || typeof config.sdk !== "string" || config.sdk.length === 0 || !("org" in config) || typeof config.org !== "string" || !ORG_CODE_PATTERN.test(config.org)) throw new Error(`Invalid Hitch config in ${path}: "sdk" must be a package spec and "org" an organization code.`);
345
+ const githubWorkflow = "githubWorkflow" in config ? config.githubWorkflow : void 0;
346
+ if (githubWorkflow !== void 0 && typeof githubWorkflow !== "boolean") throw new Error(`Invalid Hitch config in ${path}: "githubWorkflow" must be a boolean.`);
345
347
  return {
346
348
  sdk: config.sdk,
347
- org: config.org
349
+ org: config.org,
350
+ githubWorkflow
348
351
  };
349
352
  }
350
353
  function findWorkspaceConfig(cwd) {
@@ -353,23 +356,18 @@ function findWorkspaceConfig(cwd) {
353
356
  }
354
357
  //#endregion
355
358
  //#region src/auth.ts
356
- async function fetchWithOrgAuth(orgCode, options, request) {
357
- const fetcher = options.fetch ?? globalThis.fetch;
358
- const instanceUrl = await resolveInstanceUrl(void 0, options.store);
359
+ async function fetchWithOrgAuth(orgCode, request) {
360
+ const instanceUrl = await resolveInstanceUrl();
359
361
  const organizationUrl = organizationInstanceUrl(instanceUrl, orgCode);
360
- const auth = await resolveAuthForOrg(instanceUrl, orgCode, options.store);
362
+ const auth = await resolveAuthForOrg(instanceUrl, orgCode);
361
363
  if (auth !== void 0) {
362
364
  const response = await request(organizationUrl, bearerToken(auth));
363
365
  rejectEnvironmentKey(response, auth);
364
366
  if (response.status !== 401) return response;
365
367
  }
366
- if (!(options.stdinIsTTY ?? process.stdin.isTTY === true)) throw new AuthenticationError("Not logged in. Run applet login, or set HITCH_API_KEY.");
367
- await (options.login ?? loginWithDevice)(instanceUrl, {
368
- expectedOrg: orgCode,
369
- fetch: fetcher,
370
- store: options.store
371
- });
372
- const credentials = await getCredentialsForOrg(instanceUrl, orgCode, options.store);
368
+ if (process.stdin.isTTY !== true) throw new AuthenticationError("Not logged in. Run applet login, or set HITCH_API_KEY.");
369
+ await loginWithDevice(instanceUrl, { expectedOrg: orgCode });
370
+ const credentials = await getCredentialsForOrg(instanceUrl, orgCode);
373
371
  if (credentials === void 0) throw new Error(`login did not provide credentials for organization "${orgCode}"`);
374
372
  return request(organizationUrl, bearerToken(credentials));
375
373
  }
@@ -384,4 +382,4 @@ function resolveWorkspaceOrg(appletRoot) {
384
382
  throw new Error(`No Hitch workspace found for ${appletRoot}. An applet must live at <workspace>/applets/<code> with hitch.config.ts in the workspace root.`);
385
383
  }
386
384
  //#endregion
387
- export { loginWithDevice as a, resolveAuthForOrg as c, readWorkspaceConfig as i, resolveInstanceUrl as l, fetchWithOrgAuth as n, AuthenticationError as o, findWorkspaceConfig as r, organizationInstanceUrl as s, resolveWorkspaceOrg as t };
385
+ export { loginWithDevice as a, bearerToken as c, resolveAuthForOrg as d, resolveInstanceUrl as f, readWorkspaceConfig as i, organizationInstanceUrl as l, fetchWithOrgAuth as n, AuthenticationError as o, findWorkspaceConfig as r, DEFAULT_INSTANCE_URL as s, resolveWorkspaceOrg as t, rejectEnvironmentKey as u };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hitch42/applet",
3
- "version": "0.1.1-beta.7",
3
+ "version": "0.1.1-beta.9",
4
4
  "license": "MIT",
5
5
  "bin": {
6
6
  "applet": "./dist/applet.js"
@@ -27,6 +27,10 @@
27
27
  "source": "./src/react/index.ts",
28
28
  "default": "./dist/react.js"
29
29
  },
30
+ "./telephony": {
31
+ "source": "./src/telephony/index.ts",
32
+ "default": "./dist/telephony.js"
33
+ },
30
34
  "./vite": {
31
35
  "source": "./src/vite.ts",
32
36
  "default": "./dist/vite.js"
@@ -38,10 +42,15 @@
38
42
  "./_internal/server": {
39
43
  "source": "./src/internal/server.ts",
40
44
  "default": "./dist/_internal/server.js"
45
+ },
46
+ "./_internal/log-context": {
47
+ "source": "./src/server/log-context.ts",
48
+ "default": "./dist/_internal/log-context.js"
41
49
  }
42
50
  },
43
51
  "dependencies": {
44
52
  "@cloudflare/vite-plugin": "^1.51.1",
53
+ "@fontsource-variable/geist-mono": "^5.3.0",
45
54
  "@fontsource-variable/inter": "^5.3.0",
46
55
  "@hey-api/openapi-ts": "0.0.0-next-20260824173136",
47
56
  "@orpc/client": "^1.15.0",
@@ -49,28 +58,32 @@
49
58
  "@orpc/openapi-client": "^1.15.0",
50
59
  "@orpc/tanstack-query": "^1.15.0",
51
60
  "@tailwindcss/vite": "^4.3.0",
52
- "@tanstack/query-async-storage-persister": "5.101.4",
53
61
  "@tanstack/react-query-persist-client": "5.101.4",
54
62
  "@tanstack/router-cli": "^1.167.24",
55
63
  "@tanstack/router-plugin": "^1.168.23",
64
+ "@telnyx/webrtc": "^2.27.10",
56
65
  "@tiptap/core": "^3.30.3",
57
66
  "@tiptap/extension-image": "^3.30.3",
58
67
  "@tiptap/extension-list": "^3.30.3",
59
68
  "@tiptap/extension-table": "^3.30.3",
60
69
  "@tiptap/extensions": "^3.30.3",
61
70
  "@tiptap/markdown": "^3.30.3",
71
+ "@tiptap/pm": "^3.30.3",
62
72
  "@tiptap/react": "^3.30.3",
63
73
  "@tiptap/starter-kit": "^3.30.3",
64
74
  "@vitejs/plugin-react": "^6.0.3",
65
75
  "class-variance-authority": "^0.7.1",
66
- "clsx": "^2.1.1",
76
+ "cn": "^0.4.0",
67
77
  "croner": "^10.0.1",
68
78
  "lucide-react": "^1.33.0",
69
79
  "oxc-transform-react": "^0.149.0",
80
+ "oxfmt": "^0.72.0",
81
+ "oxlint": "^1.87.0",
82
+ "oxlint-tsgolint": "^7.0.2003",
70
83
  "react-aria-components": "^1.20.0",
71
84
  "shadcn": "^4.16.1",
85
+ "smol-toml": "^1.9.0",
72
86
  "streamdown": "^2.6.0",
73
- "tailwind-merge": "^3.6.0",
74
87
  "tailwindcss": "^4.3.0",
75
88
  "tw-animate-css": "^1.4.0",
76
89
  "vite": "8.3.0",
@@ -100,6 +113,6 @@
100
113
  "publishConfig": {
101
114
  "access": "public",
102
115
  "registry": "https://registry.npmjs.org",
103
- "tag": "beta"
116
+ "tag": "latest"
104
117
  }
105
118
  }
@@ -13,26 +13,31 @@ Treat each applet as an isolated microfrontend. Keep it separate from the data s
13
13
 
14
14
  This file holds the common rules. Read each matching reference before you edit an applet. Paths are relative to this file.
15
15
 
16
- | Read this | When the task involves |
17
- | --------------------------- | -------------------------------------------------------------------------------------------------------- |
18
- | `references/client.md` | Client routes, navigation, page layout, forms, controls, or other user interface work |
19
- | `references/records.md` | Listing, querying, creating, or updating records; filters, includes, aggregates; a missing record method |
20
- | `references/files.md` | Uploading or reading files, attachment attributes, download links |
21
- | `references/markdown.md` | Rendering or editing markdown, image uploads, Hitch file links |
22
- | `references/server.md` | The applet server: secrets, env variables, external services, the `api` client |
23
- | `references/schedules.md` | Cron schedules and background runs |
24
- | `references/workflows.md` | Multi-step server work: `createWorkflow`, `step.do`, `step.sleep`, starting, reading, and listing runs |
25
- | `references/manifest.md` | The applet definition in `applet.manifest.ts`: objects, access, variables, and packages |
26
- | `references/performance.md` | Data access design: client versus server, N+1 reads, includes, aggregates, pagination, batch writes |
16
+ | Read this | When the task involves |
17
+ | ------------------------------ | -------------------------------------------------------------------------------------------------------- |
18
+ | `references/client.md` | Client routes, navigation, page layout, forms, controls, or other user interface work |
19
+ | `references/records.md` | Listing, querying, creating, or updating records; filters, includes, aggregates; a missing record method |
20
+ | `references/files.md` | Uploading or reading files, attachment attributes, download links |
21
+ | `references/email-tracking.md` | Creating pixels and reading raw email hits |
22
+ | `references/markdown.md` | Rendering or editing markdown, image uploads, Hitch file links |
23
+ | `references/server.md` | The applet server: secrets, env variables, external services, the `api` client |
24
+ | `references/schedules.md` | Cron schedules and background runs |
25
+ | `references/workflows.md` | Multi-step server work: `createWorkflow`, `step.do`, `step.sleep`, starting, reading, and listing runs |
26
+ | `references/manifest.md` | The applet definition in `applet.manifest.ts`: objects, access, variables, and packages |
27
+ | `references/performance.md` | Data access design: client versus server, N+1 reads, includes, aggregates, pagination, batch writes |
27
28
 
28
29
  For attribute types, filters, and API limits, read `../hitch-data/SKILL.md`. To inspect or change Hitch data and settings from the shell, read `../hitch-cli/SKILL.md`.
29
30
 
31
+ Read `../tanstack-router/SKILL.md` for route work and `../tanstack-query/SKILL.md` for query and cache work.
32
+ Read `../react-best-practices/SKILL.md` for React performance and `../web-design-guidelines/SKILL.md` for requested interface reviews.
33
+ Follow the Hitch applet rules for SDK-owned configuration, providers, and generated files.
34
+
30
35
  ## Work with the workspace
31
36
 
32
37
  - Run package commands with `pnpm`.
33
38
  - Run `pnpm exec applet login` from the workspace root or an applet directory to sign in. It uses the organization in `hitch.config.ts` and shares credentials with `hitch login`. Add `--no-browser` to print the sign-in URL without opening a browser.
34
- - A server permission error is not a login request. After an applet has a CI release, the server rejects local deployments; deploy subsequent releases through CI.
35
- - If `package.json` is absent, read `sdk` from `hitch.config.ts`. Run `pnpm dlx <sdk> bootstrap` from the workspace root.
39
+ - A server permission error is not a login request.
40
+ - After a workspace is linked to a repository, deploy in two ways. Run `pnpm exec applet deploy` to release a change immediately. Push to the production branch to deploy through CI and keep releases in sync with the repository.
36
41
  - Run `pnpm exec applet new <code>` from the workspace root to create a full applet.
37
42
  - Add `--client-only` or `--server-only` when the applet needs only one part.
38
43
  - Use `--client-only` for a user interface that uses the current user's Hitch access and needs no server.
@@ -46,16 +51,22 @@ For attribute types, filters, and API limits, read `../hitch-data/SKILL.md`. To
46
51
  - Run `pnpm --dir applets/<code> run generate` after a Hitch object, operation, or theme changes.
47
52
  - Run generation at the start of a session when the task depends on current Hitch types.
48
53
  - Run `pnpm --dir applets/<code> run dev` and `pnpm --dir applets/<code> run build` from the workspace root.
54
+ - The dev server runs as you in the production org. Reads and writes use real data.
55
+ - The dev server prints a preview link. Open the link to see the local applet inside Hitch.
56
+ - Chrome asks once to allow local network access for the Hitch site.
57
+ - The preview lasts until you select Exit or close the tab.
58
+ - A pending `requiresChangeset` schema is not available in dev. Deploy to test it.
49
59
  - Run `pnpm --dir applets/<code> run deploy` only when the user requests a deployment.
50
- - Edit only `hitch.config.ts`, `applet.manifest.ts`, and files in `src`.
51
- - Treat all other workspace files as generated output. The applet CLI replaces them.
60
+ - The CLI creates missing MCP files and adds missing Hitch and Chrome DevTools entries. Existing entries and other settings belong to the user.
61
+ - The applet CLI replaces its generated support files. It creates `.github/workflows/hitch.yml` only when the file is absent. To stop it, set `githubWorkflow: false` in `hitch.config.ts` and delete the file.
52
62
  - Remember that generation refreshes the local theme copy. Deployed applets load the public org theme from its Hitch `.com` URL.
53
63
 
54
64
  ## Use Vite and Vitest
55
65
 
56
66
  - Import configuration APIs from `vite`.
57
67
  - Import test APIs from `vitest`.
58
- - Keep Vite configuration in the generated `vite.config.ts` file.
68
+ - Put tests in the applet's `test` folder and name them `*.test.ts` or `*.test.tsx`. Vitest does not run test files in other folders.
69
+ - Do not edit `vite.config.ts`. The applet CLI rewrites it. Do not add another Vite config.
59
70
  - Add applet packages to `dependencies` or `devDependencies` in `applet.manifest.ts`.
60
71
 
61
72
  ## Access Hitch data
@@ -123,9 +134,28 @@ Read `references/files.md` before download links, attachment attributes, or serv
123
134
  - Add useful `console.<level>` calls around important server work and failures. Deployed logs often provide the clearest evidence for applet issues.
124
135
  - Choose `console.log`, `console.info`, `console.warn`, or `console.error` deliberately. The console method sets the entry level used by log filters.
125
136
  - Run `pnpm --dir applets/<code> exec applet logs --filter '{"type":"applet"}'` from the workspace root to inspect applet code logs.
126
- - Include the applet type filter during diagnosis. Without it, Cloudflare invocation entries can hide the useful applet entries.
137
+ - Include the applet type filter during diagnosis. Without it, Cloudflare invocation entries can hide the useful applet entries. For a workflow run, use `--run <id>` or `--filter '{"type":"workflow"}'` instead.
127
138
  - Do not log secrets, tokens, or personal data.
128
139
 
140
+ ## Add request context with `log.set()`
141
+
142
+ Each server request gets one request entry with the route, status, outcome, CPU time, and wall time. Add facts about the request to that entry:
143
+
144
+ ```ts
145
+ import { log } from "@hitch42/applet/server";
146
+
147
+ log.set({ invoiceId, processedCount });
148
+ ```
149
+
150
+ - Set the IDs, counts, and decisions that explain what the request did. One entry with many fields is easier to filter than many `console.log` lines.
151
+ - A later call replaces an earlier value with the same top-level key.
152
+ - To fail a request, throw. The request entry records the error and its stack.
153
+ - To record a problem that the code recovered from, set a field, for example `log.set({ fallbackUsed: true })`.
154
+ - Use `console.<level>` for a separate line with its own level.
155
+ - Outside a request, for example at module scope, `log.set()` warns and drops the fields.
156
+ - A single call larger than 16 KB is dropped. The entry then shows `noteDropped`.
157
+ - Run `pnpm --dir applets/<code> exec applet logs --filter '{"type":"invocation"}'` to read request entries. The CLI prints the fields and any error stack.
158
+
129
159
  ## Verify changes
130
160
 
131
161
  Run these commands from the workspace root before deployment:
@@ -133,6 +163,8 @@ Run these commands from the workspace root before deployment:
133
163
  ```sh
134
164
  pnpm --dir applets/<code> run generate
135
165
  pnpm --dir applets/<code> run typecheck
166
+ pnpm --dir applets/<code> run fmt
167
+ pnpm --dir applets/<code> run lint
136
168
  pnpm --dir applets/<code> run test # Only when the applet contains tests.
137
169
  pnpm --dir applets/<code> run build
138
170
  ```
@@ -144,7 +176,7 @@ If a command fails, report the exact blocker. Do not deploy as a verification st
144
176
  ## Deploy from GitHub
145
177
 
146
178
  - A push to the production branch runs `applet deploy` in the workspace root through GitHub Actions.
147
- - An applet deploys when its own folder changed since its current CI release. Every applet deploys when a file outside `applets/` changed. An applet without a CI release always deploys.
179
+ - An applet deploys when its folder or a file outside `applets/` differs from its current release, including a local `applet deploy`. Uncommitted and untracked files count. Gitignored files do not count. An applet whose current release has no source hash always deploys.
148
180
  - The deploy skips other applets and logs the reason. A skip is expected, not a failure.
149
181
  - A schema change in Hitch alone does not trigger CI.
150
182
  - Do not import from a sibling applet folder. The change check does not follow such imports.
@@ -0,0 +1,49 @@
1
+ # Email tracking
2
+
3
+ Create one pixel for each email. Put its URL in the HTML before send.
4
+ Add the pixel next to CID images. A CID image cannot make a tracking request.
5
+
6
+ ```ts
7
+ const { id, url } = await hitch.email.tracking.createPixel({
8
+ tags: { campaignId: "fall", buyerId: "acme", version: "v2" },
9
+ });
10
+ const html = `<p>Hello</p><img src="${url}" width="1" height="1" alt="">`;
11
+ // Send the email with the applet's email provider.
12
+ await hitch.email.tracking.markSent({ id });
13
+ ```
14
+
15
+ `markSent({ id, sentAt })` accepts an ISO time. A later call replaces the sent time.
16
+ `get({ id })` returns one tracker. `list()` returns up to 100 trackers by default.
17
+ Use `filter`, `sentAt`, `cursor`, and `limit` to select a page.
18
+
19
+ ```ts
20
+ const tracker = await hitch.email.tracking.get({ id });
21
+ const query = {
22
+ filter: { buyerId: "acme" },
23
+ sentAt: { $gte: "2026-10-01T00:00:00Z" },
24
+ limit: 100,
25
+ };
26
+ const page = await hitch.email.tracking.list(query);
27
+ const next = page.nextCursor
28
+ ? await hitch.email.tracking.list({ ...query, cursor: page.nextCursor })
29
+ : null;
30
+ const opened =
31
+ tracker.lastHitAt !== null &&
32
+ new Date(tracker.lastHitAt).getTime() >
33
+ new Date(tracker.sentAt ?? tracker.createdAt).getTime() + 60_000;
34
+ ```
35
+
36
+ The example rule counts a tracker as opened when `lastHitAt` is more than 60 seconds after send or creation.
37
+ Hitch records `firstHitAt` and `lastHitAt`. It does not classify opens.
38
+ Each page must repeat the same filter, `sentAt`, and limit.
39
+
40
+ Tags stay fixed after creation. Use at most 10 tags. A key starts with an ASCII letter.
41
+ The rest contains ASCII letters, digits, or underscores, up to 64 characters total.
42
+ Each value has 1 to 200 characters. A filter matches every tag by exact equality.
43
+ Everyone with applet access sees all its trackers.
44
+
45
+ Gmail can fetch through `GoogleImageProxy` a few seconds after send.
46
+ A real Gmail open has the same user agent. A Gmail draft preview can fetch before send.
47
+ Apple Mail Privacy Protection fetches on delivery with `Mozilla/5.0`.
48
+ That fetch looks like a real open. Proton fetches on delivery.
49
+ Clients with images off never fetch the pixel.
@@ -67,7 +67,7 @@ Use `download` when a component needs one fresh link without query state:
67
67
 
68
68
  ```ts
69
69
  const file = await hitch.files.download(id);
70
- file.downloadUrl; // a download link, valid for one hour
70
+ file.downloadUrl; // a download link, valid for at least a day
71
71
  ```
72
72
 
73
73
  Use the `get` query utilities when React needs file metadata as query state.
@@ -86,11 +86,11 @@ if (fileQuery.data) {
86
86
  row.filename; // "report.csv"
87
87
  row.contentType; // "text/csv"
88
88
  row.sizeBytes; // 1024
89
- downloadUrl; // a download link, valid for one hour
89
+ downloadUrl; // a download link, valid for at least a day
90
90
  }
91
91
  ```
92
92
 
93
- A `downloadUrl` expires after one hour. Call `get` again for a fresh link instead of storing one.
93
+ A `downloadUrl` expires after 24 to 48 hours. Call `get` again for a fresh link instead of storing one.
94
94
 
95
95
  ## Link a file to a record
96
96
 
@@ -83,6 +83,14 @@ Each object entry has five required fields.
83
83
  - `readOnly` lists attribute codes that the applet can read but cannot write.
84
84
  - `readWrite` lists attribute codes that the applet can read and write.
85
85
 
86
+ Set `optional: true` when the applet works for a viewer without access to this object.
87
+ List codes from `readOnly` or `readWrite` in `optionalAttributes` when some viewers cannot see their values.
88
+ Typegen makes these record fields nullable for every viewer.
89
+ These fields never grant or remove access.
90
+ They matter when an org shares the applet with a connected organisation.
91
+ Hitch refuses a share if the connected org lacks access to a required object.
92
+ Hitch also refuses a share if a required object lists a required user attribute outside `optionalAttributes`.
93
+
86
94
  - Use the applet code format for each object code.
87
95
  - Do not declare the same object code more than once.
88
96
  - Use the applet code format for each attribute code.
@@ -92,14 +100,16 @@ Each object entry has five required fields.
92
100
 
93
101
  The object declaration caps record access for the applet identity.
94
102
 
95
- - Declare only the objects that scheduled applet work needs.
96
- - Declare only the attributes that scheduled applet work needs.
103
+ - Declare only the objects that the applet uses.
104
+ - Declare only the attributes that the applet uses.
105
+ - The declaration sets both the generated contract and the applet identity's cap.
97
106
  - Use `readOnly` for attributes that the applet identity must not change.
98
107
  - Use `readWrite` for attributes that the applet identity can change.
99
108
  - Set `canCreate` and `canDelete` to the required values.
100
109
  - The generated contract omits undeclared objects.
101
110
  - The generated contract removes `create` when `canCreate` is false.
102
111
  - The generated contract removes `delete` when `canDelete` is false.
112
+ - The generated contract removes `update` and `updateWhere` when `readWrite` is empty.
103
113
  - Regenerate after an object grant changes.
104
114
  - Do not restore a removed object or method with a cast.
105
115
 
@@ -15,6 +15,8 @@ import { MarkdownEditor } from "@hitch42/applet/react";
15
15
  <MarkdownEditor value={value} onChange={setValue} files={hitch.files} />;
16
16
  ```
17
17
 
18
+ Pass `autoFocus` to put the cursor at the end of the text when the editor mounts. It is off by default, so the editor never takes focus from another field.
19
+
18
20
  The editor uploads pasted or dropped images. It stores each image as `![name](hitch-file://<file-id>)`.
19
21
 
20
22
  The `files` value must supply both `upload(file)` and `download(id)`. The editor uses `download(id)` to show stored Hitch images.
@@ -33,7 +33,7 @@ Never call `get` once per row of a list. Use one of these instead:
33
33
  ## Page every list
34
34
 
35
35
  - Every list request returns at most 200 records. A larger `limit` is clamped to 200 with no error.
36
- - Show a page size or a bounded scroll area in the product, with a next-page control that passes the returned `cursor`.
36
+ - Show a page size or a bounded scroll area in the product, with a next-page control that passes the returned `next_cursor` as `cursor`.
37
37
  - Loop the cursor only when the code must visit the whole dataset. Name the bound in a comment, and stop at it.
38
38
  - Do not write a whole-dataset loop for a number that `aggregate` can return.
39
39