@salesforce/afv-skills 1.22.0 → 1.24.0

package/skills/using-mobile-native-capabilities/references/location.md

@@ -1,158 +0,0 @@
-# Location Service Grounding Context
-
-The following content provides grounding information for generating a Salesforce LWC that leverages location facilities on mobile devices. Specifically, this context will cover the API types and methods available to leverage the location API of the mobile device, within the LWC.
-
-## Location Service API
-
-```typescript
-/*
- * Copyright (c) 2024, Salesforce, Inc.
- * All rights reserved.
- * For full license text, see the LICENSE.txt file
- */
-
-import { BaseCapability } from '../BaseCapability.js';
-
-/**
- * Use this factory function to get an instance of {@linkcode LocationService}.
- * @returns An instance of {@linkcode LocationService}.
- */
-export function getLocationService(): LocationService;
-
-/**
- * Access and track location in a Lightning web component.
- * @see {@link https://developer.salesforce.com/docs/platform/lwc/guide/reference-lightning-locationservice.html|LocationService API}
- */
-export interface LocationService extends BaseCapability {
-  /**
-   * Gets the device’s current geolocation.
-   * @param options A {@linkcode LocationServiceOptions} object to configure the location request.
-   * @returns A Promise object that resolves as a {@linkcode LocationResult} object with the device location details.
-   */
-  getCurrentPosition(options?: LocationServiceOptions): Promise<LocationResult>;
-
-  /**
-   * Subscribes to asynchronous location updates for the mobile device.
-   * @param options A {@linkcode LocationServiceOptions} object to configure the location request.
-   * @param callback A function to handle location update responses.
-   * @returns An integer identifier for the location subscription, which you can use to end the subscription when you want to stop receiving location updates.
-   */
-  startWatchingPosition(
-    options: LocationServiceOptions | null,
-    callback: (result?: LocationResult, failure?: LocationServiceFailure) => void,
-  ): number;
-
-  /**
-   * Unsubscribes from location updates for the mobile device.
-   * @param watchId An integer identifier for an active location subscription, returned by a call to startWatchingPosition().
-   */
-  stopWatchingPosition(watchId: number): void;
-}
-
-/**
- * LocationResult interface.
- */
-export interface LocationResult {
-  /**
-   * The physical location.
-   */
-  coords: Coordinates;
-
-  /**
-   * The time of the location reading, measured in milliseconds since January 1, 1970.
-   */
-  timestamp: number;
-}
-
-/**
- * An object representing a specific point located on the planet Earth. Includes velocity details, if available.
- * Includes accuracy information, to the best of the device’s ability to evaluate. Similar to a GeolocationCoordinates in the Geolocation Web API.
- */
-export interface Coordinates {
-  /**
-   * The latitude, in degrees. Ranges from -90 to 90.
-   */
-  latitude: number;
-
-  /**
-   * The longitude, in degrees. Ranges from -180 to 180.
-   */
-  longitude: number;
-
-  /**
-   * Optional. Accuracy of the location measurement, in meters, as a radius around the measurement.
-   */
-  accuracy?: number;
-
-  /**
-   * Optional. Meters above sea level.
-   */
-  altitude?: number;
-
-  /**
-   * Optional. Accuracy of the altitude measurement, in meters.
-   */
-  altitudeAccuracy?: number;
-
-  /**
-   * Optional. Velocity of motion, if any, in meters per second.
-   */
-  speed?: number;
-
-  /**
-   * Optional. Accuracy of the speed measurement, in meters.
-   */
-  speedAccuracy?: number;
-
-  /**
-   * Optional. Direction of motion, in degrees from true north. Ranges from 0 to 360.
-   */
-  heading?: number;
-
-  /**
-   * Optional. Accuracy of the heading measurement, in degrees.
-   */
-  headingAccuracy?: number; // accuracy for the heading in degree
-}
-
-/**
- * An object representing an error that occurred when accessing LocationService features.
- */
-export interface LocationServiceFailure {
-  /**
-   * A value representing the reason for a location error.
-   */
-  code: LocationServiceFailureCode;
-
-  /**
-   * A string value explaining the reason for the failure. This value is suitable for use in user interface messages. The message is provided in English, and isn’t localized.
-   */
-  message: string;
-}
-
-/**
- * Possible failure codes.
- */
-export type LocationServiceFailureCode =
-  | 'LOCATION_SERVICE_DISABLED' // Android only - The code when the location service is disabled on the device, not just for this app.
-  | 'USER_DENIED_PERMISSION' // Permission was denied by user when prompt, could ask again
-  | 'USER_DISABLED_PERMISSION' // Android: permission was denied along "don't ask again" when prompt, will need to go app setting to turn on. iOS: permission was disabled by the user and will need to be turned on in settings
-  | 'SERVICE_NOT_ENABLED' // The service is not enabled and therefore cannot be used.
-  | 'UNKNOWN_REASON'; // An error happened in the Native Code that is not permission based. Will give more information in the LocationServiceFailure message.
-
-/**
- * An object representing configuration details for a location service session.
- */
-export interface LocationServiceOptions {
-  /**
-   * Whether to use high accuracy mode when determining location. Set to true to prioritize location accuracy.
-   * Set to false to prioritize battery life and response time.
-   */
-  enableHighAccuracy: boolean;
-
-  /**
-   * Optional, and only for Android implementations. The text shown in the UI when the device prompts the user to grant permission for your app to use the Android's location service.
-   */
-  permissionRationaleText?: string;
-}
-```

