@atproto/repo 0.0.1 → 0.2.0

package/dist/src/types.d.ts

@@ -0,0 +1,368 @@
+import { z } from 'zod';
+import { BlockWriter } from '@ipld/car/writer';
+import { CID } from 'multiformats';
+import { DataDiff } from './mst';
+declare const repoMeta: z.ZodObject<{
+    did: z.ZodString;
+    version: z.ZodNumber;
+    datastore: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    did: string;
+    version: number;
+    datastore: string;
+}, {
+    did: string;
+    version: number;
+    datastore: string;
+}>;
+export declare type RepoMeta = z.infer<typeof repoMeta>;
+declare const repoRoot: z.ZodObject<{
+    meta: z.ZodEffects<z.ZodEffects<z.ZodAny, any, any>, CID, any>;
+    prev: z.ZodNullable<z.ZodEffects<z.ZodEffects<z.ZodAny, any, any>, CID, any>>;
+    auth_token: z.ZodNullable<z.ZodEffects<z.ZodEffects<z.ZodAny, any, any>, CID, any>>;
+    data: z.ZodEffects<z.ZodEffects<z.ZodAny, any, any>, CID, any>;
+}, "strip", z.ZodTypeAny, {
+    data: CID;
+    meta: CID;
+    prev: CID | null;
+    auth_token: CID | null;
+}, {
+    data?: any;
+    meta?: any;
+    prev?: any;
+    auth_token?: any;
+}>;
+export declare type RepoRoot = z.infer<typeof repoRoot>;
+declare const commit: z.ZodObject<{
+    root: z.ZodEffects<z.ZodEffects<z.ZodAny, any, any>, CID, any>;
+    sig: z.ZodType<Uint8Array, z.ZodTypeDef, Uint8Array>;
+}, "strip", z.ZodTypeAny, {
+    root: CID;
+    sig: Uint8Array;
+}, {
+    root?: any;
+    sig: Uint8Array;
+}>;
+export declare type Commit = z.infer<typeof commit>;
+export declare const cidCreateOp: z.ZodObject<{
+    action: z.ZodLiteral<"create">;
+    collection: z.ZodString;
+    rkey: z.ZodString;
+    cid: z.ZodEffects<z.ZodEffects<z.ZodAny, any, any>, CID, any>;
+}, "strip", z.ZodTypeAny, {
+    collection: string;
+    action: "create";
+    rkey: string;
+    cid: CID;
+}, {
+    cid?: any;
+    collection: string;
+    action: "create";
+    rkey: string;
+}>;
+export declare type CidCreateOp = z.infer<typeof cidCreateOp>;
+export declare const cidUpdateOp: z.ZodObject<{
+    action: z.ZodLiteral<"update">;
+    collection: z.ZodString;
+    rkey: z.ZodString;
+    cid: z.ZodEffects<z.ZodEffects<z.ZodAny, any, any>, CID, any>;
+}, "strip", z.ZodTypeAny, {
+    collection: string;
+    action: "update";
+    rkey: string;
+    cid: CID;
+}, {
+    cid?: any;
+    collection: string;
+    action: "update";
+    rkey: string;
+}>;
+export declare type CidUpdateOp = z.infer<typeof cidUpdateOp>;
+export declare const deleteOp: z.ZodObject<{
+    action: z.ZodLiteral<"delete">;
+    collection: z.ZodString;
+    rkey: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    collection: string;
+    action: "delete";
+    rkey: string;
+}, {
+    collection: string;
+    action: "delete";
+    rkey: string;
+}>;
+export declare type DeleteOp = z.infer<typeof deleteOp>;
+export declare const cidWriteOp: z.ZodUnion<[z.ZodObject<{
+    action: z.ZodLiteral<"create">;
+    collection: z.ZodString;
+    rkey: z.ZodString;
+    cid: z.ZodEffects<z.ZodEffects<z.ZodAny, any, any>, CID, any>;
+}, "strip", z.ZodTypeAny, {
+    collection: string;
+    action: "create";
+    rkey: string;
+    cid: CID;
+}, {
+    cid?: any;
+    collection: string;
+    action: "create";
+    rkey: string;
+}>, z.ZodObject<{
+    action: z.ZodLiteral<"update">;
+    collection: z.ZodString;
+    rkey: z.ZodString;
+    cid: z.ZodEffects<z.ZodEffects<z.ZodAny, any, any>, CID, any>;
+}, "strip", z.ZodTypeAny, {
+    collection: string;
+    action: "update";
+    rkey: string;
+    cid: CID;
+}, {
+    cid?: any;
+    collection: string;
+    action: "update";
+    rkey: string;
+}>, z.ZodObject<{
+    action: z.ZodLiteral<"delete">;
+    collection: z.ZodString;
+    rkey: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    collection: string;
+    action: "delete";
+    rkey: string;
+}, {
+    collection: string;
+    action: "delete";
+    rkey: string;
+}>]>;
+export declare type CidWriteOp = z.infer<typeof cidWriteOp>;
+export declare const recordCreateOp: z.ZodObject<{
+    action: z.ZodLiteral<"create">;
+    collection: z.ZodString;
+    rkey: z.ZodString;
+    value: z.ZodAny;
+}, "strip", z.ZodTypeAny, {
+    value?: any;
+    collection: string;
+    action: "create";
+    rkey: string;
+}, {
+    value?: any;
+    collection: string;
+    action: "create";
+    rkey: string;
+}>;
+export declare type RecordCreateOp = z.infer<typeof recordCreateOp>;
+export declare const recordUpdateOp: z.ZodObject<{
+    action: z.ZodLiteral<"update">;
+    collection: z.ZodString;
+    rkey: z.ZodString;
+    value: z.ZodAny;
+}, "strip", z.ZodTypeAny, {
+    value?: any;
+    collection: string;
+    action: "update";
+    rkey: string;
+}, {
+    value?: any;
+    collection: string;
+    action: "update";
+    rkey: string;
+}>;
+export declare type RecordUpdateOp = z.infer<typeof recordUpdateOp>;
+export declare const recordWriteOp: z.ZodUnion<[z.ZodObject<{
+    action: z.ZodLiteral<"create">;
+    collection: z.ZodString;
+    rkey: z.ZodString;
+    value: z.ZodAny;
+}, "strip", z.ZodTypeAny, {
+    value?: any;
+    collection: string;
+    action: "create";
+    rkey: string;
+}, {
+    value?: any;
+    collection: string;
+    action: "create";
+    rkey: string;
+}>, z.ZodObject<{
+    action: z.ZodLiteral<"update">;
+    collection: z.ZodString;
+    rkey: z.ZodString;
+    value: z.ZodAny;
+}, "strip", z.ZodTypeAny, {
+    value?: any;
+    collection: string;
+    action: "update";
+    rkey: string;
+}, {
+    value?: any;
+    collection: string;
+    action: "update";
+    rkey: string;
+}>, z.ZodObject<{
+    action: z.ZodLiteral<"delete">;
+    collection: z.ZodString;
+    rkey: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    collection: string;
+    action: "delete";
+    rkey: string;
+}, {
+    collection: string;
+    action: "delete";
+    rkey: string;
+}>]>;
+export declare type RecordWriteOp = z.infer<typeof recordWriteOp>;
+export declare const def: {
+    repoMeta: z.ZodObject<{
+        did: z.ZodString;
+        version: z.ZodNumber;
+        datastore: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        did: string;
+        version: number;
+        datastore: string;
+    }, {
+        did: string;
+        version: number;
+        datastore: string;
+    }>;
+    repoRoot: z.ZodObject<{
+        meta: z.ZodEffects<z.ZodEffects<z.ZodAny, any, any>, CID, any>;
+        prev: z.ZodNullable<z.ZodEffects<z.ZodEffects<z.ZodAny, any, any>, CID, any>>;
+        auth_token: z.ZodNullable<z.ZodEffects<z.ZodEffects<z.ZodAny, any, any>, CID, any>>;
+        data: z.ZodEffects<z.ZodEffects<z.ZodAny, any, any>, CID, any>;
+    }, "strip", z.ZodTypeAny, {
+        data: CID;
+        meta: CID;
+        prev: CID | null;
+        auth_token: CID | null;
+    }, {
+        data?: any;
+        meta?: any;
+        prev?: any;
+        auth_token?: any;
+    }>;
+    commit: z.ZodObject<{
+        root: z.ZodEffects<z.ZodEffects<z.ZodAny, any, any>, CID, any>;
+        sig: z.ZodType<Uint8Array, z.ZodTypeDef, Uint8Array>;
+    }, "strip", z.ZodTypeAny, {
+        root: CID;
+        sig: Uint8Array;
+    }, {
+        root?: any;
+        sig: Uint8Array;
+    }>;
+    cidWriteOp: z.ZodUnion<[z.ZodObject<{
+        action: z.ZodLiteral<"create">;
+        collection: z.ZodString;
+        rkey: z.ZodString;
+        cid: z.ZodEffects<z.ZodEffects<z.ZodAny, any, any>, CID, any>;
+    }, "strip", z.ZodTypeAny, {
+        collection: string;
+        action: "create";
+        rkey: string;
+        cid: CID;
+    }, {
+        cid?: any;
+        collection: string;
+        action: "create";
+        rkey: string;
+    }>, z.ZodObject<{
+        action: z.ZodLiteral<"update">;
+        collection: z.ZodString;
+        rkey: z.ZodString;
+        cid: z.ZodEffects<z.ZodEffects<z.ZodAny, any, any>, CID, any>;
+    }, "strip", z.ZodTypeAny, {
+        collection: string;
+        action: "update";
+        rkey: string;
+        cid: CID;
+    }, {
+        cid?: any;
+        collection: string;
+        action: "update";
+        rkey: string;
+    }>, z.ZodObject<{
+        action: z.ZodLiteral<"delete">;
+        collection: z.ZodString;
+        rkey: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        collection: string;
+        action: "delete";
+        rkey: string;
+    }, {
+        collection: string;
+        action: "delete";
+        rkey: string;
+    }>]>;
+    recordWriteOp: z.ZodUnion<[z.ZodObject<{
+        action: z.ZodLiteral<"create">;
+        collection: z.ZodString;
+        rkey: z.ZodString;
+        value: z.ZodAny;
+    }, "strip", z.ZodTypeAny, {
+        value?: any;
+        collection: string;
+        action: "create";
+        rkey: string;
+    }, {
+        value?: any;
+        collection: string;
+        action: "create";
+        rkey: string;
+    }>, z.ZodObject<{
+        action: z.ZodLiteral<"update">;
+        collection: z.ZodString;
+        rkey: z.ZodString;
+        value: z.ZodAny;
+    }, "strip", z.ZodTypeAny, {
+        value?: any;
+        collection: string;
+        action: "update";
+        rkey: string;
+    }, {
+        value?: any;
+        collection: string;
+        action: "update";
+        rkey: string;
+    }>, z.ZodObject<{
+        action: z.ZodLiteral<"delete">;
+        collection: z.ZodString;
+        rkey: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        collection: string;
+        action: "delete";
+        rkey: string;
+    }, {
+        collection: string;
+        action: "delete";
+        rkey: string;
+    }>]>;
+    string: z.ZodString;
+    cid: z.ZodEffects<z.ZodEffects<z.ZodAny, any, any>, CID, any>;
+    strToCid: z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, CID, string>;
+    bytes: z.ZodType<Uint8Array, z.ZodTypeDef, Uint8Array>;
+    strToInt: z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, number, string>;
+    strToBool: z.ZodEffects<z.ZodString, boolean, string>;
+};
+export interface CarStreamable {
+    writeToCarStream(car: BlockWriter): Promise<void>;
+}
+export declare type DataValue = {
+    key: string;
+    value: CID;
+};
+export interface DataStore {
+    add(key: string, value: CID): Promise<DataStore>;
+    update(key: string, value: CID): Promise<DataStore>;
+    delete(key: string): Promise<DataStore>;
+    get(key: string): Promise<CID | null>;
+    list(count: number, after?: string, before?: string): Promise<DataValue[]>;
+    listWithPrefix(prefix: string, count?: number): Promise<DataValue[]>;
+    diff(other: DataStore): Promise<DataDiff>;
+    stage(): Promise<CID>;
+    writeToCarStream(car: BlockWriter): Promise<void>;
+}
+export {};

