@greenpandastudios/aug-cli 0.19.0 → 0.21.0

package/examples/oidc-login/.aug-spec/august/0.19.0/web/contracts.aug.md

@@ -1,420 +0,0 @@
-<!-- Generated by aug spec. Edit the August source, then regenerate. -->
-
-# `contracts.aug` specification
-
-August 0.19.0. This document is compiled from checked code with deterministic wording guided by Simplified Technical English.
-
-## In this file
-
-- [`Principal`](contracts.aug.md#symbol-Principal) is an immutable record.
-- [`Authentication`](contracts.aug.md#symbol-Authentication) is a capability interface.
-- [`Authorization`](contracts.aug.md#symbol-Authorization) is a capability interface.
-- [`RequestLogger`](contracts.aug.md#symbol-RequestLogger) is a capability interface.
-- [`_aug_http_log`](contracts.aug.md#symbol-_aug_http_log) is a function.
-- [`WebRequestLogger`](contracts.aug.md#symbol-WebRequestLogger) is a class implementing `RequestLogger`.
-- [`HttpClient`](contracts.aug.md#symbol-HttpClient) is a capability interface.
-- [`_aug_http_request`](contracts.aug.md#symbol-_aug_http_request) is a function returning `HttpResponse<Bytes>`.
-- [`WebHttpClient`](contracts.aug.md#symbol-WebHttpClient) is a class implementing `HttpClient`.
-- [`redirect`](contracts.aug.md#symbol-redirect) is a function returning `HttpResponse<string>`.
-- [`_aug_http_url_encode`](contracts.aug.md#symbol-_aug_http_url_encode) is a function returning `string`.
-- [`urlEncode`](contracts.aug.md#symbol-urlEncode) is a function returning `string`.
-- [`_aug_http_cookie`](contracts.aug.md#symbol-_aug_http_cookie) is a function returning `Headers`.
-- [`cookie`](contracts.aug.md#symbol-cookie) is a function returning `Headers`.
-
-<a id="symbol-Principal"></a>
-
-## `Principal`
-
-[source](contracts.aug#L3)
-
-Immutable record.
-
-**Author documentation**
-
-Immutable identity returned by an explicitly injected authentication adapter.
-
-**Inputs**
-
-- `subject` (`string`) — required labeled input — stored as `subject` and read-only after initialization.
-- `permissions` (`List<string>`) — required labeled input — stored as `permissions` and read-only after initialization.
-
-<a id="symbol-Authentication"></a>
-
-## `Authentication`
-
-[source](contracts.aug#L6)
-
-Capability interface.
-
-**Author documentation**
-
-Verify the request's credentials. null means unauthenticated; adapter failures raise HttpError.
-
-<a id="symbol-Authentication.authenticate"></a>
-
-### `Authentication.authenticate`
-
-[source](contracts.aug#L7)
-
-**Inputs**
-
-- `request` (`HttpRequest`) — required labeled input.
-
-Returns: [`optional Principal`](contracts.aug.md#symbol-Principal).
-
-Capabilities: [`Authentication.authenticate`](contracts.aug.md#symbol-Authentication.authenticate).
-
-Can fail with `HttpError`. Callers must catch or propagate these errors.
-
-Interface contract. A selected implementation supplies the behavior.
-
-<a id="symbol-Authorization"></a>
-
-## `Authorization`
-
-[source](contracts.aug#L10)
-
-Capability interface.
-
-**Author documentation**
-
-Decide whether a verified identity has one named permission.
-
-<a id="symbol-Authorization.authorize"></a>
-
-### `Authorization.authorize`
-
-[source](contracts.aug#L11)
-
-**Inputs**
-
-- `identity` ([`Principal`](contracts.aug.md#symbol-Principal)) — required labeled input.
-- `permission` (`string`) — required labeled input.
-
-Returns: `bool`.
-
-Capabilities: [`Authorization.authorize`](contracts.aug.md#symbol-Authorization.authorize).
-
-Can fail with `HttpError`. Callers must catch or propagate these errors.
-
-Interface contract. A selected implementation supplies the behavior.
-
-<a id="symbol-RequestLogger"></a>
-
-## `RequestLogger`
-
-[source](contracts.aug#L14)
-
-Capability interface.
-
-**Author documentation**
-
-Observe a completed HTTP exchange, including failures and disconnects.
-
-<a id="symbol-RequestLogger.complete"></a>
-
-### `RequestLogger.complete`
-
-[source](contracts.aug#L15)
-
-**Inputs**
-
-- `method` (`string`) — required labeled input.
-- `path` (`string`) — required labeled input.
-- `status` (`int`) — required labeled input.
-- `milliseconds` (`int`) — required labeled input.
-
-Returns: no value.
-
-Capabilities: [`RequestLogger.complete`](contracts.aug.md#symbol-RequestLogger.complete).
-
-Interface contract. A selected implementation supplies the behavior.
-
-<a id="symbol-WebRequestLogger"></a>
-
-## `WebRequestLogger`
-
-[source](contracts.aug#L19)
-
-Behavioral class.
-
-Satisfies [`RequestLogger`](contracts.aug.md#symbol-RequestLogger).
-
-**Author documentation**
-
-Emit escaped JSON request metadata to standard error. Credentials and query strings are excluded.
-
-<a id="symbol-WebRequestLogger.complete"></a>
-
-### `WebRequestLogger.complete`
-
-[source](contracts.aug#L20)
-
-**Inputs**
-
-- `method` (`string`) — required labeled input.
-- `path` (`string`) — required labeled input.
-- `status` (`int`) — required labeled input.
-- `milliseconds` (`int`) — required labeled input.
-
-Returns: no value.
-
-Capabilities: [`RequestLogger.complete`](contracts.aug.md#symbol-RequestLogger.complete).
-
-**What it does**
-
-- Enter an unsafe boundary. Native calls use their declared contracts; their foreign implementation is outside this specification:
-  - Call [`_aug_http_log`](contracts.aug.md#symbol-_aug_http_log) with `method` = `method`; `path` = `path`; `status` = `status`; `milliseconds` = `milliseconds`.
-
-<a id="symbol-HttpClient"></a>
-
-## `HttpClient`
-
-[source](contracts.aug#L25)
-
-Capability interface.
-
-**Author documentation**
-
-An explicit outbound network capability. TLS verifies the peer and redirects are returned to the caller.
-
-<a id="symbol-HttpClient.request"></a>
-
-### `HttpClient.request`
-
-[source](contracts.aug#L27)
-
-**Inputs**
-
-- `method` (`string`) — required labeled input.
-- `url` (`string`) — required labeled input.
-- `headers` (`optional Headers`) — optional labeled input; omission becomes null.
-- `body` (`optional Bytes`) — optional labeled input; omission becomes null.
-
-Returns: `HttpResponse<Bytes>`.
-
-Capabilities: [`HttpClient.request`](contracts.aug.md#symbol-HttpClient.request).
-
-Can fail with `HttpError`. Callers must catch or propagate these errors.
-
-Interface contract. A selected implementation supplies the behavior.
-
-**Author documentation**
-
-Perform an HTTP request with bounded bytes. Inside a task, waiting suspends the task's C stack.
-
-<a id="symbol-WebHttpClient"></a>
-
-## `WebHttpClient`
-
-[source](contracts.aug#L32)
-
-Behavioral class.
-
-Satisfies [`HttpClient`](contracts.aug.md#symbol-HttpClient).
-
-**Author documentation**
-
-Native libwebsockets transport. No socket is opened by construction.
-
-<a id="symbol-WebHttpClient.request"></a>
-
-### `WebHttpClient.request`
-
-[source](contracts.aug#L33)
-
-**Inputs**
-
-- `method` (`string`) — required labeled input.
-- `url` (`string`) — required labeled input.
-- `headers` (`optional Headers`) — optional labeled input; omission becomes null.
-- `body` (`optional Bytes`) — optional labeled input; omission becomes null.
-
-Returns: `HttpResponse<Bytes>`.
-
-Capabilities: [`HttpClient.request`](contracts.aug.md#symbol-HttpClient.request).
-
-Can fail with `HttpError`. Callers must catch or propagate these errors.
-
-**What it does**
-
-- Enter an unsafe boundary. Native calls use their declared contracts; their foreign implementation is outside this specification:
-  - Return call [`_aug_http_request`](contracts.aug.md#symbol-_aug_http_request) with `method` = `method`; `url` = `url`; `headers` = `headers`; `body` = `body`.
-
-**Author documentation**
-
-Perform an HTTP request with bounded bytes. Inside a task, waiting suspends the task's C stack.
-
-<a id="symbol-redirect"></a>
-
-## `redirect`
-
-[source](contracts.aug#L38)
-
-**Inputs**
-
-- `location` (`string`) — required labeled input.
-- `status` (`optional int`) — optional labeled input; omission becomes null.
-
-Returns: `HttpResponse<string>`.
-
-Can fail with `HttpError`. Callers must catch or propagate these errors.
-
-**What it does**
-
-- Set `code` to `303`.
-- Select the matching case for `status`:
-  - A null value, including omitted optional input:
-    - Continue without another operation.
-  - A present, non-null value, named `value`:
-    - Set `code` to `value`.
-- Set `headers` to call `with` on call `Headers` with `name` = `"location"`; `value` = `location`.
-- Return call `HttpResponse` with `body` = `""`; `status` = `code`; `headers` = `headers`.
-
-**Author documentation**
-
-Return a redirect with an explicit status. Location is checked as a header value.
-
-<a id="symbol-urlEncode"></a>
-
-## `urlEncode`
-
-[source](contracts.aug#L50)
-
-**Inputs**
-
-- `input` (`string`) — required labeled input.
-
-Returns: `string`.
-
-Can fail with `HttpError`. Callers must catch or propagate these errors.
-
-**What it does**
-
-- Enter an unsafe boundary. Native calls use their declared contracts; their foreign implementation is outside this specification:
-  - Return call [`_aug_http_url_encode`](contracts.aug.md#symbol-_aug_http_url_encode) with `input` = `input`.
-
-**Author documentation**
-
-Encode a UTF-8 value as one URL query or form component using RFC 3986 unreserved characters.
-
-<a id="symbol-cookie"></a>
-
-## `cookie`
-
-[source](contracts.aug#L56)
-
-**Inputs**
-
-- `name` (`string`) — required labeled input.
-- `value` (`string`) — required labeled input.
-- `path` (`string`) — required labeled input.
-- `maxAge` (`int`) — required labeled input.
-- `secure` (`bool`) — required labeled input.
-
-Returns: `Headers`.
-
-Can fail with `HttpError`. Callers must catch or propagate these errors.
-
-**What it does**
-
-- Enter an unsafe boundary. Native calls use their declared contracts; their foreign implementation is outside this specification:
-  - Return call [`_aug_http_cookie`](contracts.aug.md#symbol-_aug_http_cookie) with `name` = `name`; `value` = `value`; `path` = `path`; `maxAge` = `maxAge`; `secure` = `secure`.
-
-**Author documentation**
-
-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.
-
-<a id="symbol-_aug_http_log"></a>
-
-## `_aug_http_log`
-
-[source](contracts.aug#L17)
-
-Private to its defining scope.
-
-**Inputs**
-
-- `method` (`string`) — required labeled input.
-- `path` (`string`) — required labeled input.
-- `status` (`int`) — required labeled input.
-- `milliseconds` (`int`) — required labeled input.
-
-Returns: no value.
-
-Capabilities: [`RequestLogger.complete`](contracts.aug.md#symbol-RequestLogger.complete).
-
-Native C operation. Its declared inputs, result, effects, and errors are the visible contract. The C implementation is outside this specification.
-
-<a id="symbol-_aug_http_request"></a>
-
-## `_aug_http_request`
-
-[source](contracts.aug#L29)
-
-Private to its defining scope.
-
-**Inputs**
-
-- `method` (`string`) — required labeled input.
-- `url` (`string`) — required labeled input.
-- `headers` (`optional Headers`) — optional labeled input; omission becomes null.
-- `body` (`optional Bytes`) — optional labeled input; omission becomes null.
-
-Returns: `HttpResponse<Bytes>`.
-
-Capabilities: [`HttpClient.request`](contracts.aug.md#symbol-HttpClient.request).
-
-Can fail with `HttpError`. Callers must catch or propagate these errors.
-
-Native C operation. Its declared inputs, result, effects, and errors are the visible contract. The C implementation is outside this specification.
-
-<a id="symbol-_aug_http_url_encode"></a>
-
-## `_aug_http_url_encode`
-
-[source](contracts.aug#L48)
-
-Private to its defining scope.
-
-**Inputs**
-
-- `input` (`string`) — required labeled input.
-
-Returns: `string`.
-
-Can fail with `HttpError`. Callers must catch or propagate these errors.
-
-Native C operation. Its declared inputs, result, effects, and errors are the visible contract. The C implementation is outside this specification.
-
-<a id="symbol-_aug_http_cookie"></a>
-
-## `_aug_http_cookie`
-
-[source](contracts.aug#L54)
-
-Private to its defining scope.
-
-**Inputs**
-
-- `name` (`string`) — required labeled input.
-- `value` (`string`) — required labeled input.
-- `path` (`string`) — required labeled input.
-- `maxAge` (`int`) — required labeled input.
-- `secure` (`bool`) — required labeled input.
-
-Returns: `Headers`.
-
-Can fail with `HttpError`. Callers must catch or propagate these errors.
-
-Native C operation. Its declared inputs, result, effects, and errors are the visible contract. The C implementation is outside this specification.
-
-## Built-in operations used by this file
-
-- `Headers.with` (`name`: `string`, `value`: `string`) → `Headers`: Return new headers with one additional validated field. Header names ignore case; duplicate values remain separate. Can fail with `HttpError`.
-
-[Full built-in reference](https://greenpandastudios.github.io/augscript/language-constructs).
-
-## Shared language rules
-
-See the [language reference](https://greenpandastudios.github.io/augscript/reference) for numeric, equality, ownership, and task rules.

package/examples/ownership-transfer/.aug-spec/august/0.19.0/io/contracts.aug

@@ -1,36 +0,0 @@
-// Generated by aug spec. This is a copy of the installed dependency source.
-/** Permission to write to a console, provided by an explicitly selected adapter. */
-capability Console:
-    /** Write one line of text. @param value Text to display. */
-    write<T>(T value) uses Console.write
-
-/** The native standard-output adapter. Construction performs no output. */
-SystemConsole() implements Console:
-    write<T>(T value):
-        print(value=value)
-
-/** Read UTF-8 text through an explicitly selected filesystem adapter. */
-capability FileReader:
-    /** Read text. @param path File path. @throws FileError The file could not be read. */
-    read(string path) returns string uses FileReader.read unless FileError
-
-/** Write UTF-8 text through an explicitly selected filesystem adapter. */
-capability FileWriter:
-    /** Write text. @param path File path. @param content Text. @throws FileError Writing failed. */
-    write(string path, string content) uses FileWriter.write unless FileError
-
-/** Native files. Operations are explicit; construction opens no files. */
-LocalFiles() implements FileReader, FileWriter:
-    read(string path) returns string unless FileError:
-        return read_file(path=path)
-    write(string path, string content) unless FileError:
-        write_file(path=path, content=content)
-
-/** Read command-line input through an explicit dependency. */
-capability Arguments:
-    read() returns List<string> uses Arguments.read
-
-/** Native command-line arguments. */
-ProcessArguments() implements Arguments:
-    read() returns List<string>:
-        return arguments()