@crowdedkingdoms/crowdyjs 1.0.0

package/dist/domains/billing.d.ts

@@ -0,0 +1,97 @@
+import type { GraphQLClient } from '../client.js';
+import { type WalletBalanceQuery, type WalletTransactionsQuery, type WalletTransactionsConnectionQuery, type WalletTransactionsConnectionQueryVariables, type AppBudgetQuery, type AppBudgetsQuery, type SetAppBudgetMutation, type BuddyBillingTiersQuery, type GraphqlBillingTiersQuery, type PostgresBillingTiersQuery } from '../generated/graphql.js';
+/**
+ * Org wallet + per-app budgets — exposed as `client.billing` (and grouped under
+ * `client.admin`).
+ *
+ * Targets the **management-api**. Reads require the `view_billing` org/app
+ * permission; {@link setAppBudget} requires `manage_billing`. Monetary values
+ * are minor currency units (`*Cents`) and serialized as `BigInt` decimal
+ * strings.
+ *
+ * @throws {CrowdyGraphQLError} `UNAUTHENTICATED` / `FORBIDDEN` / `SCOPE_MISSING`
+ *   per the permission notes above.
+ */
+export declare class BillingAPI {
+    private readonly management;
+    constructor(management: GraphQLClient);
+    /**
+     * Return an organization's wallet balance. Requires the `view_billing` org
+     * permission.
+     *
+     * @param orgId - Numeric org id (`BigInt` as a decimal string).
+     * @returns The wallet balance (cents as a decimal string).
+     */
+    walletBalance(orgId: string): Promise<WalletBalanceQuery['walletBalance']>;
+    /**
+     * List an organization's wallet transactions (newest first). Requires the
+     * `view_billing` org permission.
+     *
+     * @param orgId - Numeric org id.
+     * @param opts - Optional `limit` / `offset` (default limit 50).
+     * @returns The wallet transactions.
+     */
+    walletTransactions(orgId: string, opts?: {
+        limit?: number;
+        offset?: number;
+    }): Promise<WalletTransactionsQuery['walletTransactions']>;
+    /**
+     * Return the spend budget for one app. Requires the `view_billing` app
+     * permission.
+     *
+     * @param orgId - Numeric org id that owns the app.
+     * @param appId - Numeric app id.
+     * @returns The app budget, or `null` if unset.
+     */
+    appBudget(orgId: string, appId: string): Promise<AppBudgetQuery['appBudget']>;
+    /**
+     * List the spend budgets for every app under an org. Requires the
+     * `view_billing` org permission.
+     *
+     * @param orgId - Numeric org id.
+     * @returns The app budgets.
+     */
+    appBudgets(orgId: string): Promise<AppBudgetsQuery['appBudgets']>;
+    /**
+     * Set (or clear) an app's monthly spend cap. Requires the `manage_billing`
+     * app permission.
+     *
+     * @param orgId - Numeric org id.
+     * @param appId - Numeric app id.
+     * @param monthlyLimitCents - Monthly cap in minor currency units (decimal
+     *   string); `"0"` disables the cap.
+     * @returns The updated app budget.
+     */
+    setAppBudget(orgId: string, appId: string, monthlyLimitCents: string): Promise<SetAppBudgetMutation['setAppBudget']>;
+    /**
+     * Relay-style cursor pagination over an org's wallet transactions — the
+     * preferred alternative to {@link walletTransactions}. Requires the
+     * `view_billing` org permission. See
+     * https://docs.crowdedkingdoms.com/overview/pagination.
+     *
+     * @param args - `orgId` plus optional `first` and `after`.
+     * @returns A wallet-transactions connection.
+     */
+    walletTransactionsConnection(args: WalletTransactionsConnectionQueryVariables): Promise<WalletTransactionsConnectionQuery['walletTransactionsConnection']>;
+    /**
+     * Buddy (UDP replication) capacity billing-tier catalog. **Public.** Each
+     * tier lists its messages/sec + bandwidth allotment and capacity charge; use
+     * with {@link EnvironmentsAPI.updateBillingTiers} to set an environment's tier.
+     *
+     * @returns The Buddy billing tiers.
+     */
+    buddyTiers(): Promise<BuddyBillingTiersQuery['buddyBillingTiers']>;
+    /**
+     * GraphQL (Game API) capacity billing-tier catalog. **Public.**
+     *
+     * @returns The GraphQL billing tiers.
+     */
+    graphqlTiers(): Promise<GraphqlBillingTiersQuery['graphqlBillingTiers']>;
+    /**
+     * Postgres capacity billing-tier catalog. **Public.**
+     *
+     * @returns The Postgres billing tiers.
+     */
+    postgresTiers(): Promise<PostgresBillingTiersQuery['postgresBillingTiers']>;
+}
+//# sourceMappingURL=billing.d.ts.map

