@salesforce/webapp-template-feature-react-authentication-experimental 1.105.0 → 1.106.0

package/dist/.a4drules/skills/feature-graphql-graphql-data-access/docs/explore-schema.md

@@ -1,256 +0,0 @@
-# GraphQL Schema Reference
-
-This document provides guidance for AI agents working with the Salesforce GraphQL API schema in this project.
-
-## Schema File Location
-
-**The complete GraphQL schema is located at: `@schema.graphql`** (in the project root)
-
-> ⚠️ **Important**: The schema file is very large (~265,000+ lines). Do NOT read it entirely. Instead, use targeted searches to find specific types, fields, or operations.
-
-If the file is not present, generate it by running:
-
-```bash
-npm run graphql:schema
-```
-
-## Required Pre-Flight Check
-
-**BEFORE generating any GraphQL query, you MUST:**
-
-1. **Check if schema exists**: Look for `schema.graphql` in the project root
-2. **If schema is missing**:
-   - Run `npm run graphql:schema` to download it
-   - Wait for the command to complete successfully
-   - Then proceed with schema exploration
-3. **If schema exists**: Proceed with targeted searches as described below
-
-> ⚠️ **DO NOT** generate GraphQL queries without first having access to the schema. Standard field assumptions may not match the target org's configuration.
-
-## Schema Structure Overview
-
-The schema follows the Salesforce GraphQL Wire Adapter pattern with these main entry points:
-
-### Query Entry Point
-
-```graphql
-type Query {
-  uiapi: UIAPI!
-}
-```
-
-### UIAPI Structure
-
-```graphql
-type UIAPI {
-  query: RecordQuery! # For querying records
-  aggregate: RecordQueryAggregate! # For aggregate queries
-  objectInfos: [ObjectInfo] # For metadata
-  relatedListByName: RelatedListInfo
-}
-```
-
-### Mutation Entry Point
-
-```graphql
-type Mutation {
-  uiapi(input: UIAPIMutationsInput): UIAPIMutations!
-}
-```
-
-## How to Explore the Schema
-
-When you need to build a GraphQL query, use these search patterns:
-
-### 1. Find Available Fields for a Record Type
-
-Search for `type <ObjectName> implements Record` to find all queryable fields:
-
-```bash
-# Example: Find Account fields
-grep "^type Account implements Record" schema.graphql -A 50
-```
-
-### 2. Find Filter Options for a Record Type
-
-Search for `input <ObjectName>_Filter` to find filterable fields and operators:
-
-```bash
-# Example: Find Account filter options
-grep "^input Account_Filter" schema.graphql -A 30
-```
-
-### 3. Find OrderBy Options
-
-Search for `input <ObjectName>_OrderBy` for sorting options:
-
-```bash
-# Example: Find Account ordering options
-grep "^input Account_OrderBy" schema.graphql -A 20
-```
-
-### 4. Find Mutation Operations
-
-Search for operations in `UIAPIMutations`:
-
-```bash
-# Example: Find Account mutations
-grep "Account.*Create\|Account.*Update\|Account.*Delete" schema.graphql
-```
-
-### 5. Find Input Types for Mutations
-
-Search for `input <ObjectName>CreateInput` or `input <ObjectName>UpdateInput`:
-
-```bash
-# Example: Find Account create input
-grep "^input AccountCreateInput" schema.graphql -A 30
-```
-
-## Common Operator Types
-
-### StringOperators (for text fields)
-
-```graphql
-input StringOperators {
-  eq: String # equals
-  ne: String # not equals
-  like: String # pattern matching (use % as wildcard)
-  lt: String # less than
-  gt: String # greater than
-  lte: String # less than or equal
-  gte: String # greater than or equal
-  in: [String] # in list
-  nin: [String] # not in list
-}
-```
-
-### OrderByClause
-
-```graphql
-input OrderByClause {
-  order: ResultOrder # ASC or DESC
-  nulls: NullOrder # FIRST or LAST
-}
-```
-
-## Query Pattern Examples
-
-### Basic Query Structure
-
-All record queries follow this pattern:
-
-```graphql
-query {
-  uiapi {
-    query {
-      <ObjectName>(
-        first: Int           # pagination limit
-        after: String        # pagination cursor
-        where: <Object>_Filter
-        orderBy: <Object>_OrderBy
-      ) {
-        edges {
-          node {
-            Id
-            <Field> { value }
-            # ... more fields
-          }
-        }
-      }
-    }
-  }
-}
-```
-
-### Example: Query Accounts with Filter
-
-```graphql
-query GetHighRevenueAccounts($minRevenue: Currency) {
-  uiapi {
-    query {
-      Account(
-        where: { AnnualRevenue: { gt: $minRevenue } }
-        orderBy: { AnnualRevenue: { order: DESC } }
-        first: 50
-      ) {
-        edges {
-          node {
-            Id
-            Name {
-              value
-            }
-            AnnualRevenue {
-              value
-            }
-            Industry {
-              value
-            }
-          }
-        }
-      }
-    }
-  }
-}
-```
-
-### Mutation Pattern
-
-```graphql
-mutation CreateAccount($input: AccountCreateInput!) {
-  uiapi(input: { AccountCreate: { input: $input } }) {
-    AccountCreate {
-      Record {
-        Id
-        Name {
-          value
-        }
-      }
-    }
-  }
-}
-```
-
-## Field Value Wrappers
-
-Salesforce GraphQL returns field values wrapped in typed objects:
-
-| Wrapper Type    | Access Pattern                     |
-| --------------- | ---------------------------------- |
-| `StringValue`   | `FieldName { value }`              |
-| `IntValue`      | `FieldName { value }`              |
-| `BooleanValue`  | `FieldName { value }`              |
-| `DateTimeValue` | `FieldName { value displayValue }` |
-| `PicklistValue` | `FieldName { value displayValue }` |
-| `CurrencyValue` | `FieldName { value displayValue }` |
-
-## Agent Workflow for Building Queries
-
-**Pre-requisites (MANDATORY):**
-
-- [ ] Verified `schema.graphql` exists in project root
-- [ ] If missing, ran `npm run graphql:schema` and waited for completion
-- [ ] Confirmed connection to correct Salesforce org (if downloading fresh schema)
-
-**Workflow Steps:**
-
-1. **Identify the target object** (e.g., Account, Contact, Opportunity)
-2. **Search the schema** for the object type to discover available fields
-3. **Search for filter input** (`<Object>_Filter`) to understand filtering options
-4. **Search for orderBy input** (`<Object>_OrderBy`) for sorting capabilities
-5. **Build the query** following the patterns above
-6. **Validate field names** match exactly as defined in the schema (case-sensitive)
-
-## Tips for Agents
-
-- **Always verify field names** by searching the schema before generating queries
-- **Use grep/search** to explore the schema efficiently—never read the entire file
-- **Check relationships** by looking for `parentRelationship` and `childRelationship` comments in type definitions
-- **Look for Connection types** (e.g., `AccountConnection`) to understand pagination structure
-- **Custom objects** end with `__c` (e.g., `CustomObject__c`)
-- **Custom fields** also end with `__c` (e.g., `Custom_Field__c`)
-
-## Related Documentation
-
-- For generating mutations and queries, see `generate-mutation-query.md`
-- For generating read queries, see `generate-read-query.md`

