@oxy.so/core 1.18.0 → 3.0.0

package/dist/types/mixins/OxyServices.store.d.ts

@@ -1,334 +0,0 @@
-/**
- * App Store Methods Mixin
- *
- * The client surface for 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`).
- *
- * Deliberately separate from `OxyServices.accounts.ts` even though the
- * publisher's routes hang off an application, for the same reason
- * `OxyServices.connectedApps.ts` is: those mixins answer "may this program act
- * for this person?", and this one answers "should this person choose it?". Turn
- * the store off and OAuth still works — which is the test that says the store is
- * a module over the platform rather than part of it.
- *
- * The two prefixes are one domain. A listing IS the store's page for an
- * application, so both halves of its life belong to the same surface; the API
- * puts the publisher's half beside credentials and webhooks because that is
- * where the permission that guards it already lives, and reusing that permission
- * is what stops a store page becoming a second, weaker way to act for somebody's
- * app.
- *
- * ## What is NOT duplicated here
- *
- * A listing carries no name, icon or legal links: `applications` 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 { OxyServicesBase } from '../OxyServices.base';
-/** 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';
-}
-export declare function OxyServicesStoreMixin<T extends typeof OxyServicesBase>(Base: T): {
-    new (...args: any[]): {
-        /** The shelves, in the order the store curates them. */
-        listStoreCategories(): Promise<StoreCategory[]>;
-        /**
-         * 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.
-         */
-        listStoreApps(options?: StorePageOptions & {
-            category?: string;
-        }): Promise<StorePage<StoreListingSummary>>;
-        /**
-         * 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.
-         */
-        getStoreApp(slug: string): Promise<StoreListingDetail>;
-        /** Visible reviews for a published app, each with the publisher's reply. */
-        listStoreReviews(slug: string, options?: StoreReviewsOptions): Promise<StorePage<StoreReview>>;
-        /** The caller's own review of an app, or `null` if they have not written one. */
-        getMyStoreReview(slug: string): Promise<StoreOwnReview | 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.
-         */
-        writeStoreReview(slug: string, input: WriteStoreReviewInput): Promise<StoreOwnReview>;
-        /** Withdraw the caller's own review. A real delete — the words were theirs. */
-        deleteMyStoreReview(slug: string): Promise<void>;
-        /**
-         * Answer a review on the publisher's behalf.
-         *
-         * Requires `app:update` over the application's owning account — the same
-         * permission that guards every other write to that application. Addressed
-         * by review id because the reply belongs to the review, and a listing can be
-         * renamed or withdrawn out from under it.
-         */
-        replyToStoreReview(reviewId: string, body: string): Promise<{
-            id: string;
-            reviewId: string;
-            body: string;
-        }>;
-        /** Withdraw the publisher's answer. Same permission that wrote it. */
-        deleteStoreReviewReply(reviewId: string): Promise<void>;
-        /** The application's store page in whatever state, or `null` if it has none. */
-        getAppListing(applicationId: string): Promise<PublisherListing | null>;
-        /**
-         * 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.
-         */
-        writeAppListing(applicationId: string, input: WriteListingInput): Promise<PublisherListing>;
-        /** Hand the page to the store for review. From a draft, or a rejected page once fixed. */
-        submitAppListing(applicationId: string): Promise<PublisherListing>;
-        /**
-         * 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.
-         */
-        unpublishAppListing(applicationId: string): Promise<PublisherListing>;
-        /** Every picture on the listing, in the author's order. */
-        listAppListingScreenshots(applicationId: string): Promise<StoreScreenshot[]>;
-        /**
-         * Attach an already-uploaded image, appended to the end.
-         *
-         * Upload through the assets surface 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.
-         */
-        addAppListingScreenshot(applicationId: string, input: AddScreenshotInput): Promise<StoreScreenshot>;
-        /** Edit a picture's caption or the frame it was taken in. Order is {@link reorderAppListingScreenshots}. */
-        updateAppListingScreenshot(applicationId: string, screenshotId: string, input: UpdateScreenshotInput): Promise<StoreScreenshot>;
-        /** Remove a picture. The uploaded file stays — it may be in use elsewhere. */
-        deleteAppListingScreenshot(applicationId: string, screenshotId: string): Promise<void>;
-        /**
-         * 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.
-         */
-        reorderAppListingScreenshots(applicationId: string, screenshotIds: string[]): Promise<StoreScreenshot[]>;
-        httpService: import("../HttpService").HttpService;
-        cloudURL: string;
-        config: import("../OxyServices.base").OxyConfig;
-        __resetTokensForTests(): void;
-        makeRequest<T_1>(method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE", url: string, data?: any, options?: import("../HttpService").RequestOptions): Promise<T_1>;
-        getBaseURL(): string;
-        getClient(): import("../HttpService").HttpService;
-        createLinkedClient(config: import("../OxyServices.base").OxyConfig): import("..").LinkedHttpClient;
-        getMetrics(): {
-            totalRequests: number;
-            successfulRequests: number;
-            failedRequests: number;
-            cacheHits: number;
-            cacheMisses: number;
-            averageResponseTime: number;
-        };
-        clearCache(): void;
-        clearCacheEntry(key: string): void;
-        clearCacheByPrefix(prefix: string): number;
-        getCacheStats(): {
-            size: number;
-            hits: number;
-            misses: number;
-            hitRate: number;
-        };
-        getCloudURL(): string;
-        setTokens(accessToken: string): void;
-        clearTokens(): void;
-        onTokensChanged(listener: (accessToken: string | null) => void): () => void;
-        _cachedUserId: string | null | undefined;
-        _cachedAccessToken: string | null;
-        getCurrentUserId(): string | null;
-        hasValidToken(): boolean;
-        getAccessToken(): string | null;
-        getAccessTokenExpiry(): number | null;
-        waitForAuth(timeoutMs?: number): Promise<boolean>;
-        withAuthRetry<T_1>(operation: () => Promise<T_1>, operationName: string, options?: {
-            maxRetries?: number;
-            retryDelay?: number;
-            authTimeoutMs?: number;
-        }): Promise<T_1>;
-        validate(): Promise<boolean>;
-        handleError(error: unknown): Error;
-        healthCheck(): Promise<{
-            status: string;
-            users?: number;
-            timestamp?: string;
-            [key: string]: any;
-        }>;
-    };
-} & T;

