faire-auth 1.0.0

package/dist/adapters/index.d.cts

@@ -0,0 +1,157 @@
+import { I as FaireAuthOptions$1, gn as Where$1, hn as TransactionAdapter, un as AdapterSchemaCreation } from "../index-B-WeOMzg.cjs";
+import "../hono-DOM31WQz.cjs";
+import { CustomAdapter as CustomAdapter$1, DBAdapter, DBAdapterFactoryConfig } from "@faire-auth/core/db/adapter";
+import { Prettify } from "@faire-auth/core/types";
+import { DBFieldAttribute, FaireAuthDBSchema } from "@faire-auth/core/db";
+export * from "@faire-auth/core/db/adapter";
+
+//#region src/adapters/adapter-factory/types.d.ts
+type AdapterFactoryOptions = {
+  config: AdapterFactoryConfig;
+  adapter: AdapterFactoryCustomizeAdapterCreator;
+};
+/**
+ * @deprecated Use `DBAdapterFactoryConfig` from `@faire-auth/core/db/adapter` instead.
+ */
+interface AdapterFactoryConfig extends Omit<DBAdapterFactoryConfig<FaireAuthOptions$1>, "transaction"> {
+  /**
+   * Execute multiple operations in a transaction.
+   *
+   * If the database doesn't support transactions, set this to `false` and operations will be executed sequentially.
+   *
+   * @default false
+   */
+  transaction?: false | (<R>(callback: (trx: TransactionAdapter) => R | Promise<R>) => Promise<R>);
+}
+type AdapterFactoryCustomizeAdapterCreator = (config: {
+  options: FaireAuthOptions$1;
+  /**
+   * The schema of the user's Faire-Auth instance.
+   */
+  schema: FaireAuthDBSchema;
+  /**
+   * The debug log function.
+   *
+   * If the config has defined `debugLogs` as `false`, no logs will be shown.
+   */
+  debugLog: (...args: any[]) => void;
+  /**
+   * Get the model name which is expected to be saved in the database based on the user's schema.
+   */
+  getModelName: (model: string) => string;
+  /**
+   * Get the field name which is expected to be saved in the database based on the user's schema.
+   */
+  getFieldName: ({
+    model,
+    field
+  }: {
+    model: string;
+    field: string;
+  }) => string;
+  /**
+   * This function helps us get the default model name from the schema defined by devs.
+   * Often times, the user will be using the `modelName` which could had been customized by the users.
+   * This function helps us get the actual model name useful to match against the schema. (eg: schema[model])
+   *
+   * If it's still unclear what this does:
+   *
+   * 1. User can define a custom modelName.
+   * 2. When using a custom modelName, doing something like `schema[model]` will not work.
+   * 3. Using this function helps us get the actual model name based on the user's defined custom modelName.
+   * 4. Thus allowing us to use `schema[model]`.
+   */
+  getDefaultModelName: (model: string) => string;
+  /**
+   * This function helps us get the default field name from the schema defined by devs.
+   * Often times, the user will be using the `fieldName` which could had been customized by the users.
+   * This function helps us get the actual field name useful to match against the schema. (eg: schema[model].fields[field])
+   *
+   * If it's still unclear what this does:
+   *
+   * 1. User can define a custom fieldName.
+   * 2. When using a custom fieldName, doing something like `schema[model].fields[field]` will not work.
+   *
+   */
+  getDefaultFieldName: ({
+    model,
+    field
+  }: {
+    model: string;
+    field: string;
+  }) => string;
+  /**
+   * Get the field attributes for a given model and field.
+   *
+   * Note: any model name or field name is allowed, whether default to schema or not.
+   */
+  getFieldAttributes: ({
+    model,
+    field
+  }: {
+    model: string;
+    field: string;
+  }) => DBFieldAttribute;
+  transformInput: (data: Record<string, any>, defaultModelName: string, action: "create" | "update", forceAllowId?: boolean) => Promise<Record<string, any>>;
+  transformOutput: (data: Record<string, any>, defaultModelName: string, select?: string[]) => Promise<Record<string, any>>;
+  transformWhereClause: <W extends Where$1[] | undefined>({
+    model,
+    where
+  }: {
+    where: W;
+    model: string;
+  }) => W extends undefined ? undefined : CleanedWhere[];
+}) => CustomAdapter;
+/**
+ * @deprecated Use `CustomAdapter` from `@faire-auth/core/db/adapter` instead.
+ */
+interface CustomAdapter extends Omit<CustomAdapter$1, "createSchema"> {
+  createSchema?: (props: {
+    /**
+     * The file the user may have passed in to the `generate` command as the expected schema file output path.
+     */
+    file?: string;
+    /**
+     * The tables from the user's Faire-Auth instance schema.
+     */
+    tables: FaireAuthDBSchema;
+  }) => Promise<AdapterSchemaCreation>;
+}
+/**
+ * @deprecated Use `CleanedWhere` from `@faire-auth/core/db/adapter` instead.
+ */
+type CleanedWhere = Prettify<Required<Where$1>>;
+type AdapterTestDebugLogs = {
+  resetDebugLogs: () => void;
+  printDebugLogs: () => void;
+};
+//#endregion
+//#region src/adapters/adapter-factory/index.d.ts
+type AdapterFactory = <O extends FaireAuthOptions$1>(options: O) => DBAdapter<O>;
+declare const createAdapterFactory: ({
+  adapter: customAdapter,
+  config: cfg
+}: AdapterFactoryOptions) => AdapterFactory;
+//#endregion
+//#region src/adapters/index.d.ts
+/**
+ * @deprecated Use `createAdapterFactory` instead. This export will be removed in the next major version.
+ */
+declare const createAdapter: ({
+  adapter: customAdapter,
+  config: cfg
+}: AdapterFactoryOptions) => AdapterFactory;
+/**
+ * @deprecated Use `AdapterFactoryOptions` instead. This export will be removed in the next major version.
+ */
+type CreateAdapterOptions = AdapterFactoryOptions;
+/**
+ * @deprecated Use `AdapterFactoryConfig` instead. This export will be removed in the next major version.
+ */
+type AdapterConfig = AdapterFactoryConfig;
+/**
+ * @deprecated Use `AdapterFactoryCustomizeAdapterCreator` instead. This export will be removed in the next major version.
+ */
+type CreateCustomAdapter = AdapterFactoryCustomizeAdapterCreator;
+//#endregion
+export { AdapterConfig, type AdapterFactory, type AdapterFactoryConfig, type AdapterFactoryCustomizeAdapterCreator, type AdapterFactoryOptions, type AdapterTestDebugLogs, CreateAdapterOptions, CreateCustomAdapter, type CustomAdapter, createAdapter, createAdapterFactory };

