@onyx.dev/onyx-database 0.2.0 → 0.3.0

package/dist/index.d.cts

@@ -1014,6 +1014,66 @@ interface IOnyxDatabase<Schema = Record<string, unknown>> {
      * @param documentId ID of the document to delete.
     */
     deleteDocument(documentId: string): Promise<unknown>;
+    /**
+     * Fetch the current schema for the configured database.
+     *
+     * @example
+     * ```ts
+     * const schema = await db.getSchema();
+     * const userOnly = await db.getSchema({ tables: ['User'] });
+     * ```
+     */
+    getSchema(options?: {
+        tables?: string | string[];
+    }): Promise<SchemaRevision>;
+    /**
+     * Retrieve the schema revision history for the configured database.
+     */
+    getSchemaHistory(): Promise<SchemaHistoryEntry[]>;
+    /**
+     * Update the schema for the configured database.
+     *
+     * @example
+     * ```ts
+     * await db.updateSchema({
+     *   revisionDescription: 'Add profile table',
+     *   entities: [
+     *     {
+     *       name: 'Profile',
+     *       identifier: { name: 'id', generator: 'UUID' },
+     *       attributes: [
+     *         { name: 'displayName', type: 'String', isNullable: false }
+     *       ]
+     *     }
+     *   ]
+     * }, { publish: true });
+     * ```
+     */
+    updateSchema(schema: SchemaUpsertRequest, options?: {
+        publish?: boolean;
+    }): Promise<SchemaRevision>;
+    /**
+     * Validate a schema definition without applying it to the database.
+     */
+    validateSchema(schema: SchemaUpsertRequest): Promise<SchemaValidationResult>;
+    /**
+     * List stored secrets for the configured database.
+     */
+    listSecrets(): Promise<SecretsListResponse>;
+    /**
+     * Fetch a decrypted secret value by key.
+     */
+    getSecret(key: string): Promise<SecretRecord>;
+    /**
+     * Create or update a secret.
+     */
+    putSecret(key: string, input: SecretSaveRequest): Promise<SecretMetadata>;
+    /**
+     * Delete a secret by key.
+     */
+    deleteSecret(key: string): Promise<{
+        key: string;
+    }>;
     /**
      * Cancels active streams; safe to call multiple times.
      * @example
@@ -1053,6 +1113,83 @@ interface OnyxFacade {
      */
     clearCacheConfig(): void;
 }
+interface SecretMetadata {
+    key: string;
+    purpose?: string;
+    updatedAt: Date;
+}
+interface SecretRecord extends SecretMetadata {
+    value: string;
+}
+interface SecretsListResponse {
+    records: SecretMetadata[];
+    meta: {
+        totalRecords: number;
+    };
+}
+interface SecretSaveRequest {
+    purpose?: string;
+    value?: string;
+}
+type SchemaDataType = 'String' | 'Boolean' | 'Char' | 'Byte' | 'Short' | 'Int' | 'Float' | 'Double' | 'Long' | 'Timestamp' | 'EmbeddedObject' | 'EmbeddedList';
+type SchemaIdentifierGenerator = 'None' | 'Sequence' | 'UUID';
+interface SchemaIdentifier {
+    name: string;
+    generator?: SchemaIdentifierGenerator;
+    type?: SchemaDataType | string;
+}
+interface SchemaAttribute {
+    name: string;
+    type: SchemaDataType | string;
+    isNullable?: boolean;
+}
+type SchemaIndexType = 'DEFAULT' | 'LUCENE' | string;
+interface SchemaIndex {
+    name: string;
+    type?: SchemaIndexType;
+    minimumScore?: number;
+}
+interface SchemaResolver {
+    name: string;
+    resolver: string;
+}
+type SchemaTriggerEvent = 'PreInsert' | 'PostInsert' | 'PrePersist' | 'PostPersist' | 'PreUpdate' | 'PostUpdate' | 'PreDelete' | 'PostDelete' | string;
+interface SchemaTrigger {
+    name: string;
+    event: SchemaTriggerEvent;
+    trigger: string;
+}
+interface SchemaEntity {
+    name: string;
+    identifier?: SchemaIdentifier;
+    partition?: string;
+    attributes?: SchemaAttribute[];
+    indexes?: SchemaIndex[];
+    resolvers?: SchemaResolver[];
+    triggers?: SchemaTrigger[];
+}
+interface SchemaRevisionMetadata {
+    revisionId?: string;
+    createdAt?: Date;
+    publishedAt?: Date;
+}
+interface SchemaRevision {
+    databaseId: string;
+    revisionDescription?: string;
+    entities: SchemaEntity[];
+    meta?: SchemaRevisionMetadata;
+}
+type SchemaHistoryEntry = SchemaRevision;
+type SchemaUpsertRequest = Omit<SchemaRevision, 'databaseId' | 'meta'> & {
+    databaseId?: string;
+};
+interface SchemaValidationResult {
+    valid?: boolean;
+    schema?: SchemaRevision;
+    errors?: Array<{
+        message: string;
+    }>;
+}
 
 /** -------------------------
  * Facade export
@@ -1187,4 +1324,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 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 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 };

package/dist/index.d.ts

@@ -1014,6 +1014,66 @@ interface IOnyxDatabase<Schema = Record<string, unknown>> {
      * @param documentId ID of the document to delete.
     */
     deleteDocument(documentId: string): Promise<unknown>;
