@comapeo/core 1.0.0

package/dist/utils.d.ts

@@ -0,0 +1,115 @@
+/**
+ * @param {String|Buffer} id
+ * @returns {Buffer | Uint8Array}
+ */
+export function idToKey(id: string | Buffer): Buffer | Uint8Array;
+/**
+ *
+ * @param {Buffer|String} key
+ * @returns {String}
+ */
+export function keyToId(key: Buffer | string): string;
+/**
+ * @param {String} version
+ * @returns {{coreId: String, blockIndex: Number}}
+ */
+export function parseVersion(version: string): {
+    coreId: string;
+    blockIndex: number;
+};
+/**
+ * @returns {void}
+ */
+export function noop(): void;
+/**
+ * @param {unknown} condition
+ * @param {string} message
+ * @returns {asserts condition}
+ */
+export function assert(condition: unknown, message: string): asserts condition;
+/**
+ * Return a function that itself returns whether a value is part of the set.
+ *
+ * Similar to binding `Set.prototype.has`, but (1) is shorter (2) refines the type.
+ *
+ * @template T
+ * @param {Readonly<Set<T>>} set
+ * @example
+ * const mySet = new Set([1, 2, 3])
+ * const isInMySet = setHas(mySet)
+ *
+ * console.log(isInMySet(2))
+ * // => true
+ */
+export function setHas<T>(set: Readonly<Set<T>>): (value: unknown) => value is T;
+/**
+ * @template T
+ * @param {undefined | T} value
+ * @returns {value is T}
+ */
+export function isDefined<T>(value: undefined | T): value is T;
+/**
+ * When reading from SQLite, any optional properties are set to `null`. This
+ * converts `null` back to `undefined` to match the input types (e.g. the types
+ * defined in @comapeo/schema)
+ * @template {{}} T
+ * @param {T} obj
+ * @returns {import('./types.js').NullableToOptional<T>}
+ */
+export function deNullify<T extends {}>(obj: T): import("./types.js").NullableToOptional<T>;
+/**
+ * @template {import('@comapeo/schema').MapeoDoc & { forks?: string[] }} T
+ * @param {T} doc
+ * @returns {Omit<T, 'docId' | 'versionId' | 'originalVersionId' | 'links' | 'forks' | 'createdAt' | 'updatedAt' | 'deleted'>}
+ */
+export function valueOf<T extends import("@comapeo/schema").MapeoDoc & {
+    forks?: string[];
+}>(doc: T): Omit<T, "docId" | "versionId" | "originalVersionId" | "links" | "forks" | "createdAt" | "updatedAt" | "deleted">;
+/**
+ * Create an internal ID from a project key
+ * @param {Buffer} projectKey
+ * @returns {string}
+ */
+export function projectKeyToId(projectKey: Buffer): string;
+/**
+ * Create a public ID from a project key
+ * @param {Buffer} projectKey
+ * @returns {string}
+ */
+export function projectKeyToPublicId(projectKey: Buffer): string;
+/**
+ * Generate an invite ID from a project key
+ * @param {Readonly<Buffer>} projectKey
+ * @returns {Buffer}
+ */
+export function projectKeyToProjectInviteId(projectKey: Readonly<Buffer>): Buffer;
+/**
+ * @param {string} projectId Project internal ID
+ * @returns {Buffer} 24-byte nonce (same length as sodium.crypto_aead_xchacha20poly1305_ietf_NPUBBYTES)
+ */
+export function projectIdToNonce(projectId: string): Buffer;
+/**
+ * @param {import('@mapeo/crypto').KeyManager} keyManager
+ * @returns {string}
+ */
+export function getDeviceId(keyManager: import("@mapeo/crypto/dist/key-manager.js")): string;
+/**
+ * Small helper to create a typed map
+ *
+ * @template {string} K
+ * @template {any} V
+ * @param {ReadonlyArray<K>} keys
+ * @param {V} value
+ * @returns {Record<K, V extends () => infer T ? T : V>} */
+export function createMap<K extends string, V extends unknown>(keys: ReadonlyArray<K>, value: V): Record<K, V extends () => infer T ? T : V>;
+/**
+ * create a sha256 hash of an object using json-stable-stringify for deterministic results
+ * @param {Object} obj
+ * @returns {String} hash of the object
+ */
+export function hashObject(obj: Object): string;
+export class ExhaustivenessError extends Error {
+    /** @param {never} value */
+    constructor(value: never);
+}
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.js"],"names":[],"mappings":"AAQA;;;GAGG;AACH,4BAHW,SAAO,MAAM,GACX,MAAM,GAAG,UAAU,CAQ/B;AAED;;;;GAIG;AACH,6BAHW,MAAM,SAAO,UASvB;AAED;;;GAGG;AACH,+CAFa;IAAC,MAAM,SAAS;IAAC,UAAU,SAAQ;CAAC,CAQhD;AAUD;;GAEG;AACH,wBAFa,IAAI,CAEQ;AAEzB;;;;GAIG;AACH,kCAJW,OAAO,WACP,MAAM,GACJ,QAAQ,SAAS,CAI7B;AAED;;;;;;;;;;;;;GAaG;AACH,uBATa,CAAC,OACH,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,WAUd,OAAO,KACL,KAAK,IAAI,CAAC,CAGxB;AAED;;;;GAIG;AACH,0BAJa,CAAC,SACH,SAAS,GAAG,CAAC,GACX,KAAK,IAAI,CAAC,CAItB;AAED;;;;;;;GAOG;AAEH,0BALkB,CAAC,SAAN,EAAI,OACN,CAAC,GACC,OAAO,YAAY,EAAE,kBAAkB,CAAC,CAAC,CAAC,CAUtD;AAED;;;;GAIG;AACH,wBAJyE,CAAC,SAA5D,OAAO,iBAAiB,EAAE,QAAQ,GAAG;IAAE,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;CAAG,OAC7D,CAAC,GACC,IAAI,CAAC,CAAC,EAAE,OAAO,GAAG,WAAW,GAAG,mBAAmB,GAAG,OAAO,GAAG,OAAO,GAAG,WAAW,GAAG,WAAW,GAAG,SAAS,CAAC,CAiB5H;AAED;;;;GAIG;AACH,2CAHW,MAAM,GACJ,MAAM,CAIlB;AAED;;;;GAIG;AACH,iDAHW,MAAM,GACJ,MAAM,CAIlB;AAED;;;;GAIG;AACH,wDAHW,QAAQ,CAAC,MAAM,CAAC,GACd,MAAM,CAMlB;AAED;;;GAGG;AACH,4CAHW,MAAM,GACJ,MAAM,CAIlB;AAED;;;GAGG;AACH,wCAHW,2CAAkC,GAChC,MAAM,CAIlB;AAED;;;;;;;2DAO2D;AAC3D,0BALsB,CAAC,SAAV,MAAQ,EACF,CAAC,wBACT,aAAa,CAAC,CAAC,CAAC,SAChB,CAAC,GACC,MAAM,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAOtD;AAED;;;;GAIG;AACH,gCAHW,MAAM,UAQhB;AApKD;IACE,2BAA2B;IAC3B,mBADY,KAAK,EAIhB;CACF"}

