gristlabs_grist-core/stubs/app/server/declarations.d.ts
Alex Hall 0005ad013e (core) Notify open ActiveDocs when the product is upgraded
Summary:
When an account is upgraded to a new product in Billing, send a message to the redis channel `billingAccount-${accountId}-product-changed`.

ActiveDocs subscribe to this channel. When a message is received, they refresh their product from the database and use it to recalculate doc usage based on new limits. The new usage is broadcast to clients so they see the result of the upgrade live.

Test Plan: Extended nbrowser Billing test to test that a document open in a separate tab has its limit banner cleared immediately on upgrade.

Reviewers: paulfitz

Reviewed By: paulfitz

Differential Revision: https://phab.getgrist.com/D3480
2022-06-14 17:25:45 +02:00

83 lines
3.6 KiB
TypeScript

// Copy official sqlite3 types to apply to @gristlabs/sqlite3.
declare module "@gristlabs/sqlite3" {
export * from 'sqlite3';
// Add minimal typings for sqlite backup api.
// TODO: remove this once the type definitions are updated upstream.
import {Database} from 'sqlite3';
export class Backup {
public readonly remaining: number;
public readonly pageCount: number;
public readonly idle: boolean;
public readonly completed: boolean;
public readonly failed: boolean;
public step(pages: number, callback?: (err: Error|null) => void): void;
}
export class DatabaseWithBackup extends Database {
public backup(filename: string, callback?: (err: Error|null) => void): Backup;
public backup(filename: string, destDbName: 'main', srcDbName: 'main',
filenameIsDest: boolean, callback?: (err: Error|null) => void): Backup;
}
}
// Add declarations of the promisified methods of redis.
// This is not exhaustive, there are a *lot* of methods.
declare module "redis" {
function createClient(url?: string): RedisClient;
class RedisClient {
public eval(args: any[], callback?: (err: Error | null, res: any) => void): any;
public subscribe(channel: string): void;
public on(eventType: string, callback: (...args: any[]) => void): void;
public publishAsync(channel: string, message: string): Promise<number>;
public delAsync(key: string): Promise<'OK'>;
public flushdbAsync(): Promise<void>;
public getAsync(key: string): Promise<string|null>;
public hdelAsync(key: string, field: string): Promise<number>;
public hgetallAsync(key: string): Promise<{[field: string]: any}|null>;
public hkeysAsync(key: string): Promise<string[]|null>;
public hmsetAsync(key: string, val: {[field: string]: any}): Promise<'OK'>;
public hsetAsync(key: string, field: string, val: string): Promise<1|0>;
public keysAsync(pattern: string): Promise<string[]>;
public multi(): Multi;
public quitAsync(): Promise<void>;
public saddAsync(key: string, val: string): Promise<'OK'>;
public selectAsync(db: number): Promise<void>;
public setAsync(key: string, val: string): Promise<'OK'>;
public setexAsync(key: string, ttl: number, val: string): Promise<'OK'>;
public sismemberAsync(key: string, val: string): Promise<0|1>;
public smembersAsync(key: string): Promise<string[]>;
public srandmemberAsync(key: string): Promise<string|null>;
public sremAsync(key: string, val: string): Promise<'OK'>;
public ttlAsync(key: string): Promise<number|null>;
public unwatchAsync(): Promise<'OK'>;
public watchAsync(key: string): Promise<void>;
public lrangeAsync(key: string, start: number, end: number): Promise<string[]>;
public rpushAsync(key: string, ...vals: string[]): Promise<number>;
}
class Multi {
public del(key: string): Multi;
public execAsync(): Promise<any[]|null>;
public get(key: string): Multi;
public hgetall(key: string): Multi;
public hmset(key: string, val: {[field: string]: any}): Multi;
public hset(key: string, field: string, val: string): Multi;
public sadd(key: string, val: string): Multi;
public set(key: string, val: string): Multi;
public setex(key: string, ttl: number, val: string): Multi;
public ttl(key: string): Multi;
public smembers(key: string): Multi;
public srandmember(key: string): Multi;
public srem(key: string, val: string): Multi;
public rpush(key: string, ...vals: string[]): Multi;
public ltrim(key: string, start: number, end: number): Multi;
public incr(key: string): Multi;
public expire(key: string, seconds: number): Multi;
}
}