appbuild-oceanbase-console 1.10.3 → 1.10.4

package/dist/cjs/sdk.js

@@ -13795,6 +13795,154 @@ exports.AttributeStatus = void 0;
     AttributeStatus["Failed"] = "failed";
 })(exports.AttributeStatus || (exports.AttributeStatus = {}));
 
+/**
+ * Helper class to generate permission strings for resources.
+ */
+class Permission {
+}
+/**
+ * Generate read permission string for the provided role.
+ *
+ * @param {string} role
+ * @returns {string}
+ */
+Permission.read = (role) => {
+    return `read("${role}")`;
+};
+/**
+ * Generate write permission string for the provided role.
+ *
+ * This is an alias of update, delete, and possibly create.
+ * Don't use write in combination with update, delete, or create.
+ *
+ * @param {string} role
+ * @returns {string}
+ */
+Permission.write = (role) => {
+    return `write("${role}")`;
+};
+/**
+ * Generate create permission string for the provided role.
+ *
+ * @param {string} role
+ * @returns {string}
+ */
+Permission.create = (role) => {
+    return `create("${role}")`;
+};
+/**
+ * Generate update permission string for the provided role.
+ *
+ * @param {string} role
+ * @returns {string}
+ */
+Permission.update = (role) => {
+    return `update("${role}")`;
+};
+/**
+ * Generate delete permission string for the provided role.
+ *
+ * @param {string} role
+ * @returns {string}
+ */
+Permission.delete = (role) => {
+    return `delete("${role}")`;
+};
+
+/**
+ * Helper class to generate role strings for `Permission`.
+ */
+class Role {
+    /**
+     * Grants access to anyone.
+     *
+     * This includes authenticated and unauthenticated users.
+     *
+     * @returns {string}
+     */
+    static any() {
+        return 'any';
+    }
+    /**
+     * Grants access to a specific user by user ID.
+     *
+     * You can optionally pass verified or unverified for
+     * `status` to target specific types of users.
+     *
+     * @param {string} id
+     * @param {string} status
+     * @returns {string}
+     */
+    static user(id, status = '') {
+        if (status === '') {
+            return `user:${id}`;
+        }
+        return `user:${id}/${status}`;
+    }
+    /**
+     * Grants access to any authenticated or anonymous user.
+     *
+     * You can optionally pass verified or unverified for
+     * `status` to target specific types of users.
+     *
+     * @param {string} status
+     * @returns {string}
+     */
+    static users(status = '') {
+        if (status === '') {
+            return 'users';
+        }
+        return `users/${status}`;
+    }
+    /**
+     * Grants access to any guest user without a session.
+     *
+     * Authenticated users don't have access to this role.
+     *
+     * @returns {string}
+     */
+    static guests() {
+        return 'guests';
+    }
+    /**
+     * Grants access to a team by team ID.
+     *
+     * You can optionally pass a role for `role` to target
+     * team members with the specified role.
+     *
+     * @param {string} id
+     * @param {string} role
+     * @returns {string}
+     */
+    static team(id, role = '') {
+        if (role === '') {
+            return `team:${id}`;
+        }
+        return `team:${id}/${role}`;
+    }
+    /**
+     * Grants access to a specific member of a team.
+     *
+     * When the member is removed from the team, they will
+     * no longer have access.
+     *
+     * @param {string} id
+     * @returns {string}
+     */
+    static member(id) {
+        return `member:${id}`;
+    }
+    /**
+     * Grants access to a user with the specified label.
+     *
+     * @param {string} name
+     * @returns  {string}
+     */
+    static label(name) {
+        return `label:${name}`;
+    }
+}
+
 /**
  * Database Schema Migration Tool
  *
@@ -13807,13 +13955,45 @@ class SchemaMigration {
     constructor(databases) {
         this.databases = databases;
     }
+    /**
+     * Get default permissions for collections (read, create, update, delete all set to 'any')
+     */
+    getDefaultPermissions() {
+        return [
+            Permission.read(Role.any()),
+            Permission.create(Role.any()),
+            Permission.update(Role.any()),
+            Permission.delete(Role.any())
+        ];
+    }
     /**
      * Check if an attribute key is a built-in field that cannot be modified
-     * Built-in fields: id, createdAt, updatedAt
+     * Built-in fields include:
+     * - Fields starting with '$' prefix (e.g., $id, $createdAt, $updatedAt)
+     * - Legacy field names: id, createdAt, updatedAt
      */
     isBuiltInAttribute(key) {
+        // Check if starts with '$' prefix (all system/built-in fields)
+        if (key.startsWith('$')) {
+            return true;
+        }
+        // Legacy field names for backwards compatibility
         return key === 'id' || key === 'createdAt' || key === 'updatedAt';
     }
