@ja-platform/db 0.0.0-dev-20261113193343 → 0.0.0-stage

package/dist/@types/credentials/index.d.ts

@@ -1,2 +0,0 @@
-export * from './ApiCredentials';
-export * from './MobileCredentials';

package/dist/@types/database/Batch.d.ts

@@ -1,61 +0,0 @@
-import { PersistedObjectData } from '../types/ObjectData';
-import * as j from '../utils/JourneyPromise';
-import { DatabaseAdapter } from './adapters/DatabaseAdapter';
-import { Database } from './Database';
-import { DatabaseObject } from './DatabaseObject';
-export interface BatchError {
-    object: DatabaseObject;
-    operation: 'put' | 'patch' | 'delete' | 'ignore';
-    error: {
-        detail: string;
-    };
-}
-export interface ExecuteBatchOperation {
-    op: 'put' | 'patch' | 'delete' | 'ignore';
-    type: string;
-    id: string;
-    object: DatabaseObject;
-    data?: PersistedObjectData;
-    patch?: PersistedObjectData;
-}
-export interface ExecuteBatchResult {
-    error?: any;
-}
-export declare class Batch {
-    /**
-     * Construct a new batch.
-     *
-     * If the same object is added to the batch multiple times, only the last instance
-     * is kept.
-     *
-     * @param adapter the Database instance
-     */
-    constructor(adapter: DatabaseAdapter | Database);
-    /**
-     * Add an object to save to the batch. The object is saved when batch.execute() is called.
-     */
-    save(object: DatabaseObject): void;
-    /**
-     * Add an object to destroy to the batch. The object is destroyed when batch.execute() is called.
-     */
-    destroy(object: DatabaseObject): void;
-    /**
-     * Execute the batch.
-     *
-     * There are two classes of errors:
-     * 1. Network or code error. The entire batch is rejected with an error.
-     * 2. Individual object errors. In this case, the batch is rejected with a CrudError, which contains the individual errors.
-     */
-    execute(): j.Promise<void>;
-    private _getOps;
-}
-export declare class CrudError extends Error {
-    errors: BatchError[];
-    constructor(errors: BatchError[]);
-    /**
-     * Return the first error. Useful if this was used for a single operation.
-     */
-    firstError(): {
-        detail: string;
-    };
-}

package/dist/@types/database/Collection.d.ts

@@ -1,85 +0,0 @@
-import { DatabaseObject } from './DatabaseObject';
-import { SchemaModelType } from '@ja-platform/parser-schema';
-import { DatabaseAdapter } from './adapters/DatabaseAdapter';
-import { Query } from '../query/Query';
-import * as j from '../utils/JourneyPromise';
-export declare class Collection<T extends DatabaseObject = DatabaseObject> {
-    type: SchemaModelType;
-    adapter: DatabaseAdapter;
-    constructor(adapter: DatabaseAdapter, type: SchemaModelType);
-    /**
-     * Query for all objects in the collection. The query may be filtered further.
-     *
-     * Return the results as a Query. Call `.toArray()` to get the results.
-     */
-    all(): Query<T>;
-    /**
-     * Create a new object.
-     *
-     * It is not saved until .save() is called.
-     *
-     * @param attributes - Enumerable object to initialize with.
-     */
-    create(attributes?: any): T;
-    /**
-     * Filter by a query string and arguments.
-     *
-     * Return the results as a Query. Call `.toArray()` to get the results.
-     *
-     *
-     * Example:
-     *
-     *    DB.user.where('email = ? and archived != ?', email, false)
-     *
-     * @param query the query string
-     * @param args the query args
-     */
-    where(query: string, ...args: any[]): Query<T>;
-    /**
-     * Filter by an object of {attribute: value} pairs.
-     *
-     * Return the results as a Query. Call `.toArray()` to get the results.
-     *
-     * @param filters an object of {field: value}
-     */
-    where(filters: {
-        [key: string]: any;
-    }): Query<T>;
-    /**
-     * Same as .all()
-     */
-    where(): Query<T>;
-    private _first;
-    /**
-     * Get a single object by id.
-     */
-    first(id: string): j.Promise<T>;
-    /**
-     * Get a single object by query.
-     *
-     * If the query has more than one matching result, only the first seen one is returned.
-     *
-     * Same as .where(...).first().
-     *
-     * @param query the query string
-     * @param args the query args
-     */
-    first(query: string, ...args: any[]): j.Promise<T>;
-    /**
-     * Return a single object from the collection.
-     */
-    first(): j.Promise<T>;
-    /**
-     * Get a single object by query.
-     *
-     * If the query has more than one matching result, only the first seen one is returned.
-     *
-     * Same as .where(...).first().
-     *
-     * @param filters an object of {field: value}
-     */
-    first(filters: {
-        [key: string]: any;
-    }): j.Promise<T>;
-}
-export type TypedCollection<T> = Collection<DatabaseObject & T>;