package/skills/using-mobile-native-capabilities/references/mobile-capabilities.md

@@ -1,30 +0,0 @@
-# lightning/mobileCapabilities
-
-Module declaration that re-exports every native capability service. Import the factory functions from `lightning/mobileCapabilities` (or the per-service path) when authoring an LWC.
-
-```typescript
-/*
- * Copyright (c) 2024, Salesforce, Inc.
- * All rights reserved.
- * For full license text, see the LICENSE.txt file
- */
-
-/**
- * Mobile capabilities are JavaScript APIs that make mobile hardware and platform (operating system) features available in JavaScript. They require access to device hardware, platform APIs, or both.
- * Mobile capability APIs are available only when a Lightning web component runs in a supported mobile app on a mobile device.
- * @see {@link https://developer.salesforce.com/docs/platform/lwc/guide/reference-lightning-mobilecapabilities.html|lightning/mobileCapabilities Module}
- */
-declare module 'lightning/mobileCapabilities' {
-  export * from '@salesforce/lightning-types/dist/lightning/mobileCapabilities/AppReviewService/appReviewService.js';
-  export * from '@salesforce/lightning-types/dist/lightning/mobileCapabilities/ARSpaceCapture/arSpaceCapture.js';
-  export * from '@salesforce/lightning-types/dist/lightning/mobileCapabilities/BarcodeScanner/barcodeScanner.js';
-  export * from '@salesforce/lightning-types/dist/lightning/mobileCapabilities/BiometricsService/biometricsService.js';
-  export * from '@salesforce/lightning-types/dist/lightning/mobileCapabilities/CalendarService/calendarService.js';
-  export * from '@salesforce/lightning-types/dist/lightning/mobileCapabilities/ContactsService/contactsService.js';
-  export * from '@salesforce/lightning-types/dist/lightning/mobileCapabilities/DocumentScanner/documentScanner.js';
-  export * from '@salesforce/lightning-types/dist/lightning/mobileCapabilities/GeofencingService/geofencingService.js';
-  export * from '@salesforce/lightning-types/dist/lightning/mobileCapabilities/LocationService/locationService.js';
-  export * from '@salesforce/lightning-types/dist/lightning/mobileCapabilities/NfcService/nfcService.js';
-  export * from '@salesforce/lightning-types/dist/lightning/mobileCapabilities/PaymentsService/paymentsService.js';
-}
-```

