allsquare 0.1.1

package/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+## 0.1.1
+
+First public beta of the AllSquare CLI.
+
+- Groups, expenses, recurring expenses, balances, settlements, and spend
+  summaries over the AllSquare `/api/v1` API
+- OAuth login with PKCE and OS keychain storage; read and write access by
+  default, `--read-only` available
+- Stable JSON output, error codes with a `retryable` flag, and distinct exit
+  codes for agents
+- Safe retries with `--idempotency-key`, including replayed results after a
+  lost response
+- `allsquare agent-guide` for AI agents; guarded self-update with
+  `allsquare update`

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Swann&Co. LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,234 @@
+# AllSquare CLI
+
+Agent-friendly command-line access to AllSquare through the public `/api/v1`
+HTTP API.
+
+## Status
+
+**Beta.** Commands, the JSON envelope, error codes, and exit codes are intended
+to stay compatible; new fields and commands will be added. Breaking changes, if
+needed, will come in a minor version with release notes.
+
+## Requirements
+
+- Node.js 22 or newer
+- An AllSquare account
+
+## Install
+
+```sh
+npm install --global allsquare
+allsquare auth login
+```
+
+`allsquare update` upgrades a global npm, pnpm, Yarn, or Bun installation.
+
+## Current commands
+
+```sh
+allsquare --help
+allsquare --version
+allsquare agent-guide [--json]
+allsquare update --check [--json]
+allsquare update [--yes] [--json]
+allsquare auth login
+allsquare auth login --read-only
+allsquare auth login --no-browser
+allsquare auth status
+allsquare auth refresh
+allsquare auth logout
+allsquare groups list
+allsquare groups members <group-id>
+allsquare groups create --name TEXT --currency CODE [--member-email EMAIL]
+allsquare groups add-member <group-id> --email EMAIL
+allsquare balances list [--currency USD]
+allsquare balances show <group-id> [--currency USD]
+allsquare expenses list [--group-id ID] [--query TEXT] [--from YYYY-MM-DD] [--to YYYY-MM-DD]
+allsquare expenses list [--paid-by-id MEMBER_ID] [--is-recurring true|false] [--is-settled true|false]
+allsquare expenses list [--limit 20] [--cursor CURSOR]
+allsquare expenses get <expense-id>
+allsquare expenses create <group-id> --description TEXT --amount DECIMAL --currency CODE
+allsquare expenses create <group-id> [--paid-by-id ID] [--split-with ID] [--split-type amount|percentage|exact]
+allsquare expenses create <group-id> [--percentage-split ID=PERCENT] [--exact-split ID=AMOUNT] [--date YYYY-MM-DD]
+allsquare expenses update <expense-id> [--description TEXT] [--amount DECIMAL] [--currency CODE]
+allsquare expenses update <expense-id> [--paid-by-id ID] [--split-with ID] [--split-type amount|percentage|exact]
+allsquare expenses delete <expense-id> [--yes]
+allsquare recurring-expenses list [--group-id ID]
+allsquare recurring-expenses get <recurring-expense-id>
+allsquare recurring-expenses create <group-id> --description TEXT --amount DECIMAL --currency CODE --frequency FREQUENCY
+allsquare recurring-expenses create <group-id> [--start-date YYYY-MM-DD] [--paid-by-id ID] [--split-with ID]
+allsquare recurring-expenses update <recurring-expense-id> [--description TEXT] [--amount DECIMAL] [--frequency FREQUENCY]
+allsquare recurring-expenses update <recurring-expense-id> [--paid-by-id ID] [--split-with ID] [--split-type amount|percentage|exact]
+allsquare recurring-expenses pause <recurring-expense-id>
+allsquare recurring-expenses resume <recurring-expense-id>
+allsquare recurring-expenses delete <recurring-expense-id> [--yes]
+allsquare settlements list [--group-id ID] [--limit 20]
+allsquare settlements preview <group-id> --expense-id ID [--expense-id ID] [--currency USD]
+allsquare settlements settle <group-id> --expense-id ID [--expense-id ID] [--currency USD] [--yes]
+allsquare spend-summary show [--group-id ID] [--from YYYY-MM-DD] [--to YYYY-MM-DD]
+allsquare spend-summary show [--query TEXT] [--currency USD]
+allsquare config show
+allsquare config show --json
+```
+
+Add `--json` to any leaf command for machine-readable output. Login opens the
+system browser by default and completes through an ephemeral loopback callback.
+Use `--no-browser` to print the authorization URL without opening it.
+
+Each CLI installation registers its own OAuth public client. Authorization uses
+PKCE, access tokens refresh automatically shortly before expiry, and refreshes
+are serialized across concurrent processes so agents cannot accidentally reuse
+a rotated refresh token. Plain `auth login` requests the CLI's normal read and
+write access in one consent flow. Use `auth login --read-only` to request only
+read access; write commands then fail with `AUTH_REQUIRED` rather than asking
+for more access. If a write command runs with no session at all from an
+interactive terminal, the CLI opens consent, waits for approval, then continues
+that same command. With `--json` or without a terminal it fails immediately with
+`AUTH_REQUIRED` (exit 3) so scripts and agents never wait on a browser. The
+older `auth login --write` flag remains accepted as an alias for the default; it
+is not required. Logging in again, including with `--read-only`, revokes the
+previous session's tokens; if that revocation cannot be confirmed, the login
+still succeeds and reports `replacedSessionRevocation: "unconfirmed"`.
+
+Refresh tokens are stored in the operating system credential vault (macOS
+Keychain, Windows Credential Manager, or a Linux Secret Service provider).
+Linux installations therefore need a working Secret Service implementation
+such as GNOME Keyring, KWallet, or KeePassXC. Non-secret client registration
+metadata is stored in the OS-standard application config directory with private
+permissions.
+
+The default profile retains its existing keychain account. Setting
+`ALLSQUARE_CONFIG_DIR` creates a separate credential namespace for that folder,
+even when it targets the same API URL. A custom-folder profile does not read or
+move credentials stored under the old unscoped account name; log in separately
+in that profile if it previously relied on those credentials.
+Log out of a custom-folder profile before deleting its folder; deleting the
+folder alone does not remove its operating-system credential entry.
+
+The CLI targets `https://allsquare.app/api/v1` by default. Set
+`ALLSQUARE_API_URL` to use another deployment. Plain HTTP is accepted only for
+loopback URLs such as `http://localhost:3000/api/v1`.
+
+Successful JSON output uses `{ "ok": true, "data": ... }`. When a write
+reuses an idempotency key the server has already completed, the output adds
+`"replayed": true` (human output prints a note on stderr): nothing new was
+written, and `data` is the original result, which may describe a resource that
+has since changed or been deleted. Expected failures
+use `{ "ok": false, "error": { "code": ..., "message": ..., "retryable": ... } }` on stderr
+and exit nonzero, including argument-parser failures. Every error includes
+`retryable`: true only when repeating the same command can succeed unchanged
+(rate limits, service or network failures, temporary login-service errors, a
+busy session refresh, or `IN_PROGRESS` while the same idempotent write is still
+running); retry writes with the same `--idempotency-key`. Error codes use one style
+(`INVALID_ARGUMENT`, `AUTH_REQUIRED`, `FORBIDDEN`, `NOT_FOUND`, `CONFLICT`,
+`RATE_LIMITED`, `SERVICE_UNAVAILABLE`, `NETWORK_ERROR`, ...); the server's own
+code is kept in `details.apiCode`. A group that does not exist returns
+`FORBIDDEN`, the same as one you cannot access. Exit codes are 0 for success,
+2 for invalid input or configuration, 3 for authentication or permission, 4 for
+conflicts, 5 for temporary or service failures, and 6 for not found.
+Unexpected failures may exit 1. `allsquare agent-guide --json` lists every
+code.
+
+`auth logout` always tries to remove local credentials even if the OAuth
+server cannot be reached. Its JSON result includes `revocation` (`confirmed`,
+`unconfirmed`, or `not_needed`). An unconfirmed result means the token may
+remain valid on the server; revoke the CLI connection in AllSquare settings if
+you need immediate server-side invalidation.
+
+## Agent use
+
+Agents should begin with `allsquare agent-guide --json`. The guide is a
+versioned, machine-readable operating contract covering resource discovery,
+pagination, least-privilege authorization, write confirmation, idempotent
+retries, deletion, settlement, Venmo handoff, and the CLI output contract. The
+same content is available for humans with `allsquare agent-guide`.
+
+The guide supplements safeguards enforced by the CLI. In particular, `--yes`
+means the calling agent has already obtained the required user confirmation; it
+does not grant permission on its own. Agents must preview settlements, render
+any returned Venmo links, avoid claiming that AllSquare completed or verified
+an external Venmo transaction, and record only the expense IDs the user
+selected.
+
+`allsquare update --check` compares the installed version with the npm
+`latest` release without changing the installation. `allsquare update` can
+update recognized npm, pnpm, Yarn, or Bun global installations after an
+interactive confirmation; agents and other non-interactive callers must pass
+`--yes`. Source checkouts, local project dependencies, ephemeral invocations,
+and ambiguous installations are never modified automatically. The command
+returns installation-specific guidance instead. JSON execution captures
+package-manager output so the final success or error envelope remains
+machine-readable.
+
+Group creation requires an explicit default currency. Repeat `--member-email`
+to add existing accounts or invite up to 20 initial members. `groups add-member`
+uses the same add-or-invite behavior for one address. These operations can send
+email; JSON output reports whether the membership or invitation was created and
+whether its notification was delivered. Both writes are idempotent, and
+`--idempotency-key` is available when retrying the same logical request.
+
+Settlement preview is non-mutating and works with read-only authorization. It
+accepts up to 100 repeated `--expense-id` flags and shows the payments that a
+settlement would create without recording the settlement.
+
+Settlement execution requires write authorization and always previews the exact
+expense IDs before recording anything. Interactive confirmation defaults to
+“no”; agents, JSON callers, and other non-interactive sessions must pass
+`--yes`. The confirmed request is idempotent, and `--idempotency-key` can be
+reused when retrying the same logical settlement: if the first attempt
+succeeded but its response was lost, the retry returns the original settlement
+with `"replayed": true` even though the preview now reports the expenses as
+settled. `expenses delete` and `recurring-expenses delete` behave the same way:
+a retry with the original `--idempotency-key` returns the original deletion even
+though the item is already gone. Recording a settlement marks
+the selected expenses settled; it does not transfer money.
+
+Expense creation requires an explicit currency: USD, CAD, EUR, or GBP. Write commands need a session
+with write access; see the login notes above for when the CLI can prompt for
+one. `--split-type amount` means split equally between the payer and each
+`--split-with` member; the payer is always included. In a two-person
+group, omitting `--split-with` splits with the other member (as the web app
+does); larger groups must name at least one member besides the payer. Percentage and exact modes
+accept repeated `MEMBER_ID=VALUE` allocation flags, validate their totals
+locally, and include every named member even if it is not repeated in
+`--split-with`. `--date` defaults to today in your local time zone. A retry with
+`--idempotency-key` must be the identical command: the same flags and values,
+including `--date` (it is in the first attempt's result) and `--currency`;
+otherwise the server rejects it as a different request. The order of repeated
+flags such as `--split-with` or `--expense-id` does not matter. The CLI generates an idempotency
+key automatically; pass `--idempotency-key` only when retrying the same logical
+creation across separate invocations.
+
+Expense updates are partial, except that changing a split requires
+`--split-type` plus the complete replacement participant list. Interactive
+deletion displays the current expense and defaults to “no.” Agents and JSON
+callers must pass `--yes`; deletion still reads the exact target before sending
+the confirmed, idempotent delete request.
+
+Recurring-expense writes use the same participant, split, amount, and
+idempotency safeguards. Frequencies are `weekly`, `biweekly`, `monthly`, or
+`yearly`. Pausing keeps generated history and stops future generation; resuming
+continues from the next scheduled date without backfilling the paused period.
+Recurring deletion is permanent, displays the exact template first for
+interactive users, and requires `--yes` for agents and JSON callers. Deleting a
+template stops future expenses but keeps the ones it already created. A
+template whose start date is today or earlier creates its first expense
+immediately and returns its ID as `immediateExpenseId` (`null` when only
+scheduled). Updates cannot change the next date or the currency; delete and
+recreate the template instead.
+
+## Development
+
+The CLI is a standalone package inside the AllSquare repository. It does not
+import application or server modules from the repository root.
+
+```sh
+cd cli
+pnpm install
+pnpm check
+```
+
+Before packaging from this repository, install both the root and `cli/`
+dependencies, then run `pnpm --dir cli run prepack`. That gate runs the CLI
+checks and compares its schemas with the generated v1 API contract. The CI
+workflow runs both test suites on each push and pull request.

package/dist/api/client.d.ts

@@ -0,0 +1,46 @@
+import { Context, Crypto, Effect, Layer, Schema } from "effect";
+import { HttpClient } from "effect/unstable/http";
+import { AuthService } from "../auth/auth-service.js";
+import type { AuthError } from "../auth/auth-service.js";
+import { API_READ_SCOPE, API_WRITE_SCOPE } from "../auth/model.js";
+import { CliConfig } from "../config.js";
+import { ApiRequestError } from "../errors.js";
+import { Interaction } from "../interaction.js";
+export type ApiClientError = AuthError | ApiRequestError;
+export interface ApiResponse<A> {
+    readonly data: A;
+    readonly replayed: boolean;
+}
+type ResponseSchema<A> = Schema.ConstraintCodec<A, unknown, never, unknown>;
+type BodySchema<B> = Schema.ConstraintCodec<B, unknown, never, never>;
+type Query = Readonly<Record<string, string | undefined>>;
+interface BaseRequestOptions<A> {
+    readonly path: string;
+    readonly query?: Query;
+    readonly schema: ResponseSchema<A>;
+}
+interface BodyRequestOptions<A, B> extends BaseRequestOptions<A> {
+    readonly body: B;
+    readonly bodySchema: BodySchema<B>;
+}
+type PostRequestOptions<A, B> = BodyRequestOptions<A, B> & ({
+    readonly scope: typeof API_READ_SCOPE;
+    readonly idempotencyKey?: never;
+} | {
+    readonly scope: typeof API_WRITE_SCOPE;
+    readonly idempotencyKey?: string;
+});
+interface WriteRequestOptions<A, B> extends BodyRequestOptions<A, B> {
+    readonly idempotencyKey?: string;
+}
+declare const ApiClient_base: Context.ServiceClass<ApiClient, "@allsquare/cli/ApiClient", {
+    readonly get: <A>(options: BaseRequestOptions<A>) => Effect.Effect<A, ApiClientError>;
+    readonly post: <A, B>(options: PostRequestOptions<A, B>) => Effect.Effect<ApiResponse<A>, ApiClientError>;
+    readonly patch: <A, B>(options: WriteRequestOptions<A, B>) => Effect.Effect<ApiResponse<A>, ApiClientError>;
+    readonly delete: <A, B>(options: WriteRequestOptions<A, B>) => Effect.Effect<ApiResponse<A>, ApiClientError>;
+}>;
+export declare class ApiClient extends ApiClient_base {
+    static readonly layer: Layer.Layer<ApiClient, never, CliConfig | Crypto.Crypto | HttpClient.HttpClient | AuthService | Interaction>;
+}
+export {};
+//# sourceMappingURL=client.d.ts.map

package/dist/api/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/api/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAU,MAAM,EAAE,MAAM,QAAQ,CAAA;AAChF,OAAO,EACL,UAAU,EAGX,MAAM,sBAAsB,CAAA;AAE7B,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AACrD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;AAClE,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AACxC,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AA+C/C,MAAM,MAAM,cAAc,GAAG,SAAS,GAAG,eAAe,CAAA;AAExD,MAAM,WAAW,WAAW,CAAC,CAAC;IAC5B,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAA;IAGhB,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAA;CAC3B;AAED,KAAK,cAAc,CAAC,CAAC,IAAI,MAAM,CAAC,eAAe,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;AAC3E,KAAK,UAAU,CAAC,CAAC,IAAI,MAAM,CAAC,eAAe,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,CAAA;AACrE,KAAK,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,CAAA;AAEzD,UAAU,kBAAkB,CAAC,CAAC;IAC5B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,CAAA;IACtB,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC,CAAC,CAAA;CACnC;AAED,UAAU,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAE,SAAQ,kBAAkB,CAAC,CAAC,CAAC;IAC9D,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAA;IAChB,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,CAAA;CACnC;AAED,KAAK,kBAAkB,CAAC,CAAC,EAAE,CAAC,IAAI,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CACvD;IACE,QAAQ,CAAC,KAAK,EAAE,OAAO,cAAc,CAAA;IACrC,QAAQ,CAAC,cAAc,CAAC,EAAE,KAAK,CAAA;CAChC,GACD;IACE,QAAQ,CAAC,KAAK,EAAE,OAAO,eAAe,CAAA;IACtC,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAA;CACjC,CACJ,CAAA;AAED,UAAU,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAE,SAAQ,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC;IAClE,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAA;CACjC;;kBAGe,CAAC,CAAC,EACd,OAAO,EAAE,kBAAkB,CAAC,CAAC,CAAC,KAC3B,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,cAAc,CAAC;mBACtB,CAAC,CAAC,EAAE,CAAC,EAClB,OAAO,EAAE,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,KAC9B,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,cAAc,CAAC;oBAClC,CAAC,CAAC,EAAE,CAAC,EACnB,OAAO,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,KAC/B,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,cAAc,CAAC;qBACjC,CAAC,CAAC,EAAE,CAAC,EACpB,OAAO,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,KAC/B,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,cAAc,CAAC;;AAZpD,qBAAa,SAAU,SAAQ,cAaC;IAC9B,MAAM,CAAC,QAAQ,CAAC,KAAK,+GAgNpB;CACF"}

package/dist/api/client.js

@@ -0,0 +1,162 @@
+import { Console, Context, Crypto, Effect, Layer, Option, Schema } from "effect";
+import { HttpClient, HttpClientRequest, HttpClientResponse } from "effect/unstable/http";
+import { AuthService } from "../auth/auth-service.js";
+import { API_READ_SCOPE, API_WRITE_SCOPE } from "../auth/model.js";
+import { CliConfig } from "../config.js";
+import { ApiRequestError } from "../errors.js";
+import { Interaction } from "../interaction.js";
+import { VERSION } from "../version.js";
+const ApiErrorBody = Schema.Struct({
+    error: Schema.String,
+    code: Schema.optionalKey(Schema.String),
+    fields: Schema.optionalKey(Schema.Record(Schema.String, Schema.String)),
+    route: Schema.optionalKey(Schema.String),
+    retryAfterSeconds: Schema.optionalKey(Schema.Number)
+});
+const apiErrorFromResponse = (status, body) => {
+    let decoded;
+    try {
+        const result = Schema.decodeUnknownOption(ApiErrorBody)(JSON.parse(body));
+        decoded = Option.getOrUndefined(result);
+    }
+    catch {
+        decoded = undefined;
+    }
+    return new ApiRequestError({
+        message: decoded?.error ?? `API request failed with status ${status}`,
+        status,
+        ...(decoded?.code === undefined ? {} : { apiCode: decoded.code }),
+        ...(decoded?.fields === undefined ? {} : { fields: decoded.fields }),
+        ...(decoded?.route === undefined ? {} : { route: decoded.route }),
+        ...(decoded?.retryAfterSeconds === undefined
+            ? {}
+            : { retryAfterSeconds: decoded.retryAfterSeconds })
+    });
+};
+const requestUrl = (apiUrl, path, query) => {
+    const url = new URL(`${apiUrl.replace(/\/+$/, "")}/${path.replace(/^\/+/, "")}`);
+    for (const [key, value] of Object.entries(query)) {
+        if (value !== undefined)
+            url.searchParams.set(key, value);
+    }
+    return url.toString();
+};
+export class ApiClient extends Context.Service()("@allsquare/cli/ApiClient") {
+    static layer = Layer.effect(ApiClient, Effect.gen(function* () {
+        const config = yield* CliConfig;
+        const auth = yield* AuthService;
+        const interaction = yield* Interaction;
+        const client = yield* HttpClient.HttpClient;
+        const crypto = yield* Crypto.Crypto;
+        const execute = (request, token, schema) => client.execute(request.pipe(HttpClientRequest.setHeader("accept", "application/json"), HttpClientRequest.setHeader("user-agent", `allsquare-cli/${VERSION}`), HttpClientRequest.bearerToken(token))).pipe(Effect.flatMap((response) => {
+            if (response.status < 200 || response.status >= 300) {
+                return response.text.pipe(Effect.orElseSucceed(() => ""), Effect.flatMap((body) => Effect.fail(apiErrorFromResponse(response.status, body))));
+            }
+            return HttpClientResponse.schemaBodyJson(schema)(response).pipe(Effect.map((data) => ({
+                data,
+                replayed: response.headers["idempotent-replayed"] === "true"
+            })), Effect.mapError((cause) => new ApiRequestError({
+                message: `API returned an invalid response: ${cause.message}`,
+                status: response.status
+            })));
+        }), Effect.mapError((cause) => cause instanceof ApiRequestError
+            ? cause
+            : new ApiRequestError({
+                message: `API request failed: ${cause.message}`
+            })));
+        const requestWithRefresh = (options) => Effect.gen(function* () {
+            const accessToken = (scope) => auth.accessToken(scope).pipe(Effect.catchTag("AuthRequiredError", (error) => 
+            // Only a missing session starts consent, and only when someone
+            // can answer it. A read-only session was chosen deliberately.
+            scope === API_READ_SCOPE ||
+                error.reason === "insufficient_scope" ||
+                !interaction.canPromptForLogin
+                ? Effect.fail(error)
+                : auth.login({
+                    write: true,
+                    noBrowser: false,
+                    onAuthorizationUrl: (url) => Console.error(`Authorize AllSquare CLI to make changes:\n${url}`),
+                    onBrowserOpenError: (cause) => Console.error(`Could not open your browser automatically: ${cause.message}`)
+                }).pipe(Effect.andThen(auth.accessToken(scope)))));
+            // Authorization happens before the request is sent, so an
+            // interactive login keeps the write's original idempotency key.
+            const token = yield* accessToken(options.scope);
+            const first = yield* Effect.result(execute(options.request, token, options.schema));
+            if (first._tag === "Success")
+                return first.success;
+            if (first.failure.status !== 401)
+                return yield* first.failure;
+            yield* auth.refresh;
+            const refreshedToken = yield* accessToken(options.scope);
+            return yield* execute(options.request, refreshedToken, options.schema);
+        });
+        const idempotencyKey = (supplied) => supplied === undefined
+            ? crypto.randomUUIDv4.pipe(Effect.mapError((cause) => new ApiRequestError({
+                message: `Could not generate an idempotency key: ${cause.message}`
+            })))
+            : Effect.succeed(supplied);
+        const bodyRequest = (options) => Effect.gen(function* () {
+            const apiUrl = yield* config.apiUrl;
+            const url = requestUrl(apiUrl, options.path, options.query);
+            const request = options.method === "POST"
+                ? HttpClientRequest.post(url)
+                : options.method === "PATCH"
+                    ? HttpClientRequest.patch(url)
+                    : HttpClientRequest.delete(url);
+            const encoded = yield* request.pipe(HttpClientRequest.schemaBodyJson(options.bodySchema)(options.body), Effect.mapError((cause) => new ApiRequestError({
+                message: `Could not encode API request body: ${cause.message}`
+            })));
+            const authenticatedRequest = options.scope === API_WRITE_SCOPE
+                ? encoded.pipe(HttpClientRequest.setHeader("idempotency-key", yield* idempotencyKey(options.idempotencyKey)))
+                : encoded;
+            return yield* requestWithRefresh({
+                request: authenticatedRequest,
+                scope: options.scope,
+                schema: options.schema
+            });
+        });
+        return ApiClient.of({
+            get: ({ path, query = {}, schema }) => Effect.gen(function* () {
+                const apiUrl = yield* config.apiUrl;
+                const url = requestUrl(apiUrl, path, query);
+                const response = yield* requestWithRefresh({
+                    request: HttpClientRequest.get(url),
+                    scope: API_READ_SCOPE,
+                    schema
+                });
+                return response.data;
+            }),
+            post: ({ path, query = {}, body, bodySchema, schema, scope, idempotencyKey }) => bodyRequest({
+                method: "POST",
+                path,
+                query,
+                body,
+                bodySchema,
+                schema,
+                scope,
+                ...(idempotencyKey === undefined ? {} : { idempotencyKey })
+            }),
+            patch: ({ path, query = {}, body, bodySchema, schema, idempotencyKey }) => bodyRequest({
+                method: "PATCH",
+                path,
+                query,
+                body,
+                bodySchema,
+                schema,
+                scope: API_WRITE_SCOPE,
+                ...(idempotencyKey === undefined ? {} : { idempotencyKey })
+            }),
+            delete: ({ path, query = {}, body, bodySchema, schema, idempotencyKey }) => bodyRequest({
+                method: "DELETE",
+                path,
+                query,
+                body,
+                bodySchema,
+                schema,
+                scope: API_WRITE_SCOPE,
+                ...(idempotencyKey === undefined ? {} : { idempotencyKey })
+            })
+        });
+    }));
+}
+//# sourceMappingURL=client.js.map

package/dist/api/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/api/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAChF,OAAO,EACL,UAAU,EACV,iBAAiB,EACjB,kBAAkB,EACnB,MAAM,sBAAsB,CAAA;AAE7B,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAErD,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;AAClE,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AACxC,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAC/C,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA;AAEvC,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC;IACjC,KAAK,EAAE,MAAM,CAAC,MAAM;IACpB,IAAI,EAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC;IACvC,MAAM,EAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IACvE,KAAK,EAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC;IACxC,iBAAiB,EAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC;CACrD,CAAC,CAAA;AAEF,MAAM,oBAAoB,GAAG,CAC3B,MAAc,EACd,IAAY,EACK,EAAE;IACnB,IAAI,OAA6C,CAAA;IACjD,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAA;QACzE,OAAO,GAAG,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,CAAA;IACzC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,GAAG,SAAS,CAAA;IACrB,CAAC;IAED,OAAO,IAAI,eAAe,CAAC;QACzB,OAAO,EAAE,OAAO,EAAE,KAAK,IAAI,kCAAkC,MAAM,EAAE;QACrE,MAAM;QACN,GAAG,CAAC,OAAO,EAAE,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC;QACjE,GAAG,CAAC,OAAO,EAAE,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC;QACpE,GAAG,CAAC,OAAO,EAAE,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC;QACjE,GAAG,CAAC,OAAO,EAAE,iBAAiB,KAAK,SAAS;YAC1C,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,EAAE,iBAAiB,EAAE,OAAO,CAAC,iBAAiB,EAAE,CAAC;KACtD,CAAC,CAAA;AACJ,CAAC,CAAA;AAED,MAAM,UAAU,GAAG,CACjB,MAAc,EACd,IAAY,EACZ,KAAmD,EAC3C,EAAE;IACV,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC,CAAA;IAChF,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACjD,IAAI,KAAK,KAAK,SAAS;YAAE,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;IAC3D,CAAC;IACD,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAA;AACvB,CAAC,CAAA;AAyCD,MAAM,OAAO,SAAU,SAAQ,OAAO,CAAC,OAAO,EAa1C,CAAC,0BAA0B,CAAC;IAC9B,MAAM,CAAU,KAAK,GAAG,KAAK,CAAC,MAAM,CAClC,SAAS,EACT,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;QAClB,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,SAAS,CAAA;QAC/B,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,WAAW,CAAA;QAC/B,MAAM,WAAW,GAAG,KAAK,CAAC,CAAC,WAAW,CAAA;QACtC,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,UAAU,CAAC,UAAU,CAAA;QAC3C,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,MAAM,CAAA;QAEnC,MAAM,OAAO,GAAG,CACd,OAA4C,EAC5C,KAAa,EACb,MAAyB,EACuB,EAAE,CAClD,MAAM,CAAC,OAAO,CACZ,OAAO,CAAC,IAAI,CACV,iBAAiB,CAAC,SAAS,CAAC,QAAQ,EAAE,kBAAkB,CAAC,EACzD,iBAAiB,CAAC,SAAS,CAAC,YAAY,EAAE,iBAAiB,OAAO,EAAE,CAAC,EACrE,iBAAiB,CAAC,WAAW,CAAC,KAAK,CAAC,CACrC,CACF,CAAC,IAAI,CACJ,MAAM,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;YAC1B,IAAI,QAAQ,CAAC,MAAM,GAAG,GAAG,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;gBACpD,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CACvB,MAAM,CAAC,aAAa,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,EAC9B,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CACtB,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAC5D,CAAA;YACH,CAAC;YAED,OAAO,kBAAkB,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,CAAC,IAAI,CAC7D,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;gBACpB,IAAI;gBACJ,QAAQ,EAAE,QAAQ,CAAC,OAAO,CAAC,qBAAqB,CAAC,KAAK,MAAM;aAC7D,CAAC,CAAC,EACH,MAAM,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,EAAE,CACxB,IAAI,eAAe,CAAC;gBAClB,OAAO,EAAE,qCAAqC,KAAK,CAAC,OAAO,EAAE;gBAC7D,MAAM,EAAE,QAAQ,CAAC,MAAM;aACxB,CAAC,CAAC,CACN,CAAA;QACH,CAAC,CAAC,EACF,MAAM,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,EAAE,CACxB,KAAK,YAAY,eAAe;YAC9B,CAAC,CAAC,KAAK;YACP,CAAC,CAAC,IAAI,eAAe,CAAC;gBAClB,OAAO,EAAE,uBAAuB,KAAK,CAAC,OAAO,EAAE;aAChD,CAAC,CAAC,CACV,CAAA;QAEH,MAAM,kBAAkB,GAAG,CAAI,OAI9B,EAAiD,EAAE,CAClD,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;YAClB,MAAM,WAAW,GAAG,CAAC,KAAqD,EAAE,EAAE,CAC5E,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,IAAI,CAC1B,MAAM,CAAC,QAAQ,CAAC,mBAAmB,EAAE,CAAC,KAAK,EAAE,EAAE;YAC7C,+DAA+D;YAC/D,8DAA8D;YAC9D,KAAK,KAAK,cAAc;gBACtB,KAAK,CAAC,MAAM,KAAK,oBAAoB;gBACrC,CAAC,WAAW,CAAC,iBAAiB;gBAC9B,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;gBACpB,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC;oBACT,KAAK,EAAE,IAAI;oBACX,SAAS,EAAE,KAAK;oBAChB,kBAAkB,EAAE,CAAC,GAAG,EAAE,EAAE,CAC1B,OAAO,CAAC,KAAK,CAAC,6CAA6C,GAAG,EAAE,CAAC;oBACnE,kBAAkB,EAAE,CAAC,KAAK,EAAE,EAAE,CAC5B,OAAO,CAAC,KAAK,CAAC,8CAA8C,KAAK,CAAC,OAAO,EAAE,CAAC;iBAC/E,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CACrD,CACF,CAAA;YAEH,0DAA0D;YAC1D,gEAAgE;YAChE,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;YAC/C,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,MAAM,CAChC,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,CAChD,CAAA;YACD,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS;gBAAE,OAAO,KAAK,CAAC,OAAO,CAAA;YAClD,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,KAAK,GAAG;gBAAE,OAAO,KAAK,CAAC,CAAC,KAAK,CAAC,OAAO,CAAA;YAE7D,KAAK,CAAC,CAAC,IAAI,CAAC,OAAO,CAAA;YACnB,MAAM,cAAc,GAAG,KAAK,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;YACxD,OAAO,KAAK,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,cAAc,EAAE,OAAO,CAAC,MAAM,CAAC,CAAA;QACxE,CAAC,CAAC,CAAA;QAEJ,MAAM,cAAc,GAAG,CACrB,QAA4B,EACY,EAAE,CAAC,QAAQ,KAAK,SAAS;YACjE,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,CACtB,MAAM,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,EAAE,CACxB,IAAI,eAAe,CAAC;gBAClB,OAAO,EAAE,0CAA0C,KAAK,CAAC,OAAO,EAAE;aACnE,CAAC,CAAC,CACN;YACH,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;QAE5B,MAAM,WAAW,GAAG,CAAO,OAS1B,EAAiD,EAAE,CAClD,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;YAClB,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,MAAM,CAAA;YACnC,MAAM,GAAG,GAAG,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,CAAA;YAC3D,MAAM,OAAO,GAAG,OAAO,CAAC,MAAM,KAAK,MAAM;gBACvC,CAAC,CAAC,iBAAiB,CAAC,IAAI,CAAC,GAAG,CAAC;gBAC7B,CAAC,CAAC,OAAO,CAAC,MAAM,KAAK,OAAO;oBAC1B,CAAC,CAAC,iBAAiB,CAAC,KAAK,CAAC,GAAG,CAAC;oBAC9B,CAAC,CAAC,iBAAiB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;YACnC,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,OAAO,CAAC,IAAI,CACjC,iBAAiB,CAAC,cAAc,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAClE,MAAM,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,EAAE,CACxB,IAAI,eAAe,CAAC;gBAClB,OAAO,EAAE,sCAAsC,KAAK,CAAC,OAAO,EAAE;aAC/D,CAAC,CAAC,CACN,CAAA;YACD,MAAM,oBAAoB,GAAG,OAAO,CAAC,KAAK,KAAK,eAAe;gBAC5D,CAAC,CAAC,OAAO,CAAC,IAAI,CACV,iBAAiB,CAAC,SAAS,CACzB,iBAAiB,EACjB,KAAK,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,cAAc,CAAC,CAC9C,CACF;gBACH,CAAC,CAAC,OAAO,CAAA;YAEX,OAAO,KAAK,CAAC,CAAC,kBAAkB,CAAC;gBAC/B,OAAO,EAAE,oBAAoB;gBAC7B,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,MAAM,EAAE,OAAO,CAAC,MAAM;aACvB,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QAEJ,OAAO,SAAS,CAAC,EAAE,CAAC;YAClB,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,GAAG,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,CACpC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;gBAClB,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,MAAM,CAAA;gBACnC,MAAM,GAAG,GAAG,UAAU,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,CAAA;gBAC3C,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,kBAAkB,CAAC;oBACzC,OAAO,EAAE,iBAAiB,CAAC,GAAG,CAAC,GAAG,CAAC;oBACnC,KAAK,EAAE,cAAc;oBACrB,MAAM;iBACP,CAAC,CAAA;gBACF,OAAO,QAAQ,CAAC,IAAI,CAAA;YACtB,CAAC,CAAC;YACJ,IAAI,EAAE,CAAC,EACL,IAAI,EACJ,KAAK,GAAG,EAAE,EACV,IAAI,EACJ,UAAU,EACV,MAAM,EACN,KAAK,EACL,cAAc,EACf,EAAE,EAAE,CAAC,WAAW,CAAC;gBAChB,MAAM,EAAE,MAAM;gBACd,IAAI;gBACJ,KAAK;gBACL,IAAI;gBACJ,UAAU;gBACV,MAAM;gBACN,KAAK;gBACL,GAAG,CAAC,cAAc,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,CAAC;aAC5D,CAAC;YACF,KAAK,EAAE,CAAC,EACN,IAAI,EACJ,KAAK,GAAG,EAAE,EACV,IAAI,EACJ,UAAU,EACV,MAAM,EACN,cAAc,EACf,EAAE,EAAE,CAAC,WAAW,CAAC;gBAChB,MAAM,EAAE,OAAO;gBACf,IAAI;gBACJ,KAAK;gBACL,IAAI;gBACJ,UAAU;gBACV,MAAM;gBACN,KAAK,EAAE,eAAe;gBACtB,GAAG,CAAC,cAAc,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,CAAC;aAC5D,CAAC;YACF,MAAM,EAAE,CAAC,EACP,IAAI,EACJ,KAAK,GAAG,EAAE,EACV,IAAI,EACJ,UAAU,EACV,MAAM,EACN,cAAc,EACf,EAAE,EAAE,CAAC,WAAW,CAAC;gBAChB,MAAM,EAAE,QAAQ;gBAChB,IAAI;gBACJ,KAAK;gBACL,IAAI;gBACJ,UAAU;gBACV,MAAM;gBACN,KAAK,EAAE,eAAe;gBACtB,GAAG,CAAC,cAAc,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,CAAC;aAC5D,CAAC;SACH,CAAC,CAAA;IACJ,CAAC,CAAC,CACH,CAAA"}