+    /**
+     * Check if an index key is a built-in index that cannot be modified
+     * Built-in indexes start with '$' prefix
+     */
+    isBuiltInIndex(key) {
+        return key.startsWith('$');
+    }
+    /**
+     * Check if an index contains any built-in attributes
+     * Built-in fields cannot have indexes created or deleted
+     */
+    indexContainsBuiltInAttributes(index) {
+        return index.attributes.some(attr => this.isBuiltInAttribute(attr));
+    }
     /**
      * Generate migration plan by comparing current database state with target schema
      */
@@ -13823,6 +14003,7 @@ class SchemaMigration {
             // Store schema for later use in execution
             this._currentSchema = schema;
             const operations = [];
+            const skippedBuiltIns = [];
             // If databaseId is empty, create a database with id "default"
             let databaseId = schema.databaseId;
             if (!databaseId || databaseId.trim() === '') {
@@ -13868,8 +14049,14 @@ class SchemaMigration {
                     // For new tables, create all attributes and indexes
                     // Process target attributes
                     for (const targetAttr of targetCollection.attributes) {
-                        // Skip built-in attributes (id, createdAt, updatedAt)
+                        // Skip built-in attributes (starting with '$' or legacy names)
                         if (this.isBuiltInAttribute(targetAttr.key)) {
+                            skippedBuiltIns.push({
+                                collectionId: collectionId,
+                                key: targetAttr.key,
+                                type: 'attribute',
+                                reason: `Built-in column '${targetAttr.key}' is automatically managed by the system`
+                            });
                             continue;
                         }
                         operations.push({
@@ -13883,6 +14070,26 @@ class SchemaMigration {
                     // Process target indexes
                     if (targetCollection.indexes) {
                         for (const targetIndex of targetCollection.indexes) {
+                            // Skip built-in indexes (starting with '$')
+                            if (this.isBuiltInIndex(targetIndex.key)) {
+                                skippedBuiltIns.push({
+                                    collectionId: collectionId,
+                                    key: targetIndex.key,
+                                    type: 'index',
+                                    reason: `Built-in index '${targetIndex.key}' is automatically managed by the system`
+                                });
+                                continue;
+                            }
+                            // Skip indexes that contain built-in attributes
+                            if (this.indexContainsBuiltInAttributes(targetIndex)) {
+                                skippedBuiltIns.push({
+                                    collectionId: collectionId,
+                                    key: targetIndex.key,
+                                    type: 'index',
+                                    reason: `Index '${targetIndex.key}' references built-in columns and is automatically managed`
+                                });
+                                continue;
+                            }
                             operations.push({
                                 type: 'createIndex',
                                 databaseId: schema.databaseId,
@@ -13919,8 +14126,14 @@ class SchemaMigration {
                     });
                     // Process target attributes
                     for (const targetAttr of targetCollection.attributes) {
-                        // Skip built-in attributes (id, createdAt, updatedAt)
+                        // Skip built-in attributes (starting with '$' or legacy names)
                         if (this.isBuiltInAttribute(targetAttr.key)) {
+                            skippedBuiltIns.push({
+                                collectionId: collectionId,
+                                key: targetAttr.key,
+                                type: 'attribute',
+                                reason: `Built-in column '${targetAttr.key}' is automatically managed by the system`
+                            });
                             continue;
                         }
                         const currentCol = currentColumnsMap.get(targetAttr.key);
@@ -13958,8 +14171,9 @@ class SchemaMigration {
                     }
                     // Check for columns to delete (columns in current but not in target)
                     for (const [key, currentAttr] of currentColumnsMap.entries()) {
-                        // Skip built-in attributes (id, createdAt, updatedAt)
+                        // Skip built-in attributes (starting with '$' or legacy names)
                         if (this.isBuiltInAttribute(key)) {
+                            // Don't add to skippedBuiltIns here since these are existing columns, not from target schema
                             continue;
                         }
                         const targetAttr = targetCollection.attributes.find(a => a.key === key);
@@ -13986,6 +14200,26 @@ class SchemaMigration {
                         });
                         // Process target indexes
                         for (const targetIndex of targetCollection.indexes) {
+                            // Skip built-in indexes (starting with '$')
+                            if (this.isBuiltInIndex(targetIndex.key)) {
+                                skippedBuiltIns.push({
+                                    collectionId: collectionId,
+                                    key: targetIndex.key,
+                                    type: 'index',
+                                    reason: `Built-in index '${targetIndex.key}' is automatically managed by the system`
+                                });
+                                continue;
+                            }
+                            // Skip indexes that contain built-in attributes
+                            if (this.indexContainsBuiltInAttributes(targetIndex)) {
+                                skippedBuiltIns.push({
+                                    collectionId: collectionId,
+                                    key: targetIndex.key,
+                                    type: 'index',
+                                    reason: `Index '${targetIndex.key}' references built-in columns and is automatically managed`
+                                });
+                                continue;
+                            }
                             const currentIndex = currentIndexesMap.get(targetIndex.key);
                             if (!currentIndex) {
                                 // Index doesn't exist - create it
@@ -14021,6 +14255,17 @@ class SchemaMigration {
                         }
                         // Check for indexes to delete
                         for (const [key, currentIndex] of currentIndexesMap.entries()) {
+                            // Skip built-in indexes (starting with '$')
+                            if (this.isBuiltInIndex(key)) {
+                                // Don't add to skippedBuiltIns here since these are existing indexes, not from target schema
+                                continue;
+                            }
+                            // Skip indexes that contain built-in attributes
+                            const indexAttributes = currentIndex.columns || [];
+                            if (indexAttributes.some((attr) => this.isBuiltInAttribute(attr))) {
+                                // Don't add to skippedBuiltIns here since these are existing indexes
+                                continue;
+                            }
                             const targetIndex = targetCollection.indexes.find(i => i.key === key);
                             if (!targetIndex) {
                                 operations.push({
@@ -14060,7 +14305,8 @@ class SchemaMigration {
             };
             return {
                 operations,
-                summary
+                summary,
+                skippedBuiltIns
             };
         });
     }
@@ -14165,6 +14411,25 @@ class SchemaMigration {
                 plan.operations.forEach((op, index) => {
                     console.log(`${index + 1}. [${op.type}] ${op.reason}`);
                 });
+                // Display skipped built-in items
+                if (plan.skippedBuiltIns && plan.skippedBuiltIns.length > 0) {
+                    console.log('\n=== SKIPPED BUILT-IN ITEMS ===');
+                    console.log('The following items are built-in (starting with "$") and automatically managed by the system:');
+                    const skippedAttributes = plan.skippedBuiltIns.filter(item => item.type === 'attribute');
+                    const skippedIndexes = plan.skippedBuiltIns.filter(item => item.type === 'index');
+                    if (skippedAttributes.length > 0) {
+                        console.log('\nBuilt-in Columns:');
+                        skippedAttributes.forEach(item => {
+                            console.log(`  - [${item.collectionId}] ${item.key}: ${item.reason}`);
+                        });
+                    }
+                    if (skippedIndexes.length > 0) {
+                        console.log('\nBuilt-in Indexes:');
+                        skippedIndexes.forEach(item => {
+                            console.log(`  - [${item.collectionId}] ${item.key}: ${item.reason}`);
+                        });
+                    }
+                }
                 return;
             }
             // Store schema for use in executeOperation
@@ -14343,7 +14608,7 @@ class SchemaMigration {
      * Execute a single migration operation
      */
     executeOperation(operation) {
-        var _a, _b, _c, _d;
+        var _a, _b, _c, _d, _e, _f;
         return __awaiter(this, void 0, void 0, function* () {
             switch (operation.type) {
                 case 'createCollection':
@@ -14356,7 +14621,7 @@ class SchemaMigration {
                         name: operation.collectionName,
                         rowSecurity: (_a = targetCollection === null || targetCollection === void 0 ? void 0 : targetCollection.documentSecurity) !== null && _a !== void 0 ? _a : false,
                         enabled: (_b = targetCollection === null || targetCollection === void 0 ? void 0 : targetCollection.enabled) !== null && _b !== void 0 ? _b : true,
-                        permissions: targetCollection === null || targetCollection === void 0 ? void 0 : targetCollection.permissions
+                        permissions: (_c = targetCollection === null || targetCollection === void 0 ? void 0 : targetCollection.permissions) !== null && _c !== void 0 ? _c : this.getDefaultPermissions()
                     });
                     break;
                 case 'updateCollection':
@@ -14367,9 +14632,9 @@ class SchemaMigration {
                         databaseId: operation.databaseId,
                         tableId: operation.collectionId,
                         name: operation.collectionName || operation.collectionId,
-                        rowSecurity: (_c = updateTargetCollection === null || updateTargetCollection === void 0 ? void 0 : updateTargetCollection.documentSecurity) !== null && _c !== void 0 ? _c : false,
-                        enabled: (_d = updateTargetCollection === null || updateTargetCollection === void 0 ? void 0 : updateTargetCollection.enabled) !== null && _d !== void 0 ? _d : true,
-                        permissions: updateTargetCollection === null || updateTargetCollection === void 0 ? void 0 : updateTargetCollection.permissions
+                        rowSecurity: (_d = updateTargetCollection === null || updateTargetCollection === void 0 ? void 0 : updateTargetCollection.documentSecurity) !== null && _d !== void 0 ? _d : false,
+                        enabled: (_e = updateTargetCollection === null || updateTargetCollection === void 0 ? void 0 : updateTargetCollection.enabled) !== null && _e !== void 0 ? _e : true,
+                        permissions: (_f = updateTargetCollection === null || updateTargetCollection === void 0 ? void 0 : updateTargetCollection.permissions) !== null && _f !== void 0 ? _f : this.getDefaultPermissions()
                     });
                     break;
                 case 'deleteCollection':
@@ -14410,6 +14675,16 @@ class SchemaMigration {
                     if (!operation.index) {
                         throw new Error('Index definition missing for createIndex operation');
                     }
+                    // Skip built-in indexes (starting with '$')
+                    if (this.isBuiltInIndex(operation.index.key)) {
+                        console.log(`Skipping createIndex for built-in index: ${operation.index.key}`);
+                        break;
+                    }
+                    // Skip indexes that contain built-in attributes
+                    if (this.indexContainsBuiltInAttributes(operation.index)) {
+                        console.log(`Skipping createIndex for index ${operation.index.key} because it contains built-in attributes`);
+                        break;
+                    }
                     // Wait for all attributes used in the index to be available
                     yield this.waitForAttributesAvailable(operation.databaseId, operation.collectionId, operation.index.attributes);
                     yield this.databases.createIndex({
@@ -14426,6 +14701,11 @@ class SchemaMigration {
                     if (!operation.indexKey) {
                         throw new Error('Index key missing for deleteIndex operation');
                     }
+                    // Skip built-in indexes (starting with '$')
+                    if (this.isBuiltInIndex(operation.indexKey)) {
+                        console.log(`Skipping deleteIndex for built-in index: ${operation.indexKey}`);
+                        break;
+                    }
                     // Check if index exists before deleting
                     try {
                         const indexesList = yield this.databases.listIndexes({
@@ -14433,12 +14713,18 @@ class SchemaMigration {
                             tableId: operation.collectionId,
                             total: true
                         });
-                        const indexExists = indexesList.indexes.some(idx => idx.key === operation.indexKey);
-                        if (!indexExists) {
+                        const indexToDelete = indexesList.indexes.find(idx => idx.key === operation.indexKey);
+                        if (!indexToDelete) {
                             // Index doesn't exist, skip deletion
                             console.log(`Index ${operation.indexKey} does not exist, skipping deletion`);
                             break;
                         }
+                        // Check if index contains built-in attributes
+                        const indexAttributes = indexToDelete.columns || [];
+                        if (indexAttributes.some((attr) => this.isBuiltInAttribute(attr))) {
+                            console.log(`Skipping deleteIndex for index ${operation.indexKey} because it contains built-in attributes`);
+                            break;
+                        }
                     }
                     catch (error) {
                         // If we can't list indexes, try to delete anyway (might fail gracefully)
@@ -25641,154 +25927,6 @@ class Realtime {
     }
 }
 
-/**
- * Helper class to generate permission strings for resources.
- */
-class Permission {
-}
-/**
- * Generate read permission string for the provided role.
- *
- * @param {string} role
- * @returns {string}
- */
-Permission.read = (role) => {
-    return `read("${role}")`;
-};
-/**
- * Generate write permission string for the provided role.
- *
- * This is an alias of update, delete, and possibly create.
- * Don't use write in combination with update, delete, or create.
- *
- * @param {string} role
- * @returns {string}
- */
-Permission.write = (role) => {
-    return `write("${role}")`;
-};
-/**
- * Generate create permission string for the provided role.
- *
- * @param {string} role
- * @returns {string}
- */
-Permission.create = (role) => {
-    return `create("${role}")`;
-};
-/**
- * Generate update permission string for the provided role.
- *
- * @param {string} role
- * @returns {string}
- */
-Permission.update = (role) => {
-    return `update("${role}")`;
-};
-/**
- * Generate delete permission string for the provided role.
- *
- * @param {string} role
- * @returns {string}
- */
-Permission.delete = (role) => {
-    return `delete("${role}")`;
-};
-
-/**
- * Helper class to generate role strings for `Permission`.
- */
-class Role {
-    /**
-     * Grants access to anyone.
-     *
-     * This includes authenticated and unauthenticated users.
-     *
-     * @returns {string}
-     */
-    static any() {
-        return 'any';
-    }
-    /**
-     * Grants access to a specific user by user ID.
-     *
-     * You can optionally pass verified or unverified for
-     * `status` to target specific types of users.
-     *
-     * @param {string} id
-     * @param {string} status
-     * @returns {string}
-     */
-    static user(id, status = '') {
-        if (status === '') {
-            return `user:${id}`;
-        }
-        return `user:${id}/${status}`;
-    }
-    /**
-     * Grants access to any authenticated or anonymous user.
-     *
-     * You can optionally pass verified or unverified for
-     * `status` to target specific types of users.
-     *
-     * @param {string} status
-     * @returns {string}
-     */
-    static users(status = '') {
-        if (status === '') {
-            return 'users';
-        }
-        return `users/${status}`;
-    }
-    /**
-     * Grants access to any guest user without a session.
-     *
-     * Authenticated users don't have access to this role.
-     *
-     * @returns {string}
-     */
-    static guests() {
-        return 'guests';
-    }
-    /**
-     * Grants access to a team by team ID.
-     *
-     * You can optionally pass a role for `role` to target
-     * team members with the specified role.
-     *
-     * @param {string} id
-     * @param {string} role
-     * @returns {string}
-     */
-    static team(id, role = '') {
-        if (role === '') {
-            return `team:${id}`;
-        }
-        return `team:${id}/${role}`;
-    }
-    /**
-     * Grants access to a specific member of a team.
-     *
-     * When the member is removed from the team, they will
-     * no longer have access.
-     *
-     * @param {string} id
-     * @returns {string}
-     */
-    static member(id) {
-        return `member:${id}`;
-    }
-    /**
-     * Grants access to a user with the specified label.
-     *
-     * @param {string} name
-     * @returns  {string}
-     */
-    static label(name) {
-        return `label:${name}`;
-    }
-}
-
 var _a, _ID_hexTimestamp;
 /**
  * Helper class to generate ID strings for resources.