package/dist/adapters/index.d.mts

@@ -0,0 +1,157 @@
+import { I as FaireAuthOptions$1, gn as Where$1, hn as TransactionAdapter, un as AdapterSchemaCreation } from "../index-jlessPI0.mjs";
+import "../hono-DuE14mmj.mjs";
+import { DBFieldAttribute, FaireAuthDBSchema } from "@faire-auth/core/db";
+import { CustomAdapter as CustomAdapter$1, DBAdapter, DBAdapterFactoryConfig } from "@faire-auth/core/db/adapter";
+import { Prettify } from "@faire-auth/core/types";
+export * from "@faire-auth/core/db/adapter";
+
+//#region src/adapters/adapter-factory/types.d.ts
+type AdapterFactoryOptions = {
+  config: AdapterFactoryConfig;
+  adapter: AdapterFactoryCustomizeAdapterCreator;
+};
+/**
+ * @deprecated Use `DBAdapterFactoryConfig` from `@faire-auth/core/db/adapter` instead.
+ */
+interface AdapterFactoryConfig extends Omit<DBAdapterFactoryConfig<FaireAuthOptions$1>, "transaction"> {
+  /**
+   * Execute multiple operations in a transaction.
+   *
+   * If the database doesn't support transactions, set this to `false` and operations will be executed sequentially.
+   *
+   * @default false
+   */
+  transaction?: false | (<R>(callback: (trx: TransactionAdapter) => R | Promise<R>) => Promise<R>);
+}
+type AdapterFactoryCustomizeAdapterCreator = (config: {
+  options: FaireAuthOptions$1;
+  /**
+   * The schema of the user's Faire-Auth instance.
+   */
+  schema: FaireAuthDBSchema;
+  /**
+   * The debug log function.
+   *
+   * If the config has defined `debugLogs` as `false`, no logs will be shown.
+   */
+  debugLog: (...args: any[]) => void;
+  /**
+   * Get the model name which is expected to be saved in the database based on the user's schema.
+   */
+  getModelName: (model: string) => string;
+  /**
+   * Get the field name which is expected to be saved in the database based on the user's schema.
+   */
+  getFieldName: ({
+    model,
+    field
+  }: {
+    model: string;
+    field: string;
+  }) => string;
+  /**
+   * This function helps us get the default model name from the schema defined by devs.
+   * Often times, the user will be using the `modelName` which could had been customized by the users.
+   * This function helps us get the actual model name useful to match against the schema. (eg: schema[model])
+   *
+   * If it's still unclear what this does:
+   *
+   * 1. User can define a custom modelName.
+   * 2. When using a custom modelName, doing something like `schema[model]` will not work.
+   * 3. Using this function helps us get the actual model name based on the user's defined custom modelName.
+   * 4. Thus allowing us to use `schema[model]`.
+   */
+  getDefaultModelName: (model: string) => string;
+  /**
+   * This function helps us get the default field name from the schema defined by devs.
+   * Often times, the user will be using the `fieldName` which could had been customized by the users.
+   * This function helps us get the actual field name useful to match against the schema. (eg: schema[model].fields[field])
+   *
+   * If it's still unclear what this does:
+   *
+   * 1. User can define a custom fieldName.
+   * 2. When using a custom fieldName, doing something like `schema[model].fields[field]` will not work.
+   *
+   */
+  getDefaultFieldName: ({
+    model,
+    field
+  }: {
+    model: string;
+    field: string;
+  }) => string;
+  /**
+   * Get the field attributes for a given model and field.
+   *
+   * Note: any model name or field name is allowed, whether default to schema or not.
+   */
+  getFieldAttributes: ({
+    model,
+    field
+  }: {
+    model: string;
+    field: string;
+  }) => DBFieldAttribute;
+  transformInput: (data: Record<string, any>, defaultModelName: string, action: "create" | "update", forceAllowId?: boolean) => Promise<Record<string, any>>;
+  transformOutput: (data: Record<string, any>, defaultModelName: string, select?: string[]) => Promise<Record<string, any>>;
+  transformWhereClause: <W extends Where$1[] | undefined>({
+    model,
+    where
+  }: {
+    where: W;
+    model: string;
+  }) => W extends undefined ? undefined : CleanedWhere[];
+}) => CustomAdapter;
+/**
+ * @deprecated Use `CustomAdapter` from `@faire-auth/core/db/adapter` instead.
+ */
+interface CustomAdapter extends Omit<CustomAdapter$1, "createSchema"> {
+  createSchema?: (props: {
+    /**
+     * The file the user may have passed in to the `generate` command as the expected schema file output path.
+     */
+    file?: string;
+    /**
+     * The tables from the user's Faire-Auth instance schema.
+     */
+    tables: FaireAuthDBSchema;
+  }) => Promise<AdapterSchemaCreation>;
+}
+/**
+ * @deprecated Use `CleanedWhere` from `@faire-auth/core/db/adapter` instead.
+ */
+type CleanedWhere = Prettify<Required<Where$1>>;
+type AdapterTestDebugLogs = {
+  resetDebugLogs: () => void;
+  printDebugLogs: () => void;
+};
+//#endregion
+//#region src/adapters/adapter-factory/index.d.ts
+type AdapterFactory = <O extends FaireAuthOptions$1>(options: O) => DBAdapter<O>;
+declare const createAdapterFactory: ({
+  adapter: customAdapter,
+  config: cfg
+}: AdapterFactoryOptions) => AdapterFactory;
+//#endregion
+//#region src/adapters/index.d.ts
+/**
+ * @deprecated Use `createAdapterFactory` instead. This export will be removed in the next major version.
+ */
+declare const createAdapter: ({
+  adapter: customAdapter,
+  config: cfg
+}: AdapterFactoryOptions) => AdapterFactory;
+/**
+ * @deprecated Use `AdapterFactoryOptions` instead. This export will be removed in the next major version.
+ */
+type CreateAdapterOptions = AdapterFactoryOptions;
+/**
+ * @deprecated Use `AdapterFactoryConfig` instead. This export will be removed in the next major version.
+ */
+type AdapterConfig = AdapterFactoryConfig;
+/**
+ * @deprecated Use `AdapterFactoryCustomizeAdapterCreator` instead. This export will be removed in the next major version.
+ */
+type CreateCustomAdapter = AdapterFactoryCustomizeAdapterCreator;
+//#endregion
+export { AdapterConfig, type AdapterFactory, type AdapterFactoryConfig, type AdapterFactoryCustomizeAdapterCreator, type AdapterFactoryOptions, type AdapterTestDebugLogs, CreateAdapterOptions, CreateCustomAdapter, type CustomAdapter, createAdapter, createAdapterFactory };

