@mpgd/adapter-devvit 0.4.0 → 0.6.0

package/dist/server/index.d.ts

@@ -0,0 +1,3 @@
+export * from './post-operation.js';
+export * from './redis-post-operation-store.js';
+export * from './redis-verified-leaderboard.js';

package/dist/server/index.js

@@ -0,0 +1,3 @@
+export * from './post-operation.js';
+export * from './redis-post-operation-store.js';
+export * from './redis-verified-leaderboard.js';

package/dist/server/post-operation.d.ts

@@ -0,0 +1,135 @@
+declare const operationSchemaVersion: 1;
+export type DevvitJsonValue = null | boolean | number | string | readonly DevvitJsonValue[] | DevvitJsonObject;
+export interface DevvitJsonObject {
+  readonly [key: string]: DevvitJsonValue;
+}
+export interface DevvitDurableOperationStore {
+  /** Reads one durable value. Missing values return undefined. */
+  read(key: string): Promise<string | undefined>;
+  /** Atomically creates a value only when the key is absent. */
+  create(key: string, value: string): Promise<boolean>;
+  /** Atomically replaces a value only when its raw current value matches. */
+  compareAndSet(key: string, expectedValue: string, nextValue: string): Promise<boolean>;
+  /** Atomically creates an expiring reconciliation lease. */
+  createLease(key: string, token: string, expiresAt: Date): Promise<boolean>;
+  /** Deletes a lease only when the current token matches. */
+  releaseLease(key: string, token: string): Promise<void>;
+}
+export interface DevvitPostOperationScope {
+  readonly appScope: string;
+  /** Use the canonical subreddit identifier, not a display name. */
+  readonly subredditId: string;
+}
+export interface DevvitPostLaunch<TParams extends DevvitJsonObject> {
+  readonly entry: string;
+  readonly params: TParams;
+}
+export interface DevvitCanonicalPostData<TPayload extends DevvitJsonObject, TLaunchParams extends DevvitJsonObject> extends DevvitJsonObject {
+  readonly mpgd: {
+    readonly schemaVersion: typeof operationSchemaVersion;
+    readonly appScope: string;
+    readonly subredditId: string;
+    readonly operationType: string;
+    readonly operationId: string;
+  };
+  readonly launch: {
+    readonly schemaVersion: typeof operationSchemaVersion;
+    readonly entry: string;
+    readonly params: TLaunchParams;
+  };
+  readonly payload: TPayload;
+}
+export interface DevvitPostOperationDefinition<TPayload extends DevvitJsonObject, TLaunchParams extends DevvitJsonObject> {
+  readonly operationType: string;
+  readonly parsePayload: (input: unknown) => TPayload;
+  readonly parseLaunchParams: (input: unknown) => TLaunchParams;
+  readonly maxPostDataBytes?: number;
+}
+export interface DevvitPostOperationDescriptorInput<TPayload extends DevvitJsonObject, TLaunchParams extends DevvitJsonObject> {
+  readonly scope: DevvitPostOperationScope;
+  /** Must be stable across process restarts and retries. */
+  readonly operationId: string;
+  readonly payload: TPayload;
+  readonly launch: DevvitPostLaunch<TLaunchParams>;
+}
+export interface DevvitPostPublishInput<TPayload extends DevvitJsonObject, TLaunchParams extends DevvitJsonObject> {
+  readonly scope: DevvitPostOperationScope;
+  readonly operationId: string;
+  readonly postData: DevvitCanonicalPostData<TPayload, TLaunchParams>;
+}
+export interface DevvitPostPublishReceipt {
+  readonly postId: string;
+}
+export interface DevvitPostReconciliationCandidate {
+  readonly postId: string;
+  readonly postData: unknown;
+}
+export type DevvitPostReconciliationReason = 'submission-attempted' | 'submit-outcome-unknown' | 'invalid-publish-receipt' | 'receipt-write-failed' | 'match-not-found' | 'invalid-reconciliation-candidate' | 'reconciliation-failed';
+export type DevvitPostOperationResult<TPayload extends DevvitJsonObject, TLaunchParams extends DevvitJsonObject> = {
+  readonly status: 'missing';
+  readonly operationId: string;
+  readonly postData: DevvitCanonicalPostData<TPayload, TLaunchParams>;
+} | {
+  readonly status: 'prepared';
+  readonly operationId: string;
+  readonly postData: DevvitCanonicalPostData<TPayload, TLaunchParams>;
+} | {
+  readonly status: 'created' | 'existing' | 'recovered';
+  readonly operationId: string;
+  readonly postId: string;
+  readonly postData: DevvitCanonicalPostData<TPayload, TLaunchParams>;
+} | {
+  readonly status: 'reconciliation-required';
+  readonly operationId: string;
+  readonly reason: DevvitPostReconciliationReason;
+  readonly postData: DevvitCanonicalPostData<TPayload, TLaunchParams>;
+} | {
+  readonly status: 'busy';
+  readonly operationId: string;
+  readonly reason: 'store-contention' | 'reconciliation-lease-held';
+  readonly postData: DevvitCanonicalPostData<TPayload, TLaunchParams>;
+} | {
+  readonly status: 'conflict';
+  readonly operationId: string;
+  readonly reason: 'descriptor-mismatch';
+  readonly postData: DevvitCanonicalPostData<TPayload, TLaunchParams>;
+} | {
+  readonly status: 'terminal-unresolved';
+  readonly operationId: string;
+  readonly reason: 'multiple-exact-matches' | 'published-receipt-conflict';
+  readonly postIds: readonly string[];
+  readonly postData: DevvitCanonicalPostData<TPayload, TLaunchParams>;
+};
+export interface ExecuteDevvitPostOperationInput<TPayload extends DevvitJsonObject, TLaunchParams extends DevvitJsonObject> extends DevvitPostOperationDescriptorInput<TPayload, TLaunchParams> {
+  readonly publish: (input: DevvitPostPublishInput<TPayload, TLaunchParams>) => Promise<DevvitPostPublishReceipt>;
+}
+export interface ReconcileDevvitPostOperationInput<TPayload extends DevvitJsonObject, TLaunchParams extends DevvitJsonObject> extends DevvitPostOperationDescriptorInput<TPayload, TLaunchParams> {
+  readonly findCandidates: (input: DevvitPostPublishInput<TPayload, TLaunchParams>) => Promise<readonly DevvitPostReconciliationCandidate[]>;
+}
+export interface DevvitPostOperationCoordinator<TPayload extends DevvitJsonObject, TLaunchParams extends DevvitJsonObject> {
+  execute(input: ExecuteDevvitPostOperationInput<TPayload, TLaunchParams>): Promise<DevvitPostOperationResult<TPayload, TLaunchParams>>;
+  read(input: DevvitPostOperationDescriptorInput<TPayload, TLaunchParams>): Promise<DevvitPostOperationResult<TPayload, TLaunchParams>>;
+  reconcile(input: ReconcileDevvitPostOperationInput<TPayload, TLaunchParams>): Promise<DevvitPostOperationResult<TPayload, TLaunchParams>>;
+}
+export interface CreateDevvitPostOperationCoordinatorOptions<TPayload extends DevvitJsonObject, TLaunchParams extends DevvitJsonObject> {
+  readonly definition: DevvitPostOperationDefinition<TPayload, TLaunchParams>;
+  readonly store: DevvitDurableOperationStore;
+  readonly now?: () => number;
+  readonly createToken?: () => string;
+  readonly leaseTtlMs?: number;
+  readonly storeAttempts?: number;
+}
+export declare class DevvitPostOperationValidationError extends TypeError {
+  constructor(message: string, options?: ErrorOptions);
+}
+export declare class DevvitPostOperationStateError extends Error {
+  constructor(message: string, options?: ErrorOptions);
+}
+export declare function defineDevvitPostOperation<TPayload extends DevvitJsonObject, TLaunchParams extends DevvitJsonObject>(definition: DevvitPostOperationDefinition<TPayload, TLaunchParams>): DevvitPostOperationDefinition<TPayload, TLaunchParams>;
+export declare function createDevvitPostOperationCoordinator<TPayload extends DevvitJsonObject, TLaunchParams extends DevvitJsonObject>(input: CreateDevvitPostOperationCoordinatorOptions<TPayload, TLaunchParams>): DevvitPostOperationCoordinator<TPayload, TLaunchParams>;
+export declare function createDevvitPostOperationKey(input: {
+  readonly scope: DevvitPostOperationScope;
+  readonly operationType: string;
+  readonly operationId: string;
+}): string;
+export {};