feeef 0.8.2 → 0.8.4

package/build/src/feeef/feeef.d.ts

@@ -3,7 +3,9 @@ import { OrderRepository } from './repositories/orders.js';
 import { ProductRepository } from './repositories/products.js';
 import { StoreRepository } from './repositories/stores.js';
 import { UserRepository } from './repositories/users.js';
+import { AppRepository } from './repositories/apps.js';
 import { DepositRepository } from './repositories/deposits.js';
+import { PromoRepository } from './repositories/promos.js';
 import { TransferRepository } from './repositories/transfers.js';
 import { CategoryRepository } from './repositories/categories.js';
 import { CountryRepository } from './repositories/countries.js';
@@ -86,6 +88,10 @@ export declare class FeeeF {
      * The repository for managing users.
      */
     users: UserRepository;
+    /**
+     * The repository for managing developer-registered apps (OAuth clients).
+     */
+    apps: AppRepository;
     /**
      * The repository for managing orders.
      */
@@ -98,6 +104,10 @@ export declare class FeeeF {
      * The repository for managing transfers.
      */
     transfers: TransferRepository;
+    /**
+     * The repository for managing promo codes (list, validate, create).
+     */
+    promos: PromoRepository;
     /**
      * The repository for managing categories.
      */

package/build/src/feeef/repositories/apps.d.ts

@@ -0,0 +1,101 @@
+import { AxiosInstance } from 'axios';
+import { ModelRepository, ListResponse } from './repository.js';
+/**
+ * Developer-registered app (OAuth client) returned by the apps API.
+ * clientSecret is present only on create and regenerateSecret responses.
+ */
+export interface AppEntity {
+    id: string;
+    /** Owner user id. Always present from API. */
+    userId?: string;
+    name: string;
+    clientId: string;
+    redirectUris: string[];
+    scopes: string[];
+    active: boolean;
+    lastUsedAt: string | null;
+    createdAt: string;
+    updatedAt: string | null;
+    /** Present only when returned from create or regenerateSecret. Store securely. */
+    clientSecret?: string;
+}
+/**
+ * Input for creating a new app.
+ * userId is optional; admins may set it to create an app for another user.
+ */
+export interface AppCreateInput {
+    name: string;
+    redirectUris: string[];
+    scopes: string[];
+    userId?: string;
+}
+/**
+ * Input for updating an existing app.
+ */
+export interface AppUpdateInput {
+    name?: string;
+    redirectUris?: string[];
+    scopes?: string[];
+    active?: boolean;
+}
+/**
+ * Options for listing apps (pagination, filterator, search).
+ * filterator: JSON string from dashboard advanced filter; backend applies filtering/ordering.
+ * q: optional search (backend may support free-text search on name/clientId).
+ */
+export interface AppListOptions {
+    page?: number;
+    limit?: number;
+    q?: string;
+    filterator?: string;
+    userId?: string;
+    active?: boolean;
+    params?: Record<string, any>;
+}
+/**
+ * Repository for developer-registered apps (CRUD and regenerate secret).
+ * Requires an authenticated user (Bearer token).
+ *
+ * Terminology: "app" / "apps" is used consistently for the resource;
+ * OAuth is used only for the flow (authorize, token endpoints).
+ */
+export declare class AppRepository extends ModelRepository<AppEntity, AppCreateInput, AppUpdateInput> {
+    constructor(client: AxiosInstance);
+    /**
+     * Lists apps with optional pagination and filterator.
+     * @param options - Page, limit, filterator, q, and extra params forwarded to the API.
+     */
+    list(options?: AppListOptions): Promise<ListResponse<AppEntity>>;
+    /**
+     * Regenerates the client secret for the app. Returns the app with
+     * clientSecret set once; store it securely.
+     *
+     * @param id - The app id.
+     * @returns The app including clientSecret.
+     */
+    regenerateSecret(id: string): Promise<AppEntity>;
+    /**
+     * Builds the OAuth authorize URL to which the user should be redirected.
+     *
+     * @param params - Parameters for the authorize URL.
+     * @param params.baseUrl - API base URL (e.g. https://api.feeef.org/api/v1).
+     * @param params.clientId - The app client id.
+     * @param params.redirectUri - Redirect URI registered for the app.
+     * @param params.responseType - Must be 'code' for authorization code flow.
+     * @param params.scope - Optional list of scopes (space-separated in URL).
+     * @param params.state - Optional state for CSRF protection.
+     * @param params.codeChallenge - Optional PKCE code challenge.
+     * @param params.codeChallengeMethod - Optional 'S256' or 'plain'.
+     * @returns The full authorize URL.
+     */
+    static buildAuthorizeUrl(params: {
+        baseUrl: string;
+        clientId: string;
+        redirectUri: string;
+        responseType: string;
+        scope?: string[];
+        state?: string;
+        codeChallenge?: string;
+        codeChallengeMethod?: string;
+    }): string;
+}

package/build/src/feeef/repositories/promos.d.ts

@@ -0,0 +1,77 @@
+import { AxiosInstance } from 'axios';
+/**
+ * Promo entity (list item from GET /promos).
+ */
+export interface PromoEntity {
+    id: string;
+    code: string;
+    discount: Array<[number, number]>;
+    strict: boolean;
+    min_months: number | null;
+    count: number;
+    max: number | null;
+    starts_at: string | null;
+    ends_at: string | null;
+    referral_id: string | null;
+    created_at: string;
+    updated_at: string;
+}
+/**
+ * Result of POST /promos/validate.
+ */
+export interface PromoValidationResult {
+    valid: boolean;
+    reason?: 'invalid' | 'expired' | 'not_yet_valid' | 'max_uses';
+    code?: string;
+    discount?: Array<[number, number]>;
+    strict?: boolean;
+    minMonths?: number;
+}
+/**
+ * List response for promos (backend returns { data, total, page, limit }).
+ */
+export interface PromoListResponse {
+    data: PromoEntity[];
+    total?: number;
+    page?: number;
+    limit?: number;
+}
+/**
+ * Input for creating a promo.
+ */
+export interface PromoCreateInput {
+    code: string;
+    discount: Array<[number, number]>;
+    strict: boolean;
+    min_months?: number | null;
+    max?: number | null;
+    starts_at?: string | null;
+    ends_at?: string | null;
+    referral_id?: string | null;
+}
+/**
+ * Repository for promo codes: list, validate, create.
+ */
+export declare class PromoRepository {
+    private client;
+    constructor(client: AxiosInstance);
+    /**
+     * Lists promos with optional pagination and validNow filter.
+     */
+    list(params?: {
+        page?: number;
+        limit?: number;
+        validNow?: boolean;
+    }): Promise<PromoListResponse>;
+    /**
+     * Validates a promo code. Returns validation result with discount info or reason.
+     */
+    validate(params: {
+        code: string;
+        storeId?: string;
+    }): Promise<PromoValidationResult>;
+    /**
+     * Creates a promo (admin). Returns the created promo.
+     */
+    create(data: PromoCreateInput): Promise<PromoEntity>;
+}

package/build/src/feeef/repositories/store_invites_repository.d.ts

@@ -0,0 +1,48 @@
+import { AxiosInstance } from 'axios';
+import { StoreInvite, CreateStoreInviteInput, StoreMember } from '../../core/entities/store.js';
+/**
+ * Repository for store invites. Exposed as `ff.stores.invites`.
+ * All methods require a store ID since invites are scoped to a store.
+ */
+export declare class StoreInvitesRepository {
+    private readonly client;
+    private readonly resource;
+    constructor(client: AxiosInstance, resource: string);
+    /**
+     * Lists invites for a store.
+     * @param storeId - The store ID.
+     * @param params - Optional filters (e.g. status).
+     * @returns A Promise that resolves to the list of invites.
+     */
+    list(storeId: string, params?: {
+        status?: string;
+    }): Promise<StoreInvite[]>;
+    /**
+     * Creates a store invite (sends email to invitee).
+     * @param storeId - The store ID.
+     * @param data - The invite data.
+     * @returns A Promise that resolves to the created invite.
+     */
+    create(storeId: string, data: CreateStoreInviteInput): Promise<StoreInvite>;
+    /**
+     * Gets invite details (public or full if authorized).
+     * @param storeId - The store ID.
+     * @param inviteId - The invite ID.
+     * @returns A Promise that resolves to the invite.
+     */
+    get(storeId: string, inviteId: string): Promise<StoreInvite>;
+    /**
+     * Revokes a pending invite.
+     * @param storeId - The store ID.
+     * @param inviteId - The invite ID.
+     */
+    revoke(storeId: string, inviteId: string): Promise<void>;
+    /**
+     * Accepts an invite (authenticated user's email must match invite email).
+     * @param storeId - The store ID.
+     * @param inviteId - The invite ID.
+     * @param token - The invite token from the email link.
+     * @returns A Promise that resolves to the created store member.
+     */
+    accept(storeId: string, inviteId: string, token: string): Promise<StoreMember>;
+}

package/build/src/feeef/repositories/stores.d.ts

@@ -1,6 +1,7 @@
 import { AxiosInstance } from 'axios';
 import { ModelRepository, ListResponse } from './repository.js';
-import { StoreEntity, StoreSummary, StoreMember, StoreInvite, CreateStoreInviteInput, StoreSubscriptionType, AddStoreMemberInput, UpdateStoreMemberInput, StoreCreateInput, StoreUpdateInput } from '../../core/entities/store.js';
+import { StoreEntity, StoreSummary, StoreMember, StoreSubscriptionType, AddStoreMemberInput, UpdateStoreMemberInput, StoreCreateInput, StoreUpdateInput } from '../../core/entities/store.js';
+import { StoreInvitesRepository } from './store_invites_repository.js';
 /**
  * Options for listing stores
  */
@@ -78,50 +79,19 @@ export declare class StoreRepository extends ModelRepository<StoreEntity, StoreC
      */
     removeMember(storeId: string, memberId: string): Promise<void>;
     /**
-     * Creates a store invite (sends email to invitee).
-     * @param storeId - The store ID.
-     * @param data - The invite data.
-     * @returns A Promise that resolves to the created invite.
-     */
-    createInvite(storeId: string, data: CreateStoreInviteInput): Promise<StoreInvite>;
-    /**
-     * Lists invites for a store.
-     * @param storeId - The store ID.
-     * @param params - Optional filters (e.g. status).
-     * @returns A Promise that resolves to the list of invites.
-     */
-    listInvites(storeId: string, params?: {
-        status?: string;
-    }): Promise<StoreInvite[]>;
-    /**
-     * Revokes a pending invite.
-     * @param storeId - The store ID.
-     * @param inviteId - The invite ID.
-     */
-    revokeInvite(storeId: string, inviteId: string): Promise<void>;
-    /**
-     * Gets invite details (public or full if authorized).
-     * @param storeId - The store ID.
-     * @param inviteId - The invite ID.
-     * @returns A Promise that resolves to the invite.
-     */
-    getInvite(storeId: string, inviteId: string): Promise<StoreInvite>;
-    /**
-     * Accepts an invite (authenticated user's email must match invite email).
-     * @param storeId - The store ID.
-     * @param inviteId - The invite ID.
-     * @param token - The invite token from the email link.
-     * @returns A Promise that resolves to the created store member.
+     * Repository for store invites. Use e.g. `ff.stores.invites.list(storeId)`, `ff.stores.invites.create(storeId, data)`.
      */
-    acceptInvite(storeId: string, inviteId: string, token: string): Promise<StoreMember>;
+    get invites(): StoreInvitesRepository;
     /**
      * Upgrades or renews a store's subscription plan.
      * @param id - The store ID.
      * @param plan - The plan type to upgrade to.
      * @param months - The number of months (1-12).
-     * @returns A Promise that resolves when the upgrade is complete.
+     * @param code - Optional promo code.
      */
-    upgrade(id: string, plan: StoreSubscriptionType, months: number): Promise<void>;
+    upgrade(id: string, plan: StoreSubscriptionType, months: number, options?: {
+        code?: string;
+    }): Promise<void>;
     /**
      * Purchases additional points for a store's subscription.
      * @param id - The store ID.

package/build/src/index.d.ts

@@ -17,12 +17,15 @@ export * from './core/entities/city.js';
 export * from './core/entities/currency.js';
 export * from './core/entities/feedback.js';
 export * from './feeef/repositories/repository.js';
+export * from './feeef/repositories/apps.js';
 export * from './feeef/repositories/deposits.js';
+export * from './feeef/repositories/promos.js';
 export * from './feeef/repositories/transfers.js';
 export * from './feeef/repositories/shipping_prices.js';
 export * from './feeef/repositories/shipping_methods.js';
 export * from './feeef/repositories/users.js';
 export * from './feeef/repositories/stores.js';
+export * from './feeef/repositories/store_invites_repository.js';
 export * from './feeef/repositories/products.js';
 export * from './feeef/repositories/orders.js';
 export * from './feeef/repositories/image_prompt_templates.js';
@@ -33,8 +36,10 @@ export * from './feeef/repositories/countries.js';
 export * from './feeef/repositories/states.js';
 export * from './feeef/repositories/cities.js';
 export * from './feeef/repositories/currencies.js';
+export type { AppEntity, AppCreateInput, AppUpdateInput } from './feeef/repositories/apps.js';
 export type { TransferEntity, TransferCreateInput, TransferUpdateInput, TransferType, TransferListOptions, } from './feeef/repositories/transfers.js';
 export type { DepositEntity, DepositCreateInput, DepositUpdateInput, DepositStatus, DepositListOptions, PayPalOrderResponse, PayPalCaptureResponse, } from './feeef/repositories/deposits.js';
+export type { PromoEntity, PromoValidationResult, PromoListResponse, PromoCreateInput, } from './feeef/repositories/promos.js';
 export * from './core/embadded/address.js';
 export * from './core/embadded/category.js';
 export * from './core/embadded/contact.js';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "feeef",
   "description": "feeef sdk for javascript",
-  "version": "0.8.2",
+  "version": "0.8.4",
   "main": "build/index.js",
   "type": "module",
   "files": [