package/dist/src/util.d.ts

@@ -0,0 +1,13 @@
+import { CID } from 'multiformats/cid';
+import * as auth from '@atproto/auth';
+import { DataDiff } from './mst';
+import { IpldStore } from './blockstore';
+import { DataStore, RecordWriteOp } from './types';
+export declare const ucanForOperation: (prevData: DataStore, newData: DataStore, rootDid: string, authStore: auth.AuthStore) => Promise<string>;
+export declare const getCommitPath: (blockstore: IpldStore, earliest: CID | null, latest: CID) => Promise<CID[] | null>;
+export declare const getWriteOpLog: (blockstore: IpldStore, earliest: CID | null, latest: CID) => Promise<RecordWriteOp[][]>;
+export declare const diffToWriteOps: (blockstore: IpldStore, diff: DataDiff) => Promise<RecordWriteOp[]>;
+export declare const parseRecordKey: (key: string) => {
+    collection: string;
+    rkey: string;
+};

package/dist/src/verify.d.ts

@@ -0,0 +1,5 @@
+import { CID } from 'multiformats/cid';
+import * as auth from '@atproto/auth';
+import { IpldStore } from './blockstore';
+import { DataDiff } from './mst';
+export declare const verifyUpdates: (blockstore: IpldStore, earliest: CID | null, latest: CID, verifier: auth.Verifier) => Promise<DataDiff>;