package/dist/@types/database/Database.d.ts

@@ -1,22 +0,0 @@
-import { ApiCredentialOptions } from '../credentials';
-import { DatabaseAdapter } from './adapters/DatabaseAdapter';
-import { Collection, TypedCollection } from './Collection';
-import { Batch } from './Batch';
-import { DatabaseObject } from './DatabaseObject';
-import { Query } from '../query/Query';
-import { DBSchema as Schema } from '../Schema';
-export declare class Database {
-    /**
-     * Convenience factory method for getting a Database Object
-     */
-    static instance(options: ApiCredentialOptions): Promise<Database>;
-    Batch: new () => Batch;
-    schema: Schema;
-    static getTypedDatabase<T extends {
-        [key: string]: {};
-    }, U = {
-        [K in keyof T]?: TypedCollection<T[K]>;
-    }>(schema: Schema, adapter: DatabaseAdapter): Database & U;
-    constructor(schema: Schema, adapter: DatabaseAdapter);
-}
-export { Collection, DatabaseObject, Query };

package/dist/@types/database/DatabaseObject.d.ts

@@ -1,51 +0,0 @@
-import { SchemaModelType } from '@ja-platform/parser-schema';
-import * as j from '../utils/JourneyPromise';
-import { DatabaseAdapter } from './adapters/DatabaseAdapter';
-export declare class DatabaseObject {
-    /**
-     * ID of the object, generated when the object is first created.
-     */
-    readonly id: string;
-    readonly type: SchemaModelType;
-    /**
-     * true if this object has ben saved to the database.
-     */
-    persisted: boolean;
-    /**
-     * Read a field or resolve a relationship.
-     */
-    _get: (name: string) => Promise<any>;
-    /**
-     * Read a field or cached relationship, returning undefined while it loads.
-     */
-    _cached: (name: string) => any;
-    /**
-     * Set a declared field or belongs-to relationship.
-     */
-    _set: (name: string, value: any) => void;
-    /**
-     * Set all values provided in an enumerable object.
-     *
-     * @param values - the values to set
-     */
-    setAll: (values?: any) => void;
-    private _reload;
-    private _save;
-    private _destroy;
-    constructor(adapter: DatabaseAdapter, type: SchemaModelType, id: string);
-    /**
-     * Reload this object from the database.
-     */
-    reload(): j.Promise<void>;
-    /**
-     * Save this object to the database.
-     */
-    save(): j.Promise<void>;
-    /**
-     * Delete this object from the database.
-     */
-    destroy(): j.Promise<void>;
-}
-export type CreateAccessor = (name: string, set: (name: string, value: any) => void, get: (name: string) => any) => void;
-export declare var createAccessor: CreateAccessor;
-export declare function setCreateAccessor(fn: CreateAccessor): void;

package/dist/@types/database/GenericDatabase.d.ts

@@ -1,4 +0,0 @@
-import { Collection } from './Collection';
-export interface GenericDatabase {
-    [key: string]: Collection;
-}

package/dist/@types/database/JourneyAPIAdapter.d.ts