package/dist/types/mixins/OxyServices.topics.d.ts

@@ -1,110 +0,0 @@
-/**
- * Topics Methods Mixin
- *
- * Provides methods for topic discovery and management
- */
-import type { OxyServicesBase } from '../OxyServices.base';
-import type { TopicData, TopicListResult, TopicTranslation } from '../models/Topic';
-export declare function OxyServicesTopicsMixin<T extends typeof OxyServicesBase>(Base: T): {
-    new (...args: any[]): {
-        /**
-         * Get top-level topic categories
-         * @param locale - Optional locale for translated results
-         * @returns List of category topics
-         */
-        getTopicCategories(locale?: string): Promise<TopicData[]>;
-        /**
-         * Search topics by query string
-         * @param query - Search query
-         * @param limit - Optional result limit
-         * @returns Matching topics
-         */
-        searchTopics(query: string, limit?: number): Promise<TopicData[]>;
-        /**
-         * List topics with optional filters
-         * @param options - Filter and pagination options
-         * @returns Paginated topics envelope (`topics` plus `total`/`limit`/`offset`)
-         */
-        listTopics(options?: {
-            type?: string;
-            q?: string;
-            limit?: number;
-            offset?: number;
-            locale?: string;
-        }): Promise<TopicListResult>;
-        /**
-         * Get a single topic by slug
-         * @param slug - Topic slug
-         * @returns Topic data
-         */
-        getTopicBySlug(slug: string): Promise<TopicData>;
-        /**
-         * Resolve an array of topic names to existing or newly created topics
-         * @param names - Array of { name, type } objects to resolve
-         * @returns Resolved topic data
-         */
-        resolveTopicNames(names: Array<{
-            name: string;
-            type: string;
-        }>): Promise<TopicData[]>;
-        /**
-         * Update metadata for a topic
-         * @param slug - Topic slug
-         * @param data - Metadata fields to update
-         * @returns Updated topic data
-         */
-        updateTopicMetadata(slug: string, data: {
-            description?: string;
-            translations?: Record<string, TopicTranslation>;
-        }): Promise<TopicData>;
-        httpService: import("../HttpService").HttpService;
-        cloudURL: string;
-        config: import("../OxyServices.base").OxyConfig;
-        __resetTokensForTests(): void;
-        makeRequest<T_1>(method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE", url: string, data?: any, options?: import("../HttpService").RequestOptions): Promise<T_1>;
-        getBaseURL(): string;
-        getClient(): import("../HttpService").HttpService;
-        createLinkedClient(config: import("../OxyServices.base").OxyConfig): import("..").LinkedHttpClient;
-        getMetrics(): {
-            totalRequests: number;
-            successfulRequests: number;
-            failedRequests: number;
-            cacheHits: number;
-            cacheMisses: number;
-            averageResponseTime: number;
-        };
-        clearCache(): void;
-        clearCacheEntry(key: string): void;
-        clearCacheByPrefix(prefix: string): number;
-        getCacheStats(): {
-            size: number;
-            hits: number;
-            misses: number;
-            hitRate: number;
-        };
-        getCloudURL(): string;
-        setTokens(accessToken: string): void;
-        clearTokens(): void;
-        onTokensChanged(listener: (accessToken: string | null) => void): () => void;
-        _cachedUserId: string | null | undefined;
-        _cachedAccessToken: string | null;
-        getCurrentUserId(): string | null;
-        hasValidToken(): boolean;
-        getAccessToken(): string | null;
-        getAccessTokenExpiry(): number | null;
-        waitForAuth(timeoutMs?: number): Promise<boolean>;
-        withAuthRetry<T_1>(operation: () => Promise<T_1>, operationName: string, options?: {
-            maxRetries?: number;
-            retryDelay?: number;
-            authTimeoutMs?: number;
-        }): Promise<T_1>;
-        validate(): Promise<boolean>;
-        handleError(error: unknown): Error;
-        healthCheck(): Promise<{
-            status: string;
-            users?: number;
-            timestamp?: string;
-            [key: string]: any;
-        }>;
-    };
-} & T;