@greenpandastudios/aug-cli 0.19.0

package/docs/api/memory.md

@@ -0,0 +1,109 @@
+---
+generated: true
+source: src/stdlib/memory
+editLink: false
+---
+
+# august.memory
+
+Public declarations exported by this module. Import names explicitly from `august.memory`. Built-in wire/value types are described in [language constructs](../language-constructs.md).
+
+- [StoreFull](#api-StoreFull)
+- [ExpiringStore](#api-ExpiringStore)
+- [MemoryStore](#api-MemoryStore)
+
+## StoreFull {#api-StoreFull}
+
+```text
+StoreFull() implements Error
+```
+
+The bounded store could not accept another live entry.
+
+[Source](https://github.com/GreenPandaStudios/augscript/blob/main/src/stdlib/memory/store.aug#L2)
+
+## ExpiringStore {#api-ExpiringStore}
+
+```text
+capability ExpiringStore<T implements Data>
+```
+
+A bounded, expiring capability for immutable values. Each generic DI binding has its own table.
+
+[Source](https://github.com/GreenPandaStudios/augscript/blob/main/src/stdlib/memory/store.aug#L7)
+
+### ExpiringStore.put
+
+```text
+put(string key, T value, int expires, int now) uses ExpiringStore.put unless StoreFull
+```
+
+Remove expired entries, then store at most 512 live entries. Time is supplied by the caller.
+
+[Source](https://github.com/GreenPandaStudios/augscript/blob/main/src/stdlib/memory/store.aug#L9)
+
+### ExpiringStore.take
+
+```text
+take(string key, int now) returns optional T uses ExpiringStore.take
+```
+
+Atomically remove a value. Expired or absent entries return null.
+
+[Source](https://github.com/GreenPandaStudios/augscript/blob/main/src/stdlib/memory/store.aug#L11)
+
+### ExpiringStore.get
+
+```text
+get(string key, int now) returns optional T uses ExpiringStore.get
+```
+
+Read a live value without consuming it.
+
+[Source](https://github.com/GreenPandaStudios/augscript/blob/main/src/stdlib/memory/store.aug#L13)
+
+## MemoryStore {#api-MemoryStore}
+
+```text
+MemoryStore<T implements Data>() implements ExpiringStore<T>
+```
+
+A synchronized table with short critical sections and no I/O while locked.
+
+[Source](https://github.com/GreenPandaStudios/augscript/blob/main/src/stdlib/memory/store.aug#L16)
+
+### MemoryStore.put
+
+```text
+put(string key, T value, int expires, int now) unless StoreFull
+```
+
+Remove expired entries, then store at most 512 live entries. Time is supplied by the caller.
+
+Inferred capabilities: `ExpiringStore<T>.put`.
+
+[Source](https://github.com/GreenPandaStudios/augscript/blob/main/src/stdlib/memory/store.aug#L18)
+
+### MemoryStore.take
+
+```text
+take(string key, int now) returns optional T
+```
+
+Atomically remove a value. Expired or absent entries return null.
+
+Inferred capabilities: `ExpiringStore<T>.take`.
+
+[Source](https://github.com/GreenPandaStudios/augscript/blob/main/src/stdlib/memory/store.aug#L27)
+
+### MemoryStore.get
+
+```text
+get(string key, int now) returns optional T
+```
+
+Read a live value without consuming it.
+
+Inferred capabilities: `ExpiringStore<T>.get`.
+
+[Source](https://github.com/GreenPandaStudios/augscript/blob/main/src/stdlib/memory/store.aug#L36)

package/docs/api/time.md

@@ -0,0 +1,54 @@
+---
+generated: true
+source: src/stdlib/time
+editLink: false
+---
+
+# august.time
+
+Public declarations exported by this module. Import names explicitly from `august.time`. Built-in wire/value types are described in [language constructs](../language-constructs.md).
+
+- [Clock](#api-Clock)
+- [SystemClock](#api-SystemClock)
+
+## Clock {#api-Clock}
+
+```text
+capability Clock
+```
+
+An explicit clock dependency makes time-based behavior replaceable in tests.
+
+[Source](https://github.com/GreenPandaStudios/augscript/blob/main/src/stdlib/time/contracts.aug#L2)
+
+### Clock.now
+
+```text
+now() returns int uses Clock.now unless TimeError
+```
+
+Read whole Unix seconds in UTC.
+
+[Source](https://github.com/GreenPandaStudios/augscript/blob/main/src/stdlib/time/contracts.aug#L4)
+
+## SystemClock {#api-SystemClock}
+
+```text
+SystemClock() implements Clock
+```
+
+Operating-system wall clock.
+
+[Source](https://github.com/GreenPandaStudios/augscript/blob/main/src/stdlib/time/contracts.aug#L7)
+
+### SystemClock.now
+
+```text
+now() returns int unless TimeError
+```
+
+Read whole Unix seconds in UTC.
+
+Inferred capabilities: `Clock.now`.
+
+[Source](https://github.com/GreenPandaStudios/augscript/blob/main/src/stdlib/time/contracts.aug#L8)

package/docs/api/web.md

@@ -0,0 +1,184 @@
+---
+generated: true
+source: src/stdlib/web
+editLink: false
+---
+
+# august.web
+
+Public declarations exported by this module. Import names explicitly from `august.web`. Built-in wire/value types are described in [language constructs](../language-constructs.md).
+
+- [Principal](#api-Principal)
+- [Authentication](#api-Authentication)
+- [Authorization](#api-Authorization)
+- [RequestLogger](#api-RequestLogger)
+- [WebRequestLogger](#api-WebRequestLogger)
+- [HttpClient](#api-HttpClient)
+- [WebHttpClient](#api-WebHttpClient)
+- [redirect](#api-redirect)
+- [urlEncode](#api-urlEncode)
+- [cookie](#api-cookie)
+
+## Principal {#api-Principal}
+
+```text
+record Principal(string subject, List<string> permissions)
+```
+
+Immutable identity returned by an explicitly injected authentication adapter.
+
+[Source](https://github.com/GreenPandaStudios/augscript/blob/main/src/stdlib/web/contracts.aug#L2)
+
+## Authentication {#api-Authentication}
+
+```text
+capability Authentication
+```
+
+Verify the request's credentials. null means unauthenticated; adapter failures raise HttpError.
+
+[Source](https://github.com/GreenPandaStudios/augscript/blob/main/src/stdlib/web/contracts.aug#L5)
+
+### Authentication.authenticate
+
+```text
+authenticate(HttpRequest request) returns optional Principal uses Authentication.authenticate unless HttpError
+```
+
+The signature declares inputs, result, effects and checked errors.
+
+[Source](https://github.com/GreenPandaStudios/augscript/blob/main/src/stdlib/web/contracts.aug#L6)
+
+## Authorization {#api-Authorization}
+
+```text
+capability Authorization
+```
+
+Decide whether a verified identity has one named permission.
+
+[Source](https://github.com/GreenPandaStudios/augscript/blob/main/src/stdlib/web/contracts.aug#L9)
+
+### Authorization.authorize
+
+```text
+authorize(Principal identity, string permission) returns bool uses Authorization.authorize unless HttpError
+```
+
+The signature declares inputs, result, effects and checked errors.
+
+[Source](https://github.com/GreenPandaStudios/augscript/blob/main/src/stdlib/web/contracts.aug#L10)
+
+## RequestLogger {#api-RequestLogger}
+
+```text
+capability RequestLogger
+```
+
+Observe a completed HTTP exchange, including failures and disconnects.
+
+[Source](https://github.com/GreenPandaStudios/augscript/blob/main/src/stdlib/web/contracts.aug#L13)
+
+### RequestLogger.complete
+
+```text
+complete(string method, string path, int status, int milliseconds) uses RequestLogger.complete
+```
+
+The signature declares inputs, result, effects and checked errors.
+
+[Source](https://github.com/GreenPandaStudios/augscript/blob/main/src/stdlib/web/contracts.aug#L14)
+
+## WebRequestLogger {#api-WebRequestLogger}
+
+```text
+WebRequestLogger() implements RequestLogger
+```
+
+Emit escaped JSON request metadata to standard error. Credentials and query strings are excluded.
+
+[Source](https://github.com/GreenPandaStudios/augscript/blob/main/src/stdlib/web/contracts.aug#L18)
+
+### WebRequestLogger.complete
+
+```text
+complete(string method, string path, int status, int milliseconds)
+```
+
+The signature declares inputs, result, effects and checked errors.
+
+Inferred capabilities: `RequestLogger.complete`.
+
+[Source](https://github.com/GreenPandaStudios/augscript/blob/main/src/stdlib/web/contracts.aug#L19)
+
+## HttpClient {#api-HttpClient}
+
+```text
+capability HttpClient
+```
+
+An explicit outbound network capability. TLS verifies the peer and redirects are returned to the caller.
+
+[Source](https://github.com/GreenPandaStudios/augscript/blob/main/src/stdlib/web/contracts.aug#L24)
+
+### HttpClient.request
+
+```text
+request(string method, string url, optional Headers headers, optional Bytes body) returns HttpResponse<Bytes> uses HttpClient.request unless HttpError
+```
+
+Perform an HTTP request with bounded bytes. Inside a task, waiting suspends the task's C stack.
+
+[Source](https://github.com/GreenPandaStudios/augscript/blob/main/src/stdlib/web/contracts.aug#L26)
+
+## WebHttpClient {#api-WebHttpClient}
+
+```text
+WebHttpClient() implements HttpClient
+```
+
+Native libwebsockets transport. No socket is opened by construction.
+
+[Source](https://github.com/GreenPandaStudios/augscript/blob/main/src/stdlib/web/contracts.aug#L31)
+
+### WebHttpClient.request
+
+```text
+request(string method, string url, optional Headers headers, optional Bytes body) returns HttpResponse<Bytes> unless HttpError
+```
+
+Perform an HTTP request with bounded bytes. Inside a task, waiting suspends the task's C stack.
+
+Inferred capabilities: `HttpClient.request`.
+
+[Source](https://github.com/GreenPandaStudios/augscript/blob/main/src/stdlib/web/contracts.aug#L32)
+
+## redirect {#api-redirect}
+
+```text
+redirect(string location, optional int status) returns HttpResponse<string> unless HttpError
+```
+
+Return a redirect with an explicit status. Location is checked as a header value.
+
+[Source](https://github.com/GreenPandaStudios/augscript/blob/main/src/stdlib/web/contracts.aug#L37)
+
+## urlEncode {#api-urlEncode}
+
+```text
+urlEncode(string input) returns string unless HttpError
+```
+
+Encode a UTF-8 value as one URL query or form component using RFC 3986 unreserved characters.
+
+[Source](https://github.com/GreenPandaStudios/augscript/blob/main/src/stdlib/web/contracts.aug#L49)
+
+## cookie {#api-cookie}
+
+```text
+cookie(string name, string value, string path, int maxAge, bool secure) returns Headers unless HttpError
+```
+
+Construct an HttpOnly, SameSite=Lax session cookie. Secure defaults are chosen explicitly at the call site. Values and paths reject delimiters and controls. maxAge=0 clears the cookie.
+
+[Source](https://github.com/GreenPandaStudios/augscript/blob/main/src/stdlib/web/contracts.aug#L55)