package/skills/using-mobile-native-capabilities/references/nfc.md

@@ -1,181 +0,0 @@
-# NFC Service Grounding Context
-
-The following content provides grounding information for generating a Salesforce LWC that leverages NFC facilities on mobile devices. Specifically, this context will cover the API types and methods available to leverage the NFC API of the mobile device, within the LWC.
-
-## NFC Service API
-
-```typescript
-/*
- * Copyright (c) 2024, Salesforce, Inc.
- * All rights reserved.
- * For full license text, see the LICENSE.txt file
- */
-
-import { BaseCapability } from '../BaseCapability.js';
-
-/**
- * Use this factory function to get an instance of {@linkcode NfcService}.
- * @returns An instance of {@linkcode NfcService}.
- */
-export function getNfcService(): NfcService;
-
-/**
- * Interact with NFC tags from a Lightning web component.
- * @see {@link https://developer.salesforce.com/docs/platform/lwc/guide/reference-lightning-nfcservice.html|NFCService API}
- */
-export interface NfcService extends BaseCapability {
-  /**
-   * Reads an NFC tag and returns the data read from it.
-   * @param options An {@linkcode NFCServiceOptions} object to configure the {@linkcode NfcService} request.
-   * @returns A Promise object that resolves to an array containing a single {@linkcode NFCMessage} object.
-   */
-  read(options?: NFCServiceOptions): Promise<NFCMessage[]>;
-
-  /**
-   * Erase the contents of an NFC tag.
-   * @param options An {@linkcode NFCServiceOptions} object to configure the {@linkcode NfcService} request.
-   * @returns If successful, the OS returns a Promise object that resolves to null.
-   */
-  erase(options?: NFCServiceOptions): Promise<null>;
-
-  /**
-   * Write text to an NFC tag.
-   * @param payloads An array of {@linkcode NFCRecord} objects containing the raw bytes to be written.
-   * @param options An {@linkcode NFCServiceOptions} object to configure the {@linkcode NfcService} request.
-   * @returns If successful, the OS returns a Promise object that resolves to null.
-   */
-  write(payloads: NFCRecord[], options?: NFCServiceOptions): Promise<null>;
-
-  /**
-   * Given a text payload, this function creates a properly formatted {@linkcode NFCRecord} to be written to an NFC tag.
-   * @param payload A {@link TextPayload} object, which contains the text to be converted to an NFC record.
-   * @returns A Promise object that resolves to an {@linkcode NFCRecord} object.
-   */
-  createTextRecord(payload: TextPayload): Promise<NFCRecord>;
-
-  /**
-   * Given a URI string payload, this function creates a properly formatted {@linkcode NFCRecord} to be written to an NFC tag.
-   * @param payload The URI to be converted to an NFC record.
-   * @returns A Promise object that resolves to an {@linkcode NFCRecord} object.
-   */
-  createUriRecord(payload: string): Promise<NFCRecord>;
-}
-
-/**
- * An object returned by an NFC read() operation.
- */
-export interface NFCMessage {
-  /**
-   * The size, in number of bytes, of the data received by the read() operation.
-   */
-  totalByteLength: number;
-
-  /**
-   * An array containing a single {@linkcode NFCMessageRecord} object, which in turn contains the payload from the NFC tag.
-   */
-  records: NFCMessageRecord[];
-}
-
-/**
- * An object within an {@linkcode NFCMessage} object, containing the payload read from an NFC tag.
- */
-export interface NFCMessageRecord {
-  /**
-   * Contains the parsed values of the raw data read from the NFC tag. The parsing operation
-   * only occurs if the value of the typeNameFormat property on the {@linkcode NFCRecord} object is "WELLKNOWN".
-   * Otherwise, this property’s value is null.
-   */
-  parsed: NFCRecord;
-
-  /**
-   * Contains the raw base64 data string read from the NFC tag.
-   */
-  raw: NFCRecord;
-}
-
-/**
- * An object containing one record of data from an NFC tag scan.
- */
-export interface NFCRecord {
-  /**
-   * The Type Name Format field of the payload, as defined by the NDEF specification.
-   */
-  typeNameFormat: TypeNameFormat;
-
-  /**
-   * The type of the payload, as defined by the NDEF specification.
-   */
-  type: string;
-
-  /**
-   * The identifier of the payload, as defined by the NDEF specification, or an empty string if no identifier data was present in the tag.
-   */
-  identifier: string;
-
-  /**
-   * The content of the record, encoded in base64 format.
-   */
-  payload: string;
-}
-
-/**
- * An object containing raw text input, to be converted into an {@linkcode NFCRecord}.
- */
-export interface TextPayload {
-  /**
-   * The raw text payload to be converted.
-   */
-  text: string;
-
-  /**
-   * The ISO 639-1 language ID of the text.
-   */
-  langId: string;
-}
-
-/**
- * The following constants are available as properties on an instance of {@linkcode NfcService}. The constants enumerate the accepted values for the associated properties.
- */
-export type TypeNameFormat = 'ABSOLUTE_URI' | 'EMPTY' | 'EXTERNAL' | 'MEDIA' | 'WELLKNOWN' | 'UNCHANGED' | 'UNKNOWN';
-
-/**
- * An object containing configuration details for an NFC interaction.
- */
-export interface NFCServiceOptions {
-  /**
-   * Optional. Provides instructions to display in the user interface. Defaults to no text.
-   */
-  instructionText?: string;
-
-  /**
-   * Optional. Provides a message to display in the user interface when an NFC operation is successfully completed. Defaults to no text.
-   */
-  successText?: string;
-}
-
-/**
- * An object representing an error that occurred when accessing {@linkcode NfcService} features.
- */
-export interface NFCServiceFailure {
-  /**
-   * A value representing the reason for an error. See {@linkcode NFCServiceFailureCode} for the list of possible values.
-   */
-  code: NFCServiceFailureCode;
-
-  /**
-   * A string value describing the reason for the failure. This value is suitable for use in user interface messages. The message is provided in English and isn’t localized.
-   */
-  message: string;
-}
-
-/**
- * Correlates with the code property on the {@linkcode NFCServiceFailure} object.
- */
-export type NFCServiceFailureCode =
-  | 'USER_DISMISSED' // The user dismissed the scanner.
-  | 'NFC_NOT_SUPPORTED' // The device doesn’t support NFC capabilities.
-  | 'NFC_NOT_ENABLED' // The device NFC feature is turned off.
-  | 'TAG_EMPTY' // The NFC tag contains no data to be read.
-  | 'SERVICE_NOT_ENABLED' // NFCService is not enabled and cannot be used.
-  | 'UNKNOWN_REASON'; // An error occurred in the native code that isn’t related to permissions or hardware issues. More information is provided in the NFCServiceFailure message.
-```