+    /**
+     * Fetch the current schema for the configured database.
+     *
+     * @example
+     * ```ts
+     * const schema = await db.getSchema();
+     * const userOnly = await db.getSchema({ tables: ['User'] });
+     * ```
+     */
+    getSchema(options?: {
+        tables?: string | string[];
+    }): Promise<SchemaRevision>;
+    /**
+     * Retrieve the schema revision history for the configured database.
+     */
+    getSchemaHistory(): Promise<SchemaHistoryEntry[]>;
+    /**
+     * Update the schema for the configured database.
+     *
+     * @example
+     * ```ts
+     * await db.updateSchema({
+     *   revisionDescription: 'Add profile table',
+     *   entities: [
+     *     {
+     *       name: 'Profile',
+     *       identifier: { name: 'id', generator: 'UUID' },
+     *       attributes: [
+     *         { name: 'displayName', type: 'String', isNullable: false }
+     *       ]
+     *     }
+     *   ]
+     * }, { publish: true });
+     * ```
+     */
+    updateSchema(schema: SchemaUpsertRequest, options?: {
+        publish?: boolean;
+    }): Promise<SchemaRevision>;
+    /**
+     * Validate a schema definition without applying it to the database.
+     */
+    validateSchema(schema: SchemaUpsertRequest): Promise<SchemaValidationResult>;
+    /**
+     * List stored secrets for the configured database.
+     */
+    listSecrets(): Promise<SecretsListResponse>;
+    /**
+     * Fetch a decrypted secret value by key.
+     */
+    getSecret(key: string): Promise<SecretRecord>;
+    /**
+     * Create or update a secret.
+     */
+    putSecret(key: string, input: SecretSaveRequest): Promise<SecretMetadata>;
+    /**
+     * Delete a secret by key.
+     */
+    deleteSecret(key: string): Promise<{
+        key: string;
+    }>;
     /**
      * Cancels active streams; safe to call multiple times.
      * @example
@@ -1053,6 +1113,83 @@ interface OnyxFacade {
      */
     clearCacheConfig(): void;
 }