package/dist/domains/billing.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"billing.d.ts","sourceRoot":"","sources":["../../src/domains/billing.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAClD,OAAO,EAUL,KAAK,kBAAkB,EACvB,KAAK,uBAAuB,EAC5B,KAAK,iCAAiC,EACtC,KAAK,0CAA0C,EAC/C,KAAK,cAAc,EACnB,KAAK,eAAe,EACpB,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,yBAAyB,EAC/B,MAAM,yBAAyB,CAAC;AAEjC;;;;;;;;;;;GAWG;AACH,qBAAa,UAAU;IACT,OAAO,CAAC,QAAQ,CAAC,UAAU;gBAAV,UAAU,EAAE,aAAa;IAEtD;;;;;;OAMG;IACG,aAAa,CACjB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC;IAK/C;;;;;;;OAOG;IACG,kBAAkB,CACtB,KAAK,EAAE,MAAM,EACb,IAAI,GAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAO,GAC7C,OAAO,CAAC,uBAAuB,CAAC,oBAAoB,CAAC,CAAC;IASzD;;;;;;;OAOG;IACG,SAAS,CACb,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;IAQvC;;;;;;OAMG;IACG,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;IAKvE;;;;;;;;;OASG;IACG,YAAY,CAChB,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,EACb,iBAAiB,EAAE,MAAM,GACxB,OAAO,CAAC,oBAAoB,CAAC,cAAc,CAAC,CAAC;IAShD;;;;;;;;OAQG;IACG,4BAA4B,CAChC,IAAI,EAAE,0CAA0C,GAC/C,OAAO,CACR,iCAAiC,CAAC,8BAA8B,CAAC,CAClE;IAQD;;;;;;OAMG;IACG,UAAU,IAAI,OAAO,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,CAAC;IAKxE;;;;OAIG;IACG,YAAY,IAAI,OAAO,CAC3B,wBAAwB,CAAC,qBAAqB,CAAC,CAChD;IAKD;;;;OAIG;IACG,aAAa,IAAI,OAAO,CAC5B,yBAAyB,CAAC,sBAAsB,CAAC,CAClD;CAIF"}

package/dist/domains/billing.js