package/skills/using-mobile-native-capabilities/references/payments.md

@@ -1,95 +0,0 @@
-# Payments Service Grounding Context
-
-The following content provides grounding information for generating a Salesforce LWC that leverages payments facilities on mobile devices. Specifically, this context will cover the API types and methods available to leverage the payments API of the mobile device, within the LWC.
-
-## Payments Service API
-
-```typescript
-/*
- * Copyright (c) 2024, Salesforce, Inc.
- * All rights reserved.
- * For full license text, see the LICENSE.txt file
- */
-
-import { BaseCapability } from '../BaseCapability.js';
-
-/**
- * Use this factory function to get an instance of {@linkcode PaymentsService}.
- * @returns An instance of {@linkcode PaymentsService}.
- */
-export function getPaymentsService(): PaymentsService;
-
-/**
- * PaymentsService is a Nimbus plugin that allows JavaScript code in a Lightning web component to call functions that launches Stripe's Tap to Pay capabilities.
- */
-export interface PaymentsService extends BaseCapability {
-  /**
-   * Process payment.
-   * @param options The customization options.
-   * @returns A Promise object that resolves to {@linkcode CollectPaymentResult} object.
-   */
-  collectPayment(options: CollectPaymentOptions): Promise<CollectPaymentResult>;
-
-  /**
-   * Get the supported payment methods on this device
-   * @param options The customization options.
-   * @returns  A Promise object that resolves to an array containing {@linkcode PaymentMethod} objects.
-   */
-  getSupportedPaymentMethods(options: GetSupportedPaymentMethodsOptions): Promise<PaymentMethod[]>;
-}
-
-/**
- * PaymentMethod values.
- */
-export type PaymentMethod = 'TAP_TO_PAY' | 'CREDIT_CARD_DETAILS' | 'PAY_VIA_LINK';
-
-/**
- * GetSupportedPaymentMethodsOptions interface.
- */
-export interface GetSupportedPaymentMethodsOptions {
-  countryIsoCode?: string;
-  merchantAccountId?: string;
-  permissionRationaleText?: string;
-}
-
-/**
- * CollectPaymentOptions interface.
- */
-export interface CollectPaymentOptions {
-  amount: number;
-  paymentMethod: PaymentMethod;
-  currencyIsoCode: string;
-  merchantAccountId: string;
-  merchantName: string;
-  payerAccountId?: string;
-  sourceObjectIds?: string[];
-  permissionRationaleText?: string;
-}
-
-/**
- * CollectPaymentResult interface.
- */
-export interface CollectPaymentResult {
-  gatewayRefId?: string;
-  guid?: string;
-  paymentGatewayId?: string;
-  status?: string;
-}
-
-/**
- * PaymentsServiceFailure interface.
- */
-export interface PaymentsServiceFailure {
-  code: PaymentsServiceFailureCode;
-  message: string;
-}
-
-/**
- * Possible failure codes.
- */
-export type PaymentsServiceFailureCode =
-  | 'USER_DISMISSED' // User cancelled the operation.
-  | 'USER_DENIED_PERMISSION' // Permission to access device location is denied.
-  | 'SERVICE_NOT_ENABLED' // The service is not enabled and therefore cannot be used.
-  | 'UNKNOWN_REASON'; // An error happened in the native code that is not permission based. Will give more information in the PaymentsServiceFailure message.
-```