package/dist/adapters/index.mjs

@@ -0,0 +1,17 @@
+import "../crypto-CyQRFtkq.mjs";
+import "../json-B1v2qRTQ.mjs";
+import "../state-CqJfCIl9.mjs";
+import "../request-1NL_1lyJ.mjs";
+import "../utils-D4vZd1-9.mjs";
+import { t as createAdapterFactory } from "../adapter-factory-BXei1QRX.mjs";
+
+export * from "@faire-auth/core/db/adapter"
+
+//#region src/adapters/index.ts
+/**
+* @deprecated Use `createAdapterFactory` instead. This export will be removed in the next major version.
+*/
+const createAdapter = createAdapterFactory;
+
+//#endregion
+export { createAdapter, createAdapterFactory };

package/dist/adapters/kysely-adapter/index.cjs

@@ -0,0 +1,11 @@
+require('../../crypto-CcTxYH82.cjs');
+require('../../json-CcJ2HjGo.cjs');
+require('../../state--f7fwIGh.cjs');
+require('../../request-CPNlp-DK.cjs');
+require('../../utils-44aDDP8f.cjs');
+const require_kysely_adapter = require('../../kysely-adapter-Bxi7sPdG.cjs');
+require('../../adapter-factory-DT-_2aHJ.cjs');
+
+exports.createKyselyAdapter = require_kysely_adapter.createKyselyAdapter;
+exports.getKyselyDatabaseType = require_kysely_adapter.getKyselyDatabaseType;
+exports.kyselyAdapter = require_kysely_adapter.kyselyAdapter;