package/dist/storage/index.d.ts

@@ -1 +1,5 @@
+export * from './readable-blockstore';
+export * from './repo-storage';
+export * from './memory-blockstore';
+export * from './sync-storage';
 export * from './types';

package/dist/storage/memory-blockstore.d.ts

@@ -0,0 +1,29 @@
+import { CID } from 'multiformats/cid';
+import { CommitData, RebaseData } from '../types';
+import BlockMap from '../block-map';
+import RepoStorage from './repo-storage';
+export declare class MemoryBlockstore extends RepoStorage {
+    blocks: BlockMap;
+    head: CID | null;
+    constructor(blocks?: BlockMap);
+    getHead(): Promise<CID | null>;
+    getBytes(cid: CID): Promise<Uint8Array | null>;
+    has(cid: CID): Promise<boolean>;
+    getBlocks(cids: CID[]): Promise<{
+        blocks: BlockMap;
+        missing: CID[];
+    }>;
+    putBlock(cid: CID, block: Uint8Array): Promise<void>;
+    putMany(blocks: BlockMap): Promise<void>;
+    indexCommits(commits: CommitData[]): Promise<void>;
+    updateHead(cid: CID, _prev: CID | null): Promise<void>;
+    applyCommit(commit: CommitData): Promise<void>;
+    getCommitPath(latest: CID, earliest: CID | null): Promise<CID[] | null>;
+    getBlocksForCommits(commits: CID[]): Promise<{
+        [commit: string]: BlockMap;
+    }>;
+    applyRebase(rebase: RebaseData): Promise<void>;
+    sizeInBytes(): Promise<number>;
+    destroy(): Promise<void>;
+}
+export default MemoryBlockstore;