package/skills/using-salesforce-archive/SKILL.md

@@ -1,121 +0,0 @@
----
-name: using-salesforce-archive
-description: "ALWAYS USE THIS SKILL for anything involving Salesforce Archive (also called Trusted Services Archive) — search, view, unarchive, analyze, mask, and erase (RTBF) archived records via the Archive Connect API, and reading archive job status from the ArchiveActivity object. TRIGGER when: user mentions Salesforce Archive, Trusted Services Archive, archive/unarchive records, ArchiveActivity, archive jobs, archive policy, archive analyzer, archived record search, archive storage, archive failure logs, right to be forgotten / RTBF on archived data, or masking archived PII — including phrasings like 'find records that were archived', 'restore archived data', 'why did the archive job fail', 'download the archive failure log', or 'monitor my archive jobs', AND even when they ask you to explain, give guidance, or write a runbook/doc about these topics rather than run code. SKIP when: the user wants generic data-export/backup unrelated to the Archive add-on, or wants to build the archive policy UI metadata."
-metadata:
-  version: "1.0"
----
-
-# Salesforce Archive
-
-Operate Salesforce Archive (also called Trusted Services Archive) through its Connect API and the `ArchiveActivity` job-metadata object. This skill covers how to search and restore archived records, run the analyzer, handle RTBF erasure and PII masking, check storage, and — the part most often missed — how to read archive job status from `ArchiveActivity` and use a job's Id + Type to download its logs.
-
-## Scope
-
-- **In scope**: Calling the Archive Connect API operations under `/platform/data-resilience/archive/`; querying the `ArchiveActivity` object via SOQL/Connect; correlating a job's `ArchiveActivity` record with its log-download endpoints; the verify-after-write pattern for each async operation.
-- **Out of scope**: Defining archive policies / `ArchivePolicyDefinition` metadata; building UI; generating Flows over archive data (`ArchiveActivity` is **not** Flow-queryable — see Gotchas); generic backup/export tooling unrelated to the add-on.
-
----
-
-## Required Inputs
-
-Gather or infer before acting:
-
-- **Operation intent**: search, view, unarchive, analyze, mask, RTBF, storage check, or job-status/log lookup.
-- **Target sObject** (`sobjectName`): required for search and unarchive.
-- **Filters**: search and unarchive require `sobjectName` + at least one filter.
-- **For log downloads**: the `requestId` (an `ArchiveActivity` Id, `8qv…` prefix) of a completed, log-producing job, and `reportType` = that activity's `Type`.
-
-Preconditions (confirm or surface to the user if a call returns a not-permitted error):
-- The **org** must have Salesforce Archive enabled (the `TrustedServicesArchive` / `TrustedServicesArchiveBt` org permission). Every operation is gated on this first.
-- Each operation requires a **specific user permission** on top of the org gate — see the Permissions table below. There is no single "archive admin" role; access is per-capability.
-
----
-
-## Permissions
-
-Every operation first requires the org to have Salesforce Archive enabled (`hasTrustedServicesArchive` = `OrgPermissions.TrustedServicesArchive || TrustedServicesArchiveBt`). On top of that org gate, each capability is gated by a distinct **user permission**. A call the user isn't permitted for fails with a "not permitted" error — match the error to the missing permission below.
-
-| Operation | User permission required |
-|-----------|--------------------------|
-| `search-archived-records`, `get-search-archived-records-next-page` | `ViewSearchPage` (Archive Search) — the Connect search endpoint runs the global-search path, gated by Archive Search, **not** `ViewArchivedRecords` |
-| `search-archived-records-with-sharing-rules` (Agentforce) | `ViewArchivedRecords` |
-| `unarchive-records` | `UnarchiveSdk` |
-| `forget-archived-records` (RTBF) + `get-rtbf-status` | `Rtbf` |
-| `mask-archived-records` + `get-masking-status` | `Rtbf` (masking shares the same `Rtbf` permission — **not** a separate entitlement) |
-| `run-analyzer`, `get-analyzer-report`, `get-archive-storage-used` | `ArchiveAnalyzer` |
-| `get-execution-details-stream-url`, `get-failed-records-stream-url` | `ViewActivitiesPage` (Archive Activities) |
-
-> Source of truth: the Connect API resource classes in `trusted-services-archive-connect-impl` → `TrustedServicesArchiveSdkImpl` guards → `TrustedServicesArchive.accessChecks.xml`. Note `search-archived-records` routes through `performArchiverGlobalSearch` (gated by `canRunArchiveSearch` = `ViewSearchPage`); the separate Apex-SDK `searchArchivedRecords()` method is gated by `ViewArchivedRecords`, but the **Connect API** search endpoint does not use it.
-
----
-
-## Workflow
-
-All steps are sequential within a task. Read the referenced file the first time you touch that area.
-
-1. **Identify the operation and read the contract** — do not rely on general knowledge of the Archive API, which has non-obvious contracts. Load `references/connect-api-operations.md` for the exact request/response shape, required inputs, and per-operation gotchas of every Archive Connect API operation. Do this before constructing any call (e.g. `dateRanges` plural vs singular, `isSuccess` flag vs HTTP status, `url: null` meaning no log).
-
-2. **For job status / monitoring, read the data model** — when the task involves archive jobs, failures, progress, counts, or logs, load `references/archive-activity-entity.md` for the `ArchiveActivity` field reference and how it links to the Connect API. Query `ArchiveActivity` via SOQL or Connect — **not** Flow. For a worked end-to-end example (find failed/in-progress jobs, then pull their execution-detail and failed-records logs), load `examples/monitor-failed-jobs.md`.
-
-3. **Construct and send the call** — follow the contract exactly. For searches, supply `sobjectName` + ≥1 filter; for date filtering use the plural `dateRanges` array of `{field, from, to}` with full ISO-8601 datetimes.
-
-4. **Branch on the right signal** — some operations return HTTP 201 with a body-level success flag (`body.statusCode`, `body.isSuccess`). Read `references/connect-api-operations.md` for which signal to trust per operation; never assume the HTTP status alone means success.
-
-5. **Verify after every write** — re-read state to confirm the effect (see the Verify-After-Write table below). Async operations (analyzer, RTBF, masking) return a request id you must poll.
-
----
-
-## Verify-After-Write
-
-| After this write | Confirm by |
-|------------------|-----------|
-| `run-analyzer` | Poll `get-analyzer-report` until the report is populated |
-| `unarchive-records` | Re-run `search-archived-records` — confirm records left the archive |
-| `forget-archived-records` (RTBF) | Poll `get-rtbf-status` with the returned `request_id` |
-| `mask-archived-records` | Poll `get-masking-status` with the returned `request_id` |
-
----
-
-## Rules / Constraints
-
-| Constraint | Rationale |
-|-----------|-----------|
-| Search & unarchive require `sobjectName` + at least one filter | The controller rejects an unfiltered request with "Search must be based on at least 1 field" — a full-object operation is never allowed. |
-| Date filters must be full ISO-8601 datetimes (`2020-01-01T00:00:00Z`) | A date-only value (`2020-01-01`) returns `400 JSON_PARSER_ERROR` because the field is typed `xsd:dateTime`. |
-| Search uses `dateRanges` (plural array); unarchive uses `dateRange` (singular) | They are genuinely different fields on the two endpoints; using the wrong shape silently drops the filter or 400s. |
-| Stop pagination when `scroll_id == "-1"` | Calling `get-search-archived-records-next-page` with `"-1"` returns 500. |
-| Log downloads need a real `ArchiveActivity` Id as `requestId` + that activity's `Type` as `reportType` | The backend resolves the log by the activity record; a mismatched `reportType` returns no log. |
-| Never use the deprecated lookups | `global-search-by-id`, `get-global-search-results`, and `view-archived-records` are deprecated with no successor and currently 500. Use `search-archived-records` (+ next-page) instead. |
-| Excluded objects are not retrievable | `Feed`, `History`, `Relation`, `Share` are not searchable; Files/Attachments are not retrievable via this API — do not promise them. |
-| Query `ArchiveActivity` via SOQL/Connect, never Flow | `ArchiveActivity` has `isProcessEnabled=false`, so a Flow "Get Records" element on it fails with "You can't get ArchiveActivity records in a flow." |
-
----
-
-## Gotchas
-
-| Issue | Resolution |
-|-------|------------|
-| Treating HTTP 201 as success | Several operations return 201 with a body-level outcome. Branch on `body.statusCode` (search) or `body.isSuccess` (`with-sharing-rules`), not the HTTP code. |
-| `run-analyzer.isRunning` used as a signal | It is **always** `null`; the endpoint only populates `message`. Poll `get-analyzer-report` to confirm completion instead. |
-| `search-archived-records-with-sharing-rules` (Agentforce) filters as an array | `filtersJson` must be a JSON-encoded **object map** `{"Field":"Value"}`, not an array of `{field,value}`; the array form returns `isSuccess:false "No valid filters provided"`. |
-| Log `url` treated as present because status is 201 | `get-*-stream-url` returns `{url}`; `url: null` means no log was resolved. Always check `url != null`. |
-| Misreading `get-archive-storage-used` | `usedStorage[]`/`availableStorage[]` are parallel positional arrays: index 0=org DATA, 1=org FILE, 2=archive RECORDS, 3=archive FILE. `availableStorage[2]`/`[3]` are **always 0** (archive tier is unmetered) — that means "not tracked", not "full". |
-| Expecting `ArchiveActivity` in a Flow | It is not Flow-enabled (`isProcessEnabled=false`). Use SOQL/Connect/Reports. |
-| Hitting unarchive caps | Unarchive processes ≤1000 matched records per request and ≤50 requests/hour/org, and restores the whole archived hierarchy of each match. |
-| RTBF/masking caps | `criteria` ≤10 entries (one per object); ≤10,000 root records/day (shared between RTBF and masking); masking is irreversible. Both RTBF and masking are gated by the same `Rtbf` user permission. |
-
----
-
-## Output Expectations
-
-This is a knowledge/API skill — it produces API calls and their interpreted results, plus SOQL against `ArchiveActivity`. It does not generate deployable metadata. Deliverables per task: the correct operation invocation(s), the right success-signal branching, and a verify-after-write confirmation.
-
----
-
-## Reference File Index
-
-| File | When to read |
-|------|-------------|
-| `references/connect-api-operations.md` | Before constructing any Archive Connect API call — full per-operation contracts, success signals, and limits |
-| `references/archive-activity-entity.md` | For any job-status / failure / progress / log task — `ArchiveActivity` field reference and its link to the log-download endpoints |
-| `examples/monitor-failed-jobs.md` | To follow an end-to-end monitoring flow: find failed/in-progress jobs, then download their logs |

