@onyx.dev/onyx-database 0.3.0 → 1.0.2

package/dist/index.d.cts

@@ -743,7 +743,7 @@ interface ICascadeBuilder<Schema = Record<string, unknown>> {
      * await db.cascade('permissions').delete('Role', 'admin');
      * ```
      */
-    delete<Table extends keyof Schema & string>(table: Table, primaryKey: string): Promise<Schema[Table]>;
+    delete<Table extends keyof Schema & string>(table: Table, primaryKey: string): Promise<boolean>;
 }
 /** Builder for describing cascade relationship metadata. */
 interface ICascadeRelationshipBuilder {
@@ -970,11 +970,12 @@ interface IOnyxDatabase<Schema = Record<string, unknown>> {
      * @param table Table containing the entity.
      * @param primaryKey Primary key value.
      * @param options Optional partition and cascade relationships.
+     * @returns `true` when the delete request succeeds.
      */
-    delete<Table extends keyof Schema & string, T = Schema[Table]>(table: Table, primaryKey: string, options?: {
+    delete<Table extends keyof Schema & string>(table: Table, primaryKey: string, options?: {
         partition?: string;
         relationships?: string[];
-    }): Promise<T>;
+    }): Promise<boolean>;
     /**
      * Store a document (file blob) for later retrieval.
      *
@@ -1030,6 +1031,18 @@ interface IOnyxDatabase<Schema = Record<string, unknown>> {
      * Retrieve the schema revision history for the configured database.
      */
     getSchemaHistory(): Promise<SchemaHistoryEntry[]>;
+    /**
+     * Compare the current API schema with a local schema definition.
+     *
+     * @example
+     * ```ts
+     * const diff = await db.diffSchema(localSchema);
+     * if (!diff.newTables.length && !diff.removedTables.length && !diff.changedTables.length) {
+     *   console.log('Schemas match');
+     * }
+     * ```
+     */
+    diffSchema(localSchema: SchemaUpsertRequest): Promise<SchemaDiff>;
     /**
      * Update the schema for the configured database.
      *
@@ -1148,16 +1161,19 @@ interface SchemaIndex {
     name: string;
     type?: SchemaIndexType;
     minimumScore?: number;
+    [key: string]: unknown;
 }
 interface SchemaResolver {
     name: string;
     resolver: string;
+    [key: string]: unknown;
 }
 type SchemaTriggerEvent = 'PreInsert' | 'PostInsert' | 'PrePersist' | 'PostPersist' | 'PreUpdate' | 'PostUpdate' | 'PreDelete' | 'PostDelete' | string;
 interface SchemaTrigger {
     name: string;
     event: SchemaTriggerEvent;
     trigger: string;
+    [key: string]: unknown;
 }
 interface SchemaEntity {
     name: string;
@@ -1167,21 +1183,25 @@ interface SchemaEntity {
     indexes?: SchemaIndex[];
     resolvers?: SchemaResolver[];
     triggers?: SchemaTrigger[];
+    [key: string]: unknown;
 }
 interface SchemaRevisionMetadata {
     revisionId?: string;
     createdAt?: Date;
     publishedAt?: Date;
+    [key: string]: unknown;
 }
 interface SchemaRevision {
     databaseId: string;
     revisionDescription?: string;
     entities: SchemaEntity[];
     meta?: SchemaRevisionMetadata;
+    [key: string]: unknown;
 }
 type SchemaHistoryEntry = SchemaRevision;
 type SchemaUpsertRequest = Omit<SchemaRevision, 'databaseId' | 'meta'> & {
     databaseId?: string;
+    [key: string]: unknown;
 };
 interface SchemaValidationResult {
     valid?: boolean;
@@ -1190,6 +1210,68 @@ interface SchemaValidationResult {
         message: string;
     }>;
 }
+interface SchemaAttributeChange {
+    name: string;
+    from: {
+        type?: string;
+        isNullable?: boolean;
+    };
+    to: {
+        type?: string;
+        isNullable?: boolean;
+    };
+}
+interface SchemaIndexChange {
+    name: string;
+    from: SchemaIndex;
+    to: SchemaIndex;
+}
+interface SchemaResolverChange {
+    name: string;
+    from: SchemaResolver;
+    to: SchemaResolver;
+}
+interface SchemaTriggerChange {
+    name: string;
+    from: SchemaTrigger;
+    to: SchemaTrigger;
+}
+interface SchemaTableDiff {
+    name: string;
+    partition?: {
+        from: string | null;
+        to: string | null;
+    } | null;
+    identifier?: {
+        from: SchemaIdentifier | null;
+        to: SchemaIdentifier | null;
+    } | null;
+    attributes?: {
+        added: SchemaAttribute[];
+        removed: string[];
+        changed: SchemaAttributeChange[];
+    };
+    indexes?: {
+        added: SchemaIndex[];
+        removed: string[];
+        changed: SchemaIndexChange[];
+    };
+    resolvers?: {
+        added: SchemaResolver[];
+        removed: string[];
+        changed: SchemaResolverChange[];
+    };
+    triggers?: {
+        added: SchemaTrigger[];
+        removed: string[];
+        changed: SchemaTriggerChange[];
+    };
+}
+interface SchemaDiff {
+    newTables: string[];
+    removedTables: string[];
+    changedTables: SchemaTableDiff[];
+}
 
 /** -------------------------
  * Facade export
@@ -1287,8 +1369,12 @@ declare class ConditionBuilderImpl implements IConditionBuilder {
 
 declare const eq: (field: string, value: unknown) => ConditionBuilderImpl;
 declare const neq: (field: string, value: unknown) => ConditionBuilderImpl;
-declare const inOp: (field: string, values: unknown[] | string) => ConditionBuilderImpl;
-declare const notIn: (field: string, values: unknown[]) => ConditionBuilderImpl;
+declare function inOp(field: string, values: string): ConditionBuilderImpl;
+declare function inOp<T>(field: string, values: unknown[] | IQueryBuilder<T>): ConditionBuilderImpl;
+declare function within<T>(field: string, values: string | unknown[] | IQueryBuilder<T>): ConditionBuilderImpl;
+declare function notIn(field: string, values: string): ConditionBuilderImpl;
+declare function notIn<T>(field: string, values: unknown[] | IQueryBuilder<T>): ConditionBuilderImpl;
+declare function notWithin<T>(field: string, values: string | unknown[] | IQueryBuilder<T>): ConditionBuilderImpl;
 declare const between: (field: string, lower: unknown, upper: unknown) => ConditionBuilderImpl;
 declare const gt: (field: string, value: unknown) => ConditionBuilderImpl;
 declare const gte: (field: string, value: unknown) => ConditionBuilderImpl;
@@ -1324,4 +1410,4 @@ declare const percentile: (attribute: string, p: number) => string;
 declare const sdkName = "@onyx.dev/onyx-database";
 declare const sdkVersion = "0.1.0";
 
-export { type FetchImpl, type FetchResponse, type ICascadeBuilder, type ICascadeRelationshipBuilder, type IConditionBuilder, type IOnyxDatabase, type IQueryBuilder, type ISaveBuilder, type LogicalOperator, type OnyxConfig, type OnyxDocument, type OnyxFacade, type QueryCondition, type QueryCriteria, type QueryCriteriaOperator, type QueryPage, QueryResults, type QueryResultsPromise, type SchemaAttribute, type SchemaDataType, type SchemaEntity, type SchemaHistoryEntry, type SchemaIdentifier, type SchemaIdentifierGenerator, type SchemaIndex, type SchemaIndexType, type SchemaResolver, type SchemaRevision, type SchemaRevisionMetadata, type SchemaTrigger, type SchemaTriggerEvent, type SchemaUpsertRequest, type SchemaValidationResult, type SecretMetadata, type SecretRecord, type SecretSaveRequest, type SecretsListResponse, type SelectQuery, type Sort, type StreamAction, type UpdateQuery, asc, avg, between, contains, containsIgnoreCase, count, desc, eq, gt, gte, inOp, isNull, like, lower, lt, lte, matches, max, median, min, neq, notContains, notContainsIgnoreCase, notIn, notLike, notMatches, notNull, notStartsWith, onyx, percentile, replace, sdkName, sdkVersion, startsWith, std, substring, sum, upper, variance };
+export { type FetchImpl, type FetchResponse, type ICascadeBuilder, type ICascadeRelationshipBuilder, type IConditionBuilder, type IOnyxDatabase, type IQueryBuilder, type ISaveBuilder, type LogicalOperator, type OnyxConfig, type OnyxDocument, type OnyxFacade, type QueryCondition, type QueryCriteria, type QueryCriteriaOperator, type QueryPage, QueryResults, type QueryResultsPromise, type SchemaAttribute, type SchemaAttributeChange, type SchemaDataType, type SchemaDiff, type SchemaEntity, type SchemaHistoryEntry, type SchemaIdentifier, type SchemaIdentifierGenerator, type SchemaIndex, type SchemaIndexChange, type SchemaIndexType, type SchemaResolver, type SchemaResolverChange, type SchemaRevision, type SchemaRevisionMetadata, type SchemaTableDiff, type SchemaTrigger, type SchemaTriggerChange, type SchemaTriggerEvent, type SchemaUpsertRequest, type SchemaValidationResult, type SecretMetadata, type SecretRecord, type SecretSaveRequest, type SecretsListResponse, type SelectQuery, type Sort, type StreamAction, type UpdateQuery, asc, avg, between, contains, containsIgnoreCase, count, desc, eq, gt, gte, inOp, isNull, like, lower, lt, lte, matches, max, median, min, neq, notContains, notContainsIgnoreCase, notIn, notLike, notMatches, notNull, notStartsWith, notWithin, onyx, percentile, replace, sdkName, sdkVersion, startsWith, std, substring, sum, upper, variance, within };

package/dist/index.d.ts

@@ -743,7 +743,7 @@ interface ICascadeBuilder<Schema = Record<string, unknown>> {
      * await db.cascade('permissions').delete('Role', 'admin');
      * ```
      */
-    delete<Table extends keyof Schema & string>(table: Table, primaryKey: string): Promise<Schema[Table]>;
+    delete<Table extends keyof Schema & string>(table: Table, primaryKey: string): Promise<boolean>;
 }
 /** Builder for describing cascade relationship metadata. */
 interface ICascadeRelationshipBuilder {
@@ -970,11 +970,12 @@ interface IOnyxDatabase<Schema = Record<string, unknown>> {
      * @param table Table containing the entity.
      * @param primaryKey Primary key value.
      * @param options Optional partition and cascade relationships.
+     * @returns `true` when the delete request succeeds.
      */
-    delete<Table extends keyof Schema & string, T = Schema[Table]>(table: Table, primaryKey: string, options?: {
+    delete<Table extends keyof Schema & string>(table: Table, primaryKey: string, options?: {
         partition?: string;
         relationships?: string[];
-    }): Promise<T>;
+    }): Promise<boolean>;
     /**
      * Store a document (file blob) for later retrieval.
      *
@@ -1030,6 +1031,18 @@ interface IOnyxDatabase<Schema = Record<string, unknown>> {
      * Retrieve the schema revision history for the configured database.
      */
     getSchemaHistory(): Promise<SchemaHistoryEntry[]>;
+    /**
+     * Compare the current API schema with a local schema definition.
+     *
+     * @example
+     * ```ts
+     * const diff = await db.diffSchema(localSchema);
+     * if (!diff.newTables.length && !diff.removedTables.length && !diff.changedTables.length) {
+     *   console.log('Schemas match');
+     * }
+     * ```
+     */
+    diffSchema(localSchema: SchemaUpsertRequest): Promise<SchemaDiff>;
     /**
      * Update the schema for the configured database.
      *
@@ -1148,16 +1161,19 @@ interface SchemaIndex {
     name: string;
     type?: SchemaIndexType;
     minimumScore?: number;
+    [key: string]: unknown;
 }
 interface SchemaResolver {
     name: string;
     resolver: string;
+    [key: string]: unknown;
 }
 type SchemaTriggerEvent = 'PreInsert' | 'PostInsert' | 'PrePersist' | 'PostPersist' | 'PreUpdate' | 'PostUpdate' | 'PreDelete' | 'PostDelete' | string;
 interface SchemaTrigger {
     name: string;
     event: SchemaTriggerEvent;
     trigger: string;
+    [key: string]: unknown;
 }
 interface SchemaEntity {
     name: string;
@@ -1167,21 +1183,25 @@ interface SchemaEntity {
     indexes?: SchemaIndex[];
     resolvers?: SchemaResolver[];
     triggers?: SchemaTrigger[];
+    [key: string]: unknown;
 }
 interface SchemaRevisionMetadata {
     revisionId?: string;
     createdAt?: Date;
     publishedAt?: Date;
+    [key: string]: unknown;
 }
 interface SchemaRevision {
     databaseId: string;
     revisionDescription?: string;
     entities: SchemaEntity[];
     meta?: SchemaRevisionMetadata;
+    [key: string]: unknown;
 }
 type SchemaHistoryEntry = SchemaRevision;
 type SchemaUpsertRequest = Omit<SchemaRevision, 'databaseId' | 'meta'> & {
     databaseId?: string;
+    [key: string]: unknown;
 };
 interface SchemaValidationResult {
     valid?: boolean;
@@ -1190,6 +1210,68 @@ interface SchemaValidationResult {
         message: string;
     }>;
 }
+interface SchemaAttributeChange {
+    name: string;
+    from: {
+        type?: string;
+        isNullable?: boolean;
+    };
+    to: {
+        type?: string;
+        isNullable?: boolean;
+    };
+}
+interface SchemaIndexChange {
+    name: string;
+    from: SchemaIndex;
+    to: SchemaIndex;
+}
+interface SchemaResolverChange {
+    name: string;
+    from: SchemaResolver;
+    to: SchemaResolver;
+}
+interface SchemaTriggerChange {
+    name: string;
+    from: SchemaTrigger;
+    to: SchemaTrigger;
+}
+interface SchemaTableDiff {
+    name: string;
+    partition?: {
+        from: string | null;
+        to: string | null;
+    } | null;
+    identifier?: {
+        from: SchemaIdentifier | null;
+        to: SchemaIdentifier | null;
+    } | null;
+    attributes?: {
+        added: SchemaAttribute[];
+        removed: string[];
+        changed: SchemaAttributeChange[];
+    };
+    indexes?: {
+        added: SchemaIndex[];
+        removed: string[];
+        changed: SchemaIndexChange[];
+    };
+    resolvers?: {
+        added: SchemaResolver[];
+        removed: string[];
+        changed: SchemaResolverChange[];
+    };
+    triggers?: {
+        added: SchemaTrigger[];
+        removed: string[];
+        changed: SchemaTriggerChange[];
+    };
+}
+interface SchemaDiff {
+    newTables: string[];
+    removedTables: string[];
+    changedTables: SchemaTableDiff[];
+}
 
 /** -------------------------
  * Facade export
@@ -1287,8 +1369,12 @@ declare class ConditionBuilderImpl implements IConditionBuilder {
 
 declare const eq: (field: string, value: unknown) => ConditionBuilderImpl;
 declare const neq: (field: string, value: unknown) => ConditionBuilderImpl;
-declare const inOp: (field: string, values: unknown[] | string) => ConditionBuilderImpl;
-declare const notIn: (field: string, values: unknown[]) => ConditionBuilderImpl;
+declare function inOp(field: string, values: string): ConditionBuilderImpl;
+declare function inOp<T>(field: string, values: unknown[] | IQueryBuilder<T>): ConditionBuilderImpl;
+declare function within<T>(field: string, values: string | unknown[] | IQueryBuilder<T>): ConditionBuilderImpl;
+declare function notIn(field: string, values: string): ConditionBuilderImpl;
+declare function notIn<T>(field: string, values: unknown[] | IQueryBuilder<T>): ConditionBuilderImpl;
+declare function notWithin<T>(field: string, values: string | unknown[] | IQueryBuilder<T>): ConditionBuilderImpl;
 declare const between: (field: string, lower: unknown, upper: unknown) => ConditionBuilderImpl;
 declare const gt: (field: string, value: unknown) => ConditionBuilderImpl;
 declare const gte: (field: string, value: unknown) => ConditionBuilderImpl;
@@ -1324,4 +1410,4 @@ declare const percentile: (attribute: string, p: number) => string;
 declare const sdkName = "@onyx.dev/onyx-database";
 declare const sdkVersion = "0.1.0";
 
-export { type FetchImpl, type FetchResponse, type ICascadeBuilder, type ICascadeRelationshipBuilder, type IConditionBuilder, type IOnyxDatabase, type IQueryBuilder, type ISaveBuilder, type LogicalOperator, type OnyxConfig, type OnyxDocument, type OnyxFacade, type QueryCondition, type QueryCriteria, type QueryCriteriaOperator, type QueryPage, QueryResults, type QueryResultsPromise, type SchemaAttribute, type SchemaDataType, type SchemaEntity, type SchemaHistoryEntry, type SchemaIdentifier, type SchemaIdentifierGenerator, type SchemaIndex, type SchemaIndexType, type SchemaResolver, type SchemaRevision, type SchemaRevisionMetadata, type SchemaTrigger, type SchemaTriggerEvent, type SchemaUpsertRequest, type SchemaValidationResult, type SecretMetadata, type SecretRecord, type SecretSaveRequest, type SecretsListResponse, type SelectQuery, type Sort, type StreamAction, type UpdateQuery, asc, avg, between, contains, containsIgnoreCase, count, desc, eq, gt, gte, inOp, isNull, like, lower, lt, lte, matches, max, median, min, neq, notContains, notContainsIgnoreCase, notIn, notLike, notMatches, notNull, notStartsWith, onyx, percentile, replace, sdkName, sdkVersion, startsWith, std, substring, sum, upper, variance };
+export { type FetchImpl, type FetchResponse, type ICascadeBuilder, type ICascadeRelationshipBuilder, type IConditionBuilder, type IOnyxDatabase, type IQueryBuilder, type ISaveBuilder, type LogicalOperator, type OnyxConfig, type OnyxDocument, type OnyxFacade, type QueryCondition, type QueryCriteria, type QueryCriteriaOperator, type QueryPage, QueryResults, type QueryResultsPromise, type SchemaAttribute, type SchemaAttributeChange, type SchemaDataType, type SchemaDiff, type SchemaEntity, type SchemaHistoryEntry, type SchemaIdentifier, type SchemaIdentifierGenerator, type SchemaIndex, type SchemaIndexChange, type SchemaIndexType, type SchemaResolver, type SchemaResolverChange, type SchemaRevision, type SchemaRevisionMetadata, type SchemaTableDiff, type SchemaTrigger, type SchemaTriggerChange, type SchemaTriggerEvent, type SchemaUpsertRequest, type SchemaValidationResult, type SecretMetadata, type SecretRecord, type SecretSaveRequest, type SecretsListResponse, type SelectQuery, type Sort, type StreamAction, type UpdateQuery, asc, avg, between, contains, containsIgnoreCase, count, desc, eq, gt, gte, inOp, isNull, like, lower, lt, lte, matches, max, median, min, neq, notContains, notContainsIgnoreCase, notIn, notLike, notMatches, notNull, notStartsWith, notWithin, onyx, percentile, replace, sdkName, sdkVersion, startsWith, std, substring, sum, upper, variance, within };