package/dist/storage/readable-blockstore.d.ts

@@ -0,0 +1,24 @@
+import { check } from '@atproto/common';
+import { RepoRecord } from '@atproto/lexicon';
+import { CID } from 'multiformats/cid';
+import BlockMap from '../block-map';
+export declare abstract class ReadableBlockstore {
+    abstract getBytes(cid: CID): Promise<Uint8Array | null>;
+    abstract has(cid: CID): Promise<boolean>;
+    abstract getBlocks(cids: CID[]): Promise<{
+        blocks: BlockMap;
+        missing: CID[];
+    }>;
+    attemptRead<T>(cid: CID, def: check.Def<T>): Promise<{
+        obj: T;
+        bytes: Uint8Array;
+    } | null>;
+    readObjAndBytes<T>(cid: CID, def: check.Def<T>): Promise<{
+        obj: T;
+        bytes: Uint8Array;
+    }>;
+    readObj<T>(cid: CID, def: check.Def<T>): Promise<T>;
+    attemptReadRecord(cid: CID): Promise<RepoRecord | null>;
+    readRecord(cid: CID): Promise<RepoRecord>;
+}
+export default ReadableBlockstore;

package/dist/storage/repo-storage.d.ts

@@ -0,0 +1,19 @@
+import { CID } from 'multiformats/cid';
+import BlockMap from '../block-map';
+import { CommitBlockData, CommitData, RebaseData } from '../types';
+import ReadableBlockstore from './readable-blockstore';
+export declare abstract class RepoStorage extends ReadableBlockstore {
+    abstract getHead(forUpdate?: boolean): Promise<CID | null>;
+    abstract getCommitPath(latest: CID, earliest: CID | null): Promise<CID[] | null>;
+    abstract getBlocksForCommits(commits: CID[]): Promise<{
+        [commit: string]: BlockMap;
+    }>;
+    abstract putBlock(cid: CID, block: Uint8Array): Promise<void>;
+    abstract putMany(blocks: BlockMap): Promise<void>;
+    abstract updateHead(cid: CID, prev: CID | null): Promise<void>;
+    abstract indexCommits(commit: CommitData[]): Promise<void>;
+    abstract applyRebase(rebase: RebaseData): Promise<void>;
+    applyCommit(commit: CommitData): Promise<void>;
+    getCommits(latest: CID, earliest: CID | null): Promise<CommitBlockData[] | null>;
+}
+export default RepoStorage;