package/dist/utils_types.d.ts

@@ -0,0 +1,14 @@
+import type { TypedEmitter } from 'tiny-typed-emitter'
+
+export type TypedEvents<T extends TypedEmitter<any>> = T extends TypedEmitter<
+  infer Result
+>
+  ? Result
+  : never
+
+export type TypedEventsFor<T extends TypedEmitter<any>> = keyof TypedEvents<T>
+
+export type TypedEventArgs<
+  Emitter extends TypedEmitter<any>,
+  Event extends TypedEventsFor<Emitter>
+> = Parameters<TypedEvents<Emitter>[Event]>

package/drizzle/client/0000_bumpy_carnage.sql

@@ -0,0 +1,33 @@
+CREATE TABLE `localDeviceInfo` (
+	`deviceId` text NOT NULL,
+	`deviceInfo` text NOT NULL
+);
+--> statement-breakpoint
+CREATE TABLE `projectSettings_backlink` (
+	`versionId` text PRIMARY KEY NOT NULL
+);
+--> statement-breakpoint
+CREATE TABLE `projectKeys` (
+	`projectId` text PRIMARY KEY NOT NULL,
+	`projectPublicId` text NOT NULL,
+	`projectInviteId` blob NOT NULL,
+	`keysCipher` blob NOT NULL,
+	`projectInfo` text DEFAULT '{}' NOT NULL
+);
+--> statement-breakpoint
+CREATE TABLE `projectSettings` (
+	`docId` text PRIMARY KEY NOT NULL,
+	`versionId` text NOT NULL,
+	`originalVersionId` text NOT NULL,
+	`schemaName` text NOT NULL,
+	`createdAt` text NOT NULL,
+	`updatedAt` text NOT NULL,
+	`links` text NOT NULL,
+	`deleted` integer NOT NULL,
+	`name` text,
+	`defaultPresets` text,
+	`configMetadata` text,
+	`forks` text NOT NULL
+);
+--> statement-breakpoint
+CREATE UNIQUE INDEX `localDeviceInfo_deviceId_unique` ON `localDeviceInfo` (`deviceId`);