@@ -1,45 +0,0 @@
-import 'isomorphic-fetch';
-import type { RequestInit } from 'node-fetch';
-import { BaseAdapter } from './adapters/BaseAdapter';
-import { SchemaModelType } from '@ja-platform/parser-schema';
-import { Query } from '../query/Query';
-import { ExecuteBatchOperation } from './Batch';
-import { ObjectData } from '../types/ObjectData';
-import { ApiCredentials } from '../credentials';
-import { DBSchema } from '../Schema';
-export type { Response, RequestInit } from 'node-fetch';
-export interface ApiObjectData extends ObjectData {
-    _updated_at?: string;
-    display?: string;
-}
-export interface ApiAdapterOptions {
-    fetch?: RequestInit;
-}
-export declare class JourneyAPIAdapter extends BaseAdapter {
-    static apiToInternalFormat(type: SchemaModelType, apiObj: any): ApiObjectData;
-    name: string;
-    serializeOptions: {
-        inlineAttachments: boolean;
-    };
-    schema: DBSchema;
-    options: ApiAdapterOptions;
-    credentials: ApiCredentials;
-    constructor(credentials: ApiCredentials, schema: DBSchema, options?: ApiAdapterOptions);
-    description(): string;
-    executeQuery(query: Query): Promise<ObjectData[]>;
-    get(type: string, id: string): Promise<ObjectData>;
-    getAll(type: string, ids: string[]): Promise<ObjectData[]>;
-    private getIdBatch;
-    applyBatch(crud: ExecuteBatchOperation[]): Promise<any[]>;
-    loadDataModel(): Promise<void>;
-    apiGet(url: string): Promise<any>;
-    private apiPost;
-    /**
-     * Post crud actions.
-     *
-     * @param {*} actions - array of actions
-     */
-    private postCrud;
-    private doApiQuery;
-    private executeQueryGetMore;
-}

package/dist/@types/database/ObjectDisplayScope.d.ts

@@ -1,22 +0,0 @@
-import type { ReferencePath } from '@ja-platform/parser-expressions';
-import type { SchemaObjectDisplayExpression } from '@ja-platform/parser-schema';
-import { Type } from '@ja-platform/parser-type-system';
-import type { Formatter } from '@ja-platform/parser-type-system';
-export declare class ObjectDisplayScope {
-    readonly object: unknown;
-    private readonly formatterFor?;
-    static getValue(object: unknown, expression: string | ReferencePath, depth?: number): any;
-    static getValuePromise(object: unknown, expression: string | ReferencePath, depth?: number): Promise<any>;
-    static retrieveValue(object: unknown, expression: string | readonly (string | number)[], depth: number, isPromise: boolean): any;
-    static promise(object: unknown, name: string): Promise<unknown>;
-    static cached(object: unknown, name: string): unknown;
-    constructor(object: unknown, formatterFor?: (type: Type) => Formatter);
-    /**
-     * Render available fields, returning null while a referenced value is loading.
-     */
-    evaluate(expression: SchemaObjectDisplayExpression): string | null;
-    getExpressionFormatter(path: ReferencePath): Formatter | null;
-    getExpressionType(path: ReferencePath): Type | null;
-    getValue(expression: string | ReferencePath): any;
-    getValuePromise(expression: string | ReferencePath): Promise<any>;
-}

package/dist/@types/database/OnlineDB.d.ts

@@ -1,8 +0,0 @@
-import { ApiAdapterOptions } from './JourneyAPIAdapter';
-import { ApiCredentialOptions } from '../credentials/ApiCredentials';
-import { Database } from './Database';
-export interface OnlineDBCredentials extends ApiCredentialOptions {
-    adapter?: ApiAdapterOptions;
-    dataModelPath?: string;
-}
-export declare function OnlineDB(options: OnlineDBCredentials): Database;

package/dist/@types/database/adapters/BaseAdapter.d.ts

@@ -1,26 +0,0 @@
-import { Query } from '../../query/Query';
-import { ObjectData } from '../../types/ObjectData';
-import { ExecuteBatchOperation } from '../Batch';
-import { DatabaseAdapter } from './DatabaseAdapter';
-export declare abstract class BaseAdapter implements DatabaseAdapter {
-    static logQuery(...args: any[]): any;
-    batchLimit: number;
-    closed: boolean;
-    adapterName: string;
-    promise: Promise<void>;
-    name: string;
-    protected constructor();
-    description(): string;
-    open(): Promise<void>;
-    abstract get(type: string, id: string): Promise<ObjectData>;
-    /**
-     * Lookup a an array of IDs. Returns a promise that is resolved with an array of object data.
-     */
-    getAll(type: string, ids: string[]): Promise<ObjectData[]>;
-    count(query: Query): Promise<number>;
-    close(): void;
-    ensureOpen(): void;
-    explain(query: Query): Promise<any>;
-    abstract applyBatch(ops: ExecuteBatchOperation[]): Promise<any[]>;
-    abstract executeQuery(query: Query): Promise<ObjectData[]>;
-}