package/dist/.a4drules/skills/feature-graphql-graphql-data-access/docs/generate-read-query.md

@@ -1,202 +0,0 @@
-# GraphQL Read Query Generation
-
-**Triggering conditions**
-
-1. Only if the schema exploration phase completed successfully
-2. Only if the query to generate is a read query
-
-## Your Role
-
-You are a GraphQL expert and your role is to help generate Salesforce compatible GraphQL read queries once the exploration phase has completed.
-
-You will leverage the context provided by the requesting user as well as the validation phase provided by the schema exploration. This tool will also provide you with a method to dynamically query the target org instance that you will use to test the generated query.
-
-If the schema exploration has not been executed yet, you **MUST** run it first, and then get back to read query generation.
-
-## Read Query Generation Workflow
-
-Strictly follow the rules below when generating the GraphQL read query:
-
-1. **No Proliferation** - Only generate for the explicitly requested fields, nothing else
-2. **Unique Query** - Leverage child relationships to query entities in one single query
-3. **Navigate Entities** - Always use `relationshipName` to access reference fields and child entities
-   1. **Exception** - if the `relationshipName` field is null, you can't navigate the related entity, and will have to return the `Id` itself
-4. **Leverage Fragments** - Generate one fragment per possible type on polymorphic fields (field with `dataType="REFERENCE"` and more than one entry in `referenceToInfos` introspection attribute)
-5. **Type Consistency** - Make sure variables used as query arguments and their related fields share the same GraphQL type
-6. **Type Enforcement** - Make sure to leverage field type information from introspection and GraphQL schema to generate field access
-7. **Semi and anti joins** - Use the semi-join or anti-join templates to filter an entity with conditions on child entities
-8. **Query Generation** - Use the [template](#read-query-template) to generate the query
-9. **Output Format** - Use the [standalone](#read-standalone-default-output-format---clean-code-only)
-10. **Test the Query** - Use the [Generated Read Query Testing](#generated-read-query-testing) workflow to test the generated query
-    1. **Report First** - Always report first, using the proper output format, before testing
-
-## Read Query Template
-
-```graphql
-query QueryName {
-  uiapi {
-    query {
-      EntityName(
-        # conditions here
-      ) {
-        edges {
-          node {
-            # Direct fields
-            FieldName { value }
-
-            # Non-polymorphic reference (single type)
-            RelationshipName {
-              Id
-              Name { value }
-            }
-
-            # Polymorphic reference (multiple types)
-            PolymorphicRelationshipName {
-              ...TypeAInfo
-              ...TypeBInfo
-            }
-
-            # Child relationship (subquery)
-            RelationshipName(
-              # conditions here
-            ) {
-              edges {
-                node {
-                  # fields
-                }
-              }
-            }
-          }
-        }
-      }
-    }
-  }
-}
-
-fragment TypeAInfo on TypeA {
-  Id
-  SpecificFieldA { value }
-}
-
-fragment TypeBInfo on TypeB {
-  Id
-  SpecificFieldB { value }
-}
-```
-
-## Semi-Join and Anti-Join Condition Template
-
-Semi-joins (resp. anti-joins) condition leverage parent-child relationships and allow filtering the parent entity using a condition on child entities.
-This is a standard `where` condition, on the parent entity's `Id`, expressed using the `inq` (resp. `ninq`, i.e. not `inq`) operator. This operator accepts two attributes:
-
-- The child entity camelcase name to apply the condition on, with a value expressing the condition
-- The field name on the child entity containing the parent entity `Id`, which is the `fieldName` from the `childRelationships` information for the child entity
-- If the only condition is related child entity existence, you can use an `Id: { ne: null }` condition
-
-### Semi-Join Example - ParentEntity with at least one Matching ChildEntity
-
-```graphql
-query testSemiJoin {
-  uiapi {
-    query {
-      ParentEntity(
-        where: {
-          Id: {
-            inq: {
-              ChildEntity: {
-                # standard conditions here
-                Name: { like: "test%" }
-                Type: { eq: "some value" }
-              }
-              ApiName: "parentIdFieldInChild"
-            }
-          }
-        }
-      ) {
-        edges {
-          node {
-            Id
-            Name {
-              value
-            }
-          }
-        }
-      }
-    }
-  }
-}
-```
-
-### Anti-Join Example - ParentEntity with no Matching ChildEntity
-
-Same example as the [Semi-Join Example](#semi-join-example---parententity-with-at-least-one-matching-childentity), but replacing the `inq` operator by the `ninq` one.
-
-## Read Standalone (Default) Output Format - CLEAN CODE ONLY
-
-```javascript
-const QUERY_NAME = `
-  query GetData {
-    // query here
-  }
-`;
-
-const QUERY_VARIABLES = {
-  // variables here
-};
-```
-
-**❌ DO NOT INCLUDE:**
-
-- Explanatory comments about the query
-- Field descriptions
-- Additional text about what the query does
-- Workflow step descriptions
-
-**✅ ONLY INCLUDE:**
-
-- Raw query string
-- Variables object
-- Nothing else
-
-## Generated Read Query Testing
-
-**Triggering conditions** - **ALL CONDITIONS MUST VALIDATE\***
-
-1. Only if the [Read Query Generation Workflow](#read-query-generation-workflow) step global status is `SUCCESS` and you have a generated query
-2. Only if the query to generate is a read query
-3. Only if non manual method was used during schema exploration to retrieve introspection data
-
-**Workflow**
-
-1. **Report Step** - Explain that you are able to test the query using `sf api request rest`
-2. **Interactive Step** - Ask the user whether they want you to test the query
-   1. **WAIT** for the user's answer.
-3. **Test Query** - If the user are OK with you testing the query:
-   1. Use `sf api request rest` to POST the query to the GraphQL endpoint:
-      ```bash
-      sf api request rest /services/data/v65.0/graphql \
-        --method POST \
-        --body '{"query":"query GetData { uiapi { query { EntityName { edges { node { Id } } } } } }"}'
-      ```
-   2. Replace `v65.0` with the API version of the target org
-   3. Replace the `query` value with the generated read query string
-   4. If the query uses variables, include them in the JSON body as a `variables` key
-   5. Report the result of the test as `SUCCESS` if the query executed without error, or `FAILED` if you got errors
-   6. If the query executed without any errors, but you received no data, then the query is valid, and the result of the test is `SUCCESS`
-4. **Remediation Step** - If status is `FAILED`, use the [`FAILED` status handling workflows](#failed-status-handling-workflow)
-
-### `FAILED` Status Handling Workflow
-
-The query is invalid:
-
-1. **Error Analysis** - Parse and categorize the specific error messages
-2. **Root Cause Identification** - Use error message to identify the root cause:
-   - **Syntax** - Error contains `invalid syntax`
-   - **Validation** - Error contains `validation error`
-   - **Type** - Error contains `VariableTypeMismatch` or `UnknownType`
-3. **Targeted Resolution** - Depending on the root cause categorization
-   - **Syntax** - Update the query using the error message information to fix the syntax errors
-   - **Validation** - This field's name is most probably invalid, ask user for clarification and **WAIT** for the user's answer
-   - **Type** - Use the error details and GraphQL schema to correct argument's type, and adjust variables accordingly
-4. **Test Again** - Resume the [query testing workflow](#generated-read-query-testing) with the updated query (increment and track attempt counter)
-5. **Escalation Path** - If targeted resolution fails after 2 attempts, ask for additional details and restart the entire GraphQL workflow, going again through the introspection phase