package/dist/storage/sync-storage.d.ts

@@ -0,0 +1,15 @@
+import { CID } from 'multiformats/cid';
+import BlockMap from '../block-map';
+import ReadableBlockstore from './readable-blockstore';
+export declare class SyncStorage extends ReadableBlockstore {
+    staged: ReadableBlockstore;
+    saved: ReadableBlockstore;
+    constructor(staged: ReadableBlockstore, saved: ReadableBlockstore);
+    getBytes(cid: CID): Promise<Uint8Array | null>;
+    getBlocks(cids: CID[]): Promise<{
+        blocks: BlockMap;
+        missing: CID[];
+    }>;
+    has(cid: CID): Promise<boolean>;
+}
+export default SyncStorage;

package/dist/storage/types.d.ts

@@ -5,8 +5,12 @@ export interface BlobStore {
     putTemp(bytes: Uint8Array | stream.Readable): Promise<string>;
     makePermanent(key: string, cid: CID): Promise<void>;
     putPermanent(cid: CID, bytes: Uint8Array | stream.Readable): Promise<void>;
+    quarantine(cid: CID): Promise<void>;
+    unquarantine(cid: CID): Promise<void>;
     getBytes(cid: CID): Promise<Uint8Array>;
     getStream(cid: CID): Promise<stream.Readable>;
+    hasStored(cid: CID): Promise<boolean>;
+    delete(cid: CID): Promise<void>;
 }
 export declare class BlobNotFoundError extends Error {
 }

package/dist/sync/consumer.d.ts

@@ -0,0 +1,19 @@
+import { CID } from 'multiformats/cid';
+import { RepoStorage } from '../storage';
+import Repo from '../repo';
+import * as verify from '../verify';
+import { RepoContents, WriteLog } from '../types';
+export declare const loadCheckout: (storage: RepoStorage, repoCar: Uint8Array, did: string, signingKey: string) => Promise<{
+    root: CID;
+    contents: RepoContents;
+}>;
+export declare const loadFullRepo: (storage: RepoStorage, repoCar: Uint8Array, did: string, signingKey: string) => Promise<{
+    root: CID;
+    writeLog: WriteLog;
+    repo: Repo;
+}>;
+export declare const loadDiff: (repo: Repo, diffCar: Uint8Array, did: string, signingKey: string) => Promise<{
+    root: CID;
+    writeLog: WriteLog;
+}>;
+export declare const persistUpdates: (storage: RepoStorage, updateStorage: RepoStorage, updates: verify.VerifiedUpdate[]) => Promise<WriteLog>;

package/dist/sync/index.d.ts

@@ -0,0 +1,2 @@
+export * from './consumer';
+export * from './provider';

package/dist/sync/provider.d.ts

@@ -0,0 +1,9 @@
+import { RecordPath } from '../types';
+import { BlockWriter } from '@ipld/car/writer';
+import { CID } from 'multiformats/cid';
+import { RepoStorage } from '../storage';
+export declare const getCheckout: (storage: RepoStorage, commitCid: CID) => AsyncIterable<Uint8Array>;
+export declare const getCommits: (storage: RepoStorage, latest: CID, earliest: CID | null) => AsyncIterable<Uint8Array>;
+export declare const getFullRepo: (storage: RepoStorage, cid: CID) => AsyncIterable<Uint8Array>;
+export declare const writeCommitsToCarStream: (storage: RepoStorage, car: BlockWriter, latest: CID, earliest: CID | null) => Promise<void>;
+export declare const getRecords: (storage: RepoStorage, commitCid: CID, paths: RecordPath[]) => AsyncIterable<Uint8Array>;