@@ -0,0 +1,131 @@
+import { WalletBalanceDocument, WalletTransactionsDocument, WalletTransactionsConnectionDocument, AppBudgetDocument, AppBudgetsDocument, SetAppBudgetDocument, BuddyBillingTiersDocument, GraphqlBillingTiersDocument, PostgresBillingTiersDocument, } from '../generated/graphql.js';
+/**
+ * Org wallet + per-app budgets — exposed as `client.billing` (and grouped under
+ * `client.admin`).
+ *
+ * Targets the **management-api**. Reads require the `view_billing` org/app
+ * permission; {@link setAppBudget} requires `manage_billing`. Monetary values
+ * are minor currency units (`*Cents`) and serialized as `BigInt` decimal
+ * strings.
+ *
+ * @throws {CrowdyGraphQLError} `UNAUTHENTICATED` / `FORBIDDEN` / `SCOPE_MISSING`
+ *   per the permission notes above.
+ */
+export class BillingAPI {
+    constructor(management) {
+        this.management = management;
+    }
+    /**
+     * Return an organization's wallet balance. Requires the `view_billing` org
+     * permission.
+     *
+     * @param orgId - Numeric org id (`BigInt` as a decimal string).
+     * @returns The wallet balance (cents as a decimal string).
+     */
+    async walletBalance(orgId) {
+        const data = await this.management.request(WalletBalanceDocument, { orgId });
+        return data.walletBalance;
+    }
+    /**
+     * List an organization's wallet transactions (newest first). Requires the
+     * `view_billing` org permission.
+     *
+     * @param orgId - Numeric org id.
+     * @param opts - Optional `limit` / `offset` (default limit 50).
+     * @returns The wallet transactions.
+     */
+    async walletTransactions(orgId, opts = {}) {
+        const data = await this.management.request(WalletTransactionsDocument, {
+            orgId,
+            limit: opts.limit,
+            offset: opts.offset,
+        });
+        return data.walletTransactions;
+    }
+    /**
+     * Return the spend budget for one app. Requires the `view_billing` app
+     * permission.
+     *
+     * @param orgId - Numeric org id that owns the app.
+     * @param appId - Numeric app id.
+     * @returns The app budget, or `null` if unset.
+     */
+    async appBudget(orgId, appId) {
+        const data = await this.management.request(AppBudgetDocument, {
+            orgId,
+            appId,
+        });
+        return data.appBudget;
+    }
+    /**
+     * List the spend budgets for every app under an org. Requires the
+     * `view_billing` org permission.
+     *
+     * @param orgId - Numeric org id.
+     * @returns The app budgets.
+     */
+    async appBudgets(orgId) {
+        const data = await this.management.request(AppBudgetsDocument, { orgId });
+        return data.appBudgets;
+    }
+    /**
+     * Set (or clear) an app's monthly spend cap. Requires the `manage_billing`
+     * app permission.
+     *
+     * @param orgId - Numeric org id.
+     * @param appId - Numeric app id.
+     * @param monthlyLimitCents - Monthly cap in minor currency units (decimal
+     *   string); `"0"` disables the cap.
+     * @returns The updated app budget.
+     */
+    async setAppBudget(orgId, appId, monthlyLimitCents) {
+        const data = await this.management.request(SetAppBudgetDocument, {
+            orgId,
+            appId,
+            monthlyLimitCents,
+        });
+        return data.setAppBudget;
+    }
+    /**
+     * Relay-style cursor pagination over an org's wallet transactions — the
+     * preferred alternative to {@link walletTransactions}. Requires the
+     * `view_billing` org permission. See
+     * https://docs.crowdedkingdoms.com/overview/pagination.
+     *
+     * @param args - `orgId` plus optional `first` and `after`.
+     * @returns A wallet-transactions connection.
+     */
+    async walletTransactionsConnection(args) {
+        const data = await this.management.request(WalletTransactionsConnectionDocument, args);
+        return data.walletTransactionsConnection;
+    }
+    /**
+     * Buddy (UDP replication) capacity billing-tier catalog. **Public.** Each
+     * tier lists its messages/sec + bandwidth allotment and capacity charge; use
+     * with {@link EnvironmentsAPI.updateBillingTiers} to set an environment's tier.
+     *
+     * @returns The Buddy billing tiers.
+     */
+    async buddyTiers() {
+        const data = await this.management.request(BuddyBillingTiersDocument);
+        return data.buddyBillingTiers;
+    }
+    /**
+     * GraphQL (Game API) capacity billing-tier catalog. **Public.**
+     *
+     * @returns The GraphQL billing tiers.
+     */
+    async graphqlTiers() {
+        const data = await this.management.request(GraphqlBillingTiersDocument);
+        return data.graphqlBillingTiers;
+    }
+    /**
+     * Postgres capacity billing-tier catalog. **Public.**
+     *
+     * @returns The Postgres billing tiers.
+     */
+    async postgresTiers() {
+        const data = await this.management.request(PostgresBillingTiersDocument);
+        return data.postgresBillingTiers;
+    }
+}

package/dist/domains/channels.d.ts

