@comapeo/core 4.1.2 → 4.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -1,13 +1,31 @@
1
1
  export { plugin as CoMapeoMapsFastifyPlugin } from "./fastify-plugins/maps.js";
2
2
  export { FastifyController } from "./fastify-controller.js";
3
3
  export { MapeoManager } from "./mapeo-manager.js";
4
- export function replicateProject(project: MapeoProject, isInitiatorOrStream: boolean | import("streamx").Duplex<any, any, any, any, true, true, import("streamx").DuplexEvents<any, any>> | import("stream").Duplex): ReturnType<(isInitiatorOrStream: (boolean | import("stream").Duplex | import("streamx").Duplex)) => import("./types.js").ReplicationStream>;
4
+ export function replicateProject(project: MapeoProject, isInitiatorOrStream: (boolean | import("stream").Duplex | import("streamx").Duplex)): import("./types.js").ReplicationStream;
5
5
  export namespace roles {
6
6
  export { CREATOR_ROLE_ID };
7
7
  export { COORDINATOR_ROLE_ID };
8
8
  export { MEMBER_ROLE_ID };
9
9
  }
10
- import type { MapeoProject } from './mapeo-project.js';
10
+ export type MapeoProject = import("./mapeo-project.js").MapeoProject;
11
+ export type EditableProjectSettings = import("./mapeo-project.js").EditableProjectSettings;
12
+ export namespace IconApi {
13
+ type BitmapOpts = import("./icon-api.js").BitmapOpts;
14
+ type SvgOpts = import("./icon-api.js").SvgOpts;
15
+ }
16
+ export namespace BlobApi {
17
+ type BlobId = import("./types.js").BlobId;
18
+ type Metadata = import("./blob-api.js").Metadata;
19
+ type BlobVariant<TBlobType extends import("./types.js").BlobType> = import("./types.js").BlobVariant<TBlobType>;
20
+ }
21
+ export namespace InviteApi {
22
+ type Invite = import("./invite/invite-api.js").Invite;
23
+ }
24
+ export namespace MemberApi {
25
+ type MemberInfo = import("./member-api.js").MemberInfo;
26
+ type RoleId = import("./roles.js").RoleId;
27
+ type RoleIdForNewInvite = import("./roles.js").RoleIdForNewInvite;
28
+ }
11
29
  import { CREATOR_ROLE_ID } from './roles.js';
12
30
  import { COORDINATOR_ROLE_ID } from './roles.js';
13
31
  import { MEMBER_ROLE_ID } from './roles.js';
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.js"],"names":[],"mappings":";;;AAgBO,0CAJI,YAAY,gKAEV,UAAU,yCAU4kmB,QAAQ,kBAAyB,SAAS,qDAV3kmB,CAG7B;;;;;;kCARH,oBAAoB;gCAL/C,YAAY;oCAAZ,YAAY;+BAAZ,YAAY"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.js"],"names":[],"mappings":";;;AA+CO,0CARI,YAAY,uBACZ,CACV,OAAW,GACX,OAAW,QAAQ,EAAE,MAAM,GAC3B,OAAW,SAAS,EAAE,MAAM,CACzB,GACS,OAAO,YAAY,EAAE,iBAAiB,CAGF;;;;;;2BArCnC,OAAO,oBAAoB,EAAE,YAAY;sCACzC,OAAO,oBAAoB,EAAE,uBAAuB;;sBAGrD,OAAO,eAAe,EAAE,UAAU;mBAClC,OAAO,eAAe,EAAE,OAAO;;;kBAI/B,OAAO,YAAY,EAAE,MAAM;oBAC3B,OAAO,eAAe,EAAE,QAAQ;qBAIA,SAAS,SAAzC,OAAQ,YAAY,EAAE,QAAS,IAC/B,OAAO,YAAY,EAAE,WAAW,CAAC,SAAS,CAAC;;;kBAI3C,OAAO,wBAAwB,EAAE,MAAM;;;sBAIvC,OAAO,iBAAiB,EAAE,UAAU;kBACpC,OAAO,YAAY,EAAE,MAAM;8BAC3B,OAAO,YAAY,EAAE,kBAAkB;;gCAhC7C,YAAY;oCAAZ,YAAY;+BAAZ,YAAY"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@comapeo/core",
3
- "version": "4.1.2",
3
+ "version": "4.1.3",
4
4
  "description": "Offline p2p mapping library",
5
5
  "main": "src/index.js",
6
6
  "types": "dist/index.d.ts",
package/src/index.js CHANGED
@@ -7,15 +7,46 @@ import { kProjectReplicate } from './mapeo-project.js'
7
7
  export { plugin as CoMapeoMapsFastifyPlugin } from './fastify-plugins/maps.js'
8
8
  export { FastifyController } from './fastify-controller.js'
9
9
  export { MapeoManager } from './mapeo-manager.js'
10
- /** @import { MapeoProject } from './mapeo-project.js' */
11
10
 
11
+ // Type exports
12
+ /** @typedef {import('./mapeo-project.js').MapeoProject} MapeoProject */
13
+ /** @typedef {import('./mapeo-project.js').EditableProjectSettings} EditableProjectSettings */
14
+ /**
15
+ * @namespace IconApi
16
+ * @typedef {import('./icon-api.js').BitmapOpts} IconApi.BitmapOpts
17
+ * @typedef {import('./icon-api.js').SvgOpts} IconApi.SvgOpts
18
+ */
19
+ /**
20
+ * @namespace BlobApi
21
+ * @typedef {import('./types.js').BlobId} BlobApi.BlobId
22
+ * @typedef {import('./blob-api.js').Metadata} BlobApi.Metadata
23
+ */
24
+ // This needs to be defined in a separate comment block so that the @template definition works.
25
+ /**
26
+ * @template {import('./types.js').BlobType} TBlobType
27
+ * @typedef {import('./types.js').BlobVariant<TBlobType>} BlobApi.BlobVariant
28
+ */
29
+ /**
30
+ * @namespace InviteApi
31
+ * @typedef {import('./invite/invite-api.js').Invite} InviteApi.Invite
32
+ */
33
+ /**
34
+ * @namespace MemberApi
35
+ * @typedef {import('./member-api.js').MemberInfo} MemberApi.MemberInfo
36
+ * @typedef {import('./roles.js').RoleId} MemberApi.RoleId
37
+ * @typedef {import('./roles.js').RoleIdForNewInvite} MemberApi.RoleIdForNewInvite
38
+ */
12
39
  /**
13
40
  * @param {MapeoProject} project
14
- * @param {Parameters<MapeoProject.prototype[kProjectReplicate]>} args
15
- * @returns {ReturnType<MapeoProject.prototype[kProjectReplicate]>}
41
+ * @param {(
42
+ * boolean |
43
+ * import('stream').Duplex |
44
+ * import('streamx').Duplex
45
+ * )} isInitiatorOrStream
46
+ * @returns {import('./types.js').ReplicationStream}
16
47
  */
17
- export const replicateProject = (project, ...args) =>
18
- project[kProjectReplicate](...args)
48
+ export const replicateProject = (project, isInitiatorOrStream) =>
49
+ project[kProjectReplicate](isInitiatorOrStream)
19
50
 
20
51
  export const roles = /** @type {const} */ ({
21
52
  CREATOR_ROLE_ID,