package/dist/@types/database/adapters/DatabaseAdapter.d.ts

@@ -1,22 +0,0 @@
-import { Type } from '@ja-platform/parser-type-system';
-import { TypeOperations, ValueSerializeOptions } from '../../types/TypeOperations';
-import { Query } from '../../query/Query';
-import { ObjectData } from '../../types/ObjectData';
-import { ExecuteBatchOperation, ExecuteBatchResult } from '../Batch';
-export interface DatabaseAdapter {
-    operationsFor?(type: Type): TypeOperations;
-    batchLimit: number;
-    name: string;
-    serializeOptions?: ValueSerializeOptions;
-    description(): string;
-    applyBatch(ops: ExecuteBatchOperation[]): Promise<ExecuteBatchResult[]>;
-    /**
-     * Lookup an object. Returns a promise that is resolved with the object data, or null if not found.
-     */
-    get(type: string, id: string): Promise<ObjectData>;
-    close(): void;
-    executeQuery(query: Query): Promise<ObjectData[]>;
-    explain(query: Query): Promise<any>;
-    count(query: Query): Promise<number>;
-    getAll(type: string, ids: string[]): Promise<ObjectData[]>;
-}

package/dist/@types/database/adapters/WebSQLAdapter.d.ts

@@ -1,50 +0,0 @@
-import { BaseAdapter } from './BaseAdapter';
-import { Query } from '../../query/Query';
-import { ObjectData } from '../../types/ObjectData';
-import { DatabaseAdapter } from './DatabaseAdapter';
-import { ExecuteBatchOperation } from '../Batch';
-export interface ExplainedResult {
-    type: 'index' | 'full scan';
-    results: number;
-    scanned: number;
-    data: ObjectData[];
-    duration?: number;
-}
-export declare class WebSQLAdapter extends BaseAdapter implements DatabaseAdapter {
-    static adapterName: string;
-    static supportsDiagnostics: boolean;
-    /**
-     * Clear the database. Returns a promise that is resolved when the database is cleared.
-     */
-    static clear(keepCrud?: boolean): Promise<[unknown, unknown]>;
-    private db;
-    batchLimit: number;
-    constructor(options: any);
-    description(): string;
-    applyCrud(crud: any[]): Promise<{
-        updatedIds: string[];
-    }>;
-    /**
-     * Apply a batch of operations in a single transaction.
-     *
-     * The entire batch is either successful or not - we don't return errors for
-     * individual objects.
-     */
-    applyBatch(crud: ExecuteBatchOperation[]): Promise<any[]>;
-    /**
-     * Perform a query.
-     * Returns a promise that is resolved with the resultset.
-     */
-    executeQuery(query: Query): Promise<ObjectData[]>;
-    explain(query: Query): Promise<ExplainedResult>;
-    executeTableScan(query: Query): Promise<ExplainedResult>;
-    get(type: string, id: string): Promise<ObjectData>;
-    getAll(type: string, ids: string[]): Promise<ObjectData[]>;
-    estimateBytesUsed(): Promise<number>;
-    openDatabase(name: string): any;
-    private promisedTransaction;
-    private simpleQuery;
-    private transactionSaveData;
-    private transactionDestroy;
-    private logError;
-}

package/dist/@types/index.d.ts

@@ -1,2 +0,0 @@
-export * from './browser';
-export * from './database/OnlineDB';

package/dist/@types/query/InternalQuery.d.ts

@@ -1,17 +0,0 @@
-import { DatabaseAdapter } from '../database/adapters/DatabaseAdapter';
-import { Query } from './Query';
-import { Expression } from './queryOperations';
-import { DatabaseObject } from '../database/DatabaseObject';
-import { ObjectData } from '../types/ObjectData';
-import { SchemaModelType } from '@ja-platform/parser-schema';
-export interface InternalQuery<T extends DatabaseObject = DatabaseObject> extends Query<T> {
-    readonly adapter: DatabaseAdapter;
-    readonly type: SchemaModelType;
-    expression: Expression;
-    ordering: any[];
-    limitNumber: number;
-    skipNumber: number;
-    _fetch(): Promise<T[]>;
-    _filter(data: ObjectData[]): ObjectData[];
-    _sort(data: ObjectData[]): ObjectData[];
-}