package/dist/adapters/kysely-adapter/index.d.cts

@@ -0,0 +1,52 @@
+import { I as FaireAuthOptions, Wt as KyselyDatabaseType } from "../../index-B-WeOMzg.cjs";
+import "../../hono-DOM31WQz.cjs";
+import { DBAdapter, DBAdapterDebugLogOption } from "@faire-auth/core/db/adapter";
+import { Kysely } from "kysely";
+
+//#region src/adapters/kysely-adapter/dialect.d.ts
+declare function getKyselyDatabaseType(db: FaireAuthOptions["database"]): KyselyDatabaseType | null;
+declare const createKyselyAdapter: (config: FaireAuthOptions) => {
+  kysely: Kysely<any> | null;
+  databaseType: KyselyDatabaseType | null;
+  transaction: undefined;
+  initialize(): Promise<void>;
+} | {
+  kysely: null;
+  databaseType: null;
+  transaction: undefined;
+} | {
+  kysely: Kysely<any>;
+  databaseType: "postgres" | "mysql" | "sqlite" | "mssql";
+  transaction: boolean | undefined;
+};
+//#endregion
+//#region src/adapters/kysely-adapter/kysely-adapter.d.ts
+interface KyselyAdapterConfig {
+  /**
+   * Database type.
+   */
+  type?: KyselyDatabaseType;
+  /**
+   * Enable debug logs for the adapter
+   *
+   * @default false
+   */
+  debugLogs?: DBAdapterDebugLogOption;
+  /**
+   * Use plural for table names.
+   *
+   * @default false
+   */
+  usePlural?: boolean;
+  /**
+   * Whether to execute multiple operations in a transaction.
+   *
+   * If the database doesn't support transactions,
+   * set this to `false` and operations will be executed sequentially.
+   * @default false
+   */
+  transaction?: boolean | undefined;
+}
+declare const kyselyAdapter: (db: Kysely<any> | Promise<Kysely<any>>, config?: KyselyAdapterConfig) => (options: FaireAuthOptions) => DBAdapter<FaireAuthOptions>;
+//#endregion
+export { KyselyDatabaseType, createKyselyAdapter, getKyselyDatabaseType, kyselyAdapter };