+interface SecretMetadata {
+    key: string;
+    purpose?: string;
+    updatedAt: Date;
+}
+interface SecretRecord extends SecretMetadata {
+    value: string;
+}
+interface SecretsListResponse {
+    records: SecretMetadata[];
+    meta: {
+        totalRecords: number;
+    };
+}
+interface SecretSaveRequest {
+    purpose?: string;
+    value?: string;
+}
+type SchemaDataType = 'String' | 'Boolean' | 'Char' | 'Byte' | 'Short' | 'Int' | 'Float' | 'Double' | 'Long' | 'Timestamp' | 'EmbeddedObject' | 'EmbeddedList';
+type SchemaIdentifierGenerator = 'None' | 'Sequence' | 'UUID';
+interface SchemaIdentifier {
+    name: string;
+    generator?: SchemaIdentifierGenerator;
+    type?: SchemaDataType | string;
+}
+interface SchemaAttribute {
+    name: string;
+    type: SchemaDataType | string;
+    isNullable?: boolean;
+}
+type SchemaIndexType = 'DEFAULT' | 'LUCENE' | string;
+interface SchemaIndex {
+    name: string;
+    type?: SchemaIndexType;
+    minimumScore?: number;
+}
+interface SchemaResolver {
+    name: string;
+    resolver: string;
+}
+type SchemaTriggerEvent = 'PreInsert' | 'PostInsert' | 'PrePersist' | 'PostPersist' | 'PreUpdate' | 'PostUpdate' | 'PreDelete' | 'PostDelete' | string;
+interface SchemaTrigger {
+    name: string;
+    event: SchemaTriggerEvent;
+    trigger: string;
+}
+interface SchemaEntity {
+    name: string;
+    identifier?: SchemaIdentifier;
+    partition?: string;
+    attributes?: SchemaAttribute[];
+    indexes?: SchemaIndex[];
+    resolvers?: SchemaResolver[];
+    triggers?: SchemaTrigger[];
+}
+interface SchemaRevisionMetadata {
+    revisionId?: string;
+    createdAt?: Date;
+    publishedAt?: Date;
+}
+interface SchemaRevision {
+    databaseId: string;
+    revisionDescription?: string;
+    entities: SchemaEntity[];
+    meta?: SchemaRevisionMetadata;
+}
+type SchemaHistoryEntry = SchemaRevision;
+type SchemaUpsertRequest = Omit<SchemaRevision, 'databaseId' | 'meta'> & {
+    databaseId?: string;
+};
+interface SchemaValidationResult {
+    valid?: boolean;
+    schema?: SchemaRevision;
+    errors?: Array<{
+        message: string;
+    }>;
+}
 
 /** -------------------------
  * Facade export
@@ -1187,4 +1324,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 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 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 };

package/dist/index.js

@@ -340,7 +340,8 @@ var HttpClient = class {
       ...method === "DELETE" ? { Prefer: "return=representation" } : {},
       ...extraHeaders ?? {}
     });
-    if (body == null) delete headers["Content-Type"];
+    const hasExplicitContentType = extraHeaders && "Content-Type" in extraHeaders || Object.prototype.hasOwnProperty.call(this.defaults, "Content-Type");
+    if (body == null && !hasExplicitContentType) delete headers["Content-Type"];
     if (this.requestLoggingEnabled) {
       console.log(`${method} ${url}`);
       if (body != null) {
@@ -957,6 +958,33 @@ function serializeDates(value) {
   }
   return value;
 }
+function normalizeSecretMetadata(input) {
+  return { ...input, updatedAt: new Date(input.updatedAt) };
+}
+function normalizeSecretRecord(input) {
+  return { ...input, updatedAt: new Date(input.updatedAt) };
+}
+function normalizeDate(value) {
+  if (value == null) return void 0;
+  if (value instanceof Date) return value;
+  const ts = new Date(value);
+  return Number.isNaN(ts.getTime()) ? void 0 : ts;
+}
+function normalizeSchemaRevision(input, fallbackDatabaseId) {
+  const { meta, createdAt, publishedAt, revisionId, ...rest } = input;
+  const mergedMeta = {
+    revisionId: meta?.revisionId ?? revisionId,
+    createdAt: normalizeDate(meta?.createdAt ?? createdAt),
+    publishedAt: normalizeDate(meta?.publishedAt ?? publishedAt)
+  };
+  const cleanedMeta = mergedMeta.revisionId || mergedMeta.createdAt || mergedMeta.publishedAt ? mergedMeta : void 0;
+  return {
+    ...rest,
+    databaseId: input.databaseId ?? fallbackDatabaseId,
+    meta: cleanedMeta,
+    entities: input.entities ?? []
+  };
+}
 var OnyxDatabaseImpl = class {
   cfgPromise;
   resolved = null;
@@ -1090,6 +1118,86 @@ var OnyxDatabaseImpl = class {
     )}`;
     return http.request("DELETE", path);
   }
+  async getSchema(options) {
+    const { http, databaseId } = await this.ensureClient();
+    const params = new URLSearchParams();
+    const tables = options?.tables;
+    const tableList = Array.isArray(tables) ? tables : typeof tables === "string" ? tables.split(",") : [];
+    const normalizedTables = tableList.map((t) => t.trim()).filter(Boolean);
+    if (normalizedTables.length) {
+      params.append("tables", normalizedTables.map(encodeURIComponent).join(","));
+    }
+    const path = `/schemas/${encodeURIComponent(databaseId)}${params.size ? `?${params.toString()}` : ""}`;
+    const res = await http.request("GET", path);
+    return normalizeSchemaRevision(res, databaseId);
+  }
+  async getSchemaHistory() {
+    const { http, databaseId } = await this.ensureClient();
+    const path = `/schemas/history/${encodeURIComponent(databaseId)}`;
+    const res = await http.request("GET", path);
+    return Array.isArray(res) ? res.map((entry) => normalizeSchemaRevision(entry, databaseId)) : [];
+  }
+  async updateSchema(schema, options) {
+    const { http, databaseId } = await this.ensureClient();
+    const params = new URLSearchParams();
+    if (options?.publish) params.append("publish", "true");
+    const path = `/schemas/${encodeURIComponent(databaseId)}${params.size ? `?${params.toString()}` : ""}`;
+    const body = { ...schema, databaseId: schema.databaseId ?? databaseId };
+    const res = await http.request("PUT", path, serializeDates(body));
+    return normalizeSchemaRevision(res, databaseId);
+  }
+  async validateSchema(schema) {
+    const { http, databaseId } = await this.ensureClient();
+    const path = `/schemas/${encodeURIComponent(databaseId)}/validate`;
+    const body = { ...schema, databaseId: schema.databaseId ?? databaseId };
+    const res = await http.request("POST", path, serializeDates(body));
+    const normalizedSchema = res.schema ? normalizeSchemaRevision(res.schema, databaseId) : void 0;
+    return {
+      ...res,
+      valid: res.valid ?? true,
+      schema: normalizedSchema
+    };
+  }
+  async listSecrets() {
+    const { http, databaseId } = await this.ensureClient();
+    const path = `/database/${encodeURIComponent(databaseId)}/secret`;
+    const response = await http.request(
+      "GET",
+      path,
+      void 0,
+      { "Content-Type": "application/json" }
+    );
+    const records = (response.records ?? []).map(normalizeSecretMetadata);
+    return {
+      ...response,
+      records,
+      meta: response.meta ?? { totalRecords: records.length }
+    };
+  }
+  async getSecret(key) {
+    const { http, databaseId } = await this.ensureClient();
+    const path = `/database/${encodeURIComponent(databaseId)}/secret/${encodeURIComponent(key)}`;
+    const record = await http.request("GET", path, void 0, {
+      "Content-Type": "application/json"
+    });
+    return normalizeSecretRecord(record);
+  }
+  async putSecret(key, input) {
+    const { http, databaseId } = await this.ensureClient();
+    const path = `/database/${encodeURIComponent(databaseId)}/secret/${encodeURIComponent(key)}`;
+    const response = await http.request("PUT", path, serializeDates(input));
+    return normalizeSecretMetadata(response);
+  }
+  async deleteSecret(key) {
+    const { http, databaseId } = await this.ensureClient();
+    const path = `/database/${encodeURIComponent(databaseId)}/secret/${encodeURIComponent(key)}`;
+    const response = await http.request(
+      "DELETE",
+      path
+    );
+    const deletedKey = response && typeof response === "object" && "key" in response ? response.key : void 0;
+    return { key: deletedKey ?? key };
+  }
   close() {
     for (const h of Array.from(this.streams)) {
       try {