package/dist/@types/query/Query.d.ts

@@ -1,133 +0,0 @@
-import { RelationshipHash } from './getPreloadRelationships';
-import { DatabaseAdapter } from '../database/adapters/DatabaseAdapter';
-import { Expression } from './queryOperations';
-import { DatabaseObject } from '../database/DatabaseObject';
-import { FormatStringExpression } from '@ja-platform/parser-expressions';
-import * as j from '../utils/JourneyPromise';
-import { SchemaModelType } from '@ja-platform/parser-schema';
-export declare class Query<T extends DatabaseObject = DatabaseObject> {
-    readonly type: SchemaModelType;
-    static isQuery(value: any): boolean;
-    constructor(adapter: DatabaseAdapter, type: SchemaModelType, expression?: Expression, ordering?: any[]);
-    private _reload;
-    private _explain;
-    _fetchWithDisplay(columns?: FormatStringExpression[] | Record<string, FormatStringExpression>): Promise<T[]>;
-    /**
-     * Apply additional query filters, as a new query.
-     *
-     * @param query the query string
-     * @param args query arguments
-     */
-    where(query: string, ...args: any[]): Query<T>;
-    /**
-     * Apply additional filters, as a new query.
-     *
-     * @param filters an object of {field: value}
-     */
-    where(filters?: any): Query<T>;
-    /**
-     * Return a copy of this query.
-     */
-    where(): Query<T>;
-    private order_by;
-    /**
-     * Limit the maximum number of results returned by the query.
-     *
-     * A new query is returned - the original one is not modified.
-     *
-     * @param n maximum number of results
-     */
-    limit(n: number): Query<T>;
-    /**
-     * Skip the first n results in the query. Typically used together with limit() for pagination.
-     *
-     * A new query is returned - the original one is not modified.
-     *
-     * @param n number of results to skip.
-     */
-    skip(n: number): Query<T>;
-    /**
-     * Pre-load belongs-to relationships when executing the query.
-     *
-     * This allows the implementation to batch the lookups, which is faster than loading each related
-     * object individually.
-     *
-     * Nested belongs-to relationships are supported by using dots, e.g. `.include('owner.region')`.
-     *
-     * A new query is returned - the original one is not modified.
-     *
-     * @param relationships belongs-to names
-     */
-    include(...relationships: string[]): Query<T>;
-    private _destroy_all;
-    private _count;
-    /**
-     * Execute the query and return the results.
-     */
-    toArray(): j.Promise<T[]>;
-    /**
-     * Apply additional filters, then return the first result.
-     *
-     * @param filters an object of {attribute: value}
-     */
-    first(filters?: {
-        [key: string]: any;
-    }): j.Promise<T | null>;
-    /**
-     * Apply additional query filters, then return the first result.
-     *
-     * Same as .where(...).first().
-     *
-     * @param query the query string
-     * @param args query arguments
-     */
-    first(query: string, ...args: any[]): j.Promise<T | null>;
-    /**
-     * Return the first result matched by this query.
-     */
-    first(): j.Promise<T | null>;
-    /**
-     * Return the number of results matched by the query.
-     *
-     * If .limit() was used, it would be respected for the count.
-     */
-    count(): j.Promise<number>;
-    /**
-     * Return executions stats for the query.
-     *
-     * The format of the results is not fixed, and may change across versions.
-     * For debugging use only.
-     */
-    explain(): j.Promise<any>;
-    /**
-     * Destroy all objects matched by this query.
-     *
-     * skip() and limit() is respected for this.
-     */
-    destroyAll(): j.Promise<void>;
-    private _toArray;
-    private _first;
-    private _destroyAll;
-    /**
-     * Order by one or more attributes.
-     *
-     * A new query is returned - the original one is not modified.
-     *
-     * @param fields an array of field names to order by. Prefix with - for descending, e.g. `-updated_at`.
-     */
-    orderBy(...fields: string[]): Query<T>;
-    /**
-     * For debugging purposes only.
-     *
-     * The format of the result is not defined.
-     */
-    toJSON(): {
-        type: string;
-        expression: Expression;
-        ordering: any[];
-        limit: number;
-        skip: number;
-        include: RelationshipHash;
-    };
-    private _includeInternal;
-}

