ignotum 0.0.17 → 0.0.19

package/README.md

@@ -1,8 +1,11 @@
 # Ignotum
 
-Ignotum is a TypeScript application platform with a schema, server queries and mutations, and a
-browser client. Generated references carry function argument, result, and error types from the
-server to the client.
+Ignotum is an application cloud for TypeScript apps. An app defines its data, callable functions,
+browser pages, and files in one project. Generated references carry function argument, result,
+error, and route types into browser code.
+
+Ignotum is currently in private alpha. APIs and hosted service behavior may change before public
+availability.
 
 The package requires Node.js 22.18 or newer.
 
@@ -18,17 +21,22 @@ Open `http://127.0.0.1:3210`. The generated counter app has this source layout:
 
 ```text
 client/
+  +layout.tsx
   index.tsx
+  about.tsx
   icon.svg
+  styles.css
 server/
   counter.ts
   schema.ts
 shared/
   utils.ts
+_generated/
 ```
 
-Ignotum writes generated bindings to `_generated`. Read those files when investigating a type, but
-do not edit them.
+Page file names determine their URLs. `client/index.tsx` defines `/`, `client/about.tsx` defines
+`/about`, and `client/+layout.tsx` shares navigation, providers, metadata, and styles. Ignotum owns
+the files under `_generated`; read them when investigating a type, but do not edit them.
 
 ## Define the schema
 
@@ -84,43 +92,41 @@ Typed server-only configuration can be declared in `server/env.ts` with `defineE
 the project-root `.env.ignotum`, and read through `ctx.env`. Use `values.secret()` for redacted
 values and `Secret.value(...)` when a function deliberately needs the underlying value.
 
-## Build the client
+## Define a page
 
-`client/index.tsx` default-exports one `app` definition. Use generated references with the query and
-mutation hooks:
+Each page default-exports a generated `route(...)` definition. Use generated function references
+with the query and mutation hooks:
 
 ```tsx
-import { app, Result, useMutation, useQuery } from "ignotum/client";
-
 import { api } from "@/_generated/api.js";
+import { route } from "@/_generated/client.js";
+import { Result, useMutation, useQuery } from "ignotum/client";
 