package/skills/using-salesforce-archive/examples/monitor-failed-jobs.md

@@ -1,47 +0,0 @@
-# Example — Monitor failed archive jobs and download their logs
-
-End-to-end flow for the most common archive-admin task: find the jobs that failed or stalled, read why, and pull the logs that show which records didn't make it.
-
-## 1. Find the jobs (query ArchiveActivity)
-
-`ArchiveActivity` is not Flow-queryable, so use SOQL/Connect:
-
-```sql
-SELECT Id, Name, Status, Type, StartTime, ProgressPercentage,
-       TotalRecordCount, SucceededCount, FailedCount, SkippedRootRecordsCount,
-       RootEntityName, FailureReason
-FROM ArchiveActivity
-WHERE (Status = 'Failed' OR Status = 'In Progress' OR Status = 'Ended With Errors')
-  AND StartTime >= LAST_N_DAYS:7
-ORDER BY StartTime DESC
-```
-
-Read each row's `ProgressPercentage`, `SucceededCount`/`FailedCount`, `RootEntityName`, and `FailureReason` to summarize health. In-progress jobs have a blank `EndTime`.
-
-## 2. For each failed job, get the logs
-
-Take the job's `Id` (`8qv…`) as `requestId` and its `Type` as `reportType`. `{activity.Type}` below is a placeholder for that job's own `Type` field value (e.g. `Archive`, `Purge`, `Unarchive`, `Analyzer`) — substitute the actual value per job; a hardcoded/mismatched `reportType` returns no log.
-
-**Execution-detail log:**
-```
-GET /platform/data-resilience/archive/log/execution-details-stream-url
-    ?requestId={activity.Id}&reportType={activity.Type}
-```
-
-**Failed-records log:**
-```
-GET /platform/data-resilience/archive/log/failed-records-stream-url
-    ?requestId={activity.Id}&reportType={activity.Type}
-```
-
-Each returns `{ url }`. **Check `url != null`** before using it — a `null` url means no log was resolved for that job/type (e.g. the job produced no failed-records file), not an error to retry blindly.
-
-## 3. Summarize
-
-Per failed/in-progress job, report: Name, Status, ProgressPercentage, SucceededCount, FailedCount, RootEntityName (target object), FailureReason, and the two log URLs (or "no log available" when `url` is null).
-
-## Pitfalls this flow avoids
-
-- **Not** attempting a Flow over `ArchiveActivity` (`isProcessEnabled=false` → "You can't get ArchiveActivity records in a flow").
-- Passing the activity's real `Type` as `reportType` (a mismatch returns no log).
-- Treating a 201 with `url: null` as a usable log.