package/dist/@types/query/getPreloadRelationships.d.ts

@@ -1,9 +0,0 @@
-import { AbstractFormatExpression } from '@ja-platform/parser-expressions';
-import { SchemaModelType } from '@ja-platform/parser-schema';
-export interface RelationshipHash {
-    [key: string]: RelationshipHash;
-}
-/**
- * Collect relationships needed by query displays, including related models' displays.
- */
-export declare function getPreloadRelationships(type: SchemaModelType, columns?: AbstractFormatExpression<any>[] | Record<string, AbstractFormatExpression<any>>): RelationshipHash;

package/dist/@types/query/queryOperations.d.ts

@@ -1,87 +0,0 @@
-import { SchemaModelType, Field } from '@ja-platform/parser-schema';
-import { ObjectData } from '../types/ObjectData';
-export declare function expressionFromHash(scopeType: SchemaModelType, hash: any): Expression;
-export interface Expression {
-    normalize(): NormalizedExpression;
-    evaluate(object: Partial<ObjectData>): boolean;
-    toOriginalExpression(): any[];
-}
-export declare class Operation implements Expression {
-    attribute: Field;
-    operator: string;
-    value: any;
-    constructor(attribute: Field, operator: string, value: any);
-    normalize(): NormalizedExpression;
-    attributes(): Field<import("@ja-platform/parser-type-system").Type<any>>[];
-    evaluate(object: Partial<ObjectData>): boolean;
-    toString(): string;
-    toOriginalExpression(): any[];
-}
-export declare class RelationMatch implements Expression {
-    name: string;
-    id: string;
-    constructor(name: string, id: string);
-    normalize(): OrExpression<AndExpression>;
-    evaluate(object: Partial<ObjectData>): boolean;
-    toString(): string;
-    toOriginalExpression(): string[];
-}
-export declare class AndExpression implements Expression {
-    operands: Expression[];
-    constructor(operands: Expression[]);
-    join(otherAnd: AndExpression): AndExpression;
-    normalize(): any;
-    evaluate(object: Partial<ObjectData>): boolean;
-    toString(): string;
-    toOriginalExpression(): any[];
-}
-export declare class OrExpression<T extends Expression = Expression> implements Expression {
-    operands: T[];
-    constructor(operands: T[]);
-    normalize(): OrExpression<AndExpression>;
-    evaluate(object: Partial<ObjectData>): boolean;
-    toString(): string;
-    toOriginalExpression(): any[];
-}
-export type NormalizedExpression = OrExpression<AndExpression>;
-export declare class TrueExpression implements Expression {
-    constructor();
-    normalize(): OrExpression<AndExpression>;
-    evaluate(object: ObjectData): boolean;
-    toString(): string;
-    toOriginalExpression(): string[];
-}
-export declare class Tokenizer {
-    expression: string;
-    i: number;
-    previousPosition: number;
-    private interpolatorCount;
-    constructor(expression: string);
-    exception(message: string, start?: number, end?: number): Error;
-    isWordSeparator(p: number): boolean;
-    isWord(): boolean;
-    hasMore(): boolean;
-    readOperator(): string;
-    readBooleanLogic(): string;
-    isOr(): boolean;
-    isAnd(): boolean;
-    isParenthesis(): boolean;
-    readParenthesis(): string;
-    readInterpolator(): number;
-    readWord(): string;
-    private advance;
-    private checkBuffer;
-    private readToken;
-    private isToken;
-}
-export declare class Parser {
-    private scopeType;
-    private tokenizer;
-    private args;
-    constructor(scopeType: SchemaModelType, tokenizer: Tokenizer, args: any[]);
-    parse(): Expression;
-    private parseOrExpression;
-    private parseAndExpression;
-    private parseTerm;
-}
-export declare function parse(scopeType: SchemaModelType, expression: string, args: any[]): Expression;