@@ -0,0 +1,293 @@
+import type { GraphQLClient } from '../client.js';
+import { type MyChannelsQuery, type MyChannelsQueryVariables, type ChannelsQuery, type ChannelsQueryVariables, type ChannelQuery, type ChannelQueryVariables, type ChannelMembersQuery, type ChannelMembersQueryVariables, type ChannelRolesQuery, type ChannelRolesQueryVariables, type ChannelPolicyQuery, type ChannelPolicyQueryVariables, type SetChannelPolicyMutation, type SetChannelPolicyMutationVariables, type CreateChannelMutation, type CreateChannelMutationVariables, type UpdateChannelMutation, type UpdateChannelMutationVariables, type DeleteChannelMutationVariables, type JoinChannelMutation, type JoinChannelMutationVariables, type RequestToJoinChannelMutation, type RequestToJoinChannelMutationVariables, type LeaveChannelMutationVariables, type AddChannelMemberMutation, type AddChannelMemberMutationVariables, type RemoveChannelMemberMutationVariables, type SetChannelMemberRolesMutation, type SetChannelMemberRolesMutationVariables, type CreateChannelRoleMutation, type CreateChannelRoleMutationVariables, type UpdateChannelRoleMutation, type UpdateChannelRoleMutationVariables, type DeleteChannelRoleMutationVariables } from '../generated/graphql.js';
+/**
+ * Channels: app-scoped, location-independent pub/sub messaging groups on the
+ * **game-api**. Exposed as `client.channels`.
+ *
+ * A channel is a named subscriber set with role-gated messaging, built on the
+ * same generic groups subsystem as Teams (`group_type='channel'`). The methods
+ * here manage a channel's lifecycle and configuration — creating channels,
+ * listing/fetching them, managing membership (join/leave/add/remove), roles,
+ * and the per-app channel policy — all over the game-api GraphQL endpoint.
+ *
+ * Realtime message delivery is a **separate** path: publish to a channel with
+ * `client.udp.sendChannelMessage(...)` over UDP. That call requires the
+ * channel's `send_messages` permission and fans the payload out to every
+ * active member (as a `ChannelMessageNotification` on `client.udp`
+ * notifications) rather than chunk-routing it. The methods on this class never
+ * carry message payloads — they only manage who belongs to a channel and what
+ * each member may do.
+ *
+ * `BigInt` ids (`appId`, `groupId`, `userId`, `groupRoleId`) are sent and
+ * received as decimal strings.
+ *
+ * Every method requires an authenticated session (a Bearer token set via
+ * `client.auth.login()` or `client.setToken()`) and the caller must be
+ * entitled to the target app; membership/role/policy mutations additionally
+ * require a specific channel permission (e.g. `manage_group`, `manage_members`,
+ * `manage_roles`) or app-admin (`manage_apps`). Failures throw
+ * {@link CrowdyGraphQLError} carrying a stable `extensions.code` such as
+ * `UNAUTHENTICATED`, `SCOPE_MISSING`, or `FORBIDDEN`.
+ */
+export declare class ChannelsAPI {
+    private gql;
+    constructor(gql: GraphQLClient);
+    /**
+     * List the caller's own channels in an app, each with the caller's roles and
+     * effective channel permissions (e.g. whether they hold `send_messages`). Use
+     * this to discover which channels the current user can read and post in.
+     *
+     * @param appId - The app (tenant) to list the caller's channels within, as a
+     *   decimal `BigInt` string.
+     * @returns One {@link GroupMembership} per channel the caller belongs to
+     *   (the channel {@link Group}, the caller's {@link GroupRole}s, their
+     *   effective permission keys, and the join time).
+     * @throws {CrowdyGraphQLError} `UNAUTHENTICATED` if there is no valid token,
+     *   or `SCOPE_MISSING` / `FORBIDDEN` if the caller isn't entitled to the app.
+     */
+    mine(appId: MyChannelsQueryVariables['appId']): Promise<MyChannelsQuery['myChannels']>;
+    /**
+     * List all active channels in an app — not just the caller's. Use
+     * {@link mine} instead when you only want the channels the caller belongs to.
+     *
+     * @param appId - The app (tenant) whose channels to list, as a decimal
+     *   `BigInt` string.
+     * @returns Every active channel in the app as {@link Group} records.
+     * @throws {CrowdyGraphQLError} `UNAUTHENTICATED`, or `SCOPE_MISSING` /
+     *   `FORBIDDEN` if the caller isn't entitled to the app.
+     */
+    list(appId: ChannelsQueryVariables['appId']): Promise<ChannelsQuery['channels']>;
+    /**
+     * Fetch a single channel by its group id.
+     *
+     * @param groupId - The channel's group id, as a decimal `BigInt` string.
+     * @returns The channel as a {@link Group}.
+     * @throws {CrowdyGraphQLError} if the id does not resolve to a channel (e.g.
+     *   it is a team, or does not exist), or `UNAUTHENTICATED` / `FORBIDDEN` if
+     *   the caller isn't entitled to the app.
+     */
+    get(groupId: ChannelQueryVariables['groupId']): Promise<ChannelQuery['channel']>;
+    /**
+     * List a channel's members — its subscriber set, including pending join
+     * requests — each with their membership status and roles.
+     *
+     * @param groupId - The channel whose members to list, as a decimal `BigInt`
+     *   string.
+     * @returns The channel's members as {@link GroupMember} records.
+     * @throws {CrowdyGraphQLError} `UNAUTHENTICATED` / `FORBIDDEN` if the caller
+     *   isn't entitled to the channel's app.
+     */
+    members(groupId: ChannelMembersQueryVariables['groupId']): Promise<ChannelMembersQuery['channelMembers']>;
+    /**
+     * List a channel's roles, including the system `leader` role and any default
+     * `member` role (which typically grants `send_messages`).
+     *
+     * @param groupId - The channel whose roles to list, as a decimal `BigInt`
+     *   string.
+     * @returns The channel's roles as {@link GroupRole} records, each with its
+     *   granted permission keys.
+     * @throws {CrowdyGraphQLError} `UNAUTHENTICATED` / `FORBIDDEN` if the caller
+     *   isn't entitled to the channel's app.
+     */
+    roles(groupId: ChannelRolesQueryVariables['groupId']): Promise<ChannelRolesQuery['channelRoles']>;
+    /**
+     * Read an app's current channel policy: who may create channels and the
+     * default membership policy applied to new channels. Falls back to app
+     * defaults when unset.
+     *
+     * @param appId - The app (tenant) whose channel policy to read, as a decimal
+     *   `BigInt` string.
+     * @returns The effective {@link AppGroupPolicy} for channels in the app
+     *   (creation policy, default membership policy, and any member/group caps).
+     * @throws {CrowdyGraphQLError} `UNAUTHENTICATED` / `FORBIDDEN` if the caller
+     *   isn't entitled to the app.
+     */
+    policy(appId: ChannelPolicyQueryVariables['appId']): Promise<ChannelPolicyQuery['channelPolicy']>;
+    /**
+     * Create a channel in an app. Whether the caller may create one is governed
+     * by the per-app channel creation policy (`admin` | `member` | `anyone`).
+     * The caller becomes the owner with a system `leader` role. When
+     * `input.membersCanSend` is true (the default) a default `member` role
+     * granting `send_messages` is created and auto-assigned to joiners (an open
+     * chat channel); when false, only roles you explicitly grant may post (an
+     * announce / read-only channel).
+     *
+     * @param input - {@link CreateChannelInput}: the owning `appId`, the channel
+     *   `name` (max 128 chars, unique per app + type), and optional
+     *   `description`, `membershipPolicy` (`open` | `request` | `invite` |
+     *   `admin`; defaults to the app policy), and `membersCanSend` flag.
+     * @returns The newly created channel as a {@link Group}.
+     * @throws {CrowdyGraphQLError} `BAD_USER_INPUT` (e.g. name too long or a
+     *   duplicate name), `FORBIDDEN` if the channel policy disallows creation, or
+     *   `UNAUTHENTICATED`.
+     */
+    create(input: CreateChannelMutationVariables['input']): Promise<CreateChannelMutation['createChannel']>;
+    /**
+     * Update a channel's name, description, and/or membership policy. Only the
+     * fields present on `input` change; omitted fields are left as-is. Requires
+     * the `manage_group` channel permission (app admins bypass).
+     *
+     * @param input - {@link UpdateChannelInput}: the `groupId` plus the fields to
+     *   change — `name` (max 128 chars), `description`, and/or `membershipPolicy`
+     *   (`open` | `request` | `invite` | `admin`).
+     * @returns The updated channel as a {@link Group}.
+     * @throws {CrowdyGraphQLError} `FORBIDDEN` / `SCOPE_MISSING` if the caller
+     *   lacks `manage_group`, `BAD_USER_INPUT` on a validation failure, or
+     *   `UNAUTHENTICATED`.
+     */
+    update(input: UpdateChannelMutationVariables['input']): Promise<UpdateChannelMutation['updateChannel']>;
+    /**
+     * Delete a channel. Requires the `manage_group` channel permission (app
+     * admins bypass). **Destructive**: cascades to the channel's members and
+     * roles and notifies Buddy servers to tear down message routing for the
+     * channel.
+     *
+     * @param groupId - The channel to delete, as a decimal `BigInt` string.
+     * @returns `true` on success.
+     * @throws {CrowdyGraphQLError} `FORBIDDEN` / `SCOPE_MISSING` if the caller
+     *   lacks `manage_group`, or `UNAUTHENTICATED`.
+     */
+    remove(groupId: DeleteChannelMutationVariables['groupId']): Promise<boolean>;
+    /**
+     * Set who may create channels in an app and the default membership policy
+     * for new channels. Requires app-admin (`manage_apps`). Affects future
+     * channel creation only — existing channels are unchanged.
+     *
+     * @param input - {@link SetChannelPolicyInput}: the `appId`, the
+     *   `creationPolicy` (`admin` | `member` | `anyone`), the
+     *   `defaultMembershipPolicy` (`open` | `request` | `invite` | `admin`), and
+     *   optional `maxMembers` / `maxGroupsPerUser` caps (`null` = unlimited).
+     * @returns The updated {@link AppGroupPolicy}.
+     * @throws {CrowdyGraphQLError} `FORBIDDEN` / `SCOPE_MISSING` if the caller
+     *   isn't app-admin, `BAD_USER_INPUT` on an invalid policy value, or
+     *   `UNAUTHENTICATED`.
+     */
+    setPolicy(input: SetChannelPolicyMutationVariables['input']): Promise<SetChannelPolicyMutation['setChannelPolicy']>;
+    /**
+     * Join a channel as the caller (subscribe to it). Honors the channel's
+     * membership policy: `open` → active immediately; `request` → pending until
+     * a manager approves; `invite` / `admin` → rejected. On becoming active,
+     * Buddy is notified with the caller's effective send permission so message
+     * routing starts.
+     *
+     * @param groupId - The channel to join, as a decimal `BigInt` string.
+     * @returns The caller's {@link GroupMember} record; its `status` reflects
+     *   `active` vs. `pending`.
+     * @throws {CrowdyGraphQLError} `FORBIDDEN` if the membership policy rejects
+     *   the join, or `UNAUTHENTICATED`.
+     */
+    join(groupId: JoinChannelMutationVariables['groupId']): Promise<JoinChannelMutation['joinChannel']>;
+    /**
+     * Request to join a request-only channel, creating a pending membership a
+     * manager can later approve via {@link addMember}. Behaves identically to
+     * {@link join}; it exists as a clearer name for request-policy UIs.
+     *
+     * @param groupId - The request-only channel to request to join, as a decimal
+     *   `BigInt` string.
+     * @returns The caller's pending {@link GroupMember} record.
+     * @throws {CrowdyGraphQLError} `FORBIDDEN` if the membership policy rejects
+     *   the request, or `UNAUTHENTICATED`.
+     */
+    requestToJoin(groupId: RequestToJoinChannelMutationVariables['groupId']): Promise<RequestToJoinChannelMutation['requestToJoinChannel']>;
+    /**
+     * Leave a channel (unsubscribe the caller). Notifies Buddy to stop routing
+     * messages to the caller.
+     *
+     * @param groupId - The channel to leave, as a decimal `BigInt` string.
+     * @returns `true` if a membership was removed (`false` if the caller wasn't
+     *   a member).
+     * @throws {CrowdyGraphQLError} `UNAUTHENTICATED`.
+     */
+    leave(groupId: LeaveChannelMutationVariables['groupId']): Promise<boolean>;
+    /**
+     * Add a user to a channel, or approve their pending join request (upserts
+     * the membership to `active`). Requires the `manage_members` channel
+     * permission (app admins bypass). Auto-assigns the channel's default role if
+     * configured and notifies Buddy with the member's effective send permission.
+     *
+     * @param groupId - The channel to add the user to, as a decimal `BigInt`
+     *   string.
+     * @param userId - The user to add or approve, as a decimal `BigInt` string.
+     * @returns The added/approved {@link GroupMember} record.
+     * @throws {CrowdyGraphQLError} `FORBIDDEN` / `SCOPE_MISSING` if the caller
+     *   lacks `manage_members`, or `UNAUTHENTICATED`.
+     */
+    addMember(groupId: AddChannelMemberMutationVariables['groupId'], userId: AddChannelMemberMutationVariables['userId']): Promise<AddChannelMemberMutation['addChannelMember']>;
+    /**
+     * Remove a member from a channel. Requires the `manage_members` channel
+     * permission, except that any member may remove themselves (pass their own
+     * `userId`). Notifies Buddy to stop routing messages to the removed member.
+     *
+     * @param groupId - The channel to remove the user from, as a decimal
+     *   `BigInt` string.
+     * @param userId - The user to remove; may be the caller's own id to
+     *   self-remove. Decimal `BigInt` string.
+     * @returns `true` if a membership was removed.
+     * @throws {CrowdyGraphQLError} `FORBIDDEN` / `SCOPE_MISSING` when removing
+     *   another member without `manage_members`, or `UNAUTHENTICATED`.
+     */
+    removeMember(groupId: RemoveChannelMemberMutationVariables['groupId'], userId: RemoveChannelMemberMutationVariables['userId']): Promise<boolean>;
+    /**
+     * Replace a member's channel roles with the given set. This is **not
+     * additive** — roles not listed are removed. Requires the `manage_roles`
+     * channel permission (app admins bypass). Re-pushes the member's effective
+     * send permission to Buddy so their ability to post updates immediately.
+     *
+     * @param input - {@link SetMemberRolesInput}: the `groupId`, the target
+     *   `userId`, and `roleIds` — the complete set of channel role ids the member
+     *   should have (ids that are unknown or belong to another group are
+     *   ignored).
+     * @returns The updated {@link GroupMember} record with its new roles.
+     * @throws {CrowdyGraphQLError} `FORBIDDEN` / `SCOPE_MISSING` if the caller
+     *   lacks `manage_roles`, or `UNAUTHENTICATED`.
+     */
+    setMemberRoles(input: SetChannelMemberRolesMutationVariables['input']): Promise<SetChannelMemberRolesMutation['setChannelMemberRoles']>;
+    /**
+     * Create a custom (non-system) channel role granting the given channel
+     * permission keys (e.g. `send_messages` for posting rights). Requires the
+     * `manage_roles` channel permission (app admins bypass).
+     *
+     * @param input - {@link CreateGroupRoleInput}: the `groupId`, the `roleName`
+     *   (max 128 chars, unique within the channel), the `permissions` keys to
+     *   grant (e.g. `send_messages`, `manage_members`; each max 64 chars,
+     *   defaults to none), and an optional `rank` (higher = more senior;
+     *   defaults to 0).
+     * @returns The created {@link GroupRole}.
+     * @throws {CrowdyGraphQLError} `BAD_USER_INPUT` on an invalid/duplicate name
+     *   or unknown permission key, `FORBIDDEN` / `SCOPE_MISSING` if the caller
+     *   lacks `manage_roles`, or `UNAUTHENTICATED`.
+     */
+    createRole(input: CreateChannelRoleMutationVariables['input']): Promise<CreateChannelRoleMutation['createChannelRole']>;
+    /**
+     * Update a channel role's name, rank, and/or permission keys (system roles
+     * cannot be renamed or re-ranked). When `input.permissions` is supplied it
+     * **replaces** the role's existing keys. Requires the `manage_roles` channel
+     * permission (app admins bypass).
+     *
+     * Note: changing `send_messages` here does not re-push to Buddy until each
+     * affected member's roles are re-applied via {@link setMemberRoles}.
+     *
+     * @param input - {@link UpdateGroupRoleInput}: the `groupRoleId` plus the
+     *   fields to change (`roleName`, `permissions`, `rank`); omitted fields are
+     *   left unchanged.
+     * @returns The updated {@link GroupRole}.
+     * @throws {CrowdyGraphQLError} `BAD_USER_INPUT` on a validation failure,
+     *   `FORBIDDEN` / `SCOPE_MISSING` if the caller lacks `manage_roles`, or
+     *   `UNAUTHENTICATED`.
+     */
+    updateRole(input: UpdateChannelRoleMutationVariables['input']): Promise<UpdateChannelRoleMutation['updateChannelRole']>;
+    /**
+     * Delete a non-system channel role. Requires the `manage_roles` channel
+     * permission (app admins bypass). The system `leader` role cannot be
+     * deleted. **Destructive**: removes the role from any members that held it.
+     *
+     * @param groupRoleId - The channel role to delete (must be a non-system
+     *   role), as a decimal `BigInt` string.
+     * @returns `true` if a role was deleted.
+     * @throws {CrowdyGraphQLError} `FORBIDDEN` / `SCOPE_MISSING` if the caller
+     *   lacks `manage_roles`, `BAD_USER_INPUT` if targeting a system role, or
+     *   `UNAUTHENTICATED`.
+     */
+    deleteRole(groupRoleId: DeleteChannelRoleMutationVariables['groupRoleId']): Promise<boolean>;
+}
+//# sourceMappingURL=channels.d.ts.map

