more work

Author: quantum

.github/workflows/wasm-sdk-documentation-check.yml

@@ -57,8 +57,9 @@ jobs:
             echo "status=failure" >> $GITHUB_OUTPUT
           fi
           
-          # Check if documentation needs to be regenerated
-          if git diff --quiet docs.html docs_manifest.json AI_REFERENCE.md; then
+          # Note: At this point, the documentation hasn't been regenerated yet,
+          # so this check will only detect if the PR already includes documentation changes
+          if git diff --quiet HEAD -- docs.html docs_manifest.json AI_REFERENCE.md; then
             echo "docs_modified=false" >> $GITHUB_OUTPUT
           else
             echo "docs_modified=true" >> $GITHUB_OUTPUT
@@ -114,13 +115,12 @@ jobs:
               }
             }
 
-      - name: Auto-update documentation
-        if: github.event_name == 'push' && (github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/heads/v')) && steps.doc-check.outputs.status == 'failure'
+      - name: Auto-update documentation (non-protected branches)
+        if: github.event_name == 'push' && !contains(github.ref, 'master') && !contains(github.ref, 'main') && steps.doc-check.outputs.status == 'failure'
         working-directory: packages/wasm-sdk
         run: |
           # Generate updated documentation
           python3 generate_docs.py
-          
           # Check if there are changes
           if ! git diff --quiet docs.html docs_manifest.json AI_REFERENCE.md; then
             git config --local user.email "github-actions[bot]@users.noreply.github.com"
@@ -129,6 +129,21 @@ jobs:
             git commit -m "chore: update WASM SDK documentation [skip ci]"
             git push
           fi
+          
+      - name: Create documentation update PR (protected branches)
+        if: github.event_name == 'push' && (contains(github.ref, 'master') || contains(github.ref, 'main')) && steps.doc-check.outputs.status == 'failure'
+        uses: peter-evans/create-pull-request@v5
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          commit-message: "chore: update WASM SDK documentation"
+          title: "chore: update WASM SDK documentation"
+          body: |
+            This PR updates the WASM SDK documentation to match the current implementation.
+            
+            Auto-generated by GitHub Actions.
+          branch: auto-update-wasm-docs-${{ github.run_number }}
+          base: ${{ github.ref_name }}
+          path: packages/wasm-sdk
 
       - name: Fail if documentation is out of date
         if: steps.doc-check.outputs.status == 'failure' && github.event_name == 'pull_request'

packages/wasm-sdk/AI_REFERENCE.md

@@ -44,7 +44,7 @@ Parameters:
 
 Example:
 ```javascript
-const identity = await sdk.get_identity("GWRSAVFMjXx8HpQFaNJMqBV7MBgMK4br5UESsB4S31Ec");
+const identity = await sdk.getIdentity("GWRSAVFMjXx8HpQFaNJMqBV7MBgMK4br5UESsB4S31Ec");
 ```
 
 **Get Identity Keys** - `getIdentityKeys`
@@ -109,7 +109,7 @@ Parameters:
 
 Example:
 ```javascript
-const balance = await sdk.get_identity_balance(identityId);
+const balance = await sdk.getIdentityBalance(identityId);
 ```
 
 **Get Identities Balances** - `getIdentitiesBalances`
@@ -267,7 +267,7 @@ Parameters:
 
 Example:
 ```javascript
-const docs = await sdk.get_documents(
+const docs = await sdk.getDocuments(
     contractId,
     "note",
     JSON.stringify([["$ownerId", "==", identityId]]),
@@ -1072,7 +1072,7 @@ const result = await sdk.masternodeVote(identityHex, /* params */, privateKeyHex
 ### Error Handling
 ```javascript
 try {
-    const result = await sdk.get_identity(identityId);
+    const result = await sdk.getIdentity(identityId);
     console.log(result);
 } catch (error) {
     console.error("Query failed:", error);
@@ -1085,7 +1085,7 @@ try {
 const sdk = await WasmSdk.new(transport, true);
 
 // Query with proof verification
-const identityWithProof = await sdk.get_identity(identityId);
+const identityWithProof = await sdk.getIdentity(identityId);
 ```
 
 ### Document Queries with Where/OrderBy
@@ -1101,7 +1101,7 @@ const orderBy = JSON.stringify([
     ["$createdAt", "desc"]
 ]);
 
-const docs = await sdk.get_documents(
+const docs = await sdk.getDocuments(
     contractId,
     documentType,
     whereClause,
@@ -1114,7 +1114,7 @@ const docs = await sdk.get_documents(
 ```javascript
 // Get multiple identities
 const identityIds = ["id1", "id2", "id3"];
-const balances = await sdk.get_identities_balances(identityIds);
+const balances = await sdk.getIdentitiesBalances(identityIds);
 ```
 
 ## Important Notes