-function App() {
-  const todos = useQuery(api.todos.list);
-  const create = useMutation(api.todos.create);
-
-  return (
-    <main class="mx-auto max-w-xl p-8">
-      <button type="button" onClick={() => void create({ text: "New todo" })}>
-        Add todo
-      </button>
-
-      {Result.match(todos, {
-        pending: () => <p>Loading...</p>,
-        value: (items) => (
-          <ul>
-            {items.map((todo) => (
-              <li key={todo.id}>{todo.text}</li>
-            ))}
-          </ul>
-        ),
-      })}
-    </main>
-  );
-}
-
-export default app({
+export default route({
   title: "Todos",
-  component: App,
+  component: function TodosPage() {
+    const todos = useQuery(api.todos.list);
+    const create = useMutation(api.todos.create);
+
+    return (
+      <main class="mx-auto max-w-xl p-8">
+        <button type="button" onClick={() => void create({ text: "New todo" })}>
+          Add todo
+        </button>
+
+        {Result.match(todos, {
+          pending: () => <p>Loading...</p>,
+          value: (items) => (
+            <ul>
+              {items.map((todo) => (
+                <li key={todo.id}>{todo.text}</li>
+              ))}
+            </ul>
+          ),
+        })}
+      </main>
+    );
+  },
 });
 ```
 
@@ -128,46 +134,51 @@ export default app({
 a value or declared application error. `useMutation` returns a stable typed function. Its promise
 settles after the mutation result arrives; affected queries may refresh afterward.
 
-Import UI components, hooks, and types from `ignotum/client`. Tailwind classes work without an app
-configuration file. Import any custom CSS from client code. An optional `client/icon.svg` becomes
-the favicon. Import images from client source.
+Import UI components, hooks, and types from `ignotum/client`. Import `route`, `layout`, and URL
+validators from `@/_generated/client.js`, and import typed destinations from
+`@/_generated/routes.js`. Tailwind classes work without an app configuration file. Import custom
+CSS and images from client code. An optional `client/icon.svg` becomes the favicon.
 
 ## Commands
 
-| Command                           | Purpose                                                            |
-| --------------------------------- | ------------------------------------------------------------------ |
-| `npx ignotum new <directory>`     | Create an app, optionally initialize Git, and install dependencies |
-| `npx ignotum install`             | Install with pnpm when available, otherwise npm                    |
-| `npx ignotum codegen`             | Regenerate `_generated` without starting the dev server            |
-| `npx ignotum dev`                 | Run the local app and watch client, schema, and function changes   |
-| `npx ignotum dev db reset`        | Delete local app data while the dev server is stopped              |
-| `npx ignotum auth login`          | Sign in to Ignotum with GitHub                                     |
-| `npx ignotum auth logout`         | Revoke and remove the saved login                                  |
-| `npx ignotum auth status`         | Show the current account and team                                  |
-| `npx ignotum deploy --app <slug>` | Link the app, then build and activate its first version            |
+| Command                       | Purpose                                                            |
+| ----------------------------- | ------------------------------------------------------------------ |
+| `npx ignotum new <directory>` | Create an app, optionally initialize Git, and install dependencies |
+| `npx ignotum install`         | Install with pnpm when available, otherwise npm                    |
+| `npx ignotum codegen`         | Regenerate `_generated` without starting the dev server            |
+| `npx ignotum dev`             | Run the local app and watch client, schema, and function changes   |
+| `npx ignotum dev db reset`    | Delete local app data while the dev server is stopped              |
+| `npx ignotum auth login`      | Sign in to Ignotum with GitHub                                     |
+| `npx ignotum auth logout`     | Revoke and remove the saved login                                  |
+| `npx ignotum auth status`     | Show the current account and team                                  |
+| `npx ignotum deploy`          | Link the app, then build and activate its first version            |
 
 Run `npx ignotum auth login` before deploying the first version. The CLI stores the login outside
 the app directory. After deploying, it records the app link in `.ignotum/app.json`; later deploy
-commands do not need `--app`.
+commands do not need `--app`. The first deploy tries the name saved by `ignotum new` in
+`ignotum.json`. Use `--app <slug>` to choose a different slug.
 
 ## Package entry points
 
-Application code uses two entry points:
+Application code uses two package entry points:
 
 - `ignotum/server` exports `defineSchema`, `defineEnv`, `Secret`, the server form of `Result`, and
   server authoring types.
-- `ignotum/client` exports `app`, query and mutation hooks, `Query.skip`, client-side result
-  matching, application file URLs, and the supported UI APIs and types.
+- `ignotum/client` exports query and mutation hooks, navigation components and hooks, `Query.skip`,
+  client-side result matching, application file URLs, imported-image rendering, and the supported
+  Preact APIs and types.
 
-Generated files provide schema-bound server builders and function references. Imports from
-`@/_generated/server.js` belong in server code. Imports from `@/_generated/api.js` belong in client
-code. Shared modules may be imported through `@/shared`.
+Generated files provide schema-bound server builders, function references, route definitions,
+typed destinations, and data types. Imports from `@/_generated/server.js` belong in server code.
+Imports from `@/_generated/api.js`, `@/_generated/client.js`, and `@/_generated/routes.js` belong in
+client code. Shared modules may be imported through `@/shared`.
 
 ## Current scope
 
-Ignotum currently supports schema-defined data, queries, mutations, live query results, application
-image files, typed environments, Ignotum ID authentication, local development, and hosted apps. It
-does not provide custom HTTP endpoints, actions, scheduled jobs, or workflows.
+Ignotum currently supports schema-defined data, queries, mutations, live query results,
+file-based pages and layouts, application files, imported images, typed environments, Ignotum ID
+authentication, local development, and hosted apps. It does not provide custom HTTP endpoints,
+actions, scheduled jobs, or workflows.
 
-See the [Ignotum documentation](https://docs.ignotum.cloud) for validators, indexes, pagination,
-errors, consistency guarantees, hosted limits, and App Version behavior.
+See the [Ignotum documentation](https://docs.ignotum.cloud) for routes, navigation, validators,
+indexes, pagination, errors, consistency guarantees, hosted limits, and App Version behavior.

package/dist/cli/Undici-C6Asbalt.mjs

@@ -0,0 +1,30 @@
+import Undici from "undici";
+export * from "undici";
+//#region ../../node_modules/.pnpm/@effect+platform-node@4.0.0_effect@4.0.0_redis@6.2.1/node_modules/@effect/platform-node/dist/Undici.js
+/**
+* Re-export of the Undici HTTP client package used by the Node platform.
+*
+* This module gives Effect applications a package-local import for Undici
+* primitives while working with `@effect/platform-node`. Import named Undici
+* APIs from here when configuring Node HTTP client dispatchers, creating agents
+* or mock agents, setting the process-global dispatcher, or sharing the same
+* Undici types with integrations that use the platform HTTP client.
+*
+* The module does not wrap or reinterpret Undici behavior. It forwards the
+* installed `undici` named exports and default export, so connection pooling,
+* dispatcher lifetimes, mocking, aborts, and request options follow Undici's
+* own semantics.
+*
+* @stability unstable
+* @since 4.0.0
+*/
+/**
+* @stability unstable
+* @category re-exports
+* @since 4.0.0
+*/
+var Undici_default = Undici;
+//#endregion
+export { Undici_default as default };
+
+//# sourceMappingURL=Undici-C6Asbalt.mjs.map

package/dist/cli/Undici-C6Asbalt.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"Undici-C6Asbalt.mjs","names":[],"sources":["../../../../node_modules/.pnpm/@effect+platform-node@4.0.0_effect@4.0.0_redis@6.2.1/node_modules/@effect/platform-node/dist/Undici.js"],"sourcesContent":["/**\n * Re-export of the Undici HTTP client package used by the Node platform.\n *\n * This module gives Effect applications a package-local import for Undici\n * primitives while working with `@effect/platform-node`. Import named Undici\n * APIs from here when configuring Node HTTP client dispatchers, creating agents\n * or mock agents, setting the process-global dispatcher, or sharing the same\n * Undici types with integrations that use the platform HTTP client.\n *\n * The module does not wrap or reinterpret Undici behavior. It forwards the\n * installed `undici` named exports and default export, so connection pooling,\n * dispatcher lifetimes, mocking, aborts, and request options follow Undici's\n * own semantics.\n *\n * @stability unstable\n * @since 4.0.0\n */\nimport Undici from \"undici\";\n/**\n * @stability unstable\n * @category re-exports\n * @since 4.0.0\n */\nexport * from \"undici\";\n/**\n * @stability unstable\n * @category re-exports\n * @since 4.0.0\n */\nexport default Undici;\n//# sourceMappingURL=Undici.js.map"],"x_google_ignoreList":[0],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AA6BA,IAAA,iBAAe"}