package/drizzle/client/meta/0000_snapshot.json

@@ -0,0 +1,199 @@
+{
+  "version": "5",
+  "dialect": "sqlite",
+  "id": "e75103ab-bbcb-4ca9-a0c4-2d9095b63add",
+  "prevId": "00000000-0000-0000-0000-000000000000",
+  "tables": {
+    "localDeviceInfo": {
+      "name": "localDeviceInfo",
+      "columns": {
+        "deviceId": {
+          "name": "deviceId",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "deviceInfo": {
+          "name": "deviceInfo",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        }
+      },
+      "indexes": {
+        "localDeviceInfo_deviceId_unique": {
+          "name": "localDeviceInfo_deviceId_unique",
+          "columns": [
+            "deviceId"
+          ],
+          "isUnique": true
+        }
+      },
+      "foreignKeys": {},
+      "compositePrimaryKeys": {},
+      "uniqueConstraints": {}
+    },
+    "projectSettings_backlink": {
+      "name": "projectSettings_backlink",
+      "columns": {
+        "versionId": {
+          "name": "versionId",
+          "type": "text",
+          "primaryKey": true,
+          "notNull": true,
+          "autoincrement": false
+        }
+      },
+      "indexes": {},
+      "foreignKeys": {},
+      "compositePrimaryKeys": {},
+      "uniqueConstraints": {}
+    },
+    "projectKeys": {
+      "name": "projectKeys",
+      "columns": {
+        "projectId": {
+          "name": "projectId",
+          "type": "text",
+          "primaryKey": true,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "projectPublicId": {
+          "name": "projectPublicId",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "projectInviteId": {
+          "name": "projectInviteId",
+          "type": "blob",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "keysCipher": {
+          "name": "keysCipher",
+          "type": "blob",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "projectInfo": {
+          "name": "projectInfo",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false,
+          "default": "'{}'"
+        }
+      },
+      "indexes": {},
+      "foreignKeys": {},
+      "compositePrimaryKeys": {},
+      "uniqueConstraints": {}
+    },
+    "projectSettings": {
+      "name": "projectSettings",
+      "columns": {
+        "docId": {
+          "name": "docId",
+          "type": "text",
+          "primaryKey": true,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "versionId": {
+          "name": "versionId",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "originalVersionId": {
+          "name": "originalVersionId",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "schemaName": {
+          "name": "schemaName",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "createdAt": {
+          "name": "createdAt",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "updatedAt": {
+          "name": "updatedAt",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "links": {
+          "name": "links",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "deleted": {
+          "name": "deleted",
+          "type": "integer",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        },
+        "name": {
+          "name": "name",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false,
+          "autoincrement": false
+        },
+        "defaultPresets": {
+          "name": "defaultPresets",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false,
+          "autoincrement": false
+        },
+        "configMetadata": {
+          "name": "configMetadata",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false,
+          "autoincrement": false
+        },
+        "forks": {
+          "name": "forks",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true,
+          "autoincrement": false
+        }
+      },
+      "indexes": {},
+      "foreignKeys": {},
+      "compositePrimaryKeys": {},
+      "uniqueConstraints": {}
+    }
+  },
+  "enums": {},
+  "_meta": {
+    "schemas": {},
+    "tables": {},
+    "columns": {}
+  }
+}

package/drizzle/client/meta/_journal.json

@@ -0,0 +1,13 @@
+{
+  "version": "5",
+  "dialect": "sqlite",
+  "entries": [
+    {
+      "idx": 0,
+      "version": "5",
+      "when": 1726514276007,
+      "tag": "0000_bumpy_carnage",
+      "breakpoints": true
+    }
+  ]
+}

package/drizzle/project/0000_spooky_lady_ursula.sql

@@ -0,0 +1,192 @@
+CREATE TABLE `coreOwnership_backlink` (
+	`versionId` text PRIMARY KEY NOT NULL
+);
+--> statement-breakpoint
+CREATE TABLE `coreOwnership` (
+	`docId` text PRIMARY KEY NOT NULL,
+	`versionId` text NOT NULL,
+	`originalVersionId` text NOT NULL,
+	`schemaName` text NOT NULL,
+	`createdAt` text NOT NULL,
+	`updatedAt` text NOT NULL,
+	`links` text NOT NULL,
+	`deleted` integer NOT NULL,
+	`authCoreId` text NOT NULL,
+	`configCoreId` text NOT NULL,
+	`dataCoreId` text NOT NULL,
+	`blobCoreId` text NOT NULL,
+	`blobIndexCoreId` text NOT NULL,
+	`forks` text NOT NULL
+);
+--> statement-breakpoint
+CREATE TABLE `cores` (
+	`publicKey` blob NOT NULL,
+	`namespace` text NOT NULL
+);
+--> statement-breakpoint
+CREATE TABLE `deviceInfo_backlink` (
+	`versionId` text PRIMARY KEY NOT NULL
+);
+--> statement-breakpoint
+CREATE TABLE `deviceInfo` (
+	`docId` text PRIMARY KEY NOT NULL,
+	`versionId` text NOT NULL,
+	`originalVersionId` text NOT NULL,
+	`schemaName` text NOT NULL,
+	`createdAt` text NOT NULL,
+	`updatedAt` text NOT NULL,
+	`links` text NOT NULL,
+	`deleted` integer NOT NULL,
+	`name` text NOT NULL,
+	`deviceType` text NOT NULL,
+	`forks` text NOT NULL
+);
+--> statement-breakpoint
+CREATE TABLE `field_backlink` (
+	`versionId` text PRIMARY KEY NOT NULL
+);
+--> statement-breakpoint
+CREATE TABLE `field` (
+	`docId` text PRIMARY KEY NOT NULL,
+	`versionId` text NOT NULL,
+	`originalVersionId` text NOT NULL,
+	`schemaName` text NOT NULL,
+	`createdAt` text NOT NULL,
+	`updatedAt` text NOT NULL,
+	`links` text NOT NULL,
+	`deleted` integer NOT NULL,
+	`tagKey` text NOT NULL,
+	`type` text NOT NULL,
+	`label` text NOT NULL,
+	`appearance` text,
+	`snakeCase` integer,
+	`options` text,
+	`universal` integer,
+	`placeholder` text,
+	`helperText` text,
+	`forks` text NOT NULL
+);
+--> statement-breakpoint
+CREATE TABLE `icon_backlink` (
+	`versionId` text PRIMARY KEY NOT NULL
+);
+--> statement-breakpoint
+CREATE TABLE `icon` (
+	`docId` text PRIMARY KEY NOT NULL,
+	`versionId` text NOT NULL,
+	`originalVersionId` text NOT NULL,
+	`schemaName` text NOT NULL,
+	`createdAt` text NOT NULL,
+	`updatedAt` text NOT NULL,
+	`links` text NOT NULL,
+	`deleted` integer NOT NULL,
+	`name` text NOT NULL,
+	`variants` text NOT NULL,
+	`forks` text NOT NULL
+);
+--> statement-breakpoint
+CREATE TABLE `observation_backlink` (
+	`versionId` text PRIMARY KEY NOT NULL
+);
+--> statement-breakpoint
+CREATE TABLE `observation` (
+	`docId` text PRIMARY KEY NOT NULL,
+	`versionId` text NOT NULL,
+	`originalVersionId` text NOT NULL,
+	`schemaName` text NOT NULL,
+	`createdAt` text NOT NULL,
+	`updatedAt` text NOT NULL,
+	`links` text NOT NULL,
+	`deleted` integer NOT NULL,
+	`lat` real,
+	`lon` real,
+	`attachments` text NOT NULL,
+	`tags` text NOT NULL,
+	`metadata` text,
+	`presetRef` text,
+	`forks` text NOT NULL
+);
+--> statement-breakpoint
+CREATE TABLE `preset_backlink` (
+	`versionId` text PRIMARY KEY NOT NULL
+);
+--> statement-breakpoint
+CREATE TABLE `preset` (
+	`docId` text PRIMARY KEY NOT NULL,
+	`versionId` text NOT NULL,
+	`originalVersionId` text NOT NULL,
+	`schemaName` text NOT NULL,
+	`createdAt` text NOT NULL,
+	`updatedAt` text NOT NULL,
+	`links` text NOT NULL,
+	`deleted` integer NOT NULL,
+	`name` text NOT NULL,
+	`geometry` text NOT NULL,
+	`tags` text NOT NULL,
+	`addTags` text NOT NULL,
+	`removeTags` text NOT NULL,
+	`fieldRefs` text NOT NULL,
+	`iconRef` text,
+	`terms` text NOT NULL,
+	`color` text,
+	`forks` text NOT NULL
+);
+--> statement-breakpoint
+CREATE TABLE `role_backlink` (
+	`versionId` text PRIMARY KEY NOT NULL
+);
+--> statement-breakpoint
+CREATE TABLE `role` (
+	`docId` text PRIMARY KEY NOT NULL,
+	`versionId` text NOT NULL,
+	`originalVersionId` text NOT NULL,
+	`schemaName` text NOT NULL,
+	`createdAt` text NOT NULL,
+	`updatedAt` text NOT NULL,
+	`links` text NOT NULL,
+	`deleted` integer NOT NULL,
+	`roleId` text NOT NULL,
+	`fromIndex` integer NOT NULL,
+	`forks` text NOT NULL
+);
+--> statement-breakpoint
+CREATE TABLE `track_backlink` (
+	`versionId` text PRIMARY KEY NOT NULL
+);
+--> statement-breakpoint
+CREATE TABLE `track` (
+	`docId` text PRIMARY KEY NOT NULL,
+	`versionId` text NOT NULL,
+	`originalVersionId` text NOT NULL,
+	`schemaName` text NOT NULL,
+	`createdAt` text NOT NULL,
+	`updatedAt` text NOT NULL,
+	`links` text NOT NULL,
+	`deleted` integer NOT NULL,
+	`locations` text NOT NULL,
+	`observationRefs` text NOT NULL,
+	`tags` text NOT NULL,
+	`forks` text NOT NULL
+);
+--> statement-breakpoint
+CREATE TABLE `translation_backlink` (
+	`versionId` text PRIMARY KEY NOT NULL
+);
+--> statement-breakpoint
+CREATE TABLE `translation` (
+	`docId` text PRIMARY KEY NOT NULL,
+	`versionId` text NOT NULL,
+	`originalVersionId` text NOT NULL,
+	`schemaName` text NOT NULL,
+	`createdAt` text NOT NULL,
+	`updatedAt` text NOT NULL,
+	`links` text NOT NULL,
+	`deleted` integer NOT NULL,
+	`docRef` text NOT NULL,
+	`docRefType` text NOT NULL,
+	`propertyRef` text NOT NULL,
+	`languageCode` text NOT NULL,
+	`regionCode` text,
+	`message` text NOT NULL,
+	`forks` text NOT NULL
+);