package/dist/adapters/kysely-adapter/index.d.mts

@@ -0,0 +1,52 @@
+import { I as FaireAuthOptions, Wt as KyselyDatabaseType } from "../../index-jlessPI0.mjs";
+import "../../hono-DuE14mmj.mjs";
+import { Kysely } from "kysely";
+import { DBAdapter, DBAdapterDebugLogOption } from "@faire-auth/core/db/adapter";
+
+//#region src/adapters/kysely-adapter/dialect.d.ts
+declare function getKyselyDatabaseType(db: FaireAuthOptions["database"]): KyselyDatabaseType | null;
+declare const createKyselyAdapter: (config: FaireAuthOptions) => {
+  kysely: Kysely<any> | null;
+  databaseType: KyselyDatabaseType | null;
+  transaction: undefined;
+  initialize(): Promise<void>;
+} | {
+  kysely: null;
+  databaseType: null;
+  transaction: undefined;
+} | {
+  kysely: Kysely<any>;
+  databaseType: "postgres" | "mysql" | "sqlite" | "mssql";
+  transaction: boolean | undefined;
+};
+//#endregion
+//#region src/adapters/kysely-adapter/kysely-adapter.d.ts
+interface KyselyAdapterConfig {
+  /**
+   * Database type.
+   */
+  type?: KyselyDatabaseType;
+  /**
+   * Enable debug logs for the adapter
+   *
+   * @default false
+   */
+  debugLogs?: DBAdapterDebugLogOption;
+  /**
+   * Use plural for table names.
+   *
+   * @default false
+   */
+  usePlural?: boolean;
+  /**
+   * Whether to execute multiple operations in a transaction.
+   *
+   * If the database doesn't support transactions,
+   * set this to `false` and operations will be executed sequentially.
+   * @default false
+   */
+  transaction?: boolean | undefined;
+}
+declare const kyselyAdapter: (db: Kysely<any> | Promise<Kysely<any>>, config?: KyselyAdapterConfig) => (options: FaireAuthOptions) => DBAdapter<FaireAuthOptions>;
+//#endregion
+export { KyselyDatabaseType, createKyselyAdapter, getKyselyDatabaseType, kyselyAdapter };

package/dist/adapters/kysely-adapter/index.mjs

@@ -0,0 +1,9 @@
+import "../../crypto-CyQRFtkq.mjs";
+import "../../json-B1v2qRTQ.mjs";
+import "../../state-CqJfCIl9.mjs";
+import "../../request-1NL_1lyJ.mjs";
+import "../../utils-D4vZd1-9.mjs";
+import { n as createKyselyAdapter, r as getKyselyDatabaseType, t as kyselyAdapter } from "../../kysely-adapter-DRuoT_X8.mjs";
+import "../../adapter-factory-BXei1QRX.mjs";
+
+export { createKyselyAdapter, getKyselyDatabaseType, kyselyAdapter };

package/dist/adapters/memory-adapter/index.cjs

@@ -0,0 +1,9 @@
+require('../../crypto-CcTxYH82.cjs');
+require('../../json-CcJ2HjGo.cjs');
+require('../../state--f7fwIGh.cjs');
+require('../../request-CPNlp-DK.cjs');
+require('../../utils-44aDDP8f.cjs');
+require('../../adapter-factory-DT-_2aHJ.cjs');
+const require_memory_adapter = require('../../memory-adapter-BlnDIAAX.cjs');
+
+exports.memoryAdapter = require_memory_adapter.memoryAdapter;

package/dist/adapters/memory-adapter/index.d.cts

