@oxy.so/core 1.18.1 → 3.0.0

package/src/api/session.ts

@@ -0,0 +1,210 @@
+/**
+ * `oxy.session` — this client's auth state and its server session.
+ *
+ * The local half is synchronous state: the access token, the user id it
+ * carries, change notifications. The remote half is the server session that
+ * token belongs to: validating it, listing the sessions beside it, signing out.
+ */
+import { jwtDecode } from 'jwt-decode';
+import type { DeviceProof } from '@oxy.so/contracts';
+import type { OxyContext } from '../client/context';
+import type { ClientSession } from '../models/session';
+import type { User } from '../models/interfaces';
+import { normalizeUserIdentity } from '../utils/userIdentity';
+
+/**
+ * Reads the device credential this client holds, if any — `{ deviceId,
+ * deviceSecret }` from the provider's auth store. See
+ * {@link SessionApi.setDeviceCredentialProvider}.
+ */
+export type DeviceCredentialProvider = () => Promise<DeviceProof | null> | DeviceProof | null;
+
+export interface SessionValidation {
+  valid: boolean;
+  expiresAt: string;
+  lastActivity: string;
+  user: User;
+  sessionId?: string;
+  source?: string;
+}
+
+interface AccessTokenClaims {
+  exp?: number;
+  userId?: string;
+  id?: string;
+}
+
+export class SessionApi {
+  private deviceCredentialProvider: DeviceCredentialProvider | null = null;
+  private decodedFor: string | null = null;
+  private decoded: AccessTokenClaims | null = null;
+
+  constructor(private readonly ctx: OxyContext) {}
+
+  // ── Local state ──────────────────────────────────────────────────────────
+
+  /** The current access token, or `null` when signed out. */
+  get accessToken(): string | null {
+    return this.ctx.http.getAccessToken();
+  }
+
+  /** Whether an access token is held. Does not ask the server; see `validateToken`. */
+  get isAuthenticated(): boolean {
+    return this.ctx.http.hasAccessToken();
+  }
+
+  /** The signed-in user's id, from the access token; `null` when signed out. */
+  get userId(): string | null {
+    const claims = this.claims();
+    return claims?.userId || claims?.id || null;
+  }
+
+  /**
+   * The access token's `exp` in SECONDS since the epoch (the raw JWT unit), or
+   * `null` when there is no token or it carries no numeric `exp`. Powers the
+   * proactive refresh timer in `@oxy.so/services`.
+   */
+  get accessTokenExpiry(): number | null {
+    const exp = this.claims()?.exp;
+    return typeof exp === 'number' ? exp : null;
+  }
+
+  /** Plant an access token (e.g. one a sign-in returned). */
+  setAccessToken(accessToken: string): void {
+    this.ctx.http.setTokens(accessToken);
+  }
+
+  /**
+   * Forget the token and end the local session: a re-mint already in flight
+   * plants nothing, and none runs until a token is set again.
+   */
+  clear(): void {
+    this.ctx.http.endSession();
+  }
+
+  /**
+   * Subscribe to access-token changes — `setAccessToken`, `clear`, a silent
+   * refresh, the 401-driven clear. The listener gets the new token, or `null`.
+   * Returns the unsubscribe.
+   */
+  onChange(listener: (accessToken: string | null) => void): () => void {
+    return this.ctx.http.addTokenChangeListener(listener);
+  }
+
+  /**
+   * Resolve `true` as soon as a token is held, or `false` after `timeoutMs`.
+   * Event-driven: no polling.
+   */
+  waitForAuth(timeoutMs = 5000): Promise<boolean> {
+    if (this.isAuthenticated) return Promise.resolve(true);
+    return new Promise((resolve) => {
+      const timer = setTimeout(() => {
+        unsubscribe();
+        resolve(false);
+      }, timeoutMs);
+      const unsubscribe = this.onChange((token) => {
+        if (!token) return;
+        clearTimeout(timer);
+        unsubscribe();
+        resolve(true);
+      });
+    });
+  }
+
+  /**
+   * Tell this client how to read the device credential it holds, so a sign-in
+   * can PROVE the device (ADR 0029 D2): every sign-in in `oxy.auth` then sends
+   * it as `device`, and the server puts the new session on that device — the
+   * browser's shared one, which every Oxy app holding it sees at once.
+   *
+   * `OxyProvider` wires this from its auth store; nothing else needs to.
+   * Returns a disposer that clears it (only if still installed).
+   */
+  setDeviceCredentialProvider(provider: DeviceCredentialProvider | null): () => void {
+    this.deviceCredentialProvider = provider;
+    return () => {
+      if (this.deviceCredentialProvider === provider) {
+        this.deviceCredentialProvider = null;
+      }
+    };
+  }
+
+  /**
+   * The device proof a sign-in should carry, or `null`. Never throws: a store
+   * that cannot be read only means the sign-in gets its own device.
+   */
+  async readDeviceProof(): Promise<DeviceProof | null> {
+    const provider = this.deviceCredentialProvider;
+    if (!provider) return null;
+    try {
+      const proof = await provider();
+      if (proof && typeof proof.deviceId === 'string' && proof.deviceId && typeof proof.deviceSecret === 'string' && proof.deviceSecret) {
+        return { deviceId: proof.deviceId, deviceSecret: proof.deviceSecret };
+      }
+      return null;
+    } catch {
+      return null;
+    }
+  }
+
+  // ── The server session ───────────────────────────────────────────────────
+
+  /** Ask the server whether the current access token is valid. */
+  async validateToken(): Promise<boolean> {
+    if (!this.isAuthenticated) return false;
+    try {
+      const res = await this.ctx.request<{ valid: boolean }>('GET', '/auth/validate', undefined, { cache: false, retry: false });
+      return res.valid === true;
+    } catch {
+      return false;
+    }
+  }
+
+  /** Validate a session by id and return it with its user. */
+  async validate(
+    sessionId: string,
+    options: { deviceFingerprint?: string; useHeaderValidation?: boolean } = {},
+  ): Promise<SessionValidation> {
+    const params: Record<string, string> = {};
+    if (options.deviceFingerprint) params.deviceFingerprint = options.deviceFingerprint;
+    if (options.useHeaderValidation) params.useHeaderValidation = 'true';
+    try {
+      const validation = await this.ctx.request<SessionValidation>('GET', `/session/validate/${sessionId}`, params, { cache: false });
+      return { ...validation, user: normalizeUserIdentity(validation.user) };
+    } catch (error) {
+      // The session is gone: drop any user cached for it (#196).
+      this.ctx.oxy.cache.delete(`GET:/session/user/${sessionId}`);
+      throw error;
+    }
+  }
+
+  /** The sessions that belong with `sessionId` (same account set). */
+  async list(sessionId: string): Promise<ClientSession[]> {
+    return this.ctx.request<ClientSession[]>('GET', `/session/sessions/${sessionId}`, undefined, { cache: false });
+  }
+
+  /** Sign out `sessionId`, or — with `targetSessionId` — one of the sessions beside it. */
+  async logout(sessionId: string, targetSessionId?: string): Promise<void> {
+    const url = targetSessionId ? `/session/logout/${sessionId}/${targetSessionId}` : `/session/logout/${sessionId}`;
+    await this.ctx.request('POST', url, undefined, { cache: false });
+  }
+
+  /** Sign out every session beside `sessionId`, and it. */
+  async logoutAll(sessionId: string): Promise<void> {
+    await this.ctx.request('POST', `/session/logout-all/${sessionId}`, undefined, { cache: false });
+  }
+
+  /** Decoded claims of the current token, memoised per token string. */
+  private claims(): AccessTokenClaims | null {
+    const token = this.ctx.http.getAccessToken();
+    if (token !== this.decodedFor) {
+      this.decodedFor = token;
+      try {
+        this.decoded = token ? jwtDecode<AccessTokenClaims>(token) : null;
+      } catch {
+        this.decoded = null;
+      }
+    }
+    return this.decoded;
+  }
+}

