@comapeo/core 4.4.0 → 5.0.0

package/dist/schema/comapeo-to-drizzle.d.ts

@@ -0,0 +1,65 @@
+/**
+ * @import { JsonSchemaToDrizzleSqliteTable } from './types.js'
+ * @import { SQLiteTextJsonBuilder } from 'drizzle-orm/sqlite-core'
+ * @import { $Type } from 'drizzle-orm'
+ * @import { MapeoDocMap } from '../types.js'
+ */
+/**
+ * @typedef {typeof import('@comapeo/schema').dereferencedDocSchemas} ComapeoSchemaMap
+ * @typedef {{ forks: $Type<SQLiteTextJsonBuilder, string[]> }} AdditionalColumns
+ */
+/**
+ * @template {ComapeoSchemaMap[keyof ComapeoSchemaMap]} TSchema
+ * @param {TSchema} schema
+ * @returns {JsonSchemaToDrizzleSqliteTable<
+ *   MapeoDocMap[TSchema['properties']['schemaName']['const']],
+ *   TSchema,
+ *   TSchema['properties']['schemaName']['const'],
+ *   AdditionalColumns,
+ *   'docId'
+ * >}
+ */
+export function comapeoSchemaToDrizzleTable<TSchema extends ComapeoSchemaMap[keyof ComapeoSchemaMap]>(schema: TSchema): JsonSchemaToDrizzleSqliteTable<MapeoDocMap[TSchema["properties"]["schemaName"]["const"]], TSchema, TSchema["properties"]["schemaName"]["const"], AdditionalColumns, "docId">;
+/**
+ * Table for storing backlinks, used for indexing. There needs to be one for
+ * each indexed document type, with a specific name `<datatype>_backlink`
+ *
+ * @param {import('@comapeo/schema').MapeoDoc['schemaName']} schemaName
+ */
+export function backlinkTable(schemaName: import("@comapeo/schema").MapeoDoc["schemaName"]): import("drizzle-orm/sqlite-core").SQLiteTableWithColumns<{
+    name: string;
+    schema: undefined;
+    columns: {
+        versionId: import("drizzle-orm/sqlite-core").SQLiteColumn<{
+            name: string;
+            tableName: string;
+            dataType: "string";
+            data: string;
+            driverParam: string;
+            notNull: true;
+            hasDefault: false;
+            isPrimaryKey: true;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}>;
+    };
+    dialect: "sqlite";
+}>;
+/**
+ * @param {string} tableName
+ */
+export function getBacklinkTableName(tableName: string): string;
+export const BACKLINK_TABLE_POSTFIX: "_backlink";
+export type ComapeoSchemaMap = typeof import("@comapeo/schema").dereferencedDocSchemas;
+export type AdditionalColumns = {
+    forks: $Type<SQLiteTextJsonBuilder, string[]>;
+};
+import type { MapeoDocMap } from '../types.js';
+import type { JsonSchemaToDrizzleSqliteTable } from './types.js';
+import type { SQLiteTextJsonBuilder } from 'drizzle-orm/sqlite-core';
+import type { $Type } from 'drizzle-orm';
+//# sourceMappingURL=comapeo-to-drizzle.d.ts.map

package/dist/schema/comapeo-to-drizzle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"comapeo-to-drizzle.d.ts","sourceRoot":"","sources":["../../src/schema/comapeo-to-drizzle.js"],"names":[],"mappings":"AAKA;;;;;GAKG;AAEH;;;GAGG;AAEH;;;;;;;;;;GAUG;AACH,4CAVwD,OAAO,SAAjD,gBAAgB,CAAC,MAAM,gBAAgB,CAAE,UAC5C,OAAO,GACL,+BACR,WAAW,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC,EACzD,OAAO,EACP,OAAO,CAAC,YAAY,CAAC,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,EAC5C,iBAAiB,EACrB,OAAW,CACR,CAWH;AAED;;;;;GAKG;AACH,0CAFW,OAAO,iBAAiB,EAAE,QAAQ,CAAC,YAAY,CAAC;;;;;;;;;;;;;;;;;;;;;;GAM1D;AAED;;GAEG;AACH,gDAFW,MAAM,UAIhB;AArDD,iDAAiD;+BAUpC,cAAc,iBAAiB,EAAE,sBAAsB;gCACvD;IAAE,KAAK,EAAE,MAAM,qBAAqB,EAAE,MAAM,EAAE,CAAC,CAAA;CAAE;iCAL9B,aAAa;oDAHM,YAAY;2CACrB,yBAAyB;2BACzC,aAAa"}

package/dist/schema/json-schema-to-drizzle.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @template {{ [ K in keyof TSchema['properties'] ]?: any }} TObjectType
+ * @template {import('./types.js').JSONSchema7Object} TSchema
+ * @template {string} TTableName
+ * @template {Record<string, import('drizzle-orm').ColumnBuilderBase>} TColumnsMap
+ * @template {keyof TSchema['properties']} TPrimaryKey
+ * @param {TTableName} tableName
+ * @param {TSchema} schema
+ * @param {object} [opts]
+ * @param {TColumnsMap} [opts.additionalColumns]
+ * @param {TPrimaryKey} [opts.primaryKey] - Column name to use as primary key, if not specified in schema
+ * @returns {import('./types.js').JsonSchemaToDrizzleSqliteTable<TObjectType, TSchema, TTableName, TColumnsMap, TPrimaryKey>}
+ */
+export function jsonSchemaToDrizzleSqliteTable<TObjectType extends { [K in keyof TSchema["properties"]]?: any; }, TSchema extends import("./types.js").JSONSchema7Object, TTableName extends string, TColumnsMap extends Record<string, import("drizzle-orm").ColumnBuilderBase>, TPrimaryKey extends keyof TSchema["properties"]>(tableName: TTableName, schema: TSchema, { additionalColumns, primaryKey }?: {
+    additionalColumns?: TColumnsMap | undefined;
+    primaryKey?: TPrimaryKey | undefined;
+} | undefined): import("./types.js").JsonSchemaToDrizzleSqliteTable<TObjectType, TSchema, TTableName, TColumnsMap, TPrimaryKey>;
+//# sourceMappingURL=json-schema-to-drizzle.d.ts.map

package/dist/schema/json-schema-to-drizzle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"json-schema-to-drizzle.d.ts","sourceRoot":"","sources":["../../src/schema/json-schema-to-drizzle.js"],"names":[],"mappings":"AAGA;;;;;;;;;;;;GAYG;AACH,+CAZ8D,WAAW,SAA5D,GAAK,CAAgC,IAA3B,MAAM,OAAO,CAAC,YAAY,CAAC,CAAE,CAAC,EAAE,GAAG,GAAG,EACP,OAAO,SAAhD,OAAQ,YAAY,EAAE,iBAAkB,EAC/B,UAAU,SAAnB,MAAQ,EACkD,WAAW,SAApE,MAAM,CAAC,MAAM,EAAE,OAAO,aAAa,EAAE,iBAAiB,CAAE,EAC3B,WAAW,SAAzC,MAAO,OAAO,CAAC,YAAY,CAAE,aAC/B,UAAU,UACV,OAAO;;;gBAIL,OAAO,YAAY,EAAE,8BAA8B,CAAC,WAAW,EAAE,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,WAAW,CAAC,CA6D3H"}