baileytownsend.dev
Client side atproto account migrator in your web browser, along with services for backups and adversarial migrations.
pdsmoover.com
pds
atproto
migrations
moo
cow
get ready for release
+1
-1
justfile
+1
-1
justfile
-1
packages/moover/lib/pdsmoover.js
-1
packages/moover/lib/pdsmoover.js
···
48
48
* @param {function|null} statusUpdateHandler
49
49
*/
50
50
async uploadBlobs(oldAgent, newAgent, usersDid, cids, totalBlobs, statusUpdateHandler) {
51
-
console.log('uploading blobs', cids)
52
51
for (const cid of cids) {
53
52
try {
54
53
const blobRes = await oldAgent.com.atproto.sync.getBlob({
+1
-1
packages/moover/package.json
+1
-1
packages/moover/package.json
+10
-10
packages/moover/types/atprotoUtils.d.ts
+10
-10
packages/moover/types/atprotoUtils.d.ts
···
1
-
export const handleResolver: CompositeHandleResolver
2
-
export const docResolver: CompositeDidDocumentResolver<'plc' | 'web'>
1
+
export const handleResolver: CompositeHandleResolver;
2
+
export const docResolver: CompositeDidDocumentResolver<"plc" | "web">;
3
3
/**
4
4
* Cleans the handle of @ and some other unicode characters that used to show up when copied from the profile
5
5
* @param handle {string}
6
6
* @returns {string}
7
7
*/
8
-
export function cleanHandle(handle: string): string
8
+
export function cleanHandle(handle: string): string;
9
9
/**
10
10
* Convince helper to resolve a handle to a did and then find the PDS url from the did document.
11
11
*
···
13
13
* @returns {Promise<{usersDid: string, pds: string}>}
14
14
*/
15
15
export function handleAndPDSResolver(handle: any): Promise<{
16
-
usersDid: string
17
-
pds: string
18
-
}>
16
+
usersDid: string;
17
+
pds: string;
18
+
}>;
19
19
/**
20
20
* Fetches the DID Web from the .well-known/did.json endpoint of the server.
21
21
* Legacy and was helpful if the web ui and server are on the same domain, not as useful now
22
22
* @param baseUrl
23
23
* @returns {Promise<*>}
24
24
*/
25
-
export function fetchPDSMooverDIDWeb(baseUrl: any): Promise<any>
26
-
import { CompositeHandleResolver } from '@atcute/identity-resolver'
27
-
import { CompositeDidDocumentResolver } from '@atcute/identity-resolver'
28
-
//# sourceMappingURL=atprotoUtils.d.ts.map
25
+
export function fetchPDSMooverDIDWeb(baseUrl: any): Promise<any>;
26
+
import { CompositeHandleResolver } from '@atcute/identity-resolver';
27
+
import { CompositeDidDocumentResolver } from '@atcute/identity-resolver';
28
+
//# sourceMappingURL=atprotoUtils.d.ts.map
+1
-1
packages/moover/types/atprotoUtils.d.ts.map
+1
-1
packages/moover/types/atprotoUtils.d.ts.map
···
1
-
{"version":3,"file":"atprotoUtils.d.ts","sourceRoot":"","sources":["../lib/atprotoUtils.js"],"names":[],"mappings":"AAOA,qDAQG;AAEH,sEAKG;AAEH;;;;GAIG;AACH,oCAHkB,MAAM,GACX,MAAM,CAMd;AAGL;;;;;GAKG;AACH,mDAFa,OAAO,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAC,CAAC,CAqBpD;AAGD;;;;;GAKG;AACH,oDAFa,OAAO,CAAC,GAAC,CAAC,CAStB;wCAxEM,2BAA2B;6CAA3B,2BAA2B"}
1
+
{"version":3,"file":"atprotoUtils.d.ts","sourceRoot":"","sources":["../lib/atprotoUtils.js"],"names":[],"mappings":"AASA,qDAQE;AAEF,sEAKE;AAkBF;;;;GAIG;AACH,oCAHkB,MAAM,GACX,MAAM,CAMyC;AAE5D;;;;;GAKG;AACH,mDAFa,OAAO,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAC,CAAC,CA0BpD;AAED;;;;;GAKG;AACH,oDAFa,OAAO,CAAC,GAAC,CAAC,CAStB;wCA3FM,2BAA2B;6CAA3B,2BAA2B"}
+82
-89
packages/moover/types/backup.d.ts
+82
-89
packages/moover/types/backup.d.ts
···
1
1
/**
2
2
* JSDoc type-only import to avoid runtime import errors in the browser.
3
3
*/
4
-
export type InferXRPCBodyOutput = any
4
+
export type InferXRPCBodyOutput = any;
5
5
/**
6
6
* JSDoc type-only import to avoid runtime import errors in the browser.
7
7
* @typedef {import('@atcute/lexicons').InferXRPCBodyOutput} InferXRPCBodyOutput
···
10
10
* Logic to sign up and manage backups for pdsmoover.com (or your own selfhosted instance)
11
11
*/
12
12
export class BackupService {
13
-
/**
14
-
*
15
-
* @param backupDidWeb {string} - The did:web for the xrpc service for backups, defaults to did:web:pdsmoover.com
16
-
*/
17
-
constructor(backupDidWeb?: string)
18
-
/**
19
-
*
20
-
* @type {Client}
21
-
*/
22
-
atCuteClient: Client
23
-
/**
24
-
*
25
-
* @type {CredentialManager}
26
-
*/
27
-
atCuteCredentialManager: CredentialManager
28
-
/**
29
-
* The did:web for the xrpc service for backups, defaults to pdsmoover.com
30
-
* @type {string}
31
-
*/
32
-
backupDidWeb: string
33
-
/**
34
-
* Logs in and returns the backup status.
35
-
* To use the rest of the BackupService, it is assumed that this has ran first,
36
-
* and the user has successfully signed up. A successful login is a returned null if the user has not signed up.
37
-
* or the backup status if they are
38
-
*
39
-
* If the server requires 2FA,
40
-
* it will throw with error.error === 'AuthFactorTokenRequired'.
41
-
* @param identifier {string} handle or did
42
-
* @param password {string}
43
-
* @param {function|null} onStatus - a function that takes a string used to update the UI.
44
-
* Like (status) => console.log(status)
45
-
* @param twoFactorCode {string|null}
46
-
*
47
-
* @returns {Promise<InferXRPCBodyOutput<ComPdsmooverBackupDescribeServer.mainSchema['output']>|null>}
48
-
*/
49
-
loginAndStatus(
50
-
identifier: string,
51
-
password: string,
52
-
onStatus?: Function | null,
53
-
twoFactorCode?: string | null,
54
-
): Promise<InferXRPCBodyOutput<ComPdsmooverBackupDescribeServer.mainSchema['output']> | null>
55
-
/**
56
-
* Signs the user up for backups with the service
57
-
* @param onStatus
58
-
* @returns {Promise<void>}
59
-
*/
60
-
signUp(onStatus?: any): Promise<void>
61
-
/**
62
-
* Requests a PLC token to be sent to the user's email, needed to add a new rotation key
63
-
* @returns {Promise<void>}
64
-
*/
65
-
requestAPlcToken(): Promise<void>
66
-
/**
67
-
* Adds a new rotation to the users did document. Assumes you are already signed in.
68
-
*
69
-
* WARNING: This will overwrite any existing rotation keys with the new one at the top, and the PDS key as the second one
70
-
* @param plcToken {string} - PLC token from the user's email that was sent from requestAPlcToken
71
-
* @param rotationKey {string} - The new rotation key to add to the user's did document
72
-
* @returns {Promise<void>}
73
-
*/
74
-
addANewRotationKey(plcToken: string, rotationKey: string): Promise<void>
75
-
/**
76
-
*
77
-
* Gets the current status of the user's backup repository.
78
-
*
79
-
* @param onStatus {function|null} - a function that takes a string used to update the UI.
80
-
* @returns {Promise<InferXRPCBodyOutput<ComPdsmooverBackupDescribeServer.mainSchema['output']>>}
81
-
*/
82
-
getUsersRepoStatus(
83
-
onStatus?: Function | null,
84
-
): Promise<InferXRPCBodyOutput<ComPdsmooverBackupDescribeServer.mainSchema['output']>>
85
-
/**
86
-
* Requests a backup to be run immediately for the signed-in user. Usually does, depend on the server's backup queue
87
-
* @param onStatus
88
-
* @returns {Promise<boolean>}
89
-
*/
90
-
runBackupNow(onStatus?: any): Promise<boolean>
91
-
/**
92
-
* Remove (delete) the signed-in user's backup repository. this also deletes all the user's backup data.
93
-
* @param onStatus
94
-
* @returns {Promise<boolean>}
95
-
*/
96
-
removeRepo(onStatus?: any): Promise<boolean>
13
+
/**
14
+
*
15
+
* @param backupDidWeb {string} - The did:web for the xrpc service for backups, defaults to did:web:pdsmoover.com
16
+
*/
17
+
constructor(backupDidWeb?: string);
18
+
/**
19
+
*
20
+
* @type {Client}
21
+
*/
22
+
atCuteClient: Client;
23
+
/**
24
+
*
25
+
* @type {CredentialManager}
26
+
*/
27
+
atCuteCredentialManager: CredentialManager;
28
+
/**
29
+
* The did:web for the xrpc service for backups, defaults to pdsmoover.com
30
+
* @type {string}
31
+
*/
32
+
backupDidWeb: string;
33
+
/**
34
+
* Logs in and returns the backup status.
35
+
* To use the rest of the BackupService, it is assumed that this has ran first,
36
+
* and the user has successfully signed up. A successful login is a returned null if the user has not signed up.
37
+
* or the backup status if they are
38
+
*
39
+
* If the server requires 2FA,
40
+
* it will throw with error.error === 'AuthFactorTokenRequired'.
41
+
* @param identifier {string} handle or did
42
+
* @param password {string}
43
+
* @param {function|null} onStatus - a function that takes a string used to update the UI.
44
+
* Like (status) => console.log(status)
45
+
* @param twoFactorCode {string|null}
46
+
*
47
+
* @returns {Promise<InferXRPCBodyOutput<ComPdsmooverBackupDescribeServer.mainSchema['output']>|null>}
48
+
*/
49
+
loginAndStatus(identifier: string, password: string, onStatus?: Function | null, twoFactorCode?: string | null): Promise<InferXRPCBodyOutput<ComPdsmooverBackupDescribeServer.mainSchema["output"]> | null>;
50
+
/**
51
+
* Signs the user up for backups with the service
52
+
* @param onStatus
53
+
* @returns {Promise<void>}
54
+
*/
55
+
signUp(onStatus?: any): Promise<void>;
56
+
/**
57
+
* Requests a PLC token to be sent to the user's email, needed to add a new rotation key
58
+
* @returns {Promise<void>}
59
+
*/
60
+
requestAPlcToken(): Promise<void>;
61
+
/**
62
+
* Adds a new rotation to the users did document. Assumes you are already signed in.
63
+
*
64
+
* WARNING: This will overwrite any existing rotation keys with the new one at the top, and the PDS key as the second one
65
+
* @param plcToken {string} - PLC token from the user's email that was sent from requestAPlcToken
66
+
* @param rotationKey {string} - The new rotation key to add to the user's did document
67
+
* @returns {Promise<void>}
68
+
*/
69
+
addANewRotationKey(plcToken: string, rotationKey: string): Promise<void>;
70
+
/**
71
+
*
72
+
* Gets the current status of the user's backup repository.
73
+
*
74
+
* @param onStatus {function|null} - a function that takes a string used to update the UI.
75
+
* @returns {Promise<InferXRPCBodyOutput<ComPdsmooverBackupDescribeServer.mainSchema['output']>>}
76
+
*/
77
+
getUsersRepoStatus(onStatus?: Function | null): Promise<InferXRPCBodyOutput<ComPdsmooverBackupDescribeServer.mainSchema["output"]>>;
78
+
/**
79
+
* Requests a backup to be run immediately for the signed-in user. Usually does, depend on the server's backup queue
80
+
* @param onStatus
81
+
* @returns {Promise<boolean>}
82
+
*/
83
+
runBackupNow(onStatus?: any): Promise<boolean>;
84
+
/**
85
+
* Remove (delete) the signed-in user's backup repository. this also deletes all the user's backup data.
86
+
* @param onStatus
87
+
* @returns {Promise<boolean>}
88
+
*/
89
+
removeRepo(onStatus?: any): Promise<boolean>;
97
90
}
98
-
import { Client } from '@atcute/client'
99
-
import { CredentialManager } from '@atcute/client'
100
-
import { ComPdsmooverBackupDescribeServer } from '@pds-moover/lexicons'
101
-
//# sourceMappingURL=backup.d.ts.map
91
+
import { Client } from '@atcute/client';
92
+
import { CredentialManager } from '@atcute/client';
93
+
import { ComPdsmooverBackupDescribeServer } from '@pds-moover/lexicons';
94
+
//# sourceMappingURL=backup.d.ts.map
+1
-1
packages/moover/types/backup.d.ts.map
+1
-1
packages/moover/types/backup.d.ts.map
···
1
-
{"version":3,"file":"backup.d.ts","sourceRoot":"","sources":["../lib/backup.js"],"names":[],"mappings":";;;;AAKA;;;GAGG;AAGH;;GAEG;AACH;IACI;;;OAGG;IACH,2BAFwB,MAAM,EAmB7B;IAhBG;;;OAGG;IACH,cAFU,MAAM,CAEQ;IACxB;;;OAGG;IACH,yBAFU,iBAAiB,CAEQ;IAEnC;;;OAGG;IACH,cAFU,MAAM,CAEgB;IAIpC;;;;;;;;;;;;;;;OAeG;IACH,2BARsB,MAAM,YACR,MAAM,aACf,WAAS,IAAI,kBAEC,MAAM,GAAC,IAAI,GAEvB,OAAO,CAAC,mBAAmB,CAAC,gCAAgC,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,GAAC,IAAI,CAAC,CAyDpG;IAED;;;;OAIG;IACH,wBAFa,OAAO,CAAC,IAAI,CAAC,CAczB;IAED;;;OAGG;IACH,oBAFa,OAAO,CAAC,IAAI,CAAC,CAgBzB;IAED;;;;;;;OAOG;IACH,6BAJoB,MAAM,eACH,MAAM,GAChB,OAAO,CAAC,IAAI,CAAC,CAgDzB;IAGD;;;;;;OAMG;IACH,8BAHoB,WAAS,IAAI,GACpB,OAAO,CAAC,mBAAmB,CAAC,gCAAgC,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAe/F;IAED;;;;OAIG;IACH,8BAFa,OAAO,CAAC,OAAO,CAAC,CAkB5B;IAED;;;;OAIG;IACH,4BAFa,OAAO,CAAC,OAAO,CAAC,CAe5B;CACJ;uBAhR2C,gBAAgB;kCAAhB,gBAAgB;iDAGb,sBAAsB"}
1
+
{"version":3,"file":"backup.d.ts","sourceRoot":"","sources":["../lib/backup.js"],"names":[],"mappings":";;;;AAKA;;;GAGG;AAEH;;GAEG;AACH;IACE;;;OAGG;IACH,2BAFwB,MAAM,EAmB7B;IAhBC;;;OAGG;IACH,cAFU,MAAM,CAEQ;IACxB;;;OAGG;IACH,yBAFU,iBAAiB,CAEQ;IAEnC;;;OAGG;IACH,cAFU,MAAM,CAEgB;IAGlC;;;;;;;;;;;;;;;OAeG;IACH,2BARsB,MAAM,YACR,MAAM,aACf,WAAS,IAAI,kBAEC,MAAM,GAAC,IAAI,GAEvB,OAAO,CAAC,mBAAmB,CAAC,gCAAgC,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,GAAC,IAAI,CAAC,CAoDpG;IAED;;;;OAIG;IACH,wBAFa,OAAO,CAAC,IAAI,CAAC,CAczB;IAED;;;OAGG;IACH,oBAFa,OAAO,CAAC,IAAI,CAAC,CAgBzB;IAED;;;;;;;OAOG;IACH,6BAJoB,MAAM,eACH,MAAM,GAChB,OAAO,CAAC,IAAI,CAAC,CA4CzB;IAED;;;;;;OAMG;IACH,8BAHoB,WAAS,IAAI,GACpB,OAAO,CAAC,mBAAmB,CAAC,gCAAgC,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAe/F;IAED;;;;OAIG;IACH,8BAFa,OAAO,CAAC,OAAO,CAAC,CAwB5B;IAED;;;;OAIG;IACH,4BAFa,OAAO,CAAC,OAAO,CAAC,CAkB5B;CACF;uBA7Q6C,gBAAgB;kCAAhB,gBAAgB;iDAGb,sBAAsB"}
+8
-8
packages/moover/types/main.d.ts
+8
-8
packages/moover/types/main.d.ts
···
1
-
import { Migrator } from './pdsmoover.js'
2
-
import { MissingBlobs } from './missingBlobs.js'
3
-
import { BackupService } from './backup.js'
4
-
import { PlcOps } from './plc-ops.js'
5
-
import { Restore } from './restore.js'
6
-
import { handleAndPDSResolver } from './atprotoUtils.js'
7
-
export { Migrator, MissingBlobs, BackupService, PlcOps, Restore, handleAndPDSResolver }
8
-
//# sourceMappingURL=main.d.ts.map
1
+
import { Migrator } from './pdsmoover.js';
2
+
import { MissingBlobs } from './missingBlobs.js';
3
+
import { BackupService } from './backup.js';
4
+
import { PlcOps } from './plc-ops.js';
5
+
import { Restore } from './restore.js';
6
+
import { handleAndPDSResolver } from './atprotoUtils.js';
7
+
export { Migrator, MissingBlobs, BackupService, PlcOps, Restore, handleAndPDSResolver };
8
+
//# sourceMappingURL=main.d.ts.map
+1
-1
packages/moover/types/main.d.ts.map
+1
-1
packages/moover/types/main.d.ts.map
···
1
-
{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../lib/main.js"],"names":[],"mappings":"yBAAuB,gBAAgB;6BACZ,mBAAmB;8BAClB,aAAa;uBACpB,cAAc;wBACb,cAAc;qCACD,mBAAmB"}
1
+
{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../lib/main.js"],"names":[],"mappings":"yBAAyB,gBAAgB;6BACZ,mBAAmB;8BAClB,aAAa;uBACpB,cAAc;wBACb,cAAc;qCACD,mBAAmB"}
+57
-65
packages/moover/types/missingBlobs.d.ts
+57
-65
packages/moover/types/missingBlobs.d.ts
···
2
2
* Class to help find missing blobs from the did's previous PDS and import them into the current PDS
3
3
*/
4
4
export class MissingBlobs {
5
-
/**
6
-
* The user's current PDS agent
7
-
* @type {AtpAgent}
8
-
*/
9
-
currentPdsAgent: AtpAgent
10
-
/**
11
-
* The user's old PDS agent
12
-
* @type {AtpAgent}
13
-
*/
14
-
oldPdsAgent: AtpAgent
15
-
/**
16
-
* the user's did
17
-
* @type {string|null}
18
-
*/
19
-
did: string | null
20
-
/**
21
-
* The user's current PDS url
22
-
* @type {null}
23
-
*/
24
-
currentPdsUrl: any
25
-
/**
26
-
* A list of the missing cids blobs from the old PDS. In this case if a retry upload fails it gets put in this array for the ui
27
-
* @type {string[]}
28
-
*/
29
-
missingBlobs: string[]
30
-
/**
31
-
* Logs the user into the current PDS and gets the account status
32
-
* @param handle {string}
33
-
* @param password {string}
34
-
* @param twoFactorCode {string|null}
35
-
* @returns {Promise<{accountStatus: OutputSchema, missingBlobsCount: number}>}
36
-
*/
37
-
currentAgentLogin(
38
-
handle: string,
39
-
password: string,
40
-
twoFactorCode?: string | null,
41
-
): Promise<{
42
-
accountStatus: OutputSchema
43
-
missingBlobsCount: number
44
-
}>
45
-
/**
46
-
* Logs into the old PDS and gets the account status.
47
-
* Does not need a handle
48
-
* since it is assumed the user has already logged in with the current PDS and we are using their did
49
-
* @param password {string}
50
-
* @param twoFactorCode {string|null}
51
-
* @param pdsUrl {string|null} - If you know the url of the old PDS you can pass it in here. If not it will be guessed at from plc ops
52
-
* @returns {Promise<void>}
53
-
*/
54
-
oldAgentLogin(
55
-
password: string,
56
-
twoFactorCode?: string | null,
57
-
pdsUrl?: string | null,
58
-
): Promise<void>
59
-
/**
60
-
* Gets the missing blobs from the old PDS and uploads them to the current PDS
61
-
* @param statusUpdateHandler {function} - A function to update the status of the migration. This is useful for showing the user the progress of the migration
62
-
* @returns {Promise<{accountStatus: OutputSchema, missingBlobsCount: number}>}
63
-
*/
64
-
migrateMissingBlobs(statusUpdateHandler: Function): Promise<{
65
-
accountStatus: OutputSchema
66
-
missingBlobsCount: number
67
-
}>
5
+
/**
6
+
* The user's current PDS agent
7
+
* @type {AtpAgent}
8
+
*/
9
+
currentPdsAgent: AtpAgent;
10
+
/**
11
+
* The user's old PDS agent
12
+
* @type {AtpAgent}
13
+
*/
14
+
oldPdsAgent: AtpAgent;
15
+
/**
16
+
* the user's did
17
+
* @type {string|null}
18
+
*/
19
+
did: string | null;
20
+
/**
21
+
* The user's current PDS url
22
+
* @type {null}
23
+
*/
24
+
currentPdsUrl: any;
25
+
/**
26
+
* A list of the missing cids blobs from the old PDS. In this case if a retry upload fails it gets put in this array for the ui
27
+
* @type {string[]}
28
+
*/
29
+
missingBlobs: string[];
30
+
/**
31
+
* Logs the user into the current PDS and gets the account status
32
+
* @param handle {string}
33
+
* @param password {string}
34
+
* @param twoFactorCode {string|null}
35
+
* @returns {Promise<{accountStatus: OutputSchema, missingBlobsCount: number}>}
36
+
*/
37
+
currentAgentLogin(handle: string, password: string, twoFactorCode?: string | null): Promise<{
38
+
accountStatus: OutputSchema;
39
+
missingBlobsCount: number;
40
+
}>;
41
+
/**
42
+
* Logs into the old PDS and gets the account status.
43
+
* Does not need a handle
44
+
* since it is assumed the user has already logged in with the current PDS and we are using their did
45
+
* @param password {string}
46
+
* @param twoFactorCode {string|null}
47
+
* @param pdsUrl {string|null} - If you know the url of the old PDS you can pass it in here. If not it will be guessed at from plc ops
48
+
* @returns {Promise<void>}
49
+
*/
50
+
oldAgentLogin(password: string, twoFactorCode?: string | null, pdsUrl?: string | null): Promise<void>;
51
+
/**
52
+
* Gets the missing blobs from the old PDS and uploads them to the current PDS
53
+
* @param statusUpdateHandler {function} - A function to update the status of the migration. This is useful for showing the user the progress of the migration
54
+
* @returns {Promise<{accountStatus: OutputSchema, missingBlobsCount: number}>}
55
+
*/
56
+
migrateMissingBlobs(statusUpdateHandler: Function): Promise<{
57
+
accountStatus: OutputSchema;
58
+
missingBlobsCount: number;
59
+
}>;
68
60
}
69
-
import { AtpAgent } from '@atproto/api'
70
-
//# sourceMappingURL=missingBlobs.d.ts.map
61
+
import { AtpAgent } from '@atproto/api';
62
+
//# sourceMappingURL=missingBlobs.d.ts.map
+1
-1
packages/moover/types/missingBlobs.d.ts.map
+1
-1
packages/moover/types/missingBlobs.d.ts.map
···
1
-
{"version":3,"file":"missingBlobs.d.ts","sourceRoot":"","sources":["../lib/missingBlobs.js"],"names":[],"mappings":"AAIA;;GAEG;AACH;IAGQ;;;OAGG;IACH,iBAFU,QAAQ,CAES;IAC3B;;;OAGG;IACH,aAFU,QAAQ,CAEK;IACvB;;;OAGG;IACH,KAFU,MAAM,GAAC,IAAI,CAEN;IACf;;;OAGG;IACH,mBAAyB;IACzB;;;OAGG;IACH,cAFU,MAAM,EAAE,CAEI;IAI1B;;;;;;OAMG;IACH,0BALkB,MAAM,YACJ,MAAM,kBACD,MAAM,GAAC,IAAI,GACvB,OAAO,CAAC;QAAC,aAAa,EAAE,YAAY,CAAC;QAAC,iBAAiB,EAAE,MAAM,CAAA;KAAC,CAAC,CA2B7E;IAED;;;;;;;;OAQG;IACH,wBALoB,MAAM,kBACD,MAAM,GAAC,IAAI,WAClB,MAAM,GAAC,IAAI,GAChB,OAAO,CAAC,IAAI,CAAC,CA+CzB;IAED;;;;OAIG;IACH,oDAFa,OAAO,CAAC;QAAC,aAAa,EAAE,YAAY,CAAC;QAAC,iBAAiB,EAAE,MAAM,CAAA;KAAC,CAAC,CAyD7E;CAEJ;yBA9LsB,cAAc"}
1
+
{"version":3,"file":"missingBlobs.d.ts","sourceRoot":"","sources":["../lib/missingBlobs.js"],"names":[],"mappings":"AAGA;;GAEG;AACH;IAEI;;;OAGG;IACH,iBAFU,QAAQ,CAES;IAC3B;;;OAGG;IACH,aAFU,QAAQ,CAEK;IACvB;;;OAGG;IACH,KAFU,MAAM,GAAC,IAAI,CAEN;IACf;;;OAGG;IACH,mBAAyB;IACzB;;;OAGG;IACH,cAFU,MAAM,EAAE,CAEI;IAGxB;;;;;;OAMG;IACH,0BALkB,MAAM,YACJ,MAAM,kBACD,MAAM,GAAC,IAAI,GACvB,OAAO,CAAC;QAAC,aAAa,EAAE,YAAY,CAAC;QAAC,iBAAiB,EAAE,MAAM,CAAA;KAAC,CAAC,CA2B7E;IAED;;;;;;;;OAQG;IACH,wBALoB,MAAM,kBACD,MAAM,GAAC,IAAI,WAClB,MAAM,GAAC,IAAI,GAChB,OAAO,CAAC,IAAI,CAAC,CA+CzB;IAED;;;;OAIG;IACH,oDAFa,OAAO,CAAC;QAAC,aAAa,EAAE,YAAY,CAAC;QAAC,iBAAiB,EAAE,MAAM,CAAA;KAAC,CAAC,CAyD7E;CACF;yBA1LwB,cAAc"}
+78
-79
packages/moover/types/pdsmoover.d.ts
+78
-79
packages/moover/types/pdsmoover.d.ts
···
3
3
* On pdsmoover.com this is the logic for the MOOver
4
4
*/
5
5
export class Migrator {
6
-
/** @type {AtpAgent} */
7
-
oldAgent: AtpAgent
8
-
/** @type {AtpAgent} */
9
-
newAgent: AtpAgent
10
-
/** @type {[string]} */
11
-
missingBlobs: [string]
12
-
/** @type {boolean} */
13
-
createNewAccount: boolean
14
-
/** @type {boolean} */
15
-
migrateRepo: boolean
16
-
/** @type {boolean} */
17
-
migrateBlobs: boolean
18
-
/** @type {boolean} */
19
-
migrateMissingBlobs: boolean
20
-
/** @type {boolean} */
21
-
migratePrefs: boolean
22
-
/** @type {boolean} */
23
-
migratePlcRecord: boolean
24
-
/**
25
-
* This migrator is pretty cut and dry and makes a few assumptions
26
-
* 1. You are using the same password between each account
27
-
* 2. If this command fails for something like oauth 2fa code it throws an error and expects the same values when ran again.
28
-
* 3. You can control which "actions" happen by setting the class variables to false.
29
-
* 4. Each instance of the class is assumed to be for a single migration
30
-
* @param {string} oldHandle - The handle you use on your old pds, something like alice.bsky.social
31
-
* @param {string} password - Your password for your current login. Has to be your real password, no app password. When setting up a new account we reuse it as well for that account
32
-
* @param {string} newPdsUrl - The new URL for your pds. Like https://coolnewpds.com
33
-
* @param {string} newEmail - The email you want to use on the new pds (can be the same as the previous one as long as it's not already being used on the new pds)
34
-
* @param {string} newHandle - The new handle you want, like alice.bsky.social, or if you already have a domain name set as a handle can use it myname.com.
35
-
* @param {string|null} inviteCode - The invite code you got from the PDS you are migrating to. If null does not include one
36
-
* @param {function|null} statusUpdateHandler - a function that takes a string used to update the UI. Like (status) => console.log(status)
37
-
* @param {string|null} twoFactorCode - Optional, but needed if it fails with 2fa required
38
-
* @param verificationCode - Optional verification captcha code for account creation if the PDS requires it
39
-
*/
40
-
migrate(
41
-
oldHandle: string,
42
-
password: string,
43
-
newPdsUrl: string,
44
-
newEmail: string,
45
-
newHandle: string,
46
-
inviteCode: string | null,
47
-
statusUpdateHandler?: Function | null,
48
-
twoFactorCode?: string | null,
49
-
verificationCode?: any,
50
-
): Promise<void>
51
-
/**
52
-
* Sign and submits the PLC operation to officially migrate the account
53
-
* @param {string} token - the PLC token sent in the email. If you're just wanting to run this rerun migrate with all the flags set as false except for migratePlcRecord
54
-
* @param additionalRotationKeysToAdd {string[]} - additional rotation keys to add in addition to the ones provided by the new PDS.
55
-
* @returns {Promise<void>}
56
-
*/
57
-
signPlcOperation(token: string, additionalRotationKeysToAdd?: string[]): Promise<void>
58
-
/**
59
-
* Using this method assumes the Migrator class was constructed new and this was called.
60
-
* Find the user's previous PDS from the PLC op logs,
61
-
* logs in and deactivates their old account if it was found still active.
62
-
*
63
-
* @param oldHandle {string}
64
-
* @param oldPassword {string}
65
-
* @param {function|null} statusUpdateHandler - a function that takes a string used to update the UI.
66
-
* Like (status) => console.log(status)
67
-
* @param {string|null} twoFactorCode - Optional, but needed if it fails with 2fa required
68
-
* @returns {Promise<void>}
69
-
*/
70
-
deactivateOldAccount(
71
-
oldHandle: string,
72
-
oldPassword: string,
73
-
statusUpdateHandler?: Function | null,
74
-
twoFactorCode?: string | null,
75
-
): Promise<void>
76
-
/**
77
-
* Signs the logged-in user in this.newAgent for backups with PDS MOOver. This is usually called after migrate and signPlcOperation are successful
78
-
*
79
-
* @param {string} didWeb
80
-
* @returns {Promise<void>}
81
-
*/
82
-
signUpForBackupsFromMigration(didWeb?: string): Promise<void>
6
+
/** @type {AtpAgent} */
7
+
oldAgent: AtpAgent;
8
+
/** @type {AtpAgent} */
9
+
newAgent: AtpAgent;
10
+
/** @type {[string]} */
11
+
missingBlobs: [string];
12
+
/** @type {boolean} */
13
+
createNewAccount: boolean;
14
+
/** @type {boolean} */
15
+
migrateRepo: boolean;
16
+
/** @type {boolean} */
17
+
migrateBlobs: boolean;
18
+
/** @type {boolean} */
19
+
migrateMissingBlobs: boolean;
20
+
/** @type {boolean} */
21
+
migratePrefs: boolean;
22
+
/** @type {boolean} */
23
+
migratePlcRecord: boolean;
24
+
/**
25
+
* How many blobs have been uploaded to the new PDS in the current step
26
+
@type {number} */
27
+
uploadedBlobsCount: number;
28
+
/**
29
+
* Uploads blobs to the new PDS
30
+
* @param {AtpAgent} oldAgent
31
+
* @param {AtpAgent} newAgent
32
+
* @param {string} usersDid
33
+
* @param {[string]} cids
34
+
* @param {number} totalBlobs
35
+
* @param {function|null} statusUpdateHandler
36
+
*/
37
+
uploadBlobs(oldAgent: AtpAgent, newAgent: AtpAgent, usersDid: string, cids: [string], totalBlobs: number, statusUpdateHandler: Function | null): Promise<void>;
38
+
/**
39
+
* This migrator is pretty cut and dry and makes a few assumptions
40
+
* 1. You are using the same password between each account
41
+
* 2. If this command fails for something like oauth 2fa code it throws an error and expects the same values when ran again.
42
+
* 3. You can control which "actions" happen by setting the class variables to false.
43
+
* 4. Each instance of the class is assumed to be for a single migration
44
+
* @param {string} oldHandle - The handle you use on your old pds, something like alice.bsky.social
45
+
* @param {string} password - Your password for your current login. Has to be your real password, no app password. When setting up a new account we reuse it as well for that account
46
+
* @param {string} newPdsUrl - The new URL for your pds. Like https://coolnewpds.com
47
+
* @param {string} newEmail - The email you want to use on the new pds (can be the same as the previous one as long as it's not already being used on the new pds)
48
+
* @param {string} newHandle - The new handle you want, like alice.bsky.social, or if you already have a domain name set as a handle can use it myname.com.
49
+
* @param {string|null} inviteCode - The invite code you got from the PDS you are migrating to. If null does not include one
50
+
* @param {function|null} statusUpdateHandler - a function that takes a string used to update the UI. Like (status) => console.log(status)
51
+
* @param {string|null} twoFactorCode - Optional, but needed if it fails with 2fa required
52
+
* @param verificationCode - Optional verification captcha code for account creation if the PDS requires it
53
+
*/
54
+
migrate(oldHandle: string, password: string, newPdsUrl: string, newEmail: string, newHandle: string, inviteCode: string | null, statusUpdateHandler?: Function | null, twoFactorCode?: string | null, verificationCode?: any): Promise<void>;
55
+
/**
56
+
* Sign and submits the PLC operation to officially migrate the account
57
+
* @param {string} token - the PLC token sent in the email. If you're just wanting to run this rerun migrate with all the flags set as false except for migratePlcRecord
58
+
* @param additionalRotationKeysToAdd {string[]} - additional rotation keys to add in addition to the ones provided by the new PDS.
59
+
* @returns {Promise<void>}
60
+
*/
61
+
signPlcOperation(token: string, additionalRotationKeysToAdd?: string[]): Promise<void>;
62
+
/**
63
+
* Using this method assumes the Migrator class was constructed new and this was called.
64
+
* Find the user's previous PDS from the PLC op logs,
65
+
* logs in and deactivates their old account if it was found still active.
66
+
*
67
+
* @param oldHandle {string}
68
+
* @param oldPassword {string}
69
+
* @param {function|null} statusUpdateHandler - a function that takes a string used to update the UI.
70
+
* Like (status) => console.log(status)
71
+
* @param {string|null} twoFactorCode - Optional, but needed if it fails with 2fa required
72
+
* @returns {Promise<void>}
73
+
*/
74
+
deactivateOldAccount(oldHandle: string, oldPassword: string, statusUpdateHandler?: Function | null, twoFactorCode?: string | null): Promise<void>;
75
+
/**
76
+
* Signs the logged-in user in this.newAgent for backups with PDS MOOver. This is usually called after migrate and signPlcOperation are successful
77
+
*
78
+
* @param {string} didWeb
79
+
* @returns {Promise<void>}
80
+
*/
81
+
signUpForBackupsFromMigration(didWeb?: string): Promise<void>;
83
82
}
84
-
import { AtpAgent } from '@atproto/api'
85
-
//# sourceMappingURL=pdsmoover.d.ts.map
83
+
import { AtpAgent } from '@atproto/api';
84
+
//# sourceMappingURL=pdsmoover.d.ts.map
+1
-1
packages/moover/types/pdsmoover.d.ts.map
+1
-1
packages/moover/types/pdsmoover.d.ts.map
···
1
-
{"version":3,"file":"pdsmoover.d.ts","sourceRoot":"","sources":["../lib/pdsmoover.js"],"names":[],"mappings":"AAUA;;;GAGG;AACH;IAEQ,uBAAuB;IACvB,UADW,QAAQ,CACC;IACpB,uBAAuB;IACvB,UADW,QAAQ,CACC;IACpB,uBAAuB;IACvB,cADW,CAAC,MAAM,CAAC,CACG;IAEtB,sBAAsB;IACtB,kBADW,OAAO,CACU;IAC5B,sBAAsB;IACtB,aADW,OAAO,CACK;IACvB,sBAAsB;IACtB,cADW,OAAO,CACM;IACxB,sBAAsB;IACtB,qBADW,OAAO,CACa;IAC/B,sBAAsB;IACtB,cADW,OAAO,CACM;IACxB,sBAAsB;IACtB,kBADW,OAAO,CACU;IAGhC;;;;;;;;;;;;;;;OAeG;IACH,mBAVW,MAAM,YACN,MAAM,aACN,MAAM,YACN,MAAM,aACN,MAAM,cACN,MAAM,GAAC,IAAI,wBACX,WAAS,IAAI,kBACb,MAAM,GAAC,IAAI,yCA2LrB;IAED;;;;;OAKG;IACH,wBAJW,MAAM,gCACsB,MAAM,EAAE,GAClC,OAAO,CAAC,IAAI,CAAC,CA4BzB;IAED;;;;;;;;;;;OAWG;IACH,gCAPqB,MAAM,eACJ,MAAM,wBAClB,WAAS,IAAI,kBAEb,MAAM,GAAC,IAAI,GACT,OAAO,CAAC,IAAI,CAAC,CAiEzB;IAED;;;;;OAKG;IACH,uCAHW,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAkCzB;CACJ;yBApYsB,cAAc"}
1
+
{"version":3,"file":"pdsmoover.d.ts","sourceRoot":"","sources":["../lib/pdsmoover.js"],"names":[],"mappings":"AASA;;;GAGG;AACH;IAEI,uBAAuB;IACvB,UADW,QAAQ,CACC;IACpB,uBAAuB;IACvB,UADW,QAAQ,CACC;IACpB,uBAAuB;IACvB,cADW,CAAC,MAAM,CAAC,CACG;IAEtB,sBAAsB;IACtB,kBADW,OAAO,CACU;IAC5B,sBAAsB;IACtB,aADW,OAAO,CACK;IACvB,sBAAsB;IACtB,cADW,OAAO,CACM;IACxB,sBAAsB;IACtB,qBADW,OAAO,CACa;IAC/B,sBAAsB;IACtB,cADW,OAAO,CACM;IACxB,sBAAsB;IACtB,kBADW,OAAO,CACU;IAC5B;;sBAEkB;IAClB,oBADQ,MAAM,CACa;IAG7B;;;;;;;;OAQG;IACH,sBAPW,QAAQ,YACR,QAAQ,YACR,MAAM,QACN,CAAC,MAAM,CAAC,cACR,MAAM,uBACN,WAAS,IAAI,iBAuBvB;IAED;;;;;;;;;;;;;;;OAeG;IACH,mBAVW,MAAM,YACN,MAAM,aACN,MAAM,YACN,MAAM,aACN,MAAM,cACN,MAAM,GAAC,IAAI,wBACX,WAAS,IAAI,kBACb,MAAM,GAAC,IAAI,yCA+MrB;IAED;;;;;OAKG;IACH,wBAJW,MAAM,gCACsB,MAAM,EAAE,GAClC,OAAO,CAAC,IAAI,CAAC,CA2BzB;IAED;;;;;;;;;;;OAWG;IACH,gCAPqB,MAAM,eACJ,MAAM,wBAClB,WAAS,IAAI,kBAEb,MAAM,GAAC,IAAI,GACT,OAAO,CAAC,IAAI,CAAC,CA+EzB;IAED;;;;;OAKG;IACH,uCAHW,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAkCzB;CACF;yBAxcwB,cAAc"}
+98
-109
packages/moover/types/plc-ops.d.ts
+98
-109
packages/moover/types/plc-ops.d.ts
···
1
1
/**
2
2
* JSDoc type-only import to avoid runtime import errors in the browser.
3
3
*/
4
-
export type defs = typeof defs
4
+
export type defs = typeof defs;
5
5
/**
6
6
* JSDoc type-only import to avoid runtime import errors in the browser.
7
7
*/
8
-
export type normalizeOp = any
8
+
export type normalizeOp = any;
9
9
/**
10
10
* JSDoc type-only import to avoid runtime import errors in the browser.
11
11
*/
12
-
export type Operation = import('@atcute/did-plc').Operation
12
+
export type Operation = import("@atcute/did-plc").Operation;
13
13
/**
14
14
* JSDoc type-only import to avoid runtime import errors in the browser.
15
15
*/
16
-
export type CompatibleOperation = import('@atcute/did-plc').CompatibleOperation
16
+
export type CompatibleOperation = import("@atcute/did-plc").CompatibleOperation;
17
17
/**
18
18
* JSDoc type-only import to avoid runtime import errors in the browser.
19
19
*/
20
-
export type IndexedEntryLog = import('@atcute/did-plc').IndexedEntryLog
20
+
export type IndexedEntryLog = import("@atcute/did-plc").IndexedEntryLog;
21
21
/**
22
22
* JSDoc type-only import to avoid runtime import errors in the browser.
23
23
*/
24
-
export type IndexedEntry = import('@atcute/did-plc').IndexedEntry
24
+
export type IndexedEntry = import("@atcute/did-plc").IndexedEntry;
25
25
/**
26
26
* Class to help with various PLC operations
27
27
*/
28
28
export class PlcOps {
29
-
/**
30
-
*
31
-
* @param plcDirectoryUrl {string} - The url of the plc directory, defaults to https://plc.directory
32
-
*/
33
-
constructor(plcDirectoryUrl?: string)
34
-
/**
35
-
* The url of the plc directory
36
-
* @type {string}
37
-
*/
38
-
plcDirectoryUrl: string
39
-
/**
40
-
* Gets the current rotation keys for a user via their last PlC operation
41
-
* @param did
42
-
* @returns {Promise<string[]>}
43
-
*/
44
-
getCurrentRotationKeysForUser(did: any): Promise<string[]>
45
-
/**
46
-
* Gets the last PlC operation for a user from the plc directory
47
-
* @param did
48
-
* @returns {Promise<{lastOperation: Operation, base: any}>}
49
-
*/
50
-
getLastPlcOpFromPlc(did: any): Promise<{
51
-
lastOperation: Operation
52
-
base: any
53
-
}>
54
-
/**
55
-
*
56
-
* @param logs {IndexedEntryLog}
57
-
* @returns {{lastOperation: Operation, base: IndexedEntry}}
58
-
*/
59
-
getLastPlcOp(logs: IndexedEntryLog): {
60
-
lastOperation: Operation
61
-
base: IndexedEntry
62
-
}
63
-
/**
64
-
* Gets the plc audit logs for a user from the plc directory
65
-
* @param did
66
-
* @returns {Promise<IndexedEntryLog>}
67
-
*/
68
-
getPlcAuditLogs(did: any): Promise<IndexedEntryLog>
69
-
/**
70
-
* Creates a new secp256k1 key that can be used for either rotation or verification key
71
-
* @returns {Promise<{privateKey: string, publicKey: `did:key:${string}`}>}
72
-
*/
73
-
createANewSecp256k1(): Promise<{
74
-
privateKey: string
75
-
publicKey: `did:key:${string}`
76
-
}>
77
-
/**
78
-
* Signs a new operation with the provided signing key, and information and submits it to the plc directory
79
-
* @param did {string} - The user's did
80
-
* @param signingRotationKey { P256PrivateKey|Secp256k1PrivateKey} - The keypair to sign the op with
81
-
* @param alsoKnownAs {string[]}
82
-
* @param rotationKeys {string[]}
83
-
* @param pds {string}
84
-
* @param verificationKey {string} - The public verification key
85
-
* @param prev {string} - The previous valid operation's cid.
86
-
* @returns {Promise<void>}
87
-
*/
88
-
signAndPublishNewOp(
89
-
did: string,
90
-
signingRotationKey: P256PrivateKey | Secp256k1PrivateKey,
91
-
alsoKnownAs: string[],
92
-
rotationKeys: string[],
93
-
pds: string,
94
-
verificationKey: string,
95
-
prev: string,
96
-
): Promise<void>
97
-
/**
98
-
* Takes a multi or hex based private key and returns a keypair
99
-
* @param privateKeyString {string}
100
-
* @param type {string} - secp256k1 or p256, needed if the private key is hex based, can be assumed if it's a multikey
101
-
* @returns {Promise<{type: string, didPublicKey: `did:key:${string}`, keypair: P256PrivateKey|Secp256k1PrivateKey}>}
102
-
*/
103
-
getKeyPair(
104
-
privateKeyString: string,
105
-
type?: string,
106
-
): Promise<{
107
-
type: string
108
-
didPublicKey: `did:key:${string}`
109
-
keypair: P256PrivateKey | Secp256k1PrivateKey
110
-
}>
111
-
/**
112
-
* Submits a new operation to the plc directory
113
-
* @param did {string} - The user's did
114
-
* @param operation
115
-
* @returns {Promise<void>}
116
-
*/
117
-
pushPlcOperation(did: string, operation: any): Promise<void>
118
-
/**
119
-
* Creates a new service auth token for a user. This is what is used to create a new account on a PDS for your did
120
-
*
121
-
* @param iss The user's did
122
-
* @param aud The did:web, if it's a PDS it's usually from /xrpc/com.atproto.server.describeServer
123
-
* @param keypair The keypair to sign with only supporting ES256K atm
124
-
* @param lxm The lxm which is usually com.atproto.server.createAccount for creating a new account
125
-
* @returns {Promise<string>}
126
-
*/
127
-
createANewServiceAuthToken(iss: any, aud: any, keypair: any, lxm: any): Promise<string>
29
+
/**
30
+
*
31
+
* @param plcDirectoryUrl {string} - The url of the plc directory, defaults to https://plc.directory
32
+
*/
33
+
constructor(plcDirectoryUrl?: string);
34
+
/**
35
+
* The url of the plc directory
36
+
* @type {string}
37
+
*/
38
+
plcDirectoryUrl: string;
39
+
/**
40
+
* Gets the current rotation keys for a user via their last PlC operation
41
+
* @param did
42
+
* @returns {Promise<string[]>}
43
+
*/
44
+
getCurrentRotationKeysForUser(did: any): Promise<string[]>;
45
+
/**
46
+
* Gets the last PlC operation for a user from the plc directory
47
+
* @param did
48
+
* @returns {Promise<{lastOperation: Operation, base: any}>}
49
+
*/
50
+
getLastPlcOpFromPlc(did: any): Promise<{
51
+
lastOperation: Operation;
52
+
base: any;
53
+
}>;
54
+
/**
55
+
*
56
+
* @param logs {IndexedEntryLog}
57
+
* @returns {{lastOperation: Operation, base: IndexedEntry}}
58
+
*/
59
+
getLastPlcOp(logs: IndexedEntryLog): {
60
+
lastOperation: Operation;
61
+
base: IndexedEntry;
62
+
};
63
+
/**
64
+
* Gets the plc audit logs for a user from the plc directory
65
+
* @param did
66
+
* @returns {Promise<IndexedEntryLog>}
67
+
*/
68
+
getPlcAuditLogs(did: any): Promise<IndexedEntryLog>;
69
+
/**
70
+
* Creates a new secp256k1 key that can be used for either rotation or verification key
71
+
* @returns {Promise<{privateKey: string, publicKey: `did:key:${string}`}>}
72
+
*/
73
+
createANewSecp256k1(): Promise<{
74
+
privateKey: string;
75
+
publicKey: `did:key:${string}`;
76
+
}>;
77
+
/**
78
+
* Signs a new operation with the provided signing key, and information and submits it to the plc directory
79
+
* @param did {string} - The user's did
80
+
* @param signingRotationKey { P256PrivateKey|Secp256k1PrivateKey} - The keypair to sign the op with
81
+
* @param alsoKnownAs {string[]}
82
+
* @param rotationKeys {string[]}
83
+
* @param pds {string}
84
+
* @param verificationKey {string} - The public verification key
85
+
* @param prev {string} - The previous valid operation's cid.
86
+
* @returns {Promise<void>}
87
+
*/
88
+
signAndPublishNewOp(did: string, signingRotationKey: P256PrivateKey | Secp256k1PrivateKey, alsoKnownAs: string[], rotationKeys: string[], pds: string, verificationKey: string, prev: string): Promise<void>;
89
+
/**
90
+
* Takes a multi or hex based private key and returns a keypair
91
+
* @param privateKeyString {string}
92
+
* @param type {string} - secp256k1 or p256, needed if the private key is hex based, can be assumed if it's a multikey
93
+
* @returns {Promise<{type: string, didPublicKey: `did:key:${string}`, keypair: P256PrivateKey|Secp256k1PrivateKey}>}
94
+
*/
95
+
getKeyPair(privateKeyString: string, type?: string): Promise<{
96
+
type: string;
97
+
didPublicKey: `did:key:${string}`;
98
+
keypair: P256PrivateKey | Secp256k1PrivateKey;
99
+
}>;
100
+
/**
101
+
* Submits a new operation to the plc directory
102
+
* @param did {string} - The user's did
103
+
* @param operation
104
+
* @returns {Promise<void>}
105
+
*/
106
+
pushPlcOperation(did: string, operation: any): Promise<void>;
107
+
/**
108
+
* Creates a new service auth token for a user. This is what is used to create a new account on a PDS for your did
109
+
*
110
+
* @param iss The user's did
111
+
* @param aud The did:web, if it's a PDS it's usually from /xrpc/com.atproto.server.describeServer
112
+
* @param keypair The keypair to sign with only supporting ES256K atm
113
+
* @param lxm The lxm which is usually com.atproto.server.createAccount for creating a new account
114
+
* @returns {Promise<string>}
115
+
*/
116
+
createANewServiceAuthToken(iss: any, aud: any, keypair: any, lxm: any): Promise<string>;
128
117
}
129
-
import { defs } from '@atcute/did-plc'
130
-
import { P256PrivateKey } from '@atcute/crypto'
131
-
import { Secp256k1PrivateKey } from '@atcute/crypto'
132
-
//# sourceMappingURL=plc-ops.d.ts.map
118
+
import { defs } from '@atcute/did-plc';
119
+
import { P256PrivateKey } from '@atcute/crypto';
120
+
import { Secp256k1PrivateKey } from '@atcute/crypto';
121
+
//# sourceMappingURL=plc-ops.d.ts.map
+1
-1
packages/moover/types/plc-ops.d.ts.map
+1
-1
packages/moover/types/plc-ops.d.ts.map
···
1
-
{"version":3,"file":"plc-ops.d.ts","sourceRoot":"","sources":["../lib/plc-ops.js"],"names":[],"mappings":";;;;;;;;;;;wBAIa,OAAO,iBAAiB,EAAE,SAAS;;;;kCACnC,OAAO,iBAAiB,EAAE,mBAAmB;;;;8BAC7C,OAAO,iBAAiB,EAAE,eAAe;;;;2BACzC,OAAO,iBAAiB,EAAE,YAAY;AAgBnD;;GAEG;AACH;IACI;;;OAGG;IACH,8BAF2B,MAAM,EAQhC;IALG;;;OAGG;IACH,iBAFU,MAAM,CAEsB;IAG1C;;;;OAIG;IACH,yCAFa,OAAO,CAAC,MAAM,EAAE,CAAC,CAM7B;IAED;;;;OAIG;IACH,+BAFa,OAAO,CAAC;QAAC,aAAa,EAAE,SAAS,CAAC;QAAC,IAAI,EAAE,GAAG,CAAA;KAAC,CAAC,CAK1D;IAED;;;;OAIG;IACH,mBAHgB,eAAe,GAClB;QAAC,aAAa,EAAE,SAAS,CAAC;QAAC,IAAI,EAAE,YAAY,CAAA;KAAC,CAK1D;IAGD;;;;OAIG;IACH,2BAFa,OAAO,CAAC,eAAe,CAAC,CAUpC;IAED;;;OAGG;IACH,uBAFa,OAAO,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,WAAW,MAAM,EAAE,CAAA;KAAC,CAAC,CAUzE;IAGD;;;;;;;;;;OAUG;IACH,yBATe,MAAM,sBACU,cAAc,GAAC,mBAAmB,eAC1C,MAAM,EAAE,gBACP,MAAM,EAAE,OACjB,MAAM,mBACM,MAAM,QACjB,MAAM,GACT,OAAO,CAAC,IAAI,CAAC,CAuCzB;IAED;;;;;OAKG;IACH,6BAJ4B,MAAM,SAClB,MAAM,GACT,OAAO,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,YAAY,EAAE,WAAW,MAAM,EAAE,CAAC;QAAC,OAAO,EAAE,cAAc,GAAC,mBAAmB,CAAA;KAAC,CAAC,CAkDnH;IAED;;;;;OAKG;IACH,sBAJe,MAAM,mBAER,OAAO,CAAC,IAAI,CAAC,CAwBzB;IAGD;;;;;;;;OAQG;IACH,wEAFa,OAAO,CAAC,MAAM,CAAC,CAwC3B;CAGJ;qBAtR+B,iBAAiB;+BACsD,gBAAgB;oCAAhB,gBAAgB"}
1
+
{"version":3,"file":"plc-ops.d.ts","sourceRoot":"","sources":["../lib/plc-ops.js"],"names":[],"mappings":";;;;;;;;;;;wBAIa,OAAO,iBAAiB,EAAE,SAAS;;;;kCACnC,OAAO,iBAAiB,EAAE,mBAAmB;;;;8BAC7C,OAAO,iBAAiB,EAAE,eAAe;;;;2BACzC,OAAO,iBAAiB,EAAE,YAAY;AAoBnD;;GAEG;AACH;IACE;;;OAGG;IACH,8BAF2B,MAAM,EAQhC;IALC;;;OAGG;IACH,iBAFU,MAAM,CAEsB;IAGxC;;;;OAIG;IACH,yCAFa,OAAO,CAAC,MAAM,EAAE,CAAC,CAM7B;IAED;;;;OAIG;IACH,+BAFa,OAAO,CAAC;QAAC,aAAa,EAAE,SAAS,CAAC;QAAC,IAAI,EAAE,GAAG,CAAA;KAAC,CAAC,CAK1D;IAED;;;;OAIG;IACH,mBAHgB,eAAe,GAClB;QAAC,aAAa,EAAE,SAAS,CAAC;QAAC,IAAI,EAAE,YAAY,CAAA;KAAC,CAK1D;IAED;;;;OAIG;IACH,2BAFa,OAAO,CAAC,eAAe,CAAC,CAUpC;IAED;;;OAGG;IACH,uBAFa,OAAO,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,WAAW,MAAM,EAAE,CAAA;KAAC,CAAC,CAUzE;IAED;;;;;;;;;;OAUG;IACH,yBATe,MAAM,sBACU,cAAc,GAAC,mBAAmB,eAC1C,MAAM,EAAE,gBACP,MAAM,EAAE,OACjB,MAAM,mBACM,MAAM,QACjB,MAAM,GACT,OAAO,CAAC,IAAI,CAAC,CA8CzB;IAED;;;;;OAKG;IACH,6BAJ4B,MAAM,SAClB,MAAM,GACT,OAAO,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,YAAY,EAAE,WAAW,MAAM,EAAE,CAAC;QAAC,OAAO,EAAE,cAAc,GAAC,mBAAmB,CAAA;KAAC,CAAC,CAiDnH;IAED;;;;;OAKG;IACH,sBAJe,MAAM,mBAER,OAAO,CAAC,IAAI,CAAC,CAwBzB;IAED;;;;;;;;OAQG;IACH,wEAFa,OAAO,CAAC,MAAM,CAAC,CAuC3B;CACF;qBA1RiC,iBAAiB;+BAM5C,gBAAgB;oCAAhB,gBAAgB"}
+77
-92
packages/moover/types/restore.d.ts
+77
-92
packages/moover/types/restore.d.ts
···
1
-
export type Operation = import('@atcute/did-plc').Operation
1
+
export type Operation = import("@atcute/did-plc").Operation;
2
2
export class Restore {
3
-
/**
4
-
*
5
-
* @param pdsMooverInstance {string} - The url of the pds moover instance to restore from. Defaults to https://pdsmover.com
6
-
*/
7
-
constructor(pdsMooverInstance?: string)
8
-
/**
9
-
* If you want to use a different plc directory create your own instance of the plc ops class and pass it in here
10
-
* @type {PlcOps} */
11
-
plcOps: PlcOps
12
-
/**
13
-
* This is the base url for the pds moover instance used to restore the files from a backup.
14
-
* @type {string}
15
-
*/
16
-
pdsMooverInstance: string
17
-
/**
18
-
* To keep it simple, only uses secp256k for the temp verification key that is used to create the new account on the new PDS
19
-
* and is temporarily assigned to the user's account on PLC
20
-
* @type {null|Secp256k1PrivateKeyExportable}
21
-
*/
22
-
tempVerificationKeypair: null | Secp256k1PrivateKeyExportable
23
-
/** @type {AtpAgent} */
24
-
atpAgent: AtpAgent
25
-
/**
26
-
* The keypair that is used to sign the plc operation
27
-
* @type {null|{type: string, didPublicKey: `did:key:${string}`, keypair: P256PrivateKey|Secp256k1PrivateKey}}
28
-
*/
29
-
recoveryRotationKeyPair: null | {
30
-
type: string
31
-
didPublicKey: `did:key:${string}`
32
-
keypair: P256PrivateKey | Secp256k1PrivateKey
33
-
}
34
-
/**
35
-
* If this is true we are just restoring the repo and blobs. Ideally for rerunning a restore process after account recovery
36
-
* @type {boolean}
37
-
*/
38
-
RestoreFromBackup: boolean
39
-
/**
40
-
* If set to true then it will do the account recovery. Writes a temp key to the did doc,
41
-
* create a new account on the new pds, and then submit a new plc op for the pds to have control (finishes the migration, can always restore the backup later)
42
-
* @type {boolean}
43
-
*/
44
-
AccountRecovery: boolean
45
-
/**
46
-
* Recovers an account with the users rotation key and restores the repo from a PDS MOOver backup
47
-
* This method can fail, and the account was still recovered, it's best to check the PLC logs to see where an account stands before reruns
48
-
* @param rotationKey {string} - The users private rotation key, can be a multi key or hex key
49
-
* @param rotationKeyType {string} - The type of the key, secp256k1 or p256. Required if the key is in hex format, defaults to secp256k1
50
-
* @param currentHandleOrDid {string} - The users current handle or did, if they don't have a DNS record it will have to be their did for success
51
-
* @param newPDS {string} - The new PDS url, like https://coolnewpds.com
52
-
* @param newHandle {string} - Can be the users DNS handle if it is already setup with their did, if not it's bob.mypds.com
53
-
* @param newPassword {string} - The new password for the new account
54
-
* @param newEmail {string} - The new email for the new account
55
-
* @param inviteCode {string|null} - The invite code for the new PDS if it requires one
56
-
* @param cidToRestoreTo {string|null} - The cid of the plc op to restore to, used mostly to revert a fraudulent plc op. Want to give it the last valid operations cid
57
-
* @param onStatus {function|null} - A function that takes a string used to update the UI. Like (status) => console.log(status)
58
-
* @returns {Promise<void>} If there is a failure during restoring the back up (after the status Success! Restoring your repo...) then your account is most likely
59
-
* recovered and future runs need to have the RestoreFromBackup flag set to true and AccountRecovery set to false.
60
-
*/
61
-
recover(
62
-
rotationKey: string,
63
-
rotationKeyType: string,
64
-
currentHandleOrDid: string,
65
-
newPDS: string,
66
-
newHandle: string,
67
-
newPassword: string,
68
-
newEmail: string,
69
-
inviteCode: string | null,
70
-
cidToRestoreTo?: string | null,
71
-
onStatus?: Function | null,
72
-
): Promise<void>
73
-
/**
74
-
* This method signs the plc operation over to the new PDS and activates the account
75
-
* Assumes you have already created a new account during the recovery process and logged in
76
-
* Uses the recommended did doc from the PDS as a base and adds the users rotation key to the rotation keys array
77
-
*
78
-
* @param usersDid
79
-
* @param additionalRotationKeysToAdd
80
-
* @param prevCid
81
-
* @returns {Promise<void>}
82
-
*/
83
-
signRestorePlcOperation(
84
-
usersDid: any,
85
-
additionalRotationKeysToAdd: any[],
86
-
prevCid: any,
87
-
): Promise<void>
3
+
/**
4
+
*
5
+
* @param pdsMooverInstance {string} - The url of the pds moover instance to restore from. Defaults to https://pdsmover.com
6
+
*/
7
+
constructor(pdsMooverInstance?: string);
8
+
/**
9
+
* If you want to use a different plc directory create your own instance of the plc ops class and pass it in here
10
+
* @type {PlcOps} */
11
+
plcOps: PlcOps;
12
+
/**
13
+
* This is the base url for the pds moover instance used to restore the files from a backup.
14
+
* @type {string}
15
+
*/
16
+
pdsMooverInstance: string;
17
+
/**
18
+
* To keep it simple, only uses secp256k for the temp verification key that is used to create the new account on the new PDS
19
+
* and is temporarily assigned to the user's account on PLC
20
+
* @type {null|Secp256k1PrivateKeyExportable}
21
+
*/
22
+
tempVerificationKeypair: null | Secp256k1PrivateKeyExportable;
23
+
/** @type {AtpAgent} */
24
+
atpAgent: AtpAgent;
25
+
/**
26
+
* The keypair that is used to sign the plc operation
27
+
* @type {null|{type: string, didPublicKey: `did:key:${string}`, keypair: P256PrivateKey|Secp256k1PrivateKey}}
28
+
*/
29
+
recoveryRotationKeyPair: null | {
30
+
type: string;
31
+
didPublicKey: `did:key:${string}`;
32
+
keypair: P256PrivateKey | Secp256k1PrivateKey;
33
+
};
34
+
/**
35
+
* If this is true we are just restoring the repo and blobs. Ideally for rerunning a restore process after account recovery
36
+
* @type {boolean}
37
+
*/
38
+
RestoreFromBackup: boolean;
39
+
/**
40
+
* If set to true then it will do the account recovery. Writes a temp key to the did doc,
41
+
* create a new account on the new pds, and then submit a new plc op for the pds to have control (finishes the migration, can always restore the backup later)
42
+
* @type {boolean}
43
+
*/
44
+
AccountRecovery: boolean;
45
+
/**
46
+
* Recovers an account with the users rotation key and restores the repo from a PDS MOOver backup
47
+
* This method can fail, and the account was still recovered, it's best to check the PLC logs to see where an account stands before reruns
48
+
* @param rotationKey {string} - The users private rotation key, can be a multi key or hex key
49
+
* @param rotationKeyType {string} - The type of the key, secp256k1 or p256. Required if the key is in hex format, defaults to secp256k1
50
+
* @param currentHandleOrDid {string} - The users current handle or did, if they don't have a DNS record it will have to be their did for success
51
+
* @param newPDS {string} - The new PDS url, like https://coolnewpds.com
52
+
* @param newHandle {string} - Can be the users DNS handle if it is already setup with their did, if not it's bob.mypds.com
53
+
* @param newPassword {string} - The new password for the new account
54
+
* @param newEmail {string} - The new email for the new account
55
+
* @param inviteCode {string|null} - The invite code for the new PDS if it requires one
56
+
* @param cidToRestoreTo {string|null} - The cid of the plc op to restore to, used mostly to revert a fraudulent plc op. Want to give it the last valid operations cid
57
+
* @param onStatus {function|null} - A function that takes a string used to update the UI. Like (status) => console.log(status)
58
+
* @returns {Promise<void>} If there is a failure during restoring the back up (after the status Success! Restoring your repo...) then your account is most likely
59
+
* recovered and future runs need to have the RestoreFromBackup flag set to true and AccountRecovery set to false.
60
+
*/
61
+
recover(rotationKey: string, rotationKeyType: string, currentHandleOrDid: string, newPDS: string, newHandle: string, newPassword: string, newEmail: string, inviteCode: string | null, cidToRestoreTo?: string | null, onStatus?: Function | null): Promise<void>;
62
+
/**
63
+
* This method signs the plc operation over to the new PDS and activates the account
64
+
* Assumes you have already created a new account during the recovery process and logged in
65
+
* Uses the recommended did doc from the PDS as a base and adds the users rotation key to the rotation keys array
66
+
*
67
+
* @param usersDid
68
+
* @param additionalRotationKeysToAdd
69
+
* @param prevCid
70
+
* @returns {Promise<void>}
71
+
*/
72
+
signRestorePlcOperation(usersDid: any, additionalRotationKeysToAdd: any[], prevCid: any): Promise<void>;
88
73
}
89
-
import { PlcOps } from './plc-ops.js'
90
-
import { Secp256k1PrivateKeyExportable } from '@atcute/crypto'
91
-
import { AtpAgent } from '@atproto/api'
92
-
import { P256PrivateKey } from '@atcute/crypto'
93
-
import { Secp256k1PrivateKey } from '@atcute/crypto'
94
-
//# sourceMappingURL=restore.d.ts.map
74
+
import { PlcOps } from './plc-ops.js';
75
+
import { Secp256k1PrivateKeyExportable } from '@atcute/crypto';
76
+
import { AtpAgent } from '@atproto/api';
77
+
import { P256PrivateKey } from '@atcute/crypto';
78
+
import { Secp256k1PrivateKey } from '@atcute/crypto';
79
+
//# sourceMappingURL=restore.d.ts.map
+1
-1
packages/moover/types/restore.d.ts.map
+1
-1
packages/moover/types/restore.d.ts.map
···
1
-
{"version":3,"file":"restore.d.ts","sourceRoot":"","sources":["../lib/restore.js"],"names":[],"mappings":"wBACa,OAAO,iBAAiB,EAAE,SAAS;AAWhD;IAEI;;;OAGG;IACH,gCAF6B,MAAM,EA0ClC;IAvCG;;wBAEoB;IACpB,QADU,MAAM,CACU;IAE1B;;;OAGG;IACH,mBAFU,MAAM,CAE0B;IAE1C;;;;OAIG;IACH,yBAFU,IAAI,GAAC,6BAA6B,CAET;IAEnC,uBAAuB;IACvB,UADW,QAAQ,CACC;IAEpB;;;OAGG;IACH,yBAFU,IAAI,GAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,YAAY,EAAE,WAAW,MAAM,EAAE,CAAC;QAAC,OAAO,EAAE,cAAc,GAAC,mBAAmB,CAAA;KAAC,CAE1E;IAEnC;;;OAGG;IACH,mBAFU,OAAO,CAEY;IAE7B;;;;OAIG;IACH,iBAFU,OAAO,CAEU;IAG/B;;;;;;;;;;;;;;;OAeG;IACH,qBAbuB,MAAM,mBACF,MAAM,sBACH,MAAM,UAClB,MAAM,aACH,MAAM,eACJ,MAAM,YACT,MAAM,cACJ,MAAM,GAAC,IAAI,mBACP,MAAM,GAAC,IAAI,aACjB,WAAS,IAAI,GACpB,OAAO,CAAC,IAAI,CAAC,CA4MzB;IAGD;;;;;;;;;OASG;IACH,0FAFa,OAAO,CAAC,IAAI,CAAC,CAuCzB;CACJ;uBAnUoB,cAAc;8CAGS,gBAAgB;yBADrC,cAAc;+BAJa,gBAAgB;oCAAhB,gBAAgB"}
1
+
{"version":3,"file":"restore.d.ts","sourceRoot":"","sources":["../lib/restore.js"],"names":[],"mappings":"wBACa,OAAO,iBAAiB,EAAE,SAAS;AAWhD;IACE;;;OAGG;IACH,gCAF6B,MAAM,EA0ClC;IAvCC;;wBAEoB;IACpB,QADU,MAAM,CACU;IAE1B;;;OAGG;IACH,mBAFU,MAAM,CAE0B;IAE1C;;;;OAIG;IACH,yBAFU,IAAI,GAAC,6BAA6B,CAET;IAEnC,uBAAuB;IACvB,UADW,QAAQ,CACC;IAEpB;;;OAGG;IACH,yBAFU,IAAI,GAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,YAAY,EAAE,WAAW,MAAM,EAAE,CAAC;QAAC,OAAO,EAAE,cAAc,GAAC,mBAAmB,CAAA;KAAC,CAE1E;IAEnC;;;OAGG;IACH,mBAFU,OAAO,CAEY;IAE7B;;;;OAIG;IACH,iBAFU,OAAO,CAEU;IAG7B;;;;;;;;;;;;;;;OAeG;IACH,qBAbuB,MAAM,mBACF,MAAM,sBACH,MAAM,UAClB,MAAM,aACH,MAAM,eACJ,MAAM,YACT,MAAM,cACJ,MAAM,GAAC,IAAI,mBACP,MAAM,GAAC,IAAI,aACjB,WAAS,IAAI,GACpB,OAAO,CAAC,IAAI,CAAC,CAiNzB;IAED;;;;;;;;;OASG;IACH,0FAFa,OAAO,CAAC,IAAI,CAAC,CAsCzB;CACF;uBArUsB,cAAc;8CAGS,gBAAgB;yBADrC,cAAc;+BAJa,gBAAgB;oCAAhB,gBAAgB"}