package/src/api/store.ts

@@ -0,0 +1,435 @@
+/**
+ * `oxy.store` — the Oxy app store: the public storefront (`/store`), the
+ * reviews people write there, and the listing a publisher edits for an
+ * application they own (`/applications/:appId/listing`).
+ *
+ * Separate from `oxy.apps` even though the publisher's routes hang off an
+ * application: `apps` answers "may this program act for this person?", and this
+ * answers "should this person choose it?". Turn the store off and OAuth still
+ * works — the store is a module over the platform rather than part of it.
+ *
+ * A listing carries no name, icon or legal links: the application already holds
+ * them and the storefront joins them in. A rating is computed from the visible
+ * reviews on every read rather than stored, so a hidden review stops counting
+ * the moment it is hidden. Reference listings by their `slug` in the storefront
+ * (it is what every link carries) and applications by their `_id` in the
+ * publisher's calls.
+ */
+import type { OxyContext } from '../client/context';
+
+const SHORT_TTL = 60 * 1000;
+const MEDIUM_TTL = 2 * 60 * 1000;
+
+const enc = encodeURIComponent;
+
+/** A shelf on the storefront. */
+export interface StoreCategory {
+  /** The public identifier a link carries. Never the row id. */
+  slug: string;
+  /** What a person reads. Never derived from the slug at render time. */
+  label: string;
+  description?: string | null;
+}
+
+/** The rating of an app, computed from its visible reviews. */
+export interface StoreRating {
+  /** Rounded to one decimal, or `null` when nobody has reviewed it — never 0. */
+  average: number | null;
+  count: number;
+}
+
+/** An app as a card on the storefront: what a listing page needs, and no more. */
+export interface StoreListingSummary {
+  slug: string;
+  /** From the APPLICATION, joined in — the listing keeps no copy. */
+  name: string;
+  tagline: string | null;
+  /** A file id for the app's icon, resolved through the usual image resolver. */
+  icon: string | null;
+  category: StoreCategory | null;
+  rating: StoreRating;
+}
+
+/** A store page in full. */
+export interface StoreListingDetail extends StoreListingSummary {
+  description: string | null;
+  /** These four come from the application; the consent screen shows the same values. */
+  websiteUrl: string | null;
+  privacyPolicyUrl: string | null;
+  termsUrl: string | null;
+  supportUrl: string | null;
+  supportEmail: string | null;
+  publishedAt: string | null;
+  screenshots: StoreScreenshot[];
+  /** How many visible reviews gave each of 1..5. Absent keys are zero. */
+  ratingBreakdown: Record<number, number>;
+}
+
+/** Which frame a screenshot was taken in. The store groups by it on the page. */
+export type StoreScreenshotPlatform = 'phone' | 'tablet' | 'desktop' | 'web';
+
+export interface StoreScreenshot {
+  id: string;
+  /** The uploaded asset's file id. Upload through the assets surface first. */
+  fileId: string;
+  platform: StoreScreenshotPlatform;
+  caption: string | null;
+  position: number;
+}
+
+/** Somebody's review, as it appears on a store page. */
+export interface StoreReview {
+  id: string;
+  rating: number;
+  title: string | null;
+  body: string | null;
+  createdAt: string;
+  author: { id: string; username: string | null };
+  /** The publisher's answer, when there is one. */
+  reply: { body: string; createdAt: string } | null;
+  /**
+   * Whether this author has authorized the application, read from their grant
+   * at request time rather than stored on the review.
+   *
+   * It is not a claim that they still use it, and it is `false` for a
+   * first-party app nobody has to consent to — so render its absence as nothing
+   * at all rather than as a demotion.
+   */
+  authorUsesApp: boolean;
+}
+
+/** A review as its own author sees it, whatever its moderation state. */
+export interface StoreOwnReview {
+  id: string;
+  rating: number;
+  title: string | null;
+  body: string | null;
+  /** An author is told when their review is hidden; the public list is not. */
+  status: 'visible' | 'hidden' | 'flagged' | 'removed';
+  createdAt: string;
+  updatedAt: string;
+}
+
+/** What a person submits about an app. One review each; writing again replaces it. */
+export interface WriteStoreReviewInput {
+  /** Whole stars, 1 to 5. The database enforces the bound too. */
+  rating: number;
+  title?: string | null;
+  body?: string | null;
+}
+
+/** Where a listing is in its life. `pending_review` is the STORE's review of the page. */
+export type StoreListingStatus = 'draft' | 'pending_review' | 'published' | 'rejected';
+
+/** A listing as its publisher sees it: whatever state it is in. */
+export interface PublisherListing {
+  id: string;
+  applicationId: string;
+  slug: string;
+  tagline: string | null;
+  description: string | null;
+  category: StoreCategory | null;
+  supportUrl: string | null;
+  supportEmail: string | null;
+  status: StoreListingStatus;
+  publishedAt: string | null;
+  createdAt: string;
+  updatedAt: string;
+}
+
+/**
+ * The whole page, not a patch: sending everything is what makes "clear the
+ * tagline" expressible at all.
+ *
+ * `status` is absent on purpose. Publishing is the store's decision and has its
+ * own calls, so a publisher cannot publish themselves by putting a field in a
+ * body.
+ */
+export interface WriteListingInput {
+  /** Lowercase letters, digits and single hyphens. What every link carries. */
+  slug: string;
+  tagline?: string | null;
+  description?: string | null;
+  /** A category SLUG, never its id. */
+  categorySlug?: string | null;
+  supportUrl?: string | null;
+  supportEmail?: string | null;
+}
+
+export interface AddScreenshotInput {
+  /** An already-uploaded image. Must be live, an image, and yours to publish. */
+  fileId: string;
+  platform?: StoreScreenshotPlatform;
+  caption?: string | null;
+}
+
+export interface UpdateScreenshotInput {
+  platform?: StoreScreenshotPlatform;
+  caption?: string | null;
+}
+
+/**
+ * One page of a paginated store read.
+ *
+ * `hasMore` comes from the API rather than being derived here, so a caller that
+ * pages does not have to re-implement the boundary the server already computed.
+ */
+export interface StorePage<T> {
+  items: T[];
+  total: number;
+  hasMore: boolean;
+}
+
+/** Options for paging the storefront and the reviews under an app. */
+export interface StorePageOptions {
+  limit?: number;
+  offset?: number;
+}
+
+export interface StoreReviewsOptions extends StorePageOptions {
+  /** Newest first by default; `rating` surfaces the strongest opinions. */
+  sort?: 'recent' | 'rating';
+}
+
+/**
+ * The API's paginated envelope. The counts live under `pagination`, NOT under
+ * `meta` — `meta` is what the single-object `sendSuccess` helper uses, and
+ * reading the wrong one yields a `total` of zero on every page with no error
+ * anywhere.
+ */
+interface PaginatedResponse<T> {
+  data?: T[];
+  pagination?: { total?: number; hasMore?: boolean };
+}
+
+/** Read one page out of that envelope. */
+function pageOf<T>(res: PaginatedResponse<T>): StorePage<T> {
+  return {
+    items: res.data ?? [],
+    total: res.pagination?.total ?? 0,
+    hasMore: res.pagination?.hasMore ?? false,
+  };
+}
+
+/**
+ * Build a query string from the options that were actually supplied.
+ *
+ * Generic over the options object rather than taking a `Record`: an interface
+ * has no implicit index signature in TypeScript, so `StoreReviewsOptions` would
+ * not be assignable to one and every call site would need a cast.
+ */
+function queryOf<T extends object>(params: T): string {
+  const search = new URLSearchParams();
+  for (const [key, value] of Object.entries(params)) {
+    if (value !== undefined) search.set(key, String(value));
+  }
+  const rendered = search.toString();
+  return rendered ? `?${rendered}` : '';
+}
+
+
+/** `oxy.store.reviews` — what people say about an app, and the caller's own review. */
+export class StoreReviewsApi {
+  constructor(private readonly ctx: OxyContext) {}
+
+  /** Visible reviews for a published app, each with the publisher's reply. */
+  async list(slug: string, options: StoreReviewsOptions = {}): Promise<StorePage<StoreReview>> {
+    const res = await this.ctx.request<PaginatedResponse<StoreReview>>(
+      'GET',
+      `/store/apps/${enc(slug)}/reviews${queryOf(options)}`,
+      undefined,
+      { cache: true, cacheTTL: SHORT_TTL },
+    );
+    return pageOf(res);
+  }
+
+  /** The caller's own review of an app, or `null` if they have not written one. */
+  async mine(slug: string): Promise<StoreOwnReview | null> {
+    const res = await this.ctx.request<{ data: StoreOwnReview | null }>('GET', reviewPath(slug), undefined, {
+      cache: false,
+    });
+    return res.data ?? null;
+  }
+
+  /**
+   * Write the caller's review, or replace what they said before.
+   *
+   * A person has one review per app, so this sets it rather than adding one.
+   * Rewriting does not clear a moderator's decision: a hidden review stays
+   * hidden when its author edits it.
+   */
+  async write(slug: string, input: WriteStoreReviewInput): Promise<StoreOwnReview> {
+    const res = await this.ctx.request<{ data: StoreOwnReview }>('PUT', reviewPath(slug), input, { cache: false });
+    return res.data;
+  }
+
+  /** Withdraw the caller's own review. A real delete — the words were theirs. */
+  async deleteMine(slug: string): Promise<void> {
+    await this.ctx.request<void>('DELETE', reviewPath(slug), undefined, { cache: false });
+  }
+}
+
+/** `oxy.store.listing.screenshots` — the pictures on a listing. */
+export class ListingScreenshotsApi {
+  constructor(private readonly ctx: OxyContext) {}
+
+  /** Every picture on the listing, in the author's order. */
+  async list(applicationId: string): Promise<StoreScreenshot[]> {
+    return this.ctx.request<StoreScreenshot[]>('GET', screenshotsPath(applicationId), undefined, { cache: false });
+  }
+
+  /**
+   * Attach an already-uploaded image, appended to the end.
+   *
+   * Upload through `oxy.assets` first; the store keeps a reference rather than
+   * a second copy of the asset pipeline. The file must be live, an image, and
+   * one the caller is entitled to.
+   */
+  async add(applicationId: string, input: AddScreenshotInput): Promise<StoreScreenshot> {
+    return this.ctx.request<StoreScreenshot>('POST', screenshotsPath(applicationId), input, { cache: false });
+  }
+
+  /** Edit a picture's caption or the frame it was taken in. Order is `reorder`. */
+  async update(applicationId: string, screenshotId: string, input: UpdateScreenshotInput): Promise<StoreScreenshot> {
+    return this.ctx.request<StoreScreenshot>(
+      'PATCH',
+      `${screenshotsPath(applicationId)}/${enc(screenshotId)}`,
+      input,
+      { cache: false },
+    );
+  }
+
+  /** Remove a picture. The uploaded file stays — it may be in use elsewhere. */
+  async delete(applicationId: string, screenshotId: string): Promise<void> {
+    await this.ctx.request<void>('DELETE', `${screenshotsPath(applicationId)}/${enc(screenshotId)}`, undefined, {
+      cache: false,
+    });
+  }
+
+  /**
+   * Set the order of every picture at once.
+   *
+   * Send EVERY id on the listing, exactly once, in the order they should
+   * appear. A partial list is rejected rather than applied: it would leave the
+   * pictures it omits at their old positions, interleaved with the new ones.
+   */
+  async reorder(applicationId: string, screenshotIds: string[]): Promise<StoreScreenshot[]> {
+    return this.ctx.request<StoreScreenshot[]>('PUT', `${screenshotsPath(applicationId)}/order`, { screenshotIds }, {
+      cache: false,
+    });
+  }
+}
+
+/** `oxy.store.listing` — the page a publisher edits for an application they own. */
+export class StoreListingApi {
+  /** The pictures on the listing. */
+  readonly screenshots: ListingScreenshotsApi;
+
+  constructor(private readonly ctx: OxyContext) {
+    this.screenshots = new ListingScreenshotsApi(ctx);
+  }
+
+  /** The application's store page in whatever state, or `null` if it has none. */
+  async get(applicationId: string): Promise<PublisherListing | null> {
+    return this.ctx.request<PublisherListing | null>('GET', listingPath(applicationId), undefined, { cache: false });
+  }
+
+  /**
+   * Create the page or replace its content. Never its status.
+   *
+   * Editing does not move a page: correcting a typo on a live listing leaves
+   * it live, and fixing a rejected one does not re-submit it.
+   */
+  async write(applicationId: string, input: WriteListingInput): Promise<PublisherListing> {
+    return this.ctx.request<PublisherListing>('PUT', listingPath(applicationId), input, { cache: false });
+  }
+
+  /** Hand the page to the store for review. From a draft, or a rejected page once fixed. */
+  async submit(applicationId: string): Promise<PublisherListing> {
+    return this.ctx.request<PublisherListing>('POST', `${listingPath(applicationId)}/submit`, undefined, {
+      cache: false,
+    });
+  }
+
+  /**
+   * Take the page down, or withdraw it from the queue.
+   *
+   * Back to a draft, never deleted: the slug, the words and the screenshots are
+   * the publisher's work, and the reviews were never the listing's to take with
+   * them.
+   */
+  async unpublish(applicationId: string): Promise<PublisherListing> {
+    return this.ctx.request<PublisherListing>('POST', `${listingPath(applicationId)}/unpublish`, undefined, {
+      cache: false,
+    });
+  }
+}
+
+export class StoreApi {
+  /** What people say about an app, and the caller's own review. */
+  readonly reviews: StoreReviewsApi;
+  /** The page a publisher edits for an application they own. */
+  readonly listing: StoreListingApi;
+
+  constructor(private readonly ctx: OxyContext) {
+    this.reviews = new StoreReviewsApi(ctx);
+    this.listing = new StoreListingApi(ctx);
+  }
+
+  // The storefront is public: everything served here needs no session.
+
+  /** The shelves, in the order the store curates them. */
+  async categories(): Promise<StoreCategory[]> {
+    const res = await this.ctx.request<{ data: StoreCategory[] }>('GET', '/store/categories', undefined, {
+      cache: true,
+      cacheTTL: MEDIUM_TTL,
+    });
+    return res.data ?? [];
+  }
+
+  /**
+   * Published listings, newest first, optionally one shelf.
+   *
+   * An unknown category slug is an EMPTY shelf, not every app on the store —
+   * so a typo shows nothing rather than showing everything.
+   *
+   * @param options - `category` is a category slug; `limit` defaults to 24.
+   */
+  async apps(options: StorePageOptions & { category?: string } = {}): Promise<StorePage<StoreListingSummary>> {
+    const res = await this.ctx.request<PaginatedResponse<StoreListingSummary>>(
+      'GET',
+      `/store/apps${queryOf(options)}`,
+      undefined,
+      { cache: true, cacheTTL: SHORT_TTL },
+    );
+    return pageOf(res);
+  }
+
+  /**
+   * One store page.
+   *
+   * A draft answers 404 exactly as an unknown slug does: whether an unpublished
+   * page exists under a name is not something a visitor learns.
+   *
+   * @param slug - The listing's public slug, not an application id.
+   */
+  async app(slug: string): Promise<StoreListingDetail> {
+    const res = await this.ctx.request<{ data: StoreListingDetail }>('GET', `/store/apps/${enc(slug)}`, undefined, {
+      cache: true,
+      cacheTTL: SHORT_TTL,
+    });
+    return res.data;
+  }
+}
+
+function reviewPath(slug: string): string {
+  return `/store/apps/${enc(slug)}/review`;
+}
+
+function listingPath(applicationId: string): string {
+  return `/applications/${enc(applicationId)}/listing`;
+}
+
+function screenshotsPath(applicationId: string): string {
+  return `${listingPath(applicationId)}/screenshots`;
+}