package/dist/domains/channels.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"channels.d.ts","sourceRoot":"","sources":["../../src/domains/channels.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAElD,OAAO,EAEL,KAAK,eAAe,EACpB,KAAK,wBAAwB,EAE7B,KAAK,aAAa,EAClB,KAAK,sBAAsB,EAE3B,KAAK,YAAY,EACjB,KAAK,qBAAqB,EAE1B,KAAK,mBAAmB,EACxB,KAAK,4BAA4B,EAEjC,KAAK,iBAAiB,EACtB,KAAK,0BAA0B,EAE/B,KAAK,kBAAkB,EACvB,KAAK,2BAA2B,EAEhC,KAAK,wBAAwB,EAC7B,KAAK,iCAAiC,EAEtC,KAAK,qBAAqB,EAC1B,KAAK,8BAA8B,EAEnC,KAAK,qBAAqB,EAC1B,KAAK,8BAA8B,EAEnC,KAAK,8BAA8B,EAEnC,KAAK,mBAAmB,EACxB,KAAK,4BAA4B,EAEjC,KAAK,4BAA4B,EACjC,KAAK,qCAAqC,EAE1C,KAAK,6BAA6B,EAElC,KAAK,wBAAwB,EAC7B,KAAK,iCAAiC,EAEtC,KAAK,oCAAoC,EAEzC,KAAK,6BAA6B,EAClC,KAAK,sCAAsC,EAE3C,KAAK,yBAAyB,EAC9B,KAAK,kCAAkC,EAEvC,KAAK,yBAAyB,EAC9B,KAAK,kCAAkC,EAEvC,KAAK,kCAAkC,EACxC,MAAM,yBAAyB,CAAC;AAEjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,qBAAa,WAAW;IACV,OAAO,CAAC,GAAG;gBAAH,GAAG,EAAE,aAAa;IAItC;;;;;;;;;;;;OAYG;IACG,IAAI,CACR,KAAK,EAAE,wBAAwB,CAAC,OAAO,CAAC,GACvC,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;IAKzC;;;;;;;;;OASG;IACG,IAAI,CACR,KAAK,EAAE,sBAAsB,CAAC,OAAO,CAAC,GACrC,OAAO,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;IAKrC;;;;;;;;OAQG;IACG,GAAG,CACP,OAAO,EAAE,qBAAqB,CAAC,SAAS,CAAC,GACxC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;IAKnC;;;;;;;;;OASG;IACG,OAAO,CACX,OAAO,EAAE,4BAA4B,CAAC,SAAS,CAAC,GAC/C,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;IAKjD;;;;;;;;;;OAUG;IACG,KAAK,CACT,OAAO,EAAE,0BAA0B,CAAC,SAAS,CAAC,GAC7C,OAAO,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC;IAK7C;;;;;;;;;;;OAWG;IACG,MAAM,CACV,KAAK,EAAE,2BAA2B,CAAC,OAAO,CAAC,GAC1C,OAAO,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC;IAO/C;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CACV,KAAK,EAAE,8BAA8B,CAAC,OAAO,CAAC,GAC7C,OAAO,CAAC,qBAAqB,CAAC,eAAe,CAAC,CAAC;IAKlD;;;;;;;;;;;;OAYG;IACG,MAAM,CACV,KAAK,EAAE,8BAA8B,CAAC,OAAO,CAAC,GAC7C,OAAO,CAAC,qBAAqB,CAAC,eAAe,CAAC,CAAC;IAKlD;;;;;;;;;;OAUG;IACG,MAAM,CACV,OAAO,EAAE,8BAA8B,CAAC,SAAS,CAAC,GACjD,OAAO,CAAC,OAAO,CAAC;IAKnB;;;;;;;;;;;;;OAaG;IACG,SAAS,CACb,KAAK,EAAE,iCAAiC,CAAC,OAAO,CAAC,GAChD,OAAO,CAAC,wBAAwB,CAAC,kBAAkB,CAAC,CAAC;IAOxD;;;;;;;;;;;;OAYG;IACG,IAAI,CACR,OAAO,EAAE,4BAA4B,CAAC,SAAS,CAAC,GAC/C,OAAO,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC;IAK9C;;;;;;;;;;OAUG;IACG,aAAa,CACjB,OAAO,EAAE,qCAAqC,CAAC,SAAS,CAAC,GACxD,OAAO,CAAC,4BAA4B,CAAC,sBAAsB,CAAC,CAAC;IAKhE;;;;;;;;OAQG;IACG,KAAK,CACT,OAAO,EAAE,6BAA6B,CAAC,SAAS,CAAC,GAChD,OAAO,CAAC,OAAO,CAAC;IAKnB;;;;;;;;;;;;OAYG;IACG,SAAS,CACb,OAAO,EAAE,iCAAiC,CAAC,SAAS,CAAC,EACrD,MAAM,EAAE,iCAAiC,CAAC,QAAQ,CAAC,GAClD,OAAO,CAAC,wBAAwB,CAAC,kBAAkB,CAAC,CAAC;IAKxD;;;;;;;;;;;;OAYG;IACG,YAAY,CAChB,OAAO,EAAE,oCAAoC,CAAC,SAAS,CAAC,EACxD,MAAM,EAAE,oCAAoC,CAAC,QAAQ,CAAC,GACrD,OAAO,CAAC,OAAO,CAAC;IAKnB;;;;;;;;;;;;;OAaG;IACG,cAAc,CAClB,KAAK,EAAE,sCAAsC,CAAC,OAAO,CAAC,GACrD,OAAO,CAAC,6BAA6B,CAAC,uBAAuB,CAAC,CAAC;IAOlE;;;;;;;;;;;;;;OAcG;IACG,UAAU,CACd,KAAK,EAAE,kCAAkC,CAAC,OAAO,CAAC,GACjD,OAAO,CAAC,yBAAyB,CAAC,mBAAmB,CAAC,CAAC;IAK1D;;;;;;;;;;;;;;;;OAgBG;IACG,UAAU,CACd,KAAK,EAAE,kCAAkC,CAAC,OAAO,CAAC,GACjD,OAAO,CAAC,yBAAyB,CAAC,mBAAmB,CAAC,CAAC;IAK1D;;;;;;;;;;;OAWG;IACG,UAAU,CACd,WAAW,EAAE,kCAAkC,CAAC,aAAa,CAAC,GAC7D,OAAO,CAAC,OAAO,CAAC;CAIpB"}