@@ -0,0 +1,15 @@
+import { I as FaireAuthOptions } from "../../index-B-WeOMzg.cjs";
+import "../../hono-DOM31WQz.cjs";
+import { DBAdapterDebugLogOption } from "@faire-auth/core/db/adapter";
+import * as _faire_auth_core_db11 from "@faire-auth/core/db";
+
+//#region src/adapters/memory-adapter/memory-adapter.d.ts
+interface MemoryDB {
+  [key: string]: any[];
+}
+interface MemoryAdapterConfig {
+  debugLogs?: DBAdapterDebugLogOption;
+}
+declare const memoryAdapter: (db: MemoryDB, config?: MemoryAdapterConfig) => (options: FaireAuthOptions) => _faire_auth_core_db11.DBAdapter<FaireAuthOptions>;
+//#endregion
+export { MemoryAdapterConfig, MemoryDB, memoryAdapter };

package/dist/adapters/memory-adapter/index.d.mts

@@ -0,0 +1,15 @@
+import { I as FaireAuthOptions } from "../../index-jlessPI0.mjs";
+import "../../hono-DuE14mmj.mjs";
+import * as _faire_auth_core_db11 from "@faire-auth/core/db";
+import { DBAdapterDebugLogOption } from "@faire-auth/core/db/adapter";
+
+//#region src/adapters/memory-adapter/memory-adapter.d.ts
+interface MemoryDB {
+  [key: string]: any[];
+}
+interface MemoryAdapterConfig {
+  debugLogs?: DBAdapterDebugLogOption;
+}
+declare const memoryAdapter: (db: MemoryDB, config?: MemoryAdapterConfig) => (options: FaireAuthOptions) => _faire_auth_core_db11.DBAdapter<FaireAuthOptions>;
+//#endregion
+export { MemoryAdapterConfig, MemoryDB, memoryAdapter };

package/dist/adapters/memory-adapter/index.mjs

@@ -0,0 +1,9 @@
+import "../../crypto-CyQRFtkq.mjs";
+import "../../json-B1v2qRTQ.mjs";
+import "../../state-CqJfCIl9.mjs";
+import "../../request-1NL_1lyJ.mjs";
+import "../../utils-D4vZd1-9.mjs";
+import "../../adapter-factory-BXei1QRX.mjs";
+import { t as memoryAdapter } from "../../memory-adapter-Db3tsJTn.mjs";
+
+export { memoryAdapter };

package/dist/adapters/mongodb-adapter/index.cjs

@@ -0,0 +1,9 @@
+require('../../crypto-CcTxYH82.cjs');
+require('../../json-CcJ2HjGo.cjs');
+require('../../state--f7fwIGh.cjs');
+require('../../request-CPNlp-DK.cjs');
+require('../../utils-44aDDP8f.cjs');
+require('../../adapter-factory-DT-_2aHJ.cjs');
+const require_mongodb_adapter = require('../../mongodb-adapter-C_qfK87x.cjs');
+
+exports.mongodbAdapter = require_mongodb_adapter.mongodbAdapter;

package/dist/adapters/mongodb-adapter/index.d.cts

@@ -0,0 +1,4 @@
+import "../../index-B-WeOMzg.cjs";
+import "../../hono-DOM31WQz.cjs";
+import { n as mongodbAdapter, t as MongoDBAdapterConfig } from "../../index-C2-2QDyS.cjs";
+export { MongoDBAdapterConfig, mongodbAdapter };

package/dist/adapters/mongodb-adapter/index.d.mts

@@ -0,0 +1,4 @@
+import "../../index-jlessPI0.mjs";
+import "../../hono-DuE14mmj.mjs";
+import { n as mongodbAdapter, t as MongoDBAdapterConfig } from "../../index-to0RO38U.mjs";
+export { MongoDBAdapterConfig, mongodbAdapter };

package/dist/adapters/mongodb-adapter/index.mjs

@@ -0,0 +1,9 @@
+import "../../crypto-CyQRFtkq.mjs";
+import "../../json-B1v2qRTQ.mjs";
+import "../../state-CqJfCIl9.mjs";
+import "../../request-1NL_1lyJ.mjs";
+import "../../utils-D4vZd1-9.mjs";
+import "../../adapter-factory-BXei1QRX.mjs";
+import { t as mongodbAdapter } from "../../mongodb-adapter-C_qGQED5.mjs";
+
+export { mongodbAdapter };